# TotalFinance — full reference for LLMs TotalFinance is a TypeScript financial-computation toolkit. The SDK covers options, strategies, technical analysis, portfolio P&L, valuation, risk, scenarios, and backtesting. The operation registry is a curated serializable subset, not universal SDK coverage. Compute uses caller-supplied data, not live quotes. Package versions below are workspace metadata, not evidence of npm publication. Generated from package export maps, TypeScript source/checker/JSDoc, public guides, stability files and live operation metadata. No root-only API reports, inferred financial defaults, or publication claims. ## Imports and bundles Use named imports from `@insiderfinance/totalfinance/` as the portable browser default. The main package includes every domain and feature subpath with no runtime dependencies; only `@insiderfinance/totalfinance-mcp` is a separate optional install. TotalFinance is an unpublished preview: these are supported import shapes for a built checkout, not evidence of a completed npm installation. ### Start with a domain With the umbrella installed: ```ts import { normalCdf } from '@insiderfinance/totalfinance/math'; console.log(normalCdf(0)); // 0.5 ``` Supported feature subpaths are another explicit choice: ```ts import { normalCdf } from '@insiderfinance/totalfinance/math/normal'; console.log(normalCdf(0)); // 0.5 ``` Other examples include `@insiderfinance/totalfinance/technical-analysis/rsi` and `@insiderfinance/totalfinance/options/black-scholes`. Use the package's public export map, never private `dist` paths. Domain and feature paths are exports of the same main package; they are not separate installs. Domain named imports need no consumer-specific plugin. ### Namespace convenience has a tradeoff Direct namespace imports with static member access can tree-shake in both esbuild and Rollup: ```ts import * as math from '@insiderfinance/totalfinance/math'; console.log(math.normalCdf(0)); // 0.5 ``` That is different from the root's namespace re-export: ```ts import { math } from '@insiderfinance/totalfinance'; console.log(math.normalCdf(0)); // 0.5, but bundler-dependent retention ``` In the tested esbuild configuration, this second form retains the whole math namespace because of [esbuild issue #1420](https://github.com/evanw/esbuild/issues/1420). Rollup shakes this static use. The braces in `import { math }` select a namespace object, not a named calculation. Prefer named domain imports when the same code must stay small across bundlers. The root namespace API remains supported for convenience and discovery. It also hoists exactly five option gestures: `blackScholes`, `option`, `market`, `engines`, and `impliedVolatility`. Other option exports live under `options` or their supported domain/feature entrypoints, not flat on the root. Runtime-selected access such as `math[name]`, namespace enumeration such as `Object.values(math)`, and registries that dispatch to many calculations inherently retain the implementations they can reach. Tree shaking cannot remove functionality your program may select at runtime. This applies even to a direct namespace import; it is distinct from the esbuild re-export limitation. ### Three different sizes - **Installation size:** package files and dependencies on disk. The main package includes all domains; MCP adds its SDK dependency and depends on the exact main version. Tree shaking does not shrink an install. - **Final bundle size:** code retained by the production bundler for the imports and calls you use. ESM and `sideEffects: false` enable removal of unused code, but access patterns and bundler behavior still matter. Installing the umbrella does not require delivering every domain to the browser. - **Plain Node ESM loading:** Node loads the imported module graph; it performs no automatic dead-code elimination. A named import from a broad barrel is not a promise to load only one function. Use a supported feature subpath when you want a narrower unbundled module graph. Type-only imports, such as `import type { BlackScholesKernelInput } from '@insiderfinance/totalfinance/options/black-scholes'`, are erased from emitted JavaScript and add no runtime code. Browser-safe compute entrypoints remain separate from Node-only transports and filesystem helpers. ### A facade is more than a formula `blackScholes` includes input validation, typed errors, and `.explain()` assumptions and diagnostics. An indicator such as `rsi` also carries its streaming and serialization services. Importing one of these public objects is not the cost of a bare formula, even when you call just one method. The expert `blackScholesPrice` export on `@insiderfinance/totalfinance/options/black-scholes` offers a different, documented contract; choose it for that contract, not to bypass validation. See the generated [bundle size report](https://www.totalfinance.io/docs/totalfinance/guides/bundle-size) for enforced measurements. Whole-entrypoint budgets and used-function consumer budgets answer different questions: keeping an entire entrypoint is not the cost of one selected calculation. Compare matching import forms and bundlers, and measure your own production build; neither set of bundle measurements describes installation size or plain Node loading. [Imports and bundles guide](https://www.totalfinance.io/docs/totalfinance/guides/imports-and-bundles) ## Journey community-connectors [Runnable no-key SDK and author guide](https://www.totalfinance.io/docs/totalfinance/guides/community-connector-first-success) ### First success: synthetic data to ordinary calculations SDK 0.1.5 includes the provider-neutral preview research protocol. This source-checkout walkthrough builds the exact local SDK and an independent synthetic provider, so no key, market-data request or public provider package is needed. The SDK understands a finite set of provider-declared research timeframes; it is not a universal provider registry. Pure calculations stay ordinary; provider packages translate source facts once. Use Node22.23.2 and pnpm10.32.0 (the versions in .nvmrc and package.json). Install that toolchain first if missing. From a clean checkout at repository root, run: ```sh pnpm install --frozen-lockfile pnpm build mkdir -p .local-connector-artifacts (cd distribution/totalfinance && pnpm pack --pack-destination ../../.local-connector-artifacts) node examples/community-connectors/starter/prepare-sdk.mjs .local-connector-artifacts/insiderfinance-totalfinance-0.1.5.tgz (cd examples/community-connectors/starter && pnpm install --frozen-lockfile && pnpm build && pnpm test && pnpm pack --pack-destination ../../../.local-connector-artifacts) node examples/community-connectors/starter/run-consumer.mjs .local-connector-artifacts ``` The preparation step copies the exact local SDK tarball and refreshes its file integrity in the starter's lock before frozen installation. The starter is an independent pnpm project at [examples/community-connectors/starter](../examples/community-connectors/starter), outside the SDK's workspace glob, with its own project boundary and lock. It uses public SDK imports only. Packing an independently installable example is not npm publication. No SDK binary is committed. Use the SDK pack from this checkout so the installed example and contract match. Older registry SDK 0.1.4 does not supply the connector contract. The runner installs both packs into a new temporary consumer and repeats frozen installation. Its synthetic JSON has cents-based OHLC fields, session labels and actual share volume. The source maps cents to dollars/share once, retains actual source identity and unknown clocks, then the consumer uses the same path as any provider: ```ts const prices = await data.connect(createStarterProvider(rows, receipt)).priceBars(request); const average = technicalAnalysis.sma(prices.closePrices, { period: 2 }).at(-1); const weighted = technicalAnalysis.vwap(prices.ohlcvBars).at(-1); console.log({ average, weighted, source: prices.window.pages }); ``` Expected values are **103** and **102**. The retained pages contain the observed-only/gapped coverage warning, provenance, original time facts and limitations. They are not automatically copied into a pure indicator result. Keep that context beside any displayed number. For SMA(20), three rows are insufficient even when pagination is terminal: ```ts const last = technicalAnalysis.sma(prices.closePrices, { period: 20 }).at(-1); if (last === undefined || !Number.isFinite(last)) { console.log('Insufficient history for SMA(20): 3 observed rows; no additional read.'); } ``` No bang assertion, fake warmup row, automatic extra request or filled gap. Missing actual volume blocks OHLCV/VWAP selection only; known closes can still support SMA. Partial quality alone does not forbid valid closes. Zero is a real value. Midnight daily timestamps label sessions, not source observation instants. Terminal pagination proves neither continuous history nor trade eligibility. #### Write and repair one mapping Read the small independent [source](../examples/community-connectors/starter/src/index.ts) and its [expected-page test](../examples/community-connectors/starter/test.mjs). A daily-only raw query receives the original DataQuery on every page and returns Promise naturally, without conditional return assertions. It explicitly refuses unsupported kinds/intervals; the consumer retains generic request inference. The runner copies this author package, intentionally changes only `close: row.closeCents / 100` to `close: Number.NaN`, and rebuilds. Its actual refusal is: ```text data.invalid_response data[].bar.close not_finite ``` The error also carries phase=page, validationCode=input.not_finite and rowIndex=0. Repair that one line to `close: row.closeCents / 100`; the expected pages and ordinary calculations pass again. The error identifies the field and rule; it never echoes the broken value or arbitrary source text. The runner separately omits cents scaling from all OHLC fields. Those prices are finite and internally consistent, so schema validation cannot infer the unit mistake: the independently expected literal pages reject it under the kit's expected-facts law. Both proofs matter. #### Use compatible real data later The InsiderFinance provider and API integration remain private, without public onboarding. After separately arranging access and an allowance, replace only the provider binding with `createInsiderFinanceProvider(apiKey)` from the independently installed reference connector. The same `data.connect(provider).priceBars(request)` and existing calculations remain. Follow the [connector guide](https://www.totalfinance.io/docs/totalfinance/guides/community-connectors) for explicit symbol/interval/dates and the exact root example. Never treat the preview staging origin as an access grant. No real request is part of this recipe. The reference chain remains EOD research with incomplete terms and unknown clocks; there is no automatic conversion into pricing or fills. ## Journey options Price options and inspect Greeks Start with `totalfinance.option.price` (Price an option (Black–Scholes–Merton)); pack `options`; in the default profile; profiles `default`, `full`, `options`, `strategies`. Read its complete input schema and permissions in the operation catalog before calling. Supply your own data; no market inputs are fetched. [Runnable SDK guide](https://www.totalfinance.io/docs/totalfinance/guides/getting-started) ## Journey strategies Build and analyze option strategies Start with `totalfinance.strategy.analyze` (Analyze an options strategy); pack `strategy`; in the default profile; profiles `default`, `full`, `strategies`. Read its complete input schema and permissions in the operation catalog before calling. Supply your own data; no market inputs are fetched. [Runnable SDK guide](https://www.totalfinance.io/docs/totalfinance/guides/strategies) ## Journey portfolio-pnl Explain portfolio P&L Start with `totalfinance.portfolio.explain_pnl` (Explain portfolio P&L between two marks); pack `portfolio`; opt-in; profiles `full`, `portfolio`. Read its complete input schema and permissions in the operation catalog before calling. Supply your own data; no market inputs are fetched. [Runnable SDK guide](https://www.totalfinance.io/docs/totalfinance/guides/end-to-end#4-portfolio) ## Journey valuation Value a company Start with `totalfinance.valuation.company` (Value a company from its statements); pack `valuation`; opt-in; profiles `full`, `valuation`. Read its complete input schema and permissions in the operation catalog before calling. Supply your own data; no market inputs are fetched. [Runnable SDK guide](https://www.totalfinance.io/docs/totalfinance/guides/end-to-end#2-valuation) ## Journey backtesting Run a reproducible backtest Start with `totalfinance.backtest.vectorized_run` (Run a vectorized backtest); pack `backtest`; opt-in; profiles `backtesting`, `full`. Read its complete input schema and permissions in the operation catalog before calling. Supply your own data; no market inputs are fetched. [Runnable SDK guide](https://www.totalfinance.io/docs/totalfinance/guides/backtesting) ## Journey connect-agent Use Node at the floor declared by the installed package. In a built checkout (`pnpm build`), launch the stdio server: ```sh node distribution/mcp/dist/bin.js --profile default node distribution/mcp/dist/bin.js doctor ``` This checkout declares @insiderfinance/totalfinance-mcp 0.1.5 (pre-1.0; component maturity varies (see stability policy)). After independently confirming availability of that exact release, a client may use command `npx` with args `["-y", "@insiderfinance/totalfinance-mcp@0.1.5", "--profile", "default"]`. Do not assume the workspace version has been published. Stdout in server mode is JSON-RPC only. Published-package smoke: pending release. This build-time reference does not claim execution against published packages. ### Selection and permissions Omitted packs select the default compute packs. An explicit packs array is exact, including an empty array. The full profile selects all registered packs but grants no capabilities. Read-only is the server default. Embedded write use requires explicit readOnly: false, the per-operation requiredCapabilities, and the stores the operation requires. The CLI accepts repeatable --capability grants; a write grant enables write visibility but does not create missing stores or trusted authorizations. A sideEffect of none does not imply no permission requirement. Consult doctor, tools/list, and totalfinance://capabilities for effective availability. Catalog discovery is paged: follow nextCursor until absent for tools, resources and prompts. Treat cursors as opaque and server/catalog-scoped; restart without a cursor if it is rejected. totalfinance://profiles lists task selections; totalfinance://capabilities reports the active filters and grants. Use totalfinance://schema/tool//input and /output for an enabled tool’s schema, and invoke only prompts actually listed. Paper trading is local simulation, not a brokerage connection. Authorization, paper submission/cancellation, reconciliation, and portfolio-ledger application are distinct operations. Policy/human authorization, trusted authorization records and idempotency are not bypassed by selecting full. No live brokerage orders or live market-data fetching are supplied by this catalog. ### Handles, results, and errors Attach an explicit artifact store (--store in the CLI) to resolve handles. A ResourceHandle is store-scoped, with uri, kind, schema, version, contentHash, createdTimestampMs, expiresTimestampMs and provenance. Only the handleFields declared by an operation accept handle substitution. Inline data and stored data must satisfy the same operation contract. Unknown, wrong-kind, stale or unavailable handles are errors, not invitations to invent data. Read stored reports through listed totalfinance://reports/ resources or totalfinance.artifact.read when enabled. OperationResult carries operation identity/version, structured output, assumptions, diagnostics, artifacts and completion status. Inspect diagnostics and partial/incomplete status before treating a calculation as complete. QuantError failures are OperationError { code, message, context, operation }; MCP returns isError with the error in text, not success-shaped structuredContent. Schema validation errors may additionally include issues. Unknown protocol tools/resources/prompts are JSON-RPC errors. Never replace non-convergence with a guessed number. SDK result grammar depends on role: facade calls return plain values and .explain() returns value/assumptions/diagnostics; analysis calls return rich reports; factories return artifacts; expert kernels have their declared numerical contracts. Use units and conventions from the exact field documentation, not generic economic defaults. A missing JSDoc default is shown as not declared; optional never implies zero. Schema defaults below are emitted only when the schema declares them. ### Budgets, seeds, and heavy jobs Runtime budget metadata (bytes and milliseconds as named; not economic assumptions): ```json { "maxInputBytes": { "transportDefault": 65536, "maximum": 16777216 }, "inlineResultBytes": { "default": 262144, "maximum": 16777216 } } ``` Stochastic metadata may be per-call: evaluate it on parsed inputs (including declared schema defaults). The transport seed policy is published at totalfinance://policy/seed; inspect the resolved seed in results. Deterministic calls do not acquire synthetic seeds. For job-class work, explicitly attach a local JobRunner and its artifact store to the embedded MCP server. Use the lifecycle tools only when listed by that server: totalfinance.job.submit returns a job id; totalfinance.job.status reports progress; totalfinance.job.result fetches the unchanged completed result later; totalfinance.job.cancel stops unfinished work. Follow the returned status/result resource URIs. Progress may be lifecycle-only, not a measured percentage. Profile selection alone does not attach a runner or grant job access. Job controls are transport lifecycle tools, not additional registry compute operations. ### SDK-only boundaries The option-price/Greeks wire operations declare Black–Scholes–Merton; do not treat them as generic pricing-engine selectors. The SDK model families (including Heston, SABR, local-volatility and exotic pricing) and custom engines are not universally exposed by MCP. A registered operation may compose a specific model without exposing its whole SDK family. Caller callbacks, custom predicates, custom pricers, and custom policies cannot be serialized into JSON. Use the SDK for those contracts. Operation-specific SDK-only restrictions below are copied from live schema metadata. [MCP guide](https://www.totalfinance.io/docs/totalfinance/guides/mcp) · [Trade lifecycle](https://www.totalfinance.io/docs/totalfinance/guides/trade-lifecycle) · [Errors](https://www.totalfinance.io/docs/totalfinance/guides/errors) ## Profiles Profiles select packs, never permissions. Counts below are registry membership, not the effective tools/list after permissions, stores and job attachment. ### Profile default Packs: `options`, `technical_analysis`, `strategy`, `volatility`, `structure`, `risk`, `performance`, `calendar`, `crypto`, `fixed_income`. Operations: 23. - options: Price an option (Black–Scholes–Merton); Compute first-order Greeks; Solve implied volatility - technical_analysis: Calculate a technical indicator; List technical indicators; Describe one technical indicator - strategy: Analyze an options strategy; List the named-strategy catalog - volatility: Expected move (1σ); Probability of finishing in-the-money; Probability of touching a level; Fit an implied-vol surface; IV rank / percentile / stats; Event-volatility decomposition (earnings) - structure: Dealer exposure & levels from an option chain; Classify options flow (sweeps / blocks / spreads) - risk: Value-at-Risk & Conditional VaR; Portfolio optimization - performance: Full performance summary - calendar: Trading sessions & option expirations - crypto: Perpetual funding → implied carry; Futures basis / cash-and-carry - fixed_income: Bond price/yield analytics ### Profile options Packs: `options`, `volatility`. Operations: 9. - options: Price an option (Black–Scholes–Merton); Compute first-order Greeks; Solve implied volatility - volatility: Expected move (1σ); Probability of finishing in-the-money; Probability of touching a level; Fit an implied-vol surface; IV rank / percentile / stats; Event-volatility decomposition (earnings) ### Profile research Packs: `research`. Operations: 4. - research: Screen a universe; Rank a universe; Score a universe; Run an event study ### Profile strategies Packs: `options`, `strategy`, `volatility`. Operations: 11. - options: Price an option (Black–Scholes–Merton); Compute first-order Greeks; Solve implied volatility - strategy: Analyze an options strategy; List the named-strategy catalog - volatility: Expected move (1σ); Probability of finishing in-the-money; Probability of touching a level; Fit an implied-vol surface; IV rank / percentile / stats; Event-volatility decomposition (earnings) ### Profile portfolio Packs: `portfolio`, `risk`, `performance`, `artifact`. Operations: 10. - portfolio: Open a portfolio ledger or handle and inspect a bounded page; Value a portfolio at an instant; Explain portfolio P&L between two marks; Analyze a portfolio (snapshot, timeline, monitor); Propose a rebalance (a proposal, never an order) - risk: Value-at-Risk & Conditional VaR; Portfolio optimization - performance: Full performance summary - artifact: Read an analysis artifact; Compare two analysis artifacts ### Profile valuation Packs: `valuation`. Operations: 1. - valuation: Value a company from its statements ### Profile backtesting Packs: `backtest`, `performance`, `artifact`. Operations: 8. - backtest: Run a vectorized backtest; Run an options backtest; Run a cross-sectional backtest; Run a portfolio backtest; Bench a baseline policy over one trading-environment episode - performance: Full performance summary - artifact: Read an analysis artifact; Compare two analysis artifacts ### Profile scenarios Packs: `scenario`, `artifact`. Operations: 3. - scenario: Run a scenario set against targets - artifact: Read an analysis artifact; Compare two analysis artifacts ### Profile full Packs: `options`, `technical_analysis`, `strategy`, `volatility`, `structure`, `risk`, `performance`, `calendar`, `crypto`, `fixed_income`, `portfolio`, `scenario`, `research`, `artifact`, `valuation`, `backtest`, `trade`. Operations: 48. - options: Price an option (Black–Scholes–Merton); Compute first-order Greeks; Solve implied volatility - technical_analysis: Calculate a technical indicator; List technical indicators; Describe one technical indicator - strategy: Analyze an options strategy; List the named-strategy catalog - volatility: Expected move (1σ); Probability of finishing in-the-money; Probability of touching a level; Fit an implied-vol surface; IV rank / percentile / stats; Event-volatility decomposition (earnings) - structure: Dealer exposure & levels from an option chain; Classify options flow (sweeps / blocks / spreads) - risk: Value-at-Risk & Conditional VaR; Portfolio optimization - performance: Full performance summary - calendar: Trading sessions & option expirations - crypto: Perpetual funding → implied carry; Futures basis / cash-and-carry - fixed_income: Bond price/yield analytics - portfolio: Open a portfolio ledger or handle and inspect a bounded page; Value a portfolio at an instant; Explain portfolio P&L between two marks; Analyze a portfolio (snapshot, timeline, monitor); Propose a rebalance (a proposal, never an order) - scenario: Run a scenario set against targets - research: Screen a universe; Rank a universe; Score a universe; Run an event study - artifact: Read an analysis artifact; Compare two analysis artifacts - valuation: Value a company from its statements - backtest: Run a vectorized backtest; Run an options backtest; Run a cross-sectional backtest; Run a portfolio backtest; Bench a baseline policy over one trading-environment episode - trade: Preflight a trade plan against the ledger, the market, and the policy; Mint an authorization grant for a preflighted plan; Submit an authorized plan to the paper broker; Cancel an open paper order; Reconcile an execution journal to the ledger; Apply events to a ledger and store the new ledger; Create and store an explicitly defined portfolio ledger ## Operation catalog 48 operations from packsForProfile('full'). All schemas below are complete, not abbreviated. ### totalfinance.artifact.compare Compare two analysis artifacts Compare a baseline and a candidate artifact of the same type leaf by leaf: value differences with absolute and relative deltas, added and removed paths, whether inputs and producers match, and — when a tolerance is supplied — whether every numeric leaf is within it. The result is compareAnalysisArtifacts(...) verbatim. Version: 1; pack: artifact; profiles: `backtesting`, `full`, `portfolio`, `scenarios`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `baseline`, `candidate`. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "baseline": { "type": "object", "properties": { "kind": { "const": "totalfinance.analysis-artifact", "type": "string" }, "schemaVersion": { "type": "integer" }, "id": { "type": "string" }, "artifactType": { "type": "string" }, "producedBy": { "type": "object", "properties": { "operation": { "type": "string" }, "libraryVersion": { "type": "string" } }, "additionalProperties": false, "required": [ "operation" ] }, "conventionsVersion": { "type": "string" }, "inputs": { "type": "object", "properties": { "inputsHash": { "type": "string" }, "snapshotHash": { "type": "string" }, "parameters": {} }, "additionalProperties": false, "required": [ "inputsHash" ] }, "createdFrom": { "type": "array", "items": { "type": "string" } }, "result": { "type": "object", "additionalProperties": {} }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "id", "artifactType", "producedBy", "conventionsVersion", "inputs", "result" ], "description": "A Gate B analysis artifact (totalfinance.analysis-artifact); hashes are re-verified by the read door" }, "candidate": { "type": "object", "properties": { "kind": { "const": "totalfinance.analysis-artifact", "type": "string" }, "schemaVersion": { "type": "integer" }, "id": { "type": "string" }, "artifactType": { "type": "string" }, "producedBy": { "type": "object", "properties": { "operation": { "type": "string" }, "libraryVersion": { "type": "string" } }, "additionalProperties": false, "required": [ "operation" ] }, "conventionsVersion": { "type": "string" }, "inputs": { "type": "object", "properties": { "inputsHash": { "type": "string" }, "snapshotHash": { "type": "string" }, "parameters": {} }, "additionalProperties": false, "required": [ "inputsHash" ] }, "createdFrom": { "type": "array", "items": { "type": "string" } }, "result": { "type": "object", "additionalProperties": {} }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "id", "artifactType", "producedBy", "conventionsVersion", "inputs", "result" ], "description": "A Gate B analysis artifact (totalfinance.analysis-artifact); hashes are re-verified by the read door" }, "tolerance": { "type": "object", "properties": { "absolute": { "type": "number", "minimum": 0 }, "relative": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "absolute", "relative" ], "description": "Two-sided: a leaf is within it when |Δ| ≤ absolute + relative·|baseline|" }, "limits": { "type": "object", "properties": { "maximumDifferences": { "type": "integer", "exclusiveMinimum": 0 }, "maximumLeaves": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "baseline", "candidate" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "artifactType": { "type": "string" }, "identical": { "type": "boolean" }, "artifactIds": { "type": "object" }, "inputs": { "type": "object" }, "producedBy": { "type": "object" }, "result": { "type": "object" }, "warningCounts": { "type": "object" }, "withinTolerance": { "type": [ "boolean", "null" ] }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "artifactType", "identical", "artifactIds", "inputs", "producedBy", "result", "warningCounts", "withinTolerance", "assumptions", "diagnostics" ] } ``` ### totalfinance.artifact.read Read an analysis artifact Validate a Gate B analysis artifact (its envelope, its recomputed inputs hash, and its content-hash identity) and return its identity, type, producer, provenance warnings, table names, and a bounded preview of the stored result — the one read door for any artifact over the wire. Migrations are not registered over the wire; a stored older version is refused with the versions named. Version: 1; pack: artifact; profiles: `backtesting`, `full`, `portfolio`, `scenarios`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `artifact`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "artifact": { "type": "object", "properties": { "kind": { "const": "totalfinance.analysis-artifact", "type": "string" }, "schemaVersion": { "type": "integer" }, "id": { "type": "string" }, "artifactType": { "type": "string" }, "producedBy": { "type": "object", "properties": { "operation": { "type": "string" }, "libraryVersion": { "type": "string" } }, "additionalProperties": false, "required": [ "operation" ] }, "conventionsVersion": { "type": "string" }, "inputs": { "type": "object", "properties": { "inputsHash": { "type": "string" }, "snapshotHash": { "type": "string" }, "parameters": {} }, "additionalProperties": false, "required": [ "inputsHash" ] }, "createdFrom": { "type": "array", "items": { "type": "string" } }, "result": { "type": "object", "additionalProperties": {} }, "tables": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "id", "artifactType", "producedBy", "conventionsVersion", "inputs", "result" ], "description": "A Gate B analysis artifact (totalfinance.analysis-artifact); hashes are re-verified by the read door" } }, "additionalProperties": false, "required": [ "artifact" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "id": { "type": "string" }, "artifactType": { "type": "string" }, "schemaVersion": { "type": "integer" }, "producedBy": { "type": "object" }, "conventionsVersion": { "type": "string" }, "inputs": { "type": "object" }, "createdFrom": { "type": "array", "items": { "type": "string" } }, "tables": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "object" } }, "preview": { "type": "object", "description": "Top-level keys; scalars inline, containers by size" }, "migrationsApplied": { "type": "array", "items": { "type": "object" } } }, "required": [ "id", "artifactType", "schemaVersion", "producedBy", "conventionsVersion", "inputs", "createdFrom", "tables", "warnings", "preview", "migrationsApplied" ] } ``` ### totalfinance.backtest.cross_sectional_run Run a cross-sectional backtest Backtest a point-in-time cross-sectional strategy: a returns dataset with declared features, a universe history with entries and exits, one declarative signal (a versioned factor recipe, a composite score, or a screen), a rebalance schedule, and a portfolio construction (quantile/count/fraction selection on each side; equal, score, inverse-volatility, or risk-budget weights; dollar/sector/beta/factor neutrality; position, weight, turnover, and participation caps — every trim a reported goal). Fills go through the execution policy into the portfolio ledger; the final value reconciles to the ledger NAV. Rebalances, holdings, fills, the ledger, the timeline, attribution, the benchmark block, and the performance summary — crossSectionalBacktest(...) verbatim. Opt-in (backtestPack): payloads and runtime are heavier than the default set; bulk row sets above the row cap travel by handle. Version: 1; pack: backtest; profiles: `backtesting`, `full`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `dataset`. Cost: job. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} SDK-only limitation: 'supplied-weights' takes a caller function and is SDK-only SDK-only limitation: A declared execution policy over session bars (execution.declared): the label is the caller's claim; a caller fill model, session rules, and quote/order-book observations are SDK-only SDK-only limitation: The three declarative signal forms; a signal callback is SDK-only Input JSON Schema: ```json { "type": "object", "properties": { "dataset": { "type": "object", "properties": { "observations": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "availableTimestampMs": { "type": "number" }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" }, { "type": "null" } ] }, "description": "Declared fields only; null is a stated missing value" } }, "additionalProperties": false, "required": [ "instrumentId", "availableTimestampMs", "fields" ] } }, "fieldDefinitions": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "numeric", "category", "text", "boolean" ] }, "unit": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "fieldName", "kind" ] }, "minItems": 1 }, "returns": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "tradingSessionDate": { "type": "string", "format": "date" }, "simpleReturn": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "tradingSessionDate", "simpleReturn" ] }, "description": "Per instrument per session; prices are return-index levels (base 100)" }, "benchmarkReturns": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "tradingSessionDate": { "type": "string", "format": "date" }, "simpleReturn": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "tradingSessionDate", "simpleReturn" ] } }, "groups": { "type": "object", "additionalProperties": { "type": "string" } }, "sizeField": { "type": "string" }, "classification": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "averageDailyVolumes": { "type": "object", "additionalProperties": { "type": "number" } }, "betas": { "type": "object", "additionalProperties": { "type": "number" } } }, "additionalProperties": false, "required": [ "observations", "fieldDefinitions", "returns" ] }, "universeHistory": { "type": "object", "properties": { "universeId": { "type": "string", "minLength": 1 }, "members": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "fromTimestampMs": { "type": "number" }, "toTimestampMs": { "type": "number" }, "exitReason": { "type": "string", "enum": [ "removed", "delisted", "merged", "other" ] }, "delistingReturn": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "fromTimestampMs" ] }, "minItems": 1 } }, "additionalProperties": false, "required": [ "universeId", "members" ] }, "signal": { "anyOf": [ { "type": "object", "properties": { "factorRecipe": { "type": "object", "properties": { "recipeName": { "type": "string", "minLength": 1 }, "recipeVersion": { "type": "integer", "exclusiveMinimum": 0 }, "disclosure": { "type": "string" }, "direction": { "type": "string", "enum": [ "higher-is-better", "lower-is-better" ] }, "features": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "transform": { "type": "string", "enum": [ "raw", "winsorize-then-z-score", "percentile-rank" ] }, "weight": { "type": "number" } }, "additionalProperties": false, "required": [ "field", "transform", "weight" ] }, "minItems": 1 }, "lagTradingSessions": { "type": "integer", "minimum": 0 }, "neutralization": { "type": "string", "enum": [ "none", "sector", "sector-and-size" ] }, "missingValuePolicy": { "type": "string", "enum": [ "exclude", "renormalize-weights" ] } }, "additionalProperties": false, "required": [ "recipeName", "recipeVersion", "disclosure", "direction", "features", "lagTradingSessions", "neutralization", "missingValuePolicy" ], "description": "A versioned research FactorRecipe (canonical or caller-authored), validated by the engine" } }, "additionalProperties": false, "required": [ "factorRecipe" ] }, { "type": "object", "properties": { "score": { "type": "object", "properties": { "components": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "weight": { "type": "number", "exclusiveMinimum": 0 }, "direction": { "type": "string", "enum": [ "higher-is-better", "lower-is-better" ] }, "standardization": { "type": "string", "enum": [ "z-score", "percentile-rank" ] } }, "additionalProperties": false, "required": [ "field", "weight", "direction", "standardization" ] }, "minItems": 1 }, "missingValuePolicy": { "type": "string", "enum": [ "exclude", "renormalize-weights" ] } }, "additionalProperties": false, "required": [ "components", "missingValuePolicy" ] } }, "additionalProperties": false, "required": [ "score" ] }, { "type": "object", "properties": { "screen": { "type": "object", "properties": { "filter": { "type": "object", "additionalProperties": {} }, "orderBy": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": [ "ascending", "descending" ] } }, "additionalProperties": false, "required": [ "field", "direction" ] }, "minItems": 1 }, "missingValuePolicy": { "type": "string", "enum": [ "exclude", "evaluate-as-false" ] } }, "additionalProperties": false, "required": [ "orderBy", "missingValuePolicy" ] } }, "additionalProperties": false, "required": [ "screen" ] } ], "description": "The three declarative signal forms; a signal callback is SDK-only" }, "rebalanceSchedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly", "quarterly" ] }, "session": { "type": "string", "enum": [ "open", "close" ] }, "bufferBand": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "frequency", "session" ] }, "portfolioConstruction": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "equal-weight", "score-weight", "inverse-volatility", "risk-budget" ], "description": "'supplied-weights' takes a caller function and is SDK-only" }, "long": { "anyOf": [ { "type": "object", "properties": { "topQuantile": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "topQuantile" ] }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "count" ] }, { "type": "object", "properties": { "fraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "fraction" ] } ] }, "short": { "anyOf": [ { "type": "object", "properties": { "bottomQuantile": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "bottomQuantile" ] }, { "type": "object", "properties": { "count": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "count" ] }, { "type": "object", "properties": { "fraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "fraction" ] } ] }, "neutrality": { "type": "string", "enum": [ "none", "dollar", "sector", "beta", "factor" ] }, "neutralizeAgainst": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "field" ] }, "maximumPositions": { "type": "integer", "exclusiveMinimum": 0 }, "maximumPositionWeight": { "type": "number", "exclusiveMinimum": 0 }, "minimumPositionWeight": { "type": "number", "minimum": 0 }, "maximumTurnover": { "type": "number", "minimum": 0 }, "maximumParticipation": { "type": "number", "exclusiveMinimum": 0 }, "volatilityLookbackSessions": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "method", "long" ] }, "execution": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "ambiguity": { "type": "string", "enum": [ "optimistic", "pessimistic", "deterministic-path", "reject" ] }, "costs": { "type": "object", "properties": { "commission": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "perShare", "type": "string" }, "amountPerShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amountPerShare" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "amount": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amount" ] } ], "description": "A declarative commission model (fees.none / bps / perShare / fixed)" }, "slippage": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "perShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "perShare" ] }, { "type": "object", "properties": { "model": { "const": "spread", "type": "string" }, "spread": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "spread" ] } ], "description": "A declarative slippage model (slippage.none / bps / fixed / spread)" }, "spread": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "halfSpreadBps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] } ] }, "marketImpact": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "squareRoot", "type": "string" }, "coefficient": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "coefficient" ] } ] }, "latencySessions": { "type": "integer", "minimum": 0 }, "participation": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "partialFills": { "type": "string", "enum": [ "allow", "reject" ] }, "timeInForce": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "day", "gtc" ] }, "expireAtSessionClose": { "type": "boolean" } }, "additionalProperties": false, "required": [ "default", "expireAtSessionClose" ] }, "margin": { "type": "object", "properties": { "buyingPowerMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "initialMarginRate": { "type": "number", "minimum": 0 }, "maintenanceMarginRate": { "type": "number", "minimum": 0 }, "forcedLiquidation": { "type": "string", "enum": [ "none", "close-largest-loss", "pro-rata" ] } }, "additionalProperties": false, "required": [ "buyingPowerMultiplier", "initialMarginRate", "maintenanceMarginRate", "forcedLiquidation" ] } }, "additionalProperties": false, "required": [ "label" ], "description": "A declared execution policy over session bars (execution.declared): the label is the caller's claim; a caller fill model, session rules, and quote/order-book observations are SDK-only" }, "transactionCostModel": { "type": "object", "properties": { "commission": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "perShare", "type": "string" }, "amountPerShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amountPerShare" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "amount": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amount" ] } ], "description": "A declarative commission model (fees.none / bps / perShare / fixed)" }, "slippage": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "perShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "perShare" ] }, { "type": "object", "properties": { "model": { "const": "spread", "type": "string" }, "spread": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "spread" ] } ], "description": "A declarative slippage model (slippage.none / bps / fixed / spread)" } }, "additionalProperties": false }, "initialCapital": { "type": "number", "exclusiveMinimum": 0, "description": "Default 1,000,000" }, "baseCurrency": { "type": "string", "minLength": 1, "description": "Default 'USD'" }, "window": { "type": "object", "properties": { "fromTimestampMs": { "type": "number" }, "toTimestampMs": { "type": "number" } }, "additionalProperties": false }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0, "description": "Default 252" }, "riskFreeRate": { "type": "number", "description": "Per-period; default 0" }, "seed": { "type": "integer", "minimum": 0, "description": "Seeds only the bootstrap confidence intervals; absent = none" } }, "additionalProperties": false, "required": [ "dataset", "universeHistory", "signal", "rebalanceSchedule", "portfolioConstruction" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "rebalances": { "type": "array", "items": { "type": "object" } }, "holdings": { "type": "array", "items": { "type": "object" } }, "points": { "type": "array", "items": { "type": "object" } }, "returns": { "type": "array", "items": { "type": "number" } }, "trades": { "type": "array", "items": { "type": "object" } }, "fills": { "type": "array", "items": { "type": "object" } }, "ledger": { "type": "object", "description": "The portfolio ledger snapshot (events)" }, "timeline": { "type": "object", "description": "The ledger timeline" }, "attribution": { "type": "object" }, "benchmark": { "type": [ "object", "null" ] }, "performance": { "type": "object", "description": "The standard performance summary" }, "performanceConfidence": { "type": [ "object", "null" ] }, "finalValue": { "type": "number" }, "runId": { "type": "string" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "rebalances", "holdings", "points", "returns", "trades", "fills", "ledger", "timeline", "attribution", "benchmark", "performance", "performanceConfidence", "finalValue", "runId", "assumptions", "diagnostics" ] } ``` ### totalfinance.backtest.environment_episode Bench a baseline policy over one trading-environment episode Run one of the six maintained baseline policies through the deterministic trading environment over a catalogue episode (or a named declarative definition) at a seed, and return Agent Bench's report for that episode: operational conformance (look-ahead, replay equality, duplicate orders under the retry drive, external-order attempts, reconciliation; the mask and limit counts) apart from strategy quality (return, volatility, Sharpe, Sortino, drawdown, turnover, cost, exposure, violations) — no single score by design. With artifact: 'embed', the recorded episode travels as an `environment` run artifact that replays to its run hash. Declarative inputs only: a TypeScript policy or a reward goal callback is SDK-only. Opt-in (backtestPack). Version: 1; pack: backtest; profiles: `backtesting`, `full`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `episode.definition.marketData`. Cost: job. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} SDK-only limitation: A built-in kind; 'custom' brings its own adapter and is SDK-only SDK-only limitation: A declared execution policy over session bars (execution.declared): the label is the caller's claim; a caller fill model, session rules, and quote/order-book observations are SDK-only SDK-only limitation: A maintained baseline; a TypeScript policy is SDK-only SDK-only limitation: Run one of the six maintained baseline policies through the deterministic trading environment over a catalogue episode (or a named declarative definition) at a seed, and return Agent Bench's report for that episode: operational conformance (look-ahead, replay equality, duplicate orders under the retry drive, external-order attempts, reconciliation; the mask and limit counts) apart from strategy quality (return, volatility, Sharpe, Sortino, drawdown, turnover, cost, exposure, violations) — no single score by design. With artifact: 'embed', the recorded episode travels as an `environment` run artifact that replays to its run hash. Declarative inputs only: a TypeScript policy or a reward goal callback is SDK-only. Opt-in (backtestPack). SDK-only limitation: The declared reward composition; a goal callback is SDK-only Input JSON Schema: ```json { "type": "object", "properties": { "episode": { "anyOf": [ { "type": "string", "enum": [ "trending", "mean-reverting", "range-bound", "volatility-expansion", "volatility-contraction", "overnight-gaps", "limit-moves", "stale-data", "missing-data", "duplicated-data", "corrected-data", "out-of-order-data", "wide-spreads", "thin-liquidity", "option-expiration", "margin-pressure", "retry-storm", "corporate-actions", "multi-currency", "model-market-disagreement" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "definition": { "type": "object", "properties": { "accounting": { "type": "object", "properties": { "baseCurrency": { "type": "string", "minLength": 1 }, "initialCash": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 1 }, "amount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "currency", "amount" ] }, "minItems": 1 }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "settlement": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "T+0", "T+1", "T+2" ] } } }, "additionalProperties": false, "required": [ "baseCurrency", "initialCash" ] }, "instruments": { "type": "object", "additionalProperties": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "equity", "etf", "option", "future", "fx-forward", "crypto-spot", "crypto-perpetual", "bond" ], "description": "A built-in kind; 'custom' brings its own adapter and is SDK-only" }, "currency": { "type": "string", "minLength": 1 }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "right": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number", "exclusiveMinimum": 0 }, "expiryTimestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "right", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "assetClass": { "type": "string", "enum": [ "equity", "etf", "option", "future", "fx-forward", "crypto-spot", "crypto-perpetual", "bond", "cash" ] }, "classification": { "type": "object", "properties": { "underlying": { "type": "string" }, "assetClass": { "type": "string" }, "strategy": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "roll": { "type": "object", "properties": { "toInstrumentId": { "type": "string", "minLength": 1 }, "sessionsBeforeExpiry": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "toInstrumentId", "sessionsBeforeExpiry" ] }, "coupon": { "type": "object", "properties": { "annualRate": { "type": "number" }, "paymentsPerYear": { "type": "integer", "exclusiveMinimum": 0 }, "faceValuePerUnit": { "type": "number", "exclusiveMinimum": 0 }, "dayCount": { "type": "string", "enum": [ "ACT/365F", "30/360" ] }, "issueDate": { "type": "string", "format": "date" }, "maturityDate": { "type": "string", "format": "date" } }, "additionalProperties": false, "required": [ "annualRate", "paymentsPerYear", "issueDate", "maturityDate" ] }, "forward": { "type": "object", "properties": { "maturityTimestampMs": { "type": "number" }, "baseCurrency": { "type": "string", "minLength": 1 }, "quoteCurrency": { "type": "string", "minLength": 1 }, "contractRate": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maturityTimestampMs", "baseCurrency", "quoteCurrency", "contractRate" ] } }, "additionalProperties": false, "required": [ "kind", "currency" ], "description": "An instrument specification; the terms each kind needs are validated by the engine" } }, "marketData": { "type": "object", "properties": { "bars": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "vwap": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "open", "high", "low", "close" ] } }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number" }, "askSize": { "type": "number" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "bid", "ask" ] } }, "trades": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } }, "sequence": { "type": "number" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "price", "size" ] } }, "orderBooks": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "bids": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" } }, "additionalProperties": false, "required": [ "price", "size" ] } }, "asks": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" } }, "additionalProperties": false, "required": [ "price", "size" ] } } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "bids", "asks" ] } }, "optionChains": { "type": "array", "items": { "type": "object", "properties": { "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Epoch ms, YYYY-MM-DD, or a zoned ISO datetime" }, "underlyingPrice": { "type": "number", "exclusiveMinimum": 0 }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "underlying": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "style": { "type": "string", "enum": [ "european", "american" ] }, "strike": { "type": "number", "exclusiveMinimum": 0 }, "expiry": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([Tt ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?([Zz]|[+-]\\d{2}:?\\d{2}))?$", "description": "Display label: 'YYYY-MM-DD' or a zoned ISO datetime (matches the builders)" }, "expiresAt": { "type": "number", "description": "Resolved expiration instant (epoch ms) — stamped by the builders" }, "expiryConvention": { "type": "string", "enum": [ "us-equity-close", "explicit-instant" ], "description": "How the label resolved to the instant" }, "multiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "type": "string", "enum": [ "physical", "cash" ] }, "exerciseTime": { "type": "string", "enum": [ "AM", "PM" ] }, "currency": { "type": "string" }, "root": { "type": "string" }, "occSymbol": { "type": "string" }, "deliverable": { "type": "object", "properties": { "cash": { "type": "number" }, "shares": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" } }, "additionalProperties": false, "required": [ "symbol", "quantity" ] } }, "notes": { "type": "string" } }, "additionalProperties": false }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "underlying", "type", "style", "strike", "expiry", "expiresAt", "expiryConvention" ] }, "timestampMs": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number", "minimum": 0 }, "askSize": { "type": "number", "minimum": 0 }, "mid": { "type": "number" }, "last": { "type": "number" }, "mark": { "type": "number" }, "volume": { "type": "number", "minimum": 0 }, "openInterest": { "type": "number", "minimum": 0 }, "underlyingPrice": { "type": "number", "exclusiveMinimum": 0 }, "impliedVolatility": { "type": "number", "minimum": 0 }, "greeks": { "type": "object", "properties": { "delta": { "type": "number" }, "gamma": { "type": "number" }, "theta": { "type": "number" }, "vega": { "type": "number" }, "rho": { "type": "number" }, "provenance": { "type": "object", "properties": { "source": { "type": "string" }, "model": { "type": "string" }, "timestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "source" ] } }, "additionalProperties": false, "required": [ "delta" ], "description": "Per-share Greeks in display units (theta per day, vega per vol point, rho per 1%), with optional provenance" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "contract", "timestampMs" ] } } }, "additionalProperties": false, "required": [ "asOf", "underlyingPrice", "quotes" ] } }, "fxRates": { "type": "array", "items": { "type": "object", "properties": { "timestampMs": { "type": "number" }, "baseCurrency": { "type": "string", "minLength": 1 }, "quoteCurrency": { "type": "string", "minLength": 1 }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "timestampMs", "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "forwardRates": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "forwardRate": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "instrumentId", "timestampMs", "forwardRate" ] } }, "fundingRates": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "fundingRate": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "timestampMs", "fundingRate" ] } }, "corporateActions": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "effectiveDate": { "type": "string", "format": "date" }, "type": { "type": "string", "enum": [ "split", "reverseSplit", "dividend", "symbolChange", "merger", "spinoff", "other" ] }, "ratio": { "type": "number", "exclusiveMinimum": 0 }, "cash": { "type": "number" }, "newSymbol": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "symbol", "effectiveDate", "type" ] } }, "dividends": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "exDate": { "type": "string", "format": "date" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "payDate": { "type": "string", "format": "date" } }, "additionalProperties": false, "required": [ "instrumentId", "exDate", "amount" ] } }, "coupons": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "paymentDate": { "type": "string", "format": "date" }, "amountPerUnit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "instrumentId", "paymentDate", "amountPerUnit" ] } } }, "additionalProperties": false }, "execution": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "ambiguity": { "type": "string", "enum": [ "optimistic", "pessimistic", "deterministic-path", "reject" ] }, "costs": { "type": "object", "properties": { "commission": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "perShare", "type": "string" }, "amountPerShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amountPerShare" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "amount": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amount" ] } ], "description": "A declarative commission model (fees.none / bps / perShare / fixed)" }, "slippage": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "perShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "perShare" ] }, { "type": "object", "properties": { "model": { "const": "spread", "type": "string" }, "spread": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "spread" ] } ], "description": "A declarative slippage model (slippage.none / bps / fixed / spread)" }, "spread": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "halfSpreadBps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] } ] }, "marketImpact": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "squareRoot", "type": "string" }, "coefficient": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "coefficient" ] } ] }, "latencySessions": { "type": "integer", "minimum": 0 }, "participation": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "partialFills": { "type": "string", "enum": [ "allow", "reject" ] }, "timeInForce": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "day", "gtc" ] }, "expireAtSessionClose": { "type": "boolean" } }, "additionalProperties": false, "required": [ "default", "expireAtSessionClose" ] }, "margin": { "type": "object", "properties": { "buyingPowerMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "initialMarginRate": { "type": "number", "minimum": 0 }, "maintenanceMarginRate": { "type": "number", "minimum": 0 }, "forcedLiquidation": { "type": "string", "enum": [ "none", "close-largest-loss", "pro-rata" ] } }, "additionalProperties": false, "required": [ "buyingPowerMultiplier", "initialMarginRate", "maintenanceMarginRate", "forcedLiquidation" ] } }, "additionalProperties": false, "required": [ "label" ], "description": "A declared execution policy over session bars (execution.declared): the label is the caller's claim; a caller fill model, session rules, and quote/order-book observations are SDK-only" }, "externalFlows": { "type": "array", "items": { "type": "object", "properties": { "timestampMs": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "timestampMs", "amount", "currency" ] } }, "calendar": { "type": "string", "enum": [ "NYSE", "CBOE", "ALWAYS_OPEN" ] }, "window": { "type": "object", "properties": { "fromTimestampMs": { "type": "number" }, "toTimestampMs": { "type": "number" } }, "additionalProperties": false }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0, "description": "Default 252" }, "seed": { "type": "integer", "minimum": 0 }, "maximumSteps": { "type": "integer", "exclusiveMinimum": 0 }, "limits": { "type": "object", "properties": { "maximumPositionWeight": { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, "maximumGrossLeverage": { "type": "number", "exclusiveMinimum": 0 }, "maximumDrawdown": { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, "maximumDailyLoss": { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, "maximumDaysToLiquidate": { "type": "number", "exclusiveMinimum": 0 }, "minimumSettledCash": { "type": "number" }, "allowUndefinedRiskOptions": { "type": "boolean" }, "maximumPositionNotional": { "type": "number", "exclusiveMinimum": 0 }, "onBreach": { "type": "string", "enum": [ "terminate", "reject-and-continue" ] } }, "additionalProperties": false }, "reward": { "type": "object", "properties": { "pnl": { "type": "number" }, "drawdown": { "type": "number" }, "turnover": { "type": "number" }, "cost": { "type": "number" }, "concentration": { "type": "number" }, "leverage": { "type": "number" }, "riskViolation": { "type": "number" }, "benchmark": { "type": "object", "properties": { "weight": { "type": "number" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "weight", "instrumentId" ] } }, "additionalProperties": false, "description": "The declared reward composition; a goal callback is SDK-only" }, "features": { "type": "object", "properties": { "lookbackReturns": { "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0 }, "minItems": 1 }, "realizedVolatility": { "type": "object", "properties": { "lookbacks": { "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0 }, "minItems": 1 }, "annualization": { "type": "number", "exclusiveMinimum": 0, "description": "Bars per year scaling the per-bar σ (252 daily, 52 weekly, 12 monthly; 1 = per-bar). Required: the environment never assumes the bar frequency." } }, "additionalProperties": false, "required": [ "lookbacks", "annualization" ] }, "drawdown": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "accounting", "instruments", "marketData" ] } }, "additionalProperties": false, "required": [ "id", "definition" ] } ], "description": "A catalogue id, or a named declarative definition" }, "policy": { "anyOf": [ { "type": "object", "properties": { "baseline": { "const": "holdCash", "type": "string" } }, "additionalProperties": false, "required": [ "baseline" ] }, { "type": "object", "properties": { "baseline": { "const": "buyAndHold", "type": "string" }, "weights": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0 } } }, "additionalProperties": false, "required": [ "baseline" ] }, { "type": "object", "properties": { "baseline": { "const": "periodicRebalance", "type": "string" }, "everySessions": { "type": "integer", "exclusiveMinimum": 0 }, "weights": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0 } } }, "additionalProperties": false, "required": [ "baseline", "everySessions" ] }, { "type": "object", "properties": { "baseline": { "const": "randomValidAction", "type": "string" }, "seed": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "baseline", "seed" ] }, { "type": "object", "properties": { "baseline": { "const": "riskParity", "type": "string" }, "lookback": { "type": "integer", "exclusiveMinimum": 0 }, "everySessions": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseline", "lookback" ] }, { "type": "object", "properties": { "baseline": { "const": "momentumCrossover", "type": "string" }, "fast": { "type": "integer", "exclusiveMinimum": 0 }, "slow": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseline", "fast", "slow" ] } ], "description": "A maintained baseline; a TypeScript policy is SDK-only" }, "seed": { "type": "integer", "minimum": 0, "description": "Default 42" }, "artifact": { "type": "string", "enum": [ "none", "embed" ], "description": "Default 'none'; 'embed' returns the recorded episode as an `environment` run artifact" } }, "additionalProperties": false, "required": [ "episode", "policy" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "policy": { "type": "string" }, "episode": { "type": "object", "description": "The bench report for the one episode: operational and strategy blocks" }, "trace": { "type": "object", "description": "The recorded episode: runId, engineRunId, traceHash, steps, rewardTotal, terminated, truncated, reason" }, "artifact": { "type": [ "object", "null" ], "description": "The `environment` run artifact when artifact is 'embed'" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "policy", "episode", "trace", "artifact", "assumptions", "diagnostics" ] } ``` ### totalfinance.backtest.options_run Run an options backtest Backtest a declarative options strategy over chain snapshots: structure selection by delta and DTE, exit and roll triggers, optional delta hedging, declarative commission and slippage, American assignment modelling, and the marking policy (current-quote or entry volatility; what a missing mark does). Several rules may hold several trades at once (book), pre-trade limits reject entries with rows, combo or legged fills, quote freshness, split lineage, dividend evidence, the surface summary, and the portfolio ledger the equity reconciles to. Equity points, trades with per-leg attribution and mark counts, settlements, and the standard performance summary. The result is optionsBacktest(...) verbatim. Opt-in (backtestPack): payloads and runtime are heavier than the default set. Version: 1; pack: backtest; profiles: `backtesting`, `full`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: job. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} SDK-only limitation: 'flat' (default) enters only when no position is open; a caller predicate is SDK-only SDK-only limitation: A `when` predicate is SDK-only SDK-only limitation: The declarative entry structures; a `build` callback is SDK-only Input JSON Schema: ```json { "type": "object", "properties": { "chains": { "type": "array", "items": { "type": "object", "properties": { "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Epoch ms, YYYY-MM-DD, or a zoned ISO datetime" }, "underlyingPrice": { "type": "number", "exclusiveMinimum": 0 }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "underlying": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "style": { "type": "string", "enum": [ "european", "american" ] }, "strike": { "type": "number", "exclusiveMinimum": 0 }, "expiry": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([Tt ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?([Zz]|[+-]\\d{2}:?\\d{2}))?$", "description": "Display label: 'YYYY-MM-DD' or a zoned ISO datetime (matches the builders)" }, "expiresAt": { "type": "number", "description": "Resolved expiration instant (epoch ms) — stamped by the builders" }, "expiryConvention": { "type": "string", "enum": [ "us-equity-close", "explicit-instant" ], "description": "How the label resolved to the instant" }, "multiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "type": "string", "enum": [ "physical", "cash" ] }, "exerciseTime": { "type": "string", "enum": [ "AM", "PM" ] }, "currency": { "type": "string" }, "root": { "type": "string" }, "occSymbol": { "type": "string" }, "deliverable": { "type": "object", "properties": { "cash": { "type": "number" }, "shares": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" } }, "additionalProperties": false, "required": [ "symbol", "quantity" ] } }, "notes": { "type": "string" } }, "additionalProperties": false }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "underlying", "type", "style", "strike", "expiry", "expiresAt", "expiryConvention" ] }, "timestampMs": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number", "minimum": 0 }, "askSize": { "type": "number", "minimum": 0 }, "mid": { "type": "number" }, "last": { "type": "number" }, "mark": { "type": "number" }, "volume": { "type": "number", "minimum": 0 }, "openInterest": { "type": "number", "minimum": 0 }, "underlyingPrice": { "type": "number", "exclusiveMinimum": 0 }, "impliedVolatility": { "type": "number", "minimum": 0 }, "greeks": { "type": "object", "properties": { "delta": { "type": "number" }, "gamma": { "type": "number" }, "theta": { "type": "number" }, "vega": { "type": "number" }, "rho": { "type": "number" }, "provenance": { "type": "object", "properties": { "source": { "type": "string" }, "model": { "type": "string" }, "timestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "source" ] } }, "additionalProperties": false, "required": [ "delta" ], "description": "Per-share Greeks in display units (theta per day, vega per vol point, rho per 1%), with optional provenance" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "contract", "timestampMs" ] } } }, "additionalProperties": false, "required": [ "asOf", "underlyingPrice", "quotes" ] }, "description": "Chain snapshots (any order; the engine sorts)" }, "marking": { "type": "object", "properties": { "volatility": { "type": "string", "enum": [ "current-quote", "entry" ] }, "missingMark": { "type": "string", "enum": [ "refuse", "entry-volatility", "carry-last-volatility" ] }, "maximumQuoteAgeMs": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "description": "Default: re-mark from the current quote; refuse a missing mark" }, "initialCapital": { "type": "number", "exclusiveMinimum": 0, "description": "Default 100,000" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal, e.g. 0.045) pricing every mark — REQUIRED; the engine never assumes a rate" }, "dividendYield": { "type": "number", "description": "Default 0" }, "entry": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "ironCondor", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "wingWidth": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta", "wingWidth" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "type": "string", "enum": [ "bullCallSpread", "bearCallSpread", "bullPutSpread", "bearPutSpread" ] }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "width": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta", "width" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "strangle", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "straddle", "type": "string" }, "select": { "type": "object", "properties": { "strike": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "coveredCall", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "stockPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "protectivePut", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "stockPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "type": "string", "enum": [ "calendarCallSpread", "calendarPutSpread", "diagonalCallSpread", "diagonalPutSpread", "doubleDiagonal" ] }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "nearDaysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "farDaysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "width": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "shortDelta", "nearDaysToExpiry", "farDaysToExpiry" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] } ], "description": "The declarative entry structures; a `build` callback is SDK-only" }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "ironCondor", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "wingWidth": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta", "wingWidth" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "type": "string", "enum": [ "bullCallSpread", "bearCallSpread", "bullPutSpread", "bearPutSpread" ] }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "width": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta", "width" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "strangle", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "straddle", "type": "string" }, "select": { "type": "object", "properties": { "strike": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "coveredCall", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "stockPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "const": "protectivePut", "type": "string" }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "stockPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "shortDelta" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Names the rule in trades and rows" }, "when": { "type": "string", "enum": [ "flat", "always" ], "description": "'flat' (default) enters only when no position is open; a caller predicate is SDK-only" }, "daysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "sizing": { "anyOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "quantity" ] }, { "type": "object", "properties": { "maxMarginFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maxMarginFraction" ] } ], "description": "Default { quantity: 1 }" }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] }, "structure": { "type": "string", "enum": [ "calendarCallSpread", "calendarPutSpread", "diagonalCallSpread", "diagonalPutSpread", "doubleDiagonal" ] }, "select": { "type": "object", "properties": { "shortDelta": { "type": "number" }, "nearDaysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "farDaysToExpiry": { "type": "object", "properties": { "target": { "type": "number" }, "min": { "type": "number" }, "max": { "type": "number" } }, "additionalProperties": false, "required": [ "target" ] }, "width": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "shortDelta", "nearDaysToExpiry", "farDaysToExpiry" ] } }, "additionalProperties": false, "required": [ "daysToExpiry", "structure", "select" ] } ], "description": "The declarative entry structures; a `build` callback is SDK-only" }, "minItems": 1, "description": "Several rules, each a member of the book; exactly one of entry and rules" }, "exit": { "type": "object", "properties": { "profitTarget": { "type": "number", "description": "Fraction of entry premium, e.g. 0.5" }, "stopLoss": { "type": "number", "description": "Multiple of entry premium, e.g. 2" }, "daysToExpiry": { "type": "number", "description": "Close at or below this DTE" } }, "additionalProperties": false, "description": "A `when` predicate is SDK-only" }, "roll": { "type": "object", "properties": { "when": { "type": "object", "properties": { "profitTarget": { "type": "number", "description": "Fraction of entry premium, e.g. 0.5" }, "stopLoss": { "type": "number", "description": "Multiple of entry premium, e.g. 2" }, "daysToExpiry": { "type": "number", "description": "Close at or below this DTE" } }, "additionalProperties": false } }, "additionalProperties": false }, "hedge": { "type": "object", "properties": { "deltaBand": { "type": "number", "exclusiveMinimum": 0 }, "commission": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "perShare", "type": "string" }, "amountPerShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amountPerShare" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "amount": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amount" ] } ], "description": "A declarative commission model (fees.none / bps / perShare / fixed)" }, "slippage": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "perShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "perShare" ] }, { "type": "object", "properties": { "model": { "const": "spread", "type": "string" }, "spread": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "spread" ] } ], "description": "A declarative slippage model (slippage.none / bps / fixed / spread)" } }, "additionalProperties": false, "required": [ "deltaBand" ] }, "commission": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "perShare", "type": "string" }, "amountPerShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amountPerShare" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "amount": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amount" ] } ], "description": "A declarative commission model (fees.none / bps / perShare / fixed)" }, "slippage": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "perShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "perShare" ] }, { "type": "object", "properties": { "model": { "const": "spread", "type": "string" }, "spread": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "spread" ] } ], "description": "A declarative slippage model (slippage.none / bps / fixed / spread)" }, "assignment": { "type": "string", "enum": [ "model", "none" ] }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0, "description": "Default 252" }, "book": { "type": "object", "properties": { "maximumOpenPositions": { "type": "integer", "exclusiveMinimum": 0 }, "maximumPerUnderlying": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "description": "Default: one open trade" }, "limits": { "type": "object", "properties": { "maximumMarginFraction": { "type": "number", "exclusiveMinimum": 0 }, "maximumNetDelta": { "type": "number", "minimum": 0 }, "maximumNetVega": { "type": "number", "minimum": 0 }, "maximumConcentration": { "type": "number", "exclusiveMinimum": 0 }, "scenarioLoss": { "type": "object", "properties": { "spotShocks": { "type": "array", "items": { "type": "number" }, "minItems": 1 }, "volatilityShocks": { "type": "array", "items": { "type": "number" }, "minItems": 1 }, "maximumLossFraction": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "spotShocks", "volatilityShocks", "maximumLossFraction" ] } }, "additionalProperties": false, "description": "Pre-trade limits on the post-trade book; a breach is a limitRejections row" }, "fillPolicy": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "combo", "legged" ] }, "partialFill": { "type": "string", "enum": [ "reject", "allow" ] }, "price": { "type": "string", "enum": [ "bid", "ask", "mid", "last", "mark" ] } }, "additionalProperties": false }, "quoteFreshness": { "type": "object", "properties": { "maximumQuoteAgeMs": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "maximumQuoteAgeMs" ] }, "corporateActions": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "effectiveDate": { "type": "string", "format": "date" }, "type": { "type": "string", "enum": [ "split", "reverseSplit", "dividend", "symbolChange", "merger", "spinoff", "other" ] }, "ratio": { "type": "number", "exclusiveMinimum": 0 }, "cash": { "type": "number" }, "newSymbol": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "symbol", "effectiveDate", "type" ] } }, "dividends": { "type": "array", "items": { "type": "object", "properties": { "underlying": { "type": "string", "minLength": 1 }, "exDate": { "type": "string", "format": "date" }, "amount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "underlying", "exDate", "amount" ] } }, "baseCurrency": { "type": "string", "minLength": 1, "description": "Default 'USD'" } }, "additionalProperties": false, "required": [ "chains", "riskFreeRate", "exit" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "points": { "type": "array", "items": { "type": "object" } }, "returns": { "type": "array", "items": { "type": "number" } }, "trades": { "type": "array", "items": { "type": "object" } }, "settlements": { "type": "array", "items": { "type": "object" } }, "finalValue": { "type": "number" }, "performance": { "type": "object", "description": "The standard performance summary" }, "limitRejections": { "type": "array", "items": { "type": "object" } }, "fillRejections": { "type": "array", "items": { "type": "object" } }, "surface": { "type": "array", "items": { "type": "object" } }, "ledger": { "type": "object", "description": "The portfolio ledger snapshot (events)" }, "timeline": { "type": [ "object", "null" ], "description": "The ledger timeline (null under two marks)" }, "runId": { "type": "string" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "points", "returns", "trades", "settlements", "finalValue", "performance", "limitRejections", "fillRejections", "surface", "ledger", "timeline", "runId", "assumptions", "diagnostics" ] } ``` ### totalfinance.backtest.portfolio_run Run a portfolio backtest Backtest a multi-asset portfolio through the ledger: instruments with built-in adapters (equity, etf, option, future, fx-forward, crypto-spot, crypto-perpetual, bond), market data by row set, a model or inline targets on a rebalance schedule, an execution policy with settlement lags, external flows, a calendar, and the margin check with forced liquidation. Every fill, flow, lifecycle fact, and liquidation is a portfolio event; the equity is the ledger's net asset value. The result is portfolioBacktest(...) verbatim. Opt-in (backtestPack): payloads and runtime are heavier than the default set; bulk row sets above the row cap travel by handle. Version: 1; pack: backtest; profiles: `backtesting`, `full`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `marketData`. Cost: job. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} SDK-only limitation: A built-in kind; 'custom' brings its own adapter and is SDK-only SDK-only limitation: A declared execution policy over session bars (execution.declared): the label is the caller's claim; a caller fill model, session rules, and quote/order-book observations are SDK-only SDK-only limitation: The declarative strategy; an onSession callback is SDK-only Input JSON Schema: ```json { "type": "object", "properties": { "accounting": { "type": "object", "properties": { "baseCurrency": { "type": "string", "minLength": 1 }, "initialCash": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 1 }, "amount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "currency", "amount" ] }, "minItems": 1 }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "settlement": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "T+0", "T+1", "T+2" ] } } }, "additionalProperties": false, "required": [ "baseCurrency", "initialCash" ] }, "instruments": { "type": "object", "additionalProperties": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "equity", "etf", "option", "future", "fx-forward", "crypto-spot", "crypto-perpetual", "bond" ], "description": "A built-in kind; 'custom' brings its own adapter and is SDK-only" }, "currency": { "type": "string", "minLength": 1 }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "right": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number", "exclusiveMinimum": 0 }, "expiryTimestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "right", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "assetClass": { "type": "string", "enum": [ "equity", "etf", "option", "future", "fx-forward", "crypto-spot", "crypto-perpetual", "bond", "cash" ] }, "classification": { "type": "object", "properties": { "underlying": { "type": "string" }, "assetClass": { "type": "string" }, "strategy": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "roll": { "type": "object", "properties": { "toInstrumentId": { "type": "string", "minLength": 1 }, "sessionsBeforeExpiry": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "toInstrumentId", "sessionsBeforeExpiry" ] }, "coupon": { "type": "object", "properties": { "annualRate": { "type": "number" }, "paymentsPerYear": { "type": "integer", "exclusiveMinimum": 0 }, "faceValuePerUnit": { "type": "number", "exclusiveMinimum": 0 }, "dayCount": { "type": "string", "enum": [ "ACT/365F", "30/360" ] }, "issueDate": { "type": "string", "format": "date" }, "maturityDate": { "type": "string", "format": "date" } }, "additionalProperties": false, "required": [ "annualRate", "paymentsPerYear", "issueDate", "maturityDate" ] }, "forward": { "type": "object", "properties": { "maturityTimestampMs": { "type": "number" }, "baseCurrency": { "type": "string", "minLength": 1 }, "quoteCurrency": { "type": "string", "minLength": 1 }, "contractRate": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "maturityTimestampMs", "baseCurrency", "quoteCurrency", "contractRate" ] } }, "additionalProperties": false, "required": [ "kind", "currency" ], "description": "An instrument specification; the terms each kind needs are validated by the engine" } }, "marketData": { "type": "object", "properties": { "bars": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "vwap": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "open", "high", "low", "close" ] } }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number" }, "askSize": { "type": "number" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "bid", "ask" ] } }, "trades": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } }, "sequence": { "type": "number" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "price", "size" ] } }, "orderBooks": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "bids": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" } }, "additionalProperties": false, "required": [ "price", "size" ] } }, "asks": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" } }, "additionalProperties": false, "required": [ "price", "size" ] } } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "bids", "asks" ] } }, "optionChains": { "type": "array", "items": { "type": "object", "properties": { "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Epoch ms, YYYY-MM-DD, or a zoned ISO datetime" }, "underlyingPrice": { "type": "number", "exclusiveMinimum": 0 }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "underlying": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "style": { "type": "string", "enum": [ "european", "american" ] }, "strike": { "type": "number", "exclusiveMinimum": 0 }, "expiry": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([Tt ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?([Zz]|[+-]\\d{2}:?\\d{2}))?$", "description": "Display label: 'YYYY-MM-DD' or a zoned ISO datetime (matches the builders)" }, "expiresAt": { "type": "number", "description": "Resolved expiration instant (epoch ms) — stamped by the builders" }, "expiryConvention": { "type": "string", "enum": [ "us-equity-close", "explicit-instant" ], "description": "How the label resolved to the instant" }, "multiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "type": "string", "enum": [ "physical", "cash" ] }, "exerciseTime": { "type": "string", "enum": [ "AM", "PM" ] }, "currency": { "type": "string" }, "root": { "type": "string" }, "occSymbol": { "type": "string" }, "deliverable": { "type": "object", "properties": { "cash": { "type": "number" }, "shares": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" } }, "additionalProperties": false, "required": [ "symbol", "quantity" ] } }, "notes": { "type": "string" } }, "additionalProperties": false }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "underlying", "type", "style", "strike", "expiry", "expiresAt", "expiryConvention" ] }, "timestampMs": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number", "minimum": 0 }, "askSize": { "type": "number", "minimum": 0 }, "mid": { "type": "number" }, "last": { "type": "number" }, "mark": { "type": "number" }, "volume": { "type": "number", "minimum": 0 }, "openInterest": { "type": "number", "minimum": 0 }, "underlyingPrice": { "type": "number", "exclusiveMinimum": 0 }, "impliedVolatility": { "type": "number", "minimum": 0 }, "greeks": { "type": "object", "properties": { "delta": { "type": "number" }, "gamma": { "type": "number" }, "theta": { "type": "number" }, "vega": { "type": "number" }, "rho": { "type": "number" }, "provenance": { "type": "object", "properties": { "source": { "type": "string" }, "model": { "type": "string" }, "timestampMs": { "type": "number" } }, "additionalProperties": false, "required": [ "source" ] } }, "additionalProperties": false, "required": [ "delta" ], "description": "Per-share Greeks in display units (theta per day, vega per vol point, rho per 1%), with optional provenance" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "contract", "timestampMs" ] } } }, "additionalProperties": false, "required": [ "asOf", "underlyingPrice", "quotes" ] } }, "fxRates": { "type": "array", "items": { "type": "object", "properties": { "timestampMs": { "type": "number" }, "baseCurrency": { "type": "string", "minLength": 1 }, "quoteCurrency": { "type": "string", "minLength": 1 }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "timestampMs", "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "forwardRates": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "forwardRate": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "instrumentId", "timestampMs", "forwardRate" ] } }, "fundingRates": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "fundingRate": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "timestampMs", "fundingRate" ] } }, "corporateActions": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "effectiveDate": { "type": "string", "format": "date" }, "type": { "type": "string", "enum": [ "split", "reverseSplit", "dividend", "symbolChange", "merger", "spinoff", "other" ] }, "ratio": { "type": "number", "exclusiveMinimum": 0 }, "cash": { "type": "number" }, "newSymbol": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "symbol", "effectiveDate", "type" ] } }, "dividends": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "exDate": { "type": "string", "format": "date" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "payDate": { "type": "string", "format": "date" } }, "additionalProperties": false, "required": [ "instrumentId", "exDate", "amount" ] } }, "coupons": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "paymentDate": { "type": "string", "format": "date" }, "amountPerUnit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "instrumentId", "paymentDate", "amountPerUnit" ] } } }, "additionalProperties": false }, "strategy": { "type": "object", "properties": { "model": { "anyOf": [ { "type": "object", "additionalProperties": {}, "description": "A ModelPortfolio artifact" }, { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "sleeveId": { "type": "string" }, "assetClass": { "type": "string" }, "currency": { "type": "string" }, "tag": { "type": "string" }, "underlying": { "type": "string" }, "strategy": { "type": "string" } }, "additionalProperties": false, "description": "Exactly one group key" }, "weight": { "type": "number" }, "riskBudget": { "type": "number" }, "driftBand": { "type": "number" } }, "additionalProperties": false, "required": [ "group" ] }, "minItems": 1 } ] }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly", "quarterly" ] } }, "additionalProperties": false, "required": [ "frequency" ] }, "policy": { "type": "object", "additionalProperties": {}, "description": "An InvestmentPolicy (limits, handling); targets come from the model" }, "scope": { "type": "string", "enum": [ "to-target", "drift-only" ] } }, "additionalProperties": false, "required": [ "model", "schedule" ], "description": "The declarative strategy; an onSession callback is SDK-only" }, "execution": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "ambiguity": { "type": "string", "enum": [ "optimistic", "pessimistic", "deterministic-path", "reject" ] }, "costs": { "type": "object", "properties": { "commission": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "perShare", "type": "string" }, "amountPerShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amountPerShare" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "amount": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "amount" ] } ], "description": "A declarative commission model (fees.none / bps / perShare / fixed)" }, "slippage": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "bps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] }, { "type": "object", "properties": { "model": { "const": "fixed", "type": "string" }, "perShare": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "perShare" ] }, { "type": "object", "properties": { "model": { "const": "spread", "type": "string" }, "spread": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "spread" ] } ], "description": "A declarative slippage model (slippage.none / bps / fixed / spread)" }, "spread": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "halfSpreadBps", "type": "string" }, "bps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "bps" ] } ] }, "marketImpact": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "none", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "squareRoot", "type": "string" }, "coefficient": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "model", "coefficient" ] } ] }, "latencySessions": { "type": "integer", "minimum": 0 }, "participation": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false }, "partialFills": { "type": "string", "enum": [ "allow", "reject" ] }, "timeInForce": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "day", "gtc" ] }, "expireAtSessionClose": { "type": "boolean" } }, "additionalProperties": false, "required": [ "default", "expireAtSessionClose" ] }, "margin": { "type": "object", "properties": { "buyingPowerMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "initialMarginRate": { "type": "number", "minimum": 0 }, "maintenanceMarginRate": { "type": "number", "minimum": 0 }, "forcedLiquidation": { "type": "string", "enum": [ "none", "close-largest-loss", "pro-rata" ] } }, "additionalProperties": false, "required": [ "buyingPowerMultiplier", "initialMarginRate", "maintenanceMarginRate", "forcedLiquidation" ] } }, "additionalProperties": false, "required": [ "label" ], "description": "A declared execution policy over session bars (execution.declared): the label is the caller's claim; a caller fill model, session rules, and quote/order-book observations are SDK-only" }, "externalFlows": { "type": "array", "items": { "type": "object", "properties": { "timestampMs": { "type": "number" }, "amount": { "type": "number" }, "currency": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "timestampMs", "amount", "currency" ] } }, "calendar": { "type": "string", "enum": [ "NYSE", "CBOE", "ALWAYS_OPEN" ] }, "window": { "type": "object", "properties": { "fromTimestampMs": { "type": "number" }, "toTimestampMs": { "type": "number" } }, "additionalProperties": false }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0, "description": "Default 252" }, "seed": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "accounting", "instruments", "marketData", "strategy" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "ledger": { "type": "object" }, "timeline": { "type": [ "object", "null" ] }, "pnl": { "type": [ "object", "null" ] }, "orders": { "type": "array", "items": { "type": "object" } }, "fills": { "type": "array", "items": { "type": "object" } }, "rejections": { "type": "array", "items": { "type": "object" } }, "liquidations": { "type": "array", "items": { "type": "object" } }, "events": { "type": "array", "items": { "type": "object" } }, "valuationMarks": { "type": "array", "items": { "type": "object" } }, "points": { "type": "array", "items": { "type": "object" } }, "returns": { "type": "array", "items": { "type": "number" } }, "performance": { "type": "object", "description": "The standard performance summary" }, "finalValue": { "type": "number" }, "runId": { "type": "string" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "ledger", "timeline", "pnl", "orders", "fills", "rejections", "liquidations", "events", "valuationMarks", "points", "returns", "performance", "finalValue", "runId", "assumptions", "diagnostics" ] } ``` ### totalfinance.backtest.vectorized_run Run a vectorized backtest Run a single-asset vectorized backtest: signal-following fills at close, optional bps fees. Returns final value, turnover, and the performance summary; every hidden policy the run assumed (fill timing, costs, slippage, settlement, calendar, margin) is echoed in `assumptions`, and the implementation-risk warnings (look-ahead, data alignment) ride `diagnostics`. Deliberately opt-in (backtestPack) — payloads and runtime are heavier than the default tools. executionLag shifts signal lookup before rebalance sampling; a month-end target can miss the next monthly sample. Use the SDK researchProtocol and selection-hygiene workflow before comparing candidates; see docs/guides/dogfood-journeys.md. Version: 1; pack: backtest; profiles: `backtesting`, `full`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Ticker (default SYMBOL)" }, "timestampMs": { "type": "number", "description": "Bar timestamp (epoch ms)" }, "open": { "type": "number", "exclusiveMinimum": 0 }, "high": { "type": "number", "exclusiveMinimum": 0 }, "low": { "type": "number", "exclusiveMinimum": 0 }, "close": { "type": "number", "exclusiveMinimum": 0 }, "volume": { "type": "number" } }, "additionalProperties": false, "required": [ "timestampMs", "open", "high", "low", "close" ] }, "description": "OHLC bars, chronological" }, "signal": { "type": "array", "items": { "type": "number" }, "description": "Target position per bar (1 long, 0 flat, -1 short; fractional = sized), aligned to data" }, "initialCapital": { "type": "number", "exclusiveMinimum": 0, "description": "Opening capital (default 1)" }, "feeBps": { "type": "number", "minimum": 0, "description": "Per-trade fee in basis points of traded notional" }, "slippageBps": { "type": "number", "minimum": 0, "description": "Existing slippage.bps model; basis points, zero means no slippage" }, "executionLag": { "type": "integer", "minimum": 0, "description": "Signal-to-fill lag in bars (SDK default 1); 0 carries a look-ahead warning" }, "rebalance": { "anyOf": [ { "type": "string", "enum": [ "everyBar", "daily", "weekly", "monthly" ] }, { "type": "integer", "exclusiveMinimum": 0 } ], "description": "Existing SDK sampling schedule; samples signal[i - executionLag] only on rebalance bars" }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0, "description": "Bars per year for metrics (SDK default 252)" }, "riskFreeRate": { "type": "number", "description": "Annual risk-free rate as a decimal (SDK default 0)" }, "maxLeverage": { "type": "number", "exclusiveMinimum": 0, "description": "Existing per-asset gross weight cap (SDK default 1)" } }, "additionalProperties": false, "required": [ "data", "signal" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "finalValue": { "type": "number" }, "turnover": { "type": "number", "description": "Traded notional ÷ average equity over the run" }, "performance": { "type": "object", "description": "The standard performance summary" }, "assumptions": { "type": "object", "description": "The modelling policies the run assumed: initialCapital, fill, cost, slippage, cashSettlement, corporateAction, calendar, margin, conventionsVersion" }, "diagnostics": { "type": "object", "description": "Implementation-risk warnings (look-ahead / data alignment) + benchmarkFixtureVersion" } }, "required": [ "finalValue", "turnover", "performance", "assumptions", "diagnostics" ] } ``` ### totalfinance.calendar.sessions Trading sessions & option expirations Trading days, holidays, and half days for an exchange calendar over a date range (≤ ~13 months), plus option expirations (weekly Fridays / monthly OPEX / quarterly, shifted off holidays from the calendar data) when `expirationKind` is set, and the next expiry after the range start. NYSE/CBOE one-off closure coverage begins 2001-01-01; earlier ranges carry a diagnostic. Rules project other dates, not future emergency closures. Version: 1; pack: calendar; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "calendar": { "type": "string", "enum": [ "NYSE", "CBOE", "crypto24x7" ], "description": "Exchange calendar" }, "from": { "type": "string", "description": "Range start (ISO YYYY-MM-DD, inclusive)" }, "to": { "type": "string", "description": "Range end (ISO YYYY-MM-DD, inclusive)" }, "expirationKind": { "type": "string", "enum": [ "weekly", "monthly", "quarterly" ], "description": "Also return option expirations of this kind (holiday-shifted)" } }, "additionalProperties": false, "required": [ "calendar", "from", "to" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "tradingDays": { "type": "array", "items": { "type": "string" } }, "holidays": { "type": "array", "items": { "type": "string" } }, "halfDays": { "type": "array", "items": { "type": "string" } }, "expirations": { "type": "array", "items": { "type": "string" } }, "nextExpiry": { "type": "string" }, "calendar": { "type": "object", "description": "name/version/timezone and documented closure-data coverage" }, "diagnostics": { "type": "object", "description": "Warnings when the range crosses the historical coverage floor" } }, "required": [ "tradingDays", "holidays", "halfDays", "calendar" ] } ``` ### totalfinance.crypto.futures_basis Futures basis / cash-and-carry Annualized basis of a dated future over spot — the cash-and-carry yield. Reports raw and percentage basis, simple and continuously-compounded annualization, contango/backwardation, and flags an arbitrage-sized basis. Version: 1; pack: crypto; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "spot": { "type": "number", "exclusiveMinimum": 0, "description": "Spot price (quote currency)" }, "future": { "type": "number", "exclusiveMinimum": 0, "description": "Dated-futures price (quote currency)" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to futures expiry in YEARS" }, "financingRate": { "type": "number", "description": "Quote financing rate (annualized decimal) — supply to get fairFuture/richness/carryArbitrage and the cash-and-carry arbitrage flag" }, "coinYield": { "type": "number", "description": "Base-coin yield (annualized decimal, e.g. staking; default 0)" }, "arbitrageThreshold": { "type": "number", "description": "|carryArbitrage| above which cash-and-carry is flagged (decimal, default 0.05)" } }, "additionalProperties": false, "required": [ "spot", "future", "timeToExpiryYears" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.crypto.perpetual_funding Perpetual funding → implied carry Annualize a perpetual funding rate into the implied cost-of-carry: the mark/index premium, simple and compounded annualized funding, and an extreme-funding flag. All rates are decimals; the interval defaults to the standard 8 hours. Version: 1; pack: crypto; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "markPrice": { "type": "number", "exclusiveMinimum": 0, "description": "Perpetual mark price (quote currency)" }, "indexPrice": { "type": "number", "exclusiveMinimum": 0, "description": "Index / spot price (quote currency)" }, "fundingRate": { "type": "number", "description": "Realized funding for ONE interval (decimal; 0.0001 = 0.01%). Longs pay when positive" }, "intervalHours": { "type": "number", "exclusiveMinimum": 0, "description": "Funding interval in hours (default 8)" } }, "additionalProperties": false, "required": [ "markPrice", "indexPrice", "fundingRate" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.fixed_income.bond_analytics Bond price/yield analytics Full fixed-rate bond analytics from a specification: given a `yield`, price it; given a `price`, solve the yield to maturity — then report clean/dirty price, accrued interest, Macaulay/modified duration, convexity, and DV01. Dates are YYYY-MM-DD; rates are decimals. Version: 1; pack: fixed_income; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "issueDate": { "type": "string", "description": "Dated date / first accrual date, YYYY-MM-DD" }, "maturityDate": { "type": "string", "description": "Maturity date, YYYY-MM-DD" }, "couponRate": { "type": "number", "description": "Annualized coupon rate (decimal; 0.05 = 5%)" }, "frequency": { "type": "string", "enum": [ "annual", "semiannual", "quarterly", "monthly" ], "description": "Coupon frequency" }, "faceValue": { "type": "number", "exclusiveMinimum": 0, "description": "Redemption / par value (default 100)" }, "dayCount": { "type": "string", "enum": [ "30/360", "ACT/360", "ACT/365F", "ACT/ACT", "30E/360" ], "description": "Accrual day count (default 30/360)" }, "settlementDate": { "type": "string", "description": "Settlement date, YYYY-MM-DD" }, "yield": { "type": "number", "description": "Annualized yield (decimal) — provide this OR `price`" }, "price": { "type": "number", "exclusiveMinimum": 0, "description": "Bond price — provide this OR `yield`" }, "priceType": { "type": "string", "enum": [ "clean", "dirty" ], "description": "How to read `price` (default clean)" } }, "additionalProperties": false, "required": [ "issueDate", "maturityDate", "couponRate", "frequency", "settlementDate" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.option.greeks Compute first-order Greeks Compute first-order Greeks (delta, gamma, theta/day, vega/1%, rho/1%) for a European option under Black–Scholes–Merton. Supply time as timeToExpiryYears (years) or as expiry + asOf (dates). Version: 1; pack: options; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "spot": { "type": "number", "exclusiveMinimum": 0, "description": "Spot price of the underlying" }, "strike": { "type": "number", "exclusiveMinimum": 0, "description": "Strike price" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "volatility": { "type": "number", "exclusiveMinimum": 0, "description": "Volatility (decimal)" }, "dividendYield": { "type": "number", "description": "Continuous dividend yield (decimal, default 0)" }, "expiry": { "type": "string", "description": "Option expiry — YYYY-MM-DD (→ the US close: 16:00 ET, 13:00 ET on early-close days) or a zoned ISO datetime. Supply with asOf instead of timeToExpiryYears." }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Valuation instant — epoch ms or a zoned ISO datetime such as \"2026-07-20T10:30:00-04:00\". A bare YYYY-MM-DD is refused: a same-day option's value depends on the time of day. For an end-of-day mark use the 16:00 ET close (13:00 ET on early-close days)." }, "type": { "type": "string", "enum": [ "call", "put" ], "description": "Option type" } }, "additionalProperties": false, "required": [ "spot", "strike", "riskFreeRate", "volatility", "type" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "greeks": { "type": "object", "properties": { "delta": { "type": "number" }, "gamma": { "type": "number" }, "theta": { "type": "number" }, "vega": { "type": "number" }, "rho": { "type": "number" } } }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "greeks" ] } ``` ### totalfinance.option.implied_volatility Solve implied volatility Solve Black–Scholes–Merton implied volatility from an observed option price using the method suite (auto/brent/newton/halley/householder, with an optional Brent fallback). Supply time as timeToExpiryYears (years) or as expiry + asOf (dates). Non-convergence and no-arbitrage failures are reported in diagnostics (converged: false), never fabricated; the method actually used is echoed in diagnostics.method. Version: 1; pack: options; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "price": { "type": "number", "exclusiveMinimum": 0, "description": "Observed option price to invert" }, "spot": { "type": "number", "exclusiveMinimum": 0, "description": "Spot price of the underlying" }, "strike": { "type": "number", "exclusiveMinimum": 0, "description": "Strike price" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "type": { "type": "string", "enum": [ "call", "put" ], "description": "Option type" }, "dividendYield": { "type": "number", "description": "Continuous dividend yield (decimal, default 0)" }, "expiry": { "type": "string", "description": "Option expiry — YYYY-MM-DD (→ the US close: 16:00 ET, 13:00 ET on early-close days) or a zoned ISO datetime. Supply with asOf instead of timeToExpiryYears." }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Valuation instant — epoch ms or a zoned ISO datetime such as \"2026-07-20T10:30:00-04:00\". A bare YYYY-MM-DD is refused: a same-day option's value depends on the time of day. For an end-of-day mark use the 16:00 ET close (13:00 ET on early-close days)." }, "method": { "type": "string", "enum": [ "auto", "brent", "newton", "halley", "householder" ], "description": "Solver method (default auto = Householder with a Brent fallback)" }, "fallback": { "type": "boolean", "description": "Fall back to Brent when the chosen method fails (default true)" } }, "additionalProperties": false, "required": [ "price", "spot", "strike", "riskFreeRate", "type" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "type": [ "number", "null" ] }, "converged": { "type": "boolean" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "value", "converged" ] } ``` ### totalfinance.option.price Price an option (Black–Scholes–Merton) Price a European option with the Black–Scholes–Merton model. Supply time as timeToExpiryYears (years) or as expiry + asOf (dates). Returns the price plus the assumptions (day count, compounding, units, resolved timeToExpiryYears) and diagnostics that produced it. Version: 1; pack: options; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "spot": { "type": "number", "exclusiveMinimum": 0, "description": "Spot price of the underlying" }, "strike": { "type": "number", "exclusiveMinimum": 0, "description": "Strike price" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "volatility": { "type": "number", "exclusiveMinimum": 0, "description": "Volatility (decimal)" }, "dividendYield": { "type": "number", "description": "Continuous dividend yield (decimal, default 0)" }, "expiry": { "type": "string", "description": "Option expiry — YYYY-MM-DD (→ the US close: 16:00 ET, 13:00 ET on early-close days) or a zoned ISO datetime. Supply with asOf instead of timeToExpiryYears." }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Valuation instant — epoch ms or a zoned ISO datetime such as \"2026-07-20T10:30:00-04:00\". A bare YYYY-MM-DD is refused: a same-day option's value depends on the time of day. For an end-of-day mark use the 16:00 ET close (13:00 ET on early-close days)." }, "type": { "type": "string", "enum": [ "call", "put" ], "description": "Option type" } }, "additionalProperties": false, "required": [ "spot", "strike", "riskFreeRate", "volatility", "type" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "type": "number" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "value" ] } ``` ### totalfinance.performance.analyze Full performance summary Summarize a return series or equity curve: total/annualized return, volatility, Sharpe, Sortino, Calmar, max drawdown, omega, hit rate, profit factor, expectancy — plus beta/alpha/tracking error/information ratio/Treynor when a `benchmark` is supplied. Suspicious inputs (prices passed as returns, returns passed as equity) are flagged in diagnostics.warnings, never silently reported. Version: 1; pack: performance; profiles: `backtesting`, `default`, `full`, `portfolio`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "returns": { "type": "array", "items": { "type": "number" }, "description": "Per-period returns as decimals (0.01 = +1%) — supply returns OR equity" }, "equity": { "type": "array", "items": { "type": "number", "exclusiveMinimum": 0 }, "description": "Equity curve (growth of capital, price levels) — supply returns OR equity" }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0, "description": "Annualization factor (default 252 daily; 12 monthly, 52 weekly)" }, "riskFreeRate": { "type": "number", "description": "Annualized risk-free rate (decimal, default 0)" }, "benchmark": { "type": "array", "items": { "type": "number" }, "description": "Aligned per-period benchmark returns (decimals); adds beta/alpha/informationRatio/Treynor" } }, "additionalProperties": false } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.portfolio.analyze Analyze a portfolio (snapshot, timeline, monitor) One report of up to three direct results: the valuation snapshot at `asOf` (always), the dated timeline with P&L since each prior mark and drawdown (when `marks` are supplied), and the policy monitor with its alerts and carried state (when `monitor` is supplied). Each result is the direct function verbatim; nothing is aggregated across them, and one `assumptions` says which parts ran and why the others did not. Version: 1; pack: portfolio; profiles: `full`, `portfolio`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `ledger`, `market`. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "ledger": { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Portfolio event envelopes (each re-validated by readPortfolioLedgerSnapshot)" }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ], "description": "A serialized portfolio ledger (totalfinance.portfolio-ledger, the FC7 JSON form)" }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The valuation and monitoring instant" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "instrumentClassification": { "type": "object", "additionalProperties": { "type": "object", "properties": { "underlying": { "type": "string" }, "assetClass": { "type": "string" }, "strategy": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "description": "Identity metadata per instrument for grouping; unknown instruments group as unclassified" }, "marks": { "type": "array", "items": { "type": "object", "properties": { "valuationDate": { "type": "string", "format": "date", "description": "Strict YYYY-MM-DD; the mark instant is 00:00 UTC" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } } }, "additionalProperties": false, "required": [ "valuationDate", "market" ] }, "minItems": 2, "description": "At least two dated marks, strictly ascending — adds portfolioTimeline when supplied" }, "monitor": { "type": "object", "properties": { "policy": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "sleeveId": { "type": "string" }, "assetClass": { "type": "string" }, "currency": { "type": "string" }, "tag": { "type": "string" }, "underlying": { "type": "string" }, "strategy": { "type": "string" } }, "additionalProperties": false, "description": "Exactly one group key" }, "weight": { "type": "number" }, "riskBudget": { "type": "number" }, "driftBand": { "type": "number" } }, "additionalProperties": false, "required": [ "group" ] } }, "model": { "type": "object", "additionalProperties": {}, "description": "A model portfolio envelope (totalfinance.model-portfolio), validated by the policy grammar" }, "withinGroupAllocation": { "type": "string", "enum": [ "proportional-to-current", "equal" ] }, "driftBand": { "type": "number" }, "reviewCadenceDays": { "type": "number" }, "maximumTurnover": { "type": "number" }, "maximumEstimatedTransactionCost": { "type": "number" }, "minimumCash": { "type": "number" }, "minimumCashWeight": { "type": "number" }, "limits": { "type": "object", "properties": { "maximumPositionWeight": { "type": "number" }, "maximumGroupWeights": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "sleeveId": { "type": "string" }, "assetClass": { "type": "string" }, "currency": { "type": "string" }, "tag": { "type": "string" }, "underlying": { "type": "string" }, "strategy": { "type": "string" } }, "additionalProperties": false, "description": "Exactly one group key" }, "maximumWeight": { "type": "number" } }, "additionalProperties": false, "required": [ "group", "maximumWeight" ] } }, "maximumGrossLeverage": { "type": "number" }, "maximumDrawdown": { "type": "number" }, "maximumDailyLoss": { "type": "number" }, "maximumDaysToLiquidate": { "type": "number" }, "minimumSettledCash": { "type": "number" } }, "additionalProperties": false }, "allowedInstruments": { "type": "array", "items": { "type": "string" } }, "restrictedInstruments": { "type": "array", "items": { "type": "string" } }, "allowedAccounts": { "type": "array", "items": { "type": "string" } }, "benchmark": { "type": "object", "properties": { "benchmarkId": { "type": "string", "minLength": 1 }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Epoch ms, YYYY-MM-DD, or a zoned ISO datetime" }, "constituents": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "weight": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "weight" ] } } }, "additionalProperties": false, "required": [ "benchmarkId" ] }, "performanceObjective": { "type": "string" }, "contributionHandling": { "type": "string", "enum": [ "invest-to-targets", "hold-as-cash" ] }, "withdrawalHandling": { "type": "string", "enum": [ "raise-from-overweights", "pro-rata" ] }, "incomeReinvestment": { "type": "string", "enum": [ "reinvest", "hold-as-cash" ] }, "lotSelectionObjective": { "type": "string" } }, "additionalProperties": false }, "previousState": { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "type": "integer" }, "asOf": { "type": "number" }, "netAssetValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "peakNetAssetValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "evaluationCount": { "type": "integer", "minimum": 0 }, "rules": { "type": "object", "additionalProperties": { "type": "object", "properties": { "active": { "type": "boolean" }, "consecutiveBreaches": { "type": "integer", "minimum": 0 }, "lastRaisedAtMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "acknowledged": { "type": "boolean" }, "lastValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "active", "consecutiveBreaches", "lastRaisedAtMs", "acknowledged", "lastValue" ] } } }, "additionalProperties": false, "required": [ "schemaVersion", "asOf", "netAssetValue", "peakNetAssetValue", "evaluationCount", "rules" ] }, { "type": "null" } ], "description": "The prior evaluation's state, or null for the first evaluation — required, exactly as monitorPortfolio requires it" }, "rules": { "type": "object", "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "threshold": { "type": "number" }, "direction": { "type": "string", "enum": [ "above", "below" ] }, "hysteresis": { "type": "object", "properties": { "enter": { "type": "number" }, "exit": { "type": "number" } }, "additionalProperties": false, "required": [ "enter", "exit" ] }, "debounceEvaluations": { "type": "integer", "exclusiveMinimum": 0, "description": "Default 1" }, "cooldownMs": { "type": "number", "minimum": 0, "description": "Default 0" }, "severity": { "type": "string", "enum": [ "informational", "warning", "critical" ] } }, "additionalProperties": false }, "description": "Per alert family" }, "acknowledgments": { "type": "array", "items": { "type": "string" } }, "averageDailyVolumes": { "type": "object", "additionalProperties": { "type": "number" } }, "marketStalenessLimitMs": { "type": "number" }, "unusualPnlThreshold": { "type": "number" }, "residualTolerance": { "type": "number" }, "optionExpirationWarningDays": { "type": "number" }, "assignmentRiskMoneyness": { "type": "number" } }, "additionalProperties": false, "required": [ "policy", "previousState" ], "description": "monitorPortfolio inputs beyond the shared portfolio / market / asOf / currencyConversions" } }, "additionalProperties": false, "required": [ "ledger", "asOf", "market" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "snapshot": { "type": "object", "description": "portfolioSnapshot(...) verbatim" }, "timeline": { "type": [ "object", "null" ], "description": "portfolioTimeline(...) verbatim, or null when no marks were supplied" }, "monitor": { "type": [ "object", "null" ], "description": "monitorPortfolio(...) verbatim, or null when no monitor request was supplied" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "snapshot", "timeline", "monitor", "assumptions", "diagnostics" ] } ``` ### totalfinance.portfolio.create Create and store an explicitly defined portfolio ledger Start here before portfolio.record_events: supply durable portfolioId, baseCurrency and explicit initial events (an empty array creates no cash). Uses the existing artifact store and ledger reducer. Requires portfolio:write and a writable store. Save the returned handle and open it with portfolio.inspect from portfolioPack (enable both trade and portfolio packs, or use --profile full); subsequent event writes return a new immutable handle. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `portfolio:write`. Authorization: none. Side effect: portfolio-state. Idempotency: required. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":false,"destructiveHint":false,"idempotentHint":true,"openWorldHint":true} Input JSON Schema: ```json { "type": "object", "properties": { "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ], "description": "Existing ledger default: fifo, echoed in the stored ledger" }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "maxItems": 100000, "description": "Explicit initial events; [] means an empty, unfunded portfolio" }, "provenance": { "$ref": "#/$defs/Provenance" }, "createdTimestampMs": { "type": "integer", "description": "Caller clock in epoch milliseconds" } }, "additionalProperties": false, "required": [ "portfolioId", "baseCurrency", "events", "createdTimestampMs" ], "$id": "https://totalfinance.dev/schemas/portfolio.create.input", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "$ref": "#/$defs/Provenance" }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "handle": { "type": "object", "properties": { "uri": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "report", "job", "portfolio", "scenario", "market", "authorization", "journal" ] }, "schema": { "type": "string", "minLength": 1 }, "version": { "type": "string" }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "expiresTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "uri", "kind", "schema", "version", "contentHash", "createdTimestampMs", "expiresTimestampMs", "provenance" ] }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "eventCount": { "type": "integer", "minimum": 0 }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "inspectOperation": { "const": "totalfinance.portfolio.inspect", "type": "string" } }, "additionalProperties": false, "required": [ "handle", "portfolioId", "baseCurrency", "eventCount", "lotRelief", "inspectOperation" ], "$id": "https://totalfinance.dev/schemas/portfolio.create.output" } ``` ### totalfinance.portfolio.explain_pnl Explain portfolio P&L between two marks Explain the change in net asset value between two dated valuation marks: external flows, investment return, and the identity components (realized, unrealized, income, transaction costs, financing, foreign exchange) that reconcile to it with a published residual, by currency and by grouping. The result is portfolioPnl(...) verbatim. Version: 1; pack: portfolio; profiles: `full`, `portfolio`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `ledger`, `from.market`, `to.market`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "ledger": { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Portfolio event envelopes (each re-validated by readPortfolioLedgerSnapshot)" }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ], "description": "A serialized portfolio ledger (totalfinance.portfolio-ledger, the FC7 JSON form)" }, "from": { "type": "object", "properties": { "valuationDate": { "type": "string", "format": "date", "description": "Strict YYYY-MM-DD; the mark instant is 00:00 UTC" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } } }, "additionalProperties": false, "required": [ "valuationDate", "market" ], "description": "The opening valuation mark" }, "to": { "type": "object", "properties": { "valuationDate": { "type": "string", "format": "date", "description": "Strict YYYY-MM-DD; the mark instant is 00:00 UTC" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } } }, "additionalProperties": false, "required": [ "valuationDate", "market" ], "description": "The closing valuation mark (strictly after `from`)" }, "instrumentClassification": { "type": "object", "additionalProperties": { "type": "object", "properties": { "underlying": { "type": "string" }, "assetClass": { "type": "string" }, "strategy": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "description": "Identity metadata per instrument for grouping; unknown instruments group as unclassified" } }, "additionalProperties": false, "required": [ "ledger", "from", "to" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "baseCurrency": { "type": "string" }, "from": { "type": "object" }, "to": { "type": "object" }, "netAssetValueChange": { "type": "number" }, "externalFlows": { "type": "number" }, "investmentReturn": { "type": "number" }, "components": { "type": "object", "description": "realized, unrealized, income, costs, financing, FX, total" }, "residual": { "type": "number" }, "byCurrency": { "type": "array", "items": { "type": "object" } }, "groupings": { "type": "array", "items": { "type": "object" } }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "baseCurrency", "from", "to", "netAssetValueChange", "externalFlows", "investmentReturn", "components", "residual", "byCurrency", "groupings", "assumptions", "diagnostics" ] } ``` ### totalfinance.portfolio.inspect Open a portfolio ledger or handle and inspect a bounded page Open a returned totalfinance://portfolios/... handle through the same configured store, or import an inline serialized ledger for read-only inspection. Revalidates and replays the ledger. Summary returns identity/counts; events, positions and cash return bounded previews (default 20, maximum 100 rows). This does not value the portfolio; use portfolio.snapshot with explicit marks. Opt-in (portfolioPack). Version: 1; pack: portfolio; profiles: `full`, `portfolio`; defaultEnabled: false; SDKonly: false. Required capabilities: `portfolio:read`. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `portfolio`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "portfolio": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "provenance": { "$ref": "#/$defs/Provenance" } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ] }, { "type": "string", "pattern": "^totalfinance:\\/\\/portfolios\\/" }, { "type": "object", "properties": { "uri": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "report", "job", "portfolio", "scenario", "market", "authorization", "journal" ] }, "schema": { "type": "string", "minLength": 1 }, "version": { "type": "string" }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "expiresTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "provenance": { "$ref": "#/$defs/Provenance" } }, "additionalProperties": false, "required": [ "uri", "kind", "schema", "version", "contentHash", "createdTimestampMs", "expiresTimestampMs", "provenance" ] } ] }, "section": { "type": "string", "enum": [ "summary", "events", "positions", "cash" ] }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "additionalProperties": false, "required": [ "portfolio" ], "$id": "https://totalfinance.dev/schemas/portfolio.inspect.input", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "$ref": "#/$defs/Provenance" }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "portfolioId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "eventCount": { "type": "integer", "minimum": 0 }, "accountCount": { "type": "integer", "minimum": 0 }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "section": { "type": "string", "enum": [ "summary", "events", "positions", "cash" ] }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "exclusiveMinimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "nextOffset": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false, "required": [ "portfolioId", "baseCurrency", "lotRelief", "eventCount", "accountCount", "lastEffectiveTimestampMs", "section", "offset", "limit", "total", "nextOffset", "rows" ] } ``` ### totalfinance.portfolio.rebalance_proposal Propose a rebalance (a proposal, never an order) Fold the ledger snapshot to its state, mark it from the market snapshot, and propose the trades that take the portfolio to the policy targets (or only the drifted ones) under the policy limits, lot sizes, minimum notional, transaction-cost estimates, and an optional external flow. The result is proposePortfolioRebalance(...) verbatim: weights before and after, the cash summary, the trades with their estimates, the objective, and every target it could not resolve. Read-only by construction — it returns a proposal and places nothing. Opt-in (portfolioPack). Version: 1; pack: portfolio; profiles: `full`, `portfolio`; defaultEnabled: false; SDKonly: false. Required capabilities: `trade:propose`. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `ledger`, `market`. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "ledger": { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Portfolio event envelopes (each re-validated by readPortfolioLedgerSnapshot)" }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ], "description": "A serialized portfolio ledger (totalfinance.portfolio-ledger, the FC7 JSON form)" }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The valuation instant the proposal is sized at" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "policy": { "type": "object", "properties": { "targets": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "sleeveId": { "type": "string" }, "assetClass": { "type": "string" }, "currency": { "type": "string" }, "tag": { "type": "string" }, "underlying": { "type": "string" }, "strategy": { "type": "string" } }, "additionalProperties": false, "description": "Exactly one group key" }, "weight": { "type": "number" }, "riskBudget": { "type": "number" }, "driftBand": { "type": "number" } }, "additionalProperties": false, "required": [ "group" ] } }, "model": { "type": "object", "additionalProperties": {}, "description": "A model portfolio envelope (totalfinance.model-portfolio), validated by the policy grammar" }, "withinGroupAllocation": { "type": "string", "enum": [ "proportional-to-current", "equal" ] }, "driftBand": { "type": "number" }, "reviewCadenceDays": { "type": "number" }, "maximumTurnover": { "type": "number" }, "maximumEstimatedTransactionCost": { "type": "number" }, "minimumCash": { "type": "number" }, "minimumCashWeight": { "type": "number" }, "limits": { "type": "object", "properties": { "maximumPositionWeight": { "type": "number" }, "maximumGroupWeights": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "sleeveId": { "type": "string" }, "assetClass": { "type": "string" }, "currency": { "type": "string" }, "tag": { "type": "string" }, "underlying": { "type": "string" }, "strategy": { "type": "string" } }, "additionalProperties": false, "description": "Exactly one group key" }, "maximumWeight": { "type": "number" } }, "additionalProperties": false, "required": [ "group", "maximumWeight" ] } }, "maximumGrossLeverage": { "type": "number" }, "maximumDrawdown": { "type": "number" }, "maximumDailyLoss": { "type": "number" }, "maximumDaysToLiquidate": { "type": "number" }, "minimumSettledCash": { "type": "number" } }, "additionalProperties": false }, "allowedInstruments": { "type": "array", "items": { "type": "string" } }, "restrictedInstruments": { "type": "array", "items": { "type": "string" } }, "allowedAccounts": { "type": "array", "items": { "type": "string" } }, "benchmark": { "type": "object", "properties": { "benchmarkId": { "type": "string", "minLength": 1 }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Epoch ms, YYYY-MM-DD, or a zoned ISO datetime" }, "constituents": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string" }, "weight": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "weight" ] } } }, "additionalProperties": false, "required": [ "benchmarkId" ] }, "performanceObjective": { "type": "string" }, "contributionHandling": { "type": "string", "enum": [ "invest-to-targets", "hold-as-cash" ] }, "withdrawalHandling": { "type": "string", "enum": [ "raise-from-overweights", "pro-rata" ] }, "incomeReinvestment": { "type": "string", "enum": [ "reinvest", "hold-as-cash" ] }, "lotSelectionObjective": { "type": "string" } }, "additionalProperties": false, "description": "Targets come from the policy (inline targets or a model)" }, "instrumentClassification": { "type": "object", "additionalProperties": { "type": "object", "properties": { "underlying": { "type": "string" }, "assetClass": { "type": "string" }, "strategy": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "description": "Identity metadata per instrument for grouping; unknown instruments group as unclassified" }, "scope": { "type": "string", "enum": [ "to-target", "drift-only" ], "description": "'to-target' trades every target to weight; 'drift-only' trades only targets outside their band" }, "externalFlow": { "type": "object", "properties": { "amount": { "type": "number" }, "currency": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "amount", "currency" ], "description": "A contribution (positive) or withdrawal (negative) the proposal sizes around" }, "tradingAccountId": { "type": "string" }, "averageDailyVolumes": { "type": "object", "additionalProperties": { "type": "number" } }, "lotSizes": { "type": "object", "additionalProperties": { "type": "number" } }, "defaultLotSize": { "type": "number", "exclusiveMinimum": 0 }, "minimumNotional": { "type": "number", "minimum": 0 }, "transactionCosts": { "type": "object", "properties": { "commissionPerTrade": { "type": "number", "minimum": 0 }, "commissionPerUnit": { "type": "number", "minimum": 0 }, "spreadBasisPoints": { "type": "number", "minimum": 0 }, "slippageBasisPoints": { "type": "number", "minimum": 0 } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "ledger", "asOf", "market", "policy", "scope" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "asOf": { "type": "number" }, "baseCurrency": { "type": "string" }, "netAssetValue": { "type": "number" }, "netAssetValueAfterFlow": { "type": "number" }, "weights": { "type": "object" }, "cash": { "type": "object" }, "trades": { "type": "array", "items": { "type": "object" } }, "estimates": { "type": "object" }, "objective": { "type": "object" }, "unresolvedTargets": { "type": "array", "items": { "type": "object" } }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "asOf", "baseCurrency", "netAssetValue", "netAssetValueAfterFlow", "weights", "cash", "trades", "estimates", "objective", "unresolvedTargets", "assumptions", "diagnostics" ] } ``` ### totalfinance.portfolio.record_events Apply events to a ledger and store the new ledger Fold validated portfolio events (fills from trade.submit, deposits, corporate actions) onto a ledger through the ledger's own reducer and put the new ledger into the artifact store as a content-addressed portfolio handle. The write is the put: an unchanged ledger is the same handle; identical replays fold once and applied counts only new events. Changed event bodies are refused. Requires a writable artifact store and the portfolio:write capability. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `portfolio:write`. Authorization: none. Side effect: portfolio-state. Idempotency: required. Handle fields: `portfolio`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":false,"destructiveHint":false,"idempotentHint":true,"openWorldHint":true} Input JSON Schema: ```json { "type": "object", "properties": { "portfolio": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "provenance": { "$ref": "#/$defs/Provenance" } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ] }, { "type": "object", "properties": { "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "accounts": { "type": "object", "additionalProperties": { "type": "object", "properties": { "cashBalances": { "type": "object", "additionalProperties": { "type": "object", "properties": { "totalAmount": { "type": "number" }, "settlementSchedule": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "amount": { "type": "number" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventId", "amount", "settleTimestampMs" ] } } }, "additionalProperties": false, "required": [ "totalAmount", "settlementSchedule" ] } }, "positions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "quantity": { "type": "number" }, "lots": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "openedByEventId": { "type": "string", "minLength": 1 }, "openedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "quantity": { "type": "number" }, "costBasisPerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "lotId", "openedByEventId", "openedTimestampMs", "quantity", "costBasisPerUnit" ] } } }, "additionalProperties": false, "required": [ "instrumentId", "currency", "contractMultiplier", "settlementStyle", "quantity", "lots" ] } }, "realizedPnl": { "type": "object", "additionalProperties": { "type": "number" } }, "incomeReceived": { "type": "object", "additionalProperties": { "type": "number" } }, "transactionCosts": { "type": "object", "additionalProperties": { "type": "number" } }, "financingCosts": { "type": "object", "additionalProperties": { "type": "number" } }, "realizedPnlByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "incomeByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "transactionCostsByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } } }, "additionalProperties": false, "required": [ "cashBalances", "positions", "realizedPnl", "incomeReceived", "transactionCosts", "financingCosts", "realizedPnlByInstrument", "incomeByInstrument", "transactionCostsByInstrument" ] } }, "appliedEvents": { "type": "object", "additionalProperties": { "type": "string" } }, "eventCount": { "type": "integer", "minimum": 0 }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number", "description": "Epoch milliseconds" }, { "type": "null" } ] }, "lotSequence": { "type": "integer", "minimum": 0 }, "fillEffects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "openedLotIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "relievedQuantity": { "type": "number" }, "realizedPnl": { "type": "number" }, "cashDelta": { "type": "number" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "currency", "openedLotIds", "relievedQuantity", "realizedPnl", "cashDelta", "accruedInterest" ] } }, "reversals": { "type": "object", "additionalProperties": { "type": "string" } }, "accountMigrations": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventId", "fromAccountId", "toAccountId", "effectiveTimestampMs" ] } } }, "additionalProperties": false, "required": [ "schemaVersion", "baseCurrency", "lotRelief", "accounts", "appliedEvents", "eventCount", "lastEffectiveTimestampMs", "lotSequence", "fillEffects", "reversals", "accountMigrations" ] } ] }, { "type": "string", "pattern": "^totalfinance:\\/\\/portfolios\\/" } ] }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "minItems": 1, "description": "Portfolio event envelopes to apply, in order" }, "createdTimestampMs": { "type": "integer", "description": "Epoch ms stamped on the new ledger’s handle — the caller’s clock" } }, "additionalProperties": false, "required": [ "portfolio", "events", "createdTimestampMs" ], "$id": "https://totalfinance.dev/schemas/portfolio.record_events.input", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "$ref": "#/$defs/Provenance" }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "handle": { "type": "object", "properties": { "uri": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "report", "job", "portfolio", "scenario", "market", "authorization", "journal" ] }, "schema": { "type": "string", "minLength": 1 }, "version": { "type": "string" }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "expiresTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "uri", "kind", "schema", "version", "contentHash", "createdTimestampMs", "expiresTimestampMs", "provenance" ] }, "applied": { "type": "integer", "minimum": 0 }, "eventCount": { "type": "integer", "minimum": 0 }, "baseCurrency": { "type": "string" }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "handle", "applied", "eventCount", "baseCurrency", "lastEffectiveTimestampMs" ], "$id": "https://totalfinance.dev/schemas/portfolio.record_events.output" } ``` ### totalfinance.portfolio.snapshot Value a portfolio at an instant Value every cash balance and position of a portfolio at one instant from a Gate B market snapshot: net asset value in the base currency, per-account cash rows (settled and unsettled), per-position marks, cost basis and unrealized P&L. Supply the portfolio as its serialized ledger envelope (re-hydrated through readPortfolioLedgerSnapshot) or as a derived PortfolioState. The result is portfolioSnapshot(...) verbatim. Version: 1; pack: portfolio; profiles: `full`, `portfolio`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `portfolio`, `market`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "portfolio": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Portfolio event envelopes (each re-validated by readPortfolioLedgerSnapshot)" }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ], "description": "A serialized portfolio ledger (totalfinance.portfolio-ledger, the FC7 JSON form)" }, { "type": "object", "properties": { "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "accounts": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "appliedEvents": { "type": "object", "additionalProperties": { "type": "string" } }, "eventCount": { "type": "integer", "minimum": 0 }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lotSequence": { "type": "integer", "minimum": 0 }, "fillEffects": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "reversals": { "type": "object", "additionalProperties": { "type": "string" } }, "accountMigrations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false, "required": [ "schemaVersion", "baseCurrency", "lotRelief", "accounts", "appliedEvents", "eventCount", "lastEffectiveTimestampMs", "lotSequence", "fillEffects", "reversals", "accountMigrations" ], "description": "A derived PortfolioState (from applyPortfolioEvents or ledger.state)" } ], "description": "A serialized ledger envelope (re-hydrated through readPortfolioLedgerSnapshot) or a PortfolioState" }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The valuation instant" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] }, "description": "Quotes to the base currency — required exactly when the portfolio holds non-base currency" } }, "additionalProperties": false, "required": [ "portfolio", "asOf", "market" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "asOf": { "type": "number" }, "baseCurrency": { "type": "string" }, "netAssetValue": { "type": "number" }, "cash": { "type": "array", "items": { "type": "object" } }, "totalCashBaseCurrencyValue": { "type": "number" }, "positions": { "type": "array", "items": { "type": "object" } }, "totalPositionsBaseCurrencyValue": { "type": "number" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "asOf", "baseCurrency", "netAssetValue", "cash", "totalCashBaseCurrencyValue", "positions", "totalPositionsBaseCurrencyValue", "assumptions", "diagnostics" ] } ``` ### totalfinance.research.event_study Run an event study Measure abnormal returns around dated events under a declared expected-return model (mean-adjusted, market-adjusted, or market model), with explicit session, overlap, and cumulation policies; per-event rows and cumulative abnormal returns, and the average abnormal return by offset with t-statistics. The result is eventStudy(...) verbatim. Version: 1; pack: research; profiles: `full`, `research`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} SDK-only limitation: The serializable models; a 'custom' expected-return function is SDK-only Input JSON Schema: ```json { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "eventType": { "type": "string" }, "announcedTimestampMs": { "type": "number" }, "effectiveTimestampMs": { "type": "number" }, "metadata": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "eventId", "instrumentId", "eventType", "announcedTimestampMs" ] } }, "returnObservations": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "tradingSessionDate": { "type": "string", "format": "date" }, "simpleReturn": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "tradingSessionDate", "simpleReturn" ] } }, "marketReturns": { "type": "array", "items": { "type": "object", "properties": { "tradingSessionDate": { "type": "string", "format": "date" }, "simpleReturn": { "type": "number" } }, "additionalProperties": false, "required": [ "tradingSessionDate", "simpleReturn" ] }, "description": "Required by the 'market-adjusted' and 'market' models" }, "eventWindow": { "type": "object", "properties": { "startTradingSessionOffset": { "type": "integer" }, "endTradingSessionOffset": { "type": "integer" } }, "additionalProperties": false, "required": [ "startTradingSessionOffset", "endTradingSessionOffset" ] }, "estimationWindow": { "type": "object", "properties": { "startTradingSessionOffset": { "type": "integer" }, "endTradingSessionOffset": { "type": "integer" } }, "additionalProperties": false, "required": [ "startTradingSessionOffset", "endTradingSessionOffset" ], "description": "Required by 'mean-adjusted' and 'market'; must end strictly before the event window starts" }, "expectedReturnModel": { "anyOf": [ { "type": "object", "properties": { "model": { "const": "mean-adjusted", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "market-adjusted", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] }, { "type": "object", "properties": { "model": { "const": "market", "type": "string" } }, "additionalProperties": false, "required": [ "model" ] } ], "description": "The serializable models; a 'custom' expected-return function is SDK-only" }, "sessionPolicy": { "type": "string", "enum": [ "announcement-session", "next-session" ] }, "overlappingEventPolicy": { "type": "string", "enum": [ "reject", "allow-contaminated" ] }, "cumulativeConvention": { "type": "string", "enum": [ "sum", "compound" ] } }, "additionalProperties": false, "required": [ "events", "returnObservations", "eventWindow", "expectedReturnModel", "overlappingEventPolicy" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" }, "events": { "type": "array", "items": { "type": "object" } }, "averageAbnormalReturns": { "type": "array", "items": { "type": "object" } } }, "required": [ "assumptions", "diagnostics", "events", "averageAbnormalReturns" ] } ``` ### totalfinance.research.rank Rank a universe Rank a point-in-time universe by one declared numeric field with an explicit tie policy (competition, dense, ordinal) and missing-value policy. The result is rankUniverse(...) verbatim. Version: 1; pack: research; profiles: `full`, `research`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "universeId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch ms; the latest observation at or before it is used per instrument" }, "observations": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "availableTimestampMs": { "type": "number" }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" }, { "type": "null" } ] }, "description": "Declared fields only; null is a stated missing value" } }, "additionalProperties": false, "required": [ "instrumentId", "availableTimestampMs", "fields" ] } }, "fieldDefinitions": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "numeric", "category", "text", "boolean" ] }, "unit": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "fieldName", "kind" ] }, "minItems": 1 }, "rankBy": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": [ "ascending", "descending" ] } }, "additionalProperties": false, "required": [ "field", "direction" ] }, "tiePolicy": { "type": "string", "enum": [ "competition", "dense", "ordinal" ] }, "missingValuePolicy": { "type": "string", "enum": [ "exclude", "evaluate-as-false" ] } }, "additionalProperties": false, "required": [ "universeId", "asOf", "observations", "fieldDefinitions", "rankBy", "tiePolicy", "missingValuePolicy" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" }, "rows": { "type": "array", "items": { "type": "object" }, "description": "{ instrumentId, value, rank }" } }, "required": [ "assumptions", "diagnostics", "rows" ] } ``` ### totalfinance.research.score Score a universe Score a point-in-time universe as a weighted composite of standardized components (z-score or percentile rank, higher- or lower-is-better) with an explicit missing-value policy. The result is scoreUniverse(...) verbatim. Version: 1; pack: research; profiles: `full`, `research`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "universeId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch ms; the latest observation at or before it is used per instrument" }, "observations": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "availableTimestampMs": { "type": "number" }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" }, { "type": "null" } ] }, "description": "Declared fields only; null is a stated missing value" } }, "additionalProperties": false, "required": [ "instrumentId", "availableTimestampMs", "fields" ] } }, "fieldDefinitions": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "numeric", "category", "text", "boolean" ] }, "unit": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "fieldName", "kind" ] }, "minItems": 1 }, "components": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "weight": { "type": "number", "exclusiveMinimum": 0 }, "direction": { "type": "string", "enum": [ "higher-is-better", "lower-is-better" ] }, "standardization": { "type": "string", "enum": [ "z-score", "percentile-rank" ] } }, "additionalProperties": false, "required": [ "field", "weight", "direction", "standardization" ] }, "minItems": 1 }, "missingValuePolicy": { "type": "string", "enum": [ "exclude", "renormalize-weights" ] } }, "additionalProperties": false, "required": [ "universeId", "asOf", "observations", "fieldDefinitions", "components", "missingValuePolicy" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" }, "rows": { "type": "array", "items": { "type": "object" }, "description": "{ instrumentId, score, componentsUsed }" } }, "required": [ "assumptions", "diagnostics", "rows" ] } ``` ### totalfinance.research.screen Screen a universe Filter a point-in-time universe of instrument observations with a declarative filter tree, order the survivors, and optionally limit them — a replayable screen by construction (no caller predicate crosses the wire). The result is screenUniverse(...) verbatim. Version: 1; pack: research; profiles: `full`, `research`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "universeId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch ms; the latest observation at or before it is used per instrument" }, "observations": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "availableTimestampMs": { "type": "number" }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" }, { "type": "null" } ] }, "description": "Declared fields only; null is a stated missing value" } }, "additionalProperties": false, "required": [ "instrumentId", "availableTimestampMs", "fields" ] } }, "fieldDefinitions": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "numeric", "category", "text", "boolean" ] }, "unit": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false, "required": [ "fieldName", "kind" ] }, "minItems": 1 }, "filter": { "$id": "https://totalfinance.dev/schemas/research/screen-filter", "oneOf": [ { "type": "object", "properties": { "all": { "type": "array", "minItems": 1, "items": { "$ref": "https://totalfinance.dev/schemas/research/screen-filter" } } }, "required": [ "all" ], "additionalProperties": false }, { "type": "object", "properties": { "any": { "type": "array", "minItems": 1, "items": { "$ref": "https://totalfinance.dev/schemas/research/screen-filter" } } }, "required": [ "any" ], "additionalProperties": false }, { "type": "object", "properties": { "not": { "$ref": "https://totalfinance.dev/schemas/research/screen-filter" } }, "required": [ "not" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual" ] }, "value": { "type": "number" } }, "required": [ "field", "operator", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "equals", "notEquals" ] }, "value": { "type": [ "number", "string", "boolean" ] } }, "required": [ "field", "operator", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "between" ] }, "from": { "type": "number" }, "to": { "type": "number" } }, "required": [ "field", "operator", "from", "to" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "in", "notIn" ] }, "values": { "type": "array", "minItems": 1, "items": { "type": [ "number", "string" ] } } }, "required": [ "field", "operator", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": [ "isPresent", "isMissing" ] } }, "required": [ "field", "operator" ], "additionalProperties": false } ], "description": "Complete ScreenFilter grammar (executable examples: docs/guides/dogfood-journeys.md): ordering operators greaterThan | greaterThanOrEqual | lessThan | lessThanOrEqual require numeric value; equals | notEquals use a number/string/boolean value. No gt/gte aliases. A ScreenFilter tree — { all: [...] } | { any: [...] } | { not: ... } | { field, operator, value } | { field, operator: 'between', from, to } | { field, operator: 'in' | 'notIn', values } | { field, operator: 'isPresent' | 'isMissing' } — validated node by node by screenUniverse; omitted = every eligible row passes" }, "missingValuePolicy": { "type": "string", "enum": [ "exclude", "evaluate-as-false" ] }, "orderBy": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": [ "ascending", "descending" ] } }, "additionalProperties": false, "required": [ "field", "direction" ] } }, "limit": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "universeId", "asOf", "observations", "fieldDefinitions", "missingValuePolicy", "orderBy" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" }, "rows": { "type": "array", "items": { "type": "object" }, "description": "{ instrumentId, availableTimestampMs, fields }" } }, "required": [ "assumptions", "diagnostics", "rows" ] } ``` ### totalfinance.risk.optimize Portfolio optimization Solve a portfolio: minVariance, maxSharpe (tangency), meanVariance utility, riskParity (equal risk contribution), hrp (hierarchical risk parity), or kelly. Returns the Computed envelope: value.weights + value.objective, assumptions echo the objective and budget, and diagnostics carry converged/iterations — a non-converged solve adds an optimize.not_converged warning instead of pretending. Version: 1; pack: risk; profiles: `default`, `full`, `portfolio`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "objective": { "type": "string", "enum": [ "minVariance", "maxSharpe", "meanVariance", "riskParity", "hrp", "kelly" ], "description": "Which portfolio to solve for" }, "covariance": { "type": "array", "items": { "type": "array", "items": { "type": "number" } }, "description": "Asset covariance matrix (per-period, decimal² units), square" }, "mean": { "type": "array", "items": { "type": "number" }, "description": "Per-asset expected returns (decimals) — required for maxSharpe/meanVariance/kelly" }, "riskFreeRatePerPeriod": { "type": "number", "description": "PER-PERIOD risk-free rate (decimal; maxSharpe only) — the same period as the covariance matrix, NOT annualized. Renamed from `riskFreeRate` because every other risk-free rate in the library is annual, and the two were silently interchangeable here" }, "riskAversion": { "type": "number", "exclusiveMinimum": 0, "description": "λ for meanVariance (default 1)" }, "fraction": { "type": "number", "exclusiveMinimum": 0, "description": "Kelly fraction (default 1 = full Kelly)" }, "longOnly": { "type": "boolean", "description": "Forbid short positions" }, "budget": { "type": "number", "description": "Σw target (default 1 = fully invested)" } }, "additionalProperties": false, "required": [ "objective", "covariance" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.risk.value_at_risk Value-at-Risk & Conditional VaR Estimate Value-at-Risk (VaR) and Conditional VaR / expected shortfall from a return series. Methods: historical (empirical quantile, default), parametric (Gaussian, optional Cornish-Fisher for skew/kurtosis), or monteCarlo. Both are positive loss magnitudes at the given `confidence`; the horizon scales by √-time. The applied confidence/method/horizon ride `assumptions` (with the resolved seed/samples for monteCarlo) and warnings ride `diagnostics`. Version: 1; pack: risk; profiles: `default`, `full`, `portfolio`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: false. Stochastic: per-call. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "returns": { "type": "array", "items": { "type": "number" }, "description": "Periodic returns as decimals (e.g. 0.01 = +1%)" }, "confidence": { "type": "number", "exclusiveMinimum": 0, "description": "Confidence level in (0, 1); default 0.95" }, "method": { "type": "string", "enum": [ "historical", "parametric", "monteCarlo" ], "description": "Estimation method; default historical" }, "horizonPeriods": { "type": "number", "exclusiveMinimum": 0, "description": "Holding-period horizon in periods; scales by √-time; default 1" }, "cornishFisher": { "type": "boolean", "description": "Parametric only: Cornish-Fisher adjustment for skew/excess-kurtosis" }, "samples": { "type": "integer", "maximum": 1000000, "exclusiveMinimum": 0, "description": "Monte-Carlo only: number of simulated paths; default 10000, capped at 1,000,000 (compute is bounded BEFORE the work starts, not just by the deadline)." }, "seed": { "type": "integer", "description": "Monte-Carlo only: PRNG seed; default 0" } }, "additionalProperties": false, "required": [ "returns" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "type": "object", "properties": { "valueAtRisk": { "type": "number", "description": "Positive loss magnitude at `confidence`" }, "conditionalValueAtRisk": { "type": "number", "description": "Conditional VaR / expected shortfall (≥ valueAtRisk)" } }, "required": [ "valueAtRisk", "conditionalValueAtRisk" ] }, "assumptions": { "type": "object", "description": "confidence, method, horizonPeriods, cornishFisher, conventionsVersion (+ seed/samples when method is monteCarlo)" }, "diagnostics": { "type": "object", "description": "method + warnings" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.scenario.run Run a scenario set against targets Revalue every target under every scenario of a Gate B scenario set against a Gate B market snapshot: a scenario-major cell grid with base values, per-cell P&L in local and reporting currency, and per-scenario aggregates. Targets are the serializable kinds — spot assets, Taylor (greeks) positions, and a portfolio bound through Taylor bindings. The result is runScenarios(...) verbatim. Version: 1; pack: scenario; profiles: `full`, `scenarios`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `scenarioSet`, `market`. Cost: large. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} SDK-only limitation: Execution options; market resolvers and factor handlers are SDK-only callbacks SDK-only limitation: Wire targets: kind 'spot' (scenarioTarget.spot), 'taylor' (scenarioTarget.taylor), or 'portfolio' (scenarioTargetsFromPortfolio with Taylor bindings). A custom pricer target is SDK-only. Input JSON Schema: ```json { "type": "object", "properties": { "scenarioSet": { "type": "object", "properties": { "kind": { "const": "totalfinance.scenario-set", "type": "string" }, "schemaVersion": { "type": "integer" }, "name": { "type": "string", "minLength": 1 }, "scenarios": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "shocks": { "type": "array", "items": { "type": "object", "properties": { "factor": { "type": "string" }, "kind": { "type": "string", "enum": [ "percent", "absolute" ] }, "value": { "type": "number" }, "target": { "type": "string" } }, "additionalProperties": false, "required": [ "factor", "kind", "value" ] } }, "overrides": { "type": "array", "items": { "type": "object", "properties": { "factor": { "type": "string" }, "value": { "type": "number" }, "target": { "type": "string" } }, "additionalProperties": false, "required": [ "factor", "value" ] } } }, "additionalProperties": false, "required": [ "name", "shocks" ] }, "minItems": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "name", "scenarios" ], "description": "A Gate B scenario set (totalfinance.scenario-set)" }, "market": { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "type": "integer" }, "asOf": { "type": "number", "description": "Epoch ms (resolved on the artifact)" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time (a bare date is refused by option pricing)" }, "dayCount": { "type": "string" }, "compounding": { "type": "string" }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number" } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "chains": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ], "description": "A Gate B market snapshot (totalfinance.market-snapshot); its interior is re-validated by the read door" }, "targets": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "spot", "type": "string" }, "id": { "type": "string", "minLength": 1 }, "symbol": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" }, "currency": { "type": "string" }, "strategy": { "type": "string" }, "account": { "type": "string" }, "book": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "kind", "id", "symbol", "quantity", "currency" ] }, { "type": "object", "properties": { "kind": { "const": "taylor", "type": "string" }, "id": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" }, "contractMultiplier": { "type": "number" }, "currency": { "type": "string" }, "underlying": { "type": "string" }, "strategy": { "type": "string" }, "account": { "type": "string" }, "book": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "baseValuePerUnit": { "type": "number" }, "greeks": { "type": "object", "properties": { "delta": { "type": "number", "description": "∂V/∂S per $1 of spot" }, "gamma": { "type": "number", "description": "∂²V/∂S² per $1²" }, "vega": { "type": "number", "description": "∂V/∂σ per 1 volatility POINT (0.01), as option.greeks reports it" }, "theta": { "type": "number", "description": "∂V/∂t per CALENDAR DAY, as option.greeks reports it" }, "rho": { "type": "number", "description": "∂V/∂r per 1% rate (0.01), as option.greeks reports it" }, "vanna": { "type": "number", "description": "∂Δ/∂σ per 1.00 σ per $" }, "vomma": { "type": "number", "description": "∂²V/∂σ² per 1.00 σ²" }, "charm": { "type": "number", "description": "∂Δ/∂T per year of time-to-expiry (options-package sign)" }, "veta": { "type": "number", "description": "∂vega/∂T per year, vega per 1.00 σ" }, "vera": { "type": "number", "description": "∂²V/∂σ∂r per 1.00 σ per 1.00 rate" }, "deltaRate": { "type": "number", "description": "∂Δ/∂r per $ per 1% rate" }, "thetaRate": { "type": "number", "description": "∂Θ/∂r per calendar day per 1% rate" }, "rhoConvexity": { "type": "number", "description": "∂²V/∂r² per (1%)²" }, "thetaConvexity": { "type": "number", "description": "∂²V/∂t² per calendar day²" }, "phi": { "type": "number", "description": "∂V/∂q per 1% dividend yield (dividend rho)" } }, "additionalProperties": false }, "factors": { "type": "object", "properties": { "spot": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "volatility": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "riskFreeRate": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "dividend": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "valuationInstant": { "type": "object", "properties": { "level": { "type": "number" } }, "additionalProperties": false, "required": [ "level" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "id", "quantity", "contractMultiplier", "currency", "baseValuePerUnit", "greeks", "factors" ] }, { "type": "object", "properties": { "kind": { "const": "portfolio", "type": "string" }, "portfolio": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Portfolio event envelopes (each re-validated by readPortfolioLedgerSnapshot)" }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number" }, "receivedAt": { "type": "number" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ], "description": "A serialized portfolio ledger (totalfinance.portfolio-ledger, the FC7 JSON form)" }, { "type": "object", "properties": { "schemaVersion": { "type": "integer" }, "portfolioId": { "type": "string" }, "baseCurrency": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "accounts": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "appliedEvents": { "type": "object", "additionalProperties": { "type": "string" } }, "eventCount": { "type": "integer", "minimum": 0 }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lotSequence": { "type": "integer", "minimum": 0 }, "fillEffects": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} } }, "reversals": { "type": "object", "additionalProperties": { "type": "string" } }, "accountMigrations": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "additionalProperties": false, "required": [ "schemaVersion", "baseCurrency", "lotRelief", "accounts", "appliedEvents", "eventCount", "lastEffectiveTimestampMs", "lotSequence", "fillEffects", "reversals", "accountMigrations" ], "description": "A derived PortfolioState (from applyPortfolioEvents or ledger.state)" } ], "description": "The ledger envelope or PortfolioState whose open positions become targets" }, "bindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "strategy": { "type": "string" }, "book": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "baseValuePerUnit": { "type": "number" }, "greeks": { "type": "object", "properties": { "delta": { "type": "number", "description": "∂V/∂S per $1 of spot" }, "gamma": { "type": "number", "description": "∂²V/∂S² per $1²" }, "vega": { "type": "number", "description": "∂V/∂σ per 1 volatility POINT (0.01), as option.greeks reports it" }, "theta": { "type": "number", "description": "∂V/∂t per CALENDAR DAY, as option.greeks reports it" }, "rho": { "type": "number", "description": "∂V/∂r per 1% rate (0.01), as option.greeks reports it" }, "vanna": { "type": "number", "description": "∂Δ/∂σ per 1.00 σ per $" }, "vomma": { "type": "number", "description": "∂²V/∂σ² per 1.00 σ²" }, "charm": { "type": "number", "description": "∂Δ/∂T per year of time-to-expiry (options-package sign)" }, "veta": { "type": "number", "description": "∂vega/∂T per year, vega per 1.00 σ" }, "vera": { "type": "number", "description": "∂²V/∂σ∂r per 1.00 σ per 1.00 rate" }, "deltaRate": { "type": "number", "description": "∂Δ/∂r per $ per 1% rate" }, "thetaRate": { "type": "number", "description": "∂Θ/∂r per calendar day per 1% rate" }, "rhoConvexity": { "type": "number", "description": "∂²V/∂r² per (1%)²" }, "thetaConvexity": { "type": "number", "description": "∂²V/∂t² per calendar day²" }, "phi": { "type": "number", "description": "∂V/∂q per 1% dividend yield (dividend rho)" } }, "additionalProperties": false }, "factors": { "type": "object", "properties": { "spot": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "volatility": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "riskFreeRate": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "dividend": { "type": "object", "properties": { "subject": { "type": "string" }, "level": { "type": "number" } }, "additionalProperties": false, "required": [ "subject", "level" ] }, "valuationInstant": { "type": "object", "properties": { "level": { "type": "number" } }, "additionalProperties": false, "required": [ "level" ] } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "id", "accountId", "instrumentId", "baseValuePerUnit", "greeks", "factors" ] }, "minItems": 1, "description": "Exactly one Taylor binding per open (accountId, instrumentId) position — the serializable binding kind" } }, "additionalProperties": false, "required": [ "kind", "portfolio", "bindings" ] } ] }, "minItems": 1, "description": "Wire targets: kind 'spot' (scenarioTarget.spot), 'taylor' (scenarioTarget.taylor), or 'portfolio' (scenarioTargetsFromPortfolio with Taylor bindings). A custom pricer target is SDK-only." }, "reportingCurrency": { "type": "string" }, "currencyConversions": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "options": { "type": "object", "properties": { "failureMode": { "type": "string", "enum": [ "fail-fast", "collect" ] }, "seed": { "type": "integer", "minimum": 0 }, "maximumValuationCells": { "type": "integer", "exclusiveMinimum": 0 }, "maximumWorkUnits": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "description": "Execution options; market resolvers and factor handlers are SDK-only callbacks" } }, "additionalProperties": false, "required": [ "scenarioSet", "market", "targets" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "layout": { "type": "object", "description": "scenario-major cell layout and the index formula" }, "scenarioAxis": { "type": "array", "items": { "type": "object" } }, "targetAxis": { "type": "array", "items": { "type": "object" } }, "base": { "type": "array", "items": { "type": "object" } }, "cells": { "type": "array", "items": { "type": "object" } }, "aggregates": { "type": "object" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "layout", "scenarioAxis", "targetAxis", "base", "cells", "aggregates", "assumptions", "diagnostics" ] } ``` ### totalfinance.strategy.analyze Analyze an options strategy Build a multi-leg options position from its legs and return breakevens, net debit/credit, max profit, and max loss. Legs may be given without premiums: pass `premiums: "model"` with a `market` snapshot (spot, volatility, riskFreeRate, asOf, expiry) and every unpriced leg is priced by the BSM engine — so an iron condor’s P&L and probability-of-profit come from strikes alone. Set `probability: true` (with `market`) to also get probability-of-profit, expected value, risk/reward, and probability-of-touch. `premiumSource` reports whether premiums were user- or model-supplied. Version: 1; pack: strategy; profiles: `default`, `full`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "legs": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "stock", "type": "string" }, "quantity": { "type": "number", "description": "Signed shares: positive = long, negative = short" }, "price": { "type": "number", "description": "Entry price per share; omit to model-price the leg at `market.spot`" } }, "additionalProperties": false, "required": [ "kind", "quantity" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "call", "put" ] }, "strike": { "type": "number", "exclusiveMinimum": 0 }, "quantity": { "type": "number", "description": "Signed contracts: positive = long, negative = short" }, "premium": { "type": "number", "description": "Entry premium per share; omit to model-price the leg from `market`" }, "expiry": { "type": "string", "description": "Per-leg expiry (YYYY-MM-DD or datetime) for calendars/diagonals" }, "impliedVolatility": { "type": "number", "exclusiveMinimum": 0, "description": "Per-leg implied volatility (decimal)" } }, "additionalProperties": false, "required": [ "kind", "strike", "quantity" ] } ] }, "description": "The option/stock legs of the position — supply legs OR strategy+input" }, "strategy": { "type": "string", "description": "A named builder from totalfinance.strategy.list (e.g. ironCondor); pair with `input`" }, "input": { "type": "object", "additionalProperties": {}, "description": "The named builder's input (shape per totalfinance.strategy.list examples)" }, "premiums": { "type": "string", "enum": [ "user", "model" ], "description": "Entry-premium source: 'user' (from the leg premiums, default) or 'model' (price unpriced legs from `market`)" }, "market": { "type": "object", "properties": { "spot": { "type": "number", "exclusiveMinimum": 0 }, "volatility": { "type": "number", "exclusiveMinimum": 0, "description": "Annualized implied volatility (decimal, e.g. 0.18)" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Entry/valuation instant — epoch ms or a zoned ISO datetime (a bare date is refused)" }, "expiry": { "type": "string", "description": "Default expiry for legs without their own (YYYY-MM-DD → the US close, 16:00 ET or 13:00 ET on early-close days; or a zoned datetime)" }, "dividendYield": { "type": "number" } }, "additionalProperties": false, "required": [ "spot", "volatility", "riskFreeRate", "asOf" ], "description": "Market snapshot; required for `premiums: model` and for `probability`" }, "probability": { "type": "boolean", "description": "Also compute probability-of-profit, expected value, risk/reward, and probability-of-touch (needs `market`)" }, "multiplier": { "type": "number", "exclusiveMinimum": 0, "description": "Contract multiplier for option legs (default 100)" } }, "additionalProperties": false } ``` Output JSON Schema: ```json { "type": "object", "properties": { "premiumSource": { "type": "string", "enum": [ "user", "model" ] }, "classification": { "type": "array", "items": { "type": "string" }, "description": "Named strategies these legs structurally match (derived via classifyStrategy; empty = custom)" }, "metrics": { "type": "object", "properties": { "netDebit": { "type": "number" }, "netCredit": { "type": "number" }, "maxProfit": { "type": [ "number", "null" ], "description": "Maximum profit at expiration; null when unbounded (see bounded.profit)" }, "maxLoss": { "type": [ "number", "null" ], "description": "Maximum loss at expiration (negative); null when unbounded (see bounded.loss)" }, "bounded": { "type": "object", "properties": { "profit": { "type": "boolean" }, "loss": { "type": "boolean" } }, "required": [ "profit", "loss" ] }, "breakevens": { "type": "array", "items": { "type": "number" } } }, "required": [ "netDebit", "netCredit", "maxProfit", "maxLoss", "bounded", "breakevens" ] }, "legs": { "type": "array", "items": { "type": "object" } }, "assumptions": { "type": "object", "description": "Position-construction assumptions (premium source, multiplier, provenance)" }, "diagnostics": { "type": "object", "description": "Warnings from the metric/probability computations (empty array when none)" }, "probability": { "type": "object", "description": "Present when `probability: true` was supplied (requires `market`)", "properties": { "probabilityOfProfit": { "type": "number" }, "expectedValue": { "type": "number" }, "riskReward": { "type": [ "number", "null" ], "description": "|maxProfit / maxLoss|; null when undefined (an unbounded side or a zero max loss) — see diagnostics" }, "probabilityOfTouch": { "type": "array" }, "model": { "type": "object" }, "assumptions": { "type": "object", "description": "Probability-model conventions, including `marketSource` (construction | call | merged)" } } } }, "required": [ "premiumSource", "metrics", "legs", "classification", "assumptions", "diagnostics" ] } ``` ### totalfinance.strategy.list List the named-strategy catalog Discover every named strategy builder: name, one-line description, whether it spans multiple expiries, and a canonical example input (the exact shape `totalfinance.strategy.analyze` accepts via its `strategy` + `input` form). Agents self-serve the input shapes from here. Version: 1; pack: strategy; profiles: `default`, `full`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "multiExpiry": { "type": "boolean", "description": "Filter: only multi-expiry (true) or single (false)" } }, "additionalProperties": false } ``` Output JSON Schema: ```json { "type": "object", "properties": { "count": { "type": "integer" }, "strategies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "multiExpiry": { "type": "boolean" }, "example": { "type": "object", "description": "A canonical, buildable input for this builder" } }, "required": [ "name", "description", "multiExpiry", "example" ] } } }, "required": [ "count", "strategies" ] } ``` ### totalfinance.structure.exposures Dealer exposure & levels from an option chain Compute dealer-positioning exposure (net GEX/DEX at spot) and key levels — call/put walls, zero-gamma flip, max pain, pin risk, and 0DTE/weekly/monthly OPEX walls — from an option chain. Each row needs `strike`, `expiry`, `type`, `openInterest`, and either `impliedVolatility` or `price` (IV is implied from price when omitted). Inferred from open interest and a sign convention (echoed in `assumptions.convention`, with its caveats as `model.limitation` warnings in `diagnostics.warnings`) — it does not know true dealer books. Version: 1; pack: structure; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "object", "properties": { "strike": { "type": "number", "exclusiveMinimum": 0 }, "expiry": { "type": "string", "description": "ISO date YYYY-MM-DD" }, "type": { "type": "string", "enum": [ "call", "put" ] }, "openInterest": { "type": "number", "description": "Open interest (contracts)" }, "impliedVolatility": { "type": "number", "exclusiveMinimum": 0, "description": "Implied volatility (decimal); when omitted, implied from `price`" }, "price": { "type": "number", "exclusiveMinimum": 0, "description": "Option mid price; used to imply IV when `impliedVolatility` is omitted" }, "multiplier": { "type": "number", "exclusiveMinimum": 0, "description": "Contract multiplier (default 100)" } }, "additionalProperties": false, "required": [ "strike", "expiry", "type", "openInterest" ] }, "description": "The option chain: one row per contract" }, "spot": { "type": "number", "exclusiveMinimum": 0 }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Valuation instant — epoch ms or a zoned ISO datetime such as \"2026-07-20T10:30:00-04:00\". A bare YYYY-MM-DD is refused: a same-day option's value depends on the time of day. For an end-of-day mark use the 16:00 ET close (13:00 ET on early-close days)." }, "dividendYield": { "type": "number" }, "convention": { "type": "string", "enum": [ "callsPositivePutsNegative", "dealerShortGamma" ], "description": "Dealer sign convention — REQUIRED, it decides the sign of every exposure number; echoed back with its limitations" }, "style": { "type": "string", "enum": [ "american", "european" ], "description": "Exercise style of every contract in the chain — REQUIRED (listed US equity options are 'american'); the library never defaults it" }, "gammaUnit": { "type": "string", "enum": [ "per1PercentMove", "perPoint" ], "description": "GEX units: per1PercentMove (default, the specification formula) or perPoint" }, "underlying": { "type": "string", "description": "Ticker symbol of the chain — REQUIRED, it names every contract" }, "topStrikes": { "type": "integer", "exclusiveMinimum": 0, "description": "How many top-|GEX| strikes to return (default 10)" } }, "additionalProperties": false, "required": [ "chain", "spot", "riskFreeRate", "asOf", "convention", "style", "underlying" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "spot": { "type": "number" }, "atSpot": { "type": "object", "description": "Net dealer exposure at spot", "properties": { "gex": { "type": "number" }, "dex": { "type": "number" } }, "required": [ "gex", "dex" ] }, "levels": { "type": "object", "description": "Walls, zero-gamma, max pain, pin risk, and OPEX walls" }, "netDrift": { "type": "object", "description": "Gamma regime + pin/trend bias + charm/vanna flow" }, "topStrikes": { "type": "array", "description": "Highest-|GEX| strikes, most concentrated first", "items": { "type": "object" } }, "assumptions": { "type": "object", "description": "Every applied convention: the sign `convention`, gammaUnit, priceSource, minTimeToExpiry, defaultMultiplier, …" }, "diagnostics": { "type": "object", "description": "Warnings, including the model limitations as `model.limitation` entries (positioning is estimated from OI + a sign convention, not true dealer books)" } }, "required": [ "spot", "atSpot", "levels", "netDrift", "topStrikes", "assumptions", "diagnostics" ] } ``` ### totalfinance.structure.flow Classify options flow (sweeps / blocks / spreads) Classify option prints into aggressor-side flow: sweeps (multi-print bursts, venue-verified when exchange codes are supplied), blocks, and multi-leg spreads. Aggressor side is NBBO-estimated (Lee–Ready style) — the honest caveats ride diagnostics.warnings as `model.limitation` entries (mirrored as `limitations` strings for quick reading); nothing is presented as exchange-confirmed unless it is. Version: 1; pack: structure; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "trades": { "type": "array", "items": { "type": "object", "properties": { "timestampMs": { "type": "number", "description": "Print timestamp (epoch ms)" }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strike": { "type": "number", "exclusiveMinimum": 0 }, "expiry": { "type": "string", "description": "ISO date YYYY-MM-DD" }, "price": { "type": "number", "exclusiveMinimum": 0, "description": "Print price per share" }, "size": { "type": "number", "exclusiveMinimum": 0, "description": "Print size (contracts)" }, "bid": { "type": "number", "description": "NBBO bid at print time (enables aggressor-side classification)" }, "ask": { "type": "number", "description": "NBBO ask at print time" }, "exchange": { "type": "string", "description": "Venue code (enables venue-verified sweep detection)" }, "openInterest": { "type": "number", "description": "Prior open interest (enables opening detection)" } }, "additionalProperties": false, "required": [ "timestampMs", "type", "strike", "expiry", "price", "size" ] }, "description": "Option prints, any order (sorted internally)" }, "underlying": { "type": "string", "description": "Ticker of the prints — REQUIRED, it names every contract" }, "style": { "type": "string", "enum": [ "american", "european" ], "description": "Exercise style of the printed contracts — REQUIRED (listed US equity options are 'american'); the library never defaults it" }, "multiplier": { "type": "number", "exclusiveMinimum": 0, "description": "Contract multiplier (default 100)" }, "blockMinSize": { "type": "number", "description": "Min contracts for a block (default 100)" }, "blockMinPremium": { "type": "number", "description": "Min premium $ for a block (default 100,000)" }, "maxDetails": { "type": "integer", "exclusiveMinimum": 0, "description": "Max sweeps/spreads returned in detail (default 25 each)" } }, "additionalProperties": false, "required": [ "trades", "underlying", "style" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "counts": { "type": "object", "description": "trades/sweeps/spreads/buy/sell/unknown totals" }, "sweeps": { "type": "array", "description": "Detected sweeps (capped by maxDetails)" }, "spreads": { "type": "array", "description": "Detected multi-leg spreads (capped)" }, "assumptions": { "type": "object", "description": "The rules/windows the analysis ran under" }, "diagnostics": { "type": "object", "description": "Warnings, including the heuristic caveats as `model.limitation` entries" }, "limitations": { "type": "array", "items": { "type": "string" }, "description": "Convenience view: the `model.limitation` messages from diagnostics.warnings (diagnostics is the source of truth)" } }, "required": [ "counts", "sweeps", "spreads", "assumptions", "diagnostics", "limitations" ] } ``` ### totalfinance.technical_analysis.calculate Calculate a technical indicator Compute any of TotalFinance’s ~300 registered technical indicators over a price series. Pass canonical core Bar records directly under bars; symbol, timestampMs, vwap and adjusted are declared fields. Source records require open, one symbol and strictly increasing unique timestamps; no stripping or SDK preprocessing is needed. Identity/time are validated before OHLCV projection; retain the original source/provenance alongside the result. Close-based (`series`) indicators take `closes`; bar-based indicators take `bars` (OHLCV objects) or parallel column arrays under `series`; pair indicators (e.g. beta, correl) take `x` and `y`. Use `totalfinance.technical_analysis.list` to discover indicator names, input kinds, and parameters. Output is aligned to input length with null during warmup; `assumptions.parameters` echoes the parameters actually used (declared defaults merged with yours), and `diagnostics.warmup` is the first real index. Version: 1; pack: technical_analysis; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "indicator": { "type": "string", "enum": [ "typicalPrice", "medianPrice", "weightedClose", "averagePrice", "realBody", "upperShadow", "lowerShadow", "candleRange", "trueRange", "gap", "heikinAshi", "returns", "logReturns", "rollingVolatility", "sma", "ema", "wma", "rma", "dema", "tema", "trima", "t3", "kama", "hma", "zlema", "alma", "vidya", "mcginley", "superSmoother", "vwma", "rollingVwap", "anchoredVwap", "frama", "mama", "movingAverage", "midpoint", "midprice", "fwma", "sineWma", "pascalWma", "symmetricWma", "jma", "holtWinterMovingAverage", "rainbowMovingAverage", "movingAverageRibbon", "gannHighLowActivator", "vwapBands", "sessionVwap", "rollingAnchoredVwap", "rsi", "macd", "roc", "rocp", "rocr", "rocr100", "momentum", "cmo", "apo", "ppo", "stochRsi", "trix", "dpo", "tsi", "kst", "connorsRsi", "macdExt", "macdFix", "cci", "williamsR", "awesomeOscillator", "ultimateOscillator", "fisherTransform", "stochastic", "stochFast", "bop", "bias", "cfo", "forecastOscillator", "coppock", "cti", "efficiencyRatio", "centerOfGravity", "psychologicalLine", "slope", "trixHistogram", "smiErgodic", "pvo", "elderRay", "brar", "kdj", "relativeVigorIndex", "pgo", "volumeWeightedMacd", "inertia", "laguerreRsi", "qqe", "rsx", "schaffTrendCycle", "squeeze", "squeezePro", "projectionOscillator", "tdSequential", "smcSweep", "adx", "dmi", "plusDI", "minusDI", "plusDM", "minusDM", "dx", "adxr", "aroon", "aroonOscillator", "psar", "psarExt", "supertrend", "ichimoku", "vortex", "donchianTrend", "chandelierExit", "linreg", "linregSlope", "linregIntercept", "linregAngle", "tsf", "choppinessIndex", "chandeKrollStop", "centralPivotRange", "amat", "linearDecay", "exponentialDecay", "increasing", "decreasing", "longRun", "shortRun", "pMax", "qstick", "ttmTrend", "verticalHorizontalFilter", "trendSignals", "crossSignals", "atr", "natr", "keltner", "donchian", "parkinson", "garmanKlass", "rogersSatchell", "yangZhang", "chaikinVolatility", "bbands", "bollingerBandWidth", "bollingerPercentB", "standardDeviation", "variance", "historicalVolatility", "realizedVolatility", "relativeVolatilityIndex", "aberration", "accelerationBands", "holtWinterChannel", "massIndex", "priceDistance", "elderThermometer", "ulcerIndex", "atrBands", "percentAtr", "volatilityStop", "obv", "vwap", "adLine", "chaikinOscillator", "chaikinMoneyFlow", "mfi", "pvt", "easeOfMovement", "forceIndex", "nvi", "pvi", "klinger", "vfi", "relativeVolume", "cvd", "archerObv", "marketFacilitationIndex", "priceVolume", "priceVolumeRank", "volumeOscillator", "williamsAd", "efi", "emv", "kvo", "dsp", "ebsw", "msw", "htDcPeriod", "htDcPhase", "htPhasor", "htSine", "htTrendMode", "htTrendline", "beta", "correl", "rollingMin", "rollingMax", "rollingSum", "rollingMinIndex", "rollingMaxIndex", "rollingMinMax", "rollingMinMaxIndex", "shift", "lag", "diff", "change", "fractionalChange", "cum", "zScore", "normalize", "rescale", "rollingMedian", "mad", "standardError", "rollingRank", "percentRank", "rollingQuantile", "winsorize", "skew", "kurtosis", "entropy", "covariance", "rSquared", "rollingRegression", "barSince", "valueWhen", "rollingMean", "rollingBeta", "rollingCorrelation", "highestBars", "lowestBars", "tosStdevAll", "acos", "asin", "atan", "ceil", "cos", "cosh", "exp", "floor", "ln", "log10", "sin", "sinh", "sqrt", "tan", "tanh", "add", "sub", "mult", "div", "crossover", "crossany", "drawdown", "cdlDoji", "cdlInside", "cdlZ", "fairValueGaps", "orderBlocks", "liquiditySweeps", "swingTrailingStop", "atrTrailingStop", "equalHighs", "equalLows", "divergence", "doji", "dojiStar", "dragonflyDoji", "gravestoneDoji", "longLeggedDoji", "rickshawMan", "takuri", "marubozu", "closingMarubozu", "beltHold", "spinningTop", "highWave", "longLine", "shortLine", "hammer", "invertedHammer", "hangingMan", "shootingStar", "engulfing", "harami", "haramiCross", "piercing", "darkCloudCover", "thrusting", "onNeck", "inNeck", "counterattack", "separatingLines", "matchingLow", "homingPigeon", "kicking", "kickingByLength", "morningStar", "eveningStar", "morningDojiStar", "eveningDojiStar", "abandonedBaby", "triStar", "threeWhiteSoldiers", "threeBlackCrows", "identicalThreeCrows", "threeInside", "threeOutside", "threeLineStrike", "twoCrows", "upsideGapTwoCrows", "advanceBlock", "stalledPattern", "threeStarsInSouth", "concealBabySwallow", "ladderBottom", "riseFallThreeMethods", "matHold", "tasukiGap", "gapSideSideWhite", "xSideGapThreeMethods", "stickSandwich", "uniqueThreeRiver", "breakaway", "hikkake", "hikkakeMod", "inside" ] }, "closes": { "type": "array", "items": { "type": "number" } }, "bars": { "type": "array", "items": { "type": "object", "properties": { "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "symbol": { "type": "string", "description": "Canonical source Bar symbol; include timestampMs and open on every row" }, "timestampMs": { "type": "number", "description": "Canonical source time in epoch ms; strictly increasing within one symbol" }, "vwap": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "high", "low", "close" ] } }, "series": { "type": "object", "properties": { "open": { "type": "array", "items": { "type": "number" } }, "high": { "type": "array", "items": { "type": "number" } }, "low": { "type": "array", "items": { "type": "number" } }, "close": { "type": "array", "items": { "type": "number" } }, "volume": { "type": "array", "items": { "type": "number" } } }, "additionalProperties": false }, "x": { "type": "array", "items": { "type": "number" }, "description": "Pair indicators: the first series (for beta/correl, the ASSET returns)" }, "y": { "type": "array", "items": { "type": "number" }, "description": "Pair indicators: the second series (for beta/correl, the BENCHMARK returns)" }, "parameters": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } } }, "additionalProperties": false, "required": [ "indicator" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "indicator": { "type": "string" }, "category": { "type": "string" }, "inputs": { "type": "string", "enum": [ "series", "bars", "pair" ] }, "value": { "type": "array", "items": { "type": [ "number", "object", "null" ] } }, "assumptions": { "type": "object", "description": "indicator + parameters actually used (declared defaults merged with supplied)" }, "diagnostics": { "type": "object", "description": "warnings + warmup (first non-null index)" } }, "required": [ "indicator", "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.technical_analysis.describe Describe one technical indicator Return the full card for a single indicator (alias-aware): category, input kind, parameters, defaults, which parameters are required, its warmup (leading bars before the first real value), and its cross-library aliases. The token-lean way to learn one indicator without listing all ~335. Discover names with `totalfinance.technical_analysis.list`; compute with `totalfinance.technical_analysis.calculate`. Version: 1; pack: technical_analysis; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "name": { "type": "string", "description": "Indicator name or a TA-Lib/pandas/TradingView alias (e.g. \"rsi\", \"RSI\", \"STOCH\")" } }, "additionalProperties": false, "required": [ "name" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "name": { "type": "string", "description": "Canonical indicator name" }, "category": { "type": "string" }, "inputs": { "type": "string", "enum": [ "series", "bars", "pair" ] }, "parameters": { "type": "array", "items": { "type": "string" } }, "defaults": { "type": "object", "description": "Default per optional parameter ('(derived)' when computed from another parameter)" }, "required": { "type": "array", "items": { "type": "string" } }, "warmup": { "type": [ "integer", "null" ], "description": "Leading bars before the first real value (null = warmup exceeds the probe window)" }, "conventions": { "type": "object", "description": "The choices this indicator made that its parameters do not reveal — smoothing method, what a flat/degenerate window resolves to, how the first value is seeded. Present only where such a choice exists, and the field to read when this indicator disagrees with another library (e.g. RSI on a flat series: TotalFinance 100, TA-Lib 0, pandas-ta NaN)." }, "aliases": { "type": "object", "description": "Cross-library names (TA-Lib / pandas-ta / TradingView), when known" } }, "required": [ "name", "category", "inputs", "parameters", "defaults", "required", "warmup" ] } ``` ### totalfinance.technical_analysis.list List technical indicators Discover the technical indicators available to `totalfinance.technical_analysis.calculate`. Returns each indicator’s name, category, input kind (series | bars | pair), parameters, defaults, and which parameters are required. Narrow the ~335-indicator catalog with `search` (matches a name or a TA-Lib/pandas/TradingView alias) and/or `category`, and page it with `limit` (default 50) / `offset` (`total` is the full match count). For one indicator’s full card (including its warmup), use `totalfinance.technical_analysis.describe`. To browse momentum, use { category: "momentum" }, rather than searching the name momentum. Then pass a name to `totalfinance.technical_analysis.calculate`. Version: 1; pack: technical_analysis; profiles: `default`, `full`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "search": { "type": "string", "description": "Case-insensitive substring of an indicator name OR a TA-Lib/pandas/TradingView alias" }, "category": { "type": "string", "enum": [ "transform", "moving-average", "momentum", "trend", "volatility", "volume", "cycle", "statistic", "math", "performance", "candlestick", "price-action" ], "description": "Browse a category here, e.g. momentum; search matches indicator names/aliases and does not expand category words" }, "limit": { "type": "integer", "exclusiveMinimum": 0, "description": "Page size (default 50; `total` is the full match count) — narrow with `search` before paging" }, "offset": { "type": "integer", "minimum": 0, "description": "Page offset (default 0)" } }, "additionalProperties": false } ``` Output JSON Schema: ```json { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of indicators returned in this page" }, "total": { "type": "integer", "description": "Total matches before pagination" }, "offset": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "category": { "type": "string" }, "inputs": { "type": "string", "enum": [ "series", "bars", "pair" ] }, "parameters": { "type": "array", "items": { "type": "string" } }, "defaults": { "type": "object", "description": "Default per optional parameter ('(derived)' when computed from another parameter)" }, "required": { "type": "array", "items": { "type": "string" }, "description": "Parameters with no default (must be supplied)" } }, "required": [ "name", "category", "inputs", "parameters", "defaults", "required" ] } } }, "required": [ "count", "indicators" ] } ``` ### totalfinance.trade.authorize Mint an authorization grant for a preflighted plan Bind human authority to one plan and one preflight report: the plan hash, the portfolio and market hashes preflight judged, the market instant and an age allowance, the paper mode, the account, a variance envelope, an expiry, the approver, and a closed set of idempotency keys. Refuses a denied preflight, an unjudged plan, or a stale expiry. The grant is put into the authorization store under its content hash and returned with its handle. Requires the trade:approve capability. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `trade:approve`. Authorization: human. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "plan": { "type": "object", "properties": { "kind": { "const": "totalfinance.execution-plan", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "accountId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "portfolioId": { "type": "string", "minLength": 1 }, "orders": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "orderId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0, "description": "Units/contracts, strictly positive; side carries direction" }, "plannedTimestampMs": { "type": "number", "description": "When the plan was made — never when a broker saw the order" }, "submittedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "orderId", "quantity", "plannedTimestampMs", "type" ] }, { "anyOf": [ { "properties": { "type": { "const": "market", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-open", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-close", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice" ], "not": { "anyOf": [ { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "stop", "type": "string" }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "stopPrice" ], "not": { "anyOf": [ { "required": [ "limitPrice" ] } ] } }, { "properties": { "type": { "const": "stop-limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice", "stopPrice" ] } ] } ] }, "minItems": 1, "maxItems": 1000 }, "combos": { "type": "array", "items": { "type": "object", "properties": { "comboId": { "type": "string", "minLength": 1 }, "orderIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 2, "description": "The legs, in plan order (at least two)" }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "comboId", "orderIds" ] } }, "trades": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "referencePricePerUnit": { "type": "number" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "estimatedNotional": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "side", "quantity", "currency", "referencePricePerUnit", "contractMultiplier", "estimatedNotional" ] } }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "intent", "type": "string" }, "intentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "intentHash" ] }, { "type": "object", "properties": { "kind": { "const": "rebalance-proposal", "type": "string" }, "planHash": { "type": "string", "minLength": 1 }, "policyContentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "planHash", "policyContentHash" ] } ] }, "rationale": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "accountId", "asOf", "baseCurrency", "orders", "combos", "trades", "source", "evidence", "contentHash" ] }, "preflight": { "type": "object", "properties": { "kind": { "const": "totalfinance.preflight-report", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "planHash": { "type": "string", "minLength": 1 }, "portfolioHash": { "type": "string", "minLength": 1 }, "marketHash": { "type": "string", "minLength": 1 }, "marketAsOf": { "type": "number", "description": "Epoch milliseconds" }, "before": { "$ref": "#/$defs/Before" }, "after": { "$ref": "#/$defs/Before" }, "hypotheticalFills": { "type": "array", "items": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "filledTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" }, "executionPriceAdjustment": { "type": "number", "minimum": 0 }, "costs": { "type": "object", "properties": { "commission": { "type": "number", "minimum": 0 }, "exchangeFees": { "type": "number", "minimum": 0 }, "regulatoryFees": { "type": "number", "minimum": 0 }, "slippageAdjustment": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "orderId": { "type": "string", "minLength": 1 }, "venue": { "type": "string" }, "liquidity": { "type": "string", "enum": [ "maker", "taker", "unknown" ] } }, "additionalProperties": false, "required": [ "fillId", "accountId", "instrumentId", "side", "quantity", "pricePerUnit", "currency", "filledTimestampMs" ] } }, "hypotheticalEvents": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "estimates": { "type": "object", "properties": { "tradedNotional": { "type": "number" }, "commission": { "type": "number" }, "spread": { "type": "number" }, "slippage": { "type": "number" }, "totalCost": { "type": "number" }, "turnover": { "type": "number" } }, "additionalProperties": false, "required": [ "tradedNotional", "commission", "spread", "slippage", "totalCost", "turnover" ] }, "checks": { "$ref": "#/$defs/Checks" }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1 }, "family": { "type": "string", "enum": [ "allocation-drift", "concentration-limit", "leverage-limit", "drawdown", "daily-loss", "cash-reserve", "margin-pressure", "liquidity", "option-expiration", "assignment-risk", "stale-market-data", "reconciliation-difference", "unexplained-residual", "unusual-pnl" ] }, "subject": { "type": "string" }, "severity": { "type": "string", "enum": [ "informational", "warning", "critical" ] }, "state": { "type": "string", "enum": [ "raised", "active", "acknowledged", "suppressed", "cleared" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "direction": { "type": "string", "enum": [ "above", "below" ] }, "message": { "type": "string" }, "evidence": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] } } }, "additionalProperties": false, "required": [ "key", "family", "subject", "severity", "state", "value", "threshold", "direction", "message", "evidence" ] } }, "decision": { "allOf": [ { "type": "object", "properties": { "verdict": {}, "checks": { "$ref": "#/$defs/Checks" }, "requiredScope": {} }, "additionalProperties": false, "required": [ "verdict", "checks" ] }, { "anyOf": [ { "properties": { "verdict": { "const": "allow", "type": "string" } }, "not": { "anyOf": [ { "required": [ "requiredScope" ] } ] } }, { "properties": { "verdict": { "const": "deny", "type": "string" } }, "not": { "anyOf": [ { "required": [ "requiredScope" ] } ] } }, { "properties": { "verdict": { "const": "require-approval", "type": "string" }, "requiredScope": { "type": "string", "minLength": 1 } }, "required": [ "requiredScope" ] } ] } ] }, "unverifiable": { "type": "array", "items": { "type": "string" } }, "monitorState": { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "const": 1, "type": "number" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "netAssetValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "peakNetAssetValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "evaluationCount": { "type": "integer", "minimum": 0 }, "rules": { "type": "object", "additionalProperties": { "type": "object", "properties": { "active": { "type": "boolean" }, "consecutiveBreaches": { "type": "integer", "minimum": 0 }, "lastRaisedAtMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "acknowledged": { "type": "boolean" }, "lastValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "active", "consecutiveBreaches", "lastRaisedAtMs", "acknowledged", "lastValue" ] } } }, "additionalProperties": false, "required": [ "schemaVersion", "asOf", "netAssetValue", "peakNetAssetValue", "evaluationCount", "rules" ] }, { "type": "null" } ] }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "policyContentHash": { "type": "string" }, "mode": { "const": "paper", "type": "string" }, "costRates": { "type": "object", "properties": { "commissionBps": { "type": "number", "minimum": 0 }, "commissionPerOrder": { "type": "number", "minimum": 0 }, "spreadBps": { "type": "number", "minimum": 0 }, "slippageBps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "commissionBps", "commissionPerOrder", "spreadBps", "slippageBps" ] }, "fillConvention": { "type": "string" }, "instrumentSources": { "type": "object", "additionalProperties": { "type": "string" } }, "decisionConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "policyContentHash", "mode", "costRates", "fillConvention", "instrumentSources", "decisionConvention" ] }, "diagnostics": { "type": "object", "properties": { "engine": { "const": "trade-preflight", "type": "string" }, "method": { "const": "hypothetical-fold", "type": "string" }, "converged": { "const": true, "type": "boolean" }, "warnings": { "$ref": "#/$defs/Warnings" }, "checkCount": { "type": "integer", "minimum": 0 }, "failedCount": { "type": "integer", "minimum": 0 }, "unverifiableCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "engine", "method", "converged", "warnings", "checkCount", "failedCount", "unverifiableCount" ] }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "planHash", "portfolioHash", "marketHash", "marketAsOf", "before", "after", "hypotheticalFills", "hypotheticalEvents", "estimates", "checks", "alerts", "decision", "unverifiable", "monitorState", "assumptions", "diagnostics", "contentHash" ] }, "approvedBy": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "number", "description": "Epoch ms" }, "now": { "type": "number", "description": "Epoch ms — the issue instant, the caller’s clock" }, "variance": { "type": "object", "properties": { "maximumQuantityRatio": { "type": "number", "minimum": 0 }, "maximumNotionalRatio": { "type": "number", "minimum": 0 }, "maximumSlippageBps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "maximumQuantityRatio", "maximumNotionalRatio", "maximumSlippageBps" ] }, "marketMaximumAgeMs": { "type": "number", "exclusiveMinimum": 0 }, "idempotencyKeys": { "anyOf": [ { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 1000 }, { "type": "object", "properties": { "prefix": { "type": "string", "minLength": 1 }, "count": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false, "required": [ "prefix", "count" ] } ] }, "portfolioHash": { "type": "string" }, "marketHash": { "type": "string" }, "account": { "type": "string" }, "grantId": { "type": "string" }, "createdTimestampMs": { "type": "integer", "description": "Epoch ms stamped on the stored grant’s handle — the caller’s clock" } }, "additionalProperties": false, "required": [ "plan", "preflight", "approvedBy", "expiresAt", "now", "variance", "marketMaximumAgeMs", "idempotencyKeys", "createdTimestampMs" ], "$id": "https://totalfinance.dev/schemas/trade.authorize.input", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "$ref": "#/$defs/Warnings" } }, "additionalProperties": false }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Before": { "type": "object", "properties": { "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "netAssetValue": { "type": "number" }, "cash": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "totalAmount": { "type": "number" }, "settledAmount": { "type": "number" }, "unsettledReceivable": { "type": "number" }, "unsettledPayable": { "type": "number" }, "baseCurrencyValue": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "currency", "totalAmount", "settledAmount", "unsettledReceivable", "unsettledPayable", "baseCurrencyValue" ] } }, "totalCashBaseCurrencyValue": { "type": "number" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quantity": { "type": "number" }, "markPricePerUnit": { "type": "number" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "marketValue": { "type": "number" }, "baseCurrencyMarketValue": { "type": "number" }, "notionalValue": { "type": "number" }, "baseCurrencyNotionalValue": { "type": "number" }, "costBasis": { "type": "number" }, "unrealizedPnl": { "type": "number" }, "baseCurrencyUnrealizedPnl": { "type": "number" }, "lotCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "currency", "quantity", "markPricePerUnit", "contractMultiplier", "settlementStyle", "marketValue", "baseCurrencyMarketValue", "notionalValue", "baseCurrencyNotionalValue", "costBasis", "unrealizedPnl", "baseCurrencyUnrealizedPnl", "lotCount" ] } }, "totalPositionsBaseCurrencyValue": { "type": "number" }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "marketAsOf": { "type": "number", "description": "Epoch milliseconds" }, "currencyConversionsUsed": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "valuationConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "lotRelief", "marketAsOf", "currencyConversionsUsed", "valuationConvention" ] }, "diagnostics": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string" } }, "accountCount": { "type": "integer", "minimum": 0 }, "positionCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "warnings", "accountCount", "positionCount" ] } }, "additionalProperties": false, "required": [ "asOf", "baseCurrency", "netAssetValue", "cash", "totalCashBaseCurrencyValue", "positions", "totalPositionsBaseCurrencyValue", "assumptions", "diagnostics" ] }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "Checks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "verdict": { "type": "string", "enum": [ "pass", "fail", "unverifiable", "require-approval" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] }, "detail": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "verdict", "value", "limit", "detail" ] } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "grant": { "type": "object", "properties": { "kind": { "const": "totalfinance.authorization-grant", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "grantId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "preflightHash": { "type": "string", "minLength": 1 }, "portfolioHash": { "type": "string", "minLength": 1 }, "marketHash": { "type": "string", "minLength": 1 }, "marketAsOf": { "type": "number", "description": "Epoch milliseconds" }, "marketMaximumAgeMs": { "type": "number", "exclusiveMinimum": 0 }, "mode": { "const": "paper", "type": "string" }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "orderIds": { "type": "array", "items": { "type": "string" } }, "comboIds": { "type": "array", "items": { "type": "string" } }, "variance": { "type": "object", "properties": { "maximumQuantityRatio": { "type": "number", "minimum": 0 }, "maximumNotionalRatio": { "type": "number", "minimum": 0 }, "maximumSlippageBps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "maximumQuantityRatio", "maximumNotionalRatio", "maximumSlippageBps" ] }, "issuedAt": { "type": "number", "description": "Epoch milliseconds" }, "expiresAt": { "type": "number", "description": "Epoch milliseconds" }, "approvedBy": { "type": "string", "minLength": 1 }, "requiredScope": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "idempotencyKeys": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 1000 }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "grantId", "planHash", "preflightHash", "portfolioHash", "marketHash", "marketAsOf", "marketMaximumAgeMs", "mode", "accountId", "baseCurrency", "orderIds", "comboIds", "variance", "issuedAt", "expiresAt", "approvedBy", "requiredScope", "idempotencyKeys", "contentHash" ] }, "handle": { "type": "object", "properties": { "uri": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "report", "job", "portfolio", "scenario", "market", "authorization", "journal" ] }, "schema": { "type": "string", "minLength": 1 }, "version": { "type": "string" }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "expiresTimestampMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "uri", "kind", "schema", "version", "contentHash", "createdTimestampMs", "expiresTimestampMs", "provenance" ] }, "requiredScope": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "grant", "handle", "requiredScope" ], "$id": "https://totalfinance.dev/schemas/trade.authorize.output" } ``` ### totalfinance.trade.cancel Cancel an open paper order Journal cancel-requested then cancelled for an open order in the journal store under `:journal`; a terminal order is not cancelled twice (accepted: false, the state says why). Cancelling a combo leg cancels all remaining legs of that plan-local combo. Both the original journal and authorization stores are required to recover pending submissions before cancellation; no new grant is needed. A fill delivered after the cancellation is Decision 6's late-fill path. Paper only; requires trade:paper. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `trade:paper`. Authorization: policy. Side effect: external-order. Idempotency: optional. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":false,"destructiveHint":true,"idempotentHint":false,"openWorldHint":true} Input JSON Schema: ```json { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "now": { "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "idempotencyKey": { "type": "string", "minLength": 1 }, "journal": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "journalId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number", "description": "Epoch milliseconds" }, "orderId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "idempotencyKey": { "type": "string", "minLength": 1 }, "sourceId": { "type": "string", "minLength": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "eventType": {}, "detail": {} }, "additionalProperties": false, "required": [ "eventId", "journalId", "timestampMs", "orderId", "planHash", "sourceId", "provenance", "eventType", "detail" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "proposed", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "preflighted", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "authorized", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "submitted", "type": "string" }, "detail": { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" }, "order": { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "orderId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0, "description": "Units/contracts, strictly positive; side carries direction" }, "plannedTimestampMs": { "type": "number", "description": "When the plan was made — never when a broker saw the order" }, "submittedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "orderId", "quantity", "plannedTimestampMs", "type" ] }, { "anyOf": [ { "properties": { "type": { "const": "market", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-open", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-close", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice" ], "not": { "anyOf": [ { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "stop", "type": "string" }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "stopPrice" ], "not": { "anyOf": [ { "required": [ "limitPrice" ] } ] } }, { "properties": { "type": { "const": "stop-limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice", "stopPrice" ] } ] } ] }, "instrument": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "contract": { "$ref": "#/$defs/Contract" }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "settlementLag": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" } ], "description": "T+n 24-hour days in the paper broker; default 0" } }, "additionalProperties": false, "required": [ "currency" ] }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "executionPolicyHash": { "type": "string", "minLength": 1 }, "comboId": { "type": "string", "minLength": 1 }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "quantity" ] } } }, { "properties": { "eventType": { "const": "acknowledged", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "partially-filled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail2" } } }, { "properties": { "eventType": { "const": "filled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail2" } } }, { "properties": { "eventType": { "const": "rejected", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "cancel-requested", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "cancelled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "replaced", "type": "string" }, "detail": { "type": "object", "properties": { "quantity": { "type": "number" }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string", "minLength": 1 }, "artifactHash": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false, "required": [ "replacementOrderId" ] } } }, { "properties": { "eventType": { "const": "expired", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "reconciled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "unresolved", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } } ] } ] }, "description": "Optional exact canonical snapshot of the persisted journal; checked inside the transaction. Never imports or replaces history. An execution-journal store is required." } }, "additionalProperties": false, "required": [ "orderId", "now", "sourceId", "accountId", "baseCurrency" ], "$id": "https://totalfinance.dev/schemas/trade.cancel.input", "$defs": { "Detail": { "type": "object", "properties": { "quantity": { "type": "number" }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "Detail2": { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fillId": { "type": "string", "minLength": 1 }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" }, "observationTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "fill": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "filledTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" }, "executionPriceAdjustment": { "type": "number", "minimum": 0 }, "costs": { "type": "object", "properties": { "commission": { "type": "number", "minimum": 0 }, "exchangeFees": { "type": "number", "minimum": 0 }, "regulatoryFees": { "type": "number", "minimum": 0 }, "slippageAdjustment": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "orderId": { "type": "string", "minLength": 1 }, "venue": { "type": "string" }, "liquidity": { "type": "string", "enum": [ "maker", "taker", "unknown" ] } }, "additionalProperties": false, "required": [ "fillId", "accountId", "instrumentId", "side", "quantity", "pricePerUnit", "currency", "filledTimestampMs" ] } }, "additionalProperties": false, "required": [ "quantity", "fillId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "orderId": { "type": "string" }, "accepted": { "type": "boolean" }, "state": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "submitted", "acknowledged", "partially-filled", "filled", "cancelled", "rejected", "expired", "unresolved" ] }, "submittedQuantity": { "type": "number", "minimum": 0 }, "filledQuantity": { "type": "number", "minimum": 0 }, "remainingQuantity": { "type": "number", "minimum": 0 }, "averageFillPrice": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fillIds": { "type": "array", "items": { "type": "string" } }, "lateFillIds": { "type": "array", "items": { "type": "string" } }, "lastEventId": { "type": "string", "minLength": 1 }, "lastTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "terminal": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "replacedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reconciledEventId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "orderId", "planHash", "state", "submittedQuantity", "filledQuantity", "remainingQuantity", "averageFillPrice", "fillIds", "lateFillIds", "lastEventId", "lastTimestampMs", "terminal", "cancelRequested", "reason", "replacedBy", "reconciledEventId" ] }, "journal": { "type": "object", "properties": { "journalId": { "type": "string", "minLength": 1 }, "appended": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "journalId", "appended", "total" ] } }, "additionalProperties": false, "required": [ "orderId", "accepted", "state", "journal" ], "$id": "https://totalfinance.dev/schemas/trade.cancel.output" } ``` ### totalfinance.trade.preflight Preflight a trade plan against the ledger, the market, and the policy Normalize an intent (or take an execution plan) and judge it: the portfolio before and after through the ledger's own fold of hypothetical fills, every policy check with its verdict, declared-rate cost estimates, the monitor's alerts on the after-state, and one decision — allow only when every check passes, deny on any failure, require-approval when evidence is missing; never an allow from missing information. No effect. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `trade:propose`. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `portfolio`, `market`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "plan": { "type": "object", "properties": { "kind": { "const": "totalfinance.execution-plan", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "accountId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "portfolioId": { "type": "string", "minLength": 1 }, "orders": { "type": "array", "items": { "$ref": "#/$defs/Orders" }, "minItems": 1, "maxItems": 1000 }, "combos": { "type": "array", "items": { "type": "object", "properties": { "comboId": { "type": "string", "minLength": 1 }, "orderIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 2, "description": "The legs, in plan order (at least two)" }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "comboId", "orderIds" ] } }, "trades": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "referencePricePerUnit": { "type": "number" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "estimatedNotional": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "side", "quantity", "currency", "referencePricePerUnit", "contractMultiplier", "estimatedNotional" ] } }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "intent", "type": "string" }, "intentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "intentHash" ] }, { "type": "object", "properties": { "kind": { "const": "rebalance-proposal", "type": "string" }, "planHash": { "type": "string", "minLength": 1 }, "policyContentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "planHash", "policyContentHash" ] } ] }, "rationale": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "accountId", "asOf", "baseCurrency", "orders", "combos", "trades", "source", "evidence", "contentHash" ] }, "intent": { "type": "object", "properties": { "kind": { "const": "totalfinance.trade-intent", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "accountId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "orders": { "type": "array", "items": { "anyOf": [ { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "quantity", "type" ] }, { "$ref": "#/$defs/Orders3" } ] }, { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "notionalWeight": { "type": "number", "maximum": 1, "exclusiveMinimum": 0, "description": "Notional as a fraction of NAV at the mark, (0, 1]; mutually exclusive with quantity" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "notionalWeight", "type" ] }, { "$ref": "#/$defs/Orders3" } ] } ] }, "minItems": 1, "maxItems": 1000 }, "combos": { "type": "array", "items": { "type": "object", "properties": { "comboId": { "type": "string", "minLength": 1 }, "netLimitPrice": { "type": "number", "description": "Net limit per combo unit: debit positive (pay at most), credit negative" } }, "additionalProperties": false, "required": [ "comboId" ] } }, "rationale": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "accountId", "asOf", "orders" ] }, "portfolio": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "provenance": { "$ref": "#/$defs/Provenance" } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ] }, { "type": "object", "properties": { "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "accounts": { "type": "object", "additionalProperties": { "type": "object", "properties": { "cashBalances": { "type": "object", "additionalProperties": { "type": "object", "properties": { "totalAmount": { "type": "number" }, "settlementSchedule": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "amount": { "type": "number" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventId", "amount", "settleTimestampMs" ] } } }, "additionalProperties": false, "required": [ "totalAmount", "settlementSchedule" ] } }, "positions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "quantity": { "type": "number" }, "lots": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "openedByEventId": { "type": "string", "minLength": 1 }, "openedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "quantity": { "type": "number" }, "costBasisPerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "lotId", "openedByEventId", "openedTimestampMs", "quantity", "costBasisPerUnit" ] } } }, "additionalProperties": false, "required": [ "instrumentId", "currency", "contractMultiplier", "settlementStyle", "quantity", "lots" ] } }, "realizedPnl": { "type": "object", "additionalProperties": { "type": "number" } }, "incomeReceived": { "type": "object", "additionalProperties": { "type": "number" } }, "transactionCosts": { "type": "object", "additionalProperties": { "type": "number" } }, "financingCosts": { "type": "object", "additionalProperties": { "type": "number" } }, "realizedPnlByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "incomeByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "transactionCostsByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } } }, "additionalProperties": false, "required": [ "cashBalances", "positions", "realizedPnl", "incomeReceived", "transactionCosts", "financingCosts", "realizedPnlByInstrument", "incomeByInstrument", "transactionCostsByInstrument" ] } }, "appliedEvents": { "type": "object", "additionalProperties": { "type": "string" } }, "eventCount": { "type": "integer", "minimum": 0 }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number", "description": "Epoch milliseconds" }, { "type": "null" } ] }, "lotSequence": { "type": "integer", "minimum": 0 }, "fillEffects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "openedLotIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "relievedQuantity": { "type": "number" }, "realizedPnl": { "type": "number" }, "cashDelta": { "type": "number" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "currency", "openedLotIds", "relievedQuantity", "realizedPnl", "cashDelta", "accruedInterest" ] } }, "reversals": { "type": "object", "additionalProperties": { "type": "string" } }, "accountMigrations": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventId", "fromAccountId", "toAccountId", "effectiveTimestampMs" ] } } }, "additionalProperties": false, "required": [ "schemaVersion", "baseCurrency", "lotRelief", "accounts", "appliedEvents", "eventCount", "lastEffectiveTimestampMs", "lotSequence", "fillEffects", "reversals", "accountMigrations" ] } ] }, { "type": "string", "pattern": "^totalfinance:\\/\\/portfolios\\/" } ] }, "market": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.market-snapshot", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "conventions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "asOfConvention": { "type": "string", "enum": [ "explicit-instant", "date-midnight-utc" ], "description": "How asOf was expressed at create time: an instant, or a bare date (00:00 UTC of that date — refused by option pricing)" }, "dayCount": { "type": "string", "enum": [ "ACT/365F", "ACT/360", "30/360" ] }, "compounding": { "anyOf": [ { "type": "string", "enum": [ "simple", "continuous", "annual", "semiannual", "quarterly", "monthly" ] }, { "$ref": "#/$defs/Compounding" } ] }, "calendar": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "asOfConvention" ] }, "observations": { "type": "object", "properties": { "spots": { "type": "object", "additionalProperties": { "type": "object", "properties": { "price": { "type": "number" }, "currency": { "type": "string" }, "timestampMs": { "type": "number" } }, "additionalProperties": true, "required": [ "price" ] } }, "riskFreeRates": { "type": "object", "additionalProperties": { "type": "number" } }, "dividendYields": { "type": "object", "additionalProperties": { "type": "number" } }, "volatilities": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0 } }, "curves": { "type": "object", "additionalProperties": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 1, "description": "Currency the curve discounts in (e.g. 'USD') — the curve states its own" }, "asOf": { "type": "number", "description": "Curve valuation instant (epoch ms); every pillar is at or after it" }, "dayCount": { "type": "string", "enum": [ "ACT/365F", "ACT/360", "30/360" ], "description": "Day-count convention the zero rates are quoted under" }, "compounding": { "anyOf": [ { "type": "string", "enum": [ "simple", "continuous", "annual", "semiannual", "quarterly", "monthly" ] }, { "$ref": "#/$defs/Compounding" } ], "description": "Interest compounding convention: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' or { type: 'periodic', periodsPerYear }" }, "points": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Pillar date, 'YYYY-MM-DD'" }, "zeroRate": { "type": "number", "description": "Decimal zero rate quoted under the curve's own compounding/dayCount" } }, "additionalProperties": true, "required": [ "date", "zeroRate" ] }, "description": "Pillar points — nonempty and strictly ascending by date (refused with teaching by the semantic validator)" }, "interpolation": { "type": "string", "description": "Interpolation-name string when present (e.g. 'linearZero')" } }, "additionalProperties": true, "required": [ "currency", "asOf", "dayCount", "compounding", "points" ], "description": "A stored RateCurve as plain data: { currency, asOf, dayCount, compounding, points: [{ date: 'YYYY-MM-DD', zeroRate }...], interpolation? } — structural shape above, semantics by core requireRateCurveData (nonempty strictly-ascending pillars at/after asOf, representable discount factors, open to vendor decoration)" } }, "surfaces": { "type": "object", "additionalProperties": { "type": "object", "properties": { "timeToExpiryYears": { "type": "array", "items": { "type": "number", "minimum": 0 } }, "strikes": { "type": "array", "items": { "type": "number", "exclusiveMinimum": 0 } }, "impliedVolatilities": { "type": "array", "items": { "type": "array", "items": { "type": "number", "minimum": 0 } } } }, "additionalProperties": false, "required": [ "timeToExpiryYears", "strikes", "impliedVolatilities" ] } }, "chains": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "quotes": { "type": "array", "items": { "type": "object", "properties": { "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number" }, "askSize": { "type": "number" }, "mid": { "type": "number" }, "last": { "type": "number" }, "mark": { "type": "number" }, "price": { "type": "number" }, "size": { "type": "number" }, "volume": { "type": "number" }, "openInterest": { "type": "number" }, "underlyingPrice": { "type": "number" }, "impliedVolatility": { "type": "number" }, "timestampMs": { "type": "number" }, "sequence": { "type": "number" }, "premium": { "type": "number" }, "notional": { "type": "number" } }, "additionalProperties": true } } }, "additionalProperties": false, "required": [ "quotes" ] }, { "type": "object", "properties": { "table": { "type": "object", "properties": { "kind": { "const": "totalfinance.table-handle", "type": "string" }, "contentHash": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0 }, "columnCount": { "type": "integer", "minimum": 0 }, "columns": { "type": "array", "items": { "type": "string" } }, "locator": { "type": "string" }, "mediaType": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "contentHash", "rowCount", "columnCount" ] } }, "additionalProperties": false, "required": [ "table" ] } ] } } }, "additionalProperties": false }, "provenance": { "$ref": "#/$defs/Provenance" } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "conventions", "observations" ] }, { "type": "string", "pattern": "^totalfinance:\\/\\/markets\\/" } ] }, "asOf": { "type": "number", "description": "Epoch ms — the instant the plan is judged at" }, "policy": { "type": "object", "properties": { "mode": { "const": "paper", "type": "string" }, "limits": { "type": "object", "properties": { "maximumPositionWeight": { "type": "number", "minimum": 0 }, "maximumGroupWeights": { "type": "array", "items": { "type": "object", "properties": { "group": { "anyOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "instrumentId" ] }, { "type": "object", "properties": { "sleeveId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "sleeveId" ] }, { "type": "object", "properties": { "assetClass": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "assetClass" ] }, { "type": "object", "properties": { "currency": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "currency" ] }, { "type": "object", "properties": { "tag": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "tag" ] }, { "type": "object", "properties": { "underlying": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "underlying" ] }, { "type": "object", "properties": { "strategy": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "strategy" ] } ] }, "maximumWeight": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "group", "maximumWeight" ] } }, "maximumGrossLeverage": { "type": "number", "exclusiveMinimum": 0 }, "maximumDrawdown": { "type": "number", "minimum": 0, "maximum": 1 }, "maximumDailyLoss": { "type": "number", "minimum": 0, "maximum": 1 }, "maximumDaysToLiquidate": { "type": "number", "exclusiveMinimum": 0 }, "minimumSettledCash": { "type": "number" } }, "additionalProperties": false }, "allowedAccounts": { "type": "array", "items": { "type": "string" } }, "allowedAssetClasses": { "type": "array", "items": { "type": "string" } }, "allowedInstruments": { "type": "array", "items": { "type": "string" } }, "allowedOrderTypes": { "type": "array", "items": { "type": "string", "enum": [ "market", "limit", "stop", "stop-limit", "market-on-open", "market-on-close" ] } }, "maximumOrderQuantity": { "type": "number", "exclusiveMinimum": 0 }, "maximumOrderNotional": { "type": "number", "exclusiveMinimum": 0 }, "maximumEstimatedCost": { "type": "number", "minimum": 0, "description": "Absolute base-currency estimated-cost ceiling; zero is a binding zero ceiling" }, "maximumSlippageBps": { "type": "number", "minimum": 0, "description": "Slippage ceiling in basis points; zero permits no positive estimated slippage" }, "maximumParticipation": { "type": "number", "maximum": 1, "exclusiveMinimum": 0 }, "allowUndefinedRiskOptions": { "type": "boolean", "description": "Default false: undefined-risk options are denied" }, "marketMaximumAgeMs": { "type": "number", "exclusiveMinimum": 0 }, "maximumTurnover": { "type": "number", "exclusiveMinimum": 0 }, "requireApprovalAbove": { "type": "object", "properties": { "notional": { "type": "number", "minimum": 0 }, "quantity": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "onUnverifiable": { "type": "string", "enum": [ "require-approval", "deny" ], "description": "Default require-approval; missing evidence never implies allow" } }, "additionalProperties": false, "required": [ "mode" ] }, "costs": { "type": "object", "properties": { "commissionBps": { "type": "number", "minimum": 0 }, "commissionPerOrder": { "type": "number", "minimum": 0 }, "spreadBps": { "type": "number", "minimum": 0 }, "slippageBps": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "instruments": { "type": "object", "additionalProperties": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "contract": { "$ref": "#/$defs/Contract" }, "assetClass": { "type": "string" } }, "additionalProperties": false, "required": [ "currency" ] } }, "session": { "type": "object", "properties": { "open": { "type": "boolean" }, "halted": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "open" ] }, "openOrders": { "type": "array", "items": { "$ref": "#/$defs/Orders" } }, "volumes": { "type": "object", "additionalProperties": { "type": "number", "minimum": 0 } } }, "additionalProperties": false, "required": [ "portfolio", "market", "asOf", "policy" ], "oneOf": [ { "required": [ "plan" ], "not": { "required": [ "intent" ] } }, { "required": [ "intent" ], "not": { "required": [ "plan" ] } } ], "$id": "https://totalfinance.dev/schemas/trade.preflight.input", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "$ref": "#/$defs/Provenance" }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Orders": { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "orderId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0, "description": "Units/contracts, strictly positive; side carries direction" }, "plannedTimestampMs": { "type": "number", "description": "When the plan was made — never when a broker saw the order" }, "submittedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "orderId", "quantity", "plannedTimestampMs", "type" ] }, { "$ref": "#/$defs/Orders3" } ] }, "Orders3": { "anyOf": [ { "properties": { "type": { "const": "market", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-open", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-close", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice" ], "not": { "anyOf": [ { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "stop", "type": "string" }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "stopPrice" ], "not": { "anyOf": [ { "required": [ "limitPrice" ] } ] } }, { "properties": { "type": { "const": "stop-limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice", "stopPrice" ] } ] }, "Provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "Compounding": { "type": "object", "properties": { "type": { "const": "periodic", "type": "string" }, "periodsPerYear": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": true, "required": [ "type", "periodsPerYear" ] }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "kind": { "const": "totalfinance.preflight-report", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "planHash": { "type": "string", "minLength": 1 }, "portfolioHash": { "type": "string", "minLength": 1 }, "marketHash": { "type": "string", "minLength": 1 }, "marketAsOf": { "type": "number", "description": "Epoch milliseconds" }, "before": { "$ref": "#/$defs/Before" }, "after": { "$ref": "#/$defs/Before" }, "hypotheticalFills": { "type": "array", "items": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "filledTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" }, "executionPriceAdjustment": { "type": "number", "minimum": 0 }, "costs": { "type": "object", "properties": { "commission": { "type": "number", "minimum": 0 }, "exchangeFees": { "type": "number", "minimum": 0 }, "regulatoryFees": { "type": "number", "minimum": 0 }, "slippageAdjustment": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "orderId": { "type": "string", "minLength": 1 }, "venue": { "type": "string" }, "liquidity": { "type": "string", "enum": [ "maker", "taker", "unknown" ] } }, "additionalProperties": false, "required": [ "fillId", "accountId", "instrumentId", "side", "quantity", "pricePerUnit", "currency", "filledTimestampMs" ] } }, "hypotheticalEvents": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "estimates": { "type": "object", "properties": { "tradedNotional": { "type": "number" }, "commission": { "type": "number" }, "spread": { "type": "number" }, "slippage": { "type": "number" }, "totalCost": { "type": "number" }, "turnover": { "type": "number" } }, "additionalProperties": false, "required": [ "tradedNotional", "commission", "spread", "slippage", "totalCost", "turnover" ] }, "checks": { "$ref": "#/$defs/Checks" }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1 }, "family": { "type": "string", "enum": [ "allocation-drift", "concentration-limit", "leverage-limit", "drawdown", "daily-loss", "cash-reserve", "margin-pressure", "liquidity", "option-expiration", "assignment-risk", "stale-market-data", "reconciliation-difference", "unexplained-residual", "unusual-pnl" ] }, "subject": { "type": "string" }, "severity": { "type": "string", "enum": [ "informational", "warning", "critical" ] }, "state": { "type": "string", "enum": [ "raised", "active", "acknowledged", "suppressed", "cleared" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "direction": { "type": "string", "enum": [ "above", "below" ] }, "message": { "type": "string" }, "evidence": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] } } }, "additionalProperties": false, "required": [ "key", "family", "subject", "severity", "state", "value", "threshold", "direction", "message", "evidence" ] } }, "decision": { "allOf": [ { "type": "object", "properties": { "verdict": {}, "checks": { "$ref": "#/$defs/Checks" }, "requiredScope": {} }, "additionalProperties": false, "required": [ "verdict", "checks" ] }, { "anyOf": [ { "properties": { "verdict": { "const": "allow", "type": "string" } }, "not": { "anyOf": [ { "required": [ "requiredScope" ] } ] } }, { "properties": { "verdict": { "const": "deny", "type": "string" } }, "not": { "anyOf": [ { "required": [ "requiredScope" ] } ] } }, { "properties": { "verdict": { "const": "require-approval", "type": "string" }, "requiredScope": { "type": "string", "minLength": 1 } }, "required": [ "requiredScope" ] } ] } ] }, "unverifiable": { "type": "array", "items": { "type": "string" } }, "monitorState": { "anyOf": [ { "type": "object", "properties": { "schemaVersion": { "const": 1, "type": "number" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "netAssetValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "peakNetAssetValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "evaluationCount": { "type": "integer", "minimum": 0 }, "rules": { "type": "object", "additionalProperties": { "type": "object", "properties": { "active": { "type": "boolean" }, "consecutiveBreaches": { "type": "integer", "minimum": 0 }, "lastRaisedAtMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "acknowledged": { "type": "boolean" }, "lastValue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "active", "consecutiveBreaches", "lastRaisedAtMs", "acknowledged", "lastValue" ] } } }, "additionalProperties": false, "required": [ "schemaVersion", "asOf", "netAssetValue", "peakNetAssetValue", "evaluationCount", "rules" ] }, { "type": "null" } ] }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "policyContentHash": { "type": "string" }, "mode": { "const": "paper", "type": "string" }, "costRates": { "type": "object", "properties": { "commissionBps": { "type": "number", "minimum": 0 }, "commissionPerOrder": { "type": "number", "minimum": 0 }, "spreadBps": { "type": "number", "minimum": 0 }, "slippageBps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "commissionBps", "commissionPerOrder", "spreadBps", "slippageBps" ] }, "fillConvention": { "type": "string" }, "instrumentSources": { "type": "object", "additionalProperties": { "type": "string" } }, "decisionConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "policyContentHash", "mode", "costRates", "fillConvention", "instrumentSources", "decisionConvention" ] }, "diagnostics": { "type": "object", "properties": { "engine": { "const": "trade-preflight", "type": "string" }, "method": { "const": "hypothetical-fold", "type": "string" }, "converged": { "const": true, "type": "boolean" }, "warnings": { "$ref": "#/$defs/Warnings" }, "checkCount": { "type": "integer", "minimum": 0 }, "failedCount": { "type": "integer", "minimum": 0 }, "unverifiableCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "engine", "method", "converged", "warnings", "checkCount", "failedCount", "unverifiableCount" ] }, "contentHash": { "type": "string", "minLength": 1 }, "plan": { "type": "object", "properties": { "kind": { "const": "totalfinance.execution-plan", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "accountId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "portfolioId": { "type": "string", "minLength": 1 }, "orders": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "orderId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0, "description": "Units/contracts, strictly positive; side carries direction" }, "plannedTimestampMs": { "type": "number", "description": "When the plan was made — never when a broker saw the order" }, "submittedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "orderId", "quantity", "plannedTimestampMs", "type" ] }, { "anyOf": [ { "properties": { "type": { "const": "market", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-open", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-close", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice" ], "not": { "anyOf": [ { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "stop", "type": "string" }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "stopPrice" ], "not": { "anyOf": [ { "required": [ "limitPrice" ] } ] } }, { "properties": { "type": { "const": "stop-limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice", "stopPrice" ] } ] } ] }, "minItems": 1, "maxItems": 1000 }, "combos": { "type": "array", "items": { "type": "object", "properties": { "comboId": { "type": "string", "minLength": 1 }, "orderIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 2, "description": "The legs, in plan order (at least two)" }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "comboId", "orderIds" ] } }, "trades": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "referencePricePerUnit": { "type": "number" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "estimatedNotional": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "side", "quantity", "currency", "referencePricePerUnit", "contractMultiplier", "estimatedNotional" ] } }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "intent", "type": "string" }, "intentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "intentHash" ] }, { "type": "object", "properties": { "kind": { "const": "rebalance-proposal", "type": "string" }, "planHash": { "type": "string", "minLength": 1 }, "policyContentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "planHash", "policyContentHash" ] } ] }, "rationale": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "accountId", "asOf", "baseCurrency", "orders", "combos", "trades", "source", "evidence", "contentHash" ] } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "planHash", "portfolioHash", "marketHash", "marketAsOf", "before", "after", "hypotheticalFills", "hypotheticalEvents", "estimates", "checks", "alerts", "decision", "unverifiable", "monitorState", "assumptions", "diagnostics", "contentHash", "plan" ], "$id": "https://totalfinance.dev/schemas/trade.preflight.output", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "$ref": "#/$defs/Warnings" } }, "additionalProperties": false }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Before": { "type": "object", "properties": { "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "netAssetValue": { "type": "number" }, "cash": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "totalAmount": { "type": "number" }, "settledAmount": { "type": "number" }, "unsettledReceivable": { "type": "number" }, "unsettledPayable": { "type": "number" }, "baseCurrencyValue": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "currency", "totalAmount", "settledAmount", "unsettledReceivable", "unsettledPayable", "baseCurrencyValue" ] } }, "totalCashBaseCurrencyValue": { "type": "number" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quantity": { "type": "number" }, "markPricePerUnit": { "type": "number" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "marketValue": { "type": "number" }, "baseCurrencyMarketValue": { "type": "number" }, "notionalValue": { "type": "number" }, "baseCurrencyNotionalValue": { "type": "number" }, "costBasis": { "type": "number" }, "unrealizedPnl": { "type": "number" }, "baseCurrencyUnrealizedPnl": { "type": "number" }, "lotCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "currency", "quantity", "markPricePerUnit", "contractMultiplier", "settlementStyle", "marketValue", "baseCurrencyMarketValue", "notionalValue", "baseCurrencyNotionalValue", "costBasis", "unrealizedPnl", "baseCurrencyUnrealizedPnl", "lotCount" ] } }, "totalPositionsBaseCurrencyValue": { "type": "number" }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "marketAsOf": { "type": "number", "description": "Epoch milliseconds" }, "currencyConversionsUsed": { "type": "array", "items": { "type": "object", "properties": { "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quoteCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "quotePerBase": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "baseCurrency", "quoteCurrency", "quotePerBase" ] } }, "valuationConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "lotRelief", "marketAsOf", "currencyConversionsUsed", "valuationConvention" ] }, "diagnostics": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string" } }, "accountCount": { "type": "integer", "minimum": 0 }, "positionCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "warnings", "accountCount", "positionCount" ] } }, "additionalProperties": false, "required": [ "asOf", "baseCurrency", "netAssetValue", "cash", "totalCashBaseCurrencyValue", "positions", "totalPositionsBaseCurrencyValue", "assumptions", "diagnostics" ] }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "Checks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "verdict": { "type": "string", "enum": [ "pass", "fail", "unverifiable", "require-approval" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] }, "detail": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "verdict", "value", "limit", "detail" ] } }, "Warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` ### totalfinance.trade.reconcile Reconcile an execution journal to the ledger Join the journal's order states (from the journal store by `journalId`, or inline events) to the ledger's fills under the execution source in both directions, compare delivered fill quantities per order within an explicit tolerance, list the unresolved orders, and — with an external snapshot — compose reconcilePortfolio verbatim. With planHash, exclude other plans’ journaled orders and fills from both joins; unattributed source fills remain discrepancies. External snapshots are judged over the whole portfolio. reconciled is true only when everything agrees and no order is unresolved. No effect; requires trade:paper. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `trade:paper`. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: `ledger`. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "journalId": { "type": "string", "minLength": 1 }, "journal": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "journalId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number", "description": "Epoch milliseconds" }, "orderId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "idempotencyKey": { "type": "string", "minLength": 1 }, "sourceId": { "type": "string", "minLength": 1 }, "provenance": { "$ref": "#/$defs/Provenance" }, "eventType": {}, "detail": {} }, "additionalProperties": false, "required": [ "eventId", "journalId", "timestampMs", "orderId", "planHash", "sourceId", "provenance", "eventType", "detail" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "proposed", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "preflighted", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "authorized", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "submitted", "type": "string" }, "detail": { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" }, "order": { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "orderId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0, "description": "Units/contracts, strictly positive; side carries direction" }, "plannedTimestampMs": { "type": "number", "description": "When the plan was made — never when a broker saw the order" }, "submittedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "orderId", "quantity", "plannedTimestampMs", "type" ] }, { "anyOf": [ { "properties": { "type": { "const": "market", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-open", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-close", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice" ], "not": { "anyOf": [ { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "stop", "type": "string" }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "stopPrice" ], "not": { "anyOf": [ { "required": [ "limitPrice" ] } ] } }, { "properties": { "type": { "const": "stop-limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice", "stopPrice" ] } ] } ] }, "instrument": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "contract": { "$ref": "#/$defs/Contract" }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "settlementLag": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" } ], "description": "T+n 24-hour days in the paper broker; default 0" } }, "additionalProperties": false, "required": [ "currency" ] }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "executionPolicyHash": { "type": "string", "minLength": 1 }, "comboId": { "type": "string", "minLength": 1 }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "quantity" ] } } }, { "properties": { "eventType": { "const": "acknowledged", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "partially-filled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail2" } } }, { "properties": { "eventType": { "const": "filled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail2" } } }, { "properties": { "eventType": { "const": "rejected", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "cancel-requested", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "cancelled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "replaced", "type": "string" }, "detail": { "type": "object", "properties": { "quantity": { "type": "number" }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string", "minLength": 1 }, "artifactHash": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false, "required": [ "replacementOrderId" ] } } }, { "properties": { "eventType": { "const": "expired", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "reconciled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "unresolved", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } } ] } ] } }, "ledger": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "totalfinance.portfolio-ledger", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "provenance": { "$ref": "#/$defs/Provenance" } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "baseCurrency", "lotRelief", "events" ] }, { "type": "object", "properties": { "schemaVersion": { "const": 1, "type": "number" }, "portfolioId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "accounts": { "type": "object", "additionalProperties": { "type": "object", "properties": { "cashBalances": { "type": "object", "additionalProperties": { "type": "object", "properties": { "totalAmount": { "type": "number" }, "settlementSchedule": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "amount": { "type": "number" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventId", "amount", "settleTimestampMs" ] } } }, "additionalProperties": false, "required": [ "totalAmount", "settlementSchedule" ] } }, "positions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "quantity": { "type": "number" }, "lots": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "openedByEventId": { "type": "string", "minLength": 1 }, "openedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "quantity": { "type": "number" }, "costBasisPerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "lotId", "openedByEventId", "openedTimestampMs", "quantity", "costBasisPerUnit" ] } } }, "additionalProperties": false, "required": [ "instrumentId", "currency", "contractMultiplier", "settlementStyle", "quantity", "lots" ] } }, "realizedPnl": { "type": "object", "additionalProperties": { "type": "number" } }, "incomeReceived": { "type": "object", "additionalProperties": { "type": "number" } }, "transactionCosts": { "type": "object", "additionalProperties": { "type": "number" } }, "financingCosts": { "type": "object", "additionalProperties": { "type": "number" } }, "realizedPnlByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "incomeByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } }, "transactionCostsByInstrument": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } } }, "additionalProperties": false, "required": [ "cashBalances", "positions", "realizedPnl", "incomeReceived", "transactionCosts", "financingCosts", "realizedPnlByInstrument", "incomeByInstrument", "transactionCostsByInstrument" ] } }, "appliedEvents": { "type": "object", "additionalProperties": { "type": "string" } }, "eventCount": { "type": "integer", "minimum": 0 }, "lastEffectiveTimestampMs": { "anyOf": [ { "type": "number", "description": "Epoch milliseconds" }, { "type": "null" } ] }, "lotSequence": { "type": "integer", "minimum": 0 }, "fillEffects": { "type": "object", "additionalProperties": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "openedLotIds": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "relievedQuantity": { "type": "number" }, "realizedPnl": { "type": "number" }, "cashDelta": { "type": "number" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "currency", "openedLotIds", "relievedQuantity", "realizedPnl", "cashDelta", "accruedInterest" ] } }, "reversals": { "type": "object", "additionalProperties": { "type": "string" } }, "accountMigrations": { "type": "array", "items": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventId", "fromAccountId", "toAccountId", "effectiveTimestampMs" ] } } }, "additionalProperties": false, "required": [ "schemaVersion", "baseCurrency", "lotRelief", "accounts", "appliedEvents", "eventCount", "lastEffectiveTimestampMs", "lotSequence", "fillEffects", "reversals", "accountMigrations" ] } ] }, { "type": "string", "pattern": "^totalfinance:\\/\\/portfolios\\/" } ] }, "sourceId": { "type": "string", "minLength": 1 }, "fills": { "type": "array", "items": { "$ref": "#/$defs/Fill" } }, "external": { "type": "object", "properties": { "asOf": { "anyOf": [ { "type": "number", "description": "Epoch milliseconds" }, { "type": "string" } ] }, "accounts": { "type": "object", "additionalProperties": { "type": "object", "properties": { "cash": { "type": "object", "additionalProperties": { "type": "object", "properties": { "total": { "type": "number" }, "settled": { "type": "number" } }, "additionalProperties": false, "required": [ "total" ] } }, "positions": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "costBasis": { "type": "number" } }, "additionalProperties": false, "required": [ "instrumentId", "quantity" ] } } }, "additionalProperties": false, "required": [ "cash", "positions" ] } }, "source": { "type": "string" } }, "additionalProperties": false, "required": [ "asOf", "accounts" ] }, "asOf": { "type": "number" }, "tolerance": { "type": "object", "properties": { "quantity": { "type": "number", "minimum": 0 }, "cashAmount": { "type": "number", "minimum": 0 }, "costBasis": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "quantity", "cashAmount" ] }, "planHash": { "type": "string" } }, "additionalProperties": false, "required": [ "ledger", "sourceId", "fills", "asOf", "tolerance" ], "oneOf": [ { "required": [ "journalId" ], "not": { "required": [ "journal" ] } }, { "required": [ "journal" ], "not": { "required": [ "journalId" ] } } ], "$id": "https://totalfinance.dev/schemas/trade.reconcile.input", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "$ref": "#/$defs/Provenance" }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "Detail": { "type": "object", "properties": { "quantity": { "type": "number" }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "Detail2": { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fillId": { "type": "string", "minLength": 1 }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" }, "observationTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "fill": { "$ref": "#/$defs/Fill" } }, "additionalProperties": false, "required": [ "quantity", "fillId" ] }, "Fill": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "filledTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" }, "executionPriceAdjustment": { "type": "number", "minimum": 0 }, "costs": { "type": "object", "properties": { "commission": { "type": "number", "minimum": 0 }, "exchangeFees": { "type": "number", "minimum": 0 }, "regulatoryFees": { "type": "number", "minimum": 0 }, "slippageAdjustment": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "orderId": { "type": "string", "minLength": 1 }, "venue": { "type": "string" }, "liquidity": { "type": "string", "enum": [ "maker", "taker", "unknown" ] } }, "additionalProperties": false, "required": [ "fillId", "accountId", "instrumentId", "side", "quantity", "pricePerUnit", "currency", "filledTimestampMs" ] }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "kind": { "const": "totalfinance.reconciliation-report", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "planHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "journalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sourceId": { "type": "string", "minLength": 1 }, "reconciled": { "type": "boolean" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "submitted", "acknowledged", "partially-filled", "filled", "cancelled", "rejected", "expired", "unresolved" ] }, "submittedQuantity": { "type": "number", "minimum": 0 }, "filledQuantity": { "type": "number", "minimum": 0 }, "remainingQuantity": { "type": "number", "minimum": 0 }, "averageFillPrice": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fillIds": { "type": "array", "items": { "type": "string" } }, "lateFillIds": { "type": "array", "items": { "type": "string" } }, "lastEventId": { "type": "string", "minLength": 1 }, "lastTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "terminal": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "replacedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reconciledEventId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "orderId", "planHash", "state", "submittedQuantity", "filledQuantity", "remainingQuantity", "averageFillPrice", "fillIds", "lateFillIds", "lastEventId", "lastTimestampMs", "terminal", "cancelRequested", "reason", "replacedBy", "reconciledEventId" ] } }, "orderChecks": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "submitted", "acknowledged", "partially-filled", "filled", "cancelled", "rejected", "expired", "unresolved" ] }, "journaledQuantity": { "type": "number" }, "fillQuantity": { "type": "number" }, "difference": { "type": "number" }, "withinTolerance": { "type": "boolean" } }, "additionalProperties": false, "required": [ "orderId", "state", "journaledQuantity", "fillQuantity", "difference", "withinTolerance" ] } }, "fills": { "type": "array", "items": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "orderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "quantity": { "type": "number" }, "journaled": { "type": "boolean" }, "inLedger": { "type": "boolean" }, "ledgerKey": { "type": "string" } }, "additionalProperties": false, "required": [ "fillId", "orderId", "quantity", "journaled", "inLedger", "ledgerKey" ] } }, "journaledNotInLedger": { "type": "array", "items": { "type": "string" } }, "ledgerNotJournaled": { "type": "array", "items": { "type": "string" } }, "unresolved": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "orderId", "reason" ] } }, "portfolio": { "anyOf": [ { "type": "object", "properties": { "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "reconciled": { "type": "boolean" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "presentInLedger": { "type": "boolean" }, "presentInExternal": { "type": "boolean" }, "cash": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "ledgerTotal": { "type": "number" }, "ledgerSettled": { "type": "number" }, "ledgerUnsettledReceivable": { "type": "number" }, "ledgerUnsettledPayable": { "type": "number" }, "externalTotal": { "type": "number" }, "externalSettled": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalDifference": { "type": "number" }, "settledDifference": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "withinTolerance": { "type": "boolean" }, "explanation": { "$ref": "#/$defs/Explanation" } }, "additionalProperties": false, "required": [ "currency", "ledgerTotal", "ledgerSettled", "ledgerUnsettledReceivable", "ledgerUnsettledPayable", "externalTotal", "externalSettled", "totalDifference", "settledDifference", "withinTolerance" ] } }, "positions": { "type": "array", "items": { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "matched", "quantity-difference", "missing-in-external", "extra-in-external" ] }, "ledgerQuantity": { "type": "number" }, "externalQuantity": { "type": "number" }, "quantityDifference": { "type": "number" }, "withinTolerance": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currencyMismatch": { "type": "object", "properties": { "ledger": { "type": "string" }, "external": { "type": "string" } }, "additionalProperties": false, "required": [ "ledger", "external" ] }, "costBasis": { "type": "object", "properties": { "ledger": { "type": "number" }, "external": { "type": "number" }, "difference": { "type": "number" }, "withinTolerance": { "type": "boolean" } }, "additionalProperties": false, "required": [ "ledger", "external", "difference", "withinTolerance" ] }, "explanation": { "$ref": "#/$defs/Explanation" } }, "additionalProperties": false, "required": [ "instrumentId", "kind", "ledgerQuantity", "externalQuantity", "quantityDifference", "withinTolerance", "currency" ] } } }, "additionalProperties": false, "required": [ "accountId", "presentInLedger", "presentInExternal", "cash", "positions" ] } }, "differenceCount": { "type": "integer", "minimum": 0 }, "explainedCount": { "type": "integer", "minimum": 0 }, "suggestedCorrections": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "undraftable": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "subject": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "accountId", "subject", "reason" ] } }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "lotRelief": { "type": "string", "enum": [ "fifo", "lifo", "highest-cost", "specific-lot" ] }, "tolerance": { "$ref": "#/$defs/Tolerance" }, "comparisonConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "lotRelief", "tolerance", "comparisonConvention" ] }, "diagnostics": { "type": "object", "properties": { "warnings": { "type": "array", "items": { "type": "string" } }, "ledgerAccountCount": { "type": "integer", "minimum": 0 }, "externalAccountCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "warnings", "ledgerAccountCount", "externalAccountCount" ] } }, "additionalProperties": false, "required": [ "asOf", "baseCurrency", "reconciled", "accounts", "differenceCount", "explainedCount", "suggestedCorrections", "undraftable", "assumptions", "diagnostics" ] }, { "type": "null" } ] }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "tolerance": { "$ref": "#/$defs/Tolerance" }, "matchConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "tolerance", "matchConvention" ] }, "diagnostics": { "type": "object", "properties": { "engine": { "const": "trade-reconciliation", "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } }, "orderCount": { "type": "integer", "minimum": 0 }, "openCount": { "type": "integer", "minimum": 0 }, "fillCount": { "type": "integer", "minimum": 0 }, "ledgerFillCount": { "type": "integer", "minimum": 0 }, "unresolvedCount": { "type": "integer", "minimum": 0 }, "differenceCount": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "engine", "warnings", "orderCount", "openCount", "fillCount", "ledgerFillCount", "unresolvedCount", "differenceCount" ] }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "asOf", "planHash", "journalId", "sourceId", "reconciled", "orders", "orderChecks", "fills", "journaledNotInLedger", "ledgerNotJournaled", "unresolved", "portfolio", "assumptions", "diagnostics", "contentHash" ], "$id": "https://totalfinance.dev/schemas/trade.reconcile.output", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Explanation": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "pending-settlement", "type": "string" }, "detail": { "type": "string" } }, "additionalProperties": false, "required": [ "kind", "detail" ] }, { "type": "object", "properties": { "kind": { "const": "corporate-action-candidate", "type": "string" }, "detail": { "type": "string" }, "ratio": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "detail", "ratio" ] } ] }, "Tolerance": { "type": "object", "properties": { "quantity": { "type": "number", "minimum": 0 }, "cashAmount": { "type": "number", "minimum": 0 }, "costBasis": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "quantity", "cashAmount", "costBasis" ] }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` ### totalfinance.trade.submit Submit an authorized plan to the paper broker Verify the grant against the plan, the portfolio and market hashes, the market instant, the account, and the idempotency key; journal submitted and acknowledged; return the content-addressed receipt — the SAME receipt for a retry with the same key and plan (no second order), trade.idempotency_conflict for the same key with another plan, trade.grant_expired for an expired grant. With `observations`, the open orders meet the market through the engines' own fill path. Top-level fills/events are only this call’s new deltas; the submission receipt is immutable. `currentOrders` is the authoritative journal-derived current state and cumulative filled/remaining quantities for this receipt. `recovery: { fills, events }` contains all persisted normalized fills and reproducible ledger envelopes for this receipt’s orders, including this call’s fills. Retry after a lost response and apply recovery.events with portfolio.record_events; identical events fold once. Recovery grows with later fills without replaying the fill engine. The journal continues transactionally from the required journal store under `:journal`; retries must retain that store and source. A grant atomically records its exact prepared submission before journal commit: a retry with the same key into the same store/journal recovers those events and reads the same receipt; any other submission of the grant is trade.grant_consumed. Every journal write recovers earlier pending submissions before allocating new identities. Inline history must match persisted history exactly. Inline grants must exist unchanged in the trusted authorization store. Paper only; requires trade:paper. Opt-in (tradePack). Version: 1; pack: trade; profiles: `full`; defaultEnabled: false; SDKonly: false. Required capabilities: `trade:paper`. Authorization: policy. Side effect: external-order. Idempotency: required. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":true} Input JSON Schema: ```json { "type": "object", "properties": { "plan": { "type": "object", "properties": { "kind": { "const": "totalfinance.execution-plan", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "accountId": { "type": "string", "minLength": 1 }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "portfolioId": { "type": "string", "minLength": 1 }, "orders": { "type": "array", "items": { "$ref": "#/$defs/Orders" }, "minItems": 1, "maxItems": 1000 }, "combos": { "type": "array", "items": { "type": "object", "properties": { "comboId": { "type": "string", "minLength": 1 }, "orderIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 2, "description": "The legs, in plan order (at least two)" }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "comboId", "orderIds" ] } }, "trades": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "referencePricePerUnit": { "type": "number" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "estimatedNotional": { "type": "number" } }, "additionalProperties": false, "required": [ "accountId", "instrumentId", "side", "quantity", "currency", "referencePricePerUnit", "contractMultiplier", "estimatedNotional" ] } }, "source": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "intent", "type": "string" }, "intentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "intentHash" ] }, { "type": "object", "properties": { "kind": { "const": "rebalance-proposal", "type": "string" }, "planHash": { "type": "string", "minLength": 1 }, "policyContentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "planHash", "policyContentHash" ] } ] }, "rationale": { "type": "string" }, "evidence": { "type": "array", "items": { "type": "string" } }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "accountId", "asOf", "baseCurrency", "orders", "combos", "trades", "source", "evidence", "contentHash" ] }, "grant": { "type": "object", "properties": { "kind": { "const": "totalfinance.authorization-grant", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "grantId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "preflightHash": { "type": "string", "minLength": 1 }, "portfolioHash": { "type": "string", "minLength": 1 }, "marketHash": { "type": "string", "minLength": 1 }, "marketAsOf": { "type": "number", "description": "Epoch milliseconds" }, "marketMaximumAgeMs": { "type": "number", "exclusiveMinimum": 0 }, "mode": { "const": "paper", "type": "string" }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "orderIds": { "type": "array", "items": { "type": "string" } }, "comboIds": { "type": "array", "items": { "type": "string" } }, "variance": { "type": "object", "properties": { "maximumQuantityRatio": { "type": "number", "minimum": 0 }, "maximumNotionalRatio": { "type": "number", "minimum": 0 }, "maximumSlippageBps": { "type": "number", "minimum": 0 } }, "additionalProperties": false, "required": [ "maximumQuantityRatio", "maximumNotionalRatio", "maximumSlippageBps" ] }, "issuedAt": { "type": "number", "description": "Epoch milliseconds" }, "expiresAt": { "type": "number", "description": "Epoch milliseconds" }, "approvedBy": { "type": "string", "minLength": 1 }, "requiredScope": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "idempotencyKeys": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "maxItems": 1000 }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "grantId", "planHash", "preflightHash", "portfolioHash", "marketHash", "marketAsOf", "marketMaximumAgeMs", "mode", "accountId", "baseCurrency", "orderIds", "comboIds", "variance", "issuedAt", "expiresAt", "approvedBy", "requiredScope", "idempotencyKeys", "contentHash" ] }, "grantHash": { "type": "string" }, "idempotencyKey": { "type": "string", "minLength": 1 }, "now": { "type": "number", "description": "Epoch ms — the submission instant" }, "portfolioHash": { "type": "string" }, "marketHash": { "type": "string" }, "marketAsOf": { "type": "number" }, "sourceId": { "type": "string", "minLength": 1, "description": "The execution source (`paper:` by convention); the journal id derives from it" }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instruments": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Instruments" } }, "orders": { "type": "array", "items": { "$ref": "#/$defs/Orders" } }, "journal": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "journalId": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number", "description": "Epoch milliseconds" }, "orderId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "idempotencyKey": { "type": "string", "minLength": 1 }, "sourceId": { "type": "string", "minLength": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "eventType": {}, "detail": {} }, "additionalProperties": false, "required": [ "eventId", "journalId", "timestampMs", "orderId", "planHash", "sourceId", "provenance", "eventType", "detail" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "proposed", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "preflighted", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "authorized", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "submitted", "type": "string" }, "detail": { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" }, "order": { "$ref": "#/$defs/Orders" }, "instrument": { "$ref": "#/$defs/Instruments" }, "accountId": { "type": "string", "minLength": 1 }, "baseCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "executionPolicyHash": { "type": "string", "minLength": 1 }, "comboId": { "type": "string", "minLength": 1 }, "netLimitPrice": { "type": "number" } }, "additionalProperties": false, "required": [ "quantity" ] } } }, { "properties": { "eventType": { "const": "acknowledged", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "partially-filled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail2" } } }, { "properties": { "eventType": { "const": "filled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail2" } } }, { "properties": { "eventType": { "const": "rejected", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "cancel-requested", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "cancelled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "replaced", "type": "string" }, "detail": { "type": "object", "properties": { "quantity": { "type": "number" }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string", "minLength": 1 }, "artifactHash": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false, "required": [ "replacementOrderId" ] } } }, { "properties": { "eventType": { "const": "expired", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "reconciled", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } }, { "properties": { "eventType": { "const": "unresolved", "type": "string" }, "detail": { "$ref": "#/$defs/Detail" } } } ] } ] }, "description": "Optional exact canonical snapshot of the persisted journal; checked inside the transaction. Never imports or replaces history. An execution-journal store is required." }, "observations": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "bar", "type": "string" }, "bar": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number", "minimum": 0 }, "vwap": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "open", "high", "low", "close" ] } }, "additionalProperties": false, "required": [ "kind", "bar" ] }, { "type": "object", "properties": { "kind": { "const": "quote", "type": "string" }, "quote": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "bid": { "type": "number" }, "ask": { "type": "number" }, "bidSize": { "type": "number", "minimum": 0 }, "askSize": { "type": "number", "minimum": 0 }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "bid", "ask" ] } }, "additionalProperties": false, "required": [ "kind", "quote" ] }, { "type": "object", "properties": { "kind": { "const": "trade", "type": "string" }, "trade": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "price": { "type": "number" }, "size": { "type": "number" }, "exchange": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "string" } }, "sequence": { "type": "number" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "price", "size" ] } }, "additionalProperties": false, "required": [ "kind", "trade" ] }, { "type": "object", "properties": { "kind": { "const": "order-book", "type": "string" }, "book": { "type": "object", "properties": { "symbol": { "type": "string", "minLength": 1 }, "timestampMs": { "type": "number" }, "bids": { "$ref": "#/$defs/Bids" }, "asks": { "$ref": "#/$defs/Bids" } }, "additionalProperties": false, "required": [ "symbol", "timestampMs", "bids", "asks" ] } }, "additionalProperties": false, "required": [ "kind", "book" ] } ] } }, "asOf": { "type": "number", "description": "Epoch ms — the instant the open orders meet the observations (default `now`)" } }, "additionalProperties": false, "required": [ "plan", "idempotencyKey", "now", "portfolioHash", "marketHash", "marketAsOf", "sourceId", "accountId", "baseCurrency" ], "anyOf": [ { "required": [ "grant" ] }, { "required": [ "grantHash" ] } ], "$id": "https://totalfinance.dev/schemas/trade.submit.input", "$defs": { "Orders": { "allOf": [ { "type": "object", "properties": { "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "timeInForce": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "comboId": { "type": "string", "minLength": 1, "description": "The multi-leg order this is a leg of (B5)" }, "orderId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0, "description": "Units/contracts, strictly positive; side carries direction" }, "plannedTimestampMs": { "type": "number", "description": "When the plan was made — never when a broker saw the order" }, "submittedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "type": {}, "limitPrice": {}, "stopPrice": {} }, "additionalProperties": false, "required": [ "instrumentId", "side", "orderId", "quantity", "plannedTimestampMs", "type" ] }, { "anyOf": [ { "properties": { "type": { "const": "market", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-open", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "market-on-close", "type": "string" } }, "not": { "anyOf": [ { "required": [ "limitPrice" ] }, { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice" ], "not": { "anyOf": [ { "required": [ "stopPrice" ] } ] } }, { "properties": { "type": { "const": "stop", "type": "string" }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "stopPrice" ], "not": { "anyOf": [ { "required": [ "limitPrice" ] } ] } }, { "properties": { "type": { "const": "stop-limit", "type": "string" }, "limitPrice": { "type": "number", "exclusiveMinimum": 0 }, "stopPrice": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "limitPrice", "stopPrice" ] } ] } ] }, "Instruments": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "contract": { "$ref": "#/$defs/Contract" }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "settlementLag": { "anyOf": [ { "const": 0, "type": "number" }, { "const": 1, "type": "number" }, { "const": 2, "type": "number" } ], "description": "T+n 24-hour days in the paper broker; default 0" } }, "additionalProperties": false, "required": [ "currency" ] }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "Detail": { "type": "object", "properties": { "quantity": { "type": "number" }, "fillId": { "type": "string" }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" } }, "additionalProperties": false }, "Detail2": { "type": "object", "properties": { "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fillId": { "type": "string", "minLength": 1 }, "pricePerUnit": { "type": "number" }, "reason": { "type": "string" }, "replacementOrderId": { "type": "string" }, "artifactHash": { "type": "string" }, "note": { "type": "string" }, "observationTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "fill": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "filledTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" }, "executionPriceAdjustment": { "type": "number", "minimum": 0 }, "costs": { "type": "object", "properties": { "commission": { "type": "number", "minimum": 0 }, "exchangeFees": { "type": "number", "minimum": 0 }, "regulatoryFees": { "type": "number", "minimum": 0 }, "slippageAdjustment": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "orderId": { "type": "string", "minLength": 1 }, "venue": { "type": "string" }, "liquidity": { "type": "string", "enum": [ "maker", "taker", "unknown" ] } }, "additionalProperties": false, "required": [ "fillId", "accountId", "instrumentId", "side", "quantity", "pricePerUnit", "currency", "filledTimestampMs" ] } }, "additionalProperties": false, "required": [ "quantity", "fillId" ] }, "Bids": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "number" }, "size": { "type": "number", "minimum": 0 }, "exchange": { "type": "string" } }, "additionalProperties": false, "required": [ "price", "size" ] } } } } ``` Output JSON Schema: ```json { "type": "object", "properties": { "receipt": { "type": "object", "properties": { "kind": { "const": "totalfinance.execution-receipt", "type": "string" }, "schemaVersion": { "const": 1, "type": "number" }, "receiptId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "grantHash": { "type": "string", "minLength": 1 }, "idempotencyKey": { "type": "string", "minLength": 1 }, "adapter": { "const": "paper", "type": "string" }, "accountId": { "type": "string", "minLength": 1 }, "sourceId": { "type": "string", "minLength": 1 }, "submittedAt": { "type": "number", "description": "Epoch milliseconds" }, "orders": { "type": "array", "items": { "$ref": "#/$defs/Orders" } }, "fills": { "$ref": "#/$defs/Fills" }, "journalEventIds": { "type": "array", "items": { "type": "string" } }, "assumptions": { "type": "object", "properties": { "conventionsVersion": { "type": "string" }, "mode": { "const": "paper", "type": "string" }, "execution": { "type": "object", "properties": { "label": { "type": "string" }, "realism": { "type": "string", "enum": [ "simplified", "declared" ] }, "observation": { "type": "string", "enum": [ "bar", "quote", "trade", "order-book" ] }, "fill": { "type": "object", "properties": { "label": { "type": "string" }, "version": { "type": "string" } }, "additionalProperties": false, "required": [ "label", "version" ] }, "ambiguity": { "type": "string", "enum": [ "optimistic", "pessimistic", "deterministic-path", "reject" ] }, "costs": { "type": "object", "properties": { "commission": { "type": "string" }, "slippage": { "type": "string" }, "spread": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "marketImpact": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latencySessions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "participation": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "borrow": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "commission", "slippage", "spread", "marketImpact", "latencySessions", "participation", "borrow" ] }, "staleQuotes": { "type": "object", "properties": { "maximumAgeMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "behavior": { "type": "string", "enum": [ "reject", "fill-at-last" ] } }, "additionalProperties": false, "required": [ "maximumAgeMs", "behavior" ] }, "lockedCrossed": { "type": "string", "enum": [ "reject", "fill-at-mid" ] }, "sessions": { "type": "object", "properties": { "halts": { "type": "integer", "minimum": 0 }, "priceLimits": { "type": "integer", "minimum": 0 }, "auction": { "anyOf": [ { "type": "string", "enum": [ "ignore", "open-close-only" ] }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "halts", "priceLimits", "auction" ] }, "partialFills": { "type": "string", "enum": [ "allow", "reject" ] }, "queue": { "type": "string", "enum": [ "none", "depth-approximation" ] }, "timeInForce": { "type": "object", "properties": { "default": { "type": "string", "enum": [ "day", "gtc" ], "description": "Default: the paper execution policy’s day time-in-force" }, "expireAtSessionClose": { "type": "boolean" } }, "additionalProperties": false, "required": [ "default", "expireAtSessionClose" ] }, "margin": { "type": "object", "properties": { "buyingPowerMultiplier": { "type": "number" }, "initialMarginRate": { "type": "number" }, "maintenanceMarginRate": { "type": "number" }, "forcedLiquidation": { "type": "string", "enum": [ "none", "close-largest-loss", "pro-rata" ] } }, "additionalProperties": false, "required": [ "buyingPowerMultiplier", "initialMarginRate", "maintenanceMarginRate", "forcedLiquidation" ] } }, "additionalProperties": false, "required": [ "label", "realism", "observation", "fill", "ambiguity", "costs", "staleQuotes", "lockedCrossed", "sessions", "partialFills", "queue", "timeInForce", "margin" ] }, "idempotencyConvention": { "type": "string" } }, "additionalProperties": false, "required": [ "conventionsVersion", "mode", "execution", "idempotencyConvention" ] }, "diagnostics": { "type": "object", "properties": { "engine": { "const": "paper-broker", "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } }, "orderCount": { "type": "integer", "minimum": 0 }, "retried": { "type": "boolean" } }, "additionalProperties": false, "required": [ "engine", "warnings", "orderCount", "retried" ] }, "contentHash": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "schemaVersion", "receiptId", "planHash", "grantHash", "idempotencyKey", "adapter", "accountId", "sourceId", "submittedAt", "orders", "fills", "journalEventIds", "assumptions", "diagnostics", "contentHash" ] }, "currentOrders": { "type": "array", "items": { "$ref": "#/$defs/Orders" }, "description": "Authoritative journal-derived state and cumulative fills for this receipt, distinct from the immutable submission receipt" }, "retried": { "type": "boolean" }, "fills": { "$ref": "#/$defs/Fills" }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } }, "recovery": { "type": "object", "properties": { "fills": { "$ref": "#/$defs/Fills" }, "events": { "type": "array", "items": { "$ref": "#/$defs/PortfolioEventEnvelope" } } }, "additionalProperties": false, "required": [ "fills", "events" ], "description": "Cumulative persisted fills and reproducible ledger events for this receipt; safe to apply idempotently after a lost response. Top-level fills/events remain new deltas." }, "journal": { "type": "object", "properties": { "journalId": { "type": "string", "minLength": 1 }, "appended": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "required": [ "journalId", "appended", "total" ] }, "open": { "type": "array", "items": { "type": "string" } }, "expired": { "type": "array", "items": { "type": "string" } }, "unfilled": { "type": "array", "items": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "enum": [ "not-triggered", "no-observation", "wrong-observation-kind", "stale-quote", "locked-crossed", "halted", "zero-quantity", "insufficient-depth", "already-observed" ] }, "detail": { "type": "string" } }, "additionalProperties": false, "required": [ "orderId", "reason", "detail" ] } } }, "additionalProperties": false, "required": [ "receipt", "currentOrders", "retried", "fills", "events", "recovery", "journal", "open", "expired", "unfilled" ], "$id": "https://totalfinance.dev/schemas/trade.submit.output", "$defs": { "PortfolioEventEnvelope": { "allOf": [ { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1 }, "schemaVersion": { "const": 1, "type": "number" }, "sourceId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "effectiveTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "recordedTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "correlationId": { "type": "string", "minLength": 1 }, "causationId": { "type": "string", "minLength": 1 }, "reversesEventId": { "type": "string", "minLength": 1 }, "provenance": { "type": "object", "properties": { "provider": { "type": "string" }, "dataset": { "type": "string" }, "asOf": { "type": "number", "description": "Epoch milliseconds" }, "receivedAt": { "type": "number", "description": "Epoch milliseconds" }, "sourceVersion": { "type": "string" }, "requestId": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string" }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ] }, "context": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "code", "message", "severity" ] } } }, "additionalProperties": false }, "eventType": {}, "event": {} }, "additionalProperties": false, "required": [ "eventId", "schemaVersion", "sourceId", "accountId", "effectiveTimestampMs", "recordedTimestampMs", "provenance", "eventType", "event" ] }, { "anyOf": [ { "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "event": { "$ref": "#/$defs/CashDeposit" } } }, { "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "event": { "$ref": "#/$defs/CashWithdrawal" } } }, { "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "event": { "$ref": "#/$defs/CashTransfer" } } }, { "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "event": { "$ref": "#/$defs/CashConversion" } } }, { "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "event": { "$ref": "#/$defs/TradeFill" } } }, { "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "event": { "$ref": "#/$defs/CostCharge" } } }, { "properties": { "eventType": { "const": "income.received", "type": "string" }, "event": { "$ref": "#/$defs/IncomeReceived" } } }, { "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "event": { "$ref": "#/$defs/FinancingCharge" } } }, { "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSplit" } } }, { "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExercise" } } }, { "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeAssignment" } } }, { "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeExpiration" } } }, { "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeMultiplierChange" } } }, { "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeVariationMargin" } } }, { "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "event": { "$ref": "#/$defs/DerivativeRoll" } } }, { "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "event": { "$ref": "#/$defs/FixedIncomeRedemption" } } }, { "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSymbolChange" } } }, { "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "event": { "$ref": "#/$defs/CorporateMerger" } } }, { "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "event": { "$ref": "#/$defs/CorporateSpinOff" } } }, { "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "event": { "$ref": "#/$defs/CorporateReturnOfCapital" } } }, { "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "event": { "$ref": "#/$defs/CorporateCashInLieu" } } }, { "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "event": { "$ref": "#/$defs/PositionTransfer" } } }, { "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.reversal", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.correction", "type": "string" }, "original": { "$ref": "#/$defs/PortfolioEventEnvelope" }, "replacement": { "anyOf": [ { "$ref": "#/$defs/CashDeposit" }, { "$ref": "#/$defs/CashWithdrawal" }, { "$ref": "#/$defs/CashTransfer" }, { "$ref": "#/$defs/CashConversion" }, { "$ref": "#/$defs/TradeFill" }, { "$ref": "#/$defs/CostCharge" }, { "$ref": "#/$defs/IncomeReceived" }, { "$ref": "#/$defs/FinancingCharge" }, { "$ref": "#/$defs/CorporateSplit" }, { "$ref": "#/$defs/DerivativeExercise" }, { "$ref": "#/$defs/DerivativeAssignment" }, { "$ref": "#/$defs/DerivativeExpiration" }, { "$ref": "#/$defs/DerivativeMultiplierChange" }, { "$ref": "#/$defs/DerivativeVariationMargin" }, { "$ref": "#/$defs/DerivativeRoll" }, { "$ref": "#/$defs/FixedIncomeRedemption" }, { "$ref": "#/$defs/CorporateSymbolChange" }, { "$ref": "#/$defs/CorporateMerger" }, { "$ref": "#/$defs/CorporateSpinOff" }, { "$ref": "#/$defs/CorporateReturnOfCapital" }, { "$ref": "#/$defs/CorporateCashInLieu" }, { "$ref": "#/$defs/PositionTransfer" } ] }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "original", "replacement" ] } }, "required": [ "reversesEventId" ] }, { "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "event": { "type": "object", "properties": { "eventType": { "const": "admin.account-migration", "type": "string" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "fromAccountId", "toAccountId" ] } } } ] } ] }, "Orders": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1 }, "planHash": { "type": "string", "minLength": 1 }, "state": { "type": "string", "enum": [ "submitted", "acknowledged", "partially-filled", "filled", "cancelled", "rejected", "expired", "unresolved" ] }, "submittedQuantity": { "type": "number", "minimum": 0 }, "filledQuantity": { "type": "number", "minimum": 0 }, "remainingQuantity": { "type": "number", "minimum": 0 }, "averageFillPrice": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fillIds": { "type": "array", "items": { "type": "string" } }, "lateFillIds": { "type": "array", "items": { "type": "string" } }, "lastEventId": { "type": "string", "minLength": 1 }, "lastTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "terminal": { "type": "boolean" }, "cancelRequested": { "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "replacedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reconciledEventId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false, "required": [ "orderId", "planHash", "state", "submittedQuantity", "filledQuantity", "remainingQuantity", "averageFillPrice", "fillIds", "lateFillIds", "lastEventId", "lastTimestampMs", "terminal", "cancelRequested", "reason", "replacedBy", "reconciledEventId" ] }, "Fills": { "type": "array", "items": { "type": "object", "properties": { "fillId": { "type": "string", "minLength": 1 }, "accountId": { "type": "string", "minLength": 1 }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "filledTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" }, "executionPriceAdjustment": { "type": "number", "minimum": 0 }, "costs": { "type": "object", "properties": { "commission": { "type": "number", "minimum": 0 }, "exchangeFees": { "type": "number", "minimum": 0 }, "regulatoryFees": { "type": "number", "minimum": 0 }, "slippageAdjustment": { "type": "number", "minimum": 0 } }, "additionalProperties": false }, "orderId": { "type": "string", "minLength": 1 }, "venue": { "type": "string" }, "liquidity": { "type": "string", "enum": [ "maker", "taker", "unknown" ] } }, "additionalProperties": false, "required": [ "fillId", "accountId", "instrumentId", "side", "quantity", "pricePerUnit", "currency", "filledTimestampMs" ] } }, "Contract": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "option", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "call", "put" ] }, "strikePricePerUnit": { "type": "number" }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "type", "strikePricePerUnit", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "future", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 }, "expiryTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId", "expiryTimestampMs" ] }, { "type": "object", "properties": { "kind": { "const": "perpetual", "type": "string" }, "underlyingInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "kind", "underlyingInstrumentId" ] } ] }, "CashDeposit": { "type": "object", "properties": { "eventType": { "const": "cash.deposit", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashWithdrawal": { "type": "object", "properties": { "eventType": { "const": "cash.withdrawal", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency" ] }, "CashTransfer": { "type": "object", "properties": { "eventType": { "const": "cash.transfer", "type": "string" }, "amount": { "type": "number", "exclusiveMinimum": 0 }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "amount", "currency", "fromAccountId", "toAccountId" ] }, "CashConversion": { "type": "object", "properties": { "eventType": { "const": "cash.conversion", "type": "string" }, "fromCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "toCurrency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "fromAmount": { "type": "number", "exclusiveMinimum": 0 }, "toAmount": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "fromCurrency", "toCurrency", "fromAmount", "toAmount" ] }, "TradeFill": { "type": "object", "properties": { "eventType": { "const": "trade.fill", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "buy", "sell" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" }, "contractMultiplier": { "type": "number", "exclusiveMinimum": 0 }, "settlementStyle": { "type": "string", "enum": [ "cash-on-trade", "variation-margin" ] }, "contract": { "$ref": "#/$defs/Contract" }, "accruedInterest": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "side", "quantity", "pricePerUnit", "currency" ] }, "LotSelections": { "type": "array", "items": { "type": "object", "properties": { "lotId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "lotId", "quantity" ] }, "minItems": 1 }, "CostCharge": { "type": "object", "properties": { "eventType": { "const": "cost.charge", "type": "string" }, "costType": { "type": "string", "enum": [ "commission", "exchange-fee", "regulatory-fee", "slippage-adjustment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "relatesToEventId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "costType", "amount", "currency" ] }, "IncomeReceived": { "type": "object", "properties": { "eventType": { "const": "income.received", "type": "string" }, "incomeType": { "type": "string", "enum": [ "dividend", "coupon", "interest", "staking-reward", "funding-receipt" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "incomeType", "amount", "currency" ] }, "FinancingCharge": { "type": "object", "properties": { "eventType": { "const": "financing.charge", "type": "string" }, "financingType": { "type": "string", "enum": [ "margin-interest", "borrow-charge", "funding-payment" ] }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "instrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "financingType", "amount", "currency" ] }, "CorporateSplit": { "type": "object", "properties": { "eventType": { "const": "corporate.split", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "sharesAfterSplit": { "type": "number", "exclusiveMinimum": 0 }, "sharesBeforeSplit": { "type": "number", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "sharesAfterSplit", "sharesBeforeSplit" ] }, "DerivativeExercise": { "type": "object", "properties": { "eventType": { "const": "derivative.exercise", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "Settlement": { "anyOf": [ { "type": "object", "properties": { "kind": { "const": "physical", "type": "string" } }, "additionalProperties": false, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "const": "cash", "type": "string" }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "kind", "settlementPricePerUnit" ] } ] }, "DerivativeAssignment": { "type": "object", "properties": { "eventType": { "const": "derivative.assignment", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "settlement": { "$ref": "#/$defs/Settlement" }, "premiumTreatment": { "type": "string", "enum": [ "fold-into-underlying-basis", "realize" ] }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "settlement", "premiumTreatment" ] }, "DerivativeExpiration": { "type": "object", "properties": { "eventType": { "const": "derivative.expiration", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity" ] }, "DerivativeMultiplierChange": { "type": "object", "properties": { "eventType": { "const": "derivative.multiplier-change", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "contractMultiplierAfter": { "type": "number", "exclusiveMinimum": 0 }, "strikePricePerUnitAfter": { "type": "number", "exclusiveMinimum": 0 }, "reason": { "type": "string" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "contractMultiplierAfter" ] }, "DerivativeVariationMargin": { "type": "object", "properties": { "eventType": { "const": "derivative.variation-margin", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "settlementPricePerUnit": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "settlementPricePerUnit" ] }, "DerivativeRoll": { "type": "object", "properties": { "eventType": { "const": "derivative.roll", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "closePricePerUnit": { "type": "number" }, "openPricePerUnit": { "type": "number" }, "contract": { "$ref": "#/$defs/Contract" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId", "quantity", "closePricePerUnit", "openPricePerUnit" ] }, "FixedIncomeRedemption": { "type": "object", "properties": { "eventType": { "const": "fixed-income.redemption", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "redemptionType": { "type": "string", "enum": [ "maturity", "call", "principal-paydown", "sinking-fund" ] }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "pricePerUnit": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "redemptionType", "quantity", "pricePerUnit", "currency" ] }, "CorporateSymbolChange": { "type": "object", "properties": { "eventType": { "const": "corporate.symbol-change", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId", "toInstrumentId" ] }, "CorporateMerger": { "type": "object", "properties": { "eventType": { "const": "corporate.merger", "type": "string" }, "fromInstrumentId": { "type": "string", "minLength": 1 }, "toInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerShare": { "type": "number", "exclusiveMinimum": 0 }, "cashPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "fromInstrumentId" ] }, "CorporateSpinOff": { "type": "object", "properties": { "eventType": { "const": "corporate.spin-off", "type": "string" }, "parentInstrumentId": { "type": "string", "minLength": 1 }, "childInstrumentId": { "type": "string", "minLength": 1 }, "sharesPerParentShare": { "type": "number", "exclusiveMinimum": 0 }, "basisAllocationFraction": { "type": "number" } }, "additionalProperties": false, "required": [ "eventType", "parentInstrumentId", "childInstrumentId", "sharesPerParentShare", "basisAllocationFraction" ] }, "CorporateReturnOfCapital": { "type": "object", "properties": { "eventType": { "const": "corporate.return-of-capital", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "amountPerShare": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "amountPerShare", "currency" ] }, "CorporateCashInLieu": { "type": "object", "properties": { "eventType": { "const": "corporate.cash-in-lieu", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "amount": { "type": "number" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "relatesToEventId": { "type": "string", "minLength": 1 }, "settleTimestampMs": { "type": "number", "description": "Epoch milliseconds" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "amount", "currency" ] }, "PositionTransfer": { "type": "object", "properties": { "eventType": { "const": "position.transfer", "type": "string" }, "instrumentId": { "type": "string", "minLength": 1 }, "quantity": { "type": "number", "exclusiveMinimum": 0 }, "fromAccountId": { "type": "string", "minLength": 1 }, "toAccountId": { "type": "string", "minLength": 1 }, "lotSelections": { "$ref": "#/$defs/LotSelections" } }, "additionalProperties": false, "required": [ "eventType", "instrumentId", "quantity", "fromAccountId", "toAccountId" ] } } } ``` ### totalfinance.valuation.company Value a company from its statements Project the three statements from explicit drivers, take the free cash flows the valuation basis needs, and discount them under the stated conventions (basis, date, currency, the REQUIRED discount rate, compounding, day count, the terminal value method, the enterprise-to-equity bridge). The result is discountedCashFlowFromStatements(...) verbatim — the projection with its balance-sheet reconciliation, the cash flows used, and the valuation — plus discountedCashFlowSensitivityTable(...) over the same flows when a sensitivity request is supplied. Opt-in (valuationPack). Version: 1; pack: valuation; profiles: `full`, `valuation`; defaultEnabled: false; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: medium. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "projection": { "type": "object", "properties": { "baseStatements": { "type": "object", "properties": { "income": { "type": "object", "properties": { "period": { "type": "object", "properties": { "periodStartDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "anyOf": [ { "const": 1, "type": "number" }, { "const": 2, "type": "number" }, { "const": 3, "type": "number" }, { "const": 4, "type": "number" } ] }, "periodType": { "type": "string", "enum": [ "quarter", "year", "trailing-twelve-months" ] }, "filedTimestampMs": { "type": "number" }, "availableTimestampMs": { "type": "number" }, "currency": { "type": "string", "minLength": 1 }, "monetaryScale": { "anyOf": [ { "const": 1, "type": "number" }, { "const": 1000, "type": "number" }, { "const": 1000000, "type": "number" } ] }, "form": { "type": "string" } }, "additionalProperties": false, "required": [ "periodEndDate", "fiscalYear", "periodType", "availableTimestampMs", "currency", "monetaryScale" ] }, "revenue": { "type": "number" }, "costOfRevenue": { "type": "number" }, "grossProfit": { "type": "number" }, "operatingExpenses": { "type": "number" }, "operatingIncome": { "type": "number" }, "interestExpense": { "type": "number" }, "incomeTaxExpense": { "type": "number" }, "netIncome": { "type": "number" }, "incomeFromContinuingOperations": { "type": "number" }, "sellingGeneralAdministrativeExpense": { "type": "number" }, "dilutedSharesOutstanding": { "type": "number" }, "metadata": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "period", "revenue", "operatingIncome", "netIncome" ] }, "balance": { "type": "object", "properties": { "period": { "type": "object", "properties": { "periodStartDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "anyOf": [ { "const": 1, "type": "number" }, { "const": 2, "type": "number" }, { "const": 3, "type": "number" }, { "const": 4, "type": "number" } ] }, "periodType": { "type": "string", "enum": [ "quarter", "year", "trailing-twelve-months" ] }, "filedTimestampMs": { "type": "number" }, "availableTimestampMs": { "type": "number" }, "currency": { "type": "string", "minLength": 1 }, "monetaryScale": { "anyOf": [ { "const": 1, "type": "number" }, { "const": 1000, "type": "number" }, { "const": 1000000, "type": "number" } ] }, "form": { "type": "string" } }, "additionalProperties": false, "required": [ "periodEndDate", "fiscalYear", "periodType", "availableTimestampMs", "currency", "monetaryScale" ] }, "cashAndCashEquivalents": { "type": "number" }, "shortTermInvestments": { "type": "number" }, "accountsReceivable": { "type": "number" }, "inventory": { "type": "number" }, "currentAssets": { "type": "number" }, "propertyPlantEquipmentNet": { "type": "number" }, "otherAssets": { "type": "number" }, "totalAssets": { "type": "number" }, "currentLiabilities": { "type": "number" }, "accountsPayable": { "type": "number" }, "shortTermDebt": { "type": "number" }, "longTermDebt": { "type": "number" }, "otherLiabilities": { "type": "number" }, "totalDebt": { "type": "number" }, "totalLiabilities": { "type": "number" }, "preferredEquity": { "type": "number" }, "minorityInterest": { "type": "number" }, "totalEquity": { "type": "number" }, "metadata": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "period", "cashAndCashEquivalents", "totalAssets", "totalLiabilities", "totalEquity" ] }, "cashFlow": { "type": "object", "properties": { "period": { "type": "object", "properties": { "periodStartDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "anyOf": [ { "const": 1, "type": "number" }, { "const": 2, "type": "number" }, { "const": 3, "type": "number" }, { "const": 4, "type": "number" } ] }, "periodType": { "type": "string", "enum": [ "quarter", "year", "trailing-twelve-months" ] }, "filedTimestampMs": { "type": "number" }, "availableTimestampMs": { "type": "number" }, "currency": { "type": "string", "minLength": 1 }, "monetaryScale": { "anyOf": [ { "const": 1, "type": "number" }, { "const": 1000, "type": "number" }, { "const": 1000000, "type": "number" } ] }, "form": { "type": "string" } }, "additionalProperties": false, "required": [ "periodEndDate", "fiscalYear", "periodType", "availableTimestampMs", "currency", "monetaryScale" ] }, "operatingCashFlow": { "type": "number" }, "investingCashFlow": { "type": "number" }, "financingCashFlow": { "type": "number" }, "capitalExpenditure": { "type": "number" }, "depreciationAndAmortization": { "type": "number" }, "stockBasedCompensation": { "type": "number" }, "acquisitions": { "type": "number" }, "dividendsPaid": { "type": "number" }, "shareRepurchases": { "type": "number" }, "increaseInNetWorkingCapital": { "type": "number" }, "netChangeInCash": { "type": "number" }, "metadata": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false, "required": [ "period", "operatingCashFlow", "investingCashFlow", "financingCashFlow" ] } }, "additionalProperties": false, "required": [ "income", "balance", "cashFlow" ], "description": "The typed historical base (one period of the three statements) the projection rolls forward" }, "periods": { "type": "array", "items": { "type": "object", "properties": { "periodLabel": { "type": "string", "minLength": 1 }, "revenue": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "number" } }, "additionalProperties": false, "required": [ "amount" ] }, { "type": "object", "properties": { "growthRate": { "type": "number" } }, "additionalProperties": false, "required": [ "growthRate" ] } ] }, "operatingMargin": { "type": "number" }, "taxRate": { "type": "number" }, "interestExpense": { "type": "number" }, "depreciationAndAmortization": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "number" } }, "additionalProperties": false, "required": [ "amount" ] }, { "type": "object", "properties": { "fractionOfRevenue": { "type": "number" } }, "additionalProperties": false, "required": [ "fractionOfRevenue" ] } ] }, "capitalExpenditure": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "number" } }, "additionalProperties": false, "required": [ "amount" ] }, { "type": "object", "properties": { "fractionOfRevenue": { "type": "number" } }, "additionalProperties": false, "required": [ "fractionOfRevenue" ] } ] }, "accountsReceivable": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "number" } }, "additionalProperties": false, "required": [ "amount" ] }, { "type": "object", "properties": { "fractionOfRevenue": { "type": "number" } }, "additionalProperties": false, "required": [ "fractionOfRevenue" ] } ] }, "inventory": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "number" } }, "additionalProperties": false, "required": [ "amount" ] }, { "type": "object", "properties": { "fractionOfRevenue": { "type": "number" } }, "additionalProperties": false, "required": [ "fractionOfRevenue" ] } ] }, "accountsPayable": { "anyOf": [ { "type": "object", "properties": { "amount": { "type": "number" } }, "additionalProperties": false, "required": [ "amount" ] }, { "type": "object", "properties": { "fractionOfRevenue": { "type": "number" } }, "additionalProperties": false, "required": [ "fractionOfRevenue" ] } ] }, "netBorrowing": { "type": "number" }, "dividendsPaid": { "type": "number" } }, "additionalProperties": false, "required": [ "periodLabel", "revenue", "operatingMargin", "taxRate", "interestExpense", "depreciationAndAmortization", "capitalExpenditure", "accountsReceivable", "inventory", "accountsPayable", "netBorrowing", "dividendsPaid" ] }, "minItems": 1 } }, "additionalProperties": false, "required": [ "baseStatements", "periods" ] }, "valuation": { "type": "object", "properties": { "valuationBasis": { "type": "string", "enum": [ "firm", "equity" ] }, "valuationDate": { "type": "string", "format": "date" }, "currency": { "type": "string", "minLength": 1 }, "annualDiscountRate": { "type": "number", "description": "REQUIRED and explicit — a discount rate is a goal, never a default (FC0)" }, "compounding": { "anyOf": [ { "type": "string", "enum": [ "simple", "continuous", "annual", "semiannual", "quarterly", "monthly" ] }, { "type": "object", "properties": { "type": { "const": "periodic", "type": "string" }, "periodsPerYear": { "type": "integer", "exclusiveMinimum": 0 } }, "additionalProperties": false, "required": [ "type", "periodsPerYear" ] } ] }, "dayCount": { "type": "string", "enum": [ "ACT/365F", "ACT/360", "30/360" ] }, "terminalValueMethod": { "anyOf": [ { "type": "object", "properties": { "method": { "const": "perpetual-growth", "type": "string" }, "terminalCashFlow": { "type": "number" }, "perpetualGrowthRate": { "type": "number" } }, "additionalProperties": false, "required": [ "method", "terminalCashFlow", "perpetualGrowthRate" ] }, { "type": "object", "properties": { "method": { "const": "exit-multiple", "type": "string" }, "terminalMetricAmount": { "type": "number" }, "exitMultiple": { "type": "number" } }, "additionalProperties": false, "required": [ "method", "terminalMetricAmount", "exitMultiple" ] } ] }, "enterpriseToEquityBridge": { "type": "object", "properties": { "cashAndCashEquivalents": { "type": "number" }, "totalDebt": { "type": "number" }, "preferredEquity": { "type": "number" }, "minorityInterest": { "type": "number" }, "nonOperatingAssets": { "type": "number" } }, "additionalProperties": false, "required": [ "cashAndCashEquivalents", "totalDebt", "preferredEquity", "minorityInterest", "nonOperatingAssets" ] }, "dilutedSharesOutstanding": { "type": "number", "exclusiveMinimum": 0 }, "provenance": { "type": "object", "properties": { "forecastIdentity": { "type": "string" }, "statementIdentity": { "type": "string" }, "restatementIdentity": { "type": "string" }, "source": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "valuationBasis", "valuationDate", "currency", "annualDiscountRate", "compounding", "terminalValueMethod" ], "description": "discountedCashFlow's conventions, minus the projected flows the projection supplies" }, "sensitivity": { "type": "object", "properties": { "rowAxis": { "type": "object", "properties": { "variable": { "type": "string", "enum": [ "annual-discount-rate", "perpetual-growth-rate", "exit-multiple" ] }, "values": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "additionalProperties": false, "required": [ "variable", "values" ] }, "columnAxis": { "type": "object", "properties": { "variable": { "type": "string", "enum": [ "annual-discount-rate", "perpetual-growth-rate", "exit-multiple" ] }, "values": { "type": "array", "items": { "type": "number" }, "minItems": 1 } }, "additionalProperties": false, "required": [ "variable", "values" ] } }, "additionalProperties": false, "required": [ "rowAxis", "columnAxis" ], "description": "Adds discountedCashFlowSensitivityTable over the same flows when supplied" } }, "additionalProperties": false, "required": [ "projection", "valuation" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "projection": { "type": "object", "description": "projectFinancialStatements(...) verbatim" }, "cashFlowsUsed": { "type": "string", "enum": [ "freeCashFlowToFirm", "freeCashFlowToEquity" ] }, "valuation": { "type": "object", "description": "discountedCashFlow(...) verbatim" }, "sensitivity": { "type": [ "object", "null" ], "description": "discountedCashFlowSensitivityTable(...) verbatim, or null when not requested" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "projection", "cashFlowsUsed", "valuation", "sensitivity", "assumptions", "diagnostics" ] } ``` ### totalfinance.volatility.event Event-volatility decomposition (earnings) Decompose pre-event implied volatility into base + event variance and the implied one-day event move (the earnings-move read): eventMove = √max(0, atmVolatility²·timeToExpiryYears − baseVolatility²·timeToExpiryYears). Optionally reports the variance risk premium when `realizedVolatility` is supplied. Version: 1; pack: volatility; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "atmVolatility": { "type": "number", "exclusiveMinimum": 0, "description": "Total ATM implied volatility into the event (decimal)" }, "baseVolatility": { "type": "number", "description": "Baseline (non-event) vol, e.g. post-event or far-month IV (decimal, ≥ 0)" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years, e.g. 5/365" }, "realizedVolatility": { "type": "number", "exclusiveMinimum": 0, "description": "ANNUALIZED realized volatility (decimal, e.g. 0.18 — a per-bar σ × √252 on daily bars) — adds the variance risk premium" } }, "additionalProperties": false, "required": [ "atmVolatility", "baseVolatility", "timeToExpiryYears" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.volatility.expected_move Expected move (1σ) Compute the expected 1-sigma move of the underlying by expiry — the lognormal ±1σ band and the expected absolute move. Provide `impliedVolatility` + `timeToExpiryYears` to imply it from volatility, or `straddlePrice` to imply it from the ATM straddle. Risk-neutral, not a directional forecast. Version: 1; pack: volatility; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "spot": { "type": "number", "exclusiveMinimum": 0 }, "impliedVolatility": { "type": "number", "exclusiveMinimum": 0, "description": "Implied volatility (annualized decimal); with `timeToExpiryYears`, the 1σ move is spot·σ·√timeToExpiryYears" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years (required with `impliedVolatility`)" }, "straddlePrice": { "type": "number", "exclusiveMinimum": 0, "description": "ATM straddle mid-price; when given, the move is implied from the straddle instead of IV" } }, "additionalProperties": false, "required": [ "spot" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "type": "object", "properties": { "oneSigma": { "type": "number" }, "oneSigmaFraction": { "type": "number" }, "expectedAbsolute": { "type": "number" }, "lower": { "type": "number" }, "upper": { "type": "number" } }, "required": [ "oneSigma", "oneSigmaFraction", "expectedAbsolute", "lower", "upper" ] }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "value" ] } ``` ### totalfinance.volatility.metrics IV rank / percentile / stats Where does the current implied volatility sit against its history? Returns IV rank (min–max position, 0–100), IV percentile (share of history below current, 0–100), and summary statistics — the standard "is IV high?" read before selling or buying premium. Version: 1; pack: volatility; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "current": { "type": "number", "exclusiveMinimum": 0, "description": "Current implied volatility (decimal, e.g. 0.22)" }, "history": { "type": "array", "items": { "type": "number", "exclusiveMinimum": 0 }, "description": "Historical IV series (decimals), e.g. 252 daily ATM IVs" } }, "additionalProperties": false, "required": [ "current", "history" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "description": "The computed result" }, "assumptions": { "type": "object", "description": "Every applied convention, echoed" }, "diagnostics": { "type": "object", "description": "Engine/method/warnings (+ convergence where iterative)" } }, "required": [ "value", "assumptions", "diagnostics" ] } ``` ### totalfinance.volatility.probability_in_the_money Probability of finishing in-the-money Risk-neutral probability that an option finishes in the money at expiry — N(d2) for a call, N(−d2) for a put. This is the model probability P(S_t ⋛ K), not a real-world forecast. Version: 1; pack: volatility; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "type": { "type": "string", "enum": [ "call", "put" ] }, "spot": { "type": "number", "exclusiveMinimum": 0 }, "strike": { "type": "number", "exclusiveMinimum": 0 }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "volatility": { "type": "number", "exclusiveMinimum": 0, "description": "Implied volatility (annualized decimal)" }, "dividendYield": { "type": "number" } }, "additionalProperties": false, "required": [ "type", "spot", "strike", "timeToExpiryYears", "riskFreeRate", "volatility" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "type": "number", "description": "Risk-neutral probability in [0, 1]" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "value" ] } ``` ### totalfinance.volatility.probability_of_touch Probability of touching a level Risk-neutral probability that the underlying TOUCHES `barrier` at any time before expiry (first-passage probability for geometric Brownian motion). Useful for stop/target and one-touch reasoning. Version: 1; pack: volatility; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "spot": { "type": "number", "exclusiveMinimum": 0 }, "barrier": { "type": "number", "exclusiveMinimum": 0, "description": "The price level to touch" }, "timeToExpiryYears": { "type": "number", "exclusiveMinimum": 0, "description": "Time to expiry in years" }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "volatility": { "type": "number", "exclusiveMinimum": 0, "description": "Implied volatility (annualized decimal)" }, "dividendYield": { "type": "number" } }, "additionalProperties": false, "required": [ "spot", "barrier", "timeToExpiryYears", "riskFreeRate", "volatility" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "value": { "type": "number", "description": "Risk-neutral probability in [0, 1]" }, "assumptions": { "type": "object", "description": "Applied conventions" }, "diagnostics": { "type": "object", "description": "Engine, method, warnings" } }, "required": [ "value" ] } ``` ### totalfinance.volatility.surface Fit an implied-vol surface Fit an implied-volatility surface from chain quotes (IV given directly, or implied from price) and return the surface rows, per-expiry ATM term structure, and the static-arbitrage report (calendar/butterfly violations). The surface never fabricates: non-convergence and extrapolation are reported in diagnostics/warnings. Version: 1; pack: volatility; profiles: `default`, `full`, `options`, `strategies`; defaultEnabled: true; SDKonly: false. Required capabilities: none. Authorization: none. Side effect: none. Idempotency: not-applicable. Handle fields: none. Cost: small. Cancellation supported: false. Deterministic: true. Stochastic: false. Annotations: {"readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false} Input JSON Schema: ```json { "type": "object", "properties": { "chain": { "type": "array", "items": { "type": "object", "properties": { "strike": { "type": "number", "exclusiveMinimum": 0 }, "expiry": { "type": "string", "description": "ISO date YYYY-MM-DD" }, "type": { "type": "string", "enum": [ "call", "put" ] }, "impliedVolatility": { "type": "number", "exclusiveMinimum": 0, "description": "Implied volatility (decimal, e.g. 0.22)" }, "price": { "type": "number", "exclusiveMinimum": 0, "description": "Option mid price (used to imply IV when `impliedVolatility` omitted)" } }, "additionalProperties": false, "required": [ "strike", "expiry", "type" ] }, "description": "Chain quotes: one row per contract" }, "spot": { "type": "number", "exclusiveMinimum": 0 }, "riskFreeRate": { "type": "number", "description": "Continuously-compounded risk-free rate (decimal)" }, "asOf": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "Valuation instant — epoch ms or a zoned ISO datetime such as \"2026-07-20T10:30:00-04:00\". A bare YYYY-MM-DD is refused: a same-day option's value depends on the time of day. For an end-of-day mark use the 16:00 ET close (13:00 ET on early-close days)." }, "dividendYield": { "type": "number", "description": "Continuous dividend yield (decimal)" }, "model": { "type": "string", "enum": [ "interpolated", "raw", "smoothed", "svi", "sabr" ], "description": "Surface model (default interpolated PCHIP; svi/sabr fit parametric smiles)" }, "underlying": { "type": "string", "description": "Ticker of the chain — REQUIRED, it names every contract" }, "style": { "type": "string", "enum": [ "american", "european" ], "description": "Exercise style of every contract in the chain — REQUIRED (listed US equity options are 'american'); the library never defaults it" } }, "additionalProperties": false, "required": [ "chain", "spot", "riskFreeRate", "asOf", "underlying", "style" ] } ``` Output JSON Schema: ```json { "type": "object", "properties": { "rows": { "type": "array", "description": "Surface grid rows (expiry × strike × impliedVolatility)" }, "expiries": { "type": "array", "items": { "type": "string" } }, "arbitrage": { "type": "object", "description": "Static-arbitrage report (violations list)" }, "assumptions": { "type": "object" }, "diagnostics": { "type": "object" } }, "required": [ "rows", "expiries", "arbitrage", "assumptions", "diagnostics" ] } ``` ## Packages and public API Every import path has its own export identity. Repeated declarations refer to an identical documented declaration. Type-only declarations are not callable JavaScript values. Named member types refer to the corresponding declarations in this catalog. Member lists have no count cap. Namespaces and callable companions expand; requests and returned artifacts expose their fields and method signatures. Named exported contracts use their own declarations rather than recursively duplicating every method-return graph; non-exported data shapes expand until a recursive type reference. ## Package @insiderfinance/totalfinance Version: 0.1.5; stability: pre-1.0; component maturity varies (see stability policy). Complete, tree-shakeable TypeScript finance: options, portfolios, risk, valuation, technical analysis, backtesting, and agent workflows. Entrypoints: `@insiderfinance/totalfinance`, `@insiderfinance/totalfinance/backtest`, `@insiderfinance/totalfinance/backtest/artifacts`, `@insiderfinance/totalfinance/backtest/costs`, `@insiderfinance/totalfinance/backtest/cross-sectional`, `@insiderfinance/totalfinance/backtest/environment`, `@insiderfinance/totalfinance/backtest/event-driven`, `@insiderfinance/totalfinance/backtest/execution`, `@insiderfinance/totalfinance/backtest/options`, `@insiderfinance/totalfinance/backtest/paper`, `@insiderfinance/totalfinance/backtest/portfolio`, `@insiderfinance/totalfinance/backtest/tearsheet`, `@insiderfinance/totalfinance/backtest/vectorized`, `@insiderfinance/totalfinance/calendars`, `@insiderfinance/totalfinance/calendars/cboe`, `@insiderfinance/totalfinance/calendars/crypto`, `@insiderfinance/totalfinance/calendars/nyse`, `@insiderfinance/totalfinance/cli`, `@insiderfinance/totalfinance/commodities`, `@insiderfinance/totalfinance/commodities/forwards`, `@insiderfinance/totalfinance/commodities/term-structure`, `@insiderfinance/totalfinance/core`, `@insiderfinance/totalfinance/core/artifacts`, `@insiderfinance/totalfinance/core/data`, `@insiderfinance/totalfinance/core/data-conformance`, `@insiderfinance/totalfinance/core/pricing`, `@insiderfinance/totalfinance/core/schema`, `@insiderfinance/totalfinance/crypto`, `@insiderfinance/totalfinance/crypto/carry`, `@insiderfinance/totalfinance/crypto/curve`, `@insiderfinance/totalfinance/crypto/inverse`, `@insiderfinance/totalfinance/crypto/liquidation`, `@insiderfinance/totalfinance/data`, `@insiderfinance/totalfinance/fixed-income`, `@insiderfinance/totalfinance/fixed-income/artifacts`, `@insiderfinance/totalfinance/fixed-income/bonds`, `@insiderfinance/totalfinance/fixed-income/conventions`, `@insiderfinance/totalfinance/fixed-income/convertible`, `@insiderfinance/totalfinance/fixed-income/credit`, `@insiderfinance/totalfinance/fixed-income/cross-currency`, `@insiderfinance/totalfinance/fixed-income/curves`, `@insiderfinance/totalfinance/fixed-income/futures`, `@insiderfinance/totalfinance/fixed-income/inflation`, `@insiderfinance/totalfinance/fixed-income/lattice`, `@insiderfinance/totalfinance/fixed-income/models`, `@insiderfinance/totalfinance/fixed-income/pricer`, `@insiderfinance/totalfinance/fixed-income/rates`, `@insiderfinance/totalfinance/fixed-income/xva`, `@insiderfinance/totalfinance/foreign-exchange`, `@insiderfinance/totalfinance/foreign-exchange/forwards`, `@insiderfinance/totalfinance/foreign-exchange/risk`, `@insiderfinance/totalfinance/foreign-exchange/spot`, `@insiderfinance/totalfinance/fundamentals`, `@insiderfinance/totalfinance/fundamentals/ratios`, `@insiderfinance/totalfinance/fundamentals/scores`, `@insiderfinance/totalfinance/fundamentals/statements`, `@insiderfinance/totalfinance/http`, `@insiderfinance/totalfinance/math`, `@insiderfinance/totalfinance/math/bivariate`, `@insiderfinance/totalfinance/math/distributions`, `@insiderfinance/totalfinance/math/filters`, `@insiderfinance/totalfinance/math/integration`, `@insiderfinance/totalfinance/math/interpolation`, `@insiderfinance/totalfinance/math/linalg`, `@insiderfinance/totalfinance/math/lowdiscrepancy`, `@insiderfinance/totalfinance/math/montecarlo`, `@insiderfinance/totalfinance/math/normal`, `@insiderfinance/totalfinance/math/optimize`, `@insiderfinance/totalfinance/math/random`, `@insiderfinance/totalfinance/math/regression`, `@insiderfinance/totalfinance/math/solvers`, `@insiderfinance/totalfinance/math/statistics`, `@insiderfinance/totalfinance/math/timeseries`, `@insiderfinance/totalfinance/options`, `@insiderfinance/totalfinance/options/bachelier`, `@insiderfinance/totalfinance/options/batch`, `@insiderfinance/totalfinance/options/black-scholes`, `@insiderfinance/totalfinance/options/black76`, `@insiderfinance/totalfinance/options/exotics`, `@insiderfinance/totalfinance/options/heston`, `@insiderfinance/totalfinance/options/lattice`, `@insiderfinance/totalfinance/options/local-volatility`, `@insiderfinance/totalfinance/options/monte-carlo`, `@insiderfinance/totalfinance/options/parity`, `@insiderfinance/totalfinance/options/payoff`, `@insiderfinance/totalfinance/options/pricer`, `@insiderfinance/totalfinance/options/sabr`, `@insiderfinance/totalfinance/options/schema`, `@insiderfinance/totalfinance/performance`, `@insiderfinance/totalfinance/performance/activity`, `@insiderfinance/totalfinance/performance/analyze`, `@insiderfinance/totalfinance/performance/drawdown`, `@insiderfinance/totalfinance/performance/flow-aware`, `@insiderfinance/totalfinance/performance/metrics`, `@insiderfinance/totalfinance/performance/ratios`, `@insiderfinance/totalfinance/performance/relative`, `@insiderfinance/totalfinance/performance/returns`, `@insiderfinance/totalfinance/performance/rolling`, `@insiderfinance/totalfinance/performance/sector-performance`, `@insiderfinance/totalfinance/performance/sharpe`, `@insiderfinance/totalfinance/portfolio`, `@insiderfinance/totalfinance/portfolio/disclosed-holding-partitions`, `@insiderfinance/totalfinance/portfolio/disclosed-holdings`, `@insiderfinance/totalfinance/portfolio/events`, `@insiderfinance/totalfinance/portfolio/ledger`, `@insiderfinance/totalfinance/portfolio/performance`, `@insiderfinance/totalfinance/portfolio/policy`, `@insiderfinance/totalfinance/portfolio/reconciliation`, `@insiderfinance/totalfinance/portfolio/trade`, `@insiderfinance/totalfinance/research`, `@insiderfinance/totalfinance/research/artifacts`, `@insiderfinance/totalfinance/research/events`, `@insiderfinance/totalfinance/research/factors`, `@insiderfinance/totalfinance/research/screening`, `@insiderfinance/totalfinance/risk`, `@insiderfinance/totalfinance/risk/factor`, `@insiderfinance/totalfinance/risk/optimize`, `@insiderfinance/totalfinance/risk/portfolio`, `@insiderfinance/totalfinance/risk/research`, `@insiderfinance/totalfinance/risk/scenario`, `@insiderfinance/totalfinance/risk/sizing`, `@insiderfinance/totalfinance/risk/value-at-risk`, `@insiderfinance/totalfinance/scenarios`, `@insiderfinance/totalfinance/scenarios/portfolio`, `@insiderfinance/totalfinance/strategy`, `@insiderfinance/totalfinance/strategy/from-chain`, `@insiderfinance/totalfinance/strategy/probability`, `@insiderfinance/totalfinance/strategy/scanner`, `@insiderfinance/totalfinance/structure`, `@insiderfinance/totalfinance/structure/exposure`, `@insiderfinance/totalfinance/structure/flow`, `@insiderfinance/totalfinance/technical-analysis`, `@insiderfinance/totalfinance/technical-analysis/aliases`, `@insiderfinance/totalfinance/technical-analysis/bands`, `@insiderfinance/totalfinance/technical-analysis/bars`, `@insiderfinance/totalfinance/technical-analysis/candle-aliases`, `@insiderfinance/totalfinance/technical-analysis/candle-talib`, `@insiderfinance/totalfinance/technical-analysis/candlesticks`, `@insiderfinance/totalfinance/technical-analysis/chart-types`, `@insiderfinance/totalfinance/technical-analysis/cycle`, `@insiderfinance/totalfinance/technical-analysis/divergence`, `@insiderfinance/totalfinance/technical-analysis/features`, `@insiderfinance/totalfinance/technical-analysis/framework`, `@insiderfinance/totalfinance/technical-analysis/macd`, `@insiderfinance/totalfinance/technical-analysis/math`, `@insiderfinance/totalfinance/technical-analysis/microstructure`, `@insiderfinance/totalfinance/technical-analysis/momentum`, `@insiderfinance/totalfinance/technical-analysis/moving-averages`, `@insiderfinance/totalfinance/technical-analysis/oscillators`, `@insiderfinance/totalfinance/technical-analysis/overlap`, `@insiderfinance/totalfinance/technical-analysis/pipeline`, `@insiderfinance/totalfinance/technical-analysis/price-action`, `@insiderfinance/totalfinance/technical-analysis/registry`, `@insiderfinance/totalfinance/technical-analysis/resample`, `@insiderfinance/totalfinance/technical-analysis/rsi`, `@insiderfinance/totalfinance/technical-analysis/series`, `@insiderfinance/totalfinance/technical-analysis/signal`, `@insiderfinance/totalfinance/technical-analysis/statistics`, `@insiderfinance/totalfinance/technical-analysis/transforms`, `@insiderfinance/totalfinance/technical-analysis/trend`, `@insiderfinance/totalfinance/technical-analysis/volatility`, `@insiderfinance/totalfinance/technical-analysis/volume`, `@insiderfinance/totalfinance/technical-analysis/warmup`, `@insiderfinance/totalfinance/valuation`, `@insiderfinance/totalfinance/valuation/cash-flows`, `@insiderfinance/totalfinance/valuation/corporate`, `@insiderfinance/totalfinance/valuation/forecasting`, `@insiderfinance/totalfinance/valuation/price-levels`, `@insiderfinance/totalfinance/valuation/schemas`, `@insiderfinance/totalfinance/volatility`, `@insiderfinance/totalfinance/volatility/analytics`, `@insiderfinance/totalfinance/volatility/arbitrage`, `@insiderfinance/totalfinance/volatility/artifacts`, `@insiderfinance/totalfinance/volatility/earnings`, `@insiderfinance/totalfinance/volatility/essvi`, `@insiderfinance/totalfinance/volatility/estimate`, `@insiderfinance/totalfinance/volatility/event`, `@insiderfinance/totalfinance/volatility/forecast`, `@insiderfinance/totalfinance/volatility/heston-surface`, `@insiderfinance/totalfinance/volatility/local-volatility`, `@insiderfinance/totalfinance/volatility/metrics`, `@insiderfinance/totalfinance/volatility/min-variance-delta`, `@insiderfinance/totalfinance/volatility/risk-reversal`, `@insiderfinance/totalfinance/volatility/sabr`, `@insiderfinance/totalfinance/volatility/sabr-delta`, `@insiderfinance/totalfinance/volatility/skew`, `@insiderfinance/totalfinance/volatility/ssvi`, `@insiderfinance/totalfinance/volatility/sticky-regime`, `@insiderfinance/totalfinance/volatility/surface`, `@insiderfinance/totalfinance/volatility/surface-pca`, `@insiderfinance/totalfinance/volatility/svi`, `@insiderfinance/totalfinance/volatility/swaption-cube`, `@insiderfinance/totalfinance/volatility/tail-risk`, `@insiderfinance/totalfinance/volatility/term`, `@insiderfinance/totalfinance/volatility/vanna-volga`, `@insiderfinance/totalfinance/volatility/variance-index`, `@insiderfinance/totalfinance/volatility/volatility-spot-beta`, `@insiderfinance/totalfinance/workflows`, `@insiderfinance/totalfinance/workflows/local` ## Entrypoint @insiderfinance/totalfinance ### @insiderfinance/totalfinance#AlignToBarsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AlignToBarsInput { higherSeries: ArrayLike; higherBars: ArrayLike; lowerBars: ArrayLike; options?: AlignOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - higherBars: ArrayLike; default: not declared - higherSeries: ArrayLike; default: not declared - lowerBars: ArrayLike; default: not declared - options?: AlignOptions; default: not declared - options.intervalMs?: number; default: not declared — The HTF bucket width in ms. Defaults to the smallest positive gap between consecutive HTF bars. ### @insiderfinance/totalfinance#BoxSpreadRateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for a box-spread-implied financing rate. ```typescript /** One cohesive request for a box-spread-implied financing rate. */ export interface BoxSpreadRateInput { quotes: readonly OptionQuote[]; expiry: string; lowerStrike: number; upperStrike: number; options: BoxSpreadOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - lowerStrike: number; default: not declared - options: BoxSpreadOptions; default: not declared - options.asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime). - options.source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). - quotes: readonly OptionQuote[]; default: not declared - upperStrike: number; default: not declared ### @insiderfinance/totalfinance#CdsBasisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CDS-bond basis: the CDS par spread minus the bond-implied credit spread (positive = CDS rich). ```typescript /** CDS-bond basis: the CDS par spread minus the bond-implied credit spread (positive = CDS rich). */ export interface CdsBasisInput { cdsParSpread: number; bondImpliedSpread: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bondImpliedSpread: number; default: not declared - cdsParSpread: number; default: not declared ### @insiderfinance/totalfinance#CommonPageFacts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CommonPageFacts { readonly dataset: { readonly id: string; readonly version: string; }; readonly receivedTimestampMs: number; readonly adjustment: DataPageMetadata['adjustment']; readonly consistency: 'snapshot' | 'best-effort'; readonly sourceSymbol?: string; readonly snapshotId?: string | null; readonly sessionDate?: string | null; readonly sourceGeneratedTimestampMs?: number | null; readonly times?: ObservationTimes; readonly freshness?: DataPageMetadata['freshness']; readonly coverage?: DataPageMetadata['coverage']; readonly quality?: DataPageMetadata['quality']; readonly access?: DataPageMetadata['access']; readonly requestId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - access?: 'unknown' | 'granted' | 'denied'; default: not declared - adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - consistency: 'snapshot' | 'best-effort'; default: not declared - coverage?: { readonly status: 'continuous' | 'observed-only' | 'unknown'; readonly start: string | null; readonly end: string | null; }; default: not declared - coverage.end: string | null; default: not declared - coverage.start: string | null; default: not declared - coverage.status: 'continuous' | 'unknown' | 'observed-only'; default: not declared - dataset: { readonly id: string; readonly version: string; }; default: not declared - dataset.id: string; default: not declared - dataset.version: string; default: not declared - freshness?: { readonly status: 'current' | 'stale' | 'session-closed' | 'historical' | 'end-of-day' | 'stored' | 'unknown'; readonly configuredDelayMs: number | null; readonly evaluatedTimestampMs: number | null; }; default: not declared - freshness.configuredDelayMs: number | null; default: not declared - freshness.evaluatedTimestampMs: number | null; default: not declared - freshness.status: 'stale' | 'historical' | 'current' | 'unknown' | 'session-closed' | 'end-of-day' | 'stored'; default: not declared - quality?: { readonly status: 'complete' | 'partial' | 'unavailable' | 'unknown'; readonly issues: readonly { source: string; code: string; message: string; }[]; }; default: not declared - quality.issues: readonly { source: string; code: string; message: string; }[]; default: not declared - quality.status: 'unavailable' | 'complete' | 'unknown' | 'partial'; default: not declared - receivedTimestampMs: number; default: not declared - requestId?: string; default: not declared - sessionDate?: string | null; default: not declared - snapshotId?: string | null; default: not declared - sourceGeneratedTimestampMs?: number | null; default: not declared - sourceSymbol?: string; default: not declared - times?: ObservationTimes; default: not declared - times.availableTimestampMs: number | null; default: not declared - times.observedTimestampMs: number | null; default: not declared - times.sourceStoredTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance#ConnectedData Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ConnectedData extends DataProvider { priceBars(request: PriceBarsWindowRequest, options?: PriceBarsWindowOptions): Promise; resumePriceBars(checkpoint: unknown, options?: PriceBarsWindowOptions): Promise; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: (options?: DataCallOptions) => Promise; default: not declared - capabilities(options)?: DataCallOptions | undefined; default: not declared - capabilities(options).signal?: AbortSignal; default: not declared - contractVersion: 2; default: not declared - id: string; default: not declared - priceBars: (request: PriceBarsWindowRequest, options?: PriceBarsWindowOptions) => Promise; default: not declared - priceBars(options)?: PriceBarsWindowOptions | undefined; default: not declared - priceBars(options).maxPages?: number; default: not declared - priceBars(options).maxReads?: number; default: not declared - priceBars(options).maxRecords?: number; default: not declared - priceBars(options).pageSize?: number; default: not declared - priceBars(options).signal?: AbortSignal; default: not declared - priceBars(request): PriceBarsWindowRequest; default: not declared - priceBars(request).from: string; default: not declared - priceBars(request).interval: DataInterval; default: not declared - priceBars(request).symbol: string; default: not declared - priceBars(request).to: string; default: not declared - query: (query: R, options: DataQueryOptions) => Promise>; default: not declared - query(options): DataQueryOptions; default: not declared - query(options).cursor?: DataContinuation; default: not declared - query(options).limit: number; default: not declared - query(options).signal?: AbortSignal; default: not declared - query(query): R; default: not declared - resumePriceBars: (checkpoint: unknown, options?: PriceBarsWindowOptions) => Promise; default: not declared - resumePriceBars(checkpoint): unknown; default: not declared - resumePriceBars(options)?: PriceBarsWindowOptions | undefined; default: not declared - resumePriceBars(options).maxPages?: number; default: not declared - resumePriceBars(options).maxReads?: number; default: not declared - resumePriceBars(options).maxRecords?: number; default: not declared - resumePriceBars(options).pageSize?: number; default: not declared - resumePriceBars(options).signal?: AbortSignal; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance#CreditTriangleHazardInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The credit-triangle approximation of the hazard rate implied by a flat par spread: `λ ≈ spread / (1 − recovery)`. Exact only in the continuous-premium, flat-curve limit. Returns a Law-2 envelope: the hazard in `value` plus the recovery assumption and a warnings channel. ```typescript /** * The credit-triangle approximation of the hazard rate implied by a flat par spread: * `λ ≈ spread / (1 − recovery)`. Exact only in the continuous-premium, flat-curve limit. Returns a * Law-2 envelope: the hazard in `value` plus the recovery assumption and a warnings channel. */ export interface CreditTriangleHazardInput { spread: number; recovery?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - recovery?: number; default: not declared - spread: number; default: not declared ### @insiderfinance/totalfinance#DataCallOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataCallOptions { readonly signal?: AbortSignal; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - signal?: AbortSignal; default: not declared ### @insiderfinance/totalfinance#DataCapabilities Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataCapabilities { readonly contractVersion: 2; readonly providerId: string; readonly providerVersion: string; readonly capabilities: readonly DataCapability[]; readonly ignored: { readonly kinds: number; readonly intervals: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: readonly DataCapability[]; default: not declared - contractVersion: 2; default: not declared - ignored: { readonly kinds: number; readonly intervals: number; }; default: not declared - ignored.intervals: number; default: not declared - ignored.kinds: number; default: not declared - providerId: string; default: not declared - providerVersion: string; default: not declared ### @insiderfinance/totalfinance#DataCapability Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataCapability extends Omit { readonly kind: DataKind; readonly intervals: readonly DataInterval[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - access: 'unknown' | 'granted' | 'denied'; default: not declared - consistency: readonly ('snapshot' | 'best-effort')[]; default: not declared - intervals: readonly DataInterval[]; default: not declared - kind: DataKind; default: not declared - maxPageSize: number; default: not declared - maxSessionDays?: number; default: not declared - maxWindowMs?: number; default: not declared - pointInTime: false; default: not declared ### @insiderfinance/totalfinance#DataCapabilityDeclaration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataCapabilityDeclaration { readonly kind: string; readonly intervals: readonly string[]; readonly maxPageSize: number; readonly consistency: readonly ('snapshot' | 'best-effort')[]; readonly pointInTime: false; readonly access: 'unknown' | 'granted' | 'denied'; readonly maxWindowMs?: number; readonly maxSessionDays?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - access: 'unknown' | 'granted' | 'denied'; default: not declared - consistency: readonly ('snapshot' | 'best-effort')[]; default: not declared - intervals: readonly string[]; default: not declared - kind: string; default: not declared - maxPageSize: number; default: not declared - maxSessionDays?: number; default: not declared - maxWindowMs?: number; default: not declared - pointInTime: false; default: not declared ### @insiderfinance/totalfinance#DataConnectionOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataConnectionOptions { readonly pageSize?: number; readonly maxPages?: number; readonly maxReads?: number; readonly maxRecords?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxPages?: number; default: not declared - maxReads?: number; default: not declared - maxRecords?: number; default: not declared - pageSize?: number; default: not declared ### @insiderfinance/totalfinance#DataContinuation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataContinuation { readonly version: 2; readonly binding: DataQueryBinding; readonly cursor: string; readonly pins: DataPins; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - binding: DataQueryBinding; default: not declared - binding.provider: { readonly id: string; readonly version: string; }; default: not declared - binding.provider.id: string; default: not declared - binding.provider.version: string; default: not declared - binding.query: DataQuery; default: not declared - binding.query.expirationFrom?: string; default: not declared - binding.query.expirationTo?: string; default: not declared - binding.query.from: string; default: not declared - binding.query.interval: DataInterval; default: not declared - binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - binding.query.maxStrike?: number; default: not declared - binding.query.minStrike?: number; default: not declared - binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - binding.query.snapshot.sessionDate: string; default: not declared - binding.query.snapshot.snapshotId: string; default: not declared - binding.query.symbol: string; default: not declared - binding.query.to: string; default: not declared - cursor: string; default: not declared - pins: DataPins; default: not declared - pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - pins.consistency: 'snapshot' | 'best-effort'; default: not declared - pins.datasetId: string; default: not declared - pins.datasetVersion: string; default: not declared - pins.sessionDate: string | null; default: not declared - pins.snapshotId: string | null; default: not declared - pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - pins.temporal.interval: DataInterval; default: not declared - pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - version: 2; default: not declared ### @insiderfinance/totalfinance#DataFor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataFor = R extends PriceBarsQuery ? PriceBarRecord : OptionChainResearchRecord; ``` ### @insiderfinance/totalfinance#DataGuidanceRule Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataGuidanceRule = 'uppercase_symbol' | 'zoned_instant_required' | 'session_date_required' | 'ordered_bounds' | 'page_limit' | 'unsupported_interval' | 'source_domain_rule'; ``` ### @insiderfinance/totalfinance#DataInterval Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataInterval = '1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '1d' | '1w' | '1mo'; ``` ### @insiderfinance/totalfinance#DataKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataKind = 'price-bars' | 'option-chain-research'; ``` ### @insiderfinance/totalfinance#DataPage Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Version1 remains a canonical restore format, never a live source protocol. ```typescript /** Version1 remains a canonical restore format, never a live source protocol. */ export type DataPage = DataPageFields & ({ readonly contractVersion: 1; readonly binding?: never; readonly timestampConvention?: never; readonly issues?: never; } | { readonly contractVersion: 2; readonly binding: DataQueryBinding; readonly timestampConvention?: PriceBarRecord['timestampConvention']; readonly issues: readonly ResearchBarIssue[]; }); ``` ### @insiderfinance/totalfinance#DataPageMetadata Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataPageMetadata { readonly datasetId: string; readonly datasetVersion: string; readonly snapshotId: string | null; readonly sessionDate: string | null; readonly sourceGeneratedTimestampMs: number | null; readonly receivedTimestampMs: number; readonly times: ObservationTimes; readonly consistency: 'snapshot' | 'best-effort'; readonly freshness: { readonly status: 'current' | 'stale' | 'session-closed' | 'historical' | 'end-of-day' | 'stored' | 'unknown'; readonly configuredDelayMs: number | null; readonly evaluatedTimestampMs: number | null; }; readonly coverage: { readonly status: 'continuous' | 'observed-only' | 'unknown'; readonly start: string | null; readonly end: string | null; }; readonly adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; readonly quality: { readonly status: 'complete' | 'partial' | 'unavailable' | 'unknown'; readonly issues: readonly { source: string; code: string; message: string; }[]; }; readonly access: 'unknown' | 'granted' | 'denied'; readonly executionEligibility: 'research-only'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - access: 'unknown' | 'granted' | 'denied'; default: not declared - adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - consistency: 'snapshot' | 'best-effort'; default: not declared - coverage: { readonly end: string | null; readonly start: string | null; readonly status: 'continuous' | 'observed-only' | 'unknown'; }; default: not declared - coverage.end: string | null; default: not declared - coverage.start: string | null; default: not declared - coverage.status: 'continuous' | 'unknown' | 'observed-only'; default: not declared - datasetId: string; default: not declared - datasetVersion: string; default: not declared - executionEligibility: 'research-only'; default: not declared - freshness: { readonly configuredDelayMs: number | null; readonly evaluatedTimestampMs: number | null; readonly status: 'current' | 'stale' | 'session-closed' | 'historical' | 'end-of-day' | 'stored' | 'unknown'; }; default: not declared - freshness.configuredDelayMs: number | null; default: not declared - freshness.evaluatedTimestampMs: number | null; default: not declared - freshness.status: 'stale' | 'historical' | 'current' | 'unknown' | 'session-closed' | 'end-of-day' | 'stored'; default: not declared - quality: { readonly issues: readonly { source: string; code: string; message: string; }[]; readonly status: 'complete' | 'partial' | 'unavailable' | 'unknown'; }; default: not declared - quality.issues: readonly { source: string; code: string; message: string; }[]; default: not declared - quality.status: 'unavailable' | 'complete' | 'unknown' | 'partial'; default: not declared - receivedTimestampMs: number; default: not declared - sessionDate: string | null; default: not declared - snapshotId: string | null; default: not declared - sourceGeneratedTimestampMs: number | null; default: not declared - times: ObservationTimes; default: not declared - times.availableTimestampMs: number | null; default: not declared - times.observedTimestampMs: number | null; default: not declared - times.sourceStoredTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance#DataPageOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataPageOptions extends DataCallOptions { readonly limit: number; readonly cursor: string | null; readonly pins: DataPins | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cursor: string | null; default: not declared - limit: number; default: not declared - pins: DataPins | null; default: not declared - pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - pins.consistency: 'snapshot' | 'best-effort'; default: not declared - pins.datasetId: string; default: not declared - pins.datasetVersion: string; default: not declared - pins.sessionDate: string | null; default: not declared - pins.snapshotId: string | null; default: not declared - pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - pins.temporal.interval: DataInterval; default: not declared - pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - signal?: AbortSignal; default: not declared ### @insiderfinance/totalfinance#DataPins Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataPins { readonly datasetId: string; readonly datasetVersion: string; readonly snapshotId: string | null; readonly sessionDate: string | null; readonly adjustment: DataPageMetadata['adjustment']; readonly consistency: 'snapshot' | 'best-effort'; readonly temporal: { readonly kind: 'price-bars'; readonly interval: DataInterval; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - consistency: 'snapshot' | 'best-effort'; default: not declared - datasetId: string; default: not declared - datasetVersion: string; default: not declared - sessionDate: string | null; default: not declared - snapshotId: string | null; default: not declared - temporal: { readonly kind: 'price-bars'; readonly interval: DataInterval; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - temporal.interval: DataInterval; default: not declared - temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared ### @insiderfinance/totalfinance#DataProvider Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataProvider { readonly id: string; readonly version: string; readonly contractVersion: 2; capabilities(options?: DataCallOptions): Promise; query(query: R, options: DataQueryOptions): Promise>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: (options?: DataCallOptions) => Promise; default: not declared - capabilities(options)?: DataCallOptions | undefined; default: not declared - capabilities(options).signal?: AbortSignal; default: not declared - contractVersion: 2; default: not declared - id: string; default: not declared - query: (query: R, options: DataQueryOptions) => Promise>; default: not declared - query(options): DataQueryOptions; default: not declared - query(options).cursor?: DataContinuation; default: not declared - query(options).limit: number; default: not declared - query(options).signal?: AbortSignal; default: not declared - query(query): R; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance#DataProviderErrorOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataProviderErrorOptions extends Omit { readonly cause?: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cause?: unknown; default: not declared - code: string; default: not declared - guidance?: { readonly field: KnownDataField; readonly rule: DataGuidanceRule; }; default: not declared - guidance.field: KnownDataField; default: not declared - guidance.rule: DataGuidanceRule; default: not declared - retryAfterMs?: number; default: not declared - retryable?: boolean; default: not declared - status?: number; default: not declared ### @insiderfinance/totalfinance#DataProviderFailure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataProviderFailure { readonly version: 1; readonly code: string; readonly guidance?: { readonly field: KnownDataField; readonly rule: DataGuidanceRule; }; readonly retryable?: boolean; readonly retryAfterMs?: number; readonly status?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared - guidance?: { readonly field: KnownDataField; readonly rule: DataGuidanceRule; }; default: not declared - guidance.field: KnownDataField; default: not declared - guidance.rule: DataGuidanceRule; default: not declared - retryAfterMs?: number; default: not declared - retryable?: boolean; default: not declared - status?: number; default: not declared - version: 1; default: not declared ### @insiderfinance/totalfinance#DataProviderSource Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataProviderSource { readonly protocol: 'totalfinance-data-source'; readonly contractVersion: 2; readonly id: string; readonly version: string; capabilities(options?: DataCallOptions): Promise; query(query: DataQuery, page: DataPageOptions): Promise; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: (options?: DataCallOptions) => Promise; default: not declared - capabilities(options)?: DataCallOptions | undefined; default: not declared - capabilities(options).signal?: AbortSignal; default: not declared - contractVersion: 2; default: not declared - id: string; default: not declared - protocol: 'totalfinance-data-source'; default: not declared - query: (query: DataQuery, page: DataPageOptions) => Promise; default: not declared - query(page): DataPageOptions; default: not declared - query(page).cursor: string | null; default: not declared - query(page).limit: number; default: not declared - query(page).pins: DataPins | null; default: not declared - query(page).pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - query(page).pins.consistency: 'snapshot' | 'best-effort'; default: not declared - query(page).pins.datasetId: string; default: not declared - query(page).pins.datasetVersion: string; default: not declared - query(page).pins.sessionDate: string | null; default: not declared - query(page).pins.snapshotId: string | null; default: not declared - query(page).pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - query(page).pins.temporal.interval: DataInterval; default: not declared - query(page).pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - query(page).pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - query(page).signal?: AbortSignal; default: not declared - query(query): DataQuery; default: not declared - query(query).expirationFrom?: string; default: not declared - query(query).expirationTo?: string; default: not declared - query(query).from: string; default: not declared - query(query).interval: DataInterval; default: not declared - query(query).kind: ('option-chain-research') | ('price-bars'); default: not declared - query(query).maxStrike?: number; default: not declared - query(query).minStrike?: number; default: not declared - query(query).rights?: readonly ('call' | 'put')[]; default: not declared - query(query).snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - query(query).snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - query(query).snapshot.sessionDate: string; default: not declared - query(query).snapshot.snapshotId: string; default: not declared - query(query).symbol: string; default: not declared - query(query).to: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance#DataQuery Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataQuery = PriceBarsQuery | OptionChainResearchQuery; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expirationFrom?: string; default: not declared - expirationTo?: string; default: not declared - from: string; default: not declared - interval: DataInterval; default: not declared - kind: ('option-chain-research') | ('price-bars'); default: not declared - maxStrike?: number; default: not declared - minStrike?: number; default: not declared - rights?: readonly ('call' | 'put')[]; default: not declared - snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - snapshot.sessionDate: string; default: not declared - snapshot.snapshotId: string; default: not declared - symbol: string; default: not declared - to: string; default: not declared ### @insiderfinance/totalfinance#DataQueryBinding Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataQueryBinding { readonly provider: { readonly id: string; readonly version: string; }; readonly query: DataQuery; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - provider: { readonly id: string; readonly version: string; }; default: not declared - provider.id: string; default: not declared - provider.version: string; default: not declared - query: DataQuery; default: not declared - query.expirationFrom?: string; default: not declared - query.expirationTo?: string; default: not declared - query.from: string; default: not declared - query.interval: DataInterval; default: not declared - query.kind: ('option-chain-research') | ('price-bars'); default: not declared - query.maxStrike?: number; default: not declared - query.minStrike?: number; default: not declared - query.rights?: readonly ('call' | 'put')[]; default: not declared - query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - query.snapshot.sessionDate: string; default: not declared - query.snapshot.snapshotId: string; default: not declared - query.symbol: string; default: not declared - query.to: string; default: not declared ### @insiderfinance/totalfinance#DataQueryOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataQueryOptions extends DataCallOptions { readonly limit: number; readonly cursor?: DataContinuation; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cursor?: DataContinuation; default: not declared - cursor.binding: DataQueryBinding; default: not declared - cursor.binding.provider: { readonly id: string; readonly version: string; }; default: not declared - cursor.binding.provider.id: string; default: not declared - cursor.binding.provider.version: string; default: not declared - cursor.binding.query: DataQuery; default: not declared - cursor.binding.query.expirationFrom?: string; default: not declared - cursor.binding.query.expirationTo?: string; default: not declared - cursor.binding.query.from: string; default: not declared - cursor.binding.query.interval: DataInterval; default: not declared - cursor.binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - cursor.binding.query.maxStrike?: number; default: not declared - cursor.binding.query.minStrike?: number; default: not declared - cursor.binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - cursor.binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - cursor.binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - cursor.binding.query.snapshot.sessionDate: string; default: not declared - cursor.binding.query.snapshot.snapshotId: string; default: not declared - cursor.binding.query.symbol: string; default: not declared - cursor.binding.query.to: string; default: not declared - cursor.cursor: string; default: not declared - cursor.pins: DataPins; default: not declared - cursor.pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - cursor.pins.consistency: 'snapshot' | 'best-effort'; default: not declared - cursor.pins.datasetId: string; default: not declared - cursor.pins.datasetVersion: string; default: not declared - cursor.pins.sessionDate: string | null; default: not declared - cursor.pins.snapshotId: string | null; default: not declared - cursor.pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - cursor.pins.temporal.interval: DataInterval; default: not declared - cursor.pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - cursor.pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - cursor.version: 2; default: not declared - limit: number; default: not declared - signal?: AbortSignal; default: not declared ### @insiderfinance/totalfinance#DataView Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataView = PriceBarsView | OptionChainResearchView; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bars: readonly Readonly[]; default: not declared - closePrices: readonly number[]; default: not declared - continuation: DataContinuation | null; default: not declared - continuation.binding: DataQueryBinding; default: not declared - continuation.binding.provider: { readonly id: string; readonly version: string; }; default: not declared - continuation.binding.provider.id: string; default: not declared - continuation.binding.provider.version: string; default: not declared - continuation.binding.query: DataQuery; default: not declared - continuation.binding.query.expirationFrom?: string; default: not declared - continuation.binding.query.expirationTo?: string; default: not declared - continuation.binding.query.from: string; default: not declared - continuation.binding.query.interval: DataInterval; default: not declared - continuation.binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - continuation.binding.query.maxStrike?: number; default: not declared - continuation.binding.query.minStrike?: number; default: not declared - continuation.binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - continuation.binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - continuation.binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - continuation.binding.query.snapshot.sessionDate: string; default: not declared - continuation.binding.query.snapshot.snapshotId: string; default: not declared - continuation.binding.query.symbol: string; default: not declared - continuation.binding.query.to: string; default: not declared - continuation.cursor: string; default: not declared - continuation.pins: DataPins; default: not declared - continuation.pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - continuation.pins.consistency: 'snapshot' | 'best-effort'; default: not declared - continuation.pins.datasetId: string; default: not declared - continuation.pins.datasetVersion: string; default: not declared - continuation.pins.sessionDate: string | null; default: not declared - continuation.pins.snapshotId: string | null; default: not declared - continuation.pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - continuation.pins.temporal.interval: DataInterval; default: not declared - continuation.pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - continuation.pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - continuation.version: 2; default: not declared - continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; default: not declared - issues: readonly ResearchBarIssue[]; default: not declared - kind: ('option-chain-research') | ('price-bars'); default: not declared - ohlcvBars: readonly OhlcvInput[]; default: not declared - page: (DataPage) | (DataPage); default: not declared - resolve: (choice: ResearchBarChoice) => PriceBarsView; default: not declared - resolve().return.bars: readonly Readonly[]; default: not declared - resolve().return.closePrices: readonly number[]; default: not declared - resolve().return.continuation: DataContinuation | null; default: not declared - resolve().return.continuation.binding: DataQueryBinding; default: not declared - resolve().return.continuation.cursor: string; default: not declared - resolve().return.continuation.pins: DataPins; default: not declared - resolve().return.continuation.version: 2; default: not declared - resolve().return.continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; default: not declared - resolve().return.issues: readonly ResearchBarIssue[]; default: not declared - resolve().return.kind: 'price-bars'; default: not declared - resolve().return.ohlcvBars: readonly OhlcvInput[]; default: not declared - resolve().return.page: DataPage; default: not declared - resolve().return.resolve: (choice: ResearchBarChoice) => PriceBarsView; default: not declared - resolve().return.selection: ResearchBarSelection; default: not declared - resolve().return.selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared - resolve(choice): ResearchBarChoice; default: not declared - resolve(choice).action: ('correct') | ('exclude' | 'use'); default: not declared - resolve(choice).corrections: readonly { readonly row: RowReference; readonly values: Partial>; }[]; default: not declared - resolve(choice).reason: string; default: not declared - resolve(choice).rows?: readonly RowReference[]; default: not declared - selection: ResearchBarSelection; default: not declared - selection.decisions: readonly ResearchBarChoice[]; default: not declared - selection.sourceRows: readonly RowReference[]; default: not declared - selection.version: 1; default: not declared - selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared ### @insiderfinance/totalfinance#DataViewFor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataViewFor = R extends PriceBarsQuery ? PriceBarsView : OptionChainResearchView; ``` ### @insiderfinance/totalfinance#DivergencesInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Detect regular & hidden divergences between a `price` series and an `indicator` series, returning the confirmed events as a list (batch derived from the stream). Each event's `index` is the confirmation bar; the swings reference earlier bars. ```typescript /** * Detect regular & hidden divergences between a `price` series and an `indicator` series, returning * the confirmed events as a list (batch derived from the stream). Each event's `index` is the * confirmation bar; the swings reference earlier bars. */ export interface DivergencesInput { price: ArrayLike; indicator: ArrayLike; parameters?: DivergenceParameters; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - indicator: ArrayLike; default: not declared - parameters?: DivergenceParameters; default: not declared - parameters.kinds?: DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - parameters.swing?: SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - parameters.swing.left?: number; default: not declared — Bars to the left of a pivot that must be higher/lower. Defaults to 5; echoed via `.explain()`. - parameters.swing.right?: number; default: not declared — Bars to the right that confirm the pivot. Defaults to 5; echoed via `.explain()`. - price: ArrayLike; default: not declared ### @insiderfinance/totalfinance#DupireLocalVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for construction of a Dupire local-volatility function. ```typescript /** One cohesive request for construction of a Dupire local-volatility function. */ export interface DupireLocalVolatilityInput { impliedVolatility: ImpliedVolatilityFunction; market: LocalVolatilityMarket; options?: DupireOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility: ImpliedVolatilityFunction; default: not declared - impliedVolatility(strike): number; default: not declared - impliedVolatility(timeToExpiryYears): number; default: not declared - market: LocalVolatilityMarket; default: not declared - market.dividendYield?: number; default: not declared - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - options?: DupireOptions; default: not declared - options.floorVolatility?: number; default: not declared — Floor for local vol (default 1e-3) — also the clamp when a local arbitrage drives σ_loc² ≤ 0. - options.logMoneynessStep?: number; default: not declared — Log-moneyness finite-difference step (default 0.01). - options.timeStepYears?: number; default: not declared — Time finite-difference step in years (default 1/365). ### @insiderfinance/totalfinance#ExposureInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link exposure}: the chain, market and convention, plus an optional metric selection. ```typescript /** Input for {@link exposure}: the chain, market and convention, plus an optional metric selection. */ export interface ExposureInput extends ExposureShortcutInput { /** * The exposures to compute, e.g. `['gex']` or `['gex', 'dex', 'vanna']`. Omit it for the full * profile (every metric, exactly as before). A selection — explicit, nonempty, each name once — * computes only those metrics and the Black–Scholes outputs they need, and is echoed in * `assumptions.metrics`; uncomputed metrics are absent from the result, never zero. */ metrics?: S; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config: ExposureConfig; default: not declared - config.convention: ExposureConvention; default: not declared — REQUIRED sign convention; echoed in `assumptions.convention` with its caveat in diagnostics. - config.convention.calls: 1 | -1; default: not declared - config.convention.puts: 1 | -1; default: not declared - config.defaultMultiplier?: number; default: not declared — Contract multiplier when a quote omits one (default 100). - config.gammaUnit?: GammaUnit; default: not declared — `per1PercentMove` (default, the spec GEX formula) or `perPoint`. - config.minTimeToExpiry?: number; default: not declared — Skip contracts with time-to-expiry below this many years (default 0). - config.priceSource?: PriceSource; default: not declared - market: ExposureMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime (core `resolveAsOf` grammar). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.riskFreeRate: number; default: not declared - market.spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. - metrics?: S; default: not declared — The exposures to compute, e.g. `['gex']` or `['gex', 'dex', 'vanna']`. Omit it for the full profile (every metric, exactly as before). A selection — explicit, nonempty, each name once — computes only those metrics and the Black–Scholes outputs they need, and is echoed in `assumptions.metrics`; uncomputed metrics are absent from the result, never zero. - quotes: OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#FibExtensionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Trend-based Fibonacci extension: project the `start → end` move from `projectFrom`: `price(r) = projectFrom + (end − start)·r`. Targets at r ≥ 1 lie beyond the original move. ```typescript /** * Trend-based Fibonacci extension: project the `start → end` move from `projectFrom`: * `price(r) = projectFrom + (end − start)·r`. Targets at r ≥ 1 lie beyond the original move. */ export interface FibExtensionInput { start: number; end: number; projectFrom: number; levels?: readonly number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - end: number; default: not declared - levels?: readonly number[]; default: not declared - projectFrom: number; default: not declared - start: number; default: not declared ### @insiderfinance/totalfinance#FlatCurveInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for a flat continuously compounded zero curve. ```typescript /** One cohesive request for a flat continuously compounded zero curve. */ export interface FlatCurveInput { rate: number; referenceDate: string; options?: Omit; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - options?: Omit; default: not declared - options.compounding?: InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - options.compounding.periodsPerYear: number; default: not declared - options.compounding.type: 'periodic'; default: not declared - options.dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - options.extrapolation?: CurveExtrapolation; default: not declared - options.interpolation?: CurveInterpolation; default: not declared - rate: number; default: not declared - referenceDate: string; default: not declared ### @insiderfinance/totalfinance#FlatHazardInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A flat-hazard survival curve (constant default intensity). ```typescript /** A flat-hazard survival curve (constant default intensity). */ export interface FlatHazardInput { hazardRate: number; referenceDate: string; options?: Omit; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - hazardRate: number; default: not declared - options?: Omit; default: not declared - options.dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - referenceDate: string; default: not declared ### @insiderfinance/totalfinance#GarchForecastInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Multi-step GARCH(1,1) variance forecast. The `h`-step-ahead conditional variance mean-reverts geometrically to the long-run variance: `σ²ₜ₊ₕ = LRV + (α+β)^h · (σ²ₜ − LRV)`. Because `0 < α+β < 1`, the path moves monotonically toward `LRV`; a forecast started exactly at `LRV` stays flat. ```typescript /** * Multi-step GARCH(1,1) variance forecast. The `h`-step-ahead conditional variance mean-reverts * geometrically to the long-run variance: `σ²ₜ₊ₕ = LRV + (α+β)^h · (σ²ₜ − LRV)`. Because `0 < α+β < 1`, * the path moves monotonically toward `LRV`; a forecast started exactly at `LRV` stays flat. */ export interface GarchForecastInput { fit: GarchFit; lastVariance: number; horizonPeriods: number; options?: GarchForecastOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fit: GarchFit; default: not declared - fit.alpha: number; default: not declared — ARCH coefficient on the lagged squared return (`≥ 0`). - fit.assumptions: { conventionsVersion: string; mean: 'zero' | 'sample'; observations: number; initialParameters: 'supplied' | 'default'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - fit.assumptions.conventionsVersion: string; default: not declared - fit.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the primary start was caller-supplied (`initialParameters`) or the classic (0.05, 0.90). - fit.assumptions.mean: 'zero' | 'sample'; default: not declared - fit.assumptions.observations: number; default: not declared - fit.beta: number; default: not declared — GARCH coefficient on the lagged conditional variance (`≥ 0`). - fit.converged: boolean; default: not declared — Whether the optimizer converged (never fabricated). - fit.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a degenerate / non-converged fit explains itself here. - fit.diagnostics.warnings: QuantWarning[]; default: not declared - fit.iterations: number; default: not declared — Optimizer iterations performed. - fit.logLikelihood: number | null; default: not declared — Maximized Gaussian log-likelihood; `null` when the likelihood is degenerate (disclosed). - fit.longRunVariance: number; default: not declared — Unconditional variance `ω / (1 − α − β)` the forecast mean-reverts to. - fit.omega: number; default: not declared — Constant term of the variance recursion (`> 0`). - fit.persistence: number; default: not declared — `α + β` — the variance half-life driver; `< 1` for a stationary fit. - horizonPeriods: number; default: not declared - lastVariance: number; default: not declared - options?: GarchForecastOptions; default: not declared - options.periodsPerYear?: number; default: not declared — Periods per year for annualization (default 252 trading days). ### @insiderfinance/totalfinance#HestonCosineExpansionPriceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete, assumption-light inputs for the raw Heston COS kernel. ```typescript /** Complete, assumption-light inputs for the raw Heston COS kernel. */ export interface HestonCosineExpansionPriceInput { type: OptionType; spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; dividendYield: number; parameters: HestonParameters; /** Number of cosine terms (default 256, maximum 8,192). */ terms?: number; truncation?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - parameters: HestonParameters; default: not declared - parameters.kappa: number; default: not declared — Mean-reversion speed κ. - parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - parameters.theta: number; default: not declared — Long-run variance θ. - parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192). - timeToExpiryYears: number; default: not declared - truncation?: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance#HestonMonteCarloEstimateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete inputs for one raw Heston QE Monte-Carlo estimate. ```typescript /** Complete inputs for one raw Heston QE Monte-Carlo estimate. */ export interface HestonMonteCarloEstimateInput { type: OptionType; spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; dividendYield: number; parameters: HestonParameters; options: HestonMonteCarloOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - options: HestonMonteCarloOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `false` — MC Greeks are noisy). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - options.steps?: number; default: not declared — Time steps per path (default 64). - parameters: HestonParameters; default: not declared - parameters.kappa: number; default: not declared — Mean-reversion speed κ. - parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - parameters.theta: number; default: not declared — Long-run variance θ. - parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance#HestonPriceMonteCarloRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for the validated Heston QE Monte-Carlo pricer. ```typescript /** One cohesive request for the validated Heston QE Monte-Carlo pricer. */ export interface HestonPriceMonteCarloRequest { type: OptionType; input: HestonInput; parameters: HestonParameters; options: HestonMonteCarloOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: HestonInput; default: not declared - input.dividendYield?: number; default: not declared - input.riskFreeRate: number; default: not declared - input.spot: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared — Time to expiry in years. - options: HestonMonteCarloOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `false` — MC Greeks are noisy). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - options.steps?: number; default: not declared — Time steps per path (default 64). - parameters: HestonParameters; default: not declared - parameters.kappa: number; default: not declared — Mean-reversion speed κ. - parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - parameters.theta: number; default: not declared — Long-run variance θ. - parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - type: OptionType; default: not declared ### @insiderfinance/totalfinance#HestonPriceRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for the validated Heston COS pricer or IV bridge. ```typescript /** One cohesive request for the validated Heston COS pricer or IV bridge. */ export interface HestonPriceRequest { type: OptionType; input: HestonInput; parameters: HestonParameters; options?: HestonCosineExpansionOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: HestonInput; default: not declared - input.dividendYield?: number; default: not declared - input.riskFreeRate: number; default: not declared - input.spot: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared — Time to expiry in years. - options?: HestonCosineExpansionOptions; default: not declared - options.extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the **vol level** — `√v₀` and `√θ` bumped together — extending the `vega` convention. The COS price is accurate, so the finite differences are converged (verified stable across term counts). - options.greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - options.terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192; COS converges exponentially). - options.truncation?: number; default: not declared — Truncation width in standard deviations (default 12). - parameters: HestonParameters; default: not declared - parameters.kappa: number; default: not declared — Mean-reversion speed κ. - parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - parameters.theta: number; default: not declared — Long-run variance θ. - parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - type: OptionType; default: not declared ### @insiderfinance/totalfinance#HestonSurfaceCalibrationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HestonSurfaceCalibrationInput { targets: readonly HestonSurfaceTarget[]; market: HestonSurfaceMarket; options?: { /** * Warm start — a partial pin of the five parameters (Stage 4.5; formerly `seed`, retired: `seed` * names randomness everywhere else in the library). Unspecified members keep their data-derived * starts (ATM variance for `v0`/`theta`, κ = 2, σ = 0.5, ρ = −0.5). */ initialParameters?: Partial; /** Heston COS expansion terms per target price (default 128, maximum 8,192). */ terms?: number; /** Outer-search iteration budget (default 300, maximum 10,000). */ maximumIterations?: number; /** Max RMSE the `converged` flag tolerates (default 0.02 IV points). */ rmseTolerance?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - market: HestonSurfaceMarket; default: not declared - market.dividendYield: number; default: not declared - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - options?: { initialParameters?: Partial; terms?: number; maximumIterations?: number; rmseTolerance?: number; }; default: not declared - options.initialParameters?: Partial; default: not declared — Warm start — a partial pin of the five parameters (Stage 4.5; formerly `seed`, retired: `seed` names randomness everywhere else in the library). Unspecified members keep their data-derived starts (ATM variance for `v0`/`theta`, κ = 2, σ = 0.5, ρ = −0.5). - options.initialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - options.initialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - options.initialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - options.initialParameters.theta?: number; default: not declared — Long-run variance θ. - options.initialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 300, maximum 10,000). - options.rmseTolerance?: number; default: not declared — Max RMSE the `converged` flag tolerates (default 0.02 IV points). - options.terms?: number; default: not declared — Heston COS expansion terms per target price (default 128, maximum 8,192). - targets: readonly HestonSurfaceTarget[]; default: not declared ### @insiderfinance/totalfinance#ImpliedBorrowInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for borrow-spread inference from put-call parity. ```typescript /** One cohesive request for borrow-spread inference from put-call parity. */ export interface ImpliedBorrowInput { quotes: readonly OptionQuote[]; expiry: string; options: ImpliedBorrowOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - options: ImpliedBorrowOptions; default: not declared - options.asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. - options.outlierThreshold?: number; default: not declared — MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). - options.riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate. - options.source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). - options.spot: number; default: not declared - quotes: readonly OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#ImpliedDividendYieldInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for dividend-yield inference from put-call parity. ```typescript /** One cohesive request for dividend-yield inference from put-call parity. */ export interface ImpliedDividendYieldInput { quotes: readonly OptionQuote[]; expiry: string; options: ImpliedDividendYieldOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - options: ImpliedDividendYieldOptions; default: not declared - options.asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. - options.outlierThreshold?: number; default: not declared — MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). - options.riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate. - options.source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). - options.spot: number; default: not declared - quotes: readonly OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#ImpliedForwardInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for put-call-parity forward inference. ```typescript /** One cohesive request for put-call-parity forward inference. */ export interface ImpliedForwardInput { quotes: readonly OptionQuote[]; expiry: string; options: ImpliedForwardOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - options: ImpliedForwardOptions; default: not declared - options.asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. - options.outlierThreshold?: number; default: not declared — MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). - options.riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate. - options.source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). - quotes: readonly OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#ImpliedVolatilityMetricInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link impliedVolatilityRank}/{@link impliedVolatilityPercentile}/{@link impliedVolatilityStatistics}: current IV vs its history. ```typescript /** * IV rank: where `current` sits in the trailing [min, max] range, as a percentage in `[0, 100]`. * `(current − min) / (max − min) × 100`, clamped. Returns `NaN` only when the history is flat * (min == max) — there is no defined rank, and we never fabricate one. */ /** Input for {@link impliedVolatilityRank}/{@link impliedVolatilityPercentile}/{@link impliedVolatilityStatistics}: current IV vs its history. */ export interface ImpliedVolatilityMetricInput { /** Current implied volatility (annualized decimal). */ current: number; /** Trailing IV history (chronological or not — order-insensitive). */ history: ArrayLike; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: number; default: not declared — Current implied volatility (annualized decimal). - history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). ### @insiderfinance/totalfinance#KellyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Kelly-optimal weights (`Σ⁻¹μ`, optionally fractional/normalized). ```typescript /** Kelly-optimal weights (`Σ⁻¹μ`, optionally fractional/normalized). */ export interface KellyInput { /** Dense stored-data ArrayLike; values are snapshotted without coercion. */ mean: ArrayLike; covariance: Matrix; options?: KellyOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - covariance: Matrix; default: not declared - mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - options?: KellyOptions; default: not declared - options.bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - options.budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - options.fraction?: number; default: not declared — Fraction of full Kelly (e.g. 0.5 for half-Kelly). Must be > 0. Default 1. - options.groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - options.longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - options.maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - options.normalize?: boolean; default: not declared — Normalize the Kelly weights to the `budget` (fully invested). Default false (leverage implied). When the raw Kelly weights sum to ≤ 0 (a net-short growth-optimal book), dividing by that total would flip every position's sign — instead the UNnormalized weights are returned with `converged: false` and a `risk.kelly_negative_sum` warning (design law #4: disclose, don't flip). With `constraints`, this flag is a no-op: the constrained solve already pins Σw to the budget. - options.tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - options.transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - options.transactionCosts.perUnitTurnover: number | number[]; default: not declared - options.transactionCosts.previousWeights: number[]; default: not declared - options.turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - options.turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - options.turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance#KnownDataField Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Only finite canonical SDK schema paths or the explicit financial request fields. ```typescript /** Only finite canonical SDK schema paths or the explicit financial request fields. */ export type KnownDataField = 'request.symbol' | 'request.from' | 'request.to' | 'request.from/to' | 'request.limit' | 'request.interval' | 'page' | 'contractVersion' | 'kind' | 'symbol' | 'data' | 'nextCursor' | 'provenance' | 'metadata' | 'assumptions' | 'diagnostics' | 'binding' | 'timestampConvention' | 'issues' | `provenance.${Exclude}` | 'assumptions.conventionsVersion' | `metadata.${keyof DataPageMetadata}` | `metadata.times.${keyof ObservationTimes}` | `data[].times.${keyof ObservationTimes}` | `metadata.freshness.${keyof DataPageMetadata['freshness']}` | `metadata.coverage.${keyof DataPageMetadata['coverage']}` | `metadata.quality.${keyof DataPageMetadata['quality']}` | 'metadata.quality.issues[]' | `metadata.quality.issues[].${'source' | 'code' | 'message'}` | 'data[]' | `data[].${keyof PriceBarRecord | keyof OptionChainResearchRecord}` | `data[].bar.${keyof Bar}` | `data[].terms.${keyof OptionResearchTerms}` | `data[].quote.${keyof OptionChainResearchRecord['quote']}` | `data[].greeks.${keyof OptionQuoteGreeks}` | `data[].greeks.provenance.${'source' | 'model' | 'timestampMs'}` | `${'diagnostics' | 'data[].diagnostics'}.warnings` | `${'diagnostics' | 'data[].diagnostics'}.warnings[]` | `${'diagnostics' | 'data[].diagnostics'}.warnings[].${'code' | 'message' | 'severity' | 'context'}` | 'capabilities' | 'capabilities[]' | 'capabilities[].intervals[]' | `capabilities.${'contractVersion' | 'providerId' | 'providerVersion' | 'capabilities'}` | `capabilities[].${'kind' | 'intervals' | 'maxPageSize' | 'consistency' | 'pointInTime' | 'access' | 'maxWindowMs' | 'maxSessionDays'}` | 'binding.provider' | 'binding.query' | 'binding.query.snapshot' | `binding.provider.${'id' | 'version'}` | `binding.query.${keyof PriceBarsQuery | keyof OptionChainResearchQuery}` | `binding.query.snapshot.${'kind' | 'sessionDate' | 'snapshotId'}`; ``` ### @insiderfinance/totalfinance#LocalVolatilityMonteCarloEstimateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete, assumption-light inputs for one raw local-volatility Monte-Carlo estimate. ```typescript /** Complete, assumption-light inputs for one raw local-volatility Monte-Carlo estimate. */ export interface LocalVolatilityMonteCarloEstimateInput { type: OptionType; spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; dividendYield: number; localVolatility: LocalVolatilityFunction; options: LocalVolatilityMonteCarloOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - localVolatility: LocalVolatilityFunction; default: not declared - localVolatility(level): number; default: not declared - localVolatility(timeToExpiryYears): number; default: not declared - options: LocalVolatilityMonteCarloOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - options.steps?: number; default: not declared — Time steps per path (default 100). - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance#LocalVolatilityPriceMonteCarloRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for the validated local-volatility Monte-Carlo pricer. ```typescript /** One cohesive request for the validated local-volatility Monte-Carlo pricer. */ export interface LocalVolatilityPriceMonteCarloRequest { type: OptionType; input: LocalVolatilityInput; localVolatility: LocalVolatilityFunction; options: LocalVolatilityMonteCarloOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: LocalVolatilityInput; default: not declared - input.dividendYield?: number; default: not declared - input.riskFreeRate: number; default: not declared - input.spot: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared - localVolatility: LocalVolatilityFunction; default: not declared - localVolatility(level): number; default: not declared - localVolatility(timeToExpiryYears): number; default: not declared - options: LocalVolatilityMonteCarloOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - options.steps?: number; default: not declared — Time steps per path (default 100). - type: OptionType; default: not declared ### @insiderfinance/totalfinance#LocalVolatilitySurfaceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LocalVolatilitySurfaceInput { impliedVolatility: (strike: number, timeToExpiryYears: number) => number; market: LocalVolatilityMarket; options?: DupireOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility: (strike: number, timeToExpiryYears: number) => number; default: not declared - impliedVolatility(strike): number; default: not declared - impliedVolatility(timeToExpiryYears): number; default: not declared - market: LocalVolatilityMarket; default: not declared - market.dividendYield?: number; default: not declared - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - options?: DupireOptions; default: not declared - options.floorVolatility?: number; default: not declared — Floor for local vol (default 1e-3) — also the clamp when a local arbitrage drives σ_loc² ≤ 0. - options.logMoneynessStep?: number; default: not declared — Log-moneyness finite-difference step (default 0.01). - options.timeStepYears?: number; default: not declared — Time finite-difference step in years (default 1/365). ### @insiderfinance/totalfinance#MavpInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MavpInput { series: ArrayLike; periods: ArrayLike; parameters?: MavpParameters; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - parameters?: MavpParameters; default: not declared - parameters.maxPeriod?: number; default: not declared - parameters.minPeriod?: number; default: not declared - parameters.movingAverageType?: MovingAverageName; default: not declared - periods: ArrayLike; default: not declared - series: ArrayLike; default: not declared ### @insiderfinance/totalfinance#MaxSharpeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Tangency (max-Sharpe) portfolio. `value.objective` is the Sharpe ratio at the solution. ```typescript /** Tangency (max-Sharpe) portfolio. `value.objective` is the Sharpe ratio at the solution. */ export interface MaxSharpeInput { /** Dense stored-data ArrayLike; values are snapshotted without coercion. */ mean: ArrayLike; covariance: Matrix; options?: MaxSharpeOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - covariance: Matrix; default: not declared - mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - options?: MaxSharpeOptions; default: not declared - options.bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - options.budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - options.groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - options.longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - options.maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - options.riskFreeRatePerPeriod?: number; default: not declared — Risk-free rate **in the same per-period units as `mean` and `covariance`** — a daily-return problem takes a daily rate (0.04/252), not 0.04. Default 0. Named `riskFreeRatePerPeriod` (renamed from `riskFreeRate` pre-1.0) because every other `riskFreeRate` in the library — `@insiderfinance/totalfinance/performance`'s sharpe/sortino/alpha, the backtest report — is an ANNUAL rate that the callee de-annualizes. Passing 0.04 here on daily inputs silently subtracted a 4%-per-DAY hurdle, turning every excess return negative and dropping maxSharpe into its min-variance fallback. One spelling per unit: the compiler now catches it. - options.tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - options.transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - options.transactionCosts.perUnitTurnover: number | number[]; default: not declared - options.transactionCosts.previousWeights: number[]; default: not declared - options.turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - options.turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - options.turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance#MeanVarianceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Mean-variance utility portfolio (`μᵀw − λ/2·wᵀΣw`). `value.objective` is the utility. ```typescript /** Mean-variance utility portfolio (`μᵀw − λ/2·wᵀΣw`). `value.objective` is the utility. */ export interface MeanVarianceInput { /** Dense stored-data ArrayLike; values are snapshotted without coercion. */ mean: ArrayLike; covariance: Matrix; options?: MeanVarianceOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - covariance: Matrix; default: not declared - mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - options?: MeanVarianceOptions; default: not declared - options.bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - options.budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - options.groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - options.longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - options.maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - options.riskAversion?: number; default: not declared — Risk-aversion `λ` in `max μᵀw − (λ/2)·wᵀΣw`. Higher ⇒ more conservative. Default 1. - options.tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - options.transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - options.transactionCosts.perUnitTurnover: number | number[]; default: not declared - options.transactionCosts.previousWeights: number[]; default: not declared - options.turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - options.turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - options.turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance#MonteCarloPortfolioVaRInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonteCarloPortfolioVaRInput { weights: ArrayLike; covariance: Matrix; options?: ParametricPortfolioVaROptions & { samples?: number; seed?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - covariance: Matrix; default: not declared - options?: ParametricPortfolioVaROptions & { samples?: number; seed?: number; }; default: not declared - options.confidence?: number; default: not declared - options.horizonPeriods?: number; default: not declared - options.mean?: ArrayLike; default: not declared — Expected per-period returns per asset (for a non-zero mean). Default all zeros. - options.samples?: number; default: not declared - options.seed?: number; default: not declared - weights: ArrayLike; default: not declared ### @insiderfinance/totalfinance#OHLCField Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OHLCField = 'open' | 'high' | 'low' | 'close'; ``` ### @insiderfinance/totalfinance#ObservationTimes Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ObservationTimes { readonly observedTimestampMs: number | null; readonly availableTimestampMs: number | null; readonly sourceStoredTimestampMs: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - availableTimestampMs: number | null; default: not declared - observedTimestampMs: number | null; default: not declared - sourceStoredTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance#OhlcvInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OhlcvInput { readonly open: number; readonly high: number; readonly low: number; readonly close: number; readonly volume: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared - volume: number; default: not declared ### @insiderfinance/totalfinance#OpeningRangeParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The opening-range knobs: `periods` is the number of leading bars that define the range. ```typescript /** The opening-range knobs: `periods` is the number of leading bars that define the range. */ export interface OpeningRangeParameters { periods: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periods: number; default: not declared ### @insiderfinance/totalfinance#OptionChainResearchQuery Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainResearchQuery { readonly kind: 'option-chain-research'; readonly symbol: string; readonly snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; readonly expirationFrom?: string; readonly expirationTo?: string; readonly rights?: readonly ('call' | 'put')[]; readonly minStrike?: number; readonly maxStrike?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expirationFrom?: string; default: not declared - expirationTo?: string; default: not declared - kind: 'option-chain-research'; default: not declared - maxStrike?: number; default: not declared - minStrike?: number; default: not declared - rights?: readonly ('call' | 'put')[]; default: not declared - snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - snapshot.sessionDate: string; default: not declared - snapshot.snapshotId: string; default: not declared - symbol: string; default: not declared ### @insiderfinance/totalfinance#OptionChainResearchRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainResearchRecord { readonly sourceContractId: string; readonly terms: OptionResearchTerms; readonly times: ObservationTimes; readonly quote: Pick; readonly greeks: OptionQuoteGreeks | null; readonly theoreticalPrice: number | null; readonly openInterestSessionDate: string | null; readonly diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks: OptionQuoteGreeks | null; default: not declared - greeks.delta: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.provenance?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeksProvenance; default: not declared - greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - openInterestSessionDate: string | null; default: not declared - quote: Pick; default: not declared - quote.ask?: number; default: not declared - quote.bid?: number; default: not declared - quote.impliedVolatility?: number; default: not declared - quote.last?: number; default: not declared - quote.mark?: number; default: not declared - quote.mid?: number; default: not declared - quote.openInterest?: number; default: not declared - quote.underlyingPrice?: number; default: not declared - quote.volume?: number; default: not declared - sourceContractId: string; default: not declared - terms: OptionResearchTerms; default: not declared - terms.currency: string | null; default: not declared - terms.expiresAt: number | null; default: not declared - terms.expiry: string; default: not declared - terms.multiplier: number | null; default: not declared - terms.occSymbol: string | null; default: not declared - terms.root: string | null; default: not declared - terms.settlement: NonNullable | null; default: not declared - terms.strike: number; default: not declared - terms.style: import('@insiderfinance/totalfinance/core').OptionStyle | null; default: not declared - terms.termsStatus: 'incomplete' | 'verified'; default: not declared - terms.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - terms.underlying: string; default: not declared - theoreticalPrice: number | null; default: not declared - times: ObservationTimes; default: not declared - times.availableTimestampMs: number | null; default: not declared - times.observedTimestampMs: number | null; default: not declared - times.sourceStoredTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance#OptionChainResearchView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainResearchView { readonly kind: 'option-chain-research'; readonly page: DataPage; readonly continuation: DataContinuation | null; readonly continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - continuation: DataContinuation | null; default: not declared - continuation.binding: DataQueryBinding; default: not declared - continuation.binding.provider: { readonly id: string; readonly version: string; }; default: not declared - continuation.binding.provider.id: string; default: not declared - continuation.binding.provider.version: string; default: not declared - continuation.binding.query: DataQuery; default: not declared - continuation.binding.query.expirationFrom?: string; default: not declared - continuation.binding.query.expirationTo?: string; default: not declared - continuation.binding.query.from: string; default: not declared - continuation.binding.query.interval: DataInterval; default: not declared - continuation.binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - continuation.binding.query.maxStrike?: number; default: not declared - continuation.binding.query.minStrike?: number; default: not declared - continuation.binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - continuation.binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - continuation.binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - continuation.binding.query.snapshot.sessionDate: string; default: not declared - continuation.binding.query.snapshot.snapshotId: string; default: not declared - continuation.binding.query.symbol: string; default: not declared - continuation.binding.query.to: string; default: not declared - continuation.cursor: string; default: not declared - continuation.pins: DataPins; default: not declared - continuation.pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - continuation.pins.consistency: 'snapshot' | 'best-effort'; default: not declared - continuation.pins.datasetId: string; default: not declared - continuation.pins.datasetVersion: string; default: not declared - continuation.pins.sessionDate: string | null; default: not declared - continuation.pins.snapshotId: string | null; default: not declared - continuation.pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - continuation.pins.temporal.interval: DataInterval; default: not declared - continuation.pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - continuation.pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - continuation.version: 2; default: not declared - continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; default: not declared - kind: 'option-chain-research'; default: not declared - page: DataPage; default: not declared ### @insiderfinance/totalfinance#OptionResearchTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionResearchTerms { readonly underlying: OptionContract['underlying']; readonly type: OptionContract['type']; readonly strike: OptionContract['strike']; readonly expiry: OptionContract['expiry']; readonly root: string | null; readonly occSymbol: string | null; readonly multiplier: number | null; readonly currency: string | null; readonly style: OptionContract['style'] | null; readonly settlement: NonNullable | null; readonly expiresAt: number | null; readonly termsStatus: 'verified' | 'incomplete'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string | null; default: not declared - expiresAt: number | null; default: not declared - expiry: string; default: not declared - multiplier: number | null; default: not declared - occSymbol: string | null; default: not declared - root: string | null; default: not declared - settlement: NonNullable | null; default: not declared - strike: number; default: not declared - style: import('@insiderfinance/totalfinance/core').OptionStyle | null; default: not declared - termsStatus: 'incomplete' | 'verified'; default: not declared - type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance#ParametricPortfolioVaRInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ParametricPortfolioVaRInput { weights: ArrayLike; covariance: Matrix; options?: ParametricPortfolioVaROptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - covariance: Matrix; default: not declared - options?: ParametricPortfolioVaROptions; default: not declared - options.confidence?: number; default: not declared - options.horizonPeriods?: number; default: not declared - options.mean?: ArrayLike; default: not declared — Expected per-period returns per asset (for a non-zero mean). Default all zeros. - weights: ArrayLike; default: not declared ### @insiderfinance/totalfinance#PriceBarRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarRecord { readonly bar: Bar; readonly sessionDate: string | null; readonly timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; readonly times: ObservationTimes; readonly source: string | null; readonly provisional: boolean | null; readonly revision: number | null; readonly diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar: Bar; default: not declared - bar.adjusted?: boolean; default: not declared - bar.close: number; default: not declared - bar.high: number; default: not declared - bar.low: number; default: not declared - bar.open: number; default: not declared - bar.symbol: string; default: not declared - bar.timestampMs: number; default: not declared - bar.volume?: number; default: not declared - bar.vwap?: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provisional: boolean | null; default: not declared - revision: number | null; default: not declared - sessionDate: string | null; default: not declared - source: string | null; default: not declared - times: ObservationTimes; default: not declared - times.availableTimestampMs: number | null; default: not declared - times.observedTimestampMs: number | null; default: not declared - times.sourceStoredTimestampMs: number | null; default: not declared - timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared ### @insiderfinance/totalfinance#PriceBarsCheckpoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsCheckpoint { readonly version: 1; readonly kind: 'price-bars-checkpoint'; readonly contractVersion: 2; readonly binding: DataQueryBinding; readonly pages: readonly DataPage[]; readonly next: DataContinuation | null; readonly progress: { readonly status: 'incomplete'; readonly acceptedPages: number; readonly records: number; readonly reads: number; }; readonly paging: PriceBarsPaging; readonly limits: { readonly maxPages: number; readonly maxReads: number; readonly maxRecords: number; }; readonly bytes: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - binding: DataQueryBinding; default: not declared - binding.provider: { readonly id: string; readonly version: string; }; default: not declared - binding.provider.id: string; default: not declared - binding.provider.version: string; default: not declared - binding.query: DataQuery; default: not declared - binding.query.expirationFrom?: string; default: not declared - binding.query.expirationTo?: string; default: not declared - binding.query.from: string; default: not declared - binding.query.interval: DataInterval; default: not declared - binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - binding.query.maxStrike?: number; default: not declared - binding.query.minStrike?: number; default: not declared - binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - binding.query.snapshot.sessionDate: string; default: not declared - binding.query.snapshot.snapshotId: string; default: not declared - binding.query.symbol: string; default: not declared - binding.query.to: string; default: not declared - bytes: number; default: not declared - contractVersion: 2; default: not declared - kind: 'price-bars-checkpoint'; default: not declared - limits: { readonly maxPages: number; readonly maxReads: number; readonly maxRecords: number; }; default: not declared - limits.maxPages: number; default: not declared - limits.maxReads: number; default: not declared - limits.maxRecords: number; default: not declared - next: DataContinuation | null; default: not declared - next.binding: DataQueryBinding; default: not declared - next.binding.provider: { readonly id: string; readonly version: string; }; default: not declared - next.binding.provider.id: string; default: not declared - next.binding.provider.version: string; default: not declared - next.binding.query: DataQuery; default: not declared - next.binding.query.expirationFrom?: string; default: not declared - next.binding.query.expirationTo?: string; default: not declared - next.binding.query.from: string; default: not declared - next.binding.query.interval: DataInterval; default: not declared - next.binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - next.binding.query.maxStrike?: number; default: not declared - next.binding.query.minStrike?: number; default: not declared - next.binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - next.binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - next.binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - next.binding.query.snapshot.sessionDate: string; default: not declared - next.binding.query.snapshot.snapshotId: string; default: not declared - next.binding.query.symbol: string; default: not declared - next.binding.query.to: string; default: not declared - next.cursor: string; default: not declared - next.pins: DataPins; default: not declared - next.pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - next.pins.consistency: 'snapshot' | 'best-effort'; default: not declared - next.pins.datasetId: string; default: not declared - next.pins.datasetVersion: string; default: not declared - next.pins.sessionDate: string | null; default: not declared - next.pins.snapshotId: string | null; default: not declared - next.pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - next.pins.temporal.interval: DataInterval; default: not declared - next.pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - next.pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - next.version: 2; default: not declared - pages: readonly DataPage[]; default: not declared - paging: PriceBarsPaging; default: not declared - paging.requested: { readonly mode: 'automatic'; } | { readonly mode: 'explicit'; readonly size: number; }; default: not declared - paging.requested.mode: ('automatic') | ('explicit'); default: not declared - paging.requested.size: number; default: not declared - paging.state: { readonly status: 'unresolved'; } | { readonly effectiveSize: number; readonly status: 'resolved'; }; default: not declared - paging.state.effectiveSize: number; default: not declared - paging.state.status: ('resolved') | ('unresolved'); default: not declared - progress: { readonly acceptedPages: number; readonly reads: number; readonly records: number; readonly status: 'incomplete'; }; default: not declared - progress.acceptedPages: number; default: not declared - progress.reads: number; default: not declared - progress.records: number; default: not declared - progress.status: 'incomplete'; default: not declared - version: 1; default: not declared ### @insiderfinance/totalfinance#PriceBarsPageFacts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsPageFacts extends CommonPageFacts { readonly timestampConvention: PriceBarRecord['timestampConvention']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - access?: 'unknown' | 'granted' | 'denied'; default: not declared - adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - consistency: 'snapshot' | 'best-effort'; default: not declared - coverage?: { readonly end: string | null; readonly start: string | null; readonly status: 'continuous' | 'observed-only' | 'unknown'; }; default: not declared - coverage.end: string | null; default: not declared - coverage.start: string | null; default: not declared - coverage.status: 'continuous' | 'unknown' | 'observed-only'; default: not declared - dataset: { readonly id: string; readonly version: string; }; default: not declared - dataset.id: string; default: not declared - dataset.version: string; default: not declared - freshness?: { readonly configuredDelayMs: number | null; readonly evaluatedTimestampMs: number | null; readonly status: 'current' | 'stale' | 'session-closed' | 'historical' | 'end-of-day' | 'stored' | 'unknown'; }; default: not declared - freshness.configuredDelayMs: number | null; default: not declared - freshness.evaluatedTimestampMs: number | null; default: not declared - freshness.status: 'stale' | 'historical' | 'current' | 'unknown' | 'session-closed' | 'end-of-day' | 'stored'; default: not declared - quality?: { readonly issues: readonly { source: string; code: string; message: string; }[]; readonly status: 'complete' | 'partial' | 'unavailable' | 'unknown'; }; default: not declared - quality.issues: readonly { source: string; code: string; message: string; }[]; default: not declared - quality.status: 'unavailable' | 'complete' | 'unknown' | 'partial'; default: not declared - receivedTimestampMs: number; default: not declared - requestId?: string; default: not declared - sessionDate?: string | null; default: not declared - snapshotId?: string | null; default: not declared - sourceGeneratedTimestampMs?: number | null; default: not declared - sourceSymbol?: string; default: not declared - times?: ObservationTimes; default: not declared - times.availableTimestampMs: number | null; default: not declared - times.observedTimestampMs: number | null; default: not declared - times.sourceStoredTimestampMs: number | null; default: not declared - timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared ### @insiderfinance/totalfinance#PriceBarsPaging Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsPaging { readonly requested: { readonly mode: 'automatic'; } | { readonly mode: 'explicit'; readonly size: number; }; readonly state: { readonly status: 'unresolved'; } | { readonly status: 'resolved'; readonly effectiveSize: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - requested: { readonly mode: 'automatic'; } | { readonly mode: 'explicit'; readonly size: number; }; default: not declared - requested.mode: ('automatic') | ('explicit'); default: not declared - requested.size: number; default: not declared - state: { readonly status: 'unresolved'; } | { readonly status: 'resolved'; readonly effectiveSize: number; }; default: not declared - state.effectiveSize: number; default: not declared - state.status: ('resolved') | ('unresolved'); default: not declared ### @insiderfinance/totalfinance#PriceBarsQuery Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsQuery { readonly kind: 'price-bars'; readonly symbol: string; readonly interval: DataInterval; readonly from: string; readonly to: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: string; default: not declared - interval: DataInterval; default: not declared - kind: 'price-bars'; default: not declared - symbol: string; default: not declared - to: string; default: not declared ### @insiderfinance/totalfinance#PriceBarsSelections Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsSelections { readonly closePrices: readonly number[]; readonly ohlcvBars: readonly OhlcvInput[]; readonly bars: readonly TimestampedOhlcvInput[]; readonly issues: readonly ResearchBarIssue[]; readonly selection: ResearchBarSelection; readonly selections: readonly [ 'closePrices', 'ohlcvBars', 'bars' ]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bars: readonly Readonly[]; default: not declared - closePrices: readonly number[]; default: not declared - issues: readonly ResearchBarIssue[]; default: not declared - ohlcvBars: readonly OhlcvInput[]; default: not declared - selection: ResearchBarSelection; default: not declared - selection.decisions: readonly ResearchBarChoice[]; default: not declared - selection.sourceRows: readonly RowReference[]; default: not declared - selection.version: 1; default: not declared - selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared ### @insiderfinance/totalfinance#PriceBarsView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsView extends PriceBarsSelections { readonly kind: 'price-bars'; readonly page: DataPage; readonly continuation: DataContinuation | null; readonly continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; resolve(choice: ResearchBarChoice): PriceBarsView; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bars: readonly Readonly[]; default: not declared - closePrices: readonly number[]; default: not declared - continuation: DataContinuation | null; default: not declared - continuation.binding: DataQueryBinding; default: not declared - continuation.binding.provider: { readonly id: string; readonly version: string; }; default: not declared - continuation.binding.provider.id: string; default: not declared - continuation.binding.provider.version: string; default: not declared - continuation.binding.query: DataQuery; default: not declared - continuation.binding.query.expirationFrom?: string; default: not declared - continuation.binding.query.expirationTo?: string; default: not declared - continuation.binding.query.from: string; default: not declared - continuation.binding.query.interval: DataInterval; default: not declared - continuation.binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - continuation.binding.query.maxStrike?: number; default: not declared - continuation.binding.query.minStrike?: number; default: not declared - continuation.binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - continuation.binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - continuation.binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - continuation.binding.query.snapshot.sessionDate: string; default: not declared - continuation.binding.query.snapshot.snapshotId: string; default: not declared - continuation.binding.query.symbol: string; default: not declared - continuation.binding.query.to: string; default: not declared - continuation.cursor: string; default: not declared - continuation.pins: DataPins; default: not declared - continuation.pins.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - continuation.pins.consistency: 'snapshot' | 'best-effort'; default: not declared - continuation.pins.datasetId: string; default: not declared - continuation.pins.datasetVersion: string; default: not declared - continuation.pins.sessionDate: string | null; default: not declared - continuation.pins.snapshotId: string | null; default: not declared - continuation.pins.temporal: { readonly interval: DataInterval; readonly kind: 'price-bars'; readonly timestampConvention: PriceBarRecord['timestampConvention']; } | { readonly kind: 'option-chain-research'; }; default: not declared - continuation.pins.temporal.interval: DataInterval; default: not declared - continuation.pins.temporal.kind: ('option-chain-research') | ('price-bars'); default: not declared - continuation.pins.temporal.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - continuation.version: 2; default: not declared - continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; default: not declared - issues: readonly ResearchBarIssue[]; default: not declared - kind: 'price-bars'; default: not declared - ohlcvBars: readonly OhlcvInput[]; default: not declared - page: DataPage; default: not declared - resolve: (choice: ResearchBarChoice) => PriceBarsView; default: not declared - resolve(choice): ResearchBarChoice; default: not declared - resolve(choice).action: ('correct') | ('exclude' | 'use'); default: not declared - resolve(choice).corrections: readonly { readonly row: RowReference; readonly values: Partial>; }[]; default: not declared - resolve(choice).reason: string; default: not declared - resolve(choice).rows?: readonly RowReference[]; default: not declared - selection: ResearchBarSelection; default: not declared - selection.decisions: readonly ResearchBarChoice[]; default: not declared - selection.sourceRows: readonly RowReference[]; default: not declared - selection.version: 1; default: not declared - selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared ### @insiderfinance/totalfinance#PriceBarsWindow Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PriceBarsWindow = CurrentPriceBarsWindow | LegacyPriceBarsWindow; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - binding: DataQueryBinding; default: not declared - binding.provider: { readonly id: string; readonly version: string; }; default: not declared - binding.provider.id: string; default: not declared - binding.provider.version: string; default: not declared - binding.query: DataQuery; default: not declared - binding.query.expirationFrom?: string; default: not declared - binding.query.expirationTo?: string; default: not declared - binding.query.from: string; default: not declared - binding.query.interval: DataInterval; default: not declared - binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - binding.query.maxStrike?: number; default: not declared - binding.query.minStrike?: number; default: not declared - binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - binding.query.snapshot.sessionDate: string; default: not declared - binding.query.snapshot.snapshotId: string; default: not declared - binding.query.symbol: string; default: not declared - binding.query.to: string; default: not declared - bytes: number; default: not declared - contractVersion: 2; default: not declared - kind: 'price-bars-window'; default: not declared - pages: readonly DataPage[]; default: not declared - pagination: ({ readonly status: 'terminal'; readonly pageSize: number; readonly pageCalls: number; readonly reads: number; readonly records: number; }) | ({ readonly status: 'terminal'; readonly pageSize: number; readonly pageCalls: number; readonly records: number; readonly reads?: never; }); default: not declared - pagination.pageCalls: number; default: not declared - pagination.pageSize: number; default: not declared - pagination.reads?: (never) | (number); default: not declared - pagination.records: number; default: not declared - pagination.status: 'terminal'; default: not declared - request: PriceBarsWindowRequest; default: not declared - request.from: string; default: not declared - request.interval: DataInterval; default: not declared - request.symbol: string; default: not declared - request.to: string; default: not declared - version: (1) | (2); default: not declared ### @insiderfinance/totalfinance#PriceBarsWindowOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsWindowOptions extends DataConnectionOptions { readonly signal?: AbortSignal; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxPages?: number; default: not declared - maxReads?: number; default: not declared - maxRecords?: number; default: not declared - pageSize?: number; default: not declared - signal?: AbortSignal; default: not declared ### @insiderfinance/totalfinance#PriceBarsWindowRequest Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Financial query without the source protocol discriminator. ```typescript /** Financial query without the source protocol discriminator. */ export type PriceBarsWindowRequest = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: string; default: not declared - interval: DataInterval; default: not declared - symbol: string; default: not declared - to: string; default: not declared ### @insiderfinance/totalfinance#PriceBarsWindowView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceBarsWindowView extends PriceBarsSelections { readonly kind: 'price-bars-window'; readonly window: PriceBarsWindow; resolve(choice: ResearchBarChoice): PriceBarsWindowView; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bars: readonly Readonly[]; default: not declared - closePrices: readonly number[]; default: not declared - issues: readonly ResearchBarIssue[]; default: not declared - kind: 'price-bars-window'; default: not declared - ohlcvBars: readonly OhlcvInput[]; default: not declared - resolve: (choice: ResearchBarChoice) => PriceBarsWindowView; default: not declared - resolve(choice): ResearchBarChoice; default: not declared - resolve(choice).action: ('correct') | ('exclude' | 'use'); default: not declared - resolve(choice).corrections: readonly { readonly row: RowReference; readonly values: Partial>; }[]; default: not declared - resolve(choice).reason: string; default: not declared - resolve(choice).rows?: readonly RowReference[]; default: not declared - selection: ResearchBarSelection; default: not declared - selection.decisions: readonly ResearchBarChoice[]; default: not declared - selection.sourceRows: readonly RowReference[]; default: not declared - selection.version: 1; default: not declared - selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared - window: PriceBarsWindow; default: not declared - window.binding: DataQueryBinding; default: not declared - window.binding.provider: { readonly id: string; readonly version: string; }; default: not declared - window.binding.provider.id: string; default: not declared - window.binding.provider.version: string; default: not declared - window.binding.query: DataQuery; default: not declared - window.binding.query.expirationFrom?: string; default: not declared - window.binding.query.expirationTo?: string; default: not declared - window.binding.query.from: string; default: not declared - window.binding.query.interval: DataInterval; default: not declared - window.binding.query.kind: ('option-chain-research') | ('price-bars'); default: not declared - window.binding.query.maxStrike?: number; default: not declared - window.binding.query.minStrike?: number; default: not declared - window.binding.query.rights?: readonly ('call' | 'put')[]; default: not declared - window.binding.query.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - window.binding.query.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - window.binding.query.snapshot.sessionDate: string; default: not declared - window.binding.query.snapshot.snapshotId: string; default: not declared - window.binding.query.symbol: string; default: not declared - window.binding.query.to: string; default: not declared - window.bytes: number; default: not declared - window.contractVersion: 2; default: not declared - window.kind: 'price-bars-window'; default: not declared - window.pages: readonly DataPage[]; default: not declared - window.pagination: ({ readonly pageCalls: number; readonly pageSize: number; readonly reads: number; readonly records: number; readonly status: 'terminal'; }) | ({ readonly pageCalls: number; readonly pageSize: number; readonly reads?: never; readonly records: number; readonly status: 'terminal'; }); default: not declared - window.pagination.pageCalls: number; default: not declared - window.pagination.pageSize: number; default: not declared - window.pagination.reads?: (never) | (number); default: not declared - window.pagination.records: number; default: not declared - window.pagination.status: 'terminal'; default: not declared - window.request: PriceBarsWindowRequest; default: not declared - window.request.from: string; default: not declared - window.request.interval: DataInterval; default: not declared - window.request.symbol: string; default: not declared - window.request.to: string; default: not declared - window.version: (1) | (2); default: not declared ### @insiderfinance/totalfinance#RealizedImpliedInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Realized-vs-implied spread: `impliedVolatility − realizedVolatility` in volatility points (positive ⇒ vol premium). BOTH inputs are ANNUALIZED decimals (0.20 = 20%): a technical-analysis estimator supplies that with `annualization: 252` on daily bars — a per-bar σ here is wrong by √252. ```typescript /** * Realized-vs-implied spread: `impliedVolatility − realizedVolatility` in volatility points (positive ⇒ * vol premium). BOTH inputs are ANNUALIZED decimals (0.20 = 20%): a technical-analysis estimator * supplies that with `annualization: 252` on daily bars — a per-bar σ here is wrong by √252. */ export interface RealizedImpliedInput { /** Annualized implied volatility (decimal). */ impliedVolatility: number; /** Annualized realized volatility (decimal) — e.g. `historicalVolatility(closes, { period, annualization: 252 })`. */ realizedVolatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility: number; default: not declared — Annualized implied volatility (decimal). - realizedVolatility: number; default: not declared — Annualized realized volatility (decimal) — e.g. `historicalVolatility(closes, { period, annualization: 252 })`. ### @insiderfinance/totalfinance#ResearchBarChoice Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ResearchBarChoice = { readonly action: 'exclude' | 'use'; readonly rows?: readonly RowReference[]; readonly reason: string; } | { readonly action: 'correct'; readonly corrections: readonly { readonly row: RowReference; readonly values: Partial>; }[]; readonly reason: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - action: ('correct') | ('exclude' | 'use'); default: not declared - corrections: readonly { readonly row: RowReference; readonly values: Partial>; }[]; default: not declared - reason: string; default: not declared - rows?: readonly RowReference[]; default: not declared ### @insiderfinance/totalfinance#ResearchBarIssue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchBarIssue extends RowReference { readonly rule: 'low_above_high' | 'open_outside_range' | 'close_outside_range'; readonly fields: readonly OHLCField[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fields: readonly OHLCField[]; default: not declared - pageIndex: number; default: not declared - rowIndex: number; default: not declared - rule: 'low_above_high' | 'open_outside_range' | 'close_outside_range'; default: not declared ### @insiderfinance/totalfinance#ResearchBarSelection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchBarSelection { readonly version: 1; readonly decisions: readonly ResearchBarChoice[]; readonly sourceRows: readonly RowReference[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - decisions: readonly ResearchBarChoice[]; default: not declared - sourceRows: readonly RowReference[]; default: not declared - version: 1; default: not declared ### @insiderfinance/totalfinance#RowReference Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RowReference { readonly pageIndex: number; readonly rowIndex: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - pageIndex: number; default: not declared - rowIndex: number; default: not declared ### @insiderfinance/totalfinance#SabrBartlettGreeksInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SabrBartlettGreeksInput { type: OptionType; input: SabrInput; parameters: SabrParameters; options?: SabrBartlettOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: SabrInput; default: not declared - input.dividendYield?: number; default: not declared - input.forward?: number; default: not declared - input.riskFreeRate?: number; default: not declared — Discount/forward rate (default 0). - input.spot?: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared — Time to expiry in years. - options?: SabrBartlettOptions; default: not declared - options.volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion: `'lognormal'` (Black, default) or `'normal'` (Bachelier). - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - type: OptionType; default: not declared ### @insiderfinance/totalfinance#SabrMonteCarloEstimateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete, assumption-light inputs for one raw SABR Monte-Carlo estimate. ```typescript /** Complete, assumption-light inputs for one raw SABR Monte-Carlo estimate. */ export interface SabrMonteCarloEstimateInput { type: OptionType; forward: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; parameters: SabrParameters; options: SabrMonteCarloOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - options: SabrMonteCarloOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - options.steps?: number; default: not declared — Time steps per path (default 100). - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance#SabrPriceMonteCarloRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for the validated SABR Monte-Carlo pricer. ```typescript /** One cohesive request for the validated SABR Monte-Carlo pricer. */ export interface SabrPriceMonteCarloRequest { type: OptionType; input: SabrInput; parameters: SabrParameters; options: SabrMonteCarloOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: SabrInput; default: not declared - input.dividendYield?: number; default: not declared - input.forward?: number; default: not declared - input.riskFreeRate?: number; default: not declared — Discount/forward rate (default 0). - input.spot?: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared — Time to expiry in years. - options: SabrMonteCarloOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - options.steps?: number; default: not declared — Time steps per path (default 100). - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - type: OptionType; default: not declared ### @insiderfinance/totalfinance#SabrPriceRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for the validated Hagan SABR pricer. ```typescript /** One cohesive request for the validated Hagan SABR pricer. */ export interface SabrPriceRequest { type: OptionType; input: SabrInput; parameters: SabrParameters; options?: SabrOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: SabrInput; default: not declared - input.dividendYield?: number; default: not declared - input.forward?: number; default: not declared - input.riskFreeRate?: number; default: not declared — Discount/forward rate (default 0). - input.spot?: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared — Time to expiry in years. - options?: SabrOptions; default: not declared - options.extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the SABR level `α` — extending the `vega` convention; `phi = 0` (forward model). Hagan's vol is smooth, so the finite differences are stable. - options.greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - options.volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion (default `'lognormal'`). - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - type: OptionType; default: not declared ### @insiderfinance/totalfinance#SabrVolatilityRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for a Hagan SABR volatility evaluation. ```typescript /** One cohesive request for a Hagan SABR volatility evaluation. */ export interface SabrVolatilityRequest { input: SabrVolatilityInput; parameters: SabrParameters; options?: SabrVolatilityOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - input: SabrVolatilityInput; default: not declared - input.forward: number; default: not declared - input.strike: number; default: not declared - input.timeToExpiryYears: number; default: not declared — Time to expiry in years. - options?: SabrVolatilityOptions; default: not declared - options.volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion: `'lognormal'` (Black, default) or `'normal'` (Bachelier). - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). ### @insiderfinance/totalfinance#ScenarioGridInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioGridInput { greeks: PositionGreeks; spotShocks: readonly Shock[]; volatilityShocks: readonly Shock[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: PositionGreeks; default: not declared - greeks.charm?: number; default: not declared — ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. - greeks.color?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.delta?: number; default: not declared — ∂V/∂S per $1 of spot. - greeks.deltaRate?: number; default: not declared — ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. - greeks.gamma?: number; default: not declared — ∂²V/∂S² per $1². - greeks.lambda?: number | null; default: not declared — Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. - greeks.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. - greeks.rho?: number; default: not declared — ∂V/∂r per 1% rate (0.01), as the options package reports it. - greeks.rhoConvexity?: number; default: not declared — ∂²V/∂r² per (1%)² — rho convexity. Optional. - greeks.speed?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.spot?: number; default: not declared — Reference spot, required to resolve percent spot shocks into price moves. - greeks.theta?: number; default: not declared — ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. - greeks.thetaConvexity?: number; default: not declared — ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. - greeks.thetaRate?: number; default: not declared — ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. - greeks.ultima?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.value: number; default: not declared — Current mark value of the position (per unit). - greeks.vanna?: number; default: not declared — ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. - greeks.vega?: number; default: not declared — ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. - greeks.vera?: number; default: not declared — ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. - greeks.veta?: number; default: not declared — ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. - greeks.vomma?: number; default: not declared — ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. - greeks.zomma?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - spotShocks: readonly Shock[]; default: not declared - volatilityShocks: readonly Shock[]; default: not declared ### @insiderfinance/totalfinance#SchemaCheckContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The validation context threaded through every schema's `_check` — exported so a consumer subclassing {@link Schema} can NAME the parameter of the method they must implement (3B.2 nameability: an abstract method whose parameter type is unexported is a contract a consumer can satisfy only by structural accident). ```typescript /** * The validation context threaded through every schema's `_check` — exported so a consumer * subclassing {@link Schema} can NAME the parameter of the method they must implement (3B.2 * nameability: an abstract method whose parameter type is unexported is a contract a consumer * can satisfy only by structural accident). */ export interface SchemaCheckContext { mode: ValidationMode; path: (string | number)[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - mode: ValidationMode; default: not declared - path: (string | number)[]; default: not declared ### @insiderfinance/totalfinance#SkewInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SkewInput { quotes: OptionQuote[]; market: SkewMarket; config: SkewConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config: SkewConfig; default: not declared - config.expiry: string; default: not declared — The expiry to analyze (ISO label present in the chain). - config.model?: SurfaceModel; default: not declared - config.priceSource?: PriceSource; default: not declared - config.riskReversalConvention?: RiskReversalConvention; default: not declared — Risk-reversal sign convention (default `callMinusPut`). - market: SkewMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.riskFreeRate: number; default: not declared - market.spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. - quotes: OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#SourceOptionChainPage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SourceOptionChainPage { readonly data: readonly OptionChainResearchRecord[]; readonly nextCursor: string | null; readonly facts: CommonPageFacts; readonly diagnostics?: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - data: readonly OptionChainResearchRecord[]; default: not declared - diagnostics?: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - facts: CommonPageFacts; default: not declared - facts.access?: 'unknown' | 'granted' | 'denied'; default: not declared - facts.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - facts.consistency: 'snapshot' | 'best-effort'; default: not declared - facts.coverage?: { readonly end: string | null; readonly start: string | null; readonly status: 'continuous' | 'observed-only' | 'unknown'; }; default: not declared - facts.coverage.end: string | null; default: not declared - facts.coverage.start: string | null; default: not declared - facts.coverage.status: 'continuous' | 'unknown' | 'observed-only'; default: not declared - facts.dataset: { readonly id: string; readonly version: string; }; default: not declared - facts.dataset.id: string; default: not declared - facts.dataset.version: string; default: not declared - facts.freshness?: { readonly configuredDelayMs: number | null; readonly evaluatedTimestampMs: number | null; readonly status: 'current' | 'stale' | 'session-closed' | 'historical' | 'end-of-day' | 'stored' | 'unknown'; }; default: not declared - facts.freshness.configuredDelayMs: number | null; default: not declared - facts.freshness.evaluatedTimestampMs: number | null; default: not declared - facts.freshness.status: 'stale' | 'historical' | 'current' | 'unknown' | 'session-closed' | 'end-of-day' | 'stored'; default: not declared - facts.quality?: { readonly issues: readonly { source: string; code: string; message: string; }[]; readonly status: 'complete' | 'partial' | 'unavailable' | 'unknown'; }; default: not declared - facts.quality.issues: readonly { source: string; code: string; message: string; }[]; default: not declared - facts.quality.status: 'unavailable' | 'complete' | 'unknown' | 'partial'; default: not declared - facts.receivedTimestampMs: number; default: not declared - facts.requestId?: string; default: not declared - facts.sessionDate?: string | null; default: not declared - facts.snapshotId?: string | null; default: not declared - facts.sourceGeneratedTimestampMs?: number | null; default: not declared - facts.sourceSymbol?: string; default: not declared - facts.times?: ObservationTimes; default: not declared - facts.times.availableTimestampMs: number | null; default: not declared - facts.times.observedTimestampMs: number | null; default: not declared - facts.times.sourceStoredTimestampMs: number | null; default: not declared - nextCursor: string | null; default: not declared ### @insiderfinance/totalfinance#SourcePriceBarRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SourcePriceBarRecord { readonly bar: Omit; readonly sessionDate?: string | null; readonly times?: ObservationTimes; readonly source?: string | null; readonly provisional?: boolean | null; readonly revision?: number | null; readonly diagnostics?: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar: Omit; default: not declared - bar.adjusted?: boolean; default: not declared - bar.close: number; default: not declared - bar.high: number; default: not declared - bar.low: number; default: not declared - bar.open: number; default: not declared - bar.timestampMs: number; default: not declared - bar.volume?: number; default: not declared - bar.vwap?: number; default: not declared - diagnostics?: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provisional?: boolean | null; default: not declared - revision?: number | null; default: not declared - sessionDate?: string | null; default: not declared - source?: string | null; default: not declared - times?: ObservationTimes; default: not declared - times.availableTimestampMs: number | null; default: not declared - times.observedTimestampMs: number | null; default: not declared - times.sourceStoredTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance#SourcePriceBarsPage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SourcePriceBarsPage { readonly data: readonly SourcePriceBarRecord[]; readonly nextCursor: string | null; readonly facts: PriceBarsPageFacts; readonly diagnostics?: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - data: readonly SourcePriceBarRecord[]; default: not declared - diagnostics?: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - facts: PriceBarsPageFacts; default: not declared - facts.access?: 'unknown' | 'granted' | 'denied'; default: not declared - facts.adjustment: 'unadjusted' | 'split' | 'split-and-dividend' | 'unknown'; default: not declared - facts.consistency: 'snapshot' | 'best-effort'; default: not declared - facts.coverage?: { readonly end: string | null; readonly start: string | null; readonly status: 'continuous' | 'observed-only' | 'unknown'; }; default: not declared - facts.coverage.end: string | null; default: not declared - facts.coverage.start: string | null; default: not declared - facts.coverage.status: 'continuous' | 'unknown' | 'observed-only'; default: not declared - facts.dataset: { readonly id: string; readonly version: string; }; default: not declared - facts.dataset.id: string; default: not declared - facts.dataset.version: string; default: not declared - facts.freshness?: { readonly configuredDelayMs: number | null; readonly evaluatedTimestampMs: number | null; readonly status: 'current' | 'stale' | 'session-closed' | 'historical' | 'end-of-day' | 'stored' | 'unknown'; }; default: not declared - facts.freshness.configuredDelayMs: number | null; default: not declared - facts.freshness.evaluatedTimestampMs: number | null; default: not declared - facts.freshness.status: 'stale' | 'historical' | 'current' | 'unknown' | 'session-closed' | 'end-of-day' | 'stored'; default: not declared - facts.quality?: { readonly issues: readonly { source: string; code: string; message: string; }[]; readonly status: 'complete' | 'partial' | 'unavailable' | 'unknown'; }; default: not declared - facts.quality.issues: readonly { source: string; code: string; message: string; }[]; default: not declared - facts.quality.status: 'unavailable' | 'complete' | 'unknown' | 'partial'; default: not declared - facts.receivedTimestampMs: number; default: not declared - facts.requestId?: string; default: not declared - facts.sessionDate?: string | null; default: not declared - facts.snapshotId?: string | null; default: not declared - facts.sourceGeneratedTimestampMs?: number | null; default: not declared - facts.sourceSymbol?: string; default: not declared - facts.times?: ObservationTimes; default: not declared - facts.times.availableTimestampMs: number | null; default: not declared - facts.times.observedTimestampMs: number | null; default: not declared - facts.times.sourceStoredTimestampMs: number | null; default: not declared - facts.timestampConvention: 'session-label-midnight-utc' | 'interval-start' | 'session-start'; default: not declared - nextCursor: string | null; default: not declared ### @insiderfinance/totalfinance#SurfaceLocalVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SurfaceLocalVolatilityInput { surface: VolatilitySurface; market: LocalVolatilityMarket; options?: DupireOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - market: LocalVolatilityMarket; default: not declared - market.dividendYield?: number; default: not declared - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - options?: DupireOptions; default: not declared - options.floorVolatility?: number; default: not declared — Floor for local vol (default 1e-3) — also the clamp when a local arbitrage drives σ_loc² ≤ 0. - options.logMoneynessStep?: number; default: not declared — Log-moneyness finite-difference step (default 0.01). - options.timeStepYears?: number; default: not declared — Time finite-difference step in years (default 1/365). - surface: VolatilitySurface; default: not declared - surface.arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - surface.arbitrage().return.arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - surface.arbitrage().return.assumptions: { conventionsVersion: string; tolerance: number; butterflyPoints: number; calendarPoints: number; step: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - surface.arbitrage().return.assumptions.butterflyPoints: number; default: not declared - surface.arbitrage().return.assumptions.calendarPoints: number; default: not declared - surface.arbitrage().return.assumptions.conventionsVersion: string; default: not declared - surface.arbitrage().return.assumptions.step: number; default: not declared - surface.arbitrage().return.assumptions.tolerance: number; default: not declared - surface.arbitrage().return.checks: { calendar: boolean; butterfly: boolean; }; default: not declared — Per-check pass/fail summary. - surface.arbitrage().return.checks.butterfly: boolean; default: not declared - surface.arbitrage().return.checks.calendar: boolean; default: not declared - surface.arbitrage().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - surface.arbitrage().return.violations: import('@insiderfinance/totalfinance/volatility').ArbitrageViolation[]; default: not declared - surface.arbitrage(options)?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions | undefined; default: not declared - surface.arbitrage(options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - surface.arbitrage(options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - surface.arbitrage(options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - surface.arbitrage(options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - surface.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - surface.assumptions.asOf?: number; default: not declared - surface.assumptions.calendar?: string; default: not declared - surface.assumptions.calendarVersion?: string; default: not declared - surface.assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - surface.assumptions.compounding.periodsPerYear: number; default: not declared - surface.assumptions.compounding.type: 'periodic'; default: not declared - surface.assumptions.conventionsVersion: string; default: not declared - surface.assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - surface.assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - surface.assumptions.engine?: string; default: not declared - surface.assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - surface.assumptions.model?: string; default: not declared - surface.assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - surface.assumptions.shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; default: not declared - surface.assumptions.shock.parallel: number; default: not declared — Additive parallel shift applied to every stored IV (in vol points, e.g. `0.02` = +2 vol). - surface.assumptions.shock.skewTilt: number; default: not declared — Skew rotation: adds `skewTilt · k` where `k = ln(K/forward)` (log-moneyness). - surface.assumptions.shock.sticky: 'strike' | 'moneyness'; default: not declared — Which quantity the tilt is pinned to: `'strike'` (default) or `'moneyness'`. - surface.assumptions.timeToExpiryConvention?: never; default: not declared - surface.assumptions.timeToExpiryYears?: number; default: not declared - surface.assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - surface.assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - surface.assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - surface.assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - surface.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - surface.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - surface.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - surface.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - surface.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - surface.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - surface.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - surface.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - surface.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - surface.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - surface.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - surface.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - surface.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - surface.diagnostics.selection.selected.name: string; default: not declared - surface.diagnostics.selection.selected.version?: string; default: not declared - surface.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - surface.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - surface.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - surface.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - surface.essvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - surface.essvi.phi.eta: number; default: not declared - surface.essvi.phi.gamma: number; default: not declared - surface.essvi.phi.kind: ('heston') | ('power-law'); default: not declared - surface.essvi.phi.lambda: number; default: not declared - surface.essvi.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - surface.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - surface.heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - surface.heston.kappa: number; default: not declared — Mean-reversion speed κ. - surface.heston.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - surface.heston.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - surface.heston.theta: number; default: not declared — Long-run variance θ. - surface.heston.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - surface.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - surface.impliedVolatility(expiry): string | number; default: not declared - surface.impliedVolatility(strike): number; default: not declared - surface.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - surface.impliedVolatilityByDelta(callDelta): number; default: not declared - surface.impliedVolatilityByDelta(expiry): string | number; default: not declared - surface.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - surface.impliedVolatilityByMoneyness(expiry): string | number; default: not declared - surface.impliedVolatilityByMoneyness(moneyness): number; default: not declared - surface.impliedVolatilityByMoneyness(options)?: { forward?: boolean; }; default: not declared - surface.impliedVolatilityByMoneyness(options).forward?: boolean; default: not declared - surface.lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - surface.lookup().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - surface.lookup().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - surface.lookup().return.extrapolated: boolean; default: not declared - surface.lookup().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - surface.lookup().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - surface.lookup(expiry): string | number; default: not declared - surface.lookup(strike): number; default: not declared - surface.model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - surface.points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - surface.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - surface.shock(__1)?: { sticky?: 'strike' | 'moneyness'; }; default: not declared - surface.shock(__1).sticky?: 'strike' | 'moneyness'; default: not declared - surface.shock(shifts): { parallel?: number; skewTilt?: number; }; default: not declared - surface.shock(shifts).parallel?: number; default: not declared - surface.shock(shifts).skewTilt?: number; default: not declared - surface.slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - surface.slice().return.deltas: number[]; default: not declared — Call-delta `e^{−qt}·N(d1)` at each strike (the smile's delta axis, for skew lookups). - surface.slice().return.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The globally-calibrated eSSVI parameters when `model: 'essvi'` (shared across all slices). - surface.slice().return.expiry: string; default: not declared - surface.slice().return.forward: number; default: not declared — Forward `S·e^{(r−q)t}`. - surface.slice().return.heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The globally-calibrated Heston parameters when `model: 'heston'` (shared across all slices). - surface.slice().return.impliedVolatilities: number[]; default: not declared - surface.slice().return.sabr?: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared — Fitted SABR parameters when `model: 'sabr'` (absent if the slice fell back to interpolation). - surface.slice().return.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The globally-calibrated SSVI parameters when `model: 'ssvi'` (shared across all slices). - surface.slice().return.strikes: number[]; default: not declared - surface.slice().return.svi?: import('@insiderfinance/totalfinance/volatility').SVIParameters; default: not declared — Fitted raw-SVI parameters when `model: 'svi'` (absent if the slice fell back to interpolation). - surface.slice().return.timeToExpiryYears: number; default: not declared — Time to expiry in years (ACT/365F). - surface.slice(expiry): string | number; default: not declared - surface.slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - surface.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - surface.ssvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function. - surface.ssvi.phi.eta: number; default: not declared - surface.ssvi.phi.gamma: number; default: not declared - surface.ssvi.phi.kind: ('heston') | ('power-law'); default: not declared - surface.ssvi.phi.lambda: number; default: not declared - surface.ssvi.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - surface.ssvi.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - surface.toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - surface.toJSON().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - surface.toJSON().return.config: { riskFreeRate: number; dividendYield: number; sabrBeta: number; sabrVolatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; smoothingBandwidth?: number; cosineExpansionTerms: number; }; default: not declared — Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. - surface.toJSON().return.config.cosineExpansionTerms: number; default: not declared - surface.toJSON().return.config.dividendYield: number; default: not declared - surface.toJSON().return.config.riskFreeRate: number; default: not declared - surface.toJSON().return.config.sabrBeta: number; default: not declared - surface.toJSON().return.config.sabrVolatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - surface.toJSON().return.config.smoothingBandwidth?: number; default: not declared - surface.toJSON().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - surface.toJSON().return.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`. - surface.toJSON().return.heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`. - surface.toJSON().return.model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - surface.toJSON().return.points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - surface.toJSON().return.referenceSpot: number; default: not declared - surface.toJSON().return.schemaVersion: string; default: not declared - surface.toJSON().return.slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - surface.toJSON().return.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`. - surface.toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). ### @insiderfinance/totalfinance#TimestampedOhlcvInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type TimestampedOhlcvInput = Readonly; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjusted?: boolean; default: not declared - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared - volume: number; default: not declared - vwap?: number; default: not declared ### @insiderfinance/totalfinance#VolatilitySurfaceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VolatilitySurfaceInput { quotes: OptionQuote[]; market: SurfaceMarket; config?: SurfaceConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config?: SurfaceConfig; default: not declared - config.cosineExpansionTerms?: number; default: not declared — COS cosine-term count for the `model: 'heston'` calibration & evaluation (default 128). - config.essviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'essvi'` calibration (default `'power-law'`). - config.essviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'essvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - config.hestonInitialParameters?: Partial; default: not declared — Warm start (partial pin) for the global `model: 'heston'` calibration — threads into `calibrateHestonSurface`'s `initialParameters`. - config.hestonInitialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - config.hestonInitialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - config.hestonInitialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - config.hestonInitialParameters.theta?: number; default: not declared — Long-run variance θ. - config.hestonInitialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - config.minQuotesPerExpiry?: number; default: not declared — Below this many usable strikes, an expiry slice is flagged sparse (default 3). - config.model?: SurfaceModel; default: not declared — `interpolated` (PCHIP, default), `raw` (linear), `smoothed` (Gaussian kernel), `svi`/`sabr` (parametric per expiry), `ssvi` (one global arbitrage-free surface SVI), `essvi` (SSVI with a per-maturity skew), or `heston` (one global stochastic-vol model fit to the whole surface). - config.priceSource?: PriceSource; default: not declared — Which quote price to invert when a quote has no `impliedVolatility` (default `mid`). - config.sabrBeta?: number; default: not declared — SABR backbone exponent β ∈ [0, 1] for `model: 'sabr'` (default 0.5). - config.sabrVolatilityType?: SabrVolatilityType; default: not declared — SABR Hagan expansion for `model: 'sabr'` (default `'lognormal'`). - config.smoothingBandwidth?: number; default: not declared — Gaussian-kernel bandwidth (in log-moneyness) for `model: 'smoothed'` (default auto). - config.ssviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'ssvi'` calibration (default `'power-law'`). - config.ssviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'ssvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - market: SurfaceMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.riskFreeRate: number; default: not declared - market.spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. - quotes: OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#backtest Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const backtest: typeof import('@insiderfinance/totalfinance/backtest'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - BENCHMARK_FIXTURE_VERSION: '0.0.1'; default: not declared — Version tag of the golden benchmark fixtures the engines are validated against (spec §16.3). - SimulatedBroker: typeof import('@insiderfinance/totalfinance/backtest').SimulatedBroker; default: not declared — A deterministic simulated broker. - SimulatedBroker().return.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - SimulatedBroker().return.cash: number; default: not declared - SimulatedBroker().return.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - SimulatedBroker().return.exerciseOption: (input: import('@insiderfinance/totalfinance/backtest').ExerciseOptionInput) => import('@insiderfinance/totalfinance/backtest').OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - SimulatedBroker().return.orders: readonly import('@insiderfinance/totalfinance/backtest').Order[]; default: not declared — All orders ever submitted (live view, readonly). - SimulatedBroker().return.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - SimulatedBroker().return.position: (symbol: import('@insiderfinance/totalfinance/core').SymbolId) => import('@insiderfinance/totalfinance/backtest').Position; default: not declared - SimulatedBroker().return.positions: Map; default: not declared - SimulatedBroker().return.processBar: (bar: import('@insiderfinance/totalfinance/core').Bar, action?: import('@insiderfinance/totalfinance/backtest').CorporateAction) => import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - SimulatedBroker().return.registerOption: (symbol: import('@insiderfinance/totalfinance/core').SymbolId, specification: import('@insiderfinance/totalfinance/backtest').OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - SimulatedBroker().return.settleExpiries: (asOfTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs, underlierMarks?: Map) => import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - SimulatedBroker().return.settlements: readonly import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - SimulatedBroker().return.submit: (request: import('@insiderfinance/totalfinance/backtest').OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - SimulatedBroker().return.trades: readonly import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — All fills (live view, readonly). - SimulatedBroker().return.warnings: readonly import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - SimulatedBroker(config): import('@insiderfinance/totalfinance/backtest').BrokerConfig; default: not declared - SimulatedBroker(config).assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - SimulatedBroker(config).assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - SimulatedBroker(config).borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - SimulatedBroker(config).cash: number; default: not declared — Opening cash. - SimulatedBroker(config).commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - SimulatedBroker(config).maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - SimulatedBroker(config).maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - SimulatedBroker(config).noShort?: boolean; default: not declared — Disallow short positions (default `false`). - SimulatedBroker(config).periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - SimulatedBroker(config).riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - SimulatedBroker(config).slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - agentBaselines: Readonly<{ holdCash: () => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; buyAndHold: (input?: { weights?: Readonly>; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; periodicRebalance: (input: { everySessions: number; weights?: Readonly>; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; randomValidAction: (seed: number) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; riskParity: (input: { lookback: number; everySessions?: number; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; momentumCrossover: (input: { fast: number; slow: number; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; }>; default: not declared - agentBaselines.buyAndHold: (input?: { weights?: Readonly>; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; default: not declared - agentBaselines.buyAndHold().return.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - agentBaselines.buyAndHold().return.label: string; default: not declared - agentBaselines.buyAndHold().return.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - agentBaselines.buyAndHold().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - agentBaselines.buyAndHold().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - agentBaselines.buyAndHold().return.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - agentBaselines.buyAndHold().return.requires.realizedVolatility.annualization: number; default: not declared - agentBaselines.buyAndHold().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - agentBaselines.buyAndHold(input)?: { weights?: Readonly>; } | undefined; default: not declared - agentBaselines.buyAndHold(input).weights?: Readonly>; default: not declared - agentBaselines.holdCash: () => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; default: not declared - agentBaselines.holdCash().return.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - agentBaselines.holdCash().return.label: string; default: not declared - agentBaselines.holdCash().return.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - agentBaselines.holdCash().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - agentBaselines.holdCash().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - agentBaselines.holdCash().return.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - agentBaselines.holdCash().return.requires.realizedVolatility.annualization: number; default: not declared - agentBaselines.holdCash().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - agentBaselines.momentumCrossover: (input: { fast: number; slow: number; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; default: not declared - agentBaselines.momentumCrossover().return.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - agentBaselines.momentumCrossover().return.label: string; default: not declared - agentBaselines.momentumCrossover().return.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - agentBaselines.momentumCrossover().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - agentBaselines.momentumCrossover().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - agentBaselines.momentumCrossover().return.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - agentBaselines.momentumCrossover().return.requires.realizedVolatility.annualization: number; default: not declared - agentBaselines.momentumCrossover().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - agentBaselines.momentumCrossover(input): { fast: number; slow: number; }; default: not declared - agentBaselines.momentumCrossover(input).fast: number; default: not declared - agentBaselines.momentumCrossover(input).slow: number; default: not declared - agentBaselines.periodicRebalance: (input: { everySessions: number; weights?: Readonly>; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; default: not declared - agentBaselines.periodicRebalance().return.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - agentBaselines.periodicRebalance().return.label: string; default: not declared - agentBaselines.periodicRebalance().return.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - agentBaselines.periodicRebalance().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - agentBaselines.periodicRebalance().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - agentBaselines.periodicRebalance().return.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - agentBaselines.periodicRebalance().return.requires.realizedVolatility.annualization: number; default: not declared - agentBaselines.periodicRebalance().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - agentBaselines.periodicRebalance(input): { everySessions: number; weights?: Readonly>; }; default: not declared - agentBaselines.periodicRebalance(input).everySessions: number; default: not declared - agentBaselines.periodicRebalance(input).weights?: Readonly>; default: not declared - agentBaselines.randomValidAction: (seed: number) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; default: not declared - agentBaselines.randomValidAction().return.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - agentBaselines.randomValidAction().return.label: string; default: not declared - agentBaselines.randomValidAction().return.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - agentBaselines.randomValidAction().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - agentBaselines.randomValidAction().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - agentBaselines.randomValidAction().return.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - agentBaselines.randomValidAction().return.requires.realizedVolatility.annualization: number; default: not declared - agentBaselines.randomValidAction().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - agentBaselines.randomValidAction(seed): number; default: not declared - agentBaselines.riskParity: (input: { lookback: number; everySessions?: number; }) => import('@insiderfinance/totalfinance/backtest/environment').BaselinePolicy; default: not declared - agentBaselines.riskParity().return.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - agentBaselines.riskParity().return.label: string; default: not declared - agentBaselines.riskParity().return.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - agentBaselines.riskParity().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - agentBaselines.riskParity().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - agentBaselines.riskParity().return.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - agentBaselines.riskParity().return.requires.realizedVolatility.annualization: number; default: not declared - agentBaselines.riskParity().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - agentBaselines.riskParity(input): { lookback: number; everySessions?: number; }; default: not declared - agentBaselines.riskParity(input).everySessions?: number; default: not declared - agentBaselines.riskParity(input).lookback: number; default: not declared - attribution: (trades: import('@insiderfinance/totalfinance/backtest').Trade[]) => import('@insiderfinance/totalfinance/backtest').AttributionReport; default: not declared — Per-symbol realized P&L attribution (average-cost matched) from a trade blotter (report-shaped). - attribution().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - attribution().return.assumptions.conventionsVersion: string; default: not declared - attribution().return.bySymbol: import('@insiderfinance/totalfinance/backtest').SymbolAttribution[]; default: not declared — Realized P&L per symbol (average-cost matched), in first-trade order. - attribution().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - attribution().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - attribution(trades): import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared - borrow: { readonly none: () => import('@insiderfinance/totalfinance/backtest').BorrowModel; readonly annualRate: (annualRate: number) => import('@insiderfinance/totalfinance/backtest').BorrowModel; }; default: not declared — Borrow-fee models for shorts. - borrow.annualRate: (annualRate: number) => import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared — A flat annualized borrow rate charged on the short market value. - borrow.annualRate().return.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - borrow.annualRate().return.label: string; default: not declared - borrow.annualRate(annualRate): number; default: not declared - borrow.none: () => import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared — No borrow fee. - borrow.none().return.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - borrow.none().return.label: string; default: not declared - brokers: { readonly simulated: (config: import('@insiderfinance/totalfinance/backtest').BrokerConfig) => import('@insiderfinance/totalfinance/backtest').SimulatedBroker; }; default: not declared — Broker factory (spec §16.2: `brokers.simulated({ cash, commission, slippage })`). - brokers.simulated: (config: import('@insiderfinance/totalfinance/backtest').BrokerConfig) => import('@insiderfinance/totalfinance/backtest').SimulatedBroker; default: not declared — Construct a simulated broker. - brokers.simulated().return.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - brokers.simulated().return.cash: number; default: not declared - brokers.simulated().return.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - brokers.simulated().return.exerciseOption: (input: import('@insiderfinance/totalfinance/backtest').ExerciseOptionInput) => import('@insiderfinance/totalfinance/backtest').OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - brokers.simulated().return.orders: readonly import('@insiderfinance/totalfinance/backtest').Order[]; default: not declared — All orders ever submitted (live view, readonly). - brokers.simulated().return.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - brokers.simulated().return.position: (symbol: import('@insiderfinance/totalfinance/core').SymbolId) => import('@insiderfinance/totalfinance/backtest').Position; default: not declared - brokers.simulated().return.positions: Map; default: not declared - brokers.simulated().return.processBar: (bar: import('@insiderfinance/totalfinance/core').Bar, action?: import('@insiderfinance/totalfinance/backtest').CorporateAction) => import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - brokers.simulated().return.registerOption: (symbol: import('@insiderfinance/totalfinance/core').SymbolId, specification: import('@insiderfinance/totalfinance/backtest').OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - brokers.simulated().return.settleExpiries: (asOfTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs, underlierMarks?: Map) => import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - brokers.simulated().return.settlements: readonly import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - brokers.simulated().return.submit: (request: import('@insiderfinance/totalfinance/backtest').OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - brokers.simulated().return.trades: readonly import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — All fills (live view, readonly). - brokers.simulated().return.warnings: readonly import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - brokers.simulated(config): import('@insiderfinance/totalfinance/backtest').BrokerConfig; default: not declared - brokers.simulated(config).assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - brokers.simulated(config).assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - brokers.simulated(config).borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - brokers.simulated(config).cash: number; default: not declared — Opening cash. - brokers.simulated(config).commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - brokers.simulated(config).maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - brokers.simulated(config).maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - brokers.simulated(config).noShort?: boolean; default: not declared — Disallow short positions (default `false`). - brokers.simulated(config).periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - brokers.simulated(config).riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - brokers.simulated(config).slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - checkDataAlignment: (bars: import('@insiderfinance/totalfinance/core').Bar[]) => import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Check that each symbol's bars are strictly time-ascending with finite positive prices. Returns structured warnings for out-of-order timestamps, duplicate timestamps, and non-finite/non-positive closes — the silent corruptions that make a backtest quietly wrong. - checkDataAlignment(bars): import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - createPortfolioStepper: (request: import('@insiderfinance/totalfinance/backtest').PortfolioStepperRequest) => import('@insiderfinance/totalfinance/backtest').PortfolioStepper; default: not declared — The engine's seam (Stage 7B.1, Decision 2): the same per-instant loop `portfolioBacktest` runs, driven from outside. `open(index)` stamps the clock, folds pre-open entitlements and external flows, and returns a pre-execution context valued at opening or last-completed marks (the mark source identifies carried prices). `close(index, orders)` executes the caller's orders through the execution policy, settles close-derived derivative lifecycle, runs the margin check, records the valuation mark and the equity, and returns the rows the step appended; `finish()` assembles the same result `portfolioBacktest` returns over the instants closed so far. Calls must alternate `open(0)`, `close(0)`, `open(1)`, … — an out-of-order call refuses and changes nothing; `finish()` may be called again and returns the same result. The orders come from the caller, so the result records `strategy: { kind: 'external', replayable: false }`; a trading environment saves its own action trace to make an episode replayable. - createPortfolioStepper().return.close: (index: number, orders: readonly import('@insiderfinance/totalfinance/backtest/execution').OrderIntent[]) => import('@insiderfinance/totalfinance/backtest').PortfolioStepFrame; default: not declared — The orders through the execution policy, the margin check, the valuation mark, the equity. - createPortfolioStepper().return.context: () => import('@insiderfinance/totalfinance/backtest/portfolio').SessionContext; default: not declared — The session context at the last closed instant — the state after its orders, margin, and mark. - createPortfolioStepper().return.finish: () => import('@insiderfinance/totalfinance/backtest').PortfolioBacktestResult; default: not declared — The same result `portfolioBacktest` returns, over the instants closed so far. - createPortfolioStepper().return.instants: readonly number[]; default: not declared — The decision instants, ascending — the same instants `portfolioBacktest` would step. - createPortfolioStepper().return.open: (index: number) => import('@insiderfinance/totalfinance/backtest/portfolio').SessionContext; default: not declared — Lifecycle facts and external flows due at the instant, then the session context. - createPortfolioStepper().return.runId: string; default: not declared - createPortfolioStepper().return.valuation: () => ({ asOf: import('@insiderfinance/totalfinance/core').EpochMs; portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; currencyConversions: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; snapshot: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; }); default: not declared — The ledger state, the market snapshot, the conversions, and the valued snapshot at the last closed instant. - createPortfolioStepper(request): import('@insiderfinance/totalfinance/backtest').PortfolioStepperRequest; default: not declared - createPortfolioStepper(request).accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - createPortfolioStepper(request).calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - createPortfolioStepper(request).execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - createPortfolioStepper(request).externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - createPortfolioStepper(request).instruments: Readonly>; default: not declared - createPortfolioStepper(request).marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - createPortfolioStepper(request).periodsPerYear?: number; default: not declared - createPortfolioStepper(request).seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - createPortfolioStepper(request).window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - createPortfolioStepper(request).window.fromTimestampMs?: number; default: not declared - createPortfolioStepper(request).window.toTimestampMs?: number; default: not declared - createTradingEnvironment: (definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition) => import('@insiderfinance/totalfinance/backtest').TradingEnvironment; default: not declared - createTradingEnvironment().return.definitionHash: string; default: not declared — The definition's identity, seed excluded. - createTradingEnvironment().return.finish: () => import('@insiderfinance/totalfinance/backtest').PortfolioBacktestResult; default: not declared — The engine's own result over the episode so far — the same shape `portfolioBacktest` returns; ends the episode. - createTradingEnvironment().return.instantCount: number; default: not declared — The decision instants an episode steps through. - createTradingEnvironment().return.reset: (options?: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentResetOptions) => import('@insiderfinance/totalfinance/backtest/environment').EnvironmentResetResult; default: not declared - createTradingEnvironment().return.step: (action: import('@insiderfinance/totalfinance/backtest').EnvironmentAction) => import('@insiderfinance/totalfinance/backtest').EnvironmentStepResult; default: not declared - createTradingEnvironment(definition): import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; default: not declared - createTradingEnvironment(definition).accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - createTradingEnvironment(definition).calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - createTradingEnvironment(definition).execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - createTradingEnvironment(definition).externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - createTradingEnvironment(definition).features?: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes; default: not declared - createTradingEnvironment(definition).instruments: Readonly>; default: not declared - createTradingEnvironment(definition).limits?: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentLimits; default: not declared - createTradingEnvironment(definition).marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - createTradingEnvironment(definition).maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - createTradingEnvironment(definition).periodsPerYear?: number; default: not declared - createTradingEnvironment(definition).reward?: import('@insiderfinance/totalfinance/backtest/environment').RewardComposition; default: not declared - createTradingEnvironment(definition).seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - createTradingEnvironment(definition).window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - createTradingEnvironment(definition).window.fromTimestampMs?: number; default: not declared - createTradingEnvironment(definition).window.toTimestampMs?: number; default: not declared - crossOver: (first: import('@insiderfinance/totalfinance/backtest').IndicatorHandle, second: import('@insiderfinance/totalfinance/backtest').IndicatorHandle) => boolean; default: not declared — True when series `a` crosses from at-or-below `b` to above it on the latest bar. - crossOver(first): import('@insiderfinance/totalfinance/backtest').IndicatorHandle; default: not declared - crossOver(first).previous: number | null; default: not declared - crossOver(first).value: number | null; default: not declared - crossOver(second): import('@insiderfinance/totalfinance/backtest').IndicatorHandle; default: not declared - crossOver(second).previous: number | null; default: not declared - crossOver(second).value: number | null; default: not declared - crossOverSeries: (first: ArrayLike, second: number | ArrayLike) => Float64Array; default: not declared — `1` on the bar where `a` crosses from at-or-below `b` to above it (`a[i-1] ≤ b[i-1] && a[i] > b[i]`), else `0`. `NaN` where any of the four inputs (`a`/`b` at `i` or `i-1`) is `NaN`, and at index `0` — a crossing needs a prior bar to compare against. `b` may be a scalar level or an aligned series. - crossOverSeries(first): ArrayLike; default: not declared - crossOverSeries(second): number | ArrayLike; default: not declared - crossSectionalBacktest: (request: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestRequest) => import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestResult; default: not declared - crossSectionalBacktest().return.assumptions: import('@insiderfinance/totalfinance/backtest').CrossSectionalAssumptions; default: not declared - crossSectionalBacktest().return.attribution: import('@insiderfinance/totalfinance/backtest').CrossSectionalAttribution; default: not declared - crossSectionalBacktest().return.benchmark: import('@insiderfinance/totalfinance/backtest').BenchmarkComparison | null; default: not declared - crossSectionalBacktest().return.benchmark.activeReturn: number | null; default: not declared - crossSectionalBacktest().return.benchmark.alpha: number | null; default: not declared - crossSectionalBacktest().return.benchmark.beta: number | null; default: not declared - crossSectionalBacktest().return.benchmark.informationRatio: number | null; default: not declared - crossSectionalBacktest().return.benchmark.instrumentId: string; default: not declared - crossSectionalBacktest().return.benchmark.returns: number[]; default: not declared — The benchmark's per-session simple returns aligned to the run's sessions. - crossSectionalBacktest().return.benchmark.trackingError: number | null; default: not declared - crossSectionalBacktest().return.diagnostics: import('@insiderfinance/totalfinance/backtest').CrossSectionalDiagnostics; default: not declared - crossSectionalBacktest().return.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - crossSectionalBacktest().return.finalValue: number; default: not declared - crossSectionalBacktest().return.holdings: import('@insiderfinance/totalfinance/backtest').HoldingRow[]; default: not declared - crossSectionalBacktest().return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - crossSectionalBacktest().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - crossSectionalBacktest().return.performanceConfidence: { iterations: number; seed: number; meanTotalReturn: number; standardDeviation: number; confidenceInterval95: [number, number]; } | null; default: not declared — Bootstrap confidence intervals of the performance block when a seed was given. - crossSectionalBacktest().return.performanceConfidence.confidenceInterval95: [number, number]; default: not declared - crossSectionalBacktest().return.performanceConfidence.iterations: number; default: not declared - crossSectionalBacktest().return.performanceConfidence.meanTotalReturn: number; default: not declared - crossSectionalBacktest().return.performanceConfidence.seed: number; default: not declared - crossSectionalBacktest().return.performanceConfidence.standardDeviation: number; default: not declared - crossSectionalBacktest().return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - crossSectionalBacktest().return.rebalances: import('@insiderfinance/totalfinance/backtest').RebalanceRow[]; default: not declared - crossSectionalBacktest().return.returns: number[]; default: not declared - crossSectionalBacktest().return.runId: string; default: not declared - crossSectionalBacktest().return.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared - crossSectionalBacktest().return.trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared - crossSectionalBacktest(request): import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestRequest; default: not declared - crossSectionalBacktest(request).baseCurrency?: string; default: not declared — Default `'USD'`. - crossSectionalBacktest(request).dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - crossSectionalBacktest(request).execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - crossSectionalBacktest(request).initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - crossSectionalBacktest(request).periodsPerYear?: number; default: not declared — Default 252. - crossSectionalBacktest(request).portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - crossSectionalBacktest(request).rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - crossSectionalBacktest(request).riskFreeRate?: number; default: not declared - crossSectionalBacktest(request).seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - crossSectionalBacktest(request).signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - crossSectionalBacktest(request).transactionCostModel?: { commission?: import('@insiderfinance/totalfinance/backtest').CostModel; slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - crossSectionalBacktest(request).transactionCostModel.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - crossSectionalBacktest(request).transactionCostModel.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - crossSectionalBacktest(request).universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - crossSectionalBacktest(request).window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - crossSectionalBacktest(request).window.fromTimestampMs?: number; default: not declared - crossSectionalBacktest(request).window.toTimestampMs?: number; default: not declared - crossSectionalBacktestGrid: (gridRequest: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestGridRequest) => import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestGridResult; default: not declared — Run the cartesian product of `variations` over `request` — each point one `crossSectionalBacktest` call — and compose the research-hygiene verdicts. Every child run is returned whole and index-aligned with `variations`; `sweepId` is the parent hash over the axes and the child hashes. - crossSectionalBacktestGrid().return.assumptions: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridAssumptions; default: not declared - crossSectionalBacktestGrid().return.best: { index: number; runId: string; metric: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; value: number; } | null; default: not declared — The best trial by the selection metric, or `null` when no variation carries the metric. - crossSectionalBacktestGrid().return.best.index: number; default: not declared - crossSectionalBacktestGrid().return.best.metric: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared - crossSectionalBacktestGrid().return.best.runId: string; default: not declared - crossSectionalBacktestGrid().return.best.value: number; default: not declared - crossSectionalBacktestGrid().return.diagnostics: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridDiagnostics; default: not declared - crossSectionalBacktestGrid().return.hygiene: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridHygiene; default: not declared - crossSectionalBacktestGrid().return.runs: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestResult[]; default: not declared — Every child run, index-aligned with `variations` — the same function, called once per point. - crossSectionalBacktestGrid().return.sweepId: string; default: not declared — The parent sweep hash: the content hash of the axes and every child run hash. - crossSectionalBacktestGrid().return.variations: import('@insiderfinance/totalfinance/backtest').GridVariationRow[]; default: not declared - crossSectionalBacktestGrid(gridRequest): import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestGridRequest; default: not declared - crossSectionalBacktestGrid(gridRequest).hygiene?: { splits?: number; confidence?: number; }; default: not declared - crossSectionalBacktestGrid(gridRequest).hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - crossSectionalBacktestGrid(gridRequest).hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - crossSectionalBacktestGrid(gridRequest).maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - crossSectionalBacktestGrid(gridRequest).request: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - crossSectionalBacktestGrid(gridRequest).selectionMetric?: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - crossSectionalBacktestGrid(gridRequest).variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - crossSectionalPurgedFolds: (request: import('@insiderfinance/totalfinance/backtest').CrossSectionalPurgedFoldsRequest) => import('@insiderfinance/totalfinance/backtest').CrossSectionalOutOfSampleResult; default: not declared — Purged k-fold evaluation of a cross-sectional grid: `purgedKFold` over the session index gives every fold a held-out block, a purge gap on each side, and an embargo after it; the grid chooses a variation on the remaining (possibly two-segment) training sessions, pooled into one curve; the choice runs once on the held-out block. Training segments left with fewer than two sessions after purging are dropped with a warning. - crossSectionalPurgedFolds().return.assumptions: import('@insiderfinance/totalfinance/backtest').OutOfSampleAssumptions; default: not declared - crossSectionalPurgedFolds().return.diagnostics: import('@insiderfinance/totalfinance/backtest').OutOfSampleDiagnostics; default: not declared - crossSectionalPurgedFolds().return.evaluationId: string; default: not declared — The content hash of the procedure: the grid axes, the fold plan, and every held-out run id. - crossSectionalPurgedFolds().return.hygiene: import('@insiderfinance/totalfinance/backtest').OutOfSampleHygiene; default: not declared - crossSectionalPurgedFolds().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary | null; default: not declared — The performance block of the stitched held-out returns; `null` under two returns. - crossSectionalPurgedFolds().return.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - crossSectionalPurgedFolds().return.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - crossSectionalPurgedFolds().return.performance.annualizedVolatility: number | null; default: not declared - crossSectionalPurgedFolds().return.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - crossSectionalPurgedFolds().return.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - crossSectionalPurgedFolds().return.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - crossSectionalPurgedFolds().return.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - crossSectionalPurgedFolds().return.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - crossSectionalPurgedFolds().return.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalPurgedFolds().return.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - crossSectionalPurgedFolds().return.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - crossSectionalPurgedFolds().return.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalPurgedFolds().return.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - crossSectionalPurgedFolds().return.performance.maxDrawdown: number; default: not declared - crossSectionalPurgedFolds().return.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalPurgedFolds().return.performance.periods: number; default: not declared - crossSectionalPurgedFolds().return.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalPurgedFolds().return.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalPurgedFolds().return.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalPurgedFolds().return.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - crossSectionalPurgedFolds().return.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - crossSectionalPurgedFolds().return.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - crossSectionalPurgedFolds().return.performance.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - crossSectionalPurgedFolds().return.returns: number[]; default: not declared — Held-out per-session returns stitched in window order. - crossSectionalPurgedFolds().return.runs: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestResult[]; default: not declared — Every held-out run, index-aligned with the evaluated windows (`windows[i].testRunId !== null`). - crossSectionalPurgedFolds().return.windows: import('@insiderfinance/totalfinance/backtest').OutOfSampleWindowRow[]; default: not declared - crossSectionalPurgedFolds(request): import('@insiderfinance/totalfinance/backtest').CrossSectionalPurgedFoldsRequest; default: not declared - crossSectionalPurgedFolds(request).embargo?: number; default: not declared — `purgedKFold`'s embargo fraction (default 0). - crossSectionalPurgedFolds(request).folds: number; default: not declared — Folds (≥ 2, ≤ sessions ÷ 2 so every held-out span carries two sessions). - crossSectionalPurgedFolds(request).hygiene?: { splits?: number; confidence?: number; }; default: not declared - crossSectionalPurgedFolds(request).hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - crossSectionalPurgedFolds(request).hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - crossSectionalPurgedFolds(request).maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - crossSectionalPurgedFolds(request).purgeGap?: number; default: not declared — `purgedKFold`'s purge gap in sessions on each side of a held-out span (default 0). - crossSectionalPurgedFolds(request).request: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - crossSectionalPurgedFolds(request).selectionMetric?: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - crossSectionalPurgedFolds(request).variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - crossSectionalWalkForward: (request: import('@insiderfinance/totalfinance/backtest').CrossSectionalWalkForwardRequest) => import('@insiderfinance/totalfinance/backtest').CrossSectionalOutOfSampleResult; default: not declared — Walk a cross-sectional grid forward: on every training span the grid picks a variation by its selection metric; that variation runs once on the following held-out span; the held-out returns are stitched in order. Rolling (default) or anchored training spans; `step` defaults to `testSessions` so held-out spans tile the data without overlap. - crossSectionalWalkForward().return.assumptions: import('@insiderfinance/totalfinance/backtest').OutOfSampleAssumptions; default: not declared - crossSectionalWalkForward().return.diagnostics: import('@insiderfinance/totalfinance/backtest').OutOfSampleDiagnostics; default: not declared - crossSectionalWalkForward().return.evaluationId: string; default: not declared — The content hash of the procedure: the grid axes, the fold plan, and every held-out run id. - crossSectionalWalkForward().return.hygiene: import('@insiderfinance/totalfinance/backtest').OutOfSampleHygiene; default: not declared - crossSectionalWalkForward().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary | null; default: not declared — The performance block of the stitched held-out returns; `null` under two returns. - crossSectionalWalkForward().return.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - crossSectionalWalkForward().return.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - crossSectionalWalkForward().return.performance.annualizedVolatility: number | null; default: not declared - crossSectionalWalkForward().return.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - crossSectionalWalkForward().return.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - crossSectionalWalkForward().return.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - crossSectionalWalkForward().return.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - crossSectionalWalkForward().return.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - crossSectionalWalkForward().return.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalWalkForward().return.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - crossSectionalWalkForward().return.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - crossSectionalWalkForward().return.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalWalkForward().return.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - crossSectionalWalkForward().return.performance.maxDrawdown: number; default: not declared - crossSectionalWalkForward().return.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalWalkForward().return.performance.periods: number; default: not declared - crossSectionalWalkForward().return.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalWalkForward().return.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalWalkForward().return.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - crossSectionalWalkForward().return.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - crossSectionalWalkForward().return.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - crossSectionalWalkForward().return.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - crossSectionalWalkForward().return.performance.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - crossSectionalWalkForward().return.returns: number[]; default: not declared — Held-out per-session returns stitched in window order. - crossSectionalWalkForward().return.runs: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestResult[]; default: not declared — Every held-out run, index-aligned with the evaluated windows (`windows[i].testRunId !== null`). - crossSectionalWalkForward().return.windows: import('@insiderfinance/totalfinance/backtest').OutOfSampleWindowRow[]; default: not declared - crossSectionalWalkForward(request): import('@insiderfinance/totalfinance/backtest').CrossSectionalWalkForwardRequest; default: not declared - crossSectionalWalkForward(request).hygiene?: { splits?: number; confidence?: number; }; default: not declared - crossSectionalWalkForward(request).hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - crossSectionalWalkForward(request).hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - crossSectionalWalkForward(request).maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - crossSectionalWalkForward(request).mode?: 'rolling' | 'anchored'; default: not declared — `'rolling'` (default): training spans slide; `'anchored'`: every training span starts at the first session. - crossSectionalWalkForward(request).request: import('@insiderfinance/totalfinance/backtest').CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - crossSectionalWalkForward(request).selectionMetric?: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - crossSectionalWalkForward(request).step?: number; default: not declared — Sessions the window advances by; default `testSessions` (adjacent, non-overlapping held-out spans). - crossSectionalWalkForward(request).testSessions: number; default: not declared — Sessions in each held-out span (≥ 2). - crossSectionalWalkForward(request).trainSessions: number; default: not declared — Sessions in each training span (≥ 2). - crossSectionalWalkForward(request).variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - crossUnder: (first: import('@insiderfinance/totalfinance/backtest').IndicatorHandle, second: import('@insiderfinance/totalfinance/backtest').IndicatorHandle) => boolean; default: not declared — True when series `a` crosses from at-or-above `b` to below it on the latest bar. - crossUnder(first): import('@insiderfinance/totalfinance/backtest').IndicatorHandle; default: not declared - crossUnder(first).previous: number | null; default: not declared - crossUnder(first).value: number | null; default: not declared - crossUnder(second): import('@insiderfinance/totalfinance/backtest').IndicatorHandle; default: not declared - crossUnder(second).previous: number | null; default: not declared - crossUnder(second).value: number | null; default: not declared - crossUnderSeries: (first: ArrayLike, second: number | ArrayLike) => Float64Array; default: not declared — `1` on the bar where `a` crosses from at-or-above `b` to below it (`a[i-1] ≥ b[i-1] && a[i] < b[i]`), else `0`. `NaN` where any of the four inputs (`a`/`b` at `i` or `i-1`) is `NaN`, and at index `0` — a crossing needs a prior bar to compare against. `b` may be a scalar level or an aligned series. - crossUnderSeries(first): ArrayLike; default: not declared - crossUnderSeries(second): number | ArrayLike; default: not declared - environmentEpisode: (input: { id: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeId; seed?: number; }) => import('@insiderfinance/totalfinance/backtest').EnvironmentEpisode; default: not declared — Build one maintained episode from its seed — the definition, the seed, its session count, and its expectations. - environmentEpisode().return.definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; default: not declared - environmentEpisode().return.description: string; default: not declared - environmentEpisode().return.expectations: readonly string[]; default: not declared - environmentEpisode().return.id: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeId; default: not declared - environmentEpisode().return.seed: number; default: not declared - environmentEpisode().return.sessions: number; default: not declared — Decision instants the definition yields. - environmentEpisode().return.title: string; default: not declared - environmentEpisode(input): { id: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeId; seed?: number; }; default: not declared - environmentEpisode(input).id: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeId; default: not declared - environmentEpisode(input).seed?: number; default: not declared - equityToReturns: (equity: ArrayLike) => number[]; default: not declared — Per-step simple returns of an equity curve. - equityToReturns(equity): ArrayLike; default: not declared - eventDriven: (options: import('@insiderfinance/totalfinance/backtest').EventDrivenOptions) => import('@insiderfinance/totalfinance/backtest').BacktestResult; default: not declared — Run an event-driven backtest. - eventDriven().return.assumptions: import('@insiderfinance/totalfinance/backtest').BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - eventDriven().return.diagnostics: import('@insiderfinance/totalfinance/backtest').ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - eventDriven().return.finalValue: number; default: not declared — Final portfolio value. - eventDriven().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - eventDriven().return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - eventDriven().return.returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - eventDriven().return.settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - eventDriven().return.trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Every filled trade, in order. - eventDriven().return.turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. - eventDriven(options): import('@insiderfinance/totalfinance/backtest').EventDrivenOptions; default: not declared - eventDriven(options).broker: import('@insiderfinance/totalfinance/backtest').SimulatedBroker | import('@insiderfinance/totalfinance/backtest').BrokerConfig; default: not declared — A configured broker, or a config to construct one. - eventDriven(options).broker.assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - eventDriven(options).broker.assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - eventDriven(options).broker.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - eventDriven(options).broker.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - eventDriven(options).broker.cash: number; default: not declared — Opening cash. - eventDriven(options).broker.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - eventDriven(options).broker.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - eventDriven(options).broker.exerciseOption: (input: import('@insiderfinance/totalfinance/backtest').ExerciseOptionInput) => import('@insiderfinance/totalfinance/backtest').OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - eventDriven(options).broker.maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - eventDriven(options).broker.maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - eventDriven(options).broker.noShort?: boolean; default: not declared — Disallow short positions (default `false`). - eventDriven(options).broker.orders: readonly import('@insiderfinance/totalfinance/backtest').Order[]; default: not declared — All orders ever submitted (live view, readonly). - eventDriven(options).broker.periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - eventDriven(options).broker.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - eventDriven(options).broker.position: (symbol: import('@insiderfinance/totalfinance/core').SymbolId) => import('@insiderfinance/totalfinance/backtest').Position; default: not declared - eventDriven(options).broker.positions: Map; default: not declared - eventDriven(options).broker.processBar: (bar: import('@insiderfinance/totalfinance/core').Bar, action?: import('@insiderfinance/totalfinance/backtest').CorporateAction) => import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - eventDriven(options).broker.registerOption: (symbol: import('@insiderfinance/totalfinance/core').SymbolId, specification: import('@insiderfinance/totalfinance/backtest').OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - eventDriven(options).broker.riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - eventDriven(options).broker.settleExpiries: (asOfTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs, underlierMarks?: Map) => import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - eventDriven(options).broker.settlements: readonly import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - eventDriven(options).broker.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - eventDriven(options).broker.submit: (request: import('@insiderfinance/totalfinance/backtest').OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - eventDriven(options).broker.trades: readonly import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — All fills (live view, readonly). - eventDriven(options).broker.warnings: readonly import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - eventDriven(options).corporateActions?: Map; default: not declared — Corporate actions keyed `"@"`. - eventDriven(options).data: import('@insiderfinance/totalfinance/core').Bar[]; default: not declared — Bars for all symbols (each symbol ascending; the engine sorts the merged stream by `ts`). - eventDriven(options).periodsPerYear?: number; default: not declared — Bars per year for annualized metrics (default 252). - eventDriven(options).riskFreeRate?: number; default: not declared — Annualized risk-free rate (default 0). - eventDriven(options).strategy: (context: import('@insiderfinance/totalfinance/backtest').StrategyContext) => void; default: not declared — The strategy: registers handlers + indicators against the context. - eventDriven(options).universe?: 'point-in-time' | 'current'; default: not declared — Whether the symbol universe is `point-in-time` (delisted names included) or `current` (survivorship-biased). Recorded in diagnostics; default `point-in-time`. - fees: { readonly none: () => import('@insiderfinance/totalfinance/backtest').CostModel; readonly bps: (bps: number) => import('@insiderfinance/totalfinance/backtest').CostModel; readonly perShare: (amountPerShare: number) => import('@insiderfinance/totalfinance/backtest').CostModel; readonly fixed: (amount: number) => import('@insiderfinance/totalfinance/backtest').CostModel; }; default: not declared — Commission models. - fees.bps: (bps: number) => import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared — Commission as basis points of traded notional (`quantity·price·bps/10000`). - fees.bps().return.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - fees.bps().return.label: string; default: not declared - fees.bps(bps): number; default: not declared - fees.fixed: (amount: number) => import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared — A flat commission per fill, regardless of size. - fees.fixed().return.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - fees.fixed().return.label: string; default: not declared - fees.fixed(amount): number; default: not declared - fees.none: () => import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared — No commission. - fees.none().return.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - fees.none().return.label: string; default: not declared - fees.perShare: (amountPerShare: number) => import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared — Commission per share (`quantity·rate`). - fees.perShare().return.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - fees.perShare().return.label: string; default: not declared - fees.perShare(amountPerShare): number; default: not declared - gtSeries: (first: ArrayLike, second: number | ArrayLike) => Float64Array; default: not declared — `1` where `a[i] > b[i]`, else `0`; `NaN` where either input is `NaN` at `i` (missing data). `b` may be a scalar level (e.g. `gtSeries(rsi, 70)`) or an aligned series. - gtSeries(first): ArrayLike; default: not declared - gtSeries(second): number | ArrayLike; default: not declared - latchSeries: (entries: ArrayLike, exits: ArrayLike) => Float64Array; default: not declared — Turn discrete **entry/exit events** into a held `{0,1}` **position** series: latch to `1` on an entry event and hold it until an exit event flips it back to `0`. This is the bridge from the cross helpers — which fire `1` on a *single* bar — to a position {@link vectorized } can trade. Feeding a raw {@link crossOverSeries} in as a signal is the classic silent bug: it opens the trade the bar of the cross and *closes it the very next bar*, because every non-crossing bar is `0`. Latch the two crosses together instead (enter on cross-over, exit on cross-under) to hold the trade between them. Any non-zero, finite value in `entries`/`exits` counts as a fire (so `crossOverSeries`/`gtSeries` outputs drop straight in). `NaN` in either input at bar `i` is warmup: the output is `NaN` and the latch is left untouched, matching how the other primitives propagate an indicator's warmup. When an entry and an exit fire on the same bar the **exit wins** (`0`), so a same-bar whipsaw never leaves a phantom position open. - latchSeries(entries): ArrayLike; default: not declared - latchSeries(exits): ArrayLike; default: not declared - ltSeries: (first: ArrayLike, second: number | ArrayLike) => Float64Array; default: not declared — `1` where `a[i] < b[i]`, else `0`; `NaN` where either input is `NaN` at `i` (missing data). `b` may be a scalar level (e.g. `ltSeries(rsi, 30)`) or an aligned series. - ltSeries(first): ArrayLike; default: not declared - ltSeries(second): number | ArrayLike; default: not declared - monteCarloResample: (returns: ArrayLike, options?: { iterations?: number; seed?: number; }) => import('@insiderfinance/totalfinance/backtest').MonteCarloResampleReport; default: not declared — Seeded bootstrap of bar returns → confidence bands on the compounded total return (report-shaped). - monteCarloResample().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - monteCarloResample().return.assumptions.conventionsVersion: string; default: not declared - monteCarloResample().return.confidenceInterval95: [number, number]; default: not declared — 95% percentile interval of the total return across resamples. - monteCarloResample().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - monteCarloResample().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - monteCarloResample().return.iterations: number; default: not declared - monteCarloResample().return.meanTotalReturn: number; default: not declared — Mean bootstrapped total return. - monteCarloResample().return.seed: number; default: not declared - monteCarloResample().return.standardDeviation: number; default: not declared - monteCarloResample(options)?: { iterations?: number; seed?: number; }; default: not declared - monteCarloResample(options).iterations?: number; default: not declared - monteCarloResample(options).seed?: number; default: not declared - monteCarloResample(returns): ArrayLike; default: not declared - portfolioBacktest: (request: import('@insiderfinance/totalfinance/backtest').PortfolioBacktestRequest) => import('@insiderfinance/totalfinance/backtest').PortfolioBacktestResult; default: not declared — Run a ledger-backed multi-asset backtest. See `docs/specs/portfolio-scale-backtesting.md` (Decision 6). - portfolioBacktest().return.assumptions: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestAssumptions; default: not declared - portfolioBacktest().return.diagnostics: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestDiagnostics; default: not declared - portfolioBacktest().return.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - portfolioBacktest().return.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - portfolioBacktest().return.finalValue: number; default: not declared - portfolioBacktest().return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - portfolioBacktest().return.liquidations: import('@insiderfinance/totalfinance/backtest/portfolio').LiquidationRow[]; default: not declared - portfolioBacktest().return.orders: import('@insiderfinance/totalfinance/backtest/portfolio').OrderRecord[]; default: not declared - portfolioBacktest().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - portfolioBacktest().return.pnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult | null; default: not declared - portfolioBacktest().return.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - portfolioBacktest().return.pnl.assumptions.conventionsVersion: string; default: not declared - portfolioBacktest().return.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - portfolioBacktest().return.pnl.assumptions.identity: string; default: not declared — The identity, stated. - portfolioBacktest().return.pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolioBacktest().return.pnl.assumptions.residualTolerance: number; default: not declared - portfolioBacktest().return.pnl.baseCurrency: string; default: not declared - portfolioBacktest().return.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - portfolioBacktest().return.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - portfolioBacktest().return.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - portfolioBacktest().return.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - portfolioBacktest().return.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - portfolioBacktest().return.pnl.diagnostics.warnings: string[]; default: not declared - portfolioBacktest().return.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - portfolioBacktest().return.pnl.from: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - portfolioBacktest().return.pnl.from.asOf: number; default: not declared - portfolioBacktest().return.pnl.from.netAssetValue: number; default: not declared - portfolioBacktest().return.pnl.from.valuationDate: string; default: not declared - portfolioBacktest().return.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - portfolioBacktest().return.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - portfolioBacktest().return.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - portfolioBacktest().return.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - portfolioBacktest().return.pnl.to: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - portfolioBacktest().return.pnl.to.asOf: number; default: not declared - portfolioBacktest().return.pnl.to.netAssetValue: number; default: not declared - portfolioBacktest().return.pnl.to.valuationDate: string; default: not declared - portfolioBacktest().return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - portfolioBacktest().return.rejections: import('@insiderfinance/totalfinance/backtest/portfolio').RejectionRow[]; default: not declared - portfolioBacktest().return.returns: number[]; default: not declared - portfolioBacktest().return.runId: string; default: not declared - portfolioBacktest().return.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult | null; default: not declared - portfolioBacktest().return.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - portfolioBacktest().return.timeline.assumptions.conventionsVersion: string; default: not declared - portfolioBacktest().return.timeline.assumptions.exposureConvention: string; default: not declared - portfolioBacktest().return.timeline.assumptions.indexConvention: string; default: not declared - portfolioBacktest().return.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolioBacktest().return.timeline.assumptions.markInstant: string; default: not declared - portfolioBacktest().return.timeline.baseCurrency: string; default: not declared - portfolioBacktest().return.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - portfolioBacktest().return.timeline.cumulativePnl.financing: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.income: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.realizedPnl: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.residual: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.totalPnl: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.transactionCosts: number; default: not declared - portfolioBacktest().return.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - portfolioBacktest().return.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - portfolioBacktest().return.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - portfolioBacktest().return.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - portfolioBacktest().return.timeline.diagnostics.markCount: number; default: not declared - portfolioBacktest().return.timeline.diagnostics.warnings: string[]; default: not declared - portfolioBacktest().return.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - portfolioBacktest().return.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - portfolioBacktest().return.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - portfolioBacktest().return.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - portfolioBacktest().return.valuationMarks: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared - portfolioBacktest(request): import('@insiderfinance/totalfinance/backtest').PortfolioBacktestRequest; default: not declared - portfolioBacktest(request).accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - portfolioBacktest(request).calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - portfolioBacktest(request).execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - portfolioBacktest(request).externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - portfolioBacktest(request).instruments: Readonly>; default: not declared - portfolioBacktest(request).marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - portfolioBacktest(request).periodsPerYear?: number; default: not declared - portfolioBacktest(request).seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - portfolioBacktest(request).strategy: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioStrategy; default: not declared - portfolioBacktest(request).window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - portfolioBacktest(request).window.fromTimestampMs?: number; default: not declared - portfolioBacktest(request).window.toTimestampMs?: number; default: not declared - returnStatistics: (returns: ArrayLike) => import('@insiderfinance/totalfinance/backtest').ReturnStatisticsReport; default: not declared — Return-distribution statistics from a series of per-bar returns (report-shaped, Law 2). - returnStatistics().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - returnStatistics().return.assumptions.conventionsVersion: string; default: not declared - returnStatistics().return.averageLoss: number; default: not declared - returnStatistics().return.averageWin: number; default: not declared - returnStatistics().return.bestPeriod: number; default: not declared - returnStatistics().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - returnStatistics().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - returnStatistics().return.expectancy: number | null; default: not declared — Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. - returnStatistics().return.hitRate: number | null; default: not declared — Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero bar — there is no win/loss population to take a fraction of, so the metric is undefined and is disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. - returnStatistics().return.profitFactor: number | null; default: not declared — Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` (Law 7). `0` when there are no gains either. - returnStatistics().return.worstPeriod: number; default: not declared - returnStatistics(returns): ArrayLike; default: not declared - runAgentBench: (input: import('@insiderfinance/totalfinance/backtest/environment').AgentBenchInput) => import('@insiderfinance/totalfinance/backtest').AgentBenchReport; default: not declared - runAgentBench().return.assumptions: { episodes: string[]; seeds: number[]; runs: number; dimensions: string; leakageProbe: string; retrySuite: string; }; default: not declared - runAgentBench().return.assumptions.dimensions: string; default: not declared - runAgentBench().return.assumptions.episodes: string[]; default: not declared - runAgentBench().return.assumptions.leakageProbe: string; default: not declared - runAgentBench().return.assumptions.retrySuite: string; default: not declared - runAgentBench().return.assumptions.runs: number; default: not declared - runAgentBench().return.assumptions.seeds: number[]; default: not declared - runAgentBench().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - runAgentBench().return.episodes: import('@insiderfinance/totalfinance/backtest/environment').AgentBenchEpisodeReport[]; default: not declared - runAgentBench().return.operational: { passes: boolean; failing: string[]; lookAhead: number; duplicateOrders: number; maskViolations: number; limitBreaches: number; externalOrderAttempts: 0; }; default: not declared - runAgentBench().return.operational.duplicateOrders: number; default: not declared - runAgentBench().return.operational.externalOrderAttempts: 0; default: not declared - runAgentBench().return.operational.failing: string[]; default: not declared - runAgentBench().return.operational.limitBreaches: number; default: not declared - runAgentBench().return.operational.lookAhead: number; default: not declared - runAgentBench().return.operational.maskViolations: number; default: not declared - runAgentBench().return.operational.passes: boolean; default: not declared - runAgentBench().return.policy: string; default: not declared - runAgentBench().return.strategy: { meanTotalReturn: number | null; meanSharpe: number | null; meanMaxDrawdown: number | null; meanTurnover: number | null; meanCost: number | null; meanGrossExposure: number | null; violations: number; }; default: not declared - runAgentBench().return.strategy.meanCost: number | null; default: not declared - runAgentBench().return.strategy.meanGrossExposure: number | null; default: not declared - runAgentBench().return.strategy.meanMaxDrawdown: number | null; default: not declared - runAgentBench().return.strategy.meanSharpe: number | null; default: not declared - runAgentBench().return.strategy.meanTotalReturn: number | null; default: not declared - runAgentBench().return.strategy.meanTurnover: number | null; default: not declared - runAgentBench().return.strategy.violations: number; default: not declared - runAgentBench().return.traces: ({ id: string; seed: number; input: import('@insiderfinance/totalfinance/backtest').EnvironmentEpisodeInput; episode: import('@insiderfinance/totalfinance/backtest').EnvironmentEpisodeResult; })[]; default: not declared — One recorded episode per run, in the order of `episodes`. - runAgentBench(input): import('@insiderfinance/totalfinance/backtest/environment').AgentBenchInput; default: not declared - runAgentBench(input).episodes?: readonly (import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeId | { id: string; definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; })[]; default: not declared — Default: the whole catalogue. - runAgentBench(input).limits?: { maximumRuns?: number; }; default: not declared - runAgentBench(input).limits.maximumRuns?: number; default: not declared - runAgentBench(input).policy: { label: string; requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; }; default: not declared - runAgentBench(input).policy.decide: import('@insiderfinance/totalfinance/backtest/environment').TradingPolicy; default: not declared - runAgentBench(input).policy.label: string; default: not declared - runAgentBench(input).policy.requires: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes | null; default: not declared - runAgentBench(input).policy.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - runAgentBench(input).policy.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - runAgentBench(input).policy.requires.realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - runAgentBench(input).policy.requires.realizedVolatility.annualization: number; default: not declared - runAgentBench(input).policy.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - runAgentBench(input).seeds?: readonly number[]; default: not declared — Default: [42]. - runEnvironmentEpisode: (input: import('@insiderfinance/totalfinance/backtest').EnvironmentEpisodeInput) => import('@insiderfinance/totalfinance/backtest').EnvironmentEpisodeResult; default: not declared - runEnvironmentEpisode().return.assumptions: { conventionsVersion: string; replayable: boolean; nextObservationLaw: string; executionPolicy: string; maximumSteps: number; instantCount: number; }; default: not declared - runEnvironmentEpisode().return.assumptions.conventionsVersion: string; default: not declared - runEnvironmentEpisode().return.assumptions.executionPolicy: string; default: not declared - runEnvironmentEpisode().return.assumptions.instantCount: number; default: not declared - runEnvironmentEpisode().return.assumptions.maximumSteps: number; default: not declared - runEnvironmentEpisode().return.assumptions.nextObservationLaw: string; default: not declared - runEnvironmentEpisode().return.assumptions.replayable: boolean; default: not declared — False with a `goal` callback or a custom adapter — the trace cannot re-issue behavior. - runEnvironmentEpisode().return.definitionHash: string; default: not declared - runEnvironmentEpisode().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { stepCount: number; fillCount: number; rejectionCount: number; violationCount: number; }; default: not declared - runEnvironmentEpisode().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - runEnvironmentEpisode().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - runEnvironmentEpisode().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - runEnvironmentEpisode().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - runEnvironmentEpisode().return.diagnostics.fillCount: number; default: not declared - runEnvironmentEpisode().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - runEnvironmentEpisode().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - runEnvironmentEpisode().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - runEnvironmentEpisode().return.diagnostics.rejectionCount: number; default: not declared - runEnvironmentEpisode().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - runEnvironmentEpisode().return.diagnostics.stepCount: number; default: not declared - runEnvironmentEpisode().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - runEnvironmentEpisode().return.diagnostics.violationCount: number; default: not declared - runEnvironmentEpisode().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - runEnvironmentEpisode().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - runEnvironmentEpisode().return.engineRunId: string; default: not declared - runEnvironmentEpisode().return.reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - runEnvironmentEpisode().return.result: import('@insiderfinance/totalfinance/backtest').PortfolioBacktestResult; default: not declared — The engine's own result over the episode — the same shape `portfolioBacktest` returns. - runEnvironmentEpisode().return.rewardTotal: number; default: not declared - runEnvironmentEpisode().return.rewards: number[]; default: not declared - runEnvironmentEpisode().return.runId: string; default: not declared - runEnvironmentEpisode().return.seed: number | null; default: not declared - runEnvironmentEpisode().return.steps: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeStep[]; default: not declared - runEnvironmentEpisode().return.terminated: boolean; default: not declared - runEnvironmentEpisode().return.traceHash: string; default: not declared - runEnvironmentEpisode().return.truncated: boolean; default: not declared - runEnvironmentEpisode(input): import('@insiderfinance/totalfinance/backtest').EnvironmentEpisodeInput; default: not declared - runEnvironmentEpisode(input).actions: readonly import('@insiderfinance/totalfinance/backtest').EnvironmentAction[]; default: not declared - runEnvironmentEpisode(input).definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; default: not declared - runEnvironmentEpisode(input).seed?: number; default: not declared - scoreAgentTranscript: (input: { transcript: import('@insiderfinance/totalfinance/backtest/environment').AgentTranscript; expected: import('@insiderfinance/totalfinance/backtest/environment').AgentTranscriptExpectation; }) => import('@insiderfinance/totalfinance/backtest').AgentTranscriptScore; default: not declared - scoreAgentTranscript().return.argumentValidity: number | null; default: not declared - scoreAgentTranscript().return.assumptions: { deterministic: true; scoring: string; }; default: not declared - scoreAgentTranscript().return.assumptions.deterministic: true; default: not declared - scoreAgentTranscript().return.assumptions.scoring: string; default: not declared - scoreAgentTranscript().return.bytes: number; default: not declared - scoreAgentTranscript().return.calls: number; default: not declared - scoreAgentTranscript().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - scoreAgentTranscript().return.firstAttemptValidity: number | null; default: not declared - scoreAgentTranscript().return.operationSelection: number; default: not declared - scoreAgentTranscript().return.parity: boolean | null; default: not declared - scoreAgentTranscript().return.passes: boolean; default: not declared - scoreAgentTranscript().return.recovery: number | null; default: not declared - scoreAgentTranscript().return.refusal: boolean | null; default: not declared - scoreAgentTranscript().return.traceability: number | null; default: not declared - scoreAgentTranscript().return.withinBudget: boolean | null; default: not declared - scoreAgentTranscript(input): { transcript: import('@insiderfinance/totalfinance/backtest/environment').AgentTranscript; expected: import('@insiderfinance/totalfinance/backtest/environment').AgentTranscriptExpectation; }; default: not declared - scoreAgentTranscript(input).expected: import('@insiderfinance/totalfinance/backtest/environment').AgentTranscriptExpectation; default: not declared - scoreAgentTranscript(input).transcript: import('@insiderfinance/totalfinance/backtest/environment').AgentTranscript; default: not declared - slippage: { readonly none: () => import('@insiderfinance/totalfinance/backtest').SlippageModel; readonly bps: (bps: number) => import('@insiderfinance/totalfinance/backtest').SlippageModel; readonly fixed: (perShare: number) => import('@insiderfinance/totalfinance/backtest').SlippageModel; readonly spread: (spread: number) => import('@insiderfinance/totalfinance/backtest').SlippageModel; }; default: not declared — Slippage models — all worsen the fill price *against* the order's side. - slippage.bps: (bps: number) => import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared — Worsen the price by `bps` basis points (relative). - slippage.bps().return.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.bps().return.label: string; default: not declared - slippage.bps(bps): number; default: not declared - slippage.fixed: (perShare: number) => import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared — Worsen the price by a fixed absolute amount per share. - slippage.fixed().return.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.fixed().return.label: string; default: not declared - slippage.fixed(perShare): number; default: not declared - slippage.none: () => import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared — No slippage (fills at the reference price). - slippage.none().return.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.none().return.label: string; default: not declared - slippage.spread: (spread: number) => import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared — Cross half of a relative bid-ask `spread` (e.g. `0.001` = 10 bps spread ⇒ 5 bps each way). - slippage.spread().return.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.spread().return.label: string; default: not declared - slippage.spread(spread): number; default: not declared - tearSheet: (result: import('@insiderfinance/totalfinance/backtest').BacktestResult, options?: import('@insiderfinance/totalfinance/backtest').TearSheetOptions) => import('@insiderfinance/totalfinance/backtest').TearSheet; default: not declared — Build a structured tear sheet from a backtest result. - tearSheet().return.assumptions: import('@insiderfinance/totalfinance/backtest').BacktestAssumptions; default: not declared — The source backtest's echoed modelling assumptions — a tear sheet never drops them (WS2.8). - tearSheet().return.attribution: import('@insiderfinance/totalfinance/backtest').SymbolAttribution[]; default: not declared - tearSheet().return.diagnostics: import('@insiderfinance/totalfinance/backtest').ImplementationRisk; default: not declared — The source backtest's implementation-risk diagnostics — a tear sheet never drops them (WS2.8). - tearSheet().return.monteCarlo?: import('@insiderfinance/totalfinance/backtest').MonteCarloResampleResult; default: not declared - tearSheet().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - tearSheet().return.returns: import('@insiderfinance/totalfinance/backtest').ReturnStatistics; default: not declared - tearSheet().return.trades: import('@insiderfinance/totalfinance/backtest').TradeStatistics; default: not declared - tearSheet(options)?: import('@insiderfinance/totalfinance/backtest').TearSheetOptions; default: not declared - tearSheet(options).monteCarlo?: { iterations?: number; seed?: number; }; default: not declared — Add a seeded Monte-Carlo bootstrap of the bar returns for total-return confidence bands. - tearSheet(options).monteCarlo.iterations?: number; default: not declared - tearSheet(options).monteCarlo.seed?: number; default: not declared - tearSheet(result): import('@insiderfinance/totalfinance/backtest').BacktestResult; default: not declared - tearSheet(result).assumptions: import('@insiderfinance/totalfinance/backtest').BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - tearSheet(result).diagnostics: import('@insiderfinance/totalfinance/backtest').ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - tearSheet(result).finalValue: number; default: not declared — Final portfolio value. - tearSheet(result).performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - tearSheet(result).points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - tearSheet(result).returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - tearSheet(result).settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - tearSheet(result).trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Every filled trade, in order. - tearSheet(result).turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. - toEquityPoints: (equityCurve: number[], timestamps: import('@insiderfinance/totalfinance/core').EpochMs[]) => import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — Build the {@link EquityPoint} series from an engine's internal `equityCurve` (length n+1, index 0 = opening capital) and `timestamps` (length n, one per bar). - toEquityPoints(equityCurve): number[]; default: not declared - toEquityPoints(timestamps): number[]; default: not declared - vectorized: (options: import('@insiderfinance/totalfinance/backtest').VectorizedOptions) => import('@insiderfinance/totalfinance/backtest').BacktestResult; default: not declared — Run a single-asset vectorized backtest. - vectorized().return.assumptions: import('@insiderfinance/totalfinance/backtest').BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - vectorized().return.diagnostics: import('@insiderfinance/totalfinance/backtest').ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - vectorized().return.finalValue: number; default: not declared — Final portfolio value. - vectorized().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - vectorized().return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - vectorized().return.returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - vectorized().return.settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - vectorized().return.trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Every filled trade, in order. - vectorized().return.turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. - vectorized(options): import('@insiderfinance/totalfinance/backtest').VectorizedOptions; default: not declared - vectorized(options).borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared — Short borrow-fee model (default `borrow.none()`). - vectorized(options).data: import('@insiderfinance/totalfinance/core').Bar[]; default: not declared — Price bars in ascending time order. - vectorized(options).executionLag?: number; default: not declared — Bars between observing the signal and trading on it; ≥ 1 avoids look-ahead (default 1). - vectorized(options).fees?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared — Commission model (default `fees.none()`). - vectorized(options).initialCapital?: number; default: not declared — Opening capital (default 1). - vectorized(options).maxLeverage?: number; default: not declared — Per-asset gross weight cap applied to the signal (default 1). - vectorized(options).periodsPerYear?: number; default: not declared — Bars per year, for annualized metrics (default 252). - vectorized(options).rebalance?: import('@insiderfinance/totalfinance/backtest').RebalanceRule; default: not declared — Rebalance calendar (default `everyBar`). - vectorized(options).riskFreeRate?: number; default: not declared — Annualized risk-free rate for Sharpe/Sortino (default 0). - vectorized(options).signal: ArrayLike | import('@insiderfinance/totalfinance/backtest').SeriesSignal | import('@insiderfinance/totalfinance/backtest').EnvelopeSignal; default: not declared — Target exposure per bar, aligned to `data`. A boolean is long (`1`) / flat (`0`); a number is a target weight (fraction of equity; negative = short), clamped to `maxLeverage`. Accepts a warmup-aware {@link SeriesSignal} (`{ value, warmup }`, e.g. a `technicalAnalysis.*.explain(...)` result) so an indicator's leading warmup NaNs are treated as flat (position 0) instead of throwing. A bare `number[]`/`Float64Array` has an implicit `warmup` of 0, so any NaN in it still throws (a genuine mid-series NaN is a real error, not warmup). - vectorized(options).signal.diagnostics: { warmup: number; }; default: not declared - vectorized(options).signal.diagnostics.warmup: number; default: not declared - vectorized(options).signal.value: ArrayLike; default: not declared — Per-bar signal values, aligned to the price bars. - vectorized(options).signal.warmup: number; default: not declared — Count of leading bars that may be non-finite by design (the indicator's warmup). - vectorized(options).slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared — Slippage model (default `slippage.none()`). - walkForward: (options: import('@insiderfinance/totalfinance/backtest').WalkForwardOptions) => import('@insiderfinance/totalfinance/backtest').WalkForwardResult; default: not declared — Run a walk-forward evaluation. - walkForward().return.assumptions: import('@insiderfinance/totalfinance/backtest').BacktestAssumptions; default: not declared — The echoed modelling assumptions, identical across windows (same engine/config) — taken from the first window, so the walk-forward artifact carries the same honesty story as a single backtest (WS2.8 / dx §2.5). - walkForward().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Core diagnostics: the union of every window's warnings, deduped by code + message (WS2.8). - walkForward().return.equityCurve: number[]; default: not declared — Out-of-sample equity stitched across all test windows (starts at 1). - walkForward().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — Performance of the stitched out-of-sample curve. - walkForward().return.windows: import('@insiderfinance/totalfinance/backtest').WalkForwardWindowResult[]; default: not declared — The per-window out-of-sample results, in order, each tagged with its train/test ranges. - walkForward(options): import('@insiderfinance/totalfinance/backtest').WalkForwardOptions; default: not declared - walkForward(options).data: import('@insiderfinance/totalfinance/core').Bar[]; default: not declared — Bars in ascending time order (one symbol, or a pre-sorted multi-symbol stream). - walkForward(options).mode?: 'rolling' | 'anchored'; default: not declared — `rolling` (sliding train window) or `anchored` (train grows from the start). Default `rolling`. - walkForward(options).periodsPerYear?: number; default: not declared — Bars per year for the stitched performance (default 252). - walkForward(options).run: (window: import('@insiderfinance/totalfinance/backtest').WalkForwardWindow) => import('@insiderfinance/totalfinance/backtest').BacktestResult; default: not declared — Run a backtest over a window; return its out-of-sample result. - walkForward(options).step?: number; default: not declared — Step between successive windows (default `testSize`, i.e. non-overlapping test windows). - walkForward(options).testSize: number; default: not declared — Test (out-of-sample) window length in bars. - walkForward(options).trainSize: number; default: not declared — Training window length in bars. ### @insiderfinance/totalfinance#blackScholes Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Black–Scholes facade namespace. Flat object arguments in, plain values out; `.explain()` on each function returns the assumptions/diagnostics envelope. ```typescript export declare const blackScholes: { call: Facade; put: Facade; price: Facade; delta: Facade; gamma: Facade; theta: Facade; vega: Facade; rho: Facade; greeks: Facade; extendedGreeks: Facade; evaluate: BlackScholesEvaluateFacade; impliedVolatility: Facade, number | null>; }; ``` Example (source JSDoc): ```ts import { blackScholes } from '@insiderfinance/totalfinance/options'; blackScholes.price({ spot: 100, strike: 105, timeToExpiryYears: 30 / 365, riskFreeRate: 0.045, volatility: 0.22, type: 'call' }); // → 0.898… (plain number) const { value, assumptions, diagnostics } = blackScholes.greeks.explain({ spot: 100, strike: 105, timeToExpiryYears: 30 / 365, riskFreeRate: 0.045, volatility: 0.22, type: 'call', }); // value.delta, value.theta (per day), … — with every assumption disclosed ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Facade; default: not declared - call(input): BlackScholesInput; default: not declared - call(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - call(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - call(input).spot: number; default: not declared — Spot price of the underlying. - call(input).strike: number; default: not declared — Strike price. - call(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - call(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - call.explain: (input: BlackScholesInput) => Computed>; default: not declared - call.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - call.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - call.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - call.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - call.explain(input): BlackScholesInput; default: not declared - call.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - call.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - call.explain(input).spot: number; default: not declared — Spot price of the underlying. - call.explain(input).strike: number; default: not declared — Strike price. - call.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - call.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - delta: Facade; default: not declared — Delta alone (per share per 1.00 of spot). Computes no other Greek. - delta(input): BlackScholesTypedInput; default: not declared - delta(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - delta(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - delta(input).spot: number; default: not declared — Spot price of the underlying. - delta(input).strike: number; default: not declared — Strike price. - delta(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - delta(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - delta(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - delta.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - delta.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - delta.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - delta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - delta.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - delta.explain(input): BlackScholesTypedInput; default: not declared - delta.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - delta.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - delta.explain(input).spot: number; default: not declared — Spot price of the underlying. - delta.explain(input).strike: number; default: not declared — Strike price. - delta.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - delta.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - delta.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - evaluate: BlackScholesEvaluateFacade; default: not declared — Several selected outputs from one shared evaluation — `evaluate({ ...input, outputs: ['price', 'delta', 'gamma'] })`. Only the requested outputs and their dependencies are computed, and only they appear in the result. - evaluate(input): BlackScholesEvaluateInput; default: not declared - evaluate(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - evaluate(input).outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - evaluate(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - evaluate(input).spot: number; default: not declared — Spot price of the underlying. - evaluate(input).strike: number; default: not declared — Strike price. - evaluate(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - evaluate(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - evaluate(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - evaluate.explain: (input: BlackScholesEvaluateInput) => Computed>; default: not declared - evaluate.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - evaluate.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - evaluate.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - evaluate.explain().return.value: BlackScholesEvaluation; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - evaluate.explain(input): BlackScholesEvaluateInput; default: not declared - evaluate.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - evaluate.explain(input).outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - evaluate.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - evaluate.explain(input).spot: number; default: not declared — Spot price of the underlying. - evaluate.explain(input).strike: number; default: not declared — Strike price. - evaluate.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - evaluate.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - evaluate.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - extendedGreeks: Facade; default: not declared - extendedGreeks().return.charm: number; default: not declared - extendedGreeks().return.color: number; default: not declared - extendedGreeks().return.delta: number; default: not declared - extendedGreeks().return.gamma: number; default: not declared - extendedGreeks().return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - extendedGreeks().return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - extendedGreeks().return.rho: number; default: not declared - extendedGreeks().return.speed: number; default: not declared - extendedGreeks().return.theta: number; default: not declared - extendedGreeks().return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - extendedGreeks().return.vanna: number; default: not declared - extendedGreeks().return.vega: number; default: not declared - extendedGreeks().return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - extendedGreeks().return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - extendedGreeks().return.vomma: number; default: not declared - extendedGreeks().return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - extendedGreeks(input): BlackScholesTypedInput; default: not declared - extendedGreeks(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - extendedGreeks(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - extendedGreeks(input).spot: number; default: not declared — Spot price of the underlying. - extendedGreeks(input).strike: number; default: not declared — Strike price. - extendedGreeks(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - extendedGreeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - extendedGreeks(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - extendedGreeks.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - extendedGreeks.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - extendedGreeks.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - extendedGreeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - extendedGreeks.explain().return.value: ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - extendedGreeks.explain(input): BlackScholesTypedInput; default: not declared - extendedGreeks.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - extendedGreeks.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - extendedGreeks.explain(input).spot: number; default: not declared — Spot price of the underlying. - extendedGreeks.explain(input).strike: number; default: not declared — Strike price. - extendedGreeks.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - extendedGreeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - extendedGreeks.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - gamma: Facade; default: not declared — Gamma alone (per 1.00 of spot). Evaluates the normal density and no cumulative normal. - gamma(input): BlackScholesTypedInput; default: not declared - gamma(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - gamma(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - gamma(input).spot: number; default: not declared — Spot price of the underlying. - gamma(input).strike: number; default: not declared — Strike price. - gamma(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - gamma(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - gamma(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - gamma.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - gamma.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - gamma.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - gamma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - gamma.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - gamma.explain(input): BlackScholesTypedInput; default: not declared - gamma.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - gamma.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - gamma.explain(input).spot: number; default: not declared — Spot price of the underlying. - gamma.explain(input).strike: number; default: not declared — Strike price. - gamma.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - gamma.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - gamma.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - greeks: Facade; default: not declared - greeks().return.delta: number; default: not declared - greeks().return.gamma: number; default: not declared - greeks().return.rho: number; default: not declared - greeks().return.theta: number; default: not declared - greeks().return.vega: number; default: not declared - greeks(input): BlackScholesTypedInput; default: not declared - greeks(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - greeks(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - greeks(input).spot: number; default: not declared — Spot price of the underlying. - greeks(input).strike: number; default: not declared — Strike price. - greeks(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - greeks(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - greeks.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - greeks.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks.explain().return.value: Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks.explain(input): BlackScholesTypedInput; default: not declared - greeks.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - greeks.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - greeks.explain(input).spot: number; default: not declared — Spot price of the underlying. - greeks.explain(input).strike: number; default: not declared — Strike price. - greeks.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - greeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - greeks.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - impliedVolatility: Facade, number | null>; default: not declared - impliedVolatility(input): BlackScholesImpliedVolatilityInput; default: not declared - impliedVolatility(input).dividendYield?: number; default: not declared - impliedVolatility(input).price: number; default: not declared — Observed option price to invert. - impliedVolatility(input).riskFreeRate: number; default: not declared - impliedVolatility(input).spot: number; default: not declared - impliedVolatility(input).strike: number; default: not declared - impliedVolatility(input).timeToExpiryYears: number; default: not declared - impliedVolatility(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - impliedVolatility.explain: (input: BlackScholesImpliedVolatilityInput) => Computed>; default: not declared - impliedVolatility.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - impliedVolatility.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - impliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatility.explain(input): BlackScholesImpliedVolatilityInput; default: not declared - impliedVolatility.explain(input).dividendYield?: number; default: not declared - impliedVolatility.explain(input).price: number; default: not declared — Observed option price to invert. - impliedVolatility.explain(input).riskFreeRate: number; default: not declared - impliedVolatility.explain(input).spot: number; default: not declared - impliedVolatility.explain(input).strike: number; default: not declared - impliedVolatility.explain(input).timeToExpiryYears: number; default: not declared - impliedVolatility.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - price: Facade; default: not declared - price(input): BlackScholesTypedInput; default: not declared - price(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - price(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - price(input).spot: number; default: not declared — Spot price of the underlying. - price(input).strike: number; default: not declared — Strike price. - price(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - price(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - price.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - price.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price.explain(input): BlackScholesTypedInput; default: not declared - price.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - price.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - price.explain(input).spot: number; default: not declared — Spot price of the underlying. - price.explain(input).strike: number; default: not declared — Strike price. - price.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - price.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - price.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - put: Facade; default: not declared - put(input): BlackScholesInput; default: not declared - put(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - put(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - put(input).spot: number; default: not declared — Spot price of the underlying. - put(input).strike: number; default: not declared — Strike price. - put(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - put(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - put.explain: (input: BlackScholesInput) => Computed>; default: not declared - put.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - put.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - put.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - put.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - put.explain(input): BlackScholesInput; default: not declared - put.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - put.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - put.explain(input).spot: number; default: not declared — Spot price of the underlying. - put.explain(input).strike: number; default: not declared — Strike price. - put.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - put.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - rho: Facade; default: not declared — Rho alone, per 1% of the risk-free rate. - rho(input): BlackScholesTypedInput; default: not declared - rho(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - rho(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - rho(input).spot: number; default: not declared — Spot price of the underlying. - rho(input).strike: number; default: not declared — Strike price. - rho(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - rho(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - rho(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - rho.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - rho.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - rho.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - rho.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rho.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rho.explain(input): BlackScholesTypedInput; default: not declared - rho.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - rho.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - rho.explain(input).spot: number; default: not declared — Spot price of the underlying. - rho.explain(input).strike: number; default: not declared — Strike price. - rho.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - rho.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - rho.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - theta: Facade; default: not declared — Theta alone, per calendar day. - theta(input): BlackScholesTypedInput; default: not declared - theta(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - theta(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - theta(input).spot: number; default: not declared — Spot price of the underlying. - theta(input).strike: number; default: not declared — Strike price. - theta(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - theta(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - theta(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - theta.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - theta.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - theta.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - theta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - theta.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - theta.explain(input): BlackScholesTypedInput; default: not declared - theta.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - theta.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - theta.explain(input).spot: number; default: not declared — Spot price of the underlying. - theta.explain(input).strike: number; default: not declared — Strike price. - theta.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - theta.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - theta.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - vega: Facade; default: not declared — Vega alone, per 1 volatility point (0.01). - vega(input): BlackScholesTypedInput; default: not declared - vega(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - vega(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - vega(input).spot: number; default: not declared — Spot price of the underlying. - vega(input).strike: number; default: not declared — Strike price. - vega(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - vega(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - vega(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - vega.explain: (input: BlackScholesTypedInput) => Computed>; default: not declared - vega.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - vega.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - vega.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vega.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vega.explain(input): BlackScholesTypedInput; default: not declared - vega.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - vega.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - vega.explain(input).spot: number; default: not declared — Spot price of the underlying. - vega.explain(input).strike: number; default: not declared — Strike price. - vega.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - vega.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - vega.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). ### @insiderfinance/totalfinance#calendars Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const calendars: typeof import('@insiderfinance/totalfinance/calendars'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - CALENDAR_DATA_VERSION: '2026.06.0'; default: not declared — Bump when the holiday rules or closure list change. - CBOE: import('@insiderfinance/totalfinance/calendars').TradingCalendar; default: not declared - CBOE.addBusinessDays: (date: string, days: number) => string; default: not declared - CBOE.addBusinessDays(date): string; default: not declared - CBOE.addBusinessDays(days): number; default: not declared - CBOE.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - CBOE.businessDaysBetween(from): string; default: not declared - CBOE.businessDaysBetween(to): string; default: not declared - CBOE.isBusinessDay: (date: string) => boolean; default: not declared - CBOE.isBusinessDay(date): string; default: not declared - CBOE.isHalfDay: (date: string) => boolean; default: not declared - CBOE.isHalfDay(date): string; default: not declared - CBOE.isHoliday: (date: string) => boolean; default: not declared - CBOE.isHoliday(date): string; default: not declared - CBOE.isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - CBOE.isTradingDay(date): string; default: not declared - CBOE.name: string; default: not declared - CBOE.nextBusinessDay: (date: string) => string; default: not declared - CBOE.nextBusinessDay(date): string; default: not declared - CBOE.previousBusinessDay: (date: string) => string; default: not declared - CBOE.previousBusinessDay(date): string; default: not declared - CBOE.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - CBOE.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - CBOE.session().return.date: string; default: not declared - CBOE.session().return.isBusinessDay: boolean; default: not declared - CBOE.session().return.isHalfDay: boolean; default: not declared - CBOE.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - CBOE.session(date): string; default: not declared - CBOE.timezone: string; default: not declared - CBOE.version: string; default: not declared - NYSE: import('@insiderfinance/totalfinance/calendars').TradingCalendar; default: not declared - NYSE.addBusinessDays: (date: string, days: number) => string; default: not declared - NYSE.addBusinessDays(date): string; default: not declared - NYSE.addBusinessDays(days): number; default: not declared - NYSE.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - NYSE.businessDaysBetween(from): string; default: not declared - NYSE.businessDaysBetween(to): string; default: not declared - NYSE.isBusinessDay: (date: string) => boolean; default: not declared - NYSE.isBusinessDay(date): string; default: not declared - NYSE.isHalfDay: (date: string) => boolean; default: not declared - NYSE.isHalfDay(date): string; default: not declared - NYSE.isHoliday: (date: string) => boolean; default: not declared - NYSE.isHoliday(date): string; default: not declared - NYSE.isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - NYSE.isTradingDay(date): string; default: not declared - NYSE.name: string; default: not declared - NYSE.nextBusinessDay: (date: string) => string; default: not declared - NYSE.nextBusinessDay(date): string; default: not declared - NYSE.previousBusinessDay: (date: string) => string; default: not declared - NYSE.previousBusinessDay(date): string; default: not declared - NYSE.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - NYSE.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - NYSE.session().return.date: string; default: not declared - NYSE.session().return.isBusinessDay: boolean; default: not declared - NYSE.session().return.isHalfDay: boolean; default: not declared - NYSE.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - NYSE.session(date): string; default: not declared - NYSE.timezone: string; default: not declared - NYSE.version: string; default: not declared - US_EQUITY_CALENDAR_COVERAGE: Readonly<{ historicalFloor: '2001-01-01'; verifiedThrough: null; dataVersion: '2026.06.0'; limitations: string; }>; default: not declared — Documented closure-data boundary; future ad-hoc closures cannot be predicted from rules. - US_EQUITY_CALENDAR_COVERAGE.dataVersion: '2026.06.0'; default: not declared - US_EQUITY_CALENDAR_COVERAGE.historicalFloor: '2001-01-01'; default: not declared - US_EQUITY_CALENDAR_COVERAGE.limitations: string; default: not declared - US_EQUITY_CALENDAR_COVERAGE.verifiedThrough: null; default: not declared - crypto24x7: import('@insiderfinance/totalfinance/calendars').TradingCalendar; default: not declared — The 24×7 crypto calendar with trader vocabulary (R10). - crypto24x7.addBusinessDays: (date: string, days: number) => string; default: not declared - crypto24x7.addBusinessDays(date): string; default: not declared - crypto24x7.addBusinessDays(days): number; default: not declared - crypto24x7.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - crypto24x7.businessDaysBetween(from): string; default: not declared - crypto24x7.businessDaysBetween(to): string; default: not declared - crypto24x7.isBusinessDay: (date: string) => boolean; default: not declared - crypto24x7.isBusinessDay(date): string; default: not declared - crypto24x7.isHalfDay: (date: string) => boolean; default: not declared - crypto24x7.isHalfDay(date): string; default: not declared - crypto24x7.isHoliday: (date: string) => boolean; default: not declared - crypto24x7.isHoliday(date): string; default: not declared - crypto24x7.isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - crypto24x7.isTradingDay(date): string; default: not declared - crypto24x7.name: string; default: not declared - crypto24x7.nextBusinessDay: (date: string) => string; default: not declared - crypto24x7.nextBusinessDay(date): string; default: not declared - crypto24x7.previousBusinessDay: (date: string) => string; default: not declared - crypto24x7.previousBusinessDay(date): string; default: not declared - crypto24x7.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - crypto24x7.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - crypto24x7.session().return.date: string; default: not declared - crypto24x7.session().return.isBusinessDay: boolean; default: not declared - crypto24x7.session().return.isHalfDay: boolean; default: not declared - crypto24x7.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - crypto24x7.session(date): string; default: not declared - crypto24x7.timezone: string; default: not declared - crypto24x7.version: string; default: not declared - expirations: (calendar: import('@insiderfinance/totalfinance/core').Calendar, range: { from: string; to: string; kind?: import('@insiderfinance/totalfinance/calendars').ExpirationKind; }) => string[]; default: not declared — Option expirations in `[from, to]` (inclusive), holiday-shifted per the calendar. `kind` defaults to `'monthly'` (the classic OPEX dates). - expirations(calendar): import('@insiderfinance/totalfinance/core').Calendar; default: not declared - expirations(calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - expirations(calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - expirations(calendar).isBusinessDay: (date: string) => boolean; default: not declared - expirations(calendar).isHalfDay: (date: string) => boolean; default: not declared - expirations(calendar).isHoliday: (date: string) => boolean; default: not declared - expirations(calendar).name: string; default: not declared - expirations(calendar).nextBusinessDay: (date: string) => string; default: not declared - expirations(calendar).previousBusinessDay: (date: string) => string; default: not declared - expirations(calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - expirations(calendar).timezone: string; default: not declared - expirations(calendar).version: string; default: not declared - expirations(range): { from: string; to: string; kind?: import('@insiderfinance/totalfinance/calendars').ExpirationKind; }; default: not declared - expirations(range).from: string; default: not declared - expirations(range).kind?: import('@insiderfinance/totalfinance/calendars').ExpirationKind; default: not declared - expirations(range).to: string; default: not declared - nextExpiry: (calendar: import('@insiderfinance/totalfinance/core').Calendar, date: string, kind?: import('@insiderfinance/totalfinance/calendars').ExpirationKind) => string; default: not declared — The first expiration strictly after `date` (`kind` defaults to `'weekly'` — the nearest Friday expiry, holiday-shifted). - nextExpiry(calendar): import('@insiderfinance/totalfinance/core').Calendar; default: not declared - nextExpiry(calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - nextExpiry(calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - nextExpiry(calendar).isBusinessDay: (date: string) => boolean; default: not declared - nextExpiry(calendar).isHalfDay: (date: string) => boolean; default: not declared - nextExpiry(calendar).isHoliday: (date: string) => boolean; default: not declared - nextExpiry(calendar).name: string; default: not declared - nextExpiry(calendar).nextBusinessDay: (date: string) => string; default: not declared - nextExpiry(calendar).previousBusinessDay: (date: string) => string; default: not declared - nextExpiry(calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - nextExpiry(calendar).timezone: string; default: not declared - nextExpiry(calendar).version: string; default: not declared - nextExpiry(date): string; default: not declared - nextExpiry(kind)?: import('@insiderfinance/totalfinance/calendars').ExpirationKind; default: not declared - requireCalendar: (functionName: string, value: unknown) => import('@insiderfinance/totalfinance/core').Calendar; default: not declared — Validate that `value` is a usable `Calendar` object; throws a teaching `InputError` otherwise. Shared by every facade in this package so garbage inputs (strings, numbers, `{}`) always produce a typed error naming the `calendar` field instead of a raw `TypeError` on a method access. - requireCalendar().return.addBusinessDays: (date: string, days: number) => string; default: not declared - requireCalendar().return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - requireCalendar().return.isBusinessDay: (date: string) => boolean; default: not declared - requireCalendar().return.isHalfDay: (date: string) => boolean; default: not declared - requireCalendar().return.isHoliday: (date: string) => boolean; default: not declared - requireCalendar().return.name: string; default: not declared - requireCalendar().return.nextBusinessDay: (date: string) => string; default: not declared - requireCalendar().return.previousBusinessDay: (date: string) => string; default: not declared - requireCalendar().return.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - requireCalendar().return.timezone: string; default: not declared - requireCalendar().return.version: string; default: not declared - requireCalendar(functionName): string; default: not declared - requireCalendar(value): unknown; default: not declared - tradingDaysToExpiry: (calendar: import('@insiderfinance/totalfinance/core').Calendar, from: string, expiry: string) => number; default: not declared — Trading sessions remaining until an expiry — the days-to-expiry number traders scale volatility with (`√(tradingDays / 252)`), counted on THIS calendar's actual schedule rather than calendar days ÷ 7 × 5. Counts trading sessions in `(from, expiry]`: the `from` date itself is excluded (it is already underway), the expiry date is included when it is a trading day. Same-day expiry → `0`. An `expiry` before `from` is a typed error, never a negative count. - tradingDaysToExpiry(calendar): import('@insiderfinance/totalfinance/core').Calendar; default: not declared - tradingDaysToExpiry(calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - tradingDaysToExpiry(calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - tradingDaysToExpiry(calendar).isBusinessDay: (date: string) => boolean; default: not declared - tradingDaysToExpiry(calendar).isHalfDay: (date: string) => boolean; default: not declared - tradingDaysToExpiry(calendar).isHoliday: (date: string) => boolean; default: not declared - tradingDaysToExpiry(calendar).name: string; default: not declared - tradingDaysToExpiry(calendar).nextBusinessDay: (date: string) => string; default: not declared - tradingDaysToExpiry(calendar).previousBusinessDay: (date: string) => string; default: not declared - tradingDaysToExpiry(calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - tradingDaysToExpiry(calendar).timezone: string; default: not declared - tradingDaysToExpiry(calendar).version: string; default: not declared - tradingDaysToExpiry(expiry): string; default: not declared - tradingDaysToExpiry(from): string; default: not declared - usMarketClosures: string[]; default: not declared — Ad-hoc full closures that no rule can derive. Complete for the era this list spans (2001→present); dates BEFORE 2001 are not covered — day counts across earlier one-off closures (e.g. the 1994 Nixon mourning day) would be silently wrong, so treat 2001-01-01 as the calendar's historical floor. - usMarketHalfDayRules: import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared - usMarketHolidayRules: import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared - withTradingVocabulary: (calendar: import('@insiderfinance/totalfinance/core').Calendar) => import('@insiderfinance/totalfinance/calendars').TradingCalendar; default: not declared — Extend a core `Calendar` with the trader-vocabulary alias `isTradingDay` (≡ `isBusinessDay`). Returns a new object; the wrapped methods are the ORIGINAL function references (single implementation), so behavior is identical by construction. - withTradingVocabulary().return.addBusinessDays: (date: string, days: number) => string; default: not declared - withTradingVocabulary().return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - withTradingVocabulary().return.isBusinessDay: (date: string) => boolean; default: not declared - withTradingVocabulary().return.isHalfDay: (date: string) => boolean; default: not declared - withTradingVocabulary().return.isHoliday: (date: string) => boolean; default: not declared - withTradingVocabulary().return.isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - withTradingVocabulary().return.name: string; default: not declared - withTradingVocabulary().return.nextBusinessDay: (date: string) => string; default: not declared - withTradingVocabulary().return.previousBusinessDay: (date: string) => string; default: not declared - withTradingVocabulary().return.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - withTradingVocabulary().return.timezone: string; default: not declared - withTradingVocabulary().return.version: string; default: not declared - withTradingVocabulary(calendar): import('@insiderfinance/totalfinance/core').Calendar; default: not declared - withTradingVocabulary(calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - withTradingVocabulary(calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - withTradingVocabulary(calendar).isBusinessDay: (date: string) => boolean; default: not declared - withTradingVocabulary(calendar).isHalfDay: (date: string) => boolean; default: not declared - withTradingVocabulary(calendar).isHoliday: (date: string) => boolean; default: not declared - withTradingVocabulary(calendar).name: string; default: not declared - withTradingVocabulary(calendar).nextBusinessDay: (date: string) => string; default: not declared - withTradingVocabulary(calendar).previousBusinessDay: (date: string) => string; default: not declared - withTradingVocabulary(calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - withTradingVocabulary(calendar).timezone: string; default: not declared - withTradingVocabulary(calendar).version: string; default: not declared ### @insiderfinance/totalfinance#commodities Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const commodities: typeof import('@insiderfinance/totalfinance/commodities'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calendarSpread: (input: import('@insiderfinance/totalfinance/commodities').CalendarSpreadInput) => import('@insiderfinance/totalfinance/commodities').CalendarSpreadResult; default: not declared — The calendar spread between two deliveries: the price spread `far − near`, and the annualized continuous carry the pair implies. Near must genuinely be nearer — a reversed pair is refused rather than silently sign-flipped. - calendarSpread().return.annualizedSpreadRate: number; default: not declared — The CONTINUOUS carry between the two deliveries: `ln(farPoint.forwardPrice / nearPoint.forwardPrice) / (farTime − nearTime)`. - calendarSpread().return.assumptions: { annualizedSpreadRateConvention: string; }; default: not declared - calendarSpread().return.assumptions.annualizedSpreadRateConvention: string; default: not declared — The fixed convention prose: continuous carry between the two deliveries. - calendarSpread().return.diagnostics: { warnings: string[]; }; default: not declared - calendarSpread().return.diagnostics.warnings: string[]; default: not declared - calendarSpread().return.spread: number; default: not declared — `farPoint.forwardPrice − nearPoint.forwardPrice` (price units). - calendarSpread(input): import('@insiderfinance/totalfinance/commodities').CalendarSpreadInput; default: not declared - calendarSpread(input).farPoint: import('@insiderfinance/totalfinance/commodities').CommodityCurvePoint; default: not declared — The farther delivery. - calendarSpread(input).nearPoint: import('@insiderfinance/totalfinance/commodities').CommodityCurvePoint; default: not declared — The nearer delivery — `nearPoint.timeToDeliveryYears < farPoint.timeToDeliveryYears`. - commodityBasis: (input: import('@insiderfinance/totalfinance/commodities').CommodityBasisInput) => import('@insiderfinance/totalfinance/commodities').CommodityBasisResult; default: not declared — The basis between spot and a quoted futures price. `basis` (a price difference) and `basisFraction` (a dimensionless ratio) are DIFFERENT quantities and both deserve names — the library's naming law already blesses exactly this pair. - commodityBasis().return.assumptions: { definition: string; }; default: not declared - commodityBasis().return.assumptions.definition: string; default: not declared — The fixed basis definition prose: price difference and fraction, both named. - commodityBasis().return.basis: number; default: not declared — `spotPrice − futuresPrice` — the basis in price units. - commodityBasis().return.basisFraction: number; default: not declared — `spotPrice / futuresPrice − 1` — the basis as a fraction of the futures price. - commodityBasis().return.diagnostics: { warnings: string[]; }; default: not declared - commodityBasis().return.diagnostics.warnings: string[]; default: not declared - commodityBasis(input): import('@insiderfinance/totalfinance/commodities').CommodityBasisInput; default: not declared - commodityBasis(input).futuresPrice: number; default: not declared — The quoted futures price, > 0. - commodityBasis(input).spotPrice: number; default: not declared — Spot price, > 0. - commodityCarry: (input: import('@insiderfinance/totalfinance/commodities').CommodityCarryInput) => import('@insiderfinance/totalfinance/commodities').CommodityCarryResult; default: not declared — The annualized TOTAL carry a spot/forward pair implies, by inverting the compounding growth factor. When all three components (financing, storage, convenience) are supplied, the result also reports `impliedResidual = annualizedCarryRate − (f + s − c)` and warns when the residual exceeds 1e-9 — a parity-priced forward has residual zero, and a nonzero residual is the parity law made visible, never silently absorbed into a component. - commodityCarry().return.annualizedCarryRate: number; default: not declared — The annualized total carry implied by the spot/forward pair: the rate `r` with `spotPrice × G(r, timeToDeliveryYears) = forwardPrice` (for `'continuous'`, `ln(forwardPrice / spotPrice) / timeToDeliveryYears`). - commodityCarry().return.assumptions: { compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; carryDefinition: string; }; default: not declared - commodityCarry().return.assumptions.carryDefinition: string; default: not declared — The fixed carry definition prose: the rate whose growth factor maps spot to forward. - commodityCarry().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - commodityCarry().return.components?: { annualFinancingRate?: number; annualStorageCostRate?: number; annualConvenienceYield?: number; }; default: not declared — The supplied components, echoed — present when at least one was supplied. - commodityCarry().return.components.annualConvenienceYield?: number; default: not declared - commodityCarry().return.components.annualFinancingRate?: number; default: not declared - commodityCarry().return.components.annualStorageCostRate?: number; default: not declared - commodityCarry().return.diagnostics: { warnings: string[]; }; default: not declared - commodityCarry().return.diagnostics.warnings: string[]; default: not declared - commodityCarry().return.impliedResidual?: number; default: not declared — `annualizedCarryRate − (financing + storage − convenience)` — the cost-of-carry parity law made visible. Present exactly when all three components were supplied. - commodityCarry(input): import('@insiderfinance/totalfinance/commodities').CommodityCarryInput; default: not declared - commodityCarry(input).annualConvenienceYield?: number; default: not declared — Optional supplied component: annual convenience yield, decimal. - commodityCarry(input).annualFinancingRate?: number; default: not declared — Optional supplied component: annual financing rate, decimal. - commodityCarry(input).annualStorageCostRate?: number; default: not declared — Optional supplied component: annual proportional storage cost rate, decimal. - commodityCarry(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED compounding convention used to annualize the implied carry. - commodityCarry(input).forwardPrice: number; default: not declared — The observed forward (or futures) price for the delivery date, > 0. - commodityCarry(input).spotPrice: number; default: not declared — Spot price, > 0. - commodityCarry(input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0 — carry over zero time is undefined, not zero. - commodityForwardPrice: (input: import('@insiderfinance/totalfinance/commodities').CommodityForwardPriceInput) => number; default: not declared — THEORETICAL cost-of-carry forward price: `spotPrice × G(netCarryRate, timeToDeliveryYears)` where `netCarryRate = annualFinancingRate + annualStorageCostRate − annualConvenienceYield` and `G` is the compounding growth factor. For `'continuous'` compounding that is exactly `spotPrice × e^((f + s − c) × t)`. A bare-number primitive (like valuation's `freeCashFlowToFirm`): what carry says the forward SHOULD be, not a quoted futures price and not a contract value. - commodityForwardPrice(input): import('@insiderfinance/totalfinance/commodities').CommodityForwardPriceInput; default: not declared - commodityForwardPrice(input).annualConvenienceYield: number; default: not declared — Annual convenience yield, decimal — the benefit of holding the physical commodity. - commodityForwardPrice(input).annualFinancingRate: number; default: not declared — Annual financing (interest) rate, decimal. - commodityForwardPrice(input).annualStorageCostRate: number; default: not declared — Annual storage cost as a PROPORTIONAL rate of the commodity's value, decimal — not a dollar amount per unit (v1 models storage as a continuous proportional drag, like a negative yield). - commodityForwardPrice(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED compounding convention — a market instrument never defaults its convention. - commodityForwardPrice(input).spotPrice: number; default: not declared — Spot price of the commodity, > 0, in the quote currency per unit. - commodityForwardPrice(input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, ≥ 0 (zero prices the forward at spot exactly). - commodityForwardValue: (input: import('@insiderfinance/totalfinance/commodities').CommodityForwardValueInput) => import('@insiderfinance/totalfinance/commodities').CommodityForwardValueResult; default: not declared — CURRENT VALUE of an existing forward contract: `±(currentForwardPrice − contractForwardPrice) × quantity × discountFactorToDelivery`, positive for `'long'` and negated for `'short'`. The three quantities this module keeps distinct meet here: `contractForwardPrice` is the price STRUCK on the contract, `currentForwardPrice` is today's forward PRICE (quoted or theoretical), and the result is the contract's VALUE — zero at inception when struck at the fair forward. - commodityForwardValue().return.assumptions: { perspective: 'long' | 'short'; discountFactorToDelivery: number; valuationConvention: string; }; default: not declared - commodityForwardValue().return.assumptions.discountFactorToDelivery: number; default: not declared — The factor as supplied — its conventions belong to the caller's curve. - commodityForwardValue().return.assumptions.perspective: 'long' | 'short'; default: not declared - commodityForwardValue().return.assumptions.valuationConvention: string; default: not declared — The fixed valuation prose: ±(current − contract) × quantity × factor, long positive. - commodityForwardValue().return.contractValue: number; default: not declared — The CURRENT VALUE of the existing contract to the stated side (quote currency). - commodityForwardValue().return.diagnostics: { warnings: string[]; }; default: not declared - commodityForwardValue().return.diagnostics.warnings: string[]; default: not declared - commodityForwardValue(input): import('@insiderfinance/totalfinance/commodities').CommodityForwardValueInput; default: not declared - commodityForwardValue(input).contractForwardPrice: number; default: not declared — The forward price STRUCK on the existing contract (the delivery price agreed at inception). - commodityForwardValue(input).currentForwardPrice: number; default: not declared — The CURRENT forward price for the same delivery date — a market quote or a theoretical price from {@link commodityForwardPrice}; either way, a forward PRICE, not a contract value. - commodityForwardValue(input).discountFactorToDelivery: number; default: not declared — EXPLICIT discount factor from the delivery date back to the valuation instant, > 0 — the matched-conventions law: the factor carries its own curve, day count, and compounding, so this function never re-derives one from a rate it would have to guess conventions for. - commodityForwardValue(input).perspective: 'long' | 'short'; default: not declared — Which side of the contract is being valued. - commodityForwardValue(input).quantity: number; default: not declared — Number of units underlying the contract, > 0. - convertCommodityQuantity: (input: import('@insiderfinance/totalfinance/commodities').ConvertCommodityQuantityInput) => import('@insiderfinance/totalfinance/commodities').ConvertCommodityQuantityResult; default: not declared — Convert a commodity quantity between units with an EXPLICIT caller-supplied factor: `convertedQuantity = quantity × conversionFactor`. Economics are preserved exactly when the caller scales prices by the reciprocal (price-per-unit × quantity is invariant). An identity conversion (`fromUnit === toUnit`) with a factor ≠ 1 is a contradiction and is refused. - convertCommodityQuantity().return.assumptions: { fromUnit: string; toUnit: string; conversionFactor: number; conversionSource: string; }; default: not declared - convertCommodityQuantity().return.assumptions.conversionFactor: number; default: not declared - convertCommodityQuantity().return.assumptions.conversionSource: string; default: not declared — The fixed source prose: the factor is the caller's physical fact. - convertCommodityQuantity().return.assumptions.fromUnit: string; default: not declared - convertCommodityQuantity().return.assumptions.toUnit: string; default: not declared - convertCommodityQuantity().return.convertedQuantity: number; default: not declared — `quantity × conversionFactor`, in `toUnit`. - convertCommodityQuantity().return.diagnostics: { warnings: string[]; }; default: not declared - convertCommodityQuantity().return.diagnostics.warnings: string[]; default: not declared - convertCommodityQuantity(input): import('@insiderfinance/totalfinance/commodities').ConvertCommodityQuantityInput; default: not declared - convertCommodityQuantity(input).conversionFactor: number; default: not declared — REQUIRED explicit factor: target units per one source unit. The generic engine does not invent conversion factors (per spec) — 42 gallons per barrel is the CALLER's physical fact. - convertCommodityQuantity(input).fromUnit: string; default: not declared — The unit the quantity is currently in — a label, echoed (e.g. 'barrel'). - convertCommodityQuantity(input).quantity: number; default: not declared - convertCommodityQuantity(input).toUnit: string; default: not declared — The target unit — a label, echoed (e.g. 'gallon'). - curveSpreadAnalytics: (input: import('@insiderfinance/totalfinance/commodities').CurveSpreadAnalyticsInput) => import('@insiderfinance/totalfinance/commodities').CurveSpreadAnalyticsResult; default: not declared — Spread analytics across a whole curve: one {@link CurveSpreadRow} per adjacent pair plus the overall front-to-back row, every rate under the disclosed continuous convention. Linear in the pillar count. - curveSpreadAnalytics().return.adjacentSpreads: import('@insiderfinance/totalfinance/commodities').CurveSpreadRow[]; default: not declared — One row per adjacent pair, in curve order. - curveSpreadAnalytics().return.assumptions: { annualizedSpreadRateConvention: string; }; default: not declared - curveSpreadAnalytics().return.assumptions.annualizedSpreadRateConvention: string; default: not declared — The fixed convention prose: continuous carry per row. - curveSpreadAnalytics().return.diagnostics: { warnings: string[]; }; default: not declared - curveSpreadAnalytics().return.diagnostics.warnings: string[]; default: not declared - curveSpreadAnalytics().return.frontToBack: import('@insiderfinance/totalfinance/commodities').CurveSpreadRow; default: not declared — The overall figures from the first delivery to the last. - curveSpreadAnalytics(input): import('@insiderfinance/totalfinance/commodities').CurveSpreadAnalyticsInput; default: not declared - curveSpreadAnalytics(input).curve: readonly import('@insiderfinance/totalfinance/commodities').CommodityCurvePoint[]; default: not declared — The forward curve — ≥ 2 points, strictly ascending delivery times. - futuresHedgeRatio: (input: import('@insiderfinance/totalfinance/commodities').FuturesHedgeRatioInput) => import('@insiderfinance/totalfinance/commodities').FuturesHedgeRatioResult; default: not declared — Futures contracts required to hedge an exposure: `exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize`. The count is NOT rounded — whether to round up, down, or trade the fraction via a mini contract is an execution decision that belongs to the caller, and the assumptions say so. - futuresHedgeRatio().return.assumptions: { betaOrHedgeEffectiveness: number; hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; rounding: string; }; default: not declared - futuresHedgeRatio().return.assumptions.betaOrHedgeEffectiveness: number; default: not declared - futuresHedgeRatio().return.assumptions.hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; default: not declared - futuresHedgeRatio().return.assumptions.rounding: string; default: not declared — The fixed rounding prose: the count is real-valued; rounding is the caller's decision. - futuresHedgeRatio().return.contractsRequired: number; default: not declared — `exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize` — a REAL number, not rounded: rounding to whole contracts is the caller's execution decision, disclosed in the assumptions rather than taken silently. - futuresHedgeRatio().return.diagnostics: { warnings: string[]; }; default: not declared - futuresHedgeRatio().return.diagnostics.warnings: string[]; default: not declared - futuresHedgeRatio(input): import('@insiderfinance/totalfinance/commodities').FuturesHedgeRatioInput; default: not declared - futuresHedgeRatio(input).betaOrHedgeEffectiveness?: number; default: not declared — The minimum-variance hedge ratio (a regression beta or hedge effectiveness), default 1 — a one-to-one hedge, echoed as such in the assumptions. - futuresHedgeRatio(input).exposureQuantity: number; default: not declared — The exposure being hedged, in commodity units (sign carries the direction). - futuresHedgeRatio(input).futuresContractSize: number; default: not declared — Units of the commodity per futures contract, > 0. - impliedConvenienceYield: (input: import('@insiderfinance/totalfinance/commodities').ImpliedConvenienceYieldInput) => import('@insiderfinance/totalfinance/commodities').ImpliedConvenienceYieldResult; default: not declared — The convenience yield the spot/forward pair implies, given the other carry components — the inverse of {@link commodityForwardPrice} solved for `annualConvenienceYield`. The remaining inputs identify it uniquely: `c = f + s − annualizedCarry`. - impliedConvenienceYield().return.assumptions: { compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; inversion: string; }; default: not declared - impliedConvenienceYield().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - impliedConvenienceYield().return.assumptions.inversion: string; default: not declared — The fixed inversion prose: convenience = financing + storage − implied carry. - impliedConvenienceYield().return.diagnostics: { warnings: string[]; }; default: not declared - impliedConvenienceYield().return.diagnostics.warnings: string[]; default: not declared - impliedConvenienceYield().return.impliedAnnualConvenienceYield: number; default: not declared — `annualFinancingRate + annualStorageCostRate − annualizedCarry` — the yield the pair implies. - impliedConvenienceYield(input): import('@insiderfinance/totalfinance/commodities').ImpliedConvenienceYieldInput; default: not declared - impliedConvenienceYield(input).annualFinancingRate: number; default: not declared — Annual financing rate, decimal. - impliedConvenienceYield(input).annualStorageCostRate: number; default: not declared — Annual proportional storage cost rate, decimal. - impliedConvenienceYield(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED compounding convention. - impliedConvenienceYield(input).forwardPrice: number; default: not declared — The observed forward (or futures) price, > 0. - impliedConvenienceYield(input).spotPrice: number; default: not declared — Spot price, > 0. - impliedConvenienceYield(input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0. - impliedStorageCost: (input: import('@insiderfinance/totalfinance/commodities').ImpliedStorageCostInput) => import('@insiderfinance/totalfinance/commodities').ImpliedStorageCostResult; default: not declared — The proportional storage cost rate the spot/forward pair implies, given the other carry components — the spec's "when the remaining inputs identify it uniquely", which these do: `s = annualizedCarry − f + c`. - impliedStorageCost().return.assumptions: { compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; inversion: string; }; default: not declared - impliedStorageCost().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - impliedStorageCost().return.assumptions.inversion: string; default: not declared — The fixed inversion prose: storage = implied carry − financing + convenience. - impliedStorageCost().return.diagnostics: { warnings: string[]; }; default: not declared - impliedStorageCost().return.diagnostics.warnings: string[]; default: not declared - impliedStorageCost().return.impliedAnnualStorageCostRate: number; default: not declared — `annualizedCarry − annualFinancingRate + annualConvenienceYield` — the rate the pair implies. - impliedStorageCost(input): import('@insiderfinance/totalfinance/commodities').ImpliedStorageCostInput; default: not declared - impliedStorageCost(input).annualConvenienceYield: number; default: not declared — Annual convenience yield, decimal. - impliedStorageCost(input).annualFinancingRate: number; default: not declared — Annual financing rate, decimal. - impliedStorageCost(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED compounding convention. - impliedStorageCost(input).forwardPrice: number; default: not declared — The observed forward (or futures) price, > 0. - impliedStorageCost(input).spotPrice: number; default: not declared — Spot price, > 0. - impliedStorageCost(input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0. - rollReturnDecomposition: (input: import('@insiderfinance/totalfinance/commodities').RollReturnDecompositionInput) => import('@insiderfinance/totalfinance/commodities').RollReturnDecompositionResult; default: not declared — Decompose the return on a long futures position over one holding period ending at a roll. With `S0/S1` the initial/final spot and `F0/F1` the held contract's initial/final (before-roll) prices: - `totalHoldingReturn = F1/F0 − 1` — the observed total; - `spotMoveReturn = S1/S0 − 1`; - `carryConvergenceReturn = (F1/S1)/(F0/S0) − 1` — the basis-ratio change; - and EXACTLY `(1 + total) = (1 + spotMove) × (1 + carryConvergence)`, because `(S1/S0) × ((F1/S1)/(F0/S0)) = F1/F0` — the declared multiplicative convention, tested at the declared residual 1e-12. The roll leg is stated separately: rolling is cash-neutral at execution, so the roll yield `(F1 − N)/N` is the third component of the economics but belongs to the NEXT period's return, and this function never folds it into the holding total. - rollReturnDecomposition().return.assumptions: { reconciliation: string; declaredResidualBound: 1e-12; }; default: not declared - rollReturnDecomposition().return.assumptions.declaredResidualBound: 1e-12; default: not declared - rollReturnDecomposition().return.assumptions.reconciliation: string; default: not declared — The fixed reconciliation prose: the components compound exactly to the observed total. - rollReturnDecomposition().return.carryConvergenceReturn: number; default: not declared — The change in the contract's basis ratio to spot over the period: `(finalContractPriceBeforeRoll / finalSpotPrice) / (initialContractPrice / initialSpotPrice) − 1` — the carry/convergence earned as the contract pulls toward spot (positive for a long in backwardation). - rollReturnDecomposition().return.diagnostics: { warnings: string[]; reconciliationResidual: number; }; default: not declared - rollReturnDecomposition().return.diagnostics.reconciliationResidual: number; default: not declared — `(1 + totalHoldingReturn) − (1 + spotMoveReturn) × (1 + carryConvergenceReturn)` — floating point only. - rollReturnDecomposition().return.diagnostics.warnings: string[]; default: not declared - rollReturnDecomposition().return.rollLeg: { rollYieldFraction: number; convention: string; }; default: not declared — The roll leg, stated SEPARATELY: the roll is cash-neutral at execution, so its yield `(finalContractPriceBeforeRoll − nextContractPriceAtRoll) / nextContractPriceAtRoll` accrues over the NEXT holding period and is never added into `totalHoldingReturn`. - rollReturnDecomposition().return.rollLeg.convention: string; default: not declared — The fixed roll-leg prose: cash-neutral at execution, accrues next period. - rollReturnDecomposition().return.rollLeg.rollYieldFraction: number; default: not declared - rollReturnDecomposition().return.spotMoveReturn: number; default: not declared — `finalSpotPrice / initialSpotPrice − 1` — the spot move over the period. - rollReturnDecomposition().return.totalHoldingReturn: number; default: not declared — The OBSERVED total return on the held contract over the holding period: `finalContractPriceBeforeRoll / initialContractPrice − 1`. - rollReturnDecomposition(input): import('@insiderfinance/totalfinance/commodities').RollReturnDecompositionInput; default: not declared - rollReturnDecomposition(input).finalContractPriceBeforeRoll: number; default: not declared — Price of the held contract at the end of the holding period, BEFORE rolling, > 0. - rollReturnDecomposition(input).finalSpotPrice: number; default: not declared — Spot price at the end of the holding period (the roll instant), > 0. - rollReturnDecomposition(input).initialContractPrice: number; default: not declared — Price of the held contract at the start of the holding period, > 0. - rollReturnDecomposition(input).initialSpotPrice: number; default: not declared — Spot price at the start of the holding period, > 0. - rollReturnDecomposition(input).nextContractPriceAtRoll: number; default: not declared — Price of the next contract at the roll instant, > 0. - rollYield: (input: import('@insiderfinance/totalfinance/commodities').RollYieldInput) => import('@insiderfinance/totalfinance/commodities').RollYieldResult; default: not declared — The roll yield when rolling a LONG position from the expiring contract into the next: `(expiring − next) / next`. Positive in backwardation — the next contract is bought below the expiring one and converges upward under a static curve; negative in contango. When `spotPriceAtRoll` is supplied the result also decomposes both legs against spot; the components compound exactly back to the roll yield (see {@link RollYieldResult.decomposition}). When spot is absent the decomposition is absent WITH its reason — it is never inferred from the contract prices. - rollYield().return.assumptions: { rollDirection: string; signLaw: string; decompositionConvention: string; }; default: not declared - rollYield().return.assumptions.decompositionConvention: string; default: not declared — The fixed decomposition prose: the spot-relative components compound exactly. - rollYield().return.assumptions.rollDirection: string; default: not declared — The fixed direction prose: a long roller out of the expiring contract into the next. - rollYield().return.assumptions.signLaw: string; default: not declared — The fixed sign-law prose: positive in backwardation, negative in contango. - rollYield().return.decomposition?: { expiringVersusSpotFraction: number; nextVersusSpotFraction: number; }; default: not declared — Spot-relative decomposition, present exactly when `spotPriceAtRoll` was supplied. The two components COMPOUND (they do not sum): with `e = expiringVersusSpotFraction` and `n = nextVersusSpotFraction`, `(1 + rollYieldFraction) = (1 + e) / (1 + n)` EXACTLY — an algebraic identity, since `(E/S) / (N/S) = E/N`. - rollYield().return.decomposition.expiringVersusSpotFraction: number; default: not declared — `(expiringContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the expiring contract's residual basis to spot (near zero when rolled at expiry; the carry already converged). - rollYield().return.decomposition.nextVersusSpotFraction: number; default: not declared — `(nextContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the curve slope out to the next contract; NEGATIVE in backwardation, which is exactly where positive roll yield comes from. - rollYield().return.decompositionAbsentReason?: string; default: not declared — Present exactly when the decomposition is absent — the reason, never a guessed spot. - rollYield().return.diagnostics: { warnings: string[]; }; default: not declared - rollYield().return.diagnostics.warnings: string[]; default: not declared - rollYield().return.rollYieldFraction: number; default: not declared — `(expiringContractPrice − nextContractPrice) / nextContractPrice` — the yield a long roller locks in for the next holding period under a static curve. SIGN LAW: positive in backwardation (next below expiring), negative in contango. - rollYield(input): import('@insiderfinance/totalfinance/commodities').RollYieldInput; default: not declared - rollYield(input).expiringContractPrice: number; default: not declared — Price of the contract being rolled OUT of (the expiring one), > 0. - rollYield(input).nextContractPrice: number; default: not declared — Price of the contract being rolled INTO (the next one), > 0. - rollYield(input).spotPriceAtRoll?: number; default: not declared — The spot price at the roll instant, > 0 — supplied only when observed. Without it the spot-relative decomposition is ABSENT with its reason, never guessed. - seasonalityProfile: (input: import('@insiderfinance/totalfinance/commodities').SeasonalityProfileInput) => import('@insiderfinance/totalfinance/commodities').SeasonalityProfileResult; default: not declared — Group caller-supplied dated observations by calendar month and report the requested statistic per month plus the overall mean. Purely descriptive: it never extrapolates an empty month (`null` with reason), and it warns when any month rests on fewer than 3 observations — a "seasonal pattern" read off one or two points is noise wearing a costume. - seasonalityProfile().return.assumptions: { statistic: 'mean' | 'median'; scope: string; }; default: not declared - seasonalityProfile().return.assumptions.scope: string; default: not declared — The fixed scope prose: descriptive only — no seasonality is invented. - seasonalityProfile().return.assumptions.statistic: 'mean' | 'median'; default: not declared - seasonalityProfile().return.diagnostics: { warnings: string[]; observationCountByMonth: number[]; }; default: not declared - seasonalityProfile().return.diagnostics.observationCountByMonth: number[]; default: not declared — Observation counts by calendar month, index 0 = January. - seasonalityProfile().return.diagnostics.warnings: string[]; default: not declared - seasonalityProfile().return.months: import('@insiderfinance/totalfinance/commodities').SeasonalityMonthRow[]; default: not declared — Twelve rows, months 1..12 in order — empty months are null WITH reason, never dropped. - seasonalityProfile().return.overallMean: number; default: not declared — The mean over ALL observations (regardless of the per-month statistic). - seasonalityProfile(input): import('@insiderfinance/totalfinance/commodities').SeasonalityProfileInput; default: not declared - seasonalityProfile(input).observations: readonly import('@insiderfinance/totalfinance/commodities').SeasonalityObservation[]; default: not declared - seasonalityProfile(input).statistic: 'mean' | 'median'; default: not declared — The per-month statistic — explicit, never defaulted. - termStructureState: (input: import('@insiderfinance/totalfinance/commodities').TermStructureStateInput) => import('@insiderfinance/totalfinance/commodities').TermStructureStateResult; default: not declared — Classify a forward curve's term structure with the reasoning disclosed. Each adjacent pair is a segment with fractional slope `far / near − 1`; segments beyond `+flatToleranceFraction` rise, beyond `−flatToleranceFraction` fall, and within the tolerance are flat. ALL rising → `'contango'`; ALL falling → `'backwardation'`; ALL flat → `'flat'`; any other mix → `'indeterminate'`, with the mixed segments named in the diagnostics rather than averaged away. The classification is a pure function of the curve and the tolerance — the same wiggly curve legitimately reads `'flat'` under a loose tolerance and `'indeterminate'` under a tight one. - termStructureState().return.assumptions: { flatToleranceFraction: number; definition: string; }; default: not declared - termStructureState().return.assumptions.definition: string; default: not declared — The fixed classification prose: pairwise slopes against the tolerance, mixes disclosed. - termStructureState().return.assumptions.flatToleranceFraction: number; default: not declared - termStructureState().return.diagnostics: { warnings: string[]; risingSegmentCount: number; fallingSegmentCount: number; flatSegmentCount: number; }; default: not declared - termStructureState().return.diagnostics.fallingSegmentCount: number; default: not declared - termStructureState().return.diagnostics.flatSegmentCount: number; default: not declared - termStructureState().return.diagnostics.risingSegmentCount: number; default: not declared - termStructureState().return.diagnostics.warnings: string[]; default: not declared - termStructureState().return.state: import('@insiderfinance/totalfinance/commodities').TermStructureState; default: not declared - termStructureState(input): import('@insiderfinance/totalfinance/commodities').TermStructureStateInput; default: not declared - termStructureState(input).curve: readonly import('@insiderfinance/totalfinance/commodities').CommodityCurvePoint[]; default: not declared — The forward curve — ≥ 2 points, strictly ascending delivery times. - termStructureState(input).flatToleranceFraction: number; default: not declared — REQUIRED explicit tolerance (e.g. `0.001`): a pairwise price change with `|forwardPrice[i+1] / forwardPrice[i] − 1| ≤ flatToleranceFraction` counts as flat. No default — how much wiggle is "flat" is a judgment the caller must state. ### @insiderfinance/totalfinance#connect Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bind only protocol2 sources. Construction performs no discovery or network work. ```typescript export declare function connect(source: DataProviderSource, options?: DataConnectionOptions): ConnectedData; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: DataConnectionOptions | undefined; default: not declared - (options).maxPages?: number; default: not declared - (options).maxReads?: number; default: not declared - (options).maxRecords?: number; default: not declared - (options).pageSize?: number; default: not declared - (source): DataProviderSource; default: not declared - (source).capabilities: (options?: import('@insiderfinance/totalfinance/core/data').DataCallOptions) => Promise; default: not declared - (source).contractVersion: 2; default: not declared - (source).id: string; default: not declared - (source).protocol: 'totalfinance-data-source'; default: not declared - (source).query: (query: import('@insiderfinance/totalfinance/core/data').DataQuery, page: import('@insiderfinance/totalfinance/core/data').DataPageOptions) => Promise; default: not declared - (source).version: string; default: not declared - return.capabilities: (options?: import('@insiderfinance/totalfinance/core/data').DataCallOptions) => Promise; default: not declared - return.contractVersion: 2; default: not declared - return.id: string; default: not declared - return.priceBars: (request: PriceBarsWindowRequest, options?: PriceBarsWindowOptions) => Promise; default: not declared - return.query: (query: R, options: import('@insiderfinance/totalfinance/core/data').DataQueryOptions) => Promise>; default: not declared - return.resumePriceBars: (checkpoint: unknown, options?: PriceBarsWindowOptions) => Promise; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance#core Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const core: typeof import('@insiderfinance/totalfinance/core'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ArbitrageError: typeof import('@insiderfinance/totalfinance/core').ArbitrageError; default: not declared — Inputs violate a no-arbitrage condition (e.g. a price below intrinsic value). - ArbitrageError().return.code: string; default: not declared - ArbitrageError().return.context?: Record; default: not declared - ArbitrageError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - ArbitrageError(message): string; default: not declared - ArbitrageError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - ArbitrageError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - ArbitrageError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - ArbitrageError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - CONVENTIONS_VERSION: '0.0.1'; default: not declared — Bump this only when default conventions change (major versions only, design law #3). - ConfigurationError: typeof import('@insiderfinance/totalfinance/core').ConfigurationError; default: not declared — The library was configured in a contradictory or unusable way. - ConfigurationError().return.code: string; default: not declared - ConfigurationError().return.context?: Record; default: not declared - ConfigurationError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - ConfigurationError(message): string; default: not declared - ConfigurationError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - ConfigurationError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - ConfigurationError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - ConfigurationError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - ConvergenceError: typeof import('@insiderfinance/totalfinance/core').ConvergenceError; default: not declared — A numerical solver failed to converge. Never silently replaced with a guess (design law #4). - ConvergenceError().return.code: string; default: not declared - ConvergenceError().return.context?: Record; default: not declared - ConvergenceError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - ConvergenceError(message): string; default: not declared - ConvergenceError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - ConvergenceError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - ConvergenceError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - ConvergenceError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - DEFAULT_COMPOUNDING: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - DEFAULT_COMPOUNDING.periodsPerYear: number; default: not declared - DEFAULT_COMPOUNDING.type: 'periodic'; default: not declared - DEFAULT_DAY_COUNT: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Library default conventions (spec §7.4 defaults table). - DEFAULT_DIVIDEND_YIELD: 0; default: not declared - DEFAULT_GREEK_UNITS: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - DEFAULT_GREEK_UNITS.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - DEFAULT_GREEK_UNITS.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - DEFAULT_GREEK_UNITS.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - DataError: typeof import('@insiderfinance/totalfinance/core').DataError; default: not declared — A data-quality problem (crossed/locked market, stale quote, bad print). - DataError().return.code: string; default: not declared - DataError().return.context?: Record; default: not declared - DataError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - DataError(message): string; default: not declared - DataError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - DataError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - DataError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - DataError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - ErrorCode: { readonly InputNaN: 'input.nan'; readonly InputNotFinite: 'input.not_finite'; readonly InputNegativeSpot: 'input.negative_spot'; readonly InputNegativeStrike: 'input.negative_strike'; readonly InputNegativeVolatility: 'input.negative_volatility'; readonly InputNegativeTime: 'input.negative_time'; readonly InputOutOfRange: 'input.out_of_range'; readonly InputInvalidEnum: 'input.invalid_enum'; readonly InputMissingField: 'input.missing_field'; readonly InputUnknownField: 'input.unknown_field'; readonly InputWrongType: 'input.wrong_type'; readonly InputWrongShape: 'input.wrong_shape'; readonly ImpliedVolatilityNoConvergence: 'implied_volatility.no_convergence'; readonly ImpliedVolatilityBelowIntrinsic: 'implied_volatility.below_intrinsic'; readonly ImpliedVolatilityAboveMax: 'implied_volatility.above_max_bound'; readonly EngineUnsupportedContract: 'engine.unsupported_contract'; readonly DataCrossedMarket: 'data.crossed_market'; readonly DataUnsupportedCapability: 'data.unsupported_capability'; readonly DataContractVersionUnsupported: 'data.contract_version_unsupported'; readonly DataAuthenticationRequired: 'data.authentication_required'; readonly DataEntitlementRequired: 'data.entitlement_required'; readonly DataRateLimited: 'data.rate_limited'; readonly DataAllowanceExhausted: 'data.allowance_exhausted'; readonly DataSnapshotExpired: 'data.snapshot_expired'; readonly DataInvalidCursor: 'data.invalid_cursor'; readonly DataNotFound: 'data.not_found'; readonly DataInvalidRequest: 'data.invalid_request'; readonly DataInvalidResponse: 'data.invalid_response'; readonly DataUnavailable: 'data.unavailable'; readonly DataAborted: 'data.aborted'; readonly DataNonconformant: 'data.nonconformant'; readonly DataWindowBudgetExceeded: 'data.window_budget_exceeded'; readonly DataProviderFailure: 'data.provider_failure'; readonly DataSuspectObservations: 'data.suspect_observations'; readonly DataStaleQuote: 'data.stale_quote'; readonly SolverNoConvergence: 'solver.no_convergence'; readonly LinalgNoConvergence: 'linalg.no_convergence'; readonly LinalgNotPositiveDefinite: 'linalg.not_positive_definite'; readonly LinalgSingular: 'linalg.singular'; readonly IntegrationMaxDepth: 'integration.max_depth'; readonly InterpolationOutOfDomain: 'interpolation.out_of_domain'; readonly InterpolationDuplicateKnots: 'interpolation.duplicate_knots'; readonly InterpolationInvalidGrid: 'interpolation.invalid_grid'; readonly OptimizeInvalidBounds: 'optimize.invalid_bounds'; readonly VolatilityExpiryNotFound: 'volatility.expiry_not_found'; readonly VolatilityCalendarArbitrage: 'volatility.calendar_arbitrage'; readonly StrategyInvalidChartRange: 'strategy.invalid_chart_range'; readonly TimeTimezoneResolutionFailed: 'time.timezone_resolution_failed'; readonly TimeValuationInstantRequired: 'time.valuation_instant_required'; readonly BacktestDuplicateHandler: 'backtest.duplicate_handler'; readonly BacktestMixedSymbols: 'backtest.mixed_symbols'; readonly BacktestMarkUnavailable: 'backtest.mark_unavailable'; readonly BacktestAmbiguousIntrabar: 'backtest.ambiguous_intrabar'; readonly BacktestStaleQuote: 'backtest.stale_quote'; readonly BacktestAdapterNonconformant: 'backtest.adapter_nonconformant'; readonly BacktestInputTooLarge: 'backtest.input_too_large'; readonly BacktestDelistingReturnMissing: 'backtest.delisting_return_missing'; readonly BacktestUniverseMembershipUnknown: 'backtest.universe_membership_unknown'; readonly BacktestLedgerReconciliationFailed: 'backtest.ledger_reconciliation_failed'; readonly EnvironmentNotReset: 'environment.not_reset'; readonly EnvironmentDuplicateOrder: 'environment.duplicate_order'; readonly EnvironmentLimitBreach: 'environment.limit_breach'; readonly EnvironmentActionDisallowed: 'environment.action_disallowed'; readonly EnvironmentUnknownInstrument: 'environment.unknown_instrument'; readonly EnvironmentOrderInvalid: 'environment.order_invalid'; readonly EnvironmentActionInvalid: 'environment.action_invalid'; readonly EnvironmentEpisodeOver: 'environment.episode_over'; readonly TradePlanInvalid: 'trade.plan_invalid'; readonly TradePreflightDenied: 'trade.preflight_denied'; readonly TradeGrantInvalid: 'trade.grant_invalid'; readonly TradeGrantExpired: 'trade.grant_expired'; readonly TradeGrantConsumed: 'trade.grant_consumed'; readonly TradeIdempotencyConflict: 'trade.idempotency_conflict'; readonly TradeHalted: 'trade.halted'; readonly TradeLiveUnavailable: 'trade.live_unavailable'; readonly TradeJournalTransitionInvalid: 'trade.journal_transition_invalid'; readonly OperationCapabilityMissing: 'operation.capability_missing'; readonly OperationToolFiltered: 'operation.tool_filtered'; readonly BacktestGridTooLarge: 'backtest.grid_too_large'; readonly BacktestBookTooLarge: 'backtest.book_too_large'; readonly BacktestUnsupportedCorporateAction: 'backtest.unsupported_corporate_action'; readonly OperationUnknown: 'operation.unknown'; readonly OperationRegistrationRefused: 'operation.registration_refused'; readonly OperationInputTooLarge: 'operation.input_too_large'; readonly OperationDeadlineExceeded: 'operation.deadline_exceeded'; readonly OperationCancelled: 'operation.cancelled'; readonly OperationInternal: 'operation.internal'; readonly OperationHandleStoreMissing: 'operation.handle_store_missing'; readonly OperationHandleUnknown: 'operation.handle_unknown'; readonly OperationHandleKindMismatch: 'operation.handle_kind_mismatch'; readonly InputLengthMismatch: 'input.length_mismatch'; readonly InputDuplicateEntry: 'input.duplicate_entry'; readonly McpDeadlineExceeded: 'mcp.deadline_exceeded'; readonly McpInputTooLarge: 'mcp.input_too_large'; readonly McpInternalError: 'mcp.internal_error'; readonly PostconditionNonFinite: 'postcondition.non_finite_result'; readonly McpUnknownTool: 'mcp.unknown_tool'; readonly PipelineDuplicateAlias: 'pipeline.duplicate_alias'; readonly PipelineLengthMismatch: 'pipeline.length_mismatch'; readonly RegistryAliasConflict: 'registry.alias_conflict'; readonly RegistryDuplicateAliasRow: 'registry.duplicate_alias_row'; readonly RegistryDuplicateIndicator: 'registry.duplicate_indicator'; readonly RegistryUnknownAliasTarget: 'registry.unknown_alias_target'; readonly SignalUnknownReference: 'signal.unknown_reference'; readonly SnapshotInvalidVersion: 'snapshot.invalid_version'; readonly SnapshotKindMismatch: 'snapshot.kind_mismatch'; readonly SnapshotUnknownKind: 'snapshot.unknown_kind'; readonly SnapshotUnsupportedVersion: 'snapshot.unsupported_version'; readonly SnapshotWrongShape: 'snapshot.wrong_shape'; readonly StrategyDeltaRequired: 'strategy.delta_required'; readonly StrategyMultiExpiryExpirationAnalytics: 'strategy.multi_expiry_expiration_analytics'; readonly StrategyExpiryConflict: 'strategy.expiry_conflict'; readonly StrategyStrikeUnavailable: 'strategy.strike_unavailable'; readonly VolatilityForwardUnavailable: 'volatility.forward_unavailable'; readonly VolatilitySnapshotVersionMismatch: 'volatility.snapshot_version_mismatch'; readonly EngineProbabilityOutOfRange: 'engine.probability_out_of_range'; readonly EngineResultOutOfBounds: 'engine.result_out_of_bounds'; readonly EngineDiscretizationInadequate: 'engine.discretization_inadequate'; readonly ImpliedVolatilityPriceBelowResolvable: 'implied_volatility.price_below_resolvable'; readonly RiskIllConditionedCovariance: 'risk.ill_conditioned_covariance'; readonly RiskQuantileBeyondSample: 'risk.quantile_beyond_sample'; readonly VolatilityCalibrationFitDeviation: 'volatility.calibration_fit_deviation'; readonly VolatilityNegativeVarianceForecast: 'volatility.negative_variance_forecast'; readonly MathIterationLimit: 'math.iteration_limit'; readonly BacktestOrderSplitAdjusted: 'backtest.order_split_adjusted'; readonly InputSuspiciousCouponRate: 'input.suspicious_coupon_rate'; readonly InputSuspiciousYield: 'input.suspicious_yield'; readonly ModelFellerConditionViolated: 'model.feller_condition_violated'; readonly PricerRequirementUnsatisfied: 'pricer.requirement_unsatisfied'; readonly PricerRequirementInvalid: 'pricer.requirement_invalid'; readonly PricerObservationInvalid: 'pricer.observation_invalid'; readonly PricerNonconformant: 'pricer.nonconformant'; readonly ScenarioInstructionUnmatched: 'scenario.instruction_unmatched'; readonly ScenarioTargetUnsupported: 'scenario.target_unsupported'; readonly ScenarioCellFailed: 'scenario.cell_failed'; readonly SerializationUnsupportedValue: 'serialization.unsupported_value'; readonly ArtifactMigrationMissing: 'artifact.migration_missing'; readonly ArtifactDuplicateMigration: 'artifact.duplicate_migration'; readonly ArtifactIdMismatch: 'artifact.id_mismatch'; readonly ArtifactTypeMismatch: 'artifact.type_mismatch'; readonly ArtifactFamilyMismatch: 'artifact.family_mismatch'; readonly ArtifactModelVersionUnsupported: 'artifact.model_version_unsupported'; readonly ArtifactNotReplayable: 'artifact.not_replayable'; readonly ArtifactReferencedDataMismatch: 'artifact.referenced_data_mismatch'; readonly ArtifactEmbeddedInputTooLarge: 'artifact.embedded_input_too_large'; readonly ArtifactOperationUnsupported: 'artifact.operation_unsupported'; readonly PortfolioDuplicateEventConflict: 'portfolio.duplicate_event_conflict'; readonly PortfolioLotUnavailable: 'portfolio.lot_unavailable'; readonly PortfolioMarkUnavailable: 'portfolio.mark_unavailable'; readonly PortfolioReversalTargetMissing: 'portfolio.reversal_target_missing'; readonly PortfolioReversalInfeasible: 'portfolio.reversal_infeasible'; }; default: not declared — A literal table allows bundlers to discard the registry or unused properties without executing a catalog constructor. The declared key/value/order contract is checked independently below. - ErrorCode.ArtifactDuplicateMigration: 'artifact.duplicate_migration'; default: not declared - ErrorCode.ArtifactEmbeddedInputTooLarge: 'artifact.embedded_input_too_large'; default: not declared - ErrorCode.ArtifactFamilyMismatch: 'artifact.family_mismatch'; default: not declared - ErrorCode.ArtifactIdMismatch: 'artifact.id_mismatch'; default: not declared - ErrorCode.ArtifactMigrationMissing: 'artifact.migration_missing'; default: not declared - ErrorCode.ArtifactModelVersionUnsupported: 'artifact.model_version_unsupported'; default: not declared - ErrorCode.ArtifactNotReplayable: 'artifact.not_replayable'; default: not declared - ErrorCode.ArtifactOperationUnsupported: 'artifact.operation_unsupported'; default: not declared - ErrorCode.ArtifactReferencedDataMismatch: 'artifact.referenced_data_mismatch'; default: not declared - ErrorCode.ArtifactTypeMismatch: 'artifact.type_mismatch'; default: not declared - ErrorCode.BacktestAdapterNonconformant: 'backtest.adapter_nonconformant'; default: not declared - ErrorCode.BacktestAmbiguousIntrabar: 'backtest.ambiguous_intrabar'; default: not declared - ErrorCode.BacktestBookTooLarge: 'backtest.book_too_large'; default: not declared - ErrorCode.BacktestDelistingReturnMissing: 'backtest.delisting_return_missing'; default: not declared - ErrorCode.BacktestDuplicateHandler: 'backtest.duplicate_handler'; default: not declared - ErrorCode.BacktestGridTooLarge: 'backtest.grid_too_large'; default: not declared - ErrorCode.BacktestInputTooLarge: 'backtest.input_too_large'; default: not declared - ErrorCode.BacktestLedgerReconciliationFailed: 'backtest.ledger_reconciliation_failed'; default: not declared - ErrorCode.BacktestMarkUnavailable: 'backtest.mark_unavailable'; default: not declared - ErrorCode.BacktestMixedSymbols: 'backtest.mixed_symbols'; default: not declared - ErrorCode.BacktestOrderSplitAdjusted: 'backtest.order_split_adjusted'; default: not declared - ErrorCode.BacktestStaleQuote: 'backtest.stale_quote'; default: not declared - ErrorCode.BacktestUniverseMembershipUnknown: 'backtest.universe_membership_unknown'; default: not declared - ErrorCode.BacktestUnsupportedCorporateAction: 'backtest.unsupported_corporate_action'; default: not declared - ErrorCode.DataAborted: 'data.aborted'; default: not declared - ErrorCode.DataAllowanceExhausted: 'data.allowance_exhausted'; default: not declared - ErrorCode.DataAuthenticationRequired: 'data.authentication_required'; default: not declared - ErrorCode.DataContractVersionUnsupported: 'data.contract_version_unsupported'; default: not declared - ErrorCode.DataCrossedMarket: 'data.crossed_market'; default: not declared - ErrorCode.DataEntitlementRequired: 'data.entitlement_required'; default: not declared - ErrorCode.DataInvalidCursor: 'data.invalid_cursor'; default: not declared - ErrorCode.DataInvalidRequest: 'data.invalid_request'; default: not declared - ErrorCode.DataInvalidResponse: 'data.invalid_response'; default: not declared - ErrorCode.DataNonconformant: 'data.nonconformant'; default: not declared - ErrorCode.DataNotFound: 'data.not_found'; default: not declared - ErrorCode.DataProviderFailure: 'data.provider_failure'; default: not declared - ErrorCode.DataRateLimited: 'data.rate_limited'; default: not declared - ErrorCode.DataSnapshotExpired: 'data.snapshot_expired'; default: not declared - ErrorCode.DataStaleQuote: 'data.stale_quote'; default: not declared - ErrorCode.DataSuspectObservations: 'data.suspect_observations'; default: not declared - ErrorCode.DataUnavailable: 'data.unavailable'; default: not declared - ErrorCode.DataUnsupportedCapability: 'data.unsupported_capability'; default: not declared - ErrorCode.DataWindowBudgetExceeded: 'data.window_budget_exceeded'; default: not declared - ErrorCode.EngineDiscretizationInadequate: 'engine.discretization_inadequate'; default: not declared - ErrorCode.EngineProbabilityOutOfRange: 'engine.probability_out_of_range'; default: not declared - ErrorCode.EngineResultOutOfBounds: 'engine.result_out_of_bounds'; default: not declared - ErrorCode.EngineUnsupportedContract: 'engine.unsupported_contract'; default: not declared - ErrorCode.EnvironmentActionDisallowed: 'environment.action_disallowed'; default: not declared - ErrorCode.EnvironmentActionInvalid: 'environment.action_invalid'; default: not declared - ErrorCode.EnvironmentDuplicateOrder: 'environment.duplicate_order'; default: not declared - ErrorCode.EnvironmentEpisodeOver: 'environment.episode_over'; default: not declared - ErrorCode.EnvironmentLimitBreach: 'environment.limit_breach'; default: not declared - ErrorCode.EnvironmentNotReset: 'environment.not_reset'; default: not declared - ErrorCode.EnvironmentOrderInvalid: 'environment.order_invalid'; default: not declared - ErrorCode.EnvironmentUnknownInstrument: 'environment.unknown_instrument'; default: not declared - ErrorCode.ImpliedVolatilityAboveMax: 'implied_volatility.above_max_bound'; default: not declared - ErrorCode.ImpliedVolatilityBelowIntrinsic: 'implied_volatility.below_intrinsic'; default: not declared - ErrorCode.ImpliedVolatilityNoConvergence: 'implied_volatility.no_convergence'; default: not declared - ErrorCode.ImpliedVolatilityPriceBelowResolvable: 'implied_volatility.price_below_resolvable'; default: not declared - ErrorCode.InputDuplicateEntry: 'input.duplicate_entry'; default: not declared - ErrorCode.InputInvalidEnum: 'input.invalid_enum'; default: not declared - ErrorCode.InputLengthMismatch: 'input.length_mismatch'; default: not declared - ErrorCode.InputMissingField: 'input.missing_field'; default: not declared - ErrorCode.InputNaN: 'input.nan'; default: not declared - ErrorCode.InputNegativeSpot: 'input.negative_spot'; default: not declared - ErrorCode.InputNegativeStrike: 'input.negative_strike'; default: not declared - ErrorCode.InputNegativeTime: 'input.negative_time'; default: not declared - ErrorCode.InputNegativeVolatility: 'input.negative_volatility'; default: not declared - ErrorCode.InputNotFinite: 'input.not_finite'; default: not declared - ErrorCode.InputOutOfRange: 'input.out_of_range'; default: not declared - ErrorCode.InputSuspiciousCouponRate: 'input.suspicious_coupon_rate'; default: not declared - ErrorCode.InputSuspiciousYield: 'input.suspicious_yield'; default: not declared - ErrorCode.InputUnknownField: 'input.unknown_field'; default: not declared - ErrorCode.InputWrongShape: 'input.wrong_shape'; default: not declared - ErrorCode.InputWrongType: 'input.wrong_type'; default: not declared - ErrorCode.IntegrationMaxDepth: 'integration.max_depth'; default: not declared - ErrorCode.InterpolationDuplicateKnots: 'interpolation.duplicate_knots'; default: not declared - ErrorCode.InterpolationInvalidGrid: 'interpolation.invalid_grid'; default: not declared - ErrorCode.InterpolationOutOfDomain: 'interpolation.out_of_domain'; default: not declared - ErrorCode.LinalgNoConvergence: 'linalg.no_convergence'; default: not declared - ErrorCode.LinalgNotPositiveDefinite: 'linalg.not_positive_definite'; default: not declared - ErrorCode.LinalgSingular: 'linalg.singular'; default: not declared - ErrorCode.MathIterationLimit: 'math.iteration_limit'; default: not declared - ErrorCode.McpDeadlineExceeded: 'mcp.deadline_exceeded'; default: not declared - ErrorCode.McpInputTooLarge: 'mcp.input_too_large'; default: not declared - ErrorCode.McpInternalError: 'mcp.internal_error'; default: not declared - ErrorCode.McpUnknownTool: 'mcp.unknown_tool'; default: not declared - ErrorCode.ModelFellerConditionViolated: 'model.feller_condition_violated'; default: not declared - ErrorCode.OperationCancelled: 'operation.cancelled'; default: not declared - ErrorCode.OperationCapabilityMissing: 'operation.capability_missing'; default: not declared - ErrorCode.OperationDeadlineExceeded: 'operation.deadline_exceeded'; default: not declared - ErrorCode.OperationHandleKindMismatch: 'operation.handle_kind_mismatch'; default: not declared - ErrorCode.OperationHandleStoreMissing: 'operation.handle_store_missing'; default: not declared - ErrorCode.OperationHandleUnknown: 'operation.handle_unknown'; default: not declared - ErrorCode.OperationInputTooLarge: 'operation.input_too_large'; default: not declared - ErrorCode.OperationInternal: 'operation.internal'; default: not declared - ErrorCode.OperationRegistrationRefused: 'operation.registration_refused'; default: not declared - ErrorCode.OperationToolFiltered: 'operation.tool_filtered'; default: not declared - ErrorCode.OperationUnknown: 'operation.unknown'; default: not declared - ErrorCode.OptimizeInvalidBounds: 'optimize.invalid_bounds'; default: not declared - ErrorCode.PipelineDuplicateAlias: 'pipeline.duplicate_alias'; default: not declared - ErrorCode.PipelineLengthMismatch: 'pipeline.length_mismatch'; default: not declared - ErrorCode.PortfolioDuplicateEventConflict: 'portfolio.duplicate_event_conflict'; default: not declared - ErrorCode.PortfolioLotUnavailable: 'portfolio.lot_unavailable'; default: not declared - ErrorCode.PortfolioMarkUnavailable: 'portfolio.mark_unavailable'; default: not declared - ErrorCode.PortfolioReversalInfeasible: 'portfolio.reversal_infeasible'; default: not declared - ErrorCode.PortfolioReversalTargetMissing: 'portfolio.reversal_target_missing'; default: not declared - ErrorCode.PostconditionNonFinite: 'postcondition.non_finite_result'; default: not declared - ErrorCode.PricerNonconformant: 'pricer.nonconformant'; default: not declared - ErrorCode.PricerObservationInvalid: 'pricer.observation_invalid'; default: not declared - ErrorCode.PricerRequirementInvalid: 'pricer.requirement_invalid'; default: not declared - ErrorCode.PricerRequirementUnsatisfied: 'pricer.requirement_unsatisfied'; default: not declared - ErrorCode.RegistryAliasConflict: 'registry.alias_conflict'; default: not declared - ErrorCode.RegistryDuplicateAliasRow: 'registry.duplicate_alias_row'; default: not declared - ErrorCode.RegistryDuplicateIndicator: 'registry.duplicate_indicator'; default: not declared - ErrorCode.RegistryUnknownAliasTarget: 'registry.unknown_alias_target'; default: not declared - ErrorCode.RiskIllConditionedCovariance: 'risk.ill_conditioned_covariance'; default: not declared - ErrorCode.RiskQuantileBeyondSample: 'risk.quantile_beyond_sample'; default: not declared - ErrorCode.ScenarioCellFailed: 'scenario.cell_failed'; default: not declared - ErrorCode.ScenarioInstructionUnmatched: 'scenario.instruction_unmatched'; default: not declared - ErrorCode.ScenarioTargetUnsupported: 'scenario.target_unsupported'; default: not declared - ErrorCode.SerializationUnsupportedValue: 'serialization.unsupported_value'; default: not declared - ErrorCode.SignalUnknownReference: 'signal.unknown_reference'; default: not declared - ErrorCode.SnapshotInvalidVersion: 'snapshot.invalid_version'; default: not declared - ErrorCode.SnapshotKindMismatch: 'snapshot.kind_mismatch'; default: not declared - ErrorCode.SnapshotUnknownKind: 'snapshot.unknown_kind'; default: not declared - ErrorCode.SnapshotUnsupportedVersion: 'snapshot.unsupported_version'; default: not declared - ErrorCode.SnapshotWrongShape: 'snapshot.wrong_shape'; default: not declared - ErrorCode.SolverNoConvergence: 'solver.no_convergence'; default: not declared - ErrorCode.StrategyDeltaRequired: 'strategy.delta_required'; default: not declared - ErrorCode.StrategyExpiryConflict: 'strategy.expiry_conflict'; default: not declared - ErrorCode.StrategyInvalidChartRange: 'strategy.invalid_chart_range'; default: not declared - ErrorCode.StrategyMultiExpiryExpirationAnalytics: 'strategy.multi_expiry_expiration_analytics'; default: not declared - ErrorCode.StrategyStrikeUnavailable: 'strategy.strike_unavailable'; default: not declared - ErrorCode.TimeTimezoneResolutionFailed: 'time.timezone_resolution_failed'; default: not declared - ErrorCode.TimeValuationInstantRequired: 'time.valuation_instant_required'; default: not declared - ErrorCode.TradeGrantConsumed: 'trade.grant_consumed'; default: not declared - ErrorCode.TradeGrantExpired: 'trade.grant_expired'; default: not declared - ErrorCode.TradeGrantInvalid: 'trade.grant_invalid'; default: not declared - ErrorCode.TradeHalted: 'trade.halted'; default: not declared - ErrorCode.TradeIdempotencyConflict: 'trade.idempotency_conflict'; default: not declared - ErrorCode.TradeJournalTransitionInvalid: 'trade.journal_transition_invalid'; default: not declared - ErrorCode.TradeLiveUnavailable: 'trade.live_unavailable'; default: not declared - ErrorCode.TradePlanInvalid: 'trade.plan_invalid'; default: not declared - ErrorCode.TradePreflightDenied: 'trade.preflight_denied'; default: not declared - ErrorCode.VolatilityCalendarArbitrage: 'volatility.calendar_arbitrage'; default: not declared - ErrorCode.VolatilityCalibrationFitDeviation: 'volatility.calibration_fit_deviation'; default: not declared - ErrorCode.VolatilityExpiryNotFound: 'volatility.expiry_not_found'; default: not declared - ErrorCode.VolatilityForwardUnavailable: 'volatility.forward_unavailable'; default: not declared - ErrorCode.VolatilityNegativeVarianceForecast: 'volatility.negative_variance_forecast'; default: not declared - ErrorCode.VolatilitySnapshotVersionMismatch: 'volatility.snapshot_version_mismatch'; default: not declared - InputError: typeof import('@insiderfinance/totalfinance/core').InputError; default: not declared — Invalid or nonsensical input (programmer error or malformed payload). - InputError().return.code: string; default: not declared - InputError().return.context?: Record; default: not declared - InputError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - InputError(message): string; default: not declared - InputError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - InputError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - InputError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - InputError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - ORDER_SIDES: readonly import('@insiderfinance/totalfinance/core').OrderSide[]; default: not declared - ORDER_TYPES: readonly import('@insiderfinance/totalfinance/core').OrderType[]; default: not declared - PostconditionError: typeof import('@insiderfinance/totalfinance/core').PostconditionError; default: not declared — A LIBRARY defect surfaced loudly (Law 7 runtime postcondition): a successful facade/analysis result was about to carry an undisclosed NaN/Infinity. This is never a user-input error — if you see it, please report it with the inputs; the honest alternatives are `null`-with-reason or a disclosed diagnostic, and the function failed to produce either. - PostconditionError().return.code: string; default: not declared - PostconditionError().return.context?: Record; default: not declared - PostconditionError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - PostconditionError(message): string; default: not declared - PostconditionError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - PostconditionError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - PostconditionError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - PostconditionError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - QuantError: typeof import('@insiderfinance/totalfinance/core').QuantError; default: not declared — Base class for every TotalFinance error. - QuantError().return.code: string; default: not declared - QuantError().return.context?: Record; default: not declared - QuantError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - QuantError(message): string; default: not declared - QuantError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - QuantError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - QuantError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - QuantError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - TIME_IN_FORCE_VALUES: readonly import('@insiderfinance/totalfinance/core').TimeInForce[]; default: not declared - US_EQUITY_HALF_DAY_RULES: readonly import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared — US equity/options early-close (13:00 ET) rules — the ONE table, consumed by `@insiderfinance/totalfinance/calendars` as well: the day after Thanksgiving, and 24 December and 3 July when they fall on a weekday and are not themselves the observed Christmas / Independence Day holiday. A rule returns the candidate date for a year; {@link isUsEquityHalfDay} applies the weekday/observance exclusions. - UnsupportedError: typeof import('@insiderfinance/totalfinance/core').UnsupportedError; default: not declared — A requested operation is not supported by the selected engine/model/contract. - UnsupportedError().return.code: string; default: not declared - UnsupportedError().return.context?: Record; default: not declared - UnsupportedError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - UnsupportedError(message): string; default: not declared - UnsupportedError(options): import('@insiderfinance/totalfinance/core').QuantErrorOptions; default: not declared - UnsupportedError(options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - UnsupportedError(options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - UnsupportedError(options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - WarningCode: { readonly DataUnknownTimes: 'data.unknown_times'; readonly DataIncompleteTerms: 'data.incomplete_terms'; readonly DataCoverageUnverified: 'data.coverage_unverified'; readonly DataResearchOnly: 'data.research_only'; readonly DataMissingField: 'data.missing_field'; readonly DataSourceIssue: 'data.source_issue'; readonly PortfolioMarketMarkAge: 'portfolio.market_mark_age'; readonly CalendarOutsideHistoricalCoverage: 'calendar.outside_historical_coverage'; readonly PortfolioDisclosedHoldingsReview: 'portfolio.disclosed_holdings_review'; readonly DataLockedMarket: 'data.locked_market'; readonly DataZeroBidAsk: 'data.zero_bid_ask'; readonly SurfaceExtrapolated: 'volatility.surface_extrapolated'; readonly BinomialStepsRoundedOdd: 'binomial.steps_rounded_odd'; readonly GreeksNotComputed: 'greeks.not_computed'; readonly SuspiciousVolatility: 'input.suspicious_volatility'; readonly SuspiciousTime: 'input.suspicious_time'; readonly SuspiciousRiskFreeRate: 'input.suspicious_risk_free_rate'; readonly SuspiciousReturns: 'input.suspicious_returns'; readonly DegenerateInput: 'input.degenerate'; readonly LambdaUndefined: 'greeks.lambda_undefined'; readonly CompoundingUndefined: 'crypto.compounding_undefined'; readonly CompoundingOverflow: 'crypto.compounding_overflow'; readonly CovarianceFloored: 'math.covariance_floored'; readonly GreeksUnsupportedByEngine: 'greeks.unsupported_by_engine'; readonly ModelLimitation: 'model.limitation'; readonly ScenarioUnusedCurrencyConversion: 'scenario.unused_currency_conversion'; readonly BacktestAssignment: 'backtest.assignment'; readonly BacktestDataDuplicateTimestamp: 'backtest.data_duplicate_timestamp'; readonly BacktestDataNonfinite: 'backtest.data_nonfinite'; readonly BacktestDataMissing: 'backtest.data_missing'; readonly BacktestLimitRejected: 'backtest.limit_rejected'; readonly BacktestComboLegUnfilled: 'backtest.combo_leg_unfilled'; readonly BacktestMarginBreach: 'backtest.margin_breach'; readonly BacktestForcedLiquidation: 'backtest.forced_liquidation'; readonly BacktestDataUnsorted: 'backtest.data_unsorted'; readonly BacktestEntrySkipped: 'backtest.entry_skipped'; readonly BacktestMarkFallback: 'backtest.mark_fallback'; readonly BacktestLookahead: 'backtest.lookahead'; readonly BacktestMarginRejected: 'backtest.margin_rejected'; readonly BacktestMarkedAtCost: 'backtest.marked_at_cost'; readonly BacktestNegativeCash: 'backtest.negative_cash'; readonly BacktestShortRejected: 'backtest.short_rejected'; readonly BacktestSignalWarmup: 'backtest.signal_warmup'; readonly CryptoCarryArbitrage: 'crypto.carry_arbitrage'; readonly CryptoExtremeFunding: 'crypto.extreme_funding'; readonly EstimateRiskNeutral: 'estimate.risk_neutral'; readonly FlowSweepsNotVenueVerified: 'flow.sweeps_not_venue_verified'; readonly HestonCosineExpansionUnstable: 'heston.cosine_expansion_unstable'; readonly HestonFellerViolated: 'heston.feller_violated'; readonly ImpliedVolatilityBracketExpanded: 'implied_volatility.bracket_expanded'; readonly ImpliedVolatilityFlatHistory: 'implied_volatility.flat_history'; readonly ImpliedVolatilityLowVega: 'implied_volatility.low_vega'; readonly LookbackZeroCarry: 'lookback.zero_carry'; readonly MathCovarianceEwmaEffectiveSample: 'math.covariance_ewma_effective_sample'; readonly MathCovarianceIllConditioned: 'math.covariance_ill_conditioned'; readonly MathCovarianceMethodAuto: 'math.covariance_method_auto'; readonly MathCovarianceSingular: 'math.covariance_singular'; readonly MonteCarloQuasiMonteCarloDimensionFallback: 'monte_carlo.quasi_monte_carlo_dimension_fallback'; readonly OptimizeNotConverged: 'optimize.not_converged'; readonly OperationUntypedWarning: 'operation.untyped_warning'; readonly OptionsDividendsNone: 'options.dividends_none'; readonly OptionsDividendsPast: 'options.dividends_past'; readonly OptionsExerciseDiscreteDividends: 'options.exercise_discrete_dividends'; readonly OptionsChainHealthModelNotRequested: 'options.chain_health.model_not_requested'; readonly PerformanceSuspiciousEquityInput: 'performance.suspicious_equity_input'; readonly PerformanceNonFiniteMetric: 'performance.non_finite_metric'; readonly PerformanceEmptySeries: 'performance.empty_series'; readonly RiskZeroGrossExposure: 'risk.zero_gross_exposure'; readonly OptionsEngineFailed: 'options.engine_failed'; readonly TechnicalAnalysisOpeningRangeTruncated: 'technical_analysis.opening_range_truncated'; readonly StructureFlatBaseline: 'structure.flat_baseline'; readonly VolatilityCalibrationNotConverged: 'volatility.calibration_not_converged'; readonly PerformanceUndefinedMetric: 'performance.undefined_metric'; readonly ResearchSurvivorshipBias: 'research.survivorship_bias'; readonly ResearchTrainTestLeakage: 'research.train_test_leakage'; readonly ResearchBacktestOverfittingProbabilityTrimmed: 'research.backtest_overfitting_probability_trimmed'; readonly RiskBrinsonWeights: 'risk.brinson_weights'; readonly RiskCornishFisherConditionalValueAtRiskGaussianFallback: 'risk.cornish_fisher_conditional_value_at_risk_gaussian_fallback'; readonly RiskCornishFisherOutOfDomain: 'risk.cornish_fisher_out_of_domain'; readonly RiskCostExceedsEdge: 'risk.cost_exceeds_edge'; readonly RiskAsOfUnscreened: 'risk.as_of_unscreened'; readonly RiskZeroVolatilitySharpe: 'risk.zero_volatility_sharpe'; readonly RiskFrontierUnboundedReturn: 'risk.frontier_unbounded_return'; readonly RiskFrontierNotMonotone: 'risk.frontier_not_monotone'; readonly RiskFrontierPointsFailed: 'risk.frontier_points_failed'; readonly RiskExtremeValueConfidenceOutsideTail: 'risk.extreme_value_confidence_outside_tail'; readonly RiskExtremeValueDegenerateFit: 'risk.extreme_value_degenerate_fit'; readonly RiskExtremeValueFewExceedances: 'risk.extreme_value_few_exceedances'; readonly RiskExtremeValueInfiniteMean: 'risk.extreme_value_infinite_mean'; readonly RiskExtremeValueInfiniteVariance: 'risk.extreme_value_infinite_variance'; readonly RiskExtremeValueMleFallback: 'risk.extreme_value_mle_fallback'; readonly RiskHighCostDrag: 'risk.high_cost_drag'; readonly RiskInfeasibleConstraints: 'risk.infeasible_constraints'; readonly RiskInfeasibleTangency: 'risk.infeasible_tangency'; readonly RiskKellyEstimationNoEdge: 'risk.kelly_estimation_no_edge'; readonly RiskKellyEstimationThinSample: 'risk.kelly_estimation_thin_sample'; readonly RiskKellyFatTails: 'risk.kelly_fat_tails'; readonly RiskKellyNaiveOverbet: 'risk.kelly_naive_overbet'; readonly RiskKellyNegativeSum: 'risk.kelly_negative_sum'; readonly RiskKellyNoEdge: 'risk.kelly_no_edge'; readonly RiskKellyOver: 'risk.kelly_over'; readonly RiskKellyUnbounded: 'risk.kelly_unbounded'; readonly RiskMeanExcessNoLinearRegion: 'risk.mean_excess_no_linear_region'; readonly RiskPnlUnexplainedResidual: 'risk.pnl_unexplained_residual'; readonly RiskUnboundedLoss: 'risk.unbounded_loss'; readonly StrategyVolatilityFloored: 'strategy.volatility_floored'; readonly StrategyRiskRewardUndefined: 'strategy.risk_reward_undefined'; readonly StrategyOptimizerZeroCapital: 'strategy.optimizer_zero_capital'; readonly StructureAggressorUnavailable: 'structure.aggressor_unavailable'; readonly StructureContractsSkipped: 'structure.contracts_skipped'; readonly StructureDuplicateContractQuotes: 'structure.duplicate_contract_quotes'; readonly StructureNoEligibleQuotes: 'structure.no_eligible_quotes'; readonly VolatilityButterflyArbitrage: 'volatility.butterfly_arbitrage'; readonly VolatilityEssviButterfly: 'volatility.essvi_butterfly'; readonly VolatilityEssviCalendar: 'volatility.essvi_calendar'; readonly VolatilityEssviCalendarData: 'volatility.essvi_calendar_data'; readonly VolatilityEssviNotConverged: 'volatility.essvi_not_converged'; readonly VolatilityFitInsufficientData: 'volatility.fit_insufficient_data'; readonly VolatilityFitUnconverged: 'volatility.fit_unconverged'; readonly VolatilityShockDegradedToInterpolated: 'volatility.shock_degraded_to_interpolated'; readonly VolatilityShockFloored: 'volatility.shock_floored'; readonly VolatilitySkewDeltaExtrapolated: 'volatility.skew_delta_extrapolated'; readonly VolatilityObservedSkewUnavailable: 'volatility.observed_skew_unavailable'; readonly VolatilityObservedSkewQuoteExcluded: 'volatility.observed_skew_quote_excluded'; readonly RiskKellyZeroVariance: 'risk.kelly_zero_variance'; readonly RiskSharpeUndefined: 'risk.sharpe_undefined'; readonly OptionsChainGreeksRowsSkipped: 'chain_greeks.rows_skipped'; readonly VolatilityObservedSkewMissingDelta: 'volatility.observed_skew_missing_delta'; readonly VolatilityObservedSkewDuplicateContract: 'volatility.observed_skew_duplicate_contract'; readonly VolatilitySsviButterfly: 'volatility.ssvi_butterfly'; readonly VolatilitySsviCalendarData: 'volatility.ssvi_calendar_data'; readonly VolatilitySsviNotConverged: 'volatility.ssvi_not_converged'; readonly VolatilityStickyIndeterminate: 'volatility.sticky_indeterminate'; readonly VolatilityStickyWeakFit: 'volatility.sticky_weak_fit'; readonly VolatilitySurfaceQuotesSkipped: 'volatility.surface_quotes_skipped'; readonly VolatilitySurfaceSparse: 'volatility.surface_sparse'; readonly VolatilitySwaptionCubeExtrapolated: 'volatility.swaption_cube_extrapolated'; readonly VolatilitySwaptionNodePoorFit: 'volatility.swaption_node_poor_fit'; readonly ArtifactLibraryVersionDiffers: 'artifact.library_version_differs'; readonly ArtifactComparisonDifferentMarket: 'artifact.comparison_different_market'; readonly ArtifactComparisonDifferentUniverse: 'artifact.comparison_different_universe'; readonly CurveExtrapolated: 'curve.extrapolated'; }; default: not declared — Canonical warning codes. Like error codes, these are stable public API — consumers branch on them. The set is open; packages may add codes, but documented ones do not change without a major version. Codes that are BOTH a thrown-error condition and an emitted warning (`implied_volatility.below_intrinsic`, `implied_volatility.above_max_bound`, `implied_volatility.no_convergence`, `data.crossed_market`, `data.stale_quote`) live only in {@link ErrorCode} — the single source of truth — and warning sites reference `ErrorCode.*` for the code string, so no string is duplicated across the two registries (WS2.9). - WarningCode.ArtifactComparisonDifferentMarket: 'artifact.comparison_different_market'; default: not declared — Two artifacts under comparison were computed under different market snapshots — still comparable, but the reader is told the market moved (Stage 4.5). - WarningCode.ArtifactComparisonDifferentUniverse: 'artifact.comparison_different_universe'; default: not declared — Two research runs under comparison were computed over different universes or as-of dates — still comparable, but the reader is told the population moved (Stage 4.5). - WarningCode.ArtifactLibraryVersionDiffers: 'artifact.library_version_differs'; default: not declared — Two artifacts under comparison or replay name different producing library versions — a difference may be a library change rather than a market or parameter change (Stage 4.5). - WarningCode.BacktestAssignment: 'backtest.assignment'; default: not declared - WarningCode.BacktestComboLegUnfilled: 'backtest.combo_leg_unfilled'; default: not declared — Stage 4.6 (FC8) — a structure could not fill every leg under the fill policy (the row names the legs). - WarningCode.BacktestDataDuplicateTimestamp: 'backtest.data_duplicate_timestamp'; default: not declared - WarningCode.BacktestDataMissing: 'backtest.data_missing'; default: not declared — Stage 4.6 (FC8): a benchmark session had no return and counted as 0; the count rides the warning. - WarningCode.BacktestDataNonfinite: 'backtest.data_nonfinite'; default: not declared - WarningCode.BacktestDataUnsorted: 'backtest.data_unsorted'; default: not declared - WarningCode.BacktestEntrySkipped: 'backtest.entry_skipped'; default: not declared - WarningCode.BacktestForcedLiquidation: 'backtest.forced_liquidation'; default: not declared — Stage 4.6 (FC8) — a forced close under the declared liquidation policy (the row names the position and the shortfall). - WarningCode.BacktestLimitRejected: 'backtest.limit_rejected'; default: not declared — Stage 4.6 (FC8) — a pre-trade limit rejected an entry (the row names the limit and the values). - WarningCode.BacktestLookahead: 'backtest.lookahead'; default: not declared - WarningCode.BacktestMarginBreach: 'backtest.margin_breach'; default: not declared — Stage 4.6 (FC8) — maintenance margin breached under forcedLiquidation 'none'. - WarningCode.BacktestMarginRejected: 'backtest.margin_rejected'; default: not declared - WarningCode.BacktestMarkFallback: 'backtest.mark_fallback'; default: not declared — An open option leg could not be marked from its current-snapshot quote and the request's named missing-mark fallback was applied (Preview P1) — the count of leg-snapshots is carried. - WarningCode.BacktestMarkedAtCost: 'backtest.marked_at_cost'; default: not declared - WarningCode.BacktestNegativeCash: 'backtest.negative_cash'; default: not declared - WarningCode.BacktestShortRejected: 'backtest.short_rejected'; default: not declared - WarningCode.BacktestSignalWarmup: 'backtest.signal_warmup'; default: not declared - WarningCode.BinomialStepsRoundedOdd: 'binomial.steps_rounded_odd'; default: not declared - WarningCode.CalendarOutsideHistoricalCoverage: 'calendar.outside_historical_coverage'; default: not declared — Rules/closures do not certify historical sessions before the documented floor. - WarningCode.CompoundingOverflow: 'crypto.compounding_overflow'; default: not declared — Compounded annualization exceeded IEEE-754 range — reported as `null`, never Infinity. - WarningCode.CompoundingUndefined: 'crypto.compounding_undefined'; default: not declared — Fractional compounding of a ≤−100%-per-interval rate is undefined — reported as `null`, never NaN. - WarningCode.CovarianceFloored: 'math.covariance_floored'; default: not declared — A degenerate/collinear covariance was eigenvalue-floored to keep the SPD postcondition. - WarningCode.CryptoCarryArbitrage: 'crypto.carry_arbitrage'; default: not declared - WarningCode.CryptoExtremeFunding: 'crypto.extreme_funding'; default: not declared - WarningCode.CurveExtrapolated: 'curve.extrapolated'; default: not declared — A restored curve was evaluated outside its calibrated pillar range under its stored extrapolation policy — counted and disclosed, never silent (Stage 4.5). - WarningCode.DataCoverageUnverified: 'data.coverage_unverified'; default: not declared - WarningCode.DataIncompleteTerms: 'data.incomplete_terms'; default: not declared - WarningCode.DataLockedMarket: 'data.locked_market'; default: not declared - WarningCode.DataMissingField: 'data.missing_field'; default: not declared - WarningCode.DataResearchOnly: 'data.research_only'; default: not declared - WarningCode.DataSourceIssue: 'data.source_issue'; default: not declared - WarningCode.DataUnknownTimes: 'data.unknown_times'; default: not declared - WarningCode.DataZeroBidAsk: 'data.zero_bid_ask'; default: not declared - WarningCode.DegenerateInput: 'input.degenerate'; default: not declared — The result is NaN/degenerate BY DESIGN (empty series, zero variance) — disclosed, not fabricated. - WarningCode.EstimateRiskNeutral: 'estimate.risk_neutral'; default: not declared - WarningCode.FlowSweepsNotVenueVerified: 'flow.sweeps_not_venue_verified'; default: not declared - WarningCode.GreeksNotComputed: 'greeks.not_computed'; default: not declared - WarningCode.GreeksUnsupportedByEngine: 'greeks.unsupported_by_engine'; default: not declared — Greeks were explicitly requested but this engine cannot compute them — request not honored. - WarningCode.HestonCosineExpansionUnstable: 'heston.cosine_expansion_unstable'; default: not declared - WarningCode.HestonFellerViolated: 'heston.feller_violated'; default: not declared - WarningCode.ImpliedVolatilityBracketExpanded: 'implied_volatility.bracket_expanded'; default: not declared - WarningCode.ImpliedVolatilityFlatHistory: 'implied_volatility.flat_history'; default: not declared - WarningCode.ImpliedVolatilityLowVega: 'implied_volatility.low_vega'; default: not declared - WarningCode.LambdaUndefined: 'greeks.lambda_undefined'; default: not declared — Elasticity Λ = Δ·S/V is undefined (price underflowed to 0) — reported as `null`, never NaN/∞. - WarningCode.LookbackZeroCarry: 'lookback.zero_carry'; default: not declared - WarningCode.MathCovarianceEwmaEffectiveSample: 'math.covariance_ewma_effective_sample'; default: not declared - WarningCode.MathCovarianceIllConditioned: 'math.covariance_ill_conditioned'; default: not declared - WarningCode.MathCovarianceMethodAuto: 'math.covariance_method_auto'; default: not declared - WarningCode.MathCovarianceSingular: 'math.covariance_singular'; default: not declared - WarningCode.ModelLimitation: 'model.limitation'; default: not declared — A structural limitation of the model/data the caller should know about (design law #4). - WarningCode.MonteCarloQuasiMonteCarloDimensionFallback: 'monte_carlo.quasi_monte_carlo_dimension_fallback'; default: not declared - WarningCode.OperationUntypedWarning: 'operation.untyped_warning'; default: not declared — A library result reported this warning as a bare sentence; the envelope carries it typed. - WarningCode.OptimizeNotConverged: 'optimize.not_converged'; default: not declared - WarningCode.OptionsChainGreeksRowsSkipped: 'chain_greeks.rows_skipped'; default: not declared — B7 — `chainGreeks` returned some rows unchanged; `diagnostics.rows` names each reason. - WarningCode.OptionsChainHealthModelNotRequested: 'options.chain_health.model_not_requested'; default: not declared — Quote-only chain health was requested; model bounds and implied volatility are not assessed. - WarningCode.OptionsDividendsNone: 'options.dividends_none'; default: not declared - WarningCode.OptionsDividendsPast: 'options.dividends_past'; default: not declared - WarningCode.OptionsEngineFailed: 'options.engine_failed'; default: not declared — `compareEngines`: one or more engines failed to price (per-row detail on the failed rows). - WarningCode.OptionsExerciseDiscreteDividends: 'options.exercise_discrete_dividends'; default: not declared - WarningCode.PerformanceEmptySeries: 'performance.empty_series'; default: not declared — `analyze` on a series with zero return periods: every metric is null (E3 degenerate summary). - WarningCode.PerformanceNonFiniteMetric: 'performance.non_finite_metric'; default: not declared - WarningCode.PerformanceSuspiciousEquityInput: 'performance.suspicious_equity_input'; default: not declared - WarningCode.PerformanceUndefinedMetric: 'performance.undefined_metric'; default: not declared - WarningCode.PortfolioDisclosedHoldingsReview: 'portfolio.disclosed_holdings_review'; default: not declared — Supplied disclosed holdings do not support some changes, weights or concentration. - WarningCode.PortfolioMarketMarkAge: 'portfolio.market_mark_age'; default: not declared — Observation and valuation clocks differ; never relabel a source mark. - WarningCode.ResearchBacktestOverfittingProbabilityTrimmed: 'research.backtest_overfitting_probability_trimmed'; default: not declared — `probabilityOfBacktestOverfitting`: the oldest rows were trimmed so T divides into S blocks. - WarningCode.ResearchSurvivorshipBias: 'research.survivorship_bias'; default: not declared - WarningCode.ResearchTrainTestLeakage: 'research.train_test_leakage'; default: not declared - WarningCode.RiskAsOfUnscreened: 'risk.as_of_unscreened'; default: not declared — FC7 slice 4 (2026-08-29): estimateExpectedReturns received an asOf but no observation timestamps — nothing could be screened for look-ahead. - WarningCode.RiskBrinsonWeights: 'risk.brinson_weights'; default: not declared - WarningCode.RiskCornishFisherConditionalValueAtRiskGaussianFallback: 'risk.cornish_fisher_conditional_value_at_risk_gaussian_fallback'; default: not declared - WarningCode.RiskCornishFisherOutOfDomain: 'risk.cornish_fisher_out_of_domain'; default: not declared - WarningCode.RiskCostExceedsEdge: 'risk.cost_exceeds_edge'; default: not declared - WarningCode.RiskExtremeValueConfidenceOutsideTail: 'risk.extreme_value_confidence_outside_tail'; default: not declared - WarningCode.RiskExtremeValueDegenerateFit: 'risk.extreme_value_degenerate_fit'; default: not declared - WarningCode.RiskExtremeValueFewExceedances: 'risk.extreme_value_few_exceedances'; default: not declared - WarningCode.RiskExtremeValueInfiniteMean: 'risk.extreme_value_infinite_mean'; default: not declared - WarningCode.RiskExtremeValueInfiniteVariance: 'risk.extreme_value_infinite_variance'; default: not declared - WarningCode.RiskExtremeValueMleFallback: 'risk.extreme_value_mle_fallback'; default: not declared - WarningCode.RiskFrontierNotMonotone: 'risk.frontier_not_monotone'; default: not declared — Solved frontier points are not monotone in volatility versus expected return. - WarningCode.RiskFrontierPointsFailed: 'risk.frontier_points_failed'; default: not declared — One or more requested frontier points could not be solved (kept with their reasons). - WarningCode.RiskFrontierUnboundedReturn: 'risk.frontier_unbounded_return'; default: not declared — The constrained maximum return is unbounded (an asset without an upper bound and another without a lower bound); a `points` grid fell back to a risk-aversion grid. - WarningCode.RiskHighCostDrag: 'risk.high_cost_drag'; default: not declared - WarningCode.RiskInfeasibleConstraints: 'risk.infeasible_constraints'; default: not declared - WarningCode.RiskInfeasibleTangency: 'risk.infeasible_tangency'; default: not declared - WarningCode.RiskKellyEstimationNoEdge: 'risk.kelly_estimation_no_edge'; default: not declared - WarningCode.RiskKellyEstimationThinSample: 'risk.kelly_estimation_thin_sample'; default: not declared - WarningCode.RiskKellyFatTails: 'risk.kelly_fat_tails'; default: not declared - WarningCode.RiskKellyNaiveOverbet: 'risk.kelly_naive_overbet'; default: not declared - WarningCode.RiskKellyNegativeSum: 'risk.kelly_negative_sum'; default: not declared - WarningCode.RiskKellyNoEdge: 'risk.kelly_no_edge'; default: not declared - WarningCode.RiskKellyOver: 'risk.kelly_over'; default: not declared - WarningCode.RiskKellyUnbounded: 'risk.kelly_unbounded'; default: not declared - WarningCode.RiskKellyZeroVariance: 'risk.kelly_zero_variance'; default: not declared — C hygiene — a zero-variance edge has no Kelly fraction: the sizing is null, never an input error. - WarningCode.RiskMeanExcessNoLinearRegion: 'risk.mean_excess_no_linear_region'; default: not declared - WarningCode.RiskPnlUnexplainedResidual: 'risk.pnl_unexplained_residual'; default: not declared — P&L explain: the unexplained residual dominates the total — the greek expansion broke down. - WarningCode.RiskSharpeUndefined: 'risk.sharpe_undefined'; default: not declared — C hygiene — a zero-variance return series has no Sharpe ratio: the statistic is null. - WarningCode.RiskUnboundedLoss: 'risk.unbounded_loss'; default: not declared — `optionsMargin`: a net-short call makes the expiration loss unbounded — `maxLoss` is null. - WarningCode.RiskZeroGrossExposure: 'risk.zero_gross_exposure'; default: not declared — Zero gross exposure: concentration metrics are undefined and reported as null. - WarningCode.RiskZeroVolatilitySharpe: 'risk.zero_volatility_sharpe'; default: not declared — A frontier point with zero volatility has no Sharpe ratio (reported null with the reason). - WarningCode.ScenarioUnusedCurrencyConversion: 'scenario.unused_currency_conversion'; default: not declared — A valid reusable FX quote was supplied but no target required it in this scenario run. - WarningCode.StrategyOptimizerZeroCapital: 'strategy.optimizer_zero_capital'; default: not declared — `optimizeStrategy`: a candidate's capital requirement is zero — `thesisEvPerCapital` is null. - WarningCode.StrategyRiskRewardUndefined: 'strategy.risk_reward_undefined'; default: not declared — The reward-to-risk ratio is undefined: an unbounded profit or loss, or a zero maximum loss. - WarningCode.StrategyVolatilityFloored: 'strategy.volatility_floored'; default: not declared - WarningCode.StructureAggressorUnavailable: 'structure.aggressor_unavailable'; default: not declared - WarningCode.StructureContractsSkipped: 'structure.contracts_skipped'; default: not declared - WarningCode.StructureDuplicateContractQuotes: 'structure.duplicate_contract_quotes'; default: not declared — Repeated contract rows remain additive and may count the same open interest more than once. - WarningCode.StructureFlatBaseline: 'structure.flat_baseline'; default: not declared — `unusualness`: flat baseline — the z-score is undefined and reported null. - WarningCode.StructureNoEligibleQuotes: 'structure.no_eligible_quotes'; default: not declared — Every supplied quote was excluded; empty sums must not be read as measured zero exposure. - WarningCode.SurfaceExtrapolated: 'volatility.surface_extrapolated'; default: not declared - WarningCode.SuspiciousReturns: 'input.suspicious_returns'; default: not declared - WarningCode.SuspiciousRiskFreeRate: 'input.suspicious_risk_free_rate'; default: not declared - WarningCode.SuspiciousTime: 'input.suspicious_time'; default: not declared - WarningCode.SuspiciousVolatility: 'input.suspicious_volatility'; default: not declared - WarningCode.TechnicalAnalysisOpeningRangeTruncated: 'technical_analysis.opening_range_truncated'; default: not declared — `openingRange`: fewer bars than `periods` — the range covers the whole series. - WarningCode.VolatilityButterflyArbitrage: 'volatility.butterfly_arbitrage'; default: not declared - WarningCode.VolatilityCalibrationNotConverged: 'volatility.calibration_not_converged'; default: not declared — Surface/model calibration finished without meeting tolerance — best-effort parameters returned. - WarningCode.VolatilityEssviButterfly: 'volatility.essvi_butterfly'; default: not declared - WarningCode.VolatilityEssviCalendar: 'volatility.essvi_calendar'; default: not declared - WarningCode.VolatilityEssviCalendarData: 'volatility.essvi_calendar_data'; default: not declared - WarningCode.VolatilityEssviNotConverged: 'volatility.essvi_not_converged'; default: not declared - WarningCode.VolatilityFitInsufficientData: 'volatility.fit_insufficient_data'; default: not declared - WarningCode.VolatilityFitUnconverged: 'volatility.fit_unconverged'; default: not declared - WarningCode.VolatilityObservedSkewDuplicateContract: 'volatility.observed_skew_duplicate_contract'; default: not declared - WarningCode.VolatilityObservedSkewMissingDelta: 'volatility.observed_skew_missing_delta'; default: not declared - WarningCode.VolatilityObservedSkewQuoteExcluded: 'volatility.observed_skew_quote_excluded'; default: not declared - WarningCode.VolatilityObservedSkewUnavailable: 'volatility.observed_skew_unavailable'; default: not declared - WarningCode.VolatilityShockDegradedToInterpolated: 'volatility.shock_degraded_to_interpolated'; default: not declared - WarningCode.VolatilityShockFloored: 'volatility.shock_floored'; default: not declared - WarningCode.VolatilitySkewDeltaExtrapolated: 'volatility.skew_delta_extrapolated'; default: not declared - WarningCode.VolatilitySsviButterfly: 'volatility.ssvi_butterfly'; default: not declared - WarningCode.VolatilitySsviCalendarData: 'volatility.ssvi_calendar_data'; default: not declared - WarningCode.VolatilitySsviNotConverged: 'volatility.ssvi_not_converged'; default: not declared - WarningCode.VolatilityStickyIndeterminate: 'volatility.sticky_indeterminate'; default: not declared - WarningCode.VolatilityStickyWeakFit: 'volatility.sticky_weak_fit'; default: not declared - WarningCode.VolatilitySurfaceQuotesSkipped: 'volatility.surface_quotes_skipped'; default: not declared - WarningCode.VolatilitySurfaceSparse: 'volatility.surface_sparse'; default: not declared - WarningCode.VolatilitySwaptionCubeExtrapolated: 'volatility.swaption_cube_extrapolated'; default: not declared - WarningCode.VolatilitySwaptionNodePoorFit: 'volatility.swaption_node_poor_fit'; default: not declared - addDays: (date: string, days: number) => string; default: not declared — Add `n` calendar days to an ISO date. - addDays(date): string; default: not declared - addDays(days): number; default: not declared - alwaysOpen: import('@insiderfinance/totalfinance/core').Calendar; default: not declared — A 24/7 calendar (every day is a business day) — e.g. crypto. - alwaysOpen.addBusinessDays: (date: string, days: number) => string; default: not declared - alwaysOpen.addBusinessDays(date): string; default: not declared - alwaysOpen.addBusinessDays(days): number; default: not declared - alwaysOpen.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - alwaysOpen.businessDaysBetween(from): string; default: not declared - alwaysOpen.businessDaysBetween(to): string; default: not declared - alwaysOpen.isBusinessDay: (date: string) => boolean; default: not declared - alwaysOpen.isBusinessDay(date): string; default: not declared - alwaysOpen.isHalfDay: (date: string) => boolean; default: not declared - alwaysOpen.isHalfDay(date): string; default: not declared - alwaysOpen.isHoliday: (date: string) => boolean; default: not declared - alwaysOpen.isHoliday(date): string; default: not declared - alwaysOpen.name: string; default: not declared - alwaysOpen.nextBusinessDay: (date: string) => string; default: not declared - alwaysOpen.nextBusinessDay(date): string; default: not declared - alwaysOpen.previousBusinessDay: (date: string) => string; default: not declared - alwaysOpen.previousBusinessDay(date): string; default: not declared - alwaysOpen.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - alwaysOpen.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - alwaysOpen.session().return.date: string; default: not declared - alwaysOpen.session().return.isBusinessDay: boolean; default: not declared - alwaysOpen.session().return.isHalfDay: boolean; default: not declared - alwaysOpen.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - alwaysOpen.session(date): string; default: not declared - alwaysOpen.timezone: string; default: not declared - alwaysOpen.version: string; default: not declared - assertFiniteResult: (label: string, result: import('@insiderfinance/totalfinance/core').Computed) => void; default: not declared — Law 7 runtime postcondition (spec P2.1, tightened in E3): a SUCCESSFUL explained result is JSON-safe — it NEVER carries a non-finite number (`JSON.stringify` would silently corrupt it to `null`). **Warnings never license a non-finite value**: an undefined quantity is reported as `null` and the warning explains the null. The only ratified exceptions are structural sentinels: 1. `diagnostics.warmup > 0` with an array value — EXACTLY the first `warmup` slots are the documented aligned-series "not yet formed" sentinel; every slot past the prefix is checked; 2. discriminated "none" elements — zone-style points (`direction: 0`, shape-anchored on their zone fields) and divergence points (`code: 0`, shape-anchored on `priceSwings`) — whose documented NaN-when-none fields are exempt; every OTHER field of such an element is still checked, and an element that merely says `direction: 0` without the zone shape (e.g. an honest tdSequential point) is walked in full. Anything else non-finite throws {@link PostconditionError}: a library defect surfaced loudly at the boundary rather than shipped silently into a serialization. The walk is exhaustive — full depth (cycle-safe), value + assumptions + diagnostics + provenance — so nothing hides below a cap. - assertFiniteResult(label): string; default: not declared - assertFiniteResult(result): import('@insiderfinance/totalfinance/core').Computed>; default: not declared - assertFiniteResult(result).assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - assertFiniteResult(result).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - assertFiniteResult(result).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - assertFiniteResult(result).value: unknown; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - assertFiniteValue: (label: string, value: unknown) => void; default: not declared - assertFiniteValue(label): string; default: not declared - assertFiniteValue(value): unknown; default: not declared - between: (value: number, min: number, max: number, options?: import('@insiderfinance/totalfinance/core').BetweenOptions) => boolean; default: not declared — Range predicate. Replaces wrapped-number DSLs (design law #2): use `between(Math.abs(delta), 0.25, 0.35)` rather than `delta.abs().between(...)`. - between(max): number; default: not declared - between(min): number; default: not declared - between(options)?: import('@insiderfinance/totalfinance/core').BetweenOptions; default: not declared - between(options).inclusive?: boolean; default: not declared — Include the bounds (default `true`). - between(value): number; default: not declared - clamp: (value: number, min: number, max: number) => number; default: not declared — Clamp `value` into `[min, max]`. - clamp(max): number; default: not declared - clamp(min): number; default: not declared - clamp(value): number; default: not declared - compoundFactor: (annualRate: number, years: number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Compound (growth) factor for `rate` over `years` under any {@link InterestCompounding} form. - compoundFactor(annualRate): number; default: not declared - compoundFactor(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - compoundFactor(compounding).periodsPerYear: number; default: not declared - compoundFactor(compounding).type: 'periodic'; default: not declared - compoundFactor(years): number; default: not declared - compoundingPeriodsPerYear: (compounding: import('@insiderfinance/totalfinance/core').InterestCompounding) => number | null; default: not declared — Periods per year for a discrete convention; `null` for the two non-discrete forms. - compoundingPeriodsPerYear(compounding): import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - compoundingPeriodsPerYear(compounding).periodsPerYear: number; default: not declared - compoundingPeriodsPerYear(compounding).type: 'periodic'; default: not declared - createRuleCalendar: (config: import('@insiderfinance/totalfinance/core').CalendarConfig) => import('@insiderfinance/totalfinance/core').Calendar; default: not declared — Build a `Calendar` from rules. Holiday/half-day sets are computed lazily per year and cached. The config is SNAPSHOTTED at construction — rule arrays, closures, weekend days, and the session object are copied — so mutating the caller's config (or a shared exported rules array) later can never make one calendar answer the same question two ways across warm and cold cache years. - createRuleCalendar().return.addBusinessDays: (date: string, days: number) => string; default: not declared - createRuleCalendar().return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - createRuleCalendar().return.isBusinessDay: (date: string) => boolean; default: not declared - createRuleCalendar().return.isHalfDay: (date: string) => boolean; default: not declared - createRuleCalendar().return.isHoliday: (date: string) => boolean; default: not declared - createRuleCalendar().return.name: string; default: not declared - createRuleCalendar().return.nextBusinessDay: (date: string) => string; default: not declared - createRuleCalendar().return.previousBusinessDay: (date: string) => string; default: not declared - createRuleCalendar().return.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - createRuleCalendar().return.timezone: string; default: not declared - createRuleCalendar().return.version: string; default: not declared - createRuleCalendar(config): import('@insiderfinance/totalfinance/core').CalendarConfig; default: not declared - createRuleCalendar(config).closures?: string[]; default: not declared — Ad-hoc full closures (ISO dates), e.g. emergency closures or days of mourning. - createRuleCalendar(config).halfDayRules?: import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared - createRuleCalendar(config).holidayRules?: import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared - createRuleCalendar(config).name: string; default: not declared - createRuleCalendar(config).session: { open: string; close: string; halfDayClose?: string; }; default: not declared — Regular session hours as `HH:MM` in the calendar's `timezone`. `close: '24:00'` is the sentinel for "no close" — a continuous 24-hour session (e.g. `alwaysOpen`/crypto), distinct from `'00:00'` (midnight). Keep it as `'24:00'`; do not normalize to `'00:00'`. - createRuleCalendar(config).session.close: string; default: not declared - createRuleCalendar(config).session.halfDayClose?: string; default: not declared - createRuleCalendar(config).session.open: string; default: not declared - createRuleCalendar(config).timezone: string; default: not declared - createRuleCalendar(config).version: string; default: not declared - createRuleCalendar(config).weekendDays?: import('@insiderfinance/totalfinance/core').Weekday[]; default: not declared — Default `[0, 6]` (Sun & Sat). - dayOfWeek: (date: string) => import('@insiderfinance/totalfinance/core').Weekday; default: not declared — Day of week for an ISO date. - dayOfWeek(date): string; default: not declared - defineCalendar: (config: import('@insiderfinance/totalfinance/core').CalendarConfig) => import('@insiderfinance/totalfinance/core').Calendar; default: not declared — Define a custom calendar (spec §22.4 extension API). A thin wrapper over `createRuleCalendar` so the extension surface is stable even if the engine evolves. - defineCalendar().return.addBusinessDays: (date: string, days: number) => string; default: not declared - defineCalendar().return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - defineCalendar().return.isBusinessDay: (date: string) => boolean; default: not declared - defineCalendar().return.isHalfDay: (date: string) => boolean; default: not declared - defineCalendar().return.isHoliday: (date: string) => boolean; default: not declared - defineCalendar().return.name: string; default: not declared - defineCalendar().return.nextBusinessDay: (date: string) => string; default: not declared - defineCalendar().return.previousBusinessDay: (date: string) => string; default: not declared - defineCalendar().return.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - defineCalendar().return.timezone: string; default: not declared - defineCalendar().return.version: string; default: not declared - defineCalendar(config): import('@insiderfinance/totalfinance/core').CalendarConfig; default: not declared - defineCalendar(config).closures?: string[]; default: not declared — Ad-hoc full closures (ISO dates), e.g. emergency closures or days of mourning. - defineCalendar(config).halfDayRules?: import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared - defineCalendar(config).holidayRules?: import('@insiderfinance/totalfinance/core').HolidayRule[]; default: not declared - defineCalendar(config).name: string; default: not declared - defineCalendar(config).session: { open: string; close: string; halfDayClose?: string; }; default: not declared — Regular session hours as `HH:MM` in the calendar's `timezone`. `close: '24:00'` is the sentinel for "no close" — a continuous 24-hour session (e.g. `alwaysOpen`/crypto), distinct from `'00:00'` (midnight). Keep it as `'24:00'`; do not normalize to `'00:00'`. - defineCalendar(config).session.close: string; default: not declared - defineCalendar(config).session.halfDayClose?: string; default: not declared - defineCalendar(config).session.open: string; default: not declared - defineCalendar(config).timezone: string; default: not declared - defineCalendar(config).version: string; default: not declared - defineCalendar(config).weekendDays?: import('@insiderfinance/totalfinance/core').Weekday[]; default: not declared — Default `[0, 6]` (Sun & Sat). - discountFactor: (annualRate: number, years: number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Discount factor for `rate` over `years` under any {@link InterestCompounding} form. - discountFactor(annualRate): number; default: not declared - discountFactor(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - discountFactor(compounding).periodsPerYear: number; default: not declared - discountFactor(compounding).type: 'periodic'; default: not declared - discountFactor(years): number; default: not declared - easterSunday: (year: number) => { month: number; day: number; }; default: not declared — Easter Sunday via the Anonymous Gregorian algorithm (Computus). - easterSunday().return.day: number; default: not declared - easterSunday().return.month: number; default: not declared - easterSunday(year): number; default: not declared - emptyDiagnostics: () => import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Construct an empty diagnostics object with no warnings. - emptyDiagnostics().return.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - emptyDiagnostics().return.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - emptyDiagnostics().return.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - emptyDiagnostics().return.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - emptyDiagnostics().return.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - emptyDiagnostics().return.iterations?: number; default: not declared — Iteration count for iterative methods. - emptyDiagnostics().return.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - emptyDiagnostics().return.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - emptyDiagnostics().return.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - emptyDiagnostics().return.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - emptyDiagnostics().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ensureEnum: (value: unknown, allowed: readonly T[], field: string, functionName: string) => asserts value is T; default: not declared — Enum guard: `value` must be exactly one of `allowed` (design law #4 — a meaning-changing field is never coerced; `type: 'Call'` must teach, not silently price the other leg). Accepts `unknown` so boundary callers can validate untyped input without a cast. - ensureEnum(allowed): readonly T[]; default: not declared - ensureEnum(field): string; default: not declared - ensureEnum(functionName): string; default: not declared - ensureEnum(value): unknown; default: not declared - ensureFinite: (value: number, field: string, functionName: string) => void; default: not declared — Throw unless `value` is a finite number. - ensureFinite(field): string; default: not declared - ensureFinite(functionName): string; default: not declared - ensureFinite(value): number; default: not declared - ensureFiniteWhenPresent: (value: unknown, field: string, functionName: string) => void; default: not declared — A finite numeric value WHEN PRESENT — the optional-field sibling of {@link requireFiniteFields}. `undefined` is allowed (optional omission, C06); anything else runs the same ladder a required field does, so a string in an optional numeric slot reports `input.wrong_type` exactly as it would in a required one. Calling bare `ensureFinite` there reported `input.not_finite`, which contradicted the library's own documented matrix — and a test had been written asserting the contradiction, which is how it survived. `null` is NOT omission. This guard originally returned early on null, which silently accepted a value every one of its call sites declares impossible (`lowerVolatilityBound?: number`, a bar's `open?: number` — none say `| null`). C06 reserves `null` for declarations that explicitly carry it; a field that wants nullable semantics declares them and takes a different guard. The `null-when-nonnullable` enforcement mutation exists to keep this class measurable. - ensureFiniteWhenPresent(field): string; default: not declared - ensureFiniteWhenPresent(functionName): string; default: not declared - ensureFiniteWhenPresent(value): unknown; default: not declared - ensureKnownKeys: (functionName: string, field: string, value: object, allowed: readonly string[]) => void; default: not declared — Law 12 — facade, analysis, and builder object inputs REJECT unknown keys (a misspelled option must never be silently ignored: `greek: false` computing Greeks anyway is the bug class this kills). Cheap by design: one key scan against a Set-able allowlist, no schema machinery, so it is safe on hot facade paths. Direct kernels use named objects when financial values could be confused; adapters that own foreign/superset schemas are declared `passthrough` in the manifest and skip this guard. - ensureKnownKeys(allowed): readonly string[]; default: not declared - ensureKnownKeys(field): string; default: not declared - ensureKnownKeys(functionName): string; default: not declared - ensureKnownKeys(value): object; default: not declared - ensureNonNegative: (value: number, field: string, functionName: string, code?: string) => void; default: not declared — Throw unless `value` is a finite number `>= 0`. - ensureNonNegative(code)?: string; default: not declared - ensureNonNegative(field): string; default: not declared - ensureNonNegative(functionName): string; default: not declared - ensureNonNegative(value): number; default: not declared - ensurePositive: (value: number, field: string, functionName: string, code?: string) => void; default: not declared — Throw unless `value` is a finite number `> 0`. - ensurePositive(code)?: string; default: not declared - ensurePositive(field): string; default: not declared - ensurePositive(functionName): string; default: not declared - ensurePositive(value): number; default: not declared - facade: = Record, ExplainValue = Output>(label: string, call: (input: Input) => Output, explain: (input: Input) => import('@insiderfinance/totalfinance/core').Computed) => import('@insiderfinance/totalfinance/core').Facade; default: not declared — Pair a plain-value `call` with its envelope-returning `explain` into a single {@link Facade}. `label` is the public name of the facade as the user calls it (e.g. `'blackScholes.call'`) — it opens every guard message. S1 facades take an input OBJECT of named fields, so arrays are rejected here too. - facade().return.explain: (input: Input) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - facade(call): (input: Input) => Output; default: not declared - facade(explain): (input: Input) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - facade(label): string; default: not declared - finalizeResult: >(label: string, result: Result) => Result; default: not declared — Validate and return a direct Computed result in one expression. - finalizeResult(label): string; default: not declared - finalizeResult(result): Result; default: not declared - finiteOrNull: (value: number) => number | null; default: not declared — Law 7 helper: a computed quantity that overflowed/underflowed to NaN/±Infinity is reported as `null` (undefined-with-reason at the envelope tier), never as a non-finite "success" value. - finiteOrNull(value): number; default: not declared - formatMoney: (value: number, options?: import('@insiderfinance/totalfinance/core').FormatMoneyOptions) => string; default: not declared — Format a number as currency using the platform `Intl` (browser-safe). - formatMoney(options)?: import('@insiderfinance/totalfinance/core').FormatMoneyOptions; default: not declared - formatMoney(options).currency?: string; default: not declared - formatMoney(options).decimals?: number; default: not declared - formatMoney(options).locale?: string; default: not declared - formatMoney(value): number; default: not declared - formatOccSymbol: (option: Pick) => string; default: not declared — Format option components into a compact OCC option symbol. - formatOccSymbol(option): Pick; default: not declared - formatOccSymbol(option).expiry: string; default: not declared — ISO `YYYY-MM-DD`. - formatOccSymbol(option).root: string; default: not declared - formatOccSymbol(option).strike: number; default: not declared - formatOccSymbol(option).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - formatPercent: (value: number, options?: import('@insiderfinance/totalfinance/core').FormatPercentOptions) => string; default: not declared — Format a fraction (`0.22`) as a percent string (`"22.00%"`). - formatPercent(options)?: import('@insiderfinance/totalfinance/core').FormatPercentOptions; default: not declared - formatPercent(options).asPercentagePoints?: boolean; default: not declared — If `true`, the input is already a percentage (e.g. `22`) rather than a fraction (`0.22`). - formatPercent(options).decimals?: number; default: not declared — Fraction digits (default `2`). - formatPercent(options).locale?: string; default: not declared - formatPercent(value): number; default: not declared - goodFriday: (year: number) => string; default: not declared — Good Friday (two days before Easter Sunday). - goodFriday(year): number; default: not declared - isComputed: (value: unknown) => value is import('@insiderfinance/totalfinance/core').Computed; default: not declared — Runtime guard for the one-envelope law (dx §7.2): a rich result is `Computed` iff it carries `value`, `assumptions.conventionsVersion`, and a `diagnostics.warnings` array. Exported so generic result handlers (and the conformance sweep in CI) can assert the shape. - isComputed(value): unknown; default: not declared - isFiniteNumber: (value: unknown) => value is number; default: not declared — True only for a real, finite number (rejects `NaN`, `Infinity`, and non-numbers). - isFiniteNumber(value): unknown; default: not declared - isNonNegative: (value: unknown) => value is number; default: not declared - isNonNegative(value): unknown; default: not declared - isOccOptionSymbol: (symbol: string) => boolean; default: not declared — Whether `symbol` is an OCC option symbol: true exactly when the OCC grammar accepts it — the same parse {@link parseOccSymbol} performs before resolving the expiry instant. The grammar lives in one place; this only asks the question, so a broker or a plan can refuse to treat an option contract as a share without re-describing the symbol layout or bundling the session calendar. - isOccOptionSymbol(symbol): string; default: not declared - isPositive: (value: unknown) => value is number; default: not declared - isPositive(value): unknown; default: not declared - isQuantError: (value: unknown, code?: string) => value is import('@insiderfinance/totalfinance/core').QuantError; default: not declared — Type guard: is this value a QuantError (and optionally a specific code)? - isQuantError(code)?: string | undefined; default: not declared - isQuantError(value): unknown; default: not declared - isTrustworthy: (result: unknown) => boolean; default: not declared — C (hygiene): the one question a caller asks of any envelope — may I act on this number? A result is trustworthy when its iterative procedure converged (or none ran: `converged` absent) and no warning is an error. `converged` lives on `diagnostics` everywhere; a result that also reports it in its value mirrors the diagnostics slot, so this reads one place. - isTrustworthy(result): unknown; default: not declared - isUsEquityHalfDay: (date: string) => boolean; default: not declared — Whether a `YYYY-MM-DD` calendar date is a US equity/options early-close day (13:00 ET). Applies {@link US_EQUITY_HALF_DAY_RULES} with the weekend and observed-holiday exclusions, so 2021-12-24 (the observed Christmas holiday) and 2026-07-03 (the observed Independence Day holiday) are full closures, not half days. - isUsEquityHalfDay(date): string; default: not declared - isoDateToEpochMs: (value: string) => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — Convert an ISO `YYYY-MM-DD` date to epoch milliseconds at UTC midnight. - isoDateToEpochMs(value): string; default: not declared - lastWeekdayOfMonth: (year: number, month: number, weekday: import('@insiderfinance/totalfinance/core').Weekday) => string; default: not declared — The last `weekday` of a month, e.g. last Monday of May. - lastWeekdayOfMonth(month): number; default: not declared - lastWeekdayOfMonth(weekday): import('@insiderfinance/totalfinance/core').Weekday; default: not declared - lastWeekdayOfMonth(year): number; default: not declared - missingFieldError: (functionName: string, field: string, example: string, hint?: string) => import('@insiderfinance/totalfinance/core').InputError; default: not declared — Build the canonical "a required field is missing" error (design law #4 / the first-touch law). One voice across every facade: it names the field and shows a WORKING example call, so the message teaches the fix instead of leaking a raw `TypeError` from a property access. ``` InputError [input.missing_field]: sma: period is required. e.g. sma(closes, { period: 20 }) ``` - missingFieldError().return.code: string; default: not declared - missingFieldError().return.context?: Record; default: not declared - missingFieldError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - missingFieldError(example): string; default: not declared - missingFieldError(field): string; default: not declared - missingFieldError(functionName): string; default: not declared - missingFieldError(hint)?: string | undefined; default: not declared - nthWeekdayOfMonth: (year: number, month: number, weekday: import('@insiderfinance/totalfinance/core').Weekday, occurrence: number) => string | null; default: not declared — The `occurrence`-th (1-based) `weekday` of a month, e.g. 3rd Monday of January. Returns `null` when the month has no such occurrence (e.g. a 5th Friday in a 4-Friday February) — the same "not observed" channel {@link HolidayRule} already speaks — rather than fabricating an impossible date like `2026-02-34`. - nthWeekdayOfMonth(month): number; default: not declared - nthWeekdayOfMonth(occurrence): number; default: not declared - nthWeekdayOfMonth(weekday): import('@insiderfinance/totalfinance/core').Weekday; default: not declared - nthWeekdayOfMonth(year): number; default: not declared - observedHoliday: (year: number, month: number, day: number) => string; default: not declared — Apply the US observance rule: Saturday → preceding Friday, Sunday → following Monday. - observedHoliday(day): number; default: not declared - observedHoliday(month): number; default: not declared - observedHoliday(year): number; default: not declared - optionExpiryToMs: (expiry: string) => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — Parse an option-expiry label to epoch-ms. A bare `YYYY-MM-DD` resolves to {@link usEquityCloseUtcMs} (16:00 ET) — not UTC midnight — so an intraday `asOf` on the expiry date still sees positive time-to-expiry; a full datetime string is parsed as-is. Throws on an unparseable value. - optionExpiryToMs(expiry): string; default: not declared - parseIsoDate: (value: string) => import('@insiderfinance/totalfinance/core').CalendarDate; default: not declared — Parse an ISO `YYYY-MM-DD` date into calendar components, validating it is a real date. - parseIsoDate().return.day: number; default: not declared - parseIsoDate().return.month: number; default: not declared - parseIsoDate().return.year: number; default: not declared - parseIsoDate(value): string; default: not declared - parseOccSymbol: (symbol: string) => import('@insiderfinance/totalfinance/core').OccOptionSymbol; default: not declared — Parse an OCC option symbol into its components. - parseOccSymbol().return.expiresAt: number; default: not declared — Resolved expiry instant (one expiry law, E2): OCC symbols are always US-equity date-only. - parseOccSymbol().return.expiry: string; default: not declared — ISO `YYYY-MM-DD`. - parseOccSymbol().return.expiryConvention: 'us-equity-close'; default: not declared - parseOccSymbol().return.root: string; default: not declared - parseOccSymbol().return.strike: number; default: not declared - parseOccSymbol().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - parseOccSymbol(symbol): string; default: not declared - plausibilityWarnings: (inputs: { volatility?: number; timeToExpiryYears?: number; riskFreeRate?: number; }) => import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Plausibility warnings for the two classic quant footguns (the first-touch law §2.4). Facades stay silent-and-correct on the plain-value path (a 2200% vol is legal — memecoins exist), but the `.explain()` envelope should say what it sees. Never throws; returns `[]` when inputs look normal. - `vol > 3` → likely a percent typed as a decimal (`vol: 22` → 2200%). - `t > 5` & integer → likely a day count typed as a year fraction (`t: 30` → a 30-year option). - `|rate| > 0.5` → likely a percent typed as a decimal (`rate: 4.5` → a 450% risk-free rate). - plausibilityWarnings(inputs): { volatility?: number; timeToExpiryYears?: number; riskFreeRate?: number; }; default: not declared - plausibilityWarnings(inputs).riskFreeRate?: number; default: not declared - plausibilityWarnings(inputs).timeToExpiryYears?: number; default: not declared - plausibilityWarnings(inputs).volatility?: number; default: not declared - requireArgumentArray: (functionName: string, field: string, value: unknown) => void; default: not declared — Throw unless `value` is a real array (or typed array). - requireArgumentArray(field): string; default: not declared - requireArgumentArray(functionName): string; default: not declared - requireArgumentArray(value): unknown; default: not declared - requireArgumentObject: (functionName: string, field: string, value: unknown) => void; default: not declared - requireArgumentObject(field): string; default: not declared - requireArgumentObject(functionName): string; default: not declared - requireArgumentObject(value): unknown; default: not declared - requireFiniteFields: (functionName: string, input: unknown, fields: readonly string[], options: import('@insiderfinance/totalfinance/core').RequireFiniteFieldsOptions) => void; default: not declared - requireFiniteFields(fields): readonly string[]; default: not declared - requireFiniteFields(functionName): string; default: not declared - requireFiniteFields(input): unknown; default: not declared - requireFiniteFields(options): import('@insiderfinance/totalfinance/core').RequireFiniteFieldsOptions; default: not declared - requireFiniteFields(options).exampleCall: string | (() => string); default: not declared — A THUNK is accepted so a derived example costs nothing on the success path. Shared validators must build their example from the reported function name, and RV6 first wrote that as `exampleCall: facadeExampleCall(functionName)` — evaluated on EVERY call, including the millions that never fail. That put string construction inside `blackScholes.price`, a documented hot path, to produce a message thrown away unused. The lazy form keeps the example correct and the success path free; it is only invoked when a field is actually missing. - requireFiniteFields(options).hints?: Readonly>; default: not declared — Optional per-field note appended on its own line — the unit trap or range the call shape cannot carry (`annualized decimal, not 20`). Keyed by the BARE field name. - requireFiniteFields(options).path?: string; default: not declared — Dotted prefix for a NESTED contract, so the error reads `parameters.kappa` rather than `kappa`. The caller is holding an outer request; the bare name does not say which object to fix. - requireRateCurveData: (functionName: string, path: string, value: unknown) => import('@insiderfinance/totalfinance/core').RateCurve; default: not declared — The ONE full validator for a stored/observed {@link RateCurve} as PLAIN DATA — shared by the Gate B market-snapshot spine (`observations.curves`) and the Gate C pricing protocol (the `discountCurve` observation value), so both refuse the same malformed curves with the same teaching. Core-internal on purpose: it is validation plumbing, not analysis API. Checks: `currency` a non-empty string; `asOf` finite epoch ms; `dayCount`/`compounding` valid conventions (a curve states its own — no silent economics); `points` an array of AT LEAST ONE pillar (an empty curve discounts nothing — a consumer handed zero pillars has no discount function, so emptiness is refused here rather than downstream) whose entries have a REAL `'YYYY-MM-DD'` calendar date (parsed with core's date parser, so `'2025-02-30'` is refused), strictly ascending pillar dates, dates at or after the curve's own `asOf` (a pillar BEFORE the curve's valuation instant discounts into the past — no consumer has a meaning for it; a pillar exactly AT `asOf` is the legal t = 0 anchor), and a finite `zeroRate` whose discount factor is actually computable and representable under the curve's compounding at that pillar's tenor; `interpolation` a non-empty string when present (the declared type). Entries stay open (Law 12): vendor decoration is preserved, not enumerated here. **Pillar authority — `zeroRate` is the ONE datum (2026-08-23, second external review).** The semantics are the existing fixed-income consumer's: `curves.fromZeroRates(...)` consumes ZERO RATES quoted under the curve's own `compounding`/`dayCount` and DERIVES every discount factor through that compounding transform. The former advisory `discountFactor` pillar member is GONE: a second, potentially contradictory answer must not share a pillar (the old sign-consistency tolerance accepted `rate: 0.05` beside `discountFactor: 0.2`), and no consumer in the workspace ever read it — discount-factor-quoted data has its own constructor (`curves.fromDiscountFactors`), whose pillars carry no rates. What replaced the tolerance is a REAL economics check through core's own transform (`discountFactor` in `dates.ts` — the one compounding engine, not a second one): every pillar's derived discount factor must exist and be a positive finite number, so `zeroRate: -2` under annual compounding (growth factor `1 + r/m ≤ 0` — no real discount factor exists) and rate/tenor pairs whose factor overflows, underflows to zero, or goes negative are refused with the arithmetic named. - requireRateCurveData().return.asOf: number; default: not declared - requireRateCurveData().return.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - requireRateCurveData().return.currency: string; default: not declared - requireRateCurveData().return.dayCount: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - requireRateCurveData().return.interpolation?: string; default: not declared - requireRateCurveData().return.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - requireRateCurveData(functionName): string; default: not declared - requireRateCurveData(path): string; default: not declared - requireRateCurveData(value): unknown; default: not declared - requireRepresentableResult: (functionName: string, result: T) => T; default: not declared — Law 7's INPUT-DRIVEN twin (2026-08-23 review wave): refuse a computed result that finite inputs pushed past IEEE-754 double precision. `assertFiniteValue` reports a non-finite success as a LIBRARY defect ("please report it"); this finalizer reports it as the caller's magnitudes overflowing the arithmetic — a teaching refusal, not a bug report. Every public facade/analysis/ratified-plain answer in the Stage 4 domain packages returns through one of the two; the overflow mutant (`tools/first-touch/overflow-sweep.test.ts`) holds the law. - requireRepresentableResult(functionName): string; default: not declared - requireRepresentableResult(result): T; default: not declared - requireSelection: (functionName: string, field: string, value: unknown, allowed: readonly T[]) => T[]; default: not declared — Validate an explicit SELECTION list — `outputs: ['price', 'gamma']`, `metrics: ['gex']` — and return a dense copy in request order. A selection decides what is computed, so every malformed form teaches instead of being repaired: not an array (`input.wrong_type`), empty (`input.out_of_range` — an empty request computes nothing and would read as a successful empty answer), a sparse hole (`input.missing_field`), an unknown or non-string name (`input.invalid_enum`, with a did-you-mean), and a repeated name (`input.duplicate_entry`). A duplicate is never silently collapsed: it usually means the caller meant a different name. `functionName` and `field` name the caller's boundary in every one of those errors, so they are checked first: a missing label would otherwise surface as `undefined: undefined must be …`. - requireSelection(allowed): readonly T[]; default: not declared - requireSelection(field): string; default: not declared - requireSelection(functionName): string; default: not declared - requireSelection(value): unknown; default: not declared - resolveAsOf: (asOf: import('@insiderfinance/totalfinance/core').EpochMs | string, functionName?: string) => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — Resolve a DATE-GRANULAR `asOf` to epoch ms — ledgers, calendars, fundamentals, performance and research windows, where "as of 2026-07-06" means the calendar date. Deterministic by construction: bare dates resolve to UTC midnight, datetimes require an explicit zone, and anything else throws a teaching error (never a machine-local parse). Option-pricing paths must NOT use this door: a bare date hides the time of day that a same-day option's value depends on. They resolve through {@link resolveValuationAsOf}, which rejects a date-only `asOf` with the fix. - resolveAsOf(asOf): string | number; default: not declared - resolveAsOf(functionName)?: string; default: not declared - resolveValuationAsOf: (asOf: import('@insiderfinance/totalfinance/core').EpochMs | string, functionName?: string) => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — Resolve a VALUATION instant (`asOf`) to epoch ms — the door every option-pricing path uses (options, strategy, volatility, structure, scenarios, risk marking). Accepts finite epoch milliseconds or a zoned ISO datetime. A date-only string is REJECTED with the fix: the time of day is the whole answer for a same-day option (a bare date resolved to UTC midnight valued a 0DTE at 10:30 ET with 3.6× its remaining life), and the expiry side already refuses a bare date that does not name its instant. `usEquitySessionInstant(date, 'close')` is the one-call form for an end-of-day mark. - resolveValuationAsOf(asOf): string | number; default: not declared - resolveValuationAsOf(functionName)?: string; default: not declared - resolvedExpiry: (expiry: string) => { expiresAt: import('@insiderfinance/totalfinance/core').EpochMs; expiryConvention: 'us-equity-close' | 'explicit-instant'; }; default: not declared — Resolve an expiry label to the REQUIRED contract fields (E2): the spreadable `{ expiresAt, expiryConvention }` pair for constructing an `OptionContract` from a label — the same resolution the option builders stamp. Prefer the builders for user-facing code; this exists for adapters and tests assembling contracts inline. - resolvedExpiry().return.expiresAt: number; default: not declared - resolvedExpiry().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared - resolvedExpiry(expiry): string; default: not declared - round: (value: number, decimals?: number) => number; default: not declared — Round half-away-from-zero to `decimals` places, robust to floating-point representation. Total over the double domain: `decimals` must be an integer in [-323, 323] (10^±323 spans the whole representable grid — beyond it nothing survives double precision), and the extremes are exact identities rather than overflow artifacts: an integer input with `decimals >= 0` is returned unchanged (so `round(1e16, 0)` is 1e16, not 1e16+2, and `round(Number.MAX_VALUE, 2)` is MAX_VALUE, not Infinity), and when the requested grid is coarser than the value's own ulp the value is already its rounded self. - round(decimals)?: number; default: not declared - round(value): number; default: not declared - selectQuotePrice: (quote: import('@insiderfinance/totalfinance/core').OptionQuote, source: import('@insiderfinance/totalfinance/core').PriceSource) => number | undefined; default: not declared — Resolve a single price from an option quote per the requested source. Returns `undefined` when the requested fields are absent. `mid` falls back to (bid+ask)/2 when an explicit mid is missing. An unknown `source` is a typed error, never a silent `undefined` — "field absent" and "you typed `'midd'`" must not be the same answer. - selectQuotePrice(quote): import('@insiderfinance/totalfinance/core').OptionQuote; default: not declared - selectQuotePrice(quote).ask?: number; default: not declared - selectQuotePrice(quote).askSize?: number; default: not declared - selectQuotePrice(quote).bid?: number; default: not declared - selectQuotePrice(quote).bidSize?: number; default: not declared - selectQuotePrice(quote).conditions?: string[]; default: not declared - selectQuotePrice(quote).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - selectQuotePrice(quote).exchange?: string; default: not declared - selectQuotePrice(quote).greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - selectQuotePrice(quote).impliedVolatility?: number; default: not declared - selectQuotePrice(quote).last?: number; default: not declared - selectQuotePrice(quote).mark?: number; default: not declared - selectQuotePrice(quote).mid?: number; default: not declared - selectQuotePrice(quote).openInterest?: number; default: not declared - selectQuotePrice(quote).timestampMs: number; default: not declared - selectQuotePrice(quote).underlyingPrice?: number; default: not declared - selectQuotePrice(quote).volume?: number; default: not declared - selectQuotePrice(source): import('@insiderfinance/totalfinance/core').PriceSource; default: not declared - seriesFacade: = Record>(label: string, call: (...callArguments: Args) => Output, explain: (...callArguments: Args) => import('@insiderfinance/totalfinance/core').Computed) => import('@insiderfinance/totalfinance/core').SeriesFacade; default: not declared — Pair a series-first `call` with an `.explain()` that takes the same arguments (S2 facades). `label` is the public name of the facade as the user calls it (e.g. `'sharpe'`). - seriesFacade().return.explain: (...callArguments: Args) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - seriesFacade(call): (...callArguments: Args) => Output; default: not declared - seriesFacade(explain): (...callArguments: Args) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - seriesFacade(label): string; default: not declared - sideOf: (signed: number, functionName?: string) => import('@insiderfinance/totalfinance/core').OrderSide; default: not declared — The side of a signed quantity: positive buys, negative sells. Zero and non-finite values have no side and are refused — a caller that reaches here with `0` has a sizing bug, not an order. - sideOf(functionName)?: string; default: not declared - sideOf(signed): number; default: not declared - signOf: (side: import('@insiderfinance/totalfinance/core').OrderSide, functionName?: string) => 1 | -1; default: not declared — The sign of a side: `+1` for a buy, `-1` for a sell. Any other value is refused. - signOf(functionName)?: string; default: not declared - signOf(side): import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - stableSum: (addends: readonly number[]) => number; default: not declared — Sum signed finite addends without losing a representable answer to evaluation order. The ordinary path uses a non-overlapping floating-point expansion: low-order residuals survive cancellation (`1e16 + 1 − 1e16 === 1`). If one partial addition itself overflows, the fallback decodes each double into an exact BigInt superaccumulator and rounds the exact total once. That fallback is what makes `1e308 + 1e308 + 1 − 1e308 − 1e308` return `1` in every permutation while still returning Infinity when the mathematical sum of the supplied doubles exceeds `Number.MAX_VALUE`. Non-finite addends retain ordinary IEEE-754 propagation semantics. - stableSum(addends): readonly number[]; default: not declared - suspiciousReturnsWarning: (returns: ArrayLike) => import('@insiderfinance/totalfinance/core').QuantWarning | undefined; default: not declared — The third classic footgun (dx WS-3 / R6): a PRICE or equity series passed where per-period RETURNS are expected. Returns are decimals (`0.01` = +1%); a series whose mean magnitude exceeds 0.5 (50% per period) is almost certainly prices — a monotonic 100→160 price series fed to `sharpe()` yields an absurd-but-silent 117. Warning only, never an error (a genuine >50%/period return series is legal — it is just worth flagging). Returns `undefined` when the series looks like returns. - suspiciousReturnsWarning().return.code: string; default: not declared - suspiciousReturnsWarning().return.context?: Record; default: not declared - suspiciousReturnsWarning().return.message: string; default: not declared - suspiciousReturnsWarning().return.severity: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared - suspiciousReturnsWarning(returns): ArrayLike; default: not declared - toFixedSafe: (value: number, decimals?: number) => string; default: not declared — `toFixed` that never throws on non-finite input and never returns `"NaN"` silently. - toFixedSafe(decimals)?: number; default: not declared - toFixedSafe(value): number; default: not declared - usEquityCloseUtcMs: (year: number, month: number, day: number) => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — UTC epoch-ms for the **US equity/options market close** on a calendar date — 16:00 America/New_York, or 13:00 on an early-close day ({@link isUsEquityHalfDay}) — DST-aware via `Intl`. Use it to resolve a *date-only* option expiry to its end-of-session instant instead of UTC midnight, so a contract stays alive through its expiry trading day. This encodes US-equity hours specifically; it is not a generic exchange close. - usEquityCloseUtcMs(day): number; default: not declared - usEquityCloseUtcMs(month): number; default: not declared - usEquityCloseUtcMs(year): number; default: not declared - usEquityMarketDateUtcMs: (epochMs: import('@insiderfinance/totalfinance/core').EpochMs) => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — UTC-midnight epoch of the market DATE an instant falls on — the anchor for weekday / day-of-month arithmetic (`getUTCDay()` on it is the ET weekday) and for whole-day counts against date labels. - usEquityMarketDateUtcMs(epochMs): number; default: not declared - usEquityMarketDayIndex: (epochMs: import('@insiderfinance/totalfinance/core').EpochMs) => number; default: not declared — The US equity/options market's calendar DAY an instant falls on, as a whole-day index (days since the epoch of the America/New_York calendar date). Differencing two indices gives whole CALENDAR DAYS between two market dates; equality means "same trading date". This is the ONE day boundary shared by 0DTE classification, days-to-expiry counts and earnings day counts: expiries resolve to 16:00 ET (20:00/21:00 UTC), so a UTC-day comparison is already "tomorrow" between 20:00 and 23:59 ET. Pure and clock-free. - usEquityMarketDayIndex(epochMs): number; default: not declared - usEquitySessionInstant: (date: string, session: 'open' | 'close') => import('@insiderfinance/totalfinance/core').EpochMs; default: not declared — The instant of a US equity/options session boundary on a `YYYY-MM-DD` date — the one-call way to say "as of today's close" without remembering the DST offset: ```ts market({ spot: 195.3, riskFreeRate: 0.045, volatility: 0.24, asOf: usEquitySessionInstant('2026-07-20', 'close') }) ``` `'open'` is 09:30 ET; `'close'` is 16:00 ET, or 13:00 ET on an early-close day. Weekends and holidays are not rejected here (the instant still exists); use `@insiderfinance/totalfinance/calendars` to ask whether the market was open. - usEquitySessionInstant(date): string; default: not declared - usEquitySessionInstant(session): 'open' | 'close'; default: not declared - validateClosedRequest: (functionName: string, value: unknown, specification: import('@insiderfinance/totalfinance/core').ClosedRequestSpecification, teaching: import('@insiderfinance/totalfinance/core').ClosedRequestTeaching) => void; default: not declared — Validate one public closed request against its GENERATED contract spec. Call ONCE at the public boundary; internals stay unchecked. Domain semantics (positivity, coordinate relationships, plausibility) remain the boundary's own code — this enforces shape, presence, type, finiteness, domain literals, and closedness, with the exact code each mistake owns. - validateClosedRequest(functionName): string; default: not declared - validateClosedRequest(specification): import('@insiderfinance/totalfinance/core').ClosedRequestSpecification; default: not declared - validateClosedRequest(specification).branches?: readonly import('@insiderfinance/totalfinance/core').ValidationBranchSpecification[]; default: not declared — ROOT union alternatives — the whole argument is a discriminated union (`phiValue`'s `SSVIPhi`). When present, `fields` holds the arms' COMMON members (the discriminant) and resolution runs discriminant-first over these arms exactly as a union FIELD's branches do. - validateClosedRequest(specification).contract: string; default: not declared — The stable contract identity this spec was generated from — drift gates compare through it. - validateClosedRequest(specification).fields: readonly import('@insiderfinance/totalfinance/core').ValidationFieldSpecification[]; default: not declared - validateClosedRequest(teaching): import('@insiderfinance/totalfinance/core').ClosedRequestTeaching; default: not declared - validateClosedRequest(teaching).argumentName?: string; default: not declared — The argument's own label in container errors — defaults to `input`. - validateClosedRequest(teaching).exampleCall: string | (() => string); default: not declared — ONE complete, runnable call for this boundary, or a thunk so the string is only built on the failing path. Hand-authored at the call site: the generator knows the keys, never the values. - validateClosedRequest(teaching).hints?: Readonly>; default: not declared — Per-field unit-trap notes, keyed by BARE field name (`volatility: 'annualized decimal'`). - validateClosedRequest(teaching).open?: boolean; default: not declared — The argument is an OPEN structural artifact per its manifest policy (Law 12): every consumed field runs its ladder, but unknown keys are PRESERVED decoration, never rejected — a fit result or market snapshot a user hands back may legitimately carry their own annotations. Curated from the manifest's per-argument `inputPolicies`; closed remains the default. - validateClosedRequest(teaching).subject?: boolean; default: not declared — This argument IS the request — field paths stay bare (`volatility`, `issueDate`) even under a domain-specific argument name like `specification`. Secondary arguments (an options bag beside a subject) omit it and get prefixed paths so a two-object call says which object to fix. - validateClosedRequest(value): unknown; default: not declared - validateResolvedExpiry: (functionName: string, expiry: string, expiresAt: unknown, expiryConvention: unknown) => void; default: not declared — ONE expiry law, cross-field (E2): validate that a resolved option-expiry triple — `expiry` label, `expiresAt` instant, `expiryConvention` — is internally consistent: - the label parses, and its form matches the convention (date-only ⇔ `us-equity-close`, zoned datetime ⇔ `explicit-instant`); - `expiresAt` is the finite instant the label resolves to under that convention. Shared by the contract schema and the pro pricing entrypoints, so a hand-assembled or post-hoc-edited contract can never smuggle a contradictory resolution past an engine. - validateResolvedExpiry(expiresAt): unknown; default: not declared - validateResolvedExpiry(expiry): string; default: not declared - validateResolvedExpiry(expiryConvention): unknown; default: not declared - validateResolvedExpiry(functionName): string; default: not declared - warning: (code: string, message: string, severity?: import('@insiderfinance/totalfinance/core').WarningSeverity, context?: Record) => import('@insiderfinance/totalfinance/core').QuantWarning; default: not declared — Build a warning helper, defaulting severity to `warn`. - warning().return.code: string; default: not declared - warning().return.context?: Record; default: not declared - warning().return.message: string; default: not declared - warning().return.severity: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared - warning(code): string; default: not declared - warning(context)?: Record | undefined; default: not declared - warning(message): string; default: not declared - warning(severity)?: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared - weekendsOnly: import('@insiderfinance/totalfinance/core').Calendar; default: not declared — A calendar whose only non-business days are weekends. - weekendsOnly.addBusinessDays: (date: string, days: number) => string; default: not declared - weekendsOnly.addBusinessDays(date): string; default: not declared - weekendsOnly.addBusinessDays(days): number; default: not declared - weekendsOnly.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - weekendsOnly.businessDaysBetween(from): string; default: not declared - weekendsOnly.businessDaysBetween(to): string; default: not declared - weekendsOnly.isBusinessDay: (date: string) => boolean; default: not declared - weekendsOnly.isBusinessDay(date): string; default: not declared - weekendsOnly.isHalfDay: (date: string) => boolean; default: not declared - weekendsOnly.isHalfDay(date): string; default: not declared - weekendsOnly.isHoliday: (date: string) => boolean; default: not declared - weekendsOnly.isHoliday(date): string; default: not declared - weekendsOnly.name: string; default: not declared - weekendsOnly.nextBusinessDay: (date: string) => string; default: not declared - weekendsOnly.nextBusinessDay(date): string; default: not declared - weekendsOnly.previousBusinessDay: (date: string) => string; default: not declared - weekendsOnly.previousBusinessDay(date): string; default: not declared - weekendsOnly.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - weekendsOnly.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - weekendsOnly.session().return.date: string; default: not declared - weekendsOnly.session().return.isBusinessDay: boolean; default: not declared - weekendsOnly.session().return.isHalfDay: boolean; default: not declared - weekendsOnly.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - weekendsOnly.session(date): string; default: not declared - weekendsOnly.timezone: string; default: not declared - weekendsOnly.version: string; default: not declared - wrongShapeError: (functionName: string, expected: string, received: unknown) => import('@insiderfinance/totalfinance/core').InputError; default: not declared — Build a "this object isn't the expected shape" error that echoes the keys the caller DID pass. The received-keys echo turns the error into documentation of the expected shape — a reasonable wrong guess (`{ putLongStrike: … }`) is answered with the real slot names rather than a raw `TypeError`. - wrongShapeError().return.code: string; default: not declared - wrongShapeError().return.context?: Record; default: not declared - wrongShapeError().return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - wrongShapeError(expected): string; default: not declared - wrongShapeError(functionName): string; default: not declared - wrongShapeError(received): unknown; default: not declared - yearFraction: (from: string | import('@insiderfinance/totalfinance/core').EpochMs, to: string | import('@insiderfinance/totalfinance/core').EpochMs, dayCount?: import('@insiderfinance/totalfinance/core').DayCount) => number; default: not declared — Year fraction between two dates under a day-count convention. - `ACT/365F` and `ACT/360` use actual elapsed days. - `30/360` uses the US (NASD) bond-basis adjustment on calendar components. - yearFraction(dayCount)?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - yearFraction(from): string | number; default: not declared - yearFraction(to): string | number; default: not declared - ymd: (year: number, month: number, day: number) => string; default: not declared — Compose an ISO date from components. - ymd(day): number; default: not declared - ymd(month): number; default: not declared - ymd(year): number; default: not declared ### @insiderfinance/totalfinance#createPriceBarsWindowView Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore full terminal state and explicit research choices; no source calls or clocks. ```typescript export declare function createPriceBarsWindowView(input: unknown, selection?: unknown): PriceBarsWindowView; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): unknown; default: not declared - (selection)?: unknown; default: not declared - return.bars: readonly Readonly[]; default: not declared - return.closePrices: readonly number[]; default: not declared - return.issues: readonly import('@insiderfinance/totalfinance/core/data').ResearchBarIssue[]; default: not declared - return.kind: 'price-bars-window'; default: not declared - return.ohlcvBars: readonly import('@insiderfinance/totalfinance/core/data').OhlcvInput[]; default: not declared - return.resolve: (choice: import('@insiderfinance/totalfinance/core/data').ResearchBarChoice) => PriceBarsWindowView; default: not declared - return.selection: import('@insiderfinance/totalfinance/core/data').ResearchBarSelection; default: not declared - return.selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared - return.window: PriceBarsWindow; default: not declared ### @insiderfinance/totalfinance#crypto Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const crypto: typeof import('@insiderfinance/totalfinance/crypto'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - carryCurve: (input: import('@insiderfinance/totalfinance/crypto').CarryCurveInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - carryCurve().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - carryCurve().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - carryCurve().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - carryCurve().return.value: import('@insiderfinance/totalfinance/crypto').CarryCurve; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - carryCurve(input): import('@insiderfinance/totalfinance/crypto').CarryCurveInput; default: not declared - carryCurve(input).coinYield?: number; default: not declared — Coin (base) yield. Default 0. - carryCurve(input).financingRate?: number; default: not declared — Quote financing rate — enables per-point cash-and-carry richness. - carryCurve(input).flatTolerance?: number; default: not declared — |forward-carry| range below which the shape is `flat`. Default 5e-4 (5 bp). - carryCurve(input).futures: import('@insiderfinance/totalfinance/crypto').CarryCurveFuture[]; default: not declared — Dated futures on the same underlying (≥ 1; distinct expiries). - carryCurve(input).queryTenors?: number[]; default: not declared — Tenors (years) to interpolate the carry at. - carryCurve(input).spot: number; default: not declared — Spot / index price (`t = 0`). - fundingBasisSpread: (input: import('@insiderfinance/totalfinance/crypto').FundingBasisSpreadInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - fundingBasisSpread().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - fundingBasisSpread().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - fundingBasisSpread().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - fundingBasisSpread().return.value: import('@insiderfinance/totalfinance/crypto').FundingBasisSpread; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - fundingBasisSpread(input): import('@insiderfinance/totalfinance/crypto').FundingBasisSpreadInput; default: not declared - fundingBasisSpread(input).fundingRate: number; default: not declared — Perp funding for the interval. - fundingBasisSpread(input).future: number; default: not declared — Dated-future price on the same underlying. - fundingBasisSpread(input).intervalHours?: number; default: not declared — Funding interval in hours. Default 8. - fundingBasisSpread(input).spot: number; default: not declared — Index (spot) price. - fundingBasisSpread(input).timeToExpiryYears: number; default: not declared — Future's time to expiry in years. - fundingBasisSpread(input).tolerance?: number; default: not declared — |spread| below which the two are 'aligned'. Default 0.005 (0.5 %/yr). - futuresBasis: (input: import('@insiderfinance/totalfinance/crypto').FuturesBasisInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - futuresBasis().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - futuresBasis().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - futuresBasis().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - futuresBasis().return.value: import('@insiderfinance/totalfinance/crypto').FuturesBasis; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - futuresBasis(input): import('@insiderfinance/totalfinance/crypto').FuturesBasisInput; default: not declared - futuresBasis(input).arbitrageThreshold?: number; default: not declared — |carryArbitrage| above which a cash-and-carry arbitrage is flagged. Default 0.05 (5 %/yr). - futuresBasis(input).coinYield?: number; default: not declared — Coin (base) yield. Default 0. - futuresBasis(input).financingRate?: number; default: not declared — Quote financing rate — supply to enable `fairFuture`/`richness`/`carryArbitrage`. - futuresBasis(input).future: number; default: not declared — Dated-future price. - futuresBasis(input).spot: number; default: not declared — Index (spot) price. - futuresBasis(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - inverseFuture: (input: import('@insiderfinance/totalfinance/crypto').InverseFutureInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - inverseFuture().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseFuture().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseFuture().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseFuture().return.value: import('@insiderfinance/totalfinance/crypto').InverseFuture; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseFuture(input): import('@insiderfinance/totalfinance/crypto').InverseFutureInput; default: not declared - inverseFuture(input).entryPrice: number; default: not declared — Entry price (USD per coin). - inverseFuture(input).markPrice: number; default: not declared — Current mark price (USD per coin). - inverseFuture(input).notionalUsd: number; default: not declared — USD notional (= contracts × contract multiplier, e.g. $10/contract on Deribit). - inverseFuture(input).side?: 'long' | 'short'; default: not declared — Position side. Default 'long'. - inverseHedge: (input: import('@insiderfinance/totalfinance/crypto').InverseHedgeInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - inverseHedge().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseHedge().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseHedge().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseHedge().return.value: import('@insiderfinance/totalfinance/crypto').InverseHedge; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseHedge(input): import('@insiderfinance/totalfinance/crypto').InverseHedgeInput; default: not declared - inverseHedge(input).coinDelta: number; default: not declared — The coin delta to neutralize (e.g. `inverseOption.greeks(…).value.coin.delta`). - inverseHedge(input).coinGamma?: number; default: not declared — Coin gamma of the position being hedged — supply to get the residual gamma after the delta hedge. - inverseHedge(input).markPrice: number; default: not declared — Mark price of the inverse future/perp used to hedge (USD per coin; a perp ≈ spot). - liquidationPrice: (input: import('@insiderfinance/totalfinance/crypto').LiquidationInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Isolated-margin liquidation & bankruptcy price of a leveraged perpetual/future position (inverse or linear). Size-independent: depends only on entry price, leverage, maintenance-margin rate, side, and margin mode. Maintenance is assessed at the mark (see the module doc for the convention and the closed forms). Requires `leverage > 1` — an isolated liquidation price is degenerate at ≤1×. - liquidationPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - liquidationPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - liquidationPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - liquidationPrice().return.value: import('@insiderfinance/totalfinance/crypto').Liquidation; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - liquidationPrice(input): import('@insiderfinance/totalfinance/crypto').LiquidationInput; default: not declared - liquidationPrice(input).entryPrice: number; default: not declared — Entry (average) price, USD per coin. - liquidationPrice(input).leverage: number; default: not declared — Position leverage (`> 1`); the initial-margin rate is `1/leverage`. - liquidationPrice(input).maintenanceMarginRate: number; default: not declared — Maintenance-margin rate `m` (fraction, e.g. `0.005` = 0.5%). `0 ≤ m < 1`. - liquidationPrice(input).margin: 'linear' | 'inverse'; default: not declared — Margin mode: coin-margined (`inverse`) or USDT-margined (`linear`). - liquidationPrice(input).side?: 'long' | 'short'; default: not declared — Position side. Default `'long'`. - optionsBasisSpread: (input: import('@insiderfinance/totalfinance/crypto').OptionsBasisSpreadInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - optionsBasisSpread().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - optionsBasisSpread().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - optionsBasisSpread().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - optionsBasisSpread().return.value: import('@insiderfinance/totalfinance/crypto').OptionsBasisSpread; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - optionsBasisSpread(input): import('@insiderfinance/totalfinance/crypto').OptionsBasisSpreadInput; default: not declared - optionsBasisSpread(input).call: number; default: not declared — European call price at `strike`/expiry, in USD (same numéraire as `spot`/`put`). - optionsBasisSpread(input).future: number; default: not declared — Observed dated-future price on the same underlying/expiry. - optionsBasisSpread(input).put: number; default: not declared — European put price at `strike`/expiry, in USD. - optionsBasisSpread(input).riskFreeRate: number; default: not declared — Continuously-compounded financing/discount rate used to un-discount the parity gap. - optionsBasisSpread(input).spot: number; default: not declared — Index (spot) price. - optionsBasisSpread(input).strike: number; default: not declared — The strike at which the European call & put are quoted (the parity strike). - optionsBasisSpread(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - optionsBasisSpread(input).tolerance?: number; default: not declared — |spread| below which the two forwards are 'aligned'. Default 0.005 (0.5 %/yr). - perpetualFunding: (input: import('@insiderfinance/totalfinance/crypto').PerpetualFundingInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Annualize a perpetual funding rate into its implied cost-of-carry, in both simple and compounded terms, with the long/short carry sign made explicit. See `docs/specs/crypto-carry.md`. - perpetualFunding().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - perpetualFunding().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - perpetualFunding().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - perpetualFunding().return.value: import('@insiderfinance/totalfinance/crypto').PerpetualFunding; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - perpetualFunding(input): import('@insiderfinance/totalfinance/crypto').PerpetualFundingInput; default: not declared - perpetualFunding(input).extremeAnnualized?: number; default: not declared — |annualized| above which the funding is flagged extreme. Default 1 (100 %/yr). - perpetualFunding(input).fundingRate: number; default: not declared — Realized funding for the interval (fraction; 0.0001 = 0.01 %). Longs pay shorts when positive. - perpetualFunding(input).indexPrice: number; default: not declared — Index (spot) price. - perpetualFunding(input).intervalHours?: number; default: not declared — Funding interval in hours. Default 8. - perpetualFunding(input).markPrice: number; default: not declared — Perpetual mark price. - predictedFunding: (input: import('@insiderfinance/totalfinance/crypto').PredictedFundingInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - predictedFunding().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - predictedFunding().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - predictedFunding().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - predictedFunding().return.value: import('@insiderfinance/totalfinance/crypto').PredictedFunding; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - predictedFunding(input): import('@insiderfinance/totalfinance/crypto').PredictedFundingInput; default: not declared - predictedFunding(input).cap?: number; default: not declared — Optional hard cap on |funding|. - predictedFunding(input).clamp?: number; default: not declared — Clamp half-width applied to the interest component. Default 0.0005 (Binance). - predictedFunding(input).interestRate?: number; default: not declared — Interest-rate component per interval (quote − base). Default 0. - predictedFunding(input).premium: number; default: not declared — Premium index — the TWAP of `(perp − index)/index` over the interval. ### @insiderfinance/totalfinance#data Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const data: typeof import('@insiderfinance/totalfinance').data; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - connect: (source: import('@insiderfinance/totalfinance/core/data').DataProviderSource, options?: import('@insiderfinance/totalfinance/core/data').DataConnectionOptions) => import('@insiderfinance/totalfinance/core/data').ConnectedData; default: not declared — Bind only protocol2 sources. Construction performs no discovery or network work. - connect().return.capabilities: (options?: import('@insiderfinance/totalfinance/core/data').DataCallOptions) => Promise; default: not declared - connect().return.contractVersion: 2; default: not declared - connect().return.id: string; default: not declared - connect().return.priceBars: (request: import('@insiderfinance/totalfinance/core/data').PriceBarsWindowRequest, options?: import('@insiderfinance/totalfinance/core/data').PriceBarsWindowOptions) => Promise; default: not declared - connect().return.query: (query: R, options: import('@insiderfinance/totalfinance/core/data').DataQueryOptions) => Promise>; default: not declared - connect().return.resumePriceBars: (checkpoint: unknown, options?: import('@insiderfinance/totalfinance/core/data').PriceBarsWindowOptions) => Promise; default: not declared - connect().return.version: string; default: not declared - connect(options)?: import('@insiderfinance/totalfinance/core/data').DataConnectionOptions | undefined; default: not declared - connect(options).maxPages?: number; default: not declared - connect(options).maxReads?: number; default: not declared - connect(options).maxRecords?: number; default: not declared - connect(options).pageSize?: number; default: not declared - connect(source): import('@insiderfinance/totalfinance/core/data').DataProviderSource; default: not declared - connect(source).capabilities: (options?: import('@insiderfinance/totalfinance/core/data').DataCallOptions) => Promise; default: not declared - connect(source).contractVersion: 2; default: not declared - connect(source).id: string; default: not declared - connect(source).protocol: 'totalfinance-data-source'; default: not declared - connect(source).query: (query: import('@insiderfinance/totalfinance/core/data').DataQuery, page: import('@insiderfinance/totalfinance/core/data').DataPageOptions) => Promise; default: not declared - connect(source).version: string; default: not declared - createPriceBarsWindowView: (input: unknown, selection?: unknown) => import('@insiderfinance/totalfinance/core/data').PriceBarsWindowView; default: not declared — Restore full terminal state and explicit research choices; no source calls or clocks. - createPriceBarsWindowView().return.bars: readonly Readonly[]; default: not declared - createPriceBarsWindowView().return.closePrices: readonly number[]; default: not declared - createPriceBarsWindowView().return.issues: readonly import('@insiderfinance/totalfinance/core/data').ResearchBarIssue[]; default: not declared - createPriceBarsWindowView().return.kind: 'price-bars-window'; default: not declared - createPriceBarsWindowView().return.ohlcvBars: readonly import('@insiderfinance/totalfinance/core/data').OhlcvInput[]; default: not declared - createPriceBarsWindowView().return.resolve: (choice: import('@insiderfinance/totalfinance/core/data').ResearchBarChoice) => import('@insiderfinance/totalfinance/core/data').PriceBarsWindowView; default: not declared - createPriceBarsWindowView().return.selection: import('@insiderfinance/totalfinance/core/data').ResearchBarSelection; default: not declared - createPriceBarsWindowView().return.selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared - createPriceBarsWindowView().return.window: import('@insiderfinance/totalfinance/core/data').PriceBarsWindow; default: not declared - createPriceBarsWindowView(input): unknown; default: not declared - createPriceBarsWindowView(selection)?: unknown; default: not declared - priceBarsCheckpoint: (error: unknown) => import('@insiderfinance/totalfinance/core/data').PriceBarsCheckpoint | undefined; default: not declared — Explicit accessor; serialized public errors never contain licensed pages or cursors. - priceBarsCheckpoint().return.binding: import('@insiderfinance/totalfinance/core/data').DataQueryBinding; default: not declared - priceBarsCheckpoint().return.bytes: number; default: not declared - priceBarsCheckpoint().return.contractVersion: 2; default: not declared - priceBarsCheckpoint().return.kind: 'price-bars-checkpoint'; default: not declared - priceBarsCheckpoint().return.limits: { readonly maxPages: number; readonly maxReads: number; readonly maxRecords: number; }; default: not declared - priceBarsCheckpoint().return.limits.maxPages: number; default: not declared - priceBarsCheckpoint().return.limits.maxReads: number; default: not declared - priceBarsCheckpoint().return.limits.maxRecords: number; default: not declared - priceBarsCheckpoint().return.next: import('@insiderfinance/totalfinance/core/data').DataContinuation | null; default: not declared - priceBarsCheckpoint().return.next.binding: import('@insiderfinance/totalfinance/core/data').DataQueryBinding; default: not declared - priceBarsCheckpoint().return.next.cursor: string; default: not declared - priceBarsCheckpoint().return.next.pins: import('@insiderfinance/totalfinance/core/data').DataPins; default: not declared - priceBarsCheckpoint().return.next.version: 2; default: not declared - priceBarsCheckpoint().return.pages: readonly import('@insiderfinance/totalfinance/core/data').DataPage[]; default: not declared - priceBarsCheckpoint().return.paging: import('@insiderfinance/totalfinance/core/data').PriceBarsPaging; default: not declared - priceBarsCheckpoint().return.progress: { readonly status: 'incomplete'; readonly acceptedPages: number; readonly records: number; readonly reads: number; }; default: not declared - priceBarsCheckpoint().return.progress.acceptedPages: number; default: not declared - priceBarsCheckpoint().return.progress.reads: number; default: not declared - priceBarsCheckpoint().return.progress.records: number; default: not declared - priceBarsCheckpoint().return.progress.status: 'incomplete'; default: not declared - priceBarsCheckpoint().return.version: 1; default: not declared - priceBarsCheckpoint(error): unknown; default: not declared ### @insiderfinance/totalfinance#engines Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Built-in pricing engines (analytical, lattice, closed-form American approximations, and FDM) — every factory returns an {@link OptionPricingEngine} usable wherever an engine is accepted. ```typescript export declare const engines: { readonly blackScholes: () => OptionPricingEngine; readonly blackScholesMerton: () => OptionPricingEngine; readonly black76: () => OptionPricingEngine; readonly binomial: (options?: BinomialEngineOptions) => OptionPricingEngine; readonly trinomial: (options?: TrinomialEngineOptions) => OptionPricingEngine; readonly baroneAdesiWhaley: () => OptionPricingEngine; readonly bjerksundStensland: () => OptionPricingEngine; readonly bjerksundStensland2002: () => OptionPricingEngine; readonly bjerksundStensland1993: () => OptionPricingEngine; readonly finiteDifference: { readonly crankNicolson: (options?: FiniteDifferenceEngineOptions) => OptionPricingEngine; }; readonly monteCarlo: (options: MonteCarloPriceOptions) => OptionPricingEngine; readonly heston: (parameters: HestonParameters, options?: HestonCosineExpansionOptions) => OptionPricingEngine; readonly sabr: (parameters: SabrParameters, options?: SabrOptions) => OptionPricingEngine; readonly localVolatility: (surface: LocalVolatilityFunction, options: LocalVolatilityMonteCarloOptions) => OptionPricingEngine; readonly auto: (options?: AutoEngineOptions) => OptionPricingEngine; }; ``` Example (source JSDoc): ```ts import { engines, market, option } from '@insiderfinance/totalfinance/options'; const contract = option.usEquityCall({ underlying: 'AAPL', strike: 200, expiry: '2026-09-18' }); const mkt = market({ spot: 195, riskFreeRate: 0.045, volatility: 0.24, asOf: '2026-07-20T10:30:00-04:00' }); option.price({ contract, market: mkt }); // engines.auto() default option.price({ contract, market: mkt, engine: engines.binomial({ steps: 501 }) }); option.compareEngines({ contract, market: mkt }); // side-by-side table ``` Members/parameters (default = JSDoc only; not declared means no documented default): - auto: (options?: AutoEngineOptions) => OptionPricingEngine; default: not declared — Auto-select a pricing engine by objective (spec §9.3). The default `'accuracy'` favours the most accurate engine; `'speed'` favours the fastest closed form. Selection (delegate in **bold**): | Contract | speed | accuracy | | ------------------------------ | ----------------------------- | ----------------------------- | | European (spot) | **black-scholes-merton** | same | | European (forward, no spot) | **black-76** | same | | American call, no dividends | **black-scholes-merton** ¹ | same | | American (otherwise) | **bjerksund-stensland-2002** | **binomial-leisen-reimer** ² | | Unsupported (e.g. bermudan) | throws `engine.unsupported_contract` | ¹ Early exercise of a non-dividend call is never optimal, so its value equals the European BSM price. ² 501-step lattice. The result's `diagnostics.engine` is the DELEGATE's name and `diagnostics.autoReason` explains, in one sentence, why it was chosen. - auto().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - auto().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - auto().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - auto().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - auto().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - auto().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - auto().return.name: string; default: not declared - auto().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - auto().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - auto().return.version: string; default: not declared - auto(options)?: AutoEngineOptions; default: not declared - auto(options).objective?: AutoObjective; default: not declared — `'accuracy'` (default) picks the most accurate engine; `'speed'` the fastest closed form. - baroneAdesiWhaley: () => OptionPricingEngine; default: not declared — Barone–Adesi–Whaley American approximation (European falls through to BSM). Requires a POSITIVE rate: the quadratic approximation's exponent divides by `1 − e^{−rT}`, so it refuses `r ≤ 0` with `engine.unsupported_contract` instead of returning NaN or a diverging value. - baroneAdesiWhaley().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - baroneAdesiWhaley().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - baroneAdesiWhaley().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - baroneAdesiWhaley().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - baroneAdesiWhaley().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - baroneAdesiWhaley().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - baroneAdesiWhaley().return.name: string; default: not declared - baroneAdesiWhaley().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - baroneAdesiWhaley().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - baroneAdesiWhaley().return.version: string; default: not declared - binomial: (options?: BinomialEngineOptions) => OptionPricingEngine; default: not declared — Binomial tree (American or European). Variants: CRR, Jarrow–Rudd, Tian, Leisen–Reimer. - binomial().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - binomial().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - binomial().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - binomial().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - binomial().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - binomial().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - binomial().return.name: string; default: not declared - binomial().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - binomial().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - binomial().return.version: string; default: not declared - binomial(options)?: BinomialEngineOptions; default: not declared - binomial(options).steps?: number; default: not declared - binomial(options).variant?: BinomialVariant; default: not declared - bjerksundStensland: () => OptionPricingEngine; default: not declared — Bjerksund–Stensland American approximation — alias for the more accurate, more widely-used **2002** two-boundary form. Use {@link engines.bjerksundStensland1993} for the original single-boundary version. (European contracts fall through to BSM.) - bjerksundStensland().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - bjerksundStensland().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - bjerksundStensland().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - bjerksundStensland().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - bjerksundStensland().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - bjerksundStensland().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - bjerksundStensland().return.name: string; default: not declared - bjerksundStensland().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - bjerksundStensland().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - bjerksundStensland().return.version: string; default: not declared - bjerksundStensland1993: () => OptionPricingEngine; default: not declared — Bjerksund–Stensland (1993) single-boundary American approximation (European falls through to BSM). - bjerksundStensland1993().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - bjerksundStensland1993().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - bjerksundStensland1993().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - bjerksundStensland1993().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - bjerksundStensland1993().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - bjerksundStensland1993().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - bjerksundStensland1993().return.name: string; default: not declared - bjerksundStensland1993().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - bjerksundStensland1993().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - bjerksundStensland1993().return.version: string; default: not declared - bjerksundStensland2002: () => OptionPricingEngine; default: not declared — Bjerksund–Stensland (2002) two-boundary American approximation (European falls through to BSM). - bjerksundStensland2002().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - bjerksundStensland2002().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - bjerksundStensland2002().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - bjerksundStensland2002().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - bjerksundStensland2002().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - bjerksundStensland2002().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - bjerksundStensland2002().return.name: string; default: not declared - bjerksundStensland2002().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - bjerksundStensland2002().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - bjerksundStensland2002().return.version: string; default: not declared - black76: () => OptionPricingEngine; default: not declared — Black-76 (European options on a forward/future). Prices off `market.forward` and discounts at `market.rate` — the forward embeds carry/dividends, so no separate dividend model is applied. - black76().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - black76().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - black76().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - black76().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - black76().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - black76().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - black76().return.name: string; default: not declared - black76().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - black76().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - black76().return.version: string; default: not declared - blackScholes: () => OptionPricingEngine; default: not declared — Textbook Black–Scholes (European, no dividends). - blackScholes().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - blackScholes().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - blackScholes().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - blackScholes().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - blackScholes().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - blackScholes().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - blackScholes().return.name: string; default: not declared - blackScholes().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - blackScholes().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - blackScholes().return.version: string; default: not declared - blackScholesMerton: () => OptionPricingEngine; default: not declared — Black–Scholes–Merton (European) with a continuous dividend yield. - blackScholesMerton().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - blackScholesMerton().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - blackScholesMerton().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - blackScholesMerton().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - blackScholesMerton().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - blackScholesMerton().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - blackScholesMerton().return.name: string; default: not declared - blackScholesMerton().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - blackScholesMerton().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - blackScholesMerton().return.version: string; default: not declared - finiteDifference: { readonly crankNicolson: (options?: FiniteDifferenceEngineOptions) => OptionPricingEngine; }; default: not declared — Crank–Nicolson finite-difference engine (American or European). - finiteDifference.crankNicolson: (options?: FiniteDifferenceEngineOptions) => OptionPricingEngine; default: not declared - finiteDifference.crankNicolson().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - finiteDifference.crankNicolson().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - finiteDifference.crankNicolson().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - finiteDifference.crankNicolson().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - finiteDifference.crankNicolson().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - finiteDifference.crankNicolson().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - finiteDifference.crankNicolson().return.name: string; default: not declared - finiteDifference.crankNicolson().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - finiteDifference.crankNicolson().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - finiteDifference.crankNicolson().return.version: string; default: not declared - finiteDifference.crankNicolson(options)?: FiniteDifferenceEngineOptions; default: not declared - finiteDifference.crankNicolson(options).gridPoints?: number; default: not declared - finiteDifference.crankNicolson(options).timeSteps?: number; default: not declared - heston: (parameters: HestonParameters, options?: HestonCosineExpansionOptions) => OptionPricingEngine; default: not declared — Heston stochastic-volatility engine (spec §9.3, WS4.3): European vanillas via the COS method. American exercise is unsupported (`supports()` returns `false`). The low-level named-input kernel {@link hestonPrice} remains the direct API; this adapter lets Heston flow through `option.price`, `priceMany`, and `compareEngines`. - heston().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - heston().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - heston().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - heston().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - heston().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - heston().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - heston().return.name: string; default: not declared - heston().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - heston().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - heston().return.version: string; default: not declared - heston(options)?: HestonCosineExpansionOptions; default: not declared - heston(options).extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the **vol level** — `√v₀` and `√θ` bumped together — extending the `vega` convention. The COS price is accurate, so the finite differences are converged (verified stable across term counts). - heston(options).greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - heston(options).terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192; COS converges exponentially). - heston(options).truncation?: number; default: not declared — Truncation width in standard deviations (default 12). - heston(parameters): HestonParameters; default: not declared - heston(parameters).kappa: number; default: not declared — Mean-reversion speed κ. - heston(parameters).rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston(parameters).sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston(parameters).theta: number; default: not declared — Long-run variance θ. - heston(parameters).v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - localVolatility: (surface: LocalVolatilityFunction, options: LocalVolatilityMonteCarloOptions) => OptionPricingEngine; default: not declared — Local-volatility (Dupire) Monte-Carlo engine (spec §9.3, WS4.3): European vanillas. `surface` is a `LocalVolatilityFunction` `(level, t) → σ` (typically from `dupireLocalVolatility`); `options` requires a seed (echoed). Greeks are not computed by the MC engine — absent, never fabricated. Low-level kernel: {@link localVolatilityMonteCarloPrice}. - localVolatility().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - localVolatility().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - localVolatility().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - localVolatility().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - localVolatility().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - localVolatility().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - localVolatility().return.name: string; default: not declared - localVolatility().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - localVolatility().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - localVolatility().return.version: string; default: not declared - localVolatility(options): LocalVolatilityMonteCarloOptions; default: not declared - localVolatility(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - localVolatility(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - localVolatility(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - localVolatility(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - localVolatility(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - localVolatility(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - localVolatility(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - localVolatility(options).steps?: number; default: not declared — Time steps per path (default 100). - localVolatility(surface): LocalVolatilityFunction; default: not declared - monteCarlo: (options: MonteCarloPriceOptions) => OptionPricingEngine; default: not declared — Geometric-Brownian-motion Monte-Carlo engine (European only). The seed is required and echoed; the result carries MC error statistics on `result.mc` (and is a superset of {@link PriceResult}). Excluded from the {@link compareEngines} default panel — a stochastic engine belongs in a comparison only when the caller options in with a fixed seed. - monteCarlo().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - monteCarlo().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - monteCarlo().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - monteCarlo().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - monteCarlo().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - monteCarlo().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - monteCarlo().return.name: string; default: not declared - monteCarlo().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - monteCarlo().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - monteCarlo().return.version: string; default: not declared - monteCarlo(options): MonteCarloPriceOptions; default: not declared - monteCarlo(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarlo(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarlo(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarlo(options).extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set by CRN finite differences (implies `greeks`). Third-order Greeks (speed/color/ultima) carry more Monte-Carlo error than the first/second order — raise `paths` when you need them tight. - monteCarlo(options).greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `true`). - monteCarlo(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarlo(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarlo(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarlo(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - sabr: (parameters: SabrParameters, options?: SabrOptions) => OptionPricingEngine; default: not declared — SABR engine (spec §9.3, WS4.3): European vanillas via Hagan's implied vol into Black-76 (lognormal) or Bachelier (normal). Uses `market.forward` when present, else the spot-implied forward. Low-level named-input kernel: {@link sabrPrice}. - sabr().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - sabr().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - sabr().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - sabr().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - sabr().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - sabr().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - sabr().return.name: string; default: not declared - sabr().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - sabr().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - sabr().return.version: string; default: not declared - sabr(options)?: SabrOptions; default: not declared - sabr(options).extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the SABR level `α` — extending the `vega` convention; `phi = 0` (forward model). Hagan's vol is smooth, so the finite differences are stable. - sabr(options).greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - sabr(options).volatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — Hagan expansion (default `'lognormal'`). - sabr(parameters): SabrParameters; default: not declared - sabr(parameters).alpha: number; default: not declared — Initial volatility level α (> 0). - sabr(parameters).beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - sabr(parameters).nu: number; default: not declared — Volatility of volatility ν (≥ 0). - sabr(parameters).rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - trinomial: (options?: TrinomialEngineOptions) => OptionPricingEngine; default: not declared — Trinomial tree (American or European). - trinomial().return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - trinomial().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - trinomial().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - trinomial().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - trinomial().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - trinomial().return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - trinomial().return.name: string; default: not declared - trinomial().return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - trinomial().return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - trinomial().return.version: string; default: not declared - trinomial(options)?: TrinomialEngineOptions; default: not declared - trinomial(options).steps?: number; default: not declared ### @insiderfinance/totalfinance#fixedIncome Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const fixedIncome: typeof import('@insiderfinance/totalfinance/fixed-income'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addMonths: (date: string, months: number, endOfMonth?: boolean) => string; default: not declared — Add `months` to an ISO date. The day-of-month is clamped to the target month's length; when `endOfMonth` is set the result snaps to the last day of the target month (the convention used when a coupon schedule anchors on a month-end date). - addMonths(date): string; default: not declared - addMonths(endOfMonth)?: boolean; default: not declared - addMonths(months): number; default: not declared - adjustDate: (date: string, convention?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention, calendar?: import('@insiderfinance/totalfinance/core').Calendar) => string; default: not declared - adjustDate(calendar)?: import('@insiderfinance/totalfinance/core').Calendar; default: not declared - adjustDate(calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - adjustDate(calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - adjustDate(calendar).isBusinessDay: (date: string) => boolean; default: not declared - adjustDate(calendar).isHalfDay: (date: string) => boolean; default: not declared - adjustDate(calendar).isHoliday: (date: string) => boolean; default: not declared - adjustDate(calendar).name: string; default: not declared - adjustDate(calendar).nextBusinessDay: (date: string) => string; default: not declared - adjustDate(calendar).previousBusinessDay: (date: string) => string; default: not declared - adjustDate(calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - adjustDate(calendar).timezone: string; default: not declared - adjustDate(calendar).version: string; default: not declared - adjustDate(convention)?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared - adjustDate(date): string; default: not declared - bermudanSwaption: (specification: import('@insiderfinance/totalfinance/fixed-income').BermudanSwaptionSpecification) => import('@insiderfinance/totalfinance/fixed-income').BermudanSwaptionResult; default: not declared — Price a Bermudan swaption on the Hull-White tree. At each exercise date the holder takes `max(continuation, swapValue)`, where the node-level forward swap value uses the Hull-White analytic bond reconstruction `P(tᵢ, T; r_node)`. (Hull-White only — the lognormal Black-Karasinski tree has no analytic node bond.) - bermudanSwaption().return.assumptions: { conventionsVersion: string; model: 'hull-white'; dayCount: 'ACT/365F'; settlementDate: string; stepsPerYear: number; meanReversion: number; sigma: number; fixedFrequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; fixedDayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; notional: number; }; default: not declared — Applied conventions and model knobs, echoed (Law 2 report grammar). - bermudanSwaption().return.assumptions.conventionsVersion: string; default: not declared - bermudanSwaption().return.assumptions.dayCount: 'ACT/365F'; default: not declared - bermudanSwaption().return.assumptions.fixedDayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bermudanSwaption().return.assumptions.fixedFrequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - bermudanSwaption().return.assumptions.meanReversion: number; default: not declared - bermudanSwaption().return.assumptions.model: 'hull-white'; default: not declared - bermudanSwaption().return.assumptions.notional: number; default: not declared - bermudanSwaption().return.assumptions.settlementDate: string; default: not declared - bermudanSwaption().return.assumptions.sigma: number; default: not declared - bermudanSwaption().return.assumptions.stepsPerYear: number; default: not declared - bermudanSwaption().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Honest computation report: the lattice method behind the price (Law 2 report grammar). - bermudanSwaption().return.exerciseDates: string[]; default: not declared — The exercise schedule actually used, sorted ascending from the valuation date. - bermudanSwaption().return.price: number; default: not declared — Option value, scaled by `notional`. - bermudanSwaption(specification): import('@insiderfinance/totalfinance/fixed-income').BermudanSwaptionSpecification; default: not declared - bermudanSwaption(specification).curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Discount/forecast curve (single-curve); its reference date is the valuation date. - bermudanSwaption(specification).exerciseDates: string[]; default: not declared — Dates on which the holder may exercise into the swap (each is a swap start). - bermudanSwaption(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - bermudanSwaption(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Fixed-leg frequency (default semiannual). - bermudanSwaption(specification).fixedRate: number; default: not declared — Fixed rate of the underlying swap. - bermudanSwaption(specification).maturityDate: string; default: not declared — Underlying swap maturity. - bermudanSwaption(specification).meanReversion: number; default: not declared — Mean reversion and short-rate vol. - bermudanSwaption(specification).notional?: number; default: not declared - bermudanSwaption(specification).optionType: 'payer' | 'receiver'; default: not declared — `payer` = option to pay fixed; `receiver` = option to receive fixed. - bermudanSwaption(specification).sigma: number; default: not declared - bermudanSwaption(specification).stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). - bondFuture: (input: import('@insiderfinance/totalfinance/fixed-income').BondFutureInput) => import('@insiderfinance/totalfinance/fixed-income').BondFutureResult; default: not declared — Bond-future basis, carry, implied repo rate, and cheapest-to-deliver across a basket. See `docs/specs/bond-future-ctd.md`. - bondFuture().return.assumptions: { conventionsVersion: string; futuresPrice: number; repoRate: number; notionalCoupon: number; settlementDate: string; deliveryDate: string; }; default: not declared - bondFuture().return.assumptions.conventionsVersion: string; default: not declared - bondFuture().return.assumptions.deliveryDate: string; default: not declared - bondFuture().return.assumptions.futuresPrice: number; default: not declared - bondFuture().return.assumptions.notionalCoupon: number; default: not declared - bondFuture().return.assumptions.repoRate: number; default: not declared - bondFuture().return.assumptions.settlementDate: string; default: not declared - bondFuture().return.cheapestToDeliver: import('@insiderfinance/totalfinance/fixed-income').DeliverableAnalysis; default: not declared — The cheapest-to-deliver (max implied repo rate). - bondFuture().return.deliverables: import('@insiderfinance/totalfinance/fixed-income').DeliverableAnalysis[]; default: not declared — Per-deliverable rows, sorted by implied repo rate descending (CTD first). - bondFuture().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - bondFuture().return.summary: string; default: not declared - bondFuture().return.yearsToDelivery: number; default: not declared - bondFuture(input): import('@insiderfinance/totalfinance/fixed-income').BondFutureInput; default: not declared - bondFuture(input).deliverables: import('@insiderfinance/totalfinance/fixed-income').DeliverableBond[]; default: not declared - bondFuture(input).deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - bondFuture(input).futuresPrice: number; default: not declared — Futures price per 100 face. - bondFuture(input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - bondFuture(input).repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - bondFuture(input).settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - bondFutureCtdFrontier: (input: import('@insiderfinance/totalfinance/fixed-income').BondFutureCtdFrontierInput) => import('@insiderfinance/totalfinance/fixed-income').BondFutureCtdFrontierResult; default: not declared — The cheapest-to-deliver *frontier*: how the CTD identity and the futures risk move under explicit parallel-yield (and optional futures-price) scenarios. This is a **switching frontier**, not a valuation of the short's timing/quality delivery option (which stays deferred). It composes {@link bondFuture} at every node (one source of basis/carry/implied-repo truth), reprices each deliverable with {@link priceFromYield}, refines held-constant switch brackets by re-evaluating the *whole* basket (so a narrow third-deliverable window splits into two honest transitions and no pairwise root off the global frontier is accepted), and reports the delivery-date futures DV01 from the CTD's futures-implied forward yield — distinct from the spot cash DV01 / CF. See `docs/specs/wave6-quant-moats.md` §1 and `docs/specs/bond-future-ctd.md`. - bondFutureCtdFrontier().return.assumptions: { conventionsVersion: string; settlementDate: string; deliveryDate: string; futuresPriceScenario: 'held-constant' | 'supplied-path'; yieldShock: 'parallel'; yieldShiftsBp: number[]; refineSwitches: boolean; switchLocationToleranceBp: number | null; repoRateTieTolerance: 1e-10; }; default: not declared - bondFutureCtdFrontier().return.assumptions.conventionsVersion: string; default: not declared - bondFutureCtdFrontier().return.assumptions.deliveryDate: string; default: not declared - bondFutureCtdFrontier().return.assumptions.futuresPriceScenario: 'held-constant' | 'supplied-path'; default: not declared - bondFutureCtdFrontier().return.assumptions.refineSwitches: boolean; default: not declared - bondFutureCtdFrontier().return.assumptions.repoRateTieTolerance: 1e-10; default: not declared — Internal global-tie test, decimal annualized implied-repo rate; a fixed library assumption. - bondFutureCtdFrontier().return.assumptions.settlementDate: string; default: not declared - bondFutureCtdFrontier().return.assumptions.switchLocationToleranceBp: number | null; default: not declared - bondFutureCtdFrontier().return.assumptions.yieldShiftsBp: number[]; default: not declared - bondFutureCtdFrontier().return.assumptions.yieldShock: 'parallel'; default: not declared - bondFutureCtdFrontier().return.current: { ctdId: string; ctdYield: number; conversionFactor: number; }; default: not declared — The current (unshifted) cheapest-to-deliver. - bondFutureCtdFrontier().return.current.conversionFactor: number; default: not declared - bondFutureCtdFrontier().return.current.ctdId: string; default: not declared - bondFutureCtdFrontier().return.current.ctdYield: number; default: not declared - bondFutureCtdFrontier().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - bondFutureCtdFrontier().return.risk: { spotFuturesDv01: number; deliveryDateFuturesDv01: number; impliedForwardYield: number; }; default: not declared - bondFutureCtdFrontier().return.risk.deliveryDateFuturesDv01: number; default: not declared — The futures DV01 from the CTD's *forward* DV01 at the delivery date / CF — the delivery risk. - bondFutureCtdFrontier().return.risk.impliedForwardYield: number; default: not declared — The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. - bondFutureCtdFrontier().return.risk.spotFuturesDv01: number; default: not declared — The current futures DV01 from the spot cash DV01 / CF (matches {@link bondFutureHedge}). - bondFutureCtdFrontier().return.scenarios: import('@insiderfinance/totalfinance/fixed-income').CtdFrontierScenario[]; default: not declared — Every scanned node, ordered by ascending yield shift. - bondFutureCtdFrontier().return.switches: import('@insiderfinance/totalfinance/fixed-income').CtdSwitch[]; default: not declared — Every CTD switch across the scan (a third-deliverable window splits into two transitions). - bondFutureCtdFrontier(input): import('@insiderfinance/totalfinance/fixed-income').BondFutureCtdFrontierInput; default: not declared - bondFutureCtdFrontier(input).deliverables: import('@insiderfinance/totalfinance/fixed-income').DeliverableBond[]; default: not declared - bondFutureCtdFrontier(input).deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - bondFutureCtdFrontier(input).futuresPrice: number; default: not declared — Futures price per 100 face. - bondFutureCtdFrontier(input).futuresPrices?: readonly number[]; default: not declared — Optional futures-price path, one entry per *explicit* shift (the `(shift, price)` pairs are sorted together). Omit to hold the input futures quote constant across the scan (a ceteris-paribus basis question). A discrete path does not define values between nodes, so its switches stay grid-labeled. - bondFutureCtdFrontier(input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - bondFutureCtdFrontier(input).refineSwitches?: boolean; default: not declared — Refine held-constant-policy switch brackets to a crossing; default `true`. Invalid with `futuresPrices`. - bondFutureCtdFrontier(input).repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - bondFutureCtdFrontier(input).settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - bondFutureCtdFrontier(input).switchLocationToleranceBp?: number; default: not declared — Maximum reported switch-location bracket width in shift basis points; default `0.01`. - bondFutureCtdFrontier(input).yieldShiftsBp?: import('@insiderfinance/totalfinance/fixed-income').YieldShiftGrid; default: not declared — Parallel yield shifts (bp) to scan. Default `{ from: -200, to: 200, step: 25 }` (17 nodes incl. 0). - bondFutureHedge: (input: import('@insiderfinance/totalfinance/fixed-income').BondFutureHedgeInput) => import('@insiderfinance/totalfinance/fixed-income').BondFutureHedgeResult; default: not declared — Bond-future DV01 hedge ratio and futures-implied yield. Composes {@link bondFuture} (to find the CTD and the conversion factors) with the bond yield/DV01 analytics: the futures DV01 is the CTD's DV01 divided by its conversion factor (Hull), so a `hedgeDv01` of risk is offset by `hedgeDv01 / futuresDv01` contracts — exactly `CF` to hedge the CTD itself. Also reports the CTD yield implied by the forward clean price `F·CF`. See `docs/specs/bond-future-hedge.md`. - bondFutureHedge().return.assumptions: { conventionsVersion: string; futuresPrice: number; settlementDate: string; deliveryDate: string; }; default: not declared - bondFutureHedge().return.assumptions.conventionsVersion: string; default: not declared - bondFutureHedge().return.assumptions.deliveryDate: string; default: not declared - bondFutureHedge().return.assumptions.futuresPrice: number; default: not declared - bondFutureHedge().return.assumptions.settlementDate: string; default: not declared - bondFutureHedge().return.ctdConversionFactor: number; default: not declared - bondFutureHedge().return.ctdDv01: number; default: not declared — DV01 of the CTD cash bond per 100 face (at its market yield). - bondFutureHedge().return.ctdId: string; default: not declared - bondFutureHedge().return.ctdYield: number; default: not declared — Spot yield of the CTD at its market clean price. - bondFutureHedge().return.deliverables: import('@insiderfinance/totalfinance/fixed-income').DeliverableRisk[]; default: not declared — Per-deliverable spot yield + DV01 across the basket (CTD first). - bondFutureHedge().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - bondFutureHedge().return.futuresDv01: number; default: not declared — The futures contract's DV01 per 100 face of notional (`ctdDv01 / CF_ctd`). - bondFutureHedge().return.hedgeRatio?: number; default: not declared — # futures (per 100 face) whose DV01 offsets `hedgeDv01` — SELL them to hedge a long book. Present iff `hedgeDv01` was supplied. - bondFutureHedge().return.impliedForwardYield: number; default: not declared — The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. - bondFutureHedge(input): import('@insiderfinance/totalfinance/fixed-income').BondFutureHedgeInput; default: not declared - bondFutureHedge(input).deliverables: import('@insiderfinance/totalfinance/fixed-income').DeliverableBond[]; default: not declared - bondFutureHedge(input).deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - bondFutureHedge(input).futuresPrice: number; default: not declared — Futures price per 100 face. - bondFutureHedge(input).hedgeDv01?: number; default: not declared — DV01 (per 100 face) of the position to hedge; when given, the result reports `hedgeRatio`. - bondFutureHedge(input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - bondFutureHedge(input).repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - bondFutureHedge(input).settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - bonds: { fixedRate: (specification: import('@insiderfinance/totalfinance/fixed-income').FixedRateBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; zeroCoupon: (specification: import('@insiderfinance/totalfinance/fixed-income').ZeroCouponBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; floatingRateNote: (specification: import('@insiderfinance/totalfinance/fixed-income').FloatingRateNoteSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; amortizing: (specification: import('@insiderfinance/totalfinance/fixed-income').AmortizingBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; inflationLinked: (specification: import('@insiderfinance/totalfinance/fixed-income').InflationLinkedBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; }; default: not declared — Bond constructors (spec §14.1). - bonds.amortizing: (specification: import('@insiderfinance/totalfinance/fixed-income').AmortizingBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - bonds.amortizing().return.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bonds.amortizing().return.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bonds.amortizing().return.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bonds.amortizing().return.couponRate: number; default: not declared - bonds.amortizing().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bonds.amortizing().return.faceValue: number; default: not declared - bonds.amortizing().return.frequency: number; default: not declared - bonds.amortizing().return.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bonds.amortizing().return.issueDate: string; default: not declared - bonds.amortizing().return.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bonds.amortizing().return.maturityDate: string; default: not declared - bonds.amortizing().return.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - bonds.amortizing(specification): import('@insiderfinance/totalfinance/fixed-income').AmortizingBondSpecification; default: not declared - bonds.amortizing(specification).amortization: import('@insiderfinance/totalfinance/fixed-income').Amortization; default: not declared - bonds.amortizing(specification).convention?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared - bonds.amortizing(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - bonds.amortizing(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - bonds.amortizing(specification).endOfMonth?: boolean; default: not declared - bonds.amortizing(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - bonds.amortizing(specification).frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - bonds.amortizing(specification).issueDate: string; default: not declared — Dated date / first accrual date. - bonds.amortizing(specification).maturityDate: string; default: not declared - bonds.fixedRate: (specification: import('@insiderfinance/totalfinance/fixed-income').FixedRateBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - bonds.fixedRate().return.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bonds.fixedRate().return.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bonds.fixedRate().return.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bonds.fixedRate().return.couponRate: number; default: not declared - bonds.fixedRate().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bonds.fixedRate().return.faceValue: number; default: not declared - bonds.fixedRate().return.frequency: number; default: not declared - bonds.fixedRate().return.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bonds.fixedRate().return.issueDate: string; default: not declared - bonds.fixedRate().return.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bonds.fixedRate().return.maturityDate: string; default: not declared - bonds.fixedRate().return.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - bonds.fixedRate(specification): import('@insiderfinance/totalfinance/fixed-income').BaseSpecification; default: not declared - bonds.fixedRate(specification).convention?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared - bonds.fixedRate(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - bonds.fixedRate(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - bonds.fixedRate(specification).endOfMonth?: boolean; default: not declared - bonds.fixedRate(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - bonds.fixedRate(specification).frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - bonds.fixedRate(specification).issueDate: string; default: not declared — Dated date / first accrual date. - bonds.fixedRate(specification).maturityDate: string; default: not declared - bonds.floatingRateNote: (specification: import('@insiderfinance/totalfinance/fixed-income').FloatingRateNoteSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - bonds.floatingRateNote().return.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bonds.floatingRateNote().return.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bonds.floatingRateNote().return.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bonds.floatingRateNote().return.couponRate: number; default: not declared - bonds.floatingRateNote().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bonds.floatingRateNote().return.faceValue: number; default: not declared - bonds.floatingRateNote().return.frequency: number; default: not declared - bonds.floatingRateNote().return.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bonds.floatingRateNote().return.issueDate: string; default: not declared - bonds.floatingRateNote().return.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bonds.floatingRateNote().return.maturityDate: string; default: not declared - bonds.floatingRateNote().return.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - bonds.floatingRateNote(specification): import('@insiderfinance/totalfinance/fixed-income').FloatingRateNoteSpecification; default: not declared - bonds.floatingRateNote(specification).convention?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared - bonds.floatingRateNote(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - bonds.floatingRateNote(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - bonds.floatingRateNote(specification).endOfMonth?: boolean; default: not declared - bonds.floatingRateNote(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - bonds.floatingRateNote(specification).frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - bonds.floatingRateNote(specification).issueDate: string; default: not declared — Dated date / first accrual date. - bonds.floatingRateNote(specification).maturityDate: string; default: not declared - bonds.floatingRateNote(specification).spread?: number; default: not declared — Quoted margin over the projected index (decimal), e.g. 0.0025 = 25bp. Default 0. - bonds.inflationLinked: (specification: import('@insiderfinance/totalfinance/fixed-income').InflationLinkedBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - bonds.inflationLinked().return.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bonds.inflationLinked().return.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bonds.inflationLinked().return.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bonds.inflationLinked().return.couponRate: number; default: not declared - bonds.inflationLinked().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bonds.inflationLinked().return.faceValue: number; default: not declared - bonds.inflationLinked().return.frequency: number; default: not declared - bonds.inflationLinked().return.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bonds.inflationLinked().return.issueDate: string; default: not declared - bonds.inflationLinked().return.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bonds.inflationLinked().return.maturityDate: string; default: not declared - bonds.inflationLinked().return.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - bonds.inflationLinked(specification): import('@insiderfinance/totalfinance/fixed-income').InflationLinkedBondSpecification; default: not declared - bonds.inflationLinked(specification).baseIndex: number; default: not declared — Reference index level at issuance (the indexation base). - bonds.inflationLinked(specification).convention?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared - bonds.inflationLinked(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - bonds.inflationLinked(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - bonds.inflationLinked(specification).deflationFloor?: boolean; default: not declared — Floor the redeemed principal at par against deflation (TIPS-style). Default false. - bonds.inflationLinked(specification).endOfMonth?: boolean; default: not declared - bonds.inflationLinked(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - bonds.inflationLinked(specification).frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - bonds.inflationLinked(specification).issueDate: string; default: not declared — Dated date / first accrual date. - bonds.inflationLinked(specification).maturityDate: string; default: not declared - bonds.zeroCoupon: (specification: import('@insiderfinance/totalfinance/fixed-income').ZeroCouponBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - bonds.zeroCoupon().return.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bonds.zeroCoupon().return.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bonds.zeroCoupon().return.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bonds.zeroCoupon().return.couponRate: number; default: not declared - bonds.zeroCoupon().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bonds.zeroCoupon().return.faceValue: number; default: not declared - bonds.zeroCoupon().return.frequency: number; default: not declared - bonds.zeroCoupon().return.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bonds.zeroCoupon().return.issueDate: string; default: not declared - bonds.zeroCoupon().return.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bonds.zeroCoupon().return.maturityDate: string; default: not declared - bonds.zeroCoupon().return.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - bonds.zeroCoupon(specification): import('@insiderfinance/totalfinance/fixed-income').ZeroCouponBondSpecification; default: not declared - bonds.zeroCoupon(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bonds.zeroCoupon(specification).faceValue?: number; default: not declared - bonds.zeroCoupon(specification).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Yield compounding frequency for analytics. Default 1 (annual). - bonds.zeroCoupon(specification).issueDate: string; default: not declared - bonds.zeroCoupon(specification).maturityDate: string; default: not declared - bootstrapHazardFromCds: (quotes: import('@insiderfinance/totalfinance/fixed-income').CdsQuote[], options: import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared — Bootstrap a survival curve from a CDS par-spread term structure. Hazard is piecewise-constant between quote maturities; each segment is solved so the CDS to that tenor prices to par. - bootstrapHazardFromCds().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - bootstrapHazardFromCds().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bootstrapHazardFromCds().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - bootstrapHazardFromCds().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - bootstrapHazardFromCds().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - bootstrapHazardFromCds().return.referenceDate: string; default: not declared - bootstrapHazardFromCds().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - bootstrapHazardFromCds().return.timeTo: (at: string | number) => number; default: not declared - bootstrapHazardFromCds(options): import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions; default: not declared - bootstrapHazardFromCds(options).accrualOnDefault?: boolean; default: not declared - bootstrapHazardFromCds(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bootstrapHazardFromCds(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - bootstrapHazardFromCds(options).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - bootstrapHazardFromCds(options).protectionSteps?: number; default: not declared - bootstrapHazardFromCds(options).recovery?: number; default: not declared - bootstrapHazardFromCds(options).referenceDate: string; default: not declared - bootstrapHazardFromCds(quotes): import('@insiderfinance/totalfinance/fixed-income').CdsQuote[]; default: not declared - breakevenInflation: (input: import('@insiderfinance/totalfinance/fixed-income').BreakevenInflationInput) => import('@insiderfinance/totalfinance/fixed-income').BreakevenInflationResult; default: not declared — The breakeven inflation rate implied by a nominal and a real (TIPS) yield — arithmetic and exact Fisher-compounded — with the standard premium decomposition. See `docs/specs/inflation.md`. - breakevenInflation().return.assumptions: { conventionsVersion: string; method: 'fisher'; }; default: not declared - breakevenInflation().return.assumptions.conventionsVersion: string; default: not declared - breakevenInflation().return.assumptions.method: 'fisher'; default: not declared - breakevenInflation().return.breakeven: number; default: not declared — Arithmetic breakeven: `nominalYield − realYield` (the quoted number). - breakevenInflation().return.breakevenCompounded: number; default: not declared — Exact Fisher-compounded breakeven: `(1+nominal)/(1+real) − 1`. - breakevenInflation().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - breakevenInflation().return.expectedInflation: number | null; default: not declared — `breakeven − inflationRiskPremium + liquidityPremium`, or `null` when no premia are supplied. - breakevenInflation().return.nominalYield: number; default: not declared - breakevenInflation().return.realYield: number; default: not declared - breakevenInflation(input): import('@insiderfinance/totalfinance/fixed-income').BreakevenInflationInput; default: not declared - breakevenInflation(input).inflationRiskPremium?: number; default: not declared — Inflation risk premium (decimal); lifts the breakeven above expected inflation. - breakevenInflation(input).liquidityPremium?: number; default: not declared — TIPS liquidity premium (decimal); illiquidity depresses the real yield, lifting the breakeven. - breakevenInflation(input).nominalYield: number; default: not declared — Nominal bond yield (decimal, annualized). - breakevenInflation(input).realYield: number; default: not declared — Real (TIPS) yield (decimal, annualized). - callableBond: (specification: import('@insiderfinance/totalfinance/fixed-income').CallableBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').CallableBondResult; default: not declared — Price a callable and/or putable bond on a short-rate tree, with option value, effective duration, and OAS. - callableBond().return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; settlementDate: string; model: import('@insiderfinance/totalfinance/fixed-income').TreeModel; stepsPerYear: number; meanReversion: number; sigma: number; }; default: not declared — Applied conventions and model knobs, echoed (R2). - callableBond().return.assumptions.conventionsVersion: string; default: not declared - callableBond().return.assumptions.dayCount: 'ACT/365F'; default: not declared - callableBond().return.assumptions.meanReversion: number; default: not declared - callableBond().return.assumptions.model: import('@insiderfinance/totalfinance/fixed-income').TreeModel; default: not declared - callableBond().return.assumptions.settlementDate: string; default: not declared - callableBond().return.assumptions.sigma: number; default: not declared - callableBond().return.assumptions.stepsPerYear: number; default: not declared - callableBond().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Honest computation report: the lattice method, and the OAS root-find when one ran (R2). - callableBond().return.effectiveDuration: number; default: not declared — Effective duration from a ±1bp parallel curve shock (re-trees each side). - callableBond().return.oas?: number; default: not declared — Option-adjusted spread (parallel curve shift repricing the model to `marketPrice`); present only when `marketPrice` is supplied. - callableBond().return.optionValue: number; default: not declared — Value of the embedded option(s): `straightPrice − price` (positive for a callable). - callableBond().return.price: number; default: not declared — Model dirty price including the embedded option(s). - callableBond().return.straightPrice: number; default: not declared — Model dirty price of the otherwise-identical straight bond (no embedded options). - callableBond(specification): import('@insiderfinance/totalfinance/fixed-income').CallableBondSpecification; default: not declared - callableBond(specification).bond: import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - callableBond(specification).calls?: import('@insiderfinance/totalfinance/fixed-income').BondOption[]; default: not declared — Issuer call schedule (caps the bond's value at each strike). - callableBond(specification).curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Calibration/discount curve (its reference date is the valuation date). - callableBond(specification).marketPrice?: number; default: not declared — Market dirty price; when given, the result includes the option-adjusted spread. - callableBond(specification).meanReversion: number; default: not declared — Mean reversion and short-rate volatility for the tree model. - callableBond(specification).model?: import('@insiderfinance/totalfinance/fixed-income').TreeModel; default: not declared — Tree model (default `hull-white`). - callableBond(specification).puts?: import('@insiderfinance/totalfinance/fixed-income').BondOption[]; default: not declared — Holder put schedule (floors the bond's value at each strike). - callableBond(specification).sigma: number; default: not declared - callableBond(specification).stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). - capFloorPrice: (specification: import('@insiderfinance/totalfinance/fixed-income').CapFloorSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').SwapCurves) => import('@insiderfinance/totalfinance/fixed-income').CapFloorResult; default: not declared — Price a cap or floor as a strip of Black/Bachelier caplets/floorlets off discount/forecast curves. - capFloorPrice().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - capFloorPrice().return.assumptions.conventionsVersion: string; default: not declared - capFloorPrice().return.caplets: import('@insiderfinance/totalfinance/fixed-income').CapletResult[]; default: not declared - capFloorPrice().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - capFloorPrice().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - capFloorPrice().return.price: number; default: not declared - capFloorPrice(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - capFloorPrice(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - capFloorPrice(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - capFloorPrice(specification): import('@insiderfinance/totalfinance/fixed-income').CapFloorSpecification; default: not declared - capFloorPrice(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count for accrual and forward projection (default `ACT/360`). - capFloorPrice(specification).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Reset/payment frequency (default quarterly). - capFloorPrice(specification).maturityDate: string; default: not declared - capFloorPrice(specification).model?: import('@insiderfinance/totalfinance/fixed-income').RatesVolatilityModel; default: not declared - capFloorPrice(specification).notional?: number; default: not declared - capFloorPrice(specification).startDate: string; default: not declared - capFloorPrice(specification).strike: number; default: not declared - capFloorPrice(specification).type: 'floor' | 'cap'; default: not declared - capFloorPrice(specification).volatility: number; default: not declared — Flat volatility applied to every caplet/floorlet (lognormal for `black`, normal for `bachelier`). - cdsBasis: (input: import('@insiderfinance/totalfinance/fixed-income/credit').CdsBasisInput) => number; default: not declared — CDS–bond basis: `cdsParSpread − bondImpliedSpread`, both DECIMAL annualized spreads (H01, ratified plain). **Positive = the CDS is rich relative to the bond** (protection costs more than the bond's credit spread pays); negative = the bond is cheap to the CDS. - cdsBasis(input): import('@insiderfinance/totalfinance/fixed-income/credit').CdsBasisInput; default: not declared - cdsBasis(input).bondImpliedSpread: number; default: not declared - cdsBasis(input).cdsParSpread: number; default: not declared - cdsParSpread: import('@insiderfinance/totalfinance/fixed-income/credit').CdsParSpreadFacade; default: not declared - cdsParSpread(curves): import('@insiderfinance/totalfinance/fixed-income').CdsCurves; default: not declared - cdsParSpread(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - cdsParSpread(curves).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - cdsParSpread(specification): import('@insiderfinance/totalfinance/fixed-income').ParCdsSpecification; default: not declared - cdsParSpread(specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - cdsParSpread(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - cdsParSpread(specification).effectiveDate: string; default: not declared - cdsParSpread(specification).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Premium payment frequency. Default quarterly. - cdsParSpread(specification).maturityDate: string; default: not declared - cdsParSpread(specification).notional?: number; default: not declared - cdsParSpread(specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - cdsParSpread(specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - cdsParSpread.explain: (specification: import('@insiderfinance/totalfinance/fixed-income').ParCdsSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').CdsCurves) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/fixed-income/credit').CdsParSpreadAssumptions; }; default: not declared - cdsParSpread.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income/credit').CdsParSpreadAssumptions; default: not declared - cdsParSpread.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - cdsParSpread.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cdsParSpread.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cdsParSpread.explain(curves): import('@insiderfinance/totalfinance/fixed-income').CdsCurves; default: not declared - cdsParSpread.explain(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - cdsParSpread.explain(curves).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - cdsParSpread.explain(specification): import('@insiderfinance/totalfinance/fixed-income').ParCdsSpecification; default: not declared - cdsParSpread.explain(specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - cdsParSpread.explain(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - cdsParSpread.explain(specification).effectiveDate: string; default: not declared - cdsParSpread.explain(specification).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Premium payment frequency. Default quarterly. - cdsParSpread.explain(specification).maturityDate: string; default: not declared - cdsParSpread.explain(specification).notional?: number; default: not declared - cdsParSpread.explain(specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - cdsParSpread.explain(specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - cdsValue: (specification: import('@insiderfinance/totalfinance/fixed-income').CdsSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').CdsCurves) => import('@insiderfinance/totalfinance/fixed-income').CdsValuation; default: not declared — Value a CDS off discount and survival curves (PV to the protection buyer). - cdsValue().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - cdsValue().return.assumptions.conventionsVersion: string; default: not declared - cdsValue().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - cdsValue().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - cdsValue().return.parSpread: number; default: not declared - cdsValue().return.premiumLeg: number; default: not declared - cdsValue().return.protectionLeg: number; default: not declared - cdsValue().return.riskyAnnuity: number; default: not declared — Risky annuity / PV01 basis: Σ τᵢ·DF·Q (+ accrual-on-default), per unit spread × notional. - cdsValue().return.upfront: number; default: not declared — Upfront value as a fraction of notional (protection-buyer sign). - cdsValue().return.value: number; default: not declared — PV to the protection buyer (pays premium, receives default protection). - cdsValue(curves): import('@insiderfinance/totalfinance/fixed-income').CdsCurves; default: not declared - cdsValue(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - cdsValue(curves).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - cdsValue(specification): import('@insiderfinance/totalfinance/fixed-income').CdsSpecification; default: not declared - cdsValue(specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - cdsValue(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - cdsValue(specification).effectiveDate: string; default: not declared - cdsValue(specification).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Premium payment frequency. Default quarterly. - cdsValue(specification).maturityDate: string; default: not declared - cdsValue(specification).notional?: number; default: not declared - cdsValue(specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - cdsValue(specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - cdsValue(specification).spread: number; default: not declared — Running premium (coupon) rate, e.g. 0.01 = 100 bp. - cir: (parameters: import('@insiderfinance/totalfinance/fixed-income').CirParameters) => import('@insiderfinance/totalfinance/fixed-income').CirModel; default: not declared — Construct a CIR model `dr = a(b − r)dt + σ√r dW` (affine, non-negative rates). The Feller condition `2ab ≥ σ²` is what keeps the short rate strictly positive. Parameters that violate it are perfectly ACCEPTABLE — CIR fits to real curves routinely land there, and the affine bond price stays valid — but the model then puts mass at r = 0, which changes what the output means. Violation is therefore disclosed (`model.feller_condition_violated`), never thrown and never silently absorbed. - cir().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings about the calibration (currently: the Feller condition). Always present. - cir().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - cir().return.discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - cir().return.shortRateMoments: (years: number) => import('@insiderfinance/totalfinance/fixed-income').ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - cir().return.zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. - cir(parameters): import('@insiderfinance/totalfinance/fixed-income').CirParameters; default: not declared - cir(parameters).a: number; default: not declared - cir(parameters).b: number; default: not declared - cir(parameters).r0: number; default: not declared - cir(parameters).sigma: number; default: not declared - cmsConvexityAdjustment: (specification: import('@insiderfinance/totalfinance/fixed-income').CmsConvexityInput) => import('@insiderfinance/totalfinance/fixed-income').CmsConvexityResult; default: not declared — The standard CMS convexity adjustment (Hull): valuing the swap-rate payoff with the bond function `G(y) = Σ cᵢ·(1 + y/m)^(−i)` of a par bond paying the swap's fixed cash flows gives `Δ = −½·y₀²·σ²·T·G''(y₀)/G'(y₀)` (positive, since `G' < 0` and `G'' > 0`). Returns a Law-2 envelope: the adjustment in `value` plus the applied conventions and a warnings channel. - cmsConvexityAdjustment().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - cmsConvexityAdjustment().return.assumptions.conventionsVersion: string; default: not declared - cmsConvexityAdjustment().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - cmsConvexityAdjustment().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - cmsConvexityAdjustment().return.value: number; default: not declared — The additive adjustment Δ (rate units): expected CMS rate minus the plain forward swap rate. - cmsConvexityAdjustment(specification): import('@insiderfinance/totalfinance/fixed-income').CmsConvexityInput; default: not declared - cmsConvexityAdjustment(specification).expiry: number; default: not declared — Time to the CMS observation, in years. - cmsConvexityAdjustment(specification).forwardSwapRate: number; default: not declared — Plain forward swap rate `y₀` of the underlying swap. - cmsConvexityAdjustment(specification).paymentsPerYear: number; default: not declared — Fixed-leg payments per year `m` (drives the bond function G(y)). - cmsConvexityAdjustment(specification).swapTenorYears: number; default: not declared — Underlying swap tenor in whole years. - cmsConvexityAdjustment(specification).volatility: number; default: not declared — Lognormal volatility of the underlying swap rate. - compareDates: (first: string, second: string) => number; default: not declared — Compare two ISO dates: negative if `a < b`, 0 if equal, positive if `a > b`. - compareDates(first): string; default: not declared - compareDates(second): string; default: not declared - conversionFactor: (input: import('@insiderfinance/totalfinance/fixed-income').ConversionFactorInput) => import('@insiderfinance/totalfinance/fixed-income').ConversionFactorResult; default: not declared — The CME/CBOT conversion factor for a deliverable bond: the price per $1 face that would make it yield the contract's notional coupon (default 6%) on the first day of the delivery month, with the time to maturity rounded down to whole quarters. Assumes semiannual coupons (Treasury/Gilt convention). See `docs/specs/bond-future-ctd.md`. - conversionFactor().return.assumptions: { conventionsVersion: string; couponFrequency: 'semiannual'; }; default: not declared - conversionFactor().return.assumptions.conventionsVersion: string; default: not declared - conversionFactor().return.assumptions.couponFrequency: 'semiannual'; default: not declared - conversionFactor().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - conversionFactor().return.extraMonths: number; default: not declared — Residual months after rounding, `z ∈ {0, 3, 6, 9}`. - conversionFactor().return.factor: number; default: not declared — Price per $1 face that makes the bond yield the notional coupon on the first delivery day. - conversionFactor().return.notionalCoupon: number; default: not declared - conversionFactor().return.wholeYears: number; default: not declared — Whole years to maturity after rounding down to a quarter (`n`). - conversionFactor(input): import('@insiderfinance/totalfinance/fixed-income').ConversionFactorInput; default: not declared - conversionFactor(input).bond: import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared — The deliverable bond — its (semiannual) coupon and maturity drive the factor. - conversionFactor(input).deliveryDate: string; default: not declared — The conversion factor is computed as of the first day of THIS date's month. - conversionFactor(input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06` (CME Treasury futures). - convertibleBond: (specification: import('@insiderfinance/totalfinance/fixed-income').ConvertibleBondSpecification) => import('@insiderfinance/totalfinance/fixed-income').ConvertibleBondResult; default: not declared — Price a convertible bond on an equity lattice with reduced-form credit (spec §14.1). - convertibleBond().return.assumptions: { conventionsVersion: string; model: 'equity-lattice+reduced-form-credit'; stepsPerYear: number; recovery: number; creditModel: 'survivalCurve' | 'flatHazard' | 'none'; }; default: not declared — Applied conventions and model knobs, echoed (R2). - convertibleBond().return.assumptions.conventionsVersion: string; default: not declared - convertibleBond().return.assumptions.creditModel: 'none' | 'survivalCurve' | 'flatHazard'; default: not declared - convertibleBond().return.assumptions.model: 'equity-lattice+reduced-form-credit'; default: not declared - convertibleBond().return.assumptions.recovery: number; default: not declared - convertibleBond().return.assumptions.stepsPerYear: number; default: not declared - convertibleBond().return.bondFloor: number; default: not declared — Value of the otherwise-identical risky bond with conversion disabled (the bond floor). - convertibleBond().return.conversionValue: number; default: not declared — Current conversion (parity) value `conversionRatio · spot`. - convertibleBond().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Honest computation report (R2). - convertibleBond().return.optionValue: number; default: not declared — Embedded equity-option value: `price − bondFloor`. - convertibleBond().return.price: number; default: not declared — Convertible value. - convertibleBond(specification): import('@insiderfinance/totalfinance/fixed-income').ConvertibleBondSpecification; default: not declared - convertibleBond(specification).calls?: import('@insiderfinance/totalfinance/fixed-income').ConvertibleBondOption[]; default: not declared — Issuer call schedule. - convertibleBond(specification).conversionRatio: number; default: not declared — Shares received per bond on conversion. - convertibleBond(specification).couponRate: number; default: not declared — Annualized coupon rate (0 for a zero-coupon convertible). - convertibleBond(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Coupon accrual day count (default `30/360`). - convertibleBond(specification).dividendYield?: number; default: not declared — Continuous dividend yield on the share (default 0). - convertibleBond(specification).faceValue?: number; default: not declared - convertibleBond(specification).frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - convertibleBond(specification).hazardRate?: number; default: not declared — Flat hazard rate alternative to `survival`. - convertibleBond(specification).issueDate: string; default: not declared - convertibleBond(specification).maturityDate: string; default: not declared - convertibleBond(specification).puts?: import('@insiderfinance/totalfinance/fixed-income').ConvertibleBondOption[]; default: not declared — Holder put schedule. - convertibleBond(specification).recovery?: number; default: not declared — Recovery on default, as a fraction of face (default 0.4). - convertibleBond(specification).riskFreeRate: number; default: not declared — Flat continuously-compounded risk-free rate used for lattice discounting. - convertibleBond(specification).settlementDate?: string; default: not declared — Valuation date (default = issue date). - convertibleBond(specification).spot: number; default: not declared — Current share price. - convertibleBond(specification).stepsPerYear?: number; default: not declared — Lattice steps per year (default 200, hard outer maximum 1,000,000; tree cap may be lower). - convertibleBond(specification).survival?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared — Term-structured hazard (credit) — provide this or `hazardRate`. - convertibleBond(specification).volatility: number; default: not declared — Equity volatility. - cpiSeasonality: (input: import('@insiderfinance/totalfinance/fixed-income').CpiSeasonalityInput) => import('@insiderfinance/totalfinance/fixed-income').CpiSeasonalityResult; default: not declared — Extract 12 multiplicative CPI seasonal factors from an NSA history via the classic ratio-to-centered- 2×12-moving-average, normalized to average 1. See `docs/specs/inflation.md`. - cpiSeasonality().return.assumptions: { conventionsVersion: string; method: 'ratio-to-2x12-moving-average'; }; default: not declared - cpiSeasonality().return.assumptions.conventionsVersion: string; default: not declared - cpiSeasonality().return.assumptions.method: 'ratio-to-2x12-moving-average'; default: not declared - cpiSeasonality().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - cpiSeasonality().return.factors: number[]; default: not declared — 12 multiplicative factors, index 0 = January … 11 = December; they average to 1. - cpiSeasonality().return.monthsUsed: number; default: not declared — Number of month observations that fed the estimate (ratios computed). - cpiSeasonality().return.peakMonth: number; default: not declared — Calendar month (1-12) with the largest factor. - cpiSeasonality().return.troughMonth: number; default: not declared — Calendar month (1-12) with the smallest factor. - cpiSeasonality().return.yearsSpanned: number; default: not declared — Calendar years the history spans. - cpiSeasonality(input): import('@insiderfinance/totalfinance/fixed-income').CpiSeasonalityInput; default: not declared - cpiSeasonality(input).series: { month: string; level: number; }[]; default: not declared — NSA CPI history: `{ month: 'YYYY-MM', level }`; ≥ 24 contiguous months (order-independent). - credit: { survivalFromHazards: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurveOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; survivalFromProbabilities: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurveOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; flatHazard: (input: import('@insiderfinance/totalfinance/fixed-income/credit').FlatHazardInput) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; bootstrapHazardFromCds: (quotes: import('@insiderfinance/totalfinance/fixed-income').CdsQuote[], options: import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; creditSpreadCurve: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveFacade; creditTriangleHazard: (input: import('@insiderfinance/totalfinance/fixed-income/credit').CreditTriangleHazardInput) => import('@insiderfinance/totalfinance/fixed-income').CreditTriangleHazardResult; cdsBasis: (input: import('@insiderfinance/totalfinance/fixed-income/credit').CdsBasisInput) => number; }; default: not declared — Survival-curve constructors and credit analytics (spec §14.4). - credit.bootstrapHazardFromCds: (quotes: import('@insiderfinance/totalfinance/fixed-income').CdsQuote[], options: import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - credit.bootstrapHazardFromCds().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - credit.bootstrapHazardFromCds().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.bootstrapHazardFromCds().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - credit.bootstrapHazardFromCds().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - credit.bootstrapHazardFromCds().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - credit.bootstrapHazardFromCds().return.referenceDate: string; default: not declared - credit.bootstrapHazardFromCds().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - credit.bootstrapHazardFromCds().return.timeTo: (at: string | number) => number; default: not declared - credit.bootstrapHazardFromCds(options): import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions; default: not declared - credit.bootstrapHazardFromCds(options).accrualOnDefault?: boolean; default: not declared - credit.bootstrapHazardFromCds(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.bootstrapHazardFromCds(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - credit.bootstrapHazardFromCds(options).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - credit.bootstrapHazardFromCds(options).protectionSteps?: number; default: not declared - credit.bootstrapHazardFromCds(options).recovery?: number; default: not declared - credit.bootstrapHazardFromCds(options).referenceDate: string; default: not declared - credit.bootstrapHazardFromCds(quotes): import('@insiderfinance/totalfinance/fixed-income').CdsQuote[]; default: not declared - credit.cdsBasis: (input: import('@insiderfinance/totalfinance/fixed-income/credit').CdsBasisInput) => number; default: not declared - credit.cdsBasis(input): import('@insiderfinance/totalfinance/fixed-income/credit').CdsBasisInput; default: not declared - credit.cdsBasis(input).bondImpliedSpread: number; default: not declared - credit.cdsBasis(input).cdsParSpread: number; default: not declared - credit.creditSpreadCurve: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveFacade; default: not declared - credit.creditSpreadCurve(options): import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions & { survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; }; default: not declared - credit.creditSpreadCurve(options).accrualOnDefault?: boolean; default: not declared - credit.creditSpreadCurve(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.creditSpreadCurve(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - credit.creditSpreadCurve(options).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - credit.creditSpreadCurve(options).protectionSteps?: number; default: not declared - credit.creditSpreadCurve(options).recovery?: number; default: not declared - credit.creditSpreadCurve(options).referenceDate: string; default: not declared - credit.creditSpreadCurve(options).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - credit.creditSpreadCurve(tenors): string[]; default: not declared - credit.creditSpreadCurve.explain: (tenors: string[], options: import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions & { survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; }) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveAssumptions; }; default: not declared - credit.creditSpreadCurve.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveAssumptions; default: not declared - credit.creditSpreadCurve.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - credit.creditSpreadCurve.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - credit.creditSpreadCurve.explain().return.value: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - credit.creditSpreadCurve.explain(options): import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions & { survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; }; default: not declared - credit.creditSpreadCurve.explain(options).accrualOnDefault?: boolean; default: not declared - credit.creditSpreadCurve.explain(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.creditSpreadCurve.explain(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - credit.creditSpreadCurve.explain(options).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - credit.creditSpreadCurve.explain(options).protectionSteps?: number; default: not declared - credit.creditSpreadCurve.explain(options).recovery?: number; default: not declared - credit.creditSpreadCurve.explain(options).referenceDate: string; default: not declared - credit.creditSpreadCurve.explain(options).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - credit.creditSpreadCurve.explain(tenors): string[]; default: not declared - credit.creditTriangleHazard: (input: import('@insiderfinance/totalfinance/fixed-income/credit').CreditTriangleHazardInput) => import('@insiderfinance/totalfinance/fixed-income').CreditTriangleHazardResult; default: not declared - credit.creditTriangleHazard().return.assumptions: { conventionsVersion: string; recovery: number; approximation: 'continuous-premium credit triangle'; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - credit.creditTriangleHazard().return.assumptions.approximation: 'continuous-premium credit triangle'; default: not declared - credit.creditTriangleHazard().return.assumptions.conventionsVersion: string; default: not declared - credit.creditTriangleHazard().return.assumptions.recovery: number; default: not declared - credit.creditTriangleHazard().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - credit.creditTriangleHazard().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - credit.creditTriangleHazard().return.value: number; default: not declared — Implied flat hazard rate λ (per year). - credit.creditTriangleHazard(input): import('@insiderfinance/totalfinance/fixed-income/credit').CreditTriangleHazardInput; default: not declared - credit.creditTriangleHazard(input).recovery?: number; default: not declared - credit.creditTriangleHazard(input).spread: number; default: not declared - credit.flatHazard: (input: import('@insiderfinance/totalfinance/fixed-income/credit').FlatHazardInput) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - credit.flatHazard().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - credit.flatHazard().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.flatHazard().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - credit.flatHazard().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - credit.flatHazard().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - credit.flatHazard().return.referenceDate: string; default: not declared - credit.flatHazard().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - credit.flatHazard().return.timeTo: (at: string | number) => number; default: not declared - credit.flatHazard(input): import('@insiderfinance/totalfinance/fixed-income/credit').FlatHazardInput; default: not declared - credit.flatHazard(input).hazardRate: number; default: not declared - credit.flatHazard(input).options?: Omit; default: not declared - credit.flatHazard(input).options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - credit.flatHazard(input).referenceDate: string; default: not declared - credit.survivalFromHazards: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurveOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - credit.survivalFromHazards().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - credit.survivalFromHazards().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.survivalFromHazards().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - credit.survivalFromHazards().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - credit.survivalFromHazards().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - credit.survivalFromHazards().return.referenceDate: string; default: not declared - credit.survivalFromHazards().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - credit.survivalFromHazards().return.timeTo: (at: string | number) => number; default: not declared - credit.survivalFromHazards(options)?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurveOptions; default: not declared - credit.survivalFromHazards(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - credit.survivalFromHazards(options).referenceDate?: string; default: not declared — Reference date (t = 0, where Q = 1). Default: the first pillar date. - credit.survivalFromHazards(points): readonly (readonly [string, number])[]; default: not declared - credit.survivalFromProbabilities: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurveOptions) => import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - credit.survivalFromProbabilities().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - credit.survivalFromProbabilities().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - credit.survivalFromProbabilities().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - credit.survivalFromProbabilities().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - credit.survivalFromProbabilities().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - credit.survivalFromProbabilities().return.referenceDate: string; default: not declared - credit.survivalFromProbabilities().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - credit.survivalFromProbabilities().return.timeTo: (at: string | number) => number; default: not declared - credit.survivalFromProbabilities(options)?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurveOptions; default: not declared - credit.survivalFromProbabilities(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - credit.survivalFromProbabilities(options).referenceDate?: string; default: not declared — Reference date (t = 0, where Q = 1). Default: the first pillar date. - credit.survivalFromProbabilities(points): readonly (readonly [string, number])[]; default: not declared - creditSpreadCurve: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveFacade; default: not declared — Par CDS spreads at each tenor off the survival/discount curves. Facade (H03): the plain call returns the points; `.explain()` echoes every convention the per-tenor CDS actually ran on — the wave that landed the propagation fix proved `accrualOnDefault`/`protectionSteps` are MATERIAL (the round trip missed its own quotes by ~0.24bp when they were dropped). - creditSpreadCurve(options): import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions & { survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; }; default: not declared - creditSpreadCurve(options).accrualOnDefault?: boolean; default: not declared - creditSpreadCurve(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - creditSpreadCurve(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - creditSpreadCurve(options).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - creditSpreadCurve(options).protectionSteps?: number; default: not declared - creditSpreadCurve(options).recovery?: number; default: not declared - creditSpreadCurve(options).referenceDate: string; default: not declared - creditSpreadCurve(options).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - creditSpreadCurve(tenors): string[]; default: not declared - creditSpreadCurve.explain: (tenors: string[], options: import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions & { survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; }) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveAssumptions; }; default: not declared - creditSpreadCurve.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadCurveAssumptions; default: not declared - creditSpreadCurve.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - creditSpreadCurve.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - creditSpreadCurve.explain().return.value: import('@insiderfinance/totalfinance/fixed-income').CreditSpreadPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - creditSpreadCurve.explain(options): import('@insiderfinance/totalfinance/fixed-income').HazardBootstrapOptions & { survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; }; default: not declared - creditSpreadCurve.explain(options).accrualOnDefault?: boolean; default: not declared - creditSpreadCurve.explain(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - creditSpreadCurve.explain(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - creditSpreadCurve.explain(options).frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - creditSpreadCurve.explain(options).protectionSteps?: number; default: not declared - creditSpreadCurve.explain(options).recovery?: number; default: not declared - creditSpreadCurve.explain(options).referenceDate: string; default: not declared - creditSpreadCurve.explain(options).survivalCurve: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared - creditSpreadCurve.explain(tenors): string[]; default: not declared - creditTriangleHazard: (input: import('@insiderfinance/totalfinance/fixed-income/credit').CreditTriangleHazardInput) => import('@insiderfinance/totalfinance/fixed-income').CreditTriangleHazardResult; default: not declared - creditTriangleHazard().return.assumptions: { conventionsVersion: string; recovery: number; approximation: 'continuous-premium credit triangle'; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - creditTriangleHazard().return.assumptions.approximation: 'continuous-premium credit triangle'; default: not declared - creditTriangleHazard().return.assumptions.conventionsVersion: string; default: not declared - creditTriangleHazard().return.assumptions.recovery: number; default: not declared - creditTriangleHazard().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - creditTriangleHazard().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - creditTriangleHazard().return.value: number; default: not declared — Implied flat hazard rate λ (per year). - creditTriangleHazard(input): import('@insiderfinance/totalfinance/fixed-income/credit').CreditTriangleHazardInput; default: not declared - creditTriangleHazard(input).recovery?: number; default: not declared - creditTriangleHazard(input).spread: number; default: not declared - crossCurrencyBasisCurve: (input: import('@insiderfinance/totalfinance/fixed-income').CrossCurrencyBasisInput) => import('@insiderfinance/totalfinance/fixed-income').CrossCurrencyBasisResult; default: not declared — Build the domestic-collateralized foreign discount curve (spec §14.5): the foreign OIS curve plus the cross-currency basis, `D_for^dom = foreign.addSpread(basis)`. This is the curve on which to discount foreign cash flows collateralized in the domestic currency, and it reprices the FX forwards the xccy basis market quotes: `F(0,t) = spot · D_for^dom(t) / D_dom(t)`. - crossCurrencyBasisCurve().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - crossCurrencyBasisCurve().return.assumptions.conventionsVersion: string; default: not declared - crossCurrencyBasisCurve().return.collateralizedCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — The domestic-collateralized foreign discount curve (`foreign + basis`). Discount foreign cash flows on THIS. - crossCurrencyBasisCurve().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - crossCurrencyBasisCurve().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - crossCurrencyBasisCurve().return.fxForward: (at: string | number) => number; default: not declared — Market FX forward at `at`, from the collateralized curve: `spot · D_for^dom(at) / D_dom(at)`. - crossCurrencyBasisCurve(input): import('@insiderfinance/totalfinance/fixed-income').CrossCurrencyBasisInput; default: not declared - crossCurrencyBasisCurve(input).basis?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Cross-currency basis term structure added to the foreign curve (its zero rates ARE the basis spreads). Omit for the pure covered-interest-parity case (no basis): `fxForward` is then `spot · D_for(t)/D_dom(t)` and the collateralized curve is the foreign curve itself. - crossCurrencyBasisCurve(input).domestic: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Domestic collateral (OIS) discount curve. - crossCurrencyBasisCurve(input).foreign: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Foreign index/OIS discount curve (pre-basis). - crossCurrencyBasisCurve(input).spot: number; default: not declared — FX spot: domestic units per 1 foreign unit. - curveMetrics: import('@insiderfinance/totalfinance/fixed-income').BondFacade<[bond: import('@insiderfinance/totalfinance/fixed-income').Bond, curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, options: import('@insiderfinance/totalfinance/fixed-income').CurvePricingOptions], import('@insiderfinance/totalfinance/fixed-income').CurveMetrics, import('@insiderfinance/totalfinance/fixed-income').CurveMetrics>; default: not declared — Price a bond against a discount curve and report effective/key-rate risk from curve shocks. Facade (dx §2.7): the plain call returns the rich {@link CurveMetrics}; `.explain()` wraps the same result in the core envelope with the conventions echoed at the top level. - curveMetrics().return.accruedInterest: number; default: not declared - curveMetrics().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - curveMetrics().return.cleanPrice: number; default: not declared - curveMetrics().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - curveMetrics().return.dirtyPrice: number; default: not declared - curveMetrics().return.dv01: number; default: not declared — Dollar value of a 1bp parallel curve shift (per face). - curveMetrics().return.effectiveConvexity: number; default: not declared — Effective convexity from a parallel curve shock. - curveMetrics().return.effectiveDuration: number; default: not declared — Effective duration from a parallel curve shock. - curveMetrics().return.keyRateDurations: { tenorYears: number; date: string; duration: number; }[]; default: not declared — Per-pillar key-rate durations, aligned to the curve's pillars. - curveMetrics(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, options: import('@insiderfinance/totalfinance/fixed-income').CurvePricingOptions]; default: not declared - curveMetrics.explain: (bond: import('@insiderfinance/totalfinance/fixed-income').Bond, curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, options: import('@insiderfinance/totalfinance/fixed-income').CurvePricingOptions) => import('@insiderfinance/totalfinance/fixed-income').BondComputed; default: not declared - curveMetrics.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - curveMetrics.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - curveMetrics.explain().return.value: import('@insiderfinance/totalfinance/fixed-income').CurveMetrics; default: not declared - curveMetrics.explain(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, options: import('@insiderfinance/totalfinance/fixed-income').CurvePricingOptions]; default: not declared - curves: { fromZeroRates: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; fromDiscountFactors: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; flat: (input: import('@insiderfinance/totalfinance/fixed-income/curves').FlatCurveInput) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; bootstrap: (instruments: import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[], options: import('@insiderfinance/totalfinance/fixed-income').BootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; bootstrapProjection: (instruments: import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[], options: import('@insiderfinance/totalfinance/fixed-income').ProjectionBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; bootstrapMultiCurve: (options: import('@insiderfinance/totalfinance/fixed-income').MultiCurveBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').MultiCurve; discountFactor: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; }; default: not declared — Curve constructors (spec §14.2). Every builder returns an immutable {@link YieldCurve} whose discount factors, zero rates, and forwards are mutually consistent. - curves.bootstrap: (instruments: import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[], options: import('@insiderfinance/totalfinance/fixed-income').BootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - curves.bootstrap().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curves.bootstrap().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curves.bootstrap().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - curves.bootstrap().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curves.bootstrap().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.bootstrap().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curves.bootstrap().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curves.bootstrap().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.bootstrap().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curves.bootstrap().return.referenceDate: string; default: not declared - curves.bootstrap().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curves.bootstrap().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curves.bootstrap().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curves.bootstrap(instruments): import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[]; default: not declared - curves.bootstrap(options): import('@insiderfinance/totalfinance/fixed-income').BootstrapOptions; default: not declared - curves.bootstrap(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - curves.bootstrap(options).extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.bootstrap(options).interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.bootstrap(options).referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - curves.bootstrapMultiCurve: (options: import('@insiderfinance/totalfinance/fixed-income').MultiCurveBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').MultiCurve; default: not declared — One-call dual-curve set: OIS discount + index projection → `{ discountCurve, forecastCurve }`. - curves.bootstrapMultiCurve().return.discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - curves.bootstrapMultiCurve().return.forecastCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - curves.bootstrapMultiCurve(options): import('@insiderfinance/totalfinance/fixed-income').MultiCurveBootstrapOptions; default: not declared - curves.bootstrapMultiCurve(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - curves.bootstrapMultiCurve(options).extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.bootstrapMultiCurve(options).interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.bootstrapMultiCurve(options).ois: import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[]; default: not declared — Instruments defining the OIS discount curve (self-discounting). - curves.bootstrapMultiCurve(options).projection: import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[]; default: not declared — Instruments defining the index projection curve (discounted on the OIS curve). - curves.bootstrapMultiCurve(options).referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - curves.bootstrapProjection: (instruments: import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[], options: import('@insiderfinance/totalfinance/fixed-income').ProjectionBootstrapOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Dual-curve (OIS-discounted) projection-curve bootstrap. - curves.bootstrapProjection().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curves.bootstrapProjection().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curves.bootstrapProjection().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - curves.bootstrapProjection().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curves.bootstrapProjection().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.bootstrapProjection().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curves.bootstrapProjection().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curves.bootstrapProjection().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.bootstrapProjection().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curves.bootstrapProjection().return.referenceDate: string; default: not declared - curves.bootstrapProjection().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curves.bootstrapProjection().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curves.bootstrapProjection().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curves.bootstrapProjection(instruments): import('@insiderfinance/totalfinance/fixed-income').BootstrapInstrument[]; default: not declared - curves.bootstrapProjection(options): import('@insiderfinance/totalfinance/fixed-income').ProjectionBootstrapOptions; default: not declared - curves.bootstrapProjection(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - curves.bootstrapProjection(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — The (OIS) discount curve. Each par swap discounts its legs on THIS curve while its floating forwards project off the curve being built — the post-2008 dual-curve convention. Build it first with {@link bootstrap} (self-discounting OIS), then pass it here. - curves.bootstrapProjection(options).extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.bootstrapProjection(options).interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.bootstrapProjection(options).referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - curves.discountFactor: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Build a curve from discount-factor pillars. - curves.discountFactor().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curves.discountFactor().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curves.discountFactor().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - curves.discountFactor().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curves.discountFactor().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.discountFactor().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curves.discountFactor().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curves.discountFactor().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.discountFactor().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curves.discountFactor().return.referenceDate: string; default: not declared - curves.discountFactor().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curves.discountFactor().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curves.discountFactor().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curves.discountFactor(options)?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions; default: not declared - curves.discountFactor(options).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - curves.discountFactor(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - curves.discountFactor(options).extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.discountFactor(options).interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.discountFactor(options).referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. - curves.discountFactor(points): readonly (readonly [string, number])[]; default: not declared - curves.flat: (input: import('@insiderfinance/totalfinance/fixed-income/curves').FlatCurveInput) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - curves.flat().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curves.flat().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curves.flat().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - curves.flat().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curves.flat().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.flat().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curves.flat().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curves.flat().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.flat().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curves.flat().return.referenceDate: string; default: not declared - curves.flat().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curves.flat().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curves.flat().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curves.flat(input): import('@insiderfinance/totalfinance/fixed-income/curves').FlatCurveInput; default: not declared - curves.flat(input).options?: Omit; default: not declared - curves.flat(input).options.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - curves.flat(input).options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - curves.flat(input).options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.flat(input).options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.flat(input).rate: number; default: not declared - curves.flat(input).referenceDate: string; default: not declared - curves.fromDiscountFactors: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - curves.fromDiscountFactors().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curves.fromDiscountFactors().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curves.fromDiscountFactors().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - curves.fromDiscountFactors().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curves.fromDiscountFactors().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.fromDiscountFactors().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curves.fromDiscountFactors().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curves.fromDiscountFactors().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.fromDiscountFactors().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curves.fromDiscountFactors().return.referenceDate: string; default: not declared - curves.fromDiscountFactors().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curves.fromDiscountFactors().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curves.fromDiscountFactors().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curves.fromDiscountFactors(options)?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions; default: not declared - curves.fromDiscountFactors(options).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - curves.fromDiscountFactors(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - curves.fromDiscountFactors(options).extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.fromDiscountFactors(options).interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.fromDiscountFactors(options).referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. - curves.fromDiscountFactors(points): readonly (readonly [string, number])[]; default: not declared - curves.fromZeroRates: (points: ReadonlyArray, options?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - curves.fromZeroRates().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curves.fromZeroRates().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curves.fromZeroRates().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - curves.fromZeroRates().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curves.fromZeroRates().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.fromZeroRates().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curves.fromZeroRates().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curves.fromZeroRates().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.fromZeroRates().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curves.fromZeroRates().return.referenceDate: string; default: not declared - curves.fromZeroRates().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curves.fromZeroRates().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curves.fromZeroRates().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curves.fromZeroRates(options)?: import('@insiderfinance/totalfinance/fixed-income').CurveOptions; default: not declared - curves.fromZeroRates(options).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - curves.fromZeroRates(options).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - curves.fromZeroRates(options).extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curves.fromZeroRates(options).interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curves.fromZeroRates(options).referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. - curves.fromZeroRates(points): readonly (readonly [string, number])[]; default: not declared - daysInMonth: (year: number, month: number) => number; default: not declared — Days in a given month (`month` is 1-12). - daysInMonth(month): number; default: not declared - daysInMonth(year): number; default: not declared - daysInYear: (year: number) => number; default: not declared — Days in a Gregorian year (365 or 366). - daysInYear(year): number; default: not declared - discountFromZero: (zero: number, years: number, compounding: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Discount factor implied by a zero rate quoted in `compounding` over time `t`. - discountFromZero(compounding): import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - discountFromZero(compounding).periodsPerYear: number; default: not declared - discountFromZero(compounding).type: 'periodic'; default: not declared - discountFromZero(years): number; default: not declared - discountFromZero(zero): number; default: not declared - forwardCmsRate: (specification: import('@insiderfinance/totalfinance/fixed-income').CmsSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').SwapCurves) => import('@insiderfinance/totalfinance/fixed-income').CmsResult; default: not declared — Forward CMS rate off a curve: the forward swap rate of the underlying constant-maturity swap plus the convexity adjustment. Discount the resulting rate on the relevant payment date to value a CMS leg. - forwardCmsRate().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - forwardCmsRate().return.assumptions.conventionsVersion: string; default: not declared - forwardCmsRate().return.cmsRate: number; default: not declared — Convexity-adjusted expected CMS rate `forwardSwapRate + convexityAdjustment`. - forwardCmsRate().return.convexityAdjustment: number; default: not declared — Convexity adjustment added because the swap rate is not a martingale under its payment measure. - forwardCmsRate().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - forwardCmsRate().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - forwardCmsRate().return.forwardSwapRate: number; default: not declared — Plain forward swap rate of the underlying CMS swap. - forwardCmsRate(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - forwardCmsRate(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - forwardCmsRate(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - forwardCmsRate(specification): import('@insiderfinance/totalfinance/fixed-income').CmsSpecification; default: not declared - forwardCmsRate(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - forwardCmsRate(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Underlying swap fixed-leg frequency (drives the convexity G(y); default semiannual). - forwardCmsRate(specification).floatDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - forwardCmsRate(specification).floatFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - forwardCmsRate(specification).resetDate: string; default: not declared — When the CMS rate is observed (the underlying swap's start). - forwardCmsRate(specification).swapTenorYears: number; default: not declared — Underlying swap tenor in whole years (e.g. 10 for a 10y CMS). - forwardCmsRate(specification).volatility: number; default: not declared — Lognormal volatility of the underlying swap rate. - forwardSwap: (specification: import('@insiderfinance/totalfinance/fixed-income').ForwardSwapSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').SwapCurves) => import('@insiderfinance/totalfinance/fixed-income').ForwardSwapResult; default: not declared — The curve-driven forward swap rate and annuity of a (possibly forward-starting) swap — the two curve inputs a swaption needs, in one call. For a swaption struck at `K` expiring at `startDate`, the price is `annuity · Black(forwardSwapRate, K, σ, T)` (Bachelier for normal σ). Pair this with a vol from `@insiderfinance/totalfinance/volatility`'s swaption cube (`swaptionCubeVolatility`) for a fully curve-consistent swaption price, so the forward and annuity come from the live (OIS/projection) curves rather than stale market nodes. - forwardSwap().return.annuity: number; default: not declared — Fixed-leg annuity `Σ τ·DF(payDate)` (the level / PV of a unit annuity). - forwardSwap().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - forwardSwap().return.assumptions.conventionsVersion: string; default: not declared - forwardSwap().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - forwardSwap().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - forwardSwap().return.forwardSwapRate: number; default: not declared — Par (forward) swap rate `S = floatLegPv / annuity` — a swaption's natural forward under the annuity measure. - forwardSwap().return.pv01: number; default: not declared — PV of a 1bp fixed-rate change (`notional · annuity · 1e-4`). - forwardSwap(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - forwardSwap(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - forwardSwap(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - forwardSwap(specification): import('@insiderfinance/totalfinance/fixed-income').ForwardSwapSpecification; default: not declared - forwardSwap(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - forwardSwap(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Fixed-leg frequency (default semiannual). - forwardSwap(specification).floatDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - forwardSwap(specification).floatFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Floating-leg frequency (default quarterly). - forwardSwap(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - forwardSwap(specification).maturityDate: string; default: not declared - forwardSwap(specification).notional?: number; default: not declared - forwardSwap(specification).startDate: string; default: not declared - fraValue: (specification: import('@insiderfinance/totalfinance/fixed-income').FraSpecification, options: { curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; }) => import('@insiderfinance/totalfinance/fixed-income').FraResult; default: not declared - fraValue().return.accrual: number; default: not declared - fraValue().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - fraValue().return.assumptions.conventionsVersion: string; default: not declared - fraValue().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - fraValue().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - fraValue().return.discountFactor: number; default: not declared - fraValue().return.forwardRate: number; default: not declared - fraValue().return.value: number; default: not declared — PV to the fixed-rate payer (receives floating). - fraValue(options): { curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; }; default: not declared - fraValue(options).curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - fraValue(specification): import('@insiderfinance/totalfinance/fixed-income').FraSpecification; default: not declared - fraValue(specification).dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Default `ACT/360`. - fraValue(specification).end: string; default: not declared - fraValue(specification).fixedRate: number; default: not declared — Contract (fixed) rate the buyer pays. - fraValue(specification).notional?: number; default: not declared - fraValue(specification).start: string; default: not declared - g2pp: (curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, parameters: import('@insiderfinance/totalfinance/fixed-income').G2ppParameters) => import('@insiderfinance/totalfinance/fixed-income').G2ppModel; default: not declared — G2++ (two-additive-factor Gaussian) short-rate model `r(t) = φ(t) + x(t) + y(t)` with correlated Ornstein-Uhlenbeck factors, fit to the initial `curve` (Brigo–Mercurio). Two factors give a richer, de-correlating term structure of volatility than one-factor Hull-White, while keeping analytic discount bonds and (Gaussian) zero-coupon-bond options. Reduces to Hull-White when `eta = 0`. - g2pp().return.caplet: (input: import('@insiderfinance/totalfinance/fixed-income/models').RateOptionletInput) => number; default: not declared - g2pp().return.discountBond: (input: import('@insiderfinance/totalfinance/fixed-income/models').G2ppDiscountBondInput) => number; default: not declared — Reconstructed discount bond `P(t,T)` given factor values `(x, y)` at `t` (default 0 ⇒ the curve). - g2pp().return.floorlet: (input: import('@insiderfinance/totalfinance/fixed-income/models').RateOptionletInput) => number; default: not declared - g2pp().return.shortRateVariance: (years: number) => number; default: not declared — Variance of the short rate at horizonYears `t`. - g2pp().return.zeroCouponBondOption: (input: import('@insiderfinance/totalfinance/fixed-income/models').ZeroCouponBondOptionInput) => number; default: not declared — Analytic zero-coupon-bond option as of t = 0 (Gaussian, like Hull-White but with the G2++ variance). - g2pp(curve): import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - g2pp(curve).addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - g2pp(curve).bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - g2pp(curve).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - g2pp(curve).discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - g2pp(curve).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - g2pp(curve).forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - g2pp(curve).instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - g2pp(curve).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - g2pp(curve).pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - g2pp(curve).referenceDate: string; default: not declared - g2pp(curve).shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - g2pp(curve).timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - g2pp(curve).zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - g2pp(parameters): import('@insiderfinance/totalfinance/fixed-income').G2ppParameters; default: not declared - g2pp(parameters).a: number; default: not declared — Mean reversion of factor x. - g2pp(parameters).b: number; default: not declared — Mean reversion of factor y. - g2pp(parameters).eta: number; default: not declared — Volatility of factor y. - g2pp(parameters).rho: number; default: not declared — Instantaneous correlation of the two factors, in [-1, 1]. - g2pp(parameters).sigma: number; default: not declared — Volatility of factor x. - generateSchedule: (options: import('@insiderfinance/totalfinance/fixed-income').ScheduleOptions) => import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared — Generate a coupon schedule by rolling backward from maturity at the coupon interval — the market default, which places any irregular ("stub") period at the front. Accrual boundaries are the regular unadjusted dates (so coupon amounts use the true period length); payment dates are business-day-adjusted and optionally lagged. - generateSchedule(options): import('@insiderfinance/totalfinance/fixed-income').ScheduleOptions; default: not declared - generateSchedule(options).calendar?: import('@insiderfinance/totalfinance/core').Calendar; default: not declared — Calendar deciding business days (default weekends-only). - generateSchedule(options).convention?: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day roll applied to payment dates (default `modifiedFollowing`). - generateSchedule(options).effectiveDate: string; default: not declared — First accrual date (dated/effective date). - generateSchedule(options).endOfMonth?: boolean; default: not declared — Force month-end rolling; defaults to auto-detect from whether `maturityDate` is a month end. - generateSchedule(options).frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - generateSchedule(options).maturityDate: string; default: not declared — Final accrual date (maturity). - generateSchedule(options).paymentLagDays?: number; default: not declared — Business days between a period's accrual end and its payment (settlement lag). Default 0. - hullWhite: (curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, parameters: import('@insiderfinance/totalfinance/fixed-income').HullWhiteParameters) => import('@insiderfinance/totalfinance/fixed-income').HullWhiteModel; default: not declared — Construct a Hull-White model `dr = (θ(t) − a·r)dt + σ dW`, with θ implied by `curve`. - hullWhite().return.caplet: (input: import('@insiderfinance/totalfinance/fixed-income/models').RateOptionletInput) => number; default: not declared - hullWhite().return.discountBond: (input: import('@insiderfinance/totalfinance/fixed-income/models').HullWhiteDiscountBondInput) => number; default: not declared — Reconstructed discount bond `P(t,T)` consistent with the initial curve, given short rate `r` at t. - hullWhite().return.floorlet: (input: import('@insiderfinance/totalfinance/fixed-income/models').RateOptionletInput) => number; default: not declared - hullWhite().return.shortRateStandardDeviation: (years: number) => number; default: not declared — Standard deviation of the short rate at horizonYears `t`. - hullWhite().return.zeroCouponBondOption: (input: import('@insiderfinance/totalfinance/fixed-income/models').ZeroCouponBondOptionInput) => number; default: not declared — Analytic ZCB option as of t = 0 (uses the market curve directly). - hullWhite(curve): import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - hullWhite(curve).addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - hullWhite(curve).bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - hullWhite(curve).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hullWhite(curve).discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - hullWhite(curve).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - hullWhite(curve).forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - hullWhite(curve).instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - hullWhite(curve).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - hullWhite(curve).pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - hullWhite(curve).referenceDate: string; default: not declared - hullWhite(curve).shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - hullWhite(curve).timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - hullWhite(curve).zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - hullWhite(parameters): import('@insiderfinance/totalfinance/fixed-income').HullWhiteParameters; default: not declared - hullWhite(parameters).a: number; default: not declared - hullWhite(parameters).sigma: number; default: not declared - impliedCrossCurrencyBasis: (input: import('@insiderfinance/totalfinance/fixed-income').ImpliedCrossCurrencyBasisInput) => import('@insiderfinance/totalfinance/fixed-income').ImpliedCrossCurrencyBasisResult; default: not declared — Invert market FX forwards to the cross-currency basis (spec §14.5) — the inverse of {@link crossCurrencyBasisCurve}. From `F(0,t) = spot · D_for^dom(t)/D_dom(t)`, the collateralized foreign discount factor is `D_for^dom(t) = F(0,t)·D_dom(t)/spot`, and the implied basis is its continuous zero minus the foreign curve's own zero. - impliedCrossCurrencyBasis().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - impliedCrossCurrencyBasis().return.assumptions.conventionsVersion: string; default: not declared - impliedCrossCurrencyBasis().return.basis: { date: string; spread: number; }[]; default: not declared — Implied continuous cross-currency basis spread at each forward date (collateralized zero − foreign zero). - impliedCrossCurrencyBasis().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - impliedCrossCurrencyBasis().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - impliedCrossCurrencyBasis(input): import('@insiderfinance/totalfinance/fixed-income').ImpliedCrossCurrencyBasisInput; default: not declared - impliedCrossCurrencyBasis(input).domestic: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Domestic collateral (OIS) discount curve. - impliedCrossCurrencyBasis(input).foreign: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Foreign index/OIS discount curve (pre-basis). - impliedCrossCurrencyBasis(input).forwards: [string, number][]; default: not declared — Observed market FX forwards `[date, forward]` (domestic per foreign). - impliedCrossCurrencyBasis(input).spot: number; default: not declared — FX spot: domestic units per 1 foreign unit. - isEndOfMonth: (date: string) => boolean; default: not declared — Whether an ISO date is the last calendar day of its month. - isEndOfMonth(date): string; default: not declared - isLeapYear: (year: number) => boolean; default: not declared — Gregorian leap-year test. - isLeapYear(year): number; default: not declared - oasAnalytics: (specification: import('@insiderfinance/totalfinance/fixed-income').OasAnalyticsSpecification) => import('@insiderfinance/totalfinance/fixed-income').OasAnalyticsResult; default: not declared — Market-calibrated option-adjusted-spread analytics for a callable/putable bond: the OAS, the Z-spread, their difference (the embedded-**option cost**), and the **OAS-consistent** effective duration and convexity (the curve shocked with the spread held fixed). Composes the same short-rate lattice as {@link callableBond}. See `docs/specs/oas-analytics.md`. - oasAnalytics().return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; settlementDate: string; model: import('@insiderfinance/totalfinance/fixed-income').TreeModel; stepsPerYear: number; meanReversion: number; sigma: number; }; default: not declared - oasAnalytics().return.assumptions.conventionsVersion: string; default: not declared - oasAnalytics().return.assumptions.dayCount: 'ACT/365F'; default: not declared - oasAnalytics().return.assumptions.meanReversion: number; default: not declared - oasAnalytics().return.assumptions.model: import('@insiderfinance/totalfinance/fixed-income').TreeModel; default: not declared - oasAnalytics().return.assumptions.settlementDate: string; default: not declared - oasAnalytics().return.assumptions.sigma: number; default: not declared - oasAnalytics().return.assumptions.stepsPerYear: number; default: not declared - oasAnalytics().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - oasAnalytics().return.effectiveConvexity: number; default: not declared — OAS-consistent effective convexity. - oasAnalytics().return.effectiveDuration: number; default: not declared — OAS-consistent effective duration (curve shocked ±`durationShock` at constant OAS). - oasAnalytics().return.marketPrice: number; default: not declared - oasAnalytics().return.modelPrice: number; default: not declared — The no-spread lattice model price (the gap `marketPrice − modelPrice` is what the OAS explains). - oasAnalytics().return.oas: number; default: not declared — Parallel curve shift repricing the callable model to `marketPrice` (decimal; ×1e4 = bps). - oasAnalytics().return.optionCost: number; default: not declared — `zSpread − oas` (decimal) — the embedded-option cost. Positive callable / negative putable. - oasAnalytics().return.zSpread: number; default: not declared — Zero-volatility spread on the same lattice's straight leg (decimal). - oasAnalytics(specification): import('@insiderfinance/totalfinance/fixed-income').OasAnalyticsSpecification; default: not declared - oasAnalytics(specification).bond: import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - oasAnalytics(specification).calls?: import('@insiderfinance/totalfinance/fixed-income').BondOption[]; default: not declared — Issuer call schedule (caps the bond's value at each strike). - oasAnalytics(specification).curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Calibration/discount curve (its reference date is the valuation date). - oasAnalytics(specification).durationShock?: number; default: not declared — Curve shock for the effective duration/convexity, in decimal. Default 1e-4 (1 bp). - oasAnalytics(specification).marketPrice: number; default: not declared — Market dirty price the OAS and Z-spread are solved to. - oasAnalytics(specification).meanReversion: number; default: not declared — Mean reversion and short-rate volatility for the tree model. - oasAnalytics(specification).model?: import('@insiderfinance/totalfinance/fixed-income').TreeModel; default: not declared — Tree model (default `hull-white`). - oasAnalytics(specification).puts?: import('@insiderfinance/totalfinance/fixed-income').BondOption[]; default: not declared — Holder put schedule (floors the bond's value at each strike). - oasAnalytics(specification).sigma: number; default: not declared - oasAnalytics(specification).spreadCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Optional term-structure spread curve added to `curve` before the spreads are solved. The effective benchmark becomes `curve` + `spreadCurve` (continuous zeros add ⇔ discount factors multiply), so the reported OAS and Z-spread are measured OVER a NON-FLAT benchmark — e.g. an OIS discount curve plus a sector/rating spread curve — rather than the plain `curve`. Its zero rates ARE the spreads (build one with `curves.fromZeroRates(spreadPillars)`); it must share `curve`'s reference date. - oasAnalytics(specification).stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). - paymentsPerYear: (frequency: import('@insiderfinance/totalfinance/fixed-income').Frequency) => number; default: not declared — Resolve a {@link Frequency} to an integer number of payments per year (must divide 12 evenly). - paymentsPerYear(frequency): import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - priceFromYield: import('@insiderfinance/totalfinance/fixed-income').BondFacade<[bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').PriceFromYieldOptions], import('@insiderfinance/totalfinance/fixed-income').BondPrice, import('@insiderfinance/totalfinance/fixed-income').BondPrice>; default: not declared — Dirty/clean price and accrued interest for a bond at a given yield. Facade (dx §2.7): the plain call returns the rich {@link BondPrice}; `.explain()` wraps the same result in the core envelope with the conventions echoed at the top level. - priceFromYield().return.accruedInterest: number; default: not declared - priceFromYield().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - priceFromYield().return.cleanPrice: number; default: not declared - priceFromYield().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - priceFromYield().return.dirtyPrice: number; default: not declared - priceFromYield(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').PriceFromYieldOptions]; default: not declared - priceFromYield.explain: (bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').PriceFromYieldOptions) => import('@insiderfinance/totalfinance/fixed-income').BondComputed; default: not declared - priceFromYield.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - priceFromYield.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - priceFromYield.explain().return.value: import('@insiderfinance/totalfinance/fixed-income').BondPrice; default: not declared - priceFromYield.explain(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').PriceFromYieldOptions]; default: not declared - priceMultiCurve: (bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: { settlementDate: string; discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; knownFixingRate?: number; }) => import('@insiderfinance/totalfinance/fixed-income').BondPrice; default: not declared — Price a bond with separate discount and forecast curves (multi-curve framework, no shock). `knownFixingRate` is the FRN in-progress coupon's observed reset — see {@link ProjectionContext.knownFixingRate}. It is surfaced here because this is the multi-curve pricing front door: without it, an FRN settled between two coupon dates could not be priced through the function most callers reach for. - priceMultiCurve().return.accruedInterest: number; default: not declared - priceMultiCurve().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - priceMultiCurve().return.cleanPrice: number; default: not declared - priceMultiCurve().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - priceMultiCurve().return.dirtyPrice: number; default: not declared - priceMultiCurve(bond): import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - priceMultiCurve(bond).accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - priceMultiCurve(bond).businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - priceMultiCurve(bond).cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - priceMultiCurve(bond).couponRate: number; default: not declared - priceMultiCurve(bond).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - priceMultiCurve(bond).faceValue: number; default: not declared - priceMultiCurve(bond).frequency: number; default: not declared - priceMultiCurve(bond).futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - priceMultiCurve(bond).issueDate: string; default: not declared - priceMultiCurve(bond).kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - priceMultiCurve(bond).maturityDate: string; default: not declared - priceMultiCurve(bond).schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - priceMultiCurve(options): { settlementDate: string; discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; knownFixingRate?: number; }; default: not declared - priceMultiCurve(options).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - priceMultiCurve(options).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - priceMultiCurve(options).knownFixingRate?: number; default: not declared - priceMultiCurve(options).settlementDate: string; default: not declared - rateCurveFromYieldCurve: (input: { curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; currency: string; }) => import('@insiderfinance/totalfinance/core').RateCurve; default: not declared — Project a live {@link YieldCurve} to core `RateCurve` data (module header). - rateCurveFromYieldCurve().return.asOf: number; default: not declared - rateCurveFromYieldCurve().return.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - rateCurveFromYieldCurve().return.currency: string; default: not declared - rateCurveFromYieldCurve().return.dayCount: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - rateCurveFromYieldCurve().return.interpolation?: string; default: not declared - rateCurveFromYieldCurve().return.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - rateCurveFromYieldCurve(input): { curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; currency: string; }; default: not declared - rateCurveFromYieldCurve(input).currency: string; default: not declared - rateCurveFromYieldCurve(input).curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - shortRateTree: (curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve, options: import('@insiderfinance/totalfinance/fixed-income').ShortRateTreeOptions) => import('@insiderfinance/totalfinance/fixed-income').ShortRateTree; default: not declared — Build a Hull-White / Black-Karasinski trinomial tree calibrated to `curve` via forward induction (Hull's two-stage procedure). Stage 1 lays out a symmetric mean-reverting tree for the transformed state `x`; stage 2 shifts each time slice by `α(t)` so the tree reprices every grid discount factor. For Black-Karasinski the short rate is `exp(x)`, so `α` is solved numerically per step. - shortRateTree().return.discountBond: (maturity: number) => number; default: not declared — Tree-implied discount bond price `P(0, T)` for a maturity on the time grid (years). - shortRateTree().return.gridTimes: readonly number[]; default: not declared — Reference discount factors the tree was calibrated to, at each grid time. - shortRateTree().return.model: import('@insiderfinance/totalfinance/fixed-income').TreeModel; default: not declared - shortRateTree().return.reachAt: (stepIndex: number) => number; default: not declared — Half-width of reachable levels at step `i` (nodes span `[-reach, +reach]`). - shortRateTree().return.rollback: (terminalStep: number, terminal: (j: number) => number, atNode?: (i: number, j: number, continuation: number) => number) => number; default: not declared — Generic backward induction from `terminalStep` to the root. `terminal(j)` seeds the value at each terminal node; at every earlier node the discounted expected continuation is passed to `atNode`, which returns the node value (inject cashflows, apply call/exercise via min/max). Returns the root value. The engine behind callable bonds and Bermudan swaptions. - shortRateTree().return.shortRate: (stepIndex: number, nodeIndex: number) => number; default: not declared — Short rate at tree node `(i, j)` (time step i, level j). - shortRateTree().return.stepOf: (years: number) => number; default: not declared — Map a year fraction to its grid step, validating it lands on the grid. - shortRateTree().return.steps: number; default: not declared - shortRateTree().return.timeStepYears: number; default: not declared - shortRateTree(curve): import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - shortRateTree(curve).addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - shortRateTree(curve).bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - shortRateTree(curve).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - shortRateTree(curve).discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - shortRateTree(curve).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - shortRateTree(curve).forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - shortRateTree(curve).instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - shortRateTree(curve).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - shortRateTree(curve).pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - shortRateTree(curve).referenceDate: string; default: not declared - shortRateTree(curve).shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - shortRateTree(curve).timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - shortRateTree(curve).zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - shortRateTree(options): import('@insiderfinance/totalfinance/fixed-income').ShortRateTreeOptions; default: not declared - shortRateTree(options).horizonYears: number; default: not declared — Tree horizonYears in years. - shortRateTree(options).meanReversion: number; default: not declared - shortRateTree(options).model: import('@insiderfinance/totalfinance/fixed-income').TreeModel; default: not declared — `hull-white` (Gaussian short rate) or `black-karasinski` (lognormal short rate). - shortRateTree(options).sigma: number; default: not declared - shortRateTree(options).steps?: number; default: not declared — Number of time steps (default 50). - swapRate: import('@insiderfinance/totalfinance/fixed-income').SwapRateFacade; default: not declared — Par swap rate that makes the swap value zero: `floatLegPv / annuity`. Facade (H04): the plain call returns the scalar; `.explain()` discloses the leg decomposition and every applied convention. - swapRate(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - swapRate(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - swapRate(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - swapRate(specification): import('@insiderfinance/totalfinance/fixed-income').ParSwapSpecification; default: not declared - swapRate(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - swapRate(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Fixed-leg frequency (default semiannual). - swapRate(specification).floatDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - swapRate(specification).floatFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Floating-leg frequency (default quarterly). - swapRate(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - swapRate(specification).maturityDate: string; default: not declared - swapRate(specification).notional?: number; default: not declared - swapRate(specification).startDate: string; default: not declared - swapRate.explain: (specification: import('@insiderfinance/totalfinance/fixed-income').ParSwapSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').SwapCurves) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/fixed-income').SwapRateAssumptions; }; default: not declared - swapRate.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').SwapRateAssumptions; default: not declared - swapRate.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - swapRate.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - swapRate.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - swapRate.explain(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - swapRate.explain(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - swapRate.explain(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - swapRate.explain(specification): import('@insiderfinance/totalfinance/fixed-income').ParSwapSpecification; default: not declared - swapRate.explain(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - swapRate.explain(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Fixed-leg frequency (default semiannual). - swapRate.explain(specification).floatDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - swapRate.explain(specification).floatFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Floating-leg frequency (default quarterly). - swapRate.explain(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - swapRate.explain(specification).maturityDate: string; default: not declared - swapRate.explain(specification).notional?: number; default: not declared - swapRate.explain(specification).startDate: string; default: not declared - swapValue: (specification: import('@insiderfinance/totalfinance/fixed-income').SwapSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').SwapCurves) => import('@insiderfinance/totalfinance/fixed-income').SwapValuation; default: not declared — Value an interest-rate swap (or OIS) off discount/forecast curves. - swapValue().return.annuity: number; default: not declared — Σ τᵢ·DF(tᵢ) over the fixed leg (the level / PV of a unit annuity). - swapValue().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - swapValue().return.assumptions.conventionsVersion: string; default: not declared - swapValue().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - swapValue().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - swapValue().return.fixedLegPresentValue: number; default: not declared - swapValue().return.floatLegPresentValue: number; default: not declared - swapValue().return.parRate: number; default: not declared - swapValue().return.pv01: number; default: not declared — PV of a 1bp change in the fixed rate (per notional). - swapValue().return.value: number; default: not declared — PV to the payer (pays fixed, receives floating). Receiver PV is the negative. - swapValue(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - swapValue(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - swapValue(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - swapValue(specification): import('@insiderfinance/totalfinance/fixed-income').SwapSpecification; default: not declared - swapValue(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - swapValue(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Fixed-leg frequency (default semiannual). - swapValue(specification).fixedRate: number; default: not declared — Fixed-leg rate. - swapValue(specification).floatDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - swapValue(specification).floatFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Floating-leg frequency (default quarterly). - swapValue(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - swapValue(specification).maturityDate: string; default: not declared - swapValue(specification).notional?: number; default: not declared - swapValue(specification).startDate: string; default: not declared - swapXva: (specification: import('@insiderfinance/totalfinance/fixed-income').XvaSwapSpecification, parameters: import('@insiderfinance/totalfinance/fixed-income').XvaParameters) => import('@insiderfinance/totalfinance/fixed-income').XvaResult; default: not declared — Compute CVA / DVA / FVA for an interest-rate swap via a Hull-White exposure simulation. - swapXva().return.assumptions: { conventionsVersion: string; model: 'hull-white'; seed: number; paths: number; stepsPerYear: number; }; default: not declared — Echoed reproducibility knobs (R2): the seed, paths, and grid resolution actually used. - swapXva().return.assumptions.conventionsVersion: string; default: not declared - swapXva().return.assumptions.model: 'hull-white'; default: not declared - swapXva().return.assumptions.paths: number; default: not declared - swapXva().return.assumptions.seed: number; default: not declared - swapXva().return.assumptions.stepsPerYear: number; default: not declared - swapXva().return.bilateralCva: number; default: not declared — Bilateral CVA: `cva − dva`. - swapXva().return.cva: number; default: not declared - swapXva().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { repricingError: number; }; default: not declared — Honest computation report (R2). `repricingError` is the worst zero-coupon repricing error of the simulator (martingale check) — the honesty signal for the whole exposure profile. - swapXva().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - swapXva().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - swapXva().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - swapXva().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - swapXva().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - swapXva().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - swapXva().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - swapXva().return.diagnostics.repricingError: number; default: not declared - swapXva().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - swapXva().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - swapXva().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - swapXva().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - swapXva().return.dva: number; default: not declared - swapXva().return.exposure: import('@insiderfinance/totalfinance/fixed-income').ExposurePoint[]; default: not declared — The exposure profile across the measurement dates. - swapXva().return.fva: number; default: not declared - swapXva(parameters): import('@insiderfinance/totalfinance/fixed-income').XvaParameters; default: not declared - swapXva(parameters).counterpartySurvival: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared — Counterparty survival curve (drives CVA). - swapXva(parameters).fundingSpread?: number; default: not declared — Funding spread over the risk-free curve for FVA (default 0 ⇒ FVA = 0). - swapXva(parameters).meanReversion: number; default: not declared — Hull-White mean reversion and short-rate volatility. - swapXva(parameters).ownRecovery?: number; default: not declared — Own recovery (default 0.4). - swapXva(parameters).ownSurvival?: import('@insiderfinance/totalfinance/fixed-income').SurvivalCurve; default: not declared — Own survival curve (drives DVA); omit to skip DVA. - swapXva(parameters).paths?: number; default: not declared — Number of simulated paths (default 5000). - swapXva(parameters).recovery?: number; default: not declared — Counterparty recovery (default 0.4). - swapXva(parameters).seed: number; default: not declared — Seed for the deterministic PRNG. - swapXva(parameters).sigma: number; default: not declared - swapXva(parameters).stepsPerYear?: number; default: not declared — Simulation steps per year (default 24, hard outer maximum 1,000,000; paths×steps cap may be lower). - swapXva(specification): import('@insiderfinance/totalfinance/fixed-income').XvaSwapSpecification; default: not declared - swapXva(specification).curve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Discount/forecast curve (single-curve); its reference date is the valuation date. - swapXva(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - swapXva(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - swapXva(specification).fixedRate: number; default: not declared - swapXva(specification).maturityDate: string; default: not declared - swapXva(specification).notional?: number; default: not declared - swapXva(specification).optionType: 'payer' | 'receiver'; default: not declared — `payer` = we pay fixed; `receiver` = we receive fixed. - swapXva(specification).startDate: string; default: not declared - swaptionPrice: (specification: import('@insiderfinance/totalfinance/fixed-income').SwaptionSpecification, curves: import('@insiderfinance/totalfinance/fixed-income').SwapCurves) => import('@insiderfinance/totalfinance/fixed-income').SwaptionResult; default: not declared — Price a European swaption. The forward swap rate `S` is the natural martingale under the annuity measure, so the price is `annuity · ForwardOption(S, K, σ, T)` — Black for lognormal vol, Bachelier for normal vol. - swaptionPrice().return.annuity: number; default: not declared - swaptionPrice().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - swaptionPrice().return.assumptions.conventionsVersion: string; default: not declared - swaptionPrice().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - swaptionPrice().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - swaptionPrice().return.forwardSwapRate: number; default: not declared - swaptionPrice().return.price: number; default: not declared - swaptionPrice(curves): import('@insiderfinance/totalfinance/fixed-income').SwapCurves; default: not declared - swaptionPrice(curves).discountCurve: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared - swaptionPrice(curves).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - swaptionPrice(specification): import('@insiderfinance/totalfinance/fixed-income').SwaptionSpecification; default: not declared - swaptionPrice(specification).expiry: string; default: not declared — Option expiry (typically the swap start). - swaptionPrice(specification).fixedDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - swaptionPrice(specification).fixedFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Fixed-leg frequency (default semiannual). - swaptionPrice(specification).fixedRate: number; default: not declared — Fixed-leg rate. - swaptionPrice(specification).floatDayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - swaptionPrice(specification).floatFrequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared — Floating-leg frequency (default quarterly). - swaptionPrice(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - swaptionPrice(specification).maturityDate: string; default: not declared - swaptionPrice(specification).model?: import('@insiderfinance/totalfinance/fixed-income').RatesVolatilityModel; default: not declared - swaptionPrice(specification).notional?: number; default: not declared - swaptionPrice(specification).optionType: 'payer' | 'receiver'; default: not declared — `payer` = option to pay fixed (call on the swap rate); `receiver` = option to receive fixed. - swaptionPrice(specification).startDate: string; default: not declared - swaptionPrice(specification).volatility: number; default: not declared — Volatility — lognormal for `black`, normal (absolute) for `bachelier`. - tipsIndexRatio: (input: import('@insiderfinance/totalfinance/fixed-income').TipsIndexRatioInput) => import('@insiderfinance/totalfinance/fixed-income').TipsIndexRatioResult; default: not declared — The TIPS reference CPI and index ratio for a settlement date: the 3-month-lagged NSA CPI, linearly interpolated by day across the settlement month, over the dated-date base. See `docs/specs/inflation.md`. - tipsIndexRatio().return.assumptions: { conventionsVersion: string; lagMonths: 3; interpolation: 'daily-linear'; }; default: not declared - tipsIndexRatio().return.assumptions.conventionsVersion: string; default: not declared - tipsIndexRatio().return.assumptions.interpolation: 'daily-linear'; default: not declared - tipsIndexRatio().return.assumptions.lagMonths: 3; default: not declared - tipsIndexRatio().return.baseReferenceCpi: number; default: not declared - tipsIndexRatio().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - tipsIndexRatio().return.indexRatio: number; default: not declared — `referenceCpi / baseReferenceCpi` (raw). - tipsIndexRatio().return.indexRatioRounded: number; default: not declared — Index ratio rounded to 5 decimals (the official ratio). - tipsIndexRatio().return.inflationSinceBase: number; default: not declared — `indexRatio − 1`. - tipsIndexRatio().return.lagMonth2: string; default: not declared — CPI two months prior (`CPI₋₂`) and its month. - tipsIndexRatio().return.lagMonth2Cpi: number; default: not declared - tipsIndexRatio().return.lagMonth3: string; default: not declared — CPI three months prior (`CPI₋₃`) and its month. - tipsIndexRatio().return.lagMonth3Cpi: number; default: not declared - tipsIndexRatio().return.referenceCpi: number; default: not declared — Interpolated reference CPI (raw). - tipsIndexRatio().return.referenceCpiRounded: number; default: not declared — Reference CPI rounded to the Treasury's 5 decimals. - tipsIndexRatio().return.settlementDate: string; default: not declared - tipsIndexRatio(input): import('@insiderfinance/totalfinance/fixed-income').TipsIndexRatioInput; default: not declared - tipsIndexRatio(input).baseReferenceCpi?: number; default: not declared — The dated-date reference CPI (indexation base) — supply this OR `datedDate`, exactly one. - tipsIndexRatio(input).cpi: Record; default: not declared — NSA CPI by month `'YYYY-MM'` → level; must cover the 3-month-lag window of every date used. - tipsIndexRatio(input).datedDate?: string; default: not declared — The bond's dated date; its reference CPI (interpolated from `cpi`) becomes the base. - tipsIndexRatio(input).settlementDate: string; default: not declared — The date the index ratio is for (ISO). - vasicek: (parameters: import('@insiderfinance/totalfinance/fixed-income').VasicekParameters) => import('@insiderfinance/totalfinance/fixed-income').GaussianShortRateModel; default: not declared — Construct a Vasicek model `dr = a(b − r)dt + σ dW`. - vasicek().return.caplet: (input: import('@insiderfinance/totalfinance/fixed-income/models').RateOptionletInput) => number; default: not declared — Caplet on the simple rate over `[tOption, tBond]`, strike `capRate`, per unit notional. - vasicek().return.discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - vasicek().return.floorlet: (input: import('@insiderfinance/totalfinance/fixed-income/models').RateOptionletInput) => number; default: not declared — Floorlet on the simple rate over `[tOption, tBond]`, strike `floorRate`, per unit notional. - vasicek().return.shortRateMoments: (years: number) => import('@insiderfinance/totalfinance/fixed-income').ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - vasicek().return.zeroCouponBondOption: (input: import('@insiderfinance/totalfinance/fixed-income/models').ZeroCouponBondOptionInput) => number; default: not declared — Analytic price of a European call/put on a zero-coupon bond maturing at `tBond`, exercised at `tOption` (years), struck at `strike` (per unit face) — the Jamshidian decomposition's building block. Returns a present value as of t = 0. - vasicek().return.zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. - vasicek(parameters): import('@insiderfinance/totalfinance/fixed-income').VasicekParameters; default: not declared - vasicek(parameters).a: number; default: not declared — Mean-reversion speed (> 0). - vasicek(parameters).b: number; default: not declared — Long-run mean level. - vasicek(parameters).r0: number; default: not declared — Current short rate. - vasicek(parameters).sigma: number; default: not declared — Instantaneous volatility (> 0). - yearFraction: (from: string, to: string, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Year fraction between two ISO dates under a fixed-income day-count convention. `ACT/ACT` and `30E/360` are implemented here; the three core conventions delegate to `@insiderfinance/totalfinance/core`. - yearFraction(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - yearFraction(from): string; default: not declared - yearFraction(to): string; default: not declared - yieldCurveFromRateCurve: (input: { curve: import('@insiderfinance/totalfinance/core').RateCurve; interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; }) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Build a live {@link YieldCurve} from core `RateCurve` data (module header). - yieldCurveFromRateCurve().return.addSpread: (spread: import('@insiderfinance/totalfinance/fixed-income').YieldCurve) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - yieldCurveFromRateCurve().return.bumpPillar: (index: number, delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - yieldCurveFromRateCurve().return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - yieldCurveFromRateCurve().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - yieldCurveFromRateCurve().return.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - yieldCurveFromRateCurve().return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - yieldCurveFromRateCurve().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - yieldCurveFromRateCurve().return.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - yieldCurveFromRateCurve().return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - yieldCurveFromRateCurve().return.referenceDate: string; default: not declared - yieldCurveFromRateCurve().return.shift: (delta: number) => import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - yieldCurveFromRateCurve().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - yieldCurveFromRateCurve().return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - yieldCurveFromRateCurve(input): { curve: import('@insiderfinance/totalfinance/core').RateCurve; interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; }; default: not declared - yieldCurveFromRateCurve(input).curve: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - yieldCurveFromRateCurve(input).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - yieldCurveFromRateCurve(input).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - yieldMetrics: import('@insiderfinance/totalfinance/fixed-income').BondFacade<[bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldMetricsOptions], import('@insiderfinance/totalfinance/fixed-income').YieldMetrics, import('@insiderfinance/totalfinance/fixed-income').YieldMetrics>; default: not declared — Full set of yield-based risk metrics at a given yield (actuarial convention). Duration and convexity are the closed-form analytic sensitivities of the dirty price to a parallel yield move. Facade (dx §2.7): the plain call returns the rich {@link YieldMetrics}; `.explain()` wraps the same result in the core envelope with the conventions echoed at the top level. - yieldMetrics().return.accruedInterest: number; default: not declared - yieldMetrics().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - yieldMetrics().return.cleanPrice: number; default: not declared - yieldMetrics().return.convexity: number; default: not declared - yieldMetrics().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - yieldMetrics().return.dirtyPrice: number; default: not declared - yieldMetrics().return.dv01: number; default: not declared — Dollar value of a 1bp yield increase (per the bond's face value). - yieldMetrics().return.macaulayDuration: number; default: not declared - yieldMetrics().return.modifiedDuration: number; default: not declared - yieldMetrics().return.pv01: number; default: not declared — Price value of a 1bp move (synonym for DV01 here, per face). - yieldMetrics().return.yield: number; default: not declared - yieldMetrics(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldMetricsOptions]; default: not declared - yieldMetrics.explain: (bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldMetricsOptions) => import('@insiderfinance/totalfinance/fixed-income').BondComputed; default: not declared - yieldMetrics.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - yieldMetrics.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - yieldMetrics.explain().return.value: import('@insiderfinance/totalfinance/fixed-income').YieldMetrics; default: not declared - yieldMetrics.explain(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldMetricsOptions]; default: not declared - yieldToCall: import('@insiderfinance/totalfinance/fixed-income').YieldToCallFacade; default: not declared — Yield to a call date (H05): the plain call returns the scalar; `.explain()` mirrors `yieldToMaturity.explain()` — solver facts in diagnostics, the resolved call price and settlement accrued in the decomposition, and the call/price basis echoed in assumptions. - yieldToCall(bond): import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - yieldToCall(bond).accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - yieldToCall(bond).businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - yieldToCall(bond).cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - yieldToCall(bond).couponRate: number; default: not declared - yieldToCall(bond).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - yieldToCall(bond).faceValue: number; default: not declared - yieldToCall(bond).frequency: number; default: not declared - yieldToCall(bond).futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - yieldToCall(bond).issueDate: string; default: not declared - yieldToCall(bond).kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - yieldToCall(bond).maturityDate: string; default: not declared - yieldToCall(bond).schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - yieldToCall(call): import('@insiderfinance/totalfinance/fixed-income').CallFeature; default: not declared - yieldToCall(call).callDate: string; default: not declared — First/earliest call date. - yieldToCall(call).callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. - yieldToCall(options): import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions; default: not declared - yieldToCall(options).context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext; default: not declared - yieldToCall(options).price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - yieldToCall(options).priceType?: 'clean' | 'dirty'; default: not declared - yieldToCall(options).settlementDate: string; default: not declared - yieldToCall.explain: (bond: import('@insiderfinance/totalfinance/fixed-income').Bond, call: import('@insiderfinance/totalfinance/fixed-income').CallFeature, options: import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/fixed-income').YieldToCallAssumptions; }; default: not declared - yieldToCall.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').YieldToCallAssumptions; default: not declared - yieldToCall.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - yieldToCall.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - yieldToCall.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - yieldToCall.explain(bond): import('@insiderfinance/totalfinance/fixed-income').Bond; default: not declared - yieldToCall.explain(bond).accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - yieldToCall.explain(bond).businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - yieldToCall.explain(bond).cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - yieldToCall.explain(bond).couponRate: number; default: not declared - yieldToCall.explain(bond).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - yieldToCall.explain(bond).faceValue: number; default: not declared - yieldToCall.explain(bond).frequency: number; default: not declared - yieldToCall.explain(bond).futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - yieldToCall.explain(bond).issueDate: string; default: not declared - yieldToCall.explain(bond).kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - yieldToCall.explain(bond).maturityDate: string; default: not declared - yieldToCall.explain(bond).schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - yieldToCall.explain(call): import('@insiderfinance/totalfinance/fixed-income').CallFeature; default: not declared - yieldToCall.explain(call).callDate: string; default: not declared — First/earliest call date. - yieldToCall.explain(call).callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. - yieldToCall.explain(options): import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions; default: not declared - yieldToCall.explain(options).context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext; default: not declared - yieldToCall.explain(options).price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - yieldToCall.explain(options).priceType?: 'clean' | 'dirty'; default: not declared - yieldToCall.explain(options).settlementDate: string; default: not declared - yieldToMaturity: import('@insiderfinance/totalfinance/fixed-income').BondFacade<[bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions], number, number>; default: not declared — Solve the yield to maturity that reprices a bond to the observed price (Brent on [−0.99·f, 1]). Facade (dx §2.7): the plain call returns the bare yield; `.explain()` returns the core envelope echoing the bond's conventions plus honest solver diagnostics (this is a root-find, so `converged`/`iterations` are disclosed — a non-converged solve throws rather than returning). - yieldToMaturity(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions]; default: not declared - yieldToMaturity.explain: (bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions) => import('@insiderfinance/totalfinance/fixed-income').BondComputed; default: not declared - yieldToMaturity.explain().return.assumptions: import('@insiderfinance/totalfinance/fixed-income').BondAssumptions; default: not declared - yieldToMaturity.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - yieldToMaturity.explain().return.value: number; default: not declared - yieldToMaturity.explain(callArguments): [bond: import('@insiderfinance/totalfinance/fixed-income').Bond, options: import('@insiderfinance/totalfinance/fixed-income').YieldFromPriceOptions]; default: not declared - zeroCouponInflationSwap: (input: import('@insiderfinance/totalfinance/fixed-income').ZeroCouponInflationSwapInput) => import('@insiderfinance/totalfinance/fixed-income').ZeroCouponInflationSwapResult; default: not declared — A **zero-coupon inflation swap** (ZCIS) — the standard inflation-market instrument. At maturity the inflation leg pays `I(T)/I(0) − 1` and the fixed leg pays `(1+K)^N − 1`; the par rate `K` is set so the two match, i.e. `(1+K)^N = I(T)/I(0)`, so the par ZCIS rate **is** the geometric breakeven inflation. Supply the market rate or the forward index ratio (each implies the other); supply a `contractRate` to mark an existing position: `MTM = ±notional·DF·[(1+parRate)^N − (1+contractRate)^N]`. Deterministic (forward-measure) — no inflation-vol model. See `docs/specs/inflation.md`. - zeroCouponInflationSwap().return.assumptions: { conventionsVersion: string; method: 'zero-coupon-inflation-swap'; }; default: not declared - zeroCouponInflationSwap().return.assumptions.conventionsVersion: string; default: not declared - zeroCouponInflationSwap().return.assumptions.method: 'zero-coupon-inflation-swap'; default: not declared - zeroCouponInflationSwap().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - zeroCouponInflationSwap().return.fixedLeg: number; default: not declared — The single fixed-leg payoff per unit notional at maturity: `(1 + parRate)^N − 1`. Equals the expected inflation-leg payoff (they match at par). - zeroCouponInflationSwap().return.forwardIndexRatio: number; default: not declared — Forward index ratio `I(T)/I(0) = (1 + parRate)^N`. - zeroCouponInflationSwap().return.markToMarket: number | null; default: not declared — Mark-to-market PV of a position at `contractRate` (present only when `contractRate` is supplied): `±notional·DF·[(1+parRate)^N − (1+contractRate)^N]`, signed by `payer`. `null` otherwise. - zeroCouponInflationSwap().return.parRate: number; default: not declared — Par ZCIS rate (geometric annual breakeven): `forwardIndexRatio^(1/N) − 1`. - zeroCouponInflationSwap(input): import('@insiderfinance/totalfinance/fixed-income').ZeroCouponInflationSwapInput; default: not declared - zeroCouponInflationSwap(input).contractRate?: number; default: not declared — An existing position's contracted fixed rate `K_c` — supply to value the swap (MTM). - zeroCouponInflationSwap(input).discountFactor?: number; default: not declared — Discount factor to maturity for the MTM (default `1` → the undiscounted at-maturity value). - zeroCouponInflationSwap(input).forwardIndexRatio?: number; default: not declared — The forward index ratio `I(T)/I(0)`. Supply **this or** `swapRate` — exactly one. Implies `swapRate = forwardIndexRatio^(1/N) − 1`. - zeroCouponInflationSwap(input).maturityYears: number; default: not declared — Swap maturity in years (`N`). The single ZCIS cashflow is exchanged at maturity. - zeroCouponInflationSwap(input).notional?: number; default: not declared — Notional (default `1`). - zeroCouponInflationSwap(input).payer?: 'fixed' | 'inflation'; default: not declared — Which leg the holder **pays** (default `'fixed'` = pay fixed, receive inflation). Signs the MTM. - zeroCouponInflationSwap(input).swapRate?: number; default: not declared — The par/market ZCIS rate `K` (the geometric annual breakeven). Supply **this or** `forwardIndexRatio` — exactly one. - zeroFromDiscount: (discountFactor: number, years: number, compounding: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate (in `compounding`) implied by a discount factor over time `t`. - zeroFromDiscount(compounding): import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - zeroFromDiscount(compounding).periodsPerYear: number; default: not declared - zeroFromDiscount(compounding).type: 'periodic'; default: not declared - zeroFromDiscount(discountFactor): number; default: not declared - zeroFromDiscount(years): number; default: not declared ### @insiderfinance/totalfinance#foreignExchange Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const foreignExchange: typeof import('@insiderfinance/totalfinance/foreign-exchange'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - HEDGED_PROFIT_AND_LOSS_DECOMPOSITION: 'totalProfitAndLossInQuoteCurrency = (1 − hedgedFraction) × (finalSpotRate.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount + hedgedFraction × (forwardRateAtHedge.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount, every term in the quote currency'; default: not declared — The exact decomposition prose, frozen so tests and docs can quote it. - convertCurrency: (input: import('@insiderfinance/totalfinance/foreign-exchange').ConvertCurrencyInput) => import('@insiderfinance/totalfinance/foreign-exchange').ConvertCurrencyResult; default: not declared — Convert an amount between two currencies at the supplied spot quote. The quote must connect the two currencies; when it is oriented the other way the conversion divides instead of multiplies and the result discloses `orientation: 'inverted'`. Converting there and back with the same quote returns the original amount (the round-trip identity, tested at 1e-12). A same-currency conversion with a quote supplied is rejected — the identity conversion needs no quote. - convertCurrency().return.assumptions: { fromCurrency: string; toCurrency: string; quoteUsed: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; orientation: 'direct' | 'inverted'; }; default: not declared - convertCurrency().return.assumptions.fromCurrency: string; default: not declared - convertCurrency().return.assumptions.orientation: 'direct' | 'inverted'; default: not declared — `'direct'`: multiplied by `quotePerBase`; `'inverted'`: divided by it. - convertCurrency().return.assumptions.quoteUsed: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The caller's quote, echoed verbatim. - convertCurrency().return.assumptions.toCurrency: string; default: not declared - convertCurrency().return.convertedAmount: number; default: not declared - convertCurrency().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - convertCurrency(input): import('@insiderfinance/totalfinance/foreign-exchange').ConvertCurrencyInput; default: not declared - convertCurrency(input).amount: number; default: not declared — Amount of `fromCurrency` to convert (any finite sign — a liability converts like an asset). - convertCurrency(input).fromCurrency: string; default: not declared - convertCurrency(input).spotRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — A quote connecting the two currencies, in EITHER orientation — inverted internally, disclosed. - convertCurrency(input).toCurrency: string; default: not declared - coveredInterestParityForward: (input: import('@insiderfinance/totalfinance/foreign-exchange').CoveredInterestParityForwardInput) => import('@insiderfinance/totalfinance/foreign-exchange').CoveredInterestParityForwardResult; default: not declared — The no-arbitrage forward: `forward = spot × growthFactor(domestic) / growthFactor(foreign)`. The DOMESTIC rate is the QUOTE currency's rate and the FOREIGN rate is the BASE currency's rate — investing the converted amount at the domestic rate must equal investing one base unit at the foreign rate and converting at this forward (the covered-interest-parity round trip, tested at 1e-12). Under continuous compounding this is exactly `spot × e^((domestic − foreign) × t)`. - coveredInterestParityForward().return.assumptions: { rateRoles: 'domestic = quote currency, foreign = base currency'; compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; timeYears: number; }; default: not declared - coveredInterestParityForward().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - coveredInterestParityForward().return.assumptions.rateRoles: 'domestic = quote currency, foreign = base currency'; default: not declared - coveredInterestParityForward().return.assumptions.timeYears: number; default: not declared - coveredInterestParityForward().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - coveredInterestParityForward().return.forwardRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The parity forward for the SAME pair as the spot quote. - coveredInterestParityForward(input): import('@insiderfinance/totalfinance/foreign-exchange').CoveredInterestParityForwardInput; default: not declared - coveredInterestParityForward(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, echoed in the assumptions. - coveredInterestParityForward(input).domesticAnnualRate: number; default: not declared — Annual rate (decimal) of the QUOTE currency — the 'domestic' leg (USD in EUR/USD). - coveredInterestParityForward(input).foreignAnnualRate: number; default: not declared — Annual rate (decimal) of the BASE currency — the 'foreign' leg (EUR in EUR/USD). - coveredInterestParityForward(input).spotRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - coveredInterestParityForward(input).timeYears: number; default: not declared - crossRate: (input: import('@insiderfinance/totalfinance/foreign-exchange').CrossRateInput) => import('@insiderfinance/totalfinance/foreign-exchange').CrossRateResult; default: not declared — Derive a cross pair through the ONE currency the two supplied quotes share (EUR/USD × USD/JPY → EUR/JPY). Every orientation case is handled by explicit inversion, and the derivation prose in the assumptions shows each leg's price, source quote, and orientation. Quotes sharing zero or both currencies are rejected with the currencies named — there is no cross to derive. - crossRate().return.assumptions: { throughCurrency: string; derivation: string; }; default: not declared - crossRate().return.assumptions.derivation: string; default: not declared — The exact arithmetic, with each leg's source quote and orientation named. - crossRate().return.assumptions.throughCurrency: string; default: not declared — The ONE currency the two supplied quotes share — the leg the cross goes through. - crossRate().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - crossRate().return.quote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The derived cross pair, oriented as requested. - crossRate(input): import('@insiderfinance/totalfinance/foreign-exchange').CrossRateInput; default: not declared - crossRate(input).crossBaseCurrency: string; default: not declared — Base currency of the derived cross pair — one of the two non-shared currencies. - crossRate(input).crossQuoteCurrency: string; default: not declared — Quote currency of the derived cross pair — the other non-shared currency. - crossRate(input).firstQuote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - crossRate(input).secondQuote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - currencyExposure: (input: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposureInput) => import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposureResult; default: not declared — Aggregate positions into per-currency exposure in one declared base currency. Base-currency positions pass through unconverted; every other currency is restated with {@link convertCurrency} at the supplied quote in whichever orientation connects it (disclosed in `assumptions.quotesUsed`). A currency with no connecting quote is excluded position-by-position WITH the reason, and `exposureFraction` is each included currency's share of `totalBaseValue`. - currencyExposure().return.assumptions: { baseCurrency: string; missingPairPolicy: string; quotesUsed: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposureQuoteUse[]; }; default: not declared - currencyExposure().return.assumptions.baseCurrency: string; default: not declared - currencyExposure().return.assumptions.missingPairPolicy: string; default: not declared — The fixed policy prose: a position with no connecting quote is excluded with its reason. - currencyExposure().return.assumptions.quotesUsed: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposureQuoteUse[]; default: not declared — Which quote restated each non-base currency, and in which orientation. - currencyExposure().return.byCurrency: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposureRow[]; default: not declared — Per-currency rows in first-appearance order, included currencies only. - currencyExposure().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - currencyExposure().return.excludedPositions: import('@insiderfinance/totalfinance/foreign-exchange').ExcludedCurrencyExposurePosition[]; default: not declared - currencyExposure().return.totalBaseValue: number; default: not declared — Sum of every INCLUDED position's value in the base currency. - currencyExposure(input): import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposureInput; default: not declared - currencyExposure(input).baseCurrency: string; default: not declared — The reporting currency every value is restated into. - currencyExposure(input).positions: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyExposurePosition[]; default: not declared - currencyExposure(input).spotRates: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote[]; default: not declared — Enough quotes to connect every position currency to the base currency, in either orientation. A currency with no connecting quote has its positions excluded WITH reason — never guessed. - foreignExchangeForwardPoints: (input: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardPointsInput) => import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardPointsResult; default: not declared — Forward points: `(forward − spot) / pointSize`. Positive when the base currency trades at a forward premium. `pointSize` is always explicit — a symbol's spelling never decides it. - foreignExchangeForwardPoints().return.assumptions: { pointSize: number; pointSizeSource: 'explicit'; formula: 'forwardPoints = (forwardRate.quotePerBase \u2212 spotRate.quotePerBase) / pointSize'; }; default: not declared - foreignExchangeForwardPoints().return.assumptions.formula: 'forwardPoints = (forwardRate.quotePerBase − spotRate.quotePerBase) / pointSize'; default: not declared - foreignExchangeForwardPoints().return.assumptions.pointSize: number; default: not declared - foreignExchangeForwardPoints().return.assumptions.pointSizeSource: 'explicit'; default: not declared - foreignExchangeForwardPoints().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - foreignExchangeForwardPoints().return.forwardPoints: number; default: not declared - foreignExchangeForwardPoints(input): import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardPointsInput; default: not declared - foreignExchangeForwardPoints(input).forwardRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The forward for the SAME pair in the SAME direction. - foreignExchangeForwardPoints(input).pointSize: number; default: not declared — The size of one point in quotePerBase units (e.g. `0.0001` for EUR/USD). REQUIRED — never guessed. - foreignExchangeForwardPoints(input).spotRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - foreignExchangeForwardValue: (input: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardValueInput) => import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardValueResult; default: not declared — Mark-to-market of an outstanding forward: `±(currentForward − contract) × notionalBase × discountFactorToSettlement`, positive sign for `'buyer-of-base'`, negative for `'seller-of-base'`, in the QUOTE currency. At `currentForwardRate === contractRate` the value is exactly zero under unchanged inputs (the FC5 acceptance law). - foreignExchangeForwardValue().return.assumptions: { perspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; }; default: not declared - foreignExchangeForwardValue().return.assumptions.discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; default: not declared - foreignExchangeForwardValue().return.assumptions.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - foreignExchangeForwardValue().return.assumptions.signConvention: string; default: not declared - foreignExchangeForwardValue().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - foreignExchangeForwardValue().return.forwardValueInQuoteCurrency: number; default: not declared — Present value of the position in the QUOTE currency; zero at the contracted fair forward. - foreignExchangeForwardValue(input): import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardValueInput; default: not declared - foreignExchangeForwardValue(input).contractRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The rate contracted at inception, for the pair being valued. - foreignExchangeForwardValue(input).currentForwardRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — Today's forward to the SAME settlement date, SAME pair, SAME direction. - foreignExchangeForwardValue(input).discountFactorToSettlement: number; default: not declared — An explicit discount factor in the QUOTE currency to the settlement date. A factor, not a rate — the matched-conventions law: accepting a rate here would let day-count and compounding conventions mismatch silently against the forward's own quotation. - foreignExchangeForwardValue(input).notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - foreignExchangeForwardValue(input).perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared — Which side is being valued: the buyer of the base currency, or the seller. - foreignExchangeSwapValue: (input: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeSwapValueInput) => import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeSwapValueResult; default: not declared — Value of a foreign-exchange swap as the sum of its two forward legs, each valued with {@link foreignExchangeForwardValue} (composed, not copied). Both legs must quote the SAME pair; a classic swap holds opposite perspectives on the two legs, but that is the caller's economics and is not enforced — each leg's perspective is echoed. - foreignExchangeSwapValue().return.assumptions: { composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; farLegPerspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; default: not declared - foreignExchangeSwapValue().return.assumptions.composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; default: not declared - foreignExchangeSwapValue().return.assumptions.farLegPerspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - foreignExchangeSwapValue().return.assumptions.nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - foreignExchangeSwapValue().return.assumptions.signConvention: string; default: not declared - foreignExchangeSwapValue().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - foreignExchangeSwapValue().return.farLegValue: number; default: not declared - foreignExchangeSwapValue().return.nearLegValue: number; default: not declared - foreignExchangeSwapValue().return.swapValueInQuoteCurrency: number; default: not declared — `nearLegValue + farLegValue`, in the pair's QUOTE currency. - foreignExchangeSwapValue(input): import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeSwapValueInput; default: not declared - foreignExchangeSwapValue(input).farLeg: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardValueInput; default: not declared - foreignExchangeSwapValue(input).nearLeg: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeForwardValueInput; default: not declared - hedgeRatio: (input: import('@insiderfinance/totalfinance/foreign-exchange').HedgeRatioInput) => import('@insiderfinance/totalfinance/foreign-exchange').HedgeRatioResult; default: not declared — The simple hedge ratio: `hedgeNotionalBaseAmount / exposureBaseAmount`, both amounts echoed. A zero exposure has no ratio — the result is `null` with the reason, never Infinity or NaN. - hedgeRatio().return.assumptions: { exposureBaseAmount: number; hedgeNotionalBaseAmount: number; definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; }; default: not declared - hedgeRatio().return.assumptions.definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; default: not declared - hedgeRatio().return.assumptions.exposureBaseAmount: number; default: not declared - hedgeRatio().return.assumptions.hedgeNotionalBaseAmount: number; default: not declared - hedgeRatio().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - hedgeRatio().return.hedgeRatio: number | null; default: not declared — `hedgeNotionalBaseAmount / exposureBaseAmount`; `null` when the exposure is exactly zero. - hedgeRatio().return.hedgeRatioAbsentReason?: string; default: not declared — Present exactly when `hedgeRatio` is null. - hedgeRatio(input): import('@insiderfinance/totalfinance/foreign-exchange').HedgeRatioInput; default: not declared - hedgeRatio(input).exposureBaseAmount: number; default: not declared — The exposure being hedged, in base-currency units (sign allowed — a short exposure is negative). - hedgeRatio(input).hedgeNotionalBaseAmount: number; default: not declared — The hedge's notional, in the same base-currency units. - invertCurrencyPairQuote: (input: import('@insiderfinance/totalfinance/foreign-exchange').InvertCurrencyPairQuoteInput) => import('@insiderfinance/totalfinance/foreign-exchange').InvertCurrencyPairQuoteResult; default: not declared — Flip a quote's direction: EUR/USD 1.08 becomes USD/EUR 1/1.08. Inverting twice returns the original pair (the quote-direction identity, tested at 1e-12). - invertCurrencyPairQuote().return.assumptions: { inversion: '1 / quotePerBase'; }; default: not declared - invertCurrencyPairQuote().return.assumptions.inversion: '1 / quotePerBase'; default: not declared - invertCurrencyPairQuote().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - invertCurrencyPairQuote().return.quote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The flipped pair: base and quote swapped, `quotePerBase` reciprocated. - invertCurrencyPairQuote(input): import('@insiderfinance/totalfinance/foreign-exchange').InvertCurrencyPairQuoteInput; default: not declared - invertCurrencyPairQuote(input).quote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - nonDeliverableForwardValue: (input: import('@insiderfinance/totalfinance/foreign-exchange').NonDeliverableForwardValueInput) => import('@insiderfinance/totalfinance/foreign-exchange').NonDeliverableForwardValueResult; default: not declared — Cash-settled value of a non-deliverable forward at its OBSERVED fixing: `±(fixing − contract) × notionalBase × discountFactorToSettlement`, in the settlement currency. The fixing is the caller's — this function never selects a fixing source. v1 settles only in the pair's quote currency; other settlement currencies are rejected with the constraint named. - nonDeliverableForwardValue().return.assumptions: { fixingSource: 'caller-supplied fixing rate'; settlementCurrency: string; settlementConstraint: string; perspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; default: not declared - nonDeliverableForwardValue().return.assumptions.fixingSource: 'caller-supplied fixing rate'; default: not declared - nonDeliverableForwardValue().return.assumptions.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - nonDeliverableForwardValue().return.assumptions.settlementConstraint: string; default: not declared — The fixed v1 constraint prose: settlement in the pair's quote currency only. - nonDeliverableForwardValue().return.assumptions.settlementCurrency: string; default: not declared - nonDeliverableForwardValue().return.assumptions.signConvention: string; default: not declared - nonDeliverableForwardValue().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - nonDeliverableForwardValue().return.nonDeliverableForwardValueInSettlementCurrency: number; default: not declared — The discounted cash settlement, in the settlement (= quote) currency. - nonDeliverableForwardValue(input): import('@insiderfinance/totalfinance/foreign-exchange').NonDeliverableForwardValueInput; default: not declared - nonDeliverableForwardValue(input).contractRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The rate contracted at inception. - nonDeliverableForwardValue(input).discountFactorToSettlement: number; default: not declared — An explicit discount factor in the settlement (quote) currency to the settlement date. - nonDeliverableForwardValue(input).fixingRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The OBSERVED fixing for the SAME pair — caller-supplied, never fetched or guessed. - nonDeliverableForwardValue(input).notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - nonDeliverableForwardValue(input).perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - nonDeliverableForwardValue(input).settlementCurrency: string; default: not declared — Where cash settles. v1 supports ONLY the pair's quote currency; anything else is rejected. - pipValue: (input: import('@insiderfinance/totalfinance/foreign-exchange').PipValueInput) => import('@insiderfinance/totalfinance/foreign-exchange').PipValueResult; default: not declared — Value of one pip for a position. A pip moves `quotePerBase` by `pipSize`, so a notional of `N` BASE units gains/loses `pipSize × N` quote-currency units per pip; a notional stated in the quote currency is first restated in base units at the supplied spot quote. `pipSize` is always explicit — a symbol's spelling never decides it. - pipValue().return.assumptions: { pipSize: number; pipSizeSource: 'explicit'; notionalCurrency: string; notionalCurrencyRole: 'base' | 'quote'; baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; }; default: not declared - pipValue().return.assumptions.baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; default: not declared - pipValue().return.assumptions.notionalCurrency: string; default: not declared - pipValue().return.assumptions.notionalCurrencyRole: 'base' | 'quote'; default: not declared — How the notional was read: already in base units, or converted from quote units at spot. - pipValue().return.assumptions.pipSize: number; default: not declared - pipValue().return.assumptions.pipSizeSource: 'explicit'; default: not declared - pipValue().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - pipValue().return.pipValueInBaseCurrency: number; default: not declared — The same value converted to the base currency at the supplied spot quote. - pipValue().return.pipValueInQuoteCurrency: number; default: not declared — Value of a one-pip move in the QUOTE currency. - pipValue(input): import('@insiderfinance/totalfinance/foreign-exchange').PipValueInput; default: not declared - pipValue(input).notionalAmount: number; default: not declared — Position notional, expressed in `notionalCurrency` units. - pipValue(input).notionalCurrency: string; default: not declared — Which currency the notional is stated in — must be the pair's base or quote currency. - pipValue(input).pipSize: number; default: not declared — The size of one pip in quote-currency units per base unit (e.g. `0.0001` for EUR/USD, `0.01` for USD/JPY). REQUIRED — never guessed from symbol spelling (FC5 law). - pipValue(input).quote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - requireCurrencyCode: (functionName: string, field: string, value: unknown) => asserts value is string; default: not declared — Validate one currency-code field at a public boundary: a string matching `/^[A-Z]{3}$/` (uppercase three-letter ISO-4217 style). A lowercase spelling is answered with the exact uppercase fix rather than a bare rejection. - requireCurrencyCode(field): string; default: not declared - requireCurrencyCode(functionName): string; default: not declared - requireCurrencyCode(value): unknown; default: not declared - requireCurrencyPairQuote: (functionName: string, label: string, quote: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote) => asserts quote is import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — Validate a {@link CurrencyPairQuote} at a public boundary (Law 12 closed request): known keys, two DISTINCT uppercase currency codes, and a finite `quotePerBase` > 0. The guard validates its own `functionName` and `label` first — invoked without them, every error it teaches would blame "undefined" (see `requireFundamentalPeriod` for the precedent). - requireCurrencyPairQuote(functionName): string; default: not declared - requireCurrencyPairQuote(label): string; default: not declared - requireCurrencyPairQuote(quote): import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared - requireCurrencyPairQuote(quote).baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - requireCurrencyPairQuote(quote).quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - requireCurrencyPairQuote(quote).quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - spotForwardHedgedProfitAndLoss: (input: import('@insiderfinance/totalfinance/foreign-exchange').SpotForwardHedgedProfitAndLossInput) => import('@insiderfinance/totalfinance/foreign-exchange').SpotForwardHedgedProfitAndLossResult; default: not declared — P&L of a base-currency position that hedged `hedgedFraction` of its notional at a forward. The decomposition is exact and disclosed: the unhedged part rides the spot move `(finalSpot − initialSpot)`, the hedged part locked `(forwardRateAtHedge − initialSpot)` the moment the hedge was placed, and the total is their notional-weighted sum in the QUOTE currency. `hedgedFraction: 0` is the pure spot P&L; `hedgedFraction: 1` is fully locked at the forward and indifferent to the final spot. `forwardRateAtHedge` is REQUIRED whenever `hedgedFraction` > 0. - spotForwardHedgedProfitAndLoss().return.assumptions: { decomposition: typeof import('@insiderfinance/totalfinance/foreign-exchange').HEDGED_PROFIT_AND_LOSS_DECOMPOSITION; hedgedFraction: number; notionalDirection: string; }; default: not declared - spotForwardHedgedProfitAndLoss().return.assumptions.decomposition: 'totalProfitAndLossInQuoteCurrency = (1 − hedgedFraction) × (finalSpotRate.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount + hedgedFraction × (forwardRateAtHedge.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount, every term in the quote currency'; default: not declared - spotForwardHedgedProfitAndLoss().return.assumptions.hedgedFraction: number; default: not declared - spotForwardHedgedProfitAndLoss().return.assumptions.notionalDirection: string; default: not declared — The fixed direction prose: positive notional is long the base; negative flips every sign. - spotForwardHedgedProfitAndLoss().return.diagnostics: import('@insiderfinance/totalfinance/foreign-exchange').ForeignExchangeDiagnostics; default: not declared - spotForwardHedgedProfitAndLoss().return.hedgedComponent: number; default: not declared — `hedgedFraction × (forwardRateAtHedge − initialSpot) × notional` — the part locked at the forward. - spotForwardHedgedProfitAndLoss().return.totalProfitAndLossInQuoteCurrency: number; default: not declared - spotForwardHedgedProfitAndLoss().return.unhedgedComponent: number; default: not declared — `(1 − hedgedFraction) × (finalSpot − initialSpot) × notional` — the part left floating. - spotForwardHedgedProfitAndLoss(input): import('@insiderfinance/totalfinance/foreign-exchange').SpotForwardHedgedProfitAndLossInput; default: not declared - spotForwardHedgedProfitAndLoss(input).finalSpotRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The spot at measurement, SAME pair, SAME direction. - spotForwardHedgedProfitAndLoss(input).forwardRateAtHedge?: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The forward locked when the hedge was placed. REQUIRED whenever `hedgedFraction` > 0. - spotForwardHedgedProfitAndLoss(input).hedgedFraction: number; default: not declared — Fraction of the notional hedged at the forward, in [0, 1]. - spotForwardHedgedProfitAndLoss(input).initialSpotRate: import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote; default: not declared — The spot when the position was opened. - spotForwardHedgedProfitAndLoss(input).notionalBaseAmount: number; default: not declared — Position size in BASE-currency units; positive = long the base currency, negative flips every sign. ### @insiderfinance/totalfinance#fundamentals Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const fundamentals: typeof import('@insiderfinance/totalfinance/fundamentals'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualRatio: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - accrualRatio(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - accrualRatio(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - accrualRatio(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - accrualRatio.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - accrualRatio.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - accrualRatio.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - accrualRatio.explain().return.assumptions.conventionsVersion: string; default: not declared - accrualRatio.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - accrualRatio.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - accrualRatio.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - accrualRatio.explain().return.assumptions.ratioName: string; default: not declared - accrualRatio.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - accrualRatio.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - accrualRatio.explain().return.diagnostics.denominator.amount: number; default: not declared - accrualRatio.explain().return.diagnostics.denominator.label: string; default: not declared - accrualRatio.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - accrualRatio.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - accrualRatio.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - accrualRatio.explain().return.diagnostics.numerator.amount: number; default: not declared - accrualRatio.explain().return.diagnostics.numerator.label: string; default: not declared - accrualRatio.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - accrualRatio.explain().return.diagnostics.warnings: string[]; default: not declared - accrualRatio.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - accrualRatio.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - accrualRatio.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - accrualRatio.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - altmanZScore: (input: import('@insiderfinance/totalfinance/fundamentals').AltmanInput) => import('@insiderfinance/totalfinance/fundamentals').AltmanResult; default: not declared — The Altman Z-score with the published coefficients and denominator definitions per variant. `X1` working capital / assets, `X2` retained earnings / assets, `X3` operating income / assets, `X4` the variant's equity basis / total liabilities, `X5` sales / assets where the variant has one. The variant is REQUIRED — there is no default bankruptcy model. - altmanZScore().return.assumptions: { model: string; variant: import('@insiderfinance/totalfinance/fundamentals').AltmanVariant; equityBasis: 'market' | 'book'; }; default: not declared - altmanZScore().return.assumptions.equityBasis: 'market' | 'book'; default: not declared - altmanZScore().return.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - altmanZScore().return.assumptions.variant: import('@insiderfinance/totalfinance/fundamentals').AltmanVariant; default: not declared - altmanZScore().return.components: import('@insiderfinance/totalfinance/fundamentals').AltmanComponent[]; default: not declared - altmanZScore().return.diagnostics: { warnings: string[]; }; default: not declared - altmanZScore().return.diagnostics.warnings: string[]; default: not declared - altmanZScore().return.variant: import('@insiderfinance/totalfinance/fundamentals').AltmanVariant; default: not declared - altmanZScore().return.zScore: number; default: not declared - altmanZScore(input): import('@insiderfinance/totalfinance/fundamentals').AltmanInput; default: not declared - altmanZScore(input).marketEquity?: number; default: not declared — REQUIRED for `public-manufacturing` (its X4 uses market equity); rejected otherwise. - altmanZScore(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - altmanZScore(input).variant: import('@insiderfinance/totalfinance/fundamentals').AltmanVariant; default: not declared - analyzeFundamentals: (input: import('@insiderfinance/totalfinance/fundamentals').AnalyzeFundamentalsInput) => import('@insiderfinance/totalfinance/fundamentals').AnalyzeFundamentalsResult; default: not declared — The one-call analysis. Missing inputs disable exactly the metrics that need them, each with a stated reason; nothing is guessed, proxied, or silently skipped. - analyzeFundamentals().return.asOf: number; default: not declared - analyzeFundamentals().return.assumptions: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; restatementPolicy: import('@insiderfinance/totalfinance/fundamentals').RestatementPolicy; periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; }; default: not declared - analyzeFundamentals().return.assumptions.asOf: number; default: not declared - analyzeFundamentals().return.assumptions.periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; default: not declared - analyzeFundamentals().return.assumptions.periodUsed.fiscalYear: number; default: not declared - analyzeFundamentals().return.assumptions.periodUsed.periodEndDate: string; default: not declared - analyzeFundamentals().return.assumptions.periodUsed.periodType: string; default: not declared - analyzeFundamentals().return.assumptions.priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; default: not declared - analyzeFundamentals().return.assumptions.priorPeriodUsed.fiscalYear: number; default: not declared - analyzeFundamentals().return.assumptions.priorPeriodUsed.periodEndDate: string; default: not declared - analyzeFundamentals().return.assumptions.priorPeriodUsed.periodType: string; default: not declared - analyzeFundamentals().return.assumptions.restatementPolicy: import('@insiderfinance/totalfinance/fundamentals').RestatementPolicy; default: not declared - analyzeFundamentals().return.diagnostics: { warnings: string[]; }; default: not declared - analyzeFundamentals().return.diagnostics.warnings: string[]; default: not declared — One warning per metric that could not be formed (mirrors `missing`). - analyzeFundamentals().return.missing: { metric: string; reason: string; }[]; default: not declared — Every metric that could not be formed, with its reason — the honest gaps ledger. - analyzeFundamentals().return.periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; default: not declared — The period the single-period metrics used. - analyzeFundamentals().return.periodUsed.fiscalYear: number; default: not declared - analyzeFundamentals().return.periodUsed.periodEndDate: string; default: not declared - analyzeFundamentals().return.periodUsed.periodType: string; default: not declared - analyzeFundamentals().return.periodsVisible: number; default: not declared — How many statement sets were visible at `asOf` after restatement resolution. - analyzeFundamentals().return.priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; default: not declared — The prior period the average-balance metrics used, when one was visible. - analyzeFundamentals().return.priorPeriodUsed.fiscalYear: number; default: not declared - analyzeFundamentals().return.priorPeriodUsed.periodEndDate: string; default: not declared - analyzeFundamentals().return.priorPeriodUsed.periodType: string; default: not declared - analyzeFundamentals().return.ratios: Record; default: not declared - analyzeFundamentals().return.restatementPolicy: import('@insiderfinance/totalfinance/fundamentals').RestatementPolicy; default: not declared - analyzeFundamentals().return.scores: { piotroski?: import('@insiderfinance/totalfinance/fundamentals').PiotroskiResult; altman?: import('@insiderfinance/totalfinance/fundamentals').AltmanResult; beneish?: import('@insiderfinance/totalfinance/fundamentals').BeneishResult; }; default: not declared - analyzeFundamentals().return.scores.altman?: import('@insiderfinance/totalfinance/fundamentals').AltmanResult; default: not declared - analyzeFundamentals().return.scores.beneish?: import('@insiderfinance/totalfinance/fundamentals').BeneishResult; default: not declared - analyzeFundamentals().return.scores.piotroski?: import('@insiderfinance/totalfinance/fundamentals').PiotroskiResult; default: not declared - analyzeFundamentals(input): import('@insiderfinance/totalfinance/fundamentals').AnalyzeFundamentalsInput; default: not declared - analyzeFundamentals(input).altmanVariant?: import('@insiderfinance/totalfinance/fundamentals').AltmanVariant; default: not declared — Runs the Altman Z-score under this explicit published variant; absent → reported missing. - analyzeFundamentals(input).asOf: number; default: not declared - analyzeFundamentals(input).debtServiceAmount?: number; default: not declared — The exact debt-service denominator; absent → debtServiceCoverage is reported missing. - analyzeFundamentals(input).marketSnapshot?: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared — The market side for valuation multiples; without it they are reported missing, not guessed. - analyzeFundamentals(input).maximumStalenessMs?: number; default: not declared — Bounds market-observation staleness for the multiples when supplied. - analyzeFundamentals(input).nonOperatingAssets?: number; default: not declared — Separately supplied non-operating assets for enterprise value. - analyzeFundamentals(input).periodDays?: number; default: not declared — Day metrics need the explicit period-day count; absent → they are reported missing. - analyzeFundamentals(input).restatementPolicy: import('@insiderfinance/totalfinance/fundamentals').RestatementPolicy; default: not declared - analyzeFundamentals(input).statements: readonly import('@insiderfinance/totalfinance/fundamentals').FinancialStatements[]; default: not declared — The reported history (restatements included) — the analysis sees only what `asOf` allows. - analyzeFundamentals(input).taxRate?: number; default: not declared — Explicit tax rate for return on invested capital; else the effective rate is derived. - assetTurnover: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - assetTurnover(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - assetTurnover(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - assetTurnover(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - assetTurnover.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - assetTurnover.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - assetTurnover.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - assetTurnover.explain().return.assumptions.conventionsVersion: string; default: not declared - assetTurnover.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - assetTurnover.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - assetTurnover.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - assetTurnover.explain().return.assumptions.ratioName: string; default: not declared - assetTurnover.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - assetTurnover.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - assetTurnover.explain().return.diagnostics.denominator.amount: number; default: not declared - assetTurnover.explain().return.diagnostics.denominator.label: string; default: not declared - assetTurnover.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - assetTurnover.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - assetTurnover.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - assetTurnover.explain().return.diagnostics.numerator.amount: number; default: not declared - assetTurnover.explain().return.diagnostics.numerator.label: string; default: not declared - assetTurnover.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - assetTurnover.explain().return.diagnostics.warnings: string[]; default: not declared - assetTurnover.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - assetTurnover.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - assetTurnover.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - assetTurnover.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - beneishMScore: (input: import('@insiderfinance/totalfinance/fundamentals').BeneishInput) => import('@insiderfinance/totalfinance/fundamentals').BeneishResult; default: not declared — The original eight-variable 1999 Beneish equation `-4.84 + 0.920 DSRI + 0.528 GMI + 0.404 AQI + 0.892 SGI + 0.115 DEPI - 0.172 SGAI + 4.679 TATA - 0.327 LVGI`, with the component definitions fixed to the paper. Every variable the model needs must be present in both periods — there is NO five-variable fallback, silent or otherwise. - beneishMScore().return.assumptions: { model: string; }; default: not declared - beneishMScore().return.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - beneishMScore().return.components: import('@insiderfinance/totalfinance/fundamentals').BeneishComponent[]; default: not declared - beneishMScore().return.diagnostics: { warnings: string[]; }; default: not declared - beneishMScore().return.diagnostics.warnings: string[]; default: not declared — Conventions the inputs forced (e.g. D&A standing in for pure depreciation) — disclosed. - beneishMScore().return.mScore: number; default: not declared - beneishMScore().return.notes: string[]; default: not declared — The same disclosures as `diagnostics.warnings` (kept for direct reading). - beneishMScore(input): import('@insiderfinance/totalfinance/fundamentals').BeneishInput; default: not declared - beneishMScore(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - beneishMScore(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - bookValuePerShare: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - bookValuePerShare(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - bookValuePerShare(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - bookValuePerShare.explain: (input: import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - bookValuePerShare.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - bookValuePerShare.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - bookValuePerShare.explain().return.assumptions.conventionsVersion: string; default: not declared - bookValuePerShare.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - bookValuePerShare.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - bookValuePerShare.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - bookValuePerShare.explain().return.assumptions.ratioName: string; default: not declared - bookValuePerShare.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - bookValuePerShare.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - bookValuePerShare.explain().return.diagnostics.denominator.amount: number; default: not declared - bookValuePerShare.explain().return.diagnostics.denominator.label: string; default: not declared - bookValuePerShare.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - bookValuePerShare.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - bookValuePerShare.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - bookValuePerShare.explain().return.diagnostics.numerator.amount: number; default: not declared - bookValuePerShare.explain().return.diagnostics.numerator.label: string; default: not declared - bookValuePerShare.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - bookValuePerShare.explain().return.diagnostics.warnings: string[]; default: not declared - bookValuePerShare.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - bookValuePerShare.explain(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - bookValuePerShare.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashConversionCycle: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - cashConversionCycle(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - cashConversionCycle(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashConversionCycle(input).periodDays: number; default: not declared - cashConversionCycle(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashConversionCycle.explain: (input: import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - cashConversionCycle.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - cashConversionCycle.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - cashConversionCycle.explain().return.assumptions.conventionsVersion: string; default: not declared - cashConversionCycle.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - cashConversionCycle.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashConversionCycle.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashConversionCycle.explain().return.assumptions.ratioName: string; default: not declared - cashConversionCycle.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - cashConversionCycle.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - cashConversionCycle.explain().return.diagnostics.denominator.amount: number; default: not declared - cashConversionCycle.explain().return.diagnostics.denominator.label: string; default: not declared - cashConversionCycle.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - cashConversionCycle.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - cashConversionCycle.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - cashConversionCycle.explain().return.diagnostics.numerator.amount: number; default: not declared - cashConversionCycle.explain().return.diagnostics.numerator.label: string; default: not declared - cashConversionCycle.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - cashConversionCycle.explain().return.diagnostics.warnings: string[]; default: not declared - cashConversionCycle.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - cashConversionCycle.explain(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - cashConversionCycle.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashConversionCycle.explain(input).periodDays: number; default: not declared - cashConversionCycle.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashFlowToNetIncome: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - cashFlowToNetIncome(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - cashFlowToNetIncome(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashFlowToNetIncome.explain: (input: import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - cashFlowToNetIncome.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - cashFlowToNetIncome.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - cashFlowToNetIncome.explain().return.assumptions.conventionsVersion: string; default: not declared - cashFlowToNetIncome.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - cashFlowToNetIncome.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashFlowToNetIncome.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashFlowToNetIncome.explain().return.assumptions.ratioName: string; default: not declared - cashFlowToNetIncome.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.denominator.amount: number; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.denominator.label: string; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - cashFlowToNetIncome.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - cashFlowToNetIncome.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.numerator.amount: number; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.numerator.label: string; default: not declared - cashFlowToNetIncome.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - cashFlowToNetIncome.explain().return.diagnostics.warnings: string[]; default: not declared - cashFlowToNetIncome.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - cashFlowToNetIncome.explain(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - cashFlowToNetIncome.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashRatio: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - cashRatio(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - cashRatio(input).balance: Pick & Partial; default: not declared - cashRatio(input).balance.accountsPayable?: number; default: not declared - cashRatio(input).balance.accountsReceivable?: number; default: not declared - cashRatio(input).balance.cashAndCashEquivalents?: number; default: not declared - cashRatio(input).balance.currentAssets?: number; default: not declared - cashRatio(input).balance.currentLiabilities?: number; default: not declared - cashRatio(input).balance.inventory?: number; default: not declared - cashRatio(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - cashRatio(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - cashRatio(input).balance.minorityInterest?: number; default: not declared - cashRatio(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - cashRatio(input).balance.preferredEquity?: number; default: not declared - cashRatio(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - cashRatio(input).balance.retainedEarnings?: number; default: not declared - cashRatio(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - cashRatio(input).balance.shortTermInvestments?: number; default: not declared - cashRatio(input).balance.totalAssets?: number; default: not declared - cashRatio(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - cashRatio(input).balance.totalEquity?: number; default: not declared - cashRatio(input).balance.totalLiabilities?: number; default: not declared - cashRatio(input).statements?: never; default: not declared - cashRatio.explain: (input: import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - cashRatio.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - cashRatio.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - cashRatio.explain().return.assumptions.conventionsVersion: string; default: not declared - cashRatio.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - cashRatio.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashRatio.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashRatio.explain().return.assumptions.ratioName: string; default: not declared - cashRatio.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - cashRatio.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - cashRatio.explain().return.diagnostics.denominator.amount: number; default: not declared - cashRatio.explain().return.diagnostics.denominator.label: string; default: not declared - cashRatio.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - cashRatio.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - cashRatio.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - cashRatio.explain().return.diagnostics.numerator.amount: number; default: not declared - cashRatio.explain().return.diagnostics.numerator.label: string; default: not declared - cashRatio.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - cashRatio.explain().return.diagnostics.warnings: string[]; default: not declared - cashRatio.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - cashRatio.explain(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - cashRatio.explain(input).balance: Pick & Partial; default: not declared - cashRatio.explain(input).balance.accountsPayable?: number; default: not declared - cashRatio.explain(input).balance.accountsReceivable?: number; default: not declared - cashRatio.explain(input).balance.cashAndCashEquivalents?: number; default: not declared - cashRatio.explain(input).balance.currentAssets?: number; default: not declared - cashRatio.explain(input).balance.currentLiabilities?: number; default: not declared - cashRatio.explain(input).balance.inventory?: number; default: not declared - cashRatio.explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - cashRatio.explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - cashRatio.explain(input).balance.minorityInterest?: number; default: not declared - cashRatio.explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - cashRatio.explain(input).balance.preferredEquity?: number; default: not declared - cashRatio.explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - cashRatio.explain(input).balance.retainedEarnings?: number; default: not declared - cashRatio.explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - cashRatio.explain(input).balance.shortTermInvestments?: number; default: not declared - cashRatio.explain(input).balance.totalAssets?: number; default: not declared - cashRatio.explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - cashRatio.explain(input).balance.totalEquity?: number; default: not declared - cashRatio.explain(input).balance.totalLiabilities?: number; default: not declared - cashRatio.explain(input).statements?: never; default: not declared - cashReturnOnAssets: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - cashReturnOnAssets(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - cashReturnOnAssets(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashReturnOnAssets(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashReturnOnAssets.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - cashReturnOnAssets.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - cashReturnOnAssets.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - cashReturnOnAssets.explain().return.assumptions.conventionsVersion: string; default: not declared - cashReturnOnAssets.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - cashReturnOnAssets.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashReturnOnAssets.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - cashReturnOnAssets.explain().return.assumptions.ratioName: string; default: not declared - cashReturnOnAssets.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - cashReturnOnAssets.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - cashReturnOnAssets.explain().return.diagnostics.denominator.amount: number; default: not declared - cashReturnOnAssets.explain().return.diagnostics.denominator.label: string; default: not declared - cashReturnOnAssets.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - cashReturnOnAssets.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - cashReturnOnAssets.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - cashReturnOnAssets.explain().return.diagnostics.numerator.amount: number; default: not declared - cashReturnOnAssets.explain().return.diagnostics.numerator.label: string; default: not declared - cashReturnOnAssets.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - cashReturnOnAssets.explain().return.diagnostics.warnings: string[]; default: not declared - cashReturnOnAssets.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - cashReturnOnAssets.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - cashReturnOnAssets.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - cashReturnOnAssets.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - commonSizeFinancialStatements: (input: import('@insiderfinance/totalfinance/fundamentals').CommonSizeInput) => import('@insiderfinance/totalfinance/fundamentals').CommonSizeResult; default: not declared — Common-size statements: every reported numeric line divided by its conventional base — income and cash-flow lines by revenue, balance lines by total assets. Fractions, never display percentages. A zero base is an error naming itself, not an Infinity. - commonSizeFinancialStatements().return.assumptions: { incomeBasis: 'revenue'; balanceBasis: 'totalAssets'; cashFlowBasis: 'revenue'; }; default: not declared - commonSizeFinancialStatements().return.assumptions.balanceBasis: 'totalAssets'; default: not declared - commonSizeFinancialStatements().return.assumptions.cashFlowBasis: 'revenue'; default: not declared - commonSizeFinancialStatements().return.assumptions.incomeBasis: 'revenue'; default: not declared - commonSizeFinancialStatements().return.balance: { basis: 'totalAssets'; lines: Record; }; default: not declared — Balance lines over `totalAssets`. - commonSizeFinancialStatements().return.balance.basis: 'totalAssets'; default: not declared - commonSizeFinancialStatements().return.balance.lines: Record; default: not declared - commonSizeFinancialStatements().return.cashFlow: { basis: 'revenue'; lines: Record; }; default: not declared — Cash-flow lines over `revenue`. - commonSizeFinancialStatements().return.cashFlow.basis: 'revenue'; default: not declared - commonSizeFinancialStatements().return.cashFlow.lines: Record; default: not declared - commonSizeFinancialStatements().return.diagnostics: { warnings: string[]; }; default: not declared - commonSizeFinancialStatements().return.diagnostics.warnings: string[]; default: not declared - commonSizeFinancialStatements().return.income: { basis: 'revenue'; lines: Record; }; default: not declared — Income lines over `revenue`. - commonSizeFinancialStatements().return.income.basis: 'revenue'; default: not declared - commonSizeFinancialStatements().return.income.lines: Record; default: not declared - commonSizeFinancialStatements(input): import('@insiderfinance/totalfinance/fundamentals').CommonSizeInput; default: not declared - commonSizeFinancialStatements(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - currentRatio: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - currentRatio(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - currentRatio(input).balance: Pick & Partial; default: not declared - currentRatio(input).balance.accountsPayable?: number; default: not declared - currentRatio(input).balance.accountsReceivable?: number; default: not declared - currentRatio(input).balance.cashAndCashEquivalents?: number; default: not declared - currentRatio(input).balance.currentAssets?: number; default: not declared - currentRatio(input).balance.currentLiabilities?: number; default: not declared - currentRatio(input).balance.inventory?: number; default: not declared - currentRatio(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - currentRatio(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - currentRatio(input).balance.minorityInterest?: number; default: not declared - currentRatio(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - currentRatio(input).balance.preferredEquity?: number; default: not declared - currentRatio(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - currentRatio(input).balance.retainedEarnings?: number; default: not declared - currentRatio(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - currentRatio(input).balance.shortTermInvestments?: number; default: not declared - currentRatio(input).balance.totalAssets?: number; default: not declared - currentRatio(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - currentRatio(input).balance.totalEquity?: number; default: not declared - currentRatio(input).balance.totalLiabilities?: number; default: not declared - currentRatio(input).statements?: never; default: not declared - currentRatio.explain: (input: import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - currentRatio.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - currentRatio.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - currentRatio.explain().return.assumptions.conventionsVersion: string; default: not declared - currentRatio.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - currentRatio.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - currentRatio.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - currentRatio.explain().return.assumptions.ratioName: string; default: not declared - currentRatio.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - currentRatio.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - currentRatio.explain().return.diagnostics.denominator.amount: number; default: not declared - currentRatio.explain().return.diagnostics.denominator.label: string; default: not declared - currentRatio.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - currentRatio.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - currentRatio.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - currentRatio.explain().return.diagnostics.numerator.amount: number; default: not declared - currentRatio.explain().return.diagnostics.numerator.label: string; default: not declared - currentRatio.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - currentRatio.explain().return.diagnostics.warnings: string[]; default: not declared - currentRatio.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - currentRatio.explain(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - currentRatio.explain(input).balance: Pick & Partial; default: not declared - currentRatio.explain(input).balance.accountsPayable?: number; default: not declared - currentRatio.explain(input).balance.accountsReceivable?: number; default: not declared - currentRatio.explain(input).balance.cashAndCashEquivalents?: number; default: not declared - currentRatio.explain(input).balance.currentAssets?: number; default: not declared - currentRatio.explain(input).balance.currentLiabilities?: number; default: not declared - currentRatio.explain(input).balance.inventory?: number; default: not declared - currentRatio.explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - currentRatio.explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - currentRatio.explain(input).balance.minorityInterest?: number; default: not declared - currentRatio.explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - currentRatio.explain(input).balance.preferredEquity?: number; default: not declared - currentRatio.explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - currentRatio.explain(input).balance.retainedEarnings?: number; default: not declared - currentRatio.explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - currentRatio.explain(input).balance.shortTermInvestments?: number; default: not declared - currentRatio.explain(input).balance.totalAssets?: number; default: not declared - currentRatio.explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - currentRatio.explain(input).balance.totalEquity?: number; default: not declared - currentRatio.explain(input).balance.totalLiabilities?: number; default: not declared - currentRatio.explain(input).statements?: never; default: not declared - daysInventoryOutstanding: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - daysInventoryOutstanding(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - daysInventoryOutstanding(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysInventoryOutstanding(input).periodDays: number; default: not declared - daysInventoryOutstanding(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysInventoryOutstanding.explain: (input: import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - daysInventoryOutstanding.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - daysInventoryOutstanding.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - daysInventoryOutstanding.explain().return.assumptions.conventionsVersion: string; default: not declared - daysInventoryOutstanding.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - daysInventoryOutstanding.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - daysInventoryOutstanding.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - daysInventoryOutstanding.explain().return.assumptions.ratioName: string; default: not declared - daysInventoryOutstanding.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.denominator.amount: number; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.denominator.label: string; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - daysInventoryOutstanding.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - daysInventoryOutstanding.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.numerator.amount: number; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.numerator.label: string; default: not declared - daysInventoryOutstanding.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - daysInventoryOutstanding.explain().return.diagnostics.warnings: string[]; default: not declared - daysInventoryOutstanding.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - daysInventoryOutstanding.explain(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - daysInventoryOutstanding.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysInventoryOutstanding.explain(input).periodDays: number; default: not declared - daysInventoryOutstanding.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysPayablesOutstanding: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - daysPayablesOutstanding(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - daysPayablesOutstanding(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysPayablesOutstanding(input).periodDays: number; default: not declared - daysPayablesOutstanding(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysPayablesOutstanding.explain: (input: import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - daysPayablesOutstanding.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - daysPayablesOutstanding.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - daysPayablesOutstanding.explain().return.assumptions.conventionsVersion: string; default: not declared - daysPayablesOutstanding.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - daysPayablesOutstanding.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - daysPayablesOutstanding.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - daysPayablesOutstanding.explain().return.assumptions.ratioName: string; default: not declared - daysPayablesOutstanding.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.denominator.amount: number; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.denominator.label: string; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - daysPayablesOutstanding.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - daysPayablesOutstanding.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.numerator.amount: number; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.numerator.label: string; default: not declared - daysPayablesOutstanding.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - daysPayablesOutstanding.explain().return.diagnostics.warnings: string[]; default: not declared - daysPayablesOutstanding.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - daysPayablesOutstanding.explain(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - daysPayablesOutstanding.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysPayablesOutstanding.explain(input).periodDays: number; default: not declared - daysPayablesOutstanding.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysSalesOutstanding: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - daysSalesOutstanding(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - daysSalesOutstanding(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysSalesOutstanding(input).periodDays: number; default: not declared - daysSalesOutstanding(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysSalesOutstanding.explain: (input: import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - daysSalesOutstanding.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - daysSalesOutstanding.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - daysSalesOutstanding.explain().return.assumptions.conventionsVersion: string; default: not declared - daysSalesOutstanding.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - daysSalesOutstanding.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - daysSalesOutstanding.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - daysSalesOutstanding.explain().return.assumptions.ratioName: string; default: not declared - daysSalesOutstanding.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - daysSalesOutstanding.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - daysSalesOutstanding.explain().return.diagnostics.denominator.amount: number; default: not declared - daysSalesOutstanding.explain().return.diagnostics.denominator.label: string; default: not declared - daysSalesOutstanding.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - daysSalesOutstanding.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - daysSalesOutstanding.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - daysSalesOutstanding.explain().return.diagnostics.numerator.amount: number; default: not declared - daysSalesOutstanding.explain().return.diagnostics.numerator.label: string; default: not declared - daysSalesOutstanding.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - daysSalesOutstanding.explain().return.diagnostics.warnings: string[]; default: not declared - daysSalesOutstanding.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - daysSalesOutstanding.explain(input): import('@insiderfinance/totalfinance/fundamentals').DayMetricRatioInput; default: not declared - daysSalesOutstanding.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - daysSalesOutstanding.explain(input).periodDays: number; default: not declared - daysSalesOutstanding.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - debtServiceCoverage: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - debtServiceCoverage(input): import('@insiderfinance/totalfinance/fundamentals').DebtServiceCoverageInput; default: not declared - debtServiceCoverage.explain: (input: import('@insiderfinance/totalfinance/fundamentals').DebtServiceCoverageInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - debtServiceCoverage.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - debtServiceCoverage.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - debtServiceCoverage.explain().return.assumptions.conventionsVersion: string; default: not declared - debtServiceCoverage.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - debtServiceCoverage.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - debtServiceCoverage.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - debtServiceCoverage.explain().return.assumptions.ratioName: string; default: not declared - debtServiceCoverage.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - debtServiceCoverage.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - debtServiceCoverage.explain().return.diagnostics.denominator.amount: number; default: not declared - debtServiceCoverage.explain().return.diagnostics.denominator.label: string; default: not declared - debtServiceCoverage.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - debtServiceCoverage.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - debtServiceCoverage.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - debtServiceCoverage.explain().return.diagnostics.numerator.amount: number; default: not declared - debtServiceCoverage.explain().return.diagnostics.numerator.label: string; default: not declared - debtServiceCoverage.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - debtServiceCoverage.explain().return.diagnostics.warnings: string[]; default: not declared - debtServiceCoverage.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - debtServiceCoverage.explain(input): import('@insiderfinance/totalfinance/fundamentals').DebtServiceCoverageInput; default: not declared - debtToAssets: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - debtToAssets(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - debtToAssets(input).balance: Pick & Partial; default: not declared - debtToAssets(input).balance.accountsPayable?: number; default: not declared - debtToAssets(input).balance.accountsReceivable?: number; default: not declared - debtToAssets(input).balance.cashAndCashEquivalents?: number; default: not declared - debtToAssets(input).balance.currentAssets?: number; default: not declared - debtToAssets(input).balance.currentLiabilities?: number; default: not declared - debtToAssets(input).balance.inventory?: number; default: not declared - debtToAssets(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - debtToAssets(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - debtToAssets(input).balance.minorityInterest?: number; default: not declared - debtToAssets(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - debtToAssets(input).balance.preferredEquity?: number; default: not declared - debtToAssets(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - debtToAssets(input).balance.retainedEarnings?: number; default: not declared - debtToAssets(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - debtToAssets(input).balance.shortTermInvestments?: number; default: not declared - debtToAssets(input).balance.totalAssets?: number; default: not declared - debtToAssets(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - debtToAssets(input).balance.totalEquity?: number; default: not declared - debtToAssets(input).balance.totalLiabilities?: number; default: not declared - debtToAssets(input).statements?: never; default: not declared - debtToAssets.explain: (input: import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - debtToAssets.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - debtToAssets.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - debtToAssets.explain().return.assumptions.conventionsVersion: string; default: not declared - debtToAssets.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - debtToAssets.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - debtToAssets.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - debtToAssets.explain().return.assumptions.ratioName: string; default: not declared - debtToAssets.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - debtToAssets.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - debtToAssets.explain().return.diagnostics.denominator.amount: number; default: not declared - debtToAssets.explain().return.diagnostics.denominator.label: string; default: not declared - debtToAssets.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - debtToAssets.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - debtToAssets.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - debtToAssets.explain().return.diagnostics.numerator.amount: number; default: not declared - debtToAssets.explain().return.diagnostics.numerator.label: string; default: not declared - debtToAssets.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - debtToAssets.explain().return.diagnostics.warnings: string[]; default: not declared - debtToAssets.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - debtToAssets.explain(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - debtToAssets.explain(input).balance: Pick & Partial; default: not declared - debtToAssets.explain(input).balance.accountsPayable?: number; default: not declared - debtToAssets.explain(input).balance.accountsReceivable?: number; default: not declared - debtToAssets.explain(input).balance.cashAndCashEquivalents?: number; default: not declared - debtToAssets.explain(input).balance.currentAssets?: number; default: not declared - debtToAssets.explain(input).balance.currentLiabilities?: number; default: not declared - debtToAssets.explain(input).balance.inventory?: number; default: not declared - debtToAssets.explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - debtToAssets.explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - debtToAssets.explain(input).balance.minorityInterest?: number; default: not declared - debtToAssets.explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - debtToAssets.explain(input).balance.preferredEquity?: number; default: not declared - debtToAssets.explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - debtToAssets.explain(input).balance.retainedEarnings?: number; default: not declared - debtToAssets.explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - debtToAssets.explain(input).balance.shortTermInvestments?: number; default: not declared - debtToAssets.explain(input).balance.totalAssets?: number; default: not declared - debtToAssets.explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - debtToAssets.explain(input).balance.totalEquity?: number; default: not declared - debtToAssets.explain(input).balance.totalLiabilities?: number; default: not declared - debtToAssets.explain(input).statements?: never; default: not declared - debtToEquity: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - debtToEquity(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - debtToEquity(input).balance: Pick & Partial; default: not declared - debtToEquity(input).balance.accountsPayable?: number; default: not declared - debtToEquity(input).balance.accountsReceivable?: number; default: not declared - debtToEquity(input).balance.cashAndCashEquivalents?: number; default: not declared - debtToEquity(input).balance.currentAssets?: number; default: not declared - debtToEquity(input).balance.currentLiabilities?: number; default: not declared - debtToEquity(input).balance.inventory?: number; default: not declared - debtToEquity(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - debtToEquity(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - debtToEquity(input).balance.minorityInterest?: number; default: not declared - debtToEquity(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - debtToEquity(input).balance.preferredEquity?: number; default: not declared - debtToEquity(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - debtToEquity(input).balance.retainedEarnings?: number; default: not declared - debtToEquity(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - debtToEquity(input).balance.shortTermInvestments?: number; default: not declared - debtToEquity(input).balance.totalAssets?: number; default: not declared - debtToEquity(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - debtToEquity(input).balance.totalEquity?: number; default: not declared - debtToEquity(input).balance.totalLiabilities?: number; default: not declared - debtToEquity(input).statements?: never; default: not declared - debtToEquity.explain: (input: import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - debtToEquity.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - debtToEquity.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - debtToEquity.explain().return.assumptions.conventionsVersion: string; default: not declared - debtToEquity.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - debtToEquity.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - debtToEquity.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - debtToEquity.explain().return.assumptions.ratioName: string; default: not declared - debtToEquity.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - debtToEquity.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - debtToEquity.explain().return.diagnostics.denominator.amount: number; default: not declared - debtToEquity.explain().return.diagnostics.denominator.label: string; default: not declared - debtToEquity.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - debtToEquity.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - debtToEquity.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - debtToEquity.explain().return.diagnostics.numerator.amount: number; default: not declared - debtToEquity.explain().return.diagnostics.numerator.label: string; default: not declared - debtToEquity.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - debtToEquity.explain().return.diagnostics.warnings: string[]; default: not declared - debtToEquity.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - debtToEquity.explain(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - debtToEquity.explain(input).balance: Pick & Partial; default: not declared - debtToEquity.explain(input).balance.accountsPayable?: number; default: not declared - debtToEquity.explain(input).balance.accountsReceivable?: number; default: not declared - debtToEquity.explain(input).balance.cashAndCashEquivalents?: number; default: not declared - debtToEquity.explain(input).balance.currentAssets?: number; default: not declared - debtToEquity.explain(input).balance.currentLiabilities?: number; default: not declared - debtToEquity.explain(input).balance.inventory?: number; default: not declared - debtToEquity.explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - debtToEquity.explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - debtToEquity.explain(input).balance.minorityInterest?: number; default: not declared - debtToEquity.explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - debtToEquity.explain(input).balance.preferredEquity?: number; default: not declared - debtToEquity.explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - debtToEquity.explain(input).balance.retainedEarnings?: number; default: not declared - debtToEquity.explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - debtToEquity.explain(input).balance.shortTermInvestments?: number; default: not declared - debtToEquity.explain(input).balance.totalAssets?: number; default: not declared - debtToEquity.explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - debtToEquity.explain(input).balance.totalEquity?: number; default: not declared - debtToEquity.explain(input).balance.totalLiabilities?: number; default: not declared - debtToEquity.explain(input).statements?: never; default: not declared - dividendYield: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - dividendYield(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - dividendYield(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - dividendYield(input).maximumStalenessMs?: number; default: not declared - dividendYield(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - dividendYield.explain: (input: import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - dividendYield.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - dividendYield.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - dividendYield.explain().return.assumptions.conventionsVersion: string; default: not declared - dividendYield.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - dividendYield.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - dividendYield.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - dividendYield.explain().return.assumptions.ratioName: string; default: not declared - dividendYield.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - dividendYield.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - dividendYield.explain().return.diagnostics.denominator.amount: number; default: not declared - dividendYield.explain().return.diagnostics.denominator.label: string; default: not declared - dividendYield.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - dividendYield.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - dividendYield.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - dividendYield.explain().return.diagnostics.numerator.amount: number; default: not declared - dividendYield.explain().return.diagnostics.numerator.label: string; default: not declared - dividendYield.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - dividendYield.explain().return.diagnostics.warnings: string[]; default: not declared - dividendYield.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - dividendYield.explain(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - dividendYield.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - dividendYield.explain(input).maximumStalenessMs?: number; default: not declared - dividendYield.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - earningsPerShare: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - earningsPerShare(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - earningsPerShare(input).income: Pick & Partial; default: not declared - earningsPerShare(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - earningsPerShare(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - earningsPerShare(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - earningsPerShare(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - earningsPerShare(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - earningsPerShare(input).income.interestExpense?: number; default: not declared — Positive magnitude. - earningsPerShare(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - earningsPerShare(input).income.netIncome?: number; default: not declared - earningsPerShare(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - earningsPerShare(input).income.operatingIncome?: number; default: not declared - earningsPerShare(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - earningsPerShare(input).income.revenue?: number; default: not declared - earningsPerShare(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - earningsPerShare(input).statements?: never; default: not declared - earningsPerShare.explain: (input: import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - earningsPerShare.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - earningsPerShare.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - earningsPerShare.explain().return.assumptions.conventionsVersion: string; default: not declared - earningsPerShare.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - earningsPerShare.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - earningsPerShare.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - earningsPerShare.explain().return.assumptions.ratioName: string; default: not declared - earningsPerShare.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - earningsPerShare.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - earningsPerShare.explain().return.diagnostics.denominator.amount: number; default: not declared - earningsPerShare.explain().return.diagnostics.denominator.label: string; default: not declared - earningsPerShare.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - earningsPerShare.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - earningsPerShare.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - earningsPerShare.explain().return.diagnostics.numerator.amount: number; default: not declared - earningsPerShare.explain().return.diagnostics.numerator.label: string; default: not declared - earningsPerShare.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - earningsPerShare.explain().return.diagnostics.warnings: string[]; default: not declared - earningsPerShare.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - earningsPerShare.explain(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - earningsPerShare.explain(input).income: Pick & Partial; default: not declared - earningsPerShare.explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - earningsPerShare.explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - earningsPerShare.explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - earningsPerShare.explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - earningsPerShare.explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - earningsPerShare.explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - earningsPerShare.explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - earningsPerShare.explain(input).income.netIncome?: number; default: not declared - earningsPerShare.explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - earningsPerShare.explain(input).income.operatingIncome?: number; default: not declared - earningsPerShare.explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - earningsPerShare.explain(input).income.revenue?: number; default: not declared - earningsPerShare.explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - earningsPerShare.explain(input).statements?: never; default: not declared - earningsYield: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - earningsYield(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - earningsYield(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - earningsYield(input).maximumStalenessMs?: number; default: not declared - earningsYield(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - earningsYield.explain: (input: import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - earningsYield.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - earningsYield.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - earningsYield.explain().return.assumptions.conventionsVersion: string; default: not declared - earningsYield.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - earningsYield.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - earningsYield.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - earningsYield.explain().return.assumptions.ratioName: string; default: not declared - earningsYield.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - earningsYield.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - earningsYield.explain().return.diagnostics.denominator.amount: number; default: not declared - earningsYield.explain().return.diagnostics.denominator.label: string; default: not declared - earningsYield.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - earningsYield.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - earningsYield.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - earningsYield.explain().return.diagnostics.numerator.amount: number; default: not declared - earningsYield.explain().return.diagnostics.numerator.label: string; default: not declared - earningsYield.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - earningsYield.explain().return.diagnostics.warnings: string[]; default: not declared - earningsYield.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - earningsYield.explain(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - earningsYield.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - earningsYield.explain(input).maximumStalenessMs?: number; default: not declared - earningsYield.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - ebitdaMargin: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - ebitdaMargin(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - ebitdaMargin(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - ebitdaMargin.explain: (input: import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - ebitdaMargin.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - ebitdaMargin.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - ebitdaMargin.explain().return.assumptions.conventionsVersion: string; default: not declared - ebitdaMargin.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - ebitdaMargin.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - ebitdaMargin.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - ebitdaMargin.explain().return.assumptions.ratioName: string; default: not declared - ebitdaMargin.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - ebitdaMargin.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - ebitdaMargin.explain().return.diagnostics.denominator.amount: number; default: not declared - ebitdaMargin.explain().return.diagnostics.denominator.label: string; default: not declared - ebitdaMargin.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - ebitdaMargin.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - ebitdaMargin.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - ebitdaMargin.explain().return.diagnostics.numerator.amount: number; default: not declared - ebitdaMargin.explain().return.diagnostics.numerator.label: string; default: not declared - ebitdaMargin.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - ebitdaMargin.explain().return.diagnostics.warnings: string[]; default: not declared - ebitdaMargin.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - ebitdaMargin.explain(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - ebitdaMargin.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - enterpriseValueToEbitda: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - enterpriseValueToEbitda(input): import('@insiderfinance/totalfinance/fundamentals').EnterpriseMultipleRatioInput; default: not declared - enterpriseValueToEbitda(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - enterpriseValueToEbitda(input).maximumStalenessMs?: number; default: not declared - enterpriseValueToEbitda(input).nonOperatingAssets?: number; default: not declared - enterpriseValueToEbitda(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - enterpriseValueToEbitda.explain: (input: import('@insiderfinance/totalfinance/fundamentals').EnterpriseMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - enterpriseValueToEbitda.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - enterpriseValueToEbitda.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - enterpriseValueToEbitda.explain().return.assumptions.conventionsVersion: string; default: not declared - enterpriseValueToEbitda.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - enterpriseValueToEbitda.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - enterpriseValueToEbitda.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - enterpriseValueToEbitda.explain().return.assumptions.ratioName: string; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.denominator.amount: number; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.denominator.label: string; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - enterpriseValueToEbitda.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - enterpriseValueToEbitda.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.numerator.amount: number; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.numerator.label: string; default: not declared - enterpriseValueToEbitda.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - enterpriseValueToEbitda.explain().return.diagnostics.warnings: string[]; default: not declared - enterpriseValueToEbitda.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - enterpriseValueToEbitda.explain(input): import('@insiderfinance/totalfinance/fundamentals').EnterpriseMultipleRatioInput; default: not declared - enterpriseValueToEbitda.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - enterpriseValueToEbitda.explain(input).maximumStalenessMs?: number; default: not declared - enterpriseValueToEbitda.explain(input).nonOperatingAssets?: number; default: not declared - enterpriseValueToEbitda.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - enterpriseValueToRevenue: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - enterpriseValueToRevenue(input): import('@insiderfinance/totalfinance/fundamentals').EnterpriseMultipleRatioInput; default: not declared - enterpriseValueToRevenue(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - enterpriseValueToRevenue(input).maximumStalenessMs?: number; default: not declared - enterpriseValueToRevenue(input).nonOperatingAssets?: number; default: not declared - enterpriseValueToRevenue(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - enterpriseValueToRevenue.explain: (input: import('@insiderfinance/totalfinance/fundamentals').EnterpriseMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - enterpriseValueToRevenue.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - enterpriseValueToRevenue.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - enterpriseValueToRevenue.explain().return.assumptions.conventionsVersion: string; default: not declared - enterpriseValueToRevenue.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - enterpriseValueToRevenue.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - enterpriseValueToRevenue.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - enterpriseValueToRevenue.explain().return.assumptions.ratioName: string; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.denominator.amount: number; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.denominator.label: string; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - enterpriseValueToRevenue.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - enterpriseValueToRevenue.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.numerator.amount: number; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.numerator.label: string; default: not declared - enterpriseValueToRevenue.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - enterpriseValueToRevenue.explain().return.diagnostics.warnings: string[]; default: not declared - enterpriseValueToRevenue.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - enterpriseValueToRevenue.explain(input): import('@insiderfinance/totalfinance/fundamentals').EnterpriseMultipleRatioInput; default: not declared - enterpriseValueToRevenue.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - enterpriseValueToRevenue.explain(input).maximumStalenessMs?: number; default: not declared - enterpriseValueToRevenue.explain(input).nonOperatingAssets?: number; default: not declared - enterpriseValueToRevenue.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - freeCashFlowPerShare: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - freeCashFlowPerShare(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - freeCashFlowPerShare(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - freeCashFlowPerShare.explain: (input: import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - freeCashFlowPerShare.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - freeCashFlowPerShare.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - freeCashFlowPerShare.explain().return.assumptions.conventionsVersion: string; default: not declared - freeCashFlowPerShare.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - freeCashFlowPerShare.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - freeCashFlowPerShare.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - freeCashFlowPerShare.explain().return.assumptions.ratioName: string; default: not declared - freeCashFlowPerShare.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.denominator.amount: number; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.denominator.label: string; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - freeCashFlowPerShare.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - freeCashFlowPerShare.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.numerator.amount: number; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.numerator.label: string; default: not declared - freeCashFlowPerShare.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - freeCashFlowPerShare.explain().return.diagnostics.warnings: string[]; default: not declared - freeCashFlowPerShare.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - freeCashFlowPerShare.explain(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - freeCashFlowPerShare.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - freeCashFlowYield: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - freeCashFlowYield(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - freeCashFlowYield(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - freeCashFlowYield(input).maximumStalenessMs?: number; default: not declared - freeCashFlowYield(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - freeCashFlowYield.explain: (input: import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - freeCashFlowYield.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - freeCashFlowYield.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - freeCashFlowYield.explain().return.assumptions.conventionsVersion: string; default: not declared - freeCashFlowYield.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - freeCashFlowYield.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - freeCashFlowYield.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - freeCashFlowYield.explain().return.assumptions.ratioName: string; default: not declared - freeCashFlowYield.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - freeCashFlowYield.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - freeCashFlowYield.explain().return.diagnostics.denominator.amount: number; default: not declared - freeCashFlowYield.explain().return.diagnostics.denominator.label: string; default: not declared - freeCashFlowYield.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - freeCashFlowYield.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - freeCashFlowYield.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - freeCashFlowYield.explain().return.diagnostics.numerator.amount: number; default: not declared - freeCashFlowYield.explain().return.diagnostics.numerator.label: string; default: not declared - freeCashFlowYield.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - freeCashFlowYield.explain().return.diagnostics.warnings: string[]; default: not declared - freeCashFlowYield.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - freeCashFlowYield.explain(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - freeCashFlowYield.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - freeCashFlowYield.explain(input).maximumStalenessMs?: number; default: not declared - freeCashFlowYield.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - fundamentalGrowth: (input: import('@insiderfinance/totalfinance/fundamentals').FundamentalGrowthInput) => import('@insiderfinance/totalfinance/fundamentals').FundamentalGrowthResult; default: not declared — Period-over-period and compound annual growth of one fundamental amount. - fundamentalGrowth().return.assumptions: { elapsedYearsBasis: string; observationCount: number; }; default: not declared - fundamentalGrowth().return.assumptions.elapsedYearsBasis: string; default: not declared — Elapsed time between period ends is an ACT/365F year fraction (a label, not a literal). - fundamentalGrowth().return.assumptions.observationCount: number; default: not declared - fundamentalGrowth().return.compoundAnnualGrowthRate: number | null; default: not declared — Compound annual growth from the first to the last observation over the ACTUAL elapsed years (ACT/365F between the period ends), or `null` with the reason when the endpoints make the exponent meaningless (non-positive start, sign change, or zero elapsed time). - fundamentalGrowth().return.compoundAnnualGrowthReason?: string; default: not declared - fundamentalGrowth().return.diagnostics: { warnings: string[]; }; default: not declared - fundamentalGrowth().return.diagnostics.warnings: string[]; default: not declared — Every null growth's reason surfaces here too, so a reader scans one place. - fundamentalGrowth().return.elapsedYears: number; default: not declared - fundamentalGrowth().return.periodOverPeriod: { fromPeriodEndDate: string; toPeriodEndDate: string; growth: number | null; reason?: string; }[]; default: not declared — One row per adjacent pair: fractional growth `current / prior - 1`, or `null` with the reason when the prior amount is zero or the pair crosses sign (a growth rate through zero has no meaningful magnitude). - fundamentalGrowth(input): import('@insiderfinance/totalfinance/fundamentals').FundamentalGrowthInput; default: not declared - fundamentalGrowth(input).observations: readonly { periodEndDate: string; amount: number; }[]; default: not declared — At least two observations of one amount, period end ascending. - grossMargin: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - grossMargin(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - grossMargin(input).income: Pick & Partial; default: not declared - grossMargin(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - grossMargin(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - grossMargin(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - grossMargin(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - grossMargin(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - grossMargin(input).income.interestExpense?: number; default: not declared — Positive magnitude. - grossMargin(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - grossMargin(input).income.netIncome?: number; default: not declared - grossMargin(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - grossMargin(input).income.operatingIncome?: number; default: not declared - grossMargin(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - grossMargin(input).income.revenue?: number; default: not declared - grossMargin(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - grossMargin(input).statements?: never; default: not declared - grossMargin.explain: (input: import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - grossMargin.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - grossMargin.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - grossMargin.explain().return.assumptions.conventionsVersion: string; default: not declared - grossMargin.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - grossMargin.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - grossMargin.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - grossMargin.explain().return.assumptions.ratioName: string; default: not declared - grossMargin.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - grossMargin.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - grossMargin.explain().return.diagnostics.denominator.amount: number; default: not declared - grossMargin.explain().return.diagnostics.denominator.label: string; default: not declared - grossMargin.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - grossMargin.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - grossMargin.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - grossMargin.explain().return.diagnostics.numerator.amount: number; default: not declared - grossMargin.explain().return.diagnostics.numerator.label: string; default: not declared - grossMargin.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - grossMargin.explain().return.diagnostics.warnings: string[]; default: not declared - grossMargin.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - grossMargin.explain(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - grossMargin.explain(input).income: Pick & Partial; default: not declared - grossMargin.explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - grossMargin.explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - grossMargin.explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - grossMargin.explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - grossMargin.explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - grossMargin.explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - grossMargin.explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - grossMargin.explain(input).income.netIncome?: number; default: not declared - grossMargin.explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - grossMargin.explain(input).income.operatingIncome?: number; default: not declared - grossMargin.explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - grossMargin.explain(input).income.revenue?: number; default: not declared - grossMargin.explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - grossMargin.explain(input).statements?: never; default: not declared - interestCoverage: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - interestCoverage(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - interestCoverage(input).income: Pick & Partial; default: not declared - interestCoverage(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - interestCoverage(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - interestCoverage(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - interestCoverage(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - interestCoverage(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - interestCoverage(input).income.interestExpense?: number; default: not declared — Positive magnitude. - interestCoverage(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - interestCoverage(input).income.netIncome?: number; default: not declared - interestCoverage(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - interestCoverage(input).income.operatingIncome?: number; default: not declared - interestCoverage(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - interestCoverage(input).income.revenue?: number; default: not declared - interestCoverage(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - interestCoverage(input).statements?: never; default: not declared - interestCoverage.explain: (input: import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - interestCoverage.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - interestCoverage.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - interestCoverage.explain().return.assumptions.conventionsVersion: string; default: not declared - interestCoverage.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - interestCoverage.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - interestCoverage.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - interestCoverage.explain().return.assumptions.ratioName: string; default: not declared - interestCoverage.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - interestCoverage.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - interestCoverage.explain().return.diagnostics.denominator.amount: number; default: not declared - interestCoverage.explain().return.diagnostics.denominator.label: string; default: not declared - interestCoverage.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - interestCoverage.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - interestCoverage.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - interestCoverage.explain().return.diagnostics.numerator.amount: number; default: not declared - interestCoverage.explain().return.diagnostics.numerator.label: string; default: not declared - interestCoverage.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - interestCoverage.explain().return.diagnostics.warnings: string[]; default: not declared - interestCoverage.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - interestCoverage.explain(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - interestCoverage.explain(input).income: Pick & Partial; default: not declared - interestCoverage.explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - interestCoverage.explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - interestCoverage.explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - interestCoverage.explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - interestCoverage.explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - interestCoverage.explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - interestCoverage.explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - interestCoverage.explain(input).income.netIncome?: number; default: not declared - interestCoverage.explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - interestCoverage.explain(input).income.operatingIncome?: number; default: not declared - interestCoverage.explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - interestCoverage.explain(input).income.revenue?: number; default: not declared - interestCoverage.explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - interestCoverage.explain(input).statements?: never; default: not declared - inventoryTurnover: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - inventoryTurnover(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - inventoryTurnover(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - inventoryTurnover(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - inventoryTurnover.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - inventoryTurnover.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - inventoryTurnover.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - inventoryTurnover.explain().return.assumptions.conventionsVersion: string; default: not declared - inventoryTurnover.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - inventoryTurnover.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - inventoryTurnover.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - inventoryTurnover.explain().return.assumptions.ratioName: string; default: not declared - inventoryTurnover.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - inventoryTurnover.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - inventoryTurnover.explain().return.diagnostics.denominator.amount: number; default: not declared - inventoryTurnover.explain().return.diagnostics.denominator.label: string; default: not declared - inventoryTurnover.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - inventoryTurnover.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - inventoryTurnover.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - inventoryTurnover.explain().return.diagnostics.numerator.amount: number; default: not declared - inventoryTurnover.explain().return.diagnostics.numerator.label: string; default: not declared - inventoryTurnover.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - inventoryTurnover.explain().return.diagnostics.warnings: string[]; default: not declared - inventoryTurnover.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - inventoryTurnover.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - inventoryTurnover.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - inventoryTurnover.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - isPeriodAvailableAt: (period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod, asOf: import('@insiderfinance/totalfinance/core').EpochMs) => boolean; default: not declared — Point-in-time eligibility: whether `period` was AVAILABLE to an observer at `asOf` (epoch ms). `availableTimestampMs`, not `periodEndDate`, controls eligibility — a restatement is a NEW version with its own availability and provenance, so a backtest never sees it early. - isPeriodAvailableAt(asOf): number; default: not declared - isPeriodAvailableAt(period): import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - isPeriodAvailableAt(period).accession?: string; default: not declared — Source accession identifier, when known. - isPeriodAvailableAt(period).availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - isPeriodAvailableAt(period).currency: string; default: not declared — ISO 4217 currency of the monetary figures. - isPeriodAvailableAt(period).filedTimestampMs?: number; default: not declared — When the filing was made, when known. - isPeriodAvailableAt(period).fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - isPeriodAvailableAt(period).fiscalYear: number; default: not declared - isPeriodAvailableAt(period).form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - isPeriodAvailableAt(period).monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - isPeriodAvailableAt(period).periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - isPeriodAvailableAt(period).periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - isPeriodAvailableAt(period).periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - isPeriodAvailableAt(period).restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - netDebtToEbitda: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - netDebtToEbitda(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - netDebtToEbitda(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - netDebtToEbitda.explain: (input: import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - netDebtToEbitda.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - netDebtToEbitda.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - netDebtToEbitda.explain().return.assumptions.conventionsVersion: string; default: not declared - netDebtToEbitda.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - netDebtToEbitda.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - netDebtToEbitda.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - netDebtToEbitda.explain().return.assumptions.ratioName: string; default: not declared - netDebtToEbitda.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - netDebtToEbitda.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - netDebtToEbitda.explain().return.diagnostics.denominator.amount: number; default: not declared - netDebtToEbitda.explain().return.diagnostics.denominator.label: string; default: not declared - netDebtToEbitda.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - netDebtToEbitda.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - netDebtToEbitda.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - netDebtToEbitda.explain().return.diagnostics.numerator.amount: number; default: not declared - netDebtToEbitda.explain().return.diagnostics.numerator.label: string; default: not declared - netDebtToEbitda.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - netDebtToEbitda.explain().return.diagnostics.warnings: string[]; default: not declared - netDebtToEbitda.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - netDebtToEbitda.explain(input): import('@insiderfinance/totalfinance/fundamentals').SingleStatementRatioInput; default: not declared - netDebtToEbitda.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - netProfitMargin: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - netProfitMargin(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - netProfitMargin(input).income: Pick & Partial; default: not declared - netProfitMargin(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - netProfitMargin(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - netProfitMargin(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - netProfitMargin(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - netProfitMargin(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - netProfitMargin(input).income.interestExpense?: number; default: not declared — Positive magnitude. - netProfitMargin(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - netProfitMargin(input).income.netIncome?: number; default: not declared - netProfitMargin(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - netProfitMargin(input).income.operatingIncome?: number; default: not declared - netProfitMargin(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - netProfitMargin(input).income.revenue?: number; default: not declared - netProfitMargin(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - netProfitMargin(input).statements?: never; default: not declared - netProfitMargin.explain: (input: import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - netProfitMargin.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - netProfitMargin.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - netProfitMargin.explain().return.assumptions.conventionsVersion: string; default: not declared - netProfitMargin.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - netProfitMargin.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - netProfitMargin.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - netProfitMargin.explain().return.assumptions.ratioName: string; default: not declared - netProfitMargin.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - netProfitMargin.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - netProfitMargin.explain().return.diagnostics.denominator.amount: number; default: not declared - netProfitMargin.explain().return.diagnostics.denominator.label: string; default: not declared - netProfitMargin.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - netProfitMargin.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - netProfitMargin.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - netProfitMargin.explain().return.diagnostics.numerator.amount: number; default: not declared - netProfitMargin.explain().return.diagnostics.numerator.label: string; default: not declared - netProfitMargin.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - netProfitMargin.explain().return.diagnostics.warnings: string[]; default: not declared - netProfitMargin.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - netProfitMargin.explain(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - netProfitMargin.explain(input).income: Pick & Partial; default: not declared - netProfitMargin.explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - netProfitMargin.explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - netProfitMargin.explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - netProfitMargin.explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - netProfitMargin.explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - netProfitMargin.explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - netProfitMargin.explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - netProfitMargin.explain(input).income.netIncome?: number; default: not declared - netProfitMargin.explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - netProfitMargin.explain(input).income.operatingIncome?: number; default: not declared - netProfitMargin.explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - netProfitMargin.explain(input).income.revenue?: number; default: not declared - netProfitMargin.explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - netProfitMargin.explain(input).statements?: never; default: not declared - operatingMargin: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - operatingMargin(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - operatingMargin(input).income: Pick & Partial; default: not declared - operatingMargin(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - operatingMargin(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - operatingMargin(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - operatingMargin(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - operatingMargin(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - operatingMargin(input).income.interestExpense?: number; default: not declared — Positive magnitude. - operatingMargin(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - operatingMargin(input).income.netIncome?: number; default: not declared - operatingMargin(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - operatingMargin(input).income.operatingIncome?: number; default: not declared - operatingMargin(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - operatingMargin(input).income.revenue?: number; default: not declared - operatingMargin(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - operatingMargin(input).statements?: never; default: not declared - operatingMargin.explain: (input: import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - operatingMargin.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - operatingMargin.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - operatingMargin.explain().return.assumptions.conventionsVersion: string; default: not declared - operatingMargin.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - operatingMargin.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - operatingMargin.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - operatingMargin.explain().return.assumptions.ratioName: string; default: not declared - operatingMargin.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - operatingMargin.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - operatingMargin.explain().return.diagnostics.denominator.amount: number; default: not declared - operatingMargin.explain().return.diagnostics.denominator.label: string; default: not declared - operatingMargin.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - operatingMargin.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - operatingMargin.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - operatingMargin.explain().return.diagnostics.numerator.amount: number; default: not declared - operatingMargin.explain().return.diagnostics.numerator.label: string; default: not declared - operatingMargin.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - operatingMargin.explain().return.diagnostics.warnings: string[]; default: not declared - operatingMargin.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - operatingMargin.explain(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - operatingMargin.explain(input).income: Pick & Partial; default: not declared - operatingMargin.explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - operatingMargin.explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - operatingMargin.explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - operatingMargin.explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - operatingMargin.explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - operatingMargin.explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - operatingMargin.explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - operatingMargin.explain(input).income.netIncome?: number; default: not declared - operatingMargin.explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - operatingMargin.explain(input).income.operatingIncome?: number; default: not declared - operatingMargin.explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - operatingMargin.explain(input).income.revenue?: number; default: not declared - operatingMargin.explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - operatingMargin.explain(input).statements?: never; default: not declared - payablesTurnover: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - payablesTurnover(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - payablesTurnover(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - payablesTurnover(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - payablesTurnover.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - payablesTurnover.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - payablesTurnover.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - payablesTurnover.explain().return.assumptions.conventionsVersion: string; default: not declared - payablesTurnover.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - payablesTurnover.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - payablesTurnover.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - payablesTurnover.explain().return.assumptions.ratioName: string; default: not declared - payablesTurnover.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - payablesTurnover.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - payablesTurnover.explain().return.diagnostics.denominator.amount: number; default: not declared - payablesTurnover.explain().return.diagnostics.denominator.label: string; default: not declared - payablesTurnover.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - payablesTurnover.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - payablesTurnover.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - payablesTurnover.explain().return.diagnostics.numerator.amount: number; default: not declared - payablesTurnover.explain().return.diagnostics.numerator.label: string; default: not declared - payablesTurnover.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - payablesTurnover.explain().return.diagnostics.warnings: string[]; default: not declared - payablesTurnover.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - payablesTurnover.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - payablesTurnover.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - payablesTurnover.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - perShareFundamentals: (input: import('@insiderfinance/totalfinance/fundamentals').PerShareFundamentalsInput) => import('@insiderfinance/totalfinance/fundamentals').PerShareFundamentalsResult; default: not declared — Split-aware per-share normalization: the period's diluted shares are multiplied by the supplied cumulative split factor so a pre-split period and a post-split observer meet on one basis. The factor and the shares used are echoed; shares absent or non-positive is an error, never a NaN. - perShareFundamentals().return.assumptions: { splitFactorSincePeriod: number; dilutedSharesUsed: number; unitBasis: 'absolute currency per share'; }; default: not declared - perShareFundamentals().return.assumptions.dilutedSharesUsed: number; default: not declared - perShareFundamentals().return.assumptions.splitFactorSincePeriod: number; default: not declared - perShareFundamentals().return.assumptions.unitBasis: 'absolute currency per share'; default: not declared — Per-share values are ABSOLUTE currency per share (amount × monetaryScale / shares). - perShareFundamentals().return.bookValuePerShare: number; default: not declared - perShareFundamentals().return.diagnostics: { warnings: string[]; }; default: not declared - perShareFundamentals().return.diagnostics.warnings: string[]; default: not declared - perShareFundamentals().return.dilutedSharesUsed: number; default: not declared — Split-adjusted diluted shares actually used as the denominator. - perShareFundamentals().return.earningsPerShare: number; default: not declared - perShareFundamentals().return.freeCashFlowPerShare: number | null; default: not declared — `operatingCashFlow - capitalExpenditure` per share; `null` when capex is absent. - perShareFundamentals().return.freeCashFlowPerShareReason?: string; default: not declared - perShareFundamentals().return.revenuePerShare: number; default: not declared - perShareFundamentals().return.splitFactorSincePeriod: number; default: not declared - perShareFundamentals(input): import('@insiderfinance/totalfinance/fundamentals').PerShareFundamentalsInput; default: not declared - perShareFundamentals(input).splitFactorSincePeriod?: number; default: not declared — Cumulative split factor between the period and the observer's share basis (e.g. `2` after a 2-for-1 split since the period end). Default `1` — no split; the factor used is echoed. - perShareFundamentals(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - piotroskiFScore: (input: import('@insiderfinance/totalfinance/fundamentals').PiotroskiInput) => import('@insiderfinance/totalfinance/fundamentals').PiotroskiResult; default: not declared — The standard nine binary signals, per the paper: profitability (return on beginning assets, operating cash flow, their improvement, accruals), leverage/liquidity/funding (falling long-term-debt ratio, improving current ratio, no net share issuance), and efficiency (improving gross margin, improving beginning-assets turnover). Each signal is reported, not only the total; a signal whose statement line is absent reports `null` with the reason and is excluded from `fScore` — never guessed to 0 or 1. - piotroskiFScore().return.assumptions: { model: string; returnBasis: 'beginning total assets'; }; default: not declared - piotroskiFScore().return.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - piotroskiFScore().return.assumptions.returnBasis: 'beginning total assets'; default: not declared — Returns and turnover use BEGINNING total assets, per the paper. - piotroskiFScore().return.diagnostics: { warnings: string[]; }; default: not declared - piotroskiFScore().return.diagnostics.warnings: string[]; default: not declared — One warning per unevaluable signal. - piotroskiFScore().return.evaluableSignals: number; default: not declared — How many of the nine signals could be evaluated; 9 when every input line was present. - piotroskiFScore().return.fScore: number; default: not declared — Sum of the evaluable signals (each 0 or 1). - piotroskiFScore().return.signals: import('@insiderfinance/totalfinance/fundamentals').PiotroskiSignal[]; default: not declared - piotroskiFScore(input): import('@insiderfinance/totalfinance/fundamentals').PiotroskiInput; default: not declared - piotroskiFScore(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - piotroskiFScore(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - piotroskiFScore(input).priorPrior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared — The period before `prior`. Needed because the paper's return and turnover use BEGINNING assets, so the prior year's own signal needs the balance sheet one further back. - priceToBook: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - priceToBook(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - priceToBook(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - priceToBook(input).maximumStalenessMs?: number; default: not declared - priceToBook(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - priceToBook.explain: (input: import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - priceToBook.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - priceToBook.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - priceToBook.explain().return.assumptions.conventionsVersion: string; default: not declared - priceToBook.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - priceToBook.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - priceToBook.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - priceToBook.explain().return.assumptions.ratioName: string; default: not declared - priceToBook.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - priceToBook.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - priceToBook.explain().return.diagnostics.denominator.amount: number; default: not declared - priceToBook.explain().return.diagnostics.denominator.label: string; default: not declared - priceToBook.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - priceToBook.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - priceToBook.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - priceToBook.explain().return.diagnostics.numerator.amount: number; default: not declared - priceToBook.explain().return.diagnostics.numerator.label: string; default: not declared - priceToBook.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - priceToBook.explain().return.diagnostics.warnings: string[]; default: not declared - priceToBook.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - priceToBook.explain(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - priceToBook.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - priceToBook.explain(input).maximumStalenessMs?: number; default: not declared - priceToBook.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - priceToEarnings: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - priceToEarnings(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - priceToEarnings(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - priceToEarnings(input).maximumStalenessMs?: number; default: not declared - priceToEarnings(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - priceToEarnings.explain: (input: import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - priceToEarnings.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - priceToEarnings.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - priceToEarnings.explain().return.assumptions.conventionsVersion: string; default: not declared - priceToEarnings.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - priceToEarnings.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - priceToEarnings.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - priceToEarnings.explain().return.assumptions.ratioName: string; default: not declared - priceToEarnings.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - priceToEarnings.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - priceToEarnings.explain().return.diagnostics.denominator.amount: number; default: not declared - priceToEarnings.explain().return.diagnostics.denominator.label: string; default: not declared - priceToEarnings.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - priceToEarnings.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - priceToEarnings.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - priceToEarnings.explain().return.diagnostics.numerator.amount: number; default: not declared - priceToEarnings.explain().return.diagnostics.numerator.label: string; default: not declared - priceToEarnings.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - priceToEarnings.explain().return.diagnostics.warnings: string[]; default: not declared - priceToEarnings.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - priceToEarnings.explain(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - priceToEarnings.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - priceToEarnings.explain(input).maximumStalenessMs?: number; default: not declared - priceToEarnings.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - priceToSales: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - priceToSales(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - priceToSales(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - priceToSales(input).maximumStalenessMs?: number; default: not declared - priceToSales(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - priceToSales.explain: (input: import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - priceToSales.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - priceToSales.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - priceToSales.explain().return.assumptions.conventionsVersion: string; default: not declared - priceToSales.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - priceToSales.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - priceToSales.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - priceToSales.explain().return.assumptions.ratioName: string; default: not declared - priceToSales.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - priceToSales.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - priceToSales.explain().return.diagnostics.denominator.amount: number; default: not declared - priceToSales.explain().return.diagnostics.denominator.label: string; default: not declared - priceToSales.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - priceToSales.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - priceToSales.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - priceToSales.explain().return.diagnostics.numerator.amount: number; default: not declared - priceToSales.explain().return.diagnostics.numerator.label: string; default: not declared - priceToSales.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - priceToSales.explain().return.diagnostics.warnings: string[]; default: not declared - priceToSales.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - priceToSales.explain(input): import('@insiderfinance/totalfinance/fundamentals').MarketMultipleRatioInput; default: not declared - priceToSales.explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - priceToSales.explain(input).maximumStalenessMs?: number; default: not declared - priceToSales.explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - quickRatio: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - quickRatio(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - quickRatio(input).balance: Pick & Partial; default: not declared - quickRatio(input).balance.accountsPayable?: number; default: not declared - quickRatio(input).balance.accountsReceivable?: number; default: not declared - quickRatio(input).balance.cashAndCashEquivalents?: number; default: not declared - quickRatio(input).balance.currentAssets?: number; default: not declared - quickRatio(input).balance.currentLiabilities?: number; default: not declared - quickRatio(input).balance.inventory?: number; default: not declared - quickRatio(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - quickRatio(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - quickRatio(input).balance.minorityInterest?: number; default: not declared - quickRatio(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - quickRatio(input).balance.preferredEquity?: number; default: not declared - quickRatio(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - quickRatio(input).balance.retainedEarnings?: number; default: not declared - quickRatio(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - quickRatio(input).balance.shortTermInvestments?: number; default: not declared - quickRatio(input).balance.totalAssets?: number; default: not declared - quickRatio(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - quickRatio(input).balance.totalEquity?: number; default: not declared - quickRatio(input).balance.totalLiabilities?: number; default: not declared - quickRatio(input).statements?: never; default: not declared - quickRatio.explain: (input: import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - quickRatio.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - quickRatio.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - quickRatio.explain().return.assumptions.conventionsVersion: string; default: not declared - quickRatio.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - quickRatio.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - quickRatio.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - quickRatio.explain().return.assumptions.ratioName: string; default: not declared - quickRatio.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - quickRatio.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - quickRatio.explain().return.diagnostics.denominator.amount: number; default: not declared - quickRatio.explain().return.diagnostics.denominator.label: string; default: not declared - quickRatio.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - quickRatio.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - quickRatio.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - quickRatio.explain().return.diagnostics.numerator.amount: number; default: not declared - quickRatio.explain().return.diagnostics.numerator.label: string; default: not declared - quickRatio.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - quickRatio.explain().return.diagnostics.warnings: string[]; default: not declared - quickRatio.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - quickRatio.explain(input): import('@insiderfinance/totalfinance/fundamentals').BalanceSheetRatioInput>; default: not declared - quickRatio.explain(input).balance: Pick & Partial; default: not declared - quickRatio.explain(input).balance.accountsPayable?: number; default: not declared - quickRatio.explain(input).balance.accountsReceivable?: number; default: not declared - quickRatio.explain(input).balance.cashAndCashEquivalents?: number; default: not declared - quickRatio.explain(input).balance.currentAssets?: number; default: not declared - quickRatio.explain(input).balance.currentLiabilities?: number; default: not declared - quickRatio.explain(input).balance.inventory?: number; default: not declared - quickRatio.explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - quickRatio.explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - quickRatio.explain(input).balance.minorityInterest?: number; default: not declared - quickRatio.explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - quickRatio.explain(input).balance.preferredEquity?: number; default: not declared - quickRatio.explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - quickRatio.explain(input).balance.retainedEarnings?: number; default: not declared - quickRatio.explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - quickRatio.explain(input).balance.shortTermInvestments?: number; default: not declared - quickRatio.explain(input).balance.totalAssets?: number; default: not declared - quickRatio.explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - quickRatio.explain(input).balance.totalEquity?: number; default: not declared - quickRatio.explain(input).balance.totalLiabilities?: number; default: not declared - quickRatio.explain(input).statements?: never; default: not declared - receivablesTurnover: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - receivablesTurnover(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - receivablesTurnover(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - receivablesTurnover(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - receivablesTurnover.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - receivablesTurnover.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - receivablesTurnover.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - receivablesTurnover.explain().return.assumptions.conventionsVersion: string; default: not declared - receivablesTurnover.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - receivablesTurnover.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - receivablesTurnover.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - receivablesTurnover.explain().return.assumptions.ratioName: string; default: not declared - receivablesTurnover.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - receivablesTurnover.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - receivablesTurnover.explain().return.diagnostics.denominator.amount: number; default: not declared - receivablesTurnover.explain().return.diagnostics.denominator.label: string; default: not declared - receivablesTurnover.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - receivablesTurnover.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - receivablesTurnover.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - receivablesTurnover.explain().return.diagnostics.numerator.amount: number; default: not declared - receivablesTurnover.explain().return.diagnostics.numerator.label: string; default: not declared - receivablesTurnover.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - receivablesTurnover.explain().return.diagnostics.warnings: string[]; default: not declared - receivablesTurnover.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - receivablesTurnover.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - receivablesTurnover.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - receivablesTurnover.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - reconcileFinancialStatements: (input: import('@insiderfinance/totalfinance/fundamentals').ReconcileStatementsInput) => import('@insiderfinance/totalfinance/fundamentals').ReconciliationResult; default: not declared — Accounting-identity diagnostics: the balance-sheet identity, gross-profit articulation, current-versus-total containment, and — with the prior period — cash articulation (`Δcash = operating + investing + financing`). A check whose fields are absent reports `null`, never a silent pass presented as proof. - reconcileFinancialStatements().return.assumptions: { toleranceAmount: number; }; default: not declared - reconcileFinancialStatements().return.assumptions.toleranceAmount: number; default: not declared — Absolute tolerance in reported units, echoed (default 1). - reconcileFinancialStatements().return.checks: import('@insiderfinance/totalfinance/fundamentals').ReconciliationCheck[]; default: not declared - reconcileFinancialStatements().return.diagnostics: { warnings: string[]; }; default: not declared - reconcileFinancialStatements().return.diagnostics.warnings: string[]; default: not declared — One warning per failed or unevaluable check. - reconcileFinancialStatements().return.reconciles: boolean; default: not declared — True when every evaluable check is within tolerance. - reconcileFinancialStatements().return.toleranceAmount: number; default: not declared - reconcileFinancialStatements(input): import('@insiderfinance/totalfinance/fundamentals').ReconcileStatementsInput; default: not declared - reconcileFinancialStatements(input).priorStatements?: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared — The immediately prior period, enabling the cash-articulation check across the two. - reconcileFinancialStatements(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - reconcileFinancialStatements(input).toleranceAmount?: number; default: not declared — Absolute tolerance in reported units (period.monetaryScale). Default `1` — one reported unit, the rounding a scaled filing can legitimately carry. Documented and echoed in the result. - requireBalanceSheet: (functionName: string, balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet) => void; default: not declared — Validate one {@link BalanceSheet} at a public boundary. - requireBalanceSheet(balance): import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - requireBalanceSheet(balance).accountsPayable?: number; default: not declared - requireBalanceSheet(balance).accountsReceivable?: number; default: not declared - requireBalanceSheet(balance).cashAndCashEquivalents: number; default: not declared - requireBalanceSheet(balance).currentAssets?: number; default: not declared - requireBalanceSheet(balance).currentLiabilities?: number; default: not declared - requireBalanceSheet(balance).inventory?: number; default: not declared - requireBalanceSheet(balance).longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - requireBalanceSheet(balance).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - requireBalanceSheet(balance).minorityInterest?: number; default: not declared - requireBalanceSheet(balance).period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - requireBalanceSheet(balance).preferredEquity?: number; default: not declared - requireBalanceSheet(balance).propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - requireBalanceSheet(balance).retainedEarnings?: number; default: not declared - requireBalanceSheet(balance).shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - requireBalanceSheet(balance).shortTermInvestments?: number; default: not declared - requireBalanceSheet(balance).totalAssets: number; default: not declared - requireBalanceSheet(balance).totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - requireBalanceSheet(balance).totalEquity: number; default: not declared - requireBalanceSheet(balance).totalLiabilities: number; default: not declared - requireBalanceSheet(functionName): string; default: not declared - requireCashFlowStatement: (functionName: string, cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement) => void; default: not declared — Validate one {@link CashFlowStatement} at a public boundary. - requireCashFlowStatement(cashFlow): import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - requireCashFlowStatement(cashFlow).acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - requireCashFlowStatement(cashFlow).capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - requireCashFlowStatement(cashFlow).depreciationAndAmortization?: number; default: not declared - requireCashFlowStatement(cashFlow).dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - requireCashFlowStatement(cashFlow).financingCashFlow: number; default: not declared - requireCashFlowStatement(cashFlow).investingCashFlow: number; default: not declared - requireCashFlowStatement(cashFlow).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - requireCashFlowStatement(cashFlow).operatingCashFlow: number; default: not declared - requireCashFlowStatement(cashFlow).period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - requireCashFlowStatement(cashFlow).shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - requireCashFlowStatement(cashFlow).stockBasedCompensation?: number; default: not declared - requireCashFlowStatement(functionName): string; default: not declared - requireFinancialStatements: (functionName: string, statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements) => void; default: not declared — Validate a {@link FinancialStatements} set: each statement, then the identity agreement — the three periods must share `periodEndDate`, `periodType`, `currency`, and `monetaryScale`, because every cross-statement ratio assumes one period and one unit. - requireFinancialStatements(functionName): string; default: not declared - requireFinancialStatements(statements): import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - requireFinancialStatements(statements).balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - requireFinancialStatements(statements).cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - requireFinancialStatements(statements).income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - requireFundamentalPeriod: (functionName: string, period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod) => asserts period is import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared — Validate a {@link FundamentalPeriod} at a public boundary (Law 12 closed request): presence, types, the strict date grammar, the literal domains, and the ordering facts a period must obey. - requireFundamentalPeriod(functionName): string; default: not declared - requireFundamentalPeriod(period): import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - requireFundamentalPeriod(period).accession?: string; default: not declared — Source accession identifier, when known. - requireFundamentalPeriod(period).availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - requireFundamentalPeriod(period).currency: string; default: not declared — ISO 4217 currency of the monetary figures. - requireFundamentalPeriod(period).filedTimestampMs?: number; default: not declared — When the filing was made, when known. - requireFundamentalPeriod(period).fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - requireFundamentalPeriod(period).fiscalYear: number; default: not declared - requireFundamentalPeriod(period).form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - requireFundamentalPeriod(period).monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - requireFundamentalPeriod(period).periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - requireFundamentalPeriod(period).periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - requireFundamentalPeriod(period).periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - requireFundamentalPeriod(period).restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - requireIncomeStatement: (functionName: string, income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement) => void; default: not declared — Validate one {@link IncomeStatement} at a public boundary. - requireIncomeStatement(functionName): string; default: not declared - requireIncomeStatement(income): import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - requireIncomeStatement(income).costOfRevenue?: number; default: not declared — Positive magnitude. - requireIncomeStatement(income).dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - requireIncomeStatement(income).grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - requireIncomeStatement(income).incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - requireIncomeStatement(income).incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - requireIncomeStatement(income).interestExpense?: number; default: not declared — Positive magnitude. - requireIncomeStatement(income).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - requireIncomeStatement(income).netIncome: number; default: not declared - requireIncomeStatement(income).operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - requireIncomeStatement(income).operatingIncome: number; default: not declared - requireIncomeStatement(income).period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - requireIncomeStatement(income).revenue: number; default: not declared - requireIncomeStatement(income).sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - requireMarketObservation: (functionName: string, observation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation) => void; default: not declared — Validate a {@link MarketObservation} at a public boundary. - requireMarketObservation(functionName): string; default: not declared - requireMarketObservation(observation): import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - requireMarketObservation(observation).marketCapitalization?: number; default: not declared - requireMarketObservation(observation).observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - requireMarketObservation(observation).sharePrice: number; default: not declared - requireMarketObservation(observation).sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. - returnOnAssets: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - returnOnAssets(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - returnOnAssets(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnAssets(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnAssets.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - returnOnAssets.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - returnOnAssets.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - returnOnAssets.explain().return.assumptions.conventionsVersion: string; default: not declared - returnOnAssets.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - returnOnAssets.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnAssets.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnAssets.explain().return.assumptions.ratioName: string; default: not declared - returnOnAssets.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - returnOnAssets.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - returnOnAssets.explain().return.diagnostics.denominator.amount: number; default: not declared - returnOnAssets.explain().return.diagnostics.denominator.label: string; default: not declared - returnOnAssets.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - returnOnAssets.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - returnOnAssets.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - returnOnAssets.explain().return.diagnostics.numerator.amount: number; default: not declared - returnOnAssets.explain().return.diagnostics.numerator.label: string; default: not declared - returnOnAssets.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - returnOnAssets.explain().return.diagnostics.warnings: string[]; default: not declared - returnOnAssets.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - returnOnAssets.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - returnOnAssets.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnAssets.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnCapitalEmployed: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - returnOnCapitalEmployed(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - returnOnCapitalEmployed(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnCapitalEmployed(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnCapitalEmployed.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - returnOnCapitalEmployed.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - returnOnCapitalEmployed.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - returnOnCapitalEmployed.explain().return.assumptions.conventionsVersion: string; default: not declared - returnOnCapitalEmployed.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - returnOnCapitalEmployed.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnCapitalEmployed.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnCapitalEmployed.explain().return.assumptions.ratioName: string; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.denominator.amount: number; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.denominator.label: string; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - returnOnCapitalEmployed.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - returnOnCapitalEmployed.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.numerator.amount: number; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.numerator.label: string; default: not declared - returnOnCapitalEmployed.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - returnOnCapitalEmployed.explain().return.diagnostics.warnings: string[]; default: not declared - returnOnCapitalEmployed.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - returnOnCapitalEmployed.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - returnOnCapitalEmployed.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnCapitalEmployed.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnEquity: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - returnOnEquity(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - returnOnEquity(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnEquity(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnEquity.explain: (input: import('@insiderfinance/totalfinance/fundamentals').PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - returnOnEquity.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - returnOnEquity.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - returnOnEquity.explain().return.assumptions.conventionsVersion: string; default: not declared - returnOnEquity.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - returnOnEquity.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnEquity.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnEquity.explain().return.assumptions.ratioName: string; default: not declared - returnOnEquity.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - returnOnEquity.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - returnOnEquity.explain().return.diagnostics.denominator.amount: number; default: not declared - returnOnEquity.explain().return.diagnostics.denominator.label: string; default: not declared - returnOnEquity.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - returnOnEquity.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - returnOnEquity.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - returnOnEquity.explain().return.diagnostics.numerator.amount: number; default: not declared - returnOnEquity.explain().return.diagnostics.numerator.label: string; default: not declared - returnOnEquity.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - returnOnEquity.explain().return.diagnostics.warnings: string[]; default: not declared - returnOnEquity.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - returnOnEquity.explain(input): import('@insiderfinance/totalfinance/fundamentals').PairRatioInput; default: not declared - returnOnEquity.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnEquity.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnInvestedCapital: import('@insiderfinance/totalfinance/fundamentals').RatioFacade; default: not declared - returnOnInvestedCapital(input): import('@insiderfinance/totalfinance/fundamentals').InvestedCapitalRatioInput; default: not declared - returnOnInvestedCapital(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnInvestedCapital(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnInvestedCapital(input).taxRate?: number; default: not declared - returnOnInvestedCapital.explain: (input: import('@insiderfinance/totalfinance/fundamentals').InvestedCapitalRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - returnOnInvestedCapital.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - returnOnInvestedCapital.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - returnOnInvestedCapital.explain().return.assumptions.conventionsVersion: string; default: not declared - returnOnInvestedCapital.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - returnOnInvestedCapital.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnInvestedCapital.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - returnOnInvestedCapital.explain().return.assumptions.ratioName: string; default: not declared - returnOnInvestedCapital.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.denominator.amount: number; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.denominator.label: string; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - returnOnInvestedCapital.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - returnOnInvestedCapital.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.numerator.amount: number; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.numerator.label: string; default: not declared - returnOnInvestedCapital.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - returnOnInvestedCapital.explain().return.diagnostics.warnings: string[]; default: not declared - returnOnInvestedCapital.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - returnOnInvestedCapital.explain(input): import('@insiderfinance/totalfinance/fundamentals').InvestedCapitalRatioInput; default: not declared - returnOnInvestedCapital.explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnInvestedCapital.explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - returnOnInvestedCapital.explain(input).taxRate?: number; default: not declared - revenuePerShare: import('@insiderfinance/totalfinance/fundamentals').RatioFacade>>; default: not declared - revenuePerShare(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - revenuePerShare(input).income: Pick & Partial; default: not declared - revenuePerShare(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - revenuePerShare(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - revenuePerShare(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - revenuePerShare(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - revenuePerShare(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - revenuePerShare(input).income.interestExpense?: number; default: not declared — Positive magnitude. - revenuePerShare(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - revenuePerShare(input).income.netIncome?: number; default: not declared - revenuePerShare(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - revenuePerShare(input).income.operatingIncome?: number; default: not declared - revenuePerShare(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - revenuePerShare(input).income.revenue?: number; default: not declared - revenuePerShare(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - revenuePerShare(input).statements?: never; default: not declared - revenuePerShare.explain: (input: import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - revenuePerShare.explain().return.assumptions: { conventionsVersion: string; ratioName: string; category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; }; default: not declared - revenuePerShare.explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - revenuePerShare.explain().return.assumptions.conventionsVersion: string; default: not declared - revenuePerShare.explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - revenuePerShare.explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - revenuePerShare.explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - revenuePerShare.explain().return.assumptions.ratioName: string; default: not declared - revenuePerShare.explain().return.diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; notes: string[]; reason?: string; marketStalenessMs?: number; }; default: not declared - revenuePerShare.explain().return.diagnostics.denominator: { label: string; amount: number; } | null; default: not declared - revenuePerShare.explain().return.diagnostics.denominator.amount: number; default: not declared - revenuePerShare.explain().return.diagnostics.denominator.label: string; default: not declared - revenuePerShare.explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - revenuePerShare.explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - revenuePerShare.explain().return.diagnostics.numerator: { label: string; amount: number; } | null; default: not declared - revenuePerShare.explain().return.diagnostics.numerator.amount: number; default: not declared - revenuePerShare.explain().return.diagnostics.numerator.label: string; default: not declared - revenuePerShare.explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - revenuePerShare.explain().return.diagnostics.warnings: string[]; default: not declared - revenuePerShare.explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - revenuePerShare.explain(input): import('@insiderfinance/totalfinance/fundamentals').IncomeStatementRatioInput>; default: not declared - revenuePerShare.explain(input).income: Pick & Partial; default: not declared - revenuePerShare.explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - revenuePerShare.explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - revenuePerShare.explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - revenuePerShare.explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - revenuePerShare.explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - revenuePerShare.explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - revenuePerShare.explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - revenuePerShare.explain(input).income.netIncome?: number; default: not declared - revenuePerShare.explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - revenuePerShare.explain(input).income.operatingIncome?: number; default: not declared - revenuePerShare.explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - revenuePerShare.explain(input).income.revenue?: number; default: not declared - revenuePerShare.explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - revenuePerShare.explain(input).statements?: never; default: not declared - selectFundamentalSnapshot: (input: import('@insiderfinance/totalfinance/fundamentals').SelectFundamentalSnapshotInput) => import('@insiderfinance/totalfinance/fundamentals').FundamentalSnapshot; default: not declared — The point-in-time view of a series: availability-gated by `statementsAvailableTimestampMs` (never by period end), then resolved to ONE version per (periodType, periodEndDate) under the stated restatement policy — `'latest-available'` takes the newest visible version, `'first-reported'` takes the original filing and ignores restatements entirely. - selectFundamentalSnapshot().return.asOf: number; default: not declared - selectFundamentalSnapshot().return.entity?: string; default: not declared - selectFundamentalSnapshot().return.restatementPolicy: import('@insiderfinance/totalfinance/fundamentals').RestatementPolicy; default: not declared - selectFundamentalSnapshot().return.statements: readonly import('@insiderfinance/totalfinance/fundamentals').FinancialStatements[]; default: not declared — One resolved version per (periodType, periodEndDate), period end ascending. - selectFundamentalSnapshot(input): import('@insiderfinance/totalfinance/fundamentals').SelectFundamentalSnapshotInput; default: not declared - selectFundamentalSnapshot(input).asOf: number; default: not declared — The observation instant (epoch ms). Only sets whose availability is at or before it qualify. - selectFundamentalSnapshot(input).restatementPolicy: import('@insiderfinance/totalfinance/fundamentals').RestatementPolicy; default: not declared — How multiple visible versions of one period resolve. - selectFundamentalSnapshot(input).series: import('@insiderfinance/totalfinance/fundamentals').FundamentalSeries; default: not declared - statementsAvailableTimestampMs: (statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements) => number; default: not declared — The point-in-time availability of a statement SET: the latest of the three statements' `availableTimestampMs` — a set is visible only when every statement in it is. The set is validated IN FULL: a helper that answers an eligibility instant from a malformed set would smuggle that malformation into every point-in-time decision built on it. - statementsAvailableTimestampMs(statements): import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - statementsAvailableTimestampMs(statements).balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - statementsAvailableTimestampMs(statements).cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statementsAvailableTimestampMs(statements).income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - trailingTwelveMonthStatements: (input: import('@insiderfinance/totalfinance/fundamentals').TrailingTwelveMonthInput) => import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared — Compose four consecutive fiscal quarters into one trailing-twelve-months set: income and cash-flow FLOWS sum; BALANCES are the latest quarter's (a balance is a point, not a flow); `dilutedSharesOutstanding` is the four-quarter arithmetic mean (disclosed convention). The quarter chain is verified — a gap or an overlap is an error naming the break, never a silent annualization. - trailingTwelveMonthStatements().return.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - trailingTwelveMonthStatements().return.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - trailingTwelveMonthStatements().return.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - trailingTwelveMonthStatements(input): import('@insiderfinance/totalfinance/fundamentals').TrailingTwelveMonthInput; default: not declared - trailingTwelveMonthStatements(input).statements: readonly import('@insiderfinance/totalfinance/fundamentals').FinancialStatements[]; default: not declared — Exactly four consecutive fiscal quarters, period end ascending. ### @insiderfinance/totalfinance#impliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve BSM implied volatility with the chosen method, reporting rich diagnostics — quantitative failure (price outside no-arbitrage bounds, no convergence) reports `converged: false` with the reason, never a fabricated vol. ```typescript export declare function impliedVolatility(input: BlackScholesImpliedVolatilityInput, options?: ImpliedVolatilityOptions): ImpliedVolatilitySolveResult; ``` Example (source JSDoc): ```ts import { impliedVolatility } from '@insiderfinance/totalfinance/options'; const solved = impliedVolatility({ price: 2.31, spot: 100, strike: 105, timeToExpiryYears: 30 / 365, riskFreeRate: 0.045, type: 'call', }); solved.value; // 0.2199… (annualized volatility) solved.diagnostics.converged; // true — ALWAYS check before trusting the value solved.diagnostics.method; // which solver actually ran ('brent', 'newton', …) ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesImpliedVolatilityInput; default: not declared - (input).dividendYield?: number; default: not declared - (input).price: number; default: not declared — Observed option price to invert. - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (options)?: ImpliedVolatilityOptions; default: not declared - (options).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - (options).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - (options).method?: ImpliedVolatilityMethod; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: (ImpliedVolatilityDiagnostics) | (import('@insiderfinance/totalfinance/core').Diagnostics); default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance#market Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function market(input: OptionMarket): OptionMarket; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OptionMarket; default: not declared - (input).asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - (input).dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - (input).dividends?: DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - (input).forward?: number; default: not declared - (input).price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).volatility?: number; default: not declared - return.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - return.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - return.dividends?: DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - return.forward?: number; default: not declared - return.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - return.riskFreeRate: number; default: not declared - return.spot: number; default: not declared - return.volatility?: number; default: not declared ### @insiderfinance/totalfinance#math Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const math: typeof import('@insiderfinance/totalfinance/math'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - SOBOL_MAX_DIMENSIONS: 1111; default: not declared - acf: (series: number[], maxLag: number) => number[]; default: not declared — Sample autocorrelation function through `maxLag`, using the biased (÷N) estimator that guarantees a positive-semidefinite sequence. Returns `[1, ρ₁, …, ρ_maxLag]` — index 0 is lag 0 and equals 1 exactly. - acf(maxLag): number; default: not declared - acf(series): number[]; default: not declared - adaptiveSimpson: (integrand: import('@insiderfinance/totalfinance/math').ScalarFunction, lowerBound: number, upperBound: number, options?: import('@insiderfinance/totalfinance/math').AdaptiveSimpsonOptions) => number; default: not declared — Adaptive Simpson integration of `f` on `[a, b]` to the requested tolerance. Throws `ConvergenceError` (`integration.max_depth`) if the depth budget is exhausted before the tolerance is met — use {@link adaptiveSimpsonSafe} for a soft result with diagnostics. - adaptiveSimpson(integrand): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - adaptiveSimpson(lowerBound): number; default: not declared - adaptiveSimpson(options)?: import('@insiderfinance/totalfinance/math').AdaptiveSimpsonOptions; default: not declared - adaptiveSimpson(options).maxDepth?: number; default: not declared - adaptiveSimpson(options).maxEvaluations?: number; default: not declared — Maximum integrand evaluations before stopping with `converged: false`. Default 100,000. `maxDepth` bounds the DEPTH of a binary subdivision, so it bounds the work at 2^depth — the default of 50 therefore permits about 10^15 evaluations, which is a budget in name only. This is the bound that actually holds. - adaptiveSimpson(options).tolerance?: number; default: not declared - adaptiveSimpson(upperBound): number; default: not declared - adaptiveSimpsonSafe: (integrand: import('@insiderfinance/totalfinance/math').ScalarFunction, lowerBound: number, upperBound: number, options?: import('@insiderfinance/totalfinance/math').AdaptiveSimpsonOptions) => import('@insiderfinance/totalfinance/math').AdaptiveSimpsonResult; default: not declared — Adaptive Simpson integration returning diagnostics instead of throwing. The tolerance is HALVED at each recursion level so the total error stays bounded by `tolerance` regardless of how many subintervals are created; depth exhaustion is reported via `converged: false` rather than being indistinguishable from success. - adaptiveSimpsonSafe().return.converged: boolean; default: not declared — Whether every subinterval met its (halved) tolerance before the depth budget ran out. - adaptiveSimpsonSafe().return.deepestLevel: number; default: not declared — The deepest recursion level reached (0 = no subdivision). - adaptiveSimpsonSafe().return.value: number; default: not declared — The integral estimate (best available even when `converged` is false). - adaptiveSimpsonSafe(integrand): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - adaptiveSimpsonSafe(lowerBound): number; default: not declared - adaptiveSimpsonSafe(options)?: import('@insiderfinance/totalfinance/math').AdaptiveSimpsonOptions; default: not declared - adaptiveSimpsonSafe(options).maxDepth?: number; default: not declared - adaptiveSimpsonSafe(options).maxEvaluations?: number; default: not declared — Maximum integrand evaluations before stopping with `converged: false`. Default 100,000. `maxDepth` bounds the DEPTH of a binary subdivision, so it bounds the work at 2^depth — the default of 50 therefore permits about 10^15 evaluations, which is a budget in name only. This is the bound that actually holds. - adaptiveSimpsonSafe(options).tolerance?: number; default: not declared - adaptiveSimpsonSafe(upperBound): number; default: not declared - antitheticSampler: (payoff: (normals: number[]) => number, dimensions: number) => (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator) => number; default: not declared — Wrap a payoff over a standard-normal vector into an antithetic sampler: each path evaluates the payoff at `Z` and `-Z` and averages, reducing variance for monotone payoffs. - antitheticSampler(dimensions): number; default: not declared - antitheticSampler(payoff): (normals: number[]) => number; default: not declared - augmentedDickeyFullerTest: (series: number[], options?: import('@insiderfinance/totalfinance/math').AugmentedDickeyFullerOptions) => import('@insiderfinance/totalfinance/math').TestResult; default: not declared — Augmented Dickey–Fuller test for a unit root. Regresses `Δyₜ` on `y_{t−1}`, a constant (and a trend for `'ct'`), and `lags` lagged differences; the statistic is the t-ratio on `y_{t−1}`. A very negative statistic (below the critical value) rejects the unit-root null in favour of stationarity. - augmentedDickeyFullerTest().return.criticalValues?: { '1%': number; '5%': number; '10%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - augmentedDickeyFullerTest().return.criticalValues.1%: number; default: not declared - augmentedDickeyFullerTest().return.criticalValues.10%: number; default: not declared - augmentedDickeyFullerTest().return.criticalValues.5%: number; default: not declared - augmentedDickeyFullerTest().return.method: string; default: not declared — Human-readable identifier of the test and its configuration. - augmentedDickeyFullerTest().return.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - augmentedDickeyFullerTest().return.statistic: number; default: not declared — The test statistic. - augmentedDickeyFullerTest(options)?: import('@insiderfinance/totalfinance/math').AugmentedDickeyFullerOptions; default: not declared - augmentedDickeyFullerTest(options).lags?: number; default: not declared — Number of augmenting lagged differences (default 0 ⇒ plain Dickey–Fuller). - augmentedDickeyFullerTest(options).regression?: 'c' | 'ct'; default: not declared — Deterministic terms: `'c'` = constant (default), `'ct'` = constant + linear trend. - augmentedDickeyFullerTest(series): number[]; default: not declared - bfgs: (objective: import('@insiderfinance/totalfinance/math').MultivariateFunction, start: number[], options?: import('@insiderfinance/totalfinance/math').MultiMinOptions) => import('@insiderfinance/totalfinance/math').MultiMinResult; default: not declared — BFGS quasi-Newton minimization with a backtracking (Armijo) line search. - bfgs().return.argMin: number[]; default: not declared - bfgs().return.converged: boolean; default: not declared - bfgs().return.evaluations?: number; default: not declared — Objective evaluations performed. - bfgs().return.iterations: number; default: not declared - bfgs().return.minimum: number; default: not declared - bfgs().return.reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - bfgs().return.seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. - bfgs(objective): import('@insiderfinance/totalfinance/math').MultivariateFunction; default: not declared - bfgs(options)?: import('@insiderfinance/totalfinance/math').MultiMinOptions; default: not declared - bfgs(options).grad?: (point: number[]) => number[]; default: not declared — Analytic gradient; if omitted, a central-difference gradient is used (BFGS only). - bfgs(options).maximumIterations?: number; default: not declared - bfgs(options).tolerance?: number; default: not declared - bfgs(start): number[]; default: not declared - bicubicInterp: (xs: ArrayLike, ys: ArrayLike, z: number[][], x: number, y: number) => number; default: not declared — Bicubic interpolation at a single `(x, y)` (see {@link makeBicubicInterpolator}). - bicubicInterp(x): number; default: not declared - bicubicInterp(xs): ArrayLike; default: not declared - bicubicInterp(y): number; default: not declared - bicubicInterp(ys): ArrayLike; default: not declared - bicubicInterp(z): number[][]; default: not declared - bilinearInterp: (xs: ArrayLike, ys: ArrayLike, z: number[][], x: number, y: number) => number; default: not declared — Bilinear interpolation on a grid. `z[i][j]` is the value at `(xs[i], ys[j])`. Clamps to the grid edges outside the domain. - bilinearInterp(x): number; default: not declared - bilinearInterp(xs): ArrayLike; default: not declared - bilinearInterp(y): number; default: not declared - bilinearInterp(ys): ArrayLike; default: not declared - bilinearInterp(z): number[][]; default: not declared - bisection: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, a0: number, b0: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared - bisection().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - bisection().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - bisection().return.iterations: number; default: not declared — Iterations performed. - bisection().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - bisection().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - bisection().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - bisection().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - bisection(a0): number; default: not declared - bisection(b0): number; default: not declared - bisection(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - bisection(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - bisection(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - bisection(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - bisection(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - bisection(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - bivariateNormalCdf: (a: number, b: number, rho: number) => number; default: not declared — Cumulative bivariate normal: P(X ≤ a, Y ≤ b) where (X, Y) is standard bivariate normal with correlation `rho ∈ [-1, 1]`. Returns `NaN` if any argument is `NaN` or `|rho| > 1`. - bivariateNormalCdf(a): number; default: not declared - bivariateNormalCdf(b): number; default: not declared - bivariateNormalCdf(rho): number; default: not declared - bootstrap: (data: ArrayLike, statistic: (sample: number[]) => number, options: import('@insiderfinance/totalfinance/math').BootstrapOptions) => import('@insiderfinance/totalfinance/math').BootstrapResult; default: not declared — Nonparametric bootstrap: resample `data` with replacement `iterations` times, apply `statistic`, and summarize the distribution of the estimate. Deterministic given `seed`. - bootstrap().return.confidenceInterval95: [number, number]; default: not declared — 95% percentile confidence interval. - bootstrap().return.estimates: number[]; default: not declared - bootstrap().return.iterations: number; default: not declared - bootstrap().return.mean: number; default: not declared - bootstrap().return.seed: number; default: not declared - bootstrap().return.standardDeviation: number; default: not declared - bootstrap(data): ArrayLike; default: not declared - bootstrap(options): import('@insiderfinance/totalfinance/math').BootstrapOptions; default: not declared - bootstrap(options).iterations?: number; default: not declared — Number of resamples (default 1000). - bootstrap(options).seed: number; default: not declared — Seed — required so results are reproducible (and echoed back). - bootstrap(statistic): (sample: number[]) => number; default: not declared - bracketExpand: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, a0: number, b0: number, options?: import('@insiderfinance/totalfinance/math').BracketExpandOptions) => import('@insiderfinance/totalfinance/math').Bracket; default: not declared — Expand an initial interval outward until it brackets a sign change. - bracketExpand().return.found: boolean; default: not declared - bracketExpand().return.iterations: number; default: not declared — Expansion steps taken (so callers like findRoot can report a truthful total iteration count). - bracketExpand().return.lowerBound: number; default: not declared - bracketExpand().return.objectiveAtLowerBound: number; default: not declared - bracketExpand().return.objectiveAtUpperBound: number; default: not declared - bracketExpand().return.upperBound: number; default: not declared - bracketExpand(a0): number; default: not declared - bracketExpand(b0): number; default: not declared - bracketExpand(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - bracketExpand(options)?: import('@insiderfinance/totalfinance/math').BracketExpandOptions; default: not declared - bracketExpand(options).factor?: number; default: not declared — Growth factor per step (default 1.6). - bracketExpand(options).maximumIterations?: number; default: not declared — Maximum expansion steps (default 60). - brent: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, a0: number, b0: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Brent's method: inverse-quadratic / secant interpolation with a bisection safeguard. The robust default root solver. - brent().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - brent().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - brent().return.iterations: number; default: not declared — Iterations performed. - brent().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - brent().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - brent().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - brent().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - brent(a0): number; default: not declared - brent(b0): number; default: not declared - brent(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - brent(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - brent(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - brent(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - brent(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - brent(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - brentMin: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, a0: number, b0: number, options?: import('@insiderfinance/totalfinance/math').MinOptions) => import('@insiderfinance/totalfinance/math').MinResult; default: not declared — Brent's method for 1-D minimization (parabolic interpolation with a golden-section safeguard). - brentMin().return.argMin: number; default: not declared - brentMin().return.converged: boolean; default: not declared - brentMin().return.evaluations?: number; default: not declared — Objective evaluations performed (interpretability parity across optimizers). - brentMin().return.iterations: number; default: not declared - brentMin().return.minimum: number; default: not declared - brentMin().return.reason?: 'max_iterations' | 'non_finite'; default: not declared - brentMin(a0): number; default: not declared - brentMin(b0): number; default: not declared - brentMin(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - brentMin(options)?: import('@insiderfinance/totalfinance/math').MinOptions; default: not declared - brentMin(options).maximumIterations?: number; default: not declared - brentMin(options).tolerance?: number; default: not declared - brownianBridge: (normals: ArrayLike, stepSize: number) => number[]; default: not declared — Brownian-bridge path construction on a uniform grid of `n` steps of size `stepSize` (a DIMENSIONLESS grid spacing — callers building a unit grid pass `1` and scale later, so this is deliberately not a `*Years` quantity). Consumes `n` standard normals, assigning the most significant (endpoint, then successive midpoints) first — ideal for quasi-Monte Carlo. Returns `W[0..n]` with `W[0] = 0`. - brownianBridge(normals): ArrayLike; default: not declared - brownianBridge(stepSize): number; default: not declared - chiSquare: { readonly cdf: (x: number, degreesOfFreedom: number) => number; readonly inverseCdf: (probability: number, degreesOfFreedom: number) => number; }; default: not declared — The chi-square distribution with `df` degrees of freedom (`df > 0`) — gamma(k = df/2, θ = 2). - chiSquare.cdf: (x: number, degreesOfFreedom: number) => number; default: not declared — Cumulative distribution `F(x; k) = P(k/2, x/2)`. For `k = 2` this collapses to the closed form `1 − e^(−x/2)`. - chiSquare.cdf(degreesOfFreedom): number; default: not declared - chiSquare.cdf(x): number; default: not declared - chiSquare.inverseCdf: (probability: number, degreesOfFreedom: number) => number; default: not declared — Quantile (inverse CDF) on `(0, ∞)`. - chiSquare.inverseCdf(degreesOfFreedom): number; default: not declared - chiSquare.inverseCdf(probability): number; default: not declared - cholesky: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Cholesky factorization: lower-triangular `L` with `A = L Lᵀ`. Throws if `A` is not PD. - cholesky(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - choleskySolve: (L: import('@insiderfinance/totalfinance/math').Matrix, b: number[]) => number[]; default: not declared — Solve `A x = b` given the Cholesky factor `L` of `A`. - choleskySolve(L): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - choleskySolve(b): number[]; default: not declared - controlVariateEstimate: (samples: ArrayLike, controls: ArrayLike, controlMean: number) => number; default: not declared — Control-variate adjusted estimate: `E[Y] ≈ Ȳ − c·(X̄ − E[X])`, with `c = cov(Y,X)/var(X)`. `samples` are the target outputs, `controls` the control outputs, `controlMean` the known `E[X]`. - controlVariateEstimate(controlMean): number; default: not declared - controlVariateEstimate(controls): ArrayLike; default: not declared - controlVariateEstimate(samples): ArrayLike; default: not declared - correlatedNormalSampler: (covarianceOrCorrelation: import('@insiderfinance/totalfinance/math').Matrix) => (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator) => number[]; default: not declared — Build a sampler of correlated standard normals from a covariance/correlation matrix (via Cholesky). - correlatedNormalSampler(covarianceOrCorrelation): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - correlation: (xs: ArrayLike, ys: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared — Pearson correlation coefficient. Throws on unequal lengths. - correlation(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - correlation(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - correlation(xs): ArrayLike; default: not declared - correlation(ys): ArrayLike; default: not declared - covariance: (xs: ArrayLike, ys: ArrayLike, options?: import('@insiderfinance/totalfinance/math').VarianceOptions) => number; default: not declared — Covariance of two equal-length series (sample by default). Throws on unequal lengths. - covariance(options)?: import('@insiderfinance/totalfinance/math').VarianceOptions | undefined; default: not declared - covariance(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - covariance(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - covariance(xs): ArrayLike; default: not declared - covariance(ys): ArrayLike; default: not declared - covarianceMatrix: (series: number[][], options?: import('@insiderfinance/totalfinance/math').PopulationOptions) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Covariance matrix of a set of equal-length variables (`series[k]` is variable k). - covarianceMatrix(options)?: import('@insiderfinance/totalfinance/math').PopulationOptions | undefined; default: not declared - covarianceMatrix(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - covarianceMatrix(series): number[][]; default: not declared - determinant: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => number; default: not declared — Determinant via LU; returns 0 for a singular matrix instead of throwing. - determinant(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - differentialEvolution: (objective: import('@insiderfinance/totalfinance/math').MultivariateFunction, bounds: ReadonlyArray, options?: import('@insiderfinance/totalfinance/math').DifferentialEvolutionOptions) => import('@insiderfinance/totalfinance/math').MultiMinResult; default: not declared — Differential evolution (Storn–Price `rand/1/bin`): a seeded, bound-constrained **global** optimizer for multimodal objectives the local methods (Nelder–Mead/BFGS) get stuck on. Deterministic given the seed; trial vectors are reflected back inside `bounds`. Returns the best member found. - differentialEvolution().return.argMin: number[]; default: not declared - differentialEvolution().return.converged: boolean; default: not declared - differentialEvolution().return.evaluations?: number; default: not declared — Objective evaluations performed. - differentialEvolution().return.iterations: number; default: not declared - differentialEvolution().return.minimum: number; default: not declared - differentialEvolution().return.reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - differentialEvolution().return.seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. - differentialEvolution(bounds): readonly (readonly [number, number])[]; default: not declared - differentialEvolution(objective): import('@insiderfinance/totalfinance/math').MultivariateFunction; default: not declared - differentialEvolution(options)?: import('@insiderfinance/totalfinance/math').DifferentialEvolutionOptions; default: not declared - differentialEvolution(options).crossover?: number; default: not declared — Crossover probability `CR ∈ [0, 1]`. Default 0.9. - differentialEvolution(options).maxGenerations?: number; default: not declared — Maximum generations. Default 300. - differentialEvolution(options).mutation?: number; default: not declared — Differential weight `F ∈ (0, 2]`. Default 0.8. - differentialEvolution(options).populationSize?: number; default: not declared — Population size. Default `max(20, 10·dim)`. - differentialEvolution(options).seed?: number; default: not declared — Seed for the deterministic PRNG. Default 0x5eed. - differentialEvolution(options).tolerance?: number; default: not declared — Converge when the population's objective spread falls below this. Default 1e-12. - eigen: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').GeneralEigenResult; default: not declared — Eigenvalues and (for real eigenvalues) eigenvectors of a general real matrix. Eigenvalues come from the Francis QR algorithm ({@link eigenvalues}); each real eigenvalue's eigenvector is recovered by inverse iteration. Complex eigenvalues report a `null` vector in this real-valued interface. - eigen().return.values: import('@insiderfinance/totalfinance/math').Complex[]; default: not declared — Eigenvalues (real, or complex-conjugate pairs), in real-Schur order. - eigen().return.vectors: (number[] | null)[]; default: not declared — Eigenvector for each real eigenvalue (via inverse iteration), aligned to `values`; `null` for complex eigenvalues (their eigenvectors are complex and not returned in this real interface). - eigen(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - eigenvalues: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Complex[]; default: not declared — Eigenvalues of a general real matrix via the **Francis double-shift QR** algorithm on its Hessenberg form (the EISPACK/JAMA `hqr2` reduction to real Schur form). Returns real eigenvalues and complex-conjugate pairs. For symmetric matrices prefer {@link jacobiEigen} (which also gives vectors). - eigenvalues(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - engleGranger: (dependent: number[], independent: number[]) => import('@insiderfinance/totalfinance/math').EngleGrangerResult; default: not declared — Engle–Granger two-step cointegration test. Step 1 regresses `y` on `x` (with intercept); step 2 runs an ADF test on the residuals. Because the residuals are estimated, the decision uses the residual-based Engle–Granger critical value (≈ −3.34 at 5% for one regressor), not the raw ADF table. - engleGranger().return.alpha: number; default: not declared — Intercept of the cointegrating regression. - engleGranger().return.beta: number; default: not declared — Slope of the cointegrating regression `y = α + β·x + resid`. - engleGranger().return.cointegrated: boolean; default: not declared — `true` when the residual ADF statistic falls below the 5% Engle–Granger critical value. - engleGranger().return.residualAugmentedDickeyFuller: import('@insiderfinance/totalfinance/math').TestResult; default: not declared — ADF test on the regression residuals (the cointegration test statistic). - engleGranger(dependent): number[]; default: not declared - engleGranger(independent): number[]; default: not declared - estimateCovariance: (series: number[][], options?: import('@insiderfinance/totalfinance/math').EstimateCovarianceOptions) => import('@insiderfinance/totalfinance/math').CovarianceEstimate; default: not declared — The covariance-estimation front door: turn a returns matrix into a well-conditioned (usually invertible) covariance and report its **conditioning** so a caller knows whether it is safe to invert. `'sample'` and `'ewma'` are the raw estimators (never altered; flagged + `converged: false` when singular); `'ledoit-wolf'` and `'ridge'` GUARANTEE an SPD result — degenerate/collinear inputs are eigenvalue-floored with a `math.covariance_floored` warning rather than returned singular; `'auto'` (default) uses the sample when it is SPD and well-conditioned, else shrinks (inheriting the SPD guarantee). `series[k]` is variable k's observations (p × T), matching {@link covarianceMatrix}. See `docs/specs/estimate-covariance.md`. - estimateCovariance().return.assumptions: { conventionsVersion: string; method: string; population: boolean; marketProxy?: 'observed-series' | 'equal-weight'; }; default: not declared - estimateCovariance().return.assumptions.conventionsVersion: string; default: not declared - estimateCovariance().return.assumptions.marketProxy?: 'observed-series' | 'equal-weight'; default: not declared — Single-index target only: the caller's observed market series vs the equal-weight proxy. - estimateCovariance().return.assumptions.method: string; default: not declared - estimateCovariance().return.assumptions.population: boolean; default: not declared - estimateCovariance().return.conditionNumber: number; default: not declared — `maxEigenvalue / minEigenvalue` (`Infinity` when singular). - estimateCovariance().return.covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — The estimated covariance. - estimateCovariance().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - estimateCovariance().return.effectiveObservations?: number; default: not declared — Kish effective sample size `1/Σwₜ²` — present only for method `'ewma'`. - estimateCovariance().return.effectiveRank: number; default: not declared — Number of eigenvalues `> 1e-9 · maxEigenvalue` — the effective rank. - estimateCovariance().return.isPositiveDefinite: boolean; default: not declared — Whether the returned covariance is positive-definite (invertible). - estimateCovariance().return.lambda?: number; default: not declared — The EWMA decay used — present only for method `'ewma'`. - estimateCovariance().return.maxEigenvalue: number; default: not declared — Largest eigenvalue of the returned covariance. - estimateCovariance().return.method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; default: not declared — The estimator actually used (`'auto'` resolves to one of these). - estimateCovariance().return.minEigenvalue: number; default: not declared — Smallest eigenvalue of the returned covariance. - estimateCovariance().return.observations: number; default: not declared — Number of observations `T`. - estimateCovariance().return.shrinkage?: number; default: not declared — Ledoit–Wolf shrinkage intensity, present when `method` is `'ledoit-wolf'`. - estimateCovariance().return.variables: number; default: not declared — Number of variables `p`. - estimateCovariance(options)?: import('@insiderfinance/totalfinance/math').EstimateCovarianceOptions; default: not declared - estimateCovariance(options).conditionThreshold?: number; default: not declared — Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. - estimateCovariance(options).halfLife?: number; default: not declared — EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. - estimateCovariance(options).lambda?: number; default: not declared — EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). - estimateCovariance(options).ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` (the market-model target, best-specified for stock returns). - estimateCovariance(options).market?: ArrayLike; default: not declared — Observed market return series for the `'single-index'` target (length `T`). Omitted → the equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. - estimateCovariance(options).method?: import('@insiderfinance/totalfinance/math').CovarianceMethod; default: not declared — Estimator; default `'auto'`. - estimateCovariance(options).population?: boolean; default: not declared — Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). - estimateCovariance(options).ridge?: number; default: not declared — Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. - estimateCovariance(series): number[][]; default: not declared - findRoot: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, lowerBound: number, upperBound: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Safe hybrid solver: expand a bracket if needed, then run Brent. Kept as a named entrypoint so callers express intent ("give me the robust default"). - findRoot().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - findRoot().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - findRoot().return.iterations: number; default: not declared — Iterations performed. - findRoot().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - findRoot().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - findRoot().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - findRoot().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - findRoot(lowerBound): number; default: not declared - findRoot(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - findRoot(options)?: import('@insiderfinance/totalfinance/math').SolverOptions | undefined; default: not declared - findRoot(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - findRoot(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - findRoot(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - findRoot(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - findRoot(upperBound): number; default: not declared - gamma: { readonly cdf: (x: number, shape: number, theta?: number) => number; readonly inverseCdf: (probability: number, shape: number, theta?: number) => number; }; default: not declared — The gamma distribution with shape `k > 0` and scale `θ > 0` (default `θ = 1`). - gamma.cdf: (x: number, shape: number, theta?: number) => number; default: not declared — Cumulative distribution `F(x; k, θ) = P(k, x/θ)`. For `k = 1` this is the exponential CDF `1 − e^(−x/θ)`. - gamma.cdf(shape): number; default: not declared - gamma.cdf(theta)?: number; default: not declared - gamma.cdf(x): number; default: not declared - gamma.inverseCdf: (probability: number, shape: number, theta?: number) => number; default: not declared — Quantile (inverse CDF) on `(0, ∞)`. - gamma.inverseCdf(probability): number; default: not declared - gamma.inverseCdf(shape): number; default: not declared - gamma.inverseCdf(theta)?: number; default: not declared - gaussLegendre: (integrand: import('@insiderfinance/totalfinance/math').ScalarFunction, lowerBound: number, upperBound: number, nodeCount?: number) => number; default: not declared — Gauss–Legendre integration of `f` on `[a, b]` using `n` points (default 10). - gaussLegendre(integrand): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - gaussLegendre(lowerBound): number; default: not declared - gaussLegendre(nodeCount)?: number; default: not declared - gaussLegendre(upperBound): number; default: not declared - gaussLegendreNodes: (nodeCount: number) => Quadrature; default: not declared — Gauss–Legendre nodes and weights on `[-1, 1]` for `n` points, as a FRESH pair of arrays. The rule is computed once per order and memoized, but the cached arrays are never handed out: a caller who scaled the returned nodes in place (the obvious way to map them onto `[a, b]`) used to corrupt the shared cache, and every later integral at that order — anywhere in the process — silently integrated against the mutated rule. A copy per call costs `2n` doubles; the alternative is a global that any caller can poison. - gaussLegendreNodes().return.nodes: number[]; default: not declared - gaussLegendreNodes().return.weights: number[]; default: not declared - gaussLegendreNodes(nodeCount): number; default: not declared - goldenSectionMin: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, lowerBound: number, upperBound: number, options?: import('@insiderfinance/totalfinance/math').MinOptions) => import('@insiderfinance/totalfinance/math').MinResult; default: not declared - goldenSectionMin().return.argMin: number; default: not declared - goldenSectionMin().return.converged: boolean; default: not declared - goldenSectionMin().return.evaluations?: number; default: not declared — Objective evaluations performed (interpretability parity across optimizers). - goldenSectionMin().return.iterations: number; default: not declared - goldenSectionMin().return.minimum: number; default: not declared - goldenSectionMin().return.reason?: 'max_iterations' | 'non_finite'; default: not declared - goldenSectionMin(lowerBound): number; default: not declared - goldenSectionMin(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - goldenSectionMin(options)?: import('@insiderfinance/totalfinance/math').MinOptions; default: not declared - goldenSectionMin(options).maximumIterations?: number; default: not declared - goldenSectionMin(options).tolerance?: number; default: not declared - goldenSectionMin(upperBound): number; default: not declared - halley: (objective: import('@insiderfinance/totalfinance/math').FunctionWithDerivatives, x0: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Halley's method (cubic convergence). `objective` returns `{ f, df, d2f }`. - halley().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - halley().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - halley().return.iterations: number; default: not declared — Iterations performed. - halley().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - halley().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - halley().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - halley().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - halley(objective): import('@insiderfinance/totalfinance/math').FunctionWithDerivatives; default: not declared - halley(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - halley(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - halley(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - halley(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - halley(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - halley(x0): number; default: not declared - haltonPoint: (index: number, dimensions: number) => number[]; default: not declared — Halton point at `index` in `dimensions` dimensions. - haltonPoint(dimensions): number; default: not declared - haltonPoint(index): number; default: not declared - haltonSequence: (count: number, dimensions: number, options?: { start?: number; }) => number[][]; default: not declared — Halton sequence of `n` points in `dimensions` dimensions, starting at `start` (default 1, skips origin). - haltonSequence(count): number; default: not declared - haltonSequence(dimensions): number; default: not declared - haltonSequence(options)?: { start?: number; }; default: not declared - haltonSequence(options).start?: number; default: not declared - householder: (objective: import('@insiderfinance/totalfinance/math').FunctionWithDerivatives, x0: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Householder's method of order 3 (quartic convergence). `objective` returns `{ f, df, d2f, d3f }`. - householder().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - householder().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - householder().return.iterations: number; default: not declared — Iterations performed. - householder().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - householder().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - householder().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - householder().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - householder(objective): import('@insiderfinance/totalfinance/math').FunctionWithDerivatives; default: not declared - householder(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - householder(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - householder(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - householder(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - householder(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - householder(x0): number; default: not declared - hurstExponent: (series: number[]) => number; default: not declared — Hurst exponent via rescaled-range (R/S) analysis. For a geometric progression of window sizes the mean rescaled range `⟨R/S⟩ₙ` scales as `nᴴ`; `H` is the slope of `log⟨R/S⟩` on `log n`. R/S is computed on the input series AS GIVEN, so the usual reading — `H ≈ 0.5` random walk, `H > 0.5` persistence/trending, `H < 0.5` mean reversion — assumes an INCREMENT (returns) series. Passing an integrated level series (e.g. a price path) instead yields `H ≈ 1`. BIAS CAVEAT — read this before calling 0.55 "persistence". This is PLAIN R/S with no Anis–Lloyd (1976) small-sample correction, and plain R/S is biased UPWARD at every finite sample size: for independent data `E[R/S]ₙ` is not `n^0.5`, so the slope is not 0.5 either. Measured on this implementation over 20 seeds of iid normal input (mean, and the spread across seeds): - `n = 512` → `H ≈ 0.565` (0.52 … 0.65) - `n = 4096` → `H ≈ 0.538` (0.48 … 0.59) - `n = 32768` → `H ≈ 0.534` (0.51 … 0.56) The bias shrinks with `n` but is still ~0.03 at 32k points, and the seed-to-seed spread is wider than the bias itself. So a lone `H = 0.55` on 4k observations is evidence of NOTHING. Compare against a shuffled (or synthetic iid) version of your own series at the SAME length rather than against the textbook 0.5, or use a corrected estimator. The ORDERING (anti-persistent < iid < persistent, as the test suite asserts) is reliable; the absolute level is not. - hurstExponent(series): number[]; default: not declared - identity: (size: number) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — The `n × n` identity matrix. - identity(size): number; default: not declared - jacobiEigen: (input: import('@insiderfinance/totalfinance/math').Matrix, options?: { maximumIterations?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/math').EigenResult; default: not declared — Symmetric eigendecomposition via cyclic Jacobi rotations. The tolerance is RELATIVE to the input's off-diagonal Frobenius norm, so a matrix scaled by any constant converges identically (an absolute tolerance would spin to `maximumIterations` on a large-scaled covariance matrix). Throws `ConvergenceError` (`linalg.no_convergence`) if the sweeps do not reach the tolerance within `maximumIterations`. The input must be SQUARE and finite. It used to be neither checked nor needed: every loop is indexed by `input.length`, so a `2×3` matrix quietly returned the eigenvalues of its leading `2×2` block — the right shape, the wrong matrix, and no way for the caller to tell. (Non-symmetric square input is still accepted and still reports non-convergence through `ConvergenceError` when the rotations cannot diagonalize it; use {@link eigenvalues} for the general case.) - jacobiEigen().return.values: number[]; default: not declared — Eigenvalues (not sorted). - jacobiEigen().return.vectors: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Eigenvectors as columns of the matrix. - jacobiEigen(input): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - jacobiEigen(options)?: { maximumIterations?: number; tolerance?: number; }; default: not declared - jacobiEigen(options).maximumIterations?: number; default: not declared - jacobiEigen(options).tolerance?: number; default: not declared - kalmanFilter: (model: import('@insiderfinance/totalfinance/math').KalmanModel, observations: import('@insiderfinance/totalfinance/math').KalmanObservation[]) => import('@insiderfinance/totalfinance/math').KalmanFilterResult; default: not declared — Run the forward Kalman recursion over `observations`. Each step predicts `xₜ|ₜ₋₁` from the previous filtered state, then (when the observation is present) updates to `xₜ|ₜ` and accumulates the Gaussian log-likelihood. Missing observations predict only. - kalmanFilter().return.filteredCovariances: import('@insiderfinance/totalfinance/math').Matrix[]; default: not declared — Filtered state covariances `Pₜ|ₜ`. - kalmanFilter().return.filteredStates: number[][]; default: not declared — Filtered state means `x̂ₜ|ₜ` (`T × n`). - kalmanFilter().return.innovationCovariances: (import('@insiderfinance/totalfinance/math').Matrix | null)[]; default: not declared — Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). - kalmanFilter().return.innovations: (number[] | null)[]; default: not declared — Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). - kalmanFilter().return.logLikelihood: number; default: not declared — Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. - kalmanFilter().return.observationDimension: number; default: not declared — Observation dimension. - kalmanFilter().return.observedCount: number; default: not declared — Number of steps that contributed to the likelihood (observed steps). - kalmanFilter().return.predictedCovariances: import('@insiderfinance/totalfinance/math').Matrix[]; default: not declared — One-step predicted state covariances `Pₜ|ₜ₋₁`. - kalmanFilter().return.predictedStates: number[][]; default: not declared — One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). - kalmanFilter().return.stateDimension: number; default: not declared — State dimension. - kalmanFilter(model): import('@insiderfinance/totalfinance/math').KalmanModel; default: not declared - kalmanFilter(model).F: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — State-transition matrix `F`, `n × n`. - kalmanFilter(model).H: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Observation matrix `H`, `m × n`. - kalmanFilter(model).P0: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - kalmanFilter(model).Q: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - kalmanFilter(model).R: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - kalmanFilter(model).x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. - kalmanFilter(observations): import('@insiderfinance/totalfinance/math').KalmanObservation[]; default: not declared - kalmanLogLikelihood: (model: import('@insiderfinance/totalfinance/math').KalmanModel, observations: import('@insiderfinance/totalfinance/math').KalmanObservation[]) => number; default: not declared — The Gaussian log-likelihood of `observations` under `model` — the innovation-form likelihood from the forward pass. This is the objective to maximise when calibrating `{ F, H, Q, R }` (e.g. by a Nelder–Mead search over a parameterisation of the system matrices). - kalmanLogLikelihood(model): import('@insiderfinance/totalfinance/math').KalmanModel; default: not declared - kalmanLogLikelihood(model).F: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — State-transition matrix `F`, `n × n`. - kalmanLogLikelihood(model).H: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Observation matrix `H`, `m × n`. - kalmanLogLikelihood(model).P0: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - kalmanLogLikelihood(model).Q: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - kalmanLogLikelihood(model).R: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - kalmanLogLikelihood(model).x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. - kalmanLogLikelihood(observations): import('@insiderfinance/totalfinance/math').KalmanObservation[]; default: not declared - kalmanSmooth: (model: import('@insiderfinance/totalfinance/math').KalmanModel, observations: import('@insiderfinance/totalfinance/math').KalmanObservation[]) => import('@insiderfinance/totalfinance/math').KalmanSmoothResult; default: not declared — Rauch–Tung–Striebel fixed-interval smoother. Runs the forward filter, then a backward pass giving `xₜ|T` / `Pₜ|T` — the state estimates conditioned on the WHOLE sample, always at least as sharp as the filtered estimates. The backward gain is `Cₜ = Pₜ|ₜ·Fᵀ·(Pₜ₊₁|ₜ)⁻¹`, solved through the Cholesky factor of the predicted covariance — or, when that covariance is singular because the model has a deterministic component, through its pseudoinverse (see {@link rtsGain}). - kalmanSmooth().return.filteredCovariances: import('@insiderfinance/totalfinance/math').Matrix[]; default: not declared — Filtered state covariances `Pₜ|ₜ`. - kalmanSmooth().return.filteredStates: number[][]; default: not declared — Filtered state means `x̂ₜ|ₜ` (`T × n`). - kalmanSmooth().return.innovationCovariances: (import('@insiderfinance/totalfinance/math').Matrix | null)[]; default: not declared — Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). - kalmanSmooth().return.innovations: (number[] | null)[]; default: not declared — Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). - kalmanSmooth().return.logLikelihood: number; default: not declared — Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. - kalmanSmooth().return.observationDimension: number; default: not declared — Observation dimension. - kalmanSmooth().return.observedCount: number; default: not declared — Number of steps that contributed to the likelihood (observed steps). - kalmanSmooth().return.predictedCovariances: import('@insiderfinance/totalfinance/math').Matrix[]; default: not declared — One-step predicted state covariances `Pₜ|ₜ₋₁`. - kalmanSmooth().return.predictedStates: number[][]; default: not declared — One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). - kalmanSmooth().return.smoothedCovariances: import('@insiderfinance/totalfinance/math').Matrix[]; default: not declared — Smoothed state covariances `Pₜ|T`. - kalmanSmooth().return.smoothedStates: number[][]; default: not declared — Smoothed state means `x̂ₜ|T` using all `T` observations (`T × n`). - kalmanSmooth().return.stateDimension: number; default: not declared — State dimension. - kalmanSmooth(model): import('@insiderfinance/totalfinance/math').KalmanModel; default: not declared - kalmanSmooth(model).F: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — State-transition matrix `F`, `n × n`. - kalmanSmooth(model).H: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Observation matrix `H`, `m × n`. - kalmanSmooth(model).P0: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - kalmanSmooth(model).Q: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - kalmanSmooth(model).R: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - kalmanSmooth(model).x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. - kalmanSmooth(observations): import('@insiderfinance/totalfinance/math').KalmanObservation[]; default: not declared - kpssTest: (series: number[], options?: import('@insiderfinance/totalfinance/math').KpssOptions) => import('@insiderfinance/totalfinance/math').TestResult; default: not declared — Kwiatkowski–Phillips–Schmidt–Shin (KPSS) stationarity test. The null is (level or trend) stationarity, so a LARGE statistic (above the critical value) rejects stationarity — the mirror image of ADF. The bandwidth for the long-run variance defaults to `⌊4·(T/100)^¼⌋`. - kpssTest().return.criticalValues?: { '1%': number; '5%': number; '10%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - kpssTest().return.criticalValues.1%: number; default: not declared - kpssTest().return.criticalValues.10%: number; default: not declared - kpssTest().return.criticalValues.5%: number; default: not declared - kpssTest().return.method: string; default: not declared — Human-readable identifier of the test and its configuration. - kpssTest().return.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - kpssTest().return.statistic: number; default: not declared — The test statistic. - kpssTest(options)?: import('@insiderfinance/totalfinance/math').KpssOptions; default: not declared - kpssTest(options).regression?: 'c' | 'ct'; default: not declared — `'c'` = level stationarity (default), `'ct'` = trend stationarity. - kpssTest(series): number[]; default: not declared - kurtosis: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').KurtosisOptions) => number; default: not declared — Population kurtosis; excess (−3) by default. - kurtosis(options)?: import('@insiderfinance/totalfinance/math').KurtosisOptions | undefined; default: not declared - kurtosis(options).excess?: boolean; default: not declared — Return excess kurtosis (subtract 3). Default `true`. - kurtosis(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - kurtosis(xs): ArrayLike; default: not declared - ledoitWolfShrinkage: (series: number[][], options?: import('@insiderfinance/totalfinance/math').LedoitWolfOptions) => import('@insiderfinance/totalfinance/math').LedoitWolfResult; default: not declared - ledoitWolfShrinkage().return.averageCorrelation?: number; default: not declared — Average off-diagonal sample correlation `r̄` — the constant-correlation target's correlation (that target only). - ledoitWolfShrinkage().return.averageVariance: number; default: not declared — Average variance `μ = tr(S)/p` — the scaled-identity target's diagonal. - ledoitWolfShrinkage().return.covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Shrunk covariance `Σ* = δ·F + (1−δ)·S` (`F` = the chosen target) — symmetric positive-definite even when `T < p`. - ledoitWolfShrinkage().return.marketVariance?: number; default: not declared — Variance of the equal-weighted market proxy `varmkt` — the single-index target's factor variance (that target only). - ledoitWolfShrinkage().return.observations: number; default: not declared — Number of observations `T`. - ledoitWolfShrinkage().return.sampleCovariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Raw sample covariance `S` (`1/T` / MLE normalization). - ledoitWolfShrinkage().return.shrinkage: number; default: not declared — Optimal shrinkage intensity `δ ∈ [0, 1]`. - ledoitWolfShrinkage().return.target: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — The shrinkage target used. - ledoitWolfShrinkage(options)?: import('@insiderfinance/totalfinance/math').LedoitWolfOptions; default: not declared - ledoitWolfShrinkage(options).market?: ArrayLike; default: not declared — Observed market return series (length `T`, chronological) for the `'single-index'` target. When omitted the equal-weight cross-sectional average of `series` is used as the market proxy (Ledoit–Wolf 2003's construction); {@link estimateCovariance} discloses which was used. - ledoitWolfShrinkage(options).target?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Shrinkage target: `'identity'` (the scaled identity `μI`, the default and original), `'constant-correlation'` (the Ledoit–Wolf 2004 target — each variable's own variance with the **average** sample correlation on every off-diagonal, which fits correlated asset returns far better), or `'single-index'` (the Ledoit–Wolf 2003 market-model target — a one-factor structure built from each variable's covariance with the equal-weighted market, the best-specified target for stock returns). - ledoitWolfShrinkage(series): number[][]; default: not declared - levenbergMarquardt: (residuals: (p: number[]) => number[], p0: number[], options?: import('@insiderfinance/totalfinance/math').LMOptions) => import('@insiderfinance/totalfinance/math').LevenbergMarquardtResult; default: not declared — Levenberg–Marquardt least-squares minimization of `||residuals(parameters)||²`. - levenbergMarquardt().return.converged: boolean; default: not declared - levenbergMarquardt().return.evaluations?: number; default: not declared — Residual-vector evaluations performed (interpretability parity with the other optimizers). - levenbergMarquardt().return.iterations: number; default: not declared - levenbergMarquardt().return.parameters: number[]; default: not declared - levenbergMarquardt().return.reason?: 'max_iterations'; default: not declared - levenbergMarquardt().return.residualNorm: number; default: not declared - levenbergMarquardt(options)?: import('@insiderfinance/totalfinance/math').LMOptions; default: not declared - levenbergMarquardt(options).lambda0?: number; default: not declared - levenbergMarquardt(options).maximumIterations?: number; default: not declared - levenbergMarquardt(options).tolerance?: number; default: not declared - levenbergMarquardt(p0): number[]; default: not declared - levenbergMarquardt(residuals): (p: number[]) => number[]; default: not declared - lgamma: (x: number) => number; default: not declared — Natural log of the gamma function, `ln Γ(x)`, via the Lanczos approximation (g = 7, 9 coefficients), accurate to ~1e-15 for `x > 0`. Uses the reflection formula `Γ(x)Γ(1−x) = π / sin(πx)` for `x < 0.5`. - lgamma(x): number; default: not declared - linearInterp: (xs: ArrayLike, ys: ArrayLike, x: number, options?: import('@insiderfinance/totalfinance/math').InterpolateOptions) => number; default: not declared — Interpolate `y` at `x` over the points `(xs[i], ys[i])`. TRUSTED FAST PATH: `xs` MUST be strictly ascending and the same length as `ys` — this function does not validate (it binary-searches and assumes order), so out-of-order input yields nonsense. For validated, axis-checked construction use {@link makePchipInterpolator} / {@link makeNaturalCubicSpline} (or call {@link validateInterpolationData} first). - linearInterp(options)?: import('@insiderfinance/totalfinance/math').InterpolateOptions; default: not declared - linearInterp(options).extrapolate?: import('@insiderfinance/totalfinance/math').ExtrapolationPolicy; default: not declared - linearInterp(x): number; default: not declared - linearInterp(xs): ArrayLike; default: not declared - linearInterp(ys): ArrayLike; default: not declared - ljungBox: (series: number[], lags: number, options?: import('@insiderfinance/totalfinance/math').LjungBoxOptions) => import('@insiderfinance/totalfinance/math').TestResult; default: not declared — Ljung–Box portmanteau test for autocorrelation up to `lags`: `Q = N(N+2) Σ_{k=1}^{h} ρ̂ₖ² / (N−k)`, distributed `χ²(h)` under the white-noise null. The p-value is the exact chi-square survival function. On ARMA RESIDUALS the white-noise null is the wrong reference: fitting `p + q` parameters to the same data absorbs autocorrelation the statistic then fails to see, so `χ²(h)` is too conservative and the test under-rejects. Pass `fittedParameterCount` to use the standard corrected reference `χ²(h − p − q)` (Box–Jenkins); the returned `method` discloses the degrees of freedom actually used. The statistic itself is unchanged — only the reference distribution moves. - ljungBox().return.criticalValues?: { '1%': number; '5%': number; '10%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - ljungBox().return.criticalValues.1%: number; default: not declared - ljungBox().return.criticalValues.10%: number; default: not declared - ljungBox().return.criticalValues.5%: number; default: not declared - ljungBox().return.method: string; default: not declared — Human-readable identifier of the test and its configuration. - ljungBox().return.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - ljungBox().return.statistic: number; default: not declared — The test statistic. - ljungBox(lags): number; default: not declared - ljungBox(options)?: import('@insiderfinance/totalfinance/math').LjungBoxOptions; default: not declared - ljungBox(options).fittedParameterCount?: number; default: not declared — Number of parameters ESTIMATED from the same series before the test (e.g. `p + q` for the residuals of an ARMA(p, q) fit). The reference distribution loses one degree of freedom per fitted parameter: `Q ~ χ²(lags − fittedParameterCount)`. Default 0 — the raw white-noise null, which is the right reference only for a series that was NOT fitted. - ljungBox(series): number[]; default: not declared - luDecompose: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').LuResult; default: not declared — LU decomposition with partial pivoting: `P·A = L·U`. Throws on a singular matrix. - luDecompose().return.lu: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Combined lower/upper factors (unit-diagonal `L` below, `U` on and above the diagonal). - luDecompose().return.pivotIndices: number[]; default: not declared — Row permutation: `pivotIndices[i]` is the source row moved into row `i`. - luDecompose().return.sign: number; default: not declared — Sign of the permutation (+1 or −1), for the determinant. - luDecompose(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - luSolve: (result: import('@insiderfinance/totalfinance/math').LuResult, b: number[]) => number[]; default: not declared — Solve `A·x = b` from a precomputed {@link luDecompose} result. - luSolve(b): number[]; default: not declared - luSolve(result): import('@insiderfinance/totalfinance/math').LuResult; default: not declared - luSolve(result).lu: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Combined lower/upper factors (unit-diagonal `L` below, `U` on and above the diagonal). - luSolve(result).pivotIndices: number[]; default: not declared — Row permutation: `pivotIndices[i]` is the source row moved into row `i`. - luSolve(result).sign: number; default: not declared — Sign of the permutation (+1 or −1), for the determinant. - makeBicubicInterpolator: (xs: ArrayLike, ys: ArrayLike, z: number[][]) => (x: number, y: number) => number; default: not declared — Build a reusable **bicubic** interpolator over a regular grid `z[i][j] = f(xs[i], ys[j])` — a smooth tensor-product natural cubic spline (C² in both axes). One x-spline is precomputed per y-column; each query splines those column values along y. Smoother than {@link bilinearInterp} for vol/price surfaces. Both axes must be strictly increasing and `z` must be `xs.length × ys.length`; both are CHECKED once here, at construction. - makeBicubicInterpolator(xs): ArrayLike; default: not declared - makeBicubicInterpolator(ys): ArrayLike; default: not declared - makeBicubicInterpolator(z): number[][]; default: not declared - makeLinearInterpolator: (xs: ArrayLike, ys: ArrayLike, options?: import('@insiderfinance/totalfinance/math').InterpolateOptions & import('@insiderfinance/totalfinance/math').AxisOptions) => (x: number) => number; default: not declared — Build a reusable linear interpolator over fixed points (validates the axis by default). - makeLinearInterpolator(options)?: (import('@insiderfinance/totalfinance/math').InterpolateOptions & import('@insiderfinance/totalfinance/math').AxisOptions) | undefined; default: not declared - makeLinearInterpolator(xs): ArrayLike; default: not declared - makeLinearInterpolator(ys): ArrayLike; default: not declared - makeNaturalCubicSpline: (xs: ArrayLike, ys: ArrayLike, options?: import('@insiderfinance/totalfinance/math').AxisOptions) => (x: number) => number; default: not declared — Build a natural cubic spline interpolator (second derivative zero at both ends). - makeNaturalCubicSpline(options)?: import('@insiderfinance/totalfinance/math').AxisOptions; default: not declared - makeNaturalCubicSpline(options).aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - makeNaturalCubicSpline(options).assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - makeNaturalCubicSpline(options).extrapolate?: import('@insiderfinance/totalfinance/math').ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). - makeNaturalCubicSpline(xs): ArrayLike; default: not declared - makeNaturalCubicSpline(ys): ArrayLike; default: not declared - makePchipInterpolator: (xs: ArrayLike, ys: ArrayLike, options?: import('@insiderfinance/totalfinance/math').AxisOptions) => (x: number) => number; default: not declared — Build a PCHIP (monotone cubic Hermite) interpolator — shape-preserving, no overshoot. - makePchipInterpolator(options)?: import('@insiderfinance/totalfinance/math').AxisOptions; default: not declared - makePchipInterpolator(options).aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - makePchipInterpolator(options).assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - makePchipInterpolator(options).extrapolate?: import('@insiderfinance/totalfinance/math').ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). - makePchipInterpolator(xs): ArrayLike; default: not declared - makePchipInterpolator(ys): ArrayLike; default: not declared - matrixMultiply: (left: import('@insiderfinance/totalfinance/math').Matrix, right: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Matrix product `A (m×k) · B (k×n)` → `m×n`. Throws on a dimension mismatch. - matrixMultiply(left): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - matrixMultiply(right): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - matrixVectorProduct: (matrix: import('@insiderfinance/totalfinance/math').Matrix, vector: number[]) => number[]; default: not declared — Matrix–vector product `A (m×n) · x (n)` → `m`. - matrixVectorProduct(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - matrixVectorProduct(vector): number[]; default: not declared - max: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared - max(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - max(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - max(xs): ArrayLike; default: not declared - mean: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared - mean(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - mean(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - mean(xs): ArrayLike; default: not declared - median: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared - median(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - median(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - median(xs): ArrayLike; default: not declared - medianAbsoluteDeviation: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').MedianAbsoluteDeviationOptions) => number; default: not declared — Median absolute deviation. - medianAbsoluteDeviation(options)?: import('@insiderfinance/totalfinance/math').MedianAbsoluteDeviationOptions | undefined; default: not declared - medianAbsoluteDeviation(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - medianAbsoluteDeviation(options).scale?: boolean; default: not declared — Scale by 1.4826 for consistency with the normal stddev (default `true`). - medianAbsoluteDeviation(xs): ArrayLike; default: not declared - min: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared - min(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - min(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - min(xs): ArrayLike; default: not declared - monteCarlo: (sampler: (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator) => number, options: import('@insiderfinance/totalfinance/math').MonteCarloOptions) => import('@insiderfinance/totalfinance/math').MonteCarloResult; default: not declared - monteCarlo().return.confidenceInterval: [number, number]; default: not declared — Confidence interval at the requested level (default 95%). - monteCarlo().return.converged: boolean; default: not declared — Whether the target standard error was reached (always true when no target is set). - monteCarlo().return.paths: number; default: not declared - monteCarlo().return.seed: number; default: not declared - monteCarlo().return.standardError: number; default: not declared - monteCarlo().return.value: number; default: not declared - monteCarlo().return.variance: number; default: not declared - monteCarlo(options): import('@insiderfinance/totalfinance/math').MonteCarloOptions; default: not declared - monteCarlo(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarlo(options).minPaths?: number; default: not declared — Minimum paths before the stopping rule applies (default 1000). - monteCarlo(options).paths?: number; default: not declared — Maximum paths (default 100_000). - monteCarlo(options).randomNumberGenerator?: (seed: number) => import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared — RNG factory (default mulberry32). - monteCarlo(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - monteCarlo(options).targetStandardError?: number; default: not declared — Stop once the standard error falls to/below this (after `minPaths`). - monteCarlo(sampler): (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator) => number; default: not declared - mulberry32: (seed: number) => import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared — Mulberry32 — a small, fast, well-distributed seedable PRNG. The state is seeded with `seed >>> 0` (the algorithm is 32-bit), but the ECHOED `seed` is the caller's literal argument: a run seeded with `-1` is reproduced by passing `-1`, and reporting `4294967295` back would send a reader looking for a seed they never used. - mulberry32().return.getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - mulberry32().return.next: () => number; default: not declared — Uniform sample in [0, 1). - mulberry32().return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - mulberry32(seed): number; default: not declared - nearestCorrelation: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — A valid correlation matrix near `matrix`: ONE eigenvalue-clipping pass to PSD ({@link nearestPsd}), then a rescale to a unit diagonal. Not the Frobenius-NEAREST correlation matrix. That is Higham's (2002) alternating-projections problem, iterated to convergence between the PSD cone and the unit-diagonal set; the rescale here is a single projection that can push the result slightly off the PSD cone again (the output is PSD to within the rescale, not by construction). It is the standard cheap repair — good enough to make a noisy correlation estimate usable for Cholesky/simulation — and it is deterministic and O(n³), but a caller who needs the true minimizer needs Higham's iteration, not this. - nearestCorrelation(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - nearestPsd: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Nearest positive-semidefinite matrix (eigenvalue clipping). - nearestPsd(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - nelderMead: (objective: import('@insiderfinance/totalfinance/math').MultivariateFunction, start: number[], options?: import('@insiderfinance/totalfinance/math').MultiMinOptions) => import('@insiderfinance/totalfinance/math').MultiMinResult; default: not declared — Nelder–Mead simplex minimization (derivative-free). - nelderMead().return.argMin: number[]; default: not declared - nelderMead().return.converged: boolean; default: not declared - nelderMead().return.evaluations?: number; default: not declared — Objective evaluations performed. - nelderMead().return.iterations: number; default: not declared - nelderMead().return.minimum: number; default: not declared - nelderMead().return.reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - nelderMead().return.seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. - nelderMead(objective): import('@insiderfinance/totalfinance/math').MultivariateFunction; default: not declared - nelderMead(options)?: import('@insiderfinance/totalfinance/math').MultiMinOptions; default: not declared - nelderMead(options).grad?: (point: number[]) => number[]; default: not declared — Analytic gradient; if omitted, a central-difference gradient is used (BFGS only). - nelderMead(options).maximumIterations?: number; default: not declared - nelderMead(options).tolerance?: number; default: not declared - nelderMead(start): number[]; default: not declared - newton: (objective: import('@insiderfinance/totalfinance/math').FunctionWithDerivatives, x0: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Newton–Raphson. `objective` returns `{ f, df }`. - newton().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - newton().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - newton().return.iterations: number; default: not declared — Iterations performed. - newton().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - newton().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - newton().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - newton().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - newton(objective): import('@insiderfinance/totalfinance/math').FunctionWithDerivatives; default: not declared - newton(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - newton(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - newton(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - newton(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - newton(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - newton(x0): number; default: not declared - normal: { readonly pdf: (x: number) => number; readonly cdf: (x: number) => number; readonly inverseCdf: (probability: number) => number; readonly survivalFunction: (x: number) => number; readonly logPdf: (x: number) => number; readonly logCdf: (x: number) => number; readonly logSurvivalFunction: (x: number) => number; }; default: not declared — Convenience namespace mirroring the spec's `normal.pdf/cdf/inverseCdf` facade. - normal.cdf: (x: number) => number; default: not declared - normal.cdf(x): number; default: not declared - normal.inverseCdf: (probability: number) => number; default: not declared - normal.inverseCdf(probability): number; default: not declared - normal.logCdf: (x: number) => number; default: not declared - normal.logCdf(x): number; default: not declared - normal.logPdf: (x: number) => number; default: not declared - normal.logPdf(x): number; default: not declared - normal.logSurvivalFunction: (x: number) => number; default: not declared - normal.logSurvivalFunction(x): number; default: not declared - normal.pdf: (x: number) => number; default: not declared - normal.pdf(x): number; default: not declared - normal.survivalFunction: (x: number) => number; default: not declared - normal.survivalFunction(x): number; default: not declared - normalCdf: (x: number) => number; default: not declared — Standard normal cumulative distribution function Φ(x). - normalCdf(x): number; default: not declared - normalInverseCdf: (probability: number) => number; default: not declared — Inverse standard normal CDF (quantile function). Returns `-Infinity` at p<=0 and `+Infinity` at p>=1. - normalInverseCdf(probability): number; default: not declared - normalLogCdf: (x: number) => number; default: not declared — Log of the standard normal CDF, stable into the far-left tail (where Φ(x) underflows to 0). Uses `log(Φ(x))` for `x ≥ -20` and the asymptotic expansion `Φ(x) = φ(x)/(-x)·(1 − 1/x² + 3/x⁴ − 15/x⁶ + …)` below that. - normalLogCdf(x): number; default: not declared - normalLogPdf: (x: number) => number; default: not declared — Log of the standard normal PDF — exact and stable everywhere. - normalLogPdf(x): number; default: not declared - normalLogSurvivalFunction: (x: number) => number; default: not declared — Log of the standard normal survival function (stable in the far-right tail). - normalLogSurvivalFunction(x): number; default: not declared - normalPdf: (x: number) => number; default: not declared — Standard normal probability density function φ(x). - normalPdf(x): number; default: not declared - normalSample: (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator, mu?: number, sigma?: number) => number; default: not declared - normalSample(mu)?: number; default: not declared - normalSample(randomNumberGenerator): import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared - normalSample(randomNumberGenerator).getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - normalSample(randomNumberGenerator).next: () => number; default: not declared — Uniform sample in [0, 1). - normalSample(randomNumberGenerator).seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - normalSample(sigma)?: number; default: not declared - normalSurvivalFunction: (x: number) => number; default: not declared — Standard normal survival function: 1 − Φ(x) = Φ(−x) (stable in the right tail). - normalSurvivalFunction(x): number; default: not declared - ols: (response: number[], design: number[][], options?: import('@insiderfinance/totalfinance/math').OlsOptions) => import('@insiderfinance/totalfinance/math').OlsResult; default: not declared — Ordinary least squares fit of `y` on `X` (rows = observations, columns = predictors, no intercept column). Returns coefficients, standard errors, t-statistics, `R²`/`R̄²`, and residuals. @param y Response vector, length `n`. @param X Design rows, `n × p` (predictors only; the intercept is added unless disabled). @param options.intercept Prepend an intercept column (default `true`). @param options.hac Newey–West HAC standard errors with a Bartlett kernel of the given bandwidth. - ols().return.adjustedRSquared: number; default: not declared — Degrees-of-freedom-adjusted `R̄²`. - ols().return.coefficientCount: number; default: not declared — Number of estimated coefficients (including the intercept). - ols().return.coefficients: number[]; default: not declared — Fitted coefficients; the intercept is first when `intercept !== false`. - ols().return.observationCount: number; default: not declared — Number of observations. - ols().return.rSquared: number; default: not declared — Coefficient of determination `R²` (centered when an intercept is present). - ols().return.residuals: number[]; default: not declared — Residuals `y − Xβ`, aligned to the input rows. - ols().return.standardErrors: number[]; default: not declared — Standard error of each coefficient (√ of the covariance diagonal). - ols().return.tStatistics: number[]; default: not declared — t-statistic `βⱼ / se(βⱼ)` for each coefficient. - ols(design): number[][]; default: not declared - ols(options)?: import('@insiderfinance/totalfinance/math').OlsOptions; default: not declared - ols(options).hac?: import('@insiderfinance/totalfinance/math').OlsHacOptions; default: not declared — Replace the classical covariance with the Newey–West HAC estimator. - ols(options).intercept?: boolean; default: not declared — Prepend an intercept column of ones (default `true`). - ols(response): number[]; default: not declared - ouHalfLife: (series: number[]) => number; default: not declared — Half-life of mean reversion from an AR(1) fit `xₜ = a + b·x_{t−1} + εₜ`: `halfLife = −ln 2 / ln b`. Defined (positive) only for a mean-reverting series with `0 < b < 1`; returns `NaN` when `b ≤ 0` and a non-positive value when `b ≥ 1` (no reversion), by construction. - ouHalfLife(series): number[]; default: not declared - pacf: (series: number[], maxLag: number) => number[]; default: not declared — Partial autocorrelation function through `maxLag` via the Durbin–Levinson recursion on the sample ACF. Returns `[1, φ₁₁, …, φ_maxLag,maxLag]` (index 0 = 1 by convention). - pacf(maxLag): number; default: not declared - pacf(series): number[]; default: not declared - pseudoInverse: (matrix: import('@insiderfinance/totalfinance/math').Matrix, options?: { rcond?: number; }) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Moore–Penrose pseudoinverse `A⁺` via SVD (singular values below `rcond·σ_max` are dropped). - pseudoInverse(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - pseudoInverse(options)?: { rcond?: number; }; default: not declared - pseudoInverse(options).rcond?: number; default: not declared - qrDecompose: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').QrResult; default: not declared — Householder QR of an `m × n` matrix (`m ≥ n`): `A = Q·R`, `Q` thin with orthonormal columns. - qrDecompose().return.q: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Orthonormal `Q` (`m × n`, thin). - qrDecompose().return.r: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Upper-triangular `R` (`n × n`). - qrDecompose(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - qrSolve: (matrix: import('@insiderfinance/totalfinance/math').Matrix, b: number[], options?: { rcond?: number; }) => number[]; default: not declared — Least-squares solve of `A·x ≈ b` (`m ≥ n`) via QR back-substitution. Rejects a rank-deficient (numerically singular) system rather than silently returning zeroed or blown-up coefficients: if the smallest `|Rᵢᵢ|` pivot falls below `rcond × max|Rᵢᵢ|`, the columns of `A` are collinear and the least-squares solution is not well defined (design law #4 — no silent garbage). Raise `rcond` to reject more aggressively; lower it to admit borderline-conditioned fits. - qrSolve(b): number[]; default: not declared - qrSolve(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - qrSolve(options)?: { rcond?: number; }; default: not declared - qrSolve(options).rcond?: number; default: not declared - quantile: (xs: ArrayLike, probability: number, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared — Quantile via the type-7 (linear interpolation of order statistics) method — the default used by NumPy and R. `p` is in [0, 1]. - quantile(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - quantile(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - quantile(probability): number; default: not declared - quantile(xs): ArrayLike; default: not declared - regularizedBeta: (a: number, b: number, x: number) => number; default: not declared — Regularized incomplete beta `Iₓ(a, b)` — exported primitive behind the Student-t CDF. - regularizedBeta(a): number; default: not declared - regularizedBeta(b): number; default: not declared - regularizedBeta(x): number; default: not declared - regularizedGammaP: (a: number, x: number) => number; default: not declared — Regularized lower incomplete gamma `P(a, x)` — exported for callers (e.g. the chi-square survival used by Ljung–Box) that want the primitive directly rather than through a distribution facade. - regularizedGammaP(a): number; default: not declared - regularizedGammaP(x): number; default: not declared - restoreRandomNumberGenerator: (snapshot: import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState) => import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared — Restore an RNG from a serialized state snapshot. Rejects malformed snapshots (no silent degeneracy). - restoreRandomNumberGenerator().return.getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - restoreRandomNumberGenerator().return.next: () => number; default: not declared — Uniform sample in [0, 1). - restoreRandomNumberGenerator().return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - restoreRandomNumberGenerator(snapshot): import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared - restoreRandomNumberGenerator(snapshot).algorithm: ('mulberry32') | ('xoshiro128ss'); default: not declared - restoreRandomNumberGenerator(snapshot).seed: number; default: not declared - restoreRandomNumberGenerator(snapshot).state: ([number, number, number, number]) | ([number]); default: not declared - ridder: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, a0: number, b0: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Ridder's method: exponential interpolation on a sign-changing bracket. Often beats bisection. - ridder().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - ridder().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - ridder().return.iterations: number; default: not declared — Iterations performed. - ridder().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - ridder().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - ridder().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - ridder().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - ridder(a0): number; default: not declared - ridder(b0): number; default: not declared - ridder(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - ridder(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - ridder(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - ridder(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - ridder(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - ridder(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - rollingCorrelation: (xs: ArrayLike, ys: ArrayLike, window: number) => number[]; default: not declared — Rolling Pearson correlation over a window. Aligned with `NaN` warmup. - rollingCorrelation(window): number; default: not declared - rollingCorrelation(xs): ArrayLike; default: not declared - rollingCorrelation(ys): ArrayLike; default: not declared - rollingCovariance: (xs: ArrayLike, ys: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/math').PopulationOptions) => number[]; default: not declared — Rolling covariance over a window. Aligned with `NaN` warmup. Takes {@link PopulationOptions} for the same reason as {@link rollingStandardDeviation}. - rollingCovariance(options)?: import('@insiderfinance/totalfinance/math').PopulationOptions | undefined; default: not declared - rollingCovariance(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - rollingCovariance(window): number; default: not declared - rollingCovariance(xs): ArrayLike; default: not declared - rollingCovariance(ys): ArrayLike; default: not declared - rollingMean: (xs: ArrayLike, window: number) => number[]; default: not declared — Rolling mean. Output length equals input; the first `window-1` values are `NaN`. A window holding a non-finite value — or whose own sum overflows — is reported `NaN`, never `±Infinity` (see {@link finiteOrNaN}). - rollingMean(window): number; default: not declared - rollingMean(xs): ArrayLike; default: not declared - rollingStandardDeviation: (xs: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/math').PopulationOptions) => number[]; default: not declared — Rolling standard deviation (sample by default). Aligned with `NaN` warmup. Takes {@link PopulationOptions}, not `VarianceOptions`: the rolling family has no `nanPolicy` (see the module conventions), so the field is rejected as unknown rather than accepted and ignored. - rollingStandardDeviation(options)?: import('@insiderfinance/totalfinance/math').PopulationOptions | undefined; default: not declared - rollingStandardDeviation(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - rollingStandardDeviation(window): number; default: not declared - rollingStandardDeviation(xs): ArrayLike; default: not declared - secant: (objective: import('@insiderfinance/totalfinance/math').ScalarFunction, x0: number, x1: number, options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult; default: not declared — Secant method from two starting points. Fast but not bracketed. - secant().return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - secant().return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - secant().return.iterations: number; default: not declared — Iterations performed. - secant().return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - secant().return.reason?: import('@insiderfinance/totalfinance/math').SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - secant().return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - secant().return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. - secant(objective): import('@insiderfinance/totalfinance/math').ScalarFunction; default: not declared - secant(options)?: import('@insiderfinance/totalfinance/math').SolverOptions; default: not declared - secant(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - secant(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - secant(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - secant(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - secant(x0): number; default: not declared - secant(x1): number; default: not declared - skewness: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared — Population skewness (third standardized moment). - skewness(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - skewness(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - skewness(xs): ArrayLike; default: not declared - sobolSequence: (count: number, dimensions: number) => number[][]; default: not declared — Sobol sequence of `n` points in `dimensions` dimensions (indices `0..n-1`; index 0 is the origin). The first `2^m` points form a regular `(0, m, dim)`-net. - sobolSequence(count): number; default: not declared - sobolSequence(dimensions): number; default: not declared - solveAll: (problems: import('@insiderfinance/totalfinance/math').RootProblem[], options?: import('@insiderfinance/totalfinance/math').SolverOptions) => import('@insiderfinance/totalfinance/math').SolverResult[]; default: not declared — Solve a batch of bracketed root problems, returning one diagnostic-carrying result per row. - solveAll(options)?: import('@insiderfinance/totalfinance/math').SolverOptions | undefined; default: not declared - solveAll(options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - solveAll(options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - solveAll(options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - solveAll(options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - solveAll(problems): import('@insiderfinance/totalfinance/math').RootProblem[]; default: not declared - standardDeviation: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').VarianceOptions) => number; default: not declared - standardDeviation(options)?: import('@insiderfinance/totalfinance/math').VarianceOptions | undefined; default: not declared - standardDeviation(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - standardDeviation(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - standardDeviation(xs): ArrayLike; default: not declared - stratifiedUniforms: (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator, count: number) => number[]; default: not declared — `n` stratified uniforms — one sample in each stratum `[i/n, (i+1)/n)`. - stratifiedUniforms(count): number; default: not declared - stratifiedUniforms(randomNumberGenerator): import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared - stratifiedUniforms(randomNumberGenerator).getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - stratifiedUniforms(randomNumberGenerator).next: () => number; default: not declared — Uniform sample in [0, 1). - stratifiedUniforms(randomNumberGenerator).seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - studentT: { readonly pdf: (x: number, degreesOfFreedom: number) => number; readonly cdf: (x: number, degreesOfFreedom: number) => number; readonly survivalFunction: (x: number, degreesOfFreedom: number) => number; readonly inverseCdf: (probability: number, degreesOfFreedom: number) => number; }; default: not declared — Student's t-distribution with `df` degrees of freedom (`df > 0`, need not be an integer). - studentT.cdf: (x: number, degreesOfFreedom: number) => number; default: not declared — Cumulative distribution `F(x; ν)`. Uses `F(x) = 1 − ½·I_{ν/(ν+x²)}(ν/2, ½)` for `x > 0` and the mirror image for `x < 0`; `F(0) = ½` exactly by symmetry. - studentT.cdf(degreesOfFreedom): number; default: not declared - studentT.cdf(x): number; default: not declared - studentT.inverseCdf: (probability: number, degreesOfFreedom: number) => number; default: not declared — Quantile (inverse CDF). Returns `±Infinity` at the boundaries `p = 0` / `p = 1`. - studentT.inverseCdf(degreesOfFreedom): number; default: not declared - studentT.inverseCdf(probability): number; default: not declared - studentT.pdf: (x: number, degreesOfFreedom: number) => number; default: not declared — Probability density `f(x; ν)`. - studentT.pdf(degreesOfFreedom): number; default: not declared - studentT.pdf(x): number; default: not declared - studentT.survivalFunction: (x: number, degreesOfFreedom: number) => number; default: not declared — Survival function `1 − F(x; ν)` (equivalently `F(−x; ν)` by symmetry). - studentT.survivalFunction(degreesOfFreedom): number; default: not declared - studentT.survivalFunction(x): number; default: not declared - sum: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').StatisticsOptions) => number; default: not declared — Kahan-compensated sum — minimizes rounding error over long series. - sum(options)?: import('@insiderfinance/totalfinance/math').StatisticsOptions | undefined; default: not declared - sum(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - sum(xs): ArrayLike; default: not declared - svd: (matrix: import('@insiderfinance/totalfinance/math').Matrix, options?: { maxSweeps?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/math').SvdResult; default: not declared — Thin singular value decomposition `A = U·diag(s)·Vᵀ` via the one-sided Jacobi (Hestenes) method — accurate and dependency-free for the small matrices TotalFinance handles. `s` is sorted descending. - svd().return.s: number[]; default: not declared — Singular values, descending. - svd().return.u: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Left singular vectors as columns (`m × n`, thin). - svd().return.v: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Right singular vectors as columns (`n × n`). - svd(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - svd(options)?: { maxSweeps?: number; tolerance?: number; }; default: not declared - svd(options).maxSweeps?: number; default: not declared - svd(options).tolerance?: number; default: not declared - transpose: (matrix: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Transpose of an `m × n` matrix → `n × m`. - transpose(matrix): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - trimmedMean: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math/statistics').TrimmedMeanOptions) => number; default: not declared — Trimmed mean: drop `fraction` of the data from each tail, then average the rest. - trimmedMean(options)?: import('@insiderfinance/totalfinance/math/statistics').TrimmedMeanOptions | undefined; default: not declared - trimmedMean(options).fraction?: number; default: not declared — Fraction dropped from EACH tail before averaging (default 0.1), in [0, 0.5]. At 0.5 nothing but the middle remains and the result is the median; the same fallback applies whenever the two trims would consume the whole sample. - trimmedMean(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - trimmedMean(xs): ArrayLike; default: not declared - uniformSamples: (randomNumberGenerator: import('@insiderfinance/totalfinance/math').RandomNumberGenerator, count: number) => Float64Array; default: not declared — Fill a typed array with uniform [0, 1) samples. - uniformSamples(count): number; default: not declared - uniformSamples(randomNumberGenerator): import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared - uniformSamples(randomNumberGenerator).getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - uniformSamples(randomNumberGenerator).next: () => number; default: not declared — Uniform sample in [0, 1). - uniformSamples(randomNumberGenerator).seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - validateInterpolationData: (xs: ArrayLike, ys: ArrayLike, options?: import('@insiderfinance/totalfinance/math').AxisOptions) => { xs: number[]; ys: number[]; }; default: not declared - validateInterpolationData().return.xs: number[]; default: not declared - validateInterpolationData().return.ys: number[]; default: not declared - validateInterpolationData(options)?: import('@insiderfinance/totalfinance/math').AxisOptions; default: not declared - validateInterpolationData(options).aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - validateInterpolationData(options).assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - validateInterpolationData(options).extrapolate?: import('@insiderfinance/totalfinance/math').ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). - validateInterpolationData(xs): ArrayLike; default: not declared - validateInterpolationData(ys): ArrayLike; default: not declared - variance: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').VarianceOptions) => number; default: not declared — Two-pass variance (stable under large constant offsets). - variance(options)?: import('@insiderfinance/totalfinance/math').VarianceOptions | undefined; default: not declared - variance(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - variance(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - variance(xs): ArrayLike; default: not declared - welfordVariance: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').VarianceOptions) => number; default: not declared — Online (Welford) variance — single pass, numerically stable. Equivalent to `variance`. - welfordVariance(options)?: import('@insiderfinance/totalfinance/math').VarianceOptions | undefined; default: not declared - welfordVariance(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - welfordVariance(options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - welfordVariance(xs): ArrayLike; default: not declared - winsorize: (xs: ArrayLike, options?: import('@insiderfinance/totalfinance/math').WinsorizeOptions) => number[]; default: not declared — Winsorize: clip values beyond the lower/upper quantiles to those quantiles. Returns a new array. Under `propagate`, a NaN anywhere yields an all-NaN array of the input's length. - winsorize(options)?: import('@insiderfinance/totalfinance/math').WinsorizeOptions | undefined; default: not declared - winsorize(options).lower?: number; default: not declared — Lower tail fraction to clip (default 0.05). - winsorize(options).nanPolicy?: import('@insiderfinance/totalfinance/math').NanPolicy; default: not declared - winsorize(options).upper?: number; default: not declared — Upper tail fraction to clip (default 0.05). - winsorize(xs): ArrayLike; default: not declared - xoshiro128ss: (seed: number) => import('@insiderfinance/totalfinance/math').RandomNumberGenerator; default: not declared — xoshiro128** — a higher-quality seedable PRNG (longer period, better statistical properties). As with {@link mulberry32}, the state is derived from `seed >>> 0` but the caller's literal `seed` is echoed. - xoshiro128ss().return.getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - xoshiro128ss().return.next: () => number; default: not declared — Uniform sample in [0, 1). - xoshiro128ss().return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - xoshiro128ss(seed): number; default: not declared ### @insiderfinance/totalfinance#option Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `option` namespace combines contract builders with pro pricing: - `option.call(...)` / `option.put(...)` build contracts, - `option.price({ contract, market, engine? })` prices them, - `option.impliedVolatility({ contract, market, engine? })` inverts a price, - `option.compareEngines({ contract, market, options? })` benchmarks engines against each other. ```typescript export declare const option: { readonly call: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => OptionContract; readonly put: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => OptionContract; readonly usEquityCall: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => OptionContract; readonly usEquityPut: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => OptionContract; readonly usEquityOption: (input: import('@insiderfinance/totalfinance/options').UsEquityOptionInput) => OptionContract; readonly european: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { type: import('@insiderfinance/totalfinance/core').OptionType; convention?: 'us-equity-close'; }) => OptionContract; readonly price: (input: PriceOptionInput) => PriceResult; readonly impliedVolatility: (input: ImpliedVolatilityOptionInput) => ImpliedVolatilitySolveResult; readonly compareEngines: (input: import('@insiderfinance/totalfinance/options').CompareEnginesInput) => import('@insiderfinance/totalfinance/options').EngineComparison; }; ``` Example (source JSDoc): ```ts import { market, option } from '@insiderfinance/totalfinance/options'; const contract = option.usEquityCall({ underlying: 'AAPL', strike: 200, expiry: '2026-09-18' }); const result = option.price({ contract, market: market({ spot: 195.3, riskFreeRate: 0.045, volatility: 0.24, asOf: '2026-07-20T10:30:00-04:00' }), }); result.value; // premium per share result.greeks?.delta; // engine-reported Greeks const solved = option.impliedVolatility({ contract, market: market({ spot: 195.3, riskFreeRate: 0.045, price: 4.1, asOf: '2026-07-20T10:30:00-04:00' }), }); solved.diagnostics.converged; // check before trusting solved.value ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => OptionContract; default: not declared - call().return.adjusted?: boolean; default: not declared - call().return.currency?: string; default: not declared - call().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - call().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - call().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - call().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - call().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - call().return.multiplier?: number; default: not declared - call().return.occSymbol?: string; default: not declared - call().return.root?: string; default: not declared - call().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - call().return.strike: number; default: not declared - call().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - call().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - call().return.underlying: string; default: not declared - call(input): import('@insiderfinance/totalfinance/options').OptionBuilderInput; default: not declared - call(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - call(input).currency?: string; default: not declared - call(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - call(input).multiplier?: number; default: not declared - call(input).root?: string; default: not declared - call(input).strike: number; default: not declared - call(input).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - call(input).underlying: string; default: not declared - compareEngines: (input: import('@insiderfinance/totalfinance/options').CompareEnginesInput) => import('@insiderfinance/totalfinance/options').EngineComparison; default: not declared - compareEngines().return.assumptions: { conventionsVersion: string; referenceEngine: string; engines: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - compareEngines().return.assumptions.conventionsVersion: string; default: not declared - compareEngines().return.assumptions.engines: number; default: not declared - compareEngines().return.assumptions.referenceEngine: string; default: not declared - compareEngines().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present — engine failures are summarized here (details per row). - compareEngines().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - compareEngines().return.reference: { engine: string; value: number; }; default: not declared - compareEngines().return.reference.engine: string; default: not declared - compareEngines().return.reference.value: number; default: not declared - compareEngines().return.rows: import('@insiderfinance/totalfinance/options').EngineComparisonRow[]; default: not declared - compareEngines(input): import('@insiderfinance/totalfinance/options').CompareEnginesInput; default: not declared - compareEngines(input).contract: OptionContract; default: not declared - compareEngines(input).market: OptionMarket; default: not declared - compareEngines(input).options?: ({ engines?: import('@insiderfinance/totalfinance/options').OptionPricingEngine[]; reference?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; now?: () => number; }); default: not declared - compareEngines(input).options.engines?: OptionPricingEngine[]; default: not declared — Engines to compare. Defaults to the built-in panel that supports the contract. - compareEngines(input).options.now?: () => number; default: not declared — Optional monotonic clock (e.g. `() => performance.now()`). When supplied, each engine's wall-clock pricing time is measured into `timingMs`. Omitted by default so the function stays pure (no system-clock read) — timing is opt-in instrumentation the caller injects. - compareEngines(input).options.reference?: OptionPricingEngine; default: not declared — Convergence benchmark. Defaults to a 1001-step Leisen–Reimer lattice. - european: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { type: import('@insiderfinance/totalfinance/core').OptionType; convention?: 'us-equity-close'; }) => OptionContract; default: not declared - european().return.adjusted?: boolean; default: not declared - european().return.currency?: string; default: not declared - european().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - european().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - european().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - european().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - european().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - european().return.multiplier?: number; default: not declared - european().return.occSymbol?: string; default: not declared - european().return.root?: string; default: not declared - european().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - european().return.strike: number; default: not declared - european().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - european().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - european().return.underlying: string; default: not declared - european(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { type: import('@insiderfinance/totalfinance/core').OptionType; convention?: 'us-equity-close'; }; default: not declared - european(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - european(input).currency?: string; default: not declared - european(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - european(input).multiplier?: number; default: not declared - european(input).root?: string; default: not declared - european(input).strike: number; default: not declared - european(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - european(input).underlying: string; default: not declared - impliedVolatility: (input: ImpliedVolatilityOptionInput) => ImpliedVolatilitySolveResult; default: not declared - impliedVolatility().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - impliedVolatility().return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - impliedVolatility().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatility().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatility(input): ImpliedVolatilityOptionInput; default: not declared - impliedVolatility(input).contract: OptionContract; default: not declared - impliedVolatility(input).engine?: OptionPricingEngine; default: not declared — Engine to invert numerically. An American contract always inverts an engine (default `engines.bjerksundStensland2002()`); a European contract inverts closed-form Black–Scholes–Merton unless an engine is named here, in which case THAT engine is inverted — e.g. a lattice for discrete dividends, or a custom model. `method`/`fallback`/`failFast` belong to the closed-form route and are refused alongside an engine. - impliedVolatility(input).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - impliedVolatility(input).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - impliedVolatility(input).market: OptionMarket; default: not declared - impliedVolatility(input).method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared - price: (input: PriceOptionInput) => PriceResult; default: not declared - price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - price().return.greeks.charm: number; default: not declared - price().return.greeks.color: number; default: not declared - price().return.greeks.delta: number; default: not declared - price().return.greeks.gamma: number; default: not declared - price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - price().return.greeks.rho: number; default: not declared - price().return.greeks.speed: number; default: not declared - price().return.greeks.theta: number; default: not declared - price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - price().return.greeks.vanna: number; default: not declared - price().return.greeks.vega: number; default: not declared - price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - price().return.greeks.vomma: number; default: not declared - price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): PriceOptionInput; default: not declared - price(input).contract: OptionContract; default: not declared - price(input).engine?: OptionPricingEngine; default: not declared — Engine override; defaults to {@link engines.auto} (European → BSM, American → lattice/approx). - price(input).extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - price(input).greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. - price(input).market: OptionMarket; default: not declared — Market snapshot. `asOf` is required on the market; the clock is never read. - put: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => OptionContract; default: not declared - put().return.adjusted?: boolean; default: not declared - put().return.currency?: string; default: not declared - put().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - put().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - put().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - put().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - put().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - put().return.multiplier?: number; default: not declared - put().return.occSymbol?: string; default: not declared - put().return.root?: string; default: not declared - put().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - put().return.strike: number; default: not declared - put().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - put().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - put().return.underlying: string; default: not declared - put(input): import('@insiderfinance/totalfinance/options').OptionBuilderInput; default: not declared - put(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - put(input).currency?: string; default: not declared - put(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - put(input).multiplier?: number; default: not declared - put(input).root?: string; default: not declared - put(input).strike: number; default: not declared - put(input).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - put(input).underlying: string; default: not declared - usEquityCall: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => OptionContract; default: not declared - usEquityCall().return.adjusted?: boolean; default: not declared - usEquityCall().return.currency?: string; default: not declared - usEquityCall().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - usEquityCall().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - usEquityCall().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - usEquityCall().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - usEquityCall().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - usEquityCall().return.multiplier?: number; default: not declared - usEquityCall().return.occSymbol?: string; default: not declared - usEquityCall().return.root?: string; default: not declared - usEquityCall().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - usEquityCall().return.strike: number; default: not declared - usEquityCall().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - usEquityCall().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - usEquityCall().return.underlying: string; default: not declared - usEquityCall(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput; default: not declared - usEquityCall(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - usEquityCall(input).currency?: string; default: not declared - usEquityCall(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - usEquityCall(input).multiplier?: number; default: not declared - usEquityCall(input).root?: string; default: not declared - usEquityCall(input).strike: number; default: not declared - usEquityCall(input).underlying: string; default: not declared - usEquityOption: (input: import('@insiderfinance/totalfinance/options').UsEquityOptionInput) => OptionContract; default: not declared - usEquityOption().return.adjusted?: boolean; default: not declared - usEquityOption().return.currency?: string; default: not declared - usEquityOption().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - usEquityOption().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - usEquityOption().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - usEquityOption().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - usEquityOption().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - usEquityOption().return.multiplier?: number; default: not declared - usEquityOption().return.occSymbol?: string; default: not declared - usEquityOption().return.root?: string; default: not declared - usEquityOption().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - usEquityOption().return.strike: number; default: not declared - usEquityOption().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - usEquityOption().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - usEquityOption().return.underlying: string; default: not declared - usEquityOption(input): import('@insiderfinance/totalfinance/options').UsEquityOptionInput; default: not declared - usEquityOption(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - usEquityOption(input).currency?: string; default: not declared - usEquityOption(input).expiry?: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - usEquityOption(input).multiplier?: number; default: not declared - usEquityOption(input).occSymbol?: string; default: not declared — A compact OCC symbol (`AAPL260918C00200000`); its root, expiry, type and strike are the contract. - usEquityOption(input).root?: string; default: not declared - usEquityOption(input).strike?: number; default: not declared - usEquityOption(input).type?: import('@insiderfinance/totalfinance/core').OptionType; default: not declared — `'call' | 'put'` — required unless `occSymbol` names it. - usEquityOption(input).underlying?: string; default: not declared - usEquityPut: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => OptionContract; default: not declared - usEquityPut().return.adjusted?: boolean; default: not declared - usEquityPut().return.currency?: string; default: not declared - usEquityPut().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - usEquityPut().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - usEquityPut().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - usEquityPut().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - usEquityPut().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - usEquityPut().return.multiplier?: number; default: not declared - usEquityPut().return.occSymbol?: string; default: not declared - usEquityPut().return.root?: string; default: not declared - usEquityPut().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - usEquityPut().return.strike: number; default: not declared - usEquityPut().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - usEquityPut().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - usEquityPut().return.underlying: string; default: not declared - usEquityPut(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput; default: not declared - usEquityPut(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - usEquityPut(input).currency?: string; default: not declared - usEquityPut(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - usEquityPut(input).multiplier?: number; default: not declared - usEquityPut(input).root?: string; default: not declared - usEquityPut(input).strike: number; default: not declared - usEquityPut(input).underlying: string; default: not declared ### @insiderfinance/totalfinance#options Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const options: typeof import('@insiderfinance/totalfinance/options'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - BlackScholesImpliedVolatilityInputSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Schema for an implied-volatility request. Built from {@link blackScholesShape} (minus `volatility`, which is the unknown being solved) so its fields carry the same descriptions as every other option schema rather than the bare, description-less duplicate this used to be. - BlackScholesImpliedVolatilityInputSchema._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { ok: false; issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; } | { ok: true; value: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; }; default: not declared — @internal - BlackScholesImpliedVolatilityInputSchema._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._check().return.ok: (false) | (true); default: not declared - BlackScholesImpliedVolatilityInputSchema._check().return.value: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - BlackScholesImpliedVolatilityInputSchema._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - BlackScholesImpliedVolatilityInputSchema._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - BlackScholesImpliedVolatilityInputSchema._check(context).path: (string | number)[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._check(input): unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.$id?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.description?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.format?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.title?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesImpliedVolatilityInputSchema.describe(description): string; default: not declared - BlackScholesImpliedVolatilityInputSchema.description: string | undefined; default: not declared - BlackScholesImpliedVolatilityInputSchema.isOptional: boolean; default: not declared - BlackScholesImpliedVolatilityInputSchema.kind: 'object'; default: not declared - BlackScholesImpliedVolatilityInputSchema.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - BlackScholesImpliedVolatilityInputSchema.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }>; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; }; default: not declared — @internal - BlackScholesImpliedVolatilityInputSchema.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesImpliedVolatilityInputSchema.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.description: string | undefined; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.isOptional: true; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.kind: 'optional'; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; } | undefined>; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined>; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesImpliedVolatilityInputSchema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - BlackScholesImpliedVolatilityInputSchema.parse(input): unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesImpliedVolatilityInputSchema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesImpliedVolatilityInputSchema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse().return.data: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse().return.success: (false) | (true); default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse(input): unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesImpliedVolatilityInputSchema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesImpliedVolatilityInputSchema.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.$id?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.description?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.format?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.title?: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.types?: ({ readonly input: unknown; readonly output: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; }) | undefined; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.types.input: unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.types.output: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.validate().return.value: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.validate(value): unknown; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.vendor: string; default: not declared - BlackScholesImpliedVolatilityInputSchema.~standard.version: 1; default: not declared - BlackScholesInputSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Schema for a `BlackScholesInput` facade payload. - BlackScholesInputSchema._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; }; default: not declared — @internal - BlackScholesInputSchema._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesInputSchema._check().return.ok: (false) | (true); default: not declared - BlackScholesInputSchema._check().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesInputSchema._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - BlackScholesInputSchema._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - BlackScholesInputSchema._check(context).path: (string | number)[]; default: not declared - BlackScholesInputSchema._check(input): unknown; default: not declared - BlackScholesInputSchema._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesInputSchema._toJSONSchema().return.$id?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.$schema?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.const?: unknown; default: not declared - BlackScholesInputSchema._toJSONSchema().return.default?: unknown; default: not declared - BlackScholesInputSchema._toJSONSchema().return.description?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.format?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema._toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.maximum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.minItems?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.minLength?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.minimum?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesInputSchema._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.pattern?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.properties?: Record; default: not declared - BlackScholesInputSchema._toJSONSchema().return.required?: string[]; default: not declared - BlackScholesInputSchema._toJSONSchema().return.title?: string; default: not declared - BlackScholesInputSchema._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInputSchema.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesInputSchema.describe(description): string; default: not declared - BlackScholesInputSchema.description: string | undefined; default: not declared - BlackScholesInputSchema.isOptional: boolean; default: not declared - BlackScholesInputSchema.kind: 'object'; default: not declared - BlackScholesInputSchema.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - BlackScholesInputSchema.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }>; default: not declared - BlackScholesInputSchema.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; }; default: not declared — @internal - BlackScholesInputSchema.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesInputSchema.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInputSchema.optional().return.description: string | undefined; default: not declared - BlackScholesInputSchema.optional().return.isOptional: true; default: not declared - BlackScholesInputSchema.optional().return.kind: 'optional'; default: not declared - BlackScholesInputSchema.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; } | undefined>; default: not declared - BlackScholesInputSchema.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; default: not declared - BlackScholesInputSchema.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined>; default: not declared - BlackScholesInputSchema.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesInputSchema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - BlackScholesInputSchema.parse(input): unknown; default: not declared - BlackScholesInputSchema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesInputSchema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesInputSchema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInputSchema.safeParse().return.data: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesInputSchema.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - BlackScholesInputSchema.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesInputSchema.safeParse().return.success: (false) | (true); default: not declared - BlackScholesInputSchema.safeParse(input): unknown; default: not declared - BlackScholesInputSchema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesInputSchema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesInputSchema.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema.toJSONSchema().return.$id?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.$schema?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.const?: unknown; default: not declared - BlackScholesInputSchema.toJSONSchema().return.default?: unknown; default: not declared - BlackScholesInputSchema.toJSONSchema().return.description?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.format?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInputSchema.toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.maximum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.minItems?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.minLength?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.minimum?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesInputSchema.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.pattern?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.properties?: Record; default: not declared - BlackScholesInputSchema.toJSONSchema().return.required?: string[]; default: not declared - BlackScholesInputSchema.toJSONSchema().return.title?: string; default: not declared - BlackScholesInputSchema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInputSchema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesInputSchema.~standard.types?: ({ readonly input: unknown; readonly output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; }) | undefined; default: not declared - BlackScholesInputSchema.~standard.types.input: unknown; default: not declared - BlackScholesInputSchema.~standard.types.output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesInputSchema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInputSchema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - BlackScholesInputSchema.~standard.validate().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesInputSchema.~standard.validate(value): unknown; default: not declared - BlackScholesInputSchema.~standard.vendor: string; default: not declared - BlackScholesInputSchema.~standard.version: 1; default: not declared - BlackScholesTypedInputSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Schema for a typed BSM payload (`blackScholes.price` / `blackScholes.greeks`). - BlackScholesTypedInputSchema._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; }; default: not declared — @internal - BlackScholesTypedInputSchema._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesTypedInputSchema._check().return.ok: (false) | (true); default: not declared - BlackScholesTypedInputSchema._check().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesTypedInputSchema._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - BlackScholesTypedInputSchema._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - BlackScholesTypedInputSchema._check(context).path: (string | number)[]; default: not declared - BlackScholesTypedInputSchema._check(input): unknown; default: not declared - BlackScholesTypedInputSchema._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesTypedInputSchema._toJSONSchema().return.$id?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.$schema?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.const?: unknown; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.default?: unknown; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.description?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.format?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.maximum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.minItems?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.minLength?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.minimum?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.pattern?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.properties?: Record; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.required?: string[]; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.title?: string; default: not declared - BlackScholesTypedInputSchema._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInputSchema.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesTypedInputSchema.describe(description): string; default: not declared - BlackScholesTypedInputSchema.description: string | undefined; default: not declared - BlackScholesTypedInputSchema.isOptional: boolean; default: not declared - BlackScholesTypedInputSchema.kind: 'object'; default: not declared - BlackScholesTypedInputSchema.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - BlackScholesTypedInputSchema.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }>; default: not declared - BlackScholesTypedInputSchema.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; }; default: not declared — @internal - BlackScholesTypedInputSchema.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesTypedInputSchema.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInputSchema.optional().return.description: string | undefined; default: not declared - BlackScholesTypedInputSchema.optional().return.isOptional: true; default: not declared - BlackScholesTypedInputSchema.optional().return.kind: 'optional'; default: not declared - BlackScholesTypedInputSchema.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; } | undefined>; default: not declared - BlackScholesTypedInputSchema.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; default: not declared - BlackScholesTypedInputSchema.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined>; default: not declared - BlackScholesTypedInputSchema.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesTypedInputSchema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - BlackScholesTypedInputSchema.parse(input): unknown; default: not declared - BlackScholesTypedInputSchema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesTypedInputSchema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesTypedInputSchema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInputSchema.safeParse().return.data: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesTypedInputSchema.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - BlackScholesTypedInputSchema.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesTypedInputSchema.safeParse().return.success: (false) | (true); default: not declared - BlackScholesTypedInputSchema.safeParse(input): unknown; default: not declared - BlackScholesTypedInputSchema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesTypedInputSchema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesTypedInputSchema.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.$id?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.$schema?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.const?: unknown; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.default?: unknown; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.description?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.format?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.maximum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.minItems?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.minLength?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.minimum?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.pattern?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.properties?: Record; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.required?: string[]; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.title?: string; default: not declared - BlackScholesTypedInputSchema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInputSchema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesTypedInputSchema.~standard.types?: ({ readonly input: unknown; readonly output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; }) | undefined; default: not declared - BlackScholesTypedInputSchema.~standard.types.input: unknown; default: not declared - BlackScholesTypedInputSchema.~standard.types.output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesTypedInputSchema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInputSchema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - BlackScholesTypedInputSchema.~standard.validate().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - BlackScholesTypedInputSchema.~standard.validate(value): unknown; default: not declared - BlackScholesTypedInputSchema.~standard.vendor: string; default: not declared - BlackScholesTypedInputSchema.~standard.version: 1; default: not declared - DEFAULT_OUTLIER_THRESHOLD: 3.5; default: not declared — Default MAD multiplier `k`: a strike whose parity residual exceeds `k·MAD` is trimmed. - OptionContractSchema: import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }>; default: not declared — E2 — the contract schema validates the RESOLVED ARTIFACT cross-field, not just field shapes: after the structural parse, `validateResolvedExpiry` confirms the label ↔ instant ↔ convention triple is internally consistent (impossible dates, mismatched epochs, and contradictory conventions all reject), and the parsed value is DEEP-frozen — the artifact (including `deliverable` and its `shares[]`) stays immutable through the schema boundary exactly as it left the builders. - OptionContractSchema.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }>; default: not declared - OptionContractSchema.describe(description): string; default: not declared - OptionContractSchema.isOptional: boolean; default: not declared - OptionContractSchema.kind: string; default: not declared - OptionContractSchema.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - OptionContractSchema.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - OptionContractSchema.optional().return.isOptional: boolean; default: not declared - OptionContractSchema.optional().return.kind: string; default: not declared - OptionContractSchema.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - OptionContractSchema.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined; default: not declared - OptionContractSchema.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - OptionContractSchema.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContractSchema.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionContractSchema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - OptionContractSchema.parse(input): unknown; default: not declared - OptionContractSchema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionContractSchema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionContractSchema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContractSchema.safeParse().return.data: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - OptionContractSchema.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OptionContractSchema.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionContractSchema.safeParse().return.success: (false) | (true); default: not declared - OptionContractSchema.safeParse(input): unknown; default: not declared - OptionContractSchema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionContractSchema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionContractSchema.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContractSchema.toJSONSchema().return.$id?: string; default: not declared - OptionContractSchema.toJSONSchema().return.$schema?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionContractSchema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionContractSchema.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContractSchema.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContractSchema.toJSONSchema().return.const?: unknown; default: not declared - OptionContractSchema.toJSONSchema().return.default?: unknown; default: not declared - OptionContractSchema.toJSONSchema().return.description?: string; default: not declared - OptionContractSchema.toJSONSchema().return.enum?: unknown[]; default: not declared - OptionContractSchema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.format?: string; default: not declared - OptionContractSchema.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContractSchema.toJSONSchema().return.maxItems?: number; default: not declared - OptionContractSchema.toJSONSchema().return.maxLength?: number; default: not declared - OptionContractSchema.toJSONSchema().return.maximum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.minItems?: number; default: not declared - OptionContractSchema.toJSONSchema().return.minLength?: number; default: not declared - OptionContractSchema.toJSONSchema().return.minimum?: number; default: not declared - OptionContractSchema.toJSONSchema().return.multipleOf?: number; default: not declared - OptionContractSchema.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContractSchema.toJSONSchema().return.pattern?: string; default: not declared - OptionContractSchema.toJSONSchema().return.properties?: Record; default: not declared - OptionContractSchema.toJSONSchema().return.required?: string[]; default: not declared - OptionContractSchema.toJSONSchema().return.title?: string; default: not declared - OptionContractSchema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionContractSchema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionContractSchema.~standard.types?: ({ readonly input: unknown; readonly output: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; }) | undefined; default: not declared - OptionContractSchema.~standard.types.input: unknown; default: not declared - OptionContractSchema.~standard.types.output: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - OptionContractSchema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContractSchema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OptionContractSchema.~standard.validate().return.value: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - OptionContractSchema.~standard.validate(value): unknown; default: not declared - OptionContractSchema.~standard.vendor: string; default: not declared - OptionContractSchema.~standard.version: 1; default: not declared - ParityCode: { readonly StrikeUnavailable: 'parity.strike_unavailable'; readonly InsufficientStrikes: 'parity.insufficient_strikes'; readonly NonPositiveDiscount: 'parity.nonpositive_discount'; readonly NonPositiveForward: 'parity.nonpositive_forward'; readonly DegenerateBox: 'parity.degenerate_box'; readonly RateMismatch: 'parity.rate_mismatch'; }; default: not declared — Stable `parity.*` error/warning codes (public API; the set is open). - ParityCode.DegenerateBox: 'parity.degenerate_box'; default: not declared — The box debit is non-positive, so no real financing rate exists. - ParityCode.InsufficientStrikes: 'parity.insufficient_strikes'; default: not declared — Fewer than two usable strikes with both a call and a put — a line cannot be fit. - ParityCode.NonPositiveDiscount: 'parity.nonpositive_discount'; default: not declared — The regression slope is non-negative, so no positive discount factor exists. - ParityCode.NonPositiveForward: 'parity.nonpositive_forward'; default: not declared — The implied forward came out non-positive / non-finite. - ParityCode.RateMismatch: 'parity.rate_mismatch'; default: not declared — The regression-implied rate disagrees materially with the supplied rate. - ParityCode.StrikeUnavailable: 'parity.strike_unavailable'; default: not declared — A specifically requested strike/leg quote is missing (box spread). - americanExercise: (input: import('@insiderfinance/totalfinance/options').AmericanExerciseInput) => import('@insiderfinance/totalfinance/options').AmericanExerciseResult; default: not declared — Decompose an American option into its European value plus early-exercise premium, recover the exercise boundary `S*(τ)`, and say whether to exercise now. See `docs/specs/american-exercise.md`. - americanExercise().return.american: number; default: not declared — American value (Barone–Adesi–Whaley). - americanExercise().return.assumptions: { conventionsVersion: string; valueEngine: 'barone-adesi-whaley'; dividendModel: import('@insiderfinance/totalfinance/core').DividendModel; timeToExpiryYears: number; }; default: not declared - americanExercise().return.assumptions.conventionsVersion: string; default: not declared - americanExercise().return.assumptions.dividendModel: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - americanExercise().return.assumptions.timeToExpiryYears: number; default: not declared - americanExercise().return.assumptions.valueEngine: 'barone-adesi-whaley'; default: not declared - americanExercise().return.boundary: import('@insiderfinance/totalfinance/options').BoundaryPoint[]; default: not declared — The `S*(τ)` curve over the remaining life (empty when never optimal). - americanExercise().return.criticalSpot: number | null; default: not declared — `S*(τ)` at the current maturity; `null` when early exercise is never optimal. - americanExercise().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - americanExercise().return.earlyExerciseCanBeOptimal: boolean; default: not declared — `false` for a non-dividend call (early exercise never optimal). - americanExercise().return.earlyExercisePremium: number; default: not declared — `american − european ≥ 0` — the dollars the early-exercise right adds. - americanExercise().return.european: number; default: not declared — European value (BSM) — the value stripped of the early-exercise right. - americanExercise().return.intrinsic: number; default: not declared - americanExercise().return.optionType: 'call' | 'put'; default: not declared — Which leg was analysed — `'call'` or `'put'`. Named `optionType` because that is what it holds: in TotalFinance `style` is the EXERCISE style (`'european' | 'american'`) everywhere else, and every one of these results is American by construction, so a field called `style` reading `'put'` was a straight collision of two vocabularies (pre-1.0 clean break, defect-fix wave, review-1). - americanExercise().return.premiumFractionOfValue: number; default: not declared — `premium / american`. - americanExercise().return.rationale: string; default: not declared — Prose an agent relays. - americanExercise().return.shouldExerciseNow: boolean; default: not declared — The American value has collapsed to intrinsic — no time value left to give up. - americanExercise().return.spot: number; default: not declared - americanExercise().return.spotToBoundary: number | null; default: not declared — Signed fraction of spot to the boundary (put: `(S−S*)/S`, call: `(S*−S)/S`); `null` if no boundary. - americanExercise().return.timeValue: number; default: not declared — `american − intrinsic ≥ 0`. - americanExercise(input): import('@insiderfinance/totalfinance/options').AmericanExerciseInput; default: not declared - americanExercise(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - americanExercise(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - americanExercise(input).options?: import('@insiderfinance/totalfinance/options').AmericanExerciseOptions; default: not declared - americanImpliedVolatility: (input: import('@insiderfinance/totalfinance/options').AmericanImpliedVolatilityInput) => import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult; default: not declared — Solve the implied volatility of an American contract from `market.price` by inverting an American pricing engine over σ with a safeguarded Brent bracket (`[1e-4, 5]`, expanded once to `[1e-6, 10]`). No-arbitrage bounds use the American intrinsic (`max(S−K,0)` calls, `max(K−S,0)` puts, no discounting): a price below intrinsic, above the upper bound, or at intrinsic (no time value to imply a vol) fails honestly instead of returning a fabricated number. A European contract is refused — its door is `option.impliedVolatility`, closed-form by default or engine-inverted when an engine is named. - americanImpliedVolatility().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - americanImpliedVolatility().return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - americanImpliedVolatility().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - americanImpliedVolatility().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - americanImpliedVolatility(input): import('@insiderfinance/totalfinance/options').AmericanImpliedVolatilityInput; default: not declared - americanImpliedVolatility(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - americanImpliedVolatility(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - americanImpliedVolatility(input).options?: import('@insiderfinance/totalfinance/options').AmericanImpliedVolatilityOptions; default: not declared - asian: { readonly geometricPrice: (input: import('@insiderfinance/totalfinance/options').AsianInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').AsianMonteCarloInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').AsianMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - asian.geometricPrice: (input: import('@insiderfinance/totalfinance/options').AsianInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Exact discrete geometric-average Asian price. - asian.geometricPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - asian.geometricPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - asian.geometricPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - asian.geometricPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - asian.geometricPrice(input): import('@insiderfinance/totalfinance/options').AsianInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - asian.geometricPrice(input).averagingPoints?: number; default: not declared — Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). - asian.geometricPrice(input).dividendYield?: number; default: not declared - asian.geometricPrice(input).riskFreeRate: number; default: not declared - asian.geometricPrice(input).spot: number; default: not declared - asian.geometricPrice(input).strike: number; default: not declared - asian.geometricPrice(input).timeToExpiryYears: number; default: not declared - asian.geometricPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - asian.geometricPrice(input).volatility: number; default: not declared - asian.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').AsianMonteCarloInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').AsianMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Arithmetic-average Asian price by Monte-Carlo, with the geometric Asian as control variate. - asian.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - asian.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - asian.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - asian.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - asian.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - asian.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').AsianMonteCarloInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - asian.monteCarloPrice(input).dividendYield?: number; default: not declared - asian.monteCarloPrice(input).riskFreeRate: number; default: not declared - asian.monteCarloPrice(input).spot: number; default: not declared - asian.monteCarloPrice(input).strike: number; default: not declared - asian.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - asian.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - asian.monteCarloPrice(input).volatility: number; default: not declared - asian.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').AsianMonteCarloOptions; default: not declared - asian.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - asian.monteCarloPrice(options).averagingPoints?: number; default: not declared — Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). - asian.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - asian.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - asian.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - asian.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - asian.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - asian.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - autocallable: { readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').AutocallableInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - autocallable.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').AutocallableInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo price of a canonical autocallable note: on each observation date the note redeems at `notional·(1 + couponRate·periods)` if the spot is at or above `autocallBarrier`; if it never does, at maturity it returns the notional when `S(T) ≥ knockInBarrier`, else the loss-bearing `notional·S(T)/S(0)`. The payoff is discounted at the per-path redemption time. - autocallable.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - autocallable.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - autocallable.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - autocallable.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - autocallable.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - autocallable.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').AutocallableInput; default: not declared - autocallable.monteCarloPrice(input).autocallBarrier: number; default: not declared — Autocall trigger level: if `S(tᵢ) ≥ autocallBarrier`, the note redeems early. - autocallable.monteCarloPrice(input).couponRate: number; default: not declared — Coupon per elapsed period (fraction of notional), paid cumulatively on redemption. - autocallable.monteCarloPrice(input).dividendYield?: number; default: not declared - autocallable.monteCarloPrice(input).knockInBarrier: number; default: not declared — Downside knock-in level checked at maturity (capital is at risk below it). - autocallable.monteCarloPrice(input).notional?: number; default: not declared — Notional. Default 100. - autocallable.monteCarloPrice(input).observationTimes: number[]; default: not declared — Strictly-increasing observation times in years; the last is maturity. - autocallable.monteCarloPrice(input).riskFreeRate: number; default: not declared - autocallable.monteCarloPrice(input).spot: number; default: not declared - autocallable.monteCarloPrice(input).volatility: number; default: not declared - autocallable.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - autocallable.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - autocallable.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - autocallable.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - autocallable.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - autocallable.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - autocallable.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - autocallable.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - bachelier: { call: import('@insiderfinance/totalfinance/core').Facade; put: import('@insiderfinance/totalfinance/core').Facade; price: import('@insiderfinance/totalfinance/core').Facade; greeks: import('@insiderfinance/totalfinance/core').Facade; extendedGreeks: import('@insiderfinance/totalfinance/core').Facade; impliedVolatility: import('@insiderfinance/totalfinance/core').Facade, number | null>; }; default: not declared — The Bachelier facade namespace. - bachelier.call: import('@insiderfinance/totalfinance/core').Facade; default: not declared - bachelier.call(input): import('@insiderfinance/totalfinance/options').BachelierInput; default: not declared - bachelier.call(input).forward: number; default: not declared - bachelier.call(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.call(input).riskFreeRate: number; default: not declared - bachelier.call(input).strike: number; default: not declared - bachelier.call(input).timeToExpiryYears: number; default: not declared - bachelier.call.explain: (input: import('@insiderfinance/totalfinance/options').BachelierInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - bachelier.call.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - bachelier.call.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bachelier.call.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bachelier.call.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bachelier.call.explain(input): import('@insiderfinance/totalfinance/options').BachelierInput; default: not declared - bachelier.call.explain(input).forward: number; default: not declared - bachelier.call.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.call.explain(input).riskFreeRate: number; default: not declared - bachelier.call.explain(input).strike: number; default: not declared - bachelier.call.explain(input).timeToExpiryYears: number; default: not declared - bachelier.extendedGreeks: import('@insiderfinance/totalfinance/core').Facade; default: not declared - bachelier.extendedGreeks().return.charm: number; default: not declared - bachelier.extendedGreeks().return.color: number; default: not declared - bachelier.extendedGreeks().return.delta: number; default: not declared - bachelier.extendedGreeks().return.gamma: number; default: not declared - bachelier.extendedGreeks().return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - bachelier.extendedGreeks().return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - bachelier.extendedGreeks().return.rho: number; default: not declared - bachelier.extendedGreeks().return.speed: number; default: not declared - bachelier.extendedGreeks().return.theta: number; default: not declared - bachelier.extendedGreeks().return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - bachelier.extendedGreeks().return.vanna: number; default: not declared - bachelier.extendedGreeks().return.vega: number; default: not declared - bachelier.extendedGreeks().return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - bachelier.extendedGreeks().return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - bachelier.extendedGreeks().return.vomma: number; default: not declared - bachelier.extendedGreeks().return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - bachelier.extendedGreeks(input): import('@insiderfinance/totalfinance/options').BachelierTypedInput; default: not declared - bachelier.extendedGreeks(input).forward: number; default: not declared - bachelier.extendedGreeks(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.extendedGreeks(input).riskFreeRate: number; default: not declared - bachelier.extendedGreeks(input).strike: number; default: not declared - bachelier.extendedGreeks(input).timeToExpiryYears: number; default: not declared - bachelier.extendedGreeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.extendedGreeks.explain: (input: import('@insiderfinance/totalfinance/options').BachelierTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - bachelier.extendedGreeks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - bachelier.extendedGreeks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bachelier.extendedGreeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bachelier.extendedGreeks.explain().return.value: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bachelier.extendedGreeks.explain(input): import('@insiderfinance/totalfinance/options').BachelierTypedInput; default: not declared - bachelier.extendedGreeks.explain(input).forward: number; default: not declared - bachelier.extendedGreeks.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.extendedGreeks.explain(input).riskFreeRate: number; default: not declared - bachelier.extendedGreeks.explain(input).strike: number; default: not declared - bachelier.extendedGreeks.explain(input).timeToExpiryYears: number; default: not declared - bachelier.extendedGreeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.greeks: import('@insiderfinance/totalfinance/core').Facade; default: not declared - bachelier.greeks().return.delta: number; default: not declared - bachelier.greeks().return.gamma: number; default: not declared - bachelier.greeks().return.rho: number; default: not declared - bachelier.greeks().return.theta: number; default: not declared - bachelier.greeks().return.vega: number; default: not declared - bachelier.greeks(input): import('@insiderfinance/totalfinance/options').BachelierTypedInput; default: not declared - bachelier.greeks(input).forward: number; default: not declared - bachelier.greeks(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.greeks(input).riskFreeRate: number; default: not declared - bachelier.greeks(input).strike: number; default: not declared - bachelier.greeks(input).timeToExpiryYears: number; default: not declared - bachelier.greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.greeks.explain: (input: import('@insiderfinance/totalfinance/options').BachelierTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - bachelier.greeks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - bachelier.greeks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bachelier.greeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bachelier.greeks.explain().return.value: import('@insiderfinance/totalfinance/options').Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bachelier.greeks.explain(input): import('@insiderfinance/totalfinance/options').BachelierTypedInput; default: not declared - bachelier.greeks.explain(input).forward: number; default: not declared - bachelier.greeks.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.greeks.explain(input).riskFreeRate: number; default: not declared - bachelier.greeks.explain(input).strike: number; default: not declared - bachelier.greeks.explain(input).timeToExpiryYears: number; default: not declared - bachelier.greeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.impliedVolatility: import('@insiderfinance/totalfinance/core').Facade, number | null>; default: not declared - bachelier.impliedVolatility(input): import('@insiderfinance/totalfinance/options').BachelierImpliedVolatilityInput; default: not declared - bachelier.impliedVolatility(input).forward: number; default: not declared - bachelier.impliedVolatility(input).price: number; default: not declared - bachelier.impliedVolatility(input).riskFreeRate: number; default: not declared - bachelier.impliedVolatility(input).strike: number; default: not declared - bachelier.impliedVolatility(input).timeToExpiryYears: number; default: not declared - bachelier.impliedVolatility(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.impliedVolatility.explain: (input: import('@insiderfinance/totalfinance/options').BachelierImpliedVolatilityInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - bachelier.impliedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - bachelier.impliedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bachelier.impliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bachelier.impliedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bachelier.impliedVolatility.explain(input): import('@insiderfinance/totalfinance/options').BachelierImpliedVolatilityInput; default: not declared - bachelier.impliedVolatility.explain(input).forward: number; default: not declared - bachelier.impliedVolatility.explain(input).price: number; default: not declared - bachelier.impliedVolatility.explain(input).riskFreeRate: number; default: not declared - bachelier.impliedVolatility.explain(input).strike: number; default: not declared - bachelier.impliedVolatility.explain(input).timeToExpiryYears: number; default: not declared - bachelier.impliedVolatility.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.price: import('@insiderfinance/totalfinance/core').Facade; default: not declared - bachelier.price(input): import('@insiderfinance/totalfinance/options').BachelierTypedInput; default: not declared - bachelier.price(input).forward: number; default: not declared - bachelier.price(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.price(input).riskFreeRate: number; default: not declared - bachelier.price(input).strike: number; default: not declared - bachelier.price(input).timeToExpiryYears: number; default: not declared - bachelier.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.price.explain: (input: import('@insiderfinance/totalfinance/options').BachelierTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - bachelier.price.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - bachelier.price.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bachelier.price.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bachelier.price.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bachelier.price.explain(input): import('@insiderfinance/totalfinance/options').BachelierTypedInput; default: not declared - bachelier.price.explain(input).forward: number; default: not declared - bachelier.price.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.price.explain(input).riskFreeRate: number; default: not declared - bachelier.price.explain(input).strike: number; default: not declared - bachelier.price.explain(input).timeToExpiryYears: number; default: not declared - bachelier.price.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - bachelier.put: import('@insiderfinance/totalfinance/core').Facade; default: not declared - bachelier.put(input): import('@insiderfinance/totalfinance/options').BachelierInput; default: not declared - bachelier.put(input).forward: number; default: not declared - bachelier.put(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.put(input).riskFreeRate: number; default: not declared - bachelier.put(input).strike: number; default: not declared - bachelier.put(input).timeToExpiryYears: number; default: not declared - bachelier.put.explain: (input: import('@insiderfinance/totalfinance/options').BachelierInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - bachelier.put.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - bachelier.put.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bachelier.put.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bachelier.put.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bachelier.put.explain(input): import('@insiderfinance/totalfinance/options').BachelierInput; default: not declared - bachelier.put.explain(input).forward: number; default: not declared - bachelier.put.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - bachelier.put.explain(input).riskFreeRate: number; default: not declared - bachelier.put.explain(input).strike: number; default: not declared - bachelier.put.explain(input).timeToExpiryYears: number; default: not declared - barrier: { readonly price: (input: import('@insiderfinance/totalfinance/options').BarrierInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').BarrierInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; }, options: import('@insiderfinance/totalfinance/options').BarrierMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - barrier.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').BarrierInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; }, options: import('@insiderfinance/totalfinance/options').BarrierMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Brownian-bridge-corrected Monte-Carlo barrier price (converges to the continuous analytic). - barrier.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - barrier.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - barrier.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - barrier.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - barrier.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - barrier.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').BarrierInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; }; default: not declared - barrier.monteCarloPrice(input).barrier: number; default: not declared — Barrier level H. - barrier.monteCarloPrice(input).barrierType: import('@insiderfinance/totalfinance/options').BarrierType; default: not declared - barrier.monteCarloPrice(input).dividendYield?: number; default: not declared - barrier.monteCarloPrice(input).riskFreeRate: number; default: not declared - barrier.monteCarloPrice(input).spot: number; default: not declared - barrier.monteCarloPrice(input).strike: number; default: not declared - barrier.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - barrier.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - barrier.monteCarloPrice(input).volatility: number; default: not declared - barrier.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').BarrierMonteCarloOptions; default: not declared - barrier.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - barrier.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - barrier.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - barrier.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - barrier.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - barrier.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - barrier.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - barrier.monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 100). - barrier.price: (input: import('@insiderfinance/totalfinance/options').BarrierInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Continuous-monitoring single-barrier price (Reiner–Rubinstein / Haug, zero rebate). - barrier.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - barrier.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - barrier.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - barrier.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - barrier.price(input): import('@insiderfinance/totalfinance/options').BarrierInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; }; default: not declared - barrier.price(input).barrier: number; default: not declared — Barrier level H. - barrier.price(input).barrierType: import('@insiderfinance/totalfinance/options').BarrierType; default: not declared - barrier.price(input).dividendYield?: number; default: not declared - barrier.price(input).riskFreeRate: number; default: not declared - barrier.price(input).spot: number; default: not declared - barrier.price(input).strike: number; default: not declared - barrier.price(input).timeToExpiryYears: number; default: not declared - barrier.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - barrier.price(input).volatility: number; default: not declared - basket: { readonly approximatePrice: (input: import('@insiderfinance/totalfinance/options').BasketInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').BasketInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - basket.approximatePrice: (input: import('@insiderfinance/totalfinance/options').BasketInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Levy moment-matched lognormal approximation (closed form) for a weighted-basket option. - basket.approximatePrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - basket.approximatePrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - basket.approximatePrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - basket.approximatePrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - basket.approximatePrice(input): import('@insiderfinance/totalfinance/options').BasketInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - basket.approximatePrice(input).correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - basket.approximatePrice(input).dividendYields?: number[]; default: not declared - basket.approximatePrice(input).riskFreeRate: number; default: not declared - basket.approximatePrice(input).spots: number[]; default: not declared - basket.approximatePrice(input).strike: number; default: not declared - basket.approximatePrice(input).timeToExpiryYears: number; default: not declared - basket.approximatePrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - basket.approximatePrice(input).volatilities: number[]; default: not declared - basket.approximatePrice(input).weights: number[]; default: not declared — Basket weights (one per asset). - basket.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').BasketInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo price of a weighted-basket option (exact; corroborates the Levy approximation). - basket.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - basket.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - basket.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - basket.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - basket.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - basket.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').BasketInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - basket.monteCarloPrice(input).correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - basket.monteCarloPrice(input).dividendYields?: number[]; default: not declared - basket.monteCarloPrice(input).riskFreeRate: number; default: not declared - basket.monteCarloPrice(input).spots: number[]; default: not declared - basket.monteCarloPrice(input).strike: number; default: not declared - basket.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - basket.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - basket.monteCarloPrice(input).volatilities: number[]; default: not declared - basket.monteCarloPrice(input).weights: number[]; default: not declared — Basket weights (one per asset). - basket.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - basket.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - basket.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - basket.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - basket.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - basket.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - basket.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - basket.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - black76: { call: import('@insiderfinance/totalfinance/core').Facade; put: import('@insiderfinance/totalfinance/core').Facade; price: import('@insiderfinance/totalfinance/core').Facade; greeks: import('@insiderfinance/totalfinance/core').Facade; extendedGreeks: import('@insiderfinance/totalfinance/core').Facade; impliedVolatility: import('@insiderfinance/totalfinance/core').Facade, number | null>; }; default: not declared — The Black-76 facade namespace. - black76.call: import('@insiderfinance/totalfinance/core').Facade; default: not declared - black76.call(input): import('@insiderfinance/totalfinance/options').Black76Input; default: not declared - black76.call(input).forward: number; default: not declared - black76.call(input).riskFreeRate: number; default: not declared - black76.call(input).strike: number; default: not declared - black76.call(input).timeToExpiryYears: number; default: not declared - black76.call(input).volatility: number; default: not declared - black76.call.explain: (input: import('@insiderfinance/totalfinance/options').Black76Input) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - black76.call.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - black76.call.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - black76.call.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - black76.call.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - black76.call.explain(input): import('@insiderfinance/totalfinance/options').Black76Input; default: not declared - black76.call.explain(input).forward: number; default: not declared - black76.call.explain(input).riskFreeRate: number; default: not declared - black76.call.explain(input).strike: number; default: not declared - black76.call.explain(input).timeToExpiryYears: number; default: not declared - black76.call.explain(input).volatility: number; default: not declared - black76.extendedGreeks: import('@insiderfinance/totalfinance/core').Facade; default: not declared - black76.extendedGreeks().return.charm: number; default: not declared - black76.extendedGreeks().return.color: number; default: not declared - black76.extendedGreeks().return.delta: number; default: not declared - black76.extendedGreeks().return.gamma: number; default: not declared - black76.extendedGreeks().return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - black76.extendedGreeks().return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - black76.extendedGreeks().return.rho: number; default: not declared - black76.extendedGreeks().return.speed: number; default: not declared - black76.extendedGreeks().return.theta: number; default: not declared - black76.extendedGreeks().return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - black76.extendedGreeks().return.vanna: number; default: not declared - black76.extendedGreeks().return.vega: number; default: not declared - black76.extendedGreeks().return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - black76.extendedGreeks().return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - black76.extendedGreeks().return.vomma: number; default: not declared - black76.extendedGreeks().return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - black76.extendedGreeks(input): import('@insiderfinance/totalfinance/options').Black76TypedInput; default: not declared - black76.extendedGreeks(input).forward: number; default: not declared - black76.extendedGreeks(input).riskFreeRate: number; default: not declared - black76.extendedGreeks(input).strike: number; default: not declared - black76.extendedGreeks(input).timeToExpiryYears: number; default: not declared - black76.extendedGreeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.extendedGreeks(input).volatility: number; default: not declared - black76.extendedGreeks.explain: (input: import('@insiderfinance/totalfinance/options').Black76TypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - black76.extendedGreeks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - black76.extendedGreeks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - black76.extendedGreeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - black76.extendedGreeks.explain().return.value: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - black76.extendedGreeks.explain(input): import('@insiderfinance/totalfinance/options').Black76TypedInput; default: not declared - black76.extendedGreeks.explain(input).forward: number; default: not declared - black76.extendedGreeks.explain(input).riskFreeRate: number; default: not declared - black76.extendedGreeks.explain(input).strike: number; default: not declared - black76.extendedGreeks.explain(input).timeToExpiryYears: number; default: not declared - black76.extendedGreeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.extendedGreeks.explain(input).volatility: number; default: not declared - black76.greeks: import('@insiderfinance/totalfinance/core').Facade; default: not declared - black76.greeks().return.delta: number; default: not declared - black76.greeks().return.gamma: number; default: not declared - black76.greeks().return.rho: number; default: not declared - black76.greeks().return.theta: number; default: not declared - black76.greeks().return.vega: number; default: not declared - black76.greeks(input): import('@insiderfinance/totalfinance/options').Black76TypedInput; default: not declared - black76.greeks(input).forward: number; default: not declared - black76.greeks(input).riskFreeRate: number; default: not declared - black76.greeks(input).strike: number; default: not declared - black76.greeks(input).timeToExpiryYears: number; default: not declared - black76.greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.greeks(input).volatility: number; default: not declared - black76.greeks.explain: (input: import('@insiderfinance/totalfinance/options').Black76TypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - black76.greeks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - black76.greeks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - black76.greeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - black76.greeks.explain().return.value: import('@insiderfinance/totalfinance/options').Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - black76.greeks.explain(input): import('@insiderfinance/totalfinance/options').Black76TypedInput; default: not declared - black76.greeks.explain(input).forward: number; default: not declared - black76.greeks.explain(input).riskFreeRate: number; default: not declared - black76.greeks.explain(input).strike: number; default: not declared - black76.greeks.explain(input).timeToExpiryYears: number; default: not declared - black76.greeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.greeks.explain(input).volatility: number; default: not declared - black76.impliedVolatility: import('@insiderfinance/totalfinance/core').Facade, number | null>; default: not declared - black76.impliedVolatility(input): import('@insiderfinance/totalfinance/options').Black76ImpliedVolatilityInput; default: not declared - black76.impliedVolatility(input).forward: number; default: not declared - black76.impliedVolatility(input).price: number; default: not declared - black76.impliedVolatility(input).riskFreeRate: number; default: not declared - black76.impliedVolatility(input).strike: number; default: not declared - black76.impliedVolatility(input).timeToExpiryYears: number; default: not declared - black76.impliedVolatility(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.impliedVolatility.explain: (input: import('@insiderfinance/totalfinance/options').Black76ImpliedVolatilityInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - black76.impliedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - black76.impliedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - black76.impliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - black76.impliedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - black76.impliedVolatility.explain(input): import('@insiderfinance/totalfinance/options').Black76ImpliedVolatilityInput; default: not declared - black76.impliedVolatility.explain(input).forward: number; default: not declared - black76.impliedVolatility.explain(input).price: number; default: not declared - black76.impliedVolatility.explain(input).riskFreeRate: number; default: not declared - black76.impliedVolatility.explain(input).strike: number; default: not declared - black76.impliedVolatility.explain(input).timeToExpiryYears: number; default: not declared - black76.impliedVolatility.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.price: import('@insiderfinance/totalfinance/core').Facade; default: not declared - black76.price(input): import('@insiderfinance/totalfinance/options').Black76TypedInput; default: not declared - black76.price(input).forward: number; default: not declared - black76.price(input).riskFreeRate: number; default: not declared - black76.price(input).strike: number; default: not declared - black76.price(input).timeToExpiryYears: number; default: not declared - black76.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.price(input).volatility: number; default: not declared - black76.price.explain: (input: import('@insiderfinance/totalfinance/options').Black76TypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - black76.price.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - black76.price.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - black76.price.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - black76.price.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - black76.price.explain(input): import('@insiderfinance/totalfinance/options').Black76TypedInput; default: not declared - black76.price.explain(input).forward: number; default: not declared - black76.price.explain(input).riskFreeRate: number; default: not declared - black76.price.explain(input).strike: number; default: not declared - black76.price.explain(input).timeToExpiryYears: number; default: not declared - black76.price.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - black76.price.explain(input).volatility: number; default: not declared - black76.put: import('@insiderfinance/totalfinance/core').Facade; default: not declared - black76.put(input): import('@insiderfinance/totalfinance/options').Black76Input; default: not declared - black76.put(input).forward: number; default: not declared - black76.put(input).riskFreeRate: number; default: not declared - black76.put(input).strike: number; default: not declared - black76.put(input).timeToExpiryYears: number; default: not declared - black76.put(input).volatility: number; default: not declared - black76.put.explain: (input: import('@insiderfinance/totalfinance/options').Black76Input) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - black76.put.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - black76.put.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - black76.put.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - black76.put.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - black76.put.explain(input): import('@insiderfinance/totalfinance/options').Black76Input; default: not declared - black76.put.explain(input).forward: number; default: not declared - black76.put.explain(input).riskFreeRate: number; default: not declared - black76.put.explain(input).strike: number; default: not declared - black76.put.explain(input).timeToExpiryYears: number; default: not declared - black76.put.explain(input).volatility: number; default: not declared - blackScholes: { call: import('@insiderfinance/totalfinance/core').Facade; delta: import('@insiderfinance/totalfinance/core').Facade; evaluate: import('@insiderfinance/totalfinance/options/black-scholes').BlackScholesEvaluateFacade; extendedGreeks: import('@insiderfinance/totalfinance/core').Facade; gamma: import('@insiderfinance/totalfinance/core').Facade; greeks: import('@insiderfinance/totalfinance/core').Facade; impliedVolatility: import('@insiderfinance/totalfinance/core').Facade, number | null>; price: import('@insiderfinance/totalfinance/core').Facade; put: import('@insiderfinance/totalfinance/core').Facade; rho: import('@insiderfinance/totalfinance/core').Facade; theta: import('@insiderfinance/totalfinance/core').Facade; vega: import('@insiderfinance/totalfinance/core').Facade; }; default: not declared — The Black–Scholes facade namespace. Flat object arguments in, plain values out; `.explain()` on each function returns the assumptions/diagnostics envelope. - blackScholes.call: import('@insiderfinance/totalfinance/core').Facade; default: not declared - blackScholes.call(input): import('@insiderfinance/totalfinance/options').BlackScholesInput; default: not declared - blackScholes.call(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.call(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.call(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.call(input).strike: number; default: not declared — Strike price. - blackScholes.call(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.call(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.call.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.call.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.call.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.call.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.call.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.call.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesInput; default: not declared - blackScholes.call.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.call.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.call.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.call.explain(input).strike: number; default: not declared — Strike price. - blackScholes.call.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.call.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.delta: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Delta alone (per share per 1.00 of spot). Computes no other Greek. - blackScholes.delta(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.delta(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.delta(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.delta(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.delta(input).strike: number; default: not declared — Strike price. - blackScholes.delta(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.delta(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.delta(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.delta.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.delta.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.delta.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.delta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.delta.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.delta.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.delta.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.delta.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.delta.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.delta.explain(input).strike: number; default: not declared — Strike price. - blackScholes.delta.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.delta.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.delta.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.evaluate: import('@insiderfinance/totalfinance/options/black-scholes').BlackScholesEvaluateFacade; default: not declared — Several selected outputs from one shared evaluation — `evaluate({ ...input, outputs: ['price', 'delta', 'gamma'] })`. Only the requested outputs and their dependencies are computed, and only they appear in the result. - blackScholes.evaluate(input): import('@insiderfinance/totalfinance/options').BlackScholesEvaluateInput; default: not declared - blackScholes.evaluate(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.evaluate(input).outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - blackScholes.evaluate(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.evaluate(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.evaluate(input).strike: number; default: not declared — Strike price. - blackScholes.evaluate(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.evaluate(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.evaluate(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.evaluate.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesEvaluateInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.evaluate.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.evaluate.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.evaluate.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.evaluate.explain().return.value: import('@insiderfinance/totalfinance/options').BlackScholesEvaluation; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.evaluate.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesEvaluateInput; default: not declared - blackScholes.evaluate.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.evaluate.explain(input).outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - blackScholes.evaluate.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.evaluate.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.evaluate.explain(input).strike: number; default: not declared — Strike price. - blackScholes.evaluate.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.evaluate.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.evaluate.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.extendedGreeks: import('@insiderfinance/totalfinance/core').Facade; default: not declared - blackScholes.extendedGreeks().return.charm: number; default: not declared - blackScholes.extendedGreeks().return.color: number; default: not declared - blackScholes.extendedGreeks().return.delta: number; default: not declared - blackScholes.extendedGreeks().return.gamma: number; default: not declared - blackScholes.extendedGreeks().return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - blackScholes.extendedGreeks().return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - blackScholes.extendedGreeks().return.rho: number; default: not declared - blackScholes.extendedGreeks().return.speed: number; default: not declared - blackScholes.extendedGreeks().return.theta: number; default: not declared - blackScholes.extendedGreeks().return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - blackScholes.extendedGreeks().return.vanna: number; default: not declared - blackScholes.extendedGreeks().return.vega: number; default: not declared - blackScholes.extendedGreeks().return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - blackScholes.extendedGreeks().return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - blackScholes.extendedGreeks().return.vomma: number; default: not declared - blackScholes.extendedGreeks().return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - blackScholes.extendedGreeks(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.extendedGreeks(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.extendedGreeks(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.extendedGreeks(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.extendedGreeks(input).strike: number; default: not declared — Strike price. - blackScholes.extendedGreeks(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.extendedGreeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.extendedGreeks(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.extendedGreeks.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.extendedGreeks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.extendedGreeks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.extendedGreeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.extendedGreeks.explain().return.value: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.extendedGreeks.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.extendedGreeks.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.extendedGreeks.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.extendedGreeks.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.extendedGreeks.explain(input).strike: number; default: not declared — Strike price. - blackScholes.extendedGreeks.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.extendedGreeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.extendedGreeks.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.gamma: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Gamma alone (per 1.00 of spot). Evaluates the normal density and no cumulative normal. - blackScholes.gamma(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.gamma(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.gamma(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.gamma(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.gamma(input).strike: number; default: not declared — Strike price. - blackScholes.gamma(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.gamma(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.gamma(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.gamma.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.gamma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.gamma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.gamma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.gamma.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.gamma.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.gamma.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.gamma.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.gamma.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.gamma.explain(input).strike: number; default: not declared — Strike price. - blackScholes.gamma.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.gamma.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.gamma.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.greeks: import('@insiderfinance/totalfinance/core').Facade; default: not declared - blackScholes.greeks().return.delta: number; default: not declared - blackScholes.greeks().return.gamma: number; default: not declared - blackScholes.greeks().return.rho: number; default: not declared - blackScholes.greeks().return.theta: number; default: not declared - blackScholes.greeks().return.vega: number; default: not declared - blackScholes.greeks(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.greeks(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.greeks(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.greeks(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.greeks(input).strike: number; default: not declared — Strike price. - blackScholes.greeks(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.greeks(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.greeks.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.greeks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.greeks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.greeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.greeks.explain().return.value: import('@insiderfinance/totalfinance/options').Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.greeks.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.greeks.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.greeks.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.greeks.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.greeks.explain(input).strike: number; default: not declared — Strike price. - blackScholes.greeks.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.greeks.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.greeks.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.impliedVolatility: import('@insiderfinance/totalfinance/core').Facade, number | null>; default: not declared - blackScholes.impliedVolatility(input): import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput; default: not declared - blackScholes.impliedVolatility(input).dividendYield?: number; default: not declared - blackScholes.impliedVolatility(input).price: number; default: not declared — Observed option price to invert. - blackScholes.impliedVolatility(input).riskFreeRate: number; default: not declared - blackScholes.impliedVolatility(input).spot: number; default: not declared - blackScholes.impliedVolatility(input).strike: number; default: not declared - blackScholes.impliedVolatility(input).timeToExpiryYears: number; default: not declared - blackScholes.impliedVolatility(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.impliedVolatility.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.impliedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.impliedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.impliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.impliedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.impliedVolatility.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput; default: not declared - blackScholes.impliedVolatility.explain(input).dividendYield?: number; default: not declared - blackScholes.impliedVolatility.explain(input).price: number; default: not declared — Observed option price to invert. - blackScholes.impliedVolatility.explain(input).riskFreeRate: number; default: not declared - blackScholes.impliedVolatility.explain(input).spot: number; default: not declared - blackScholes.impliedVolatility.explain(input).strike: number; default: not declared - blackScholes.impliedVolatility.explain(input).timeToExpiryYears: number; default: not declared - blackScholes.impliedVolatility.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.price: import('@insiderfinance/totalfinance/core').Facade; default: not declared - blackScholes.price(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.price(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.price(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.price(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.price(input).strike: number; default: not declared — Strike price. - blackScholes.price(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.price(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.price.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.price.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.price.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.price.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.price.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.price.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.price.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.price.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.price.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.price.explain(input).strike: number; default: not declared — Strike price. - blackScholes.price.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.price.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.price.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.put: import('@insiderfinance/totalfinance/core').Facade; default: not declared - blackScholes.put(input): import('@insiderfinance/totalfinance/options').BlackScholesInput; default: not declared - blackScholes.put(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.put(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.put(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.put(input).strike: number; default: not declared — Strike price. - blackScholes.put(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.put(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.put.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.put.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.put.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.put.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.put.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.put.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesInput; default: not declared - blackScholes.put.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.put.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.put.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.put.explain(input).strike: number; default: not declared — Strike price. - blackScholes.put.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.put.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.rho: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Rho alone, per 1% of the risk-free rate. - blackScholes.rho(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.rho(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.rho(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.rho(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.rho(input).strike: number; default: not declared — Strike price. - blackScholes.rho(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.rho(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.rho(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.rho.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.rho.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.rho.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.rho.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.rho.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.rho.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.rho.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.rho.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.rho.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.rho.explain(input).strike: number; default: not declared — Strike price. - blackScholes.rho.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.rho.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.rho.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.theta: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Theta alone, per calendar day. - blackScholes.theta(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.theta(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.theta(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.theta(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.theta(input).strike: number; default: not declared — Strike price. - blackScholes.theta(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.theta(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.theta(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.theta.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.theta.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.theta.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.theta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.theta.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.theta.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.theta.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.theta.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.theta.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.theta.explain(input).strike: number; default: not declared — Strike price. - blackScholes.theta.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.theta.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.theta.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.vega: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Vega alone, per 1 volatility point (0.01). - blackScholes.vega(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.vega(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.vega(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.vega(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.vega(input).strike: number; default: not declared — Strike price. - blackScholes.vega(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.vega(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.vega(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - blackScholes.vega.explain: (input: import('@insiderfinance/totalfinance/options').BlackScholesTypedInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - blackScholes.vega.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - blackScholes.vega.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackScholes.vega.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackScholes.vega.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackScholes.vega.explain(input): import('@insiderfinance/totalfinance/options').BlackScholesTypedInput; default: not declared - blackScholes.vega.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - blackScholes.vega.explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - blackScholes.vega.explain(input).spot: number; default: not declared — Spot price of the underlying. - blackScholes.vega.explain(input).strike: number; default: not declared — Strike price. - blackScholes.vega.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - blackScholes.vega.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - blackScholes.vega.explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - boxSpreadRate: (input: import('@insiderfinance/totalfinance/options/parity').BoxSpreadRateInput) => import('@insiderfinance/totalfinance/options').BoxSpreadResult; default: not declared — Implied financing rate from the box spread between strikes `k1 < k2`. A box (bull call spread `+` bear put spread) locks in `(k2 − k1)` at expiry for a net debit `box = (C(k1) − C(k2)) + (P(k2) − P(k1))`, so `box = (k2 − k1)·e^(−rT)` and `rate = −ln(box / (k2 − k1)) / T`. Throws `parity.strike_unavailable` when a needed leg is missing. - boxSpreadRate().return.assumptions: import('@insiderfinance/totalfinance/options').BoxSpreadAssumptions; default: not declared - boxSpreadRate().return.diagnostics: import('@insiderfinance/totalfinance/options').BoxSpreadDiagnostics; default: not declared - boxSpreadRate().return.value: number; default: not declared - boxSpreadRate(input): import('@insiderfinance/totalfinance/options/parity').BoxSpreadRateInput; default: not declared - boxSpreadRate(input).expiry: string; default: not declared - boxSpreadRate(input).lowerStrike: number; default: not declared - boxSpreadRate(input).options: import('@insiderfinance/totalfinance/options').BoxSpreadOptions; default: not declared - boxSpreadRate(input).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - boxSpreadRate(input).upperStrike: number; default: not declared - callContract: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared — Generic call builder — `style` REQUIRED. - callContract().return.adjusted?: boolean; default: not declared - callContract().return.currency?: string; default: not declared - callContract().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - callContract().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - callContract().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - callContract().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - callContract().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - callContract().return.multiplier?: number; default: not declared - callContract().return.occSymbol?: string; default: not declared - callContract().return.root?: string; default: not declared - callContract().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - callContract().return.strike: number; default: not declared - callContract().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - callContract().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - callContract().return.underlying: string; default: not declared - callContract(input): import('@insiderfinance/totalfinance/options').OptionBuilderInput; default: not declared - callContract(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - callContract(input).currency?: string; default: not declared - callContract(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - callContract(input).multiplier?: number; default: not declared - callContract(input).root?: string; default: not declared - callContract(input).strike: number; default: not declared - callContract(input).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - callContract(input).underlying: string; default: not declared - chainGreeks: (input: import('@insiderfinance/totalfinance/options').ChainGreeksInput) => import('@insiderfinance/totalfinance/options').ChainGreeksResult; default: not declared — Solve every chain row's implied volatility and Greeks from its observed price. See the module note: non-throwing per row, style-routed, display units, provenance stamped. - chainGreeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - chainGreeks().return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ChainGreeksDiagnostics); default: not declared — How the value was computed, plus any warnings. - chainGreeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - chainGreeks().return.value: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - chainGreeks(input): import('@insiderfinance/totalfinance/options').ChainGreeksInput; default: not declared - chainGreeks(input).market: import('@insiderfinance/totalfinance/core').MarketInputs; default: not declared — Spot, rate, optional continuous yield and the valuation instant (a bare date is refused). - chainGreeks(input).priceSource?: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — Which observed price to invert per row (default `'mid'`; no fallback across sources). - chainGreeks(input).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared — The chain rows; each is returned in order, stamped when its Greeks could be solved. - checkBlackScholesNoArbitrage: (input: import('@insiderfinance/totalfinance/options').BlackScholesNoArbitrageInput) => ({ admissible: boolean; lower: number; upper: number; assumptions: import('@insiderfinance/totalfinance/core').Assumptions; diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; }); default: not declared — Check an observed price against BSM no-arbitrage bounds. Returns a report: `admissible` plus the `[lower, upper]` band, with each violation as a structured `severity: 'error'` warning on `diagnostics.warnings` (empty when the price is admissible). Callers decide whether to treat a violation as fatal. - checkBlackScholesNoArbitrage().return.admissible: boolean; default: not declared — True when the observed price sits inside the BSM no-arbitrage band (within tolerance). - checkBlackScholesNoArbitrage().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Applied conventions, echoed (Law 2 report grammar). - checkBlackScholesNoArbitrage().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — The violations as structured warnings (empty when admissible). - checkBlackScholesNoArbitrage().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - checkBlackScholesNoArbitrage().return.lower: number; default: not declared — The no-arbitrage lower bound (discounted intrinsic). - checkBlackScholesNoArbitrage().return.upper: number; default: not declared — The no-arbitrage upper bound (call: discounted spot; put: discounted strike). - checkBlackScholesNoArbitrage(input): import('@insiderfinance/totalfinance/options').BlackScholesNoArbitrageInput; default: not declared - checkBlackScholesNoArbitrage(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - checkBlackScholesNoArbitrage(input).price: number; default: not declared — The observed option price to test. - checkBlackScholesNoArbitrage(input).riskFreeRate: number; default: not declared - checkBlackScholesNoArbitrage(input).spot: number; default: not declared - checkBlackScholesNoArbitrage(input).strike: number; default: not declared - checkBlackScholesNoArbitrage(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - checkBlackScholesNoArbitrage(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - cliquet: { readonly price: (input: import('@insiderfinance/totalfinance/options').CliquetInput) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').CliquetInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - cliquet.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').CliquetInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — General Monte-Carlo cliquet (local + global caps/floors); converges to the analytic in the no-global case. - cliquet.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - cliquet.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - cliquet.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - cliquet.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cliquet.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cliquet.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').CliquetInput; default: not declared - cliquet.monteCarloPrice(input).dividendYield?: number; default: not declared - cliquet.monteCarloPrice(input).globalCap?: number; default: not declared — Global (summed) cap; default `+∞`. Requires `monteCarloPrice`. - cliquet.monteCarloPrice(input).globalFloor?: number; default: not declared — Global (summed) floor; default `−∞`. Requires `monteCarloPrice`. - cliquet.monteCarloPrice(input).localCap?: number; default: not declared — Per-period return cap; default `+∞` (uncapped). Must be > `localFloor`. - cliquet.monteCarloPrice(input).localFloor?: number; default: not declared — Per-period return floor; default 0 (lock in non-negative gains). Must be ≥ −1. - cliquet.monteCarloPrice(input).notional?: number; default: not declared — Notional multiplier; default 1. - cliquet.monteCarloPrice(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - cliquet.monteCarloPrice(input).riskFreeRate: number; default: not declared - cliquet.monteCarloPrice(input).spot: number; default: not declared - cliquet.monteCarloPrice(input).volatility: number; default: not declared - cliquet.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - cliquet.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - cliquet.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - cliquet.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - cliquet.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - cliquet.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - cliquet.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - cliquet.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - cliquet.price: (input: import('@insiderfinance/totalfinance/options').CliquetInput) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Closed-form cliquet (a strip of forward-start caplets), valid when there is NO global cap/floor — the value is then the discounted sum of the per-period expected clipped returns (Black-76 on each period return). A global cap/floor makes the total path-dependent; this throws and points to `monteCarloPrice`. See `docs/specs/cliquet.md`. - cliquet.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - cliquet.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - cliquet.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cliquet.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cliquet.price(input): import('@insiderfinance/totalfinance/options').CliquetInput; default: not declared - cliquet.price(input).dividendYield?: number; default: not declared - cliquet.price(input).globalCap?: number; default: not declared — Global (summed) cap; default `+∞`. Requires `monteCarloPrice`. - cliquet.price(input).globalFloor?: number; default: not declared — Global (summed) floor; default `−∞`. Requires `monteCarloPrice`. - cliquet.price(input).localCap?: number; default: not declared — Per-period return cap; default `+∞` (uncapped). Must be > `localFloor`. - cliquet.price(input).localFloor?: number; default: not declared — Per-period return floor; default 0 (lock in non-negative gains). Must be ≥ −1. - cliquet.price(input).notional?: number; default: not declared — Notional multiplier; default 1. - cliquet.price(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - cliquet.price(input).riskFreeRate: number; default: not declared - cliquet.price(input).spot: number; default: not declared - cliquet.price(input).volatility: number; default: not declared - compareEngines: (input: import('@insiderfinance/totalfinance/options').CompareEnginesInput) => import('@insiderfinance/totalfinance/options').EngineComparison; default: not declared — Price one contract across many engines and report each engine's value, Greeks, convergence, timing, and deviation from a high-resolution reference (spec §9.7). Rows are sorted most-accurate first. This is the tool for choosing an engine and for validating new ones against the lattice convergence benchmark — no silent "best" pick, every number is shown with its diagnostics. Supply a custom panel as `options.engines`; all request fields live in one object so adding a benchmark or clock never creates a second calling form. - compareEngines().return.assumptions: { conventionsVersion: string; engines: number; referenceEngine: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - compareEngines().return.assumptions.conventionsVersion: string; default: not declared - compareEngines().return.assumptions.engines: number; default: not declared - compareEngines().return.assumptions.referenceEngine: string; default: not declared - compareEngines().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present — engine failures are summarized here (details per row). - compareEngines().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - compareEngines().return.reference: { engine: string; value: number; }; default: not declared - compareEngines().return.reference.engine: string; default: not declared - compareEngines().return.reference.value: number; default: not declared - compareEngines().return.rows: import('@insiderfinance/totalfinance/options').EngineComparisonRow[]; default: not declared - compareEngines(input): import('@insiderfinance/totalfinance/options').CompareEnginesInput; default: not declared - compareEngines(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - compareEngines(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - compareEngines(input).options?: ({ engines?: import('@insiderfinance/totalfinance/options').OptionPricingEngine[]; reference?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; now?: () => number; }); default: not declared - compareEngines(input).options.engines?: import('@insiderfinance/totalfinance/options').OptionPricingEngine[]; default: not declared — Engines to compare. Defaults to the built-in panel that supports the contract. - compareEngines(input).options.now?: () => number; default: not declared — Optional monotonic clock (e.g. `() => performance.now()`). When supplied, each engine's wall-clock pricing time is measured into `timingMs`. Omitted by default so the function stays pure (no system-clock read) — timing is opt-in instrumentation the caller injects. - compareEngines(input).options.reference?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Convergence benchmark. Defaults to a 1001-step Leisen–Reimer lattice. - compo: { readonly price: (input: import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly greeks: (input: import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/core').Computed; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').CompoMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - compo.greeks: (input: import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — The compo's multi-factor risk: foreign-asset and FX deltas, foreign-asset gamma, the asset and FX vegas, the **correlation vega** (a compo is long correlation), plus theta and domestic rho — all exact chain-rule derivatives of the composite BSM greeks through `A₀ = S_f·X` and `σ_A`. - compo.greeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - compo.greeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - compo.greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - compo.greeks().return.value: import('@insiderfinance/totalfinance/options').CompoGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - compo.greeks(input): import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - compo.greeks(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - compo.greeks(input).dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - compo.greeks(input).domesticRate: number; default: not declared — Domestic discount / growth rate. - compo.greeks(input).fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - compo.greeks(input).fxVolatility: number; default: not declared — FX volatility `σ_X`. - compo.greeks(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - compo.greeks(input).strike: number; default: not declared — Strike, in DOMESTIC currency. - compo.greeks(input).timeToExpiryYears: number; default: not declared - compo.greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - compo.greeks(input).volatility: number; default: not declared — Foreign-asset volatility `σ_S`. - compo.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').CompoMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Two-factor Monte-Carlo: simulate `S_f` and `X` as correlated GBMs under the domestic measure and price `(S_f(T)·X(T) − K)⁺` discounted at `r_d`. Converges to the closed form, corroborating the `σ_A` combination. `options.foreignRate` (default `domesticRate`) only splits the two drifts — the price is invariant to it. - compo.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - compo.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - compo.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - compo.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - compo.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - compo.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - compo.monteCarloPrice(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - compo.monteCarloPrice(input).dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - compo.monteCarloPrice(input).domesticRate: number; default: not declared — Domestic discount / growth rate. - compo.monteCarloPrice(input).fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - compo.monteCarloPrice(input).fxVolatility: number; default: not declared — FX volatility `σ_X`. - compo.monteCarloPrice(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - compo.monteCarloPrice(input).strike: number; default: not declared — Strike, in DOMESTIC currency. - compo.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - compo.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - compo.monteCarloPrice(input).volatility: number; default: not declared — Foreign-asset volatility `σ_S`. - compo.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').CompoMonteCarloOptions; default: not declared - compo.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - compo.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - compo.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - compo.monteCarloPrice(options).foreignRate?: number; default: not declared — Foreign rate used only to split the two-factor drift; the price is invariant to it. Default = `domesticRate`. - compo.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - compo.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - compo.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - compo.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - compo.price: (input: import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Composite option paying `(S_f(T)·X(T) − K_d)⁺` in domestic currency — the foreign asset at the FLOATING FX rate against a domestic strike. The domestic value `A = S_f·X` is a domestic asset drifting at `r_d − q`, so this is exactly `BSM(A₀ = S_f·X, K_d, T, r_d, q, σ_A)` with the composite vol `σ_A = √(σ_S² + σ_X² + 2ρσ_Sσ_X)`. The foreign rate drops out. See `docs/specs/compo-option.md`. - compo.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - compo.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - compo.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - compo.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - compo.price(input): import('@insiderfinance/totalfinance/options').CompoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - compo.price(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - compo.price(input).dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - compo.price(input).domesticRate: number; default: not declared — Domestic discount / growth rate. - compo.price(input).fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - compo.price(input).fxVolatility: number; default: not declared — FX volatility `σ_X`. - compo.price(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - compo.price(input).strike: number; default: not declared — Strike, in DOMESTIC currency. - compo.price(input).timeToExpiryYears: number; default: not declared - compo.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - compo.price(input).volatility: number; default: not declared — Foreign-asset volatility `σ_S`. - defineOptionPricingEngine: (engine: import('@insiderfinance/totalfinance/options').OptionPricingEngine) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Define a custom pricing engine (spec §22.1). TotalFinance treats it like any built-in engine: pass it to `option.price({ contract: contract, market: market, engine: engine })`. - defineOptionPricingEngine().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - defineOptionPricingEngine().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - defineOptionPricingEngine().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - defineOptionPricingEngine().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - defineOptionPricingEngine().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - defineOptionPricingEngine().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - defineOptionPricingEngine().return.name: string; default: not declared - defineOptionPricingEngine().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - defineOptionPricingEngine().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - defineOptionPricingEngine().return.version: string; default: not declared - defineOptionPricingEngine(engine): import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared - defineOptionPricingEngine(engine).capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - defineOptionPricingEngine(engine).capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - defineOptionPricingEngine(engine).capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - defineOptionPricingEngine(engine).capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - defineOptionPricingEngine(engine).capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - defineOptionPricingEngine(engine).capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - defineOptionPricingEngine(engine).name: string; default: not declared - defineOptionPricingEngine(engine).price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - defineOptionPricingEngine(engine).supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - defineOptionPricingEngine(engine).version: string; default: not declared - digital: { readonly price: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; readonly greeks: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }) => import('@insiderfinance/totalfinance/core').Computed; readonly extendedGreeks: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }) => import('@insiderfinance/totalfinance/core').Computed; }; default: not declared - digital.extendedGreeks: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — The full higher-order (extended) Greek set for the European binary — completing {@link digital.greeks} with vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, and lambda. The binary price is a smooth function of `(S, σ, r, q, T)` for `T > 0`, so the higher-order Greeks are taken by central finite differences of the exact `digital.price` closed form (the shared `finiteDifferenceExtendedGreeks` helper); the first-order fields are the exact analytic Greeks of {@link digital.greeks}. Units match the package (higher-order raw; `phi` per 1% dividend yield; `lambda` dimensionless). Near the strike a binary's Greeks spike (pin risk) — they stay finite for `T > 0`, but very close to expiry-at-the-pin the higher-order finite differences lose precision; widen `t` or read the sign/scale rather than the digit. See `docs/specs/digital-extended-greeks.md`. - digital.extendedGreeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - digital.extendedGreeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - digital.extendedGreeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - digital.extendedGreeks().return.value: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - digital.extendedGreeks(input): import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }; default: not declared - digital.extendedGreeks(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - digital.extendedGreeks(input).dividendYield?: number; default: not declared - digital.extendedGreeks(input).kind: import('@insiderfinance/totalfinance/options').DigitalKind; default: not declared - digital.extendedGreeks(input).riskFreeRate: number; default: not declared - digital.extendedGreeks(input).spot: number; default: not declared - digital.extendedGreeks(input).strike: number; default: not declared - digital.extendedGreeks(input).timeToExpiryYears: number; default: not declared - digital.extendedGreeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - digital.extendedGreeks(input).volatility: number; default: not declared - digital.greeks: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Closed-form greeks (delta, gamma, vega, theta, rho) for the European binary. Every greek is an exact derivative of the `digital.price` closed form — pinned to a finite-difference bump in the tests. Units match the package: `vega` per vol point, `theta` per calendar day, `rho` per 1% (echoed in `assumptions.units`). A cash-or-nothing's delta spikes and gamma flips sign across the strike (pin risk); the asset-or-nothing's gamma/vega are exactly `0` at `d₂ = 0`. See `docs/specs/digital-greeks.md`. - digital.greeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - digital.greeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - digital.greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - digital.greeks().return.value: import('@insiderfinance/totalfinance/options').Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - digital.greeks(input): import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }; default: not declared - digital.greeks(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - digital.greeks(input).dividendYield?: number; default: not declared - digital.greeks(input).kind: import('@insiderfinance/totalfinance/options').DigitalKind; default: not declared - digital.greeks(input).riskFreeRate: number; default: not declared - digital.greeks(input).spot: number; default: not declared - digital.greeks(input).strike: number; default: not declared - digital.greeks(input).timeToExpiryYears: number; default: not declared - digital.greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - digital.greeks(input).volatility: number; default: not declared - digital.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo binary price (discount the terminal indicator payoff); converges to the analytic. - digital.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - digital.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - digital.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - digital.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - digital.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - digital.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }; default: not declared - digital.monteCarloPrice(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - digital.monteCarloPrice(input).dividendYield?: number; default: not declared - digital.monteCarloPrice(input).kind: import('@insiderfinance/totalfinance/options').DigitalKind; default: not declared - digital.monteCarloPrice(input).riskFreeRate: number; default: not declared - digital.monteCarloPrice(input).spot: number; default: not declared - digital.monteCarloPrice(input).strike: number; default: not declared - digital.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - digital.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - digital.monteCarloPrice(input).volatility: number; default: not declared - digital.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - digital.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - digital.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - digital.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - digital.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - digital.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - digital.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - digital.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - digital.price: (input: import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — European binary price (closed form). A vanilla call ≡ asset-or-nothing call − K·cash-or-nothing call. - digital.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - digital.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - digital.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - digital.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - digital.price(input): import('@insiderfinance/totalfinance/options').DigitalInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; }; default: not declared - digital.price(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - digital.price(input).dividendYield?: number; default: not declared - digital.price(input).kind: import('@insiderfinance/totalfinance/options').DigitalKind; default: not declared - digital.price(input).riskFreeRate: number; default: not declared - digital.price(input).spot: number; default: not declared - digital.price(input).strike: number; default: not declared - digital.price(input).timeToExpiryYears: number; default: not declared - digital.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - digital.price(input).volatility: number; default: not declared - dividendTermStructure: (input: import('@insiderfinance/totalfinance/options').DividendTermStructureInput) => import('@insiderfinance/totalfinance/options').DividendTermStructure; default: not declared — Build the dividend term structure — per-expiry forward, dividend PV, and continuous-equivalent yield — from a discrete cash schedule and/or a continuous yield. See `docs/specs/dividend-term-structure.md`. - dividendTermStructure().return.assumptions: { conventionsVersion: string; spot: number; riskFreeRate: number; continuousYield: number; dividendModel: import('@insiderfinance/totalfinance/core').DividendModel; }; default: not declared - dividendTermStructure().return.assumptions.continuousYield: number; default: not declared - dividendTermStructure().return.assumptions.conventionsVersion: string; default: not declared - dividendTermStructure().return.assumptions.dividendModel: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - dividendTermStructure().return.assumptions.riskFreeRate: number; default: not declared - dividendTermStructure().return.assumptions.spot: number; default: not declared - dividendTermStructure().return.continuousYield: number; default: not declared — The continuous yield echoed back (`0` when none supplied). - dividendTermStructure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - dividendTermStructure().return.points: import('@insiderfinance/totalfinance/options').DividendTermStructurePoint[]; default: not declared — One row per requested expiry, sorted ascending by tenor. - dividendTermStructure().return.summary: string; default: not declared — One-line, agent-relayable summary. - dividendTermStructure().return.totalDividendPresentValue: number; default: not declared — PV of every *future* dividend in the schedule (all `τᵢ > 0`), independent of the maturities asked. - dividendTermStructure(input): import('@insiderfinance/totalfinance/options').DividendTermStructureInput; default: not declared - dividendTermStructure(input).asOf: string | number; default: not declared — Valuation date; ex-dates and maturities are measured from here (epoch ms or ISO). Required. - dividendTermStructure(input).dividendYield?: number; default: not declared — Continuous dividend yield applied alongside the discrete schedule (decimal); default `0`. - dividendTermStructure(input).dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (ISO ex-date + per-share amount). Omitted / empty ⇒ continuous-only. - dividendTermStructure(input).maturities: string[]; default: not declared — The expiries (ISO dates) to report the term structure at. At least one, each after `asOf`. - dividendTermStructure(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - dividendTermStructure(input).spot: number; default: not declared - doubleTouch: { readonly price: (input: import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly greeks: (input: import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }) => import('@insiderfinance/totalfinance/core').Computed; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }, options: import('@insiderfinance/totalfinance/options').TouchMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - doubleTouch.greeks: (input: import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — First-order greeks (delta, gamma, vega, theta, rho) for the double-no-touch / double-one-touch corridor binary, by central finite-difference of the exact `doubleTouch.price` (the image-series precludes clean analytic greeks). Units match the package (vega/1%, theta/day, rho/1%; echoed in `assumptions.units`). The spot bump is shrunk near either barrier so it never straddles the corridor edge. Pinned to the exact `DNT + DOT = cash·e^{−rT}` greek identity. See `docs/specs/touch-greeks.md`. - doubleTouch.greeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - doubleTouch.greeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - doubleTouch.greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - doubleTouch.greeks().return.value: import('@insiderfinance/totalfinance/options').Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - doubleTouch.greeks(input): import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }; default: not declared - doubleTouch.greeks(input).cash?: number; default: not declared — Payout on the winning outcome; default 1. - doubleTouch.greeks(input).dividendYield?: number; default: not declared - doubleTouch.greeks(input).kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; default: not declared - doubleTouch.greeks(input).lower: number; default: not declared — Lower barrier `L` (> 0). - doubleTouch.greeks(input).riskFreeRate: number; default: not declared - doubleTouch.greeks(input).spot: number; default: not declared - doubleTouch.greeks(input).timeToExpiryYears: number; default: not declared - doubleTouch.greeks(input).upper: number; default: not declared — Upper barrier `U` (> L). - doubleTouch.greeks(input).volatility: number; default: not declared - doubleTouch.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }, options: import('@insiderfinance/totalfinance/options').TouchMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo double-no-touch / double-one-touch. The corridor survival per path is the product of the two single-barrier Brownian-bridge survivals (lower down × upper up), so discrete monitoring converges to the continuous analytic. - doubleTouch.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - doubleTouch.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - doubleTouch.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - doubleTouch.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - doubleTouch.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - doubleTouch.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }; default: not declared - doubleTouch.monteCarloPrice(input).cash?: number; default: not declared — Payout on the winning outcome; default 1. - doubleTouch.monteCarloPrice(input).dividendYield?: number; default: not declared - doubleTouch.monteCarloPrice(input).kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; default: not declared - doubleTouch.monteCarloPrice(input).lower: number; default: not declared — Lower barrier `L` (> 0). - doubleTouch.monteCarloPrice(input).riskFreeRate: number; default: not declared - doubleTouch.monteCarloPrice(input).spot: number; default: not declared - doubleTouch.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - doubleTouch.monteCarloPrice(input).upper: number; default: not declared — Upper barrier `U` (> L). - doubleTouch.monteCarloPrice(input).volatility: number; default: not declared - doubleTouch.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').TouchMonteCarloOptions; default: not declared - doubleTouch.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - doubleTouch.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - doubleTouch.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - doubleTouch.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - doubleTouch.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - doubleTouch.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - doubleTouch.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - doubleTouch.monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 100). - doubleTouch.price: (input: import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Double no-touch (pays if `S` stays in `(L, U)` the whole life) / double one-touch (pays if it ever leaves), continuous monitoring, settled at expiry. The image-series survival `P_stay` drives both: `DNT = cash·e^{−rT}·P_stay`, `DOT = cash·e^{−rT}·(1 − P_stay)`, so `DNT + DOT = cash·e^{−rT}`. A spot already outside the corridor short-circuits (DNT = 0, DOT = cash·e^{−rT}). See `docs/specs/double-touch.md`. - doubleTouch.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - doubleTouch.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - doubleTouch.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - doubleTouch.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - doubleTouch.price(input): import('@insiderfinance/totalfinance/options').DoubleTouchInput & { kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; }; default: not declared - doubleTouch.price(input).cash?: number; default: not declared — Payout on the winning outcome; default 1. - doubleTouch.price(input).dividendYield?: number; default: not declared - doubleTouch.price(input).kind: import('@insiderfinance/totalfinance/options').DoubleTouchKind; default: not declared - doubleTouch.price(input).lower: number; default: not declared — Lower barrier `L` (> 0). - doubleTouch.price(input).riskFreeRate: number; default: not declared - doubleTouch.price(input).spot: number; default: not declared - doubleTouch.price(input).timeToExpiryYears: number; default: not declared - doubleTouch.price(input).upper: number; default: not declared — Upper barrier `U` (> L). - doubleTouch.price(input).volatility: number; default: not declared - engines: { readonly auto: (options?: import('@insiderfinance/totalfinance/options').AutoEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly baroneAdesiWhaley: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly binomial: (options?: import('@insiderfinance/totalfinance/options').BinomialEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly bjerksundStensland: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly bjerksundStensland1993: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly bjerksundStensland2002: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly black76: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly blackScholes: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly blackScholesMerton: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly finiteDifference: { readonly crankNicolson: (options?: import('@insiderfinance/totalfinance/options').FiniteDifferenceEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; }; readonly heston: (parameters: import('@insiderfinance/totalfinance/options').HestonParameters, options?: import('@insiderfinance/totalfinance/options').HestonCosineExpansionOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly localVolatility: (surface: import('@insiderfinance/totalfinance/options').LocalVolatilityFunction, options: import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly monteCarlo: (options: import('@insiderfinance/totalfinance/options').MonteCarloPriceOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly sabr: (parameters: import('@insiderfinance/totalfinance/options').SabrParameters, options?: import('@insiderfinance/totalfinance/options').SabrOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; readonly trinomial: (options?: import('@insiderfinance/totalfinance/options').TrinomialEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; }; default: not declared — Built-in pricing engines (analytical, lattice, closed-form American approximations, and FDM) — every factory returns an {@link OptionPricingEngine} usable wherever an engine is accepted. - engines.auto: (options?: import('@insiderfinance/totalfinance/options').AutoEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Auto-select a pricing engine by objective (spec §9.3). The default `'accuracy'` favours the most accurate engine; `'speed'` favours the fastest closed form. Selection (delegate in **bold**): | Contract | speed | accuracy | | ------------------------------ | ----------------------------- | ----------------------------- | | European (spot) | **black-scholes-merton** | same | | European (forward, no spot) | **black-76** | same | | American call, no dividends | **black-scholes-merton** ¹ | same | | American (otherwise) | **bjerksund-stensland-2002** | **binomial-leisen-reimer** ² | | Unsupported (e.g. bermudan) | throws `engine.unsupported_contract` | ¹ Early exercise of a non-dividend call is never optimal, so its value equals the European BSM price. ² 501-step lattice. The result's `diagnostics.engine` is the DELEGATE's name and `diagnostics.autoReason` explains, in one sentence, why it was chosen. - engines.auto().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.auto().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.auto().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.auto().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.auto().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.auto().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.auto().return.name: string; default: not declared - engines.auto().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.auto().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.auto().return.version: string; default: not declared - engines.auto(options)?: import('@insiderfinance/totalfinance/options').AutoEngineOptions; default: not declared - engines.auto(options).objective?: import('@insiderfinance/totalfinance/options').AutoObjective; default: not declared — `'accuracy'` (default) picks the most accurate engine; `'speed'` the fastest closed form. - engines.baroneAdesiWhaley: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Barone–Adesi–Whaley American approximation (European falls through to BSM). Requires a POSITIVE rate: the quadratic approximation's exponent divides by `1 − e^{−rT}`, so it refuses `r ≤ 0` with `engine.unsupported_contract` instead of returning NaN or a diverging value. - engines.baroneAdesiWhaley().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.baroneAdesiWhaley().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.baroneAdesiWhaley().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.baroneAdesiWhaley().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.baroneAdesiWhaley().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.baroneAdesiWhaley().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.baroneAdesiWhaley().return.name: string; default: not declared - engines.baroneAdesiWhaley().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.baroneAdesiWhaley().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.baroneAdesiWhaley().return.version: string; default: not declared - engines.binomial: (options?: import('@insiderfinance/totalfinance/options').BinomialEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Binomial tree (American or European). Variants: CRR, Jarrow–Rudd, Tian, Leisen–Reimer. - engines.binomial().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.binomial().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.binomial().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.binomial().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.binomial().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.binomial().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.binomial().return.name: string; default: not declared - engines.binomial().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.binomial().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.binomial().return.version: string; default: not declared - engines.binomial(options)?: import('@insiderfinance/totalfinance/options').BinomialEngineOptions; default: not declared - engines.binomial(options).steps?: number; default: not declared - engines.binomial(options).variant?: import('@insiderfinance/totalfinance/options').BinomialVariant; default: not declared - engines.bjerksundStensland: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Bjerksund–Stensland American approximation — alias for the more accurate, more widely-used **2002** two-boundary form. Use {@link engines.bjerksundStensland1993} for the original single-boundary version. (European contracts fall through to BSM.) - engines.bjerksundStensland().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.bjerksundStensland().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.bjerksundStensland().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.bjerksundStensland().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.bjerksundStensland().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.bjerksundStensland().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.bjerksundStensland().return.name: string; default: not declared - engines.bjerksundStensland().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.bjerksundStensland().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.bjerksundStensland().return.version: string; default: not declared - engines.bjerksundStensland1993: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Bjerksund–Stensland (1993) single-boundary American approximation (European falls through to BSM). - engines.bjerksundStensland1993().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.bjerksundStensland1993().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.bjerksundStensland1993().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.bjerksundStensland1993().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.bjerksundStensland1993().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.bjerksundStensland1993().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.bjerksundStensland1993().return.name: string; default: not declared - engines.bjerksundStensland1993().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.bjerksundStensland1993().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.bjerksundStensland1993().return.version: string; default: not declared - engines.bjerksundStensland2002: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Bjerksund–Stensland (2002) two-boundary American approximation (European falls through to BSM). - engines.bjerksundStensland2002().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.bjerksundStensland2002().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.bjerksundStensland2002().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.bjerksundStensland2002().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.bjerksundStensland2002().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.bjerksundStensland2002().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.bjerksundStensland2002().return.name: string; default: not declared - engines.bjerksundStensland2002().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.bjerksundStensland2002().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.bjerksundStensland2002().return.version: string; default: not declared - engines.black76: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Black-76 (European options on a forward/future). Prices off `market.forward` and discounts at `market.rate` — the forward embeds carry/dividends, so no separate dividend model is applied. - engines.black76().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.black76().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.black76().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.black76().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.black76().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.black76().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.black76().return.name: string; default: not declared - engines.black76().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.black76().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.black76().return.version: string; default: not declared - engines.blackScholes: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Textbook Black–Scholes (European, no dividends). - engines.blackScholes().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.blackScholes().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.blackScholes().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.blackScholes().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.blackScholes().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.blackScholes().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.blackScholes().return.name: string; default: not declared - engines.blackScholes().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.blackScholes().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.blackScholes().return.version: string; default: not declared - engines.blackScholesMerton: () => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Black–Scholes–Merton (European) with a continuous dividend yield. - engines.blackScholesMerton().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.blackScholesMerton().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.blackScholesMerton().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.blackScholesMerton().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.blackScholesMerton().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.blackScholesMerton().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.blackScholesMerton().return.name: string; default: not declared - engines.blackScholesMerton().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.blackScholesMerton().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.blackScholesMerton().return.version: string; default: not declared - engines.finiteDifference: { readonly crankNicolson: (options?: import('@insiderfinance/totalfinance/options').FiniteDifferenceEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; }; default: not declared — Crank–Nicolson finite-difference engine (American or European). - engines.finiteDifference.crankNicolson: (options?: import('@insiderfinance/totalfinance/options').FiniteDifferenceEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared - engines.finiteDifference.crankNicolson().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.finiteDifference.crankNicolson().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.finiteDifference.crankNicolson().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.finiteDifference.crankNicolson().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.finiteDifference.crankNicolson().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.finiteDifference.crankNicolson().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.finiteDifference.crankNicolson().return.name: string; default: not declared - engines.finiteDifference.crankNicolson().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.finiteDifference.crankNicolson().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.finiteDifference.crankNicolson().return.version: string; default: not declared - engines.finiteDifference.crankNicolson(options)?: import('@insiderfinance/totalfinance/options').FiniteDifferenceEngineOptions; default: not declared - engines.finiteDifference.crankNicolson(options).gridPoints?: number; default: not declared - engines.finiteDifference.crankNicolson(options).timeSteps?: number; default: not declared - engines.heston: (parameters: import('@insiderfinance/totalfinance/options').HestonParameters, options?: import('@insiderfinance/totalfinance/options').HestonCosineExpansionOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Heston stochastic-volatility engine (spec §9.3, WS4.3): European vanillas via the COS method. American exercise is unsupported (`supports()` returns `false`). The low-level named-input kernel {@link hestonPrice} remains the direct API; this adapter lets Heston flow through `option.price`, `priceMany`, and `compareEngines`. - engines.heston().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.heston().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.heston().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.heston().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.heston().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.heston().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.heston().return.name: string; default: not declared - engines.heston().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.heston().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.heston().return.version: string; default: not declared - engines.heston(options)?: import('@insiderfinance/totalfinance/options').HestonCosineExpansionOptions; default: not declared - engines.heston(options).extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the **vol level** — `√v₀` and `√θ` bumped together — extending the `vega` convention. The COS price is accurate, so the finite differences are converged (verified stable across term counts). - engines.heston(options).greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - engines.heston(options).terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192; COS converges exponentially). - engines.heston(options).truncation?: number; default: not declared — Truncation width in standard deviations (default 12). - engines.heston(parameters): import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - engines.heston(parameters).kappa: number; default: not declared — Mean-reversion speed κ. - engines.heston(parameters).rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - engines.heston(parameters).sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - engines.heston(parameters).theta: number; default: not declared — Long-run variance θ. - engines.heston(parameters).v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - engines.localVolatility: (surface: import('@insiderfinance/totalfinance/options').LocalVolatilityFunction, options: import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Local-volatility (Dupire) Monte-Carlo engine (spec §9.3, WS4.3): European vanillas. `surface` is a `LocalVolatilityFunction` `(level, t) → σ` (typically from `dupireLocalVolatility`); `options` requires a seed (echoed). Greeks are not computed by the MC engine — absent, never fabricated. Low-level kernel: {@link localVolatilityMonteCarloPrice}. - engines.localVolatility().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.localVolatility().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.localVolatility().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.localVolatility().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.localVolatility().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.localVolatility().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.localVolatility().return.name: string; default: not declared - engines.localVolatility().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.localVolatility().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.localVolatility().return.version: string; default: not declared - engines.localVolatility(options): import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloOptions; default: not declared - engines.localVolatility(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - engines.localVolatility(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - engines.localVolatility(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - engines.localVolatility(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - engines.localVolatility(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - engines.localVolatility(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - engines.localVolatility(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - engines.localVolatility(options).steps?: number; default: not declared — Time steps per path (default 100). - engines.localVolatility(surface): import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared - engines.monteCarlo: (options: import('@insiderfinance/totalfinance/options').MonteCarloPriceOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Geometric-Brownian-motion Monte-Carlo engine (European only). The seed is required and echoed; the result carries MC error statistics on `result.mc` (and is a superset of {@link PriceResult}). Excluded from the {@link compareEngines} default panel — a stochastic engine belongs in a comparison only when the caller options in with a fixed seed. - engines.monteCarlo().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.monteCarlo().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.monteCarlo().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.monteCarlo().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.monteCarlo().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.monteCarlo().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.monteCarlo().return.name: string; default: not declared - engines.monteCarlo().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.monteCarlo().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.monteCarlo().return.version: string; default: not declared - engines.monteCarlo(options): import('@insiderfinance/totalfinance/options').MonteCarloPriceOptions; default: not declared - engines.monteCarlo(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - engines.monteCarlo(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - engines.monteCarlo(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - engines.monteCarlo(options).extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set by CRN finite differences (implies `greeks`). Third-order Greeks (speed/color/ultima) carry more Monte-Carlo error than the first/second order — raise `paths` when you need them tight. - engines.monteCarlo(options).greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `true`). - engines.monteCarlo(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - engines.monteCarlo(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - engines.monteCarlo(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - engines.monteCarlo(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - engines.sabr: (parameters: import('@insiderfinance/totalfinance/options').SabrParameters, options?: import('@insiderfinance/totalfinance/options').SabrOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — SABR engine (spec §9.3, WS4.3): European vanillas via Hagan's implied vol into Black-76 (lognormal) or Bachelier (normal). Uses `market.forward` when present, else the spot-implied forward. Low-level named-input kernel: {@link sabrPrice}. - engines.sabr().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.sabr().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.sabr().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.sabr().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.sabr().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.sabr().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.sabr().return.name: string; default: not declared - engines.sabr().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.sabr().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.sabr().return.version: string; default: not declared - engines.sabr(options)?: import('@insiderfinance/totalfinance/options').SabrOptions; default: not declared - engines.sabr(options).extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the SABR level `α` — extending the `vega` convention; `phi = 0` (forward model). Hagan's vol is smooth, so the finite differences are stable. - engines.sabr(options).greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - engines.sabr(options).volatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — Hagan expansion (default `'lognormal'`). - engines.sabr(parameters): import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - engines.sabr(parameters).alpha: number; default: not declared — Initial volatility level α (> 0). - engines.sabr(parameters).beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - engines.sabr(parameters).nu: number; default: not declared — Volatility of volatility ν (≥ 0). - engines.sabr(parameters).rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - engines.trinomial: (options?: import('@insiderfinance/totalfinance/options').TrinomialEngineOptions) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Trinomial tree (American or European). - engines.trinomial().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engines.trinomial().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engines.trinomial().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engines.trinomial().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engines.trinomial().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engines.trinomial().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engines.trinomial().return.name: string; default: not declared - engines.trinomial().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engines.trinomial().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engines.trinomial().return.version: string; default: not declared - engines.trinomial(options)?: import('@insiderfinance/totalfinance/options').TrinomialEngineOptions; default: not declared - engines.trinomial(options).steps?: number; default: not declared - european: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { type: import('@insiderfinance/totalfinance/core').OptionType; convention?: 'us-equity-close'; }) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared — European-exercise contract with the convention in the name (index-style options). A DATE-ONLY expiry must say which instant it means: pass a zoned datetime, or add `convention: 'us-equity-close'` to opt into the 16:00 ET close explicitly. The silent US-equity default belongs to `usEquityCall`/`usEquityPut`, whose NAMES carry it — European index products settle at different instants (AM auctions, European closes), so guessing here would be silent economics (Law 6). - european().return.adjusted?: boolean; default: not declared - european().return.currency?: string; default: not declared - european().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - european().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - european().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - european().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - european().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - european().return.multiplier?: number; default: not declared - european().return.occSymbol?: string; default: not declared - european().return.root?: string; default: not declared - european().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - european().return.strike: number; default: not declared - european().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - european().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - european().return.underlying: string; default: not declared - european(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { convention?: 'us-equity-close'; type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - european(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - european(input).currency?: string; default: not declared - european(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - european(input).multiplier?: number; default: not declared - european(input).root?: string; default: not declared - european(input).strike: number; default: not declared - european(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - european(input).underlying: string; default: not declared - forwardStart: { readonly price: (input: import('@insiderfinance/totalfinance/options').ForwardStartInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').ForwardStartInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - forwardStart.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').ForwardStartInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Two-step-GBM Monte-Carlo forward-start price (converges to the analytic). - forwardStart.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - forwardStart.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - forwardStart.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - forwardStart.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - forwardStart.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - forwardStart.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').ForwardStartInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - forwardStart.monteCarloPrice(input).dividendYield?: number; default: not declared - forwardStart.monteCarloPrice(input).resetTime: number; default: not declared — Reset time `t₁` (years) at which the strike is fixed; must be in `(0, t)`. - forwardStart.monteCarloPrice(input).riskFreeRate: number; default: not declared - forwardStart.monteCarloPrice(input).spot: number; default: not declared - forwardStart.monteCarloPrice(input).strikeMultiplier?: number; default: not declared — Strike multiplier α: the strike is set to `α·S(t₁)` at the reset (α=1 ⇒ at-the-money-at-reset). Default 1. - forwardStart.monteCarloPrice(input).timeToExpiryYears: number; default: not declared — Expiry `T` (years). - forwardStart.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - forwardStart.monteCarloPrice(input).volatility: number; default: not declared - forwardStart.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - forwardStart.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - forwardStart.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - forwardStart.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - forwardStart.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - forwardStart.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - forwardStart.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - forwardStart.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - forwardStart.price: (input: import('@insiderfinance/totalfinance/options').ForwardStartInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Closed-form forward-start price (Rubinstein 1991); the value scales with today's spot. - forwardStart.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - forwardStart.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - forwardStart.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - forwardStart.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - forwardStart.price(input): import('@insiderfinance/totalfinance/options').ForwardStartInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - forwardStart.price(input).dividendYield?: number; default: not declared - forwardStart.price(input).resetTime: number; default: not declared — Reset time `t₁` (years) at which the strike is fixed; must be in `(0, t)`. - forwardStart.price(input).riskFreeRate: number; default: not declared - forwardStart.price(input).spot: number; default: not declared - forwardStart.price(input).strikeMultiplier?: number; default: not declared — Strike multiplier α: the strike is set to `α·S(t₁)` at the reset (α=1 ⇒ at-the-money-at-reset). Default 1. - forwardStart.price(input).timeToExpiryYears: number; default: not declared — Expiry `T` (years). - forwardStart.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - forwardStart.price(input).volatility: number; default: not declared - gbm: { readonly path: (input: import('@insiderfinance/totalfinance/options').GbmPathInput) => Float64Array; readonly terminal: (input: import('@insiderfinance/totalfinance/options').GbmTerminalInput) => number; }; default: not declared — The geometric-Brownian-motion namespace — the grouped surface over the flat `gbm*` kernels. `gbm.path` / `gbm.terminal` are the same functions; prefer the namespace over the deprecated flats. - gbm.path: (input: import('@insiderfinance/totalfinance/options').GbmPathInput) => Float64Array; default: not declared - gbm.path(input): import('@insiderfinance/totalfinance/options').GbmPathInput; default: not declared - gbm.path(input).dividendYield: number; default: not declared - gbm.path(input).riskFreeRate: number; default: not declared - gbm.path(input).shocks: number[]; default: not declared - gbm.path(input).spot: number; default: not declared - gbm.path(input).timeToExpiryYears: number; default: not declared - gbm.path(input).volatility: number; default: not declared - gbm.terminal: (input: import('@insiderfinance/totalfinance/options').GbmTerminalInput) => number; default: not declared - gbm.terminal(input): import('@insiderfinance/totalfinance/options').GbmTerminalInput; default: not declared - gbm.terminal(input).dividendYield: number; default: not declared - gbm.terminal(input).riskFreeRate: number; default: not declared - gbm.terminal(input).shock: number; default: not declared - gbm.terminal(input).spot: number; default: not declared - gbm.terminal(input).timeToExpiryYears: number; default: not declared - gbm.terminal(input).volatility: number; default: not declared - heston: { readonly price: (request: import('@insiderfinance/totalfinance/options/heston').HestonPriceRequest) => import('@insiderfinance/totalfinance/options').PriceResult; readonly monteCarloPrice: (request: import('@insiderfinance/totalfinance/options/heston').HestonPriceMonteCarloRequest) => import('@insiderfinance/totalfinance/options').HestonMonteCarloResult; readonly cosineExpansion: (input: import('@insiderfinance/totalfinance/options/heston').HestonCosineExpansionPriceInput) => number; readonly impliedVolatility: (request: import('@insiderfinance/totalfinance/options/heston').HestonPriceRequest) => import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityResult; readonly monteCarloEstimate: (input: import('@insiderfinance/totalfinance/options/heston').HestonMonteCarloEstimateInput) => import('@insiderfinance/totalfinance/options').MonteCarloEstimate; }; default: not declared — The Heston model namespace — the grouped, discoverable surface over the flat `heston*` functions. `heston.price` / `heston.monteCarloPrice` / `heston.cosineExpansion` / `heston.impliedVolatility` / `heston.monteCarloEstimate` are the same functions; prefer the namespace over the deprecated flat exports. - heston.cosineExpansion: (input: import('@insiderfinance/totalfinance/options/heston').HestonCosineExpansionPriceInput) => number; default: not declared - heston.cosineExpansion(input): import('@insiderfinance/totalfinance/options/heston').HestonCosineExpansionPriceInput; default: not declared - heston.cosineExpansion(input).dividendYield: number; default: not declared - heston.cosineExpansion(input).parameters: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - heston.cosineExpansion(input).riskFreeRate: number; default: not declared - heston.cosineExpansion(input).spot: number; default: not declared - heston.cosineExpansion(input).strike: number; default: not declared - heston.cosineExpansion(input).terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192). - heston.cosineExpansion(input).timeToExpiryYears: number; default: not declared - heston.cosineExpansion(input).truncation?: number; default: not declared - heston.cosineExpansion(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - heston.impliedVolatility: (request: import('@insiderfinance/totalfinance/options/heston').HestonPriceRequest) => import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityResult; default: not declared - heston.impliedVolatility().return.converged: boolean; default: not declared - heston.impliedVolatility().return.error?: number; default: not declared - heston.impliedVolatility().return.iterations: number; default: not declared - heston.impliedVolatility().return.message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - heston.impliedVolatility().return.reason?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityReason; default: not declared - heston.impliedVolatility().return.value: number; default: not declared - heston.impliedVolatility(request): import('@insiderfinance/totalfinance/options/heston').HestonPriceRequest; default: not declared - heston.impliedVolatility(request).input: import('@insiderfinance/totalfinance/options').HestonInput; default: not declared - heston.impliedVolatility(request).options?: import('@insiderfinance/totalfinance/options').HestonCosineExpansionOptions; default: not declared - heston.impliedVolatility(request).parameters: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - heston.impliedVolatility(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - heston.monteCarloEstimate: (input: import('@insiderfinance/totalfinance/options/heston').HestonMonteCarloEstimateInput) => import('@insiderfinance/totalfinance/options').MonteCarloEstimate; default: not declared - heston.monteCarloEstimate().return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - heston.monteCarloEstimate().return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - heston.monteCarloEstimate().return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - heston.monteCarloEstimate().return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - heston.monteCarloEstimate().return.seed: number; default: not declared — The seed, echoed for reproducibility. - heston.monteCarloEstimate().return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - heston.monteCarloEstimate().return.value: number; default: not declared - heston.monteCarloEstimate().return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - heston.monteCarloEstimate().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). - heston.monteCarloEstimate(input): import('@insiderfinance/totalfinance/options/heston').HestonMonteCarloEstimateInput; default: not declared - heston.monteCarloEstimate(input).dividendYield: number; default: not declared - heston.monteCarloEstimate(input).options: import('@insiderfinance/totalfinance/options').HestonMonteCarloOptions; default: not declared - heston.monteCarloEstimate(input).parameters: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - heston.monteCarloEstimate(input).riskFreeRate: number; default: not declared - heston.monteCarloEstimate(input).spot: number; default: not declared - heston.monteCarloEstimate(input).strike: number; default: not declared - heston.monteCarloEstimate(input).timeToExpiryYears: number; default: not declared - heston.monteCarloEstimate(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - heston.monteCarloPrice: (request: import('@insiderfinance/totalfinance/options/heston').HestonPriceMonteCarloRequest) => import('@insiderfinance/totalfinance/options').HestonMonteCarloResult; default: not declared - heston.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - heston.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - heston.monteCarloPrice().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - heston.monteCarloPrice().return.greeks.charm: number; default: not declared - heston.monteCarloPrice().return.greeks.color: number; default: not declared - heston.monteCarloPrice().return.greeks.delta: number; default: not declared - heston.monteCarloPrice().return.greeks.gamma: number; default: not declared - heston.monteCarloPrice().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - heston.monteCarloPrice().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - heston.monteCarloPrice().return.greeks.rho: number; default: not declared - heston.monteCarloPrice().return.greeks.speed: number; default: not declared - heston.monteCarloPrice().return.greeks.theta: number; default: not declared - heston.monteCarloPrice().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - heston.monteCarloPrice().return.greeks.vanna: number; default: not declared - heston.monteCarloPrice().return.greeks.vega: number; default: not declared - heston.monteCarloPrice().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - heston.monteCarloPrice().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - heston.monteCarloPrice().return.greeks.vomma: number; default: not declared - heston.monteCarloPrice().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - heston.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - heston.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - heston.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - heston.monteCarloPrice(request): import('@insiderfinance/totalfinance/options/heston').HestonPriceMonteCarloRequest; default: not declared - heston.monteCarloPrice(request).input: import('@insiderfinance/totalfinance/options').HestonInput; default: not declared - heston.monteCarloPrice(request).options: import('@insiderfinance/totalfinance/options').HestonMonteCarloOptions; default: not declared - heston.monteCarloPrice(request).parameters: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - heston.monteCarloPrice(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - heston.price: (request: import('@insiderfinance/totalfinance/options/heston').HestonPriceRequest) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - heston.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - heston.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - heston.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - heston.price().return.greeks.charm: number; default: not declared - heston.price().return.greeks.color: number; default: not declared - heston.price().return.greeks.delta: number; default: not declared - heston.price().return.greeks.gamma: number; default: not declared - heston.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - heston.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - heston.price().return.greeks.rho: number; default: not declared - heston.price().return.greeks.speed: number; default: not declared - heston.price().return.greeks.theta: number; default: not declared - heston.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - heston.price().return.greeks.vanna: number; default: not declared - heston.price().return.greeks.vega: number; default: not declared - heston.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - heston.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - heston.price().return.greeks.vomma: number; default: not declared - heston.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - heston.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - heston.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - heston.price(request): import('@insiderfinance/totalfinance/options/heston').HestonPriceRequest; default: not declared - heston.price(request).input: import('@insiderfinance/totalfinance/options').HestonInput; default: not declared - heston.price(request).options?: import('@insiderfinance/totalfinance/options').HestonCosineExpansionOptions; default: not declared - heston.price(request).parameters: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - heston.price(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - impliedBorrow: (input: import('@insiderfinance/totalfinance/options/parity').ImpliedBorrowInput) => import('@insiderfinance/totalfinance/options').ParityResult; default: not declared — Implied borrow / financing spread: the regression-implied financing rate `r*` (from the parity slope) minus the supplied `rate`. Zero when the chain was priced at exactly `rate`. - impliedBorrow().return.assumptions: import('@insiderfinance/totalfinance/options').ParityAssumptions; default: not declared - impliedBorrow().return.diagnostics: import('@insiderfinance/totalfinance/options').ParityDiagnostics; default: not declared - impliedBorrow().return.value: number; default: not declared - impliedBorrow(input): import('@insiderfinance/totalfinance/options/parity').ImpliedBorrowInput; default: not declared - impliedBorrow(input).expiry: string; default: not declared - impliedBorrow(input).options: import('@insiderfinance/totalfinance/options').ImpliedBorrowOptions; default: not declared - impliedBorrow(input).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - impliedDividendYield: (input: import('@insiderfinance/totalfinance/options/parity').ImpliedDividendYieldInput) => import('@insiderfinance/totalfinance/options').ParityResult; default: not declared — Implied continuous dividend yield `q` from `F = S·e^((r−q)T)` ⇒ `q = r − ln(F/S)/T`, using the regression forward and the supplied `spot`/`rate`. - impliedDividendYield().return.assumptions: import('@insiderfinance/totalfinance/options').ParityAssumptions; default: not declared - impliedDividendYield().return.diagnostics: import('@insiderfinance/totalfinance/options').ParityDiagnostics; default: not declared - impliedDividendYield().return.value: number; default: not declared - impliedDividendYield(input): import('@insiderfinance/totalfinance/options/parity').ImpliedDividendYieldInput; default: not declared - impliedDividendYield(input).expiry: string; default: not declared - impliedDividendYield(input).options: import('@insiderfinance/totalfinance/options').ImpliedDividendYieldOptions; default: not declared - impliedDividendYield(input).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - impliedForward: (input: import('@insiderfinance/totalfinance/options/parity').ImpliedForwardInput) => import('@insiderfinance/totalfinance/options').ParityResult; default: not declared — Implied forward `F` from put-call parity across one expiry's chain. Regresses `C(K) − P(K)` on `K`; from `slope = −e^(−rT)` and `intercept = e^(−rT)·F`, `F = −intercept / slope`. The supplied `rate` is echoed and compared against the regression-implied financing rate (reported in `diagnostics.impliedRate`); it does not bias `F`. - impliedForward().return.assumptions: import('@insiderfinance/totalfinance/options').ParityAssumptions; default: not declared - impliedForward().return.diagnostics: import('@insiderfinance/totalfinance/options').ParityDiagnostics; default: not declared - impliedForward().return.value: number; default: not declared - impliedForward(input): import('@insiderfinance/totalfinance/options/parity').ImpliedForwardInput; default: not declared - impliedForward(input).expiry: string; default: not declared - impliedForward(input).options: import('@insiderfinance/totalfinance/options').ImpliedForwardOptions; default: not declared - impliedForward(input).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - impliedVolatility: (input: import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput, options?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptions) => import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult; default: not declared — Solve BSM implied volatility with the chosen method, reporting rich diagnostics — quantitative failure (price outside no-arbitrage bounds, no convergence) reports `converged: false` with the reason, never a fabricated vol. - impliedVolatility().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - impliedVolatility().return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - impliedVolatility().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatility().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatility(input): import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput; default: not declared - impliedVolatility(input).dividendYield?: number; default: not declared - impliedVolatility(input).price: number; default: not declared — Observed option price to invert. - impliedVolatility(input).riskFreeRate: number; default: not declared - impliedVolatility(input).spot: number; default: not declared - impliedVolatility(input).strike: number; default: not declared - impliedVolatility(input).timeToExpiryYears: number; default: not declared - impliedVolatility(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - impliedVolatility(options)?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptions; default: not declared - impliedVolatility(options).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - impliedVolatility(options).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - impliedVolatility(options).method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared - impliedVolatilityMany: (rows: import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput[], options?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptions) => ({ results: import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult[]; assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ rows: number; }>; diagnostics: { engine: string; method: string; converged: boolean; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; }); default: not declared — Batch implied volatility with per-row diagnostics on `results`. A bad row yields a non-converged row result rather than aborting the chain — unless `failFast` is set. - impliedVolatilityMany().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ rows: number; }>; default: not declared — Applied conventions, echoed (per-row `timeToExpiryYears` rides each row's own assumptions). - impliedVolatilityMany().return.diagnostics: { engine: string; method: string; converged: boolean; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Batch diagnostics: `converged` is true iff EVERY row converged. - impliedVolatilityMany().return.diagnostics.converged: boolean; default: not declared - impliedVolatilityMany().return.diagnostics.engine: string; default: not declared - impliedVolatilityMany().return.diagnostics.method: string; default: not declared - impliedVolatilityMany().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - impliedVolatilityMany().return.results: import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult[]; default: not declared — One solve envelope per input row, in input order. - impliedVolatilityMany(options)?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptions; default: not declared - impliedVolatilityMany(options).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - impliedVolatilityMany(options).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - impliedVolatilityMany(options).method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared - impliedVolatilityMany(rows): import('@insiderfinance/totalfinance/options').BlackScholesImpliedVolatilityInput[]; default: not declared - impliedVolatilityOption: (input: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptionInput) => import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult; default: not declared - impliedVolatilityOption().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - impliedVolatilityOption().return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - impliedVolatilityOption().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatilityOption().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatilityOption(input): import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptionInput; default: not declared - impliedVolatilityOption(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - impliedVolatilityOption(input).engine?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Engine to invert numerically. An American contract always inverts an engine (default `engines.bjerksundStensland2002()`); a European contract inverts closed-form Black–Scholes–Merton unless an engine is named here, in which case THAT engine is inverted — e.g. a lattice for discrete dividends, or a custom model. `method`/`fallback`/`failFast` belong to the closed-form route and are refused alongside an engine. - impliedVolatilityOption(input).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - impliedVolatilityOption(input).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - impliedVolatilityOption(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - impliedVolatilityOption(input).method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared - inverseOption: { readonly price: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly greeks: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/core').Computed; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').InverseOptionMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; readonly digital: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; cash?: number; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly barrier: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; barrier: number; }) => import('@insiderfinance/totalfinance/options').ExoticResult; }; default: not declared - inverseOption.barrier: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; barrier: number; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — The **coin premium** of a coin-settled (inverse) **barrier** (continuous monitoring, zero rebate). By the same universal identity, the coin premium is the vanilla barrier's USD price divided by spot. `value·spot` recovers the USD premium. See `docs/specs/inverse-option.md`. - inverseOption.barrier().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseOption.barrier().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseOption.barrier().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseOption.barrier().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseOption.barrier(input): import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; barrierType: import('@insiderfinance/totalfinance/options').BarrierType; barrier: number; }; default: not declared - inverseOption.barrier(input).barrier: number; default: not declared - inverseOption.barrier(input).barrierType: import('@insiderfinance/totalfinance/options').BarrierType; default: not declared - inverseOption.barrier(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - inverseOption.barrier(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - inverseOption.barrier(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - inverseOption.barrier(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - inverseOption.barrier(input).timeToExpiryYears: number; default: not declared - inverseOption.barrier(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - inverseOption.barrier(input).volatility: number; default: not declared — Volatility. - inverseOption.digital: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; cash?: number; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — The **coin premium** of a coin-settled (inverse) **binary**. Every coin-settled exotic obeys the same universal identity as the vanilla: a coin payoff `H(S_T)/S_T` is worth `H(S_T)` USD at expiry (1 coin = `S_T` USD then), so its USD price is the vanilla's and its coin premium is exactly `vanillaUsd/spot`. A `cash-or-nothing` therefore settles its `cash` USD-equivalent in the coin, an `asset-or-nothing` settles 1 coin if in-the-money. `value·spot` recovers the USD premium. See `docs/specs/inverse-option.md`. - inverseOption.digital().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseOption.digital().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseOption.digital().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseOption.digital().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseOption.digital(input): import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').DigitalKind; cash?: number; }; default: not declared - inverseOption.digital(input).cash?: number; default: not declared - inverseOption.digital(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - inverseOption.digital(input).kind: import('@insiderfinance/totalfinance/options').DigitalKind; default: not declared - inverseOption.digital(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - inverseOption.digital(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - inverseOption.digital(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - inverseOption.digital(input).timeToExpiryYears: number; default: not declared - inverseOption.digital(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - inverseOption.digital(input).volatility: number; default: not declared — Volatility. - inverseOption.greeks: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — The inverse option's risk in **both** denominations. The `coin` greeks are the exact derivatives of the coin premium `V_usd/S`: delta and gamma carry the numeraire corrections (`Δ_coin = Δ_usd/S − V_usd/S²`, `Γ_coin = Γ_usd/S − 2Δ_usd/S² + 2V_usd/S³`), while vega/theta/rho scale by `1/S`. The `usd` greeks equal the vanilla BSM greeks. The `−V_coin/S` delta term is the embedded short-coin from the coin-denominated premium — an inverse option is NOT hedged at its Black–Scholes delta. - inverseOption.greeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseOption.greeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseOption.greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseOption.greeks().return.value: import('@insiderfinance/totalfinance/options').InverseGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseOption.greeks(input): import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - inverseOption.greeks(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - inverseOption.greeks(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - inverseOption.greeks(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - inverseOption.greeks(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - inverseOption.greeks(input).timeToExpiryYears: number; default: not declared - inverseOption.greeks(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - inverseOption.greeks(input).volatility: number; default: not declared — Volatility. - inverseOption.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').InverseOptionMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — One-factor **coin-numeraire** Monte-Carlo: under the coin money-market numeraire the spot drifts at the self-quanto rate `r − q + σ²`, and the coin premium is `E[e^{−qT}·(±(S_T−K))⁺/S_T]`. Converges to the closed-form coin premium, corroborating the `V_usd/S` identity from the other measure. - inverseOption.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseOption.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseOption.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - inverseOption.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseOption.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseOption.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - inverseOption.monteCarloPrice(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - inverseOption.monteCarloPrice(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - inverseOption.monteCarloPrice(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - inverseOption.monteCarloPrice(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - inverseOption.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - inverseOption.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - inverseOption.monteCarloPrice(input).volatility: number; default: not declared — Volatility. - inverseOption.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - inverseOption.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - inverseOption.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - inverseOption.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - inverseOption.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - inverseOption.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - inverseOption.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - inverseOption.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - inverseOption.price: (input: import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — The **coin (base-currency) premium** of a Deribit-style inverse option, settling `(±(S_T−K))⁺/S_T` in the coin. The USD payoff is a vanilla's, so the coin premium is exactly `blackScholesPrice/spot`. `value·spot` recovers the USD premium. `rate` is the USD/quote rate; `coinYield` the coin lending/staking yield. See `docs/specs/inverse-option.md`. - inverseOption.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - inverseOption.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - inverseOption.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inverseOption.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inverseOption.price(input): import('@insiderfinance/totalfinance/options').InverseOptionInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - inverseOption.price(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - inverseOption.price(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - inverseOption.price(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - inverseOption.price(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - inverseOption.price(input).timeToExpiryYears: number; default: not declared - inverseOption.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - inverseOption.price(input).volatility: number; default: not declared — Volatility. - localVolatility: { readonly fromImplied: (input: import('@insiderfinance/totalfinance/options/local-volatility').DupireLocalVolatilityInput) => import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; readonly grid: (localVolatility: import('@insiderfinance/totalfinance/options').LocalVolatilityFunction, specification: import('@insiderfinance/totalfinance/options').LocalVolatilityGridSpecification) => import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; readonly monteCarloPrice: (request: import('@insiderfinance/totalfinance/options/local-volatility').LocalVolatilityPriceMonteCarloRequest) => import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloResult; readonly monteCarloEstimate: (input: import('@insiderfinance/totalfinance/options/local-volatility').LocalVolatilityMonteCarloEstimateInput) => import('@insiderfinance/totalfinance/options').MonteCarloEstimate; }; default: not declared — The local-volatility namespace — the grouped, discoverable surface over the flat local-volatility functions. `localVolatility.fromImplied` / `localVolatility.grid` / `localVolatility.monteCarloPrice` / `localVolatility.monteCarloEstimate` are the same functions; prefer the namespace over the deprecated flat exports. - localVolatility.fromImplied: (input: import('@insiderfinance/totalfinance/options/local-volatility').DupireLocalVolatilityInput) => import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared - localVolatility.fromImplied(input): import('@insiderfinance/totalfinance/options/local-volatility').DupireLocalVolatilityInput; default: not declared - localVolatility.fromImplied(input).impliedVolatility: import('@insiderfinance/totalfinance/options').ImpliedVolatilityFunction; default: not declared - localVolatility.fromImplied(input).market: import('@insiderfinance/totalfinance/options').LocalVolatilityMarket; default: not declared - localVolatility.fromImplied(input).options?: import('@insiderfinance/totalfinance/options').DupireOptions; default: not declared - localVolatility.grid: (localVolatility: import('@insiderfinance/totalfinance/options').LocalVolatilityFunction, specification: import('@insiderfinance/totalfinance/options').LocalVolatilityGridSpecification) => import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared - localVolatility.grid(localVolatility): import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared - localVolatility.grid(specification): import('@insiderfinance/totalfinance/options').LocalVolatilityGridSpecification; default: not declared - localVolatility.grid(specification).levels: number[]; default: not declared — Underlying levels, ascending (e.g. 0.4·S₀ … 2.5·S₀). - localVolatility.grid(specification).times: number[]; default: not declared — Times in years, ascending (e.g. up to the longest expiry priced). - localVolatility.monteCarloEstimate: (input: import('@insiderfinance/totalfinance/options/local-volatility').LocalVolatilityMonteCarloEstimateInput) => import('@insiderfinance/totalfinance/options').MonteCarloEstimate; default: not declared - localVolatility.monteCarloEstimate().return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - localVolatility.monteCarloEstimate().return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - localVolatility.monteCarloEstimate().return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - localVolatility.monteCarloEstimate().return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - localVolatility.monteCarloEstimate().return.seed: number; default: not declared — The seed, echoed for reproducibility. - localVolatility.monteCarloEstimate().return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - localVolatility.monteCarloEstimate().return.value: number; default: not declared - localVolatility.monteCarloEstimate().return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - localVolatility.monteCarloEstimate().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). - localVolatility.monteCarloEstimate(input): import('@insiderfinance/totalfinance/options/local-volatility').LocalVolatilityMonteCarloEstimateInput; default: not declared - localVolatility.monteCarloEstimate(input).dividendYield: number; default: not declared - localVolatility.monteCarloEstimate(input).localVolatility: import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared - localVolatility.monteCarloEstimate(input).options: import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloOptions; default: not declared - localVolatility.monteCarloEstimate(input).riskFreeRate: number; default: not declared - localVolatility.monteCarloEstimate(input).spot: number; default: not declared - localVolatility.monteCarloEstimate(input).strike: number; default: not declared - localVolatility.monteCarloEstimate(input).timeToExpiryYears: number; default: not declared - localVolatility.monteCarloEstimate(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - localVolatility.monteCarloPrice: (request: import('@insiderfinance/totalfinance/options/local-volatility').LocalVolatilityPriceMonteCarloRequest) => import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloResult; default: not declared - localVolatility.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - localVolatility.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - localVolatility.monteCarloPrice().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - localVolatility.monteCarloPrice().return.greeks.charm: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.color: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.delta: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.gamma: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - localVolatility.monteCarloPrice().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - localVolatility.monteCarloPrice().return.greeks.rho: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.speed: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.theta: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - localVolatility.monteCarloPrice().return.greeks.vanna: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.vega: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - localVolatility.monteCarloPrice().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - localVolatility.monteCarloPrice().return.greeks.vomma: number; default: not declared - localVolatility.monteCarloPrice().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - localVolatility.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - localVolatility.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - localVolatility.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - localVolatility.monteCarloPrice(request): import('@insiderfinance/totalfinance/options/local-volatility').LocalVolatilityPriceMonteCarloRequest; default: not declared - localVolatility.monteCarloPrice(request).input: import('@insiderfinance/totalfinance/options').LocalVolatilityInput; default: not declared - localVolatility.monteCarloPrice(request).localVolatility: import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared - localVolatility.monteCarloPrice(request).options: import('@insiderfinance/totalfinance/options').LocalVolatilityMonteCarloOptions; default: not declared - localVolatility.monteCarloPrice(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - lookback: { readonly price: (input: import('@insiderfinance/totalfinance/options').LookbackInput & { type: import('@insiderfinance/totalfinance/core').OptionType; strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').LookbackInput & { type: import('@insiderfinance/totalfinance/core').OptionType; strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; }, options: import('@insiderfinance/totalfinance/options').LookbackMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - lookback.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').LookbackInput & { type: import('@insiderfinance/totalfinance/core').OptionType; strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; }, options: import('@insiderfinance/totalfinance/options').LookbackMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo lookback price with the Broadie–Glasserman–Kou discrete-monitoring correction. - lookback.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - lookback.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - lookback.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - lookback.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - lookback.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - lookback.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').LookbackInput & { type: import('@insiderfinance/totalfinance/core').OptionType; strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; }; default: not declared - lookback.monteCarloPrice(input).dividendYield?: number; default: not declared - lookback.monteCarloPrice(input).riskFreeRate: number; default: not declared - lookback.monteCarloPrice(input).runningMax?: number; default: not declared — Running maximum observed so far (default = spot). - lookback.monteCarloPrice(input).runningMin?: number; default: not declared — Running minimum observed so far (default = spot, a newly-issued option). - lookback.monteCarloPrice(input).spot: number; default: not declared - lookback.monteCarloPrice(input).strike?: number; default: not declared — Strike (fixed-strike lookbacks only). - lookback.monteCarloPrice(input).strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; default: not declared - lookback.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - lookback.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - lookback.monteCarloPrice(input).volatility: number; default: not declared - lookback.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').LookbackMonteCarloOptions; default: not declared - lookback.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - lookback.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - lookback.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - lookback.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - lookback.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - lookback.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - lookback.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - lookback.monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 150). - lookback.price: (input: import('@insiderfinance/totalfinance/options').LookbackInput & { type: import('@insiderfinance/totalfinance/core').OptionType; strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Continuous-monitoring lookback price (Conze–Viswanathan / Goldman–Sosin–Gatto). - lookback.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - lookback.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - lookback.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - lookback.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - lookback.price(input): import('@insiderfinance/totalfinance/options').LookbackInput & { type: import('@insiderfinance/totalfinance/core').OptionType; strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; }; default: not declared - lookback.price(input).dividendYield?: number; default: not declared - lookback.price(input).riskFreeRate: number; default: not declared - lookback.price(input).runningMax?: number; default: not declared — Running maximum observed so far (default = spot). - lookback.price(input).runningMin?: number; default: not declared — Running minimum observed so far (default = spot, a newly-issued option). - lookback.price(input).spot: number; default: not declared - lookback.price(input).strike?: number; default: not declared — Strike (fixed-strike lookbacks only). - lookback.price(input).strikeType: import('@insiderfinance/totalfinance/options').LookbackStrike; default: not declared - lookback.price(input).timeToExpiryYears: number; default: not declared - lookback.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - lookback.price(input).volatility: number; default: not declared - market: (input: import('@insiderfinance/totalfinance/options').OptionMarket) => import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - market().return.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market().return.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market().return.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market().return.forward?: number; default: not declared - market().return.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market().return.riskFreeRate: number; default: not declared - market().return.spot: number; default: not declared - market().return.volatility?: number; default: not declared - market(input): import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - market(input).asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market(input).dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market(input).dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market(input).forward?: number; default: not declared - market(input).price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market(input).riskFreeRate: number; default: not declared - market(input).spot: number; default: not declared - market(input).volatility?: number; default: not declared - napoleon: { readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').NapoleonInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - napoleon.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').NapoleonInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Napoleon option: pays the coupon plus the **single worst** period return, `max(floor, C + minᵢ rᵢ)`. The investor is SHORT the volatility of the minimum return — a higher `volatility` LOWERS the value. No clean closed form (the minimum of `n` dependent lognormals), so Monte-Carlo only. See `docs/specs/napoleon-reverse-cliquet.md`. - napoleon.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - napoleon.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - napoleon.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - napoleon.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - napoleon.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - napoleon.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').NapoleonInput; default: not declared - napoleon.monteCarloPrice(input).coupon: number; default: not declared — The fixed coupon degraded by the period returns. - napoleon.monteCarloPrice(input).dividendYield?: number; default: not declared - napoleon.monteCarloPrice(input).globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - napoleon.monteCarloPrice(input).notional?: number; default: not declared — Notional multiplier. Default 1. - napoleon.monteCarloPrice(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - napoleon.monteCarloPrice(input).riskFreeRate: number; default: not declared - napoleon.monteCarloPrice(input).spot: number; default: not declared - napoleon.monteCarloPrice(input).volatility: number; default: not declared - napoleon.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - napoleon.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - napoleon.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - napoleon.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - napoleon.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - napoleon.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - napoleon.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - napoleon.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - option: { readonly call: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; readonly compareEngines: (input: import('@insiderfinance/totalfinance/options').CompareEnginesInput) => import('@insiderfinance/totalfinance/options').EngineComparison; readonly european: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { type: import('@insiderfinance/totalfinance/core').OptionType; convention?: 'us-equity-close'; }) => import('@insiderfinance/totalfinance/core').OptionContract; readonly impliedVolatility: (input: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptionInput) => import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult; readonly price: (input: import('@insiderfinance/totalfinance/options').PriceOptionInput) => import('@insiderfinance/totalfinance/options').PriceResult; readonly put: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; readonly usEquityCall: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; readonly usEquityOption: (input: import('@insiderfinance/totalfinance/options').UsEquityOptionInput) => import('@insiderfinance/totalfinance/core').OptionContract; readonly usEquityPut: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; }; default: not declared — The `option` namespace combines contract builders with pro pricing: - `option.call(...)` / `option.put(...)` build contracts, - `option.price({ contract, market, engine? })` prices them, - `option.impliedVolatility({ contract, market, engine? })` inverts a price, - `option.compareEngines({ contract, market, options? })` benchmarks engines against each other. - option.call: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.call().return.adjusted?: boolean; default: not declared - option.call().return.currency?: string; default: not declared - option.call().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - option.call().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - option.call().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - option.call().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - option.call().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - option.call().return.multiplier?: number; default: not declared - option.call().return.occSymbol?: string; default: not declared - option.call().return.root?: string; default: not declared - option.call().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - option.call().return.strike: number; default: not declared - option.call().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - option.call().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.call().return.underlying: string; default: not declared - option.call(input): import('@insiderfinance/totalfinance/options').OptionBuilderInput; default: not declared - option.call(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - option.call(input).currency?: string; default: not declared - option.call(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - option.call(input).multiplier?: number; default: not declared - option.call(input).root?: string; default: not declared - option.call(input).strike: number; default: not declared - option.call(input).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - option.call(input).underlying: string; default: not declared - option.compareEngines: (input: import('@insiderfinance/totalfinance/options').CompareEnginesInput) => import('@insiderfinance/totalfinance/options').EngineComparison; default: not declared - option.compareEngines().return.assumptions: { conventionsVersion: string; engines: number; referenceEngine: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - option.compareEngines().return.assumptions.conventionsVersion: string; default: not declared - option.compareEngines().return.assumptions.engines: number; default: not declared - option.compareEngines().return.assumptions.referenceEngine: string; default: not declared - option.compareEngines().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present — engine failures are summarized here (details per row). - option.compareEngines().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - option.compareEngines().return.reference: { engine: string; value: number; }; default: not declared - option.compareEngines().return.reference.engine: string; default: not declared - option.compareEngines().return.reference.value: number; default: not declared - option.compareEngines().return.rows: import('@insiderfinance/totalfinance/options').EngineComparisonRow[]; default: not declared - option.compareEngines(input): import('@insiderfinance/totalfinance/options').CompareEnginesInput; default: not declared - option.compareEngines(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.compareEngines(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - option.compareEngines(input).options?: ({ engines?: import('@insiderfinance/totalfinance/options').OptionPricingEngine[]; reference?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; now?: () => number; }); default: not declared - option.compareEngines(input).options.engines?: import('@insiderfinance/totalfinance/options').OptionPricingEngine[]; default: not declared — Engines to compare. Defaults to the built-in panel that supports the contract. - option.compareEngines(input).options.now?: () => number; default: not declared — Optional monotonic clock (e.g. `() => performance.now()`). When supplied, each engine's wall-clock pricing time is measured into `timingMs`. Omitted by default so the function stays pure (no system-clock read) — timing is opt-in instrumentation the caller injects. - option.compareEngines(input).options.reference?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Convergence benchmark. Defaults to a 1001-step Leisen–Reimer lattice. - option.european: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { type: import('@insiderfinance/totalfinance/core').OptionType; convention?: 'us-equity-close'; }) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.european().return.adjusted?: boolean; default: not declared - option.european().return.currency?: string; default: not declared - option.european().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - option.european().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - option.european().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - option.european().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - option.european().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - option.european().return.multiplier?: number; default: not declared - option.european().return.occSymbol?: string; default: not declared - option.european().return.root?: string; default: not declared - option.european().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - option.european().return.strike: number; default: not declared - option.european().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - option.european().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.european().return.underlying: string; default: not declared - option.european(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput & { convention?: 'us-equity-close'; type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - option.european(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - option.european(input).currency?: string; default: not declared - option.european(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - option.european(input).multiplier?: number; default: not declared - option.european(input).root?: string; default: not declared - option.european(input).strike: number; default: not declared - option.european(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.european(input).underlying: string; default: not declared - option.impliedVolatility: (input: import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptionInput) => import('@insiderfinance/totalfinance/options').ImpliedVolatilitySolveResult; default: not declared - option.impliedVolatility().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - option.impliedVolatility().return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - option.impliedVolatility().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - option.impliedVolatility().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - option.impliedVolatility(input): import('@insiderfinance/totalfinance/options').ImpliedVolatilityOptionInput; default: not declared - option.impliedVolatility(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.impliedVolatility(input).engine?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Engine to invert numerically. An American contract always inverts an engine (default `engines.bjerksundStensland2002()`); a European contract inverts closed-form Black–Scholes–Merton unless an engine is named here, in which case THAT engine is inverted — e.g. a lattice for discrete dividends, or a custom model. `method`/`fallback`/`failFast` belong to the closed-form route and are refused alongside an engine. - option.impliedVolatility(input).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - option.impliedVolatility(input).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - option.impliedVolatility(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - option.impliedVolatility(input).method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared - option.price: (input: import('@insiderfinance/totalfinance/options').PriceOptionInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - option.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - option.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - option.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - option.price().return.greeks.charm: number; default: not declared - option.price().return.greeks.color: number; default: not declared - option.price().return.greeks.delta: number; default: not declared - option.price().return.greeks.gamma: number; default: not declared - option.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - option.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - option.price().return.greeks.rho: number; default: not declared - option.price().return.greeks.speed: number; default: not declared - option.price().return.greeks.theta: number; default: not declared - option.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - option.price().return.greeks.vanna: number; default: not declared - option.price().return.greeks.vega: number; default: not declared - option.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - option.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - option.price().return.greeks.vomma: number; default: not declared - option.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - option.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - option.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - option.price(input): import('@insiderfinance/totalfinance/options').PriceOptionInput; default: not declared - option.price(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.price(input).engine?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Engine override; defaults to {@link engines.auto} (European → BSM, American → lattice/approx). - option.price(input).extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - option.price(input).greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. - option.price(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared — Market snapshot. `asOf` is required on the market; the clock is never read. - option.put: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.put().return.adjusted?: boolean; default: not declared - option.put().return.currency?: string; default: not declared - option.put().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - option.put().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - option.put().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - option.put().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - option.put().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - option.put().return.multiplier?: number; default: not declared - option.put().return.occSymbol?: string; default: not declared - option.put().return.root?: string; default: not declared - option.put().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - option.put().return.strike: number; default: not declared - option.put().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - option.put().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.put().return.underlying: string; default: not declared - option.put(input): import('@insiderfinance/totalfinance/options').OptionBuilderInput; default: not declared - option.put(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - option.put(input).currency?: string; default: not declared - option.put(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - option.put(input).multiplier?: number; default: not declared - option.put(input).root?: string; default: not declared - option.put(input).strike: number; default: not declared - option.put(input).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - option.put(input).underlying: string; default: not declared - option.usEquityCall: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.usEquityCall().return.adjusted?: boolean; default: not declared - option.usEquityCall().return.currency?: string; default: not declared - option.usEquityCall().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - option.usEquityCall().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - option.usEquityCall().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - option.usEquityCall().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - option.usEquityCall().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - option.usEquityCall().return.multiplier?: number; default: not declared - option.usEquityCall().return.occSymbol?: string; default: not declared - option.usEquityCall().return.root?: string; default: not declared - option.usEquityCall().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - option.usEquityCall().return.strike: number; default: not declared - option.usEquityCall().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - option.usEquityCall().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.usEquityCall().return.underlying: string; default: not declared - option.usEquityCall(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput; default: not declared - option.usEquityCall(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - option.usEquityCall(input).currency?: string; default: not declared - option.usEquityCall(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - option.usEquityCall(input).multiplier?: number; default: not declared - option.usEquityCall(input).root?: string; default: not declared - option.usEquityCall(input).strike: number; default: not declared - option.usEquityCall(input).underlying: string; default: not declared - option.usEquityOption: (input: import('@insiderfinance/totalfinance/options').UsEquityOptionInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.usEquityOption().return.adjusted?: boolean; default: not declared - option.usEquityOption().return.currency?: string; default: not declared - option.usEquityOption().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - option.usEquityOption().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - option.usEquityOption().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - option.usEquityOption().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - option.usEquityOption().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - option.usEquityOption().return.multiplier?: number; default: not declared - option.usEquityOption().return.occSymbol?: string; default: not declared - option.usEquityOption().return.root?: string; default: not declared - option.usEquityOption().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - option.usEquityOption().return.strike: number; default: not declared - option.usEquityOption().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - option.usEquityOption().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.usEquityOption().return.underlying: string; default: not declared - option.usEquityOption(input): import('@insiderfinance/totalfinance/options').UsEquityOptionInput; default: not declared - option.usEquityOption(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - option.usEquityOption(input).currency?: string; default: not declared - option.usEquityOption(input).expiry?: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - option.usEquityOption(input).multiplier?: number; default: not declared - option.usEquityOption(input).occSymbol?: string; default: not declared — A compact OCC symbol (`AAPL260918C00200000`); its root, expiry, type and strike are the contract. - option.usEquityOption(input).root?: string; default: not declared - option.usEquityOption(input).strike?: number; default: not declared - option.usEquityOption(input).type?: import('@insiderfinance/totalfinance/core').OptionType; default: not declared — `'call' | 'put'` — required unless `occSymbol` names it. - option.usEquityOption(input).underlying?: string; default: not declared - option.usEquityPut: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - option.usEquityPut().return.adjusted?: boolean; default: not declared - option.usEquityPut().return.currency?: string; default: not declared - option.usEquityPut().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - option.usEquityPut().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - option.usEquityPut().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - option.usEquityPut().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - option.usEquityPut().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - option.usEquityPut().return.multiplier?: number; default: not declared - option.usEquityPut().return.occSymbol?: string; default: not declared - option.usEquityPut().return.root?: string; default: not declared - option.usEquityPut().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - option.usEquityPut().return.strike: number; default: not declared - option.usEquityPut().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - option.usEquityPut().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - option.usEquityPut().return.underlying: string; default: not declared - option.usEquityPut(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput; default: not declared - option.usEquityPut(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - option.usEquityPut(input).currency?: string; default: not declared - option.usEquityPut(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - option.usEquityPut(input).multiplier?: number; default: not declared - option.usEquityPut(input).root?: string; default: not declared - option.usEquityPut(input).strike: number; default: not declared - option.usEquityPut(input).underlying: string; default: not declared - optionChainHealth: (input: import('@insiderfinance/totalfinance/options').OptionChainHealthInput) => import('@insiderfinance/totalfinance/options').OptionChainHealthReport; default: not declared — Consolidated chain-health report. Structural malformations throw indexed InputError; absent prices/timestamps, empty chains and unavailable inverses are valid reports, never fake IVs. Omit config.model for quote health and coverage only: market needs just underlying and asOf, with no invented spot/rate/yield. Each model.status is 'not-requested', bounds/IV are null and the solver is not run. Select config.model: 'black-scholes-merton' to additionally assess compatibility under BSM dynamics, supplying market.spot and riskFreeRate (dividendYield follows the package rule: omitted is 0, echoed and disclosed). Each row is assessed under its OWN exercise style — a European row against the discounted closed-form band and inverse, an American row against the undiscounted intrinsic band and the Bjerksund–Stensland 2002 engine — never as the other style. This is quote health plus SELECTED model compatibility, NOT certification of all option pricing. Nonempty canonical DiscreteDividend schedules and adjusted deliverables report unsupported; no escrowed-dividend approximation is performed here. No clock, rate, exercise, or quote-source inference. Prices are per underlying share; multiplier and unconsumed provider fields are ignored. Stale/future/wide quotes are retained and may be inverted with their warnings attached; crossed markets are not inverted. BSM compatibility is NOT proof of quote validity, nor is incompatibility proof of a bad market observation. This report checks individual model bounds, not cross-strike/calendar static arbitrage. Controls are closed. Quote/contract/dividend observations are open and never mutated. Coverage counts all observations (including expired/unavailable), not an automatically filtered universe. Expected contracts use pricing identity; different venue/multiplier metadata does not create a second slot. A missing call/put side is only an observed-grid gap unless explicitly expected. Work: ≤10,000 quotes, ≤10,000 expected contracts, ≤1,000 dividends, bounded strings and at most 100 Brent iterations per quote. All lengths are checked before row traversal or result allocation. Rows preserve input order; coverage and missing-contract identities are sorted deterministically. - optionChainHealth().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ underlying: string; spot?: number; riskFreeRate?: number; dividendYield?: number; dividends: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; modelAssessment: 'not-requested' | 'black-scholes-merton'; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; priceUnit: 'per-underlying-share'; impliedVolatilityUnit: 'annualized-decimal'; exercisePolicy: 'by-contract-style' | 'not-assessed'; exerciseEngines?: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; quotePolicy: 'report-only'; coverageIdentity: 'underlying-expiresAt-style-type-strike'; maximumQuoteAgeMs: number; maximumRelativeSpread: number; minimumExpiries: number; minimumStrikesPerExpiry: number; maximumQuotes: number; lowerVolatilityBound: number | null; upperVolatilityBound: number | null; maximumSolverIterations: number; }>; default: not declared - optionChainHealth().return.coverage: { expiries: import('@insiderfinance/totalfinance/options').OptionChainHealthExpiryCoverage[]; expiryCount: number; belowMinimumExpiries: boolean; duplicateQuoteCount: number; missingContracts: import('@insiderfinance/totalfinance/options').OptionChainHealthContract[] | null; expectedContractCount: number | null; }; default: not declared - optionChainHealth().return.coverage.belowMinimumExpiries: boolean; default: not declared - optionChainHealth().return.coverage.duplicateQuoteCount: number; default: not declared - optionChainHealth().return.coverage.expectedContractCount: number | null; default: not declared - optionChainHealth().return.coverage.expiries: import('@insiderfinance/totalfinance/options').OptionChainHealthExpiryCoverage[]; default: not declared — Sorted by expiration instant, then style (code-unit order); no locale or clock dependency. - optionChainHealth().return.coverage.expiryCount: number; default: not declared - optionChainHealth().return.coverage.missingContracts: import('@insiderfinance/totalfinance/options').OptionChainHealthContract[] | null; default: not declared — null means no expected universe supplied; [] means the supplied universe is covered. - optionChainHealth().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - optionChainHealth().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - optionChainHealth().return.rows: import('@insiderfinance/totalfinance/options').OptionChainHealthRow[]; default: not declared - optionChainHealth().return.summary: { quoteCount: number; quotesWithIssues: number; issueCounts: Record; modelStatusCounts: Record; solvedCount: number; }; default: not declared - optionChainHealth().return.summary.issueCounts: Record; default: not declared - optionChainHealth().return.summary.modelStatusCounts: Record; default: not declared - optionChainHealth().return.summary.quoteCount: number; default: not declared - optionChainHealth().return.summary.quotesWithIssues: number; default: not declared - optionChainHealth().return.summary.solvedCount: number; default: not declared - optionChainHealth(input): import('@insiderfinance/totalfinance/options').OptionChainHealthInput; default: not declared - priceMany: (input: import('@insiderfinance/totalfinance/options').PriceManyInput) => import('@insiderfinance/totalfinance/options').PriceResult[]; default: not declared — Price many contracts against one market, returning a rich `PriceResult` per contract (rows form). - priceMany(input): import('@insiderfinance/totalfinance/options').PriceManyInput; default: not declared - priceMany(input).contracts: import('@insiderfinance/totalfinance/core').OptionContract[]; default: not declared - priceMany(input).engine?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Engine to use; defaults to {@link engines.auto}, the same default as `option.price`. - priceMany(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared - priceOption: (input: import('@insiderfinance/totalfinance/options').PriceOptionInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - priceOption().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - priceOption().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - priceOption().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - priceOption().return.greeks.charm: number; default: not declared - priceOption().return.greeks.color: number; default: not declared - priceOption().return.greeks.delta: number; default: not declared - priceOption().return.greeks.gamma: number; default: not declared - priceOption().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - priceOption().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - priceOption().return.greeks.rho: number; default: not declared - priceOption().return.greeks.speed: number; default: not declared - priceOption().return.greeks.theta: number; default: not declared - priceOption().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - priceOption().return.greeks.vanna: number; default: not declared - priceOption().return.greeks.vega: number; default: not declared - priceOption().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - priceOption().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - priceOption().return.greeks.vomma: number; default: not declared - priceOption().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - priceOption().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - priceOption().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - priceOption(input): import('@insiderfinance/totalfinance/options').PriceOptionInput; default: not declared - priceOption(input).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - priceOption(input).engine?: import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Engine override; defaults to {@link engines.auto} (European → BSM, American → lattice/approx). - priceOption(input).extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - priceOption(input).greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. - priceOption(input).market: import('@insiderfinance/totalfinance/options').OptionMarket; default: not declared — Market snapshot. `asOf` is required on the market; the clock is never read. - putContract: (input: import('@insiderfinance/totalfinance/options').OptionBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared — Generic put builder — `style` REQUIRED. - putContract().return.adjusted?: boolean; default: not declared - putContract().return.currency?: string; default: not declared - putContract().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - putContract().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - putContract().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - putContract().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - putContract().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - putContract().return.multiplier?: number; default: not declared - putContract().return.occSymbol?: string; default: not declared - putContract().return.root?: string; default: not declared - putContract().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - putContract().return.strike: number; default: not declared - putContract().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - putContract().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - putContract().return.underlying: string; default: not declared - putContract(input): import('@insiderfinance/totalfinance/options').OptionBuilderInput; default: not declared - putContract(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - putContract(input).currency?: string; default: not declared - putContract(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - putContract(input).multiplier?: number; default: not declared - putContract(input).root?: string; default: not declared - putContract(input).strike: number; default: not declared - putContract(input).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - putContract(input).underlying: string; default: not declared - quanto: { readonly price: (input: import('@insiderfinance/totalfinance/options').QuantoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; }; default: not declared - quanto.price: (input: import('@insiderfinance/totalfinance/options').QuantoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Quanto option paying `(S_foreign(T) − K)⁺` in domestic currency at a fixed FX rate. The asset's drift is adjusted by `−ρ·σ_S·σ_FX` (the quanto correction) and discounting is domestic. - quanto.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - quanto.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - quanto.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - quanto.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - quanto.price(input): import('@insiderfinance/totalfinance/options').QuantoInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - quanto.price(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in [-1, 1]. - quanto.price(input).dividendYield?: number; default: not declared - quanto.price(input).domesticRate: number; default: not declared — Domestic discount rate. - quanto.price(input).foreignRate: number; default: not declared — Foreign risk-free rate. - quanto.price(input).fxVolatility: number; default: not declared — Volatility of the domestic/foreign FX rate. - quanto.price(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - quanto.price(input).strike: number; default: not declared - quanto.price(input).timeToExpiryYears: number; default: not declared - quanto.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - quanto.price(input).volatility: number; default: not declared — Asset volatility. - rainbow: { readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').MultiAssetInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').RainbowKind; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - rainbow.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').MultiAssetInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').RainbowKind; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo price of a rainbow option on the max or min of several assets. - rainbow.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - rainbow.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - rainbow.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - rainbow.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rainbow.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rainbow.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').MultiAssetInput & { type: import('@insiderfinance/totalfinance/core').OptionType; kind: import('@insiderfinance/totalfinance/options').RainbowKind; }; default: not declared - rainbow.monteCarloPrice(input).correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - rainbow.monteCarloPrice(input).dividendYields?: number[]; default: not declared - rainbow.monteCarloPrice(input).kind: import('@insiderfinance/totalfinance/options').RainbowKind; default: not declared - rainbow.monteCarloPrice(input).riskFreeRate: number; default: not declared - rainbow.monteCarloPrice(input).spots: number[]; default: not declared - rainbow.monteCarloPrice(input).strike: number; default: not declared - rainbow.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - rainbow.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - rainbow.monteCarloPrice(input).volatilities: number[]; default: not declared - rainbow.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - rainbow.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - rainbow.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - rainbow.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - rainbow.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - rainbow.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - rainbow.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - rainbow.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - reverseCliquet: { readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').ReverseCliquetInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; readonly floorlessValue: (input: import('@insiderfinance/totalfinance/options').ReverseCliquetInput) => import('@insiderfinance/totalfinance/options').ExoticResult; }; default: not declared - reverseCliquet.floorlessValue: (input: import('@insiderfinance/totalfinance/options').ReverseCliquetInput) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Closed-form reverse-cliquet value **ignoring the global floor**: `df·notional·(C + Σᵢ E[min(rᵢ, 0)])`, with `E[min(rᵢ, 0)] = (e^{b·τᵢ} − 1) − returnCaplet(1, τᵢ, b, σ)` (reusing the cliquet caplet). Exact for an unfloored note (`globalFloor = −∞`) and a fast lower bound for the floored one (large coupon ⇒ the floor rarely binds ⇒ this ≈ the MC price). See `docs/specs/napoleon-reverse-cliquet.md`. - reverseCliquet.floorlessValue().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - reverseCliquet.floorlessValue().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - reverseCliquet.floorlessValue().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - reverseCliquet.floorlessValue().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - reverseCliquet.floorlessValue(input): import('@insiderfinance/totalfinance/options').NapoleonInput; default: not declared - reverseCliquet.floorlessValue(input).coupon: number; default: not declared — The fixed coupon degraded by the period returns. - reverseCliquet.floorlessValue(input).dividendYield?: number; default: not declared - reverseCliquet.floorlessValue(input).globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - reverseCliquet.floorlessValue(input).notional?: number; default: not declared — Notional multiplier. Default 1. - reverseCliquet.floorlessValue(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - reverseCliquet.floorlessValue(input).riskFreeRate: number; default: not declared - reverseCliquet.floorlessValue(input).spot: number; default: not declared - reverseCliquet.floorlessValue(input).volatility: number; default: not declared - reverseCliquet.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').ReverseCliquetInput, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Reverse cliquet: pays the coupon eroded by the **sum of the negative** period returns, `max(floor, C + Σᵢ min(rᵢ, 0))`. Up-periods don't help, down-periods subtract — the investor is short downside vol, so a higher `volatility` LOWERS the value. Path-dependent (the floored sum) ⇒ Monte-Carlo. See `docs/specs/napoleon-reverse-cliquet.md`. - reverseCliquet.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - reverseCliquet.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - reverseCliquet.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - reverseCliquet.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - reverseCliquet.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - reverseCliquet.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').NapoleonInput; default: not declared - reverseCliquet.monteCarloPrice(input).coupon: number; default: not declared — The fixed coupon degraded by the period returns. - reverseCliquet.monteCarloPrice(input).dividendYield?: number; default: not declared - reverseCliquet.monteCarloPrice(input).globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - reverseCliquet.monteCarloPrice(input).notional?: number; default: not declared — Notional multiplier. Default 1. - reverseCliquet.monteCarloPrice(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - reverseCliquet.monteCarloPrice(input).riskFreeRate: number; default: not declared - reverseCliquet.monteCarloPrice(input).spot: number; default: not declared - reverseCliquet.monteCarloPrice(input).volatility: number; default: not declared - reverseCliquet.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - reverseCliquet.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - reverseCliquet.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - reverseCliquet.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - reverseCliquet.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - reverseCliquet.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - reverseCliquet.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - reverseCliquet.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - sabr: { readonly volatility: (request: import('@insiderfinance/totalfinance/options/sabr').SabrVolatilityRequest) => number; readonly price: (request: import('@insiderfinance/totalfinance/options/sabr').SabrPriceRequest) => import('@insiderfinance/totalfinance/options').PriceResult; readonly monteCarloPrice: (request: import('@insiderfinance/totalfinance/options/sabr').SabrPriceMonteCarloRequest) => import('@insiderfinance/totalfinance/options').SabrMonteCarloResult; readonly monteCarloEstimate: (input: import('@insiderfinance/totalfinance/options/sabr').SabrMonteCarloEstimateInput) => import('@insiderfinance/totalfinance/options').MonteCarloEstimate; }; default: not declared — The SABR model namespace — the grouped, discoverable surface over the flat `sabr*` functions. `sabr.volatility` / `sabr.price` / `sabr.monteCarloPrice` / `sabr.monteCarloEstimate` are the same functions; prefer the namespace over the deprecated flat exports. - sabr.monteCarloEstimate: (input: import('@insiderfinance/totalfinance/options/sabr').SabrMonteCarloEstimateInput) => import('@insiderfinance/totalfinance/options').MonteCarloEstimate; default: not declared - sabr.monteCarloEstimate().return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - sabr.monteCarloEstimate().return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - sabr.monteCarloEstimate().return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - sabr.monteCarloEstimate().return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - sabr.monteCarloEstimate().return.seed: number; default: not declared — The seed, echoed for reproducibility. - sabr.monteCarloEstimate().return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - sabr.monteCarloEstimate().return.value: number; default: not declared - sabr.monteCarloEstimate().return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - sabr.monteCarloEstimate().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). - sabr.monteCarloEstimate(input): import('@insiderfinance/totalfinance/options/sabr').SabrMonteCarloEstimateInput; default: not declared - sabr.monteCarloEstimate(input).forward: number; default: not declared - sabr.monteCarloEstimate(input).options: import('@insiderfinance/totalfinance/options').SabrMonteCarloOptions; default: not declared - sabr.monteCarloEstimate(input).parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - sabr.monteCarloEstimate(input).riskFreeRate: number; default: not declared - sabr.monteCarloEstimate(input).strike: number; default: not declared - sabr.monteCarloEstimate(input).timeToExpiryYears: number; default: not declared - sabr.monteCarloEstimate(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - sabr.monteCarloPrice: (request: import('@insiderfinance/totalfinance/options/sabr').SabrPriceMonteCarloRequest) => import('@insiderfinance/totalfinance/options').SabrMonteCarloResult; default: not declared - sabr.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - sabr.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - sabr.monteCarloPrice().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - sabr.monteCarloPrice().return.greeks.charm: number; default: not declared - sabr.monteCarloPrice().return.greeks.color: number; default: not declared - sabr.monteCarloPrice().return.greeks.delta: number; default: not declared - sabr.monteCarloPrice().return.greeks.gamma: number; default: not declared - sabr.monteCarloPrice().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - sabr.monteCarloPrice().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - sabr.monteCarloPrice().return.greeks.rho: number; default: not declared - sabr.monteCarloPrice().return.greeks.speed: number; default: not declared - sabr.monteCarloPrice().return.greeks.theta: number; default: not declared - sabr.monteCarloPrice().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - sabr.monteCarloPrice().return.greeks.vanna: number; default: not declared - sabr.monteCarloPrice().return.greeks.vega: number; default: not declared - sabr.monteCarloPrice().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - sabr.monteCarloPrice().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - sabr.monteCarloPrice().return.greeks.vomma: number; default: not declared - sabr.monteCarloPrice().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - sabr.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - sabr.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sabr.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sabr.monteCarloPrice(request): import('@insiderfinance/totalfinance/options/sabr').SabrPriceMonteCarloRequest; default: not declared - sabr.monteCarloPrice(request).input: import('@insiderfinance/totalfinance/options').SabrInput; default: not declared - sabr.monteCarloPrice(request).options: import('@insiderfinance/totalfinance/options').SabrMonteCarloOptions; default: not declared - sabr.monteCarloPrice(request).parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - sabr.monteCarloPrice(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - sabr.price: (request: import('@insiderfinance/totalfinance/options/sabr').SabrPriceRequest) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - sabr.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - sabr.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - sabr.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - sabr.price().return.greeks.charm: number; default: not declared - sabr.price().return.greeks.color: number; default: not declared - sabr.price().return.greeks.delta: number; default: not declared - sabr.price().return.greeks.gamma: number; default: not declared - sabr.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - sabr.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - sabr.price().return.greeks.rho: number; default: not declared - sabr.price().return.greeks.speed: number; default: not declared - sabr.price().return.greeks.theta: number; default: not declared - sabr.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - sabr.price().return.greeks.vanna: number; default: not declared - sabr.price().return.greeks.vega: number; default: not declared - sabr.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - sabr.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - sabr.price().return.greeks.vomma: number; default: not declared - sabr.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - sabr.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sabr.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sabr.price(request): import('@insiderfinance/totalfinance/options/sabr').SabrPriceRequest; default: not declared - sabr.price(request).input: import('@insiderfinance/totalfinance/options').SabrInput; default: not declared - sabr.price(request).options?: import('@insiderfinance/totalfinance/options').SabrOptions; default: not declared - sabr.price(request).parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - sabr.price(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - sabr.volatility: (request: import('@insiderfinance/totalfinance/options/sabr').SabrVolatilityRequest) => number; default: not declared - sabr.volatility(request): import('@insiderfinance/totalfinance/options/sabr').SabrVolatilityRequest; default: not declared - sabr.volatility(request).input: import('@insiderfinance/totalfinance/options/sabr').SabrVolatilityInput; default: not declared - sabr.volatility(request).options?: import('@insiderfinance/totalfinance/options/sabr').SabrVolatilityOptions; default: not declared - sabr.volatility(request).parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - schemas: { readonly BlackScholesInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly BlackScholesTypedInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly BlackScholesImpliedVolatilityInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly OptionContract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; }; default: not declared — Convenience namespace mirroring the spec's `schemas.OptionContract.parse(...)` usage. - schemas.BlackScholesImpliedVolatilityInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - schemas.BlackScholesImpliedVolatilityInput._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { ok: false; issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; } | { ok: true; value: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; }; default: not declared — @internal - schemas.BlackScholesImpliedVolatilityInput._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._check().return.ok: (false) | (true); default: not declared - schemas.BlackScholesImpliedVolatilityInput._check().return.value: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - schemas.BlackScholesImpliedVolatilityInput._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - schemas.BlackScholesImpliedVolatilityInput._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - schemas.BlackScholesImpliedVolatilityInput._check(context).path: (string | number)[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._check(input): unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.$id?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.$schema?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.const?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.default?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.description?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.format?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.maxItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.maxLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.maximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.minItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.minLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.minimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.multipleOf?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.pattern?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.properties?: Record; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.required?: string[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.title?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.describe(description): string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.description: string | undefined; default: not declared - schemas.BlackScholesImpliedVolatilityInput.isOptional: boolean; default: not declared - schemas.BlackScholesImpliedVolatilityInput.kind: 'object'; default: not declared - schemas.BlackScholesImpliedVolatilityInput.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - schemas.BlackScholesImpliedVolatilityInput.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; }; default: not declared — @internal - schemas.BlackScholesImpliedVolatilityInput.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - schemas.BlackScholesImpliedVolatilityInput.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.description: string | undefined; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.isOptional: true; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.kind: 'optional'; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; } | undefined>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.BlackScholesImpliedVolatilityInput.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - schemas.BlackScholesImpliedVolatilityInput.parse(input): unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.BlackScholesImpliedVolatilityInput.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.BlackScholesImpliedVolatilityInput.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse().return.data: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse().return.success: (false) | (true); default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse(input): unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.BlackScholesImpliedVolatilityInput.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.$id?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.$schema?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.const?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.default?: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.description?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.format?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.maxItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.maxLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.maximum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.minItems?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.minLength?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.minimum?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.multipleOf?: number; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.pattern?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.properties?: Record; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.required?: string[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.title?: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.types?: ({ readonly input: unknown; readonly output: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; }) | undefined; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.types.input: unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.types.output: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.validate().return.value: { price: number; strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; dividendYield?: number; }; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.validate(value): unknown; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.vendor: string; default: not declared - schemas.BlackScholesImpliedVolatilityInput.~standard.version: 1; default: not declared - schemas.BlackScholesInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - schemas.BlackScholesInput._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; }; default: not declared — @internal - schemas.BlackScholesInput._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.BlackScholesInput._check().return.ok: (false) | (true); default: not declared - schemas.BlackScholesInput._check().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesInput._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - schemas.BlackScholesInput._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - schemas.BlackScholesInput._check(context).path: (string | number)[]; default: not declared - schemas.BlackScholesInput._check(input): unknown; default: not declared - schemas.BlackScholesInput._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - schemas.BlackScholesInput._toJSONSchema().return.$id?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.$schema?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.const?: unknown; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.default?: unknown; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.description?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.format?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.maxItems?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.maxLength?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.maximum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.minItems?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.minLength?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.minimum?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.multipleOf?: number; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.pattern?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.properties?: Record; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.required?: string[]; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.title?: string; default: not declared - schemas.BlackScholesInput._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesInput.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - schemas.BlackScholesInput.describe(description): string; default: not declared - schemas.BlackScholesInput.description: string | undefined; default: not declared - schemas.BlackScholesInput.isOptional: boolean; default: not declared - schemas.BlackScholesInput.kind: 'object'; default: not declared - schemas.BlackScholesInput.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - schemas.BlackScholesInput.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }>; default: not declared - schemas.BlackScholesInput.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; }; default: not declared — @internal - schemas.BlackScholesInput.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - schemas.BlackScholesInput.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - schemas.BlackScholesInput.optional().return.description: string | undefined; default: not declared - schemas.BlackScholesInput.optional().return.isOptional: true; default: not declared - schemas.BlackScholesInput.optional().return.kind: 'optional'; default: not declared - schemas.BlackScholesInput.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; } | undefined>; default: not declared - schemas.BlackScholesInput.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; default: not declared - schemas.BlackScholesInput.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined>; default: not declared - schemas.BlackScholesInput.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.BlackScholesInput.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - schemas.BlackScholesInput.parse(input): unknown; default: not declared - schemas.BlackScholesInput.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.BlackScholesInput.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.BlackScholesInput.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - schemas.BlackScholesInput.safeParse().return.data: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesInput.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - schemas.BlackScholesInput.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.BlackScholesInput.safeParse().return.success: (false) | (true); default: not declared - schemas.BlackScholesInput.safeParse(input): unknown; default: not declared - schemas.BlackScholesInput.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.BlackScholesInput.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.BlackScholesInput.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.$id?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.$schema?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.const?: unknown; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.default?: unknown; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.description?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.format?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.maxItems?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.maxLength?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.maximum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.minItems?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.minLength?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.minimum?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.multipleOf?: number; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.pattern?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.properties?: Record; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.required?: string[]; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.title?: string; default: not declared - schemas.BlackScholesInput.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesInput.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.BlackScholesInput.~standard.types?: ({ readonly input: unknown; readonly output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; }) | undefined; default: not declared - schemas.BlackScholesInput.~standard.types.input: unknown; default: not declared - schemas.BlackScholesInput.~standard.types.output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesInput.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - schemas.BlackScholesInput.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - schemas.BlackScholesInput.~standard.validate().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesInput.~standard.validate(value): unknown; default: not declared - schemas.BlackScholesInput.~standard.vendor: string; default: not declared - schemas.BlackScholesInput.~standard.version: 1; default: not declared - schemas.BlackScholesTypedInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - schemas.BlackScholesTypedInput._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; }; default: not declared — @internal - schemas.BlackScholesTypedInput._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.BlackScholesTypedInput._check().return.ok: (false) | (true); default: not declared - schemas.BlackScholesTypedInput._check().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesTypedInput._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - schemas.BlackScholesTypedInput._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - schemas.BlackScholesTypedInput._check(context).path: (string | number)[]; default: not declared - schemas.BlackScholesTypedInput._check(input): unknown; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - schemas.BlackScholesTypedInput._toJSONSchema().return.$id?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.$schema?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.const?: unknown; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.default?: unknown; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.description?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.format?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.maxItems?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.maxLength?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.maximum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.minItems?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.minLength?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.minimum?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.multipleOf?: number; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.pattern?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.properties?: Record; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.required?: string[]; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.title?: string; default: not declared - schemas.BlackScholesTypedInput._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesTypedInput.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - schemas.BlackScholesTypedInput.describe(description): string; default: not declared - schemas.BlackScholesTypedInput.description: string | undefined; default: not declared - schemas.BlackScholesTypedInput.isOptional: boolean; default: not declared - schemas.BlackScholesTypedInput.kind: 'object'; default: not declared - schemas.BlackScholesTypedInput.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - schemas.BlackScholesTypedInput.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }>; default: not declared - schemas.BlackScholesTypedInput.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; }; default: not declared — @internal - schemas.BlackScholesTypedInput.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - schemas.BlackScholesTypedInput.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - schemas.BlackScholesTypedInput.optional().return.description: string | undefined; default: not declared - schemas.BlackScholesTypedInput.optional().return.isOptional: true; default: not declared - schemas.BlackScholesTypedInput.optional().return.kind: 'optional'; default: not declared - schemas.BlackScholesTypedInput.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; } | undefined>; default: not declared - schemas.BlackScholesTypedInput.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; default: not declared - schemas.BlackScholesTypedInput.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined>; default: not declared - schemas.BlackScholesTypedInput.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.BlackScholesTypedInput.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - schemas.BlackScholesTypedInput.parse(input): unknown; default: not declared - schemas.BlackScholesTypedInput.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.BlackScholesTypedInput.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.BlackScholesTypedInput.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - schemas.BlackScholesTypedInput.safeParse().return.data: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesTypedInput.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - schemas.BlackScholesTypedInput.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.BlackScholesTypedInput.safeParse().return.success: (false) | (true); default: not declared - schemas.BlackScholesTypedInput.safeParse(input): unknown; default: not declared - schemas.BlackScholesTypedInput.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.BlackScholesTypedInput.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.BlackScholesTypedInput.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.$id?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.$schema?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.const?: unknown; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.default?: unknown; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.description?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.format?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.maxItems?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.maxLength?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.maximum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.minItems?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.minLength?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.minimum?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.multipleOf?: number; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.pattern?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.properties?: Record; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.required?: string[]; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.title?: string; default: not declared - schemas.BlackScholesTypedInput.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.BlackScholesTypedInput.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.BlackScholesTypedInput.~standard.types?: ({ readonly input: unknown; readonly output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; }) | undefined; default: not declared - schemas.BlackScholesTypedInput.~standard.types.input: unknown; default: not declared - schemas.BlackScholesTypedInput.~standard.types.output: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesTypedInput.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - schemas.BlackScholesTypedInput.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - schemas.BlackScholesTypedInput.~standard.validate().return.value: { strike: number; spot: number; riskFreeRate: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; dividendYield?: number; }; default: not declared - schemas.BlackScholesTypedInput.~standard.validate(value): unknown; default: not declared - schemas.BlackScholesTypedInput.~standard.vendor: string; default: not declared - schemas.BlackScholesTypedInput.~standard.version: 1; default: not declared - schemas.OptionContract: import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }>; default: not declared - schemas.OptionContract.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }>; default: not declared - schemas.OptionContract.describe(description): string; default: not declared - schemas.OptionContract.isOptional: boolean; default: not declared - schemas.OptionContract.kind: string; default: not declared - schemas.OptionContract.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - schemas.OptionContract.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - schemas.OptionContract.optional().return.isOptional: boolean; default: not declared - schemas.OptionContract.optional().return.kind: string; default: not declared - schemas.OptionContract.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - schemas.OptionContract.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined; default: not declared - schemas.OptionContract.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; } | undefined>; default: not declared - schemas.OptionContract.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.OptionContract.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.OptionContract.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - schemas.OptionContract.parse(input): unknown; default: not declared - schemas.OptionContract.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.OptionContract.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.OptionContract.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - schemas.OptionContract.safeParse().return.data: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - schemas.OptionContract.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - schemas.OptionContract.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schemas.OptionContract.safeParse().return.success: (false) | (true); default: not declared - schemas.OptionContract.safeParse(input): unknown; default: not declared - schemas.OptionContract.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schemas.OptionContract.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schemas.OptionContract.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.OptionContract.toJSONSchema().return.$id?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.$schema?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.description?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.format?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.title?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.OptionContract.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.OptionContract.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.OptionContract.toJSONSchema().return.const?: unknown; default: not declared - schemas.OptionContract.toJSONSchema().return.default?: unknown; default: not declared - schemas.OptionContract.toJSONSchema().return.description?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.enum?: unknown[]; default: not declared - schemas.OptionContract.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.format?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - schemas.OptionContract.toJSONSchema().return.maxItems?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.maxLength?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.maximum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.minItems?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.minLength?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.minimum?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.multipleOf?: number; default: not declared - schemas.OptionContract.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - schemas.OptionContract.toJSONSchema().return.pattern?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.properties?: Record; default: not declared - schemas.OptionContract.toJSONSchema().return.required?: string[]; default: not declared - schemas.OptionContract.toJSONSchema().return.title?: string; default: not declared - schemas.OptionContract.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schemas.OptionContract.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schemas.OptionContract.~standard.types?: ({ readonly input: unknown; readonly output: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; }) | undefined; default: not declared - schemas.OptionContract.~standard.types.input: unknown; default: not declared - schemas.OptionContract.~standard.types.output: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - schemas.OptionContract.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - schemas.OptionContract.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - schemas.OptionContract.~standard.validate().return.value: { style: 'european' | 'american'; underlying: string; strike: number; expiry: string; type: 'call' | 'put'; expiresAt: number; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; currency?: string; root?: string; settlement?: 'physical' | 'cash'; exerciseTime?: 'AM' | 'PM'; occSymbol?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; adjusted?: boolean; }; default: not declared - schemas.OptionContract.~standard.validate(value): unknown; default: not declared - schemas.OptionContract.~standard.vendor: string; default: not declared - schemas.OptionContract.~standard.version: 1; default: not declared - selectQuotePrice: (quote: import('@insiderfinance/totalfinance/core').OptionQuote, source: import('@insiderfinance/totalfinance/core').PriceSource) => number | undefined; default: not declared — Resolve a single price from an option quote per the requested source. Returns `undefined` when the requested fields are absent. `mid` falls back to (bid+ask)/2 when an explicit mid is missing. Quote records are structural artifacts, so venue/provenance fields and declared subtypes may decorate them; only the fields consumed by the selected source are interpreted here. - selectQuotePrice(quote): import('@insiderfinance/totalfinance/core').OptionQuote; default: not declared - selectQuotePrice(quote).ask?: number; default: not declared - selectQuotePrice(quote).askSize?: number; default: not declared - selectQuotePrice(quote).bid?: number; default: not declared - selectQuotePrice(quote).bidSize?: number; default: not declared - selectQuotePrice(quote).conditions?: string[]; default: not declared - selectQuotePrice(quote).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - selectQuotePrice(quote).exchange?: string; default: not declared - selectQuotePrice(quote).greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - selectQuotePrice(quote).impliedVolatility?: number; default: not declared - selectQuotePrice(quote).last?: number; default: not declared - selectQuotePrice(quote).mark?: number; default: not declared - selectQuotePrice(quote).mid?: number; default: not declared - selectQuotePrice(quote).openInterest?: number; default: not declared - selectQuotePrice(quote).timestampMs: number; default: not declared - selectQuotePrice(quote).underlyingPrice?: number; default: not declared - selectQuotePrice(quote).volume?: number; default: not declared - selectQuotePrice(source): import('@insiderfinance/totalfinance/core').PriceSource; default: not declared - spread: { readonly price: (input: import('@insiderfinance/totalfinance/options').SpreadInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').SpreadInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - spread.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').SpreadInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }, options: import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo price of the spread option (validator for, and generalization of, Kirk). - spread.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - spread.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - spread.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - spread.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - spread.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - spread.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').SpreadInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - spread.monteCarloPrice(input).correlation: number; default: not declared — Correlation between the two assets, in [-1, 1]. - spread.monteCarloPrice(input).dividendYield1?: number; default: not declared - spread.monteCarloPrice(input).dividendYield2?: number; default: not declared - spread.monteCarloPrice(input).riskFreeRate: number; default: not declared - spread.monteCarloPrice(input).spot1: number; default: not declared - spread.monteCarloPrice(input).spot2: number; default: not declared - spread.monteCarloPrice(input).strike: number; default: not declared — Strike on `S1 − S2`. May be negative; Kirk requires `F2 + K > 0`. - spread.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - spread.monteCarloPrice(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - spread.monteCarloPrice(input).volatility1: number; default: not declared — Per-asset volatilities. These were `vol1`/`vol2` under a retired rule ("flat inputs use `vol`") that survived in this comment long after the rule went. The denylist has forbidden `vol` since N0 — the digit is what hid these two, which is the whole reason the tokenizer now tests the letter run in front of a numeric suffix. - spread.monteCarloPrice(input).volatility2: number; default: not declared - spread.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').MonteCarloSamplingOptions; default: not declared - spread.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - spread.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - spread.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - spread.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - spread.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - spread.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - spread.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - spread.price: (input: import('@insiderfinance/totalfinance/options').SpreadInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — Kirk's-approximation analytic price of an option on `S1 − S2`. - spread.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - spread.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - spread.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - spread.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - spread.price(input): import('@insiderfinance/totalfinance/options').SpreadInput & { type: import('@insiderfinance/totalfinance/core').OptionType; }; default: not declared - spread.price(input).correlation: number; default: not declared — Correlation between the two assets, in [-1, 1]. - spread.price(input).dividendYield1?: number; default: not declared - spread.price(input).dividendYield2?: number; default: not declared - spread.price(input).riskFreeRate: number; default: not declared - spread.price(input).spot1: number; default: not declared - spread.price(input).spot2: number; default: not declared - spread.price(input).strike: number; default: not declared — Strike on `S1 − S2`. May be negative; Kirk requires `F2 + K > 0`. - spread.price(input).timeToExpiryYears: number; default: not declared - spread.price(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - spread.price(input).volatility1: number; default: not declared — Per-asset volatilities. These were `vol1`/`vol2` under a retired rule ("flat inputs use `vol`") that survived in this comment long after the rule went. The denylist has forbidden `vol` since N0 — the digit is what hid these two, which is the whole reason the tokenizer now tests the letter run in front of a numeric suffix. - spread.price(input).volatility2: number; default: not declared - touch: { readonly price: (input: import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }) => import('@insiderfinance/totalfinance/options').ExoticResult; readonly greeks: (input: import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }) => import('@insiderfinance/totalfinance/core').Computed; readonly monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }, options: import('@insiderfinance/totalfinance/options').TouchMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; }; default: not declared - touch.greeks: (input: import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — First-order greeks (delta, gamma, vega, theta, rho) for the one-touch / no-touch binary, by central finite-difference of the exact `touch.price` (the analytic greeks are a research-grade first-passage series). Units match the package (vega/1%, theta/day, rho/1%; echoed in `assumptions.units`). The spot bump is shrunk near the barrier so it never straddles it. Pinned to the exact identity that a one-touch (pay-at-expiry) and a no-touch greek sum to the `cash·e^{−rT}` greeks. See `docs/specs/touch-greeks.md`. - touch.greeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - touch.greeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - touch.greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - touch.greeks().return.value: import('@insiderfinance/totalfinance/options').Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - touch.greeks(input): import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }; default: not declared - touch.greeks(input).barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - touch.greeks(input).cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - touch.greeks(input).dividendYield?: number; default: not declared - touch.greeks(input).kind: import('@insiderfinance/totalfinance/options').TouchKind; default: not declared - touch.greeks(input).payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - touch.greeks(input).riskFreeRate: number; default: not declared - touch.greeks(input).spot: number; default: not declared - touch.greeks(input).timeToExpiryYears: number; default: not declared - touch.greeks(input).volatility: number; default: not declared - touch.monteCarloPrice: (input: import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }, options: import('@insiderfinance/totalfinance/options').TouchMonteCarloOptions) => import('@insiderfinance/totalfinance/options').ExoticMonteCarloResult; default: not declared — Monte-Carlo one-touch / no-touch. Pay-at-expiry reuses the Brownian-bridge survival so discrete monitoring converges to the continuous analytic; pay-at-hit detects the first crossing on the grid and discounts at the hit time. - touch.monteCarloPrice().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - touch.monteCarloPrice().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - touch.monteCarloPrice().return.monteCarlo: import('@insiderfinance/totalfinance/options').MonteCarloStatistics; default: not declared - touch.monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - touch.monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - touch.monteCarloPrice(input): import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }; default: not declared - touch.monteCarloPrice(input).barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - touch.monteCarloPrice(input).cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - touch.monteCarloPrice(input).dividendYield?: number; default: not declared - touch.monteCarloPrice(input).kind: import('@insiderfinance/totalfinance/options').TouchKind; default: not declared - touch.monteCarloPrice(input).payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - touch.monteCarloPrice(input).riskFreeRate: number; default: not declared - touch.monteCarloPrice(input).spot: number; default: not declared - touch.monteCarloPrice(input).timeToExpiryYears: number; default: not declared - touch.monteCarloPrice(input).volatility: number; default: not declared - touch.monteCarloPrice(options): import('@insiderfinance/totalfinance/options').TouchMonteCarloOptions; default: not declared - touch.monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - touch.monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - touch.monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - touch.monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - touch.monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - touch.monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - touch.monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - touch.monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 100). - touch.price: (input: import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }) => import('@insiderfinance/totalfinance/options').ExoticResult; default: not declared — One-touch (pays if `H` is ever touched) / no-touch (pays if it never is), continuous monitoring. `one-touch` settles at expiry by default or at the hit (`payAt: 'hit'`, Reiner–Rubinstein); `no-touch` is always expiry-settled. An already-touched spot (`S = H`) short-circuits to the certain payoff. See `docs/specs/digital-touch.md`. - touch.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - touch.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - touch.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - touch.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - touch.price(input): import('@insiderfinance/totalfinance/options').TouchInput & { kind: import('@insiderfinance/totalfinance/options').TouchKind; }; default: not declared - touch.price(input).barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - touch.price(input).cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - touch.price(input).dividendYield?: number; default: not declared - touch.price(input).kind: import('@insiderfinance/totalfinance/options').TouchKind; default: not declared - touch.price(input).payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - touch.price(input).riskFreeRate: number; default: not declared - touch.price(input).spot: number; default: not declared - touch.price(input).timeToExpiryYears: number; default: not declared - touch.price(input).volatility: number; default: not declared - usEquityCall: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - usEquityCall().return.adjusted?: boolean; default: not declared - usEquityCall().return.currency?: string; default: not declared - usEquityCall().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - usEquityCall().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - usEquityCall().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - usEquityCall().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - usEquityCall().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - usEquityCall().return.multiplier?: number; default: not declared - usEquityCall().return.occSymbol?: string; default: not declared - usEquityCall().return.root?: string; default: not declared - usEquityCall().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - usEquityCall().return.strike: number; default: not declared - usEquityCall().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - usEquityCall().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - usEquityCall().return.underlying: string; default: not declared - usEquityCall(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput; default: not declared - usEquityCall(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - usEquityCall(input).currency?: string; default: not declared - usEquityCall(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - usEquityCall(input).multiplier?: number; default: not declared - usEquityCall(input).root?: string; default: not declared - usEquityCall(input).strike: number; default: not declared - usEquityCall(input).underlying: string; default: not declared - usEquityOption: (input: import('@insiderfinance/totalfinance/options').UsEquityOptionInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared — US listed equity option from DATA (B7): either an OCC symbol, or `type` plus the fields `usEquityCall`/`usEquityPut` take. The two named builders remain the sugar; this is the door a chain row, a fill, or a broker symbol goes through without branching on `type` first. A field given beside `occSymbol` must agree with the symbol — a contradiction is refused, never resolved by preference. - usEquityOption().return.adjusted?: boolean; default: not declared - usEquityOption().return.currency?: string; default: not declared - usEquityOption().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - usEquityOption().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - usEquityOption().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - usEquityOption().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - usEquityOption().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - usEquityOption().return.multiplier?: number; default: not declared - usEquityOption().return.occSymbol?: string; default: not declared - usEquityOption().return.root?: string; default: not declared - usEquityOption().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - usEquityOption().return.strike: number; default: not declared - usEquityOption().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - usEquityOption().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - usEquityOption().return.underlying: string; default: not declared - usEquityOption(input): import('@insiderfinance/totalfinance/options').UsEquityOptionInput; default: not declared - usEquityOption(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - usEquityOption(input).currency?: string; default: not declared - usEquityOption(input).expiry?: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - usEquityOption(input).multiplier?: number; default: not declared - usEquityOption(input).occSymbol?: string; default: not declared — A compact OCC symbol (`AAPL260918C00200000`); its root, expiry, type and strike are the contract. - usEquityOption(input).root?: string; default: not declared - usEquityOption(input).strike?: number; default: not declared - usEquityOption(input).type?: import('@insiderfinance/totalfinance/core').OptionType; default: not declared — `'call' | 'put'` — required unless `occSymbol` names it. - usEquityOption(input).underlying?: string; default: not declared - usEquityPut: (input: import('@insiderfinance/totalfinance/options').InstrumentBuilderInput) => import('@insiderfinance/totalfinance/core').OptionContract; default: not declared — US listed equity put — see {@link usEquityCall}. - usEquityPut().return.adjusted?: boolean; default: not declared - usEquityPut().return.currency?: string; default: not declared - usEquityPut().return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - usEquityPut().return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - usEquityPut().return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - usEquityPut().return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - usEquityPut().return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - usEquityPut().return.multiplier?: number; default: not declared - usEquityPut().return.occSymbol?: string; default: not declared - usEquityPut().return.root?: string; default: not declared - usEquityPut().return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - usEquityPut().return.strike: number; default: not declared - usEquityPut().return.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - usEquityPut().return.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - usEquityPut().return.underlying: string; default: not declared - usEquityPut(input): import('@insiderfinance/totalfinance/options').InstrumentBuilderInput; default: not declared - usEquityPut(input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - usEquityPut(input).currency?: string; default: not declared - usEquityPut(input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - usEquityPut(input).multiplier?: number; default: not declared - usEquityPut(input).root?: string; default: not declared - usEquityPut(input).strike: number; default: not declared - usEquityPut(input).underlying: string; default: not declared - validateOptionPricingEngine: (engine: import('@insiderfinance/totalfinance/options').OptionPricingEngine, probes: readonly import('@insiderfinance/totalfinance/options').OptionPricingEngineProbe[]) => import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared — Behaviorally verify a custom pricing engine against CALLER-SUPPLIED fixtures. Registration via {@link defineOptionPricingEngine} is deliberately side-effect-free; this explicit companion is the place for potentially expensive pricing calls and therefore works for spot, forward, stateful, remote, and domain-specific engines without TotalFinance guessing their inputs. At least one probe is required for every claimed exercise style. Each probe verifies `supports()`, a finite non-negative price, Greek capability claims, extended-Greek claims, and repeat-call value equality when `deterministic` is true. The validated immutable engine is returned for convenient inline use. - validateOptionPricingEngine().return.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - validateOptionPricingEngine().return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - validateOptionPricingEngine().return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - validateOptionPricingEngine().return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - validateOptionPricingEngine().return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - validateOptionPricingEngine().return.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - validateOptionPricingEngine().return.name: string; default: not declared - validateOptionPricingEngine().return.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - validateOptionPricingEngine().return.supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - validateOptionPricingEngine().return.version: string; default: not declared - validateOptionPricingEngine(engine): import('@insiderfinance/totalfinance/options').OptionPricingEngine; default: not declared - validateOptionPricingEngine(engine).capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - validateOptionPricingEngine(engine).capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - validateOptionPricingEngine(engine).capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - validateOptionPricingEngine(engine).capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - validateOptionPricingEngine(engine).capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - validateOptionPricingEngine(engine).capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - validateOptionPricingEngine(engine).name: string; default: not declared - validateOptionPricingEngine(engine).price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - validateOptionPricingEngine(engine).supports: (contract: import('@insiderfinance/totalfinance/core').OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - validateOptionPricingEngine(engine).version: string; default: not declared - validateOptionPricingEngine(probes): readonly import('@insiderfinance/totalfinance/options').OptionPricingEngineProbe[]; default: not declared - vanillaIntrinsic: (input: import('@insiderfinance/totalfinance/options').VanillaIntrinsicInput) => number; default: not declared — Gross vanilla intrinsic value per unit: `max(underlyingPrice − strike, 0)` for a call, `max(strike − underlyingPrice, 0)` for a put. A plain number out, and nothing else in: no premium (this is not P&L), no quantity or multiplier (per unit), no volatility or time (intrinsic is model-free). `underlyingPrice` and `strike` must be finite and `>= 0` — zero is legal on either leg (a worthless underlying or a zero strike still has a well-defined intrinsic value). - vanillaIntrinsic(input): import('@insiderfinance/totalfinance/options').VanillaIntrinsicInput; default: not declared - vanillaIntrinsic(input).strike: number; default: not declared — The option's strike price per unit. - vanillaIntrinsic(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared — Which leg — `'call'` or `'put'`. - vanillaIntrinsic(input).underlyingPrice: number; default: not declared — The underlying's price per unit, in the same currency unit as `strike`. - varianceSwap: { readonly hestonFairVariance: (parameters: { v0: number; kappa: number; theta: number; }, timeToExpiryYears: number) => number; readonly value: (input: { realizedVariance: number; strikeVariance: number; varianceNotional?: number; riskFreeRate: number; timeToExpiryYears: number; }) => number; }; default: not declared - varianceSwap.hestonFairVariance: (parameters: { v0: number; kappa: number; theta: number; }, timeToExpiryYears: number) => number; default: not declared — Fair variance strike under Heston: `θ + (v₀ − θ)·(1 − e^{−κT})/(κT)`. Depends only on the mean-reversion `κ`, long-run variance `θ`, and initial variance `v₀` (not on vol-of-vol/ρ). - varianceSwap.hestonFairVariance(parameters): { v0: number; kappa: number; theta: number; }; default: not declared - varianceSwap.hestonFairVariance(parameters).kappa: number; default: not declared - varianceSwap.hestonFairVariance(parameters).theta: number; default: not declared - varianceSwap.hestonFairVariance(parameters).v0: number; default: not declared - varianceSwap.hestonFairVariance(timeToExpiryYears): number; default: not declared - varianceSwap.value: (input: { realizedVariance: number; strikeVariance: number; varianceNotional?: number; riskFreeRate: number; timeToExpiryYears: number; }) => number; default: not declared — Present value of a variance swap: `e^{−rT}·varianceNotional·(realizedVariance − strikeVariance)`. - varianceSwap.value(input): { realizedVariance: number; strikeVariance: number; varianceNotional?: number; riskFreeRate: number; timeToExpiryYears: number; }; default: not declared - varianceSwap.value(input).realizedVariance: number; default: not declared - varianceSwap.value(input).riskFreeRate: number; default: not declared - varianceSwap.value(input).strikeVariance: number; default: not declared - varianceSwap.value(input).timeToExpiryYears: number; default: not declared - varianceSwap.value(input).varianceNotional?: number; default: not declared - volatilitySwap: { readonly approximateFairVolatility: (input: { fairVariance: number; varianceOfVariance?: number; }) => number; }; default: not declared - volatilitySwap.approximateFairVolatility: (input: { fairVariance: number; varianceOfVariance?: number; }) => number; default: not declared — Brockhaus–Long convexity-adjusted fair vol: `K_vol ≈ √K_var·(1 − Var[realized variance]/(8·K_var²))`. With no variance-of-variance it reduces to `√K_var`; the adjustment captures the (downward) Jensen gap between √E[var] and E[√var]. - volatilitySwap.approximateFairVolatility(input): { fairVariance: number; varianceOfVariance?: number; }; default: not declared - volatilitySwap.approximateFairVolatility(input).fairVariance: number; default: not declared - volatilitySwap.approximateFairVolatility(input).varianceOfVariance?: number; default: not declared ### @insiderfinance/totalfinance#performance Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const performance: typeof import('@insiderfinance/totalfinance/performance'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').RiskAdjustedExtra>; default: not declared — Annualized Jensen's alpha: the strategy's average return in excess of what its beta exposure to the benchmark would predict, `α = ppy · (r̄ − [rf_p + β·(b̄ − rf_p)])` (rf split to a per-period rate). - alpha(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - alpha.explain: (returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - alpha.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - alpha.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - alpha.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - alpha.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - alpha.explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - analyze: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: import('@insiderfinance/totalfinance/performance').AnalyzeInput, options?: import('@insiderfinance/totalfinance/performance').AnalyzeOptions | undefined], import('@insiderfinance/totalfinance/performance').PerformanceSummary, { periodsPerYear: number; riskFreeRate: number; benchmarkLength?: number; }>; default: not declared — The performance summary facade (dx §2.3): plain call → the summary; `.explain()` → the core Computed envelope around it (the summary's own warnings ride `diagnostics.warnings`, its echoed conventions ride `assumptions`). - analyze().return.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - analyze().return.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - analyze().return.annualizedVolatility: number | null; default: not declared - analyze().return.assumptions: { periodsPerYear: number; riskFreeRate: number; benchmarkLength?: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - analyze().return.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - analyze().return.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - analyze().return.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - analyze().return.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - analyze().return.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - analyze().return.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - analyze().return.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - analyze().return.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - analyze().return.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - analyze().return.maxDrawdown: number; default: not declared - analyze().return.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - analyze().return.periods: number; default: not declared - analyze().return.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - analyze().return.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - analyze().return.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - analyze().return.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - analyze().return.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - analyze().return.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - analyze().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - analyze(callArguments): [input: import('@insiderfinance/totalfinance/performance').AnalyzeInput, options?: import('@insiderfinance/totalfinance/performance').AnalyzeOptions | undefined]; default: not declared - analyze.explain: (input: import('@insiderfinance/totalfinance/performance').AnalyzeInput, options?: import('@insiderfinance/totalfinance/performance').AnalyzeOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - analyze.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ periodsPerYear: number; riskFreeRate: number; benchmarkLength?: number; }>; default: not declared — Every applied convention, echoed back. - analyze.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - analyze.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - analyze.explain().return.value: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - analyze.explain(callArguments): [input: import('@insiderfinance/totalfinance/performance').AnalyzeInput, options?: import('@insiderfinance/totalfinance/performance').AnalyzeOptions | undefined]; default: not declared - annualizedReturn: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').AnnualizationExtra>; default: not declared — Geometric annualized return from a per-period return series. - annualizedReturn(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - annualizedReturn.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - annualizedReturn.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - annualizedReturn.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - annualizedReturn.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - annualizedReturn.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - annualizedReturn.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - annualizedVolatility: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').AnnualizationExtra>; default: not declared — Annualized volatility: per-period stddev scaled by √periodsPerYear. - annualizedVolatility(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - annualizedVolatility.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - annualizedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - annualizedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - annualizedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - annualizedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - annualizedVolatility.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - benchmarkRelativeTimeline: (input: import('@insiderfinance/totalfinance/performance').BenchmarkRelativeTimelineInput) => import('@insiderfinance/totalfinance/performance').BenchmarkRelativeTimelineResult; default: not declared — Benchmark-relative timeline: aligns a portfolio total-return index with benchmark period returns BY DATE and reports cumulative relative performance rows. A row exists only where BOTH a portfolio index value and a benchmark return dated exactly that day exist; missing dates on either side become `diagnostics.gaps` — never interpolated. Benchmark observations on non-portfolio dates are real growth: they still compound into the benchmark cumulative at the next aligned row (compounding observed returns is not interpolation), and their absence of a row is recorded as a gap. - benchmarkRelativeTimeline().return.assumptions: { benchmarkBasis: 'total-return' | 'price-return'; relativeMethod: string; anchorDate: string; benchmarkReturnConvention: string; }; default: not declared - benchmarkRelativeTimeline().return.assumptions.anchorDate: string; default: not declared - benchmarkRelativeTimeline().return.assumptions.benchmarkBasis: 'total-return' | 'price-return'; default: not declared - benchmarkRelativeTimeline().return.assumptions.benchmarkReturnConvention: string; default: not declared - benchmarkRelativeTimeline().return.assumptions.relativeMethod: string; default: not declared - benchmarkRelativeTimeline().return.diagnostics: { warnings: string[]; gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; rowCount: number; }; default: not declared - benchmarkRelativeTimeline().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - benchmarkRelativeTimeline().return.diagnostics.rowCount: number; default: not declared - benchmarkRelativeTimeline().return.diagnostics.warnings: string[]; default: not declared - benchmarkRelativeTimeline().return.rows: import('@insiderfinance/totalfinance/performance').BenchmarkRelativeRow[]; default: not declared - benchmarkRelativeTimeline(input): import('@insiderfinance/totalfinance/performance').BenchmarkRelativeTimelineInput; default: not declared - benchmarkRelativeTimeline(input).benchmarkBasis: 'total-return' | 'price-return'; default: not declared — REQUIRED — a benchmark states its basis; price-return omits dividend/income return. - benchmarkRelativeTimeline(input).benchmarkReturns: readonly import('@insiderfinance/totalfinance/performance').BenchmarkReturnObservation[]; default: not declared - benchmarkRelativeTimeline(input).portfolioIndex: readonly import('@insiderfinance/totalfinance/performance').ReturnIndexPoint[]; default: not declared - beta: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike], number | null, Record>; default: not declared — Beta: sensitivity of the strategy to the benchmark, `cov(r, b) / var(b)`. - beta(callArguments): [returns: ArrayLike, benchmark: ArrayLike]; default: not declared - beta.explain: (returns: ArrayLike, benchmark: ArrayLike) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - beta.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - beta.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - beta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - beta.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - beta.explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike]; default: not declared - calmar: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').AnnualizationExtra>; default: not declared — Calmar ratio: annualized return divided by maximum drawdown. - calmar(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - calmar.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - calmar.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - calmar.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - calmar.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - calmar.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - calmar.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - contributionByGroup: (input: import('@insiderfinance/totalfinance/performance').ContributionByGroupInput) => import('@insiderfinance/totalfinance/performance').ContributionByGroupResult; default: not declared — Single-period contribution by group: `contribution = weight × simpleReturn` per group, summing to the weighted total return. At single-period scope the reconciliation is exact — the residual (disclosed in `diagnostics.reconciliationResidual`) is 0 within 1e-12, the linking-residual law with no linking involved. - contributionByGroup().return.assumptions: { formula: string; scope: 'single-period'; }; default: not declared - contributionByGroup().return.assumptions.formula: string; default: not declared - contributionByGroup().return.assumptions.scope: 'single-period'; default: not declared - contributionByGroup().return.contributions: import('@insiderfinance/totalfinance/performance').GroupContribution[]; default: not declared - contributionByGroup().return.diagnostics: { warnings: string[]; groupCount: number; weightSum: number; reconciliationResidual: number; }; default: not declared - contributionByGroup().return.diagnostics.groupCount: number; default: not declared - contributionByGroup().return.diagnostics.reconciliationResidual: number; default: not declared — `totalReturn − Σ contributionᵢ` — identically 0 at single-period scope (the linking-residual law). - contributionByGroup().return.diagnostics.warnings: string[]; default: not declared - contributionByGroup().return.diagnostics.weightSum: number; default: not declared - contributionByGroup().return.totalReturn: number; default: not declared — The weighted total return `Σ weightᵢ · simpleReturnᵢ` the contributions reconcile to. - contributionByGroup(input): import('@insiderfinance/totalfinance/performance').ContributionByGroupInput; default: not declared - contributionByGroup(input).groupReturns: readonly import('@insiderfinance/totalfinance/performance').GroupReturn[]; default: not declared — ONE period's per-group weights and returns (position/account/strategy/asset class/…). - cumulativeReturns: (returns: ArrayLike) => number[]; default: not declared — Cumulative compounded return at each step from a series of simple returns. - cumulativeReturns(returns): ArrayLike; default: not declared - equityCurve: (returns: ArrayLike, start?: number) => number[]; default: not declared — Equity curve (growth of `start`) from a series of simple returns. The curve begins at `start` and has length `returns.length + 1`, so `analyze({ equity: equityCurve(returns) })` recovers every return — the starting capital is the first point, not an implicit one. (`equityCurve([])` is `[start]`.) - equityCurve(returns): ArrayLike; default: not declared - equityCurve(start)?: number; default: not declared - expectancy: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], number | null, Record>; default: not declared — Expectancy: the mean per-period return — `null` when undefined (empty series), exactly as `analyze().expectancy` reports it (one word, one shape). For the win/loss decomposition that explains it (hit rate, average win/loss), use {@link winLossStatistics}. - expectancy(callArguments): [returns: ArrayLike]; default: not declared - expectancy.explain: (returns: ArrayLike) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - expectancy.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - expectancy.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - expectancy.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - expectancy.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - expectancy.explain(callArguments): [returns: ArrayLike]; default: not declared - exposure: import('@insiderfinance/totalfinance/core').SeriesFacade<[weights: readonly ArrayLike[]], import('@insiderfinance/totalfinance/performance').ExposureResult, Record>; default: not declared — Exposure facade (dx §2.3): plain call → the profile; `.explain()` → the Computed envelope. - exposure().return.averageGross: number | null; default: not declared — Average gross exposure `mean_t( Σ_i |w_{t,i}| )`. - exposure().return.averageLong: number | null; default: not declared — Average long exposure `mean_t( Σ_i max(w_{t,i}, 0) )`. - exposure().return.averageNet: number | null; default: not declared — Average net exposure `mean_t( Σ_i w_{t,i} )`. - exposure().return.averageShort: number | null; default: not declared — Average short exposure as a positive number `mean_t( Σ_i max(−w_{t,i}, 0) )`. - exposure().return.timeInMarket: number | null; default: not declared — Fraction of periods with any non-zero net position (`Σ_i w ≠ 0`). - exposure(callArguments): [weights: readonly ArrayLike[]]; default: not declared - exposure.explain: (weights: readonly ArrayLike[]) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - exposure.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - exposure.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - exposure.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - exposure.explain().return.value: import('@insiderfinance/totalfinance/performance').ExposureResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - exposure.explain(callArguments): [weights: readonly ArrayLike[]]; default: not declared - hitRate: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], number | null, Record>; default: not declared — Hit rate: fraction of non-zero periods that were positive (`wins / (wins + losses)`). - hitRate(callArguments): [returns: ArrayLike]; default: not declared - hitRate.explain: (returns: ArrayLike) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - hitRate.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - hitRate.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - hitRate.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - hitRate.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - hitRate.explain(callArguments): [returns: ArrayLike]; default: not declared - informationRatio: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').AnnualizationExtra>; default: not declared — Information ratio: annualized mean active return divided by annualized tracking error — the Sharpe ratio of the active (strategy − benchmark) return series. - informationRatio(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - informationRatio.explain: (returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - informationRatio.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - informationRatio.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - informationRatio.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - informationRatio.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - informationRatio.explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - linkSubperiodReturns: (input: import('@insiderfinance/totalfinance/performance').LinkSubperiodReturnsInput) => import('@insiderfinance/totalfinance/performance').LinkSubperiodReturnsResult; default: not declared — Explicit subperiod linking: `'geometric'` compounds (`Π(1 + rᵢ) − 1`, the time-weighted convention), `'arithmetic'` sums (`Σ rᵢ`, no compounding — an approximation that ignores base drift). The policy is required; nothing is inferred. - linkSubperiodReturns().return.assumptions: { linking: 'geometric' | 'arithmetic'; formula: string; }; default: not declared - linkSubperiodReturns().return.assumptions.formula: string; default: not declared - linkSubperiodReturns().return.assumptions.linking: 'geometric' | 'arithmetic'; default: not declared - linkSubperiodReturns().return.diagnostics: { warnings: string[]; subperiodCount: number; }; default: not declared - linkSubperiodReturns().return.diagnostics.subperiodCount: number; default: not declared - linkSubperiodReturns().return.diagnostics.warnings: string[]; default: not declared - linkSubperiodReturns().return.linkedReturn: number; default: not declared - linkSubperiodReturns(input): import('@insiderfinance/totalfinance/performance').LinkSubperiodReturnsInput; default: not declared - linkSubperiodReturns(input).linking: 'geometric' | 'arithmetic'; default: not declared — REQUIRED and explicit — linking is a policy, never a guess. - linkSubperiodReturns(input).subperiodReturns: readonly number[]; default: not declared - logReturns: (prices: ArrayLike) => number[]; default: not declared — Continuously-compounded (log) returns; output length is `prices.length - 1`. - logReturns(prices): ArrayLike; default: not declared - maxDrawdown: import('@insiderfinance/totalfinance/core').SeriesFacade<[equity: ArrayLike], import('@insiderfinance/totalfinance/performance').DrawdownResult, Record>; default: not declared — Maximum drawdown facade (dx §2.3): plain call → the `DrawdownResult`; `.explain()` → the `Computed` envelope. `equity` is a PRICE-level series by contract, so the prices-as-returns plausibility guard deliberately does not apply here. - maxDrawdown().return.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - maxDrawdown().return.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - maxDrawdown().return.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - maxDrawdown().return.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - maxDrawdown().return.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - maxDrawdown(callArguments): [equity: ArrayLike]; default: not declared - maxDrawdown.explain: (equity: ArrayLike) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - maxDrawdown.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - maxDrawdown.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - maxDrawdown.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - maxDrawdown.explain().return.value: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - maxDrawdown.explain(callArguments): [equity: ArrayLike]; default: not declared - maxDrawdownFromReturns: (returns: ArrayLike) => import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared — Maximum drawdown of the growth-of-1 equity curve implied by a per-period **return** series (WS3.3b) — the returns-input counterpart to {@link maxDrawdown}, which expects an equity curve. - maxDrawdownFromReturns().return.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - maxDrawdownFromReturns().return.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - maxDrawdownFromReturns().return.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - maxDrawdownFromReturns().return.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - maxDrawdownFromReturns().return.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - maxDrawdownFromReturns(returns): ArrayLike; default: not declared - modifiedDietzReturn: (input: import('@insiderfinance/totalfinance/performance').ModifiedDietzReturnInput) => import('@insiderfinance/totalfinance/performance').ModifiedDietzReturnResult; default: not declared — Classic Modified Dietz single-period return: `(netAssetValue₁ − netAssetValue₀ − F) / (netAssetValue₀ + Σ weightᵢ·flowᵢ)` where `F` is the net external flow and each `weightᵢ = (daysInPeriod − daysSinceStartᵢ) / daysInPeriod` under ACT day counts. The weights actually used are exposed in `flowWeights`. When the average-capital denominator is not positive the result is `null` with a reason — never a fabricated rate. - modifiedDietzReturn().return.assumptions: { weightFormula: string; dayCount: 'ACT (actual calendar days)'; }; default: not declared - modifiedDietzReturn().return.assumptions.dayCount: 'ACT (actual calendar days)'; default: not declared - modifiedDietzReturn().return.assumptions.weightFormula: string; default: not declared - modifiedDietzReturn().return.diagnostics: { warnings: string[]; flowCount: number; daysInPeriod: number; }; default: not declared - modifiedDietzReturn().return.diagnostics.daysInPeriod: number; default: not declared - modifiedDietzReturn().return.diagnostics.flowCount: number; default: not declared - modifiedDietzReturn().return.diagnostics.warnings: string[]; default: not declared - modifiedDietzReturn().return.flowWeights: import('@insiderfinance/totalfinance/performance').ModifiedDietzFlowWeight[]; default: not declared — The exact weight applied to each flow — exposed, never hidden. - modifiedDietzReturn().return.modifiedDietzReturn: number | null; default: not declared — `null` (with `reason`) when the average-capital denominator is not positive. - modifiedDietzReturn().return.reason?: string; default: not declared — Present exactly when `modifiedDietzReturn` is `null`. - modifiedDietzReturn(input): import('@insiderfinance/totalfinance/performance').ModifiedDietzReturnInput; default: not declared - modifiedDietzReturn(input).externalCashFlows: readonly import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - modifiedDietzReturn(input).valuations: readonly import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — EXACTLY the two period endpoints: the start and end valuations. - moneyWeightedReturn: (input: import('@insiderfinance/totalfinance/performance').MoneyWeightedReturnInput) => import('@insiderfinance/totalfinance/performance').MoneyWeightedReturnResult; default: not declared — Money-weighted return: the dated internal rate of return of the INVESTOR's cash-flow schedule, composed from `datedInternalRateOfReturn` in `@insiderfinance/totalfinance/valuation` (annual compounding, ACT/365F — echoed in `solverReport.assumptions`). Sign convention (echoed in `assumptions.signConvention`): flows are stated from the INVESTOR's perspective — the beginning net asset value is money the investor has committed (an outflow, `−netAssetValue₀`), a deposit is the investor paying in (an outflow, `−amount`), a withdrawal is the investor taking money out (an inflow, `+amount`), and the ending net asset value is what the investor could take out (an inflow, `+netAssetValueₙ`). The solver's `.explain()` report is preserved whole in `solverReport` so every admissible root and convergence detail rides along. - moneyWeightedReturn().return.assumptions: { signConvention: string; asOf: string; }; default: not declared - moneyWeightedReturn().return.assumptions.asOf: string; default: not declared — The first valuation date — the solver's valuation instant. - moneyWeightedReturn().return.assumptions.signConvention: string; default: not declared - moneyWeightedReturn().return.diagnostics: { warnings: string[]; scheduleRowCount: number; }; default: not declared - moneyWeightedReturn().return.diagnostics.scheduleRowCount: number; default: not declared - moneyWeightedReturn().return.diagnostics.warnings: string[]; default: not declared - moneyWeightedReturn().return.moneyWeightedReturn: number | null; default: not declared — The dated internal rate of return of the investor schedule; `null` on no root or ambiguity. - moneyWeightedReturn().return.reason?: string; default: not declared — Present exactly when `moneyWeightedReturn` is `null` — why the solver withheld a value. - moneyWeightedReturn().return.solverReport: import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnReport; default: not declared — The FC1 solver's full `.explain()` report: roots, convergence, and warnings ride along. - moneyWeightedReturn(input): import('@insiderfinance/totalfinance/performance').MoneyWeightedReturnInput; default: not declared - moneyWeightedReturn(input).externalCashFlows: readonly import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - moneyWeightedReturn(input).valuations: readonly import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — First and last valuations REQUIRED — they anchor the schedule. Interior marks do not enter. - omega: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: { threshold?: number; } | undefined], number | null, { threshold: number; }>; default: not declared — Omega ratio at a per-period `threshold` (default 0): Σ gains above θ ÷ Σ losses below θ. **`null`, never `Infinity`** (Law 7): with gains but no losses the ratio is unbounded, and with neither it is undefined — both are reported as `null`, and `.explain()` carries an `input.degenerate` warning naming the reason. A JSON payload can hold `null`; it cannot hold `Infinity` (`JSON.stringify` silently corrupts it to `null` anyway, without the reason). - omega(callArguments): [returns: ArrayLike, options?: { threshold?: number; } | undefined]; default: not declared - omega.explain: (returns: ArrayLike, options?: { threshold?: number; } | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - omega.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ threshold: number; }>; default: not declared — Every applied convention, echoed back. - omega.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - omega.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - omega.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - omega.explain(callArguments): [returns: ArrayLike, options?: { threshold?: number; } | undefined]; default: not declared - portfolioReturnIndex: (input: import('@insiderfinance/totalfinance/performance').PortfolioReturnIndexInput) => import('@insiderfinance/totalfinance/performance').PortfolioReturnIndexResult; default: not declared — The portfolio's total-return index: the time-weighted subperiod returns (same flow convention and gap rules as {@link timeWeightedReturn}) chained geometrically from `baseValue` at the first valuation date. Gap policy — decided, documented, echoed: ANY gap makes the WHOLE index `null` with a reason (`assumptions.gapPolicy`), because an index that silently restarts across a hole misrepresents cumulative growth. - portfolioReturnIndex().return.assumptions: { baseValue: number; gapPolicy: string; flowTiming: 'at-flow-timestamp'; flowConvention: string; linking: 'geometric'; }; default: not declared - portfolioReturnIndex().return.assumptions.baseValue: number; default: not declared - portfolioReturnIndex().return.assumptions.flowConvention: string; default: not declared - portfolioReturnIndex().return.assumptions.flowTiming: 'at-flow-timestamp'; default: not declared - portfolioReturnIndex().return.assumptions.gapPolicy: string; default: not declared - portfolioReturnIndex().return.assumptions.linking: 'geometric'; default: not declared - portfolioReturnIndex().return.diagnostics: { warnings: string[]; gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; flowCount: number; subperiodCount: number; }; default: not declared - portfolioReturnIndex().return.diagnostics.flowCount: number; default: not declared - portfolioReturnIndex().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - portfolioReturnIndex().return.diagnostics.subperiodCount: number; default: not declared - portfolioReturnIndex().return.diagnostics.warnings: string[]; default: not declared - portfolioReturnIndex().return.indexSeries: import('@insiderfinance/totalfinance/performance').ReturnIndexPoint[] | null; default: not declared — `null` (with `reason`) under the null-on-any-gap policy — see `assumptions.gapPolicy`. - portfolioReturnIndex().return.reason?: string; default: not declared — Present exactly when `indexSeries` is `null`. - portfolioReturnIndex(input): import('@insiderfinance/totalfinance/performance').PortfolioReturnIndexInput; default: not declared - portfolioReturnIndex(input).baseValue?: number; default: not declared — The index level at the first valuation date. Default `100`, echoed in `assumptions`. - portfolioReturnIndex(input).externalCashFlows: readonly import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - portfolioReturnIndex(input).valuations: readonly import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared - profitFactor: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], number | null, Record>; default: not declared — Profit factor: gross gains ÷ gross losses. **`null`, never `Infinity`** (Law 7): a series with gains but no losses has an unbounded profit factor, and a series with neither has an undefined one — both are reported as `null`, with an `input.degenerate` warning on `.explain()` naming which case it was. (The doc used to promise `Infinity`; the facade has always returned `null`, and `null` is the law-conform answer — a caller branching on `=== Infinity` would never have matched.) - profitFactor(callArguments): [returns: ArrayLike]; default: not declared - profitFactor.explain: (returns: ArrayLike) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - profitFactor.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - profitFactor.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - profitFactor.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - profitFactor.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - profitFactor.explain(callArguments): [returns: ArrayLike]; default: not declared - rollingReturn: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, window: number], number[], { window: number; }>; default: not declared — Rolling compounded return over a trailing window (`Π(1 + r) − 1`), aligned to the input index with the leading `window − 1` entries set to `NaN`. - rollingReturn(callArguments): [returns: ArrayLike, window: number]; default: not declared - rollingReturn.explain: (returns: ArrayLike, window: number) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - rollingReturn.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; }>; default: not declared — Every applied convention, echoed back. - rollingReturn.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - rollingReturn.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingReturn.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingReturn.explain(callArguments): [returns: ArrayLike, window: number]; default: not declared - rollingSharpe: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined], number[], { window: number; periodsPerYear: number; riskFreeRate: number; }>; default: not declared — Rolling annualized Sharpe ratio over a trailing window (leading `window − 1` entries are `NaN`). - rollingSharpe(callArguments): [returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - rollingSharpe.explain: (returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - rollingSharpe.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; periodsPerYear: number; riskFreeRate: number; }>; default: not declared — Every applied convention, echoed back. - rollingSharpe.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - rollingSharpe.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingSharpe.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingSharpe.explain(callArguments): [returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - rollingVolatility: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined], number[], { window: number; periodsPerYear: number; }>; default: not declared — Rolling annualized volatility over a trailing window (leading `window − 1` entries are `NaN`). `options.periodsPerYear` defaults to 252 — matching every other `rolling*(series, window, options?)` sibling, so the annualization factor is no longer a bare positional scalar. - rollingVolatility(callArguments): [returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - rollingVolatility.explain: (returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - rollingVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; periodsPerYear: number; }>; default: not declared — Every applied convention, echoed back. - rollingVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - rollingVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingVolatility.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingVolatility.explain(callArguments): [returns: ArrayLike, window: number, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - sectorPerformance: (input: import('@insiderfinance/totalfinance/performance').SectorPerformanceInput) => import('@insiderfinance/totalfinance/performance').SectorPerformanceReport; default: not declared — Equal-weight sectors from same-period decimal returns. Rows are open observations, the request is closed. Inputs are copied, never mutated; identities, not ticker aliases, determine membership. - sectorPerformance().return.assumptions: Readonly; default: not declared - sectorPerformance().return.assumptions.policyVersion: 'sector-performance-v1'; default: not declared - sectorPerformance().return.assumptions.rankingAndTies: string; default: not declared - sectorPerformance().return.assumptions.returnBasis: string; default: not declared - sectorPerformance().return.assumptions.rounding: string; default: not declared - sectorPerformance().return.assumptions.weighting: string; default: not declared - sectorPerformance().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; status: 'complete' | 'empty'; inputMemberCount: number; includedSecurityCount: number; sectorCount: number; }; default: not declared - sectorPerformance().return.diagnostics.includedSecurityCount: number; default: not declared - sectorPerformance().return.diagnostics.inputMemberCount: number; default: not declared - sectorPerformance().return.diagnostics.sectorCount: number; default: not declared - sectorPerformance().return.diagnostics.status: 'complete' | 'empty'; default: not declared - sectorPerformance().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - sectorPerformance().return.policyVersion: 'sector-performance-v1'; default: not declared - sectorPerformance().return.sectors: import('@insiderfinance/totalfinance/performance').SectorPerformanceSectorResult[]; default: not declared - sectorPerformance(input): import('@insiderfinance/totalfinance/performance').SectorPerformanceInput; default: not declared - sectorPerformance(input).members: readonly import('@insiderfinance/totalfinance/performance').SectorPerformanceMember[]; default: not declared — Dense observations with unique securityId; at most 1,000,000 rows. Empty is disclosed. - sectorPerformanceSnapshot: (input: import('@insiderfinance/totalfinance/performance').SectorPerformanceSnapshotInput) => import('@insiderfinance/totalfinance/performance').SectorPerformanceSnapshotReport; default: not declared — Calculate one target session's audited sector returns from governed inputs. The function is deterministic and pure: it performs no I/O, reads no clock, mutates no input, and never infers a universe, session, classification, or price. - sectorPerformanceSnapshot().return.assumptions: Readonly; default: not declared - sectorPerformanceSnapshot().return.assumptions.cacheAndFreshness: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.classification: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.eligibility: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.missingAndStale: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.policyVersion: 'sector-performance-v1'; default: not declared - sectorPerformanceSnapshot().return.assumptions.rankingAndTies: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.returnBasis: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.rounding: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.sessionSelection: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.temporalSelection: string; default: not declared - sectorPerformanceSnapshot().return.assumptions.weighting: string; default: not declared - sectorPerformanceSnapshot().return.classificationTaxonomy: import('@insiderfinance/totalfinance/performance').SectorPerformanceTaxonomy; default: not declared - sectorPerformanceSnapshot().return.cutoffs: import('@insiderfinance/totalfinance/performance').SectorPerformanceCutoffs; default: not declared - sectorPerformanceSnapshot().return.diagnostics: import('@insiderfinance/totalfinance/performance').SectorPerformanceSnapshotDiagnostics; default: not declared - sectorPerformanceSnapshot().return.exclusions: import('@insiderfinance/totalfinance/performance').SectorPerformanceExclusion[]; default: not declared - sectorPerformanceSnapshot().return.marketCalendarId: string; default: not declared - sectorPerformanceSnapshot().return.policyVersion: 'sector-performance-v1'; default: not declared - sectorPerformanceSnapshot().return.sectors: import('@insiderfinance/totalfinance/performance').SectorPerformanceSnapshotSectorResult[]; default: not declared - sectorPerformanceSnapshot().return.selectedSessions: { target: import('@insiderfinance/totalfinance/performance').SectorPerformanceSessionLineage | null; previous: import('@insiderfinance/totalfinance/performance').SectorPerformanceSessionLineage | null; }; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.previous: import('@insiderfinance/totalfinance/performance').SectorPerformanceSessionLineage | null; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.previous.completedAtTimestampMs: number; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.previous.sessionDate: string; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.previous.sessionId: string; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.target: import('@insiderfinance/totalfinance/performance').SectorPerformanceSessionLineage | null; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.target.completedAtTimestampMs: number; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.target.sessionDate: string; default: not declared - sectorPerformanceSnapshot().return.selectedSessions.target.sessionId: string; default: not declared - sectorPerformanceSnapshot().return.targetSessionDate: string; default: not declared - sectorPerformanceSnapshot(input): import('@insiderfinance/totalfinance/performance').SectorPerformanceSnapshotInput; default: not declared - sectorPerformanceSnapshot(input).classificationTaxonomy: import('@insiderfinance/totalfinance/performance').SectorPerformanceTaxonomy; default: not declared - sectorPerformanceSnapshot(input).classifications: readonly import('@insiderfinance/totalfinance/performance').SectorClassificationObservation[]; default: not declared - sectorPerformanceSnapshot(input).completedSessions: readonly import('@insiderfinance/totalfinance/performance').SectorPerformanceCompletedSession[]; default: not declared - sectorPerformanceSnapshot(input).cutoffs: import('@insiderfinance/totalfinance/performance').SectorPerformanceCutoffs; default: not declared - sectorPerformanceSnapshot(input).eligibleUniverse: readonly import('@insiderfinance/totalfinance/performance').SectorPerformanceUniverseMember[]; default: not declared — Exactly one nominated listing per eligible security for the target session. - sectorPerformanceSnapshot(input).marketCalendarId: string; default: not declared — Caller-declared calendar identity; TotalFinance does not infer holidays or sessions. - sectorPerformanceSnapshot(input).splitAdjustedCloses: readonly import('@insiderfinance/totalfinance/performance').SectorPerformanceCloseObservation[]; default: not declared - sectorPerformanceSnapshot(input).targetSessionDate: string; default: not declared — Exact requested session date. A non-session date produces an empty diagnostic report. - segmentExternalFlows: (input: import('@insiderfinance/totalfinance/performance').SegmentExternalFlowsInput) => import('@insiderfinance/totalfinance/performance').SegmentExternalFlowsResult; default: not declared — External-flow segmentation: totals by account plus the net, with transfers BETWEEN accounts of one portfolio identified and reported as internal — a transfer nets to zero external flow (the acceptance law) and appears only in `internalTransfers`, never in the external totals. - segmentExternalFlows().return.assumptions: { transferIdentification: string; accountFilter: readonly string[] | 'none'; }; default: not declared - segmentExternalFlows().return.assumptions.accountFilter: 'none' | readonly string[]; default: not declared - segmentExternalFlows().return.assumptions.transferIdentification: string; default: not declared - segmentExternalFlows().return.byAccount: import('@insiderfinance/totalfinance/performance').AccountFlowSegment[]; default: not declared - segmentExternalFlows().return.diagnostics: { warnings: string[]; flowCount: number; internalTransferCount: number; excludedByFilterCount: number; }; default: not declared - segmentExternalFlows().return.diagnostics.excludedByFilterCount: number; default: not declared - segmentExternalFlows().return.diagnostics.flowCount: number; default: not declared - segmentExternalFlows().return.diagnostics.internalTransferCount: number; default: not declared - segmentExternalFlows().return.diagnostics.warnings: string[]; default: not declared - segmentExternalFlows().return.externalNetAmount: number; default: not declared — Net EXTERNAL flow across the kept accounts — internal transfers contribute exactly zero. - segmentExternalFlows().return.internalTransfers: import('@insiderfinance/totalfinance/performance').InternalTransfer[]; default: not declared - segmentExternalFlows(input): import('@insiderfinance/totalfinance/performance').SegmentExternalFlowsInput; default: not declared - segmentExternalFlows(input).accountFilter?: readonly string[]; default: not declared — Keep only flows whose `accountId` is listed (flows without an `accountId` are excluded by any filter). Transfer identification runs BEFORE the filter so a filter can never orphan one leg. - segmentExternalFlows(input).externalCashFlows: readonly import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - sharpe: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').RiskAdjustedExtra>; default: not declared — Annualized Sharpe ratio of a per-period return series. - sharpe(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - sharpe.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - sharpe.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sharpe.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - sharpe.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sharpe.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sharpe.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - simpleReturns: (prices: ArrayLike) => number[]; default: not declared — Simple period-over-period returns; output length is `prices.length - 1`. A zero price before the final observation throws (that period's return divides by zero) rather than emitting a NaN that poisons every downstream metric. - simpleReturns(prices): ArrayLike; default: not declared - sortino: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SortinoOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').RiskAdjustedExtra>; default: not declared — Annualized Sortino ratio (downside-deviation-adjusted). - sortino(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SortinoOptions | undefined]; default: not declared - sortino.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SortinoOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - sortino.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sortino.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - sortino.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sortino.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sortino.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SortinoOptions | undefined]; default: not declared - timeWeightedReturn: (input: import('@insiderfinance/totalfinance/performance').TimeWeightedReturnInput) => import('@insiderfinance/totalfinance/performance').TimeWeightedReturnResult; default: not declared — Time-weighted return: simple returns between consecutive valuation dates, linked geometrically. Flow convention (also echoed in `assumptions.flowConvention`): a valuation dated D marks the portfolio BEFORE any external flow dated D lands, so a flow dated on a valuation date is attributed to the START of the subperiod beginning at D and is invested for its whole length. Each subperiod uses `simpleReturn = endNetAssetValue / (startNetAssetValue + netExternalFlows) − 1` — the flow principal joins the start-of-subperiod base (denominator), so external deposits and withdrawals are never profit or loss. A flow dated between valuations has no mark to be valued at, so its surrounding subperiod becomes a GAP: excluded from linking, recorded in `diagnostics.gaps`, never forward-filled. `annualizedReturn` appears only under the explicit `{ basis: 'ACT/365F' }` policy, and only when NO subperiod is a gap — a linked return that covers part of the window is never annualized over the whole window. - timeWeightedReturn().return.annualizedReturn?: number; default: not declared — Present only when `annualization` declared a basis AND the linked return exists, is annualizable (its growth factor is positive), AND NO subperiod is a gap: `(1 + timeWeightedReturn)^(1 / elapsedYears) − 1` over the ACT/365F year fraction between the first and last valuation dates. When any subperiod is a gap the linked return does not cover the whole window, so no annualized rate is stated (withheld with a warning). - timeWeightedReturn().return.assumptions: { flowTiming: 'at-flow-timestamp'; flowConvention: string; annualization: import('@insiderfinance/totalfinance/performance').AnnualizationPolicy; linking: 'geometric'; }; default: not declared - timeWeightedReturn().return.assumptions.annualization: import('@insiderfinance/totalfinance/performance').AnnualizationPolicy; default: not declared - timeWeightedReturn().return.assumptions.flowConvention: string; default: not declared - timeWeightedReturn().return.assumptions.flowTiming: 'at-flow-timestamp'; default: not declared - timeWeightedReturn().return.assumptions.linking: 'geometric'; default: not declared - timeWeightedReturn().return.diagnostics: { warnings: string[]; gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; flowCount: number; subperiodCount: number; }; default: not declared - timeWeightedReturn().return.diagnostics.flowCount: number; default: not declared - timeWeightedReturn().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - timeWeightedReturn().return.diagnostics.subperiodCount: number; default: not declared - timeWeightedReturn().return.diagnostics.warnings: string[]; default: not declared - timeWeightedReturn().return.reason?: string; default: not declared — Present exactly when `timeWeightedReturn` is `null`. - timeWeightedReturn().return.subperiods: import('@insiderfinance/totalfinance/performance').TimeWeightedSubperiod[]; default: not declared - timeWeightedReturn().return.timeWeightedReturn: number | null; default: not declared — Geometric link of the measured subperiod returns; `null` when every subperiod is a gap. - timeWeightedReturn(input): import('@insiderfinance/totalfinance/performance').TimeWeightedReturnInput; default: not declared - timeWeightedReturn(input).annualization: import('@insiderfinance/totalfinance/performance').AnnualizationPolicy; default: not declared — REQUIRED and explicit: `'none'` or `{ basis: 'ACT/365F' }` — never inferred from timestamps. - timeWeightedReturn(input).externalCashFlows: readonly import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - timeWeightedReturn(input).flowTiming: 'at-flow-timestamp'; default: not declared — The only v1 policy: a flow is valued at the net asset value dated the SAME date; a flow date with no valuation makes its surrounding subperiod a gap — never a forward fill. - timeWeightedReturn(input).valuations: readonly import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared - trackingError: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').AnnualizationExtra>; default: not declared — Annualized tracking error: the volatility of the active (strategy − benchmark) return series. - trackingError(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - trackingError.explain: (returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - trackingError.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - trackingError.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - trackingError.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - trackingError.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - trackingError.explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').AnnualizationOptions | undefined]; default: not declared - treynor: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined], number | null, import('@insiderfinance/totalfinance/performance/sharpe').RiskAdjustedExtra>; default: not declared — Treynor ratio: excess (over risk-free) annualized return per unit of systematic risk (beta), `(annualizedReturn − rf) / β`. Uses the geometric annualized return for the numerator. - treynor(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - treynor.explain: (returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - treynor.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - treynor.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - treynor.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - treynor.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - treynor.explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: import('@insiderfinance/totalfinance/performance').SharpeOptions | undefined]; default: not declared - turnover: import('@insiderfinance/totalfinance/core').SeriesFacade<[weights: readonly ArrayLike[]], number | null, Record>; default: not declared — Turnover facade (dx §2.3): plain call → the ratio; `.explain()` → the Computed envelope. - turnover(callArguments): [weights: readonly ArrayLike[]]; default: not declared - turnover.explain: (weights: readonly ArrayLike[]) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - turnover.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - turnover.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - turnover.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - turnover.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - turnover.explain(callArguments): [weights: readonly ArrayLike[]]; default: not declared - underwater: (equity: ArrayLike) => number[]; default: not declared — Per-period drawdown series (input-aligned): the fractional decline from the running peak at each index, as a non-negative number (0 at a fresh high). The series that drives an underwater chart (WS3.3c); its maximum equals `maxDrawdown(equity).maxDrawdown`. - underwater(equity): ArrayLike; default: not declared - winLossStatistics: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], import('@insiderfinance/totalfinance/performance').WinLossStatistics, Record>; default: not declared - winLossStatistics().return.averageLoss: number; default: not declared — Average losing return (negative); 0 when the series has no losing periods. - winLossStatistics().return.averageWin: number; default: not declared — Average winning return; 0 when the series has no winning periods (not NaN — disclosed here). - winLossStatistics().return.expectancy: number | null; default: not declared — Mean per-period return over ALL periods (zeros included). With `active` = the fraction of non-zero periods, `expectancy = active · (hitRate·averageWin + (1 − hitRate)·averageLoss)`; the bare `hitRate·averageWin + (1 − hitRate)·averageLoss` identity holds only when no period is exactly zero. - winLossStatistics().return.hitRate: number | null; default: not declared - winLossStatistics(callArguments): [returns: ArrayLike]; default: not declared - winLossStatistics.explain: (returns: ArrayLike) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared - winLossStatistics.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - winLossStatistics.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - winLossStatistics.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - winLossStatistics.explain().return.value: import('@insiderfinance/totalfinance/performance').WinLossStatistics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - winLossStatistics.explain(callArguments): [returns: ArrayLike]; default: not declared ### @insiderfinance/totalfinance#portfolio Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const portfolio: typeof import('@insiderfinance/totalfinance/portfolio'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - MODEL_PORTFOLIO_KIND: 'totalfinance.model-portfolio'; default: not declared - MODEL_PORTFOLIO_SCHEMA_VERSION: 1; default: not declared - MONITOR_ALERT_FAMILIES: readonly import('@insiderfinance/totalfinance/portfolio').MonitorAlertFamily[]; default: not declared - MONITOR_LIQUIDITY_PARTICIPATION_RATE: 0.1; default: not declared — Days to liquidate = |quantity| ÷ (averageDailyVolume × this rate). Stated in assumptions. - NORMALIZED_FILL_KEYS: readonly ['fillId', 'accountId', 'instrumentId', 'side', 'quantity', 'pricePerUnit', 'currency', 'filledTimestampMs', 'settleTimestampMs', 'contractMultiplier', 'settlementStyle', 'contract', 'accruedInterest', 'costs', 'executionPriceAdjustment', 'orderId', 'venue', 'liquidity']; default: not declared - PORTFOLIO_EVENT_SCHEMA_VERSION: 1; default: not declared — Version of the event grammar carried by EVERY envelope. Bump only with a payload shape change, landed together with a registered ledger migration. - PORTFOLIO_LEDGER_KIND: 'totalfinance.portfolio-ledger'; default: not declared - PORTFOLIO_LEDGER_SCHEMA_VERSION: 1; default: not declared — Current ledger-envelope schema version. Bump ONLY with a shape change, landed together with a registered migration — `readPortfolioLedgerSnapshot` refuses an older stored version without one, and refuses a newer version outright (this build cannot know what changed). - PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION: 1; default: not declared - PORTFOLIO_STATE_SCHEMA_VERSION: 4; default: not declared — 2 (2026-08-28, FC7 slice 2): accounts gained the per-instrument attribution maps. 3 (2026-08-28, FC7 slice 3): the fold records per-fill effects (for exact reversal), the reversal links, and account-migration markers. 4 (2026-08-29, FC7 slice 5): positions carry their instrument profile (contract multiplier, settlement style, derivative terms) and fill effects record the cash they booked. - TRADE_PLAN_KIND: 'totalfinance.trade-plan'; default: not declared - TRADE_PLAN_SCHEMA_VERSION: 1; default: not declared - allocatePortfolio: (input: import('@insiderfinance/totalfinance/portfolio').AllocatePortfolioInput) => import('@insiderfinance/totalfinance/portfolio').AllocatePortfolioResult; default: not declared — Turn a policy's target weights into executable quantities at `asOf` — see the module comment for the laws. A proposal built on this is a PLAN: nothing here executes anything. - allocatePortfolio().return.allocations: import('@insiderfinance/totalfinance/portfolio').AllocationRow[]; default: not declared — Sorted by instrumentId. - allocatePortfolio().return.asOf: number; default: not declared - allocatePortfolio().return.assumptions: { conventionsVersion: string; targetSource: import('@insiderfinance/totalfinance/portfolio').ResolvedTargetSource; rounding: string; costModel: string; pricing: string; currencyConversionsUsed: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; }; default: not declared - allocatePortfolio().return.assumptions.conventionsVersion: string; default: not declared - allocatePortfolio().return.assumptions.costModel: string; default: not declared - allocatePortfolio().return.assumptions.currencyConversionsUsed: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared - allocatePortfolio().return.assumptions.pricing: string; default: not declared - allocatePortfolio().return.assumptions.rounding: string; default: not declared - allocatePortfolio().return.assumptions.targetSource: import('@insiderfinance/totalfinance/portfolio').ResolvedTargetSource; default: not declared - allocatePortfolio().return.baseCurrency: string; default: not declared - allocatePortfolio().return.cash: import('@insiderfinance/totalfinance/portfolio').AllocationCash; default: not declared - allocatePortfolio().return.diagnostics: { warnings: string[]; instrumentCount: number; tradeCount: number; dustCount: number; unresolvedCount: number; }; default: not declared - allocatePortfolio().return.diagnostics.dustCount: number; default: not declared - allocatePortfolio().return.diagnostics.instrumentCount: number; default: not declared - allocatePortfolio().return.diagnostics.tradeCount: number; default: not declared - allocatePortfolio().return.diagnostics.unresolvedCount: number; default: not declared - allocatePortfolio().return.diagnostics.warnings: string[]; default: not declared - allocatePortfolio().return.dust: import('@insiderfinance/totalfinance/portfolio').AllocationDustRow[]; default: not declared — Sorted by instrumentId. - allocatePortfolio().return.estimatedTransactionCost: number; default: not declared - allocatePortfolio().return.feasible: boolean; default: not declared — No unresolved target AND the buys are funded (cash residual ≥ 0). - allocatePortfolio().return.netAssetValue: number; default: not declared - allocatePortfolio().return.trades: import('@insiderfinance/totalfinance/portfolio').AllocationTrade[]; default: not declared — Sorted by instrumentId; dust and zero trades excluded. - allocatePortfolio().return.turnover: number; default: not declared — `Σ |trade notional| ÷ netAssetValue` (buys and sells both counted). - allocatePortfolio().return.unresolved: import('@insiderfinance/totalfinance/portfolio').UnresolvedTarget[]; default: not declared — Sorted by key, then reason. - allocatePortfolio(input): import('@insiderfinance/totalfinance/portfolio').AllocatePortfolioInput; default: not declared - allocatePortfolio(input).asOf: string | number; default: not declared — REQUIRED — model targets are dated; echoed on the result. - allocatePortfolio(input).baseCurrency: string; default: not declared - allocatePortfolio(input).cashReserve?: number; default: not declared — Base currency held back from the investable amount (≥ 0), on top of the cash target. - allocatePortfolio(input).contractMultipliers?: Record; default: not declared — Units of the underlying per unit of quantity, per instrument (slice 5): an option's 100, a futures contract size. Omitted = 1. Notional = quantity × price × multiplier; lot rounding stays on quantity. - allocatePortfolio(input).currencyConversions?: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared — FC5 quotes; required exactly when a priced instrument's currency ≠ `baseCurrency`. - allocatePortfolio(input).currentHoldings?: Record; default: not declared — Signed quantity per instrument; omitted = no holdings. - allocatePortfolio(input).defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - allocatePortfolio(input).instrumentClassification?: Record; default: not declared - allocatePortfolio(input).lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - allocatePortfolio(input).minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - allocatePortfolio(input).netAssetValue: number; default: not declared — The investable total in base currency (> 0). Weights are shares of this. - allocatePortfolio(input).policy: import('@insiderfinance/totalfinance/portfolio').InvestmentPolicy; default: not declared — Targets inline or via a model artifact (resolved at `asOf`). - allocatePortfolio(input).prices: Record; default: not declared — Per instrument. Required for every instrument with a target or a holding. - allocatePortfolio(input).transactionCosts?: import('@insiderfinance/totalfinance/portfolio').AllocationTransactionCosts; default: not declared - applyJournalEvents: (input: import('@insiderfinance/totalfinance/portfolio').ApplyJournalEventsInput) => import('@insiderfinance/totalfinance/portfolio').ApplyJournalEventsResult; default: not declared — Fold journal events onto a state (Decision 6). The transition table: - `proposed` / `preflighted` / `authorized` are accepted only before `submitted`; - `submitted` opens the order (its `detail.quantity` is the submitted quantity); - `acknowledged` follows `submitted` once; - `partially-filled` and `filled` carry `detail.fillId` and `detail.quantity`; a partial fill must leave quantity open, a fill must complete it; - `cancel-requested` flags the order, `cancelled` / `replaced` / `expired` / `rejected` close it; - `reconciled` marks any existing order; `unresolved` closes any existing order with a reason; - a fill on an order closed by cancellation, replacement, expiry, or rejection is a LATE FILL: the fill is recorded, the order becomes `unresolved` (terminal), and the result lists it. Any other sequence refuses with `trade.journal_transition_invalid`; a store appends only what folds. A duplicate `eventId` is skipped and reported. - applyJournalEvents().return.applied: number; default: not declared - applyJournalEvents().return.diagnostics: { warnings: string[]; eventCount: number; orderCount: number; duplicateCount: number; lateFillCount: number; unresolvedCount: number; }; default: not declared - applyJournalEvents().return.diagnostics.duplicateCount: number; default: not declared - applyJournalEvents().return.diagnostics.eventCount: number; default: not declared - applyJournalEvents().return.diagnostics.lateFillCount: number; default: not declared - applyJournalEvents().return.diagnostics.orderCount: number; default: not declared - applyJournalEvents().return.diagnostics.unresolvedCount: number; default: not declared - applyJournalEvents().return.diagnostics.warnings: string[]; default: not declared - applyJournalEvents().return.duplicates: string[]; default: not declared - applyJournalEvents().return.lateFills: { orderId: string; fillId: string; eventId: string; }[]; default: not declared - applyJournalEvents().return.state: import('@insiderfinance/totalfinance/portfolio').ExecutionJournalState; default: not declared - applyJournalEvents(input): import('@insiderfinance/totalfinance/portfolio').ApplyJournalEventsInput; default: not declared - applyJournalEvents(input).events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared - applyJournalEvents(input).previousState?: import('@insiderfinance/totalfinance/portfolio').ExecutionJournalState; default: not declared - applyPortfolioEvents: (input: import('@insiderfinance/totalfinance/portfolio').ApplyPortfolioEventsInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared — The direct pure reducer (FC7 required API; the agent-native doc's decided API ladder): fold `events` over a fresh `portfolio` definition or a `previousState`, returning a new deeply frozen {@link PortfolioState}. Laws (tested in `test/apply.test.ts`): - **replay determinism** — same events, same order → deep-equal state; - **duplicate idempotence** — an already-applied `(sourceId, eventId)` with an identical body (content hash, provenance excluded) is a no-op; - **conflict detection** — a same-key body change throws `portfolio.duplicate_event_conflict`; - **ordering** — events fold in array order and must be non-decreasing in `effectiveTimestampMs` (ties keep array order); - **immutability** — neither `previousState` nor any envelope is mutated; the result owns its own frozen tree. - applyPortfolioEvents().return.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - applyPortfolioEvents().return.accounts: Record; default: not declared - applyPortfolioEvents().return.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - applyPortfolioEvents().return.baseCurrency: string; default: not declared - applyPortfolioEvents().return.eventCount: number; default: not declared - applyPortfolioEvents().return.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - applyPortfolioEvents().return.lastEffectiveTimestampMs: number | null; default: not declared - applyPortfolioEvents().return.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - applyPortfolioEvents().return.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - applyPortfolioEvents().return.portfolioId?: string; default: not declared - applyPortfolioEvents().return.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - applyPortfolioEvents().return.schemaVersion: number; default: not declared - applyPortfolioEvents(input): import('@insiderfinance/totalfinance/portfolio').ApplyPortfolioEventsInput; default: not declared - applyPortfolioEvents(input).events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - applyPortfolioEvents(input).portfolio?: import('@insiderfinance/totalfinance/portfolio').PortfolioDefinition; default: not declared - applyPortfolioEvents(input).previousState?: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - compareDisclosedHoldingPartitions: (input: import('@insiderfinance/totalfinance/portfolio').CompareDisclosedHoldingPartitionsInput) => import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsReport; default: not declared — Compare supplied reported partitions without treating discretion redistribution as a position change. - compareDisclosedHoldingPartitions().return.assumptions: { policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsPolicy; profile: string; discretion: string; denominator: string; rounding: string; changes: string; partitionBasis: string; }; default: not declared - compareDisclosedHoldingPartitions().return.assumptions.changes: string; default: not declared - compareDisclosedHoldingPartitions().return.assumptions.denominator: string; default: not declared - compareDisclosedHoldingPartitions().return.assumptions.discretion: string; default: not declared - compareDisclosedHoldingPartitions().return.assumptions.partitionBasis: string; default: not declared - compareDisclosedHoldingPartitions().return.assumptions.policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsPolicy; default: not declared — Validated policy used for this report, copied independently of the caller's request. - compareDisclosedHoldingPartitions().return.assumptions.profile: string; default: not declared - compareDisclosedHoldingPartitions().return.assumptions.rounding: string; default: not declared - compareDisclosedHoldingPartitions().return.baseline: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsSnapshotReport; default: not declared - compareDisclosedHoldingPartitions().return.changes: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionChange[]; default: not declared - compareDisclosedHoldingPartitions().return.comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - compareDisclosedHoldingPartitions().return.current: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsSnapshotReport; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics: { status: 'complete' | 'review'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; baselineHoldingCount: number; currentHoldingCount: number; changeCount: number; baselinePartitionCount: number; currentPartitionCount: number; uncomparedPartitionCount: number; }; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.baselineHoldingCount: number; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.baselinePartitionCount: number; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.changeCount: number; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.currentHoldingCount: number; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.currentPartitionCount: number; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.status: 'complete' | 'review'; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.uncomparedPartitionCount: number; default: not declared - compareDisclosedHoldingPartitions().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - compareDisclosedHoldingPartitions().return.policyVersion: 'disclosed-holding-partitions-v1'; default: not declared - compareDisclosedHoldingPartitions().return.uncomparedPartitions: import('@insiderfinance/totalfinance/portfolio').DisclosedUncomparedHoldingPartition[]; default: not declared - compareDisclosedHoldingPartitions(input): import('@insiderfinance/totalfinance/portfolio').CompareDisclosedHoldingPartitionsInput; default: not declared - compareDisclosedHoldingPartitions(input).baseline: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsSnapshot; default: not declared - compareDisclosedHoldingPartitions(input).comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - compareDisclosedHoldingPartitions(input).current: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsSnapshot; default: not declared - compareDisclosedHoldingPartitions(input).policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsPolicy; default: not declared - compareDisclosedHoldings: (input: import('@insiderfinance/totalfinance/portfolio').CompareDisclosedHoldingsInput) => import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsReport; default: not declared — Compare supplied reported holdings; exact decimal quantities and values are never inferred trades. A complete supported universe establishes absence; incomplete/unsupported evidence stays visible with withheld deltas or ratios. Source/system cutoffs belong in the caller's artifact envelope. - compareDisclosedHoldings().return.assumptions: { policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsPolicy; profile: string; discretion: string; denominator: string; rounding: string; changes: string; }; default: not declared - compareDisclosedHoldings().return.assumptions.changes: string; default: not declared - compareDisclosedHoldings().return.assumptions.denominator: string; default: not declared - compareDisclosedHoldings().return.assumptions.discretion: string; default: not declared - compareDisclosedHoldings().return.assumptions.policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsPolicy; default: not declared — Validated policy used for this report, copied independently of the caller's request. - compareDisclosedHoldings().return.assumptions.profile: string; default: not declared - compareDisclosedHoldings().return.assumptions.rounding: string; default: not declared - compareDisclosedHoldings().return.baseline: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsSnapshotReport; default: not declared - compareDisclosedHoldings().return.changes: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingChange[]; default: not declared - compareDisclosedHoldings().return.comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - compareDisclosedHoldings().return.current: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsSnapshotReport; default: not declared - compareDisclosedHoldings().return.diagnostics: { status: 'complete' | 'review'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; baselineHoldingCount: number; currentHoldingCount: number; changeCount: number; }; default: not declared - compareDisclosedHoldings().return.diagnostics.baselineHoldingCount: number; default: not declared - compareDisclosedHoldings().return.diagnostics.changeCount: number; default: not declared - compareDisclosedHoldings().return.diagnostics.currentHoldingCount: number; default: not declared - compareDisclosedHoldings().return.diagnostics.status: 'complete' | 'review'; default: not declared - compareDisclosedHoldings().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - compareDisclosedHoldings().return.policyVersion: 'disclosed-holdings-v1'; default: not declared - compareDisclosedHoldings(input): import('@insiderfinance/totalfinance/portfolio').CompareDisclosedHoldingsInput; default: not declared - compareDisclosedHoldings(input).baseline: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsSnapshot; default: not declared - compareDisclosedHoldings(input).comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - compareDisclosedHoldings(input).current: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsSnapshot; default: not declared - compareDisclosedHoldings(input).policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsPolicy; default: not declared - createAuthorizationGrant: (input: import('@insiderfinance/totalfinance/portfolio').CreateAuthorizationGrantInput) => import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared — Mint a grant (Decision 5). Refuses a preflight whose decision is `deny` (`trade.preflight_denied`), a plan the preflight did not judge, a portfolio or market hash that differs from the preflight's, an account the plan is not for (`trade.grant_invalid`), an expiry not after `now` (`trade.grant_expired`), and `mode: 'live'` (`trade.live_unavailable`). A `require-approval` preflight carries its scope into the grant; the runtime (slice 4) checks the approver holds it. - createAuthorizationGrant().return.accountId: string; default: not declared - createAuthorizationGrant().return.approvedBy: string; default: not declared - createAuthorizationGrant().return.baseCurrency: string; default: not declared - createAuthorizationGrant().return.comboIds: string[]; default: not declared — The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. - createAuthorizationGrant().return.contentHash: string; default: not declared - createAuthorizationGrant().return.expiresAt: number; default: not declared - createAuthorizationGrant().return.grantId: string; default: not declared - createAuthorizationGrant().return.idempotencyKeys: string[]; default: not declared — The closed set of submission keys this grant licenses — one per attempt. - createAuthorizationGrant().return.issuedAt: number; default: not declared - createAuthorizationGrant().return.kind: 'totalfinance.authorization-grant'; default: not declared - createAuthorizationGrant().return.marketAsOf: number; default: not declared — The market instant the preflight judged; execution must not see an older market. - createAuthorizationGrant().return.marketHash: string; default: not declared - createAuthorizationGrant().return.marketMaximumAgeMs: number; default: not declared — At execution the market may be at most this old (`now − marketAsOf`). - createAuthorizationGrant().return.mode: 'paper'; default: not declared - createAuthorizationGrant().return.orderIds: string[]; default: not declared — The plan's order ids, in plan order. - createAuthorizationGrant().return.planHash: string; default: not declared - createAuthorizationGrant().return.portfolioHash: string; default: not declared - createAuthorizationGrant().return.preflightHash: string; default: not declared - createAuthorizationGrant().return.requiredScope: string | null; default: not declared — The scope the preflight asked for (`require-approval`), or null when it allowed outright. - createAuthorizationGrant().return.schemaVersion: 1; default: not declared - createAuthorizationGrant().return.variance: import('@insiderfinance/totalfinance/portfolio/trade').GrantVariance; default: not declared - createAuthorizationGrant(input): import('@insiderfinance/totalfinance/portfolio').CreateAuthorizationGrantInput; default: not declared - createAuthorizationGrant(input).account?: string; default: not declared — Defaults to the plan's account; given, it must match. - createAuthorizationGrant(input).approvedBy: string; default: not declared - createAuthorizationGrant(input).expiresAt: number; default: not declared - createAuthorizationGrant(input).grantId?: string; default: not declared — Default `grant::`. - createAuthorizationGrant(input).idempotencyKeys: string[] | { prefix: string; count: number; }; default: not declared - createAuthorizationGrant(input).idempotencyKeys.count: number; default: not declared - createAuthorizationGrant(input).idempotencyKeys.prefix: string; default: not declared - createAuthorizationGrant(input).marketHash?: string; default: not declared — Defaults to the preflight's; given, it must match. - createAuthorizationGrant(input).marketMaximumAgeMs: number; default: not declared - createAuthorizationGrant(input).mode: 'paper'; default: not declared - createAuthorizationGrant(input).now: number; default: not declared — The issue instant — supplied, never read from a clock. - createAuthorizationGrant(input).plan: import('@insiderfinance/totalfinance/portfolio').ExecutionPlan; default: not declared - createAuthorizationGrant(input).portfolioHash?: string; default: not declared — Defaults to the preflight's; given, it must match (a grant binds what preflight saw). - createAuthorizationGrant(input).preflight: import('@insiderfinance/totalfinance/portfolio').PreflightReport; default: not declared - createAuthorizationGrant(input).variance: import('@insiderfinance/totalfinance/portfolio/trade').GrantVariance; default: not declared - createModelPortfolio: (definition: import('@insiderfinance/totalfinance/portfolio').ModelPortfolioDefinition) => import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared — Freeze a {@link ModelPortfolioDefinition} into an immutable, content-addressed {@link ModelPortfolio} artifact. The definition is fully validated first; the hash covers everything (a changed target is a different model). - createModelPortfolio().return.baseCurrency: string; default: not declared - createModelPortfolio().return.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - createModelPortfolio().return.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - createModelPortfolio().return.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - createModelPortfolio().return.horizonEndDate?: string | number; default: not declared - createModelPortfolio().return.kind: 'totalfinance.model-portfolio'; default: not declared - createModelPortfolio().return.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - createModelPortfolio().return.modelId: string; default: not declared - createModelPortfolio().return.note?: string; default: not declared - createModelPortfolio().return.schemaVersion: number; default: not declared - createModelPortfolio().return.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - createModelPortfolio().return.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - createModelPortfolio().return.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - createModelPortfolio().return.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - createModelPortfolio(definition): import('@insiderfinance/totalfinance/portfolio').ModelPortfolioDefinition; default: not declared - createModelPortfolio(definition).baseCurrency: string; default: not declared - createModelPortfolio(definition).benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - createModelPortfolio(definition).glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - createModelPortfolio(definition).horizonEndDate?: string | number; default: not declared - createModelPortfolio(definition).liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - createModelPortfolio(definition).modelId: string; default: not declared - createModelPortfolio(definition).note?: string; default: not declared - createModelPortfolio(definition).sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - createModelPortfolio(definition).strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - createModelPortfolio(definition).tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - createModelPortfolio(definition).version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - createPortfolioLedger: (input: import('@insiderfinance/totalfinance/portfolio').CreatePortfolioLedgerInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; default: not declared — Build the immutable ledger artifact from a definition and its economic events. Validates every envelope, folds the state through `applyPortfolioEvents` (the ONE reducer — no second engine), and returns a frozen artifact whose serialized form rides the Gate B spine. - createPortfolioLedger().return.apply: (events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]) => import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; default: not declared — Fold more events and return a NEW immutable ledger; this one is untouched. - createPortfolioLedger().return.baseCurrency: string; default: not declared - createPortfolioLedger().return.events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — The applied economic events, canonical and frozen. Identical no-op replays are not stored. - createPortfolioLedger().return.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - createPortfolioLedger().return.pnl: (input: Omit) => import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult; default: not declared — `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). - createPortfolioLedger().return.portfolioId?: string; default: not declared - createPortfolioLedger().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - createPortfolioLedger().return.state: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared — The derived state — the fold of `events` under `lotRelief`. - createPortfolioLedger().return.timeline: (input: Omit) => import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared — `portfolioTimeline` over this ledger (slice 2). - createPortfolioLedger().return.toJSON: () => import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared — The serialized envelope (also what `JSON.stringify(ledger)` emits). - createPortfolioLedger(input): import('@insiderfinance/totalfinance/portfolio').CreatePortfolioLedgerInput; default: not declared - createPortfolioLedger(input).baseCurrency: string; default: not declared - createPortfolioLedger(input).events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - createPortfolioLedger(input).lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Defaults to `'fifo'`; echoed on the artifact, the state, and every serialized envelope. - createPortfolioLedger(input).portfolioId?: string; default: not declared - createPortfolioLedger(input).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - duplicateBoundaryKey: (envelope: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope) => string; default: not declared — The `(sourceId, eventId)` duplicate-boundary key — the exact registry key `PortfolioState` records under `appliedEvents`, exposed so stores and importers can pre-check delivery without re-deriving the encoding. - duplicateBoundaryKey(envelope): import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope; default: not declared - duplicateBoundaryKey(envelope).accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - duplicateBoundaryKey(envelope).causationId?: string; default: not declared - duplicateBoundaryKey(envelope).correlationId?: string; default: not declared - duplicateBoundaryKey(envelope).effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - duplicateBoundaryKey(envelope).event: import('@insiderfinance/totalfinance/portfolio').PortfolioEvent; default: not declared - duplicateBoundaryKey(envelope).eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - duplicateBoundaryKey(envelope).eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - duplicateBoundaryKey(envelope).provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - duplicateBoundaryKey(envelope).recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - duplicateBoundaryKey(envelope).reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - duplicateBoundaryKey(envelope).schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - duplicateBoundaryKey(envelope).sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - isModelPortfolio: (value: unknown) => value is import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared — Whether a value is a structurally valid, untampered model artifact (a predicate: never throws). - isModelPortfolio(value): unknown; default: not declared - isPortfolioLedgerSnapshot: (value: unknown) => value is import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared — Structural test for a (current-version) serialized ledger envelope. - isPortfolioLedgerSnapshot(value): unknown; default: not declared - mergeTradePolicies: (input: import('@insiderfinance/totalfinance/portfolio/trade').MergeTradePoliciesInput) => import('@insiderfinance/totalfinance/portfolio').TradePolicy; default: not declared — The stricter of every policy given: the minimum of each bound, the intersection of each allow list, the stricter unverifiable handling. - mergeTradePolicies().return.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a plan that leaves an option net short (a call uncovered) is denied. - mergeTradePolicies().return.allowedAccounts?: string[]; default: not declared - mergeTradePolicies().return.allowedAssetClasses?: string[]; default: not declared - mergeTradePolicies().return.allowedInstruments?: string[]; default: not declared - mergeTradePolicies().return.allowedOrderTypes?: import('@insiderfinance/totalfinance/core').OrderType[]; default: not declared - mergeTradePolicies().return.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - mergeTradePolicies().return.marketMaximumAgeMs?: number; default: not declared - mergeTradePolicies().return.maximumEstimatedCost?: number; default: not declared — Base currency, the plan's total estimated commission + spread + slippage. - mergeTradePolicies().return.maximumOrderNotional?: number; default: not declared - mergeTradePolicies().return.maximumOrderQuantity?: number; default: not declared - mergeTradePolicies().return.maximumParticipation?: number; default: not declared - mergeTradePolicies().return.maximumSlippageBps?: number; default: not declared - mergeTradePolicies().return.maximumTurnover?: number; default: not declared — Traded notional ÷ NAV before the plan. - mergeTradePolicies().return.mode: 'paper'; default: not declared — The only mode this stage accepts; `'live'` is a typed refusal naming AT8. - mergeTradePolicies().return.onUnverifiable?: 'require-approval' | 'deny'; default: not declared — What an unverifiable check does to the decision (default `'require-approval'`). - mergeTradePolicies().return.requireApprovalAbove?: { notional?: number; quantity?: number; }; default: not declared — Above either bound the decision is `require-approval` rather than `allow`. - mergeTradePolicies().return.requireApprovalAbove.notional?: number; default: not declared - mergeTradePolicies().return.requireApprovalAbove.quantity?: number; default: not declared - mergeTradePolicies(input): import('@insiderfinance/totalfinance/portfolio/trade').MergeTradePoliciesInput; default: not declared - mergeTradePolicies(input).policies: readonly import('@insiderfinance/totalfinance/portfolio').TradePolicy[]; default: not declared - monitorPortfolio: (input: import('@insiderfinance/totalfinance/portfolio').MonitorPortfolioInput) => import('@insiderfinance/totalfinance/portfolio').MonitorPortfolioResult; default: not declared — Evaluate one explicit valuation against the policy and the prior monitor state — see the module comment for the decisions. Pure: same inputs, same alerts and state. - monitorPortfolio().return.alerts: import('@insiderfinance/totalfinance/portfolio').MonitorAlert[]; default: not declared — Raised / active / acknowledged / suppressed / cleared entries only, sorted by key. - monitorPortfolio().return.asOf: number; default: not declared - monitorPortfolio().return.assumptions: { conventionsVersion: string; liquidityParticipationRate: number; conventions: string; rulesApplied: Record; }; default: not declared - monitorPortfolio().return.assumptions.conventions: string; default: not declared — Prose statement of every convention. String-typed by design. - monitorPortfolio().return.assumptions.conventionsVersion: string; default: not declared - monitorPortfolio().return.assumptions.liquidityParticipationRate: number; default: not declared - monitorPortfolio().return.assumptions.rulesApplied: Record; default: not declared - monitorPortfolio().return.baseCurrency: string; default: not declared - monitorPortfolio().return.diagnostics: { warnings: string[]; unsupportedFamilies: { family: import('@insiderfinance/totalfinance/portfolio').MonitorDeferredFamily; reason: string; }[]; raisedCount: number; activeCount: number; clearedCount: number; suppressedCount: number; acknowledgedCount: number; }; default: not declared - monitorPortfolio().return.diagnostics.acknowledgedCount: number; default: not declared - monitorPortfolio().return.diagnostics.activeCount: number; default: not declared — Rules active AFTER this evaluation (raised, active, acknowledged, and carried-forward). - monitorPortfolio().return.diagnostics.clearedCount: number; default: not declared - monitorPortfolio().return.diagnostics.raisedCount: number; default: not declared - monitorPortfolio().return.diagnostics.suppressedCount: number; default: not declared - monitorPortfolio().return.diagnostics.unsupportedFamilies: { family: import('@insiderfinance/totalfinance/portfolio').MonitorDeferredFamily; reason: string; }[]; default: not declared - monitorPortfolio().return.diagnostics.warnings: string[]; default: not declared - monitorPortfolio().return.evaluated: import('@insiderfinance/totalfinance/portfolio').MonitorFamilyEvaluation[]; default: not declared — One row per family, in the family order. - monitorPortfolio().return.netAssetValue: number | null; default: not declared - monitorPortfolio().return.state: import('@insiderfinance/totalfinance/portfolio').PortfolioMonitorState; default: not declared - monitorPortfolio(input): import('@insiderfinance/totalfinance/portfolio').MonitorPortfolioInput; default: not declared - monitorPortfolio(input).acknowledgments?: string[]; default: not declared — Alert keys the host acknowledged since `previousState`. - monitorPortfolio(input).asOf: string | number; default: not declared — The evaluation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. - monitorPortfolio(input).assignmentRiskMoneyness?: number; default: not declared — Moneyness (a decimal of the strike; positive = in the money) above which a SHORT option is at risk of assignment — the `assignment-risk` family's bound. A negative value alerts while still out of the money. Skipped without one (or a rule threshold). - monitorPortfolio(input).averageDailyVolumes?: Record; default: not declared — Units per day per instrument — the liquidity family's denominator. - monitorPortfolio(input).currencyConversions?: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared - monitorPortfolio(input).instrumentClassification?: Record; default: not declared - monitorPortfolio(input).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared - monitorPortfolio(input).marketStalenessLimitMs?: number; default: not declared — A mark observed before `asOf − marketStalenessLimitMs` is stale. - monitorPortfolio(input).optionExpirationWarningDays?: number; default: not declared — Days to expiry (≥ 0) at or below which an option position is near expiry — the `option-expiration` family's bound (direction below). Skipped without one (or a rule threshold). - monitorPortfolio(input).pnl?: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult; default: not declared - monitorPortfolio(input).policy: import('@insiderfinance/totalfinance/portfolio').InvestmentPolicy; default: not declared - monitorPortfolio(input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - monitorPortfolio(input).previousState: import('@insiderfinance/totalfinance/portfolio').PortfolioMonitorState | null; default: not declared — REQUIRED: the prior evaluation's `state`, or `null` for the first evaluation. - monitorPortfolio(input).previousState.asOf: number; default: not declared - monitorPortfolio(input).previousState.evaluationCount: number; default: not declared - monitorPortfolio(input).previousState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - monitorPortfolio(input).previousState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - monitorPortfolio(input).previousState.rules: Record; default: not declared - monitorPortfolio(input).previousState.schemaVersion: number; default: not declared - monitorPortfolio(input).reconciliation?: import('@insiderfinance/totalfinance/portfolio').ReconcilePortfolioResult; default: not declared - monitorPortfolio(input).residualTolerance?: number; default: not declared — Base-currency amount above which `|pnl.residual|` is unexplained. - monitorPortfolio(input).rules?: Partial>; default: not declared - monitorPortfolio(input).unusualPnlThreshold?: number; default: not declared — Decimal of NAV above which `|pnl.components.totalPnl| ÷ NAV` is unusual. - normalizeTradePlan: (input: import('@insiderfinance/totalfinance/portfolio/trade').NormalizeTradePlanInput) => import('@insiderfinance/totalfinance/portfolio').ExecutionPlan; default: not declared - normalizeTradePlan().return.accountId: string; default: not declared - normalizeTradePlan().return.asOf: number; default: not declared - normalizeTradePlan().return.baseCurrency: string; default: not declared - normalizeTradePlan().return.combos: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - normalizeTradePlan().return.contentHash: string; default: not declared - normalizeTradePlan().return.evidence: string[]; default: not declared - normalizeTradePlan().return.kind: 'totalfinance.execution-plan'; default: not declared - normalizeTradePlan().return.orders: import('@insiderfinance/totalfinance/portfolio').TradeOrder[]; default: not declared - normalizeTradePlan().return.portfolioId?: string; default: not declared - normalizeTradePlan().return.rationale?: string; default: not declared - normalizeTradePlan().return.schemaVersion: number; default: not declared - normalizeTradePlan().return.source: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanSource; default: not declared - normalizeTradePlan().return.trades: import('@insiderfinance/totalfinance/portfolio').TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. - normalizeTradePlan(input): import('@insiderfinance/totalfinance/portfolio/trade').NormalizeTradePlanInput; default: not declared - normalizeTradePlan(input).accountId?: string; default: not declared - normalizeTradePlan(input).asOf: string | number; default: not declared - normalizeTradePlan(input).currencyConversions?: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared - normalizeTradePlan(input).evidence?: string[]; default: not declared - normalizeTradePlan(input).instruments?: Record; default: not declared - normalizeTradePlan(input).intent?: import('@insiderfinance/totalfinance/portfolio').TradeIntent; default: not declared - normalizeTradePlan(input).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared - normalizeTradePlan(input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - normalizeTradePlan(input).proposal?: import('@insiderfinance/totalfinance/portfolio').TradePlanArtifact; default: not declared - normalizeTradePlan(input).rationale?: string; default: not declared - portfolioEventContentHash: (envelope: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope) => string; default: not declared — The event's content identity and the CONFLICT boundary for duplicate `(sourceId, eventId)` delivery: the `sha256:` content hash (Gate B canonical JSON) of the envelope EXCLUDING `provenance` — two deliveries of the same economic fact under different source labels are the SAME event (Gate B Decision 3: provenance is outside every identity). The envelope is fully validated first; a malformed envelope never acquires a confident-looking hash. - portfolioEventContentHash(envelope): import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope; default: not declared - portfolioEventContentHash(envelope).accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - portfolioEventContentHash(envelope).causationId?: string; default: not declared - portfolioEventContentHash(envelope).correlationId?: string; default: not declared - portfolioEventContentHash(envelope).effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - portfolioEventContentHash(envelope).event: import('@insiderfinance/totalfinance/portfolio').PortfolioEvent; default: not declared - portfolioEventContentHash(envelope).eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - portfolioEventContentHash(envelope).eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - portfolioEventContentHash(envelope).provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - portfolioEventContentHash(envelope).recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - portfolioEventContentHash(envelope).reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - portfolioEventContentHash(envelope).schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - portfolioEventContentHash(envelope).sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - portfolioEventsFromFill: (input: import('@insiderfinance/totalfinance/portfolio').PortfolioEventsFromFillInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — Map one {@link NormalizedFill} to the economic events the ledger folds: exactly one `trade.fill` (id = `fillId`) followed by one `cost.charge` per non-zero cost component (id = `:cost:`, `relatesToEventId` = the fill), in the fixed order commission → exchange fees → regulatory fees → slippage adjustment. The mapping is deterministic and the ids are derived from the fill, so an identical fill delivered twice folds once (the ledger's duplicate boundary) and a replay emits identical envelopes. Every envelope passes the same validator a hand-written one would. - portfolioEventsFromFill(input): import('@insiderfinance/totalfinance/portfolio').PortfolioEventsFromFillInput; default: not declared - portfolioEventsFromFill(input).fill: import('@insiderfinance/totalfinance/portfolio').NormalizedFill; default: not declared - portfolioEventsFromFill(input).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Where the fill came from; `{}` when there is no further detail. Outside the event identity. - portfolioEventsFromFill(input).recordedTimestampMs: number; default: not declared — When the events are recorded — supplied, never read from a clock. - portfolioEventsFromFill(input).sourceId: string; default: not declared — The system that produced the fill — `'backtest:'`, a broker import id, a paper account. - portfolioLedgerContentHash: (snapshot: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot) => string; default: not declared — The ledger's content identity: `sha256:` over the canonical envelope with `provenance` removed at BOTH levels — the ledger's own and every event's (Gate B Decision 3: identical economic facts from two vendors are the SAME ledger; dedup and replay comparison depend on that). `baseCurrency` and `lotRelief` ARE covered: they change the derived economics, so two ledgers differing only in relief policy must never collide. The envelope is fully validated through the read path first — a malformed envelope never acquires a confident-looking hash (the Gate B serial-landing lesson) — and identity is defined over the CURRENT grammar: hash an older stored version by reading it with its registered migrations and hashing `ledger.toJSON()`. - portfolioLedgerContentHash(snapshot): import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - portfolioLedgerContentHash(snapshot).baseCurrency: string; default: not declared - portfolioLedgerContentHash(snapshot).events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - portfolioLedgerContentHash(snapshot).kind: 'totalfinance.portfolio-ledger'; default: not declared - portfolioLedgerContentHash(snapshot).lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - portfolioLedgerContentHash(snapshot).portfolioId?: string; default: not declared - portfolioLedgerContentHash(snapshot).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - portfolioLedgerContentHash(snapshot).schemaVersion: number; default: not declared - portfolioPerformanceInputs: (input: import('@insiderfinance/totalfinance/portfolio').PortfolioPerformanceInputsInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioPerformanceInputsResult; default: not declared — Derive the EXACT `valuations` + `externalCashFlows` series FC4's flow-aware calls consume, from a ledger and explicit per-date marks. The identity test in `test/performance-seam.test.ts` proves ledger-derived series → `timeWeightedReturn`/`moneyWeightedReturn` equal the same FC4 calls on hand-built series (the FC7 exit-gate hook, closed in this slice). - portfolioPerformanceInputs().return.assumptions: { conventionsVersion: string; markInstant: string; flowMapping: string; }; default: not declared - portfolioPerformanceInputs().return.assumptions.conventionsVersion: string; default: not declared - portfolioPerformanceInputs().return.assumptions.flowMapping: string; default: not declared — Prose statement of which events are external flows and how they convert. - portfolioPerformanceInputs().return.assumptions.markInstant: string; default: not declared — Prose statement of the mark instant and its agreement with FC4's flow convention. - portfolioPerformanceInputs().return.diagnostics: { warnings: string[]; markCount: number; flowCount: number; excludedFlowCount: number; }; default: not declared - portfolioPerformanceInputs().return.diagnostics.excludedFlowCount: number; default: not declared — Deposits/withdrawals outside the [first, last] mark window — excluded, disclosed. - portfolioPerformanceInputs().return.diagnostics.flowCount: number; default: not declared - portfolioPerformanceInputs().return.diagnostics.markCount: number; default: not declared - portfolioPerformanceInputs().return.diagnostics.warnings: string[]; default: not declared - portfolioPerformanceInputs().return.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared — Feed directly as `externalCashFlows`; `label` carries the source `eventId`. - portfolioPerformanceInputs().return.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — Feed directly to `timeWeightedReturn` / `moneyWeightedReturn` as `valuations`. - portfolioPerformanceInputs(input): import('@insiderfinance/totalfinance/portfolio').PortfolioPerformanceInputsInput; default: not declared - portfolioPerformanceInputs(input).ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; default: not declared - portfolioPerformanceInputs(input).valuationMarks: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date — a return is measured BETWEEN valuations. - portfolioPnl: (input: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult; default: not declared — Reconciled P&L between two valuation marks — see the module comment for the identity and the conversion convention. Never mutates the ledger; every number is base currency unless the row says otherwise. - portfolioPnl().return.assumptions: { conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; identity: string; conversionConvention: string; residualTolerance: number; }; default: not declared - portfolioPnl().return.assumptions.conventionsVersion: string; default: not declared - portfolioPnl().return.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - portfolioPnl().return.assumptions.identity: string; default: not declared — The identity, stated. - portfolioPnl().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolioPnl().return.assumptions.residualTolerance: number; default: not declared - portfolioPnl().return.baseCurrency: string; default: not declared - portfolioPnl().return.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - portfolioPnl().return.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - portfolioPnl().return.diagnostics: { warnings: string[]; eventCount: number; residualWithinTolerance: boolean; }; default: not declared - portfolioPnl().return.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - portfolioPnl().return.diagnostics.residualWithinTolerance: boolean; default: not declared - portfolioPnl().return.diagnostics.warnings: string[]; default: not declared - portfolioPnl().return.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - portfolioPnl().return.from: { valuationDate: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; }; default: not declared - portfolioPnl().return.from.asOf: number; default: not declared - portfolioPnl().return.from.netAssetValue: number; default: not declared - portfolioPnl().return.from.valuationDate: string; default: not declared - portfolioPnl().return.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - portfolioPnl().return.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - portfolioPnl().return.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - portfolioPnl().return.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - portfolioPnl().return.to: { valuationDate: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; }; default: not declared - portfolioPnl().return.to.asOf: number; default: not declared - portfolioPnl().return.to.netAssetValue: number; default: not declared - portfolioPnl().return.to.valuationDate: string; default: not declared - portfolioPnl(input): import('@insiderfinance/totalfinance/portfolio').PortfolioPnlInput; default: not declared - portfolioPnl(input).from: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark; default: not declared - portfolioPnl(input).instrumentClassification?: Record; default: not declared - portfolioPnl(input).ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; default: not declared - portfolioPnl(input).to: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark; default: not declared - portfolioSnapshot: (input: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared — Value a portfolio state against an explicit market snapshot at an explicit instant. - portfolioSnapshot().return.asOf: number; default: not declared - portfolioSnapshot().return.assumptions: { conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; marketAsOf: import('@insiderfinance/totalfinance/core').EpochMs; currencyConversionsUsed: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; valuationConvention: string; }; default: not declared - portfolioSnapshot().return.assumptions.conventionsVersion: string; default: not declared - portfolioSnapshot().return.assumptions.currencyConversionsUsed: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - portfolioSnapshot().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - portfolioSnapshot().return.assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - portfolioSnapshot().return.assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - portfolioSnapshot().return.baseCurrency: string; default: not declared - portfolioSnapshot().return.cash: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - portfolioSnapshot().return.diagnostics: { warnings: string[]; accountCount: number; positionCount: number; }; default: not declared - portfolioSnapshot().return.diagnostics.accountCount: number; default: not declared - portfolioSnapshot().return.diagnostics.positionCount: number; default: not declared - portfolioSnapshot().return.diagnostics.warnings: string[]; default: not declared - portfolioSnapshot().return.netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - portfolioSnapshot().return.positions: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - portfolioSnapshot().return.totalCashBaseCurrencyValue: number; default: not declared - portfolioSnapshot().return.totalPositionsBaseCurrencyValue: number; default: not declared - portfolioSnapshot(input): import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotInput; default: not declared - portfolioSnapshot(input).asOf: string | number; default: not declared — The valuation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. - portfolioSnapshot(input).currencyConversions?: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared — Explicit valuation-time exchange-rate quotes (FC5 vocabulary), one per currency pair, in either orientation. Required exactly when the portfolio holds cash or positions outside its base currency. - portfolioSnapshot(input).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared — The Gate B market snapshot supplying instrument marks. - portfolioSnapshot(input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared — A derived {@link PortfolioState} (from `applyPortfolioEvents` or `ledger.state`). - portfolioTimeline: (input: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineInput) => import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared — NAV, cash, flows, exposure, drawdown, and P&L components through time — see the module comment. - portfolioTimeline().return.assumptions: { conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; indexConvention: string; exposureConvention: string; }; default: not declared - portfolioTimeline().return.assumptions.conventionsVersion: string; default: not declared - portfolioTimeline().return.assumptions.exposureConvention: string; default: not declared - portfolioTimeline().return.assumptions.indexConvention: string; default: not declared - portfolioTimeline().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolioTimeline().return.assumptions.markInstant: string; default: not declared - portfolioTimeline().return.baseCurrency: string; default: not declared - portfolioTimeline().return.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - portfolioTimeline().return.cumulativePnl.financing: number; default: not declared - portfolioTimeline().return.cumulativePnl.foreignExchangePnl: number; default: not declared - portfolioTimeline().return.cumulativePnl.income: number; default: not declared - portfolioTimeline().return.cumulativePnl.realizedPnl: number; default: not declared - portfolioTimeline().return.cumulativePnl.residual: number; default: not declared - portfolioTimeline().return.cumulativePnl.totalPnl: number; default: not declared - portfolioTimeline().return.cumulativePnl.transactionCosts: number; default: not declared - portfolioTimeline().return.cumulativePnl.unrealizedPnl: number; default: not declared - portfolioTimeline().return.diagnostics: { warnings: string[]; markCount: number; indexWithheldReason?: string; gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; }; default: not declared - portfolioTimeline().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - portfolioTimeline().return.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - portfolioTimeline().return.diagnostics.markCount: number; default: not declared - portfolioTimeline().return.diagnostics.warnings: string[]; default: not declared - portfolioTimeline().return.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - portfolioTimeline().return.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - portfolioTimeline().return.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - portfolioTimeline().return.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - portfolioTimeline(input): import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineInput; default: not declared - portfolioTimeline(input).instrumentClassification?: Record; default: not declared - portfolioTimeline(input).ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; default: not declared - portfolioTimeline(input).valuationMarks: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. - preflightTradePlan: (input: import('@insiderfinance/totalfinance/portfolio/trade').PreflightTradePlanInput) => import('@insiderfinance/totalfinance/portfolio').PreflightReport; default: not declared - preflightTradePlan().return.after: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared - preflightTradePlan().return.alerts: import('@insiderfinance/totalfinance/portfolio').MonitorAlert[]; default: not declared - preflightTradePlan().return.asOf: number; default: not declared - preflightTradePlan().return.assumptions: { conventionsVersion: string; policyContentHash: string; mode: 'paper'; costRates: Required; fillConvention: string; instrumentSources: Record; decisionConvention: string; }; default: not declared - preflightTradePlan().return.assumptions.conventionsVersion: string; default: not declared - preflightTradePlan().return.assumptions.costRates: Required; default: not declared - preflightTradePlan().return.assumptions.costRates.commissionBps: number; default: not declared - preflightTradePlan().return.assumptions.costRates.commissionPerOrder: number; default: not declared - preflightTradePlan().return.assumptions.costRates.slippageBps: number; default: not declared - preflightTradePlan().return.assumptions.costRates.spreadBps: number; default: not declared - preflightTradePlan().return.assumptions.decisionConvention: string; default: not declared - preflightTradePlan().return.assumptions.fillConvention: string; default: not declared - preflightTradePlan().return.assumptions.instrumentSources: Record; default: not declared — Where each instrument's currency and multiplier came from: the ledger position, the caller's description, or the market spot (priced as a plain cash instrument). - preflightTradePlan().return.assumptions.mode: 'paper'; default: not declared - preflightTradePlan().return.assumptions.policyContentHash: string; default: not declared - preflightTradePlan().return.before: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared - preflightTradePlan().return.checks: import('@insiderfinance/totalfinance/portfolio').PolicyCheck[]; default: not declared - preflightTradePlan().return.contentHash: string; default: not declared - preflightTradePlan().return.decision: import('@insiderfinance/totalfinance/portfolio').PolicyDecision; default: not declared - preflightTradePlan().return.diagnostics: { engine: 'trade-preflight'; method: 'hypothetical-fold'; converged: true; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; checkCount: number; failedCount: number; unverifiableCount: number; }; default: not declared - preflightTradePlan().return.diagnostics.checkCount: number; default: not declared - preflightTradePlan().return.diagnostics.converged: true; default: not declared - preflightTradePlan().return.diagnostics.engine: 'trade-preflight'; default: not declared - preflightTradePlan().return.diagnostics.failedCount: number; default: not declared - preflightTradePlan().return.diagnostics.method: 'hypothetical-fold'; default: not declared - preflightTradePlan().return.diagnostics.unverifiableCount: number; default: not declared - preflightTradePlan().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - preflightTradePlan().return.estimates: import('@insiderfinance/totalfinance/portfolio/trade').PreflightEstimates; default: not declared - preflightTradePlan().return.hypotheticalEvents: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - preflightTradePlan().return.hypotheticalFills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared — The hypothetical fills the after-state was folded from. - preflightTradePlan().return.kind: 'totalfinance.preflight-report'; default: not declared - preflightTradePlan().return.marketAsOf: number; default: not declared - preflightTradePlan().return.marketHash: string; default: not declared - preflightTradePlan().return.monitorState: import('@insiderfinance/totalfinance/portfolio').PortfolioMonitorState | null; default: not declared - preflightTradePlan().return.monitorState.asOf: number; default: not declared - preflightTradePlan().return.monitorState.evaluationCount: number; default: not declared - preflightTradePlan().return.monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - preflightTradePlan().return.monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - preflightTradePlan().return.monitorState.rules: Record; default: not declared - preflightTradePlan().return.monitorState.schemaVersion: number; default: not declared - preflightTradePlan().return.planHash: string; default: not declared - preflightTradePlan().return.portfolioHash: string; default: not declared - preflightTradePlan().return.schemaVersion: number; default: not declared - preflightTradePlan().return.unverifiable: string[]; default: not declared - preflightTradePlan(input): import('@insiderfinance/totalfinance/portfolio/trade').PreflightTradePlanInput; default: not declared - preflightTradePlan(input).asOf: string | number; default: not declared - preflightTradePlan(input).averageDailyVolumes?: Record; default: not declared - preflightTradePlan(input).costs?: import('@insiderfinance/totalfinance/portfolio/trade').PreflightCostRates; default: not declared - preflightTradePlan(input).currencyConversions?: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared - preflightTradePlan(input).instruments?: Record; default: not declared - preflightTradePlan(input).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared - preflightTradePlan(input).monitorState?: import('@insiderfinance/totalfinance/portfolio').PortfolioMonitorState | null; default: not declared — The monitor state carried from the previous evaluation, when the caller keeps one. - preflightTradePlan(input).monitorState.asOf: number; default: not declared - preflightTradePlan(input).monitorState.evaluationCount: number; default: not declared - preflightTradePlan(input).monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - preflightTradePlan(input).monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - preflightTradePlan(input).monitorState.rules: Record; default: not declared - preflightTradePlan(input).monitorState.schemaVersion: number; default: not declared - preflightTradePlan(input).openOrders?: import('@insiderfinance/totalfinance/portfolio').TradeOrder[]; default: not declared — Orders already open in the journal; a plan that repeats one is a conflict. - preflightTradePlan(input).plan: import('@insiderfinance/totalfinance/portfolio').ExecutionPlan; default: not declared - preflightTradePlan(input).policy: import('@insiderfinance/totalfinance/portfolio').TradePolicy; default: not declared - preflightTradePlan(input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - preflightTradePlan(input).session?: import('@insiderfinance/totalfinance/portfolio/trade').PreflightSession; default: not declared - proposePortfolioRebalance: (input: import('@insiderfinance/totalfinance/portfolio').ProposePortfolioRebalanceInput) => import('@insiderfinance/totalfinance/portfolio').ProposePortfolioRebalanceResult; default: not declared — Propose a rebalance of the ledger's managed book toward the policy's targets at `asOf` — a plan, never an execution. See the module comment for the laws and the accepted example. - proposePortfolioRebalance().return.asOf: number; default: not declared - proposePortfolioRebalance().return.assumptions: { conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; targetSource: import('@insiderfinance/totalfinance/portfolio').ResolvedTargetSource; scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; flowHandling: string; rounding: string; costModel: string; liquidityParticipationRate: number; conventions: string; }; default: not declared - proposePortfolioRebalance().return.assumptions.conventions: string; default: not declared - proposePortfolioRebalance().return.assumptions.conventionsVersion: string; default: not declared - proposePortfolioRebalance().return.assumptions.costModel: string; default: not declared - proposePortfolioRebalance().return.assumptions.flowHandling: string; default: not declared - proposePortfolioRebalance().return.assumptions.liquidityParticipationRate: number; default: not declared - proposePortfolioRebalance().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - proposePortfolioRebalance().return.assumptions.rounding: string; default: not declared - proposePortfolioRebalance().return.assumptions.scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; default: not declared - proposePortfolioRebalance().return.assumptions.targetSource: import('@insiderfinance/totalfinance/portfolio').ResolvedTargetSource; default: not declared - proposePortfolioRebalance().return.baseCurrency: string; default: not declared - proposePortfolioRebalance().return.cash: import('@insiderfinance/totalfinance/portfolio').RebalanceCashSummary; default: not declared - proposePortfolioRebalance().return.convergence: { converged: boolean; iterations: number; }; default: not declared - proposePortfolioRebalance().return.convergence.converged: boolean; default: not declared - proposePortfolioRebalance().return.convergence.iterations: number; default: not declared - proposePortfolioRebalance().return.diagnostics: { warnings: string[]; accountsConsidered: string[]; accountsExcluded: string[]; tradeCount: number; dustCount: number; }; default: not declared - proposePortfolioRebalance().return.diagnostics.accountsConsidered: string[]; default: not declared - proposePortfolioRebalance().return.diagnostics.accountsExcluded: string[]; default: not declared - proposePortfolioRebalance().return.diagnostics.dustCount: number; default: not declared - proposePortfolioRebalance().return.diagnostics.tradeCount: number; default: not declared - proposePortfolioRebalance().return.diagnostics.warnings: string[]; default: not declared - proposePortfolioRebalance().return.dust: import('@insiderfinance/totalfinance/portfolio').RebalanceDustSummary; default: not declared - proposePortfolioRebalance().return.estimates: import('@insiderfinance/totalfinance/portfolio').RebalanceEstimates; default: not declared - proposePortfolioRebalance().return.feasible: boolean; default: not declared - proposePortfolioRebalance().return.netAssetValue: number; default: not declared — The managed (allowed-account) NAV before the flow. - proposePortfolioRebalance().return.netAssetValueAfterFlow: number; default: not declared - proposePortfolioRebalance().return.objective: { before: import('@insiderfinance/totalfinance/portfolio').RebalanceObjectivePoint; after: import('@insiderfinance/totalfinance/portfolio').RebalanceObjectivePoint; convention: string; }; default: not declared - proposePortfolioRebalance().return.objective.after: import('@insiderfinance/totalfinance/portfolio').RebalanceObjectivePoint; default: not declared - proposePortfolioRebalance().return.objective.before: import('@insiderfinance/totalfinance/portfolio').RebalanceObjectivePoint; default: not declared - proposePortfolioRebalance().return.objective.convention: string; default: not declared - proposePortfolioRebalance().return.plan: import('@insiderfinance/totalfinance/portfolio').TradePlanArtifact; default: not declared - proposePortfolioRebalance().return.risk: { before: import('@insiderfinance/totalfinance/portfolio').RebalanceRiskPoint; after: import('@insiderfinance/totalfinance/portfolio').RebalanceRiskPoint; }; default: not declared - proposePortfolioRebalance().return.risk.after: import('@insiderfinance/totalfinance/portfolio').RebalanceRiskPoint; default: not declared - proposePortfolioRebalance().return.risk.before: import('@insiderfinance/totalfinance/portfolio').RebalanceRiskPoint; default: not declared - proposePortfolioRebalance().return.trades: import('@insiderfinance/totalfinance/portfolio').RebalanceTrade[]; default: not declared — Sorted by (instrumentId, accountId). - proposePortfolioRebalance().return.unresolvedConstraints: import('@insiderfinance/totalfinance/portfolio').UnresolvedConstraint[]; default: not declared - proposePortfolioRebalance().return.unresolvedTargets: import('@insiderfinance/totalfinance/portfolio').UnresolvedTarget[]; default: not declared - proposePortfolioRebalance().return.weights: { instruments: import('@insiderfinance/totalfinance/portfolio').RebalanceInstrumentWeight[]; groups: import('@insiderfinance/totalfinance/portfolio').RebalanceGroupWeight[]; cash: import('@insiderfinance/totalfinance/portfolio').RebalanceCashWeight; }; default: not declared - proposePortfolioRebalance().return.weights.cash: import('@insiderfinance/totalfinance/portfolio').RebalanceCashWeight; default: not declared - proposePortfolioRebalance().return.weights.groups: import('@insiderfinance/totalfinance/portfolio').RebalanceGroupWeight[]; default: not declared - proposePortfolioRebalance().return.weights.instruments: import('@insiderfinance/totalfinance/portfolio').RebalanceInstrumentWeight[]; default: not declared - proposePortfolioRebalance(input): import('@insiderfinance/totalfinance/portfolio').ProposePortfolioRebalanceInput; default: not declared - proposePortfolioRebalance(input).asOf: string | number; default: not declared - proposePortfolioRebalance(input).averageDailyVolumes?: Record; default: not declared — Units per day; with `limits.maximumDaysToLiquidate`, days = |post-trade quantity| ÷ (volume × 0.1). - proposePortfolioRebalance(input).currencyConversions?: import('@insiderfinance/totalfinance/portfolio').CurrencyPairQuote[]; default: not declared - proposePortfolioRebalance(input).defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - proposePortfolioRebalance(input).externalFlow?: import('@insiderfinance/totalfinance/portfolio').ExternalFlow; default: not declared - proposePortfolioRebalance(input).instrumentClassification?: Record; default: not declared - proposePortfolioRebalance(input).lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - proposePortfolioRebalance(input).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared — Marks come from `observations.spots` through `portfolioSnapshot`. - proposePortfolioRebalance(input).minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - proposePortfolioRebalance(input).policy: import('@insiderfinance/totalfinance/portfolio').InvestmentPolicy; default: not declared - proposePortfolioRebalance(input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - proposePortfolioRebalance(input).scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; default: not declared - proposePortfolioRebalance(input).tradingAccountId?: string; default: not declared — Where BUYS book. REQUIRED when more than one allowed account; with exactly one it is that account. - proposePortfolioRebalance(input).transactionCosts?: import('@insiderfinance/totalfinance/portfolio').AllocationTransactionCosts; default: not declared - readPortfolioLedgerSnapshot: (input: import('@insiderfinance/totalfinance/portfolio').ReadPortfolioLedgerSnapshotInput) => { ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; migrationsApplied: import('@insiderfinance/totalfinance/core/artifacts').AppliedMigration[]; }; default: not declared — The ONE door back in for stored ledgers: validates the envelope (closed key set, kind, version) BEFORE reading any event, applies explicitly registered migrations for older versions, refuses newer versions, then restores by RE-FOLDING the events through `createPortfolioLedger` — full re-validation and deterministic replay in one step — and reports the exact migrations applied. - readPortfolioLedgerSnapshot().return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedger; default: not declared - readPortfolioLedgerSnapshot().return.migrationsApplied: import('@insiderfinance/totalfinance/core/artifacts').AppliedMigration[]; default: not declared - readPortfolioLedgerSnapshot(input): import('@insiderfinance/totalfinance/portfolio').ReadPortfolioLedgerSnapshotInput; default: not declared - readPortfolioLedgerSnapshot(input).migrations?: import('@insiderfinance/totalfinance/core/artifacts').ArtifactMigrationRegistry; default: not declared — Explicitly registered migrations for OLDER stored versions — never module-global state. - readPortfolioLedgerSnapshot(input).snapshot: unknown; default: not declared - reconcileExecution: (input: import('@insiderfinance/totalfinance/portfolio').ReconcileExecutionInput) => import('@insiderfinance/totalfinance/portfolio').ReconciliationReport; default: not declared — Reconcile an execution (Decision 8). Pure: the journal (events or a folded state), the ledger, the fills, and the optional external snapshot are inputs; the tolerance is explicit; the result is a content-addressed `totalfinance.reconciliation-report`. - reconcileExecution().return.asOf: number; default: not declared - reconcileExecution().return.assumptions: { conventionsVersion: string; tolerance: Required; matchConvention: string; }; default: not declared - reconcileExecution().return.assumptions.conventionsVersion: string; default: not declared - reconcileExecution().return.assumptions.matchConvention: string; default: not declared - reconcileExecution().return.assumptions.tolerance: Required; default: not declared - reconcileExecution().return.assumptions.tolerance.cashAmount: number; default: not declared - reconcileExecution().return.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - reconcileExecution().return.assumptions.tolerance.quantity: number; default: not declared - reconcileExecution().return.contentHash: string; default: not declared - reconcileExecution().return.diagnostics: { engine: 'trade-reconciliation'; warnings: string[]; orderCount: number; openCount: number; fillCount: number; ledgerFillCount: number; unresolvedCount: number; differenceCount: number; }; default: not declared - reconcileExecution().return.diagnostics.differenceCount: number; default: not declared - reconcileExecution().return.diagnostics.engine: 'trade-reconciliation'; default: not declared - reconcileExecution().return.diagnostics.fillCount: number; default: not declared - reconcileExecution().return.diagnostics.ledgerFillCount: number; default: not declared - reconcileExecution().return.diagnostics.openCount: number; default: not declared - reconcileExecution().return.diagnostics.orderCount: number; default: not declared - reconcileExecution().return.diagnostics.unresolvedCount: number; default: not declared - reconcileExecution().return.diagnostics.warnings: string[]; default: not declared - reconcileExecution().return.fills: import('@insiderfinance/totalfinance/portfolio/trade').ReconciliationFillMatch[]; default: not declared - reconcileExecution().return.journalId: string | null; default: not declared - reconcileExecution().return.journaledNotInLedger: string[]; default: not declared — Journaled fill ids with no `trade.fill` under the source in the ledger. - reconcileExecution().return.kind: 'totalfinance.reconciliation-report'; default: not declared - reconcileExecution().return.ledgerNotJournaled: string[]; default: not declared — Ledger `trade.fill` ids under the source that no order journaled. - reconcileExecution().return.orderChecks: import('@insiderfinance/totalfinance/portfolio/trade').ReconciliationOrderCheck[]; default: not declared - reconcileExecution().return.orders: import('@insiderfinance/totalfinance/portfolio').ExecutionOrderState[]; default: not declared - reconcileExecution().return.planHash: string | null; default: not declared - reconcileExecution().return.portfolio: import('@insiderfinance/totalfinance/portfolio').ReconcilePortfolioResult | null; default: not declared — `reconcilePortfolio`'s result when an external snapshot was given. - reconcileExecution().return.portfolio.accounts: import('@insiderfinance/totalfinance/portfolio').ReconciliationAccountReport[]; default: not declared - reconcileExecution().return.portfolio.asOf: number; default: not declared - reconcileExecution().return.portfolio.assumptions: { conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; tolerance: Required; comparisonConvention: string; }; default: not declared - reconcileExecution().return.portfolio.assumptions.comparisonConvention: string; default: not declared - reconcileExecution().return.portfolio.assumptions.conventionsVersion: string; default: not declared - reconcileExecution().return.portfolio.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - reconcileExecution().return.portfolio.assumptions.tolerance: Required; default: not declared - reconcileExecution().return.portfolio.assumptions.tolerance.cashAmount: number; default: not declared - reconcileExecution().return.portfolio.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - reconcileExecution().return.portfolio.assumptions.tolerance.quantity: number; default: not declared - reconcileExecution().return.portfolio.baseCurrency: string; default: not declared - reconcileExecution().return.portfolio.diagnostics: { warnings: string[]; ledgerAccountCount: number; externalAccountCount: number; }; default: not declared - reconcileExecution().return.portfolio.diagnostics.externalAccountCount: number; default: not declared - reconcileExecution().return.portfolio.diagnostics.ledgerAccountCount: number; default: not declared - reconcileExecution().return.portfolio.diagnostics.warnings: string[]; default: not declared - reconcileExecution().return.portfolio.differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - reconcileExecution().return.portfolio.explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - reconcileExecution().return.portfolio.reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - reconcileExecution().return.portfolio.suggestedCorrections: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - reconcileExecution().return.portfolio.undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. - reconcileExecution().return.reconciled: boolean; default: not declared - reconcileExecution().return.schemaVersion: 1; default: not declared - reconcileExecution().return.sourceId: string; default: not declared - reconcileExecution().return.unresolved: { orderId: string; reason: string; }[]; default: not declared - reconcileExecution(input): import('@insiderfinance/totalfinance/portfolio').ReconcileExecutionInput; default: not declared - reconcileExecution(input).asOf: string | number; default: not declared - reconcileExecution(input).external?: import('@insiderfinance/totalfinance/portfolio').ExternalPortfolioSnapshot; default: not declared - reconcileExecution(input).fills: readonly import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared — The execution's fills as delivered. - reconcileExecution(input).journal: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[] | import('@insiderfinance/totalfinance/portfolio').ExecutionJournalState; default: not declared — The journal's events (folded here) or an already-folded state. - reconcileExecution(input).journal.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - reconcileExecution(input).journal.eventCount: number; default: not declared - reconcileExecution(input).journal.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - reconcileExecution(input).journal.journalId: string | null; default: not declared — Null until the first event. - reconcileExecution(input).journal.orders: Record; default: not declared - reconcileExecution(input).journal.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. - reconcileExecution(input).ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - reconcileExecution(input).planHash?: string; default: not declared — Exclude other plans' journaled orders and fills; unattributed source fills remain discrepancies. - reconcileExecution(input).sourceId: string; default: not declared — The `sourceId` the execution's fills were folded into the ledger under. - reconcileExecution(input).tolerance: import('@insiderfinance/totalfinance/portfolio').ReconciliationTolerance; default: not declared — Explicit — reconciliation never assumes a tolerance. - reconcilePortfolio: (input: import('@insiderfinance/totalfinance/portfolio').ReconcilePortfolioInput) => import('@insiderfinance/totalfinance/portfolio').ReconcilePortfolioResult; default: not declared — Compare a derived state with a normalized external snapshot at `asOf` — see the module comment. - reconcilePortfolio().return.accounts: import('@insiderfinance/totalfinance/portfolio').ReconciliationAccountReport[]; default: not declared - reconcilePortfolio().return.asOf: number; default: not declared - reconcilePortfolio().return.assumptions: { conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; tolerance: Required; comparisonConvention: string; }; default: not declared - reconcilePortfolio().return.assumptions.comparisonConvention: string; default: not declared - reconcilePortfolio().return.assumptions.conventionsVersion: string; default: not declared - reconcilePortfolio().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - reconcilePortfolio().return.assumptions.tolerance: Required; default: not declared - reconcilePortfolio().return.assumptions.tolerance.cashAmount: number; default: not declared - reconcilePortfolio().return.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - reconcilePortfolio().return.assumptions.tolerance.quantity: number; default: not declared - reconcilePortfolio().return.baseCurrency: string; default: not declared - reconcilePortfolio().return.diagnostics: { warnings: string[]; ledgerAccountCount: number; externalAccountCount: number; }; default: not declared - reconcilePortfolio().return.diagnostics.externalAccountCount: number; default: not declared - reconcilePortfolio().return.diagnostics.ledgerAccountCount: number; default: not declared - reconcilePortfolio().return.diagnostics.warnings: string[]; default: not declared - reconcilePortfolio().return.differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - reconcilePortfolio().return.explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - reconcilePortfolio().return.reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - reconcilePortfolio().return.suggestedCorrections: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - reconcilePortfolio().return.undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. - reconcilePortfolio(input): import('@insiderfinance/totalfinance/portfolio').ReconcilePortfolioInput; default: not declared - reconcilePortfolio(input).asOf: string | number; default: not declared — The comparison instant (settled/unsettled cash is classified here); ISO date or epoch ms. - reconcilePortfolio(input).correctionSourceId?: string; default: not declared — `sourceId` stamped on suggested correction drafts. Default `'reconciliation'`. - reconcilePortfolio(input).external: import('@insiderfinance/totalfinance/portfolio').ExternalPortfolioSnapshot; default: not declared - reconcilePortfolio(input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - reconcilePortfolio(input).tolerance: import('@insiderfinance/totalfinance/portfolio').ReconciliationTolerance; default: not declared - requireNormalizedFill: (functionName: string, label: string, fill: unknown) => asserts fill is import('@insiderfinance/totalfinance/portfolio').NormalizedFill; default: not declared — Validate a {@link NormalizedFill} at a public boundary: a closed plain-data record whose numbers are finite, whose quantity is positive, whose settlement never precedes the fill, whose cost components are non-negative, and whose derivative terms come with their multiplier. The economic laws a fill must satisfy inside the ledger (a future settles by variation margin, a lot selection names real lots, …) are enforced by the event validator the mapped events pass through. - requireNormalizedFill(fill): unknown; default: not declared - requireNormalizedFill(functionName): string; default: not declared - requireNormalizedFill(label): string; default: not declared - requirePortfolioEventEnvelope: (functionName: string, label: string, envelope: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope) => asserts envelope is import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope; default: not declared — Validate one {@link PortfolioEventEnvelope} at a public boundary (Law 12 closed request): known keys at every level, identity strings, finite explicit timestamps, the schema version, the envelope/payload discriminator agreement, and the full per-variant payload contract. The guard validates its own `functionName` and `label` first (the `requireFundamentalPeriod` precedent) so its teaching errors always name the real boundary. - requirePortfolioEventEnvelope(envelope): import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope; default: not declared - requirePortfolioEventEnvelope(envelope).accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - requirePortfolioEventEnvelope(envelope).causationId?: string; default: not declared - requirePortfolioEventEnvelope(envelope).correlationId?: string; default: not declared - requirePortfolioEventEnvelope(envelope).effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - requirePortfolioEventEnvelope(envelope).event: import('@insiderfinance/totalfinance/portfolio').PortfolioEvent; default: not declared - requirePortfolioEventEnvelope(envelope).eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - requirePortfolioEventEnvelope(envelope).eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - requirePortfolioEventEnvelope(envelope).provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - requirePortfolioEventEnvelope(envelope).recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - requirePortfolioEventEnvelope(envelope).reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - requirePortfolioEventEnvelope(envelope).schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - requirePortfolioEventEnvelope(envelope).sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - requirePortfolioEventEnvelope(functionName): string; default: not declared - requirePortfolioEventEnvelope(label): string; default: not declared - resolveModelTargets: (input: import('@insiderfinance/totalfinance/portfolio').ResolveModelTargetsInput) => import('@insiderfinance/totalfinance/portfolio').ResolvedTargets; default: not declared — The targets a model makes effective at `asOf`: the latest tactical set covering the instant, else the glide path (stepped or interpolated), else the strategic set. An instant before the strategic set is effective is a typed refusal — a model has no targets there. - resolveModelTargets().return.effectiveFrom: number | null; default: not declared — The effective-from instant of the winning set (`null` for inline targets). - resolveModelTargets().return.interpolation?: { from: import('@insiderfinance/totalfinance/core').EpochMs; to: import('@insiderfinance/totalfinance/core').EpochMs; fraction: number; }; default: not declared — Present when a linear glide path interpolated between two points. - resolveModelTargets().return.interpolation.fraction: number; default: not declared - resolveModelTargets().return.interpolation.from: number; default: not declared - resolveModelTargets().return.interpolation.to: number; default: not declared - resolveModelTargets().return.source: import('@insiderfinance/totalfinance/portfolio').ResolvedTargetSource; default: not declared - resolveModelTargets().return.targets: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - resolveModelTargets(input): import('@insiderfinance/totalfinance/portfolio').ResolveModelTargetsInput; default: not declared - resolveModelTargets(input).asOf: string | number; default: not declared — The instant to resolve at (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - resolveModelTargets(input).model: import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared - verifyAuthorizationGrant: (input: import('@insiderfinance/totalfinance/portfolio').VerifyAuthorizationGrantInput) => import('@insiderfinance/totalfinance/portfolio').GrantVerification; default: not declared — Re-verify a grant at execution (Decision 5): expiry, the plan hash, the portfolio and market hashes, the market's age against the grant's allowance, the mode, the account, the idempotency key, and — when the orders about to be submitted differ from the plan's — the variance envelope (quantity ratio, notional ratio, limit-price slippage). Every binding is checked; the result lists every reason, never the first. - verifyAuthorizationGrant().return.assumptions: { conventionsVersion: string; mode: 'paper'; marketAsOf: import('@insiderfinance/totalfinance/core').EpochMs; marketAgeMs: number; marketMaximumAgeMs: number; ordersJudged: 'plan' | 'supplied'; bindingConvention: string; }; default: not declared - verifyAuthorizationGrant().return.assumptions.bindingConvention: string; default: not declared - verifyAuthorizationGrant().return.assumptions.conventionsVersion: string; default: not declared - verifyAuthorizationGrant().return.assumptions.marketAgeMs: number; default: not declared - verifyAuthorizationGrant().return.assumptions.marketAsOf: number; default: not declared — The market instant and age the verification judged. - verifyAuthorizationGrant().return.assumptions.marketMaximumAgeMs: number; default: not declared - verifyAuthorizationGrant().return.assumptions.mode: 'paper'; default: not declared - verifyAuthorizationGrant().return.assumptions.ordersJudged: 'supplied' | 'plan'; default: not declared — Whether the orders judged for variance were the plan's own (no variance) or supplied. - verifyAuthorizationGrant().return.checkedAt: number; default: not declared - verifyAuthorizationGrant().return.diagnostics: { engine: 'grant-verification'; warnings: string[]; bindingCount: number; reasonCount: number; orderCount: number; }; default: not declared - verifyAuthorizationGrant().return.diagnostics.bindingCount: number; default: not declared - verifyAuthorizationGrant().return.diagnostics.engine: 'grant-verification'; default: not declared - verifyAuthorizationGrant().return.diagnostics.orderCount: number; default: not declared - verifyAuthorizationGrant().return.diagnostics.reasonCount: number; default: not declared - verifyAuthorizationGrant().return.diagnostics.warnings: string[]; default: not declared - verifyAuthorizationGrant().return.grantHash: string; default: not declared - verifyAuthorizationGrant().return.planHash: string; default: not declared - verifyAuthorizationGrant().return.reasons: import('@insiderfinance/totalfinance/portfolio/trade').GrantRefusal[]; default: not declared — Every failed binding, never only the first. - verifyAuthorizationGrant().return.valid: boolean; default: not declared - verifyAuthorizationGrant(input): import('@insiderfinance/totalfinance/portfolio').VerifyAuthorizationGrantInput; default: not declared - verifyAuthorizationGrant(input).grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - verifyAuthorizationGrant(input).idempotencyKey: string; default: not declared — The submission's key; must be one the grant licenses. - verifyAuthorizationGrant(input).marketAsOf: number; default: not declared — The market snapshot's instant at execution. - verifyAuthorizationGrant(input).marketHash: string; default: not declared — The market snapshot's content hash at execution. - verifyAuthorizationGrant(input).mode?: 'paper'; default: not declared — Default `'paper'`. - verifyAuthorizationGrant(input).now: number; default: not declared - verifyAuthorizationGrant(input).orders?: readonly import('@insiderfinance/totalfinance/portfolio').TradeOrder[]; default: not declared — The orders about to be submitted when they differ from the plan's (a re-priced limit, a resized quantity), judged against the grant's variance envelope. Default: the plan's orders. - verifyAuthorizationGrant(input).plan: import('@insiderfinance/totalfinance/portfolio').ExecutionPlan; default: not declared - verifyAuthorizationGrant(input).portfolioHash: string; default: not declared — The portfolio's content hash at execution. ### @insiderfinance/totalfinance#priceBarsCheckpoint Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit accessor; serialized public errors never contain licensed pages or cursors. ```typescript export declare function priceBarsCheckpoint(error: unknown): PriceBarsCheckpoint | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (error): unknown; default: not declared - return.binding: DataQueryBinding; default: not declared - return.bytes: number; default: not declared - return.contractVersion: 2; default: not declared - return.kind: 'price-bars-checkpoint'; default: not declared - return.limits: { readonly maxPages: number; readonly maxReads: number; readonly maxRecords: number; }; default: not declared - return.limits.maxPages: number; default: not declared - return.limits.maxReads: number; default: not declared - return.limits.maxRecords: number; default: not declared - return.next: import('@insiderfinance/totalfinance/core/data').DataContinuation | null; default: not declared - return.next.binding: DataQueryBinding; default: not declared - return.next.cursor: string; default: not declared - return.next.pins: import('@insiderfinance/totalfinance/core/data').DataPins; default: not declared - return.next.version: 2; default: not declared - return.pages: readonly DataPage[]; default: not declared - return.paging: import('@insiderfinance/totalfinance/core/data').PriceBarsPaging; default: not declared - return.progress: { readonly acceptedPages: number; readonly reads: number; readonly records: number; readonly status: 'incomplete'; }; default: not declared - return.progress.acceptedPages: number; default: not declared - return.progress.reads: number; default: not declared - return.progress.records: number; default: not declared - return.progress.status: 'incomplete'; default: not declared - return.version: 1; default: not declared ### @insiderfinance/totalfinance#research Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const research: typeof import('@insiderfinance/totalfinance/research'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - CANONICAL_FACTOR_RECIPES: Readonly>; default: not declared — The seven canonical recipe families. Each is a frozen, versioned artifact; callers may copy and modify freely (the result is then their recipe, and should carry their name and version). - aggregateEventStudies: (input: import('@insiderfinance/totalfinance/research').AggregateEventStudiesInput) => import('@insiderfinance/totalfinance/research').AggregateEventStudiesResult; default: not declared — Pool the INCLUDED events of several {@link eventStudy} results and recompute AAR/CAAR and per-offset t-statistics across the pooled cross-section. Studies must share `sessionPolicy`, `cumulativeConvention`, and `eventWindow` — pooled per-offset statistics are meaningless otherwise, and a mismatch is refused naming both values. - aggregateEventStudies().return.assumptions: import('@insiderfinance/totalfinance/research').AggregateEventStudiesAssumptions; default: not declared - aggregateEventStudies().return.averageAbnormalReturns: import('@insiderfinance/totalfinance/research').AverageAbnormalReturnRow[]; default: not declared - aggregateEventStudies().return.diagnostics: import('@insiderfinance/totalfinance/research').EventStudyDiagnostics; default: not declared - aggregateEventStudies().return.events: import('@insiderfinance/totalfinance/research').EventStudyEventResult[]; default: not declared - aggregateEventStudies().return.studiesAggregated: number; default: not declared - aggregateEventStudies(input): import('@insiderfinance/totalfinance/research').AggregateEventStudiesInput; default: not declared - aggregateEventStudies(input).studies: readonly import('@insiderfinance/totalfinance/research').EventStudyResult[]; default: not declared - alignEventWindows: (input: import('@insiderfinance/totalfinance/research').AlignEventWindowsInput) => import('@insiderfinance/totalfinance/research').AlignEventWindowsResult; default: not declared — The alignment step of {@link eventStudy} alone: per event, the anchor session and the resolved event-window rows, or the exclusion reason. Runs the SAME anchoring code path as `eventStudy` — there is exactly one implementation of the session-policy rules in this module. - alignEventWindows().return.alignments: import('@insiderfinance/totalfinance/research').AlignedEventWindow[]; default: not declared - alignEventWindows().return.assumptions: { sessionPolicy: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; }; default: not declared - alignEventWindows().return.assumptions.eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared - alignEventWindows().return.assumptions.sessionPolicy: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; default: not declared - alignEventWindows().return.diagnostics: { warnings: string[]; eventsSupplied: number; eventsAligned: number; excludedEvents: { eventId: string; reason: string; }[]; }; default: not declared - alignEventWindows().return.diagnostics.eventsAligned: number; default: not declared - alignEventWindows().return.diagnostics.eventsSupplied: number; default: not declared - alignEventWindows().return.diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - alignEventWindows().return.diagnostics.warnings: string[]; default: not declared - alignEventWindows(input): import('@insiderfinance/totalfinance/research').AlignEventWindowsInput; default: not declared - alignEventWindows(input).eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared - alignEventWindows(input).events: readonly import('@insiderfinance/totalfinance/research').MarketEvent[]; default: not declared - alignEventWindows(input).returnObservations: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared - alignEventWindows(input).sessionPolicy?: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; default: not declared — Default `'next-session'` — the same policy, the same code path, as {@link eventStudy}. - compositeFactorScore: (input: import('@insiderfinance/totalfinance/research').CompositeFactorScoreInput) => import('@insiderfinance/totalfinance/research').CompositeFactorScoreResult; default: not declared — Weighted composite of standardized factor vectors; direction flips signs so higher is better. - compositeFactorScore().return.assumptions: { components: Array<{ label: string; weight: number; normalizedWeight: number; direction: string; }>; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - compositeFactorScore().return.assumptions.components: { label: string; weight: number; normalizedWeight: number; direction: string; }[]; default: not declared - compositeFactorScore().return.assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - compositeFactorScore().return.diagnostics: { warnings: string[]; instrumentCount: number; scoredCount: number; exclusionReasons: Record; }; default: not declared - compositeFactorScore().return.diagnostics.exclusionReasons: Record; default: not declared - compositeFactorScore().return.diagnostics.instrumentCount: number; default: not declared - compositeFactorScore().return.diagnostics.scoredCount: number; default: not declared - compositeFactorScore().return.diagnostics.warnings: string[]; default: not declared - compositeFactorScore().return.entries: import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - compositeFactorScore(input): import('@insiderfinance/totalfinance/research').CompositeFactorScoreInput; default: not declared - compositeFactorScore(input).components: readonly import('@insiderfinance/totalfinance/research').CompositeComponent[]; default: not declared - compositeFactorScore(input).missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'` drops an instrument missing any component; `'renormalize-weights'` scores what is present. - eligibleObservationsAt: (input: import('@insiderfinance/totalfinance/research').EligibleObservationsAtInput) => import('@insiderfinance/totalfinance/research').EligibleObservationsAtResult; default: not declared — The observations a decision at `asOf` may see: available at or before the cutoff (an explicit session lag moves the cutoff back through the caller's session index), the latest version per instrument, and — when a universe history is given — members at `asOf` only. Shifting a row's `availableTimestampMs` past the cutoff removes it; the acceptance law every FC3 screen already satisfies, exposed for the simulators. - eligibleObservationsAt().return.assumptions: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; availabilityCutoffMs: import('@insiderfinance/totalfinance/core').EpochMs; lagTradingSessions: number; universeId: string | null; versionResolution: 'latest available at or before the cutoff per instrument'; }; default: not declared - eligibleObservationsAt().return.assumptions.asOf: number; default: not declared - eligibleObservationsAt().return.assumptions.availabilityCutoffMs: number; default: not declared — The instant availability is measured against: `asOf`, or the lagged session instant. - eligibleObservationsAt().return.assumptions.lagTradingSessions: number; default: not declared - eligibleObservationsAt().return.assumptions.universeId: string | null; default: not declared - eligibleObservationsAt().return.assumptions.versionResolution: 'latest available at or before the cutoff per instrument'; default: not declared - eligibleObservationsAt().return.diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; excludedCount: number; exclusionReasons: Record; }; default: not declared - eligibleObservationsAt().return.diagnostics.eligibleCount: number; default: not declared - eligibleObservationsAt().return.diagnostics.excludedCount: number; default: not declared - eligibleObservationsAt().return.diagnostics.exclusionReasons: Record; default: not declared - eligibleObservationsAt().return.diagnostics.suppliedCount: number; default: not declared - eligibleObservationsAt().return.diagnostics.warnings: string[]; default: not declared - eligibleObservationsAt().return.observations: import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — One observation per eligible instrument, `instrumentId` ascending. - eligibleObservationsAt(input): import('@insiderfinance/totalfinance/research').EligibleObservationsAtInput; default: not declared - eligibleObservationsAt(input).asOf: number; default: not declared - eligibleObservationsAt(input).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - eligibleObservationsAt(input).lag?: import('@insiderfinance/totalfinance/research').EligibilityLag; default: not declared — Omitted = no lag: availability at or before `asOf` is enough. - eligibleObservationsAt(input).observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - eligibleObservationsAt(input).universeHistory?: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared — When given, only members of this universe at `asOf` are eligible. - eventStudy: (input: import('@insiderfinance/totalfinance/research').EventStudyInput) => import('@insiderfinance/totalfinance/research').EventStudyResult; default: not declared — Run an event study: anchor each event on its instrument's sessions under the declared session policy, model expected returns, and disclose abnormal returns per event and across events. Every convention is echoed in `assumptions`; every dropped event is named with its reason in `diagnostics.excludedEvents` — see the module header for the exact anchoring and overlap rules. - eventStudy().return.assumptions: import('@insiderfinance/totalfinance/research').EventStudyAssumptions; default: not declared - eventStudy().return.averageAbnormalReturns: import('@insiderfinance/totalfinance/research').AverageAbnormalReturnRow[]; default: not declared - eventStudy().return.diagnostics: import('@insiderfinance/totalfinance/research').EventStudyDiagnostics; default: not declared - eventStudy().return.events: import('@insiderfinance/totalfinance/research').EventStudyEventResult[]; default: not declared - eventStudy(input): import('@insiderfinance/totalfinance/research').EventStudyInput; default: not declared - eventStudy(input).cumulativeConvention?: import('@insiderfinance/totalfinance/research').CumulativeConvention; default: not declared — Default `'sum'` (classic CAR) — documented and echoed. - eventStudy(input).estimationWindow?: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared — REQUIRED by `'mean-adjusted'` and `'market'`; must END strictly BEFORE the event window starts — a model estimated through the event measures the event twice. - eventStudy(input).eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared — Integers, start ≤ end; offset 0 is the event session. - eventStudy(input).events: readonly import('@insiderfinance/totalfinance/research').MarketEvent[]; default: not declared - eventStudy(input).expectedReturnModel: import('@insiderfinance/totalfinance/research').ExpectedReturnModelInput; default: not declared - eventStudy(input).marketReturns?: readonly import('@insiderfinance/totalfinance/research').MarketReturnObservation[]; default: not declared — Required by the `'market-adjusted'` and `'market'` models. - eventStudy(input).overlappingEventPolicy: import('@insiderfinance/totalfinance/research').OverlappingEventPolicy; default: not declared — REQUIRED, no default — overlap handling changes the statistics, so the caller must choose. - eventStudy(input).returnObservations: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Instrument returns per trading session — the sessions ARE these rows' distinct dates. - eventStudy(input).sessionPolicy?: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; default: not declared — Default `'next-session'` — documented in the module header and echoed in assumptions. - factorDecay: (input: import('@insiderfinance/totalfinance/research').FactorDecayInput) => import('@insiderfinance/totalfinance/research').FactorDecayResult; default: not declared — The factor's rank information coefficient at each stated horizon — its signal decay curve. - factorDecay().return.assumptions: { coefficient: 'rank information coefficient per horizon'; minimumCoverageFraction: number; }; default: not declared - factorDecay().return.assumptions.coefficient: 'rank information coefficient per horizon'; default: not declared - factorDecay().return.assumptions.minimumCoverageFraction: number; default: not declared - factorDecay().return.byHorizon: { horizonLabel: string; rankInformationCoefficient: number | null; pairedCount: number; reason?: string; }[]; default: not declared - factorDecay().return.diagnostics: { warnings: string[]; }; default: not declared - factorDecay().return.diagnostics.warnings: string[]; default: not declared - factorDecay(input): import('@insiderfinance/totalfinance/research').FactorDecayInput; default: not declared - factorDecay(input).factorEntries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - factorDecay(input).horizons: readonly { horizonLabel: string; forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; }[]; default: not declared — Forward returns at increasing horizons, each labeled. - factorDecay(input).minimumCoverageFraction?: number; default: not declared - factorSpreadReturn: (input: import('@insiderfinance/totalfinance/research').FactorSpreadReturnInput) => import('@insiderfinance/totalfinance/research').FactorSpreadReturnResult; default: not declared — Top-minus-bottom quantile forward return, equal-weighted within each leg. - factorSpreadReturn().return.assumptions: { quantileCount: number; direction: 'ascending' | 'descending'; legWeighting: 'equal weight within each leg'; }; default: not declared - factorSpreadReturn().return.assumptions.direction: 'ascending' | 'descending'; default: not declared - factorSpreadReturn().return.assumptions.legWeighting: 'equal weight within each leg'; default: not declared - factorSpreadReturn().return.assumptions.quantileCount: number; default: not declared - factorSpreadReturn().return.diagnostics: { warnings: string[]; longLegCount: number; shortLegCount: number; }; default: not declared - factorSpreadReturn().return.diagnostics.longLegCount: number; default: not declared - factorSpreadReturn().return.diagnostics.shortLegCount: number; default: not declared - factorSpreadReturn().return.diagnostics.warnings: string[]; default: not declared - factorSpreadReturn().return.longLegMeanReturn: number | null; default: not declared - factorSpreadReturn().return.reason?: string; default: not declared - factorSpreadReturn().return.shortLegMeanReturn: number | null; default: not declared - factorSpreadReturn().return.spreadReturn: number | null; default: not declared — Mean forward return of portfolio 1 minus portfolio N, or null with the reason. - factorSpreadReturn(input): import('@insiderfinance/totalfinance/research').FactorSpreadReturnInput; default: not declared - factorSpreadReturn(input).direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 (highest factor) is the LONG leg. - factorSpreadReturn(input).entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - factorSpreadReturn(input).forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - factorSpreadReturn(input).quantileCount: number; default: not declared - factorTurnover: (input: import('@insiderfinance/totalfinance/research').FactorTurnoverInput) => import('@insiderfinance/totalfinance/research').FactorTurnoverResult; default: not declared — Per-quantile membership turnover between two formations. - factorTurnover().return.assumptions: { definition: 'fraction of the current portfolio not present in the previous one'; }; default: not declared - factorTurnover().return.assumptions.definition: 'fraction of the current portfolio not present in the previous one'; default: not declared - factorTurnover().return.byQuantile: { quantileIndex: number; turnover: number | null; reason?: string; }[]; default: not declared - factorTurnover().return.diagnostics: { warnings: string[]; }; default: not declared - factorTurnover().return.diagnostics.warnings: string[]; default: not declared - factorTurnover(input): import('@insiderfinance/totalfinance/research').FactorTurnoverInput; default: not declared - factorTurnover(input).currentPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - factorTurnover(input).previousPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - formQuantilePortfolios: (input: import('@insiderfinance/totalfinance/research').FormQuantilePortfoliosInput) => import('@insiderfinance/totalfinance/research').FormQuantilePortfoliosResult; default: not declared — Sort the valued entries and cut them into `quantileCount` portfolios. Every valued entry lands in EXACTLY one portfolio and no portfolio repeats a name — the acceptance law, by construction. - formQuantilePortfolios().return.assumptions: { quantileCount: number; direction: 'ascending' | 'descending'; tieBreaker: 'instrumentId ascending'; sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; }; default: not declared - formQuantilePortfolios().return.assumptions.direction: 'ascending' | 'descending'; default: not declared - formQuantilePortfolios().return.assumptions.quantileCount: number; default: not declared - formQuantilePortfolios().return.assumptions.sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; default: not declared - formQuantilePortfolios().return.assumptions.tieBreaker: 'instrumentId ascending'; default: not declared - formQuantilePortfolios().return.diagnostics: { warnings: string[]; coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; excludedMissingCount: number; }; default: not declared - formQuantilePortfolios().return.diagnostics.coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; default: not declared - formQuantilePortfolios().return.diagnostics.excludedMissingCount: number; default: not declared - formQuantilePortfolios().return.diagnostics.warnings: string[]; default: not declared - formQuantilePortfolios().return.portfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - formQuantilePortfolios(input): import('@insiderfinance/totalfinance/research').FormQuantilePortfoliosInput; default: not declared - formQuantilePortfolios(input).direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 holds the HIGHEST values (the conventional long leg). - formQuantilePortfolios(input).entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - formQuantilePortfolios(input).quantileCount: number; default: not declared — How many portfolios (e.g. 5 = quintiles). - informationCoefficient: (input: import('@insiderfinance/totalfinance/research').InformationCoefficientInput) => import('@insiderfinance/totalfinance/research').InformationCoefficientResult; default: not declared — The information coefficient: Pearson correlation of a factor with forward returns over the instruments carrying BOTH, plus the Spearman rank version. Fewer than three pairs or zero dispersion answers null with the reason — a correlation of nothing is not zero. - informationCoefficient().return.assumptions: { pearsonBasis: 'values'; rankBasis: 'average ranks (Spearman)'; minimumCoverageFraction: number; }; default: not declared - informationCoefficient().return.assumptions.minimumCoverageFraction: number; default: not declared - informationCoefficient().return.assumptions.pearsonBasis: 'values'; default: not declared - informationCoefficient().return.assumptions.rankBasis: 'average ranks (Spearman)'; default: not declared - informationCoefficient().return.diagnostics: { warnings: string[]; pairedCount: number; }; default: not declared - informationCoefficient().return.diagnostics.pairedCount: number; default: not declared - informationCoefficient().return.diagnostics.warnings: string[]; default: not declared - informationCoefficient().return.informationCoefficient: number | null; default: not declared — Pearson correlation of factor values with forward returns, or null with the reason. - informationCoefficient().return.rankInformationCoefficient: number | null; default: not declared — Spearman (rank) correlation, or null with the reason. - informationCoefficient().return.reason?: string; default: not declared - informationCoefficient(input): import('@insiderfinance/totalfinance/research').InformationCoefficientInput; default: not declared - informationCoefficient(input).factorEntries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - informationCoefficient(input).forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared — Forward returns over the evaluation horizon, keyed by instrument. - informationCoefficient(input).minimumCoverageFraction?: number; default: not declared - neutralizeFactor: (input: import('@insiderfinance/totalfinance/research').NeutralizeFactorInput) => import('@insiderfinance/totalfinance/research').NeutralizeFactorResult; default: not declared — Neutralize a factor against sector/industry groups (demean within group) and/or continuous exposures (remove the OLS projection, intercept included). Residuals are orthogonal to every controlled exposure within numerical tolerance — the acceptance law, provable from the normal equations this solves. - neutralizeFactor().return.assumptions: { groupNeutralization: boolean; continuousNeutralization: boolean; intercept: 'included'; minimumCoverageFraction: number; }; default: not declared - neutralizeFactor().return.assumptions.continuousNeutralization: boolean; default: not declared - neutralizeFactor().return.assumptions.groupNeutralization: boolean; default: not declared - neutralizeFactor().return.assumptions.intercept: 'included'; default: not declared — Continuous fit always includes an intercept, so residuals are mean-zero. - neutralizeFactor().return.assumptions.minimumCoverageFraction: number; default: not declared - neutralizeFactor().return.diagnostics: { warnings: string[]; coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; groupCount?: number; exposureCount?: number; exclusionReasons: Record; }; default: not declared - neutralizeFactor().return.diagnostics.coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; default: not declared - neutralizeFactor().return.diagnostics.exclusionReasons: Record; default: not declared — Entries dropped because their group or exposure row was absent, tallied. - neutralizeFactor().return.diagnostics.exposureCount?: number; default: not declared - neutralizeFactor().return.diagnostics.groupCount?: number; default: not declared - neutralizeFactor().return.diagnostics.warnings: string[]; default: not declared - neutralizeFactor().return.entries: import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - neutralizeFactor(input): import('@insiderfinance/totalfinance/research').NeutralizeFactorInput; default: not declared - neutralizeFactor(input).entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - neutralizeFactor(input).exposures?: readonly { instrumentId: string; exposures: readonly number[]; }[]; default: not declared — Continuous exposures (size, beta, …): the cross-sectional OLS projection is removed. - neutralizeFactor(input).groups?: readonly { instrumentId: string; group: string; }[]; default: not declared — Category memberships (sector/industry): the group mean is removed within each group. - neutralizeFactor(input).minimumCoverageFraction?: number; default: not declared - rankUniverse: (input: import('@insiderfinance/totalfinance/research').RankUniverseInput) => import('@insiderfinance/totalfinance/research').RankUniverseResult; default: not declared — Rank one declared numeric field across the point-in-time universe. - rankUniverse().return.assumptions: { universeId: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; finalTieBreaker: 'instrumentId ascending'; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - rankUniverse().return.assumptions.asOf: number; default: not declared - rankUniverse().return.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - rankUniverse().return.assumptions.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - rankUniverse().return.assumptions.rankBy: { field: string; direction: 'ascending' | 'descending'; }; default: not declared - rankUniverse().return.assumptions.rankBy.direction: 'ascending' | 'descending'; default: not declared - rankUniverse().return.assumptions.rankBy.field: string; default: not declared - rankUniverse().return.assumptions.tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; default: not declared - rankUniverse().return.assumptions.universeId: string; default: not declared - rankUniverse().return.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - rankUniverse().return.diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; rankedCount: number; excludedCount: number; exclusionReasons: Record; }; default: not declared - rankUniverse().return.diagnostics.eligibleCount: number; default: not declared - rankUniverse().return.diagnostics.excludedCount: number; default: not declared - rankUniverse().return.diagnostics.exclusionReasons: Record; default: not declared - rankUniverse().return.diagnostics.rankedCount: number; default: not declared - rankUniverse().return.diagnostics.suppliedCount: number; default: not declared - rankUniverse().return.diagnostics.warnings: string[]; default: not declared - rankUniverse().return.rows: { instrumentId: string; value: number; rank: number; }[]; default: not declared - rankUniverse(input): import('@insiderfinance/totalfinance/research').RankUniverseInput; default: not declared - rankUniverse(input).asOf: number; default: not declared - rankUniverse(input).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - rankUniverse(input).missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - rankUniverse(input).observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - rankUniverse(input).rankBy: { field: string; direction: 'ascending' | 'descending'; }; default: not declared - rankUniverse(input).rankBy.direction: 'ascending' | 'descending'; default: not declared - rankUniverse(input).rankBy.field: string; default: not declared - rankUniverse(input).tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; default: not declared - rankUniverse(input).universeId: string; default: not declared - requireDefinitionsMap: (functionName: string, definitions: Map) => void; default: not declared — The definitions Map every declaration-aware guard consumes — typed, never assumed. - requireDefinitionsMap(definitions): Map; default: not declared - requireDefinitionsMap(functionName): string; default: not declared - requireFieldDefinitions: (functionName: string, fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]) => Map; default: not declared — Validate the field-definition list and return them keyed by name. - requireFieldDefinitions(fieldDefinitions): readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - requireFieldDefinitions(functionName): string; default: not declared - requireMarketEvent: (functionName: string, path: string, event: import('@insiderfinance/totalfinance/research').MarketEvent) => void; default: not declared — Validate one {@link MarketEvent} at a public boundary. - requireMarketEvent(event): import('@insiderfinance/totalfinance/research').MarketEvent; default: not declared - requireMarketEvent(event).announcedTimestampMs: number; default: not declared - requireMarketEvent(event).effectiveTimestampMs?: number; default: not declared — When the event takes economic effect, where that differs from the announcement. - requireMarketEvent(event).eventId: string; default: not declared - requireMarketEvent(event).eventType: string; default: not declared — A caller vocabulary ('earnings', 'guidance', …) — recorded, never interpreted. - requireMarketEvent(event).instrumentId: string; default: not declared - requireMarketEvent(event).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - requireMarketEvent(functionName): string; default: not declared - requireMarketEvent(path): string; default: not declared - requireReturnObservations: (functionName: string, label: string, observations: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]) => void; default: not declared — Validate a return-observation array, naming the failing row. - requireReturnObservations(functionName): string; default: not declared - requireReturnObservations(label): string; default: not declared - requireReturnObservations(observations): readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared - requireScreenFilter: (functionName: string, path: string, filter: import('@insiderfinance/totalfinance/research').ScreenFilter, definitions: Map) => void; default: not declared — Validate a filter tree against the declarations: every field declared, every operator known, every comparison kind-compatible (an ordering comparison of a category field is the classic unit-incompatibility, and it teaches instead of silently failing every row). - requireScreenFilter(definitions): Map; default: not declared - requireScreenFilter(filter): import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - requireScreenFilter(filter).all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - requireScreenFilter(filter).any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - requireScreenFilter(filter).field: string; default: not declared - requireScreenFilter(filter).from: number; default: not declared - requireScreenFilter(filter).not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - requireScreenFilter(filter).operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - requireScreenFilter(filter).to: number; default: not declared - requireScreenFilter(filter).value: (number) | (string | number | boolean); default: not declared - requireScreenFilter(filter).values: readonly (string | number)[]; default: not declared - requireScreenFilter(functionName): string; default: not declared - requireScreenFilter(path): string; default: not declared - requireUniverseHistory: (functionName: string, label: string, history: import('@insiderfinance/totalfinance/research').UniverseHistory) => void; default: not declared — Validate a {@link UniverseHistory} at a public boundary: a closed record whose members are closed records with finite instants, a half-open non-empty interval each, a declared exit reason whenever an exit instant is given, a finite delisting return ≥ −1 only beside an exit, and no two overlapping intervals for one instrument (a name cannot be a member twice at once). - requireUniverseHistory(functionName): string; default: not declared - requireUniverseHistory(history): import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - requireUniverseHistory(history).members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - requireUniverseHistory(history).universeId: string; default: not declared - requireUniverseHistory(label): string; default: not declared - requireUniverseObservation: (functionName: string, path: string, observation: import('@insiderfinance/totalfinance/research').UniverseObservation, definitions: Map) => void; default: not declared — Validate one observation against the declarations: closed keys at the row level, every field key DECLARED, and every value matching its declared kind. `null` means "the source had no value" and is legal for any declared field — the missing-value policy decides what happens next, never the validator. - requireUniverseObservation(definitions): Map; default: not declared - requireUniverseObservation(functionName): string; default: not declared - requireUniverseObservation(observation): import('@insiderfinance/totalfinance/research').UniverseObservation; default: not declared - requireUniverseObservation(observation).availableTimestampMs: number; default: not declared - requireUniverseObservation(observation).fields: Record; default: not declared — Values for DECLARED fields only; a key with no declaration is a teaching error. - requireUniverseObservation(observation).instrumentId: string; default: not declared - requireUniverseObservation(path): string; default: not declared - requireUniverseObservations: (functionName: string, observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[], definitions: Map) => void; default: not declared — Validate a whole observation array, naming the failing row. - requireUniverseObservations(definitions): Map; default: not declared - requireUniverseObservations(functionName): string; default: not declared - requireUniverseObservations(observations): readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - scoreUniverse: (input: import('@insiderfinance/totalfinance/research').ScoreUniverseInput) => import('@insiderfinance/totalfinance/research').ScoreUniverseResult; default: not declared — Weighted composite scoring over standardized declared fields. Standardization is computed over the rows that carry the component; direction flips the sign so higher is always better in the composite. - scoreUniverse().return.assumptions: { universeId: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; components: Array; missingValuePolicy: 'exclude' | 'renormalize-weights'; finalTieBreaker: 'instrumentId ascending'; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - scoreUniverse().return.assumptions.asOf: number; default: not declared - scoreUniverse().return.assumptions.components: (import('@insiderfinance/totalfinance/research').ScoreComponent & { normalizedWeight: number; })[]; default: not declared - scoreUniverse().return.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - scoreUniverse().return.assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - scoreUniverse().return.assumptions.universeId: string; default: not declared - scoreUniverse().return.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - scoreUniverse().return.diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; scoredCount: number; excludedCount: number; exclusionReasons: Record; }; default: not declared - scoreUniverse().return.diagnostics.eligibleCount: number; default: not declared - scoreUniverse().return.diagnostics.excludedCount: number; default: not declared - scoreUniverse().return.diagnostics.exclusionReasons: Record; default: not declared - scoreUniverse().return.diagnostics.scoredCount: number; default: not declared - scoreUniverse().return.diagnostics.suppliedCount: number; default: not declared - scoreUniverse().return.diagnostics.warnings: string[]; default: not declared - scoreUniverse().return.rows: { instrumentId: string; score: number; componentsUsed: number; }[]; default: not declared - scoreUniverse(input): import('@insiderfinance/totalfinance/research').ScoreUniverseInput; default: not declared - scoreUniverse(input).asOf: number; default: not declared - scoreUniverse(input).components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - scoreUniverse(input).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - scoreUniverse(input).missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'`: a row missing ANY component is dropped with the reason. `'renormalize-weights'`: the row scores over its PRESENT components with weights renormalized — disclosed per policy, never per row silently. - scoreUniverse(input).observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - scoreUniverse(input).universeId: string; default: not declared - screenUniverse: (input: import('@insiderfinance/totalfinance/research').ScreenUniverseInput) => import('@insiderfinance/totalfinance/research').ScreenUniverseResult; default: not declared — A point-in-time screen: eligibility, version resolution, filter, ordering with the always-on stable tie-breaker, and the honest exclusion ledger. Deterministic under input permutation by construction. - screenUniverse().return.assumptions: { universeId: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; finalTieBreaker: 'instrumentId ascending'; limit?: number; customPredicate?: 'non-serializable caller predicate'; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - screenUniverse().return.assumptions.asOf: number; default: not declared - screenUniverse().return.assumptions.customPredicate?: 'non-serializable caller predicate'; default: not declared — Present exactly when a caller predicate participated. - screenUniverse().return.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared — The stable final ordering key, always applied — determinism under input permutation. - screenUniverse().return.assumptions.limit?: number; default: not declared - screenUniverse().return.assumptions.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - screenUniverse().return.assumptions.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - screenUniverse().return.assumptions.universeId: string; default: not declared - screenUniverse().return.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - screenUniverse().return.diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; includedCount: number; excludedCount: number; exclusionReasons: Record; }; default: not declared - screenUniverse().return.diagnostics.eligibleCount: number; default: not declared - screenUniverse().return.diagnostics.excludedCount: number; default: not declared - screenUniverse().return.diagnostics.exclusionReasons: Record; default: not declared — Every exclusion, tallied by reason. - screenUniverse().return.diagnostics.includedCount: number; default: not declared - screenUniverse().return.diagnostics.suppliedCount: number; default: not declared - screenUniverse().return.diagnostics.warnings: string[]; default: not declared - screenUniverse().return.rows: import('@insiderfinance/totalfinance/research').ScreenedRow[]; default: not declared - screenUniverse(input): import('@insiderfinance/totalfinance/research').ScreenUniverseInput; default: not declared - screenUniverse(input).asOf: number; default: not declared - screenUniverse(input).customPredicate?: (observation: import('@insiderfinance/totalfinance/research').UniverseObservation) => boolean; default: not declared — The explicit NON-SERIALIZABLE escape hatch: a caller predicate over the observation. Its presence is classified in `assumptions.customPredicate` so a stored screen recipe cannot silently claim reproducibility it does not have. - screenUniverse(input).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - screenUniverse(input).filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared — The serializable filter. Omitted → every eligible row passes (ordering still applies). - screenUniverse(input).limit?: number; default: not declared — Keep at most this many rows after ordering; a non-negative safe integer. Omit for all rows. - screenUniverse(input).missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - screenUniverse(input).observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - screenUniverse(input).orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared — Ordering keys; `instrumentId` ascending is ALWAYS appended as the stable final tie-breaker. - screenUniverse(input).universeId: string; default: not declared — The universe's identity, echoed — a screen without provenance is a number without a source. - standardizeFactor: (input: import('@insiderfinance/totalfinance/research').StandardizeFactorInput) => import('@insiderfinance/totalfinance/research').StandardizeFactorResult; default: not declared — Standardize a factor cross-sectionally: z-scores over the valued entries, or average-rank percentiles scaled to (0, 1]. Nulls pass through; a zero-dispersion z-score answers 0 for every entry WITH a warning rather than dividing by nothing. - standardizeFactor().return.assumptions: { method: 'z-score' | 'percentile-rank'; minimumCoverageFraction: number; mean?: number; sampleStandardDeviation?: number; tieHandling: 'average rank'; }; default: not declared - standardizeFactor().return.assumptions.mean?: number; default: not declared — Echoed z-score moments (absent for percentile ranks). - standardizeFactor().return.assumptions.method: 'z-score' | 'percentile-rank'; default: not declared - standardizeFactor().return.assumptions.minimumCoverageFraction: number; default: not declared - standardizeFactor().return.assumptions.sampleStandardDeviation?: number; default: not declared - standardizeFactor().return.assumptions.tieHandling: 'average rank'; default: not declared - standardizeFactor().return.diagnostics: { warnings: string[]; coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; }; default: not declared - standardizeFactor().return.diagnostics.coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; default: not declared - standardizeFactor().return.diagnostics.warnings: string[]; default: not declared - standardizeFactor().return.entries: import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - standardizeFactor(input): import('@insiderfinance/totalfinance/research').StandardizeFactorInput; default: not declared - standardizeFactor(input).entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - standardizeFactor(input).method: 'z-score' | 'percentile-rank'; default: not declared - standardizeFactor(input).minimumCoverageFraction?: number; default: not declared - universeMembershipAt: (input: import('@insiderfinance/totalfinance/research').UniverseMembershipAtInput) => import('@insiderfinance/totalfinance/research').UniverseMembershipAtResult; default: not declared — Who is in the universe at an instant, and — against a previous instant — who joined and who left (with the exit reason and any delisting return). The membership rule is the half-open interval; ties are impossible because one instant is either inside an interval or not. - universeMembershipAt().return.additions: string[]; default: not declared — Names whose membership began in `(previousAsOf, asOf]`, ascending. - universeMembershipAt().return.assumptions: { universeId: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; previousAsOf: import('@insiderfinance/totalfinance/core').EpochMs | null; membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; }; default: not declared - universeMembershipAt().return.assumptions.asOf: number; default: not declared - universeMembershipAt().return.assumptions.membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; default: not declared - universeMembershipAt().return.assumptions.previousAsOf: number | null; default: not declared - universeMembershipAt().return.assumptions.universeId: string; default: not declared - universeMembershipAt().return.diagnostics: { warnings: string[]; memberCount: number; additionCount: number; exitCount: number; }; default: not declared - universeMembershipAt().return.diagnostics.additionCount: number; default: not declared - universeMembershipAt().return.diagnostics.exitCount: number; default: not declared - universeMembershipAt().return.diagnostics.memberCount: number; default: not declared - universeMembershipAt().return.diagnostics.warnings: string[]; default: not declared - universeMembershipAt().return.exits: import('@insiderfinance/totalfinance/research').UniverseExit[]; default: not declared — Names whose membership ended in `(previousAsOf, asOf]`, ascending by id then instant. - universeMembershipAt().return.instrumentIds: string[]; default: not declared — Members at `asOf`, `instrumentId` ascending. - universeMembershipAt(input): import('@insiderfinance/totalfinance/research').UniverseMembershipAtInput; default: not declared - universeMembershipAt(input).asOf: number; default: not declared — The decision instant. - universeMembershipAt(input).previousAsOf?: number; default: not declared — The previous decision instant. When given, `additions` and `exits` describe what changed in `(previousAsOf, asOf]`; when omitted both are empty and only `instrumentIds` is meaningful. - universeMembershipAt(input).universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - winsorizeFactor: (input: import('@insiderfinance/totalfinance/research').WinsorizeFactorInput) => import('@insiderfinance/totalfinance/research').WinsorizeFactorResult; default: not declared — Winsorize a factor vector under an EXPLICIT method. The percentile form uses the CLASSIC Winsor convention — order-statistic replacement: the `floor(n × lowerPercentile)` smallest values are replaced by the next order statistic (and symmetrically at the top). Chosen over interpolating quantiles deliberately: order-statistic replacement is EXACTLY idempotent (re-winsorizing a winsorized vector is the identity — the metamorphic law in the evidence plan), while an interpolated cutoff moves every time it is recomputed over its own output. Nulls pass through untouched; the realized clip bounds are echoed. - winsorizeFactor().return.assumptions: { method: import('@insiderfinance/totalfinance/research').WinsorizationMethod; minimumCoverageFraction: number; lowerBound: number; upperBound: number; }; default: not declared - winsorizeFactor().return.assumptions.lowerBound: number; default: not declared — The realized clip bounds, so the transform is reproducible without the input. - winsorizeFactor().return.assumptions.method: import('@insiderfinance/totalfinance/research').WinsorizationMethod; default: not declared - winsorizeFactor().return.assumptions.minimumCoverageFraction: number; default: not declared - winsorizeFactor().return.assumptions.upperBound: number; default: not declared - winsorizeFactor().return.diagnostics: { warnings: string[]; coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; clippedLowerCount: number; clippedUpperCount: number; }; default: not declared - winsorizeFactor().return.diagnostics.clippedLowerCount: number; default: not declared - winsorizeFactor().return.diagnostics.clippedUpperCount: number; default: not declared - winsorizeFactor().return.diagnostics.coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; default: not declared - winsorizeFactor().return.diagnostics.warnings: string[]; default: not declared - winsorizeFactor().return.entries: import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - winsorizeFactor(input): import('@insiderfinance/totalfinance/research').WinsorizeFactorInput; default: not declared - winsorizeFactor(input).entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - winsorizeFactor(input).method: import('@insiderfinance/totalfinance/research').WinsorizationMethod; default: not declared - winsorizeFactor(input).minimumCoverageFraction?: number; default: not declared ### @insiderfinance/totalfinance#risk Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const risk: typeof import('@insiderfinance/totalfinance/risk'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustPValues: (pValues: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').MultipleTestOptions) => import('@insiderfinance/totalfinance/risk').MultipleTestResult; default: not declared — Adjust a set of p-values for multiple testing. Bonferroni/Šidák/Holm control the family-wise error rate; Benjamini–Hochberg controls the false-discovery rate. Returns adjusted p-values (input order) and the rejection decisions at `alpha`. - adjustPValues().return.adjusted: number[]; default: not declared — Adjusted p-values aligned with the input order. - adjustPValues().return.alpha: number; default: not declared - adjustPValues().return.method: import('@insiderfinance/totalfinance/risk').MultipleTestMethod; default: not declared - adjustPValues().return.rejected: boolean[]; default: not declared — Whether each hypothesis is rejected at `alpha` (`adjusted ≤ alpha`). - adjustPValues(options)?: import('@insiderfinance/totalfinance/risk').MultipleTestOptions; default: not declared - adjustPValues(options).alpha?: number; default: not declared — Significance level (default 0.05). - adjustPValues(options).method?: import('@insiderfinance/totalfinance/risk').MultipleTestMethod; default: not declared — Correction method (default `'holm'`). - adjustPValues(pValues): ArrayLike; default: not declared - aggregateGreeks: (positions: readonly import('@insiderfinance/totalfinance/risk').Position[]) => import('@insiderfinance/totalfinance/risk').AggregateGreeksResult; default: not declared — Aggregate per-position Greeks into book-level totals, each scaled by the position's signed `quantity` (default 1) AND its contract `multiplier` (default 1) — per-share option Greeks with `quantity` in contracts need `multiplier: 100`, and the result says so. Missing Greeks count as 0, so a mixed book of options and deltas aggregates cleanly. Greeks are in the one unit system (theta per day, vega per vol point, rho per 1%). Returns the standard `Computed` envelope (`value` = the totals). - aggregateGreeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ positions: number; missingGreeks: 'counted-as-zero'; contractMultiplier: 'applied'; greekUnits: { theta: 'perDay'; vega: 'per1Percent'; rho: 'per1Percent'; }; }>; default: not declared — Every applied convention, echoed back. - aggregateGreeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - aggregateGreeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - aggregateGreeks().return.value: import('@insiderfinance/totalfinance/risk').PortfolioGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - aggregateGreeks(positions): readonly import('@insiderfinance/totalfinance/risk').Position[]; default: not declared - analyzeBook: (positions: readonly import('@insiderfinance/totalfinance/risk').BookPosition[], options?: import('@insiderfinance/totalfinance/risk').BookOptions) => import('@insiderfinance/totalfinance/risk').BookRisk; default: not declared — Aggregate a book of strategy positions into net risk: greeks, beta-weighted delta, margin, concentration, per-position + per-underlying breakdowns, and (optionally) scenario P&L. - analyzeBook().return.assumptions: { conventionsVersion: string; indexPrice?: number; multiplier: number; }; default: not declared - analyzeBook().return.assumptions.conventionsVersion: string; default: not declared - analyzeBook().return.assumptions.indexPrice?: number; default: not declared - analyzeBook().return.assumptions.multiplier: number; default: not declared - analyzeBook().return.betaWeightedDelta?: import('@insiderfinance/totalfinance/risk').BetaWeightedDeltaResult; default: not declared — Present when `options.indexPrice` is given. - analyzeBook().return.byPosition: import('@insiderfinance/totalfinance/risk').PositionRisk[]; default: not declared - analyzeBook().return.byUnderlying: import('@insiderfinance/totalfinance/risk').UnderlyingRisk[]; default: not declared - analyzeBook().return.concentration: import('@insiderfinance/totalfinance/risk').ConcentrationValues; default: not declared — Concentration on per-underlying margin — how much buying power sits in one name (bare values; the report wrapper lives on `concentration()` itself). - analyzeBook().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - analyzeBook().return.greeks: import('@insiderfinance/totalfinance/risk').BookGreeks; default: not declared — Net greeks, display units. - analyzeBook().return.margin: { total: number; buyingPowerReduction: number; }; default: not declared - analyzeBook().return.margin.buyingPowerReduction: number; default: not declared - analyzeBook().return.margin.total: number; default: not declared - analyzeBook().return.scenarios?: import('@insiderfinance/totalfinance/risk').ScenarioResult[]; default: not declared — Present when `options.scenarios` is given. - analyzeBook().return.value: number; default: not declared — Net unrealized P&L of the book ($) — Σ each position's `Position.value()` (P&L since entry), not liquidation NAV. - analyzeBook(options)?: import('@insiderfinance/totalfinance/risk').BookOptions; default: not declared - analyzeBook(options).indexPrice?: number; default: not declared — Reference index price → beta-weighted delta (the "net delta in SPY terms" read-out). - analyzeBook(options).multiplier?: number; default: not declared — Contract multiplier for margin (default 100). - analyzeBook(options).regulationTRate?: number; default: not declared — Reg-T naked-margin rate knob, forwarded to `optionsMargin` as its `equityRate`. - analyzeBook(options).scenarios?: readonly import('@insiderfinance/totalfinance/risk').Scenario[]; default: not declared — Optional book P&L under scenarios (reuses `stressTest` / `taylorPnl`). - analyzeBook(positions): readonly import('@insiderfinance/totalfinance/risk').BookPosition[]; default: not declared - betaWeightedDelta: (positions: readonly import('@insiderfinance/totalfinance/risk').BetaWeightedPosition[], options: { indexPrice: number; }) => import('@insiderfinance/totalfinance/risk').BetaWeightedDeltaResult; default: not declared — Beta-weight a book's delta to a reference index — the standard "what's my net delta in SPY terms" read-out. Each position's dollar delta `δ·price` is scaled by its beta and divided by the index price to express the whole book as index-equivalent shares. - betaWeightedDelta().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - betaWeightedDelta().return.assumptions.conventionsVersion: string; default: not declared - betaWeightedDelta().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - betaWeightedDelta().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - betaWeightedDelta().return.dollarDelta: number; default: not declared — Net beta-weighted dollar delta (`Σ δ·price·β`). - betaWeightedDelta().return.indexDelta: number; default: not declared — Net exposure in index-equivalent shares (`Σ δ·price·β / indexPrice`). - betaWeightedDelta().return.perPosition: { dollarDelta: number; indexDelta: number; }[]; default: not declared - betaWeightedDelta(options): { indexPrice: number; }; default: not declared - betaWeightedDelta(options).indexPrice: number; default: not declared - betaWeightedDelta(positions): readonly import('@insiderfinance/totalfinance/risk').BetaWeightedPosition[]; default: not declared - blackLitterman: (options: import('@insiderfinance/totalfinance/risk').BlackLittermanOptions) => import('@insiderfinance/totalfinance/risk').BlackLittermanResult; default: not declared — Black-Litterman (1992): blend a market-equilibrium prior on expected returns with subjective views to get a posterior `μ_BL` and covariance, then mean-variance-optimize. The prior is either supplied (`priorMean`) or reverse-engineered from market weights (`π = δ·Σ·w_mkt`); each view `j` carries an uncertainty `Ω_jj` (default the He–Litterman `τ·pᵀΣp`). Posterior: `M = [(τΣ)⁻¹ + PᵀΩ⁻¹P]⁻¹`, `μ_BL = M·[(τΣ)⁻¹π + PᵀΩ⁻¹Q]`, `Σ_post = Σ + M`. Returns the standard `Computed` envelope (dx §2.4): the defaulted `tau: 0.05` / `riskAversion: 2.5` are echoed in `assumptions` (never silently applied), and the posterior solve's convergence lives in `diagnostics.converged` with an `optimize.not_converged` warning when it fails. - blackLitterman().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ tau: number; riskAversion: number; views: number; }>; default: not declared — Every applied convention, echoed back. - blackLitterman().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - blackLitterman().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - blackLitterman().return.value: { priorMean: number[]; posteriorMean: number[]; posteriorCovariance: number[][]; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - blackLitterman().return.value.posteriorCovariance: number[][]; default: not declared — Posterior return covariance `Σ + M`, where `M` is the posterior covariance of the mean. - blackLitterman().return.value.posteriorMean: number[]; default: not declared — Posterior (views-blended) expected returns. - blackLitterman().return.value.priorMean: number[]; default: not declared — The supplied or market-implied equilibrium prior π. - blackLitterman().return.value.weights: number[]; default: not declared — Mean-variance-optimal weights under the posterior. - blackLitterman(options): import('@insiderfinance/totalfinance/risk').BlackLittermanOptions; default: not declared - blackLitterman(options).constraints?: import('@insiderfinance/totalfinance/risk').OptimizeConstraints; default: not declared — Constraints applied to the posterior mean-variance weights. - blackLitterman(options).covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Asset return covariance Σ (n×n). - blackLitterman(options).marketWeights?: ArrayLike; default: not declared — Market-cap weights to reverse-engineer the prior `π = δ·Σ·w_mkt`. - blackLitterman(options).priorMean?: ArrayLike; default: not declared — Prior (equilibrium) expected returns π. Provide this, or `marketWeights` to imply it. - blackLitterman(options).riskAversion?: number; default: not declared — Risk-aversion δ for the implied prior and the posterior mean-variance weights. Default 2.5. - blackLitterman(options).tau?: number; default: not declared — Scalar τ scaling the prior uncertainty of the mean (default 0.05). - blackLitterman(options).views: import('@insiderfinance/totalfinance/risk').BlackLittermanView[]; default: not declared — Investor views (at least one). - bookVaR: (positions: readonly import('@insiderfinance/totalfinance/risk').BookVaRPosition[], options: import('@insiderfinance/totalfinance/risk').BookVaROptions) => import('@insiderfinance/totalfinance/risk').BookVaRResult; default: not declared - bookVaR().return.assumptions: { conventionsVersion: string; confidence: number; horizonDays: number; tradingDaysPerYear: number; underlyings: string[]; samples?: number; seed?: number; }; default: not declared - bookVaR().return.assumptions.confidence: number; default: not declared - bookVaR().return.assumptions.conventionsVersion: string; default: not declared - bookVaR().return.assumptions.horizonDays: number; default: not declared - bookVaR().return.assumptions.samples?: number; default: not declared - bookVaR().return.assumptions.seed?: number; default: not declared - bookVaR().return.assumptions.tradingDaysPerYear: number; default: not declared - bookVaR().return.assumptions.underlyings: string[]; default: not declared — Sorted underlyings — the row/col order of `options.correlation`. - bookVaR().return.components: import('@insiderfinance/totalfinance/risk').BookVaRComponent[]; default: not declared — Per-underlying decomposition (from the linear risk), sorted by `componentVaR` desc. - bookVaR().return.confidence: number; default: not declared - bookVaR().return.cornishFisher?: import('@insiderfinance/totalfinance/risk').BookVaRMethodResult; default: not declared — Cornish-Fisher **gamma-adjusted** analytic VaR — the parametric quantile corrected for the P&L skewness/kurtosis the gamma induces. Present unless `method: 'monteCarlo'` AND the CF expansion is in its valid (monotone) domain; when a very convex book pushes it out of domain it is omitted and a `risk.cornish_fisher_out_of_domain` warning points to `monteCarlo`. - bookVaR().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - bookVaR().return.horizonDays: number; default: not declared - bookVaR().return.monteCarlo?: import('@insiderfinance/totalfinance/risk').BookVaRMethodResult; default: not declared — Delta-gamma (gamma-exact), seeded Monte-Carlo VaR — present unless `method: 'parametric'`. - bookVaR().return.parametric?: import('@insiderfinance/totalfinance/risk').BookVaRMethodResult; default: not declared — Delta-normal (linear) VaR — present unless `method: 'monteCarlo'`. - bookVaR(options): import('@insiderfinance/totalfinance/risk').BookVaROptions; default: not declared - bookVaR(options).confidence?: number; default: not declared — Confidence level in (0, 1). Default 0.95. - bookVaR(options).correlation?: readonly (readonly number[])[]; default: not declared — Spot-return correlation matrix, rows/cols in `assumptions.underlyings` (sorted) order. Default I. - bookVaR(options).factors: Record; default: not declared — Per-underlying risk factors — MUST cover every underlying present in the book. - bookVaR(options).horizonDays?: number; default: not declared — VaR horizonPeriods in (trading) days. Default 1. - bookVaR(options).method?: 'both' | 'parametric' | 'monteCarlo'; default: not declared — Which method(s) to compute. Default `'both'`. - bookVaR(options).samples?: number; default: not declared — Monte-Carlo draws. Default 10,000; capped at 1,000,000. - bookVaR(options).seed?: number; default: not declared — Monte-Carlo PRNG seed (integer). Default 1; echoed for reproducibility. - bookVaR(options).tradingDaysPerYear?: number; default: not declared — Trading days per year for vol annualization. Default 252. - bookVaR(positions): readonly import('@insiderfinance/totalfinance/risk').BookVaRPosition[]; default: not declared - brinsonAttribution: (segments: import('@insiderfinance/totalfinance/risk').BrinsonSegment[], options?: import('@insiderfinance/totalfinance/risk').BrinsonAttributionOptions) => import('@insiderfinance/totalfinance/risk').BrinsonAttribution; default: not declared — Decompose a portfolio's active return vs a benchmark into allocation (sector bets), selection (security picks), and interaction — an exact decomposition (the three sum to the active return). See `docs/specs/attribution.md`. - brinsonAttribution().return.activeReturn: number; default: not declared — `portfolioReturn − benchmarkReturn`. - brinsonAttribution().return.allocation: number; default: not declared — Segment-summed effects (`allocation + selection + interaction = activeReturn`, exact). - brinsonAttribution().return.assumptions: { conventionsVersion: string; method: 'brinson-fachler' | 'brinson-hood-beebower'; }; default: not declared - brinsonAttribution().return.assumptions.conventionsVersion: string; default: not declared - brinsonAttribution().return.assumptions.method: 'brinson-fachler' | 'brinson-hood-beebower'; default: not declared - brinsonAttribution().return.benchmarkReturn: number; default: not declared - brinsonAttribution().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - brinsonAttribution().return.interaction: number; default: not declared - brinsonAttribution().return.method: 'brinson-fachler' | 'brinson-hood-beebower'; default: not declared - brinsonAttribution().return.portfolioReturn: number; default: not declared - brinsonAttribution().return.segments: import('@insiderfinance/totalfinance/risk').SegmentEffect[]; default: not declared - brinsonAttribution().return.selection: number; default: not declared - brinsonAttribution(options)?: import('@insiderfinance/totalfinance/risk').BrinsonAttributionOptions; default: not declared - brinsonAttribution(options).method?: 'brinson-fachler' | 'brinson-hood-beebower'; default: not declared — Allocation convention; default `'brinson-fachler'` (benchmark-relative). - brinsonAttribution(segments): import('@insiderfinance/totalfinance/risk').BrinsonSegment[]; default: not declared - checkLeakage: (splits: import('@insiderfinance/totalfinance/risk').Split[]) => import('@insiderfinance/totalfinance/risk').LeakageReport; default: not declared — Flag any split whose train and test index sets overlap (look-ahead leakage). The findings are `research.train_test_leakage` warnings on `diagnostics.warnings` (one per leaking split), with the structured per-split detail mirrored on `leaks` and a `clean` verdict. - checkLeakage().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - checkLeakage().return.assumptions.conventionsVersion: string; default: not declared - checkLeakage().return.clean: boolean; default: not declared — `true` when no split leaks. - checkLeakage().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — The leakage warnings themselves (one `research.train_test_leakage` per leaking split). - checkLeakage().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - checkLeakage().return.leaks: import('@insiderfinance/totalfinance/risk').LeakageIssue[]; default: not declared — Per-split leak details, aligned with `diagnostics.warnings`. - checkLeakage(splits): import('@insiderfinance/totalfinance/risk').Split[]; default: not declared - concentration: (weights: ArrayLike, options?: { topK?: number; }) => import('@insiderfinance/totalfinance/risk').ConcentrationResult; default: not declared — Concentration of a (possibly long/short) weight vector, measured on gross-normalized shares `s_i = |w_i| / Σ|w|`: the HHI and its reciprocal effective-N, the largest and top-k shares, and the Gini coefficient. - concentration().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - concentration().return.assumptions.conventionsVersion: string; default: not declared - concentration().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - concentration().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - concentration().return.effectiveCount: number | null; default: not declared — Effective number of positions `1 / HHI`; `null` when the book has zero gross exposure (there is nothing to concentrate — Law 7: an undefined quantity is null-with-reason, never NaN). - concentration().return.gini: number; default: not declared — Gini coefficient of the gross-normalized weight distribution (0 = equal, →1 = concentrated). - concentration().return.hhi: number; default: not declared — Herfindahl-Hirschman index `Σ s_i²` on gross-normalized weights (1 = one name, 1/n = equal). - concentration().return.topKShare: number; default: not declared — Combined share of the top-`k` names (default `k = min(5, n)`). - concentration().return.topWeight: number; default: not declared — Largest single name's share of gross exposure. - concentration(options)?: { topK?: number; }; default: not declared - concentration(options).topK?: number; default: not declared - concentration(weights): ArrayLike; default: not declared - conditionalValueAtRiskOptimize: (scenarios: number[][], options?: import('@insiderfinance/totalfinance/risk').CVaROptimizeOptions) => import('@insiderfinance/totalfinance/risk').CVaROptimizeResult; default: not declared — Minimize portfolio CVaR over a scenario set (Rockafellar–Uryasev, projected subgradient). `value` carries the weights plus the optimized `conditionalValueAtRisk` and the `valueAtRisk` threshold; `assumptions` additionally echo the tail confidence `alpha`. - conditionalValueAtRiskOptimize().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; confidence: number; }>; default: not declared — Every applied convention, echoed back. - conditionalValueAtRiskOptimize().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - conditionalValueAtRiskOptimize().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - conditionalValueAtRiskOptimize().return.value: { weights: number[]; objective: number; conditionalValueAtRisk: number; valueAtRisk: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - conditionalValueAtRiskOptimize().return.value.conditionalValueAtRisk: number; default: not declared — The optimized CVaR — mean loss over the worst `(1 − α)` tail (a positive magnitude). - conditionalValueAtRiskOptimize().return.value.objective: number; default: not declared - conditionalValueAtRiskOptimize().return.value.valueAtRisk: number; default: not declared — The VaR threshold (loss quantile at α) at the solution. - conditionalValueAtRiskOptimize().return.value.weights: number[]; default: not declared - conditionalValueAtRiskOptimize(options)?: import('@insiderfinance/totalfinance/risk').CVaROptimizeOptions; default: not declared - conditionalValueAtRiskOptimize(options).alpha?: number; default: not declared — Tail confidence α: optimize the mean of the worst `(1 − α)` fraction of losses. Default 0.95. - conditionalValueAtRiskOptimize(options).bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - conditionalValueAtRiskOptimize(options).budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - conditionalValueAtRiskOptimize(options).groups?: import('@insiderfinance/totalfinance/risk').GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - conditionalValueAtRiskOptimize(options).longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - conditionalValueAtRiskOptimize(options).maximumIterations?: number; default: not declared — Projected-subgradient iteration cap. Default 4000. - conditionalValueAtRiskOptimize(options).minReturn?: number; default: not declared — Optional minimum mean return `μᵀw ≥ minReturn` (μ = per-asset scenario means). - conditionalValueAtRiskOptimize(options).step?: number; default: not declared — Initial subgradient step size (decays as `step/√t`). Defaults to `1/‖g₀‖` — the step that moves the FIRST iterate a distance of about 1 in weight space, which is the scale weights live on. A fixed default (this used to be `1`) is unit-dependent: on decimal daily returns ‖g‖ ≈ 0.01, so every step moved ~1e-2·(1/√t) and the run plateaued a long way from the optimum while reporting `converged: true`. Pass an explicit `step` only to override that scaling. - conditionalValueAtRiskOptimize(options).tolerance?: number; default: not declared — Relative-improvement tolerance for convergence: the run is `converged` only once the best CVaR improves by less than this over the final 25 iterations. Default `1e-6`. - conditionalValueAtRiskOptimize(options).transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - conditionalValueAtRiskOptimize(options).transactionCosts.perUnitTurnover: number | number[]; default: not declared - conditionalValueAtRiskOptimize(options).transactionCosts.previousWeights: number[]; default: not declared - conditionalValueAtRiskOptimize(options).turnover?: import('@insiderfinance/totalfinance/risk').TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - conditionalValueAtRiskOptimize(scenarios): number[][]; default: not declared - costAwareKelly: (input: import('@insiderfinance/totalfinance/risk').CostAwareKellyInput) => import('@insiderfinance/totalfinance/risk').CostAwareKelly; default: not declared — Cost-aware Kelly for a continuous edge. Costs — a per-period holding cost plus an amortized round-trip cost, `c = holdingCost + roundTripCost/horizonPeriods` — reduce the drift (`μ → μ − c`, variance unchanged), so the growth-optimal size shrinks to `netKelly = max(0, (μ−c)/σ²)` and below the breakeven cost `μ` the edge is not worth betting. Reports gross vs net Kelly, the growth drag, the penalty for naively betting gross while paying costs, and refuses a losing bet. See `docs/specs/cost-aware-kelly.md`. - costAwareKelly().return.assumptions: { conventionsVersion: string; fraction: number; edgeType: 'gaussian' | 'returns'; }; default: not declared - costAwareKelly().return.assumptions.conventionsVersion: string; default: not declared - costAwareKelly().return.assumptions.edgeType: 'returns' | 'gaussian'; default: not declared - costAwareKelly().return.assumptions.fraction: number; default: not declared - costAwareKelly().return.breakevenCost: number; default: not declared — `μ` — the cost at which the edge vanishes. - costAwareKelly().return.costPerPeriod: number; default: not declared — Per-period cost drag `c = holdingCost + roundTripCost/horizonPeriods`. - costAwareKelly().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - costAwareKelly().return.grossGrowth: number | null; default: not declared — `μ²/(2σ²)` — expected log-growth at gross Kelly with no costs; `null` with `grossKelly`. - costAwareKelly().return.grossKelly: number | null; default: not declared — `μ/σ²` — the growth-optimal fraction ignoring costs; `null` when the edge has zero variance (C hygiene). - costAwareKelly().return.growthDrag: number | null; default: not declared — `grossGrowth − netGrowth` — the log-growth the costs cost you; `null` with `grossKelly`. - costAwareKelly().return.ignoringCostsGrowth: number | null; default: not declared — Log-growth of naively betting gross Kelly while paying costs (`≤ netGrowth`); `null` with `grossKelly`. - costAwareKelly().return.isProfitable: boolean; default: not declared — Whether the net edge is positive (`c < μ`). - costAwareKelly().return.mean: number; default: not declared — The edge mean `μ` used. - costAwareKelly().return.netGrowth: number | null; default: not declared — `(μ−c)²/(2σ²)` — expected log-growth at net Kelly (the achievable optimum with costs); `null` with `grossKelly`. - costAwareKelly().return.netKelly: number | null; default: not declared — `max(0, (μ−c)/σ²)` — the cost-aware growth-optimal fraction; `null` with `grossKelly`. - costAwareKelly().return.rationale: string; default: not declared — Prose an agent relays. - costAwareKelly().return.recommendedFraction: number | null; default: not declared — `fraction · netKelly` — the recommended size after fractional-Kelly; `null` with `grossKelly`. - costAwareKelly().return.variance: number; default: not declared — The edge variance `σ²` used. - costAwareKelly(input): import('@insiderfinance/totalfinance/risk').CostAwareKellyInput; default: not declared - costAwareKelly(input).edge: { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; default: not declared — The per-period edge: a Gaussian mean/variance, or a return sample (μ, σ² computed from it). - costAwareKelly(input).edge.gaussian: { mean: number; variance: number; }; default: not declared - costAwareKelly(input).edge.gaussian.mean: number; default: not declared - costAwareKelly(input).edge.gaussian.variance: number; default: not declared - costAwareKelly(input).edge.returns: ArrayLike; default: not declared - costAwareKelly(input).fraction?: number; default: not declared — Fractional-Kelly multiplier applied to `netKelly`. Default 0.5. Must be > 0. - costAwareKelly(input).holdingCost?: number; default: not declared — Per-period holding cost per unit of position (financing / borrow / carry). Default 0. - costAwareKelly(input).horizonPeriods?: number; default: not declared — Expected holding periods, to amortize `roundTripCost`. Required when `roundTripCost > 0`. - costAwareKelly(input).roundTripCost?: number; default: not declared — One-time round-trip cost per unit of position (entry + exit). Default 0. Requires `horizonPeriods`. - covariance: (input: import('@insiderfinance/totalfinance/risk').CovarianceInput, options?: import('@insiderfinance/totalfinance/risk').CovarianceOptions) => import('@insiderfinance/totalfinance/risk').CovarianceResult; default: not declared — Estimate a portfolio covariance (and mean returns) from raw return history — the first step of every optimizer journey. Delegates estimation to `estimateCovariance` (`method: 'auto'` defaults to the sample covariance and shrinks only when it is singular/ill-conditioned, always disclosing what it did), and reports the full conditioning diagnostics so a caller knows the matrix is safe to invert BEFORE optimizing with it. - covariance().return.assumptions: { conventionsVersion: string; method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; observations: number; orientation: 'observations-major'; }; default: not declared - covariance().return.assumptions.conventionsVersion: string; default: not declared - covariance().return.assumptions.method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; default: not declared — The estimator actually used (`'auto'` resolves before reporting). - covariance().return.assumptions.observations: number; default: not declared - covariance().return.assumptions.orientation: 'observations-major'; default: not declared — Returns are treated as one row per PERIOD; means are per-period, not annualized. - covariance().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { conditionNumber: number | null; isPositiveDefinite: boolean; effectiveRank: number; minEigenvalue: number; maxEigenvalue: number; shrinkage?: number; lambda?: number; }; default: not declared - covariance().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - covariance().return.diagnostics.conditionNumber: number | null; default: not declared — `null` when the matrix is singular (κ = ∞ has no JSON representation; see warnings). - covariance().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - covariance().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - covariance().return.diagnostics.effectiveRank: number; default: not declared - covariance().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - covariance().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - covariance().return.diagnostics.isPositiveDefinite: boolean; default: not declared - covariance().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - covariance().return.diagnostics.lambda?: number; default: not declared - covariance().return.diagnostics.maxEigenvalue: number; default: not declared - covariance().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - covariance().return.diagnostics.minEigenvalue: number; default: not declared - covariance().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - covariance().return.diagnostics.shrinkage?: number; default: not declared - covariance().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - covariance().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - covariance().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - covariance().return.value: import('@insiderfinance/totalfinance/risk').CovarianceValue; default: not declared - covariance(input): import('@insiderfinance/totalfinance/risk').CovarianceInput; default: not declared - covariance(input).assets?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result for self-description. - covariance(input).returns: number[][]; default: not declared — Observations-major returns: `returns[t][k]` is asset `k`'s simple return in period `t` — one row per period, one column per asset (the natural CSV/dataframe orientation, and the TRANSPOSE of `@insiderfinance/totalfinance/math`'s variables-major `estimateCovariance` input). Every row must have the same number of assets. - covariance(options)?: import('@insiderfinance/totalfinance/math').EstimateCovarianceOptions; default: not declared - covariance(options).conditionThreshold?: number; default: not declared — Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. - covariance(options).halfLife?: number; default: not declared — EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. - covariance(options).lambda?: number; default: not declared — EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). - covariance(options).ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` (the market-model target, best-specified for stock returns). - covariance(options).market?: ArrayLike; default: not declared — Observed market return series for the `'single-index'` target (length `T`). Omitted → the equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. - covariance(options).method?: import('@insiderfinance/totalfinance/math').CovarianceMethod; default: not declared — Estimator; default `'auto'`. - covariance(options).population?: boolean; default: not declared — Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). - covariance(options).ridge?: number; default: not declared — Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. - covarianceToCorrelation: (covariance: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Convert a covariance matrix to a correlation matrix (unit diagonal). - covarianceToCorrelation(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - deflatedSharpeRatio: (statistics: import('@insiderfinance/totalfinance/risk').SharpeStatistics, trials: { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }) => import('@insiderfinance/totalfinance/risk').DeflatedSharpeResult; default: not declared — Deflated Sharpe Ratio (Bailey & López de Prado 2014): the PSR evaluated against the *expected maximum* Sharpe that `N` independent trials would produce by chance, so selecting the best of a parameter sweep is penalised. Pass the trial Sharpes (variance computed for you) or `trialCount` plus their variance directly. - deflatedSharpeRatio().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - deflatedSharpeRatio().return.assumptions.conventionsVersion: string; default: not declared - deflatedSharpeRatio().return.deflatedSharpe: number | null; default: not declared — `null` when the statistics carry no Sharpe (a zero-variance series). - deflatedSharpeRatio().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - deflatedSharpeRatio().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - deflatedSharpeRatio().return.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. - deflatedSharpeRatio().return.probabilisticSharpe: number | null; default: not declared — The un-deflated PSR (benchmark 0), for comparison. - deflatedSharpeRatio().return.trialCount: number; default: not declared - deflatedSharpeRatio(statistics): import('@insiderfinance/totalfinance/risk').SharpeStatistics; default: not declared - deflatedSharpeRatio(statistics).kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - deflatedSharpeRatio(statistics).observations: number; default: not declared — Number of observations. - deflatedSharpeRatio(statistics).sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - deflatedSharpeRatio(statistics).skewness: number; default: not declared — Skewness `γ₃` of the returns. - deflatedSharpeRatio(trials): { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }; default: not declared - deflatedSharpeRatio(trials).trialCount: number; default: not declared - deflatedSharpeRatio(trials).trialSharpes: ArrayLike; default: not declared - deflatedSharpeRatio(trials).varianceSharpe: number; default: not declared - diversificationRatio: (weights: ArrayLike, covariance: import('@insiderfinance/totalfinance/math').Matrix) => number; default: not declared — Diversification ratio: weighted-average asset volatility ÷ portfolio volatility (≥ 1). A zero-volatility portfolio has no finite ratio — that degenerate input throws a typed `input.degenerate` error instead of returning the plausible but false value `1` (H09). - diversificationRatio(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - diversificationRatio(weights): ArrayLike; default: not declared - drawdownAtRisk: (returns: ArrayLike, options?: { confidence?: number; }) => import('@insiderfinance/totalfinance/risk').DrawdownAtRisk; default: not declared — Drawdown-at-Risk and Conditional Drawdown-at-Risk (Chekhlov–Uryasev) from a return series: the `α`-quantile of the path's underwater (fractional-drawdown) curve, and the mean drawdown beyond it. Deterministic; no simulation. See `docs/specs/evt-tail-risk.md`. - drawdownAtRisk().return.assumptions: { conventionsVersion: string; confidence: number; }; default: not declared - drawdownAtRisk().return.assumptions.confidence: number; default: not declared - drawdownAtRisk().return.assumptions.conventionsVersion: string; default: not declared - drawdownAtRisk().return.conditionalDrawdownAtRisk: number; default: not declared — `CDaR_α` — the mean drawdown beyond `DaR_α` (Chekhlov–Uryasev; ≥ `DaR_α`). - drawdownAtRisk().return.confidence: number; default: not declared - drawdownAtRisk().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - drawdownAtRisk().return.drawdownAtRisk: number; default: not declared — `DaR_α` — the `α`-quantile of the fractional drawdown series (≥ 0). - drawdownAtRisk().return.maxDrawdown: number; default: not declared — The worst drawdown on the path (context). - drawdownAtRisk().return.observations: number; default: not declared - drawdownAtRisk(options)?: { confidence?: number; }; default: not declared - drawdownAtRisk(options).confidence?: number; default: not declared - drawdownAtRisk(returns): ArrayLike; default: not declared - efficientFrontier: (input: import('@insiderfinance/totalfinance/risk').EfficientFrontierInput) => import('@insiderfinance/totalfinance/risk').EfficientFrontierResult; default: not declared — Trace the constrained mean-variance efficient frontier by composing `minVariance`, `meanVariance`, and (with a risk-free rate) `maxSharpe` under ONE constraint set. ```ts efficientFrontier({ mean, covariance, grid: { kind: 'points', count: 20 }, constraints: { longOnly: true }, riskFreeRatePerPeriod: 0.04 / 252, }); ``` `value.points` keeps every grid point in order; a target outside the achievable range is a `feasible: false` point whose `reason` names the range, never a throw. `diagnostics.monotone` reports whether volatility rises with expected return across the solved points (the shape a correct frontier has) and names the first violation in a warning when it does not. - efficientFrontier().return.assumptions: { conventionsVersion: string; objective: 'mean-variance'; budget: number; grid: { kind: import('@insiderfinance/totalfinance/risk').EfficientFrontierGridKind; count: number; }; riskFreeRatePerPeriod?: number; constraintSummary: string; }; default: not declared - efficientFrontier().return.assumptions.budget: number; default: not declared - efficientFrontier().return.assumptions.constraintSummary: string; default: not declared — Prose summary of the constraint set every point was solved under. - efficientFrontier().return.assumptions.conventionsVersion: string; default: not declared - efficientFrontier().return.assumptions.grid: { kind: import('@insiderfinance/totalfinance/risk').EfficientFrontierGridKind; count: number; }; default: not declared - efficientFrontier().return.assumptions.grid.count: number; default: not declared - efficientFrontier().return.assumptions.grid.kind: 'risk-aversion' | 'target-return' | 'points'; default: not declared - efficientFrontier().return.assumptions.objective: 'mean-variance'; default: not declared - efficientFrontier().return.assumptions.riskFreeRatePerPeriod?: number; default: not declared - efficientFrontier().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { converged: boolean; iterations: number; solvedCount: number; failedCount: number; monotone: boolean; maximumReturnBounded: boolean | null; }; default: not declared - efficientFrontier().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - efficientFrontier().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. Every solved point converged (false when any point failed or stopped early). - efficientFrontier().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - efficientFrontier().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - efficientFrontier().return.diagnostics.failedCount: number; default: not declared - efficientFrontier().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - efficientFrontier().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. Total solver iterations across the sweep. - efficientFrontier().return.diagnostics.maximumReturnBounded: boolean | null; default: not declared — `true` when finite, `false` when unbounded, `null` when the proof is undetermined. - efficientFrontier().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - efficientFrontier().return.diagnostics.monotone: boolean; default: not declared — Volatility is non-decreasing with expected return across the solved points. - efficientFrontier().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - efficientFrontier().return.diagnostics.solvedCount: number; default: not declared - efficientFrontier().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - efficientFrontier().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - efficientFrontier().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - efficientFrontier().return.value: import('@insiderfinance/totalfinance/risk').EfficientFrontierValue; default: not declared - efficientFrontier(input): import('@insiderfinance/totalfinance/risk').EfficientFrontierInput; default: not declared - efficientFrontier(input).constraints?: import('@insiderfinance/totalfinance/risk/optimize').EfficientFrontierConstraints; default: not declared — The optimizer's feasible-region grammar (`longOnly`, `bounds`, `budget`, `groups`, …). - efficientFrontier(input).covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared — Asset return covariance Σ (n×n). - efficientFrontier(input).grid: import('@insiderfinance/totalfinance/risk').EfficientFrontierGrid; default: not declared - efficientFrontier(input).mean: ArrayLike; default: not declared — Per-asset expected returns as a dense stored-data ArrayLike (same period as covariance). - efficientFrontier(input).riskFreeRatePerPeriod?: number; default: not declared — Risk-free rate in the SAME per-period units as `mean` (a daily problem takes 0.04/252, not 0.04) — the `maxSharpe` spelling. When present every point reports a Sharpe ratio and the tangency portfolio is solved and reported under `value.tangency`. - estimateExpectedReturns: (input: import('@insiderfinance/totalfinance/risk').EstimateExpectedReturnsInput) => import('@insiderfinance/totalfinance/risk').ExpectedReturnsResult; default: not declared — Estimate per-asset expected returns under an EXPLICIT method — the `mean` for `maxSharpe`, `meanVariance`, `kelly`, and `efficientFrontier`. ```ts estimateExpectedReturns({ method: 'historical-mean', returns, periodsPerYear: 252 }); estimateExpectedReturns({ method: 'exponentially-weighted', returns, halfLifePeriods: 60 }); estimateExpectedReturns({ method: 'capital-asset-pricing', betas: [0.8, 1.2], annualRiskFreeRate: 0.04, annualMarketRiskPremium: 0.05, }); estimateExpectedReturns({ method: 'supplied', expectedReturns: [0.08, 0.1], annualized: true }); ``` `value.annualized` always states the unit of the result; the sample methods report per-period means unless `periodsPerYear` is given, the capital-asset-pricing method is annual by construction, and the supplied method carries the caller's own flag. - estimateExpectedReturns().return.assumptions: { conventionsVersion: string; method: import('@insiderfinance/totalfinance/risk').ExpectedReturnsMethod; periodsPerYear?: number; halfLifePeriods?: number; annualRiskFreeRate?: number; annualMarketRiskPremium?: number; asOf?: import('@insiderfinance/totalfinance/core').EpochMs; estimationConvention: string; }; default: not declared - estimateExpectedReturns().return.assumptions.annualMarketRiskPremium?: number; default: not declared — Echoed for `'capital-asset-pricing'`. - estimateExpectedReturns().return.assumptions.annualRiskFreeRate?: number; default: not declared — Echoed for `'capital-asset-pricing'`. - estimateExpectedReturns().return.assumptions.asOf?: number; default: not declared — The resolved point-in-time cut (epoch milliseconds), when `asOf` was given. - estimateExpectedReturns().return.assumptions.conventionsVersion: string; default: not declared - estimateExpectedReturns().return.assumptions.estimationConvention: string; default: not declared — Prose statement of exactly how the numbers were produced. - estimateExpectedReturns().return.assumptions.halfLifePeriods?: number; default: not declared — Echoed for `'exponentially-weighted'`. - estimateExpectedReturns().return.assumptions.method: 'supplied' | 'capital-asset-pricing' | 'historical-mean' | 'exponentially-weighted'; default: not declared - estimateExpectedReturns().return.assumptions.periodsPerYear?: number; default: not declared — Echoed when annualization was requested (sample methods only). - estimateExpectedReturns().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { sampleSize: number; effectiveSampleSize?: number; excludedAfterAsOf?: number; }; default: not declared - estimateExpectedReturns().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - estimateExpectedReturns().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - estimateExpectedReturns().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - estimateExpectedReturns().return.diagnostics.effectiveSampleSize?: number; default: not declared — `(Σw)² / Σw²` of the observation weights (`'exponentially-weighted'` only). - estimateExpectedReturns().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - estimateExpectedReturns().return.diagnostics.excludedAfterAsOf?: number; default: not declared — Rows excluded because their timestamp is after `asOf` (when both were supplied). - estimateExpectedReturns().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - estimateExpectedReturns().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - estimateExpectedReturns().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - estimateExpectedReturns().return.diagnostics.sampleSize: number; default: not declared — Return observations consumed (after point-in-time screening); 0 for methods without a sample. - estimateExpectedReturns().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - estimateExpectedReturns().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - estimateExpectedReturns().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - estimateExpectedReturns().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - estimateExpectedReturns().return.value: import('@insiderfinance/totalfinance/risk').ExpectedReturnsValue; default: not declared - estimateExpectedReturns(input): import('@insiderfinance/totalfinance/risk').EstimateExpectedReturnsInput; default: not declared - estimateExpectedReturns(input).annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - estimateExpectedReturns(input).annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - estimateExpectedReturns(input).annualized: boolean; default: not declared — Whether the supplied values are annual (`true`) or per-period (`false`). Required. - estimateExpectedReturns(input).asOf?: string | number; default: not declared — Point-in-time cut: every row whose timestamp is AFTER this instant is excluded from the estimate and the excluded count is disclosed in `diagnostics.excludedAfterAsOf`. Without `observationTimestamps` nothing can be screened — the result then carries a warning. - estimateExpectedReturns(input).assetIds?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result. Optional asset labels aligned to `betas`; echoed on the result. Optional asset labels aligned to `expectedReturns`; echoed on the result. - estimateExpectedReturns(input).betas: number[]; default: not declared — Per-asset market betas (one per asset). - estimateExpectedReturns(input).expectedReturns: number[]; default: not declared — Caller-supplied expected returns, one per asset. - estimateExpectedReturns(input).halfLifePeriods: number; default: not declared — Half-life of the observation weights in PERIODS: observation `t` of `T` carries weight `0.5^((T − 1 − t) / halfLifePeriods)` before normalization, so the most recent row is the heaviest. Required — there is no universal decay rate. - estimateExpectedReturns(input).method: ('capital-asset-pricing') | ('exponentially-weighted') | ('historical-mean') | ('supplied'); default: not declared - estimateExpectedReturns(input).observationTimestamps?: (string | number)[]; default: not declared — Optional observation instants aligned 1:1 with the rows of `returns` (epoch milliseconds or an ISO date / zoned datetime), non-decreasing. Required for `asOf` to screen anything. - estimateExpectedReturns(input).periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily, `12` for monthly data): the reported means become `periodMean × periodsPerYear`. OMITTED means per-period means with `annualized: false` — annualization is never silent. - estimateExpectedReturns(input).returns: number[][]; default: not declared — Observations-major returns — the same orientation as `CovarianceInput`: `returns[t][k]` is asset `k`'s simple return in period `t` (one row per period, one column per asset). - expectedShortfall: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined], number, import('@insiderfinance/totalfinance/risk/value-at-risk').ValueAtRiskAssumptionExtras>; default: not declared — Conditional VaR / expected shortfall (positive loss magnitude), with the same `.explain()`. - expectedShortfall(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined]; default: not declared - expectedShortfall.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - expectedShortfall.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - expectedShortfall.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - expectedShortfall.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - expectedShortfall.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - expectedShortfall.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined]; default: not declared - explainPnl: (input: import('@insiderfinance/totalfinance/risk').ExplainPnlInput) => import('@insiderfinance/totalfinance/risk').PnlExplain; default: not declared - explainPnl().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - explainPnl().return.assumptions.conventionsVersion: string; default: not declared - explainPnl().return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - explainPnl().return.delta: number; default: not declared — Delta term: `Δ·dS`. - explainPnl().return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - explainPnl().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - explainPnl().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - explainPnl().return.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - explainPnl().return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - explainPnl().return.rho: number; default: not declared — Rho term: `Rho·dr`. - explainPnl().return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - explainPnl().return.theta: number; default: not declared — Theta term: `Θ·dt`. - explainPnl().return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - explainPnl().return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - explainPnl().return.total: number; default: not declared — The actual realized P&L. - explainPnl().return.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - explainPnl().return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - explainPnl().return.vega: number; default: not declared — Vega term: `Vega·dσ`. - explainPnl().return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - explainPnl().return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - explainPnl().return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). - explainPnl(input): import('@insiderfinance/totalfinance/risk').ExplainPnlInput; default: not declared - explainPnl(input).actualPnl: number; default: not declared - explainPnl(input).greeks: import('@insiderfinance/totalfinance/risk').PositionGreeks; default: not declared - explainPnl(input).move: import('@insiderfinance/totalfinance/risk').PnlMove; default: not declared - explainPortfolioPnl: (items: readonly import('@insiderfinance/totalfinance/risk').PortfolioPnlItem[]) => import('@insiderfinance/totalfinance/risk').PortfolioPnlExplain; default: not declared — Decompose a portfolio's realized P&L: each position with its own market context (so a book can span underlyings). The book explain is the term-wise sum; each position's explain is preserved. - explainPortfolioPnl().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - explainPortfolioPnl().return.assumptions.conventionsVersion: string; default: not declared - explainPortfolioPnl().return.byPosition: (import('@insiderfinance/totalfinance/risk').PositionPnlExplain & { id?: string; })[]; default: not declared - explainPortfolioPnl().return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - explainPortfolioPnl().return.delta: number; default: not declared — Delta term: `Δ·dS`. - explainPortfolioPnl().return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - explainPortfolioPnl().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - explainPortfolioPnl().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - explainPortfolioPnl().return.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - explainPortfolioPnl().return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - explainPortfolioPnl().return.rho: number; default: not declared — Rho term: `Rho·dr`. - explainPortfolioPnl().return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - explainPortfolioPnl().return.theta: number; default: not declared — Theta term: `Θ·dt`. - explainPortfolioPnl().return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - explainPortfolioPnl().return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - explainPortfolioPnl().return.total: number; default: not declared — The actual realized P&L. - explainPortfolioPnl().return.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - explainPortfolioPnl().return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - explainPortfolioPnl().return.vega: number; default: not declared — Vega term: `Vega·dσ`. - explainPortfolioPnl().return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - explainPortfolioPnl().return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - explainPortfolioPnl().return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). - explainPortfolioPnl(items): readonly import('@insiderfinance/totalfinance/risk').PortfolioPnlItem[]; default: not declared - explainPositionPnl: (input: import('@insiderfinance/totalfinance/risk').ExplainPositionPnlInput) => import('@insiderfinance/totalfinance/risk').PositionPnlExplain; default: not declared - explainPositionPnl().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - explainPositionPnl().return.assumptions.conventionsVersion: string; default: not declared - explainPositionPnl().return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - explainPositionPnl().return.delta: number; default: not declared — Delta term: `Δ·dS`. - explainPositionPnl().return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - explainPositionPnl().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - explainPositionPnl().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - explainPositionPnl().return.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - explainPositionPnl().return.perLeg: import('@insiderfinance/totalfinance/risk').LegPnlExplain[]; default: not declared - explainPositionPnl().return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - explainPositionPnl().return.rho: number; default: not declared — Rho term: `Rho·dr`. - explainPositionPnl().return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - explainPositionPnl().return.theta: number; default: not declared — Theta term: `Θ·dt`. - explainPositionPnl().return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - explainPositionPnl().return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - explainPositionPnl().return.total: number; default: not declared — The actual realized P&L. - explainPositionPnl().return.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - explainPositionPnl().return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - explainPositionPnl().return.vega: number; default: not declared — Vega term: `Vega·dσ`. - explainPositionPnl().return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - explainPositionPnl().return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - explainPositionPnl().return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). - explainPositionPnl(input): import('@insiderfinance/totalfinance/risk').ExplainPositionPnlInput; default: not declared - explainPositionPnl(input).from: import('@insiderfinance/totalfinance/risk').PnlMarket; default: not declared - explainPositionPnl(input).position: import('@insiderfinance/totalfinance/risk').StrategyPosition; default: not declared - explainPositionPnl(input).to: import('@insiderfinance/totalfinance/risk').PnlMarket; default: not declared - extremeValueTailRisk: (returns: ArrayLike, options?: { confidence?: number; } & import('@insiderfinance/totalfinance/risk').GeneralizedParetoFitOptions) => import('@insiderfinance/totalfinance/risk').ExtremeValueTailRisk; default: not declared — Extreme-tail VaR and Expected Shortfall via the MonteCarloNeil–Frey peaks-over-threshold method, shown beside the empirical and normal numbers with a fat-tail ratio. When the confidence sits outside the fitted tail (`1 − p ≥ Nu/n`) EVT cannot extrapolate, so the empirical quantile is reported with a warning instead of a fabricated EVT number. See `docs/specs/evt-tail-risk.md`. - extremeValueTailRisk().return.assumptions: { conventionsVersion: string; confidence: number; }; default: not declared - extremeValueTailRisk().return.assumptions.confidence: number; default: not declared - extremeValueTailRisk().return.assumptions.conventionsVersion: string; default: not declared - extremeValueTailRisk().return.conditionalValueAtRisk: number; default: not declared — EVT Expected Shortfall (`≥ var`; `Infinity` when `ξ ≥ 1`). - extremeValueTailRisk().return.confidence: number; default: not declared - extremeValueTailRisk().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - extremeValueTailRisk().return.empirical: { valueAtRisk: number; conditionalValueAtRisk: number; }; default: not declared — The empirical (historical) VaR/ES at the same confidence, for comparison. - extremeValueTailRisk().return.empirical.conditionalValueAtRisk: number; default: not declared - extremeValueTailRisk().return.empirical.valueAtRisk: number; default: not declared - extremeValueTailRisk().return.fit: import('@insiderfinance/totalfinance/risk').GeneralizedParetoFit; default: not declared — The underlying GPD fit. - extremeValueTailRisk().return.normal: { valueAtRisk: number; conditionalValueAtRisk: number; }; default: not declared — The normal (Gaussian) VaR/ES at the same confidence, for comparison. - extremeValueTailRisk().return.normal.conditionalValueAtRisk: number; default: not declared - extremeValueTailRisk().return.normal.valueAtRisk: number; default: not declared - extremeValueTailRisk().return.tailFatnessRatio: number; default: not declared — `evt.var / normal.var` — how much fatter the tail is than the Gaussian says. - extremeValueTailRisk().return.valueAtRisk: number; default: not declared — EVT VaR — a positive loss magnitude. - extremeValueTailRisk(options)?: { confidence?: number; } & import('@insiderfinance/totalfinance/risk').GeneralizedParetoFitOptions; default: not declared - extremeValueTailRisk(options).confidence?: number; default: not declared - extremeValueTailRisk(options).method?: 'pwm' | 'mle'; default: not declared — Estimator; default `'pwm'` (closed-form, robust). - extremeValueTailRisk(options).minExceedances?: number; default: not declared — Exceedance count below which the fit is warned as unreliable; default 10. - extremeValueTailRisk(options).tailFraction?: number; default: not declared — Worst fraction of losses used as exceedances; default 0.10. Ignored when `threshold` is set. - extremeValueTailRisk(options).threshold?: number; default: not declared — Explicit loss threshold `u` (overrides `tailFraction`). - extremeValueTailRisk(returns): ArrayLike; default: not declared - factorAttribution: (input: import('@insiderfinance/totalfinance/risk').FactorAttributionInput) => import('@insiderfinance/totalfinance/risk').FactorAttribution; default: not declared — Attribute a return series to observable factors by OLS regression, splitting the realized return into a contribution per factor plus a specific (alpha) residual — a decomposition that reconstructs the total exactly. See `docs/specs/attribution.md`. - factorAttribution().return.adjustedRSquared: number; default: not declared - factorAttribution().return.alpha: number; default: not declared — Per-period specific return (the OLS intercept). - factorAttribution().return.assumptions: { conventionsVersion: string; riskFreeRate: number; }; default: not declared - factorAttribution().return.assumptions.conventionsVersion: string; default: not declared - factorAttribution().return.assumptions.riskFreeRate: number; default: not declared - factorAttribution().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - factorAttribution().return.factors: import('@insiderfinance/totalfinance/risk').FactorContribution[]; default: not declared - factorAttribution().return.observations: number; default: not declared - factorAttribution().return.rSquared: number; default: not declared - factorAttribution().return.specificReturn: number; default: not declared — Cumulative specific return `n·alpha` — the part no factor explains. - factorAttribution().return.totalReturn: number; default: not declared — Total of the (excess, if `riskFreeRate` given) return series = `specificReturn + Σ contributions`. - factorAttribution(input): import('@insiderfinance/totalfinance/risk').FactorAttributionInput; default: not declared - factorAttribution(input).factors: import('@insiderfinance/totalfinance/risk').FactorSeries[]; default: not declared — Observable factor return series (each aligned to `returns`). - factorAttribution(input).returns: ArrayLike; default: not declared — The asset/portfolio return series to attribute. - factorAttribution(input).riskFreeRate?: number; default: not declared — Per-period risk-free rate subtracted from `returns` first; default 0. - factorExposure: (covariance: import('@insiderfinance/totalfinance/math').Matrix, options?: { factorCount?: number; correlation?: boolean; }) => import('@insiderfinance/totalfinance/risk').FactorExposureResult; default: not declared — Keep the top-`k` principal components and report each asset's exposure (loading) to them. - factorExposure().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - factorExposure().return.assumptions.conventionsVersion: string; default: not declared - factorExposure().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - factorExposure().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - factorExposure().return.exposure: number[][]; default: not declared — `exposure[assetIndex][factorIndex]` = that asset's loading on the factor. - factorExposure().return.factors: import('@insiderfinance/totalfinance/risk').PcaComponent[]; default: not declared — The retained top-k principal components. - factorExposure().return.varianceExplained: number; default: not declared — Total variance explained by the retained factors. - factorExposure(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - factorExposure(options)?: { factorCount?: number; correlation?: boolean; }; default: not declared - factorExposure(options).correlation?: boolean; default: not declared - factorExposure(options).factorCount?: number; default: not declared - fitGeneralizedParetoTail: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').GeneralizedParetoFitOptions) => import('@insiderfinance/totalfinance/risk').GeneralizedParetoFit; default: not declared — Fit a Generalized Pareto Distribution to the **loss** tail (peaks-over-threshold). Returns the tail index `ξ`, scale `β`, threshold, and exceedance count, with warnings for a thin sample or infinite-moment tails. See `docs/specs/evt-tail-risk.md`. - fitGeneralizedParetoTail().return.assumptions: { conventionsVersion: string; estimator: 'pwm' | 'mle'; }; default: not declared - fitGeneralizedParetoTail().return.assumptions.conventionsVersion: string; default: not declared - fitGeneralizedParetoTail().return.assumptions.estimator: 'pwm' | 'mle'; default: not declared - fitGeneralizedParetoTail().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - fitGeneralizedParetoTail().return.exceedances: number; default: not declared — Number of exceedances `Nu` over the threshold. - fitGeneralizedParetoTail().return.method: 'pwm' | 'mle'; default: not declared — The estimator that actually produced the fit (`'mle'` may fall back to `'pwm'`). - fitGeneralizedParetoTail().return.observationCount: number; default: not declared — Total number of losses. - fitGeneralizedParetoTail().return.scale: number; default: not declared — Scale `β > 0`. - fitGeneralizedParetoTail().return.shape: number; default: not declared — Tail index `ξ` — `> 0` heavy, `0` exponential, `< 0` finite endpoint. - fitGeneralizedParetoTail().return.tailFraction: number; default: not declared — `Nu / observationCount` — the realized tail fraction. - fitGeneralizedParetoTail().return.threshold: number; default: not declared — Loss threshold `u` above which the GPD is fitted. - fitGeneralizedParetoTail(options)?: import('@insiderfinance/totalfinance/risk').GeneralizedParetoFitOptions; default: not declared - fitGeneralizedParetoTail(options).method?: 'pwm' | 'mle'; default: not declared — Estimator; default `'pwm'` (closed-form, robust). - fitGeneralizedParetoTail(options).minExceedances?: number; default: not declared — Exceedance count below which the fit is warned as unreliable; default 10. - fitGeneralizedParetoTail(options).tailFraction?: number; default: not declared — Worst fraction of losses used as exceedances; default 0.10. Ignored when `threshold` is set. - fitGeneralizedParetoTail(options).threshold?: number; default: not declared — Explicit loss threshold `u` (overrides `tailFraction`). - fitGeneralizedParetoTail(returns): ArrayLike; default: not declared - hrp: (covariance: import('@insiderfinance/totalfinance/math').Matrix, options?: { budget?: number; }) => import('@insiderfinance/totalfinance/risk').OptimizeResult; default: not declared — Hierarchical Risk Parity portfolio (correlation-distance clustering + recursive bisection). - hrp().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - hrp().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - hrp().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - hrp().return.value: { weights: number[]; objective: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - hrp().return.value.objective: number; default: not declared - hrp().return.value.weights: number[]; default: not declared - hrp(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - hrp(options)?: { budget?: number; }; default: not declared - hrp(options).budget?: number; default: not declared - kelly: (input: import('@insiderfinance/totalfinance/risk/optimize').KellyInput) => import('@insiderfinance/totalfinance/risk').OptimizeResult; default: not declared - kelly().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - kelly().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - kelly().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - kelly().return.value: { weights: number[]; objective: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - kelly().return.value.objective: number; default: not declared - kelly().return.value.weights: number[]; default: not declared - kelly(input): import('@insiderfinance/totalfinance/risk/optimize').KellyInput; default: not declared - kelly(input).covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared - kelly(input).mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - kelly(input).options?: import('@insiderfinance/totalfinance/risk').KellyOptions; default: not declared - kellyBet: (input: import('@insiderfinance/totalfinance/risk').KellyBetInput) => import('@insiderfinance/totalfinance/risk').KellySizing; default: not declared — Size a single bet by the Kelly criterion — compute the growth-optimal fraction from the edge, then scale it down sanely (half-Kelly by default, a drawdown budget, a hard cap) with the growth, the drawdown risk, and the fat-tail correction all disclosed. See `docs/specs/kelly-sizing.md`. - kellyBet().return.appliedFraction: number | null; default: not declared — `κ = recommendedFraction / fullKelly` — the applied Kelly multiple (0 when there's no edge); `null` when `fullKelly` is null (undefined against a non-existent optimum). - kellyBet().return.assumptions: { conventionsVersion: string; fraction: number; drawdownModel: 'continuous-gbm'; edgeType: 'binary' | 'outcomes' | 'gaussian' | 'returns'; }; default: not declared - kellyBet().return.assumptions.conventionsVersion: string; default: not declared - kellyBet().return.assumptions.drawdownModel: 'continuous-gbm'; default: not declared - kellyBet().return.assumptions.edgeType: 'returns' | 'gaussian' | 'binary' | 'outcomes'; default: not declared - kellyBet().return.assumptions.fraction: number; default: not declared - kellyBet().return.bindingConstraint: 'fraction' | 'drawdown-limit' | 'max-fraction' | 'no-edge' | 'no-downside'; default: not declared — Which cap set the recommended fraction (`no-downside` = unbounded edge with no cap supplied). - kellyBet().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - kellyBet().return.drawdownRisk: { toFraction: number; probability: number; }; default: not declared — `P(wealth ever falls to toFraction of the starting bankroll)` at the recommended fraction (continuous model). - kellyBet().return.drawdownRisk.probability: number; default: not declared - kellyBet().return.drawdownRisk.toFraction: number; default: not declared - kellyBet().return.fullKelly: number | null; default: not declared — `f*` — the growth-optimal fraction of bankroll. `null` when the edge has **no downside**, so log-growth increases without bound and there is no finite unconstrained optimum (finite-success law — never `Infinity`; a `risk.kelly_unbounded` diagnostic explains it). - kellyBet().return.gaussianKelly?: number; default: not declared — Returns path only: the Gaussian `μ/σ²` estimate, for comparison with the exact empirical `f*`. - kellyBet().return.growthRate: number | null; default: not declared — Expected per-period log-growth at the recommended fraction; `null` when there is none. - kellyBet().return.growthRateFull: number | null; default: not declared — Expected per-period log-growth at full Kelly (the maximum); `null` for a no-downside edge. - kellyBet().return.horizonGrowth?: { horizonPeriods: number; logGrowth: number; growthMultiple: number; }; default: not declared — Present when `horizonPeriods` is given: the median wealth projection over the horizonPeriods. - kellyBet().return.horizonGrowth.growthMultiple: number; default: not declared - kellyBet().return.horizonGrowth.horizonPeriods: number; default: not declared - kellyBet().return.horizonGrowth.logGrowth: number; default: not declared - kellyBet().return.periodsToDouble: number | null; default: not declared — `ln 2 / growthRate` — periods to double at the recommended fraction (`Infinity` when growth ≤ 0, `null` when there is no finite recommendation). - kellyBet().return.rationale: string; default: not declared — Prose an agent relays. - kellyBet().return.recommendedFraction: number | null; default: not declared — The recommended fraction after the fractional/drawdown/max caps (≥ 0). `null` only for a no-downside edge with **no** explicit cap — a finite recommendation then requires a `maxFraction`. - kellyBet(input): import('@insiderfinance/totalfinance/risk').KellyBetInput; default: not declared - kellyBet(input).drawdownLimit?: { toFraction: number; maxProbability: number; }; default: not declared — Cap the applied Kelly multiple so `P(ever falling to toFraction of starting bankroll) ≤ maxProbability`. - kellyBet(input).drawdownLimit.maxProbability: number; default: not declared - kellyBet(input).drawdownLimit.toFraction: number; default: not declared - kellyBet(input).edge: { binary: import('@insiderfinance/totalfinance/risk').BinaryEdge; } | { outcomes: import('@insiderfinance/totalfinance/risk').EdgeOutcome[]; } | { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; default: not declared - kellyBet(input).edge.binary: import('@insiderfinance/totalfinance/risk').BinaryEdge; default: not declared - kellyBet(input).edge.gaussian: { mean: number; variance: number; }; default: not declared - kellyBet(input).edge.gaussian.mean: number; default: not declared - kellyBet(input).edge.gaussian.variance: number; default: not declared - kellyBet(input).edge.outcomes: import('@insiderfinance/totalfinance/risk').EdgeOutcome[]; default: not declared - kellyBet(input).edge.returns: ArrayLike; default: not declared - kellyBet(input).fraction?: number; default: not declared — Fraction of full Kelly to apply (0.5 = half-Kelly). Default 0.5. Must be > 0. - kellyBet(input).horizonPeriods?: number; default: not declared — Optional horizonPeriods (periods) for the growth projection. Must be > 0 when given. - kellyBet(input).maxFraction?: number; default: not declared — Hard cap on the recommended fraction of bankroll (e.g. 1 = no leverage). Must be > 0. - linkAttribution: (periods: import('@insiderfinance/totalfinance/risk').AttributionPeriod[], options?: import('@insiderfinance/totalfinance/risk').LinkAttributionOptions) => import('@insiderfinance/totalfinance/risk').LinkedAttribution; default: not declared — Link single-period Brinson attributions across time with **Cariño's** logarithmic coefficients, so the cumulative allocation / selection / interaction sum **exactly** to the compounded (geometric) active return — the property the naive arithmetic sum lacks. Each period's effects are scaled by `βₜ = kₜ/k`; per-segment effects are linked with the same `βₜ`. See `docs/specs/attribution-linking.md`. - linkAttribution().return.activeReturn: number; default: not declared — `portfolioReturn − benchmarkReturn` (the geometric active return). - linkAttribution().return.allocation: number; default: not declared — Linked cumulative effects — `allocation + selection + interaction = activeReturn`, exact. - linkAttribution().return.assumptions: { conventionsVersion: string; method: 'carino'; periods: number; }; default: not declared - linkAttribution().return.assumptions.conventionsVersion: string; default: not declared - linkAttribution().return.assumptions.method: 'carino'; default: not declared - linkAttribution().return.assumptions.periods: number; default: not declared - linkAttribution().return.benchmarkReturn: number; default: not declared — Compounded benchmark return `∏(1+Bₜ) − 1`. - linkAttribution().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - linkAttribution().return.interaction: number; default: not declared - linkAttribution().return.linkingCoefficients: import('@insiderfinance/totalfinance/risk').LinkingCoefficient[]; default: not declared — The per-period linking coefficient `βₜ` (with the period `label` when supplied). - linkAttribution().return.method: 'carino'; default: not declared - linkAttribution().return.portfolioReturn: number; default: not declared — Compounded portfolio return `∏(1+Pₜ) − 1`. - linkAttribution().return.segments?: import('@insiderfinance/totalfinance/risk').SegmentEffect[]; default: not declared — Linked per-segment effects — present only when every period supplied segments. - linkAttribution().return.selection: number; default: not declared - linkAttribution(options)?: import('@insiderfinance/totalfinance/risk').LinkAttributionOptions; default: not declared - linkAttribution(options).method?: 'carino'; default: not declared — Linking method; default (and currently only) `'carino'`. - linkAttribution(periods): import('@insiderfinance/totalfinance/risk').AttributionPeriod[]; default: not declared - liquidity: (positions: readonly import('@insiderfinance/totalfinance/risk').LiquidityPosition[], options?: { participation?: number; }) => import('@insiderfinance/totalfinance/risk').LiquidityResult; default: not declared — Liquidity approximation: days to liquidate each position when trading at most `participation` of its average daily volume (default 20%), plus the slowest name's horizonPeriods for the whole book. - liquidity().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - liquidity().return.assumptions.conventionsVersion: string; default: not declared - liquidity().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - liquidity().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - liquidity().return.perAsset: { daysToLiquidate: number; averageDailyVolumeMultiple: number; }[]; default: not declared - liquidity().return.portfolioDaysToLiquidate: number; default: not declared — Days to fully unwind the book trading each name at `participation` of its ADV (the slowest name). - liquidity(options)?: { participation?: number; }; default: not declared - liquidity(options).participation?: number; default: not declared - liquidity(positions): readonly import('@insiderfinance/totalfinance/risk').LiquidityPosition[]; default: not declared - margin: (positionNotionals: ArrayLike, options: { equity: number; initialRate?: number; maintenanceRate?: number; }) => import('@insiderfinance/totalfinance/risk').MarginResult; default: not declared — Margin approximation from signed position notionals and account equity: gross/net/long/short exposure, Reg-T-style initial (default 50%) and maintenance (default 25%) requirements, gross leverage, and a maintenance-met flag. - margin().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - margin().return.assumptions.conventionsVersion: string; default: not declared - margin().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - margin().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - margin().return.grossExposure: number; default: not declared - margin().return.initialMargin: number; default: not declared — Initial (Reg-T-style) margin requirement: `initialRate · gross`. - margin().return.leverage: number; default: not declared — Gross leverage `gross / equity`. - margin().return.longExposure: number; default: not declared - margin().return.maintenanceMargin: number; default: not declared — Maintenance margin requirement: `maintenanceRate · gross`. - margin().return.meetsMaintenance: boolean; default: not declared — Whether `equity ≥ maintenanceMargin`. - margin().return.netExposure: number; default: not declared - margin().return.shortExposure: number; default: not declared — Short exposure as a positive magnitude. - margin(options): { equity: number; initialRate?: number; maintenanceRate?: number; }; default: not declared - margin(options).equity: number; default: not declared - margin(options).initialRate?: number; default: not declared - margin(options).maintenanceRate?: number; default: not declared - margin(positionNotionals): ArrayLike; default: not declared - marketImpact: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: import('@insiderfinance/totalfinance/risk').MarketImpactInput, options?: { coefficient?: number; } | undefined], number, { coefficient: number; }>; default: not declared — Plain impact cost; use `marketImpact.explain(...)` for the coefficient and diagnostics. - marketImpact(callArguments): [input: import('@insiderfinance/totalfinance/risk').MarketImpactInput, options?: { coefficient?: number; } | undefined]; default: not declared - marketImpact.explain: (input: import('@insiderfinance/totalfinance/risk').MarketImpactInput, options?: { coefficient?: number; } | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - marketImpact.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ coefficient: number; }>; default: not declared — Every applied convention, echoed back. - marketImpact.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - marketImpact.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - marketImpact.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - marketImpact.explain(callArguments): [input: import('@insiderfinance/totalfinance/risk').MarketImpactInput, options?: { coefficient?: number; } | undefined]; default: not declared - maxSharpe: (input: import('@insiderfinance/totalfinance/risk/optimize').MaxSharpeInput) => import('@insiderfinance/totalfinance/risk').OptimizeResult; default: not declared - maxSharpe().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - maxSharpe().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - maxSharpe().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - maxSharpe().return.value: { weights: number[]; objective: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - maxSharpe().return.value.objective: number; default: not declared - maxSharpe().return.value.weights: number[]; default: not declared - maxSharpe(input): import('@insiderfinance/totalfinance/risk/optimize').MaxSharpeInput; default: not declared - maxSharpe(input).covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared - maxSharpe(input).mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - maxSharpe(input).options?: import('@insiderfinance/totalfinance/risk').MaxSharpeOptions; default: not declared - meanExcessPlot: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').MeanExcessPlotOptions) => import('@insiderfinance/totalfinance/risk').MeanExcessPlot; default: not declared — The **mean-excess plot** — the standard tool for choosing the EVT peaks-over-threshold cutoff the rest of the pack takes as an input. The mean-excess `e(u) = E[X − u | X > u]` is linear in `u` (slope `ξ/(1−ξ)`) above the true tail threshold and non-linear below it, so the threshold is read off as where the curve straightens. Returns the curve, a heuristic `suggestedThreshold`, the `tailIndexEstimate` from that region's slope, and the `suggestedTailFraction` to hand to {@link fitGeneralizedParetoTail}. See `docs/specs/mean-excess-plot.md`. - meanExcessPlot().return.assumptions: { conventionsVersion: string; observations: number; losses: number; }; default: not declared - meanExcessPlot().return.assumptions.conventionsVersion: string; default: not declared - meanExcessPlot().return.assumptions.losses: number; default: not declared - meanExcessPlot().return.assumptions.observations: number; default: not declared - meanExcessPlot().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - meanExcessPlot().return.points: import('@insiderfinance/totalfinance/risk').MeanExcessPoint[]; default: not declared - meanExcessPlot().return.suggestedTailFraction: number; default: not declared — `Nu(suggestedThreshold)/n` — hand to `fitGeneralizedParetoTail({ tailFraction })`. - meanExcessPlot().return.suggestedThreshold: number; default: not declared — Heuristic tail-onset threshold — the lowest `u` above which `e(·)` is ~linear. - meanExcessPlot().return.tailIndexEstimate: number; default: not declared — `ξ` from the slope over `[suggestedThreshold, uₘₐₓ]`: `ξ = slope/(1+slope)`. - meanExcessPlot(options)?: import('@insiderfinance/totalfinance/risk').MeanExcessPlotOptions; default: not declared - meanExcessPlot(options).gridSize?: number; default: not declared — Auto-grid point count. Default 25. - meanExcessPlot(options).linearTolerance?: number; default: not declared — Normalized deviation below which the mean-excess counts as linear. Default 0.1. - meanExcessPlot(options).minExceedances?: number; default: not declared — Minimum exceedances the top threshold retains (and the fit-reliability floor). Default 10. - meanExcessPlot(options).startQuantile?: number; default: not declared — Auto-grid lower bound as a loss quantile in (0, 1). Default 0.5 (the median loss). - meanExcessPlot(options).thresholds?: number[]; default: not declared — Explicit candidate thresholds (loss units); else an auto grid. - meanExcessPlot(returns): ArrayLike; default: not declared - meanReturns: (input: import('@insiderfinance/totalfinance/risk').MeanReturnsInput) => number[]; default: not declared — Per-asset arithmetic mean returns from observations-major history — the `mu` for `maxSharpe({ mean, covariance })` / `meanVariance({ mean, covariance })`. Kept deliberately small: it is the journey-completing helper, not a statistics suite (see `@insiderfinance/totalfinance/math` for that). - meanReturns(input): import('@insiderfinance/totalfinance/risk').MeanReturnsInput; default: not declared - meanReturns(input).periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily data): reported means become `periodMean × periodsPerYear`. OMITTED means per-period means — annualization is never silent (spec Law 6). - meanReturns(input).returns: number[][]; default: not declared — Observations-major returns — same orientation as {@link CovarianceInput}. - meanVariance: (input: import('@insiderfinance/totalfinance/risk/optimize').MeanVarianceInput) => import('@insiderfinance/totalfinance/risk').OptimizeResult; default: not declared - meanVariance().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - meanVariance().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - meanVariance().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - meanVariance().return.value: { weights: number[]; objective: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - meanVariance().return.value.objective: number; default: not declared - meanVariance().return.value.weights: number[]; default: not declared - meanVariance(input): import('@insiderfinance/totalfinance/risk/optimize').MeanVarianceInput; default: not declared - meanVariance(input).covariance: import('@insiderfinance/totalfinance/math').Matrix; default: not declared - meanVariance(input).mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - meanVariance(input).options?: import('@insiderfinance/totalfinance/risk').MeanVarianceOptions; default: not declared - minVariance: (covariance: import('@insiderfinance/totalfinance/math').Matrix, constraints?: import('@insiderfinance/totalfinance/risk').OptimizeConstraints) => import('@insiderfinance/totalfinance/risk').OptimizeResult; default: not declared — Global minimum-variance portfolio. `value.objective` is the portfolio variance `wᵀΣw`. - minVariance().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - minVariance().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - minVariance().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - minVariance().return.value: { weights: number[]; objective: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - minVariance().return.value.objective: number; default: not declared - minVariance().return.value.weights: number[]; default: not declared - minVariance(constraints)?: import('@insiderfinance/totalfinance/risk').OptimizeConstraints; default: not declared - minVariance(constraints).bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - minVariance(constraints).budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - minVariance(constraints).groups?: import('@insiderfinance/totalfinance/risk').GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - minVariance(constraints).longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - minVariance(constraints).maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - minVariance(constraints).tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - minVariance(constraints).transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - minVariance(constraints).transactionCosts.perUnitTurnover: number | number[]; default: not declared - minVariance(constraints).transactionCosts.previousWeights: number[]; default: not declared - minVariance(constraints).turnover?: import('@insiderfinance/totalfinance/risk').TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - minVariance(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - nakedCallMargin: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined], number, { multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Plain per-contract requirement; use `.explain()` for the applied Reg-T knobs. - nakedCallMargin(callArguments): [input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined]; default: not declared - nakedCallMargin.explain: (input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - nakedCallMargin.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Every applied convention, echoed back. - nakedCallMargin.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - nakedCallMargin.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - nakedCallMargin.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - nakedCallMargin.explain(callArguments): [input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined]; default: not declared - nakedPutMargin: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined], number, { multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Plain per-contract requirement; use `.explain()` for the applied Reg-T knobs. - nakedPutMargin(callArguments): [input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined]; default: not declared - nakedPutMargin.explain: (input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - nakedPutMargin.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Every applied convention, echoed back. - nakedPutMargin.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - nakedPutMargin.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - nakedPutMargin.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - nakedPutMargin.explain(callArguments): [input: import('@insiderfinance/totalfinance/risk').NakedMarginInput, options?: import('@insiderfinance/totalfinance/risk').NakedMarginOptions | undefined]; default: not declared - optionsMargin: (legs: readonly import('@insiderfinance/totalfinance/risk').OptionMarginLeg[], options: import('@insiderfinance/totalfinance/risk').OptionsMarginOptions) => import('@insiderfinance/totalfinance/risk').OptionsMarginResult; default: not declared — Initial margin / buying-power for a single-underlying, single-expiry multi-leg option position (spec §15.3, product review §6). The expiration payoff is piecewise-linear, so the requirement is: - **long only** (all legs bought): the net debit paid (fully-paid, no additional margin); - **covered defined risk** (every short leg is offset — verticals, condors, butterflies): the max loss; - **uncovered short puts** (more short put contracts than long ones): the Reg-T naked-put requirement on the uncovered contracts + the max loss of the rest. A short put's loss is *bounded* (the underlying stops at 0), but bounded is not the same as covered: charging the whole `(strike − premium)` exercise value margins a margin account as if it were cash-secured, ~4× the Reg-T requirement one function away (`nakedPutMargin`). Opt into the cash-secured basis for a cash/IRA account with `putMarginBasis: 'cash-secured'`; - **undefined risk** (a net-short call leaves the upside unbounded): the Reg-T naked requirement summed over the short legs — a conservative strategy-based approximation (a portfolio-margin engine would net offsets more finely). Coverage is counted contract-for-contract per option type, pairing the highest strikes first, so a 1×1 spread is covered and the extra short in a 2×1 ratio is not. `maxLoss` is unaffected by the margin basis — it stays the position's true worst case at expiration. Pure and clock-free; premiums, strikes, and the underlier are explicit inputs. - optionsMargin().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - optionsMargin().return.assumptions.conventionsVersion: string; default: not declared - optionsMargin().return.buyingPowerReduction: number; default: not declared — Buying-power reduction — what the account must set aside. Equals `initialMargin` for margin accounts; for a long-only (fully-paid) position it is the net debit paid. - optionsMargin().return.definedRisk: boolean; default: not declared — True when the position's loss is capped (spreads / condors / butterflies / long options). - optionsMargin().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - optionsMargin().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - optionsMargin().return.initialMargin: number; default: not declared — Initial margin / buying-power requirement, in account currency. - optionsMargin().return.maxLoss: number | null; default: not declared — Worst-case expiration loss magnitude per contract; `null` when the loss is unbounded (e.g. a naked call — no finite worst case exists; `Infinity` is not JSON-safe, Law 7). `definedRisk: false` is the primary unbounded discriminant, and a `risk.unbounded_loss` warning explains the null. - optionsMargin().return.method: 'reg-t-naked' | 'defined-risk-max-loss' | 'reg-t-naked-put' | 'long-premium'; default: not declared — How the requirement was derived. `'reg-t-naked-put'` is the bounded-but-uncovered case: the loss IS capped (a put's underlying stops at 0), but the position is short naked puts, so the requirement is the Reg-T naked-put charge on the uncovered contracts plus the capped max loss of whatever remains — not the cash-secured exercise value. - optionsMargin().return.netDebit: number; default: not declared — Net debit paid (> 0) or credit received (< 0), per contract. - optionsMargin(legs): readonly import('@insiderfinance/totalfinance/risk').OptionMarginLeg[]; default: not declared - optionsMargin(options): import('@insiderfinance/totalfinance/risk').OptionsMarginOptions; default: not declared - optionsMargin(options).equityRate?: number; default: not declared — Reg-T naked "equity" rate — the % of underlying (default 0.20). - optionsMargin(options).floorRate?: number; default: not declared — Reg-T naked floor rate — the % of underlying (calls) / strike (puts) minimum (default 0.10). - optionsMargin(options).multiplier?: number; default: not declared — Contract multiplier (default 100). - optionsMargin(options).putMarginBasis?: import('@insiderfinance/totalfinance/risk/portfolio').PutMarginBasis; default: not declared — Basis for UNCOVERED short puts. Default `'reg-t-naked'` — a margin account's actual requirement. Use `'cash-secured'` for a cash/IRA account, where the whole exercise value must be posted. Echoed in `assumptions.putMarginBasis`. - optionsMargin(options).spot: number; default: not declared — Current price of the underlying (> 0). - parameterSweepDiagnostics: (trialSharpes: ArrayLike, selected: import('@insiderfinance/totalfinance/risk').SharpeStatistics) => import('@insiderfinance/totalfinance/risk').ParameterSweepResult; default: not declared — Summarize a parameter sweep: given the per-trial Sharpes and the sample statistics of the *selected* (best) configuration's return series, report the dispersion of the trials and the deflated Sharpe — the honest probability the winner is real rather than the luckiest of many. - parameterSweepDiagnostics().return.bestSharpe: number; default: not declared - parameterSweepDiagnostics().return.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carry no Sharpe (a zero-variance series). - parameterSweepDiagnostics().return.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe under the null (the deflation benchmark `SR₀`). - parameterSweepDiagnostics().return.meanSharpe: number; default: not declared - parameterSweepDiagnostics().return.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR of the selected configuration; `null` with `deflatedSharpe`. - parameterSweepDiagnostics().return.trialCount: number; default: not declared - parameterSweepDiagnostics().return.varianceSharpe: number; default: not declared - parameterSweepDiagnostics(selected): import('@insiderfinance/totalfinance/risk').SharpeStatistics; default: not declared - parameterSweepDiagnostics(selected).kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - parameterSweepDiagnostics(selected).observations: number; default: not declared — Number of observations. - parameterSweepDiagnostics(selected).sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - parameterSweepDiagnostics(selected).skewness: number; default: not declared — Skewness `γ₃` of the returns. - parameterSweepDiagnostics(trialSharpes): ArrayLike; default: not declared - pca: (covariance: import('@insiderfinance/totalfinance/math').Matrix, options?: { correlation?: boolean; }) => import('@insiderfinance/totalfinance/risk').PcaResult; default: not declared — Principal-component analysis of a covariance (or, with `correlation`, the standardized) matrix. - pca().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - pca().return.assumptions.conventionsVersion: string; default: not declared - pca().return.components: import('@insiderfinance/totalfinance/risk').PcaComponent[]; default: not declared — Components sorted by descending eigenvalue. - pca().return.cumulativeVariance: number[]; default: not declared - pca().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - pca().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - pca().return.eigenvalues: number[]; default: not declared - pca().return.loadings: number[][]; default: not declared — `loadings[k]` = the k-th component's eigenvector. - pca().return.totalVariance: number; default: not declared — Sum of eigenvalues (= trace of the input matrix). - pca().return.varianceExplained: number[]; default: not declared - pca(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - pca(options)?: { correlation?: boolean; }; default: not declared - pca(options).correlation?: boolean; default: not declared - portfolioVaR: (input: import('@insiderfinance/totalfinance/risk').PortfolioVaRInput) => import('@insiderfinance/totalfinance/risk').PortfolioVaROutput; default: not declared - portfolioVaR().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - portfolioVaR().return.assumptions.conventionsVersion: string; default: not declared - portfolioVaR().return.componentVaR: number[]; default: not declared — Per-asset component VaR; Σ component = total VaR (zero-mean case). - portfolioVaR().return.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - portfolioVaR().return.confidence: number; default: not declared - portfolioVaR().return.cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - portfolioVaR().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — the one warnings channel. Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - portfolioVaR().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - portfolioVaR().return.horizonPeriods: number; default: not declared - portfolioVaR().return.marginalVaR: number[]; default: not declared — Per-asset marginal VaR (∂VaR/∂w_i). - portfolioVaR().return.method: import('@insiderfinance/totalfinance/risk').VaRMethod; default: not declared - portfolioVaR().return.observations: number; default: not declared — The number of portfolio-return observations the empirical tail was read from. - portfolioVaR().return.samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. The number of simulated samples actually drawn (always echoed). - portfolioVaR().return.seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). The PRNG seed actually used (always echoed for reproducibility). - portfolioVaR().return.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. - portfolioVaR(input): import('@insiderfinance/totalfinance/risk').PortfolioVaRInput; default: not declared - portfolioVaR(input).method: 'historical'; default: not declared - portfolioVaR(input).options?: import('@insiderfinance/totalfinance/risk').HistoricalPortfolioVaROptions; default: not declared - portfolioVaR(input).returns: ArrayLike>; default: not declared - portfolioVaR(input).weights: ArrayLike; default: not declared - portfolioVariance: (weights: ArrayLike, covariance: import('@insiderfinance/totalfinance/math').Matrix) => number; default: not declared — Portfolio variance `wᵀΣw` (H07 contract): every weight and covariance cell validated finite, Σ numerically symmetric with a non-negative diagonal, a materially negative quadratic form rejected (`linalg.not_positive_definite`), and only the tiny documented floating-point tolerance (see {@link quadFormNonNegative}) clamped to 0. - portfolioVariance(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - portfolioVariance(weights): ArrayLike; default: not declared - portfolioVolatility: (weights: ArrayLike, covariance: import('@insiderfinance/totalfinance/math').Matrix) => number; default: not declared — Portfolio volatility `√(wᵀΣw)` — H08: delegates to H07's variance kernel, validating under its own name. - portfolioVolatility(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - portfolioVolatility(weights): ArrayLike; default: not declared - probabilisticSharpeRatio: import('@insiderfinance/totalfinance/core').SeriesFacade<[stats: import('@insiderfinance/totalfinance/risk').SharpeStatistics, benchmarkSharpe?: number | undefined], number | null, { benchmarkSharpe: number; observations: number; }>; default: not declared — Plain probability; use `.explain()` for the benchmark and observation count. - probabilisticSharpeRatio(callArguments): [stats: import('@insiderfinance/totalfinance/risk').SharpeStatistics, benchmarkSharpe?: number | undefined]; default: not declared - probabilisticSharpeRatio.explain: (stats: import('@insiderfinance/totalfinance/risk').SharpeStatistics, benchmarkSharpe?: number | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - probabilisticSharpeRatio.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ benchmarkSharpe: number; observations: number; }>; default: not declared — Every applied convention, echoed back. - probabilisticSharpeRatio.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - probabilisticSharpeRatio.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - probabilisticSharpeRatio.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - probabilisticSharpeRatio.explain(callArguments): [stats: import('@insiderfinance/totalfinance/risk').SharpeStatistics, benchmarkSharpe?: number | undefined]; default: not declared - probabilityOfBacktestOverfitting: (returns: number[][], options?: import('@insiderfinance/totalfinance/risk').BacktestOverfittingProbabilityOptions) => import('@insiderfinance/totalfinance/risk').BacktestOverfittingProbabilityResult; default: not declared — **Probability of backtest overfitting** (Bailey & López de Prado's CSCV). Given a `T × N` matrix of per-period returns — `T` time observations (rows) × `N` strategy configurations you selected among (columns) — split the rows into `S` blocks, and over **every** `C(S, S/2)` symmetric partition into an in-sample and an out-of-sample half: pick the IS-best configuration, then measure its OOS rank. PBO is the fraction of splits where the IS winner lands **below the OOS median** — the probability that picking the best backtest buys you a below-average live result. `≈ 0.5` means the selection is worthless out of sample; `≈ 0` means a genuinely persistent edge. Depends only on `@insiderfinance/totalfinance/core`/`math`. - probabilityOfBacktestOverfitting().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - probabilityOfBacktestOverfitting().return.assumptions.conventionsVersion: string; default: not declared - probabilityOfBacktestOverfitting().return.backtestOverfittingProbability: number; default: not declared — Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. - probabilityOfBacktestOverfitting().return.combinations: number; default: not declared — Number of symmetric train/test splits evaluated: `C(S, S/2)`. - probabilityOfBacktestOverfitting().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - probabilityOfBacktestOverfitting().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - probabilityOfBacktestOverfitting().return.medianLogit: number; default: not declared — Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. - probabilityOfBacktestOverfitting().return.observations: number; default: not declared — Observations (rows) used after trimming to a multiple of `S`. - probabilityOfBacktestOverfitting().return.splits: number; default: not declared — Blocks `S` actually used. - probabilityOfBacktestOverfitting().return.trials: number; default: not declared — Number of strategy configurations (columns) `N`. - probabilityOfBacktestOverfitting(options)?: import('@insiderfinance/totalfinance/risk').BacktestOverfittingProbabilityOptions; default: not declared - probabilityOfBacktestOverfitting(options).splits?: number; default: not declared — Number of disjoint contiguous row-blocks `S` (even, `4 ≤ S ≤ 16`). Default `16` (Bailey & López de Prado). The `C(S, S/2)` train/test splits grow fast in `S`; the observation count is trimmed to a multiple of `S` (the oldest rows dropped). - probabilityOfBacktestOverfitting(returns): number[][]; default: not declared - purgedKFold: (observationCount: number, options: import('@insiderfinance/totalfinance/risk').PurgedKFoldOptions) => import('@insiderfinance/totalfinance/risk').Split[]; default: not declared — Purged & embargoed K-fold cross-validation (López de Prado, *Advances in Financial ML* ch. 7). Each fold's test set is a contiguous block; training drops any observation within `purgeGap` of the test block (label-overlap purge) and within the trailing `embargo·n` window after it. Throws a typed `input.out_of_range` naming the largest viable `purgeGap` when the requested purge (with the embargo) would leave a fold with an empty training set — an unusable split is an error, not an empty array to be discovered downstream. - purgedKFold(observationCount): number; default: not declared - purgedKFold(options): import('@insiderfinance/totalfinance/risk').PurgedKFoldOptions; default: not declared - purgedKFold(options).embargo?: number; default: not declared — Fraction of `n` to embargo after each test fold (default 0). - purgedKFold(options).folds: number; default: not declared — Number of folds (≥ 2). - purgedKFold(options).purgeGap?: number; default: not declared — Observations to purge on each side of a test fold (label-overlap buffer; default 0). - researchProtocol: (input: import('@insiderfinance/totalfinance/risk').ResearchProtocolInput) => import('@insiderfinance/totalfinance/risk').ResearchVerdict; default: not declared — Render a statistically honest verdict on a research process — deflate for selection, confirm out-of-sample, and conclude `significant` / `inconclusive` / `likely-overfit`. See the spec. - researchProtocol().return.assumptions: { conventionsVersion: string; confidence: number; periodsPerYear: number; }; default: not declared - researchProtocol().return.assumptions.confidence: number; default: not declared - researchProtocol().return.assumptions.conventionsVersion: string; default: not declared - researchProtocol().return.assumptions.periodsPerYear: number; default: not declared - researchProtocol().return.deflatedSharpe: number | null; default: not declared — Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. - researchProtocol().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - researchProtocol().return.expectedMaxSharpe: number; default: not declared — SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). - researchProtocol().return.inSample: { sharpe: number | null; annualizedSharpe: number | null; observations: number; }; default: not declared — Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. - researchProtocol().return.inSample.annualizedSharpe: number | null; default: not declared - researchProtocol().return.inSample.observations: number; default: not declared - researchProtocol().return.inSample.sharpe: number | null; default: not declared - researchProtocol().return.minTrackRecordLength: number; default: not declared — Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). - researchProtocol().return.outOfSample?: { sharpe: number | null; annualizedSharpe: number | null; degradation: number | null; }; default: not declared — Present when out-of-sample returns are given; `null` figures when either series has zero variance. - researchProtocol().return.outOfSample.annualizedSharpe: number | null; default: not declared - researchProtocol().return.outOfSample.degradation: number | null; default: not declared - researchProtocol().return.outOfSample.sharpe: number | null; default: not declared - researchProtocol().return.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. - researchProtocol().return.rationale: string; default: not declared — Prose an agent relays. - researchProtocol().return.trialCount: number; default: not declared - researchProtocol().return.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - researchProtocol(input): import('@insiderfinance/totalfinance/risk').ResearchProtocolInput; default: not declared - researchProtocol(input).confidence?: number; default: not declared — Confidence for "significant" in (0, 1); default 0.95. - researchProtocol(input).outOfSampleReturns?: ArrayLike; default: not declared — Out-of-sample (e.g. walk-forward) returns of the SAME strategy — confirmatory. - researchProtocol(input).periodsPerYear?: number; default: not declared — Periods per year for the annualized read-outs; default 252. - researchProtocol(input).returns: ArrayLike; default: not declared — The selected strategy's in-sample return series (per period). - researchProtocol(input).riskFreeRate?: number; default: not declared - researchProtocol(input).trials?: { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }; default: not declared — The pool that produced the selection, for deflation. Omit for a single pre-registered hypothesis (no selection → SR₀ = 0). `trialSharpes` are the per-observation Sharpes of every config tried. - researchProtocol(input).trials.trialCount: number; default: not declared - researchProtocol(input).trials.trialSharpes: ArrayLike; default: not declared - researchProtocol(input).trials.varianceSharpe: number; default: not declared - riskContributions: (weights: ArrayLike, covariance: import('@insiderfinance/totalfinance/math').Matrix) => import('@insiderfinance/totalfinance/risk').RiskContributionsResult; default: not declared — Per-asset volatility risk contributions (H10 report). A zero-volatility portfolio has no defined marginal/component/fraction — those rows carry `null` with a degenerate-input warning naming the fields, never fabricated zeros. - riskContributions().return.assumptions: { conventionsVersion: string; assets: number; }; default: not declared - riskContributions().return.assumptions.assets: number; default: not declared - riskContributions().return.assumptions.conventionsVersion: string; default: not declared - riskContributions().return.contributions: import('@insiderfinance/totalfinance/risk').RiskContributionRow[]; default: not declared - riskContributions().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - riskContributions().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - riskContributions().return.portfolioVolatility: number; default: not declared - riskContributions(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - riskContributions(weights): ArrayLike; default: not declared - riskParity: (covariance: import('@insiderfinance/totalfinance/math').Matrix, options?: { budget?: number; maximumIterations?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/risk').OptimizeResult; default: not declared — Equal-risk-contribution (risk parity) portfolio. - riskParity().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - riskParity().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - riskParity().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - riskParity().return.value: { weights: number[]; objective: number; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - riskParity().return.value.objective: number; default: not declared - riskParity().return.value.weights: number[]; default: not declared - riskParity(covariance): import('@insiderfinance/totalfinance/math').Matrix; default: not declared - riskParity(options)?: { budget?: number; maximumIterations?: number; tolerance?: number; }; default: not declared - riskParity(options).budget?: number; default: not declared - riskParity(options).maximumIterations?: number; default: not declared - riskParity(options).tolerance?: number; default: not declared - scenario: (name: string, ...shocks: import('@insiderfinance/totalfinance/risk').Shock[]) => import('@insiderfinance/totalfinance/risk').Scenario; default: not declared — Build a named scenario from shocks. Each shock is validated at build time (use the `shock.*` constructors — they produce exactly this shape), so a malformed shock fails here with a typed error instead of deep inside the Taylor engine. - scenario().return.name: string; default: not declared - scenario().return.shocks: import('@insiderfinance/totalfinance/risk').Shock[]; default: not declared - scenario(name): string; default: not declared - scenario(shocks): import('@insiderfinance/totalfinance/risk').Shock[]; default: not declared - scenarioGrid: (input: import('@insiderfinance/totalfinance/risk/scenario').ScenarioGridInput) => import('@insiderfinance/totalfinance/risk').ScenarioGridResult; default: not declared — 2-D scenario grid (H12 report): P&L (per unit) of one position's Greeks across a Cartesian product of spot and vol shocks. A serialized result is self-interpreting — both axes carry their resolved shock semantics beside the cells, so a detached matrix never travels alone. - scenarioGrid().return.assumptions: { conventionsVersion: string; greekUnits: { readonly phi: 'per1Percent'; readonly rho: import('@insiderfinance/totalfinance/core').RhoUnit; readonly theta: import('@insiderfinance/totalfinance/core').ThetaUnit; readonly vega: import('@insiderfinance/totalfinance/core').VegaUnit; }; }; default: not declared - scenarioGrid().return.assumptions.conventionsVersion: string; default: not declared - scenarioGrid().return.assumptions.greekUnits: { readonly phi: 'per1Percent'; readonly rho: import('@insiderfinance/totalfinance/core').RhoUnit; readonly theta: import('@insiderfinance/totalfinance/core').ThetaUnit; readonly vega: import('@insiderfinance/totalfinance/core').VegaUnit; }; default: not declared - scenarioGrid().return.assumptions.greekUnits.phi: 'per1Percent'; default: not declared - scenarioGrid().return.assumptions.greekUnits.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - scenarioGrid().return.assumptions.greekUnits.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - scenarioGrid().return.assumptions.greekUnits.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - scenarioGrid().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - scenarioGrid().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - scenarioGrid().return.pnl: number[][]; default: not declared — `pnl[i][j]` = P&L per unit at `spotAxis[i]` × `volatilityAxis[j]`. - scenarioGrid().return.spotAxis: import('@insiderfinance/totalfinance/risk').ResolvedGridShock[]; default: not declared - scenarioGrid().return.volatilityAxis: import('@insiderfinance/totalfinance/risk').ResolvedGridShock[]; default: not declared - scenarioGrid(input): import('@insiderfinance/totalfinance/risk/scenario').ScenarioGridInput; default: not declared - scenarioGrid(input).greeks: import('@insiderfinance/totalfinance/risk').PositionGreeks; default: not declared - scenarioGrid(input).spotShocks: readonly import('@insiderfinance/totalfinance/risk').Shock[]; default: not declared - scenarioGrid(input).volatilityShocks: readonly import('@insiderfinance/totalfinance/risk').Shock[]; default: not declared - sharpeStatistics: (returns: ArrayLike, options?: { riskFreeRate?: number; }) => import('@insiderfinance/totalfinance/risk').SharpeStatisticsReport; default: not declared — Sample Sharpe statistics of a return series: the per-observation (non-annualized) Sharpe plus the skewness and (non-excess) kurtosis that the probabilistic-Sharpe adjustment needs. - sharpeStatistics().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - sharpeStatistics().return.assumptions.conventionsVersion: string; default: not declared - sharpeStatistics().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - sharpeStatistics().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - sharpeStatistics().return.kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - sharpeStatistics().return.observations: number; default: not declared — Number of observations. - sharpeStatistics().return.sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - sharpeStatistics().return.skewness: number; default: not declared — Skewness `γ₃` of the returns. - sharpeStatistics(options)?: { riskFreeRate?: number; }; default: not declared - sharpeStatistics(options).riskFreeRate?: number; default: not declared - sharpeStatistics(returns): ArrayLike; default: not declared - shock: { spot(change: string | number): import('@insiderfinance/totalfinance/risk').Shock; volatility(change: string | number): import('@insiderfinance/totalfinance/risk').Shock; riskFreeRate(change: string | number): import('@insiderfinance/totalfinance/risk').Shock; time(years: number): import('@insiderfinance/totalfinance/risk').Shock; dividend(change: string | number): import('@insiderfinance/totalfinance/risk').Shock; factor(name: string, change: string | number): import('@insiderfinance/totalfinance/risk').Shock; }; default: not declared — Typed shock constructors. Strings carry units; raw numbers are absolute. - shock.dividend: (change: string | number) => import('@insiderfinance/totalfinance/risk').Shock; default: not declared — Dividend-yield move: `'+50bp'` ⇒ +0.005, or a raw `0.005`. Drives the first-order carry term `ε·dq`. Percent (`'%'`) dividend moves are rejected by the Taylor engine — it has no reference dividend level to scale against. - shock.dividend().return.factor: string; default: not declared - shock.dividend().return.kind: import('@insiderfinance/totalfinance/risk').ShockKind; default: not declared - shock.dividend().return.value: number; default: not declared - shock.dividend(change): string | number; default: not declared - shock.factor: (name: string, change: string | number) => import('@insiderfinance/totalfinance/risk').Shock; default: not declared — A custom named factor shock. Percent (`'%'`) moves resolve only for `'spot'` in the Taylor engine; a custom `reprice` fn receives the raw scenario and may interpret `%` itself. - shock.factor().return.factor: string; default: not declared - shock.factor().return.kind: import('@insiderfinance/totalfinance/risk').ShockKind; default: not declared - shock.factor().return.value: number; default: not declared - shock.factor(change): string | number; default: not declared - shock.factor(name): string; default: not declared - shock.riskFreeRate: (change: string | number) => import('@insiderfinance/totalfinance/risk').Shock; default: not declared — Rate move: `'+50bp'` ⇒ +0.005, or a raw `0.005`. Percent (`'%'`) rate moves are rejected by the Taylor engine — it has no reference rate to scale against. - shock.riskFreeRate().return.factor: string; default: not declared - shock.riskFreeRate().return.kind: import('@insiderfinance/totalfinance/risk').ShockKind; default: not declared - shock.riskFreeRate().return.value: number; default: not declared - shock.riskFreeRate(change): string | number; default: not declared - shock.spot: (change: string | number) => import('@insiderfinance/totalfinance/risk').Shock; default: not declared — Spot move: `'-5%'` (relative) or `-5` (absolute price). - shock.spot().return.factor: string; default: not declared - shock.spot().return.kind: import('@insiderfinance/totalfinance/risk').ShockKind; default: not declared - shock.spot().return.value: number; default: not declared - shock.spot(change): string | number; default: not declared - shock.time: (years: number) => import('@insiderfinance/totalfinance/risk').Shock; default: not declared — Time decay over `years` (e.g. `1/365` for one day). - shock.time().return.factor: string; default: not declared - shock.time().return.kind: import('@insiderfinance/totalfinance/risk').ShockKind; default: not declared - shock.time().return.value: number; default: not declared - shock.time(years): number; default: not declared - shock.volatility: (change: string | number) => import('@insiderfinance/totalfinance/risk').Shock; default: not declared — Volatility move in absolute vol points (`'+10pts'` ⇒ +0.10) or a raw decimal (`0.10`). Percent (`'%'`) vol moves are rejected by the Taylor engine — it has no reference vol to scale against. - shock.volatility().return.factor: string; default: not declared - shock.volatility().return.kind: import('@insiderfinance/totalfinance/risk').ShockKind; default: not declared - shock.volatility().return.value: number; default: not declared - shock.volatility(change): string | number; default: not declared - shrunkKelly: (input: import('@insiderfinance/totalfinance/risk').ShrunkKellyInput) => import('@insiderfinance/totalfinance/risk').ShrunkKelly; default: not declared — Estimation-error-shrunk portfolio Kelly. The plug-in weights `Σ̂⁻¹μ̂` overbet because `μ̂`/`Σ̂` are estimated from a finite sample; this scales them by the growth-optimal factor `c* = max(0, 1 − (n/T)/θ̂²)` (`θ̂² = μ̂ᵀΣ̂⁻¹μ̂`), returns a zero book when the estimated edge is indistinguishable from sampling noise (`n/T ≥ θ̂²`), and discloses the biased-vs-corrected Sharpe and the naive book's (often negative) expected out-of-sample growth. See `docs/specs/shrunk-kelly.md`. - shrunkKelly().return.appliedScaling: number; default: not declared — The applied scaling `fraction · c*`. - shrunkKelly().return.assumptions: { conventionsVersion: string; assets: number; sampleSize: number; fraction: number; }; default: not declared - shrunkKelly().return.assumptions.assets: number; default: not declared - shrunkKelly().return.assumptions.conventionsVersion: string; default: not declared - shrunkKelly().return.assumptions.fraction: number; default: not declared - shrunkKelly().return.assumptions.sampleSize: number; default: not declared - shrunkKelly().return.correctedSharpeSquared: number; default: not declared — Bias-corrected out-of-sample squared Sharpe `θ̂² − n/T` (may be ≤ 0). - shrunkKelly().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - shrunkKelly().return.expectedGrowth: number; default: not declared — Expected out-of-sample log-growth at the applied scaling. - shrunkKelly().return.inSampleSharpeSquared: number; default: not declared — In-sample squared Sharpe `θ̂² = μ̂ᵀΣ̂⁻¹μ̂` (biased high). - shrunkKelly().return.naiveExpectedGrowth: number; default: not declared — Expected out-of-sample log-growth of the naive (unshrunk) book — often negative. - shrunkKelly().return.naiveWeights: number[]; default: not declared — Naive plug-in Kelly weights `Σ̂⁻¹μ̂` (before any shrinkage). - shrunkKelly().return.shrinkage: number; default: not declared — Estimation-error shrinkage factor `c* ∈ [0, 1]`. - shrunkKelly().return.weights: number[]; default: not declared — Shrunk Kelly weights `fraction · c* · Σ̂⁻¹μ̂`. - shrunkKelly(input): import('@insiderfinance/totalfinance/risk').ShrunkKellyInput; default: not declared - shrunkKelly(input).covariance: number[][]; default: not declared — Estimated covariance Σ̂ (n×n, symmetric positive-definite). - shrunkKelly(input).fraction?: number; default: not declared — Extra fractional-Kelly multiplier applied on top of the estimation shrinkage (e.g. 0.5). Default 1. - shrunkKelly(input).mean: number[]; default: not declared — Estimated per-period expected (excess) returns μ̂, one per asset. - shrunkKelly(input).sampleSize: number; default: not declared — Number of observations T the estimates came from. Must be > 0. - spectralRisk: (returns: ArrayLike, options?: { riskAversion?: number; } | { alpha: number; }) => import('@insiderfinance/totalfinance/risk').SpectralRisk; default: not declared — A coherent spectral risk measure (Acerbi): a weighted average of the loss quantiles with a non-decreasing weight on worse outcomes. Pass `{ riskAversion }` for the exponential spectrum `φ(p) = k·e^(−k(1−p))/(1−e^(−k))` (default `k = 10`), or `{ alpha }` for the Expected-Shortfall spectrum `φ(p) = 𝟙[p ≥ α]/(1−α)` — ES being the flat-tail special case. See the spec. - spectralRisk().return.alpha?: number; default: not declared — Level `α` for the Expected-Shortfall spectrum. - spectralRisk().return.assumptions: { conventionsVersion: string; }; default: not declared - spectralRisk().return.assumptions.conventionsVersion: string; default: not declared - spectralRisk().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - spectralRisk().return.riskAversion?: number; default: not declared — Risk-aversion `k` for the exponential spectrum. - spectralRisk().return.spectrum: 'exponential' | 'expected-shortfall'; default: not declared - spectralRisk().return.value: number; default: not declared — The spectral risk measure — a positive loss magnitude. - spectralRisk(options)?: { riskAversion?: number; } | { alpha: number; }; default: not declared - spectralRisk(options).alpha: number; default: not declared - spectralRisk(options).riskAversion?: number; default: not declared - spectralRisk(returns): ArrayLike; default: not declared - stressTest: (input: import('@insiderfinance/totalfinance/risk/scenario').StressTestInput) => import('@insiderfinance/totalfinance/risk').StressTestResult; default: not declared — Stress a positions book across scenarios (H11 report): per-scenario and per-position P&L. - stressTest().return.assumptions: { conventionsVersion: string; scenarios: number; positions: number; valuation: string; }; default: not declared - stressTest().return.assumptions.conventionsVersion: string; default: not declared - stressTest().return.assumptions.positions: number; default: not declared - stressTest().return.assumptions.scenarios: number; default: not declared - stressTest().return.assumptions.valuation: string; default: not declared — Book-level valuation summary: 'greeks-taylor' | 'reprice' | 'mixed'. - stressTest().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - stressTest().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - stressTest().return.scenarios: import('@insiderfinance/totalfinance/risk').ScenarioResult[]; default: not declared - stressTest(input): import('@insiderfinance/totalfinance/risk/scenario').StressTestInput; default: not declared - stressTest(input).options?: import('@insiderfinance/totalfinance/risk').StressOptions; default: not declared - stressTest(input).positions: readonly import('@insiderfinance/totalfinance/risk').Position[]; default: not declared - stressTest(input).scenarios: readonly import('@insiderfinance/totalfinance/risk').Scenario[]; default: not declared - survivorshipWarning: (context: import('@insiderfinance/totalfinance/risk').SurvivorshipContext) => import('@insiderfinance/totalfinance/core').QuantWarning | null; default: not declared — Return a survivorship-bias warning when the backtest universe excludes delisted names or is not point-in-time — both bias results upward — or `null` when neither concern applies. - survivorshipWarning().return.code: string; default: not declared - survivorshipWarning().return.context?: Record; default: not declared - survivorshipWarning().return.message: string; default: not declared - survivorshipWarning().return.severity: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared - survivorshipWarning(context): import('@insiderfinance/totalfinance/risk').SurvivorshipContext; default: not declared - survivorshipWarning(context).includesDelisted?: boolean; default: not declared — Whether delisted / inactive instruments are included in the backtest universe. - survivorshipWarning(context).pointInTimeUniverse?: boolean; default: not declared — Whether the universe is point-in-time (members as they were on each date). - taylorPnl: (greeks: import('@insiderfinance/totalfinance/risk').PositionGreeks, scenario: import('@insiderfinance/totalfinance/risk').Scenario) => import('@insiderfinance/totalfinance/risk').TaylorPnlResult; default: not declared — Greeks-Taylor P&L of a single position's Greeks under a scenario (per unit). - taylorPnl().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - taylorPnl().return.assumptions.conventionsVersion: string; default: not declared - taylorPnl().return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - taylorPnl().return.delta: number; default: not declared - taylorPnl().return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - taylorPnl().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - taylorPnl().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - taylorPnl().return.gamma: number; default: not declared - taylorPnl().return.other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - taylorPnl().return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - taylorPnl().return.rho: number; default: not declared - taylorPnl().return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - taylorPnl().return.theta: number; default: not declared - taylorPnl().return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - taylorPnl().return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - taylorPnl().return.total: number; default: not declared - taylorPnl().return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - taylorPnl().return.vega: number; default: not declared - taylorPnl().return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - taylorPnl().return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - taylorPnl().return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). - taylorPnl(greeks): import('@insiderfinance/totalfinance/risk').PositionGreeks; default: not declared - taylorPnl(greeks).charm?: number; default: not declared — ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. - taylorPnl(greeks).color?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - taylorPnl(greeks).delta?: number; default: not declared — ∂V/∂S per $1 of spot. - taylorPnl(greeks).deltaRate?: number; default: not declared — ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. - taylorPnl(greeks).gamma?: number; default: not declared — ∂²V/∂S² per $1². - taylorPnl(greeks).lambda?: number | null; default: not declared — Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. - taylorPnl(greeks).phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. - taylorPnl(greeks).rho?: number; default: not declared — ∂V/∂r per 1% rate (0.01), as the options package reports it. - taylorPnl(greeks).rhoConvexity?: number; default: not declared — ∂²V/∂r² per (1%)² — rho convexity. Optional. - taylorPnl(greeks).speed?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - taylorPnl(greeks).spot?: number; default: not declared — Reference spot, required to resolve percent spot shocks into price moves. - taylorPnl(greeks).theta?: number; default: not declared — ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. - taylorPnl(greeks).thetaConvexity?: number; default: not declared — ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. - taylorPnl(greeks).thetaRate?: number; default: not declared — ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. - taylorPnl(greeks).ultima?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - taylorPnl(greeks).value: number; default: not declared — Current mark value of the position (per unit). - taylorPnl(greeks).vanna?: number; default: not declared — ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. - taylorPnl(greeks).vega?: number; default: not declared — ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. - taylorPnl(greeks).vera?: number; default: not declared — ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. - taylorPnl(greeks).veta?: number; default: not declared — ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. - taylorPnl(greeks).vomma?: number; default: not declared — ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. - taylorPnl(greeks).zomma?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - taylorPnl(scenario): import('@insiderfinance/totalfinance/risk').Scenario; default: not declared - taylorPnl(scenario).name: string; default: not declared - taylorPnl(scenario).shocks: import('@insiderfinance/totalfinance/risk').Shock[]; default: not declared - valueAtRisk: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined], number, import('@insiderfinance/totalfinance/risk/value-at-risk').ValueAtRiskAssumptionExtras>; default: not declared — VaR (positive loss magnitude) for a single return/P&L series. Plain call → the number; `.explain()` → the Computed envelope echoing confidence/method/horizonPeriods (dx §2.4: the applied `confidence: 0.95` default is disclosed, never hidden). - valueAtRisk(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined]; default: not declared - valueAtRisk.explain: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - valueAtRisk.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - valueAtRisk.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - valueAtRisk.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - valueAtRisk.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - valueAtRisk.explain(callArguments): [returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions | undefined]; default: not declared - valueAtRiskReport: (returns: ArrayLike, options?: import('@insiderfinance/totalfinance/risk').VaROptions) => import('@insiderfinance/totalfinance/risk').VaRResult; default: not declared — Full VaR + CVaR report for a single return/P&L series. - valueAtRiskReport().return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - valueAtRiskReport().return.assumptions.conventionsVersion: string; default: not declared - valueAtRiskReport().return.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - valueAtRiskReport().return.confidence: number; default: not declared - valueAtRiskReport().return.cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - valueAtRiskReport().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - valueAtRiskReport().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - valueAtRiskReport().return.horizonPeriods: number; default: not declared - valueAtRiskReport().return.method: import('@insiderfinance/totalfinance/risk').VaRMethod; default: not declared - valueAtRiskReport().return.samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. - valueAtRiskReport().return.seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). - valueAtRiskReport().return.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. - valueAtRiskReport(options)?: import('@insiderfinance/totalfinance/risk').VaROptions; default: not declared - valueAtRiskReport(options).confidence?: number; default: not declared — Confidence level in (0, 1). Default 0.95. - valueAtRiskReport(options).cornishFisher?: boolean; default: not declared — Parametric only: Cornish-Fisher adjustment for skew/excess-kurtosis. Default false. Applied only where the expansion is a monotone quantile map; outside that domain the plain Gaussian quantile is reported with a `risk.cornish_fisher_out_of_domain` warning and `cornishFisher: false`. Over a multi-period `horizonPeriods` the moments are rescaled to the horizon under iid aggregation (`skew/√h`, `excessKurtosis/h`), disclosed as `assumptions.momentScaling: 'iid'`. On a non-parametric method it is ignored with an info warning, never silently. - valueAtRiskReport(options).horizonPeriods?: number; default: not declared — Holding-period horizonPeriods in periods; scales by √-time. Default 1. - valueAtRiskReport(options).method?: import('@insiderfinance/totalfinance/risk').VaRMethod; default: not declared — Estimation method. Default `'historical'`. - `'historical'` — the empirical (hyndman-fan-7) tail quantile of the sample; - `'parametric'` — the Gaussian quantile of the fitted (μ, σ), optionally Cornish-Fisher; - `'monteCarlo'` — draws from the **fitted NORMAL** and takes its empirical tail. It captures no non-normality whatsoever (same two moments as `'parametric'`, plus sampling noise), so prefer `'parametric'` unless you specifically want sampling diagnostics; use `'historical'` or the EVT tools when the shape of the tail matters. - valueAtRiskReport(options).samples?: number; default: not declared — Monte-Carlo only: number of simulated paths. Default 10000. - valueAtRiskReport(options).seed?: number; default: not declared — Monte-Carlo only: PRNG seed for reproducibility. Default 1. - valueAtRiskReport(returns): ArrayLike; default: not declared - walkForwardSplits: (observationCount: number, options: import('@insiderfinance/totalfinance/risk').WalkForwardOptions) => import('@insiderfinance/totalfinance/risk').Split[]; default: not declared — Generate walk-forward (rolling or anchored) train/test splits over `n` ordered observations. - walkForwardSplits(observationCount): number; default: not declared - walkForwardSplits(options): import('@insiderfinance/totalfinance/risk').WalkForwardOptions; default: not declared - walkForwardSplits(options).mode?: 'rolling' | 'anchored'; default: not declared — `rolling` (sliding train window) or `anchored` (train always starts at 0). Default `rolling`. - walkForwardSplits(options).step?: number; default: not declared — Step between successive folds (default `testSize`). - walkForwardSplits(options).testSize: number; default: not declared — Test window length. - walkForwardSplits(options).trainSize: number; default: not declared — Training window length (in observations). ### @insiderfinance/totalfinance#scenarios Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const scenarios: typeof import('@insiderfinance/totalfinance/scenarios'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - runScenarios: (rawInput: import('@insiderfinance/totalfinance/scenarios').RunScenariosInput) => import('@insiderfinance/totalfinance/scenarios').ScenarioRunResult; default: not declared — Run one validated ScenarioSet over heterogeneous builder-owned targets and one market snapshot. - runScenarios().return.aggregates: { readonly base: import('@insiderfinance/totalfinance/scenarios').ScenarioBaseAggregateSet; readonly scenarios: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioOutcomeAggregateSet[]; }; default: not declared - runScenarios().return.aggregates.base: import('@insiderfinance/totalfinance/scenarios').ScenarioBaseAggregateSet; default: not declared - runScenarios().return.aggregates.scenarios: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioOutcomeAggregateSet[]; default: not declared - runScenarios().return.assumptions: import('@insiderfinance/totalfinance/scenarios').ScenarioRunAssumptions; default: not declared - runScenarios().return.base: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioBaseCell[]; default: not declared - runScenarios().return.cells: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioCell[]; default: not declared - runScenarios().return.diagnostics: import('@insiderfinance/totalfinance/scenarios').ScenarioRunDiagnostics; default: not declared - runScenarios().return.layout: import('@insiderfinance/totalfinance/scenarios').ScenarioResultLayout; default: not declared - runScenarios().return.scenarioAxis: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioAxisRow[]; default: not declared - runScenarios().return.targetAxis: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioTargetAxisRow[]; default: not declared - runScenarios(rawInput): import('@insiderfinance/totalfinance/scenarios').RunScenariosInput; default: not declared - runScenarios(rawInput).currencyConversions?: readonly import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote[]; default: not declared - runScenarios(rawInput).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared - runScenarios(rawInput).options?: import('@insiderfinance/totalfinance/scenarios').RunScenariosOptions; default: not declared - runScenarios(rawInput).reportingCurrency?: string; default: not declared - runScenarios(rawInput).scenarioSet: import('@insiderfinance/totalfinance/core/artifacts').ScenarioSet; default: not declared - runScenarios(rawInput).targets: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioTarget[]; default: not declared - scenarioPortfolioBinding: import('@insiderfinance/totalfinance/scenarios').ScenarioPortfolioBindingBuilders; default: not declared — Opaque builder namespace for durable portfolio-to-scenario bindings. - scenarioPortfolioBinding.fullRevaluation: (input: import('@insiderfinance/totalfinance/scenarios').FullRevaluationScenarioPortfolioBindingInput) => import('@insiderfinance/totalfinance/scenarios').ScenarioPortfolioBinding; default: not declared - scenarioPortfolioBinding.fullRevaluation(input): import('@insiderfinance/totalfinance/scenarios').FullRevaluationScenarioPortfolioBindingInput; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).accountId: string; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).book?: string; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).id: string; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).instrument: TInstrument; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).instrumentDescriptor?: unknown; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).instrumentId: string; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).pricer: import('@insiderfinance/totalfinance/core/pricing').Pricer, import('@insiderfinance/totalfinance/core/pricing').PricerValuationResult>; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).strategy?: string; default: not declared - scenarioPortfolioBinding.fullRevaluation(input).tags?: readonly string[]; default: not declared - scenarioPortfolioBinding.taylor: (input: import('@insiderfinance/totalfinance/scenarios').TaylorScenarioPortfolioBindingInput) => import('@insiderfinance/totalfinance/scenarios').ScenarioPortfolioBinding; default: not declared - scenarioPortfolioBinding.taylor(input): import('@insiderfinance/totalfinance/scenarios').TaylorScenarioPortfolioBindingInput; default: not declared - scenarioPortfolioBinding.taylor(input).accountId: string; default: not declared - scenarioPortfolioBinding.taylor(input).baseValuePerUnit: number; default: not declared - scenarioPortfolioBinding.taylor(input).book?: string; default: not declared - scenarioPortfolioBinding.taylor(input).factors: import('@insiderfinance/totalfinance/scenarios').TaylorFactors; default: not declared - scenarioPortfolioBinding.taylor(input).greeks: import('@insiderfinance/totalfinance/scenarios').TaylorSensitivities; default: not declared - scenarioPortfolioBinding.taylor(input).id: string; default: not declared - scenarioPortfolioBinding.taylor(input).instrumentId: string; default: not declared - scenarioPortfolioBinding.taylor(input).strategy?: string; default: not declared - scenarioPortfolioBinding.taylor(input).tags?: readonly string[]; default: not declared - scenarioTarget: import('@insiderfinance/totalfinance/scenarios').ScenarioTargetBuilders; default: not declared — Builder namespace for opaque, immutable scenario targets. - scenarioTarget.fullRevaluation: (input: import('@insiderfinance/totalfinance/scenarios').FullRevaluationScenarioTargetInput) => import('@insiderfinance/totalfinance/scenarios').ScenarioTarget; default: not declared - scenarioTarget.fullRevaluation(input): import('@insiderfinance/totalfinance/scenarios').FullRevaluationScenarioTargetInput; default: not declared - scenarioTarget.fullRevaluation(input).account?: string; default: not declared - scenarioTarget.fullRevaluation(input).book?: string; default: not declared - scenarioTarget.fullRevaluation(input).contractMultiplier: number; default: not declared - scenarioTarget.fullRevaluation(input).currency: string; default: not declared - scenarioTarget.fullRevaluation(input).id: string; default: not declared - scenarioTarget.fullRevaluation(input).instrument: TInstrument; default: not declared - scenarioTarget.fullRevaluation(input).instrumentDescriptor?: unknown; default: not declared - scenarioTarget.fullRevaluation(input).pricer: import('@insiderfinance/totalfinance/core/pricing').Pricer, import('@insiderfinance/totalfinance/core/pricing').PricerValuationResult>; default: not declared - scenarioTarget.fullRevaluation(input).quantity: number; default: not declared - scenarioTarget.fullRevaluation(input).strategy?: string; default: not declared - scenarioTarget.fullRevaluation(input).tags?: readonly string[]; default: not declared - scenarioTarget.fullRevaluation(input).underlying?: string; default: not declared - scenarioTarget.spot: (input: import('@insiderfinance/totalfinance/scenarios').SpotScenarioTargetInput) => import('@insiderfinance/totalfinance/scenarios').ScenarioTarget; default: not declared - scenarioTarget.spot(input): import('@insiderfinance/totalfinance/scenarios').SpotScenarioTargetInput; default: not declared - scenarioTarget.spot(input).account?: string; default: not declared - scenarioTarget.spot(input).book?: string; default: not declared - scenarioTarget.spot(input).currency: string; default: not declared - scenarioTarget.spot(input).id: string; default: not declared - scenarioTarget.spot(input).quantity: number; default: not declared - scenarioTarget.spot(input).strategy?: string; default: not declared - scenarioTarget.spot(input).symbol: string; default: not declared - scenarioTarget.spot(input).tags?: readonly string[]; default: not declared - scenarioTarget.taylor: (input: import('@insiderfinance/totalfinance/scenarios').TaylorScenarioTargetInput) => import('@insiderfinance/totalfinance/scenarios').ScenarioTarget; default: not declared - scenarioTarget.taylor(input): import('@insiderfinance/totalfinance/scenarios').TaylorScenarioTargetInput; default: not declared - scenarioTarget.taylor(input).account?: string; default: not declared - scenarioTarget.taylor(input).baseValuePerUnit: number; default: not declared - scenarioTarget.taylor(input).book?: string; default: not declared - scenarioTarget.taylor(input).contractMultiplier: number; default: not declared - scenarioTarget.taylor(input).currency: string; default: not declared - scenarioTarget.taylor(input).factors: import('@insiderfinance/totalfinance/scenarios').TaylorFactors; default: not declared - scenarioTarget.taylor(input).greeks: import('@insiderfinance/totalfinance/scenarios').TaylorSensitivities; default: not declared - scenarioTarget.taylor(input).id: string; default: not declared - scenarioTarget.taylor(input).quantity: number; default: not declared - scenarioTarget.taylor(input).strategy?: string; default: not declared - scenarioTarget.taylor(input).tags?: readonly string[]; default: not declared - scenarioTarget.taylor(input).underlying?: string; default: not declared - scenarioTargetsFromPortfolio: (rawInput: import('@insiderfinance/totalfinance/scenarios').ScenarioTargetsFromPortfolioInput) => readonly import('@insiderfinance/totalfinance/scenarios').ScenarioTarget[]; default: not declared — Convert every open position in one validated durable portfolio snapshot into exactly one opaque scenario target. Ledger facts remain authoritative; bindings contribute only identity, valuation behavior, and optional strategy/book/tag metadata. - scenarioTargetsFromPortfolio(rawInput): import('@insiderfinance/totalfinance/scenarios').ScenarioTargetsFromPortfolioInput; default: not declared - scenarioTargetsFromPortfolio(rawInput).bindings: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioPortfolioBinding[]; default: not declared - scenarioTargetsFromPortfolio(rawInput).state: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - spotAssetPricer: () => import('@insiderfinance/totalfinance/core/pricing').Pricer; default: not declared — First-party Gate-C adapter for a directly observed spot asset. Its per-unit value is exactly the matching spot observation; quantity and any contract multiplier remain target-owned. - spotAssetPricer().return.capabilities: import('@insiderfinance/totalfinance/core/pricing').PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - spotAssetPricer().return.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - spotAssetPricer().return.price: (input: import('@insiderfinance/totalfinance/core/pricing').PricerPriceInput) => SpotAssetPricingResult; default: not declared - spotAssetPricer().return.priceBatch?: (input: import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput) => readonly SpotAssetPricingResult[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - spotAssetPricer().return.requirements: (instrument: import('@insiderfinance/totalfinance/scenarios').SpotAssetInstrument) => readonly import('@insiderfinance/totalfinance/core/pricing').MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - spotAssetPricer().return.supports: (instrument: import('@insiderfinance/totalfinance/scenarios').SpotAssetInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - spotAssetPricer().return.version: string; default: not declared ### @insiderfinance/totalfinance#strategy Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const strategy: typeof import('@insiderfinance/totalfinance/strategy'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - Position: typeof Position; default: not declared - Position().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - Position().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - Position().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - Position().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - Position().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - Position().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - Position().return.market.dividendYield?: number; default: not declared - Position().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - Position().return.market.riskFreeRate: number; default: not declared - Position().return.market.spot: number; default: not declared - Position().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - Position().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - Position().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - Position().return.multiplier: number; default: not declared - Position().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - Position().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - Position().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - Position().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - Position().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - Position().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - Position().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - Position().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - Position().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - Position(config)?: PositionConfig; default: not declared - Position(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - Position(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - Position(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - Position(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - Position(legs): readonly LegInput[]; default: not declared - SCAN_OBJECTIVES: readonly ['probabilityOfProfit', 'expectedValue', 'returnOnRisk', 'expectedValuePerRisk']; default: not declared — Every ranking objective a scan accepts, as DATA — the single source the type, the runtime guard and the error message are all derived from. RV11 — these were three copies: a hand-written union here, a hand-written array in `optimizer.ts`, and a third hand-written list inside the error string. The string copy drifted and kept teaching `pop|ev` after both were renamed, because plain prose is invisible to a rename of the quoted literals. One tuple, and `.join(', ')` for the message, is what makes that impossible rather than merely fixed. `'return'` became `'returnOnRisk'` in the same pass: it ranked by `returnOnRisk` and the candidate output already called that number `returnOnRisk`, so one quantity carried two public names. - bearCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bearCallLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearCallLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearCallLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearCallLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearCallLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearCallLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearCallLadder().return.market.dividendYield?: number; default: not declared - bearCallLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearCallLadder().return.market.riskFreeRate: number; default: not declared - bearCallLadder().return.market.spot: number; default: not declared - bearCallLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearCallLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearCallLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearCallLadder().return.multiplier: number; default: not declared - bearCallLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearCallLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearCallLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearCallLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearCallLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearCallLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearCallLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearCallLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearCallLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearCallLadder(config)?: PositionConfig | undefined; default: not declared - bearCallLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearCallLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearCallLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearCallLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearCallLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bearCallLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bearCallLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearCallLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearCallLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bearCallLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bearCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearCallSpread().return.market.dividendYield?: number; default: not declared - bearCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearCallSpread().return.market.riskFreeRate: number; default: not declared - bearCallSpread().return.market.spot: number; default: not declared - bearCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearCallSpread().return.multiplier: number; default: not declared - bearCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearCallSpread(config)?: PositionConfig | undefined; default: not declared - bearCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearCallSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bearCallSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bearCallSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bearCallSpread(input).quantity?: number; default: not declared - bearCallSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - bearPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bearPutLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearPutLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearPutLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearPutLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearPutLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearPutLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearPutLadder().return.market.dividendYield?: number; default: not declared - bearPutLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearPutLadder().return.market.riskFreeRate: number; default: not declared - bearPutLadder().return.market.spot: number; default: not declared - bearPutLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearPutLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearPutLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearPutLadder().return.multiplier: number; default: not declared - bearPutLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearPutLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearPutLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearPutLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearPutLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearPutLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearPutLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearPutLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearPutLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearPutLadder(config)?: PositionConfig | undefined; default: not declared - bearPutLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearPutLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearPutLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearPutLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearPutLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bearPutLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bearPutLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearPutLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearPutLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bearPutLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bearPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearPutSpread().return.market.dividendYield?: number; default: not declared - bearPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearPutSpread().return.market.riskFreeRate: number; default: not declared - bearPutSpread().return.market.spot: number; default: not declared - bearPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearPutSpread().return.multiplier: number; default: not declared - bearPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearPutSpread(config)?: PositionConfig | undefined; default: not declared - bearPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearPutSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bearPutSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bearPutSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bearPutSpread(input).quantity?: number; default: not declared - bearPutSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - buildStrategy: (request: manifest.BuildStrategyInput) => Position; default: not declared - buildStrategy().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - buildStrategy().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - buildStrategy().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - buildStrategy().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - buildStrategy().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - buildStrategy().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - buildStrategy().return.market.dividendYield?: number; default: not declared - buildStrategy().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - buildStrategy().return.market.riskFreeRate: number; default: not declared - buildStrategy().return.market.spot: number; default: not declared - buildStrategy().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - buildStrategy().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - buildStrategy().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - buildStrategy().return.multiplier: number; default: not declared - buildStrategy().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - buildStrategy().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - buildStrategy().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - buildStrategy().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - buildStrategy().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - buildStrategy().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - buildStrategy().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - buildStrategy().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - buildStrategy().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - buildStrategy(request): manifest.BuildStrategyInput; default: not declared - buildStrategy(request).config?: PositionConfig; default: not declared — Optional position construction and model-premium configuration. - buildStrategy(request).input: Record; default: not declared — Builder-specific strategy fields; inspect the matching descriptor's `exampleInput`. - buildStrategy(request).name: string; default: not declared — The exact strategy name returned by {@link listStrategies}. - bullCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bullCallLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullCallLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullCallLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullCallLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullCallLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullCallLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullCallLadder().return.market.dividendYield?: number; default: not declared - bullCallLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullCallLadder().return.market.riskFreeRate: number; default: not declared - bullCallLadder().return.market.spot: number; default: not declared - bullCallLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullCallLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullCallLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullCallLadder().return.multiplier: number; default: not declared - bullCallLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullCallLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullCallLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullCallLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullCallLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullCallLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullCallLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullCallLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullCallLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullCallLadder(config)?: PositionConfig | undefined; default: not declared - bullCallLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullCallLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullCallLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullCallLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullCallLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bullCallLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bullCallLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullCallLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullCallLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bullCallLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bullCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullCallSpread().return.market.dividendYield?: number; default: not declared - bullCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullCallSpread().return.market.riskFreeRate: number; default: not declared - bullCallSpread().return.market.spot: number; default: not declared - bullCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullCallSpread().return.multiplier: number; default: not declared - bullCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullCallSpread(config)?: PositionConfig | undefined; default: not declared - bullCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullCallSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bullCallSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bullCallSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bullCallSpread(input).quantity?: number; default: not declared - bullCallSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - bullPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bullPutLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullPutLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullPutLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullPutLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullPutLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullPutLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullPutLadder().return.market.dividendYield?: number; default: not declared - bullPutLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullPutLadder().return.market.riskFreeRate: number; default: not declared - bullPutLadder().return.market.spot: number; default: not declared - bullPutLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullPutLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullPutLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullPutLadder().return.multiplier: number; default: not declared - bullPutLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullPutLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullPutLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullPutLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullPutLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullPutLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullPutLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullPutLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullPutLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullPutLadder(config)?: PositionConfig | undefined; default: not declared - bullPutLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullPutLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullPutLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullPutLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullPutLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bullPutLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bullPutLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullPutLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullPutLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bullPutLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bullPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullPutSpread().return.market.dividendYield?: number; default: not declared - bullPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullPutSpread().return.market.riskFreeRate: number; default: not declared - bullPutSpread().return.market.spot: number; default: not declared - bullPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullPutSpread().return.multiplier: number; default: not declared - bullPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullPutSpread(config)?: PositionConfig | undefined; default: not declared - bullPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullPutSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bullPutSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bullPutSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bullPutSpread(input).quantity?: number; default: not declared - bullPutSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - calendarCallSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; default: not declared - calendarCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - calendarCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - calendarCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - calendarCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - calendarCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - calendarCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - calendarCallSpread().return.market.dividendYield?: number; default: not declared - calendarCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - calendarCallSpread().return.market.riskFreeRate: number; default: not declared - calendarCallSpread().return.market.spot: number; default: not declared - calendarCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - calendarCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - calendarCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - calendarCallSpread().return.multiplier: number; default: not declared - calendarCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - calendarCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - calendarCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - calendarCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - calendarCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - calendarCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - calendarCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - calendarCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - calendarCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - calendarCallSpread(config)?: PositionConfig | undefined; default: not declared - calendarCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - calendarCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - calendarCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - calendarCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - calendarCallSpread(input): import('@insiderfinance/totalfinance/strategy').CalendarInput; default: not declared - calendarCallSpread(input).farExpiry: string; default: not declared — Far expiry of the long leg. - calendarCallSpread(input).longPremium?: number; default: not declared — Premium paid on the long far leg. - calendarCallSpread(input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - calendarCallSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - calendarCallSpread(input).shortPremium?: number; default: not declared — Premium received on the short near leg. - calendarCallSpread(input).strike: number; default: not declared - calendarPutSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; default: not declared - calendarPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - calendarPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - calendarPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - calendarPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - calendarPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - calendarPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - calendarPutSpread().return.market.dividendYield?: number; default: not declared - calendarPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - calendarPutSpread().return.market.riskFreeRate: number; default: not declared - calendarPutSpread().return.market.spot: number; default: not declared - calendarPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - calendarPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - calendarPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - calendarPutSpread().return.multiplier: number; default: not declared - calendarPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - calendarPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - calendarPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - calendarPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - calendarPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - calendarPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - calendarPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - calendarPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - calendarPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - calendarPutSpread(config)?: PositionConfig | undefined; default: not declared - calendarPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - calendarPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - calendarPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - calendarPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - calendarPutSpread(input): import('@insiderfinance/totalfinance/strategy').CalendarInput; default: not declared - calendarPutSpread(input).farExpiry: string; default: not declared — Far expiry of the long leg. - calendarPutSpread(input).longPremium?: number; default: not declared — Premium paid on the long far leg. - calendarPutSpread(input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - calendarPutSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - calendarPutSpread(input).shortPremium?: number; default: not declared — Premium received on the short near leg. - calendarPutSpread(input).strike: number; default: not declared - callBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - callBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - callBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - callBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - callBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - callBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - callBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - callBrokenWing().return.market.dividendYield?: number; default: not declared - callBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - callBrokenWing().return.market.riskFreeRate: number; default: not declared - callBrokenWing().return.market.spot: number; default: not declared - callBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - callBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - callBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - callBrokenWing().return.multiplier: number; default: not declared - callBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - callBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - callBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - callBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - callBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - callBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - callBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - callBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - callBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - callBrokenWing(config)?: PositionConfig | undefined; default: not declared - callBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - callBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - callBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - callBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - callBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - callBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - callBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - callBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - callRatioBackspread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - callRatioBackspread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - callRatioBackspread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - callRatioBackspread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - callRatioBackspread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - callRatioBackspread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - callRatioBackspread().return.market.dividendYield?: number; default: not declared - callRatioBackspread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - callRatioBackspread().return.market.riskFreeRate: number; default: not declared - callRatioBackspread().return.market.spot: number; default: not declared - callRatioBackspread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - callRatioBackspread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - callRatioBackspread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - callRatioBackspread().return.multiplier: number; default: not declared - callRatioBackspread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - callRatioBackspread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - callRatioBackspread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - callRatioBackspread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - callRatioBackspread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - callRatioBackspread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - callRatioBackspread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - callRatioBackspread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - callRatioBackspread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - callRatioBackspread(config)?: PositionConfig | undefined; default: not declared - callRatioBackspread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - callRatioBackspread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - callRatioBackspread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - callRatioBackspread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - callRatioBackspread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - callRatioBackspread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - callRatioBackspread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioBackspread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - callRatioBackspread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - callRatioBackspread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - callRatioSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - callRatioSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - callRatioSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - callRatioSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - callRatioSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - callRatioSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - callRatioSpread().return.market.dividendYield?: number; default: not declared - callRatioSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - callRatioSpread().return.market.riskFreeRate: number; default: not declared - callRatioSpread().return.market.spot: number; default: not declared - callRatioSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - callRatioSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - callRatioSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - callRatioSpread().return.multiplier: number; default: not declared - callRatioSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - callRatioSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - callRatioSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - callRatioSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - callRatioSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - callRatioSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - callRatioSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - callRatioSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - callRatioSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - callRatioSpread(config)?: PositionConfig | undefined; default: not declared - callRatioSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - callRatioSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - callRatioSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - callRatioSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - callRatioSpread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - callRatioSpread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - callRatioSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - callRatioSpread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - callRatioSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - cashSecuredPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - cashSecuredPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - cashSecuredPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - cashSecuredPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - cashSecuredPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - cashSecuredPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - cashSecuredPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - cashSecuredPut().return.market.dividendYield?: number; default: not declared - cashSecuredPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - cashSecuredPut().return.market.riskFreeRate: number; default: not declared - cashSecuredPut().return.market.spot: number; default: not declared - cashSecuredPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - cashSecuredPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - cashSecuredPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - cashSecuredPut().return.multiplier: number; default: not declared - cashSecuredPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - cashSecuredPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - cashSecuredPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - cashSecuredPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - cashSecuredPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - cashSecuredPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - cashSecuredPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - cashSecuredPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - cashSecuredPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - cashSecuredPut(config)?: PositionConfig | undefined; default: not declared - cashSecuredPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - cashSecuredPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - cashSecuredPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - cashSecuredPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - cashSecuredPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - cashSecuredPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - cashSecuredPut(input).premium?: number; default: not declared - cashSecuredPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - cashSecuredPut(input).strike: number; default: not declared - classifyStrategy: (input: readonly import('@insiderfinance/totalfinance/strategy').ClassifiableLeg[] | readonly LegInput[] | Position) => ({ matches: import('@insiderfinance/totalfinance/strategy').StrategyMatch[]; assumptions: { conventionsVersion: string; matching: 'structural-base-signature'; tieBreaker: 'wing-gap-symmetry'; }; diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; }); default: not declared — Classify a leg list (or a Position) against the named-strategy catalog. `matches` carries every matching name in manifest order — payoff-identical aliases all match — and is `[]` when the structure matches nothing (a custom position; every calculation still works, it just has no name). - classifyStrategy().return.assumptions: { conventionsVersion: string; matching: 'structural-base-signature'; tieBreaker: 'wing-gap-symmetry'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - classifyStrategy().return.assumptions.conventionsVersion: string; default: not declared - classifyStrategy().return.assumptions.matching: 'structural-base-signature'; default: not declared — Identity is the structural base signature: (kind, sign, strike-rank, ratio, expiry-rank). - classifyStrategy().return.assumptions.tieBreaker: 'wing-gap-symmetry'; default: not declared — Spacing splits base-signature collisions only (butterflies vs broken wings). - classifyStrategy().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - classifyStrategy().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - classifyStrategy().return.matches: import('@insiderfinance/totalfinance/strategy').StrategyMatch[]; default: not declared — Every matching name in manifest order — payoff-identical aliases all match. Empty = a custom position (every calculation still works, it just has no name). - classifyStrategy(input): Position | readonly LegInput[] | readonly import('@insiderfinance/totalfinance/strategy').ClassifiableLeg[]; default: not declared - classifyStrategy(input).assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - classifyStrategy(input).chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - classifyStrategy(input).constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - classifyStrategy(input).legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - classifyStrategy(input).market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - classifyStrategy(input).market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - classifyStrategy(input).market.dividendYield?: number; default: not declared - classifyStrategy(input).market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - classifyStrategy(input).market.riskFreeRate: number; default: not declared - classifyStrategy(input).market.spot: number; default: not declared - classifyStrategy(input).market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - classifyStrategy(input).metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - classifyStrategy(input).monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - classifyStrategy(input).multiplier: number; default: not declared - classifyStrategy(input).netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - classifyStrategy(input).payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - classifyStrategy(input).pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - classifyStrategy(input).premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - classifyStrategy(input).premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - classifyStrategy(input).probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - classifyStrategy(input).scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - classifyStrategy(input).value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - classifyStrategy(input).whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - collar: (input: import('@insiderfinance/totalfinance/strategy').CollarInput, config?: PositionConfig) => Position; default: not declared - collar().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - collar().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - collar().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - collar().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - collar().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - collar().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - collar().return.market.dividendYield?: number; default: not declared - collar().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - collar().return.market.riskFreeRate: number; default: not declared - collar().return.market.spot: number; default: not declared - collar().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - collar().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - collar().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - collar().return.multiplier: number; default: not declared - collar().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - collar().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - collar().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - collar().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - collar().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - collar().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - collar().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - collar().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - collar().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - collar(config)?: PositionConfig | undefined; default: not declared - collar(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - collar(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - collar(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - collar(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - collar(input): import('@insiderfinance/totalfinance/strategy').CollarInput; default: not declared - collar(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - collar(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - collar(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - collar(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - collar(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - coveredCall: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; default: not declared - coveredCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - coveredCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - coveredCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - coveredCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - coveredCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - coveredCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - coveredCall().return.market.dividendYield?: number; default: not declared - coveredCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - coveredCall().return.market.riskFreeRate: number; default: not declared - coveredCall().return.market.spot: number; default: not declared - coveredCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - coveredCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - coveredCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - coveredCall().return.multiplier: number; default: not declared - coveredCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - coveredCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - coveredCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - coveredCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - coveredCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - coveredCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - coveredCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - coveredCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - coveredCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - coveredCall(config)?: PositionConfig | undefined; default: not declared - coveredCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - coveredCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - coveredCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - coveredCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - coveredCall(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg; default: not declared - coveredCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - coveredCall(input).premium?: number; default: not declared - coveredCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - coveredCall(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - coveredCall(input).strike: number; default: not declared - coveredShortStraddle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; default: not declared - coveredShortStraddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - coveredShortStraddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - coveredShortStraddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - coveredShortStraddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - coveredShortStraddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - coveredShortStraddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - coveredShortStraddle().return.market.dividendYield?: number; default: not declared - coveredShortStraddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - coveredShortStraddle().return.market.riskFreeRate: number; default: not declared - coveredShortStraddle().return.market.spot: number; default: not declared - coveredShortStraddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - coveredShortStraddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - coveredShortStraddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - coveredShortStraddle().return.multiplier: number; default: not declared - coveredShortStraddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - coveredShortStraddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - coveredShortStraddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - coveredShortStraddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - coveredShortStraddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - coveredShortStraddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - coveredShortStraddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - coveredShortStraddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - coveredShortStraddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - coveredShortStraddle(config)?: PositionConfig | undefined; default: not declared - coveredShortStraddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - coveredShortStraddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - coveredShortStraddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - coveredShortStraddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - coveredShortStraddle(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput; default: not declared - coveredShortStraddle(input).callPremium?: number; default: not declared - coveredShortStraddle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - coveredShortStraddle(input).putPremium?: number; default: not declared - coveredShortStraddle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - coveredShortStraddle(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - coveredShortStraddle(input).strike: number; default: not declared - coveredShortStrangle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; default: not declared - coveredShortStrangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - coveredShortStrangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - coveredShortStrangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - coveredShortStrangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - coveredShortStrangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - coveredShortStrangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - coveredShortStrangle().return.market.dividendYield?: number; default: not declared - coveredShortStrangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - coveredShortStrangle().return.market.riskFreeRate: number; default: not declared - coveredShortStrangle().return.market.spot: number; default: not declared - coveredShortStrangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - coveredShortStrangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - coveredShortStrangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - coveredShortStrangle().return.multiplier: number; default: not declared - coveredShortStrangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - coveredShortStrangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - coveredShortStrangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - coveredShortStrangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - coveredShortStrangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - coveredShortStrangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - coveredShortStrangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - coveredShortStrangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - coveredShortStrangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - coveredShortStrangle(config)?: PositionConfig | undefined; default: not declared - coveredShortStrangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - coveredShortStrangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - coveredShortStrangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - coveredShortStrangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - coveredShortStrangle(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput; default: not declared - coveredShortStrangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - coveredShortStrangle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - coveredShortStrangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - coveredShortStrangle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - coveredShortStrangle(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - diagonalCallSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; default: not declared - diagonalCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - diagonalCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - diagonalCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - diagonalCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - diagonalCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - diagonalCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - diagonalCallSpread().return.market.dividendYield?: number; default: not declared - diagonalCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - diagonalCallSpread().return.market.riskFreeRate: number; default: not declared - diagonalCallSpread().return.market.spot: number; default: not declared - diagonalCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - diagonalCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - diagonalCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - diagonalCallSpread().return.multiplier: number; default: not declared - diagonalCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - diagonalCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - diagonalCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - diagonalCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - diagonalCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - diagonalCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - diagonalCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - diagonalCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - diagonalCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - diagonalCallSpread(config)?: PositionConfig | undefined; default: not declared - diagonalCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - diagonalCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - diagonalCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - diagonalCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - diagonalCallSpread(input): import('@insiderfinance/totalfinance/strategy').DiagonalInput; default: not declared - diagonalCallSpread(input).farExpiry: string; default: not declared - diagonalCallSpread(input).longPremium?: number; default: not declared - diagonalCallSpread(input).longStrike: number; default: not declared - diagonalCallSpread(input).nearExpiry: string; default: not declared - diagonalCallSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - diagonalCallSpread(input).shortPremium?: number; default: not declared - diagonalCallSpread(input).shortStrike: number; default: not declared - diagonalPutSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; default: not declared - diagonalPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - diagonalPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - diagonalPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - diagonalPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - diagonalPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - diagonalPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - diagonalPutSpread().return.market.dividendYield?: number; default: not declared - diagonalPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - diagonalPutSpread().return.market.riskFreeRate: number; default: not declared - diagonalPutSpread().return.market.spot: number; default: not declared - diagonalPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - diagonalPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - diagonalPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - diagonalPutSpread().return.multiplier: number; default: not declared - diagonalPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - diagonalPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - diagonalPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - diagonalPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - diagonalPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - diagonalPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - diagonalPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - diagonalPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - diagonalPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - diagonalPutSpread(config)?: PositionConfig | undefined; default: not declared - diagonalPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - diagonalPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - diagonalPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - diagonalPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - diagonalPutSpread(input): import('@insiderfinance/totalfinance/strategy').DiagonalInput; default: not declared - diagonalPutSpread(input).farExpiry: string; default: not declared - diagonalPutSpread(input).longPremium?: number; default: not declared - diagonalPutSpread(input).longStrike: number; default: not declared - diagonalPutSpread(input).nearExpiry: string; default: not declared - diagonalPutSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - diagonalPutSpread(input).shortPremium?: number; default: not declared - diagonalPutSpread(input).shortStrike: number; default: not declared - doubleDiagonal: (input: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput, config?: PositionConfig) => Position; default: not declared - doubleDiagonal().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - doubleDiagonal().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - doubleDiagonal().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - doubleDiagonal().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - doubleDiagonal().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - doubleDiagonal().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - doubleDiagonal().return.market.dividendYield?: number; default: not declared - doubleDiagonal().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - doubleDiagonal().return.market.riskFreeRate: number; default: not declared - doubleDiagonal().return.market.spot: number; default: not declared - doubleDiagonal().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - doubleDiagonal().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - doubleDiagonal().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - doubleDiagonal().return.multiplier: number; default: not declared - doubleDiagonal().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - doubleDiagonal().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - doubleDiagonal().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - doubleDiagonal().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - doubleDiagonal().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - doubleDiagonal().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - doubleDiagonal().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - doubleDiagonal().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - doubleDiagonal().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - doubleDiagonal(config)?: PositionConfig | undefined; default: not declared - doubleDiagonal(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - doubleDiagonal(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - doubleDiagonal(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - doubleDiagonal(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - doubleDiagonal(input): import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput; default: not declared - doubleDiagonal(input).call: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalSide; default: not declared - doubleDiagonal(input).farExpiry: string; default: not declared - doubleDiagonal(input).nearExpiry: string; default: not declared - doubleDiagonal(input).put: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalSide; default: not declared - doubleDiagonal(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - explainPosition: (position: Position, options?: import('@insiderfinance/totalfinance/strategy').ExplainPositionOptions) => import('@insiderfinance/totalfinance/strategy').PositionExplanation; default: not declared - explainPosition().return.aliases: string[]; default: not declared — Other payoff-identical names. - explainPosition().return.assumptions: { conventionsVersion: string; classifier: 'structural-base-signature'; marketDependent: boolean; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - explainPosition().return.assumptions.classifier: 'structural-base-signature'; default: not declared — How the name was derived — always the structural classifier (identity is never remembered). - explainPosition().return.assumptions.conventionsVersion: string; default: not declared - explainPosition().return.assumptions.marketDependent: boolean; default: not declared — Whether a usable market priced the greek/probability posture (false = payoff-only read). - explainPosition().return.definedRisk: boolean; default: not declared - explainPosition().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — a missing market explains itself here. - explainPosition().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - explainPosition().return.directionalBias: import('@insiderfinance/totalfinance/strategy').DirectionalBias; default: not declared - explainPosition().return.economics: { net: number; maxProfit: number | null; maxLoss: number | null; breakevens: number[]; rewardToRisk: number | null; }; default: not declared - explainPosition().return.economics.breakevens: number[]; default: not declared - explainPosition().return.economics.maxLoss: number | null; default: not declared — Maximum loss (negative), or `null` when unbounded. - explainPosition().return.economics.maxProfit: number | null; default: not declared — Maximum profit, or `null` when unbounded. - explainPosition().return.economics.net: number; default: not declared — Net cash: `+` = debit paid, `−` = credit received (per contract). - explainPosition().return.economics.rewardToRisk: number | null; default: not declared — `|maxProfit / maxLoss|`, or `null` when undefined (an unbounded side or a zero max loss). - explainPosition().return.greeks?: { delta: number; gamma: number; theta: number; vega: number; rho: number; }; default: not declared - explainPosition().return.greeks.delta: number; default: not declared - explainPosition().return.greeks.gamma: number; default: not declared - explainPosition().return.greeks.rho: number; default: not declared - explainPosition().return.greeks.theta: number; default: not declared - explainPosition().return.greeks.vega: number; default: not declared - explainPosition().return.moveBias: import('@insiderfinance/totalfinance/strategy').MoveBias; default: not declared - explainPosition().return.name: string; default: not declared — The classification, or `'custom'`. - explainPosition().return.probability?: { probabilityOfProfit: number; expectedValue: number; }; default: not declared - explainPosition().return.probability.expectedValue: number; default: not declared - explainPosition().return.probability.probabilityOfProfit: number; default: not declared - explainPosition().return.risks: string[]; default: not declared - explainPosition().return.structure: string; default: not declared — Readable leg list, sorted by strike. - explainPosition().return.summary: string; default: not declared — The prose narrative composing all of the above. - explainPosition().return.timeBias?: import('@insiderfinance/totalfinance/strategy').TimeBias; default: not declared - explainPosition().return.volatilityBias?: import('@insiderfinance/totalfinance/strategy').VolatilityBias; default: not declared — Present when a market is available. - explainPosition(options)?: import('@insiderfinance/totalfinance/strategy').ExplainPositionOptions; default: not declared - explainPosition(options).market?: Partial; default: not declared — Market for probability + greeks (spot/vol/rate/asOf); merges over the position's own market. - explainPosition(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - explainPosition(options).market.dividendYield?: number; default: not declared - explainPosition(options).market.expiry?: string; default: not declared - explainPosition(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - explainPosition(options).market.riskFreeRate?: number; default: not declared - explainPosition(options).market.spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - explainPosition(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - explainPosition(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - explainPosition(options).underlyingLabel?: string; default: not declared — Underlying name for the prose (e.g. `'AAPL'`); default `'the underlying'`. - explainPosition(position): Position; default: not declared - explainPosition(position).assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - explainPosition(position).chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - explainPosition(position).constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - explainPosition(position).legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - explainPosition(position).market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - explainPosition(position).market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - explainPosition(position).market.dividendYield?: number; default: not declared - explainPosition(position).market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - explainPosition(position).market.riskFreeRate: number; default: not declared - explainPosition(position).market.spot: number; default: not declared - explainPosition(position).market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - explainPosition(position).metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - explainPosition(position).monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - explainPosition(position).multiplier: number; default: not declared - explainPosition(position).netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - explainPosition(position).payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - explainPosition(position).pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - explainPosition(position).premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - explainPosition(position).premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - explainPosition(position).probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - explainPosition(position).scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - explainPosition(position).value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - explainPosition(position).whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - guts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - guts().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - guts().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - guts().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - guts().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - guts().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - guts().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - guts().return.market.dividendYield?: number; default: not declared - guts().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - guts().return.market.riskFreeRate: number; default: not declared - guts().return.market.spot: number; default: not declared - guts().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - guts().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - guts().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - guts().return.multiplier: number; default: not declared - guts().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - guts().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - guts().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - guts().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - guts().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - guts().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - guts().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - guts().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - guts().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - guts(config)?: PositionConfig | undefined; default: not declared - guts(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - guts(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - guts(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - guts(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - guts(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - guts(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - guts(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - guts(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - guts(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseCallBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - inverseCallBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inverseCallBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inverseCallBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inverseCallBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inverseCallBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inverseCallBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inverseCallBrokenWing().return.market.dividendYield?: number; default: not declared - inverseCallBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inverseCallBrokenWing().return.market.riskFreeRate: number; default: not declared - inverseCallBrokenWing().return.market.spot: number; default: not declared - inverseCallBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inverseCallBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inverseCallBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inverseCallBrokenWing().return.multiplier: number; default: not declared - inverseCallBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inverseCallBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inverseCallBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inverseCallBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inverseCallBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inverseCallBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inverseCallBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inverseCallBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inverseCallBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inverseCallBrokenWing(config)?: PositionConfig | undefined; default: not declared - inverseCallBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inverseCallBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inverseCallBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inverseCallBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inverseCallBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - inverseCallBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - inverseCallBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseCallBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseCallBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - inverseCallBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; default: not declared - inverseIronButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inverseIronButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inverseIronButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inverseIronButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inverseIronButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inverseIronButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inverseIronButterfly().return.market.dividendYield?: number; default: not declared - inverseIronButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inverseIronButterfly().return.market.riskFreeRate: number; default: not declared - inverseIronButterfly().return.market.spot: number; default: not declared - inverseIronButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inverseIronButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inverseIronButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inverseIronButterfly().return.multiplier: number; default: not declared - inverseIronButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inverseIronButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inverseIronButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inverseIronButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inverseIronButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inverseIronButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inverseIronButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inverseIronButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inverseIronButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inverseIronButterfly(config)?: PositionConfig | undefined; default: not declared - inverseIronButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inverseIronButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inverseIronButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inverseIronButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inverseIronButterfly(input): import('@insiderfinance/totalfinance/strategy').IronButterflyInput; default: not declared - inverseIronButterfly(input).body: number | { strike: number; callPremium?: number; putPremium?: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - inverseIronButterfly(input).body.callPremium?: number; default: not declared - inverseIronButterfly(input).body.putPremium?: number; default: not declared - inverseIronButterfly(input).body.strike: number; default: not declared - inverseIronButterfly(input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - inverseIronButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - inverseIronButterfly(input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - inverseIronButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - inverseIronCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; default: not declared - inverseIronCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inverseIronCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inverseIronCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inverseIronCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inverseIronCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inverseIronCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inverseIronCondor().return.market.dividendYield?: number; default: not declared - inverseIronCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inverseIronCondor().return.market.riskFreeRate: number; default: not declared - inverseIronCondor().return.market.spot: number; default: not declared - inverseIronCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inverseIronCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inverseIronCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inverseIronCondor().return.multiplier: number; default: not declared - inverseIronCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inverseIronCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inverseIronCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inverseIronCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inverseIronCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inverseIronCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inverseIronCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inverseIronCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inverseIronCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inverseIronCondor(config)?: PositionConfig | undefined; default: not declared - inverseIronCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inverseIronCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inverseIronCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inverseIronCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inverseIronCondor(input): import('@insiderfinance/totalfinance/strategy').IronCondorInput; default: not declared - inverseIronCondor(input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).expiry?: string; default: not declared - inverseIronCondor(input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).quantity?: number; default: not declared - inversePutBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - inversePutBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inversePutBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inversePutBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inversePutBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inversePutBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inversePutBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inversePutBrokenWing().return.market.dividendYield?: number; default: not declared - inversePutBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inversePutBrokenWing().return.market.riskFreeRate: number; default: not declared - inversePutBrokenWing().return.market.spot: number; default: not declared - inversePutBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inversePutBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inversePutBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inversePutBrokenWing().return.multiplier: number; default: not declared - inversePutBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inversePutBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inversePutBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inversePutBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inversePutBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inversePutBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inversePutBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inversePutBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inversePutBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inversePutBrokenWing(config)?: PositionConfig | undefined; default: not declared - inversePutBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inversePutBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inversePutBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inversePutBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inversePutBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - inversePutBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - inversePutBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inversePutBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inversePutBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - inversePutBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; default: not declared - ironButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - ironButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - ironButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - ironButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - ironButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - ironButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - ironButterfly().return.market.dividendYield?: number; default: not declared - ironButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - ironButterfly().return.market.riskFreeRate: number; default: not declared - ironButterfly().return.market.spot: number; default: not declared - ironButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - ironButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - ironButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - ironButterfly().return.multiplier: number; default: not declared - ironButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - ironButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - ironButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - ironButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - ironButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - ironButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - ironButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - ironButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - ironButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - ironButterfly(config)?: PositionConfig | undefined; default: not declared - ironButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - ironButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - ironButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - ironButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - ironButterfly(input): import('@insiderfinance/totalfinance/strategy').IronButterflyInput; default: not declared - ironButterfly(input).body: number | { strike: number; callPremium?: number; putPremium?: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - ironButterfly(input).body.callPremium?: number; default: not declared - ironButterfly(input).body.putPremium?: number; default: not declared - ironButterfly(input).body.strike: number; default: not declared - ironButterfly(input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - ironButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - ironButterfly(input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - ironButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - ironCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; default: not declared - ironCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - ironCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - ironCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - ironCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - ironCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - ironCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - ironCondor().return.market.dividendYield?: number; default: not declared - ironCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - ironCondor().return.market.riskFreeRate: number; default: not declared - ironCondor().return.market.spot: number; default: not declared - ironCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - ironCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - ironCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - ironCondor().return.multiplier: number; default: not declared - ironCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - ironCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - ironCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - ironCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - ironCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - ironCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - ironCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - ironCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - ironCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - ironCondor(config)?: PositionConfig | undefined; default: not declared - ironCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - ironCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - ironCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - ironCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - ironCondor(input): import('@insiderfinance/totalfinance/strategy').IronCondorInput; default: not declared - ironCondor(input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).expiry?: string; default: not declared - ironCondor(input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).quantity?: number; default: not declared - jadeLizard: (input: import('@insiderfinance/totalfinance/strategy').JadeLizardInput, config?: PositionConfig) => Position; default: not declared - jadeLizard().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - jadeLizard().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - jadeLizard().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - jadeLizard().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - jadeLizard().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - jadeLizard().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - jadeLizard().return.market.dividendYield?: number; default: not declared - jadeLizard().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - jadeLizard().return.market.riskFreeRate: number; default: not declared - jadeLizard().return.market.spot: number; default: not declared - jadeLizard().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - jadeLizard().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - jadeLizard().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - jadeLizard().return.multiplier: number; default: not declared - jadeLizard().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - jadeLizard().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - jadeLizard().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - jadeLizard().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - jadeLizard().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - jadeLizard().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - jadeLizard().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - jadeLizard().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - jadeLizard().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - jadeLizard(config)?: PositionConfig | undefined; default: not declared - jadeLizard(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - jadeLizard(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - jadeLizard(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - jadeLizard(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - jadeLizard(input): import('@insiderfinance/totalfinance/strategy').JadeLizardInput; default: not declared - jadeLizard(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - jadeLizard(input).longCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - jadeLizard(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - jadeLizard(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - jadeLizard(input).shortCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - legs: { readonly call: (input: import('@insiderfinance/totalfinance/strategy').OptionLegInput) => Omit & { premium?: number; }; readonly put: (input: import('@insiderfinance/totalfinance/strategy').OptionLegInput) => Omit & { premium?: number; }; readonly stock: (input: import('@insiderfinance/totalfinance/strategy').StockLegInput) => import('@insiderfinance/totalfinance/strategy').StockLeg; }; default: not declared — Plain leg records for custom strategies. No direction or size is inferred. - legs.call: (input: import('@insiderfinance/totalfinance/strategy').OptionLegInput) => Omit & { premium?: number; }; default: not declared — Build a call leg. Signed quantity is in contracts; premium is per share. - legs.call().return.expiry?: string; default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - legs.call().return.impliedVolatility?: number; default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - legs.call().return.kind: 'call' | 'put'; default: not declared - legs.call().return.premium?: number; default: not declared - legs.call().return.price?: undefined; default: not declared — Never on an option row (a stock row's entry price). - legs.call().return.quantity: number; default: not declared — Signed contracts: positive = long, negative = short. - legs.call().return.strike: number; default: not declared - legs.call(input): import('@insiderfinance/totalfinance/strategy').OptionLegInput; default: not declared - legs.call(input).expiry?: string; default: not declared — Per-leg expiry: a YYYY-MM-DD label (16:00 ET) or zoned ISO datetime. - legs.call(input).impliedVolatility?: number; default: not declared — Positive per-leg implied volatility, as an annualized decimal (0.20 = 20%). - legs.call(input).premium?: number | undefined; default: not declared — Entry premium per share. Omit it (or pass `undefined`) and supply `{ premiums: 'model', market }` on the position config to have it priced from the market. Accepts `undefined` explicitly so builders can forward an optional slot premium without a conditional spread. - legs.call(input).quantity: number; default: not declared — Signed contracts: positive = long, negative = short. Required, finite and nonzero. - legs.call(input).strike: number; default: not declared — Positive strike price per share. - legs.put: (input: import('@insiderfinance/totalfinance/strategy').OptionLegInput) => Omit & { premium?: number; }; default: not declared — Build a put leg. Signed quantity is in contracts; premium is per share. - legs.put().return.expiry?: string; default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - legs.put().return.impliedVolatility?: number; default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - legs.put().return.kind: 'call' | 'put'; default: not declared - legs.put().return.premium?: number; default: not declared - legs.put().return.price?: undefined; default: not declared — Never on an option row (a stock row's entry price). - legs.put().return.quantity: number; default: not declared — Signed contracts: positive = long, negative = short. - legs.put().return.strike: number; default: not declared - legs.put(input): import('@insiderfinance/totalfinance/strategy').OptionLegInput; default: not declared - legs.put(input).expiry?: string; default: not declared — Per-leg expiry: a YYYY-MM-DD label (16:00 ET) or zoned ISO datetime. - legs.put(input).impliedVolatility?: number; default: not declared — Positive per-leg implied volatility, as an annualized decimal (0.20 = 20%). - legs.put(input).premium?: number | undefined; default: not declared — Entry premium per share. Omit it (or pass `undefined`) and supply `{ premiums: 'model', market }` on the position config to have it priced from the market. Accepts `undefined` explicitly so builders can forward an optional slot premium without a conditional spread. - legs.put(input).quantity: number; default: not declared — Signed contracts: positive = long, negative = short. Required, finite and nonzero. - legs.put(input).strike: number; default: not declared — Positive strike price per share. - legs.stock: (input: import('@insiderfinance/totalfinance/strategy').StockLegInput) => import('@insiderfinance/totalfinance/strategy').StockLeg; default: not declared — Build a stock leg. Signed quantity is in shares; price is the entry price per share. - legs.stock().return.expiry?: undefined; default: not declared - legs.stock().return.impliedVolatility?: undefined; default: not declared - legs.stock().return.kind: 'stock'; default: not declared - legs.stock().return.premium?: undefined; default: not declared - legs.stock().return.price: number; default: not declared — Entry price per share. - legs.stock().return.quantity: number; default: not declared — Signed shares: positive = long, negative = short. - legs.stock().return.strike?: undefined; default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). - legs.stock(input): import('@insiderfinance/totalfinance/strategy').StockLegInput; default: not declared - legs.stock(input).price: number; default: not declared — Entry price per share. - legs.stock(input).quantity: number; default: not declared — Signed shares: positive = long, negative = short. Not scaled by the option multiplier. - listStrategies: () => manifest.StrategyDescriptor[]; default: not declared — Every named builder: name, description, multi-expiry flag, and a canonical example input. - longCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - longCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCall().return.market.dividendYield?: number; default: not declared - longCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCall().return.market.riskFreeRate: number; default: not declared - longCall().return.market.spot: number; default: not declared - longCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCall().return.multiplier: number; default: not declared - longCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCall(config)?: PositionConfig | undefined; default: not declared - longCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCall(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - longCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCall(input).premium?: number; default: not declared - longCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCall(input).strike: number; default: not declared - longCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - longCallButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCallButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCallButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCallButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCallButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCallButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCallButterfly().return.market.dividendYield?: number; default: not declared - longCallButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCallButterfly().return.market.riskFreeRate: number; default: not declared - longCallButterfly().return.market.spot: number; default: not declared - longCallButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCallButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCallButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCallButterfly().return.multiplier: number; default: not declared - longCallButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCallButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCallButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCallButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCallButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCallButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCallButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCallButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCallButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCallButterfly(config)?: PositionConfig | undefined; default: not declared - longCallButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCallButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCallButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCallButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCallButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - longCallButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCallButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCallButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - longCallCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCallCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCallCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCallCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCallCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCallCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCallCondor().return.market.dividendYield?: number; default: not declared - longCallCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCallCondor().return.market.riskFreeRate: number; default: not declared - longCallCondor().return.market.spot: number; default: not declared - longCallCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCallCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCallCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCallCondor().return.multiplier: number; default: not declared - longCallCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCallCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCallCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCallCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCallCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCallCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCallCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCallCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCallCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCallCondor(config)?: PositionConfig | undefined; default: not declared - longCallCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCallCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCallCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCallCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCallCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - longCallCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCallCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - longCombo().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCombo().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCombo().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCombo().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCombo().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCombo().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCombo().return.market.dividendYield?: number; default: not declared - longCombo().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCombo().return.market.riskFreeRate: number; default: not declared - longCombo().return.market.spot: number; default: not declared - longCombo().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCombo().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCombo().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCombo().return.multiplier: number; default: not declared - longCombo().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCombo().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCombo().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCombo().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCombo().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCombo().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCombo().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCombo().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCombo().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCombo(config)?: PositionConfig | undefined; default: not declared - longCombo(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCombo(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCombo(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCombo(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCombo(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - longCombo(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCombo(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCombo(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCombo(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - longPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longPut().return.market.dividendYield?: number; default: not declared - longPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longPut().return.market.riskFreeRate: number; default: not declared - longPut().return.market.spot: number; default: not declared - longPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longPut().return.multiplier: number; default: not declared - longPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longPut(config)?: PositionConfig | undefined; default: not declared - longPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - longPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPut(input).premium?: number; default: not declared - longPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longPut(input).strike: number; default: not declared - longPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - longPutButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longPutButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longPutButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longPutButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longPutButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longPutButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longPutButterfly().return.market.dividendYield?: number; default: not declared - longPutButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longPutButterfly().return.market.riskFreeRate: number; default: not declared - longPutButterfly().return.market.spot: number; default: not declared - longPutButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longPutButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longPutButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longPutButterfly().return.multiplier: number; default: not declared - longPutButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longPutButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longPutButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longPutButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longPutButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longPutButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longPutButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longPutButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longPutButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longPutButterfly(config)?: PositionConfig | undefined; default: not declared - longPutButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longPutButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longPutButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longPutButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longPutButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - longPutButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPutButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longPutButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - longPutCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longPutCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longPutCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longPutCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longPutCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longPutCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longPutCondor().return.market.dividendYield?: number; default: not declared - longPutCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longPutCondor().return.market.riskFreeRate: number; default: not declared - longPutCondor().return.market.spot: number; default: not declared - longPutCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longPutCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longPutCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longPutCondor().return.multiplier: number; default: not declared - longPutCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longPutCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longPutCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longPutCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longPutCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longPutCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longPutCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longPutCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longPutCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longPutCondor(config)?: PositionConfig | undefined; default: not declared - longPutCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longPutCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longPutCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longPutCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longPutCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - longPutCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPutCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - longSyntheticFuture().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longSyntheticFuture().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longSyntheticFuture().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longSyntheticFuture().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longSyntheticFuture().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longSyntheticFuture().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longSyntheticFuture().return.market.dividendYield?: number; default: not declared - longSyntheticFuture().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longSyntheticFuture().return.market.riskFreeRate: number; default: not declared - longSyntheticFuture().return.market.spot: number; default: not declared - longSyntheticFuture().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longSyntheticFuture().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longSyntheticFuture().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longSyntheticFuture().return.multiplier: number; default: not declared - longSyntheticFuture().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longSyntheticFuture().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longSyntheticFuture().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longSyntheticFuture().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longSyntheticFuture().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longSyntheticFuture().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longSyntheticFuture().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longSyntheticFuture().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longSyntheticFuture().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longSyntheticFuture(config)?: PositionConfig | undefined; default: not declared - longSyntheticFuture(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longSyntheticFuture(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longSyntheticFuture(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longSyntheticFuture(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longSyntheticFuture(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - longSyntheticFuture(input).callPremium?: number; default: not declared - longSyntheticFuture(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longSyntheticFuture(input).putPremium?: number; default: not declared - longSyntheticFuture(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longSyntheticFuture(input).strike: number; default: not declared - optimizeStrategy: (options: import('@insiderfinance/totalfinance/strategy').OptimizeStrategyOptions) => import('@insiderfinance/totalfinance/strategy').OptimizeStrategyResult; default: not declared — Search structures × strikes × expiries for the best trade under a thesis. Reuses `scanStrategies` per expiry, re-scores each candidate under the thesis density, and ranks across all expiries. See the spec. - optimizeStrategy().return.assumptions: { conventionsVersion: string; objective: import('@insiderfinance/totalfinance/strategy').OptimizerObjective; expiries: number; gridPoints: number; }; default: not declared - optimizeStrategy().return.assumptions.conventionsVersion: string; default: not declared - optimizeStrategy().return.assumptions.expiries: number; default: not declared - optimizeStrategy().return.assumptions.gridPoints: number; default: not declared - optimizeStrategy().return.assumptions.objective: import('@insiderfinance/totalfinance/strategy').OptimizerObjective; default: not declared - optimizeStrategy().return.candidates: import('@insiderfinance/totalfinance/strategy').OptimizedStrategy[]; default: not declared — Top-N candidates across all expiries, ranked by `objective` (descending). - optimizeStrategy().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - optimizeStrategy().return.thesis: { median: 'target' | 'drift'; volatility: number; targetPrice?: number; drift?: number; }; default: not declared - optimizeStrategy().return.thesis.drift?: number; default: not declared - optimizeStrategy().return.thesis.median: 'drift' | 'target'; default: not declared - optimizeStrategy().return.thesis.targetPrice?: number; default: not declared - optimizeStrategy().return.thesis.volatility: number; default: not declared - optimizeStrategy(options): import('@insiderfinance/totalfinance/strategy').OptimizeStrategyOptions; default: not declared - optimizeStrategy(options).asOf: string | number; default: not declared — Valuation instant — epoch milliseconds or a zoned ISO datetime, the ONE valuation-instant grammar shared with `scanStrategies`, `Position.probability()` and the what-if cube. A bare date is refused everywhere a position is priced: the time of day is the answer for a 0DTE. - optimizeStrategy(options).dividendYield?: number; default: not declared - optimizeStrategy(options).expiries: import('@insiderfinance/totalfinance/strategy').OptimizerExpiry[]; default: not declared — The multi-expiry search space (≥ 1 expiry). - optimizeStrategy(options).gridPoints?: number; default: not declared — Integration resolution for the thesis metrics (default 801). - optimizeStrategy(options).maxRisk?: number; default: not declared — Keep only candidates whose max loss ≤ this (per contract, 100×). - optimizeStrategy(options).maxWidth?: number; default: not declared - optimizeStrategy(options).minProbabilityOfProfit?: number; default: not declared — Keep only candidates whose MARKET-implied PoP ≥ this. - optimizeStrategy(options).minThesisProbabilityOfProfit?: number; default: not declared — Keep only candidates whose THESIS PoP ≥ this. - optimizeStrategy(options).objective?: import('@insiderfinance/totalfinance/strategy').OptimizerObjective; default: not declared — Ranking objective (default `'thesisExpectedValuePerRisk'`). - optimizeStrategy(options).riskFreeRate: number; default: not declared - optimizeStrategy(options).sizing?: import('@insiderfinance/totalfinance/strategy').OptimizerSizingOptions; default: not declared — Opt-in Kelly sizing. When set, each candidate gains a `kelly` verdict; omit for no Kelly work. - optimizeStrategy(options).smile?: (strike: number) => number; default: not declared — Default pricing smile (takes precedence over `volatility` for pricing). - optimizeStrategy(options).spot: number; default: not declared - optimizeStrategy(options).structures?: import('@insiderfinance/totalfinance/strategy').ScanStructure[]; default: not declared — Which structures to enumerate (default: all the scanner's). - optimizeStrategy(options).thesis: import('@insiderfinance/totalfinance/strategy').OptimizerThesis; default: not declared - optimizeStrategy(options).top?: number; default: not declared — Top-N across all expiries (default 25). - optimizeStrategy(options).volatility?: number; default: not declared — Default pricing volatility for missing premiums + the scanner's market-implied metrics. - payoffSvg: (position: Position, options?: import('@insiderfinance/totalfinance/strategy').PayoffSvgOptions) => string; default: not declared — Render a {@link Position}'s payoff diagram as a self-contained `` string. See the spec. - payoffSvg(options)?: import('@insiderfinance/totalfinance/strategy').PayoffSvgOptions; default: not declared - payoffSvg(options).height?: number; default: not declared — Height in px (default 360). - payoffSvg(options).includeCurrentPnl?: boolean; default: not declared — Also draw the CURRENT (pre-expiry) P&L curve (dashed); needs a market (or the position's own). - payoffSvg(options).market?: Partial>; default: not declared - payoffSvg(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - payoffSvg(options).market.dividendYield?: number; default: not declared - payoffSvg(options).market.expiry?: string; default: not declared - payoffSvg(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - payoffSvg(options).market.riskFreeRate?: number; default: not declared - payoffSvg(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - payoffSvg(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - payoffSvg(options).prices?: import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared — X-axis price range. Omit for an auto-range around the strikes + breakevens. - payoffSvg(options).spot?: number; default: not declared — Draw a marker at the current spot. - payoffSvg(options).theme?: 'light' | 'dark'; default: not declared — Color theme (default 'light'). - payoffSvg(options).title?: string; default: not declared — Chart title (XML-escaped). - payoffSvg(options).width?: number; default: not declared — Width in px (default 640). - payoffSvg(position): Position; default: not declared - payoffSvg(position).assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - payoffSvg(position).chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - payoffSvg(position).constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - payoffSvg(position).legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - payoffSvg(position).market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - payoffSvg(position).market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - payoffSvg(position).market.dividendYield?: number; default: not declared - payoffSvg(position).market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - payoffSvg(position).market.riskFreeRate: number; default: not declared - payoffSvg(position).market.spot: number; default: not declared - payoffSvg(position).market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - payoffSvg(position).metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - payoffSvg(position).monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - payoffSvg(position).multiplier: number; default: not declared - payoffSvg(position).netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - payoffSvg(position).payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - payoffSvg(position).pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - payoffSvg(position).premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - payoffSvg(position).premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - payoffSvg(position).probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - payoffSvg(position).scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - payoffSvg(position).value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - payoffSvg(position).whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - protectivePut: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; default: not declared - protectivePut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - protectivePut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - protectivePut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - protectivePut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - protectivePut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - protectivePut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - protectivePut().return.market.dividendYield?: number; default: not declared - protectivePut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - protectivePut().return.market.riskFreeRate: number; default: not declared - protectivePut().return.market.spot: number; default: not declared - protectivePut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - protectivePut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - protectivePut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - protectivePut().return.multiplier: number; default: not declared - protectivePut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - protectivePut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - protectivePut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - protectivePut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - protectivePut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - protectivePut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - protectivePut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - protectivePut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - protectivePut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - protectivePut(config)?: PositionConfig | undefined; default: not declared - protectivePut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - protectivePut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - protectivePut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - protectivePut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - protectivePut(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg; default: not declared - protectivePut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - protectivePut(input).premium?: number; default: not declared - protectivePut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - protectivePut(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - protectivePut(input).strike: number; default: not declared - putBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - putBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - putBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - putBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - putBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - putBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - putBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - putBrokenWing().return.market.dividendYield?: number; default: not declared - putBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - putBrokenWing().return.market.riskFreeRate: number; default: not declared - putBrokenWing().return.market.spot: number; default: not declared - putBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - putBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - putBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - putBrokenWing().return.multiplier: number; default: not declared - putBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - putBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - putBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - putBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - putBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - putBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - putBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - putBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - putBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - putBrokenWing(config)?: PositionConfig | undefined; default: not declared - putBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - putBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - putBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - putBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - putBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - putBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - putBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - putRatioBackspread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - putRatioBackspread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - putRatioBackspread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - putRatioBackspread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - putRatioBackspread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - putRatioBackspread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - putRatioBackspread().return.market.dividendYield?: number; default: not declared - putRatioBackspread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - putRatioBackspread().return.market.riskFreeRate: number; default: not declared - putRatioBackspread().return.market.spot: number; default: not declared - putRatioBackspread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - putRatioBackspread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - putRatioBackspread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - putRatioBackspread().return.multiplier: number; default: not declared - putRatioBackspread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - putRatioBackspread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - putRatioBackspread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - putRatioBackspread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - putRatioBackspread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - putRatioBackspread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - putRatioBackspread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - putRatioBackspread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - putRatioBackspread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - putRatioBackspread(config)?: PositionConfig | undefined; default: not declared - putRatioBackspread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - putRatioBackspread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - putRatioBackspread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - putRatioBackspread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - putRatioBackspread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - putRatioBackspread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putRatioBackspread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioBackspread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - putRatioBackspread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - putRatioBackspread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - putRatioSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - putRatioSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - putRatioSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - putRatioSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - putRatioSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - putRatioSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - putRatioSpread().return.market.dividendYield?: number; default: not declared - putRatioSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - putRatioSpread().return.market.riskFreeRate: number; default: not declared - putRatioSpread().return.market.spot: number; default: not declared - putRatioSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - putRatioSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - putRatioSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - putRatioSpread().return.multiplier: number; default: not declared - putRatioSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - putRatioSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - putRatioSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - putRatioSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - putRatioSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - putRatioSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - putRatioSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - putRatioSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - putRatioSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - putRatioSpread(config)?: PositionConfig | undefined; default: not declared - putRatioSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - putRatioSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - putRatioSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - putRatioSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - putRatioSpread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - putRatioSpread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putRatioSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - putRatioSpread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - putRatioSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - reverseJadeLizard: (input: import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput, config?: PositionConfig) => Position; default: not declared - reverseJadeLizard().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - reverseJadeLizard().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - reverseJadeLizard().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - reverseJadeLizard().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - reverseJadeLizard().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - reverseJadeLizard().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - reverseJadeLizard().return.market.dividendYield?: number; default: not declared - reverseJadeLizard().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - reverseJadeLizard().return.market.riskFreeRate: number; default: not declared - reverseJadeLizard().return.market.spot: number; default: not declared - reverseJadeLizard().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - reverseJadeLizard().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - reverseJadeLizard().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - reverseJadeLizard().return.multiplier: number; default: not declared - reverseJadeLizard().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - reverseJadeLizard().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - reverseJadeLizard().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - reverseJadeLizard().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - reverseJadeLizard().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - reverseJadeLizard().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - reverseJadeLizard().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - reverseJadeLizard().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - reverseJadeLizard().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - reverseJadeLizard(config)?: PositionConfig | undefined; default: not declared - reverseJadeLizard(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - reverseJadeLizard(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - reverseJadeLizard(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - reverseJadeLizard(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - reverseJadeLizard(input): import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput; default: not declared - reverseJadeLizard(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - reverseJadeLizard(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - reverseJadeLizard(input).longPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - reverseJadeLizard(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - reverseJadeLizard(input).shortPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - scanStrategies: (options: import('@insiderfinance/totalfinance/strategy').ScanOptions) => import('@insiderfinance/totalfinance/strategy/scanner').ScanResult; default: not declared — Enumerate, score, and rank option structures over a strike grid. `candidates` carries the top-N by the chosen objective, each with the full payoff/probability metrics. - scanStrategies().return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; rankBy: import('@insiderfinance/totalfinance/strategy').ScanObjective; structures: import('@insiderfinance/totalfinance/strategy').ScanStructure[]; timeToExpiryYears: number; scoringVolatility: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - scanStrategies().return.assumptions.conventionsVersion: string; default: not declared - scanStrategies().return.assumptions.dayCount: 'ACT/365F'; default: not declared - scanStrategies().return.assumptions.rankBy: 'probabilityOfProfit' | 'expectedValue' | 'returnOnRisk' | 'expectedValuePerRisk'; default: not declared — The ranking objective that produced the order (and each candidate's `score`). - scanStrategies().return.assumptions.scoringVolatility: number; default: not declared — The single at-spot volatility that `probabilityOfProfit`/`expectedValue` are scored at (see the `smile` doc). - scanStrategies().return.assumptions.structures: import('@insiderfinance/totalfinance/strategy').ScanStructure[]; default: not declared — The structures that were enumerated. - scanStrategies().return.assumptions.timeToExpiryYears: number; default: not declared — Year fraction to the scanned expiry. - scanStrategies().return.candidates: import('@insiderfinance/totalfinance/strategy').ScanCandidate[]; default: not declared — The top-N candidates by the ranking objective, descending, each fully metric'd. - scanStrategies().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings; always present (possibly empty). - scanStrategies(options): import('@insiderfinance/totalfinance/strategy').ScanOptions; default: not declared - scanStrategies(options).asOf: string | number; default: not declared — Valuation instant. Epoch ms or a zoned ISO datetime, resolved at the boundary by core's `resolveValuationAsOf` — the ONE valuation-instant grammar shared by `Position.probability()`, the what-if cube and every other pricing boundary. A bare date is refused: a 0DTE's value depends on the time of day. - scanStrategies(options).chain: import('@insiderfinance/totalfinance/strategy').ScanQuoteRow[]; default: not declared — The option chain — one row per strike, ascending or not (sorted internally). - scanStrategies(options).dividendYield?: number; default: not declared - scanStrategies(options).expiry: string; default: not declared — Option expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). - scanStrategies(options).maxRisk?: number; default: not declared — Keep only candidates whose max loss ≤ this (in the position's P&L units — per contract, 100×). - scanStrategies(options).maxWidth?: number; default: not declared — Cap on the width (strike distance) of any single wing/spread, in price units. - scanStrategies(options).minProbabilityOfProfit?: number; default: not declared — Keep only candidates with probability-of-profit ≥ this. - scanStrategies(options).rankBy?: 'probabilityOfProfit' | 'expectedValue' | 'returnOnRisk' | 'expectedValuePerRisk'; default: not declared — Ranking objective (default `expectedValuePerRisk`). - scanStrategies(options).riskFreeRate: number; default: not declared - scanStrategies(options).smile?: (strike: number) => number; default: not declared — Per-strike implied-volatility smile. Used to price any missing per-strike premiums (takes precedence over `volatility`). **Scoring uses a SINGLE volatility:** `probabilityOfProfit` and `expectedValue` are computed closed-form at the at-spot volatility `smile(spot)` (or `volatility`), not the full smile — for smile-consistent probabilities, price a specific structure with `Position.monteCarloProbability({ localVolatility })`. - scanStrategies(options).spot: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - scanStrategies(options).structures?: import('@insiderfinance/totalfinance/strategy').ScanStructure[]; default: not declared — Which structures to enumerate (default: all). - scanStrategies(options).top?: number; default: not declared — Return only the top-N ranked candidates (default 25). - scanStrategies(options).volatility?: number; default: not declared — Constant annualized volatility used for probabilityOfProfit / expectedValue scoring and to price any missing premiums. - shortCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - shortCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCall().return.market.dividendYield?: number; default: not declared - shortCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCall().return.market.riskFreeRate: number; default: not declared - shortCall().return.market.spot: number; default: not declared - shortCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCall().return.multiplier: number; default: not declared - shortCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCall(config)?: PositionConfig | undefined; default: not declared - shortCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCall(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - shortCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCall(input).premium?: number; default: not declared - shortCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCall(input).strike: number; default: not declared - shortCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - shortCallButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCallButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCallButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCallButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCallButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCallButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCallButterfly().return.market.dividendYield?: number; default: not declared - shortCallButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCallButterfly().return.market.riskFreeRate: number; default: not declared - shortCallButterfly().return.market.spot: number; default: not declared - shortCallButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCallButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCallButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCallButterfly().return.multiplier: number; default: not declared - shortCallButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCallButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCallButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCallButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCallButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCallButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCallButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCallButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCallButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCallButterfly(config)?: PositionConfig | undefined; default: not declared - shortCallButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCallButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCallButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCallButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCallButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - shortCallButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCallButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCallButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - shortCallCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCallCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCallCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCallCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCallCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCallCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCallCondor().return.market.dividendYield?: number; default: not declared - shortCallCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCallCondor().return.market.riskFreeRate: number; default: not declared - shortCallCondor().return.market.spot: number; default: not declared - shortCallCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCallCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCallCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCallCondor().return.multiplier: number; default: not declared - shortCallCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCallCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCallCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCallCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCallCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCallCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCallCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCallCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCallCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCallCondor(config)?: PositionConfig | undefined; default: not declared - shortCallCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCallCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCallCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCallCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCallCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - shortCallCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCallCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - shortCombo().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCombo().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCombo().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCombo().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCombo().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCombo().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCombo().return.market.dividendYield?: number; default: not declared - shortCombo().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCombo().return.market.riskFreeRate: number; default: not declared - shortCombo().return.market.spot: number; default: not declared - shortCombo().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCombo().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCombo().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCombo().return.multiplier: number; default: not declared - shortCombo().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCombo().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCombo().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCombo().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCombo().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCombo().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCombo().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCombo().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCombo().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCombo(config)?: PositionConfig | undefined; default: not declared - shortCombo(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCombo(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCombo(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCombo(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCombo(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - shortCombo(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCombo(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCombo(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCombo(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortGuts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - shortGuts().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortGuts().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortGuts().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortGuts().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortGuts().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortGuts().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortGuts().return.market.dividendYield?: number; default: not declared - shortGuts().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortGuts().return.market.riskFreeRate: number; default: not declared - shortGuts().return.market.spot: number; default: not declared - shortGuts().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortGuts().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortGuts().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortGuts().return.multiplier: number; default: not declared - shortGuts().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortGuts().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortGuts().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortGuts().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortGuts().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortGuts().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortGuts().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortGuts().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortGuts().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortGuts(config)?: PositionConfig | undefined; default: not declared - shortGuts(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortGuts(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortGuts(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortGuts(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortGuts(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - shortGuts(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortGuts(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortGuts(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortGuts(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - shortPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortPut().return.market.dividendYield?: number; default: not declared - shortPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortPut().return.market.riskFreeRate: number; default: not declared - shortPut().return.market.spot: number; default: not declared - shortPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortPut().return.multiplier: number; default: not declared - shortPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortPut(config)?: PositionConfig | undefined; default: not declared - shortPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - shortPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortPut(input).premium?: number; default: not declared - shortPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPut(input).strike: number; default: not declared - shortPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - shortPutButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortPutButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortPutButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortPutButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortPutButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortPutButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortPutButterfly().return.market.dividendYield?: number; default: not declared - shortPutButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortPutButterfly().return.market.riskFreeRate: number; default: not declared - shortPutButterfly().return.market.spot: number; default: not declared - shortPutButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortPutButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortPutButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortPutButterfly().return.multiplier: number; default: not declared - shortPutButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortPutButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortPutButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortPutButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortPutButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortPutButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortPutButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortPutButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortPutButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortPutButterfly(config)?: PositionConfig | undefined; default: not declared - shortPutButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortPutButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortPutButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortPutButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortPutButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - shortPutButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortPutButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPutButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - shortPutCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortPutCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortPutCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortPutCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortPutCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortPutCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortPutCondor().return.market.dividendYield?: number; default: not declared - shortPutCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortPutCondor().return.market.riskFreeRate: number; default: not declared - shortPutCondor().return.market.spot: number; default: not declared - shortPutCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortPutCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortPutCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortPutCondor().return.multiplier: number; default: not declared - shortPutCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortPutCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortPutCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortPutCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortPutCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortPutCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortPutCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortPutCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortPutCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortPutCondor(config)?: PositionConfig | undefined; default: not declared - shortPutCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortPutCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortPutCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortPutCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortPutCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - shortPutCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortPutCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortStraddle: (input: import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; default: not declared - shortStraddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortStraddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortStraddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortStraddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortStraddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortStraddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortStraddle().return.market.dividendYield?: number; default: not declared - shortStraddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortStraddle().return.market.riskFreeRate: number; default: not declared - shortStraddle().return.market.spot: number; default: not declared - shortStraddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortStraddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortStraddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortStraddle().return.multiplier: number; default: not declared - shortStraddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortStraddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortStraddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortStraddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortStraddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortStraddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortStraddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortStraddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortStraddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortStraddle(config)?: PositionConfig | undefined; default: not declared - shortStraddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortStraddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortStraddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortStraddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortStraddle(input): import('@insiderfinance/totalfinance/strategy').ShortStraddleInput; default: not declared - shortStraddle(input).callPremium?: number; default: not declared - shortStraddle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortStraddle(input).putPremium?: number; default: not declared - shortStraddle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortStraddle(input).strike: number; default: not declared - shortStrangle: (input: import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; default: not declared - shortStrangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortStrangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortStrangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortStrangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortStrangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortStrangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortStrangle().return.market.dividendYield?: number; default: not declared - shortStrangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortStrangle().return.market.riskFreeRate: number; default: not declared - shortStrangle().return.market.spot: number; default: not declared - shortStrangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortStrangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortStrangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortStrangle().return.multiplier: number; default: not declared - shortStrangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortStrangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortStrangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortStrangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortStrangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortStrangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortStrangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortStrangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortStrangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortStrangle(config)?: PositionConfig | undefined; default: not declared - shortStrangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortStrangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortStrangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortStrangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortStrangle(input): import('@insiderfinance/totalfinance/strategy').ShortStrangleInput; default: not declared - shortStrangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - shortStrangle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortStrangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - shortStrangle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - shortSyntheticFuture().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortSyntheticFuture().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortSyntheticFuture().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortSyntheticFuture().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortSyntheticFuture().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortSyntheticFuture().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortSyntheticFuture().return.market.dividendYield?: number; default: not declared - shortSyntheticFuture().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortSyntheticFuture().return.market.riskFreeRate: number; default: not declared - shortSyntheticFuture().return.market.spot: number; default: not declared - shortSyntheticFuture().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortSyntheticFuture().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortSyntheticFuture().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortSyntheticFuture().return.multiplier: number; default: not declared - shortSyntheticFuture().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortSyntheticFuture().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortSyntheticFuture().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortSyntheticFuture().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortSyntheticFuture().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortSyntheticFuture().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortSyntheticFuture().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortSyntheticFuture().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortSyntheticFuture().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortSyntheticFuture(config)?: PositionConfig | undefined; default: not declared - shortSyntheticFuture(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortSyntheticFuture(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortSyntheticFuture(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortSyntheticFuture(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortSyntheticFuture(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - shortSyntheticFuture(input).callPremium?: number; default: not declared - shortSyntheticFuture(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortSyntheticFuture(input).putPremium?: number; default: not declared - shortSyntheticFuture(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortSyntheticFuture(input).strike: number; default: not declared - straddle: (input: import('@insiderfinance/totalfinance/strategy').StraddleInput, config?: PositionConfig) => Position; default: not declared - straddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - straddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - straddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - straddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - straddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - straddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - straddle().return.market.dividendYield?: number; default: not declared - straddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - straddle().return.market.riskFreeRate: number; default: not declared - straddle().return.market.spot: number; default: not declared - straddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - straddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - straddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - straddle().return.multiplier: number; default: not declared - straddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - straddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - straddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - straddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - straddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - straddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - straddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - straddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - straddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - straddle(config)?: PositionConfig | undefined; default: not declared - straddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - straddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - straddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - straddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - straddle(input): import('@insiderfinance/totalfinance/strategy').StraddleInput; default: not declared - straddle(input).callPremium?: number; default: not declared - straddle(input).expiry?: string; default: not declared - straddle(input).putPremium?: number; default: not declared - straddle(input).quantity?: number; default: not declared - straddle(input).strike: number; default: not declared — The shared strike (shared-strike rule: premiums are named per option type). - strangle: (input: import('@insiderfinance/totalfinance/strategy').StrangleInput, config?: PositionConfig) => Position; default: not declared - strangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strangle().return.market.dividendYield?: number; default: not declared - strangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strangle().return.market.riskFreeRate: number; default: not declared - strangle().return.market.spot: number; default: not declared - strangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strangle().return.multiplier: number; default: not declared - strangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strangle(config)?: PositionConfig | undefined; default: not declared - strangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strangle(input): import('@insiderfinance/totalfinance/strategy').StrangleInput; default: not declared - strangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The call leg: a strike, or `{ strike, premium? }`. - strangle(input).expiry?: string; default: not declared - strangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The put leg: a strike, or `{ strike, premium? }`. - strangle(input).quantity?: number; default: not declared - strap: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strap().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strap().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strap().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strap().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strap().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strap().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strap().return.market.dividendYield?: number; default: not declared - strap().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strap().return.market.riskFreeRate: number; default: not declared - strap().return.market.spot: number; default: not declared - strap().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strap().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strap().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strap().return.multiplier: number; default: not declared - strap().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strap().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strap().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strap().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strap().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strap().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strap().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strap().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strap().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strap(config)?: PositionConfig | undefined; default: not declared - strap(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strap(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strap(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strap(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strap(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strap(input).callPremium?: number; default: not declared - strap(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strap(input).putPremium?: number; default: not declared - strap(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strap(input).strike: number; default: not declared - strategy: ((positionLegs: readonly LegInput[], config?: PositionConfig) => Position) & { listStrategies(): manifest.StrategyDescriptor[]; buildStrategy(request: manifest.BuildStrategyInput): Position; longCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; shortCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; longPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; shortPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; cashSecuredPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; bullCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bearCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bullPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bearPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; straddle: (input: import('@insiderfinance/totalfinance/strategy').StraddleInput, config?: PositionConfig) => Position; strangle: (input: import('@insiderfinance/totalfinance/strategy').StrangleInput, config?: PositionConfig) => Position; shortStraddle: (input: import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; shortStrangle: (input: import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; strip: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; strap: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; guts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; shortGuts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; longCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; shortCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; longSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; shortSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; syntheticPut: (input: import('@insiderfinance/totalfinance/strategy').SyntheticPutInput, config?: PositionConfig) => Position; bullCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bearCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bullPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bearPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; callBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; putBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; inverseCallBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; inversePutBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; jadeLizard: (input: import('@insiderfinance/totalfinance/strategy').JadeLizardInput, config?: PositionConfig) => Position; reverseJadeLizard: (input: import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput, config?: PositionConfig) => Position; callRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; putRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; callRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; putRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; longCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; longPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; shortCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; shortPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; longCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; longPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; shortCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; shortPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; ironCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; inverseIronCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; ironButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; inverseIronButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; coveredCall: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; protectivePut: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; collar: (input: import('@insiderfinance/totalfinance/strategy').CollarInput, config?: PositionConfig) => Position; coveredShortStraddle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; coveredShortStrangle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; calendarCallSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; calendarPutSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; diagonalCallSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; diagonalPutSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; doubleDiagonal: (input: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput, config?: PositionConfig) => Position; }; default: not declared - strategy().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy().return.market.dividendYield?: number; default: not declared - strategy().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy().return.market.riskFreeRate: number; default: not declared - strategy().return.market.spot: number; default: not declared - strategy().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy().return.multiplier: number; default: not declared - strategy().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy(config)?: PositionConfig | undefined; default: not declared - strategy(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy(positionLegs): readonly LegInput[]; default: not declared - strategy.bearCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.bearCallLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bearCallLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bearCallLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bearCallLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bearCallLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bearCallLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bearCallLadder().return.market.dividendYield?: number; default: not declared - strategy.bearCallLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bearCallLadder().return.market.riskFreeRate: number; default: not declared - strategy.bearCallLadder().return.market.spot: number; default: not declared - strategy.bearCallLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bearCallLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bearCallLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bearCallLadder().return.multiplier: number; default: not declared - strategy.bearCallLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bearCallLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bearCallLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bearCallLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bearCallLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bearCallLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bearCallLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bearCallLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bearCallLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bearCallLadder(config)?: PositionConfig | undefined; default: not declared - strategy.bearCallLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bearCallLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bearCallLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bearCallLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bearCallLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.bearCallLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.bearCallLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bearCallLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bearCallLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.bearCallLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bearCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - strategy.bearCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bearCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bearCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bearCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bearCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bearCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bearCallSpread().return.market.dividendYield?: number; default: not declared - strategy.bearCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bearCallSpread().return.market.riskFreeRate: number; default: not declared - strategy.bearCallSpread().return.market.spot: number; default: not declared - strategy.bearCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bearCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bearCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bearCallSpread().return.multiplier: number; default: not declared - strategy.bearCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bearCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bearCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bearCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bearCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bearCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bearCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bearCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bearCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bearCallSpread(config)?: PositionConfig | undefined; default: not declared - strategy.bearCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bearCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bearCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bearCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bearCallSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - strategy.bearCallSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - strategy.bearCallSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - strategy.bearCallSpread(input).quantity?: number; default: not declared - strategy.bearCallSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - strategy.bearPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.bearPutLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bearPutLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bearPutLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bearPutLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bearPutLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bearPutLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bearPutLadder().return.market.dividendYield?: number; default: not declared - strategy.bearPutLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bearPutLadder().return.market.riskFreeRate: number; default: not declared - strategy.bearPutLadder().return.market.spot: number; default: not declared - strategy.bearPutLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bearPutLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bearPutLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bearPutLadder().return.multiplier: number; default: not declared - strategy.bearPutLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bearPutLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bearPutLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bearPutLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bearPutLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bearPutLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bearPutLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bearPutLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bearPutLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bearPutLadder(config)?: PositionConfig | undefined; default: not declared - strategy.bearPutLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bearPutLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bearPutLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bearPutLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bearPutLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.bearPutLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.bearPutLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bearPutLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bearPutLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.bearPutLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bearPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - strategy.bearPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bearPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bearPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bearPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bearPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bearPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bearPutSpread().return.market.dividendYield?: number; default: not declared - strategy.bearPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bearPutSpread().return.market.riskFreeRate: number; default: not declared - strategy.bearPutSpread().return.market.spot: number; default: not declared - strategy.bearPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bearPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bearPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bearPutSpread().return.multiplier: number; default: not declared - strategy.bearPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bearPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bearPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bearPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bearPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bearPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bearPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bearPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bearPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bearPutSpread(config)?: PositionConfig | undefined; default: not declared - strategy.bearPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bearPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bearPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bearPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bearPutSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - strategy.bearPutSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - strategy.bearPutSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - strategy.bearPutSpread(input).quantity?: number; default: not declared - strategy.bearPutSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - strategy.buildStrategy: (request: manifest.BuildStrategyInput) => Position; default: not declared - strategy.buildStrategy().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.buildStrategy().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.buildStrategy().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.buildStrategy().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.buildStrategy().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.buildStrategy().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.buildStrategy().return.market.dividendYield?: number; default: not declared - strategy.buildStrategy().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.buildStrategy().return.market.riskFreeRate: number; default: not declared - strategy.buildStrategy().return.market.spot: number; default: not declared - strategy.buildStrategy().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.buildStrategy().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.buildStrategy().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.buildStrategy().return.multiplier: number; default: not declared - strategy.buildStrategy().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.buildStrategy().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.buildStrategy().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.buildStrategy().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.buildStrategy().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.buildStrategy().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.buildStrategy().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.buildStrategy().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.buildStrategy().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.buildStrategy(request): manifest.BuildStrategyInput; default: not declared - strategy.buildStrategy(request).config?: PositionConfig; default: not declared — Optional position construction and model-premium configuration. - strategy.buildStrategy(request).input: Record; default: not declared — Builder-specific strategy fields; inspect the matching descriptor's `exampleInput`. - strategy.buildStrategy(request).name: string; default: not declared — The exact strategy name returned by {@link listStrategies}. - strategy.bullCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.bullCallLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bullCallLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bullCallLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bullCallLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bullCallLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bullCallLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bullCallLadder().return.market.dividendYield?: number; default: not declared - strategy.bullCallLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bullCallLadder().return.market.riskFreeRate: number; default: not declared - strategy.bullCallLadder().return.market.spot: number; default: not declared - strategy.bullCallLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bullCallLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bullCallLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bullCallLadder().return.multiplier: number; default: not declared - strategy.bullCallLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bullCallLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bullCallLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bullCallLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bullCallLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bullCallLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bullCallLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bullCallLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bullCallLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bullCallLadder(config)?: PositionConfig | undefined; default: not declared - strategy.bullCallLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bullCallLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bullCallLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bullCallLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bullCallLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.bullCallLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.bullCallLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bullCallLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bullCallLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.bullCallLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bullCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - strategy.bullCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bullCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bullCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bullCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bullCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bullCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bullCallSpread().return.market.dividendYield?: number; default: not declared - strategy.bullCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bullCallSpread().return.market.riskFreeRate: number; default: not declared - strategy.bullCallSpread().return.market.spot: number; default: not declared - strategy.bullCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bullCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bullCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bullCallSpread().return.multiplier: number; default: not declared - strategy.bullCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bullCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bullCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bullCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bullCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bullCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bullCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bullCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bullCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bullCallSpread(config)?: PositionConfig | undefined; default: not declared - strategy.bullCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bullCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bullCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bullCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bullCallSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - strategy.bullCallSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - strategy.bullCallSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - strategy.bullCallSpread(input).quantity?: number; default: not declared - strategy.bullCallSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - strategy.bullPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.bullPutLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bullPutLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bullPutLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bullPutLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bullPutLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bullPutLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bullPutLadder().return.market.dividendYield?: number; default: not declared - strategy.bullPutLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bullPutLadder().return.market.riskFreeRate: number; default: not declared - strategy.bullPutLadder().return.market.spot: number; default: not declared - strategy.bullPutLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bullPutLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bullPutLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bullPutLadder().return.multiplier: number; default: not declared - strategy.bullPutLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bullPutLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bullPutLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bullPutLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bullPutLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bullPutLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bullPutLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bullPutLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bullPutLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bullPutLadder(config)?: PositionConfig | undefined; default: not declared - strategy.bullPutLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bullPutLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bullPutLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bullPutLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bullPutLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.bullPutLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.bullPutLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bullPutLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bullPutLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.bullPutLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.bullPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - strategy.bullPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.bullPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.bullPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.bullPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.bullPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.bullPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.bullPutSpread().return.market.dividendYield?: number; default: not declared - strategy.bullPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.bullPutSpread().return.market.riskFreeRate: number; default: not declared - strategy.bullPutSpread().return.market.spot: number; default: not declared - strategy.bullPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.bullPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.bullPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.bullPutSpread().return.multiplier: number; default: not declared - strategy.bullPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.bullPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.bullPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.bullPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.bullPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.bullPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.bullPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.bullPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.bullPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.bullPutSpread(config)?: PositionConfig | undefined; default: not declared - strategy.bullPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.bullPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.bullPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.bullPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.bullPutSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - strategy.bullPutSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - strategy.bullPutSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - strategy.bullPutSpread(input).quantity?: number; default: not declared - strategy.bullPutSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - strategy.calendarCallSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; default: not declared - strategy.calendarCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.calendarCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.calendarCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.calendarCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.calendarCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.calendarCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.calendarCallSpread().return.market.dividendYield?: number; default: not declared - strategy.calendarCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.calendarCallSpread().return.market.riskFreeRate: number; default: not declared - strategy.calendarCallSpread().return.market.spot: number; default: not declared - strategy.calendarCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.calendarCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.calendarCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.calendarCallSpread().return.multiplier: number; default: not declared - strategy.calendarCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.calendarCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.calendarCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.calendarCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.calendarCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.calendarCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.calendarCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.calendarCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.calendarCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.calendarCallSpread(config)?: PositionConfig | undefined; default: not declared - strategy.calendarCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.calendarCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.calendarCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.calendarCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.calendarCallSpread(input): import('@insiderfinance/totalfinance/strategy').CalendarInput; default: not declared - strategy.calendarCallSpread(input).farExpiry: string; default: not declared — Far expiry of the long leg. - strategy.calendarCallSpread(input).longPremium?: number; default: not declared — Premium paid on the long far leg. - strategy.calendarCallSpread(input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.calendarCallSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.calendarCallSpread(input).shortPremium?: number; default: not declared — Premium received on the short near leg. - strategy.calendarCallSpread(input).strike: number; default: not declared - strategy.calendarPutSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; default: not declared - strategy.calendarPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.calendarPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.calendarPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.calendarPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.calendarPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.calendarPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.calendarPutSpread().return.market.dividendYield?: number; default: not declared - strategy.calendarPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.calendarPutSpread().return.market.riskFreeRate: number; default: not declared - strategy.calendarPutSpread().return.market.spot: number; default: not declared - strategy.calendarPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.calendarPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.calendarPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.calendarPutSpread().return.multiplier: number; default: not declared - strategy.calendarPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.calendarPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.calendarPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.calendarPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.calendarPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.calendarPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.calendarPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.calendarPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.calendarPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.calendarPutSpread(config)?: PositionConfig | undefined; default: not declared - strategy.calendarPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.calendarPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.calendarPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.calendarPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.calendarPutSpread(input): import('@insiderfinance/totalfinance/strategy').CalendarInput; default: not declared - strategy.calendarPutSpread(input).farExpiry: string; default: not declared — Far expiry of the long leg. - strategy.calendarPutSpread(input).longPremium?: number; default: not declared — Premium paid on the long far leg. - strategy.calendarPutSpread(input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.calendarPutSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.calendarPutSpread(input).shortPremium?: number; default: not declared — Premium received on the short near leg. - strategy.calendarPutSpread(input).strike: number; default: not declared - strategy.callBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.callBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.callBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.callBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.callBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.callBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.callBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.callBrokenWing().return.market.dividendYield?: number; default: not declared - strategy.callBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.callBrokenWing().return.market.riskFreeRate: number; default: not declared - strategy.callBrokenWing().return.market.spot: number; default: not declared - strategy.callBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.callBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.callBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.callBrokenWing().return.multiplier: number; default: not declared - strategy.callBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.callBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.callBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.callBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.callBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.callBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.callBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.callBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.callBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.callBrokenWing(config)?: PositionConfig | undefined; default: not declared - strategy.callBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.callBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.callBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.callBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.callBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.callBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.callBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.callBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.callBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.callBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.callRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - strategy.callRatioBackspread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.callRatioBackspread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.callRatioBackspread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.callRatioBackspread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.callRatioBackspread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.callRatioBackspread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.callRatioBackspread().return.market.dividendYield?: number; default: not declared - strategy.callRatioBackspread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.callRatioBackspread().return.market.riskFreeRate: number; default: not declared - strategy.callRatioBackspread().return.market.spot: number; default: not declared - strategy.callRatioBackspread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.callRatioBackspread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.callRatioBackspread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.callRatioBackspread().return.multiplier: number; default: not declared - strategy.callRatioBackspread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.callRatioBackspread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.callRatioBackspread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.callRatioBackspread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.callRatioBackspread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.callRatioBackspread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.callRatioBackspread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.callRatioBackspread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.callRatioBackspread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.callRatioBackspread(config)?: PositionConfig | undefined; default: not declared - strategy.callRatioBackspread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.callRatioBackspread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.callRatioBackspread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.callRatioBackspread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.callRatioBackspread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - strategy.callRatioBackspread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.callRatioBackspread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.callRatioBackspread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.callRatioBackspread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - strategy.callRatioBackspread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.callRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - strategy.callRatioSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.callRatioSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.callRatioSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.callRatioSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.callRatioSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.callRatioSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.callRatioSpread().return.market.dividendYield?: number; default: not declared - strategy.callRatioSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.callRatioSpread().return.market.riskFreeRate: number; default: not declared - strategy.callRatioSpread().return.market.spot: number; default: not declared - strategy.callRatioSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.callRatioSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.callRatioSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.callRatioSpread().return.multiplier: number; default: not declared - strategy.callRatioSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.callRatioSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.callRatioSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.callRatioSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.callRatioSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.callRatioSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.callRatioSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.callRatioSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.callRatioSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.callRatioSpread(config)?: PositionConfig | undefined; default: not declared - strategy.callRatioSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.callRatioSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.callRatioSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.callRatioSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.callRatioSpread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - strategy.callRatioSpread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.callRatioSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.callRatioSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.callRatioSpread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - strategy.callRatioSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.cashSecuredPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - strategy.cashSecuredPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.cashSecuredPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.cashSecuredPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.cashSecuredPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.cashSecuredPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.cashSecuredPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.cashSecuredPut().return.market.dividendYield?: number; default: not declared - strategy.cashSecuredPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.cashSecuredPut().return.market.riskFreeRate: number; default: not declared - strategy.cashSecuredPut().return.market.spot: number; default: not declared - strategy.cashSecuredPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.cashSecuredPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.cashSecuredPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.cashSecuredPut().return.multiplier: number; default: not declared - strategy.cashSecuredPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.cashSecuredPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.cashSecuredPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.cashSecuredPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.cashSecuredPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.cashSecuredPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.cashSecuredPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.cashSecuredPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.cashSecuredPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.cashSecuredPut(config)?: PositionConfig | undefined; default: not declared - strategy.cashSecuredPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.cashSecuredPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.cashSecuredPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.cashSecuredPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.cashSecuredPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - strategy.cashSecuredPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.cashSecuredPut(input).premium?: number; default: not declared - strategy.cashSecuredPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.cashSecuredPut(input).strike: number; default: not declared - strategy.collar: (input: import('@insiderfinance/totalfinance/strategy').CollarInput, config?: PositionConfig) => Position; default: not declared - strategy.collar().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.collar().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.collar().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.collar().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.collar().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.collar().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.collar().return.market.dividendYield?: number; default: not declared - strategy.collar().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.collar().return.market.riskFreeRate: number; default: not declared - strategy.collar().return.market.spot: number; default: not declared - strategy.collar().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.collar().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.collar().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.collar().return.multiplier: number; default: not declared - strategy.collar().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.collar().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.collar().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.collar().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.collar().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.collar().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.collar().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.collar().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.collar().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.collar(config)?: PositionConfig | undefined; default: not declared - strategy.collar(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.collar(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.collar(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.collar(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.collar(input): import('@insiderfinance/totalfinance/strategy').CollarInput; default: not declared - strategy.collar(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.collar(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.collar(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.collar(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.collar(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - strategy.coveredCall: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; default: not declared - strategy.coveredCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.coveredCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.coveredCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.coveredCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.coveredCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.coveredCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.coveredCall().return.market.dividendYield?: number; default: not declared - strategy.coveredCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.coveredCall().return.market.riskFreeRate: number; default: not declared - strategy.coveredCall().return.market.spot: number; default: not declared - strategy.coveredCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.coveredCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.coveredCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.coveredCall().return.multiplier: number; default: not declared - strategy.coveredCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.coveredCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.coveredCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.coveredCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.coveredCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.coveredCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.coveredCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.coveredCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.coveredCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.coveredCall(config)?: PositionConfig | undefined; default: not declared - strategy.coveredCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.coveredCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.coveredCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.coveredCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.coveredCall(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg; default: not declared - strategy.coveredCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.coveredCall(input).premium?: number; default: not declared - strategy.coveredCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.coveredCall(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - strategy.coveredCall(input).strike: number; default: not declared - strategy.coveredShortStraddle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; default: not declared - strategy.coveredShortStraddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.coveredShortStraddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.coveredShortStraddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.coveredShortStraddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.coveredShortStraddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.coveredShortStraddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.coveredShortStraddle().return.market.dividendYield?: number; default: not declared - strategy.coveredShortStraddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.coveredShortStraddle().return.market.riskFreeRate: number; default: not declared - strategy.coveredShortStraddle().return.market.spot: number; default: not declared - strategy.coveredShortStraddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.coveredShortStraddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.coveredShortStraddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.coveredShortStraddle().return.multiplier: number; default: not declared - strategy.coveredShortStraddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.coveredShortStraddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.coveredShortStraddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.coveredShortStraddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.coveredShortStraddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.coveredShortStraddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.coveredShortStraddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.coveredShortStraddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.coveredShortStraddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.coveredShortStraddle(config)?: PositionConfig | undefined; default: not declared - strategy.coveredShortStraddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.coveredShortStraddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.coveredShortStraddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.coveredShortStraddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.coveredShortStraddle(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput; default: not declared - strategy.coveredShortStraddle(input).callPremium?: number; default: not declared - strategy.coveredShortStraddle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.coveredShortStraddle(input).putPremium?: number; default: not declared - strategy.coveredShortStraddle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.coveredShortStraddle(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - strategy.coveredShortStraddle(input).strike: number; default: not declared - strategy.coveredShortStrangle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; default: not declared - strategy.coveredShortStrangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.coveredShortStrangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.coveredShortStrangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.coveredShortStrangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.coveredShortStrangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.coveredShortStrangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.coveredShortStrangle().return.market.dividendYield?: number; default: not declared - strategy.coveredShortStrangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.coveredShortStrangle().return.market.riskFreeRate: number; default: not declared - strategy.coveredShortStrangle().return.market.spot: number; default: not declared - strategy.coveredShortStrangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.coveredShortStrangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.coveredShortStrangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.coveredShortStrangle().return.multiplier: number; default: not declared - strategy.coveredShortStrangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.coveredShortStrangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.coveredShortStrangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.coveredShortStrangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.coveredShortStrangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.coveredShortStrangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.coveredShortStrangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.coveredShortStrangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.coveredShortStrangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.coveredShortStrangle(config)?: PositionConfig | undefined; default: not declared - strategy.coveredShortStrangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.coveredShortStrangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.coveredShortStrangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.coveredShortStrangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.coveredShortStrangle(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput; default: not declared - strategy.coveredShortStrangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - strategy.coveredShortStrangle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.coveredShortStrangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - strategy.coveredShortStrangle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.coveredShortStrangle(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - strategy.diagonalCallSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; default: not declared - strategy.diagonalCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.diagonalCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.diagonalCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.diagonalCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.diagonalCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.diagonalCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.diagonalCallSpread().return.market.dividendYield?: number; default: not declared - strategy.diagonalCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.diagonalCallSpread().return.market.riskFreeRate: number; default: not declared - strategy.diagonalCallSpread().return.market.spot: number; default: not declared - strategy.diagonalCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.diagonalCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.diagonalCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.diagonalCallSpread().return.multiplier: number; default: not declared - strategy.diagonalCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.diagonalCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.diagonalCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.diagonalCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.diagonalCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.diagonalCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.diagonalCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.diagonalCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.diagonalCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.diagonalCallSpread(config)?: PositionConfig | undefined; default: not declared - strategy.diagonalCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.diagonalCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.diagonalCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.diagonalCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.diagonalCallSpread(input): import('@insiderfinance/totalfinance/strategy').DiagonalInput; default: not declared - strategy.diagonalCallSpread(input).farExpiry: string; default: not declared - strategy.diagonalCallSpread(input).longPremium?: number; default: not declared - strategy.diagonalCallSpread(input).longStrike: number; default: not declared - strategy.diagonalCallSpread(input).nearExpiry: string; default: not declared - strategy.diagonalCallSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.diagonalCallSpread(input).shortPremium?: number; default: not declared - strategy.diagonalCallSpread(input).shortStrike: number; default: not declared - strategy.diagonalPutSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; default: not declared - strategy.diagonalPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.diagonalPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.diagonalPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.diagonalPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.diagonalPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.diagonalPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.diagonalPutSpread().return.market.dividendYield?: number; default: not declared - strategy.diagonalPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.diagonalPutSpread().return.market.riskFreeRate: number; default: not declared - strategy.diagonalPutSpread().return.market.spot: number; default: not declared - strategy.diagonalPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.diagonalPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.diagonalPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.diagonalPutSpread().return.multiplier: number; default: not declared - strategy.diagonalPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.diagonalPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.diagonalPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.diagonalPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.diagonalPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.diagonalPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.diagonalPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.diagonalPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.diagonalPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.diagonalPutSpread(config)?: PositionConfig | undefined; default: not declared - strategy.diagonalPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.diagonalPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.diagonalPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.diagonalPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.diagonalPutSpread(input): import('@insiderfinance/totalfinance/strategy').DiagonalInput; default: not declared - strategy.diagonalPutSpread(input).farExpiry: string; default: not declared - strategy.diagonalPutSpread(input).longPremium?: number; default: not declared - strategy.diagonalPutSpread(input).longStrike: number; default: not declared - strategy.diagonalPutSpread(input).nearExpiry: string; default: not declared - strategy.diagonalPutSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.diagonalPutSpread(input).shortPremium?: number; default: not declared - strategy.diagonalPutSpread(input).shortStrike: number; default: not declared - strategy.doubleDiagonal: (input: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput, config?: PositionConfig) => Position; default: not declared - strategy.doubleDiagonal().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.doubleDiagonal().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.doubleDiagonal().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.doubleDiagonal().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.doubleDiagonal().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.doubleDiagonal().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.doubleDiagonal().return.market.dividendYield?: number; default: not declared - strategy.doubleDiagonal().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.doubleDiagonal().return.market.riskFreeRate: number; default: not declared - strategy.doubleDiagonal().return.market.spot: number; default: not declared - strategy.doubleDiagonal().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.doubleDiagonal().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.doubleDiagonal().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.doubleDiagonal().return.multiplier: number; default: not declared - strategy.doubleDiagonal().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.doubleDiagonal().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.doubleDiagonal().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.doubleDiagonal().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.doubleDiagonal().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.doubleDiagonal().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.doubleDiagonal().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.doubleDiagonal().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.doubleDiagonal().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.doubleDiagonal(config)?: PositionConfig | undefined; default: not declared - strategy.doubleDiagonal(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.doubleDiagonal(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.doubleDiagonal(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.doubleDiagonal(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.doubleDiagonal(input): import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput; default: not declared - strategy.doubleDiagonal(input).call: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalSide; default: not declared - strategy.doubleDiagonal(input).farExpiry: string; default: not declared - strategy.doubleDiagonal(input).nearExpiry: string; default: not declared - strategy.doubleDiagonal(input).put: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalSide; default: not declared - strategy.doubleDiagonal(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.guts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - strategy.guts().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.guts().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.guts().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.guts().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.guts().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.guts().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.guts().return.market.dividendYield?: number; default: not declared - strategy.guts().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.guts().return.market.riskFreeRate: number; default: not declared - strategy.guts().return.market.spot: number; default: not declared - strategy.guts().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.guts().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.guts().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.guts().return.multiplier: number; default: not declared - strategy.guts().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.guts().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.guts().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.guts().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.guts().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.guts().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.guts().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.guts().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.guts().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.guts(config)?: PositionConfig | undefined; default: not declared - strategy.guts(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.guts(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.guts(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.guts(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.guts(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - strategy.guts(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.guts(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.guts(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.guts(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseCallBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.inverseCallBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.inverseCallBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.inverseCallBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.inverseCallBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.inverseCallBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.inverseCallBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.inverseCallBrokenWing().return.market.dividendYield?: number; default: not declared - strategy.inverseCallBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.inverseCallBrokenWing().return.market.riskFreeRate: number; default: not declared - strategy.inverseCallBrokenWing().return.market.spot: number; default: not declared - strategy.inverseCallBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.inverseCallBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.inverseCallBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.inverseCallBrokenWing().return.multiplier: number; default: not declared - strategy.inverseCallBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.inverseCallBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.inverseCallBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.inverseCallBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.inverseCallBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.inverseCallBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.inverseCallBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.inverseCallBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.inverseCallBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.inverseCallBrokenWing(config)?: PositionConfig | undefined; default: not declared - strategy.inverseCallBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.inverseCallBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.inverseCallBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.inverseCallBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.inverseCallBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.inverseCallBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.inverseCallBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseCallBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseCallBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.inverseCallBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseIronButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; default: not declared - strategy.inverseIronButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.inverseIronButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.inverseIronButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.inverseIronButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.inverseIronButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.inverseIronButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.inverseIronButterfly().return.market.dividendYield?: number; default: not declared - strategy.inverseIronButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.inverseIronButterfly().return.market.riskFreeRate: number; default: not declared - strategy.inverseIronButterfly().return.market.spot: number; default: not declared - strategy.inverseIronButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.inverseIronButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.inverseIronButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.inverseIronButterfly().return.multiplier: number; default: not declared - strategy.inverseIronButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.inverseIronButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.inverseIronButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.inverseIronButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.inverseIronButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.inverseIronButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.inverseIronButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.inverseIronButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.inverseIronButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.inverseIronButterfly(config)?: PositionConfig | undefined; default: not declared - strategy.inverseIronButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.inverseIronButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.inverseIronButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.inverseIronButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.inverseIronButterfly(input): import('@insiderfinance/totalfinance/strategy').IronButterflyInput; default: not declared - strategy.inverseIronButterfly(input).body: number | { strike: number; callPremium?: number; putPremium?: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - strategy.inverseIronButterfly(input).body.callPremium?: number; default: not declared - strategy.inverseIronButterfly(input).body.putPremium?: number; default: not declared - strategy.inverseIronButterfly(input).body.strike: number; default: not declared - strategy.inverseIronButterfly(input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - strategy.inverseIronButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.inverseIronButterfly(input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - strategy.inverseIronButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.inverseIronCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; default: not declared - strategy.inverseIronCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.inverseIronCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.inverseIronCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.inverseIronCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.inverseIronCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.inverseIronCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.inverseIronCondor().return.market.dividendYield?: number; default: not declared - strategy.inverseIronCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.inverseIronCondor().return.market.riskFreeRate: number; default: not declared - strategy.inverseIronCondor().return.market.spot: number; default: not declared - strategy.inverseIronCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.inverseIronCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.inverseIronCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.inverseIronCondor().return.multiplier: number; default: not declared - strategy.inverseIronCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.inverseIronCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.inverseIronCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.inverseIronCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.inverseIronCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.inverseIronCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.inverseIronCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.inverseIronCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.inverseIronCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.inverseIronCondor(config)?: PositionConfig | undefined; default: not declared - strategy.inverseIronCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.inverseIronCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.inverseIronCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.inverseIronCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.inverseIronCondor(input): import('@insiderfinance/totalfinance/strategy').IronCondorInput; default: not declared - strategy.inverseIronCondor(input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseIronCondor(input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseIronCondor(input).expiry?: string; default: not declared - strategy.inverseIronCondor(input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseIronCondor(input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inverseIronCondor(input).quantity?: number; default: not declared - strategy.inversePutBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.inversePutBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.inversePutBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.inversePutBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.inversePutBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.inversePutBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.inversePutBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.inversePutBrokenWing().return.market.dividendYield?: number; default: not declared - strategy.inversePutBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.inversePutBrokenWing().return.market.riskFreeRate: number; default: not declared - strategy.inversePutBrokenWing().return.market.spot: number; default: not declared - strategy.inversePutBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.inversePutBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.inversePutBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.inversePutBrokenWing().return.multiplier: number; default: not declared - strategy.inversePutBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.inversePutBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.inversePutBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.inversePutBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.inversePutBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.inversePutBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.inversePutBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.inversePutBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.inversePutBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.inversePutBrokenWing(config)?: PositionConfig | undefined; default: not declared - strategy.inversePutBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.inversePutBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.inversePutBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.inversePutBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.inversePutBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.inversePutBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.inversePutBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inversePutBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.inversePutBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.inversePutBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.ironButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; default: not declared - strategy.ironButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.ironButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.ironButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.ironButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.ironButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.ironButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.ironButterfly().return.market.dividendYield?: number; default: not declared - strategy.ironButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.ironButterfly().return.market.riskFreeRate: number; default: not declared - strategy.ironButterfly().return.market.spot: number; default: not declared - strategy.ironButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.ironButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.ironButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.ironButterfly().return.multiplier: number; default: not declared - strategy.ironButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.ironButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.ironButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.ironButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.ironButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.ironButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.ironButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.ironButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.ironButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.ironButterfly(config)?: PositionConfig | undefined; default: not declared - strategy.ironButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.ironButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.ironButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.ironButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.ironButterfly(input): import('@insiderfinance/totalfinance/strategy').IronButterflyInput; default: not declared - strategy.ironButterfly(input).body: number | { strike: number; callPremium?: number; putPremium?: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - strategy.ironButterfly(input).body.callPremium?: number; default: not declared - strategy.ironButterfly(input).body.putPremium?: number; default: not declared - strategy.ironButterfly(input).body.strike: number; default: not declared - strategy.ironButterfly(input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - strategy.ironButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.ironButterfly(input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - strategy.ironButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.ironCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; default: not declared - strategy.ironCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.ironCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.ironCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.ironCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.ironCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.ironCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.ironCondor().return.market.dividendYield?: number; default: not declared - strategy.ironCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.ironCondor().return.market.riskFreeRate: number; default: not declared - strategy.ironCondor().return.market.spot: number; default: not declared - strategy.ironCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.ironCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.ironCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.ironCondor().return.multiplier: number; default: not declared - strategy.ironCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.ironCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.ironCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.ironCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.ironCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.ironCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.ironCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.ironCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.ironCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.ironCondor(config)?: PositionConfig | undefined; default: not declared - strategy.ironCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.ironCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.ironCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.ironCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.ironCondor(input): import('@insiderfinance/totalfinance/strategy').IronCondorInput; default: not declared - strategy.ironCondor(input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.ironCondor(input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.ironCondor(input).expiry?: string; default: not declared - strategy.ironCondor(input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.ironCondor(input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.ironCondor(input).quantity?: number; default: not declared - strategy.jadeLizard: (input: import('@insiderfinance/totalfinance/strategy').JadeLizardInput, config?: PositionConfig) => Position; default: not declared - strategy.jadeLizard().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.jadeLizard().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.jadeLizard().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.jadeLizard().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.jadeLizard().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.jadeLizard().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.jadeLizard().return.market.dividendYield?: number; default: not declared - strategy.jadeLizard().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.jadeLizard().return.market.riskFreeRate: number; default: not declared - strategy.jadeLizard().return.market.spot: number; default: not declared - strategy.jadeLizard().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.jadeLizard().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.jadeLizard().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.jadeLizard().return.multiplier: number; default: not declared - strategy.jadeLizard().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.jadeLizard().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.jadeLizard().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.jadeLizard().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.jadeLizard().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.jadeLizard().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.jadeLizard().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.jadeLizard().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.jadeLizard().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.jadeLizard(config)?: PositionConfig | undefined; default: not declared - strategy.jadeLizard(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.jadeLizard(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.jadeLizard(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.jadeLizard(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.jadeLizard(input): import('@insiderfinance/totalfinance/strategy').JadeLizardInput; default: not declared - strategy.jadeLizard(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.jadeLizard(input).longCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.jadeLizard(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.jadeLizard(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.jadeLizard(input).shortCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.listStrategies: () => manifest.StrategyDescriptor[]; default: not declared — Every named builder: name, description, multi-expiry flag, and a canonical example input. - strategy.longCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - strategy.longCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longCall().return.market.dividendYield?: number; default: not declared - strategy.longCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longCall().return.market.riskFreeRate: number; default: not declared - strategy.longCall().return.market.spot: number; default: not declared - strategy.longCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longCall().return.multiplier: number; default: not declared - strategy.longCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longCall(config)?: PositionConfig | undefined; default: not declared - strategy.longCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longCall(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - strategy.longCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longCall(input).premium?: number; default: not declared - strategy.longCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longCall(input).strike: number; default: not declared - strategy.longCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.longCallButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longCallButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longCallButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longCallButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longCallButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longCallButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longCallButterfly().return.market.dividendYield?: number; default: not declared - strategy.longCallButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longCallButterfly().return.market.riskFreeRate: number; default: not declared - strategy.longCallButterfly().return.market.spot: number; default: not declared - strategy.longCallButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longCallButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longCallButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longCallButterfly().return.multiplier: number; default: not declared - strategy.longCallButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longCallButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longCallButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longCallButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longCallButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longCallButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longCallButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longCallButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longCallButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longCallButterfly(config)?: PositionConfig | undefined; default: not declared - strategy.longCallButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longCallButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longCallButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longCallButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longCallButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.longCallButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longCallButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longCallButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - strategy.longCallCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longCallCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longCallCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longCallCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longCallCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longCallCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longCallCondor().return.market.dividendYield?: number; default: not declared - strategy.longCallCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longCallCondor().return.market.riskFreeRate: number; default: not declared - strategy.longCallCondor().return.market.spot: number; default: not declared - strategy.longCallCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longCallCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longCallCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longCallCondor().return.multiplier: number; default: not declared - strategy.longCallCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longCallCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longCallCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longCallCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longCallCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longCallCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longCallCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longCallCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longCallCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longCallCondor(config)?: PositionConfig | undefined; default: not declared - strategy.longCallCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longCallCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longCallCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longCallCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longCallCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - strategy.longCallCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longCallCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCallCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - strategy.longCombo().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longCombo().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longCombo().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longCombo().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longCombo().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longCombo().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longCombo().return.market.dividendYield?: number; default: not declared - strategy.longCombo().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longCombo().return.market.riskFreeRate: number; default: not declared - strategy.longCombo().return.market.spot: number; default: not declared - strategy.longCombo().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longCombo().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longCombo().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longCombo().return.multiplier: number; default: not declared - strategy.longCombo().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longCombo().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longCombo().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longCombo().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longCombo().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longCombo().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longCombo().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longCombo().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longCombo().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longCombo(config)?: PositionConfig | undefined; default: not declared - strategy.longCombo(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longCombo(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longCombo(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longCombo(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longCombo(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - strategy.longCombo(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longCombo(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longCombo(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longCombo(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - strategy.longPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longPut().return.market.dividendYield?: number; default: not declared - strategy.longPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longPut().return.market.riskFreeRate: number; default: not declared - strategy.longPut().return.market.spot: number; default: not declared - strategy.longPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longPut().return.multiplier: number; default: not declared - strategy.longPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longPut(config)?: PositionConfig | undefined; default: not declared - strategy.longPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - strategy.longPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longPut(input).premium?: number; default: not declared - strategy.longPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longPut(input).strike: number; default: not declared - strategy.longPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.longPutButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longPutButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longPutButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longPutButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longPutButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longPutButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longPutButterfly().return.market.dividendYield?: number; default: not declared - strategy.longPutButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longPutButterfly().return.market.riskFreeRate: number; default: not declared - strategy.longPutButterfly().return.market.spot: number; default: not declared - strategy.longPutButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longPutButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longPutButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longPutButterfly().return.multiplier: number; default: not declared - strategy.longPutButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longPutButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longPutButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longPutButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longPutButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longPutButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longPutButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longPutButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longPutButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longPutButterfly(config)?: PositionConfig | undefined; default: not declared - strategy.longPutButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longPutButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longPutButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longPutButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longPutButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.longPutButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longPutButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longPutButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - strategy.longPutCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longPutCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longPutCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longPutCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longPutCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longPutCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longPutCondor().return.market.dividendYield?: number; default: not declared - strategy.longPutCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longPutCondor().return.market.riskFreeRate: number; default: not declared - strategy.longPutCondor().return.market.spot: number; default: not declared - strategy.longPutCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longPutCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longPutCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longPutCondor().return.multiplier: number; default: not declared - strategy.longPutCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longPutCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longPutCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longPutCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longPutCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longPutCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longPutCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longPutCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longPutCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longPutCondor(config)?: PositionConfig | undefined; default: not declared - strategy.longPutCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longPutCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longPutCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longPutCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longPutCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - strategy.longPutCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longPutCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.longPutCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strategy.longSyntheticFuture().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.longSyntheticFuture().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.longSyntheticFuture().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.longSyntheticFuture().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.longSyntheticFuture().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.longSyntheticFuture().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.longSyntheticFuture().return.market.dividendYield?: number; default: not declared - strategy.longSyntheticFuture().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.longSyntheticFuture().return.market.riskFreeRate: number; default: not declared - strategy.longSyntheticFuture().return.market.spot: number; default: not declared - strategy.longSyntheticFuture().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.longSyntheticFuture().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.longSyntheticFuture().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.longSyntheticFuture().return.multiplier: number; default: not declared - strategy.longSyntheticFuture().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.longSyntheticFuture().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.longSyntheticFuture().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.longSyntheticFuture().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.longSyntheticFuture().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.longSyntheticFuture().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.longSyntheticFuture().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.longSyntheticFuture().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.longSyntheticFuture().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.longSyntheticFuture(config)?: PositionConfig | undefined; default: not declared - strategy.longSyntheticFuture(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.longSyntheticFuture(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.longSyntheticFuture(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.longSyntheticFuture(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.longSyntheticFuture(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strategy.longSyntheticFuture(input).callPremium?: number; default: not declared - strategy.longSyntheticFuture(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.longSyntheticFuture(input).putPremium?: number; default: not declared - strategy.longSyntheticFuture(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.longSyntheticFuture(input).strike: number; default: not declared - strategy.protectivePut: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; default: not declared - strategy.protectivePut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.protectivePut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.protectivePut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.protectivePut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.protectivePut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.protectivePut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.protectivePut().return.market.dividendYield?: number; default: not declared - strategy.protectivePut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.protectivePut().return.market.riskFreeRate: number; default: not declared - strategy.protectivePut().return.market.spot: number; default: not declared - strategy.protectivePut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.protectivePut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.protectivePut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.protectivePut().return.multiplier: number; default: not declared - strategy.protectivePut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.protectivePut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.protectivePut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.protectivePut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.protectivePut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.protectivePut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.protectivePut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.protectivePut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.protectivePut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.protectivePut(config)?: PositionConfig | undefined; default: not declared - strategy.protectivePut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.protectivePut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.protectivePut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.protectivePut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.protectivePut(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg; default: not declared - strategy.protectivePut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.protectivePut(input).premium?: number; default: not declared - strategy.protectivePut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.protectivePut(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - strategy.protectivePut(input).strike: number; default: not declared - strategy.putBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.putBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.putBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.putBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.putBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.putBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.putBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.putBrokenWing().return.market.dividendYield?: number; default: not declared - strategy.putBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.putBrokenWing().return.market.riskFreeRate: number; default: not declared - strategy.putBrokenWing().return.market.spot: number; default: not declared - strategy.putBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.putBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.putBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.putBrokenWing().return.multiplier: number; default: not declared - strategy.putBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.putBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.putBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.putBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.putBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.putBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.putBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.putBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.putBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.putBrokenWing(config)?: PositionConfig | undefined; default: not declared - strategy.putBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.putBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.putBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.putBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.putBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.putBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.putBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.putBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.putBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.putBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.putRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - strategy.putRatioBackspread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.putRatioBackspread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.putRatioBackspread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.putRatioBackspread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.putRatioBackspread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.putRatioBackspread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.putRatioBackspread().return.market.dividendYield?: number; default: not declared - strategy.putRatioBackspread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.putRatioBackspread().return.market.riskFreeRate: number; default: not declared - strategy.putRatioBackspread().return.market.spot: number; default: not declared - strategy.putRatioBackspread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.putRatioBackspread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.putRatioBackspread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.putRatioBackspread().return.multiplier: number; default: not declared - strategy.putRatioBackspread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.putRatioBackspread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.putRatioBackspread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.putRatioBackspread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.putRatioBackspread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.putRatioBackspread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.putRatioBackspread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.putRatioBackspread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.putRatioBackspread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.putRatioBackspread(config)?: PositionConfig | undefined; default: not declared - strategy.putRatioBackspread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.putRatioBackspread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.putRatioBackspread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.putRatioBackspread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.putRatioBackspread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - strategy.putRatioBackspread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.putRatioBackspread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.putRatioBackspread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.putRatioBackspread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - strategy.putRatioBackspread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.putRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - strategy.putRatioSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.putRatioSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.putRatioSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.putRatioSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.putRatioSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.putRatioSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.putRatioSpread().return.market.dividendYield?: number; default: not declared - strategy.putRatioSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.putRatioSpread().return.market.riskFreeRate: number; default: not declared - strategy.putRatioSpread().return.market.spot: number; default: not declared - strategy.putRatioSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.putRatioSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.putRatioSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.putRatioSpread().return.multiplier: number; default: not declared - strategy.putRatioSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.putRatioSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.putRatioSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.putRatioSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.putRatioSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.putRatioSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.putRatioSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.putRatioSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.putRatioSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.putRatioSpread(config)?: PositionConfig | undefined; default: not declared - strategy.putRatioSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.putRatioSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.putRatioSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.putRatioSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.putRatioSpread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - strategy.putRatioSpread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.putRatioSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.putRatioSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.putRatioSpread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - strategy.putRatioSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.reverseJadeLizard: (input: import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput, config?: PositionConfig) => Position; default: not declared - strategy.reverseJadeLizard().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.reverseJadeLizard().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.reverseJadeLizard().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.reverseJadeLizard().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.reverseJadeLizard().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.reverseJadeLizard().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.reverseJadeLizard().return.market.dividendYield?: number; default: not declared - strategy.reverseJadeLizard().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.reverseJadeLizard().return.market.riskFreeRate: number; default: not declared - strategy.reverseJadeLizard().return.market.spot: number; default: not declared - strategy.reverseJadeLizard().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.reverseJadeLizard().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.reverseJadeLizard().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.reverseJadeLizard().return.multiplier: number; default: not declared - strategy.reverseJadeLizard().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.reverseJadeLizard().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.reverseJadeLizard().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.reverseJadeLizard().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.reverseJadeLizard().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.reverseJadeLizard().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.reverseJadeLizard().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.reverseJadeLizard().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.reverseJadeLizard().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.reverseJadeLizard(config)?: PositionConfig | undefined; default: not declared - strategy.reverseJadeLizard(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.reverseJadeLizard(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.reverseJadeLizard(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.reverseJadeLizard(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.reverseJadeLizard(input): import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput; default: not declared - strategy.reverseJadeLizard(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.reverseJadeLizard(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.reverseJadeLizard(input).longPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.reverseJadeLizard(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.reverseJadeLizard(input).shortPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - strategy.shortCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortCall().return.market.dividendYield?: number; default: not declared - strategy.shortCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortCall().return.market.riskFreeRate: number; default: not declared - strategy.shortCall().return.market.spot: number; default: not declared - strategy.shortCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortCall().return.multiplier: number; default: not declared - strategy.shortCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortCall(config)?: PositionConfig | undefined; default: not declared - strategy.shortCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortCall(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - strategy.shortCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortCall(input).premium?: number; default: not declared - strategy.shortCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortCall(input).strike: number; default: not declared - strategy.shortCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.shortCallButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortCallButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortCallButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortCallButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortCallButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortCallButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortCallButterfly().return.market.dividendYield?: number; default: not declared - strategy.shortCallButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortCallButterfly().return.market.riskFreeRate: number; default: not declared - strategy.shortCallButterfly().return.market.spot: number; default: not declared - strategy.shortCallButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortCallButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortCallButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortCallButterfly().return.multiplier: number; default: not declared - strategy.shortCallButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortCallButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortCallButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortCallButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortCallButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortCallButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortCallButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortCallButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortCallButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortCallButterfly(config)?: PositionConfig | undefined; default: not declared - strategy.shortCallButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortCallButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortCallButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortCallButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortCallButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.shortCallButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortCallButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortCallButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - strategy.shortCallCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortCallCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortCallCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortCallCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortCallCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortCallCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortCallCondor().return.market.dividendYield?: number; default: not declared - strategy.shortCallCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortCallCondor().return.market.riskFreeRate: number; default: not declared - strategy.shortCallCondor().return.market.spot: number; default: not declared - strategy.shortCallCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortCallCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortCallCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortCallCondor().return.multiplier: number; default: not declared - strategy.shortCallCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortCallCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortCallCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortCallCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortCallCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortCallCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortCallCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortCallCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortCallCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortCallCondor(config)?: PositionConfig | undefined; default: not declared - strategy.shortCallCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortCallCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortCallCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortCallCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortCallCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - strategy.shortCallCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortCallCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCallCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - strategy.shortCombo().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortCombo().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortCombo().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortCombo().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortCombo().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortCombo().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortCombo().return.market.dividendYield?: number; default: not declared - strategy.shortCombo().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortCombo().return.market.riskFreeRate: number; default: not declared - strategy.shortCombo().return.market.spot: number; default: not declared - strategy.shortCombo().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortCombo().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortCombo().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortCombo().return.multiplier: number; default: not declared - strategy.shortCombo().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortCombo().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortCombo().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortCombo().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortCombo().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortCombo().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortCombo().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortCombo().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortCombo().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortCombo(config)?: PositionConfig | undefined; default: not declared - strategy.shortCombo(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortCombo(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortCombo(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortCombo(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortCombo(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - strategy.shortCombo(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortCombo(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortCombo(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortCombo(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortGuts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - strategy.shortGuts().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortGuts().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortGuts().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortGuts().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortGuts().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortGuts().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortGuts().return.market.dividendYield?: number; default: not declared - strategy.shortGuts().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortGuts().return.market.riskFreeRate: number; default: not declared - strategy.shortGuts().return.market.spot: number; default: not declared - strategy.shortGuts().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortGuts().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortGuts().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortGuts().return.multiplier: number; default: not declared - strategy.shortGuts().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortGuts().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortGuts().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortGuts().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortGuts().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortGuts().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortGuts().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortGuts().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortGuts().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortGuts(config)?: PositionConfig | undefined; default: not declared - strategy.shortGuts(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortGuts(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortGuts(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortGuts(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortGuts(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - strategy.shortGuts(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortGuts(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortGuts(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortGuts(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - strategy.shortPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortPut().return.market.dividendYield?: number; default: not declared - strategy.shortPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortPut().return.market.riskFreeRate: number; default: not declared - strategy.shortPut().return.market.spot: number; default: not declared - strategy.shortPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortPut().return.multiplier: number; default: not declared - strategy.shortPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortPut(config)?: PositionConfig | undefined; default: not declared - strategy.shortPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - strategy.shortPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortPut(input).premium?: number; default: not declared - strategy.shortPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortPut(input).strike: number; default: not declared - strategy.shortPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - strategy.shortPutButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortPutButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortPutButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortPutButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortPutButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortPutButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortPutButterfly().return.market.dividendYield?: number; default: not declared - strategy.shortPutButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortPutButterfly().return.market.riskFreeRate: number; default: not declared - strategy.shortPutButterfly().return.market.spot: number; default: not declared - strategy.shortPutButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortPutButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortPutButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortPutButterfly().return.multiplier: number; default: not declared - strategy.shortPutButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortPutButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortPutButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortPutButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortPutButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortPutButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortPutButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortPutButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortPutButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortPutButterfly(config)?: PositionConfig | undefined; default: not declared - strategy.shortPutButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortPutButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortPutButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortPutButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortPutButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - strategy.shortPutButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortPutButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortPutButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - strategy.shortPutCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortPutCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortPutCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortPutCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortPutCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortPutCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortPutCondor().return.market.dividendYield?: number; default: not declared - strategy.shortPutCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortPutCondor().return.market.riskFreeRate: number; default: not declared - strategy.shortPutCondor().return.market.spot: number; default: not declared - strategy.shortPutCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortPutCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortPutCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortPutCondor().return.multiplier: number; default: not declared - strategy.shortPutCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortPutCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortPutCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortPutCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortPutCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortPutCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortPutCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortPutCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortPutCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortPutCondor(config)?: PositionConfig | undefined; default: not declared - strategy.shortPutCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortPutCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortPutCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortPutCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortPutCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - strategy.shortPutCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortPutCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - strategy.shortPutCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortStraddle: (input: import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; default: not declared - strategy.shortStraddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortStraddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortStraddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortStraddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortStraddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortStraddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortStraddle().return.market.dividendYield?: number; default: not declared - strategy.shortStraddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortStraddle().return.market.riskFreeRate: number; default: not declared - strategy.shortStraddle().return.market.spot: number; default: not declared - strategy.shortStraddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortStraddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortStraddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortStraddle().return.multiplier: number; default: not declared - strategy.shortStraddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortStraddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortStraddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortStraddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortStraddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortStraddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortStraddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortStraddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortStraddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortStraddle(config)?: PositionConfig | undefined; default: not declared - strategy.shortStraddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortStraddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortStraddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortStraddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortStraddle(input): import('@insiderfinance/totalfinance/strategy').ShortStraddleInput; default: not declared - strategy.shortStraddle(input).callPremium?: number; default: not declared - strategy.shortStraddle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortStraddle(input).putPremium?: number; default: not declared - strategy.shortStraddle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortStraddle(input).strike: number; default: not declared - strategy.shortStrangle: (input: import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; default: not declared - strategy.shortStrangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortStrangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortStrangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortStrangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortStrangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortStrangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortStrangle().return.market.dividendYield?: number; default: not declared - strategy.shortStrangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortStrangle().return.market.riskFreeRate: number; default: not declared - strategy.shortStrangle().return.market.spot: number; default: not declared - strategy.shortStrangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortStrangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortStrangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortStrangle().return.multiplier: number; default: not declared - strategy.shortStrangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortStrangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortStrangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortStrangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortStrangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortStrangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortStrangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortStrangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortStrangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortStrangle(config)?: PositionConfig | undefined; default: not declared - strategy.shortStrangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortStrangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortStrangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortStrangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortStrangle(input): import('@insiderfinance/totalfinance/strategy').ShortStrangleInput; default: not declared - strategy.shortStrangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - strategy.shortStrangle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortStrangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - strategy.shortStrangle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strategy.shortSyntheticFuture().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.shortSyntheticFuture().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.shortSyntheticFuture().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.shortSyntheticFuture().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.shortSyntheticFuture().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.shortSyntheticFuture().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.shortSyntheticFuture().return.market.dividendYield?: number; default: not declared - strategy.shortSyntheticFuture().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.shortSyntheticFuture().return.market.riskFreeRate: number; default: not declared - strategy.shortSyntheticFuture().return.market.spot: number; default: not declared - strategy.shortSyntheticFuture().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.shortSyntheticFuture().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.shortSyntheticFuture().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.shortSyntheticFuture().return.multiplier: number; default: not declared - strategy.shortSyntheticFuture().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.shortSyntheticFuture().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.shortSyntheticFuture().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.shortSyntheticFuture().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.shortSyntheticFuture().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.shortSyntheticFuture().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.shortSyntheticFuture().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.shortSyntheticFuture().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.shortSyntheticFuture().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.shortSyntheticFuture(config)?: PositionConfig | undefined; default: not declared - strategy.shortSyntheticFuture(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.shortSyntheticFuture(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.shortSyntheticFuture(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.shortSyntheticFuture(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.shortSyntheticFuture(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strategy.shortSyntheticFuture(input).callPremium?: number; default: not declared - strategy.shortSyntheticFuture(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.shortSyntheticFuture(input).putPremium?: number; default: not declared - strategy.shortSyntheticFuture(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.shortSyntheticFuture(input).strike: number; default: not declared - strategy.straddle: (input: import('@insiderfinance/totalfinance/strategy').StraddleInput, config?: PositionConfig) => Position; default: not declared - strategy.straddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.straddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.straddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.straddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.straddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.straddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.straddle().return.market.dividendYield?: number; default: not declared - strategy.straddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.straddle().return.market.riskFreeRate: number; default: not declared - strategy.straddle().return.market.spot: number; default: not declared - strategy.straddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.straddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.straddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.straddle().return.multiplier: number; default: not declared - strategy.straddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.straddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.straddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.straddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.straddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.straddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.straddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.straddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.straddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.straddle(config)?: PositionConfig | undefined; default: not declared - strategy.straddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.straddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.straddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.straddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.straddle(input): import('@insiderfinance/totalfinance/strategy').StraddleInput; default: not declared - strategy.straddle(input).callPremium?: number; default: not declared - strategy.straddle(input).expiry?: string; default: not declared - strategy.straddle(input).putPremium?: number; default: not declared - strategy.straddle(input).quantity?: number; default: not declared - strategy.straddle(input).strike: number; default: not declared — The shared strike (shared-strike rule: premiums are named per option type). - strategy.strangle: (input: import('@insiderfinance/totalfinance/strategy').StrangleInput, config?: PositionConfig) => Position; default: not declared - strategy.strangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.strangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.strangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.strangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.strangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.strangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.strangle().return.market.dividendYield?: number; default: not declared - strategy.strangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.strangle().return.market.riskFreeRate: number; default: not declared - strategy.strangle().return.market.spot: number; default: not declared - strategy.strangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.strangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.strangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.strangle().return.multiplier: number; default: not declared - strategy.strangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.strangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.strangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.strangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.strangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.strangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.strangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.strangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.strangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.strangle(config)?: PositionConfig | undefined; default: not declared - strategy.strangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.strangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.strangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.strangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.strangle(input): import('@insiderfinance/totalfinance/strategy').StrangleInput; default: not declared - strategy.strangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The call leg: a strike, or `{ strike, premium? }`. - strategy.strangle(input).expiry?: string; default: not declared - strategy.strangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The put leg: a strike, or `{ strike, premium? }`. - strategy.strangle(input).quantity?: number; default: not declared - strategy.strap: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strategy.strap().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.strap().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.strap().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.strap().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.strap().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.strap().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.strap().return.market.dividendYield?: number; default: not declared - strategy.strap().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.strap().return.market.riskFreeRate: number; default: not declared - strategy.strap().return.market.spot: number; default: not declared - strategy.strap().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.strap().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.strap().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.strap().return.multiplier: number; default: not declared - strategy.strap().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.strap().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.strap().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.strap().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.strap().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.strap().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.strap().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.strap().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.strap().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.strap(config)?: PositionConfig | undefined; default: not declared - strategy.strap(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.strap(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.strap(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.strap(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.strap(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strategy.strap(input).callPremium?: number; default: not declared - strategy.strap(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.strap(input).putPremium?: number; default: not declared - strategy.strap(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.strap(input).strike: number; default: not declared - strategy.strip: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strategy.strip().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.strip().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.strip().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.strip().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.strip().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.strip().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.strip().return.market.dividendYield?: number; default: not declared - strategy.strip().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.strip().return.market.riskFreeRate: number; default: not declared - strategy.strip().return.market.spot: number; default: not declared - strategy.strip().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.strip().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.strip().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.strip().return.multiplier: number; default: not declared - strategy.strip().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.strip().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.strip().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.strip().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.strip().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.strip().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.strip().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.strip().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.strip().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.strip(config)?: PositionConfig | undefined; default: not declared - strategy.strip(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.strip(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.strip(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.strip(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.strip(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strategy.strip(input).callPremium?: number; default: not declared - strategy.strip(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.strip(input).putPremium?: number; default: not declared - strategy.strip(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.strip(input).strike: number; default: not declared - strategy.syntheticPut: (input: import('@insiderfinance/totalfinance/strategy').SyntheticPutInput, config?: PositionConfig) => Position; default: not declared - strategy.syntheticPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategy.syntheticPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategy.syntheticPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategy.syntheticPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategy.syntheticPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategy.syntheticPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategy.syntheticPut().return.market.dividendYield?: number; default: not declared - strategy.syntheticPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategy.syntheticPut().return.market.riskFreeRate: number; default: not declared - strategy.syntheticPut().return.market.spot: number; default: not declared - strategy.syntheticPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategy.syntheticPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategy.syntheticPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategy.syntheticPut().return.multiplier: number; default: not declared - strategy.syntheticPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategy.syntheticPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategy.syntheticPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategy.syntheticPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategy.syntheticPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategy.syntheticPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategy.syntheticPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategy.syntheticPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategy.syntheticPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategy.syntheticPut(config)?: PositionConfig | undefined; default: not declared - strategy.syntheticPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategy.syntheticPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategy.syntheticPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategy.syntheticPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategy.syntheticPut(input): import('@insiderfinance/totalfinance/strategy').SyntheticPutInput; default: not declared - strategy.syntheticPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strategy.syntheticPut(input).premium?: number; default: not declared - strategy.syntheticPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strategy.syntheticPut(input).stockPrice: number; default: not declared — Entry price of the short stock leg. - strategy.syntheticPut(input).strike: number; default: not declared - strategyFromChain: (rows: import('@insiderfinance/totalfinance/core').OptionQuote[], options: import('@insiderfinance/totalfinance/strategy').FromChainOptions) => import('@insiderfinance/totalfinance/strategy').FromChainResult; default: not declared — Build a {@link Position} from an option chain. Returns the position, its resolved legs (premiums and per-leg IVs attached), and the fills (contract / premium / delta per leg). Missing quotes throw `strategy.strike_unavailable`; delta-targeted selection without deltas throws `strategy.delta_required`. - strategyFromChain().return.assumptions: { conventionsVersion: string; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; expiry: string; multiplier: number; quantity: number; }; default: not declared — C (hygiene): the conventions the selection applied — above all which quoted price became each premium. - strategyFromChain().return.assumptions.conventionsVersion: string; default: not declared - strategyFromChain().return.assumptions.expiry: string; default: not declared — The selection expiry (the NEAR expiry for a calendar). - strategyFromChain().return.assumptions.multiplier: number; default: not declared - strategyFromChain().return.assumptions.priceSource: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — The price source every premium was read from (`'mid'` by default; never a silent fallback). - strategyFromChain().return.assumptions.quantity: number; default: not declared - strategyFromChain().return.fills: import('@insiderfinance/totalfinance/strategy').ChainFill[]; default: not declared - strategyFromChain().return.legs: import('@insiderfinance/totalfinance/strategy').Leg[]; default: not declared - strategyFromChain().return.position: Position; default: not declared - strategyFromChain(options): import('@insiderfinance/totalfinance/strategy').FromChainOptions; default: not declared - strategyFromChain(rows): import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - strategyOf: (legs: readonly LegInput[], config?: PositionConfig) => Position; default: not declared — Build a position from legs. - strategyOf().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strategyOf().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strategyOf().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strategyOf().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strategyOf().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strategyOf().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strategyOf().return.market.dividendYield?: number; default: not declared - strategyOf().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strategyOf().return.market.riskFreeRate: number; default: not declared - strategyOf().return.market.spot: number; default: not declared - strategyOf().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strategyOf().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strategyOf().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strategyOf().return.multiplier: number; default: not declared - strategyOf().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strategyOf().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strategyOf().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strategyOf().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strategyOf().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strategyOf().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strategyOf().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strategyOf().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strategyOf().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strategyOf(config)?: PositionConfig | undefined; default: not declared - strategyOf(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strategyOf(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strategyOf(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strategyOf(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strategyOf(legs): readonly LegInput[]; default: not declared - strategySignature: (legs: readonly import('@insiderfinance/totalfinance/strategy').ClassifiableLeg[]) => string; default: not declared — Normalize legs to a structural BASE signature string (order-, scale-, and spacing-independent). Two leg lists share a base signature iff they have the same (kind, sign, strike-rank, quantity-ratio, expiry-rank) multiset — strike DISTANCES are deliberately not encoded (spacing distinguishes only butterflies from broken wings, handled as a tie-breaker in {@link classifyStrategy}, never here). - strategySignature(legs): readonly import('@insiderfinance/totalfinance/strategy').ClassifiableLeg[]; default: not declared - strip: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strip().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strip().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strip().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strip().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strip().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strip().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strip().return.market.dividendYield?: number; default: not declared - strip().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strip().return.market.riskFreeRate: number; default: not declared - strip().return.market.spot: number; default: not declared - strip().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strip().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strip().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strip().return.multiplier: number; default: not declared - strip().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strip().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strip().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strip().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strip().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strip().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strip().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strip().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strip().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strip(config)?: PositionConfig | undefined; default: not declared - strip(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strip(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strip(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strip(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strip(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strip(input).callPremium?: number; default: not declared - strip(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strip(input).putPremium?: number; default: not declared - strip(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strip(input).strike: number; default: not declared - syntheticPut: (input: import('@insiderfinance/totalfinance/strategy').SyntheticPutInput, config?: PositionConfig) => Position; default: not declared - syntheticPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - syntheticPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - syntheticPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - syntheticPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - syntheticPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - syntheticPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - syntheticPut().return.market.dividendYield?: number; default: not declared - syntheticPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - syntheticPut().return.market.riskFreeRate: number; default: not declared - syntheticPut().return.market.spot: number; default: not declared - syntheticPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - syntheticPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - syntheticPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - syntheticPut().return.multiplier: number; default: not declared - syntheticPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - syntheticPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - syntheticPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - syntheticPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - syntheticPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - syntheticPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - syntheticPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - syntheticPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - syntheticPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - syntheticPut(config)?: PositionConfig | undefined; default: not declared - syntheticPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - syntheticPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - syntheticPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - syntheticPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - syntheticPut(input): import('@insiderfinance/totalfinance/strategy').SyntheticPutInput; default: not declared - syntheticPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - syntheticPut(input).premium?: number; default: not declared - syntheticPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - syntheticPut(input).stockPrice: number; default: not declared — Entry price of the short stock leg. - syntheticPut(input).strike: number; default: not declared ### @insiderfinance/totalfinance#structure Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const structure: typeof import('@insiderfinance/totalfinance/structure'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ExposureProfile: typeof import('@insiderfinance/totalfinance/structure').ExposureProfile; default: not declared — A computed exposure profile with levels, by-strike/by-expiry views, and scenario maps. R2 envelope: the sign convention and every resolved knob live in `assumptions`; model limitations ride `diagnostics.warnings` as `model.limitation` entries — nothing is hoisted top-level. SELECTIVE (selective Greeks and exposure spec, decision 11). A profile built with `exposure({ …, metrics })` — or a shortcut such as {@link gammaExposure} — computed ONLY the selected metrics and the Black–Scholes outputs they need. Its rows and `aggregate` carry exactly those metrics; an uncomputed metric is ABSENT, never zero. `G` is the set the type guarantees (a literal selection) and `P` the set that may be present (a dynamic selection); both default to every metric — the full profile `exposure()` has always returned. - ExposureProfile().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate; default: not declared - ExposureProfile().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - ExposureProfile().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - ExposureProfile().return.byExpiry: (metrics?: readonly M[]) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - ExposureProfile().return.byStrike: (metrics?: readonly M[]) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - ExposureProfile().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - ExposureProfile().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - ExposureProfile().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - ExposureProfile().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - ExposureProfile().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - ExposureProfile().return.spot: number; default: not declared - ExposureProfile(request): import('@insiderfinance/totalfinance/structure').ExposureInput; default: not declared - ExposureProfile(request).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - ExposureProfile(request).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - ExposureProfile(request).metrics?: undefined; default: not declared — The exposures to compute, e.g. `['gex']` or `['gex', 'dex', 'vanna']`. Omit it for the full profile (every metric, exactly as before). A selection — explicit, nonempty, each name once — computes only those metrics and the Black–Scholes outputs they need, and is echoed in `assumptions.metrics`; uncomputed metrics are absent from the result, never zero. - ExposureProfile(request).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - FlowAnalysis: typeof import('@insiderfinance/totalfinance/structure').FlowAnalysis; default: not declared — Result of analyzing a stream of option trades. R2 envelope: the rules/windows ride `assumptions` and the heuristic caveats ride `diagnostics.warnings` as `model.limitation` entries — nothing is hoisted top-level. - FlowAnalysis().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ nbboRule: 'quote-rule-midpoint-unknown'; classificationSource: import('@insiderfinance/totalfinance/structure').FlowClassificationSource; sweepWindowMs: number; spreadWindowMs: number; sweepMinPrints: number; blockMinSize: number; blockMinPremium: number; multiplier: number; venueVerifiedSweeps: boolean; }>; default: not declared — The rules/windows the analysis ran under — echoed so a serialized report is self-interpreting. - FlowAnalysis().return.blocks: import('@insiderfinance/totalfinance/structure').ClassifiedTrade[]; default: not declared — Blocks: single prints large by size or premium. - FlowAnalysis().return.callPutPremium: () => import('@insiderfinance/totalfinance/structure').CallPutPremium; default: not declared — Call-vs-put premium and volume across all trades, with put/call ratios and net premium. - FlowAnalysis().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings: `model.limitation` caveats plus any data-quality flags. - FlowAnalysis().return.groupBy: (keys: Array) => import('@insiderfinance/totalfinance/structure').FlowGroup[]; default: not declared — Aggregate trades into groups keyed by any subset of underlying/expiry/strike/type. - FlowAnalysis().return.rank: (groups: import('@insiderfinance/totalfinance/structure').FlowGroup[], options?: import('@insiderfinance/totalfinance/structure').RankOptions) => import('@insiderfinance/totalfinance/structure').FlowGroup[]; default: not declared — Filter and sort groups (default: by premium, descending). - FlowAnalysis().return.spreads: readonly Readonly[]; default: not declared - FlowAnalysis().return.sweeps: readonly Readonly[]; default: not declared - FlowAnalysis().return.trades: readonly Readonly[]; default: not declared — Frozen result arrays — an analysis is a snapshot; mutate a copy, never the result. - FlowAnalysis().return.zeroDaysToExpiry: import('@insiderfinance/totalfinance/structure').ClassifiedTrade[]; default: not declared — 0DTE trades: prints on a contract expiring the same calendar day. - FlowAnalysis(options)?: import('@insiderfinance/totalfinance/structure').FlowOptions; default: not declared - FlowAnalysis(options).blockMinPremium?: number; default: not declared — ...or at/above this premium (price·size·multiplier). Default 100_000. - FlowAnalysis(options).blockMinSize?: number; default: not declared — A single print is a block at/above this size (contracts). Default 100. - FlowAnalysis(options).classificationSource?: import('@insiderfinance/totalfinance/structure').FlowClassificationSource; default: not declared — Classification authority/fallback rule. Default `'provided-or-quotes'` (legacy behavior). - FlowAnalysis(options).multiplier?: number; default: not declared — Contract multiplier when a trade omits one. Default 100. - FlowAnalysis(options).spreadWindowMs?: number; default: not declared — Prints on one underlying within this window (ms) across ≥2 contracts form a spread. Default 100. - FlowAnalysis(options).sweepMinPrints?: number; default: not declared — Minimum prints to call a cluster a sweep. Default 3. - FlowAnalysis(options).sweepWindowMs?: number; default: not declared — Prints on one contract within this window (ms), same side, count as one sweep. Default 500. - FlowAnalysis(rawTrades): import('@insiderfinance/totalfinance/core').OptionTrade[]; default: not declared - charmExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'charm'>; default: not declared — Charm exposure alone — the signed dollar-delta change as ONE calendar day elapses (`−∂DEX/∂T` per day). A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['charm'] })`. - charmExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'charm', 'charm'>; default: not declared - charmExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - charmExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'charm', 'charm'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - charmExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - charmExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - charmExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - charmExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - charmExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - charmExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - charmExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - charmExposure().return.spot: number; default: not declared - charmExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - charmExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - charmExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - charmExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - colorExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'color'>; default: not declared — Color exposure alone — the signed change in GEX as ONE calendar day elapses (`−∂GEX/∂T` per day), in the profile's `gammaUnit`. A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['color'] })`. - colorExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'color', 'color'>; default: not declared - colorExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - colorExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'color', 'color'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - colorExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - colorExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - colorExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - colorExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - colorExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - colorExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - colorExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - colorExposure().return.spot: number; default: not declared - colorExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - colorExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - colorExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - colorExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - deltaAdjustedPremium: (trades: readonly import('@insiderfinance/totalfinance/structure').DirectionalFlowTrade[]) => import('@insiderfinance/totalfinance/structure').DeltaAdjustedPremium; default: not declared — Delta-adjusted (delta-weighted) premium of a set of directional flow prints (spec §11.6, product review §4). Weighting premium by |delta| turns raw premium into an approximate directional exposure: deep-ITM bought calls move the tape far more than lottery-ticket wings of the same premium. A print leans **bullish** when it is a bought call or a sold put and **bearish** when it is a bought put or a sold call. Pure; greeks are an explicit input. - deltaAdjustedPremium().return.bearishPremium: number; default: not declared — Σ |delta|·premium over bearish prints (bought puts / sold calls). - deltaAdjustedPremium().return.bullishPremium: number; default: not declared — Σ |delta|·premium over prints whose directional lean is bullish (bought calls / sold puts). - deltaAdjustedPremium().return.netDirectional: number; default: not declared — `bullishPremium − bearishPremium` — net directional delta-adjusted premium (> 0 = net bullish). - deltaAdjustedPremium().return.totalDeltaAdjusted: number; default: not declared — Σ |delta|·premium regardless of direction — the total delta-weighted premium. - deltaAdjustedPremium(trades): readonly import('@insiderfinance/totalfinance/structure').DirectionalFlowTrade[]; default: not declared - deltaExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'dex'>; default: not declared — Delta exposure (DEX) alone — dollar delta (`Δ·OI·multiplier·spot`), signed by the convention. Computes delta only. Equivalent to `exposure({ ...input, metrics: ['dex'] })`. - deltaExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'dex', 'dex'>; default: not declared - deltaExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - deltaExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'dex', 'dex'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - deltaExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - deltaExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - deltaExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - deltaExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - deltaExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - deltaExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - deltaExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - deltaExposure().return.spot: number; default: not declared - deltaExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - deltaExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - deltaExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - deltaExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - exposure: (input: import('@insiderfinance/totalfinance/structure').ExposureInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile, import('@insiderfinance/totalfinance/structure').PossibleExposureMetrics>; default: not declared — Compute an exposure profile from an option chain. Omit `metrics` for the full profile. Pass `metrics` to compute only some exposures — a literal selection types the result precisely (`exposure({ …, metrics: ['gex'] }).aggregate.gex` is a `number`, `.dex` does not exist); a selection held in a variable types its metrics as optional. Name the full profile's types as `ExposureInput` and `ExposureProfile`: `Parameters` and `ReturnType` see the selection's general (dynamic) form. - exposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate, import('@insiderfinance/totalfinance/structure').PossibleExposureMetrics>; default: not declared - exposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - exposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure, import('@insiderfinance/totalfinance/structure').PossibleExposureMetrics>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - exposure().return.byExpiry: >(metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - exposure().return.byStrike: >(metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - exposure().return.contracts: readonly Readonly, import('@insiderfinance/totalfinance/structure').PossibleExposureMetrics>>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - exposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - exposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - exposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - exposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - exposure().return.spot: number; default: not declared - exposure(input): import('@insiderfinance/totalfinance/structure').ExposureInput; default: not declared - exposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - exposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - exposure(input).metrics?: S; default: not declared — The exposures to compute, e.g. `['gex']` or `['gex', 'dex', 'vanna']`. Omit it for the full profile (every metric, exactly as before). A selection — explicit, nonempty, each name once — computes only those metrics and the Black–Scholes outputs they need, and is echoed in `assumptions.metrics`; uncomputed metrics are absent from the result, never zero. - exposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - exposureFromGreeks: (request: import('@insiderfinance/totalfinance/structure').SuppliedExposureRequest) => import('@insiderfinance/totalfinance/structure').SuppliedExposureReport, import('@insiderfinance/totalfinance/structure').PossibleSuppliedExposureMetrics, B>; default: not declared — Account for caller-supplied signed Greeks at one spot snapshot. GEX is `gamma * openInterest * multiplier * gexSign * spot * (spot * 0.01)` for `per1PercentMove`, or `gamma * openInterest * multiplier * gexSign * spot` for `perPoint`. DEX is `delta * openInterest * multiplier * dexSign * spot`. A negative put delta is used unchanged: a negative DEX position sign reverses it ONCE. Gamma inputs are signed delta-per-spot-point, never dollar gamma or per-contract gamma. Quotes, contracts, Greeks and market observations are open to harmless decoration; the request, config and both convention objects are closed. Only consumed fields are validated/copied. Quote timestamp/source describe the supplied OI snapshot, not a fabricated exchange OI update. Caller must align currency, deliverable basis, source units and non-overlapping OI observations. Repeated underlying/type/style/strike/expiry identities are counted and warned, never silently deduplicated; differing multipliers, sources, timestamps and provider metadata do not hide repeats. Coverage describes only supplied quote rows, not a full market universe. Empty or entirely excluded chains produce empty sums, NOT an estimate that market exposure is zero. Every row is validated, including rows later excluded. Missing OI/Greeks, expired contracts (`expiresAt <= asOf`), future observations (`timestampMs > asOf`) and stale observations (`asOf - timestampMs > maximumObservationAgeMs`) are excluded with retained lineage. Zero OI is a valid included zero contribution. Missing multipliers require an explicit fallback. Contributions sort by expiry instant, strike, call-before-put, then original input index. Aggregates sort numerically by strike/expiry instant and include excluded-only buckets as zero. At most 100,000 dense quote rows and 512 characters per consumed string are accepted; lengths are refused before traversal. Nonrepresentable contributions or aggregates throw InputError. No rate/dividend model is invented and fixed supplied Greeks cannot yield scenario repricing, gamma flips, or model-driven hedging forecasts. Use exposure() for model-based scenarios. `metrics` selects GEX, DEX or both (omitted: both, exactly as before). `['gex']` reads only supplied gamma, `gexConvention` and `gammaUnit` — a row's delta may be absent — and `['dex']` only supplied delta and `dexConvention`. The unselected metric's contribution sign and value, totals, units and convention echoes are absent from the report (never zero), and `assumptions.metrics` echoes the selection. A GEX+DEX report requires both supplied Greeks on every row that supplies Greeks, so the two metrics always cover the same included rows. Modeled Greeks are never substituted. Name the report as `SuppliedExposureReport` and its input as `SuppliedExposureInput`: `Parameters` and `ReturnType<…>` see the selection's general (dynamic) form. `breakdowns: false` leaves out `byStrike` and `byExpiry` for a caller that aggregates the contributions itself: no grouping and no per-group exact totals (two thirds of the summation), with every other field unchanged and `assumptions.breakdowns` echoing the flag. - exposureFromGreeks().return.aggregate: import('@insiderfinance/totalfinance/structure').SuppliedExposureTotalsFor, import('@insiderfinance/totalfinance/structure').PossibleSuppliedExposureMetrics>; default: not declared - exposureFromGreeks().return.assumptions: import('@insiderfinance/totalfinance/structure').SuppliedExposureAssumptionsFor, import('@insiderfinance/totalfinance/structure').PossibleSuppliedExposureMetrics>; default: not declared - exposureFromGreeks().return.contributions: import('@insiderfinance/totalfinance/structure').SuppliedExposureContributionFor, import('@insiderfinance/totalfinance/structure').PossibleSuppliedExposureMetrics>[]; default: not declared - exposureFromGreeks().return.coverage: { scope: 'suppliedQuotesOnly'; status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; totalQuotes: number; includedQuotes: number; excludedQuotes: number; fraction: number | null; duplicateContractQuotes: number; duplicateIncludedContractQuotes: number; exclusionCounts: Record; }; default: not declared - exposureFromGreeks().return.coverage.duplicateContractQuotes: number; default: not declared — Rows beyond the first matching underlying/type/style/strike/expiry instant, across sources/times. - exposureFromGreeks().return.coverage.duplicateIncludedContractQuotes: number; default: not declared — Included rows beyond the first included matching identity; these can double-count OI. - exposureFromGreeks().return.coverage.excludedQuotes: number; default: not declared - exposureFromGreeks().return.coverage.exclusionCounts: Record; default: not declared — Counts overlap when a row has several reasons. - exposureFromGreeks().return.coverage.fraction: number | null; default: not declared — Included / supplied rows; null for an empty chain. Not coverage of an unknown full universe. - exposureFromGreeks().return.coverage.includedQuotes: number; default: not declared - exposureFromGreeks().return.coverage.scope: 'suppliedQuotesOnly'; default: not declared - exposureFromGreeks().return.coverage.status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; default: not declared - exposureFromGreeks().return.coverage.totalQuotes: number; default: not declared - exposureFromGreeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - exposureFromGreeks(request): import('@insiderfinance/totalfinance/structure').SuppliedExposureRequest; default: not declared - exposureFromGreeks(request).breakdowns?: B; default: not declared — `false` leaves `byStrike` and `byExpiry` out of the report: no grouping and no per-group exact totals, two thirds of the summation, for a caller that aggregates the contributions itself. Omitted or `true`: the released report. Contributions, aggregate, coverage and diagnostics are the same either way. - exposureFromGreeks(request).config: import('@insiderfinance/totalfinance/structure').SuppliedExposureRequestConfig; default: not declared - exposureFromGreeks(request).market: import('@insiderfinance/totalfinance/structure').SuppliedExposureMarket; default: not declared - exposureFromGreeks(request).metrics?: S; default: not declared — `['gex']`, `['dex']` or both. Omit for today's report (both). A GEX-only report needs only supplied gamma, `gexConvention` and `gammaUnit`; a DEX-only report only supplied delta and `dexConvention`. The unselected metric's fields are absent from the report, never zero. - exposureFromGreeks(request).quotes: readonly import('@insiderfinance/totalfinance/structure').SuppliedExposureRequestQuote[]; default: not declared - flow: (trades: import('@insiderfinance/totalfinance/core').OptionTrade[], options?: import('@insiderfinance/totalfinance/structure').FlowOptions) => import('@insiderfinance/totalfinance/structure').FlowAnalysis; default: not declared — Analyze a stream of option trades for aggressor, sweeps, blocks, and spreads. - flow().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ nbboRule: 'quote-rule-midpoint-unknown'; classificationSource: import('@insiderfinance/totalfinance/structure').FlowClassificationSource; sweepWindowMs: number; spreadWindowMs: number; sweepMinPrints: number; blockMinSize: number; blockMinPremium: number; multiplier: number; venueVerifiedSweeps: boolean; }>; default: not declared — The rules/windows the analysis ran under — echoed so a serialized report is self-interpreting. - flow().return.blocks: import('@insiderfinance/totalfinance/structure').ClassifiedTrade[]; default: not declared — Blocks: single prints large by size or premium. - flow().return.callPutPremium: () => import('@insiderfinance/totalfinance/structure').CallPutPremium; default: not declared — Call-vs-put premium and volume across all trades, with put/call ratios and net premium. - flow().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings: `model.limitation` caveats plus any data-quality flags. - flow().return.groupBy: (keys: Array) => import('@insiderfinance/totalfinance/structure').FlowGroup[]; default: not declared — Aggregate trades into groups keyed by any subset of underlying/expiry/strike/type. - flow().return.rank: (groups: import('@insiderfinance/totalfinance/structure').FlowGroup[], options?: import('@insiderfinance/totalfinance/structure').RankOptions) => import('@insiderfinance/totalfinance/structure').FlowGroup[]; default: not declared — Filter and sort groups (default: by premium, descending). - flow().return.spreads: readonly Readonly[]; default: not declared - flow().return.sweeps: readonly Readonly[]; default: not declared - flow().return.trades: readonly Readonly[]; default: not declared — Frozen result arrays — an analysis is a snapshot; mutate a copy, never the result. - flow().return.zeroDaysToExpiry: import('@insiderfinance/totalfinance/structure').ClassifiedTrade[]; default: not declared — 0DTE trades: prints on a contract expiring the same calendar day. - flow(options)?: import('@insiderfinance/totalfinance/structure').FlowOptions; default: not declared - flow(options).blockMinPremium?: number; default: not declared — ...or at/above this premium (price·size·multiplier). Default 100_000. - flow(options).blockMinSize?: number; default: not declared — A single print is a block at/above this size (contracts). Default 100. - flow(options).classificationSource?: import('@insiderfinance/totalfinance/structure').FlowClassificationSource; default: not declared — Classification authority/fallback rule. Default `'provided-or-quotes'` (legacy behavior). - flow(options).multiplier?: number; default: not declared — Contract multiplier when a trade omits one. Default 100. - flow(options).spreadWindowMs?: number; default: not declared — Prints on one underlying within this window (ms) across ≥2 contracts form a spread. Default 100. - flow(options).sweepMinPrints?: number; default: not declared — Minimum prints to call a cluster a sweep. Default 3. - flow(options).sweepWindowMs?: number; default: not declared — Prints on one contract within this window (ms), same side, count as one sweep. Default 500. - flow(trades): import('@insiderfinance/totalfinance/core').OptionTrade[]; default: not declared - gammaExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'gex'>; default: not declared — Gamma exposure (GEX) alone — the dollar change in dealer delta for a 1% spot move (`Γ·OI·multiplier·spot²·0.01`, or per point with `gammaUnit: 'perPoint'`), signed by the convention. Computes gamma only. Equivalent to `exposure({ ...input, metrics: ['gex'] })`; `atSpot` re-evaluates GEX per tick and `levels()` computes what it needs when called. - gammaExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'gex', 'gex'>; default: not declared - gammaExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - gammaExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'gex', 'gex'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - gammaExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - gammaExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - gammaExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - gammaExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - gammaExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - gammaExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - gammaExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - gammaExposure().return.spot: number; default: not declared - gammaExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - gammaExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - gammaExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - gammaExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - optionFlowDrift: (input: import('@insiderfinance/totalfinance/structure').OptionFlowDriftInput) => import('@insiderfinance/totalfinance/structure').OptionFlowDriftResult; default: not declared — Aggregate observed raw option trading premium for one explicit session. Example: `optionFlowDrift({ trades, session: { date: '2026-06-04' }, config: { symbol: 'SPY' } })`. Each minute/bucket exposes separate `change` and `cumulative` accounting. Buy calls / sell puts map to bullish premium and volume; sell calls / buy puts map to bearish. Unknowns move neither drift nor directional volume, but contribute all their premium to worst-case sign bounds. Classification coverage is a share of premium, NOT a success probability or confidence band. No delta weighting, dealer-position inference, multi-leg netting, fees, P&L, or income prediction. All combined premiums must already use one currency; this operation does not convert FX. Heuristics apply to the SAME window's totals: no prints/zero premium → no-signal; coverage below the threshold → low-coverage; opposing nonzero volume/premium signs → volume-opposed; call > 0 and put < 0 → bullish-expansion (reverse → bearish-expansion); remaining nonzero net → mixed-flow. These are descriptive accounting rules, not trading recommendations or measured predictiveness. Session/cutoff and bucket ends are exclusive. A bucket is a completed END-of-interval observation, not a value available at its start. Prices carry forward only from observations in this session; missing prices stay null. Overlay ties prefer underlying trades, then quotes, then option-print underlyingPrice, with last input winning within a source. Caller timestamps must express when data was available; embedded underlyingPrice is assumed available at its option print timestamp. Late vendor corrections/publication delays cannot be reconstructed from these fields alone. Trades are validated even outside scope, then stably sorted without mutation. Repeated explicit IDs fail. ID-less prints identical in the consumed trade fields fail (including sequence/venue); give genuinely distinct identical executions distinct IDs. Vendor metadata stays open. No print is silently deduplicated; malformed data or unrepresentable arithmetic throws typed InputError. - optionFlowDrift().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - optionFlowDrift().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - optionFlowDrift().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - optionFlowDrift().return.value: import('@insiderfinance/totalfinance/structure').OptionFlowDriftValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - optionFlowDrift(input): import('@insiderfinance/totalfinance/structure').OptionFlowDriftInput; default: not declared - optionFlowDrift(input).config?: import('@insiderfinance/totalfinance/structure').OptionFlowDriftConfig; default: not declared - optionFlowDrift(input).session: import('@insiderfinance/totalfinance/structure').OptionFlowDriftSession; default: not declared - optionFlowDrift(input).trades: readonly import('@insiderfinance/totalfinance/structure').OptionFlowDriftTrade[]; default: not declared - speedExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'speed'>; default: not declared — Speed exposure alone — the change in GEX for a +1% spot move, in the GEX unit (computes speed and gamma). A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['speed'] })`. - speedExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'speed', 'speed'>; default: not declared - speedExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - speedExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'speed', 'speed'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - speedExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - speedExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - speedExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - speedExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - speedExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - speedExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - speedExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - speedExposure().return.spot: number; default: not declared - speedExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - speedExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - speedExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - speedExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - thetaExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'theta'>; default: not declared — Theta exposure alone — dollar option-value decay per calendar day (`θ/day·OI·multiplier`). Equivalent to `exposure({ ...input, metrics: ['theta'] })`. - thetaExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'theta', 'theta'>; default: not declared - thetaExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - thetaExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'theta', 'theta'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - thetaExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - thetaExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - thetaExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - thetaExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - thetaExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - thetaExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - thetaExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - thetaExposure().return.spot: number; default: not declared - thetaExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - thetaExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - thetaExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - thetaExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - unusualness: (value: number, baseline: ArrayLike) => import('@insiderfinance/totalfinance/structure').Unusualness; default: not declared — Unusualness of a reading versus a caller-supplied baseline history (spec §11.6, product review §4): the z-score and percentile of `value` against `baseline` (e.g. today's contract volume vs. its trailing daily volumes). The baseline is bring-your-own — this package stores no history. A flat baseline has no defined spread, so the z-score is `null` (never fabricated). - unusualness().return.assumptions: { conventionsVersion: string; baselineLength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - unusualness().return.assumptions.baselineLength: number; default: not declared - unusualness().return.assumptions.conventionsVersion: string; default: not declared - unusualness().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — a flat baseline explains its null z. - unusualness().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - unusualness().return.mean: number; default: not declared - unusualness().return.percentile: number; default: not declared — Percentile of `value` within the baseline, in `[0, 100]` (share strictly below). - unusualness().return.stdev: number; default: not declared — Sample standard deviation of the baseline. - unusualness().return.zScore: number | null; default: not declared — `(value − mean) / stdev` of the baseline; `null` when the baseline is flat (no defined z). - unusualness(baseline): ArrayLike; default: not declared - unusualness(value): number; default: not declared - vannaExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'vanna'>; default: not declared — Vanna exposure alone — the dollar-delta change per +1% volatility (`vanna·OI·multiplier·spot·0.01`). A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['vanna'] })`. - vannaExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'vanna', 'vanna'>; default: not declared - vannaExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - vannaExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'vanna', 'vanna'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - vannaExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - vannaExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - vannaExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - vannaExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - vannaExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - vannaExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - vannaExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - vannaExposure().return.spot: number; default: not declared - vannaExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - vannaExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - vannaExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - vannaExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - vegaExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'vega'>; default: not declared — Vega exposure alone — the dollar change in option value per 1% (0.01) volatility move (`vega%·OI·multiplier`). Equivalent to `exposure({ ...input, metrics: ['vega'] })`. - vegaExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'vega', 'vega'>; default: not declared - vegaExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - vegaExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'vega', 'vega'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - vegaExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - vegaExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - vegaExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - vegaExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - vegaExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - vegaExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - vegaExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - vegaExposure().return.spot: number; default: not declared - vegaExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - vegaExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - vegaExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - vegaExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - vommaExposure: (input: import('@insiderfinance/totalfinance/structure').ExposureShortcutInput) => import('@insiderfinance/totalfinance/structure').ExposureProfile<'vomma'>; default: not declared — Vomma (volga) exposure alone — the change in vega exposure per +1% volatility. A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['vomma'] })`. - vommaExposure().return.aggregate: import('@insiderfinance/totalfinance/structure').ExposureAggregate<'vomma', 'vomma'>; default: not declared - vommaExposure().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: import('@insiderfinance/totalfinance/structure').GammaUnit; priceSource: import('@insiderfinance/totalfinance/core').PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly import('@insiderfinance/totalfinance/structure').ExposureMetric[]; }>; default: not declared - vommaExposure().return.atSpot: (spot: number) => import('@insiderfinance/totalfinance/structure').AtSpotExposure<'vomma', 'vomma'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - vommaExposure().return.byExpiry: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - vommaExposure().return.byStrike: (metrics?: readonly M[] | undefined) => import('@insiderfinance/totalfinance/structure').StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - vommaExposure().return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - vommaExposure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - vommaExposure().return.levels: (options?: { pinRiskBand?: number; }) => import('@insiderfinance/totalfinance/structure').Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - vommaExposure().return.netDrift: () => import('@insiderfinance/totalfinance/structure').NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - vommaExposure().return.scenarioMap: (options?: import('@insiderfinance/totalfinance/structure').ScenarioMapOptions) => import('@insiderfinance/totalfinance/structure').ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - vommaExposure().return.spot: number; default: not declared - vommaExposure(input): import('@insiderfinance/totalfinance/structure').ExposureShortcutInput; default: not declared - vommaExposure(input).config: import('@insiderfinance/totalfinance/structure').ExposureConfig; default: not declared - vommaExposure(input).market: import('@insiderfinance/totalfinance/structure').ExposureMarket; default: not declared - vommaExposure(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared ### @insiderfinance/totalfinance#technicalAnalysis Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const technicalAnalysis: typeof import('@insiderfinance/totalfinance/technical-analysis'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ALIAS_TABLE: readonly import('@insiderfinance/totalfinance/technical-analysis').IndicatorAliasRow[]; default: not declared — Curated TotalFinance ↔ TA-Lib ↔ pandas-ta ↔ TradingView name map. Grouped by family for readability; the order is informational only (resolution and the matrix index it independently). - BarAggregator: typeof import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; default: not declared - BarAggregator().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - BarAggregator().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - BarAggregator().return.restore: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - BarAggregator().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - BarAggregator(parameters): { kind: string; shouldClose: (accumulated: AggBar, bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => boolean; }; default: not declared - BarAggregator(parameters).kind: string; default: not declared - BarAggregator(parameters).shouldClose: (accumulated: AggBar, bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => boolean; default: not declared - CANDLE_SETTINGS: { readonly bodyLong: { readonly range: 'realBody'; readonly averagePeriod: 10; readonly factor: 1; }; readonly bodyVeryLong: { readonly range: 'realBody'; readonly averagePeriod: 10; readonly factor: 3; }; readonly bodyShort: { readonly range: 'realBody'; readonly averagePeriod: 10; readonly factor: 1; }; readonly bodyDoji: { readonly range: 'highLow'; readonly averagePeriod: 10; readonly factor: 0.1; }; readonly shadowLong: { readonly range: 'realBody'; readonly averagePeriod: 0; readonly factor: 1; }; readonly shadowVeryLong: { readonly range: 'realBody'; readonly averagePeriod: 0; readonly factor: 3; }; readonly shadowShort: { readonly range: 'shadows'; readonly averagePeriod: 10; readonly factor: 1; }; readonly shadowVeryShort: { readonly range: 'highLow'; readonly averagePeriod: 10; readonly factor: 0.1; }; readonly near: { readonly range: 'highLow'; readonly averagePeriod: 5; readonly factor: 0.2; }; readonly far: { readonly range: 'highLow'; readonly averagePeriod: 5; readonly factor: 0.6; }; readonly equal: { readonly range: 'highLow'; readonly averagePeriod: 5; readonly factor: 0.05; }; }; default: not declared — TA-Lib default candle settings (`TA_RestoreCandleDefaultSettings`). - CANDLE_SETTINGS.bodyDoji: { readonly range: 'highLow'; readonly averagePeriod: 10; readonly factor: 0.1; }; default: not declared - CANDLE_SETTINGS.bodyDoji.averagePeriod: 10; default: not declared - CANDLE_SETTINGS.bodyDoji.factor: 0.1; default: not declared - CANDLE_SETTINGS.bodyDoji.range: 'highLow'; default: not declared - CANDLE_SETTINGS.bodyLong: { readonly range: 'realBody'; readonly averagePeriod: 10; readonly factor: 1; }; default: not declared - CANDLE_SETTINGS.bodyLong.averagePeriod: 10; default: not declared - CANDLE_SETTINGS.bodyLong.factor: 1; default: not declared - CANDLE_SETTINGS.bodyLong.range: 'realBody'; default: not declared - CANDLE_SETTINGS.bodyShort: { readonly range: 'realBody'; readonly averagePeriod: 10; readonly factor: 1; }; default: not declared - CANDLE_SETTINGS.bodyShort.averagePeriod: 10; default: not declared - CANDLE_SETTINGS.bodyShort.factor: 1; default: not declared - CANDLE_SETTINGS.bodyShort.range: 'realBody'; default: not declared - CANDLE_SETTINGS.bodyVeryLong: { readonly range: 'realBody'; readonly averagePeriod: 10; readonly factor: 3; }; default: not declared - CANDLE_SETTINGS.bodyVeryLong.averagePeriod: 10; default: not declared - CANDLE_SETTINGS.bodyVeryLong.factor: 3; default: not declared - CANDLE_SETTINGS.bodyVeryLong.range: 'realBody'; default: not declared - CANDLE_SETTINGS.equal: { readonly range: 'highLow'; readonly averagePeriod: 5; readonly factor: 0.05; }; default: not declared - CANDLE_SETTINGS.equal.averagePeriod: 5; default: not declared - CANDLE_SETTINGS.equal.factor: 0.05; default: not declared - CANDLE_SETTINGS.equal.range: 'highLow'; default: not declared - CANDLE_SETTINGS.far: { readonly range: 'highLow'; readonly averagePeriod: 5; readonly factor: 0.6; }; default: not declared - CANDLE_SETTINGS.far.averagePeriod: 5; default: not declared - CANDLE_SETTINGS.far.factor: 0.6; default: not declared - CANDLE_SETTINGS.far.range: 'highLow'; default: not declared - CANDLE_SETTINGS.near: { readonly range: 'highLow'; readonly averagePeriod: 5; readonly factor: 0.2; }; default: not declared - CANDLE_SETTINGS.near.averagePeriod: 5; default: not declared - CANDLE_SETTINGS.near.factor: 0.2; default: not declared - CANDLE_SETTINGS.near.range: 'highLow'; default: not declared - CANDLE_SETTINGS.shadowLong: { readonly range: 'realBody'; readonly averagePeriod: 0; readonly factor: 1; }; default: not declared - CANDLE_SETTINGS.shadowLong.averagePeriod: 0; default: not declared - CANDLE_SETTINGS.shadowLong.factor: 1; default: not declared - CANDLE_SETTINGS.shadowLong.range: 'realBody'; default: not declared - CANDLE_SETTINGS.shadowShort: { readonly range: 'shadows'; readonly averagePeriod: 10; readonly factor: 1; }; default: not declared - CANDLE_SETTINGS.shadowShort.averagePeriod: 10; default: not declared - CANDLE_SETTINGS.shadowShort.factor: 1; default: not declared - CANDLE_SETTINGS.shadowShort.range: 'shadows'; default: not declared - CANDLE_SETTINGS.shadowVeryLong: { readonly range: 'realBody'; readonly averagePeriod: 0; readonly factor: 3; }; default: not declared - CANDLE_SETTINGS.shadowVeryLong.averagePeriod: 0; default: not declared - CANDLE_SETTINGS.shadowVeryLong.factor: 3; default: not declared - CANDLE_SETTINGS.shadowVeryLong.range: 'realBody'; default: not declared - CANDLE_SETTINGS.shadowVeryShort: { readonly range: 'highLow'; readonly averagePeriod: 10; readonly factor: 0.1; }; default: not declared - CANDLE_SETTINGS.shadowVeryShort.averagePeriod: 10; default: not declared - CANDLE_SETTINGS.shadowVeryShort.factor: 0.1; default: not declared - CANDLE_SETTINGS.shadowVeryShort.range: 'highLow'; default: not declared - CDL_ALIASES: Readonly>; default: not declared — TA-Lib `CDL*` function name → TotalFinance catalog name. - CandleView: typeof import('@insiderfinance/totalfinance/technical-analysis').CandleView; default: not declared — A read-only view of the last `len + 10` bars positioned at the current bar, exposing geometry and TA-Lib candle-average thresholds. `i` is an offset back from the current bar (0 = current, 1 = previous, …); the pattern spans offsets `0 … len − 1`. - CandleView().return.black: (index: number) => boolean; default: not declared - CandleView().return.body: (index: number) => number; default: not declared - CandleView().return.bodyAverage: number; default: not declared - CandleView().return.bodyGapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - CandleView().return.bodyGapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared — Real bodies of the two bars do not overlap, `barIndex` gapping up over `priorBarIndex`. - CandleView().return.bodyHigh: (index: number) => number; default: not declared - CandleView().return.bodyLow: (index: number) => number; default: not declared - CandleView().return.close: (index: number) => number; default: not declared - CandleView().return.dojiBody: (index: number) => boolean; default: not declared - CandleView().return.equalish: (first: number, second: number) => boolean; default: not declared - CandleView().return.far: (first: number, second: number) => boolean; default: not declared - CandleView().return.gapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - CandleView().return.gapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - CandleView().return.high: (index: number) => number; default: not declared - CandleView().return.longBody: (index: number) => boolean; default: not declared - CandleView().return.longLower: (index: number) => boolean; default: not declared - CandleView().return.longUpper: (index: number) => boolean; default: not declared - CandleView().return.low: (index: number) => number; default: not declared - CandleView().return.lower: (index: number) => number; default: not declared - CandleView().return.near: (first: number, second: number) => boolean; default: not declared - CandleView().return.open: (index: number) => number; default: not declared - CandleView().return.range: (index: number) => number; default: not declared - CandleView().return.rangeAverage10: number; default: not declared - CandleView().return.rangeAverage5: number; default: not declared - CandleView().return.shadowAverage: number; default: not declared - CandleView().return.shortBody: (index: number) => boolean; default: not declared - CandleView().return.shortLower: (index: number) => boolean; default: not declared - CandleView().return.shortUpper: (index: number) => boolean; default: not declared - CandleView().return.signedBody: (index: number) => number; default: not declared - CandleView().return.upper: (index: number) => number; default: not declared - CandleView().return.veryLongBody: (index: number) => boolean; default: not declared - CandleView().return.veryLongLower: (index: number) => boolean; default: not declared - CandleView().return.veryShortLower: (index: number) => boolean; default: not declared - CandleView().return.veryShortUpper: (index: number) => boolean; default: not declared - CandleView().return.white: (index: number) => boolean; default: not declared - CandleView(parameters): { history: import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; length: number; }; default: not declared - CandleView(parameters).history: import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - CandleView(parameters).length: number; default: not declared - CvdAggregator: typeof import('@insiderfinance/totalfinance/technical-analysis').CvdAggregator; default: not declared — Streaming, serializable cumulative-volume-delta aggregator — feed it trades (with optional aligned quotes) and it tracks running CVD and buy/sell volume. Mirrors the framework's stream ethos so it can be checkpointed and resumed mid-tape. - CvdAggregator().return.buyVolume: number; default: not declared - CvdAggregator().return.cumulative: number; default: not declared - CvdAggregator().return.next: (trade: import('@insiderfinance/totalfinance/technical-analysis').Trade, quote?: import('@insiderfinance/totalfinance/technical-analysis').Quote) => { sign: import('@insiderfinance/totalfinance/technical-analysis/microstructure').TradeDirection; delta: number; cumulative: number; }; default: not declared — Process one trade; returns `{ sign, delta, cumulative }` for it. - CvdAggregator().return.sellVolume: number; default: not declared - CvdAggregator().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared — Serialize as a {@link TechnicalAnalysisSnapshot}, like every other stream in the package. This class used to return a bare `Record` — no `kind`, no `schemaVersion`, no `state` — so it sat outside the envelope law entirely: its snapshot could not say which aggregator wrote it, could not be version-checked, and lost non-finite numbers to `JSON.stringify` with nothing to notice. The structural gate in `restorer-conformance` is what surfaced it; it was the only serializer in the package building an envelope by hand. - CvdAggregator(method)?: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; default: not declared - CvdAggregator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').CvdAggregator; default: not declared - CvdAggregator.fromJSON().return.buyVolume: number; default: not declared - CvdAggregator.fromJSON().return.cumulative: number; default: not declared - CvdAggregator.fromJSON().return.next: (trade: import('@insiderfinance/totalfinance/technical-analysis').Trade, quote?: import('@insiderfinance/totalfinance/technical-analysis').Quote) => { sign: import('@insiderfinance/totalfinance/technical-analysis/microstructure').TradeDirection; delta: number; cumulative: number; }; default: not declared — Process one trade; returns `{ sign, delta, cumulative }` for it. - CvdAggregator.fromJSON().return.sellVolume: number; default: not declared - CvdAggregator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared — Serialize as a {@link TechnicalAnalysisSnapshot}, like every other stream in the package. This class used to return a bare `Record` — no `kind`, no `schemaVersion`, no `state` — so it sat outside the envelope law entirely: its snapshot could not say which aggregator wrote it, could not be version-checked, and lost non-finite numbers to `JSON.stringify` with nothing to notice. The structural gate in `restorer-conformance` is what surfaced it; it was the only serializer in the package building an envelope by hand. - CvdAggregator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - CvdAggregator.fromJSON(snapshot).kind: string; default: not declared - CvdAggregator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - CvdAggregator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - FIB_EXTENSION_LEVELS: readonly [0, 0.618, 1, 1.618, 2, 2.618]; default: not declared - FIB_RETRACEMENT_LEVELS: readonly [0, 0.236, 0.382, 0.5, 0.618, 0.786, 1]; default: not declared - FeaturePipeline: typeof import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.applyBars: (indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: AliasOpt & { as: string; }) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — Apply any bar indicator (BarInput → Out) to the candles. - FeaturePipeline().return.applySeries: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: AliasOpt & { as: string; }) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — Apply any series indicator (number → Out) to a price field. The generic escape hatch that lets the pipeline reach every indicator in the catalog, not just the named convenience methods. - FeaturePipeline().return.atr: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — `parameters` is optional: ATR's Wilder period defaults to 14, exactly as `atr(bars)` does. - FeaturePipeline().return.bbands: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — `parameters` is optional: Bollinger's period defaults to 20, exactly as `bbands(series)` does. - FeaturePipeline().return.column: (alias: string, values: import('@insiderfinance/totalfinance/technical-analysis').FeatureColumn) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — Inject a precomputed column under an alias. - FeaturePipeline().return.ema: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.field: (field: import('@insiderfinance/totalfinance/technical-analysis').Field) => number[]; default: not declared — The raw `field` column (`close`, `high`, …) as a number array. - FeaturePipeline().return.macd: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.obv: (options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.returns: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.rollingVolatility: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.rsi: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — `parameters` is optional: RSI's period defaults to 14, exactly as `rsi(series)` does. - FeaturePipeline().return.sma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — The convenience methods all follow one order, and the order is the point: validate the alias, then CALL THE INDICATOR, then build the auto-name from the parameters it just accepted. The first version built the name first — `` `sma_${field}_${parameters.period}` `` — so a caller who omitted `parameters` got `TypeError: Cannot read properties of undefined (reading 'period')` from the pipeline instead of `sma`'s own teaching `InputError`. Worse for `rsi` and `atr`, whose direct forms default to 14: the fluent wrapper was STRICTER than the thing it wraps. Calling the indicator first delegates every parameter question to the validator that owns it. - FeaturePipeline().return.toColumns: () => Record; default: not declared — Columnar output keyed by alias. - FeaturePipeline().return.toRows: () => Record[]; default: not declared — Row-oriented output: one object per bar with each alias as a key. - FeaturePipeline().return.vwap: (options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline().return.wma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - FeaturePipeline(candles): import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - HilbertCore: typeof import('@insiderfinance/totalfinance/technical-analysis').HilbertCore; default: not declared — Shared Ehlers Hilbert-transform discriminator. Emits once the FIR history has filled (~6 bars). - HilbertCore().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - HilbertCore().return.update: (priceValue: number) => import('@insiderfinance/totalfinance/technical-analysis').HilbertOut | null; default: not declared - HilbertCore.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').HilbertCore; default: not declared - HilbertCore.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - HilbertCore.fromJSON().return.update: (priceValue: number) => import('@insiderfinance/totalfinance/technical-analysis').HilbertOut | null; default: not declared - HilbertCore.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - HilbertCore.fromJSON(snapshot).kind: string; default: not declared - HilbertCore.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - HilbertCore.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - InformationBarAggregator: typeof import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - InformationBarAggregator().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - InformationBarAggregator().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - InformationBarAggregator().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - InformationBarAggregator(parameters): { kind: string; weight: 'tick' | 'volume' | 'dollar'; mode: 'imbalance' | 'run'; threshold: number; }; default: not declared - InformationBarAggregator(parameters).kind: string; default: not declared - InformationBarAggregator(parameters).mode: 'imbalance' | 'run'; default: not declared - InformationBarAggregator(parameters).threshold: number; default: not declared - InformationBarAggregator(parameters).weight: 'tick' | 'volume' | 'dollar'; default: not declared - InformationBarAggregator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - InformationBarAggregator.fromJSON().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - InformationBarAggregator.fromJSON().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - InformationBarAggregator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - InformationBarAggregator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - InformationBarAggregator.fromJSON(snapshot).kind: string; default: not declared - InformationBarAggregator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - InformationBarAggregator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - LineBreakStream: typeof import('@insiderfinance/totalfinance/technical-analysis').LineBreakStream; default: not declared - LineBreakStream().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; default: not declared - LineBreakStream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - LineBreakStream(count): number; default: not declared - LineBreakStream.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakStream; default: not declared - LineBreakStream.fromJSON().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; default: not declared - LineBreakStream.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - LineBreakStream.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - LineBreakStream.fromJSON(snapshot).kind: string; default: not declared - LineBreakStream.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - LineBreakStream.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - PANDAS_CDL_ALIASES: Readonly>; default: not declared — pandas-ta `cdl_pattern(name=...)` pattern name → TotalFinance catalog name. - RenkoStream: typeof import('@insiderfinance/totalfinance/technical-analysis').RenkoStream; default: not declared - RenkoStream().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; default: not declared - RenkoStream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - RenkoStream(brick): number; default: not declared - RenkoStream.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').RenkoStream; default: not declared - RenkoStream.fromJSON().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; default: not declared - RenkoStream.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - RenkoStream.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - RenkoStream.fromJSON(snapshot).kind: string; default: not declared - RenkoStream.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - RenkoStream.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - RuleBuilder: typeof import('@insiderfinance/totalfinance/technical-analysis').RuleBuilder; default: not declared — Builds one rule as a chain of conditions. Evaluation is STRICT LEFT-TO-RIGHT with NO operator precedence: each `.and(c)` / `.or(c)` folds `c` into the accumulated result immediately, so `when(a).or(b).and(c)` evaluates as `(a || b) && c` — NOT `a || (b && c)`. When you need grouping, compose a single condition instead (e.g. with `condition()` / `not()`), or order the chain so left-to-right folding expresses your intent. - RuleBuilder().return.and: (condition: import('@insiderfinance/totalfinance/technical-analysis').Condition) => import('@insiderfinance/totalfinance/technical-analysis').RuleBuilder; default: not declared — Fold `c` into the accumulated result with AND (left-to-right, no precedence — class doc). - RuleBuilder().return.emit: (label: string) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Finalise the rule with a label and return to the signal builder. - RuleBuilder().return.or: (condition: import('@insiderfinance/totalfinance/technical-analysis').Condition) => import('@insiderfinance/totalfinance/technical-analysis').RuleBuilder; default: not declared — Fold `c` into the accumulated result with OR (left-to-right, no precedence — class doc). - RuleBuilder(__0): { owner: import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; first: import('@insiderfinance/totalfinance/technical-analysis').Condition; }; default: not declared - RuleBuilder(__0).first: import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - RuleBuilder(__0).owner: import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - SCHEMA_VERSION: 3; default: not declared — Current snapshot schema version. Bump when a stored snapshot's shape changes incompatibly. 2 — the flat `{ kind, v?, ...state }` shape became the explicit `{ kind, schemaVersion, state }` envelope. 3 — non-finite numbers inside `state` are ENCODED (see {@link encodeNonFinite}). Before this, `JSON.stringify` turned every one of them into `null`, so a snapshot could not round-trip through the very format it exists for. No legacy parser is retained at either step: pre-1.0 corrections are clean (law N9), and an older snapshot is rejected by {@link checkSnapshotVersion} with a teaching error rather than misread. - SignalBuilder: typeof import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - SignalBuilder().return.addRule: (rule: import('@insiderfinance/totalfinance/technical-analysis').Rule) => void; default: not declared - SignalBuilder().return.atr: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - SignalBuilder().return.columns: () => Record; default: not declared — The underlying feature columns (for inspection / charting). - SignalBuilder().return.ema: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - SignalBuilder().return.events: () => import('@insiderfinance/totalfinance/technical-analysis').SignalEvent[]; default: not declared — Only the bars that emitted, as `{ index, label }` events. - SignalBuilder().return.feature: (alias: string, values: unknown[]) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Inject a precomputed column. - SignalBuilder().return.rsi: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — `parameters` is optional on the default-bearing methods, matching both `FeaturePipeline` and the direct call: `rsi(closes)` resolves period 14, so `signal(bars).rsi('close')` must too. These two were left required when the pipeline's were relaxed, so the two fluent surfaces disagreed — the delegate compiled and the caller's identical call did not. - SignalBuilder().return.signals: () => (string | null)[]; default: not declared — Aligned labels: the first matching rule's label per bar, else `null`. - SignalBuilder().return.sma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - SignalBuilder().return.use: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: Required) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Apply any series indicator to a field under an alias. `options.as` is REQUIRED here: the generic escape hatch has no indicator-specific auto-name to fall back on. - SignalBuilder().return.useBars: (indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: Required) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Apply any bar indicator to the candles under an alias. `options.as` is required (see {@link use}). - SignalBuilder().return.when: (condition: import('@insiderfinance/totalfinance/technical-analysis').Condition) => import('@insiderfinance/totalfinance/technical-analysis').RuleBuilder; default: not declared - SignalBuilder().return.wma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - SignalBuilder(candles): import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - SignalContext: typeof import('@insiderfinance/totalfinance/technical-analysis').SignalContext; default: not declared - SignalContext().return.get: (operand: import('@insiderfinance/totalfinance/technical-analysis').Operand, barIndex: number) => number; default: not declared - SignalContext(parameters): { cols: Map; candles: import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; }; default: not declared - SignalContext(parameters).candles: import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - SignalContext(parameters).cols: Map; default: not declared - TALIB_CANDLE_NAMES: string[]; default: not declared — Pattern names implemented with exact TA-Lib adaptive parity in this module. - aberration: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - aberration(input): ArrayLike; default: not declared - aberration(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AberrationParameters | undefined; default: not declared - aberration(parameters).atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - aberration(parameters).period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. - aberration.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AberrationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - aberration.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - aberration.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - aberration.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - aberration.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - aberration.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - aberration.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - aberration.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - aberration.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - aberration.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - aberration.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - aberration.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - aberration.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - aberration.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - aberration.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - aberration.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - aberration.explain(input): ArrayLike; default: not declared - aberration.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AberrationParameters | undefined; default: not declared - aberration.explain(parameters).atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - aberration.explain(parameters).period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. - aberration.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - aberration.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint | null; default: not declared - aberration.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - aberration.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aberration.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint | null; default: not declared - aberration.fromJSON().return.value.atr: number; default: not declared — The ATR offset itself. - aberration.fromJSON().return.value.lowerBand: number; default: not declared — Lower band: zeroLine − ATR. - aberration.fromJSON().return.value.upperBand: number; default: not declared — Upper band: zeroLine + ATR. - aberration.fromJSON().return.value.zeroLine: number; default: not declared — Zero-line: SMA of HLC3. - aberration.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aberration.fromJSON(snapshot).kind: string; default: not declared - aberration.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - aberration.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - aberration.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AberrationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - aberration.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint | null; default: not declared - aberration.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - aberration.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aberration.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').AberrationPoint | null; default: not declared - aberration.stream().return.value.atr: number; default: not declared — The ATR offset itself. - aberration.stream().return.value.lowerBand: number; default: not declared — Lower band: zeroLine − ATR. - aberration.stream().return.value.upperBand: number; default: not declared — Upper band: zeroLine + ATR. - aberration.stream().return.value.zeroLine: number; default: not declared — Zero-line: SMA of HLC3. - aberration.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AberrationParameters | undefined; default: not declared - aberration.stream(parameters).atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - aberration.stream(parameters).period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. - accelerationBands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - accelerationBands(input): ArrayLike; default: not declared - accelerationBands(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AccelerationBandsParameters | undefined; default: not declared - accelerationBands(parameters).multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - accelerationBands(parameters).period?: number; default: not declared - accelerationBands.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AccelerationBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - accelerationBands.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - accelerationBands.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - accelerationBands.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - accelerationBands.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - accelerationBands.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - accelerationBands.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - accelerationBands.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - accelerationBands.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - accelerationBands.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - accelerationBands.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - accelerationBands.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - accelerationBands.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - accelerationBands.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - accelerationBands.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - accelerationBands.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - accelerationBands.explain(input): ArrayLike; default: not declared - accelerationBands.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AccelerationBandsParameters | undefined; default: not declared - accelerationBands.explain(parameters).multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - accelerationBands.explain(parameters).period?: number; default: not declared - accelerationBands.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - accelerationBands.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - accelerationBands.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - accelerationBands.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - accelerationBands.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - accelerationBands.fromJSON().return.value.lower: number; default: not declared - accelerationBands.fromJSON().return.value.middle: number; default: not declared - accelerationBands.fromJSON().return.value.upper: number; default: not declared - accelerationBands.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - accelerationBands.fromJSON(snapshot).kind: string; default: not declared - accelerationBands.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - accelerationBands.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - accelerationBands.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AccelerationBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - accelerationBands.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - accelerationBands.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - accelerationBands.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - accelerationBands.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - accelerationBands.stream().return.value.lower: number; default: not declared - accelerationBands.stream().return.value.middle: number; default: not declared - accelerationBands.stream().return.value.upper: number; default: not declared - accelerationBands.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AccelerationBandsParameters | undefined; default: not declared - accelerationBands.stream(parameters).multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - accelerationBands.stream(parameters).period?: number; default: not declared - acos: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - acos(input): ArrayLike; default: not declared - acos(parameters)?: {} | undefined; default: not declared - acos.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - acos.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - acos.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - acos.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - acos.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - acos.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - acos.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - acos.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - acos.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - acos.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - acos.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - acos.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - acos.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - acos.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - acos.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - acos.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - acos.explain(input): ArrayLike; default: not declared - acos.explain(parameters)?: {} | undefined; default: not declared - acos.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - acos.fromJSON().return.next: (input: number) => number | null; default: not declared - acos.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - acos.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - acos.fromJSON().return.value: number | null; default: not declared - acos.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - acos.fromJSON(snapshot).kind: string; default: not declared - acos.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - acos.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - acos.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - acos.stream().return.next: (input: number) => number | null; default: not declared - acos.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - acos.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - acos.stream().return.value: number | null; default: not declared - acos.stream(parameters)?: {} | undefined; default: not declared - adLine: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - adLine(input): ArrayLike; default: not declared - adLine(parameters)?: Record | undefined; default: not declared - adLine.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - adLine.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - adLine.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - adLine.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - adLine.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - adLine.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - adLine.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - adLine.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - adLine.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - adLine.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - adLine.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - adLine.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - adLine.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - adLine.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - adLine.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - adLine.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - adLine.explain(input): ArrayLike; default: not declared - adLine.explain(parameters)?: Record | undefined; default: not declared - adLine.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - adLine.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - adLine.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - adLine.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adLine.fromJSON().return.value: number | null; default: not declared - adLine.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adLine.fromJSON(snapshot).kind: string; default: not declared - adLine.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - adLine.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - adLine.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - adLine.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - adLine.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - adLine.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adLine.stream().return.value: number | null; default: not declared - adLine.stream(parameters)?: Record | undefined; default: not declared - add: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared - add(input): ArrayLike; default: not declared - add(parameters)?: {} | undefined; default: not declared - add.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - add.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - add.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - add.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - add.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - add.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - add.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - add.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - add.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - add.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - add.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - add.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - add.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - add.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - add.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - add.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - add.explain(input): ArrayLike; default: not declared - add.explain(parameters)?: {} | undefined; default: not declared - add.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - add.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - add.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - add.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - add.fromJSON().return.value: number | null; default: not declared - add.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - add.fromJSON(snapshot).kind: string; default: not declared - add.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - add.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - add.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - add.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - add.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - add.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - add.stream().return.value: number | null; default: not declared - add.stream(parameters)?: {} | undefined; default: not declared - adx: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - adx(input): ArrayLike; default: not declared - adx(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - adx(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - adx.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - adx.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - adx.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - adx.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - adx.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - adx.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - adx.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - adx.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - adx.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - adx.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - adx.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - adx.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - adx.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - adx.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - adx.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - adx.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').AdxPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - adx.explain(input): ArrayLike; default: not declared - adx.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - adx.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - adx.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - adx.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AdxPoint | null; default: not declared - adx.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AdxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - adx.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adx.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').AdxPoint | null; default: not declared - adx.fromJSON().return.value.adx: number; default: not declared - adx.fromJSON().return.value.minusDI: number; default: not declared - adx.fromJSON().return.value.plusDI: number; default: not declared - adx.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adx.fromJSON(snapshot).kind: string; default: not declared - adx.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - adx.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - adx.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - adx.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AdxPoint | null; default: not declared - adx.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AdxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - adx.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adx.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').AdxPoint | null; default: not declared - adx.stream().return.value.adx: number; default: not declared - adx.stream().return.value.minusDI: number; default: not declared - adx.stream().return.value.plusDI: number; default: not declared - adx.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - adx.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - adxr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - adxr(input): ArrayLike; default: not declared - adxr(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - adxr(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - adxr.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - adxr.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - adxr.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - adxr.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - adxr.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - adxr.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - adxr.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - adxr.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - adxr.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - adxr.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - adxr.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - adxr.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - adxr.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - adxr.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - adxr.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - adxr.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - adxr.explain(input): ArrayLike; default: not declared - adxr.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - adxr.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - adxr.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - adxr.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - adxr.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - adxr.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adxr.fromJSON().return.value: number | null; default: not declared - adxr.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adxr.fromJSON(snapshot).kind: string; default: not declared - adxr.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - adxr.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - adxr.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - adxr.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - adxr.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - adxr.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - adxr.stream().return.value: number | null; default: not declared - adxr.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - adxr.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - aggregators: { readonly range: (size: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; readonly tick: (count: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; readonly volume: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; readonly dollar: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; readonly imbalance: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; readonly volumeImbalance: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; readonly dollarImbalance: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; readonly run: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; readonly volumeRun: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; readonly dollarRun: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; }; default: not declared — Streaming aggregators for live bar construction (each returns completed bars per input bar). - aggregators.dollar: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; default: not declared - aggregators.dollar().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - aggregators.dollar().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.dollar().return.restore: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - aggregators.dollar().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.dollar(threshold): number; default: not declared - aggregators.dollarImbalance: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - aggregators.dollarImbalance().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.dollarImbalance().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.dollarImbalance().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.dollarImbalance(threshold): number; default: not declared - aggregators.dollarRun: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - aggregators.dollarRun().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.dollarRun().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.dollarRun().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.dollarRun(threshold): number; default: not declared - aggregators.imbalance: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - aggregators.imbalance().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.imbalance().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.imbalance().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.imbalance(threshold): number; default: not declared - aggregators.range: (size: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; default: not declared - aggregators.range().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - aggregators.range().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.range().return.restore: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - aggregators.range().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.range(size): number; default: not declared - aggregators.run: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - aggregators.run().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.run().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.run().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.run(threshold): number; default: not declared - aggregators.tick: (count: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; default: not declared - aggregators.tick().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - aggregators.tick().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.tick().return.restore: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - aggregators.tick().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.tick(count): number; default: not declared - aggregators.volume: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').BarAggregator; default: not declared - aggregators.volume().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - aggregators.volume().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.volume().return.restore: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - aggregators.volume().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.volume(threshold): number; default: not declared - aggregators.volumeImbalance: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - aggregators.volumeImbalance().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.volumeImbalance().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.volumeImbalance().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.volumeImbalance(threshold): number; default: not declared - aggregators.volumeRun: (threshold: number) => import('@insiderfinance/totalfinance/technical-analysis').InformationBarAggregator; default: not declared - aggregators.volumeRun().return.flush: () => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.volumeRun().return.next: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - aggregators.volumeRun().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aggregators.volumeRun(threshold): number; default: not declared - aliasesOf: (canonical: string) => import('@insiderfinance/totalfinance/technical-analysis').IndicatorAliasRow | undefined; default: not declared — The alias row for a canonical TotalFinance name, if one exists. - aliasesOf().return.pandas?: string | string[]; default: not declared — pandas-ta name(s), snake_case. - aliasesOf().return.talib?: string | string[]; default: not declared — TA-Lib function name(s), uppercase. - aliasesOf().return.totalfinance: string; default: not declared — Canonical TotalFinance name (must be registered). - aliasesOf().return.tradingview?: string; default: not declared — TradingView display name. - aliasesOf(canonical): string; default: not declared - alignToBars: (input: import('@insiderfinance/totalfinance/technical-analysis/resample').AlignToBarsInput) => number[]; default: not declared — Project a higher-timeframe series onto a lower-timeframe bar index, strictly causally (spec §13, WS6.2). `higherSeries[j]` is a value computed on `higherBars[j]`, whose bucket `[ts, ts + iv)` is usable only once it has CLOSED, i.e. at LTF times `≥ higherBars[j].timestampMs + intervalMs`. The LTF value at bar `i` is a step-hold of the last HTF bar that has closed by `lowerBars[i].timestampMs`; it is `NaN` before the first HTF bucket closes. No LTF output ever depends on an unclosed HTF bar — the `request.security` lookahead is impossible by construction. `higherBars` must be ascending by `timestampMs`. The interval is `options.intervalMs` if given, else inferred as the smallest positive gap between consecutive HTF bars (with a single HTF bar and no `intervalMs`, the bar never becomes usable and every output is `NaN`). - alignToBars(input): import('@insiderfinance/totalfinance/technical-analysis/resample').AlignToBarsInput; default: not declared - alignToBars(input).higherBars: ArrayLike; default: not declared - alignToBars(input).higherSeries: ArrayLike; default: not declared - alignToBars(input).lowerBars: ArrayLike; default: not declared - alignToBars(input).options?: import('@insiderfinance/totalfinance/technical-analysis').AlignOptions; default: not declared - alma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - alma(input): ArrayLike; default: not declared - alma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AlmaParameters | undefined; default: not declared - alma(parameters).offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - alma(parameters).period: number; default: not declared - alma(parameters).sigma?: number; default: not declared — Gaussian width. Default 6. - alma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AlmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - alma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - alma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - alma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - alma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - alma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - alma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - alma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - alma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - alma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - alma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - alma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - alma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - alma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - alma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - alma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - alma.explain(input): ArrayLike; default: not declared - alma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AlmaParameters | undefined; default: not declared - alma.explain(parameters).offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - alma.explain(parameters).period: number; default: not declared - alma.explain(parameters).sigma?: number; default: not declared — Gaussian width. Default 6. - alma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - alma.fromJSON().return.next: (input: number) => number | null; default: not declared - alma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - alma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - alma.fromJSON().return.value: number | null; default: not declared - alma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - alma.fromJSON(snapshot).kind: string; default: not declared - alma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - alma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - alma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AlmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - alma.stream().return.next: (input: number) => number | null; default: not declared - alma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - alma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - alma.stream().return.value: number | null; default: not declared - alma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AlmaParameters | undefined; default: not declared - alma.stream(parameters).offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - alma.stream(parameters).period: number; default: not declared - alma.stream(parameters).sigma?: number; default: not declared — Gaussian width. Default 6. - amat: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Archer Moving Averages Trends (pandas-ta `amat`). - amat(input): ArrayLike; default: not declared - amat(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AmatParameters | undefined; default: not declared - amat(parameters).fast?: number; default: not declared - amat(parameters).lookback?: number; default: not declared - amat(parameters).movingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageName; default: not declared - amat(parameters).slow?: number; default: not declared - amat.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AmatParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - amat.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - amat.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - amat.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - amat.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - amat.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - amat.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - amat.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - amat.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - amat.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - amat.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - amat.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - amat.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - amat.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - amat.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - amat.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').AmatPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - amat.explain(input): ArrayLike; default: not declared - amat.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AmatParameters | undefined; default: not declared - amat.explain(parameters).fast?: number; default: not declared - amat.explain(parameters).lookback?: number; default: not declared - amat.explain(parameters).movingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageName; default: not declared - amat.explain(parameters).slow?: number; default: not declared - amat.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - amat.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').AmatPoint | null; default: not declared - amat.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').AmatPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - amat.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - amat.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').AmatPoint | null; default: not declared - amat.fromJSON().return.value.long: number; default: not declared - amat.fromJSON().return.value.short: number; default: not declared - amat.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - amat.fromJSON(snapshot).kind: string; default: not declared - amat.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - amat.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - amat.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AmatParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - amat.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').AmatPoint | null; default: not declared - amat.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').AmatPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - amat.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - amat.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').AmatPoint | null; default: not declared - amat.stream().return.value.long: number; default: not declared - amat.stream().return.value.short: number; default: not declared - amat.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AmatParameters | undefined; default: not declared - amat.stream(parameters).fast?: number; default: not declared - amat.stream(parameters).lookback?: number; default: not declared - amat.stream(parameters).movingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageName; default: not declared - amat.stream(parameters).slow?: number; default: not declared - anchoredVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - anchoredVwap(input): ArrayLike; default: not declared - anchoredVwap(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapParameters | undefined; default: not declared - anchoredVwap(parameters).anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. - anchoredVwap.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - anchoredVwap.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - anchoredVwap.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - anchoredVwap.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - anchoredVwap.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - anchoredVwap.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - anchoredVwap.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - anchoredVwap.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - anchoredVwap.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - anchoredVwap.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - anchoredVwap.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - anchoredVwap.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - anchoredVwap.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - anchoredVwap.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - anchoredVwap.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - anchoredVwap.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - anchoredVwap.explain(input): ArrayLike; default: not declared - anchoredVwap.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapParameters | undefined; default: not declared - anchoredVwap.explain(parameters).anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. - anchoredVwap.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - anchoredVwap.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - anchoredVwap.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - anchoredVwap.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - anchoredVwap.fromJSON().return.value: number | null; default: not declared - anchoredVwap.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - anchoredVwap.fromJSON(snapshot).kind: string; default: not declared - anchoredVwap.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - anchoredVwap.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - anchoredVwap.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - anchoredVwap.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - anchoredVwap.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - anchoredVwap.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - anchoredVwap.stream().return.value: number | null; default: not declared - anchoredVwap.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapParameters | undefined; default: not declared - anchoredVwap.stream(parameters).anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. - apo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - apo(input): ArrayLike; default: not declared - apo(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ApoParameters | undefined; default: not declared - apo(parameters).fast?: number; default: not declared - apo(parameters).slow?: number; default: not declared - apo.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ApoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - apo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - apo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - apo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - apo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - apo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - apo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - apo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - apo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - apo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - apo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - apo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - apo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - apo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - apo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - apo.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - apo.explain(input): ArrayLike; default: not declared - apo.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ApoParameters | undefined; default: not declared - apo.explain(parameters).fast?: number; default: not declared - apo.explain(parameters).slow?: number; default: not declared - apo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - apo.fromJSON().return.next: (input: number) => number | null; default: not declared - apo.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - apo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - apo.fromJSON().return.value: number | null; default: not declared - apo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - apo.fromJSON(snapshot).kind: string; default: not declared - apo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - apo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - apo.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ApoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - apo.stream().return.next: (input: number) => number | null; default: not declared - apo.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - apo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - apo.stream().return.value: number | null; default: not declared - apo.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ApoParameters | undefined; default: not declared - apo.stream(parameters).fast?: number; default: not declared - apo.stream(parameters).slow?: number; default: not declared - archerObv: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - archerObv(input): ArrayLike; default: not declared - archerObv(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvParameters | undefined; default: not declared - archerObv(parameters).fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - archerObv(parameters).runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - archerObv(parameters).slow?: number; default: not declared — Slow EMA length on OBV. Default 12. - archerObv.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - archerObv.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - archerObv.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - archerObv.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - archerObv.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - archerObv.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - archerObv.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - archerObv.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - archerObv.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - archerObv.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - archerObv.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - archerObv.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - archerObv.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - archerObv.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - archerObv.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - archerObv.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - archerObv.explain(input): ArrayLike; default: not declared - archerObv.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvParameters | undefined; default: not declared - archerObv.explain(parameters).fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - archerObv.explain(parameters).runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - archerObv.explain(parameters).slow?: number; default: not declared — Slow EMA length on OBV. Default 12. - archerObv.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - archerObv.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint | null; default: not declared - archerObv.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - archerObv.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - archerObv.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint | null; default: not declared - archerObv.fromJSON().return.value.fast: number; default: not declared — Fast EMA of OBV. - archerObv.fromJSON().return.value.long: number; default: not declared — 1 when both EMAs are rising over `runLength` — a long-run signal. - archerObv.fromJSON().return.value.obv: number; default: not declared - archerObv.fromJSON().return.value.short: number; default: not declared — 1 when both EMAs are falling over `runLength` — a short-run signal. - archerObv.fromJSON().return.value.slow: number; default: not declared — Slow EMA of OBV. - archerObv.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - archerObv.fromJSON(snapshot).kind: string; default: not declared - archerObv.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - archerObv.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - archerObv.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - archerObv.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint | null; default: not declared - archerObv.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - archerObv.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - archerObv.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvPoint | null; default: not declared - archerObv.stream().return.value.fast: number; default: not declared — Fast EMA of OBV. - archerObv.stream().return.value.long: number; default: not declared — 1 when both EMAs are rising over `runLength` — a long-run signal. - archerObv.stream().return.value.obv: number; default: not declared - archerObv.stream().return.value.short: number; default: not declared — 1 when both EMAs are falling over `runLength` — a short-run signal. - archerObv.stream().return.value.slow: number; default: not declared — Slow EMA of OBV. - archerObv.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ArcherObvParameters | undefined; default: not declared - archerObv.stream(parameters).fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - archerObv.stream(parameters).runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - archerObv.stream(parameters).slow?: number; default: not declared — Slow EMA length on OBV. Default 12. - aroon: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').AroonPoint>; default: not declared - aroon(input): ArrayLike; default: not declared - aroon(parameters)?: { period?: number; } | undefined; default: not declared - aroon(parameters).period?: number; default: not declared - aroon.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - aroon.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - aroon.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - aroon.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - aroon.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - aroon.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - aroon.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - aroon.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - aroon.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - aroon.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - aroon.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - aroon.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - aroon.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - aroon.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - aroon.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - aroon.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').AroonPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - aroon.explain(input): ArrayLike; default: not declared - aroon.explain(parameters)?: { period?: number; } | undefined; default: not declared - aroon.explain(parameters).period?: number; default: not declared - aroon.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - aroon.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AroonPoint | null; default: not declared - aroon.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AroonPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - aroon.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aroon.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').AroonPoint | null; default: not declared - aroon.fromJSON().return.value.down: number; default: not declared - aroon.fromJSON().return.value.up: number; default: not declared - aroon.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aroon.fromJSON(snapshot).kind: string; default: not declared - aroon.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - aroon.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - aroon.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - aroon.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AroonPoint | null; default: not declared - aroon.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AroonPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - aroon.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aroon.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').AroonPoint | null; default: not declared - aroon.stream().return.value.down: number; default: not declared - aroon.stream().return.value.up: number; default: not declared - aroon.stream(parameters)?: { period?: number; } | undefined; default: not declared - aroon.stream(parameters).period?: number; default: not declared - aroonOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - aroonOscillator(input): ArrayLike; default: not declared - aroonOscillator(parameters)?: { period?: number; } | undefined; default: not declared - aroonOscillator(parameters).period?: number; default: not declared - aroonOscillator.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - aroonOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - aroonOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - aroonOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - aroonOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - aroonOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - aroonOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - aroonOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - aroonOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - aroonOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - aroonOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - aroonOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - aroonOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - aroonOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - aroonOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - aroonOscillator.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - aroonOscillator.explain(input): ArrayLike; default: not declared - aroonOscillator.explain(parameters)?: { period?: number; } | undefined; default: not declared - aroonOscillator.explain(parameters).period?: number; default: not declared - aroonOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - aroonOscillator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - aroonOscillator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - aroonOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aroonOscillator.fromJSON().return.value: number | null; default: not declared - aroonOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aroonOscillator.fromJSON(snapshot).kind: string; default: not declared - aroonOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - aroonOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - aroonOscillator.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - aroonOscillator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - aroonOscillator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - aroonOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - aroonOscillator.stream().return.value: number | null; default: not declared - aroonOscillator.stream(parameters)?: { period?: number; } | undefined; default: not declared - aroonOscillator.stream(parameters).period?: number; default: not declared - asin: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - asin(input): ArrayLike; default: not declared - asin(parameters)?: {} | undefined; default: not declared - asin.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - asin.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - asin.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - asin.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - asin.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - asin.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - asin.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - asin.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - asin.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - asin.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - asin.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - asin.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - asin.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - asin.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - asin.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - asin.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - asin.explain(input): ArrayLike; default: not declared - asin.explain(parameters)?: {} | undefined; default: not declared - asin.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - asin.fromJSON().return.next: (input: number) => number | null; default: not declared - asin.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - asin.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - asin.fromJSON().return.value: number | null; default: not declared - asin.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - asin.fromJSON(snapshot).kind: string; default: not declared - asin.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - asin.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - asin.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - asin.stream().return.next: (input: number) => number | null; default: not declared - asin.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - asin.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - asin.stream().return.value: number | null; default: not declared - asin.stream(parameters)?: {} | undefined; default: not declared - atan: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - atan(input): ArrayLike; default: not declared - atan(parameters)?: {} | undefined; default: not declared - atan.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - atan.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - atan.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - atan.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - atan.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - atan.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - atan.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - atan.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - atan.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - atan.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - atan.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - atan.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - atan.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - atan.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - atan.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - atan.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - atan.explain(input): ArrayLike; default: not declared - atan.explain(parameters)?: {} | undefined; default: not declared - atan.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atan.fromJSON().return.next: (input: number) => number | null; default: not declared - atan.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atan.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atan.fromJSON().return.value: number | null; default: not declared - atan.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atan.fromJSON(snapshot).kind: string; default: not declared - atan.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - atan.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - atan.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atan.stream().return.next: (input: number) => number | null; default: not declared - atan.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atan.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atan.stream().return.value: number | null; default: not declared - atan.stream(parameters)?: {} | undefined; default: not declared - atr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - atr(input): ArrayLike; default: not declared - atr(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - atr(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - atr.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - atr.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - atr.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - atr.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - atr.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - atr.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - atr.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - atr.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - atr.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - atr.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - atr.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - atr.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - atr.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - atr.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - atr.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - atr.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - atr.explain(input): ArrayLike; default: not declared - atr.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - atr.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - atr.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atr.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - atr.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atr.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atr.fromJSON().return.value: number | null; default: not declared - atr.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atr.fromJSON(snapshot).kind: string; default: not declared - atr.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - atr.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - atr.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atr.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - atr.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atr.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atr.stream().return.value: number | null; default: not declared - atr.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - atr.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - atrBands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — ATR Bands — SMA(close) ± multiplier·ATR (an SMA-centred ATR channel). - atrBands(input): ArrayLike; default: not declared - atrBands(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AtrBandsParameters | undefined; default: not declared - atrBands(parameters).multiplier?: number; default: not declared - atrBands(parameters).period?: number; default: not declared - atrBands.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AtrBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - atrBands.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - atrBands.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - atrBands.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - atrBands.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - atrBands.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - atrBands.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - atrBands.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - atrBands.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - atrBands.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - atrBands.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - atrBands.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - atrBands.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - atrBands.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - atrBands.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - atrBands.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - atrBands.explain(input): ArrayLike; default: not declared - atrBands.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AtrBandsParameters | undefined; default: not declared - atrBands.explain(parameters).multiplier?: number; default: not declared - atrBands.explain(parameters).period?: number; default: not declared - atrBands.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atrBands.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - atrBands.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atrBands.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atrBands.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - atrBands.fromJSON().return.value.lower: number; default: not declared - atrBands.fromJSON().return.value.middle: number; default: not declared - atrBands.fromJSON().return.value.upper: number; default: not declared - atrBands.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atrBands.fromJSON(snapshot).kind: string; default: not declared - atrBands.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - atrBands.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - atrBands.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AtrBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atrBands.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - atrBands.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atrBands.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atrBands.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - atrBands.stream().return.value.lower: number; default: not declared - atrBands.stream().return.value.middle: number; default: not declared - atrBands.stream().return.value.upper: number; default: not declared - atrBands.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AtrBandsParameters | undefined; default: not declared - atrBands.stream(parameters).multiplier?: number; default: not declared - atrBands.stream(parameters).period?: number; default: not declared - atrTrailingStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — ATR trailing stop (Vervoort / UT-Bot): close-anchored `close ± multiplier·ATR`, trailed per leg. - atrTrailingStop(input): ArrayLike; default: not declared - atrTrailingStop(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AtrTrailingStopParameters | undefined; default: not declared - atrTrailingStop(parameters).multiplier?: number; default: not declared - atrTrailingStop(parameters).period?: number; default: not declared - atrTrailingStop.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AtrTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - atrTrailingStop.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - atrTrailingStop.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - atrTrailingStop.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - atrTrailingStop.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - atrTrailingStop.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - atrTrailingStop.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - atrTrailingStop.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - atrTrailingStop.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - atrTrailingStop.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - atrTrailingStop.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - atrTrailingStop.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - atrTrailingStop.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - atrTrailingStop.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - atrTrailingStop.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - atrTrailingStop.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - atrTrailingStop.explain(input): ArrayLike; default: not declared - atrTrailingStop.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AtrTrailingStopParameters | undefined; default: not declared - atrTrailingStop.explain(parameters).multiplier?: number; default: not declared - atrTrailingStop.explain(parameters).period?: number; default: not declared - atrTrailingStop.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atrTrailingStop.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - atrTrailingStop.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atrTrailingStop.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atrTrailingStop.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - atrTrailingStop.fromJSON().return.value.stop: number; default: not declared — The trailing stop line. - atrTrailingStop.fromJSON().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - atrTrailingStop.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atrTrailingStop.fromJSON(snapshot).kind: string; default: not declared - atrTrailingStop.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - atrTrailingStop.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - atrTrailingStop.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AtrTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - atrTrailingStop.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - atrTrailingStop.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - atrTrailingStop.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - atrTrailingStop.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - atrTrailingStop.stream().return.value.stop: number; default: not declared — The trailing stop line. - atrTrailingStop.stream().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - atrTrailingStop.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AtrTrailingStopParameters | undefined; default: not declared - atrTrailingStop.stream(parameters).multiplier?: number; default: not declared - atrTrailingStop.stream(parameters).period?: number; default: not declared - averagePrice: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - averagePrice(input): ArrayLike; default: not declared - averagePrice(parameters)?: {} | undefined; default: not declared - averagePrice.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - averagePrice.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - averagePrice.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - averagePrice.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - averagePrice.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - averagePrice.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - averagePrice.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - averagePrice.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - averagePrice.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - averagePrice.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - averagePrice.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - averagePrice.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - averagePrice.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - averagePrice.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - averagePrice.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - averagePrice.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - averagePrice.explain(input): ArrayLike; default: not declared - averagePrice.explain(parameters)?: {} | undefined; default: not declared - averagePrice.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - averagePrice.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - averagePrice.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - averagePrice.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - averagePrice.fromJSON().return.value: number | null; default: not declared - averagePrice.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - averagePrice.fromJSON(snapshot).kind: string; default: not declared - averagePrice.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - averagePrice.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - averagePrice.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - averagePrice.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - averagePrice.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - averagePrice.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - averagePrice.stream().return.value: number | null; default: not declared - averagePrice.stream(parameters)?: {} | undefined; default: not declared - awesomeOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - awesomeOscillator(input): ArrayLike; default: not declared - awesomeOscillator(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AwesomeParameters | undefined; default: not declared - awesomeOscillator(parameters).fast?: number; default: not declared - awesomeOscillator(parameters).slow?: number; default: not declared - awesomeOscillator.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').AwesomeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - awesomeOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - awesomeOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - awesomeOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - awesomeOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - awesomeOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - awesomeOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - awesomeOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - awesomeOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - awesomeOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - awesomeOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - awesomeOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - awesomeOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - awesomeOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - awesomeOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - awesomeOscillator.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - awesomeOscillator.explain(input): ArrayLike; default: not declared - awesomeOscillator.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AwesomeParameters | undefined; default: not declared - awesomeOscillator.explain(parameters).fast?: number; default: not declared - awesomeOscillator.explain(parameters).slow?: number; default: not declared - awesomeOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - awesomeOscillator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - awesomeOscillator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - awesomeOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - awesomeOscillator.fromJSON().return.value: number | null; default: not declared - awesomeOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - awesomeOscillator.fromJSON(snapshot).kind: string; default: not declared - awesomeOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - awesomeOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - awesomeOscillator.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').AwesomeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - awesomeOscillator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - awesomeOscillator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - awesomeOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - awesomeOscillator.stream().return.value: number | null; default: not declared - awesomeOscillator.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').AwesomeParameters | undefined; default: not declared - awesomeOscillator.stream(parameters).fast?: number; default: not declared - awesomeOscillator.stream(parameters).slow?: number; default: not declared - bar: { readonly open: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly typical: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly median: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly weighted: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly average: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly body: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly upperShadow: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly lowerShadow: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly range: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; readonly trueRange: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, previousClose: number) => number; }; default: not declared - bar.average: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.average(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.average(bar).close: number; default: not declared - bar.average(bar).high: number; default: not declared - bar.average(bar).low: number; default: not declared - bar.average(bar).open?: number; default: not declared - bar.average(bar).volume?: number; default: not declared - bar.average(rest): []; default: not declared - bar.body: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.body(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.body(bar).close: number; default: not declared - bar.body(bar).high: number; default: not declared - bar.body(bar).low: number; default: not declared - bar.body(bar).open?: number; default: not declared - bar.body(bar).volume?: number; default: not declared - bar.body(rest): []; default: not declared - bar.lowerShadow: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.lowerShadow(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.lowerShadow(bar).close: number; default: not declared - bar.lowerShadow(bar).high: number; default: not declared - bar.lowerShadow(bar).low: number; default: not declared - bar.lowerShadow(bar).open?: number; default: not declared - bar.lowerShadow(bar).volume?: number; default: not declared - bar.lowerShadow(rest): []; default: not declared - bar.median: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.median(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.median(bar).close: number; default: not declared - bar.median(bar).high: number; default: not declared - bar.median(bar).low: number; default: not declared - bar.median(bar).open?: number; default: not declared - bar.median(bar).volume?: number; default: not declared - bar.median(rest): []; default: not declared - bar.open: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.open(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.open(bar).close: number; default: not declared - bar.open(bar).high: number; default: not declared - bar.open(bar).low: number; default: not declared - bar.open(bar).open?: number; default: not declared - bar.open(bar).volume?: number; default: not declared - bar.open(rest): []; default: not declared - bar.range: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.range(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.range(bar).close: number; default: not declared - bar.range(bar).high: number; default: not declared - bar.range(bar).low: number; default: not declared - bar.range(bar).open?: number; default: not declared - bar.range(bar).volume?: number; default: not declared - bar.range(rest): []; default: not declared - bar.trueRange: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, previousClose: number) => number; default: not declared - bar.trueRange(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.trueRange(bar).close: number; default: not declared - bar.trueRange(bar).high: number; default: not declared - bar.trueRange(bar).low: number; default: not declared - bar.trueRange(bar).open?: number; default: not declared - bar.trueRange(bar).volume?: number; default: not declared - bar.trueRange(rest): [previousClose: number]; default: not declared - bar.typical: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.typical(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.typical(bar).close: number; default: not declared - bar.typical(bar).high: number; default: not declared - bar.typical(bar).low: number; default: not declared - bar.typical(bar).open?: number; default: not declared - bar.typical(bar).volume?: number; default: not declared - bar.typical(rest): []; default: not declared - bar.upperShadow: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.upperShadow(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.upperShadow(bar).close: number; default: not declared - bar.upperShadow(bar).high: number; default: not declared - bar.upperShadow(bar).low: number; default: not declared - bar.upperShadow(bar).open?: number; default: not declared - bar.upperShadow(bar).volume?: number; default: not declared - bar.upperShadow(rest): []; default: not declared - bar.weighted: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared - bar.weighted(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - bar.weighted(bar).close: number; default: not declared - bar.weighted(bar).high: number; default: not declared - bar.weighted(bar).low: number; default: not declared - bar.weighted(bar).open?: number; default: not declared - bar.weighted(bar).volume?: number; default: not declared - bar.weighted(rest): []; default: not declared - barSince: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; default: not declared — Bars since the input condition (`> 0`) was last true (0 on a true bar; NaN before the first). - barSince(input): ArrayLike; default: not declared - barSince(parameters)?: Record | undefined; default: not declared - barSince.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - barSince.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - barSince.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - barSince.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - barSince.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - barSince.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - barSince.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - barSince.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - barSince.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - barSince.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - barSince.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - barSince.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - barSince.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - barSince.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - barSince.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - barSince.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - barSince.explain(input): ArrayLike; default: not declared - barSince.explain(parameters)?: Record | undefined; default: not declared - barSince.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - barSince.fromJSON().return.next: (input: number) => number | null; default: not declared - barSince.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - barSince.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - barSince.fromJSON().return.value: number | null; default: not declared - barSince.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - barSince.fromJSON(snapshot).kind: string; default: not declared - barSince.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - barSince.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - barSince.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - barSince.stream().return.next: (input: number) => number | null; default: not declared - barSince.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - barSince.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - barSince.stream().return.value: number | null; default: not declared - barSince.stream(parameters)?: Record | undefined; default: not declared - barsFromColumns: (columns: import('@insiderfinance/totalfinance/technical-analysis').BarColumns) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Convert columnar OHLCV arrays into bar rows. All supplied columns must be arrays of one shared length; omitted columns are simply absent from the rows. Throws typed teaching errors on shape garbage — never returns a partial result. - barsFromColumns(columns): import('@insiderfinance/totalfinance/technical-analysis').BarColumns; default: not declared - barsFromColumns(columns).close?: readonly number[]; default: not declared - barsFromColumns(columns).high?: readonly number[]; default: not declared - barsFromColumns(columns).low?: readonly number[]; default: not declared - barsFromColumns(columns).open?: readonly number[]; default: not declared - barsFromColumns(columns).volume?: readonly number[]; default: not declared - bb: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - bb(input): ArrayLike; default: not declared - bb(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined; default: not declared - bb(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bb(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - bb.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - bb.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - bb.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - bb.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - bb.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - bb.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - bb.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - bb.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - bb.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - bb.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - bb.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - bb.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - bb.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - bb.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - bb.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bb.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bb.explain(input): ArrayLike; default: not declared - bb.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined; default: not declared - bb.explain(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bb.explain(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - bb.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bb.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bb.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bb.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bb.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bb.fromJSON().return.value.bandwidth: number; default: not declared - bb.fromJSON().return.value.lower: number; default: not declared - bb.fromJSON().return.value.middle: number; default: not declared - bb.fromJSON().return.value.percentB: number; default: not declared - bb.fromJSON().return.value.upper: number; default: not declared - bb.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bb.fromJSON(snapshot).kind: string; default: not declared - bb.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - bb.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - bb.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bb.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bb.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bb.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bb.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bb.stream().return.value.bandwidth: number; default: not declared - bb.stream().return.value.lower: number; default: not declared - bb.stream().return.value.middle: number; default: not declared - bb.stream().return.value.percentB: number; default: not declared - bb.stream().return.value.upper: number; default: not declared - bb.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined; default: not declared - bb.stream(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bb.stream(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - bbands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - bbands(input): ArrayLike; default: not declared - bbands(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined; default: not declared - bbands(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bbands(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - bbands.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - bbands.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - bbands.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - bbands.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - bbands.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - bbands.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - bbands.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - bbands.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - bbands.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - bbands.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - bbands.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - bbands.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - bbands.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - bbands.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - bbands.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bbands.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bbands.explain(input): ArrayLike; default: not declared - bbands.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined; default: not declared - bbands.explain(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bbands.explain(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - bbands.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bbands.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bbands.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bbands.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bbands.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bbands.fromJSON().return.value.bandwidth: number; default: not declared - bbands.fromJSON().return.value.lower: number; default: not declared - bbands.fromJSON().return.value.middle: number; default: not declared - bbands.fromJSON().return.value.percentB: number; default: not declared - bbands.fromJSON().return.value.upper: number; default: not declared - bbands.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bbands.fromJSON(snapshot).kind: string; default: not declared - bbands.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - bbands.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - bbands.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bbands.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bbands.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bbands.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bbands.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').BollingerPoint | null; default: not declared - bbands.stream().return.value.bandwidth: number; default: not declared - bbands.stream().return.value.lower: number; default: not declared - bbands.stream().return.value.middle: number; default: not declared - bbands.stream().return.value.percentB: number; default: not declared - bbands.stream().return.value.upper: number; default: not declared - bbands.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters | undefined; default: not declared - bbands.stream(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bbands.stream(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - beta: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - beta(input): ArrayLike; default: not declared - beta(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - beta(parameters).period: number; default: not declared - beta.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - beta.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - beta.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - beta.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - beta.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - beta.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - beta.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - beta.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - beta.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - beta.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - beta.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - beta.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - beta.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - beta.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - beta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - beta.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - beta.explain(input): ArrayLike; default: not declared - beta.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - beta.explain(parameters).period: number; default: not declared - beta.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - beta.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - beta.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - beta.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - beta.fromJSON().return.value: number | null; default: not declared - beta.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - beta.fromJSON(snapshot).kind: string; default: not declared - beta.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - beta.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - beta.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - beta.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - beta.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - beta.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - beta.stream().return.value: number | null; default: not declared - beta.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - beta.stream(parameters).period: number; default: not declared - between: (operand: import('@insiderfinance/totalfinance/technical-analysis').Operand, low: number, high: number) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - between().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - between(high): number; default: not declared - between(low): number; default: not declared - between(operand): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - bias: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - bias(input): ArrayLike; default: not declared - bias(parameters)?: { period?: number; } | undefined; default: not declared - bias(parameters).period?: number; default: not declared - bias.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - bias.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - bias.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - bias.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - bias.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - bias.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - bias.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - bias.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - bias.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - bias.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - bias.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - bias.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - bias.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - bias.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - bias.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bias.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bias.explain(input): ArrayLike; default: not declared - bias.explain(parameters)?: { period?: number; } | undefined; default: not declared - bias.explain(parameters).period?: number; default: not declared - bias.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bias.fromJSON().return.next: (input: number) => number | null; default: not declared - bias.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bias.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bias.fromJSON().return.value: number | null; default: not declared - bias.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bias.fromJSON(snapshot).kind: string; default: not declared - bias.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - bias.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - bias.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bias.stream().return.next: (input: number) => number | null; default: not declared - bias.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bias.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bias.stream().return.value: number | null; default: not declared - bias.stream(parameters)?: { period?: number; } | undefined; default: not declared - bias.stream(parameters).period?: number; default: not declared - bollingerBandWidth: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - bollingerBandWidth(input): ArrayLike; default: not declared - bollingerBandWidth(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined; default: not declared - bollingerBandWidth(parameters).period: number; default: not declared - bollingerBandWidth(parameters).standardDeviation?: number; default: not declared - bollingerBandWidth.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - bollingerBandWidth.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - bollingerBandWidth.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - bollingerBandWidth.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - bollingerBandWidth.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - bollingerBandWidth.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - bollingerBandWidth.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - bollingerBandWidth.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - bollingerBandWidth.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - bollingerBandWidth.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - bollingerBandWidth.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - bollingerBandWidth.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - bollingerBandWidth.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - bollingerBandWidth.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - bollingerBandWidth.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bollingerBandWidth.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bollingerBandWidth.explain(input): ArrayLike; default: not declared - bollingerBandWidth.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined; default: not declared - bollingerBandWidth.explain(parameters).period: number; default: not declared - bollingerBandWidth.explain(parameters).standardDeviation?: number; default: not declared - bollingerBandWidth.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bollingerBandWidth.fromJSON().return.next: (input: number) => number | null; default: not declared - bollingerBandWidth.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bollingerBandWidth.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bollingerBandWidth.fromJSON().return.value: number | null; default: not declared - bollingerBandWidth.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bollingerBandWidth.fromJSON(snapshot).kind: string; default: not declared - bollingerBandWidth.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - bollingerBandWidth.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - bollingerBandWidth.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bollingerBandWidth.stream().return.next: (input: number) => number | null; default: not declared - bollingerBandWidth.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bollingerBandWidth.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bollingerBandWidth.stream().return.value: number | null; default: not declared - bollingerBandWidth.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined; default: not declared - bollingerBandWidth.stream(parameters).period: number; default: not declared - bollingerBandWidth.stream(parameters).standardDeviation?: number; default: not declared - bollingerPercentB: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - bollingerPercentB(input): ArrayLike; default: not declared - bollingerPercentB(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined; default: not declared - bollingerPercentB(parameters).period: number; default: not declared - bollingerPercentB(parameters).standardDeviation?: number; default: not declared - bollingerPercentB.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - bollingerPercentB.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - bollingerPercentB.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - bollingerPercentB.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - bollingerPercentB.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - bollingerPercentB.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - bollingerPercentB.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - bollingerPercentB.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - bollingerPercentB.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - bollingerPercentB.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - bollingerPercentB.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - bollingerPercentB.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - bollingerPercentB.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - bollingerPercentB.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - bollingerPercentB.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bollingerPercentB.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bollingerPercentB.explain(input): ArrayLike; default: not declared - bollingerPercentB.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined; default: not declared - bollingerPercentB.explain(parameters).period: number; default: not declared - bollingerPercentB.explain(parameters).standardDeviation?: number; default: not declared - bollingerPercentB.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bollingerPercentB.fromJSON().return.next: (input: number) => number | null; default: not declared - bollingerPercentB.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bollingerPercentB.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bollingerPercentB.fromJSON().return.value: number | null; default: not declared - bollingerPercentB.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bollingerPercentB.fromJSON(snapshot).kind: string; default: not declared - bollingerPercentB.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - bollingerPercentB.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - bollingerPercentB.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bollingerPercentB.stream().return.next: (input: number) => number | null; default: not declared - bollingerPercentB.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bollingerPercentB.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bollingerPercentB.stream().return.value: number | null; default: not declared - bollingerPercentB.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').BollingerParameters | undefined; default: not declared - bollingerPercentB.stream(parameters).period: number; default: not declared - bollingerPercentB.stream(parameters).standardDeviation?: number; default: not declared - bookImbalance: import('@insiderfinance/totalfinance/core').SeriesFacade<[book: import('@insiderfinance/totalfinance/technical-analysis').OrderBook, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BookImbalanceParameters | undefined], number | null, { conventionsVersion: string; levels: number; weighted: boolean; }>; default: not declared — Plain imbalance; use `.explain()` for effective depth, weighting, and null diagnostics. - bookImbalance(callArguments): [book: import('@insiderfinance/totalfinance/technical-analysis').OrderBook, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BookImbalanceParameters | undefined]; default: not declared - bookImbalance.explain: (book: import('@insiderfinance/totalfinance/technical-analysis').OrderBook, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BookImbalanceParameters | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - bookImbalance.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; levels: number; weighted: boolean; }>; default: not declared — Every applied convention, echoed back. - bookImbalance.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - bookImbalance.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bookImbalance.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bookImbalance.explain(callArguments): [book: import('@insiderfinance/totalfinance/technical-analysis').OrderBook, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BookImbalanceParameters | undefined]; default: not declared - bop: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - bop(input): ArrayLike; default: not declared - bop(parameters)?: {} | undefined; default: not declared - bop.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - bop.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - bop.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - bop.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - bop.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - bop.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - bop.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - bop.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - bop.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - bop.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - bop.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - bop.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - bop.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - bop.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - bop.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - bop.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - bop.explain(input): ArrayLike; default: not declared - bop.explain(parameters)?: {} | undefined; default: not declared - bop.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bop.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - bop.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bop.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bop.fromJSON().return.value: number | null; default: not declared - bop.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bop.fromJSON(snapshot).kind: string; default: not declared - bop.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - bop.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - bop.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - bop.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - bop.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - bop.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - bop.stream().return.value: number | null; default: not declared - bop.stream(parameters)?: {} | undefined; default: not declared - brar: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').BrarPoint>; default: not declared - brar(input): ArrayLike; default: not declared - brar(parameters)?: { period?: number; } | undefined; default: not declared - brar(parameters).period?: number; default: not declared - brar.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - brar.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - brar.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - brar.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - brar.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - brar.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - brar.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - brar.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - brar.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - brar.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - brar.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - brar.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - brar.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - brar.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - brar.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - brar.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').BrarPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - brar.explain(input): ArrayLike; default: not declared - brar.explain(parameters)?: { period?: number; } | undefined; default: not declared - brar.explain(parameters).period?: number; default: not declared - brar.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - brar.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BrarPoint | null; default: not declared - brar.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BrarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - brar.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - brar.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').BrarPoint | null; default: not declared - brar.fromJSON().return.value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - brar.fromJSON().return.value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - brar.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - brar.fromJSON(snapshot).kind: string; default: not declared - brar.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - brar.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - brar.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - brar.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BrarPoint | null; default: not declared - brar.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').BrarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - brar.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - brar.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').BrarPoint | null; default: not declared - brar.stream().return.value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - brar.stream().return.value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - brar.stream(parameters)?: { period?: number; } | undefined; default: not declared - brar.stream(parameters).period?: number; default: not declared - breakouts: (bars: ArrayLike, options?: { lookback?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').BreakoutsReport; default: not declared — Breakout signal aligned to the input: at each bar, `+1` if the close exceeds the highest high of the prior `lookback` bars, `−1` if it breaks below the lowest low, else `0` (null during warmup). - breakouts().return.assumptions: { conventionsVersion: string; lookback: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - breakouts().return.assumptions.conventionsVersion: string; default: not declared - breakouts().return.assumptions.lookback: number; default: not declared - breakouts().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - breakouts().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - breakouts().return.signal: (number | null)[]; default: not declared — Aligned to the input: `+1` when the close exceeds the highest high of the prior `lookback` bars, `−1` below the lowest low, `0` otherwise — `null` during the lookback warmup. - breakouts(bars): ArrayLike; default: not declared - breakouts(options)?: { lookback?: number; }; default: not declared - breakouts(options).lookback?: number; default: not declared - candleAverage: (bars: ArrayLike, setting: import('@insiderfinance/totalfinance/technical-analysis').CandleSetting) => number[]; default: not declared — TA-Lib's `TA_CANDLEAVERAGE` at every bar: `factor · (avg of `range` over the preceding `averagePeriod` bars) / denom`, where `denom = 2` for the Shadows range type (it sums two shadows) else `1`. With `averagePeriod = 0` the current bar's own range is used. Bars before the trailing window is full get `NaN` (the pattern is in its lookback there). - candleAverage(bars): ArrayLike; default: not declared - candleAverage(setting): import('@insiderfinance/totalfinance/technical-analysis').CandleSetting; default: not declared - candleAverage(setting).averagePeriod: number; default: not declared — Trailing-average period; 0 means "use the current bar's range" (no averaging). - candleAverage(setting).factor: number; default: not declared - candleAverage(setting).range: import('@insiderfinance/totalfinance/technical-analysis').CandleRangeType; default: not declared - candleColor: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number; default: not declared — Candle color: +1 white (close ≥ open), −1 black. - candleColor(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - candleColor(bar).close: number; default: not declared - candleColor(bar).high: number; default: not declared - candleColor(bar).low: number; default: not declared - candleColor(bar).open?: number; default: not declared - candleColor(bar).volume?: number; default: not declared - candleRange: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - candleRange(input): ArrayLike; default: not declared - candleRange(parameters)?: {} | undefined; default: not declared - candleRange.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - candleRange.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - candleRange.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - candleRange.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - candleRange.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - candleRange.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - candleRange.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - candleRange.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - candleRange.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - candleRange.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - candleRange.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - candleRange.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - candleRange.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - candleRange.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - candleRange.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - candleRange.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - candleRange.explain(input): ArrayLike; default: not declared - candleRange.explain(parameters)?: {} | undefined; default: not declared - candleRange.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - candleRange.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - candleRange.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - candleRange.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - candleRange.fromJSON().return.value: number | null; default: not declared - candleRange.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - candleRange.fromJSON(snapshot).kind: string; default: not declared - candleRange.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - candleRange.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - candleRange.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - candleRange.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - candleRange.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - candleRange.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - candleRange.stream().return.value: number | null; default: not declared - candleRange.stream(parameters)?: {} | undefined; default: not declared - candlestickNames: string[]; default: not declared — Names of every catalogued candlestick pattern. - candlesticks: Record>; default: not declared — All candlestick patterns, keyed by name → an aligned batch+stream indicator emitting ±100 / 0. - cci: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - cci(input): ArrayLike; default: not declared - cci(parameters)?: { period?: number; } | undefined; default: not declared - cci(parameters).period?: number; default: not declared - cci.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cci.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cci.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cci.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cci.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cci.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cci.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cci.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cci.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cci.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cci.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cci.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cci.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cci.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cci.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cci.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cci.explain(input): ArrayLike; default: not declared - cci.explain(parameters)?: { period?: number; } | undefined; default: not declared - cci.explain(parameters).period?: number; default: not declared - cci.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cci.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cci.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cci.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cci.fromJSON().return.value: number | null; default: not declared - cci.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cci.fromJSON(snapshot).kind: string; default: not declared - cci.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cci.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cci.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cci.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cci.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cci.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cci.stream().return.value: number | null; default: not declared - cci.stream(parameters)?: { period?: number; } | undefined; default: not declared - cci.stream(parameters).period?: number; default: not declared - cdlClosingMarubozuTalib: (bars: ArrayLike) => number[]; default: not declared — CDLCLOSINGMARUBOZU (TA-Lib): a long real body where the shadow on the *close* side is shorter than `ShadowVeryShort` (the open-side shadow is unconstrained) → ±100 by color, else 0. - cdlClosingMarubozuTalib(bars): ArrayLike; default: not declared - cdlDoji: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Dedicated Doji pattern accessor (pandas-ta `cdl_doji`). - cdlDoji(input): ArrayLike; default: not declared - cdlDoji(parameters)?: {} | undefined; default: not declared - cdlDoji.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cdlDoji.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cdlDoji.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cdlDoji.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cdlDoji.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cdlDoji.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cdlDoji.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cdlDoji.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cdlDoji.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cdlDoji.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cdlDoji.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cdlDoji.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cdlDoji.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cdlDoji.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cdlDoji.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cdlDoji.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cdlDoji.explain(input): ArrayLike; default: not declared - cdlDoji.explain(parameters)?: {} | undefined; default: not declared - cdlDoji.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cdlDoji.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cdlDoji.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cdlDoji.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlDoji.fromJSON().return.value: number | null; default: not declared - cdlDoji.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlDoji.fromJSON(snapshot).kind: string; default: not declared - cdlDoji.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cdlDoji.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cdlDoji.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cdlDoji.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cdlDoji.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cdlDoji.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlDoji.stream().return.value: number | null; default: not declared - cdlDoji.stream(parameters)?: {} | undefined; default: not declared - cdlDojiTalib: (bars: ArrayLike) => number[]; default: not declared — CDLDOJI (TA-Lib): +100 when the real body is no larger than `BodyDoji`'s adaptive threshold (a fraction of the trailing high-low average), else 0. Doji is non-directional, so it is never −100. - cdlDojiTalib(bars): ArrayLike; default: not declared - cdlInside: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Inside-bar pattern (TA-Lib `CDLINSIDE`): +100 bullish inside, −100 bearish inside, else 0. - cdlInside(input): ArrayLike; default: not declared - cdlInside(parameters)?: {} | undefined; default: not declared - cdlInside.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cdlInside.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cdlInside.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cdlInside.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cdlInside.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cdlInside.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cdlInside.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cdlInside.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cdlInside.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cdlInside.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cdlInside.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cdlInside.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cdlInside.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cdlInside.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cdlInside.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cdlInside.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cdlInside.explain(input): ArrayLike; default: not declared - cdlInside.explain(parameters)?: {} | undefined; default: not declared - cdlInside.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cdlInside.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cdlInside.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cdlInside.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlInside.fromJSON().return.value: number | null; default: not declared - cdlInside.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlInside.fromJSON(snapshot).kind: string; default: not declared - cdlInside.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cdlInside.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cdlInside.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cdlInside.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cdlInside.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cdlInside.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlInside.stream().return.value: number | null; default: not declared - cdlInside.stream(parameters)?: {} | undefined; default: not declared - cdlMarubozuTalib: (bars: ArrayLike) => number[]; default: not declared — CDLMARUBOZU (TA-Lib): a long real body (`BodyLong`) with both shadows shorter than the `ShadowVeryShort` threshold → ±100 by candle color (white +100, black −100), else 0. - cdlMarubozuTalib(bars): ArrayLike; default: not declared - cdlPattern: { (bars: ArrayLike, name: string): number[]; (bars: ArrayLike, name: 'all'): import('@insiderfinance/totalfinance/technical-analysis').CandleMatch[][]; }; default: not declared — Run a single candlestick pattern by TotalFinance or TA-Lib name, returning the aligned ±100/0 series. Pass `'all'` to scan the full catalog (returns per-bar matches instead). - cdlPattern(bars): ArrayLike; default: not declared - cdlPattern(name): ('all') | (string); default: not declared - cdlZ: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — pandas-ta `cdl_z`: rolling sample z-score normalization of OHLC candles. - cdlZ(input): ArrayLike; default: not declared - cdlZ(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CandleZParameters | undefined; default: not declared - cdlZ(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - cdlZ(parameters).period?: number; default: not declared - cdlZ.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').CandleZParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cdlZ.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cdlZ.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cdlZ.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cdlZ.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cdlZ.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cdlZ.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cdlZ.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cdlZ.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cdlZ.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cdlZ.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cdlZ.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cdlZ.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cdlZ.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cdlZ.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cdlZ.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cdlZ.explain(input): ArrayLike; default: not declared - cdlZ.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CandleZParameters | undefined; default: not declared - cdlZ.explain(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - cdlZ.explain(parameters).period?: number; default: not declared - cdlZ.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cdlZ.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint | null; default: not declared - cdlZ.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cdlZ.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlZ.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint | null; default: not declared - cdlZ.fromJSON().return.value.close: number; default: not declared - cdlZ.fromJSON().return.value.high: number; default: not declared - cdlZ.fromJSON().return.value.low: number; default: not declared - cdlZ.fromJSON().return.value.open: number; default: not declared - cdlZ.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlZ.fromJSON(snapshot).kind: string; default: not declared - cdlZ.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cdlZ.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cdlZ.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').CandleZParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cdlZ.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint | null; default: not declared - cdlZ.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cdlZ.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cdlZ.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').CandleZPoint | null; default: not declared - cdlZ.stream().return.value.close: number; default: not declared - cdlZ.stream().return.value.high: number; default: not declared - cdlZ.stream().return.value.low: number; default: not declared - cdlZ.stream().return.value.open: number; default: not declared - cdlZ.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CandleZParameters | undefined; default: not declared - cdlZ.stream(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - cdlZ.stream(parameters).period?: number; default: not declared - ceil: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - ceil(input): ArrayLike; default: not declared - ceil(parameters)?: {} | undefined; default: not declared - ceil.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ceil.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ceil.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ceil.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ceil.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ceil.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ceil.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ceil.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ceil.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ceil.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ceil.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ceil.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ceil.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ceil.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ceil.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ceil.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ceil.explain(input): ArrayLike; default: not declared - ceil.explain(parameters)?: {} | undefined; default: not declared - ceil.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ceil.fromJSON().return.next: (input: number) => number | null; default: not declared - ceil.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ceil.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ceil.fromJSON().return.value: number | null; default: not declared - ceil.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ceil.fromJSON(snapshot).kind: string; default: not declared - ceil.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ceil.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ceil.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ceil.stream().return.next: (input: number) => number | null; default: not declared - ceil.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ceil.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ceil.stream().return.value: number | null; default: not declared - ceil.stream(parameters)?: {} | undefined; default: not declared - centerOfGravity: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - centerOfGravity(input): ArrayLike; default: not declared - centerOfGravity(parameters)?: { period?: number; } | undefined; default: not declared - centerOfGravity(parameters).period?: number; default: not declared - centerOfGravity.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - centerOfGravity.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - centerOfGravity.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - centerOfGravity.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - centerOfGravity.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - centerOfGravity.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - centerOfGravity.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - centerOfGravity.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - centerOfGravity.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - centerOfGravity.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - centerOfGravity.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - centerOfGravity.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - centerOfGravity.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - centerOfGravity.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - centerOfGravity.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - centerOfGravity.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - centerOfGravity.explain(input): ArrayLike; default: not declared - centerOfGravity.explain(parameters)?: { period?: number; } | undefined; default: not declared - centerOfGravity.explain(parameters).period?: number; default: not declared - centerOfGravity.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - centerOfGravity.fromJSON().return.next: (input: number) => number | null; default: not declared - centerOfGravity.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - centerOfGravity.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - centerOfGravity.fromJSON().return.value: number | null; default: not declared - centerOfGravity.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - centerOfGravity.fromJSON(snapshot).kind: string; default: not declared - centerOfGravity.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - centerOfGravity.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - centerOfGravity.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - centerOfGravity.stream().return.next: (input: number) => number | null; default: not declared - centerOfGravity.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - centerOfGravity.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - centerOfGravity.stream().return.value: number | null; default: not declared - centerOfGravity.stream(parameters)?: { period?: number; } | undefined; default: not declared - centerOfGravity.stream(parameters).period?: number; default: not declared - centralPivotRange: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').CprPoint>; default: not declared - centralPivotRange(input): ArrayLike; default: not declared - centralPivotRange(parameters)?: Record | undefined; default: not declared - centralPivotRange.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - centralPivotRange.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - centralPivotRange.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - centralPivotRange.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - centralPivotRange.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - centralPivotRange.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - centralPivotRange.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - centralPivotRange.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - centralPivotRange.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - centralPivotRange.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - centralPivotRange.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - centralPivotRange.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - centralPivotRange.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - centralPivotRange.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - centralPivotRange.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - centralPivotRange.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').CprPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - centralPivotRange.explain(input): ArrayLike; default: not declared - centralPivotRange.explain(parameters)?: Record | undefined; default: not declared - centralPivotRange.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - centralPivotRange.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CprPoint | null; default: not declared - centralPivotRange.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CprPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - centralPivotRange.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - centralPivotRange.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').CprPoint | null; default: not declared - centralPivotRange.fromJSON().return.value.bottomCentral: number; default: not declared — Bottom central = (H + L) / 2 of the prior bar. - centralPivotRange.fromJSON().return.value.pivot: number; default: not declared — Pivot = (H + L + C) / 3 of the prior bar. - centralPivotRange.fromJSON().return.value.topCentral: number; default: not declared — Top central = 2·pivot − bottomCentral. - centralPivotRange.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - centralPivotRange.fromJSON(snapshot).kind: string; default: not declared - centralPivotRange.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - centralPivotRange.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - centralPivotRange.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - centralPivotRange.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CprPoint | null; default: not declared - centralPivotRange.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').CprPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - centralPivotRange.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - centralPivotRange.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').CprPoint | null; default: not declared - centralPivotRange.stream().return.value.bottomCentral: number; default: not declared — Bottom central = (H + L) / 2 of the prior bar. - centralPivotRange.stream().return.value.pivot: number; default: not declared — Pivot = (H + L + C) / 3 of the prior bar. - centralPivotRange.stream().return.value.topCentral: number; default: not declared — Top central = 2·pivot − bottomCentral. - centralPivotRange.stream(parameters)?: Record | undefined; default: not declared - cfo: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Chande Forecast Oscillator: % distance of price from its linear-regression value. - cfo(input): ArrayLike; default: not declared - cfo(parameters)?: { period?: number; } | undefined; default: not declared - cfo(parameters).period?: number; default: not declared - cfo.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cfo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cfo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cfo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cfo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cfo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cfo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cfo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cfo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cfo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cfo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cfo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cfo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cfo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cfo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cfo.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cfo.explain(input): ArrayLike; default: not declared - cfo.explain(parameters)?: { period?: number; } | undefined; default: not declared - cfo.explain(parameters).period?: number; default: not declared - cfo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cfo.fromJSON().return.next: (input: number) => number | null; default: not declared - cfo.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cfo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cfo.fromJSON().return.value: number | null; default: not declared - cfo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cfo.fromJSON(snapshot).kind: string; default: not declared - cfo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cfo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cfo.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cfo.stream().return.next: (input: number) => number | null; default: not declared - cfo.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cfo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cfo.stream().return.value: number | null; default: not declared - cfo.stream(parameters)?: { period?: number; } | undefined; default: not declared - cfo.stream(parameters).period?: number; default: not declared - chaikinMoneyFlow: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - chaikinMoneyFlow(input): ArrayLike; default: not declared - chaikinMoneyFlow(parameters)?: { period?: number; } | undefined; default: not declared - chaikinMoneyFlow(parameters).period?: number; default: not declared - chaikinMoneyFlow.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - chaikinMoneyFlow.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - chaikinMoneyFlow.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - chaikinMoneyFlow.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - chaikinMoneyFlow.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - chaikinMoneyFlow.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - chaikinMoneyFlow.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - chaikinMoneyFlow.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - chaikinMoneyFlow.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - chaikinMoneyFlow.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - chaikinMoneyFlow.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - chaikinMoneyFlow.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - chaikinMoneyFlow.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - chaikinMoneyFlow.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - chaikinMoneyFlow.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - chaikinMoneyFlow.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - chaikinMoneyFlow.explain(input): ArrayLike; default: not declared - chaikinMoneyFlow.explain(parameters)?: { period?: number; } | undefined; default: not declared - chaikinMoneyFlow.explain(parameters).period?: number; default: not declared - chaikinMoneyFlow.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chaikinMoneyFlow.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - chaikinMoneyFlow.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chaikinMoneyFlow.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinMoneyFlow.fromJSON().return.value: number | null; default: not declared - chaikinMoneyFlow.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinMoneyFlow.fromJSON(snapshot).kind: string; default: not declared - chaikinMoneyFlow.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - chaikinMoneyFlow.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - chaikinMoneyFlow.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chaikinMoneyFlow.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - chaikinMoneyFlow.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chaikinMoneyFlow.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinMoneyFlow.stream().return.value: number | null; default: not declared - chaikinMoneyFlow.stream(parameters)?: { period?: number; } | undefined; default: not declared - chaikinMoneyFlow.stream(parameters).period?: number; default: not declared - chaikinOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - chaikinOscillator(input): ArrayLike; default: not declared - chaikinOscillator(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinOscParameters | undefined; default: not declared - chaikinOscillator(parameters).fast?: number; default: not declared - chaikinOscillator(parameters).slow?: number; default: not declared - chaikinOscillator.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinOscParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - chaikinOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - chaikinOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - chaikinOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - chaikinOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - chaikinOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - chaikinOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - chaikinOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - chaikinOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - chaikinOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - chaikinOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - chaikinOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - chaikinOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - chaikinOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - chaikinOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - chaikinOscillator.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - chaikinOscillator.explain(input): ArrayLike; default: not declared - chaikinOscillator.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinOscParameters | undefined; default: not declared - chaikinOscillator.explain(parameters).fast?: number; default: not declared - chaikinOscillator.explain(parameters).slow?: number; default: not declared - chaikinOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chaikinOscillator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - chaikinOscillator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chaikinOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinOscillator.fromJSON().return.value: number | null; default: not declared - chaikinOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinOscillator.fromJSON(snapshot).kind: string; default: not declared - chaikinOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - chaikinOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - chaikinOscillator.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinOscParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chaikinOscillator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - chaikinOscillator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chaikinOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinOscillator.stream().return.value: number | null; default: not declared - chaikinOscillator.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinOscParameters | undefined; default: not declared - chaikinOscillator.stream(parameters).fast?: number; default: not declared - chaikinOscillator.stream(parameters).slow?: number; default: not declared - chaikinVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - chaikinVolatility(input): ArrayLike; default: not declared - chaikinVolatility(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinVolatilityParameters | undefined; default: not declared - chaikinVolatility(parameters).period: number; default: not declared - chaikinVolatility(parameters).rocPeriod?: number; default: not declared - chaikinVolatility.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - chaikinVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - chaikinVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - chaikinVolatility.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - chaikinVolatility.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - chaikinVolatility.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - chaikinVolatility.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - chaikinVolatility.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - chaikinVolatility.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - chaikinVolatility.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - chaikinVolatility.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - chaikinVolatility.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - chaikinVolatility.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - chaikinVolatility.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - chaikinVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - chaikinVolatility.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - chaikinVolatility.explain(input): ArrayLike; default: not declared - chaikinVolatility.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinVolatilityParameters | undefined; default: not declared - chaikinVolatility.explain(parameters).period: number; default: not declared - chaikinVolatility.explain(parameters).rocPeriod?: number; default: not declared - chaikinVolatility.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chaikinVolatility.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - chaikinVolatility.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chaikinVolatility.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinVolatility.fromJSON().return.value: number | null; default: not declared - chaikinVolatility.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinVolatility.fromJSON(snapshot).kind: string; default: not declared - chaikinVolatility.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - chaikinVolatility.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - chaikinVolatility.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chaikinVolatility.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - chaikinVolatility.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chaikinVolatility.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chaikinVolatility.stream().return.value: number | null; default: not declared - chaikinVolatility.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChaikinVolatilityParameters | undefined; default: not declared - chaikinVolatility.stream(parameters).period: number; default: not declared - chaikinVolatility.stream(parameters).rocPeriod?: number; default: not declared - chandeKrollStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - chandeKrollStop(input): ArrayLike; default: not declared - chandeKrollStop(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopParameters | undefined; default: not declared - chandeKrollStop(parameters).atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - chandeKrollStop(parameters).multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - chandeKrollStop(parameters).period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. - chandeKrollStop.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - chandeKrollStop.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - chandeKrollStop.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - chandeKrollStop.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - chandeKrollStop.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - chandeKrollStop.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - chandeKrollStop.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - chandeKrollStop.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - chandeKrollStop.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - chandeKrollStop.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - chandeKrollStop.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - chandeKrollStop.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - chandeKrollStop.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - chandeKrollStop.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - chandeKrollStop.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - chandeKrollStop.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - chandeKrollStop.explain(input): ArrayLike; default: not declared - chandeKrollStop.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopParameters | undefined; default: not declared - chandeKrollStop.explain(parameters).atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - chandeKrollStop.explain(parameters).multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - chandeKrollStop.explain(parameters).period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. - chandeKrollStop.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chandeKrollStop.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint | null; default: not declared - chandeKrollStop.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chandeKrollStop.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chandeKrollStop.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint | null; default: not declared - chandeKrollStop.fromJSON().return.value.long: number; default: not declared — Long stop — highest first-stage high-stop over the lookback (trails above price). - chandeKrollStop.fromJSON().return.value.short: number; default: not declared — Short stop — lowest first-stage low-stop over the lookback (trails below price). - chandeKrollStop.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chandeKrollStop.fromJSON(snapshot).kind: string; default: not declared - chandeKrollStop.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - chandeKrollStop.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - chandeKrollStop.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chandeKrollStop.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint | null; default: not declared - chandeKrollStop.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chandeKrollStop.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chandeKrollStop.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopPoint | null; default: not declared - chandeKrollStop.stream().return.value.long: number; default: not declared — Long stop — highest first-stage high-stop over the lookback (trails above price). - chandeKrollStop.stream().return.value.short: number; default: not declared — Short stop — lowest first-stage low-stop over the lookback (trails below price). - chandeKrollStop.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChandeKrollStopParameters | undefined; default: not declared - chandeKrollStop.stream(parameters).atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - chandeKrollStop.stream(parameters).multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - chandeKrollStop.stream(parameters).period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. - chandelierExit: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - chandelierExit(input): ArrayLike; default: not declared - chandelierExit(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChandelierParameters | undefined; default: not declared - chandelierExit(parameters).multiplier?: number; default: not declared - chandelierExit(parameters).period: number; default: not declared - chandelierExit.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChandelierParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - chandelierExit.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - chandelierExit.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - chandelierExit.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - chandelierExit.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - chandelierExit.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - chandelierExit.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - chandelierExit.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - chandelierExit.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - chandelierExit.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - chandelierExit.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - chandelierExit.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - chandelierExit.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - chandelierExit.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - chandelierExit.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - chandelierExit.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - chandelierExit.explain(input): ArrayLike; default: not declared - chandelierExit.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChandelierParameters | undefined; default: not declared - chandelierExit.explain(parameters).multiplier?: number; default: not declared - chandelierExit.explain(parameters).period: number; default: not declared - chandelierExit.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chandelierExit.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint | null; default: not declared - chandelierExit.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chandelierExit.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chandelierExit.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint | null; default: not declared - chandelierExit.fromJSON().return.value.long: number; default: not declared - chandelierExit.fromJSON().return.value.short: number; default: not declared - chandelierExit.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chandelierExit.fromJSON(snapshot).kind: string; default: not declared - chandelierExit.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - chandelierExit.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - chandelierExit.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ChandelierParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - chandelierExit.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint | null; default: not declared - chandelierExit.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - chandelierExit.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - chandelierExit.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChandelierPoint | null; default: not declared - chandelierExit.stream().return.value.long: number; default: not declared - chandelierExit.stream().return.value.short: number; default: not declared - chandelierExit.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ChandelierParameters | undefined; default: not declared - chandelierExit.stream(parameters).multiplier?: number; default: not declared - chandelierExit.stream(parameters).period: number; default: not declared - change: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Alias of `diff`. - change(input): ArrayLike; default: not declared - change(parameters)?: { period?: number; } | undefined; default: not declared - change(parameters).period?: number; default: not declared - change.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - change.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - change.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - change.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - change.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - change.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - change.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - change.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - change.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - change.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - change.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - change.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - change.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - change.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - change.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - change.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - change.explain(input): ArrayLike; default: not declared - change.explain(parameters)?: { period?: number; } | undefined; default: not declared - change.explain(parameters).period?: number; default: not declared - change.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - change.fromJSON().return.next: (input: number) => number | null; default: not declared - change.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - change.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - change.fromJSON().return.value: number | null; default: not declared - change.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - change.fromJSON(snapshot).kind: string; default: not declared - change.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - change.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - change.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - change.stream().return.next: (input: number) => number | null; default: not declared - change.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - change.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - change.stream().return.value: number | null; default: not declared - change.stream(parameters)?: { period?: number; } | undefined; default: not declared - change.stream(parameters).period?: number; default: not declared - channel: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; default: not declared — The trendline pair as a channel; `support`/`resistance` are the channel rails. - channel().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - channel().return.assumptions.conventionsVersion: string; default: not declared - channel().return.assumptions.strength: number; default: not declared - channel().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - channel().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - channel().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - channel().return.resistance.from: number; default: not declared - channel().return.resistance.intercept: number; default: not declared - channel().return.resistance.slope: number; default: not declared - channel().return.resistance.to: number; default: not declared - channel().return.support: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - channel().return.support.from: number; default: not declared - channel().return.support.intercept: number; default: not declared - channel().return.support.slope: number; default: not declared - channel().return.support.to: number; default: not declared - channel(bars): ArrayLike; default: not declared - channel(options)?: { strength?: number; }; default: not declared - channel(options).strength?: number; default: not declared - charts: { readonly renko: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; readonly lineBreak: (bars: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; readonly kagi: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').KagiParameters) => import('@insiderfinance/totalfinance/technical-analysis').KagiSegment[]; readonly pointAndFigure: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').PnfParameters) => import('@insiderfinance/totalfinance/technical-analysis').PnfColumn[]; readonly rangeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly tickBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly volumeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly dollarBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly imbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly volumeImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly dollarImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly runBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly volumeRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly dollarRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; }; default: not declared — Chart-construction group: alternative chart types built from OHLC bars. - charts.dollarBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.dollarBars(bars): ArrayLike; default: not declared - charts.dollarBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters; default: not declared - charts.dollarBars(parameters).dollar: number; default: not declared - charts.dollarBars(parameters).flush?: boolean; default: not declared - charts.dollarImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.dollarImbalanceBars(bars): ArrayLike; default: not declared - charts.dollarImbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - charts.dollarImbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.dollarImbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - charts.dollarRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.dollarRunBars(bars): ArrayLike; default: not declared - charts.dollarRunBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - charts.dollarRunBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.dollarRunBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - charts.imbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.imbalanceBars(bars): ArrayLike; default: not declared - charts.imbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - charts.imbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.imbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - charts.kagi: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').KagiParameters) => import('@insiderfinance/totalfinance/technical-analysis').KagiSegment[]; default: not declared - charts.kagi(bars): ArrayLike; default: not declared - charts.kagi(parameters): import('@insiderfinance/totalfinance/technical-analysis').KagiParameters; default: not declared - charts.kagi(parameters).percent?: boolean; default: not declared - charts.kagi(parameters).reversal: number; default: not declared — Reversal amount. Absolute price by default, or a percent of price if `percent` is true. - charts.lineBreak: (bars: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; default: not declared - charts.lineBreak(bars): ArrayLike; default: not declared - charts.lineBreak(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters; default: not declared - charts.lineBreak(parameters).lines?: number; default: not declared - charts.pointAndFigure: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').PnfParameters) => import('@insiderfinance/totalfinance/technical-analysis').PnfColumn[]; default: not declared - charts.pointAndFigure(bars): ArrayLike; default: not declared - charts.pointAndFigure(parameters): import('@insiderfinance/totalfinance/technical-analysis').PnfParameters; default: not declared - charts.pointAndFigure(parameters).boxSize: number; default: not declared - charts.pointAndFigure(parameters).reversal?: number; default: not declared - charts.rangeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.rangeBars(bars): ArrayLike; default: not declared - charts.rangeBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters; default: not declared - charts.rangeBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.rangeBars(parameters).size: number; default: not declared - charts.renko: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; default: not declared - charts.renko(bars): ArrayLike; default: not declared - charts.renko(parameters): import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters; default: not declared - charts.renko(parameters).brickSize: number; default: not declared - charts.runBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.runBars(bars): ArrayLike; default: not declared - charts.runBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - charts.runBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.runBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - charts.tickBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.tickBars(bars): ArrayLike; default: not declared - charts.tickBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters; default: not declared - charts.tickBars(parameters).count: number; default: not declared - charts.tickBars(parameters).flush?: boolean; default: not declared - charts.volumeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.volumeBars(bars): ArrayLike; default: not declared - charts.volumeBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters; default: not declared - charts.volumeBars(parameters).flush?: boolean; default: not declared - charts.volumeBars(parameters).volume: number; default: not declared - charts.volumeImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.volumeImbalanceBars(bars): ArrayLike; default: not declared - charts.volumeImbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - charts.volumeImbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.volumeImbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - charts.volumeRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - charts.volumeRunBars(bars): ArrayLike; default: not declared - charts.volumeRunBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - charts.volumeRunBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - charts.volumeRunBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - checkSnapshotVersion: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => void; default: not declared — Validate a snapshot's schema version before restoring. A newer version is rejected — this build can't know what changed, so restoring would silently corrupt state, which design law #4 forbids. An OLDER version is rejected too: the v1 flat shape has no `state`, so "accepting" it would restore an indicator with every field undefined. - checkSnapshotVersion(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - checkSnapshotVersion(snapshot).kind: string; default: not declared - checkSnapshotVersion(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - checkSnapshotVersion(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - choppinessIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - choppinessIndex(input): ArrayLike; default: not declared - choppinessIndex(parameters)?: { period?: number; } | undefined; default: not declared - choppinessIndex(parameters).period?: number; default: not declared - choppinessIndex.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - choppinessIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - choppinessIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - choppinessIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - choppinessIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - choppinessIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - choppinessIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - choppinessIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - choppinessIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - choppinessIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - choppinessIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - choppinessIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - choppinessIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - choppinessIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - choppinessIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - choppinessIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - choppinessIndex.explain(input): ArrayLike; default: not declared - choppinessIndex.explain(parameters)?: { period?: number; } | undefined; default: not declared - choppinessIndex.explain(parameters).period?: number; default: not declared - choppinessIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - choppinessIndex.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - choppinessIndex.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - choppinessIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - choppinessIndex.fromJSON().return.value: number | null; default: not declared - choppinessIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - choppinessIndex.fromJSON(snapshot).kind: string; default: not declared - choppinessIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - choppinessIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - choppinessIndex.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - choppinessIndex.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - choppinessIndex.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - choppinessIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - choppinessIndex.stream().return.value: number | null; default: not declared - choppinessIndex.stream(parameters)?: { period?: number; } | undefined; default: not declared - choppinessIndex.stream(parameters).period?: number; default: not declared - cmo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - cmo(input): ArrayLike; default: not declared - cmo(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/momentum').CmoParameters | undefined; default: not declared - cmo(parameters).period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - cmo(parameters).talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. - cmo.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/momentum').CmoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cmo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cmo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cmo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cmo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cmo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cmo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cmo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cmo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cmo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cmo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cmo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cmo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cmo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cmo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cmo.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cmo.explain(input): ArrayLike; default: not declared - cmo.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/momentum').CmoParameters | undefined; default: not declared - cmo.explain(parameters).period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - cmo.explain(parameters).talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. - cmo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cmo.fromJSON().return.next: (input: number) => number | null; default: not declared - cmo.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cmo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cmo.fromJSON().return.value: number | null; default: not declared - cmo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cmo.fromJSON(snapshot).kind: string; default: not declared - cmo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cmo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cmo.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/momentum').CmoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cmo.stream().return.next: (input: number) => number | null; default: not declared - cmo.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cmo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cmo.stream().return.value: number | null; default: not declared - cmo.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/momentum').CmoParameters | undefined; default: not declared - cmo.stream(parameters).period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - cmo.stream(parameters).talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. - collectAsync: (stream: import('@insiderfinance/totalfinance/technical-analysis').IndicatorStream, source: AsyncIterable, nan: Out) => Promise<{ value: Out[]; warmup: number; }>; default: not declared — Drain an async iterable through a stream into an aligned series (NaN sentinel during warmup). - collectAsync(nan): Out; default: not declared - collectAsync(source): AsyncIterable; default: not declared - collectAsync(stream): import('@insiderfinance/totalfinance/technical-analysis').IndicatorStream; default: not declared - collectAsync(stream).next: (input: In) => Out | null; default: not declared - collectAsync(stream).toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - collectAsync(stream).value: Out | null; default: not declared - columnsFromBars: (bars: readonly import('@insiderfinance/totalfinance/technical-analysis').BarInput[]) => import('@insiderfinance/totalfinance/technical-analysis').BarColumns; default: not declared — Convert bar rows back into columnar arrays (only columns present on the first bar are emitted). - columnsFromBars().return.close?: readonly number[]; default: not declared - columnsFromBars().return.high?: readonly number[]; default: not declared - columnsFromBars().return.low?: readonly number[]; default: not declared - columnsFromBars().return.open?: readonly number[]; default: not declared - columnsFromBars().return.volume?: readonly number[]; default: not declared - columnsFromBars(bars): readonly import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - compatibilityMatrixMarkdown: () => string; default: not declared — Render the TotalFinance ↔ TA-Lib ↔ pandas-ta ↔ TradingView name map as a Markdown matrix. - condition: (refs: readonly string[], predicate: (context: import('@insiderfinance/totalfinance/technical-analysis').SignalContext, barIndex: number) => boolean) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared — Build a custom condition. `refs` are the column aliases / `alias.field` / raw OHLCV fields the predicate reads via `context.get(...)` — they are validated up front like the built-in conditions, so a typo fails loud. Pass `[]` for a condition that reads nothing (or reads only constants). - condition().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - condition(predicate): (context: import('@insiderfinance/totalfinance/technical-analysis').SignalContext, barIndex: number) => boolean; default: not declared - condition(refs): readonly string[]; default: not declared - connorsRsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - connorsRsi(input): ArrayLike; default: not declared - connorsRsi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ConnorsRsiParameters | undefined; default: not declared - connorsRsi(parameters).rankPeriod?: number; default: not declared - connorsRsi(parameters).rsiPeriod?: number; default: not declared - connorsRsi(parameters).streakPeriod?: number; default: not declared - connorsRsi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ConnorsRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - connorsRsi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - connorsRsi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - connorsRsi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - connorsRsi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - connorsRsi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - connorsRsi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - connorsRsi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - connorsRsi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - connorsRsi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - connorsRsi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - connorsRsi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - connorsRsi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - connorsRsi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - connorsRsi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - connorsRsi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - connorsRsi.explain(input): ArrayLike; default: not declared - connorsRsi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ConnorsRsiParameters | undefined; default: not declared - connorsRsi.explain(parameters).rankPeriod?: number; default: not declared - connorsRsi.explain(parameters).rsiPeriod?: number; default: not declared - connorsRsi.explain(parameters).streakPeriod?: number; default: not declared - connorsRsi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - connorsRsi.fromJSON().return.next: (input: number) => number | null; default: not declared - connorsRsi.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - connorsRsi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - connorsRsi.fromJSON().return.value: number | null; default: not declared - connorsRsi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - connorsRsi.fromJSON(snapshot).kind: string; default: not declared - connorsRsi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - connorsRsi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - connorsRsi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ConnorsRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - connorsRsi.stream().return.next: (input: number) => number | null; default: not declared - connorsRsi.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - connorsRsi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - connorsRsi.stream().return.value: number | null; default: not declared - connorsRsi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ConnorsRsiParameters | undefined; default: not declared - connorsRsi.stream(parameters).rankPeriod?: number; default: not declared - connorsRsi.stream(parameters).rsiPeriod?: number; default: not declared - connorsRsi.stream(parameters).streakPeriod?: number; default: not declared - coppock: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - coppock(input): ArrayLike; default: not declared - coppock(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CoppockParameters | undefined; default: not declared - coppock(parameters).longRoc?: number; default: not declared - coppock(parameters).shortRoc?: number; default: not declared - coppock(parameters).wma?: number; default: not declared - coppock.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').CoppockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - coppock.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - coppock.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - coppock.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - coppock.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - coppock.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - coppock.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - coppock.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - coppock.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - coppock.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - coppock.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - coppock.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - coppock.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - coppock.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - coppock.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - coppock.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - coppock.explain(input): ArrayLike; default: not declared - coppock.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CoppockParameters | undefined; default: not declared - coppock.explain(parameters).longRoc?: number; default: not declared - coppock.explain(parameters).shortRoc?: number; default: not declared - coppock.explain(parameters).wma?: number; default: not declared - coppock.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - coppock.fromJSON().return.next: (input: number) => number | null; default: not declared - coppock.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - coppock.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - coppock.fromJSON().return.value: number | null; default: not declared - coppock.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - coppock.fromJSON(snapshot).kind: string; default: not declared - coppock.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - coppock.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - coppock.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').CoppockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - coppock.stream().return.next: (input: number) => number | null; default: not declared - coppock.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - coppock.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - coppock.stream().return.value: number | null; default: not declared - coppock.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CoppockParameters | undefined; default: not declared - coppock.stream(parameters).longRoc?: number; default: not declared - coppock.stream(parameters).shortRoc?: number; default: not declared - coppock.stream(parameters).wma?: number; default: not declared - correl: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - correl(input): ArrayLike; default: not declared - correl(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - correl(parameters).period: number; default: not declared - correl.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - correl.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - correl.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - correl.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - correl.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - correl.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - correl.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - correl.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - correl.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - correl.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - correl.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - correl.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - correl.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - correl.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - correl.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - correl.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - correl.explain(input): ArrayLike; default: not declared - correl.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - correl.explain(parameters).period: number; default: not declared - correl.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - correl.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - correl.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - correl.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - correl.fromJSON().return.value: number | null; default: not declared - correl.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - correl.fromJSON(snapshot).kind: string; default: not declared - correl.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - correl.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - correl.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - correl.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - correl.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - correl.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - correl.stream().return.value: number | null; default: not declared - correl.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - correl.stream(parameters).period: number; default: not declared - cos: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - cos(input): ArrayLike; default: not declared - cos(parameters)?: {} | undefined; default: not declared - cos.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cos.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cos.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cos.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cos.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cos.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cos.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cos.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cos.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cos.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cos.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cos.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cos.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cos.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cos.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cos.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cos.explain(input): ArrayLike; default: not declared - cos.explain(parameters)?: {} | undefined; default: not declared - cos.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cos.fromJSON().return.next: (input: number) => number | null; default: not declared - cos.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cos.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cos.fromJSON().return.value: number | null; default: not declared - cos.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cos.fromJSON(snapshot).kind: string; default: not declared - cos.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cos.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cos.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cos.stream().return.next: (input: number) => number | null; default: not declared - cos.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cos.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cos.stream().return.value: number | null; default: not declared - cos.stream(parameters)?: {} | undefined; default: not declared - cosh: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - cosh(input): ArrayLike; default: not declared - cosh(parameters)?: {} | undefined; default: not declared - cosh.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cosh.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cosh.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cosh.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cosh.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cosh.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cosh.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cosh.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cosh.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cosh.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cosh.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cosh.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cosh.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cosh.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cosh.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cosh.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cosh.explain(input): ArrayLike; default: not declared - cosh.explain(parameters)?: {} | undefined; default: not declared - cosh.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cosh.fromJSON().return.next: (input: number) => number | null; default: not declared - cosh.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cosh.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cosh.fromJSON().return.value: number | null; default: not declared - cosh.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cosh.fromJSON(snapshot).kind: string; default: not declared - cosh.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cosh.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cosh.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cosh.stream().return.next: (input: number) => number | null; default: not declared - cosh.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cosh.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cosh.stream().return.value: number | null; default: not declared - cosh.stream(parameters)?: {} | undefined; default: not declared - covariance: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling covariance of a paired series (sample denominator by default). - covariance(input): ArrayLike; default: not declared - covariance(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CovarianceParameters | undefined; default: not declared - covariance(parameters).period?: number; default: not declared - covariance(parameters).sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. - covariance.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').CovarianceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - covariance.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - covariance.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - covariance.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - covariance.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - covariance.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - covariance.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - covariance.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - covariance.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - covariance.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - covariance.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - covariance.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - covariance.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - covariance.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - covariance.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - covariance.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - covariance.explain(input): ArrayLike; default: not declared - covariance.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CovarianceParameters | undefined; default: not declared - covariance.explain(parameters).period?: number; default: not declared - covariance.explain(parameters).sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. - covariance.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - covariance.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - covariance.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - covariance.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - covariance.fromJSON().return.value: number | null; default: not declared - covariance.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - covariance.fromJSON(snapshot).kind: string; default: not declared - covariance.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - covariance.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - covariance.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').CovarianceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - covariance.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - covariance.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - covariance.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - covariance.stream().return.value: number | null; default: not declared - covariance.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CovarianceParameters | undefined; default: not declared - covariance.stream(parameters).period?: number; default: not declared - covariance.stream(parameters).sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. - crossOver: (first: import('@insiderfinance/totalfinance/technical-analysis').Operand, second: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - crossOver().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - crossOver(first): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - crossOver(second): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - crossSignals: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Cross-based long/flat state machine: enter when the series crosses above `above`, exit below `below`. - crossSignals(input): ArrayLike; default: not declared - crossSignals(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CrossSignalParameters | undefined; default: not declared - crossSignals(parameters).above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - crossSignals(parameters).below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. - crossSignals.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').CrossSignalParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - crossSignals.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - crossSignals.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - crossSignals.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - crossSignals.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - crossSignals.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - crossSignals.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - crossSignals.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - crossSignals.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - crossSignals.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - crossSignals.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - crossSignals.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - crossSignals.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - crossSignals.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - crossSignals.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - crossSignals.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - crossSignals.explain(input): ArrayLike; default: not declared - crossSignals.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CrossSignalParameters | undefined; default: not declared - crossSignals.explain(parameters).above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - crossSignals.explain(parameters).below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. - crossSignals.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - crossSignals.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - crossSignals.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - crossSignals.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossSignals.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - crossSignals.fromJSON().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - crossSignals.fromJSON().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - crossSignals.fromJSON().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - crossSignals.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossSignals.fromJSON(snapshot).kind: string; default: not declared - crossSignals.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - crossSignals.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - crossSignals.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').CrossSignalParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - crossSignals.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - crossSignals.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - crossSignals.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossSignals.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - crossSignals.stream().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - crossSignals.stream().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - crossSignals.stream().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - crossSignals.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CrossSignalParameters | undefined; default: not declared - crossSignals.stream(parameters).above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - crossSignals.stream(parameters).below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. - crossUnder: (first: import('@insiderfinance/totalfinance/technical-analysis').Operand, second: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - crossUnder().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - crossUnder(first): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - crossUnder(second): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - crossany: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared — 1 on the bar where `x` crosses either above or below `y`, else 0. - crossany(input): ArrayLike; default: not declared - crossany(parameters)?: {} | undefined; default: not declared - crossany.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - crossany.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - crossany.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - crossany.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - crossany.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - crossany.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - crossany.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - crossany.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - crossany.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - crossany.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - crossany.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - crossany.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - crossany.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - crossany.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - crossany.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - crossany.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - crossany.explain(input): ArrayLike; default: not declared - crossany.explain(parameters)?: {} | undefined; default: not declared - crossany.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - crossany.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - crossany.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - crossany.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossany.fromJSON().return.value: number | null; default: not declared - crossany.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossany.fromJSON(snapshot).kind: string; default: not declared - crossany.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - crossany.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - crossany.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - crossany.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - crossany.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - crossany.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossany.stream().return.value: number | null; default: not declared - crossany.stream(parameters)?: {} | undefined; default: not declared - crossover: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared — 1 on the bar where `x` crosses above `y`, else 0. - crossover(input): ArrayLike; default: not declared - crossover(parameters)?: {} | undefined; default: not declared - crossover.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - crossover.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - crossover.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - crossover.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - crossover.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - crossover.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - crossover.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - crossover.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - crossover.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - crossover.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - crossover.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - crossover.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - crossover.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - crossover.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - crossover.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - crossover.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - crossover.explain(input): ArrayLike; default: not declared - crossover.explain(parameters)?: {} | undefined; default: not declared - crossover.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - crossover.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - crossover.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - crossover.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossover.fromJSON().return.value: number | null; default: not declared - crossover.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossover.fromJSON(snapshot).kind: string; default: not declared - crossover.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - crossover.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - crossover.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - crossover.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - crossover.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - crossover.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - crossover.stream().return.value: number | null; default: not declared - crossover.stream(parameters)?: {} | undefined; default: not declared - cti: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - cti(input): ArrayLike; default: not declared - cti(parameters)?: { period?: number; } | undefined; default: not declared - cti(parameters).period?: number; default: not declared - cti.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cti.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cti.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cti.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cti.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cti.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cti.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cti.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cti.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cti.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cti.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cti.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cti.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cti.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cti.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cti.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cti.explain(input): ArrayLike; default: not declared - cti.explain(parameters)?: { period?: number; } | undefined; default: not declared - cti.explain(parameters).period?: number; default: not declared - cti.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cti.fromJSON().return.next: (input: number) => number | null; default: not declared - cti.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cti.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cti.fromJSON().return.value: number | null; default: not declared - cti.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cti.fromJSON(snapshot).kind: string; default: not declared - cti.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cti.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cti.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cti.stream().return.next: (input: number) => number | null; default: not declared - cti.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cti.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cti.stream().return.value: number | null; default: not declared - cti.stream(parameters)?: { period?: number; } | undefined; default: not declared - cti.stream(parameters).period?: number; default: not declared - cumulativeSum: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; default: not declared — Running cumulative sum. - cumulativeSum(input): ArrayLike; default: not declared - cumulativeSum(parameters)?: Record | undefined; default: not declared - cumulativeSum.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cumulativeSum.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cumulativeSum.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cumulativeSum.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cumulativeSum.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cumulativeSum.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cumulativeSum.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cumulativeSum.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cumulativeSum.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cumulativeSum.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cumulativeSum.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cumulativeSum.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cumulativeSum.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cumulativeSum.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cumulativeSum.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cumulativeSum.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cumulativeSum.explain(input): ArrayLike; default: not declared - cumulativeSum.explain(parameters)?: Record | undefined; default: not declared - cumulativeSum.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cumulativeSum.fromJSON().return.next: (input: number) => number | null; default: not declared - cumulativeSum.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cumulativeSum.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cumulativeSum.fromJSON().return.value: number | null; default: not declared - cumulativeSum.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cumulativeSum.fromJSON(snapshot).kind: string; default: not declared - cumulativeSum.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cumulativeSum.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cumulativeSum.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cumulativeSum.stream().return.next: (input: number) => number | null; default: not declared - cumulativeSum.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cumulativeSum.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cumulativeSum.stream().return.value: number | null; default: not declared - cumulativeSum.stream(parameters)?: Record | undefined; default: not declared - cumulativeVolumeDelta: (trades: readonly import('@insiderfinance/totalfinance/technical-analysis').Trade[], parameters?: import('@insiderfinance/totalfinance/technical-analysis').CvdParameters) => import('@insiderfinance/totalfinance/technical-analysis').CvdResult; default: not declared — Batch cumulative volume delta over a trade tape. - cumulativeVolumeDelta().return.assumptions: { conventionsVersion: string; method: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; }; default: not declared — Applied conventions, echoed — `method` is the aggressor rule actually used. - cumulativeVolumeDelta().return.assumptions.conventionsVersion: string; default: not declared - cumulativeVolumeDelta().return.assumptions.method: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; default: not declared - cumulativeVolumeDelta().return.buyVolume: number; default: not declared - cumulativeVolumeDelta().return.cumulative: number[]; default: not declared — Running cumulative volume delta after each trade. - cumulativeVolumeDelta().return.delta: number[]; default: not declared — Per-trade signed volume (`sign · size`). - cumulativeVolumeDelta().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - cumulativeVolumeDelta().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - cumulativeVolumeDelta().return.sellVolume: number; default: not declared - cumulativeVolumeDelta().return.sign: number[]; default: not declared — Per-trade aggressor sign (+1 / −1 / 0). - cumulativeVolumeDelta(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').CvdParameters; default: not declared - cumulativeVolumeDelta(parameters).method?: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; default: not declared — Aggressor inference method. Default `'quote'` (Lee-Ready) when quotes are supplied, else `'tick'`. - cumulativeVolumeDelta(parameters).quotes?: readonly import('@insiderfinance/totalfinance/technical-analysis').Quote[]; default: not declared — NBBO quotes aligned 1:1 with `trades` (for the quote rule). - cumulativeVolumeDelta(trades): readonly import('@insiderfinance/totalfinance/technical-analysis').Trade[]; default: not declared - cvd: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - cvd(input): ArrayLike; default: not declared - cvd(parameters)?: Record | undefined; default: not declared - cvd.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - cvd.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - cvd.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - cvd.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cvd.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cvd.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cvd.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cvd.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cvd.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cvd.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cvd.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cvd.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cvd.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cvd.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cvd.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - cvd.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - cvd.explain(input): ArrayLike; default: not declared - cvd.explain(parameters)?: Record | undefined; default: not declared - cvd.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cvd.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cvd.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cvd.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cvd.fromJSON().return.value: number | null; default: not declared - cvd.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cvd.fromJSON(snapshot).kind: string; default: not declared - cvd.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - cvd.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - cvd.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - cvd.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - cvd.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - cvd.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - cvd.stream().return.value: number | null; default: not declared - cvd.stream(parameters)?: Record | undefined; default: not declared - decreasing: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — 1 when the series is lower than `period` bars ago (strict → every step fell). - decreasing(input): ArrayLike; default: not declared - decreasing(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined; default: not declared - decreasing(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - decreasing(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - decreasing.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - decreasing.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - decreasing.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - decreasing.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - decreasing.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decreasing.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - decreasing.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - decreasing.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - decreasing.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - decreasing.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - decreasing.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - decreasing.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - decreasing.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - decreasing.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - decreasing.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - decreasing.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - decreasing.explain(input): ArrayLike; default: not declared - decreasing.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined; default: not declared - decreasing.explain(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - decreasing.explain(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - decreasing.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - decreasing.fromJSON().return.next: (input: number) => number | null; default: not declared - decreasing.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - decreasing.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - decreasing.fromJSON().return.value: number | null; default: not declared - decreasing.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - decreasing.fromJSON(snapshot).kind: string; default: not declared - decreasing.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - decreasing.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - decreasing.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - decreasing.stream().return.next: (input: number) => number | null; default: not declared - decreasing.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - decreasing.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - decreasing.stream().return.value: number | null; default: not declared - decreasing.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined; default: not declared - decreasing.stream(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - decreasing.stream(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - defineIndicator: (definition: import('@insiderfinance/totalfinance/technical-analysis').IndicatorDefinition) => import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Build an aligned batch+stream indicator and register it. Returns the facade. - defineIndicator().return.explain: (input: ArrayLike, parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - defineIndicator().return.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - defineIndicator().return.stream: (parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - defineIndicator(definition): import('@insiderfinance/totalfinance/technical-analysis').IndicatorDefinition; default: not declared - defineIndicator(definition).category?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - defineIndicator(definition).conventions?: Readonly>; default: not declared — See {@link IndicatorMetadata.conventions} — declared here, echoed by every `.explain()`. - defineIndicator(definition).defaults?: Record; default: not declared — Declared default per optional parameter, echoed through `.explain().assumptions.parameters` (the disclosure law). Every key must appear in `parameters`; parameters without a default are required. - defineIndicator(definition).inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared - defineIndicator(definition).name: string; default: not declared - defineIndicator(definition).nan: (parameters: P) => Out; default: not declared — Warmup sentinel factory. - defineIndicator(definition).output: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputMetadata; default: not declared — Output metadata (Wave 6 §4) — the recursive value schema + optional visualization. Required. - defineIndicator(definition).parameters?: string[]; default: not declared - defineIndicator(definition).restore: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').IndicatorStream; default: not declared — TechnicalAnalysisSnapshot restorer (`makeIndicator`'s restore). - defineIndicator(definition).stream: (parameters: P) => import('@insiderfinance/totalfinance/technical-analysis').IndicatorStream; default: not declared — Stream factory (`makeIndicator`'s `make`). - dema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - dema(input): ArrayLike; default: not declared - dema(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - dema(parameters).period: number; default: not declared - dema.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - dema.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - dema.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - dema.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - dema.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - dema.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - dema.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - dema.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - dema.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - dema.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - dema.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - dema.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - dema.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - dema.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dema.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - dema.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - dema.explain(input): ArrayLike; default: not declared - dema.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - dema.explain(parameters).period: number; default: not declared - dema.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dema.fromJSON().return.next: (input: number) => number | null; default: not declared - dema.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dema.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dema.fromJSON().return.value: number | null; default: not declared - dema.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dema.fromJSON(snapshot).kind: string; default: not declared - dema.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - dema.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - dema.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dema.stream().return.next: (input: number) => number | null; default: not declared - dema.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dema.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dema.stream().return.value: number | null; default: not declared - dema.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - dema.stream(parameters).period: number; default: not declared - describeIndicator: (name: string, probeLength?: number) => import('@insiderfinance/totalfinance/technical-analysis').IndicatorDescription; default: not declared — One indicator's full metadata card (alias-aware): category, input kind, parameters, defaults, which are required, its warmup, and its cross-library aliases. Throws on an unknown name. See the spec. - describeIndicator().return.aliases?: Omit; default: not declared — Cross-library aliases (TA-Lib / pandas-ta / TradingView), when known. - describeIndicator().return.aliases.pandas?: string | string[]; default: not declared — pandas-ta name(s), snake_case. - describeIndicator().return.aliases.talib?: string | string[]; default: not declared — TA-Lib function name(s), uppercase. - describeIndicator().return.aliases.tradingview?: string; default: not declared — TradingView display name. - describeIndicator().return.category: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - describeIndicator().return.conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal (Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded) — present only where such a choice exists. This is the field that answers "why does your RSI disagree with my other library?" without leaving the tool schema. - describeIndicator().return.defaults: Record; default: not declared — Declared default per optional parameter; a derived default is a resolver function. - describeIndicator().return.inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared — Input kind expected by the indicator. - describeIndicator().return.name: string; default: not declared — Canonical registered name. - describeIndicator().return.output: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputMetadata; default: not declared — The output metadata — recursive value schema + optional visualization (Wave 6 §4). - describeIndicator().return.parameters: string[]; default: not declared — All parameter names (including defaulted ones the caller may omit). - describeIndicator().return.required: string[]; default: not declared — Parameters with no default — the caller must supply these. - describeIndicator().return.warmup: number | null; default: not declared — Leading bars before the first real value, or `null` if it never emitted within the probe. - describeIndicator(name): string; default: not declared - describeIndicator(probeLength)?: number; default: not declared - detectCandles: (bars: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').CandleMatch[][]; default: not declared — Scan bars with the whole catalog, returning the matched patterns (non-zero signal) at each bar. Index `i` of the result lists patterns that complete on bar `i`. - detectCandles(bars): ArrayLike; default: not declared - difference: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Discrete difference: `input[i] − input[i − period]`. - difference(input): ArrayLike; default: not declared - difference(parameters)?: { period?: number; } | undefined; default: not declared - difference(parameters).period?: number; default: not declared - difference.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - difference.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - difference.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - difference.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - difference.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - difference.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - difference.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - difference.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - difference.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - difference.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - difference.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - difference.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - difference.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - difference.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - difference.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - difference.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - difference.explain(input): ArrayLike; default: not declared - difference.explain(parameters)?: { period?: number; } | undefined; default: not declared - difference.explain(parameters).period?: number; default: not declared - difference.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - difference.fromJSON().return.next: (input: number) => number | null; default: not declared - difference.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - difference.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - difference.fromJSON().return.value: number | null; default: not declared - difference.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - difference.fromJSON(snapshot).kind: string; default: not declared - difference.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - difference.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - difference.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - difference.stream().return.next: (input: number) => number | null; default: not declared - difference.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - difference.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - difference.stream().return.value: number | null; default: not declared - difference.stream(parameters)?: { period?: number; } | undefined; default: not declared - difference.stream(parameters).period?: number; default: not declared - div: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared - div(input): ArrayLike; default: not declared - div(parameters)?: {} | undefined; default: not declared - div.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - div.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - div.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - div.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - div.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - div.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - div.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - div.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - div.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - div.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - div.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - div.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - div.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - div.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - div.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - div.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - div.explain(input): ArrayLike; default: not declared - div.explain(parameters)?: {} | undefined; default: not declared - div.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - div.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - div.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - div.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - div.fromJSON().return.value: number | null; default: not declared - div.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - div.fromJSON(snapshot).kind: string; default: not declared - div.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - div.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - div.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - div.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - div.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - div.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - div.stream().return.value: number | null; default: not declared - div.stream(parameters)?: {} | undefined; default: not declared - divergence: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — The `divergence` indicator (registry name `divergence`, category `price-action`): a streaming price/indicator divergence detector. Input is a `{ x: price, y: indicator }` pair per bar; each bar yields a numeric {@link DivergencePoint} (`code: 0` when nothing confirms). For the friendly event-list form with string `kind`, use {@link divergences}. - divergence(input): ArrayLike; default: not declared - divergence(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceParameters | undefined; default: not declared - divergence(parameters).kinds?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - divergence(parameters).swing?: import('@insiderfinance/totalfinance/technical-analysis').SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - divergence.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - divergence.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - divergence.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - divergence.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - divergence.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - divergence.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - divergence.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - divergence.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - divergence.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - divergence.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - divergence.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - divergence.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - divergence.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - divergence.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - divergence.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - divergence.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - divergence.explain(input): ArrayLike; default: not declared - divergence.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceParameters | undefined; default: not declared - divergence.explain(parameters).kinds?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - divergence.explain(parameters).swing?: import('@insiderfinance/totalfinance/technical-analysis').SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - divergence.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - divergence.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint | null; default: not declared - divergence.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - divergence.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - divergence.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint | null; default: not declared - divergence.fromJSON().return.value.code: number; default: not declared — Signed class code (see {@link DivergenceCode}); `0` none, `NaN` warmup. - divergence.fromJSON().return.value.index: number; default: not declared — Confirmation bar index (`NaN` when no divergence / warmup). - divergence.fromJSON().return.value.indicatorSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` indicator value (`[NaN, NaN]` when none). - divergence.fromJSON().return.value.priceSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` price (`[NaN, NaN]` when none). - divergence.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - divergence.fromJSON(snapshot).kind: string; default: not declared - divergence.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - divergence.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - divergence.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - divergence.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint | null; default: not declared - divergence.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - divergence.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - divergence.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').DivergencePoint | null; default: not declared - divergence.stream().return.value.code: number; default: not declared — Signed class code (see {@link DivergenceCode}); `0` none, `NaN` warmup. - divergence.stream().return.value.index: number; default: not declared — Confirmation bar index (`NaN` when no divergence / warmup). - divergence.stream().return.value.indicatorSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` indicator value (`[NaN, NaN]` when none). - divergence.stream().return.value.priceSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` price (`[NaN, NaN]` when none). - divergence.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceParameters | undefined; default: not declared - divergence.stream(parameters).kinds?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - divergence.stream(parameters).swing?: import('@insiderfinance/totalfinance/technical-analysis').SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - divergences: (input: import('@insiderfinance/totalfinance/technical-analysis/divergence').DivergencesInput) => import('@insiderfinance/totalfinance/technical-analysis').DivergenceEvent[]; default: not declared - divergences(input): import('@insiderfinance/totalfinance/technical-analysis/divergence').DivergencesInput; default: not declared - divergences(input).indicator: ArrayLike; default: not declared - divergences(input).parameters?: import('@insiderfinance/totalfinance/technical-analysis').DivergenceParameters; default: not declared - divergences(input).price: ArrayLike; default: not declared - dmi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - dmi(input): ArrayLike; default: not declared - dmi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - dmi(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - dmi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - dmi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - dmi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - dmi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - dmi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - dmi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - dmi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - dmi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - dmi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - dmi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - dmi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - dmi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - dmi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - dmi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dmi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - dmi.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').DmiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - dmi.explain(input): ArrayLike; default: not declared - dmi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - dmi.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - dmi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dmi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').DmiPoint | null; default: not declared - dmi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').DmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dmi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dmi.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').DmiPoint | null; default: not declared - dmi.fromJSON().return.value.dx: number; default: not declared - dmi.fromJSON().return.value.minusDI: number; default: not declared - dmi.fromJSON().return.value.minusDM: number; default: not declared — Wilder-smoothed −DM. - dmi.fromJSON().return.value.plusDI: number; default: not declared - dmi.fromJSON().return.value.plusDM: number; default: not declared — Wilder-smoothed +DM. - dmi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dmi.fromJSON(snapshot).kind: string; default: not declared - dmi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - dmi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - dmi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dmi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').DmiPoint | null; default: not declared - dmi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').DmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dmi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dmi.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').DmiPoint | null; default: not declared - dmi.stream().return.value.dx: number; default: not declared - dmi.stream().return.value.minusDI: number; default: not declared - dmi.stream().return.value.minusDM: number; default: not declared — Wilder-smoothed −DM. - dmi.stream().return.value.plusDI: number; default: not declared - dmi.stream().return.value.plusDM: number; default: not declared — Wilder-smoothed +DM. - dmi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - dmi.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - dollarBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - dollarBars(bars): ArrayLike; default: not declared - dollarBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters; default: not declared - dollarBars(parameters).dollar: number; default: not declared - dollarBars(parameters).flush?: boolean; default: not declared - dollarImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Dollar imbalance bars — signed dollar value `|Σ sign(Δclose)·close·volume|`. - dollarImbalanceBars(bars): ArrayLike; default: not declared - dollarImbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - dollarImbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - dollarImbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - dollarRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Dollar run bars — close on the larger one-sided dollar run. - dollarRunBars(bars): ArrayLike; default: not declared - dollarRunBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - dollarRunBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - dollarRunBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - donchian: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - donchian(input): ArrayLike; default: not declared - donchian(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined; default: not declared - donchian(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - donchian.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - donchian.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - donchian.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - donchian.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - donchian.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - donchian.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - donchian.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - donchian.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - donchian.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - donchian.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - donchian.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - donchian.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - donchian.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - donchian.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - donchian.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - donchian.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - donchian.explain(input): ArrayLike; default: not declared - donchian.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined; default: not declared - donchian.explain(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - donchian.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - donchian.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - donchian.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - donchian.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - donchian.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - donchian.fromJSON().return.value.lower: number; default: not declared - donchian.fromJSON().return.value.middle: number; default: not declared - donchian.fromJSON().return.value.upper: number; default: not declared - donchian.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - donchian.fromJSON(snapshot).kind: string; default: not declared - donchian.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - donchian.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - donchian.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - donchian.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - donchian.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - donchian.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - donchian.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - donchian.stream().return.value.lower: number; default: not declared - donchian.stream().return.value.middle: number; default: not declared - donchian.stream().return.value.upper: number; default: not declared - donchian.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined; default: not declared - donchian.stream(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - donchianTrend: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - donchianTrend(input): ArrayLike; default: not declared - donchianTrend(parameters)?: { period?: number; } | undefined; default: not declared - donchianTrend(parameters).period?: number; default: not declared - donchianTrend.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - donchianTrend.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - donchianTrend.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - donchianTrend.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - donchianTrend.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - donchianTrend.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - donchianTrend.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - donchianTrend.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - donchianTrend.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - donchianTrend.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - donchianTrend.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - donchianTrend.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - donchianTrend.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - donchianTrend.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - donchianTrend.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - donchianTrend.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - donchianTrend.explain(input): ArrayLike; default: not declared - donchianTrend.explain(parameters)?: { period?: number; } | undefined; default: not declared - donchianTrend.explain(parameters).period?: number; default: not declared - donchianTrend.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - donchianTrend.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - donchianTrend.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - donchianTrend.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - donchianTrend.fromJSON().return.value: number | null; default: not declared - donchianTrend.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - donchianTrend.fromJSON(snapshot).kind: string; default: not declared - donchianTrend.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - donchianTrend.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - donchianTrend.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - donchianTrend.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - donchianTrend.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - donchianTrend.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - donchianTrend.stream().return.value: number | null; default: not declared - donchianTrend.stream(parameters)?: { period?: number; } | undefined; default: not declared - donchianTrend.stream(parameters).period?: number; default: not declared - dpo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - dpo(input): ArrayLike; default: not declared - dpo(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/momentum').PeriodParameters | undefined; default: not declared - dpo(parameters).period: number; default: not declared - dpo.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/momentum').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - dpo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - dpo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - dpo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - dpo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - dpo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - dpo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - dpo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - dpo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - dpo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - dpo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - dpo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - dpo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - dpo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dpo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - dpo.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - dpo.explain(input): ArrayLike; default: not declared - dpo.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/momentum').PeriodParameters | undefined; default: not declared - dpo.explain(parameters).period: number; default: not declared - dpo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dpo.fromJSON().return.next: (input: number) => number | null; default: not declared - dpo.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dpo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dpo.fromJSON().return.value: number | null; default: not declared - dpo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dpo.fromJSON(snapshot).kind: string; default: not declared - dpo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - dpo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - dpo.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/momentum').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dpo.stream().return.next: (input: number) => number | null; default: not declared - dpo.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dpo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dpo.stream().return.value: number | null; default: not declared - dpo.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/momentum').PeriodParameters | undefined; default: not declared - dpo.stream(parameters).period: number; default: not declared - drawdown: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint>; default: not declared - drawdown(input): ArrayLike; default: not declared - drawdown(parameters)?: {} | undefined; default: not declared - drawdown.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - drawdown.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - drawdown.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - drawdown.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - drawdown.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - drawdown.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - drawdown.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - drawdown.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - drawdown.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - drawdown.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - drawdown.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - drawdown.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - drawdown.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - drawdown.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - drawdown.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - drawdown.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - drawdown.explain(input): ArrayLike; default: not declared - drawdown.explain(parameters)?: {} | undefined; default: not declared - drawdown.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - drawdown.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint | null; default: not declared - drawdown.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - drawdown.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - drawdown.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint | null; default: not declared - drawdown.fromJSON().return.value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - drawdown.fromJSON().return.value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - drawdown.fromJSON().return.value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - drawdown.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - drawdown.fromJSON(snapshot).kind: string; default: not declared - drawdown.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - drawdown.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - drawdown.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - drawdown.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint | null; default: not declared - drawdown.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - drawdown.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - drawdown.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').DrawdownPoint | null; default: not declared - drawdown.stream().return.value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - drawdown.stream().return.value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - drawdown.stream().return.value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - drawdown.stream(parameters)?: {} | undefined; default: not declared - dsp: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Detrended Synthetic Price: `close - EMA(close, period)` (pandas-ta `dsp`). - dsp(input): ArrayLike; default: not declared - dsp(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').DspParameters | undefined; default: not declared - dsp(parameters).period?: number; default: not declared - dsp.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').DspParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - dsp.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - dsp.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - dsp.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - dsp.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - dsp.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - dsp.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - dsp.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - dsp.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - dsp.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - dsp.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - dsp.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - dsp.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - dsp.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dsp.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - dsp.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - dsp.explain(input): ArrayLike; default: not declared - dsp.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').DspParameters | undefined; default: not declared - dsp.explain(parameters).period?: number; default: not declared - dsp.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dsp.fromJSON().return.next: (input: number) => number | null; default: not declared - dsp.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dsp.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dsp.fromJSON().return.value: number | null; default: not declared - dsp.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dsp.fromJSON(snapshot).kind: string; default: not declared - dsp.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - dsp.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - dsp.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').DspParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dsp.stream().return.next: (input: number) => number | null; default: not declared - dsp.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dsp.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dsp.stream().return.value: number | null; default: not declared - dsp.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').DspParameters | undefined; default: not declared - dsp.stream(parameters).period?: number; default: not declared - dx: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - dx(input): ArrayLike; default: not declared - dx(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - dx(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - dx.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - dx.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - dx.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - dx.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - dx.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - dx.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - dx.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - dx.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - dx.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - dx.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - dx.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - dx.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - dx.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - dx.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dx.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - dx.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - dx.explain(input): ArrayLike; default: not declared - dx.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - dx.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - dx.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dx.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - dx.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dx.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dx.fromJSON().return.value: number | null; default: not declared - dx.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dx.fromJSON(snapshot).kind: string; default: not declared - dx.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - dx.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - dx.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - dx.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - dx.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - dx.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - dx.stream().return.value: number | null; default: not declared - dx.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - dx.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - easeOfMovement: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - easeOfMovement(input): ArrayLike; default: not declared - easeOfMovement(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - easeOfMovement(parameters).period: number; default: not declared - easeOfMovement(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - easeOfMovement.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - easeOfMovement.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - easeOfMovement.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - easeOfMovement.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - easeOfMovement.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - easeOfMovement.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - easeOfMovement.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - easeOfMovement.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - easeOfMovement.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - easeOfMovement.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - easeOfMovement.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - easeOfMovement.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - easeOfMovement.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - easeOfMovement.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - easeOfMovement.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - easeOfMovement.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - easeOfMovement.explain(input): ArrayLike; default: not declared - easeOfMovement.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - easeOfMovement.explain(parameters).period: number; default: not declared - easeOfMovement.explain(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - easeOfMovement.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - easeOfMovement.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - easeOfMovement.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - easeOfMovement.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - easeOfMovement.fromJSON().return.value: number | null; default: not declared - easeOfMovement.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - easeOfMovement.fromJSON(snapshot).kind: string; default: not declared - easeOfMovement.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - easeOfMovement.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - easeOfMovement.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - easeOfMovement.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - easeOfMovement.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - easeOfMovement.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - easeOfMovement.stream().return.value: number | null; default: not declared - easeOfMovement.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - easeOfMovement.stream(parameters).period: number; default: not declared - easeOfMovement.stream(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - ebsw: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Even Better Sinewave (pandas-ta `ebsw`), bounded roughly to [-1, 1]. Matches pandas-ta **including its degree/radian translation defect** — it is not Ehlers's published filter (see `EbswStream` and `docs/compatibility/talib-differences.md`). - ebsw(input): ArrayLike; default: not declared - ebsw(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EbswParameters | undefined; default: not declared - ebsw(parameters).bars?: number; default: not declared — Low-pass filtering period. Default 10. - ebsw(parameters).period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. - ebsw.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').EbswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ebsw.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ebsw.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ebsw.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ebsw.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ebsw.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ebsw.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ebsw.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ebsw.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ebsw.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ebsw.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ebsw.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ebsw.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ebsw.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ebsw.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ebsw.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ebsw.explain(input): ArrayLike; default: not declared - ebsw.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EbswParameters | undefined; default: not declared - ebsw.explain(parameters).bars?: number; default: not declared — Low-pass filtering period. Default 10. - ebsw.explain(parameters).period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. - ebsw.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ebsw.fromJSON().return.next: (input: number) => number | null; default: not declared - ebsw.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ebsw.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ebsw.fromJSON().return.value: number | null; default: not declared - ebsw.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ebsw.fromJSON(snapshot).kind: string; default: not declared - ebsw.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ebsw.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ebsw.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').EbswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ebsw.stream().return.next: (input: number) => number | null; default: not declared - ebsw.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ebsw.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ebsw.stream().return.value: number | null; default: not declared - ebsw.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EbswParameters | undefined; default: not declared - ebsw.stream(parameters).bars?: number; default: not declared — Low-pass filtering period. Default 10. - ebsw.stream(parameters).period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. - efficiencyRatio: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - efficiencyRatio(input): ArrayLike; default: not declared - efficiencyRatio(parameters)?: { period?: number; } | undefined; default: not declared - efficiencyRatio(parameters).period?: number; default: not declared - efficiencyRatio.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - efficiencyRatio.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - efficiencyRatio.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - efficiencyRatio.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - efficiencyRatio.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - efficiencyRatio.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - efficiencyRatio.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - efficiencyRatio.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - efficiencyRatio.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - efficiencyRatio.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - efficiencyRatio.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - efficiencyRatio.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - efficiencyRatio.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - efficiencyRatio.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - efficiencyRatio.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - efficiencyRatio.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - efficiencyRatio.explain(input): ArrayLike; default: not declared - efficiencyRatio.explain(parameters)?: { period?: number; } | undefined; default: not declared - efficiencyRatio.explain(parameters).period?: number; default: not declared - efficiencyRatio.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - efficiencyRatio.fromJSON().return.next: (input: number) => number | null; default: not declared - efficiencyRatio.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - efficiencyRatio.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - efficiencyRatio.fromJSON().return.value: number | null; default: not declared - efficiencyRatio.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - efficiencyRatio.fromJSON(snapshot).kind: string; default: not declared - efficiencyRatio.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - efficiencyRatio.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - efficiencyRatio.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - efficiencyRatio.stream().return.next: (input: number) => number | null; default: not declared - efficiencyRatio.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - efficiencyRatio.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - efficiencyRatio.stream().return.value: number | null; default: not declared - efficiencyRatio.stream(parameters)?: { period?: number; } | undefined; default: not declared - efficiencyRatio.stream(parameters).period?: number; default: not declared - efi: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Elder's Force Index (alias of `forceIndex`). - efi(input): ArrayLike; default: not declared - efi(parameters)?: { period?: number; } | undefined; default: not declared - efi(parameters).period?: number; default: not declared - efi.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - efi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - efi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - efi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - efi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - efi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - efi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - efi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - efi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - efi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - efi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - efi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - efi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - efi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - efi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - efi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - efi.explain(input): ArrayLike; default: not declared - efi.explain(parameters)?: { period?: number; } | undefined; default: not declared - efi.explain(parameters).period?: number; default: not declared - efi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - efi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - efi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - efi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - efi.fromJSON().return.value: number | null; default: not declared - efi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - efi.fromJSON(snapshot).kind: string; default: not declared - efi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - efi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - efi.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - efi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - efi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - efi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - efi.stream().return.value: number | null; default: not declared - efi.stream(parameters)?: { period?: number; } | undefined; default: not declared - efi.stream(parameters).period?: number; default: not declared - elderRay: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint>; default: not declared - elderRay(input): ArrayLike; default: not declared - elderRay(parameters)?: { period?: number; } | undefined; default: not declared - elderRay(parameters).period?: number; default: not declared - elderRay.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - elderRay.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - elderRay.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - elderRay.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - elderRay.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - elderRay.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - elderRay.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - elderRay.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - elderRay.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - elderRay.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - elderRay.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - elderRay.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - elderRay.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - elderRay.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - elderRay.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - elderRay.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - elderRay.explain(input): ArrayLike; default: not declared - elderRay.explain(parameters)?: { period?: number; } | undefined; default: not declared - elderRay.explain(parameters).period?: number; default: not declared - elderRay.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - elderRay.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint | null; default: not declared - elderRay.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - elderRay.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - elderRay.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint | null; default: not declared - elderRay.fromJSON().return.value.bear: number; default: not declared - elderRay.fromJSON().return.value.bull: number; default: not declared - elderRay.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - elderRay.fromJSON(snapshot).kind: string; default: not declared - elderRay.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - elderRay.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - elderRay.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - elderRay.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint | null; default: not declared - elderRay.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - elderRay.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - elderRay.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ElderRayPoint | null; default: not declared - elderRay.stream().return.value.bear: number; default: not declared - elderRay.stream().return.value.bull: number; default: not declared - elderRay.stream(parameters)?: { period?: number; } | undefined; default: not declared - elderRay.stream(parameters).period?: number; default: not declared - elderThermometer: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - elderThermometer(input): ArrayLike; default: not declared - elderThermometer(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerParameters | undefined; default: not declared - elderThermometer(parameters).long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - elderThermometer(parameters).period?: number; default: not declared - elderThermometer(parameters).short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. - elderThermometer.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - elderThermometer.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - elderThermometer.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - elderThermometer.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - elderThermometer.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - elderThermometer.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - elderThermometer.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - elderThermometer.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - elderThermometer.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - elderThermometer.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - elderThermometer.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - elderThermometer.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - elderThermometer.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - elderThermometer.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - elderThermometer.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - elderThermometer.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - elderThermometer.explain(input): ArrayLike; default: not declared - elderThermometer.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerParameters | undefined; default: not declared - elderThermometer.explain(parameters).long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - elderThermometer.explain(parameters).period?: number; default: not declared - elderThermometer.explain(parameters).short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. - elderThermometer.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - elderThermometer.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint | null; default: not declared - elderThermometer.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - elderThermometer.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - elderThermometer.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint | null; default: not declared - elderThermometer.fromJSON().return.value.long: number; default: not declared — 1 when thermo < movingAverage·long (calm). - elderThermometer.fromJSON().return.value.movingAverage: number; default: not declared - elderThermometer.fromJSON().return.value.short: number; default: not declared — 1 when thermo > movingAverage·short (active). - elderThermometer.fromJSON().return.value.thermo: number; default: not declared - elderThermometer.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - elderThermometer.fromJSON(snapshot).kind: string; default: not declared - elderThermometer.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - elderThermometer.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - elderThermometer.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - elderThermometer.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint | null; default: not declared - elderThermometer.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - elderThermometer.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - elderThermometer.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerPoint | null; default: not declared - elderThermometer.stream().return.value.long: number; default: not declared — 1 when thermo < movingAverage·long (calm). - elderThermometer.stream().return.value.movingAverage: number; default: not declared - elderThermometer.stream().return.value.short: number; default: not declared — 1 when thermo > movingAverage·short (active). - elderThermometer.stream().return.value.thermo: number; default: not declared - elderThermometer.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ElderThermometerParameters | undefined; default: not declared - elderThermometer.stream(parameters).long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - elderThermometer.stream(parameters).period?: number; default: not declared - elderThermometer.stream(parameters).short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. - ema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - ema(input): ArrayLike; default: not declared - ema(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - ema(parameters).period: number; default: not declared - ema.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ema.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ema.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ema.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ema.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ema.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ema.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ema.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ema.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ema.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ema.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ema.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ema.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ema.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ema.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ema.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ema.explain(input): ArrayLike; default: not declared - ema.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - ema.explain(parameters).period: number; default: not declared - ema.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ema.fromJSON().return.next: (input: number) => number | null; default: not declared - ema.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ema.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ema.fromJSON().return.value: number | null; default: not declared - ema.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ema.fromJSON(snapshot).kind: string; default: not declared - ema.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ema.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ema.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ema.stream().return.next: (input: number) => number | null; default: not declared - ema.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ema.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ema.stream().return.value: number | null; default: not declared - ema.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - ema.stream(parameters).period: number; default: not declared - emv: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Ease of Movement (alias of `easeOfMovement`). - emv(input): ArrayLike; default: not declared - emv(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - emv(parameters).period: number; default: not declared - emv(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - emv.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - emv.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - emv.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - emv.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - emv.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - emv.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - emv.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - emv.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - emv.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - emv.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - emv.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - emv.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - emv.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - emv.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - emv.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - emv.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - emv.explain(input): ArrayLike; default: not declared - emv.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - emv.explain(parameters).period: number; default: not declared - emv.explain(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - emv.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - emv.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - emv.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - emv.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - emv.fromJSON().return.value: number | null; default: not declared - emv.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - emv.fromJSON(snapshot).kind: string; default: not declared - emv.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - emv.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - emv.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - emv.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - emv.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - emv.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - emv.stream().return.value: number | null; default: not declared - emv.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - emv.stream(parameters).period: number; default: not declared - emv.stream(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - entropy: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling Shannon entropy (pandas-ta: each value as a fraction of the window sum), in bits. - entropy(input): ArrayLike; default: not declared - entropy(parameters)?: { period?: number; } | undefined; default: not declared - entropy(parameters).period?: number; default: not declared - entropy.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - entropy.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - entropy.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - entropy.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - entropy.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - entropy.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - entropy.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - entropy.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - entropy.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - entropy.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - entropy.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - entropy.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - entropy.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - entropy.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - entropy.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - entropy.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - entropy.explain(input): ArrayLike; default: not declared - entropy.explain(parameters)?: { period?: number; } | undefined; default: not declared - entropy.explain(parameters).period?: number; default: not declared - entropy.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - entropy.fromJSON().return.next: (input: number) => number | null; default: not declared - entropy.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - entropy.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - entropy.fromJSON().return.value: number | null; default: not declared - entropy.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - entropy.fromJSON(snapshot).kind: string; default: not declared - entropy.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - entropy.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - entropy.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - entropy.stream().return.next: (input: number) => number | null; default: not declared - entropy.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - entropy.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - entropy.stream().return.value: number | null; default: not declared - entropy.stream(parameters)?: { period?: number; } | undefined; default: not declared - entropy.stream(parameters).period?: number; default: not declared - equalHighs: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Equal highs — consecutive swing highs within `tolerance` (a buy-side liquidity pool). - equalHighs(input): ArrayLike; default: not declared - equalHighs(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined; default: not declared - equalHighs(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - equalHighs(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - equalHighs.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - equalHighs.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - equalHighs.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - equalHighs.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - equalHighs.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - equalHighs.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - equalHighs.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - equalHighs.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - equalHighs.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - equalHighs.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - equalHighs.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - equalHighs.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - equalHighs.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - equalHighs.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - equalHighs.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - equalHighs.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - equalHighs.explain(input): ArrayLike; default: not declared - equalHighs.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined; default: not declared - equalHighs.explain(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - equalHighs.explain(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - equalHighs.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - equalHighs.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalHighs.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - equalHighs.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - equalHighs.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalHighs.fromJSON().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - equalHighs.fromJSON().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - equalHighs.fromJSON().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - equalHighs.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - equalHighs.fromJSON(snapshot).kind: string; default: not declared - equalHighs.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - equalHighs.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - equalHighs.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - equalHighs.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalHighs.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - equalHighs.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - equalHighs.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalHighs.stream().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - equalHighs.stream().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - equalHighs.stream().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - equalHighs.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined; default: not declared - equalHighs.stream(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - equalHighs.stream(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - equalLows: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Equal lows — consecutive swing lows within `tolerance` (a sell-side liquidity pool). - equalLows(input): ArrayLike; default: not declared - equalLows(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined; default: not declared - equalLows(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - equalLows(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - equalLows.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - equalLows.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - equalLows.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - equalLows.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - equalLows.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - equalLows.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - equalLows.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - equalLows.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - equalLows.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - equalLows.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - equalLows.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - equalLows.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - equalLows.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - equalLows.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - equalLows.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - equalLows.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - equalLows.explain(input): ArrayLike; default: not declared - equalLows.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined; default: not declared - equalLows.explain(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - equalLows.explain(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - equalLows.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - equalLows.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalLows.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - equalLows.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - equalLows.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalLows.fromJSON().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - equalLows.fromJSON().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - equalLows.fromJSON().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - equalLows.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - equalLows.fromJSON(snapshot).kind: string; default: not declared - equalLows.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - equalLows.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - equalLows.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - equalLows.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalLows.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - equalLows.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - equalLows.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelPoint | null; default: not declared - equalLows.stream().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - equalLows.stream().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - equalLows.stream().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - equalLows.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EqualLevelParameters | undefined; default: not declared - equalLows.stream(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - equalLows.stream(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - exp: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - exp(input): ArrayLike; default: not declared - exp(parameters)?: {} | undefined; default: not declared - exp.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - exp.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - exp.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - exp.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - exp.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - exp.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - exp.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - exp.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - exp.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - exp.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - exp.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - exp.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - exp.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - exp.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - exp.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - exp.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - exp.explain(input): ArrayLike; default: not declared - exp.explain(parameters)?: {} | undefined; default: not declared - exp.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - exp.fromJSON().return.next: (input: number) => number | null; default: not declared - exp.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - exp.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - exp.fromJSON().return.value: number | null; default: not declared - exp.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - exp.fromJSON(snapshot).kind: string; default: not declared - exp.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - exp.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - exp.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - exp.stream().return.next: (input: number) => number | null; default: not declared - exp.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - exp.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - exp.stream().return.value: number | null; default: not declared - exp.stream(parameters)?: {} | undefined; default: not declared - exponentialDecay: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Exponential decay floor — same shape, with an `exp(−period)` step (decays far more slowly). - exponentialDecay(input): ArrayLike; default: not declared - exponentialDecay(parameters)?: { period?: number; } | undefined; default: not declared - exponentialDecay(parameters).period?: number; default: not declared - exponentialDecay.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - exponentialDecay.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - exponentialDecay.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - exponentialDecay.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - exponentialDecay.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - exponentialDecay.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - exponentialDecay.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - exponentialDecay.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - exponentialDecay.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - exponentialDecay.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - exponentialDecay.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - exponentialDecay.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - exponentialDecay.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - exponentialDecay.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - exponentialDecay.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - exponentialDecay.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - exponentialDecay.explain(input): ArrayLike; default: not declared - exponentialDecay.explain(parameters)?: { period?: number; } | undefined; default: not declared - exponentialDecay.explain(parameters).period?: number; default: not declared - exponentialDecay.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - exponentialDecay.fromJSON().return.next: (input: number) => number | null; default: not declared - exponentialDecay.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - exponentialDecay.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - exponentialDecay.fromJSON().return.value: number | null; default: not declared - exponentialDecay.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - exponentialDecay.fromJSON(snapshot).kind: string; default: not declared - exponentialDecay.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - exponentialDecay.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - exponentialDecay.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - exponentialDecay.stream().return.next: (input: number) => number | null; default: not declared - exponentialDecay.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - exponentialDecay.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - exponentialDecay.stream().return.value: number | null; default: not declared - exponentialDecay.stream(parameters)?: { period?: number; } | undefined; default: not declared - exponentialDecay.stream(parameters).period?: number; default: not declared - fairValueGaps: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - fairValueGaps(input): ArrayLike; default: not declared - fairValueGaps(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FvgParameters | undefined; default: not declared - fairValueGaps(parameters).minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. - fairValueGaps.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').FvgParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - fairValueGaps.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - fairValueGaps.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - fairValueGaps.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - fairValueGaps.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - fairValueGaps.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - fairValueGaps.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - fairValueGaps.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - fairValueGaps.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - fairValueGaps.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - fairValueGaps.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - fairValueGaps.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - fairValueGaps.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - fairValueGaps.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fairValueGaps.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - fairValueGaps.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ZonePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - fairValueGaps.explain(input): ArrayLike; default: not declared - fairValueGaps.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FvgParameters | undefined; default: not declared - fairValueGaps.explain(parameters).minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. - fairValueGaps.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fairValueGaps.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - fairValueGaps.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fairValueGaps.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fairValueGaps.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - fairValueGaps.fromJSON().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - fairValueGaps.fromJSON().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - fairValueGaps.fromJSON().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - fairValueGaps.fromJSON().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - fairValueGaps.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fairValueGaps.fromJSON(snapshot).kind: string; default: not declared - fairValueGaps.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fairValueGaps.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - fairValueGaps.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').FvgParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fairValueGaps.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - fairValueGaps.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fairValueGaps.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fairValueGaps.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - fairValueGaps.stream().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - fairValueGaps.stream().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - fairValueGaps.stream().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - fairValueGaps.stream().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - fairValueGaps.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FvgParameters | undefined; default: not declared - fairValueGaps.stream(parameters).minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. - falling: (operand: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - falling().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - falling(operand): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - features: (candles: import('@insiderfinance/totalfinance/technical-analysis').BarInput[]) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.applyBars: (indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: AliasOpt & { as: string; }) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — Apply any bar indicator (BarInput → Out) to the candles. - features().return.applySeries: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: AliasOpt & { as: string; }) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — Apply any series indicator (number → Out) to a price field. The generic escape hatch that lets the pipeline reach every indicator in the catalog, not just the named convenience methods. - features().return.atr: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — `parameters` is optional: ATR's Wilder period defaults to 14, exactly as `atr(bars)` does. - features().return.bbands: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').BollingerParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — `parameters` is optional: Bollinger's period defaults to 20, exactly as `bbands(series)` does. - features().return.column: (alias: string, values: import('@insiderfinance/totalfinance/technical-analysis').FeatureColumn) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — Inject a precomputed column under an alias. - features().return.ema: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.field: (field: import('@insiderfinance/totalfinance/technical-analysis').Field) => number[]; default: not declared — The raw `field` column (`close`, `high`, …) as a number array. - features().return.macd: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.obv: (options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.returns: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.rollingVolatility: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.rsi: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — `parameters` is optional: RSI's period defaults to 14, exactly as `rsi(series)` does. - features().return.sma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared — The convenience methods all follow one order, and the order is the point: validate the alias, then CALL THE INDICATOR, then build the auto-name from the parameters it just accepted. The first version built the name first — `` `sma_${field}_${parameters.period}` `` — so a caller who omitted `parameters` got `TypeError: Cannot read properties of undefined (reading 'period')` from the pipeline instead of `sma`'s own teaching `InputError`. Worse for `rsi` and `atr`, whose direct forms default to 14: the fluent wrapper was STRICTER than the thing it wraps. Calling the indicator first delegates every parameter question to the validator that owns it. - features().return.toColumns: () => Record; default: not declared — Columnar output keyed by alias. - features().return.toRows: () => Record[]; default: not declared — Row-oriented output: one object per bar with each alias as a key. - features().return.vwap: (options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features().return.wma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').FeaturePipeline; default: not declared - features(candles): import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - fibExtension: (input: import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; default: not declared - fibExtension(input): import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput; default: not declared - fibExtension(input).end: number; default: not declared - fibExtension(input).levels?: readonly number[]; default: not declared - fibExtension(input).projectFrom: number; default: not declared - fibExtension(input).start: number; default: not declared - fibRetracement: (start: number, end: number, levels?: readonly number[]) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; default: not declared — Fibonacci retracement levels for a move from `start` (origin / 100% line) to `end` (extreme / 0% line): `price(r) = end + (start − end)·r`. Direction-agnostic — works for up- and down-moves. - fibRetracement(end): number; default: not declared - fibRetracement(levels)?: readonly number[]; default: not declared - fibRetracement(start): number; default: not declared - fisherTransform: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - fisherTransform(input): ArrayLike; default: not declared - fisherTransform(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FisherParameters | undefined; default: not declared - fisherTransform(parameters).period?: number; default: not declared - fisherTransform.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').FisherParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - fisherTransform.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - fisherTransform.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - fisherTransform.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - fisherTransform.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - fisherTransform.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - fisherTransform.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - fisherTransform.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - fisherTransform.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - fisherTransform.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - fisherTransform.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - fisherTransform.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - fisherTransform.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - fisherTransform.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fisherTransform.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - fisherTransform.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').FisherPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - fisherTransform.explain(input): ArrayLike; default: not declared - fisherTransform.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FisherParameters | undefined; default: not declared - fisherTransform.explain(parameters).period?: number; default: not declared - fisherTransform.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fisherTransform.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').FisherPoint | null; default: not declared - fisherTransform.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').FisherPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fisherTransform.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fisherTransform.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').FisherPoint | null; default: not declared - fisherTransform.fromJSON().return.value.fisher: number; default: not declared - fisherTransform.fromJSON().return.value.trigger: number; default: not declared - fisherTransform.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fisherTransform.fromJSON(snapshot).kind: string; default: not declared - fisherTransform.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fisherTransform.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - fisherTransform.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').FisherParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fisherTransform.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').FisherPoint | null; default: not declared - fisherTransform.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').FisherPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fisherTransform.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fisherTransform.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').FisherPoint | null; default: not declared - fisherTransform.stream().return.value.fisher: number; default: not declared - fisherTransform.stream().return.value.trigger: number; default: not declared - fisherTransform.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FisherParameters | undefined; default: not declared - fisherTransform.stream(parameters).period?: number; default: not declared - floor: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - floor(input): ArrayLike; default: not declared - floor(parameters)?: {} | undefined; default: not declared - floor.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - floor.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - floor.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - floor.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - floor.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - floor.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - floor.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - floor.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - floor.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - floor.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - floor.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - floor.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - floor.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - floor.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - floor.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - floor.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - floor.explain(input): ArrayLike; default: not declared - floor.explain(parameters)?: {} | undefined; default: not declared - floor.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - floor.fromJSON().return.next: (input: number) => number | null; default: not declared - floor.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - floor.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - floor.fromJSON().return.value: number | null; default: not declared - floor.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - floor.fromJSON(snapshot).kind: string; default: not declared - floor.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - floor.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - floor.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - floor.stream().return.next: (input: number) => number | null; default: not declared - floor.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - floor.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - floor.stream().return.value: number | null; default: not declared - floor.stream(parameters)?: {} | undefined; default: not declared - footprintBars: (trades: readonly import('@insiderfinance/totalfinance/technical-analysis').Trade[], parameters: import('@insiderfinance/totalfinance/technical-analysis').FootprintBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').FootprintBar[]; default: not declared — Aggregate a trade tape into OHLCV bars annotated with the aggressor footprint (buy/sell volume and delta), bucketing by trade `count`, cumulative `volume`, or `time`. - footprintBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').FootprintBarParameters; default: not declared - footprintBars(parameters).by?: 'time' | 'volume' | 'count'; default: not declared — Aggregation rule and threshold. `by` defaults to `'volume'`. - footprintBars(parameters).method?: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; default: not declared - footprintBars(parameters).quotes?: readonly import('@insiderfinance/totalfinance/technical-analysis').Quote[]; default: not declared - footprintBars(parameters).threshold: number; default: not declared — Trades per bar (`count`), volume per bar (`volume`), or milliseconds per bar (`time`). - footprintBars(trades): readonly import('@insiderfinance/totalfinance/technical-analysis').Trade[]; default: not declared - forceIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - forceIndex(input): ArrayLike; default: not declared - forceIndex(parameters)?: { period?: number; } | undefined; default: not declared - forceIndex(parameters).period?: number; default: not declared - forceIndex.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - forceIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - forceIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - forceIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - forceIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - forceIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - forceIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - forceIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - forceIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - forceIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - forceIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - forceIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - forceIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - forceIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - forceIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - forceIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - forceIndex.explain(input): ArrayLike; default: not declared - forceIndex.explain(parameters)?: { period?: number; } | undefined; default: not declared - forceIndex.explain(parameters).period?: number; default: not declared - forceIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - forceIndex.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - forceIndex.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - forceIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - forceIndex.fromJSON().return.value: number | null; default: not declared - forceIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - forceIndex.fromJSON(snapshot).kind: string; default: not declared - forceIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - forceIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - forceIndex.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - forceIndex.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - forceIndex.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - forceIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - forceIndex.stream().return.value: number | null; default: not declared - forceIndex.stream(parameters)?: { period?: number; } | undefined; default: not declared - forceIndex.stream(parameters).period?: number; default: not declared - forecastOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Forecast Oscillator: % distance of price from its time-series forecast (one bar ahead). - forecastOscillator(input): ArrayLike; default: not declared - forecastOscillator(parameters)?: { period?: number; } | undefined; default: not declared - forecastOscillator(parameters).period?: number; default: not declared - forecastOscillator.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - forecastOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - forecastOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - forecastOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - forecastOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - forecastOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - forecastOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - forecastOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - forecastOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - forecastOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - forecastOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - forecastOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - forecastOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - forecastOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - forecastOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - forecastOscillator.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - forecastOscillator.explain(input): ArrayLike; default: not declared - forecastOscillator.explain(parameters)?: { period?: number; } | undefined; default: not declared - forecastOscillator.explain(parameters).period?: number; default: not declared - forecastOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - forecastOscillator.fromJSON().return.next: (input: number) => number | null; default: not declared - forecastOscillator.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - forecastOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - forecastOscillator.fromJSON().return.value: number | null; default: not declared - forecastOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - forecastOscillator.fromJSON(snapshot).kind: string; default: not declared - forecastOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - forecastOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - forecastOscillator.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - forecastOscillator.stream().return.next: (input: number) => number | null; default: not declared - forecastOscillator.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - forecastOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - forecastOscillator.stream().return.value: number | null; default: not declared - forecastOscillator.stream(parameters)?: { period?: number; } | undefined; default: not declared - forecastOscillator.stream(parameters).period?: number; default: not declared - fractals: (bars: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis/price-action').Fractals; default: not declared — Bill Williams fractals: a 5-bar swing (strength 2). - fractals().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - fractals().return.assumptions.conventionsVersion: string; default: not declared - fractals().return.assumptions.strength: number; default: not declared - fractals().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - fractals().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - fractals().return.down: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - fractals().return.up: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - fractals(bars): ArrayLike; default: not declared - fractionalChange: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Fractional change: `(input[i] − input[i − period]) / input[i − period]`. - fractionalChange(input): ArrayLike; default: not declared - fractionalChange(parameters)?: { period?: number; } | undefined; default: not declared - fractionalChange(parameters).period?: number; default: not declared - fractionalChange.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - fractionalChange.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - fractionalChange.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - fractionalChange.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - fractionalChange.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - fractionalChange.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - fractionalChange.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - fractionalChange.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - fractionalChange.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - fractionalChange.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - fractionalChange.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - fractionalChange.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - fractionalChange.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - fractionalChange.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fractionalChange.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - fractionalChange.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - fractionalChange.explain(input): ArrayLike; default: not declared - fractionalChange.explain(parameters)?: { period?: number; } | undefined; default: not declared - fractionalChange.explain(parameters).period?: number; default: not declared - fractionalChange.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fractionalChange.fromJSON().return.next: (input: number) => number | null; default: not declared - fractionalChange.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fractionalChange.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fractionalChange.fromJSON().return.value: number | null; default: not declared - fractionalChange.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fractionalChange.fromJSON(snapshot).kind: string; default: not declared - fractionalChange.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fractionalChange.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - fractionalChange.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fractionalChange.stream().return.next: (input: number) => number | null; default: not declared - fractionalChange.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fractionalChange.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fractionalChange.stream().return.value: number | null; default: not declared - fractionalChange.stream(parameters)?: { period?: number; } | undefined; default: not declared - fractionalChange.stream(parameters).period?: number; default: not declared - frama: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - frama(input): ArrayLike; default: not declared - frama(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FramaParameters | undefined; default: not declared - frama(parameters).period: number; default: not declared — Lookback (rounded up to an even number). Default 16. - frama.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').FramaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - frama.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - frama.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - frama.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - frama.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - frama.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - frama.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - frama.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - frama.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - frama.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - frama.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - frama.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - frama.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - frama.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - frama.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - frama.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - frama.explain(input): ArrayLike; default: not declared - frama.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FramaParameters | undefined; default: not declared - frama.explain(parameters).period: number; default: not declared — Lookback (rounded up to an even number). Default 16. - frama.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - frama.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - frama.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - frama.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - frama.fromJSON().return.value: number | null; default: not declared - frama.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - frama.fromJSON(snapshot).kind: string; default: not declared - frama.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - frama.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - frama.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').FramaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - frama.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - frama.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - frama.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - frama.stream().return.value: number | null; default: not declared - frama.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').FramaParameters | undefined; default: not declared - frama.stream(parameters).period: number; default: not declared — Lookback (rounded up to an even number). Default 16. - fwma: import('@insiderfinance/totalfinance/technical-analysis').Indicator<({ period: number; }), number, number>; default: not declared - fwma(input): ArrayLike; default: not declared - fwma(parameters)?: ({ period: number; }) | undefined; default: not declared - fwma(parameters).period: number; default: not declared - fwma.explain: (input: ArrayLike, parameters?: ({ period: number; }) | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - fwma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - fwma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - fwma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - fwma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - fwma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - fwma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - fwma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - fwma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - fwma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - fwma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - fwma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - fwma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - fwma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fwma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - fwma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - fwma.explain(input): ArrayLike; default: not declared - fwma.explain(parameters)?: ({ period: number; }) | undefined; default: not declared - fwma.explain(parameters).period: number; default: not declared - fwma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fwma.fromJSON().return.next: (input: number) => number | null; default: not declared - fwma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fwma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fwma.fromJSON().return.value: number | null; default: not declared - fwma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fwma.fromJSON(snapshot).kind: string; default: not declared - fwma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fwma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - fwma.stream: (parameters?: ({ period: number; }) | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fwma.stream().return.next: (input: number) => number | null; default: not declared - fwma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fwma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - fwma.stream().return.value: number | null; default: not declared - fwma.stream(parameters)?: ({ period: number; }) | undefined; default: not declared - fwma.stream(parameters).period: number; default: not declared - gannHighLowActivator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint>; default: not declared - gannHighLowActivator(input): ArrayLike; default: not declared - gannHighLowActivator(parameters)?: { period?: number; } | undefined; default: not declared - gannHighLowActivator(parameters).period?: number; default: not declared - gannHighLowActivator.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - gannHighLowActivator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - gannHighLowActivator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - gannHighLowActivator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - gannHighLowActivator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - gannHighLowActivator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - gannHighLowActivator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - gannHighLowActivator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - gannHighLowActivator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - gannHighLowActivator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - gannHighLowActivator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - gannHighLowActivator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - gannHighLowActivator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - gannHighLowActivator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - gannHighLowActivator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - gannHighLowActivator.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - gannHighLowActivator.explain(input): ArrayLike; default: not declared - gannHighLowActivator.explain(parameters)?: { period?: number; } | undefined; default: not declared - gannHighLowActivator.explain(parameters).period?: number; default: not declared - gannHighLowActivator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - gannHighLowActivator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint | null; default: not declared - gannHighLowActivator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - gannHighLowActivator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - gannHighLowActivator.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint | null; default: not declared - gannHighLowActivator.fromJSON().return.value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - gannHighLowActivator.fromJSON().return.value.value: number; default: not declared — The active HiLo line. - gannHighLowActivator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - gannHighLowActivator.fromJSON(snapshot).kind: string; default: not declared - gannHighLowActivator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - gannHighLowActivator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - gannHighLowActivator.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - gannHighLowActivator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint | null; default: not declared - gannHighLowActivator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - gannHighLowActivator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - gannHighLowActivator.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').GannHiLoPoint | null; default: not declared - gannHighLowActivator.stream().return.value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - gannHighLowActivator.stream().return.value.value: number; default: not declared — The active HiLo line. - gannHighLowActivator.stream(parameters)?: { period?: number; } | undefined; default: not declared - gannHighLowActivator.stream(parameters).period?: number; default: not declared - gap: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - gap(input): ArrayLike; default: not declared - gap(parameters)?: {} | undefined; default: not declared - gap.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - gap.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - gap.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - gap.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - gap.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - gap.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - gap.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - gap.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - gap.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - gap.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - gap.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - gap.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - gap.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - gap.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - gap.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - gap.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - gap.explain(input): ArrayLike; default: not declared - gap.explain(parameters)?: {} | undefined; default: not declared - gap.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - gap.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - gap.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - gap.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - gap.fromJSON().return.value: number | null; default: not declared - gap.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - gap.fromJSON(snapshot).kind: string; default: not declared - gap.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - gap.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - gap.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - gap.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - gap.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - gap.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - gap.stream().return.value: number | null; default: not declared - gap.stream(parameters)?: {} | undefined; default: not declared - gapFill: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapFillReport; default: not declared — Opening gaps with fill tracking: the same events {@link gaps} detects, plus whether and when each one closed. A gap fills when a later bar trades back to the prior close. A gap requires the open to leave the prior bar's RANGE — above its high or below its low — which is the definition {@link gaps} uses and the only one that means anything on a real tape. This function previously fired on any open that merely differed from the prior close: on a 500-bar random walk with no true gaps, `gaps()` returned 0 events and this returned 499, one per bar. The two are now the same event universe, so `sizeFraction` and `minSizeFraction` mean the same thing in both and a caller can pair them. `minSizeFraction` filters small gaps as a FRACTION of the prior close (`0.005` = 0.5%), the same unit `sizeFraction` reports. Default 0 — every detected gap. - gapFill().return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - gapFill().return.assumptions.conventionsVersion: string; default: not declared - gapFill().return.assumptions.minSizeFraction: number; default: not declared - gapFill().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - gapFill().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - gapFill().return.events: import('@insiderfinance/totalfinance/technical-analysis').GapFillEvent[]; default: not declared - gapFill(bars): ArrayLike; default: not declared - gapFill(options)?: { minSizeFraction?: number; }; default: not declared - gapFill(options).minSizeFraction?: number; default: not declared - gaps: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapsReport; default: not declared — Opening gaps: this bar's open leaves the prior bar's RANGE (above its high or below its low). `sizeFraction` is measured from the prior CLOSE — the level a fill has to trade back to — and `minSizeFraction` filters in that same unit (`0.005` = 0.5%). {@link gapFill} detects exactly these events and adds fill tracking. - gaps().return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - gaps().return.assumptions.conventionsVersion: string; default: not declared - gaps().return.assumptions.minSizeFraction: number; default: not declared - gaps().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - gaps().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - gaps().return.gaps: import('@insiderfinance/totalfinance/technical-analysis').Gap[]; default: not declared - gaps(bars): ArrayLike; default: not declared - gaps(options)?: { minSizeFraction?: number; }; default: not declared - gaps(options).minSizeFraction?: number; default: not declared - garmanKlass: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - garmanKlass(input): ArrayLike; default: not declared - garmanKlass(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - garmanKlass(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - garmanKlass(parameters).period: number; default: not declared - garmanKlass.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - garmanKlass.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - garmanKlass.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - garmanKlass.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - garmanKlass.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - garmanKlass.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - garmanKlass.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - garmanKlass.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - garmanKlass.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - garmanKlass.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - garmanKlass.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - garmanKlass.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - garmanKlass.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - garmanKlass.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - garmanKlass.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - garmanKlass.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - garmanKlass.explain(input): ArrayLike; default: not declared - garmanKlass.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - garmanKlass.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - garmanKlass.explain(parameters).period: number; default: not declared - garmanKlass.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - garmanKlass.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - garmanKlass.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - garmanKlass.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - garmanKlass.fromJSON().return.value: number | null; default: not declared - garmanKlass.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - garmanKlass.fromJSON(snapshot).kind: string; default: not declared - garmanKlass.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - garmanKlass.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - garmanKlass.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - garmanKlass.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - garmanKlass.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - garmanKlass.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - garmanKlass.stream().return.value: number | null; default: not declared - garmanKlass.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - garmanKlass.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - garmanKlass.stream(parameters).period: number; default: not declared - getIndicator: (name: string) => Readonly | undefined; default: not declared — The registered entry for `name`, or `undefined`. The result is DEEPLY FROZEN. It is a view of the registry, not a copy to edit: mutating it used to reach the facade's own validation allowlist. - getIndicator().return.category: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - getIndicator().return.conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - getIndicator().return.defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - getIndicator().return.indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - getIndicator().return.indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - getIndicator().return.indicator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - getIndicator().return.indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - getIndicator().return.inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared - getIndicator().return.name: string; default: not declared - getIndicator().return.output: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - getIndicator().return.parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). - getIndicator(name): string; default: not declared - gt: (left: import('@insiderfinance/totalfinance/technical-analysis').Operand, right: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - gt().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - gt(left): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - gt(right): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - gte: (left: import('@insiderfinance/totalfinance/technical-analysis').Operand, right: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - gte().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - gte(left): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - gte(right): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - hasIndicator: (name: string) => boolean; default: not declared - hasIndicator(name): string; default: not declared - heikinAshi: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar>; default: not declared - heikinAshi(input): ArrayLike; default: not declared - heikinAshi(parameters)?: {} | undefined; default: not declared - heikinAshi.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - heikinAshi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - heikinAshi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - heikinAshi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - heikinAshi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - heikinAshi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - heikinAshi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - heikinAshi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - heikinAshi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - heikinAshi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - heikinAshi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - heikinAshi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - heikinAshi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - heikinAshi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - heikinAshi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - heikinAshi.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - heikinAshi.explain(input): ArrayLike; default: not declared - heikinAshi.explain(parameters)?: {} | undefined; default: not declared - heikinAshi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - heikinAshi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar | null; default: not declared - heikinAshi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - heikinAshi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - heikinAshi.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar | null; default: not declared - heikinAshi.fromJSON().return.value.close: number; default: not declared - heikinAshi.fromJSON().return.value.high: number; default: not declared - heikinAshi.fromJSON().return.value.low: number; default: not declared - heikinAshi.fromJSON().return.value.open: number; default: not declared - heikinAshi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - heikinAshi.fromJSON(snapshot).kind: string; default: not declared - heikinAshi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - heikinAshi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - heikinAshi.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - heikinAshi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar | null; default: not declared - heikinAshi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - heikinAshi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - heikinAshi.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').HeikinAshiBar | null; default: not declared - heikinAshi.stream().return.value.close: number; default: not declared - heikinAshi.stream().return.value.high: number; default: not declared - heikinAshi.stream().return.value.low: number; default: not declared - heikinAshi.stream().return.value.open: number; default: not declared - heikinAshi.stream(parameters)?: {} | undefined; default: not declared - highestBars: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Bars-ago of the rolling window high (alias of `rollingMaxIndex`). - highestBars(input): ArrayLike; default: not declared - highestBars(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - highestBars(parameters).period: number; default: not declared - highestBars.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - highestBars.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - highestBars.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - highestBars.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - highestBars.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - highestBars.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - highestBars.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - highestBars.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - highestBars.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - highestBars.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - highestBars.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - highestBars.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - highestBars.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - highestBars.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - highestBars.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - highestBars.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - highestBars.explain(input): ArrayLike; default: not declared - highestBars.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - highestBars.explain(parameters).period: number; default: not declared - highestBars.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - highestBars.fromJSON().return.next: (input: number) => number | null; default: not declared - highestBars.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - highestBars.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - highestBars.fromJSON().return.value: number | null; default: not declared - highestBars.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - highestBars.fromJSON(snapshot).kind: string; default: not declared - highestBars.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - highestBars.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - highestBars.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - highestBars.stream().return.next: (input: number) => number | null; default: not declared - highestBars.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - highestBars.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - highestBars.stream().return.value: number | null; default: not declared - highestBars.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - highestBars.stream(parameters).period: number; default: not declared - historicalVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - historicalVolatility(input): ArrayLike; default: not declared - historicalVolatility(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined; default: not declared - historicalVolatility(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - historicalVolatility(parameters).period: number; default: not declared - historicalVolatility.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - historicalVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - historicalVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - historicalVolatility.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - historicalVolatility.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - historicalVolatility.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - historicalVolatility.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - historicalVolatility.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - historicalVolatility.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - historicalVolatility.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - historicalVolatility.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - historicalVolatility.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - historicalVolatility.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - historicalVolatility.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - historicalVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - historicalVolatility.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - historicalVolatility.explain(input): ArrayLike; default: not declared - historicalVolatility.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined; default: not declared - historicalVolatility.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - historicalVolatility.explain(parameters).period: number; default: not declared - historicalVolatility.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - historicalVolatility.fromJSON().return.next: (input: number) => number | null; default: not declared - historicalVolatility.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - historicalVolatility.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - historicalVolatility.fromJSON().return.value: number | null; default: not declared - historicalVolatility.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - historicalVolatility.fromJSON(snapshot).kind: string; default: not declared - historicalVolatility.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - historicalVolatility.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - historicalVolatility.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - historicalVolatility.stream().return.next: (input: number) => number | null; default: not declared - historicalVolatility.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - historicalVolatility.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - historicalVolatility.stream().return.value: number | null; default: not declared - historicalVolatility.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined; default: not declared - historicalVolatility.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - historicalVolatility.stream(parameters).period: number; default: not declared - hl2: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — (high + low) / 2 — alias of `medianPrice`. - hl2(input): ArrayLike; default: not declared - hl2(parameters)?: {} | undefined; default: not declared - hl2.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - hl2.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - hl2.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - hl2.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - hl2.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - hl2.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - hl2.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - hl2.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - hl2.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - hl2.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - hl2.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - hl2.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - hl2.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - hl2.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - hl2.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - hl2.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - hl2.explain(input): ArrayLike; default: not declared - hl2.explain(parameters)?: {} | undefined; default: not declared - hl2.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - hl2.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - hl2.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - hl2.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hl2.fromJSON().return.value: number | null; default: not declared - hl2.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hl2.fromJSON(snapshot).kind: string; default: not declared - hl2.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - hl2.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - hl2.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - hl2.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - hl2.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - hl2.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hl2.stream().return.value: number | null; default: not declared - hl2.stream(parameters)?: {} | undefined; default: not declared - hlc3: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — (high + low + close) / 3 — alias of `typicalPrice`. - hlc3(input): ArrayLike; default: not declared - hlc3(parameters)?: {} | undefined; default: not declared - hlc3.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - hlc3.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - hlc3.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - hlc3.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - hlc3.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - hlc3.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - hlc3.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - hlc3.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - hlc3.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - hlc3.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - hlc3.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - hlc3.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - hlc3.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - hlc3.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - hlc3.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - hlc3.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - hlc3.explain(input): ArrayLike; default: not declared - hlc3.explain(parameters)?: {} | undefined; default: not declared - hlc3.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - hlc3.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - hlc3.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - hlc3.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hlc3.fromJSON().return.value: number | null; default: not declared - hlc3.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hlc3.fromJSON(snapshot).kind: string; default: not declared - hlc3.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - hlc3.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - hlc3.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - hlc3.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - hlc3.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - hlc3.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hlc3.stream().return.value: number | null; default: not declared - hlc3.stream(parameters)?: {} | undefined; default: not declared - hma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - hma(input): ArrayLike; default: not declared - hma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - hma(parameters).period: number; default: not declared - hma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - hma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - hma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - hma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - hma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - hma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - hma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - hma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - hma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - hma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - hma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - hma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - hma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - hma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - hma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - hma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - hma.explain(input): ArrayLike; default: not declared - hma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - hma.explain(parameters).period: number; default: not declared - hma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - hma.fromJSON().return.next: (input: number) => number | null; default: not declared - hma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - hma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hma.fromJSON().return.value: number | null; default: not declared - hma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hma.fromJSON(snapshot).kind: string; default: not declared - hma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - hma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - hma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - hma.stream().return.next: (input: number) => number | null; default: not declared - hma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - hma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - hma.stream().return.value: number | null; default: not declared - hma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - hma.stream(parameters).period: number; default: not declared - holtWinterChannel: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - holtWinterChannel(input): ArrayLike; default: not declared - holtWinterChannel(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HoltWinterChannelParameters | undefined; default: not declared - holtWinterChannel(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - holtWinterChannel(parameters).levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - holtWinterChannel(parameters).scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - holtWinterChannel(parameters).trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - holtWinterChannel(parameters).varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. - holtWinterChannel.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').HoltWinterChannelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - holtWinterChannel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - holtWinterChannel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - holtWinterChannel.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - holtWinterChannel.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - holtWinterChannel.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - holtWinterChannel.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - holtWinterChannel.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - holtWinterChannel.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - holtWinterChannel.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - holtWinterChannel.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - holtWinterChannel.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - holtWinterChannel.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - holtWinterChannel.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - holtWinterChannel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - holtWinterChannel.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - holtWinterChannel.explain(input): ArrayLike; default: not declared - holtWinterChannel.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HoltWinterChannelParameters | undefined; default: not declared - holtWinterChannel.explain(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - holtWinterChannel.explain(parameters).levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - holtWinterChannel.explain(parameters).scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - holtWinterChannel.explain(parameters).trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - holtWinterChannel.explain(parameters).varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. - holtWinterChannel.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - holtWinterChannel.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - holtWinterChannel.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - holtWinterChannel.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - holtWinterChannel.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - holtWinterChannel.fromJSON().return.value.lower: number; default: not declared - holtWinterChannel.fromJSON().return.value.middle: number; default: not declared - holtWinterChannel.fromJSON().return.value.upper: number; default: not declared - holtWinterChannel.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - holtWinterChannel.fromJSON(snapshot).kind: string; default: not declared - holtWinterChannel.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - holtWinterChannel.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - holtWinterChannel.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').HoltWinterChannelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - holtWinterChannel.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - holtWinterChannel.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - holtWinterChannel.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - holtWinterChannel.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - holtWinterChannel.stream().return.value.lower: number; default: not declared - holtWinterChannel.stream().return.value.middle: number; default: not declared - holtWinterChannel.stream().return.value.upper: number; default: not declared - holtWinterChannel.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HoltWinterChannelParameters | undefined; default: not declared - holtWinterChannel.stream(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - holtWinterChannel.stream(parameters).levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - holtWinterChannel.stream(parameters).scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - holtWinterChannel.stream(parameters).trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - holtWinterChannel.stream(parameters).varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. - holtWinterMovingAverage: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - holtWinterMovingAverage(input): ArrayLike; default: not declared - holtWinterMovingAverage(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HwmaParameters | undefined; default: not declared - holtWinterMovingAverage(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - holtWinterMovingAverage(parameters).levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - holtWinterMovingAverage(parameters).trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. - holtWinterMovingAverage.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').HwmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - holtWinterMovingAverage.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - holtWinterMovingAverage.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - holtWinterMovingAverage.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - holtWinterMovingAverage.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - holtWinterMovingAverage.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - holtWinterMovingAverage.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - holtWinterMovingAverage.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - holtWinterMovingAverage.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - holtWinterMovingAverage.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - holtWinterMovingAverage.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - holtWinterMovingAverage.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - holtWinterMovingAverage.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - holtWinterMovingAverage.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - holtWinterMovingAverage.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - holtWinterMovingAverage.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - holtWinterMovingAverage.explain(input): ArrayLike; default: not declared - holtWinterMovingAverage.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HwmaParameters | undefined; default: not declared - holtWinterMovingAverage.explain(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - holtWinterMovingAverage.explain(parameters).levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - holtWinterMovingAverage.explain(parameters).trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. - holtWinterMovingAverage.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - holtWinterMovingAverage.fromJSON().return.next: (input: number) => number | null; default: not declared - holtWinterMovingAverage.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - holtWinterMovingAverage.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - holtWinterMovingAverage.fromJSON().return.value: number | null; default: not declared - holtWinterMovingAverage.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - holtWinterMovingAverage.fromJSON(snapshot).kind: string; default: not declared - holtWinterMovingAverage.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - holtWinterMovingAverage.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - holtWinterMovingAverage.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').HwmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - holtWinterMovingAverage.stream().return.next: (input: number) => number | null; default: not declared - holtWinterMovingAverage.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - holtWinterMovingAverage.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - holtWinterMovingAverage.stream().return.value: number | null; default: not declared - holtWinterMovingAverage.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HwmaParameters | undefined; default: not declared - holtWinterMovingAverage.stream(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - holtWinterMovingAverage.stream(parameters).levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - holtWinterMovingAverage.stream(parameters).trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. - htDcPeriod: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - htDcPeriod(input): ArrayLike; default: not declared - htDcPeriod(parameters)?: {} | undefined; default: not declared - htDcPeriod.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - htDcPeriod.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - htDcPeriod.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - htDcPeriod.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - htDcPeriod.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - htDcPeriod.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - htDcPeriod.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - htDcPeriod.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - htDcPeriod.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - htDcPeriod.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - htDcPeriod.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - htDcPeriod.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - htDcPeriod.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - htDcPeriod.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - htDcPeriod.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - htDcPeriod.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - htDcPeriod.explain(input): ArrayLike; default: not declared - htDcPeriod.explain(parameters)?: {} | undefined; default: not declared - htDcPeriod.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htDcPeriod.fromJSON().return.next: (input: number) => number | null; default: not declared - htDcPeriod.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htDcPeriod.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htDcPeriod.fromJSON().return.value: number | null; default: not declared - htDcPeriod.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htDcPeriod.fromJSON(snapshot).kind: string; default: not declared - htDcPeriod.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - htDcPeriod.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - htDcPeriod.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htDcPeriod.stream().return.next: (input: number) => number | null; default: not declared - htDcPeriod.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htDcPeriod.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htDcPeriod.stream().return.value: number | null; default: not declared - htDcPeriod.stream(parameters)?: {} | undefined; default: not declared - htDcPhase: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - htDcPhase(input): ArrayLike; default: not declared - htDcPhase(parameters)?: {} | undefined; default: not declared - htDcPhase.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - htDcPhase.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - htDcPhase.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - htDcPhase.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - htDcPhase.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - htDcPhase.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - htDcPhase.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - htDcPhase.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - htDcPhase.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - htDcPhase.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - htDcPhase.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - htDcPhase.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - htDcPhase.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - htDcPhase.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - htDcPhase.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - htDcPhase.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - htDcPhase.explain(input): ArrayLike; default: not declared - htDcPhase.explain(parameters)?: {} | undefined; default: not declared - htDcPhase.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htDcPhase.fromJSON().return.next: (input: number) => number | null; default: not declared - htDcPhase.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htDcPhase.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htDcPhase.fromJSON().return.value: number | null; default: not declared - htDcPhase.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htDcPhase.fromJSON(snapshot).kind: string; default: not declared - htDcPhase.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - htDcPhase.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - htDcPhase.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htDcPhase.stream().return.next: (input: number) => number | null; default: not declared - htDcPhase.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htDcPhase.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htDcPhase.stream().return.value: number | null; default: not declared - htDcPhase.stream(parameters)?: {} | undefined; default: not declared - htPhasor: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint>; default: not declared - htPhasor(input): ArrayLike; default: not declared - htPhasor(parameters)?: {} | undefined; default: not declared - htPhasor.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - htPhasor.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - htPhasor.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - htPhasor.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - htPhasor.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - htPhasor.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - htPhasor.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - htPhasor.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - htPhasor.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - htPhasor.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - htPhasor.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - htPhasor.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - htPhasor.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - htPhasor.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - htPhasor.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - htPhasor.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - htPhasor.explain(input): ArrayLike; default: not declared - htPhasor.explain(parameters)?: {} | undefined; default: not declared - htPhasor.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htPhasor.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint | null; default: not declared - htPhasor.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htPhasor.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htPhasor.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint | null; default: not declared - htPhasor.fromJSON().return.value.inPhase: number; default: not declared - htPhasor.fromJSON().return.value.quadrature: number; default: not declared - htPhasor.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htPhasor.fromJSON(snapshot).kind: string; default: not declared - htPhasor.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - htPhasor.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - htPhasor.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htPhasor.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint | null; default: not declared - htPhasor.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htPhasor.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htPhasor.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').PhasorPoint | null; default: not declared - htPhasor.stream().return.value.inPhase: number; default: not declared - htPhasor.stream().return.value.quadrature: number; default: not declared - htPhasor.stream(parameters)?: {} | undefined; default: not declared - htSine: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, import('@insiderfinance/totalfinance/technical-analysis').SinePoint>; default: not declared - htSine(input): ArrayLike; default: not declared - htSine(parameters)?: {} | undefined; default: not declared - htSine.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - htSine.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - htSine.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - htSine.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - htSine.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - htSine.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - htSine.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - htSine.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - htSine.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - htSine.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - htSine.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - htSine.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - htSine.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - htSine.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - htSine.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - htSine.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').SinePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - htSine.explain(input): ArrayLike; default: not declared - htSine.explain(parameters)?: {} | undefined; default: not declared - htSine.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htSine.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SinePoint | null; default: not declared - htSine.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SinePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htSine.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htSine.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').SinePoint | null; default: not declared - htSine.fromJSON().return.value.leadSine: number; default: not declared - htSine.fromJSON().return.value.sine: number; default: not declared - htSine.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htSine.fromJSON(snapshot).kind: string; default: not declared - htSine.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - htSine.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - htSine.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htSine.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SinePoint | null; default: not declared - htSine.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SinePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htSine.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htSine.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').SinePoint | null; default: not declared - htSine.stream().return.value.leadSine: number; default: not declared - htSine.stream().return.value.sine: number; default: not declared - htSine.stream(parameters)?: {} | undefined; default: not declared - htTrendMode: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - htTrendMode(input): ArrayLike; default: not declared - htTrendMode(parameters)?: {} | undefined; default: not declared - htTrendMode.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - htTrendMode.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - htTrendMode.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - htTrendMode.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - htTrendMode.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - htTrendMode.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - htTrendMode.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - htTrendMode.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - htTrendMode.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - htTrendMode.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - htTrendMode.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - htTrendMode.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - htTrendMode.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - htTrendMode.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - htTrendMode.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - htTrendMode.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - htTrendMode.explain(input): ArrayLike; default: not declared - htTrendMode.explain(parameters)?: {} | undefined; default: not declared - htTrendMode.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htTrendMode.fromJSON().return.next: (input: number) => number | null; default: not declared - htTrendMode.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htTrendMode.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htTrendMode.fromJSON().return.value: number | null; default: not declared - htTrendMode.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htTrendMode.fromJSON(snapshot).kind: string; default: not declared - htTrendMode.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - htTrendMode.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - htTrendMode.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htTrendMode.stream().return.next: (input: number) => number | null; default: not declared - htTrendMode.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htTrendMode.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htTrendMode.stream().return.value: number | null; default: not declared - htTrendMode.stream(parameters)?: {} | undefined; default: not declared - htTrendline: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - htTrendline(input): ArrayLike; default: not declared - htTrendline(parameters)?: {} | undefined; default: not declared - htTrendline.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - htTrendline.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - htTrendline.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - htTrendline.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - htTrendline.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - htTrendline.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - htTrendline.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - htTrendline.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - htTrendline.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - htTrendline.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - htTrendline.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - htTrendline.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - htTrendline.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - htTrendline.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - htTrendline.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - htTrendline.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - htTrendline.explain(input): ArrayLike; default: not declared - htTrendline.explain(parameters)?: {} | undefined; default: not declared - htTrendline.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htTrendline.fromJSON().return.next: (input: number) => number | null; default: not declared - htTrendline.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htTrendline.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htTrendline.fromJSON().return.value: number | null; default: not declared - htTrendline.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htTrendline.fromJSON(snapshot).kind: string; default: not declared - htTrendline.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - htTrendline.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - htTrendline.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - htTrendline.stream().return.next: (input: number) => number | null; default: not declared - htTrendline.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - htTrendline.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - htTrendline.stream().return.value: number | null; default: not declared - htTrendline.stream(parameters)?: {} | undefined; default: not declared - ichimoku: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - ichimoku(input): ArrayLike; default: not declared - ichimoku(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').IchimokuParameters | undefined; default: not declared - ichimoku(parameters).base?: number; default: not declared - ichimoku(parameters).conversion?: number; default: not declared - ichimoku(parameters).displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - ichimoku(parameters).spanB?: number; default: not declared - ichimoku.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').IchimokuParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ichimoku.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ichimoku.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ichimoku.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ichimoku.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ichimoku.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ichimoku.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ichimoku.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ichimoku.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ichimoku.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ichimoku.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ichimoku.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ichimoku.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ichimoku.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ichimoku.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ichimoku.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ichimoku.explain(input): ArrayLike; default: not declared - ichimoku.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').IchimokuParameters | undefined; default: not declared - ichimoku.explain(parameters).base?: number; default: not declared - ichimoku.explain(parameters).conversion?: number; default: not declared - ichimoku.explain(parameters).displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - ichimoku.explain(parameters).spanB?: number; default: not declared - ichimoku.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ichimoku.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint | null; default: not declared - ichimoku.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ichimoku.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ichimoku.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint | null; default: not declared - ichimoku.fromJSON().return.value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - ichimoku.fromJSON().return.value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - ichimoku.fromJSON().return.value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - ichimoku.fromJSON().return.value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - ichimoku.fromJSON().return.value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - ichimoku.fromJSON().return.value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - ichimoku.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ichimoku.fromJSON(snapshot).kind: string; default: not declared - ichimoku.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ichimoku.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ichimoku.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').IchimokuParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ichimoku.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint | null; default: not declared - ichimoku.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ichimoku.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ichimoku.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').IchimokuPoint | null; default: not declared - ichimoku.stream().return.value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - ichimoku.stream().return.value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - ichimoku.stream().return.value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - ichimoku.stream().return.value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - ichimoku.stream().return.value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - ichimoku.stream().return.value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - ichimoku.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').IchimokuParameters | undefined; default: not declared - ichimoku.stream(parameters).base?: number; default: not declared - ichimoku.stream(parameters).conversion?: number; default: not declared - ichimoku.stream(parameters).displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - ichimoku.stream(parameters).spanB?: number; default: not declared - imbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Tick imbalance bars — close on `|Σ sign(Δclose)|`. - imbalanceBars(bars): ArrayLike; default: not declared - imbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - imbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - imbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - increasing: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — 1 when the series is higher than `period` bars ago (strict → every step rose). - increasing(input): ArrayLike; default: not declared - increasing(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined; default: not declared - increasing(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - increasing(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - increasing.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - increasing.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - increasing.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - increasing.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - increasing.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - increasing.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - increasing.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - increasing.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - increasing.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - increasing.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - increasing.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - increasing.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - increasing.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - increasing.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - increasing.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - increasing.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - increasing.explain(input): ArrayLike; default: not declared - increasing.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined; default: not declared - increasing.explain(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - increasing.explain(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - increasing.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - increasing.fromJSON().return.next: (input: number) => number | null; default: not declared - increasing.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - increasing.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - increasing.fromJSON().return.value: number | null; default: not declared - increasing.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - increasing.fromJSON(snapshot).kind: string; default: not declared - increasing.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - increasing.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - increasing.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - increasing.stream().return.next: (input: number) => number | null; default: not declared - increasing.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - increasing.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - increasing.stream().return.value: number | null; default: not declared - increasing.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrendTestParameters | undefined; default: not declared - increasing.stream(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - increasing.stream(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - indicatorCategories: () => import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory[]; default: not declared - indicatorWarmup: (name: string, probeLength?: number) => import('@insiderfinance/totalfinance/technical-analysis').WarmupMetadata; default: not declared — The warmup of a SINGLE indicator (alias-aware name), measured on a probe series — the targeted counterpart to {@link indicatorWarmups} for a `describe`-style lookup that shouldn't probe all 335. - indicatorWarmup().return.category: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - indicatorWarmup().return.inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared - indicatorWarmup().return.name: string; default: not declared - indicatorWarmup().return.parameters: Record; default: not declared — The canonical parameters used to measure the warmup. - indicatorWarmup().return.warmup: number | null; default: not declared — Leading bars before the first real value, or `null` if it never emitted within the probe. - indicatorWarmup(name): string; default: not declared - indicatorWarmup(probeLength)?: number; default: not declared - indicatorWarmups: (probeLength?: number) => import('@insiderfinance/totalfinance/technical-analysis').WarmupMetadata[]; default: not declared — Measure the warmup of every registered indicator at canonical parameters. `probeLength` must exceed the longest warmup (default 512 comfortably covers the catalog). - indicatorWarmups(probeLength)?: number; default: not declared - inertia: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - inertia(input): ArrayLike; default: not declared - inertia(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').InertiaParameters | undefined; default: not declared - inertia(parameters).period?: number; default: not declared - inertia(parameters).rviPeriod?: number; default: not declared - inertia.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').InertiaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - inertia.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - inertia.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - inertia.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - inertia.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - inertia.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - inertia.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - inertia.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - inertia.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - inertia.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - inertia.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - inertia.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - inertia.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - inertia.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - inertia.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - inertia.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - inertia.explain(input): ArrayLike; default: not declared - inertia.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').InertiaParameters | undefined; default: not declared - inertia.explain(parameters).period?: number; default: not declared - inertia.explain(parameters).rviPeriod?: number; default: not declared - inertia.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - inertia.fromJSON().return.next: (input: number) => number | null; default: not declared - inertia.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - inertia.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - inertia.fromJSON().return.value: number | null; default: not declared - inertia.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - inertia.fromJSON(snapshot).kind: string; default: not declared - inertia.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - inertia.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - inertia.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').InertiaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - inertia.stream().return.next: (input: number) => number | null; default: not declared - inertia.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - inertia.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - inertia.stream().return.value: number | null; default: not declared - inertia.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').InertiaParameters | undefined; default: not declared - inertia.stream(parameters).period?: number; default: not declared - inertia.stream(parameters).rviPeriod?: number; default: not declared - jma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - jma(input): ArrayLike; default: not declared - jma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').JmaParameters | undefined; default: not declared - jma(parameters).period: number; default: not declared - jma(parameters).phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - jma(parameters).power?: number; default: not declared — Smoothing power on β (default 1). - jma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').JmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - jma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - jma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - jma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - jma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - jma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - jma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - jma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - jma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - jma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - jma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - jma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - jma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - jma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - jma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - jma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - jma.explain(input): ArrayLike; default: not declared - jma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').JmaParameters | undefined; default: not declared - jma.explain(parameters).period: number; default: not declared - jma.explain(parameters).phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - jma.explain(parameters).power?: number; default: not declared — Smoothing power on β (default 1). - jma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - jma.fromJSON().return.next: (input: number) => number | null; default: not declared - jma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - jma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - jma.fromJSON().return.value: number | null; default: not declared - jma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - jma.fromJSON(snapshot).kind: string; default: not declared - jma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - jma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - jma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').JmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - jma.stream().return.next: (input: number) => number | null; default: not declared - jma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - jma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - jma.stream().return.value: number | null; default: not declared - jma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').JmaParameters | undefined; default: not declared - jma.stream(parameters).period: number; default: not declared - jma.stream(parameters).phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - jma.stream(parameters).power?: number; default: not declared — Smoothing power on β (default 1). - kagi: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').KagiParameters) => import('@insiderfinance/totalfinance/technical-analysis').KagiSegment[]; default: not declared - kagi(bars): ArrayLike; default: not declared - kagi(parameters): import('@insiderfinance/totalfinance/technical-analysis').KagiParameters; default: not declared - kagi(parameters).percent?: boolean; default: not declared - kagi(parameters).reversal: number; default: not declared — Reversal amount. Absolute price by default, or a percent of price if `percent` is true. - kama: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - kama(input): ArrayLike; default: not declared - kama(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KamaParameters | undefined; default: not declared - kama(parameters).fast?: number; default: not declared — Fast EMA constant period. Default 2. - kama(parameters).period: number; default: not declared - kama(parameters).slow?: number; default: not declared — Slow EMA constant period. Default 30. - kama.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - kama.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - kama.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - kama.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - kama.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - kama.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - kama.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - kama.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - kama.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - kama.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - kama.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - kama.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - kama.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - kama.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - kama.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - kama.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - kama.explain(input): ArrayLike; default: not declared - kama.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KamaParameters | undefined; default: not declared - kama.explain(parameters).fast?: number; default: not declared — Fast EMA constant period. Default 2. - kama.explain(parameters).period: number; default: not declared - kama.explain(parameters).slow?: number; default: not declared — Slow EMA constant period. Default 30. - kama.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kama.fromJSON().return.next: (input: number) => number | null; default: not declared - kama.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kama.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kama.fromJSON().return.value: number | null; default: not declared - kama.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kama.fromJSON(snapshot).kind: string; default: not declared - kama.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - kama.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - kama.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kama.stream().return.next: (input: number) => number | null; default: not declared - kama.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kama.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kama.stream().return.value: number | null; default: not declared - kama.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KamaParameters | undefined; default: not declared - kama.stream(parameters).fast?: number; default: not declared — Fast EMA constant period. Default 2. - kama.stream(parameters).period: number; default: not declared - kama.stream(parameters).slow?: number; default: not declared — Slow EMA constant period. Default 30. - kdj: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - kdj(input): ArrayLike; default: not declared - kdj(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KdjParameters | undefined; default: not declared - kdj(parameters).period?: number; default: not declared - kdj(parameters).signal?: number; default: not declared - kdj.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KdjParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - kdj.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - kdj.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - kdj.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - kdj.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - kdj.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - kdj.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - kdj.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - kdj.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - kdj.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - kdj.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - kdj.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - kdj.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - kdj.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - kdj.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - kdj.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').KdjPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - kdj.explain(input): ArrayLike; default: not declared - kdj.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KdjParameters | undefined; default: not declared - kdj.explain(parameters).period?: number; default: not declared - kdj.explain(parameters).signal?: number; default: not declared - kdj.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kdj.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KdjPoint | null; default: not declared - kdj.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KdjPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kdj.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kdj.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').KdjPoint | null; default: not declared - kdj.fromJSON().return.value.d: number; default: not declared - kdj.fromJSON().return.value.j: number; default: not declared - kdj.fromJSON().return.value.k: number; default: not declared - kdj.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kdj.fromJSON(snapshot).kind: string; default: not declared - kdj.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - kdj.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - kdj.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KdjParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kdj.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KdjPoint | null; default: not declared - kdj.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KdjPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kdj.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kdj.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').KdjPoint | null; default: not declared - kdj.stream().return.value.d: number; default: not declared - kdj.stream().return.value.j: number; default: not declared - kdj.stream().return.value.k: number; default: not declared - kdj.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KdjParameters | undefined; default: not declared - kdj.stream(parameters).period?: number; default: not declared - kdj.stream(parameters).signal?: number; default: not declared - keltner: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - keltner(input): ArrayLike; default: not declared - keltner(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KeltnerParameters | undefined; default: not declared - keltner(parameters).atrPeriod?: number; default: not declared - keltner(parameters).multiplier?: number; default: not declared - keltner(parameters).period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. - keltner.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KeltnerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - keltner.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - keltner.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - keltner.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - keltner.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - keltner.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - keltner.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - keltner.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - keltner.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - keltner.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - keltner.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - keltner.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - keltner.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - keltner.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - keltner.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - keltner.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - keltner.explain(input): ArrayLike; default: not declared - keltner.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KeltnerParameters | undefined; default: not declared - keltner.explain(parameters).atrPeriod?: number; default: not declared - keltner.explain(parameters).multiplier?: number; default: not declared - keltner.explain(parameters).period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. - keltner.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - keltner.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - keltner.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - keltner.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - keltner.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - keltner.fromJSON().return.value.lower: number; default: not declared - keltner.fromJSON().return.value.middle: number; default: not declared - keltner.fromJSON().return.value.upper: number; default: not declared - keltner.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - keltner.fromJSON(snapshot).kind: string; default: not declared - keltner.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - keltner.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - keltner.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KeltnerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - keltner.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - keltner.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - keltner.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - keltner.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ChannelPoint | null; default: not declared - keltner.stream().return.value.lower: number; default: not declared - keltner.stream().return.value.middle: number; default: not declared - keltner.stream().return.value.upper: number; default: not declared - keltner.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KeltnerParameters | undefined; default: not declared - keltner.stream(parameters).atrPeriod?: number; default: not declared - keltner.stream(parameters).multiplier?: number; default: not declared - keltner.stream(parameters).period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. - klinger: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - klinger(input): ArrayLike; default: not declared - klinger(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - klinger(parameters).fast?: number; default: not declared - klinger(parameters).signal?: number; default: not declared - klinger(parameters).slow?: number; default: not declared - klinger.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - klinger.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - klinger.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - klinger.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - klinger.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - klinger.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - klinger.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - klinger.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - klinger.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - klinger.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - klinger.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - klinger.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - klinger.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - klinger.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - klinger.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - klinger.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - klinger.explain(input): ArrayLike; default: not declared - klinger.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - klinger.explain(parameters).fast?: number; default: not declared - klinger.explain(parameters).signal?: number; default: not declared - klinger.explain(parameters).slow?: number; default: not declared - klinger.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - klinger.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - klinger.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - klinger.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - klinger.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - klinger.fromJSON().return.value.klinger: number; default: not declared - klinger.fromJSON().return.value.signal: number; default: not declared - klinger.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - klinger.fromJSON(snapshot).kind: string; default: not declared - klinger.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - klinger.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - klinger.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - klinger.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - klinger.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - klinger.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - klinger.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - klinger.stream().return.value.klinger: number; default: not declared - klinger.stream().return.value.signal: number; default: not declared - klinger.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - klinger.stream(parameters).fast?: number; default: not declared - klinger.stream(parameters).signal?: number; default: not declared - klinger.stream(parameters).slow?: number; default: not declared - kst: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - kst(input): ArrayLike; default: not declared - kst(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KstParameters | undefined; default: not declared - kst(parameters).rocPeriods?: [number, number, number, number]; default: not declared - kst(parameters).signal?: number; default: not declared - kst(parameters).smaPeriods?: [number, number, number, number]; default: not declared - kst.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KstParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - kst.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - kst.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - kst.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - kst.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - kst.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - kst.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - kst.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - kst.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - kst.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - kst.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - kst.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - kst.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - kst.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - kst.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - kst.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').KstPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - kst.explain(input): ArrayLike; default: not declared - kst.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KstParameters | undefined; default: not declared - kst.explain(parameters).rocPeriods?: [number, number, number, number]; default: not declared - kst.explain(parameters).signal?: number; default: not declared - kst.explain(parameters).smaPeriods?: [number, number, number, number]; default: not declared - kst.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kst.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').KstPoint | null; default: not declared - kst.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').KstPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kst.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kst.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').KstPoint | null; default: not declared - kst.fromJSON().return.value.kst: number; default: not declared - kst.fromJSON().return.value.signal: number; default: not declared - kst.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kst.fromJSON(snapshot).kind: string; default: not declared - kst.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - kst.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - kst.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KstParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kst.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').KstPoint | null; default: not declared - kst.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').KstPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kst.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kst.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').KstPoint | null; default: not declared - kst.stream().return.value.kst: number; default: not declared - kst.stream().return.value.signal: number; default: not declared - kst.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KstParameters | undefined; default: not declared - kst.stream(parameters).rocPeriods?: [number, number, number, number]; default: not declared - kst.stream(parameters).signal?: number; default: not declared - kst.stream(parameters).smaPeriods?: [number, number, number, number]; default: not declared - kurtosis: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling sample excess kurtosis (bias-corrected G2). - kurtosis(input): ArrayLike; default: not declared - kurtosis(parameters)?: { period?: number; } | undefined; default: not declared - kurtosis(parameters).period?: number; default: not declared - kurtosis.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - kurtosis.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - kurtosis.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - kurtosis.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - kurtosis.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - kurtosis.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - kurtosis.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - kurtosis.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - kurtosis.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - kurtosis.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - kurtosis.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - kurtosis.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - kurtosis.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - kurtosis.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - kurtosis.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - kurtosis.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - kurtosis.explain(input): ArrayLike; default: not declared - kurtosis.explain(parameters)?: { period?: number; } | undefined; default: not declared - kurtosis.explain(parameters).period?: number; default: not declared - kurtosis.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kurtosis.fromJSON().return.next: (input: number) => number | null; default: not declared - kurtosis.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kurtosis.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kurtosis.fromJSON().return.value: number | null; default: not declared - kurtosis.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kurtosis.fromJSON(snapshot).kind: string; default: not declared - kurtosis.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - kurtosis.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - kurtosis.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kurtosis.stream().return.next: (input: number) => number | null; default: not declared - kurtosis.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kurtosis.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kurtosis.stream().return.value: number | null; default: not declared - kurtosis.stream(parameters)?: { period?: number; } | undefined; default: not declared - kurtosis.stream(parameters).period?: number; default: not declared - kvo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Klinger Volume Oscillator (alias of `klinger`). - kvo(input): ArrayLike; default: not declared - kvo(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - kvo(parameters).fast?: number; default: not declared - kvo(parameters).signal?: number; default: not declared - kvo(parameters).slow?: number; default: not declared - kvo.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - kvo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - kvo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - kvo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - kvo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - kvo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - kvo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - kvo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - kvo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - kvo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - kvo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - kvo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - kvo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - kvo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - kvo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - kvo.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - kvo.explain(input): ArrayLike; default: not declared - kvo.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - kvo.explain(parameters).fast?: number; default: not declared - kvo.explain(parameters).signal?: number; default: not declared - kvo.explain(parameters).slow?: number; default: not declared - kvo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kvo.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - kvo.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kvo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kvo.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - kvo.fromJSON().return.value.klinger: number; default: not declared - kvo.fromJSON().return.value.signal: number; default: not declared - kvo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kvo.fromJSON(snapshot).kind: string; default: not declared - kvo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - kvo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - kvo.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - kvo.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - kvo.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - kvo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - kvo.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - kvo.stream().return.value.klinger: number; default: not declared - kvo.stream().return.value.signal: number; default: not declared - kvo.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - kvo.stream(parameters).fast?: number; default: not declared - kvo.stream(parameters).signal?: number; default: not declared - kvo.stream(parameters).slow?: number; default: not declared - lag: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Alias of `shift` (causal lag; leading is not possible in a streaming model). - lag(input): ArrayLike; default: not declared - lag(parameters)?: { period?: number; } | undefined; default: not declared - lag(parameters).period?: number; default: not declared - lag.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - lag.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - lag.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - lag.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - lag.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - lag.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - lag.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - lag.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - lag.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - lag.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - lag.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - lag.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - lag.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - lag.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - lag.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - lag.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - lag.explain(input): ArrayLike; default: not declared - lag.explain(parameters)?: { period?: number; } | undefined; default: not declared - lag.explain(parameters).period?: number; default: not declared - lag.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - lag.fromJSON().return.next: (input: number) => number | null; default: not declared - lag.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - lag.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lag.fromJSON().return.value: number | null; default: not declared - lag.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lag.fromJSON(snapshot).kind: string; default: not declared - lag.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - lag.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - lag.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - lag.stream().return.next: (input: number) => number | null; default: not declared - lag.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - lag.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lag.stream().return.value: number | null; default: not declared - lag.stream(parameters)?: { period?: number; } | undefined; default: not declared - lag.stream(parameters).period?: number; default: not declared - laguerreRsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - laguerreRsi(input): ArrayLike; default: not declared - laguerreRsi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LaguerreParameters | undefined; default: not declared - laguerreRsi(parameters).gamma?: number; default: not declared - laguerreRsi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LaguerreParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - laguerreRsi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - laguerreRsi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - laguerreRsi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - laguerreRsi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - laguerreRsi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - laguerreRsi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - laguerreRsi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - laguerreRsi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - laguerreRsi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - laguerreRsi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - laguerreRsi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - laguerreRsi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - laguerreRsi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - laguerreRsi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - laguerreRsi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - laguerreRsi.explain(input): ArrayLike; default: not declared - laguerreRsi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LaguerreParameters | undefined; default: not declared - laguerreRsi.explain(parameters).gamma?: number; default: not declared - laguerreRsi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - laguerreRsi.fromJSON().return.next: (input: number) => number | null; default: not declared - laguerreRsi.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - laguerreRsi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - laguerreRsi.fromJSON().return.value: number | null; default: not declared - laguerreRsi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - laguerreRsi.fromJSON(snapshot).kind: string; default: not declared - laguerreRsi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - laguerreRsi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - laguerreRsi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').LaguerreParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - laguerreRsi.stream().return.next: (input: number) => number | null; default: not declared - laguerreRsi.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - laguerreRsi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - laguerreRsi.stream().return.value: number | null; default: not declared - laguerreRsi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LaguerreParameters | undefined; default: not declared - laguerreRsi.stream(parameters).gamma?: number; default: not declared - lineAt: (line: import('@insiderfinance/totalfinance/technical-analysis').Line, index: number) => number; default: not declared — Evaluate a fitted line (price = intercept + slope·index) at a bar index. - lineAt(index): number; default: not declared - lineAt(line): import('@insiderfinance/totalfinance/technical-analysis').Line; default: not declared - lineAt(line).from: number; default: not declared - lineAt(line).intercept: number; default: not declared - lineAt(line).slope: number; default: not declared - lineAt(line).to: number; default: not declared - lineBreak: (bars: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; default: not declared - lineBreak(bars): ArrayLike; default: not declared - lineBreak(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters; default: not declared - lineBreak(parameters).lines?: number; default: not declared - linearDecay: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Linear decay floor — the series may rise freely but falls no faster than `1/period` per bar. - linearDecay(input): ArrayLike; default: not declared - linearDecay(parameters)?: { period?: number; } | undefined; default: not declared - linearDecay(parameters).period?: number; default: not declared - linearDecay.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - linearDecay.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - linearDecay.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - linearDecay.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - linearDecay.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - linearDecay.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - linearDecay.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - linearDecay.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - linearDecay.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - linearDecay.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - linearDecay.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - linearDecay.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - linearDecay.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - linearDecay.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - linearDecay.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - linearDecay.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - linearDecay.explain(input): ArrayLike; default: not declared - linearDecay.explain(parameters)?: { period?: number; } | undefined; default: not declared - linearDecay.explain(parameters).period?: number; default: not declared - linearDecay.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linearDecay.fromJSON().return.next: (input: number) => number | null; default: not declared - linearDecay.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linearDecay.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linearDecay.fromJSON().return.value: number | null; default: not declared - linearDecay.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linearDecay.fromJSON(snapshot).kind: string; default: not declared - linearDecay.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - linearDecay.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - linearDecay.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linearDecay.stream().return.next: (input: number) => number | null; default: not declared - linearDecay.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linearDecay.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linearDecay.stream().return.value: number | null; default: not declared - linearDecay.stream(parameters)?: { period?: number; } | undefined; default: not declared - linearDecay.stream(parameters).period?: number; default: not declared - linreg: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - linreg(input): ArrayLike; default: not declared - linreg(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linreg(parameters).period: number; default: not declared - linreg.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - linreg.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - linreg.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - linreg.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - linreg.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - linreg.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - linreg.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - linreg.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - linreg.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - linreg.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - linreg.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - linreg.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - linreg.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - linreg.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - linreg.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - linreg.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').LinregPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - linreg.explain(input): ArrayLike; default: not declared - linreg.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linreg.explain(parameters).period: number; default: not declared - linreg.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linreg.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').LinregPoint | null; default: not declared - linreg.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').LinregPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linreg.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linreg.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').LinregPoint | null; default: not declared - linreg.fromJSON().return.value.angle: number; default: not declared - linreg.fromJSON().return.value.forecast: number; default: not declared - linreg.fromJSON().return.value.intercept: number; default: not declared - linreg.fromJSON().return.value.slope: number; default: not declared - linreg.fromJSON().return.value.value: number; default: not declared - linreg.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linreg.fromJSON(snapshot).kind: string; default: not declared - linreg.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - linreg.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - linreg.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linreg.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').LinregPoint | null; default: not declared - linreg.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').LinregPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linreg.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linreg.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').LinregPoint | null; default: not declared - linreg.stream().return.value.angle: number; default: not declared - linreg.stream().return.value.forecast: number; default: not declared - linreg.stream().return.value.intercept: number; default: not declared - linreg.stream().return.value.slope: number; default: not declared - linreg.stream().return.value.value: number; default: not declared - linreg.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linreg.stream(parameters).period: number; default: not declared - linregAngle: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - linregAngle(input): ArrayLike; default: not declared - linregAngle(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregAngle(parameters).period: number; default: not declared - linregAngle.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - linregAngle.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - linregAngle.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - linregAngle.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - linregAngle.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - linregAngle.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - linregAngle.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - linregAngle.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - linregAngle.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - linregAngle.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - linregAngle.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - linregAngle.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - linregAngle.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - linregAngle.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - linregAngle.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - linregAngle.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - linregAngle.explain(input): ArrayLike; default: not declared - linregAngle.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregAngle.explain(parameters).period: number; default: not declared - linregAngle.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linregAngle.fromJSON().return.next: (input: number) => number | null; default: not declared - linregAngle.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linregAngle.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregAngle.fromJSON().return.value: number | null; default: not declared - linregAngle.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregAngle.fromJSON(snapshot).kind: string; default: not declared - linregAngle.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - linregAngle.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - linregAngle.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linregAngle.stream().return.next: (input: number) => number | null; default: not declared - linregAngle.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linregAngle.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregAngle.stream().return.value: number | null; default: not declared - linregAngle.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregAngle.stream(parameters).period: number; default: not declared - linregIntercept: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - linregIntercept(input): ArrayLike; default: not declared - linregIntercept(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregIntercept(parameters).period: number; default: not declared - linregIntercept.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - linregIntercept.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - linregIntercept.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - linregIntercept.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - linregIntercept.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - linregIntercept.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - linregIntercept.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - linregIntercept.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - linregIntercept.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - linregIntercept.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - linregIntercept.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - linregIntercept.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - linregIntercept.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - linregIntercept.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - linregIntercept.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - linregIntercept.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - linregIntercept.explain(input): ArrayLike; default: not declared - linregIntercept.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregIntercept.explain(parameters).period: number; default: not declared - linregIntercept.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linregIntercept.fromJSON().return.next: (input: number) => number | null; default: not declared - linregIntercept.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linregIntercept.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregIntercept.fromJSON().return.value: number | null; default: not declared - linregIntercept.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregIntercept.fromJSON(snapshot).kind: string; default: not declared - linregIntercept.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - linregIntercept.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - linregIntercept.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linregIntercept.stream().return.next: (input: number) => number | null; default: not declared - linregIntercept.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linregIntercept.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregIntercept.stream().return.value: number | null; default: not declared - linregIntercept.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregIntercept.stream(parameters).period: number; default: not declared - linregSlope: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - linregSlope(input): ArrayLike; default: not declared - linregSlope(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregSlope(parameters).period: number; default: not declared - linregSlope.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - linregSlope.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - linregSlope.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - linregSlope.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - linregSlope.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - linregSlope.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - linregSlope.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - linregSlope.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - linregSlope.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - linregSlope.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - linregSlope.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - linregSlope.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - linregSlope.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - linregSlope.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - linregSlope.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - linregSlope.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - linregSlope.explain(input): ArrayLike; default: not declared - linregSlope.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregSlope.explain(parameters).period: number; default: not declared - linregSlope.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linregSlope.fromJSON().return.next: (input: number) => number | null; default: not declared - linregSlope.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linregSlope.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregSlope.fromJSON().return.value: number | null; default: not declared - linregSlope.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregSlope.fromJSON(snapshot).kind: string; default: not declared - linregSlope.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - linregSlope.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - linregSlope.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - linregSlope.stream().return.next: (input: number) => number | null; default: not declared - linregSlope.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - linregSlope.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - linregSlope.stream().return.value: number | null; default: not declared - linregSlope.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - linregSlope.stream(parameters).period: number; default: not declared - liquiditySweeps: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - liquiditySweeps(input): ArrayLike; default: not declared - liquiditySweeps(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepParameters | undefined; default: not declared - liquiditySweeps(parameters).lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. - liquiditySweeps.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - liquiditySweeps.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - liquiditySweeps.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - liquiditySweeps.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - liquiditySweeps.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - liquiditySweeps.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - liquiditySweeps.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - liquiditySweeps.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - liquiditySweeps.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - liquiditySweeps.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - liquiditySweeps.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - liquiditySweeps.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - liquiditySweeps.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - liquiditySweeps.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - liquiditySweeps.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - liquiditySweeps.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - liquiditySweeps.explain(input): ArrayLike; default: not declared - liquiditySweeps.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepParameters | undefined; default: not declared - liquiditySweeps.explain(parameters).lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. - liquiditySweeps.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - liquiditySweeps.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint | null; default: not declared - liquiditySweeps.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - liquiditySweeps.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - liquiditySweeps.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint | null; default: not declared - liquiditySweeps.fromJSON().return.value.direction: number; default: not declared — +1 buy-side sweep (high taken then rejected), −1 sell-side, 0 none. - liquiditySweeps.fromJSON().return.value.level: number; default: not declared — The swept liquidity level (the prior-window extreme), NaN when none. - liquiditySweeps.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - liquiditySweeps.fromJSON(snapshot).kind: string; default: not declared - liquiditySweeps.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - liquiditySweeps.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - liquiditySweeps.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - liquiditySweeps.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint | null; default: not declared - liquiditySweeps.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - liquiditySweeps.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - liquiditySweeps.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepPoint | null; default: not declared - liquiditySweeps.stream().return.value.direction: number; default: not declared — +1 buy-side sweep (high taken then rejected), −1 sell-side, 0 none. - liquiditySweeps.stream().return.value.level: number; default: not declared — The swept liquidity level (the prior-window extreme), NaN when none. - liquiditySweeps.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LiquiditySweepParameters | undefined; default: not declared - liquiditySweeps.stream(parameters).lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. - listIndicators: (category?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory) => Readonly[]; default: not declared — Every registered indicator (optionally one category). The ARRAY is fresh; the entries are frozen. - listIndicators(category)?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory | undefined; default: not declared - ln: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - ln(input): ArrayLike; default: not declared - ln(parameters)?: {} | undefined; default: not declared - ln.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ln.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ln.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ln.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ln.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ln.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ln.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ln.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ln.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ln.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ln.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ln.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ln.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ln.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ln.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ln.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ln.explain(input): ArrayLike; default: not declared - ln.explain(parameters)?: {} | undefined; default: not declared - ln.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ln.fromJSON().return.next: (input: number) => number | null; default: not declared - ln.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ln.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ln.fromJSON().return.value: number | null; default: not declared - ln.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ln.fromJSON(snapshot).kind: string; default: not declared - ln.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ln.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ln.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ln.stream().return.next: (input: number) => number | null; default: not declared - ln.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ln.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ln.stream().return.value: number | null; default: not declared - ln.stream(parameters)?: {} | undefined; default: not declared - log10: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - log10(input): ArrayLike; default: not declared - log10(parameters)?: {} | undefined; default: not declared - log10.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - log10.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - log10.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - log10.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - log10.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - log10.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - log10.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - log10.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - log10.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - log10.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - log10.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - log10.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - log10.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - log10.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - log10.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - log10.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - log10.explain(input): ArrayLike; default: not declared - log10.explain(parameters)?: {} | undefined; default: not declared - log10.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - log10.fromJSON().return.next: (input: number) => number | null; default: not declared - log10.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - log10.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - log10.fromJSON().return.value: number | null; default: not declared - log10.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - log10.fromJSON(snapshot).kind: string; default: not declared - log10.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - log10.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - log10.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - log10.stream().return.next: (input: number) => number | null; default: not declared - log10.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - log10.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - log10.stream().return.value: number | null; default: not declared - log10.stream(parameters)?: {} | undefined; default: not declared - logReturns: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; default: not declared - logReturns(input): ArrayLike; default: not declared - logReturns(parameters)?: Record | undefined; default: not declared - logReturns.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - logReturns.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - logReturns.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - logReturns.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - logReturns.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - logReturns.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - logReturns.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - logReturns.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - logReturns.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - logReturns.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - logReturns.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - logReturns.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - logReturns.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - logReturns.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - logReturns.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - logReturns.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - logReturns.explain(input): ArrayLike; default: not declared - logReturns.explain(parameters)?: Record | undefined; default: not declared - logReturns.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - logReturns.fromJSON().return.next: (input: number) => number | null; default: not declared - logReturns.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - logReturns.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - logReturns.fromJSON().return.value: number | null; default: not declared - logReturns.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - logReturns.fromJSON(snapshot).kind: string; default: not declared - logReturns.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - logReturns.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - logReturns.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - logReturns.stream().return.next: (input: number) => number | null; default: not declared - logReturns.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - logReturns.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - logReturns.stream().return.value: number | null; default: not declared - logReturns.stream(parameters)?: Record | undefined; default: not declared - longRun: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared — 1 when fast (`x`) and slow (`y`) are both rising over the lookback — a confirmed up-run. - longRun(input): ArrayLike; default: not declared - longRun(parameters)?: { period?: number; } | undefined; default: not declared - longRun(parameters).period?: number; default: not declared - longRun.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - longRun.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - longRun.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - longRun.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - longRun.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - longRun.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - longRun.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - longRun.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - longRun.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - longRun.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - longRun.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - longRun.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - longRun.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - longRun.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - longRun.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - longRun.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - longRun.explain(input): ArrayLike; default: not declared - longRun.explain(parameters)?: { period?: number; } | undefined; default: not declared - longRun.explain(parameters).period?: number; default: not declared - longRun.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - longRun.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - longRun.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - longRun.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - longRun.fromJSON().return.value: number | null; default: not declared - longRun.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - longRun.fromJSON(snapshot).kind: string; default: not declared - longRun.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - longRun.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - longRun.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - longRun.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - longRun.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - longRun.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - longRun.stream().return.value: number | null; default: not declared - longRun.stream(parameters)?: { period?: number; } | undefined; default: not declared - longRun.stream(parameters).period?: number; default: not declared - lowerShadow: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - lowerShadow(input): ArrayLike; default: not declared - lowerShadow(parameters)?: {} | undefined; default: not declared - lowerShadow.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - lowerShadow.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - lowerShadow.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - lowerShadow.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - lowerShadow.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - lowerShadow.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - lowerShadow.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - lowerShadow.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - lowerShadow.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - lowerShadow.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - lowerShadow.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - lowerShadow.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - lowerShadow.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - lowerShadow.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - lowerShadow.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - lowerShadow.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - lowerShadow.explain(input): ArrayLike; default: not declared - lowerShadow.explain(parameters)?: {} | undefined; default: not declared - lowerShadow.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - lowerShadow.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - lowerShadow.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - lowerShadow.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lowerShadow.fromJSON().return.value: number | null; default: not declared - lowerShadow.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lowerShadow.fromJSON(snapshot).kind: string; default: not declared - lowerShadow.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - lowerShadow.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - lowerShadow.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - lowerShadow.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - lowerShadow.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - lowerShadow.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lowerShadow.stream().return.value: number | null; default: not declared - lowerShadow.stream(parameters)?: {} | undefined; default: not declared - lowestBars: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Bars-ago of the rolling window low (alias of `rollingMinIndex`). - lowestBars(input): ArrayLike; default: not declared - lowestBars(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - lowestBars(parameters).period: number; default: not declared - lowestBars.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - lowestBars.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - lowestBars.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - lowestBars.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - lowestBars.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - lowestBars.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - lowestBars.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - lowestBars.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - lowestBars.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - lowestBars.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - lowestBars.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - lowestBars.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - lowestBars.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - lowestBars.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - lowestBars.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - lowestBars.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - lowestBars.explain(input): ArrayLike; default: not declared - lowestBars.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - lowestBars.explain(parameters).period: number; default: not declared - lowestBars.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - lowestBars.fromJSON().return.next: (input: number) => number | null; default: not declared - lowestBars.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - lowestBars.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lowestBars.fromJSON().return.value: number | null; default: not declared - lowestBars.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lowestBars.fromJSON(snapshot).kind: string; default: not declared - lowestBars.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - lowestBars.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - lowestBars.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - lowestBars.stream().return.next: (input: number) => number | null; default: not declared - lowestBars.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - lowestBars.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - lowestBars.stream().return.value: number | null; default: not declared - lowestBars.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - lowestBars.stream(parameters).period: number; default: not declared - lt: (left: import('@insiderfinance/totalfinance/technical-analysis').Operand, right: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - lt().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - lt(left): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - lt(right): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - lte: (left: import('@insiderfinance/totalfinance/technical-analysis').Operand, right: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - lte().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - lte(left): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - lte(right): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - macd: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - macd(input): ArrayLike; default: not declared - macd(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters | undefined; default: not declared - macd(parameters).fast?: number; default: not declared - macd(parameters).signal?: number; default: not declared - macd(parameters).slow?: number; default: not declared - macd.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - macd.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - macd.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - macd.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - macd.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - macd.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - macd.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - macd.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - macd.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - macd.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - macd.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - macd.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - macd.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - macd.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - macd.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - macd.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - macd.explain(input): ArrayLike; default: not declared - macd.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters | undefined; default: not declared - macd.explain(parameters).fast?: number; default: not declared - macd.explain(parameters).signal?: number; default: not declared - macd.explain(parameters).slow?: number; default: not declared - macd.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - macd.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macd.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - macd.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macd.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macd.fromJSON().return.value.histogram: number; default: not declared - macd.fromJSON().return.value.macd: number; default: not declared - macd.fromJSON().return.value.signal: number; default: not declared - macd.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macd.fromJSON(snapshot).kind: string; default: not declared - macd.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - macd.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - macd.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - macd.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macd.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - macd.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macd.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macd.stream().return.value.histogram: number; default: not declared - macd.stream().return.value.macd: number; default: not declared - macd.stream().return.value.signal: number; default: not declared - macd.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdParameters | undefined; default: not declared - macd.stream(parameters).fast?: number; default: not declared - macd.stream(parameters).signal?: number; default: not declared - macd.stream(parameters).slow?: number; default: not declared - macdExt: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - macdExt(input): ArrayLike; default: not declared - macdExt(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdExtParameters | undefined; default: not declared - macdExt(parameters).fast?: number; default: not declared - macdExt(parameters).fastMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt(parameters).signal?: number; default: not declared - macdExt(parameters).signalMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt(parameters).slow?: number; default: not declared - macdExt(parameters).slowMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - macdExt.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - macdExt.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - macdExt.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - macdExt.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - macdExt.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - macdExt.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - macdExt.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - macdExt.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - macdExt.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - macdExt.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - macdExt.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - macdExt.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - macdExt.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - macdExt.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - macdExt.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - macdExt.explain(input): ArrayLike; default: not declared - macdExt.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdExtParameters | undefined; default: not declared - macdExt.explain(parameters).fast?: number; default: not declared - macdExt.explain(parameters).fastMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt.explain(parameters).signal?: number; default: not declared - macdExt.explain(parameters).signalMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt.explain(parameters).slow?: number; default: not declared - macdExt.explain(parameters).slowMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - macdExt.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdExt.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - macdExt.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macdExt.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdExt.fromJSON().return.value.histogram: number; default: not declared - macdExt.fromJSON().return.value.macd: number; default: not declared - macdExt.fromJSON().return.value.signal: number; default: not declared - macdExt.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macdExt.fromJSON(snapshot).kind: string; default: not declared - macdExt.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - macdExt.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - macdExt.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - macdExt.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdExt.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - macdExt.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macdExt.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdExt.stream().return.value.histogram: number; default: not declared - macdExt.stream().return.value.macd: number; default: not declared - macdExt.stream().return.value.signal: number; default: not declared - macdExt.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdExtParameters | undefined; default: not declared - macdExt.stream(parameters).fast?: number; default: not declared - macdExt.stream(parameters).fastMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt.stream(parameters).signal?: number; default: not declared - macdExt.stream(parameters).signalMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdExt.stream(parameters).slow?: number; default: not declared - macdExt.stream(parameters).slowMovingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageType; default: not declared - macdFix: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — MACDFIX — fixed 12/26 EMA MACD with a configurable signal period (TA-Lib MACDFIX). - macdFix(input): ArrayLike; default: not declared - macdFix(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdFixParameters | undefined; default: not declared - macdFix(parameters).signal?: number; default: not declared - macdFix.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdFixParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - macdFix.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - macdFix.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - macdFix.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - macdFix.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - macdFix.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - macdFix.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - macdFix.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - macdFix.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - macdFix.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - macdFix.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - macdFix.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - macdFix.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - macdFix.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - macdFix.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - macdFix.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - macdFix.explain(input): ArrayLike; default: not declared - macdFix.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdFixParameters | undefined; default: not declared - macdFix.explain(parameters).signal?: number; default: not declared - macdFix.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - macdFix.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdFix.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - macdFix.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macdFix.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdFix.fromJSON().return.value.histogram: number; default: not declared - macdFix.fromJSON().return.value.macd: number; default: not declared - macdFix.fromJSON().return.value.signal: number; default: not declared - macdFix.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macdFix.fromJSON(snapshot).kind: string; default: not declared - macdFix.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - macdFix.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - macdFix.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MacdFixParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - macdFix.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdFix.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - macdFix.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - macdFix.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - macdFix.stream().return.value.histogram: number; default: not declared - macdFix.stream().return.value.macd: number; default: not declared - macdFix.stream().return.value.signal: number; default: not declared - macdFix.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MacdFixParameters | undefined; default: not declared - macdFix.stream(parameters).signal?: number; default: not declared - mama: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - mama(input): ArrayLike; default: not declared - mama(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MamaParameters | undefined; default: not declared - mama(parameters).fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - mama(parameters).slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. - mama.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - mama.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - mama.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - mama.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - mama.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - mama.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - mama.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - mama.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - mama.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - mama.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - mama.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - mama.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - mama.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - mama.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - mama.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - mama.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MamaPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - mama.explain(input): ArrayLike; default: not declared - mama.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MamaParameters | undefined; default: not declared - mama.explain(parameters).fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - mama.explain(parameters).slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. - mama.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mama.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MamaPoint | null; default: not declared - mama.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MamaPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mama.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mama.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MamaPoint | null; default: not declared - mama.fromJSON().return.value.fama: number; default: not declared - mama.fromJSON().return.value.mama: number; default: not declared - mama.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mama.fromJSON(snapshot).kind: string; default: not declared - mama.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - mama.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - mama.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mama.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MamaPoint | null; default: not declared - mama.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MamaPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mama.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mama.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MamaPoint | null; default: not declared - mama.stream().return.value.fama: number; default: not declared - mama.stream().return.value.mama: number; default: not declared - mama.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MamaParameters | undefined; default: not declared - mama.stream(parameters).fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - mama.stream(parameters).slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. - marketFacilitationIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Bill Williams Market Facilitation Index — (high − low) / volume. - marketFacilitationIndex(input): ArrayLike; default: not declared - marketFacilitationIndex(parameters)?: Record | undefined; default: not declared - marketFacilitationIndex.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - marketFacilitationIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - marketFacilitationIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - marketFacilitationIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - marketFacilitationIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - marketFacilitationIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - marketFacilitationIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - marketFacilitationIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - marketFacilitationIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - marketFacilitationIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - marketFacilitationIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - marketFacilitationIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - marketFacilitationIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - marketFacilitationIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - marketFacilitationIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - marketFacilitationIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - marketFacilitationIndex.explain(input): ArrayLike; default: not declared - marketFacilitationIndex.explain(parameters)?: Record | undefined; default: not declared - marketFacilitationIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - marketFacilitationIndex.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - marketFacilitationIndex.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - marketFacilitationIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - marketFacilitationIndex.fromJSON().return.value: number | null; default: not declared - marketFacilitationIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - marketFacilitationIndex.fromJSON(snapshot).kind: string; default: not declared - marketFacilitationIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - marketFacilitationIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - marketFacilitationIndex.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - marketFacilitationIndex.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - marketFacilitationIndex.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - marketFacilitationIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - marketFacilitationIndex.stream().return.value: number | null; default: not declared - marketFacilitationIndex.stream(parameters)?: Record | undefined; default: not declared - marketStructure: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').MarketStructure; default: not declared — Label the swing sequence (HH/HL/LH/LL) and flag breaks of structure. A higher-high while already bullish is a continuation (BOS); a higher-high that reverses a bearish run is a change of character (CHoCH), and symmetrically for lower-lows. The first swing high and the first swing low carry `label: null` — a label is a comparison with the previous swing of that kind, and there is none yet. - marketStructure().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - marketStructure().return.assumptions.conventionsVersion: string; default: not declared - marketStructure().return.assumptions.strength: number; default: not declared - marketStructure().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - marketStructure().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - marketStructure().return.events: import('@insiderfinance/totalfinance/technical-analysis').StructureEvent[]; default: not declared - marketStructure().return.swings: import('@insiderfinance/totalfinance/technical-analysis').LabeledSwing[]; default: not declared - marketStructure(bars): ArrayLike; default: not declared - marketStructure(options)?: { strength?: number; }; default: not declared - marketStructure(options).strength?: number; default: not declared - massIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - massIndex(input): ArrayLike; default: not declared - massIndex(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MassIndexParameters | undefined; default: not declared - massIndex(parameters).fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - massIndex(parameters).slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. - massIndex.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MassIndexParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - massIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - massIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - massIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - massIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - massIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - massIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - massIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - massIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - massIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - massIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - massIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - massIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - massIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - massIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - massIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - massIndex.explain(input): ArrayLike; default: not declared - massIndex.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MassIndexParameters | undefined; default: not declared - massIndex.explain(parameters).fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - massIndex.explain(parameters).slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. - massIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - massIndex.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - massIndex.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - massIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - massIndex.fromJSON().return.value: number | null; default: not declared - massIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - massIndex.fromJSON(snapshot).kind: string; default: not declared - massIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - massIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - massIndex.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MassIndexParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - massIndex.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - massIndex.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - massIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - massIndex.stream().return.value: number | null; default: not declared - massIndex.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MassIndexParameters | undefined; default: not declared - massIndex.stream(parameters).fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - massIndex.stream(parameters).slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. - mavp: (input: import('@insiderfinance/totalfinance/technical-analysis/statistics').MavpInput) => number[]; default: not declared - mavp(input): import('@insiderfinance/totalfinance/technical-analysis/statistics').MavpInput; default: not declared - mavp(input).parameters?: import('@insiderfinance/totalfinance/technical-analysis').MavpParameters; default: not declared - mavp(input).periods: ArrayLike; default: not declared - mavp(input).series: ArrayLike; default: not declared - mcginley: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - mcginley(input): ArrayLike; default: not declared - mcginley(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - mcginley(parameters).period: number; default: not declared - mcginley.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - mcginley.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - mcginley.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - mcginley.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - mcginley.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - mcginley.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - mcginley.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - mcginley.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - mcginley.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - mcginley.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - mcginley.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - mcginley.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - mcginley.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - mcginley.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - mcginley.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - mcginley.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - mcginley.explain(input): ArrayLike; default: not declared - mcginley.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - mcginley.explain(parameters).period: number; default: not declared - mcginley.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mcginley.fromJSON().return.next: (input: number) => number | null; default: not declared - mcginley.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mcginley.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mcginley.fromJSON().return.value: number | null; default: not declared - mcginley.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mcginley.fromJSON(snapshot).kind: string; default: not declared - mcginley.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - mcginley.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - mcginley.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mcginley.stream().return.next: (input: number) => number | null; default: not declared - mcginley.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mcginley.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mcginley.stream().return.value: number | null; default: not declared - mcginley.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - mcginley.stream(parameters).period: number; default: not declared - medianPrice: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - medianPrice(input): ArrayLike; default: not declared - medianPrice(parameters)?: {} | undefined; default: not declared - medianPrice.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - medianPrice.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - medianPrice.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - medianPrice.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - medianPrice.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - medianPrice.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - medianPrice.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - medianPrice.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - medianPrice.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - medianPrice.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - medianPrice.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - medianPrice.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - medianPrice.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - medianPrice.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - medianPrice.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - medianPrice.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - medianPrice.explain(input): ArrayLike; default: not declared - medianPrice.explain(parameters)?: {} | undefined; default: not declared - medianPrice.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - medianPrice.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - medianPrice.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - medianPrice.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - medianPrice.fromJSON().return.value: number | null; default: not declared - medianPrice.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - medianPrice.fromJSON(snapshot).kind: string; default: not declared - medianPrice.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - medianPrice.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - medianPrice.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - medianPrice.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - medianPrice.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - medianPrice.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - medianPrice.stream().return.value: number | null; default: not declared - medianPrice.stream(parameters)?: {} | undefined; default: not declared - mfi: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - mfi(input): ArrayLike; default: not declared - mfi(parameters)?: { period?: number; } | undefined; default: not declared - mfi(parameters).period?: number; default: not declared - mfi.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - mfi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - mfi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - mfi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - mfi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - mfi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - mfi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - mfi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - mfi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - mfi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - mfi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - mfi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - mfi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - mfi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - mfi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - mfi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - mfi.explain(input): ArrayLike; default: not declared - mfi.explain(parameters)?: { period?: number; } | undefined; default: not declared - mfi.explain(parameters).period?: number; default: not declared - mfi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mfi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - mfi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mfi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mfi.fromJSON().return.value: number | null; default: not declared - mfi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mfi.fromJSON(snapshot).kind: string; default: not declared - mfi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - mfi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - mfi.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mfi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - mfi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mfi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mfi.stream().return.value: number | null; default: not declared - mfi.stream(parameters)?: { period?: number; } | undefined; default: not declared - mfi.stream(parameters).period?: number; default: not declared - microprice: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Plain microprice; use `.explain()` for null/fallback diagnostics. - microprice(input): import('@insiderfinance/totalfinance/technical-analysis').OrderBook; default: not declared - microprice(input).asks: readonly import('@insiderfinance/totalfinance/technical-analysis').BookLevel[]; default: not declared - microprice(input).bids: readonly import('@insiderfinance/totalfinance/technical-analysis').BookLevel[]; default: not declared - microprice.explain: (input: import('@insiderfinance/totalfinance/technical-analysis').OrderBook) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - microprice.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; }>; default: not declared — Every applied convention, echoed back. - microprice.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - microprice.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - microprice.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - microprice.explain(input): import('@insiderfinance/totalfinance/technical-analysis').OrderBook; default: not declared - microprice.explain(input).asks: readonly import('@insiderfinance/totalfinance/technical-analysis').BookLevel[]; default: not declared - microprice.explain(input).bids: readonly import('@insiderfinance/totalfinance/technical-analysis').BookLevel[]; default: not declared - midpoint: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - midpoint(input): ArrayLike; default: not declared - midpoint(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - midpoint(parameters).period: number; default: not declared - midpoint.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - midpoint.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - midpoint.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - midpoint.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - midpoint.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - midpoint.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - midpoint.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - midpoint.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - midpoint.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - midpoint.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - midpoint.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - midpoint.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - midpoint.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - midpoint.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - midpoint.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - midpoint.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - midpoint.explain(input): ArrayLike; default: not declared - midpoint.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - midpoint.explain(parameters).period: number; default: not declared - midpoint.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - midpoint.fromJSON().return.next: (input: number) => number | null; default: not declared - midpoint.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - midpoint.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - midpoint.fromJSON().return.value: number | null; default: not declared - midpoint.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - midpoint.fromJSON(snapshot).kind: string; default: not declared - midpoint.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - midpoint.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - midpoint.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - midpoint.stream().return.next: (input: number) => number | null; default: not declared - midpoint.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - midpoint.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - midpoint.stream().return.value: number | null; default: not declared - midpoint.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - midpoint.stream(parameters).period: number; default: not declared - midprice: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - midprice(input): ArrayLike; default: not declared - midprice(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - midprice(parameters).period: number; default: not declared - midprice.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - midprice.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - midprice.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - midprice.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - midprice.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - midprice.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - midprice.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - midprice.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - midprice.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - midprice.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - midprice.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - midprice.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - midprice.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - midprice.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - midprice.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - midprice.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - midprice.explain(input): ArrayLike; default: not declared - midprice.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - midprice.explain(parameters).period: number; default: not declared - midprice.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - midprice.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - midprice.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - midprice.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - midprice.fromJSON().return.value: number | null; default: not declared - midprice.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - midprice.fromJSON(snapshot).kind: string; default: not declared - midprice.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - midprice.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - midprice.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - midprice.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - midprice.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - midprice.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - midprice.stream().return.value: number | null; default: not declared - midprice.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - midprice.stream(parameters).period: number; default: not declared - minusDI: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - minusDI(input): ArrayLike; default: not declared - minusDI(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - minusDI(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - minusDI.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - minusDI.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - minusDI.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - minusDI.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - minusDI.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - minusDI.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - minusDI.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - minusDI.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - minusDI.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - minusDI.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - minusDI.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - minusDI.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - minusDI.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - minusDI.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - minusDI.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - minusDI.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - minusDI.explain(input): ArrayLike; default: not declared - minusDI.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - minusDI.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - minusDI.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - minusDI.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - minusDI.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - minusDI.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - minusDI.fromJSON().return.value: number | null; default: not declared - minusDI.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - minusDI.fromJSON(snapshot).kind: string; default: not declared - minusDI.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - minusDI.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - minusDI.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - minusDI.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - minusDI.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - minusDI.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - minusDI.stream().return.value: number | null; default: not declared - minusDI.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - minusDI.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - minusDM: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - minusDM(input): ArrayLike; default: not declared - minusDM(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - minusDM(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - minusDM.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - minusDM.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - minusDM.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - minusDM.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - minusDM.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - minusDM.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - minusDM.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - minusDM.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - minusDM.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - minusDM.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - minusDM.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - minusDM.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - minusDM.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - minusDM.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - minusDM.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - minusDM.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - minusDM.explain(input): ArrayLike; default: not declared - minusDM.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - minusDM.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - minusDM.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - minusDM.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - minusDM.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - minusDM.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - minusDM.fromJSON().return.value: number | null; default: not declared - minusDM.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - minusDM.fromJSON(snapshot).kind: string; default: not declared - minusDM.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - minusDM.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - minusDM.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - minusDM.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - minusDM.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - minusDM.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - minusDM.stream().return.value: number | null; default: not declared - minusDM.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - minusDM.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - momentum: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - momentum(input): ArrayLike; default: not declared - momentum(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - momentum(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - momentum.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - momentum.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - momentum.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - momentum.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - momentum.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - momentum.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - momentum.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - momentum.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - momentum.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - momentum.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - momentum.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - momentum.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - momentum.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - momentum.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - momentum.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - momentum.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - momentum.explain(input): ArrayLike; default: not declared - momentum.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - momentum.explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - momentum.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - momentum.fromJSON().return.next: (input: number) => number | null; default: not declared - momentum.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - momentum.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - momentum.fromJSON().return.value: number | null; default: not declared - momentum.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - momentum.fromJSON(snapshot).kind: string; default: not declared - momentum.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - momentum.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - momentum.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - momentum.stream().return.next: (input: number) => number | null; default: not declared - momentum.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - momentum.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - momentum.stream().return.value: number | null; default: not declared - momentum.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - momentum.stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - movingAverage: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - movingAverage(input): ArrayLike; default: not declared - movingAverage(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageParameters | undefined; default: not declared - movingAverage(parameters).movingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageName; default: not declared - movingAverage(parameters).period: number; default: not declared - movingAverage.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - movingAverage.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - movingAverage.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - movingAverage.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - movingAverage.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - movingAverage.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - movingAverage.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - movingAverage.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - movingAverage.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - movingAverage.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - movingAverage.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - movingAverage.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - movingAverage.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - movingAverage.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - movingAverage.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - movingAverage.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - movingAverage.explain(input): ArrayLike; default: not declared - movingAverage.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageParameters | undefined; default: not declared - movingAverage.explain(parameters).movingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageName; default: not declared - movingAverage.explain(parameters).period: number; default: not declared - movingAverage.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - movingAverage.fromJSON().return.next: (input: number) => number | null; default: not declared - movingAverage.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - movingAverage.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - movingAverage.fromJSON().return.value: number | null; default: not declared - movingAverage.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - movingAverage.fromJSON(snapshot).kind: string; default: not declared - movingAverage.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - movingAverage.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - movingAverage.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - movingAverage.stream().return.next: (input: number) => number | null; default: not declared - movingAverage.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - movingAverage.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - movingAverage.stream().return.value: number | null; default: not declared - movingAverage.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageParameters | undefined; default: not declared - movingAverage.stream(parameters).movingAverageType?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageName; default: not declared - movingAverage.stream(parameters).period: number; default: not declared - movingAverageRibbon: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - movingAverageRibbon(input): ArrayLike; default: not declared - movingAverageRibbon(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageRibbonParameters | undefined; default: not declared - movingAverageRibbon(parameters).periods?: number[]; default: not declared - movingAverageRibbon.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageRibbonParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - movingAverageRibbon.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - movingAverageRibbon.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - movingAverageRibbon.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - movingAverageRibbon.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - movingAverageRibbon.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - movingAverageRibbon.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - movingAverageRibbon.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - movingAverageRibbon.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - movingAverageRibbon.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - movingAverageRibbon.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - movingAverageRibbon.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - movingAverageRibbon.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - movingAverageRibbon.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - movingAverageRibbon.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - movingAverageRibbon.explain().return.value: number[][]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - movingAverageRibbon.explain(input): ArrayLike; default: not declared - movingAverageRibbon.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageRibbonParameters | undefined; default: not declared - movingAverageRibbon.explain(parameters).periods?: number[]; default: not declared - movingAverageRibbon.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - movingAverageRibbon.fromJSON().return.next: (input: number) => number[] | null; default: not declared - movingAverageRibbon.fromJSON().return.peek: (input: number) => number[] | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - movingAverageRibbon.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - movingAverageRibbon.fromJSON().return.value: number[] | null; default: not declared - movingAverageRibbon.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - movingAverageRibbon.fromJSON(snapshot).kind: string; default: not declared - movingAverageRibbon.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - movingAverageRibbon.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - movingAverageRibbon.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageRibbonParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - movingAverageRibbon.stream().return.next: (input: number) => number[] | null; default: not declared - movingAverageRibbon.stream().return.peek: (input: number) => number[] | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - movingAverageRibbon.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - movingAverageRibbon.stream().return.value: number[] | null; default: not declared - movingAverageRibbon.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MovingAverageRibbonParameters | undefined; default: not declared - movingAverageRibbon.stream(parameters).periods?: number[]; default: not declared - msw: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Mesa Sine Wave (pandas-ta/tulipy `msw`). - msw(input): ArrayLike; default: not declared - msw(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MswParameters | undefined; default: not declared - msw(parameters).period?: number; default: not declared - msw.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').MswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - msw.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - msw.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - msw.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - msw.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - msw.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - msw.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - msw.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - msw.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - msw.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - msw.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - msw.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - msw.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - msw.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - msw.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - msw.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MswPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - msw.explain(input): ArrayLike; default: not declared - msw.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MswParameters | undefined; default: not declared - msw.explain(parameters).period?: number; default: not declared - msw.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - msw.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MswPoint | null; default: not declared - msw.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MswPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - msw.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - msw.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MswPoint | null; default: not declared - msw.fromJSON().return.value.lead: number; default: not declared - msw.fromJSON().return.value.sine: number; default: not declared - msw.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - msw.fromJSON(snapshot).kind: string; default: not declared - msw.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - msw.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - msw.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').MswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - msw.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MswPoint | null; default: not declared - msw.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MswPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - msw.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - msw.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MswPoint | null; default: not declared - msw.stream().return.value.lead: number; default: not declared - msw.stream().return.value.sine: number; default: not declared - msw.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').MswParameters | undefined; default: not declared - msw.stream(parameters).period?: number; default: not declared - mult: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared - mult(input): ArrayLike; default: not declared - mult(parameters)?: {} | undefined; default: not declared - mult.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - mult.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - mult.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - mult.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - mult.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - mult.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - mult.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - mult.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - mult.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - mult.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - mult.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - mult.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - mult.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - mult.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - mult.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - mult.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - mult.explain(input): ArrayLike; default: not declared - mult.explain(parameters)?: {} | undefined; default: not declared - mult.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mult.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - mult.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mult.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mult.fromJSON().return.value: number | null; default: not declared - mult.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mult.fromJSON(snapshot).kind: string; default: not declared - mult.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - mult.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - mult.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - mult.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - mult.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - mult.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - mult.stream().return.value: number | null; default: not declared - mult.stream(parameters)?: {} | undefined; default: not declared - natr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - natr(input): ArrayLike; default: not declared - natr(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined; default: not declared - natr(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - natr.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - natr.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - natr.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - natr.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - natr.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - natr.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - natr.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - natr.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - natr.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - natr.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - natr.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - natr.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - natr.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - natr.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - natr.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - natr.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - natr.explain(input): ArrayLike; default: not declared - natr.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined; default: not declared - natr.explain(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - natr.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - natr.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - natr.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - natr.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - natr.fromJSON().return.value: number | null; default: not declared - natr.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - natr.fromJSON(snapshot).kind: string; default: not declared - natr.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - natr.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - natr.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - natr.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - natr.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - natr.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - natr.stream().return.value: number | null; default: not declared - natr.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volatility').PeriodParameters | undefined; default: not declared - natr.stream(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - normalize: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling min-max normalization to [0, 1] (0.5 on a flat window). - normalize(input): ArrayLike; default: not declared - normalize(parameters)?: { period?: number; } | undefined; default: not declared - normalize(parameters).period?: number; default: not declared - normalize.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - normalize.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - normalize.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - normalize.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - normalize.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - normalize.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - normalize.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - normalize.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - normalize.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - normalize.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - normalize.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - normalize.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - normalize.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - normalize.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - normalize.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - normalize.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - normalize.explain(input): ArrayLike; default: not declared - normalize.explain(parameters)?: { period?: number; } | undefined; default: not declared - normalize.explain(parameters).period?: number; default: not declared - normalize.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - normalize.fromJSON().return.next: (input: number) => number | null; default: not declared - normalize.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - normalize.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - normalize.fromJSON().return.value: number | null; default: not declared - normalize.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - normalize.fromJSON(snapshot).kind: string; default: not declared - normalize.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - normalize.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - normalize.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - normalize.stream().return.next: (input: number) => number | null; default: not declared - normalize.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - normalize.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - normalize.stream().return.value: number | null; default: not declared - normalize.stream(parameters)?: { period?: number; } | undefined; default: not declared - normalize.stream(parameters).period?: number; default: not declared - not: (condition: import('@insiderfinance/totalfinance/technical-analysis').Condition) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared — Logical negation of a condition (carries through the inner condition's refs). - not().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - not(condition): import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - not(condition).refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - nvi: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - nvi(input): ArrayLike; default: not declared - nvi(parameters)?: Record | undefined; default: not declared - nvi.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - nvi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - nvi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - nvi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - nvi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - nvi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - nvi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - nvi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - nvi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - nvi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - nvi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - nvi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - nvi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - nvi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - nvi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - nvi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - nvi.explain(input): ArrayLike; default: not declared - nvi.explain(parameters)?: Record | undefined; default: not declared - nvi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - nvi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - nvi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - nvi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - nvi.fromJSON().return.value: number | null; default: not declared - nvi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - nvi.fromJSON(snapshot).kind: string; default: not declared - nvi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - nvi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - nvi.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - nvi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - nvi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - nvi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - nvi.stream().return.value: number | null; default: not declared - nvi.stream(parameters)?: Record | undefined; default: not declared - obv: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ talib?: boolean; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - obv(input): ArrayLike; default: not declared - obv(parameters)?: { talib?: boolean; } | undefined; default: not declared - obv(parameters).talib?: boolean; default: not declared - obv.explain: (input: ArrayLike, parameters?: { talib?: boolean; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - obv.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - obv.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - obv.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - obv.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - obv.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - obv.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - obv.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - obv.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - obv.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - obv.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - obv.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - obv.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - obv.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - obv.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - obv.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - obv.explain(input): ArrayLike; default: not declared - obv.explain(parameters)?: { talib?: boolean; } | undefined; default: not declared - obv.explain(parameters).talib?: boolean; default: not declared - obv.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - obv.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - obv.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - obv.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - obv.fromJSON().return.value: number | null; default: not declared - obv.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - obv.fromJSON(snapshot).kind: string; default: not declared - obv.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - obv.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - obv.stream: (parameters?: { talib?: boolean; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - obv.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - obv.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - obv.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - obv.stream().return.value: number | null; default: not declared - obv.stream(parameters)?: { talib?: boolean; } | undefined; default: not declared - obv.stream(parameters).talib?: boolean; default: not declared - ohlc4: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — (open + high + low + close) / 4 — alias of `averagePrice`. - ohlc4(input): ArrayLike; default: not declared - ohlc4(parameters)?: {} | undefined; default: not declared - ohlc4.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ohlc4.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ohlc4.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ohlc4.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ohlc4.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ohlc4.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ohlc4.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ohlc4.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ohlc4.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ohlc4.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ohlc4.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ohlc4.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ohlc4.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ohlc4.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ohlc4.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ohlc4.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ohlc4.explain(input): ArrayLike; default: not declared - ohlc4.explain(parameters)?: {} | undefined; default: not declared - ohlc4.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ohlc4.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - ohlc4.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ohlc4.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ohlc4.fromJSON().return.value: number | null; default: not declared - ohlc4.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ohlc4.fromJSON(snapshot).kind: string; default: not declared - ohlc4.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ohlc4.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ohlc4.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ohlc4.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - ohlc4.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ohlc4.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ohlc4.stream().return.value: number | null; default: not declared - ohlc4.stream(parameters)?: {} | undefined; default: not declared - ohlcvFromBars: (bars: readonly import('@insiderfinance/totalfinance/core').Bar[]) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Explicitly project core Bar records to OHLCV indicator rows. Source identity, timestamps, adjustment flags and caller provenance remain in the original records: retain them alongside the calculation. This adapter neither fetches nor relabels observations. Prices may be negative where the instrument permits; finite values and OHLC range relationships are validated. A source series must contain one symbol in strictly increasing timestamp order; no sorting or deduplication is performed before identity/time are projected away. - ohlcvFromBars(bars): readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - openingRange: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => import('@insiderfinance/totalfinance/technical-analysis').OpeningRange; default: not declared — High/low of the first `periods` bars — the opening range. - openingRange().return.assumptions: { conventionsVersion: string; periods: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - openingRange().return.assumptions.conventionsVersion: string; default: not declared - openingRange().return.assumptions.periods: number; default: not declared - openingRange().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - openingRange().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - openingRange().return.high: number; default: not declared - openingRange().return.low: number; default: not declared - openingRange().return.mid: number; default: not declared - openingRange(bars): ArrayLike; default: not declared - openingRange(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - openingRange(options).periods: number; default: not declared - openingRangeBreakout: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; default: not declared — Opening-range breakout signal aligned to the input: `0` within the opening range, then `+1` on the first close above the range high, `−1` below the range low (NaN for the opening-range bars). - openingRangeBreakout(bars): ArrayLike; default: not declared - openingRangeBreakout(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - openingRangeBreakout(options).periods: number; default: not declared - orbRetest: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; default: not declared — Opening-range retest aligned to the input: after a close breaks the range, `+1` on the first bar that pulls back to touch the range high (a retest of an up-breakout), `−1` for a retest of the range low. A new breakout in a direction re-arms that side; NaN during the opening range. - orbRetest(bars): ArrayLike; default: not declared - orbRetest(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - orbRetest(options).periods: number; default: not declared - orderBlocks: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - orderBlocks(input): ArrayLike; default: not declared - orderBlocks(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').OrderBlockParameters | undefined; default: not declared - orderBlocks(parameters).lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. - orderBlocks.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').OrderBlockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - orderBlocks.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - orderBlocks.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - orderBlocks.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - orderBlocks.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - orderBlocks.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - orderBlocks.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - orderBlocks.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - orderBlocks.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - orderBlocks.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - orderBlocks.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - orderBlocks.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - orderBlocks.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - orderBlocks.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - orderBlocks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - orderBlocks.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ZonePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - orderBlocks.explain(input): ArrayLike; default: not declared - orderBlocks.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').OrderBlockParameters | undefined; default: not declared - orderBlocks.explain(parameters).lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. - orderBlocks.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - orderBlocks.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - orderBlocks.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - orderBlocks.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - orderBlocks.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - orderBlocks.fromJSON().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - orderBlocks.fromJSON().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - orderBlocks.fromJSON().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - orderBlocks.fromJSON().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - orderBlocks.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - orderBlocks.fromJSON(snapshot).kind: string; default: not declared - orderBlocks.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - orderBlocks.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - orderBlocks.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').OrderBlockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - orderBlocks.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - orderBlocks.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - orderBlocks.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - orderBlocks.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ZonePoint | null; default: not declared - orderBlocks.stream().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - orderBlocks.stream().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - orderBlocks.stream().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - orderBlocks.stream().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - orderBlocks.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').OrderBlockParameters | undefined; default: not declared - orderBlocks.stream(parameters).lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. - orderBookImbalance: import('@insiderfinance/totalfinance/core').Facade; default: not declared — Plain single-level imbalance; use `.explain()` for zero-depth diagnostics. - orderBookImbalance(input): import('@insiderfinance/totalfinance/technical-analysis').OrderBookLevel; default: not declared - orderBookImbalance(input).askSize: number; default: not declared - orderBookImbalance(input).bidSize: number; default: not declared - orderBookImbalance.explain: (input: import('@insiderfinance/totalfinance/technical-analysis').OrderBookLevel) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - orderBookImbalance.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; }>; default: not declared — Every applied convention, echoed back. - orderBookImbalance.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - orderBookImbalance.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - orderBookImbalance.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - orderBookImbalance.explain(input): import('@insiderfinance/totalfinance/technical-analysis').OrderBookLevel; default: not declared - orderBookImbalance.explain(input).askSize: number; default: not declared - orderBookImbalance.explain(input).bidSize: number; default: not declared - pMax: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - pMax(input): ArrayLike; default: not declared - pMax(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PmaxParameters | undefined; default: not declared - pMax(parameters).multiplier?: number; default: not declared - pMax(parameters).period?: number; default: not declared - pMax.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PmaxParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - pMax.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - pMax.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - pMax.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pMax.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pMax.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pMax.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pMax.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pMax.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pMax.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pMax.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pMax.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pMax.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pMax.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pMax.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - pMax.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - pMax.explain(input): ArrayLike; default: not declared - pMax.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PmaxParameters | undefined; default: not declared - pMax.explain(parameters).multiplier?: number; default: not declared - pMax.explain(parameters).period?: number; default: not declared - pMax.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pMax.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint | null; default: not declared - pMax.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pMax.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pMax.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint | null; default: not declared - pMax.fromJSON().return.value.pmax: number; default: not declared — The trailing stop line. - pMax.fromJSON().return.value.trend: number; default: not declared — +1 long (MA above the stop), −1 short. - pMax.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pMax.fromJSON(snapshot).kind: string; default: not declared - pMax.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - pMax.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - pMax.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PmaxParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pMax.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint | null; default: not declared - pMax.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pMax.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pMax.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').PmaxPoint | null; default: not declared - pMax.stream().return.value.pmax: number; default: not declared — The trailing stop line. - pMax.stream().return.value.trend: number; default: not declared — +1 long (MA above the stop), −1 short. - pMax.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PmaxParameters | undefined; default: not declared - pMax.stream(parameters).multiplier?: number; default: not declared - pMax.stream(parameters).period?: number; default: not declared - pairs: (x: ArrayLike, y: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').Pair[]; default: not declared — Zip two equal-length series into the `Pair[]` that `beta` / `correl` consume. Throws on a length mismatch — silent truncation would mask a benchmark/asset alignment bug. - pairs(x): ArrayLike; default: not declared - pairs(y): ArrayLike; default: not declared - parkinson: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - parkinson(input): ArrayLike; default: not declared - parkinson(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - parkinson(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - parkinson(parameters).period: number; default: not declared - parkinson.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - parkinson.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - parkinson.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - parkinson.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - parkinson.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - parkinson.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - parkinson.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - parkinson.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - parkinson.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - parkinson.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - parkinson.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - parkinson.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - parkinson.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - parkinson.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - parkinson.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - parkinson.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - parkinson.explain(input): ArrayLike; default: not declared - parkinson.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - parkinson.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - parkinson.explain(parameters).period: number; default: not declared - parkinson.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - parkinson.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - parkinson.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - parkinson.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - parkinson.fromJSON().return.value: number | null; default: not declared - parkinson.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - parkinson.fromJSON(snapshot).kind: string; default: not declared - parkinson.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - parkinson.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - parkinson.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - parkinson.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - parkinson.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - parkinson.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - parkinson.stream().return.value: number | null; default: not declared - parkinson.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - parkinson.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - parkinson.stream(parameters).period: number; default: not declared - pascalWma: import('@insiderfinance/totalfinance/technical-analysis').Indicator<({ period: number; }), number, number>; default: not declared - pascalWma(input): ArrayLike; default: not declared - pascalWma(parameters)?: ({ period: number; }) | undefined; default: not declared - pascalWma(parameters).period: number; default: not declared - pascalWma.explain: (input: ArrayLike, parameters?: ({ period: number; }) | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - pascalWma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - pascalWma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - pascalWma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pascalWma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pascalWma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pascalWma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pascalWma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pascalWma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pascalWma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pascalWma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pascalWma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pascalWma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pascalWma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pascalWma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - pascalWma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - pascalWma.explain(input): ArrayLike; default: not declared - pascalWma.explain(parameters)?: ({ period: number; }) | undefined; default: not declared - pascalWma.explain(parameters).period: number; default: not declared - pascalWma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pascalWma.fromJSON().return.next: (input: number) => number | null; default: not declared - pascalWma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pascalWma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pascalWma.fromJSON().return.value: number | null; default: not declared - pascalWma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pascalWma.fromJSON(snapshot).kind: string; default: not declared - pascalWma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - pascalWma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - pascalWma.stream: (parameters?: ({ period: number; }) | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pascalWma.stream().return.next: (input: number) => number | null; default: not declared - pascalWma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pascalWma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pascalWma.stream().return.value: number | null; default: not declared - pascalWma.stream(parameters)?: ({ period: number; }) | undefined; default: not declared - pascalWma.stream(parameters).period: number; default: not declared - percentAtr: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — ATR as a percent of close (a.k.a. ATRP). - percentAtr(input): ArrayLike; default: not declared - percentAtr(parameters)?: { period?: number; } | undefined; default: not declared - percentAtr(parameters).period?: number; default: not declared - percentAtr.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - percentAtr.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - percentAtr.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - percentAtr.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - percentAtr.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - percentAtr.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - percentAtr.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - percentAtr.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - percentAtr.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - percentAtr.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - percentAtr.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - percentAtr.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - percentAtr.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - percentAtr.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - percentAtr.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - percentAtr.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - percentAtr.explain(input): ArrayLike; default: not declared - percentAtr.explain(parameters)?: { period?: number; } | undefined; default: not declared - percentAtr.explain(parameters).period?: number; default: not declared - percentAtr.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - percentAtr.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - percentAtr.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - percentAtr.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - percentAtr.fromJSON().return.value: number | null; default: not declared - percentAtr.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - percentAtr.fromJSON(snapshot).kind: string; default: not declared - percentAtr.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - percentAtr.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - percentAtr.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - percentAtr.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - percentAtr.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - percentAtr.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - percentAtr.stream().return.value: number | null; default: not declared - percentAtr.stream(parameters)?: { period?: number; } | undefined; default: not declared - percentAtr.stream(parameters).period?: number; default: not declared - percentRank: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling percentile position of the current value within the window, in [0, 100]. - percentRank(input): ArrayLike; default: not declared - percentRank(parameters)?: { period?: number; } | undefined; default: not declared - percentRank(parameters).period?: number; default: not declared - percentRank.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - percentRank.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - percentRank.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - percentRank.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - percentRank.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - percentRank.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - percentRank.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - percentRank.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - percentRank.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - percentRank.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - percentRank.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - percentRank.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - percentRank.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - percentRank.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - percentRank.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - percentRank.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - percentRank.explain(input): ArrayLike; default: not declared - percentRank.explain(parameters)?: { period?: number; } | undefined; default: not declared - percentRank.explain(parameters).period?: number; default: not declared - percentRank.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - percentRank.fromJSON().return.next: (input: number) => number | null; default: not declared - percentRank.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - percentRank.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - percentRank.fromJSON().return.value: number | null; default: not declared - percentRank.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - percentRank.fromJSON(snapshot).kind: string; default: not declared - percentRank.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - percentRank.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - percentRank.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - percentRank.stream().return.next: (input: number) => number | null; default: not declared - percentRank.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - percentRank.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - percentRank.stream().return.value: number | null; default: not declared - percentRank.stream(parameters)?: { period?: number; } | undefined; default: not declared - percentRank.stream(parameters).period?: number; default: not declared - pgo: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - pgo(input): ArrayLike; default: not declared - pgo(parameters)?: { period?: number; } | undefined; default: not declared - pgo(parameters).period?: number; default: not declared - pgo.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - pgo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - pgo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - pgo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pgo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pgo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pgo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pgo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pgo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pgo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pgo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pgo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pgo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pgo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pgo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - pgo.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - pgo.explain(input): ArrayLike; default: not declared - pgo.explain(parameters)?: { period?: number; } | undefined; default: not declared - pgo.explain(parameters).period?: number; default: not declared - pgo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pgo.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - pgo.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pgo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pgo.fromJSON().return.value: number | null; default: not declared - pgo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pgo.fromJSON(snapshot).kind: string; default: not declared - pgo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - pgo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - pgo.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pgo.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - pgo.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pgo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pgo.stream().return.value: number | null; default: not declared - pgo.stream(parameters)?: { period?: number; } | undefined; default: not declared - pgo.stream(parameters).period?: number; default: not declared - pivots: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, method?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod) => import('@insiderfinance/totalfinance/technical-analysis').PivotLevels; default: not declared — Pivot levels for the next period from a prior period's OHLC. - pivots().return.assumptions: { conventionsVersion: string; method: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - pivots().return.assumptions.conventionsVersion: string; default: not declared - pivots().return.assumptions.method: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; default: not declared - pivots().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - pivots().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - pivots().return.pivot: number; default: not declared - pivots().return.resistance: number[]; default: not declared - pivots().return.support: number[]; default: not declared - pivots(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - pivots(bar).close: number; default: not declared - pivots(bar).high: number; default: not declared - pivots(bar).low: number; default: not declared - pivots(bar).open?: number; default: not declared - pivots(bar).volume?: number; default: not declared - pivots(method)?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; default: not declared - plusDI: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - plusDI(input): ArrayLike; default: not declared - plusDI(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - plusDI(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - plusDI.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - plusDI.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - plusDI.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - plusDI.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - plusDI.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - plusDI.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - plusDI.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - plusDI.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - plusDI.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - plusDI.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - plusDI.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - plusDI.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - plusDI.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - plusDI.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - plusDI.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - plusDI.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - plusDI.explain(input): ArrayLike; default: not declared - plusDI.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - plusDI.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - plusDI.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - plusDI.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - plusDI.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - plusDI.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - plusDI.fromJSON().return.value: number | null; default: not declared - plusDI.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - plusDI.fromJSON(snapshot).kind: string; default: not declared - plusDI.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - plusDI.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - plusDI.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - plusDI.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - plusDI.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - plusDI.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - plusDI.stream().return.value: number | null; default: not declared - plusDI.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - plusDI.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - plusDM: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - plusDM(input): ArrayLike; default: not declared - plusDM(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - plusDM(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - plusDM.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - plusDM.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - plusDM.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - plusDM.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - plusDM.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - plusDM.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - plusDM.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - plusDM.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - plusDM.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - plusDM.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - plusDM.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - plusDM.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - plusDM.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - plusDM.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - plusDM.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - plusDM.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - plusDM.explain(input): ArrayLike; default: not declared - plusDM.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - plusDM.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - plusDM.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - plusDM.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - plusDM.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - plusDM.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - plusDM.fromJSON().return.value: number | null; default: not declared - plusDM.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - plusDM.fromJSON(snapshot).kind: string; default: not declared - plusDM.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - plusDM.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - plusDM.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - plusDM.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - plusDM.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - plusDM.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - plusDM.stream().return.value: number | null; default: not declared - plusDM.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters | undefined; default: not declared - plusDM.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - pointAndFigure: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').PnfParameters) => import('@insiderfinance/totalfinance/technical-analysis').PnfColumn[]; default: not declared - pointAndFigure(bars): ArrayLike; default: not declared - pointAndFigure(parameters): import('@insiderfinance/totalfinance/technical-analysis').PnfParameters; default: not declared - pointAndFigure(parameters).boxSize: number; default: not declared - pointAndFigure(parameters).reversal?: number; default: not declared - ppo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - ppo(input): ArrayLike; default: not declared - ppo(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PpoParameters | undefined; default: not declared - ppo(parameters).fast?: number; default: not declared - ppo(parameters).signal?: number; default: not declared - ppo(parameters).slow?: number; default: not declared - ppo.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PpoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ppo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ppo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ppo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ppo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ppo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ppo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ppo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ppo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ppo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ppo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ppo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ppo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ppo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ppo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ppo.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').PpoPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ppo.explain(input): ArrayLike; default: not declared - ppo.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PpoParameters | undefined; default: not declared - ppo.explain(parameters).fast?: number; default: not declared - ppo.explain(parameters).signal?: number; default: not declared - ppo.explain(parameters).slow?: number; default: not declared - ppo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ppo.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PpoPoint | null; default: not declared - ppo.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PpoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ppo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ppo.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').PpoPoint | null; default: not declared - ppo.fromJSON().return.value.histogram: number; default: not declared - ppo.fromJSON().return.value.ppo: number; default: not declared - ppo.fromJSON().return.value.signal: number; default: not declared - ppo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ppo.fromJSON(snapshot).kind: string; default: not declared - ppo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ppo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ppo.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PpoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ppo.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PpoPoint | null; default: not declared - ppo.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').PpoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ppo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ppo.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').PpoPoint | null; default: not declared - ppo.stream().return.value.histogram: number; default: not declared - ppo.stream().return.value.ppo: number; default: not declared - ppo.stream().return.value.signal: number; default: not declared - ppo.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PpoParameters | undefined; default: not declared - ppo.stream(parameters).fast?: number; default: not declared - ppo.stream(parameters).signal?: number; default: not declared - ppo.stream(parameters).slow?: number; default: not declared - previousSessionLevels: (bars: ArrayLike, sessionIds: ArrayLike) => (import('@insiderfinance/totalfinance/technical-analysis').PriorSessionLevel | null)[]; default: not declared — For each bar, the high/low/close of the PRIOR session (the fully-completed session before the bar's own). `sessionIds[i]` groups bars (bars carry no timestamp, so the caller supplies the grouping — pass day ids for "previous day high/low", week ids for "previous week high/low"). Bars in the first session get NaN levels. - previousSessionLevels(bars): ArrayLike; default: not declared - previousSessionLevels(sessionIds): ArrayLike; default: not declared - priceAction: { readonly pivots: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, method?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod) => import('@insiderfinance/totalfinance/technical-analysis').PivotLevels; readonly swings: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').Swings; readonly fractals: (bars: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis/price-action').Fractals; readonly supportResistance: (bars: ArrayLike, options?: { strength?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').SupportResistance; readonly trendlines: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; readonly channel: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; readonly lineAt: (line: import('@insiderfinance/totalfinance/technical-analysis').Line, index: number) => number; readonly breakouts: (bars: ArrayLike, options?: { lookback?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').BreakoutsReport; readonly gaps: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapsReport; readonly marketStructure: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').MarketStructure; readonly sessionRanges: (bars: ArrayLike, sessionIds: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').SessionRange[]; readonly openingRange: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => import('@insiderfinance/totalfinance/technical-analysis').OpeningRange; readonly openingRangeBreakout: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; readonly orbRetest: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; readonly fibRetracement: (start: number, end: number, levels?: readonly number[]) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; readonly fibExtension: (input: import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; readonly previousSessionLevels: (bars: ArrayLike, sessionIds: ArrayLike) => (import('@insiderfinance/totalfinance/technical-analysis').PriorSessionLevel | null)[]; readonly gapFill: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapFillReport; }; default: not declared — Price-action group: swings, structure, ranges, and level detection. - priceAction.breakouts: (bars: ArrayLike, options?: { lookback?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').BreakoutsReport; default: not declared - priceAction.breakouts().return.assumptions: { conventionsVersion: string; lookback: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.breakouts().return.assumptions.conventionsVersion: string; default: not declared - priceAction.breakouts().return.assumptions.lookback: number; default: not declared - priceAction.breakouts().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.breakouts().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.breakouts().return.signal: (number | null)[]; default: not declared — Aligned to the input: `+1` when the close exceeds the highest high of the prior `lookback` bars, `−1` below the lowest low, `0` otherwise — `null` during the lookback warmup. - priceAction.breakouts(bars): ArrayLike; default: not declared - priceAction.breakouts(options)?: { lookback?: number; }; default: not declared - priceAction.breakouts(options).lookback?: number; default: not declared - priceAction.channel: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; default: not declared - priceAction.channel().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.channel().return.assumptions.conventionsVersion: string; default: not declared - priceAction.channel().return.assumptions.strength: number; default: not declared - priceAction.channel().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.channel().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.channel().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - priceAction.channel().return.resistance.from: number; default: not declared - priceAction.channel().return.resistance.intercept: number; default: not declared - priceAction.channel().return.resistance.slope: number; default: not declared - priceAction.channel().return.resistance.to: number; default: not declared - priceAction.channel().return.support: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - priceAction.channel().return.support.from: number; default: not declared - priceAction.channel().return.support.intercept: number; default: not declared - priceAction.channel().return.support.slope: number; default: not declared - priceAction.channel().return.support.to: number; default: not declared - priceAction.channel(bars): ArrayLike; default: not declared - priceAction.channel(options)?: { strength?: number; }; default: not declared - priceAction.channel(options).strength?: number; default: not declared - priceAction.fibExtension: (input: import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; default: not declared - priceAction.fibExtension(input): import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput; default: not declared - priceAction.fibExtension(input).end: number; default: not declared - priceAction.fibExtension(input).levels?: readonly number[]; default: not declared - priceAction.fibExtension(input).projectFrom: number; default: not declared - priceAction.fibExtension(input).start: number; default: not declared - priceAction.fibRetracement: (start: number, end: number, levels?: readonly number[]) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; default: not declared - priceAction.fibRetracement(end): number; default: not declared - priceAction.fibRetracement(levels)?: readonly number[]; default: not declared - priceAction.fibRetracement(start): number; default: not declared - priceAction.fractals: (bars: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis/price-action').Fractals; default: not declared - priceAction.fractals().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.fractals().return.assumptions.conventionsVersion: string; default: not declared - priceAction.fractals().return.assumptions.strength: number; default: not declared - priceAction.fractals().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.fractals().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.fractals().return.down: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - priceAction.fractals().return.up: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - priceAction.fractals(bars): ArrayLike; default: not declared - priceAction.gapFill: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapFillReport; default: not declared - priceAction.gapFill().return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.gapFill().return.assumptions.conventionsVersion: string; default: not declared - priceAction.gapFill().return.assumptions.minSizeFraction: number; default: not declared - priceAction.gapFill().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.gapFill().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.gapFill().return.events: import('@insiderfinance/totalfinance/technical-analysis').GapFillEvent[]; default: not declared - priceAction.gapFill(bars): ArrayLike; default: not declared - priceAction.gapFill(options)?: { minSizeFraction?: number; }; default: not declared - priceAction.gapFill(options).minSizeFraction?: number; default: not declared - priceAction.gaps: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapsReport; default: not declared - priceAction.gaps().return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.gaps().return.assumptions.conventionsVersion: string; default: not declared - priceAction.gaps().return.assumptions.minSizeFraction: number; default: not declared - priceAction.gaps().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.gaps().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.gaps().return.gaps: import('@insiderfinance/totalfinance/technical-analysis').Gap[]; default: not declared - priceAction.gaps(bars): ArrayLike; default: not declared - priceAction.gaps(options)?: { minSizeFraction?: number; }; default: not declared - priceAction.gaps(options).minSizeFraction?: number; default: not declared - priceAction.lineAt: (line: import('@insiderfinance/totalfinance/technical-analysis').Line, index: number) => number; default: not declared - priceAction.lineAt(index): number; default: not declared - priceAction.lineAt(line): import('@insiderfinance/totalfinance/technical-analysis').Line; default: not declared - priceAction.lineAt(line).from: number; default: not declared - priceAction.lineAt(line).intercept: number; default: not declared - priceAction.lineAt(line).slope: number; default: not declared - priceAction.lineAt(line).to: number; default: not declared - priceAction.marketStructure: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').MarketStructure; default: not declared - priceAction.marketStructure().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.marketStructure().return.assumptions.conventionsVersion: string; default: not declared - priceAction.marketStructure().return.assumptions.strength: number; default: not declared - priceAction.marketStructure().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.marketStructure().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.marketStructure().return.events: import('@insiderfinance/totalfinance/technical-analysis').StructureEvent[]; default: not declared - priceAction.marketStructure().return.swings: import('@insiderfinance/totalfinance/technical-analysis').LabeledSwing[]; default: not declared - priceAction.marketStructure(bars): ArrayLike; default: not declared - priceAction.marketStructure(options)?: { strength?: number; }; default: not declared - priceAction.marketStructure(options).strength?: number; default: not declared - priceAction.openingRange: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => import('@insiderfinance/totalfinance/technical-analysis').OpeningRange; default: not declared - priceAction.openingRange().return.assumptions: { conventionsVersion: string; periods: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.openingRange().return.assumptions.conventionsVersion: string; default: not declared - priceAction.openingRange().return.assumptions.periods: number; default: not declared - priceAction.openingRange().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.openingRange().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.openingRange().return.high: number; default: not declared - priceAction.openingRange().return.low: number; default: not declared - priceAction.openingRange().return.mid: number; default: not declared - priceAction.openingRange(bars): ArrayLike; default: not declared - priceAction.openingRange(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - priceAction.openingRange(options).periods: number; default: not declared - priceAction.openingRangeBreakout: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; default: not declared - priceAction.openingRangeBreakout(bars): ArrayLike; default: not declared - priceAction.openingRangeBreakout(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - priceAction.openingRangeBreakout(options).periods: number; default: not declared - priceAction.orbRetest: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; default: not declared - priceAction.orbRetest(bars): ArrayLike; default: not declared - priceAction.orbRetest(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - priceAction.orbRetest(options).periods: number; default: not declared - priceAction.pivots: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, method?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod) => import('@insiderfinance/totalfinance/technical-analysis').PivotLevels; default: not declared - priceAction.pivots().return.assumptions: { conventionsVersion: string; method: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.pivots().return.assumptions.conventionsVersion: string; default: not declared - priceAction.pivots().return.assumptions.method: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; default: not declared - priceAction.pivots().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.pivots().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.pivots().return.pivot: number; default: not declared - priceAction.pivots().return.resistance: number[]; default: not declared - priceAction.pivots().return.support: number[]; default: not declared - priceAction.pivots(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - priceAction.pivots(bar).close: number; default: not declared - priceAction.pivots(bar).high: number; default: not declared - priceAction.pivots(bar).low: number; default: not declared - priceAction.pivots(bar).open?: number; default: not declared - priceAction.pivots(bar).volume?: number; default: not declared - priceAction.pivots(method)?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; default: not declared - priceAction.previousSessionLevels: (bars: ArrayLike, sessionIds: ArrayLike) => (import('@insiderfinance/totalfinance/technical-analysis').PriorSessionLevel | null)[]; default: not declared - priceAction.previousSessionLevels(bars): ArrayLike; default: not declared - priceAction.previousSessionLevels(sessionIds): ArrayLike; default: not declared - priceAction.sessionRanges: (bars: ArrayLike, sessionIds: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').SessionRange[]; default: not declared - priceAction.sessionRanges(bars): ArrayLike; default: not declared - priceAction.sessionRanges(sessionIds): ArrayLike; default: not declared - priceAction.supportResistance: (bars: ArrayLike, options?: { strength?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').SupportResistance; default: not declared - priceAction.supportResistance().return.assumptions: { conventionsVersion: string; strength: number; tolerance: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.supportResistance().return.assumptions.conventionsVersion: string; default: not declared - priceAction.supportResistance().return.assumptions.strength: number; default: not declared - priceAction.supportResistance().return.assumptions.tolerance: number; default: not declared - priceAction.supportResistance().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.supportResistance().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.supportResistance().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').SrLevel[]; default: not declared - priceAction.supportResistance().return.support: import('@insiderfinance/totalfinance/technical-analysis').SrLevel[]; default: not declared - priceAction.supportResistance(bars): ArrayLike; default: not declared - priceAction.supportResistance(options)?: { strength?: number; tolerance?: number; }; default: not declared - priceAction.supportResistance(options).strength?: number; default: not declared - priceAction.supportResistance(options).tolerance?: number; default: not declared - priceAction.swings: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').Swings; default: not declared - priceAction.swings().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.swings().return.assumptions.conventionsVersion: string; default: not declared - priceAction.swings().return.assumptions.strength: number; default: not declared - priceAction.swings().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.swings().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.swings().return.highs: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - priceAction.swings().return.lows: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - priceAction.swings(bars): ArrayLike; default: not declared - priceAction.swings(options)?: { strength?: number; }; default: not declared - priceAction.swings(options).strength?: number; default: not declared - priceAction.trendlines: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; default: not declared - priceAction.trendlines().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - priceAction.trendlines().return.assumptions.conventionsVersion: string; default: not declared - priceAction.trendlines().return.assumptions.strength: number; default: not declared - priceAction.trendlines().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - priceAction.trendlines().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - priceAction.trendlines().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - priceAction.trendlines().return.resistance.from: number; default: not declared - priceAction.trendlines().return.resistance.intercept: number; default: not declared - priceAction.trendlines().return.resistance.slope: number; default: not declared - priceAction.trendlines().return.resistance.to: number; default: not declared - priceAction.trendlines().return.support: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - priceAction.trendlines().return.support.from: number; default: not declared - priceAction.trendlines().return.support.intercept: number; default: not declared - priceAction.trendlines().return.support.slope: number; default: not declared - priceAction.trendlines().return.support.to: number; default: not declared - priceAction.trendlines(bars): ArrayLike; default: not declared - priceAction.trendlines(options)?: { strength?: number; }; default: not declared - priceAction.trendlines(options).strength?: number; default: not declared - priceDistance: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ drift?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Price Distance — 2·(H−L) + |open − close[drift]| − |close − open|. - priceDistance(input): ArrayLike; default: not declared - priceDistance(parameters)?: { drift?: number; } | undefined; default: not declared - priceDistance(parameters).drift?: number; default: not declared - priceDistance.explain: (input: ArrayLike, parameters?: { drift?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - priceDistance.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - priceDistance.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - priceDistance.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - priceDistance.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - priceDistance.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - priceDistance.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - priceDistance.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - priceDistance.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - priceDistance.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - priceDistance.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - priceDistance.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - priceDistance.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - priceDistance.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - priceDistance.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - priceDistance.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - priceDistance.explain(input): ArrayLike; default: not declared - priceDistance.explain(parameters)?: { drift?: number; } | undefined; default: not declared - priceDistance.explain(parameters).drift?: number; default: not declared - priceDistance.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - priceDistance.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - priceDistance.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - priceDistance.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceDistance.fromJSON().return.value: number | null; default: not declared - priceDistance.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceDistance.fromJSON(snapshot).kind: string; default: not declared - priceDistance.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - priceDistance.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - priceDistance.stream: (parameters?: { drift?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - priceDistance.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - priceDistance.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - priceDistance.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceDistance.stream().return.value: number | null; default: not declared - priceDistance.stream(parameters)?: { drift?: number; } | undefined; default: not declared - priceDistance.stream(parameters).drift?: number; default: not declared - priceVolume: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Price · Volume — close × volume, optionally signed by the close-to-close direction. - priceVolume(input): ArrayLike; default: not declared - priceVolume(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PriceVolumeParameters | undefined; default: not declared - priceVolume(parameters).signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. - priceVolume.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PriceVolumeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - priceVolume.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - priceVolume.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - priceVolume.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - priceVolume.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - priceVolume.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - priceVolume.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - priceVolume.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - priceVolume.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - priceVolume.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - priceVolume.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - priceVolume.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - priceVolume.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - priceVolume.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - priceVolume.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - priceVolume.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - priceVolume.explain(input): ArrayLike; default: not declared - priceVolume.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PriceVolumeParameters | undefined; default: not declared - priceVolume.explain(parameters).signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. - priceVolume.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - priceVolume.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - priceVolume.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - priceVolume.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceVolume.fromJSON().return.value: number | null; default: not declared - priceVolume.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceVolume.fromJSON(snapshot).kind: string; default: not declared - priceVolume.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - priceVolume.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - priceVolume.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PriceVolumeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - priceVolume.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - priceVolume.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - priceVolume.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceVolume.stream().return.value: number | null; default: not declared - priceVolume.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PriceVolumeParameters | undefined; default: not declared - priceVolume.stream(parameters).signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. - priceVolumeRank: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Price Volume Rank — 1: price↑ & volume↑, 2: price↑ & volume↓, 3: price↓ & volume↑, 4: price↓ & volume↓ (ties count as "down"). - priceVolumeRank(input): ArrayLike; default: not declared - priceVolumeRank(parameters)?: Record | undefined; default: not declared - priceVolumeRank.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - priceVolumeRank.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - priceVolumeRank.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - priceVolumeRank.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - priceVolumeRank.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - priceVolumeRank.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - priceVolumeRank.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - priceVolumeRank.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - priceVolumeRank.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - priceVolumeRank.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - priceVolumeRank.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - priceVolumeRank.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - priceVolumeRank.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - priceVolumeRank.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - priceVolumeRank.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - priceVolumeRank.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - priceVolumeRank.explain(input): ArrayLike; default: not declared - priceVolumeRank.explain(parameters)?: Record | undefined; default: not declared - priceVolumeRank.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - priceVolumeRank.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - priceVolumeRank.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - priceVolumeRank.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceVolumeRank.fromJSON().return.value: number | null; default: not declared - priceVolumeRank.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceVolumeRank.fromJSON(snapshot).kind: string; default: not declared - priceVolumeRank.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - priceVolumeRank.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - priceVolumeRank.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - priceVolumeRank.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - priceVolumeRank.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - priceVolumeRank.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - priceVolumeRank.stream().return.value: number | null; default: not declared - priceVolumeRank.stream(parameters)?: Record | undefined; default: not declared - projectionOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint>; default: not declared - projectionOscillator(input): ArrayLike; default: not declared - projectionOscillator(parameters)?: { period?: number; } | undefined; default: not declared - projectionOscillator(parameters).period?: number; default: not declared - projectionOscillator.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - projectionOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - projectionOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - projectionOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - projectionOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - projectionOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - projectionOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - projectionOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - projectionOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - projectionOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - projectionOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - projectionOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - projectionOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - projectionOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - projectionOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - projectionOscillator.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - projectionOscillator.explain(input): ArrayLike; default: not declared - projectionOscillator.explain(parameters)?: { period?: number; } | undefined; default: not declared - projectionOscillator.explain(parameters).period?: number; default: not declared - projectionOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - projectionOscillator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint | null; default: not declared - projectionOscillator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - projectionOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - projectionOscillator.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint | null; default: not declared - projectionOscillator.fromJSON().return.value.lower: number; default: not declared - projectionOscillator.fromJSON().return.value.po: number; default: not declared - projectionOscillator.fromJSON().return.value.upper: number; default: not declared - projectionOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - projectionOscillator.fromJSON(snapshot).kind: string; default: not declared - projectionOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - projectionOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - projectionOscillator.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - projectionOscillator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint | null; default: not declared - projectionOscillator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - projectionOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - projectionOscillator.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').ProjectionPoint | null; default: not declared - projectionOscillator.stream().return.value.lower: number; default: not declared - projectionOscillator.stream().return.value.po: number; default: not declared - projectionOscillator.stream().return.value.upper: number; default: not declared - projectionOscillator.stream(parameters)?: { period?: number; } | undefined; default: not declared - projectionOscillator.stream(parameters).period?: number; default: not declared - psar: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - psar(input): ArrayLike; default: not declared - psar(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PsarParameters | undefined; default: not declared - psar(parameters).max?: number; default: not declared - psar(parameters).step?: number; default: not declared - psar.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PsarParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - psar.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - psar.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - psar.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - psar.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - psar.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - psar.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - psar.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - psar.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - psar.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - psar.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - psar.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - psar.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - psar.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - psar.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - psar.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').PsarPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - psar.explain(input): ArrayLike; default: not declared - psar.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PsarParameters | undefined; default: not declared - psar.explain(parameters).max?: number; default: not declared - psar.explain(parameters).step?: number; default: not declared - psar.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - psar.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PsarPoint | null; default: not declared - psar.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PsarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - psar.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psar.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').PsarPoint | null; default: not declared - psar.fromJSON().return.value.sar: number; default: not declared - psar.fromJSON().return.value.trend: number; default: not declared — +1 rising (long), −1 falling (short). - psar.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psar.fromJSON(snapshot).kind: string; default: not declared - psar.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - psar.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - psar.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PsarParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - psar.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PsarPoint | null; default: not declared - psar.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PsarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - psar.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psar.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').PsarPoint | null; default: not declared - psar.stream().return.value.sar: number; default: not declared - psar.stream().return.value.trend: number; default: not declared — +1 rising (long), −1 falling (short). - psar.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PsarParameters | undefined; default: not declared - psar.stream(parameters).max?: number; default: not declared - psar.stream(parameters).step?: number; default: not declared - psarExt: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - psarExt(input): ArrayLike; default: not declared - psarExt(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PsarExtParameters | undefined; default: not declared - psarExt(parameters).accelInitLong?: number; default: not declared - psarExt(parameters).accelInitShort?: number; default: not declared - psarExt(parameters).accelLong?: number; default: not declared - psarExt(parameters).accelMaxLong?: number; default: not declared - psarExt(parameters).accelMaxShort?: number; default: not declared - psarExt(parameters).accelShort?: number; default: not declared - psarExt(parameters).offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - psarExt(parameters).startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. - psarExt.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PsarExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - psarExt.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - psarExt.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - psarExt.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - psarExt.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - psarExt.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - psarExt.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - psarExt.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - psarExt.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - psarExt.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - psarExt.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - psarExt.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - psarExt.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - psarExt.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - psarExt.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - psarExt.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - psarExt.explain(input): ArrayLike; default: not declared - psarExt.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PsarExtParameters | undefined; default: not declared - psarExt.explain(parameters).accelInitLong?: number; default: not declared - psarExt.explain(parameters).accelInitShort?: number; default: not declared - psarExt.explain(parameters).accelLong?: number; default: not declared - psarExt.explain(parameters).accelMaxLong?: number; default: not declared - psarExt.explain(parameters).accelMaxShort?: number; default: not declared - psarExt.explain(parameters).accelShort?: number; default: not declared - psarExt.explain(parameters).offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - psarExt.explain(parameters).startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. - psarExt.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - psarExt.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - psarExt.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - psarExt.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psarExt.fromJSON().return.value: number | null; default: not declared - psarExt.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psarExt.fromJSON(snapshot).kind: string; default: not declared - psarExt.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - psarExt.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - psarExt.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PsarExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - psarExt.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - psarExt.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - psarExt.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psarExt.stream().return.value: number | null; default: not declared - psarExt.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PsarExtParameters | undefined; default: not declared - psarExt.stream(parameters).accelInitLong?: number; default: not declared - psarExt.stream(parameters).accelInitShort?: number; default: not declared - psarExt.stream(parameters).accelLong?: number; default: not declared - psarExt.stream(parameters).accelMaxLong?: number; default: not declared - psarExt.stream(parameters).accelMaxShort?: number; default: not declared - psarExt.stream(parameters).accelShort?: number; default: not declared - psarExt.stream(parameters).offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - psarExt.stream(parameters).startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. - psychologicalLine: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - psychologicalLine(input): ArrayLike; default: not declared - psychologicalLine(parameters)?: { period?: number; } | undefined; default: not declared - psychologicalLine(parameters).period?: number; default: not declared - psychologicalLine.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - psychologicalLine.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - psychologicalLine.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - psychologicalLine.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - psychologicalLine.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - psychologicalLine.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - psychologicalLine.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - psychologicalLine.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - psychologicalLine.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - psychologicalLine.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - psychologicalLine.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - psychologicalLine.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - psychologicalLine.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - psychologicalLine.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - psychologicalLine.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - psychologicalLine.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - psychologicalLine.explain(input): ArrayLike; default: not declared - psychologicalLine.explain(parameters)?: { period?: number; } | undefined; default: not declared - psychologicalLine.explain(parameters).period?: number; default: not declared - psychologicalLine.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - psychologicalLine.fromJSON().return.next: (input: number) => number | null; default: not declared - psychologicalLine.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - psychologicalLine.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psychologicalLine.fromJSON().return.value: number | null; default: not declared - psychologicalLine.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psychologicalLine.fromJSON(snapshot).kind: string; default: not declared - psychologicalLine.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - psychologicalLine.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - psychologicalLine.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - psychologicalLine.stream().return.next: (input: number) => number | null; default: not declared - psychologicalLine.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - psychologicalLine.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - psychologicalLine.stream().return.value: number | null; default: not declared - psychologicalLine.stream(parameters)?: { period?: number; } | undefined; default: not declared - psychologicalLine.stream(parameters).period?: number; default: not declared - pvi: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - pvi(input): ArrayLike; default: not declared - pvi(parameters)?: Record | undefined; default: not declared - pvi.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - pvi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - pvi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - pvi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pvi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pvi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pvi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pvi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pvi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pvi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pvi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pvi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pvi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pvi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pvi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - pvi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - pvi.explain(input): ArrayLike; default: not declared - pvi.explain(parameters)?: Record | undefined; default: not declared - pvi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pvi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - pvi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pvi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvi.fromJSON().return.value: number | null; default: not declared - pvi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvi.fromJSON(snapshot).kind: string; default: not declared - pvi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - pvi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - pvi.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pvi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - pvi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pvi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvi.stream().return.value: number | null; default: not declared - pvi.stream(parameters)?: Record | undefined; default: not declared - pvo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - pvo(input): ArrayLike; default: not declared - pvo(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PvoParameters | undefined; default: not declared - pvo(parameters).fast?: number; default: not declared - pvo(parameters).signal?: number; default: not declared - pvo(parameters).slow?: number; default: not declared - pvo.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PvoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - pvo.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - pvo.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - pvo.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pvo.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pvo.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pvo.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pvo.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pvo.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pvo.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pvo.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pvo.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pvo.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pvo.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pvo.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - pvo.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').PvoPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - pvo.explain(input): ArrayLike; default: not declared - pvo.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PvoParameters | undefined; default: not declared - pvo.explain(parameters).fast?: number; default: not declared - pvo.explain(parameters).signal?: number; default: not declared - pvo.explain(parameters).slow?: number; default: not declared - pvo.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pvo.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PvoPoint | null; default: not declared - pvo.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PvoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pvo.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvo.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').PvoPoint | null; default: not declared - pvo.fromJSON().return.value.histogram: number; default: not declared - pvo.fromJSON().return.value.pvo: number; default: not declared - pvo.fromJSON().return.value.signal: number; default: not declared - pvo.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvo.fromJSON(snapshot).kind: string; default: not declared - pvo.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - pvo.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - pvo.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PvoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pvo.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PvoPoint | null; default: not declared - pvo.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').PvoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pvo.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvo.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').PvoPoint | null; default: not declared - pvo.stream().return.value.histogram: number; default: not declared - pvo.stream().return.value.pvo: number; default: not declared - pvo.stream().return.value.signal: number; default: not declared - pvo.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PvoParameters | undefined; default: not declared - pvo.stream(parameters).fast?: number; default: not declared - pvo.stream(parameters).signal?: number; default: not declared - pvo.stream(parameters).slow?: number; default: not declared - pvt: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - pvt(input): ArrayLike; default: not declared - pvt(parameters)?: Record | undefined; default: not declared - pvt.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - pvt.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - pvt.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - pvt.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pvt.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pvt.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pvt.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pvt.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pvt.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pvt.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pvt.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pvt.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pvt.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pvt.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pvt.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - pvt.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - pvt.explain(input): ArrayLike; default: not declared - pvt.explain(parameters)?: Record | undefined; default: not declared - pvt.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pvt.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - pvt.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pvt.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvt.fromJSON().return.value: number | null; default: not declared - pvt.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvt.fromJSON(snapshot).kind: string; default: not declared - pvt.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - pvt.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - pvt.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - pvt.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - pvt.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - pvt.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - pvt.stream().return.value: number | null; default: not declared - pvt.stream(parameters)?: Record | undefined; default: not declared - qqe: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - qqe(input): ArrayLike; default: not declared - qqe(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').QqeParameters | undefined; default: not declared - qqe(parameters).factor?: number; default: not declared - qqe(parameters).rsiPeriod?: number; default: not declared - qqe(parameters).smooth?: number; default: not declared - qqe.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').QqeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - qqe.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - qqe.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - qqe.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - qqe.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - qqe.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - qqe.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - qqe.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - qqe.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - qqe.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - qqe.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - qqe.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - qqe.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - qqe.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - qqe.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - qqe.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').QqePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - qqe.explain(input): ArrayLike; default: not declared - qqe.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').QqeParameters | undefined; default: not declared - qqe.explain(parameters).factor?: number; default: not declared - qqe.explain(parameters).rsiPeriod?: number; default: not declared - qqe.explain(parameters).smooth?: number; default: not declared - qqe.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - qqe.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').QqePoint | null; default: not declared - qqe.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').QqePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - qqe.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - qqe.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').QqePoint | null; default: not declared - qqe.fromJSON().return.value.longBand: number; default: not declared - qqe.fromJSON().return.value.rsiMovingAverage: number; default: not declared - qqe.fromJSON().return.value.shortBand: number; default: not declared - qqe.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - qqe.fromJSON(snapshot).kind: string; default: not declared - qqe.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - qqe.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - qqe.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').QqeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - qqe.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').QqePoint | null; default: not declared - qqe.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').QqePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - qqe.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - qqe.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').QqePoint | null; default: not declared - qqe.stream().return.value.longBand: number; default: not declared - qqe.stream().return.value.rsiMovingAverage: number; default: not declared - qqe.stream().return.value.shortBand: number; default: not declared - qqe.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').QqeParameters | undefined; default: not declared - qqe.stream(parameters).factor?: number; default: not declared - qqe.stream(parameters).rsiPeriod?: number; default: not declared - qqe.stream(parameters).smooth?: number; default: not declared - qstick: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Q Stick — SMA of (close − open); positive = bullish bodies dominate. - qstick(input): ArrayLike; default: not declared - qstick(parameters)?: { period?: number; } | undefined; default: not declared - qstick(parameters).period?: number; default: not declared - qstick.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - qstick.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - qstick.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - qstick.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - qstick.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - qstick.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - qstick.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - qstick.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - qstick.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - qstick.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - qstick.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - qstick.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - qstick.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - qstick.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - qstick.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - qstick.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - qstick.explain(input): ArrayLike; default: not declared - qstick.explain(parameters)?: { period?: number; } | undefined; default: not declared - qstick.explain(parameters).period?: number; default: not declared - qstick.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - qstick.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - qstick.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - qstick.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - qstick.fromJSON().return.value: number | null; default: not declared - qstick.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - qstick.fromJSON(snapshot).kind: string; default: not declared - qstick.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - qstick.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - qstick.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - qstick.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - qstick.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - qstick.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - qstick.stream().return.value: number | null; default: not declared - qstick.stream(parameters)?: { period?: number; } | undefined; default: not declared - qstick.stream(parameters).period?: number; default: not declared - rSquared: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared — Rolling R² (squared Pearson correlation) of a paired series. - rSquared(input): ArrayLike; default: not declared - rSquared(parameters)?: { period?: number; } | undefined; default: not declared - rSquared(parameters).period?: number; default: not declared - rSquared.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rSquared.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rSquared.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rSquared.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rSquared.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rSquared.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rSquared.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rSquared.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rSquared.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rSquared.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rSquared.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rSquared.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rSquared.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rSquared.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rSquared.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rSquared.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rSquared.explain(input): ArrayLike; default: not declared - rSquared.explain(parameters)?: { period?: number; } | undefined; default: not declared - rSquared.explain(parameters).period?: number; default: not declared - rSquared.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rSquared.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - rSquared.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rSquared.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rSquared.fromJSON().return.value: number | null; default: not declared - rSquared.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rSquared.fromJSON(snapshot).kind: string; default: not declared - rSquared.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rSquared.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rSquared.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rSquared.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - rSquared.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rSquared.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rSquared.stream().return.value: number | null; default: not declared - rSquared.stream(parameters)?: { period?: number; } | undefined; default: not declared - rSquared.stream(parameters).period?: number; default: not declared - rainbowMovingAverage: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rainbowMovingAverage(input): ArrayLike; default: not declared - rainbowMovingAverage(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RainbowParameters | undefined; default: not declared - rainbowMovingAverage(parameters).levels?: number; default: not declared - rainbowMovingAverage(parameters).period?: number; default: not declared - rainbowMovingAverage.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RainbowParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rainbowMovingAverage.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rainbowMovingAverage.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rainbowMovingAverage.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rainbowMovingAverage.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rainbowMovingAverage.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rainbowMovingAverage.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rainbowMovingAverage.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rainbowMovingAverage.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rainbowMovingAverage.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rainbowMovingAverage.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rainbowMovingAverage.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rainbowMovingAverage.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rainbowMovingAverage.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rainbowMovingAverage.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rainbowMovingAverage.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rainbowMovingAverage.explain(input): ArrayLike; default: not declared - rainbowMovingAverage.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RainbowParameters | undefined; default: not declared - rainbowMovingAverage.explain(parameters).levels?: number; default: not declared - rainbowMovingAverage.explain(parameters).period?: number; default: not declared - rainbowMovingAverage.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rainbowMovingAverage.fromJSON().return.next: (input: number) => number | null; default: not declared - rainbowMovingAverage.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rainbowMovingAverage.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rainbowMovingAverage.fromJSON().return.value: number | null; default: not declared - rainbowMovingAverage.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rainbowMovingAverage.fromJSON(snapshot).kind: string; default: not declared - rainbowMovingAverage.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rainbowMovingAverage.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rainbowMovingAverage.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RainbowParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rainbowMovingAverage.stream().return.next: (input: number) => number | null; default: not declared - rainbowMovingAverage.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rainbowMovingAverage.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rainbowMovingAverage.stream().return.value: number | null; default: not declared - rainbowMovingAverage.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RainbowParameters | undefined; default: not declared - rainbowMovingAverage.stream(parameters).levels?: number; default: not declared - rainbowMovingAverage.stream(parameters).period?: number; default: not declared - rangeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - rangeBars(bars): ArrayLike; default: not declared - rangeBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters; default: not declared - rangeBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - rangeBars(parameters).size: number; default: not declared - readSnapshot: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot, expected: Kind | readonly Kind[]) => import('@insiderfinance/totalfinance/technical-analysis').SnapshotState; default: not declared — Validate a snapshot envelope and open its state for checked reading. `expected` is the kind the CALLING restorer produces. Passing it is what turns a restorer from "rebuilds itself out of whatever numbers are in front of it" into one that knows whose snapshot it is holding — and it costs the call site four characters. A LIST is accepted for the handful of restorers that serve a FAMILY: one `MomentStream` class backs both `standardDeviation` and `variance`, and reads which one it is off the snapshot. Those are the restorers that genuinely may not pin a single kind — and a list still pins the family, which is the whole guarantee. A restorer that pins nothing is the defect this parameter exists to remove, so there is no form of this call that omits it. Order matters, and each step is the precondition of the next: an envelope that is not an object has no version; a version this build cannot read makes every field meaningless; a snapshot from another indicator has the wrong fields entirely, so reporting a missing field would send the reader looking in the wrong place. - readSnapshot().return.boolean: (field: string) => boolean; default: not declared — A boolean flag. - readSnapshot().return.cached: (field: string) => T | null; default: not declared — The LAST EMITTED OUTPUT, cached so a restored stream's `.value` is not blank until the next bar. Deliberately the loosest accessor, and the only one that tolerates non-finite: `NaN` is a real output. `acos` outside [-1, 1] is NaN; a `fairValueGaps` point reads `{ top: NaN, bottom: NaN }` until a gap forms. Rejecting those would refuse to restore a correct stream. What it still refuses is a value of a kind no indicator ever outputs — a string, a boolean, a function — which is what a foreign or hand-edited snapshot looks like. A missing key reads as `null` rather than throwing: the cache is an optimisation, and a snapshot that predates an indicator caching its value must restore to "no value yet", not fail. - readSnapshot().return.child: (field: string) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared — A nested snapshot envelope — a composed indicator's child (`macd` carries three EMAs). Only the SHAPE is checked here. The child's own `fromJSON` calls `readSnapshot` with the kind it expects, so a child from the wrong indicator is convicted there, with that indicator's name on the message rather than the parent's. - readSnapshot().return.children: (field: string) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot[]; default: not declared — A fresh array of nested snapshot envelopes. - readSnapshot().return.has: (field: string) => boolean; default: not declared — Does the state carry this key at all? For a field a newer build may legitimately omit. - readSnapshot().return.integer: (field: string) => number; default: not declared — A whole number ≥ 0 — a count, an index, a bar offset. A fractional count restores a stream whose window boundaries never line up again, which shows up as an off-by-a-fraction output rather than as an error. - readSnapshot().return.kind: Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - readSnapshot().return.literal: (field: string, allowed: readonly T[]) => T; default: not declared — A value drawn from a closed set — a mode, a method, a moving-average family, a trade direction. Numbers as well as strings: `TradeDirection` is `-1 | 0 | 1`, and reading it as a plain number would accept `7` as a trade direction. - readSnapshot().return.literals: (field: string, allowed: readonly T[]) => T[]; default: not declared — A fresh array of values drawn from a closed set. - readSnapshot().return.lookback: (field: string) => number; default: not declared — A lookback: an integer ≥ 1. This is the asymmetry the reader exists to close. `ta.rsi.stream({ period: -3 })` throws from `requirePeriod`; `RsiStream.fromJSON` read the same number straight out of state and built a stream with a negative window, which produces `undefined` buffer reads and silent NaN. - readSnapshot().return.number: (field: string) => number; default: not declared — A number: sums, running averages, thresholds, multipliers. Non-finite is permitted HERE and refused at the door. `readSnapshot` has already walked the whole state: an encoded non-finite has been decoded (the indicator computed it — a zero price series makes every log-return NaN), and a raw one has been rejected as damage. By the time an accessor runs, `NaN` can only mean the first. - readSnapshot().return.numberOrNull: (field: string) => number | null; default: not declared — A number or `null` — a running value that has not been established yet. - readSnapshot().return.numberRows: (field: string) => number[][]; default: not declared — A fresh array of fresh number arrays — a matrix of windows. - readSnapshot().return.numbers: (field: string) => number[]; default: not declared — A FRESH array of finite numbers. Fresh matters: the previous `state['buf'] as number[]` aliased the caller's snapshot, so two streams restored from one snapshot object shared a buffer and corrupted each other. Restorers used to spell that defence themselves (`[...(state['buf'] as number[])]`) and could forget to. - readSnapshot().return.numbersOrNull: (field: string) => number[] | null; default: not declared — A fresh array of finite numbers, or `null`. - readSnapshot().return.optionalNumber: (field: string) => number | undefined; default: not declared — A number the state may omit entirely (an optional parameter a stream carries). - readSnapshot().return.optionalNumbers: (field: string) => number[] | undefined; default: not declared — A fresh array of finite numbers the state may omit. - readSnapshot().return.raw: Record; default: not declared — The raw state object. For a restorer that must hand a whole sub-object to a helper. - readSnapshot().return.record: (field: string) => T; default: not declared — A structured record the indicator persists whole — a bar, a candle, an accumulator. Members are not walked: their shape is the indicator's own business and varies per record type. The check is that it IS a record, which is what separates a usable snapshot from `"acc"` or `7`. - readSnapshot().return.recordOrNull: (field: string) => T | null; default: not declared — A structured record, or `null` when the indicator has not established one. - readSnapshot().return.records: (field: string) => T[]; default: not declared — A fresh array of structured records — persisted bars, candles, levels. - readSnapshot().return.text: (field: string) => string; default: not declared — A string. - readSnapshot(expected): Kind | readonly Kind[]; default: not declared - readSnapshot(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - readSnapshot(snapshot).kind: string; default: not declared - readSnapshot(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - readSnapshot(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - realBody: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - realBody(input): ArrayLike; default: not declared - realBody(parameters)?: {} | undefined; default: not declared - realBody.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - realBody.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - realBody.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - realBody.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - realBody.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - realBody.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - realBody.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - realBody.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - realBody.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - realBody.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - realBody.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - realBody.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - realBody.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - realBody.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - realBody.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - realBody.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - realBody.explain(input): ArrayLike; default: not declared - realBody.explain(parameters)?: {} | undefined; default: not declared - realBody.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - realBody.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - realBody.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - realBody.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - realBody.fromJSON().return.value: number | null; default: not declared - realBody.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - realBody.fromJSON(snapshot).kind: string; default: not declared - realBody.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - realBody.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - realBody.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - realBody.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - realBody.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - realBody.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - realBody.stream().return.value: number | null; default: not declared - realBody.stream(parameters)?: {} | undefined; default: not declared - realizedVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - realizedVolatility(input): ArrayLike; default: not declared - realizedVolatility(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined; default: not declared - realizedVolatility(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - realizedVolatility(parameters).period: number; default: not declared - realizedVolatility.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - realizedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - realizedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - realizedVolatility.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - realizedVolatility.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - realizedVolatility.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - realizedVolatility.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - realizedVolatility.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - realizedVolatility.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - realizedVolatility.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - realizedVolatility.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - realizedVolatility.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - realizedVolatility.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - realizedVolatility.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - realizedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - realizedVolatility.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - realizedVolatility.explain(input): ArrayLike; default: not declared - realizedVolatility.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined; default: not declared - realizedVolatility.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - realizedVolatility.explain(parameters).period: number; default: not declared - realizedVolatility.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - realizedVolatility.fromJSON().return.next: (input: number) => number | null; default: not declared - realizedVolatility.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - realizedVolatility.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - realizedVolatility.fromJSON().return.value: number | null; default: not declared - realizedVolatility.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - realizedVolatility.fromJSON(snapshot).kind: string; default: not declared - realizedVolatility.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - realizedVolatility.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - realizedVolatility.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - realizedVolatility.stream().return.next: (input: number) => number | null; default: not declared - realizedVolatility.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - realizedVolatility.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - realizedVolatility.stream().return.value: number | null; default: not declared - realizedVolatility.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').HistoricalVolatilityParameters | undefined; default: not declared - realizedVolatility.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - realizedVolatility.stream(parameters).period: number; default: not declared - register: (entry: import('@insiderfinance/totalfinance/technical-analysis').RegisteredIndicator) => void; default: not declared - register(entry): import('@insiderfinance/totalfinance/technical-analysis').RegisteredIndicator; default: not declared - register(entry).category: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - register(entry).conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - register(entry).defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - register(entry).indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - register(entry).indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - register(entry).indicator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - register(entry).indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - register(entry).inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared - register(entry).name: string; default: not declared - register(entry).output: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - register(entry).parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). - registryMarkdown: () => string; default: not declared — Render the registry as a Markdown reference table, grouped by category. - relativeVigorIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint>; default: not declared - relativeVigorIndex(input): ArrayLike; default: not declared - relativeVigorIndex(parameters)?: { period?: number; } | undefined; default: not declared - relativeVigorIndex(parameters).period?: number; default: not declared - relativeVigorIndex.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - relativeVigorIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - relativeVigorIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - relativeVigorIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - relativeVigorIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - relativeVigorIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - relativeVigorIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - relativeVigorIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - relativeVigorIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - relativeVigorIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - relativeVigorIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - relativeVigorIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - relativeVigorIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - relativeVigorIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - relativeVigorIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - relativeVigorIndex.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - relativeVigorIndex.explain(input): ArrayLike; default: not declared - relativeVigorIndex.explain(parameters)?: { period?: number; } | undefined; default: not declared - relativeVigorIndex.explain(parameters).period?: number; default: not declared - relativeVigorIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - relativeVigorIndex.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint | null; default: not declared - relativeVigorIndex.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - relativeVigorIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVigorIndex.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint | null; default: not declared - relativeVigorIndex.fromJSON().return.value.rvi: number; default: not declared - relativeVigorIndex.fromJSON().return.value.signal: number; default: not declared - relativeVigorIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVigorIndex.fromJSON(snapshot).kind: string; default: not declared - relativeVigorIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - relativeVigorIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - relativeVigorIndex.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - relativeVigorIndex.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint | null; default: not declared - relativeVigorIndex.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - relativeVigorIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVigorIndex.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').RvgiPoint | null; default: not declared - relativeVigorIndex.stream().return.value.rvi: number; default: not declared - relativeVigorIndex.stream().return.value.signal: number; default: not declared - relativeVigorIndex.stream(parameters)?: { period?: number; } | undefined; default: not declared - relativeVigorIndex.stream(parameters).period?: number; default: not declared - relativeVolatilityIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - relativeVolatilityIndex(input): ArrayLike; default: not declared - relativeVolatilityIndex(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RviParameters | undefined; default: not declared - relativeVolatilityIndex(parameters).period?: number; default: not declared - relativeVolatilityIndex(parameters).stdevPeriod?: number; default: not declared - relativeVolatilityIndex.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RviParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - relativeVolatilityIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - relativeVolatilityIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - relativeVolatilityIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - relativeVolatilityIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - relativeVolatilityIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - relativeVolatilityIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - relativeVolatilityIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - relativeVolatilityIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - relativeVolatilityIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - relativeVolatilityIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - relativeVolatilityIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - relativeVolatilityIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - relativeVolatilityIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - relativeVolatilityIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - relativeVolatilityIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - relativeVolatilityIndex.explain(input): ArrayLike; default: not declared - relativeVolatilityIndex.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RviParameters | undefined; default: not declared - relativeVolatilityIndex.explain(parameters).period?: number; default: not declared - relativeVolatilityIndex.explain(parameters).stdevPeriod?: number; default: not declared - relativeVolatilityIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - relativeVolatilityIndex.fromJSON().return.next: (input: number) => number | null; default: not declared - relativeVolatilityIndex.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - relativeVolatilityIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVolatilityIndex.fromJSON().return.value: number | null; default: not declared - relativeVolatilityIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVolatilityIndex.fromJSON(snapshot).kind: string; default: not declared - relativeVolatilityIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - relativeVolatilityIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - relativeVolatilityIndex.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RviParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - relativeVolatilityIndex.stream().return.next: (input: number) => number | null; default: not declared - relativeVolatilityIndex.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - relativeVolatilityIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVolatilityIndex.stream().return.value: number | null; default: not declared - relativeVolatilityIndex.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RviParameters | undefined; default: not declared - relativeVolatilityIndex.stream(parameters).period?: number; default: not declared - relativeVolatilityIndex.stream(parameters).stdevPeriod?: number; default: not declared - relativeVolume: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - relativeVolume(input): ArrayLike; default: not declared - relativeVolume(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volume').PeriodParameters | undefined; default: not declared - relativeVolume(parameters).period: number; default: not declared - relativeVolume.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/volume').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - relativeVolume.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - relativeVolume.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - relativeVolume.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - relativeVolume.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - relativeVolume.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - relativeVolume.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - relativeVolume.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - relativeVolume.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - relativeVolume.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - relativeVolume.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - relativeVolume.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - relativeVolume.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - relativeVolume.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - relativeVolume.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - relativeVolume.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - relativeVolume.explain(input): ArrayLike; default: not declared - relativeVolume.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volume').PeriodParameters | undefined; default: not declared - relativeVolume.explain(parameters).period: number; default: not declared - relativeVolume.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - relativeVolume.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - relativeVolume.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - relativeVolume.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVolume.fromJSON().return.value: number | null; default: not declared - relativeVolume.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVolume.fromJSON(snapshot).kind: string; default: not declared - relativeVolume.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - relativeVolume.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - relativeVolume.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/volume').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - relativeVolume.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - relativeVolume.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - relativeVolume.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - relativeVolume.stream().return.value: number | null; default: not declared - relativeVolume.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/volume').PeriodParameters | undefined; default: not declared - relativeVolume.stream(parameters).period: number; default: not declared - renko: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; default: not declared - renko(bars): ArrayLike; default: not declared - renko(parameters): import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters; default: not declared - renko(parameters).brickSize: number; default: not declared - resample: (bars: ArrayLike, interval: import('@insiderfinance/totalfinance/technical-analysis').ResampleInterval, options?: import('@insiderfinance/totalfinance/technical-analysis').ResampleOptions) => import('@insiderfinance/totalfinance/technical-analysis').ResampledBar[]; default: not declared — Resample ascending timestamped bars to a higher timeframe on epoch-aligned buckets. OHLC = first-open / max-high / min-low / last-close; volume is summed; VWAP is volume-weighted over the bucket's typical prices. Only COMPLETED buckets are emitted by default — the final (forming) bucket is emitted only with `{ includePartial: true }` and flagged `partial: true`. Bars must be ascending by `timestampMs` (throws otherwise). - resample(bars): ArrayLike; default: not declared - resample(interval): import('@insiderfinance/totalfinance/technical-analysis').ResampleInterval; default: not declared - resample(options)?: import('@insiderfinance/totalfinance/technical-analysis').ResampleOptions; default: not declared - resample(options).includePartial?: boolean; default: not declared — Emit the final, still-forming bucket (flagged `partial: true`). Default `false`. - rescale: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling rescale of the min-max-normalized value into [min, max]. - rescale(input): ArrayLike; default: not declared - rescale(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RescaleParameters | undefined; default: not declared - rescale(parameters).max?: number; default: not declared — Target range maximum. Default 1. - rescale(parameters).min?: number; default: not declared — Target range minimum. Default 0. - rescale(parameters).period?: number; default: not declared - rescale.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RescaleParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rescale.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rescale.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rescale.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rescale.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rescale.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rescale.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rescale.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rescale.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rescale.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rescale.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rescale.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rescale.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rescale.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rescale.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rescale.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rescale.explain(input): ArrayLike; default: not declared - rescale.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RescaleParameters | undefined; default: not declared - rescale.explain(parameters).max?: number; default: not declared — Target range maximum. Default 1. - rescale.explain(parameters).min?: number; default: not declared — Target range minimum. Default 0. - rescale.explain(parameters).period?: number; default: not declared - rescale.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rescale.fromJSON().return.next: (input: number) => number | null; default: not declared - rescale.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rescale.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rescale.fromJSON().return.value: number | null; default: not declared - rescale.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rescale.fromJSON(snapshot).kind: string; default: not declared - rescale.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rescale.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rescale.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RescaleParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rescale.stream().return.next: (input: number) => number | null; default: not declared - rescale.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rescale.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rescale.stream().return.value: number | null; default: not declared - rescale.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RescaleParameters | undefined; default: not declared - rescale.stream(parameters).max?: number; default: not declared — Target range maximum. Default 1. - rescale.stream(parameters).min?: number; default: not declared — Target range minimum. Default 0. - rescale.stream(parameters).period?: number; default: not declared - resolveCandleName: (name: string) => string; default: not declared — Resolve a TotalFinance or TA-Lib `CDL*` pattern name to the TotalFinance catalog name (throws if unknown). - resolveCandleName(name): string; default: not declared - resolveIndicator: (name: string) => import('@insiderfinance/totalfinance/technical-analysis').RegisteredIndicator | undefined; default: not declared — Resolve a name (any convention) to its registered indicator, or `undefined`. - resolveIndicator().return.category: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - resolveIndicator().return.conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - resolveIndicator().return.defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - resolveIndicator().return.indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - resolveIndicator().return.indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - resolveIndicator().return.indicator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - resolveIndicator().return.indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - resolveIndicator().return.inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared - resolveIndicator().return.name: string; default: not declared - resolveIndicator().return.output: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - resolveIndicator().return.parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). - resolveIndicator(name): string; default: not declared - resolveIndicatorName: (name: string) => string | undefined; default: not declared — Resolve any TotalFinance / TA-Lib / pandas-ta / TradingView name (case-insensitive) to the canonical TotalFinance indicator name. An exact canonical name wins over a case variant, which wins over an external alias. Returns `undefined` if nothing matches. - resolveIndicatorName(name): string; default: not declared - returns: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; default: not declared - returns(input): ArrayLike; default: not declared - returns(parameters)?: Record | undefined; default: not declared - returns.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - returns.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - returns.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - returns.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - returns.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - returns.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - returns.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - returns.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - returns.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - returns.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - returns.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - returns.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - returns.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - returns.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - returns.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - returns.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - returns.explain(input): ArrayLike; default: not declared - returns.explain(parameters)?: Record | undefined; default: not declared - returns.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - returns.fromJSON().return.next: (input: number) => number | null; default: not declared - returns.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - returns.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - returns.fromJSON().return.value: number | null; default: not declared - returns.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - returns.fromJSON(snapshot).kind: string; default: not declared - returns.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - returns.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - returns.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - returns.stream().return.next: (input: number) => number | null; default: not declared - returns.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - returns.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - returns.stream().return.value: number | null; default: not declared - returns.stream(parameters)?: Record | undefined; default: not declared - rising: (operand: import('@insiderfinance/totalfinance/technical-analysis').Operand) => import('@insiderfinance/totalfinance/technical-analysis').Condition; default: not declared - rising().return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - rising(operand): import('@insiderfinance/totalfinance/technical-analysis').Operand; default: not declared - rma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rma(input): ArrayLike; default: not declared - rma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rma(parameters).period: number; default: not declared - rma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rma.explain(input): ArrayLike; default: not declared - rma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rma.explain(parameters).period: number; default: not declared - rma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rma.fromJSON().return.next: (input: number) => number | null; default: not declared - rma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rma.fromJSON().return.value: number | null; default: not declared - rma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rma.fromJSON(snapshot).kind: string; default: not declared - rma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rma.stream().return.next: (input: number) => number | null; default: not declared - rma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rma.stream().return.value: number | null; default: not declared - rma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rma.stream(parameters).period: number; default: not declared - roc: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - roc(input): ArrayLike; default: not declared - roc(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - roc(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - roc.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - roc.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - roc.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - roc.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - roc.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - roc.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - roc.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - roc.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - roc.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - roc.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - roc.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - roc.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - roc.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - roc.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - roc.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - roc.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - roc.explain(input): ArrayLike; default: not declared - roc.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - roc.explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - roc.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - roc.fromJSON().return.next: (input: number) => number | null; default: not declared - roc.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - roc.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - roc.fromJSON().return.value: number | null; default: not declared - roc.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - roc.fromJSON(snapshot).kind: string; default: not declared - roc.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - roc.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - roc.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - roc.stream().return.next: (input: number) => number | null; default: not declared - roc.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - roc.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - roc.stream().return.value: number | null; default: not declared - roc.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - roc.stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocp: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rocp(input): ArrayLike; default: not declared - rocp(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocp(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocp.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rocp.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rocp.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rocp.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rocp.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rocp.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rocp.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rocp.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rocp.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rocp.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rocp.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rocp.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rocp.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rocp.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rocp.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rocp.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rocp.explain(input): ArrayLike; default: not declared - rocp.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocp.explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocp.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rocp.fromJSON().return.next: (input: number) => number | null; default: not declared - rocp.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rocp.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocp.fromJSON().return.value: number | null; default: not declared - rocp.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocp.fromJSON(snapshot).kind: string; default: not declared - rocp.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rocp.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rocp.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rocp.stream().return.next: (input: number) => number | null; default: not declared - rocp.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rocp.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocp.stream().return.value: number | null; default: not declared - rocp.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocp.stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rocr(input): ArrayLike; default: not declared - rocr(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocr(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocr.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rocr.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rocr.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rocr.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rocr.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rocr.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rocr.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rocr.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rocr.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rocr.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rocr.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rocr.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rocr.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rocr.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rocr.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rocr.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rocr.explain(input): ArrayLike; default: not declared - rocr.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocr.explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocr.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rocr.fromJSON().return.next: (input: number) => number | null; default: not declared - rocr.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rocr.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocr.fromJSON().return.value: number | null; default: not declared - rocr.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocr.fromJSON(snapshot).kind: string; default: not declared - rocr.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rocr.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rocr.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rocr.stream().return.next: (input: number) => number | null; default: not declared - rocr.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rocr.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocr.stream().return.value: number | null; default: not declared - rocr.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocr.stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocr100: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rocr100(input): ArrayLike; default: not declared - rocr100(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocr100(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocr100.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rocr100.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rocr100.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rocr100.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rocr100.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rocr100.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rocr100.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rocr100.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rocr100.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rocr100.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rocr100.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rocr100.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rocr100.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rocr100.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rocr100.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rocr100.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rocr100.explain(input): ArrayLike; default: not declared - rocr100.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocr100.explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rocr100.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rocr100.fromJSON().return.next: (input: number) => number | null; default: not declared - rocr100.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rocr100.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocr100.fromJSON().return.value: number | null; default: not declared - rocr100.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocr100.fromJSON(snapshot).kind: string; default: not declared - rocr100.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rocr100.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rocr100.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rocr100.stream().return.next: (input: number) => number | null; default: not declared - rocr100.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rocr100.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rocr100.stream().return.value: number | null; default: not declared - rocr100.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RocParameters | undefined; default: not declared - rocr100.stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - rogersSatchell: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rogersSatchell(input): ArrayLike; default: not declared - rogersSatchell(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - rogersSatchell(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - rogersSatchell(parameters).period: number; default: not declared - rogersSatchell.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rogersSatchell.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rogersSatchell.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rogersSatchell.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rogersSatchell.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rogersSatchell.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rogersSatchell.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rogersSatchell.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rogersSatchell.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rogersSatchell.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rogersSatchell.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rogersSatchell.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rogersSatchell.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rogersSatchell.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rogersSatchell.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rogersSatchell.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rogersSatchell.explain(input): ArrayLike; default: not declared - rogersSatchell.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - rogersSatchell.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - rogersSatchell.explain(parameters).period: number; default: not declared - rogersSatchell.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rogersSatchell.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - rogersSatchell.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rogersSatchell.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rogersSatchell.fromJSON().return.value: number | null; default: not declared - rogersSatchell.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rogersSatchell.fromJSON(snapshot).kind: string; default: not declared - rogersSatchell.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rogersSatchell.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rogersSatchell.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rogersSatchell.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - rogersSatchell.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rogersSatchell.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rogersSatchell.stream().return.value: number | null; default: not declared - rogersSatchell.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - rogersSatchell.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - rogersSatchell.stream(parameters).period: number; default: not declared - rollingAnchoredVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingAnchoredVwap(input): ArrayLike; default: not declared - rollingAnchoredVwap(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RollingAnchoredVwapParameters | undefined; default: not declared - rollingAnchoredVwap(parameters).anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - rollingAnchoredVwap(parameters).lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. - rollingAnchoredVwap.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RollingAnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingAnchoredVwap.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingAnchoredVwap.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingAnchoredVwap.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingAnchoredVwap.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingAnchoredVwap.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingAnchoredVwap.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingAnchoredVwap.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingAnchoredVwap.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingAnchoredVwap.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingAnchoredVwap.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingAnchoredVwap.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingAnchoredVwap.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingAnchoredVwap.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingAnchoredVwap.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingAnchoredVwap.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingAnchoredVwap.explain(input): ArrayLike; default: not declared - rollingAnchoredVwap.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RollingAnchoredVwapParameters | undefined; default: not declared - rollingAnchoredVwap.explain(parameters).anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - rollingAnchoredVwap.explain(parameters).lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. - rollingAnchoredVwap.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingAnchoredVwap.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint | null; default: not declared - rollingAnchoredVwap.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingAnchoredVwap.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingAnchoredVwap.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint | null; default: not declared - rollingAnchoredVwap.fromJSON().return.value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - rollingAnchoredVwap.fromJSON().return.value.vwap: number; default: not declared - rollingAnchoredVwap.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingAnchoredVwap.fromJSON(snapshot).kind: string; default: not declared - rollingAnchoredVwap.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingAnchoredVwap.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingAnchoredVwap.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RollingAnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingAnchoredVwap.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint | null; default: not declared - rollingAnchoredVwap.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingAnchoredVwap.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingAnchoredVwap.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').AnchoredVwapPoint | null; default: not declared - rollingAnchoredVwap.stream().return.value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - rollingAnchoredVwap.stream().return.value.vwap: number; default: not declared - rollingAnchoredVwap.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RollingAnchoredVwapParameters | undefined; default: not declared - rollingAnchoredVwap.stream(parameters).anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - rollingAnchoredVwap.stream(parameters).lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. - rollingBeta: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling beta vs a benchmark (alias of `beta`). - rollingBeta(input): ArrayLike; default: not declared - rollingBeta(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingBeta(parameters).period: number; default: not declared - rollingBeta.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingBeta.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingBeta.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingBeta.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingBeta.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingBeta.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingBeta.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingBeta.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingBeta.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingBeta.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingBeta.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingBeta.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingBeta.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingBeta.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingBeta.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingBeta.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingBeta.explain(input): ArrayLike; default: not declared - rollingBeta.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingBeta.explain(parameters).period: number; default: not declared - rollingBeta.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingBeta.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - rollingBeta.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingBeta.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingBeta.fromJSON().return.value: number | null; default: not declared - rollingBeta.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingBeta.fromJSON(snapshot).kind: string; default: not declared - rollingBeta.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingBeta.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingBeta.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingBeta.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - rollingBeta.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingBeta.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingBeta.stream().return.value: number | null; default: not declared - rollingBeta.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingBeta.stream(parameters).period: number; default: not declared - rollingCorrelation: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling Pearson correlation (alias of `correl`). - rollingCorrelation(input): ArrayLike; default: not declared - rollingCorrelation(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingCorrelation(parameters).period: number; default: not declared - rollingCorrelation.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingCorrelation.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingCorrelation.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingCorrelation.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingCorrelation.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingCorrelation.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingCorrelation.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingCorrelation.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingCorrelation.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingCorrelation.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingCorrelation.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingCorrelation.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingCorrelation.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingCorrelation.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingCorrelation.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingCorrelation.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingCorrelation.explain(input): ArrayLike; default: not declared - rollingCorrelation.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingCorrelation.explain(parameters).period: number; default: not declared - rollingCorrelation.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingCorrelation.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - rollingCorrelation.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingCorrelation.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingCorrelation.fromJSON().return.value: number | null; default: not declared - rollingCorrelation.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingCorrelation.fromJSON(snapshot).kind: string; default: not declared - rollingCorrelation.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingCorrelation.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingCorrelation.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingCorrelation.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - rollingCorrelation.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingCorrelation.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingCorrelation.stream().return.value: number | null; default: not declared - rollingCorrelation.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingCorrelation.stream(parameters).period: number; default: not declared - rollingMax: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingMax(input): ArrayLike; default: not declared - rollingMax(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMax(parameters).period: number; default: not declared - rollingMax.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMax.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMax.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMax.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMax.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMax.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMax.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMax.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMax.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMax.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMax.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMax.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMax.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMax.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMax.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMax.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMax.explain(input): ArrayLike; default: not declared - rollingMax.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMax.explain(parameters).period: number; default: not declared - rollingMax.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMax.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMax.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMax.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMax.fromJSON().return.value: number | null; default: not declared - rollingMax.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMax.fromJSON(snapshot).kind: string; default: not declared - rollingMax.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMax.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMax.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMax.stream().return.next: (input: number) => number | null; default: not declared - rollingMax.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMax.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMax.stream().return.value: number | null; default: not declared - rollingMax.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMax.stream(parameters).period: number; default: not declared - rollingMaxIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Bars ago (0 = current bar) of the highest value in the window. - rollingMaxIndex(input): ArrayLike; default: not declared - rollingMaxIndex(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMaxIndex(parameters).period: number; default: not declared - rollingMaxIndex.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMaxIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMaxIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMaxIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMaxIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMaxIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMaxIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMaxIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMaxIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMaxIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMaxIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMaxIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMaxIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMaxIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMaxIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMaxIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMaxIndex.explain(input): ArrayLike; default: not declared - rollingMaxIndex.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMaxIndex.explain(parameters).period: number; default: not declared - rollingMaxIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMaxIndex.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMaxIndex.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMaxIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMaxIndex.fromJSON().return.value: number | null; default: not declared - rollingMaxIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMaxIndex.fromJSON(snapshot).kind: string; default: not declared - rollingMaxIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMaxIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMaxIndex.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMaxIndex.stream().return.next: (input: number) => number | null; default: not declared - rollingMaxIndex.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMaxIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMaxIndex.stream().return.value: number | null; default: not declared - rollingMaxIndex.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMaxIndex.stream(parameters).period: number; default: not declared - rollingMean: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling mean (alias of `sma`). - rollingMean(input): ArrayLike; default: not declared - rollingMean(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rollingMean(parameters).period: number; default: not declared - rollingMean.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMean.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMean.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMean.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMean.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMean.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMean.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMean.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMean.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMean.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMean.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMean.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMean.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMean.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMean.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMean.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMean.explain(input): ArrayLike; default: not declared - rollingMean.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rollingMean.explain(parameters).period: number; default: not declared - rollingMean.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMean.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMean.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMean.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMean.fromJSON().return.value: number | null; default: not declared - rollingMean.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMean.fromJSON(snapshot).kind: string; default: not declared - rollingMean.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMean.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMean.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMean.stream().return.next: (input: number) => number | null; default: not declared - rollingMean.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMean.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMean.stream().return.value: number | null; default: not declared - rollingMean.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rollingMean.stream(parameters).period: number; default: not declared - rollingMeanAbsoluteDeviation: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling mean absolute deviation from the window mean. - rollingMeanAbsoluteDeviation(input): ArrayLike; default: not declared - rollingMeanAbsoluteDeviation(parameters)?: { period?: number; } | undefined; default: not declared - rollingMeanAbsoluteDeviation(parameters).period?: number; default: not declared - rollingMeanAbsoluteDeviation.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMeanAbsoluteDeviation.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMeanAbsoluteDeviation.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMeanAbsoluteDeviation.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMeanAbsoluteDeviation.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMeanAbsoluteDeviation.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMeanAbsoluteDeviation.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMeanAbsoluteDeviation.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMeanAbsoluteDeviation.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMeanAbsoluteDeviation.explain(input): ArrayLike; default: not declared - rollingMeanAbsoluteDeviation.explain(parameters)?: { period?: number; } | undefined; default: not declared - rollingMeanAbsoluteDeviation.explain(parameters).period?: number; default: not declared - rollingMeanAbsoluteDeviation.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMeanAbsoluteDeviation.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMeanAbsoluteDeviation.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMeanAbsoluteDeviation.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMeanAbsoluteDeviation.fromJSON().return.value: number | null; default: not declared - rollingMeanAbsoluteDeviation.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMeanAbsoluteDeviation.fromJSON(snapshot).kind: string; default: not declared - rollingMeanAbsoluteDeviation.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMeanAbsoluteDeviation.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMeanAbsoluteDeviation.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMeanAbsoluteDeviation.stream().return.next: (input: number) => number | null; default: not declared - rollingMeanAbsoluteDeviation.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMeanAbsoluteDeviation.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMeanAbsoluteDeviation.stream().return.value: number | null; default: not declared - rollingMeanAbsoluteDeviation.stream(parameters)?: { period?: number; } | undefined; default: not declared - rollingMeanAbsoluteDeviation.stream(parameters).period?: number; default: not declared - rollingMedian: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling median. - rollingMedian(input): ArrayLike; default: not declared - rollingMedian(parameters)?: { period?: number; } | undefined; default: not declared - rollingMedian(parameters).period?: number; default: not declared - rollingMedian.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMedian.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMedian.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMedian.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMedian.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMedian.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMedian.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMedian.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMedian.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMedian.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMedian.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMedian.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMedian.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMedian.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMedian.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMedian.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMedian.explain(input): ArrayLike; default: not declared - rollingMedian.explain(parameters)?: { period?: number; } | undefined; default: not declared - rollingMedian.explain(parameters).period?: number; default: not declared - rollingMedian.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMedian.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMedian.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMedian.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMedian.fromJSON().return.value: number | null; default: not declared - rollingMedian.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMedian.fromJSON(snapshot).kind: string; default: not declared - rollingMedian.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMedian.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMedian.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMedian.stream().return.next: (input: number) => number | null; default: not declared - rollingMedian.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMedian.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMedian.stream().return.value: number | null; default: not declared - rollingMedian.stream(parameters)?: { period?: number; } | undefined; default: not declared - rollingMedian.stream(parameters).period?: number; default: not declared - rollingMin: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingMin(input): ArrayLike; default: not declared - rollingMin(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMin(parameters).period: number; default: not declared - rollingMin.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMin.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMin.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMin.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMin.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMin.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMin.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMin.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMin.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMin.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMin.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMin.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMin.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMin.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMin.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMin.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMin.explain(input): ArrayLike; default: not declared - rollingMin.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMin.explain(parameters).period: number; default: not declared - rollingMin.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMin.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMin.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMin.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMin.fromJSON().return.value: number | null; default: not declared - rollingMin.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMin.fromJSON(snapshot).kind: string; default: not declared - rollingMin.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMin.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMin.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMin.stream().return.next: (input: number) => number | null; default: not declared - rollingMin.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMin.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMin.stream().return.value: number | null; default: not declared - rollingMin.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMin.stream(parameters).period: number; default: not declared - rollingMinIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Bars ago (0 = current bar) of the lowest value in the window. - rollingMinIndex(input): ArrayLike; default: not declared - rollingMinIndex(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinIndex(parameters).period: number; default: not declared - rollingMinIndex.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMinIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMinIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMinIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMinIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMinIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMinIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMinIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMinIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMinIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMinIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMinIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMinIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMinIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMinIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMinIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMinIndex.explain(input): ArrayLike; default: not declared - rollingMinIndex.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinIndex.explain(parameters).period: number; default: not declared - rollingMinIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMinIndex.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingMinIndex.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMinIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinIndex.fromJSON().return.value: number | null; default: not declared - rollingMinIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinIndex.fromJSON(snapshot).kind: string; default: not declared - rollingMinIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMinIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMinIndex.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMinIndex.stream().return.next: (input: number) => number | null; default: not declared - rollingMinIndex.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMinIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinIndex.stream().return.value: number | null; default: not declared - rollingMinIndex.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinIndex.stream(parameters).period: number; default: not declared - rollingMinMax: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingMinMax(input): ArrayLike; default: not declared - rollingMinMax(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinMax(parameters).period: number; default: not declared - rollingMinMax.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMinMax.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMinMax.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMinMax.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMinMax.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMinMax.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMinMax.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMinMax.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMinMax.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMinMax.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMinMax.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMinMax.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMinMax.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMinMax.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMinMax.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMinMax.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMinMax.explain(input): ArrayLike; default: not declared - rollingMinMax.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinMax.explain(parameters).period: number; default: not declared - rollingMinMax.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMinMax.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint | null; default: not declared - rollingMinMax.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMinMax.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinMax.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint | null; default: not declared - rollingMinMax.fromJSON().return.value.max: number; default: not declared - rollingMinMax.fromJSON().return.value.min: number; default: not declared - rollingMinMax.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinMax.fromJSON(snapshot).kind: string; default: not declared - rollingMinMax.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMinMax.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMinMax.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMinMax.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint | null; default: not declared - rollingMinMax.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMinMax.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinMax.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MinMaxPoint | null; default: not declared - rollingMinMax.stream().return.value.max: number; default: not declared - rollingMinMax.stream().return.value.min: number; default: not declared - rollingMinMax.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinMax.stream(parameters).period: number; default: not declared - rollingMinMaxIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingMinMaxIndex(input): ArrayLike; default: not declared - rollingMinMaxIndex(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinMaxIndex(parameters).period: number; default: not declared - rollingMinMaxIndex.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingMinMaxIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingMinMaxIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingMinMaxIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingMinMaxIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingMinMaxIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingMinMaxIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingMinMaxIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingMinMaxIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingMinMaxIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingMinMaxIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingMinMaxIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingMinMaxIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingMinMaxIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingMinMaxIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingMinMaxIndex.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingMinMaxIndex.explain(input): ArrayLike; default: not declared - rollingMinMaxIndex.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinMaxIndex.explain(parameters).period: number; default: not declared - rollingMinMaxIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMinMaxIndex.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint | null; default: not declared - rollingMinMaxIndex.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMinMaxIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinMaxIndex.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint | null; default: not declared - rollingMinMaxIndex.fromJSON().return.value.maxIndex: number; default: not declared - rollingMinMaxIndex.fromJSON().return.value.minIndex: number; default: not declared - rollingMinMaxIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinMaxIndex.fromJSON(snapshot).kind: string; default: not declared - rollingMinMaxIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingMinMaxIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingMinMaxIndex.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingMinMaxIndex.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint | null; default: not declared - rollingMinMaxIndex.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingMinMaxIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingMinMaxIndex.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MinMaxIndexPoint | null; default: not declared - rollingMinMaxIndex.stream().return.value.maxIndex: number; default: not declared - rollingMinMaxIndex.stream().return.value.minIndex: number; default: not declared - rollingMinMaxIndex.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingMinMaxIndex.stream(parameters).period: number; default: not declared - rollingQuantile: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling quantile (linear interpolation). - rollingQuantile(input): ArrayLike; default: not declared - rollingQuantile(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').QuantileParameters | undefined; default: not declared - rollingQuantile(parameters).period?: number; default: not declared - rollingQuantile(parameters).quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). - rollingQuantile.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').QuantileParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingQuantile.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingQuantile.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingQuantile.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingQuantile.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingQuantile.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingQuantile.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingQuantile.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingQuantile.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingQuantile.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingQuantile.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingQuantile.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingQuantile.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingQuantile.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingQuantile.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingQuantile.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingQuantile.explain(input): ArrayLike; default: not declared - rollingQuantile.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').QuantileParameters | undefined; default: not declared - rollingQuantile.explain(parameters).period?: number; default: not declared - rollingQuantile.explain(parameters).quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). - rollingQuantile.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingQuantile.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingQuantile.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingQuantile.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingQuantile.fromJSON().return.value: number | null; default: not declared - rollingQuantile.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingQuantile.fromJSON(snapshot).kind: string; default: not declared - rollingQuantile.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingQuantile.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingQuantile.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').QuantileParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingQuantile.stream().return.next: (input: number) => number | null; default: not declared - rollingQuantile.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingQuantile.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingQuantile.stream().return.value: number | null; default: not declared - rollingQuantile.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').QuantileParameters | undefined; default: not declared - rollingQuantile.stream(parameters).period?: number; default: not declared - rollingQuantile.stream(parameters).quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). - rollingRank: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling 1-based ordinal rank of the current value within the window. - rollingRank(input): ArrayLike; default: not declared - rollingRank(parameters)?: { period?: number; } | undefined; default: not declared - rollingRank(parameters).period?: number; default: not declared - rollingRank.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingRank.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingRank.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingRank.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingRank.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingRank.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingRank.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingRank.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingRank.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingRank.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingRank.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingRank.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingRank.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingRank.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingRank.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingRank.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingRank.explain(input): ArrayLike; default: not declared - rollingRank.explain(parameters)?: { period?: number; } | undefined; default: not declared - rollingRank.explain(parameters).period?: number; default: not declared - rollingRank.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingRank.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingRank.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingRank.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingRank.fromJSON().return.value: number | null; default: not declared - rollingRank.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingRank.fromJSON(snapshot).kind: string; default: not declared - rollingRank.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingRank.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingRank.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingRank.stream().return.next: (input: number) => number | null; default: not declared - rollingRank.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingRank.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingRank.stream().return.value: number | null; default: not declared - rollingRank.stream(parameters)?: { period?: number; } | undefined; default: not declared - rollingRank.stream(parameters).period?: number; default: not declared - rollingRegression: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').Pair, import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint>; default: not declared — Rolling ordinary-least-squares regression of y on x: `{ slope, intercept, rSquared }`. - rollingRegression(input): ArrayLike; default: not declared - rollingRegression(parameters)?: { period?: number; } | undefined; default: not declared - rollingRegression(parameters).period?: number; default: not declared - rollingRegression.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingRegression.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingRegression.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingRegression.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingRegression.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingRegression.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingRegression.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingRegression.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingRegression.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingRegression.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingRegression.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingRegression.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingRegression.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingRegression.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingRegression.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingRegression.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingRegression.explain(input): ArrayLike; default: not declared - rollingRegression.explain(parameters)?: { period?: number; } | undefined; default: not declared - rollingRegression.explain(parameters).period?: number; default: not declared - rollingRegression.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingRegression.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint | null; default: not declared - rollingRegression.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingRegression.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingRegression.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint | null; default: not declared - rollingRegression.fromJSON().return.value.intercept: number; default: not declared - rollingRegression.fromJSON().return.value.rSquared: number; default: not declared — Coefficient of determination. - rollingRegression.fromJSON().return.value.slope: number; default: not declared — OLS slope of y on x. - rollingRegression.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingRegression.fromJSON(snapshot).kind: string; default: not declared - rollingRegression.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingRegression.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingRegression.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingRegression.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint | null; default: not declared - rollingRegression.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingRegression.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingRegression.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').RegressionPoint | null; default: not declared - rollingRegression.stream().return.value.intercept: number; default: not declared - rollingRegression.stream().return.value.rSquared: number; default: not declared — Coefficient of determination. - rollingRegression.stream().return.value.slope: number; default: not declared — OLS slope of y on x. - rollingRegression.stream(parameters)?: { period?: number; } | undefined; default: not declared - rollingRegression.stream(parameters).period?: number; default: not declared - rollingSum: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingSum(input): ArrayLike; default: not declared - rollingSum(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingSum(parameters).period: number; default: not declared - rollingSum.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingSum.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingSum.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingSum.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingSum.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingSum.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingSum.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingSum.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingSum.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingSum.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingSum.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingSum.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingSum.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingSum.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingSum.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingSum.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingSum.explain(input): ArrayLike; default: not declared - rollingSum.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingSum.explain(parameters).period: number; default: not declared - rollingSum.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingSum.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingSum.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingSum.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingSum.fromJSON().return.value: number | null; default: not declared - rollingSum.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingSum.fromJSON(snapshot).kind: string; default: not declared - rollingSum.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingSum.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingSum.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingSum.stream().return.next: (input: number) => number | null; default: not declared - rollingSum.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingSum.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingSum.stream().return.value: number | null; default: not declared - rollingSum.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - rollingSum.stream(parameters).period: number; default: not declared - rollingVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingVolatility(input): ArrayLike; default: not declared - rollingVolatility(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters | undefined; default: not declared - rollingVolatility(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - rollingVolatility(parameters).period: number; default: not declared - rollingVolatility.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingVolatility.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingVolatility.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingVolatility.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingVolatility.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingVolatility.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingVolatility.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingVolatility.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingVolatility.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingVolatility.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingVolatility.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingVolatility.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingVolatility.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingVolatility.explain(input): ArrayLike; default: not declared - rollingVolatility.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters | undefined; default: not declared - rollingVolatility.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - rollingVolatility.explain(parameters).period: number; default: not declared - rollingVolatility.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingVolatility.fromJSON().return.next: (input: number) => number | null; default: not declared - rollingVolatility.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingVolatility.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingVolatility.fromJSON().return.value: number | null; default: not declared - rollingVolatility.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingVolatility.fromJSON(snapshot).kind: string; default: not declared - rollingVolatility.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingVolatility.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingVolatility.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingVolatility.stream().return.next: (input: number) => number | null; default: not declared - rollingVolatility.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingVolatility.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingVolatility.stream().return.value: number | null; default: not declared - rollingVolatility.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RollingVolatilityParameters | undefined; default: not declared - rollingVolatility.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - rollingVolatility.stream(parameters).period: number; default: not declared - rollingVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - rollingVwap(input): ArrayLike; default: not declared - rollingVwap(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rollingVwap(parameters).period: number; default: not declared - rollingVwap.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rollingVwap.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rollingVwap.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rollingVwap.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rollingVwap.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rollingVwap.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rollingVwap.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rollingVwap.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rollingVwap.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rollingVwap.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rollingVwap.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rollingVwap.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rollingVwap.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rollingVwap.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rollingVwap.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rollingVwap.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rollingVwap.explain(input): ArrayLike; default: not declared - rollingVwap.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rollingVwap.explain(parameters).period: number; default: not declared - rollingVwap.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingVwap.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - rollingVwap.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingVwap.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingVwap.fromJSON().return.value: number | null; default: not declared - rollingVwap.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingVwap.fromJSON(snapshot).kind: string; default: not declared - rollingVwap.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rollingVwap.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rollingVwap.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rollingVwap.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - rollingVwap.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rollingVwap.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rollingVwap.stream().return.value: number | null; default: not declared - rollingVwap.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - rollingVwap.stream(parameters).period: number; default: not declared - rsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Wilder's RSI (period 14 default, disclosed via `.explain()`). Flat-series convention: when the average loss over the window is zero (a flat or monotonically rising series), TotalFinance returns **100** (the RS → ∞ limit; TradingView's convention). TA-Lib emits 0 there and pandas-ta NaN — see `docs/compatibility/talib-differences.md`. - rsi(input): ArrayLike; default: not declared - rsi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters | undefined; default: not declared - rsi(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - rsi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rsi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rsi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rsi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rsi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rsi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rsi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rsi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rsi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rsi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rsi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rsi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rsi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rsi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rsi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rsi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rsi.explain(input): ArrayLike; default: not declared - rsi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters | undefined; default: not declared - rsi.explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - rsi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rsi.fromJSON().return.next: (input: number) => number | null; default: not declared - rsi.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rsi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rsi.fromJSON().return.value: number | null; default: not declared - rsi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rsi.fromJSON(snapshot).kind: string; default: not declared - rsi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rsi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rsi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rsi.stream().return.next: (input: number) => number | null; default: not declared - rsi.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rsi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rsi.stream().return.value: number | null; default: not declared - rsi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters | undefined; default: not declared - rsi.stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - rsx: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - rsx(input): ArrayLike; default: not declared - rsx(parameters)?: { period?: number; } | undefined; default: not declared - rsx(parameters).period?: number; default: not declared - rsx.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - rsx.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - rsx.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - rsx.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - rsx.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - rsx.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - rsx.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - rsx.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - rsx.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - rsx.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rsx.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - rsx.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - rsx.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - rsx.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rsx.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rsx.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rsx.explain(input): ArrayLike; default: not declared - rsx.explain(parameters)?: { period?: number; } | undefined; default: not declared - rsx.explain(parameters).period?: number; default: not declared - rsx.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rsx.fromJSON().return.next: (input: number) => number | null; default: not declared - rsx.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rsx.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rsx.fromJSON().return.value: number | null; default: not declared - rsx.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rsx.fromJSON(snapshot).kind: string; default: not declared - rsx.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - rsx.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - rsx.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - rsx.stream().return.next: (input: number) => number | null; default: not declared - rsx.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - rsx.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - rsx.stream().return.value: number | null; default: not declared - rsx.stream(parameters)?: { period?: number; } | undefined; default: not declared - rsx.stream(parameters).period?: number; default: not declared - runBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Tick run bars — close on the larger one-sided tick run. - runBars(bars): ArrayLike; default: not declared - runBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - runBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - runBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - schaffTrendCycle: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - schaffTrendCycle(input): ArrayLike; default: not declared - schaffTrendCycle(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StcParameters | undefined; default: not declared - schaffTrendCycle(parameters).cycle?: number; default: not declared - schaffTrendCycle(parameters).fast?: number; default: not declared - schaffTrendCycle(parameters).slow?: number; default: not declared - schaffTrendCycle.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StcParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - schaffTrendCycle.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - schaffTrendCycle.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - schaffTrendCycle.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - schaffTrendCycle.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - schaffTrendCycle.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - schaffTrendCycle.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - schaffTrendCycle.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - schaffTrendCycle.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - schaffTrendCycle.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - schaffTrendCycle.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - schaffTrendCycle.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - schaffTrendCycle.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - schaffTrendCycle.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - schaffTrendCycle.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - schaffTrendCycle.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - schaffTrendCycle.explain(input): ArrayLike; default: not declared - schaffTrendCycle.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StcParameters | undefined; default: not declared - schaffTrendCycle.explain(parameters).cycle?: number; default: not declared - schaffTrendCycle.explain(parameters).fast?: number; default: not declared - schaffTrendCycle.explain(parameters).slow?: number; default: not declared - schaffTrendCycle.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - schaffTrendCycle.fromJSON().return.next: (input: number) => number | null; default: not declared - schaffTrendCycle.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - schaffTrendCycle.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - schaffTrendCycle.fromJSON().return.value: number | null; default: not declared - schaffTrendCycle.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - schaffTrendCycle.fromJSON(snapshot).kind: string; default: not declared - schaffTrendCycle.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - schaffTrendCycle.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - schaffTrendCycle.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StcParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - schaffTrendCycle.stream().return.next: (input: number) => number | null; default: not declared - schaffTrendCycle.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - schaffTrendCycle.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - schaffTrendCycle.stream().return.value: number | null; default: not declared - schaffTrendCycle.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StcParameters | undefined; default: not declared - schaffTrendCycle.stream(parameters).cycle?: number; default: not declared - schaffTrendCycle.stream(parameters).fast?: number; default: not declared - schaffTrendCycle.stream(parameters).slow?: number; default: not declared - searchIndicators: (options?: import('@insiderfinance/totalfinance/technical-analysis').SearchIndicatorsOptions) => import('@insiderfinance/totalfinance/technical-analysis').SearchIndicatorsResult; default: not declared — Filter the registry by a name/alias search and category, then paginate — the token-lean alternative to pulling all ~335 indicators. `query` matches the canonical name or any TA-Lib/pandas/TradingView alias. `match: 'auto'` (default) uses exact/substring hits when any exist and falls back to a deterministic Damerau–Levenshtein fuzzy match only when they do not; queried rows carry inspectable `match` evidence. See `docs/specs/wave6-quant-moats.md` §4. - searchIndicators().return.indicators: import('@insiderfinance/totalfinance/technical-analysis').IndicatorRow[]; default: not declared - searchIndicators().return.limit: number | null; default: not declared — The applied page size (`null` = unbounded). - searchIndicators().return.offset: number; default: not declared - searchIndicators().return.total: number; default: not declared — Matches before pagination. - searchIndicators(options)?: import('@insiderfinance/totalfinance/technical-analysis').SearchIndicatorsOptions; default: not declared - searchIndicators(options).category?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - searchIndicators(options).limit?: number; default: not declared — Non-negative safe-integer page size; omit for all matches. - searchIndicators(options).match?: import('@insiderfinance/totalfinance/technical-analysis').SearchMatchMode; default: not declared — Match mode (default `'auto'`). Only meaningful with a `query`. - searchIndicators(options).minScore?: number; default: not declared — Minimum fuzzy similarity in `[0, 1]` (default `0.7`). Only used for fuzzy matching, needs a `query`. - searchIndicators(options).offset?: number; default: not declared — Non-negative safe-integer page offset; default 0. - searchIndicators(options).query?: string; default: not declared — Case-insensitive substring/fuzzy match of the canonical name OR any alias. - sessionRanges: (bars: ArrayLike, sessionIds: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').SessionRange[]; default: not declared — Aggregate bars into per-session OHLCV + range. `sessionIds[i]` is the session a bar belongs to (bars carry no timestamp, so the caller supplies the grouping). Sessions appear in first-seen order. - sessionRanges(bars): ArrayLike; default: not declared - sessionRanges(sessionIds): ArrayLike; default: not declared - sessionVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - sessionVwap(input): ArrayLike; default: not declared - sessionVwap(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SessionVwapParameters | undefined; default: not declared - sessionVwap(parameters).resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). - sessionVwap.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SessionVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sessionVwap.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sessionVwap.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sessionVwap.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sessionVwap.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sessionVwap.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sessionVwap.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sessionVwap.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sessionVwap.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sessionVwap.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sessionVwap.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sessionVwap.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sessionVwap.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sessionVwap.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sessionVwap.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sessionVwap.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sessionVwap.explain(input): ArrayLike; default: not declared - sessionVwap.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SessionVwapParameters | undefined; default: not declared - sessionVwap.explain(parameters).resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). - sessionVwap.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sessionVwap.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - sessionVwap.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sessionVwap.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sessionVwap.fromJSON().return.value: number | null; default: not declared - sessionVwap.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sessionVwap.fromJSON(snapshot).kind: string; default: not declared - sessionVwap.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sessionVwap.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sessionVwap.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SessionVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sessionVwap.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - sessionVwap.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sessionVwap.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sessionVwap.stream().return.value: number | null; default: not declared - sessionVwap.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SessionVwapParameters | undefined; default: not declared - sessionVwap.stream(parameters).resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). - shift: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Lag a series by `period` bars: `output[i] = input[i − period]`. - shift(input): ArrayLike; default: not declared - shift(parameters)?: { period?: number; } | undefined; default: not declared - shift(parameters).period?: number; default: not declared - shift.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - shift.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - shift.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - shift.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - shift.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - shift.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - shift.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - shift.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - shift.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - shift.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - shift.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - shift.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - shift.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - shift.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - shift.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - shift.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - shift.explain(input): ArrayLike; default: not declared - shift.explain(parameters)?: { period?: number; } | undefined; default: not declared - shift.explain(parameters).period?: number; default: not declared - shift.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - shift.fromJSON().return.next: (input: number) => number | null; default: not declared - shift.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - shift.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - shift.fromJSON().return.value: number | null; default: not declared - shift.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - shift.fromJSON(snapshot).kind: string; default: not declared - shift.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - shift.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - shift.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - shift.stream().return.next: (input: number) => number | null; default: not declared - shift.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - shift.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - shift.stream().return.value: number | null; default: not declared - shift.stream(parameters)?: { period?: number; } | undefined; default: not declared - shift.stream(parameters).period?: number; default: not declared - shortRun: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared — 1 when fast (`x`) and slow (`y`) are both falling over the lookback — a confirmed down-run. - shortRun(input): ArrayLike; default: not declared - shortRun(parameters)?: { period?: number; } | undefined; default: not declared - shortRun(parameters).period?: number; default: not declared - shortRun.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - shortRun.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - shortRun.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - shortRun.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - shortRun.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - shortRun.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - shortRun.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - shortRun.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - shortRun.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - shortRun.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - shortRun.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - shortRun.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - shortRun.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - shortRun.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - shortRun.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - shortRun.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - shortRun.explain(input): ArrayLike; default: not declared - shortRun.explain(parameters)?: { period?: number; } | undefined; default: not declared - shortRun.explain(parameters).period?: number; default: not declared - shortRun.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - shortRun.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - shortRun.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - shortRun.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - shortRun.fromJSON().return.value: number | null; default: not declared - shortRun.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - shortRun.fromJSON(snapshot).kind: string; default: not declared - shortRun.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - shortRun.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - shortRun.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - shortRun.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - shortRun.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - shortRun.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - shortRun.stream().return.value: number | null; default: not declared - shortRun.stream(parameters)?: { period?: number; } | undefined; default: not declared - shortRun.stream(parameters).period?: number; default: not declared - signal: (candles: import('@insiderfinance/totalfinance/technical-analysis').BarInput[]) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - signal().return.addRule: (rule: import('@insiderfinance/totalfinance/technical-analysis').Rule) => void; default: not declared - signal().return.atr: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WilderPeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - signal().return.columns: () => Record; default: not declared — The underlying feature columns (for inspection / charting). - signal().return.ema: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - signal().return.events: () => import('@insiderfinance/totalfinance/technical-analysis').SignalEvent[]; default: not declared — Only the bars that emitted, as `{ index, label }` events. - signal().return.feature: (alias: string, values: unknown[]) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Inject a precomputed column. - signal().return.rsi: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RsiParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — `parameters` is optional on the default-bearing methods, matching both `FeaturePipeline` and the direct call: `rsi(closes)` resolves period 14, so `signal(bars).rsi('close')` must too. These two were left required when the pipeline's were relaxed, so the two fluent surfaces disagreed — the delegate compiled and the caller's identical call did not. - signal().return.signals: () => (string | null)[]; default: not declared — Aligned labels: the first matching rule's label per bar, else `null`. - signal().return.sma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - signal().return.use: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: Required) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Apply any series indicator to a field under an alias. `options.as` is REQUIRED here: the generic escape hatch has no indicator-specific auto-name to fall back on. - signal().return.useBars: (indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator, parameters: P, options: Required) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared — Apply any bar indicator to the candles under an alias. `options.as` is required (see {@link use}). - signal().return.when: (condition: import('@insiderfinance/totalfinance/technical-analysis').Condition) => import('@insiderfinance/totalfinance/technical-analysis').RuleBuilder; default: not declared - signal().return.wma: (field: import('@insiderfinance/totalfinance/technical-analysis').Field, parameters: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters, options?: AliasOpt) => import('@insiderfinance/totalfinance/technical-analysis').SignalBuilder; default: not declared - signal(candles): import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - sin: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - sin(input): ArrayLike; default: not declared - sin(parameters)?: {} | undefined; default: not declared - sin.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sin.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sin.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sin.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sin.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sin.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sin.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sin.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sin.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sin.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sin.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sin.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sin.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sin.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sin.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sin.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sin.explain(input): ArrayLike; default: not declared - sin.explain(parameters)?: {} | undefined; default: not declared - sin.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sin.fromJSON().return.next: (input: number) => number | null; default: not declared - sin.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sin.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sin.fromJSON().return.value: number | null; default: not declared - sin.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sin.fromJSON(snapshot).kind: string; default: not declared - sin.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sin.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sin.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sin.stream().return.next: (input: number) => number | null; default: not declared - sin.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sin.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sin.stream().return.value: number | null; default: not declared - sin.stream(parameters)?: {} | undefined; default: not declared - sineWma: import('@insiderfinance/totalfinance/technical-analysis').Indicator<({ period: number; }), number, number>; default: not declared - sineWma(input): ArrayLike; default: not declared - sineWma(parameters)?: ({ period: number; }) | undefined; default: not declared - sineWma(parameters).period: number; default: not declared - sineWma.explain: (input: ArrayLike, parameters?: ({ period: number; }) | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sineWma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sineWma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sineWma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sineWma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sineWma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sineWma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sineWma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sineWma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sineWma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sineWma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sineWma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sineWma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sineWma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sineWma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sineWma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sineWma.explain(input): ArrayLike; default: not declared - sineWma.explain(parameters)?: ({ period: number; }) | undefined; default: not declared - sineWma.explain(parameters).period: number; default: not declared - sineWma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sineWma.fromJSON().return.next: (input: number) => number | null; default: not declared - sineWma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sineWma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sineWma.fromJSON().return.value: number | null; default: not declared - sineWma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sineWma.fromJSON(snapshot).kind: string; default: not declared - sineWma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sineWma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sineWma.stream: (parameters?: ({ period: number; }) | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sineWma.stream().return.next: (input: number) => number | null; default: not declared - sineWma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sineWma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sineWma.stream().return.value: number | null; default: not declared - sineWma.stream(parameters)?: ({ period: number; }) | undefined; default: not declared - sineWma.stream(parameters).period: number; default: not declared - sinh: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - sinh(input): ArrayLike; default: not declared - sinh(parameters)?: {} | undefined; default: not declared - sinh.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sinh.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sinh.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sinh.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sinh.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sinh.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sinh.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sinh.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sinh.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sinh.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sinh.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sinh.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sinh.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sinh.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sinh.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sinh.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sinh.explain(input): ArrayLike; default: not declared - sinh.explain(parameters)?: {} | undefined; default: not declared - sinh.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sinh.fromJSON().return.next: (input: number) => number | null; default: not declared - sinh.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sinh.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sinh.fromJSON().return.value: number | null; default: not declared - sinh.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sinh.fromJSON(snapshot).kind: string; default: not declared - sinh.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sinh.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sinh.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sinh.stream().return.next: (input: number) => number | null; default: not declared - sinh.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sinh.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sinh.stream().return.value: number | null; default: not declared - sinh.stream(parameters)?: {} | undefined; default: not declared - skew: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling sample skewness (bias-corrected Fisher-Pearson G1). - skew(input): ArrayLike; default: not declared - skew(parameters)?: { period?: number; } | undefined; default: not declared - skew(parameters).period?: number; default: not declared - skew.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - skew.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - skew.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - skew.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - skew.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - skew.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - skew.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - skew.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - skew.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - skew.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - skew.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - skew.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - skew.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - skew.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - skew.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - skew.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - skew.explain(input): ArrayLike; default: not declared - skew.explain(parameters)?: { period?: number; } | undefined; default: not declared - skew.explain(parameters).period?: number; default: not declared - skew.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - skew.fromJSON().return.next: (input: number) => number | null; default: not declared - skew.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - skew.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - skew.fromJSON().return.value: number | null; default: not declared - skew.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - skew.fromJSON(snapshot).kind: string; default: not declared - skew.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - skew.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - skew.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - skew.stream().return.next: (input: number) => number | null; default: not declared - skew.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - skew.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - skew.stream().return.value: number | null; default: not declared - skew.stream(parameters)?: { period?: number; } | undefined; default: not declared - skew.stream(parameters).period?: number; default: not declared - slope: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared - slope(input): ArrayLike; default: not declared - slope(parameters)?: { period?: number; } | undefined; default: not declared - slope(parameters).period?: number; default: not declared - slope.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - slope.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - slope.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - slope.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - slope.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - slope.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - slope.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - slope.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - slope.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - slope.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - slope.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - slope.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - slope.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - slope.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - slope.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - slope.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - slope.explain(input): ArrayLike; default: not declared - slope.explain(parameters)?: { period?: number; } | undefined; default: not declared - slope.explain(parameters).period?: number; default: not declared - slope.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - slope.fromJSON().return.next: (input: number) => number | null; default: not declared - slope.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - slope.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - slope.fromJSON().return.value: number | null; default: not declared - slope.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - slope.fromJSON(snapshot).kind: string; default: not declared - slope.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - slope.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - slope.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - slope.stream().return.next: (input: number) => number | null; default: not declared - slope.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - slope.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - slope.stream().return.value: number | null; default: not declared - slope.stream(parameters)?: { period?: number; } | undefined; default: not declared - slope.stream(parameters).period?: number; default: not declared - sma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - sma(input): ArrayLike; default: not declared - sma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - sma(parameters).period: number; default: not declared - sma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sma.explain(input): ArrayLike; default: not declared - sma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - sma.explain(parameters).period: number; default: not declared - sma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sma.fromJSON().return.next: (input: number) => number | null; default: not declared - sma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sma.fromJSON().return.value: number | null; default: not declared - sma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sma.fromJSON(snapshot).kind: string; default: not declared - sma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sma.stream().return.next: (input: number) => number | null; default: not declared - sma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sma.stream().return.value: number | null; default: not declared - sma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - sma.stream(parameters).period: number; default: not declared - smcSweep: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — pandas-ta `smc_sweep`: +1 bullish low sweep, -1 bearish high sweep, 0 none. - smcSweep(input): ArrayLike; default: not declared - smcSweep(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SmcSweepParameters | undefined; default: not declared - smcSweep(parameters).period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - smcSweep(parameters).wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. - smcSweep.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SmcSweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - smcSweep.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - smcSweep.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - smcSweep.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - smcSweep.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - smcSweep.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - smcSweep.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - smcSweep.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - smcSweep.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - smcSweep.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - smcSweep.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - smcSweep.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - smcSweep.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - smcSweep.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - smcSweep.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - smcSweep.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - smcSweep.explain(input): ArrayLike; default: not declared - smcSweep.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SmcSweepParameters | undefined; default: not declared - smcSweep.explain(parameters).period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - smcSweep.explain(parameters).wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. - smcSweep.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - smcSweep.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - smcSweep.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - smcSweep.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - smcSweep.fromJSON().return.value: number | null; default: not declared - smcSweep.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - smcSweep.fromJSON(snapshot).kind: string; default: not declared - smcSweep.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - smcSweep.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - smcSweep.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SmcSweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - smcSweep.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - smcSweep.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - smcSweep.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - smcSweep.stream().return.value: number | null; default: not declared - smcSweep.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SmcSweepParameters | undefined; default: not declared - smcSweep.stream(parameters).period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - smcSweep.stream(parameters).wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. - smiErgodic: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - smiErgodic(input): ArrayLike; default: not declared - smiErgodic(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SmiParameters | undefined; default: not declared - smiErgodic(parameters).long?: number; default: not declared - smiErgodic(parameters).short?: number; default: not declared - smiErgodic(parameters).signal?: number; default: not declared - smiErgodic.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SmiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - smiErgodic.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - smiErgodic.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - smiErgodic.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - smiErgodic.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - smiErgodic.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - smiErgodic.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - smiErgodic.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - smiErgodic.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - smiErgodic.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - smiErgodic.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - smiErgodic.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - smiErgodic.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - smiErgodic.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - smiErgodic.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - smiErgodic.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').SmiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - smiErgodic.explain(input): ArrayLike; default: not declared - smiErgodic.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SmiParameters | undefined; default: not declared - smiErgodic.explain(parameters).long?: number; default: not declared - smiErgodic.explain(parameters).short?: number; default: not declared - smiErgodic.explain(parameters).signal?: number; default: not declared - smiErgodic.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - smiErgodic.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SmiPoint | null; default: not declared - smiErgodic.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - smiErgodic.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - smiErgodic.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').SmiPoint | null; default: not declared - smiErgodic.fromJSON().return.value.oscillator: number; default: not declared - smiErgodic.fromJSON().return.value.signal: number; default: not declared - smiErgodic.fromJSON().return.value.smi: number; default: not declared - smiErgodic.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - smiErgodic.fromJSON(snapshot).kind: string; default: not declared - smiErgodic.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - smiErgodic.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - smiErgodic.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SmiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - smiErgodic.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SmiPoint | null; default: not declared - smiErgodic.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').SmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - smiErgodic.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - smiErgodic.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').SmiPoint | null; default: not declared - smiErgodic.stream().return.value.oscillator: number; default: not declared - smiErgodic.stream().return.value.signal: number; default: not declared - smiErgodic.stream().return.value.smi: number; default: not declared - smiErgodic.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SmiParameters | undefined; default: not declared - smiErgodic.stream(parameters).long?: number; default: not declared - smiErgodic.stream(parameters).short?: number; default: not declared - smiErgodic.stream(parameters).signal?: number; default: not declared - snapshotOf: (kind: string, state: Record) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared — Stamp indicator state into the public envelope. Every `toJSON` goes through here. This is also where the state becomes JSON-SAFE: after `snapshotOf`, no number in the tree is non-finite, so `JSON.stringify` is lossless and any raw `NaN` a reader later encounters can only have come from damage — which is what lets {@link SnapshotState} refuse it. `kind` is guarded because the natural wrong call is `snapshotOf(stream)` — reaching for the serializer as if it took the thing to serialize. That produced an envelope whose `kind` was a live stream object and whose `state` was `undefined`: it survives `JSON.stringify` (as `{}`) and only fails much later, at a `fromJSON` that cannot say why. - snapshotOf().return.kind: string; default: not declared - snapshotOf().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - snapshotOf().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - snapshotOf(kind): string; default: not declared - snapshotOf(state): Record; default: not declared - sqrt: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - sqrt(input): ArrayLike; default: not declared - sqrt(parameters)?: {} | undefined; default: not declared - sqrt.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sqrt.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sqrt.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sqrt.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sqrt.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sqrt.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sqrt.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sqrt.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sqrt.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sqrt.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sqrt.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sqrt.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sqrt.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sqrt.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sqrt.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sqrt.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sqrt.explain(input): ArrayLike; default: not declared - sqrt.explain(parameters)?: {} | undefined; default: not declared - sqrt.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sqrt.fromJSON().return.next: (input: number) => number | null; default: not declared - sqrt.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sqrt.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sqrt.fromJSON().return.value: number | null; default: not declared - sqrt.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sqrt.fromJSON(snapshot).kind: string; default: not declared - sqrt.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sqrt.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sqrt.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sqrt.stream().return.next: (input: number) => number | null; default: not declared - sqrt.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sqrt.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sqrt.stream().return.value: number | null; default: not declared - sqrt.stream(parameters)?: {} | undefined; default: not declared - squeeze: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - squeeze(input): ArrayLike; default: not declared - squeeze(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeParameters | undefined; default: not declared - squeeze(parameters).bollingerBandPeriod?: number; default: not declared - squeeze(parameters).bollingerStandardDeviations?: number; default: not declared - squeeze(parameters).keltnerChannelMultiplier?: number; default: not declared - squeeze(parameters).keltnerChannelPeriod?: number; default: not declared - squeeze.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - squeeze.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - squeeze.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - squeeze.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - squeeze.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - squeeze.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - squeeze.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - squeeze.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - squeeze.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - squeeze.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - squeeze.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - squeeze.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - squeeze.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - squeeze.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - squeeze.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - squeeze.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - squeeze.explain(input): ArrayLike; default: not declared - squeeze.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeParameters | undefined; default: not declared - squeeze.explain(parameters).bollingerBandPeriod?: number; default: not declared - squeeze.explain(parameters).bollingerStandardDeviations?: number; default: not declared - squeeze.explain(parameters).keltnerChannelMultiplier?: number; default: not declared - squeeze.explain(parameters).keltnerChannelPeriod?: number; default: not declared - squeeze.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - squeeze.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint | null; default: not declared - squeeze.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - squeeze.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - squeeze.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint | null; default: not declared - squeeze.fromJSON().return.value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - squeeze.fromJSON().return.value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - squeeze.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - squeeze.fromJSON(snapshot).kind: string; default: not declared - squeeze.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - squeeze.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - squeeze.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - squeeze.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint | null; default: not declared - squeeze.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - squeeze.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - squeeze.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').SqueezePoint | null; default: not declared - squeeze.stream().return.value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - squeeze.stream().return.value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - squeeze.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeParameters | undefined; default: not declared - squeeze.stream(parameters).bollingerBandPeriod?: number; default: not declared - squeeze.stream(parameters).bollingerStandardDeviations?: number; default: not declared - squeeze.stream(parameters).keltnerChannelMultiplier?: number; default: not declared - squeeze.stream(parameters).keltnerChannelPeriod?: number; default: not declared - squeezePro: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - squeezePro(input): ArrayLike; default: not declared - squeezePro(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProParameters | undefined; default: not declared - squeezePro(parameters).bollingerBandPeriod?: number; default: not declared - squeezePro(parameters).bollingerStandardDeviations?: number; default: not declared - squeezePro(parameters).keltnerChannelPeriod?: number; default: not declared - squeezePro(parameters).narrowKeltnerChannelMultiplier?: number; default: not declared - squeezePro(parameters).normalKeltnerChannelMultiplier?: number; default: not declared - squeezePro(parameters).wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. - squeezePro.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - squeezePro.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - squeezePro.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - squeezePro.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - squeezePro.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - squeezePro.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - squeezePro.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - squeezePro.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - squeezePro.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - squeezePro.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - squeezePro.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - squeezePro.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - squeezePro.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - squeezePro.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - squeezePro.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - squeezePro.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - squeezePro.explain(input): ArrayLike; default: not declared - squeezePro.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProParameters | undefined; default: not declared - squeezePro.explain(parameters).bollingerBandPeriod?: number; default: not declared - squeezePro.explain(parameters).bollingerStandardDeviations?: number; default: not declared - squeezePro.explain(parameters).keltnerChannelPeriod?: number; default: not declared - squeezePro.explain(parameters).narrowKeltnerChannelMultiplier?: number; default: not declared - squeezePro.explain(parameters).normalKeltnerChannelMultiplier?: number; default: not declared - squeezePro.explain(parameters).wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. - squeezePro.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - squeezePro.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint | null; default: not declared - squeezePro.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - squeezePro.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - squeezePro.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint | null; default: not declared - squeezePro.fromJSON().return.value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - squeezePro.fromJSON().return.value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - squeezePro.fromJSON().return.value.momentum: number; default: not declared - squeezePro.fromJSON().return.value.normalCompression: number; default: not declared — Normal compression. - squeezePro.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - squeezePro.fromJSON(snapshot).kind: string; default: not declared - squeezePro.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - squeezePro.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - squeezePro.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - squeezePro.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint | null; default: not declared - squeezePro.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - squeezePro.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - squeezePro.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProPoint | null; default: not declared - squeezePro.stream().return.value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - squeezePro.stream().return.value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - squeezePro.stream().return.value.momentum: number; default: not declared - squeezePro.stream().return.value.normalCompression: number; default: not declared — Normal compression. - squeezePro.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SqueezeProParameters | undefined; default: not declared - squeezePro.stream(parameters).bollingerBandPeriod?: number; default: not declared - squeezePro.stream(parameters).bollingerStandardDeviations?: number; default: not declared - squeezePro.stream(parameters).keltnerChannelPeriod?: number; default: not declared - squeezePro.stream(parameters).narrowKeltnerChannelMultiplier?: number; default: not declared - squeezePro.stream(parameters).normalKeltnerChannelMultiplier?: number; default: not declared - squeezePro.stream(parameters).wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. - standardDeviation: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - standardDeviation(input): ArrayLike; default: not declared - standardDeviation(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined; default: not declared - standardDeviation(parameters).period: number; default: not declared - standardDeviation(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - standardDeviation.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - standardDeviation.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - standardDeviation.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - standardDeviation.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - standardDeviation.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - standardDeviation.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - standardDeviation.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - standardDeviation.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - standardDeviation.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - standardDeviation.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - standardDeviation.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - standardDeviation.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - standardDeviation.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - standardDeviation.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - standardDeviation.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - standardDeviation.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - standardDeviation.explain(input): ArrayLike; default: not declared - standardDeviation.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined; default: not declared - standardDeviation.explain(parameters).period: number; default: not declared - standardDeviation.explain(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - standardDeviation.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - standardDeviation.fromJSON().return.next: (input: number) => number | null; default: not declared - standardDeviation.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - standardDeviation.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - standardDeviation.fromJSON().return.value: number | null; default: not declared - standardDeviation.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - standardDeviation.fromJSON(snapshot).kind: string; default: not declared - standardDeviation.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - standardDeviation.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - standardDeviation.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - standardDeviation.stream().return.next: (input: number) => number | null; default: not declared - standardDeviation.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - standardDeviation.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - standardDeviation.stream().return.value: number | null; default: not declared - standardDeviation.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined; default: not declared - standardDeviation.stream(parameters).period: number; default: not declared - standardDeviation.stream(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - standardError: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling standard error of the mean: sampleStd / √n. - standardError(input): ArrayLike; default: not declared - standardError(parameters)?: { period?: number; } | undefined; default: not declared - standardError(parameters).period?: number; default: not declared - standardError.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - standardError.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - standardError.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - standardError.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - standardError.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - standardError.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - standardError.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - standardError.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - standardError.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - standardError.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - standardError.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - standardError.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - standardError.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - standardError.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - standardError.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - standardError.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - standardError.explain(input): ArrayLike; default: not declared - standardError.explain(parameters)?: { period?: number; } | undefined; default: not declared - standardError.explain(parameters).period?: number; default: not declared - standardError.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - standardError.fromJSON().return.next: (input: number) => number | null; default: not declared - standardError.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - standardError.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - standardError.fromJSON().return.value: number | null; default: not declared - standardError.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - standardError.fromJSON(snapshot).kind: string; default: not declared - standardError.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - standardError.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - standardError.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - standardError.stream().return.next: (input: number) => number | null; default: not declared - standardError.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - standardError.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - standardError.stream().return.value: number | null; default: not declared - standardError.stream(parameters)?: { period?: number; } | undefined; default: not declared - standardError.stream(parameters).period?: number; default: not declared - stoch: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - stoch(input): ArrayLike; default: not declared - stoch(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stoch(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stoch(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stoch(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stoch.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - stoch.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - stoch.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - stoch.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - stoch.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - stoch.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - stoch.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - stoch.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - stoch.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - stoch.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - stoch.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - stoch.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - stoch.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - stoch.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - stoch.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - stoch.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - stoch.explain(input): ArrayLike; default: not declared - stoch.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stoch.explain(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stoch.explain(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stoch.explain(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stoch.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stoch.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stoch.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stoch.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stoch.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stoch.fromJSON().return.value.d: number; default: not declared - stoch.fromJSON().return.value.k: number; default: not declared - stoch.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stoch.fromJSON(snapshot).kind: string; default: not declared - stoch.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - stoch.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stoch.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stoch.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stoch.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stoch.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stoch.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stoch.stream().return.value.d: number; default: not declared - stoch.stream().return.value.k: number; default: not declared - stoch.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stoch.stream(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stoch.stream(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stoch.stream(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stochFast: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Alias of {@link stochastic}: with the default `smoothK: 1` the stochastic IS the fast stochastic (raw %K + SMA %D — TA-Lib STOCHF). One implementation, two registry names; pass `smoothK: 3` for the classic slow stochastic (TA-Lib STOCH's slowk). - stochFast(input): ArrayLike; default: not declared - stochFast(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stochFast(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stochFast(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stochFast(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stochFast.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - stochFast.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - stochFast.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - stochFast.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - stochFast.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - stochFast.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - stochFast.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - stochFast.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - stochFast.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - stochFast.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - stochFast.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - stochFast.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - stochFast.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - stochFast.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - stochFast.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - stochFast.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - stochFast.explain(input): ArrayLike; default: not declared - stochFast.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stochFast.explain(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stochFast.explain(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stochFast.explain(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stochFast.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stochFast.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochFast.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stochFast.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochFast.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochFast.fromJSON().return.value.d: number; default: not declared - stochFast.fromJSON().return.value.k: number; default: not declared - stochFast.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochFast.fromJSON(snapshot).kind: string; default: not declared - stochFast.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - stochFast.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stochFast.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stochFast.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochFast.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stochFast.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochFast.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochFast.stream().return.value.d: number; default: not declared - stochFast.stream().return.value.k: number; default: not declared - stochFast.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stochFast.stream(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stochFast.stream(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stochFast.stream(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stochRsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - stochRsi(input): ArrayLike; default: not declared - stochRsi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochRsiParameters | undefined; default: not declared - stochRsi(parameters).dPeriod?: number; default: not declared - stochRsi(parameters).kPeriod?: number; default: not declared - stochRsi(parameters).rsiPeriod?: number; default: not declared - stochRsi(parameters).stochPeriod?: number; default: not declared - stochRsi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - stochRsi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - stochRsi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - stochRsi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - stochRsi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - stochRsi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - stochRsi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - stochRsi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - stochRsi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - stochRsi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - stochRsi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - stochRsi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - stochRsi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - stochRsi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - stochRsi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - stochRsi.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - stochRsi.explain(input): ArrayLike; default: not declared - stochRsi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochRsiParameters | undefined; default: not declared - stochRsi.explain(parameters).dPeriod?: number; default: not declared - stochRsi.explain(parameters).kPeriod?: number; default: not declared - stochRsi.explain(parameters).rsiPeriod?: number; default: not declared - stochRsi.explain(parameters).stochPeriod?: number; default: not declared - stochRsi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stochRsi.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint | null; default: not declared - stochRsi.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stochRsi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochRsi.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint | null; default: not declared - stochRsi.fromJSON().return.value.d: number; default: not declared - stochRsi.fromJSON().return.value.k: number; default: not declared - stochRsi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochRsi.fromJSON(snapshot).kind: string; default: not declared - stochRsi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - stochRsi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stochRsi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stochRsi.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint | null; default: not declared - stochRsi.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stochRsi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochRsi.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochRsiPoint | null; default: not declared - stochRsi.stream().return.value.d: number; default: not declared - stochRsi.stream().return.value.k: number; default: not declared - stochRsi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochRsiParameters | undefined; default: not declared - stochRsi.stream(parameters).dPeriod?: number; default: not declared - stochRsi.stream(parameters).kPeriod?: number; default: not declared - stochRsi.stream(parameters).rsiPeriod?: number; default: not declared - stochRsi.stream(parameters).stochPeriod?: number; default: not declared - stochastic: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - stochastic(input): ArrayLike; default: not declared - stochastic(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stochastic(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stochastic(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stochastic(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stochastic.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - stochastic.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - stochastic.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - stochastic.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - stochastic.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - stochastic.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - stochastic.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - stochastic.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - stochastic.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - stochastic.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - stochastic.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - stochastic.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - stochastic.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - stochastic.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - stochastic.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - stochastic.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - stochastic.explain(input): ArrayLike; default: not declared - stochastic.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stochastic.explain(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stochastic.explain(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stochastic.explain(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - stochastic.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stochastic.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochastic.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stochastic.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochastic.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochastic.fromJSON().return.value.d: number; default: not declared - stochastic.fromJSON().return.value.k: number; default: not declared - stochastic.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochastic.fromJSON(snapshot).kind: string; default: not declared - stochastic.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - stochastic.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stochastic.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stochastic.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochastic.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stochastic.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - stochastic.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').StochasticPoint | null; default: not declared - stochastic.stream().return.value.d: number; default: not declared - stochastic.stream().return.value.k: number; default: not declared - stochastic.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StochasticParameters | undefined; default: not declared - stochastic.stream(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stochastic.stream(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stochastic.stream(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - streamAsync: (stream: import('@insiderfinance/totalfinance/technical-analysis').IndicatorStream, source: AsyncIterable) => AsyncGenerator; default: not declared — Feed a stream from an **async iterable** source (spec §13.2 streaming adapters), yielding each non-`null` (post-warmup) output as it is produced. Lets indicators consume live feeds — websockets, async DB cursors, generators — without buffering the whole series. Pure: it reads only what the source yields and never touches the clock. - streamAsync(source): AsyncIterable; default: not declared - streamAsync(stream): import('@insiderfinance/totalfinance/technical-analysis').IndicatorStream; default: not declared - streamAsync(stream).next: (input: In) => Out | null; default: not declared - streamAsync(stream).toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - streamAsync(stream).value: Out | null; default: not declared - sub: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').Pair, number>; default: not declared - sub(input): ArrayLike; default: not declared - sub(parameters)?: {} | undefined; default: not declared - sub.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - sub.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - sub.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - sub.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sub.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sub.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sub.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sub.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sub.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sub.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sub.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sub.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sub.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sub.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sub.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sub.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sub.explain(input): ArrayLike; default: not declared - sub.explain(parameters)?: {} | undefined; default: not declared - sub.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sub.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - sub.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sub.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sub.fromJSON().return.value: number | null; default: not declared - sub.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sub.fromJSON(snapshot).kind: string; default: not declared - sub.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - sub.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - sub.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - sub.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - sub.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - sub.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - sub.stream().return.value: number | null; default: not declared - sub.stream(parameters)?: {} | undefined; default: not declared - superSmoother: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - superSmoother(input): ArrayLike; default: not declared - superSmoother(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - superSmoother(parameters).period: number; default: not declared - superSmoother.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - superSmoother.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - superSmoother.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - superSmoother.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - superSmoother.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - superSmoother.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - superSmoother.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - superSmoother.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - superSmoother.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - superSmoother.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - superSmoother.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - superSmoother.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - superSmoother.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - superSmoother.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - superSmoother.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - superSmoother.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - superSmoother.explain(input): ArrayLike; default: not declared - superSmoother.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - superSmoother.explain(parameters).period: number; default: not declared - superSmoother.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - superSmoother.fromJSON().return.next: (input: number) => number | null; default: not declared - superSmoother.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - superSmoother.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - superSmoother.fromJSON().return.value: number | null; default: not declared - superSmoother.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - superSmoother.fromJSON(snapshot).kind: string; default: not declared - superSmoother.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - superSmoother.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - superSmoother.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - superSmoother.stream().return.next: (input: number) => number | null; default: not declared - superSmoother.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - superSmoother.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - superSmoother.stream().return.value: number | null; default: not declared - superSmoother.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - superSmoother.stream(parameters).period: number; default: not declared - supertrend: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - supertrend(input): ArrayLike; default: not declared - supertrend(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SupertrendParameters | undefined; default: not declared - supertrend(parameters).multiplier?: number; default: not declared - supertrend(parameters).period: number; default: not declared - supertrend.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SupertrendParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - supertrend.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - supertrend.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - supertrend.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - supertrend.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - supertrend.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - supertrend.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - supertrend.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - supertrend.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - supertrend.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - supertrend.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - supertrend.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - supertrend.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - supertrend.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - supertrend.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - supertrend.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - supertrend.explain(input): ArrayLike; default: not declared - supertrend.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SupertrendParameters | undefined; default: not declared - supertrend.explain(parameters).multiplier?: number; default: not declared - supertrend.explain(parameters).period: number; default: not declared - supertrend.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - supertrend.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint | null; default: not declared - supertrend.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - supertrend.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - supertrend.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint | null; default: not declared - supertrend.fromJSON().return.value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - supertrend.fromJSON().return.value.supertrend: number; default: not declared - supertrend.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - supertrend.fromJSON(snapshot).kind: string; default: not declared - supertrend.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - supertrend.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - supertrend.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SupertrendParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - supertrend.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint | null; default: not declared - supertrend.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - supertrend.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - supertrend.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').SupertrendPoint | null; default: not declared - supertrend.stream().return.value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - supertrend.stream().return.value.supertrend: number; default: not declared - supertrend.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SupertrendParameters | undefined; default: not declared - supertrend.stream(parameters).multiplier?: number; default: not declared - supertrend.stream(parameters).period: number; default: not declared - supportResistance: (bars: ArrayLike, options?: { strength?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').SupportResistance; default: not declared — Cluster swing highs into resistance levels and swing lows into support levels. - supportResistance().return.assumptions: { conventionsVersion: string; strength: number; tolerance: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - supportResistance().return.assumptions.conventionsVersion: string; default: not declared - supportResistance().return.assumptions.strength: number; default: not declared - supportResistance().return.assumptions.tolerance: number; default: not declared - supportResistance().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - supportResistance().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - supportResistance().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').SrLevel[]; default: not declared - supportResistance().return.support: import('@insiderfinance/totalfinance/technical-analysis').SrLevel[]; default: not declared - supportResistance(bars): ArrayLike; default: not declared - supportResistance(options)?: { strength?: number; tolerance?: number; }; default: not declared - supportResistance(options).strength?: number; default: not declared - supportResistance(options).tolerance?: number; default: not declared - swingTrailingStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Structure-based trailing stop: trails the most recent confirmed swing low (long) / high (short). - swingTrailingStop(input): ArrayLike; default: not declared - swingTrailingStop(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SwingTrailingStopParameters | undefined; default: not declared - swingTrailingStop(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - swingTrailingStop.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').SwingTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - swingTrailingStop.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - swingTrailingStop.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - swingTrailingStop.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - swingTrailingStop.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - swingTrailingStop.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - swingTrailingStop.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - swingTrailingStop.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - swingTrailingStop.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - swingTrailingStop.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - swingTrailingStop.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - swingTrailingStop.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - swingTrailingStop.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - swingTrailingStop.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - swingTrailingStop.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - swingTrailingStop.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - swingTrailingStop.explain(input): ArrayLike; default: not declared - swingTrailingStop.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SwingTrailingStopParameters | undefined; default: not declared - swingTrailingStop.explain(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - swingTrailingStop.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - swingTrailingStop.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - swingTrailingStop.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - swingTrailingStop.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - swingTrailingStop.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - swingTrailingStop.fromJSON().return.value.stop: number; default: not declared — The trailing stop line. - swingTrailingStop.fromJSON().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - swingTrailingStop.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - swingTrailingStop.fromJSON(snapshot).kind: string; default: not declared - swingTrailingStop.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - swingTrailingStop.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - swingTrailingStop.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').SwingTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - swingTrailingStop.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - swingTrailingStop.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - swingTrailingStop.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - swingTrailingStop.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrailingStopPoint | null; default: not declared - swingTrailingStop.stream().return.value.stop: number; default: not declared — The trailing stop line. - swingTrailingStop.stream().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - swingTrailingStop.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').SwingTrailingStopParameters | undefined; default: not declared - swingTrailingStop.stream(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - swings: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').Swings; default: not declared — Swing highs/lows: a swing high is a bar whose high strictly exceeds the highs of the `strength` bars on each side (and symmetrically for lows). The first and last `strength` bars can never be swings. `strength` defaults to 2 (the Bill Williams fractal window). - swings().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - swings().return.assumptions.conventionsVersion: string; default: not declared - swings().return.assumptions.strength: number; default: not declared - swings().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - swings().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - swings().return.highs: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - swings().return.lows: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - swings(bars): ArrayLike; default: not declared - swings(options)?: { strength?: number; }; default: not declared - swings(options).strength?: number; default: not declared - symmetricWma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Symmetric (triangular) weighted MA — identical to the triangular MA (`trima`). - symmetricWma(input): ArrayLike; default: not declared - symmetricWma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - symmetricWma(parameters).period: number; default: not declared - symmetricWma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - symmetricWma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - symmetricWma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - symmetricWma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - symmetricWma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - symmetricWma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - symmetricWma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - symmetricWma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - symmetricWma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - symmetricWma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - symmetricWma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - symmetricWma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - symmetricWma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - symmetricWma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - symmetricWma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - symmetricWma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - symmetricWma.explain(input): ArrayLike; default: not declared - symmetricWma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - symmetricWma.explain(parameters).period: number; default: not declared - symmetricWma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - symmetricWma.fromJSON().return.next: (input: number) => number | null; default: not declared - symmetricWma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - symmetricWma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - symmetricWma.fromJSON().return.value: number | null; default: not declared - symmetricWma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - symmetricWma.fromJSON(snapshot).kind: string; default: not declared - symmetricWma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - symmetricWma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - symmetricWma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - symmetricWma.stream().return.next: (input: number) => number | null; default: not declared - symmetricWma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - symmetricWma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - symmetricWma.stream().return.value: number | null; default: not declared - symmetricWma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - symmetricWma.stream(parameters).period: number; default: not declared - t3: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - t3(input): ArrayLike; default: not declared - t3(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').T3Parameters | undefined; default: not declared - t3(parameters).period: number; default: not declared - t3(parameters).volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. - t3.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').T3Parameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - t3.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - t3.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - t3.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - t3.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - t3.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - t3.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - t3.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - t3.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - t3.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - t3.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - t3.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - t3.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - t3.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - t3.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - t3.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - t3.explain(input): ArrayLike; default: not declared - t3.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').T3Parameters | undefined; default: not declared - t3.explain(parameters).period: number; default: not declared - t3.explain(parameters).volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. - t3.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - t3.fromJSON().return.next: (input: number) => number | null; default: not declared - t3.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - t3.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - t3.fromJSON().return.value: number | null; default: not declared - t3.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - t3.fromJSON(snapshot).kind: string; default: not declared - t3.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - t3.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - t3.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').T3Parameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - t3.stream().return.next: (input: number) => number | null; default: not declared - t3.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - t3.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - t3.stream().return.value: number | null; default: not declared - t3.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').T3Parameters | undefined; default: not declared - t3.stream(parameters).period: number; default: not declared - t3.stream(parameters).volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. - talibCandle: (name: string, bars: ArrayLike) => number[]; default: not declared — Run an adaptive TA-Lib candlestick pattern by name (camelCase or `CDL*`), returning the ±100/0 series. Throws for patterns not yet ported to the adaptive engine (use the fixed-ratio detectors in `candlesticks.ts` for those — see `TALIB_CANDLE_NAMES` for what's available here). - talibCandle(bars): ArrayLike; default: not declared - talibCandle(name): string; default: not declared - tan: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - tan(input): ArrayLike; default: not declared - tan(parameters)?: {} | undefined; default: not declared - tan.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tan.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tan.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tan.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tan.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tan.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tan.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tan.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tan.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tan.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tan.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tan.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tan.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tan.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tan.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tan.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tan.explain(input): ArrayLike; default: not declared - tan.explain(parameters)?: {} | undefined; default: not declared - tan.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tan.fromJSON().return.next: (input: number) => number | null; default: not declared - tan.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tan.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tan.fromJSON().return.value: number | null; default: not declared - tan.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tan.fromJSON(snapshot).kind: string; default: not declared - tan.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tan.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tan.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tan.stream().return.next: (input: number) => number | null; default: not declared - tan.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tan.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tan.stream().return.value: number | null; default: not declared - tan.stream(parameters)?: {} | undefined; default: not declared - tanh: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, number, number>; default: not declared - tanh(input): ArrayLike; default: not declared - tanh(parameters)?: {} | undefined; default: not declared - tanh.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tanh.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tanh.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tanh.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tanh.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tanh.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tanh.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tanh.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tanh.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tanh.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tanh.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tanh.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tanh.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tanh.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tanh.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tanh.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tanh.explain(input): ArrayLike; default: not declared - tanh.explain(parameters)?: {} | undefined; default: not declared - tanh.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tanh.fromJSON().return.next: (input: number) => number | null; default: not declared - tanh.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tanh.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tanh.fromJSON().return.value: number | null; default: not declared - tanh.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tanh.fromJSON(snapshot).kind: string; default: not declared - tanh.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tanh.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tanh.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tanh.stream().return.next: (input: number) => number | null; default: not declared - tanh.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tanh.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tanh.stream().return.value: number | null; default: not declared - tanh.stream(parameters)?: {} | undefined; default: not declared - tdSequential: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - tdSequential(input): ArrayLike; default: not declared - tdSequential(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialParameters | undefined; default: not declared - tdSequential(parameters).lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). - tdSequential.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tdSequential.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tdSequential.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tdSequential.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tdSequential.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tdSequential.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tdSequential.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tdSequential.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tdSequential.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tdSequential.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tdSequential.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tdSequential.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tdSequential.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tdSequential.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tdSequential.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tdSequential.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tdSequential.explain(input): ArrayLike; default: not declared - tdSequential.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialParameters | undefined; default: not declared - tdSequential.explain(parameters).lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). - tdSequential.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tdSequential.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint | null; default: not declared - tdSequential.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tdSequential.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tdSequential.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint | null; default: not declared - tdSequential.fromJSON().return.value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - tdSequential.fromJSON().return.value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - tdSequential.fromJSON().return.value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - tdSequential.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tdSequential.fromJSON(snapshot).kind: string; default: not declared - tdSequential.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tdSequential.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tdSequential.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tdSequential.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint | null; default: not declared - tdSequential.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tdSequential.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tdSequential.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialPoint | null; default: not declared - tdSequential.stream().return.value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - tdSequential.stream().return.value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - tdSequential.stream().return.value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - tdSequential.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TdSequentialParameters | undefined; default: not declared - tdSequential.stream(parameters).lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). - tema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - tema(input): ArrayLike; default: not declared - tema(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - tema(parameters).period: number; default: not declared - tema.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tema.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tema.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tema.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tema.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tema.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tema.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tema.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tema.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tema.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tema.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tema.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tema.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tema.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tema.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tema.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tema.explain(input): ArrayLike; default: not declared - tema.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - tema.explain(parameters).period: number; default: not declared - tema.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tema.fromJSON().return.next: (input: number) => number | null; default: not declared - tema.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tema.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tema.fromJSON().return.value: number | null; default: not declared - tema.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tema.fromJSON(snapshot).kind: string; default: not declared - tema.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tema.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tema.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tema.stream().return.next: (input: number) => number | null; default: not declared - tema.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tema.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tema.stream().return.value: number | null; default: not declared - tema.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - tema.stream(parameters).period: number; default: not declared - tickBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - tickBars(bars): ArrayLike; default: not declared - tickBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters; default: not declared - tickBars(parameters).count: number; default: not declared - tickBars(parameters).flush?: boolean; default: not declared - tickVolumeProfile: (trades: readonly import('@insiderfinance/totalfinance/technical-analysis').Trade[], parameters?: import('@insiderfinance/totalfinance/technical-analysis').TickVolumeProfileParameters) => import('@insiderfinance/totalfinance/technical-analysis').TickVolumeProfile; default: not declared — Volume-by-price built from the **actual trade prints** (each trade's full size lands in the bucket of its exact price — no bar-range smearing), with the POC, value area, and a per-price buy/sell delta (footprint). This is the trade-level counterpart to the bar-based `volumeProfile`. - tickVolumeProfile().return.assumptions: { conventionsVersion: string; tickSize: number | null; bins: number | null; valueAreaFraction: number; method: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; }; default: not declared — Applied conventions, echoed — the binning mode that WON is non-null (`tickSize` beats `bins`). - tickVolumeProfile().return.assumptions.bins: number | null; default: not declared - tickVolumeProfile().return.assumptions.conventionsVersion: string; default: not declared - tickVolumeProfile().return.assumptions.method: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; default: not declared - tickVolumeProfile().return.assumptions.tickSize: number | null; default: not declared - tickVolumeProfile().return.assumptions.valueAreaFraction: number; default: not declared - tickVolumeProfile().return.bins: import('@insiderfinance/totalfinance/technical-analysis').TickVolumeBin[]; default: not declared - tickVolumeProfile().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - tickVolumeProfile().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - tickVolumeProfile().return.poc: number | null; default: not declared — Point of control: price of the highest-volume bucket (its midpoint); null for an empty tape. - tickVolumeProfile().return.totalDelta: number; default: not declared - tickVolumeProfile().return.totalVolume: number; default: not declared - tickVolumeProfile().return.valueArea: { low: number | null; high: number | null; }; default: not declared — Value-area price bounds holding `valueAreaFraction` of total volume around the POC (nulls when empty). - tickVolumeProfile().return.valueArea.high: number | null; default: not declared - tickVolumeProfile().return.valueArea.low: number | null; default: not declared - tickVolumeProfile(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TickVolumeProfileParameters; default: not declared - tickVolumeProfile(parameters).bins?: number; default: not declared — Number of equal-width buckets between the min and max trade price. Default 50. - tickVolumeProfile(parameters).method?: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; default: not declared — Aggressor method for the buy/sell split. Default `'quote'` if quotes given, else `'tick'`. - tickVolumeProfile(parameters).quotes?: readonly import('@insiderfinance/totalfinance/technical-analysis').Quote[]; default: not declared - tickVolumeProfile(parameters).tickSize?: number; default: not declared — Bucket width in price units (e.g. one tick). Mutually exclusive with `bins` (tickSize wins). - tickVolumeProfile(parameters).valueAreaFraction?: number; default: not declared — Fraction of total volume defining the value area. Default 0.7. - tickVolumeProfile(trades): readonly import('@insiderfinance/totalfinance/technical-analysis').Trade[]; default: not declared - tosStdevAll: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Thinkorswim Standard Deviation All: OLS line plus source-standard-deviation bands. Omitting `period` uses **all history seen so far** (a causal, stream-friendly expanding window) — a deliberate TotalFinance choice. This is NOT the single full-series regression overlay that ThinkorSwim / pandas-ta's `tos_stdevall` draws (a constant line over the whole chart); pass an explicit `period` for a fixed rolling window. See docs/compatibility/talib-differences.md. - tosStdevAll(input): ArrayLike; default: not declared - tosStdevAll(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllParameters | undefined; default: not declared - tosStdevAll(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - tosStdevAll(parameters).period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - tosStdevAll(parameters).stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. - tosStdevAll.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tosStdevAll.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tosStdevAll.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tosStdevAll.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tosStdevAll.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tosStdevAll.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tosStdevAll.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tosStdevAll.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tosStdevAll.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tosStdevAll.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tosStdevAll.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tosStdevAll.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tosStdevAll.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tosStdevAll.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tosStdevAll.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tosStdevAll.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tosStdevAll.explain(input): ArrayLike; default: not declared - tosStdevAll.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllParameters | undefined; default: not declared - tosStdevAll.explain(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - tosStdevAll.explain(parameters).period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - tosStdevAll.explain(parameters).stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. - tosStdevAll.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tosStdevAll.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint | null; default: not declared - tosStdevAll.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tosStdevAll.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tosStdevAll.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint | null; default: not declared - tosStdevAll.fromJSON().return.value.line: number; default: not declared — Current value of the OLS centerline. - tosStdevAll.fromJSON().return.value.lower: number[]; default: not declared — Lower bands, in the same order as `stds`. - tosStdevAll.fromJSON().return.value.upper: number[]; default: not declared — Upper bands, in the same order as `stds`. - tosStdevAll.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tosStdevAll.fromJSON(snapshot).kind: string; default: not declared - tosStdevAll.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tosStdevAll.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tosStdevAll.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tosStdevAll.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint | null; default: not declared - tosStdevAll.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tosStdevAll.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tosStdevAll.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllPoint | null; default: not declared - tosStdevAll.stream().return.value.line: number; default: not declared — Current value of the OLS centerline. - tosStdevAll.stream().return.value.lower: number[]; default: not declared — Lower bands, in the same order as `stds`. - tosStdevAll.stream().return.value.upper: number[]; default: not declared — Upper bands, in the same order as `stds`. - tosStdevAll.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TosStdevAllParameters | undefined; default: not declared - tosStdevAll.stream(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - tosStdevAll.stream(parameters).period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - tosStdevAll.stream(parameters).stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. - tradeSign: import('@insiderfinance/totalfinance/core').SeriesFacade<[trade: import('@insiderfinance/totalfinance/technical-analysis').Trade, context?: import('@insiderfinance/totalfinance/technical-analysis').SignContext | undefined], import('@insiderfinance/totalfinance/technical-analysis/microstructure').TradeDirection, { conventionsVersion: string; method: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; }>; default: not declared — Plain aggressor sign; use `tradeSign.explain(...)` for the resolving rule and diagnostics. - tradeSign(callArguments): [trade: import('@insiderfinance/totalfinance/technical-analysis').Trade, context?: import('@insiderfinance/totalfinance/technical-analysis').SignContext | undefined]; default: not declared - tradeSign.explain: (trade: import('@insiderfinance/totalfinance/technical-analysis').Trade, context?: import('@insiderfinance/totalfinance/technical-analysis').SignContext | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - tradeSign.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; method: import('@insiderfinance/totalfinance/technical-analysis').AggressorMethod; }>; default: not declared — Every applied convention, echoed back. - tradeSign.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - tradeSign.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tradeSign.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis/microstructure').TradeDirection; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tradeSign.explain(callArguments): [trade: import('@insiderfinance/totalfinance/technical-analysis').Trade, context?: import('@insiderfinance/totalfinance/technical-analysis').SignContext | undefined]; default: not declared - trendSignals: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint>; default: not declared — Turn a trend series (>0 ⇒ in-trend) into trend/entry/exit flags. - trendSignals(input): ArrayLike; default: not declared - trendSignals(parameters)?: Record | undefined; default: not declared - trendSignals.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - trendSignals.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - trendSignals.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - trendSignals.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - trendSignals.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - trendSignals.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - trendSignals.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - trendSignals.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - trendSignals.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - trendSignals.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - trendSignals.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - trendSignals.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - trendSignals.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - trendSignals.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - trendSignals.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - trendSignals.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - trendSignals.explain(input): ArrayLike; default: not declared - trendSignals.explain(parameters)?: Record | undefined; default: not declared - trendSignals.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trendSignals.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - trendSignals.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trendSignals.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trendSignals.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - trendSignals.fromJSON().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - trendSignals.fromJSON().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - trendSignals.fromJSON().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - trendSignals.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trendSignals.fromJSON(snapshot).kind: string; default: not declared - trendSignals.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - trendSignals.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - trendSignals.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trendSignals.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - trendSignals.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trendSignals.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trendSignals.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrendSignalPoint | null; default: not declared - trendSignals.stream().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - trendSignals.stream().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - trendSignals.stream().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - trendSignals.stream(parameters)?: Record | undefined; default: not declared - trendlines: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; default: not declared — Connect the two most recent swing lows (support) and swing highs (resistance) into trendlines. - trendlines().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - trendlines().return.assumptions.conventionsVersion: string; default: not declared - trendlines().return.assumptions.strength: number; default: not declared - trendlines().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - trendlines().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - trendlines().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - trendlines().return.resistance.from: number; default: not declared - trendlines().return.resistance.intercept: number; default: not declared - trendlines().return.resistance.slope: number; default: not declared - trendlines().return.resistance.to: number; default: not declared - trendlines().return.support: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - trendlines().return.support.from: number; default: not declared - trendlines().return.support.intercept: number; default: not declared - trendlines().return.support.slope: number; default: not declared - trendlines().return.support.to: number; default: not declared - trendlines(bars): ArrayLike; default: not declared - trendlines(options)?: { strength?: number; }; default: not declared - trendlines(options).strength?: number; default: not declared - trima: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - trima(input): ArrayLike; default: not declared - trima(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - trima(parameters).period: number; default: not declared - trima.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - trima.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - trima.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - trima.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - trima.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - trima.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - trima.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - trima.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - trima.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - trima.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - trima.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - trima.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - trima.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - trima.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - trima.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - trima.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - trima.explain(input): ArrayLike; default: not declared - trima.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - trima.explain(parameters).period: number; default: not declared - trima.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trima.fromJSON().return.next: (input: number) => number | null; default: not declared - trima.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trima.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trima.fromJSON().return.value: number | null; default: not declared - trima.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trima.fromJSON(snapshot).kind: string; default: not declared - trima.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - trima.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - trima.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trima.stream().return.next: (input: number) => number | null; default: not declared - trima.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trima.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trima.stream().return.value: number | null; default: not declared - trima.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - trima.stream(parameters).period: number; default: not declared - trix: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — TRIX — the 1-bar rate of change of a triple-smoothed EMA, in percent. Warmup is TA-Lib's TRIX lookback, `3·(period − 1) + 1`: the triple EMA itself first exists at `3·(period − 1)`, and the rate of change needs the bar after that. - trix(input): ArrayLike; default: not declared - trix(parameters)?: { period?: number; } | undefined; default: not declared - trix(parameters).period?: number; default: not declared - trix.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - trix.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - trix.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - trix.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - trix.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - trix.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - trix.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - trix.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - trix.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - trix.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - trix.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - trix.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - trix.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - trix.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - trix.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - trix.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - trix.explain(input): ArrayLike; default: not declared - trix.explain(parameters)?: { period?: number; } | undefined; default: not declared - trix.explain(parameters).period?: number; default: not declared - trix.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trix.fromJSON().return.next: (input: number) => number | null; default: not declared - trix.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trix.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trix.fromJSON().return.value: number | null; default: not declared - trix.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trix.fromJSON(snapshot).kind: string; default: not declared - trix.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - trix.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - trix.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trix.stream().return.next: (input: number) => number | null; default: not declared - trix.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trix.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trix.stream().return.value: number | null; default: not declared - trix.stream(parameters)?: { period?: number; } | undefined; default: not declared - trix.stream(parameters).period?: number; default: not declared - trixHistogram: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - trixHistogram(input): ArrayLike; default: not declared - trixHistogram(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramParameters | undefined; default: not declared - trixHistogram(parameters).period?: number; default: not declared - trixHistogram(parameters).signal?: number; default: not declared - trixHistogram.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - trixHistogram.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - trixHistogram.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - trixHistogram.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - trixHistogram.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - trixHistogram.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - trixHistogram.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - trixHistogram.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - trixHistogram.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - trixHistogram.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - trixHistogram.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - trixHistogram.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - trixHistogram.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - trixHistogram.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - trixHistogram.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - trixHistogram.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - trixHistogram.explain(input): ArrayLike; default: not declared - trixHistogram.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramParameters | undefined; default: not declared - trixHistogram.explain(parameters).period?: number; default: not declared - trixHistogram.explain(parameters).signal?: number; default: not declared - trixHistogram.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trixHistogram.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint | null; default: not declared - trixHistogram.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trixHistogram.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trixHistogram.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint | null; default: not declared - trixHistogram.fromJSON().return.value.histogram: number; default: not declared - trixHistogram.fromJSON().return.value.signal: number; default: not declared - trixHistogram.fromJSON().return.value.trix: number; default: not declared - trixHistogram.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trixHistogram.fromJSON(snapshot).kind: string; default: not declared - trixHistogram.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - trixHistogram.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - trixHistogram.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trixHistogram.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint | null; default: not declared - trixHistogram.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trixHistogram.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trixHistogram.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramPoint | null; default: not declared - trixHistogram.stream().return.value.histogram: number; default: not declared - trixHistogram.stream().return.value.signal: number; default: not declared - trixHistogram.stream().return.value.trix: number; default: not declared - trixHistogram.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TrixHistogramParameters | undefined; default: not declared - trixHistogram.stream(parameters).period?: number; default: not declared - trixHistogram.stream(parameters).signal?: number; default: not declared - trueRange: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - trueRange(input): ArrayLike; default: not declared - trueRange(parameters)?: {} | undefined; default: not declared - trueRange.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - trueRange.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - trueRange.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - trueRange.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - trueRange.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - trueRange.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - trueRange.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - trueRange.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - trueRange.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - trueRange.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - trueRange.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - trueRange.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - trueRange.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - trueRange.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - trueRange.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - trueRange.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - trueRange.explain(input): ArrayLike; default: not declared - trueRange.explain(parameters)?: {} | undefined; default: not declared - trueRange.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trueRange.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - trueRange.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trueRange.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trueRange.fromJSON().return.value: number | null; default: not declared - trueRange.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trueRange.fromJSON(snapshot).kind: string; default: not declared - trueRange.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - trueRange.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - trueRange.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - trueRange.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - trueRange.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - trueRange.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - trueRange.stream().return.value: number | null; default: not declared - trueRange.stream(parameters)?: {} | undefined; default: not declared - tsf: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - tsf(input): ArrayLike; default: not declared - tsf(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - tsf(parameters).period: number; default: not declared - tsf.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tsf.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tsf.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tsf.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tsf.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tsf.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tsf.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tsf.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tsf.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tsf.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tsf.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tsf.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tsf.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tsf.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tsf.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tsf.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tsf.explain(input): ArrayLike; default: not declared - tsf.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - tsf.explain(parameters).period: number; default: not declared - tsf.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tsf.fromJSON().return.next: (input: number) => number | null; default: not declared - tsf.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tsf.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tsf.fromJSON().return.value: number | null; default: not declared - tsf.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tsf.fromJSON(snapshot).kind: string; default: not declared - tsf.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tsf.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tsf.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tsf.stream().return.next: (input: number) => number | null; default: not declared - tsf.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tsf.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tsf.stream().return.value: number | null; default: not declared - tsf.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/trend').PeriodParameters | undefined; default: not declared - tsf.stream(parameters).period: number; default: not declared - tsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - tsi(input): ArrayLike; default: not declared - tsi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TsiParameters | undefined; default: not declared - tsi(parameters).long?: number; default: not declared - tsi(parameters).short?: number; default: not declared - tsi(parameters).signal?: number; default: not declared - tsi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').TsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - tsi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - tsi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - tsi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - tsi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - tsi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - tsi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - tsi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - tsi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - tsi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - tsi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - tsi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tsi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - tsi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - tsi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - tsi.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').TsiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - tsi.explain(input): ArrayLike; default: not declared - tsi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TsiParameters | undefined; default: not declared - tsi.explain(parameters).long?: number; default: not declared - tsi.explain(parameters).short?: number; default: not declared - tsi.explain(parameters).signal?: number; default: not declared - tsi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tsi.fromJSON().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TsiPoint | null; default: not declared - tsi.fromJSON().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tsi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tsi.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').TsiPoint | null; default: not declared - tsi.fromJSON().return.value.signal: number; default: not declared - tsi.fromJSON().return.value.tsi: number; default: not declared - tsi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tsi.fromJSON(snapshot).kind: string; default: not declared - tsi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - tsi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - tsi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').TsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - tsi.stream().return.next: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TsiPoint | null; default: not declared - tsi.stream().return.peek: (input: number) => import('@insiderfinance/totalfinance/technical-analysis').TsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - tsi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - tsi.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').TsiPoint | null; default: not declared - tsi.stream().return.value.signal: number; default: not declared - tsi.stream().return.value.tsi: number; default: not declared - tsi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').TsiParameters | undefined; default: not declared - tsi.stream(parameters).long?: number; default: not declared - tsi.stream(parameters).short?: number; default: not declared - tsi.stream(parameters).signal?: number; default: not declared - ttmTrend: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — TTM Trend — +1 when close is above the SMA of HL2 over the lookback, −1 otherwise. - ttmTrend(input): ArrayLike; default: not declared - ttmTrend(parameters)?: { period?: number; } | undefined; default: not declared - ttmTrend(parameters).period?: number; default: not declared - ttmTrend.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ttmTrend.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ttmTrend.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ttmTrend.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ttmTrend.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ttmTrend.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ttmTrend.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ttmTrend.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ttmTrend.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ttmTrend.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ttmTrend.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ttmTrend.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ttmTrend.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ttmTrend.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ttmTrend.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ttmTrend.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ttmTrend.explain(input): ArrayLike; default: not declared - ttmTrend.explain(parameters)?: { period?: number; } | undefined; default: not declared - ttmTrend.explain(parameters).period?: number; default: not declared - ttmTrend.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ttmTrend.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - ttmTrend.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ttmTrend.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ttmTrend.fromJSON().return.value: number | null; default: not declared - ttmTrend.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ttmTrend.fromJSON(snapshot).kind: string; default: not declared - ttmTrend.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ttmTrend.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ttmTrend.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ttmTrend.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - ttmTrend.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ttmTrend.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ttmTrend.stream().return.value: number | null; default: not declared - ttmTrend.stream(parameters)?: { period?: number; } | undefined; default: not declared - ttmTrend.stream(parameters).period?: number; default: not declared - typicalPrice: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - typicalPrice(input): ArrayLike; default: not declared - typicalPrice(parameters)?: {} | undefined; default: not declared - typicalPrice.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - typicalPrice.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - typicalPrice.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - typicalPrice.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - typicalPrice.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - typicalPrice.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - typicalPrice.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - typicalPrice.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - typicalPrice.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - typicalPrice.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - typicalPrice.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - typicalPrice.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - typicalPrice.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - typicalPrice.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - typicalPrice.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - typicalPrice.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - typicalPrice.explain(input): ArrayLike; default: not declared - typicalPrice.explain(parameters)?: {} | undefined; default: not declared - typicalPrice.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - typicalPrice.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - typicalPrice.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - typicalPrice.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - typicalPrice.fromJSON().return.value: number | null; default: not declared - typicalPrice.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - typicalPrice.fromJSON(snapshot).kind: string; default: not declared - typicalPrice.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - typicalPrice.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - typicalPrice.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - typicalPrice.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - typicalPrice.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - typicalPrice.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - typicalPrice.stream().return.value: number | null; default: not declared - typicalPrice.stream(parameters)?: {} | undefined; default: not declared - ulcerIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Ulcer Index — RMS of percent drawdown from the rolling `period` high close. - ulcerIndex(input): ArrayLike; default: not declared - ulcerIndex(parameters)?: { period?: number; } | undefined; default: not declared - ulcerIndex(parameters).period?: number; default: not declared - ulcerIndex.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ulcerIndex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ulcerIndex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ulcerIndex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ulcerIndex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ulcerIndex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ulcerIndex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ulcerIndex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ulcerIndex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ulcerIndex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ulcerIndex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ulcerIndex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ulcerIndex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ulcerIndex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ulcerIndex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ulcerIndex.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ulcerIndex.explain(input): ArrayLike; default: not declared - ulcerIndex.explain(parameters)?: { period?: number; } | undefined; default: not declared - ulcerIndex.explain(parameters).period?: number; default: not declared - ulcerIndex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ulcerIndex.fromJSON().return.next: (input: number) => number | null; default: not declared - ulcerIndex.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ulcerIndex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ulcerIndex.fromJSON().return.value: number | null; default: not declared - ulcerIndex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ulcerIndex.fromJSON(snapshot).kind: string; default: not declared - ulcerIndex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ulcerIndex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ulcerIndex.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ulcerIndex.stream().return.next: (input: number) => number | null; default: not declared - ulcerIndex.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ulcerIndex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ulcerIndex.stream().return.value: number | null; default: not declared - ulcerIndex.stream(parameters)?: { period?: number; } | undefined; default: not declared - ulcerIndex.stream(parameters).period?: number; default: not declared - ultimateOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - ultimateOscillator(input): ArrayLike; default: not declared - ultimateOscillator(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').UltimateParameters | undefined; default: not declared - ultimateOscillator(parameters).long?: number; default: not declared - ultimateOscillator(parameters).medium?: number; default: not declared - ultimateOscillator(parameters).short?: number; default: not declared - ultimateOscillator.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').UltimateParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - ultimateOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - ultimateOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - ultimateOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ultimateOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ultimateOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ultimateOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ultimateOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ultimateOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ultimateOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ultimateOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ultimateOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ultimateOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ultimateOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ultimateOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ultimateOscillator.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ultimateOscillator.explain(input): ArrayLike; default: not declared - ultimateOscillator.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').UltimateParameters | undefined; default: not declared - ultimateOscillator.explain(parameters).long?: number; default: not declared - ultimateOscillator.explain(parameters).medium?: number; default: not declared - ultimateOscillator.explain(parameters).short?: number; default: not declared - ultimateOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ultimateOscillator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - ultimateOscillator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ultimateOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ultimateOscillator.fromJSON().return.value: number | null; default: not declared - ultimateOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ultimateOscillator.fromJSON(snapshot).kind: string; default: not declared - ultimateOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - ultimateOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - ultimateOscillator.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').UltimateParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - ultimateOscillator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - ultimateOscillator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - ultimateOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - ultimateOscillator.stream().return.value: number | null; default: not declared - ultimateOscillator.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').UltimateParameters | undefined; default: not declared - ultimateOscillator.stream(parameters).long?: number; default: not declared - ultimateOscillator.stream(parameters).medium?: number; default: not declared - ultimateOscillator.stream(parameters).short?: number; default: not declared - upperShadow: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - upperShadow(input): ArrayLike; default: not declared - upperShadow(parameters)?: {} | undefined; default: not declared - upperShadow.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - upperShadow.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - upperShadow.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - upperShadow.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - upperShadow.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - upperShadow.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - upperShadow.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - upperShadow.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - upperShadow.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - upperShadow.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - upperShadow.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - upperShadow.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - upperShadow.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - upperShadow.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - upperShadow.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - upperShadow.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - upperShadow.explain(input): ArrayLike; default: not declared - upperShadow.explain(parameters)?: {} | undefined; default: not declared - upperShadow.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - upperShadow.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - upperShadow.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - upperShadow.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - upperShadow.fromJSON().return.value: number | null; default: not declared - upperShadow.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - upperShadow.fromJSON(snapshot).kind: string; default: not declared - upperShadow.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - upperShadow.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - upperShadow.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - upperShadow.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - upperShadow.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - upperShadow.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - upperShadow.stream().return.value: number | null; default: not declared - upperShadow.stream(parameters)?: {} | undefined; default: not declared - valueWhen: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — The source (`y`) value when the condition (`x > 0`) was last true (the `occurrence`-th most recent). - valueWhen(input): ArrayLike; default: not declared - valueWhen(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ValueWhenParameters | undefined; default: not declared - valueWhen(parameters).occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. - valueWhen.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').ValueWhenParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - valueWhen.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - valueWhen.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - valueWhen.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - valueWhen.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - valueWhen.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - valueWhen.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - valueWhen.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - valueWhen.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - valueWhen.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - valueWhen.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - valueWhen.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - valueWhen.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - valueWhen.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - valueWhen.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - valueWhen.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - valueWhen.explain(input): ArrayLike; default: not declared - valueWhen.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ValueWhenParameters | undefined; default: not declared - valueWhen.explain(parameters).occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. - valueWhen.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - valueWhen.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - valueWhen.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - valueWhen.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - valueWhen.fromJSON().return.value: number | null; default: not declared - valueWhen.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - valueWhen.fromJSON(snapshot).kind: string; default: not declared - valueWhen.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - valueWhen.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - valueWhen.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').ValueWhenParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - valueWhen.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared - valueWhen.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - valueWhen.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - valueWhen.stream().return.value: number | null; default: not declared - valueWhen.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').ValueWhenParameters | undefined; default: not declared - valueWhen.stream(parameters).occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. - variance: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - variance(input): ArrayLike; default: not declared - variance(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined; default: not declared - variance(parameters).period: number; default: not declared - variance(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - variance.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - variance.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - variance.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - variance.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - variance.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - variance.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - variance.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - variance.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - variance.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - variance.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - variance.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - variance.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - variance.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - variance.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - variance.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - variance.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - variance.explain(input): ArrayLike; default: not declared - variance.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined; default: not declared - variance.explain(parameters).period: number; default: not declared - variance.explain(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - variance.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - variance.fromJSON().return.next: (input: number) => number | null; default: not declared - variance.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - variance.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - variance.fromJSON().return.value: number | null; default: not declared - variance.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - variance.fromJSON(snapshot).kind: string; default: not declared - variance.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - variance.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - variance.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - variance.stream().return.next: (input: number) => number | null; default: not declared - variance.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - variance.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - variance.stream().return.value: number | null; default: not declared - variance.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').StandardDeviationParameters | undefined; default: not declared - variance.stream(parameters).period: number; default: not declared - variance.stream(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - verticalHorizontalFilter: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Vertical Horizontal Filter — trend strength = range / summed absolute change. - verticalHorizontalFilter(input): ArrayLike; default: not declared - verticalHorizontalFilter(parameters)?: { period?: number; } | undefined; default: not declared - verticalHorizontalFilter(parameters).period?: number; default: not declared - verticalHorizontalFilter.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - verticalHorizontalFilter.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - verticalHorizontalFilter.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - verticalHorizontalFilter.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - verticalHorizontalFilter.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - verticalHorizontalFilter.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - verticalHorizontalFilter.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - verticalHorizontalFilter.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - verticalHorizontalFilter.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - verticalHorizontalFilter.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - verticalHorizontalFilter.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - verticalHorizontalFilter.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - verticalHorizontalFilter.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - verticalHorizontalFilter.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - verticalHorizontalFilter.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - verticalHorizontalFilter.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - verticalHorizontalFilter.explain(input): ArrayLike; default: not declared - verticalHorizontalFilter.explain(parameters)?: { period?: number; } | undefined; default: not declared - verticalHorizontalFilter.explain(parameters).period?: number; default: not declared - verticalHorizontalFilter.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - verticalHorizontalFilter.fromJSON().return.next: (input: number) => number | null; default: not declared - verticalHorizontalFilter.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - verticalHorizontalFilter.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - verticalHorizontalFilter.fromJSON().return.value: number | null; default: not declared - verticalHorizontalFilter.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - verticalHorizontalFilter.fromJSON(snapshot).kind: string; default: not declared - verticalHorizontalFilter.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - verticalHorizontalFilter.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - verticalHorizontalFilter.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - verticalHorizontalFilter.stream().return.next: (input: number) => number | null; default: not declared - verticalHorizontalFilter.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - verticalHorizontalFilter.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - verticalHorizontalFilter.stream().return.value: number | null; default: not declared - verticalHorizontalFilter.stream(parameters)?: { period?: number; } | undefined; default: not declared - verticalHorizontalFilter.stream(parameters).period?: number; default: not declared - vfi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - vfi(input): ArrayLike; default: not declared - vfi(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VfiParameters | undefined; default: not declared - vfi(parameters).coefficient?: number; default: not declared - vfi(parameters).period?: number; default: not declared - vfi(parameters).smooth?: number; default: not declared - vfi(parameters).volumeCutoff?: number; default: not declared - vfi.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VfiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - vfi.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - vfi.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - vfi.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vfi.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vfi.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vfi.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vfi.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vfi.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vfi.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vfi.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vfi.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vfi.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vfi.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vfi.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vfi.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vfi.explain(input): ArrayLike; default: not declared - vfi.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VfiParameters | undefined; default: not declared - vfi.explain(parameters).coefficient?: number; default: not declared - vfi.explain(parameters).period?: number; default: not declared - vfi.explain(parameters).smooth?: number; default: not declared - vfi.explain(parameters).volumeCutoff?: number; default: not declared - vfi.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vfi.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - vfi.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vfi.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vfi.fromJSON().return.value: number | null; default: not declared - vfi.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vfi.fromJSON(snapshot).kind: string; default: not declared - vfi.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - vfi.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - vfi.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').VfiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vfi.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - vfi.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vfi.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vfi.stream().return.value: number | null; default: not declared - vfi.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VfiParameters | undefined; default: not declared - vfi.stream(parameters).coefficient?: number; default: not declared - vfi.stream(parameters).period?: number; default: not declared - vfi.stream(parameters).smooth?: number; default: not declared - vfi.stream(parameters).volumeCutoff?: number; default: not declared - vidya: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - vidya(input): ArrayLike; default: not declared - vidya(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VidyaParameters | undefined; default: not declared - vidya(parameters).cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - vidya(parameters).period: number; default: not declared - vidya.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VidyaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - vidya.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - vidya.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - vidya.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vidya.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vidya.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vidya.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vidya.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vidya.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vidya.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vidya.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vidya.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vidya.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vidya.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vidya.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vidya.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vidya.explain(input): ArrayLike; default: not declared - vidya.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VidyaParameters | undefined; default: not declared - vidya.explain(parameters).cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - vidya.explain(parameters).period: number; default: not declared - vidya.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vidya.fromJSON().return.next: (input: number) => number | null; default: not declared - vidya.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vidya.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vidya.fromJSON().return.value: number | null; default: not declared - vidya.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vidya.fromJSON(snapshot).kind: string; default: not declared - vidya.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - vidya.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - vidya.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').VidyaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vidya.stream().return.next: (input: number) => number | null; default: not declared - vidya.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vidya.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vidya.stream().return.value: number | null; default: not declared - vidya.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VidyaParameters | undefined; default: not declared - vidya.stream(parameters).cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - vidya.stream(parameters).period: number; default: not declared - volatilityStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - volatilityStop(input): ArrayLike; default: not declared - volatilityStop(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopParameters | undefined; default: not declared - volatilityStop(parameters).multiplier?: number; default: not declared - volatilityStop(parameters).period?: number; default: not declared - volatilityStop.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - volatilityStop.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - volatilityStop.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - volatilityStop.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - volatilityStop.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - volatilityStop.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - volatilityStop.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - volatilityStop.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - volatilityStop.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - volatilityStop.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - volatilityStop.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - volatilityStop.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - volatilityStop.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - volatilityStop.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - volatilityStop.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - volatilityStop.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - volatilityStop.explain(input): ArrayLike; default: not declared - volatilityStop.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopParameters | undefined; default: not declared - volatilityStop.explain(parameters).multiplier?: number; default: not declared - volatilityStop.explain(parameters).period?: number; default: not declared - volatilityStop.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - volatilityStop.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint | null; default: not declared - volatilityStop.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - volatilityStop.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volatilityStop.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint | null; default: not declared - volatilityStop.fromJSON().return.value.stop: number; default: not declared — The trailing stop line. - volatilityStop.fromJSON().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - volatilityStop.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volatilityStop.fromJSON(snapshot).kind: string; default: not declared - volatilityStop.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - volatilityStop.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - volatilityStop.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - volatilityStop.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint | null; default: not declared - volatilityStop.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - volatilityStop.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volatilityStop.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopPoint | null; default: not declared - volatilityStop.stream().return.value.stop: number; default: not declared — The trailing stop line. - volatilityStop.stream().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - volatilityStop.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolatilityStopParameters | undefined; default: not declared - volatilityStop.stream(parameters).multiplier?: number; default: not declared - volatilityStop.stream(parameters).period?: number; default: not declared - volumeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - volumeBars(bars): ArrayLike; default: not declared - volumeBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters; default: not declared - volumeBars(parameters).flush?: boolean; default: not declared - volumeBars(parameters).volume: number; default: not declared - volumeImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Volume imbalance bars — signed volume `|Σ sign(Δclose)·volume|`. - volumeImbalanceBars(bars): ArrayLike; default: not declared - volumeImbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - volumeImbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - volumeImbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - volumeOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Volume Oscillator — 100·(EMA_fast(volume) − EMA_slow(volume)) / EMA_slow(volume). - volumeOscillator(input): ArrayLike; default: not declared - volumeOscillator(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolumeOscillatorParameters | undefined; default: not declared - volumeOscillator(parameters).fast?: number; default: not declared — Fast EMA length on volume. Default 5. - volumeOscillator(parameters).slow?: number; default: not declared — Slow EMA length on volume. Default 10. - volumeOscillator.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VolumeOscillatorParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - volumeOscillator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - volumeOscillator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - volumeOscillator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - volumeOscillator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - volumeOscillator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - volumeOscillator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - volumeOscillator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - volumeOscillator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - volumeOscillator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - volumeOscillator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - volumeOscillator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - volumeOscillator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - volumeOscillator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - volumeOscillator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - volumeOscillator.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - volumeOscillator.explain(input): ArrayLike; default: not declared - volumeOscillator.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolumeOscillatorParameters | undefined; default: not declared - volumeOscillator.explain(parameters).fast?: number; default: not declared — Fast EMA length on volume. Default 5. - volumeOscillator.explain(parameters).slow?: number; default: not declared — Slow EMA length on volume. Default 10. - volumeOscillator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - volumeOscillator.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - volumeOscillator.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - volumeOscillator.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volumeOscillator.fromJSON().return.value: number | null; default: not declared - volumeOscillator.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volumeOscillator.fromJSON(snapshot).kind: string; default: not declared - volumeOscillator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - volumeOscillator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - volumeOscillator.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').VolumeOscillatorParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - volumeOscillator.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - volumeOscillator.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - volumeOscillator.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volumeOscillator.stream().return.value: number | null; default: not declared - volumeOscillator.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolumeOscillatorParameters | undefined; default: not declared - volumeOscillator.stream(parameters).fast?: number; default: not declared — Fast EMA length on volume. Default 5. - volumeOscillator.stream(parameters).slow?: number; default: not declared — Slow EMA length on volume. Default 10. - volumeProfile: (bars: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VolumeProfileParameters) => import('@insiderfinance/totalfinance/technical-analysis').VolumeProfile; default: not declared — Fixed-range volume profile: each bar's volume is spread across the price buckets its high-low range overlaps, **in proportion to the overlap** (a bar contributing 90% of its range to one bucket gives that bucket 90% of its volume), giving volume-by-price, the point of control, and the value area. A zero-range bar puts its whole volume in the bucket holding its close. - volumeProfile().return.assumptions: { conventionsVersion: string; bins: number; valueAreaFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - volumeProfile().return.assumptions.bins: number; default: not declared - volumeProfile().return.assumptions.conventionsVersion: string; default: not declared - volumeProfile().return.assumptions.valueAreaFraction: number; default: not declared - volumeProfile().return.bins: import('@insiderfinance/totalfinance/technical-analysis').VolumeBin[]; default: not declared - volumeProfile().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - volumeProfile().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - volumeProfile().return.poc: number | null; default: not declared — Point of control: price-bin midpoint with the most volume; null for an empty series. - volumeProfile().return.totalVolume: number; default: not declared - volumeProfile().return.valueArea: { low: number | null; high: number | null; }; default: not declared — Value-area price bounds containing `valueAreaFraction` of total volume around the POC (nulls when empty). - volumeProfile().return.valueArea.high: number | null; default: not declared - volumeProfile().return.valueArea.low: number | null; default: not declared - volumeProfile(bars): ArrayLike; default: not declared - volumeProfile(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VolumeProfileParameters; default: not declared - volumeProfile(parameters).bins?: number; default: not declared — Number of price buckets. Default 24. - volumeProfile(parameters).valueAreaFraction?: number; default: not declared — Fraction of total volume that defines the value area. Default 0.7. - volumeRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared — Volume run bars — close on the larger one-sided volume run. - volumeRunBars(bars): ArrayLike; default: not declared - volumeRunBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - volumeRunBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - volumeRunBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - volumeWeightedMacd: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - volumeWeightedMacd(input): ArrayLike; default: not declared - volumeWeightedMacd(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VwMacdParameters | undefined; default: not declared - volumeWeightedMacd(parameters).fast?: number; default: not declared - volumeWeightedMacd(parameters).signal?: number; default: not declared - volumeWeightedMacd(parameters).slow?: number; default: not declared - volumeWeightedMacd.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VwMacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - volumeWeightedMacd.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - volumeWeightedMacd.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - volumeWeightedMacd.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - volumeWeightedMacd.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - volumeWeightedMacd.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - volumeWeightedMacd.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - volumeWeightedMacd.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - volumeWeightedMacd.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - volumeWeightedMacd.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - volumeWeightedMacd.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - volumeWeightedMacd.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - volumeWeightedMacd.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - volumeWeightedMacd.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - volumeWeightedMacd.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - volumeWeightedMacd.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - volumeWeightedMacd.explain(input): ArrayLike; default: not declared - volumeWeightedMacd.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VwMacdParameters | undefined; default: not declared - volumeWeightedMacd.explain(parameters).fast?: number; default: not declared - volumeWeightedMacd.explain(parameters).signal?: number; default: not declared - volumeWeightedMacd.explain(parameters).slow?: number; default: not declared - volumeWeightedMacd.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - volumeWeightedMacd.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - volumeWeightedMacd.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - volumeWeightedMacd.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volumeWeightedMacd.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - volumeWeightedMacd.fromJSON().return.value.histogram: number; default: not declared - volumeWeightedMacd.fromJSON().return.value.macd: number; default: not declared - volumeWeightedMacd.fromJSON().return.value.signal: number; default: not declared - volumeWeightedMacd.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volumeWeightedMacd.fromJSON(snapshot).kind: string; default: not declared - volumeWeightedMacd.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - volumeWeightedMacd.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - volumeWeightedMacd.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').VwMacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - volumeWeightedMacd.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - volumeWeightedMacd.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - volumeWeightedMacd.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - volumeWeightedMacd.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').MacdPoint | null; default: not declared - volumeWeightedMacd.stream().return.value.histogram: number; default: not declared - volumeWeightedMacd.stream().return.value.macd: number; default: not declared - volumeWeightedMacd.stream().return.value.signal: number; default: not declared - volumeWeightedMacd.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VwMacdParameters | undefined; default: not declared - volumeWeightedMacd.stream(parameters).fast?: number; default: not declared - volumeWeightedMacd.stream(parameters).signal?: number; default: not declared - volumeWeightedMacd.stream(parameters).slow?: number; default: not declared - vortex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, import('@insiderfinance/totalfinance/technical-analysis').VortexPoint>; default: not declared - vortex(input): ArrayLike; default: not declared - vortex(parameters)?: { period?: number; } | undefined; default: not declared - vortex(parameters).period?: number; default: not declared - vortex.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - vortex.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - vortex.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - vortex.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vortex.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vortex.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vortex.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vortex.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vortex.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vortex.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vortex.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vortex.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vortex.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vortex.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vortex.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vortex.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').VortexPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vortex.explain(input): ArrayLike; default: not declared - vortex.explain(parameters)?: { period?: number; } | undefined; default: not declared - vortex.explain(parameters).period?: number; default: not declared - vortex.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vortex.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VortexPoint | null; default: not declared - vortex.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VortexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vortex.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vortex.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').VortexPoint | null; default: not declared - vortex.fromJSON().return.value.viMinus: number; default: not declared - vortex.fromJSON().return.value.viPlus: number; default: not declared - vortex.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vortex.fromJSON(snapshot).kind: string; default: not declared - vortex.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - vortex.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - vortex.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vortex.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VortexPoint | null; default: not declared - vortex.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VortexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vortex.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vortex.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').VortexPoint | null; default: not declared - vortex.stream().return.value.viMinus: number; default: not declared - vortex.stream().return.value.viPlus: number; default: not declared - vortex.stream(parameters)?: { period?: number; } | undefined; default: not declared - vortex.stream(parameters).period?: number; default: not declared - vwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - vwap(input): ArrayLike; default: not declared - vwap(parameters)?: Record | undefined; default: not declared - vwap.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - vwap.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - vwap.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - vwap.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vwap.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vwap.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vwap.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vwap.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vwap.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vwap.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vwap.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vwap.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vwap.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vwap.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vwap.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vwap.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vwap.explain(input): ArrayLike; default: not declared - vwap.explain(parameters)?: Record | undefined; default: not declared - vwap.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vwap.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - vwap.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vwap.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwap.fromJSON().return.value: number | null; default: not declared - vwap.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwap.fromJSON(snapshot).kind: string; default: not declared - vwap.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - vwap.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - vwap.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vwap.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - vwap.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vwap.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwap.stream().return.value: number | null; default: not declared - vwap.stream(parameters)?: Record | undefined; default: not declared - vwapBands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - vwapBands(input): ArrayLike; default: not declared - vwapBands(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsParameters | undefined; default: not declared - vwapBands(parameters).multiplier?: number; default: not declared - vwapBands.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - vwapBands.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - vwapBands.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - vwapBands.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vwapBands.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vwapBands.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vwapBands.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vwapBands.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vwapBands.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vwapBands.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vwapBands.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vwapBands.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vwapBands.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vwapBands.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vwapBands.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vwapBands.explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vwapBands.explain(input): ArrayLike; default: not declared - vwapBands.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsParameters | undefined; default: not declared - vwapBands.explain(parameters).multiplier?: number; default: not declared - vwapBands.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vwapBands.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint | null; default: not declared - vwapBands.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vwapBands.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwapBands.fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint | null; default: not declared - vwapBands.fromJSON().return.value.lower: number; default: not declared - vwapBands.fromJSON().return.value.upper: number; default: not declared - vwapBands.fromJSON().return.value.vwap: number; default: not declared - vwapBands.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwapBands.fromJSON(snapshot).kind: string; default: not declared - vwapBands.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - vwapBands.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - vwapBands.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vwapBands.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint | null; default: not declared - vwapBands.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vwapBands.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwapBands.stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsPoint | null; default: not declared - vwapBands.stream().return.value.lower: number; default: not declared - vwapBands.stream().return.value.upper: number; default: not declared - vwapBands.stream().return.value.vwap: number; default: not declared - vwapBands.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').VwapBandsParameters | undefined; default: not declared - vwapBands.stream(parameters).multiplier?: number; default: not declared - vwma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - vwma(input): ArrayLike; default: not declared - vwma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - vwma(parameters).period: number; default: not declared - vwma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - vwma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - vwma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - vwma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vwma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vwma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vwma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vwma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vwma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vwma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vwma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vwma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vwma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vwma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vwma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - vwma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - vwma.explain(input): ArrayLike; default: not declared - vwma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - vwma.explain(parameters).period: number; default: not declared - vwma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vwma.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - vwma.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vwma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwma.fromJSON().return.value: number | null; default: not declared - vwma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwma.fromJSON(snapshot).kind: string; default: not declared - vwma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - vwma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - vwma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - vwma.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - vwma.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - vwma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - vwma.stream().return.value: number | null; default: not declared - vwma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - vwma.stream(parameters).period: number; default: not declared - warmupMarkdown: () => string; default: not declared — Render warmup/lookahead/displacement reference as Markdown, grouped by category. - wcp: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — (high + low + 2·close) / 4 — alias of `weightedClose`. - wcp(input): ArrayLike; default: not declared - wcp(parameters)?: {} | undefined; default: not declared - wcp.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - wcp.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - wcp.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - wcp.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - wcp.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - wcp.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - wcp.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - wcp.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - wcp.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - wcp.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - wcp.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - wcp.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - wcp.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - wcp.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - wcp.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - wcp.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - wcp.explain(input): ArrayLike; default: not declared - wcp.explain(parameters)?: {} | undefined; default: not declared - wcp.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - wcp.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - wcp.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - wcp.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - wcp.fromJSON().return.value: number | null; default: not declared - wcp.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - wcp.fromJSON(snapshot).kind: string; default: not declared - wcp.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - wcp.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - wcp.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - wcp.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - wcp.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - wcp.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - wcp.stream().return.value: number | null; default: not declared - wcp.stream(parameters)?: {} | undefined; default: not declared - weightedClose: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - weightedClose(input): ArrayLike; default: not declared - weightedClose(parameters)?: {} | undefined; default: not declared - weightedClose.explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - weightedClose.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - weightedClose.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - weightedClose.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - weightedClose.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - weightedClose.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - weightedClose.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - weightedClose.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - weightedClose.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - weightedClose.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - weightedClose.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - weightedClose.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - weightedClose.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - weightedClose.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - weightedClose.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - weightedClose.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - weightedClose.explain(input): ArrayLike; default: not declared - weightedClose.explain(parameters)?: {} | undefined; default: not declared - weightedClose.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - weightedClose.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - weightedClose.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - weightedClose.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - weightedClose.fromJSON().return.value: number | null; default: not declared - weightedClose.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - weightedClose.fromJSON(snapshot).kind: string; default: not declared - weightedClose.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - weightedClose.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - weightedClose.stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - weightedClose.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - weightedClose.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - weightedClose.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - weightedClose.stream().return.value: number | null; default: not declared - weightedClose.stream(parameters)?: {} | undefined; default: not declared - williamsAd: import('@insiderfinance/totalfinance/technical-analysis').Indicator, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared — Williams Accumulation/Distribution — running sum of close − true-low/high on up/down days. - williamsAd(input): ArrayLike; default: not declared - williamsAd(parameters)?: Record | undefined; default: not declared - williamsAd.explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - williamsAd.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - williamsAd.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - williamsAd.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - williamsAd.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - williamsAd.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - williamsAd.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - williamsAd.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - williamsAd.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - williamsAd.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - williamsAd.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - williamsAd.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - williamsAd.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - williamsAd.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - williamsAd.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - williamsAd.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - williamsAd.explain(input): ArrayLike; default: not declared - williamsAd.explain(parameters)?: Record | undefined; default: not declared - williamsAd.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - williamsAd.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - williamsAd.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - williamsAd.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - williamsAd.fromJSON().return.value: number | null; default: not declared - williamsAd.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - williamsAd.fromJSON(snapshot).kind: string; default: not declared - williamsAd.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - williamsAd.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - williamsAd.stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - williamsAd.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - williamsAd.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - williamsAd.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - williamsAd.stream().return.value: number | null; default: not declared - williamsAd.stream(parameters)?: Record | undefined; default: not declared - williamsR: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - williamsR(input): ArrayLike; default: not declared - williamsR(parameters)?: { period?: number; } | undefined; default: not declared - williamsR(parameters).period?: number; default: not declared - williamsR.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - williamsR.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - williamsR.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - williamsR.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - williamsR.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - williamsR.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - williamsR.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - williamsR.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - williamsR.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - williamsR.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - williamsR.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - williamsR.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - williamsR.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - williamsR.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - williamsR.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - williamsR.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - williamsR.explain(input): ArrayLike; default: not declared - williamsR.explain(parameters)?: { period?: number; } | undefined; default: not declared - williamsR.explain(parameters).period?: number; default: not declared - williamsR.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - williamsR.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - williamsR.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - williamsR.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - williamsR.fromJSON().return.value: number | null; default: not declared - williamsR.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - williamsR.fromJSON(snapshot).kind: string; default: not declared - williamsR.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - williamsR.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - williamsR.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - williamsR.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - williamsR.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - williamsR.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - williamsR.stream().return.value: number | null; default: not declared - williamsR.stream(parameters)?: { period?: number; } | undefined; default: not declared - williamsR.stream(parameters).period?: number; default: not declared - willr: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, import('@insiderfinance/totalfinance/technical-analysis').BarInput, number>; default: not declared - willr(input): ArrayLike; default: not declared - willr(parameters)?: { period?: number; } | undefined; default: not declared - willr(parameters).period?: number; default: not declared - willr.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - willr.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - willr.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - willr.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - willr.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - willr.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - willr.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - willr.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - willr.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - willr.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - willr.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - willr.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - willr.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - willr.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - willr.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - willr.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - willr.explain(input): ArrayLike; default: not declared - willr.explain(parameters)?: { period?: number; } | undefined; default: not declared - willr.explain(parameters).period?: number; default: not declared - willr.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - willr.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - willr.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - willr.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - willr.fromJSON().return.value: number | null; default: not declared - willr.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - willr.fromJSON(snapshot).kind: string; default: not declared - willr.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - willr.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - willr.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - willr.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - willr.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - willr.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - willr.stream().return.value: number | null; default: not declared - willr.stream(parameters)?: { period?: number; } | undefined; default: not declared - willr.stream(parameters).period?: number; default: not declared - winsorize: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Rolling winsorize: clip the current value to the window's [lower, upper] quantiles. - winsorize(input): ArrayLike; default: not declared - winsorize(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WinsorizeParameters | undefined; default: not declared - winsorize(parameters).lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - winsorize(parameters).period?: number; default: not declared - winsorize(parameters).upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. - winsorize.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').WinsorizeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - winsorize.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - winsorize.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - winsorize.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - winsorize.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - winsorize.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - winsorize.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - winsorize.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - winsorize.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - winsorize.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - winsorize.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - winsorize.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - winsorize.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - winsorize.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - winsorize.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - winsorize.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - winsorize.explain(input): ArrayLike; default: not declared - winsorize.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WinsorizeParameters | undefined; default: not declared - winsorize.explain(parameters).lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - winsorize.explain(parameters).period?: number; default: not declared - winsorize.explain(parameters).upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. - winsorize.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - winsorize.fromJSON().return.next: (input: number) => number | null; default: not declared - winsorize.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - winsorize.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - winsorize.fromJSON().return.value: number | null; default: not declared - winsorize.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - winsorize.fromJSON(snapshot).kind: string; default: not declared - winsorize.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - winsorize.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - winsorize.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').WinsorizeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - winsorize.stream().return.next: (input: number) => number | null; default: not declared - winsorize.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - winsorize.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - winsorize.stream().return.value: number | null; default: not declared - winsorize.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').WinsorizeParameters | undefined; default: not declared - winsorize.stream(parameters).lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - winsorize.stream(parameters).period?: number; default: not declared - winsorize.stream(parameters).upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. - wma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - wma(input): ArrayLike; default: not declared - wma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - wma(parameters).period: number; default: not declared - wma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - wma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - wma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - wma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - wma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - wma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - wma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - wma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - wma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - wma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - wma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - wma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - wma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - wma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - wma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - wma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - wma.explain(input): ArrayLike; default: not declared - wma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - wma.explain(parameters).period: number; default: not declared - wma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - wma.fromJSON().return.next: (input: number) => number | null; default: not declared - wma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - wma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - wma.fromJSON().return.value: number | null; default: not declared - wma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - wma.fromJSON(snapshot).kind: string; default: not declared - wma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - wma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - wma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - wma.stream().return.next: (input: number) => number | null; default: not declared - wma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - wma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - wma.stream().return.value: number | null; default: not declared - wma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - wma.stream(parameters).period: number; default: not declared - yangZhang: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - yangZhang(input): ArrayLike; default: not declared - yangZhang(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - yangZhang(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - yangZhang(parameters).period: number; default: not declared - yangZhang.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - yangZhang.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - yangZhang.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - yangZhang.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - yangZhang.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - yangZhang.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - yangZhang.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - yangZhang.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - yangZhang.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - yangZhang.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - yangZhang.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - yangZhang.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - yangZhang.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - yangZhang.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - yangZhang.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - yangZhang.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - yangZhang.explain(input): ArrayLike; default: not declared - yangZhang.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - yangZhang.explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - yangZhang.explain(parameters).period: number; default: not declared - yangZhang.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - yangZhang.fromJSON().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - yangZhang.fromJSON().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - yangZhang.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - yangZhang.fromJSON().return.value: number | null; default: not declared - yangZhang.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - yangZhang.fromJSON(snapshot).kind: string; default: not declared - yangZhang.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - yangZhang.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - yangZhang.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - yangZhang.stream().return.next: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared - yangZhang.stream().return.peek: (input: import('@insiderfinance/totalfinance/technical-analysis').BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - yangZhang.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - yangZhang.stream().return.value: number | null; default: not declared - yangZhang.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').RangeVolatilityParameters | undefined; default: not declared - yangZhang.stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - yangZhang.stream(parameters).period: number; default: not declared - zScore: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; default: not declared — Rolling z-score: `(value − mean) / populationStd` over the window (0 on a flat window). - zScore(input): ArrayLike; default: not declared - zScore(parameters)?: { period?: number; } | undefined; default: not declared - zScore(parameters).period?: number; default: not declared - zScore.explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - zScore.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - zScore.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - zScore.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - zScore.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - zScore.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - zScore.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - zScore.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - zScore.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - zScore.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - zScore.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - zScore.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - zScore.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - zScore.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - zScore.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - zScore.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - zScore.explain(input): ArrayLike; default: not declared - zScore.explain(parameters)?: { period?: number; } | undefined; default: not declared - zScore.explain(parameters).period?: number; default: not declared - zScore.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - zScore.fromJSON().return.next: (input: number) => number | null; default: not declared - zScore.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - zScore.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zScore.fromJSON().return.value: number | null; default: not declared - zScore.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zScore.fromJSON(snapshot).kind: string; default: not declared - zScore.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - zScore.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - zScore.stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - zScore.stream().return.next: (input: number) => number | null; default: not declared - zScore.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - zScore.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zScore.stream().return.value: number | null; default: not declared - zScore.stream(parameters)?: { period?: number; } | undefined; default: not declared - zScore.stream(parameters).period?: number; default: not declared - zigzag: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').ZigZagParameters) => import('@insiderfinance/totalfinance/technical-analysis/trend').ZigZagReport; default: not declared — ZigZag pivots: alternating swing highs and lows that each reverse price by at least `deviation`%. The last pivot is provisional — a larger move can still extend the final leg — so it is flagged via `provisional`. ZigZag repaints by nature; it is a batch utility, not a streaming indicator. - zigzag().return.assumptions: { conventionsVersion: string; deviation: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - zigzag().return.assumptions.conventionsVersion: string; default: not declared - zigzag().return.assumptions.deviation: number; default: not declared - zigzag().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - zigzag().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - zigzag().return.pivots: import('@insiderfinance/totalfinance/technical-analysis').ZigZagPivot[]; default: not declared - zigzag().return.provisional: boolean; default: not declared — The last pivot is provisional — a larger move can still extend the final leg. - zigzag(bars): ArrayLike; default: not declared - zigzag(parameters): import('@insiderfinance/totalfinance/technical-analysis').ZigZagParameters; default: not declared - zigzag(parameters).deviation: number; default: not declared — Minimum reversal as a percentage of price (e.g. 5 = 5%). - zlema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - zlema(input): ArrayLike; default: not declared - zlema(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - zlema(parameters).period: number; default: not declared - zlema.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - zlema.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - zlema.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - zlema.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - zlema.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - zlema.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - zlema.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - zlema.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - zlema.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - zlema.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - zlema.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - zlema.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - zlema.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - zlema.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - zlema.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - zlema.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - zlema.explain(input): ArrayLike; default: not declared - zlema.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - zlema.explain(parameters).period: number; default: not declared - zlema.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - zlema.fromJSON().return.next: (input: number) => number | null; default: not declared - zlema.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - zlema.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zlema.fromJSON().return.value: number | null; default: not declared - zlema.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zlema.fromJSON(snapshot).kind: string; default: not declared - zlema.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - zlema.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - zlema.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - zlema.stream().return.next: (input: number) => number | null; default: not declared - zlema.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - zlema.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zlema.stream().return.value: number | null; default: not declared - zlema.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - zlema.stream(parameters).period: number; default: not declared - zlma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared — Zero-lag EMA — alias of `zlema`. - zlma(input): ArrayLike; default: not declared - zlma(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - zlma(parameters).period: number; default: not declared - zlma.explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - zlma.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - zlma.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - zlma.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - zlma.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - zlma.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - zlma.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - zlma.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - zlma.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - zlma.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - zlma.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - zlma.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - zlma.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - zlma.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - zlma.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - zlma.explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - zlma.explain(input): ArrayLike; default: not declared - zlma.explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - zlma.explain(parameters).period: number; default: not declared - zlma.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - zlma.fromJSON().return.next: (input: number) => number | null; default: not declared - zlma.fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - zlma.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zlma.fromJSON().return.value: number | null; default: not declared - zlma.fromJSON(snapshot): import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zlma.fromJSON(snapshot).kind: string; default: not declared - zlma.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - zlma.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - zlma.stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - zlma.stream().return.next: (input: number) => number | null; default: not declared - zlma.stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - zlma.stream().return.toJSON: () => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot; default: not declared - zlma.stream().return.value: number | null; default: not declared - zlma.stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - zlma.stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance#valuation Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const valuation: typeof import('@insiderfinance/totalfinance/valuation'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustedPresentValue: (input: import('@insiderfinance/totalfinance/valuation').AdjustedPresentValueInput) => import('@insiderfinance/totalfinance/valuation').AdjustedPresentValueResult; default: not declared — Adjusted present value: the unlevered operating value at the unlevered cost of capital PLUS the present value of each financing side effect at its own declared rate. The decomposition is the result — nothing is netted away silently. - adjustedPresentValue().return.adjustedPresentValue: number; default: not declared — `unleveredValue + Σ side-effect present values`. - adjustedPresentValue().return.assumptions: { unleveredCostOfCapital: number; compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; sideEffectCount: number; }; default: not declared - adjustedPresentValue().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — The one compounding convention every leg was discounted under. - adjustedPresentValue().return.assumptions.sideEffectCount: number; default: not declared - adjustedPresentValue().return.assumptions.unleveredCostOfCapital: number; default: not declared - adjustedPresentValue().return.diagnostics: { warnings: string[]; }; default: not declared - adjustedPresentValue().return.diagnostics.warnings: string[]; default: not declared - adjustedPresentValue().return.financingSideEffects: import('@insiderfinance/totalfinance/valuation').FinancingSideEffectValue[]; default: not declared — Each side effect's present value at ITS OWN rate, in input order. - adjustedPresentValue().return.unleveredValue: number; default: not declared — Present value of the unlevered operating flows at `unleveredCostOfCapital`. - adjustedPresentValue(input): import('@insiderfinance/totalfinance/valuation').AdjustedPresentValueInput; default: not declared - adjustedPresentValue(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `assumptions.compounding`. - adjustedPresentValue(input).financingSideEffects: readonly import('@insiderfinance/totalfinance/valuation').FinancingSideEffect[]; default: not declared — May be empty — "no side effects" is an explicit statement, not an omission. - adjustedPresentValue(input).unleveredCashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared — The unlevered (all-equity) operating cash flows, `timeYears: 0` being the valuation instant. - adjustedPresentValue(input).unleveredCostOfCapital: number; default: not declared — Annual rate (decimal, > −1) for the UNLEVERED operating flows. - afterTaxCostOfDebt: (input: import('@insiderfinance/totalfinance/valuation').AfterTaxCostOfDebtInput) => number; default: not declared — After-tax cost of debt = annual pre-tax cost × (1 − marginal tax rate), plus any EXPLICIT unusable-tax-shield adjustment. - afterTaxCostOfDebt(input): import('@insiderfinance/totalfinance/valuation').AfterTaxCostOfDebtInput; default: not declared - afterTaxCostOfDebt(input).annualPreTaxCostOfDebt: number; default: not declared — Annual pre-tax cost of debt (decimal). - afterTaxCostOfDebt(input).marginalTaxRate: number; default: not declared — Marginal tax rate in [0, 1). - afterTaxCostOfDebt(input).unusableTaxShieldAdjustment?: number; default: not declared — An EXPLICIT adjustment (decimal, added to the after-tax cost) for a tax shield the company cannot use — supplied, never inferred from losses or carryforwards. - amortizationSchedule: (input: import('@insiderfinance/totalfinance/valuation').AmortizationScheduleInput) => import('@insiderfinance/totalfinance/valuation').AmortizationScheduleResult; default: not declared — The full amortization schedule. Unrounded binary64 values reconcile within arithmetic precision (closing balance = opening − principal; Σ principal ≈ principal − balloon) and any display rounding is the caller's explicit, documented policy applied afterwards. The final installment may absorb arithmetic drift only within a compounding-propagated roundoff allowance, capped at 1e-10 of original principal; larger drift is refused. The `payment` headline is the level installment; inspect the final row's payment for its explicit roundoff reconciliation. - amortizationSchedule().return.balloon: number; default: not declared — The requested residual after the final, roundoff-adjusted installment. - amortizationSchedule().return.payment: number; default: not declared — Level payment; the final row may differ by the documented binary64 reconciliation drift. - amortizationSchedule().return.rounding: 'none'; default: not declared — This schedule is UNROUNDED: display rounding is the caller's explicit policy. - amortizationSchedule().return.rows: import('@insiderfinance/totalfinance/valuation').AmortizationRow[]; default: not declared - amortizationSchedule().return.totalInterest: number; default: not declared - amortizationSchedule().return.totalPrincipal: number; default: not declared - amortizationSchedule(input): import('@insiderfinance/totalfinance/valuation').AmortizationScheduleInput; default: not declared - amortizationSchedule(input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - amortizationSchedule(input).numberOfPeriods: number; default: not declared - amortizationSchedule(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - amortizationSchedule(input).periodicFee?: number; default: not declared — A flat per-period fee, reported per row (never folded into interest). - amortizationSchedule(input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - amortizationSchedule(input).principal: number; default: not declared — Amount borrowed (positive). - annuityPayment: (input: import('@insiderfinance/totalfinance/valuation').LoanTermsInput) => number; default: not declared — The level payment that amortizes `principal` down to `balloon` over `numberOfPeriods` at the periodic rate, under the explicit payment timing. Positive for every nonnegative-rate loan; SIGNED in general — a negative periodic rate can decay the principal below a balloon on its own, making the level payment zero or negative (the lender pays the borrower to hold the schedule to its residual). A payment the arithmetic cannot represent (IEEE-754 overflow at extreme magnitudes) is a typed refusal, never Infinity/NaN (2026-08-23 review, finding 1). - annuityPayment(input): import('@insiderfinance/totalfinance/valuation').LoanTermsInput; default: not declared - annuityPayment(input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - annuityPayment(input).numberOfPeriods: number; default: not declared - annuityPayment(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - annuityPayment(input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - annuityPayment(input).principal: number; default: not declared — Amount borrowed (positive). - capitalAssetPricingExpectedReturn: (input: import('@insiderfinance/totalfinance/valuation').CapitalAssetPricingInput) => number; default: not declared — Capital-asset-pricing expected return = annual risk-free rate + beta × annual market risk premium. The premium is supplied AS a premium — passing the market return here would double the risk-free rate, so the field name says exactly which number it wants. - capitalAssetPricingExpectedReturn(input): import('@insiderfinance/totalfinance/valuation').CapitalAssetPricingInput; default: not declared - capitalAssetPricingExpectedReturn(input).annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - capitalAssetPricingExpectedReturn(input).annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - capitalAssetPricingExpectedReturn(input).beta: number; default: not declared - comparableCompanyValuation: (input: import('@insiderfinance/totalfinance/valuation').ComparableCompanyValuationInput) => import('@insiderfinance/totalfinance/valuation').ComparableCompanyValuationResult; default: not declared — Comparable-company valuation: apply the EXPLICIT outlier policy to the peer multiples, aggregate the survivors under the declared method, and price the subject's metric on the declared enterprise/equity basis. Every excluded peer is named with the reason; the metric definition, period, basis, aggregation, policy, and normalized weights are all echoed in the result. - comparableCompanyValuation().return.aggregatedMultiple: number; default: not declared - comparableCompanyValuation().return.aggregation: import('@insiderfinance/totalfinance/valuation').ComparableAggregation; default: not declared - comparableCompanyValuation().return.assumptions: { outlierPolicy: import('@insiderfinance/totalfinance/valuation').ComparableOutlierPolicy; weightsNormalized?: number[]; }; default: not declared - comparableCompanyValuation().return.assumptions.outlierPolicy: import('@insiderfinance/totalfinance/valuation').ComparableOutlierPolicy; default: not declared — The outlier policy as requested — echoed so the record is self-describing. - comparableCompanyValuation().return.assumptions.weightsNormalized?: number[]; default: not declared — Present only under `'weighted-mean'`: the normalized weights, aligned with `peersUsed`. - comparableCompanyValuation().return.diagnostics: { warnings: string[]; }; default: not declared - comparableCompanyValuation().return.diagnostics.warnings: string[]; default: not declared — One warning per excluded peer. - comparableCompanyValuation().return.impliedValue: number; default: not declared — `aggregatedMultiple × subjectMetricAmount`, on the declared `valuationBasis`. - comparableCompanyValuation().return.metricDefinition: string; default: not declared - comparableCompanyValuation().return.metricName: string; default: not declared - comparableCompanyValuation().return.peersExcluded: import('@insiderfinance/totalfinance/valuation').ComparablePeerExcluded[]; default: not declared — The peers the outlier policy excluded, in input order, each with its reason. - comparableCompanyValuation().return.peersUsed: import('@insiderfinance/totalfinance/valuation').ComparablePeerUsed[]; default: not declared — The peers that survived the outlier policy, in input order. - comparableCompanyValuation().return.period: string; default: not declared - comparableCompanyValuation().return.valuationBasis: import('@insiderfinance/totalfinance/valuation').ComparableValuationBasis; default: not declared - comparableCompanyValuation(input): import('@insiderfinance/totalfinance/valuation').ComparableCompanyValuationInput; default: not declared - comparableCompanyValuation(input).aggregation: import('@insiderfinance/totalfinance/valuation').ComparableAggregation; default: not declared - comparableCompanyValuation(input).metricDefinition: string; default: not declared — What the metric MEANS (e.g. `'enterprise value over trailing-twelve-month EBITDA'`). - comparableCompanyValuation(input).metricName: string; default: not declared — The metric's name (e.g. `'EV/EBITDA'`). Recorded, never inferred. - comparableCompanyValuation(input).outlierPolicy: import('@insiderfinance/totalfinance/valuation').ComparableOutlierPolicy; default: not declared — REQUIRED — an unstated outlier policy is a silent default. Use `{ method: 'none' }` to keep all. - comparableCompanyValuation(input).peers: readonly import('@insiderfinance/totalfinance/valuation').ComparablePeer[]; default: not declared - comparableCompanyValuation(input).period: string; default: not declared — The period the metric covers (e.g. `'TTM 2025-Q4'`). Recorded, never inferred. - comparableCompanyValuation(input).subjectMetricAmount: number; default: not declared — The subject company's metric amount the aggregated multiple is applied to. - comparableCompanyValuation(input).valuationBasis: import('@insiderfinance/totalfinance/valuation').ComparableValuationBasis; default: not declared — `'enterprise'` when the multiple prices the firm, `'equity'` when it prices the equity. - comparableCompanyValuation(input).weights?: readonly number[]; default: not declared — Peer weights, REQUIRED for (and only valid with) `'weighted-mean'`, one per peer in peer order. Each must be a finite number > 0; they need not sum to 1 — they are normalized and the normalized weights are echoed in `assumptions.weightsNormalized`. - convertPriceLevel: { (input: import('@insiderfinance/totalfinance/valuation').ConvertPriceLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').ConvertPriceLevelInput) => import('@insiderfinance/totalfinance/core').Computed; }; default: not declared — Map a source price level to an approximate target level in the supplied target price unit. Reference mode: `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Ratio mode: `sourcePriceLevel * targetPricePerSourcePrice` (target units per source unit). To invert, swap source/target references and unit labels, or supply the reciprocal ratio. Inputs are closed and validated on both calls; prices/ratios must be finite and positive, except the requested level may be zero. No cents/tick rounding or instrument inference occurs. Overflow and positive underflow to zero throw typed `input.out_of_range` errors. Unit labels are optional descriptive metadata, not financial defaults or conversion factors. `.explain()` echoes supplied metadata; resultUnit is null when targetPriceUnit is omitted. It assumes that the proportional mapping remains valid at the requested level. This approximation is not a live quote, predicted ETF open, arbitrage/fair-value result, option premium or notional/delta hedge. The caller supplies comparable references and freshness policy. For named pairs, start with helpers such as `esToSpyLevel` or `nqToQqqLevel`; they need only three named prices. - convertPriceLevel(input): import('@insiderfinance/totalfinance/valuation').ConvertPriceLevelInput; default: not declared - convertPriceLevel(input).method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - convertPriceLevel(input).referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - convertPriceLevel(input).referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - convertPriceLevel(input).sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - convertPriceLevel(input).sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - convertPriceLevel(input).targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - convertPriceLevel(input).targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - convertPriceLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').ConvertPriceLevelInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Same closed input and arithmetic; echoes the method, units, references/ratio and limitations. - convertPriceLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - convertPriceLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - convertPriceLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - convertPriceLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - convertPriceLevel.explain(input): import('@insiderfinance/totalfinance/valuation').ConvertPriceLevelInput; default: not declared - convertPriceLevel.explain(input).method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - convertPriceLevel.explain(input).referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - convertPriceLevel.explain(input).referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - convertPriceLevel.explain(input).sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - convertPriceLevel.explain(input).sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - convertPriceLevel.explain(input).targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - convertPriceLevel.explain(input).targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - costOfEquity: (input: import('@insiderfinance/totalfinance/valuation').CostOfEquityInput) => number; default: not declared — Cost of equity under an EXPLICIT method: `'capital-asset-pricing'` (risk-free + beta × premium) or `'dividend-growth'` (next dividend / price + growth). The dividend-growth form requires a positive share price and takes the NEXT dividend — the field name carries the timing so the one-period growth step is never applied twice or forgotten. - costOfEquity(input): import('@insiderfinance/totalfinance/valuation').CostOfEquityInput; default: not declared - costOfEquity(input).annualMarketRiskPremium: number; default: not declared - costOfEquity(input).annualRiskFreeRate: number; default: not declared - costOfEquity(input).beta: number; default: not declared - costOfEquity(input).method: ('capital-asset-pricing') | ('dividend-growth'); default: not declared - costOfEquity(input).nextAnnualDividendPerShare: number; default: not declared — The NEXT annual dividend per share (already grown one period). - costOfEquity(input).perpetualGrowthRate: number; default: not declared - costOfEquity(input).sharePrice: number; default: not declared - cumulativeLoanInterest: (input: import('@insiderfinance/totalfinance/valuation').LoanRangeInput) => number; default: not declared — Total interest across an inclusive period range — SIGNED: positive for a nonnegative rate, negative when the periodic rate is negative (interest credited to the borrower). - cumulativeLoanInterest(input): import('@insiderfinance/totalfinance/valuation').LoanRangeInput; default: not declared - cumulativeLoanInterest(input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - cumulativeLoanInterest(input).fromPeriod: number; default: not declared — 1-based first period, inclusive. - cumulativeLoanInterest(input).numberOfPeriods: number; default: not declared - cumulativeLoanInterest(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - cumulativeLoanInterest(input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - cumulativeLoanInterest(input).principal: number; default: not declared — Amount borrowed (positive). - cumulativeLoanInterest(input).toPeriod: number; default: not declared — 1-based last period, inclusive. - cumulativeLoanPrincipal: (input: import('@insiderfinance/totalfinance/valuation').LoanRangeInput) => number; default: not declared — Total balance reduction across an inclusive period range — SIGNED: exceeds the payments made when the periodic rate is negative (each period's principal component exceeds its payment). - cumulativeLoanPrincipal(input): import('@insiderfinance/totalfinance/valuation').LoanRangeInput; default: not declared - cumulativeLoanPrincipal(input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - cumulativeLoanPrincipal(input).fromPeriod: number; default: not declared — 1-based first period, inclusive. - cumulativeLoanPrincipal(input).numberOfPeriods: number; default: not declared - cumulativeLoanPrincipal(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - cumulativeLoanPrincipal(input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - cumulativeLoanPrincipal(input).principal: number; default: not declared — Amount borrowed (positive). - cumulativeLoanPrincipal(input).toPeriod: number; default: not declared — 1-based last period, inclusive. - datedInternalRateOfReturn: ((input: import('@insiderfinance/totalfinance/valuation').DatedInternalRateOfReturnInput) => number | null) & { explain: (input: import('@insiderfinance/totalfinance/valuation').DatedInternalRateOfReturnInput) => import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnReport; }; default: not declared — The dated internal rate of return AT `asOf` — historical flows accumulate forward, future flows discount back, under one declared convention. `null` on no root or ambiguity; `.explain()` carries every root. - datedInternalRateOfReturn(input): import('@insiderfinance/totalfinance/valuation').DatedInternalRateOfReturnInput; default: not declared - datedInternalRateOfReturn(input).asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date; flows before it ACCUMULATE forward, never drop. - datedInternalRateOfReturn(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').DatedCashFlow[]; default: not declared - datedInternalRateOfReturn(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - datedInternalRateOfReturn(input).dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed in `.explain()`. - datedInternalRateOfReturn.explain: (input: import('@insiderfinance/totalfinance/valuation').DatedInternalRateOfReturnInput) => import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnReport; default: not declared - datedInternalRateOfReturn.explain().return.assumptions: { conventionsVersion: string; compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; dayCount?: import('@insiderfinance/totalfinance/core').DayCount; asOf?: string; searchRange: { from: number; to: number; }; }; default: not declared - datedInternalRateOfReturn.explain().return.assumptions.asOf?: string; default: not declared — Present only on the dated head. - datedInternalRateOfReturn.explain().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - datedInternalRateOfReturn.explain().return.assumptions.conventionsVersion: string; default: not declared - datedInternalRateOfReturn.explain().return.assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Present only on the dated head. - datedInternalRateOfReturn.explain().return.assumptions.searchRange: { from: number; to: number; }; default: not declared - datedInternalRateOfReturn.explain().return.assumptions.searchRange.from: number; default: not declared - datedInternalRateOfReturn.explain().return.assumptions.searchRange.to: number; default: not declared - datedInternalRateOfReturn.explain().return.diagnostics: { method: 'scan-bisect'; converged: boolean; iterations: number; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - datedInternalRateOfReturn.explain().return.diagnostics.converged: boolean; default: not declared - datedInternalRateOfReturn.explain().return.diagnostics.iterations: number; default: not declared - datedInternalRateOfReturn.explain().return.diagnostics.method: 'scan-bisect'; default: not declared - datedInternalRateOfReturn.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - datedInternalRateOfReturn.explain().return.roots: import('@insiderfinance/totalfinance/valuation').InternalRateRoot[]; default: not declared — EVERY economically admissible root found in the search range. - datedInternalRateOfReturn.explain().return.value: number | null; default: not declared — The plain call's answer: the single root, or null when none or many. - datedInternalRateOfReturn.explain(input): import('@insiderfinance/totalfinance/valuation').DatedInternalRateOfReturnInput; default: not declared - datedInternalRateOfReturn.explain(input).asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date; flows before it ACCUMULATE forward, never drop. - datedInternalRateOfReturn.explain(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').DatedCashFlow[]; default: not declared - datedInternalRateOfReturn.explain(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - datedInternalRateOfReturn.explain(input).dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed in `.explain()`. - datedNetPresentValue: (input: import('@insiderfinance/totalfinance/valuation').DatedNetPresentValueInput) => number; default: not declared — Dated net present value AT `asOf`. Future flows discount back and HISTORICAL flows accumulate forward under the same declared convention — a realized flow is never discarded merely because it precedes the valuation date. A flow ON `asOf` enters at face value, exactly once. - datedNetPresentValue(input): import('@insiderfinance/totalfinance/valuation').DatedNetPresentValueInput; default: not declared - datedNetPresentValue(input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - datedNetPresentValue(input).asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date. - datedNetPresentValue(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').DatedCashFlow[]; default: not declared - datedNetPresentValue(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - datedNetPresentValue(input).dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed. - decliningBalanceDepreciation: (input: import('@insiderfinance/totalfinance/valuation').DecliningBalanceInput) => number; default: not declared — Declining-balance charge in `period` at the explicit `factor`, floored at salvage. - decliningBalanceDepreciation(input): import('@insiderfinance/totalfinance/valuation').DecliningBalanceInput; default: not declared - decliningBalanceDepreciation(input).cost: number; default: not declared — Acquisition cost (positive). - decliningBalanceDepreciation(input).factor: number; default: not declared — The declining-balance factor (e.g. `1.5`); double-declining uses its own head. - decliningBalanceDepreciation(input).period: number; default: not declared — 1-based period being asked about. - decliningBalanceDepreciation(input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - decliningBalanceDepreciation(input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). - diaToDjiaLevel: { (input: import('@insiderfinance/totalfinance/valuation').DiaToDjiaLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').DiaToDjiaLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate DJIA level corresponding to the supplied DIA level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - diaToDjiaLevel(input): import('@insiderfinance/totalfinance/valuation').DiaToDjiaLevelInput; default: not declared - diaToDjiaLevel(input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - diaToDjiaLevel(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - diaToDjiaLevel(input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - diaToDjiaLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').DiaToDjiaLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - diaToDjiaLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - diaToDjiaLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diaToDjiaLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - diaToDjiaLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - diaToDjiaLevel.explain(input): import('@insiderfinance/totalfinance/valuation').DiaToDjiaLevelInput; default: not declared - diaToDjiaLevel.explain(input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - diaToDjiaLevel.explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - diaToDjiaLevel.explain(input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - diaToYmLevel: { (input: import('@insiderfinance/totalfinance/valuation').DiaToYmLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').DiaToYmLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate YM level corresponding to the supplied DIA level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - diaToYmLevel(input): import('@insiderfinance/totalfinance/valuation').DiaToYmLevelInput; default: not declared - diaToYmLevel(input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - diaToYmLevel(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - diaToYmLevel(input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - diaToYmLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').DiaToYmLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - diaToYmLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - diaToYmLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diaToYmLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - diaToYmLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - diaToYmLevel.explain(input): import('@insiderfinance/totalfinance/valuation').DiaToYmLevelInput; default: not declared - diaToYmLevel.explain(input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - diaToYmLevel.explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - diaToYmLevel.explain(input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - discountCashFlows: (input: import('@insiderfinance/totalfinance/valuation').DiscountCashFlowsInput) => { rows: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowRow[]; presentValueTotal: number; }; default: not declared — Discount each flow individually (a supplied time-zero flow discounts by exactly 1 — included once, never inferred). Rows preserve input order; `presentValueTotal` is their sum. - discountCashFlows().return.presentValueTotal: number; default: not declared - discountCashFlows().return.rows: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowRow[]; default: not declared - discountCashFlows(input): import('@insiderfinance/totalfinance/valuation').DiscountCashFlowsInput; default: not declared - discountCashFlows(input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - discountCashFlows(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - discountCashFlows(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - discountedCashFlow: (input: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowInput) => import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; default: not declared — The direct DCF: explicit projections, explicit conventions, explicit terminal method. The top-level `annualDiscountRate` feeds the terminal primitive too, so a caller never repeats the rate inside the terminal method. Firm basis returns enterprise value (equity only across a supplied bridge); equity basis returns equity value directly. - discountedCashFlow(input): import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowInput; default: not declared - discountedCashFlow(input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - discountedCashFlow(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - discountedCashFlow(input).currency: string; default: not declared - discountedCashFlow(input).dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - discountedCashFlow(input).dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - discountedCashFlow(input).enterpriseToEquityBridge?: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - discountedCashFlow(input).projectedCashFlows: import('@insiderfinance/totalfinance/valuation').ProjectedCashFlowSchedule; default: not declared - discountedCashFlow(input).provenance?: import('@insiderfinance/totalfinance/valuation').ValuationProvenance; default: not declared - discountedCashFlow(input).terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - discountedCashFlow(input).valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - discountedCashFlow(input).valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - discountedCashFlowFromStatements: (input: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowFromStatementsInput) => import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowFromStatementsResult; default: not declared — The composition the acceptance law names: project the statements, take the emitted FCFF (firm basis) or FCFE (equity basis) at whole-year offsets, and hand them to the direct {@link discountedCashFlow} — so the composed valuation IS a direct valuation of the projected flows, reproducible by construction. - discountedCashFlowFromStatements().return.assumptions: { cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; projectedPeriodCount: number; }; default: not declared - discountedCashFlowFromStatements().return.assumptions.cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; default: not declared — Which flow column fed the valuation, decided by the basis — never relabeled. - discountedCashFlowFromStatements().return.assumptions.projectedPeriodCount: number; default: not declared - discountedCashFlowFromStatements().return.cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; default: not declared — Which flow column fed the valuation, decided by the valuation basis — never relabeled. - discountedCashFlowFromStatements().return.diagnostics: { warnings: string[]; }; default: not declared - discountedCashFlowFromStatements().return.diagnostics.warnings: string[]; default: not declared - discountedCashFlowFromStatements().return.projection: import('@insiderfinance/totalfinance/valuation').ProjectStatementsResult; default: not declared - discountedCashFlowFromStatements().return.valuation: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; default: not declared - discountedCashFlowFromStatements(input): import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowFromStatementsInput; default: not declared - discountedCashFlowFromStatements(input).projection: import('@insiderfinance/totalfinance/valuation').ProjectStatementsInput; default: not declared — The statement projection (see {@link projectFinancialStatements}). - discountedCashFlowFromStatements(input).valuation: Omit; default: not declared — Everything the direct DCF needs EXCEPT the flows — those come from the projection. - discountedCashFlowFromStatements(input).valuation.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - discountedCashFlowFromStatements(input).valuation.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - discountedCashFlowFromStatements(input).valuation.currency: string; default: not declared - discountedCashFlowFromStatements(input).valuation.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - discountedCashFlowFromStatements(input).valuation.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - discountedCashFlowFromStatements(input).valuation.enterpriseToEquityBridge?: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - discountedCashFlowFromStatements(input).valuation.provenance?: import('@insiderfinance/totalfinance/valuation').ValuationProvenance; default: not declared - discountedCashFlowFromStatements(input).valuation.terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - discountedCashFlowFromStatements(input).valuation.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - discountedCashFlowFromStatements(input).valuation.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - discountedCashFlowScenarioAnalysis: (input: import('@insiderfinance/totalfinance/valuation').ScenarioAnalysisInput) => import('@insiderfinance/totalfinance/valuation').ScenarioAnalysisResult; default: not declared — Named deterministic assumption sets over one base case. Each scenario is the base input with ONLY its stated overrides replaced — scenario values are supplied, never invented — and each result is a direct {@link discountedCashFlow} call. - discountedCashFlowScenarioAnalysis().return.assumptions: { scenarioNames: string[]; }; default: not declared - discountedCashFlowScenarioAnalysis().return.assumptions.scenarioNames: string[]; default: not declared - discountedCashFlowScenarioAnalysis().return.baseCase: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; default: not declared - discountedCashFlowScenarioAnalysis().return.diagnostics: { warnings: string[]; }; default: not declared - discountedCashFlowScenarioAnalysis().return.diagnostics.warnings: string[]; default: not declared - discountedCashFlowScenarioAnalysis().return.scenarios: { scenarioName: string; overriddenFields: string[]; result: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; }[]; default: not declared - discountedCashFlowScenarioAnalysis(input): import('@insiderfinance/totalfinance/valuation').ScenarioAnalysisInput; default: not declared - discountedCashFlowScenarioAnalysis(input).discountedCashFlowInput: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowInput; default: not declared - discountedCashFlowScenarioAnalysis(input).scenarios: readonly import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowScenario[]; default: not declared - discountedCashFlowSensitivityTable: (input: import('@insiderfinance/totalfinance/valuation').SensitivityTableInput) => import('@insiderfinance/totalfinance/valuation').SensitivityTableResult; default: not declared — A two-axis sensitivity table where EVERY cell is a direct {@link discountedCashFlow} call with exactly one row and one column value substituted — no incremental shortcuts, so the equality the acceptance law demands holds by construction. The base case is retained unmodified. - discountedCashFlowSensitivityTable().return.assumptions: { rowVariable: import('@insiderfinance/totalfinance/valuation').SensitivityAxis['variable']; rowUnit: string; columnVariable: import('@insiderfinance/totalfinance/valuation').SensitivityAxis['variable']; columnUnit: string; cellValue: 'enterpriseValue' | 'equityValue'; }; default: not declared - discountedCashFlowSensitivityTable().return.assumptions.cellValue: 'enterpriseValue' | 'equityValue'; default: not declared - discountedCashFlowSensitivityTable().return.assumptions.columnUnit: string; default: not declared - discountedCashFlowSensitivityTable().return.assumptions.columnVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - discountedCashFlowSensitivityTable().return.assumptions.rowUnit: string; default: not declared - discountedCashFlowSensitivityTable().return.assumptions.rowVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - discountedCashFlowSensitivityTable().return.baseCase: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; default: not declared — The unmodified base case, retained. - discountedCashFlowSensitivityTable().return.cellValue: 'enterpriseValue' | 'equityValue'; default: not declared — The value each cell reports: enterprise value (firm basis) or equity value (equity basis). - discountedCashFlowSensitivityTable().return.cells: number[][]; default: not declared — `cells[rowIndex][columnIndex]` — each PROVEN equal to a direct DCF call by construction. - discountedCashFlowSensitivityTable().return.columnUnit: string; default: not declared - discountedCashFlowSensitivityTable().return.columnValues: number[]; default: not declared - discountedCashFlowSensitivityTable().return.columnVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - discountedCashFlowSensitivityTable().return.diagnostics: { warnings: string[]; }; default: not declared - discountedCashFlowSensitivityTable().return.diagnostics.warnings: string[]; default: not declared - discountedCashFlowSensitivityTable().return.rowUnit: string; default: not declared — The unit of the row/column values, stated. - discountedCashFlowSensitivityTable().return.rowValues: number[]; default: not declared - discountedCashFlowSensitivityTable().return.rowVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - discountedCashFlowSensitivityTable(input): import('@insiderfinance/totalfinance/valuation').SensitivityTableInput; default: not declared - discountedCashFlowSensitivityTable(input).columnAxis: import('@insiderfinance/totalfinance/valuation').SensitivityAxis; default: not declared - discountedCashFlowSensitivityTable(input).discountedCashFlowInput: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowInput; default: not declared - discountedCashFlowSensitivityTable(input).rowAxis: import('@insiderfinance/totalfinance/valuation').SensitivityAxis; default: not declared - discountedPaybackPeriod: (input: import('@insiderfinance/totalfinance/valuation').DiscountedPaybackInput) => number | null; default: not declared — {@link paybackPeriod} on DISCOUNTED flows — the recovery clock respects the time value. - discountedPaybackPeriod(input): import('@insiderfinance/totalfinance/valuation').DiscountedPaybackInput; default: not declared - discountedPaybackPeriod(input).annualDiscountRate: number; default: not declared — Annual rate (decimal). - discountedPaybackPeriod(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - discountedPaybackPeriod(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - dividendDiscountValuation: (input: import('@insiderfinance/totalfinance/valuation').DividendDiscountInput) => import('@insiderfinance/totalfinance/valuation').DividendDiscountResult; default: not declared — Present value of explicit projected dividends per share plus a terminal stage. With an EMPTY projection stage and a perpetual-growth terminal (its `terminalCashFlow` being the CURRENT annual dividend), this is exactly the Gordon growth model: `D0 × (1 + g) / (r − g)`. - dividendDiscountValuation().return.assumptions: { annualCostOfEquity: number; compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; terminalCashFlowConvention: 'final-forecast-period-flow'; }; default: not declared - dividendDiscountValuation().return.assumptions.annualCostOfEquity: number; default: not declared - dividendDiscountValuation().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - dividendDiscountValuation().return.assumptions.terminalCashFlowConvention: 'final-forecast-period-flow'; default: not declared - dividendDiscountValuation().return.assumptions.terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - dividendDiscountValuation().return.diagnostics: { warnings: string[]; }; default: not declared - dividendDiscountValuation().return.diagnostics.warnings: string[]; default: not declared - dividendDiscountValuation().return.projectedDividendPresentValue: number; default: not declared - dividendDiscountValuation().return.rows: { timeYears: number; dividendPerShare: number; discountFactor: number; presentValue: number; }[]; default: not declared - dividendDiscountValuation().return.terminalValue: number; default: not declared - dividendDiscountValuation().return.terminalValuePresentValue: number; default: not declared - dividendDiscountValuation().return.valuePerShare: number; default: not declared - dividendDiscountValuation(input): import('@insiderfinance/totalfinance/valuation').DividendDiscountInput; default: not declared - dividendDiscountValuation(input).annualCostOfEquity: number; default: not declared — Annual cost of equity (decimal) — the discount rate for dividends. - dividendDiscountValuation(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - dividendDiscountValuation(input).projectedDividendsPerShare: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared — Explicit projected dividends PER SHARE (timed from today). An empty projection stage with a perpetual-growth terminal is the classic single-stage Gordon model. - dividendDiscountValuation(input).terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - djiaToDiaLevel: { (input: import('@insiderfinance/totalfinance/valuation').DjiaToDiaLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').DjiaToDiaLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate DIA level corresponding to the supplied DJIA level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - djiaToDiaLevel(input): import('@insiderfinance/totalfinance/valuation').DjiaToDiaLevelInput; default: not declared - djiaToDiaLevel(input).djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - djiaToDiaLevel(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - djiaToDiaLevel(input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - djiaToDiaLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').DjiaToDiaLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - djiaToDiaLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - djiaToDiaLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - djiaToDiaLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - djiaToDiaLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - djiaToDiaLevel.explain(input): import('@insiderfinance/totalfinance/valuation').DjiaToDiaLevelInput; default: not declared - djiaToDiaLevel.explain(input).djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - djiaToDiaLevel.explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - djiaToDiaLevel.explain(input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - doubleDecliningBalanceDepreciation: (input: import('@insiderfinance/totalfinance/valuation').DepreciationInput) => number; default: not declared — Double-declining balance: {@link decliningBalanceDepreciation} at factor 2. - doubleDecliningBalanceDepreciation(input): import('@insiderfinance/totalfinance/valuation').DepreciationInput; default: not declared - doubleDecliningBalanceDepreciation(input).cost: number; default: not declared — Acquisition cost (positive). - doubleDecliningBalanceDepreciation(input).period: number; default: not declared — 1-based period being asked about. - doubleDecliningBalanceDepreciation(input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - doubleDecliningBalanceDepreciation(input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). - effectiveAnnualRate: (input: import('@insiderfinance/totalfinance/valuation').EffectiveAnnualRateInput) => number; default: not declared — Effective annual rate: the one-year growth of the nominal rate under its convention, minus 1. - effectiveAnnualRate(input): import('@insiderfinance/totalfinance/valuation').EffectiveAnnualRateInput; default: not declared - effectiveAnnualRate(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a rate conversion never guesses its convention. - effectiveAnnualRate(input).nominalAnnualRate: number; default: not declared — Nominal (stated) annual rate (decimal). - enterpriseToEquityValue: (input: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityValueInput) => number; default: not declared — Equity value = enterprise value − total debt − preferred equity − minority interest + cash and cash equivalents + non-operating assets. The bridge is EXPLICIT: a field the company genuinely lacks is a stated zero, not an omission. - enterpriseToEquityValue(input): import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityValueInput; default: not declared - enterpriseToEquityValue(input).enterpriseToEquityBridge: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityBridge; default: not declared - enterpriseToEquityValue(input).enterpriseValue: number; default: not declared - equivalentAnnualAnnuity: (input: import('@insiderfinance/totalfinance/valuation').EquivalentAnnualAnnuityInput) => number; default: not declared — The level annual amount whose PV over `projectLifeYears` equals the project NPV — the standard yardstick for comparing projects of unequal length. The annuity factor honors the SAME declared `compounding` convention the NPV used: it is `Σ discountFactor(rate, t, compounding)` over the integer payment years `t = 1..projectLifeYears`, so discounting the returned annuity back over the project life under that convention recovers the NPV exactly. (Under `'annual'` the sum equals the classic closed-form annuity factor `(1 − (1 + r)^−L) / r`.) - equivalentAnnualAnnuity(input): import('@insiderfinance/totalfinance/valuation').EquivalentAnnualAnnuityInput; default: not declared - equivalentAnnualAnnuity(input).annualDiscountRate: number; default: not declared - equivalentAnnualAnnuity(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - equivalentAnnualAnnuity(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'`. - equivalentAnnualAnnuity(input).projectLifeYears: number; default: not declared — Project length in years (the annuity horizon). - equivalentInterestRate: (input: import('@insiderfinance/totalfinance/valuation').EquivalentInterestRateInput) => number; default: not declared — Re-express a rate in another convention so both produce the SAME one-year growth. - equivalentInterestRate(input): import('@insiderfinance/totalfinance/valuation').EquivalentInterestRateInput; default: not declared - equivalentInterestRate(input).annualInterestRate: number; default: not declared — Annual rate (decimal) quoted in `fromCompounding`. - equivalentInterestRate(input).fromCompounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED source convention. - equivalentInterestRate(input).toCompounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED target convention. - esToSpyLevel: { (input: import('@insiderfinance/totalfinance/valuation').EsToSpyLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').EsToSpyLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate SPY level corresponding to the supplied ES level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - esToSpyLevel(input): import('@insiderfinance/totalfinance/valuation').EsToSpyLevelInput; default: not declared - esToSpyLevel(input).esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - esToSpyLevel(input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - esToSpyLevel(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - esToSpyLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').EsToSpyLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - esToSpyLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - esToSpyLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - esToSpyLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - esToSpyLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - esToSpyLevel.explain(input): import('@insiderfinance/totalfinance/valuation').EsToSpyLevelInput; default: not declared - esToSpyLevel.explain(input).esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - esToSpyLevel.explain(input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - esToSpyLevel.explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - freeCashFlowToEquity: (input: import('@insiderfinance/totalfinance/valuation').FreeCashFlowToEquityInput) => number; default: not declared — FCFE = net income + depreciation/amortization − capital expenditure − increase in net working capital + net borrowing. - freeCashFlowToEquity(input): import('@insiderfinance/totalfinance/valuation').FreeCashFlowToEquityInput; default: not declared - freeCashFlowToEquity(input).capitalExpenditure: number; default: not declared - freeCashFlowToEquity(input).depreciationAndAmortization: number; default: not declared - freeCashFlowToEquity(input).increaseInNetWorkingCapital: number; default: not declared — The INCREASE in net working capital over the period (a decrease is negative). - freeCashFlowToEquity(input).netBorrowing: number; default: not declared — New borrowing minus repayments over the period. - freeCashFlowToEquity(input).netIncome: number; default: not declared - freeCashFlowToFirm: (input: import('@insiderfinance/totalfinance/valuation').FreeCashFlowToFirmInput) => number; default: not declared — FCFF = operating income × (1 − tax rate) + depreciation/amortization − capital expenditure − increase in net working capital. Wants OPERATING income — handing it net income double-counts interest, and the field name refuses the swap. - freeCashFlowToFirm(input): import('@insiderfinance/totalfinance/valuation').FreeCashFlowToFirmInput; default: not declared - freeCashFlowToFirm(input).capitalExpenditure: number; default: not declared - freeCashFlowToFirm(input).depreciationAndAmortization: number; default: not declared - freeCashFlowToFirm(input).increaseInNetWorkingCapital: number; default: not declared — The INCREASE in net working capital over the period (a decrease is negative). - freeCashFlowToFirm(input).operatingIncome: number; default: not declared - freeCashFlowToFirm(input).taxRate: number; default: not declared — Tax rate in [0, 1) applied to operating income. - futureValue: (input: import('@insiderfinance/totalfinance/valuation').FutureValueInput) => number; default: not declared — Future value of one present amount: `presentAmount · compoundFactor(rate, t, compounding)`. - futureValue(input): import('@insiderfinance/totalfinance/valuation').FutureValueInput; default: not declared - futureValue(input).annualInterestRate: number; default: not declared — Annual rate (decimal). - futureValue(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. - futureValue(input).presentAmount: number; default: not declared — The amount held at time zero. - futureValue(input).timeYears: number; default: not declared - internalRateOfReturn: ((input: import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnInput) => number | null) & { explain: (input: import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnInput) => import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnReport; }; default: not declared — The internal rate of return of explicit timed flows, or `null` when no admissible root exists or MORE THAN ONE does — an ambiguous IRR is never chosen silently. `.explain()` carries every root and the ambiguity warning. - internalRateOfReturn(input): import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnInput; default: not declared - internalRateOfReturn(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - internalRateOfReturn(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - internalRateOfReturn.explain: (input: import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnInput) => import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnReport; default: not declared - internalRateOfReturn.explain().return.assumptions: { conventionsVersion: string; compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; dayCount?: import('@insiderfinance/totalfinance/core').DayCount; asOf?: string; searchRange: { from: number; to: number; }; }; default: not declared - internalRateOfReturn.explain().return.assumptions.asOf?: string; default: not declared — Present only on the dated head. - internalRateOfReturn.explain().return.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - internalRateOfReturn.explain().return.assumptions.conventionsVersion: string; default: not declared - internalRateOfReturn.explain().return.assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Present only on the dated head. - internalRateOfReturn.explain().return.assumptions.searchRange: { from: number; to: number; }; default: not declared - internalRateOfReturn.explain().return.assumptions.searchRange.from: number; default: not declared - internalRateOfReturn.explain().return.assumptions.searchRange.to: number; default: not declared - internalRateOfReturn.explain().return.diagnostics: { method: 'scan-bisect'; converged: boolean; iterations: number; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - internalRateOfReturn.explain().return.diagnostics.converged: boolean; default: not declared - internalRateOfReturn.explain().return.diagnostics.iterations: number; default: not declared - internalRateOfReturn.explain().return.diagnostics.method: 'scan-bisect'; default: not declared - internalRateOfReturn.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - internalRateOfReturn.explain().return.roots: import('@insiderfinance/totalfinance/valuation').InternalRateRoot[]; default: not declared — EVERY economically admissible root found in the search range. - internalRateOfReturn.explain().return.value: number | null; default: not declared — The plain call's answer: the single root, or null when none or many. - internalRateOfReturn.explain(input): import('@insiderfinance/totalfinance/valuation').InternalRateOfReturnInput; default: not declared - internalRateOfReturn.explain(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - internalRateOfReturn.explain(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - iwmToRtyLevel: { (input: import('@insiderfinance/totalfinance/valuation').IwmToRtyLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').IwmToRtyLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate RTY level corresponding to the supplied IWM level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - iwmToRtyLevel(input): import('@insiderfinance/totalfinance/valuation').IwmToRtyLevelInput; default: not declared - iwmToRtyLevel(input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - iwmToRtyLevel(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - iwmToRtyLevel(input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - iwmToRtyLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').IwmToRtyLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - iwmToRtyLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - iwmToRtyLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - iwmToRtyLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - iwmToRtyLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - iwmToRtyLevel.explain(input): import('@insiderfinance/totalfinance/valuation').IwmToRtyLevelInput; default: not declared - iwmToRtyLevel.explain(input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - iwmToRtyLevel.explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - iwmToRtyLevel.explain(input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - iwmToRutLevel: { (input: import('@insiderfinance/totalfinance/valuation').IwmToRutLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').IwmToRutLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate RUT level corresponding to the supplied IWM level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - iwmToRutLevel(input): import('@insiderfinance/totalfinance/valuation').IwmToRutLevelInput; default: not declared - iwmToRutLevel(input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - iwmToRutLevel(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - iwmToRutLevel(input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - iwmToRutLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').IwmToRutLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - iwmToRutLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - iwmToRutLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - iwmToRutLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - iwmToRutLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - iwmToRutLevel.explain(input): import('@insiderfinance/totalfinance/valuation').IwmToRutLevelInput; default: not declared - iwmToRutLevel.explain(input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - iwmToRutLevel.explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - iwmToRutLevel.explain(input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - leveragedBuyoutAnalysis: (input: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutAnalysisInput) => import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutAnalysisResult; default: not declared — Leveraged buyout analysis: entry sources/uses, an annual debt/cash schedule under mandatory amortization plus a priority-ordered cash sweep, the exit bridge from enterprise value to sponsor proceeds, the sponsor's equity cash flows, MOIC, and IRR (via the FC1 solver). See the module doc comment for the DISCLOSED simplifications, echoed in the result. - leveragedBuyoutAnalysis().return.annualSchedule: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutAnnualScheduleRow[]; default: not declared - leveragedBuyoutAnalysis().return.assumptions: { disclosedSimplifications: string[]; }; default: not declared - leveragedBuyoutAnalysis().return.assumptions.disclosedSimplifications: string[]; default: not declared — Every modeling simplification this analysis makes, stated — never implied. - leveragedBuyoutAnalysis().return.diagnostics: { warnings: string[]; }; default: not declared - leveragedBuyoutAnalysis().return.diagnostics.warnings: string[]; default: not declared — The disclosed simplifications, surfaced in the one grammar every analysis shares. - leveragedBuyoutAnalysis().return.equityCashFlows: import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared — −sponsorEquity at year 0, +equityProceeds at the exit year (no interim dividends, v1). - leveragedBuyoutAnalysis().return.exitBridge: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutExitBridge; default: not declared - leveragedBuyoutAnalysis().return.internalRateOfReturn: number | null; default: not declared — The sponsor's IRR from the FC1 solver, or `null` when no admissible rate exists (equity proceeds ≤ 0 have no positive-flow leg for an internal rate to equate). - leveragedBuyoutAnalysis().return.multipleOnInvestedCapital: number; default: not declared — `equityProceeds / sponsorEquity`. - leveragedBuyoutAnalysis().return.sourcesAndUses: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutSourcesAndUses; default: not declared - leveragedBuyoutAnalysis(input): import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutAnalysisInput; default: not declared - leveragedBuyoutAnalysis(input).cashSweepFraction: number; default: not declared — Fraction (0 ≤ f ≤ 1) of positive post-mandatory-amortization FCF swept to debt each year. - leveragedBuyoutAnalysis(input).exit: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutExitInput; default: not declared - leveragedBuyoutAnalysis(input).operatingForecast: readonly import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutOperatingYearInput[]; default: not declared - leveragedBuyoutAnalysis(input).sources: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutSourcesInput; default: not declared - leveragedBuyoutAnalysis(input).transaction: import('@insiderfinance/totalfinance/valuation').LeveragedBuyoutTransactionInput; default: not declared - loanInterestPayment: (input: import('@insiderfinance/totalfinance/valuation').LoanPeriodInput) => number; default: not declared — Interest portion of the payment in one period — SIGNED: positive for a nonnegative rate, negative when the periodic rate is negative (the period credits interest to the borrower). - loanInterestPayment(input): import('@insiderfinance/totalfinance/valuation').LoanPeriodInput; default: not declared - loanInterestPayment(input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - loanInterestPayment(input).numberOfPeriods: number; default: not declared - loanInterestPayment(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - loanInterestPayment(input).period: number; default: not declared — 1-based period the question is about. - loanInterestPayment(input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - loanInterestPayment(input).principal: number; default: not declared — Amount borrowed (positive). - loanNumberOfPeriods: (input: import('@insiderfinance/totalfinance/valuation').LoanNumberOfPeriodsInput) => number; default: not declared — Periods (possibly fractional) for `payment` to amortize `principal` down to `balloon`. - loanNumberOfPeriods(input): import('@insiderfinance/totalfinance/valuation').LoanNumberOfPeriodsInput; default: not declared - loanNumberOfPeriods(input).balloon?: number; default: not declared - loanNumberOfPeriods(input).payment: number; default: not declared — The level payment (positive magnitude). - loanNumberOfPeriods(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared - loanNumberOfPeriods(input).periodicInterestRate: number; default: not declared - loanNumberOfPeriods(input).principal: number; default: not declared - loanPeriodicInterestRate: (input: import('@insiderfinance/totalfinance/valuation').LoanPeriodicInterestRateInput) => number; default: not declared — The per-period rate that makes `payment` amortize `principal` — a PROVEN bracket on the monotone payment-in-rate map (geometric expansion until the sign changes, over the full economic domain `rate > −1`), then bisection, then a residual check that the found rate actually reproduces the payment. The closed form for one period shows the rate can be astronomically large (`payment / principal − 1`), so the expansion never stops at an arbitrary cap and returns — failing to bracket is a refusal with a teaching error, never a number. One shape is refused BEFORE the solver: a one-period `'beginning'` loan with no balloon pays its single installment at time zero, so the rate never touches a cash flow — the rate is unidentifiable when `payment === principal` (every rate satisfies the identity) and no rate solves it otherwise. See the inline teaching errors for both sub-cases. - loanPeriodicInterestRate(input): import('@insiderfinance/totalfinance/valuation').LoanPeriodicInterestRateInput; default: not declared - loanPeriodicInterestRate(input).balloon?: number; default: not declared - loanPeriodicInterestRate(input).numberOfPeriods: number; default: not declared - loanPeriodicInterestRate(input).payment: number; default: not declared — The level payment (positive magnitude). - loanPeriodicInterestRate(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared - loanPeriodicInterestRate(input).principal: number; default: not declared - loanPrincipalPayment: (input: import('@insiderfinance/totalfinance/valuation').LoanPeriodInput) => number; default: not declared — Balance reduction in one period (`payment − interest`) — SIGNED: exceeds the payment when the periodic rate (and so the interest component) is negative. - loanPrincipalPayment(input): import('@insiderfinance/totalfinance/valuation').LoanPeriodInput; default: not declared - loanPrincipalPayment(input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - loanPrincipalPayment(input).numberOfPeriods: number; default: not declared - loanPrincipalPayment(input).paymentTiming: import('@insiderfinance/totalfinance/valuation').PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - loanPrincipalPayment(input).period: number; default: not declared — 1-based period the question is about. - loanPrincipalPayment(input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - loanPrincipalPayment(input).principal: number; default: not declared — Amount borrowed (positive). - modifiedInternalRateOfReturn: (input: import('@insiderfinance/totalfinance/valuation').ModifiedInternalRateOfReturnInput) => number; default: not declared — Modified IRR: negative flows discount to time zero at `financeRate`; positive flows compound to the horizon at `reinvestmentRate`; the MIRR is the single rate equating them over the horizon. Deterministic — no root ambiguity exists, so the plain call returns a number. - modifiedInternalRateOfReturn(input): import('@insiderfinance/totalfinance/valuation').ModifiedInternalRateOfReturnInput; default: not declared - modifiedInternalRateOfReturn(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - modifiedInternalRateOfReturn(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - modifiedInternalRateOfReturn(input).financeRate: number; default: not declared — Annual rate financing the negative flows (decimal). - modifiedInternalRateOfReturn(input).reinvestmentRate: number; default: not declared — Annual rate reinvesting the positive flows (decimal). - ndxToQqqLevel: { (input: import('@insiderfinance/totalfinance/valuation').NdxToQqqLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').NdxToQqqLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate QQQ level corresponding to the supplied NDX level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - ndxToQqqLevel(input): import('@insiderfinance/totalfinance/valuation').NdxToQqqLevelInput; default: not declared - ndxToQqqLevel(input).ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - ndxToQqqLevel(input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - ndxToQqqLevel(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - ndxToQqqLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').NdxToQqqLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - ndxToQqqLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - ndxToQqqLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - ndxToQqqLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ndxToQqqLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ndxToQqqLevel.explain(input): import('@insiderfinance/totalfinance/valuation').NdxToQqqLevelInput; default: not declared - ndxToQqqLevel.explain(input).ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - ndxToQqqLevel.explain(input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - ndxToQqqLevel.explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - netPresentValue: (input: import('@insiderfinance/totalfinance/valuation').NetPresentValueInput) => number; default: not declared — Net present value of explicit timed flows. A supplied `timeYears: 0` flow is included exactly once at face value; no time-zero flow is ever inferred. - netPresentValue(input): import('@insiderfinance/totalfinance/valuation').NetPresentValueInput; default: not declared - netPresentValue(input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - netPresentValue(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - netPresentValue(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - nominalAnnualRate: (input: import('@insiderfinance/totalfinance/valuation').NominalAnnualRateInput) => number; default: not declared — Nominal annual rate whose EAR under `compounding` equals the given effective rate. - nominalAnnualRate(input): import('@insiderfinance/totalfinance/valuation').NominalAnnualRateInput; default: not declared - nominalAnnualRate(input).compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a rate conversion never guesses its convention. - nominalAnnualRate(input).effectiveAnnualRate: number; default: not declared — Effective annual rate (decimal). - nqToQqqLevel: { (input: import('@insiderfinance/totalfinance/valuation').NqToQqqLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').NqToQqqLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate QQQ level corresponding to the supplied NQ level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - nqToQqqLevel(input): import('@insiderfinance/totalfinance/valuation').NqToQqqLevelInput; default: not declared - nqToQqqLevel(input).nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - nqToQqqLevel(input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - nqToQqqLevel(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - nqToQqqLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').NqToQqqLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - nqToQqqLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - nqToQqqLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - nqToQqqLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - nqToQqqLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - nqToQqqLevel.explain(input): import('@insiderfinance/totalfinance/valuation').NqToQqqLevelInput; default: not declared - nqToQqqLevel.explain(input).nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - nqToQqqLevel.explain(input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - nqToQqqLevel.explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - operatingForecast: (input: import('@insiderfinance/totalfinance/valuation').OperatingForecastInput) => import('@insiderfinance/totalfinance/valuation').OperatingForecastResult; default: not declared — Revenue, margins, taxes, working capital, capital expenditure, depreciation, and the resulting FCFF (and FCFE where the financing drivers are supplied) — from EXPLICIT per-period drivers. FCFF taxes operating income at the period's rate (the {@link freeCashFlowToFirm} primitive); net income and FCFE additionally need the period's interest expense, stated, never assumed zero. - operatingForecast().return.assumptions: { baseRevenue: number; periods: readonly import('@insiderfinance/totalfinance/valuation').OperatingForecastPeriod[]; }; default: not declared — The drivers, echoed verbatim per period. - operatingForecast().return.assumptions.baseRevenue: number; default: not declared - operatingForecast().return.assumptions.periods: readonly import('@insiderfinance/totalfinance/valuation').OperatingForecastPeriod[]; default: not declared - operatingForecast().return.diagnostics: { warnings: string[]; }; default: not declared - operatingForecast().return.diagnostics.warnings: string[]; default: not declared — One warning per row output disabled by an absent driver. - operatingForecast().return.rows: import('@insiderfinance/totalfinance/valuation').OperatingForecastRow[]; default: not declared - operatingForecast(input): import('@insiderfinance/totalfinance/valuation').OperatingForecastInput; default: not declared - operatingForecast(input).baseRevenue: number; default: not declared — The revenue base the first growth-driven period grows FROM (the last historical revenue). - operatingForecast(input).periods: readonly import('@insiderfinance/totalfinance/valuation').OperatingForecastPeriod[]; default: not declared - paybackPeriod: (input: import('@insiderfinance/totalfinance/valuation').PaybackInput) => number | null; default: not declared — Years until cumulative cash flow first reaches zero (linear interpolation within the recovering interval), or `null` when the outlay is never recovered. - paybackPeriod(input): import('@insiderfinance/totalfinance/valuation').PaybackInput; default: not declared - paybackPeriod(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - presentValue: (input: import('@insiderfinance/totalfinance/valuation').PresentValueInput) => number; default: not declared — Present value of one future amount: `futureAmount · discountFactor(rate, t, compounding)`. - presentValue(input): import('@insiderfinance/totalfinance/valuation').PresentValueInput; default: not declared - presentValue(input).annualInterestRate: number; default: not declared — Annual rate (decimal, e.g. `0.08`). - presentValue(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. - presentValue(input).futureAmount: number; default: not declared — The amount received at `timeYears`. - presentValue(input).timeYears: number; default: not declared - probabilisticDiscountedCashFlow: (input: import('@insiderfinance/totalfinance/valuation').ProbabilisticDiscountedCashFlowInput) => import('@insiderfinance/totalfinance/valuation').ProbabilisticDiscountedCashFlowResult; default: not declared — Monte-Carlo DCF over the DECLARED randomized variables: Gaussian dependence per the supplied correlations, inverse-CDF marginal transforms, one direct {@link discountedCashFlow} call per sample. A draw the model's own domain rejects (e.g. growth at or above the rate) is counted and excluded with its reason — never clamped into validity. With every distribution degenerate the run collapses to the deterministic result exactly. - probabilisticDiscountedCashFlow().return.assumptions: { distributions: readonly import('@insiderfinance/totalfinance/valuation').RandomizedVariable[]; correlationMatrix: readonly (readonly number[])[] | 'independent'; dependence: 'gaussian-copula-over-declared-correlations'; baseCase: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; }; default: not declared — The exact seeded assumptions, echoed for reproduction. - probabilisticDiscountedCashFlow().return.assumptions.baseCase: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult; default: not declared - probabilisticDiscountedCashFlow().return.assumptions.correlationMatrix: readonly (readonly number[])[] | 'independent'; default: not declared - probabilisticDiscountedCashFlow().return.assumptions.dependence: 'gaussian-copula-over-declared-correlations'; default: not declared - probabilisticDiscountedCashFlow().return.assumptions.distributions: readonly import('@insiderfinance/totalfinance/valuation').RandomizedVariable[]; default: not declared - probabilisticDiscountedCashFlow().return.diagnostics: { warnings: string[]; }; default: not declared - probabilisticDiscountedCashFlow().return.diagnostics.warnings: string[]; default: not declared — One warning per rejected-sample reason (count included). - probabilisticDiscountedCashFlow().return.maximum: number; default: not declared - probabilisticDiscountedCashFlow().return.mean: number; default: not declared - probabilisticDiscountedCashFlow().return.minimum: number; default: not declared - probabilisticDiscountedCashFlow().return.probabilityAtOrBelowZero: number; default: not declared — Left-tail diagnostics: the sampled probability that the value falls at or below zero. - probabilisticDiscountedCashFlow().return.quantiles: { p05: number; p10: number; p25: number; p50: number; p75: number; p90: number; p95: number; }; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p05: number; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p10: number; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p25: number; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p50: number; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p75: number; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p90: number; default: not declared - probabilisticDiscountedCashFlow().return.quantiles.p95: number; default: not declared - probabilisticDiscountedCashFlow().return.rejectedSamples: { count: number; reasons: Record; }; default: not declared — Samples the model's own laws rejected (e.g. growth ≥ rate), with the reasons tallied. - probabilisticDiscountedCashFlow().return.rejectedSamples.count: number; default: not declared - probabilisticDiscountedCashFlow().return.rejectedSamples.reasons: Record; default: not declared - probabilisticDiscountedCashFlow().return.sampleCount: number; default: not declared - probabilisticDiscountedCashFlow().return.seed: number; default: not declared - probabilisticDiscountedCashFlow().return.standardDeviation: number; default: not declared - probabilisticDiscountedCashFlow().return.validSampleCount: number; default: not declared — Samples whose drawn variables kept the model inside its domain. - probabilisticDiscountedCashFlow().return.valueDescribed: 'enterpriseValue' | 'equityValue'; default: not declared — The value the distribution describes (per the base input's valuation basis). - probabilisticDiscountedCashFlow(input): import('@insiderfinance/totalfinance/valuation').ProbabilisticDiscountedCashFlowInput; default: not declared - probabilisticDiscountedCashFlow(input).correlationMatrix?: readonly (readonly number[])[]; default: not declared — Correlation matrix over `distributions` (Gaussian dependence, applied before the marginal transforms). Omitted → independent. - probabilisticDiscountedCashFlow(input).discountedCashFlowInput: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowInput; default: not declared - probabilisticDiscountedCashFlow(input).distributions: readonly import('@insiderfinance/totalfinance/valuation').RandomizedVariable[]; default: not declared - probabilisticDiscountedCashFlow(input).sampleCount: number; default: not declared - probabilisticDiscountedCashFlow(input).seed: number; default: not declared - profitabilityIndex: (input: import('@insiderfinance/totalfinance/valuation').ProfitabilityIndexInput) => number; default: not declared — PV of the positive flows ÷ PV of the outlays (positive magnitude): > 1 means value-creating at the discount rate. - profitabilityIndex(input): import('@insiderfinance/totalfinance/valuation').ProfitabilityIndexInput; default: not declared - profitabilityIndex(input).annualDiscountRate: number; default: not declared - profitabilityIndex(input).cashFlows: readonly import('@insiderfinance/totalfinance/valuation').TimedCashFlow[]; default: not declared - profitabilityIndex(input).compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — Default `'annual'`. - projectFinancialStatements: (input: import('@insiderfinance/totalfinance/valuation').ProjectStatementsInput) => import('@insiderfinance/totalfinance/valuation').ProjectStatementsResult; default: not declared — A three-statement projection from a typed historical base and explicit per-period drivers. The articulation, written out (Δ = period change): ΔtotalAssets = Δcash + ΔAR + Δinventory + ΔPPE = (CFO + CFI + CFF) + ΔAR + Δinventory + (capex − D&A) = netIncome + ΔAP + netBorrowing − dividends ΔtotalLiabilities + Δequity = ΔAP + netBorrowing + netIncome − dividends — identical, so the balance sheet ties EXACTLY with cash as the named balancer. Other assets and other liabilities are carried CONSTANT from the base (disclosed), never grown silently. - projectFinancialStatements().return.assumptions: { periods: readonly import('@insiderfinance/totalfinance/valuation').StatementProjectionPeriod[]; }; default: not declared - projectFinancialStatements().return.assumptions.periods: readonly import('@insiderfinance/totalfinance/valuation').StatementProjectionPeriod[]; default: not declared - projectFinancialStatements().return.balancingItem: 'cash'; default: not declared — The named balancing item. CASH absorbs the residual of the articulated statements — the identity `assets = liabilities + equity` then holds by construction, and the proof is the per-period `identityDifference` (floating-point dust, gated in tests). - projectFinancialStatements().return.diagnostics: { warnings: string[]; }; default: not declared - projectFinancialStatements().return.diagnostics.warnings: string[]; default: not declared — Any period whose identity residual exceeds floating-point dust. - projectFinancialStatements().return.reconciliation: { periodLabel: string; identityDifference: number; }[]; default: not declared - projectFinancialStatements().return.statements: import('@insiderfinance/totalfinance/valuation').ProjectedStatements[]; default: not declared - projectFinancialStatements(input): import('@insiderfinance/totalfinance/valuation').ProjectStatementsInput; default: not declared - projectFinancialStatements(input).baseStatements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared — The typed historical anchor — beginning balances come from HERE, not from an assumption. - projectFinancialStatements(input).periods: readonly import('@insiderfinance/totalfinance/valuation').StatementProjectionPeriod[]; default: not declared - qqqToNdxLevel: { (input: import('@insiderfinance/totalfinance/valuation').QqqToNdxLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').QqqToNdxLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate NDX level corresponding to the supplied QQQ level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - qqqToNdxLevel(input): import('@insiderfinance/totalfinance/valuation').QqqToNdxLevelInput; default: not declared - qqqToNdxLevel(input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - qqqToNdxLevel(input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - qqqToNdxLevel(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - qqqToNdxLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').QqqToNdxLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - qqqToNdxLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - qqqToNdxLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - qqqToNdxLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - qqqToNdxLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - qqqToNdxLevel.explain(input): import('@insiderfinance/totalfinance/valuation').QqqToNdxLevelInput; default: not declared - qqqToNdxLevel.explain(input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - qqqToNdxLevel.explain(input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - qqqToNdxLevel.explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - qqqToNqLevel: { (input: import('@insiderfinance/totalfinance/valuation').QqqToNqLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').QqqToNqLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate NQ level corresponding to the supplied QQQ level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - qqqToNqLevel(input): import('@insiderfinance/totalfinance/valuation').QqqToNqLevelInput; default: not declared - qqqToNqLevel(input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - qqqToNqLevel(input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - qqqToNqLevel(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - qqqToNqLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').QqqToNqLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - qqqToNqLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - qqqToNqLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - qqqToNqLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - qqqToNqLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - qqqToNqLevel.explain(input): import('@insiderfinance/totalfinance/valuation').QqqToNqLevelInput; default: not declared - qqqToNqLevel.explain(input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - qqqToNqLevel.explain(input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - qqqToNqLevel.explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - requireCompoundingWhenPresent: (functionName: string, compounding: unknown) => asserts compounding is import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared — Shared when-present compounding ladder — the seven-form grammar, taught at the boundary. - requireCompoundingWhenPresent(compounding): unknown; default: not declared - requireCompoundingWhenPresent(functionName): string; default: not declared - requireDayCountWhenPresent: (functionName: string, dayCount: unknown) => asserts dayCount is import('@insiderfinance/totalfinance/core').DayCount | undefined; default: not declared — Shared when-present day-count ladder over core's ONE vocabulary. - requireDayCountWhenPresent(dayCount): unknown; default: not declared - requireDayCountWhenPresent(functionName): string; default: not declared - residualIncomeValuation: (input: import('@insiderfinance/totalfinance/valuation').ResidualIncomeInput) => import('@insiderfinance/totalfinance/valuation').ResidualIncomeResult; default: not declared — Clean-surplus residual income: value = beginning book value + Σ PV(EPS_t − r × B_{t−1}) + PV of the stated terminal stage. Book value rolls forward as `B_t = B_{t−1} + EPS_t − DPS_t`; annual discrete discounting (the model is annual by construction). - residualIncomeValuation().return.assumptions: { annualCostOfEquity: number; cleanSurplus: 'ending book = beginning book + earnings - dividends'; terminalResidualIncome: import('@insiderfinance/totalfinance/valuation').ResidualIncomeInput['terminalResidualIncome']; }; default: not declared - residualIncomeValuation().return.assumptions.annualCostOfEquity: number; default: not declared - residualIncomeValuation().return.assumptions.cleanSurplus: 'ending book = beginning book + earnings - dividends'; default: not declared - residualIncomeValuation().return.assumptions.terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; default: not declared - residualIncomeValuation().return.assumptions.terminalResidualIncome.method: ('none') | ('perpetuity'); default: not declared - residualIncomeValuation().return.assumptions.terminalResidualIncome.perpetualGrowthRate: number; default: not declared - residualIncomeValuation().return.beginningBookValuePerShare: number; default: not declared - residualIncomeValuation().return.diagnostics: { warnings: string[]; }; default: not declared - residualIncomeValuation().return.diagnostics.warnings: string[]; default: not declared - residualIncomeValuation().return.residualIncomePresentValue: number; default: not declared - residualIncomeValuation().return.rows: { year: number; beginningBookValuePerShare: number; earningsPerShare: number; dividendsPerShare: number; endingBookValuePerShare: number; equityCharge: number; residualIncomePerShare: number; presentValue: number; }[]; default: not declared - residualIncomeValuation().return.terminalValuePresentValue: number; default: not declared - residualIncomeValuation().return.valuePerShare: number; default: not declared - residualIncomeValuation(input): import('@insiderfinance/totalfinance/valuation').ResidualIncomeInput; default: not declared - residualIncomeValuation(input).annualCostOfEquity: number; default: not declared — Annual cost of equity (decimal). - residualIncomeValuation(input).beginningBookValuePerShare: number; default: not declared — Book value per share at the valuation date. - residualIncomeValuation(input).projections: readonly import('@insiderfinance/totalfinance/valuation').ResidualIncomeProjection[]; default: not declared — One entry per forecast YEAR, in order — clean surplus rolls the book value between them. - residualIncomeValuation(input).terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; default: not declared — The residual-income terminal stage: `'none'` states that residual income is competed away after the horizon; `'perpetuity'` continues the FINAL residual income at a growth rate. - residualIncomeValuation(input).terminalResidualIncome.method: ('none') | ('perpetuity'); default: not declared - residualIncomeValuation(input).terminalResidualIncome.perpetualGrowthRate: number; default: not declared - reverseDiscountedCashFlow: (input: import('@insiderfinance/totalfinance/valuation').ReverseDiscountedCashFlowInput) => import('@insiderfinance/totalfinance/valuation').ReverseDiscountedCashFlowResult; default: not declared — Solve for the stated variable so the DCF reproduces `targetValue` (enterprise value on the firm basis, equity value on equity). Bisection over the EXPLICIT search range; bounds and convergence are reported, and a no-root range answers `null` with the reason — never the nearest endpoint. - reverseDiscountedCashFlow().return.assumptions: { variable: import('@insiderfinance/totalfinance/valuation').ReverseDiscountedCashFlowTarget['variable']; searchRange: { from: number; to: number; }; targetValue: number; method: 'bisection'; }; default: not declared - reverseDiscountedCashFlow().return.assumptions.method: 'bisection'; default: not declared - reverseDiscountedCashFlow().return.assumptions.searchRange: { from: number; to: number; }; default: not declared - reverseDiscountedCashFlow().return.assumptions.searchRange.from: number; default: not declared - reverseDiscountedCashFlow().return.assumptions.searchRange.to: number; default: not declared - reverseDiscountedCashFlow().return.assumptions.targetValue: number; default: not declared - reverseDiscountedCashFlow().return.assumptions.variable: 'annual-discount-rate' | 'perpetual-growth-rate'; default: not declared - reverseDiscountedCashFlow().return.converged: boolean; default: not declared - reverseDiscountedCashFlow().return.diagnostics: { warnings: string[]; }; default: not declared - reverseDiscountedCashFlow().return.diagnostics.warnings: string[]; default: not declared - reverseDiscountedCashFlow().return.impliedResult: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowResult | null; default: not declared — The valuation the implied variable reproduces, for inspection. - reverseDiscountedCashFlow().return.impliedValue: number | null; default: not declared — The implied value of the solved variable, or `null` when no root lies in the range. - reverseDiscountedCashFlow().return.iterations: number; default: not declared - reverseDiscountedCashFlow().return.reason?: string; default: not declared — Why `impliedValue` is null, when it is. - reverseDiscountedCashFlow().return.residual: number | null; default: not declared — |model(implied) − target| at the reported solution (absolute). - reverseDiscountedCashFlow().return.searchRange: { from: number; to: number; }; default: not declared - reverseDiscountedCashFlow().return.searchRange.from: number; default: not declared - reverseDiscountedCashFlow().return.searchRange.to: number; default: not declared - reverseDiscountedCashFlow().return.variable: 'annual-discount-rate' | 'perpetual-growth-rate'; default: not declared - reverseDiscountedCashFlow(input): import('@insiderfinance/totalfinance/valuation').ReverseDiscountedCashFlowInput; default: not declared - reverseDiscountedCashFlow(input).discountedCashFlowInput: import('@insiderfinance/totalfinance/valuation').DiscountedCashFlowInput; default: not declared — The full direct-DCF input to hold fixed (except the solved variable). - reverseDiscountedCashFlow(input).target: import('@insiderfinance/totalfinance/valuation').ReverseDiscountedCashFlowTarget; default: not declared - reverseDiscountedCashFlow(input).targetValue: number; default: not declared — The observed value to match: enterprise value on the firm basis, equity value on equity. - rtyToIwmLevel: { (input: import('@insiderfinance/totalfinance/valuation').RtyToIwmLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').RtyToIwmLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate IWM level corresponding to the supplied RTY level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - rtyToIwmLevel(input): import('@insiderfinance/totalfinance/valuation').RtyToIwmLevelInput; default: not declared - rtyToIwmLevel(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - rtyToIwmLevel(input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - rtyToIwmLevel(input).rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. - rtyToIwmLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').RtyToIwmLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - rtyToIwmLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - rtyToIwmLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - rtyToIwmLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rtyToIwmLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rtyToIwmLevel.explain(input): import('@insiderfinance/totalfinance/valuation').RtyToIwmLevelInput; default: not declared - rtyToIwmLevel.explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - rtyToIwmLevel.explain(input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - rtyToIwmLevel.explain(input).rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. - rutToIwmLevel: { (input: import('@insiderfinance/totalfinance/valuation').RutToIwmLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').RutToIwmLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate IWM level corresponding to the supplied RUT level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - rutToIwmLevel(input): import('@insiderfinance/totalfinance/valuation').RutToIwmLevelInput; default: not declared - rutToIwmLevel(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - rutToIwmLevel(input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - rutToIwmLevel(input).rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. - rutToIwmLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').RutToIwmLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - rutToIwmLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - rutToIwmLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - rutToIwmLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - rutToIwmLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - rutToIwmLevel.explain(input): import('@insiderfinance/totalfinance/valuation').RutToIwmLevelInput; default: not declared - rutToIwmLevel.explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - rutToIwmLevel.explain(input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - rutToIwmLevel.explain(input).rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. - spxToSpyLevel: { (input: import('@insiderfinance/totalfinance/valuation').SpxToSpyLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').SpxToSpyLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate SPY level corresponding to the supplied SPX level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - spxToSpyLevel(input): import('@insiderfinance/totalfinance/valuation').SpxToSpyLevelInput; default: not declared - spxToSpyLevel(input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - spxToSpyLevel(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spxToSpyLevel(input).spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. - spxToSpyLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').SpxToSpyLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - spxToSpyLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - spxToSpyLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - spxToSpyLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - spxToSpyLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - spxToSpyLevel.explain(input): import('@insiderfinance/totalfinance/valuation').SpxToSpyLevelInput; default: not declared - spxToSpyLevel.explain(input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - spxToSpyLevel.explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spxToSpyLevel.explain(input).spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. - spyToEsLevel: { (input: import('@insiderfinance/totalfinance/valuation').SpyToEsLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').SpyToEsLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate ES level corresponding to the supplied SPY level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - spyToEsLevel(input): import('@insiderfinance/totalfinance/valuation').SpyToEsLevelInput; default: not declared - spyToEsLevel(input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - spyToEsLevel(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spyToEsLevel(input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - spyToEsLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').SpyToEsLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - spyToEsLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - spyToEsLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - spyToEsLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - spyToEsLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - spyToEsLevel.explain(input): import('@insiderfinance/totalfinance/valuation').SpyToEsLevelInput; default: not declared - spyToEsLevel.explain(input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - spyToEsLevel.explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spyToEsLevel.explain(input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - spyToSpxLevel: { (input: import('@insiderfinance/totalfinance/valuation').SpyToSpxLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').SpyToSpxLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate SPX level corresponding to the supplied SPY level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - spyToSpxLevel(input): import('@insiderfinance/totalfinance/valuation').SpyToSpxLevelInput; default: not declared - spyToSpxLevel(input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - spyToSpxLevel(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spyToSpxLevel(input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - spyToSpxLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').SpyToSpxLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - spyToSpxLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - spyToSpxLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - spyToSpxLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - spyToSpxLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - spyToSpxLevel.explain(input): import('@insiderfinance/totalfinance/valuation').SpyToSpxLevelInput; default: not declared - spyToSpxLevel.explain(input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - spyToSpxLevel.explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spyToSpxLevel.explain(input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - straightLineDepreciation: (input: import('@insiderfinance/totalfinance/valuation').DepreciationInput) => number; default: not declared — Straight-line: the same charge every period, `(cost − salvage) / life`. - straightLineDepreciation(input): import('@insiderfinance/totalfinance/valuation').DepreciationInput; default: not declared - straightLineDepreciation(input).cost: number; default: not declared — Acquisition cost (positive). - straightLineDepreciation(input).period: number; default: not declared — 1-based period being asked about. - straightLineDepreciation(input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - straightLineDepreciation(input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). - sumOfYearsDigitsDepreciation: (input: import('@insiderfinance/totalfinance/valuation').DepreciationInput) => number; default: not declared — Sum-of-years'-digits charge in `period`: `(cost − salvage) · remainingLife / Σ digits`. - sumOfYearsDigitsDepreciation(input): import('@insiderfinance/totalfinance/valuation').DepreciationInput; default: not declared - sumOfYearsDigitsDepreciation(input).cost: number; default: not declared — Acquisition cost (positive). - sumOfYearsDigitsDepreciation(input).period: number; default: not declared — 1-based period being asked about. - sumOfYearsDigitsDepreciation(input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - sumOfYearsDigitsDepreciation(input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). - terminalValue: (input: import('@insiderfinance/totalfinance/valuation').TerminalValueInput) => number; default: not declared — The terminal value AT the end of the forecast horizon (not yet discounted to the valuation date): perpetual growth `terminalCashFlow × (1 + g) / (r − g)`, or the exit multiple `terminalMetricAmount × exitMultiple`. - terminalValue(input): import('@insiderfinance/totalfinance/valuation').TerminalValueInput; default: not declared - terminalValue(input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). Perpetual growth requires it to EXCEED the growth rate. - terminalValue(input).terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - weightedAverageCostOfCapital: (input: import('@insiderfinance/totalfinance/valuation').WeightedAverageCostOfCapitalInput) => import('@insiderfinance/totalfinance/valuation').WeightedAverageCostOfCapitalResult; default: not declared — Market-value weighted average of the supplied component costs. Weights are normalized from the market values and REPORTED; a zero or negative total capital base is refused — there is no average over nothing. Tax shields are explicit: hand this function the after-tax cost of debt (see {@link afterTaxCostOfDebt}), it never applies a tax rate itself. - weightedAverageCostOfCapital().return.assumptions: { weightBasis: 'market values, normalized to sum to one'; componentCount: number; }; default: not declared - weightedAverageCostOfCapital().return.assumptions.componentCount: number; default: not declared - weightedAverageCostOfCapital().return.assumptions.weightBasis: 'market values, normalized to sum to one'; default: not declared - weightedAverageCostOfCapital().return.components: { label: string; marketValue: number; weight: number; annualCostOfCapital: number; contribution: number; }[]; default: not declared — Normalized weights, echoed per component — they sum to one by construction. - weightedAverageCostOfCapital().return.diagnostics: { warnings: string[]; }; default: not declared - weightedAverageCostOfCapital().return.diagnostics.warnings: string[]; default: not declared - weightedAverageCostOfCapital().return.totalCapital: number | null; default: not declared — `null` when the summed capital base exceeds `Number.MAX_VALUE` — the WEIGHTS and the average are still exact (computed in scaled space), but the raw total itself has no IEEE-754 representation; `totalCapitalAbsentReason` says so (2026-08-23 review wave). - weightedAverageCostOfCapital().return.totalCapitalAbsentReason?: string; default: not declared - weightedAverageCostOfCapital().return.weightedAverageCostOfCapital: number; default: not declared - weightedAverageCostOfCapital(input): import('@insiderfinance/totalfinance/valuation').WeightedAverageCostOfCapitalInput; default: not declared - weightedAverageCostOfCapital(input).components: readonly import('@insiderfinance/totalfinance/valuation').CapitalComponent[]; default: not declared - ymToDiaLevel: { (input: import('@insiderfinance/totalfinance/valuation').YmToDiaLevelInput): number; explain: (input: import('@insiderfinance/totalfinance/valuation').YmToDiaLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; }; default: not declared — Approximate DIA level corresponding to the supplied YM level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. - ymToDiaLevel(input): import('@insiderfinance/totalfinance/valuation').YmToDiaLevelInput; default: not declared - ymToDiaLevel(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - ymToDiaLevel(input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - ymToDiaLevel(input).ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. - ymToDiaLevel.explain: (input: import('@insiderfinance/totalfinance/valuation').YmToDiaLevelInput) => import('@insiderfinance/totalfinance/core').Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - ymToDiaLevel.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - ymToDiaLevel.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - ymToDiaLevel.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - ymToDiaLevel.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - ymToDiaLevel.explain(input): import('@insiderfinance/totalfinance/valuation').YmToDiaLevelInput; default: not declared - ymToDiaLevel.explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - ymToDiaLevel.explain(input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - ymToDiaLevel.explain(input).ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. ### @insiderfinance/totalfinance#volatility Kind: namespace; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const volatility: typeof import('@insiderfinance/totalfinance/volatility'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - RISK_NEUTRAL_ESTIMATE: import('@insiderfinance/totalfinance/core').QuantWarning; default: not declared — The standard "this is a risk-neutral model estimate, not a real-world forecast" caveat. - RISK_NEUTRAL_ESTIMATE.code: string; default: not declared - RISK_NEUTRAL_ESTIMATE.context?: Record; default: not declared - RISK_NEUTRAL_ESTIMATE.message: string; default: not declared - RISK_NEUTRAL_ESTIMATE.severity: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared - SURFACE_SCHEMA_VERSION: '1'; default: not declared — Schema version stamped onto every {@link VolatilitySurface#toJSON } snapshot; checked on restore (WS4.4). - VolatilitySurface: typeof import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — A fitted implied-volatility surface with diagnostics-bearing lookup. - VolatilitySurface().return.arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - VolatilitySurface().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - VolatilitySurface().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - VolatilitySurface().return.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - VolatilitySurface().return.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - VolatilitySurface().return.heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - VolatilitySurface().return.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - VolatilitySurface().return.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - VolatilitySurface().return.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - VolatilitySurface().return.lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - VolatilitySurface().return.model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - VolatilitySurface().return.points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - VolatilitySurface().return.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - VolatilitySurface().return.slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - VolatilitySurface().return.slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - VolatilitySurface().return.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - VolatilitySurface().return.toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - VolatilitySurface().return.toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - VolatilitySurface(input): import('@insiderfinance/totalfinance/volatility/surface').VolatilitySurfaceInput; default: not declared - VolatilitySurface(input).config?: import('@insiderfinance/totalfinance/volatility').SurfaceConfig; default: not declared - VolatilitySurface(input).market: import('@insiderfinance/totalfinance/volatility').SurfaceMarket; default: not declared - VolatilitySurface(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - VolatilitySurface.fromJSON: (snapshot: import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Rebuild a surface from a {@link VolatilitySurfaceSnapshot}. Rejects a `schemaVersion` mismatch (design law #4: never silently restore state a different build wrote). Interpolators are rebuilt via {@link buildSmile} from the stored slice parameters — never re-fitted — so the restored surface answers `iv()` identically to the one that produced the snapshot. - VolatilitySurface.fromJSON().return.arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - VolatilitySurface.fromJSON().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - VolatilitySurface.fromJSON().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - VolatilitySurface.fromJSON().return.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - VolatilitySurface.fromJSON().return.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - VolatilitySurface.fromJSON().return.heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - VolatilitySurface.fromJSON().return.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - VolatilitySurface.fromJSON().return.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - VolatilitySurface.fromJSON().return.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - VolatilitySurface.fromJSON().return.lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - VolatilitySurface.fromJSON().return.model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - VolatilitySurface.fromJSON().return.points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - VolatilitySurface.fromJSON().return.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - VolatilitySurface.fromJSON().return.slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - VolatilitySurface.fromJSON().return.slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - VolatilitySurface.fromJSON().return.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - VolatilitySurface.fromJSON().return.toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - VolatilitySurface.fromJSON().return.toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - VolatilitySurface.fromJSON(snapshot): import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared - VolatilitySurface.fromJSON(snapshot).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - VolatilitySurface.fromJSON(snapshot).config: { cosineExpansionTerms: number; dividendYield: number; riskFreeRate: number; sabrBeta: number; sabrVolatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; smoothingBandwidth?: number; }; default: not declared — Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. - VolatilitySurface.fromJSON(snapshot).config.cosineExpansionTerms: number; default: not declared - VolatilitySurface.fromJSON(snapshot).config.dividendYield: number; default: not declared - VolatilitySurface.fromJSON(snapshot).config.riskFreeRate: number; default: not declared - VolatilitySurface.fromJSON(snapshot).config.sabrBeta: number; default: not declared - VolatilitySurface.fromJSON(snapshot).config.sabrVolatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - VolatilitySurface.fromJSON(snapshot).config.smoothingBandwidth?: number; default: not declared - VolatilitySurface.fromJSON(snapshot).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - VolatilitySurface.fromJSON(snapshot).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`. - VolatilitySurface.fromJSON(snapshot).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`. - VolatilitySurface.fromJSON(snapshot).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - VolatilitySurface.fromJSON(snapshot).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - VolatilitySurface.fromJSON(snapshot).referenceSpot: number; default: not declared - VolatilitySurface.fromJSON(snapshot).schemaVersion: string; default: not declared - VolatilitySurface.fromJSON(snapshot).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - VolatilitySurface.fromJSON(snapshot).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`. - arbitrageReport: (slices: import('@insiderfinance/totalfinance/volatility').ArbitrageSlice[], options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run all static no-arbitrage checks over a set of slices (Law 2 report grammar). - arbitrageReport().return.arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - arbitrageReport().return.assumptions: { butterflyPoints: number; calendarPoints: number; conventionsVersion: string; step: number; tolerance: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - arbitrageReport().return.assumptions.butterflyPoints: number; default: not declared - arbitrageReport().return.assumptions.calendarPoints: number; default: not declared - arbitrageReport().return.assumptions.conventionsVersion: string; default: not declared - arbitrageReport().return.assumptions.step: number; default: not declared - arbitrageReport().return.assumptions.tolerance: number; default: not declared - arbitrageReport().return.checks: { butterfly: boolean; calendar: boolean; }; default: not declared — Per-check pass/fail summary. - arbitrageReport().return.checks.butterfly: boolean; default: not declared - arbitrageReport().return.checks.calendar: boolean; default: not declared - arbitrageReport().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - arbitrageReport().return.violations: import('@insiderfinance/totalfinance/volatility').ArbitrageViolation[]; default: not declared - arbitrageReport(options)?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions; default: not declared - arbitrageReport(options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - arbitrageReport(options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - arbitrageReport(options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - arbitrageReport(options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - arbitrageReport(slices): import('@insiderfinance/totalfinance/volatility').ArbitrageSlice[]; default: not declared - atmTermStructure: (surface: import('@insiderfinance/totalfinance/volatility').VolatilitySurface) => import('@insiderfinance/totalfinance/volatility').AtmTermStructure; default: not declared — The ATM implied-vol term structure: ATM IV and total variance per expiry, with a monotonicity flag. - atmTermStructure().return.assumptions: { conventionsVersion: string; coordinate: 'atm-total-variance'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - atmTermStructure().return.assumptions.conventionsVersion: string; default: not declared - atmTermStructure().return.assumptions.coordinate: 'atm-total-variance'; default: not declared - atmTermStructure().return.calendarMonotone: boolean; default: not declared — Whether ATM total variance is non-decreasing across maturities (calendar-arbitrage-free ATM). - atmTermStructure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings; a non-monotone ATM structure discloses itself here. - atmTermStructure().return.points: import('@insiderfinance/totalfinance/volatility').AtmTermPoint[]; default: not declared - atmTermStructure(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - atmTermStructure(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - atmTermStructure(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - atmTermStructure(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - atmTermStructure(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - atmTermStructure(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - atmTermStructure(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - atmTermStructure(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - atmTermStructure(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - atmTermStructure(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - atmTermStructure(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - atmTermStructure(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - atmTermStructure(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - atmTermStructure(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - atmTermStructure(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - atmTermStructure(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - atmTermStructure(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - atmTermStructure(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - atmTermStructure(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - calendarSkew: import('@insiderfinance/totalfinance/volatility').CalendarSkewFacade; default: not declared — Calendar skew: how the ATM skew slope changes from the near to the far expiry (`slope_far − slope_near`). Negative when the near-dated smile is steeper (the usual term-structure-of-skew shape). Facade (H22): the plain call returns the scalar; `.explain()` discloses the sorted near/far expiries and the canonical `0.05` log-moneyness central-difference step in `assumptions`, and both ATM skew slopes in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the plain call's first-touch teaching errors stay byte-identical. - calendarSkew(from): string | number; default: not declared - calendarSkew(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - calendarSkew(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - calendarSkew(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - calendarSkew(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calendarSkew(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - calendarSkew(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - calendarSkew(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - calendarSkew(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - calendarSkew(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - calendarSkew(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - calendarSkew(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - calendarSkew(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - calendarSkew(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - calendarSkew(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - calendarSkew(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - calendarSkew(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - calendarSkew(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - calendarSkew(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - calendarSkew(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - calendarSkew(to): string | number; default: not declared - calendarSkew.explain: (surface: import('@insiderfinance/totalfinance/volatility').VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/volatility').CalendarSkewAssumptions; }; default: not declared - calendarSkew.explain().return.assumptions: import('@insiderfinance/totalfinance/volatility').CalendarSkewAssumptions; default: not declared - calendarSkew.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - calendarSkew.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - calendarSkew.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - calendarSkew.explain(from): string | number; default: not declared - calendarSkew.explain(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - calendarSkew.explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - calendarSkew.explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - calendarSkew.explain(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calendarSkew.explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - calendarSkew.explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - calendarSkew.explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - calendarSkew.explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - calendarSkew.explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - calendarSkew.explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - calendarSkew.explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - calendarSkew.explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - calendarSkew.explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - calendarSkew.explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - calendarSkew.explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - calendarSkew.explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - calendarSkew.explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - calendarSkew.explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - calendarSkew.explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - calendarSkew.explain(to): string | number; default: not declared - calibrateEssvi: (surface: import('@insiderfinance/totalfinance/volatility').ESSVICalibrationInput, options?: import('@insiderfinance/totalfinance/volatility').ESSVICalibrationOptions) => import('@insiderfinance/totalfinance/volatility').ESSVICalibration; default: not declared — Fit a calendar-arbitrage-free eSSVI surface: θ knots from each slice's ATM variance (made monotone), then per-maturity `ρᵢ` and a global `φ` by least squares — warm-started from a global SSVI fit, so eSSVI begins at the best single-`ρ` surface and can only improve, with a calendar-crossing penalty keeping the fit arbitrage-free between maturities. See the spec. - calibrateEssvi().return.arbitrage: import('@insiderfinance/totalfinance/volatility').ESSVIArbitrage; default: not declared - calibrateEssvi().return.assumptions: { conventionsVersion: string; phi: 'power-law' | 'heston'; skew: 'per-maturity'; weight: 'uniform' | 'vega'; initialParameters: 'supplied' | 'ssvi-warm-start'; }; default: not declared - calibrateEssvi().return.assumptions.conventionsVersion: string; default: not declared - calibrateEssvi().return.assumptions.initialParameters: 'supplied' | 'ssvi-warm-start'; default: not declared — Whether the search began from a caller-supplied start or the internal global-SSVI warm start. - calibrateEssvi().return.assumptions.phi: 'power-law' | 'heston'; default: not declared - calibrateEssvi().return.assumptions.skew: 'per-maturity'; default: not declared - calibrateEssvi().return.assumptions.weight: 'vega' | 'uniform'; default: not declared - calibrateEssvi().return.converged: boolean; default: not declared - calibrateEssvi().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calibrateEssvi().return.parameters: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared - calibrateEssvi().return.perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - calibrateEssvi().return.rhoTerm: { timeToExpiryYears: number; rho: number; }[]; default: not declared — The fitted skew term structure — the payoff of eSSVI over global-ρ SSVI. - calibrateEssvi().return.rmse: number; default: not declared — Root-mean-square total-variance error across all points. - calibrateEssvi(options)?: import('@insiderfinance/totalfinance/volatility').ESSVICalibrationOptions; default: not declared - calibrateEssvi(options).initialParameters?: { rho: number | number[]; phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; }; default: not declared — Warm start (Stage 4.5): a scalar `rho` broadcasts to every maturity knot, an array must match the slice count; `phi.kind` must equal the calibration's `phi` family. A supplied start REPLACES the internal SSVI warm start (echoed in `assumptions.initialParameters`). - calibrateEssvi(options).initialParameters.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared - calibrateEssvi(options).initialParameters.rho: number | number[]; default: not declared - calibrateEssvi(options).maximumIterations?: number; default: not declared — Outer-search iteration budget (default 2,000, maximum 10,000). - calibrateEssvi(options).phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - calibrateEssvi(options).tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - calibrateEssvi(options).weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit. Threaded through the SSVI warm-start too. - calibrateEssvi(surface): import('@insiderfinance/totalfinance/volatility').ESSVICalibrationInput; default: not declared - calibrateEssvi(surface).slices: import('@insiderfinance/totalfinance/volatility').SSVISliceInput[]; default: not declared - calibrateEventMove: (observations: readonly import('@insiderfinance/totalfinance/volatility').EventMoveObservation[]) => import('@insiderfinance/totalfinance/volatility').EventMoveCalibration; default: not declared — Calibrate the earnings straddle: compare each past event's implied move (before) to its realized move (after), and aggregate — the ratio, how often selling the straddle won, and the average bias. A historical statistic (not a forecast). See the spec. - calibrateEventMove().return.assumptions: { conventionsVersion: string; method: string; }; default: not declared - calibrateEventMove().return.assumptions.conventionsVersion: string; default: not declared - calibrateEventMove().return.assumptions.method: string; default: not declared - calibrateEventMove().return.averageImplied: number; default: not declared - calibrateEventMove().return.averageRealized: number; default: not declared - calibrateEventMove().return.bias: number; default: not declared — Mean `realized − implied` — positive ⇒ straddles underpriced on average. - calibrateEventMove().return.count: number; default: not declared - calibrateEventMove().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calibrateEventMove().return.meanAbsoluteError: number; default: not declared — Mean `|realized − implied|`. - calibrateEventMove().return.overpricedFraction: number; default: not declared — Fraction of events where implied > realized (how often selling the straddle won). - calibrateEventMove().return.perEvent: import('@insiderfinance/totalfinance/volatility').CalibratedEvent[]; default: not declared - calibrateEventMove().return.ratio: number; default: not declared — `averageRealized / averageImplied` — > 1 ⇒ the stock moves MORE than the straddle prices. - calibrateEventMove(observations): readonly import('@insiderfinance/totalfinance/volatility').EventMoveObservation[]; default: not declared - calibrateEventVolatility: (options: import('@insiderfinance/totalfinance/volatility').FitEventVolatilityOptions) => import('@insiderfinance/totalfinance/volatility').EventVolatilityCalibration; default: not declared — Extract the continuous vol and the discrete event jump from an ATM-vol term structure by fitting `Vᵢ = σ_base²·Tᵢ + J²·[spans]` (a 2-coefficient least-squares regression). See the spec. - calibrateEventVolatility().return.assumptions: { conventionsVersion: string; method: string; eventDate: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - calibrateEventVolatility().return.assumptions.asOf: number; default: not declared — The valuation instant the maturities were measured from (epoch ms) — what {@link eventVolatilityAtExpiry} evaluates against. - calibrateEventVolatility().return.assumptions.conventionsVersion: string; default: not declared - calibrateEventVolatility().return.assumptions.eventDate: string; default: not declared - calibrateEventVolatility().return.assumptions.method: string; default: not declared - calibrateEventVolatility().return.baseVariance: number; default: not declared — `σ_base²` — the fitted continuous variance itself (exact; `baseVolatility` is its root). - calibrateEventVolatility().return.baseVolatility: number; default: not declared — Annualized continuous (non-event) vol `√σ_base²`. - calibrateEventVolatility().return.daysToEvent: number; default: not declared - calibrateEventVolatility().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calibrateEventVolatility().return.eventMove: number; default: not declared — Implied event move as a fraction of spot (`J`) — the "earnings move" (`spot·J` in price units). - calibrateEventVolatility().return.eventVariance: number; default: not declared — `J²` — the discrete event variance. - calibrateEventVolatility().return.perExpiry: import('@insiderfinance/totalfinance/volatility').FittedExpiry[]; default: not declared - calibrateEventVolatility().return.rSquared: number; default: not declared — Fit quality on total variance (1 = perfect). - calibrateEventVolatility(options): import('@insiderfinance/totalfinance/volatility').FitEventVolatilityOptions; default: not declared - calibrateEventVolatility(options).asOf: string | number; default: not declared - calibrateEventVolatility(options).baseVolatility?: number; default: not declared — Pin the continuous vol when the term structure can't identify it (single expiry / no maturity spread). - calibrateEventVolatility(options).eventDate: string; default: not declared — ISO date of the earnings/event. - calibrateEventVolatility(options).termStructure: readonly import('@insiderfinance/totalfinance/volatility').AtmVolatilityPoint[]; default: not declared — The ATM-vol term structure (≥ 1 expiry; ≥ 2 to fit both `σ_base` and `J`, unless `baseVolatility` given). - calibrateHestonSurface: (request: import('@insiderfinance/totalfinance/volatility/heston-surface').HestonSurfaceCalibrationInput) => import('@insiderfinance/totalfinance/volatility').HestonSurfaceFit; default: not declared - calibrateHestonSurface().return.assumptions: { conventionsVersion: string; targets: number; maximumIterations: number; initialParameters: 'supplied' | 'default'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - calibrateHestonSurface().return.assumptions.conventionsVersion: string; default: not declared - calibrateHestonSurface().return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether any starting member was caller-supplied (`initialParameters`) or all were data-derived. - calibrateHestonSurface().return.assumptions.maximumIterations: number; default: not declared - calibrateHestonSurface().return.assumptions.targets: number; default: not declared - calibrateHestonSurface().return.converged: boolean; default: not declared - calibrateHestonSurface().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present — a non-converged fit explains itself here. - calibrateHestonSurface().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - calibrateHestonSurface().return.parameters: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared - calibrateHestonSurface().return.rmse: number; default: not declared — Root-mean-square IV error across all calibration targets. - calibrateHestonSurface().return.rmseTolerance: number; default: not declared — The RMSE tolerance the `converged` flag was gated on (echoed for interpretability). - calibrateHestonSurface(request): import('@insiderfinance/totalfinance/volatility/heston-surface').HestonSurfaceCalibrationInput; default: not declared - calibrateHestonSurface(request).market: import('@insiderfinance/totalfinance/volatility').HestonSurfaceMarket; default: not declared - calibrateHestonSurface(request).options?: { initialParameters?: Partial; maximumIterations?: number; rmseTolerance?: number; terms?: number; }; default: not declared - calibrateHestonSurface(request).options.initialParameters?: Partial; default: not declared — Warm start — a partial pin of the five parameters (Stage 4.5; formerly `seed`, retired: `seed` names randomness everywhere else in the library). Unspecified members keep their data-derived starts (ATM variance for `v0`/`theta`, κ = 2, σ = 0.5, ρ = −0.5). - calibrateHestonSurface(request).options.initialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - calibrateHestonSurface(request).options.initialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - calibrateHestonSurface(request).options.initialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - calibrateHestonSurface(request).options.initialParameters.theta?: number; default: not declared — Long-run variance θ. - calibrateHestonSurface(request).options.initialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - calibrateHestonSurface(request).options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 300, maximum 10,000). - calibrateHestonSurface(request).options.rmseTolerance?: number; default: not declared — Max RMSE the `converged` flag tolerates (default 0.02 IV points). - calibrateHestonSurface(request).options.terms?: number; default: not declared — Heston COS expansion terms per target price (default 128, maximum 8,192). - calibrateHestonSurface(request).targets: readonly import('@insiderfinance/totalfinance/volatility').HestonSurfaceTarget[]; default: not declared - calibrateSabrSmile: (input: import('@insiderfinance/totalfinance/volatility').SABRSmileInput, options?: import('@insiderfinance/totalfinance/volatility').SABRCalibrationOptions) => import('@insiderfinance/totalfinance/volatility').SABRCalibrationResult; default: not declared - calibrateSabrSmile().return.assumptions: { conventionsVersion: string; beta: number; volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; initialParameters: 'supplied' | 'default'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - calibrateSabrSmile().return.assumptions.beta: number; default: not declared - calibrateSabrSmile().return.assumptions.conventionsVersion: string; default: not declared - calibrateSabrSmile().return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the ATM-derived default. - calibrateSabrSmile().return.assumptions.volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - calibrateSabrSmile().return.converged: boolean; default: not declared - calibrateSabrSmile().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings; a non-converged fit explains itself here. - calibrateSabrSmile().return.iterations: number; default: not declared - calibrateSabrSmile().return.parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - calibrateSabrSmile().return.rmse: number; default: not declared — Root-mean-square implied-volatility error of the fit. - calibrateSabrSmile(input): import('@insiderfinance/totalfinance/volatility').SABRSmileInput; default: not declared - calibrateSabrSmile(input).forward: number; default: not declared - calibrateSabrSmile(input).impliedVolatilities: number[]; default: not declared — Implied volatilities aligned to `strikes` (annualized decimals). - calibrateSabrSmile(input).strikes: number[]; default: not declared - calibrateSabrSmile(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - calibrateSabrSmile(options)?: import('@insiderfinance/totalfinance/volatility').SABRCalibrationOptions; default: not declared - calibrateSabrSmile(options).beta?: number; default: not declared — Backbone exponent β ∈ [0, 1] (default 0.5). - calibrateSabrSmile(options).initialParameters?: { alpha: number; rho: number; nu: number; }; default: not declared — Warm start for the `(α, ρ, ν)` search (Stage 4.5); `β` stays an option and is never fitted. Replaces the ATM-derived default start. - calibrateSabrSmile(options).initialParameters.alpha: number; default: not declared - calibrateSabrSmile(options).initialParameters.nu: number; default: not declared - calibrateSabrSmile(options).initialParameters.rho: number; default: not declared - calibrateSabrSmile(options).maximumIterations?: number; default: not declared — LM iteration budget (default 200, maximum 10,000). - calibrateSabrSmile(options).tolerance?: number; default: not declared — LM tolerance (default 1e-12). - calibrateSabrSmile(options).volatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — Hagan expansion to fit against (default `'lognormal'`). - calibrateSsvi: (surface: import('@insiderfinance/totalfinance/volatility').SSVICalibrationInput, options?: import('@insiderfinance/totalfinance/volatility').SSVICalibrationOptions) => import('@insiderfinance/totalfinance/volatility').SSVICalibration; default: not declared — Fit a calendar-arbitrage-free SSVI surface to a market total-variance surface: θ knots from each slice's ATM variance (made monotone), then a global `ρ` and `φ`-parameters by least squares. See the spec. - calibrateSsvi().return.arbitrage: import('@insiderfinance/totalfinance/volatility').SSVIArbitrage; default: not declared - calibrateSsvi().return.assumptions: { conventionsVersion: string; phi: 'power-law' | 'heston'; weight: 'uniform' | 'vega'; initialParameters: 'supplied' | 'default'; }; default: not declared - calibrateSsvi().return.assumptions.conventionsVersion: string; default: not declared - calibrateSsvi().return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the built-in start. - calibrateSsvi().return.assumptions.phi: 'power-law' | 'heston'; default: not declared - calibrateSsvi().return.assumptions.weight: 'vega' | 'uniform'; default: not declared - calibrateSsvi().return.converged: boolean; default: not declared - calibrateSsvi().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calibrateSsvi().return.parameters: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared - calibrateSsvi().return.perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - calibrateSsvi().return.rmse: number; default: not declared — Root-mean-square total-variance error across all points. - calibrateSsvi(options)?: import('@insiderfinance/totalfinance/volatility').SSVICalibrationOptions; default: not declared - calibrateSsvi(options).initialParameters?: { rho: number; phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; }; default: not declared — Warm start for the `(ρ, φ)` search (Stage 4.5): `phi.kind` must equal the calibration's `phi` family. The θ knots are fixed from the data and are not a start. - calibrateSsvi(options).initialParameters.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared - calibrateSsvi(options).initialParameters.rho: number; default: not declared - calibrateSsvi(options).maximumIterations?: number; default: not declared — Outer-search iteration budget (default 1,000, maximum 10,000). - calibrateSsvi(options).phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - calibrateSsvi(options).tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - calibrateSsvi(options).weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit and thin, low-vega wings are downweighted. - calibrateSsvi(surface): import('@insiderfinance/totalfinance/volatility').SSVICalibrationInput; default: not declared - calibrateSsvi(surface).slices: import('@insiderfinance/totalfinance/volatility').SSVISliceInput[]; default: not declared - calibrateSvi: (input: import('@insiderfinance/totalfinance/volatility').SVISmileInput, options?: import('@insiderfinance/totalfinance/volatility').SVICalibrationOptions) => import('@insiderfinance/totalfinance/volatility').SVICalibrationResult; default: not declared - calibrateSvi().return.assumptions: { conventionsVersion: string; method: 'zeliade-quasi-explicit'; points: number; initialParameters: 'supplied' | 'default'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - calibrateSvi().return.assumptions.conventionsVersion: string; default: not declared - calibrateSvi().return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the outer search began from a caller-supplied `initialParameters` or the built-in starts. - calibrateSvi().return.assumptions.method: 'zeliade-quasi-explicit'; default: not declared - calibrateSvi().return.assumptions.points: number; default: not declared - calibrateSvi().return.butterflyFree: boolean; default: not declared — Whether the fitted slice is butterfly-arbitrage-free (`g(k) ≥ 0` across the check grid). - calibrateSvi().return.converged: boolean; default: not declared — `false` when the outer search stopped early OR the fitted slice sits materially away from the input smile (the arbitrage projection — see {@link calibrateSvi}); the reason is always a `diagnostics.warnings` entry. Gate on it before trusting `parameters`. - calibrateSvi().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings; a non-converged or arbitrageable fit explains itself here. - calibrateSvi().return.iterations: number; default: not declared - calibrateSvi().return.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the check grid (`≥ 0` ⇔ arbitrage-free). - calibrateSvi().return.parameters: import('@insiderfinance/totalfinance/volatility').SVIParameters; default: not declared - calibrateSvi().return.rmse: number; default: not declared — Root-mean-square total-variance error of the fit. - calibrateSvi(input): import('@insiderfinance/totalfinance/volatility').SVISmileInput; default: not declared - calibrateSvi(input).k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - calibrateSvi(input).w: number[]; default: not declared — Total implied variance `σ²·t` aligned to `k`. - calibrateSvi(options)?: import('@insiderfinance/totalfinance/volatility').SVICalibrationOptions; default: not declared - calibrateSvi(options).initialParameters?: import('@insiderfinance/totalfinance/volatility').SVIWarmStart; default: not declared — Warm start for the outer `(m, σ)` search (Stage 4.5). Tried FIRST, ahead of the four built-in starts — ties keep the first, so a warm start never loses to a cold fit. `a`, `b`, and `ρ` are solved by the inner normal equations at every `(m, σ)` and are therefore not accepted as starts (a member the search cannot honor is refused, never ignored). - calibrateSvi(options).maximumIterations?: number; default: not declared — Outer-search iteration budget (default 400, maximum 10,000). - calibrateSvi(options).timeToExpiryYears?: number; default: not declared — The slice's maturity in years. Supplied ⇒ the fit-vs-data deviation check (see {@link calibrateSvi}) is expressed in true implied-VOL points, `σ = √(w/t)`. Omitted ⇒ `t = 1`, i.e. the check runs on `√w = σ√t` — still a vol scale, but shrunk by `√t` on a short slice. - calibrateSvi(options).tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - calibrateVannaVolga: (input: import('@insiderfinance/totalfinance/volatility').VannaVolgaInput) => import('@insiderfinance/totalfinance/volatility').VannaVolgaSmile; default: not declared — Construct a vanna–volga smile from the `(ATM, riskReversal, butterfly)` quotes and evaluate it at the requested strikes. The three market pillars (from {@link smileFromQuotes}) reprice exactly; strikes so far out of range that the VV price violates the no-arbitrage bounds cannot be inverted and are reported. See `docs/specs/vanna-volga.md`. - calibrateVannaVolga().return.assumptions: { conventionsVersion: string; method: 'vanna-volga'; deltaConvention: 'forward'; delta: number; }; default: not declared - calibrateVannaVolga().return.assumptions.conventionsVersion: string; default: not declared - calibrateVannaVolga().return.assumptions.delta: number; default: not declared - calibrateVannaVolga().return.assumptions.deltaConvention: 'forward'; default: not declared - calibrateVannaVolga().return.assumptions.method: 'vanna-volga'; default: not declared - calibrateVannaVolga().return.delta: number; default: not declared - calibrateVannaVolga().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calibrateVannaVolga().return.pillars: { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; }; default: not declared — The three market pillars the smile reprices exactly. - calibrateVannaVolga().return.pillars.atmStrike: number; default: not declared - calibrateVannaVolga().return.pillars.atmVolatility: number; default: not declared - calibrateVannaVolga().return.pillars.callStrike: number; default: not declared - calibrateVannaVolga().return.pillars.callVolatility: number; default: not declared - calibrateVannaVolga().return.pillars.putStrike: number; default: not declared - calibrateVannaVolga().return.pillars.putVolatility: number; default: not declared - calibrateVannaVolga().return.strikes: number[]; default: not declared — Requested strikes. - calibrateVannaVolga().return.volatilities: number[]; default: not declared — The constructed vol at each strike (aligned to `strikes`). - calibrateVannaVolga(input): import('@insiderfinance/totalfinance/volatility').VannaVolgaInput; default: not declared - calibrateVannaVolga(input).atmVolatility: number; default: not declared — ATM vol. - calibrateVannaVolga(input).butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - calibrateVannaVolga(input).delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - calibrateVannaVolga(input).forward: number; default: not declared — Forward price of the underlying. - calibrateVannaVolga(input).riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - calibrateVannaVolga(input).strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - calibrateVannaVolga(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - calibrateVannaVolga5: (input: import('@insiderfinance/totalfinance/volatility').VannaVolga5Input) => import('@insiderfinance/totalfinance/volatility').VannaVolga5Smile; default: not declared — Build the FX/crypto smile from the full five-quote set — ATM + the 25Δ and 10Δ risk reversal / butterfly — so it **exactly reprices all five market pillars** (10Δ put, 25Δ put, ATM, 25Δ call, 10Δ call) and pins the wings to real quotes instead of extrapolating them like the 3-pillar {@link calibrateVannaVolga} / {@link vannaVolgaApproximation}. The anchors come from {@link smileFromQuotes} at each delta; the smile is a shape-preserving PCHIP interpolation of total variance `σ²T` in log-moneyness (exact at the pillars, C¹ smooth, no overshoot). Exact repricing of arbitrary quotes can't guarantee no arbitrage, so the implied Breeden–Litzenberger density is checked across the pillar span and a butterfly arbitrage is a disclosed warning. See `docs/specs/vanna-volga-5.md`. - calibrateVannaVolga5().return.assumptions: { conventionsVersion: string; method: 'vanna-volga-5'; deltaConvention: 'forward'; interpolation: 'pchip-total-variance'; wingExtrapolation: 'flat' | 'linear'; }; default: not declared - calibrateVannaVolga5().return.assumptions.conventionsVersion: string; default: not declared - calibrateVannaVolga5().return.assumptions.deltaConvention: 'forward'; default: not declared - calibrateVannaVolga5().return.assumptions.interpolation: 'pchip-total-variance'; default: not declared - calibrateVannaVolga5().return.assumptions.method: 'vanna-volga-5'; default: not declared - calibrateVannaVolga5().return.assumptions.wingExtrapolation: 'flat' | 'linear'; default: not declared - calibrateVannaVolga5().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - calibrateVannaVolga5().return.innerDelta: number; default: not declared - calibrateVannaVolga5().return.outerDelta: number; default: not declared - calibrateVannaVolga5().return.pillars: import('@insiderfinance/totalfinance/volatility').VannaVolga5Pillar[]; default: not declared — The five market pillars the smile reprices exactly, low → high strike. - calibrateVannaVolga5().return.strikes: number[]; default: not declared - calibrateVannaVolga5().return.volatilities: number[]; default: not declared - calibrateVannaVolga5(input): import('@insiderfinance/totalfinance/volatility').VannaVolga5Input; default: not declared - calibrateVannaVolga5(input).atmVolatility: number; default: not declared - calibrateVannaVolga5(input).butterfly10: number; default: not declared - calibrateVannaVolga5(input).butterfly25: number; default: not declared - calibrateVannaVolga5(input).forward: number; default: not declared - calibrateVannaVolga5(input).innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - calibrateVannaVolga5(input).outerDelta?: number; default: not declared - calibrateVannaVolga5(input).riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - calibrateVannaVolga5(input).riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - calibrateVannaVolga5(input).strikes: number[]; default: not declared — Strikes to evaluate the smile at. - calibrateVannaVolga5(input).timeToExpiryYears: number; default: not declared - calibrateVannaVolga5(input).wingExtrapolation?: 'flat' | 'linear'; default: not declared — Wing extrapolation beyond the 10Δ pillars, in total variance: `flat` (default) or `linear`. - checkButterfly: (slice: import('@insiderfinance/totalfinance/volatility').ArbitrageSlice, options?: import('@insiderfinance/totalfinance/volatility').ButterflyCheckOptions) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Butterfly arbitrage: Gatheral's `g(k)` (∝ risk-neutral density) must stay non-negative. Envelope-shaped: `value` is the violation list, `assumptions.points` the resolution actually scanned (density-scaled from {@link ArbitrageSlice.strikes} when present) (Law 2 analysis grammar). - checkButterfly().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ tolerance: number; points: number; step?: number; }>; default: not declared — Every applied convention, echoed back. - checkButterfly().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - checkButterfly().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - checkButterfly().return.value: import('@insiderfinance/totalfinance/volatility').ArbitrageViolation[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - checkButterfly(options)?: import('@insiderfinance/totalfinance/volatility').ButterflyCheckOptions; default: not declared - checkButterfly(options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - checkButterfly(options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - checkButterfly(options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - checkButterfly(slice): import('@insiderfinance/totalfinance/volatility').ArbitrageSlice; default: not declared - checkButterfly(slice).expiry: string; default: not declared - checkButterfly(slice).forward: number; default: not declared — Forward price `S·e^{(r−q)t}`. - checkButterfly(slice).impliedVolatility: (strike: number) => number; default: not declared — Implied volatility at an absolute strike. - checkButterfly(slice).strikeRange: [number, number]; default: not declared — Fitted strike range `[Kmin, Kmax]`. - checkButterfly(slice).strikes?: readonly number[]; default: not declared — The slice's actual strike ladder, when known. Used ONLY to size the DEFAULT scan grids: the checks then sample at least {@link SAMPLES_PER_STRIKE_GAP} points per adjacent-strike gap, so a violation planted at a single strike cannot hide between two scan points (an explicit `butterflyPoints`/`calendarPoints` still wins). Omitted ⇒ the fixed 40/21-point defaults. - checkButterfly(slice).timeToExpiryYears: number; default: not declared — Time to expiry in years. - checkCalendar: (slices: import('@insiderfinance/totalfinance/volatility').ArbitrageSlice[], options?: import('@insiderfinance/totalfinance/volatility').CalendarCheckOptions) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Calendar arbitrage: total variance must not fall as maturity increases (at fixed forward-moneyness). Envelope-shaped: `value` is the violation list, `assumptions` echoes the scan knobs (`points` is the resolution actually scanned — see {@link ArbitrageSlice.strikes}), and `diagnostics` is the standard warnings carrier (Law 2 analysis grammar). - checkCalendar().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ tolerance: number; points: number; step?: number; }>; default: not declared — Every applied convention, echoed back. - checkCalendar().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - checkCalendar().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - checkCalendar().return.value: import('@insiderfinance/totalfinance/volatility').ArbitrageViolation[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - checkCalendar(options)?: import('@insiderfinance/totalfinance/volatility').CalendarCheckOptions; default: not declared - checkCalendar(options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - checkCalendar(options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - checkCalendar(slices): import('@insiderfinance/totalfinance/volatility').ArbitrageSlice[]; default: not declared - estimateVolatilitySpotBeta: (input: import('@insiderfinance/totalfinance/volatility').VolatilitySpotBetaInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - estimateVolatilitySpotBeta().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'real-world-hedge'; basis: 'log' | 'level'; hacLags: number; }>; default: not declared — Every applied convention, echoed back. - estimateVolatilitySpotBeta().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - estimateVolatilitySpotBeta().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - estimateVolatilitySpotBeta().return.value: import('@insiderfinance/totalfinance/volatility').VolatilitySpotBeta; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - estimateVolatilitySpotBeta(input): import('@insiderfinance/totalfinance/volatility').VolatilitySpotBetaInput; default: not declared - estimateVolatilitySpotBeta(input).basis?: 'log' | 'level'; default: not declared — Regress IV changes on log-returns (`'log'`, default) or dollar spot changes (`'level'`). - estimateVolatilitySpotBeta(input).hacLags?: number; default: not declared — Newey–West HAC bandwidth for autocorrelation-robust errors. Default 0 uses classical standard errors (no HAC request). - estimateVolatilitySpotBeta(input).impliedVolatility: number[]; default: not declared — The option's implied vol (decimal), aligned to `spot`. - estimateVolatilitySpotBeta(input).referenceSpot?: number; default: not declared — Reference spot to convert a log-basis slope to `∂σ/∂S` (default: the latest spot). - estimateVolatilitySpotBeta(input).spot: number[]; default: not declared — Chronological spot prices. - eventStrippedVolatility: import('@insiderfinance/totalfinance/core').Facade<{ atmVolatility: number; timeToExpiryYears: number; eventMove: number; }, number, { method: 'additive-event-variance'; }, number>; default: not declared — Plain de-earned volatility; use `.explain()` for assumptions and clamp diagnostics. - eventStrippedVolatility(input): { atmVolatility: number; timeToExpiryYears: number; eventMove: number; }; default: not declared - eventStrippedVolatility(input).atmVolatility: number; default: not declared - eventStrippedVolatility(input).eventMove: number; default: not declared - eventStrippedVolatility(input).timeToExpiryYears: number; default: not declared - eventStrippedVolatility.explain: (input: { atmVolatility: number; timeToExpiryYears: number; eventMove: number; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - eventStrippedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ method: 'additive-event-variance'; }>; default: not declared — Every applied convention, echoed back. - eventStrippedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - eventStrippedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - eventStrippedVolatility.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - eventStrippedVolatility.explain(input): { atmVolatility: number; timeToExpiryYears: number; eventMove: number; }; default: not declared - eventStrippedVolatility.explain(input).atmVolatility: number; default: not declared - eventStrippedVolatility.explain(input).eventMove: number; default: not declared - eventStrippedVolatility.explain(input).timeToExpiryYears: number; default: not declared - eventVolatilityAtExpiry: (input: { fit: import('@insiderfinance/totalfinance/volatility').EventVolatilityCalibration; expiries: readonly string[]; }) => import('@insiderfinance/totalfinance/volatility').EventVolatilityAtExpiryResult; default: not declared — Evaluate a fitted event-volatility model at any expiries — the forward door of {@link calibrateEventVolatility}: the ATM volatility the model implies at an expiry, whether or not that expiry was in the calibration (an expiry after the event carries the jump; one before it does not). Maturities are measured from the fit's own `assumptions.asOf`. - eventVolatilityAtExpiry().return.assumptions: { conventionsVersion: string; method: 'additive-event-variance'; eventDate: string; asOf: import('@insiderfinance/totalfinance/core').EpochMs; baseVolatility: number; eventMove: number; }; default: not declared - eventVolatilityAtExpiry().return.assumptions.asOf: number; default: not declared - eventVolatilityAtExpiry().return.assumptions.baseVolatility: number; default: not declared - eventVolatilityAtExpiry().return.assumptions.conventionsVersion: string; default: not declared - eventVolatilityAtExpiry().return.assumptions.eventDate: string; default: not declared - eventVolatilityAtExpiry().return.assumptions.eventMove: number; default: not declared - eventVolatilityAtExpiry().return.assumptions.method: 'additive-event-variance'; default: not declared - eventVolatilityAtExpiry().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - eventVolatilityAtExpiry().return.rows: import('@insiderfinance/totalfinance/volatility').EventVolatilityAtExpiryRow[]; default: not declared - eventVolatilityAtExpiry().return.values: number[]; default: not declared — The model ATM volatilities, aligned to `input.expiries`. - eventVolatilityAtExpiry(input): { fit: import('@insiderfinance/totalfinance/volatility').EventVolatilityCalibration; expiries: readonly string[]; }; default: not declared - eventVolatilityAtExpiry(input).expiries: readonly string[]; default: not declared - eventVolatilityAtExpiry(input).fit: import('@insiderfinance/totalfinance/volatility').EventVolatilityCalibration; default: not declared - eventVolatilityDecomposition: (options: { atmVolatility: number; timeToExpiryYears: number; baseVolatility: number; }) => import('@insiderfinance/totalfinance/volatility').EventVolatilityDecomposition; default: not declared — Decompose an event-spanning ATM vol into a continuous (diffusive) part and a discrete event jump (spec §10.3). With a base (non-event) vol `σ_base` for the same tenor, the event contributes `σ_atm²·t − σ_base²·t` of variance, i.e. an implied move of `√(that)` on the event day. - eventVolatilityDecomposition().return.assumptions: { conventionsVersion: string; timeToExpiryYears: number; method: 'additive-event-variance'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - eventVolatilityDecomposition().return.assumptions.conventionsVersion: string; default: not declared - eventVolatilityDecomposition().return.assumptions.method: 'additive-event-variance'; default: not declared - eventVolatilityDecomposition().return.assumptions.timeToExpiryYears: number; default: not declared - eventVolatilityDecomposition().return.baseVariance: number; default: not declared — Continuous (non-event) variance over the tenor `σ_base²·t`. - eventVolatilityDecomposition().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; a clamped (base > total) decomposition explains itself here. - eventVolatilityDecomposition().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - eventVolatilityDecomposition().return.eventMove: number; default: not declared — Implied one-event move as a fraction of spot, `√(eventVariance)` — the earnings/event jump size. - eventVolatilityDecomposition().return.eventVariance: number; default: not declared — Variance attributed to the discrete event `σ_atm²·t − σ_base²·t` (clamped ≥ 0). - eventVolatilityDecomposition().return.totalVariance: number; default: not declared — Total variance over the tenor `σ_atm²·t`. - eventVolatilityDecomposition(options): { atmVolatility: number; timeToExpiryYears: number; baseVolatility: number; }; default: not declared - eventVolatilityDecomposition(options).atmVolatility: number; default: not declared - eventVolatilityDecomposition(options).baseVolatility: number; default: not declared - eventVolatilityDecomposition(options).timeToExpiryYears: number; default: not declared - expectedMoveFromImpliedVolatility: import('@insiderfinance/totalfinance/core').Facade; default: not declared — FACADE (P3.2, one gesture): the plain call returns the {@link ExpectedMove} numbers; the same call's `.explain()` returns the full envelope with the risk-neutral caveat — exactly the `blackScholes.call` / `blackScholes.call.explain` grammar, one import away. - expectedMoveFromImpliedVolatility().return.expectedAbsolute: number; default: not declared — Expected absolute move `E|S_t − S_0| = oneSigma · √(2/π)` (≈ the ATM straddle price). - expectedMoveFromImpliedVolatility().return.lower: number; default: not declared — Spot − oneSigma. - expectedMoveFromImpliedVolatility().return.oneSigma: number; default: not declared — One standard-deviation move in price units: `spot · σ · √t`. - expectedMoveFromImpliedVolatility().return.oneSigmaFraction: number; default: not declared — One-σ move as a fraction of spot: `σ · √t`. - expectedMoveFromImpliedVolatility().return.upper: number; default: not declared — Spot + oneSigma. - expectedMoveFromImpliedVolatility(input): import('@insiderfinance/totalfinance/volatility').ExpectedMoveImpliedVolatilityInput; default: not declared - expectedMoveFromImpliedVolatility(input).impliedVolatility: number; default: not declared — Implied volatility (annualized decimal) — the one volatility vocabulary across the library. - expectedMoveFromImpliedVolatility(input).spot: number; default: not declared - expectedMoveFromImpliedVolatility(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - expectedMoveFromImpliedVolatility.explain: (input: import('@insiderfinance/totalfinance/volatility').ExpectedMoveImpliedVolatilityInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - expectedMoveFromImpliedVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'risk-neutral'; basis: 'lognormal-1sigma'; volatilitySource: string; }>; default: not declared — Every applied convention, echoed back. - expectedMoveFromImpliedVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - expectedMoveFromImpliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - expectedMoveFromImpliedVolatility.explain().return.value: import('@insiderfinance/totalfinance/volatility').ExpectedMove; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - expectedMoveFromImpliedVolatility.explain(input): import('@insiderfinance/totalfinance/volatility').ExpectedMoveImpliedVolatilityInput; default: not declared - expectedMoveFromImpliedVolatility.explain(input).impliedVolatility: number; default: not declared — Implied volatility (annualized decimal) — the one volatility vocabulary across the library. - expectedMoveFromImpliedVolatility.explain(input).spot: number; default: not declared - expectedMoveFromImpliedVolatility.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - expectedMoveFromStraddle: import('@insiderfinance/totalfinance/core').Facade; default: not declared — FACADE: plain {@link ExpectedMove}; `.explain()` for the envelope. - expectedMoveFromStraddle().return.expectedAbsolute: number; default: not declared — Expected absolute move `E|S_t − S_0| = oneSigma · √(2/π)` (≈ the ATM straddle price). - expectedMoveFromStraddle().return.lower: number; default: not declared — Spot − oneSigma. - expectedMoveFromStraddle().return.oneSigma: number; default: not declared — One standard-deviation move in price units: `spot · σ · √t`. - expectedMoveFromStraddle().return.oneSigmaFraction: number; default: not declared — One-σ move as a fraction of spot: `σ · √t`. - expectedMoveFromStraddle().return.upper: number; default: not declared — Spot + oneSigma. - expectedMoveFromStraddle(input): import('@insiderfinance/totalfinance/volatility').ExpectedMoveStraddleInput; default: not declared - expectedMoveFromStraddle(input).spot: number; default: not declared - expectedMoveFromStraddle(input).straddlePrice: number; default: not declared — The ATM straddle mid-price (call + put at the spot strike). - expectedMoveFromStraddle.explain: (input: import('@insiderfinance/totalfinance/volatility').ExpectedMoveStraddleInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - expectedMoveFromStraddle.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'risk-neutral'; basis: 'lognormal-1sigma'; volatilitySource: string; }>; default: not declared — Every applied convention, echoed back. - expectedMoveFromStraddle.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - expectedMoveFromStraddle.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - expectedMoveFromStraddle.explain().return.value: import('@insiderfinance/totalfinance/volatility').ExpectedMove; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - expectedMoveFromStraddle.explain(input): import('@insiderfinance/totalfinance/volatility').ExpectedMoveStraddleInput; default: not declared - expectedMoveFromStraddle.explain(input).spot: number; default: not declared - expectedMoveFromStraddle.explain(input).straddlePrice: number; default: not declared — The ATM straddle mid-price (call + put at the spot strike). - fitGarch: (returns: number[], options?: import('@insiderfinance/totalfinance/volatility').GarchFitOptions) => import('@insiderfinance/totalfinance/volatility').GarchFit; default: not declared — Fit a GARCH(1,1) model to a returns series by Gaussian MLE. The conditional variance follows `σ²ₜ = ω + α·r²ₜ₋₁ + β·σ²ₜ₋₁`, seeded with the sample second moment `E[r²]`. The optimizer works in the unconstrained space `θ = (log ω, logit p, logit f)` where `p = α+β` and `f = α/(α+β)`, so `ω>0, α≥0, β≥0, α+β<1` hold at every evaluation. A degenerate zero-second-moment series returns `converged: false`. Exact constants are degenerate in sample mode; in zero mode a nonzero constant retains its second moment about the declared zero mean. - fitGarch().return.alpha: number; default: not declared — ARCH coefficient on the lagged squared return (`≥ 0`). - fitGarch().return.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; mean: 'zero' | 'sample'; observations: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - fitGarch().return.assumptions.conventionsVersion: string; default: not declared - fitGarch().return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the primary start was caller-supplied (`initialParameters`) or the classic (0.05, 0.90). - fitGarch().return.assumptions.mean: 'zero' | 'sample'; default: not declared - fitGarch().return.assumptions.observations: number; default: not declared - fitGarch().return.beta: number; default: not declared — GARCH coefficient on the lagged conditional variance (`≥ 0`). - fitGarch().return.converged: boolean; default: not declared — Whether the optimizer converged (never fabricated). - fitGarch().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; a degenerate / non-converged fit explains itself here. - fitGarch().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - fitGarch().return.iterations: number; default: not declared — Optimizer iterations performed. - fitGarch().return.logLikelihood: number | null; default: not declared — Maximized Gaussian log-likelihood; `null` when the likelihood is degenerate (disclosed). - fitGarch().return.longRunVariance: number; default: not declared — Unconditional variance `ω / (1 − α − β)` the forecast mean-reverts to. - fitGarch().return.omega: number; default: not declared — Constant term of the variance recursion (`> 0`). - fitGarch().return.persistence: number; default: not declared — `α + β` — the variance half-life driver; `< 1` for a stationary fit. - fitGarch(options)?: import('@insiderfinance/totalfinance/volatility').GarchFitOptions; default: not declared - fitGarch(options).initialParameters?: { alpha: number; beta: number; }; default: not declared — Warm start for the `(α, β)` search (Stage 4.5): replaces the primary `(0.05, 0.90)` start; `ω` is derived by variance targeting and is not a start. The seeded restarts still run. - fitGarch(options).initialParameters.alpha: number; default: not declared - fitGarch(options).initialParameters.beta: number; default: not declared - fitGarch(options).mean?: 'zero' | 'sample'; default: not declared — `'zero'` (default) fits second moments about zero; `'sample'` de-means first. A nonzero constant has a positive second moment in zero mode but is degenerate in sample mode. - fitGarch(options).seed?: number; default: not declared — Seed for the deterministic multi-start of the optimizer (default `0x61726368`). - fitGarch(returns): number[]; default: not declared - fitHarRv: (realizedVariances: number[], options?: import('@insiderfinance/totalfinance/volatility').HarRvOptions) => import('@insiderfinance/totalfinance/volatility').HarRvFit; default: not declared — Fit a HAR-RV (heterogeneous autoregressive) model to a realized-variance series by OLS. Regresses `RVₜ` on `[1, RVₜ₋₁, avg(last {@link HarRvOptions.weekly}), avg(last {@link HarRvOptions.monthly})]`. The 4×4 least-squares system is solved by QR (stable — no normal-equations conditioning penalty). Requires more than `monthly` observations, with at least {@link HAR_PREDICTORS} fitted rows so the system is well-posed. - fitHarRv().return.assumptions: { conventionsVersion: string; method: 'ols-qr'; weekly: number; monthly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - fitHarRv().return.assumptions.conventionsVersion: string; default: not declared - fitHarRv().return.assumptions.method: 'ols-qr'; default: not declared - fitHarRv().return.assumptions.monthly: number; default: not declared - fitHarRv().return.assumptions.weekly: number; default: not declared - fitHarRv().return.coefficients: import('@insiderfinance/totalfinance/volatility').HarRvCoefficients; default: not declared - fitHarRv().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - fitHarRv().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - fitHarRv().return.observationCount: number; default: not declared — Number of fitted observations. - fitHarRv().return.rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - fitHarRv().return.residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - fitHarRv().return.windows: { weekly: number; monthly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - fitHarRv().return.windows.monthly: number; default: not declared - fitHarRv().return.windows.weekly: number; default: not declared - fitHarRv(options)?: import('@insiderfinance/totalfinance/volatility').HarRvOptions; default: not declared - fitHarRv(options).monthly?: number; default: not declared — Monthly averaging window in observations (default 22). - fitHarRv(options).weekly?: number; default: not declared — Weekly averaging window in observations (default 5). - fitHarRv(realizedVariances): number[]; default: not declared - forwardSkew: import('@insiderfinance/totalfinance/volatility').ForwardSkewFacade; default: not declared — Forward skew: the skew slope of the *forward-starting* smile between two expiries, built from the added forward variance at fixed forward-log-moneyness. `d(σ_fwd)/d(logMoneyness)` via a central difference, where `σ_fwd(k) = √((w_far(k) − w_near(k))/(t_far − t_near))`. Throws the same {@link ArbitrageError} (`volatility.calendar_arbitrage`) as {@link forwardVolatility} when the forward variance is negative at either sampled `k` — a forward smile that does not exist is reported, never clamped to zero and differenced into a plausible-looking number. Facade (H23): the plain call returns the scalar; `.explain()` discloses the applied `step` in `assumptions` and BOTH total-variance calculations (the `k = +step` and `k = −step` legs) in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the closed-request teaching error for a `null` options bag stays byte-identical. - forwardSkew(from): string | number; default: not declared - forwardSkew(options)?: { step?: number; } | undefined; default: not declared - forwardSkew(options).step?: number; default: not declared - forwardSkew(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - forwardSkew(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - forwardSkew(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - forwardSkew(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - forwardSkew(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - forwardSkew(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - forwardSkew(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - forwardSkew(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - forwardSkew(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - forwardSkew(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - forwardSkew(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - forwardSkew(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - forwardSkew(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - forwardSkew(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - forwardSkew(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - forwardSkew(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - forwardSkew(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - forwardSkew(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - forwardSkew(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - forwardSkew(to): string | number; default: not declared - forwardSkew.explain: (surface: import('@insiderfinance/totalfinance/volatility').VolatilitySurface, from: string | number, to: string | number, options?: { step?: number; }) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/volatility').ForwardSkewAssumptions; }; default: not declared - forwardSkew.explain().return.assumptions: import('@insiderfinance/totalfinance/volatility').ForwardSkewAssumptions; default: not declared - forwardSkew.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - forwardSkew.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - forwardSkew.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - forwardSkew.explain(from): string | number; default: not declared - forwardSkew.explain(options)?: { step?: number; } | undefined; default: not declared - forwardSkew.explain(options).step?: number; default: not declared - forwardSkew.explain(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - forwardSkew.explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - forwardSkew.explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - forwardSkew.explain(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - forwardSkew.explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - forwardSkew.explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - forwardSkew.explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - forwardSkew.explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - forwardSkew.explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - forwardSkew.explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - forwardSkew.explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - forwardSkew.explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - forwardSkew.explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - forwardSkew.explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - forwardSkew.explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - forwardSkew.explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - forwardSkew.explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - forwardSkew.explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - forwardSkew.explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - forwardSkew.explain(to): string | number; default: not declared - forwardVolatility: import('@insiderfinance/totalfinance/volatility').ForwardVolatilityFacade; default: not declared — Forward-starting ATM volatility between two expiries from ATM total variance: `√((w_far − w_near)/(t_far − t_near))`. Throws an {@link ArbitrageError} (`volatility.calendar_arbitrage`) if the implied forward variance is negative (an ATM calendar-arbitrage breach). Facade (H21): the plain call returns the scalar; `.explain()` discloses the resolved near/far expiries and year fractions in `assumptions`, and the ATM total variances / forward variance / time gap the square root came from in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the plain call's first-touch teaching errors stay byte-identical. - forwardVolatility(from): string | number; default: not declared - forwardVolatility(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - forwardVolatility(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - forwardVolatility(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - forwardVolatility(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - forwardVolatility(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - forwardVolatility(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - forwardVolatility(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - forwardVolatility(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - forwardVolatility(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - forwardVolatility(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - forwardVolatility(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - forwardVolatility(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - forwardVolatility(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - forwardVolatility(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - forwardVolatility(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - forwardVolatility(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - forwardVolatility(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - forwardVolatility(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - forwardVolatility(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - forwardVolatility(to): string | number; default: not declared - forwardVolatility.explain: (surface: import('@insiderfinance/totalfinance/volatility').VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/volatility').ForwardVolatilityAssumptions; }; default: not declared - forwardVolatility.explain().return.assumptions: import('@insiderfinance/totalfinance/volatility').ForwardVolatilityAssumptions; default: not declared - forwardVolatility.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - forwardVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - forwardVolatility.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - forwardVolatility.explain(from): string | number; default: not declared - forwardVolatility.explain(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - forwardVolatility.explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - forwardVolatility.explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - forwardVolatility.explain(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - forwardVolatility.explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - forwardVolatility.explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - forwardVolatility.explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - forwardVolatility.explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - forwardVolatility.explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - forwardVolatility.explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - forwardVolatility.explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - forwardVolatility.explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - forwardVolatility.explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - forwardVolatility.explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - forwardVolatility.explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - forwardVolatility.explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - forwardVolatility.explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - forwardVolatility.explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - forwardVolatility.explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - forwardVolatility.explain(to): string | number; default: not declared - garchForecast: (input: import('@insiderfinance/totalfinance/volatility/forecast').GarchForecastInput) => import('@insiderfinance/totalfinance/volatility').GarchForecast; default: not declared - garchForecast().return.annualizedVolatility: number[]; default: not declared — `√(σ²ₜ₊ₕ · periodsPerYear)` — the annualized volatility. - garchForecast().return.assumptions: { conventionsVersion: string; periodsPerYear: number; horizonPeriods: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - garchForecast().return.assumptions.conventionsVersion: string; default: not declared - garchForecast().return.assumptions.horizonPeriods: number; default: not declared - garchForecast().return.assumptions.periodsPerYear: number; default: not declared - garchForecast().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - garchForecast().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - garchForecast().return.variancePath: number[]; default: not declared — `σ²ₜ₊ₕ` for `h = 1..horizonPeriods`. - garchForecast().return.volatilityPath: number[]; default: not declared — `√σ²ₜ₊ₕ` — the per-period volatility. - garchForecast(input): import('@insiderfinance/totalfinance/volatility/forecast').GarchForecastInput; default: not declared - garchForecast(input).fit: import('@insiderfinance/totalfinance/volatility').GarchFit; default: not declared - garchForecast(input).horizonPeriods: number; default: not declared - garchForecast(input).lastVariance: number; default: not declared - garchForecast(input).options?: import('@insiderfinance/totalfinance/volatility').GarchForecastOptions; default: not declared - harRvForecast: import('@insiderfinance/totalfinance/volatility').HarRvForecastFacade; default: not declared — One-step-ahead HAR-RV forecast from the latest daily/weekly/monthly aggregates of `history`, using the same windows the model was fit with. Requires at least `monthly` observations. A NEGATIVE forecast throws (`volatility.negative_variance_forecast`): the linear model can extrapolate below zero, and a negative variance is not a variance — it is never clamped, and never returned as if it were a successful forecast. `.explain()` throws the same typed error — a failed model output is never softened into an envelope. Facade (H24): the plain call returns the scalar; `.explain()` discloses the fitted windows in `assumptions`, and the three predictors plus the per-term regression contributions (which sum to the raw model output, i.e. the value) in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the closed-request teaching error for a hand-rolled `fit` stays byte-identical. - harRvForecast(fit): import('@insiderfinance/totalfinance/volatility').HarRvFit; default: not declared - harRvForecast(fit).assumptions: { conventionsVersion: string; method: 'ols-qr'; weekly: number; monthly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - harRvForecast(fit).assumptions.conventionsVersion: string; default: not declared - harRvForecast(fit).assumptions.method: 'ols-qr'; default: not declared - harRvForecast(fit).assumptions.monthly: number; default: not declared - harRvForecast(fit).assumptions.weekly: number; default: not declared - harRvForecast(fit).coefficients: import('@insiderfinance/totalfinance/volatility').HarRvCoefficients; default: not declared - harRvForecast(fit).diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - harRvForecast(fit).diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - harRvForecast(fit).observationCount: number; default: not declared — Number of fitted observations. - harRvForecast(fit).rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - harRvForecast(fit).residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - harRvForecast(fit).windows: { weekly: number; monthly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - harRvForecast(fit).windows.monthly: number; default: not declared - harRvForecast(fit).windows.weekly: number; default: not declared - harRvForecast(history): number[]; default: not declared - harRvForecast.explain: (fit: import('@insiderfinance/totalfinance/volatility').HarRvFit, history: number[]) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/volatility').HarRvForecastAssumptions; }; default: not declared - harRvForecast.explain().return.assumptions: import('@insiderfinance/totalfinance/volatility').HarRvForecastAssumptions; default: not declared - harRvForecast.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - harRvForecast.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - harRvForecast.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - harRvForecast.explain(fit): import('@insiderfinance/totalfinance/volatility').HarRvFit; default: not declared - harRvForecast.explain(fit).assumptions: { conventionsVersion: string; method: 'ols-qr'; weekly: number; monthly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - harRvForecast.explain(fit).assumptions.conventionsVersion: string; default: not declared - harRvForecast.explain(fit).assumptions.method: 'ols-qr'; default: not declared - harRvForecast.explain(fit).assumptions.monthly: number; default: not declared - harRvForecast.explain(fit).assumptions.weekly: number; default: not declared - harRvForecast.explain(fit).coefficients: import('@insiderfinance/totalfinance/volatility').HarRvCoefficients; default: not declared - harRvForecast.explain(fit).diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - harRvForecast.explain(fit).diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - harRvForecast.explain(fit).observationCount: number; default: not declared — Number of fitted observations. - harRvForecast.explain(fit).rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - harRvForecast.explain(fit).residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - harRvForecast.explain(fit).windows: { weekly: number; monthly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - harRvForecast.explain(fit).windows.monthly: number; default: not declared - harRvForecast.explain(fit).windows.weekly: number; default: not declared - harRvForecast.explain(history): number[]; default: not declared - impliedVolatilityPercentile: import('@insiderfinance/totalfinance/core').Facade; default: not declared - impliedVolatilityPercentile(input): import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput; default: not declared - impliedVolatilityPercentile(input).current: number; default: not declared — Current implied volatility (annualized decimal). - impliedVolatilityPercentile(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - impliedVolatilityPercentile.explain: (input: import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - impliedVolatilityPercentile.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; method: 'rank' | 'percentile' | 'stats'; }>; default: not declared — Every applied convention, echoed back. - impliedVolatilityPercentile.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - impliedVolatilityPercentile.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatilityPercentile.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatilityPercentile.explain(input): import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput; default: not declared - impliedVolatilityPercentile.explain(input).current: number; default: not declared — Current implied volatility (annualized decimal). - impliedVolatilityPercentile.explain(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - impliedVolatilityRank: import('@insiderfinance/totalfinance/core').Facade; default: not declared — FACADES (P3.2, one gesture): plain value from the call; the same call's `.explain()` returns the envelope (window, method, and the flat-history caveat when rank is undefined). Single-object input per Decision 3 — `impliedVolatilityRank({ current, history })`. - impliedVolatilityRank(input): import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput; default: not declared - impliedVolatilityRank(input).current: number; default: not declared — Current implied volatility (annualized decimal). - impliedVolatilityRank(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - impliedVolatilityRank.explain: (input: import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - impliedVolatilityRank.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; method: 'rank' | 'percentile' | 'stats'; }>; default: not declared — Every applied convention, echoed back. - impliedVolatilityRank.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - impliedVolatilityRank.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatilityRank.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatilityRank.explain(input): import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput; default: not declared - impliedVolatilityRank.explain(input).current: number; default: not declared — Current implied volatility (annualized decimal). - impliedVolatilityRank.explain(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - impliedVolatilityStatistics: import('@insiderfinance/totalfinance/core').Facade; default: not declared - impliedVolatilityStatistics().return.current: number; default: not declared - impliedVolatilityStatistics().return.max: number; default: not declared - impliedVolatilityStatistics().return.mean: number; default: not declared - impliedVolatilityStatistics().return.min: number; default: not declared - impliedVolatilityStatistics().return.observations: number; default: not declared - impliedVolatilityStatistics().return.percentile: number; default: not declared - impliedVolatilityStatistics().return.rank: number | null; default: not declared — `null` for a flat history (rank undefined — disclosed via `implied_volatility.flat_history`). - impliedVolatilityStatistics(input): import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput; default: not declared - impliedVolatilityStatistics(input).current: number; default: not declared — Current implied volatility (annualized decimal). - impliedVolatilityStatistics(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - impliedVolatilityStatistics.explain: (input: import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - impliedVolatilityStatistics.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; method: 'rank' | 'percentile' | 'stats'; }>; default: not declared — Every applied convention, echoed back. - impliedVolatilityStatistics.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - impliedVolatilityStatistics.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatilityStatistics.explain().return.value: import('@insiderfinance/totalfinance/volatility').ImpliedVolatilityStatistics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatilityStatistics.explain(input): import('@insiderfinance/totalfinance/volatility/metrics').ImpliedVolatilityMetricInput; default: not declared - impliedVolatilityStatistics.explain(input).current: number; default: not declared — Current implied volatility (annualized decimal). - impliedVolatilityStatistics.explain(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - localVolatilitySurface: (input: import('@insiderfinance/totalfinance/volatility/local-volatility').LocalVolatilitySurfaceInput) => import('@insiderfinance/totalfinance/volatility').LocalVolatilitySurface; default: not declared — Fit a Dupire local-volatility surface from an implied-vol function `σ_imp(strike, t)` and market context. - localVolatilitySurface().return.grid: (specification: import('@insiderfinance/totalfinance/options').LocalVolatilityGridSpecification) => import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared — A grid-cached local-volatility function over the given (level, time) knots — bilinearly interpolated and far cheaper to evaluate inside a Monte-Carlo simulation than the raw finite-difference transform. - localVolatilitySurface().return.localVolatility: (level: number, timeToExpiryYears: number) => number; default: not declared — Dupire local volatility `σ_loc(level, t)` (level = underlying price, t in years). - localVolatilitySurface(input): import('@insiderfinance/totalfinance/volatility/local-volatility').LocalVolatilitySurfaceInput; default: not declared - localVolatilitySurface(input).impliedVolatility: (strike: number, timeToExpiryYears: number) => number; default: not declared - localVolatilitySurface(input).market: import('@insiderfinance/totalfinance/options').LocalVolatilityMarket; default: not declared - localVolatilitySurface(input).options?: import('@insiderfinance/totalfinance/options').DupireOptions; default: not declared - minimumVarianceDelta: (options: import('@insiderfinance/totalfinance/volatility').MinimumVarianceDeltaOptions) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — The minimum-variance (smile-adjusted) delta for one option. Composes `blackScholesGreeks` (for `Δ_BS` and vega) with a vol–spot sensitivity `β`. See the spec — β should be empirical (leverage) for a true minimum-variance hedge; the skew-derived regimes are smile models, not the leverage effect. - minimumVarianceDelta().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'real-world-hedge'; betaSource: string; regime?: string; }>; default: not declared — Every applied convention, echoed back. - minimumVarianceDelta().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - minimumVarianceDelta().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - minimumVarianceDelta().return.value: import('@insiderfinance/totalfinance/volatility').MinimumVarianceDeltaResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - minimumVarianceDelta(options): import('@insiderfinance/totalfinance/volatility').MinimumVarianceDeltaOptions; default: not declared - minimumVarianceDelta(options).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - minimumVarianceDelta(options).regime?: 'sticky-strike' | 'sticky-moneyness'; default: not declared — How `skewSlope` maps to β. Default `'sticky-moneyness'`. - minimumVarianceDelta(options).riskFreeRate: number; default: not declared - minimumVarianceDelta(options).skewSlope?: number; default: not declared — ∂σ/∂ln(K) (`SkewMetrics.skewSlope`) — mapped to β via `regime`. - minimumVarianceDelta(options).spot: number; default: not declared - minimumVarianceDelta(options).strike: number; default: not declared - minimumVarianceDelta(options).timeToExpiryYears: number; default: not declared — Time to expiry in years. - minimumVarianceDelta(options).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - minimumVarianceDelta(options).volatility: number; default: not declared — The option's implied vol (decimal). - minimumVarianceDelta(options).volatilitySpotBeta?: number; default: not declared — ∂σ/∂S directly (decimal vol **per $1 of spot**) — the empirical / minimum-variance β (preferred). Take it from `estimateVolatilitySpotBeta(...).value.volatilitySpotBeta`, which is already in these units. `stickyRegime`'s `volatilitySpotBetaPerLogSpot` is ∂σ/∂lnS — `S ×` larger — so divide it by spot before passing it here, or the smile adjustment is scaled by the spot price. - observedSkew: (input: import('@insiderfinance/totalfinance/volatility').ObservedSkewInput) => import('@insiderfinance/totalfinance/volatility').ObservedSkewResult; default: not declared — Observe a single expiry. Compose separate calls for a term structure; compare their mean ATM IVs only when available. IV/RR/BF/spreads are decimals (multiply by 100 for IV-point displays). Missing IV/delta is omission, not null/NaN/zero. Missing wings and insufficient/expired samples return null with reasons. Supplied malformed values throw; no alternate quote/date shapes, delta recomputation, interpolation, forward adjustment or tail extrapolation is performed. Distance ties and inclusive boundaries allow only 4 × machine epsilon at the arithmetic operand scale. Ties are measured against the global minimum, then use the disclosed lower-strike order; an exact observed target always wins and a zero delta tolerance remains strictly exact. - observedSkew().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - observedSkew().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - observedSkew().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - observedSkew().return.value: import('@insiderfinance/totalfinance/volatility').ObservedSkewMetrics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - observedSkew(input): import('@insiderfinance/totalfinance/volatility').ObservedSkewInput; default: not declared - observedSkew(input).config: import('@insiderfinance/totalfinance/volatility').ObservedSkewConfig; default: not declared - observedSkew(input).market: Pick; default: not declared — No rate, yield, volatility, clock default, or forward inference is used. - observedSkew(input).market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - observedSkew(input).market.spot: number; default: not declared - observedSkew(input).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - probabilityInTheMoney: import('@insiderfinance/totalfinance/core').Facade; default: not declared — FACADE: plain probability; `.explain()` carries the risk-neutral disclosure. - probabilityInTheMoney(input): import('@insiderfinance/totalfinance/volatility').ProbabilityInTheMoneyInput; default: not declared - probabilityInTheMoney(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - probabilityInTheMoney(input).riskFreeRate: number; default: not declared - probabilityInTheMoney(input).spot: number; default: not declared - probabilityInTheMoney(input).strike: number; default: not declared - probabilityInTheMoney(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - probabilityInTheMoney(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - probabilityInTheMoney(input).volatility: number; default: not declared — Implied volatility (annualized decimal). - probabilityInTheMoney.explain: (input: import('@insiderfinance/totalfinance/volatility').ProbabilityInTheMoneyInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - probabilityInTheMoney.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'risk-neutral'; drift: string; }>; default: not declared — Every applied convention, echoed back. - probabilityInTheMoney.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - probabilityInTheMoney.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - probabilityInTheMoney.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - probabilityInTheMoney.explain(input): import('@insiderfinance/totalfinance/volatility').ProbabilityInTheMoneyInput; default: not declared - probabilityInTheMoney.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - probabilityInTheMoney.explain(input).riskFreeRate: number; default: not declared - probabilityInTheMoney.explain(input).spot: number; default: not declared - probabilityInTheMoney.explain(input).strike: number; default: not declared - probabilityInTheMoney.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - probabilityInTheMoney.explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - probabilityInTheMoney.explain(input).volatility: number; default: not declared — Implied volatility (annualized decimal). - probabilityOfTouch: import('@insiderfinance/totalfinance/core').Facade; default: not declared — FACADE: plain first-passage probability; `.explain()` for the envelope. - probabilityOfTouch(input): import('@insiderfinance/totalfinance/volatility').ProbabilityOfTouchInput; default: not declared - probabilityOfTouch(input).barrier: number; default: not declared - probabilityOfTouch(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - probabilityOfTouch(input).riskFreeRate: number; default: not declared - probabilityOfTouch(input).spot: number; default: not declared - probabilityOfTouch(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - probabilityOfTouch(input).volatility: number; default: not declared — Implied volatility (annualized decimal). - probabilityOfTouch.explain: (input: import('@insiderfinance/totalfinance/volatility').ProbabilityOfTouchInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - probabilityOfTouch.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'risk-neutral'; drift: string; }>; default: not declared — Every applied convention, echoed back. - probabilityOfTouch.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - probabilityOfTouch.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - probabilityOfTouch.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - probabilityOfTouch.explain(input): import('@insiderfinance/totalfinance/volatility').ProbabilityOfTouchInput; default: not declared - probabilityOfTouch.explain(input).barrier: number; default: not declared - probabilityOfTouch.explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - probabilityOfTouch.explain(input).riskFreeRate: number; default: not declared - probabilityOfTouch.explain(input).spot: number; default: not declared - probabilityOfTouch.explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - probabilityOfTouch.explain(input).volatility: number; default: not declared — Implied volatility (annualized decimal). - realizedImpliedSpread: (input: import('@insiderfinance/totalfinance/volatility/event').RealizedImpliedInput) => number; default: not declared - realizedImpliedSpread(input): import('@insiderfinance/totalfinance/volatility/event').RealizedImpliedInput; default: not declared - realizedImpliedSpread(input).impliedVolatility: number; default: not declared — Annualized implied volatility (decimal). - realizedImpliedSpread(input).realizedVolatility: number; default: not declared — Annualized realized volatility (decimal) — e.g. `historicalVolatility(closes, { period, annualization: 252 })`. - riskNeutralDistribution: (volatilitySmile: (strike: number) => number, options: import('@insiderfinance/totalfinance/volatility').RiskNeutralOptions) => import('@insiderfinance/totalfinance/volatility').RiskNeutralDistribution; default: not declared — Breeden–Litzenberger (1978): the risk-neutral terminal distribution implied by a call-price curve. Given the smile `volatilitySmile(strike)`, prices calls via BSM and differentiates numerically: `f(K) = e^{rT}·∂²C/∂K²` and `F(K) = 1 + e^{rT}·∂C/∂K`. Use it for probability cones / expected-range bands. The smile must be arbitrage-free for the density to stay non-negative. Where it repairs itself, it SAYS SO on the returned `diagnostics`: a negative (arbitrageable) density clamped to zero, and the one-sided difference used for strikes within `step` of zero (a deep-downside probe like `density(0.05)` on a $100 name, which used to price a negative strike and return `NaN`). `diagnostics.warnings` fills in as the closures are queried — read it after use. - riskNeutralDistribution().return.cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + e^{rT}·∂C/∂K`, clamped to [0, 1]. - riskNeutralDistribution().return.density: (strike: number) => number; default: not declared — Risk-neutral PDF at strike `K`: `e^{rT}·∂²C/∂K²` (clamped ≥ 0 — see {@link diagnostics}). - riskNeutralDistribution().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — LIVE disclosure channel for the two places this object silently repairs itself — it accumulates as the closures are called, so read it AFTER querying (it starts empty): • `model.limitation` "negative density clamped" — `∂²C/∂K²` came out negative, which means the smile is butterfly-arbitrageable there. The clamp keeps `density()` a density; the warning stops a caller integrating a repaired curve and calling it the market's distribution. • `model.limitation` "one-sided difference" — a query within `step` of zero, where the centred difference would price a NEGATIVE strike (which returned `NaN`). - riskNeutralDistribution().return.probabilityAbove: (strike: number) => number; default: not declared - riskNeutralDistribution().return.probabilityBelow: (strike: number) => number; default: not declared - riskNeutralDistribution().return.probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared - riskNeutralDistribution(options): import('@insiderfinance/totalfinance/volatility').RiskNeutralOptions; default: not declared - riskNeutralDistribution(options).dividendYield?: number; default: not declared - riskNeutralDistribution(options).riskFreeRate: number; default: not declared - riskNeutralDistribution(options).spot: number; default: not declared - riskNeutralDistribution(options).step?: number; default: not declared — Central-difference step in strike (default `spot · 0.001`). - riskNeutralDistribution(options).timeToExpiryYears: number; default: not declared — Time to expiry in years. - riskNeutralDistribution(volatilitySmile): (strike: number) => number; default: not declared - riskReversalButterfly: (input: import('@insiderfinance/totalfinance/volatility').RiskReversalButterflyInput) => import('@insiderfinance/totalfinance/volatility').RiskReversalButterfly; default: not declared — Decompose a smile into the ATM vol, the δ-delta **risk reversal** (`callVolatility − putVolatility`, the skew) and **butterfly** (`(callVolatility + putVolatility)/2 − ATM`, the curvature) — the standard FX/crypto quoting triple. Forward delta throughout. See `docs/specs/risk-reversal-butterfly.md`. - riskReversalButterfly().return.assumptions: { conventionsVersion: string; deltaConvention: 'forward'; delta: number; }; default: not declared - riskReversalButterfly().return.assumptions.conventionsVersion: string; default: not declared - riskReversalButterfly().return.assumptions.delta: number; default: not declared - riskReversalButterfly().return.assumptions.deltaConvention: 'forward'; default: not declared - riskReversalButterfly().return.atmVolatility: number; default: not declared — ATM vol (at `K = forward`). - riskReversalButterfly().return.butterfly: number; default: not declared — `(callVolatility + putVolatility)/2 − atmVolatility` — the curvature (> 0 ⇒ smile). - riskReversalButterfly().return.callStrike: number; default: not declared — The δ-delta call strike. - riskReversalButterfly().return.callVolatility: number; default: not declared — The vol at the call strike. - riskReversalButterfly().return.delta: number; default: not declared - riskReversalButterfly().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - riskReversalButterfly().return.putStrike: number; default: not declared — The δ-delta put strike. - riskReversalButterfly().return.putVolatility: number; default: not declared — The vol at the put strike. - riskReversalButterfly().return.riskReversal: number; default: not declared — `callVolatility − putVolatility` — the skew (< 0 ⇒ puts bid). - riskReversalButterfly(input): import('@insiderfinance/totalfinance/volatility').RiskReversalButterflyInput; default: not declared - riskReversalButterfly(input).delta?: number; default: not declared — Delta level for the wings (0.25 = 25-delta). Default 0.25. Must be in `(0, 0.5)`. - riskReversalButterfly(input).forward: number; default: not declared — Forward price of the underlying. - riskReversalButterfly(input).smile: (strike: number) => number; default: not declared — The smile: strike → implied vol (from any fit — SVI, SSVI, volatilitySurface, …). - riskReversalButterfly(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - sabrBartlettGreeks: (request: import('@insiderfinance/totalfinance/volatility/sabr-delta').SabrBartlettGreeksInput) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Bartlett (2006) minimum-variance delta, vega & gamma for a SABR-parametrised option — the model-consistent hedges that account for the correlated forward/vol dynamics. Composes `sabrPrice` (naive delta/vega/gamma) with the correlation coupling `ρν/F^β` (delta) and `ρF^β/ν` (vega); the Bartlett gamma is the price convexity along the correlated hedge path. Greeks are w.r.t. the **forward**, as in `sabrPrice`. Each is reported alongside its naive counterpart and the adjustment. See `docs/specs/sabr-bartlett-delta.md` and `docs/specs/sabr-bartlett-gamma.md`. - sabrBartlettGreeks().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'min-variance-hedge'; volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; }>; default: not declared — Every applied convention, echoed back. - sabrBartlettGreeks().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - sabrBartlettGreeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - sabrBartlettGreeks().return.value: import('@insiderfinance/totalfinance/volatility').SabrBartlettGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - sabrBartlettGreeks(request): import('@insiderfinance/totalfinance/volatility/sabr-delta').SabrBartlettGreeksInput; default: not declared - sabrBartlettGreeks(request).input: import('@insiderfinance/totalfinance/options').SabrInput; default: not declared - sabrBartlettGreeks(request).options?: import('@insiderfinance/totalfinance/volatility').SabrBartlettOptions; default: not declared - sabrBartlettGreeks(request).parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared - sabrBartlettGreeks(request).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - skew: (input: import('@insiderfinance/totalfinance/volatility/skew').SkewInput) => import('@insiderfinance/totalfinance/volatility').SkewResult; default: not declared — Compute skew/smile metrics for one expiry of an option chain. - skew().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - skew().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - skew().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - skew().return.value: import('@insiderfinance/totalfinance/volatility').SkewMetrics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - skew(input): import('@insiderfinance/totalfinance/volatility/skew').SkewInput; default: not declared - skew(input).config: import('@insiderfinance/totalfinance/volatility').SkewConfig; default: not declared - skew(input).market: import('@insiderfinance/totalfinance/volatility').SkewMarket; default: not declared - skew(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - smileFromQuotes: (input: import('@insiderfinance/totalfinance/volatility').SmileFromQuotesInput) => import('@insiderfinance/totalfinance/volatility').SmileAnchors; default: not declared — Recover the three smile anchors — the δ-delta put, the ATM, and the δ-delta call `(strike, vol)` — from the `(ATM, riskReversal, butterfly)` quotes. Exact inverse of {@link riskReversalButterfly}: the wing volatilities are `ATM + BF ± RR/2`, and each wing strike is closed form (`K = F·exp(½σ²T − Φ⁻¹(·)σ√T)`) since the vol is now known. See `docs/specs/risk-reversal-butterfly.md`. - smileFromQuotes().return.assumptions: { conventionsVersion: string; deltaConvention: 'forward'; delta: number; }; default: not declared - smileFromQuotes().return.assumptions.conventionsVersion: string; default: not declared - smileFromQuotes().return.assumptions.delta: number; default: not declared - smileFromQuotes().return.assumptions.deltaConvention: 'forward'; default: not declared - smileFromQuotes().return.atmStrike: number; default: not declared - smileFromQuotes().return.atmVolatility: number; default: not declared - smileFromQuotes().return.callStrike: number; default: not declared - smileFromQuotes().return.callVolatility: number; default: not declared - smileFromQuotes().return.delta: number; default: not declared - smileFromQuotes().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - smileFromQuotes().return.putStrike: number; default: not declared - smileFromQuotes().return.putVolatility: number; default: not declared - smileFromQuotes(input): import('@insiderfinance/totalfinance/volatility').SmileFromQuotesInput; default: not declared - smileFromQuotes(input).atmVolatility: number; default: not declared — ATM vol. - smileFromQuotes(input).butterfly: number; default: not declared — Butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - smileFromQuotes(input).delta?: number; default: not declared — Delta level. Default 0.25. - smileFromQuotes(input).forward: number; default: not declared - smileFromQuotes(input).riskReversal: number; default: not declared — Risk reversal (`callVolatility − putVolatility`). - smileFromQuotes(input).timeToExpiryYears: number; default: not declared - stickyRegime: (input: import('@insiderfinance/totalfinance/volatility').StickyRegimeInput) => import('@insiderfinance/totalfinance/volatility').StickyRegime; default: not declared — Measure whether the market's smile is sticky-strike or sticky-moneyness (sticky-delta) from a history of spot and a fixed reference strike's implied vol. See `docs/specs/sticky-regime.md`. - stickyRegime().return.assumptions: { conventionsVersion: string; skewSlope: number | null; }; default: not declared - stickyRegime().return.assumptions.conventionsVersion: string; default: not declared - stickyRegime().return.assumptions.skewSlope: number | null; default: not declared - stickyRegime().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - stickyRegime().return.observations: number; default: not declared - stickyRegime().return.rSquared: number; default: not declared — How much of the fixed-strike vol's change spot returns explain. - stickyRegime().return.regime: 'indeterminate' | 'sticky-strike' | 'sticky-moneyness' | 'intermediate'; default: not declared - stickyRegime().return.stickiness: number | null; default: not declared — Position on the axis: 0 = sticky-strike, 1 = sticky-moneyness (`= −β/skewSlope`); `null` if no reference. - stickyRegime().return.tStatistic: number; default: not declared - stickyRegime().return.volatilitySpotBetaPerLogSpot: number; default: not declared — `∂σ_K/∂lnS` — the empirical vol-spot beta from the regression, **per LOG spot** (vol points per 100% spot move). NOT the same quantity as `VolatilitySpotBeta.volatilitySpotBeta` / `minimumVarianceDelta({ volatilitySpotBeta })`, which are `∂σ/∂S` — per DOLLAR. The two differ by a factor of `S`: feeding this straight into the hedge would scale the smile adjustment by the spot price. Divide by the reference spot first (`estimateVolatilitySpotBeta` does exactly that when its `basis` is `'log'`). - stickyRegime(input): import('@insiderfinance/totalfinance/volatility').StickyRegimeInput; default: not declared - stickyRegime(input).fixedStrikeVolatility: ArrayLike; default: not declared — Per-observation implied vol of a FIXED reference strike (same K across the series). - stickyRegime(input).skewSlope?: number; default: not declared — The smile slope `∂σ/∂ln(K)` — the sticky-moneyness reference. Omit ⇒ only `β`/R² (indeterminate). - stickyRegime(input).spot: ArrayLike; default: not declared — Per-observation underlying spot, aligned to `fixedStrikeVolatility`. - surfaceArbitrageReport: (surface: import('@insiderfinance/totalfinance/volatility').VolatilitySurface, options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Adapt a {@link VolatilitySurface} to {@link arbitrageReport}, carrying its sparse-data warnings through into `diagnostics.warnings`. - surfaceArbitrageReport().return.arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - surfaceArbitrageReport().return.assumptions: { butterflyPoints: number; calendarPoints: number; conventionsVersion: string; step: number; tolerance: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - surfaceArbitrageReport().return.assumptions.butterflyPoints: number; default: not declared - surfaceArbitrageReport().return.assumptions.calendarPoints: number; default: not declared - surfaceArbitrageReport().return.assumptions.conventionsVersion: string; default: not declared - surfaceArbitrageReport().return.assumptions.step: number; default: not declared - surfaceArbitrageReport().return.assumptions.tolerance: number; default: not declared - surfaceArbitrageReport().return.checks: { butterfly: boolean; calendar: boolean; }; default: not declared — Per-check pass/fail summary. - surfaceArbitrageReport().return.checks.butterfly: boolean; default: not declared - surfaceArbitrageReport().return.checks.calendar: boolean; default: not declared - surfaceArbitrageReport().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - surfaceArbitrageReport().return.violations: import('@insiderfinance/totalfinance/volatility').ArbitrageViolation[]; default: not declared - surfaceArbitrageReport(options)?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions; default: not declared - surfaceArbitrageReport(options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - surfaceArbitrageReport(options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - surfaceArbitrageReport(options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - surfaceArbitrageReport(options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - surfaceArbitrageReport(surface): import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - surfaceArbitrageReport(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - surfaceArbitrageReport(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - surfaceArbitrageReport(surface).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - surfaceArbitrageReport(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - surfaceArbitrageReport(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - surfaceArbitrageReport(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - surfaceArbitrageReport(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - surfaceArbitrageReport(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - surfaceArbitrageReport(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - surfaceArbitrageReport(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - surfaceArbitrageReport(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - surfaceArbitrageReport(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - surfaceArbitrageReport(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - surfaceArbitrageReport(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - surfaceArbitrageReport(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - surfaceArbitrageReport(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - surfaceArbitrageReport(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - surfaceArbitrageReport(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - surfaceLocalVolatility: (input: import('@insiderfinance/totalfinance/volatility/local-volatility').SurfaceLocalVolatilityInput) => import('@insiderfinance/totalfinance/volatility').LocalVolatilitySurface; default: not declared — Fit a Dupire local-volatility surface directly from a calibrated {@link VolatilitySurface}. - surfaceLocalVolatility().return.grid: (specification: import('@insiderfinance/totalfinance/options').LocalVolatilityGridSpecification) => import('@insiderfinance/totalfinance/options').LocalVolatilityFunction; default: not declared — A grid-cached local-volatility function over the given (level, time) knots — bilinearly interpolated and far cheaper to evaluate inside a Monte-Carlo simulation than the raw finite-difference transform. - surfaceLocalVolatility().return.localVolatility: (level: number, timeToExpiryYears: number) => number; default: not declared — Dupire local volatility `σ_loc(level, t)` (level = underlying price, t in years). - surfaceLocalVolatility(input): import('@insiderfinance/totalfinance/volatility/local-volatility').SurfaceLocalVolatilityInput; default: not declared - surfaceLocalVolatility(input).market: import('@insiderfinance/totalfinance/options').LocalVolatilityMarket; default: not declared - surfaceLocalVolatility(input).options?: import('@insiderfinance/totalfinance/options').DupireOptions; default: not declared - surfaceLocalVolatility(input).surface: import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - surfacePCA: (input: import('@insiderfinance/totalfinance/volatility').SurfacePcaInput) => import('@insiderfinance/totalfinance/volatility').SurfacePcaResult; default: not declared — Principal-component analysis of vol-surface changes: the dominant modes of surface motion (level / slope / curvature), each with its variance explained and factor-score series. See the spec. - surfacePCA().return.assumptions: { conventionsVersion: string; changeType: 'absolute' | 'relative'; ordered: boolean; }; default: not declared - surfacePCA().return.assumptions.changeType: 'absolute' | 'relative'; default: not declared - surfacePCA().return.assumptions.conventionsVersion: string; default: not declared - surfacePCA().return.assumptions.ordered: boolean; default: not declared - surfacePCA().return.changeType: 'absolute' | 'relative'; default: not declared - surfacePCA().return.cumulativeVarianceExplained: number[]; default: not declared — Cumulative variance explained up to and including each mode. - surfacePCA().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - surfacePCA().return.gridSize: number; default: not declared - surfacePCA().return.modes: import('@insiderfinance/totalfinance/volatility').SurfaceMode[]; default: not declared - surfacePCA().return.observations: number; default: not declared — Number of change vectors (`snapshots.length − 1`). - surfacePCA().return.totalVariance: number; default: not declared - surfacePCA(input): import('@insiderfinance/totalfinance/volatility').SurfacePcaInput; default: not declared - surfacePCA(input).changes?: 'absolute' | 'relative'; default: not declared — How to difference consecutive snapshots; default `'absolute'`. - surfacePCA(input).gridPoints?: number[]; default: not declared — Ordered grid coordinates (moneyness or tenor), one per column — used to label mode shapes. - surfacePCA(input).maxComponents?: number; default: not declared — Retain only the top-k modes; default all (= grid size). - surfacePCA(input).snapshots: number[][]; default: not declared — IV snapshots over time; `snapshots[t]` is the vol vector at a FIXED set of grid points. - surfacePcaScenarios: (input: import('@insiderfinance/totalfinance/volatility').SurfacePcaScenarioInput) => import('@insiderfinance/totalfinance/volatility').SurfacePcaScenarios; default: not declared — Turn a fitted {@link surfacePCA} into **stress scenarios**: shock a base surface by `±k` standard deviations along each principal mode (`k·√λ·loadings`, since `√λ` is the mode's 1-sigma move and the loadings are unit-norm), and optionally by a combined per-mode move. Shocked volatilities are floored (default 0) so a large downside shock can't go negative. The shock is applied in the units the PCA was FITTED in (`pca.changeType`): `absolute` adds the vector to the base vols, `relative` scales them (`base·(1 + shock)`), because a relative PCA's modes are proportional moves. See `docs/specs/surface-pca-scenarios.md`. - surfacePcaScenarios().return.assumptions: { conventionsVersion: string; changeType: 'absolute' | 'relative'; floor: number; }; default: not declared - surfacePcaScenarios().return.assumptions.changeType: 'absolute' | 'relative'; default: not declared - surfacePcaScenarios().return.assumptions.conventionsVersion: string; default: not declared - surfacePcaScenarios().return.assumptions.floor: number; default: not declared - surfacePcaScenarios().return.base: number[]; default: not declared - surfacePcaScenarios().return.combinedSurface?: number[]; default: not declared — `base + Σ sᵢ·√λᵢ·loadingsᵢ`, floored — present only when `combined` is supplied. - surfacePcaScenarios().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - surfacePcaScenarios().return.scenarios: import('@insiderfinance/totalfinance/volatility').SurfaceScenario[]; default: not declared — One per `(mode, sigma)`, in mode-major order. - surfacePcaScenarios(input): import('@insiderfinance/totalfinance/volatility').SurfacePcaScenarioInput; default: not declared - surfacePcaScenarios(input).base: number[]; default: not declared — Current volatilities to shock, at the SAME grid points as the PCA (length = `pca.gridSize`). - surfacePcaScenarios(input).combined?: number[]; default: not declared — Optional per-mode sigma moves → one combined shocked surface. - surfacePcaScenarios(input).floor?: number; default: not declared — Floor for the shocked volatilities (a vol can't go negative). Default 0. - surfacePcaScenarios(input).maxModes?: number; default: not declared — Shock only the top-N modes. Default all of `pca.modes`. - surfacePcaScenarios(input).pca: import('@insiderfinance/totalfinance/volatility').SurfacePcaResult; default: not declared — The result of {@link surfacePCA} — its modes drive the shocks. - surfacePcaScenarios(input).sigmas?: number[]; default: not declared — Shock magnitudes in standard deviations, applied to each mode. Default `[-1, 1]`. - swaptionCube: (input: import('@insiderfinance/totalfinance/volatility').SwaptionCubeInput) => import('@insiderfinance/totalfinance/volatility').SwaptionCube; default: not declared - swaptionCube().return.assumptions: { conventionsVersion: string; volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; backbone: 'sabr'; shift: number; }; default: not declared - swaptionCube().return.assumptions.backbone: 'sabr'; default: not declared - swaptionCube().return.assumptions.conventionsVersion: string; default: not declared - swaptionCube().return.assumptions.shift: number; default: not declared - swaptionCube().return.assumptions.volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - swaptionCube().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - swaptionCube().return.expiries: number[]; default: not declared — Unique expiries, ascending. - swaptionCube().return.nodes: import('@insiderfinance/totalfinance/volatility').CalibratedSwaptionNode[]; default: not declared — Calibrated nodes, sorted by `(expiry, tenor)`. - swaptionCube().return.shift?: number; default: not declared — The rate displacement applied inside SABR (`0` for plain SABR). Nodes' `forward` fields stay the real (unshifted) rates; the shift lives only in the SABR calibration/evaluation. {@link swaptionCubeVolatility} reads this off the cube. OPTIONAL because legacy (pre-shift) serialized cubes carry no field — evaluation reads an absent shift as `0`; the declaration used to say required while the runtime documented that default, and the 3B.1b spec convicted the mismatch (the TA lesson: when the runtime is right, the DECLARATION is what lies). - swaptionCube().return.tenors: number[]; default: not declared — Unique tenors, ascending. - swaptionCube().return.volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - swaptionCube(input): import('@insiderfinance/totalfinance/volatility').SwaptionCubeInput; default: not declared - swaptionCube(input).beta?: number; default: not declared — Default backbone β for every node's calibration (0.5, the rates convention). - swaptionCube(input).maximumIterations?: number; default: not declared — `calibrateSabrSmile` iteration cap (pass-through). - swaptionCube(input).nodes: import('@insiderfinance/totalfinance/volatility').SwaptionCubeNode[]; default: not declared - swaptionCube(input).shift?: number; default: not declared — Rate displacement `s ≥ 0` for **shifted (displaced) SABR** — SABR is lognormal and needs `forward, strike > 0`, so a negative-rate cube must be calibrated on `forward + s` / `strike + s`. Default `0` (plain SABR). With `s > 0` the `'lognormal'` volatilities are *shifted*-lognormal — price with Black on the shifted rates, `annuity · Black(forward + s, strike + s, vol, expiry)`; `'normal'` (Bachelier) volatilities are unchanged (a common shift cancels in `forward − strike`). See `docs/specs/swaption-cube-shift.md`. - swaptionCube(input).tolerance?: number; default: not declared — `calibrateSabrSmile` tolerance (pass-through). - swaptionCube(input).volatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — Volatility quote convention: `'lognormal'` (Black, default) or `'normal'` (Bachelier). - swaptionCubeVolatility: (query: import('@insiderfinance/totalfinance/volatility').SwaptionCubeVolatilityQuery) => import('@insiderfinance/totalfinance/volatility').SwaptionCubeVolatilityResult; default: not declared — Evaluate the swaption cube's implied vol at an arbitrary `(expiry, tenor, strike)` by bilinearly interpolating the forward and SABR parameters across the grid, then evaluating the SABR smile. See `docs/specs/swaption-cube.md`. - swaptionCubeVolatility().return.assumptions: { conventionsVersion: string; volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; interpolation: 'bilinear-parameters'; shift: number; }; default: not declared - swaptionCubeVolatility().return.assumptions.conventionsVersion: string; default: not declared - swaptionCubeVolatility().return.assumptions.interpolation: 'bilinear-parameters'; default: not declared - swaptionCubeVolatility().return.assumptions.shift: number; default: not declared — The cube's rate shift, echoed so the caller prices with the matching (shifted) convention. - swaptionCubeVolatility().return.assumptions.volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - swaptionCubeVolatility().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - swaptionCubeVolatility().return.extrapolated: boolean; default: not declared — Whether the query fell outside the `(expiry, tenor)` grid (clamped to the edge). - swaptionCubeVolatility().return.forward: number; default: not declared — Interpolated forward swap rate. - swaptionCubeVolatility().return.parameters: import('@insiderfinance/totalfinance/options').SabrParameters; default: not declared — The interpolated SABR parameters used. - swaptionCubeVolatility().return.value: number; default: not declared — Interpolated implied vol. - swaptionCubeVolatility(query): import('@insiderfinance/totalfinance/volatility').SwaptionCubeVolatilityQuery; default: not declared - swaptionCubeVolatility(query).cube: import('@insiderfinance/totalfinance/volatility').SwaptionCube; default: not declared - swaptionCubeVolatility(query).expiryYears: number; default: not declared — Option expiry in years. - swaptionCubeVolatility(query).strike: number; default: not declared — Absolute strike rate. - swaptionCubeVolatility(query).tenorYears: number; default: not declared — Underlying swap tenor in years. - tailRiskIndex: (options: import('@insiderfinance/totalfinance/volatility').TailRiskOptions) => import('@insiderfinance/totalfinance/volatility').TailRiskResult; default: not declared — The SKEW-style tail-risk index from an option chain: per-expiry risk-neutral skewness / excess kurtosis (BKM), plus the constant-maturity SKEW value. See `docs/specs/tail-risk-index.md`. - tailRiskIndex().return.assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; default: not declared - tailRiskIndex().return.assumptions.conventionsVersion: string; default: not declared - tailRiskIndex().return.assumptions.horizonDays: number; default: not declared - tailRiskIndex().return.assumptions.measure: 'risk-neutral'; default: not declared - tailRiskIndex().return.assumptions.method: string; default: not declared - tailRiskIndex().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - tailRiskIndex().return.excessKurtosis: number; default: not declared — Constant-maturity risk-neutral excess kurtosis. - tailRiskIndex().return.horizonDays: number; default: not declared - tailRiskIndex().return.interpolatedBetween?: { near: string; far: string; }; default: not declared — The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). - tailRiskIndex().return.interpolatedBetween.far: string; default: not declared - tailRiskIndex().return.interpolatedBetween.near: string; default: not declared - tailRiskIndex().return.skewIndex: number; default: not declared — Constant-maturity SKEW value (> 100 ⇒ elevated crash risk), interpolated to `horizonDays`. - tailRiskIndex().return.skewness: number; default: not declared — Constant-maturity risk-neutral skewness. - tailRiskIndex().return.termStructure: import('@insiderfinance/totalfinance/volatility').ExpiryTailRisk[]; default: not declared — Per-expiry moments — the whole tail-risk term structure, ascending by DTE. - tailRiskIndex(options): import('@insiderfinance/totalfinance/volatility').TailRiskOptions; default: not declared - tailRiskIndex(options).asOf: string | number; default: not declared - tailRiskIndex(options).horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (CBOE SKEW). - tailRiskIndex(options).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared - tailRiskIndex(options).riskFreeRate: number; default: not declared - tailRiskIndex(options).spot: number; default: not declared - varianceIndex: (options: import('@insiderfinance/totalfinance/volatility').VarianceIndexOptions) => import('@insiderfinance/totalfinance/volatility').VarianceIndexResult; default: not declared — The VIX-style constant-maturity, model-free implied vol from an option chain, with the per-expiry fair-variance term structure. See `docs/specs/variance-index.md`. - varianceIndex().return.assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; default: not declared - varianceIndex().return.assumptions.conventionsVersion: string; default: not declared - varianceIndex().return.assumptions.horizonDays: number; default: not declared - varianceIndex().return.assumptions.measure: 'risk-neutral'; default: not declared - varianceIndex().return.assumptions.method: string; default: not declared - varianceIndex().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - varianceIndex().return.fairVolatility: number; default: not declared — Constant-maturity fair vol as a decimal (`index / 100`). - varianceIndex().return.horizonDays: number; default: not declared - varianceIndex().return.index: number; default: not declared — Constant-maturity model-free vol in VIX-style points (e.g. 20.0 = 20% annualized). - varianceIndex().return.interpolatedBetween?: { near: string; far: string; }; default: not declared — The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). - varianceIndex().return.interpolatedBetween.far: string; default: not declared - varianceIndex().return.interpolatedBetween.near: string; default: not declared - varianceIndex().return.termStructure: import('@insiderfinance/totalfinance/volatility').ExpiryVariance[]; default: not declared — Per-expiry fair variance/vol — the whole term structure, ascending by DTE. - varianceIndex().return.variance: number; default: not declared — Constant-maturity annualized fair variance (decimal). - varianceIndex(options): import('@insiderfinance/totalfinance/volatility').VarianceIndexOptions; default: not declared - varianceIndex(options).asOf: string | number; default: not declared - varianceIndex(options).dividendYield?: number; default: not declared — Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). - varianceIndex(options).horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (VIX). - varianceIndex(options).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared — Option chain across ≥ 1 expiries — call + put quotes with a usable mid. - varianceIndex(options).riskFreeRate: number; default: not declared - varianceIndex(options).spot: number; default: not declared - varianceRiskPremium: (input: import('@insiderfinance/totalfinance/volatility/event').RealizedImpliedInput) => number; default: not declared — Variance risk premium: `impliedVolatility² − realizedVolatility²`, the premium of option-implied ANNUALIZED variance over subsequently-realized annualized variance (the compensation for bearing variance risk; both inputs are annualized volatilities, so the result is in annualized-variance units). Positive on average. - varianceRiskPremium(input): import('@insiderfinance/totalfinance/volatility/event').RealizedImpliedInput; default: not declared - varianceRiskPremium(input).impliedVolatility: number; default: not declared — Annualized implied volatility (decimal). - varianceRiskPremium(input).realizedVolatility: number; default: not declared — Annualized realized volatility (decimal) — e.g. `historicalVolatility(closes, { period, annualization: 252 })`. - varianceRiskPremiumTermStructure: (options: import('@insiderfinance/totalfinance/volatility').VarianceRiskPremiumTermStructureOptions) => import('@insiderfinance/totalfinance/volatility').VarianceRiskPremiumTermStructureResult; default: not declared — The variance-risk-premium term structure — per-expiry implied variance (from {@link varianceIndex}) minus realized variance — plus the VRP at the constant-maturity index. See the spec. - varianceRiskPremiumTermStructure().return.assumptions: { conventionsVersion: string; measure: 'risk-neutral'; method: string; }; default: not declared - varianceRiskPremiumTermStructure().return.assumptions.conventionsVersion: string; default: not declared - varianceRiskPremiumTermStructure().return.assumptions.measure: 'risk-neutral'; default: not declared - varianceRiskPremiumTermStructure().return.assumptions.method: string; default: not declared - varianceRiskPremiumTermStructure().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - varianceRiskPremiumTermStructure().return.indexVarianceRiskPremium: number; default: not declared — VRP at the constant-maturity index vs the reference realized vol. - varianceRiskPremiumTermStructure().return.points: import('@insiderfinance/totalfinance/volatility').VarianceRiskPremiumPoint[]; default: not declared - varianceRiskPremiumTermStructure(options): import('@insiderfinance/totalfinance/volatility').VarianceRiskPremiumTermStructureOptions; default: not declared - varianceRiskPremiumTermStructure(options).asOf: string | number; default: not declared - varianceRiskPremiumTermStructure(options).dividendYield?: number; default: not declared — Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). - varianceRiskPremiumTermStructure(options).horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (VIX). - varianceRiskPremiumTermStructure(options).quotes: readonly import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared — Option chain across ≥ 1 expiries — call + put quotes with a usable mid. - varianceRiskPremiumTermStructure(options).realizedVolatility: number | Record; default: not declared — Realized vol to compare (decimal): one number for the whole curve, or per-expiry by ISO date. - varianceRiskPremiumTermStructure(options).riskFreeRate: number; default: not declared - varianceRiskPremiumTermStructure(options).spot: number; default: not declared - varianceSwapRate: (options: { strikes: number[]; otmPrices: number[]; forward: number; riskFreeRate: number; timeToExpiryYears: number; boundaryCallPrice?: number; boundaryPriceAveraged?: boolean; }) => import('@insiderfinance/totalfinance/core').Computed; default: not declared — Model-free implied volatility via the CBOE VIX replication (Demeterfi–Derman–Kamal–Zou): a strip of out-of-the-money option mid-prices integrates to the fair variance `σ² = (2/T)·Σ (ΔKᵢ/Kᵢ²)·e^{rT}·Q(Kᵢ) − (1/T)·(F/K₀ − 1)²`, where `K₀` is the highest strike below the forward `F`. `otmPrices[i]` is the OTM option (put below `F`, call above) mid at `strikes[i]`. **At `K₀` the CBOE strip is the AVERAGE of the put and the call**, and the `−(1/T)(F/K₀ − 1)²` correction subtracted here is derived for exactly that convention. Supply the `K₀` call as `boundaryCallPrice` and pass the `K₀` PUT in `otmPrices` — the two are averaged for you. With a put-only `K₀` price and no `boundaryCallPrice` the strip under-states variance by `ΔK₀·(F − K₀)/(T·K₀²)` (by put–call parity the missing half-difference is `(C−P)/2 = e^{−rT}(F−K₀)/2`), which on a typical 1-month index chain is ~1.7 vol points — so the disclosure rides the result. - varianceSwapRate().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'risk-neutral'; method: 'ddkz-replication'; }>; default: not declared — Every applied convention, echoed back. - varianceSwapRate().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - varianceSwapRate().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - varianceSwapRate().return.value: import('@insiderfinance/totalfinance/volatility').VarianceSwapResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - varianceSwapRate(options): { strikes: number[]; otmPrices: number[]; forward: number; riskFreeRate: number; timeToExpiryYears: number; boundaryCallPrice?: number; boundaryPriceAveraged?: boolean; }; default: not declared - varianceSwapRate(options).boundaryCallPrice?: number; default: not declared — The CALL price at `K₀` (the highest strike ≤ `F`), with the `K₀` PUT passed in `otmPrices`. Supplied ⇒ the `K₀` term becomes the CBOE put/call average; omitted ⇒ `otmPrices` is used as given and the put-only bias is disclosed in `diagnostics`. - varianceSwapRate(options).boundaryPriceAveraged?: boolean; default: not declared — Set when `otmPrices` at `K₀` is ALREADY the CBOE put/call average (a chain extractor that averaged there). Suppresses the put-only bias disclosure without touching the arithmetic. Cannot be combined with `boundaryCallPrice` — that would average an average. - varianceSwapRate(options).forward: number; default: not declared - varianceSwapRate(options).otmPrices: number[]; default: not declared - varianceSwapRate(options).riskFreeRate: number; default: not declared - varianceSwapRate(options).strikes: number[]; default: not declared - varianceSwapRate(options).timeToExpiryYears: number; default: not declared - volatilityCone: import('@insiderfinance/totalfinance/volatility').VolatilityConeFacade; default: not declared — Realized-volatility cone: for each lookback `window`, the percentile spread of annualized realized volatility across all rolling windows of the return series, plus the current reading. The classic "is implied vol rich or cheap vs the underlying's own realized history" view. Facade (H27): the plain call returns the rows array; `.explain()` discloses the applied `periodsPerYear`, windows, and annualization convention in `assumptions`, and the observation count / annualization factor in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the closed-request teaching errors for the options bag stay byte-identical. - volatilityCone(options): { windows: number[]; periodsPerYear?: number; }; default: not declared - volatilityCone(options).periodsPerYear?: number; default: not declared - volatilityCone(options).windows: number[]; default: not declared - volatilityCone(returns): ArrayLike; default: not declared - volatilityCone.explain: (returns: ArrayLike, options: { windows: number[]; periodsPerYear?: number; }) => Omit, 'assumptions'> & { assumptions: import('@insiderfinance/totalfinance/volatility').VolatilityConeAssumptions; }; default: not declared - volatilityCone.explain().return.assumptions: import('@insiderfinance/totalfinance/volatility').VolatilityConeAssumptions; default: not declared - volatilityCone.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - volatilityCone.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - volatilityCone.explain().return.value: import('@insiderfinance/totalfinance/volatility').VolatilityConeWindow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - volatilityCone.explain(options): { windows: number[]; periodsPerYear?: number; }; default: not declared - volatilityCone.explain(options).periodsPerYear?: number; default: not declared - volatilityCone.explain(options).windows: number[]; default: not declared - volatilityCone.explain(returns): ArrayLike; default: not declared - volatilitySurface: (input: import('@insiderfinance/totalfinance/volatility/surface').VolatilitySurfaceInput) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared - volatilitySurface().return.arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - volatilitySurface().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - volatilitySurface().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - volatilitySurface().return.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - volatilitySurface().return.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - volatilitySurface().return.heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - volatilitySurface().return.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - volatilitySurface().return.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - volatilitySurface().return.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - volatilitySurface().return.lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - volatilitySurface().return.model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - volatilitySurface().return.points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - volatilitySurface().return.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => import('@insiderfinance/totalfinance/volatility').VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - volatilitySurface().return.slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - volatilitySurface().return.slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - volatilitySurface().return.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - volatilitySurface().return.toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - volatilitySurface().return.toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - volatilitySurface(input): import('@insiderfinance/totalfinance/volatility/surface').VolatilitySurfaceInput; default: not declared - volatilitySurface(input).config?: import('@insiderfinance/totalfinance/volatility').SurfaceConfig; default: not declared - volatilitySurface(input).market: import('@insiderfinance/totalfinance/volatility').SurfaceMarket; default: not declared - volatilitySurface(input).quotes: import('@insiderfinance/totalfinance/core').OptionQuote[]; default: not declared ## Entrypoint @insiderfinance/totalfinance/backtest ### @insiderfinance/totalfinance/backtest#AgentBenchReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Operational conformance and strategy quality, reported separately — no single score by design. ```typescript /** Operational conformance and strategy quality, reported separately — no single score by design. */ export interface AgentBenchReport { policy: string; episodes: AgentBenchEpisodeReport[]; /** One recorded episode per run, in the order of `episodes`. */ traces: AgentBenchTrace[]; operational: { passes: boolean; failing: string[]; lookAhead: number; duplicateOrders: number; maskViolations: number; limitBreaches: number; externalOrderAttempts: 0; }; strategy: { meanTotalReturn: number | null; meanSharpe: number | null; meanMaxDrawdown: number | null; meanTurnover: number | null; meanCost: number | null; meanGrossExposure: number | null; violations: number; }; assumptions: { episodes: string[]; seeds: number[]; runs: number; dimensions: string; leakageProbe: string; retrySuite: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { dimensions: string; episodes: string[]; leakageProbe: string; retrySuite: string; runs: number; seeds: number[]; }; default: not declared - assumptions.dimensions: string; default: not declared - assumptions.episodes: string[]; default: not declared - assumptions.leakageProbe: string; default: not declared - assumptions.retrySuite: string; default: not declared - assumptions.runs: number; default: not declared - assumptions.seeds: number[]; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - episodes: AgentBenchEpisodeReport[]; default: not declared - operational: { duplicateOrders: number; externalOrderAttempts: 0; failing: string[]; limitBreaches: number; lookAhead: number; maskViolations: number; passes: boolean; }; default: not declared - operational.duplicateOrders: number; default: not declared - operational.externalOrderAttempts: 0; default: not declared - operational.failing: string[]; default: not declared - operational.limitBreaches: number; default: not declared - operational.lookAhead: number; default: not declared - operational.maskViolations: number; default: not declared - operational.passes: boolean; default: not declared - policy: string; default: not declared - strategy: { meanCost: number | null; meanGrossExposure: number | null; meanMaxDrawdown: number | null; meanSharpe: number | null; meanTotalReturn: number | null; meanTurnover: number | null; violations: number; }; default: not declared - strategy.meanCost: number | null; default: not declared - strategy.meanGrossExposure: number | null; default: not declared - strategy.meanMaxDrawdown: number | null; default: not declared - strategy.meanSharpe: number | null; default: not declared - strategy.meanTotalReturn: number | null; default: not declared - strategy.meanTurnover: number | null; default: not declared - strategy.violations: number; default: not declared - traces: AgentBenchTrace[]; default: not declared — One recorded episode per run, in the order of `episodes`. ### @insiderfinance/totalfinance/backtest#AgentTranscriptScore Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AgentTranscriptScore { operationSelection: number; firstAttemptValidity: number | null; recovery: number | null; argumentValidity: number | null; parity: boolean | null; refusal: boolean | null; traceability: number | null; calls: number; bytes: number; withinBudget: boolean | null; passes: boolean; assumptions: { deterministic: true; scoring: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - argumentValidity: number | null; default: not declared - assumptions: { deterministic: true; scoring: string; }; default: not declared - assumptions.deterministic: true; default: not declared - assumptions.scoring: string; default: not declared - bytes: number; default: not declared - calls: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - firstAttemptValidity: number | null; default: not declared - operationSelection: number; default: not declared - parity: boolean | null; default: not declared - passes: boolean; default: not declared - recovery: number | null; default: not declared - refusal: boolean | null; default: not declared - traceability: number | null; default: not declared - withinBudget: boolean | null; default: not declared ### @insiderfinance/totalfinance/backtest#AttributionReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link attribution} as a report: per-symbol rows carrying `assumptions` + `diagnostics` inline. ```typescript /** {@link attribution} as a report: per-symbol rows carrying `assumptions` + `diagnostics` inline. */ export interface AttributionReport { /** Realized P&L per symbol (average-cost matched), in first-trade order. */ bySymbol: SymbolAttribution[]; assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - bySymbol: SymbolAttribution[]; default: not declared — Realized P&L per symbol (average-cost matched), in first-trade order. - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/backtest#AttributionRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AttributionRow { rebalanceIndex: number; sessionDate: string; /** Pearson IC of the signal against the next-period return; null when unmeasurable. */ informationCoefficient: number | null; rankInformationCoefficient: number | null; /** Long-leg minus short-leg mean next-period return of the signal's quantiles. */ spreadReturn: number | null; /** Fraction of this rebalance's selection not present in the previous one. */ selectionTurnover: number | null; breadth: number; coverage: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - breadth: number; default: not declared - coverage: number; default: not declared - informationCoefficient: number | null; default: not declared — Pearson IC of the signal against the next-period return; null when unmeasurable. - rankInformationCoefficient: number | null; default: not declared - rebalanceIndex: number; default: not declared - selectionTurnover: number | null; default: not declared — Fraction of this rebalance's selection not present in the previous one. - sessionDate: string; default: not declared - spreadReturn: number | null; default: not declared — Long-leg minus short-leg mean next-period return of the signal's quantiles. ### @insiderfinance/totalfinance/backtest#BENCHMARK_FIXTURE_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Version tag of the golden benchmark fixtures the engines are validated against (spec §16.3). ```typescript export declare const BENCHMARK_FIXTURE_VERSION: '0.0.1'; ``` ### @insiderfinance/totalfinance/backtest#BacktestAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The modelling assumptions a backtest makes, echoed on every result's `assumptions` slot so they are never hidden (spec §16.3 / dx §2.5). Each policy is a short, stable, machine-readable label. ```typescript /** * The modelling assumptions a backtest makes, echoed on every result's `assumptions` slot so they are * never hidden (spec §16.3 / dx §2.5). Each policy is a short, stable, machine-readable label. */ export interface BacktestAssumptions { /** Version of the library's default conventions (core `CONVENTIONS_VERSION`). */ conventionsVersion: string; /** Opening capital the run started from. */ initialCapital: number; /** When/at what price orders fill, e.g. `next-open`, `close`, `trigger-price`. */ fill: string; /** Commission model applied, e.g. `bps(1)`, `per-share(0.005)`, `none`. */ cost: string; /** Slippage model applied, e.g. `bps(2)`, `spread`, `none`. */ slippage: string; /** Cash settlement assumption, e.g. `immediate` (T+0). */ cashSettlement: string; /** Corporate-action handling, e.g. `dividends-as-cash`, `splits-adjusted`, `none`. */ corporateAction: string; /** Rebalancing/trading calendar, e.g. `every-bar`, `monthly`, `signal-driven`. */ calendar: string; /** Leverage/margin regime: `unconstrained` (no cap; unfunded fills allowed) or `maxLeverage`. */ margin: string; /** American early exercise/assignment policy: `model` or `none` (WS7.4). Absent where inapplicable. */ assignment?: string; /** * How an OCO group resolves a bar that touches BOTH legs. One bar cannot say which trigger came * first, and the engine's answer — the take-profit, because a bracket submits it before the * stop-loss and orders fill in submission order — is optimistic. It is disclosed here rather than * left as an undocumented mechanic (`take-profit-first-on-ambiguous-bar`). Absent for engines with * no order book (the vectorized loop). */ oco?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assignment?: string; default: not declared — American early exercise/assignment policy: `model` or `none` (WS7.4). Absent where inapplicable. - calendar: string; default: not declared — Rebalancing/trading calendar, e.g. `every-bar`, `monthly`, `signal-driven`. - cashSettlement: string; default: not declared — Cash settlement assumption, e.g. `immediate` (T+0). - conventionsVersion: string; default: not declared — Version of the library's default conventions (core `CONVENTIONS_VERSION`). - corporateAction: string; default: not declared — Corporate-action handling, e.g. `dividends-as-cash`, `splits-adjusted`, `none`. - cost: string; default: not declared — Commission model applied, e.g. `bps(1)`, `per-share(0.005)`, `none`. - fill: string; default: not declared — When/at what price orders fill, e.g. `next-open`, `close`, `trigger-price`. - initialCapital: number; default: not declared — Opening capital the run started from. - margin: string; default: not declared — Leverage/margin regime: `unconstrained` (no cap; unfunded fills allowed) or `maxLeverage`. - oco?: string; default: not declared — How an OCO group resolves a bar that touches BOTH legs. One bar cannot say which trigger came first, and the engine's answer — the take-profit, because a bracket submits it before the stop-loss and orders fill in submission order — is optimistic. It is disclosed here rather than left as an undocumented mechanic (`take-profit-first-on-ambiguous-bar`). Absent for engines with no order book (the vectorized loop). - slippage: string; default: not declared — Slippage model applied, e.g. `bps(2)`, `spread`, `none`. ### @insiderfinance/totalfinance/backtest#BacktestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The common result shape returned by both engines. ```typescript /** The common result shape returned by both engines. */ export interface BacktestResult { /** * The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` * is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. */ points: EquityPoint[]; /** Per-bar simple returns of the equity curve. */ returns: number[]; /** Every filled trade, in order. */ trades: Trade[]; /** Final portfolio value. */ finalValue: number; /** Sum of |traded notional| ÷ average equity — a turnover proxy. */ turnover: number; /** Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). */ performance: PerformanceSummary; /** The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). */ assumptions: BacktestAssumptions; /** Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). */ diagnostics: ImplementationRisk; /** Option positions settled at expiry (exercise / assignment / worthless), if any. */ settlements?: OptionSettlement[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - assumptions.assignment?: string; default: not declared — American early exercise/assignment policy: `model` or `none` (WS7.4). Absent where inapplicable. - assumptions.calendar: string; default: not declared — Rebalancing/trading calendar, e.g. `every-bar`, `monthly`, `signal-driven`. - assumptions.cashSettlement: string; default: not declared — Cash settlement assumption, e.g. `immediate` (T+0). - assumptions.conventionsVersion: string; default: not declared — Version of the library's default conventions (core `CONVENTIONS_VERSION`). - assumptions.corporateAction: string; default: not declared — Corporate-action handling, e.g. `dividends-as-cash`, `splits-adjusted`, `none`. - assumptions.cost: string; default: not declared — Commission model applied, e.g. `bps(1)`, `per-share(0.005)`, `none`. - assumptions.fill: string; default: not declared — When/at what price orders fill, e.g. `next-open`, `close`, `trigger-price`. - assumptions.initialCapital: number; default: not declared — Opening capital the run started from. - assumptions.margin: string; default: not declared — Leverage/margin regime: `unconstrained` (no cap; unfunded fills allowed) or `maxLeverage`. - assumptions.oco?: string; default: not declared — How an OCO group resolves a bar that touches BOTH legs. One bar cannot say which trigger came first, and the engine's answer — the take-profit, because a bracket submits it before the stop-loss and orders fill in submission order — is optimistic. It is disclosed here rather than left as an undocumented mechanic (`take-profit-first-on-ambiguous-bar`). Absent for engines with no order book (the vectorized loop). - assumptions.slippage: string; default: not declared — Slippage model applied, e.g. `bps(2)`, `spread`, `none`. - diagnostics: ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.benchmarkFixtureVersion: string; default: not declared — The benchmark fixture version this engine was validated against. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - finalValue: number; default: not declared — Final portfolio value. - performance: PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - points: EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - settlements?: OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - trades: Trade[]; default: not declared — Every filled trade, in order. - turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. ### @insiderfinance/totalfinance/backtest#Bar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Bar { symbol: SymbolId; timestampMs: EpochMs; open: number; high: number; low: number; close: number; volume?: number; vwap?: number; adjusted?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjusted?: boolean; default: not declared - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared - volume?: number; default: not declared - vwap?: number; default: not declared ### @insiderfinance/totalfinance/backtest#BarField Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Field of a bar to feed an indicator, or a custom extractor. ```typescript /** Field of a bar to feed an indicator, or a custom extractor. */ export type BarField = 'open' | 'high' | 'low' | 'close' | 'volume'; ``` ### @insiderfinance/totalfinance/backtest#BenchmarkComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BenchmarkComparison { instrumentId: string; /** The benchmark's per-session simple returns aligned to the run's sessions. */ returns: number[]; activeReturn: number | null; trackingError: number | null; informationRatio: number | null; beta: number | null; alpha: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - activeReturn: number | null; default: not declared - alpha: number | null; default: not declared - beta: number | null; default: not declared - informationRatio: number | null; default: not declared - instrumentId: string; default: not declared - returns: number[]; default: not declared — The benchmark's per-session simple returns aligned to the run's sessions. - trackingError: number | null; default: not declared ### @insiderfinance/totalfinance/backtest#BorrowModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A borrow-fee model for short positions: an annualized financing rate on the short market value. ```typescript /** A borrow-fee model for short positions: an annualized financing rate on the short market value. */ export interface BorrowModel { readonly label: string; /** Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). */ readonly annualRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - label: string; default: not declared ### @insiderfinance/totalfinance/backtest#BrokerConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BrokerConfig { /** Opening cash. */ cash: number; commission?: CostModel; slippage?: SlippageModel; borrow?: BorrowModel; /** Bars per year, for borrow accrual (default 252). */ periodsPerYear?: number; /** Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). */ maxLeverage?: number; /** Disallow short positions (default `false`). */ noShort?: boolean; /** Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. */ maxVolumeParticipation?: number; /** * American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at * expiry — every European-style golden is byte-identical. `'model'` options in to modeling early * assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds * (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. */ assignment?: 'model' | 'none'; /** * Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is * assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic * (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. */ assignmentThreshold?: number; /** * Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put * early-assignment carry economics — early put exercise is driven by the interest earned on the * strike over the option's remaining life. With rate `0` there is no carry incentive, so a short * put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. */ riskFreeRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - borrow?: BorrowModel; default: not declared - borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - borrow.label: string; default: not declared - cash: number; default: not declared — Opening cash. - commission?: CostModel; default: not declared - commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - commission.commission(input).price: number; default: not declared - commission.commission(input).quantity: number; default: not declared - commission.label: string; default: not declared - maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - noShort?: boolean; default: not declared — Disallow short positions (default `false`). - periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - slippage?: SlippageModel; default: not declared - slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - slippage.fill(input).quantity: number; default: not declared - slippage.fill(input).referencePrice: number; default: not declared - slippage.fill(input).side: OrderSide; default: not declared - slippage.label: string; default: not declared ### @insiderfinance/totalfinance/backtest#CorporateAction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A corporate action effective on a bar. ```typescript /** A corporate action effective on a bar. */ export interface CorporateAction { /** Cash dividend per share (long receives, short pays). */ dividend?: number; /** Split ratio `R` (`2` = 2-for-1: quantities ×R, prices ÷R). */ split?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividend?: number; default: not declared — Cash dividend per share (long receives, short pays). - split?: number; default: not declared — Split ratio `R` (`2` = 2-for-1: quantities ×R, prices ÷R). ### @insiderfinance/totalfinance/backtest#CostModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CostModel { readonly label: string; commission(input: CommissionInput): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: (input: CommissionInput) => number; default: not declared - commission(input): CommissionInput; default: not declared - commission(input).price: number; default: not declared - commission(input).quantity: number; default: not declared - label: string; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalAssumptions { conventionsVersion: string; universeId: string; signal: { kind: 'factor-recipe'; recipeName: string; recipeVersion: number; direction: string; lagTradingSessions: number; neutralization: string; } | { kind: 'score'; components: number; missingValuePolicy: string; } | { kind: 'screen'; orderBy: string[]; missingValuePolicy: string; } | { kind: 'callback'; replayable: false; }; rebalanceSchedule: { frequency: RebalanceFrequency; session: 'open' | 'close'; bufferBand: number | null; }; sessionInstantConvention: string; pricing: string; portfolioConstruction: { method: WeightingMethod; long: SideSelection; short: ShortSideSelection | null; neutrality: Neutrality; maximumPositions: number | null; maximumPositionWeight: number | null; minimumPositionWeight: number | null; maximumTurnover: number | null; maximumParticipation: number | null; volatilityLookbackSessions: number; shortBookSizing: string; }; execution: ExecutionPolicyDescription; costs: { commission: string; slippage: string; }; initialCapital: number; baseCurrency: string; periodsPerYear: number; riskFreeRate: number; seed: number | null; window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; ledger: { sourceId: string; accountId: string; lotRelief: string; }; replayable: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - conventionsVersion: string; default: not declared - costs: { commission: string; slippage: string; }; default: not declared - costs.commission: string; default: not declared - costs.slippage: string; default: not declared - execution: ExecutionPolicyDescription; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - execution.costs.borrow: string | null; default: not declared - execution.costs.commission: string; default: not declared - execution.costs.latencySessions: number | null; default: not declared - execution.costs.marketImpact: string | null; default: not declared - execution.costs.participation: number | null; default: not declared - execution.costs.slippage: string; default: not declared - execution.costs.spread: string | null; default: not declared - execution.fill: { label: string; version: string; }; default: not declared - execution.fill.label: string; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared - execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - execution.sessions.halts: number; default: not declared - execution.sessions.priceLimits: number; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - initialCapital: number; default: not declared - ledger: { sourceId: string; accountId: string; lotRelief: string; }; default: not declared - ledger.accountId: string; default: not declared - ledger.lotRelief: string; default: not declared - ledger.sourceId: string; default: not declared - periodsPerYear: number; default: not declared - portfolioConstruction: { method: WeightingMethod; long: SideSelection; short: ShortSideSelection | null; neutrality: Neutrality; maximumPositions: number | null; maximumPositionWeight: number | null; minimumPositionWeight: number | null; maximumTurnover: number | null; maximumParticipation: number | null; volatilityLookbackSessions: number; shortBookSizing: string; }; default: not declared - portfolioConstruction.long: SideSelection; default: not declared - portfolioConstruction.long.count: number; default: not declared - portfolioConstruction.long.fraction: number; default: not declared - portfolioConstruction.long.topQuantile: number; default: not declared - portfolioConstruction.maximumParticipation: number | null; default: not declared - portfolioConstruction.maximumPositionWeight: number | null; default: not declared - portfolioConstruction.maximumPositions: number | null; default: not declared - portfolioConstruction.maximumTurnover: number | null; default: not declared - portfolioConstruction.method: WeightingMethod; default: not declared - portfolioConstruction.minimumPositionWeight: number | null; default: not declared - portfolioConstruction.neutrality: Neutrality; default: not declared - portfolioConstruction.short: ShortSideSelection | null; default: not declared - portfolioConstruction.short.bottomQuantile: number; default: not declared - portfolioConstruction.short.count: number; default: not declared - portfolioConstruction.short.fraction: number; default: not declared - portfolioConstruction.shortBookSizing: string; default: not declared - portfolioConstruction.volatilityLookbackSessions: number; default: not declared - pricing: string; default: not declared - rebalanceSchedule: { frequency: RebalanceFrequency; session: 'open' | 'close'; bufferBand: number | null; }; default: not declared - rebalanceSchedule.bufferBand: number | null; default: not declared - rebalanceSchedule.frequency: RebalanceFrequency; default: not declared - rebalanceSchedule.session: 'open' | 'close'; default: not declared - replayable: boolean; default: not declared - riskFreeRate: number; default: not declared - seed: number | null; default: not declared - sessionInstantConvention: string; default: not declared - signal: { kind: 'factor-recipe'; recipeName: string; recipeVersion: number; direction: string; lagTradingSessions: number; neutralization: string; } | { kind: 'score'; components: number; missingValuePolicy: string; } | { kind: 'screen'; orderBy: string[]; missingValuePolicy: string; } | { kind: 'callback'; replayable: false; }; default: not declared - signal.components: number; default: not declared - signal.direction: string; default: not declared - signal.kind: ('callback') | ('factor-recipe') | ('score') | ('screen'); default: not declared - signal.lagTradingSessions: number; default: not declared - signal.missingValuePolicy: string; default: not declared - signal.neutralization: string; default: not declared - signal.orderBy: string[]; default: not declared - signal.recipeName: string; default: not declared - signal.recipeVersion: number; default: not declared - signal.replayable: false; default: not declared - universeId: string; default: not declared - window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - window.fromTimestampMs: number | null; default: not declared - window.toTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalAttribution { perRebalance: AttributionRow[]; /** Mean rank information coefficient per horizon (in rebalances), across rebalances. */ decay: Array<{ horizonRebalances: number; meanRankInformationCoefficient: number | null; samples: number; }>; meanInformationCoefficient: number | null; meanRankInformationCoefficient: number | null; meanSpreadReturn: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - decay: { horizonRebalances: number; meanRankInformationCoefficient: number | null; samples: number; }[]; default: not declared — Mean rank information coefficient per horizon (in rebalances), across rebalances. - meanInformationCoefficient: number | null; default: not declared - meanRankInformationCoefficient: number | null; default: not declared - meanSpreadReturn: number | null; default: not declared - perRebalance: AttributionRow[]; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalBacktestGridRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalBacktestGridRequest { /** The base request every variation is applied to; validated once, never mutated. */ request: CrossSectionalBacktestRequest; /** The axes; the cartesian product is run with the last axis varying fastest. */ variations: readonly GridVariation[]; /** Variations the sweep may run (default 256, at most 4,096). */ maximumVariations?: number; /** The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. */ selectionMetric?: GridSelectionMetric; hygiene?: { /** CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. */ splits?: number; /** `researchProtocol`'s confidence in (0, 1); default 0.95. */ confidence?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - hygiene?: { confidence?: number; splits?: number; }; default: not declared - hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - request.baseCurrency?: string; default: not declared — Default `'USD'`. - request.dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - request.dataset.averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - request.dataset.benchmarkReturns?: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - request.dataset.betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - request.dataset.classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - request.dataset.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - request.dataset.groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - request.dataset.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - request.dataset.returns: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - request.dataset.sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. - request.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - request.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - request.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - request.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - request.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - request.execution.costs.borrow.label: string; default: not declared - request.execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - request.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - request.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - request.execution.costs.commission.commission(input).price: number; default: not declared - request.execution.costs.commission.commission(input).quantity: number; default: not declared - request.execution.costs.commission.label: string; default: not declared - request.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - request.execution.costs.latency.label: string; default: not declared - request.execution.costs.latency.sessions: number; default: not declared - request.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - request.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - request.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - request.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - request.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - request.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - request.execution.costs.marketImpact.label: string; default: not declared - request.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - request.execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - request.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - request.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - request.execution.costs.slippage.fill(input).quantity: number; default: not declared - request.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - request.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.execution.costs.slippage.label: string; default: not declared - request.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - request.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - request.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - request.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - request.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.execution.costs.spread.label: string; default: not declared - request.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - request.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - request.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - request.execution.fill.fill().return.detail?: string; default: not declared - request.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - request.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - request.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - request.execution.fill.fill().return.pricePerUnit: number; default: not declared - request.execution.fill.fill().return.quantity: number; default: not declared - request.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - request.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - request.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - request.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - request.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - request.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - request.execution.fill.label: string; default: not declared - request.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - request.execution.fill.version: string; default: not declared - request.execution.label: string; default: not declared — Echoed in every result's assumptions. - request.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - request.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - request.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - request.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - request.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - request.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - request.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - request.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - request.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - request.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - request.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - request.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - request.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - request.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - request.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - request.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - request.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - request.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - request.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - request.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - request.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - request.initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - request.periodsPerYear?: number; default: not declared — Default 252. - request.portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - request.portfolioConstruction.long: import('@insiderfinance/totalfinance/backtest').SideSelection; default: not declared - request.portfolioConstruction.long.count: number; default: not declared - request.portfolioConstruction.long.fraction: number; default: not declared - request.portfolioConstruction.long.topQuantile: number; default: not declared - request.portfolioConstruction.maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - request.portfolioConstruction.maximumPositionWeight?: number; default: not declared - request.portfolioConstruction.maximumPositions?: number; default: not declared - request.portfolioConstruction.maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - request.portfolioConstruction.method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; default: not declared - request.portfolioConstruction.minimumPositionWeight?: number; default: not declared - request.portfolioConstruction.neutrality?: import('@insiderfinance/totalfinance/backtest').Neutrality; default: not declared - request.portfolioConstruction.neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - request.portfolioConstruction.neutralizeAgainst.field: string; default: not declared - request.portfolioConstruction.riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - request.portfolioConstruction.short?: import('@insiderfinance/totalfinance/backtest').ShortSideSelection; default: not declared - request.portfolioConstruction.short.bottomQuantile: number; default: not declared - request.portfolioConstruction.short.count: number; default: not declared - request.portfolioConstruction.short.fraction: number; default: not declared - request.portfolioConstruction.suppliedWeights?: (context: import('@insiderfinance/totalfinance/backtest').WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - request.portfolioConstruction.suppliedWeights(context): import('@insiderfinance/totalfinance/backtest').WeightContext; default: not declared - request.portfolioConstruction.suppliedWeights(context).asOf: number; default: not declared - request.portfolioConstruction.suppliedWeights(context).long: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.portfolioConstruction.suppliedWeights(context).sessionDate: string; default: not declared - request.portfolioConstruction.suppliedWeights(context).short: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.portfolioConstruction.suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - request.portfolioConstruction.volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). - request.rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - request.rebalanceSchedule.bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - request.rebalanceSchedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - request.rebalanceSchedule.session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. - request.riskFreeRate?: number; default: not declared - request.seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - request.signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - request.signal.callback: (context: import('@insiderfinance/totalfinance/backtest').SignalContext) => readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.signal.callback(context): import('@insiderfinance/totalfinance/backtest').SignalContext; default: not declared - request.signal.callback(context).asOf: number; default: not declared - request.signal.callback(context).eligible: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - request.signal.callback(context).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - request.signal.callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - request.signal.callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - request.signal.callback(context).sessionDate: string; default: not declared - request.signal.factorRecipe: import('@insiderfinance/totalfinance/research').FactorRecipe; default: not declared - request.signal.factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - request.signal.factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - request.signal.factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - request.signal.factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - request.signal.factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - request.signal.factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - request.signal.factorRecipe.recipeName: string; default: not declared - request.signal.factorRecipe.recipeVersion: number; default: not declared - request.signal.score: { components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - request.signal.score.components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - request.signal.score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - request.signal.screen: { filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; }; default: not declared - request.signal.screen.filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - request.signal.screen.filter.all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - request.signal.screen.filter.any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - request.signal.screen.filter.field: string; default: not declared - request.signal.screen.filter.from: number; default: not declared - request.signal.screen.filter.not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - request.signal.screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - request.signal.screen.filter.to: number; default: not declared - request.signal.screen.filter.value: (number) | (string | number | boolean); default: not declared - request.signal.screen.filter.values: readonly (string | number)[]; default: not declared - request.signal.screen.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - request.signal.screen.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - request.transactionCostModel?: { commission?: import('@insiderfinance/totalfinance/backtest').CostModel; slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - request.transactionCostModel.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - request.transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - request.transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - request.transactionCostModel.commission.commission(input).price: number; default: not declared - request.transactionCostModel.commission.commission(input).quantity: number; default: not declared - request.transactionCostModel.commission.label: string; default: not declared - request.transactionCostModel.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - request.transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - request.transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - request.transactionCostModel.slippage.fill(input).quantity: number; default: not declared - request.transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - request.transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.transactionCostModel.slippage.label: string; default: not declared - request.universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - request.universeHistory.members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - request.universeHistory.universeId: string; default: not declared - request.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - request.window.fromTimestampMs?: number; default: not declared - request.window.toTimestampMs?: number; default: not declared - selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - variations: readonly GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. ### @insiderfinance/totalfinance/backtest#CrossSectionalBacktestGridResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalBacktestGridResult { /** The parent sweep hash: the content hash of the axes and every child run hash. */ sweepId: string; variations: GridVariationRow[]; /** Every child run, index-aligned with `variations` — the same function, called once per point. */ runs: CrossSectionalBacktestResult[]; /** The best trial by the selection metric, or `null` when no variation carries the metric. */ best: { index: number; runId: string; metric: GridSelectionMetric; value: number; } | null; hygiene: GridHygiene; assumptions: GridAssumptions; diagnostics: GridDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: GridAssumptions; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.hygiene: { splits: number | null; confidence: number; degenerateTrialSharpe: 0; }; default: not declared - assumptions.hygiene.confidence: number; default: not declared - assumptions.hygiene.degenerateTrialSharpe: 0; default: not declared — The trial Sharpe recorded for a degenerate return series. - assumptions.hygiene.splits: number | null; default: not declared — The CSCV blocks actually used, or `null` when the overfitting probability was not computed. - assumptions.maximumVariations: number; default: not declared - assumptions.paths: string[]; default: not declared - assumptions.periodsPerYear: number; default: not declared - assumptions.riskFreeRate: number; default: not declared - assumptions.selectionMetric: GridSelectionMetric; default: not declared - assumptions.variationCount: number; default: not declared - best: { index: number; metric: GridSelectionMetric; runId: string; value: number; } | null; default: not declared — The best trial by the selection metric, or `null` when no variation carries the metric. - best.index: number; default: not declared - best.metric: GridSelectionMetric; default: not declared - best.runId: string; default: not declared - best.value: number; default: not declared - diagnostics: GridDiagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.degenerateTrialCount: number; default: not declared - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.skippedHygiene: { block: 'researchProtocol' | 'backtestOverfitting' | 'deflatedSharpe'; reason: string; }[]; default: not declared — The hygiene blocks that were not computed, each with its reason. - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.variationCount: number; default: not declared - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - hygiene: GridHygiene; default: not declared - hygiene.backtestOverfitting: BacktestOverfittingProbabilityResult | null; default: not declared — `probabilityOfBacktestOverfitting` over the periods × variations return matrix; `null` when fewer than two variations or too few periods. - hygiene.backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - hygiene.backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - hygiene.backtestOverfitting.backtestOverfittingProbability: number; default: not declared — Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. - hygiene.backtestOverfitting.combinations: number; default: not declared — Number of symmetric train/test splits evaluated: `C(S, S/2)`. - hygiene.backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - hygiene.backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.backtestOverfitting.medianLogit: number; default: not declared — Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. - hygiene.backtestOverfitting.observations: number; default: not declared — Observations (rows) used after trimming to a multiple of `S`. - hygiene.backtestOverfitting.splits: number; default: not declared — Blocks `S` actually used. - hygiene.backtestOverfitting.trials: number; default: not declared — Number of strategy configurations (columns) `N`. - hygiene.deflatedSharpe: DeflatedSharpeResult | null; default: not declared — `deflatedSharpeRatio` for the best trial against the pool; `null` when the best trial is degenerate. - hygiene.deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - hygiene.deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - hygiene.deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carry no Sharpe (a zero-variance series). - hygiene.deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - hygiene.deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.deflatedSharpe.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. - hygiene.deflatedSharpe.probabilisticSharpe: number | null; default: not declared — The un-deflated PSR (benchmark 0), for comparison. - hygiene.deflatedSharpe.trialCount: number; default: not declared - hygiene.researchProtocol: ResearchVerdict | null; default: not declared — `researchProtocol` over the best trial's returns with the pool; `null` when the best trial is degenerate. - hygiene.researchProtocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - hygiene.researchProtocol.assumptions.confidence: number; default: not declared - hygiene.researchProtocol.assumptions.conventionsVersion: string; default: not declared - hygiene.researchProtocol.assumptions.periodsPerYear: number; default: not declared - hygiene.researchProtocol.deflatedSharpe: number | null; default: not declared — Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. - hygiene.researchProtocol.diagnostics: Diagnostics; default: not declared - hygiene.researchProtocol.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - hygiene.researchProtocol.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - hygiene.researchProtocol.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - hygiene.researchProtocol.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - hygiene.researchProtocol.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - hygiene.researchProtocol.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - hygiene.researchProtocol.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - hygiene.researchProtocol.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - hygiene.researchProtocol.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - hygiene.researchProtocol.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - hygiene.researchProtocol.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - hygiene.researchProtocol.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - hygiene.researchProtocol.diagnostics.selection.selected.name: string; default: not declared - hygiene.researchProtocol.diagnostics.selection.selected.version?: string; default: not declared - hygiene.researchProtocol.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - hygiene.researchProtocol.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - hygiene.researchProtocol.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - hygiene.researchProtocol.expectedMaxSharpe: number; default: not declared — SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). - hygiene.researchProtocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. - hygiene.researchProtocol.inSample.annualizedSharpe: number | null; default: not declared - hygiene.researchProtocol.inSample.observations: number; default: not declared - hygiene.researchProtocol.inSample.sharpe: number | null; default: not declared - hygiene.researchProtocol.minTrackRecordLength: number; default: not declared — Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). - hygiene.researchProtocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared — Present when out-of-sample returns are given; `null` figures when either series has zero variance. - hygiene.researchProtocol.outOfSample.annualizedSharpe: number | null; default: not declared - hygiene.researchProtocol.outOfSample.degradation: number | null; default: not declared - hygiene.researchProtocol.outOfSample.sharpe: number | null; default: not declared - hygiene.researchProtocol.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. - hygiene.researchProtocol.rationale: string; default: not declared — Prose an agent relays. - hygiene.researchProtocol.trialCount: number; default: not declared - hygiene.researchProtocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - hygiene.trialSharpes: number[]; default: not declared — The trial Sharpes in variation order — the pool `researchProtocol` deflates against. - runs: CrossSectionalBacktestResult[]; default: not declared — Every child run, index-aligned with `variations` — the same function, called once per point. - sweepId: string; default: not declared — The parent sweep hash: the content hash of the axes and every child run hash. - variations: GridVariationRow[]; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalBacktestRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Request // --------------------------------------------------------------------------------------------------- export interface CrossSectionalBacktestRequest { dataset: CrossSectionalDataset; universeHistory: UniverseHistory; signal: CrossSectionalSignal; rebalanceSchedule: RebalanceSchedule; portfolioConstruction: PortfolioConstruction; /** Decision 7's policy; omitted = `execution.simplified()`, and the result says so. */ execution?: ExecutionPolicy; /** Cost models applied to every fill; omitted = the policy's (none for the simplified policy). */ transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; /** Default 1,000,000 in `baseCurrency`. */ initialCapital?: number; /** Default `'USD'`. */ baseCurrency?: string; /** Restrict the run to sessions inside the window (inclusive instants). */ window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; /** Default 252. */ periodsPerYear?: number; riskFreeRate?: number; /** Seeds the bootstrap confidence intervals of the performance block; absent = none. */ seed?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency?: string; default: not declared — Default `'USD'`. - dataset: CrossSectionalDataset; default: not declared - dataset.averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - dataset.benchmarkReturns?: readonly ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - dataset.betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - dataset.classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - dataset.fieldDefinitions: readonly FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - dataset.groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - dataset.observations: readonly UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - dataset.returns: readonly ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - dataset.sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. - execution?: ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - execution.costs.borrow.label: string; default: not declared - execution.costs.commission: CostModel; default: not declared - execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - execution.costs.commission.commission(input).price: number; default: not declared - execution.costs.commission.commission(input).quantity: number; default: not declared - execution.costs.commission.label: string; default: not declared - execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - execution.costs.latency.label: string; default: not declared - execution.costs.latency.sessions: number; default: not declared - execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - execution.costs.marketImpact.impact(input).quantity: number; default: not declared - execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - execution.costs.marketImpact.label: string; default: not declared - execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - execution.costs.slippage: SlippageModel; default: not declared - execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - execution.costs.slippage.fill(input).quantity: number; default: not declared - execution.costs.slippage.fill(input).referencePrice: number; default: not declared - execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.slippage.label: string; default: not declared - execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.spread.label: string; default: not declared - execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - execution.fill.fill().return.detail?: string; default: not declared - execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - execution.fill.fill().return.pricePerUnit: number; default: not declared - execution.fill.fill().return.quantity: number; default: not declared - execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - execution.fill.label: string; default: not declared - execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared — Echoed in every result's assumptions. - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - periodsPerYear?: number; default: not declared — Default 252. - portfolioConstruction: PortfolioConstruction; default: not declared - portfolioConstruction.long: SideSelection; default: not declared - portfolioConstruction.long.count: number; default: not declared - portfolioConstruction.long.fraction: number; default: not declared - portfolioConstruction.long.topQuantile: number; default: not declared - portfolioConstruction.maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - portfolioConstruction.maximumPositionWeight?: number; default: not declared - portfolioConstruction.maximumPositions?: number; default: not declared - portfolioConstruction.maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - portfolioConstruction.method: WeightingMethod; default: not declared - portfolioConstruction.minimumPositionWeight?: number; default: not declared - portfolioConstruction.neutrality?: Neutrality; default: not declared - portfolioConstruction.neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - portfolioConstruction.neutralizeAgainst.field: string; default: not declared - portfolioConstruction.riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - portfolioConstruction.short?: ShortSideSelection; default: not declared - portfolioConstruction.short.bottomQuantile: number; default: not declared - portfolioConstruction.short.count: number; default: not declared - portfolioConstruction.short.fraction: number; default: not declared - portfolioConstruction.suppliedWeights?: (context: WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - portfolioConstruction.suppliedWeights(context): WeightContext; default: not declared - portfolioConstruction.suppliedWeights(context).asOf: number; default: not declared - portfolioConstruction.suppliedWeights(context).long: readonly SignalRow[]; default: not declared - portfolioConstruction.suppliedWeights(context).sessionDate: string; default: not declared - portfolioConstruction.suppliedWeights(context).short: readonly SignalRow[]; default: not declared - portfolioConstruction.suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - portfolioConstruction.volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). - rebalanceSchedule: RebalanceSchedule; default: not declared - rebalanceSchedule.bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - rebalanceSchedule.frequency: RebalanceFrequency; default: not declared - rebalanceSchedule.session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. - riskFreeRate?: number; default: not declared - seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - signal: CrossSectionalSignal; default: not declared - signal.callback: (context: SignalContext) => readonly SignalRow[]; default: not declared - signal.callback(context): SignalContext; default: not declared - signal.callback(context).asOf: number; default: not declared - signal.callback(context).eligible: readonly UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - signal.callback(context).fieldDefinitions: readonly FieldDefinition[]; default: not declared - signal.callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - signal.callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - signal.callback(context).sessionDate: string; default: not declared - signal.factorRecipe: FactorRecipe; default: not declared - signal.factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - signal.factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - signal.factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - signal.factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - signal.factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - signal.factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - signal.factorRecipe.recipeName: string; default: not declared - signal.factorRecipe.recipeVersion: number; default: not declared - signal.score: { components: readonly ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - signal.score.components: readonly ScoreComponent[]; default: not declared - signal.score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - signal.screen: { filter?: ScreenFilter; missingValuePolicy: MissingValuePolicy; orderBy: readonly ScreenOrdering[]; }; default: not declared - signal.screen.filter?: ScreenFilter; default: not declared - signal.screen.filter.all: readonly ScreenFilter[]; default: not declared - signal.screen.filter.any: readonly ScreenFilter[]; default: not declared - signal.screen.filter.field: string; default: not declared - signal.screen.filter.from: number; default: not declared - signal.screen.filter.not: ScreenFilter; default: not declared - signal.screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - signal.screen.filter.to: number; default: not declared - signal.screen.filter.value: (number) | (string | number | boolean); default: not declared - signal.screen.filter.values: readonly (string | number)[]; default: not declared - signal.screen.missingValuePolicy: MissingValuePolicy; default: not declared - signal.screen.orderBy: readonly ScreenOrdering[]; default: not declared - transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - transactionCostModel.commission?: CostModel; default: not declared - transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - transactionCostModel.commission.commission(input).price: number; default: not declared - transactionCostModel.commission.commission(input).quantity: number; default: not declared - transactionCostModel.commission.label: string; default: not declared - transactionCostModel.slippage?: SlippageModel; default: not declared - transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - transactionCostModel.slippage.fill(input).quantity: number; default: not declared - transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - transactionCostModel.slippage.label: string; default: not declared - universeHistory: UniverseHistory; default: not declared - universeHistory.members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - universeHistory.universeId: string; default: not declared - window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - window.fromTimestampMs?: number; default: not declared - window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalBacktestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalBacktestResult { rebalances: RebalanceRow[]; holdings: HoldingRow[]; points: EquityPoint[]; returns: number[]; trades: Trade[]; fills: NormalizedFill[]; ledger: PortfolioLedgerSnapshot; timeline: PortfolioTimelineResult; attribution: CrossSectionalAttribution; benchmark: BenchmarkComparison | null; performance: PerformanceSummary; /** Bootstrap confidence intervals of the performance block when a seed was given. */ performanceConfidence: { iterations: number; seed: number; meanTotalReturn: number; standardDeviation: number; confidenceInterval95: [ number, number ]; } | null; finalValue: number; runId: string; assumptions: CrossSectionalAssumptions; diagnostics: CrossSectionalDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: CrossSectionalAssumptions; default: not declared - assumptions.baseCurrency: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.costs: { commission: string; slippage: string; }; default: not declared - assumptions.costs.commission: string; default: not declared - assumptions.costs.slippage: string; default: not declared - assumptions.execution: ExecutionPolicyDescription; default: not declared - assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - assumptions.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - assumptions.execution.costs.borrow: string | null; default: not declared - assumptions.execution.costs.commission: string; default: not declared - assumptions.execution.costs.latencySessions: number | null; default: not declared - assumptions.execution.costs.marketImpact: string | null; default: not declared - assumptions.execution.costs.participation: number | null; default: not declared - assumptions.execution.costs.slippage: string; default: not declared - assumptions.execution.costs.spread: string | null; default: not declared - assumptions.execution.fill: { label: string; version: string; }; default: not declared - assumptions.execution.fill.label: string; default: not declared - assumptions.execution.fill.version: string; default: not declared - assumptions.execution.label: string; default: not declared - assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - assumptions.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - assumptions.execution.sessions.halts: number; default: not declared - assumptions.execution.sessions.priceLimits: number; default: not declared - assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - assumptions.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - assumptions.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - assumptions.initialCapital: number; default: not declared - assumptions.ledger: { accountId: string; lotRelief: string; sourceId: string; }; default: not declared - assumptions.ledger.accountId: string; default: not declared - assumptions.ledger.lotRelief: string; default: not declared - assumptions.ledger.sourceId: string; default: not declared - assumptions.periodsPerYear: number; default: not declared - assumptions.portfolioConstruction: { long: SideSelection; maximumParticipation: number | null; maximumPositionWeight: number | null; maximumPositions: number | null; maximumTurnover: number | null; method: WeightingMethod; minimumPositionWeight: number | null; neutrality: Neutrality; short: ShortSideSelection | null; shortBookSizing: string; volatilityLookbackSessions: number; }; default: not declared - assumptions.portfolioConstruction.long: SideSelection; default: not declared - assumptions.portfolioConstruction.long.count: number; default: not declared - assumptions.portfolioConstruction.long.fraction: number; default: not declared - assumptions.portfolioConstruction.long.topQuantile: number; default: not declared - assumptions.portfolioConstruction.maximumParticipation: number | null; default: not declared - assumptions.portfolioConstruction.maximumPositionWeight: number | null; default: not declared - assumptions.portfolioConstruction.maximumPositions: number | null; default: not declared - assumptions.portfolioConstruction.maximumTurnover: number | null; default: not declared - assumptions.portfolioConstruction.method: WeightingMethod; default: not declared - assumptions.portfolioConstruction.minimumPositionWeight: number | null; default: not declared - assumptions.portfolioConstruction.neutrality: Neutrality; default: not declared - assumptions.portfolioConstruction.short: ShortSideSelection | null; default: not declared - assumptions.portfolioConstruction.short.bottomQuantile: number; default: not declared - assumptions.portfolioConstruction.short.count: number; default: not declared - assumptions.portfolioConstruction.short.fraction: number; default: not declared - assumptions.portfolioConstruction.shortBookSizing: string; default: not declared - assumptions.portfolioConstruction.volatilityLookbackSessions: number; default: not declared - assumptions.pricing: string; default: not declared - assumptions.rebalanceSchedule: { bufferBand: number | null; frequency: RebalanceFrequency; session: 'open' | 'close'; }; default: not declared - assumptions.rebalanceSchedule.bufferBand: number | null; default: not declared - assumptions.rebalanceSchedule.frequency: RebalanceFrequency; default: not declared - assumptions.rebalanceSchedule.session: 'open' | 'close'; default: not declared - assumptions.replayable: boolean; default: not declared - assumptions.riskFreeRate: number; default: not declared - assumptions.seed: number | null; default: not declared - assumptions.sessionInstantConvention: string; default: not declared - assumptions.signal: { direction: string; kind: 'factor-recipe'; lagTradingSessions: number; neutralization: string; recipeName: string; recipeVersion: number; } | { components: number; kind: 'score'; missingValuePolicy: string; } | { kind: 'screen'; missingValuePolicy: string; orderBy: string[]; } | { kind: 'callback'; replayable: false; }; default: not declared - assumptions.signal.components: number; default: not declared - assumptions.signal.direction: string; default: not declared - assumptions.signal.kind: ('callback') | ('factor-recipe') | ('score') | ('screen'); default: not declared - assumptions.signal.lagTradingSessions: number; default: not declared - assumptions.signal.missingValuePolicy: string; default: not declared - assumptions.signal.neutralization: string; default: not declared - assumptions.signal.orderBy: string[]; default: not declared - assumptions.signal.recipeName: string; default: not declared - assumptions.signal.recipeVersion: number; default: not declared - assumptions.signal.replayable: false; default: not declared - assumptions.universeId: string; default: not declared - assumptions.window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - assumptions.window.fromTimestampMs: number | null; default: not declared - assumptions.window.toTimestampMs: number | null; default: not declared - attribution: CrossSectionalAttribution; default: not declared - attribution.decay: { horizonRebalances: number; meanRankInformationCoefficient: number | null; samples: number; }[]; default: not declared — Mean rank information coefficient per horizon (in rebalances), across rebalances. - attribution.meanInformationCoefficient: number | null; default: not declared - attribution.meanRankInformationCoefficient: number | null; default: not declared - attribution.meanSpreadReturn: number | null; default: not declared - attribution.perRebalance: AttributionRow[]; default: not declared - benchmark: BenchmarkComparison | null; default: not declared - benchmark.activeReturn: number | null; default: not declared - benchmark.alpha: number | null; default: not declared - benchmark.beta: number | null; default: not declared - benchmark.informationRatio: number | null; default: not declared - benchmark.instrumentId: string; default: not declared - benchmark.returns: number[]; default: not declared — The benchmark's per-session simple returns aligned to the run's sessions. - benchmark.trackingError: number | null; default: not declared - diagnostics: CrossSectionalDiagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.cappedGoalCount: number; default: not declared - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.delistingCount: number; default: not declared - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.exitCount: number; default: not declared - diagnostics.fillCount: number; default: not declared - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.rebalanceCount: number; default: not declared - diagnostics.reconciliationResidual: number; default: not declared — The ledger's final base-currency NAV minus the reported `finalValue` — always 0 within 1e-9. - diagnostics.rejectedFillCount: number; default: not declared - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.sessionCount: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.violatedGoalCount: number; default: not declared - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fills: NormalizedFill[]; default: not declared - finalValue: number; default: not declared - holdings: HoldingRow[]; default: not declared - ledger: PortfolioLedgerSnapshot; default: not declared - ledger.baseCurrency: string; default: not declared - ledger.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - ledger.portfolioId?: string; default: not declared - ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - ledger.provenance.asOf?: number; default: not declared - ledger.provenance.dataset?: string; default: not declared - ledger.provenance.provider?: string; default: not declared - ledger.provenance.receivedAt?: number; default: not declared - ledger.provenance.requestId?: string; default: not declared - ledger.provenance.sourceVersion?: string; default: not declared - ledger.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - ledger.schemaVersion: number; default: not declared - performance: PerformanceSummary; default: not declared - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - performanceConfidence: { confidenceInterval95: [number, number]; iterations: number; meanTotalReturn: number; seed: number; standardDeviation: number; } | null; default: not declared — Bootstrap confidence intervals of the performance block when a seed was given. - performanceConfidence.confidenceInterval95: [number, number]; default: not declared - performanceConfidence.iterations: number; default: not declared - performanceConfidence.meanTotalReturn: number; default: not declared - performanceConfidence.seed: number; default: not declared - performanceConfidence.standardDeviation: number; default: not declared - points: EquityPoint[]; default: not declared - rebalances: RebalanceRow[]; default: not declared - returns: number[]; default: not declared - runId: string; default: not declared - timeline: PortfolioTimelineResult; default: not declared - timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - timeline.assumptions.conventionsVersion: string; default: not declared - timeline.assumptions.exposureConvention: string; default: not declared - timeline.assumptions.indexConvention: string; default: not declared - timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - timeline.assumptions.markInstant: string; default: not declared - timeline.baseCurrency: string; default: not declared - timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - timeline.cumulativePnl.financing: number; default: not declared - timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - timeline.cumulativePnl.income: number; default: not declared - timeline.cumulativePnl.realizedPnl: number; default: not declared - timeline.cumulativePnl.residual: number; default: not declared - timeline.cumulativePnl.totalPnl: number; default: not declared - timeline.cumulativePnl.transactionCosts: number; default: not declared - timeline.cumulativePnl.unrealizedPnl: number; default: not declared - timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - timeline.diagnostics.markCount: number; default: not declared - timeline.diagnostics.warnings: string[]; default: not declared - timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - trades: Trade[]; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalDataset Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The point-in-time inputs a cross-sectional strategy reads. Prices are return-index levels. ```typescript // --------------------------------------------------------------------------------------------------- // Dataset // --------------------------------------------------------------------------------------------------- /** The point-in-time inputs a cross-sectional strategy reads. Prices are return-index levels. */ export interface CrossSectionalDataset { /** Features with `availableTimestampMs` — what a decision may see is decided by availability. */ observations: readonly UniverseObservation[]; /** Declared fields; nothing is inferred from the data. */ fieldDefinitions: readonly FieldDefinition[]; /** Per-instrument per-session simple returns; their session dates are the run's calendar. */ returns: readonly ReturnObservation[]; /** A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). */ benchmarkReturns?: readonly ReturnObservation[]; /** Grouping for sector-neutral targets and the recipe's sector neutralization. */ groups?: Readonly>; /** The observation field that carries size (log market capitalization) for `sector-and-size`. */ sizeField?: string; /** Grouping for the ledger's exposure reports (asset class, strategy, tags). */ classification?: Readonly>; /** Average daily volume in return-index units, for the participation constraint. */ averageDailyVolumes?: Readonly>; /** Per-instrument betas for beta-neutral targets. */ betas?: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - benchmarkReturns?: readonly ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - fieldDefinitions: readonly FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - observations: readonly UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - returns: readonly ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. ### @insiderfinance/totalfinance/backtest#CrossSectionalDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalDiagnostics extends Diagnostics { sessionCount: number; rebalanceCount: number; fillCount: number; rejectedFillCount: number; exitCount: number; delistingCount: number; cappedGoalCount: number; violatedGoalCount: number; /** The ledger's final base-currency NAV minus the reported `finalValue` — always 0 within 1e-9. */ reconciliationResidual: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cappedGoalCount: number; default: not declared - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - delistingCount: number; default: not declared - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - exitCount: number; default: not declared - fillCount: number; default: not declared - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rebalanceCount: number; default: not declared - reconciliationResidual: number; default: not declared — The ledger's final base-currency NAV minus the reported `finalValue` — always 0 within 1e-9. - rejectedFillCount: number; default: not declared - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - sessionCount: number; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - violatedGoalCount: number; default: not declared - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/backtest#CrossSectionalOutOfSampleResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSectionalOutOfSampleResult { /** The content hash of the procedure: the grid axes, the fold plan, and every held-out run id. */ evaluationId: string; windows: OutOfSampleWindowRow[]; /** Every held-out run, index-aligned with the evaluated windows (`windows[i].testRunId !== null`). */ runs: CrossSectionalBacktestResult[]; /** Held-out per-session returns stitched in window order. */ returns: number[]; /** The performance block of the stitched held-out returns; `null` under two returns. */ performance: PerformanceSummary | null; hygiene: OutOfSampleHygiene; assumptions: OutOfSampleAssumptions; diagnostics: OutOfSampleDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: OutOfSampleAssumptions; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.periodsPerYear: number; default: not declared - assumptions.selectionMetric: GridSelectionMetric; default: not declared - assumptions.sessionCount: number; default: not declared — Total sessions of the base request inside its window. - assumptions.stitching: string; default: not declared — How held-out returns were stitched: in window order, each test span's per-session returns appended. - assumptions.visibility: string; default: not declared — The rule for which sessions each window could see. - diagnostics: OutOfSampleDiagnostics; default: not declared - diagnostics.skippedWindowCount: number; default: not declared — Windows skipped because a span had fewer than two sessions after purging. - diagnostics.warnings: QuantWarning[]; default: not declared - evaluationId: string; default: not declared — The content hash of the procedure: the grid axes, the fold plan, and every held-out run id. - hygiene: OutOfSampleHygiene; default: not declared - hygiene.degradation: number | null; default: not declared — `meanTrainMetric − meanTestMetric` — how much the in-sample choice flattered the strategy. - hygiene.evaluatedWindowCount: number; default: not declared — Windows where a variation could be chosen and evaluated. - hygiene.meanTestMetric: number | null; default: not declared — Mean selection metric on the held-out spans, over evaluated windows. - hygiene.meanTrainMetric: number | null; default: not declared — Mean selection metric on the training spans, over evaluated windows. - hygiene.negativeTestFraction: number | null; default: not declared — Fraction of evaluated windows whose held-out metric was below zero. - hygiene.windowCount: number; default: not declared - performance: PerformanceSummary | null; default: not declared — The performance block of the stitched held-out returns; `null` under two returns. - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - returns: number[]; default: not declared — Held-out per-session returns stitched in window order. - runs: CrossSectionalBacktestResult[]; default: not declared — Every held-out run, index-aligned with the evaluated windows (`windows[i].testRunId !== null`). - windows: OutOfSampleWindowRow[]; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalPurgedFoldsRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The grid's members inline plus the fold plan (see {@link CrossSectionalWalkForwardRequest}). ```typescript /** The grid's members inline plus the fold plan (see {@link CrossSectionalWalkForwardRequest}). */ export interface CrossSectionalPurgedFoldsRequest extends CrossSectionalBacktestGridRequest { /** Folds (≥ 2, ≤ sessions ÷ 2 so every held-out span carries two sessions). */ folds: number; /** `purgedKFold`'s embargo fraction (default 0). */ embargo?: number; /** `purgedKFold`'s purge gap in sessions on each side of a held-out span (default 0). */ purgeGap?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embargo?: number; default: not declared — `purgedKFold`'s embargo fraction (default 0). - folds: number; default: not declared — Folds (≥ 2, ≤ sessions ÷ 2 so every held-out span carries two sessions). - hygiene?: { confidence?: number; splits?: number; }; default: not declared - hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - purgeGap?: number; default: not declared — `purgedKFold`'s purge gap in sessions on each side of a held-out span (default 0). - request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - request.baseCurrency?: string; default: not declared — Default `'USD'`. - request.dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - request.dataset.averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - request.dataset.benchmarkReturns?: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - request.dataset.betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - request.dataset.classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - request.dataset.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - request.dataset.groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - request.dataset.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - request.dataset.returns: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - request.dataset.sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. - request.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - request.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - request.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - request.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - request.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - request.execution.costs.borrow.label: string; default: not declared - request.execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - request.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - request.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - request.execution.costs.commission.commission(input).price: number; default: not declared - request.execution.costs.commission.commission(input).quantity: number; default: not declared - request.execution.costs.commission.label: string; default: not declared - request.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - request.execution.costs.latency.label: string; default: not declared - request.execution.costs.latency.sessions: number; default: not declared - request.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - request.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - request.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - request.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - request.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - request.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - request.execution.costs.marketImpact.label: string; default: not declared - request.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - request.execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - request.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - request.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - request.execution.costs.slippage.fill(input).quantity: number; default: not declared - request.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - request.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.execution.costs.slippage.label: string; default: not declared - request.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - request.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - request.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - request.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - request.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.execution.costs.spread.label: string; default: not declared - request.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - request.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - request.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - request.execution.fill.fill().return.detail?: string; default: not declared - request.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - request.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - request.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - request.execution.fill.fill().return.pricePerUnit: number; default: not declared - request.execution.fill.fill().return.quantity: number; default: not declared - request.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - request.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - request.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - request.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - request.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - request.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - request.execution.fill.label: string; default: not declared - request.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - request.execution.fill.version: string; default: not declared - request.execution.label: string; default: not declared — Echoed in every result's assumptions. - request.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - request.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - request.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - request.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - request.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - request.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - request.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - request.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - request.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - request.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - request.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - request.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - request.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - request.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - request.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - request.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - request.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - request.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - request.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - request.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - request.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - request.initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - request.periodsPerYear?: number; default: not declared — Default 252. - request.portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - request.portfolioConstruction.long: import('@insiderfinance/totalfinance/backtest').SideSelection; default: not declared - request.portfolioConstruction.long.count: number; default: not declared - request.portfolioConstruction.long.fraction: number; default: not declared - request.portfolioConstruction.long.topQuantile: number; default: not declared - request.portfolioConstruction.maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - request.portfolioConstruction.maximumPositionWeight?: number; default: not declared - request.portfolioConstruction.maximumPositions?: number; default: not declared - request.portfolioConstruction.maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - request.portfolioConstruction.method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; default: not declared - request.portfolioConstruction.minimumPositionWeight?: number; default: not declared - request.portfolioConstruction.neutrality?: import('@insiderfinance/totalfinance/backtest').Neutrality; default: not declared - request.portfolioConstruction.neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - request.portfolioConstruction.neutralizeAgainst.field: string; default: not declared - request.portfolioConstruction.riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - request.portfolioConstruction.short?: import('@insiderfinance/totalfinance/backtest').ShortSideSelection; default: not declared - request.portfolioConstruction.short.bottomQuantile: number; default: not declared - request.portfolioConstruction.short.count: number; default: not declared - request.portfolioConstruction.short.fraction: number; default: not declared - request.portfolioConstruction.suppliedWeights?: (context: import('@insiderfinance/totalfinance/backtest').WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - request.portfolioConstruction.suppliedWeights(context): import('@insiderfinance/totalfinance/backtest').WeightContext; default: not declared - request.portfolioConstruction.suppliedWeights(context).asOf: number; default: not declared - request.portfolioConstruction.suppliedWeights(context).long: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.portfolioConstruction.suppliedWeights(context).sessionDate: string; default: not declared - request.portfolioConstruction.suppliedWeights(context).short: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.portfolioConstruction.suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - request.portfolioConstruction.volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). - request.rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - request.rebalanceSchedule.bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - request.rebalanceSchedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - request.rebalanceSchedule.session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. - request.riskFreeRate?: number; default: not declared - request.seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - request.signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - request.signal.callback: (context: import('@insiderfinance/totalfinance/backtest').SignalContext) => readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.signal.callback(context): import('@insiderfinance/totalfinance/backtest').SignalContext; default: not declared - request.signal.callback(context).asOf: number; default: not declared - request.signal.callback(context).eligible: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - request.signal.callback(context).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - request.signal.callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - request.signal.callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - request.signal.callback(context).sessionDate: string; default: not declared - request.signal.factorRecipe: import('@insiderfinance/totalfinance/research').FactorRecipe; default: not declared - request.signal.factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - request.signal.factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - request.signal.factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - request.signal.factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - request.signal.factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - request.signal.factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - request.signal.factorRecipe.recipeName: string; default: not declared - request.signal.factorRecipe.recipeVersion: number; default: not declared - request.signal.score: { components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - request.signal.score.components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - request.signal.score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - request.signal.screen: { filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; }; default: not declared - request.signal.screen.filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - request.signal.screen.filter.all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - request.signal.screen.filter.any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - request.signal.screen.filter.field: string; default: not declared - request.signal.screen.filter.from: number; default: not declared - request.signal.screen.filter.not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - request.signal.screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - request.signal.screen.filter.to: number; default: not declared - request.signal.screen.filter.value: (number) | (string | number | boolean); default: not declared - request.signal.screen.filter.values: readonly (string | number)[]; default: not declared - request.signal.screen.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - request.signal.screen.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - request.transactionCostModel?: { commission?: import('@insiderfinance/totalfinance/backtest').CostModel; slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - request.transactionCostModel.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - request.transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - request.transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - request.transactionCostModel.commission.commission(input).price: number; default: not declared - request.transactionCostModel.commission.commission(input).quantity: number; default: not declared - request.transactionCostModel.commission.label: string; default: not declared - request.transactionCostModel.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - request.transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - request.transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - request.transactionCostModel.slippage.fill(input).quantity: number; default: not declared - request.transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - request.transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.transactionCostModel.slippage.label: string; default: not declared - request.universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - request.universeHistory.members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - request.universeHistory.universeId: string; default: not declared - request.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - request.window.fromTimestampMs?: number; default: not declared - request.window.toTimestampMs?: number; default: not declared - selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. ### @insiderfinance/totalfinance/backtest#CrossSectionalSignal Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CrossSectionalSignal = { factorRecipe: FactorRecipe; } | { score: { components: readonly ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; } | { screen: { filter?: ScreenFilter; orderBy: readonly ScreenOrdering[]; missingValuePolicy: MissingValuePolicy; }; } | { callback: (context: SignalContext) => readonly SignalRow[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callback: (context: SignalContext) => readonly SignalRow[]; default: not declared - callback(context): SignalContext; default: not declared - callback(context).asOf: number; default: not declared - callback(context).eligible: readonly UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - callback(context).fieldDefinitions: readonly FieldDefinition[]; default: not declared - callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - callback(context).sessionDate: string; default: not declared - factorRecipe: FactorRecipe; default: not declared - factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - factorRecipe.recipeName: string; default: not declared - factorRecipe.recipeVersion: number; default: not declared - score: { components: readonly ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - score.components: readonly ScoreComponent[]; default: not declared - score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - screen: { filter?: ScreenFilter; missingValuePolicy: MissingValuePolicy; orderBy: readonly ScreenOrdering[]; }; default: not declared - screen.filter?: ScreenFilter; default: not declared - screen.filter.all: readonly ScreenFilter[]; default: not declared - screen.filter.any: readonly ScreenFilter[]; default: not declared - screen.filter.field: string; default: not declared - screen.filter.from: number; default: not declared - screen.filter.not: ScreenFilter; default: not declared - screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - screen.filter.to: number; default: not declared - screen.filter.value: (number) | (string | number | boolean); default: not declared - screen.filter.values: readonly (string | number)[]; default: not declared - screen.missingValuePolicy: MissingValuePolicy; default: not declared - screen.orderBy: readonly ScreenOrdering[]; default: not declared ### @insiderfinance/totalfinance/backtest#CrossSectionalWalkForwardRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The grid's members inline (`request`, `variations`, `maximumVariations`, `selectionMetric`, `hygiene`) plus the walk-forward plan — one object, the same shape a grid call takes, so the cross-sectional request sits where every declaration walker and fixture already reads it. ```typescript /** * The grid's members inline (`request`, `variations`, `maximumVariations`, `selectionMetric`, * `hygiene`) plus the walk-forward plan — one object, the same shape a grid call takes, so the * cross-sectional request sits where every declaration walker and fixture already reads it. */ export interface CrossSectionalWalkForwardRequest extends CrossSectionalBacktestGridRequest { /** Sessions in each training span (≥ 2). */ trainSessions: number; /** Sessions in each held-out span (≥ 2). */ testSessions: number; /** Sessions the window advances by; default `testSessions` (adjacent, non-overlapping held-out spans). */ step?: number; /** `'rolling'` (default): training spans slide; `'anchored'`: every training span starts at the first session. */ mode?: 'rolling' | 'anchored'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - hygiene?: { confidence?: number; splits?: number; }; default: not declared - hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - mode?: 'rolling' | 'anchored'; default: not declared — `'rolling'` (default): training spans slide; `'anchored'`: every training span starts at the first session. - request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - request.baseCurrency?: string; default: not declared — Default `'USD'`. - request.dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - request.dataset.averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - request.dataset.benchmarkReturns?: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - request.dataset.betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - request.dataset.classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - request.dataset.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - request.dataset.groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - request.dataset.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - request.dataset.returns: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - request.dataset.sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. - request.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - request.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - request.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - request.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - request.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - request.execution.costs.borrow.label: string; default: not declared - request.execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - request.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - request.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - request.execution.costs.commission.commission(input).price: number; default: not declared - request.execution.costs.commission.commission(input).quantity: number; default: not declared - request.execution.costs.commission.label: string; default: not declared - request.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - request.execution.costs.latency.label: string; default: not declared - request.execution.costs.latency.sessions: number; default: not declared - request.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - request.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - request.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - request.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - request.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - request.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - request.execution.costs.marketImpact.label: string; default: not declared - request.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - request.execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - request.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - request.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - request.execution.costs.slippage.fill(input).quantity: number; default: not declared - request.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - request.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.execution.costs.slippage.label: string; default: not declared - request.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - request.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - request.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - request.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - request.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.execution.costs.spread.label: string; default: not declared - request.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - request.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - request.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - request.execution.fill.fill().return.detail?: string; default: not declared - request.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - request.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - request.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - request.execution.fill.fill().return.pricePerUnit: number; default: not declared - request.execution.fill.fill().return.quantity: number; default: not declared - request.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - request.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - request.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - request.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - request.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - request.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - request.execution.fill.label: string; default: not declared - request.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - request.execution.fill.version: string; default: not declared - request.execution.label: string; default: not declared — Echoed in every result's assumptions. - request.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - request.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - request.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - request.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - request.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - request.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - request.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - request.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - request.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - request.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - request.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - request.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - request.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - request.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - request.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - request.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - request.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - request.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - request.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - request.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - request.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - request.initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - request.periodsPerYear?: number; default: not declared — Default 252. - request.portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - request.portfolioConstruction.long: import('@insiderfinance/totalfinance/backtest').SideSelection; default: not declared - request.portfolioConstruction.long.count: number; default: not declared - request.portfolioConstruction.long.fraction: number; default: not declared - request.portfolioConstruction.long.topQuantile: number; default: not declared - request.portfolioConstruction.maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - request.portfolioConstruction.maximumPositionWeight?: number; default: not declared - request.portfolioConstruction.maximumPositions?: number; default: not declared - request.portfolioConstruction.maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - request.portfolioConstruction.method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; default: not declared - request.portfolioConstruction.minimumPositionWeight?: number; default: not declared - request.portfolioConstruction.neutrality?: import('@insiderfinance/totalfinance/backtest').Neutrality; default: not declared - request.portfolioConstruction.neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - request.portfolioConstruction.neutralizeAgainst.field: string; default: not declared - request.portfolioConstruction.riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - request.portfolioConstruction.short?: import('@insiderfinance/totalfinance/backtest').ShortSideSelection; default: not declared - request.portfolioConstruction.short.bottomQuantile: number; default: not declared - request.portfolioConstruction.short.count: number; default: not declared - request.portfolioConstruction.short.fraction: number; default: not declared - request.portfolioConstruction.suppliedWeights?: (context: import('@insiderfinance/totalfinance/backtest').WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - request.portfolioConstruction.suppliedWeights(context): import('@insiderfinance/totalfinance/backtest').WeightContext; default: not declared - request.portfolioConstruction.suppliedWeights(context).asOf: number; default: not declared - request.portfolioConstruction.suppliedWeights(context).long: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.portfolioConstruction.suppliedWeights(context).sessionDate: string; default: not declared - request.portfolioConstruction.suppliedWeights(context).short: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.portfolioConstruction.suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - request.portfolioConstruction.volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). - request.rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - request.rebalanceSchedule.bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - request.rebalanceSchedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - request.rebalanceSchedule.session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. - request.riskFreeRate?: number; default: not declared - request.seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - request.signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - request.signal.callback: (context: import('@insiderfinance/totalfinance/backtest').SignalContext) => readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - request.signal.callback(context): import('@insiderfinance/totalfinance/backtest').SignalContext; default: not declared - request.signal.callback(context).asOf: number; default: not declared - request.signal.callback(context).eligible: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - request.signal.callback(context).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - request.signal.callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - request.signal.callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - request.signal.callback(context).sessionDate: string; default: not declared - request.signal.factorRecipe: import('@insiderfinance/totalfinance/research').FactorRecipe; default: not declared - request.signal.factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - request.signal.factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - request.signal.factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - request.signal.factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - request.signal.factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - request.signal.factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - request.signal.factorRecipe.recipeName: string; default: not declared - request.signal.factorRecipe.recipeVersion: number; default: not declared - request.signal.score: { components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - request.signal.score.components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - request.signal.score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - request.signal.screen: { filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; }; default: not declared - request.signal.screen.filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - request.signal.screen.filter.all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - request.signal.screen.filter.any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - request.signal.screen.filter.field: string; default: not declared - request.signal.screen.filter.from: number; default: not declared - request.signal.screen.filter.not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - request.signal.screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - request.signal.screen.filter.to: number; default: not declared - request.signal.screen.filter.value: (number) | (string | number | boolean); default: not declared - request.signal.screen.filter.values: readonly (string | number)[]; default: not declared - request.signal.screen.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - request.signal.screen.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - request.transactionCostModel?: { commission?: import('@insiderfinance/totalfinance/backtest').CostModel; slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - request.transactionCostModel.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - request.transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - request.transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - request.transactionCostModel.commission.commission(input).price: number; default: not declared - request.transactionCostModel.commission.commission(input).quantity: number; default: not declared - request.transactionCostModel.commission.label: string; default: not declared - request.transactionCostModel.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - request.transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - request.transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - request.transactionCostModel.slippage.fill(input).quantity: number; default: not declared - request.transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - request.transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - request.transactionCostModel.slippage.label: string; default: not declared - request.universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - request.universeHistory.members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - request.universeHistory.universeId: string; default: not declared - request.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - request.window.fromTimestampMs?: number; default: not declared - request.window.toTimestampMs?: number; default: not declared - selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - step?: number; default: not declared — Sessions the window advances by; default `testSessions` (adjacent, non-overlapping held-out spans). - testSessions: number; default: not declared — Sessions in each held-out span (≥ 2). - trainSessions: number; default: not declared — Sessions in each training span (≥ 2). - variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. ### @insiderfinance/totalfinance/backtest#EnvelopeSignal Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A TA explain envelope used directly as a signal: warmup rides in `diagnostics.warmup`. ```typescript /** A TA explain envelope used directly as a signal: warmup rides in `diagnostics.warmup`. */ export interface EnvelopeSignal { value: ArrayLike; diagnostics: { warmup: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - diagnostics: { warmup: number; }; default: not declared - diagnostics.warmup: number; default: not declared - value: ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#EnvironmentAction Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Hold, or submit orders and cancel open ones. `rationale` is recorded, never read. ```typescript /** Hold, or submit orders and cancel open ones. `rationale` is recorded, never read. */ export type EnvironmentAction = { kind: 'hold'; rationale?: string; } | { kind: 'orders'; orders: readonly EnvironmentOrder[]; cancel?: readonly string[]; rationale?: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cancel?: readonly string[]; default: not declared - kind: ('hold') | ('orders'); default: not declared - orders: readonly EnvironmentOrder[]; default: not declared - rationale?: string; default: not declared ### @insiderfinance/totalfinance/backtest#EnvironmentEpisode Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One maintained scenario: a complete definition, its seed, and the expectations its suite asserts. ```typescript /** One maintained scenario: a complete definition, its seed, and the expectations its suite asserts. */ export interface EnvironmentEpisode { id: EnvironmentEpisodeId; title: string; description: string; definition: TradingEnvironmentDefinition; seed: number; /** Decision instants the definition yields. */ sessions: number; expectations: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - definition: TradingEnvironmentDefinition; default: not declared - definition.accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - definition.accounting.baseCurrency: string; default: not declared - definition.accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - definition.accounting.lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Default `'fifo'`. - definition.accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - definition.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - definition.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - definition.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - definition.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - definition.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - definition.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - definition.execution.costs.borrow.label: string; default: not declared - definition.execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - definition.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - definition.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - definition.execution.costs.commission.commission(input).price: number; default: not declared - definition.execution.costs.commission.commission(input).quantity: number; default: not declared - definition.execution.costs.commission.label: string; default: not declared - definition.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - definition.execution.costs.latency.label: string; default: not declared - definition.execution.costs.latency.sessions: number; default: not declared - definition.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - definition.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - definition.execution.costs.marketImpact.impact(input): { quantity: number; referencePrice: number; averageDailyVolume?: number; }; default: not declared - definition.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - definition.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - definition.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - definition.execution.costs.marketImpact.label: string; default: not declared - definition.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - definition.execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - definition.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - definition.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - definition.execution.costs.slippage.fill(input).quantity: number; default: not declared - definition.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - definition.execution.costs.slippage.fill(input).side: OrderSide; default: not declared - definition.execution.costs.slippage.label: string; default: not declared - definition.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - definition.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - definition.execution.costs.spread.halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - definition.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - definition.execution.costs.spread.halfSpread(input).side: OrderSide; default: not declared - definition.execution.costs.spread.label: string; default: not declared - definition.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - definition.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - definition.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - definition.execution.fill.fill().return.detail?: string; default: not declared - definition.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - definition.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - definition.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - definition.execution.fill.fill().return.pricePerUnit: number; default: not declared - definition.execution.fill.fill().return.quantity: number; default: not declared - definition.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - definition.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - definition.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - definition.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - definition.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - definition.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - definition.execution.fill.label: string; default: not declared - definition.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - definition.execution.fill.version: string; default: not declared - definition.execution.label: string; default: not declared — Echoed in every result's assumptions. - definition.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - definition.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - definition.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - definition.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - definition.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - definition.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - definition.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - definition.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - definition.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - definition.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - definition.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - definition.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - definition.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - definition.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - definition.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - definition.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - definition.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - definition.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - definition.execution.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - definition.execution.timeInForce.default: TimeInForce; default: not declared - definition.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - definition.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - definition.features?: FeatureRecipes; default: not declared - definition.features.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - definition.features.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - definition.features.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - definition.features.realizedVolatility.annualization: number; default: not declared - definition.features.realizedVolatility.lookbacks: readonly number[]; default: not declared - definition.instruments: Readonly>; default: not declared - definition.limits?: EnvironmentLimits; default: not declared - definition.limits.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. - definition.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - definition.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - definition.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - definition.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - definition.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - definition.limits.maximumPositionNotional?: number; default: not declared — Base currency, per instrument: the largest absolute position value an order may project. - definition.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - definition.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - definition.limits.onBreach?: 'terminate' | 'reject-and-continue'; default: not declared — What a post-trade breach does: end the episode (default) or record it and continue. - definition.marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - definition.marketData.bars?: readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - definition.marketData.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared - definition.marketData.coupons?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').CouponRecord[]; default: not declared - definition.marketData.dividends?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DividendRecord[]; default: not declared - definition.marketData.forwardRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - definition.marketData.fundingRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').FundingRateRecord[]; default: not declared - definition.marketData.fxRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - definition.marketData.optionChains?: readonly import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot[]; default: not declared - definition.marketData.orderBooks?: readonly import('@insiderfinance/totalfinance/core').OrderBook[]; default: not declared - definition.marketData.quotes?: readonly import('@insiderfinance/totalfinance/core').Quote[]; default: not declared - definition.marketData.trades?: readonly import('@insiderfinance/totalfinance/core').Trade[]; default: not declared - definition.maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - definition.periodsPerYear?: number; default: not declared - definition.reward?: RewardComposition; default: not declared - definition.reward.benchmark?: { weight: number; instrumentId: string; }; default: not declared — On the step return minus the named instrument's bar return over the step. - definition.reward.benchmark.instrumentId: string; default: not declared - definition.reward.benchmark.weight: number; default: not declared - definition.reward.concentration?: number; default: not declared — On the largest absolute position weight after the step. - definition.reward.cost?: number; default: not declared — On commissions, fees, and slippage ÷ NAV before the step. - definition.reward.drawdown?: number; default: not declared — On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). - definition.reward.goal?: (frame: RewardFrame) => Record; default: not declared — Extra named terms (weight 1 each); a callback, so the definition is not replayable. - definition.reward.goal(frame): RewardFrame; default: not declared - definition.reward.goal(frame).asOf: number; default: not declared - definition.reward.goal(frame).benchmarkReturn: number | null; default: not declared — The benchmark instrument's bar-close return over the step, or null without two closes. - definition.reward.goal(frame).costs: number; default: not declared — Σ commission + fees + slippage adjustment of the step's fills, base currency. - definition.reward.goal(frame).drawdownAfter: number; default: not declared - definition.reward.goal(frame).drawdownBefore: number; default: not declared — 1 − NAV ÷ running peak, before and after the step. - definition.reward.goal(frame).fills: readonly NormalizedFill[]; default: not declared - definition.reward.goal(frame).grossExposure: number; default: not declared - definition.reward.goal(frame).largestPositionWeight: number; default: not declared - definition.reward.goal(frame).netAssetValueAfter: number; default: not declared - definition.reward.goal(frame).netAssetValueBefore: number; default: not declared - definition.reward.goal(frame).positions: readonly SessionPosition[]; default: not declared - definition.reward.goal(frame).step: number; default: not declared - definition.reward.goal(frame).stepReturn: number; default: not declared — Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). - definition.reward.goal(frame).tradedNotional: number; default: not declared — Σ |quantity × price × multiplier| of the step's fills, base currency. - definition.reward.goal(frame).violations: number; default: not declared — Limit breaches plus disallowed orders in the step. - definition.reward.leverage?: number; default: not declared — On gross exposure ÷ NAV after the step. - definition.reward.pnl?: number; default: not declared — On the step's net return, Δ NAV ÷ NAV before the step. - definition.reward.riskViolation?: number; default: not declared — On the count of limit breaches and disallowed orders in the step. - definition.reward.turnover?: number; default: not declared — On traded notional ÷ NAV before the step. - definition.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - definition.window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - definition.window.fromTimestampMs?: number; default: not declared - definition.window.toTimestampMs?: number; default: not declared - description: string; default: not declared - expectations: readonly string[]; default: not declared - id: EnvironmentEpisodeId; default: not declared - seed: number; default: not declared - sessions: number; default: not declared — Decision instants the definition yields. - title: string; default: not declared ### @insiderfinance/totalfinance/backtest#EnvironmentEpisodeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A recorded episode: the definition, the seed, and the actions in order — the artifact spine's input. ```typescript /** A recorded episode: the definition, the seed, and the actions in order — the artifact spine's input. */ export interface EnvironmentEpisodeInput { definition: TradingEnvironmentDefinition; seed?: number; actions: readonly EnvironmentAction[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - actions: readonly EnvironmentAction[]; default: not declared - definition: TradingEnvironmentDefinition; default: not declared - definition.accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - definition.accounting.baseCurrency: string; default: not declared - definition.accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - definition.accounting.lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Default `'fifo'`. - definition.accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - definition.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - definition.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - definition.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - definition.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - definition.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - definition.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - definition.execution.costs.borrow.label: string; default: not declared - definition.execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - definition.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - definition.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - definition.execution.costs.commission.commission(input).price: number; default: not declared - definition.execution.costs.commission.commission(input).quantity: number; default: not declared - definition.execution.costs.commission.label: string; default: not declared - definition.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - definition.execution.costs.latency.label: string; default: not declared - definition.execution.costs.latency.sessions: number; default: not declared - definition.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - definition.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - definition.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - definition.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - definition.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - definition.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - definition.execution.costs.marketImpact.label: string; default: not declared - definition.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - definition.execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - definition.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - definition.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - definition.execution.costs.slippage.fill(input).quantity: number; default: not declared - definition.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - definition.execution.costs.slippage.fill(input).side: OrderSide; default: not declared - definition.execution.costs.slippage.label: string; default: not declared - definition.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - definition.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - definition.execution.costs.spread.halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - definition.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - definition.execution.costs.spread.halfSpread(input).side: OrderSide; default: not declared - definition.execution.costs.spread.label: string; default: not declared - definition.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - definition.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - definition.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - definition.execution.fill.fill().return.detail?: string; default: not declared - definition.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - definition.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - definition.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - definition.execution.fill.fill().return.pricePerUnit: number; default: not declared - definition.execution.fill.fill().return.quantity: number; default: not declared - definition.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - definition.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - definition.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - definition.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - definition.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - definition.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - definition.execution.fill.label: string; default: not declared - definition.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - definition.execution.fill.version: string; default: not declared - definition.execution.label: string; default: not declared — Echoed in every result's assumptions. - definition.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - definition.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - definition.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - definition.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - definition.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - definition.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - definition.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - definition.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - definition.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - definition.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - definition.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - definition.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - definition.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - definition.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - definition.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - definition.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - definition.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - definition.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - definition.execution.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - definition.execution.timeInForce.default: TimeInForce; default: not declared - definition.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - definition.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - definition.features?: FeatureRecipes; default: not declared - definition.features.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - definition.features.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - definition.features.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - definition.features.realizedVolatility.annualization: number; default: not declared - definition.features.realizedVolatility.lookbacks: readonly number[]; default: not declared - definition.instruments: Readonly>; default: not declared - definition.limits?: EnvironmentLimits; default: not declared - definition.limits.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. - definition.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - definition.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - definition.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - definition.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - definition.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - definition.limits.maximumPositionNotional?: number; default: not declared — Base currency, per instrument: the largest absolute position value an order may project. - definition.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - definition.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - definition.limits.onBreach?: 'terminate' | 'reject-and-continue'; default: not declared — What a post-trade breach does: end the episode (default) or record it and continue. - definition.marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - definition.marketData.bars?: readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - definition.marketData.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared - definition.marketData.coupons?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').CouponRecord[]; default: not declared - definition.marketData.dividends?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DividendRecord[]; default: not declared - definition.marketData.forwardRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - definition.marketData.fundingRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').FundingRateRecord[]; default: not declared - definition.marketData.fxRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - definition.marketData.optionChains?: readonly import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot[]; default: not declared - definition.marketData.orderBooks?: readonly import('@insiderfinance/totalfinance/core').OrderBook[]; default: not declared - definition.marketData.quotes?: readonly import('@insiderfinance/totalfinance/core').Quote[]; default: not declared - definition.marketData.trades?: readonly import('@insiderfinance/totalfinance/core').Trade[]; default: not declared - definition.maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - definition.periodsPerYear?: number; default: not declared - definition.reward?: RewardComposition; default: not declared - definition.reward.benchmark?: { instrumentId: string; weight: number; }; default: not declared — On the step return minus the named instrument's bar return over the step. - definition.reward.benchmark.instrumentId: string; default: not declared - definition.reward.benchmark.weight: number; default: not declared - definition.reward.concentration?: number; default: not declared — On the largest absolute position weight after the step. - definition.reward.cost?: number; default: not declared — On commissions, fees, and slippage ÷ NAV before the step. - definition.reward.drawdown?: number; default: not declared — On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). - definition.reward.goal?: (frame: RewardFrame) => Record; default: not declared — Extra named terms (weight 1 each); a callback, so the definition is not replayable. - definition.reward.goal(frame): RewardFrame; default: not declared - definition.reward.goal(frame).asOf: number; default: not declared - definition.reward.goal(frame).benchmarkReturn: number | null; default: not declared — The benchmark instrument's bar-close return over the step, or null without two closes. - definition.reward.goal(frame).costs: number; default: not declared — Σ commission + fees + slippage adjustment of the step's fills, base currency. - definition.reward.goal(frame).drawdownAfter: number; default: not declared - definition.reward.goal(frame).drawdownBefore: number; default: not declared — 1 − NAV ÷ running peak, before and after the step. - definition.reward.goal(frame).fills: readonly NormalizedFill[]; default: not declared - definition.reward.goal(frame).grossExposure: number; default: not declared - definition.reward.goal(frame).largestPositionWeight: number; default: not declared - definition.reward.goal(frame).netAssetValueAfter: number; default: not declared - definition.reward.goal(frame).netAssetValueBefore: number; default: not declared - definition.reward.goal(frame).positions: readonly SessionPosition[]; default: not declared - definition.reward.goal(frame).step: number; default: not declared - definition.reward.goal(frame).stepReturn: number; default: not declared — Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). - definition.reward.goal(frame).tradedNotional: number; default: not declared — Σ |quantity × price × multiplier| of the step's fills, base currency. - definition.reward.goal(frame).violations: number; default: not declared — Limit breaches plus disallowed orders in the step. - definition.reward.leverage?: number; default: not declared — On gross exposure ÷ NAV after the step. - definition.reward.pnl?: number; default: not declared — On the step's net return, Δ NAV ÷ NAV before the step. - definition.reward.riskViolation?: number; default: not declared — On the count of limit breaches and disallowed orders in the step. - definition.reward.turnover?: number; default: not declared — On traded notional ÷ NAV before the step. - definition.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - definition.window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - definition.window.fromTimestampMs?: number; default: not declared - definition.window.toTimestampMs?: number; default: not declared - seed?: number; default: not declared ### @insiderfinance/totalfinance/backtest#EnvironmentEpisodeResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentEpisodeResult { runId: string; engineRunId: string; definitionHash: string; seed: number | null; traceHash: string; steps: EnvironmentEpisodeStep[]; rewards: number[]; rewardTotal: number; terminated: boolean; truncated: boolean; reason: EnvironmentStepResult['reason']; /** The engine's own result over the episode — the same shape `portfolioBacktest` returns. */ result: PortfolioBacktestResult; assumptions: { conventionsVersion: string; /** False with a `goal` callback or a custom adapter — the trace cannot re-issue behavior. */ replayable: boolean; nextObservationLaw: string; executionPolicy: string; maximumSteps: number; instantCount: number; }; diagnostics: Diagnostics & { stepCount: number; fillCount: number; rejectionCount: number; violationCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; executionPolicy: string; instantCount: number; maximumSteps: number; nextObservationLaw: string; replayable: boolean; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.executionPolicy: string; default: not declared - assumptions.instantCount: number; default: not declared - assumptions.maximumSteps: number; default: not declared - assumptions.nextObservationLaw: string; default: not declared - assumptions.replayable: boolean; default: not declared — False with a `goal` callback or a custom adapter — the trace cannot re-issue behavior. - definitionHash: string; default: not declared - diagnostics: Diagnostics & { fillCount: number; rejectionCount: number; stepCount: number; violationCount: number; }; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.fillCount: number; default: not declared - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.rejectionCount: number; default: not declared - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.stepCount: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.violationCount: number; default: not declared - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - engineRunId: string; default: not declared - reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - result: PortfolioBacktestResult; default: not declared — The engine's own result over the episode — the same shape `portfolioBacktest` returns. - result.assumptions: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestAssumptions; default: not declared - result.assumptions.baseCurrency: string; default: not declared - result.assumptions.calendar: string | null; default: not declared - result.assumptions.conventionsVersion: string; default: not declared - result.assumptions.execution: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicyDescription; default: not declared - result.assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - result.assumptions.execution.costs: { commission: string; slippage: string; spread: string | null; marketImpact: string | null; latencySessions: number | null; participation: number | null; borrow: string | null; }; default: not declared - result.assumptions.execution.costs.borrow: string | null; default: not declared - result.assumptions.execution.costs.commission: string; default: not declared - result.assumptions.execution.costs.latencySessions: number | null; default: not declared - result.assumptions.execution.costs.marketImpact: string | null; default: not declared - result.assumptions.execution.costs.participation: number | null; default: not declared - result.assumptions.execution.costs.slippage: string; default: not declared - result.assumptions.execution.costs.spread: string | null; default: not declared - result.assumptions.execution.fill: { label: string; version: string; }; default: not declared - result.assumptions.execution.fill.label: string; default: not declared - result.assumptions.execution.fill.version: string; default: not declared - result.assumptions.execution.label: string; default: not declared - result.assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - result.assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - result.assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - result.assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - result.assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - result.assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - result.assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - result.assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - result.assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - result.assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - result.assumptions.execution.sessions: { halts: number; priceLimits: number; auction: 'ignore' | 'open-close-only' | null; }; default: not declared - result.assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - result.assumptions.execution.sessions.halts: number; default: not declared - result.assumptions.execution.sessions.priceLimits: number; default: not declared - result.assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - result.assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - result.assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - result.assumptions.execution.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - result.assumptions.execution.timeInForce.default: TimeInForce; default: not declared - result.assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - result.assumptions.instruments: { instrumentId: string; kind: import('@insiderfinance/totalfinance/backtest/portfolio').InstrumentKind; adapter: { kind: string; version: string; }; currency: string; }[]; default: not declared - result.assumptions.ledger: { sourceId: string; accountId: string; }; default: not declared - result.assumptions.ledger.accountId: string; default: not declared - result.assumptions.ledger.sourceId: string; default: not declared - result.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - result.assumptions.markConvention: string; default: not declared - result.assumptions.periodsPerYear: number; default: not declared - result.assumptions.replayable: boolean; default: not declared - result.assumptions.seed: number | null; default: not declared - result.assumptions.sessionConvention: string; default: not declared - result.assumptions.settlement: Record; default: not declared - result.assumptions.strategy: { kind: 'model'; modelId: string | null; targets: number; frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; } | { kind: 'callback'; replayable: false; } | { kind: 'external'; replayable: false; }; default: not declared - result.assumptions.strategy.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - result.assumptions.strategy.kind: ('callback') | ('external') | ('model'); default: not declared - result.assumptions.strategy.modelId: string | null; default: not declared - result.assumptions.strategy.replayable: false; default: not declared - result.assumptions.strategy.scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; default: not declared - result.assumptions.strategy.targets: number; default: not declared - result.assumptions.window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - result.assumptions.window.fromTimestampMs: number | null; default: not declared - result.assumptions.window.toTimestampMs: number | null; default: not declared - result.diagnostics: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestDiagnostics; default: not declared - result.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - result.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - result.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - result.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - result.diagnostics.externalFlowCount: number; default: not declared - result.diagnostics.fillCount: number; default: not declared - result.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - result.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - result.diagnostics.lifecycleEventCount: number; default: not declared - result.diagnostics.liquidationCount: number; default: not declared - result.diagnostics.markCount: number; default: not declared - result.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - result.diagnostics.orderCount: number; default: not declared - result.diagnostics.reconciliationResidual: number; default: not declared — The ledger NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - result.diagnostics.rejectionCount: number; default: not declared - result.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - result.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - result.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - result.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - result.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - result.diagnostics.selection.selected.name: string; default: not declared - result.diagnostics.selection.selected.version?: string; default: not declared - result.diagnostics.sessionCount: number; default: not declared - result.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - result.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - result.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - result.events: PortfolioEventEnvelope[]; default: not declared - result.fills: NormalizedFill[]; default: not declared - result.finalValue: number; default: not declared - result.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - result.ledger.baseCurrency: string; default: not declared - result.ledger.events: PortfolioEventEnvelope[]; default: not declared - result.ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - result.ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - result.ledger.portfolioId?: string; default: not declared - result.ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - result.ledger.provenance.asOf?: number; default: not declared - result.ledger.provenance.dataset?: string; default: not declared - result.ledger.provenance.provider?: string; default: not declared - result.ledger.provenance.receivedAt?: number; default: not declared - result.ledger.provenance.requestId?: string; default: not declared - result.ledger.provenance.sourceVersion?: string; default: not declared - result.ledger.provenance.warnings?: QuantWarning[]; default: not declared - result.ledger.schemaVersion: number; default: not declared - result.liquidations: LiquidationRow[]; default: not declared - result.orders: import('@insiderfinance/totalfinance/backtest/portfolio').OrderRecord[]; default: not declared - result.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - result.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - result.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - result.performance.annualizedVolatility: number | null; default: not declared - result.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - result.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - result.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - result.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - result.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - result.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - result.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - result.performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - result.performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - result.performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - result.performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - result.performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - result.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - result.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - result.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - result.performance.maxDrawdown: number; default: not declared - result.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - result.performance.periods: number; default: not declared - result.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - result.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - result.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - result.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - result.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - result.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - result.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - result.pnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult | null; default: not declared - result.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - result.pnl.assumptions.conventionsVersion: string; default: not declared - result.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - result.pnl.assumptions.identity: string; default: not declared — The identity, stated. - result.pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - result.pnl.assumptions.residualTolerance: number; default: not declared - result.pnl.baseCurrency: string; default: not declared - result.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - result.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - result.pnl.components.financing: number; default: not declared - result.pnl.components.foreignExchangePnl: number; default: not declared - result.pnl.components.income: number; default: not declared - result.pnl.components.realizedPnl: number; default: not declared - result.pnl.components.totalPnl: number; default: not declared - result.pnl.components.transactionCosts: number; default: not declared - result.pnl.components.unrealizedPnl: number; default: not declared - result.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - result.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - result.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - result.pnl.diagnostics.warnings: string[]; default: not declared - result.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - result.pnl.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - result.pnl.from.asOf: number; default: not declared - result.pnl.from.netAssetValue: number; default: not declared - result.pnl.from.valuationDate: string; default: not declared - result.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - result.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - result.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - result.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - result.pnl.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - result.pnl.to.asOf: number; default: not declared - result.pnl.to.netAssetValue: number; default: not declared - result.pnl.to.valuationDate: string; default: not declared - result.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - result.rejections: import('@insiderfinance/totalfinance/backtest/portfolio').RejectionRow[]; default: not declared - result.returns: number[]; default: not declared - result.runId: string; default: not declared - result.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult | null; default: not declared - result.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - result.timeline.assumptions.conventionsVersion: string; default: not declared - result.timeline.assumptions.exposureConvention: string; default: not declared - result.timeline.assumptions.indexConvention: string; default: not declared - result.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - result.timeline.assumptions.markInstant: string; default: not declared - result.timeline.baseCurrency: string; default: not declared - result.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - result.timeline.cumulativePnl.financing: number; default: not declared - result.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - result.timeline.cumulativePnl.income: number; default: not declared - result.timeline.cumulativePnl.realizedPnl: number; default: not declared - result.timeline.cumulativePnl.residual: number; default: not declared - result.timeline.cumulativePnl.totalPnl: number; default: not declared - result.timeline.cumulativePnl.transactionCosts: number; default: not declared - result.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - result.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - result.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - result.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - result.timeline.diagnostics.markCount: number; default: not declared - result.timeline.diagnostics.warnings: string[]; default: not declared - result.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - result.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - result.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - result.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - result.valuationMarks: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared - rewardTotal: number; default: not declared - rewards: number[]; default: not declared - runId: string; default: not declared - seed: number | null; default: not declared - steps: EnvironmentEpisodeStep[]; default: not declared - terminated: boolean; default: not declared - traceHash: string; default: not declared - truncated: boolean; default: not declared ### @insiderfinance/totalfinance/backtest#EnvironmentObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Only what was published at or before `asOf` — the no-leak law (Decision 4). ```typescript /** Only what was published at or before `asOf` — the no-leak law (Decision 4). */ export interface EnvironmentObservation { asOf: EpochMs; /** The instant's ordinal among the decision instants. */ index: number; /** Steps since `reset`. */ sequence: number; market: Readonly>; instruments: Readonly>; portfolio: EnvironmentPortfolioView; limits: EnvironmentLimitsView; features: EnvironmentFeatures; freshness: Readonly>; actionMask: ActionMask; previous: EnvironmentStepOutcome | null; provenance: EnvironmentProvenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - actionMask: Readonly>; default: not declared - asOf: number; default: not declared - features: EnvironmentFeatures; default: not declared - features.drawdown: Readonly>; default: not declared - features.lookbackReturns: Readonly>>>; default: not declared - features.realizedVolatility: Readonly>>>; default: not declared - freshness: Readonly>; default: not declared - index: number; default: not declared — The instant's ordinal among the decision instants. - instruments: Readonly>; default: not declared - limits: EnvironmentLimitsView; default: not declared - limits.breaches: LimitBreach[]; default: not declared - limits.utilization: LimitUtilization[]; default: not declared - market: Readonly>; default: not declared - portfolio: EnvironmentPortfolioView; default: not declared - portfolio.buyingPower: number; default: not declared — NAV × the margin policy's buying-power multiplier − gross exposure. - portfolio.cash: readonly { currency: string; amount: number; }[]; default: not declared - portfolio.grossExposure: number; default: not declared — Σ |position market value| in the base currency (positions without a mark are excluded). - portfolio.netAssetValue: number; default: not declared - portfolio.netExposure: number; default: not declared — Σ signed position market value in the base currency. - portfolio.openOrders: readonly OpenOrder[]; default: not declared - portfolio.positions: readonly SessionPosition[]; default: not declared - previous: EnvironmentStepOutcome | null; default: not declared - previous.action: EnvironmentAction; default: not declared - previous.action.cancel?: readonly string[]; default: not declared - previous.action.kind: ('hold') | ('orders'); default: not declared - previous.action.orders: readonly EnvironmentOrder[]; default: not declared - previous.action.rationale?: string; default: not declared - previous.events: PortfolioEventEnvelope[]; default: not declared - previous.fills: NormalizedFill[]; default: not declared - previous.liquidations: LiquidationRow[]; default: not declared - previous.rejections: EnvironmentRejection[]; default: not declared - previous.reward: RewardBreakdown; default: not declared - previous.reward.components: Readonly>; default: not declared - previous.reward.total: number; default: not declared - previous.step: number; default: not declared - previous.warnings: QuantWarning[]; default: not declared - provenance: EnvironmentProvenance; default: not declared - provenance.adapters: { instrumentId: string; kind: string; version: string; }[]; default: not declared - provenance.conventionsVersion: string; default: not declared - provenance.definitionHash: string; default: not declared - provenance.engineRunId: string; default: not declared — The portfolio engine run this episode drives — the prefix of its event, fill, and source ids. - provenance.executionPolicy: string; default: not declared - provenance.runId: string; default: not declared - provenance.seed: number | null; default: not declared - sequence: number; default: not declared — Steps since `reset`. ### @insiderfinance/totalfinance/backtest#EnvironmentStepResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentStepResult { observation: EnvironmentObservation; fills: NormalizedFill[]; rejections: EnvironmentRejection[]; liquidations: LiquidationRow[]; events: PortfolioEventEnvelope[]; warnings: QuantWarning[]; reward: RewardBreakdown; /** An economic or policy terminal state was reached. */ terminated: boolean; /** The data boundary or the step bound was reached. */ truncated: boolean; /** Why the episode ended, when it did. */ reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; identity: EnvironmentIdentity; diagnostics: { acceptedCount: number; rejectedCount: number; cancelledCount: number; /** Orders carried into the next instant because the market did not resolve them. */ carriedCount: number; openOrderCount: number; rationaleTruncated: boolean; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - diagnostics: { acceptedCount: number; rejectedCount: number; cancelledCount: number; carriedCount: number; openOrderCount: number; rationaleTruncated: boolean; }; default: not declared - diagnostics.acceptedCount: number; default: not declared - diagnostics.cancelledCount: number; default: not declared - diagnostics.carriedCount: number; default: not declared — Orders carried into the next instant because the market did not resolve them. - diagnostics.openOrderCount: number; default: not declared - diagnostics.rationaleTruncated: boolean; default: not declared - diagnostics.rejectedCount: number; default: not declared - events: PortfolioEventEnvelope[]; default: not declared - fills: NormalizedFill[]; default: not declared - identity: EnvironmentIdentity; default: not declared - identity.runId: string; default: not declared - identity.step: number; default: not declared - identity.traceHash: string; default: not declared — Chains the previous trace hash with this step's canonical action; identical policies leave identical traces. - liquidations: LiquidationRow[]; default: not declared - observation: EnvironmentObservation; default: not declared - observation.actionMask: Readonly>; default: not declared - observation.asOf: number; default: not declared - observation.features: EnvironmentFeatures; default: not declared - observation.features.drawdown: Readonly>; default: not declared - observation.features.lookbackReturns: Readonly>>>; default: not declared - observation.features.realizedVolatility: Readonly>>>; default: not declared - observation.freshness: Readonly>; default: not declared - observation.index: number; default: not declared — The instant's ordinal among the decision instants. - observation.instruments: Readonly>; default: not declared - observation.limits: EnvironmentLimitsView; default: not declared - observation.limits.breaches: LimitBreach[]; default: not declared - observation.limits.utilization: LimitUtilization[]; default: not declared - observation.market: Readonly>; default: not declared - observation.portfolio: EnvironmentPortfolioView; default: not declared - observation.portfolio.buyingPower: number; default: not declared — NAV × the margin policy's buying-power multiplier − gross exposure. - observation.portfolio.cash: readonly { currency: string; amount: number; }[]; default: not declared - observation.portfolio.grossExposure: number; default: not declared — Σ |position market value| in the base currency (positions without a mark are excluded). - observation.portfolio.netAssetValue: number; default: not declared - observation.portfolio.netExposure: number; default: not declared — Σ signed position market value in the base currency. - observation.portfolio.openOrders: readonly OpenOrder[]; default: not declared - observation.portfolio.positions: readonly SessionPosition[]; default: not declared - observation.previous: EnvironmentStepOutcome | null; default: not declared - observation.previous.action: EnvironmentAction; default: not declared - observation.previous.action.cancel?: readonly string[]; default: not declared - observation.previous.action.kind: ('hold') | ('orders'); default: not declared - observation.previous.action.orders: readonly EnvironmentOrder[]; default: not declared - observation.previous.action.rationale?: string; default: not declared - observation.previous.events: PortfolioEventEnvelope[]; default: not declared - observation.previous.fills: NormalizedFill[]; default: not declared - observation.previous.liquidations: LiquidationRow[]; default: not declared - observation.previous.rejections: EnvironmentRejection[]; default: not declared - observation.previous.reward: RewardBreakdown; default: not declared - observation.previous.reward.components: Readonly>; default: not declared - observation.previous.reward.total: number; default: not declared - observation.previous.step: number; default: not declared - observation.previous.warnings: QuantWarning[]; default: not declared - observation.provenance: EnvironmentProvenance; default: not declared - observation.provenance.adapters: { instrumentId: string; kind: string; version: string; }[]; default: not declared - observation.provenance.conventionsVersion: string; default: not declared - observation.provenance.definitionHash: string; default: not declared - observation.provenance.engineRunId: string; default: not declared — The portfolio engine run this episode drives — the prefix of its event, fill, and source ids. - observation.provenance.executionPolicy: string; default: not declared - observation.provenance.runId: string; default: not declared - observation.provenance.seed: number | null; default: not declared - observation.sequence: number; default: not declared — Steps since `reset`. - reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared — Why the episode ended, when it did. - rejections: EnvironmentRejection[]; default: not declared - reward: RewardBreakdown; default: not declared - reward.components: Readonly>; default: not declared - reward.total: number; default: not declared - terminated: boolean; default: not declared — An economic or policy terminal state was reached. - truncated: boolean; default: not declared — The data boundary or the step bound was reached. - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/backtest#EquityPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One point on the equity curve: a timestamp paired unambiguously with the portfolio value at that instant (WS2.8). `points[0]` stamps the opening capital at the FIRST bar's timestamp; each later point is the post-bar equity at that bar's timestamp — one series, no `equityCurve`/`timestamps` off-by-one to reconcile. ```typescript /** * One point on the equity curve: a timestamp paired unambiguously with the portfolio value at that * instant (WS2.8). `points[0]` stamps the opening capital at the FIRST bar's timestamp; each later * point is the post-bar equity at that bar's timestamp — one series, no `equityCurve`/`timestamps` * off-by-one to reconcile. */ export interface EquityPoint { timestampMs: EpochMs; equity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - equity: number; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest#EventDrivenOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EventDrivenOptions { /** Bars for all symbols (each symbol ascending; the engine sorts the merged stream by `ts`). */ data: Bar[]; /** A configured broker, or a config to construct one. */ broker: SimulatedBroker | BrokerConfig; /** The strategy: registers handlers + indicators against the context. */ strategy: (context: StrategyContext) => void; /** Corporate actions keyed `"@"`. */ corporateActions?: Map; /** Bars per year for annualized metrics (default 252). */ periodsPerYear?: number; /** Annualized risk-free rate (default 0). */ riskFreeRate?: number; /** * Whether the symbol universe is `point-in-time` (delisted names included) or `current` * (survivorship-biased). Recorded in diagnostics; default `point-in-time`. */ universe?: 'point-in-time' | 'current'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - broker: SimulatedBroker | BrokerConfig; default: not declared — A configured broker, or a config to construct one. - broker.assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - broker.assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - broker.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - broker.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - broker.borrow.label: string; default: not declared - broker.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - broker.cancel(id): string; default: not declared - broker.cash: number; default: not declared — Opening cash. - broker.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - broker.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - broker.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - broker.commission.commission(input).price: number; default: not declared - broker.commission.commission(input).quantity: number; default: not declared - broker.commission.label: string; default: not declared - broker.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - broker.equity(marks): Map; default: not declared - broker.exerciseOption: (input: import('@insiderfinance/totalfinance/backtest').ExerciseOptionInput) => import('@insiderfinance/totalfinance/backtest').OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - broker.exerciseOption().return.action: 'expired' | 'exercised' | 'assigned'; default: not declared — `exercised` (long, ITM), `assigned` (short, ITM), or `expired` (out-of-the-money). - broker.exerciseOption().return.cashFlow: number; default: not declared — Net cash effect of the settlement. - broker.exerciseOption().return.contracts: number; default: not declared — Signed contracts settled (negative = short). - broker.exerciseOption().return.early?: boolean; default: not declared — `true` when this was an EARLY (pre-expiry) American exercise/assignment (WS7.4). - broker.exerciseOption().return.intrinsic: number; default: not declared — Intrinsic value per underlier share at settlement. - broker.exerciseOption().return.multiplier: number; default: not declared - broker.exerciseOption().return.reason?: 'dividend' | 'deep-itm' | 'manual'; default: not declared — Why an early event fired: `'dividend'`, `'deep-itm'`, or `'manual'` (absent for expiry). - broker.exerciseOption().return.settlement: import('@insiderfinance/totalfinance/backtest').OptionSettlementStyle; default: not declared - broker.exerciseOption().return.shares: number; default: not declared — Signed underlier shares delivered/received on physical exercise/assignment (0 otherwise). - broker.exerciseOption().return.strike: number; default: not declared - broker.exerciseOption().return.symbol: string; default: not declared - broker.exerciseOption().return.timestampMs: number; default: not declared - broker.exerciseOption().return.type: 'call' | 'put'; default: not declared - broker.exerciseOption().return.underlierPrice: number; default: not declared — Underlier settlement price. - broker.exerciseOption().return.underlying: string; default: not declared - broker.exerciseOption(input): import('@insiderfinance/totalfinance/backtest').ExerciseOptionInput; default: not declared - broker.exerciseOption(input).quantity: number; default: not declared - broker.exerciseOption(input).symbol: string; default: not declared - broker.exerciseOption(input).timestampMs: number; default: not declared - broker.exerciseOption(input).underlierMarks?: Map; default: not declared - broker.maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - broker.maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - broker.noShort?: boolean; default: not declared — Disallow short positions (default `false`). - broker.orders: readonly import('@insiderfinance/totalfinance/backtest').Order[]; default: not declared — All orders ever submitted (live view, readonly). - broker.periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - broker.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - broker.policies().return.assignment: string; default: not declared - broker.policies().return.cost: string; default: not declared - broker.policies().return.margin: string; default: not declared - broker.policies().return.oco: string; default: not declared - broker.policies().return.slippage: string; default: not declared - broker.position: (symbol: SymbolId) => Position; default: not declared - broker.position().return.averagePrice: number; default: not declared — Average entry price of the current position. - broker.position().return.quantity: number; default: not declared — Signed quantity (negative = short). - broker.position().return.symbol: string; default: not declared - broker.position(symbol): string; default: not declared - broker.positions: Map; default: not declared - broker.processBar: (bar: Bar, action?: CorporateAction) => import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - broker.processBar(action)?: CorporateAction | undefined; default: not declared - broker.processBar(action).dividend?: number; default: not declared — Cash dividend per share (long receives, short pays). - broker.processBar(action).split?: number; default: not declared — Split ratio `R` (`2` = 2-for-1: quantities ×R, prices ÷R). - broker.processBar(bar): Bar; default: not declared - broker.processBar(bar).adjusted?: boolean; default: not declared - broker.processBar(bar).close: number; default: not declared - broker.processBar(bar).high: number; default: not declared - broker.processBar(bar).low: number; default: not declared - broker.processBar(bar).open: number; default: not declared - broker.processBar(bar).symbol: string; default: not declared - broker.processBar(bar).timestampMs: number; default: not declared - broker.processBar(bar).volume?: number; default: not declared - broker.processBar(bar).vwap?: number; default: not declared - broker.registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - broker.registerOption(specification): OptionContractSpecification; default: not declared - broker.registerOption(specification).expiresAt: number; default: not declared — Expiry instant, epoch ms (B6: the same name every resolved contract carries). - broker.registerOption(specification).multiplier?: number; default: not declared — Contract multiplier (underlier shares per contract). Default 100. - broker.registerOption(specification).settlement?: import('@insiderfinance/totalfinance/backtest').OptionSettlementStyle; default: not declared — `physical` (deliver/receive the underlier at strike, default) or `cash` (pay/receive intrinsic). - broker.registerOption(specification).strike: number; default: not declared - broker.registerOption(specification).style?: 'european' | 'american'; default: not declared — Exercise style (default `american`). Only `american` options are eligible for the EARLY exercise/assignment model (WS7.4); `european` options settle only at expiry. The early model is itself opt-in via the broker's `assignment: 'model'` policy, so this field is inert by default. - broker.registerOption(specification).type: 'call' | 'put'; default: not declared - broker.registerOption(specification).underlying: string; default: not declared — The underlying symbol the option exercises into. - broker.registerOption(symbol): string; default: not declared - broker.riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - broker.settleExpiries: (asOfTimestampMs: EpochMs, underlierMarks?: Map) => import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - broker.settleExpiries(asOfTimestampMs): number; default: not declared - broker.settleExpiries(underlierMarks)?: Map | undefined; default: not declared - broker.settlements: readonly import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - broker.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - broker.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - broker.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - broker.slippage.fill(input).quantity: number; default: not declared - broker.slippage.fill(input).referencePrice: number; default: not declared - broker.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - broker.slippage.label: string; default: not declared - broker.submit: (request: import('@insiderfinance/totalfinance/backtest').OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - broker.submit(request): import('@insiderfinance/totalfinance/backtest').OrderRequest; default: not declared - broker.submit(request).limitPrice?: number; default: not declared — Limit price (for `limit` / `stop-limit`). - broker.submit(request).notional?: number; default: not declared — Cash notional to trade; the broker sizes shares at the fill price. Mutually exclusive with `quantity`. - broker.submit(request).ocoGroup?: string; default: not declared — OCO group: filling or cancelling any member cancels the rest. - broker.submit(request).quantity?: number; default: not declared — Share quantity to trade (> 0). Mutually exclusive with `notional`. - broker.submit(request).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - broker.submit(request).stopLoss?: number; default: not declared — Bracket: a stop-loss **stop** price, attached as an OCO child once the parent fills. - broker.submit(request).stopPrice?: number; default: not declared — Stop trigger price (for `stop` / `stop-limit`). - broker.submit(request).symbol: string; default: not declared - broker.submit(request).takeProfit?: number; default: not declared — Bracket: a take-profit **limit** price, attached as an OCO child once the parent fills. - broker.submit(request).timeInForce?: TimeInForce; default: not declared — Time in force (default `gtc`). - broker.submit(request).type?: OrderType; default: not declared — Order type (default `market`). - broker.trades: readonly import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — All fills (live view, readonly). - broker.warnings: readonly import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - corporateActions?: Map; default: not declared — Corporate actions keyed `"@"`. - data: Bar[]; default: not declared — Bars for all symbols (each symbol ascending; the engine sorts the merged stream by `ts`). - periodsPerYear?: number; default: not declared — Bars per year for annualized metrics (default 252). - riskFreeRate?: number; default: not declared — Annualized risk-free rate (default 0). - strategy: (context: StrategyContext) => void; default: not declared — The strategy: registers handlers + indicators against the context. - strategy(context): StrategyContext; default: not declared - strategy(context).bar: Bar; default: not declared — The bar currently being handled. - strategy(context).buy: (symbol: SymbolId, options?: TradeOptions) => string; default: not declared — Buy (target long via `percent`, or add via `quantity`/`value`). Returns the order id. - strategy(context).cancel: (id: string) => void; default: not declared — Cancel a working order. - strategy(context).cash: number; default: not declared — Current cash. - strategy(context).close: (symbol: SymbolId) => void; default: not declared — Flatten the position in `symbol` with a market order. - strategy(context).equity: number; default: not declared — Current portfolio equity (cash + marked positions). - strategy(context).exercise: (symbol: SymbolId, quantity: number) => void; default: not declared — Manually exercise `quantity` contracts of a LONG American option early (WS7.4). Requires the broker's `assignment: 'model'` policy; settles at the current underlier mark. - strategy(context).indicator: (symbol: SymbolId, stream: Indicator, field: BarField | ((bar: Bar) => In)) => IndicatorHandle; default: not declared — Bind a streaming indicator to a symbol; returns a handle refreshed before each handler call. - strategy(context).onBar: (symbol: SymbolId, handler: () => void) => void; default: not declared — Register a handler that runs on every bar of `symbol`. Throws if `symbol` already has a handler — one handler per symbol, so behaviour never silently depends on registration order (WS2.8). - strategy(context).onBars: (handler: () => void) => void; default: not declared — Register a portfolio-level handler that fires ONCE per timestamp, after every symbol's bar handler for that timestamp has run — the right hook for cross-sectional logic (ranking, rebalancing) that must not depend on the input bar order (WS2.8). - strategy(context).position: (symbol: SymbolId) => Position; default: not declared — Current position in `symbol`. - strategy(context).registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol (underlying/type/strike/expiry) so it's marked and settled at expiry. - strategy(context).sell: (symbol: SymbolId, options?: TradeOptions) => string; default: not declared — Sell / short. Returns the order id. - universe?: 'point-in-time' | 'current'; default: not declared — Whether the symbol universe is `point-in-time` (delisted names included) or `current` (survivorship-biased). Recorded in diagnostics; default `point-in-time`. ### @insiderfinance/totalfinance/backtest#ExerciseOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExerciseOptionInput { symbol: SymbolId; quantity: number; timestampMs: EpochMs; underlierMarks?: Map; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - quantity: number; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared - underlierMarks?: Map; default: not declared ### @insiderfinance/totalfinance/backtest#GridVariation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One axis of the grid: a dotted path into the request and the values it takes. ```typescript /** One axis of the grid: a dotted path into the request and the values it takes. */ export interface GridVariation { /** A dotted path under `signal`, `rebalanceSchedule`, `portfolioConstruction`, `execution`, `transactionCostModel`, `initialCapital`, or `riskFreeRate`. */ path: string; /** The declarative values the path takes, in order; functions are refused (a grid is replayable). */ values: readonly unknown[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - path: string; default: not declared — A dotted path under `signal`, `rebalanceSchedule`, `portfolioConstruction`, `execution`, `transactionCostModel`, `initialCapital`, or `riskFreeRate`. - values: readonly unknown[]; default: not declared — The declarative values the path takes, in order; functions are refused (a grid is replayable). ### @insiderfinance/totalfinance/backtest#GridVariationRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GridVariationRow { index: number; /** Path → the value applied at this point of the product. */ parameters: Record; /** The child run's content-addressed identity (`CrossSectionalBacktestResult.runId`). */ runId: string; metrics: GridSummaryMetrics; /** Per-observation Sharpe of the run's returns — the trial Sharpe the deflation reads. */ trialSharpe: number; /** True when the run's returns could not carry a Sharpe (fewer than three periods or zero variance); the trial Sharpe is then 0 by convention. */ trialSharpeDegenerate: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - index: number; default: not declared - metrics: GridSummaryMetrics; default: not declared - metrics.annualizedReturn: number | null; default: not declared - metrics.annualizedVolatility: number | null; default: not declared - metrics.calmar: number | null; default: not declared - metrics.cappedGoalCount: number; default: not declared - metrics.fillCount: number; default: not declared - metrics.finalValue: number; default: not declared - metrics.hitRate: number | null; default: not declared - metrics.maxDrawdown: number; default: not declared - metrics.meanTurnover: number | null; default: not declared — Mean allocator turnover per rebalance (fraction of NAV). - metrics.periods: number; default: not declared - metrics.rebalanceCount: number; default: not declared - metrics.sharpe: number | null; default: not declared - metrics.sortino: number | null; default: not declared - metrics.totalCosts: number; default: not declared — Costs charged over the run, in base currency. - metrics.totalReturn: number | null; default: not declared - metrics.tradeCount: number; default: not declared - metrics.violatedGoalCount: number; default: not declared - metrics.warningCount: number; default: not declared - parameters: Record; default: not declared — Path → the value applied at this point of the product. - runId: string; default: not declared — The child run's content-addressed identity (`CrossSectionalBacktestResult.runId`). - trialSharpe: number; default: not declared — Per-observation Sharpe of the run's returns — the trial Sharpe the deflation reads. - trialSharpeDegenerate: boolean; default: not declared — True when the run's returns could not carry a Sharpe (fewer than three periods or zero variance); the trial Sharpe is then 0 by convention. ### @insiderfinance/totalfinance/backtest#HoldingReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Result // --------------------------------------------------------------------------------------------------- export type HoldingReason = 'selected' | 'retained-in-buffer' | 'exited' | 'deselected' | 'delisted' | 'removed'; ``` ### @insiderfinance/totalfinance/backtest#HoldingRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HoldingRow { rebalanceIndex: number; instrumentId: string; side: 'long' | 'short'; weight: number; quantity: number; score: number | null; rank: number | null; reason: HoldingReason; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - quantity: number; default: not declared - rank: number | null; default: not declared - reason: HoldingReason; default: not declared - rebalanceIndex: number; default: not declared - score: number | null; default: not declared - side: 'long' | 'short'; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/backtest#ImplementationRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The implementation-risk diagnostics attached to every {@link BacktestResult} (spec §16.3): core {@link Diagnostics} (look-ahead / leakage checks and data-alignment warnings — empty when clean) plus the benchmark fixture version the engine was validated against. The echoed run policies live on the result's `assumptions` slot (dx §2.5) — diagnostics say how trustworthy the run is, assumptions say what was assumed. ```typescript /** * The implementation-risk diagnostics attached to every {@link BacktestResult} (spec §16.3): core * {@link Diagnostics} (look-ahead / leakage checks and data-alignment warnings — empty when clean) * plus the benchmark fixture version the engine was validated against. The echoed run policies live * on the result's `assumptions` slot (dx §2.5) — diagnostics say how trustworthy the run is, * assumptions say what was assumed. */ export interface ImplementationRisk extends Diagnostics { /** The benchmark fixture version this engine was validated against. */ benchmarkFixtureVersion: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - benchmarkFixtureVersion: string; default: not declared — The benchmark fixture version this engine was validated against. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/backtest#Indicator Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A minimal streaming indicator (structurally compatible with `@insiderfinance/totalfinance/technical-analysis` streams). ```typescript /** A minimal streaming indicator (structurally compatible with `@insiderfinance/totalfinance/technical-analysis` streams). */ export interface Indicator { next(input: In): Out | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - next: (input: In) => Out | null; default: not declared - next(input): In; default: not declared ### @insiderfinance/totalfinance/backtest#IndicatorHandle Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A live indicator value the engine refreshes each bar, exposing the current and previous reading. ```typescript /** A live indicator value the engine refreshes each bar, exposing the current and previous reading. */ export interface IndicatorHandle { value: Out | null; previous: Out | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - previous: Out | null; default: not declared - value: Out | null; default: not declared ### @insiderfinance/totalfinance/backtest#InstrumentAdapter Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An instrument adapter: how the instrument marks, which lifecycle facts it emits (as FC7 event PAYLOADS — the engine envelopes them with ids, the source, and the instant), and how its fills settle. Pure and deterministic; `assertInstrumentAdapterConformance` proves it. ```typescript /** * An instrument adapter: how the instrument marks, which lifecycle facts it emits (as FC7 event * PAYLOADS — the engine envelopes them with ids, the source, and the instant), and how its fills * settle. Pure and deterministic; `assertInstrumentAdapterConformance` proves it. */ export interface InstrumentAdapter { readonly kind: string; readonly version: string; mark(input: MarkInput): MarkOutcome; lifecycle(input: LifecycleInput): PortfolioEvent[]; fillTerms(specification: InstrumentSpecification): FillTerms; /** Accrued interest per unit at the instant (bonds); omitted = none. */ accrued?(input: { specification: InstrumentSpecification; asOf: EpochMs; }): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrued?: (input: { specification: InstrumentSpecification; asOf: EpochMs; }) => number; default: not declared — Accrued interest per unit at the instant (bonds); omitted = none. - accrued(input): { asOf: EpochMs; specification: InstrumentSpecification; }; default: not declared - accrued(input).asOf: number; default: not declared - accrued(input).specification: InstrumentSpecification; default: not declared - fillTerms: (specification: InstrumentSpecification) => FillTerms; default: not declared - fillTerms().return.contract?: DerivativeContractTerms; default: not declared - fillTerms().return.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - fillTerms().return.settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared - fillTerms(specification): InstrumentSpecification; default: not declared - fillTerms(specification).adapter?: InstrumentAdapter; default: not declared — REQUIRED for `custom`; refused for a built-in kind. - fillTerms(specification).assetClass?: AssetClass; default: not declared — Default: the kind. - fillTerms(specification).classification?: InstrumentClassification; default: not declared - fillTerms(specification).contract?: DerivativeContractTerms; default: not declared — REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. - fillTerms(specification).contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. - fillTerms(specification).coupon?: CouponTerms; default: not declared — `bond`: the coupon terms. - fillTerms(specification).currency: string; default: not declared — The trading and mark currency. - fillTerms(specification).forward?: ForwardTerms; default: not declared — `fx-forward`: the contract. - fillTerms(specification).kind: InstrumentKind; default: not declared - fillTerms(specification).roll?: RollTerms; default: not declared — `future`: the declared roll. - kind: string; default: not declared - lifecycle: (input: LifecycleInput) => PortfolioEvent[]; default: not declared - lifecycle(input): LifecycleInput; default: not declared - lifecycle(input).asOf: number; default: not declared - lifecycle(input).facts: LifecycleFacts; default: not declared - lifecycle(input).held: { contractMultiplier: number; quantity: number; } | null; default: not declared — The held position, or `null` when flat. - lifecycle(input).held.contractMultiplier: number; default: not declared - lifecycle(input).held.quantity: number; default: not declared - lifecycle(input).instrumentId: string; default: not declared - lifecycle(input).last: boolean; default: not declared — True when this instant is the last one the run sees. - lifecycle(input).mark: { pricePerUnit: number; source: string; } | null; default: not declared — The instrument's mark at the instant, when one exists. - lifecycle(input).mark.pricePerUnit: number; default: not declared - lifecycle(input).mark.source: string; default: not declared - lifecycle(input).previousAsOf: number | null; default: not declared - lifecycle(input).specification: InstrumentSpecification; default: not declared - lifecycle(input).underlyingMark: number | null; default: not declared — The underlying's mark at the instant (options, futures, perpetuals), when one exists. - mark: (input: MarkInput) => MarkOutcome; default: not declared - mark().return.pricePerUnit: number; default: not declared - mark().return.source: string; default: not declared - mark().return.unavailable: MissingMarkCause; default: not declared - mark(input): MarkInput; default: not declared - mark(input).asOf: number; default: not declared - mark(input).instrumentId: string; default: not declared - mark(input).latest: LatestObservations; default: not declared - mark(input).previous: { pricePerUnit: number; source: string; } | null; default: not declared — The previous mark, when one exists. - mark(input).previous.pricePerUnit: number; default: not declared - mark(input).previous.source: string; default: not declared - mark(input).specification: InstrumentSpecification; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/backtest#InstrumentSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface InstrumentSpecification { kind: InstrumentKind; /** The trading and mark currency. */ currency: string; /** Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. */ contractMultiplier?: number; /** REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. */ contract?: DerivativeContractTerms; /** Default: the kind. */ assetClass?: AssetClass; classification?: InstrumentClassification; /** REQUIRED for `custom`; refused for a built-in kind. */ adapter?: InstrumentAdapter; /** `future`: the declared roll. */ roll?: RollTerms; /** `bond`: the coupon terms. */ coupon?: CouponTerms; /** `fx-forward`: the contract. */ forward?: ForwardTerms; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adapter?: InstrumentAdapter; default: not declared — REQUIRED for `custom`; refused for a built-in kind. - adapter.accrued?: (input: { specification: InstrumentSpecification; asOf: EpochMs; }) => number; default: not declared — Accrued interest per unit at the instant (bonds); omitted = none. - adapter.accrued(input): { specification: InstrumentSpecification; asOf: EpochMs; }; default: not declared - adapter.accrued(input).asOf: number; default: not declared - adapter.accrued(input).specification: InstrumentSpecification; default: not declared - adapter.fillTerms: (specification: InstrumentSpecification) => FillTerms; default: not declared - adapter.fillTerms().return.contract?: DerivativeContractTerms; default: not declared - adapter.fillTerms().return.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - adapter.fillTerms().return.settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared - adapter.fillTerms(specification): InstrumentSpecification; default: not declared - adapter.kind: string; default: not declared - adapter.lifecycle: (input: LifecycleInput) => PortfolioEvent[]; default: not declared - adapter.lifecycle(input): LifecycleInput; default: not declared - adapter.lifecycle(input).asOf: number; default: not declared - adapter.lifecycle(input).facts: LifecycleFacts; default: not declared - adapter.lifecycle(input).held: { quantity: number; contractMultiplier: number; } | null; default: not declared — The held position, or `null` when flat. - adapter.lifecycle(input).held.contractMultiplier: number; default: not declared - adapter.lifecycle(input).held.quantity: number; default: not declared - adapter.lifecycle(input).instrumentId: string; default: not declared - adapter.lifecycle(input).last: boolean; default: not declared — True when this instant is the last one the run sees. - adapter.lifecycle(input).mark: { pricePerUnit: number; source: string; } | null; default: not declared — The instrument's mark at the instant, when one exists. - adapter.lifecycle(input).mark.pricePerUnit: number; default: not declared - adapter.lifecycle(input).mark.source: string; default: not declared - adapter.lifecycle(input).previousAsOf: number | null; default: not declared - adapter.lifecycle(input).specification: InstrumentSpecification; default: not declared - adapter.lifecycle(input).underlyingMark: number | null; default: not declared — The underlying's mark at the instant (options, futures, perpetuals), when one exists. - adapter.mark: (input: MarkInput) => MarkOutcome; default: not declared - adapter.mark().return.pricePerUnit: number; default: not declared - adapter.mark().return.source: string; default: not declared - adapter.mark().return.unavailable: MissingMarkCause; default: not declared - adapter.mark(input): MarkInput; default: not declared - adapter.mark(input).asOf: number; default: not declared - adapter.mark(input).instrumentId: string; default: not declared - adapter.mark(input).latest: LatestObservations; default: not declared - adapter.mark(input).previous: { pricePerUnit: number; source: string; } | null; default: not declared — The previous mark, when one exists. - adapter.mark(input).previous.pricePerUnit: number; default: not declared - adapter.mark(input).previous.source: string; default: not declared - adapter.mark(input).specification: InstrumentSpecification; default: not declared - adapter.version: string; default: not declared - assetClass?: AssetClass; default: not declared — Default: the kind. - classification?: InstrumentClassification; default: not declared - classification.assetClass?: string; default: not declared - classification.strategy?: string; default: not declared - classification.tags?: string[]; default: not declared — Overlapping by nature — the `tag` grouping does not partition the total. - classification.underlying?: string; default: not declared - contract?: DerivativeContractTerms; default: not declared — REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. - coupon?: CouponTerms; default: not declared — `bond`: the coupon terms. - coupon.annualRate: number; default: not declared — Annual coupon rate, decimal (0.05 = 5%). - coupon.dayCount?: 'ACT/365F' | '30/360'; default: not declared — Accrual day count (default `'ACT/365F'`). - coupon.faceValuePerUnit?: number; default: not declared — Face value per unit of quantity (default 1). - coupon.issueDate: string; default: not declared — Dated date / first accrual date, `YYYY-MM-DD`. - coupon.maturityDate: string; default: not declared — Maturity, `YYYY-MM-DD`; principal redeems at the face value on this date. - coupon.paymentsPerYear: number; default: not declared — Coupons per year (1, 2, 4, 12). - currency: string; default: not declared — The trading and mark currency. - forward?: ForwardTerms; default: not declared — `fx-forward`: the contract. - forward.baseCurrency: string; default: not declared — The currency bought forward (one unit of quantity = one unit of this currency). - forward.contractRate: number; default: not declared - forward.maturityTimestampMs: number; default: not declared - forward.quoteCurrency: string; default: not declared — The currency paid, at `contractRate` per base unit. - kind: InstrumentKind; default: not declared - roll?: RollTerms; default: not declared — `future`: the declared roll. - roll.sessionsBeforeExpiry: number; default: not declared - roll.toInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/backtest#MonteCarloResampleReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link monteCarloResample} as a report: the resample stats + `assumptions` + `diagnostics`. ```typescript /** {@link monteCarloResample} as a report: the resample stats + `assumptions` + `diagnostics`. */ export interface MonteCarloResampleReport extends MonteCarloResampleResult { assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - confidenceInterval95: [number, number]; default: not declared — 95% percentile interval of the total return across resamples. - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - iterations: number; default: not declared - meanTotalReturn: number; default: not declared — Mean bootstrapped total return. - seed: number; default: not declared - standardDeviation: number; default: not declared ### @insiderfinance/totalfinance/backtest#MonteCarloResampleResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonteCarloResampleResult { iterations: number; seed: number; /** Mean bootstrapped total return. */ meanTotalReturn: number; standardDeviation: number; /** 95% percentile interval of the total return across resamples. */ confidenceInterval95: [ number, number ]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidenceInterval95: [number, number]; default: not declared — 95% percentile interval of the total return across resamples. - iterations: number; default: not declared - meanTotalReturn: number; default: not declared — Mean bootstrapped total return. - seed: number; default: not declared - standardDeviation: number; default: not declared ### @insiderfinance/totalfinance/backtest#Neutrality Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type Neutrality = 'none' | 'dollar' | 'sector' | 'beta' | 'factor'; ``` ### @insiderfinance/totalfinance/backtest#OptionContractSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Registration of an option symbol so the broker can mark and settle it (spec §16.2). ```typescript /** Registration of an option symbol so the broker can mark and settle it (spec §16.2). */ export interface OptionContractSpecification { /** The underlying symbol the option exercises into. */ underlying: SymbolId; type: 'call' | 'put'; strike: number; /** Expiry instant, epoch ms (B6: the same name every resolved contract carries). */ expiresAt: EpochMs; /** Contract multiplier (underlier shares per contract). Default 100. */ multiplier?: number; /** `physical` (deliver/receive the underlier at strike, default) or `cash` (pay/receive intrinsic). */ settlement?: OptionSettlementStyle; /** * Exercise style (default `american`). Only `american` options are eligible for the EARLY * exercise/assignment model (WS7.4); `european` options settle only at expiry. The early model is * itself opt-in via the broker's `assignment: 'model'` policy, so this field is inert by default. */ style?: 'american' | 'european'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiresAt: number; default: not declared — Expiry instant, epoch ms (B6: the same name every resolved contract carries). - multiplier?: number; default: not declared — Contract multiplier (underlier shares per contract). Default 100. - settlement?: OptionSettlementStyle; default: not declared — `physical` (deliver/receive the underlier at strike, default) or `cash` (pay/receive intrinsic). - strike: number; default: not declared - style?: 'european' | 'american'; default: not declared — Exercise style (default `american`). Only `american` options are eligible for the EARLY exercise/assignment model (WS7.4); `european` options settle only at expiry. The early model is itself opt-in via the broker's `assignment: 'model'` policy, so this field is inert by default. - type: 'call' | 'put'; default: not declared - underlying: string; default: not declared — The underlying symbol the option exercises into. ### @insiderfinance/totalfinance/backtest#OptionSettlement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The record of an option position settled at expiry. ```typescript /** The record of an option position settled at expiry. */ export interface OptionSettlement { symbol: SymbolId; underlying: SymbolId; timestampMs: EpochMs; type: 'call' | 'put'; strike: number; multiplier: number; /** Signed contracts settled (negative = short). */ contracts: number; /** Underlier settlement price. */ underlierPrice: number; /** Intrinsic value per underlier share at settlement. */ intrinsic: number; /** `exercised` (long, ITM), `assigned` (short, ITM), or `expired` (out-of-the-money). */ action: 'exercised' | 'assigned' | 'expired'; settlement: OptionSettlementStyle; /** Net cash effect of the settlement. */ cashFlow: number; /** Signed underlier shares delivered/received on physical exercise/assignment (0 otherwise). */ shares: number; /** `true` when this was an EARLY (pre-expiry) American exercise/assignment (WS7.4). */ early?: boolean; /** Why an early event fired: `'dividend'`, `'deep-itm'`, or `'manual'` (absent for expiry). */ reason?: 'dividend' | 'deep-itm' | 'manual'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - action: 'expired' | 'exercised' | 'assigned'; default: not declared — `exercised` (long, ITM), `assigned` (short, ITM), or `expired` (out-of-the-money). - cashFlow: number; default: not declared — Net cash effect of the settlement. - contracts: number; default: not declared — Signed contracts settled (negative = short). - early?: boolean; default: not declared — `true` when this was an EARLY (pre-expiry) American exercise/assignment (WS7.4). - intrinsic: number; default: not declared — Intrinsic value per underlier share at settlement. - multiplier: number; default: not declared - reason?: 'dividend' | 'deep-itm' | 'manual'; default: not declared — Why an early event fired: `'dividend'`, `'deep-itm'`, or `'manual'` (absent for expiry). - settlement: OptionSettlementStyle; default: not declared - shares: number; default: not declared — Signed underlier shares delivered/received on physical exercise/assignment (0 otherwise). - strike: number; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared - type: 'call' | 'put'; default: not declared - underlierPrice: number; default: not declared — Underlier settlement price. - underlying: string; default: not declared ### @insiderfinance/totalfinance/backtest#OptionSettlementStyle Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionSettlementStyle = 'physical' | 'cash'; ``` ### @insiderfinance/totalfinance/backtest#Order Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A live order tracked by the broker. ```typescript /** A live order tracked by the broker. */ export interface Order { id: string; symbol: SymbolId; side: OrderSide; type: OrderType; /** Target share quantity (0 for notional orders, where shares are sized at fill). */ quantity: number; /** Target cash notional, when the order is notional-sized. */ notional?: number; filledQuantity: number; /** Cash notional filled so far (notional orders). */ filledNotional: number; status: OrderStatus; timeInForce: TimeInForce; limitPrice?: number; stopPrice?: number; ocoGroup?: string; takeProfit?: number; stopLoss?: number; /** * Timestamp of the bar the broker was processing when the order was submitted — an order placed in * a strategy's bar handler carries that bar's `ts`. Absent when the order was submitted before the * broker had seen any bar (the sim broker has no clock of its own). */ submittedTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - filledNotional: number; default: not declared — Cash notional filled so far (notional orders). - filledQuantity: number; default: not declared - id: string; default: not declared - limitPrice?: number; default: not declared - notional?: number; default: not declared — Target cash notional, when the order is notional-sized. - ocoGroup?: string; default: not declared - quantity: number; default: not declared — Target share quantity (0 for notional orders, where shares are sized at fill). - side: OrderSide; default: not declared - status: OrderStatus; default: not declared - stopLoss?: number; default: not declared - stopPrice?: number; default: not declared - submittedTimestampMs?: number; default: not declared — Timestamp of the bar the broker was processing when the order was submitted — an order placed in a strategy's bar handler carries that bar's `ts`. Absent when the order was submitted before the broker had seen any bar (the sim broker has no clock of its own). - symbol: string; default: not declared - takeProfit?: number; default: not declared - timeInForce: TimeInForce; default: not declared - type: OrderType; default: not declared ### @insiderfinance/totalfinance/backtest#OrderRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A request to trade, passed to {@link SimulatedBroker.submit}. Provide `quantity` *or* `notional`. ```typescript /** A request to trade, passed to {@link SimulatedBroker.submit}. Provide `quantity` *or* `notional`. */ export interface OrderRequest { symbol: SymbolId; side: OrderSide; /** Share quantity to trade (> 0). Mutually exclusive with `notional`. */ quantity?: number; /** Cash notional to trade; the broker sizes shares at the fill price. Mutually exclusive with `quantity`. */ notional?: number; /** Order type (default `market`). */ type?: OrderType; /** Limit price (for `limit` / `stop-limit`). */ limitPrice?: number; /** Stop trigger price (for `stop` / `stop-limit`). */ stopPrice?: number; /** Time in force (default `gtc`). */ timeInForce?: TimeInForce; /** Bracket: a take-profit **limit** price, attached as an OCO child once the parent fills. */ takeProfit?: number; /** Bracket: a stop-loss **stop** price, attached as an OCO child once the parent fills. */ stopLoss?: number; /** OCO group: filling or cancelling any member cancels the rest. */ ocoGroup?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - limitPrice?: number; default: not declared — Limit price (for `limit` / `stop-limit`). - notional?: number; default: not declared — Cash notional to trade; the broker sizes shares at the fill price. Mutually exclusive with `quantity`. - ocoGroup?: string; default: not declared — OCO group: filling or cancelling any member cancels the rest. - quantity?: number; default: not declared — Share quantity to trade (> 0). Mutually exclusive with `notional`. - side: OrderSide; default: not declared - stopLoss?: number; default: not declared — Bracket: a stop-loss **stop** price, attached as an OCO child once the parent fills. - stopPrice?: number; default: not declared — Stop trigger price (for `stop` / `stop-limit`). - symbol: string; default: not declared - takeProfit?: number; default: not declared — Bracket: a take-profit **limit** price, attached as an OCO child once the parent fills. - timeInForce?: TimeInForce; default: not declared — Time in force (default `gtc`). - type?: OrderType; default: not declared — Order type (default `market`). ### @insiderfinance/totalfinance/backtest#OrderSide Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OrderSide = 'buy' | 'sell'; ``` ### @insiderfinance/totalfinance/backtest#OrderStatus Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Kebab-case like every other enum on the surface (B6). ```typescript /** Kebab-case like every other enum on the surface (B6). */ export type OrderStatus = 'pending' | 'partially-filled' | 'filled' | 'cancelled'; ``` ### @insiderfinance/totalfinance/backtest#OrderType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Kebab-case everywhere; a simulator that supports a subset says so at its door. ```typescript /** Kebab-case everywhere; a simulator that supports a subset says so at its door. */ export type OrderType = 'market' | 'limit' | 'stop' | 'stop-limit' | 'market-on-open' | 'market-on-close'; ``` ### @insiderfinance/totalfinance/backtest#OutOfSampleAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OutOfSampleAssumptions { conventionsVersion: string; selectionMetric: GridSelectionMetric; periodsPerYear: number; /** Total sessions of the base request inside its window. */ sessionCount: number; /** How held-out returns were stitched: in window order, each test span's per-session returns appended. */ stitching: string; /** The rule for which sessions each window could see. */ visibility: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - periodsPerYear: number; default: not declared - selectionMetric: GridSelectionMetric; default: not declared - sessionCount: number; default: not declared — Total sessions of the base request inside its window. - stitching: string; default: not declared — How held-out returns were stitched: in window order, each test span's per-session returns appended. - visibility: string; default: not declared — The rule for which sessions each window could see. ### @insiderfinance/totalfinance/backtest#OutOfSampleDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OutOfSampleDiagnostics { warnings: QuantWarning[]; /** Windows skipped because a span had fewer than two sessions after purging. */ skippedWindowCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - skippedWindowCount: number; default: not declared — Windows skipped because a span had fewer than two sessions after purging. - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/backtest#OutOfSampleHygiene Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OutOfSampleHygiene { windowCount: number; /** Windows where a variation could be chosen and evaluated. */ evaluatedWindowCount: number; /** Mean selection metric on the training spans, over evaluated windows. */ meanTrainMetric: number | null; /** Mean selection metric on the held-out spans, over evaluated windows. */ meanTestMetric: number | null; /** `meanTrainMetric − meanTestMetric` — how much the in-sample choice flattered the strategy. */ degradation: number | null; /** Fraction of evaluated windows whose held-out metric was below zero. */ negativeTestFraction: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - degradation: number | null; default: not declared — `meanTrainMetric − meanTestMetric` — how much the in-sample choice flattered the strategy. - evaluatedWindowCount: number; default: not declared — Windows where a variation could be chosen and evaluated. - meanTestMetric: number | null; default: not declared — Mean selection metric on the held-out spans, over evaluated windows. - meanTrainMetric: number | null; default: not declared — Mean selection metric on the training spans, over evaluated windows. - negativeTestFraction: number | null; default: not declared — Fraction of evaluated windows whose held-out metric was below zero. - windowCount: number; default: not declared ### @insiderfinance/totalfinance/backtest#OutOfSampleWindowRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One out-of-sample window: the choice made on the training span and how it fared on the test span. ```typescript /** One out-of-sample window: the choice made on the training span and how it fared on the test span. */ export interface OutOfSampleWindowRow { index: number; train: SessionSpan[]; test: SessionSpan; /** The grid's best trial on the training span(s), or `null` when no variation carried the metric there. */ chosen: { variationIndex: number; parameters: Record; trainMetric: number; } | null; /** The held-out run of the chosen variation; `null` when nothing could be chosen. */ testMetric: number | null; testMetrics: GridSummaryMetrics | null; /** The chosen variation's held-out run id — replayable through `@insiderfinance/totalfinance/backtest/artifacts`. */ testRunId: string | null; /** The training sweep ids, one per contiguous training segment. */ trainSweepIds: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - chosen: { variationIndex: number; parameters: Record; trainMetric: number; } | null; default: not declared — The grid's best trial on the training span(s), or `null` when no variation carried the metric there. - chosen.parameters: Record; default: not declared - chosen.trainMetric: number; default: not declared - chosen.variationIndex: number; default: not declared - index: number; default: not declared - test: SessionSpan; default: not declared - test.fromSessionDate: string; default: not declared - test.fromSessionIndex: number; default: not declared — Index of the first session in the span (0 = the dataset's first session inside the base window). - test.sessionCount: number; default: not declared - test.toSessionDate: string; default: not declared - test.toSessionIndex: number; default: not declared - testMetric: number | null; default: not declared — The held-out run of the chosen variation; `null` when nothing could be chosen. - testMetrics: GridSummaryMetrics | null; default: not declared - testMetrics.annualizedReturn: number | null; default: not declared - testMetrics.annualizedVolatility: number | null; default: not declared - testMetrics.calmar: number | null; default: not declared - testMetrics.cappedGoalCount: number; default: not declared - testMetrics.fillCount: number; default: not declared - testMetrics.finalValue: number; default: not declared - testMetrics.hitRate: number | null; default: not declared - testMetrics.maxDrawdown: number; default: not declared - testMetrics.meanTurnover: number | null; default: not declared — Mean allocator turnover per rebalance (fraction of NAV). - testMetrics.periods: number; default: not declared - testMetrics.rebalanceCount: number; default: not declared - testMetrics.sharpe: number | null; default: not declared - testMetrics.sortino: number | null; default: not declared - testMetrics.totalCosts: number; default: not declared — Costs charged over the run, in base currency. - testMetrics.totalReturn: number | null; default: not declared - testMetrics.tradeCount: number; default: not declared - testMetrics.violatedGoalCount: number; default: not declared - testMetrics.warningCount: number; default: not declared - testRunId: string | null; default: not declared — The chosen variation's held-out run id — replayable through `@insiderfinance/totalfinance/backtest/artifacts`. - train: SessionSpan[]; default: not declared - trainSweepIds: string[]; default: not declared — The training sweep ids, one per contiguous training segment. ### @insiderfinance/totalfinance/backtest#PortfolioBacktestRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioBacktestRequest extends PortfolioStepperRequest { strategy: PortfolioStrategy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accounting: AccountingPolicy; default: not declared - accounting.baseCurrency: string; default: not declared - accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - accounting.lotRelief?: LotReliefPolicy; default: not declared — Default `'fifo'`. - accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - execution?: ExecutionPolicy; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - execution.costs.borrow.label: string; default: not declared - execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - execution.costs.commission.commission(input).price: number; default: not declared - execution.costs.commission.commission(input).quantity: number; default: not declared - execution.costs.commission.label: string; default: not declared - execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - execution.costs.latency.label: string; default: not declared - execution.costs.latency.sessions: number; default: not declared - execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - execution.costs.marketImpact.impact(input).quantity: number; default: not declared - execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - execution.costs.marketImpact.label: string; default: not declared - execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - execution.costs.slippage.fill(input).quantity: number; default: not declared - execution.costs.slippage.fill(input).referencePrice: number; default: not declared - execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.slippage.label: string; default: not declared - execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.spread.label: string; default: not declared - execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - execution.fill.fill().return.detail?: string; default: not declared - execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - execution.fill.fill().return.pricePerUnit: number; default: not declared - execution.fill.fill().return.quantity: number; default: not declared - execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - execution.fill.fill(request).order: OrderIntent; default: not declared - execution.fill.label: string; default: not declared - execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared — Echoed in every result's assumptions. - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - externalFlows?: readonly ExternalFlowRecord[]; default: not declared - instruments: Readonly>; default: not declared - marketData: PortfolioMarketData; default: not declared - marketData.bars?: readonly Bar[]; default: not declared - marketData.corporateActions?: readonly CorporateAction[]; default: not declared - marketData.coupons?: readonly CouponRecord[]; default: not declared - marketData.dividends?: readonly DividendRecord[]; default: not declared - marketData.forwardRates?: readonly ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - marketData.fundingRates?: readonly FundingRateRecord[]; default: not declared - marketData.fxRates?: readonly DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - marketData.optionChains?: readonly ChainSnapshot[]; default: not declared - marketData.orderBooks?: readonly OrderBook[]; default: not declared - marketData.quotes?: readonly Quote[]; default: not declared - marketData.trades?: readonly Trade[]; default: not declared - periodsPerYear?: number; default: not declared - seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - strategy: PortfolioStrategy; default: not declared - strategy.model: ModelPortfolio | readonly AllocationTarget[]; default: not declared — A model artifact or inline targets, proposed on the schedule through `proposePortfolioRebalance`. - strategy.model.baseCurrency: string; default: not declared - strategy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - strategy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - strategy.model.benchmark.benchmarkId: string; default: not declared - strategy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - strategy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - strategy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - strategy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - strategy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - strategy.model.horizonEndDate?: string | number; default: not declared - strategy.model.kind: 'totalfinance.model-portfolio'; default: not declared - strategy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - strategy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - strategy.model.liabilities.note?: string; default: not declared - strategy.model.modelId: string; default: not declared - strategy.model.note?: string; default: not declared - strategy.model.schemaVersion: number; default: not declared - strategy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - strategy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - strategy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - strategy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - strategy.model.strategic.note?: string; default: not declared - strategy.model.strategic.targets: AllocationTarget[]; default: not declared - strategy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - strategy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - strategy.onSession: (context: SessionContext) => readonly OrderIntent[]; default: not declared — Direct TypeScript; the run is not replayable. - strategy.onSession(context): SessionContext; default: not declared - strategy.onSession(context).asOf: number; default: not declared - strategy.onSession(context).cash: readonly { currency: string; amount: number; }[]; default: not declared - strategy.onSession(context).index: number; default: not declared - strategy.onSession(context).instruments: Readonly>; default: not declared - strategy.onSession(context).marks: Readonly>; default: not declared — Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). - strategy.onSession(context).netAssetValue: number; default: not declared - strategy.onSession(context).observations: Readonly>; default: not declared — The latest observations per instrument at the instant. - strategy.onSession(context).positions: readonly SessionPosition[]; default: not declared - strategy.policy?: InvestmentPolicy; default: not declared - strategy.policy.allowedAccounts?: string[]; default: not declared - strategy.policy.allowedInstruments?: string[]; default: not declared - strategy.policy.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - strategy.policy.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - strategy.policy.benchmark.benchmarkId: string; default: not declared - strategy.policy.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - strategy.policy.contributionHandling?: import('@insiderfinance/totalfinance/portfolio').ContributionHandling; default: not declared - strategy.policy.driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - strategy.policy.incomeReinvestment?: import('@insiderfinance/totalfinance/portfolio').IncomeReinvestment; default: not declared - strategy.policy.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - strategy.policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - strategy.policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - strategy.policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - strategy.policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - strategy.policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - strategy.policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - strategy.policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - strategy.policy.lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - strategy.policy.maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - strategy.policy.maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - strategy.policy.minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - strategy.policy.minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - strategy.policy.model?: ModelPortfolio; default: not declared - strategy.policy.model.baseCurrency: string; default: not declared - strategy.policy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - strategy.policy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - strategy.policy.model.benchmark.benchmarkId: string; default: not declared - strategy.policy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - strategy.policy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - strategy.policy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - strategy.policy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - strategy.policy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - strategy.policy.model.horizonEndDate?: string | number; default: not declared - strategy.policy.model.kind: 'totalfinance.model-portfolio'; default: not declared - strategy.policy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - strategy.policy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - strategy.policy.model.liabilities.note?: string; default: not declared - strategy.policy.model.modelId: string; default: not declared - strategy.policy.model.note?: string; default: not declared - strategy.policy.model.schemaVersion: number; default: not declared - strategy.policy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - strategy.policy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - strategy.policy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - strategy.policy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - strategy.policy.model.strategic.note?: string; default: not declared - strategy.policy.model.strategic.targets: AllocationTarget[]; default: not declared - strategy.policy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - strategy.policy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - strategy.policy.performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - strategy.policy.restrictedInstruments?: string[]; default: not declared - strategy.policy.reviewCadenceDays?: number; default: not declared - strategy.policy.targets?: AllocationTarget[]; default: not declared - strategy.policy.withdrawalHandling?: import('@insiderfinance/totalfinance/portfolio').WithdrawalHandling; default: not declared - strategy.policy.withinGroupAllocation?: import('@insiderfinance/totalfinance/portfolio').WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. - strategy.schedule: RebalanceSchedule; default: not declared - strategy.schedule.frequency: RebalanceFrequency; default: not declared - strategy.scope?: RebalanceScope; default: not declared — Default `'to-target'`. - window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - window.fromTimestampMs?: number; default: not declared - window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest#PortfolioBacktestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioBacktestResult { ledger: PortfolioLedgerSnapshot; timeline: PortfolioTimelineResult | null; pnl: PortfolioPnlResult | null; orders: OrderRecord[]; fills: NormalizedFill[]; rejections: RejectionRow[]; liquidations: LiquidationRow[]; events: PortfolioEventEnvelope[]; valuationMarks: PortfolioValuationMark[]; points: EquityPoint[]; returns: number[]; performance: PerformanceSummary; finalValue: number; runId: string; assumptions: PortfolioBacktestAssumptions; diagnostics: PortfolioBacktestDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: PortfolioBacktestAssumptions; default: not declared - assumptions.baseCurrency: string; default: not declared - assumptions.calendar: string | null; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.execution: ExecutionPolicyDescription; default: not declared - assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - assumptions.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - assumptions.execution.costs.borrow: string | null; default: not declared - assumptions.execution.costs.commission: string; default: not declared - assumptions.execution.costs.latencySessions: number | null; default: not declared - assumptions.execution.costs.marketImpact: string | null; default: not declared - assumptions.execution.costs.participation: number | null; default: not declared - assumptions.execution.costs.slippage: string; default: not declared - assumptions.execution.costs.spread: string | null; default: not declared - assumptions.execution.fill: { label: string; version: string; }; default: not declared - assumptions.execution.fill.label: string; default: not declared - assumptions.execution.fill.version: string; default: not declared - assumptions.execution.label: string; default: not declared - assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - assumptions.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - assumptions.execution.sessions.halts: number; default: not declared - assumptions.execution.sessions.priceLimits: number; default: not declared - assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - assumptions.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - assumptions.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - assumptions.instruments: { instrumentId: string; kind: InstrumentKind; adapter: { kind: string; version: string; }; currency: string; }[]; default: not declared - assumptions.ledger: { accountId: string; sourceId: string; }; default: not declared - assumptions.ledger.accountId: string; default: not declared - assumptions.ledger.sourceId: string; default: not declared - assumptions.lotRelief: LotReliefPolicy; default: not declared - assumptions.markConvention: string; default: not declared - assumptions.periodsPerYear: number; default: not declared - assumptions.replayable: boolean; default: not declared - assumptions.seed: number | null; default: not declared - assumptions.sessionConvention: string; default: not declared - assumptions.settlement: Record; default: not declared - assumptions.strategy: { frequency: RebalanceFrequency; kind: 'model'; modelId: string | null; scope: RebalanceScope; targets: number; } | { kind: 'callback'; replayable: false; } | { kind: 'external'; replayable: false; }; default: not declared - assumptions.strategy.frequency: RebalanceFrequency; default: not declared - assumptions.strategy.kind: ('callback') | ('external') | ('model'); default: not declared - assumptions.strategy.modelId: string | null; default: not declared - assumptions.strategy.replayable: false; default: not declared - assumptions.strategy.scope: RebalanceScope; default: not declared - assumptions.strategy.targets: number; default: not declared - assumptions.window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - assumptions.window.fromTimestampMs: number | null; default: not declared - assumptions.window.toTimestampMs: number | null; default: not declared - diagnostics: PortfolioBacktestDiagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.externalFlowCount: number; default: not declared - diagnostics.fillCount: number; default: not declared - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.lifecycleEventCount: number; default: not declared - diagnostics.liquidationCount: number; default: not declared - diagnostics.markCount: number; default: not declared - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.orderCount: number; default: not declared - diagnostics.reconciliationResidual: number; default: not declared — The ledger NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - diagnostics.rejectionCount: number; default: not declared - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.sessionCount: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - events: PortfolioEventEnvelope[]; default: not declared - fills: NormalizedFill[]; default: not declared - finalValue: number; default: not declared - ledger: PortfolioLedgerSnapshot; default: not declared - ledger.baseCurrency: string; default: not declared - ledger.events: PortfolioEventEnvelope[]; default: not declared - ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - ledger.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - ledger.portfolioId?: string; default: not declared - ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - ledger.provenance.asOf?: number; default: not declared - ledger.provenance.dataset?: string; default: not declared - ledger.provenance.provider?: string; default: not declared - ledger.provenance.receivedAt?: number; default: not declared - ledger.provenance.requestId?: string; default: not declared - ledger.provenance.sourceVersion?: string; default: not declared - ledger.provenance.warnings?: QuantWarning[]; default: not declared - ledger.schemaVersion: number; default: not declared - liquidations: LiquidationRow[]; default: not declared - orders: OrderRecord[]; default: not declared - performance: PerformanceSummary; default: not declared - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - pnl: PortfolioPnlResult | null; default: not declared - pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - pnl.assumptions.conventionsVersion: string; default: not declared - pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - pnl.assumptions.identity: string; default: not declared — The identity, stated. - pnl.assumptions.lotRelief: LotReliefPolicy; default: not declared - pnl.assumptions.residualTolerance: number; default: not declared - pnl.baseCurrency: string; default: not declared - pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - pnl.components.financing: number; default: not declared - pnl.components.foreignExchangePnl: number; default: not declared - pnl.components.income: number; default: not declared - pnl.components.realizedPnl: number; default: not declared - pnl.components.totalPnl: number; default: not declared - pnl.components.transactionCosts: number; default: not declared - pnl.components.unrealizedPnl: number; default: not declared - pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - pnl.diagnostics.warnings: string[]; default: not declared - pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - pnl.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - pnl.from.asOf: number; default: not declared - pnl.from.netAssetValue: number; default: not declared - pnl.from.valuationDate: string; default: not declared - pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - pnl.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - pnl.to.asOf: number; default: not declared - pnl.to.netAssetValue: number; default: not declared - pnl.to.valuationDate: string; default: not declared - points: EquityPoint[]; default: not declared - rejections: RejectionRow[]; default: not declared - returns: number[]; default: not declared - runId: string; default: not declared - timeline: PortfolioTimelineResult | null; default: not declared - timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - timeline.assumptions.conventionsVersion: string; default: not declared - timeline.assumptions.exposureConvention: string; default: not declared - timeline.assumptions.indexConvention: string; default: not declared - timeline.assumptions.lotRelief: LotReliefPolicy; default: not declared - timeline.assumptions.markInstant: string; default: not declared - timeline.baseCurrency: string; default: not declared - timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - timeline.cumulativePnl.financing: number; default: not declared - timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - timeline.cumulativePnl.income: number; default: not declared - timeline.cumulativePnl.realizedPnl: number; default: not declared - timeline.cumulativePnl.residual: number; default: not declared - timeline.cumulativePnl.totalPnl: number; default: not declared - timeline.cumulativePnl.transactionCosts: number; default: not declared - timeline.cumulativePnl.unrealizedPnl: number; default: not declared - timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - timeline.diagnostics.markCount: number; default: not declared - timeline.diagnostics.warnings: string[]; default: not declared - timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - valuationMarks: PortfolioValuationMark[]; default: not declared ### @insiderfinance/totalfinance/backtest#PortfolioConstruction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioConstruction { method: WeightingMethod; long: SideSelection; short?: ShortSideSelection; neutrality?: Neutrality; /** For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. */ neutralizeAgainst?: { field: string; }; maximumPositions?: number; maximumPositionWeight?: number; minimumPositionWeight?: number; /** Fraction of net asset value traded per rebalance; a trim is reported, never silent. */ maximumTurnover?: number; /** Fraction of a name's average daily volume one rebalance may trade. */ maximumParticipation?: number; /** Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). */ volatilityLookbackSessions?: number; /** For `risk-budget`: budgets per instrument (missing names share the remainder equally). */ riskBudgets?: Readonly>; /** For `supplied-weights`: the caller's weights (fractions of net asset value, signed). */ suppliedWeights?: (context: WeightContext) => Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long: SideSelection; default: not declared - long.count: number; default: not declared - long.fraction: number; default: not declared - long.topQuantile: number; default: not declared - maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - maximumPositionWeight?: number; default: not declared - maximumPositions?: number; default: not declared - maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - method: WeightingMethod; default: not declared - minimumPositionWeight?: number; default: not declared - neutrality?: Neutrality; default: not declared - neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - neutralizeAgainst.field: string; default: not declared - riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - short?: ShortSideSelection; default: not declared - short.bottomQuantile: number; default: not declared - short.count: number; default: not declared - short.fraction: number; default: not declared - suppliedWeights?: (context: WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - suppliedWeights(context): WeightContext; default: not declared - suppliedWeights(context).asOf: number; default: not declared - suppliedWeights(context).long: readonly SignalRow[]; default: not declared - suppliedWeights(context).sessionDate: string; default: not declared - suppliedWeights(context).short: readonly SignalRow[]; default: not declared - suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). ### @insiderfinance/totalfinance/backtest#PortfolioStepFrame Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The rows one closed instant appended (Stage 7B.1): what the step did, in the engine's own grammar. ```typescript /** The rows one closed instant appended (Stage 7B.1): what the step did, in the engine's own grammar. */ export interface PortfolioStepFrame { asOf: EpochMs; index: number; /** The ledger's net asset value after the step, in the base currency. */ netAssetValue: number; orders: OrderRecord[]; fills: NormalizedFill[]; rejections: RejectionRow[]; liquidations: LiquidationRow[]; /** Every portfolio event folded during the step — lifecycle, flows, fills, liquidations. */ events: PortfolioEventEnvelope[]; warnings: QuantWarning[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - events: PortfolioEventEnvelope[]; default: not declared — Every portfolio event folded during the step — lifecycle, flows, fills, liquidations. - fills: NormalizedFill[]; default: not declared - index: number; default: not declared - liquidations: LiquidationRow[]; default: not declared - netAssetValue: number; default: not declared — The ledger's net asset value after the step, in the base currency. - orders: OrderRecord[]; default: not declared - rejections: RejectionRow[]; default: not declared - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/backtest#PortfolioStepper Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `portfolioBacktest`'s loop driven from outside (Stage 7B.1, Decision 2). ```typescript /** `portfolioBacktest`'s loop driven from outside (Stage 7B.1, Decision 2). */ export interface PortfolioStepper { readonly runId: string; /** The decision instants, ascending — the same instants `portfolioBacktest` would step. */ readonly instants: readonly EpochMs[]; /** Lifecycle facts and external flows due at the instant, then the session context. */ open(index: number): SessionContext; /** The orders through the execution policy, the margin check, the valuation mark, the equity. */ close(index: number, orders: readonly OrderIntent[]): PortfolioStepFrame; /** The session context at the last closed instant — the state after its orders, margin, and mark. */ context(): SessionContext; /** The ledger state, the market snapshot, the conversions, and the valued snapshot at the last closed instant. */ valuation(): PortfolioValuationInputs; /** The same result `portfolioBacktest` returns, over the instants closed so far. */ finish(): PortfolioBacktestResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: (index: number, orders: readonly OrderIntent[]) => PortfolioStepFrame; default: not declared — The orders through the execution policy, the margin check, the valuation mark, the equity. - close().return.asOf: number; default: not declared - close().return.events: PortfolioEventEnvelope[]; default: not declared — Every portfolio event folded during the step — lifecycle, flows, fills, liquidations. - close().return.fills: NormalizedFill[]; default: not declared - close().return.index: number; default: not declared - close().return.liquidations: LiquidationRow[]; default: not declared - close().return.netAssetValue: number; default: not declared — The ledger's net asset value after the step, in the base currency. - close().return.orders: OrderRecord[]; default: not declared - close().return.rejections: RejectionRow[]; default: not declared - close().return.warnings: QuantWarning[]; default: not declared - close(index): number; default: not declared - close(orders): readonly OrderIntent[]; default: not declared - context: () => SessionContext; default: not declared — The session context at the last closed instant — the state after its orders, margin, and mark. - context().return.asOf: number; default: not declared - context().return.cash: readonly { currency: string; amount: number; }[]; default: not declared - context().return.index: number; default: not declared - context().return.instruments: Readonly>; default: not declared - context().return.marks: Readonly>; default: not declared — Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). - context().return.netAssetValue: number; default: not declared - context().return.observations: Readonly>; default: not declared — The latest observations per instrument at the instant. - context().return.positions: readonly SessionPosition[]; default: not declared - finish: () => PortfolioBacktestResult; default: not declared — The same result `portfolioBacktest` returns, over the instants closed so far. - finish().return.assumptions: PortfolioBacktestAssumptions; default: not declared - finish().return.diagnostics: PortfolioBacktestDiagnostics; default: not declared - finish().return.events: PortfolioEventEnvelope[]; default: not declared - finish().return.fills: NormalizedFill[]; default: not declared - finish().return.finalValue: number; default: not declared - finish().return.ledger: PortfolioLedgerSnapshot; default: not declared - finish().return.liquidations: LiquidationRow[]; default: not declared - finish().return.orders: OrderRecord[]; default: not declared - finish().return.performance: PerformanceSummary; default: not declared - finish().return.pnl: PortfolioPnlResult | null; default: not declared - finish().return.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - finish().return.pnl.assumptions.conventionsVersion: string; default: not declared - finish().return.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - finish().return.pnl.assumptions.identity: string; default: not declared — The identity, stated. - finish().return.pnl.assumptions.lotRelief: LotReliefPolicy; default: not declared - finish().return.pnl.assumptions.residualTolerance: number; default: not declared - finish().return.pnl.baseCurrency: string; default: not declared - finish().return.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - finish().return.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - finish().return.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - finish().return.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - finish().return.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - finish().return.pnl.diagnostics.warnings: string[]; default: not declared - finish().return.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - finish().return.pnl.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - finish().return.pnl.from.asOf: number; default: not declared - finish().return.pnl.from.netAssetValue: number; default: not declared - finish().return.pnl.from.valuationDate: string; default: not declared - finish().return.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - finish().return.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - finish().return.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - finish().return.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - finish().return.pnl.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - finish().return.pnl.to.asOf: number; default: not declared - finish().return.pnl.to.netAssetValue: number; default: not declared - finish().return.pnl.to.valuationDate: string; default: not declared - finish().return.points: EquityPoint[]; default: not declared - finish().return.rejections: RejectionRow[]; default: not declared - finish().return.returns: number[]; default: not declared - finish().return.runId: string; default: not declared - finish().return.timeline: PortfolioTimelineResult | null; default: not declared - finish().return.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - finish().return.timeline.assumptions.conventionsVersion: string; default: not declared - finish().return.timeline.assumptions.exposureConvention: string; default: not declared - finish().return.timeline.assumptions.indexConvention: string; default: not declared - finish().return.timeline.assumptions.lotRelief: LotReliefPolicy; default: not declared - finish().return.timeline.assumptions.markInstant: string; default: not declared - finish().return.timeline.baseCurrency: string; default: not declared - finish().return.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - finish().return.timeline.cumulativePnl.financing: number; default: not declared - finish().return.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - finish().return.timeline.cumulativePnl.income: number; default: not declared - finish().return.timeline.cumulativePnl.realizedPnl: number; default: not declared - finish().return.timeline.cumulativePnl.residual: number; default: not declared - finish().return.timeline.cumulativePnl.totalPnl: number; default: not declared - finish().return.timeline.cumulativePnl.transactionCosts: number; default: not declared - finish().return.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - finish().return.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - finish().return.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - finish().return.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - finish().return.timeline.diagnostics.markCount: number; default: not declared - finish().return.timeline.diagnostics.warnings: string[]; default: not declared - finish().return.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - finish().return.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - finish().return.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - finish().return.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - finish().return.valuationMarks: PortfolioValuationMark[]; default: not declared - instants: readonly number[]; default: not declared — The decision instants, ascending — the same instants `portfolioBacktest` would step. - open: (index: number) => SessionContext; default: not declared — Lifecycle facts and external flows due at the instant, then the session context. - open().return.asOf: number; default: not declared - open().return.cash: readonly { currency: string; amount: number; }[]; default: not declared - open().return.index: number; default: not declared - open().return.instruments: Readonly>; default: not declared - open().return.marks: Readonly>; default: not declared — Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). - open().return.netAssetValue: number; default: not declared - open().return.observations: Readonly>; default: not declared — The latest observations per instrument at the instant. - open().return.positions: readonly SessionPosition[]; default: not declared - open(index): number; default: not declared - runId: string; default: not declared - valuation: () => PortfolioValuationInputs; default: not declared — The ledger state, the market snapshot, the conversions, and the valued snapshot at the last closed instant. - valuation().return.asOf: number; default: not declared - valuation().return.currencyConversions: CurrencyPairQuote[]; default: not declared - valuation().return.market: MarketSnapshot; default: not declared - valuation().return.portfolio: PortfolioState; default: not declared - valuation().return.snapshot: PortfolioSnapshotResult; default: not declared ### @insiderfinance/totalfinance/backtest#PortfolioStepperRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Everything a run needs except who decides the orders — the stepper's request (Stage 7B.1). ```typescript /** Everything a run needs except who decides the orders — the stepper's request (Stage 7B.1). */ export interface PortfolioStepperRequest { accounting: AccountingPolicy; instruments: Readonly>; marketData: PortfolioMarketData; execution?: ExecutionPolicy; externalFlows?: readonly ExternalFlowRecord[]; /** A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. */ calendar?: string; window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; periodsPerYear?: number; /** Seeds only the bootstrap confidence intervals. */ seed?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accounting: AccountingPolicy; default: not declared - accounting.baseCurrency: string; default: not declared - accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - accounting.lotRelief?: LotReliefPolicy; default: not declared — Default `'fifo'`. - accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - execution?: ExecutionPolicy; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - execution.costs.borrow.label: string; default: not declared - execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - execution.costs.commission.commission(input).price: number; default: not declared - execution.costs.commission.commission(input).quantity: number; default: not declared - execution.costs.commission.label: string; default: not declared - execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - execution.costs.latency.label: string; default: not declared - execution.costs.latency.sessions: number; default: not declared - execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - execution.costs.marketImpact.impact(input).quantity: number; default: not declared - execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - execution.costs.marketImpact.label: string; default: not declared - execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - execution.costs.slippage.fill(input).quantity: number; default: not declared - execution.costs.slippage.fill(input).referencePrice: number; default: not declared - execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.slippage.label: string; default: not declared - execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.spread.label: string; default: not declared - execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - execution.fill.fill().return.detail?: string; default: not declared - execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - execution.fill.fill().return.pricePerUnit: number; default: not declared - execution.fill.fill().return.quantity: number; default: not declared - execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - execution.fill.fill(request).order: OrderIntent; default: not declared - execution.fill.label: string; default: not declared - execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared — Echoed in every result's assumptions. - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - externalFlows?: readonly ExternalFlowRecord[]; default: not declared - instruments: Readonly>; default: not declared - marketData: PortfolioMarketData; default: not declared - marketData.bars?: readonly Bar[]; default: not declared - marketData.corporateActions?: readonly CorporateAction[]; default: not declared - marketData.coupons?: readonly CouponRecord[]; default: not declared - marketData.dividends?: readonly DividendRecord[]; default: not declared - marketData.forwardRates?: readonly ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - marketData.fundingRates?: readonly FundingRateRecord[]; default: not declared - marketData.fxRates?: readonly DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - marketData.optionChains?: readonly ChainSnapshot[]; default: not declared - marketData.orderBooks?: readonly OrderBook[]; default: not declared - marketData.quotes?: readonly Quote[]; default: not declared - marketData.trades?: readonly Trade[]; default: not declared - periodsPerYear?: number; default: not declared - seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - window.fromTimestampMs?: number; default: not declared - window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest#Position Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An open position snapshot. ```typescript /** An open position snapshot. */ export interface Position { symbol: SymbolId; /** Signed quantity (negative = short). */ quantity: number; /** Average entry price of the current position. */ averagePrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averagePrice: number; default: not declared — Average entry price of the current position. - quantity: number; default: not declared — Signed quantity (negative = short). - symbol: string; default: not declared ### @insiderfinance/totalfinance/backtest#RebalanceFrequency Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Schedule and construction // --------------------------------------------------------------------------------------------------- export type RebalanceFrequency = 'daily' | 'weekly' | 'monthly' | 'quarterly'; ``` ### @insiderfinance/totalfinance/backtest#RebalanceGoal Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceGoal { goal: string; status: 'satisfied' | 'capped' | 'violated'; detail: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: string; default: not declared - goal: string; default: not declared - status: 'satisfied' | 'capped' | 'violated'; default: not declared ### @insiderfinance/totalfinance/backtest#RebalanceRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceRow { rebalanceIndex: number; sessionDate: string; asOf: EpochMs; memberCount: number; eligibleCount: number; scoredCount: number; longCount: number; shortCount: number; /** Fraction of net asset value traded (the allocator's turnover). */ turnover: number; /** Costs charged at this rebalance, in base currency. */ costs: number; netAssetValue: number; goals: RebalanceGoal[]; exits: Array<{ instrumentId: string; reason: 'delisted' | 'removed' | 'deselected'; exitPrice: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - costs: number; default: not declared — Costs charged at this rebalance, in base currency. - eligibleCount: number; default: not declared - exits: { instrumentId: string; reason: 'delisted' | 'removed' | 'deselected'; exitPrice: number; }[]; default: not declared - goals: RebalanceGoal[]; default: not declared - longCount: number; default: not declared - memberCount: number; default: not declared - netAssetValue: number; default: not declared - rebalanceIndex: number; default: not declared - scoredCount: number; default: not declared - sessionDate: string; default: not declared - shortCount: number; default: not declared - turnover: number; default: not declared — Fraction of net asset value traded (the allocator's turnover). ### @insiderfinance/totalfinance/backtest#RebalanceRule Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rebalance calendar: every bar, on a date/week/month boundary, or every `N` bars. ```typescript /** Rebalance calendar: every bar, on a date/week/month boundary, or every `N` bars. */ export type RebalanceRule = 'everyBar' | 'daily' | 'weekly' | 'monthly' | number; ``` ### @insiderfinance/totalfinance/backtest#RebalanceSchedule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceSchedule { frequency: RebalanceFrequency; /** Which session instant decides and fills: the open or the close of the rebalance session. */ session: 'open' | 'close'; /** * Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the * selection threshold, so a name oscillating at the edge does not churn. */ bufferBand?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - frequency: RebalanceFrequency; default: not declared - session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. ### @insiderfinance/totalfinance/backtest#ReturnStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReturnStatistics { /** * Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero * bar — there is no win/loss population to take a fraction of, so the metric is undefined and is * disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate * (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. */ hitRate: number | null; /** * Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite * value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` * (Law 7). `0` when there are no gains either. */ profitFactor: number | null; /** * Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — * matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. */ expectancy: number | null; averageWin: number; averageLoss: number; bestPeriod: number; worstPeriod: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageLoss: number; default: not declared - averageWin: number; default: not declared - bestPeriod: number; default: not declared - expectancy: number | null; default: not declared — Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. - hitRate: number | null; default: not declared — Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero bar — there is no win/loss population to take a fraction of, so the metric is undefined and is disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. - profitFactor: number | null; default: not declared — Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` (Law 7). `0` when there are no gains either. - worstPeriod: number; default: not declared ### @insiderfinance/totalfinance/backtest#ReturnStatisticsReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link returnStatistics} as a report: the stats carrying `assumptions` + `diagnostics` inline. ```typescript /** {@link returnStatistics} as a report: the stats carrying `assumptions` + `diagnostics` inline. */ export interface ReturnStatisticsReport extends ReturnStatistics { assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - averageLoss: number; default: not declared - averageWin: number; default: not declared - bestPeriod: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - expectancy: number | null; default: not declared — Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. - hitRate: number | null; default: not declared — Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero bar — there is no win/loss population to take a fraction of, so the metric is undefined and is disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. - profitFactor: number | null; default: not declared — Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` (Law 7). `0` when there are no gains either. - worstPeriod: number; default: not declared ### @insiderfinance/totalfinance/backtest#SeriesSignal Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A warmup-aware signal: `{ value, warmup }` hand-built, or any `technicalAnalysis.*.explain(...)` envelope (`{ value, diagnostics: { warmup } }`) — `vectorized` accepts both. `warmup` is the number of leading bars that may be non-finite by design (an indicator's warmup); {@link vectorized } treats a non-finite value at index `i < warmup` as a flat (position 0) bar instead of an error. Defined structurally in this package so `@insiderfinance/totalfinance/backtest` need not depend on `@insiderfinance/totalfinance/technical-analysis`. ```typescript /** * A warmup-aware signal: `{ value, warmup }` hand-built, or any `technicalAnalysis.*.explain(...)` envelope * (`{ value, diagnostics: { warmup } }`) — `vectorized` accepts both. `warmup` is the number of * leading bars that may be non-finite by design (an indicator's warmup); {@link vectorized} treats * a non-finite value at index `i < warmup` as a flat (position 0) bar instead of an error. * * Defined structurally in this package so `@insiderfinance/totalfinance/backtest` need not depend on `@insiderfinance/totalfinance/technical-analysis`. */ export interface SeriesSignal { /** Per-bar signal values, aligned to the price bars. */ value: ArrayLike; /** Count of leading bars that may be non-finite by design (the indicator's warmup). */ warmup: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - value: ArrayLike; default: not declared — Per-bar signal values, aligned to the price bars. - warmup: number; default: not declared — Count of leading bars that may be non-finite by design (the indicator's warmup). ### @insiderfinance/totalfinance/backtest#SessionSpan Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A contiguous run of dataset sessions, inclusive on both ends, in session-index space. ```typescript // --------------------------------------------------------------------------------------------------- // Types // --------------------------------------------------------------------------------------------------- /** A contiguous run of dataset sessions, inclusive on both ends, in session-index space. */ export interface SessionSpan { /** Index of the first session in the span (0 = the dataset's first session inside the base window). */ fromSessionIndex: number; toSessionIndex: number; fromSessionDate: string; toSessionDate: string; sessionCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromSessionDate: string; default: not declared - fromSessionIndex: number; default: not declared — Index of the first session in the span (0 = the dataset's first session inside the base window). - sessionCount: number; default: not declared - toSessionDate: string; default: not declared - toSessionIndex: number; default: not declared ### @insiderfinance/totalfinance/backtest#ShortSideSelection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ShortSideSelection = { bottomQuantile: number; } | { count: number; } | { fraction: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bottomQuantile: number; default: not declared - count: number; default: not declared - fraction: number; default: not declared ### @insiderfinance/totalfinance/backtest#SideSelection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SideSelection = { topQuantile: number; } | { count: number; } | { fraction: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - fraction: number; default: not declared - topQuantile: number; default: not declared ### @insiderfinance/totalfinance/backtest#SignalContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a direct callback signal sees at a decision instant. ```typescript /** What a direct callback signal sees at a decision instant. */ export interface SignalContext { asOf: EpochMs; sessionDate: string; /** Eligible observations at the instant (availability, version, membership all applied). */ eligible: readonly UniverseObservation[]; fieldDefinitions: readonly FieldDefinition[]; /** Members of the universe at the instant. */ members: readonly string[]; /** The names held going into this rebalance. */ held: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - eligible: readonly UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - fieldDefinitions: readonly FieldDefinition[]; default: not declared - held: readonly string[]; default: not declared — The names held going into this rebalance. - members: readonly string[]; default: not declared — Members of the universe at the instant. - sessionDate: string; default: not declared ### @insiderfinance/totalfinance/backtest#SignalRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One scored name a signal produced at a decision instant; higher is better. ```typescript // --------------------------------------------------------------------------------------------------- // Signal // --------------------------------------------------------------------------------------------------- /** One scored name a signal produced at a decision instant; higher is better. */ export interface SignalRow { instrumentId: string; score: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - score: number; default: not declared ### @insiderfinance/totalfinance/backtest#SimulatedBroker Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A deterministic simulated broker. ```typescript export declare class SimulatedBroker { constructor(config: BrokerConfig); cancel(id: string): void; cash: number; equity(marks: Map): number; exerciseOption(input: ExerciseOptionInput): OptionSettlement; orders: readonly Order[]; policies(): { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; position(symbol: SymbolId): Position; readonly positions: Map; processBar(bar: Bar, action?: CorporateAction): Trade[]; registerOption(symbol: SymbolId, specification: OptionContractSpecification): void; settleExpiries(asOfTimestampMs: EpochMs, underlierMarks?: Map): OptionSettlement[]; settlements: readonly OptionSettlement[]; submit(request: OrderRequest): string; trades: readonly Trade[]; warnings: readonly QuantWarning[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config): BrokerConfig; default: not declared - (config).assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - (config).assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - (config).borrow?: BorrowModel; default: not declared - (config).cash: number; default: not declared — Opening cash. - (config).commission?: CostModel; default: not declared - (config).maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - (config).maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - (config).noShort?: boolean; default: not declared — Disallow short positions (default `false`). - (config).periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - (config).riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - (config).slippage?: SlippageModel; default: not declared - cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - cancel(id): string; default: not declared - cash: number; default: not declared - equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - equity(marks): Map; default: not declared - exerciseOption: (input: ExerciseOptionInput) => OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - exerciseOption().return.action: 'expired' | 'exercised' | 'assigned'; default: not declared — `exercised` (long, ITM), `assigned` (short, ITM), or `expired` (out-of-the-money). - exerciseOption().return.cashFlow: number; default: not declared — Net cash effect of the settlement. - exerciseOption().return.contracts: number; default: not declared — Signed contracts settled (negative = short). - exerciseOption().return.early?: boolean; default: not declared — `true` when this was an EARLY (pre-expiry) American exercise/assignment (WS7.4). - exerciseOption().return.intrinsic: number; default: not declared — Intrinsic value per underlier share at settlement. - exerciseOption().return.multiplier: number; default: not declared - exerciseOption().return.reason?: 'dividend' | 'deep-itm' | 'manual'; default: not declared — Why an early event fired: `'dividend'`, `'deep-itm'`, or `'manual'` (absent for expiry). - exerciseOption().return.settlement: import('@insiderfinance/totalfinance/backtest').OptionSettlementStyle; default: not declared - exerciseOption().return.shares: number; default: not declared — Signed underlier shares delivered/received on physical exercise/assignment (0 otherwise). - exerciseOption().return.strike: number; default: not declared - exerciseOption().return.symbol: string; default: not declared - exerciseOption().return.timestampMs: number; default: not declared - exerciseOption().return.type: 'call' | 'put'; default: not declared - exerciseOption().return.underlierPrice: number; default: not declared — Underlier settlement price. - exerciseOption().return.underlying: string; default: not declared - exerciseOption(input): ExerciseOptionInput; default: not declared - exerciseOption(input).quantity: number; default: not declared - exerciseOption(input).symbol: string; default: not declared - exerciseOption(input).timestampMs: number; default: not declared - exerciseOption(input).underlierMarks?: Map; default: not declared - orders: readonly Order[]; default: not declared — All orders ever submitted (live view, readonly). - policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - policies().return.assignment: string; default: not declared - policies().return.cost: string; default: not declared - policies().return.margin: string; default: not declared - policies().return.oco: string; default: not declared - policies().return.slippage: string; default: not declared - position: (symbol: SymbolId) => Position; default: not declared - position().return.averagePrice: number; default: not declared — Average entry price of the current position. - position().return.quantity: number; default: not declared — Signed quantity (negative = short). - position().return.symbol: string; default: not declared - position(symbol): string; default: not declared - positions: Map; default: not declared - processBar: (bar: Bar, action?: CorporateAction) => Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - processBar(action)?: CorporateAction | undefined; default: not declared - processBar(action).dividend?: number; default: not declared — Cash dividend per share (long receives, short pays). - processBar(action).split?: number; default: not declared — Split ratio `R` (`2` = 2-for-1: quantities ×R, prices ÷R). - processBar(bar): Bar; default: not declared - processBar(bar).adjusted?: boolean; default: not declared - processBar(bar).close: number; default: not declared - processBar(bar).high: number; default: not declared - processBar(bar).low: number; default: not declared - processBar(bar).open: number; default: not declared - processBar(bar).symbol: string; default: not declared - processBar(bar).timestampMs: number; default: not declared - processBar(bar).volume?: number; default: not declared - processBar(bar).vwap?: number; default: not declared - registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - registerOption(specification): OptionContractSpecification; default: not declared - registerOption(specification).expiresAt: number; default: not declared — Expiry instant, epoch ms (B6: the same name every resolved contract carries). - registerOption(specification).multiplier?: number; default: not declared — Contract multiplier (underlier shares per contract). Default 100. - registerOption(specification).settlement?: import('@insiderfinance/totalfinance/backtest').OptionSettlementStyle; default: not declared — `physical` (deliver/receive the underlier at strike, default) or `cash` (pay/receive intrinsic). - registerOption(specification).strike: number; default: not declared - registerOption(specification).style?: 'european' | 'american'; default: not declared — Exercise style (default `american`). Only `american` options are eligible for the EARLY exercise/assignment model (WS7.4); `european` options settle only at expiry. The early model is itself opt-in via the broker's `assignment: 'model'` policy, so this field is inert by default. - registerOption(specification).type: 'call' | 'put'; default: not declared - registerOption(specification).underlying: string; default: not declared — The underlying symbol the option exercises into. - registerOption(symbol): string; default: not declared - return.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - return.cash: number; default: not declared - return.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - return.exerciseOption: (input: ExerciseOptionInput) => OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - return.orders: readonly Order[]; default: not declared — All orders ever submitted (live view, readonly). - return.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - return.position: (symbol: SymbolId) => Position; default: not declared - return.positions: Map; default: not declared - return.processBar: (bar: Bar, action?: CorporateAction) => Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - return.registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - return.settleExpiries: (asOfTimestampMs: EpochMs, underlierMarks?: Map) => OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - return.settlements: readonly OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - return.submit: (request: OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - return.trades: readonly Trade[]; default: not declared — All fills (live view, readonly). - return.warnings: readonly QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - settleExpiries: (asOfTimestampMs: EpochMs, underlierMarks?: Map) => OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - settleExpiries(asOfTimestampMs): number; default: not declared - settleExpiries(underlierMarks)?: Map | undefined; default: not declared - settlements: readonly OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - submit: (request: OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - submit(request): OrderRequest; default: not declared - submit(request).limitPrice?: number; default: not declared — Limit price (for `limit` / `stop-limit`). - submit(request).notional?: number; default: not declared — Cash notional to trade; the broker sizes shares at the fill price. Mutually exclusive with `quantity`. - submit(request).ocoGroup?: string; default: not declared — OCO group: filling or cancelling any member cancels the rest. - submit(request).quantity?: number; default: not declared — Share quantity to trade (> 0). Mutually exclusive with `notional`. - submit(request).side: OrderSide; default: not declared - submit(request).stopLoss?: number; default: not declared — Bracket: a stop-loss **stop** price, attached as an OCO child once the parent fills. - submit(request).stopPrice?: number; default: not declared — Stop trigger price (for `stop` / `stop-limit`). - submit(request).symbol: string; default: not declared - submit(request).takeProfit?: number; default: not declared — Bracket: a take-profit **limit** price, attached as an OCO child once the parent fills. - submit(request).timeInForce?: TimeInForce; default: not declared — Time in force (default `gtc`). - submit(request).type?: OrderType; default: not declared — Order type (default `market`). - trades: readonly Trade[]; default: not declared — All fills (live view, readonly). - warnings: readonly QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). ### @insiderfinance/totalfinance/backtest#SlippageModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SlippageModel { readonly label: string; fill(input: SlippageFillInput): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fill: (input: SlippageFillInput) => number; default: not declared - fill(input): SlippageFillInput; default: not declared - fill(input).quantity: number; default: not declared - fill(input).referencePrice: number; default: not declared - fill(input).side: OrderSide; default: not declared - label: string; default: not declared ### @insiderfinance/totalfinance/backtest#StrategyContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The strategy's view of the world on the current bar. ```typescript /** The strategy's view of the world on the current bar. */ export interface StrategyContext { /** The bar currently being handled. */ readonly bar: Bar; /** * Register a handler that runs on every bar of `symbol`. Throws if `symbol` already has a handler — * one handler per symbol, so behaviour never silently depends on registration order (WS2.8). */ onBar(symbol: SymbolId, handler: () => void): void; /** * Register a portfolio-level handler that fires ONCE per timestamp, after every symbol's bar handler * for that timestamp has run — the right hook for cross-sectional logic (ranking, rebalancing) that * must not depend on the input bar order (WS2.8). */ onBars(handler: () => void): void; /** Bind a streaming indicator to a symbol; returns a handle refreshed before each handler call. */ indicator(symbol: SymbolId, stream: Indicator, field: BarField | ((bar: Bar) => In)): IndicatorHandle; /** Buy (target long via `percent`, or add via `quantity`/`value`). Returns the order id. */ buy(symbol: SymbolId, options?: TradeOptions): string; /** Sell / short. Returns the order id. */ sell(symbol: SymbolId, options?: TradeOptions): string; /** Flatten the position in `symbol` with a market order. */ close(symbol: SymbolId): void; /** Cancel a working order. */ cancel(id: string): void; /** Current position in `symbol`. */ position(symbol: SymbolId): Position; /** Register an option symbol (underlying/type/strike/expiry) so it's marked and settled at expiry. */ registerOption(symbol: SymbolId, specification: OptionContractSpecification): void; /** * Manually exercise `quantity` contracts of a LONG American option early (WS7.4). Requires the * broker's `assignment: 'model'` policy; settles at the current underlier mark. */ exercise(symbol: SymbolId, quantity: number): void; /** Current cash. */ readonly cash: number; /** Current portfolio equity (cash + marked positions). */ readonly equity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar: Bar; default: not declared — The bar currently being handled. - bar.adjusted?: boolean; default: not declared - bar.close: number; default: not declared - bar.high: number; default: not declared - bar.low: number; default: not declared - bar.open: number; default: not declared - bar.symbol: string; default: not declared - bar.timestampMs: number; default: not declared - bar.volume?: number; default: not declared - bar.vwap?: number; default: not declared - buy: (symbol: SymbolId, options?: TradeOptions) => string; default: not declared — Buy (target long via `percent`, or add via `quantity`/`value`). Returns the order id. - buy(options)?: TradeOptions | undefined; default: not declared - buy(options).limitPrice?: number; default: not declared - buy(options).percent?: number; default: not declared — Target allocation as a fraction of equity (a *target*, e.g. `1` = 100% long for `buy`). - buy(options).quantity?: number; default: not declared — Incremental share quantity. - buy(options).stopLoss?: number; default: not declared - buy(options).stopPrice?: number; default: not declared - buy(options).takeProfit?: number; default: not declared - buy(options).timeInForce?: TimeInForce; default: not declared - buy(options).type?: OrderType; default: not declared - buy(options).value?: number; default: not declared — Incremental notional value (shares = value / price). - buy(symbol): string; default: not declared - cancel: (id: string) => void; default: not declared — Cancel a working order. - cancel(id): string; default: not declared - cash: number; default: not declared — Current cash. - close: (symbol: SymbolId) => void; default: not declared — Flatten the position in `symbol` with a market order. - close(symbol): string; default: not declared - equity: number; default: not declared — Current portfolio equity (cash + marked positions). - exercise: (symbol: SymbolId, quantity: number) => void; default: not declared — Manually exercise `quantity` contracts of a LONG American option early (WS7.4). Requires the broker's `assignment: 'model'` policy; settles at the current underlier mark. - exercise(quantity): number; default: not declared - exercise(symbol): string; default: not declared - indicator: (symbol: SymbolId, stream: Indicator, field: BarField | ((bar: Bar) => In)) => IndicatorHandle; default: not declared — Bind a streaming indicator to a symbol; returns a handle refreshed before each handler call. - indicator().return.previous: Out | null; default: not declared - indicator().return.value: Out | null; default: not declared - indicator(field): BarField | ((bar: Bar) => In); default: not declared - indicator(stream): Indicator; default: not declared - indicator(stream).next: (input: In) => Out | null; default: not declared - indicator(symbol): string; default: not declared - onBar: (symbol: SymbolId, handler: () => void) => void; default: not declared — Register a handler that runs on every bar of `symbol`. Throws if `symbol` already has a handler — one handler per symbol, so behaviour never silently depends on registration order (WS2.8). - onBar(handler): () => void; default: not declared - onBar(symbol): string; default: not declared - onBars: (handler: () => void) => void; default: not declared — Register a portfolio-level handler that fires ONCE per timestamp, after every symbol's bar handler for that timestamp has run — the right hook for cross-sectional logic (ranking, rebalancing) that must not depend on the input bar order (WS2.8). - onBars(handler): () => void; default: not declared - position: (symbol: SymbolId) => Position; default: not declared — Current position in `symbol`. - position().return.averagePrice: number; default: not declared — Average entry price of the current position. - position().return.quantity: number; default: not declared — Signed quantity (negative = short). - position().return.symbol: string; default: not declared - position(symbol): string; default: not declared - registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol (underlying/type/strike/expiry) so it's marked and settled at expiry. - registerOption(specification): OptionContractSpecification; default: not declared - registerOption(specification).expiresAt: number; default: not declared — Expiry instant, epoch ms (B6: the same name every resolved contract carries). - registerOption(specification).multiplier?: number; default: not declared — Contract multiplier (underlier shares per contract). Default 100. - registerOption(specification).settlement?: import('@insiderfinance/totalfinance/backtest').OptionSettlementStyle; default: not declared — `physical` (deliver/receive the underlier at strike, default) or `cash` (pay/receive intrinsic). - registerOption(specification).strike: number; default: not declared - registerOption(specification).style?: 'european' | 'american'; default: not declared — Exercise style (default `american`). Only `american` options are eligible for the EARLY exercise/assignment model (WS7.4); `european` options settle only at expiry. The early model is itself opt-in via the broker's `assignment: 'model'` policy, so this field is inert by default. - registerOption(specification).type: 'call' | 'put'; default: not declared - registerOption(specification).underlying: string; default: not declared — The underlying symbol the option exercises into. - registerOption(symbol): string; default: not declared - sell: (symbol: SymbolId, options?: TradeOptions) => string; default: not declared — Sell / short. Returns the order id. - sell(options)?: TradeOptions | undefined; default: not declared - sell(options).limitPrice?: number; default: not declared - sell(options).percent?: number; default: not declared — Target allocation as a fraction of equity (a *target*, e.g. `1` = 100% long for `buy`). - sell(options).quantity?: number; default: not declared — Incremental share quantity. - sell(options).stopLoss?: number; default: not declared - sell(options).stopPrice?: number; default: not declared - sell(options).takeProfit?: number; default: not declared - sell(options).timeInForce?: TimeInForce; default: not declared - sell(options).type?: OrderType; default: not declared - sell(options).value?: number; default: not declared — Incremental notional value (shares = value / price). - sell(symbol): string; default: not declared ### @insiderfinance/totalfinance/backtest#SymbolAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Realized P&L (and costs) attributed to one symbol. ```typescript /** Realized P&L (and costs) attributed to one symbol. */ export interface SymbolAttribution { symbol: SymbolId; /** Realized trading P&L (average-cost matched; excludes open positions, dividends, borrow). */ realizedPnl: number; commission: number; slippage: number; tradedNotional: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: number; default: not declared - realizedPnl: number; default: not declared — Realized trading P&L (average-cost matched; excludes open positions, dividends, borrow). - slippage: number; default: not declared - symbol: string; default: not declared - tradedNotional: number; default: not declared ### @insiderfinance/totalfinance/backtest#TearSheet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TearSheet { performance: PerformanceSummary; trades: TradeStatistics; returns: ReturnStatistics; attribution: SymbolAttribution[]; monteCarlo?: MonteCarloResampleResult; /** The source backtest's echoed modelling assumptions — a tear sheet never drops them (WS2.8). */ assumptions: BacktestAssumptions; /** The source backtest's implementation-risk diagnostics — a tear sheet never drops them (WS2.8). */ diagnostics: ImplementationRisk; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: BacktestAssumptions; default: not declared — The source backtest's echoed modelling assumptions — a tear sheet never drops them (WS2.8). - assumptions.assignment?: string; default: not declared — American early exercise/assignment policy: `model` or `none` (WS7.4). Absent where inapplicable. - assumptions.calendar: string; default: not declared — Rebalancing/trading calendar, e.g. `every-bar`, `monthly`, `signal-driven`. - assumptions.cashSettlement: string; default: not declared — Cash settlement assumption, e.g. `immediate` (T+0). - assumptions.conventionsVersion: string; default: not declared — Version of the library's default conventions (core `CONVENTIONS_VERSION`). - assumptions.corporateAction: string; default: not declared — Corporate-action handling, e.g. `dividends-as-cash`, `splits-adjusted`, `none`. - assumptions.cost: string; default: not declared — Commission model applied, e.g. `bps(1)`, `per-share(0.005)`, `none`. - assumptions.fill: string; default: not declared — When/at what price orders fill, e.g. `next-open`, `close`, `trigger-price`. - assumptions.initialCapital: number; default: not declared — Opening capital the run started from. - assumptions.margin: string; default: not declared — Leverage/margin regime: `unconstrained` (no cap; unfunded fills allowed) or `maxLeverage`. - assumptions.oco?: string; default: not declared — How an OCO group resolves a bar that touches BOTH legs. One bar cannot say which trigger came first, and the engine's answer — the take-profit, because a bracket submits it before the stop-loss and orders fill in submission order — is optimistic. It is disclosed here rather than left as an undocumented mechanic (`take-profit-first-on-ambiguous-bar`). Absent for engines with no order book (the vectorized loop). - assumptions.slippage: string; default: not declared — Slippage model applied, e.g. `bps(2)`, `spread`, `none`. - attribution: SymbolAttribution[]; default: not declared - diagnostics: ImplementationRisk; default: not declared — The source backtest's implementation-risk diagnostics — a tear sheet never drops them (WS2.8). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.benchmarkFixtureVersion: string; default: not declared — The benchmark fixture version this engine was validated against. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - monteCarlo?: MonteCarloResampleResult; default: not declared - monteCarlo.confidenceInterval95: [number, number]; default: not declared — 95% percentile interval of the total return across resamples. - monteCarlo.iterations: number; default: not declared - monteCarlo.meanTotalReturn: number; default: not declared — Mean bootstrapped total return. - monteCarlo.seed: number; default: not declared - monteCarlo.standardDeviation: number; default: not declared - performance: PerformanceSummary; default: not declared - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - returns: ReturnStatistics; default: not declared - returns.averageLoss: number; default: not declared - returns.averageWin: number; default: not declared - returns.bestPeriod: number; default: not declared - returns.expectancy: number | null; default: not declared — Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. - returns.hitRate: number | null; default: not declared — Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero bar — there is no win/loss population to take a fraction of, so the metric is undefined and is disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. - returns.profitFactor: number | null; default: not declared — Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` (Law 7). `0` when there are no gains either. - returns.worstPeriod: number; default: not declared - trades: TradeStatistics; default: not declared - trades.count: number; default: not declared - trades.totalCommission: number; default: not declared - trades.totalSlippage: number; default: not declared - trades.turnover: number; default: not declared ### @insiderfinance/totalfinance/backtest#TearSheetOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TearSheetOptions { /** Add a seeded Monte-Carlo bootstrap of the bar returns for total-return confidence bands. */ monteCarlo?: { iterations?: number; seed?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarlo?: { iterations?: number; seed?: number; }; default: not declared — Add a seeded Monte-Carlo bootstrap of the bar returns for total-return confidence bands. - monteCarlo.iterations?: number; default: not declared - monteCarlo.seed?: number; default: not declared ### @insiderfinance/totalfinance/backtest#TimeInForce Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type TimeInForce = 'day' | 'gtc'; ``` ### @insiderfinance/totalfinance/backtest#Trade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A filled trade. `quantity` is always positive; `side` carries the direction (core `OrderSide`, B6). ```typescript /** A filled trade. `quantity` is always positive; `side` carries the direction (core `OrderSide`, B6). */ export interface Trade { symbol: SymbolId; timestampMs: EpochMs; side: OrderSide; /** Filled quantity (> 0). */ quantity: number; /** Fill price *after* slippage. */ price: number; /** Commission charged on this fill. */ commission: number; /** Slippage cost (signed against the trader) embedded in `price` vs the reference. */ slippage: number; /** * Contract multiplier of the instrument traded — `1` for a share, the registered option's * multiplier (default 100) for an option symbol. Cash value of the fill is * `quantity · price · multiplier`; turnover and realized-P&L attribution apply it or a * 100×-multiplier option trade is reported at 1% of its true size. Every engine stamps it — * the share-only loops (vectorized, cross-sectional) stamp `1` by construction — so no reader * has to guess what an absent field meant. */ multiplier: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: number; default: not declared — Commission charged on this fill. - multiplier: number; default: not declared — Contract multiplier of the instrument traded — `1` for a share, the registered option's multiplier (default 100) for an option symbol. Cash value of the fill is `quantity · price · multiplier`; turnover and realized-P&L attribution apply it or a 100×-multiplier option trade is reported at 1% of its true size. Every engine stamps it — the share-only loops (vectorized, cross-sectional) stamp `1` by construction — so no reader has to guess what an absent field meant. - price: number; default: not declared — Fill price *after* slippage. - quantity: number; default: not declared — Filled quantity (> 0). - side: OrderSide; default: not declared - slippage: number; default: not declared — Slippage cost (signed against the trader) embedded in `price` vs the reference. - symbol: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest#TradeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sizing + order parameters for `context.buy` / `context.sell`. ```typescript /** Sizing + order parameters for `context.buy` / `context.sell`. */ export interface TradeOptions { /** Incremental share quantity. */ quantity?: number; /** Target allocation as a fraction of equity (a *target*, e.g. `1` = 100% long for `buy`). */ percent?: number; /** Incremental notional value (shares = value / price). */ value?: number; type?: OrderType; limitPrice?: number; stopPrice?: number; timeInForce?: TimeInForce; takeProfit?: number; stopLoss?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - limitPrice?: number; default: not declared - percent?: number; default: not declared — Target allocation as a fraction of equity (a *target*, e.g. `1` = 100% long for `buy`). - quantity?: number; default: not declared — Incremental share quantity. - stopLoss?: number; default: not declared - stopPrice?: number; default: not declared - takeProfit?: number; default: not declared - timeInForce?: TimeInForce; default: not declared - type?: OrderType; default: not declared - value?: number; default: not declared — Incremental notional value (shares = value / price). ### @insiderfinance/totalfinance/backtest#TradeStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TradeStatistics { count: number; totalCommission: number; totalSlippage: number; turnover: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - totalCommission: number; default: not declared - totalSlippage: number; default: not declared - turnover: number; default: not declared ### @insiderfinance/totalfinance/backtest#TradingEnvironment Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The familiar `reset` / `step` contract over the frozen simulator. ```typescript /** The familiar `reset` / `step` contract over the frozen simulator. */ export interface TradingEnvironment { /** The definition's identity, seed excluded. */ readonly definitionHash: string; /** The decision instants an episode steps through. */ readonly instantCount: number; reset(options?: EnvironmentResetOptions): EnvironmentResetResult; step(action: EnvironmentAction): EnvironmentStepResult; /** The engine's own result over the episode so far — the same shape `portfolioBacktest` returns; ends the episode. */ finish(): PortfolioBacktestResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - definitionHash: string; default: not declared — The definition's identity, seed excluded. - finish: () => PortfolioBacktestResult; default: not declared — The engine's own result over the episode so far — the same shape `portfolioBacktest` returns; ends the episode. - finish().return.assumptions: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestAssumptions; default: not declared - finish().return.diagnostics: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestDiagnostics; default: not declared - finish().return.events: PortfolioEventEnvelope[]; default: not declared - finish().return.fills: NormalizedFill[]; default: not declared - finish().return.finalValue: number; default: not declared - finish().return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - finish().return.liquidations: LiquidationRow[]; default: not declared - finish().return.orders: import('@insiderfinance/totalfinance/backtest/portfolio').OrderRecord[]; default: not declared - finish().return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - finish().return.pnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult | null; default: not declared - finish().return.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - finish().return.pnl.assumptions.conventionsVersion: string; default: not declared - finish().return.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - finish().return.pnl.assumptions.identity: string; default: not declared — The identity, stated. - finish().return.pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - finish().return.pnl.assumptions.residualTolerance: number; default: not declared - finish().return.pnl.baseCurrency: string; default: not declared - finish().return.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - finish().return.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - finish().return.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - finish().return.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - finish().return.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - finish().return.pnl.diagnostics.warnings: string[]; default: not declared - finish().return.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - finish().return.pnl.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - finish().return.pnl.from.asOf: number; default: not declared - finish().return.pnl.from.netAssetValue: number; default: not declared - finish().return.pnl.from.valuationDate: string; default: not declared - finish().return.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - finish().return.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - finish().return.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - finish().return.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - finish().return.pnl.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - finish().return.pnl.to.asOf: number; default: not declared - finish().return.pnl.to.netAssetValue: number; default: not declared - finish().return.pnl.to.valuationDate: string; default: not declared - finish().return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - finish().return.rejections: import('@insiderfinance/totalfinance/backtest/portfolio').RejectionRow[]; default: not declared - finish().return.returns: number[]; default: not declared - finish().return.runId: string; default: not declared - finish().return.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult | null; default: not declared - finish().return.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - finish().return.timeline.assumptions.conventionsVersion: string; default: not declared - finish().return.timeline.assumptions.exposureConvention: string; default: not declared - finish().return.timeline.assumptions.indexConvention: string; default: not declared - finish().return.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - finish().return.timeline.assumptions.markInstant: string; default: not declared - finish().return.timeline.baseCurrency: string; default: not declared - finish().return.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - finish().return.timeline.cumulativePnl.financing: number; default: not declared - finish().return.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - finish().return.timeline.cumulativePnl.income: number; default: not declared - finish().return.timeline.cumulativePnl.realizedPnl: number; default: not declared - finish().return.timeline.cumulativePnl.residual: number; default: not declared - finish().return.timeline.cumulativePnl.totalPnl: number; default: not declared - finish().return.timeline.cumulativePnl.transactionCosts: number; default: not declared - finish().return.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - finish().return.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - finish().return.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - finish().return.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - finish().return.timeline.diagnostics.markCount: number; default: not declared - finish().return.timeline.diagnostics.warnings: string[]; default: not declared - finish().return.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - finish().return.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - finish().return.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - finish().return.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - finish().return.valuationMarks: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared - instantCount: number; default: not declared — The decision instants an episode steps through. - reset: (options?: EnvironmentResetOptions) => EnvironmentResetResult; default: not declared - reset().return.episode: EpisodeInformation; default: not declared - reset().return.identity: EnvironmentIdentity; default: not declared - reset().return.observation: EnvironmentObservation; default: not declared - reset().return.reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - reset().return.terminated: boolean; default: not declared — An episode can be over at reset: a single instant, insolvency, or a limit breached at the start. - reset().return.truncated: boolean; default: not declared - reset(options)?: EnvironmentResetOptions | undefined; default: not declared - reset(options).seed?: number; default: not declared — Overrides the definition's seed for this episode; part of the run identity. - step: (action: EnvironmentAction) => EnvironmentStepResult; default: not declared - step().return.diagnostics: { acceptedCount: number; cancelledCount: number; carriedCount: number; openOrderCount: number; rationaleTruncated: boolean; rejectedCount: number; }; default: not declared - step().return.diagnostics.acceptedCount: number; default: not declared - step().return.diagnostics.cancelledCount: number; default: not declared - step().return.diagnostics.carriedCount: number; default: not declared — Orders carried into the next instant because the market did not resolve them. - step().return.diagnostics.openOrderCount: number; default: not declared - step().return.diagnostics.rationaleTruncated: boolean; default: not declared - step().return.diagnostics.rejectedCount: number; default: not declared - step().return.events: PortfolioEventEnvelope[]; default: not declared - step().return.fills: NormalizedFill[]; default: not declared - step().return.identity: EnvironmentIdentity; default: not declared - step().return.liquidations: LiquidationRow[]; default: not declared - step().return.observation: EnvironmentObservation; default: not declared - step().return.reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared — Why the episode ended, when it did. - step().return.rejections: EnvironmentRejection[]; default: not declared - step().return.reward: RewardBreakdown; default: not declared - step().return.terminated: boolean; default: not declared — An economic or policy terminal state was reached. - step().return.truncated: boolean; default: not declared — The data boundary or the step bound was reached. - step().return.warnings: QuantWarning[]; default: not declared - step(action): EnvironmentAction; default: not declared - step(action).cancel?: readonly string[]; default: not declared - step(action).kind: ('hold') | ('orders'); default: not declared - step(action).orders: readonly EnvironmentOrder[]; default: not declared - step(action).rationale?: string; default: not declared ### @insiderfinance/totalfinance/backtest#TradingEnvironmentDefinition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What an environment simulates: the stepper's request plus the episode bound, the limits, the reward, the features. ```typescript /** What an environment simulates: the stepper's request plus the episode bound, the limits, the reward, the features. */ export interface TradingEnvironmentDefinition extends PortfolioStepperRequest { /** The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). */ maximumSteps?: number; limits?: EnvironmentLimits; reward?: RewardComposition; features?: FeatureRecipes; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - accounting.baseCurrency: string; default: not declared - accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - accounting.lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Default `'fifo'`. - accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - execution.costs.borrow.label: string; default: not declared - execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - execution.costs.commission.commission(input).price: number; default: not declared - execution.costs.commission.commission(input).quantity: number; default: not declared - execution.costs.commission.label: string; default: not declared - execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - execution.costs.latency.label: string; default: not declared - execution.costs.latency.sessions: number; default: not declared - execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - execution.costs.marketImpact.impact(input).quantity: number; default: not declared - execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - execution.costs.marketImpact.label: string; default: not declared - execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - execution.costs.slippage.fill(input).quantity: number; default: not declared - execution.costs.slippage.fill(input).referencePrice: number; default: not declared - execution.costs.slippage.fill(input).side: OrderSide; default: not declared - execution.costs.slippage.label: string; default: not declared - execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - execution.costs.spread.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - execution.costs.spread.halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - execution.costs.spread.halfSpread(input).side: OrderSide; default: not declared - execution.costs.spread.label: string; default: not declared - execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - execution.fill.fill().return.detail?: string; default: not declared - execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - execution.fill.fill().return.pricePerUnit: number; default: not declared - execution.fill.fill().return.quantity: number; default: not declared - execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - execution.fill.label: string; default: not declared - execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared — Echoed in every result's assumptions. - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - features?: FeatureRecipes; default: not declared - features.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - features.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - features.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - features.realizedVolatility.annualization: number; default: not declared - features.realizedVolatility.lookbacks: readonly number[]; default: not declared - instruments: Readonly>; default: not declared - limits?: EnvironmentLimits; default: not declared - limits.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. - limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - limits.maximumPositionNotional?: number; default: not declared — Base currency, per instrument: the largest absolute position value an order may project. - limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - limits.onBreach?: 'terminate' | 'reject-and-continue'; default: not declared — What a post-trade breach does: end the episode (default) or record it and continue. - marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - marketData.bars?: readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - marketData.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared - marketData.coupons?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').CouponRecord[]; default: not declared - marketData.dividends?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DividendRecord[]; default: not declared - marketData.forwardRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - marketData.fundingRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').FundingRateRecord[]; default: not declared - marketData.fxRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - marketData.optionChains?: readonly import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot[]; default: not declared - marketData.orderBooks?: readonly import('@insiderfinance/totalfinance/core').OrderBook[]; default: not declared - marketData.quotes?: readonly import('@insiderfinance/totalfinance/core').Quote[]; default: not declared - marketData.trades?: readonly import('@insiderfinance/totalfinance/core').Trade[]; default: not declared - maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - periodsPerYear?: number; default: not declared - reward?: RewardComposition; default: not declared - reward.benchmark?: { instrumentId: string; weight: number; }; default: not declared — On the step return minus the named instrument's bar return over the step. - reward.benchmark.instrumentId: string; default: not declared - reward.benchmark.weight: number; default: not declared - reward.concentration?: number; default: not declared — On the largest absolute position weight after the step. - reward.cost?: number; default: not declared — On commissions, fees, and slippage ÷ NAV before the step. - reward.drawdown?: number; default: not declared — On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). - reward.goal?: (frame: RewardFrame) => Record; default: not declared — Extra named terms (weight 1 each); a callback, so the definition is not replayable. - reward.goal(frame): RewardFrame; default: not declared - reward.goal(frame).asOf: number; default: not declared - reward.goal(frame).benchmarkReturn: number | null; default: not declared — The benchmark instrument's bar-close return over the step, or null without two closes. - reward.goal(frame).costs: number; default: not declared — Σ commission + fees + slippage adjustment of the step's fills, base currency. - reward.goal(frame).drawdownAfter: number; default: not declared - reward.goal(frame).drawdownBefore: number; default: not declared — 1 − NAV ÷ running peak, before and after the step. - reward.goal(frame).fills: readonly NormalizedFill[]; default: not declared - reward.goal(frame).grossExposure: number; default: not declared - reward.goal(frame).largestPositionWeight: number; default: not declared - reward.goal(frame).netAssetValueAfter: number; default: not declared - reward.goal(frame).netAssetValueBefore: number; default: not declared - reward.goal(frame).positions: readonly SessionPosition[]; default: not declared - reward.goal(frame).step: number; default: not declared - reward.goal(frame).stepReturn: number; default: not declared — Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). - reward.goal(frame).tradedNotional: number; default: not declared — Σ |quantity × price × multiplier| of the step's fills, base currency. - reward.goal(frame).violations: number; default: not declared — Limit breaches plus disallowed orders in the step. - reward.leverage?: number; default: not declared — On gross exposure ÷ NAV after the step. - reward.pnl?: number; default: not declared — On the step's net return, Δ NAV ÷ NAV before the step. - reward.riskViolation?: number; default: not declared — On the count of limit breaches and disallowed orders in the step. - reward.turnover?: number; default: not declared — On traded notional ÷ NAV before the step. - seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - window.fromTimestampMs?: number; default: not declared - window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest#VectorizedOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VectorizedOptions { /** Price bars in ascending time order. */ data: Bar[]; /** * Target exposure per bar, aligned to `data`. A boolean is long (`1`) / flat (`0`); a number is a * target weight (fraction of equity; negative = short), clamped to `maxLeverage`. * * Accepts a warmup-aware {@link SeriesSignal} (`{ value, warmup }`, e.g. a `technicalAnalysis.*.explain(...)` * result) so an indicator's leading warmup NaNs are treated as flat (position 0) instead of * throwing. A bare `number[]`/`Float64Array` has an implicit `warmup` of 0, so any NaN in it still * throws (a genuine mid-series NaN is a real error, not warmup). */ signal: ArrayLike | SeriesSignal | EnvelopeSignal; /** Rebalance calendar (default `everyBar`). */ rebalance?: RebalanceRule; /** Commission model (default `fees.none()`). */ fees?: CostModel; /** Slippage model (default `slippage.none()`). */ slippage?: SlippageModel; /** Short borrow-fee model (default `borrow.none()`). */ borrow?: BorrowModel; /** Opening capital (default 1). */ initialCapital?: number; /** Bars per year, for annualized metrics (default 252). */ periodsPerYear?: number; /** Per-asset gross weight cap applied to the signal (default 1). */ maxLeverage?: number; /** Bars between observing the signal and trading on it; ≥ 1 avoids look-ahead (default 1). */ executionLag?: number; /** Annualized risk-free rate for Sharpe/Sortino (default 0). */ riskFreeRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - borrow?: BorrowModel; default: not declared — Short borrow-fee model (default `borrow.none()`). - borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - borrow.label: string; default: not declared - data: Bar[]; default: not declared — Price bars in ascending time order. - executionLag?: number; default: not declared — Bars between observing the signal and trading on it; ≥ 1 avoids look-ahead (default 1). - fees?: CostModel; default: not declared — Commission model (default `fees.none()`). - fees.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - fees.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - fees.commission(input).price: number; default: not declared - fees.commission(input).quantity: number; default: not declared - fees.label: string; default: not declared - initialCapital?: number; default: not declared — Opening capital (default 1). - maxLeverage?: number; default: not declared — Per-asset gross weight cap applied to the signal (default 1). - periodsPerYear?: number; default: not declared — Bars per year, for annualized metrics (default 252). - rebalance?: RebalanceRule; default: not declared — Rebalance calendar (default `everyBar`). - riskFreeRate?: number; default: not declared — Annualized risk-free rate for Sharpe/Sortino (default 0). - signal: ArrayLike | SeriesSignal | EnvelopeSignal; default: not declared — Target exposure per bar, aligned to `data`. A boolean is long (`1`) / flat (`0`); a number is a target weight (fraction of equity; negative = short), clamped to `maxLeverage`. Accepts a warmup-aware {@link SeriesSignal} (`{ value, warmup }`, e.g. a `technicalAnalysis.*.explain(...)` result) so an indicator's leading warmup NaNs are treated as flat (position 0) instead of throwing. A bare `number[]`/`Float64Array` has an implicit `warmup` of 0, so any NaN in it still throws (a genuine mid-series NaN is a real error, not warmup). - signal.diagnostics: { warmup: number; }; default: not declared - signal.diagnostics.warmup: number; default: not declared - signal.value: ArrayLike; default: not declared — Per-bar signal values, aligned to the price bars. - signal.warmup: number; default: not declared — Count of leading bars that may be non-finite by design (the indicator's warmup). - slippage?: SlippageModel; default: not declared — Slippage model (default `slippage.none()`). - slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - slippage.fill(input).quantity: number; default: not declared - slippage.fill(input).referencePrice: number; default: not declared - slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - slippage.label: string; default: not declared ### @insiderfinance/totalfinance/backtest#WalkForwardOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WalkForwardOptions { /** Bars in ascending time order (one symbol, or a pre-sorted multi-symbol stream). */ data: Bar[]; /** Training window length in bars. */ trainSize: number; /** Test (out-of-sample) window length in bars. */ testSize: number; /** Step between successive windows (default `testSize`, i.e. non-overlapping test windows). */ step?: number; /** `rolling` (sliding train window) or `anchored` (train grows from the start). Default `rolling`. */ mode?: 'rolling' | 'anchored'; /** Run a backtest over a window; return its out-of-sample result. */ run: (window: WalkForwardWindow) => BacktestResult; /** Bars per year for the stitched performance (default 252). */ periodsPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - data: Bar[]; default: not declared — Bars in ascending time order (one symbol, or a pre-sorted multi-symbol stream). - mode?: 'rolling' | 'anchored'; default: not declared — `rolling` (sliding train window) or `anchored` (train grows from the start). Default `rolling`. - periodsPerYear?: number; default: not declared — Bars per year for the stitched performance (default 252). - run: (window: WalkForwardWindow) => BacktestResult; default: not declared — Run a backtest over a window; return its out-of-sample result. - run().return.assumptions: BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - run().return.diagnostics: import('@insiderfinance/totalfinance/backtest').ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - run().return.finalValue: number; default: not declared — Final portfolio value. - run().return.performance: PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - run().return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - run().return.returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - run().return.settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - run().return.trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Every filled trade, in order. - run().return.turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. - run(window): WalkForwardWindow; default: not declared - run(window).test: Bar[]; default: not declared - run(window).train: Bar[]; default: not declared - step?: number; default: not declared — Step between successive windows (default `testSize`, i.e. non-overlapping test windows). - testSize: number; default: not declared — Test (out-of-sample) window length in bars. - trainSize: number; default: not declared — Training window length in bars. ### @insiderfinance/totalfinance/backtest#WalkForwardResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WalkForwardResult { /** The per-window out-of-sample results, in order, each tagged with its train/test ranges. */ windows: WalkForwardWindowResult[]; /** Out-of-sample equity stitched across all test windows (starts at 1). */ equityCurve: number[]; /** Performance of the stitched out-of-sample curve. */ performance: PerformanceSummary; /** * The echoed modelling assumptions, identical across windows (same engine/config) — taken from the * first window, so the walk-forward artifact carries the same honesty story as a single backtest * (WS2.8 / dx §2.5). */ assumptions: BacktestAssumptions; /** Core diagnostics: the union of every window's warnings, deduped by code + message (WS2.8). */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: BacktestAssumptions; default: not declared — The echoed modelling assumptions, identical across windows (same engine/config) — taken from the first window, so the walk-forward artifact carries the same honesty story as a single backtest (WS2.8 / dx §2.5). - assumptions.assignment?: string; default: not declared — American early exercise/assignment policy: `model` or `none` (WS7.4). Absent where inapplicable. - assumptions.calendar: string; default: not declared — Rebalancing/trading calendar, e.g. `every-bar`, `monthly`, `signal-driven`. - assumptions.cashSettlement: string; default: not declared — Cash settlement assumption, e.g. `immediate` (T+0). - assumptions.conventionsVersion: string; default: not declared — Version of the library's default conventions (core `CONVENTIONS_VERSION`). - assumptions.corporateAction: string; default: not declared — Corporate-action handling, e.g. `dividends-as-cash`, `splits-adjusted`, `none`. - assumptions.cost: string; default: not declared — Commission model applied, e.g. `bps(1)`, `per-share(0.005)`, `none`. - assumptions.fill: string; default: not declared — When/at what price orders fill, e.g. `next-open`, `close`, `trigger-price`. - assumptions.initialCapital: number; default: not declared — Opening capital the run started from. - assumptions.margin: string; default: not declared — Leverage/margin regime: `unconstrained` (no cap; unfunded fills allowed) or `maxLeverage`. - assumptions.oco?: string; default: not declared — How an OCO group resolves a bar that touches BOTH legs. One bar cannot say which trigger came first, and the engine's answer — the take-profit, because a bracket submits it before the stop-loss and orders fill in submission order — is optimistic. It is disclosed here rather than left as an undocumented mechanic (`take-profit-first-on-ambiguous-bar`). Absent for engines with no order book (the vectorized loop). - assumptions.slippage: string; default: not declared — Slippage model applied, e.g. `bps(2)`, `spread`, `none`. - diagnostics: Diagnostics; default: not declared — Core diagnostics: the union of every window's warnings, deduped by code + message (WS2.8). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - equityCurve: number[]; default: not declared — Out-of-sample equity stitched across all test windows (starts at 1). - performance: PerformanceSummary; default: not declared — Performance of the stitched out-of-sample curve. - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - windows: WalkForwardWindowResult[]; default: not declared — The per-window out-of-sample results, in order, each tagged with its train/test ranges. ### @insiderfinance/totalfinance/backtest#WalkForwardWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WalkForwardWindow { train: Bar[]; test: Bar[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - test: Bar[]; default: not declared - train: Bar[]; default: not declared ### @insiderfinance/totalfinance/backtest#WalkForwardWindowResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A per-window out-of-sample result, tagged with the train/test time ranges it covered (WS2.8). ```typescript /** A per-window out-of-sample result, tagged with the train/test time ranges it covered (WS2.8). */ export interface WalkForwardWindowResult extends BacktestResult { /** `[firstTrainBarTs, lastTrainBarTs]`. */ trainRange: [ EpochMs, EpochMs ]; /** `[firstTestBarTs, lastTestBarTs]`. */ testRange: [ EpochMs, EpochMs ]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - assumptions.assignment?: string; default: not declared — American early exercise/assignment policy: `model` or `none` (WS7.4). Absent where inapplicable. - assumptions.calendar: string; default: not declared — Rebalancing/trading calendar, e.g. `every-bar`, `monthly`, `signal-driven`. - assumptions.cashSettlement: string; default: not declared — Cash settlement assumption, e.g. `immediate` (T+0). - assumptions.conventionsVersion: string; default: not declared — Version of the library's default conventions (core `CONVENTIONS_VERSION`). - assumptions.corporateAction: string; default: not declared — Corporate-action handling, e.g. `dividends-as-cash`, `splits-adjusted`, `none`. - assumptions.cost: string; default: not declared — Commission model applied, e.g. `bps(1)`, `per-share(0.005)`, `none`. - assumptions.fill: string; default: not declared — When/at what price orders fill, e.g. `next-open`, `close`, `trigger-price`. - assumptions.initialCapital: number; default: not declared — Opening capital the run started from. - assumptions.margin: string; default: not declared — Leverage/margin regime: `unconstrained` (no cap; unfunded fills allowed) or `maxLeverage`. - assumptions.oco?: string; default: not declared — How an OCO group resolves a bar that touches BOTH legs. One bar cannot say which trigger came first, and the engine's answer — the take-profit, because a bracket submits it before the stop-loss and orders fill in submission order — is optimistic. It is disclosed here rather than left as an undocumented mechanic (`take-profit-first-on-ambiguous-bar`). Absent for engines with no order book (the vectorized loop). - assumptions.slippage: string; default: not declared — Slippage model applied, e.g. `bps(2)`, `spread`, `none`. - diagnostics: import('@insiderfinance/totalfinance/backtest').ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.benchmarkFixtureVersion: string; default: not declared — The benchmark fixture version this engine was validated against. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - finalValue: number; default: not declared — Final portfolio value. - performance: PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - testRange: [number, number]; default: not declared — `[firstTestBarTs, lastTestBarTs]`. - trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Every filled trade, in order. - trainRange: [number, number]; default: not declared — `[firstTrainBarTs, lastTrainBarTs]`. - turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. ### @insiderfinance/totalfinance/backtest#WeightContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a supplied-weights callback sees. ```typescript /** What a supplied-weights callback sees. */ export interface WeightContext { asOf: EpochMs; sessionDate: string; long: readonly SignalRow[]; short: readonly SignalRow[]; /** Trailing per-session returns per selected name, oldest first (as many as available). */ trailingReturns: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - long: readonly SignalRow[]; default: not declared - sessionDate: string; default: not declared - short: readonly SignalRow[]; default: not declared - trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). ### @insiderfinance/totalfinance/backtest#WeightingMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type WeightingMethod = 'equal-weight' | 'score-weight' | 'inverse-volatility' | 'risk-budget' | 'supplied-weights'; ``` ### @insiderfinance/totalfinance/backtest#agentBaselines Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const agentBaselines: Readonly<{ holdCash: () => BaselinePolicy; buyAndHold: (input?: { weights?: Readonly>; }) => BaselinePolicy; periodicRebalance: (input: { everySessions: number; weights?: Readonly>; }) => BaselinePolicy; randomValidAction: (seed: number) => BaselinePolicy; riskParity: (input: { lookback: number; everySessions?: number; }) => BaselinePolicy; momentumCrossover: (input: { fast: number; slow: number; }) => BaselinePolicy; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buyAndHold: (input?: { weights?: Readonly>; }) => BaselinePolicy; default: not declared - buyAndHold().return.decide: TradingPolicy; default: not declared - buyAndHold().return.label: string; default: not declared - buyAndHold().return.requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - buyAndHold().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - buyAndHold().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - buyAndHold().return.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - buyAndHold().return.requires.realizedVolatility.annualization: number; default: not declared - buyAndHold().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - buyAndHold(input)?: { weights?: Readonly>; } | undefined; default: not declared - buyAndHold(input).weights?: Readonly>; default: not declared - holdCash: () => BaselinePolicy; default: not declared - holdCash().return.decide: TradingPolicy; default: not declared - holdCash().return.label: string; default: not declared - holdCash().return.requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - holdCash().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - holdCash().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - holdCash().return.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - holdCash().return.requires.realizedVolatility.annualization: number; default: not declared - holdCash().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - momentumCrossover: (input: { fast: number; slow: number; }) => BaselinePolicy; default: not declared - momentumCrossover().return.decide: TradingPolicy; default: not declared - momentumCrossover().return.label: string; default: not declared - momentumCrossover().return.requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - momentumCrossover().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - momentumCrossover().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - momentumCrossover().return.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - momentumCrossover().return.requires.realizedVolatility.annualization: number; default: not declared - momentumCrossover().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - momentumCrossover(input): { fast: number; slow: number; }; default: not declared - momentumCrossover(input).fast: number; default: not declared - momentumCrossover(input).slow: number; default: not declared - periodicRebalance: (input: { everySessions: number; weights?: Readonly>; }) => BaselinePolicy; default: not declared - periodicRebalance().return.decide: TradingPolicy; default: not declared - periodicRebalance().return.label: string; default: not declared - periodicRebalance().return.requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - periodicRebalance().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - periodicRebalance().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - periodicRebalance().return.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - periodicRebalance().return.requires.realizedVolatility.annualization: number; default: not declared - periodicRebalance().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - periodicRebalance(input): { everySessions: number; weights?: Readonly>; }; default: not declared - periodicRebalance(input).everySessions: number; default: not declared - periodicRebalance(input).weights?: Readonly>; default: not declared - randomValidAction: (seed: number) => BaselinePolicy; default: not declared - randomValidAction().return.decide: TradingPolicy; default: not declared - randomValidAction().return.label: string; default: not declared - randomValidAction().return.requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - randomValidAction().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - randomValidAction().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - randomValidAction().return.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - randomValidAction().return.requires.realizedVolatility.annualization: number; default: not declared - randomValidAction().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - randomValidAction(seed): number; default: not declared - riskParity: (input: { lookback: number; everySessions?: number; }) => BaselinePolicy; default: not declared - riskParity().return.decide: TradingPolicy; default: not declared - riskParity().return.label: string; default: not declared - riskParity().return.requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - riskParity().return.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - riskParity().return.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - riskParity().return.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - riskParity().return.requires.realizedVolatility.annualization: number; default: not declared - riskParity().return.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - riskParity(input): { everySessions?: number; lookback: number; }; default: not declared - riskParity(input).everySessions?: number; default: not declared - riskParity(input).lookback: number; default: not declared ### @insiderfinance/totalfinance/backtest#attribution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-symbol realized P&L attribution (average-cost matched) from a trade blotter (report-shaped). ```typescript export declare function attribution(trades: Trade[]): AttributionReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (trades): Trade[]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.bySymbol: SymbolAttribution[]; default: not declared — Realized P&L per symbol (average-cost matched), in first-trade order. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/backtest#borrow Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Borrow-fee models for shorts. ```typescript export declare const borrow: { readonly annualRate: (annualRate: number) => BorrowModel; readonly none: () => BorrowModel; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualRate: (annualRate: number) => BorrowModel; default: not declared — A flat annualized borrow rate charged on the short market value. - annualRate().return.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - annualRate().return.label: string; default: not declared - annualRate(annualRate): number; default: not declared - none: () => BorrowModel; default: not declared — No borrow fee. - none().return.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - none().return.label: string; default: not declared ### @insiderfinance/totalfinance/backtest#brokers Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Broker factory (spec §16.2: `brokers.simulated({ cash, commission, slippage })`). ```typescript export declare const brokers: { readonly simulated: (config: BrokerConfig) => SimulatedBroker; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - simulated: (config: BrokerConfig) => SimulatedBroker; default: not declared — Construct a simulated broker. - simulated().return.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - simulated().return.cash: number; default: not declared - simulated().return.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - simulated().return.exerciseOption: (input: ExerciseOptionInput) => OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - simulated().return.orders: readonly Order[]; default: not declared — All orders ever submitted (live view, readonly). - simulated().return.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - simulated().return.position: (symbol: SymbolId) => Position; default: not declared - simulated().return.positions: Map; default: not declared - simulated().return.processBar: (bar: Bar, action?: CorporateAction) => Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - simulated().return.registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - simulated().return.settleExpiries: (asOfTimestampMs: EpochMs, underlierMarks?: Map) => OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - simulated().return.settlements: readonly OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - simulated().return.submit: (request: OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - simulated().return.trades: readonly Trade[]; default: not declared — All fills (live view, readonly). - simulated().return.warnings: readonly QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - simulated(config): BrokerConfig; default: not declared - simulated(config).assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - simulated(config).assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - simulated(config).borrow?: BorrowModel; default: not declared - simulated(config).cash: number; default: not declared — Opening cash. - simulated(config).commission?: CostModel; default: not declared - simulated(config).maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - simulated(config).maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - simulated(config).noShort?: boolean; default: not declared — Disallow short positions (default `false`). - simulated(config).periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - simulated(config).riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - simulated(config).slippage?: SlippageModel; default: not declared ### @insiderfinance/totalfinance/backtest#checkDataAlignment Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Check that each symbol's bars are strictly time-ascending with finite positive prices. Returns structured warnings for out-of-order timestamps, duplicate timestamps, and non-finite/non-positive closes — the silent corruptions that make a backtest quietly wrong. ```typescript export declare function checkDataAlignment(bars: Bar[]): QuantWarning[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): Bar[]; default: not declared ### @insiderfinance/totalfinance/backtest#createPortfolioStepper Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The engine's seam (Stage 7B.1, Decision 2): the same per-instant loop `portfolioBacktest` runs, driven from outside. `open(index)` stamps the clock, folds pre-open entitlements and external flows, and returns a pre-execution context valued at opening or last-completed marks (the mark source identifies carried prices). `close(index, orders)` executes the caller's orders through the execution policy, settles close-derived derivative lifecycle, runs the margin check, records the valuation mark and the equity, and returns the rows the step appended; `finish()` assembles the same result `portfolioBacktest` returns over the instants closed so far. Calls must alternate `open(0)`, `close(0)`, `open(1)`, … — an out-of-order call refuses and changes nothing; `finish()` may be called again and returns the same result. The orders come from the caller, so the result records `strategy: { kind: 'external', replayable: false }`; a trading environment saves its own action trace to make an episode replayable. ```typescript export declare function createPortfolioStepper(request: PortfolioStepperRequest): PortfolioStepper; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): PortfolioStepperRequest; default: not declared - (request).accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - (request).calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - (request).execution?: ExecutionPolicy; default: not declared - (request).externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - (request).instruments: Readonly>; default: not declared - (request).marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - (request).periodsPerYear?: number; default: not declared - (request).seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - (request).window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - (request).window.fromTimestampMs?: number; default: not declared - (request).window.toTimestampMs?: number; default: not declared - return.close: (index: number, orders: readonly OrderIntent[]) => PortfolioStepFrame; default: not declared — The orders through the execution policy, the margin check, the valuation mark, the equity. - return.context: () => SessionContext; default: not declared — The session context at the last closed instant — the state after its orders, margin, and mark. - return.finish: () => PortfolioBacktestResult; default: not declared — The same result `portfolioBacktest` returns, over the instants closed so far. - return.instants: readonly number[]; default: not declared — The decision instants, ascending — the same instants `portfolioBacktest` would step. - return.open: (index: number) => SessionContext; default: not declared — Lifecycle facts and external flows due at the instant, then the session context. - return.runId: string; default: not declared - return.valuation: () => PortfolioValuationInputs; default: not declared — The ledger state, the market snapshot, the conversions, and the valued snapshot at the last closed instant. ### @insiderfinance/totalfinance/backtest#createTradingEnvironment Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function createTradingEnvironment(definition: TradingEnvironmentDefinition): TradingEnvironment; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definition): TradingEnvironmentDefinition; default: not declared - (definition).accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - (definition).calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - (definition).execution?: ExecutionPolicy; default: not declared - (definition).externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - (definition).features?: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes; default: not declared - (definition).instruments: Readonly>; default: not declared - (definition).limits?: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentLimits; default: not declared - (definition).marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - (definition).maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - (definition).periodsPerYear?: number; default: not declared - (definition).reward?: import('@insiderfinance/totalfinance/backtest/environment').RewardComposition; default: not declared - (definition).seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - (definition).window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - (definition).window.fromTimestampMs?: number; default: not declared - (definition).window.toTimestampMs?: number; default: not declared - return.definitionHash: string; default: not declared — The definition's identity, seed excluded. - return.finish: () => PortfolioBacktestResult; default: not declared — The engine's own result over the episode so far — the same shape `portfolioBacktest` returns; ends the episode. - return.instantCount: number; default: not declared — The decision instants an episode steps through. - return.reset: (options?: EnvironmentResetOptions) => EnvironmentResetResult; default: not declared - return.step: (action: EnvironmentAction) => EnvironmentStepResult; default: not declared ### @insiderfinance/totalfinance/backtest#crossOver Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). True when series `a` crosses from at-or-below `b` to above it on the latest bar. ```typescript export declare function crossOver(first: IndicatorHandle, second: IndicatorHandle): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): IndicatorHandle; default: not declared - (first).previous: number | null; default: not declared - (first).value: number | null; default: not declared - (second): IndicatorHandle; default: not declared - (second).previous: number | null; default: not declared - (second).value: number | null; default: not declared ### @insiderfinance/totalfinance/backtest#crossOverSeries Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `1` on the bar where `a` crosses from at-or-below `b` to above it (`a[i-1] ≤ b[i-1] && a[i] > b[i]`), else `0`. `NaN` where any of the four inputs (`a`/`b` at `i` or `i-1`) is `NaN`, and at index `0` — a crossing needs a prior bar to compare against. `b` may be a scalar level or an aligned series. ```typescript export declare function crossOverSeries(first: ArrayLike, second: number | ArrayLike): Float64Array; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): ArrayLike; default: not declared - (second): number | ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#crossSectionalBacktest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function crossSectionalBacktest(request: CrossSectionalBacktestRequest): CrossSectionalBacktestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): CrossSectionalBacktestRequest; default: not declared - (request).baseCurrency?: string; default: not declared — Default `'USD'`. - (request).dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - (request).execution?: ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - (request).initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - (request).periodsPerYear?: number; default: not declared — Default 252. - (request).portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - (request).rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - (request).riskFreeRate?: number; default: not declared - (request).seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - (request).signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - (request).transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - (request).transactionCostModel.commission?: CostModel; default: not declared - (request).transactionCostModel.slippage?: SlippageModel; default: not declared - (request).universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - (request).window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - (request).window.fromTimestampMs?: number; default: not declared - (request).window.toTimestampMs?: number; default: not declared - return.assumptions: CrossSectionalAssumptions; default: not declared - return.attribution: import('@insiderfinance/totalfinance/backtest').CrossSectionalAttribution; default: not declared - return.benchmark: BenchmarkComparison | null; default: not declared - return.benchmark.activeReturn: number | null; default: not declared - return.benchmark.alpha: number | null; default: not declared - return.benchmark.beta: number | null; default: not declared - return.benchmark.informationRatio: number | null; default: not declared - return.benchmark.instrumentId: string; default: not declared - return.benchmark.returns: number[]; default: not declared — The benchmark's per-session simple returns aligned to the run's sessions. - return.benchmark.trackingError: number | null; default: not declared - return.diagnostics: CrossSectionalDiagnostics; default: not declared - return.fills: NormalizedFill[]; default: not declared - return.finalValue: number; default: not declared - return.holdings: HoldingRow[]; default: not declared - return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - return.performanceConfidence: { confidenceInterval95: [number, number]; iterations: number; meanTotalReturn: number; seed: number; standardDeviation: number; } | null; default: not declared — Bootstrap confidence intervals of the performance block when a seed was given. - return.performanceConfidence.confidenceInterval95: [number, number]; default: not declared - return.performanceConfidence.iterations: number; default: not declared - return.performanceConfidence.meanTotalReturn: number; default: not declared - return.performanceConfidence.seed: number; default: not declared - return.performanceConfidence.standardDeviation: number; default: not declared - return.points: EquityPoint[]; default: not declared - return.rebalances: RebalanceRow[]; default: not declared - return.returns: number[]; default: not declared - return.runId: string; default: not declared - return.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared - return.trades: Trade[]; default: not declared ### @insiderfinance/totalfinance/backtest#crossSectionalBacktestGrid Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run the cartesian product of `variations` over `request` — each point one `crossSectionalBacktest` call — and compose the research-hygiene verdicts. Every child run is returned whole and index-aligned with `variations`; `sweepId` is the parent hash over the axes and the child hashes. ```typescript export declare function crossSectionalBacktestGrid(gridRequest: CrossSectionalBacktestGridRequest): CrossSectionalBacktestGridResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (gridRequest): CrossSectionalBacktestGridRequest; default: not declared - (gridRequest).hygiene?: { confidence?: number; splits?: number; }; default: not declared - (gridRequest).hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - (gridRequest).hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - (gridRequest).maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - (gridRequest).request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - (gridRequest).selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - (gridRequest).variations: readonly GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - return.assumptions: GridAssumptions; default: not declared - return.best: { index: number; metric: GridSelectionMetric; runId: string; value: number; } | null; default: not declared — The best trial by the selection metric, or `null` when no variation carries the metric. - return.best.index: number; default: not declared - return.best.metric: GridSelectionMetric; default: not declared - return.best.runId: string; default: not declared - return.best.value: number; default: not declared - return.diagnostics: GridDiagnostics; default: not declared - return.hygiene: GridHygiene; default: not declared - return.runs: CrossSectionalBacktestResult[]; default: not declared — Every child run, index-aligned with `variations` — the same function, called once per point. - return.sweepId: string; default: not declared — The parent sweep hash: the content hash of the axes and every child run hash. - return.variations: GridVariationRow[]; default: not declared ### @insiderfinance/totalfinance/backtest#crossSectionalPurgedFolds Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Purged k-fold evaluation of a cross-sectional grid: `purgedKFold` over the session index gives every fold a held-out block, a purge gap on each side, and an embargo after it; the grid chooses a variation on the remaining (possibly two-segment) training sessions, pooled into one curve; the choice runs once on the held-out block. Training segments left with fewer than two sessions after purging are dropped with a warning. ```typescript export declare function crossSectionalPurgedFolds(request: CrossSectionalPurgedFoldsRequest): CrossSectionalOutOfSampleResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): CrossSectionalPurgedFoldsRequest; default: not declared - (request).embargo?: number; default: not declared — `purgedKFold`'s embargo fraction (default 0). - (request).folds: number; default: not declared — Folds (≥ 2, ≤ sessions ÷ 2 so every held-out span carries two sessions). - (request).hygiene?: { confidence?: number; splits?: number; }; default: not declared - (request).hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - (request).hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - (request).maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - (request).purgeGap?: number; default: not declared — `purgedKFold`'s purge gap in sessions on each side of a held-out span (default 0). - (request).request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - (request).selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - (request).variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - return.assumptions: OutOfSampleAssumptions; default: not declared - return.diagnostics: OutOfSampleDiagnostics; default: not declared - return.evaluationId: string; default: not declared — The content hash of the procedure: the grid axes, the fold plan, and every held-out run id. - return.hygiene: OutOfSampleHygiene; default: not declared - return.performance: PerformanceSummary | null; default: not declared — The performance block of the stitched held-out returns; `null` under two returns. - return.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - return.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - return.performance.annualizedVolatility: number | null; default: not declared - return.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - return.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - return.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - return.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - return.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - return.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - return.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - return.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - return.performance.maxDrawdown: number; default: not declared - return.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.periods: number; default: not declared - return.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - return.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - return.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - return.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - return.returns: number[]; default: not declared — Held-out per-session returns stitched in window order. - return.runs: CrossSectionalBacktestResult[]; default: not declared — Every held-out run, index-aligned with the evaluated windows (`windows[i].testRunId !== null`). - return.windows: OutOfSampleWindowRow[]; default: not declared ### @insiderfinance/totalfinance/backtest#crossSectionalWalkForward Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Walk a cross-sectional grid forward: on every training span the grid picks a variation by its selection metric; that variation runs once on the following held-out span; the held-out returns are stitched in order. Rolling (default) or anchored training spans; `step` defaults to `testSessions` so held-out spans tile the data without overlap. ```typescript export declare function crossSectionalWalkForward(request: CrossSectionalWalkForwardRequest): CrossSectionalOutOfSampleResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): CrossSectionalWalkForwardRequest; default: not declared - (request).hygiene?: { confidence?: number; splits?: number; }; default: not declared - (request).hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - (request).hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - (request).maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - (request).mode?: 'rolling' | 'anchored'; default: not declared — `'rolling'` (default): training spans slide; `'anchored'`: every training span starts at the first session. - (request).request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - (request).selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - (request).step?: number; default: not declared — Sessions the window advances by; default `testSessions` (adjacent, non-overlapping held-out spans). - (request).testSessions: number; default: not declared — Sessions in each held-out span (≥ 2). - (request).trainSessions: number; default: not declared — Sessions in each training span (≥ 2). - (request).variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - return.assumptions: OutOfSampleAssumptions; default: not declared - return.diagnostics: OutOfSampleDiagnostics; default: not declared - return.evaluationId: string; default: not declared — The content hash of the procedure: the grid axes, the fold plan, and every held-out run id. - return.hygiene: OutOfSampleHygiene; default: not declared - return.performance: PerformanceSummary | null; default: not declared — The performance block of the stitched held-out returns; `null` under two returns. - return.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - return.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - return.performance.annualizedVolatility: number | null; default: not declared - return.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - return.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - return.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - return.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - return.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - return.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - return.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - return.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - return.performance.maxDrawdown: number; default: not declared - return.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.periods: number; default: not declared - return.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - return.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - return.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - return.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - return.returns: number[]; default: not declared — Held-out per-session returns stitched in window order. - return.runs: CrossSectionalBacktestResult[]; default: not declared — Every held-out run, index-aligned with the evaluated windows (`windows[i].testRunId !== null`). - return.windows: OutOfSampleWindowRow[]; default: not declared ### @insiderfinance/totalfinance/backtest#crossUnder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). True when series `a` crosses from at-or-above `b` to below it on the latest bar. ```typescript export declare function crossUnder(first: IndicatorHandle, second: IndicatorHandle): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): IndicatorHandle; default: not declared - (first).previous: number | null; default: not declared - (first).value: number | null; default: not declared - (second): IndicatorHandle; default: not declared - (second).previous: number | null; default: not declared - (second).value: number | null; default: not declared ### @insiderfinance/totalfinance/backtest#crossUnderSeries Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `1` on the bar where `a` crosses from at-or-above `b` to below it (`a[i-1] ≥ b[i-1] && a[i] < b[i]`), else `0`. `NaN` where any of the four inputs (`a`/`b` at `i` or `i-1`) is `NaN`, and at index `0` — a crossing needs a prior bar to compare against. `b` may be a scalar level or an aligned series. ```typescript export declare function crossUnderSeries(first: ArrayLike, second: number | ArrayLike): Float64Array; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): ArrayLike; default: not declared - (second): number | ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#environmentEpisode Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build one maintained episode from its seed — the definition, the seed, its session count, and its expectations. ```typescript export declare function environmentEpisode(input: { id: EnvironmentEpisodeId; seed?: number; }): EnvironmentEpisode; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { id: EnvironmentEpisodeId; seed?: number; }; default: not declared - (input).id: EnvironmentEpisodeId; default: not declared - (input).seed?: number; default: not declared - return.definition: TradingEnvironmentDefinition; default: not declared - return.description: string; default: not declared - return.expectations: readonly string[]; default: not declared - return.id: EnvironmentEpisodeId; default: not declared - return.seed: number; default: not declared - return.sessions: number; default: not declared — Decision instants the definition yields. - return.title: string; default: not declared ### @insiderfinance/totalfinance/backtest#equityToReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-step simple returns of an equity curve. ```typescript export declare function equityToReturns(equity: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (equity): ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#eventDriven Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run an event-driven backtest. ```typescript export declare function eventDriven(options: EventDrivenOptions): BacktestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): EventDrivenOptions; default: not declared - (options).broker: SimulatedBroker | BrokerConfig; default: not declared — A configured broker, or a config to construct one. - (options).broker.assignment?: 'none' | 'model'; default: not declared — American early exercise/assignment policy (WS7.4). `'none'` (default) settles options only at expiry — every European-style golden is byte-identical. `'model'` options in to modeling early assignment of American short options at ex-dividend dates (short calls) and deep-ITM thresholds (short puts), plus manual `exerciseOption`/`context.exercise` for American longs. - (options).broker.assignmentThreshold?: number; default: not declared — Short-put early-assignment buffer as a FRACTION of strike (default `0.02`): a short put is assigned early when the interest CARRY benefit of exercising now exceeds the remaining extrinsic (time value) by more than `threshold·strike`. Only used when `assignment: 'model'`. - (options).broker.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - (options).broker.cancel: (id: string) => void; default: not declared — Cancel a pending order (and its OCO group). - (options).broker.cash: number; default: not declared — Opening cash. - (options).broker.commission?: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - (options).broker.equity: (marks: Map) => number; default: not declared — Portfolio equity = cash + Σ position market value at the supplied marks (option positions ×multiplier). - (options).broker.exerciseOption: (input: import('@insiderfinance/totalfinance/backtest').ExerciseOptionInput) => import('@insiderfinance/totalfinance/backtest').OptionSettlement; default: not declared — Manually exercise a LONG American option early (WS7.4) — the `context.exercise` hook. `quantity` is the number of contracts (≤ the current long position). Requires the `assignment: 'model'` policy. - (options).broker.maxLeverage?: number; default: not declared — Max gross leverage `Σ|positionNotional| / equity` allowed at fill (default `Infinity`). - (options).broker.maxVolumeParticipation?: number; default: not declared — Cap a single bar's fill to this fraction of bar volume (partial fills); default `Infinity`. - (options).broker.noShort?: boolean; default: not declared — Disallow short positions (default `false`). - (options).broker.orders: readonly import('@insiderfinance/totalfinance/backtest').Order[]; default: not declared — All orders ever submitted (live view, readonly). - (options).broker.periodsPerYear?: number; default: not declared — Bars per year, for borrow accrual (default 252). - (options).broker.policies: () => { cost: string; slippage: string; margin: string; assignment: string; oco: string; }; default: not declared — The policy labels for the implementation-risk diagnostics. - (options).broker.position: (symbol: SymbolId) => Position; default: not declared - (options).broker.positions: Map; default: not declared - (options).broker.processBar: (bar: Bar, action?: CorporateAction) => import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Advance the broker by one bar: apply corporate actions, accrue borrow on shorts, then try to fill every working order for this bar's symbol. Returns this bar's fills. - (options).broker.registerOption: (symbol: SymbolId, specification: OptionContractSpecification) => void; default: not declared — Register an option symbol so the broker marks it by its contract multiplier and settles it at expiry (spec §16.2). Required before trading or settling an option position. - (options).broker.riskFreeRate?: number; default: not declared — Continuously-compounded risk-free rate (decimal, default `0`) used ONLY for the short-put early-assignment carry economics — early put exercise is driven by the interest earned on the strike over the option's remaining life. With rate `0` there is no carry incentive, so a short put is never assigned early on arbitrage-free prices. Only used when `assignment: 'model'`. - (options).broker.settleExpiries: (asOfTimestampMs: EpochMs, underlierMarks?: Map) => import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Settle every registered option whose expiry is at or before `asOfTimestampMs`. ITM long positions are exercised and ITM shorts assigned (physical: the underlier position is adjusted at the strike; cash: the intrinsic is paid/received); OTM positions expire worthless. Returns the new settlements. The underlier settlement price comes from `underlierMarks` or the broker's last seen mark. - (options).broker.settlements: readonly import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry — exercise / assignment / worthless (live view, readonly). - (options).broker.slippage?: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - (options).broker.submit: (request: import('@insiderfinance/totalfinance/backtest').OrderRequest) => string; default: not declared — Submit an order; returns its id. Validates the request. - (options).broker.trades: readonly import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — All fills (live view, readonly). - (options).broker.warnings: readonly import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings raised during simulation (live view, readonly). - (options).corporateActions?: Map; default: not declared — Corporate actions keyed `"@"`. - (options).data: Bar[]; default: not declared — Bars for all symbols (each symbol ascending; the engine sorts the merged stream by `ts`). - (options).periodsPerYear?: number; default: not declared — Bars per year for annualized metrics (default 252). - (options).riskFreeRate?: number; default: not declared — Annualized risk-free rate (default 0). - (options).strategy: (context: StrategyContext) => void; default: not declared — The strategy: registers handlers + indicators against the context. - (options).universe?: 'point-in-time' | 'current'; default: not declared — Whether the symbol universe is `point-in-time` (delisted names included) or `current` (survivorship-biased). Recorded in diagnostics; default `point-in-time`. - return.assumptions: BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - return.diagnostics: ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - return.finalValue: number; default: not declared — Final portfolio value. - return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - return.returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - return.settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - return.trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared — Every filled trade, in order. - return.turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. ### @insiderfinance/totalfinance/backtest#fees Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Commission models. ```typescript export declare const fees: { readonly bps: (bps: number) => CostModel; readonly fixed: (amount: number) => CostModel; readonly none: () => CostModel; readonly perShare: (amountPerShare: number) => CostModel; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bps: (bps: number) => CostModel; default: not declared — Commission as basis points of traded notional (`quantity·price·bps/10000`). - bps().return.commission: (input: CommissionInput) => number; default: not declared - bps().return.label: string; default: not declared - bps(bps): number; default: not declared - fixed: (amount: number) => CostModel; default: not declared — A flat commission per fill, regardless of size. - fixed().return.commission: (input: CommissionInput) => number; default: not declared - fixed().return.label: string; default: not declared - fixed(amount): number; default: not declared - none: () => CostModel; default: not declared — No commission. - none().return.commission: (input: CommissionInput) => number; default: not declared - none().return.label: string; default: not declared - perShare: (amountPerShare: number) => CostModel; default: not declared — Commission per share (`quantity·rate`). - perShare().return.commission: (input: CommissionInput) => number; default: not declared - perShare().return.label: string; default: not declared - perShare(amountPerShare): number; default: not declared ### @insiderfinance/totalfinance/backtest#gtSeries Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `1` where `a[i] > b[i]`, else `0`; `NaN` where either input is `NaN` at `i` (missing data). `b` may be a scalar level (e.g. `gtSeries(rsi, 70)`) or an aligned series. ```typescript export declare function gtSeries(first: ArrayLike, second: number | ArrayLike): Float64Array; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): ArrayLike; default: not declared - (second): number | ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#latchSeries Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Turn discrete **entry/exit events** into a held `{0,1}` **position** series: latch to `1` on an entry event and hold it until an exit event flips it back to `0`. This is the bridge from the cross helpers — which fire `1` on a *single* bar — to a position {@link vectorized } can trade. Feeding a raw {@link crossOverSeries} in as a signal is the classic silent bug: it opens the trade the bar of the cross and *closes it the very next bar*, because every non-crossing bar is `0`. Latch the two crosses together instead (enter on cross-over, exit on cross-under) to hold the trade between them. Any non-zero, finite value in `entries`/`exits` counts as a fire (so `crossOverSeries`/`gtSeries` outputs drop straight in). `NaN` in either input at bar `i` is warmup: the output is `NaN` and the latch is left untouched, matching how the other primitives propagate an indicator's warmup. When an entry and an exit fire on the same bar the **exit wins** (`0`), so a same-bar whipsaw never leaves a phantom position open. ```typescript export declare function latchSeries(entries: ArrayLike, exits: ArrayLike): Float64Array; ``` Example (source JSDoc): Enter long on a 10/30 SMA golden cross, exit on the death cross, hold in between: ```ts const entries = crossOverSeries(fast.value, slow.value); const exits = crossUnderSeries(fast.value, slow.value); const position = latchSeries(entries, exits); // 1 held from golden cross until death cross const warmup = Math.max(fast.diagnostics.warmup, slow.diagnostics.warmup) + 1; vectorized({ data: candles, signal: { value: position, warmup } }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (entries): ArrayLike; default: not declared - (exits): ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#ltSeries Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `1` where `a[i] < b[i]`, else `0`; `NaN` where either input is `NaN` at `i` (missing data). `b` may be a scalar level (e.g. `ltSeries(rsi, 30)`) or an aligned series. ```typescript export declare function ltSeries(first: ArrayLike, second: number | ArrayLike): Float64Array; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): ArrayLike; default: not declared - (second): number | ArrayLike; default: not declared ### @insiderfinance/totalfinance/backtest#monteCarloResample Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Seeded bootstrap of bar returns → confidence bands on the compounded total return (report-shaped). ```typescript export declare function monteCarloResample(returns: ArrayLike, options?: { iterations?: number; seed?: number; }): MonteCarloResampleReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { iterations?: number; seed?: number; }; default: not declared - (options).iterations?: number; default: not declared - (options).seed?: number; default: not declared - (returns): ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.confidenceInterval95: [number, number]; default: not declared — 95% percentile interval of the total return across resamples. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.iterations: number; default: not declared - return.meanTotalReturn: number; default: not declared — Mean bootstrapped total return. - return.seed: number; default: not declared - return.standardDeviation: number; default: not declared ### @insiderfinance/totalfinance/backtest#portfolioBacktest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run a ledger-backed multi-asset backtest. See `docs/specs/portfolio-scale-backtesting.md` (Decision 6). ```typescript export declare function portfolioBacktest(request: PortfolioBacktestRequest): PortfolioBacktestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): PortfolioBacktestRequest; default: not declared - (request).accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - (request).calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - (request).execution?: ExecutionPolicy; default: not declared - (request).externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - (request).instruments: Readonly>; default: not declared - (request).marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - (request).periodsPerYear?: number; default: not declared - (request).seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - (request).strategy: PortfolioStrategy; default: not declared - (request).window?: { fromTimestampMs?: EpochMs; toTimestampMs?: EpochMs; }; default: not declared - (request).window.fromTimestampMs?: number; default: not declared - (request).window.toTimestampMs?: number; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestAssumptions; default: not declared - return.diagnostics: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestDiagnostics; default: not declared - return.events: PortfolioEventEnvelope[]; default: not declared - return.fills: NormalizedFill[]; default: not declared - return.finalValue: number; default: not declared - return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - return.liquidations: LiquidationRow[]; default: not declared - return.orders: OrderRecord[]; default: not declared - return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - return.pnl: PortfolioPnlResult | null; default: not declared - return.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - return.pnl.assumptions.conventionsVersion: string; default: not declared - return.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - return.pnl.assumptions.identity: string; default: not declared — The identity, stated. - return.pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - return.pnl.assumptions.residualTolerance: number; default: not declared - return.pnl.baseCurrency: string; default: not declared - return.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - return.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - return.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - return.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - return.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - return.pnl.diagnostics.warnings: string[]; default: not declared - return.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - return.pnl.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - return.pnl.from.asOf: number; default: not declared - return.pnl.from.netAssetValue: number; default: not declared - return.pnl.from.valuationDate: string; default: not declared - return.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - return.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - return.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - return.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - return.pnl.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - return.pnl.to.asOf: number; default: not declared - return.pnl.to.netAssetValue: number; default: not declared - return.pnl.to.valuationDate: string; default: not declared - return.points: EquityPoint[]; default: not declared - return.rejections: RejectionRow[]; default: not declared - return.returns: number[]; default: not declared - return.runId: string; default: not declared - return.timeline: PortfolioTimelineResult | null; default: not declared - return.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - return.timeline.assumptions.conventionsVersion: string; default: not declared - return.timeline.assumptions.exposureConvention: string; default: not declared - return.timeline.assumptions.indexConvention: string; default: not declared - return.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - return.timeline.assumptions.markInstant: string; default: not declared - return.timeline.baseCurrency: string; default: not declared - return.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - return.timeline.cumulativePnl.financing: number; default: not declared - return.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - return.timeline.cumulativePnl.income: number; default: not declared - return.timeline.cumulativePnl.realizedPnl: number; default: not declared - return.timeline.cumulativePnl.residual: number; default: not declared - return.timeline.cumulativePnl.totalPnl: number; default: not declared - return.timeline.cumulativePnl.transactionCosts: number; default: not declared - return.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - return.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - return.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - return.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - return.timeline.diagnostics.markCount: number; default: not declared - return.timeline.diagnostics.warnings: string[]; default: not declared - return.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - return.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - return.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - return.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - return.valuationMarks: PortfolioValuationMark[]; default: not declared ### @insiderfinance/totalfinance/backtest#returnStatistics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Return-distribution statistics from a series of per-bar returns (report-shaped, Law 2). ```typescript export declare function returnStatistics(returns: ArrayLike): ReturnStatisticsReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (returns): ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.averageLoss: number; default: not declared - return.averageWin: number; default: not declared - return.bestPeriod: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.expectancy: number | null; default: not declared — Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. - return.hitRate: number | null; default: not declared — Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero bar — there is no win/loss population to take a fraction of, so the metric is undefined and is disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. - return.profitFactor: number | null; default: not declared — Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` (Law 7). `0` when there are no gains either. - return.worstPeriod: number; default: not declared ### @insiderfinance/totalfinance/backtest#runAgentBench Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function runAgentBench(input: AgentBenchInput): AgentBenchReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AgentBenchInput; default: not declared - (input).episodes?: readonly AgentBenchEpisode[]; default: not declared — Default: the whole catalogue. - (input).limits?: { maximumRuns?: number; }; default: not declared - (input).limits.maximumRuns?: number; default: not declared - (input).policy: { decide: TradingPolicy; label: string; requires: FeatureRecipes | null; }; default: not declared - (input).policy.decide: TradingPolicy; default: not declared - (input).policy.label: string; default: not declared - (input).policy.requires: FeatureRecipes | null; default: not declared - (input).policy.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - (input).policy.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - (input).policy.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - (input).policy.requires.realizedVolatility.annualization: number; default: not declared - (input).policy.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - (input).seeds?: readonly number[]; default: not declared — Default: [42]. - return.assumptions: { dimensions: string; episodes: string[]; leakageProbe: string; retrySuite: string; runs: number; seeds: number[]; }; default: not declared - return.assumptions.dimensions: string; default: not declared - return.assumptions.episodes: string[]; default: not declared - return.assumptions.leakageProbe: string; default: not declared - return.assumptions.retrySuite: string; default: not declared - return.assumptions.runs: number; default: not declared - return.assumptions.seeds: number[]; default: not declared - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - return.episodes: AgentBenchEpisodeReport[]; default: not declared - return.operational: { duplicateOrders: number; externalOrderAttempts: 0; failing: string[]; limitBreaches: number; lookAhead: number; maskViolations: number; passes: boolean; }; default: not declared - return.operational.duplicateOrders: number; default: not declared - return.operational.externalOrderAttempts: 0; default: not declared - return.operational.failing: string[]; default: not declared - return.operational.limitBreaches: number; default: not declared - return.operational.lookAhead: number; default: not declared - return.operational.maskViolations: number; default: not declared - return.operational.passes: boolean; default: not declared - return.policy: string; default: not declared - return.strategy: { meanCost: number | null; meanGrossExposure: number | null; meanMaxDrawdown: number | null; meanSharpe: number | null; meanTotalReturn: number | null; meanTurnover: number | null; violations: number; }; default: not declared - return.strategy.meanCost: number | null; default: not declared - return.strategy.meanGrossExposure: number | null; default: not declared - return.strategy.meanMaxDrawdown: number | null; default: not declared - return.strategy.meanSharpe: number | null; default: not declared - return.strategy.meanTotalReturn: number | null; default: not declared - return.strategy.meanTurnover: number | null; default: not declared - return.strategy.violations: number; default: not declared - return.traces: AgentBenchTrace[]; default: not declared — One recorded episode per run, in the order of `episodes`. ### @insiderfinance/totalfinance/backtest#runEnvironmentEpisode Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function runEnvironmentEpisode(input: EnvironmentEpisodeInput): EnvironmentEpisodeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EnvironmentEpisodeInput; default: not declared - (input).actions: readonly EnvironmentAction[]; default: not declared - (input).definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; default: not declared - (input).seed?: number; default: not declared - return.assumptions: { conventionsVersion: string; executionPolicy: string; instantCount: number; maximumSteps: number; nextObservationLaw: string; replayable: boolean; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.executionPolicy: string; default: not declared - return.assumptions.instantCount: number; default: not declared - return.assumptions.maximumSteps: number; default: not declared - return.assumptions.nextObservationLaw: string; default: not declared - return.assumptions.replayable: boolean; default: not declared — False with a `goal` callback or a custom adapter — the trace cannot re-issue behavior. - return.definitionHash: string; default: not declared - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { fillCount: number; rejectionCount: number; stepCount: number; violationCount: number; }; default: not declared - return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.diagnostics.fillCount: number; default: not declared - return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.diagnostics.rejectionCount: number; default: not declared - return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.diagnostics.stepCount: number; default: not declared - return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.diagnostics.violationCount: number; default: not declared - return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - return.engineRunId: string; default: not declared - return.reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - return.result: import('@insiderfinance/totalfinance/backtest').PortfolioBacktestResult; default: not declared — The engine's own result over the episode — the same shape `portfolioBacktest` returns. - return.rewardTotal: number; default: not declared - return.rewards: number[]; default: not declared - return.runId: string; default: not declared - return.seed: number | null; default: not declared - return.steps: EnvironmentEpisodeStep[]; default: not declared - return.terminated: boolean; default: not declared - return.traceHash: string; default: not declared - return.truncated: boolean; default: not declared ### @insiderfinance/totalfinance/backtest#scoreAgentTranscript Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function scoreAgentTranscript(input: { transcript: AgentTranscript; expected: AgentTranscriptExpectation; }): AgentTranscriptScore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { expected: AgentTranscriptExpectation; transcript: AgentTranscript; }; default: not declared - (input).expected: AgentTranscriptExpectation; default: not declared - (input).transcript: AgentTranscript; default: not declared - return.argumentValidity: number | null; default: not declared - return.assumptions: { deterministic: true; scoring: string; }; default: not declared - return.assumptions.deterministic: true; default: not declared - return.assumptions.scoring: string; default: not declared - return.bytes: number; default: not declared - return.calls: number; default: not declared - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - return.firstAttemptValidity: number | null; default: not declared - return.operationSelection: number; default: not declared - return.parity: boolean | null; default: not declared - return.passes: boolean; default: not declared - return.recovery: number | null; default: not declared - return.refusal: boolean | null; default: not declared - return.traceability: number | null; default: not declared - return.withinBudget: boolean | null; default: not declared ### @insiderfinance/totalfinance/backtest#slippage Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Slippage models — all worsen the fill price *against* the order's side. ```typescript export declare const slippage: { readonly bps: (bps: number) => SlippageModel; readonly fixed: (perShare: number) => SlippageModel; readonly none: () => SlippageModel; readonly spread: (spread: number) => SlippageModel; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bps: (bps: number) => SlippageModel; default: not declared — Worsen the price by `bps` basis points (relative). - bps().return.fill: (input: SlippageFillInput) => number; default: not declared - bps().return.label: string; default: not declared - bps(bps): number; default: not declared - fixed: (perShare: number) => SlippageModel; default: not declared — Worsen the price by a fixed absolute amount per share. - fixed().return.fill: (input: SlippageFillInput) => number; default: not declared - fixed().return.label: string; default: not declared - fixed(perShare): number; default: not declared - none: () => SlippageModel; default: not declared — No slippage (fills at the reference price). - none().return.fill: (input: SlippageFillInput) => number; default: not declared - none().return.label: string; default: not declared - spread: (spread: number) => SlippageModel; default: not declared — Cross half of a relative bid-ask `spread` (e.g. `0.001` = 10 bps spread ⇒ 5 bps each way). - spread().return.fill: (input: SlippageFillInput) => number; default: not declared - spread().return.label: string; default: not declared - spread(spread): number; default: not declared ### @insiderfinance/totalfinance/backtest#tearSheet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a structured tear sheet from a backtest result. ```typescript export declare function tearSheet(result: BacktestResult, options?: TearSheetOptions): TearSheet; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: TearSheetOptions; default: not declared - (options).monteCarlo?: { iterations?: number; seed?: number; }; default: not declared — Add a seeded Monte-Carlo bootstrap of the bar returns for total-return confidence bands. - (options).monteCarlo.iterations?: number; default: not declared - (options).monteCarlo.seed?: number; default: not declared - (result): BacktestResult; default: not declared - (result).assumptions: BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - (result).diagnostics: ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - (result).finalValue: number; default: not declared — Final portfolio value. - (result).performance: PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - (result).points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - (result).returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - (result).settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - (result).trades: Trade[]; default: not declared — Every filled trade, in order. - (result).turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. - return.assumptions: BacktestAssumptions; default: not declared — The source backtest's echoed modelling assumptions — a tear sheet never drops them (WS2.8). - return.attribution: SymbolAttribution[]; default: not declared - return.diagnostics: ImplementationRisk; default: not declared — The source backtest's implementation-risk diagnostics — a tear sheet never drops them (WS2.8). - return.monteCarlo?: MonteCarloResampleResult; default: not declared - return.performance: PerformanceSummary; default: not declared - return.returns: ReturnStatistics; default: not declared - return.trades: TradeStatistics; default: not declared ### @insiderfinance/totalfinance/backtest#toEquityPoints Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the {@link EquityPoint} series from an engine's internal `equityCurve` (length n+1, index 0 = opening capital) and `timestamps` (length n, one per bar). ```typescript export declare function toEquityPoints(equityCurve: number[], timestamps: EpochMs[]): EquityPoint[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (equityCurve): number[]; default: not declared - (timestamps): number[]; default: not declared ### @insiderfinance/totalfinance/backtest#vectorized Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run a single-asset vectorized backtest. ```typescript export declare function vectorized(options: VectorizedOptions): BacktestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): VectorizedOptions; default: not declared - (options).borrow?: BorrowModel; default: not declared — Short borrow-fee model (default `borrow.none()`). - (options).data: Bar[]; default: not declared — Price bars in ascending time order. - (options).executionLag?: number; default: not declared — Bars between observing the signal and trading on it; ≥ 1 avoids look-ahead (default 1). - (options).fees?: CostModel; default: not declared — Commission model (default `fees.none()`). - (options).initialCapital?: number; default: not declared — Opening capital (default 1). - (options).maxLeverage?: number; default: not declared — Per-asset gross weight cap applied to the signal (default 1). - (options).periodsPerYear?: number; default: not declared — Bars per year, for annualized metrics (default 252). - (options).rebalance?: RebalanceRule; default: not declared — Rebalance calendar (default `everyBar`). - (options).riskFreeRate?: number; default: not declared — Annualized risk-free rate for Sharpe/Sortino (default 0). - (options).signal: ArrayLike | SeriesSignal | EnvelopeSignal; default: not declared — Target exposure per bar, aligned to `data`. A boolean is long (`1`) / flat (`0`); a number is a target weight (fraction of equity; negative = short), clamped to `maxLeverage`. Accepts a warmup-aware {@link SeriesSignal} (`{ value, warmup }`, e.g. a `technicalAnalysis.*.explain(...)` result) so an indicator's leading warmup NaNs are treated as flat (position 0) instead of throwing. A bare `number[]`/`Float64Array` has an implicit `warmup` of 0, so any NaN in it still throws (a genuine mid-series NaN is a real error, not warmup). - (options).signal.diagnostics: { warmup: number; }; default: not declared - (options).signal.diagnostics.warmup: number; default: not declared - (options).signal.value: ArrayLike; default: not declared — Per-bar signal values, aligned to the price bars. - (options).signal.warmup: number; default: not declared — Count of leading bars that may be non-finite by design (the indicator's warmup). - (options).slippage?: SlippageModel; default: not declared — Slippage model (default `slippage.none()`). - return.assumptions: BacktestAssumptions; default: not declared — The modelling assumptions this run made — capital, fills, costs, calendar, margin (dx §2.5). - return.diagnostics: ImplementationRisk; default: not declared — Implementation-risk diagnostics: warnings + benchmark fixture version (spec §16.3). - return.finalValue: number; default: not declared — Final portfolio value. - return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared — Performance metrics of the equity curve (`@insiderfinance/totalfinance/performance`). - return.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared — The equity curve as an explicit `(ts, equity)` series (length = number of bars + 1). `points[0]` is the opening capital stamped at the first bar's timestamp; see {@link EquityPoint}. - return.returns: number[]; default: not declared — Per-bar simple returns of the equity curve. - return.settlements?: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared — Option positions settled at expiry (exercise / assignment / worthless), if any. - return.trades: Trade[]; default: not declared — Every filled trade, in order. - return.turnover: number; default: not declared — Sum of |traded notional| ÷ average equity — a turnover proxy. ### @insiderfinance/totalfinance/backtest#walkForward Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run a walk-forward evaluation. ```typescript export declare function walkForward(options: WalkForwardOptions): WalkForwardResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): WalkForwardOptions; default: not declared - (options).data: Bar[]; default: not declared — Bars in ascending time order (one symbol, or a pre-sorted multi-symbol stream). - (options).mode?: 'rolling' | 'anchored'; default: not declared — `rolling` (sliding train window) or `anchored` (train grows from the start). Default `rolling`. - (options).periodsPerYear?: number; default: not declared — Bars per year for the stitched performance (default 252). - (options).run: (window: WalkForwardWindow) => BacktestResult; default: not declared — Run a backtest over a window; return its out-of-sample result. - (options).step?: number; default: not declared — Step between successive windows (default `testSize`, i.e. non-overlapping test windows). - (options).testSize: number; default: not declared — Test (out-of-sample) window length in bars. - (options).trainSize: number; default: not declared — Training window length in bars. - return.assumptions: BacktestAssumptions; default: not declared — The echoed modelling assumptions, identical across windows (same engine/config) — taken from the first window, so the walk-forward artifact carries the same honesty story as a single backtest (WS2.8 / dx §2.5). - return.diagnostics: Diagnostics; default: not declared — Core diagnostics: the union of every window's warnings, deduped by code + message (WS2.8). - return.equityCurve: number[]; default: not declared — Out-of-sample equity stitched across all test windows (starts at 1). - return.performance: PerformanceSummary; default: not declared — Performance of the stitched out-of-sample curve. - return.windows: WalkForwardWindowResult[]; default: not declared — The per-window out-of-sample results, in order, each tagged with its train/test ranges. ## Entrypoint @insiderfinance/totalfinance/backtest/artifacts ### @insiderfinance/totalfinance/backtest/artifacts#BACKTEST_RUN_ARTIFACT_TYPE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const BACKTEST_RUN_ARTIFACT_TYPE: 'totalfinance.backtest-run'; ``` ### @insiderfinance/totalfinance/backtest/artifacts#BACKTEST_RUN_KINDS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The frozen data projection of the kind table — what an agent reads before choosing a kind. ```typescript export declare const BACKTEST_RUN_KINDS: Readonly>; ``` ### @insiderfinance/totalfinance/backtest/artifacts#BACKTEST_RUN_KIND_LIST Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const BACKTEST_RUN_KIND_LIST: readonly BacktestRunKind[]; ``` ### @insiderfinance/totalfinance/backtest/artifacts#BACKTEST_RUN_LIMITS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers). ```typescript export declare const BACKTEST_RUN_LIMITS: Readonly<{ maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; gridPoints: Readonly<{ default: 256; maximum: 4096; }>; restarts: Readonly<{ maximum: 64; }>; holdoutEvaluations: Readonly<{ maximum: 100000; }>; listedIds: Readonly<{ default: 200; maximum: 10000; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; default: not declared - embeddedRowLimit.default: 5000; default: not declared - embeddedRowLimit.maximum: 50000; default: not declared - gridPoints: Readonly<{ default: 256; maximum: 4096; }>; default: not declared - gridPoints.default: 256; default: not declared - gridPoints.maximum: 4096; default: not declared - holdoutEvaluations: Readonly<{ maximum: 100000; }>; default: not declared - holdoutEvaluations.maximum: 100000; default: not declared - listedIds: Readonly<{ default: 200; maximum: 10000; }>; default: not declared - listedIds.default: 200; default: not declared - listedIds.maximum: 10000; default: not declared - maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; default: not declared - maximumDifferences.default: 1000; default: not declared - maximumDifferences.maximum: 100000; default: not declared - maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; default: not declared - maximumEmbeddedBytes.default: 1048576; default: not declared - maximumEmbeddedBytes.maximum: 8388608; default: not declared - maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; default: not declared - maximumLeaves.default: 2000000; default: not declared - maximumLeaves.maximum: 2000000; default: not declared - restarts: Readonly<{ maximum: 64; }>; default: not declared - restarts.maximum: 64; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestHygieneBlock Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The research-hygiene verdicts a caller attaches to a single run — verbatim `@insiderfinance/totalfinance/risk` results. ```typescript /** The research-hygiene verdicts a caller attaches to a single run — verbatim `@insiderfinance/totalfinance/risk` results. */ export interface BacktestHygieneBlock { researchProtocol?: Record; deflatedSharpe?: Record; backtestOverfitting?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - backtestOverfitting?: Record; default: not declared - deflatedSharpe?: Record; default: not declared - researchProtocol?: Record; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunArtifactInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BacktestRunArtifactInput { kind: Kind; /** The verb's result, verbatim. */ run: RunOf; /** The request as it was called — rows included; callbacks recorded and not stored; models recorded by description. */ input: InputOf; /** Row-set labels (`dataset.returns`, `run.holdings`, `run.ledger.events`) to store by `TableHandle` instead of embedding. */ referenceRowSets?: readonly string[]; /** Storage locators to stamp on the minted handles, keyed by row-set label. */ locators?: Record; /** Verbatim `@insiderfinance/totalfinance/risk` verdicts for a single run; a grid carries its own and refuses this. */ hygiene?: BacktestHygieneBlock; snapshotHash?: string; libraryVersion?: string; createdFrom?: string[]; provenance?: Provenance; limits?: BacktestRunArtifactLimits; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - createdFrom?: string[]; default: not declared - hygiene?: BacktestHygieneBlock; default: not declared — Verbatim `@insiderfinance/totalfinance/risk` verdicts for a single run; a grid carries its own and refuses this. - hygiene.backtestOverfitting?: Record; default: not declared - hygiene.deflatedSharpe?: Record; default: not declared - hygiene.researchProtocol?: Record; default: not declared - input: InputOf; default: not declared — The request as it was called — rows included; callbacks recorded and not stored; models recorded by description. - kind: Kind; default: not declared - libraryVersion?: string; default: not declared - limits?: BacktestRunArtifactLimits; default: not declared - limits.embeddedRowLimit?: number; default: not declared - limits.maximumEmbeddedBytes?: number; default: not declared - locators?: Record; default: not declared — Storage locators to stamp on the minted handles, keyed by row-set label. - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - referenceRowSets?: readonly string[]; default: not declared — Row-set labels (`dataset.returns`, `run.holdings`, `run.ledger.events`) to store by `TableHandle` instead of embedding. - run: RunOf; default: not declared — The verb's result, verbatim. - snapshotHash?: string; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunArtifactLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BacktestRunArtifactLimits { maximumEmbeddedBytes?: number; embeddedRowLimit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit?: number; default: not declared - maximumEmbeddedBytes?: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BacktestRunComparison { kind: Kind; artifactIds: { baseline: string | null; candidate: string | null; }; runHashes: { baseline: string; candidate: string; }; identical: boolean; sameInputs: boolean; sameUniverse: boolean; sameStrategy: boolean; sameModels: boolean; sameConventions: boolean; /** The performance block and the run-level totals, name by name. */ metrics: NamedDelta[]; /** Final-holding membership (names held at the last rebalance) — single runs only. */ holdings: MembershipSection | null; /** Rebalance-by-rebalance turnover and cost deltas over the shared index range, listed up to `listedIds`. */ rebalances: { compared: number; rows: RebalanceDelta[]; remainderCount: number; } | null; /** Per-variation deltas of the grid's selection metric, matched by parameters — grids only. */ variations: { matched: number; baselineOnly: number; candidateOnly: number; rows: VariationDelta[]; remainderCount: number; best: { baseline: number | null; candidate: number | null; moved: boolean; }; } | null; hygiene: { baseline: string | null; candidate: string | null; changed: boolean; } | null; /** The structural diff of the two stored runs through the parity walk. */ run: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; /** Under an explicit tolerance: every metric within it; `null` without one. */ withinTolerance: boolean | null; assumptions: { conventionsVersion: string; kind: Kind; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - artifactIds.baseline: string | null; default: not declared - artifactIds.candidate: string | null; default: not declared - assumptions: { conventionsVersion: string; kind: Kind; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.kind: Kind; default: not declared - assumptions.limits: { listedIds: number; maximumDifferences: number; maximumLeaves: number; }; default: not declared - assumptions.limits.listedIds: number; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - assumptions.tolerance: ComparisonTolerance | null; default: not declared - assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - holdings: MembershipSection | null; default: not declared — Final-holding membership (names held at the last rebalance) — single runs only. - holdings.entered: IdListSection; default: not declared - holdings.entered.count: number; default: not declared - holdings.entered.ids: string[]; default: not declared - holdings.entered.remainderCount: number; default: not declared - holdings.exited: IdListSection; default: not declared - holdings.exited.count: number; default: not declared - holdings.exited.ids: string[]; default: not declared - holdings.exited.remainderCount: number; default: not declared - holdings.kept: IdListSection; default: not declared - holdings.kept.count: number; default: not declared - holdings.kept.ids: string[]; default: not declared - holdings.kept.remainderCount: number; default: not declared - hygiene: { baseline: string | null; candidate: string | null; changed: boolean; } | null; default: not declared - hygiene.baseline: string | null; default: not declared - hygiene.candidate: string | null; default: not declared - hygiene.changed: boolean; default: not declared - identical: boolean; default: not declared - kind: Kind; default: not declared - metrics: NamedDelta[]; default: not declared — The performance block and the run-level totals, name by name. - rebalances: { compared: number; remainderCount: number; rows: RebalanceDelta[]; } | null; default: not declared — Rebalance-by-rebalance turnover and cost deltas over the shared index range, listed up to `listedIds`. - rebalances.compared: number; default: not declared - rebalances.remainderCount: number; default: not declared - rebalances.rows: RebalanceDelta[]; default: not declared - run: { addedPaths: string[]; differenceCount: number; removedPaths: string[]; retainedDifferences: number; truncated: boolean; }; default: not declared — The structural diff of the two stored runs through the parity walk. - run.addedPaths: string[]; default: not declared - run.differenceCount: number; default: not declared - run.removedPaths: string[]; default: not declared - run.retainedDifferences: number; default: not declared - run.truncated: boolean; default: not declared - runHashes: { baseline: string; candidate: string; }; default: not declared - runHashes.baseline: string; default: not declared - runHashes.candidate: string; default: not declared - sameConventions: boolean; default: not declared - sameInputs: boolean; default: not declared - sameModels: boolean; default: not declared - sameStrategy: boolean; default: not declared - sameUniverse: boolean; default: not declared - variations: { baselineOnly: number; best: { baseline: number | null; candidate: number | null; moved: boolean; }; candidateOnly: number; matched: number; remainderCount: number; rows: VariationDelta[]; } | null; default: not declared — Per-variation deltas of the grid's selection metric, matched by parameters — grids only. - variations.baselineOnly: number; default: not declared - variations.best: { baseline: number | null; candidate: number | null; moved: boolean; }; default: not declared - variations.best.baseline: number | null; default: not declared - variations.best.candidate: number | null; default: not declared - variations.best.moved: boolean; default: not declared - variations.candidateOnly: number; default: not declared - variations.matched: number; default: not declared - variations.remainderCount: number; default: not declared - variations.rows: VariationDelta[]; default: not declared - withinTolerance: boolean | null; default: not declared — Under an explicit tolerance: every metric within it; `null` without one. ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunIdentity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The FC8 identity list, read from the run's assumptions and the request — never recomputed. ```typescript /** The FC8 identity list, read from the run's assumptions and the request — never recomputed. */ export interface BacktestRunIdentity { /** The engine's content-addressed run id (the sweep id for a grid). */ runId: string; /** Every child run id, in variation order (grids only). */ childRunIds: string[] | null; universeId: string; /** Content hash of the universe history's member rows. */ universeHistoryHash: string; /** The signal as the engine disclosed it (`assumptions.signal`). */ strategy: Record; recipe: { recipeName: string; recipeVersion: number; } | null; pointInTimePolicy: string; conventions: { conventionsVersion: string; sessionInstantConvention: string; pricing: string; }; calendar: { sessions: number; firstMarkTimestampMs: number | null; lastMarkTimestampMs: number | null; }; engine: { operation: string; runVersion: number; }; models: RecordedModels; seed: number | null; benchmark: boolean; annualization: { periodsPerYear: number; riskFreeRate: number; }; initialCapital: number; baseCurrency: string; /** The grid's axes (grids only). */ variations: Array<{ path: string; values: unknown[]; }> | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualization: { periodsPerYear: number; riskFreeRate: number; }; default: not declared - annualization.periodsPerYear: number; default: not declared - annualization.riskFreeRate: number; default: not declared - baseCurrency: string; default: not declared - benchmark: boolean; default: not declared - calendar: { sessions: number; firstMarkTimestampMs: number | null; lastMarkTimestampMs: number | null; }; default: not declared - calendar.firstMarkTimestampMs: number | null; default: not declared - calendar.lastMarkTimestampMs: number | null; default: not declared - calendar.sessions: number; default: not declared - childRunIds: string[] | null; default: not declared — Every child run id, in variation order (grids only). - conventions: { conventionsVersion: string; sessionInstantConvention: string; pricing: string; }; default: not declared - conventions.conventionsVersion: string; default: not declared - conventions.pricing: string; default: not declared - conventions.sessionInstantConvention: string; default: not declared - engine: { operation: string; runVersion: number; }; default: not declared - engine.operation: string; default: not declared - engine.runVersion: number; default: not declared - initialCapital: number; default: not declared - models: RecordedModels; default: not declared - models.commission: string | null; default: not declared - models.execution: ExecutionPolicyDescription | null; default: not declared - models.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - models.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - models.execution.costs.borrow: string | null; default: not declared - models.execution.costs.commission: string; default: not declared - models.execution.costs.latencySessions: number | null; default: not declared - models.execution.costs.marketImpact: string | null; default: not declared - models.execution.costs.participation: number | null; default: not declared - models.execution.costs.slippage: string; default: not declared - models.execution.costs.spread: string | null; default: not declared - models.execution.fill: { label: string; version: string; }; default: not declared - models.execution.fill.label: string; default: not declared - models.execution.fill.version: string; default: not declared - models.execution.label: string; default: not declared - models.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - models.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - models.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - models.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - models.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - models.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - models.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - models.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - models.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - models.execution.realism: 'simplified' | 'declared'; default: not declared - models.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - models.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - models.execution.sessions.halts: number; default: not declared - models.execution.sessions.priceLimits: number; default: not declared - models.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - models.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - models.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - models.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - models.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - models.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - models.slippage: string | null; default: not declared - pointInTimePolicy: string; default: not declared - recipe: { recipeName: string; recipeVersion: number; } | null; default: not declared - recipe.recipeName: string; default: not declared - recipe.recipeVersion: number; default: not declared - runId: string; default: not declared — The engine's content-addressed run id (the sweep id for a grid). - seed: number | null; default: not declared - strategy: Record; default: not declared — The signal as the engine disclosed it (`assumptions.signal`). - universeHistoryHash: string; default: not declared — Content hash of the universe history's member rows. - universeId: string; default: not declared - variations: { path: string; values: unknown[]; }[] | null; default: not declared — The grid's axes (grids only). ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunInputs Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BacktestRunInputs { 'cross-sectional': CrossSectionalBacktestRequest; 'cross-sectional-grid': CrossSectionalBacktestGridRequest; options: OptionsBacktestConfig; portfolio: PortfolioBacktestRequest; environment: EnvironmentEpisodeInput; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cross-sectional: CrossSectionalBacktestRequest; default: not declared - cross-sectional-grid: CrossSectionalBacktestGridRequest; default: not declared - cross-sectional-grid.hygiene?: { confidence?: number; splits?: number; }; default: not declared - cross-sectional-grid.hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - cross-sectional-grid.hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - cross-sectional-grid.maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - cross-sectional-grid.request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - cross-sectional-grid.request.baseCurrency?: string; default: not declared — Default `'USD'`. - cross-sectional-grid.request.dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - cross-sectional-grid.request.dataset.averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - cross-sectional-grid.request.dataset.benchmarkReturns?: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - cross-sectional-grid.request.dataset.betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - cross-sectional-grid.request.dataset.classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - cross-sectional-grid.request.dataset.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - cross-sectional-grid.request.dataset.groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - cross-sectional-grid.request.dataset.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - cross-sectional-grid.request.dataset.returns: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - cross-sectional-grid.request.dataset.sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. - cross-sectional-grid.request.execution?: ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - cross-sectional-grid.request.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - cross-sectional-grid.request.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - cross-sectional-grid.request.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - cross-sectional-grid.request.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - cross-sectional-grid.request.execution.costs.borrow.label: string; default: not declared - cross-sectional-grid.request.execution.costs.commission: CostModel; default: not declared - cross-sectional-grid.request.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - cross-sectional-grid.request.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - cross-sectional-grid.request.execution.costs.commission.commission(input).price: number; default: not declared - cross-sectional-grid.request.execution.costs.commission.commission(input).quantity: number; default: not declared - cross-sectional-grid.request.execution.costs.commission.label: string; default: not declared - cross-sectional-grid.request.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - cross-sectional-grid.request.execution.costs.latency.label: string; default: not declared - cross-sectional-grid.request.execution.costs.latency.sessions: number; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - cross-sectional-grid.request.execution.costs.marketImpact.label: string; default: not declared - cross-sectional-grid.request.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - cross-sectional-grid.request.execution.costs.slippage: SlippageModel; default: not declared - cross-sectional-grid.request.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - cross-sectional-grid.request.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - cross-sectional-grid.request.execution.costs.slippage.fill(input).quantity: number; default: not declared - cross-sectional-grid.request.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - cross-sectional-grid.request.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - cross-sectional-grid.request.execution.costs.slippage.label: string; default: not declared - cross-sectional-grid.request.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - cross-sectional-grid.request.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - cross-sectional-grid.request.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - cross-sectional-grid.request.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - cross-sectional-grid.request.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - cross-sectional-grid.request.execution.costs.spread.label: string; default: not declared - cross-sectional-grid.request.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - cross-sectional-grid.request.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - cross-sectional-grid.request.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - cross-sectional-grid.request.execution.fill.fill().return.detail?: string; default: not declared - cross-sectional-grid.request.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - cross-sectional-grid.request.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - cross-sectional-grid.request.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - cross-sectional-grid.request.execution.fill.fill().return.pricePerUnit: number; default: not declared - cross-sectional-grid.request.execution.fill.fill().return.quantity: number; default: not declared - cross-sectional-grid.request.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - cross-sectional-grid.request.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - cross-sectional-grid.request.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - cross-sectional-grid.request.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - cross-sectional-grid.request.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - cross-sectional-grid.request.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - cross-sectional-grid.request.execution.fill.label: string; default: not declared - cross-sectional-grid.request.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - cross-sectional-grid.request.execution.fill.version: string; default: not declared - cross-sectional-grid.request.execution.label: string; default: not declared — Echoed in every result's assumptions. - cross-sectional-grid.request.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - cross-sectional-grid.request.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - cross-sectional-grid.request.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - cross-sectional-grid.request.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - cross-sectional-grid.request.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - cross-sectional-grid.request.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - cross-sectional-grid.request.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - cross-sectional-grid.request.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - cross-sectional-grid.request.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - cross-sectional-grid.request.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - cross-sectional-grid.request.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - cross-sectional-grid.request.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - cross-sectional-grid.request.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - cross-sectional-grid.request.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - cross-sectional-grid.request.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - cross-sectional-grid.request.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - cross-sectional-grid.request.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - cross-sectional-grid.request.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - cross-sectional-grid.request.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - cross-sectional-grid.request.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - cross-sectional-grid.request.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - cross-sectional-grid.request.initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - cross-sectional-grid.request.periodsPerYear?: number; default: not declared — Default 252. - cross-sectional-grid.request.portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - cross-sectional-grid.request.portfolioConstruction.long: import('@insiderfinance/totalfinance/backtest').SideSelection; default: not declared - cross-sectional-grid.request.portfolioConstruction.long.count: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.long.fraction: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.long.topQuantile: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - cross-sectional-grid.request.portfolioConstruction.maximumPositionWeight?: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.maximumPositions?: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - cross-sectional-grid.request.portfolioConstruction.method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; default: not declared - cross-sectional-grid.request.portfolioConstruction.minimumPositionWeight?: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.neutrality?: import('@insiderfinance/totalfinance/backtest').Neutrality; default: not declared - cross-sectional-grid.request.portfolioConstruction.neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - cross-sectional-grid.request.portfolioConstruction.neutralizeAgainst.field: string; default: not declared - cross-sectional-grid.request.portfolioConstruction.riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - cross-sectional-grid.request.portfolioConstruction.short?: import('@insiderfinance/totalfinance/backtest').ShortSideSelection; default: not declared - cross-sectional-grid.request.portfolioConstruction.short.bottomQuantile: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.short.count: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.short.fraction: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.suppliedWeights?: (context: import('@insiderfinance/totalfinance/backtest').WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - cross-sectional-grid.request.portfolioConstruction.suppliedWeights(context): import('@insiderfinance/totalfinance/backtest').WeightContext; default: not declared - cross-sectional-grid.request.portfolioConstruction.suppliedWeights(context).asOf: number; default: not declared - cross-sectional-grid.request.portfolioConstruction.suppliedWeights(context).long: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - cross-sectional-grid.request.portfolioConstruction.suppliedWeights(context).sessionDate: string; default: not declared - cross-sectional-grid.request.portfolioConstruction.suppliedWeights(context).short: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - cross-sectional-grid.request.portfolioConstruction.suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - cross-sectional-grid.request.portfolioConstruction.volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). - cross-sectional-grid.request.rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - cross-sectional-grid.request.rebalanceSchedule.bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - cross-sectional-grid.request.rebalanceSchedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - cross-sectional-grid.request.rebalanceSchedule.session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. - cross-sectional-grid.request.riskFreeRate?: number; default: not declared - cross-sectional-grid.request.seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - cross-sectional-grid.request.signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - cross-sectional-grid.request.signal.callback: (context: import('@insiderfinance/totalfinance/backtest').SignalContext) => readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - cross-sectional-grid.request.signal.callback(context): import('@insiderfinance/totalfinance/backtest').SignalContext; default: not declared - cross-sectional-grid.request.signal.callback(context).asOf: number; default: not declared - cross-sectional-grid.request.signal.callback(context).eligible: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - cross-sectional-grid.request.signal.callback(context).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - cross-sectional-grid.request.signal.callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - cross-sectional-grid.request.signal.callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - cross-sectional-grid.request.signal.callback(context).sessionDate: string; default: not declared - cross-sectional-grid.request.signal.factorRecipe: import('@insiderfinance/totalfinance/research').FactorRecipe; default: not declared - cross-sectional-grid.request.signal.factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - cross-sectional-grid.request.signal.factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - cross-sectional-grid.request.signal.factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - cross-sectional-grid.request.signal.factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - cross-sectional-grid.request.signal.factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - cross-sectional-grid.request.signal.factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - cross-sectional-grid.request.signal.factorRecipe.recipeName: string; default: not declared - cross-sectional-grid.request.signal.factorRecipe.recipeVersion: number; default: not declared - cross-sectional-grid.request.signal.score: { components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - cross-sectional-grid.request.signal.score.components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - cross-sectional-grid.request.signal.score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - cross-sectional-grid.request.signal.screen: { filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; }; default: not declared - cross-sectional-grid.request.signal.screen.filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - cross-sectional-grid.request.signal.screen.filter.all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - cross-sectional-grid.request.signal.screen.filter.any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - cross-sectional-grid.request.signal.screen.filter.field: string; default: not declared - cross-sectional-grid.request.signal.screen.filter.from: number; default: not declared - cross-sectional-grid.request.signal.screen.filter.not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - cross-sectional-grid.request.signal.screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - cross-sectional-grid.request.signal.screen.filter.to: number; default: not declared - cross-sectional-grid.request.signal.screen.filter.value: (number) | (string | number | boolean); default: not declared - cross-sectional-grid.request.signal.screen.filter.values: readonly (string | number)[]; default: not declared - cross-sectional-grid.request.signal.screen.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - cross-sectional-grid.request.signal.screen.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - cross-sectional-grid.request.transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - cross-sectional-grid.request.transactionCostModel.commission?: CostModel; default: not declared - cross-sectional-grid.request.transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - cross-sectional-grid.request.transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - cross-sectional-grid.request.transactionCostModel.commission.commission(input).price: number; default: not declared - cross-sectional-grid.request.transactionCostModel.commission.commission(input).quantity: number; default: not declared - cross-sectional-grid.request.transactionCostModel.commission.label: string; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage?: SlippageModel; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage.fill(input).quantity: number; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - cross-sectional-grid.request.transactionCostModel.slippage.label: string; default: not declared - cross-sectional-grid.request.universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - cross-sectional-grid.request.universeHistory.members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - cross-sectional-grid.request.universeHistory.universeId: string; default: not declared - cross-sectional-grid.request.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - cross-sectional-grid.request.window.fromTimestampMs?: number; default: not declared - cross-sectional-grid.request.window.toTimestampMs?: number; default: not declared - cross-sectional-grid.selectionMetric?: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - cross-sectional-grid.variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. - cross-sectional.baseCurrency?: string; default: not declared — Default `'USD'`. - cross-sectional.dataset: import('@insiderfinance/totalfinance/backtest').CrossSectionalDataset; default: not declared - cross-sectional.dataset.averageDailyVolumes?: Readonly>; default: not declared — Average daily volume in return-index units, for the participation constraint. - cross-sectional.dataset.benchmarkReturns?: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — A benchmark's per-session simple returns (one `instrumentId`, e.g. an index proxy). - cross-sectional.dataset.betas?: Readonly>; default: not declared — Per-instrument betas for beta-neutral targets. - cross-sectional.dataset.classification?: Readonly>; default: not declared — Grouping for the ledger's exposure reports (asset class, strategy, tags). - cross-sectional.dataset.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared — Declared fields; nothing is inferred from the data. - cross-sectional.dataset.groups?: Readonly>; default: not declared — Grouping for sector-neutral targets and the recipe's sector neutralization. - cross-sectional.dataset.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Features with `availableTimestampMs` — what a decision may see is decided by availability. - cross-sectional.dataset.returns: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Per-instrument per-session simple returns; their session dates are the run's calendar. - cross-sectional.dataset.sizeField?: string; default: not declared — The observation field that carries size (log market capitalization) for `sector-and-size`. - cross-sectional.execution?: ExecutionPolicy; default: not declared — Decision 7's policy; omitted = `execution.simplified()`, and the result says so. - cross-sectional.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - cross-sectional.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - cross-sectional.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - cross-sectional.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - cross-sectional.execution.costs.borrow.label: string; default: not declared - cross-sectional.execution.costs.commission: CostModel; default: not declared - cross-sectional.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - cross-sectional.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - cross-sectional.execution.costs.commission.commission(input).price: number; default: not declared - cross-sectional.execution.costs.commission.commission(input).quantity: number; default: not declared - cross-sectional.execution.costs.commission.label: string; default: not declared - cross-sectional.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - cross-sectional.execution.costs.latency.label: string; default: not declared - cross-sectional.execution.costs.latency.sessions: number; default: not declared - cross-sectional.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - cross-sectional.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - cross-sectional.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - cross-sectional.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - cross-sectional.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - cross-sectional.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - cross-sectional.execution.costs.marketImpact.label: string; default: not declared - cross-sectional.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - cross-sectional.execution.costs.slippage: SlippageModel; default: not declared - cross-sectional.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - cross-sectional.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - cross-sectional.execution.costs.slippage.fill(input).quantity: number; default: not declared - cross-sectional.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - cross-sectional.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - cross-sectional.execution.costs.slippage.label: string; default: not declared - cross-sectional.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - cross-sectional.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - cross-sectional.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - cross-sectional.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - cross-sectional.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - cross-sectional.execution.costs.spread.label: string; default: not declared - cross-sectional.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - cross-sectional.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - cross-sectional.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - cross-sectional.execution.fill.fill().return.detail?: string; default: not declared - cross-sectional.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - cross-sectional.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - cross-sectional.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - cross-sectional.execution.fill.fill().return.pricePerUnit: number; default: not declared - cross-sectional.execution.fill.fill().return.quantity: number; default: not declared - cross-sectional.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - cross-sectional.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - cross-sectional.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - cross-sectional.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - cross-sectional.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - cross-sectional.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - cross-sectional.execution.fill.label: string; default: not declared - cross-sectional.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - cross-sectional.execution.fill.version: string; default: not declared - cross-sectional.execution.label: string; default: not declared — Echoed in every result's assumptions. - cross-sectional.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - cross-sectional.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - cross-sectional.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - cross-sectional.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - cross-sectional.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - cross-sectional.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - cross-sectional.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - cross-sectional.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - cross-sectional.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - cross-sectional.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - cross-sectional.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - cross-sectional.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - cross-sectional.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - cross-sectional.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - cross-sectional.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - cross-sectional.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - cross-sectional.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - cross-sectional.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - cross-sectional.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - cross-sectional.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - cross-sectional.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - cross-sectional.initialCapital?: number; default: not declared — Default 1,000,000 in `baseCurrency`. - cross-sectional.periodsPerYear?: number; default: not declared — Default 252. - cross-sectional.portfolioConstruction: import('@insiderfinance/totalfinance/backtest').PortfolioConstruction; default: not declared - cross-sectional.portfolioConstruction.long: import('@insiderfinance/totalfinance/backtest').SideSelection; default: not declared - cross-sectional.portfolioConstruction.long.count: number; default: not declared - cross-sectional.portfolioConstruction.long.fraction: number; default: not declared - cross-sectional.portfolioConstruction.long.topQuantile: number; default: not declared - cross-sectional.portfolioConstruction.maximumParticipation?: number; default: not declared — Fraction of a name's average daily volume one rebalance may trade. - cross-sectional.portfolioConstruction.maximumPositionWeight?: number; default: not declared - cross-sectional.portfolioConstruction.maximumPositions?: number; default: not declared - cross-sectional.portfolioConstruction.maximumTurnover?: number; default: not declared — Fraction of net asset value traded per rebalance; a trim is reported, never silent. - cross-sectional.portfolioConstruction.method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; default: not declared - cross-sectional.portfolioConstruction.minimumPositionWeight?: number; default: not declared - cross-sectional.portfolioConstruction.neutrality?: import('@insiderfinance/totalfinance/backtest').Neutrality; default: not declared - cross-sectional.portfolioConstruction.neutralizeAgainst?: { field: string; }; default: not declared — For `neutrality: 'factor'`: the observation field whose exposure the weights are residualized against. - cross-sectional.portfolioConstruction.neutralizeAgainst.field: string; default: not declared - cross-sectional.portfolioConstruction.riskBudgets?: Readonly>; default: not declared — For `risk-budget`: budgets per instrument (missing names share the remainder equally). - cross-sectional.portfolioConstruction.short?: import('@insiderfinance/totalfinance/backtest').ShortSideSelection; default: not declared - cross-sectional.portfolioConstruction.short.bottomQuantile: number; default: not declared - cross-sectional.portfolioConstruction.short.count: number; default: not declared - cross-sectional.portfolioConstruction.short.fraction: number; default: not declared - cross-sectional.portfolioConstruction.suppliedWeights?: (context: import('@insiderfinance/totalfinance/backtest').WeightContext) => Readonly>; default: not declared — For `supplied-weights`: the caller's weights (fractions of net asset value, signed). - cross-sectional.portfolioConstruction.suppliedWeights(context): import('@insiderfinance/totalfinance/backtest').WeightContext; default: not declared - cross-sectional.portfolioConstruction.suppliedWeights(context).asOf: number; default: not declared - cross-sectional.portfolioConstruction.suppliedWeights(context).long: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - cross-sectional.portfolioConstruction.suppliedWeights(context).sessionDate: string; default: not declared - cross-sectional.portfolioConstruction.suppliedWeights(context).short: readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - cross-sectional.portfolioConstruction.suppliedWeights(context).trailingReturns: Readonly>; default: not declared — Trailing per-session returns per selected name, oldest first (as many as available). - cross-sectional.portfolioConstruction.volatilityLookbackSessions?: number; default: not declared — Sessions of trailing returns for `inverse-volatility` / `risk-budget` (default 63). - cross-sectional.rebalanceSchedule: import('@insiderfinance/totalfinance/backtest').RebalanceSchedule; default: not declared - cross-sectional.rebalanceSchedule.bufferBand?: number; default: not declared — Hysteresis: a held name stays selected while its rank is within `(1 + bufferBand)` of the selection threshold, so a name oscillating at the edge does not churn. - cross-sectional.rebalanceSchedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - cross-sectional.rebalanceSchedule.session: 'open' | 'close'; default: not declared — Which session instant decides and fills: the open or the close of the rebalance session. - cross-sectional.riskFreeRate?: number; default: not declared - cross-sectional.seed?: number; default: not declared — Seeds the bootstrap confidence intervals of the performance block; absent = none. - cross-sectional.signal: import('@insiderfinance/totalfinance/backtest').CrossSectionalSignal; default: not declared - cross-sectional.signal.callback: (context: import('@insiderfinance/totalfinance/backtest').SignalContext) => readonly import('@insiderfinance/totalfinance/backtest').SignalRow[]; default: not declared - cross-sectional.signal.callback(context): import('@insiderfinance/totalfinance/backtest').SignalContext; default: not declared - cross-sectional.signal.callback(context).asOf: number; default: not declared - cross-sectional.signal.callback(context).eligible: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared — Eligible observations at the instant (availability, version, membership all applied). - cross-sectional.signal.callback(context).fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - cross-sectional.signal.callback(context).held: readonly string[]; default: not declared — The names held going into this rebalance. - cross-sectional.signal.callback(context).members: readonly string[]; default: not declared — Members of the universe at the instant. - cross-sectional.signal.callback(context).sessionDate: string; default: not declared - cross-sectional.signal.factorRecipe: import('@insiderfinance/totalfinance/research').FactorRecipe; default: not declared - cross-sectional.signal.factorRecipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - cross-sectional.signal.factorRecipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - cross-sectional.signal.factorRecipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - cross-sectional.signal.factorRecipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - cross-sectional.signal.factorRecipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - cross-sectional.signal.factorRecipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - cross-sectional.signal.factorRecipe.recipeName: string; default: not declared - cross-sectional.signal.factorRecipe.recipeVersion: number; default: not declared - cross-sectional.signal.score: { components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - cross-sectional.signal.score.components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - cross-sectional.signal.score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - cross-sectional.signal.screen: { filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; }; default: not declared - cross-sectional.signal.screen.filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - cross-sectional.signal.screen.filter.all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - cross-sectional.signal.screen.filter.any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - cross-sectional.signal.screen.filter.field: string; default: not declared - cross-sectional.signal.screen.filter.from: number; default: not declared - cross-sectional.signal.screen.filter.not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - cross-sectional.signal.screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - cross-sectional.signal.screen.filter.to: number; default: not declared - cross-sectional.signal.screen.filter.value: (number) | (string | number | boolean); default: not declared - cross-sectional.signal.screen.filter.values: readonly (string | number)[]; default: not declared - cross-sectional.signal.screen.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - cross-sectional.signal.screen.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - cross-sectional.transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; default: not declared — Cost models applied to every fill; omitted = the policy's (none for the simplified policy). - cross-sectional.transactionCostModel.commission?: CostModel; default: not declared - cross-sectional.transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - cross-sectional.transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - cross-sectional.transactionCostModel.commission.commission(input).price: number; default: not declared - cross-sectional.transactionCostModel.commission.commission(input).quantity: number; default: not declared - cross-sectional.transactionCostModel.commission.label: string; default: not declared - cross-sectional.transactionCostModel.slippage?: SlippageModel; default: not declared - cross-sectional.transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - cross-sectional.transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - cross-sectional.transactionCostModel.slippage.fill(input).quantity: number; default: not declared - cross-sectional.transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - cross-sectional.transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - cross-sectional.transactionCostModel.slippage.label: string; default: not declared - cross-sectional.universeHistory: import('@insiderfinance/totalfinance/research').UniverseHistory; default: not declared - cross-sectional.universeHistory.members: readonly import('@insiderfinance/totalfinance/research').UniverseMember[]; default: not declared - cross-sectional.universeHistory.universeId: string; default: not declared - cross-sectional.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared — Restrict the run to sessions inside the window (inclusive instants). - cross-sectional.window.fromTimestampMs?: number; default: not declared - cross-sectional.window.toTimestampMs?: number; default: not declared - environment: EnvironmentEpisodeInput; default: not declared - environment.actions: readonly import('@insiderfinance/totalfinance/backtest').EnvironmentAction[]; default: not declared - environment.definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; default: not declared - environment.definition.accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - environment.definition.accounting.baseCurrency: string; default: not declared - environment.definition.accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - environment.definition.accounting.lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Default `'fifo'`. - environment.definition.accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - environment.definition.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - environment.definition.execution?: ExecutionPolicy; default: not declared - environment.definition.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - environment.definition.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - environment.definition.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - environment.definition.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - environment.definition.execution.costs.borrow.label: string; default: not declared - environment.definition.execution.costs.commission: CostModel; default: not declared - environment.definition.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - environment.definition.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - environment.definition.execution.costs.commission.commission(input).price: number; default: not declared - environment.definition.execution.costs.commission.commission(input).quantity: number; default: not declared - environment.definition.execution.costs.commission.label: string; default: not declared - environment.definition.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - environment.definition.execution.costs.latency.label: string; default: not declared - environment.definition.execution.costs.latency.sessions: number; default: not declared - environment.definition.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - environment.definition.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - environment.definition.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - environment.definition.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - environment.definition.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - environment.definition.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - environment.definition.execution.costs.marketImpact.label: string; default: not declared - environment.definition.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - environment.definition.execution.costs.slippage: SlippageModel; default: not declared - environment.definition.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - environment.definition.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - environment.definition.execution.costs.slippage.fill(input).quantity: number; default: not declared - environment.definition.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - environment.definition.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - environment.definition.execution.costs.slippage.label: string; default: not declared - environment.definition.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - environment.definition.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - environment.definition.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - environment.definition.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - environment.definition.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - environment.definition.execution.costs.spread.label: string; default: not declared - environment.definition.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - environment.definition.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - environment.definition.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - environment.definition.execution.fill.fill().return.detail?: string; default: not declared - environment.definition.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - environment.definition.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - environment.definition.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - environment.definition.execution.fill.fill().return.pricePerUnit: number; default: not declared - environment.definition.execution.fill.fill().return.quantity: number; default: not declared - environment.definition.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - environment.definition.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - environment.definition.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - environment.definition.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - environment.definition.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - environment.definition.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - environment.definition.execution.fill.label: string; default: not declared - environment.definition.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - environment.definition.execution.fill.version: string; default: not declared - environment.definition.execution.label: string; default: not declared — Echoed in every result's assumptions. - environment.definition.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - environment.definition.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - environment.definition.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - environment.definition.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - environment.definition.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - environment.definition.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - environment.definition.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - environment.definition.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - environment.definition.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - environment.definition.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - environment.definition.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - environment.definition.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - environment.definition.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - environment.definition.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - environment.definition.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - environment.definition.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - environment.definition.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - environment.definition.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - environment.definition.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - environment.definition.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - environment.definition.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - environment.definition.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - environment.definition.features?: import('@insiderfinance/totalfinance/backtest/environment').FeatureRecipes; default: not declared - environment.definition.features.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - environment.definition.features.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - environment.definition.features.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - environment.definition.features.realizedVolatility.annualization: number; default: not declared - environment.definition.features.realizedVolatility.lookbacks: readonly number[]; default: not declared - environment.definition.instruments: Readonly>; default: not declared - environment.definition.limits?: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentLimits; default: not declared - environment.definition.limits.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. - environment.definition.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - environment.definition.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - environment.definition.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - environment.definition.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - environment.definition.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - environment.definition.limits.maximumPositionNotional?: number; default: not declared — Base currency, per instrument: the largest absolute position value an order may project. - environment.definition.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - environment.definition.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - environment.definition.limits.onBreach?: 'terminate' | 'reject-and-continue'; default: not declared — What a post-trade breach does: end the episode (default) or record it and continue. - environment.definition.marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - environment.definition.marketData.bars?: readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - environment.definition.marketData.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared - environment.definition.marketData.coupons?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').CouponRecord[]; default: not declared - environment.definition.marketData.dividends?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DividendRecord[]; default: not declared - environment.definition.marketData.forwardRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - environment.definition.marketData.fundingRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').FundingRateRecord[]; default: not declared - environment.definition.marketData.fxRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - environment.definition.marketData.optionChains?: readonly import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot[]; default: not declared - environment.definition.marketData.orderBooks?: readonly import('@insiderfinance/totalfinance/core').OrderBook[]; default: not declared - environment.definition.marketData.quotes?: readonly import('@insiderfinance/totalfinance/core').Quote[]; default: not declared - environment.definition.marketData.trades?: readonly import('@insiderfinance/totalfinance/core').Trade[]; default: not declared - environment.definition.maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - environment.definition.periodsPerYear?: number; default: not declared - environment.definition.reward?: import('@insiderfinance/totalfinance/backtest/environment').RewardComposition; default: not declared - environment.definition.reward.benchmark?: { instrumentId: string; weight: number; }; default: not declared — On the step return minus the named instrument's bar return over the step. - environment.definition.reward.benchmark.instrumentId: string; default: not declared - environment.definition.reward.benchmark.weight: number; default: not declared - environment.definition.reward.concentration?: number; default: not declared — On the largest absolute position weight after the step. - environment.definition.reward.cost?: number; default: not declared — On commissions, fees, and slippage ÷ NAV before the step. - environment.definition.reward.drawdown?: number; default: not declared — On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). - environment.definition.reward.goal?: (frame: import('@insiderfinance/totalfinance/backtest/environment').RewardFrame) => Record; default: not declared — Extra named terms (weight 1 each); a callback, so the definition is not replayable. - environment.definition.reward.goal(frame): import('@insiderfinance/totalfinance/backtest/environment').RewardFrame; default: not declared - environment.definition.reward.goal(frame).asOf: number; default: not declared - environment.definition.reward.goal(frame).benchmarkReturn: number | null; default: not declared — The benchmark instrument's bar-close return over the step, or null without two closes. - environment.definition.reward.goal(frame).costs: number; default: not declared — Σ commission + fees + slippage adjustment of the step's fills, base currency. - environment.definition.reward.goal(frame).drawdownAfter: number; default: not declared - environment.definition.reward.goal(frame).drawdownBefore: number; default: not declared — 1 − NAV ÷ running peak, before and after the step. - environment.definition.reward.goal(frame).fills: readonly import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - environment.definition.reward.goal(frame).grossExposure: number; default: not declared - environment.definition.reward.goal(frame).largestPositionWeight: number; default: not declared - environment.definition.reward.goal(frame).netAssetValueAfter: number; default: not declared - environment.definition.reward.goal(frame).netAssetValueBefore: number; default: not declared - environment.definition.reward.goal(frame).positions: readonly import('@insiderfinance/totalfinance/backtest/portfolio').SessionPosition[]; default: not declared - environment.definition.reward.goal(frame).step: number; default: not declared - environment.definition.reward.goal(frame).stepReturn: number; default: not declared — Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). - environment.definition.reward.goal(frame).tradedNotional: number; default: not declared — Σ |quantity × price × multiplier| of the step's fills, base currency. - environment.definition.reward.goal(frame).violations: number; default: not declared — Limit breaches plus disallowed orders in the step. - environment.definition.reward.leverage?: number; default: not declared — On gross exposure ÷ NAV after the step. - environment.definition.reward.pnl?: number; default: not declared — On the step's net return, Δ NAV ÷ NAV before the step. - environment.definition.reward.riskViolation?: number; default: not declared — On the count of limit breaches and disallowed orders in the step. - environment.definition.reward.turnover?: number; default: not declared — On traded notional ÷ NAV before the step. - environment.definition.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - environment.definition.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - environment.definition.window.fromTimestampMs?: number; default: not declared - environment.definition.window.toTimestampMs?: number; default: not declared - environment.seed?: number; default: not declared - options: OptionsBacktestConfig; default: not declared - options.assignment?: 'none' | 'model'; default: not declared — American early-assignment modeling (default `'none'`; `'model'` uses the deep-ITM/ex-div heuristic). - options.baseCurrency?: string; default: not declared — The account currency of the ledger (default `'USD'`). - options.book?: import('@insiderfinance/totalfinance/backtest/options').BookPolicy; default: not declared — The book's capacity (default: one open trade). - options.book.maximumOpenPositions?: number; default: not declared — Open trades at once (default 1 — the shipped single-position behaviour; at most 10,000). - options.book.maximumPerUnderlying?: number; default: not declared — Open trades per underlying (default: no bound). - options.chains: Iterable; default: not declared — Time-ordered (or unordered — the engine sorts) chain snapshots. - options.commission?: CostModel; default: not declared — Commission model for option trades (default none). - options.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - options.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - options.commission.commission(input).price: number; default: not declared - options.commission.commission(input).quantity: number; default: not declared - options.commission.label: string; default: not declared - options.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared — Splits and symbol changes adjust open legs with lineage; mergers and spin-offs on an open leg refuse. - options.dividendYield?: number; default: not declared — Continuous dividend yield for pricing (default 0). - options.dividends?: readonly import('@insiderfinance/totalfinance/backtest/options').DividendRecord[]; default: not declared — Cash dividends: dividend-risk evidence per short call, early assignment under `assignment: 'model'`. - options.entry?: import('@insiderfinance/totalfinance/backtest/options').EntryRule; default: not declared — One rule (the shipped form); exactly one of `entry` and `rules` is given. - options.exit: import('@insiderfinance/totalfinance/backtest/options').ExitRule; default: not declared - options.exit.daysToExpiry?: number; default: not declared — Close at or below this many days to expiry. - options.exit.profitTarget?: number; default: not declared — Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). - options.exit.stopLoss?: number; default: not declared — Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). - options.exit.when?: (context: import('@insiderfinance/totalfinance/backtest/options').ExitContext) => boolean; default: not declared — Arbitrary exit predicate (OR-combined with the declarative triggers). - options.exit.when(context): import('@insiderfinance/totalfinance/backtest/options').ExitContext; default: not declared - options.exit.when(context).asOf: number; default: not declared - options.exit.when(context).daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - options.exit.when(context).entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - options.exit.when(context).greeks: import('@insiderfinance/totalfinance/options').Greeks; default: not declared - options.exit.when(context).markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - options.exit.when(context).netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - options.exit.when(context).pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - options.exit.when(context).position: import('@insiderfinance/totalfinance/strategy').Position; default: not declared - options.exit.when(context).snapshot: import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot; default: not declared - options.fillPolicy?: import('@insiderfinance/totalfinance/backtest/options').FillPolicy; default: not declared — Combo or legged fills; partial-fill policy; the per-leg fill side. - options.fillPolicy.mode?: 'combo' | 'legged'; default: not declared — `'combo'` (default) fills every leg at once or rejects the entry; `'legged'` fills legs in order. - options.fillPolicy.partialFill?: 'reject' | 'allow'; default: not declared — Under `'legged'`: reject a structure whose sequence stops early (default), or hold the filled legs. - options.fillPolicy.price?: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — The per-leg fill side (default: the rule's `price`, else `'mid'`). - options.hedge?: import('@insiderfinance/totalfinance/backtest/options').DeltaHedgeRule; default: not declared — Optional delta-hedging with the underlying. - options.hedge.commission?: CostModel; default: not declared — Commission on the underlying hedge trades (defaults to the backtest's option commission). - options.hedge.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - options.hedge.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - options.hedge.commission.commission(input).price: number; default: not declared - options.hedge.commission.commission(input).quantity: number; default: not declared - options.hedge.commission.label: string; default: not declared - options.hedge.deltaBand: number; default: not declared — Rehedge to flat delta when the absolute share-equivalent net delta exceeds this many shares. - options.hedge.slippage?: SlippageModel; default: not declared — Slippage on the underlying hedge trades (defaults to the backtest's option slippage). - options.hedge.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - options.hedge.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - options.hedge.slippage.fill(input).quantity: number; default: not declared - options.hedge.slippage.fill(input).referencePrice: number; default: not declared - options.hedge.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - options.hedge.slippage.label: string; default: not declared - options.initialCapital?: number; default: not declared — Opening capital (default 100,000). - options.limits?: import('@insiderfinance/totalfinance/backtest/options').PortfolioLimits; default: not declared — Pre-trade limits on the post-trade book. - options.limits.maximumConcentration?: number; default: not declared — Premium at risk (Σ |entry premium|) in one underlying ≤ fraction × equity. - options.limits.maximumMarginFraction?: number; default: not declared — `optionsMargin` of the whole book ≤ fraction × equity. - options.limits.maximumNetDelta?: number; default: not declared — |Σ share-equivalent delta| per underlying ≤ this many shares. - options.limits.maximumNetVega?: number; default: not declared — |Σ vega| per underlying (account currency per 1.00 volatility) ≤ this. - options.limits.scenarioLoss?: { spotShocks: readonly number[]; volatilityShocks: readonly number[]; maximumLossFraction: number; }; default: not declared — The book's worst Taylor P&L over the shock grid (`scenarioGrid`) may not exceed fraction × equity. - options.limits.scenarioLoss.maximumLossFraction: number; default: not declared - options.limits.scenarioLoss.spotShocks: readonly number[]; default: not declared — Spot shocks as fractions (e.g. −0.1 for −10%). - options.limits.scenarioLoss.volatilityShocks: readonly number[]; default: not declared — Absolute volatility shocks (e.g. 0.05 for +5 points). - options.marking?: import('@insiderfinance/totalfinance/backtest/options').MarkingPolicy; default: not declared — How open legs are marked at every snapshot (default: current quote; refuse a missing mark). - options.marking.maximumQuoteAgeMs?: number; default: not declared — A current quote whose `timestampMs` is older than the snapshot's `asOf` by more than this is STALE and cannot mark (it falls to `missingMark`). Omitted ⇒ every quote a snapshot carries is current by definition of the snapshot. - options.marking.missingMark?: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared — What happens when the current contract cannot mark a leg under `'current-quote'`: `'refuse'` (DEFAULT) throws `backtest.mark_unavailable` naming the leg, the snapshot, and the cause; `'entry-volatility'` marks THAT leg at its entry volatility for THAT snapshot; `'carry-last-volatility'` holds the leg's last successfully marked volatility (the mark still reprices for spot and time). Both fallbacks are counted per trade and warned once per cause. - options.marking.volatility?: 'current-quote' | 'entry'; default: not declared — `'current-quote'` (DEFAULT) re-marks each open leg from the exact current-snapshot contract quote — its stated implied volatility, or one implied from the quote's selected price. `'entry'` holds each leg's entry volatility for the whole trade (the pre-P1 behaviour, now explicit). - options.periodsPerYear?: number; default: not declared — Annualization factor for the performance summary (default 252). - options.quoteFreshness?: import('@insiderfinance/totalfinance/backtest/options').QuoteFreshnessPolicy; default: not declared — Refuse fills on stale quotes. - options.quoteFreshness.maximumQuoteAgeMs: number; default: not declared - options.riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal) for every mark-to-market price and the assignment carry. REQUIRED: a backtest that silently priced at 4% was a financial assumption nobody stated. - options.roll?: import('@insiderfinance/totalfinance/backtest/options').RollRule; default: not declared — Roll instead of closing flat when the rule fires. - options.roll.when?: import('@insiderfinance/totalfinance/backtest/options').ExitRule; default: not declared — When to roll (defaults to the same triggers as {@link ExitRule}). - options.roll.when.daysToExpiry?: number; default: not declared — Close at or below this many days to expiry. - options.roll.when.profitTarget?: number; default: not declared — Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). - options.roll.when.stopLoss?: number; default: not declared — Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). - options.roll.when.when?: (context: import('@insiderfinance/totalfinance/backtest/options').ExitContext) => boolean; default: not declared — Arbitrary exit predicate (OR-combined with the declarative triggers). - options.roll.when.when(context): import('@insiderfinance/totalfinance/backtest/options').ExitContext; default: not declared - options.roll.when.when(context).asOf: number; default: not declared - options.roll.when.when(context).daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - options.roll.when.when(context).entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - options.roll.when.when(context).greeks: import('@insiderfinance/totalfinance/options').Greeks; default: not declared - options.roll.when.when(context).markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - options.roll.when.when(context).netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - options.roll.when.when(context).pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - options.roll.when.when(context).position: import('@insiderfinance/totalfinance/strategy').Position; default: not declared - options.roll.when.when(context).snapshot: import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot; default: not declared - options.rules?: readonly import('@insiderfinance/totalfinance/backtest/options').EntryRule[]; default: not declared — Several rules at once (Stage 4.6): each a member of the book, entered in order at every snapshot. - options.slippage?: SlippageModel; default: not declared — Slippage model for option trades (default none). - options.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - options.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - options.slippage.fill(input).quantity: number; default: not declared - options.slippage.fill(input).referencePrice: number; default: not declared - options.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - options.slippage.label: string; default: not declared - portfolio: PortfolioBacktestRequest; default: not declared - portfolio.accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - portfolio.accounting.baseCurrency: string; default: not declared - portfolio.accounting.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - portfolio.accounting.lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Default `'fifo'`. - portfolio.accounting.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. - portfolio.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - portfolio.execution?: ExecutionPolicy; default: not declared - portfolio.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - portfolio.execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - portfolio.execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - portfolio.execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - portfolio.execution.costs.borrow.label: string; default: not declared - portfolio.execution.costs.commission: CostModel; default: not declared - portfolio.execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - portfolio.execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - portfolio.execution.costs.commission.commission(input).price: number; default: not declared - portfolio.execution.costs.commission.commission(input).quantity: number; default: not declared - portfolio.execution.costs.commission.label: string; default: not declared - portfolio.execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - portfolio.execution.costs.latency.label: string; default: not declared - portfolio.execution.costs.latency.sessions: number; default: not declared - portfolio.execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - portfolio.execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - portfolio.execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - portfolio.execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - portfolio.execution.costs.marketImpact.impact(input).quantity: number; default: not declared - portfolio.execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - portfolio.execution.costs.marketImpact.label: string; default: not declared - portfolio.execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - portfolio.execution.costs.slippage: SlippageModel; default: not declared - portfolio.execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - portfolio.execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - portfolio.execution.costs.slippage.fill(input).quantity: number; default: not declared - portfolio.execution.costs.slippage.fill(input).referencePrice: number; default: not declared - portfolio.execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - portfolio.execution.costs.slippage.label: string; default: not declared - portfolio.execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - portfolio.execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - portfolio.execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - portfolio.execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - portfolio.execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - portfolio.execution.costs.spread.label: string; default: not declared - portfolio.execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - portfolio.execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - portfolio.execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - portfolio.execution.fill.fill().return.detail?: string; default: not declared - portfolio.execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - portfolio.execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - portfolio.execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - portfolio.execution.fill.fill().return.pricePerUnit: number; default: not declared - portfolio.execution.fill.fill().return.quantity: number; default: not declared - portfolio.execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - portfolio.execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - portfolio.execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - portfolio.execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - portfolio.execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - portfolio.execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - portfolio.execution.fill.label: string; default: not declared - portfolio.execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - portfolio.execution.fill.version: string; default: not declared - portfolio.execution.label: string; default: not declared — Echoed in every result's assumptions. - portfolio.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - portfolio.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - portfolio.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - portfolio.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - portfolio.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - portfolio.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - portfolio.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - portfolio.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - portfolio.execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - portfolio.execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - portfolio.execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - portfolio.execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - portfolio.execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - portfolio.execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - portfolio.execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - portfolio.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - portfolio.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - portfolio.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - portfolio.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - portfolio.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - portfolio.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - portfolio.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - portfolio.instruments: Readonly>; default: not declared - portfolio.marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - portfolio.marketData.bars?: readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - portfolio.marketData.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared - portfolio.marketData.coupons?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').CouponRecord[]; default: not declared - portfolio.marketData.dividends?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DividendRecord[]; default: not declared - portfolio.marketData.forwardRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - portfolio.marketData.fundingRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').FundingRateRecord[]; default: not declared - portfolio.marketData.fxRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - portfolio.marketData.optionChains?: readonly import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot[]; default: not declared - portfolio.marketData.orderBooks?: readonly import('@insiderfinance/totalfinance/core').OrderBook[]; default: not declared - portfolio.marketData.quotes?: readonly import('@insiderfinance/totalfinance/core').Quote[]; default: not declared - portfolio.marketData.trades?: readonly import('@insiderfinance/totalfinance/core').Trade[]; default: not declared - portfolio.periodsPerYear?: number; default: not declared - portfolio.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - portfolio.strategy: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioStrategy; default: not declared - portfolio.strategy.model: import('@insiderfinance/totalfinance/portfolio').ModelPortfolio | readonly import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared — A model artifact or inline targets, proposed on the schedule through `proposePortfolioRebalance`. - portfolio.strategy.model.baseCurrency: string; default: not declared - portfolio.strategy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - portfolio.strategy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - portfolio.strategy.model.benchmark.benchmarkId: string; default: not declared - portfolio.strategy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - portfolio.strategy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - portfolio.strategy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - portfolio.strategy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - portfolio.strategy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - portfolio.strategy.model.horizonEndDate?: string | number; default: not declared - portfolio.strategy.model.kind: 'totalfinance.model-portfolio'; default: not declared - portfolio.strategy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - portfolio.strategy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - portfolio.strategy.model.liabilities.note?: string; default: not declared - portfolio.strategy.model.modelId: string; default: not declared - portfolio.strategy.model.note?: string; default: not declared - portfolio.strategy.model.schemaVersion: number; default: not declared - portfolio.strategy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - portfolio.strategy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - portfolio.strategy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - portfolio.strategy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - portfolio.strategy.model.strategic.note?: string; default: not declared - portfolio.strategy.model.strategic.targets: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - portfolio.strategy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - portfolio.strategy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - portfolio.strategy.onSession: (context: import('@insiderfinance/totalfinance/backtest/portfolio').SessionContext) => readonly import('@insiderfinance/totalfinance/backtest/execution').OrderIntent[]; default: not declared — Direct TypeScript; the run is not replayable. - portfolio.strategy.onSession(context): import('@insiderfinance/totalfinance/backtest/portfolio').SessionContext; default: not declared - portfolio.strategy.onSession(context).asOf: number; default: not declared - portfolio.strategy.onSession(context).cash: readonly { currency: string; amount: number; }[]; default: not declared - portfolio.strategy.onSession(context).index: number; default: not declared - portfolio.strategy.onSession(context).instruments: Readonly>; default: not declared - portfolio.strategy.onSession(context).marks: Readonly>; default: not declared — Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). - portfolio.strategy.onSession(context).netAssetValue: number; default: not declared - portfolio.strategy.onSession(context).observations: Readonly>; default: not declared — The latest observations per instrument at the instant. - portfolio.strategy.onSession(context).positions: readonly import('@insiderfinance/totalfinance/backtest/portfolio').SessionPosition[]; default: not declared - portfolio.strategy.policy?: import('@insiderfinance/totalfinance/portfolio').InvestmentPolicy; default: not declared - portfolio.strategy.policy.allowedAccounts?: string[]; default: not declared - portfolio.strategy.policy.allowedInstruments?: string[]; default: not declared - portfolio.strategy.policy.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - portfolio.strategy.policy.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - portfolio.strategy.policy.benchmark.benchmarkId: string; default: not declared - portfolio.strategy.policy.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - portfolio.strategy.policy.contributionHandling?: import('@insiderfinance/totalfinance/portfolio').ContributionHandling; default: not declared - portfolio.strategy.policy.driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - portfolio.strategy.policy.incomeReinvestment?: import('@insiderfinance/totalfinance/portfolio').IncomeReinvestment; default: not declared - portfolio.strategy.policy.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - portfolio.strategy.policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - portfolio.strategy.policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - portfolio.strategy.policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - portfolio.strategy.policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - portfolio.strategy.policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - portfolio.strategy.policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - portfolio.strategy.policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - portfolio.strategy.policy.lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - portfolio.strategy.policy.maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - portfolio.strategy.policy.maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - portfolio.strategy.policy.minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - portfolio.strategy.policy.minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - portfolio.strategy.policy.model?: import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared - portfolio.strategy.policy.model.baseCurrency: string; default: not declared - portfolio.strategy.policy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - portfolio.strategy.policy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - portfolio.strategy.policy.model.benchmark.benchmarkId: string; default: not declared - portfolio.strategy.policy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - portfolio.strategy.policy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - portfolio.strategy.policy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - portfolio.strategy.policy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - portfolio.strategy.policy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - portfolio.strategy.policy.model.horizonEndDate?: string | number; default: not declared - portfolio.strategy.policy.model.kind: 'totalfinance.model-portfolio'; default: not declared - portfolio.strategy.policy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - portfolio.strategy.policy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - portfolio.strategy.policy.model.liabilities.note?: string; default: not declared - portfolio.strategy.policy.model.modelId: string; default: not declared - portfolio.strategy.policy.model.note?: string; default: not declared - portfolio.strategy.policy.model.schemaVersion: number; default: not declared - portfolio.strategy.policy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - portfolio.strategy.policy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - portfolio.strategy.policy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - portfolio.strategy.policy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - portfolio.strategy.policy.model.strategic.note?: string; default: not declared - portfolio.strategy.policy.model.strategic.targets: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - portfolio.strategy.policy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - portfolio.strategy.policy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - portfolio.strategy.policy.performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - portfolio.strategy.policy.restrictedInstruments?: string[]; default: not declared - portfolio.strategy.policy.reviewCadenceDays?: number; default: not declared - portfolio.strategy.policy.targets?: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - portfolio.strategy.policy.withdrawalHandling?: import('@insiderfinance/totalfinance/portfolio').WithdrawalHandling; default: not declared - portfolio.strategy.policy.withinGroupAllocation?: import('@insiderfinance/totalfinance/portfolio').WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. - portfolio.strategy.schedule: import('@insiderfinance/totalfinance/backtest/portfolio').RebalanceSchedule; default: not declared - portfolio.strategy.schedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - portfolio.strategy.scope?: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; default: not declared — Default `'to-target'`. - portfolio.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - portfolio.window.fromTimestampMs?: number; default: not declared - portfolio.window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The run kinds this subpath records. ```typescript /** The run kinds this subpath records. */ export type BacktestRunKind = 'cross-sectional' | 'cross-sectional-grid' | 'options' | 'portfolio' | 'environment'; ``` ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunKindDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The frozen, data-only description of one run kind. ```typescript /** The frozen, data-only description of one run kind. */ export interface BacktestRunKindDescriptor { kind: BacktestRunKind; runVersion: number; /** The direct verb the run re-issues on replay. */ operation: string; /** Bulk row sets of the request (dotted paths); each may be embedded or referenced by table handle. */ inputRowSets: readonly string[]; /** Bulk row sets of the run (dotted paths under `run.`); each may be embedded or referenced. */ resultRowSets: readonly string[]; /** Request fields that, when they carry a caller function, make the run non-replayable. */ callbackFields: readonly string[]; /** Request fields recorded by description (execution policy, cost models); replay takes them back as `models`. */ modelFields: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callbackFields: readonly string[]; default: not declared — Request fields that, when they carry a caller function, make the run non-replayable. - inputRowSets: readonly string[]; default: not declared — Bulk row sets of the request (dotted paths); each may be embedded or referenced by table handle. - kind: BacktestRunKind; default: not declared - modelFields: readonly string[]; default: not declared — Request fields recorded by description (execution policy, cost models); replay takes them back as `models`. - operation: string; default: not declared — The direct verb the run re-issues on replay. - resultRowSets: readonly string[]; default: not declared — Bulk row sets of the run (dotted paths under `run.`); each may be embedded or referenced. - runVersion: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunReplay Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BacktestRunReplay { kind: Kind; artifactId: string; /** The recomputed report (the same projection as the saved one). */ recomputed: BacktestRunReport; runHash: { saved: string; recomputed: string; }; /** `true` exactly when the recomputed run hash equals the saved one. */ matches: boolean; parity: ArtifactReplayParity; assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; models: { execution: 'recorded-default' | 'supplied' | 'none'; transactionCostModel: 'supplied' | 'none'; }; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactId: string; default: not declared - assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; models: { execution: 'recorded-default' | 'supplied' | 'none'; transactionCostModel: 'supplied' | 'none'; }; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.kind: Kind; default: not declared - assumptions.libraryVersion: { current: string | null; saved: string | null; }; default: not declared - assumptions.libraryVersion.current: string | null; default: not declared - assumptions.libraryVersion.saved: string | null; default: not declared - assumptions.models: { execution: 'recorded-default' | 'supplied' | 'none'; transactionCostModel: 'supplied' | 'none'; }; default: not declared - assumptions.models.execution: 'none' | 'supplied' | 'recorded-default'; default: not declared - assumptions.models.transactionCostModel: 'none' | 'supplied'; default: not declared - assumptions.operation: string; default: not declared - assumptions.referencedRowSets: string[]; default: not declared - assumptions.runVersion: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - kind: Kind; default: not declared - matches: boolean; default: not declared — `true` exactly when the recomputed run hash equals the saved one. - parity: ArtifactReplayParity; default: not declared - parity.addedPaths: string[]; default: not declared - parity.assumptions: { conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; comparison: 'canonical JSON bytes'; }; default: not declared - parity.assumptions.comparison: 'canonical JSON bytes'; default: not declared - parity.assumptions.conventionsVersion: string; default: not declared - parity.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - parity.assumptions.limits.maximumDifferences: number; default: not declared - parity.assumptions.limits.maximumLeaves: number; default: not declared - parity.comparedLeafCount: number; default: not declared - parity.diagnostics: { warnings: QuantWarning[]; }; default: not declared - parity.diagnostics.warnings: QuantWarning[]; default: not declared - parity.differenceCount: number; default: not declared - parity.differences: import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]; default: not declared - parity.identical: boolean; default: not declared - parity.recomputedHash: string; default: not declared - parity.removedPaths: string[]; default: not declared - parity.savedHash: string; default: not declared - parity.truncated: boolean; default: not declared - recomputed: BacktestRunReport; default: not declared — The recomputed report (the same projection as the saved one). - recomputed.assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; modelPolicy: string; projection: string; }; default: not declared - recomputed.assumptions.conventionsVersion: string; default: not declared - recomputed.assumptions.embeddedRowLimit: number; default: not declared - recomputed.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - recomputed.assumptions.kind: Kind; default: not declared - recomputed.assumptions.modelPolicy: string; default: not declared - recomputed.assumptions.nonReplayableField: string | null; default: not declared - recomputed.assumptions.operation: string; default: not declared - recomputed.assumptions.projection: string; default: not declared - recomputed.assumptions.replayable: boolean; default: not declared — `false` exactly when a caller function participated. - recomputed.assumptions.runVersion: number; default: not declared - recomputed.diagnostics: { warnings: QuantWarning[]; embeddedRows: number; referencedRows: number; runWarningCount: number; }; default: not declared - recomputed.diagnostics.embeddedRows: number; default: not declared - recomputed.diagnostics.referencedRows: number; default: not declared - recomputed.diagnostics.runWarningCount: number; default: not declared - recomputed.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.execution: { completed: true; }; default: not declared — Reserved (Decision 8): a cooperative checkpoint/resume lands in Stage 7B without changing the format. - recomputed.execution.completed: true; default: not declared - recomputed.hygiene: BacktestHygieneBlock | null; default: not declared — The caller's hygiene block (single runs) or the grid's own verdicts (grids), verbatim. - recomputed.hygiene.backtestOverfitting?: Record; default: not declared - recomputed.hygiene.deflatedSharpe?: Record; default: not declared - recomputed.hygiene.researchProtocol?: Record; default: not declared - recomputed.identity: BacktestRunIdentity; default: not declared - recomputed.identity.annualization: { periodsPerYear: number; riskFreeRate: number; }; default: not declared - recomputed.identity.annualization.periodsPerYear: number; default: not declared - recomputed.identity.annualization.riskFreeRate: number; default: not declared - recomputed.identity.baseCurrency: string; default: not declared - recomputed.identity.benchmark: boolean; default: not declared - recomputed.identity.calendar: { firstMarkTimestampMs: number | null; lastMarkTimestampMs: number | null; sessions: number; }; default: not declared - recomputed.identity.calendar.firstMarkTimestampMs: number | null; default: not declared - recomputed.identity.calendar.lastMarkTimestampMs: number | null; default: not declared - recomputed.identity.calendar.sessions: number; default: not declared - recomputed.identity.childRunIds: string[] | null; default: not declared — Every child run id, in variation order (grids only). - recomputed.identity.conventions: { conventionsVersion: string; pricing: string; sessionInstantConvention: string; }; default: not declared - recomputed.identity.conventions.conventionsVersion: string; default: not declared - recomputed.identity.conventions.pricing: string; default: not declared - recomputed.identity.conventions.sessionInstantConvention: string; default: not declared - recomputed.identity.engine: { operation: string; runVersion: number; }; default: not declared - recomputed.identity.engine.operation: string; default: not declared - recomputed.identity.engine.runVersion: number; default: not declared - recomputed.identity.initialCapital: number; default: not declared - recomputed.identity.models: RecordedModels; default: not declared - recomputed.identity.models.commission: string | null; default: not declared - recomputed.identity.models.execution: ExecutionPolicyDescription | null; default: not declared - recomputed.identity.models.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - recomputed.identity.models.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - recomputed.identity.models.execution.costs.borrow: string | null; default: not declared - recomputed.identity.models.execution.costs.commission: string; default: not declared - recomputed.identity.models.execution.costs.latencySessions: number | null; default: not declared - recomputed.identity.models.execution.costs.marketImpact: string | null; default: not declared - recomputed.identity.models.execution.costs.participation: number | null; default: not declared - recomputed.identity.models.execution.costs.slippage: string; default: not declared - recomputed.identity.models.execution.costs.spread: string | null; default: not declared - recomputed.identity.models.execution.fill: { label: string; version: string; }; default: not declared - recomputed.identity.models.execution.fill.label: string; default: not declared - recomputed.identity.models.execution.fill.version: string; default: not declared - recomputed.identity.models.execution.label: string; default: not declared - recomputed.identity.models.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - recomputed.identity.models.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - recomputed.identity.models.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - recomputed.identity.models.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - recomputed.identity.models.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - recomputed.identity.models.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - recomputed.identity.models.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - recomputed.identity.models.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - recomputed.identity.models.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - recomputed.identity.models.execution.realism: 'simplified' | 'declared'; default: not declared - recomputed.identity.models.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - recomputed.identity.models.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - recomputed.identity.models.execution.sessions.halts: number; default: not declared - recomputed.identity.models.execution.sessions.priceLimits: number; default: not declared - recomputed.identity.models.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - recomputed.identity.models.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - recomputed.identity.models.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - recomputed.identity.models.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - recomputed.identity.models.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - recomputed.identity.models.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - recomputed.identity.models.slippage: string | null; default: not declared - recomputed.identity.pointInTimePolicy: string; default: not declared - recomputed.identity.recipe: { recipeName: string; recipeVersion: number; } | null; default: not declared - recomputed.identity.recipe.recipeName: string; default: not declared - recomputed.identity.recipe.recipeVersion: number; default: not declared - recomputed.identity.runId: string; default: not declared — The engine's content-addressed run id (the sweep id for a grid). - recomputed.identity.seed: number | null; default: not declared - recomputed.identity.strategy: Record; default: not declared — The signal as the engine disclosed it (`assumptions.signal`). - recomputed.identity.universeHistoryHash: string; default: not declared — Content hash of the universe history's member rows. - recomputed.identity.universeId: string; default: not declared - recomputed.identity.variations: { path: string; values: unknown[]; }[] | null; default: not declared — The grid's axes (grids only). - recomputed.inputs: Record; default: not declared — The request with bulk row sets embedded or referenced, callbacks omitted, models by description. - recomputed.kind: Kind; default: not declared - recomputed.referencedData: Record; default: not declared — Table references for every row set that was not embedded, keyed by label (`dataset.returns`, `run.holdings`). - recomputed.run: Record; default: not declared — The verb's result verbatim, with referenced result row sets replaced by their table handles. - recomputed.runHash: string; default: not declared — `contentHash` of the stored run (the projection above) — the run's identity. - recomputed.runVersion: number; default: not declared - runHash: { recomputed: string; saved: string; }; default: not declared - runHash.recomputed: string; default: not declared - runHash.saved: string; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The typed report every verb reads and writes — the artifact's `result`, verbatim. ```typescript /** The typed report every verb reads and writes — the artifact's `result`, verbatim. */ export type BacktestRunReport = Readonly> & { kind: Kind; runVersion: number; /** The verb's result verbatim, with referenced result row sets replaced by their table handles. */ run: Record; /** The request with bulk row sets embedded or referenced, callbacks omitted, models by description. */ inputs: Record; /** Table references for every row set that was not embedded, keyed by label (`dataset.returns`, `run.holdings`). */ referencedData: Record; /** `contentHash` of the stored run (the projection above) — the run's identity. */ runHash: string; identity: BacktestRunIdentity; /** The caller's hygiene block (single runs) or the grid's own verdicts (grids), verbatim. */ hygiene: BacktestHygieneBlock | null; /** Reserved (Decision 8): a cooperative checkpoint/resume lands in Stage 7B without changing the format. */ execution: { completed: true; }; assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; /** `false` exactly when a caller function participated. */ replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; modelPolicy: string; projection: string; }; diagnostics: { warnings: QuantWarning[]; embeddedRows: number; referencedRows: number; runWarningCount: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; modelPolicy: string; projection: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.embeddedRowLimit: number; default: not declared - assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - assumptions.kind: Kind; default: not declared - assumptions.modelPolicy: string; default: not declared - assumptions.nonReplayableField: string | null; default: not declared - assumptions.operation: string; default: not declared - assumptions.projection: string; default: not declared - assumptions.replayable: boolean; default: not declared — `false` exactly when a caller function participated. - assumptions.runVersion: number; default: not declared - diagnostics: { embeddedRows: number; referencedRows: number; runWarningCount: number; warnings: QuantWarning[]; }; default: not declared - diagnostics.embeddedRows: number; default: not declared - diagnostics.referencedRows: number; default: not declared - diagnostics.runWarningCount: number; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - execution: { completed: true; }; default: not declared — Reserved (Decision 8): a cooperative checkpoint/resume lands in Stage 7B without changing the format. - execution.completed: true; default: not declared - hygiene: BacktestHygieneBlock | null; default: not declared — The caller's hygiene block (single runs) or the grid's own verdicts (grids), verbatim. - hygiene.backtestOverfitting?: Record; default: not declared - hygiene.deflatedSharpe?: Record; default: not declared - hygiene.researchProtocol?: Record; default: not declared - identity: BacktestRunIdentity; default: not declared - identity.annualization: { periodsPerYear: number; riskFreeRate: number; }; default: not declared - identity.annualization.periodsPerYear: number; default: not declared - identity.annualization.riskFreeRate: number; default: not declared - identity.baseCurrency: string; default: not declared - identity.benchmark: boolean; default: not declared - identity.calendar: { firstMarkTimestampMs: number | null; lastMarkTimestampMs: number | null; sessions: number; }; default: not declared - identity.calendar.firstMarkTimestampMs: number | null; default: not declared - identity.calendar.lastMarkTimestampMs: number | null; default: not declared - identity.calendar.sessions: number; default: not declared - identity.childRunIds: string[] | null; default: not declared — Every child run id, in variation order (grids only). - identity.conventions: { conventionsVersion: string; pricing: string; sessionInstantConvention: string; }; default: not declared - identity.conventions.conventionsVersion: string; default: not declared - identity.conventions.pricing: string; default: not declared - identity.conventions.sessionInstantConvention: string; default: not declared - identity.engine: { operation: string; runVersion: number; }; default: not declared - identity.engine.operation: string; default: not declared - identity.engine.runVersion: number; default: not declared - identity.initialCapital: number; default: not declared - identity.models: RecordedModels; default: not declared - identity.models.commission: string | null; default: not declared - identity.models.execution: ExecutionPolicyDescription | null; default: not declared - identity.models.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - identity.models.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - identity.models.execution.costs.borrow: string | null; default: not declared - identity.models.execution.costs.commission: string; default: not declared - identity.models.execution.costs.latencySessions: number | null; default: not declared - identity.models.execution.costs.marketImpact: string | null; default: not declared - identity.models.execution.costs.participation: number | null; default: not declared - identity.models.execution.costs.slippage: string; default: not declared - identity.models.execution.costs.spread: string | null; default: not declared - identity.models.execution.fill: { label: string; version: string; }; default: not declared - identity.models.execution.fill.label: string; default: not declared - identity.models.execution.fill.version: string; default: not declared - identity.models.execution.label: string; default: not declared - identity.models.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - identity.models.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - identity.models.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - identity.models.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - identity.models.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - identity.models.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - identity.models.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - identity.models.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - identity.models.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - identity.models.execution.realism: 'simplified' | 'declared'; default: not declared - identity.models.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - identity.models.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - identity.models.execution.sessions.halts: number; default: not declared - identity.models.execution.sessions.priceLimits: number; default: not declared - identity.models.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - identity.models.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - identity.models.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - identity.models.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - identity.models.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - identity.models.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - identity.models.slippage: string | null; default: not declared - identity.pointInTimePolicy: string; default: not declared - identity.recipe: { recipeName: string; recipeVersion: number; } | null; default: not declared - identity.recipe.recipeName: string; default: not declared - identity.recipe.recipeVersion: number; default: not declared - identity.runId: string; default: not declared — The engine's content-addressed run id (the sweep id for a grid). - identity.seed: number | null; default: not declared - identity.strategy: Record; default: not declared — The signal as the engine disclosed it (`assumptions.signal`). - identity.universeHistoryHash: string; default: not declared — Content hash of the universe history's member rows. - identity.universeId: string; default: not declared - identity.variations: { path: string; values: unknown[]; }[] | null; default: not declared — The grid's axes (grids only). - inputs: Record; default: not declared — The request with bulk row sets embedded or referenced, callbacks omitted, models by description. - kind: Kind; default: not declared - referencedData: Record; default: not declared — Table references for every row set that was not embedded, keyed by label (`dataset.returns`, `run.holdings`). - run: Record; default: not declared — The verb's result verbatim, with referenced result row sets replaced by their table handles. - runHash: string; default: not declared — `contentHash` of the stored run (the projection above) — the run's identity. - runVersion: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#BacktestRunResults Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BacktestRunResults { 'cross-sectional': CrossSectionalBacktestResult; 'cross-sectional-grid': CrossSectionalBacktestGridResult; options: OptionsBacktestResult; portfolio: PortfolioBacktestResult; environment: EnvironmentEpisodeResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cross-sectional: CrossSectionalBacktestResult; default: not declared - cross-sectional-grid: CrossSectionalBacktestGridResult; default: not declared - cross-sectional-grid.assumptions: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridAssumptions; default: not declared - cross-sectional-grid.assumptions.conventionsVersion: string; default: not declared - cross-sectional-grid.assumptions.hygiene: { confidence: number; degenerateTrialSharpe: 0; splits: number | null; }; default: not declared - cross-sectional-grid.assumptions.hygiene.confidence: number; default: not declared - cross-sectional-grid.assumptions.hygiene.degenerateTrialSharpe: 0; default: not declared — The trial Sharpe recorded for a degenerate return series. - cross-sectional-grid.assumptions.hygiene.splits: number | null; default: not declared — The CSCV blocks actually used, or `null` when the overfitting probability was not computed. - cross-sectional-grid.assumptions.maximumVariations: number; default: not declared - cross-sectional-grid.assumptions.paths: string[]; default: not declared - cross-sectional-grid.assumptions.periodsPerYear: number; default: not declared - cross-sectional-grid.assumptions.riskFreeRate: number; default: not declared - cross-sectional-grid.assumptions.selectionMetric: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared - cross-sectional-grid.assumptions.variationCount: number; default: not declared - cross-sectional-grid.best: { index: number; metric: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; runId: string; value: number; } | null; default: not declared — The best trial by the selection metric, or `null` when no variation carries the metric. - cross-sectional-grid.best.index: number; default: not declared - cross-sectional-grid.best.metric: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridSelectionMetric; default: not declared - cross-sectional-grid.best.runId: string; default: not declared - cross-sectional-grid.best.value: number; default: not declared - cross-sectional-grid.diagnostics: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridDiagnostics; default: not declared - cross-sectional-grid.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cross-sectional-grid.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cross-sectional-grid.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cross-sectional-grid.diagnostics.degenerateTrialCount: number; default: not declared - cross-sectional-grid.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cross-sectional-grid.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cross-sectional-grid.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cross-sectional-grid.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cross-sectional-grid.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cross-sectional-grid.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - cross-sectional-grid.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - cross-sectional-grid.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - cross-sectional-grid.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - cross-sectional-grid.diagnostics.selection.selected.name: string; default: not declared - cross-sectional-grid.diagnostics.selection.selected.version?: string; default: not declared - cross-sectional-grid.diagnostics.skippedHygiene: { block: 'researchProtocol' | 'backtestOverfitting' | 'deflatedSharpe'; reason: string; }[]; default: not declared — The hygiene blocks that were not computed, each with its reason. - cross-sectional-grid.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cross-sectional-grid.diagnostics.variationCount: number; default: not declared - cross-sectional-grid.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cross-sectional-grid.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cross-sectional-grid.hygiene: import('@insiderfinance/totalfinance/backtest/cross-sectional').GridHygiene; default: not declared - cross-sectional-grid.hygiene.backtestOverfitting: import('@insiderfinance/totalfinance/risk').BacktestOverfittingProbabilityResult | null; default: not declared — `probabilityOfBacktestOverfitting` over the periods × variations return matrix; `null` when fewer than two variations or too few periods. - cross-sectional-grid.hygiene.backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - cross-sectional-grid.hygiene.backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - cross-sectional-grid.hygiene.backtestOverfitting.backtestOverfittingProbability: number; default: not declared — Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. - cross-sectional-grid.hygiene.backtestOverfitting.combinations: number; default: not declared — Number of symmetric train/test splits evaluated: `C(S, S/2)`. - cross-sectional-grid.hygiene.backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - cross-sectional-grid.hygiene.backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - cross-sectional-grid.hygiene.backtestOverfitting.medianLogit: number; default: not declared — Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. - cross-sectional-grid.hygiene.backtestOverfitting.observations: number; default: not declared — Observations (rows) used after trimming to a multiple of `S`. - cross-sectional-grid.hygiene.backtestOverfitting.splits: number; default: not declared — Blocks `S` actually used. - cross-sectional-grid.hygiene.backtestOverfitting.trials: number; default: not declared — Number of strategy configurations (columns) `N`. - cross-sectional-grid.hygiene.deflatedSharpe: import('@insiderfinance/totalfinance/risk').DeflatedSharpeResult | null; default: not declared — `deflatedSharpeRatio` for the best trial against the pool; `null` when the best trial is degenerate. - cross-sectional-grid.hygiene.deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - cross-sectional-grid.hygiene.deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - cross-sectional-grid.hygiene.deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carry no Sharpe (a zero-variance series). - cross-sectional-grid.hygiene.deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - cross-sectional-grid.hygiene.deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - cross-sectional-grid.hygiene.deflatedSharpe.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. - cross-sectional-grid.hygiene.deflatedSharpe.probabilisticSharpe: number | null; default: not declared — The un-deflated PSR (benchmark 0), for comparison. - cross-sectional-grid.hygiene.deflatedSharpe.trialCount: number; default: not declared - cross-sectional-grid.hygiene.researchProtocol: import('@insiderfinance/totalfinance/risk').ResearchVerdict | null; default: not declared — `researchProtocol` over the best trial's returns with the pool; `null` when the best trial is degenerate. - cross-sectional-grid.hygiene.researchProtocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - cross-sectional-grid.hygiene.researchProtocol.assumptions.confidence: number; default: not declared - cross-sectional-grid.hygiene.researchProtocol.assumptions.conventionsVersion: string; default: not declared - cross-sectional-grid.hygiene.researchProtocol.assumptions.periodsPerYear: number; default: not declared - cross-sectional-grid.hygiene.researchProtocol.deflatedSharpe: number | null; default: not declared — Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. - cross-sectional-grid.hygiene.researchProtocol.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - cross-sectional-grid.hygiene.researchProtocol.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cross-sectional-grid.hygiene.researchProtocol.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cross-sectional-grid.hygiene.researchProtocol.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection.selected.name: string; default: not declared - cross-sectional-grid.hygiene.researchProtocol.diagnostics.selection.selected.version?: string; default: not declared - cross-sectional-grid.hygiene.researchProtocol.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cross-sectional-grid.hygiene.researchProtocol.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cross-sectional-grid.hygiene.researchProtocol.expectedMaxSharpe: number; default: not declared — SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). - cross-sectional-grid.hygiene.researchProtocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. - cross-sectional-grid.hygiene.researchProtocol.inSample.annualizedSharpe: number | null; default: not declared - cross-sectional-grid.hygiene.researchProtocol.inSample.observations: number; default: not declared - cross-sectional-grid.hygiene.researchProtocol.inSample.sharpe: number | null; default: not declared - cross-sectional-grid.hygiene.researchProtocol.minTrackRecordLength: number; default: not declared — Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). - cross-sectional-grid.hygiene.researchProtocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared — Present when out-of-sample returns are given; `null` figures when either series has zero variance. - cross-sectional-grid.hygiene.researchProtocol.outOfSample.annualizedSharpe: number | null; default: not declared - cross-sectional-grid.hygiene.researchProtocol.outOfSample.degradation: number | null; default: not declared - cross-sectional-grid.hygiene.researchProtocol.outOfSample.sharpe: number | null; default: not declared - cross-sectional-grid.hygiene.researchProtocol.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. - cross-sectional-grid.hygiene.researchProtocol.rationale: string; default: not declared — Prose an agent relays. - cross-sectional-grid.hygiene.researchProtocol.trialCount: number; default: not declared - cross-sectional-grid.hygiene.researchProtocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - cross-sectional-grid.hygiene.trialSharpes: number[]; default: not declared — The trial Sharpes in variation order — the pool `researchProtocol` deflates against. - cross-sectional-grid.runs: CrossSectionalBacktestResult[]; default: not declared — Every child run, index-aligned with `variations` — the same function, called once per point. - cross-sectional-grid.sweepId: string; default: not declared — The parent sweep hash: the content hash of the axes and every child run hash. - cross-sectional-grid.variations: import('@insiderfinance/totalfinance/backtest').GridVariationRow[]; default: not declared - cross-sectional.assumptions: import('@insiderfinance/totalfinance/backtest').CrossSectionalAssumptions; default: not declared - cross-sectional.assumptions.baseCurrency: string; default: not declared - cross-sectional.assumptions.conventionsVersion: string; default: not declared - cross-sectional.assumptions.costs: { commission: string; slippage: string; }; default: not declared - cross-sectional.assumptions.costs.commission: string; default: not declared - cross-sectional.assumptions.costs.slippage: string; default: not declared - cross-sectional.assumptions.execution: ExecutionPolicyDescription; default: not declared - cross-sectional.assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - cross-sectional.assumptions.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - cross-sectional.assumptions.execution.costs.borrow: string | null; default: not declared - cross-sectional.assumptions.execution.costs.commission: string; default: not declared - cross-sectional.assumptions.execution.costs.latencySessions: number | null; default: not declared - cross-sectional.assumptions.execution.costs.marketImpact: string | null; default: not declared - cross-sectional.assumptions.execution.costs.participation: number | null; default: not declared - cross-sectional.assumptions.execution.costs.slippage: string; default: not declared - cross-sectional.assumptions.execution.costs.spread: string | null; default: not declared - cross-sectional.assumptions.execution.fill: { label: string; version: string; }; default: not declared - cross-sectional.assumptions.execution.fill.label: string; default: not declared - cross-sectional.assumptions.execution.fill.version: string; default: not declared - cross-sectional.assumptions.execution.label: string; default: not declared - cross-sectional.assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - cross-sectional.assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - cross-sectional.assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - cross-sectional.assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - cross-sectional.assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - cross-sectional.assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - cross-sectional.assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - cross-sectional.assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - cross-sectional.assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - cross-sectional.assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - cross-sectional.assumptions.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - cross-sectional.assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - cross-sectional.assumptions.execution.sessions.halts: number; default: not declared - cross-sectional.assumptions.execution.sessions.priceLimits: number; default: not declared - cross-sectional.assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - cross-sectional.assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - cross-sectional.assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - cross-sectional.assumptions.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - cross-sectional.assumptions.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - cross-sectional.assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - cross-sectional.assumptions.initialCapital: number; default: not declared - cross-sectional.assumptions.ledger: { accountId: string; lotRelief: string; sourceId: string; }; default: not declared - cross-sectional.assumptions.ledger.accountId: string; default: not declared - cross-sectional.assumptions.ledger.lotRelief: string; default: not declared - cross-sectional.assumptions.ledger.sourceId: string; default: not declared - cross-sectional.assumptions.periodsPerYear: number; default: not declared - cross-sectional.assumptions.portfolioConstruction: { long: import('@insiderfinance/totalfinance/backtest').SideSelection; maximumParticipation: number | null; maximumPositionWeight: number | null; maximumPositions: number | null; maximumTurnover: number | null; method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; minimumPositionWeight: number | null; neutrality: import('@insiderfinance/totalfinance/backtest').Neutrality; short: import('@insiderfinance/totalfinance/backtest').ShortSideSelection | null; shortBookSizing: string; volatilityLookbackSessions: number; }; default: not declared - cross-sectional.assumptions.portfolioConstruction.long: import('@insiderfinance/totalfinance/backtest').SideSelection; default: not declared - cross-sectional.assumptions.portfolioConstruction.long.count: number; default: not declared - cross-sectional.assumptions.portfolioConstruction.long.fraction: number; default: not declared - cross-sectional.assumptions.portfolioConstruction.long.topQuantile: number; default: not declared - cross-sectional.assumptions.portfolioConstruction.maximumParticipation: number | null; default: not declared - cross-sectional.assumptions.portfolioConstruction.maximumPositionWeight: number | null; default: not declared - cross-sectional.assumptions.portfolioConstruction.maximumPositions: number | null; default: not declared - cross-sectional.assumptions.portfolioConstruction.maximumTurnover: number | null; default: not declared - cross-sectional.assumptions.portfolioConstruction.method: import('@insiderfinance/totalfinance/backtest').WeightingMethod; default: not declared - cross-sectional.assumptions.portfolioConstruction.minimumPositionWeight: number | null; default: not declared - cross-sectional.assumptions.portfolioConstruction.neutrality: import('@insiderfinance/totalfinance/backtest').Neutrality; default: not declared - cross-sectional.assumptions.portfolioConstruction.short: import('@insiderfinance/totalfinance/backtest').ShortSideSelection | null; default: not declared - cross-sectional.assumptions.portfolioConstruction.short.bottomQuantile: number; default: not declared - cross-sectional.assumptions.portfolioConstruction.short.count: number; default: not declared - cross-sectional.assumptions.portfolioConstruction.short.fraction: number; default: not declared - cross-sectional.assumptions.portfolioConstruction.shortBookSizing: string; default: not declared - cross-sectional.assumptions.portfolioConstruction.volatilityLookbackSessions: number; default: not declared - cross-sectional.assumptions.pricing: string; default: not declared - cross-sectional.assumptions.rebalanceSchedule: { bufferBand: number | null; frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; session: 'open' | 'close'; }; default: not declared - cross-sectional.assumptions.rebalanceSchedule.bufferBand: number | null; default: not declared - cross-sectional.assumptions.rebalanceSchedule.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - cross-sectional.assumptions.rebalanceSchedule.session: 'open' | 'close'; default: not declared - cross-sectional.assumptions.replayable: boolean; default: not declared - cross-sectional.assumptions.riskFreeRate: number; default: not declared - cross-sectional.assumptions.seed: number | null; default: not declared - cross-sectional.assumptions.sessionInstantConvention: string; default: not declared - cross-sectional.assumptions.signal: { direction: string; kind: 'factor-recipe'; lagTradingSessions: number; neutralization: string; recipeName: string; recipeVersion: number; } | { components: number; kind: 'score'; missingValuePolicy: string; } | { kind: 'screen'; missingValuePolicy: string; orderBy: string[]; } | { kind: 'callback'; replayable: false; }; default: not declared - cross-sectional.assumptions.signal.components: number; default: not declared - cross-sectional.assumptions.signal.direction: string; default: not declared - cross-sectional.assumptions.signal.kind: ('callback') | ('factor-recipe') | ('score') | ('screen'); default: not declared - cross-sectional.assumptions.signal.lagTradingSessions: number; default: not declared - cross-sectional.assumptions.signal.missingValuePolicy: string; default: not declared - cross-sectional.assumptions.signal.neutralization: string; default: not declared - cross-sectional.assumptions.signal.orderBy: string[]; default: not declared - cross-sectional.assumptions.signal.recipeName: string; default: not declared - cross-sectional.assumptions.signal.recipeVersion: number; default: not declared - cross-sectional.assumptions.signal.replayable: false; default: not declared - cross-sectional.assumptions.universeId: string; default: not declared - cross-sectional.assumptions.window: { fromTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs | null; toTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs | null; }; default: not declared - cross-sectional.assumptions.window.fromTimestampMs: number | null; default: not declared - cross-sectional.assumptions.window.toTimestampMs: number | null; default: not declared - cross-sectional.attribution: import('@insiderfinance/totalfinance/backtest').CrossSectionalAttribution; default: not declared - cross-sectional.attribution.decay: { horizonRebalances: number; meanRankInformationCoefficient: number | null; samples: number; }[]; default: not declared — Mean rank information coefficient per horizon (in rebalances), across rebalances. - cross-sectional.attribution.meanInformationCoefficient: number | null; default: not declared - cross-sectional.attribution.meanRankInformationCoefficient: number | null; default: not declared - cross-sectional.attribution.meanSpreadReturn: number | null; default: not declared - cross-sectional.attribution.perRebalance: import('@insiderfinance/totalfinance/backtest').AttributionRow[]; default: not declared - cross-sectional.benchmark: import('@insiderfinance/totalfinance/backtest').BenchmarkComparison | null; default: not declared - cross-sectional.benchmark.activeReturn: number | null; default: not declared - cross-sectional.benchmark.alpha: number | null; default: not declared - cross-sectional.benchmark.beta: number | null; default: not declared - cross-sectional.benchmark.informationRatio: number | null; default: not declared - cross-sectional.benchmark.instrumentId: string; default: not declared - cross-sectional.benchmark.returns: number[]; default: not declared — The benchmark's per-session simple returns aligned to the run's sessions. - cross-sectional.benchmark.trackingError: number | null; default: not declared - cross-sectional.diagnostics: import('@insiderfinance/totalfinance/backtest').CrossSectionalDiagnostics; default: not declared - cross-sectional.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cross-sectional.diagnostics.cappedGoalCount: number; default: not declared - cross-sectional.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cross-sectional.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cross-sectional.diagnostics.delistingCount: number; default: not declared - cross-sectional.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cross-sectional.diagnostics.exitCount: number; default: not declared - cross-sectional.diagnostics.fillCount: number; default: not declared - cross-sectional.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cross-sectional.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cross-sectional.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cross-sectional.diagnostics.rebalanceCount: number; default: not declared - cross-sectional.diagnostics.reconciliationResidual: number; default: not declared — The ledger's final base-currency NAV minus the reported `finalValue` — always 0 within 1e-9. - cross-sectional.diagnostics.rejectedFillCount: number; default: not declared - cross-sectional.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cross-sectional.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - cross-sectional.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - cross-sectional.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - cross-sectional.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - cross-sectional.diagnostics.selection.selected.name: string; default: not declared - cross-sectional.diagnostics.selection.selected.version?: string; default: not declared - cross-sectional.diagnostics.sessionCount: number; default: not declared - cross-sectional.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cross-sectional.diagnostics.violatedGoalCount: number; default: not declared - cross-sectional.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cross-sectional.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cross-sectional.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - cross-sectional.finalValue: number; default: not declared - cross-sectional.holdings: import('@insiderfinance/totalfinance/backtest').HoldingRow[]; default: not declared - cross-sectional.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - cross-sectional.ledger.baseCurrency: string; default: not declared - cross-sectional.ledger.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - cross-sectional.ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - cross-sectional.ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - cross-sectional.ledger.portfolioId?: string; default: not declared - cross-sectional.ledger.provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - cross-sectional.ledger.provenance.asOf?: number; default: not declared - cross-sectional.ledger.provenance.dataset?: string; default: not declared - cross-sectional.ledger.provenance.provider?: string; default: not declared - cross-sectional.ledger.provenance.receivedAt?: number; default: not declared - cross-sectional.ledger.provenance.requestId?: string; default: not declared - cross-sectional.ledger.provenance.sourceVersion?: string; default: not declared - cross-sectional.ledger.provenance.warnings?: QuantWarning[]; default: not declared - cross-sectional.ledger.schemaVersion: number; default: not declared - cross-sectional.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - cross-sectional.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - cross-sectional.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - cross-sectional.performance.annualizedVolatility: number | null; default: not declared - cross-sectional.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - cross-sectional.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - cross-sectional.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - cross-sectional.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - cross-sectional.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - cross-sectional.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - cross-sectional.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - cross-sectional.performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - cross-sectional.performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - cross-sectional.performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - cross-sectional.performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - cross-sectional.performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - cross-sectional.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - cross-sectional.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - cross-sectional.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - cross-sectional.performance.maxDrawdown: number; default: not declared - cross-sectional.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - cross-sectional.performance.periods: number; default: not declared - cross-sectional.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - cross-sectional.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - cross-sectional.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - cross-sectional.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - cross-sectional.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - cross-sectional.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - cross-sectional.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - cross-sectional.performanceConfidence: { confidenceInterval95: [number, number]; iterations: number; meanTotalReturn: number; seed: number; standardDeviation: number; } | null; default: not declared — Bootstrap confidence intervals of the performance block when a seed was given. - cross-sectional.performanceConfidence.confidenceInterval95: [number, number]; default: not declared - cross-sectional.performanceConfidence.iterations: number; default: not declared - cross-sectional.performanceConfidence.meanTotalReturn: number; default: not declared - cross-sectional.performanceConfidence.seed: number; default: not declared - cross-sectional.performanceConfidence.standardDeviation: number; default: not declared - cross-sectional.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - cross-sectional.rebalances: import('@insiderfinance/totalfinance/backtest').RebalanceRow[]; default: not declared - cross-sectional.returns: number[]; default: not declared - cross-sectional.runId: string; default: not declared - cross-sectional.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared - cross-sectional.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - cross-sectional.timeline.assumptions.conventionsVersion: string; default: not declared - cross-sectional.timeline.assumptions.exposureConvention: string; default: not declared - cross-sectional.timeline.assumptions.indexConvention: string; default: not declared - cross-sectional.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - cross-sectional.timeline.assumptions.markInstant: string; default: not declared - cross-sectional.timeline.baseCurrency: string; default: not declared - cross-sectional.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - cross-sectional.timeline.cumulativePnl.financing: number; default: not declared - cross-sectional.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - cross-sectional.timeline.cumulativePnl.income: number; default: not declared - cross-sectional.timeline.cumulativePnl.realizedPnl: number; default: not declared - cross-sectional.timeline.cumulativePnl.residual: number; default: not declared - cross-sectional.timeline.cumulativePnl.totalPnl: number; default: not declared - cross-sectional.timeline.cumulativePnl.transactionCosts: number; default: not declared - cross-sectional.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - cross-sectional.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - cross-sectional.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - cross-sectional.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - cross-sectional.timeline.diagnostics.markCount: number; default: not declared - cross-sectional.timeline.diagnostics.warnings: string[]; default: not declared - cross-sectional.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - cross-sectional.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - cross-sectional.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - cross-sectional.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - cross-sectional.trades: import('@insiderfinance/totalfinance/backtest').Trade[]; default: not declared - environment: EnvironmentEpisodeResult; default: not declared - environment.assumptions: { conventionsVersion: string; executionPolicy: string; instantCount: number; maximumSteps: number; nextObservationLaw: string; replayable: boolean; }; default: not declared - environment.assumptions.conventionsVersion: string; default: not declared - environment.assumptions.executionPolicy: string; default: not declared - environment.assumptions.instantCount: number; default: not declared - environment.assumptions.maximumSteps: number; default: not declared - environment.assumptions.nextObservationLaw: string; default: not declared - environment.assumptions.replayable: boolean; default: not declared — False with a `goal` callback or a custom adapter — the trace cannot re-issue behavior. - environment.definitionHash: string; default: not declared - environment.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { fillCount: number; rejectionCount: number; stepCount: number; violationCount: number; }; default: not declared - environment.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - environment.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - environment.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - environment.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - environment.diagnostics.fillCount: number; default: not declared - environment.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - environment.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - environment.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - environment.diagnostics.rejectionCount: number; default: not declared - environment.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - environment.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - environment.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - environment.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - environment.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - environment.diagnostics.selection.selected.name: string; default: not declared - environment.diagnostics.selection.selected.version?: string; default: not declared - environment.diagnostics.stepCount: number; default: not declared - environment.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - environment.diagnostics.violationCount: number; default: not declared - environment.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - environment.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - environment.engineRunId: string; default: not declared - environment.reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - environment.result: PortfolioBacktestResult; default: not declared — The engine's own result over the episode — the same shape `portfolioBacktest` returns. - environment.result.assumptions: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestAssumptions; default: not declared - environment.result.assumptions.baseCurrency: string; default: not declared - environment.result.assumptions.calendar: string | null; default: not declared - environment.result.assumptions.conventionsVersion: string; default: not declared - environment.result.assumptions.execution: ExecutionPolicyDescription; default: not declared - environment.result.assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - environment.result.assumptions.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - environment.result.assumptions.execution.costs.borrow: string | null; default: not declared - environment.result.assumptions.execution.costs.commission: string; default: not declared - environment.result.assumptions.execution.costs.latencySessions: number | null; default: not declared - environment.result.assumptions.execution.costs.marketImpact: string | null; default: not declared - environment.result.assumptions.execution.costs.participation: number | null; default: not declared - environment.result.assumptions.execution.costs.slippage: string; default: not declared - environment.result.assumptions.execution.costs.spread: string | null; default: not declared - environment.result.assumptions.execution.fill: { label: string; version: string; }; default: not declared - environment.result.assumptions.execution.fill.label: string; default: not declared - environment.result.assumptions.execution.fill.version: string; default: not declared - environment.result.assumptions.execution.label: string; default: not declared - environment.result.assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - environment.result.assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - environment.result.assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - environment.result.assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - environment.result.assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - environment.result.assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - environment.result.assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - environment.result.assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - environment.result.assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - environment.result.assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - environment.result.assumptions.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - environment.result.assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - environment.result.assumptions.execution.sessions.halts: number; default: not declared - environment.result.assumptions.execution.sessions.priceLimits: number; default: not declared - environment.result.assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - environment.result.assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - environment.result.assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - environment.result.assumptions.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - environment.result.assumptions.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - environment.result.assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - environment.result.assumptions.instruments: { instrumentId: string; kind: import('@insiderfinance/totalfinance/backtest/portfolio').InstrumentKind; adapter: { kind: string; version: string; }; currency: string; }[]; default: not declared - environment.result.assumptions.ledger: { accountId: string; sourceId: string; }; default: not declared - environment.result.assumptions.ledger.accountId: string; default: not declared - environment.result.assumptions.ledger.sourceId: string; default: not declared - environment.result.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - environment.result.assumptions.markConvention: string; default: not declared - environment.result.assumptions.periodsPerYear: number; default: not declared - environment.result.assumptions.replayable: boolean; default: not declared - environment.result.assumptions.seed: number | null; default: not declared - environment.result.assumptions.sessionConvention: string; default: not declared - environment.result.assumptions.settlement: Record; default: not declared - environment.result.assumptions.strategy: { frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; kind: 'model'; modelId: string | null; scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; targets: number; } | { kind: 'callback'; replayable: false; } | { kind: 'external'; replayable: false; }; default: not declared - environment.result.assumptions.strategy.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - environment.result.assumptions.strategy.kind: ('callback') | ('external') | ('model'); default: not declared - environment.result.assumptions.strategy.modelId: string | null; default: not declared - environment.result.assumptions.strategy.replayable: false; default: not declared - environment.result.assumptions.strategy.scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; default: not declared - environment.result.assumptions.strategy.targets: number; default: not declared - environment.result.assumptions.window: { fromTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs | null; toTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs | null; }; default: not declared - environment.result.assumptions.window.fromTimestampMs: number | null; default: not declared - environment.result.assumptions.window.toTimestampMs: number | null; default: not declared - environment.result.diagnostics: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestDiagnostics; default: not declared - environment.result.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - environment.result.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - environment.result.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - environment.result.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - environment.result.diagnostics.externalFlowCount: number; default: not declared - environment.result.diagnostics.fillCount: number; default: not declared - environment.result.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - environment.result.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - environment.result.diagnostics.lifecycleEventCount: number; default: not declared - environment.result.diagnostics.liquidationCount: number; default: not declared - environment.result.diagnostics.markCount: number; default: not declared - environment.result.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - environment.result.diagnostics.orderCount: number; default: not declared - environment.result.diagnostics.reconciliationResidual: number; default: not declared — The ledger NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - environment.result.diagnostics.rejectionCount: number; default: not declared - environment.result.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - environment.result.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - environment.result.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - environment.result.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - environment.result.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - environment.result.diagnostics.selection.selected.name: string; default: not declared - environment.result.diagnostics.selection.selected.version?: string; default: not declared - environment.result.diagnostics.sessionCount: number; default: not declared - environment.result.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - environment.result.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - environment.result.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - environment.result.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - environment.result.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - environment.result.finalValue: number; default: not declared - environment.result.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - environment.result.ledger.baseCurrency: string; default: not declared - environment.result.ledger.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - environment.result.ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - environment.result.ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - environment.result.ledger.portfolioId?: string; default: not declared - environment.result.ledger.provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - environment.result.ledger.provenance.asOf?: number; default: not declared - environment.result.ledger.provenance.dataset?: string; default: not declared - environment.result.ledger.provenance.provider?: string; default: not declared - environment.result.ledger.provenance.receivedAt?: number; default: not declared - environment.result.ledger.provenance.requestId?: string; default: not declared - environment.result.ledger.provenance.sourceVersion?: string; default: not declared - environment.result.ledger.provenance.warnings?: QuantWarning[]; default: not declared - environment.result.ledger.schemaVersion: number; default: not declared - environment.result.liquidations: import('@insiderfinance/totalfinance/backtest/portfolio').LiquidationRow[]; default: not declared - environment.result.orders: import('@insiderfinance/totalfinance/backtest/portfolio').OrderRecord[]; default: not declared - environment.result.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - environment.result.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - environment.result.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - environment.result.performance.annualizedVolatility: number | null; default: not declared - environment.result.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - environment.result.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - environment.result.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - environment.result.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - environment.result.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - environment.result.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - environment.result.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - environment.result.performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - environment.result.performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - environment.result.performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - environment.result.performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - environment.result.performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - environment.result.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - environment.result.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - environment.result.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - environment.result.performance.maxDrawdown: number; default: not declared - environment.result.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - environment.result.performance.periods: number; default: not declared - environment.result.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - environment.result.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - environment.result.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - environment.result.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - environment.result.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - environment.result.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - environment.result.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - environment.result.pnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult | null; default: not declared - environment.result.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - environment.result.pnl.assumptions.conventionsVersion: string; default: not declared - environment.result.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - environment.result.pnl.assumptions.identity: string; default: not declared — The identity, stated. - environment.result.pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - environment.result.pnl.assumptions.residualTolerance: number; default: not declared - environment.result.pnl.baseCurrency: string; default: not declared - environment.result.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - environment.result.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - environment.result.pnl.components.financing: number; default: not declared - environment.result.pnl.components.foreignExchangePnl: number; default: not declared - environment.result.pnl.components.income: number; default: not declared - environment.result.pnl.components.realizedPnl: number; default: not declared - environment.result.pnl.components.totalPnl: number; default: not declared - environment.result.pnl.components.transactionCosts: number; default: not declared - environment.result.pnl.components.unrealizedPnl: number; default: not declared - environment.result.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - environment.result.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - environment.result.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - environment.result.pnl.diagnostics.warnings: string[]; default: not declared - environment.result.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - environment.result.pnl.from: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - environment.result.pnl.from.asOf: number; default: not declared - environment.result.pnl.from.netAssetValue: number; default: not declared - environment.result.pnl.from.valuationDate: string; default: not declared - environment.result.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - environment.result.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - environment.result.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - environment.result.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - environment.result.pnl.to: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - environment.result.pnl.to.asOf: number; default: not declared - environment.result.pnl.to.netAssetValue: number; default: not declared - environment.result.pnl.to.valuationDate: string; default: not declared - environment.result.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - environment.result.rejections: import('@insiderfinance/totalfinance/backtest/portfolio').RejectionRow[]; default: not declared - environment.result.returns: number[]; default: not declared - environment.result.runId: string; default: not declared - environment.result.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult | null; default: not declared - environment.result.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - environment.result.timeline.assumptions.conventionsVersion: string; default: not declared - environment.result.timeline.assumptions.exposureConvention: string; default: not declared - environment.result.timeline.assumptions.indexConvention: string; default: not declared - environment.result.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - environment.result.timeline.assumptions.markInstant: string; default: not declared - environment.result.timeline.baseCurrency: string; default: not declared - environment.result.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - environment.result.timeline.cumulativePnl.financing: number; default: not declared - environment.result.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - environment.result.timeline.cumulativePnl.income: number; default: not declared - environment.result.timeline.cumulativePnl.realizedPnl: number; default: not declared - environment.result.timeline.cumulativePnl.residual: number; default: not declared - environment.result.timeline.cumulativePnl.totalPnl: number; default: not declared - environment.result.timeline.cumulativePnl.transactionCosts: number; default: not declared - environment.result.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - environment.result.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - environment.result.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - environment.result.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - environment.result.timeline.diagnostics.markCount: number; default: not declared - environment.result.timeline.diagnostics.warnings: string[]; default: not declared - environment.result.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - environment.result.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - environment.result.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - environment.result.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - environment.result.valuationMarks: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared - environment.rewardTotal: number; default: not declared - environment.rewards: number[]; default: not declared - environment.runId: string; default: not declared - environment.seed: number | null; default: not declared - environment.steps: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentEpisodeStep[]; default: not declared - environment.terminated: boolean; default: not declared - environment.traceHash: string; default: not declared - environment.truncated: boolean; default: not declared - options: OptionsBacktestResult; default: not declared - options.assumptions: import('@insiderfinance/totalfinance/backtest/options').OptionsBacktestAssumptions; default: not declared - options.assumptions.assignment: 'none' | 'model'; default: not declared - options.assumptions.baseCurrency: string; default: not declared - options.assumptions.book: { maximumOpenPositions: number; maximumPerUnderlying: number | null; }; default: not declared — Stage 4.6: the book, the limits, the fill policy, the freshness policy, and the rules. - options.assumptions.book.maximumOpenPositions: number; default: not declared - options.assumptions.book.maximumPerUnderlying: number | null; default: not declared - options.assumptions.commission: string; default: not declared - options.assumptions.conventionsVersion: string; default: not declared - options.assumptions.corporateActions: number; default: not declared - options.assumptions.dividendYield: number; default: not declared - options.assumptions.dividends: number; default: not declared - options.assumptions.fillPolicy: { mode: 'combo' | 'legged'; partialFill: 'reject' | 'allow'; price: import('@insiderfinance/totalfinance/core').PriceSource; }; default: not declared - options.assumptions.fillPolicy.mode: 'combo' | 'legged'; default: not declared - options.assumptions.fillPolicy.partialFill: 'reject' | 'allow'; default: not declared - options.assumptions.fillPolicy.price: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared - options.assumptions.hedge: number | 'none'; default: not declared — Delta-hedge band in share-equivalents, or `'none'`. - options.assumptions.initialCapital: number; default: not declared - options.assumptions.ledger: { sourceId: string; accountId: string; lotRelief: string; }; default: not declared - options.assumptions.ledger.accountId: string; default: not declared - options.assumptions.ledger.lotRelief: string; default: not declared - options.assumptions.ledger.sourceId: string; default: not declared - options.assumptions.limits: { maximumMarginFraction: number | null; maximumNetDelta: number | null; maximumNetVega: number | null; maximumConcentration: number | null; scenarioLoss: { spotShocks: number[]; volatilityShocks: number[]; maximumLossFraction: number; } | null; }; default: not declared - options.assumptions.limits.maximumConcentration: number | null; default: not declared - options.assumptions.limits.maximumMarginFraction: number | null; default: not declared - options.assumptions.limits.maximumNetDelta: number | null; default: not declared - options.assumptions.limits.maximumNetVega: number | null; default: not declared - options.assumptions.limits.scenarioLoss: { spotShocks: number[]; volatilityShocks: number[]; maximumLossFraction: number; } | null; default: not declared - options.assumptions.limits.scenarioLoss.maximumLossFraction: number; default: not declared - options.assumptions.limits.scenarioLoss.spotShocks: number[]; default: not declared - options.assumptions.limits.scenarioLoss.volatilityShocks: number[]; default: not declared - options.assumptions.marking: import('@insiderfinance/totalfinance/backtest/options').AppliedMarkingPolicy; default: not declared — The applied marking and missing-mark policies (Preview P1). - options.assumptions.marking.maximumQuoteAgeMs: number | null; default: not declared - options.assumptions.marking.missingMark: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared - options.assumptions.marking.volatility: 'current-quote' | 'entry'; default: not declared - options.assumptions.periodsPerYear: number; default: not declared - options.assumptions.priceSource: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — Fill price source for entries/exits. - options.assumptions.quoteFreshness: { maximumQuoteAgeMs: number | null; }; default: not declared - options.assumptions.quoteFreshness.maximumQuoteAgeMs: number | null; default: not declared - options.assumptions.replayable: boolean; default: not declared — `false` exactly when a caller function (a `build`, a `when`) participated. - options.assumptions.riskFreeRate: number; default: not declared - options.assumptions.rules: { id: string; structure: string; }[]; default: not declared - options.assumptions.sizing: 'fixed-quantity' | 'margin-aware'; default: not declared — How positions were sized. - options.assumptions.slippage: string; default: not declared - options.diagnostics: import('@insiderfinance/totalfinance/backtest/options').OptionsBacktestDiagnostics; default: not declared - options.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - options.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - options.diagnostics.corporateActionsApplied: number; default: not declared - options.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - options.diagnostics.earlyAssignmentCount: number; default: not declared - options.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - options.diagnostics.fillRejectionCount: number; default: not declared - options.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - options.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - options.diagnostics.limitRejectionCount: number; default: not declared - options.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - options.diagnostics.openAtEnd: number; default: not declared - options.diagnostics.reconciliationResidual: number; default: not declared — The ledger's NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - options.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - options.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - options.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - options.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - options.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - options.diagnostics.selection.selected.name: string; default: not declared - options.diagnostics.selection.selected.version?: string; default: not declared - options.diagnostics.snapshotCount: number; default: not declared - options.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - options.diagnostics.tradeCount: number; default: not declared - options.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - options.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - options.fillRejections: import('@insiderfinance/totalfinance/backtest/options').FillRejection[]; default: not declared - options.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared — Every fill the book placed — the same `NormalizedFill`s the ledger folded (Decision 2). - options.finalValue: number; default: not declared - options.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - options.ledger.baseCurrency: string; default: not declared - options.ledger.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - options.ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - options.ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - options.ledger.portfolioId?: string; default: not declared - options.ledger.provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - options.ledger.provenance.asOf?: number; default: not declared - options.ledger.provenance.dataset?: string; default: not declared - options.ledger.provenance.provider?: string; default: not declared - options.ledger.provenance.receivedAt?: number; default: not declared - options.ledger.provenance.requestId?: string; default: not declared - options.ledger.provenance.sourceVersion?: string; default: not declared - options.ledger.provenance.warnings?: QuantWarning[]; default: not declared - options.ledger.schemaVersion: number; default: not declared - options.limitRejections: import('@insiderfinance/totalfinance/backtest/options').LimitRejection[]; default: not declared — Stage 4.6: the book's rows and the ledger. - options.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - options.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - options.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - options.performance.annualizedVolatility: number | null; default: not declared - options.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - options.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - options.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - options.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - options.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - options.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - options.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - options.performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - options.performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - options.performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - options.performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - options.performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - options.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - options.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - options.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - options.performance.maxDrawdown: number; default: not declared - options.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - options.performance.periods: number; default: not declared - options.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - options.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - options.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - options.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - options.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - options.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - options.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - options.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - options.returns: number[]; default: not declared - options.runId: string; default: not declared — Content-addressed identity of the request (callbacks recorded as such). - options.settlements: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared - options.surface: import('@insiderfinance/totalfinance/backtest/options').SurfaceRow[]; default: not declared - options.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared - options.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - options.timeline.assumptions.conventionsVersion: string; default: not declared - options.timeline.assumptions.exposureConvention: string; default: not declared - options.timeline.assumptions.indexConvention: string; default: not declared - options.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - options.timeline.assumptions.markInstant: string; default: not declared - options.timeline.baseCurrency: string; default: not declared - options.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - options.timeline.cumulativePnl.financing: number; default: not declared - options.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - options.timeline.cumulativePnl.income: number; default: not declared - options.timeline.cumulativePnl.realizedPnl: number; default: not declared - options.timeline.cumulativePnl.residual: number; default: not declared - options.timeline.cumulativePnl.totalPnl: number; default: not declared - options.timeline.cumulativePnl.transactionCosts: number; default: not declared - options.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - options.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - options.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - options.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - options.timeline.diagnostics.markCount: number; default: not declared - options.timeline.diagnostics.warnings: string[]; default: not declared - options.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - options.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - options.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - options.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - options.trades: import('@insiderfinance/totalfinance/backtest/options').OptionsTrade[]; default: not declared - portfolio: PortfolioBacktestResult; default: not declared - portfolio.assumptions: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestAssumptions; default: not declared - portfolio.assumptions.baseCurrency: string; default: not declared - portfolio.assumptions.calendar: string | null; default: not declared - portfolio.assumptions.conventionsVersion: string; default: not declared - portfolio.assumptions.execution: ExecutionPolicyDescription; default: not declared - portfolio.assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - portfolio.assumptions.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - portfolio.assumptions.execution.costs.borrow: string | null; default: not declared - portfolio.assumptions.execution.costs.commission: string; default: not declared - portfolio.assumptions.execution.costs.latencySessions: number | null; default: not declared - portfolio.assumptions.execution.costs.marketImpact: string | null; default: not declared - portfolio.assumptions.execution.costs.participation: number | null; default: not declared - portfolio.assumptions.execution.costs.slippage: string; default: not declared - portfolio.assumptions.execution.costs.spread: string | null; default: not declared - portfolio.assumptions.execution.fill: { label: string; version: string; }; default: not declared - portfolio.assumptions.execution.fill.label: string; default: not declared - portfolio.assumptions.execution.fill.version: string; default: not declared - portfolio.assumptions.execution.label: string; default: not declared - portfolio.assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - portfolio.assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - portfolio.assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - portfolio.assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - portfolio.assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - portfolio.assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - portfolio.assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - portfolio.assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - portfolio.assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - portfolio.assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - portfolio.assumptions.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - portfolio.assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - portfolio.assumptions.execution.sessions.halts: number; default: not declared - portfolio.assumptions.execution.sessions.priceLimits: number; default: not declared - portfolio.assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - portfolio.assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - portfolio.assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - portfolio.assumptions.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - portfolio.assumptions.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - portfolio.assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - portfolio.assumptions.instruments: { instrumentId: string; kind: import('@insiderfinance/totalfinance/backtest/portfolio').InstrumentKind; adapter: { kind: string; version: string; }; currency: string; }[]; default: not declared - portfolio.assumptions.ledger: { accountId: string; sourceId: string; }; default: not declared - portfolio.assumptions.ledger.accountId: string; default: not declared - portfolio.assumptions.ledger.sourceId: string; default: not declared - portfolio.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolio.assumptions.markConvention: string; default: not declared - portfolio.assumptions.periodsPerYear: number; default: not declared - portfolio.assumptions.replayable: boolean; default: not declared - portfolio.assumptions.seed: number | null; default: not declared - portfolio.assumptions.sessionConvention: string; default: not declared - portfolio.assumptions.settlement: Record; default: not declared - portfolio.assumptions.strategy: { frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; kind: 'model'; modelId: string | null; scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; targets: number; } | { kind: 'callback'; replayable: false; } | { kind: 'external'; replayable: false; }; default: not declared - portfolio.assumptions.strategy.frequency: import('@insiderfinance/totalfinance/backtest').RebalanceFrequency; default: not declared - portfolio.assumptions.strategy.kind: ('callback') | ('external') | ('model'); default: not declared - portfolio.assumptions.strategy.modelId: string | null; default: not declared - portfolio.assumptions.strategy.replayable: false; default: not declared - portfolio.assumptions.strategy.scope: import('@insiderfinance/totalfinance/portfolio').RebalanceScope; default: not declared - portfolio.assumptions.strategy.targets: number; default: not declared - portfolio.assumptions.window: { fromTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs | null; toTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs | null; }; default: not declared - portfolio.assumptions.window.fromTimestampMs: number | null; default: not declared - portfolio.assumptions.window.toTimestampMs: number | null; default: not declared - portfolio.diagnostics: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioBacktestDiagnostics; default: not declared - portfolio.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - portfolio.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - portfolio.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - portfolio.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - portfolio.diagnostics.externalFlowCount: number; default: not declared - portfolio.diagnostics.fillCount: number; default: not declared - portfolio.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - portfolio.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - portfolio.diagnostics.lifecycleEventCount: number; default: not declared - portfolio.diagnostics.liquidationCount: number; default: not declared - portfolio.diagnostics.markCount: number; default: not declared - portfolio.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - portfolio.diagnostics.orderCount: number; default: not declared - portfolio.diagnostics.reconciliationResidual: number; default: not declared — The ledger NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - portfolio.diagnostics.rejectionCount: number; default: not declared - portfolio.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - portfolio.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - portfolio.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - portfolio.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - portfolio.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - portfolio.diagnostics.selection.selected.name: string; default: not declared - portfolio.diagnostics.selection.selected.version?: string; default: not declared - portfolio.diagnostics.sessionCount: number; default: not declared - portfolio.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - portfolio.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - portfolio.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - portfolio.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - portfolio.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - portfolio.finalValue: number; default: not declared - portfolio.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - portfolio.ledger.baseCurrency: string; default: not declared - portfolio.ledger.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - portfolio.ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - portfolio.ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - portfolio.ledger.portfolioId?: string; default: not declared - portfolio.ledger.provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - portfolio.ledger.provenance.asOf?: number; default: not declared - portfolio.ledger.provenance.dataset?: string; default: not declared - portfolio.ledger.provenance.provider?: string; default: not declared - portfolio.ledger.provenance.receivedAt?: number; default: not declared - portfolio.ledger.provenance.requestId?: string; default: not declared - portfolio.ledger.provenance.sourceVersion?: string; default: not declared - portfolio.ledger.provenance.warnings?: QuantWarning[]; default: not declared - portfolio.ledger.schemaVersion: number; default: not declared - portfolio.liquidations: import('@insiderfinance/totalfinance/backtest/portfolio').LiquidationRow[]; default: not declared - portfolio.orders: import('@insiderfinance/totalfinance/backtest/portfolio').OrderRecord[]; default: not declared - portfolio.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - portfolio.performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - portfolio.performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - portfolio.performance.annualizedVolatility: number | null; default: not declared - portfolio.performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - portfolio.performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - portfolio.performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - portfolio.performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - portfolio.performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - portfolio.performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - portfolio.performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - portfolio.performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - portfolio.performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - portfolio.performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - portfolio.performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - portfolio.performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - portfolio.performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - portfolio.performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - portfolio.performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - portfolio.performance.maxDrawdown: number; default: not declared - portfolio.performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - portfolio.performance.periods: number; default: not declared - portfolio.performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - portfolio.performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - portfolio.performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - portfolio.performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - portfolio.performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - portfolio.performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - portfolio.performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - portfolio.pnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult | null; default: not declared - portfolio.pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - portfolio.pnl.assumptions.conventionsVersion: string; default: not declared - portfolio.pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - portfolio.pnl.assumptions.identity: string; default: not declared — The identity, stated. - portfolio.pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolio.pnl.assumptions.residualTolerance: number; default: not declared - portfolio.pnl.baseCurrency: string; default: not declared - portfolio.pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - portfolio.pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - portfolio.pnl.components.financing: number; default: not declared - portfolio.pnl.components.foreignExchangePnl: number; default: not declared - portfolio.pnl.components.income: number; default: not declared - portfolio.pnl.components.realizedPnl: number; default: not declared - portfolio.pnl.components.totalPnl: number; default: not declared - portfolio.pnl.components.transactionCosts: number; default: not declared - portfolio.pnl.components.unrealizedPnl: number; default: not declared - portfolio.pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - portfolio.pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - portfolio.pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - portfolio.pnl.diagnostics.warnings: string[]; default: not declared - portfolio.pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - portfolio.pnl.from: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - portfolio.pnl.from.asOf: number; default: not declared - portfolio.pnl.from.netAssetValue: number; default: not declared - portfolio.pnl.from.valuationDate: string; default: not declared - portfolio.pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - portfolio.pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - portfolio.pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - portfolio.pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - portfolio.pnl.to: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - portfolio.pnl.to.asOf: number; default: not declared - portfolio.pnl.to.netAssetValue: number; default: not declared - portfolio.pnl.to.valuationDate: string; default: not declared - portfolio.points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - portfolio.rejections: import('@insiderfinance/totalfinance/backtest/portfolio').RejectionRow[]; default: not declared - portfolio.returns: number[]; default: not declared - portfolio.runId: string; default: not declared - portfolio.timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult | null; default: not declared - portfolio.timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - portfolio.timeline.assumptions.conventionsVersion: string; default: not declared - portfolio.timeline.assumptions.exposureConvention: string; default: not declared - portfolio.timeline.assumptions.indexConvention: string; default: not declared - portfolio.timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolio.timeline.assumptions.markInstant: string; default: not declared - portfolio.timeline.baseCurrency: string; default: not declared - portfolio.timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - portfolio.timeline.cumulativePnl.financing: number; default: not declared - portfolio.timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - portfolio.timeline.cumulativePnl.income: number; default: not declared - portfolio.timeline.cumulativePnl.realizedPnl: number; default: not declared - portfolio.timeline.cumulativePnl.residual: number; default: not declared - portfolio.timeline.cumulativePnl.totalPnl: number; default: not declared - portfolio.timeline.cumulativePnl.transactionCosts: number; default: not declared - portfolio.timeline.cumulativePnl.unrealizedPnl: number; default: not declared - portfolio.timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - portfolio.timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - portfolio.timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - portfolio.timeline.diagnostics.markCount: number; default: not declared - portfolio.timeline.diagnostics.warnings: string[]; default: not declared - portfolio.timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - portfolio.timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - portfolio.timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - portfolio.timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - portfolio.valuationMarks: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#IdListSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface IdListSection { count: number; ids: string[]; remainderCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - ids: string[]; default: not declared - remainderCount: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#InputOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type InputOf = BacktestRunInputs[K]; ``` ### @insiderfinance/totalfinance/backtest/artifacts#MembershipSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MembershipSection { entered: IdListSection; exited: IdListSection; kept: IdListSection; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entered: IdListSection; default: not declared - entered.count: number; default: not declared - entered.ids: string[]; default: not declared - entered.remainderCount: number; default: not declared - exited: IdListSection; default: not declared - exited.count: number; default: not declared - exited.ids: string[]; default: not declared - exited.remainderCount: number; default: not declared - kept: IdListSection; default: not declared - kept.count: number; default: not declared - kept.ids: string[]; default: not declared - kept.remainderCount: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#NamedDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface NamedDelta { name: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; /** Under an explicit tolerance: whether the delta is within it; `null` without one. */ withinTolerance: boolean | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared - baselineValue: number | null; default: not declared - candidateValue: number | null; default: not declared - name: string; default: not declared - withinTolerance: boolean | null; default: not declared — Under an explicit tolerance: whether the delta is within it; `null` without one. ### @insiderfinance/totalfinance/backtest/artifacts#ReadBacktestRunResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReadBacktestRunResult { report: BacktestRunReport; artifact: AnalysisArtifact; migrationsApplied: AppliedMigration[]; modelMigrationsApplied: AppliedMigration[]; /** Labels whose referenced rows were supplied, verified by hash, and restored into `report`. */ restoredRowSets: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifact: AnalysisArtifact; default: not declared - artifact.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - artifact.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - artifact.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - artifact.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - artifact.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - artifact.inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - artifact.inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - artifact.inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - artifact.kind: 'totalfinance.analysis-artifact'; default: not declared - artifact.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - artifact.producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - artifact.producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - artifact.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - artifact.provenance.asOf?: number; default: not declared - artifact.provenance.dataset?: string; default: not declared - artifact.provenance.provider?: string; default: not declared - artifact.provenance.receivedAt?: number; default: not declared - artifact.provenance.requestId?: string; default: not declared - artifact.provenance.sourceVersion?: string; default: not declared - artifact.provenance.warnings?: QuantWarning[]; default: not declared - artifact.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - artifact.schemaVersion: number; default: not declared - artifact.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - migrationsApplied: AppliedMigration[]; default: not declared - modelMigrationsApplied: AppliedMigration[]; default: not declared - report: BacktestRunReport; default: not declared - report.assumptions: { conventionsVersion: string; embeddedRowLimit: number; inputPolicy: 'embedded' | 'referenced'; kind: Kind; modelPolicy: string; nonReplayableField: string | null; operation: string; projection: string; replayable: boolean; runVersion: number; }; default: not declared - report.assumptions.conventionsVersion: string; default: not declared - report.assumptions.embeddedRowLimit: number; default: not declared - report.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - report.assumptions.kind: Kind; default: not declared - report.assumptions.modelPolicy: string; default: not declared - report.assumptions.nonReplayableField: string | null; default: not declared - report.assumptions.operation: string; default: not declared - report.assumptions.projection: string; default: not declared - report.assumptions.replayable: boolean; default: not declared — `false` exactly when a caller function participated. - report.assumptions.runVersion: number; default: not declared - report.diagnostics: { embeddedRows: number; referencedRows: number; runWarningCount: number; warnings: QuantWarning[]; }; default: not declared - report.diagnostics.embeddedRows: number; default: not declared - report.diagnostics.referencedRows: number; default: not declared - report.diagnostics.runWarningCount: number; default: not declared - report.diagnostics.warnings: QuantWarning[]; default: not declared - report.execution: { completed: true; }; default: not declared — Reserved (Decision 8): a cooperative checkpoint/resume lands in Stage 7B without changing the format. - report.execution.completed: true; default: not declared - report.hygiene: BacktestHygieneBlock | null; default: not declared — The caller's hygiene block (single runs) or the grid's own verdicts (grids), verbatim. - report.hygiene.backtestOverfitting?: Record; default: not declared - report.hygiene.deflatedSharpe?: Record; default: not declared - report.hygiene.researchProtocol?: Record; default: not declared - report.identity: BacktestRunIdentity; default: not declared - report.identity.annualization: { periodsPerYear: number; riskFreeRate: number; }; default: not declared - report.identity.annualization.periodsPerYear: number; default: not declared - report.identity.annualization.riskFreeRate: number; default: not declared - report.identity.baseCurrency: string; default: not declared - report.identity.benchmark: boolean; default: not declared - report.identity.calendar: { firstMarkTimestampMs: number | null; lastMarkTimestampMs: number | null; sessions: number; }; default: not declared - report.identity.calendar.firstMarkTimestampMs: number | null; default: not declared - report.identity.calendar.lastMarkTimestampMs: number | null; default: not declared - report.identity.calendar.sessions: number; default: not declared - report.identity.childRunIds: string[] | null; default: not declared — Every child run id, in variation order (grids only). - report.identity.conventions: { conventionsVersion: string; pricing: string; sessionInstantConvention: string; }; default: not declared - report.identity.conventions.conventionsVersion: string; default: not declared - report.identity.conventions.pricing: string; default: not declared - report.identity.conventions.sessionInstantConvention: string; default: not declared - report.identity.engine: { operation: string; runVersion: number; }; default: not declared - report.identity.engine.operation: string; default: not declared - report.identity.engine.runVersion: number; default: not declared - report.identity.initialCapital: number; default: not declared - report.identity.models: RecordedModels; default: not declared - report.identity.models.commission: string | null; default: not declared - report.identity.models.execution: ExecutionPolicyDescription | null; default: not declared - report.identity.models.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - report.identity.models.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - report.identity.models.execution.costs.borrow: string | null; default: not declared - report.identity.models.execution.costs.commission: string; default: not declared - report.identity.models.execution.costs.latencySessions: number | null; default: not declared - report.identity.models.execution.costs.marketImpact: string | null; default: not declared - report.identity.models.execution.costs.participation: number | null; default: not declared - report.identity.models.execution.costs.slippage: string; default: not declared - report.identity.models.execution.costs.spread: string | null; default: not declared - report.identity.models.execution.fill: { label: string; version: string; }; default: not declared - report.identity.models.execution.fill.label: string; default: not declared - report.identity.models.execution.fill.version: string; default: not declared - report.identity.models.execution.label: string; default: not declared - report.identity.models.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - report.identity.models.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - report.identity.models.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - report.identity.models.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - report.identity.models.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - report.identity.models.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - report.identity.models.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - report.identity.models.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - report.identity.models.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - report.identity.models.execution.realism: 'simplified' | 'declared'; default: not declared - report.identity.models.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - report.identity.models.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - report.identity.models.execution.sessions.halts: number; default: not declared - report.identity.models.execution.sessions.priceLimits: number; default: not declared - report.identity.models.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - report.identity.models.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - report.identity.models.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - report.identity.models.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - report.identity.models.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - report.identity.models.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - report.identity.models.slippage: string | null; default: not declared - report.identity.pointInTimePolicy: string; default: not declared - report.identity.recipe: { recipeName: string; recipeVersion: number; } | null; default: not declared - report.identity.recipe.recipeName: string; default: not declared - report.identity.recipe.recipeVersion: number; default: not declared - report.identity.runId: string; default: not declared — The engine's content-addressed run id (the sweep id for a grid). - report.identity.seed: number | null; default: not declared - report.identity.strategy: Record; default: not declared — The signal as the engine disclosed it (`assumptions.signal`). - report.identity.universeHistoryHash: string; default: not declared — Content hash of the universe history's member rows. - report.identity.universeId: string; default: not declared - report.identity.variations: { path: string; values: unknown[]; }[] | null; default: not declared — The grid's axes (grids only). - report.inputs: Record; default: not declared — The request with bulk row sets embedded or referenced, callbacks omitted, models by description. - report.kind: Kind; default: not declared - report.referencedData: Record; default: not declared — Table references for every row set that was not embedded, keyed by label (`dataset.returns`, `run.holdings`). - report.run: Record; default: not declared — The verb's result verbatim, with referenced result row sets replaced by their table handles. - report.runHash: string; default: not declared — `contentHash` of the stored run (the projection above) — the run's identity. - report.runVersion: number; default: not declared - restoredRowSets: string[]; default: not declared — Labels whose referenced rows were supplied, verified by hash, and restored into `report`. ### @insiderfinance/totalfinance/backtest/artifacts#RebalanceDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceDelta { rebalanceIndex: number; sessionDate: { baseline: string; candidate: string; }; turnover: { baseline: number; candidate: number; absoluteDelta: number; }; costs: { baseline: number; candidate: number; absoluteDelta: number; }; longCount: { baseline: number; candidate: number; }; shortCount: { baseline: number; candidate: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - costs: { baseline: number; candidate: number; absoluteDelta: number; }; default: not declared - costs.absoluteDelta: number; default: not declared - costs.baseline: number; default: not declared - costs.candidate: number; default: not declared - longCount: { baseline: number; candidate: number; }; default: not declared - longCount.baseline: number; default: not declared - longCount.candidate: number; default: not declared - rebalanceIndex: number; default: not declared - sessionDate: { baseline: string; candidate: string; }; default: not declared - sessionDate.baseline: string; default: not declared - sessionDate.candidate: string; default: not declared - shortCount: { baseline: number; candidate: number; }; default: not declared - shortCount.baseline: number; default: not declared - shortCount.candidate: number; default: not declared - turnover: { baseline: number; candidate: number; absoluteDelta: number; }; default: not declared - turnover.absoluteDelta: number; default: not declared - turnover.baseline: number; default: not declared - turnover.candidate: number; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#RecordedModels Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The recorded models of a run: descriptions and labels, never functions. ```typescript /** The recorded models of a run: descriptions and labels, never functions. */ export interface RecordedModels { execution: ExecutionPolicyDescription | null; commission: string | null; slippage: string | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: string | null; default: not declared - execution: ExecutionPolicyDescription | null; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - execution.costs.borrow: string | null; default: not declared - execution.costs.commission: string; default: not declared - execution.costs.latencySessions: number | null; default: not declared - execution.costs.marketImpact: string | null; default: not declared - execution.costs.participation: number | null; default: not declared - execution.costs.slippage: string; default: not declared - execution.costs.spread: string | null; default: not declared - execution.fill: { label: string; version: string; }; default: not declared - execution.fill.label: string; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared - execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - execution.sessions.halts: number; default: not declared - execution.sessions.priceLimits: number; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - slippage: string | null; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#ReplayModels Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The models a replay takes back, each verified against the recorded description before the run. ```typescript /** The models a replay takes back, each verified against the recorded description before the run. */ export interface ReplayModels { execution?: ExecutionPolicy; transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; /** The options kind's labeled models, keyed by their request path (`commission`, `slippage`, `hedge.commission`, `hedge.slippage`). */ labeled?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - execution?: ExecutionPolicy; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - execution.costs.borrow.label: string; default: not declared - execution.costs.commission: CostModel; default: not declared - execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - execution.costs.commission.commission(input).price: number; default: not declared - execution.costs.commission.commission(input).quantity: number; default: not declared - execution.costs.commission.label: string; default: not declared - execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - execution.costs.latency.label: string; default: not declared - execution.costs.latency.sessions: number; default: not declared - execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - execution.costs.marketImpact.impact(input).quantity: number; default: not declared - execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - execution.costs.marketImpact.label: string; default: not declared - execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - execution.costs.slippage: SlippageModel; default: not declared - execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - execution.costs.slippage.fill(input).quantity: number; default: not declared - execution.costs.slippage.fill(input).referencePrice: number; default: not declared - execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.slippage.label: string; default: not declared - execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.spread.label: string; default: not declared - execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - execution.fill.fill().return.detail?: string; default: not declared - execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - execution.fill.fill().return.pricePerUnit: number; default: not declared - execution.fill.fill().return.quantity: number; default: not declared - execution.fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - execution.fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - execution.fill.label: string; default: not declared - execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared — Echoed in every result's assumptions. - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - labeled?: Record; default: not declared — The options kind's labeled models, keyed by their request path (`commission`, `slippage`, `hedge.commission`, `hedge.slippage`). - transactionCostModel?: { commission?: CostModel; slippage?: SlippageModel; }; default: not declared - transactionCostModel.commission?: CostModel; default: not declared - transactionCostModel.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - transactionCostModel.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - transactionCostModel.commission.commission(input).price: number; default: not declared - transactionCostModel.commission.commission(input).quantity: number; default: not declared - transactionCostModel.commission.label: string; default: not declared - transactionCostModel.slippage?: SlippageModel; default: not declared - transactionCostModel.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - transactionCostModel.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - transactionCostModel.slippage.fill(input).quantity: number; default: not declared - transactionCostModel.slippage.fill(input).referencePrice: number; default: not declared - transactionCostModel.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - transactionCostModel.slippage.label: string; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#RunOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RunOf = BacktestRunResults[K]; ``` ### @insiderfinance/totalfinance/backtest/artifacts#VariationDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VariationDelta { parameters: Record; metric: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared - baselineValue: number | null; default: not declared - candidateValue: number | null; default: not declared - metric: string; default: not declared - parameters: Record; default: not declared ### @insiderfinance/totalfinance/backtest/artifacts#backtestRunArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Describe a run and save it as an identified, immutable artifact. ```typescript export declare function backtestRunArtifact(input: BacktestRunArtifactInput): AnalysisArtifact; ``` Example (source JSDoc): ```ts const run = crossSectionalBacktest(request); const artifact = backtestRunArtifact({ kind: 'cross-sectional', run, input: request, referenceRowSets: ['dataset.returns', 'run.ledger.events'], }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BacktestRunArtifactInput; default: not declared - (input).createdFrom?: string[]; default: not declared - (input).hygiene?: BacktestHygieneBlock; default: not declared — Verbatim `@insiderfinance/totalfinance/risk` verdicts for a single run; a grid carries its own and refuses this. - (input).input: InputOf; default: not declared — The request as it was called — rows included; callbacks recorded and not stored; models recorded by description. - (input).kind: Kind; default: not declared - (input).libraryVersion?: string; default: not declared - (input).limits?: BacktestRunArtifactLimits; default: not declared - (input).locators?: Record; default: not declared — Storage locators to stamp on the minted handles, keyed by row-set label. - (input).provenance?: Provenance; default: not declared - (input).referenceRowSets?: readonly string[]; default: not declared — Row-set labels (`dataset.returns`, `run.holdings`, `run.ledger.events`) to store by `TableHandle` instead of embedding. - (input).run: RunOf; default: not declared — The verb's result, verbatim. - (input).snapshotHash?: string; default: not declared - return.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - return.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - return.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - return.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - return.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - return.kind: 'totalfinance.analysis-artifact'; default: not declared - return.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - return.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - return.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - return.schemaVersion: number; default: not declared - return.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ### @insiderfinance/totalfinance/backtest/artifacts#compareBacktestRuns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare two runs of one kind: metric deltas, holdings membership, rebalance-by-rebalance turnover and cost deltas, grid variation deltas, the hygiene verdict, and the structural diff. ```typescript export declare function compareBacktestRuns(input: { baseline: BacktestRunReport | AnalysisArtifact; candidate: BacktestRunReport | AnalysisArtifact; tolerance?: ComparisonTolerance; limits?: ComparisonLimits & { listedIds?: number; }; }): BacktestRunComparison; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { baseline: BacktestRunReport | AnalysisArtifact; candidate: BacktestRunReport | AnalysisArtifact; tolerance?: ComparisonTolerance; limits?: ComparisonLimits & { listedIds?: number; }; }; default: not declared - (input).baseline: AnalysisArtifact | BacktestRunReport; default: not declared - (input).baseline.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).baseline.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).baseline.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).baseline.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).baseline.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).baseline.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).baseline.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).baseline.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).baseline.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).baseline.schemaVersion: number; default: not declared - (input).baseline.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).candidate: AnalysisArtifact | BacktestRunReport; default: not declared - (input).candidate.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).candidate.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).candidate.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).candidate.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).candidate.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).candidate.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).candidate.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).candidate.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).candidate.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).candidate.schemaVersion: number; default: not declared - (input).candidate.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).limits?: ComparisonLimits & { listedIds?: number; }; default: not declared - (input).limits.listedIds?: number; default: not declared - (input).limits.maximumDifferences?: number; default: not declared — Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted. - (input).limits.maximumLeaves?: number; default: not declared — Canonical work units each side may cost before the comparison refuses (default and maximum 2,000,000). A leaf costs one unit, so this bounds the leaves walked from above. - (input).tolerance?: ComparisonTolerance; default: not declared - return.artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - return.artifactIds.baseline: string | null; default: not declared - return.artifactIds.candidate: string | null; default: not declared - return.assumptions: { conventionsVersion: string; kind: Kind; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.kind: Kind; default: not declared - return.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; default: not declared - return.assumptions.limits.listedIds: number; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.assumptions.tolerance: ComparisonTolerance | null; default: not declared - return.assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - return.assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.holdings: MembershipSection | null; default: not declared — Final-holding membership (names held at the last rebalance) — single runs only. - return.holdings.entered: IdListSection; default: not declared - return.holdings.exited: IdListSection; default: not declared - return.holdings.kept: IdListSection; default: not declared - return.hygiene: { baseline: string | null; candidate: string | null; changed: boolean; } | null; default: not declared - return.hygiene.baseline: string | null; default: not declared - return.hygiene.candidate: string | null; default: not declared - return.hygiene.changed: boolean; default: not declared - return.identical: boolean; default: not declared - return.kind: Kind; default: not declared - return.metrics: NamedDelta[]; default: not declared — The performance block and the run-level totals, name by name. - return.rebalances: { compared: number; rows: RebalanceDelta[]; remainderCount: number; } | null; default: not declared — Rebalance-by-rebalance turnover and cost deltas over the shared index range, listed up to `listedIds`. - return.rebalances.compared: number; default: not declared - return.rebalances.remainderCount: number; default: not declared - return.rebalances.rows: RebalanceDelta[]; default: not declared - return.run: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; default: not declared — The structural diff of the two stored runs through the parity walk. - return.run.addedPaths: string[]; default: not declared - return.run.differenceCount: number; default: not declared - return.run.removedPaths: string[]; default: not declared - return.run.retainedDifferences: number; default: not declared - return.run.truncated: boolean; default: not declared - return.runHashes: { baseline: string; candidate: string; }; default: not declared - return.runHashes.baseline: string; default: not declared - return.runHashes.candidate: string; default: not declared - return.sameConventions: boolean; default: not declared - return.sameInputs: boolean; default: not declared - return.sameModels: boolean; default: not declared - return.sameStrategy: boolean; default: not declared - return.sameUniverse: boolean; default: not declared - return.variations: { matched: number; baselineOnly: number; candidateOnly: number; rows: VariationDelta[]; remainderCount: number; best: { baseline: number | null; candidate: number | null; moved: boolean; }; } | null; default: not declared — Per-variation deltas of the grid's selection metric, matched by parameters — grids only. - return.variations.baselineOnly: number; default: not declared - return.variations.best: { baseline: number | null; candidate: number | null; moved: boolean; }; default: not declared - return.variations.best.baseline: number | null; default: not declared - return.variations.best.candidate: number | null; default: not declared - return.variations.best.moved: boolean; default: not declared - return.variations.candidateOnly: number; default: not declared - return.variations.matched: number; default: not declared - return.variations.remainderCount: number; default: not declared - return.variations.rows: VariationDelta[]; default: not declared - return.withinTolerance: boolean | null; default: not declared — Under an explicit tolerance: every metric within it; `null` without one. ### @insiderfinance/totalfinance/backtest/artifacts#readBacktestRun Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore a run artifact: Gate B's read door, a foreign-type refusal, the run-level migration policy, the report re-validated (its run hash recomputed), and any supplied referenced rows verified by hash and restored into the report. ```typescript export declare function readBacktestRun(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; }): ReadBacktestRunResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).referencedData?: Record; default: not declared — Rows for referenced row sets, keyed by label; each is verified against its handle before it is restored. - return.artifact: AnalysisArtifact; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared - return.modelMigrationsApplied: AppliedMigration[]; default: not declared - return.report: BacktestRunReport; default: not declared - return.restoredRowSets: string[]; default: not declared — Labels whose referenced rows were supplied, verified by hash, and restored into `report`. ### @insiderfinance/totalfinance/backtest/artifacts#replayBacktestRun Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-issue the run's verb from the stored request (referenced rows supplied and re-verified, models taken back and verified against their recorded descriptions) and compare the recomputed run hash with the saved one. A run that recorded a caller function refuses by name. ```typescript export declare function replayBacktestRun(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; models?: ReplayModels; libraryVersion?: string; limits?: ComparisonLimits; }): BacktestRunReplay; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; models?: ReplayModels; libraryVersion?: string; limits?: ComparisonLimits; }; default: not declared - (input).artifact: unknown; default: not declared - (input).libraryVersion?: string; default: not declared - (input).limits?: ComparisonLimits; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).models?: ReplayModels; default: not declared - (input).referencedData?: Record; default: not declared - return.artifactId: string; default: not declared - return.assumptions: { conventionsVersion: string; kind: BacktestRunKind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; models: { execution: 'recorded-default' | 'supplied' | 'none'; transactionCostModel: 'supplied' | 'none'; }; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.kind: BacktestRunKind; default: not declared - return.assumptions.libraryVersion: { saved: string | null; current: string | null; }; default: not declared - return.assumptions.libraryVersion.current: string | null; default: not declared - return.assumptions.libraryVersion.saved: string | null; default: not declared - return.assumptions.models: { execution: 'recorded-default' | 'supplied' | 'none'; transactionCostModel: 'supplied' | 'none'; }; default: not declared - return.assumptions.models.execution: 'none' | 'supplied' | 'recorded-default'; default: not declared - return.assumptions.models.transactionCostModel: 'none' | 'supplied'; default: not declared - return.assumptions.operation: string; default: not declared - return.assumptions.referencedRowSets: string[]; default: not declared - return.assumptions.runVersion: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.kind: BacktestRunKind; default: not declared - return.matches: boolean; default: not declared — `true` exactly when the recomputed run hash equals the saved one. - return.parity: ArtifactReplayParity; default: not declared - return.recomputed: BacktestRunReport; default: not declared — The recomputed report (the same projection as the saved one). - return.runHash: { saved: string; recomputed: string; }; default: not declared - return.runHash.recomputed: string; default: not declared - return.runHash.saved: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/backtest/costs ### @insiderfinance/totalfinance/backtest/costs#BorrowModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#BorrowModel`. ### @insiderfinance/totalfinance/backtest/costs#CommissionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A commission model: the cash cost of a fill of `quantity` shares at `price`. ```typescript /** A commission model: the cash cost of a fill of `quantity` shares at `price`. */ export interface CommissionInput { quantity: number; price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared - quantity: number; default: not declared ### @insiderfinance/totalfinance/backtest/costs#CostModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CostModel`. ### @insiderfinance/totalfinance/backtest/costs#SlippageFillInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A slippage model: the effective fill price, worsened against the trader from a reference price. `quantity` is the INTENDED order size (both engines pass the real size, estimated at the reference price for notional orders). A notional order is re-quantized once at the slipped price — a single iteration — so a size-dependent impact model is evaluated at the intended size, not at qty = 1. ```typescript /** * A slippage model: the effective fill price, worsened against the trader from a reference price. * `quantity` is the INTENDED order size (both engines pass the real size, estimated at the reference * price for notional orders). A notional order is re-quantized once at the slipped price — a single * iteration — so a size-dependent impact model is evaluated at the intended size, not at qty = 1. */ export interface SlippageFillInput { referencePrice: number; side: OrderSide; quantity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - quantity: number; default: not declared - referencePrice: number; default: not declared - side: OrderSide; default: not declared ### @insiderfinance/totalfinance/backtest/costs#SlippageModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#SlippageModel`. ### @insiderfinance/totalfinance/backtest/costs#borrow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#borrow`. ### @insiderfinance/totalfinance/backtest/costs#fees Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#fees`. ### @insiderfinance/totalfinance/backtest/costs#slippage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#slippage`. ## Entrypoint @insiderfinance/totalfinance/backtest/cross-sectional ### @insiderfinance/totalfinance/backtest/cross-sectional#AttributionRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#AttributionRow`. ### @insiderfinance/totalfinance/backtest/cross-sectional#BenchmarkComparison Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#BenchmarkComparison`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_GRID_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: the hard ceiling on variations one synchronous sweep may run. ```typescript export declare const CROSS_SECTIONAL_GRID_CEILING: 4096; ``` ### @insiderfinance/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_GRID_DEFAULT_MAXIMUM Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: variations one synchronous sweep runs unless the caller raises the ceiling. ```typescript export declare const CROSS_SECTIONAL_GRID_DEFAULT_MAXIMUM: 256; ``` ### @insiderfinance/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_POSITION_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: open positions one construction may hold. ```typescript export declare const CROSS_SECTIONAL_POSITION_CEILING: 50000; ``` ### @insiderfinance/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_ROW_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: rows one run may read; larger inputs travel by handle to the job runner. ```typescript export declare const CROSS_SECTIONAL_ROW_CEILING: 5000000; ``` ### @insiderfinance/totalfinance/backtest/cross-sectional#CROSS_SECTIONAL_WINDOW_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ceiling on windows one call may run — each window is a grid run plus a held-out run. ```typescript export declare const CROSS_SECTIONAL_WINDOW_CEILING: 1000; ``` ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalAssumptions`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalAttribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalAttribution`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalBacktestGridRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalBacktestGridRequest`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalBacktestGridResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalBacktestGridResult`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalBacktestRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalBacktestRequest`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalBacktestResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalBacktestResult`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalDataset Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalDataset`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalDiagnostics`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalOutOfSampleResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalOutOfSampleResult`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalPurgedFoldsRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalPurgedFoldsRequest`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalSignal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalSignal`. ### @insiderfinance/totalfinance/backtest/cross-sectional#CrossSectionalWalkForwardRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#CrossSectionalWalkForwardRequest`. ### @insiderfinance/totalfinance/backtest/cross-sectional#GridAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GridAssumptions { conventionsVersion: string; variationCount: number; maximumVariations: number; selectionMetric: GridSelectionMetric; periodsPerYear: number; riskFreeRate: number; paths: string[]; hygiene: { /** The CSCV blocks actually used, or `null` when the overfitting probability was not computed. */ splits: number | null; confidence: number; /** The trial Sharpe recorded for a degenerate return series. */ degenerateTrialSharpe: 0; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - hygiene: { confidence: number; degenerateTrialSharpe: 0; splits: number | null; }; default: not declared - hygiene.confidence: number; default: not declared - hygiene.degenerateTrialSharpe: 0; default: not declared — The trial Sharpe recorded for a degenerate return series. - hygiene.splits: number | null; default: not declared — The CSCV blocks actually used, or `null` when the overfitting probability was not computed. - maximumVariations: number; default: not declared - paths: string[]; default: not declared - periodsPerYear: number; default: not declared - riskFreeRate: number; default: not declared - selectionMetric: GridSelectionMetric; default: not declared - variationCount: number; default: not declared ### @insiderfinance/totalfinance/backtest/cross-sectional#GridDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GridDiagnostics extends Diagnostics { variationCount: number; degenerateTrialCount: number; /** The hygiene blocks that were not computed, each with its reason. */ skippedHygiene: Array<{ block: 'researchProtocol' | 'backtestOverfitting' | 'deflatedSharpe'; reason: string; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - degenerateTrialCount: number; default: not declared - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - skippedHygiene: { block: 'researchProtocol' | 'backtestOverfitting' | 'deflatedSharpe'; reason: string; }[]; default: not declared — The hygiene blocks that were not computed, each with its reason. - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - variationCount: number; default: not declared - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/backtest/cross-sectional#GridHygiene Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GridHygiene { /** The trial Sharpes in variation order — the pool `researchProtocol` deflates against. */ trialSharpes: number[]; /** `researchProtocol` over the best trial's returns with the pool; `null` when the best trial is degenerate. */ researchProtocol: ResearchVerdict | null; /** `probabilityOfBacktestOverfitting` over the periods × variations return matrix; `null` when fewer than two variations or too few periods. */ backtestOverfitting: BacktestOverfittingProbabilityResult | null; /** `deflatedSharpeRatio` for the best trial against the pool; `null` when the best trial is degenerate. */ deflatedSharpe: DeflatedSharpeResult | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - backtestOverfitting: BacktestOverfittingProbabilityResult | null; default: not declared — `probabilityOfBacktestOverfitting` over the periods × variations return matrix; `null` when fewer than two variations or too few periods. - backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - backtestOverfitting.backtestOverfittingProbability: number; default: not declared — Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. - backtestOverfitting.combinations: number; default: not declared — Number of symmetric train/test splits evaluated: `C(S, S/2)`. - backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - backtestOverfitting.medianLogit: number; default: not declared — Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. - backtestOverfitting.observations: number; default: not declared — Observations (rows) used after trimming to a multiple of `S`. - backtestOverfitting.splits: number; default: not declared — Blocks `S` actually used. - backtestOverfitting.trials: number; default: not declared — Number of strategy configurations (columns) `N`. - deflatedSharpe: DeflatedSharpeResult | null; default: not declared — `deflatedSharpeRatio` for the best trial against the pool; `null` when the best trial is degenerate. - deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carry no Sharpe (a zero-variance series). - deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - deflatedSharpe.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. - deflatedSharpe.probabilisticSharpe: number | null; default: not declared — The un-deflated PSR (benchmark 0), for comparison. - deflatedSharpe.trialCount: number; default: not declared - researchProtocol: ResearchVerdict | null; default: not declared — `researchProtocol` over the best trial's returns with the pool; `null` when the best trial is degenerate. - researchProtocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - researchProtocol.assumptions.confidence: number; default: not declared - researchProtocol.assumptions.conventionsVersion: string; default: not declared - researchProtocol.assumptions.periodsPerYear: number; default: not declared - researchProtocol.deflatedSharpe: number | null; default: not declared — Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. - researchProtocol.diagnostics: Diagnostics; default: not declared - researchProtocol.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - researchProtocol.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - researchProtocol.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - researchProtocol.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - researchProtocol.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - researchProtocol.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - researchProtocol.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - researchProtocol.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - researchProtocol.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - researchProtocol.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - researchProtocol.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - researchProtocol.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - researchProtocol.diagnostics.selection.selected.name: string; default: not declared - researchProtocol.diagnostics.selection.selected.version?: string; default: not declared - researchProtocol.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - researchProtocol.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - researchProtocol.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - researchProtocol.expectedMaxSharpe: number; default: not declared — SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). - researchProtocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. - researchProtocol.inSample.annualizedSharpe: number | null; default: not declared - researchProtocol.inSample.observations: number; default: not declared - researchProtocol.inSample.sharpe: number | null; default: not declared - researchProtocol.minTrackRecordLength: number; default: not declared — Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). - researchProtocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared — Present when out-of-sample returns are given; `null` figures when either series has zero variance. - researchProtocol.outOfSample.annualizedSharpe: number | null; default: not declared - researchProtocol.outOfSample.degradation: number | null; default: not declared - researchProtocol.outOfSample.sharpe: number | null; default: not declared - researchProtocol.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. - researchProtocol.rationale: string; default: not declared — Prose an agent relays. - researchProtocol.trialCount: number; default: not declared - researchProtocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - trialSharpes: number[]; default: not declared — The trial Sharpes in variation order — the pool `researchProtocol` deflates against. ### @insiderfinance/totalfinance/backtest/cross-sectional#GridSelectionMetric Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The performance-block metric that ranks the variations. ```typescript /** The performance-block metric that ranks the variations. */ export type GridSelectionMetric = 'sharpe' | 'sortino' | 'calmar' | 'annualizedReturn' | 'totalReturn'; ``` ### @insiderfinance/totalfinance/backtest/cross-sectional#GridSummaryMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The summary metrics of one variation, read from the run's performance block and diagnostics. ```typescript /** The summary metrics of one variation, read from the run's performance block and diagnostics. */ export interface GridSummaryMetrics { periods: number; totalReturn: number | null; annualizedReturn: number | null; annualizedVolatility: number | null; sharpe: number | null; sortino: number | null; calmar: number | null; maxDrawdown: number; hitRate: number | null; finalValue: number; rebalanceCount: number; tradeCount: number; fillCount: number; /** Mean allocator turnover per rebalance (fraction of NAV). */ meanTurnover: number | null; /** Costs charged over the run, in base currency. */ totalCosts: number; cappedGoalCount: number; violatedGoalCount: number; warningCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedReturn: number | null; default: not declared - annualizedVolatility: number | null; default: not declared - calmar: number | null; default: not declared - cappedGoalCount: number; default: not declared - fillCount: number; default: not declared - finalValue: number; default: not declared - hitRate: number | null; default: not declared - maxDrawdown: number; default: not declared - meanTurnover: number | null; default: not declared — Mean allocator turnover per rebalance (fraction of NAV). - periods: number; default: not declared - rebalanceCount: number; default: not declared - sharpe: number | null; default: not declared - sortino: number | null; default: not declared - totalCosts: number; default: not declared — Costs charged over the run, in base currency. - totalReturn: number | null; default: not declared - tradeCount: number; default: not declared - violatedGoalCount: number; default: not declared - warningCount: number; default: not declared ### @insiderfinance/totalfinance/backtest/cross-sectional#GridVariation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#GridVariation`. ### @insiderfinance/totalfinance/backtest/cross-sectional#GridVariationRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#GridVariationRow`. ### @insiderfinance/totalfinance/backtest/cross-sectional#HoldingReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#HoldingReason`. ### @insiderfinance/totalfinance/backtest/cross-sectional#HoldingRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#HoldingRow`. ### @insiderfinance/totalfinance/backtest/cross-sectional#Neutrality Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#Neutrality`. ### @insiderfinance/totalfinance/backtest/cross-sectional#OutOfSampleAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OutOfSampleAssumptions`. ### @insiderfinance/totalfinance/backtest/cross-sectional#OutOfSampleDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OutOfSampleDiagnostics`. ### @insiderfinance/totalfinance/backtest/cross-sectional#OutOfSampleHygiene Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OutOfSampleHygiene`. ### @insiderfinance/totalfinance/backtest/cross-sectional#OutOfSampleWindowRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OutOfSampleWindowRow`. ### @insiderfinance/totalfinance/backtest/cross-sectional#PortfolioConstruction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#PortfolioConstruction`. ### @insiderfinance/totalfinance/backtest/cross-sectional#RebalanceFrequency Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#RebalanceFrequency`. ### @insiderfinance/totalfinance/backtest/cross-sectional#RebalanceGoal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#RebalanceGoal`. ### @insiderfinance/totalfinance/backtest/cross-sectional#RebalanceRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#RebalanceRow`. ### @insiderfinance/totalfinance/backtest/cross-sectional#RebalanceSchedule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#RebalanceSchedule`. ### @insiderfinance/totalfinance/backtest/cross-sectional#SessionSpan Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#SessionSpan`. ### @insiderfinance/totalfinance/backtest/cross-sectional#ShortSideSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#ShortSideSelection`. ### @insiderfinance/totalfinance/backtest/cross-sectional#SideSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#SideSelection`. ### @insiderfinance/totalfinance/backtest/cross-sectional#SignalContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#SignalContext`. ### @insiderfinance/totalfinance/backtest/cross-sectional#SignalRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#SignalRow`. ### @insiderfinance/totalfinance/backtest/cross-sectional#WeightContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#WeightContext`. ### @insiderfinance/totalfinance/backtest/cross-sectional#WeightingMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#WeightingMethod`. ### @insiderfinance/totalfinance/backtest/cross-sectional#crossSectionalBacktest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#crossSectionalBacktest`. ### @insiderfinance/totalfinance/backtest/cross-sectional#crossSectionalBacktestGrid Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#crossSectionalBacktestGrid`. ### @insiderfinance/totalfinance/backtest/cross-sectional#crossSectionalPurgedFolds Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#crossSectionalPurgedFolds`. ### @insiderfinance/totalfinance/backtest/cross-sectional#crossSectionalWalkForward Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#crossSectionalWalkForward`. ### @insiderfinance/totalfinance/backtest/cross-sectional#requireCrossSectionalBacktestGridRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed guard for the grid request; the base request is validated by the engine's own guard. ```typescript export declare function requireCrossSectionalBacktestGridRequest(functionName: string, label: string, value: unknown): CrossSectionalBacktestGridRequest; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.hygiene?: { confidence?: number; splits?: number; }; default: not declared - return.hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - return.hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - return.maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - return.request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - return.selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - return.variations: readonly GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. ### @insiderfinance/totalfinance/backtest/cross-sectional#requireCrossSectionalBacktestRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate the whole request; returns the declared field definitions for the engine's reuse. ```typescript export declare function requireCrossSectionalBacktestRequest(functionName: string, label: string, value: unknown): Map; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/cross-sectional#requireCrossSectionalPurgedFoldsRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The boundary guard for {@link crossSectionalPurgedFolds}. ```typescript export declare function requireCrossSectionalPurgedFoldsRequest(functionName: string, label: string, value: unknown): CrossSectionalPurgedFoldsRequest; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.embargo?: number; default: not declared — `purgedKFold`'s embargo fraction (default 0). - return.folds: number; default: not declared — Folds (≥ 2, ≤ sessions ÷ 2 so every held-out span carries two sessions). - return.hygiene?: { confidence?: number; splits?: number; }; default: not declared - return.hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - return.hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - return.maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - return.purgeGap?: number; default: not declared — `purgedKFold`'s purge gap in sessions on each side of a held-out span (default 0). - return.request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - return.selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - return.variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. ### @insiderfinance/totalfinance/backtest/cross-sectional#requireCrossSectionalWalkForwardRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The boundary guard for {@link crossSectionalWalkForward}; the grid is validated by the grid's own guard. ```typescript export declare function requireCrossSectionalWalkForwardRequest(functionName: string, label: string, value: unknown): CrossSectionalWalkForwardRequest; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.hygiene?: { confidence?: number; splits?: number; }; default: not declared - return.hygiene.confidence?: number; default: not declared — `researchProtocol`'s confidence in (0, 1); default 0.95. - return.hygiene.splits?: number; default: not declared — CSCV blocks for `probabilityOfBacktestOverfitting` (even, 4–16). Default: 16, or the largest even count the run's periods allow. - return.maximumVariations?: number; default: not declared — Variations the sweep may run (default 256, at most 4,096). - return.mode?: 'rolling' | 'anchored'; default: not declared — `'rolling'` (default): training spans slide; `'anchored'`: every training span starts at the first session. - return.request: CrossSectionalBacktestRequest; default: not declared — The base request every variation is applied to; validated once, never mutated. - return.selectionMetric?: GridSelectionMetric; default: not declared — The metric that picks the best trial (default `'sharpe'`); ties resolve to the lower index. - return.step?: number; default: not declared — Sessions the window advances by; default `testSessions` (adjacent, non-overlapping held-out spans). - return.testSessions: number; default: not declared — Sessions in each held-out span (≥ 2). - return.trainSessions: number; default: not declared — Sessions in each training span (≥ 2). - return.variations: readonly import('@insiderfinance/totalfinance/backtest').GridVariation[]; default: not declared — The axes; the cartesian product is run with the last axis varying fastest. ## Entrypoint @insiderfinance/totalfinance/backtest/environment ### @insiderfinance/totalfinance/backtest/environment#AGENT_BENCH_RUN_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The most episode × seed runs one bench call may take (Decision 11). ```typescript export declare const AGENT_BENCH_RUN_CEILING: 200; ``` ### @insiderfinance/totalfinance/backtest/environment#ActionMask Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ActionMask = Readonly>; ``` ### @insiderfinance/totalfinance/backtest/environment#ActionMaskEntry Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether a buy or a sell of the instrument is allowed at the observation, and why not (Decision 6). ```typescript /** Whether a buy or a sell of the instrument is allowed at the observation, and why not (Decision 6). */ export interface ActionMaskEntry { instrumentId: string; buy: boolean; sell: boolean; reasons: { buy: MaskReason[]; sell: MaskReason[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buy: boolean; default: not declared - instrumentId: string; default: not declared - reasons: { buy: MaskReason[]; sell: MaskReason[]; }; default: not declared - reasons.buy: MaskReason[]; default: not declared - reasons.sell: MaskReason[]; default: not declared - sell: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentBenchEpisodeReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AgentBenchEpisodeReport { id: string; seed: number; sessions: number; terminated: boolean; reason: EnvironmentStepResult['reason']; operational: AgentBenchOperational; strategy: AgentBenchStrategy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - id: string; default: not declared - operational: AgentBenchOperational; default: not declared - operational.duplicateOrders: number; default: not declared - operational.externalOrderAttempts: 0; default: not declared - operational.limitBreaches: number; default: not declared - operational.lookAhead: number; default: not declared - operational.maskViolations: number; default: not declared - operational.passes: boolean; default: not declared - operational.reconciled: boolean; default: not declared - operational.replayEquality: boolean; default: not declared - reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - seed: number; default: not declared - sessions: number; default: not declared - strategy: AgentBenchStrategy; default: not declared - strategy.annualizedVolatility: number | null; default: not declared - strategy.cost: number; default: not declared - strategy.finalValue: number; default: not declared - strategy.maxDrawdown: number; default: not declared - strategy.meanGrossExposure: number; default: not declared - strategy.rewardTotal: number; default: not declared - strategy.sharpe: number | null; default: not declared - strategy.sortino: number | null; default: not declared - strategy.steps: number; default: not declared - strategy.totalReturn: number | null; default: not declared - strategy.turnover: number; default: not declared - strategy.violations: number; default: not declared - terminated: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentBenchInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AgentBenchInput { policy: { label: string; requires: FeatureRecipes | null; decide: TradingPolicy; }; /** Default: the whole catalogue. */ episodes?: readonly AgentBenchEpisode[]; /** Default: [42]. */ seeds?: readonly number[]; limits?: { maximumRuns?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - episodes?: readonly AgentBenchEpisode[]; default: not declared — Default: the whole catalogue. - limits?: { maximumRuns?: number; }; default: not declared - limits.maximumRuns?: number; default: not declared - policy: { decide: TradingPolicy; label: string; requires: FeatureRecipes | null; }; default: not declared - policy.decide: TradingPolicy; default: not declared - policy.decide().return.cancel?: readonly string[]; default: not declared - policy.decide().return.kind: ('hold') | ('orders'); default: not declared - policy.decide().return.orders: readonly EnvironmentOrder[]; default: not declared - policy.decide().return.rationale?: string; default: not declared - policy.decide(observation): EnvironmentObservation; default: not declared - policy.decide(observation).actionMask: Readonly>; default: not declared - policy.decide(observation).asOf: number; default: not declared - policy.decide(observation).features: EnvironmentFeatures; default: not declared - policy.decide(observation).freshness: Readonly>; default: not declared - policy.decide(observation).index: number; default: not declared — The instant's ordinal among the decision instants. - policy.decide(observation).instruments: Readonly>; default: not declared - policy.decide(observation).limits: EnvironmentLimitsView; default: not declared - policy.decide(observation).market: Readonly>; default: not declared - policy.decide(observation).portfolio: EnvironmentPortfolioView; default: not declared - policy.decide(observation).previous: EnvironmentStepOutcome | null; default: not declared - policy.decide(observation).previous.action: EnvironmentAction; default: not declared - policy.decide(observation).previous.events: PortfolioEventEnvelope[]; default: not declared - policy.decide(observation).previous.fills: NormalizedFill[]; default: not declared - policy.decide(observation).previous.liquidations: LiquidationRow[]; default: not declared - policy.decide(observation).previous.rejections: EnvironmentRejection[]; default: not declared - policy.decide(observation).previous.reward: RewardBreakdown; default: not declared - policy.decide(observation).previous.step: number; default: not declared - policy.decide(observation).previous.warnings: QuantWarning[]; default: not declared - policy.decide(observation).provenance: EnvironmentProvenance; default: not declared - policy.decide(observation).sequence: number; default: not declared — Steps since `reset`. - policy.label: string; default: not declared - policy.requires: FeatureRecipes | null; default: not declared - policy.requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - policy.requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - policy.requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - policy.requires.realizedVolatility.annualization: number; default: not declared - policy.requires.realizedVolatility.lookbacks: readonly number[]; default: not declared - seeds?: readonly number[]; default: not declared — Default: [42]. ### @insiderfinance/totalfinance/backtest/environment#AgentBenchOperational Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The absolute gates and the counts, per episode. ```typescript /** The absolute gates and the counts, per episode. */ export interface AgentBenchOperational { lookAhead: number; replayEquality: boolean; duplicateOrders: number; maskViolations: number; limitBreaches: number; externalOrderAttempts: 0; reconciled: boolean; passes: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - duplicateOrders: number; default: not declared - externalOrderAttempts: 0; default: not declared - limitBreaches: number; default: not declared - lookAhead: number; default: not declared - maskViolations: number; default: not declared - passes: boolean; default: not declared - reconciled: boolean; default: not declared - replayEquality: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentBenchReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#AgentBenchReport`. ### @insiderfinance/totalfinance/backtest/environment#AgentBenchStrategy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AgentBenchStrategy { totalReturn: number | null; annualizedVolatility: number | null; sharpe: number | null; sortino: number | null; maxDrawdown: number; turnover: number; cost: number; meanGrossExposure: number; violations: number; steps: number; finalValue: number; rewardTotal: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedVolatility: number | null; default: not declared - cost: number; default: not declared - finalValue: number; default: not declared - maxDrawdown: number; default: not declared - meanGrossExposure: number; default: not declared - rewardTotal: number; default: not declared - sharpe: number | null; default: not declared - sortino: number | null; default: not declared - steps: number; default: not declared - totalReturn: number | null; default: not declared - turnover: number; default: not declared - violations: number; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentTranscript Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AgentTranscript { calls: AgentTranscriptCall[]; answer: { text: string; citedArtifactIds?: string[]; refused?: boolean; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - answer: { text: string; citedArtifactIds?: string[]; refused?: boolean; }; default: not declared - answer.citedArtifactIds?: string[]; default: not declared - answer.refused?: boolean; default: not declared - answer.text: string; default: not declared - calls: AgentTranscriptCall[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentTranscriptCall Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One transport call as a harness recorded it. ```typescript /** One transport call as a harness recorded it. */ export interface AgentTranscriptCall { operation: string; arguments: unknown; ok: boolean; error?: { code: string; message?: string; }; result?: unknown; /** Bytes the call moved through the model's context, when the harness measured them. */ bytes?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - arguments: unknown; default: not declared - bytes?: number; default: not declared — Bytes the call moved through the model's context, when the harness measured them. - error?: { code: string; message?: string; }; default: not declared - error.code: string; default: not declared - error.message?: string; default: not declared - ok: boolean; default: not declared - operation: string; default: not declared - result?: unknown; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentTranscriptExpectation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AgentTranscriptExpectation { /** The operations the journey must call. */ operations: string[]; argumentPredicates?: Record boolean>; /** The last successful result of `operation` must equal `direct` byte for byte (canonical JSON). */ parity?: { operation: string; direct: unknown; }; mustRefuse?: boolean; artifactIds?: string[]; budget?: { maximumCalls?: number; maximumBytes?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - argumentPredicates?: Record boolean>; default: not declared - artifactIds?: string[]; default: not declared - budget?: { maximumCalls?: number; maximumBytes?: number; }; default: not declared - budget.maximumBytes?: number; default: not declared - budget.maximumCalls?: number; default: not declared - mustRefuse?: boolean; default: not declared - operations: string[]; default: not declared — The operations the journey must call. - parity?: { operation: string; direct: unknown; }; default: not declared — The last successful result of `operation` must equal `direct` byte for byte (canonical JSON). - parity.direct: unknown; default: not declared - parity.operation: string; default: not declared ### @insiderfinance/totalfinance/backtest/environment#AgentTranscriptScore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#AgentTranscriptScore`. ### @insiderfinance/totalfinance/backtest/environment#BaselinePolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BaselinePolicy { readonly label: string; /** Feature recipes the policy reads; merged into every definition the bench runs it on. */ readonly requires: FeatureRecipes | null; readonly decide: TradingPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - decide: TradingPolicy; default: not declared - decide().return.cancel?: readonly string[]; default: not declared - decide().return.kind: ('hold') | ('orders'); default: not declared - decide().return.orders: readonly EnvironmentOrder[]; default: not declared - decide().return.rationale?: string; default: not declared - decide(observation): EnvironmentObservation; default: not declared - decide(observation).actionMask: Readonly>; default: not declared - decide(observation).asOf: number; default: not declared - decide(observation).features: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentFeatures; default: not declared - decide(observation).freshness: Readonly>; default: not declared - decide(observation).index: number; default: not declared — The instant's ordinal among the decision instants. - decide(observation).instruments: Readonly>; default: not declared - decide(observation).limits: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentLimitsView; default: not declared - decide(observation).market: Readonly>; default: not declared - decide(observation).portfolio: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentPortfolioView; default: not declared - decide(observation).previous: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentStepOutcome | null; default: not declared - decide(observation).previous.action: EnvironmentAction; default: not declared - decide(observation).previous.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - decide(observation).previous.fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared - decide(observation).previous.liquidations: import('@insiderfinance/totalfinance/backtest/portfolio').LiquidationRow[]; default: not declared - decide(observation).previous.rejections: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentRejection[]; default: not declared - decide(observation).previous.reward: import('@insiderfinance/totalfinance/backtest/environment').RewardBreakdown; default: not declared - decide(observation).previous.step: number; default: not declared - decide(observation).previous.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - decide(observation).provenance: import('@insiderfinance/totalfinance/backtest/environment').EnvironmentProvenance; default: not declared - decide(observation).sequence: number; default: not declared — Steps since `reset`. - label: string; default: not declared - requires: FeatureRecipes | null; default: not declared — Feature recipes the policy reads; merged into every definition the bench runs it on. - requires.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - requires.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - requires.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - requires.realizedVolatility.annualization: number; default: not declared - requires.realizedVolatility.lookbacks: readonly number[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#ENVIRONMENT_EPISODE_IDS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ENVIRONMENT_EPISODE_IDS: readonly ['trending', 'mean-reverting', 'range-bound', 'volatility-expansion', 'volatility-contraction', 'overnight-gaps', 'limit-moves', 'stale-data', 'missing-data', 'duplicated-data', 'corrected-data', 'out-of-order-data', 'wide-spreads', 'thin-liquidity', 'option-expiration', 'margin-pressure', 'retry-storm', 'corporate-actions', 'multi-currency', 'model-market-disagreement']; ``` ### @insiderfinance/totalfinance/backtest/environment#EnvironmentAction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EnvironmentAction`. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentEpisode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EnvironmentEpisode`. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentEpisodeId Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The catalogue's episode ids (Decision 8). ```typescript /** The catalogue's episode ids (Decision 8). */ export type EnvironmentEpisodeId = 'trending' | 'mean-reverting' | 'range-bound' | 'volatility-expansion' | 'volatility-contraction' | 'overnight-gaps' | 'limit-moves' | 'stale-data' | 'missing-data' | 'duplicated-data' | 'corrected-data' | 'out-of-order-data' | 'wide-spreads' | 'thin-liquidity' | 'option-expiration' | 'margin-pressure' | 'retry-storm' | 'corporate-actions' | 'multi-currency' | 'model-market-disagreement'; ``` ### @insiderfinance/totalfinance/backtest/environment#EnvironmentEpisodeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EnvironmentEpisodeInput`. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentEpisodeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EnvironmentEpisodeResult`. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentEpisodeStep Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentEpisodeStep { step: number; asOf: EpochMs; action: EnvironmentAction; traceHash: string; reward: RewardBreakdown; netAssetValue: number; fills: number; rejections: number; breaches: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - action: EnvironmentAction; default: not declared - action.cancel?: readonly string[]; default: not declared - action.kind: ('hold') | ('orders'); default: not declared - action.orders: readonly EnvironmentOrder[]; default: not declared - action.rationale?: string; default: not declared - asOf: number; default: not declared - breaches: number; default: not declared - fills: number; default: not declared - netAssetValue: number; default: not declared - rejections: number; default: not declared - reward: RewardBreakdown; default: not declared - reward.components: Readonly>; default: not declared - reward.total: number; default: not declared - step: number; default: not declared - traceHash: string; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentFeatures Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The evaluated features, keyed by lookback then instrument; null where the prefix is too short. ```typescript /** The evaluated features, keyed by lookback then instrument; null where the prefix is too short. */ export interface EnvironmentFeatures { lookbackReturns: Readonly>>>; realizedVolatility: Readonly>>>; drawdown: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drawdown: Readonly>; default: not declared - lookbackReturns: Readonly>>>; default: not declared - realizedVolatility: Readonly>>>; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentIdentity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentIdentity { runId: string; step: number; /** Chains the previous trace hash with this step's canonical action; identical policies leave identical traces. */ traceHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - runId: string; default: not declared - step: number; default: not declared - traceHash: string; default: not declared — Chains the previous trace hash with this step's canonical action; identical policies leave identical traces. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FC7's `PolicyLimits` verbatim plus three environment-only members (Decision 5). ```typescript /** FC7's `PolicyLimits` verbatim plus three environment-only members (Decision 5). */ export interface EnvironmentLimits extends PolicyLimits { /** Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. */ allowUndefinedRiskOptions?: boolean; /** Base currency, per instrument: the largest absolute position value an order may project. */ maximumPositionNotional?: number; /** What a post-trade breach does: end the episode (default) or record it and continue. */ onBreach?: 'terminate' | 'reject-and-continue'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. - maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - maximumPositionNotional?: number; default: not declared — Base currency, per instrument: the largest absolute position value an order may project. - maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - onBreach?: 'terminate' | 'reject-and-continue'; default: not declared — What a post-trade breach does: end the episode (default) or record it and continue. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentLimitsView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentLimitsView { utilization: LimitUtilization[]; breaches: LimitBreach[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - breaches: LimitBreach[]; default: not declared - utilization: LimitUtilization[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EnvironmentObservation`. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentOrder Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One order an action submits — the execution grammar without the fields the environment stamps. ```typescript /** One order an action submits — the execution grammar without the fields the environment stamps. */ export interface EnvironmentOrder { /** Assigned `${runId}:a${n}` when absent; a repeated id is an idempotent retry, never a second order. */ orderId?: string; instrumentId: string; side: OrderSide; quantity: number; type: OrderType; limitPrice?: number; stopPrice?: number; /** Default: the execution policy's. `day` expires with the session; `gtc` stays open until cancelled. */ timeInForce?: TimeInForce; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - limitPrice?: number; default: not declared - orderId?: string; default: not declared — Assigned `${runId}:a${n}` when absent; a repeated id is an idempotent retry, never a second order. - quantity: number; default: not declared - side: OrderSide; default: not declared - stopPrice?: number; default: not declared - timeInForce?: TimeInForce; default: not declared — Default: the execution policy's. `day` expires with the session; `gtc` stays open until cancelled. - type: OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentPortfolioView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentPortfolioView { netAssetValue: number; cash: readonly { currency: string; amount: number; }[]; positions: readonly SessionPosition[]; /** Σ |position market value| in the base currency (positions without a mark are excluded). */ grossExposure: number; /** Σ signed position market value in the base currency. */ netExposure: number; /** NAV × the margin policy's buying-power multiplier − gross exposure. */ buyingPower: number; openOrders: readonly OpenOrder[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buyingPower: number; default: not declared — NAV × the margin policy's buying-power multiplier − gross exposure. - cash: readonly { currency: string; amount: number; }[]; default: not declared - grossExposure: number; default: not declared — Σ |position market value| in the base currency (positions without a mark are excluded). - netAssetValue: number; default: not declared - netExposure: number; default: not declared — Σ signed position market value in the base currency. - openOrders: readonly OpenOrder[]; default: not declared - positions: readonly SessionPosition[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentProvenance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentProvenance { runId: string; /** The portfolio engine run this episode drives — the prefix of its event, fill, and source ids. */ engineRunId: string; definitionHash: string; seed: number | null; executionPolicy: string; conventionsVersion: string; adapters: Array<{ instrumentId: string; kind: string; version: string; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adapters: { instrumentId: string; kind: string; version: string; }[]; default: not declared - conventionsVersion: string; default: not declared - definitionHash: string; default: not declared - engineRunId: string; default: not declared — The portfolio engine run this episode drives — the prefix of its event, fill, and source ids. - executionPolicy: string; default: not declared - runId: string; default: not declared - seed: number | null; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentRejection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A typed rejection: never thrown, always a row with the step it happened at. ```typescript /** A typed rejection: never thrown, always a row with the step it happened at. */ export interface EnvironmentRejection { step: number; orderId: string | null; instrumentId: string | null; /** An `environment.*` code, or the engine's own (`backtest.unfilled.`, `backtest.data_missing`, …). */ code: string; detail: string; source: 'environment' | 'engine'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared — An `environment.*` code, or the engine's own (`backtest.unfilled.`, `backtest.data_missing`, …). - detail: string; default: not declared - instrumentId: string | null; default: not declared - orderId: string | null; default: not declared - source: 'engine' | 'environment'; default: not declared - step: number; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentRejectionCode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The environment's own rejection codes — registered in `ErrorCode`, never thrown (the engine's `backtest.*` codes pass through unchanged). ```typescript /** The environment's own rejection codes — registered in `ErrorCode`, never thrown (the engine's `backtest.*` codes pass through unchanged). */ export type EnvironmentRejectionCode = typeof ErrorCode.EnvironmentDuplicateOrder | typeof ErrorCode.EnvironmentLimitBreach | typeof ErrorCode.EnvironmentActionDisallowed | typeof ErrorCode.EnvironmentUnknownInstrument | typeof ErrorCode.EnvironmentOrderInvalid | typeof ErrorCode.EnvironmentActionInvalid | typeof ErrorCode.EnvironmentEpisodeOver; ``` ### @insiderfinance/totalfinance/backtest/environment#EnvironmentResetOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentResetOptions { /** Overrides the definition's seed for this episode; part of the run identity. */ seed?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - seed?: number; default: not declared — Overrides the definition's seed for this episode; part of the run identity. ### @insiderfinance/totalfinance/backtest/environment#EnvironmentResetResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EnvironmentResetResult { observation: EnvironmentObservation; episode: EpisodeInformation; identity: EnvironmentIdentity; /** An episode can be over at reset: a single instant, insolvency, or a limit breached at the start. */ terminated: boolean; truncated: boolean; reason: EnvironmentStepResult['reason']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - episode: EpisodeInformation; default: not declared - episode.definitionHash: string; default: not declared - episode.engineRunId: string; default: not declared - episode.instantCount: number; default: not declared - episode.maximumSteps: number; default: not declared - episode.runId: string; default: not declared - episode.seed: number | null; default: not declared - episode.window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - episode.window.fromTimestampMs: number | null; default: not declared - episode.window.toTimestampMs: number | null; default: not declared - identity: EnvironmentIdentity; default: not declared - identity.runId: string; default: not declared - identity.step: number; default: not declared - identity.traceHash: string; default: not declared — Chains the previous trace hash with this step's canonical action; identical policies leave identical traces. - observation: EnvironmentObservation; default: not declared - observation.actionMask: Readonly>; default: not declared - observation.asOf: number; default: not declared - observation.features: EnvironmentFeatures; default: not declared - observation.features.drawdown: Readonly>; default: not declared - observation.features.lookbackReturns: Readonly>>>; default: not declared - observation.features.realizedVolatility: Readonly>>>; default: not declared - observation.freshness: Readonly>; default: not declared - observation.index: number; default: not declared — The instant's ordinal among the decision instants. - observation.instruments: Readonly>; default: not declared - observation.limits: EnvironmentLimitsView; default: not declared - observation.limits.breaches: LimitBreach[]; default: not declared - observation.limits.utilization: LimitUtilization[]; default: not declared - observation.market: Readonly>; default: not declared - observation.portfolio: EnvironmentPortfolioView; default: not declared - observation.portfolio.buyingPower: number; default: not declared — NAV × the margin policy's buying-power multiplier − gross exposure. - observation.portfolio.cash: readonly { currency: string; amount: number; }[]; default: not declared - observation.portfolio.grossExposure: number; default: not declared — Σ |position market value| in the base currency (positions without a mark are excluded). - observation.portfolio.netAssetValue: number; default: not declared - observation.portfolio.netExposure: number; default: not declared — Σ signed position market value in the base currency. - observation.portfolio.openOrders: readonly OpenOrder[]; default: not declared - observation.portfolio.positions: readonly SessionPosition[]; default: not declared - observation.previous: EnvironmentStepOutcome | null; default: not declared - observation.previous.action: EnvironmentAction; default: not declared - observation.previous.action.cancel?: readonly string[]; default: not declared - observation.previous.action.kind: ('hold') | ('orders'); default: not declared - observation.previous.action.orders: readonly EnvironmentOrder[]; default: not declared - observation.previous.action.rationale?: string; default: not declared - observation.previous.events: PortfolioEventEnvelope[]; default: not declared - observation.previous.fills: NormalizedFill[]; default: not declared - observation.previous.liquidations: LiquidationRow[]; default: not declared - observation.previous.rejections: EnvironmentRejection[]; default: not declared - observation.previous.reward: RewardBreakdown; default: not declared - observation.previous.reward.components: Readonly>; default: not declared - observation.previous.reward.total: number; default: not declared - observation.previous.step: number; default: not declared - observation.previous.warnings: QuantWarning[]; default: not declared - observation.provenance: EnvironmentProvenance; default: not declared - observation.provenance.adapters: { instrumentId: string; kind: string; version: string; }[]; default: not declared - observation.provenance.conventionsVersion: string; default: not declared - observation.provenance.definitionHash: string; default: not declared - observation.provenance.engineRunId: string; default: not declared — The portfolio engine run this episode drives — the prefix of its event, fill, and source ids. - observation.provenance.executionPolicy: string; default: not declared - observation.provenance.runId: string; default: not declared - observation.provenance.seed: number | null; default: not declared - observation.sequence: number; default: not declared — Steps since `reset`. - reason: 'insolvent' | 'limit-breach' | 'data-boundary' | 'maximum-steps' | null; default: not declared - terminated: boolean; default: not declared — An episode can be over at reset: a single instant, insolvency, or a limit breached at the start. - truncated: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentStepOutcome Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The outcome of one action — what the previous step did, as the next observation reports it. ```typescript /** The outcome of one action — what the previous step did, as the next observation reports it. */ export interface EnvironmentStepOutcome { step: number; action: EnvironmentAction; fills: NormalizedFill[]; rejections: EnvironmentRejection[]; liquidations: LiquidationRow[]; events: PortfolioEventEnvelope[]; warnings: QuantWarning[]; reward: RewardBreakdown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - action: EnvironmentAction; default: not declared - action.cancel?: readonly string[]; default: not declared - action.kind: ('hold') | ('orders'); default: not declared - action.orders: readonly EnvironmentOrder[]; default: not declared - action.rationale?: string; default: not declared - events: PortfolioEventEnvelope[]; default: not declared - fills: NormalizedFill[]; default: not declared - liquidations: LiquidationRow[]; default: not declared - rejections: EnvironmentRejection[]; default: not declared - reward: RewardBreakdown; default: not declared - reward.components: Readonly>; default: not declared - reward.total: number; default: not declared - step: number; default: not declared - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#EnvironmentStepResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EnvironmentStepResult`. ### @insiderfinance/totalfinance/backtest/environment#EpisodeInformation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EpisodeInformation { runId: string; engineRunId: string; definitionHash: string; seed: number | null; instantCount: number; maximumSteps: number; window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - definitionHash: string; default: not declared - engineRunId: string; default: not declared - instantCount: number; default: not declared - maximumSteps: number; default: not declared - runId: string; default: not declared - seed: number | null; default: not declared - window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - window.fromTimestampMs: number | null; default: not declared - window.toTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance/backtest/environment#FeatureRecipes Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Feature recipes evaluated over the bar closes at or before the instant only. ```typescript /** Feature recipes evaluated over the bar closes at or before the instant only. */ export interface FeatureRecipes { /** Close-to-close returns over each lookback in bars. */ lookbackReturns?: readonly number[]; /** * Standard deviation of log returns over each lookback in bars, scaled by √annualization — * the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the * environment never assumes the bar frequency. */ realizedVolatility?: { lookbacks: readonly number[]; annualization: number; }; /** 1 − close ÷ running peak close, per instrument. */ drawdown?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - realizedVolatility.annualization: number; default: not declared - realizedVolatility.lookbacks: readonly number[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#InstrumentFreshness Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface InstrumentFreshness { /** The latest observation of the kind the execution policy fills on (the chain quote for an option). */ latestTimestampMs: EpochMs | null; ageMs: number | null; /** Older than the execution policy's `staleQuotes.maximumAgeMs`. */ stale: boolean; /** Every observation kind present at the instant. */ kinds: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ageMs: number | null; default: not declared - kinds: string[]; default: not declared — Every observation kind present at the instant. - latestTimestampMs: number | null; default: not declared — The latest observation of the kind the execution policy fills on (the chain quote for an option). - stale: boolean; default: not declared — Older than the execution policy's `staleQuotes.maximumAgeMs`. ### @insiderfinance/totalfinance/backtest/environment#LimitBreach Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A breach the FC7 monitor raised at the instant (`monitorPortfolio`, state raised or active). ```typescript /** A breach the FC7 monitor raised at the instant (`monitorPortfolio`, state raised or active). */ export interface LimitBreach { family: string; subject: string; value: number | null; threshold: number | null; message: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - family: string; default: not declared - message: string; default: not declared - subject: string; default: not declared - threshold: number | null; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/backtest/environment#LimitUtilization Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LimitUtilization { /** The limit's name in `EnvironmentLimits`. */ limit: string; subject: string; value: number | null; bound: number; /** value ÷ bound for an upper bound; bound ÷ value for a floor; null when the value is unknown. */ fraction: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bound: number; default: not declared - fraction: number | null; default: not declared — value ÷ bound for an upper bound; bound ÷ value for a floor; null when the value is unknown. - limit: string; default: not declared — The limit's name in `EnvironmentLimits`. - subject: string; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/backtest/environment#MAXIMUM_ENVIRONMENT_STEPS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The most steps one episode may take (Decision 11). ```typescript export declare const MAXIMUM_ENVIRONMENT_STEPS: 100000; ``` ### @insiderfinance/totalfinance/backtest/environment#MaskReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MaskReason = 'no-observation' | 'halted' | 'stale-quote' | 'position-limit' | 'notional-limit' | 'leverage-limit' | 'undefined-risk' | 'insufficient-buying-power' | 'episode-over'; ``` ### @insiderfinance/totalfinance/backtest/environment#OpenOrder Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An order accepted and not yet resolved — it meets the market at the next instant. ```typescript /** An order accepted and not yet resolved — it meets the market at the next instant. */ export interface OpenOrder { orderId: string; instrumentId: string; side: OrderSide; /** The quantity still to fill. */ quantity: number; type: OrderType; limitPrice?: number; stopPrice?: number; timeInForce: TimeInForce; submittedStep: number; submittedTimestampMs: EpochMs; reason: OpenOrderReason; /** How many instants the order has met the market. */ attempts: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - attempts: number; default: not declared — How many instants the order has met the market. - instrumentId: string; default: not declared - limitPrice?: number; default: not declared - orderId: string; default: not declared - quantity: number; default: not declared — The quantity still to fill. - reason: OpenOrderReason; default: not declared - side: OrderSide; default: not declared - stopPrice?: number; default: not declared - submittedStep: number; default: not declared - submittedTimestampMs: number; default: not declared - timeInForce: TimeInForce; default: not declared - type: OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/environment#OpenOrderReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Why an order is still open: submitted this step, or the market reason it did not fill. ```typescript /** Why an order is still open: submitted this step, or the market reason it did not fill. */ export type OpenOrderReason = 'submitted' | 'partial' | 'not-triggered' | 'no-observation' | 'stale-quote' | 'halted' | 'locked-crossed' | 'insufficient-depth'; ``` ### @insiderfinance/totalfinance/backtest/environment#RATIONALE_BYTE_LIMIT Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bytes of `rationale` kept per action; longer text is truncated with a diagnostic, never refused. ```typescript export declare const RATIONALE_BYTE_LIMIT: 4096; ``` ### @insiderfinance/totalfinance/backtest/environment#RewardBreakdown Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every component separately, plus the weighted total. ```typescript /** Every component separately, plus the weighted total. */ export interface RewardBreakdown { total: number; components: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - components: Readonly>; default: not declared - total: number; default: not declared ### @insiderfinance/totalfinance/backtest/environment#RewardComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RewardComponent { value: number; weight: number; contribution: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contribution: number; default: not declared - value: number; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/backtest/environment#RewardComposition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The declared reward composition — weights on the components below; absent components are reported with weight 0. ```typescript /** The declared reward composition — weights on the components below; absent components are reported with weight 0. */ export interface RewardComposition { /** On the step's net return, Δ NAV ÷ NAV before the step. */ pnl?: number; /** On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). */ drawdown?: number; /** On traded notional ÷ NAV before the step. */ turnover?: number; /** On commissions, fees, and slippage ÷ NAV before the step. */ cost?: number; /** On the largest absolute position weight after the step. */ concentration?: number; /** On gross exposure ÷ NAV after the step. */ leverage?: number; /** On the count of limit breaches and disallowed orders in the step. */ riskViolation?: number; /** On the step return minus the named instrument's bar return over the step. */ benchmark?: { weight: number; instrumentId: string; }; /** Extra named terms (weight 1 each); a callback, so the definition is not replayable. */ goal?: (frame: RewardFrame) => Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - benchmark?: { instrumentId: string; weight: number; }; default: not declared — On the step return minus the named instrument's bar return over the step. - benchmark.instrumentId: string; default: not declared - benchmark.weight: number; default: not declared - concentration?: number; default: not declared — On the largest absolute position weight after the step. - cost?: number; default: not declared — On commissions, fees, and slippage ÷ NAV before the step. - drawdown?: number; default: not declared — On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). - goal?: (frame: RewardFrame) => Record; default: not declared — Extra named terms (weight 1 each); a callback, so the definition is not replayable. - goal(frame): RewardFrame; default: not declared - goal(frame).asOf: number; default: not declared - goal(frame).benchmarkReturn: number | null; default: not declared — The benchmark instrument's bar-close return over the step, or null without two closes. - goal(frame).costs: number; default: not declared — Σ commission + fees + slippage adjustment of the step's fills, base currency. - goal(frame).drawdownAfter: number; default: not declared - goal(frame).drawdownBefore: number; default: not declared — 1 − NAV ÷ running peak, before and after the step. - goal(frame).fills: readonly NormalizedFill[]; default: not declared - goal(frame).grossExposure: number; default: not declared - goal(frame).largestPositionWeight: number; default: not declared - goal(frame).netAssetValueAfter: number; default: not declared - goal(frame).netAssetValueBefore: number; default: not declared - goal(frame).positions: readonly SessionPosition[]; default: not declared - goal(frame).step: number; default: not declared - goal(frame).stepReturn: number; default: not declared — Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). - goal(frame).tradedNotional: number; default: not declared — Σ |quantity × price × multiplier| of the step's fills, base currency. - goal(frame).violations: number; default: not declared — Limit breaches plus disallowed orders in the step. - leverage?: number; default: not declared — On gross exposure ÷ NAV after the step. - pnl?: number; default: not declared — On the step's net return, Δ NAV ÷ NAV before the step. - riskViolation?: number; default: not declared — On the count of limit breaches and disallowed orders in the step. - turnover?: number; default: not declared — On traded notional ÷ NAV before the step. ### @insiderfinance/totalfinance/backtest/environment#RewardFrame Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What one step did, as the reward reads it — from the engine's frame, never from the ledger. ```typescript /** What one step did, as the reward reads it — from the engine's frame, never from the ledger. */ export interface RewardFrame { step: number; asOf: EpochMs; netAssetValueBefore: number; netAssetValueAfter: number; /** Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). */ stepReturn: number; /** 1 − NAV ÷ running peak, before and after the step. */ drawdownBefore: number; drawdownAfter: number; /** Σ |quantity × price × multiplier| of the step's fills, base currency. */ tradedNotional: number; /** Σ commission + fees + slippage adjustment of the step's fills, base currency. */ costs: number; grossExposure: number; largestPositionWeight: number; /** Limit breaches plus disallowed orders in the step. */ violations: number; /** The benchmark instrument's bar-close return over the step, or null without two closes. */ benchmarkReturn: number | null; fills: readonly NormalizedFill[]; positions: readonly SessionPosition[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - benchmarkReturn: number | null; default: not declared — The benchmark instrument's bar-close return over the step, or null without two closes. - costs: number; default: not declared — Σ commission + fees + slippage adjustment of the step's fills, base currency. - drawdownAfter: number; default: not declared - drawdownBefore: number; default: not declared — 1 − NAV ÷ running peak, before and after the step. - fills: readonly NormalizedFill[]; default: not declared - grossExposure: number; default: not declared - largestPositionWeight: number; default: not declared - netAssetValueAfter: number; default: not declared - netAssetValueBefore: number; default: not declared - positions: readonly SessionPosition[]; default: not declared - step: number; default: not declared - stepReturn: number; default: not declared — Δ NAV ÷ NAV before the step (0 when the NAV before was not positive). - tradedNotional: number; default: not declared — Σ |quantity × price × multiplier| of the step's fills, base currency. - violations: number; default: not declared — Limit breaches plus disallowed orders in the step. ### @insiderfinance/totalfinance/backtest/environment#TradingEnvironment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TradingEnvironment`. ### @insiderfinance/totalfinance/backtest/environment#TradingEnvironmentDefinition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TradingEnvironmentDefinition`. ### @insiderfinance/totalfinance/backtest/environment#TradingPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A coded policy: the observation in, the action out. ```typescript /** A coded policy: the observation in, the action out. */ export type TradingPolicy = (observation: EnvironmentObservation) => EnvironmentAction; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (observation): EnvironmentObservation; default: not declared - (observation).actionMask: Readonly>; default: not declared - (observation).asOf: number; default: not declared - (observation).features: EnvironmentFeatures; default: not declared - (observation).freshness: Readonly>; default: not declared - (observation).index: number; default: not declared — The instant's ordinal among the decision instants. - (observation).instruments: Readonly>; default: not declared - (observation).limits: EnvironmentLimitsView; default: not declared - (observation).market: Readonly>; default: not declared - (observation).portfolio: EnvironmentPortfolioView; default: not declared - (observation).previous: EnvironmentStepOutcome | null; default: not declared - (observation).previous.action: EnvironmentAction; default: not declared - (observation).previous.events: PortfolioEventEnvelope[]; default: not declared - (observation).previous.fills: NormalizedFill[]; default: not declared - (observation).previous.liquidations: LiquidationRow[]; default: not declared - (observation).previous.rejections: EnvironmentRejection[]; default: not declared - (observation).previous.reward: RewardBreakdown; default: not declared - (observation).previous.step: number; default: not declared - (observation).previous.warnings: QuantWarning[]; default: not declared - (observation).provenance: EnvironmentProvenance; default: not declared - (observation).sequence: number; default: not declared — Steps since `reset`. - return.cancel?: readonly string[]; default: not declared - return.kind: ('hold') | ('orders'); default: not declared - return.orders: readonly EnvironmentOrder[]; default: not declared - return.rationale?: string; default: not declared ### @insiderfinance/totalfinance/backtest/environment#agentBaselines Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#agentBaselines`. ### @insiderfinance/totalfinance/backtest/environment#createTradingEnvironment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#createTradingEnvironment`. ### @insiderfinance/totalfinance/backtest/environment#environmentEpisode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#environmentEpisode`. ### @insiderfinance/totalfinance/backtest/environment#listEnvironmentEpisodes Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every maintained episode at its default seed, in catalogue order. ```typescript export declare function listEnvironmentEpisodes(): Array<{ id: EnvironmentEpisodeId; title: string; sessions: number; }>; ``` ### @insiderfinance/totalfinance/backtest/environment#requireEnvironmentAction Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An action, refused outright — for callers who want the teaching error rather than a rejection row. ```typescript export declare function requireEnvironmentAction(functionName: string, label: string, value: unknown): EnvironmentAction; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.cancel?: readonly string[]; default: not declared - return.kind: ('hold') | ('orders'); default: not declared - return.orders: readonly EnvironmentOrder[]; default: not declared - return.rationale?: string; default: not declared ### @insiderfinance/totalfinance/backtest/environment#requireEnvironmentEpisodeInput Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireEnvironmentEpisodeInput(functionName: string, label: string, value: unknown): EnvironmentEpisodeInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.actions: readonly EnvironmentAction[]; default: not declared - return.definition: import('@insiderfinance/totalfinance/backtest').TradingEnvironmentDefinition; default: not declared - return.seed?: number; default: not declared ### @insiderfinance/totalfinance/backtest/environment#requireEnvironmentLimits Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FC7's `PolicyLimits` members plus the three environment-only ones (Decision 5). ```typescript export declare function requireEnvironmentLimits(functionName: string, label: string, value: unknown): EnvironmentLimits; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a sell that leaves an option position net short (and, for a call, uncovered) is disallowed. - return.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - return.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - return.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - return.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - return.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - return.maximumPositionNotional?: number; default: not declared — Base currency, per instrument: the largest absolute position value an order may project. - return.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - return.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - return.onBreach?: 'terminate' | 'reject-and-continue'; default: not declared — What a post-trade breach does: end the episode (default) or record it and continue. ### @insiderfinance/totalfinance/backtest/environment#requireEnvironmentOrder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One environment order, validated through the execution grammar it extends. ```typescript export declare function requireEnvironmentOrder(functionName: string, label: string, value: unknown): EnvironmentOrder; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.instrumentId: string; default: not declared - return.limitPrice?: number; default: not declared - return.orderId?: string; default: not declared — Assigned `${runId}:a${n}` when absent; a repeated id is an idempotent retry, never a second order. - return.quantity: number; default: not declared - return.side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - return.stopPrice?: number; default: not declared - return.timeInForce?: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared — Default: the execution policy's. `day` expires with the session; `gtc` stays open until cancelled. - return.type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/environment#requireFeatureRecipes Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The feature recipes: positive integer lookbacks, a positive annualization, a boolean drawdown flag. ```typescript export declare function requireFeatureRecipes(functionName: string, label: string, value: unknown): FeatureRecipes; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.drawdown?: boolean; default: not declared — 1 − close ÷ running peak close, per instrument. - return.lookbackReturns?: readonly number[]; default: not declared — Close-to-close returns over each lookback in bars. - return.realizedVolatility?: { annualization: number; lookbacks: readonly number[]; }; default: not declared — Standard deviation of log returns over each lookback in bars, scaled by √annualization — the bars per year (252 daily, 52 weekly, 12 monthly) or `1` for the per-bar σ. Required: the environment never assumes the bar frequency. - return.realizedVolatility.annualization: number; default: not declared - return.realizedVolatility.lookbacks: readonly number[]; default: not declared ### @insiderfinance/totalfinance/backtest/environment#requireRewardComposition Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The reward composition: finite weights, a benchmark with a weight and an instrument, an optional goal callback (Decision 7). ```typescript export declare function requireRewardComposition(functionName: string, label: string, value: unknown): RewardComposition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.benchmark?: { instrumentId: string; weight: number; }; default: not declared — On the step return minus the named instrument's bar return over the step. - return.benchmark.instrumentId: string; default: not declared - return.benchmark.weight: number; default: not declared - return.concentration?: number; default: not declared — On the largest absolute position weight after the step. - return.cost?: number; default: not declared — On commissions, fees, and slippage ÷ NAV before the step. - return.drawdown?: number; default: not declared — On the INCREASE in drawdown from the episode's running peak (a recovery pays 0). - return.goal?: (frame: import('@insiderfinance/totalfinance/backtest/environment').RewardFrame) => Record; default: not declared — Extra named terms (weight 1 each); a callback, so the definition is not replayable. - return.leverage?: number; default: not declared — On gross exposure ÷ NAV after the step. - return.pnl?: number; default: not declared — On the step's net return, Δ NAV ÷ NAV before the step. - return.riskViolation?: number; default: not declared — On the count of limit breaches and disallowed orders in the step. - return.turnover?: number; default: not declared — On traded notional ÷ NAV before the step. ### @insiderfinance/totalfinance/backtest/environment#requireTradingEnvironmentDefinition Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The environment definition (Stage 7B.1): the stepper's request plus `maximumSteps`. A `strategy` member teaches which verb wants it — the environment's orders come from `step()`. ```typescript export declare function requireTradingEnvironmentDefinition(functionName: string, label: string, value: unknown): TradingEnvironmentDefinition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accounting: import('@insiderfinance/totalfinance/backtest/portfolio').AccountingPolicy; default: not declared - return.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - return.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - return.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - return.features?: FeatureRecipes; default: not declared - return.instruments: Readonly>; default: not declared - return.limits?: EnvironmentLimits; default: not declared - return.marketData: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioMarketData; default: not declared - return.maximumSteps?: number; default: not declared — The most steps an episode takes before `truncated` (default: the instant count; ceiling 100,000). - return.periodsPerYear?: number; default: not declared - return.reward?: RewardComposition; default: not declared - return.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - return.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - return.window.fromTimestampMs?: number; default: not declared - return.window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest/environment#runAgentBench Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#runAgentBench`. ### @insiderfinance/totalfinance/backtest/environment#runEnvironmentEpisode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#runEnvironmentEpisode`. ### @insiderfinance/totalfinance/backtest/environment#scoreAgentTranscript Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#scoreAgentTranscript`. ## Entrypoint @insiderfinance/totalfinance/backtest/event-driven ### @insiderfinance/totalfinance/backtest/event-driven#BarField Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#BarField`. ### @insiderfinance/totalfinance/backtest/event-driven#EventDrivenOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#EventDrivenOptions`. ### @insiderfinance/totalfinance/backtest/event-driven#Indicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#Indicator`. ### @insiderfinance/totalfinance/backtest/event-driven#IndicatorHandle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#IndicatorHandle`. ### @insiderfinance/totalfinance/backtest/event-driven#StrategyContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#StrategyContext`. ### @insiderfinance/totalfinance/backtest/event-driven#TradeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TradeOptions`. ### @insiderfinance/totalfinance/backtest/event-driven#crossOver Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#crossOver`. ### @insiderfinance/totalfinance/backtest/event-driven#crossUnder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#crossUnder`. ### @insiderfinance/totalfinance/backtest/event-driven#eventDriven Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#eventDriven`. ## Entrypoint @insiderfinance/totalfinance/backtest/execution ### @insiderfinance/totalfinance/backtest/execution#AmbiguityPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How an intrabar sequence of touches is resolved when the bar alone cannot say. ```typescript /** How an intrabar sequence of touches is resolved when the bar alone cannot say. */ export type AmbiguityPolicy = 'optimistic' | 'pessimistic' | 'deterministic-path' | 'reject'; ``` ### @insiderfinance/totalfinance/backtest/execution#AssertFillModelConformanceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AssertFillModelConformanceInput { fillModel: FillModel; /** Caller fixtures run beside the built-in ones for the model's observation kind. */ fixtures?: readonly FillModelFixture[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fillModel: FillModel; default: not declared - fillModel.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => FillDecision; default: not declared - fillModel.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - fillModel.fill().return.detail?: string; default: not declared - fillModel.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - fillModel.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - fillModel.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - fillModel.fill().return.pricePerUnit: number; default: not declared - fillModel.fill().return.quantity: number; default: not declared - fillModel.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - fillModel.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - fillModel.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - fillModel.fill(request).context: FillContext; default: not declared - fillModel.fill(request).observation: MarketObservation; default: not declared - fillModel.fill(request).order: OrderIntent; default: not declared - fillModel.label: string; default: not declared - fillModel.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - fillModel.version: string; default: not declared - fixtures?: readonly FillModelFixture[]; default: not declared — Caller fixtures run beside the built-in ones for the model's observation kind. ### @insiderfinance/totalfinance/backtest/execution#DeclaredExecutionPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The members `execution.declared` accepts — every one optional except the label. ```typescript /** The members `execution.declared` accepts — every one optional except the label. */ export interface DeclaredExecutionPolicy { label: string; observation?: MarketObservationKind; fill?: FillModel; ambiguity?: AmbiguityPolicy; costs?: Partial; staleQuotes?: StaleQuotePolicy; lockedCrossed?: LockedCrossedPolicy; sessions?: SessionRules; partialFills?: PartialFillPolicy; queue?: { model: QueueModel; }; timeInForce?: { default: TimeInForce; expireAtSessionClose: boolean; }; margin?: MarginPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ambiguity?: AmbiguityPolicy; default: not declared - costs?: Partial; default: not declared - costs.borrow?: BorrowModel; default: not declared - costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - costs.borrow.label: string; default: not declared - costs.commission?: CostModel; default: not declared - costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - costs.commission.commission(input).price: number; default: not declared - costs.commission.commission(input).quantity: number; default: not declared - costs.commission.label: string; default: not declared - costs.latency?: LatencyModel; default: not declared - costs.latency.label: string; default: not declared - costs.latency.sessions: number; default: not declared - costs.marketImpact?: MarketImpactModel; default: not declared - costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - costs.marketImpact.impact(input).quantity: number; default: not declared - costs.marketImpact.impact(input).referencePrice: number; default: not declared - costs.marketImpact.label: string; default: not declared - costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - costs.slippage?: SlippageModel; default: not declared - costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - costs.slippage.fill(input).quantity: number; default: not declared - costs.slippage.fill(input).referencePrice: number; default: not declared - costs.slippage.fill(input).side: OrderSide; default: not declared - costs.slippage.label: string; default: not declared - costs.spread?: SpreadModel; default: not declared - costs.spread.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - costs.spread.halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - costs.spread.halfSpread(input).referencePrice: number; default: not declared - costs.spread.halfSpread(input).side: OrderSide; default: not declared - costs.spread.label: string; default: not declared - fill?: FillModel; default: not declared - fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - fill.fill().return.detail?: string; default: not declared - fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - fill.fill().return.pricePerUnit: number; default: not declared - fill.fill().return.quantity: number; default: not declared - fill.fill().return.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - fill.fill(request).observation: import('@insiderfinance/totalfinance/backtest/execution').MarketObservation; default: not declared - fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - fill.label: string; default: not declared - fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - fill.version: string; default: not declared - label: string; default: not declared - lockedCrossed?: LockedCrossedPolicy; default: not declared - margin?: MarginPolicy; default: not declared - margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - observation?: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - partialFills?: PartialFillPolicy; default: not declared - queue?: { model: QueueModel; }; default: not declared - queue.model: QueueModel; default: not declared - sessions?: SessionRules; default: not declared - sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - staleQuotes?: StaleQuotePolicy; default: not declared - staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - timeInForce?: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - timeInForce.default: TimeInForce; default: not declared - timeInForce.expireAtSessionClose: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/execution#ExecutionCosts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExecutionCosts { commission: CostModel; slippage: SlippageModel; spread?: SpreadModel; marketImpact?: MarketImpactModel; latency?: LatencyModel; /** Fraction of the observation's volume one fill may take. */ participation?: number; borrow?: BorrowModel; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - borrow?: BorrowModel; default: not declared - borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - borrow.label: string; default: not declared - commission: CostModel; default: not declared - commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - commission.commission(input).price: number; default: not declared - commission.commission(input).quantity: number; default: not declared - commission.label: string; default: not declared - latency?: LatencyModel; default: not declared - latency.label: string; default: not declared - latency.sessions: number; default: not declared - marketImpact?: MarketImpactModel; default: not declared - marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - marketImpact.impact(input).averageDailyVolume?: number; default: not declared - marketImpact.impact(input).quantity: number; default: not declared - marketImpact.impact(input).referencePrice: number; default: not declared - marketImpact.label: string; default: not declared - participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - slippage: SlippageModel; default: not declared - slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - slippage.fill(input).quantity: number; default: not declared - slippage.fill(input).referencePrice: number; default: not declared - slippage.fill(input).side: OrderSide; default: not declared - slippage.label: string; default: not declared - spread?: SpreadModel; default: not declared - spread.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - spread.halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - spread.halfSpread(input).referencePrice: number; default: not declared - spread.halfSpread(input).side: OrderSide; default: not declared - spread.label: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#ExecutionPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The whole declared execution reality of one run. ```typescript /** The whole declared execution reality of one run. */ export interface ExecutionPolicy { /** Echoed in every result's assumptions. */ readonly label: string; /** `simplified` is the default and says so; `declared` means the caller named every member. */ readonly realism: 'simplified' | 'declared'; readonly observation: MarketObservationKind; readonly fill: FillModel; readonly ambiguity: AmbiguityPolicy; readonly costs: ExecutionCosts; readonly staleQuotes: StaleQuotePolicy; readonly lockedCrossed: LockedCrossedPolicy; readonly sessions?: SessionRules; readonly partialFills: PartialFillPolicy; readonly queue: { model: QueueModel; }; readonly timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; readonly margin: MarginPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ambiguity: AmbiguityPolicy; default: not declared - costs: ExecutionCosts; default: not declared - costs.borrow?: BorrowModel; default: not declared - costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - costs.borrow.label: string; default: not declared - costs.commission: CostModel; default: not declared - costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - costs.commission.commission(input).price: number; default: not declared - costs.commission.commission(input).quantity: number; default: not declared - costs.commission.label: string; default: not declared - costs.latency?: LatencyModel; default: not declared - costs.latency.label: string; default: not declared - costs.latency.sessions: number; default: not declared - costs.marketImpact?: MarketImpactModel; default: not declared - costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - costs.marketImpact.impact(input).quantity: number; default: not declared - costs.marketImpact.impact(input).referencePrice: number; default: not declared - costs.marketImpact.label: string; default: not declared - costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - costs.slippage: SlippageModel; default: not declared - costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - costs.slippage.fill(input).quantity: number; default: not declared - costs.slippage.fill(input).referencePrice: number; default: not declared - costs.slippage.fill(input).side: OrderSide; default: not declared - costs.slippage.label: string; default: not declared - costs.spread?: SpreadModel; default: not declared - costs.spread.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - costs.spread.halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - costs.spread.halfSpread(input).referencePrice: number; default: not declared - costs.spread.halfSpread(input).side: OrderSide; default: not declared - costs.spread.label: string; default: not declared - fill: FillModel; default: not declared - fill.fill: (request: FillRequest) => FillDecision; default: not declared - fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - fill.fill().return.detail?: string; default: not declared - fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - fill.fill().return.pricePerUnit: number; default: not declared - fill.fill().return.quantity: number; default: not declared - fill.fill().return.reason: UnfilledReason; default: not declared - fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - fill.fill(request): FillRequest; default: not declared - fill.fill(request).context: FillContext; default: not declared - fill.fill(request).observation: MarketObservation; default: not declared - fill.fill(request).order: OrderIntent; default: not declared - fill.label: string; default: not declared - fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - fill.version: string; default: not declared - label: string; default: not declared — Echoed in every result's assumptions. - lockedCrossed: LockedCrossedPolicy; default: not declared - margin: MarginPolicy; default: not declared - margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - margin.forcedLiquidation: ForcedLiquidationPolicy; default: not declared - margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - partialFills: PartialFillPolicy; default: not declared - queue: { model: QueueModel; }; default: not declared - queue.model: QueueModel; default: not declared - realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - sessions?: SessionRules; default: not declared - sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - sessions.halts?: readonly HaltWindow[]; default: not declared - sessions.priceLimits?: readonly PriceLimitWindow[]; default: not declared - staleQuotes: StaleQuotePolicy; default: not declared - staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - timeInForce.default: TimeInForce; default: not declared - timeInForce.expireAtSessionClose: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/execution#ExecutionPolicyDescription Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The JSON-safe projection of a policy that goes into a result's assumptions. ```typescript /** The JSON-safe projection of a policy that goes into a result's assumptions. */ export interface ExecutionPolicyDescription { label: string; realism: 'simplified' | 'declared'; observation: MarketObservationKind; fill: { label: string; version: string; }; ambiguity: AmbiguityPolicy; costs: { commission: string; slippage: string; spread: string | null; marketImpact: string | null; latencySessions: number | null; participation: number | null; borrow: string | null; }; staleQuotes: StaleQuotePolicy; lockedCrossed: LockedCrossedPolicy; sessions: { halts: number; priceLimits: number; auction: 'ignore' | 'open-close-only' | null; }; partialFills: PartialFillPolicy; queue: QueueModel; timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; margin: MarginPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ambiguity: AmbiguityPolicy; default: not declared - costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - costs.borrow: string | null; default: not declared - costs.commission: string; default: not declared - costs.latencySessions: number | null; default: not declared - costs.marketImpact: string | null; default: not declared - costs.participation: number | null; default: not declared - costs.slippage: string; default: not declared - costs.spread: string | null; default: not declared - fill: { label: string; version: string; }; default: not declared - fill.label: string; default: not declared - fill.version: string; default: not declared - label: string; default: not declared - lockedCrossed: LockedCrossedPolicy; default: not declared - margin: MarginPolicy; default: not declared - margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - margin.forcedLiquidation: ForcedLiquidationPolicy; default: not declared - margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - partialFills: PartialFillPolicy; default: not declared - queue: QueueModel; default: not declared - realism: 'simplified' | 'declared'; default: not declared - sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - sessions.halts: number; default: not declared - sessions.priceLimits: number; default: not declared - staleQuotes: StaleQuotePolicy; default: not declared - staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - timeInForce.default: TimeInForce; default: not declared - timeInForce.expireAtSessionClose: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/execution#FillContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The per-decision context a fill model receives beside the order and the observation. ```typescript /** The per-decision context a fill model receives beside the order and the observation. */ export interface FillContext { asOf: EpochMs; /** Fraction of the observation's volume (or size) one fill may take; omitted = no cap. */ participation?: number; partialFills: PartialFillPolicy; staleQuotes: StaleQuotePolicy; lockedCrossed: LockedCrossedPolicy; sessions?: SessionRules; queue: { model: QueueModel; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - lockedCrossed: LockedCrossedPolicy; default: not declared - partialFills: PartialFillPolicy; default: not declared - participation?: number; default: not declared — Fraction of the observation's volume (or size) one fill may take; omitted = no cap. - queue: { model: QueueModel; }; default: not declared - queue.model: QueueModel; default: not declared - sessions?: SessionRules; default: not declared - sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - sessions.halts?: readonly HaltWindow[]; default: not declared - sessions.priceLimits?: readonly PriceLimitWindow[]; default: not declared - staleQuotes: StaleQuotePolicy; default: not declared - staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. ### @insiderfinance/totalfinance/backtest/execution#FillDecision Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FillDecision = { outcome: 'filled'; quantity: number; pricePerUnit: number; /** Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … */ reference: string; /** Less than the requested quantity (participation, depth, size caps). */ partial: boolean; /** The fill price was clamped into a session price-limit band. */ clampedToPriceLimit?: boolean; /** Order-book fills: how many levels the quantity consumed. */ levelsConsumed?: number; } | { outcome: 'unfilled'; reason: UnfilledReason; detail?: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - detail?: string; default: not declared - levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - outcome: ('filled') | ('unfilled'); default: not declared - partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - pricePerUnit: number; default: not declared - quantity: number; default: not declared - reason: UnfilledReason; default: not declared - reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … ### @insiderfinance/totalfinance/backtest/execution#FillModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A fill model: pure, deterministic, and closed over the observation it declares. ```typescript /** A fill model: pure, deterministic, and closed over the observation it declares. */ export interface FillModel { readonly label: string; readonly version: string; readonly observation: MarketObservationKind; fill(request: FillRequest): FillDecision; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fill: (request: FillRequest) => FillDecision; default: not declared - fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - fill().return.detail?: string; default: not declared - fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - fill().return.outcome: ('filled') | ('unfilled'); default: not declared - fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - fill().return.pricePerUnit: number; default: not declared - fill().return.quantity: number; default: not declared - fill().return.reason: UnfilledReason; default: not declared - fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - fill(request): FillRequest; default: not declared - fill(request).context: FillContext; default: not declared - fill(request).observation: MarketObservation; default: not declared - fill(request).order: OrderIntent; default: not declared - label: string; default: not declared - observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#FillModelConformanceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FillModelConformanceResult { conformant: true; label: string; version: string; observation: MarketObservation['kind']; checks: string[]; fixturesRun: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - checks: string[]; default: not declared - conformant: true; default: not declared - fixturesRun: number; default: not declared - label: string; default: not declared - observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#FillModelFixture Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FillModelFixture { order: OrderIntent; observation: MarketObservation; context: FillContext; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - context: FillContext; default: not declared - context.asOf: number; default: not declared - context.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - context.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - context.participation?: number; default: not declared — Fraction of the observation's volume (or size) one fill may take; omitted = no cap. - context.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - context.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - context.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - context.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - context.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - context.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - context.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - context.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - context.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - observation: MarketObservation; default: not declared - observation.bar: import('@insiderfinance/totalfinance/core').Bar; default: not declared - observation.bar.adjusted?: boolean; default: not declared - observation.bar.close: number; default: not declared - observation.bar.high: number; default: not declared - observation.bar.low: number; default: not declared - observation.bar.open: number; default: not declared - observation.bar.symbol: string; default: not declared - observation.bar.timestampMs: number; default: not declared - observation.bar.volume?: number; default: not declared - observation.bar.vwap?: number; default: not declared - observation.book: import('@insiderfinance/totalfinance/core').OrderBook; default: not declared - observation.book.asks: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - observation.book.bids: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - observation.book.symbol: string; default: not declared - observation.book.timestampMs: number; default: not declared - observation.kind: ('bar') | ('order-book') | ('quote') | ('trade'); default: not declared - observation.quote: import('@insiderfinance/totalfinance/core').Quote; default: not declared - observation.quote.ask: number; default: not declared - observation.quote.askSize?: number; default: not declared - observation.quote.bid: number; default: not declared - observation.quote.bidSize?: number; default: not declared - observation.quote.conditions?: string[]; default: not declared - observation.quote.exchange?: string; default: not declared - observation.quote.symbol: string; default: not declared - observation.quote.timestampMs: number; default: not declared - observation.trade: import('@insiderfinance/totalfinance/core').Trade; default: not declared - observation.trade.conditions?: string[]; default: not declared - observation.trade.exchange?: string; default: not declared - observation.trade.price: number; default: not declared - observation.trade.sequence?: number; default: not declared - observation.trade.size: number; default: not declared - observation.trade.symbol: string; default: not declared - observation.trade.timestampMs: number; default: not declared - order: OrderIntent; default: not declared - order.instrumentId: string; default: not declared - order.limitPrice?: number; default: not declared - order.orderId: string; default: not declared - order.quantity: number; default: not declared — Requested quantity, > 0. - order.side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - order.stopPrice?: number; default: not declared - order.submittedTimestampMs: number; default: not declared - order.timeInForce?: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - order.type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/execution#FillOrderWithPolicyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FillOrderWithPolicyInput { policy: ExecutionPolicy; order: OrderIntent; observation: MarketObservation; /** The decision instant (the fill context's `asOf`). */ asOf: EpochMs; accountId: string; currency: string; fillId: string; /** The instant stamped on the fill; default `asOf` (an engine stamps its session close). */ filledTimestampMs?: EpochMs; /** The instrument's fill terms; a plain cash instrument omits them. */ terms?: { contractMultiplier?: number; settlementStyle?: SettlementStyle; contract?: DerivativeContractTerms; }; /** When the cash leg settles; omitted = at the fill. Ignored unless after `asOf`. */ settleTimestampMs?: EpochMs; /** Accrued interest per unit exchanged with a bond fill (0 = none). */ accruedPerUnit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - accruedPerUnit?: number; default: not declared — Accrued interest per unit exchanged with a bond fill (0 = none). - asOf: number; default: not declared — The decision instant (the fill context's `asOf`). - currency: string; default: not declared - fillId: string; default: not declared - filledTimestampMs?: number; default: not declared — The instant stamped on the fill; default `asOf` (an engine stamps its session close). - observation: MarketObservation; default: not declared - observation.bar: import('@insiderfinance/totalfinance/core').Bar; default: not declared - observation.bar.adjusted?: boolean; default: not declared - observation.bar.close: number; default: not declared - observation.bar.high: number; default: not declared - observation.bar.low: number; default: not declared - observation.bar.open: number; default: not declared - observation.bar.symbol: string; default: not declared - observation.bar.timestampMs: number; default: not declared - observation.bar.volume?: number; default: not declared - observation.bar.vwap?: number; default: not declared - observation.book: import('@insiderfinance/totalfinance/core').OrderBook; default: not declared - observation.book.asks: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - observation.book.bids: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - observation.book.symbol: string; default: not declared - observation.book.timestampMs: number; default: not declared - observation.kind: ('bar') | ('order-book') | ('quote') | ('trade'); default: not declared - observation.quote: import('@insiderfinance/totalfinance/core').Quote; default: not declared - observation.quote.ask: number; default: not declared - observation.quote.askSize?: number; default: not declared - observation.quote.bid: number; default: not declared - observation.quote.bidSize?: number; default: not declared - observation.quote.conditions?: string[]; default: not declared - observation.quote.exchange?: string; default: not declared - observation.quote.symbol: string; default: not declared - observation.quote.timestampMs: number; default: not declared - observation.trade: import('@insiderfinance/totalfinance/core').Trade; default: not declared - observation.trade.conditions?: string[]; default: not declared - observation.trade.exchange?: string; default: not declared - observation.trade.price: number; default: not declared - observation.trade.sequence?: number; default: not declared - observation.trade.size: number; default: not declared - observation.trade.symbol: string; default: not declared - observation.trade.timestampMs: number; default: not declared - order: OrderIntent; default: not declared - order.instrumentId: string; default: not declared - order.limitPrice?: number; default: not declared - order.orderId: string; default: not declared - order.quantity: number; default: not declared — Requested quantity, > 0. - order.side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - order.stopPrice?: number; default: not declared - order.submittedTimestampMs: number; default: not declared - order.timeInForce?: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - order.type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared - policy: ExecutionPolicy; default: not declared - policy.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - policy.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - policy.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - policy.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - policy.costs.borrow.label: string; default: not declared - policy.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - policy.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - policy.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - policy.costs.commission.commission(input).price: number; default: not declared - policy.costs.commission.commission(input).quantity: number; default: not declared - policy.costs.commission.label: string; default: not declared - policy.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - policy.costs.latency.label: string; default: not declared - policy.costs.latency.sessions: number; default: not declared - policy.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - policy.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - policy.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - policy.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - policy.costs.marketImpact.impact(input).quantity: number; default: not declared - policy.costs.marketImpact.impact(input).referencePrice: number; default: not declared - policy.costs.marketImpact.label: string; default: not declared - policy.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - policy.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - policy.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - policy.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - policy.costs.slippage.fill(input).quantity: number; default: not declared - policy.costs.slippage.fill(input).referencePrice: number; default: not declared - policy.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - policy.costs.slippage.label: string; default: not declared - policy.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - policy.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - policy.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - policy.costs.spread.halfSpread(input).referencePrice: number; default: not declared - policy.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - policy.costs.spread.label: string; default: not declared - policy.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - policy.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => FillDecision; default: not declared - policy.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - policy.fill.fill().return.detail?: string; default: not declared - policy.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - policy.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - policy.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - policy.fill.fill().return.pricePerUnit: number; default: not declared - policy.fill.fill().return.quantity: number; default: not declared - policy.fill.fill().return.reason: UnfilledReason; default: not declared - policy.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - policy.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - policy.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - policy.fill.fill(request).observation: MarketObservation; default: not declared - policy.fill.fill(request).order: OrderIntent; default: not declared - policy.fill.label: string; default: not declared - policy.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - policy.fill.version: string; default: not declared - policy.label: string; default: not declared — Echoed in every result's assumptions. - policy.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - policy.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - policy.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - policy.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - policy.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - policy.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - policy.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - policy.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - policy.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - policy.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - policy.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - policy.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - policy.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - policy.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - policy.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - policy.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - policy.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - policy.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - policy.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - policy.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - policy.timeInForce.expireAtSessionClose: boolean; default: not declared - settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = at the fill. Ignored unless after `asOf`. - terms?: { contract?: DerivativeContractTerms; contractMultiplier?: number; settlementStyle?: SettlementStyle; }; default: not declared — The instrument's fill terms; a plain cash instrument omits them. - terms.contract?: DerivativeContractTerms; default: not declared - terms.contract.expiryTimestampMs: number; default: not declared - terms.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - terms.contract.strikePricePerUnit: number; default: not declared - terms.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - terms.contract.underlyingInstrumentId: string; default: not declared - terms.contractMultiplier?: number; default: not declared - terms.settlementStyle?: SettlementStyle; default: not declared ### @insiderfinance/totalfinance/backtest/execution#FillOrderWithPolicyResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FillOrderWithPolicyResult = { outcome: 'filled'; fill: NormalizedFill; decision: Extract; /** The executed price after slippage, half-spread, and impact. */ price: number; commission: number; slippageAdjustment: number; } | { outcome: 'unfilled'; reason: UnfilledReason; detail: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: number; default: not declared - decision: { clampedToPriceLimit?: boolean; levelsConsumed?: number; outcome: 'filled'; partial: boolean; pricePerUnit: number; quantity: number; reference: string; }; default: not declared - decision.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - decision.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - decision.outcome: 'filled'; default: not declared - decision.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - decision.pricePerUnit: number; default: not declared - decision.quantity: number; default: not declared - decision.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - detail: string; default: not declared - fill: NormalizedFill; default: not declared - fill.accountId: string; default: not declared - fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - fill.contract?: DerivativeContractTerms; default: not declared - fill.contract.expiryTimestampMs: number; default: not declared - fill.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - fill.contract.strikePricePerUnit: number; default: not declared - fill.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - fill.contract.underlyingInstrumentId: string; default: not declared - fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - fill.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - fill.costs.commission?: number; default: not declared - fill.costs.exchangeFees?: number; default: not declared - fill.costs.regulatoryFees?: number; default: not declared - fill.costs.slippageAdjustment?: number; default: not declared - fill.currency: string; default: not declared - fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - fill.instrumentId: string; default: not declared - fill.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - fill.settlementStyle?: SettlementStyle; default: not declared - fill.side: 'buy' | 'sell'; default: not declared - fill.venue?: string; default: not declared - outcome: ('filled') | ('unfilled'); default: not declared - price: number; default: not declared — The executed price after slippage, half-spread, and impact. - reason: UnfilledReason; default: not declared - slippageAdjustment: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#FillRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a fill model decides on: one order, one observation, the decision context. ```typescript /** What a fill model decides on: one order, one observation, the decision context. */ export interface FillRequest { order: OrderIntent; observation: MarketObservation; context: FillContext; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - context: FillContext; default: not declared - context.asOf: number; default: not declared - context.lockedCrossed: LockedCrossedPolicy; default: not declared - context.partialFills: PartialFillPolicy; default: not declared - context.participation?: number; default: not declared — Fraction of the observation's volume (or size) one fill may take; omitted = no cap. - context.queue: { model: QueueModel; }; default: not declared - context.queue.model: QueueModel; default: not declared - context.sessions?: SessionRules; default: not declared - context.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - context.sessions.halts?: readonly HaltWindow[]; default: not declared - context.sessions.priceLimits?: readonly PriceLimitWindow[]; default: not declared - context.staleQuotes: StaleQuotePolicy; default: not declared - context.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - context.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - observation: MarketObservation; default: not declared - observation.bar: Bar; default: not declared - observation.bar.adjusted?: boolean; default: not declared - observation.bar.close: number; default: not declared - observation.bar.high: number; default: not declared - observation.bar.low: number; default: not declared - observation.bar.open: number; default: not declared - observation.bar.symbol: string; default: not declared - observation.bar.timestampMs: number; default: not declared - observation.bar.volume?: number; default: not declared - observation.bar.vwap?: number; default: not declared - observation.book: OrderBook; default: not declared - observation.book.asks: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - observation.book.bids: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - observation.book.symbol: string; default: not declared - observation.book.timestampMs: number; default: not declared - observation.kind: ('bar') | ('order-book') | ('quote') | ('trade'); default: not declared - observation.quote: Quote; default: not declared - observation.quote.ask: number; default: not declared - observation.quote.askSize?: number; default: not declared - observation.quote.bid: number; default: not declared - observation.quote.bidSize?: number; default: not declared - observation.quote.conditions?: string[]; default: not declared - observation.quote.exchange?: string; default: not declared - observation.quote.symbol: string; default: not declared - observation.quote.timestampMs: number; default: not declared - observation.trade: Trade; default: not declared - observation.trade.conditions?: string[]; default: not declared - observation.trade.exchange?: string; default: not declared - observation.trade.price: number; default: not declared - observation.trade.sequence?: number; default: not declared - observation.trade.size: number; default: not declared - observation.trade.symbol: string; default: not declared - observation.trade.timestampMs: number; default: not declared - order: OrderIntent; default: not declared - order.instrumentId: string; default: not declared - order.limitPrice?: number; default: not declared - order.orderId: string; default: not declared - order.quantity: number; default: not declared — Requested quantity, > 0. - order.side: OrderSide; default: not declared - order.stopPrice?: number; default: not declared - order.submittedTimestampMs: number; default: not declared - order.timeInForce?: TimeInForce; default: not declared - order.type: OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/execution#ForcedLiquidationPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ForcedLiquidationPolicy = 'none' | 'close-largest-loss' | 'pro-rata'; ``` ### @insiderfinance/totalfinance/backtest/execution#HaltWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). No fills for the instrument (or every instrument when `instrumentId` is omitted) in the window. ```typescript // --------------------------------------------------------------------------------------------------- // Sessions // --------------------------------------------------------------------------------------------------- /** No fills for the instrument (or every instrument when `instrumentId` is omitted) in the window. */ export interface HaltWindow { instrumentId?: string; fromTimestampMs: EpochMs; toTimestampMs: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromTimestampMs: number; default: not declared - instrumentId?: string; default: not declared - toTimestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#IntrabarPath Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type IntrabarPath = 'open-low-high-close' | 'open-high-low-close' | 'unambiguous'; ``` ### @insiderfinance/totalfinance/backtest/execution#IntrabarTouch Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One order that touched inside the bar. ```typescript /** One order that touched inside the bar. */ export interface IntrabarTouch { orderId: string; /** The price at which the order would fill. */ triggerPrice: number; /** Whether filling this order first is the favorable sequence for the account (a take-profit). */ favorable: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - favorable: boolean; default: not declared — Whether filling this order first is the favorable sequence for the account (a take-profit). - orderId: string; default: not declared - triggerPrice: number; default: not declared — The price at which the order would fill. ### @insiderfinance/totalfinance/backtest/execution#LatencyModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The order is worked `sessions` observations after submission (0 = the same observation). ```typescript /** The order is worked `sessions` observations after submission (0 = the same observation). */ export interface LatencyModel { readonly label: string; readonly sessions: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - label: string; default: not declared - sessions: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#LockedCrossedPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type LockedCrossedPolicy = 'reject' | 'fill-at-mid'; ``` ### @insiderfinance/totalfinance/backtest/execution#MarginPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarginPolicy { /** Gross notional an account may hold per unit of equity (1 = cash account). */ buyingPowerMultiplier: number; /** Fraction of a new position's notional that must be equity at entry. */ initialMarginRate: number; /** Fraction of gross notional that must remain equity after every fold. */ maintenanceMarginRate: number; forcedLiquidation: ForcedLiquidationPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - forcedLiquidation: ForcedLiquidationPolicy; default: not declared - initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. ### @insiderfinance/totalfinance/backtest/execution#MarketImpactModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price impact of a quantity as a FRACTION of the reference price (≥ 0), by side. ```typescript /** Price impact of a quantity as a FRACTION of the reference price (≥ 0), by side. */ export interface MarketImpactModel { readonly label: string; impact(input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - impact(input).averageDailyVolume?: number; default: not declared - impact(input).quantity: number; default: not declared - impact(input).referencePrice: number; default: not declared - label: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#MarketObservation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a fill model observes at the decision instant. ```typescript /** What a fill model observes at the decision instant. */ export type MarketObservation = { kind: 'bar'; bar: Bar; } | { kind: 'quote'; quote: Quote; } | { kind: 'trade'; trade: Trade; } | { kind: 'order-book'; book: OrderBook; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar: Bar; default: not declared - bar.adjusted?: boolean; default: not declared - bar.close: number; default: not declared - bar.high: number; default: not declared - bar.low: number; default: not declared - bar.open: number; default: not declared - bar.symbol: string; default: not declared - bar.timestampMs: number; default: not declared - bar.volume?: number; default: not declared - bar.vwap?: number; default: not declared - book: OrderBook; default: not declared - book.asks: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - book.bids: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - book.symbol: string; default: not declared - book.timestampMs: number; default: not declared - kind: ('bar') | ('order-book') | ('quote') | ('trade'); default: not declared - quote: Quote; default: not declared - quote.ask: number; default: not declared - quote.askSize?: number; default: not declared - quote.bid: number; default: not declared - quote.bidSize?: number; default: not declared - quote.conditions?: string[]; default: not declared - quote.exchange?: string; default: not declared - quote.symbol: string; default: not declared - quote.timestampMs: number; default: not declared - trade: Trade; default: not declared - trade.conditions?: string[]; default: not declared - trade.exchange?: string; default: not declared - trade.price: number; default: not declared - trade.sequence?: number; default: not declared - trade.size: number; default: not declared - trade.symbol: string; default: not declared - trade.timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#MarketObservationKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MarketObservationKind = MarketObservation['kind']; ``` ### @insiderfinance/totalfinance/backtest/execution#NormalizedFillFromDecisionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface NormalizedFillFromDecisionInput { decision: FillDecision; order: OrderIntent; accountId: string; currency: string; filledTimestampMs: EpochMs; /** Defaults to `:fill`; a partial fill sequence should number its fills. */ fillId?: string; costs?: NormalizedFill['costs']; /** Attribution already included in the execution price, not an additional cash charge. */ executionPriceAdjustment?: NormalizedFill['executionPriceAdjustment']; settleTimestampMs?: EpochMs; contractMultiplier?: number; settlementStyle?: NormalizedFill['settlementStyle']; contract?: NormalizedFill['contract']; accruedInterest?: number; venue?: string; liquidity?: NormalizedFill['liquidity']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - accruedInterest?: number; default: not declared - contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms | undefined; default: not declared - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared - costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts | undefined; default: not declared - costs.commission?: number; default: not declared - costs.exchangeFees?: number; default: not declared - costs.regulatoryFees?: number; default: not declared - costs.slippageAdjustment?: number; default: not declared - currency: string; default: not declared - decision: FillDecision; default: not declared - decision.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - decision.detail?: string; default: not declared - decision.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - decision.outcome: ('filled') | ('unfilled'); default: not declared - decision.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - decision.pricePerUnit: number; default: not declared - decision.quantity: number; default: not declared - decision.reason: import('@insiderfinance/totalfinance/backtest/execution').UnfilledReason; default: not declared - decision.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - executionPriceAdjustment?: number | undefined; default: not declared — Attribution already included in the execution price, not an additional cash charge. - fillId?: string; default: not declared — Defaults to `:fill`; a partial fill sequence should number its fills. - filledTimestampMs: number; default: not declared - liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity | undefined; default: not declared - order: OrderIntent; default: not declared - order.instrumentId: string; default: not declared - order.limitPrice?: number; default: not declared - order.orderId: string; default: not declared - order.quantity: number; default: not declared — Requested quantity, > 0. - order.side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - order.stopPrice?: number; default: not declared - order.submittedTimestampMs: number; default: not declared - order.timeInForce?: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - order.type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared - settleTimestampMs?: number; default: not declared - settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle | undefined; default: not declared - venue?: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#NormalizedFillsFromBacktestInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link normalizedFillsFromBacktest}: the trades a backtest reported, and the account they book to. ```typescript /** Input for {@link normalizedFillsFromBacktest}: the trades a backtest reported, and the account they book to. */ export interface NormalizedFillsFromBacktestInput { /** The run's trades (`result.trades`), in order. */ trades: readonly Trade[]; accountId: string; /** The currency every fill books in (a backtest quotes one currency). */ currency: string; /** Fill ids default to `:fill:`; the source names the run. */ sourceId: string; /** Instrument terms by symbol (an option's contract, its settlement style) for fills that need them. */ instruments?: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - currency: string; default: not declared — The currency every fill books in (a backtest quotes one currency). - instruments?: Readonly>; default: not declared — Instrument terms by symbol (an option's contract, its settlement style) for fills that need them. - sourceId: string; default: not declared — Fill ids default to `:fill:`; the source names the run. - trades: readonly Trade[]; default: not declared — The run's trades (`result.trades`), in order. ### @insiderfinance/totalfinance/backtest/execution#OrderIntent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One order a simulator wants filled — the intent, not the journey. ```typescript /** One order a simulator wants filled — the intent, not the journey. */ export interface OrderIntent { orderId: string; instrumentId: string; side: OrderSide; /** Requested quantity, > 0. */ quantity: number; type: OrderType; limitPrice?: number; stopPrice?: number; timeInForce?: TimeInForce; submittedTimestampMs: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - limitPrice?: number; default: not declared - orderId: string; default: not declared - quantity: number; default: not declared — Requested quantity, > 0. - side: OrderSide; default: not declared - stopPrice?: number; default: not declared - submittedTimestampMs: number; default: not declared - timeInForce?: TimeInForce; default: not declared - type: OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/execution#OrderSide Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderSide`. ### @insiderfinance/totalfinance/backtest/execution#OrderTouchSequenceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OrderTouchSequenceInput { bar: { open: number; high: number; low: number; close: number; }; touches: readonly IntrabarTouch[]; policy: AmbiguityPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar: { close: number; high: number; low: number; open: number; }; default: not declared - bar.close: number; default: not declared - bar.high: number; default: not declared - bar.low: number; default: not declared - bar.open: number; default: not declared - policy: AmbiguityPolicy; default: not declared - touches: readonly IntrabarTouch[]; default: not declared ### @insiderfinance/totalfinance/backtest/execution#OrderTouchSequenceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OrderTouchSequenceResult { /** Order ids in fill sequence. */ sequence: string[]; /** The path the sequence assumes; `unambiguous` when every touch lay on one side of the open. */ path: IntrabarPath; /** Whether the bar alone could not decide the sequence (the policy did). */ ambiguous: boolean; policy: AmbiguityPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ambiguous: boolean; default: not declared — Whether the bar alone could not decide the sequence (the policy did). - path: IntrabarPath; default: not declared — The path the sequence assumes; `unambiguous` when every touch lay on one side of the open. - policy: AmbiguityPolicy; default: not declared - sequence: string[]; default: not declared — Order ids in fill sequence. ### @insiderfinance/totalfinance/backtest/execution#OrderType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderType`. ### @insiderfinance/totalfinance/backtest/execution#PartialFillPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PartialFillPolicy = 'allow' | 'reject'; ``` ### @insiderfinance/totalfinance/backtest/execution#PriceLimitWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fills for the instrument are clamped into `[low, high]` in the window (limit-up / limit-down). ```typescript /** Fills for the instrument are clamped into `[low, high]` in the window (limit-up / limit-down). */ export interface PriceLimitWindow { instrumentId: string; fromTimestampMs: EpochMs; toTimestampMs: EpochMs; low: number; high: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromTimestampMs: number; default: not declared - high: number; default: not declared - instrumentId: string; default: not declared - low: number; default: not declared - toTimestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#QueueModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type QueueModel = 'none' | 'depth-approximation'; ``` ### @insiderfinance/totalfinance/backtest/execution#SessionRules Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SessionRules { halts?: readonly HaltWindow[]; priceLimits?: readonly PriceLimitWindow[]; /** How auction-only order types are treated by a model that has no auction: declared, never assumed. */ auction?: 'ignore' | 'open-close-only'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - halts?: readonly HaltWindow[]; default: not declared - priceLimits?: readonly PriceLimitWindow[]; default: not declared ### @insiderfinance/totalfinance/backtest/execution#SpreadModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Half-spread paid by an aggressor, as a price adjustment per unit (≥ 0). ```typescript /** Half-spread paid by an aggressor, as a price adjustment per unit (≥ 0). */ export interface SpreadModel { readonly label: string; halfSpread(input: { referencePrice: number; side: OrderSide; }): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - halfSpread(input): { referencePrice: number; side: OrderSide; }; default: not declared - halfSpread(input).referencePrice: number; default: not declared - halfSpread(input).side: OrderSide; default: not declared - label: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#StaleQuotePolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Models // --------------------------------------------------------------------------------------------------- export interface StaleQuotePolicy { /** A quote older than this at the decision instant is stale; `null` = never stale. */ maximumAgeMs: number | null; /** `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. */ behavior: 'reject' | 'fill-at-last'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. ### @insiderfinance/totalfinance/backtest/execution#TimeInForce Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TimeInForce`. ### @insiderfinance/totalfinance/backtest/execution#UnfilledReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Decisions // --------------------------------------------------------------------------------------------------- export type UnfilledReason = 'not-triggered' | 'no-observation' | 'wrong-observation-kind' | 'stale-quote' | 'locked-crossed' | 'halted' | 'zero-quantity' | 'insufficient-depth'; ``` ### @insiderfinance/totalfinance/backtest/execution#assertFillModelConformance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run the conformance suite over the built-in fixtures for the model's observation kind and any caller fixtures. Returns the checks that passed; throws `backtest.adapter_nonconformant` on the first failure, naming the check. ```typescript export declare function assertFillModelConformance(input: AssertFillModelConformanceInput): FillModelConformanceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AssertFillModelConformanceInput; default: not declared - (input).fillModel: FillModel; default: not declared - (input).fixtures?: readonly FillModelFixture[]; default: not declared — Caller fixtures run beside the built-in ones for the model's observation kind. - return.checks: string[]; default: not declared - return.conformant: true; default: not declared - return.fixturesRun: number; default: not declared - return.label: string; default: not declared - return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#barTriggerPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Where a bar fills an order, or `null` when the bar never touched it. Market and market-on-open fill at the open; market-on-close at the close; a limit fills at the open when the open is already through it, else at the limit when the range reached it; a stop triggers on the range and fills at the worse of the open and the stop (a gap through the stop fills at the open); a stop-limit becomes a limit at the stop instant, so its effective open is the stop unless the bar gapped through it. ```typescript export declare function barTriggerPrice(input: { order: OrderIntent; bar: { open: number; high: number; low: number; close: number; }; }): { price: number; reference: string; } | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { order: OrderIntent; bar: { open: number; high: number; low: number; close: number; }; }; default: not declared - (input).bar: { open: number; high: number; low: number; close: number; }; default: not declared - (input).bar.close: number; default: not declared - (input).bar.high: number; default: not declared - (input).bar.low: number; default: not declared - (input).bar.open: number; default: not declared - (input).order: OrderIntent; default: not declared - return.price: number; default: not declared - return.reference: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#borrow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#borrow`. ### @insiderfinance/totalfinance/backtest/execution#describeExecutionPolicy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The JSON-safe projection of a policy every result carries under `assumptions.execution`. ```typescript export declare function describeExecutionPolicy(policy: ExecutionPolicy): ExecutionPolicyDescription; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (policy): ExecutionPolicy; default: not declared - (policy).ambiguity: AmbiguityPolicy; default: not declared - (policy).costs: ExecutionCosts; default: not declared - (policy).fill: FillModel; default: not declared - (policy).label: string; default: not declared — Echoed in every result's assumptions. - (policy).lockedCrossed: LockedCrossedPolicy; default: not declared - (policy).margin: MarginPolicy; default: not declared - (policy).observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - (policy).partialFills: PartialFillPolicy; default: not declared - (policy).queue: { model: QueueModel; }; default: not declared - (policy).queue.model: QueueModel; default: not declared - (policy).realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - (policy).sessions?: SessionRules; default: not declared - (policy).staleQuotes: StaleQuotePolicy; default: not declared - (policy).timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - (policy).timeInForce.default: TimeInForce; default: not declared - (policy).timeInForce.expireAtSessionClose: boolean; default: not declared - return.ambiguity: AmbiguityPolicy; default: not declared - return.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - return.costs.borrow: string | null; default: not declared - return.costs.commission: string; default: not declared - return.costs.latencySessions: number | null; default: not declared - return.costs.marketImpact: string | null; default: not declared - return.costs.participation: number | null; default: not declared - return.costs.slippage: string; default: not declared - return.costs.spread: string | null; default: not declared - return.fill: { label: string; version: string; }; default: not declared - return.fill.label: string; default: not declared - return.fill.version: string; default: not declared - return.label: string; default: not declared - return.lockedCrossed: LockedCrossedPolicy; default: not declared - return.margin: MarginPolicy; default: not declared - return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - return.partialFills: PartialFillPolicy; default: not declared - return.queue: QueueModel; default: not declared - return.realism: 'simplified' | 'declared'; default: not declared - return.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - return.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - return.sessions.halts: number; default: not declared - return.sessions.priceLimits: number; default: not declared - return.staleQuotes: StaleQuotePolicy; default: not declared - return.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - return.timeInForce.default: TimeInForce; default: not declared - return.timeInForce.expireAtSessionClose: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/execution#execution Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The execution policies a run may declare. ```typescript export declare const execution: Readonly<{ simplified(): ExecutionPolicy; declared(input: DeclaredExecutionPolicy): ExecutionPolicy; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - declared: (input: DeclaredExecutionPolicy) => ExecutionPolicy; default: not declared — A declared policy: the members given override the simplified ones; the label is required and is the caller's claim about what the run assumes. Every member present is validated — the whole assembled policy passes `requireExecutionPolicy` before it is returned. - declared().return.ambiguity: AmbiguityPolicy; default: not declared - declared().return.costs: ExecutionCosts; default: not declared - declared().return.fill: FillModel; default: not declared - declared().return.label: string; default: not declared — Echoed in every result's assumptions. - declared().return.lockedCrossed: LockedCrossedPolicy; default: not declared - declared().return.margin: MarginPolicy; default: not declared - declared().return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - declared().return.partialFills: PartialFillPolicy; default: not declared - declared().return.queue: { model: QueueModel; }; default: not declared - declared().return.queue.model: QueueModel; default: not declared - declared().return.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - declared().return.sessions?: SessionRules; default: not declared - declared().return.staleQuotes: StaleQuotePolicy; default: not declared - declared().return.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - declared().return.timeInForce.default: TimeInForce; default: not declared - declared().return.timeInForce.expireAtSessionClose: boolean; default: not declared - declared(input): DeclaredExecutionPolicy; default: not declared - declared(input).ambiguity?: AmbiguityPolicy; default: not declared - declared(input).costs?: Partial; default: not declared - declared(input).costs.borrow?: BorrowModel; default: not declared - declared(input).costs.commission?: CostModel; default: not declared - declared(input).costs.latency?: LatencyModel; default: not declared - declared(input).costs.marketImpact?: MarketImpactModel; default: not declared - declared(input).costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - declared(input).costs.slippage?: SlippageModel; default: not declared - declared(input).costs.spread?: SpreadModel; default: not declared - declared(input).fill?: FillModel; default: not declared - declared(input).label: string; default: not declared - declared(input).lockedCrossed?: LockedCrossedPolicy; default: not declared - declared(input).margin?: MarginPolicy; default: not declared - declared(input).observation?: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - declared(input).partialFills?: PartialFillPolicy; default: not declared - declared(input).queue?: { model: QueueModel; }; default: not declared - declared(input).queue.model: QueueModel; default: not declared - declared(input).sessions?: SessionRules; default: not declared - declared(input).staleQuotes?: StaleQuotePolicy; default: not declared - declared(input).timeInForce?: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - declared(input).timeInForce.default: TimeInForce; default: not declared - declared(input).timeInForce.expireAtSessionClose: boolean; default: not declared - simplified: () => ExecutionPolicy; default: not declared — The honest default: every member named in the label, `realism: 'simplified'`. - simplified().return.ambiguity: AmbiguityPolicy; default: not declared - simplified().return.costs: ExecutionCosts; default: not declared - simplified().return.fill: FillModel; default: not declared - simplified().return.label: string; default: not declared — Echoed in every result's assumptions. - simplified().return.lockedCrossed: LockedCrossedPolicy; default: not declared - simplified().return.margin: MarginPolicy; default: not declared - simplified().return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - simplified().return.partialFills: PartialFillPolicy; default: not declared - simplified().return.queue: { model: QueueModel; }; default: not declared - simplified().return.queue.model: QueueModel; default: not declared - simplified().return.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - simplified().return.sessions?: SessionRules; default: not declared - simplified().return.staleQuotes: StaleQuotePolicy; default: not declared - simplified().return.timeInForce: { default: TimeInForce; expireAtSessionClose: boolean; }; default: not declared - simplified().return.timeInForce.default: TimeInForce; default: not declared - simplified().return.timeInForce.expireAtSessionClose: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/execution#fees Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#fees`. ### @insiderfinance/totalfinance/backtest/execution#fillModels Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The built-in fill models, one per observation kind. Each factory returns the frozen singleton. ```typescript export declare const fillModels: Readonly<{ bar: () => FillModel; quote: () => FillModel; orderBook: () => FillModel; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar: () => FillModel; default: not declared - bar().return.fill: (request: FillRequest) => FillDecision; default: not declared - bar().return.label: string; default: not declared - bar().return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - bar().return.version: string; default: not declared - orderBook: () => FillModel; default: not declared - orderBook().return.fill: (request: FillRequest) => FillDecision; default: not declared - orderBook().return.label: string; default: not declared - orderBook().return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - orderBook().return.version: string; default: not declared - quote: () => FillModel; default: not declared - quote().return.fill: (request: FillRequest) => FillDecision; default: not declared - quote().return.label: string; default: not declared - quote().return.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - quote().return.version: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#fillOrderWithPolicy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Meet one order with one observation through the policy: the fill model decides; a filled decision pays slippage, the half-spread, and impact on the price, commission on the notional, and becomes a `NormalizedFill` (the ledger's own grammar) with its costs and terms; an unfilled decision returns the model's reason. The arithmetic is the engine's, verbatim — the goldens prove it. ```typescript export declare function fillOrderWithPolicy(input: FillOrderWithPolicyInput): FillOrderWithPolicyResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FillOrderWithPolicyInput; default: not declared - (input).accountId: string; default: not declared - (input).accruedPerUnit?: number; default: not declared — Accrued interest per unit exchanged with a bond fill (0 = none). - (input).asOf: number; default: not declared — The decision instant (the fill context's `asOf`). - (input).currency: string; default: not declared - (input).fillId: string; default: not declared - (input).filledTimestampMs?: number; default: not declared — The instant stamped on the fill; default `asOf` (an engine stamps its session close). - (input).observation: MarketObservation; default: not declared - (input).order: OrderIntent; default: not declared - (input).policy: ExecutionPolicy; default: not declared - (input).settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = at the fill. Ignored unless after `asOf`. - (input).terms?: { contractMultiplier?: number; settlementStyle?: SettlementStyle; contract?: DerivativeContractTerms; }; default: not declared — The instrument's fill terms; a plain cash instrument omits them. - (input).terms.contract?: DerivativeContractTerms; default: not declared - (input).terms.contractMultiplier?: number; default: not declared - (input).terms.settlementStyle?: SettlementStyle; default: not declared - return.commission: number; default: not declared - return.decision: { clampedToPriceLimit?: boolean; levelsConsumed?: number; outcome: 'filled'; partial: boolean; pricePerUnit: number; quantity: number; reference: string; }; default: not declared - return.decision.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - return.decision.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - return.decision.outcome: 'filled'; default: not declared - return.decision.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - return.decision.pricePerUnit: number; default: not declared - return.decision.quantity: number; default: not declared - return.decision.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - return.detail: string; default: not declared - return.fill: NormalizedFill; default: not declared - return.outcome: ('filled') | ('unfilled'); default: not declared - return.price: number; default: not declared — The executed price after slippage, half-spread, and impact. - return.reason: UnfilledReason; default: not declared - return.slippageAdjustment: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#impactModels Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market-impact models: the fraction of the reference price a quantity moves against itself. ```typescript export declare const impactModels: Readonly<{ squareRoot(input: { coefficient: number; }): MarketImpactModel; none(): MarketImpactModel; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - none: () => MarketImpactModel; default: not declared - none().return.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - none().return.label: string; default: not declared - squareRoot: (input: { coefficient: number; }) => MarketImpactModel; default: not declared — The square-root law: impact = coefficient × √(quantity / averageDailyVolume). A fill with no average daily volume in context has no impact and says so through the label the engine echoes. - squareRoot().return.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - squareRoot().return.label: string; default: not declared - squareRoot(input): { coefficient: number; }; default: not declared - squareRoot(input).coefficient: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#latencyModels Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Latency models: how many observations after submission an order is first worked. ```typescript export declare const latencyModels: Readonly<{ sessions(sessions: number): LatencyModel; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sessions: (sessions: number) => LatencyModel; default: not declared - sessions().return.label: string; default: not declared - sessions().return.sessions: number; default: not declared - sessions(sessions): number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#maintenanceMarginBreached Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether equity has fallen below the maintenance requirement on the gross notional held. ```typescript export declare function maintenanceMarginBreached(input: { equity: number; grossNotional: number; policy: MarginPolicy; }): { breached: boolean; requiredEquity: number; shortfall: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { equity: number; grossNotional: number; policy: MarginPolicy; }; default: not declared - (input).equity: number; default: not declared - (input).grossNotional: number; default: not declared - (input).policy: MarginPolicy; default: not declared - return.breached: boolean; default: not declared - return.requiredEquity: number; default: not declared - return.shortfall: number; default: not declared ### @insiderfinance/totalfinance/backtest/execution#normalizedFillFromDecision Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the portfolio-owned fill for a filled decision; an unfilled decision is a teaching refusal. ```typescript export declare function normalizedFillFromDecision(input: NormalizedFillFromDecisionInput): NormalizedFill; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NormalizedFillFromDecisionInput; default: not declared - (input).accountId: string; default: not declared - (input).accruedInterest?: number; default: not declared - (input).contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms | undefined; default: not declared - (input).contract.expiryTimestampMs: number; default: not declared - (input).contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - (input).contract.strikePricePerUnit: number; default: not declared - (input).contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - (input).contract.underlyingInstrumentId: string; default: not declared - (input).contractMultiplier?: number; default: not declared - (input).costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts | undefined; default: not declared - (input).costs.commission?: number; default: not declared - (input).costs.exchangeFees?: number; default: not declared - (input).costs.regulatoryFees?: number; default: not declared - (input).costs.slippageAdjustment?: number; default: not declared - (input).currency: string; default: not declared - (input).decision: FillDecision; default: not declared - (input).executionPriceAdjustment?: number | undefined; default: not declared — Attribution already included in the execution price, not an additional cash charge. - (input).fillId?: string; default: not declared — Defaults to `:fill`; a partial fill sequence should number its fills. - (input).filledTimestampMs: number; default: not declared - (input).liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity | undefined; default: not declared - (input).order: OrderIntent; default: not declared - (input).settleTimestampMs?: number; default: not declared - (input).settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle | undefined; default: not declared - (input).venue?: string; default: not declared - return.accountId: string; default: not declared - return.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - return.contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms; default: not declared - return.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - return.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - return.currency: string; default: not declared - return.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - return.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - return.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - return.instrumentId: string; default: not declared - return.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - return.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - return.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - return.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - return.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - return.settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared - return.side: 'buy' | 'sell'; default: not declared - return.venue?: string; default: not declared ### @insiderfinance/totalfinance/backtest/execution#normalizedFillsFromBacktest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). B6 — the bridge from a backtest's trades to the ledger's fills: one `NormalizedFill` per trade, keyed by `instrumentId = symbol`, the contract multiplier the engine stamped, commission and commission as a cash cost. Slippage is already in trade.price; trade.slippage is attribution, not another cash charge. Every fill is validated by the ledger's own guard, so a run's trades fold through `portfolioEventsFromFill` exactly like a paper broker's. ```typescript export declare function normalizedFillsFromBacktest(input: NormalizedFillsFromBacktestInput): NormalizedFill[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NormalizedFillsFromBacktestInput; default: not declared - (input).accountId: string; default: not declared - (input).currency: string; default: not declared — The currency every fill books in (a backtest quotes one currency). - (input).instruments?: Readonly>; default: not declared — Instrument terms by symbol (an option's contract, its settlement style) for fills that need them. - (input).sourceId: string; default: not declared — Fill ids default to `:fill:`; the source names the run. - (input).trades: readonly Trade[]; default: not declared — The run's trades (`result.trades`), in order. ### @insiderfinance/totalfinance/backtest/execution#orderTouchSequence Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve the fill sequence of the orders a bar touched. Touches on one side of the open are never ambiguous (nearer the open fills first). Touches on both sides are: `deterministic-path` walks open → low → high → close on an up bar (close ≥ open) and open → high → low → close on a down bar; `optimistic` walks the side holding a favorable touch first (and the deterministic path when both sides do); `pessimistic` the reverse; `reject` refuses with `backtest.ambiguous_intrabar` naming the orders. ```typescript export declare function orderTouchSequence(input: OrderTouchSequenceInput): OrderTouchSequenceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OrderTouchSequenceInput; default: not declared - (input).bar: { open: number; high: number; low: number; close: number; }; default: not declared - (input).bar.close: number; default: not declared - (input).bar.high: number; default: not declared - (input).bar.low: number; default: not declared - (input).bar.open: number; default: not declared - (input).policy: AmbiguityPolicy; default: not declared - (input).touches: readonly IntrabarTouch[]; default: not declared - return.ambiguous: boolean; default: not declared — Whether the bar alone could not decide the sequence (the policy did). - return.path: IntrabarPath; default: not declared — The path the sequence assumes; `unambiguous` when every touch lay on one side of the open. - return.policy: AmbiguityPolicy; default: not declared - return.sequence: string[]; default: not declared — Order ids in fill sequence. ### @insiderfinance/totalfinance/backtest/execution#requireExecutionPolicy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a whole {@link ExecutionPolicy} — what `execution.declared` builds and every engine echoes. ```typescript export declare function requireExecutionPolicy(functionName: string, label: string, value: unknown): asserts value is ExecutionPolicy; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/execution#requireFillContext Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link FillContext}. ```typescript export declare function requireFillContext(functionName: string, label: string, value: unknown): asserts value is FillContext; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/execution#requireFillDecision Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link FillDecision}: the closed `filled | unfilled` union. ```typescript export declare function requireFillDecision(functionName: string, label: string, value: unknown): asserts value is FillDecision; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/execution#requireMarginPolicy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link MarginPolicy}: rates in [0, 1], maintenance ≤ initial, a buying power ≥ 1. ```typescript export declare function requireMarginPolicy(functionName: string, label: string, value: unknown): asserts value is MarginPolicy; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/execution#requireMarketObservation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link MarketObservation}: the closed union over bar, quote, trade, and order book. ```typescript export declare function requireMarketObservation(functionName: string, label: string, value: unknown): asserts value is MarketObservation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/execution#requireOrderIntent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate an {@link OrderIntent}: a closed record whose prices match its order type. ```typescript export declare function requireOrderIntent(functionName: string, label: string, value: unknown): asserts value is OrderIntent; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/backtest/execution#requiredInitialMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equity a new position of `notional` requires at entry under the policy. ```typescript export declare function requiredInitialMargin(input: { notional: number; policy: MarginPolicy; }): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { notional: number; policy: MarginPolicy; }; default: not declared - (input).notional: number; default: not declared - (input).policy: MarginPolicy; default: not declared ### @insiderfinance/totalfinance/backtest/execution#slippage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#slippage`. ### @insiderfinance/totalfinance/backtest/execution#spreadModels Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Spread models: an aggressor pays half the quoted spread on top of the reference price. ```typescript export declare const spreadModels: Readonly<{ halfSpreadBps(bps: number): SpreadModel; none(): SpreadModel; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - halfSpreadBps: (bps: number) => SpreadModel; default: not declared — A constant half-spread in basis points of the reference price. - halfSpreadBps().return.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - halfSpreadBps().return.label: string; default: not declared - halfSpreadBps(bps): number; default: not declared - none: () => SpreadModel; default: not declared - none().return.halfSpread: (input: { referencePrice: number; side: OrderSide; }) => number; default: not declared - none().return.label: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/backtest/options ### @insiderfinance/totalfinance/backtest/options#AppliedMarkingPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The applied marking policy, echoed in the assumptions. ```typescript /** The applied marking policy, echoed in the assumptions. */ export interface AppliedMarkingPolicy { volatility: 'current-quote' | 'entry'; missingMark: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; maximumQuoteAgeMs: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumQuoteAgeMs: number | null; default: not declared - missingMark: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared - volatility: 'current-quote' | 'entry'; default: not declared ### @insiderfinance/totalfinance/backtest/options#BookPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How many trades the book may hold (Stage 4.6). ```typescript /** How many trades the book may hold (Stage 4.6). */ export interface BookPolicy { /** Open trades at once (default 1 — the shipped single-position behaviour; at most 10,000). */ maximumOpenPositions?: number; /** Open trades per underlying (default: no bound). */ maximumPerUnderlying?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumOpenPositions?: number; default: not declared — Open trades at once (default 1 — the shipped single-position behaviour; at most 10,000). - maximumPerUnderlying?: number; default: not declared — Open trades per underlying (default: no bound). ### @insiderfinance/totalfinance/backtest/options#ChainSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One dated option chain: every listed quote at a single point in time (the backtest's tick). ```typescript /** One dated option chain: every listed quote at a single point in time (the backtest's tick). */ export interface ChainSnapshot { /** * Snapshot instant — epoch ms or a zoned ISO datetime. A bare `'YYYY-MM-DD'` is refused: the * time of day prices the chain. An end-of-day chain is observed at the close — * `usEquitySessionInstant(date, 'close')` from `@insiderfinance/totalfinance/core`. */ asOf: EpochMs | string; /** Underlying spot at this snapshot (the mark for pricing and delta-hedging). */ underlyingPrice: number; /** * Every listed contract's quote. Delta-based strike selection reads `greeks.delta` per quote (stamp * it with `@insiderfinance/totalfinance/options` `chainGreeks` if your source lacks it); other selections do not need it. */ quotes: OptionQuote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot instant — epoch ms or a zoned ISO datetime. A bare `'YYYY-MM-DD'` is refused: the time of day prices the chain. An end-of-day chain is observed at the close — `usEquitySessionInstant(date, 'close')` from `@insiderfinance/totalfinance/core`. - quotes: OptionQuote[]; default: not declared — Every listed contract's quote. Delta-based strike selection reads `greeks.delta` per quote (stamp it with `@insiderfinance/totalfinance/options` `chainGreeks` if your source lacks it); other selections do not need it. - underlyingPrice: number; default: not declared — Underlying spot at this snapshot (the mark for pricing and delta-hedging). ### @insiderfinance/totalfinance/backtest/options#DaysToExpiryTarget Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Which listed expiry to trade: the one whose days-to-expiry is nearest `target`, within `[min,max]`. ```typescript /** Which listed expiry to trade: the one whose days-to-expiry is nearest `target`, within `[min,max]`. */ export interface DaysToExpiryTarget { /** Preferred days to expiry. */ target: number; /** Reject expiries with fewer DTE than this (default: no floor). */ min?: number; /** Reject expiries with more DTE than this (default: no ceiling). */ max?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - max?: number; default: not declared — Reject expiries with more DTE than this (default: no ceiling). - min?: number; default: not declared — Reject expiries with fewer DTE than this (default: no floor). - target: number; default: not declared — Preferred days to expiry. ### @insiderfinance/totalfinance/backtest/options#DeltaHedgeRule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Keep the portfolio delta-neutral by trading the underlying whenever |net delta| exceeds the band. ```typescript /** Keep the portfolio delta-neutral by trading the underlying whenever |net delta| exceeds the band. */ export interface DeltaHedgeRule { /** Rehedge to flat delta when the absolute share-equivalent net delta exceeds this many shares. */ deltaBand: number; /** Slippage on the underlying hedge trades (defaults to the backtest's option slippage). */ slippage?: SlippageModel; /** Commission on the underlying hedge trades (defaults to the backtest's option commission). */ commission?: CostModel; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission?: CostModel; default: not declared — Commission on the underlying hedge trades (defaults to the backtest's option commission). - commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - commission.commission(input).price: number; default: not declared - commission.commission(input).quantity: number; default: not declared - commission.label: string; default: not declared - deltaBand: number; default: not declared — Rehedge to flat delta when the absolute share-equivalent net delta exceeds this many shares. - slippage?: SlippageModel; default: not declared — Slippage on the underlying hedge trades (defaults to the backtest's option slippage). - slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - slippage.fill(input).quantity: number; default: not declared - slippage.fill(input).referencePrice: number; default: not declared - slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - slippage.label: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#DividendRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A cash dividend on an underlying — early-assignment and dividend-risk evidence. ```typescript /** A cash dividend on an underlying — early-assignment and dividend-risk evidence. */ export interface DividendRecord { underlying: string; /** Ex-dividend date, `YYYY-MM-DD`. */ exDate: string; /** Per-share amount, > 0. */ amount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Per-share amount, > 0. - exDate: string; default: not declared — Ex-dividend date, `YYYY-MM-DD`. - underlying: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#DividendRiskRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dividend-risk evidence for one open short call at a snapshot before an ex-date. ```typescript /** Dividend-risk evidence for one open short call at a snapshot before an ex-date. */ export interface DividendRiskRow { tradeId: number; legIndex: number; underlying: string; exDate: string; dividend: number; /** The call's extrinsic value per share at the snapshot. */ extrinsic: number; /** True when the dividend exceeds the extrinsic value — the classic early-assignment condition. */ atRisk: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atRisk: boolean; default: not declared — True when the dividend exceeds the extrinsic value — the classic early-assignment condition. - dividend: number; default: not declared - exDate: string; default: not declared - extrinsic: number; default: not declared — The call's extrinsic value per share at the snapshot. - legIndex: number; default: not declared - tradeId: number; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#EntryContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Context passed to entry callbacks (`when` / `build`). ```typescript /** Context passed to entry callbacks (`when` / `build`). */ export interface EntryContext { snapshot: ChainSnapshot; asOf: EpochMs; cash: number; equity: number; /** True when this rule has no open trade. */ flat: boolean; /** Trades open in the book at the decision instant, every rule's (Stage 4.6). */ openTrades: readonly OpenTradeView[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - cash: number; default: not declared - equity: number; default: not declared - flat: boolean; default: not declared — True when this rule has no open trade. - openTrades: readonly OpenTradeView[]; default: not declared — Trades open in the book at the decision instant, every rule's (Stage 4.6). - snapshot: ChainSnapshot; default: not declared - snapshot.asOf: string | number; default: not declared — Snapshot instant — epoch ms or a zoned ISO datetime. A bare `'YYYY-MM-DD'` is refused: the time of day prices the chain. An end-of-day chain is observed at the close — `usEquitySessionInstant(date, 'close')` from `@insiderfinance/totalfinance/core`. - snapshot.quotes: OptionQuote[]; default: not declared — Every listed contract's quote. Delta-based strike selection reads `greeks.delta` per quote (stamp it with `@insiderfinance/totalfinance/options` `chainGreeks` if your source lacks it); other selections do not need it. - snapshot.underlyingPrice: number; default: not declared — Underlying spot at this snapshot (the mark for pricing and delta-hedging). ### @insiderfinance/totalfinance/backtest/options#EntryRule Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The entry rule — a discriminated union over `structure`, mirroring `strategyFromChain`'s option grammar so the declarative form maps 1:1 onto the library. The `build` variant is the full escape hatch: return a `Position` (or `null` to skip) built however you like from the snapshot. ```typescript /** * The entry rule — a discriminated union over `structure`, mirroring `strategyFromChain`'s option * grammar so the declarative form maps 1:1 onto the library. The `build` variant is the full escape * hatch: return a `Position` (or `null` to skip) built however you like from the snapshot. */ export type EntryRule = (EntryCommon & { structure: 'ironCondor'; select: { shortDelta: number; wingWidth: number; }; }) | (EntryCommon & { structure: 'bullCallSpread' | 'bearCallSpread' | 'bullPutSpread' | 'bearPutSpread'; select: { shortDelta: number; width: number; }; }) | (EntryCommon & { structure: 'strangle'; select: { shortDelta: number; }; }) | (EntryCommon & { structure: 'straddle'; select?: { strike?: number; }; }) | (EntryCommon & { structure: 'coveredCall'; select: { shortDelta: number; stockPrice?: number; }; }) | (EntryCommon & { structure: 'protectivePut'; select: { shortDelta: number; stockPrice?: number; }; }) | (EntryCommon & { structure: 'calendarCallSpread' | 'calendarPutSpread'; select: MultiExpirySelection; }) | (EntryCommon & { structure: 'diagonalCallSpread' | 'diagonalPutSpread' | 'doubleDiagonal'; select: MultiExpirySelection; }) | (EntryCommon & { build: (context: EntryContext) => Position | null; }); ``` ### @insiderfinance/totalfinance/backtest/options#EntryStructure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The declarative single-expiry `structure` values (a subset of {@link FromChainType}). ```typescript /** The declarative single-expiry `structure` values (a subset of {@link FromChainType}). */ export type EntryStructure = Exclude; ``` ### @insiderfinance/totalfinance/backtest/options#EntryWhen Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). When to open a position: only when this rule is flat (default), whenever the book has room, or a caller predicate. ```typescript /** When to open a position: only when this rule is flat (default), whenever the book has room, or a caller predicate. */ export type EntryWhen = 'flat' | 'always' | ((context: EntryContext) => boolean); ``` ### @insiderfinance/totalfinance/backtest/options#ExitContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Context passed to exit / roll callbacks. ```typescript /** Context passed to exit / roll callbacks. */ export interface ExitContext { snapshot: ChainSnapshot; asOf: EpochMs; position: Position; /** Signed entry premium (positive = net debit paid, negative = net credit received). */ entryPremium: number; /** Current mark-to-market P&L of the position, in account currency. */ markToMarket: number; /** `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). */ pnlFraction: number; /** Calendar days to expiry (nearest leg for a multi-expiry structure). */ daysToExpiry: number; /** Aggregate share-equivalent delta of the position. */ netDelta: number; greeks: Greeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - greeks: Greeks; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.rho: number; default: not declared - greeks.theta: number; default: not declared - greeks.vega: number; default: not declared - markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - position: Position; default: not declared - position.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - position.assumptions().return.constructedAs?: string; default: not declared — The named builder that constructed this position (provenance — see `classifyStrategy`). - position.assumptions().return.multiplier: number; default: not declared — Contract multiplier applied to option legs. - position.assumptions().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — `'user'` when every entry premium was supplied; `'model'` when any was priced from `market`. - position.assumptions().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When premiums were modeled, which volatility priced them: each leg's own `impliedVolatility` (`'leg'`), the position-level `market.volatility` (`'position'`), or both across legs (`'mixed'`) — the same source `value()` marks with, so a chain-fed position opens flat. - position.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - position.chartData(options)?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }; default: not declared - position.chartData(options).include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; default: not declared - position.chartData(options).market?: Partial>; default: not declared - position.chartData(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.chartData(options).market.dividendYield?: number; default: not declared - position.chartData(options).market.expiry?: string; default: not declared - position.chartData(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.chartData(options).market.riskFreeRate?: number; default: not declared - position.chartData(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.chartData(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.chartData(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared - position.chartData(options).prices.from: number; default: not declared - position.chartData(options).prices.steps: number; default: not declared - position.chartData(options).prices.to: number; default: not declared - position.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - position.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - position.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - position.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - position.market.dividendYield?: number; default: not declared - position.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - position.market.riskFreeRate: number; default: not declared - position.market.spot: number; default: not declared - position.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - position.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - position.metrics().return.bounded: { profit: boolean; loss: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - position.metrics().return.bounded.loss: boolean; default: not declared - position.metrics().return.bounded.profit: boolean; default: not declared - position.metrics().return.breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - position.metrics().return.maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - position.metrics().return.maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - position.metrics().return.netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - position.metrics().return.netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - position.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - position.monteCarloProbability().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; probabilityModel: import('@insiderfinance/totalfinance/strategy').ProbabilityModel; }>; default: not declared — Applied conventions, plus where the market fields came from — construction market, call site, or a merge (R5) — as `assumptions.marketSource` (R2: never hoisted to the top level). - position.monteCarloProbability().return.expectedValue: number; default: not declared — Monte-Carlo expected expiration P&L. - position.monteCarloProbability().return.expectedValueStandardError: number; default: not declared — Standard error of the expected-value estimate. - position.monteCarloProbability().return.paths: number; default: not declared — Number of paths simulated. - position.monteCarloProbability().return.pnlQuantiles?: { quantile: number; pnl: number; }[]; default: not declared — Requested expiration-P&L quantiles (the profit cone), present only when `pnlQuantiles` was set. - position.monteCarloProbability().return.probabilityOfProfit: number; default: not declared — Monte-Carlo probability of a positive expiration P&L. - position.monteCarloProbability().return.probabilityOfTouch: import('@insiderfinance/totalfinance/strategy').TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry, estimated from simulated paths with the Brownian-bridge continuous-monitoring correction (discrete sampling alone would under-count). - position.monteCarloProbability().return.seed: number; default: not declared — The PRNG seed, echoed for reproducibility (stochastic-provenance rule, cf. `MonteCarloStatistics.seed`). - position.monteCarloProbability(overrides): Partial & { seed: number; }; default: not declared - position.monteCarloProbability(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.monteCarloProbability(overrides).dividendYield?: number; default: not declared - position.monteCarloProbability(overrides).expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - position.monteCarloProbability(overrides).expiry?: string; default: not declared - position.monteCarloProbability(overrides).localVolatility?: (level: number, timeToExpiryYears: number) => number; default: not declared — Optional Dupire local-volatility function `σ_loc(level, t)` (e.g. from `@insiderfinance/totalfinance/volatility`'s `surfaceLocalVolatility` or `@insiderfinance/totalfinance/options`'s `dupireLocalVolatility`). When provided, the simulation steps under local vol instead of a single lognormal σ, so probability-of-profit, expected P&L, and probability-of-touch all reflect the volatility smile/skew — the smile-aware multi-leg read. The function is evaluated at the price and time reached at each step. - position.monteCarloProbability(overrides).measure?: import('@insiderfinance/totalfinance/strategy').ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - position.monteCarloProbability(overrides).paths?: number; default: not declared — Number of simulated paths (default 50_000). - position.monteCarloProbability(overrides).pnlQuantiles?: number[]; default: not declared — Optional P&L quantiles to report (each in `(0, 1)`), forming an expiration profit "cone" from the simulated terminal distribution. E.g. `[0.05, 0.5, 0.95]` → 5th/50th/95th-percentile P&L. - position.monteCarloProbability(overrides).riskFreeRate?: number; default: not declared - position.monteCarloProbability(overrides).seed?: number; default: not declared — Seed for the deterministic PRNG (required — the simulation never reads the system clock). - position.monteCarloProbability(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - position.monteCarloProbability(overrides).steps?: number; default: not declared — Monitoring steps per path for the probability-of-touch estimate (default 50). - position.monteCarloProbability(overrides).volatility?: number; default: not declared — Annualized volatility of the constant-vol lognormal. Required unless {@link localVolatility} is supplied (a local-volatility path ignores it except as the model echo's representative vol). - position.multiplier: number; default: not declared - position.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - position.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - position.payoff().return.bounded: { profit: boolean; loss: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - position.payoff().return.bounded.loss: boolean; default: not declared - position.payoff().return.bounded.profit: boolean; default: not declared - position.payoff().return.breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - position.payoff().return.maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - position.payoff().return.maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - position.payoff().return.netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - position.payoff().return.netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - position.payoff().return.points: { underlyingPrice: number; pnl: number; }[]; default: not declared — Chart-ready points of expiration P&L vs. underlying price. - position.payoff(options)?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }; default: not declared - position.payoff(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared - position.payoff(options).prices.from: number; default: not declared - position.payoff(options).prices.steps: number; default: not declared - position.payoff(options).prices.to: number; default: not declared - position.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - position.pnlAtExpiry(underlyingPrice): number; default: not declared - position.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - position.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - position.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - position.probability().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; probabilityModel: import('@insiderfinance/totalfinance/strategy').ProbabilityModel; }>; default: not declared — Applied conventions, where the market fields came from (`assumptions.marketSource`, R5), and the probability model echo (`assumptions.probabilityModel`) — R2: never hoisted to the top level. - position.probability().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings — the undefined reward-to-risk reason rides here (empty otherwise). - position.probability().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - position.probability().return.expectedValue: number; default: not declared — Expected expiration P&L under the model (closed-form expected intrinsic − premium per leg). - position.probability().return.probabilityOfProfit: number; default: not declared — Probability that expiration P&L is positive (sum of profit-region probabilities). - position.probability().return.probabilityOfTouch: import('@insiderfinance/totalfinance/strategy').TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry. - position.probability().return.riskReward: number | null; default: not declared — Reward-to-risk ratio `|maxProfit / maxLoss|`, or `null` when it is undefined — an unbounded profit, an unbounded loss, or a zero maximum loss — with the reason in `diagnostics.warnings` (`strategy.risk_reward_undefined`). Never `Infinity` (B3). - position.probability(overrides)?: Partial; default: not declared - position.probability(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.probability(overrides).dividendYield?: number; default: not declared - position.probability(overrides).expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - position.probability(overrides).expiry?: string; default: not declared - position.probability(overrides).measure?: import('@insiderfinance/totalfinance/strategy').ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - position.probability(overrides).riskFreeRate?: number; default: not declared - position.probability(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - position.probability(overrides).volatility?: number; default: not declared — Annualized volatility of the terminal lognormal (e.g. the ATM implied vol). - position.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - position.scenarioTable().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; }>; default: not declared — Every applied convention, echoed back. - position.scenarioTable().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - position.scenarioTable().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - position.scenarioTable().return.value: import('@insiderfinance/totalfinance/strategy').ScenarioRow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - position.scenarioTable(options)?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }; default: not declared - position.scenarioTable(options).daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 1, 7]`. Default `[0]`. - position.scenarioTable(options).market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - position.scenarioTable(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.scenarioTable(options).market.dividendYield?: number; default: not declared - position.scenarioTable(options).market.expiry?: string; default: not declared - position.scenarioTable(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.scenarioTable(options).market.riskFreeRate?: number; default: not declared - position.scenarioTable(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.scenarioTable(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.scenarioTable(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - position.scenarioTable(options).prices.from: number; default: not declared - position.scenarioTable(options).prices.steps: number; default: not declared - position.scenarioTable(options).prices.to: number; default: not declared - position.scenarioTable(options).volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. - position.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - position.value().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ volatilitySource: import('@insiderfinance/totalfinance/strategy').VolatilitySource; marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; }>; default: not declared — Every applied convention, echoed back. - position.value().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - position.value().return.greeks: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared — Book-aggregate extended greeks: additive fields summed over legs; `lambda` (Δ·S/V) recomputed at the book level (null when the book value underflows to 0). - position.value().return.perLeg: import('@insiderfinance/totalfinance/strategy').LegValuation[]; default: not declared - position.value().return.pnl: number; default: not declared — Current mark-to-market P&L (also `value`). - position.value().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - position.value().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - position.value(overrides)?: Partial; default: not declared - position.value(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.value(overrides).dividendYield?: number; default: not declared - position.value(overrides).expiry?: string; default: not declared - position.value(overrides).legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.value(overrides).riskFreeRate?: number; default: not declared - position.value(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - position.value(overrides).volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.value(overrides).volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - position.whatIfCube().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; }>; default: not declared — Every applied convention, echoed back. - position.whatIfCube().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - position.whatIfCube().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - position.whatIfCube().return.value: import('@insiderfinance/totalfinance/strategy').WhatIfCubeValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - position.whatIfCube(options)?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions; default: not declared - position.whatIfCube(options).daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 7, 30]`. Default `[0]`. - position.whatIfCube(options).market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - position.whatIfCube(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.whatIfCube(options).market.dividendYield?: number; default: not declared - position.whatIfCube(options).market.expiry?: string; default: not declared - position.whatIfCube(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.whatIfCube(options).market.riskFreeRate?: number; default: not declared - position.whatIfCube(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.whatIfCube(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.whatIfCube(options).objective?: 'max-pnl' | 'min-pnl'; default: not declared — Which extremum the optimal-exit surface picks per (spot, vol); default `'max-pnl'`. - position.whatIfCube(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - position.whatIfCube(options).prices.from: number; default: not declared - position.whatIfCube(options).prices.steps: number; default: not declared - position.whatIfCube(options).prices.to: number; default: not declared - position.whatIfCube(options).probability?: import('@insiderfinance/totalfinance/strategy').WhatIfProbabilityOptions; default: not declared — Opt-in probability weighting (Wave 6 §3). When set, the result gains a `probability` block with the per-day spot mass, disclosed tails, and per-(vol, day) expected P&L. Requires strictly increasing unique prices and non-negative days. - position.whatIfCube(options).volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. - snapshot: ChainSnapshot; default: not declared - snapshot.asOf: string | number; default: not declared — Snapshot instant — epoch ms or a zoned ISO datetime. A bare `'YYYY-MM-DD'` is refused: the time of day prices the chain. An end-of-day chain is observed at the close — `usEquitySessionInstant(date, 'close')` from `@insiderfinance/totalfinance/core`. - snapshot.quotes: OptionQuote[]; default: not declared — Every listed contract's quote. Delta-based strike selection reads `greeks.delta` per quote (stamp it with `@insiderfinance/totalfinance/options` `chainGreeks` if your source lacks it); other selections do not need it. - snapshot.underlyingPrice: number; default: not declared — Underlying spot at this snapshot (the mark for pricing and delta-hedging). ### @insiderfinance/totalfinance/backtest/options#ExitReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Why a trade closed. ```typescript /** Why a trade closed. */ export type ExitReason = 'profit-target' | 'stop-loss' | 'daysToExpiry' | 'signal' | 'expiry' | 'assignment' | 'roll' | 'open-at-end'; ``` ### @insiderfinance/totalfinance/backtest/options#ExitRule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). When to close a position. Declarative triggers OR-combine with the `when` callback; the first to fire closes the trade (its name is recorded as the exit reason). ```typescript /** * When to close a position. Declarative triggers OR-combine with the `when` callback; the first to * fire closes the trade (its name is recorded as the exit reason). */ export interface ExitRule { /** Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). */ profitTarget?: number; /** Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). */ stopLoss?: number; /** Close at or below this many days to expiry. */ daysToExpiry?: number; /** Arbitrary exit predicate (OR-combined with the declarative triggers). */ when?: (context: ExitContext) => boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysToExpiry?: number; default: not declared — Close at or below this many days to expiry. - profitTarget?: number; default: not declared — Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). - stopLoss?: number; default: not declared — Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). - when?: (context: ExitContext) => boolean; default: not declared — Arbitrary exit predicate (OR-combined with the declarative triggers). - when(context): ExitContext; default: not declared - when(context).asOf: number; default: not declared - when(context).daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - when(context).entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - when(context).greeks: Greeks; default: not declared - when(context).markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - when(context).netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - when(context).pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - when(context).position: Position; default: not declared - when(context).snapshot: ChainSnapshot; default: not declared ### @insiderfinance/totalfinance/backtest/options#FillPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a structure's legs fill at entry (Stage 4.6). ```typescript /** How a structure's legs fill at entry (Stage 4.6). */ export interface FillPolicy { /** `'combo'` (default) fills every leg at once or rejects the entry; `'legged'` fills legs in order. */ mode?: 'combo' | 'legged'; /** Under `'legged'`: reject a structure whose sequence stops early (default), or hold the filled legs. */ partialFill?: 'reject' | 'allow'; /** The per-leg fill side (default: the rule's `price`, else `'mid'`). */ price?: PriceSource; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - mode?: 'combo' | 'legged'; default: not declared — `'combo'` (default) fills every leg at once or rejects the entry; `'legged'` fills legs in order. - partialFill?: 'reject' | 'allow'; default: not declared — Under `'legged'`: reject a structure whose sequence stops early (default), or hold the filled legs. - price?: PriceSource; default: not declared — The per-leg fill side (default: the rule's `price`, else `'mid'`). ### @insiderfinance/totalfinance/backtest/options#FillRejection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An entry the fill policy rejected (Stage 4.6): the legs that could not fill and why. ```typescript /** An entry the fill policy rejected (Stage 4.6): the legs that could not fill and why. */ export interface FillRejection { asOf: EpochMs; ruleId: string; structure: string; mode: 'combo' | 'legged'; unfilledLegs: UnfilledLeg[]; /** `backtest.combo_leg_unfilled` */ code: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - code: string; default: not declared — `backtest.combo_leg_unfilled` - mode: 'combo' | 'legged'; default: not declared - ruleId: string; default: not declared - structure: string; default: not declared - unfilledLegs: UnfilledLeg[]; default: not declared ### @insiderfinance/totalfinance/backtest/options#GreekAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Strategy-level greek P&L attribution — the per-trade `TradePnlExplain`s summed across every trade. Answers "where did the P&L come from": how much of the realized gross P&L was `delta` (direction), `theta` (decay), `gamma` (convexity), `vega` (vol), etc., plus the `unexplained` 3rd-order-and-higher residual. `total` is the summed **gross** (pre-cost) mark P&L; the net P&L is `total − options.totalCosts`. Because the backtester marks at constant entry IV with a fixed rate, `delta`/ `gamma`/`theta` carry most strategies and `vega`/`rho` are ~0 (see `TradePnlExplain`). ```typescript /** * Strategy-level greek P&L attribution — the per-trade `TradePnlExplain`s summed across every trade. * Answers "where did the P&L come from": how much of the realized gross P&L was `delta` (direction), * `theta` (decay), `gamma` (convexity), `vega` (vol), etc., plus the `unexplained` 3rd-order-and-higher * residual. `total` is the summed **gross** (pre-cost) mark P&L; the net P&L is `total − * options.totalCosts`. Because the backtester marks at constant entry IV with a fixed rate, `delta`/ * `gamma`/`theta` carry most strategies and `vega`/`rho` are ~0 (see `TradePnlExplain`). */ export interface GreekAttribution extends Omit { /** Number of trades summed (every trade in the result, closed and open-at-end). */ trades: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - delta: number; default: not declared — Delta term: `Δ·dS`. - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - rho: number; default: not declared — Rho term: `Rho·dr`. - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - theta: number; default: not declared — Theta term: `Θ·dt`. - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - total: number; default: not declared — The actual realized P&L. - trades: number; default: not declared — Number of trades summed (every trade in the result, closed and open-at-end). - unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - vega: number; default: not declared — Vega term: `Vega·dσ`. - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/backtest/options#LegAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-leg realized P&L attribution for a closed (or marked-at-end) options trade. ```typescript /** Per-leg realized P&L attribution for a closed (or marked-at-end) options trade. */ export interface LegAttribution { leg: Leg; realizedPnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - leg: Leg; default: not declared - leg.expiry?: (string) | (undefined); default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - leg.impliedVolatility?: (number) | (undefined); default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - leg.kind: ('call' | 'put') | ('stock'); default: not declared - leg.premium?: (number) | (undefined); default: not declared — Entry premium per share. - leg.price?: (number) | (undefined); default: not declared — Entry price per share. Never on an option row (a stock row's entry price). - leg.quantity: number; default: not declared — Signed shares: positive = long, negative = short. Signed contracts: positive = long, negative = short. - leg.strike?: (number) | (undefined); default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). - realizedPnl: number; default: not declared ### @insiderfinance/totalfinance/backtest/options#LegRoleAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Realized P&L grouped by leg role (`short put`, `long call`, `stock`, …) across every trade. ```typescript /** Realized P&L grouped by leg role (`short put`, `long call`, `stock`, …) across every trade. */ export interface LegRoleAttribution { role: string; legs: number; realizedPnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - legs: number; default: not declared - realizedPnl: number; default: not declared - role: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#LimitRejection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An entry a limit rejected (Stage 4.6): the limit, the value the book would have had, the bound. ```typescript /** An entry a limit rejected (Stage 4.6): the limit, the value the book would have had, the bound. */ export interface LimitRejection { asOf: EpochMs; ruleId: string; structure: string; limit: keyof PortfolioLimits; value: number; bound: number; /** `backtest.limit_rejected` */ code: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - bound: number; default: not declared - code: string; default: not declared — `backtest.limit_rejected` - limit: keyof PortfolioLimits; default: not declared - ruleId: string; default: not declared - structure: string; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/backtest/options#MarkSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Where one open option leg's volatility came from at one snapshot (Preview P1). ```typescript /** Where one open option leg's volatility came from at one snapshot (Preview P1). */ export type MarkSource = 'current-quote' | 'implied-from-price' | 'entry-volatility' | 'carried'; ``` ### @insiderfinance/totalfinance/backtest/options#MarkingPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How open option legs are marked at every snapshot (Preview P1 — `docs/specs/options-backtest.md`, "Preview P1 amendment"). Every member is optional; the defaults are the truthful ones. ```typescript /** * How open option legs are marked at every snapshot (Preview P1 — `docs/specs/options-backtest.md`, * "Preview P1 amendment"). Every member is optional; the defaults are the truthful ones. */ export interface MarkingPolicy { /** * `'current-quote'` (DEFAULT) re-marks each open leg from the exact current-snapshot contract * quote — its stated implied volatility, or one implied from the quote's selected price. `'entry'` * holds each leg's entry volatility for the whole trade (the pre-P1 behaviour, now explicit). */ volatility?: 'current-quote' | 'entry'; /** * What happens when the current contract cannot mark a leg under `'current-quote'`: `'refuse'` * (DEFAULT) throws `backtest.mark_unavailable` naming the leg, the snapshot, and the cause; * `'entry-volatility'` marks THAT leg at its entry volatility for THAT snapshot; * `'carry-last-volatility'` holds the leg's last successfully marked volatility (the mark still * reprices for spot and time). Both fallbacks are counted per trade and warned once per cause. */ missingMark?: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; /** * A current quote whose `timestampMs` is older than the snapshot's `asOf` by more than this is * STALE and cannot mark (it falls to `missingMark`). Omitted ⇒ every quote a snapshot carries is * current by definition of the snapshot. */ maximumQuoteAgeMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumQuoteAgeMs?: number; default: not declared — A current quote whose `timestampMs` is older than the snapshot's `asOf` by more than this is STALE and cannot mark (it falls to `missingMark`). Omitted ⇒ every quote a snapshot carries is current by definition of the snapshot. - missingMark?: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared — What happens when the current contract cannot mark a leg under `'current-quote'`: `'refuse'` (DEFAULT) throws `backtest.mark_unavailable` naming the leg, the snapshot, and the cause; `'entry-volatility'` marks THAT leg at its entry volatility for THAT snapshot; `'carry-last-volatility'` holds the leg's last successfully marked volatility (the mark still reprices for spot and time). Both fallbacks are counted per trade and warned once per cause. - volatility?: 'current-quote' | 'entry'; default: not declared — `'current-quote'` (DEFAULT) re-marks each open leg from the exact current-snapshot contract quote — its stated implied volatility, or one implied from the quote's selected price. `'entry'` holds each leg's entry volatility for the whole trade (the pre-P1 behaviour, now explicit). ### @insiderfinance/totalfinance/backtest/options#MissingMarkCause Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Why a current contract quote could not mark a leg (Preview P1). ```typescript /** Why a current contract quote could not mark a leg (Preview P1). */ export type MissingMarkCause = 'missing' | 'ambiguous' | 'stale' | 'unpriceable'; ``` ### @insiderfinance/totalfinance/backtest/options#MultiExpirySelection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Multi-expiry selection for calendars and diagonals: the near leg by delta, the far leg by days. ```typescript /** Multi-expiry selection for calendars and diagonals: the near leg by delta, the far leg by days. */ export interface MultiExpirySelection { /** Target |delta| of the short near leg. */ shortDelta: number; /** Days-to-expiry target of the near (short) expiry. */ nearDaysToExpiry: DaysToExpiryTarget; /** Days-to-expiry target of the far (long) expiry; must resolve to a later expiry than the near one. */ farDaysToExpiry: DaysToExpiryTarget; /** Strike distance of the far leg from the near leg (diagonals: required; calendars: not allowed). */ width?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - farDaysToExpiry: DaysToExpiryTarget; default: not declared — Days-to-expiry target of the far (long) expiry; must resolve to a later expiry than the near one. - farDaysToExpiry.max?: number; default: not declared — Reject expiries with more DTE than this (default: no ceiling). - farDaysToExpiry.min?: number; default: not declared — Reject expiries with fewer DTE than this (default: no floor). - farDaysToExpiry.target: number; default: not declared — Preferred days to expiry. - nearDaysToExpiry: DaysToExpiryTarget; default: not declared — Days-to-expiry target of the near (short) expiry. - nearDaysToExpiry.max?: number; default: not declared — Reject expiries with more DTE than this (default: no ceiling). - nearDaysToExpiry.min?: number; default: not declared — Reject expiries with fewer DTE than this (default: no floor). - nearDaysToExpiry.target: number; default: not declared — Preferred days to expiry. - shortDelta: number; default: not declared — Target |delta| of the short near leg. - width?: number; default: not declared — Strike distance of the far leg from the near leg (diagonals: required; calendars: not allowed). ### @insiderfinance/totalfinance/backtest/options#MultiExpiryStructure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The declarative multi-expiry structures (Stage 4.6), built through `@insiderfinance/totalfinance/strategy`'s constructors. ```typescript /** The declarative multi-expiry structures (Stage 4.6), built through `@insiderfinance/totalfinance/strategy`'s constructors. */ export type MultiExpiryStructure = 'calendarCallSpread' | 'calendarPutSpread' | 'diagonalCallSpread' | 'diagonalPutSpread' | 'doubleDiagonal'; ``` ### @insiderfinance/totalfinance/backtest/options#OPTIONS_BOOK_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: open positions one book may hold. ```typescript export declare const OPTIONS_BOOK_CEILING: 10000; ``` ### @insiderfinance/totalfinance/backtest/options#OpenTradeView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a callback may see of an open trade: identity, structure, and the current mark. ```typescript /** What a callback may see of an open trade: identity, structure, and the current mark. */ export interface OpenTradeView { tradeId: number; ruleId: string; structure: string; underlying: string; entryAsOf: EpochMs; entryPremium: number; markToMarket: number; legs: readonly Leg[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entryAsOf: number; default: not declared - entryPremium: number; default: not declared - legs: readonly Leg[]; default: not declared - markToMarket: number; default: not declared - ruleId: string; default: not declared - structure: string; default: not declared - tradeId: number; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#OptionsBacktestAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Applied conventions, echoed (the envelope law). ```typescript /** Applied conventions, echoed (the envelope law). */ export interface OptionsBacktestAssumptions { conventionsVersion: string; initialCapital: number; riskFreeRate: number; dividendYield: number; /** Fill price source for entries/exits. */ priceSource: PriceSource; /** How positions were sized. */ sizing: 'fixed-quantity' | 'margin-aware'; commission: string; slippage: string; assignment: 'model' | 'none'; /** Delta-hedge band in share-equivalents, or `'none'`. */ hedge: number | 'none'; periodsPerYear: number; /** The applied marking and missing-mark policies (Preview P1). */ marking: AppliedMarkingPolicy; /** Stage 4.6: the book, the limits, the fill policy, the freshness policy, and the rules. */ book: { maximumOpenPositions: number; maximumPerUnderlying: number | null; }; limits: { maximumMarginFraction: number | null; maximumNetDelta: number | null; maximumNetVega: number | null; maximumConcentration: number | null; scenarioLoss: { spotShocks: number[]; volatilityShocks: number[]; maximumLossFraction: number; } | null; }; fillPolicy: { mode: 'combo' | 'legged'; partialFill: 'reject' | 'allow'; price: PriceSource; }; quoteFreshness: { maximumQuoteAgeMs: number | null; }; rules: Array<{ id: string; structure: string; }>; corporateActions: number; dividends: number; baseCurrency: string; ledger: { sourceId: string; accountId: string; lotRelief: string; }; /** `false` exactly when a caller function (a `build`, a `when`) participated. */ replayable: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assignment: 'none' | 'model'; default: not declared - baseCurrency: string; default: not declared - book: { maximumOpenPositions: number; maximumPerUnderlying: number | null; }; default: not declared — Stage 4.6: the book, the limits, the fill policy, the freshness policy, and the rules. - book.maximumOpenPositions: number; default: not declared - book.maximumPerUnderlying: number | null; default: not declared - commission: string; default: not declared - conventionsVersion: string; default: not declared - corporateActions: number; default: not declared - dividendYield: number; default: not declared - dividends: number; default: not declared - fillPolicy: { mode: 'combo' | 'legged'; partialFill: 'reject' | 'allow'; price: PriceSource; }; default: not declared - fillPolicy.mode: 'combo' | 'legged'; default: not declared - fillPolicy.partialFill: 'reject' | 'allow'; default: not declared - fillPolicy.price: PriceSource; default: not declared - hedge: number | 'none'; default: not declared — Delta-hedge band in share-equivalents, or `'none'`. - initialCapital: number; default: not declared - ledger: { accountId: string; lotRelief: string; sourceId: string; }; default: not declared - ledger.accountId: string; default: not declared - ledger.lotRelief: string; default: not declared - ledger.sourceId: string; default: not declared - limits: { maximumConcentration: number | null; maximumMarginFraction: number | null; maximumNetDelta: number | null; maximumNetVega: number | null; scenarioLoss: { spotShocks: number[]; volatilityShocks: number[]; maximumLossFraction: number; } | null; }; default: not declared - limits.maximumConcentration: number | null; default: not declared - limits.maximumMarginFraction: number | null; default: not declared - limits.maximumNetDelta: number | null; default: not declared - limits.maximumNetVega: number | null; default: not declared - limits.scenarioLoss: { maximumLossFraction: number; spotShocks: number[]; volatilityShocks: number[]; } | null; default: not declared - limits.scenarioLoss.maximumLossFraction: number; default: not declared - limits.scenarioLoss.spotShocks: number[]; default: not declared - limits.scenarioLoss.volatilityShocks: number[]; default: not declared - marking: AppliedMarkingPolicy; default: not declared — The applied marking and missing-mark policies (Preview P1). - marking.maximumQuoteAgeMs: number | null; default: not declared - marking.missingMark: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared - marking.volatility: 'current-quote' | 'entry'; default: not declared - periodsPerYear: number; default: not declared - priceSource: PriceSource; default: not declared — Fill price source for entries/exits. - quoteFreshness: { maximumQuoteAgeMs: number | null; }; default: not declared - quoteFreshness.maximumQuoteAgeMs: number | null; default: not declared - replayable: boolean; default: not declared — `false` exactly when a caller function (a `build`, a `when`) participated. - riskFreeRate: number; default: not declared - rules: { id: string; structure: string; }[]; default: not declared - sizing: 'fixed-quantity' | 'margin-aware'; default: not declared — How positions were sized. - slippage: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#OptionsBacktestConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionsBacktestConfig { /** Time-ordered (or unordered — the engine sorts) chain snapshots. */ chains: Iterable; /** How open legs are marked at every snapshot (default: current quote; refuse a missing mark). */ marking?: MarkingPolicy; /** Opening capital (default 100,000). */ initialCapital?: number; /** * Continuously-compounded risk-free rate (decimal) for every mark-to-market price and the * assignment carry. REQUIRED: a backtest that silently priced at 4% was a financial assumption * nobody stated. */ riskFreeRate: number; /** Continuous dividend yield for pricing (default 0). */ dividendYield?: number; /** One rule (the shipped form); exactly one of `entry` and `rules` is given. */ entry?: EntryRule; /** Several rules at once (Stage 4.6): each a member of the book, entered in order at every snapshot. */ rules?: readonly EntryRule[]; exit: ExitRule; /** Roll instead of closing flat when the rule fires. */ roll?: RollRule; /** Optional delta-hedging with the underlying. */ hedge?: DeltaHedgeRule; /** Commission model for option trades (default none). */ commission?: CostModel; /** Slippage model for option trades (default none). */ slippage?: SlippageModel; /** American early-assignment modeling (default `'none'`; `'model'` uses the deep-ITM/ex-div heuristic). */ assignment?: 'model' | 'none'; /** Annualization factor for the performance summary (default 252). */ periodsPerYear?: number; /** The book's capacity (default: one open trade). */ book?: BookPolicy; /** Pre-trade limits on the post-trade book. */ limits?: PortfolioLimits; /** Combo or legged fills; partial-fill policy; the per-leg fill side. */ fillPolicy?: FillPolicy; /** Refuse fills on stale quotes. */ quoteFreshness?: QuoteFreshnessPolicy; /** Splits and symbol changes adjust open legs with lineage; mergers and spin-offs on an open leg refuse. */ corporateActions?: readonly CorporateAction[]; /** Cash dividends: dividend-risk evidence per short call, early assignment under `assignment: 'model'`. */ dividends?: readonly DividendRecord[]; /** The account currency of the ledger (default `'USD'`). */ baseCurrency?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assignment?: 'none' | 'model'; default: not declared — American early-assignment modeling (default `'none'`; `'model'` uses the deep-ITM/ex-div heuristic). - baseCurrency?: string; default: not declared — The account currency of the ledger (default `'USD'`). - book?: BookPolicy; default: not declared — The book's capacity (default: one open trade). - book.maximumOpenPositions?: number; default: not declared — Open trades at once (default 1 — the shipped single-position behaviour; at most 10,000). - book.maximumPerUnderlying?: number; default: not declared — Open trades per underlying (default: no bound). - chains: Iterable; default: not declared — Time-ordered (or unordered — the engine sorts) chain snapshots. - commission?: CostModel; default: not declared — Commission model for option trades (default none). - commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - commission.commission(input).price: number; default: not declared - commission.commission(input).quantity: number; default: not declared - commission.label: string; default: not declared - corporateActions?: readonly CorporateAction[]; default: not declared — Splits and symbol changes adjust open legs with lineage; mergers and spin-offs on an open leg refuse. - dividendYield?: number; default: not declared — Continuous dividend yield for pricing (default 0). - dividends?: readonly DividendRecord[]; default: not declared — Cash dividends: dividend-risk evidence per short call, early assignment under `assignment: 'model'`. - entry?: EntryRule; default: not declared — One rule (the shipped form); exactly one of `entry` and `rules` is given. - exit: ExitRule; default: not declared - exit.daysToExpiry?: number; default: not declared — Close at or below this many days to expiry. - exit.profitTarget?: number; default: not declared — Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). - exit.stopLoss?: number; default: not declared — Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). - exit.when?: (context: ExitContext) => boolean; default: not declared — Arbitrary exit predicate (OR-combined with the declarative triggers). - exit.when(context): ExitContext; default: not declared - exit.when(context).asOf: number; default: not declared - exit.when(context).daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - exit.when(context).entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - exit.when(context).greeks: Greeks; default: not declared - exit.when(context).markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - exit.when(context).netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - exit.when(context).pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - exit.when(context).position: Position; default: not declared - exit.when(context).snapshot: ChainSnapshot; default: not declared - fillPolicy?: FillPolicy; default: not declared — Combo or legged fills; partial-fill policy; the per-leg fill side. - fillPolicy.mode?: 'combo' | 'legged'; default: not declared — `'combo'` (default) fills every leg at once or rejects the entry; `'legged'` fills legs in order. - fillPolicy.partialFill?: 'reject' | 'allow'; default: not declared — Under `'legged'`: reject a structure whose sequence stops early (default), or hold the filled legs. - fillPolicy.price?: PriceSource; default: not declared — The per-leg fill side (default: the rule's `price`, else `'mid'`). - hedge?: DeltaHedgeRule; default: not declared — Optional delta-hedging with the underlying. - hedge.commission?: CostModel; default: not declared — Commission on the underlying hedge trades (defaults to the backtest's option commission). - hedge.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - hedge.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - hedge.commission.commission(input).price: number; default: not declared - hedge.commission.commission(input).quantity: number; default: not declared - hedge.commission.label: string; default: not declared - hedge.deltaBand: number; default: not declared — Rehedge to flat delta when the absolute share-equivalent net delta exceeds this many shares. - hedge.slippage?: SlippageModel; default: not declared — Slippage on the underlying hedge trades (defaults to the backtest's option slippage). - hedge.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - hedge.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - hedge.slippage.fill(input).quantity: number; default: not declared - hedge.slippage.fill(input).referencePrice: number; default: not declared - hedge.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - hedge.slippage.label: string; default: not declared - initialCapital?: number; default: not declared — Opening capital (default 100,000). - limits?: PortfolioLimits; default: not declared — Pre-trade limits on the post-trade book. - limits.maximumConcentration?: number; default: not declared — Premium at risk (Σ |entry premium|) in one underlying ≤ fraction × equity. - limits.maximumMarginFraction?: number; default: not declared — `optionsMargin` of the whole book ≤ fraction × equity. - limits.maximumNetDelta?: number; default: not declared — |Σ share-equivalent delta| per underlying ≤ this many shares. - limits.maximumNetVega?: number; default: not declared — |Σ vega| per underlying (account currency per 1.00 volatility) ≤ this. - limits.scenarioLoss?: { maximumLossFraction: number; spotShocks: readonly number[]; volatilityShocks: readonly number[]; }; default: not declared — The book's worst Taylor P&L over the shock grid (`scenarioGrid`) may not exceed fraction × equity. - limits.scenarioLoss.maximumLossFraction: number; default: not declared - limits.scenarioLoss.spotShocks: readonly number[]; default: not declared — Spot shocks as fractions (e.g. −0.1 for −10%). - limits.scenarioLoss.volatilityShocks: readonly number[]; default: not declared — Absolute volatility shocks (e.g. 0.05 for +5 points). - marking?: MarkingPolicy; default: not declared — How open legs are marked at every snapshot (default: current quote; refuse a missing mark). - marking.maximumQuoteAgeMs?: number; default: not declared — A current quote whose `timestampMs` is older than the snapshot's `asOf` by more than this is STALE and cannot mark (it falls to `missingMark`). Omitted ⇒ every quote a snapshot carries is current by definition of the snapshot. - marking.missingMark?: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared — What happens when the current contract cannot mark a leg under `'current-quote'`: `'refuse'` (DEFAULT) throws `backtest.mark_unavailable` naming the leg, the snapshot, and the cause; `'entry-volatility'` marks THAT leg at its entry volatility for THAT snapshot; `'carry-last-volatility'` holds the leg's last successfully marked volatility (the mark still reprices for spot and time). Both fallbacks are counted per trade and warned once per cause. - marking.volatility?: 'current-quote' | 'entry'; default: not declared — `'current-quote'` (DEFAULT) re-marks each open leg from the exact current-snapshot contract quote — its stated implied volatility, or one implied from the quote's selected price. `'entry'` holds each leg's entry volatility for the whole trade (the pre-P1 behaviour, now explicit). - periodsPerYear?: number; default: not declared — Annualization factor for the performance summary (default 252). - quoteFreshness?: QuoteFreshnessPolicy; default: not declared — Refuse fills on stale quotes. - quoteFreshness.maximumQuoteAgeMs: number; default: not declared - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal) for every mark-to-market price and the assignment carry. REQUIRED: a backtest that silently priced at 4% was a financial assumption nobody stated. - roll?: RollRule; default: not declared — Roll instead of closing flat when the rule fires. - roll.when?: ExitRule; default: not declared — When to roll (defaults to the same triggers as {@link ExitRule}). - roll.when.daysToExpiry?: number; default: not declared — Close at or below this many days to expiry. - roll.when.profitTarget?: number; default: not declared — Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). - roll.when.stopLoss?: number; default: not declared — Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). - roll.when.when?: (context: ExitContext) => boolean; default: not declared — Arbitrary exit predicate (OR-combined with the declarative triggers). - roll.when.when(context): ExitContext; default: not declared - roll.when.when(context).asOf: number; default: not declared - roll.when.when(context).daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - roll.when.when(context).entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - roll.when.when(context).greeks: Greeks; default: not declared - roll.when.when(context).markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - roll.when.when(context).netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - roll.when.when(context).pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - roll.when.when(context).position: Position; default: not declared - roll.when.when(context).snapshot: ChainSnapshot; default: not declared - rules?: readonly EntryRule[]; default: not declared — Several rules at once (Stage 4.6): each a member of the book, entered in order at every snapshot. - slippage?: SlippageModel; default: not declared — Slippage model for option trades (default none). - slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - slippage.fill(input).quantity: number; default: not declared - slippage.fill(input).referencePrice: number; default: not declared - slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - slippage.label: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#OptionsBacktestDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionsBacktestDiagnostics extends Diagnostics { snapshotCount: number; tradeCount: number; openAtEnd: number; limitRejectionCount: number; fillRejectionCount: number; earlyAssignmentCount: number; corporateActionsApplied: number; /** The ledger's NAV minus the engine's equity at the worst mark — always 0 within 1e-6. */ reconciliationResidual: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - corporateActionsApplied: number; default: not declared - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - earlyAssignmentCount: number; default: not declared - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - fillRejectionCount: number; default: not declared - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - limitRejectionCount: number; default: not declared - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - openAtEnd: number; default: not declared - reconciliationResidual: number; default: not declared — The ledger's NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - snapshotCount: number; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - tradeCount: number; default: not declared - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/backtest/options#OptionsBacktestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The result of an options backtest. ```typescript /** The result of an options backtest. */ export interface OptionsBacktestResult { points: EquityPoint[]; returns: number[]; trades: OptionsTrade[]; settlements: OptionSettlement[]; /** Every fill the book placed — the same `NormalizedFill`s the ledger folded (Decision 2). */ fills: NormalizedFill[]; finalValue: number; performance: PerformanceSummary; assumptions: OptionsBacktestAssumptions; diagnostics: OptionsBacktestDiagnostics; /** Stage 4.6: the book's rows and the ledger. */ limitRejections: LimitRejection[]; fillRejections: FillRejection[]; surface: SurfaceRow[]; ledger: PortfolioLedgerSnapshot; timeline: PortfolioTimelineResult; /** Content-addressed identity of the request (callbacks recorded as such). */ runId: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: OptionsBacktestAssumptions; default: not declared - assumptions.assignment: 'none' | 'model'; default: not declared - assumptions.baseCurrency: string; default: not declared - assumptions.book: { maximumOpenPositions: number; maximumPerUnderlying: number | null; }; default: not declared — Stage 4.6: the book, the limits, the fill policy, the freshness policy, and the rules. - assumptions.book.maximumOpenPositions: number; default: not declared - assumptions.book.maximumPerUnderlying: number | null; default: not declared - assumptions.commission: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.corporateActions: number; default: not declared - assumptions.dividendYield: number; default: not declared - assumptions.dividends: number; default: not declared - assumptions.fillPolicy: { mode: 'combo' | 'legged'; partialFill: 'reject' | 'allow'; price: PriceSource; }; default: not declared - assumptions.fillPolicy.mode: 'combo' | 'legged'; default: not declared - assumptions.fillPolicy.partialFill: 'reject' | 'allow'; default: not declared - assumptions.fillPolicy.price: PriceSource; default: not declared - assumptions.hedge: number | 'none'; default: not declared — Delta-hedge band in share-equivalents, or `'none'`. - assumptions.initialCapital: number; default: not declared - assumptions.ledger: { accountId: string; lotRelief: string; sourceId: string; }; default: not declared - assumptions.ledger.accountId: string; default: not declared - assumptions.ledger.lotRelief: string; default: not declared - assumptions.ledger.sourceId: string; default: not declared - assumptions.limits: { maximumConcentration: number | null; maximumMarginFraction: number | null; maximumNetDelta: number | null; maximumNetVega: number | null; scenarioLoss: { spotShocks: number[]; volatilityShocks: number[]; maximumLossFraction: number; } | null; }; default: not declared - assumptions.limits.maximumConcentration: number | null; default: not declared - assumptions.limits.maximumMarginFraction: number | null; default: not declared - assumptions.limits.maximumNetDelta: number | null; default: not declared - assumptions.limits.maximumNetVega: number | null; default: not declared - assumptions.limits.scenarioLoss: { maximumLossFraction: number; spotShocks: number[]; volatilityShocks: number[]; } | null; default: not declared - assumptions.limits.scenarioLoss.maximumLossFraction: number; default: not declared - assumptions.limits.scenarioLoss.spotShocks: number[]; default: not declared - assumptions.limits.scenarioLoss.volatilityShocks: number[]; default: not declared - assumptions.marking: AppliedMarkingPolicy; default: not declared — The applied marking and missing-mark policies (Preview P1). - assumptions.marking.maximumQuoteAgeMs: number | null; default: not declared - assumptions.marking.missingMark: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared - assumptions.marking.volatility: 'current-quote' | 'entry'; default: not declared - assumptions.periodsPerYear: number; default: not declared - assumptions.priceSource: PriceSource; default: not declared — Fill price source for entries/exits. - assumptions.quoteFreshness: { maximumQuoteAgeMs: number | null; }; default: not declared - assumptions.quoteFreshness.maximumQuoteAgeMs: number | null; default: not declared - assumptions.replayable: boolean; default: not declared — `false` exactly when a caller function (a `build`, a `when`) participated. - assumptions.riskFreeRate: number; default: not declared - assumptions.rules: { id: string; structure: string; }[]; default: not declared - assumptions.sizing: 'fixed-quantity' | 'margin-aware'; default: not declared — How positions were sized. - assumptions.slippage: string; default: not declared - diagnostics: OptionsBacktestDiagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.corporateActionsApplied: number; default: not declared - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.earlyAssignmentCount: number; default: not declared - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.fillRejectionCount: number; default: not declared - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.limitRejectionCount: number; default: not declared - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.openAtEnd: number; default: not declared - diagnostics.reconciliationResidual: number; default: not declared — The ledger's NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.snapshotCount: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.tradeCount: number; default: not declared - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fillRejections: FillRejection[]; default: not declared - fills: NormalizedFill[]; default: not declared — Every fill the book placed — the same `NormalizedFill`s the ledger folded (Decision 2). - finalValue: number; default: not declared - ledger: PortfolioLedgerSnapshot; default: not declared - ledger.baseCurrency: string; default: not declared - ledger.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.kind: 'totalfinance.portfolio-ledger'; default: not declared - ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - ledger.portfolioId?: string; default: not declared - ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - ledger.provenance.asOf?: number; default: not declared - ledger.provenance.dataset?: string; default: not declared - ledger.provenance.provider?: string; default: not declared - ledger.provenance.receivedAt?: number; default: not declared - ledger.provenance.requestId?: string; default: not declared - ledger.provenance.sourceVersion?: string; default: not declared - ledger.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - ledger.schemaVersion: number; default: not declared - limitRejections: LimitRejection[]; default: not declared — Stage 4.6: the book's rows and the ledger. - performance: PerformanceSummary; default: not declared - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - points: EquityPoint[]; default: not declared - returns: number[]; default: not declared - runId: string; default: not declared — Content-addressed identity of the request (callbacks recorded as such). - settlements: OptionSettlement[]; default: not declared - surface: SurfaceRow[]; default: not declared - timeline: PortfolioTimelineResult; default: not declared - timeline.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - timeline.assumptions.conventionsVersion: string; default: not declared - timeline.assumptions.exposureConvention: string; default: not declared - timeline.assumptions.indexConvention: string; default: not declared - timeline.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - timeline.assumptions.markInstant: string; default: not declared - timeline.baseCurrency: string; default: not declared - timeline.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - timeline.cumulativePnl.financing: number; default: not declared - timeline.cumulativePnl.foreignExchangePnl: number; default: not declared - timeline.cumulativePnl.income: number; default: not declared - timeline.cumulativePnl.realizedPnl: number; default: not declared - timeline.cumulativePnl.residual: number; default: not declared - timeline.cumulativePnl.totalPnl: number; default: not declared - timeline.cumulativePnl.transactionCosts: number; default: not declared - timeline.cumulativePnl.unrealizedPnl: number; default: not declared - timeline.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - timeline.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - timeline.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - timeline.diagnostics.markCount: number; default: not declared - timeline.diagnostics.warnings: string[]; default: not declared - timeline.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - timeline.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - timeline.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - timeline.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - trades: OptionsTrade[]; default: not declared ### @insiderfinance/totalfinance/backtest/options#OptionsTearSheet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionsTearSheet { performance: PerformanceSummary; returns: ReturnStatistics; options: OptionsTradeStatistics; byStructure: StructureAttribution[]; byLegRole: LegRoleAttribution[]; /** Strategy-level greek P&L decomposition (summed per-trade explains). */ greekAttribution: GreekAttribution; /** Echoed from the source backtest — never dropped (the envelope law). */ assumptions: OptionsBacktestAssumptions; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: OptionsBacktestAssumptions; default: not declared — Echoed from the source backtest — never dropped (the envelope law). - assumptions.assignment: 'none' | 'model'; default: not declared - assumptions.baseCurrency: string; default: not declared - assumptions.book: { maximumOpenPositions: number; maximumPerUnderlying: number | null; }; default: not declared — Stage 4.6: the book, the limits, the fill policy, the freshness policy, and the rules. - assumptions.book.maximumOpenPositions: number; default: not declared - assumptions.book.maximumPerUnderlying: number | null; default: not declared - assumptions.commission: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.corporateActions: number; default: not declared - assumptions.dividendYield: number; default: not declared - assumptions.dividends: number; default: not declared - assumptions.fillPolicy: { mode: 'combo' | 'legged'; partialFill: 'reject' | 'allow'; price: import('@insiderfinance/totalfinance/core').PriceSource; }; default: not declared - assumptions.fillPolicy.mode: 'combo' | 'legged'; default: not declared - assumptions.fillPolicy.partialFill: 'reject' | 'allow'; default: not declared - assumptions.fillPolicy.price: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared - assumptions.hedge: number | 'none'; default: not declared — Delta-hedge band in share-equivalents, or `'none'`. - assumptions.initialCapital: number; default: not declared - assumptions.ledger: { accountId: string; lotRelief: string; sourceId: string; }; default: not declared - assumptions.ledger.accountId: string; default: not declared - assumptions.ledger.lotRelief: string; default: not declared - assumptions.ledger.sourceId: string; default: not declared - assumptions.limits: { maximumConcentration: number | null; maximumMarginFraction: number | null; maximumNetDelta: number | null; maximumNetVega: number | null; scenarioLoss: { spotShocks: number[]; volatilityShocks: number[]; maximumLossFraction: number; } | null; }; default: not declared - assumptions.limits.maximumConcentration: number | null; default: not declared - assumptions.limits.maximumMarginFraction: number | null; default: not declared - assumptions.limits.maximumNetDelta: number | null; default: not declared - assumptions.limits.maximumNetVega: number | null; default: not declared - assumptions.limits.scenarioLoss: { maximumLossFraction: number; spotShocks: number[]; volatilityShocks: number[]; } | null; default: not declared - assumptions.limits.scenarioLoss.maximumLossFraction: number; default: not declared - assumptions.limits.scenarioLoss.spotShocks: number[]; default: not declared - assumptions.limits.scenarioLoss.volatilityShocks: number[]; default: not declared - assumptions.marking: import('@insiderfinance/totalfinance/backtest/options').AppliedMarkingPolicy; default: not declared — The applied marking and missing-mark policies (Preview P1). - assumptions.marking.maximumQuoteAgeMs: number | null; default: not declared - assumptions.marking.missingMark: 'refuse' | 'entry-volatility' | 'carry-last-volatility'; default: not declared - assumptions.marking.volatility: 'current-quote' | 'entry'; default: not declared - assumptions.periodsPerYear: number; default: not declared - assumptions.priceSource: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — Fill price source for entries/exits. - assumptions.quoteFreshness: { maximumQuoteAgeMs: number | null; }; default: not declared - assumptions.quoteFreshness.maximumQuoteAgeMs: number | null; default: not declared - assumptions.replayable: boolean; default: not declared — `false` exactly when a caller function (a `build`, a `when`) participated. - assumptions.riskFreeRate: number; default: not declared - assumptions.rules: { id: string; structure: string; }[]; default: not declared - assumptions.sizing: 'fixed-quantity' | 'margin-aware'; default: not declared — How positions were sized. - assumptions.slippage: string; default: not declared - byLegRole: LegRoleAttribution[]; default: not declared - byStructure: StructureAttribution[]; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greekAttribution: GreekAttribution; default: not declared — Strategy-level greek P&L decomposition (summed per-trade explains). - greekAttribution.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - greekAttribution.delta: number; default: not declared — Delta term: `Δ·dS`. - greekAttribution.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - greekAttribution.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - greekAttribution.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - greekAttribution.rho: number; default: not declared — Rho term: `Rho·dr`. - greekAttribution.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - greekAttribution.theta: number; default: not declared — Theta term: `Θ·dt`. - greekAttribution.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - greekAttribution.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - greekAttribution.total: number; default: not declared — The actual realized P&L. - greekAttribution.trades: number; default: not declared — Number of trades summed (every trade in the result, closed and open-at-end). - greekAttribution.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - greekAttribution.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - greekAttribution.vega: number; default: not declared — Vega term: `Vega·dσ`. - greekAttribution.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - greekAttribution.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - greekAttribution.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). - options: OptionsTradeStatistics; default: not declared - options.assignments: number; default: not declared — Number of legs assigned at expiry (short, ITM). - options.averageCredit: number; default: not declared — Average credit received on credit trades (entry premium < 0); 0 when there are none. - options.averageDaysHeld: number; default: not declared — Average calendar days a closed trade was held. - options.averagePnl: number; default: not declared — Average realized P&L per closed trade, in account currency. - options.closed: number; default: not declared — Closed round-trips (excludes any position still open at the end). - options.losses: number; default: not declared - options.totalCosts: number; default: not declared — Total commission + slippage across all trades. - options.winRate: number | null; default: not declared — `wins / (wins + losses)`. `null` when there are no decided trades — disclosed via a `performance.undefined_metric` warning, never NaN (Law 7). - options.wins: number; default: not declared - performance: PerformanceSummary; default: not declared - performance.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - performance.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.annualizedVolatility: number | null; default: not declared - performance.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - performance.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - performance.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - performance.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - performance.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - performance.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.drawdown: import('@insiderfinance/totalfinance/performance').DrawdownResult; default: not declared - performance.drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - performance.drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - performance.drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - performance.drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - performance.drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - performance.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - performance.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - performance.maxDrawdown: number; default: not declared - performance.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.periods: number; default: not declared - performance.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - performance.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - performance.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - performance.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - performance.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. - returns: ReturnStatistics; default: not declared - returns.averageLoss: number; default: not declared - returns.averageWin: number; default: not declared - returns.bestPeriod: number; default: not declared - returns.expectancy: number | null; default: not declared — Mean per-bar return. `null` on an EMPTY series (no bars to average), disclosed the same way — matches `@insiderfinance/totalfinance/performance`'s `analyze().expectancy`, which never reports a fabricated `0`. - returns.hitRate: number | null; default: not declared — Fraction of non-zero return bars that were positive. `null` when the series has NO non-zero bar — there is no win/loss population to take a fraction of, so the metric is undefined and is disclosed via a `performance.undefined_metric` warning rather than reported as a `0` hit rate (which reads as "every bar lost"). Matches `@insiderfinance/totalfinance/performance`'s `analyze().hitRate`. - returns.profitFactor: number | null; default: not declared — Σ gains ÷ |Σ losses|. `null` when there are gains but NO losses — the ratio has no finite value, so it is disclosed via a `performance.undefined_metric` warning, never `Infinity` (Law 7). `0` when there are no gains either. - returns.worstPeriod: number; default: not declared ### @insiderfinance/totalfinance/backtest/options#OptionsTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One round-trip options trade in the backtest. ```typescript /** One round-trip options trade in the backtest. */ export interface OptionsTrade { /** The structure as classified/constructed (e.g. `'bullPutSpread'`). */ structure: string; entryAsOf: EpochMs; /** Exit time, or `null` if still open at the end of the run. */ exitAsOf: EpochMs | null; expiry: string; contracts: number; /** Signed entry premium (positive = debit paid, negative = credit received), in account currency. */ entryPremium: number; /** Realized P&L over the trade, net of costs, in account currency. */ realizedPnl: number; /** Total commission + slippage paid on entry and exit. */ costs: number; exitReason: ExitReason; perLeg: LegAttribution[]; legs: readonly Leg[]; /** * Greek P&L attribution of the trade's gross mark P&L (entry → exit), via `explainPositionPnl`. The * terms sum to `total` (≈ `realizedPnl + costs`); the `unexplained` residual is 3rd-order-and-higher. * See {@link TradePnlExplain}. */ pnlExplain: TradePnlExplain; /** Where the trade's marks came from, counted over every open snapshot (Preview P1). */ marks: TradeMarkCounts; /** * The volatility each leg was LAST marked at, aligned to `legs` — `null` for a stock leg or a leg * priced at intrinsic (expired/settled). Under `'current-quote'` this is the exit contract's * volatility; under `'entry'` it is the entry volatility. */ exitVolatilities: (number | null)[]; /** The book identity (Stage 4.6). */ tradeId: number; ruleId: string; underlying: string; /** Ledger instrument ids aligned to `legs` (OCC symbols for options, the underlying for stock). */ legInstrumentIds: string[]; /** Corporate actions applied while the trade was open, oldest first. */ lineage: TradeLineage[]; /** True when a legged fill held fewer legs than the structure names. */ partial: boolean; unfilledLegs: UnfilledLeg[]; /** Legs settled before the trade closed (a calendar's near leg, an early assignment), aligned to `legs` by `legIndex`. */ legSettlements: Array<{ legIndex: number; settlement: OptionSettlement; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contracts: number; default: not declared - costs: number; default: not declared — Total commission + slippage paid on entry and exit. - entryAsOf: number; default: not declared - entryPremium: number; default: not declared — Signed entry premium (positive = debit paid, negative = credit received), in account currency. - exitAsOf: number | null; default: not declared — Exit time, or `null` if still open at the end of the run. - exitReason: ExitReason; default: not declared - exitVolatilities: (number | null)[]; default: not declared — The volatility each leg was LAST marked at, aligned to `legs` — `null` for a stock leg or a leg priced at intrinsic (expired/settled). Under `'current-quote'` this is the exit contract's volatility; under `'entry'` it is the entry volatility. - expiry: string; default: not declared - legInstrumentIds: string[]; default: not declared — Ledger instrument ids aligned to `legs` (OCC symbols for options, the underlying for stock). - legSettlements: { legIndex: number; settlement: OptionSettlement; }[]; default: not declared — Legs settled before the trade closed (a calendar's near leg, an early assignment), aligned to `legs` by `legIndex`. - legs: readonly Leg[]; default: not declared - lineage: TradeLineage[]; default: not declared — Corporate actions applied while the trade was open, oldest first. - marks: TradeMarkCounts; default: not declared — Where the trade's marks came from, counted over every open snapshot (Preview P1). - marks.carried: number; default: not declared - marks.currentQuote: number; default: not declared - marks.entryVolatility: number; default: not declared — The `'entry'` policy AND the `'entry-volatility'` fallback. - marks.impliedFromPrice: number; default: not declared - marks.snapshots: number; default: not declared — Snapshots on which the trade was open and marked. - partial: boolean; default: not declared — True when a legged fill held fewer legs than the structure names. - perLeg: LegAttribution[]; default: not declared - pnlExplain: TradePnlExplain; default: not declared — Greek P&L attribution of the trade's gross mark P&L (entry → exit), via `explainPositionPnl`. The terms sum to `total` (≈ `realizedPnl + costs`); the `unexplained` residual is 3rd-order-and-higher. See {@link TradePnlExplain}. - pnlExplain.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - pnlExplain.delta: number; default: not declared — Delta term: `Δ·dS`. - pnlExplain.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - pnlExplain.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - pnlExplain.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - pnlExplain.rho: number; default: not declared — Rho term: `Rho·dr`. - pnlExplain.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - pnlExplain.theta: number; default: not declared — Theta term: `Θ·dt`. - pnlExplain.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - pnlExplain.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - pnlExplain.total: number; default: not declared — The actual realized P&L. - pnlExplain.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - pnlExplain.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - pnlExplain.vega: number; default: not declared — Vega term: `Vega·dσ`. - pnlExplain.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - pnlExplain.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - pnlExplain.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). - realizedPnl: number; default: not declared — Realized P&L over the trade, net of costs, in account currency. - ruleId: string; default: not declared - structure: string; default: not declared — The structure as classified/constructed (e.g. `'bullPutSpread'`). - tradeId: number; default: not declared — The book identity (Stage 4.6). - underlying: string; default: not declared - unfilledLegs: UnfilledLeg[]; default: not declared ### @insiderfinance/totalfinance/backtest/options#OptionsTradeStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options-strategy summary stats over the closed trades. ```typescript /** Options-strategy summary stats over the closed trades. */ export interface OptionsTradeStatistics { /** Closed round-trips (excludes any position still open at the end). */ closed: number; wins: number; losses: number; /** * `wins / (wins + losses)`. `null` when there are no decided trades — disclosed via a * `performance.undefined_metric` warning, never NaN (Law 7). */ winRate: number | null; /** Average credit received on credit trades (entry premium < 0); 0 when there are none. */ averageCredit: number; /** Average realized P&L per closed trade, in account currency. */ averagePnl: number; /** Average calendar days a closed trade was held. */ averageDaysHeld: number; /** Total commission + slippage across all trades. */ totalCosts: number; /** Number of legs assigned at expiry (short, ITM). */ assignments: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assignments: number; default: not declared — Number of legs assigned at expiry (short, ITM). - averageCredit: number; default: not declared — Average credit received on credit trades (entry premium < 0); 0 when there are none. - averageDaysHeld: number; default: not declared — Average calendar days a closed trade was held. - averagePnl: number; default: not declared — Average realized P&L per closed trade, in account currency. - closed: number; default: not declared — Closed round-trips (excludes any position still open at the end). - losses: number; default: not declared - totalCosts: number; default: not declared — Total commission + slippage across all trades. - winRate: number | null; default: not declared — `wins / (wins + losses)`. `null` when there are no decided trades — disclosed via a `performance.undefined_metric` warning, never NaN (Law 7). - wins: number; default: not declared ### @insiderfinance/totalfinance/backtest/options#PortfolioLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pre-trade limits evaluated on the post-trade book; a breach rejects the entry with a row. ```typescript /** Pre-trade limits evaluated on the post-trade book; a breach rejects the entry with a row. */ export interface PortfolioLimits { /** `optionsMargin` of the whole book ≤ fraction × equity. */ maximumMarginFraction?: number; /** |Σ share-equivalent delta| per underlying ≤ this many shares. */ maximumNetDelta?: number; /** |Σ vega| per underlying (account currency per 1.00 volatility) ≤ this. */ maximumNetVega?: number; /** Premium at risk (Σ |entry premium|) in one underlying ≤ fraction × equity. */ maximumConcentration?: number; /** The book's worst Taylor P&L over the shock grid (`scenarioGrid`) may not exceed fraction × equity. */ scenarioLoss?: { /** Spot shocks as fractions (e.g. −0.1 for −10%). */ spotShocks: readonly number[]; /** Absolute volatility shocks (e.g. 0.05 for +5 points). */ volatilityShocks: readonly number[]; maximumLossFraction: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumConcentration?: number; default: not declared — Premium at risk (Σ |entry premium|) in one underlying ≤ fraction × equity. - maximumMarginFraction?: number; default: not declared — `optionsMargin` of the whole book ≤ fraction × equity. - maximumNetDelta?: number; default: not declared — |Σ share-equivalent delta| per underlying ≤ this many shares. - maximumNetVega?: number; default: not declared — |Σ vega| per underlying (account currency per 1.00 volatility) ≤ this. - scenarioLoss?: { maximumLossFraction: number; spotShocks: readonly number[]; volatilityShocks: readonly number[]; }; default: not declared — The book's worst Taylor P&L over the shock grid (`scenarioGrid`) may not exceed fraction × equity. - scenarioLoss.maximumLossFraction: number; default: not declared - scenarioLoss.spotShocks: readonly number[]; default: not declared — Spot shocks as fractions (e.g. −0.1 for −10%). - scenarioLoss.volatilityShocks: readonly number[]; default: not declared — Absolute volatility shocks (e.g. 0.05 for +5 points). ### @insiderfinance/totalfinance/backtest/options#QuoteFreshnessPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A quote older than this at the decision instant cannot fill (the fill-side twin of `marking.maximumQuoteAgeMs`). ```typescript /** A quote older than this at the decision instant cannot fill (the fill-side twin of `marking.maximumQuoteAgeMs`). */ export interface QuoteFreshnessPolicy { maximumQuoteAgeMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumQuoteAgeMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/options#RollRule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Roll instead of closing flat: when the rule fires, close and immediately re-enter via `entry`. ```typescript /** Roll instead of closing flat: when the rule fires, close and immediately re-enter via `entry`. */ export interface RollRule { /** When to roll (defaults to the same triggers as {@link ExitRule}). */ when?: ExitRule; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - when?: ExitRule; default: not declared — When to roll (defaults to the same triggers as {@link ExitRule}). - when.daysToExpiry?: number; default: not declared — Close at or below this many days to expiry. - when.profitTarget?: number; default: not declared — Close when captured P&L reaches this fraction of the entry premium (e.g. `0.5` = 50%). - when.stopLoss?: number; default: not declared — Close when the loss reaches this multiple of the entry premium (e.g. `2` = 200%). - when.when?: (context: ExitContext) => boolean; default: not declared — Arbitrary exit predicate (OR-combined with the declarative triggers). - when.when(context): ExitContext; default: not declared - when.when(context).asOf: number; default: not declared - when.when(context).daysToExpiry: number; default: not declared — Calendar days to expiry (nearest leg for a multi-expiry structure). - when.when(context).entryPremium: number; default: not declared — Signed entry premium (positive = net debit paid, negative = net credit received). - when.when(context).greeks: Greeks; default: not declared - when.when(context).markToMarket: number; default: not declared — Current mark-to-market P&L of the position, in account currency. - when.when(context).netDelta: number; default: not declared — Aggregate share-equivalent delta of the position. - when.when(context).pnlFraction: number; default: not declared — `mtm / |entryPremium|` — the fraction of the entry premium captured (+) or lost (−). - when.when(context).position: Position; default: not declared - when.when(context).snapshot: ChainSnapshot; default: not declared ### @insiderfinance/totalfinance/backtest/options#Sizing Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How to size a position: a fixed contract count, or margin-aware (largest count within a budget). ```typescript /** How to size a position: a fixed contract count, or margin-aware (largest count within a budget). */ export type Sizing = { quantity: number; } | { maxMarginFraction: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxMarginFraction: number; default: not declared - quantity: number; default: not declared ### @insiderfinance/totalfinance/backtest/options#StructureAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Realized P&L grouped by the constructed structure (e.g. `bullPutSpread`). ```typescript /** Realized P&L grouped by the constructed structure (e.g. `bullPutSpread`). */ export interface StructureAttribution { structure: string; trades: number; realizedPnl: number; /** `null` when the group has no decided (non-zero P&L) trades — disclosed, never NaN (Law 7). */ winRate: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - realizedPnl: number; default: not declared - structure: string; default: not declared - trades: number; default: not declared - winRate: number | null; default: not declared — `null` when the group has no decided (non-zero P&L) trades — disclosed, never NaN (Law 7). ### @insiderfinance/totalfinance/backtest/options#SurfaceRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The volatility surface's evolution, one row per snapshot (bounded by the snapshot count). ```typescript /** The volatility surface's evolution, one row per snapshot (bounded by the snapshot count). */ export interface SurfaceRow { asOf: EpochMs; /** At-the-money implied volatility per listed expiry (the nearest strike to spot with a volatility). */ atTheMoneyVolatilityByExpiry: Record; /** IV(25Δ put) − IV(25Δ call) of the nearest listed expiry, or `null` when the chain carries no deltas. */ skew25Delta: number | null; /** Where this snapshot's leg marks came from, across every open trade. */ markSources: TradeMarkCounts; dividendRisk: DividendRiskRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - atTheMoneyVolatilityByExpiry: Record; default: not declared — At-the-money implied volatility per listed expiry (the nearest strike to spot with a volatility). - dividendRisk: DividendRiskRow[]; default: not declared - markSources: TradeMarkCounts; default: not declared — Where this snapshot's leg marks came from, across every open trade. - markSources.carried: number; default: not declared - markSources.currentQuote: number; default: not declared - markSources.entryVolatility: number; default: not declared — The `'entry'` policy AND the `'entry-volatility'` fallback. - markSources.impliedFromPrice: number; default: not declared - markSources.snapshots: number; default: not declared — Snapshots on which the trade was open and marked. - skew25Delta: number | null; default: not declared — IV(25Δ put) − IV(25Δ call) of the nearest listed expiry, or `null` when the chain carries no deltas. ### @insiderfinance/totalfinance/backtest/options#TradeLineage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A corporate action applied to an open trade's legs, with what changed. ```typescript /** A corporate action applied to an open trade's legs, with what changed. */ export interface TradeLineage { lineageId: string; action: CorporateAction['type']; effectiveDate: string; asOf: EpochMs; previous: { underlying: string; strikes: number[]; multiplier: number; }; adjusted: { underlying: string; strikes: number[]; multiplier: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - action: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; default: not declared - adjusted: { underlying: string; strikes: number[]; multiplier: number; }; default: not declared - adjusted.multiplier: number; default: not declared - adjusted.strikes: number[]; default: not declared - adjusted.underlying: string; default: not declared - asOf: number; default: not declared - effectiveDate: string; default: not declared - lineageId: string; default: not declared - previous: { underlying: string; strikes: number[]; multiplier: number; }; default: not declared - previous.multiplier: number; default: not declared - previous.strikes: number[]; default: not declared - previous.underlying: string; default: not declared ### @insiderfinance/totalfinance/backtest/options#TradeMarkCounts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How many leg-snapshot marks of a trade came from each source (Preview P1 evidence). ```typescript /** How many leg-snapshot marks of a trade came from each source (Preview P1 evidence). */ export interface TradeMarkCounts { /** Snapshots on which the trade was open and marked. */ snapshots: number; currentQuote: number; impliedFromPrice: number; /** The `'entry'` policy AND the `'entry-volatility'` fallback. */ entryVolatility: number; carried: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - carried: number; default: not declared - currentQuote: number; default: not declared - entryVolatility: number; default: not declared — The `'entry'` policy AND the `'entry-volatility'` fallback. - impliedFromPrice: number; default: not declared - snapshots: number; default: not declared — Snapshots on which the trade was open and marked. ### @insiderfinance/totalfinance/backtest/options#TradePnlExplain Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A closed trade's **greek P&L explain** (entry → exit): the realized gross mark P&L decomposed into greek contributions (the full 2nd-order Taylor + dividend carry) plus an honest `unexplained` residual, via `@insiderfinance/totalfinance/risk`'s `explainPositionPnl`. These are the **bare terms** — the backtest result carries the report envelope (`assumptions`/`diagnostics`) at the top level, so a per-trade row stays a plain record (matching `perLeg`). The terms sum exactly to `total`, which is anchored to the trade's gross (pre-cost) P&L: `total === realizedPnl + costs`. (The day-0 entry edge — fill vs. model mark — is a model/data effect, so it lives in `unexplained`, not a greek term.) Under the default `'current-quote'` marking (Preview P1) each leg is re-marked from its current contract quote, so `vega` (with `vanna`/`vomma`/`veta`) is a live term attributed per leg from the entry volatility to the exit volatility; under `marking.volatility: 'entry'` the leg volatility is held for the trade and those terms stay ~0. The rate is held fixed across the trade. See `explainPositionPnl` for the per-leg vol-attribution contract. ```typescript /** * A closed trade's **greek P&L explain** (entry → exit): the realized gross mark P&L decomposed into * greek contributions (the full 2nd-order Taylor + dividend carry) plus an honest `unexplained` * residual, via `@insiderfinance/totalfinance/risk`'s `explainPositionPnl`. These are the **bare terms** — * the backtest result carries the report envelope (`assumptions`/`diagnostics`) at the top level, so a * per-trade row stays a plain record (matching `perLeg`). The terms sum exactly to `total`, which is * anchored to the trade's gross (pre-cost) P&L: `total === realizedPnl + costs`. (The day-0 entry edge — * fill vs. model mark — is a model/data effect, so it lives in `unexplained`, not a greek term.) * * Under the default `'current-quote'` marking (Preview P1) each leg is re-marked from its current * contract quote, so `vega` (with `vanna`/`vomma`/`veta`) is a live term attributed per leg from the * entry volatility to the exit volatility; under `marking.volatility: 'entry'` the leg volatility is * held for the trade and those terms stay ~0. The rate is held fixed across the trade. See * `explainPositionPnl` for the per-leg vol-attribution contract. */ export type TradePnlExplain = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - delta: number; default: not declared — Delta term: `Δ·dS`. - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - rho: number; default: not declared — Rho term: `Rho·dr`. - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - theta: number; default: not declared — Theta term: `Θ·dt`. - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - total: number; default: not declared — The actual realized P&L. - unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - vega: number; default: not declared — Vega term: `Vega·dσ`. - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/backtest/options#UnfilledLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A leg a legged fill could not fill, with why. ```typescript /** A leg a legged fill could not fill, with why. */ export interface UnfilledLeg { leg: Leg; cause: 'missing' | 'ambiguous' | 'stale' | 'unpriceable'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cause: 'stale' | 'missing' | 'ambiguous' | 'unpriceable'; default: not declared - leg: Leg; default: not declared - leg.expiry?: (string) | (undefined); default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - leg.impliedVolatility?: (number) | (undefined); default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - leg.kind: ('call' | 'put') | ('stock'); default: not declared - leg.premium?: (number) | (undefined); default: not declared — Entry premium per share. - leg.price?: (number) | (undefined); default: not declared — Entry price per share. Never on an option row (a stock row's entry price). - leg.quantity: number; default: not declared — Signed shares: positive = long, negative = short. Signed contracts: positive = long, negative = short. - leg.strike?: (number) | (undefined); default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). ### @insiderfinance/totalfinance/backtest/options#optionsBacktest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function optionsBacktest(config: OptionsBacktestConfig): OptionsBacktestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config): OptionsBacktestConfig; default: not declared - (config).assignment?: 'none' | 'model'; default: not declared — American early-assignment modeling (default `'none'`; `'model'` uses the deep-ITM/ex-div heuristic). - (config).baseCurrency?: string; default: not declared — The account currency of the ledger (default `'USD'`). - (config).book?: import('@insiderfinance/totalfinance/backtest/options').BookPolicy; default: not declared — The book's capacity (default: one open trade). - (config).chains: Iterable; default: not declared — Time-ordered (or unordered — the engine sorts) chain snapshots. - (config).commission?: CostModel; default: not declared — Commission model for option trades (default none). - (config).corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared — Splits and symbol changes adjust open legs with lineage; mergers and spin-offs on an open leg refuse. - (config).dividendYield?: number; default: not declared — Continuous dividend yield for pricing (default 0). - (config).dividends?: readonly import('@insiderfinance/totalfinance/backtest/options').DividendRecord[]; default: not declared — Cash dividends: dividend-risk evidence per short call, early assignment under `assignment: 'model'`. - (config).entry?: EntryRule; default: not declared — One rule (the shipped form); exactly one of `entry` and `rules` is given. - (config).exit: ExitRule; default: not declared - (config).fillPolicy?: import('@insiderfinance/totalfinance/backtest/options').FillPolicy; default: not declared — Combo or legged fills; partial-fill policy; the per-leg fill side. - (config).hedge?: import('@insiderfinance/totalfinance/backtest/options').DeltaHedgeRule; default: not declared — Optional delta-hedging with the underlying. - (config).initialCapital?: number; default: not declared — Opening capital (default 100,000). - (config).limits?: PortfolioLimits; default: not declared — Pre-trade limits on the post-trade book. - (config).marking?: import('@insiderfinance/totalfinance/backtest/options').MarkingPolicy; default: not declared — How open legs are marked at every snapshot (default: current quote; refuse a missing mark). - (config).periodsPerYear?: number; default: not declared — Annualization factor for the performance summary (default 252). - (config).quoteFreshness?: import('@insiderfinance/totalfinance/backtest/options').QuoteFreshnessPolicy; default: not declared — Refuse fills on stale quotes. - (config).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal) for every mark-to-market price and the assignment carry. REQUIRED: a backtest that silently priced at 4% was a financial assumption nobody stated. - (config).roll?: import('@insiderfinance/totalfinance/backtest/options').RollRule; default: not declared — Roll instead of closing flat when the rule fires. - (config).rules?: readonly EntryRule[]; default: not declared — Several rules at once (Stage 4.6): each a member of the book, entered in order at every snapshot. - (config).slippage?: SlippageModel; default: not declared — Slippage model for option trades (default none). - return.assumptions: import('@insiderfinance/totalfinance/backtest/options').OptionsBacktestAssumptions; default: not declared - return.diagnostics: import('@insiderfinance/totalfinance/backtest/options').OptionsBacktestDiagnostics; default: not declared - return.fillRejections: FillRejection[]; default: not declared - return.fills: NormalizedFill[]; default: not declared — Every fill the book placed — the same `NormalizedFill`s the ledger folded (Decision 2). - return.finalValue: number; default: not declared - return.ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - return.limitRejections: LimitRejection[]; default: not declared — Stage 4.6: the book's rows and the ledger. - return.performance: import('@insiderfinance/totalfinance/performance').PerformanceSummary; default: not declared - return.points: EquityPoint[]; default: not declared - return.returns: number[]; default: not declared - return.runId: string; default: not declared — Content-addressed identity of the request (callbacks recorded as such). - return.settlements: OptionSettlement[]; default: not declared - return.surface: SurfaceRow[]; default: not declared - return.timeline: PortfolioTimelineResult; default: not declared - return.trades: OptionsTrade[]; default: not declared ### @insiderfinance/totalfinance/backtest/options#optionsTearSheet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the options tear sheet from an {@link OptionsBacktestResult}. ```typescript export declare function optionsTearSheet(result: OptionsBacktestResult): OptionsTearSheet; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (result): OptionsBacktestResult; default: not declared - (result).assumptions: OptionsBacktestAssumptions; default: not declared - (result).diagnostics: import('@insiderfinance/totalfinance/backtest/options').OptionsBacktestDiagnostics; default: not declared - (result).fillRejections: import('@insiderfinance/totalfinance/backtest/options').FillRejection[]; default: not declared - (result).fills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared — Every fill the book placed — the same `NormalizedFill`s the ledger folded (Decision 2). - (result).finalValue: number; default: not declared - (result).ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared - (result).limitRejections: import('@insiderfinance/totalfinance/backtest/options').LimitRejection[]; default: not declared — Stage 4.6: the book's rows and the ledger. - (result).performance: PerformanceSummary; default: not declared - (result).points: import('@insiderfinance/totalfinance/backtest').EquityPoint[]; default: not declared - (result).returns: number[]; default: not declared - (result).runId: string; default: not declared — Content-addressed identity of the request (callbacks recorded as such). - (result).settlements: import('@insiderfinance/totalfinance/backtest').OptionSettlement[]; default: not declared - (result).surface: import('@insiderfinance/totalfinance/backtest/options').SurfaceRow[]; default: not declared - (result).timeline: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared - (result).trades: OptionsTrade[]; default: not declared - return.assumptions: OptionsBacktestAssumptions; default: not declared — Echoed from the source backtest — never dropped (the envelope law). - return.byLegRole: LegRoleAttribution[]; default: not declared - return.byStructure: StructureAttribution[]; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.greekAttribution: GreekAttribution; default: not declared — Strategy-level greek P&L decomposition (summed per-trade explains). - return.options: OptionsTradeStatistics; default: not declared - return.performance: PerformanceSummary; default: not declared - return.returns: ReturnStatistics; default: not declared ### @insiderfinance/totalfinance/backtest/options#requireOptionsBacktestConfig Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed guard for `optionsBacktest` (Stage 4.6): the generated closed-request spec over the whole declaration, then the hand laws — the iterable `chains`, the rules and their unique ids, the book's bounds, the limits, the fill and freshness policies, the corporate actions, the dividends. `optionsBacktest` calls it first; the run artifacts call it before storing a request. ```typescript export declare function requireOptionsBacktestConfig(functionName: string, label: string, value: unknown): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared ## Entrypoint @insiderfinance/totalfinance/backtest/paper ### @insiderfinance/totalfinance/backtest/paper#CreatePaperBrokerInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CreatePaperBrokerInput { /** * The declared execution reality; default `execution.simplified()`. Restoring requires the same * declared data, callback labels and fill-model version as every submission in the journal. * Callbacks cannot serialize: callers must supply the original implementations and change their * declared identity when their behavior changes; the broker cannot verify captured closure state. */ execution?: ExecutionPolicy; /** The ledger's base currency — prices an instrument `instruments` does not describe. The broker never holds the ledger: the caller applies the events it returns. */ baseCurrency: string; /** * Complete prior paper journal, folded at construction. Submitted context and normalized fills * are required; incomplete legacy journals fail explicitly and need migration from original facts. * Restore, operate and persist must be one caller-owned transaction for concurrent processes. * The journal preserves halt's cancellations, NOT the in-memory halt flag. A durable account-wide * kill switch requires an external persisted execution gate (including when there are no orders). */ journal?: readonly ExecutionJournalEvent[]; /** The `sourceId` every journal event and ledger fill carries — `paper:` by convention. */ sourceId: string; accountId: string; /** Instrument terms by id for new orders; absent = plain cash in base currency. Restored orders use their persisted terms; conflicting supplied terms are refused. */ instruments?: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - baseCurrency: string; default: not declared — The ledger's base currency — prices an instrument `instruments` does not describe. The broker never holds the ledger: the caller applies the events it returns. - execution?: ExecutionPolicy; default: not declared — The declared execution reality; default `execution.simplified()`. Restoring requires the same declared data, callback labels and fill-model version as every submission in the journal. Callbacks cannot serialize: callers must supply the original implementations and change their declared identity when their behavior changes; the broker cannot verify captured closure state. - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: import('@insiderfinance/totalfinance/backtest/execution').ExecutionCosts; default: not declared - execution.costs.borrow?: import('@insiderfinance/totalfinance/backtest').BorrowModel; default: not declared - execution.costs.borrow.annualRate: number; default: not declared — Annualized borrow rate (decimal, e.g. `0.005` = 50 bps/yr). - execution.costs.borrow.label: string; default: not declared - execution.costs.commission: import('@insiderfinance/totalfinance/backtest').CostModel; default: not declared - execution.costs.commission.commission: (input: import('@insiderfinance/totalfinance/backtest/costs').CommissionInput) => number; default: not declared - execution.costs.commission.commission(input): import('@insiderfinance/totalfinance/backtest/costs').CommissionInput; default: not declared - execution.costs.commission.commission(input).price: number; default: not declared - execution.costs.commission.commission(input).quantity: number; default: not declared - execution.costs.commission.label: string; default: not declared - execution.costs.latency?: import('@insiderfinance/totalfinance/backtest/execution').LatencyModel; default: not declared - execution.costs.latency.label: string; default: not declared - execution.costs.latency.sessions: number; default: not declared - execution.costs.marketImpact?: import('@insiderfinance/totalfinance/backtest/execution').MarketImpactModel; default: not declared - execution.costs.marketImpact.impact: (input: { quantity: number; referencePrice: number; averageDailyVolume?: number; }) => number; default: not declared - execution.costs.marketImpact.impact(input): { averageDailyVolume?: number; quantity: number; referencePrice: number; }; default: not declared - execution.costs.marketImpact.impact(input).averageDailyVolume?: number; default: not declared - execution.costs.marketImpact.impact(input).quantity: number; default: not declared - execution.costs.marketImpact.impact(input).referencePrice: number; default: not declared - execution.costs.marketImpact.label: string; default: not declared - execution.costs.participation?: number; default: not declared — Fraction of the observation's volume one fill may take. - execution.costs.slippage: import('@insiderfinance/totalfinance/backtest').SlippageModel; default: not declared - execution.costs.slippage.fill: (input: import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput) => number; default: not declared - execution.costs.slippage.fill(input): import('@insiderfinance/totalfinance/backtest/costs').SlippageFillInput; default: not declared - execution.costs.slippage.fill(input).quantity: number; default: not declared - execution.costs.slippage.fill(input).referencePrice: number; default: not declared - execution.costs.slippage.fill(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.slippage.label: string; default: not declared - execution.costs.spread?: import('@insiderfinance/totalfinance/backtest/execution').SpreadModel; default: not declared - execution.costs.spread.halfSpread: (input: { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }) => number; default: not declared - execution.costs.spread.halfSpread(input): { referencePrice: number; side: import('@insiderfinance/totalfinance/core').OrderSide; }; default: not declared - execution.costs.spread.halfSpread(input).referencePrice: number; default: not declared - execution.costs.spread.halfSpread(input).side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - execution.costs.spread.label: string; default: not declared - execution.fill: import('@insiderfinance/totalfinance/backtest/execution').FillModel; default: not declared - execution.fill.fill: (request: import('@insiderfinance/totalfinance/backtest/execution').FillRequest) => import('@insiderfinance/totalfinance/backtest/execution').FillDecision; default: not declared - execution.fill.fill().return.clampedToPriceLimit?: boolean; default: not declared — The fill price was clamped into a session price-limit band. - execution.fill.fill().return.detail?: string; default: not declared - execution.fill.fill().return.levelsConsumed?: number; default: not declared — Order-book fills: how many levels the quantity consumed. - execution.fill.fill().return.outcome: ('filled') | ('unfilled'); default: not declared - execution.fill.fill().return.partial: boolean; default: not declared — Less than the requested quantity (participation, depth, size caps). - execution.fill.fill().return.pricePerUnit: number; default: not declared - execution.fill.fill().return.quantity: number; default: not declared - execution.fill.fill().return.reason: UnfilledReason; default: not declared - execution.fill.fill().return.reference: string; default: not declared — Which price the fill referenced — `bar.open`, `bar.touch:limit`, `quote.ask`, `book.levels`, … - execution.fill.fill(request): import('@insiderfinance/totalfinance/backtest/execution').FillRequest; default: not declared - execution.fill.fill(request).context: import('@insiderfinance/totalfinance/backtest/execution').FillContext; default: not declared - execution.fill.fill(request).observation: MarketObservation; default: not declared - execution.fill.fill(request).order: import('@insiderfinance/totalfinance/backtest/execution').OrderIntent; default: not declared - execution.fill.label: string; default: not declared - execution.fill.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared — Echoed in every result's assumptions. - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: { model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; }; default: not declared - execution.queue.model: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared — `simplified` is the default and says so; `declared` means the caller named every member. - execution.sessions?: import('@insiderfinance/totalfinance/backtest/execution').SessionRules; default: not declared - execution.sessions.auction?: 'ignore' | 'open-close-only'; default: not declared — How auction-only order types are treated by a model that has no auction: declared, never assumed. - execution.sessions.halts?: readonly import('@insiderfinance/totalfinance/backtest/execution').HaltWindow[]; default: not declared - execution.sessions.priceLimits?: readonly import('@insiderfinance/totalfinance/backtest/execution').PriceLimitWindow[]; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - instruments?: Readonly>; default: not declared — Instrument terms by id for new orders; absent = plain cash in base currency. Restored orders use their persisted terms; conflicting supplied terms are refused. - journal?: readonly ExecutionJournalEvent[]; default: not declared — Complete prior paper journal, folded at construction. Submitted context and normalized fills are required; incomplete legacy journals fail explicitly and need migration from original facts. Restore, operate and persist must be one caller-owned transaction for concurrent processes. The journal preserves halt's cancellations, NOT the in-memory halt flag. A durable account-wide kill switch requires an external persisted execution gate (including when there are no orders). - sourceId: string; default: not declared — The `sourceId` every journal event and ledger fill carries — `paper:` by convention. ### @insiderfinance/totalfinance/backtest/paper#EXECUTION_RECEIPT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const EXECUTION_RECEIPT_KIND: 'totalfinance.execution-receipt'; ``` ### @insiderfinance/totalfinance/backtest/paper#EXECUTION_RECEIPT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const EXECUTION_RECEIPT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/backtest/paper#ExecutionReceipt Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The receipt of one submission — the same object for a retry with the same key and plan. ```typescript /** The receipt of one submission — the same object for a retry with the same key and plan. */ export interface ExecutionReceipt { kind: typeof EXECUTION_RECEIPT_KIND; schemaVersion: typeof EXECUTION_RECEIPT_SCHEMA_VERSION; receiptId: string; planHash: string; grantHash: string; idempotencyKey: string; adapter: 'paper'; accountId: string; sourceId: string; submittedAt: EpochMs; /** The order states as of submission (submitted and acknowledged). */ orders: ExecutionOrderState[]; /** Fills known at submission — always empty for the paper broker (fills arrive on `step`). */ fills: NormalizedFill[]; journalEventIds: string[]; assumptions: { conventionsVersion: string; mode: 'paper'; execution: ExecutionPolicyDescription; idempotencyConvention: string; }; diagnostics: { engine: 'paper-broker'; warnings: string[]; orderCount: number; retried: boolean; }; contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - adapter: 'paper'; default: not declared - assumptions: { conventionsVersion: string; mode: 'paper'; execution: ExecutionPolicyDescription; idempotencyConvention: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.execution: ExecutionPolicyDescription; default: not declared - assumptions.execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - assumptions.execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - assumptions.execution.costs.borrow: string | null; default: not declared - assumptions.execution.costs.commission: string; default: not declared - assumptions.execution.costs.latencySessions: number | null; default: not declared - assumptions.execution.costs.marketImpact: string | null; default: not declared - assumptions.execution.costs.participation: number | null; default: not declared - assumptions.execution.costs.slippage: string; default: not declared - assumptions.execution.costs.spread: string | null; default: not declared - assumptions.execution.fill: { label: string; version: string; }; default: not declared - assumptions.execution.fill.label: string; default: not declared - assumptions.execution.fill.version: string; default: not declared - assumptions.execution.label: string; default: not declared - assumptions.execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - assumptions.execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - assumptions.execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - assumptions.execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - assumptions.execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - assumptions.execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - assumptions.execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - assumptions.execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - assumptions.execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - assumptions.execution.realism: 'simplified' | 'declared'; default: not declared - assumptions.execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - assumptions.execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - assumptions.execution.sessions.halts: number; default: not declared - assumptions.execution.sessions.priceLimits: number; default: not declared - assumptions.execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - assumptions.execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - assumptions.execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - assumptions.execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - assumptions.execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - assumptions.execution.timeInForce.expireAtSessionClose: boolean; default: not declared - assumptions.idempotencyConvention: string; default: not declared - assumptions.mode: 'paper'; default: not declared - contentHash: string; default: not declared - diagnostics: { engine: 'paper-broker'; warnings: string[]; orderCount: number; retried: boolean; }; default: not declared - diagnostics.engine: 'paper-broker'; default: not declared - diagnostics.orderCount: number; default: not declared - diagnostics.retried: boolean; default: not declared - diagnostics.warnings: string[]; default: not declared - fills: NormalizedFill[]; default: not declared — Fills known at submission — always empty for the paper broker (fills arrive on `step`). - grantHash: string; default: not declared - idempotencyKey: string; default: not declared - journalEventIds: string[]; default: not declared - kind: 'totalfinance.execution-receipt'; default: not declared - orders: ExecutionOrderState[]; default: not declared — The order states as of submission (submitted and acknowledged). - planHash: string; default: not declared - receiptId: string; default: not declared - schemaVersion: 1; default: not declared - sourceId: string; default: not declared - submittedAt: number; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperBroker Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperBroker { submit(input: PaperSubmitInput): ExecutionReceipt; step(input: PaperStepInput): PaperStepResult; cancel(input: PaperCancelInput): PaperCancelResult; deliver(input: PaperDeliverInput): PaperDeliverResult; halt(input: PaperHaltInput): PaperHaltResult; /** Clears this instance's halt only; never reopens the cancelled orders. */ resume(input: { now: EpochMs; }): { halted: false; }; /** The append-only journal so far (a frozen copy). */ journal(): ExecutionJournalEvent[]; /** The folded journal state (a frozen copy). */ state(): ExecutionJournalState; /** Open (non-terminal) order states in id order. */ openOrders(): ExecutionOrderState[]; /** Every receipt issued, in submission order. */ receipts(): ExecutionReceipt[]; describe(): PaperBrokerDescription; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cancel: (input: PaperCancelInput) => PaperCancelResult; default: not declared - cancel().return.accepted: boolean; default: not declared — False when the order was already terminal — nothing is journaled, the state says why. - cancel().return.journal: ExecutionJournalEvent[]; default: not declared - cancel().return.orderId: string; default: not declared - cancel().return.state: ExecutionOrderState; default: not declared - cancel(input): PaperCancelInput; default: not declared - cancel(input).now: number; default: not declared - cancel(input).orderId: string; default: not declared - deliver: (input: PaperDeliverInput) => PaperDeliverResult; default: not declared - deliver().return.applied: boolean; default: not declared — False for a duplicate delivery (recorded once, reported here). - deliver().return.duplicate: boolean; default: not declared - deliver().return.events: PortfolioEventEnvelope[]; default: not declared — Ledger events for a delivered fill (a late fill reaches the ledger too). - deliver().return.fill: NormalizedFill | null; default: not declared - deliver().return.fill.accountId: string; default: not declared - deliver().return.fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - deliver().return.fill.contract?: DerivativeContractTerms; default: not declared - deliver().return.fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - deliver().return.fill.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - deliver().return.fill.currency: string; default: not declared - deliver().return.fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - deliver().return.fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - deliver().return.fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - deliver().return.fill.instrumentId: string; default: not declared - deliver().return.fill.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - deliver().return.fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - deliver().return.fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - deliver().return.fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - deliver().return.fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - deliver().return.fill.settlementStyle?: SettlementStyle; default: not declared - deliver().return.fill.side: 'buy' | 'sell'; default: not declared - deliver().return.fill.venue?: string; default: not declared - deliver().return.lateFill: boolean; default: not declared - deliver().return.state: ExecutionOrderState | null; default: not declared - deliver().return.state.averageFillPrice: number | null; default: not declared — Quantity-weighted; null until a priced fill, and null again if any fill came unpriced. - deliver().return.state.cancelRequested: boolean; default: not declared - deliver().return.state.fillIds: string[]; default: not declared - deliver().return.state.filledQuantity: number; default: not declared - deliver().return.state.lastEventId: string; default: not declared - deliver().return.state.lastTimestampMs: number; default: not declared - deliver().return.state.lateFillIds: string[]; default: not declared — Fills journaled after the order was closed — the order is `unresolved` while any exist. - deliver().return.state.orderId: string; default: not declared - deliver().return.state.planHash: string; default: not declared - deliver().return.state.reason: string | null; default: not declared - deliver().return.state.reconciledEventId: string | null; default: not declared - deliver().return.state.remainingQuantity: number; default: not declared - deliver().return.state.replacedBy: string | null; default: not declared - deliver().return.state.state: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionOrderStatus; default: not declared - deliver().return.state.submittedQuantity: number; default: not declared - deliver().return.state.terminal: boolean; default: not declared - deliver(input): PaperDeliverInput; default: not declared - deliver(input).event: ExecutionJournalEvent; default: not declared - describe: () => PaperBrokerDescription; default: not declared - describe().return.accountId: string; default: not declared - describe().return.adapter: 'paper'; default: not declared - describe().return.eventCount: number; default: not declared - describe().return.execution: ExecutionPolicyDescription; default: not declared - describe().return.haltReason: string | null; default: not declared - describe().return.halted: boolean; default: not declared - describe().return.journalId: string; default: not declared - describe().return.openOrderCount: number; default: not declared - describe().return.receiptCount: number; default: not declared - describe().return.sourceId: string; default: not declared - halt: (input: PaperHaltInput) => PaperHaltResult; default: not declared - halt().return.cancelled: string[]; default: not declared - halt().return.halted: true; default: not declared - halt().return.journal: ExecutionJournalEvent[]; default: not declared - halt().return.reason: string; default: not declared - halt(input): PaperHaltInput; default: not declared - halt(input).now: number; default: not declared - halt(input).reason: string; default: not declared - journal: () => ExecutionJournalEvent[]; default: not declared — The append-only journal so far (a frozen copy). - openOrders: () => ExecutionOrderState[]; default: not declared — Open (non-terminal) order states in id order. - receipts: () => ExecutionReceipt[]; default: not declared — Every receipt issued, in submission order. - resume: (input: { now: EpochMs; }) => { halted: false; }; default: not declared — Clears this instance's halt only; never reopens the cancelled orders. - resume().return.halted: false; default: not declared - resume(input): { now: EpochMs; }; default: not declared - resume(input).now: number; default: not declared - state: () => ExecutionJournalState; default: not declared — The folded journal state (a frozen copy). - state().return.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - state().return.eventCount: number; default: not declared - state().return.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - state().return.journalId: string | null; default: not declared — Null until the first event. - state().return.orders: Record; default: not declared - state().return.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. - step: (input: PaperStepInput) => PaperStepResult; default: not declared - step().return.asOf: number; default: not declared - step().return.events: PortfolioEventEnvelope[]; default: not declared — The ledger events for the fills (`portfolioEventsFromFill`) — the caller applies them. - step().return.expired: string[]; default: not declared - step().return.fills: NormalizedFill[]; default: not declared - step().return.journal: ExecutionJournalEvent[]; default: not declared - step().return.open: string[]; default: not declared — Orders still open after the step. - step().return.unfilled: { orderId: string; reason: UnfilledReason | 'already-observed' | 'observation-before-submission' | 'combo-leg-unfilled' | 'combo-net-limit'; detail: string; }[]; default: not declared — Why an open order did not fill this step. `already-observed`: the observation is not newer than the last one this order consumed. `observation-before-submission` (B6): the observation predates the submission. `combo-leg-unfilled` / `combo-net-limit` (B5): a combo fills all-or-none against one observation instant, and only when its net price per combo unit meets the limit. - step(input): PaperStepInput; default: not declared - step(input).asOf: number; default: not declared — Decision time, at or after submission/latest order event and every supplied observation (an already-consumed observation may be retried at its original instant and is a no-op). Day orders expire after 24 hours from acceptance when expireAtSessionClose is enabled; no exchange calendar/session-close lookup is performed by paper. - step(input).observations: Readonly>; default: not declared — The observation each open instrument meets; missing instruments stay open. After a fill, only a strictly newer observation timestamp may fill that order again (including across restarts). Repeating or revising a consumed timestamp cannot consume its liquidity again. An observation older than the order's submission never fills it (B6). Results contain only NEW fills; previously returned accounting facts remain in journal detail.fill for recovery. - submit: (input: PaperSubmitInput) => ExecutionReceipt; default: not declared - submit().return.accountId: string; default: not declared - submit().return.adapter: 'paper'; default: not declared - submit().return.assumptions: { conventionsVersion: string; execution: ExecutionPolicyDescription; idempotencyConvention: string; mode: 'paper'; }; default: not declared - submit().return.assumptions.conventionsVersion: string; default: not declared - submit().return.assumptions.execution: ExecutionPolicyDescription; default: not declared - submit().return.assumptions.idempotencyConvention: string; default: not declared - submit().return.assumptions.mode: 'paper'; default: not declared - submit().return.contentHash: string; default: not declared - submit().return.diagnostics: { engine: 'paper-broker'; orderCount: number; retried: boolean; warnings: string[]; }; default: not declared - submit().return.diagnostics.engine: 'paper-broker'; default: not declared - submit().return.diagnostics.orderCount: number; default: not declared - submit().return.diagnostics.retried: boolean; default: not declared - submit().return.diagnostics.warnings: string[]; default: not declared - submit().return.fills: NormalizedFill[]; default: not declared — Fills known at submission — always empty for the paper broker (fills arrive on `step`). - submit().return.grantHash: string; default: not declared - submit().return.idempotencyKey: string; default: not declared - submit().return.journalEventIds: string[]; default: not declared - submit().return.kind: 'totalfinance.execution-receipt'; default: not declared - submit().return.orders: ExecutionOrderState[]; default: not declared — The order states as of submission (submitted and acknowledged). - submit().return.planHash: string; default: not declared - submit().return.receiptId: string; default: not declared - submit().return.schemaVersion: 1; default: not declared - submit().return.sourceId: string; default: not declared - submit().return.submittedAt: number; default: not declared - submit(input): PaperSubmitInput; default: not declared - submit(input).grant: AuthorizationGrant; default: not declared - submit(input).idempotencyKey: string; default: not declared - submit(input).marketAsOf: number; default: not declared - submit(input).marketHash: string; default: not declared — The market snapshot's content hash and instant at submission. - submit(input).now: number; default: not declared - submit(input).orders?: readonly TradeOrder[]; default: not declared — The orders to submit when they differ from the plan's (judged against the grant's variance). - submit(input).plan: ExecutionPlan; default: not declared - submit(input).portfolioHash: string; default: not declared — The portfolio's content hash at submission (the grant binds it). ### @insiderfinance/totalfinance/backtest/paper#PaperBrokerDescription Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperBrokerDescription { adapter: 'paper'; sourceId: string; accountId: string; journalId: string; execution: ExecutionPolicyDescription; halted: boolean; haltReason: string | null; openOrderCount: number; eventCount: number; receiptCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - adapter: 'paper'; default: not declared - eventCount: number; default: not declared - execution: ExecutionPolicyDescription; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - execution.costs.borrow: string | null; default: not declared - execution.costs.commission: string; default: not declared - execution.costs.latencySessions: number | null; default: not declared - execution.costs.marketImpact: string | null; default: not declared - execution.costs.participation: number | null; default: not declared - execution.costs.slippage: string; default: not declared - execution.costs.spread: string | null; default: not declared - execution.fill: { label: string; version: string; }; default: not declared - execution.fill.label: string; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared - execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - execution.sessions.halts: number; default: not declared - execution.sessions.priceLimits: number; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - haltReason: string | null; default: not declared - halted: boolean; default: not declared - journalId: string; default: not declared - openOrderCount: number; default: not declared - receiptCount: number; default: not declared - sourceId: string; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperCancelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperCancelInput { orderId: string; now: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - now: number; default: not declared - orderId: string; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperCancelResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperCancelResult { orderId: string; /** False when the order was already terminal — nothing is journaled, the state says why. */ accepted: boolean; journal: ExecutionJournalEvent[]; state: ExecutionOrderState; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accepted: boolean; default: not declared — False when the order was already terminal — nothing is journaled, the state says why. - journal: ExecutionJournalEvent[]; default: not declared - orderId: string; default: not declared - state: ExecutionOrderState; default: not declared - state.averageFillPrice: number | null; default: not declared — Quantity-weighted; null until a priced fill, and null again if any fill came unpriced. - state.cancelRequested: boolean; default: not declared - state.fillIds: string[]; default: not declared - state.filledQuantity: number; default: not declared - state.lastEventId: string; default: not declared - state.lastTimestampMs: number; default: not declared - state.lateFillIds: string[]; default: not declared — Fills journaled after the order was closed — the order is `unresolved` while any exist. - state.orderId: string; default: not declared - state.planHash: string; default: not declared - state.reason: string | null; default: not declared - state.reconciledEventId: string | null; default: not declared - state.remainingQuantity: number; default: not declared - state.replacedBy: string | null; default: not declared - state.state: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionOrderStatus; default: not declared - state.submittedQuantity: number; default: not declared - state.terminal: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperDeliverInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperDeliverInput { event: ExecutionJournalEvent; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - event: ExecutionJournalEvent; default: not declared - event.detail: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionJournalDetail; default: not declared - event.detail.accountId?: string; default: not declared — Paper `submitted`: the account/base-currency binding of the broker. - event.detail.artifactHash?: string; default: not declared — `proposed` / `preflighted` / `authorized` / `reconciled`: the artifact's content hash. - event.detail.baseCurrency?: string; default: not declared - event.detail.comboId?: string; default: not declared — Paper `submitted`: the combo this order is a leg of (B5), so a restored broker fills it all-or-none. - event.detail.executionPolicyHash?: string; default: not declared — Hash of the complete declared policy data and callback labels/versions; not serialized code. - event.detail.fill?: NormalizedFill; default: not declared — The complete accounting fact, including settlement and costs, for durable recovery. - event.detail.fill.accountId: string; default: not declared - event.detail.fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - event.detail.fill.contract?: DerivativeContractTerms; default: not declared - event.detail.fill.contract.expiryTimestampMs: number; default: not declared - event.detail.fill.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - event.detail.fill.contract.strikePricePerUnit: number; default: not declared - event.detail.fill.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - event.detail.fill.contract.underlyingInstrumentId: string; default: not declared - event.detail.fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - event.detail.fill.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - event.detail.fill.costs.commission?: number; default: not declared - event.detail.fill.costs.exchangeFees?: number; default: not declared - event.detail.fill.costs.regulatoryFees?: number; default: not declared - event.detail.fill.costs.slippageAdjustment?: number; default: not declared - event.detail.fill.currency: string; default: not declared - event.detail.fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - event.detail.fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - event.detail.fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - event.detail.fill.instrumentId: string; default: not declared - event.detail.fill.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - event.detail.fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - event.detail.fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - event.detail.fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - event.detail.fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - event.detail.fill.settlementStyle?: SettlementStyle; default: not declared - event.detail.fill.side: 'buy' | 'sell'; default: not declared - event.detail.fill.venue?: string; default: not declared - event.detail.fillId?: string; default: not declared — `partially-filled` / `filled`: the fill id — the ledger's `trade.fill` event id. - event.detail.instrument?: { currency: string; contractMultiplier?: number; settlementStyle?: SettlementStyle; contract?: DerivativeContractTerms; settlementLag?: 0 | 1 | 2; }; default: not declared — Paper `submitted`: instrument terms captured at submission, never replaced by restart defaults. - event.detail.instrument.contract?: DerivativeContractTerms; default: not declared - event.detail.instrument.contract.expiryTimestampMs: number; default: not declared - event.detail.instrument.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - event.detail.instrument.contract.strikePricePerUnit: number; default: not declared - event.detail.instrument.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - event.detail.instrument.contract.underlyingInstrumentId: string; default: not declared - event.detail.instrument.contractMultiplier?: number; default: not declared - event.detail.instrument.currency: string; default: not declared - event.detail.instrument.settlementLag?: 0 | 1 | 2; default: not declared — Paper currently measures this lag in 24-hour days, not exchange-calendar sessions. - event.detail.instrument.settlementStyle?: SettlementStyle; default: not declared - event.detail.netLimitPrice?: number; default: not declared — Paper `submitted`: the combo's net limit per combo unit, repeated on every leg. - event.detail.note?: string; default: not declared - event.detail.observationTimestampMs?: number; default: not declared — Paper fills: the consumed market observation's instant, preventing retry from consuming it again. - event.detail.order?: TradeOrder; default: not declared — Paper `submitted`: complete intent, with the effective time-in-force made explicit. - event.detail.order.comboId?: string; default: not declared — The multi-leg order this is a leg of (B5); the plan's `combos` names the legs and the net limit. - event.detail.order.instrumentId: string; default: not declared - event.detail.order.limitPrice?: number; default: not declared - event.detail.order.orderId: string; default: not declared - event.detail.order.plannedTimestampMs: number; default: not declared — The plan's instant — when the order was planned, never when it reached a broker. - event.detail.order.quantity: number; default: not declared - event.detail.order.side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - event.detail.order.stopPrice?: number; default: not declared - event.detail.order.submittedTimestampMs?: number; default: not declared — Stamped by the broker at submission; absent on a plan's order. A fill never consumes an observation older than it. - event.detail.order.timeInForce?: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - event.detail.order.type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared - event.detail.pricePerUnit?: number; default: not declared — `partially-filled` / `filled`: the fill price, for the average. - event.detail.quantity?: number; default: not declared — `submitted`: the submitted quantity; `partially-filled` / `filled`: the fill's quantity. - event.detail.reason?: string; default: not declared — `rejected` / `cancelled` / `expired` / `unresolved`: why. - event.detail.replacementOrderId?: string; default: not declared — `replaced`: the replacing order. - event.eventId: string; default: not declared - event.eventType: 'expired' | 'proposed' | 'preflighted' | 'authorized' | 'submitted' | 'acknowledged' | 'partially-filled' | 'filled' | 'rejected' | 'cancel-requested' | 'cancelled' | 'replaced' | 'reconciled' | 'unresolved'; default: not declared - event.idempotencyKey?: string; default: not declared - event.journalId: string; default: not declared - event.orderId: string; default: not declared - event.planHash: string; default: not declared - event.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - event.provenance.asOf?: number; default: not declared - event.provenance.dataset?: string; default: not declared - event.provenance.provider?: string; default: not declared - event.provenance.receivedAt?: number; default: not declared - event.provenance.requestId?: string; default: not declared - event.provenance.sourceVersion?: string; default: not declared - event.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - event.sourceId: string; default: not declared - event.timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperDeliverResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperDeliverResult { /** False for a duplicate delivery (recorded once, reported here). */ applied: boolean; duplicate: boolean; lateFill: boolean; /** Ledger events for a delivered fill (a late fill reaches the ledger too). */ events: PortfolioEventEnvelope[]; fill: NormalizedFill | null; state: ExecutionOrderState | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - applied: boolean; default: not declared — False for a duplicate delivery (recorded once, reported here). - duplicate: boolean; default: not declared - events: PortfolioEventEnvelope[]; default: not declared — Ledger events for a delivered fill (a late fill reaches the ledger too). - fill: NormalizedFill | null; default: not declared - fill.accountId: string; default: not declared - fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - fill.contract?: DerivativeContractTerms; default: not declared - fill.contract.expiryTimestampMs: number; default: not declared - fill.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - fill.contract.strikePricePerUnit: number; default: not declared - fill.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - fill.contract.underlyingInstrumentId: string; default: not declared - fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - fill.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - fill.costs.commission?: number; default: not declared - fill.costs.exchangeFees?: number; default: not declared - fill.costs.regulatoryFees?: number; default: not declared - fill.costs.slippageAdjustment?: number; default: not declared - fill.currency: string; default: not declared - fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - fill.instrumentId: string; default: not declared - fill.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - fill.settlementStyle?: SettlementStyle; default: not declared - fill.side: 'buy' | 'sell'; default: not declared - fill.venue?: string; default: not declared - lateFill: boolean; default: not declared - state: ExecutionOrderState | null; default: not declared - state.averageFillPrice: number | null; default: not declared — Quantity-weighted; null until a priced fill, and null again if any fill came unpriced. - state.cancelRequested: boolean; default: not declared - state.fillIds: string[]; default: not declared - state.filledQuantity: number; default: not declared - state.lastEventId: string; default: not declared - state.lastTimestampMs: number; default: not declared - state.lateFillIds: string[]; default: not declared — Fills journaled after the order was closed — the order is `unresolved` while any exist. - state.orderId: string; default: not declared - state.planHash: string; default: not declared - state.reason: string | null; default: not declared - state.reconciledEventId: string | null; default: not declared - state.remainingQuantity: number; default: not declared - state.replacedBy: string | null; default: not declared - state.state: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionOrderStatus; default: not declared - state.submittedQuantity: number; default: not declared - state.terminal: boolean; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperHaltInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperHaltInput { reason: string; now: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - now: number; default: not declared - reason: string; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperHaltResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperHaltResult { halted: true; reason: string; cancelled: string[]; journal: ExecutionJournalEvent[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cancelled: string[]; default: not declared - halted: true; default: not declared - journal: ExecutionJournalEvent[]; default: not declared - reason: string; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What the broker needs to know about an instrument to write a ledger fill for it. ```typescript /** What the broker needs to know about an instrument to write a ledger fill for it. */ export interface PaperInstrument { currency: string; contractMultiplier?: number; settlementStyle?: SettlementStyle; contract?: DerivativeContractTerms; /** Settlement lag in 24-hour days; no exchange calendar is applied. Default 0 = at the fill. */ settlementLag?: 0 | 1 | 2; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract?: DerivativeContractTerms; default: not declared - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared - currency: string; default: not declared - settlementLag?: 0 | 1 | 2; default: not declared — Settlement lag in 24-hour days; no exchange calendar is applied. Default 0 = at the fill. - settlementStyle?: SettlementStyle; default: not declared ### @insiderfinance/totalfinance/backtest/paper#PaperStepInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperStepInput { /** * The observation each open instrument meets; missing instruments stay open. After a fill, only * a strictly newer observation timestamp may fill that order again (including across restarts). * Repeating or revising a consumed timestamp cannot consume its liquidity again. An observation * older than the order's submission never fills it (B6). Results contain only NEW fills; * previously returned accounting facts remain in journal detail.fill for recovery. */ observations: Readonly>; /** Decision time, at or after submission/latest order event and every supplied observation (an * already-consumed observation may be retried at its original instant and is a no-op). Day * orders expire after 24 hours from acceptance when expireAtSessionClose is enabled; no exchange * calendar/session-close lookup is performed by paper. */ asOf: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared — Decision time, at or after submission/latest order event and every supplied observation (an already-consumed observation may be retried at its original instant and is a no-op). Day orders expire after 24 hours from acceptance when expireAtSessionClose is enabled; no exchange calendar/session-close lookup is performed by paper. - observations: Readonly>; default: not declared — The observation each open instrument meets; missing instruments stay open. After a fill, only a strictly newer observation timestamp may fill that order again (including across restarts). Repeating or revising a consumed timestamp cannot consume its liquidity again. An observation older than the order's submission never fills it (B6). Results contain only NEW fills; previously returned accounting facts remain in journal detail.fill for recovery. ### @insiderfinance/totalfinance/backtest/paper#PaperStepResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperStepResult { asOf: EpochMs; fills: NormalizedFill[]; /** The ledger events for the fills (`portfolioEventsFromFill`) — the caller applies them. */ events: PortfolioEventEnvelope[]; journal: ExecutionJournalEvent[]; expired: string[]; /** * Why an open order did not fill this step. `already-observed`: the observation is not newer than * the last one this order consumed. `observation-before-submission` (B6): the observation predates * the submission. `combo-leg-unfilled` / `combo-net-limit` (B5): a combo fills all-or-none against * one observation instant, and only when its net price per combo unit meets the limit. */ unfilled: { orderId: string; reason: UnfilledReason | 'already-observed' | 'observation-before-submission' | 'combo-leg-unfilled' | 'combo-net-limit'; detail: string; }[]; /** Orders still open after the step. */ open: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - events: PortfolioEventEnvelope[]; default: not declared — The ledger events for the fills (`portfolioEventsFromFill`) — the caller applies them. - expired: string[]; default: not declared - fills: NormalizedFill[]; default: not declared - journal: ExecutionJournalEvent[]; default: not declared - open: string[]; default: not declared — Orders still open after the step. - unfilled: { orderId: string; reason: UnfilledReason | 'already-observed' | 'observation-before-submission' | 'combo-leg-unfilled' | 'combo-net-limit'; detail: string; }[]; default: not declared — Why an open order did not fill this step. `already-observed`: the observation is not newer than the last one this order consumed. `observation-before-submission` (B6): the observation predates the submission. `combo-leg-unfilled` / `combo-net-limit` (B5): a combo fills all-or-none against one observation instant, and only when its net price per combo unit meets the limit. ### @insiderfinance/totalfinance/backtest/paper#PaperSubmitInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PaperSubmitInput { plan: ExecutionPlan; grant: AuthorizationGrant; idempotencyKey: string; now: EpochMs; /** The portfolio's content hash at submission (the grant binds it). */ portfolioHash: string; /** The market snapshot's content hash and instant at submission. */ marketHash: string; marketAsOf: EpochMs; /** The orders to submit when they differ from the plan's (judged against the grant's variance). */ orders?: readonly TradeOrder[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - grant: AuthorizationGrant; default: not declared - grant.accountId: string; default: not declared - grant.approvedBy: string; default: not declared - grant.baseCurrency: string; default: not declared - grant.comboIds: string[]; default: not declared — The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. - grant.contentHash: string; default: not declared - grant.expiresAt: number; default: not declared - grant.grantId: string; default: not declared - grant.idempotencyKeys: string[]; default: not declared — The closed set of submission keys this grant licenses — one per attempt. - grant.issuedAt: number; default: not declared - grant.kind: 'totalfinance.authorization-grant'; default: not declared - grant.marketAsOf: number; default: not declared — The market instant the preflight judged; execution must not see an older market. - grant.marketHash: string; default: not declared - grant.marketMaximumAgeMs: number; default: not declared — At execution the market may be at most this old (`now − marketAsOf`). - grant.mode: 'paper'; default: not declared - grant.orderIds: string[]; default: not declared — The plan's order ids, in plan order. - grant.planHash: string; default: not declared - grant.portfolioHash: string; default: not declared - grant.preflightHash: string; default: not declared - grant.requiredScope: string | null; default: not declared — The scope the preflight asked for (`require-approval`), or null when it allowed outright. - grant.schemaVersion: 1; default: not declared - grant.variance: import('@insiderfinance/totalfinance/portfolio/trade').GrantVariance; default: not declared - grant.variance.maximumNotionalRatio: number; default: not declared — `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. - grant.variance.maximumQuantityRatio: number; default: not declared — `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). - grant.variance.maximumSlippageBps: number; default: not declared — A limit price may sit at most this many bps from the plan's reference price. - idempotencyKey: string; default: not declared - marketAsOf: number; default: not declared - marketHash: string; default: not declared — The market snapshot's content hash and instant at submission. - now: number; default: not declared - orders?: readonly TradeOrder[]; default: not declared — The orders to submit when they differ from the plan's (judged against the grant's variance). - plan: ExecutionPlan; default: not declared - plan.accountId: string; default: not declared - plan.asOf: number; default: not declared - plan.baseCurrency: string; default: not declared - plan.combos: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - plan.contentHash: string; default: not declared - plan.evidence: string[]; default: not declared - plan.kind: 'totalfinance.execution-plan'; default: not declared - plan.orders: TradeOrder[]; default: not declared - plan.portfolioId?: string; default: not declared - plan.rationale?: string; default: not declared - plan.schemaVersion: number; default: not declared - plan.source: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanSource; default: not declared - plan.source.intentHash: string; default: not declared - plan.source.kind: ('intent') | ('rebalance-proposal'); default: not declared - plan.source.planHash: string; default: not declared - plan.source.policyContentHash: string; default: not declared - plan.trades: import('@insiderfinance/totalfinance/portfolio').TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. - portfolioHash: string; default: not declared — The portfolio's content hash at submission (the grant binds it). ### @insiderfinance/totalfinance/backtest/paper#createPaperBroker Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the paper broker over a declared execution policy and a ledger's account. Every method is explicit about time (`now` / `asOf`), every journal write folds through the transition table, every fill is a `NormalizedFill` the ledger folds unchanged, and a retry is never a second order. ```typescript export declare function createPaperBroker(input: CreatePaperBrokerInput): PaperBroker; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CreatePaperBrokerInput; default: not declared - (input).accountId: string; default: not declared - (input).baseCurrency: string; default: not declared — The ledger's base currency — prices an instrument `instruments` does not describe. The broker never holds the ledger: the caller applies the events it returns. - (input).execution?: ExecutionPolicy; default: not declared — The declared execution reality; default `execution.simplified()`. Restoring requires the same declared data, callback labels and fill-model version as every submission in the journal. Callbacks cannot serialize: callers must supply the original implementations and change their declared identity when their behavior changes; the broker cannot verify captured closure state. - (input).instruments?: Readonly>; default: not declared — Instrument terms by id for new orders; absent = plain cash in base currency. Restored orders use their persisted terms; conflicting supplied terms are refused. - (input).journal?: readonly ExecutionJournalEvent[]; default: not declared — Complete prior paper journal, folded at construction. Submitted context and normalized fills are required; incomplete legacy journals fail explicitly and need migration from original facts. Restore, operate and persist must be one caller-owned transaction for concurrent processes. The journal preserves halt's cancellations, NOT the in-memory halt flag. A durable account-wide kill switch requires an external persisted execution gate (including when there are no orders). - (input).sourceId: string; default: not declared — The `sourceId` every journal event and ledger fill carries — `paper:` by convention. - return.cancel: (input: PaperCancelInput) => PaperCancelResult; default: not declared - return.deliver: (input: PaperDeliverInput) => PaperDeliverResult; default: not declared - return.describe: () => PaperBrokerDescription; default: not declared - return.halt: (input: PaperHaltInput) => PaperHaltResult; default: not declared - return.journal: () => ExecutionJournalEvent[]; default: not declared — The append-only journal so far (a frozen copy). - return.openOrders: () => ExecutionOrderState[]; default: not declared — Open (non-terminal) order states in id order. - return.receipts: () => ExecutionReceipt[]; default: not declared — Every receipt issued, in submission order. - return.resume: (input: { now: EpochMs; }) => { halted: false; }; default: not declared — Clears this instance's halt only; never reopens the cancelled orders. - return.state: () => ExecutionJournalState; default: not declared — The folded journal state (a frozen copy). - return.step: (input: PaperStepInput) => PaperStepResult; default: not declared - return.submit: (input: PaperSubmitInput) => ExecutionReceipt; default: not declared ### @insiderfinance/totalfinance/backtest/paper#requireCreatePaperBrokerInput Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireCreatePaperBrokerInput(functionName: string, label: string, value: unknown): CreatePaperBrokerInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accountId: string; default: not declared - return.baseCurrency: string; default: not declared — The ledger's base currency — prices an instrument `instruments` does not describe. The broker never holds the ledger: the caller applies the events it returns. - return.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared — The declared execution reality; default `execution.simplified()`. Restoring requires the same declared data, callback labels and fill-model version as every submission in the journal. Callbacks cannot serialize: callers must supply the original implementations and change their declared identity when their behavior changes; the broker cannot verify captured closure state. - return.instruments?: Readonly>; default: not declared — Instrument terms by id for new orders; absent = plain cash in base currency. Restored orders use their persisted terms; conflicting supplied terms are refused. - return.journal?: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Complete prior paper journal, folded at construction. Submitted context and normalized fills are required; incomplete legacy journals fail explicitly and need migration from original facts. Restore, operate and persist must be one caller-owned transaction for concurrent processes. The journal preserves halt's cancellations, NOT the in-memory halt flag. A durable account-wide kill switch requires an external persisted execution gate (including when there are no orders). - return.sourceId: string; default: not declared — The `sourceId` every journal event and ledger fill carries — `paper:` by convention. ### @insiderfinance/totalfinance/backtest/paper#requirePaperInstrument Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requirePaperInstrument(functionName: string, label: string, value: unknown): PaperInstrument; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms; default: not declared - return.contractMultiplier?: number; default: not declared - return.currency: string; default: not declared - return.settlementLag?: 0 | 1 | 2; default: not declared — Settlement lag in 24-hour days; no exchange calendar is applied. Default 0 = at the fill. - return.settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared ## Entrypoint @insiderfinance/totalfinance/backtest/portfolio ### @insiderfinance/totalfinance/backtest/portfolio#AccountingPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AccountingPolicy { baseCurrency: string; initialCash: readonly { currency: string; amount: number; }[]; /** Default `'fifo'`. */ lotRelief?: LotReliefPolicy; /** Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. */ settlement?: Partial>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - initialCash: readonly { currency: string; amount: number; }[]; default: not declared - lotRelief?: LotReliefPolicy; default: not declared — Default `'fifo'`. - settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. ### @insiderfinance/totalfinance/backtest/portfolio#AssetClass Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The asset classes the accounting's settlement table and the classifications name. ```typescript /** The asset classes the accounting's settlement table and the classifications name. */ export type AssetClass = InstrumentKind | 'cash'; ``` ### @insiderfinance/totalfinance/backtest/portfolio#CouponRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CouponRecord { instrumentId: string; paymentDate: string; /** Per unit of quantity, > 0. */ amountPerUnit: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amountPerUnit: number; default: not declared — Per unit of quantity, > 0. - instrumentId: string; default: not declared - paymentDate: string; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#CouponTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A bond's coupon terms — accrued interest is computed from these, never fetched. ```typescript /** A bond's coupon terms — accrued interest is computed from these, never fetched. */ export interface CouponTerms { /** Annual coupon rate, decimal (0.05 = 5%). */ annualRate: number; /** Coupons per year (1, 2, 4, 12). */ paymentsPerYear: number; /** Face value per unit of quantity (default 1). */ faceValuePerUnit?: number; /** Accrual day count (default `'ACT/365F'`). */ dayCount?: 'ACT/365F' | '30/360'; /** Dated date / first accrual date, `YYYY-MM-DD`. */ issueDate: string; /** Maturity, `YYYY-MM-DD`; principal redeems at the face value on this date. */ maturityDate: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualRate: number; default: not declared — Annual coupon rate, decimal (0.05 = 5%). - dayCount?: 'ACT/365F' | '30/360'; default: not declared — Accrual day count (default `'ACT/365F'`). - faceValuePerUnit?: number; default: not declared — Face value per unit of quantity (default 1). - issueDate: string; default: not declared — Dated date / first accrual date, `YYYY-MM-DD`. - maturityDate: string; default: not declared — Maturity, `YYYY-MM-DD`; principal redeems at the face value on this date. - paymentsPerYear: number; default: not declared — Coupons per year (1, 2, 4, 12). ### @insiderfinance/totalfinance/backtest/portfolio#DatedCurrencyPairQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A dated FX quote to the base currency. ```typescript /** A dated FX quote to the base currency. */ export interface DatedCurrencyPairQuote { timestampMs: EpochMs; baseCurrency: string; quoteCurrency: string; quotePerBase: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - quoteCurrency: string; default: not declared - quotePerBase: number; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#DividendRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DividendRecord { /** The instrument the dividend is paid on. */ instrumentId: string; exDate: string; /** Per unit of quantity, > 0. */ amount: number; /** Default: the ex-date. */ payDate?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Per unit of quantity, > 0. - exDate: string; default: not declared - instrumentId: string; default: not declared — The instrument the dividend is paid on. - payDate?: string; default: not declared — Default: the ex-date. ### @insiderfinance/totalfinance/backtest/portfolio#ExternalFlowRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExternalFlowRecord { timestampMs: EpochMs; /** Contribution (> 0) or withdrawal (< 0). */ amount: number; currency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Contribution (> 0) or withdrawal (< 0). - currency: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#FillTerms Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The fill terms an adapter stamps on every fill of its instrument. ```typescript /** The fill terms an adapter stamps on every fill of its instrument. */ export type FillTerms = Pick; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract?: DerivativeContractTerms; default: not declared - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#ForwardRateRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ForwardRateRecord { instrumentId: string; timestampMs: EpochMs; /** Quote currency per base unit for the instrument's maturity. */ forwardRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forwardRate: number; default: not declared — Quote currency per base unit for the instrument's maturity. - instrumentId: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#ForwardTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A forward contract on a currency pair, marked from a caller-supplied forward-rate series. ```typescript /** A forward contract on a currency pair, marked from a caller-supplied forward-rate series. */ export interface ForwardTerms { maturityTimestampMs: EpochMs; /** The currency bought forward (one unit of quantity = one unit of this currency). */ baseCurrency: string; /** The currency paid, at `contractRate` per base unit. */ quoteCurrency: string; contractRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared — The currency bought forward (one unit of quantity = one unit of this currency). - contractRate: number; default: not declared - maturityTimestampMs: number; default: not declared - quoteCurrency: string; default: not declared — The currency paid, at `contractRate` per base unit. ### @insiderfinance/totalfinance/backtest/portfolio#FundingRateRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FundingRateRecord { instrumentId: string; timestampMs: EpochMs; /** The funding rate for the interval ending at the instant; positive = longs pay shorts. */ fundingRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fundingRate: number; default: not declared — The funding rate for the interval ending at the instant; positive = longs pay shorts. - instrumentId: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#InstrumentAdapter Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#InstrumentAdapter`. ### @insiderfinance/totalfinance/backtest/portfolio#InstrumentKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The instrument kinds with a built-in adapter, plus `custom`. ```typescript /** The instrument kinds with a built-in adapter, plus `custom`. */ export type InstrumentKind = 'equity' | 'etf' | 'option' | 'future' | 'fx-forward' | 'crypto-spot' | 'crypto-perpetual' | 'bond' | 'custom'; ``` ### @insiderfinance/totalfinance/backtest/portfolio#InstrumentSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#InstrumentSpecification`. ### @insiderfinance/totalfinance/backtest/portfolio#LatestObservations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The latest observation of each kind at or before the instant, per instrument. ```typescript /** The latest observation of each kind at or before the instant, per instrument. */ export interface LatestObservations { bar?: Bar; quote?: Quote; trade?: Trade; orderBook?: OrderBook; /** The option contract's chain quote at the instant (options). */ chainQuote?: ChainSnapshot['quotes'][number]; /** The underlying's spot at the instant (options), from the chain snapshot. */ underlyingPrice?: number; /** The forward rate at the instant (fx-forward). */ forwardRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bar?: Bar; default: not declared - bar.adjusted?: boolean; default: not declared - bar.close: number; default: not declared - bar.high: number; default: not declared - bar.low: number; default: not declared - bar.open: number; default: not declared - bar.symbol: string; default: not declared - bar.timestampMs: number; default: not declared - bar.volume?: number; default: not declared - bar.vwap?: number; default: not declared - chainQuote?: import('@insiderfinance/totalfinance/core').OptionQuote; default: not declared — The option contract's chain quote at the instant (options). - chainQuote.ask?: number; default: not declared - chainQuote.askSize?: number; default: not declared - chainQuote.bid?: number; default: not declared - chainQuote.bidSize?: number; default: not declared - chainQuote.conditions?: string[]; default: not declared - chainQuote.contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - chainQuote.contract.adjusted?: boolean; default: not declared - chainQuote.contract.currency?: string; default: not declared - chainQuote.contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - chainQuote.contract.deliverable.cash?: number; default: not declared - chainQuote.contract.deliverable.notes?: string; default: not declared - chainQuote.contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - chainQuote.contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - chainQuote.contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - chainQuote.contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - chainQuote.contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - chainQuote.contract.multiplier?: number; default: not declared - chainQuote.contract.occSymbol?: string; default: not declared - chainQuote.contract.root?: string; default: not declared - chainQuote.contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - chainQuote.contract.strike: number; default: not declared - chainQuote.contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - chainQuote.contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - chainQuote.contract.underlying: string; default: not declared - chainQuote.exchange?: string; default: not declared - chainQuote.greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - chainQuote.greeks.delta: number; default: not declared - chainQuote.greeks.gamma?: number; default: not declared - chainQuote.greeks.provenance?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeksProvenance; default: not declared - chainQuote.greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - chainQuote.greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - chainQuote.greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - chainQuote.greeks.rho?: number; default: not declared - chainQuote.greeks.theta?: number; default: not declared - chainQuote.greeks.vega?: number; default: not declared - chainQuote.impliedVolatility?: number; default: not declared - chainQuote.last?: number; default: not declared - chainQuote.mark?: number; default: not declared - chainQuote.mid?: number; default: not declared - chainQuote.openInterest?: number; default: not declared - chainQuote.timestampMs: number; default: not declared - chainQuote.underlyingPrice?: number; default: not declared - chainQuote.volume?: number; default: not declared - forwardRate?: number; default: not declared — The forward rate at the instant (fx-forward). - orderBook?: OrderBook; default: not declared - orderBook.asks: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - orderBook.bids: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - orderBook.symbol: string; default: not declared - orderBook.timestampMs: number; default: not declared - quote?: Quote; default: not declared - quote.ask: number; default: not declared - quote.askSize?: number; default: not declared - quote.bid: number; default: not declared - quote.bidSize?: number; default: not declared - quote.conditions?: string[]; default: not declared - quote.exchange?: string; default: not declared - quote.symbol: string; default: not declared - quote.timestampMs: number; default: not declared - trade?: Trade; default: not declared - trade.conditions?: string[]; default: not declared - trade.exchange?: string; default: not declared - trade.price: number; default: not declared - trade.sequence?: number; default: not declared - trade.size: number; default: not declared - trade.symbol: string; default: not declared - trade.timestampMs: number; default: not declared - underlyingPrice?: number; default: not declared — The underlying's spot at the instant (options), from the chain snapshot. ### @insiderfinance/totalfinance/backtest/portfolio#LifecycleFacts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The facts an adapter's lifecycle sees for one instrument in `(previousAsOf, asOf]`. ```typescript /** The facts an adapter's lifecycle sees for one instrument in `(previousAsOf, asOf]`. */ export interface LifecycleFacts { dividends: readonly DividendRecord[]; coupons: readonly CouponRecord[]; fundingRates: readonly FundingRateRecord[]; corporateActions: readonly CorporateAction[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - corporateActions: readonly CorporateAction[]; default: not declared - coupons: readonly CouponRecord[]; default: not declared - dividends: readonly DividendRecord[]; default: not declared - fundingRates: readonly FundingRateRecord[]; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#LifecycleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LifecycleInput { instrumentId: string; specification: InstrumentSpecification; asOf: EpochMs; previousAsOf: EpochMs | null; /** The held position, or `null` when flat. */ held: { quantity: number; contractMultiplier: number; } | null; /** The instrument's mark at the instant, when one exists. */ mark: { pricePerUnit: number; source: string; } | null; /** The underlying's mark at the instant (options, futures, perpetuals), when one exists. */ underlyingMark: number | null; facts: LifecycleFacts; /** True when this instant is the last one the run sees. */ last: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - facts: LifecycleFacts; default: not declared - facts.corporateActions: readonly CorporateAction[]; default: not declared - facts.coupons: readonly CouponRecord[]; default: not declared - facts.dividends: readonly DividendRecord[]; default: not declared - facts.fundingRates: readonly FundingRateRecord[]; default: not declared - held: { contractMultiplier: number; quantity: number; } | null; default: not declared — The held position, or `null` when flat. - held.contractMultiplier: number; default: not declared - held.quantity: number; default: not declared - instrumentId: string; default: not declared - last: boolean; default: not declared — True when this instant is the last one the run sees. - mark: { pricePerUnit: number; source: string; } | null; default: not declared — The instrument's mark at the instant, when one exists. - mark.pricePerUnit: number; default: not declared - mark.source: string; default: not declared - previousAsOf: number | null; default: not declared - specification: InstrumentSpecification; default: not declared - specification.adapter?: InstrumentAdapter; default: not declared — REQUIRED for `custom`; refused for a built-in kind. - specification.adapter.accrued?: (input: { specification: InstrumentSpecification; asOf: EpochMs; }) => number; default: not declared — Accrued interest per unit at the instant (bonds); omitted = none. - specification.adapter.accrued(input): { asOf: EpochMs; specification: InstrumentSpecification; }; default: not declared - specification.adapter.accrued(input).asOf: number; default: not declared - specification.adapter.accrued(input).specification: InstrumentSpecification; default: not declared - specification.adapter.fillTerms: (specification: InstrumentSpecification) => FillTerms; default: not declared - specification.adapter.fillTerms().return.contract?: DerivativeContractTerms; default: not declared - specification.adapter.fillTerms().return.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - specification.adapter.fillTerms().return.settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared - specification.adapter.fillTerms(specification): InstrumentSpecification; default: not declared - specification.adapter.kind: string; default: not declared - specification.adapter.lifecycle: (input: LifecycleInput) => PortfolioEvent[]; default: not declared - specification.adapter.lifecycle(input): LifecycleInput; default: not declared - specification.adapter.mark: (input: MarkInput) => MarkOutcome; default: not declared - specification.adapter.mark().return.pricePerUnit: number; default: not declared - specification.adapter.mark().return.source: string; default: not declared - specification.adapter.mark().return.unavailable: MissingMarkCause; default: not declared - specification.adapter.mark(input): MarkInput; default: not declared - specification.adapter.mark(input).asOf: number; default: not declared - specification.adapter.mark(input).instrumentId: string; default: not declared - specification.adapter.mark(input).latest: LatestObservations; default: not declared - specification.adapter.mark(input).previous: { pricePerUnit: number; source: string; } | null; default: not declared — The previous mark, when one exists. - specification.adapter.mark(input).previous.pricePerUnit: number; default: not declared - specification.adapter.mark(input).previous.source: string; default: not declared - specification.adapter.mark(input).specification: InstrumentSpecification; default: not declared - specification.adapter.version: string; default: not declared - specification.assetClass?: AssetClass; default: not declared — Default: the kind. - specification.classification?: InstrumentClassification; default: not declared - specification.classification.assetClass?: string; default: not declared - specification.classification.strategy?: string; default: not declared - specification.classification.tags?: string[]; default: not declared — Overlapping by nature — the `tag` grouping does not partition the total. - specification.classification.underlying?: string; default: not declared - specification.contract?: DerivativeContractTerms; default: not declared — REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. - specification.contract.expiryTimestampMs: number; default: not declared - specification.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - specification.contract.strikePricePerUnit: number; default: not declared - specification.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - specification.contract.underlyingInstrumentId: string; default: not declared - specification.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. - specification.coupon?: CouponTerms; default: not declared — `bond`: the coupon terms. - specification.coupon.annualRate: number; default: not declared — Annual coupon rate, decimal (0.05 = 5%). - specification.coupon.dayCount?: 'ACT/365F' | '30/360'; default: not declared — Accrual day count (default `'ACT/365F'`). - specification.coupon.faceValuePerUnit?: number; default: not declared — Face value per unit of quantity (default 1). - specification.coupon.issueDate: string; default: not declared — Dated date / first accrual date, `YYYY-MM-DD`. - specification.coupon.maturityDate: string; default: not declared — Maturity, `YYYY-MM-DD`; principal redeems at the face value on this date. - specification.coupon.paymentsPerYear: number; default: not declared — Coupons per year (1, 2, 4, 12). - specification.currency: string; default: not declared — The trading and mark currency. - specification.forward?: ForwardTerms; default: not declared — `fx-forward`: the contract. - specification.forward.baseCurrency: string; default: not declared — The currency bought forward (one unit of quantity = one unit of this currency). - specification.forward.contractRate: number; default: not declared - specification.forward.maturityTimestampMs: number; default: not declared - specification.forward.quoteCurrency: string; default: not declared — The currency paid, at `contractRate` per base unit. - specification.kind: InstrumentKind; default: not declared - specification.roll?: RollTerms; default: not declared — `future`: the declared roll. - specification.roll.sessionsBeforeExpiry: number; default: not declared - specification.roll.toInstrumentId: string; default: not declared - underlyingMark: number | null; default: not declared — The underlying's mark at the instant (options, futures, perpetuals), when one exists. ### @insiderfinance/totalfinance/backtest/portfolio#LiquidationRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LiquidationRow { asOf: EpochMs; policy: 'close-largest-loss' | 'pro-rata'; instrumentId: string; quantity: number; shortfall: number; code: typeof WarningCode.BacktestForcedLiquidation; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - code: 'backtest.forced_liquidation'; default: not declared - instrumentId: string; default: not declared - policy: 'close-largest-loss' | 'pro-rata'; default: not declared - quantity: number; default: not declared - shortfall: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#MarkInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarkInput { instrumentId: string; specification: InstrumentSpecification; asOf: EpochMs; latest: LatestObservations; /** The previous mark, when one exists. */ previous: { pricePerUnit: number; source: string; } | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - instrumentId: string; default: not declared - latest: LatestObservations; default: not declared - latest.bar?: Bar; default: not declared - latest.bar.adjusted?: boolean; default: not declared - latest.bar.close: number; default: not declared - latest.bar.high: number; default: not declared - latest.bar.low: number; default: not declared - latest.bar.open: number; default: not declared - latest.bar.symbol: string; default: not declared - latest.bar.timestampMs: number; default: not declared - latest.bar.volume?: number; default: not declared - latest.bar.vwap?: number; default: not declared - latest.chainQuote?: import('@insiderfinance/totalfinance/core').OptionQuote; default: not declared — The option contract's chain quote at the instant (options). - latest.chainQuote.ask?: number; default: not declared - latest.chainQuote.askSize?: number; default: not declared - latest.chainQuote.bid?: number; default: not declared - latest.chainQuote.bidSize?: number; default: not declared - latest.chainQuote.conditions?: string[]; default: not declared - latest.chainQuote.contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - latest.chainQuote.contract.adjusted?: boolean; default: not declared - latest.chainQuote.contract.currency?: string; default: not declared - latest.chainQuote.contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - latest.chainQuote.contract.deliverable.cash?: number; default: not declared - latest.chainQuote.contract.deliverable.notes?: string; default: not declared - latest.chainQuote.contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - latest.chainQuote.contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - latest.chainQuote.contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - latest.chainQuote.contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - latest.chainQuote.contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - latest.chainQuote.contract.multiplier?: number; default: not declared - latest.chainQuote.contract.occSymbol?: string; default: not declared - latest.chainQuote.contract.root?: string; default: not declared - latest.chainQuote.contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - latest.chainQuote.contract.strike: number; default: not declared - latest.chainQuote.contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - latest.chainQuote.contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - latest.chainQuote.contract.underlying: string; default: not declared - latest.chainQuote.exchange?: string; default: not declared - latest.chainQuote.greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - latest.chainQuote.greeks.delta: number; default: not declared - latest.chainQuote.greeks.gamma?: number; default: not declared - latest.chainQuote.greeks.provenance?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeksProvenance; default: not declared - latest.chainQuote.greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - latest.chainQuote.greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - latest.chainQuote.greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - latest.chainQuote.greeks.rho?: number; default: not declared - latest.chainQuote.greeks.theta?: number; default: not declared - latest.chainQuote.greeks.vega?: number; default: not declared - latest.chainQuote.impliedVolatility?: number; default: not declared - latest.chainQuote.last?: number; default: not declared - latest.chainQuote.mark?: number; default: not declared - latest.chainQuote.mid?: number; default: not declared - latest.chainQuote.openInterest?: number; default: not declared - latest.chainQuote.timestampMs: number; default: not declared - latest.chainQuote.underlyingPrice?: number; default: not declared - latest.chainQuote.volume?: number; default: not declared - latest.forwardRate?: number; default: not declared — The forward rate at the instant (fx-forward). - latest.orderBook?: OrderBook; default: not declared - latest.orderBook.asks: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - latest.orderBook.bids: import('@insiderfinance/totalfinance/core').OrderBookLevel[]; default: not declared - latest.orderBook.symbol: string; default: not declared - latest.orderBook.timestampMs: number; default: not declared - latest.quote?: Quote; default: not declared - latest.quote.ask: number; default: not declared - latest.quote.askSize?: number; default: not declared - latest.quote.bid: number; default: not declared - latest.quote.bidSize?: number; default: not declared - latest.quote.conditions?: string[]; default: not declared - latest.quote.exchange?: string; default: not declared - latest.quote.symbol: string; default: not declared - latest.quote.timestampMs: number; default: not declared - latest.trade?: Trade; default: not declared - latest.trade.conditions?: string[]; default: not declared - latest.trade.exchange?: string; default: not declared - latest.trade.price: number; default: not declared - latest.trade.sequence?: number; default: not declared - latest.trade.size: number; default: not declared - latest.trade.symbol: string; default: not declared - latest.trade.timestampMs: number; default: not declared - latest.underlyingPrice?: number; default: not declared — The underlying's spot at the instant (options), from the chain snapshot. - previous: { pricePerUnit: number; source: string; } | null; default: not declared — The previous mark, when one exists. - previous.pricePerUnit: number; default: not declared - previous.source: string; default: not declared - specification: InstrumentSpecification; default: not declared - specification.adapter?: InstrumentAdapter; default: not declared — REQUIRED for `custom`; refused for a built-in kind. - specification.adapter.accrued?: (input: { specification: InstrumentSpecification; asOf: EpochMs; }) => number; default: not declared — Accrued interest per unit at the instant (bonds); omitted = none. - specification.adapter.accrued(input): { asOf: EpochMs; specification: InstrumentSpecification; }; default: not declared - specification.adapter.accrued(input).asOf: number; default: not declared - specification.adapter.accrued(input).specification: InstrumentSpecification; default: not declared - specification.adapter.fillTerms: (specification: InstrumentSpecification) => FillTerms; default: not declared - specification.adapter.fillTerms().return.contract?: DerivativeContractTerms; default: not declared - specification.adapter.fillTerms().return.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - specification.adapter.fillTerms().return.settlementStyle?: import('@insiderfinance/totalfinance/portfolio').SettlementStyle; default: not declared - specification.adapter.fillTerms(specification): InstrumentSpecification; default: not declared - specification.adapter.kind: string; default: not declared - specification.adapter.lifecycle: (input: LifecycleInput) => PortfolioEvent[]; default: not declared - specification.adapter.lifecycle(input): LifecycleInput; default: not declared - specification.adapter.lifecycle(input).asOf: number; default: not declared - specification.adapter.lifecycle(input).facts: LifecycleFacts; default: not declared - specification.adapter.lifecycle(input).held: { contractMultiplier: number; quantity: number; } | null; default: not declared — The held position, or `null` when flat. - specification.adapter.lifecycle(input).held.contractMultiplier: number; default: not declared - specification.adapter.lifecycle(input).held.quantity: number; default: not declared - specification.adapter.lifecycle(input).instrumentId: string; default: not declared - specification.adapter.lifecycle(input).last: boolean; default: not declared — True when this instant is the last one the run sees. - specification.adapter.lifecycle(input).mark: { pricePerUnit: number; source: string; } | null; default: not declared — The instrument's mark at the instant, when one exists. - specification.adapter.lifecycle(input).mark.pricePerUnit: number; default: not declared - specification.adapter.lifecycle(input).mark.source: string; default: not declared - specification.adapter.lifecycle(input).previousAsOf: number | null; default: not declared - specification.adapter.lifecycle(input).specification: InstrumentSpecification; default: not declared - specification.adapter.lifecycle(input).underlyingMark: number | null; default: not declared — The underlying's mark at the instant (options, futures, perpetuals), when one exists. - specification.adapter.mark: (input: MarkInput) => MarkOutcome; default: not declared - specification.adapter.mark().return.pricePerUnit: number; default: not declared - specification.adapter.mark().return.source: string; default: not declared - specification.adapter.mark().return.unavailable: MissingMarkCause; default: not declared - specification.adapter.mark(input): MarkInput; default: not declared - specification.adapter.version: string; default: not declared - specification.assetClass?: AssetClass; default: not declared — Default: the kind. - specification.classification?: InstrumentClassification; default: not declared - specification.classification.assetClass?: string; default: not declared - specification.classification.strategy?: string; default: not declared - specification.classification.tags?: string[]; default: not declared — Overlapping by nature — the `tag` grouping does not partition the total. - specification.classification.underlying?: string; default: not declared - specification.contract?: DerivativeContractTerms; default: not declared — REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. - specification.contract.expiryTimestampMs: number; default: not declared - specification.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - specification.contract.strikePricePerUnit: number; default: not declared - specification.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - specification.contract.underlyingInstrumentId: string; default: not declared - specification.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. - specification.coupon?: CouponTerms; default: not declared — `bond`: the coupon terms. - specification.coupon.annualRate: number; default: not declared — Annual coupon rate, decimal (0.05 = 5%). - specification.coupon.dayCount?: 'ACT/365F' | '30/360'; default: not declared — Accrual day count (default `'ACT/365F'`). - specification.coupon.faceValuePerUnit?: number; default: not declared — Face value per unit of quantity (default 1). - specification.coupon.issueDate: string; default: not declared — Dated date / first accrual date, `YYYY-MM-DD`. - specification.coupon.maturityDate: string; default: not declared — Maturity, `YYYY-MM-DD`; principal redeems at the face value on this date. - specification.coupon.paymentsPerYear: number; default: not declared — Coupons per year (1, 2, 4, 12). - specification.currency: string; default: not declared — The trading and mark currency. - specification.forward?: ForwardTerms; default: not declared — `fx-forward`: the contract. - specification.forward.baseCurrency: string; default: not declared — The currency bought forward (one unit of quantity = one unit of this currency). - specification.forward.contractRate: number; default: not declared - specification.forward.maturityTimestampMs: number; default: not declared - specification.forward.quoteCurrency: string; default: not declared — The currency paid, at `contractRate` per base unit. - specification.kind: InstrumentKind; default: not declared - specification.roll?: RollTerms; default: not declared — `future`: the declared roll. - specification.roll.sessionsBeforeExpiry: number; default: not declared - specification.roll.toInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#MarkOutcome Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MarkOutcome = { pricePerUnit: number; source: string; } | { unavailable: MissingMarkCause; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - pricePerUnit: number; default: not declared - source: string; default: not declared - unavailable: MissingMarkCause; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#OrderRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OrderRecord { orderId: string; asOf: EpochMs; instrumentId: string; side: 'buy' | 'sell'; quantity: number; type: OrderIntent['type']; source: OrderSource; outcome: 'filled' | 'partial' | 'unfilled'; filledQuantity: number; reason: string | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - filledQuantity: number; default: not declared - instrumentId: string; default: not declared - orderId: string; default: not declared - outcome: 'filled' | 'partial' | 'unfilled'; default: not declared - quantity: number; default: not declared - reason: string | null; default: not declared - side: 'buy' | 'sell'; default: not declared - source: OrderSource; default: not declared - type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#OrderSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OrderSource = 'strategy' | 'lifecycle' | 'liquidation'; ``` ### @insiderfinance/totalfinance/backtest/portfolio#PORTFOLIO_CALENDARS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const PORTFOLIO_CALENDARS: readonly ['NYSE', 'CBOE', 'ALWAYS_OPEN']; ``` ### @insiderfinance/totalfinance/backtest/portfolio#PORTFOLIO_INSTRUMENT_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: instruments one run may hold. ```typescript export declare const PORTFOLIO_INSTRUMENT_CEILING: 50000; ``` ### @insiderfinance/totalfinance/backtest/portfolio#PORTFOLIO_ROW_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9: rows one run may read per row set. ```typescript export declare const PORTFOLIO_ROW_CEILING: 5000000; ``` ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioBacktestAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioBacktestAssumptions { conventionsVersion: string; baseCurrency: string; lotRelief: LotReliefPolicy; settlement: Record; calendar: string | null; sessionConvention: string; markConvention: string; strategy: { kind: 'model'; modelId: string | null; targets: number; frequency: RebalanceFrequency; scope: RebalanceScope; } | { kind: 'callback'; replayable: false; } /** The orders came from a stepper's caller step by step (Stage 7B.1). */ | { kind: 'external'; replayable: false; }; execution: ExecutionPolicyDescription; instruments: Array<{ instrumentId: string; kind: InstrumentKind; adapter: { kind: string; version: string; }; currency: string; }>; periodsPerYear: number; seed: number | null; window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; ledger: { sourceId: string; accountId: string; }; replayable: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - calendar: string | null; default: not declared - conventionsVersion: string; default: not declared - execution: ExecutionPolicyDescription; default: not declared - execution.ambiguity: import('@insiderfinance/totalfinance/backtest/execution').AmbiguityPolicy; default: not declared - execution.costs: { borrow: string | null; commission: string; latencySessions: number | null; marketImpact: string | null; participation: number | null; slippage: string; spread: string | null; }; default: not declared - execution.costs.borrow: string | null; default: not declared - execution.costs.commission: string; default: not declared - execution.costs.latencySessions: number | null; default: not declared - execution.costs.marketImpact: string | null; default: not declared - execution.costs.participation: number | null; default: not declared - execution.costs.slippage: string; default: not declared - execution.costs.spread: string | null; default: not declared - execution.fill: { label: string; version: string; }; default: not declared - execution.fill.label: string; default: not declared - execution.fill.version: string; default: not declared - execution.label: string; default: not declared - execution.lockedCrossed: import('@insiderfinance/totalfinance/backtest/execution').LockedCrossedPolicy; default: not declared - execution.margin: import('@insiderfinance/totalfinance/backtest/execution').MarginPolicy; default: not declared - execution.margin.buyingPowerMultiplier: number; default: not declared — Gross notional an account may hold per unit of equity (1 = cash account). - execution.margin.forcedLiquidation: import('@insiderfinance/totalfinance/backtest/execution').ForcedLiquidationPolicy; default: not declared - execution.margin.initialMarginRate: number; default: not declared — Fraction of a new position's notional that must be equity at entry. - execution.margin.maintenanceMarginRate: number; default: not declared — Fraction of gross notional that must remain equity after every fold. - execution.observation: 'quote' | 'bar' | 'trade' | 'order-book'; default: not declared - execution.partialFills: import('@insiderfinance/totalfinance/backtest/execution').PartialFillPolicy; default: not declared - execution.queue: import('@insiderfinance/totalfinance/backtest/execution').QueueModel; default: not declared - execution.realism: 'simplified' | 'declared'; default: not declared - execution.sessions: { auction: 'ignore' | 'open-close-only' | null; halts: number; priceLimits: number; }; default: not declared - execution.sessions.auction: 'ignore' | 'open-close-only' | null; default: not declared - execution.sessions.halts: number; default: not declared - execution.sessions.priceLimits: number; default: not declared - execution.staleQuotes: import('@insiderfinance/totalfinance/backtest/execution').StaleQuotePolicy; default: not declared - execution.staleQuotes.behavior: 'reject' | 'fill-at-last'; default: not declared — `reject` refuses the run (`backtest.stale_quote`); `fill-at-last` fills at the stale quote and reports it. - execution.staleQuotes.maximumAgeMs: number | null; default: not declared — A quote older than this at the decision instant is stale; `null` = never stale. - execution.timeInForce: { default: import('@insiderfinance/totalfinance/core').TimeInForce; expireAtSessionClose: boolean; }; default: not declared - execution.timeInForce.default: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - execution.timeInForce.expireAtSessionClose: boolean; default: not declared - instruments: { instrumentId: string; kind: InstrumentKind; adapter: { kind: string; version: string; }; currency: string; }[]; default: not declared - ledger: { accountId: string; sourceId: string; }; default: not declared - ledger.accountId: string; default: not declared - ledger.sourceId: string; default: not declared - lotRelief: LotReliefPolicy; default: not declared - markConvention: string; default: not declared - periodsPerYear: number; default: not declared - replayable: boolean; default: not declared - seed: number | null; default: not declared - sessionConvention: string; default: not declared - settlement: Record; default: not declared - strategy: { frequency: RebalanceFrequency; kind: 'model'; modelId: string | null; scope: RebalanceScope; targets: number; } | { kind: 'callback'; replayable: false; } | { kind: 'external'; replayable: false; }; default: not declared - strategy.frequency: RebalanceFrequency; default: not declared - strategy.kind: ('callback') | ('external') | ('model'); default: not declared - strategy.modelId: string | null; default: not declared - strategy.replayable: false; default: not declared - strategy.scope: RebalanceScope; default: not declared - strategy.targets: number; default: not declared - window: { fromTimestampMs: EpochMs | null; toTimestampMs: EpochMs | null; }; default: not declared - window.fromTimestampMs: number | null; default: not declared - window.toTimestampMs: number | null; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioBacktestDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioBacktestDiagnostics extends Diagnostics { sessionCount: number; orderCount: number; fillCount: number; rejectionCount: number; liquidationCount: number; lifecycleEventCount: number; externalFlowCount: number; markCount: number; /** The ledger NAV minus the engine's equity at the worst mark — always 0 within 1e-6. */ reconciliationResidual: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - externalFlowCount: number; default: not declared - fillCount: number; default: not declared - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - lifecycleEventCount: number; default: not declared - liquidationCount: number; default: not declared - markCount: number; default: not declared - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - orderCount: number; default: not declared - reconciliationResidual: number; default: not declared — The ledger NAV minus the engine's equity at the worst mark — always 0 within 1e-6. - rejectionCount: number; default: not declared - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - sessionCount: number; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioBacktestRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#PortfolioBacktestRequest`. ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioBacktestResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#PortfolioBacktestResult`. ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioMarketData Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioMarketData { bars?: readonly Bar[]; quotes?: readonly Quote[]; trades?: readonly Trade[]; orderBooks?: readonly OrderBook[]; optionChains?: readonly ChainSnapshot[]; /** Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. */ fxRates?: readonly DatedCurrencyPairQuote[]; /** Forward-rate series per fx-forward instrument. */ forwardRates?: readonly ForwardRateRecord[]; fundingRates?: readonly FundingRateRecord[]; corporateActions?: readonly CorporateAction[]; dividends?: readonly DividendRecord[]; coupons?: readonly CouponRecord[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bars?: readonly Bar[]; default: not declared - corporateActions?: readonly CorporateAction[]; default: not declared - coupons?: readonly CouponRecord[]; default: not declared - dividends?: readonly DividendRecord[]; default: not declared - forwardRates?: readonly ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - fundingRates?: readonly FundingRateRecord[]; default: not declared - fxRates?: readonly DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - optionChains?: readonly ChainSnapshot[]; default: not declared - orderBooks?: readonly OrderBook[]; default: not declared - quotes?: readonly Quote[]; default: not declared - trades?: readonly Trade[]; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioStepFrame Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#PortfolioStepFrame`. ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioStepper Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#PortfolioStepper`. ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioStepperRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#PortfolioStepperRequest`. ### @insiderfinance/totalfinance/backtest/portfolio#PortfolioStrategy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PortfolioStrategy = { /** A model artifact or inline targets, proposed on the schedule through `proposePortfolioRebalance`. */ model: ModelPortfolio | readonly AllocationTarget[]; schedule: RebalanceSchedule; policy?: InvestmentPolicy; /** Default `'to-target'`. */ scope?: RebalanceScope; } | { /** Direct TypeScript; the run is not replayable. */ onSession: (context: SessionContext) => readonly OrderIntent[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - model: ModelPortfolio | readonly AllocationTarget[]; default: not declared — A model artifact or inline targets, proposed on the schedule through `proposePortfolioRebalance`. - model.baseCurrency: string; default: not declared - model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - model.benchmark.benchmarkId: string; default: not declared - model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - model.glidePath.interpolation: 'linear' | 'step'; default: not declared - model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - model.horizonEndDate?: string | number; default: not declared - model.kind: 'totalfinance.model-portfolio'; default: not declared - model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - model.liabilities.note?: string; default: not declared - model.modelId: string; default: not declared - model.note?: string; default: not declared - model.schemaVersion: number; default: not declared - model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - model.strategic.note?: string; default: not declared - model.strategic.targets: AllocationTarget[]; default: not declared - model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - onSession: (context: SessionContext) => readonly OrderIntent[]; default: not declared — Direct TypeScript; the run is not replayable. - onSession(context): SessionContext; default: not declared - onSession(context).asOf: number; default: not declared - onSession(context).cash: readonly { currency: string; amount: number; }[]; default: not declared - onSession(context).index: number; default: not declared - onSession(context).instruments: Readonly>; default: not declared - onSession(context).marks: Readonly>; default: not declared — Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). - onSession(context).netAssetValue: number; default: not declared - onSession(context).observations: Readonly>; default: not declared — The latest observations per instrument at the instant. - onSession(context).positions: readonly SessionPosition[]; default: not declared - policy?: InvestmentPolicy; default: not declared - policy.allowedAccounts?: string[]; default: not declared - policy.allowedInstruments?: string[]; default: not declared - policy.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.benchmark.benchmarkId: string; default: not declared - policy.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.contributionHandling?: import('@insiderfinance/totalfinance/portfolio').ContributionHandling; default: not declared - policy.driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - policy.incomeReinvestment?: import('@insiderfinance/totalfinance/portfolio').IncomeReinvestment; default: not declared - policy.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - policy.lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - policy.maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - policy.maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - policy.minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - policy.minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - policy.model?: ModelPortfolio; default: not declared - policy.model.baseCurrency: string; default: not declared - policy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.model.benchmark.benchmarkId: string; default: not declared - policy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - policy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - policy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - policy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - policy.model.horizonEndDate?: string | number; default: not declared - policy.model.kind: 'totalfinance.model-portfolio'; default: not declared - policy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - policy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - policy.model.liabilities.note?: string; default: not declared - policy.model.modelId: string; default: not declared - policy.model.note?: string; default: not declared - policy.model.schemaVersion: number; default: not declared - policy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - policy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - policy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - policy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - policy.model.strategic.note?: string; default: not declared - policy.model.strategic.targets: AllocationTarget[]; default: not declared - policy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - policy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - policy.performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - policy.restrictedInstruments?: string[]; default: not declared - policy.reviewCadenceDays?: number; default: not declared - policy.targets?: AllocationTarget[]; default: not declared - policy.withdrawalHandling?: import('@insiderfinance/totalfinance/portfolio').WithdrawalHandling; default: not declared - policy.withinGroupAllocation?: import('@insiderfinance/totalfinance/portfolio').WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. - schedule: RebalanceSchedule; default: not declared - schedule.frequency: RebalanceFrequency; default: not declared - scope?: RebalanceScope; default: not declared — Default `'to-target'`. ### @insiderfinance/totalfinance/backtest/portfolio#RebalanceSchedule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceSchedule { frequency: RebalanceFrequency; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - frequency: RebalanceFrequency; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#RejectionRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RejectionRow { asOf: EpochMs; orderId: string | null; instrumentId: string; /** `backtest.limit_rejected` | the fill model's unfilled reason | `backtest.stale_quote` … */ code: string; detail: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - code: string; default: not declared — `backtest.limit_rejected` | the fill model's unfilled reason | `backtest.stale_quote` … - detail: string; default: not declared - instrumentId: string; default: not declared - orderId: string | null; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#RollTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A future's declared roll: the successor contract and how many sessions before expiry to roll. ```typescript /** A future's declared roll: the successor contract and how many sessions before expiry to roll. */ export interface RollTerms { toInstrumentId: string; sessionsBeforeExpiry: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sessionsBeforeExpiry: number; default: not declared - toInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#SessionContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a direct strategy sees at a decision instant. ```typescript /** What a direct strategy sees at a decision instant. */ export interface SessionContext { asOf: EpochMs; index: number; netAssetValue: number; cash: readonly { currency: string; amount: number; }[]; positions: readonly SessionPosition[]; /** The latest observations per instrument at the instant. */ observations: Readonly>; /** Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). */ marks: Readonly>; instruments: Readonly>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - cash: readonly { currency: string; amount: number; }[]; default: not declared - index: number; default: not declared - instruments: Readonly>; default: not declared - marks: Readonly>; default: not declared — Each instrument's mark at the instant from its adapter, or null when the adapter has none (Stage 7B.1). - netAssetValue: number; default: not declared - observations: Readonly>; default: not declared — The latest observations per instrument at the instant. - positions: readonly SessionPosition[]; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#SessionPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SessionPosition { instrumentId: string; quantity: number; contractMultiplier: number; /** `quantity × mark × multiplier` in the base currency, signed; null while the instrument has no mark (Stage 7B.1). */ baseCurrencyMarketValue: number | null; /** The mark per unit at the instant, or `null` when unavailable. */ markPricePerUnit: number | null; currency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrencyMarketValue: number | null; default: not declared — `quantity × mark × multiplier` in the base currency, signed; null while the instrument has no mark (Stage 7B.1). - contractMultiplier: number; default: not declared - currency: string; default: not declared - instrumentId: string; default: not declared - markPricePerUnit: number | null; default: not declared — The mark per unit at the instant, or `null` when unavailable. - quantity: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#accruedFromTerms Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Finite accrued interest per unit of quantity at the instant, from the coupon terms alone. Refuses terms whose calculation overflows, even when their individual fields are finite. ```typescript export declare function accruedFromTerms(terms: CouponTerms, asOf: EpochMs): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (asOf): number; default: not declared - (terms): CouponTerms; default: not declared - (terms).annualRate: number; default: not declared — Annual coupon rate, decimal (0.05 = 5%). - (terms).dayCount?: 'ACT/365F' | '30/360'; default: not declared — Accrual day count (default `'ACT/365F'`). - (terms).faceValuePerUnit?: number; default: not declared — Face value per unit of quantity (default 1). - (terms).issueDate: string; default: not declared — Dated date / first accrual date, `YYYY-MM-DD`. - (terms).maturityDate: string; default: not declared — Maturity, `YYYY-MM-DD`; principal redeems at the face value on this date. - (terms).paymentsPerYear: number; default: not declared — Coupons per year (1, 2, 4, 12). ### @insiderfinance/totalfinance/backtest/portfolio#adapterFor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The adapter a specification uses: its own for `custom`, the built-in otherwise. ```typescript export declare function adapterFor(instrumentId: string, specification: InstrumentSpecification): InstrumentAdapter; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (instrumentId): string; default: not declared - (specification): InstrumentSpecification; default: not declared - (specification).adapter?: InstrumentAdapter; default: not declared — REQUIRED for `custom`; refused for a built-in kind. - (specification).assetClass?: import('@insiderfinance/totalfinance/backtest/portfolio').AssetClass; default: not declared — Default: the kind. - (specification).classification?: import('@insiderfinance/totalfinance/portfolio').InstrumentClassification; default: not declared - (specification).contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms; default: not declared — REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. - (specification).contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. - (specification).coupon?: CouponTerms; default: not declared — `bond`: the coupon terms. - (specification).currency: string; default: not declared — The trading and mark currency. - (specification).forward?: import('@insiderfinance/totalfinance/backtest/portfolio').ForwardTerms; default: not declared — `fx-forward`: the contract. - (specification).kind: InstrumentKind; default: not declared - (specification).roll?: import('@insiderfinance/totalfinance/backtest/portfolio').RollTerms; default: not declared — `future`: the declared roll. - return.accrued?: (input: { specification: InstrumentSpecification; asOf: EpochMs; }) => number; default: not declared — Accrued interest per unit at the instant (bonds); omitted = none. - return.fillTerms: (specification: InstrumentSpecification) => FillTerms; default: not declared - return.kind: string; default: not declared - return.lifecycle: (input: LifecycleInput) => PortfolioEvent[]; default: not declared - return.mark: (input: MarkInput) => MarkOutcome; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#assertInstrumentAdapterConformance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conformance suite (Decision 6a): pure, deterministic, finite, JSON-safe, payloads shaped as events. ```typescript export declare function assertInstrumentAdapterConformance(input: { adapter: InstrumentAdapter; fixtures: { mark: readonly MarkInput[]; lifecycle: readonly LifecycleInput[]; }; }): { kind: string; version: string; marks: number; lifecycles: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { adapter: InstrumentAdapter; fixtures: { mark: readonly MarkInput[]; lifecycle: readonly LifecycleInput[]; }; }; default: not declared - (input).adapter: InstrumentAdapter; default: not declared - (input).fixtures: { mark: readonly MarkInput[]; lifecycle: readonly LifecycleInput[]; }; default: not declared - (input).fixtures.lifecycle: readonly LifecycleInput[]; default: not declared - (input).fixtures.mark: readonly MarkInput[]; default: not declared - return.kind: string; default: not declared - return.lifecycles: number; default: not declared - return.marks: number; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#createPortfolioStepper Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#createPortfolioStepper`. ### @insiderfinance/totalfinance/backtest/portfolio#instrumentAdapters Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The built-in adapters, keyed by kind. ```typescript export declare const instrumentAdapters: Readonly>; ``` ### @insiderfinance/totalfinance/backtest/portfolio#portfolioBacktest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#portfolioBacktest`. ### @insiderfinance/totalfinance/backtest/portfolio#requireAccountingPolicy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireAccountingPolicy(functionName: string, field: string, value: unknown): AccountingPolicy; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared - return.baseCurrency: string; default: not declared - return.initialCash: readonly { currency: string; amount: number; }[]; default: not declared - return.lotRelief?: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — Default `'fifo'`. - return.settlement?: Partial>; default: not declared — Settlement lag per asset class; default equities/etf/option/bond `'T+1'`, everything else `'T+0'`. ### @insiderfinance/totalfinance/backtest/portfolio#requireInstrumentSpecification Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireInstrumentSpecification(functionName: string, field: string, value: unknown): InstrumentSpecification; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared - return.adapter?: import('@insiderfinance/totalfinance/backtest').InstrumentAdapter; default: not declared — REQUIRED for `custom`; refused for a built-in kind. - return.assetClass?: AssetClass; default: not declared — Default: the kind. - return.classification?: import('@insiderfinance/totalfinance/portfolio').InstrumentClassification; default: not declared - return.contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms; default: not declared — REQUIRED for `option`, `future`, and `crypto-perpetual` — the ledger stores the terms on the position. - return.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity (an option's 100, a futures contract size); default 1. - return.coupon?: CouponTerms; default: not declared — `bond`: the coupon terms. - return.currency: string; default: not declared — The trading and mark currency. - return.forward?: import('@insiderfinance/totalfinance/backtest/portfolio').ForwardTerms; default: not declared — `fx-forward`: the contract. - return.kind: InstrumentKind; default: not declared - return.roll?: import('@insiderfinance/totalfinance/backtest/portfolio').RollTerms; default: not declared — `future`: the declared roll. ### @insiderfinance/totalfinance/backtest/portfolio#requirePortfolioBacktestRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requirePortfolioBacktestRequest(functionName: string, label: string, value: unknown): PortfolioBacktestRequest; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accounting: AccountingPolicy; default: not declared - return.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - return.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - return.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - return.instruments: Readonly>; default: not declared - return.marketData: PortfolioMarketData; default: not declared - return.periodsPerYear?: number; default: not declared - return.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - return.strategy: import('@insiderfinance/totalfinance/backtest/portfolio').PortfolioStrategy; default: not declared - return.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - return.window.fromTimestampMs?: number; default: not declared - return.window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#requirePortfolioMarketData Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requirePortfolioMarketData(functionName: string, field: string, value: unknown): PortfolioMarketData; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared - return.bars?: readonly import('@insiderfinance/totalfinance/core').Bar[]; default: not declared - return.corporateActions?: readonly import('@insiderfinance/totalfinance/core').CorporateAction[]; default: not declared - return.coupons?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').CouponRecord[]; default: not declared - return.dividends?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DividendRecord[]; default: not declared - return.forwardRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ForwardRateRecord[]; default: not declared — Forward-rate series per fx-forward instrument. - return.fundingRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').FundingRateRecord[]; default: not declared - return.fxRates?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').DatedCurrencyPairQuote[]; default: not declared — Dated quotes to the base currency; REQUIRED when any instrument's currency ≠ baseCurrency. - return.optionChains?: readonly import('@insiderfinance/totalfinance/backtest/options').ChainSnapshot[]; default: not declared - return.orderBooks?: readonly import('@insiderfinance/totalfinance/core').OrderBook[]; default: not declared - return.quotes?: readonly import('@insiderfinance/totalfinance/core').Quote[]; default: not declared - return.trades?: readonly import('@insiderfinance/totalfinance/core').Trade[]; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#requirePortfolioStepperRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The stepper's request (Stage 7B.1): `portfolioBacktest`'s request without a strategy — the orders come from `close()`. A `strategy` member teaches which verb wants it. ```typescript export declare function requirePortfolioStepperRequest(functionName: string, label: string, value: unknown): PortfolioStepperRequest; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accounting: AccountingPolicy; default: not declared - return.calendar?: string; default: not declared — A calendar name (`'NYSE'`, `'CBOE'`, `'ALWAYS_OPEN'`): sessions and settlement days. - return.execution?: import('@insiderfinance/totalfinance/backtest/execution').ExecutionPolicy; default: not declared - return.externalFlows?: readonly import('@insiderfinance/totalfinance/backtest/portfolio').ExternalFlowRecord[]; default: not declared - return.instruments: Readonly>; default: not declared - return.marketData: PortfolioMarketData; default: not declared - return.periodsPerYear?: number; default: not declared - return.seed?: number; default: not declared — Seeds only the bootstrap confidence intervals. - return.window?: { fromTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; toTimestampMs?: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - return.window.fromTimestampMs?: number; default: not declared - return.window.toTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/backtest/portfolio#splitShares Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A rational approximation of a split ratio as positive integers (2 → 2:1, 0.5 → 1:2, 1.5 → 3:2). ```typescript export declare function splitShares(ratio: number): { sharesAfterSplit: number; sharesBeforeSplit: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (ratio): number; default: not declared - return.sharesAfterSplit: number; default: not declared - return.sharesBeforeSplit: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/backtest/tearsheet ### @insiderfinance/totalfinance/backtest/tearsheet#AttributionReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#AttributionReport`. ### @insiderfinance/totalfinance/backtest/tearsheet#MonteCarloResampleReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#MonteCarloResampleReport`. ### @insiderfinance/totalfinance/backtest/tearsheet#MonteCarloResampleResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#MonteCarloResampleResult`. ### @insiderfinance/totalfinance/backtest/tearsheet#ReturnStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#ReturnStatistics`. ### @insiderfinance/totalfinance/backtest/tearsheet#ReturnStatisticsReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#ReturnStatisticsReport`. ### @insiderfinance/totalfinance/backtest/tearsheet#SymbolAttribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#SymbolAttribution`. ### @insiderfinance/totalfinance/backtest/tearsheet#TearSheet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TearSheet`. ### @insiderfinance/totalfinance/backtest/tearsheet#TearSheetOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TearSheetOptions`. ### @insiderfinance/totalfinance/backtest/tearsheet#TradeStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TradeStatistics`. ### @insiderfinance/totalfinance/backtest/tearsheet#attribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#attribution`. ### @insiderfinance/totalfinance/backtest/tearsheet#monteCarloResample Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#monteCarloResample`. ### @insiderfinance/totalfinance/backtest/tearsheet#returnStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#returnStatistics`. ### @insiderfinance/totalfinance/backtest/tearsheet#tearSheet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#tearSheet`. ## Entrypoint @insiderfinance/totalfinance/backtest/vectorized ### @insiderfinance/totalfinance/backtest/vectorized#RebalanceRule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#RebalanceRule`. ### @insiderfinance/totalfinance/backtest/vectorized#VectorizedOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#VectorizedOptions`. ### @insiderfinance/totalfinance/backtest/vectorized#equityToReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#equityToReturns`. ### @insiderfinance/totalfinance/backtest/vectorized#vectorized Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#vectorized`. ## Entrypoint @insiderfinance/totalfinance/calendars ### @insiderfinance/totalfinance/calendars#CALENDAR_DATA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bump when the holiday rules or closure list change. ```typescript export declare const CALENDAR_DATA_VERSION: '2026.06.0'; ``` ### @insiderfinance/totalfinance/calendars#CBOE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const CBOE: TradingCalendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - isTradingDay(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/calendars#Calendar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Calendar { readonly name: string; readonly version: string; readonly timezone: string; isBusinessDay(date: string): boolean; isHoliday(date: string): boolean; isHalfDay(date: string): boolean; nextBusinessDay(date: string): string; previousBusinessDay(date: string): string; addBusinessDays(date: string, days: number): string; /** Business days in the half-open interval `(from, to]` (negative if `to < from`). */ businessDaysBetween(from: string, to: string): number; session(date: string): DaySession; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/calendars#ExpirationKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExpirationKind = 'weekly' | 'monthly' | 'quarterly'; ``` ### @insiderfinance/totalfinance/calendars#NYSE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const NYSE: TradingCalendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - isTradingDay(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/calendars#TradingCalendar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A core `Calendar` extended with trader vocabulary. ```typescript /** A core `Calendar` extended with trader vocabulary. */ export interface TradingCalendar extends Calendar { /** * First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a * regular or shortened session on `date` (ISO `YYYY-MM-DD`). */ isTradingDay(date: string): boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - isTradingDay(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/calendars#US_EQUITY_CALENDAR_COVERAGE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Documented closure-data boundary; future ad-hoc closures cannot be predicted from rules. ```typescript export declare const US_EQUITY_CALENDAR_COVERAGE: Readonly<{ historicalFloor: '2001-01-01'; verifiedThrough: null; dataVersion: '2026.06.0'; limitations: string; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dataVersion: '2026.06.0'; default: not declared - historicalFloor: '2001-01-01'; default: not declared - limitations: string; default: not declared - verifiedThrough: null; default: not declared ### @insiderfinance/totalfinance/calendars#crypto24x7 Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The 24×7 crypto calendar with trader vocabulary (R10). ```typescript export declare const crypto24x7: TradingCalendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - isTradingDay(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/calendars#expirations Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Option expirations in `[from, to]` (inclusive), holiday-shifted per the calendar. `kind` defaults to `'monthly'` (the classic OPEX dates). ```typescript export declare function expirations(calendar: Calendar, range: { from: string; to: string; kind?: ExpirationKind; }): string[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (calendar): Calendar; default: not declared - (calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - (calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - (calendar).isBusinessDay: (date: string) => boolean; default: not declared - (calendar).isHalfDay: (date: string) => boolean; default: not declared - (calendar).isHoliday: (date: string) => boolean; default: not declared - (calendar).name: string; default: not declared - (calendar).nextBusinessDay: (date: string) => string; default: not declared - (calendar).previousBusinessDay: (date: string) => string; default: not declared - (calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - (calendar).timezone: string; default: not declared - (calendar).version: string; default: not declared - (range): { from: string; kind?: ExpirationKind; to: string; }; default: not declared - (range).from: string; default: not declared - (range).kind?: ExpirationKind; default: not declared - (range).to: string; default: not declared ### @insiderfinance/totalfinance/calendars#nextExpiry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The first expiration strictly after `date` (`kind` defaults to `'weekly'` — the nearest Friday expiry, holiday-shifted). ```typescript export declare function nextExpiry(calendar: Calendar, date: string, kind?: ExpirationKind): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (calendar): Calendar; default: not declared - (calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - (calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - (calendar).isBusinessDay: (date: string) => boolean; default: not declared - (calendar).isHalfDay: (date: string) => boolean; default: not declared - (calendar).isHoliday: (date: string) => boolean; default: not declared - (calendar).name: string; default: not declared - (calendar).nextBusinessDay: (date: string) => string; default: not declared - (calendar).previousBusinessDay: (date: string) => string; default: not declared - (calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - (calendar).timezone: string; default: not declared - (calendar).version: string; default: not declared - (date): string; default: not declared - (kind)?: ExpirationKind; default: not declared ### @insiderfinance/totalfinance/calendars#requireCalendar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate that `value` is a usable `Calendar` object; throws a teaching `InputError` otherwise. Shared by every facade in this package so garbage inputs (strings, numbers, `{}`) always produce a typed error naming the `calendar` field instead of a raw `TypeError` on a method access. ```typescript export declare function requireCalendar(functionName: string, value: unknown): Calendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (value): unknown; default: not declared - return.addBusinessDays: (date: string, days: number) => string; default: not declared - return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - return.isBusinessDay: (date: string) => boolean; default: not declared - return.isHalfDay: (date: string) => boolean; default: not declared - return.isHoliday: (date: string) => boolean; default: not declared - return.name: string; default: not declared - return.nextBusinessDay: (date: string) => string; default: not declared - return.previousBusinessDay: (date: string) => string; default: not declared - return.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - return.timezone: string; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/calendars#tradingDaysToExpiry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Trading sessions remaining until an expiry — the days-to-expiry number traders scale volatility with (`√(tradingDays / 252)`), counted on THIS calendar's actual schedule rather than calendar days ÷ 7 × 5. Counts trading sessions in `(from, expiry]`: the `from` date itself is excluded (it is already underway), the expiry date is included when it is a trading day. Same-day expiry → `0`. An `expiry` before `from` is a typed error, never a negative count. ```typescript export declare function tradingDaysToExpiry(calendar: Calendar, from: string, expiry: string): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (calendar): Calendar; default: not declared - (calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - (calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - (calendar).isBusinessDay: (date: string) => boolean; default: not declared - (calendar).isHalfDay: (date: string) => boolean; default: not declared - (calendar).isHoliday: (date: string) => boolean; default: not declared - (calendar).name: string; default: not declared - (calendar).nextBusinessDay: (date: string) => string; default: not declared - (calendar).previousBusinessDay: (date: string) => string; default: not declared - (calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - (calendar).timezone: string; default: not declared - (calendar).version: string; default: not declared - (expiry): string; default: not declared - (from): string; default: not declared ### @insiderfinance/totalfinance/calendars#usMarketClosures Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ad-hoc full closures that no rule can derive. Complete for the era this list spans (2001→present); dates BEFORE 2001 are not covered — day counts across earlier one-off closures (e.g. the 1994 Nixon mourning day) would be silently wrong, so treat 2001-01-01 as the calendar's historical floor. ```typescript export declare const usMarketClosures: string[]; ``` ### @insiderfinance/totalfinance/calendars#usMarketHalfDayRules Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const usMarketHalfDayRules: HolidayRule[]; ``` ### @insiderfinance/totalfinance/calendars#usMarketHolidayRules Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const usMarketHolidayRules: HolidayRule[]; ``` ### @insiderfinance/totalfinance/calendars#withTradingVocabulary Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extend a core `Calendar` with the trader-vocabulary alias `isTradingDay` (≡ `isBusinessDay`). Returns a new object; the wrapped methods are the ORIGINAL function references (single implementation), so behavior is identical by construction. ```typescript export declare function withTradingVocabulary(calendar: Calendar): TradingCalendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (calendar): Calendar; default: not declared - (calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - (calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - (calendar).isBusinessDay: (date: string) => boolean; default: not declared - (calendar).isHalfDay: (date: string) => boolean; default: not declared - (calendar).isHoliday: (date: string) => boolean; default: not declared - (calendar).name: string; default: not declared - (calendar).nextBusinessDay: (date: string) => string; default: not declared - (calendar).previousBusinessDay: (date: string) => string; default: not declared - (calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - (calendar).timezone: string; default: not declared - (calendar).version: string; default: not declared - return.addBusinessDays: (date: string, days: number) => string; default: not declared - return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - return.isBusinessDay: (date: string) => boolean; default: not declared - return.isHalfDay: (date: string) => boolean; default: not declared - return.isHoliday: (date: string) => boolean; default: not declared - return.isTradingDay: (date: string) => boolean; default: not declared — First-class alias of {@link Calendar.isBusinessDay} (R10): `true` when the exchange holds a regular or shortened session on `date` (ISO `YYYY-MM-DD`). - return.name: string; default: not declared - return.nextBusinessDay: (date: string) => string; default: not declared - return.previousBusinessDay: (date: string) => string; default: not declared - return.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - return.timezone: string; default: not declared - return.version: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/calendars/cboe ### @insiderfinance/totalfinance/calendars/cboe#CBOE Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/calendars#CBOE`. ## Entrypoint @insiderfinance/totalfinance/calendars/crypto ### @insiderfinance/totalfinance/calendars/crypto#crypto24x7 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/calendars#crypto24x7`. ## Entrypoint @insiderfinance/totalfinance/calendars/nyse ### @insiderfinance/totalfinance/calendars/nyse#NYSE Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/calendars#NYSE`. ## Entrypoint @insiderfinance/totalfinance/cli ### @insiderfinance/totalfinance/cli#CLI_COMMANDS Kind: value; stability: preview (pre-1.0). The `totalfinance` command surface, published so the CLI guide is checked against what ships (the same standing as the MCP guide's tool list). ```typescript export declare const CLI_COMMANDS: readonly ['operations list', 'schema', 'run', 'job submit', 'job status', 'job result', 'job cancel', 'artifacts get', 'serve', 'doctor']; ``` ### @insiderfinance/totalfinance/cli#CLI_EXIT_CODES Kind: value; stability: preview (pre-1.0). The `totalfinance` exit codes — a contract (Stage 7A Decision 6), published so a caller's script and the CLI guide's table are checked against the same values. ```typescript export declare const CLI_EXIT_CODES: Readonly<{ readonly success: 0; readonly usage: 2; readonly inputRefused: 3; readonly operationFailed: 4; readonly jobCancelled: 5; readonly internal: 70; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - inputRefused: 3; default: not declared — The input was refused — an `OperationError` with an `input.*` code. - internal: 70; default: not declared — An internal error (a bug, a missing worker build) — never an input problem. - jobCancelled: 5; default: not declared — The job was cancelled before it produced a result. - operationFailed: 4; default: not declared — The operation failed — any other `OperationError`. - success: 0; default: not declared — The command succeeded; stdout carries one JSON document. - usage: 2; default: not declared — Usage: an unknown command or flag, a missing argument, a malformed `--input`, an environment below the floor. ### @insiderfinance/totalfinance/cli#CliCommand Kind: type; stability: preview (pre-1.0). ```typescript export type CliCommand = (typeof CLI_COMMANDS)[number]; ``` ### @insiderfinance/totalfinance/cli#CliExitCode Kind: type; stability: preview (pre-1.0). ```typescript export type CliExitCode = (typeof CLI_EXIT_CODES)[keyof typeof CLI_EXIT_CODES]; ``` ### @insiderfinance/totalfinance/cli#JobRun Kind: interface; stability: preview (pre-1.0). ```typescript export interface JobRun { /** The record as accepted (or, for an inline non-job operation, as completed). */ record: JobRecord; /** Resolves with the terminal record — completed, failed, or cancelled. Never rejects. */ completion: Promise; /** Terminate the worker now; resolves with the cancelled (or already terminal) record. */ cancel(): Promise; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cancel: () => Promise; default: not declared — Terminate the worker now; resolves with the cancelled (or already terminal) record. - completion: Promise; default: not declared — Resolves with the terminal record — completed, failed, or cancelled. Never rejects. - record: JobRecord; default: not declared — The record as accepted (or, for an inline non-job operation, as completed). - record.error: OperationError | null; default: not declared - record.error.code: string; default: not declared - record.error.context: Record; default: not declared - record.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - record.error.message: string; default: not declared - record.error.operation: { id: string; version: string; } | null; default: not declared - record.error.operation.id: string; default: not declared - record.error.operation.version: string; default: not declared - record.finishedAt: string | null; default: not declared - record.id: string; default: not declared - record.inputsHash: string; default: not declared - record.operation: { id: string; version: string; }; default: not declared - record.operation.id: string; default: not declared - record.operation.version: string; default: not declared - record.progress: { fraction: number | null; stage: string; } | null; default: not declared - record.progress.fraction: number | null; default: not declared - record.progress.stage: string; default: not declared - record.result: ResourceHandle | null; default: not declared - record.result.contentHash: string | null; default: not declared - record.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - record.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - record.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - record.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - record.result.provenance.asOf?: number; default: not declared - record.result.provenance.dataset?: string; default: not declared - record.result.provenance.provider?: string; default: not declared - record.result.provenance.receivedAt?: number; default: not declared - record.result.provenance.requestId?: string; default: not declared - record.result.provenance.sourceVersion?: string; default: not declared - record.result.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - record.result.schema: string; default: not declared - record.result.uri: string; default: not declared - record.result.version: string; default: not declared - record.seed: number | null; default: not declared - record.startedAt: string | null; default: not declared - record.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - record.submittedAt: string; default: not declared - record.usage: { elapsedMs: number | null; }; default: not declared - record.usage.elapsedMs: number | null; default: not declared ### @insiderfinance/totalfinance/cli#JobRunner Kind: interface; stability: preview (pre-1.0). What a transport needs from a job runner — structural, so a host can supply its own. ```typescript /** What a transport needs from a job runner — structural, so a host can supply its own. */ export interface JobRunner { submit(submission: JobSubmission): JobRun; cancel(id: string): JobRecord; get(id: string): JobRecord | null; list(): JobRecord[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cancel: (id: string) => JobRecord; default: not declared - cancel().return.error: import('@insiderfinance/totalfinance/workflows').OperationError | null; default: not declared - cancel().return.error.code: string; default: not declared - cancel().return.error.context: Record; default: not declared - cancel().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - cancel().return.error.message: string; default: not declared - cancel().return.error.operation: { id: string; version: string; } | null; default: not declared - cancel().return.error.operation.id: string; default: not declared - cancel().return.error.operation.version: string; default: not declared - cancel().return.finishedAt: string | null; default: not declared - cancel().return.id: string; default: not declared - cancel().return.inputsHash: string; default: not declared - cancel().return.operation: { id: string; version: string; }; default: not declared - cancel().return.operation.id: string; default: not declared - cancel().return.operation.version: string; default: not declared - cancel().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - cancel().return.progress.fraction: number | null; default: not declared - cancel().return.progress.stage: string; default: not declared - cancel().return.result: import('@insiderfinance/totalfinance/workflows').ResourceHandle | null; default: not declared - cancel().return.result.contentHash: string | null; default: not declared - cancel().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - cancel().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - cancel().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - cancel().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - cancel().return.result.schema: string; default: not declared - cancel().return.result.uri: string; default: not declared - cancel().return.result.version: string; default: not declared - cancel().return.seed: number | null; default: not declared - cancel().return.startedAt: string | null; default: not declared - cancel().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - cancel().return.submittedAt: string; default: not declared - cancel().return.usage: { elapsedMs: number | null; }; default: not declared - cancel().return.usage.elapsedMs: number | null; default: not declared - cancel(id): string; default: not declared - get: (id: string) => JobRecord | null; default: not declared - get().return.error: import('@insiderfinance/totalfinance/workflows').OperationError | null; default: not declared - get().return.error.code: string; default: not declared - get().return.error.context: Record; default: not declared - get().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - get().return.error.message: string; default: not declared - get().return.error.operation: { id: string; version: string; } | null; default: not declared - get().return.error.operation.id: string; default: not declared - get().return.error.operation.version: string; default: not declared - get().return.finishedAt: string | null; default: not declared - get().return.id: string; default: not declared - get().return.inputsHash: string; default: not declared - get().return.operation: { id: string; version: string; }; default: not declared - get().return.operation.id: string; default: not declared - get().return.operation.version: string; default: not declared - get().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - get().return.progress.fraction: number | null; default: not declared - get().return.progress.stage: string; default: not declared - get().return.result: import('@insiderfinance/totalfinance/workflows').ResourceHandle | null; default: not declared - get().return.result.contentHash: string | null; default: not declared - get().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - get().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - get().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - get().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - get().return.result.schema: string; default: not declared - get().return.result.uri: string; default: not declared - get().return.result.version: string; default: not declared - get().return.seed: number | null; default: not declared - get().return.startedAt: string | null; default: not declared - get().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - get().return.submittedAt: string; default: not declared - get().return.usage: { elapsedMs: number | null; }; default: not declared - get().return.usage.elapsedMs: number | null; default: not declared - get(id): string; default: not declared - list: () => JobRecord[]; default: not declared - submit: (submission: JobSubmission) => JobRun; default: not declared - submit().return.cancel: () => Promise; default: not declared — Terminate the worker now; resolves with the cancelled (or already terminal) record. - submit().return.completion: Promise; default: not declared — Resolves with the terminal record — completed, failed, or cancelled. Never rejects. - submit().return.record: JobRecord; default: not declared — The record as accepted (or, for an inline non-job operation, as completed). - submit(submission): JobSubmission; default: not declared - submit(submission).deadlineMs?: number; default: not declared - submit(submission).id: string; default: not declared — The operation id. - submit(submission).inlineResultBytes?: number; default: not declared - submit(submission).input: unknown; default: not declared - submit(submission).maxInputBytes?: number; default: not declared - submit(submission).requestId?: string; default: not declared - submit(submission).seed?: number; default: not declared ### @insiderfinance/totalfinance/cli#JobSubmission Kind: interface; stability: preview (pre-1.0). ```typescript export interface JobSubmission { /** The operation id. */ id: string; input: unknown; seed?: number; requestId?: string; maxInputBytes?: number; deadlineMs?: number; inlineResultBytes?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deadlineMs?: number; default: not declared - id: string; default: not declared — The operation id. - inlineResultBytes?: number; default: not declared - input: unknown; default: not declared - maxInputBytes?: number; default: not declared - requestId?: string; default: not declared - seed?: number; default: not declared ### @insiderfinance/totalfinance/cli#LocalJobRunnerInput Kind: interface; stability: preview (pre-1.0). ```typescript export interface LocalJobRunnerInput { registry: OperationRegistry; /** The store directory (absolute) jobs, artifacts, and workers share. */ directory: string; /** The profile the worker rebuilds the registry from — it must produce the same set as `registry`. */ profile: RegistryProfile; packs?: readonly string[]; clock: () => string; pollMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - clock: () => string; default: not declared - directory: string; default: not declared — The store directory (absolute) jobs, artifacts, and workers share. - packs?: readonly string[]; default: not declared - pollMs?: number; default: not declared - profile: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared — The profile the worker rebuilds the registry from — it must produce the same set as `registry`. - registry: OperationRegistry; default: not declared - registry.describe: (id: string) => import('@insiderfinance/totalfinance/workflows').OperationDescription; default: not declared - registry.describe().return.annotations: import('@insiderfinance/totalfinance/workflows').OperationAnnotations; default: not declared - registry.describe().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.describe().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.describe().return.description: string; default: not declared - registry.describe().return.deterministic: boolean; default: not declared - registry.describe().return.handleFields: string[]; default: not declared - registry.describe().return.id: string; default: not declared - registry.describe().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.describe().return.inputSchema: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.describe().return.outputSchema.$id?: string; default: not declared - registry.describe().return.outputSchema.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.describe().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.const?: unknown; default: not declared - registry.describe().return.outputSchema.default?: unknown; default: not declared - registry.describe().return.outputSchema.description?: string; default: not declared - registry.describe().return.outputSchema.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.format?: string; default: not declared - registry.describe().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.maxItems?: number; default: not declared - registry.describe().return.outputSchema.maxLength?: number; default: not declared - registry.describe().return.outputSchema.maximum?: number; default: not declared - registry.describe().return.outputSchema.minItems?: number; default: not declared - registry.describe().return.outputSchema.minLength?: number; default: not declared - registry.describe().return.outputSchema.minimum?: number; default: not declared - registry.describe().return.outputSchema.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.pattern?: string; default: not declared - registry.describe().return.outputSchema.properties?: Record; default: not declared - registry.describe().return.outputSchema.required?: string[]; default: not declared - registry.describe().return.outputSchema.title?: string; default: not declared - registry.describe().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.requiredCapabilities: string[]; default: not declared - registry.describe().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.describe().return.stochastic: boolean | 'per-call'; default: not declared - registry.describe().return.supportsCancellation: boolean; default: not declared - registry.describe().return.title: string; default: not declared - registry.describe().return.version: string; default: not declared - registry.describe(id): string; default: not declared - registry.get: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation | null; default: not declared - registry.get().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.get().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.get().return.description: string; default: not declared - registry.get().return.deterministic: boolean; default: not declared - registry.get().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.get().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.get().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.get().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.get().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.get().return.outputSchema.$id?: string; default: not declared - registry.get().return.outputSchema.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.get().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.get().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.const?: unknown; default: not declared - registry.get().return.outputSchema.default?: unknown; default: not declared - registry.get().return.outputSchema.description?: string; default: not declared - registry.get().return.outputSchema.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.format?: string; default: not declared - registry.get().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.maxItems?: number; default: not declared - registry.get().return.outputSchema.maxLength?: number; default: not declared - registry.get().return.outputSchema.maximum?: number; default: not declared - registry.get().return.outputSchema.minItems?: number; default: not declared - registry.get().return.outputSchema.minLength?: number; default: not declared - registry.get().return.outputSchema.minimum?: number; default: not declared - registry.get().return.outputSchema.multipleOf?: number; default: not declared - registry.get().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.pattern?: string; default: not declared - registry.get().return.outputSchema.properties?: Record; default: not declared - registry.get().return.outputSchema.required?: string[]; default: not declared - registry.get().return.outputSchema.title?: string; default: not declared - registry.get().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.requiredCapabilities: readonly string[]; default: not declared - registry.get().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.get().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.get().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.get().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.get().return.title: string; default: not declared - registry.get().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.get(id): string; default: not declared - registry.list: () => import('@insiderfinance/totalfinance/workflows').OperationDescription[]; default: not declared - registry.packs: () => import('@insiderfinance/totalfinance/workflows').OperationPack[]; default: not declared - registry.require: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - registry.require().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.require().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.require().return.description: string; default: not declared - registry.require().return.deterministic: boolean; default: not declared - registry.require().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.require().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.require().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.require().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.require().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.require().return.outputSchema.$id?: string; default: not declared - registry.require().return.outputSchema.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.require().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.require().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.const?: unknown; default: not declared - registry.require().return.outputSchema.default?: unknown; default: not declared - registry.require().return.outputSchema.description?: string; default: not declared - registry.require().return.outputSchema.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.format?: string; default: not declared - registry.require().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.maxItems?: number; default: not declared - registry.require().return.outputSchema.maxLength?: number; default: not declared - registry.require().return.outputSchema.maximum?: number; default: not declared - registry.require().return.outputSchema.minItems?: number; default: not declared - registry.require().return.outputSchema.minLength?: number; default: not declared - registry.require().return.outputSchema.minimum?: number; default: not declared - registry.require().return.outputSchema.multipleOf?: number; default: not declared - registry.require().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.pattern?: string; default: not declared - registry.require().return.outputSchema.properties?: Record; default: not declared - registry.require().return.outputSchema.required?: string[]; default: not declared - registry.require().return.outputSchema.title?: string; default: not declared - registry.require().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.requiredCapabilities: readonly string[]; default: not declared - registry.require().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.require().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.require().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.require().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.require().return.title: string; default: not declared - registry.require().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.require(id): string; default: not declared - registry.run: (request: { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions) => import('@insiderfinance/totalfinance/workflows').OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - registry.run().return.artifacts: import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - registry.run().return.assumptions: Record; default: not declared - registry.run().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; status: 'complete' | 'partial'; incomplete: string[]; }; default: not declared - registry.run().return.diagnostics.incomplete: string[]; default: not declared - registry.run().return.diagnostics.status: 'complete' | 'partial'; default: not declared - registry.run().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - registry.run().return.identity: { inputsHash: string; artifactIds: string[]; snapshotHash: string | null; }; default: not declared - registry.run().return.identity.artifactIds: string[]; default: not declared - registry.run().return.identity.inputsHash: string; default: not declared - registry.run().return.identity.snapshotHash: string | null; default: not declared - registry.run().return.library: { version: string; }; default: not declared - registry.run().return.library.version: string; default: not declared - registry.run().return.operation: { id: string; version: string; }; default: not declared - registry.run().return.operation.id: string; default: not declared - registry.run().return.operation.version: string; default: not declared - registry.run().return.structured: Record; default: not declared - registry.run().return.summary: string; default: not declared - registry.run().return.trace: { requestId: string | null; }; default: not declared - registry.run().return.trace.requestId: string | null; default: not declared - registry.run().return.usage: { inputBytes: number; elapsedMs: number | null; }; default: not declared - registry.run().return.usage.elapsedMs: number | null; default: not declared - registry.run().return.usage.inputBytes: number; default: not declared - registry.run(request): { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions; default: not declared - registry.run(request).artifacts?: import('@insiderfinance/totalfinance/workflows').ArtifactStore | import('@insiderfinance/totalfinance/workflows').ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - registry.run(request).artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - registry.run(request).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - registry.run(request).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - registry.run(request).capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - registry.run(request).createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - registry.run(request).deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - registry.run(request).defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - registry.run(request).id: string; default: not declared - registry.run(request).inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - registry.run(request).input: unknown; default: not declared - registry.run(request).maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - registry.run(request).now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - registry.run(request).requestId?: string; default: not declared - registry.run(request).signal?: import('@insiderfinance/totalfinance/workflows').OperationSignal; default: not declared - registry.run(request).stores?: { authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - registry.run(request).stores.authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; default: not declared - registry.run(request).stores.journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; default: not declared - registry.size: number; default: not declared ### @insiderfinance/totalfinance/cli#REGISTRY_PROFILES Kind: value; stability: preview (pre-1.0). ```typescript export declare const REGISTRY_PROFILES: readonly ('default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full')[]; ``` ### @insiderfinance/totalfinance/cli#RegistryProfile Kind: type; stability: preview (pre-1.0). ```typescript export type RegistryProfile = keyof typeof PROFILE_PACKS; ``` ### @insiderfinance/totalfinance/cli#SubmitJobInput Kind: interface; stability: preview (pre-1.0). ```typescript export interface SubmitJobInput { registry: OperationRegistry; jobs: JobStore; artifacts: ArtifactStore; /** The store directory a worker reopens (file stores are shared by path). */ directory: string; id: string; input: unknown; /** The profile (and optional pack narrowing) the worker rebuilds the registry from. */ profile: RegistryProfile; packs?: readonly string[]; /** The caller's clock: stamps `submittedAt`, handles, and every transition. */ clock: () => string; /** A job id; omitted ⇒ `job--`. */ jobId?: string; seed?: number; maxInputBytes?: number; deadlineMs?: number; inlineResultBytes?: number; /** How often the runner re-reads the store for an external cancel (ms, default 250). */ pollMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts: ArtifactStore; default: not declared - artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - artifacts.get().return.handle: ResourceHandle; default: not declared - artifacts.get().return.value: Record; default: not declared - artifacts.get(uri): string; default: not declared - artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - artifacts.list(filter)?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; } | undefined; default: not declared - artifacts.list(filter).kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => ResourceHandle; default: not declared - artifacts.put().return.contentHash: string | null; default: not declared - artifacts.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - artifacts.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - artifacts.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - artifacts.put().return.schema: string; default: not declared - artifacts.put().return.uri: string; default: not declared - artifacts.put().return.version: string; default: not declared - artifacts.put(input): import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput; default: not declared - artifacts.put(input).createdTimestampMs: number; default: not declared — Epoch ms — the caller's clock, never read by the library. - artifacts.put(input).expiresTimestampMs?: number; default: not declared — Epoch ms; must be after `createdTimestampMs`. - artifacts.put(input).kind: 'market' | 'portfolio' | 'report' | 'scenario' | 'authorization' | 'journal'; default: not declared - artifacts.put(input).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - artifacts.put(input).value: Record; default: not declared — The stored data — an envelope or an operation's structured result; JSON-safe by construction. - clock: () => string; default: not declared — The caller's clock: stamps `submittedAt`, handles, and every transition. - deadlineMs?: number; default: not declared - directory: string; default: not declared — The store directory a worker reopens (file stores are shared by path). - id: string; default: not declared - inlineResultBytes?: number; default: not declared - input: unknown; default: not declared - jobId?: string; default: not declared — A job id; omitted ⇒ `job--`. - jobs: JobStore; default: not declared - jobs.create: (record: JobRecord) => JobRecord; default: not declared - jobs.create().return.error: OperationError | null; default: not declared - jobs.create().return.error.code: string; default: not declared - jobs.create().return.error.context: Record; default: not declared - jobs.create().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.create().return.error.message: string; default: not declared - jobs.create().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.create().return.error.operation.id: string; default: not declared - jobs.create().return.error.operation.version: string; default: not declared - jobs.create().return.finishedAt: string | null; default: not declared - jobs.create().return.id: string; default: not declared - jobs.create().return.inputsHash: string; default: not declared - jobs.create().return.operation: { id: string; version: string; }; default: not declared - jobs.create().return.operation.id: string; default: not declared - jobs.create().return.operation.version: string; default: not declared - jobs.create().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.create().return.progress.fraction: number | null; default: not declared - jobs.create().return.progress.stage: string; default: not declared - jobs.create().return.result: ResourceHandle | null; default: not declared - jobs.create().return.result.contentHash: string | null; default: not declared - jobs.create().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.create().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.create().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.create().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.create().return.result.schema: string; default: not declared - jobs.create().return.result.uri: string; default: not declared - jobs.create().return.result.version: string; default: not declared - jobs.create().return.seed: number | null; default: not declared - jobs.create().return.startedAt: string | null; default: not declared - jobs.create().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.create().return.submittedAt: string; default: not declared - jobs.create().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.create().return.usage.elapsedMs: number | null; default: not declared - jobs.create(record): JobRecord; default: not declared - jobs.create(record).error: OperationError | null; default: not declared - jobs.create(record).error.code: string; default: not declared - jobs.create(record).error.context: Record; default: not declared - jobs.create(record).error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.create(record).error.message: string; default: not declared - jobs.create(record).error.operation: { id: string; version: string; } | null; default: not declared - jobs.create(record).error.operation.id: string; default: not declared - jobs.create(record).error.operation.version: string; default: not declared - jobs.create(record).finishedAt: string | null; default: not declared - jobs.create(record).id: string; default: not declared - jobs.create(record).inputsHash: string; default: not declared - jobs.create(record).operation: { id: string; version: string; }; default: not declared - jobs.create(record).operation.id: string; default: not declared - jobs.create(record).operation.version: string; default: not declared - jobs.create(record).progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.create(record).progress.fraction: number | null; default: not declared - jobs.create(record).progress.stage: string; default: not declared - jobs.create(record).result: ResourceHandle | null; default: not declared - jobs.create(record).result.contentHash: string | null; default: not declared - jobs.create(record).result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.create(record).result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.create(record).result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.create(record).result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.create(record).result.schema: string; default: not declared - jobs.create(record).result.uri: string; default: not declared - jobs.create(record).result.version: string; default: not declared - jobs.create(record).seed: number | null; default: not declared - jobs.create(record).startedAt: string | null; default: not declared - jobs.create(record).state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.create(record).submittedAt: string; default: not declared - jobs.create(record).usage: { elapsedMs: number | null; }; default: not declared - jobs.create(record).usage.elapsedMs: number | null; default: not declared - jobs.get: (id: string) => JobRecord | null; default: not declared - jobs.get().return.error: OperationError | null; default: not declared - jobs.get().return.error.code: string; default: not declared - jobs.get().return.error.context: Record; default: not declared - jobs.get().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.get().return.error.message: string; default: not declared - jobs.get().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.get().return.error.operation.id: string; default: not declared - jobs.get().return.error.operation.version: string; default: not declared - jobs.get().return.finishedAt: string | null; default: not declared - jobs.get().return.id: string; default: not declared - jobs.get().return.inputsHash: string; default: not declared - jobs.get().return.operation: { id: string; version: string; }; default: not declared - jobs.get().return.operation.id: string; default: not declared - jobs.get().return.operation.version: string; default: not declared - jobs.get().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.get().return.progress.fraction: number | null; default: not declared - jobs.get().return.progress.stage: string; default: not declared - jobs.get().return.result: ResourceHandle | null; default: not declared - jobs.get().return.result.contentHash: string | null; default: not declared - jobs.get().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.get().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.get().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.get().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.get().return.result.schema: string; default: not declared - jobs.get().return.result.uri: string; default: not declared - jobs.get().return.result.version: string; default: not declared - jobs.get().return.seed: number | null; default: not declared - jobs.get().return.startedAt: string | null; default: not declared - jobs.get().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.get().return.submittedAt: string; default: not declared - jobs.get().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.get().return.usage.elapsedMs: number | null; default: not declared - jobs.get(id): string; default: not declared - jobs.list: () => JobRecord[]; default: not declared - jobs.update: (id: string, patch: Partial>) => JobRecord; default: not declared - jobs.update().return.error: OperationError | null; default: not declared - jobs.update().return.error.code: string; default: not declared - jobs.update().return.error.context: Record; default: not declared - jobs.update().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.update().return.error.message: string; default: not declared - jobs.update().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.update().return.error.operation.id: string; default: not declared - jobs.update().return.error.operation.version: string; default: not declared - jobs.update().return.finishedAt: string | null; default: not declared - jobs.update().return.id: string; default: not declared - jobs.update().return.inputsHash: string; default: not declared - jobs.update().return.operation: { id: string; version: string; }; default: not declared - jobs.update().return.operation.id: string; default: not declared - jobs.update().return.operation.version: string; default: not declared - jobs.update().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.update().return.progress.fraction: number | null; default: not declared - jobs.update().return.progress.stage: string; default: not declared - jobs.update().return.result: ResourceHandle | null; default: not declared - jobs.update().return.result.contentHash: string | null; default: not declared - jobs.update().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.update().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.update().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.update().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.update().return.result.schema: string; default: not declared - jobs.update().return.result.uri: string; default: not declared - jobs.update().return.result.version: string; default: not declared - jobs.update().return.seed: number | null; default: not declared - jobs.update().return.startedAt: string | null; default: not declared - jobs.update().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.update().return.submittedAt: string; default: not declared - jobs.update().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.update().return.usage.elapsedMs: number | null; default: not declared - jobs.update(id): string; default: not declared - jobs.update(patch): Partial>; default: not declared - jobs.update(patch).error?: OperationError | null; default: not declared - jobs.update(patch).error.code: string; default: not declared - jobs.update(patch).error.context: Record; default: not declared - jobs.update(patch).error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.update(patch).error.message: string; default: not declared - jobs.update(patch).error.operation: { id: string; version: string; } | null; default: not declared - jobs.update(patch).error.operation.id: string; default: not declared - jobs.update(patch).error.operation.version: string; default: not declared - jobs.update(patch).finishedAt?: string | null; default: not declared - jobs.update(patch).inputsHash?: string; default: not declared - jobs.update(patch).operation?: { id: string; version: string; }; default: not declared - jobs.update(patch).operation.id: string; default: not declared - jobs.update(patch).operation.version: string; default: not declared - jobs.update(patch).progress?: { fraction: number | null; stage: string; } | null; default: not declared - jobs.update(patch).progress.fraction: number | null; default: not declared - jobs.update(patch).progress.stage: string; default: not declared - jobs.update(patch).result?: ResourceHandle | null; default: not declared - jobs.update(patch).result.contentHash: string | null; default: not declared - jobs.update(patch).result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.update(patch).result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.update(patch).result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.update(patch).result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.update(patch).result.schema: string; default: not declared - jobs.update(patch).result.uri: string; default: not declared - jobs.update(patch).result.version: string; default: not declared - jobs.update(patch).seed?: number | null; default: not declared - jobs.update(patch).startedAt?: string | null; default: not declared - jobs.update(patch).state?: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.update(patch).submittedAt?: string; default: not declared - jobs.update(patch).usage?: { elapsedMs: number | null; }; default: not declared - jobs.update(patch).usage.elapsedMs: number | null; default: not declared - maxInputBytes?: number; default: not declared - packs?: readonly string[]; default: not declared - pollMs?: number; default: not declared — How often the runner re-reads the store for an external cancel (ms, default 250). - profile: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared — The profile (and optional pack narrowing) the worker rebuilds the registry from. - registry: OperationRegistry; default: not declared - registry.describe: (id: string) => import('@insiderfinance/totalfinance/workflows').OperationDescription; default: not declared - registry.describe().return.annotations: import('@insiderfinance/totalfinance/workflows').OperationAnnotations; default: not declared - registry.describe().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.describe().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.describe().return.description: string; default: not declared - registry.describe().return.deterministic: boolean; default: not declared - registry.describe().return.handleFields: string[]; default: not declared - registry.describe().return.id: string; default: not declared - registry.describe().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.describe().return.inputSchema: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.describe().return.outputSchema.$id?: string; default: not declared - registry.describe().return.outputSchema.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.describe().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.const?: unknown; default: not declared - registry.describe().return.outputSchema.default?: unknown; default: not declared - registry.describe().return.outputSchema.description?: string; default: not declared - registry.describe().return.outputSchema.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.format?: string; default: not declared - registry.describe().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.maxItems?: number; default: not declared - registry.describe().return.outputSchema.maxLength?: number; default: not declared - registry.describe().return.outputSchema.maximum?: number; default: not declared - registry.describe().return.outputSchema.minItems?: number; default: not declared - registry.describe().return.outputSchema.minLength?: number; default: not declared - registry.describe().return.outputSchema.minimum?: number; default: not declared - registry.describe().return.outputSchema.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.pattern?: string; default: not declared - registry.describe().return.outputSchema.properties?: Record; default: not declared - registry.describe().return.outputSchema.required?: string[]; default: not declared - registry.describe().return.outputSchema.title?: string; default: not declared - registry.describe().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.requiredCapabilities: string[]; default: not declared - registry.describe().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.describe().return.stochastic: boolean | 'per-call'; default: not declared - registry.describe().return.supportsCancellation: boolean; default: not declared - registry.describe().return.title: string; default: not declared - registry.describe().return.version: string; default: not declared - registry.describe(id): string; default: not declared - registry.get: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation | null; default: not declared - registry.get().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.get().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.get().return.description: string; default: not declared - registry.get().return.deterministic: boolean; default: not declared - registry.get().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.get().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.get().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.get().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.get().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.get().return.outputSchema.$id?: string; default: not declared - registry.get().return.outputSchema.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.get().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.get().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.const?: unknown; default: not declared - registry.get().return.outputSchema.default?: unknown; default: not declared - registry.get().return.outputSchema.description?: string; default: not declared - registry.get().return.outputSchema.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.format?: string; default: not declared - registry.get().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.maxItems?: number; default: not declared - registry.get().return.outputSchema.maxLength?: number; default: not declared - registry.get().return.outputSchema.maximum?: number; default: not declared - registry.get().return.outputSchema.minItems?: number; default: not declared - registry.get().return.outputSchema.minLength?: number; default: not declared - registry.get().return.outputSchema.minimum?: number; default: not declared - registry.get().return.outputSchema.multipleOf?: number; default: not declared - registry.get().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.pattern?: string; default: not declared - registry.get().return.outputSchema.properties?: Record; default: not declared - registry.get().return.outputSchema.required?: string[]; default: not declared - registry.get().return.outputSchema.title?: string; default: not declared - registry.get().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.requiredCapabilities: readonly string[]; default: not declared - registry.get().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.get().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.get().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.get().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.get().return.title: string; default: not declared - registry.get().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.get(id): string; default: not declared - registry.list: () => import('@insiderfinance/totalfinance/workflows').OperationDescription[]; default: not declared - registry.packs: () => import('@insiderfinance/totalfinance/workflows').OperationPack[]; default: not declared - registry.require: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - registry.require().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.require().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.require().return.description: string; default: not declared - registry.require().return.deterministic: boolean; default: not declared - registry.require().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.require().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.require().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.require().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.require().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.require().return.outputSchema.$id?: string; default: not declared - registry.require().return.outputSchema.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.require().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.require().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.const?: unknown; default: not declared - registry.require().return.outputSchema.default?: unknown; default: not declared - registry.require().return.outputSchema.description?: string; default: not declared - registry.require().return.outputSchema.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.format?: string; default: not declared - registry.require().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.maxItems?: number; default: not declared - registry.require().return.outputSchema.maxLength?: number; default: not declared - registry.require().return.outputSchema.maximum?: number; default: not declared - registry.require().return.outputSchema.minItems?: number; default: not declared - registry.require().return.outputSchema.minLength?: number; default: not declared - registry.require().return.outputSchema.minimum?: number; default: not declared - registry.require().return.outputSchema.multipleOf?: number; default: not declared - registry.require().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.pattern?: string; default: not declared - registry.require().return.outputSchema.properties?: Record; default: not declared - registry.require().return.outputSchema.required?: string[]; default: not declared - registry.require().return.outputSchema.title?: string; default: not declared - registry.require().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.requiredCapabilities: readonly string[]; default: not declared - registry.require().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.require().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.require().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.require().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.require().return.title: string; default: not declared - registry.require().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.require(id): string; default: not declared - registry.run: (request: { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions) => import('@insiderfinance/totalfinance/workflows').OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - registry.run().return.artifacts: ResourceHandle[]; default: not declared - registry.run().return.assumptions: Record; default: not declared - registry.run().return.diagnostics: { incomplete: string[]; status: 'complete' | 'partial'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - registry.run().return.diagnostics.incomplete: string[]; default: not declared - registry.run().return.diagnostics.status: 'complete' | 'partial'; default: not declared - registry.run().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - registry.run().return.identity: { artifactIds: string[]; inputsHash: string; snapshotHash: string | null; }; default: not declared - registry.run().return.identity.artifactIds: string[]; default: not declared - registry.run().return.identity.inputsHash: string; default: not declared - registry.run().return.identity.snapshotHash: string | null; default: not declared - registry.run().return.library: { version: string; }; default: not declared - registry.run().return.library.version: string; default: not declared - registry.run().return.operation: { id: string; version: string; }; default: not declared - registry.run().return.operation.id: string; default: not declared - registry.run().return.operation.version: string; default: not declared - registry.run().return.structured: Record; default: not declared - registry.run().return.summary: string; default: not declared - registry.run().return.trace: { requestId: string | null; }; default: not declared - registry.run().return.trace.requestId: string | null; default: not declared - registry.run().return.usage: { elapsedMs: number | null; inputBytes: number; }; default: not declared - registry.run().return.usage.elapsedMs: number | null; default: not declared - registry.run().return.usage.inputBytes: number; default: not declared - registry.run(request): { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions; default: not declared - registry.run(request).artifacts?: ArtifactStore | import('@insiderfinance/totalfinance/workflows').ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - registry.run(request).artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - registry.run(request).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - registry.run(request).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => ResourceHandle; default: not declared - registry.run(request).capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - registry.run(request).createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - registry.run(request).deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - registry.run(request).defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - registry.run(request).id: string; default: not declared - registry.run(request).inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - registry.run(request).input: unknown; default: not declared - registry.run(request).maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - registry.run(request).now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - registry.run(request).requestId?: string; default: not declared - registry.run(request).signal?: import('@insiderfinance/totalfinance/workflows').OperationSignal; default: not declared - registry.run(request).stores?: { authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - registry.run(request).stores.authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; default: not declared - registry.run(request).stores.journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; default: not declared - registry.size: number; default: not declared - seed?: number; default: not declared ### @insiderfinance/totalfinance/cli#cancelJob Kind: function; stability: preview (pre-1.0). Cancel a job from ANY process: the record moves to `cancelled`; the running process's runner terminates its worker on the next poll. ```typescript export declare function cancelJob(input: { jobs: JobStore; id: string; clock: () => string; }): JobRecord; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { jobs: JobStore; id: string; clock: () => string; }; default: not declared - (input).clock: () => string; default: not declared - (input).id: string; default: not declared - (input).jobs: JobStore; default: not declared - return.error: OperationError | null; default: not declared - return.error.code: string; default: not declared - return.error.context: Record; default: not declared - return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - return.error.message: string; default: not declared - return.error.operation: { id: string; version: string; } | null; default: not declared - return.error.operation.id: string; default: not declared - return.error.operation.version: string; default: not declared - return.finishedAt: string | null; default: not declared - return.id: string; default: not declared - return.inputsHash: string; default: not declared - return.operation: { id: string; version: string; }; default: not declared - return.operation.id: string; default: not declared - return.operation.version: string; default: not declared - return.progress: { stage: string; fraction: number | null; } | null; default: not declared - return.progress.fraction: number | null; default: not declared - return.progress.stage: string; default: not declared - return.result: ResourceHandle | null; default: not declared - return.result.contentHash: string | null; default: not declared - return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - return.result.schema: string; default: not declared - return.result.uri: string; default: not declared - return.result.version: string; default: not declared - return.seed: number | null; default: not declared - return.startedAt: string | null; default: not declared - return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - return.submittedAt: string; default: not declared - return.usage: { elapsedMs: number | null; }; default: not declared - return.usage.elapsedMs: number | null; default: not declared ### @insiderfinance/totalfinance/cli#createFileArtifactStore Kind: function; stability: preview (pre-1.0). A file-backed artifact store: `/artifacts/_.json` per value, plus `/artifacts/index.json` listing every handle. Idempotent by content. ```typescript export declare function createFileArtifactStore(input: { directory: string; }): ArtifactStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { directory: string; }; default: not declared - (input).directory: string; default: not declared - return.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - return.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - return.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => ResourceHandle; default: not declared ### @insiderfinance/totalfinance/cli#createFileJobStore Kind: function; stability: preview (pre-1.0). A file-backed job store: `/jobs/.json` per record, re-read on every call. ```typescript export declare function createFileJobStore(input: { directory: string; }): JobStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { directory: string; }; default: not declared - (input).directory: string; default: not declared - return.create: (record: JobRecord) => JobRecord; default: not declared - return.get: (id: string) => JobRecord | null; default: not declared - return.list: () => JobRecord[]; default: not declared - return.update: (id: string, patch: Partial>) => JobRecord; default: not declared ### @insiderfinance/totalfinance/cli#createLocalJobRunner Kind: function; stability: preview (pre-1.0). ```typescript export declare function createLocalJobRunner(rawInput: LocalJobRunnerInput): JobRunner; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (rawInput): LocalJobRunnerInput; default: not declared - (rawInput).clock: () => string; default: not declared - (rawInput).directory: string; default: not declared — The store directory (absolute) jobs, artifacts, and workers share. - (rawInput).packs?: readonly string[]; default: not declared - (rawInput).pollMs?: number; default: not declared - (rawInput).profile: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared — The profile the worker rebuilds the registry from — it must produce the same set as `registry`. - (rawInput).registry: OperationRegistry; default: not declared - return.cancel: (id: string) => JobRecord; default: not declared - return.get: (id: string) => JobRecord | null; default: not declared - return.list: () => JobRecord[]; default: not declared - return.submit: (submission: JobSubmission) => JobRun; default: not declared ### @insiderfinance/totalfinance/cli#packsForProfile Kind: function; stability: preview (pre-1.0). The packs a profile selects — `full` is every shipped pack, the journey packs and the backtests included. ```typescript export declare function packsForProfile(profile: RegistryProfile): OperationPack[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (profile): 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared ### @insiderfinance/totalfinance/cli#registryForProfile Kind: function; stability: preview (pre-1.0). The registry for a profile, optionally narrowed to named packs (`--packs a,b`). ```typescript export declare function registryForProfile(input: { profile: RegistryProfile; packs?: readonly string[]; }): OperationRegistry; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { profile: RegistryProfile; packs?: readonly string[]; }; default: not declared - (input).packs?: readonly string[]; default: not declared - (input).profile: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared - return.describe: (id: string) => import('@insiderfinance/totalfinance/workflows').OperationDescription; default: not declared - return.get: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation | null; default: not declared - return.list: () => import('@insiderfinance/totalfinance/workflows').OperationDescription[]; default: not declared - return.packs: () => OperationPack[]; default: not declared - return.require: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - return.run: (request: { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions) => import('@insiderfinance/totalfinance/workflows').OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - return.size: number; default: not declared ### @insiderfinance/totalfinance/cli#submitJob Kind: function; stability: preview (pre-1.0). Submit an operation: a job-class operation runs in a terminated-on-cancel worker; any other operation runs inline and its record is already terminal on return. ```typescript export declare function submitJob(rawInput: SubmitJobInput): JobRun; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (rawInput): SubmitJobInput; default: not declared - (rawInput).artifacts: ArtifactStore; default: not declared - (rawInput).clock: () => string; default: not declared — The caller's clock: stamps `submittedAt`, handles, and every transition. - (rawInput).deadlineMs?: number; default: not declared - (rawInput).directory: string; default: not declared — The store directory a worker reopens (file stores are shared by path). - (rawInput).id: string; default: not declared - (rawInput).inlineResultBytes?: number; default: not declared - (rawInput).input: unknown; default: not declared - (rawInput).jobId?: string; default: not declared — A job id; omitted ⇒ `job--`. - (rawInput).jobs: JobStore; default: not declared - (rawInput).maxInputBytes?: number; default: not declared - (rawInput).packs?: readonly string[]; default: not declared - (rawInput).pollMs?: number; default: not declared — How often the runner re-reads the store for an external cancel (ms, default 250). - (rawInput).profile: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared — The profile (and optional pack narrowing) the worker rebuilds the registry from. - (rawInput).registry: OperationRegistry; default: not declared - (rawInput).seed?: number; default: not declared - return.cancel: () => Promise; default: not declared — Terminate the worker now; resolves with the cancelled (or already terminal) record. - return.completion: Promise; default: not declared — Resolves with the terminal record — completed, failed, or cancelled. Never rejects. - return.record: JobRecord; default: not declared — The record as accepted (or, for an inline non-job operation, as completed). ## Entrypoint @insiderfinance/totalfinance/commodities ### @insiderfinance/totalfinance/commodities#CalendarSpreadInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link calendarSpread}. ```typescript // --------------------------------------------------------------------------------------------------- // Calendar and curve spreads // --------------------------------------------------------------------------------------------------- /** Input for {@link calendarSpread}. */ export interface CalendarSpreadInput { /** The nearer delivery — `nearPoint.timeToDeliveryYears < farPoint.timeToDeliveryYears`. */ nearPoint: CommodityCurvePoint; /** The farther delivery. */ farPoint: CommodityCurvePoint; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - farPoint: CommodityCurvePoint; default: not declared — The farther delivery. - farPoint.forwardPrice: number; default: not declared — The forward (or futures) price at that delivery, > 0. - farPoint.timeToDeliveryYears: number; default: not declared — Time to delivery in years, ≥ 0; strictly ascending across a curve. - nearPoint: CommodityCurvePoint; default: not declared — The nearer delivery — `nearPoint.timeToDeliveryYears < farPoint.timeToDeliveryYears`. - nearPoint.forwardPrice: number; default: not declared — The forward (or futures) price at that delivery, > 0. - nearPoint.timeToDeliveryYears: number; default: not declared — Time to delivery in years, ≥ 0; strictly ascending across a curve. ### @insiderfinance/totalfinance/commodities#CalendarSpreadResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link calendarSpread}. ```typescript /** Result of {@link calendarSpread}. */ export interface CalendarSpreadResult { /** `farPoint.forwardPrice − nearPoint.forwardPrice` (price units). */ spread: number; /** * The CONTINUOUS carry between the two deliveries: * `ln(farPoint.forwardPrice / nearPoint.forwardPrice) / (farTime − nearTime)`. */ annualizedSpreadRate: number; assumptions: { /** The fixed convention prose: continuous carry between the two deliveries. */ annualizedSpreadRateConvention: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedSpreadRate: number; default: not declared — The CONTINUOUS carry between the two deliveries: `ln(farPoint.forwardPrice / nearPoint.forwardPrice) / (farTime − nearTime)`. - assumptions: { annualizedSpreadRateConvention: string; }; default: not declared - assumptions.annualizedSpreadRateConvention: string; default: not declared — The fixed convention prose: continuous carry between the two deliveries. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - spread: number; default: not declared — `farPoint.forwardPrice − nearPoint.forwardPrice` (price units). ### @insiderfinance/totalfinance/commodities#CommodityBasisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link commodityBasis}. ```typescript /** Input for {@link commodityBasis}. */ export interface CommodityBasisInput { /** Spot price, > 0. */ spotPrice: number; /** The quoted futures price, > 0. */ futuresPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - futuresPrice: number; default: not declared — The quoted futures price, > 0. - spotPrice: number; default: not declared — Spot price, > 0. ### @insiderfinance/totalfinance/commodities#CommodityBasisResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link commodityBasis}. ```typescript /** Result of {@link commodityBasis}. */ export interface CommodityBasisResult { /** `spotPrice − futuresPrice` — the basis in price units. */ basis: number; /** `spotPrice / futuresPrice − 1` — the basis as a fraction of the futures price. */ basisFraction: number; assumptions: { /** The fixed basis definition prose: price difference and fraction, both named. */ definition: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { definition: string; }; default: not declared - assumptions.definition: string; default: not declared — The fixed basis definition prose: price difference and fraction, both named. - basis: number; default: not declared — `spotPrice − futuresPrice` — the basis in price units. - basisFraction: number; default: not declared — `spotPrice / futuresPrice − 1` — the basis as a fraction of the futures price. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#CommodityCarryInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link commodityCarry}. ```typescript // --------------------------------------------------------------------------------------------------- // Implied carry and its components // --------------------------------------------------------------------------------------------------- /** Input for {@link commodityCarry}. */ export interface CommodityCarryInput { /** Spot price, > 0. */ spotPrice: number; /** The observed forward (or futures) price for the delivery date, > 0. */ forwardPrice: number; /** Time to delivery in years, > 0 — carry over zero time is undefined, not zero. */ timeToDeliveryYears: number; /** REQUIRED compounding convention used to annualize the implied carry. */ compounding: InterestCompounding; /** Optional supplied component: annual financing rate, decimal. */ annualFinancingRate?: number; /** Optional supplied component: annual proportional storage cost rate, decimal. */ annualStorageCostRate?: number; /** Optional supplied component: annual convenience yield, decimal. */ annualConvenienceYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualConvenienceYield?: number; default: not declared — Optional supplied component: annual convenience yield, decimal. - annualFinancingRate?: number; default: not declared — Optional supplied component: annual financing rate, decimal. - annualStorageCostRate?: number; default: not declared — Optional supplied component: annual proportional storage cost rate, decimal. - compounding: InterestCompounding; default: not declared — REQUIRED compounding convention used to annualize the implied carry. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - forwardPrice: number; default: not declared — The observed forward (or futures) price for the delivery date, > 0. - spotPrice: number; default: not declared — Spot price, > 0. - timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0 — carry over zero time is undefined, not zero. ### @insiderfinance/totalfinance/commodities#CommodityCarryResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link commodityCarry}. ```typescript /** Result of {@link commodityCarry}. */ export interface CommodityCarryResult { /** * The annualized total carry implied by the spot/forward pair: the rate `r` with * `spotPrice × G(r, timeToDeliveryYears) = forwardPrice` (for `'continuous'`, * `ln(forwardPrice / spotPrice) / timeToDeliveryYears`). */ annualizedCarryRate: number; /** The supplied components, echoed — present when at least one was supplied. */ components?: { annualFinancingRate?: number; annualStorageCostRate?: number; annualConvenienceYield?: number; }; /** * `annualizedCarryRate − (financing + storage − convenience)` — the cost-of-carry parity law * made visible. Present exactly when all three components were supplied. */ impliedResidual?: number; assumptions: { compounding: InterestCompounding; /** The fixed carry definition prose: the rate whose growth factor maps spot to forward. */ carryDefinition: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedCarryRate: number; default: not declared — The annualized total carry implied by the spot/forward pair: the rate `r` with `spotPrice × G(r, timeToDeliveryYears) = forwardPrice` (for `'continuous'`, `ln(forwardPrice / spotPrice) / timeToDeliveryYears`). - assumptions: { carryDefinition: string; compounding: InterestCompounding; }; default: not declared - assumptions.carryDefinition: string; default: not declared — The fixed carry definition prose: the rate whose growth factor maps spot to forward. - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - components?: { annualConvenienceYield?: number; annualFinancingRate?: number; annualStorageCostRate?: number; }; default: not declared — The supplied components, echoed — present when at least one was supplied. - components.annualConvenienceYield?: number; default: not declared - components.annualFinancingRate?: number; default: not declared - components.annualStorageCostRate?: number; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - impliedResidual?: number; default: not declared — `annualizedCarryRate − (financing + storage − convenience)` — the cost-of-carry parity law made visible. Present exactly when all three components were supplied. ### @insiderfinance/totalfinance/commodities#CommodityCurvePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One point on a commodity forward curve. ```typescript // --------------------------------------------------------------------------------------------------- // The curve // --------------------------------------------------------------------------------------------------- /** One point on a commodity forward curve. */ export interface CommodityCurvePoint { /** Time to delivery in years, ≥ 0; strictly ascending across a curve. */ timeToDeliveryYears: number; /** The forward (or futures) price at that delivery, > 0. */ forwardPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forwardPrice: number; default: not declared — The forward (or futures) price at that delivery, > 0. - timeToDeliveryYears: number; default: not declared — Time to delivery in years, ≥ 0; strictly ascending across a curve. ### @insiderfinance/totalfinance/commodities#CommodityForwardPriceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link commodityForwardPrice} — the FROZEN first-touch field set. ```typescript // --------------------------------------------------------------------------------------------------- // Theoretical forward price // --------------------------------------------------------------------------------------------------- /** Input for {@link commodityForwardPrice} — the FROZEN first-touch field set. */ export interface CommodityForwardPriceInput { /** Spot price of the commodity, > 0, in the quote currency per unit. */ spotPrice: number; /** Time to delivery in years, ≥ 0 (zero prices the forward at spot exactly). */ timeToDeliveryYears: number; /** Annual financing (interest) rate, decimal. */ annualFinancingRate: number; /** * Annual storage cost as a PROPORTIONAL rate of the commodity's value, decimal — not a dollar * amount per unit (v1 models storage as a continuous proportional drag, like a negative yield). */ annualStorageCostRate: number; /** Annual convenience yield, decimal — the benefit of holding the physical commodity. */ annualConvenienceYield: number; /** REQUIRED compounding convention — a market instrument never defaults its convention. */ compounding: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualConvenienceYield: number; default: not declared — Annual convenience yield, decimal — the benefit of holding the physical commodity. - annualFinancingRate: number; default: not declared — Annual financing (interest) rate, decimal. - annualStorageCostRate: number; default: not declared — Annual storage cost as a PROPORTIONAL rate of the commodity's value, decimal — not a dollar amount per unit (v1 models storage as a continuous proportional drag, like a negative yield). - compounding: InterestCompounding; default: not declared — REQUIRED compounding convention — a market instrument never defaults its convention. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - spotPrice: number; default: not declared — Spot price of the commodity, > 0, in the quote currency per unit. - timeToDeliveryYears: number; default: not declared — Time to delivery in years, ≥ 0 (zero prices the forward at spot exactly). ### @insiderfinance/totalfinance/commodities#CommodityForwardValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link commodityForwardValue}. ```typescript // --------------------------------------------------------------------------------------------------- // Current contract value // --------------------------------------------------------------------------------------------------- /** Input for {@link commodityForwardValue}. */ export interface CommodityForwardValueInput { /** The forward price STRUCK on the existing contract (the delivery price agreed at inception). */ contractForwardPrice: number; /** * The CURRENT forward price for the same delivery date — a market quote or a theoretical price * from {@link commodityForwardPrice}; either way, a forward PRICE, not a contract value. */ currentForwardPrice: number; /** Number of units underlying the contract, > 0. */ quantity: number; /** * EXPLICIT discount factor from the delivery date back to the valuation instant, > 0 — the * matched-conventions law: the factor carries its own curve, day count, and compounding, so this * function never re-derives one from a rate it would have to guess conventions for. */ discountFactorToDelivery: number; /** Which side of the contract is being valued. */ perspective: 'long' | 'short'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contractForwardPrice: number; default: not declared — The forward price STRUCK on the existing contract (the delivery price agreed at inception). - currentForwardPrice: number; default: not declared — The CURRENT forward price for the same delivery date — a market quote or a theoretical price from {@link commodityForwardPrice}; either way, a forward PRICE, not a contract value. - discountFactorToDelivery: number; default: not declared — EXPLICIT discount factor from the delivery date back to the valuation instant, > 0 — the matched-conventions law: the factor carries its own curve, day count, and compounding, so this function never re-derives one from a rate it would have to guess conventions for. - perspective: 'long' | 'short'; default: not declared — Which side of the contract is being valued. - quantity: number; default: not declared — Number of units underlying the contract, > 0. ### @insiderfinance/totalfinance/commodities#CommodityForwardValueResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link commodityForwardValue}. ```typescript /** Result of {@link commodityForwardValue}. */ export interface CommodityForwardValueResult { /** The CURRENT VALUE of the existing contract to the stated side (quote currency). */ contractValue: number; assumptions: { perspective: 'long' | 'short'; /** The factor as supplied — its conventions belong to the caller's curve. */ discountFactorToDelivery: number; /** The fixed valuation prose: ±(current − contract) × quantity × factor, long positive. */ valuationConvention: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { discountFactorToDelivery: number; perspective: 'long' | 'short'; valuationConvention: string; }; default: not declared - assumptions.discountFactorToDelivery: number; default: not declared — The factor as supplied — its conventions belong to the caller's curve. - assumptions.perspective: 'long' | 'short'; default: not declared - assumptions.valuationConvention: string; default: not declared — The fixed valuation prose: ±(current − contract) × quantity × factor, long positive. - contractValue: number; default: not declared — The CURRENT VALUE of the existing contract to the stated side (quote currency). - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#ConvertCommodityQuantityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link convertCommodityQuantity}. ```typescript // --------------------------------------------------------------------------------------------------- // Unit conversion — the explicit-factor law // --------------------------------------------------------------------------------------------------- /** Input for {@link convertCommodityQuantity}. */ export interface ConvertCommodityQuantityInput { quantity: number; /** The unit the quantity is currently in — a label, echoed (e.g. 'barrel'). */ fromUnit: string; /** The target unit — a label, echoed (e.g. 'gallon'). */ toUnit: string; /** * REQUIRED explicit factor: target units per one source unit. The generic engine does not * invent conversion factors (per spec) — 42 gallons per barrel is the CALLER's physical fact. */ conversionFactor: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conversionFactor: number; default: not declared — REQUIRED explicit factor: target units per one source unit. The generic engine does not invent conversion factors (per spec) — 42 gallons per barrel is the CALLER's physical fact. - fromUnit: string; default: not declared — The unit the quantity is currently in — a label, echoed (e.g. 'barrel'). - quantity: number; default: not declared - toUnit: string; default: not declared — The target unit — a label, echoed (e.g. 'gallon'). ### @insiderfinance/totalfinance/commodities#ConvertCommodityQuantityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link convertCommodityQuantity}. ```typescript /** Result of {@link convertCommodityQuantity}. */ export interface ConvertCommodityQuantityResult { /** `quantity × conversionFactor`, in `toUnit`. */ convertedQuantity: number; assumptions: { fromUnit: string; toUnit: string; conversionFactor: number; /** The fixed source prose: the factor is the caller's physical fact. */ conversionSource: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conversionFactor: number; conversionSource: string; fromUnit: string; toUnit: string; }; default: not declared - assumptions.conversionFactor: number; default: not declared - assumptions.conversionSource: string; default: not declared — The fixed source prose: the factor is the caller's physical fact. - assumptions.fromUnit: string; default: not declared - assumptions.toUnit: string; default: not declared - convertedQuantity: number; default: not declared — `quantity × conversionFactor`, in `toUnit`. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#CurveSpreadAnalyticsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link curveSpreadAnalytics}. ```typescript /** Input for {@link curveSpreadAnalytics}. */ export interface CurveSpreadAnalyticsInput { /** The forward curve — ≥ 2 points, strictly ascending delivery times. */ curve: readonly CommodityCurvePoint[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - curve: readonly CommodityCurvePoint[]; default: not declared — The forward curve — ≥ 2 points, strictly ascending delivery times. ### @insiderfinance/totalfinance/commodities#CurveSpreadAnalyticsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link curveSpreadAnalytics}. ```typescript /** Result of {@link curveSpreadAnalytics}. */ export interface CurveSpreadAnalyticsResult { /** One row per adjacent pair, in curve order. */ adjacentSpreads: CurveSpreadRow[]; /** The overall figures from the first delivery to the last. */ frontToBack: CurveSpreadRow; assumptions: { /** The fixed convention prose: continuous carry per row. */ annualizedSpreadRateConvention: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjacentSpreads: CurveSpreadRow[]; default: not declared — One row per adjacent pair, in curve order. - assumptions: { annualizedSpreadRateConvention: string; }; default: not declared - assumptions.annualizedSpreadRateConvention: string; default: not declared — The fixed convention prose: continuous carry per row. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - frontToBack: CurveSpreadRow; default: not declared — The overall figures from the first delivery to the last. - frontToBack.annualizedSpreadRate: number; default: not declared — Continuous carry between the two deliveries: `ln(to / from) / (toTime − fromTime)`. - frontToBack.fromTimeYears: number; default: not declared - frontToBack.spread: number; default: not declared — `forwardPrice(to) − forwardPrice(from)` (price units). - frontToBack.toTimeYears: number; default: not declared ### @insiderfinance/totalfinance/commodities#CurveSpreadRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One adjacent-pair (or front-to-back) spread row. ```typescript /** One adjacent-pair (or front-to-back) spread row. */ export interface CurveSpreadRow { fromTimeYears: number; toTimeYears: number; /** `forwardPrice(to) − forwardPrice(from)` (price units). */ spread: number; /** Continuous carry between the two deliveries: `ln(to / from) / (toTime − fromTime)`. */ annualizedSpreadRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedSpreadRate: number; default: not declared — Continuous carry between the two deliveries: `ln(to / from) / (toTime − fromTime)`. - fromTimeYears: number; default: not declared - spread: number; default: not declared — `forwardPrice(to) − forwardPrice(from)` (price units). - toTimeYears: number; default: not declared ### @insiderfinance/totalfinance/commodities#FuturesHedgeRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link futuresHedgeRatio}. ```typescript // --------------------------------------------------------------------------------------------------- // Hedge ratio and basis // --------------------------------------------------------------------------------------------------- /** Input for {@link futuresHedgeRatio}. */ export interface FuturesHedgeRatioInput { /** The exposure being hedged, in commodity units (sign carries the direction). */ exposureQuantity: number; /** Units of the commodity per futures contract, > 0. */ futuresContractSize: number; /** * The minimum-variance hedge ratio (a regression beta or hedge effectiveness), default 1 — a * one-to-one hedge, echoed as such in the assumptions. */ betaOrHedgeEffectiveness?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - betaOrHedgeEffectiveness?: number; default: not declared — The minimum-variance hedge ratio (a regression beta or hedge effectiveness), default 1 — a one-to-one hedge, echoed as such in the assumptions. - exposureQuantity: number; default: not declared — The exposure being hedged, in commodity units (sign carries the direction). - futuresContractSize: number; default: not declared — Units of the commodity per futures contract, > 0. ### @insiderfinance/totalfinance/commodities#FuturesHedgeRatioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link futuresHedgeRatio}. ```typescript /** Result of {@link futuresHedgeRatio}. */ export interface FuturesHedgeRatioResult { /** * `exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize` — a REAL number, not * rounded: rounding to whole contracts is the caller's execution decision, disclosed in the * assumptions rather than taken silently. */ contractsRequired: number; assumptions: { betaOrHedgeEffectiveness: number; hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; /** The fixed rounding prose: the count is real-valued; rounding is the caller's decision. */ rounding: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { betaOrHedgeEffectiveness: number; hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; rounding: string; }; default: not declared - assumptions.betaOrHedgeEffectiveness: number; default: not declared - assumptions.hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; default: not declared - assumptions.rounding: string; default: not declared — The fixed rounding prose: the count is real-valued; rounding is the caller's decision. - contractsRequired: number; default: not declared — `exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize` — a REAL number, not rounded: rounding to whole contracts is the caller's execution decision, disclosed in the assumptions rather than taken silently. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#ImpliedConvenienceYieldInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link impliedConvenienceYield}. ```typescript /** Input for {@link impliedConvenienceYield}. */ export interface ImpliedConvenienceYieldInput { /** Spot price, > 0. */ spotPrice: number; /** The observed forward (or futures) price, > 0. */ forwardPrice: number; /** Time to delivery in years, > 0. */ timeToDeliveryYears: number; /** Annual financing rate, decimal. */ annualFinancingRate: number; /** Annual proportional storage cost rate, decimal. */ annualStorageCostRate: number; /** REQUIRED compounding convention. */ compounding: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualFinancingRate: number; default: not declared — Annual financing rate, decimal. - annualStorageCostRate: number; default: not declared — Annual proportional storage cost rate, decimal. - compounding: InterestCompounding; default: not declared — REQUIRED compounding convention. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - forwardPrice: number; default: not declared — The observed forward (or futures) price, > 0. - spotPrice: number; default: not declared — Spot price, > 0. - timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0. ### @insiderfinance/totalfinance/commodities#ImpliedConvenienceYieldResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link impliedConvenienceYield}. ```typescript /** Result of {@link impliedConvenienceYield}. */ export interface ImpliedConvenienceYieldResult { /** `annualFinancingRate + annualStorageCostRate − annualizedCarry` — the yield the pair implies. */ impliedAnnualConvenienceYield: number; assumptions: { compounding: InterestCompounding; /** The fixed inversion prose: convenience = financing + storage − implied carry. */ inversion: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { compounding: InterestCompounding; inversion: string; }; default: not declared - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.inversion: string; default: not declared — The fixed inversion prose: convenience = financing + storage − implied carry. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - impliedAnnualConvenienceYield: number; default: not declared — `annualFinancingRate + annualStorageCostRate − annualizedCarry` — the yield the pair implies. ### @insiderfinance/totalfinance/commodities#ImpliedStorageCostInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link impliedStorageCost}. ```typescript /** Input for {@link impliedStorageCost}. */ export interface ImpliedStorageCostInput { /** Spot price, > 0. */ spotPrice: number; /** The observed forward (or futures) price, > 0. */ forwardPrice: number; /** Time to delivery in years, > 0. */ timeToDeliveryYears: number; /** Annual financing rate, decimal. */ annualFinancingRate: number; /** Annual convenience yield, decimal. */ annualConvenienceYield: number; /** REQUIRED compounding convention. */ compounding: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualConvenienceYield: number; default: not declared — Annual convenience yield, decimal. - annualFinancingRate: number; default: not declared — Annual financing rate, decimal. - compounding: InterestCompounding; default: not declared — REQUIRED compounding convention. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - forwardPrice: number; default: not declared — The observed forward (or futures) price, > 0. - spotPrice: number; default: not declared — Spot price, > 0. - timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0. ### @insiderfinance/totalfinance/commodities#ImpliedStorageCostResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link impliedStorageCost}. ```typescript /** Result of {@link impliedStorageCost}. */ export interface ImpliedStorageCostResult { /** `annualizedCarry − annualFinancingRate + annualConvenienceYield` — the rate the pair implies. */ impliedAnnualStorageCostRate: number; assumptions: { compounding: InterestCompounding; /** The fixed inversion prose: storage = implied carry − financing + convenience. */ inversion: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { compounding: InterestCompounding; inversion: string; }; default: not declared - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.inversion: string; default: not declared — The fixed inversion prose: storage = implied carry − financing + convenience. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - impliedAnnualStorageCostRate: number; default: not declared — `annualizedCarry − annualFinancingRate + annualConvenienceYield` — the rate the pair implies. ### @insiderfinance/totalfinance/commodities#RollReturnDecompositionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link rollReturnDecomposition}. ```typescript /** Input for {@link rollReturnDecomposition}. */ export interface RollReturnDecompositionInput { /** Spot price at the start of the holding period, > 0. */ initialSpotPrice: number; /** Spot price at the end of the holding period (the roll instant), > 0. */ finalSpotPrice: number; /** Price of the held contract at the start of the holding period, > 0. */ initialContractPrice: number; /** Price of the held contract at the end of the holding period, BEFORE rolling, > 0. */ finalContractPriceBeforeRoll: number; /** Price of the next contract at the roll instant, > 0. */ nextContractPriceAtRoll: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - finalContractPriceBeforeRoll: number; default: not declared — Price of the held contract at the end of the holding period, BEFORE rolling, > 0. - finalSpotPrice: number; default: not declared — Spot price at the end of the holding period (the roll instant), > 0. - initialContractPrice: number; default: not declared — Price of the held contract at the start of the holding period, > 0. - initialSpotPrice: number; default: not declared — Spot price at the start of the holding period, > 0. - nextContractPriceAtRoll: number; default: not declared — Price of the next contract at the roll instant, > 0. ### @insiderfinance/totalfinance/commodities#RollReturnDecompositionResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link rollReturnDecomposition}. ```typescript /** Result of {@link rollReturnDecomposition}. */ export interface RollReturnDecompositionResult { /** * The OBSERVED total return on the held contract over the holding period: * `finalContractPriceBeforeRoll / initialContractPrice − 1`. */ totalHoldingReturn: number; /** `finalSpotPrice / initialSpotPrice − 1` — the spot move over the period. */ spotMoveReturn: number; /** * The change in the contract's basis ratio to spot over the period: * `(finalContractPriceBeforeRoll / finalSpotPrice) / (initialContractPrice / initialSpotPrice) − 1` * — the carry/convergence earned as the contract pulls toward spot (positive for a long in * backwardation). */ carryConvergenceReturn: number; /** * The roll leg, stated SEPARATELY: the roll is cash-neutral at execution, so its yield * `(finalContractPriceBeforeRoll − nextContractPriceAtRoll) / nextContractPriceAtRoll` accrues * over the NEXT holding period and is never added into `totalHoldingReturn`. */ rollLeg: { rollYieldFraction: number; /** The fixed roll-leg prose: cash-neutral at execution, accrues next period. */ convention: string; }; assumptions: { /** The fixed reconciliation prose: the components compound exactly to the observed total. */ reconciliation: string; declaredResidualBound: 1e-12; }; diagnostics: { warnings: string[]; /** `(1 + totalHoldingReturn) − (1 + spotMoveReturn) × (1 + carryConvergenceReturn)` — floating point only. */ reconciliationResidual: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { declaredResidualBound: 1e-12; reconciliation: string; }; default: not declared - assumptions.declaredResidualBound: 1e-12; default: not declared - assumptions.reconciliation: string; default: not declared — The fixed reconciliation prose: the components compound exactly to the observed total. - carryConvergenceReturn: number; default: not declared — The change in the contract's basis ratio to spot over the period: `(finalContractPriceBeforeRoll / finalSpotPrice) / (initialContractPrice / initialSpotPrice) − 1` — the carry/convergence earned as the contract pulls toward spot (positive for a long in backwardation). - diagnostics: { reconciliationResidual: number; warnings: string[]; }; default: not declared - diagnostics.reconciliationResidual: number; default: not declared — `(1 + totalHoldingReturn) − (1 + spotMoveReturn) × (1 + carryConvergenceReturn)` — floating point only. - diagnostics.warnings: string[]; default: not declared - rollLeg: { convention: string; rollYieldFraction: number; }; default: not declared — The roll leg, stated SEPARATELY: the roll is cash-neutral at execution, so its yield `(finalContractPriceBeforeRoll − nextContractPriceAtRoll) / nextContractPriceAtRoll` accrues over the NEXT holding period and is never added into `totalHoldingReturn`. - rollLeg.convention: string; default: not declared — The fixed roll-leg prose: cash-neutral at execution, accrues next period. - rollLeg.rollYieldFraction: number; default: not declared - spotMoveReturn: number; default: not declared — `finalSpotPrice / initialSpotPrice − 1` — the spot move over the period. - totalHoldingReturn: number; default: not declared — The OBSERVED total return on the held contract over the holding period: `finalContractPriceBeforeRoll / initialContractPrice − 1`. ### @insiderfinance/totalfinance/commodities#RollYieldInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link rollYield}. ```typescript // --------------------------------------------------------------------------------------------------- // Roll yield and roll-return decomposition // --------------------------------------------------------------------------------------------------- /** Input for {@link rollYield}. */ export interface RollYieldInput { /** Price of the contract being rolled OUT of (the expiring one), > 0. */ expiringContractPrice: number; /** Price of the contract being rolled INTO (the next one), > 0. */ nextContractPrice: number; /** * The spot price at the roll instant, > 0 — supplied only when observed. Without it the * spot-relative decomposition is ABSENT with its reason, never guessed. */ spotPriceAtRoll?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiringContractPrice: number; default: not declared — Price of the contract being rolled OUT of (the expiring one), > 0. - nextContractPrice: number; default: not declared — Price of the contract being rolled INTO (the next one), > 0. - spotPriceAtRoll?: number; default: not declared — The spot price at the roll instant, > 0 — supplied only when observed. Without it the spot-relative decomposition is ABSENT with its reason, never guessed. ### @insiderfinance/totalfinance/commodities#RollYieldResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link rollYield}. ```typescript /** Result of {@link rollYield}. */ export interface RollYieldResult { /** * `(expiringContractPrice − nextContractPrice) / nextContractPrice` — the yield a long roller * locks in for the next holding period under a static curve. SIGN LAW: positive in * backwardation (next below expiring), negative in contango. */ rollYieldFraction: number; /** * Spot-relative decomposition, present exactly when `spotPriceAtRoll` was supplied. The two * components COMPOUND (they do not sum): with `e = expiringVersusSpotFraction` and * `n = nextVersusSpotFraction`, `(1 + rollYieldFraction) = (1 + e) / (1 + n)` EXACTLY — an * algebraic identity, since `(E/S) / (N/S) = E/N`. */ decomposition?: { /** * `(expiringContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the expiring contract's * residual basis to spot (near zero when rolled at expiry; the carry already converged). */ expiringVersusSpotFraction: number; /** * `(nextContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the curve slope out to the next * contract; NEGATIVE in backwardation, which is exactly where positive roll yield comes from. */ nextVersusSpotFraction: number; }; /** Present exactly when the decomposition is absent — the reason, never a guessed spot. */ decompositionAbsentReason?: string; assumptions: { /** The fixed direction prose: a long roller out of the expiring contract into the next. */ rollDirection: string; /** The fixed sign-law prose: positive in backwardation, negative in contango. */ signLaw: string; /** The fixed decomposition prose: the spot-relative components compound exactly. */ decompositionConvention: string; }; diagnostics: { warnings: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { decompositionConvention: string; rollDirection: string; signLaw: string; }; default: not declared - assumptions.decompositionConvention: string; default: not declared — The fixed decomposition prose: the spot-relative components compound exactly. - assumptions.rollDirection: string; default: not declared — The fixed direction prose: a long roller out of the expiring contract into the next. - assumptions.signLaw: string; default: not declared — The fixed sign-law prose: positive in backwardation, negative in contango. - decomposition?: { expiringVersusSpotFraction: number; nextVersusSpotFraction: number; }; default: not declared — Spot-relative decomposition, present exactly when `spotPriceAtRoll` was supplied. The two components COMPOUND (they do not sum): with `e = expiringVersusSpotFraction` and `n = nextVersusSpotFraction`, `(1 + rollYieldFraction) = (1 + e) / (1 + n)` EXACTLY — an algebraic identity, since `(E/S) / (N/S) = E/N`. - decomposition.expiringVersusSpotFraction: number; default: not declared — `(expiringContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the expiring contract's residual basis to spot (near zero when rolled at expiry; the carry already converged). - decomposition.nextVersusSpotFraction: number; default: not declared — `(nextContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the curve slope out to the next contract; NEGATIVE in backwardation, which is exactly where positive roll yield comes from. - decompositionAbsentReason?: string; default: not declared — Present exactly when the decomposition is absent — the reason, never a guessed spot. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - rollYieldFraction: number; default: not declared — `(expiringContractPrice − nextContractPrice) / nextContractPrice` — the yield a long roller locks in for the next holding period under a static curve. SIGN LAW: positive in backwardation (next below expiring), negative in contango. ### @insiderfinance/totalfinance/commodities#SeasonalityMonthRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One calendar-month row of a {@link seasonalityProfile}. ```typescript /** One calendar-month row of a {@link seasonalityProfile}. */ export interface SeasonalityMonthRow { /** Calendar month, 1..12. */ month: number; observationCount: number; /** The requested statistic over the month's observations — `null` for an empty month. */ statisticValue: number | null; /** Present exactly when `statisticValue` is null. */ statisticValueAbsentReason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - month: number; default: not declared — Calendar month, 1..12. - observationCount: number; default: not declared - statisticValue: number | null; default: not declared — The requested statistic over the month's observations — `null` for an empty month. - statisticValueAbsentReason?: string; default: not declared — Present exactly when `statisticValue` is null. ### @insiderfinance/totalfinance/commodities#SeasonalityObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One dated observation for {@link seasonalityProfile}. ```typescript // --------------------------------------------------------------------------------------------------- // Seasonality // --------------------------------------------------------------------------------------------------- /** One dated observation for {@link seasonalityProfile}. */ export interface SeasonalityObservation { /** Strict `YYYY-MM-DD` calendar date. */ observationDate: string; value: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - observationDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date. - value: number; default: not declared ### @insiderfinance/totalfinance/commodities#SeasonalityProfileInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link seasonalityProfile}. ```typescript /** Input for {@link seasonalityProfile}. */ export interface SeasonalityProfileInput { observations: readonly SeasonalityObservation[]; /** The per-month statistic — explicit, never defaulted. */ statistic: 'mean' | 'median'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - observations: readonly SeasonalityObservation[]; default: not declared - statistic: 'mean' | 'median'; default: not declared — The per-month statistic — explicit, never defaulted. ### @insiderfinance/totalfinance/commodities#SeasonalityProfileResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link seasonalityProfile}. ```typescript /** Result of {@link seasonalityProfile}. */ export interface SeasonalityProfileResult { /** Twelve rows, months 1..12 in order — empty months are null WITH reason, never dropped. */ months: SeasonalityMonthRow[]; /** The mean over ALL observations (regardless of the per-month statistic). */ overallMean: number; assumptions: { statistic: 'mean' | 'median'; /** The fixed scope prose: descriptive only — no seasonality is invented. */ scope: string; }; diagnostics: { warnings: string[]; /** Observation counts by calendar month, index 0 = January. */ observationCountByMonth: number[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { scope: string; statistic: 'mean' | 'median'; }; default: not declared - assumptions.scope: string; default: not declared — The fixed scope prose: descriptive only — no seasonality is invented. - assumptions.statistic: 'mean' | 'median'; default: not declared - diagnostics: { observationCountByMonth: number[]; warnings: string[]; }; default: not declared - diagnostics.observationCountByMonth: number[]; default: not declared — Observation counts by calendar month, index 0 = January. - diagnostics.warnings: string[]; default: not declared - months: SeasonalityMonthRow[]; default: not declared — Twelve rows, months 1..12 in order — empty months are null WITH reason, never dropped. - overallMean: number; default: not declared — The mean over ALL observations (regardless of the per-month statistic). ### @insiderfinance/totalfinance/commodities#TermStructureState Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The four disclosed term-structure states. ```typescript // --------------------------------------------------------------------------------------------------- // Term-structure state // --------------------------------------------------------------------------------------------------- /** The four disclosed term-structure states. */ export type TermStructureState = 'contango' | 'backwardation' | 'flat' | 'indeterminate'; ``` ### @insiderfinance/totalfinance/commodities#TermStructureStateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link termStructureState}. ```typescript /** Input for {@link termStructureState}. */ export interface TermStructureStateInput { /** The forward curve — ≥ 2 points, strictly ascending delivery times. */ curve: readonly CommodityCurvePoint[]; /** * REQUIRED explicit tolerance (e.g. `0.001`): a pairwise price change with * `|forwardPrice[i+1] / forwardPrice[i] − 1| ≤ flatToleranceFraction` counts as flat. No * default — how much wiggle is "flat" is a judgment the caller must state. */ flatToleranceFraction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - curve: readonly CommodityCurvePoint[]; default: not declared — The forward curve — ≥ 2 points, strictly ascending delivery times. - flatToleranceFraction: number; default: not declared — REQUIRED explicit tolerance (e.g. `0.001`): a pairwise price change with `|forwardPrice[i+1] / forwardPrice[i] − 1| ≤ flatToleranceFraction` counts as flat. No default — how much wiggle is "flat" is a judgment the caller must state. ### @insiderfinance/totalfinance/commodities#TermStructureStateResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link termStructureState}. ```typescript /** Result of {@link termStructureState}. */ export interface TermStructureStateResult { state: TermStructureState; assumptions: { flatToleranceFraction: number; /** The fixed classification prose: pairwise slopes against the tolerance, mixes disclosed. */ definition: string; }; diagnostics: { warnings: string[]; risingSegmentCount: number; fallingSegmentCount: number; flatSegmentCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { definition: string; flatToleranceFraction: number; }; default: not declared - assumptions.definition: string; default: not declared — The fixed classification prose: pairwise slopes against the tolerance, mixes disclosed. - assumptions.flatToleranceFraction: number; default: not declared - diagnostics: { fallingSegmentCount: number; flatSegmentCount: number; risingSegmentCount: number; warnings: string[]; }; default: not declared - diagnostics.fallingSegmentCount: number; default: not declared - diagnostics.flatSegmentCount: number; default: not declared - diagnostics.risingSegmentCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - state: TermStructureState; default: not declared ### @insiderfinance/totalfinance/commodities#calendarSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The calendar spread between two deliveries: the price spread `far − near`, and the annualized continuous carry the pair implies. Near must genuinely be nearer — a reversed pair is refused rather than silently sign-flipped. ```typescript export declare function calendarSpread(input: CalendarSpreadInput): CalendarSpreadResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CalendarSpreadInput; default: not declared - (input).farPoint: CommodityCurvePoint; default: not declared — The farther delivery. - (input).nearPoint: CommodityCurvePoint; default: not declared — The nearer delivery — `nearPoint.timeToDeliveryYears < farPoint.timeToDeliveryYears`. - return.annualizedSpreadRate: number; default: not declared — The CONTINUOUS carry between the two deliveries: `ln(farPoint.forwardPrice / nearPoint.forwardPrice) / (farTime − nearTime)`. - return.assumptions: { annualizedSpreadRateConvention: string; }; default: not declared - return.assumptions.annualizedSpreadRateConvention: string; default: not declared — The fixed convention prose: continuous carry between the two deliveries. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.spread: number; default: not declared — `farPoint.forwardPrice − nearPoint.forwardPrice` (price units). ### @insiderfinance/totalfinance/commodities#commodityBasis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The basis between spot and a quoted futures price. `basis` (a price difference) and `basisFraction` (a dimensionless ratio) are DIFFERENT quantities and both deserve names — the library's naming law already blesses exactly this pair. ```typescript export declare function commodityBasis(input: CommodityBasisInput): CommodityBasisResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CommodityBasisInput; default: not declared - (input).futuresPrice: number; default: not declared — The quoted futures price, > 0. - (input).spotPrice: number; default: not declared — Spot price, > 0. - return.assumptions: { definition: string; }; default: not declared - return.assumptions.definition: string; default: not declared — The fixed basis definition prose: price difference and fraction, both named. - return.basis: number; default: not declared — `spotPrice − futuresPrice` — the basis in price units. - return.basisFraction: number; default: not declared — `spotPrice / futuresPrice − 1` — the basis as a fraction of the futures price. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#commodityCarry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The annualized TOTAL carry a spot/forward pair implies, by inverting the compounding growth factor. When all three components (financing, storage, convenience) are supplied, the result also reports `impliedResidual = annualizedCarryRate − (f + s − c)` and warns when the residual exceeds 1e-9 — a parity-priced forward has residual zero, and a nonzero residual is the parity law made visible, never silently absorbed into a component. ```typescript export declare function commodityCarry(input: CommodityCarryInput): CommodityCarryResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CommodityCarryInput; default: not declared - (input).annualConvenienceYield?: number; default: not declared — Optional supplied component: annual convenience yield, decimal. - (input).annualFinancingRate?: number; default: not declared — Optional supplied component: annual financing rate, decimal. - (input).annualStorageCostRate?: number; default: not declared — Optional supplied component: annual proportional storage cost rate, decimal. - (input).compounding: InterestCompounding; default: not declared — REQUIRED compounding convention used to annualize the implied carry. - (input).forwardPrice: number; default: not declared — The observed forward (or futures) price for the delivery date, > 0. - (input).spotPrice: number; default: not declared — Spot price, > 0. - (input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0 — carry over zero time is undefined, not zero. - return.annualizedCarryRate: number; default: not declared — The annualized total carry implied by the spot/forward pair: the rate `r` with `spotPrice × G(r, timeToDeliveryYears) = forwardPrice` (for `'continuous'`, `ln(forwardPrice / spotPrice) / timeToDeliveryYears`). - return.assumptions: { carryDefinition: string; compounding: InterestCompounding; }; default: not declared - return.assumptions.carryDefinition: string; default: not declared — The fixed carry definition prose: the rate whose growth factor maps spot to forward. - return.assumptions.compounding: InterestCompounding; default: not declared - return.components?: { annualConvenienceYield?: number; annualFinancingRate?: number; annualStorageCostRate?: number; }; default: not declared — The supplied components, echoed — present when at least one was supplied. - return.components.annualConvenienceYield?: number; default: not declared - return.components.annualFinancingRate?: number; default: not declared - return.components.annualStorageCostRate?: number; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.impliedResidual?: number; default: not declared — `annualizedCarryRate − (financing + storage − convenience)` — the cost-of-carry parity law made visible. Present exactly when all three components were supplied. ### @insiderfinance/totalfinance/commodities#commodityForwardPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). THEORETICAL cost-of-carry forward price: `spotPrice × G(netCarryRate, timeToDeliveryYears)` where `netCarryRate = annualFinancingRate + annualStorageCostRate − annualConvenienceYield` and `G` is the compounding growth factor. For `'continuous'` compounding that is exactly `spotPrice × e^((f + s − c) × t)`. A bare-number primitive (like valuation's `freeCashFlowToFirm`): what carry says the forward SHOULD be, not a quoted futures price and not a contract value. ```typescript export declare function commodityForwardPrice(input: CommodityForwardPriceInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CommodityForwardPriceInput; default: not declared - (input).annualConvenienceYield: number; default: not declared — Annual convenience yield, decimal — the benefit of holding the physical commodity. - (input).annualFinancingRate: number; default: not declared — Annual financing (interest) rate, decimal. - (input).annualStorageCostRate: number; default: not declared — Annual storage cost as a PROPORTIONAL rate of the commodity's value, decimal — not a dollar amount per unit (v1 models storage as a continuous proportional drag, like a negative yield). - (input).compounding: InterestCompounding; default: not declared — REQUIRED compounding convention — a market instrument never defaults its convention. - (input).spotPrice: number; default: not declared — Spot price of the commodity, > 0, in the quote currency per unit. - (input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, ≥ 0 (zero prices the forward at spot exactly). ### @insiderfinance/totalfinance/commodities#commodityForwardValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CURRENT VALUE of an existing forward contract: `±(currentForwardPrice − contractForwardPrice) × quantity × discountFactorToDelivery`, positive for `'long'` and negated for `'short'`. The three quantities this module keeps distinct meet here: `contractForwardPrice` is the price STRUCK on the contract, `currentForwardPrice` is today's forward PRICE (quoted or theoretical), and the result is the contract's VALUE — zero at inception when struck at the fair forward. ```typescript export declare function commodityForwardValue(input: CommodityForwardValueInput): CommodityForwardValueResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CommodityForwardValueInput; default: not declared - (input).contractForwardPrice: number; default: not declared — The forward price STRUCK on the existing contract (the delivery price agreed at inception). - (input).currentForwardPrice: number; default: not declared — The CURRENT forward price for the same delivery date — a market quote or a theoretical price from {@link commodityForwardPrice}; either way, a forward PRICE, not a contract value. - (input).discountFactorToDelivery: number; default: not declared — EXPLICIT discount factor from the delivery date back to the valuation instant, > 0 — the matched-conventions law: the factor carries its own curve, day count, and compounding, so this function never re-derives one from a rate it would have to guess conventions for. - (input).perspective: 'long' | 'short'; default: not declared — Which side of the contract is being valued. - (input).quantity: number; default: not declared — Number of units underlying the contract, > 0. - return.assumptions: { discountFactorToDelivery: number; perspective: 'long' | 'short'; valuationConvention: string; }; default: not declared - return.assumptions.discountFactorToDelivery: number; default: not declared — The factor as supplied — its conventions belong to the caller's curve. - return.assumptions.perspective: 'long' | 'short'; default: not declared - return.assumptions.valuationConvention: string; default: not declared — The fixed valuation prose: ±(current − contract) × quantity × factor, long positive. - return.contractValue: number; default: not declared — The CURRENT VALUE of the existing contract to the stated side (quote currency). - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#convertCommodityQuantity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert a commodity quantity between units with an EXPLICIT caller-supplied factor: `convertedQuantity = quantity × conversionFactor`. Economics are preserved exactly when the caller scales prices by the reciprocal (price-per-unit × quantity is invariant). An identity conversion (`fromUnit === toUnit`) with a factor ≠ 1 is a contradiction and is refused. ```typescript export declare function convertCommodityQuantity(input: ConvertCommodityQuantityInput): ConvertCommodityQuantityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ConvertCommodityQuantityInput; default: not declared - (input).conversionFactor: number; default: not declared — REQUIRED explicit factor: target units per one source unit. The generic engine does not invent conversion factors (per spec) — 42 gallons per barrel is the CALLER's physical fact. - (input).fromUnit: string; default: not declared — The unit the quantity is currently in — a label, echoed (e.g. 'barrel'). - (input).quantity: number; default: not declared - (input).toUnit: string; default: not declared — The target unit — a label, echoed (e.g. 'gallon'). - return.assumptions: { conversionFactor: number; conversionSource: string; fromUnit: string; toUnit: string; }; default: not declared - return.assumptions.conversionFactor: number; default: not declared - return.assumptions.conversionSource: string; default: not declared — The fixed source prose: the factor is the caller's physical fact. - return.assumptions.fromUnit: string; default: not declared - return.assumptions.toUnit: string; default: not declared - return.convertedQuantity: number; default: not declared — `quantity × conversionFactor`, in `toUnit`. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#curveSpreadAnalytics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Spread analytics across a whole curve: one {@link CurveSpreadRow} per adjacent pair plus the overall front-to-back row, every rate under the disclosed continuous convention. Linear in the pillar count. ```typescript export declare function curveSpreadAnalytics(input: CurveSpreadAnalyticsInput): CurveSpreadAnalyticsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CurveSpreadAnalyticsInput; default: not declared - (input).curve: readonly CommodityCurvePoint[]; default: not declared — The forward curve — ≥ 2 points, strictly ascending delivery times. - return.adjacentSpreads: CurveSpreadRow[]; default: not declared — One row per adjacent pair, in curve order. - return.assumptions: { annualizedSpreadRateConvention: string; }; default: not declared - return.assumptions.annualizedSpreadRateConvention: string; default: not declared — The fixed convention prose: continuous carry per row. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.frontToBack: CurveSpreadRow; default: not declared — The overall figures from the first delivery to the last. ### @insiderfinance/totalfinance/commodities#futuresHedgeRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Futures contracts required to hedge an exposure: `exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize`. The count is NOT rounded — whether to round up, down, or trade the fraction via a mini contract is an execution decision that belongs to the caller, and the assumptions say so. ```typescript export declare function futuresHedgeRatio(input: FuturesHedgeRatioInput): FuturesHedgeRatioResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FuturesHedgeRatioInput; default: not declared - (input).betaOrHedgeEffectiveness?: number; default: not declared — The minimum-variance hedge ratio (a regression beta or hedge effectiveness), default 1 — a one-to-one hedge, echoed as such in the assumptions. - (input).exposureQuantity: number; default: not declared — The exposure being hedged, in commodity units (sign carries the direction). - (input).futuresContractSize: number; default: not declared — Units of the commodity per futures contract, > 0. - return.assumptions: { betaOrHedgeEffectiveness: number; hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; rounding: string; }; default: not declared - return.assumptions.betaOrHedgeEffectiveness: number; default: not declared - return.assumptions.hedgeRatioBasis: 'one-to-one' | 'caller-supplied beta or hedge effectiveness'; default: not declared - return.assumptions.rounding: string; default: not declared — The fixed rounding prose: the count is real-valued; rounding is the caller's decision. - return.contractsRequired: number; default: not declared — `exposureQuantity × betaOrHedgeEffectiveness / futuresContractSize` — a REAL number, not rounded: rounding to whole contracts is the caller's execution decision, disclosed in the assumptions rather than taken silently. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/commodities#impliedConvenienceYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The convenience yield the spot/forward pair implies, given the other carry components — the inverse of {@link commodityForwardPrice} solved for `annualConvenienceYield`. The remaining inputs identify it uniquely: `c = f + s − annualizedCarry`. ```typescript export declare function impliedConvenienceYield(input: ImpliedConvenienceYieldInput): ImpliedConvenienceYieldResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedConvenienceYieldInput; default: not declared - (input).annualFinancingRate: number; default: not declared — Annual financing rate, decimal. - (input).annualStorageCostRate: number; default: not declared — Annual proportional storage cost rate, decimal. - (input).compounding: InterestCompounding; default: not declared — REQUIRED compounding convention. - (input).forwardPrice: number; default: not declared — The observed forward (or futures) price, > 0. - (input).spotPrice: number; default: not declared — Spot price, > 0. - (input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0. - return.assumptions: { compounding: InterestCompounding; inversion: string; }; default: not declared - return.assumptions.compounding: InterestCompounding; default: not declared - return.assumptions.inversion: string; default: not declared — The fixed inversion prose: convenience = financing + storage − implied carry. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.impliedAnnualConvenienceYield: number; default: not declared — `annualFinancingRate + annualStorageCostRate − annualizedCarry` — the yield the pair implies. ### @insiderfinance/totalfinance/commodities#impliedStorageCost Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The proportional storage cost rate the spot/forward pair implies, given the other carry components — the spec's "when the remaining inputs identify it uniquely", which these do: `s = annualizedCarry − f + c`. ```typescript export declare function impliedStorageCost(input: ImpliedStorageCostInput): ImpliedStorageCostResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedStorageCostInput; default: not declared - (input).annualConvenienceYield: number; default: not declared — Annual convenience yield, decimal. - (input).annualFinancingRate: number; default: not declared — Annual financing rate, decimal. - (input).compounding: InterestCompounding; default: not declared — REQUIRED compounding convention. - (input).forwardPrice: number; default: not declared — The observed forward (or futures) price, > 0. - (input).spotPrice: number; default: not declared — Spot price, > 0. - (input).timeToDeliveryYears: number; default: not declared — Time to delivery in years, > 0. - return.assumptions: { compounding: InterestCompounding; inversion: string; }; default: not declared - return.assumptions.compounding: InterestCompounding; default: not declared - return.assumptions.inversion: string; default: not declared — The fixed inversion prose: storage = implied carry − financing + convenience. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.impliedAnnualStorageCostRate: number; default: not declared — `annualizedCarry − annualFinancingRate + annualConvenienceYield` — the rate the pair implies. ### @insiderfinance/totalfinance/commodities#rollReturnDecomposition Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose the return on a long futures position over one holding period ending at a roll. With `S0/S1` the initial/final spot and `F0/F1` the held contract's initial/final (before-roll) prices: - `totalHoldingReturn = F1/F0 − 1` — the observed total; - `spotMoveReturn = S1/S0 − 1`; - `carryConvergenceReturn = (F1/S1)/(F0/S0) − 1` — the basis-ratio change; - and EXACTLY `(1 + total) = (1 + spotMove) × (1 + carryConvergence)`, because `(S1/S0) × ((F1/S1)/(F0/S0)) = F1/F0` — the declared multiplicative convention, tested at the declared residual 1e-12. The roll leg is stated separately: rolling is cash-neutral at execution, so the roll yield `(F1 − N)/N` is the third component of the economics but belongs to the NEXT period's return, and this function never folds it into the holding total. ```typescript export declare function rollReturnDecomposition(input: RollReturnDecompositionInput): RollReturnDecompositionResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RollReturnDecompositionInput; default: not declared - (input).finalContractPriceBeforeRoll: number; default: not declared — Price of the held contract at the end of the holding period, BEFORE rolling, > 0. - (input).finalSpotPrice: number; default: not declared — Spot price at the end of the holding period (the roll instant), > 0. - (input).initialContractPrice: number; default: not declared — Price of the held contract at the start of the holding period, > 0. - (input).initialSpotPrice: number; default: not declared — Spot price at the start of the holding period, > 0. - (input).nextContractPriceAtRoll: number; default: not declared — Price of the next contract at the roll instant, > 0. - return.assumptions: { declaredResidualBound: 1e-12; reconciliation: string; }; default: not declared - return.assumptions.declaredResidualBound: 1e-12; default: not declared - return.assumptions.reconciliation: string; default: not declared — The fixed reconciliation prose: the components compound exactly to the observed total. - return.carryConvergenceReturn: number; default: not declared — The change in the contract's basis ratio to spot over the period: `(finalContractPriceBeforeRoll / finalSpotPrice) / (initialContractPrice / initialSpotPrice) − 1` — the carry/convergence earned as the contract pulls toward spot (positive for a long in backwardation). - return.diagnostics: { reconciliationResidual: number; warnings: string[]; }; default: not declared - return.diagnostics.reconciliationResidual: number; default: not declared — `(1 + totalHoldingReturn) − (1 + spotMoveReturn) × (1 + carryConvergenceReturn)` — floating point only. - return.diagnostics.warnings: string[]; default: not declared - return.rollLeg: { convention: string; rollYieldFraction: number; }; default: not declared — The roll leg, stated SEPARATELY: the roll is cash-neutral at execution, so its yield `(finalContractPriceBeforeRoll − nextContractPriceAtRoll) / nextContractPriceAtRoll` accrues over the NEXT holding period and is never added into `totalHoldingReturn`. - return.rollLeg.convention: string; default: not declared — The fixed roll-leg prose: cash-neutral at execution, accrues next period. - return.rollLeg.rollYieldFraction: number; default: not declared - return.spotMoveReturn: number; default: not declared — `finalSpotPrice / initialSpotPrice − 1` — the spot move over the period. - return.totalHoldingReturn: number; default: not declared — The OBSERVED total return on the held contract over the holding period: `finalContractPriceBeforeRoll / initialContractPrice − 1`. ### @insiderfinance/totalfinance/commodities#rollYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The roll yield when rolling a LONG position from the expiring contract into the next: `(expiring − next) / next`. Positive in backwardation — the next contract is bought below the expiring one and converges upward under a static curve; negative in contango. When `spotPriceAtRoll` is supplied the result also decomposes both legs against spot; the components compound exactly back to the roll yield (see {@link RollYieldResult.decomposition}). When spot is absent the decomposition is absent WITH its reason — it is never inferred from the contract prices. ```typescript export declare function rollYield(input: RollYieldInput): RollYieldResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RollYieldInput; default: not declared - (input).expiringContractPrice: number; default: not declared — Price of the contract being rolled OUT of (the expiring one), > 0. - (input).nextContractPrice: number; default: not declared — Price of the contract being rolled INTO (the next one), > 0. - (input).spotPriceAtRoll?: number; default: not declared — The spot price at the roll instant, > 0 — supplied only when observed. Without it the spot-relative decomposition is ABSENT with its reason, never guessed. - return.assumptions: { decompositionConvention: string; rollDirection: string; signLaw: string; }; default: not declared - return.assumptions.decompositionConvention: string; default: not declared — The fixed decomposition prose: the spot-relative components compound exactly. - return.assumptions.rollDirection: string; default: not declared — The fixed direction prose: a long roller out of the expiring contract into the next. - return.assumptions.signLaw: string; default: not declared — The fixed sign-law prose: positive in backwardation, negative in contango. - return.decomposition?: { expiringVersusSpotFraction: number; nextVersusSpotFraction: number; }; default: not declared — Spot-relative decomposition, present exactly when `spotPriceAtRoll` was supplied. The two components COMPOUND (they do not sum): with `e = expiringVersusSpotFraction` and `n = nextVersusSpotFraction`, `(1 + rollYieldFraction) = (1 + e) / (1 + n)` EXACTLY — an algebraic identity, since `(E/S) / (N/S) = E/N`. - return.decomposition.expiringVersusSpotFraction: number; default: not declared — `(expiringContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the expiring contract's residual basis to spot (near zero when rolled at expiry; the carry already converged). - return.decomposition.nextVersusSpotFraction: number; default: not declared — `(nextContractPrice − spotPriceAtRoll) / spotPriceAtRoll` — the curve slope out to the next contract; NEGATIVE in backwardation, which is exactly where positive roll yield comes from. - return.decompositionAbsentReason?: string; default: not declared — Present exactly when the decomposition is absent — the reason, never a guessed spot. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.rollYieldFraction: number; default: not declared — `(expiringContractPrice − nextContractPrice) / nextContractPrice` — the yield a long roller locks in for the next holding period under a static curve. SIGN LAW: positive in backwardation (next below expiring), negative in contango. ### @insiderfinance/totalfinance/commodities#seasonalityProfile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Group caller-supplied dated observations by calendar month and report the requested statistic per month plus the overall mean. Purely descriptive: it never extrapolates an empty month (`null` with reason), and it warns when any month rests on fewer than 3 observations — a "seasonal pattern" read off one or two points is noise wearing a costume. ```typescript export declare function seasonalityProfile(input: SeasonalityProfileInput): SeasonalityProfileResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SeasonalityProfileInput; default: not declared - (input).observations: readonly SeasonalityObservation[]; default: not declared - (input).statistic: 'mean' | 'median'; default: not declared — The per-month statistic — explicit, never defaulted. - return.assumptions: { scope: string; statistic: 'mean' | 'median'; }; default: not declared - return.assumptions.scope: string; default: not declared — The fixed scope prose: descriptive only — no seasonality is invented. - return.assumptions.statistic: 'mean' | 'median'; default: not declared - return.diagnostics: { observationCountByMonth: number[]; warnings: string[]; }; default: not declared - return.diagnostics.observationCountByMonth: number[]; default: not declared — Observation counts by calendar month, index 0 = January. - return.diagnostics.warnings: string[]; default: not declared - return.months: SeasonalityMonthRow[]; default: not declared — Twelve rows, months 1..12 in order — empty months are null WITH reason, never dropped. - return.overallMean: number; default: not declared — The mean over ALL observations (regardless of the per-month statistic). ### @insiderfinance/totalfinance/commodities#termStructureState Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Classify a forward curve's term structure with the reasoning disclosed. Each adjacent pair is a segment with fractional slope `far / near − 1`; segments beyond `+flatToleranceFraction` rise, beyond `−flatToleranceFraction` fall, and within the tolerance are flat. ALL rising → `'contango'`; ALL falling → `'backwardation'`; ALL flat → `'flat'`; any other mix → `'indeterminate'`, with the mixed segments named in the diagnostics rather than averaged away. The classification is a pure function of the curve and the tolerance — the same wiggly curve legitimately reads `'flat'` under a loose tolerance and `'indeterminate'` under a tight one. ```typescript export declare function termStructureState(input: TermStructureStateInput): TermStructureStateResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TermStructureStateInput; default: not declared - (input).curve: readonly CommodityCurvePoint[]; default: not declared — The forward curve — ≥ 2 points, strictly ascending delivery times. - (input).flatToleranceFraction: number; default: not declared — REQUIRED explicit tolerance (e.g. `0.001`): a pairwise price change with `|forwardPrice[i+1] / forwardPrice[i] − 1| ≤ flatToleranceFraction` counts as flat. No default — how much wiggle is "flat" is a judgment the caller must state. - return.assumptions: { definition: string; flatToleranceFraction: number; }; default: not declared - return.assumptions.definition: string; default: not declared — The fixed classification prose: pairwise slopes against the tolerance, mixes disclosed. - return.assumptions.flatToleranceFraction: number; default: not declared - return.diagnostics: { fallingSegmentCount: number; flatSegmentCount: number; risingSegmentCount: number; warnings: string[]; }; default: not declared - return.diagnostics.fallingSegmentCount: number; default: not declared - return.diagnostics.flatSegmentCount: number; default: not declared - return.diagnostics.risingSegmentCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.state: TermStructureState; default: not declared ## Entrypoint @insiderfinance/totalfinance/commodities/forwards ### @insiderfinance/totalfinance/commodities/forwards#CommodityBasisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityBasisInput`. ### @insiderfinance/totalfinance/commodities/forwards#CommodityBasisResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityBasisResult`. ### @insiderfinance/totalfinance/commodities/forwards#CommodityCarryInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityCarryInput`. ### @insiderfinance/totalfinance/commodities/forwards#CommodityCarryResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityCarryResult`. ### @insiderfinance/totalfinance/commodities/forwards#CommodityForwardPriceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityForwardPriceInput`. ### @insiderfinance/totalfinance/commodities/forwards#CommodityForwardValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityForwardValueInput`. ### @insiderfinance/totalfinance/commodities/forwards#CommodityForwardValueResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityForwardValueResult`. ### @insiderfinance/totalfinance/commodities/forwards#FuturesHedgeRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#FuturesHedgeRatioInput`. ### @insiderfinance/totalfinance/commodities/forwards#FuturesHedgeRatioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#FuturesHedgeRatioResult`. ### @insiderfinance/totalfinance/commodities/forwards#ImpliedConvenienceYieldInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#ImpliedConvenienceYieldInput`. ### @insiderfinance/totalfinance/commodities/forwards#ImpliedConvenienceYieldResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#ImpliedConvenienceYieldResult`. ### @insiderfinance/totalfinance/commodities/forwards#ImpliedStorageCostInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#ImpliedStorageCostInput`. ### @insiderfinance/totalfinance/commodities/forwards#ImpliedStorageCostResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#ImpliedStorageCostResult`. ### @insiderfinance/totalfinance/commodities/forwards#commodityBasis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#commodityBasis`. ### @insiderfinance/totalfinance/commodities/forwards#commodityCarry Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#commodityCarry`. ### @insiderfinance/totalfinance/commodities/forwards#commodityForwardPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#commodityForwardPrice`. ### @insiderfinance/totalfinance/commodities/forwards#commodityForwardValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#commodityForwardValue`. ### @insiderfinance/totalfinance/commodities/forwards#futuresHedgeRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#futuresHedgeRatio`. ### @insiderfinance/totalfinance/commodities/forwards#impliedConvenienceYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#impliedConvenienceYield`. ### @insiderfinance/totalfinance/commodities/forwards#impliedStorageCost Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#impliedStorageCost`. ## Entrypoint @insiderfinance/totalfinance/commodities/term-structure ### @insiderfinance/totalfinance/commodities/term-structure#CalendarSpreadInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CalendarSpreadInput`. ### @insiderfinance/totalfinance/commodities/term-structure#CalendarSpreadResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CalendarSpreadResult`. ### @insiderfinance/totalfinance/commodities/term-structure#CommodityCurvePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CommodityCurvePoint`. ### @insiderfinance/totalfinance/commodities/term-structure#ConvertCommodityQuantityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#ConvertCommodityQuantityInput`. ### @insiderfinance/totalfinance/commodities/term-structure#ConvertCommodityQuantityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#ConvertCommodityQuantityResult`. ### @insiderfinance/totalfinance/commodities/term-structure#CurveSpreadAnalyticsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CurveSpreadAnalyticsInput`. ### @insiderfinance/totalfinance/commodities/term-structure#CurveSpreadAnalyticsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CurveSpreadAnalyticsResult`. ### @insiderfinance/totalfinance/commodities/term-structure#CurveSpreadRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#CurveSpreadRow`. ### @insiderfinance/totalfinance/commodities/term-structure#RollReturnDecompositionInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#RollReturnDecompositionInput`. ### @insiderfinance/totalfinance/commodities/term-structure#RollReturnDecompositionResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#RollReturnDecompositionResult`. ### @insiderfinance/totalfinance/commodities/term-structure#RollYieldInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#RollYieldInput`. ### @insiderfinance/totalfinance/commodities/term-structure#RollYieldResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#RollYieldResult`. ### @insiderfinance/totalfinance/commodities/term-structure#SeasonalityMonthRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#SeasonalityMonthRow`. ### @insiderfinance/totalfinance/commodities/term-structure#SeasonalityObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#SeasonalityObservation`. ### @insiderfinance/totalfinance/commodities/term-structure#SeasonalityProfileInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#SeasonalityProfileInput`. ### @insiderfinance/totalfinance/commodities/term-structure#SeasonalityProfileResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#SeasonalityProfileResult`. ### @insiderfinance/totalfinance/commodities/term-structure#TermStructureState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#TermStructureState`. ### @insiderfinance/totalfinance/commodities/term-structure#TermStructureStateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#TermStructureStateInput`. ### @insiderfinance/totalfinance/commodities/term-structure#TermStructureStateResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#TermStructureStateResult`. ### @insiderfinance/totalfinance/commodities/term-structure#calendarSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#calendarSpread`. ### @insiderfinance/totalfinance/commodities/term-structure#convertCommodityQuantity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#convertCommodityQuantity`. ### @insiderfinance/totalfinance/commodities/term-structure#curveSpreadAnalytics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#curveSpreadAnalytics`. ### @insiderfinance/totalfinance/commodities/term-structure#rollReturnDecomposition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#rollReturnDecomposition`. ### @insiderfinance/totalfinance/commodities/term-structure#rollYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#rollYield`. ### @insiderfinance/totalfinance/commodities/term-structure#seasonalityProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#seasonalityProfile`. ### @insiderfinance/totalfinance/commodities/term-structure#termStructureState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/commodities#termStructureState`. ## Entrypoint @insiderfinance/totalfinance/core ### @insiderfinance/totalfinance/core#ArbitrageError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs violate a no-arbitrage condition (e.g. a price below intrinsic value). ```typescript export declare class ArbitrageError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#Assumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assumptions echoed on every pro result. Extra model-specific fields are added via the `Extra` type parameter so each domain can annotate its own conventions without losing the common shape. ```typescript /** * Assumptions echoed on every pro result. Extra model-specific fields are added via the `Extra` * type parameter so each domain can annotate its own conventions without losing the common shape. */ export type Assumptions = Record> = { conventionsVersion: string; dayCount?: DayCount; compounding?: InterestCompounding; calendar?: string; calendarVersion?: string; asOf?: EpochMs; timeToExpiryYears?: number; /** * How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a * date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, * or 13:00 on an early-close day; * `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is * never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. */ expiryConvention?: 'us-equity-close' | 'explicit-instant'; timeToExpiryConvention?: never; dividendModel?: DividendModel; units?: GreekUnits; model?: string; engine?: string; /** * The randomness seed this result was computed under — REQUIRED echo for a * `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name * its seed cannot be replayed from the result alone. Deterministic paths never set it. */ seed?: number; } & Extra; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding?: InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - conventionsVersion: string; default: not declared - dayCount?: DayCount; default: not declared - dividendModel?: DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - model?: string; default: not declared - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: GreekUnits; default: not declared - units.rho: RhoUnit; default: not declared - units.theta: ThetaUnit; default: not declared - units.vega: VegaUnit; default: not declared ### @insiderfinance/totalfinance/core#Bar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#Bar`. ### @insiderfinance/totalfinance/core#BetweenOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BetweenOptions { /** Include the bounds (default `true`). */ inclusive?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - inclusive?: boolean; default: not declared — Include the bounds (default `true`). ### @insiderfinance/totalfinance/core#CONVENTIONS_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bump this only when default conventions change (major versions only, design law #3). ```typescript export declare const CONVENTIONS_VERSION: '0.0.1'; ``` ### @insiderfinance/totalfinance/core#Calendar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/calendars#Calendar`. ### @insiderfinance/totalfinance/core#CalendarConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CalendarConfig { name: string; version: string; timezone: string; /** Default `[0, 6]` (Sun & Sat). */ weekendDays?: Weekday[]; /** * Regular session hours as `HH:MM` in the calendar's `timezone`. `close: '24:00'` is the sentinel * for "no close" — a continuous 24-hour session (e.g. `alwaysOpen`/crypto), distinct from `'00:00'` * (midnight). Keep it as `'24:00'`; do not normalize to `'00:00'`. */ session: { open: string; close: string; halfDayClose?: string; }; holidayRules?: HolidayRule[]; halfDayRules?: HolidayRule[]; /** Ad-hoc full closures (ISO dates), e.g. emergency closures or days of mourning. */ closures?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - closures?: string[]; default: not declared — Ad-hoc full closures (ISO dates), e.g. emergency closures or days of mourning. - halfDayRules?: HolidayRule[]; default: not declared - holidayRules?: HolidayRule[]; default: not declared - name: string; default: not declared - session: { close: string; halfDayClose?: string; open: string; }; default: not declared — Regular session hours as `HH:MM` in the calendar's `timezone`. `close: '24:00'` is the sentinel for "no close" — a continuous 24-hour session (e.g. `alwaysOpen`/crypto), distinct from `'00:00'` (midnight). Keep it as `'24:00'`; do not normalize to `'00:00'`. - session.close: string; default: not declared - session.halfDayClose?: string; default: not declared - session.open: string; default: not declared - timezone: string; default: not declared - version: string; default: not declared - weekendDays?: Weekday[]; default: not declared — Default `[0, 6]` (Sun & Sat). ### @insiderfinance/totalfinance/core#CalendarDate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CalendarDate { year: number; month: number; // 1-12 day: number; // 1-31 } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - day: number; default: not declared - month: number; default: not declared - year: number; default: not declared ### @insiderfinance/totalfinance/core#ClosedRequestSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ClosedRequestSpecification { /** The stable contract identity this spec was generated from — drift gates compare through it. */ readonly contract: string; readonly fields: readonly ValidationFieldSpecification[]; /** * ROOT union alternatives — the whole argument is a discriminated union (`phiValue`'s `SSVIPhi`). * When present, `fields` holds the arms' COMMON members (the discriminant) and resolution runs * discriminant-first over these arms exactly as a union FIELD's branches do. */ readonly branches?: readonly ValidationBranchSpecification[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - branches?: readonly ValidationBranchSpecification[]; default: not declared — ROOT union alternatives — the whole argument is a discriminated union (`phiValue`'s `SSVIPhi`). When present, `fields` holds the arms' COMMON members (the discriminant) and resolution runs discriminant-first over these arms exactly as a union FIELD's branches do. - contract: string; default: not declared — The stable contract identity this spec was generated from — drift gates compare through it. - fields: readonly ValidationFieldSpecification[]; default: not declared ### @insiderfinance/totalfinance/core#ClosedRequestTeaching Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ClosedRequestTeaching { /** The argument's own label in container errors — defaults to `input`. */ readonly argumentName?: string; /** * This argument IS the request — field paths stay bare (`volatility`, `issueDate`) even under a * domain-specific argument name like `specification`. Secondary arguments (an options bag beside * a subject) omit it and get prefixed paths so a two-object call says which object to fix. */ readonly subject?: boolean; /** * ONE complete, runnable call for this boundary, or a thunk so the string is only built on the * failing path. Hand-authored at the call site: the generator knows the keys, never the values. */ readonly exampleCall: string | (() => string); /** Per-field unit-trap notes, keyed by BARE field name (`volatility: 'annualized decimal'`). */ readonly hints?: Readonly>; /** * The argument is an OPEN structural artifact per its manifest policy (Law 12): every consumed * field runs its ladder, but unknown keys are PRESERVED decoration, never rejected — a fit * result or market snapshot a user hands back may legitimately carry their own annotations. * Curated from the manifest's per-argument `inputPolicies`; closed remains the default. */ readonly open?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - argumentName?: string; default: not declared — The argument's own label in container errors — defaults to `input`. - exampleCall: string | (() => string); default: not declared — ONE complete, runnable call for this boundary, or a thunk so the string is only built on the failing path. Hand-authored at the call site: the generator knows the keys, never the values. - hints?: Readonly>; default: not declared — Per-field unit-trap notes, keyed by BARE field name (`volatility: 'annualized decimal'`). - open?: boolean; default: not declared — The argument is an OPEN structural artifact per its manifest policy (Law 12): every consumed field runs its ladder, but unknown keys are PRESERVED decoration, never rejected — a fit result or market snapshot a user hands back may legitimately carry their own annotations. Curated from the manifest's per-argument `inputPolicies`; closed remains the default. - subject?: boolean; default: not declared — This argument IS the request — field paths stay bare (`volatility`, `issueDate`) even under a domain-specific argument name like `specification`. Secondary arguments (an options bag beside a subject) omit it and get prefixed paths so a two-object call says which object to fix. ### @insiderfinance/totalfinance/core#Computed Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Computed = Record> { /** * The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` * beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). */ value: T; /** Every applied convention, echoed back. */ assumptions: Assumptions; /** How the value was computed, plus any warnings. */ diagnostics: Diagnostics; /** Optional data lineage when the inputs came from a provider. */ provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: T; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/core#ConfigurationError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The library was configured in a contradictory or unusable way. ```typescript export declare class ConfigurationError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#ConvergenceError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A numerical solver failed to converge. Never silently replaced with a guess (design law #4). ```typescript export declare class ConvergenceError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#CorporateAction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CorporateAction { symbol: SymbolId; effectiveDate: string; type: 'split' | 'reverseSplit' | 'dividend' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; ratio?: number; cash?: number; newSymbol?: string; details?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cash?: number; default: not declared - details?: Record; default: not declared - effectiveDate: string; default: not declared - newSymbol?: string; default: not declared - ratio?: number; default: not declared - symbol: string; default: not declared - type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; default: not declared ### @insiderfinance/totalfinance/core#DEFAULT_COMPOUNDING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const DEFAULT_COMPOUNDING: InterestCompounding; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear: number; default: not declared - type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/core#DEFAULT_DAY_COUNT Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Library default conventions (spec §7.4 defaults table). ```typescript export declare const DEFAULT_DAY_COUNT: DayCount; ``` ### @insiderfinance/totalfinance/core#DEFAULT_DIVIDEND_YIELD Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const DEFAULT_DIVIDEND_YIELD: 0; ``` ### @insiderfinance/totalfinance/core#DEFAULT_GREEK_UNITS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const DEFAULT_GREEK_UNITS: GreekUnits; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - rho: RhoUnit; default: not declared - theta: ThetaUnit; default: not declared - vega: VegaUnit; default: not declared ### @insiderfinance/totalfinance/core#DataError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A data-quality problem (crossed/locked market, stale quote, bad print). ```typescript export declare class DataError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#DayCount Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Day-count conventions supported in the 0.0.1 surface. ```typescript /** Day-count conventions supported in the 0.0.1 surface. */ export type DayCount = 'ACT/365F' | 'ACT/360' | '30/360'; ``` ### @insiderfinance/totalfinance/core#DaySession Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DaySession { date: string; isBusinessDay: boolean; isHalfDay: boolean; /** Local `HH:MM` open (present only on business days). */ open?: string; /** Local `HH:MM` close (early close on half days). */ close?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close?: string; default: not declared — Local `HH:MM` close (early close on half days). - date: string; default: not declared - isBusinessDay: boolean; default: not declared - isHalfDay: boolean; default: not declared - open?: string; default: not declared — Local `HH:MM` open (present only on business days). ### @insiderfinance/totalfinance/core#Deliverable Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Deliverable { cash?: number; shares?: Array<{ symbol: string; quantity: number; }>; notes?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cash?: number; default: not declared - notes?: string; default: not declared - shares?: { symbol: string; quantity: number; }[]; default: not declared ### @insiderfinance/totalfinance/core#Diagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Non-value metadata about how a result was computed. ```typescript /** Non-value metadata about how a result was computed. */ export interface Diagnostics { /** Pricing/solver engine name, e.g. `black-scholes-merton`. */ engine?: string; /** Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. */ method?: string; /** Whether an iterative procedure converged. `false` means the value is not trustworthy. */ converged?: boolean; /** Iteration count for iterative methods. */ iterations?: number; /** * When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, * human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). * Absent when no auto-selection took place. */ autoReason?: string; /** * The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, * why, and — for automatic selection — every candidate considered with its verdict. This is the * machine-readable superset of `engine` + `autoReason` (which remain for compatibility); * `selected.name` always agrees with `engine` when both are present. */ selection?: SelectionReport; /** * Named intermediate quantities the value decomposes into — a par spread's protection leg and * risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their * arithmetic here so a caller can audit the ratio, not just receive it (3B.3). */ decomposition?: Record; /** Structured warnings; always present (possibly empty). */ warnings: QuantWarning[]; /** Wall-clock timing in milliseconds, when measured. */ timingMs?: number; /** * Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the * computation seeds. Equals the input length when the indicator never emitted. */ warmup?: number; /** * Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive * near the vol/time boundaries, so the caller can see exactly what was differenced. * Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — * `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it * bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the * emit sites had moved to the semantic names, so a caller following it read `undefined`.) */ finiteDifferenceBumps?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - selection?: SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/core#Dividend Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Dividend { symbol: SymbolId; exDate: string; payDate?: string; amount: number; currency?: string; type?: 'regular' | 'special' | 'returnOfCapital' | 'unknown'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - currency?: string; default: not declared - exDate: string; default: not declared - payDate?: string; default: not declared - symbol: string; default: not declared - type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; default: not declared ### @insiderfinance/totalfinance/core#DividendModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DividendModel = 'none' | 'continuousYield' | 'discreteSchedule'; ``` ### @insiderfinance/totalfinance/core#EpochMs Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Unix epoch milliseconds. ```typescript /** Unix epoch milliseconds. */ export type EpochMs = number; ``` ### @insiderfinance/totalfinance/core#ErrorCode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A literal table allows bundlers to discard the registry or unused properties without executing a catalog constructor. The declared key/value/order contract is checked independently below. ```typescript export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ArtifactDuplicateMigration: 'artifact.duplicate_migration'; default: not declared - ArtifactEmbeddedInputTooLarge: 'artifact.embedded_input_too_large'; default: not declared - ArtifactFamilyMismatch: 'artifact.family_mismatch'; default: not declared - ArtifactIdMismatch: 'artifact.id_mismatch'; default: not declared - ArtifactMigrationMissing: 'artifact.migration_missing'; default: not declared - ArtifactModelVersionUnsupported: 'artifact.model_version_unsupported'; default: not declared - ArtifactNotReplayable: 'artifact.not_replayable'; default: not declared - ArtifactOperationUnsupported: 'artifact.operation_unsupported'; default: not declared - ArtifactReferencedDataMismatch: 'artifact.referenced_data_mismatch'; default: not declared - ArtifactTypeMismatch: 'artifact.type_mismatch'; default: not declared - BacktestAdapterNonconformant: 'backtest.adapter_nonconformant'; default: not declared - BacktestAmbiguousIntrabar: 'backtest.ambiguous_intrabar'; default: not declared - BacktestBookTooLarge: 'backtest.book_too_large'; default: not declared - BacktestDelistingReturnMissing: 'backtest.delisting_return_missing'; default: not declared - BacktestDuplicateHandler: 'backtest.duplicate_handler'; default: not declared - BacktestGridTooLarge: 'backtest.grid_too_large'; default: not declared - BacktestInputTooLarge: 'backtest.input_too_large'; default: not declared - BacktestLedgerReconciliationFailed: 'backtest.ledger_reconciliation_failed'; default: not declared - BacktestMarkUnavailable: 'backtest.mark_unavailable'; default: not declared - BacktestMixedSymbols: 'backtest.mixed_symbols'; default: not declared - BacktestOrderSplitAdjusted: 'backtest.order_split_adjusted'; default: not declared - BacktestStaleQuote: 'backtest.stale_quote'; default: not declared - BacktestUniverseMembershipUnknown: 'backtest.universe_membership_unknown'; default: not declared - BacktestUnsupportedCorporateAction: 'backtest.unsupported_corporate_action'; default: not declared - DataAborted: 'data.aborted'; default: not declared - DataAllowanceExhausted: 'data.allowance_exhausted'; default: not declared - DataAuthenticationRequired: 'data.authentication_required'; default: not declared - DataContractVersionUnsupported: 'data.contract_version_unsupported'; default: not declared - DataCrossedMarket: 'data.crossed_market'; default: not declared - DataEntitlementRequired: 'data.entitlement_required'; default: not declared - DataInvalidCursor: 'data.invalid_cursor'; default: not declared - DataInvalidRequest: 'data.invalid_request'; default: not declared - DataInvalidResponse: 'data.invalid_response'; default: not declared - DataNonconformant: 'data.nonconformant'; default: not declared - DataNotFound: 'data.not_found'; default: not declared - DataProviderFailure: 'data.provider_failure'; default: not declared - DataRateLimited: 'data.rate_limited'; default: not declared - DataSnapshotExpired: 'data.snapshot_expired'; default: not declared - DataStaleQuote: 'data.stale_quote'; default: not declared - DataSuspectObservations: 'data.suspect_observations'; default: not declared - DataUnavailable: 'data.unavailable'; default: not declared - DataUnsupportedCapability: 'data.unsupported_capability'; default: not declared - DataWindowBudgetExceeded: 'data.window_budget_exceeded'; default: not declared - EngineDiscretizationInadequate: 'engine.discretization_inadequate'; default: not declared - EngineProbabilityOutOfRange: 'engine.probability_out_of_range'; default: not declared - EngineResultOutOfBounds: 'engine.result_out_of_bounds'; default: not declared - EngineUnsupportedContract: 'engine.unsupported_contract'; default: not declared - EnvironmentActionDisallowed: 'environment.action_disallowed'; default: not declared - EnvironmentActionInvalid: 'environment.action_invalid'; default: not declared - EnvironmentDuplicateOrder: 'environment.duplicate_order'; default: not declared - EnvironmentEpisodeOver: 'environment.episode_over'; default: not declared - EnvironmentLimitBreach: 'environment.limit_breach'; default: not declared - EnvironmentNotReset: 'environment.not_reset'; default: not declared - EnvironmentOrderInvalid: 'environment.order_invalid'; default: not declared - EnvironmentUnknownInstrument: 'environment.unknown_instrument'; default: not declared - ImpliedVolatilityAboveMax: 'implied_volatility.above_max_bound'; default: not declared - ImpliedVolatilityBelowIntrinsic: 'implied_volatility.below_intrinsic'; default: not declared - ImpliedVolatilityNoConvergence: 'implied_volatility.no_convergence'; default: not declared - ImpliedVolatilityPriceBelowResolvable: 'implied_volatility.price_below_resolvable'; default: not declared - InputDuplicateEntry: 'input.duplicate_entry'; default: not declared - InputInvalidEnum: 'input.invalid_enum'; default: not declared - InputLengthMismatch: 'input.length_mismatch'; default: not declared - InputMissingField: 'input.missing_field'; default: not declared - InputNaN: 'input.nan'; default: not declared - InputNegativeSpot: 'input.negative_spot'; default: not declared - InputNegativeStrike: 'input.negative_strike'; default: not declared - InputNegativeTime: 'input.negative_time'; default: not declared - InputNegativeVolatility: 'input.negative_volatility'; default: not declared - InputNotFinite: 'input.not_finite'; default: not declared - InputOutOfRange: 'input.out_of_range'; default: not declared - InputSuspiciousCouponRate: 'input.suspicious_coupon_rate'; default: not declared - InputSuspiciousYield: 'input.suspicious_yield'; default: not declared - InputUnknownField: 'input.unknown_field'; default: not declared - InputWrongShape: 'input.wrong_shape'; default: not declared - InputWrongType: 'input.wrong_type'; default: not declared - IntegrationMaxDepth: 'integration.max_depth'; default: not declared - InterpolationDuplicateKnots: 'interpolation.duplicate_knots'; default: not declared - InterpolationInvalidGrid: 'interpolation.invalid_grid'; default: not declared - InterpolationOutOfDomain: 'interpolation.out_of_domain'; default: not declared - LinalgNoConvergence: 'linalg.no_convergence'; default: not declared - LinalgNotPositiveDefinite: 'linalg.not_positive_definite'; default: not declared - LinalgSingular: 'linalg.singular'; default: not declared - MathIterationLimit: 'math.iteration_limit'; default: not declared - McpDeadlineExceeded: 'mcp.deadline_exceeded'; default: not declared - McpInputTooLarge: 'mcp.input_too_large'; default: not declared - McpInternalError: 'mcp.internal_error'; default: not declared - McpUnknownTool: 'mcp.unknown_tool'; default: not declared - ModelFellerConditionViolated: 'model.feller_condition_violated'; default: not declared - OperationCancelled: 'operation.cancelled'; default: not declared - OperationCapabilityMissing: 'operation.capability_missing'; default: not declared - OperationDeadlineExceeded: 'operation.deadline_exceeded'; default: not declared - OperationHandleKindMismatch: 'operation.handle_kind_mismatch'; default: not declared - OperationHandleStoreMissing: 'operation.handle_store_missing'; default: not declared - OperationHandleUnknown: 'operation.handle_unknown'; default: not declared - OperationInputTooLarge: 'operation.input_too_large'; default: not declared - OperationInternal: 'operation.internal'; default: not declared - OperationRegistrationRefused: 'operation.registration_refused'; default: not declared - OperationToolFiltered: 'operation.tool_filtered'; default: not declared - OperationUnknown: 'operation.unknown'; default: not declared - OptimizeInvalidBounds: 'optimize.invalid_bounds'; default: not declared - PipelineDuplicateAlias: 'pipeline.duplicate_alias'; default: not declared - PipelineLengthMismatch: 'pipeline.length_mismatch'; default: not declared - PortfolioDuplicateEventConflict: 'portfolio.duplicate_event_conflict'; default: not declared - PortfolioLotUnavailable: 'portfolio.lot_unavailable'; default: not declared - PortfolioMarkUnavailable: 'portfolio.mark_unavailable'; default: not declared - PortfolioReversalInfeasible: 'portfolio.reversal_infeasible'; default: not declared - PortfolioReversalTargetMissing: 'portfolio.reversal_target_missing'; default: not declared - PostconditionNonFinite: 'postcondition.non_finite_result'; default: not declared - PricerNonconformant: 'pricer.nonconformant'; default: not declared - PricerObservationInvalid: 'pricer.observation_invalid'; default: not declared - PricerRequirementInvalid: 'pricer.requirement_invalid'; default: not declared - PricerRequirementUnsatisfied: 'pricer.requirement_unsatisfied'; default: not declared - RegistryAliasConflict: 'registry.alias_conflict'; default: not declared - RegistryDuplicateAliasRow: 'registry.duplicate_alias_row'; default: not declared - RegistryDuplicateIndicator: 'registry.duplicate_indicator'; default: not declared - RegistryUnknownAliasTarget: 'registry.unknown_alias_target'; default: not declared - RiskIllConditionedCovariance: 'risk.ill_conditioned_covariance'; default: not declared - RiskQuantileBeyondSample: 'risk.quantile_beyond_sample'; default: not declared - ScenarioCellFailed: 'scenario.cell_failed'; default: not declared - ScenarioInstructionUnmatched: 'scenario.instruction_unmatched'; default: not declared - ScenarioTargetUnsupported: 'scenario.target_unsupported'; default: not declared - SerializationUnsupportedValue: 'serialization.unsupported_value'; default: not declared - SignalUnknownReference: 'signal.unknown_reference'; default: not declared - SnapshotInvalidVersion: 'snapshot.invalid_version'; default: not declared - SnapshotKindMismatch: 'snapshot.kind_mismatch'; default: not declared - SnapshotUnknownKind: 'snapshot.unknown_kind'; default: not declared - SnapshotUnsupportedVersion: 'snapshot.unsupported_version'; default: not declared - SnapshotWrongShape: 'snapshot.wrong_shape'; default: not declared - SolverNoConvergence: 'solver.no_convergence'; default: not declared - StrategyDeltaRequired: 'strategy.delta_required'; default: not declared - StrategyExpiryConflict: 'strategy.expiry_conflict'; default: not declared - StrategyInvalidChartRange: 'strategy.invalid_chart_range'; default: not declared - StrategyMultiExpiryExpirationAnalytics: 'strategy.multi_expiry_expiration_analytics'; default: not declared - StrategyStrikeUnavailable: 'strategy.strike_unavailable'; default: not declared - TimeTimezoneResolutionFailed: 'time.timezone_resolution_failed'; default: not declared - TimeValuationInstantRequired: 'time.valuation_instant_required'; default: not declared - TradeGrantConsumed: 'trade.grant_consumed'; default: not declared - TradeGrantExpired: 'trade.grant_expired'; default: not declared - TradeGrantInvalid: 'trade.grant_invalid'; default: not declared - TradeHalted: 'trade.halted'; default: not declared - TradeIdempotencyConflict: 'trade.idempotency_conflict'; default: not declared - TradeJournalTransitionInvalid: 'trade.journal_transition_invalid'; default: not declared - TradeLiveUnavailable: 'trade.live_unavailable'; default: not declared - TradePlanInvalid: 'trade.plan_invalid'; default: not declared - TradePreflightDenied: 'trade.preflight_denied'; default: not declared - VolatilityCalendarArbitrage: 'volatility.calendar_arbitrage'; default: not declared - VolatilityCalibrationFitDeviation: 'volatility.calibration_fit_deviation'; default: not declared - VolatilityExpiryNotFound: 'volatility.expiry_not_found'; default: not declared - VolatilityForwardUnavailable: 'volatility.forward_unavailable'; default: not declared - VolatilityNegativeVarianceForecast: 'volatility.negative_variance_forecast'; default: not declared - VolatilitySnapshotVersionMismatch: 'volatility.snapshot_version_mismatch'; default: not declared ### @insiderfinance/totalfinance/core#ExerciseTime Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExerciseTime = 'AM' | 'PM'; ``` ### @insiderfinance/totalfinance/core#Facade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `ExplainValue` defaults to `Output` and diverges only for solver facades (Law 7 / E3): the plain call THROWS on failure so its output stays `number`, while the `.explain` envelope reports the same failure softly as `value: null` + `converged: false`. ```typescript /** * A callable `(input) => Output` with an `.explain(input) => Computed` companion. The * `Extra` type parameter carries the domain-specific assumptions the envelope discloses (it defaults * to none), so `f.explain(input).assumptions.` type-checks. */ /** * `ExplainValue` defaults to `Output` and diverges only for solver facades (Law 7 / E3): the plain * call THROWS on failure so its output stays `number`, while the `.explain` envelope reports the * same failure softly as `value: null` + `converged: false`. */ export type Facade = Record, ExplainValue = Output> = ((input: Input) => Output) & { explain: (input: Input) => Computed; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Input; default: not declared - explain: (input: Input) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ExplainValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): Input; default: not declared ### @insiderfinance/totalfinance/core#FormatMoneyOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FormatMoneyOptions { currency?: string; locale?: string; decimals?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency?: string; default: not declared - decimals?: number; default: not declared - locale?: string; default: not declared ### @insiderfinance/totalfinance/core#FormatPercentOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FormatPercentOptions { /** Fraction digits (default `2`). */ decimals?: number; /** If `true`, the input is already a percentage (e.g. `22`) rather than a fraction (`0.22`). */ asPercentagePoints?: boolean; locale?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asPercentagePoints?: boolean; default: not declared — If `true`, the input is already a percentage (e.g. `22`) rather than a fraction (`0.22`). - decimals?: number; default: not declared — Fraction digits (default `2`). - locale?: string; default: not declared ### @insiderfinance/totalfinance/core#GreekUnits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Units in which Greeks are reported. ```typescript /** Units in which Greeks are reported. */ export interface GreekUnits { theta: ThetaUnit; vega: VegaUnit; rho: RhoUnit; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - rho: RhoUnit; default: not declared - theta: ThetaUnit; default: not declared - vega: VegaUnit; default: not declared ### @insiderfinance/totalfinance/core#GuaranteedSelection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The names a selection of type `S` is CERTAIN to contain — the names a result may promise as required. Every other name in `S[number]` was only possibly selected, so a result types it as optional. A name is guaranteed when every possible value of `S` holds it as a whole element: - `readonly ['price', 'gamma']` guarantees `'price' | 'gamma'`; - a union of selections guarantees only what all of them share: `readonly ['gamma'] | readonly ['delta']` (a conditional) guarantees nothing, and `readonly ['price', 'gamma'] | readonly ['price']` guarantees `'price'`; - an element that is itself a union guarantees none of its members: `readonly ['gamma' | 'delta']` holds one of the two, and the type cannot say which; - a list without a fixed length (`BlackScholesOutput[]`) guarantees nothing. `S extends unknown` distributes over the members of `S`, giving one verdict per possible selection; a name is kept only when no member says `false`. ```typescript /** * The names a selection of type `S` is CERTAIN to contain — the names a result may promise as * required. Every other name in `S[number]` was only possibly selected, so a result types it as * optional. * * A name is guaranteed when every possible value of `S` holds it as a whole element: * - `readonly ['price', 'gamma']` guarantees `'price' | 'gamma'`; * - a union of selections guarantees only what all of them share: * `readonly ['gamma'] | readonly ['delta']` (a conditional) guarantees nothing, and * `readonly ['price', 'gamma'] | readonly ['price']` guarantees `'price'`; * - an element that is itself a union guarantees none of its members: `readonly ['gamma' | 'delta']` * holds one of the two, and the type cannot say which; * - a list without a fixed length (`BlackScholesOutput[]`) guarantees nothing. * * `S extends unknown` distributes over the members of `S`, giving one verdict per possible * selection; a name is kept only when no member says `false`. */ export type GuaranteedSelection = { [K in S[number]]: false extends (S extends unknown ? number extends S['length'] ? false : K extends { [I in keyof S]: [ S[I] ] extends [ K ] ? K : never; }[number] ? true : false : never) ? never : K; }[S[number]]; ``` ### @insiderfinance/totalfinance/core#HolidayRule Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A holiday/half-day rule: given a year, return the ISO date it falls on, or `null` if not observed. ```typescript // ---- rules engine ---- /** A holiday/half-day rule: given a year, return the ISO date it falls on, or `null` if not observed. */ export type HolidayRule = (year: number) => string | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (year): number; default: not declared ### @insiderfinance/totalfinance/core#InputError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Invalid or nonsensical input (programmer error or malformed payload). ```typescript export declare class InputError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#InterestCompounding Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The ONE public interest-compounding grammar (FC0). Every rate-bearing contract in the library quotes its compounding in this vocabulary — the former core `'continuous' | 'simple'` pair and fixed-income's separate curve grammar (with its bare-number periodic form) are unified here, with no compatibility aliases (pre-1.0). The object form names its meaning: a bare `12` said nothing about being periods-per-year. ```typescript /** Interest compounding conventions. */ /** * The ONE public interest-compounding grammar (FC0). Every rate-bearing contract in the library * quotes its compounding in this vocabulary — the former core `'continuous' | 'simple'` pair and * fixed-income's separate curve grammar (with its bare-number periodic form) are unified here, * with no compatibility aliases (pre-1.0). The object form names its meaning: a bare `12` said * nothing about being periods-per-year. */ export type InterestCompounding = 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { type: 'periodic'; periodsPerYear: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear: number; default: not declared - type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/core#JSONSchema Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface JSONSchema { $schema?: string; $id?: string; title?: string; description?: string; type?: JSONSchemaTypeName | JSONSchemaTypeName[]; enum?: unknown[]; const?: unknown; default?: unknown; // object properties?: Record; required?: string[]; additionalProperties?: boolean | JSONSchema; // array items?: JSONSchema; minItems?: number; maxItems?: number; // number minimum?: number; maximum?: number; exclusiveMinimum?: number; exclusiveMaximum?: number; multipleOf?: number; // string minLength?: number; maxLength?: number; pattern?: string; format?: string; // composition anyOf?: JSONSchema[]; oneOf?: JSONSchema[]; allOf?: JSONSchema[]; /** Allow vendor/extension keywords without losing type-checking on the known ones. */ [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - $id?: string; default: not declared - $schema?: string; default: not declared - additionalProperties?: boolean | JSONSchema; default: not declared - additionalProperties.$id?: string; default: not declared - additionalProperties.$schema?: string; default: not declared - additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - additionalProperties.allOf?: JSONSchema[]; default: not declared - additionalProperties.anyOf?: JSONSchema[]; default: not declared - additionalProperties.const?: unknown; default: not declared - additionalProperties.default?: unknown; default: not declared - additionalProperties.description?: string; default: not declared - additionalProperties.enum?: unknown[]; default: not declared - additionalProperties.exclusiveMaximum?: number; default: not declared - additionalProperties.exclusiveMinimum?: number; default: not declared - additionalProperties.format?: string; default: not declared - additionalProperties.items?: JSONSchema; default: not declared - additionalProperties.maxItems?: number; default: not declared - additionalProperties.maxLength?: number; default: not declared - additionalProperties.maximum?: number; default: not declared - additionalProperties.minItems?: number; default: not declared - additionalProperties.minLength?: number; default: not declared - additionalProperties.minimum?: number; default: not declared - additionalProperties.multipleOf?: number; default: not declared - additionalProperties.oneOf?: JSONSchema[]; default: not declared - additionalProperties.pattern?: string; default: not declared - additionalProperties.properties?: Record; default: not declared - additionalProperties.required?: string[]; default: not declared - additionalProperties.title?: string; default: not declared - additionalProperties.type?: JSONSchemaTypeName | JSONSchemaTypeName[]; default: not declared - allOf?: JSONSchema[]; default: not declared - anyOf?: JSONSchema[]; default: not declared - const?: unknown; default: not declared - default?: unknown; default: not declared - description?: string; default: not declared - enum?: unknown[]; default: not declared - exclusiveMaximum?: number; default: not declared - exclusiveMinimum?: number; default: not declared - format?: string; default: not declared - items?: JSONSchema; default: not declared - maxItems?: number; default: not declared - maxLength?: number; default: not declared - maximum?: number; default: not declared - minItems?: number; default: not declared - minLength?: number; default: not declared - minimum?: number; default: not declared - multipleOf?: number; default: not declared - oneOf?: JSONSchema[]; default: not declared - pattern?: string; default: not declared - properties?: Record; default: not declared - required?: string[]; default: not declared - title?: string; default: not declared - type?: JSONSchemaTypeName | JSONSchemaTypeName[]; default: not declared ### @insiderfinance/totalfinance/core#MarketInputs Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The canonical market snapshot every pricing/analytics entrypoint takes (spec §5.3 / WS3.2). One shape, one vocabulary: `spot`, `rate`, optional `dividendYield` (default 0), and the `asOf` the snapshot is valid for. Package-specific markets EXTEND this and add their own fields (options adds `forward`/`volatility`/quotes; structure/vol pair it with a separate `config`), so the same word always means the same thing across the workspace. ```typescript /** * The canonical market snapshot every pricing/analytics entrypoint takes (spec §5.3 / WS3.2). One * shape, one vocabulary: `spot`, `rate`, optional `dividendYield` (default 0), and the `asOf` the * snapshot is valid for. Package-specific markets EXTEND this and add their own fields (options adds * `forward`/`volatility`/quotes; structure/vol pair it with a separate `config`), so the same word * always means the same thing across the workspace. */ export interface MarketInputs { spot: number; riskFreeRate: number; /** Continuous dividend yield; defaults to 0 when omitted. */ dividendYield?: number; /** * Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" * across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less * datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). */ asOf: EpochMs | string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - riskFreeRate: number; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/core#ORDER_SIDES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ORDER_SIDES: readonly OrderSide[]; ``` ### @insiderfinance/totalfinance/core#ORDER_TYPES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ORDER_TYPES: readonly OrderType[]; ``` ### @insiderfinance/totalfinance/core#OccOptionSymbol Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OccOptionSymbol { root: string; /** ISO `YYYY-MM-DD`. */ expiry: string; /** Resolved expiry instant (one expiry law, E2): OCC symbols are always US-equity date-only. */ expiresAt: number; expiryConvention: 'us-equity-close'; type: OptionType; strike: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiresAt: number; default: not declared — Resolved expiry instant (one expiry law, E2): OCC symbols are always US-equity date-only. - expiry: string; default: not declared — ISO `YYYY-MM-DD`. - expiryConvention: 'us-equity-close'; default: not declared - root: string; default: not declared - strike: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/core#OptionContract Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionContract { // ── Identity & pricing fields — every engine reads these (P3.4 pricing/metadata split) ────── underlying: string; type: OptionType; /** REQUIRED at build — never defaulted: US equity options are American, many index options European. */ style: OptionStyle; strike: number; /** The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. */ expiry: string; /** * The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at * construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the * caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this * resolution and cross-validate it against the label — an unresolved literal is not a * contract; build one with the option builders. */ expiresAt: EpochMs; /** HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). */ expiryConvention: 'us-equity-close' | 'explicit-instant'; // ── Metadata — portfolio accounting, settlement plumbing, display. Vanilla pricing does NOT // read these; an engine never appears to honor a field it ignores (P3.4). ────────────────── multiplier?: number; settlement?: Settlement; /** * AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry * instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled * index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. */ exerciseTime?: ExerciseTime; currency?: string; root?: string; occSymbol?: string; deliverable?: Deliverable; adjusted?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjusted?: boolean; default: not declared - currency?: string; default: not declared - deliverable?: Deliverable; default: not declared - deliverable.cash?: number; default: not declared - deliverable.notes?: string; default: not declared - deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - exerciseTime?: ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - multiplier?: number; default: not declared - occSymbol?: string; default: not declared - root?: string; default: not declared - settlement?: Settlement; default: not declared - strike: number; default: not declared - style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - type: OptionType; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/core#OptionQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionQuote { contract: OptionContract; timestampMs: EpochMs; bid?: number; ask?: number; bidSize?: number; askSize?: number; mid?: number; last?: number; mark?: number; volume?: number; openInterest?: number; underlyingPrice?: number; impliedVolatility?: number; /** Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. */ greeks?: OptionQuoteGreeks; exchange?: string; conditions?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ask?: number; default: not declared - askSize?: number; default: not declared - bid?: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - exchange?: string; default: not declared - greeks?: OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - greeks.delta: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.provenance?: OptionQuoteGreeksProvenance; default: not declared - greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - impliedVolatility?: number; default: not declared - last?: number; default: not declared - mark?: number; default: not declared - mid?: number; default: not declared - openInterest?: number; default: not declared - timestampMs: number; default: not declared - underlyingPrice?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/core#OptionQuoteGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-share Greeks on a chain row, in TotalFinance display units: `delta` per $1 of spot, `gamma` per $1², `theta` per calendar day, `vega` per volatility point, `rho` per 1% rate. A vendor feed may supply `delta` alone; `chainGreeks` stamps the full set with its provenance. ```typescript /** * Per-share Greeks on a chain row, in TotalFinance display units: `delta` per $1 of spot, `gamma` per * $1², `theta` per calendar day, `vega` per volatility point, `rho` per 1% rate. A vendor feed may * supply `delta` alone; `chainGreeks` stamps the full set with its provenance. */ export interface OptionQuoteGreeks { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: OptionQuoteGreeksProvenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared - gamma?: number; default: not declared - provenance?: OptionQuoteGreeksProvenance; default: not declared - provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - rho?: number; default: not declared - theta?: number; default: not declared - vega?: number; default: not declared ### @insiderfinance/totalfinance/core#OptionQuoteGreeksProvenance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Who produced a chain row's Greeks, with what, and when. ```typescript /** Who produced a chain row's Greeks, with what, and when. */ export interface OptionQuoteGreeksProvenance { /** The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. */ source: string; /** The pricing model behind them when known, e.g. `'black-scholes-merton'`. */ model?: string; /** When the Greeks were observed or computed (epoch ms). */ timestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). ### @insiderfinance/totalfinance/core#OptionStyle Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exercise style of a LISTED equity/index option. `'bermudan'` was removed (alignment spec P3.4): no vanilla engine supports it, and a representable-but-unpriceable state violates valid-by-construction. Bermudan RATES exercise lives where it is actually priced — `@insiderfinance/totalfinance/fixed-income`'s `bermudanSwaption` with its explicit exercise-date schedule. ```typescript /** * Exercise style of a LISTED equity/index option. `'bermudan'` was removed (alignment spec P3.4): * no vanilla engine supports it, and a representable-but-unpriceable state violates * valid-by-construction. Bermudan RATES exercise lives where it is actually priced — * `@insiderfinance/totalfinance/fixed-income`'s `bermudanSwaption` with its explicit exercise-date schedule. */ export type OptionStyle = 'european' | 'american'; ``` ### @insiderfinance/totalfinance/core#OptionTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionTrade extends OptionQuote { price: number; size: number; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; premium?: number; notional?: number; openingLikely?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggressorSide?: 'buy' | 'sell' | 'unknown'; default: not declared - ask?: number; default: not declared - askSize?: number; default: not declared - bid?: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - exchange?: string; default: not declared - greeks?: OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - greeks.delta: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.provenance?: OptionQuoteGreeksProvenance; default: not declared - greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - impliedVolatility?: number; default: not declared - last?: number; default: not declared - mark?: number; default: not declared - mid?: number; default: not declared - notional?: number; default: not declared - openInterest?: number; default: not declared - openingLikely?: boolean; default: not declared - premium?: number; default: not declared - price: number; default: not declared - sequence?: number; default: not declared - size: number; default: not declared - timestampMs: number; default: not declared - underlyingPrice?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/core#OptionType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionType = 'call' | 'put'; ``` ### @insiderfinance/totalfinance/core#OrderBook Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OrderBook { symbol: SymbolId; timestampMs: EpochMs; bids: OrderBookLevel[]; asks: OrderBookLevel[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asks: OrderBookLevel[]; default: not declared - bids: OrderBookLevel[]; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/core#OrderBookLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OrderBookLevel { price: number; size: number; exchange?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exchange?: string; default: not declared - price: number; default: not declared - size: number; default: not declared ### @insiderfinance/totalfinance/core#OrderSide Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderSide`. ### @insiderfinance/totalfinance/core#OrderType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderType`. ### @insiderfinance/totalfinance/core#PostconditionError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A LIBRARY defect surfaced loudly (Law 7 runtime postcondition): a successful facade/analysis result was about to carry an undisclosed NaN/Infinity. This is never a user-input error — if you see it, please report it with the inputs; the honest alternatives are `null`-with-reason or a disclosed diagnostic, and the function failed to produce either. ```typescript export declare class PostconditionError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#PriceSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price-source selection for quotes (spec §9.5 bid/ask/mid selection). ```typescript /** Price-source selection for quotes (spec §9.5 bid/ask/mid selection). */ export type PriceSource = 'bid' | 'ask' | 'mid' | 'last' | 'mark'; ``` ### @insiderfinance/totalfinance/core#Provenance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Provenance { provider?: string; dataset?: string; asOf?: EpochMs; receivedAt?: EpochMs; sourceVersion?: string; requestId?: string; warnings?: QuantWarning[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - dataset?: string; default: not declared - provider?: string; default: not declared - receivedAt?: number; default: not declared - requestId?: string; default: not declared - sourceVersion?: string; default: not declared - warnings?: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/core#QuantError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Base class for every TotalFinance error. ```typescript export declare class QuantError extends Error { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#QuantErrorOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface QuantErrorOptions { /** Stable, machine-readable code, e.g. `input.negative_spot`. */ code: string; /** Structured context for programmatic handling and good error messages. */ context?: Record; /** Underlying cause, preserved on the standard `Error.cause` chain. */ cause?: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - context?: Record; default: not declared — Structured context for programmatic handling and good error messages. ### @insiderfinance/totalfinance/core#QuantWarning Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A structured, machine-readable warning. `code` is stable public API. ```typescript /** A structured, machine-readable warning. `code` is stable public API. */ export interface QuantWarning { code: string; message: string; severity: WarningSeverity; context?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared - context?: Record; default: not declared - message: string; default: not declared - severity: WarningSeverity; default: not declared ### @insiderfinance/totalfinance/core#Quote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Quote { symbol: SymbolId; timestampMs: EpochMs; bid: number; ask: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ask: number; default: not declared - askSize?: number; default: not declared - bid: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - exchange?: string; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/core#RateCurve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RateCurve { currency: string; asOf: EpochMs; dayCount: DayCount; compounding: InterestCompounding; points: RateCurvePoint[]; interpolation?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - compounding: InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - currency: string; default: not declared - dayCount: DayCount; default: not declared - interpolation?: string; default: not declared - points: RateCurvePoint[]; default: not declared ### @insiderfinance/totalfinance/core#RateCurvePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One curve pillar: a `'YYYY-MM-DD'` date and the ZERO RATE quoted there, as a decimal, under the owning curve's own `compounding`/`dayCount`. The field is `zeroRate` — not a generic `rate` — because that is exactly what TotalFinance consumers evaluate (`curves.fromZeroRates` semantics): every discount factor is DERIVED from this rate through the curve's compounding transform. There is deliberately no `discountFactor` member (removed 2026-08-23, second external review): two answers to "what discounts this pillar?" on one pillar can contradict each other, and the old advisory field did — sign-consistency let `zeroRate: 0.05` sit beside `discountFactor: 0.2`. Discount-factor-quoted data has its own constructor (`curves.fromDiscountFactors`), whose pillars carry no rates. Entries stay open to vendor decoration (Law 12). ```typescript /** * One curve pillar: a `'YYYY-MM-DD'` date and the ZERO RATE quoted there, as a decimal, under the * owning curve's own `compounding`/`dayCount`. The field is `zeroRate` — not a generic `rate` — * because that is exactly what TotalFinance consumers evaluate (`curves.fromZeroRates` semantics): * every discount factor is DERIVED from this rate through the curve's compounding transform. * * There is deliberately no `discountFactor` member (removed 2026-08-23, second external review): * two answers to "what discounts this pillar?" on one pillar can contradict each other, and the * old advisory field did — sign-consistency let `zeroRate: 0.05` sit beside `discountFactor: 0.2`. * Discount-factor-quoted data has its own constructor (`curves.fromDiscountFactors`), whose * pillars carry no rates. Entries stay open to vendor decoration (Law 12). */ export interface RateCurvePoint { date: string; zeroRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared - zeroRate: number; default: not declared ### @insiderfinance/totalfinance/core#RawFundamentalsRecord Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The RAW provider-fundamentals record — an explicitly raw/open DATA-EDGE artifact (FC0). A vendor's untyped field bag survives ONLY here; compute functions never read `fields`. Typed analysis attaches to `@insiderfinance/totalfinance/fundamentals`' `FundamentalPeriod` declarations, and a data adapter's job is to map one of these raw records into them with the availability instant carried honestly. (Relocation-by-rename of the former generic `Fundamentals`, pre-1.0, no alias.) ```typescript /** * The RAW provider-fundamentals record — an explicitly raw/open DATA-EDGE artifact (FC0). A * vendor's untyped field bag survives ONLY here; compute functions never read `fields`. Typed * analysis attaches to `@insiderfinance/totalfinance/fundamentals`' `FundamentalPeriod` declarations, and a data * adapter's job is to map one of these raw records into them with the availability instant * carried honestly. (Relocation-by-rename of the former generic `Fundamentals`, pre-1.0, no * alias.) */ export interface RawFundamentalsRecord { symbol: SymbolId; /** Vendor's own period label, verbatim (e.g. `'Q1 2026'`, `'FY25'`). */ fiscalPeriod?: string; /** When the vendor says the record is as-of, when known. */ asOf?: EpochMs; /** The vendor's untyped field bag — data-edge only, never a compute input. */ fields: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared — When the vendor says the record is as-of, when known. - fields: Record; default: not declared — The vendor's untyped field bag — data-edge only, never a compute input. - fiscalPeriod?: string; default: not declared — Vendor's own period label, verbatim (e.g. `'Q1 2026'`, `'FY25'`). - symbol: string; default: not declared ### @insiderfinance/totalfinance/core#RequireFiniteFieldsOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The shared enforcement path for a request object's NUMERIC fields (spec 3B.1b). One call answers the three questions a numeric contract actually makes, in the order a caller makes mistakes: is the field there, is it a number, is that number usable. Each gets its own code and its own sentence, because "volatility is required" and "volatility must be a finite number, received NaN" are different bugs with different fixes and a single `input.not_finite` for both teaches neither. Why this exists rather than a hand-rolled check per boundary: measurement found 31 public boundaries where omitting a declared-required field reached the arithmetic and returned `NaN` — `blackScholesPrice({ spot, strike, timeToExpiryYears, riskFreeRate, dividendYield })` with no `volatility` priced the option as `NaN` and handed it back as a success. In a pricing library a silently wrong number is the worst possible failure: it does not look like an error at any layer that consumes it. The declaration already said the field was required; only the runtime disagreed. HOT PATHS: this validates ONE object, not one row. It belongs at a public facade, never inside an iterative solver or a columnar loop whose columns were already checked — those call the unchecked kernel behind the facade (spec 3B.1b: unchecked numeric routines stay private and reachable only after validation). A `for` over a handful of declared names costs nothing next to `Math.log`; the same loop run 100,000 times inside a batch path is a different thing entirely. ```typescript /** * The shared enforcement path for a request object's NUMERIC fields (spec 3B.1b). * * One call answers the three questions a numeric contract actually makes, in the order a caller * makes mistakes: is the field there, is it a number, is that number usable. Each gets its own code * and its own sentence, because "volatility is required" and "volatility must be a finite number, * received NaN" are different bugs with different fixes and a single `input.not_finite` for both * teaches neither. * * Why this exists rather than a hand-rolled check per boundary: measurement found 31 public * boundaries where omitting a declared-required field reached the arithmetic and returned `NaN` — * `blackScholesPrice({ spot, strike, timeToExpiryYears, riskFreeRate, dividendYield })` with no * `volatility` priced the option as `NaN` and handed it back as a success. In a pricing library a * silently wrong number is the worst possible failure: it does not look like an error at any layer * that consumes it. The declaration already said the field was required; only the runtime disagreed. * * HOT PATHS: this validates ONE object, not one row. It belongs at a public facade, never inside an * iterative solver or a columnar loop whose columns were already checked — those call the unchecked * kernel behind the facade (spec 3B.1b: unchecked numeric routines stay private and reachable only * after validation). A `for` over a handful of declared names costs nothing next to `Math.log`; the * same loop run 100,000 times inside a batch path is a different thing entirely. */ export interface RequireFiniteFieldsOptions { /** * ONE complete, runnable call for this boundary — `blackScholesPrice({ type: 'call', spot: 100, … })`, * not a field fragment like `volatility: 0.2`. * * `missingFieldError` documents itself as showing "a WORKING example call", and the rest of the * library honours that: `walkForward({ data, trainSize: 30, … })`, `sma(closes, { period: 20 })`. * A fragment is helpful but not pasteable, and a caller who is already confused about the shape of * the request is exactly who cannot assemble one from a field snippet. */ /** * A THUNK is accepted so a derived example costs nothing on the success path. * * Shared validators must build their example from the reported function name, and RV6 first wrote * that as `exampleCall: facadeExampleCall(functionName)` — evaluated on EVERY call, including the * millions that never fail. That put string construction inside `blackScholes.price`, a documented * hot path, to produce a message thrown away unused. The lazy form keeps the example correct and * the success path free; it is only invoked when a field is actually missing. */ exampleCall: string | (() => string); /** * Optional per-field note appended on its own line — the unit trap or range the call shape cannot * carry (`annualized decimal, not 20`). Keyed by the BARE field name. */ hints?: Readonly>; /** * Dotted prefix for a NESTED contract, so the error reads `parameters.kappa` rather than `kappa`. * The caller is holding an outer request; the bare name does not say which object to fix. */ path?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exampleCall: string | (() => string); default: not declared — A THUNK is accepted so a derived example costs nothing on the success path. Shared validators must build their example from the reported function name, and RV6 first wrote that as `exampleCall: facadeExampleCall(functionName)` — evaluated on EVERY call, including the millions that never fail. That put string construction inside `blackScholes.price`, a documented hot path, to produce a message thrown away unused. The lazy form keeps the example correct and the success path free; it is only invoked when a field is actually missing. - hints?: Readonly>; default: not declared — Optional per-field note appended on its own line — the unit trap or range the call shape cannot carry (`annualized decimal, not 20`). Keyed by the BARE field name. - path?: string; default: not declared — Dotted prefix for a NESTED contract, so the error reads `parameters.kappa` rather than `kappa`. The caller is holding an outer request; the bare name does not say which object to fix. ### @insiderfinance/totalfinance/core#RhoUnit Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RhoUnit = 'per1Percent' | 'perPoint'; ``` ### @insiderfinance/totalfinance/core#SeriesFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A multi-argument (series-first) facade: the plain call takes `(data, parameters?, …)`, and `.explain()` takes the SAME arguments and returns the {@link Computed} envelope. This is the S2 shape (`rsi(closes, parameters?)`, `sharpe(returns, options?)`) — distinct from {@link Facade}, which is the single-object S1 shape (`blackScholes.call({ … })`). ```typescript /** * A multi-argument (series-first) facade: the plain call takes `(data, parameters?, …)`, and `.explain()` * takes the SAME arguments and returns the {@link Computed} envelope. This is the S2 shape (`rsi(closes, * parameters?)`, `sharpe(returns, options?)`) — distinct from {@link Facade}, which is the single-object S1 * shape (`blackScholes.call({ … })`). */ export type SeriesFacade = Record> = ((...callArguments: Args) => Output) & { explain: (...callArguments: Args) => Computed; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): Args; default: not declared - explain: (...callArguments: Args) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: Output; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): Args; default: not declared ### @insiderfinance/totalfinance/core#Settlement Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type Settlement = 'physical' | 'cash'; ``` ### @insiderfinance/totalfinance/core#SymbolId Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SymbolId = string; ``` ### @insiderfinance/totalfinance/core#TIME_IN_FORCE_VALUES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TIME_IN_FORCE_VALUES: readonly TimeInForce[]; ``` ### @insiderfinance/totalfinance/core#ThetaUnit Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ThetaUnit = 'perDay' | 'perYear'; ``` ### @insiderfinance/totalfinance/core#TimeInForce Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TimeInForce`. ### @insiderfinance/totalfinance/core#Trade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Trade { symbol: SymbolId; timestampMs: EpochMs; price: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conditions?: string[]; default: not declared - exchange?: string; default: not declared - price: number; default: not declared - sequence?: number; default: not declared - size: number; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/core#US_EQUITY_HALF_DAY_RULES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). US equity/options early-close (13:00 ET) rules — the ONE table, consumed by `@insiderfinance/totalfinance/calendars` as well: the day after Thanksgiving, and 24 December and 3 July when they fall on a weekday and are not themselves the observed Christmas / Independence Day holiday. A rule returns the candidate date for a year; {@link isUsEquityHalfDay} applies the weekday/observance exclusions. ```typescript export declare const US_EQUITY_HALF_DAY_RULES: readonly HolidayRule[]; ``` ### @insiderfinance/totalfinance/core#UnsupportedError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A requested operation is not supported by the selected engine/model/contract. ```typescript export declare class UnsupportedError extends QuantError { constructor(message: string, options: QuantErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; cause?: unknown; readonly code: string; readonly context?: Record; message: string; name: string; stack?: string; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (message): string; default: not declared - (options): QuantErrorOptions; default: not declared - (options).cause?: unknown; default: not declared — Underlying cause, preserved on the standard `Error.cause` chain. - (options).code: string; default: not declared — Stable, machine-readable code, e.g. `input.negative_spot`. - (options).context?: Record; default: not declared — Structured context for programmatic handling and good error messages. - code: string; default: not declared - context?: Record; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core#ValidationBranchSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ValidationBranchSpecification { readonly fields: readonly ValidationFieldSpecification[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fields: readonly ValidationFieldSpecification[]; default: not declared ### @insiderfinance/totalfinance/core#ValidationFieldKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What the validator checks for a field, projected from the inventory's richer kind vocabulary. ```typescript /** What the validator checks for a field, projected from the inventory's richer kind vocabulary. */ export type ValidationFieldKind = 'numeric' | 'enum' | 'boolean' | 'string' | 'array' | 'object' | 'callback' | 'unchecked'; ``` ### @insiderfinance/totalfinance/core#ValidationFieldSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ValidationFieldSpecification { readonly name: string; readonly kind: ValidationFieldKind; readonly optional?: boolean; /** The declared union admits `null`; anywhere else a `null` is a wrong-typed value, not omission. */ readonly nullable?: boolean; /** * A documented IEEE BOUND field: ±Infinity is the spelled "unbounded" (`localCap: Infinity`, * `globalFloor: -Infinity`). CURATED per contract in the validation roster, never inferred — * the checker sees `number` either way, and which numbers mean "no bound" is financial * semantics (C03). `NaN` stays rejected: no bound is ever spelled NaN. */ readonly allowsInfinity?: boolean; /** * This numeric field is a synchronous resource count and must be a positive safe integer no * larger than this operation-level ceiling. Generated only where the declaration-derived resource * inventory owns the semantic classification; ordinary numeric magnitudes never receive it. */ readonly safeIntegerMaximum?: number; /** The array's elements are resource counts governed by the same positive-safe-integer ladder. */ readonly safeIntegerElementsMaximum?: number; /** The closed literal domain of an `enum` field. */ readonly literals?: readonly (string | number | boolean)[]; /** * OPEN primitive alternatives beside the literal domain — a MIXED union such as * `Frequency = 'annual' | 'semiannual' | … | number`, where a value is valid when it is a listed * literal OR any value of an open kind (numeric runs the finite ladder). Projected from the * declaration's arms; without it the collapsed kind rejected the named spellings. */ readonly openKinds?: readonly ValidationFieldKind[]; /** Nested closed object contract. */ readonly fields?: readonly ValidationFieldSpecification[]; /** Declared union alternatives. A field has `branches` OR `fields`, never both. */ readonly branches?: readonly ValidationBranchSpecification[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allowsInfinity?: boolean; default: not declared — A documented IEEE BOUND field: ±Infinity is the spelled "unbounded" (`localCap: Infinity`, `globalFloor: -Infinity`). CURATED per contract in the validation roster, never inferred — the checker sees `number` either way, and which numbers mean "no bound" is financial semantics (C03). `NaN` stays rejected: no bound is ever spelled NaN. - branches?: readonly ValidationBranchSpecification[]; default: not declared — Declared union alternatives. A field has `branches` OR `fields`, never both. - fields?: readonly ValidationFieldSpecification[]; default: not declared — Nested closed object contract. - kind: ValidationFieldKind; default: not declared - literals?: readonly (string | number | boolean)[]; default: not declared — The closed literal domain of an `enum` field. - name: string; default: not declared - nullable?: boolean; default: not declared — The declared union admits `null`; anywhere else a `null` is a wrong-typed value, not omission. - openKinds?: readonly ValidationFieldKind[]; default: not declared — OPEN primitive alternatives beside the literal domain — a MIXED union such as `Frequency = 'annual' | 'semiannual' | … | number`, where a value is valid when it is a listed literal OR any value of an open kind (numeric runs the finite ladder). Projected from the declaration's arms; without it the collapsed kind rejected the named spellings. - optional?: boolean; default: not declared - safeIntegerElementsMaximum?: number; default: not declared — The array's elements are resource counts governed by the same positive-safe-integer ladder. - safeIntegerMaximum?: number; default: not declared — This numeric field is a synchronous resource count and must be a positive safe integer no larger than this operation-level ceiling. Generated only where the declaration-derived resource inventory owns the semantic classification; ordinary numeric magnitudes never receive it. ### @insiderfinance/totalfinance/core#VegaUnit Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type VegaUnit = 'per1Percent' | 'perPoint'; ``` ### @insiderfinance/totalfinance/core#WarningCode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical warning codes. Like error codes, these are stable public API — consumers branch on them. The set is open; packages may add codes, but documented ones do not change without a major version. Codes that are BOTH a thrown-error condition and an emitted warning (`implied_volatility.below_intrinsic`, `implied_volatility.above_max_bound`, `implied_volatility.no_convergence`, `data.crossed_market`, `data.stale_quote`) live only in {@link ErrorCode} — the single source of truth — and warning sites reference `ErrorCode.*` for the code string, so no string is duplicated across the two registries (WS2.9). ```typescript export type WarningCode = (typeof WarningCode)[keyof typeof WarningCode]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ArtifactComparisonDifferentMarket: 'artifact.comparison_different_market'; default: not declared — Two artifacts under comparison were computed under different market snapshots — still comparable, but the reader is told the market moved (Stage 4.5). - ArtifactComparisonDifferentUniverse: 'artifact.comparison_different_universe'; default: not declared — Two research runs under comparison were computed over different universes or as-of dates — still comparable, but the reader is told the population moved (Stage 4.5). - ArtifactLibraryVersionDiffers: 'artifact.library_version_differs'; default: not declared — Two artifacts under comparison or replay name different producing library versions — a difference may be a library change rather than a market or parameter change (Stage 4.5). - BacktestAssignment: 'backtest.assignment'; default: not declared - BacktestComboLegUnfilled: 'backtest.combo_leg_unfilled'; default: not declared — Stage 4.6 (FC8) — a structure could not fill every leg under the fill policy (the row names the legs). - BacktestDataDuplicateTimestamp: 'backtest.data_duplicate_timestamp'; default: not declared - BacktestDataMissing: 'backtest.data_missing'; default: not declared — Stage 4.6 (FC8): a benchmark session had no return and counted as 0; the count rides the warning. - BacktestDataNonfinite: 'backtest.data_nonfinite'; default: not declared - BacktestDataUnsorted: 'backtest.data_unsorted'; default: not declared - BacktestEntrySkipped: 'backtest.entry_skipped'; default: not declared - BacktestForcedLiquidation: 'backtest.forced_liquidation'; default: not declared — Stage 4.6 (FC8) — a forced close under the declared liquidation policy (the row names the position and the shortfall). - BacktestLimitRejected: 'backtest.limit_rejected'; default: not declared — Stage 4.6 (FC8) — a pre-trade limit rejected an entry (the row names the limit and the values). - BacktestLookahead: 'backtest.lookahead'; default: not declared - BacktestMarginBreach: 'backtest.margin_breach'; default: not declared — Stage 4.6 (FC8) — maintenance margin breached under forcedLiquidation 'none'. - BacktestMarginRejected: 'backtest.margin_rejected'; default: not declared - BacktestMarkFallback: 'backtest.mark_fallback'; default: not declared — An open option leg could not be marked from its current-snapshot quote and the request's named missing-mark fallback was applied (Preview P1) — the count of leg-snapshots is carried. - BacktestMarkedAtCost: 'backtest.marked_at_cost'; default: not declared - BacktestNegativeCash: 'backtest.negative_cash'; default: not declared - BacktestShortRejected: 'backtest.short_rejected'; default: not declared - BacktestSignalWarmup: 'backtest.signal_warmup'; default: not declared - BinomialStepsRoundedOdd: 'binomial.steps_rounded_odd'; default: not declared - CalendarOutsideHistoricalCoverage: 'calendar.outside_historical_coverage'; default: not declared — Rules/closures do not certify historical sessions before the documented floor. - CompoundingOverflow: 'crypto.compounding_overflow'; default: not declared — Compounded annualization exceeded IEEE-754 range — reported as `null`, never Infinity. - CompoundingUndefined: 'crypto.compounding_undefined'; default: not declared — Fractional compounding of a ≤−100%-per-interval rate is undefined — reported as `null`, never NaN. - CovarianceFloored: 'math.covariance_floored'; default: not declared — A degenerate/collinear covariance was eigenvalue-floored to keep the SPD postcondition. - CryptoCarryArbitrage: 'crypto.carry_arbitrage'; default: not declared - CryptoExtremeFunding: 'crypto.extreme_funding'; default: not declared - CurveExtrapolated: 'curve.extrapolated'; default: not declared — A restored curve was evaluated outside its calibrated pillar range under its stored extrapolation policy — counted and disclosed, never silent (Stage 4.5). - DataCoverageUnverified: 'data.coverage_unverified'; default: not declared - DataIncompleteTerms: 'data.incomplete_terms'; default: not declared - DataLockedMarket: 'data.locked_market'; default: not declared - DataMissingField: 'data.missing_field'; default: not declared - DataResearchOnly: 'data.research_only'; default: not declared - DataSourceIssue: 'data.source_issue'; default: not declared - DataUnknownTimes: 'data.unknown_times'; default: not declared - DataZeroBidAsk: 'data.zero_bid_ask'; default: not declared - DegenerateInput: 'input.degenerate'; default: not declared — The result is NaN/degenerate BY DESIGN (empty series, zero variance) — disclosed, not fabricated. - EstimateRiskNeutral: 'estimate.risk_neutral'; default: not declared - FlowSweepsNotVenueVerified: 'flow.sweeps_not_venue_verified'; default: not declared - GreeksNotComputed: 'greeks.not_computed'; default: not declared - GreeksUnsupportedByEngine: 'greeks.unsupported_by_engine'; default: not declared — Greeks were explicitly requested but this engine cannot compute them — request not honored. - HestonCosineExpansionUnstable: 'heston.cosine_expansion_unstable'; default: not declared - HestonFellerViolated: 'heston.feller_violated'; default: not declared - ImpliedVolatilityBracketExpanded: 'implied_volatility.bracket_expanded'; default: not declared - ImpliedVolatilityFlatHistory: 'implied_volatility.flat_history'; default: not declared - ImpliedVolatilityLowVega: 'implied_volatility.low_vega'; default: not declared - LambdaUndefined: 'greeks.lambda_undefined'; default: not declared — Elasticity Λ = Δ·S/V is undefined (price underflowed to 0) — reported as `null`, never NaN/∞. - LookbackZeroCarry: 'lookback.zero_carry'; default: not declared - MathCovarianceEwmaEffectiveSample: 'math.covariance_ewma_effective_sample'; default: not declared - MathCovarianceIllConditioned: 'math.covariance_ill_conditioned'; default: not declared - MathCovarianceMethodAuto: 'math.covariance_method_auto'; default: not declared - MathCovarianceSingular: 'math.covariance_singular'; default: not declared - ModelLimitation: 'model.limitation'; default: not declared — A structural limitation of the model/data the caller should know about (design law #4). - MonteCarloQuasiMonteCarloDimensionFallback: 'monte_carlo.quasi_monte_carlo_dimension_fallback'; default: not declared - OperationUntypedWarning: 'operation.untyped_warning'; default: not declared — A library result reported this warning as a bare sentence; the envelope carries it typed. - OptimizeNotConverged: 'optimize.not_converged'; default: not declared - OptionsChainGreeksRowsSkipped: 'chain_greeks.rows_skipped'; default: not declared — B7 — `chainGreeks` returned some rows unchanged; `diagnostics.rows` names each reason. - OptionsChainHealthModelNotRequested: 'options.chain_health.model_not_requested'; default: not declared — Quote-only chain health was requested; model bounds and implied volatility are not assessed. - OptionsDividendsNone: 'options.dividends_none'; default: not declared - OptionsDividendsPast: 'options.dividends_past'; default: not declared - OptionsEngineFailed: 'options.engine_failed'; default: not declared — `compareEngines`: one or more engines failed to price (per-row detail on the failed rows). - OptionsExerciseDiscreteDividends: 'options.exercise_discrete_dividends'; default: not declared - PerformanceEmptySeries: 'performance.empty_series'; default: not declared — `analyze` on a series with zero return periods: every metric is null (E3 degenerate summary). - PerformanceNonFiniteMetric: 'performance.non_finite_metric'; default: not declared - PerformanceSuspiciousEquityInput: 'performance.suspicious_equity_input'; default: not declared - PerformanceUndefinedMetric: 'performance.undefined_metric'; default: not declared - PortfolioDisclosedHoldingsReview: 'portfolio.disclosed_holdings_review'; default: not declared — Supplied disclosed holdings do not support some changes, weights or concentration. - PortfolioMarketMarkAge: 'portfolio.market_mark_age'; default: not declared — Observation and valuation clocks differ; never relabel a source mark. - ResearchBacktestOverfittingProbabilityTrimmed: 'research.backtest_overfitting_probability_trimmed'; default: not declared — `probabilityOfBacktestOverfitting`: the oldest rows were trimmed so T divides into S blocks. - ResearchSurvivorshipBias: 'research.survivorship_bias'; default: not declared - ResearchTrainTestLeakage: 'research.train_test_leakage'; default: not declared - RiskAsOfUnscreened: 'risk.as_of_unscreened'; default: not declared — FC7 slice 4 (2026-08-29): estimateExpectedReturns received an asOf but no observation timestamps — nothing could be screened for look-ahead. - RiskBrinsonWeights: 'risk.brinson_weights'; default: not declared - RiskCornishFisherConditionalValueAtRiskGaussianFallback: 'risk.cornish_fisher_conditional_value_at_risk_gaussian_fallback'; default: not declared - RiskCornishFisherOutOfDomain: 'risk.cornish_fisher_out_of_domain'; default: not declared - RiskCostExceedsEdge: 'risk.cost_exceeds_edge'; default: not declared - RiskExtremeValueConfidenceOutsideTail: 'risk.extreme_value_confidence_outside_tail'; default: not declared - RiskExtremeValueDegenerateFit: 'risk.extreme_value_degenerate_fit'; default: not declared - RiskExtremeValueFewExceedances: 'risk.extreme_value_few_exceedances'; default: not declared - RiskExtremeValueInfiniteMean: 'risk.extreme_value_infinite_mean'; default: not declared - RiskExtremeValueInfiniteVariance: 'risk.extreme_value_infinite_variance'; default: not declared - RiskExtremeValueMleFallback: 'risk.extreme_value_mle_fallback'; default: not declared - RiskFrontierNotMonotone: 'risk.frontier_not_monotone'; default: not declared — Solved frontier points are not monotone in volatility versus expected return. - RiskFrontierPointsFailed: 'risk.frontier_points_failed'; default: not declared — One or more requested frontier points could not be solved (kept with their reasons). - RiskFrontierUnboundedReturn: 'risk.frontier_unbounded_return'; default: not declared — The constrained maximum return is unbounded (an asset without an upper bound and another without a lower bound); a `points` grid fell back to a risk-aversion grid. - RiskHighCostDrag: 'risk.high_cost_drag'; default: not declared - RiskInfeasibleConstraints: 'risk.infeasible_constraints'; default: not declared - RiskInfeasibleTangency: 'risk.infeasible_tangency'; default: not declared - RiskKellyEstimationNoEdge: 'risk.kelly_estimation_no_edge'; default: not declared - RiskKellyEstimationThinSample: 'risk.kelly_estimation_thin_sample'; default: not declared - RiskKellyFatTails: 'risk.kelly_fat_tails'; default: not declared - RiskKellyNaiveOverbet: 'risk.kelly_naive_overbet'; default: not declared - RiskKellyNegativeSum: 'risk.kelly_negative_sum'; default: not declared - RiskKellyNoEdge: 'risk.kelly_no_edge'; default: not declared - RiskKellyOver: 'risk.kelly_over'; default: not declared - RiskKellyUnbounded: 'risk.kelly_unbounded'; default: not declared - RiskKellyZeroVariance: 'risk.kelly_zero_variance'; default: not declared — C hygiene — a zero-variance edge has no Kelly fraction: the sizing is null, never an input error. - RiskMeanExcessNoLinearRegion: 'risk.mean_excess_no_linear_region'; default: not declared - RiskPnlUnexplainedResidual: 'risk.pnl_unexplained_residual'; default: not declared — P&L explain: the unexplained residual dominates the total — the greek expansion broke down. - RiskSharpeUndefined: 'risk.sharpe_undefined'; default: not declared — C hygiene — a zero-variance return series has no Sharpe ratio: the statistic is null. - RiskUnboundedLoss: 'risk.unbounded_loss'; default: not declared — `optionsMargin`: a net-short call makes the expiration loss unbounded — `maxLoss` is null. - RiskZeroGrossExposure: 'risk.zero_gross_exposure'; default: not declared — Zero gross exposure: concentration metrics are undefined and reported as null. - RiskZeroVolatilitySharpe: 'risk.zero_volatility_sharpe'; default: not declared — A frontier point with zero volatility has no Sharpe ratio (reported null with the reason). - ScenarioUnusedCurrencyConversion: 'scenario.unused_currency_conversion'; default: not declared — A valid reusable FX quote was supplied but no target required it in this scenario run. - StrategyOptimizerZeroCapital: 'strategy.optimizer_zero_capital'; default: not declared — `optimizeStrategy`: a candidate's capital requirement is zero — `thesisEvPerCapital` is null. - StrategyRiskRewardUndefined: 'strategy.risk_reward_undefined'; default: not declared — The reward-to-risk ratio is undefined: an unbounded profit or loss, or a zero maximum loss. - StrategyVolatilityFloored: 'strategy.volatility_floored'; default: not declared - StructureAggressorUnavailable: 'structure.aggressor_unavailable'; default: not declared - StructureContractsSkipped: 'structure.contracts_skipped'; default: not declared - StructureDuplicateContractQuotes: 'structure.duplicate_contract_quotes'; default: not declared — Repeated contract rows remain additive and may count the same open interest more than once. - StructureFlatBaseline: 'structure.flat_baseline'; default: not declared — `unusualness`: flat baseline — the z-score is undefined and reported null. - StructureNoEligibleQuotes: 'structure.no_eligible_quotes'; default: not declared — Every supplied quote was excluded; empty sums must not be read as measured zero exposure. - SurfaceExtrapolated: 'volatility.surface_extrapolated'; default: not declared - SuspiciousReturns: 'input.suspicious_returns'; default: not declared - SuspiciousRiskFreeRate: 'input.suspicious_risk_free_rate'; default: not declared - SuspiciousTime: 'input.suspicious_time'; default: not declared - SuspiciousVolatility: 'input.suspicious_volatility'; default: not declared - TechnicalAnalysisOpeningRangeTruncated: 'technical_analysis.opening_range_truncated'; default: not declared — `openingRange`: fewer bars than `periods` — the range covers the whole series. - VolatilityButterflyArbitrage: 'volatility.butterfly_arbitrage'; default: not declared - VolatilityCalibrationNotConverged: 'volatility.calibration_not_converged'; default: not declared — Surface/model calibration finished without meeting tolerance — best-effort parameters returned. - VolatilityEssviButterfly: 'volatility.essvi_butterfly'; default: not declared - VolatilityEssviCalendar: 'volatility.essvi_calendar'; default: not declared - VolatilityEssviCalendarData: 'volatility.essvi_calendar_data'; default: not declared - VolatilityEssviNotConverged: 'volatility.essvi_not_converged'; default: not declared - VolatilityFitInsufficientData: 'volatility.fit_insufficient_data'; default: not declared - VolatilityFitUnconverged: 'volatility.fit_unconverged'; default: not declared - VolatilityObservedSkewDuplicateContract: 'volatility.observed_skew_duplicate_contract'; default: not declared - VolatilityObservedSkewMissingDelta: 'volatility.observed_skew_missing_delta'; default: not declared - VolatilityObservedSkewQuoteExcluded: 'volatility.observed_skew_quote_excluded'; default: not declared - VolatilityObservedSkewUnavailable: 'volatility.observed_skew_unavailable'; default: not declared - VolatilityShockDegradedToInterpolated: 'volatility.shock_degraded_to_interpolated'; default: not declared - VolatilityShockFloored: 'volatility.shock_floored'; default: not declared - VolatilitySkewDeltaExtrapolated: 'volatility.skew_delta_extrapolated'; default: not declared - VolatilitySsviButterfly: 'volatility.ssvi_butterfly'; default: not declared - VolatilitySsviCalendarData: 'volatility.ssvi_calendar_data'; default: not declared - VolatilitySsviNotConverged: 'volatility.ssvi_not_converged'; default: not declared - VolatilityStickyIndeterminate: 'volatility.sticky_indeterminate'; default: not declared - VolatilityStickyWeakFit: 'volatility.sticky_weak_fit'; default: not declared - VolatilitySurfaceQuotesSkipped: 'volatility.surface_quotes_skipped'; default: not declared - VolatilitySurfaceSparse: 'volatility.surface_sparse'; default: not declared - VolatilitySwaptionCubeExtrapolated: 'volatility.swaption_cube_extrapolated'; default: not declared - VolatilitySwaptionNodePoorFit: 'volatility.swaption_node_poor_fit'; default: not declared ### @insiderfinance/totalfinance/core#WarningSeverity Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type WarningSeverity = 'info' | 'warn' | 'error'; ``` ### @insiderfinance/totalfinance/core#Weekday Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Day of week, Sunday = 0 … Saturday = 6. ```typescript /** Day of week, Sunday = 0 … Saturday = 6. */ export type Weekday = 0 | 1 | 2 | 3 | 4 | 5 | 6; ``` ### @insiderfinance/totalfinance/core#addDays Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Add `n` calendar days to an ISO date. ```typescript export declare function addDays(date: string, days: number): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (date): string; default: not declared - (days): number; default: not declared ### @insiderfinance/totalfinance/core#alwaysOpen Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A 24/7 calendar (every day is a business day) — e.g. crypto. ```typescript export declare const alwaysOpen: Calendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/core#assertFiniteResult Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Law 7 runtime postcondition (spec P2.1, tightened in E3): a SUCCESSFUL explained result is JSON-safe — it NEVER carries a non-finite number (`JSON.stringify` would silently corrupt it to `null`). **Warnings never license a non-finite value**: an undefined quantity is reported as `null` and the warning explains the null. The only ratified exceptions are structural sentinels: 1. `diagnostics.warmup > 0` with an array value — EXACTLY the first `warmup` slots are the documented aligned-series "not yet formed" sentinel; every slot past the prefix is checked; 2. discriminated "none" elements — zone-style points (`direction: 0`, shape-anchored on their zone fields) and divergence points (`code: 0`, shape-anchored on `priceSwings`) — whose documented NaN-when-none fields are exempt; every OTHER field of such an element is still checked, and an element that merely says `direction: 0` without the zone shape (e.g. an honest tdSequential point) is walked in full. Anything else non-finite throws {@link PostconditionError}: a library defect surfaced loudly at the boundary rather than shipped silently into a serialization. The walk is exhaustive — full depth (cycle-safe), value + assumptions + diagnostics + provenance — so nothing hides below a cap. ```typescript export declare function assertFiniteResult(label: string, result: Computed): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (label): string; default: not declared - (result): Computed>; default: not declared - (result).assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - (result).diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - (result).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - (result).value: unknown; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/core#assertFiniteValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function assertFiniteValue(label: string, value: unknown): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (label): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#between Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Range predicate. Replaces wrapped-number DSLs (design law #2): use `between(Math.abs(delta), 0.25, 0.35)` rather than `delta.abs().between(...)`. ```typescript export declare function between(value: number, min: number, max: number, options?: BetweenOptions): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (max): number; default: not declared - (min): number; default: not declared - (options)?: BetweenOptions; default: not declared - (options).inclusive?: boolean; default: not declared — Include the bounds (default `true`). - (value): number; default: not declared ### @insiderfinance/totalfinance/core#clamp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Clamp `value` into `[min, max]`. ```typescript export declare function clamp(value: number, min: number, max: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (max): number; default: not declared - (min): number; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#compoundFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compound (growth) factor for `rate` over `years` under any {@link InterestCompounding} form. ```typescript export declare function compoundFactor(annualRate: number, years: number, compounding?: InterestCompounding): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (annualRate): number; default: not declared - (compounding)?: InterestCompounding; default: not declared - (compounding).periodsPerYear: number; default: not declared - (compounding).type: 'periodic'; default: not declared - (years): number; default: not declared ### @insiderfinance/totalfinance/core#compoundingPeriodsPerYear Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Periods per year for a discrete convention; `null` for the two non-discrete forms. ```typescript export declare function compoundingPeriodsPerYear(compounding: InterestCompounding): number | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (compounding): InterestCompounding; default: not declared - (compounding).periodsPerYear: number; default: not declared - (compounding).type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/core#createRuleCalendar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a `Calendar` from rules. Holiday/half-day sets are computed lazily per year and cached. The config is SNAPSHOTTED at construction — rule arrays, closures, weekend days, and the session object are copied — so mutating the caller's config (or a shared exported rules array) later can never make one calendar answer the same question two ways across warm and cold cache years. ```typescript export declare function createRuleCalendar(config: CalendarConfig): Calendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config): CalendarConfig; default: not declared - (config).closures?: string[]; default: not declared — Ad-hoc full closures (ISO dates), e.g. emergency closures or days of mourning. - (config).halfDayRules?: HolidayRule[]; default: not declared - (config).holidayRules?: HolidayRule[]; default: not declared - (config).name: string; default: not declared - (config).session: { close: string; halfDayClose?: string; open: string; }; default: not declared — Regular session hours as `HH:MM` in the calendar's `timezone`. `close: '24:00'` is the sentinel for "no close" — a continuous 24-hour session (e.g. `alwaysOpen`/crypto), distinct from `'00:00'` (midnight). Keep it as `'24:00'`; do not normalize to `'00:00'`. - (config).session.close: string; default: not declared - (config).session.halfDayClose?: string; default: not declared - (config).session.open: string; default: not declared - (config).timezone: string; default: not declared - (config).version: string; default: not declared - (config).weekendDays?: Weekday[]; default: not declared — Default `[0, 6]` (Sun & Sat). - return.addBusinessDays: (date: string, days: number) => string; default: not declared - return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - return.isBusinessDay: (date: string) => boolean; default: not declared - return.isHalfDay: (date: string) => boolean; default: not declared - return.isHoliday: (date: string) => boolean; default: not declared - return.name: string; default: not declared - return.nextBusinessDay: (date: string) => string; default: not declared - return.previousBusinessDay: (date: string) => string; default: not declared - return.session: (date: string) => DaySession; default: not declared - return.timezone: string; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/core#dayOfWeek Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Day of week for an ISO date. ```typescript export declare function dayOfWeek(date: string): Weekday; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (date): string; default: not declared ### @insiderfinance/totalfinance/core#defineCalendar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Define a custom calendar (spec §22.4 extension API). A thin wrapper over `createRuleCalendar` so the extension surface is stable even if the engine evolves. ```typescript export declare function defineCalendar(config: CalendarConfig): Calendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config): CalendarConfig; default: not declared - (config).closures?: string[]; default: not declared — Ad-hoc full closures (ISO dates), e.g. emergency closures or days of mourning. - (config).halfDayRules?: HolidayRule[]; default: not declared - (config).holidayRules?: HolidayRule[]; default: not declared - (config).name: string; default: not declared - (config).session: { close: string; halfDayClose?: string; open: string; }; default: not declared — Regular session hours as `HH:MM` in the calendar's `timezone`. `close: '24:00'` is the sentinel for "no close" — a continuous 24-hour session (e.g. `alwaysOpen`/crypto), distinct from `'00:00'` (midnight). Keep it as `'24:00'`; do not normalize to `'00:00'`. - (config).session.close: string; default: not declared - (config).session.halfDayClose?: string; default: not declared - (config).session.open: string; default: not declared - (config).timezone: string; default: not declared - (config).version: string; default: not declared - (config).weekendDays?: Weekday[]; default: not declared — Default `[0, 6]` (Sun & Sat). - return.addBusinessDays: (date: string, days: number) => string; default: not declared - return.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - return.isBusinessDay: (date: string) => boolean; default: not declared - return.isHalfDay: (date: string) => boolean; default: not declared - return.isHoliday: (date: string) => boolean; default: not declared - return.name: string; default: not declared - return.nextBusinessDay: (date: string) => string; default: not declared - return.previousBusinessDay: (date: string) => string; default: not declared - return.session: (date: string) => DaySession; default: not declared - return.timezone: string; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/core#discountFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Discount factor for `rate` over `years` under any {@link InterestCompounding} form. ```typescript export declare function discountFactor(annualRate: number, years: number, compounding?: InterestCompounding): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (annualRate): number; default: not declared - (compounding)?: InterestCompounding; default: not declared - (compounding).periodsPerYear: number; default: not declared - (compounding).type: 'periodic'; default: not declared - (years): number; default: not declared ### @insiderfinance/totalfinance/core#easterSunday Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Easter Sunday via the Anonymous Gregorian algorithm (Computus). ```typescript export declare function easterSunday(year: number): { month: number; day: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (year): number; default: not declared - return.day: number; default: not declared - return.month: number; default: not declared ### @insiderfinance/totalfinance/core#emptyDiagnostics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Construct an empty diagnostics object with no warnings. ```typescript export declare function emptyDiagnostics(): Diagnostics; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.iterations?: number; default: not declared — Iteration count for iterative methods. - return.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.selection?: SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/core#ensureEnum Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Enum guard: `value` must be exactly one of `allowed` (design law #4 — a meaning-changing field is never coerced; `type: 'Call'` must teach, not silently price the other leg). Accepts `unknown` so boundary callers can validate untyped input without a cast. ```typescript export declare function ensureEnum(value: unknown, allowed: readonly T[], field: string, functionName: string): asserts value is T; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (allowed): readonly T[]; default: not declared - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#ensureFinite Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Throw unless `value` is a finite number. ```typescript export declare function ensureFinite(value: number, field: string, functionName: string): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#ensureFiniteWhenPresent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A finite numeric value WHEN PRESENT — the optional-field sibling of {@link requireFiniteFields}. `undefined` is allowed (optional omission, C06); anything else runs the same ladder a required field does, so a string in an optional numeric slot reports `input.wrong_type` exactly as it would in a required one. Calling bare `ensureFinite` there reported `input.not_finite`, which contradicted the library's own documented matrix — and a test had been written asserting the contradiction, which is how it survived. `null` is NOT omission. This guard originally returned early on null, which silently accepted a value every one of its call sites declares impossible (`lowerVolatilityBound?: number`, a bar's `open?: number` — none say `| null`). C06 reserves `null` for declarations that explicitly carry it; a field that wants nullable semantics declares them and takes a different guard. The `null-when-nonnullable` enforcement mutation exists to keep this class measurable. ```typescript export declare function ensureFiniteWhenPresent(value: unknown, field: string, functionName: string): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#ensureKnownKeys Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Law 12 — facade, analysis, and builder object inputs REJECT unknown keys (a misspelled option must never be silently ignored: `greek: false` computing Greeks anyway is the bug class this kills). Cheap by design: one key scan against a Set-able allowlist, no schema machinery, so it is safe on hot facade paths. Direct kernels use named objects when financial values could be confused; adapters that own foreign/superset schemas are declared `passthrough` in the manifest and skip this guard. ```typescript export declare function ensureKnownKeys(functionName: string, field: string, value: object, allowed: readonly string[]): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (allowed): readonly string[]; default: not declared - (field): string; default: not declared - (functionName): string; default: not declared - (value): object; default: not declared ### @insiderfinance/totalfinance/core#ensureNonNegative Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Throw unless `value` is a finite number `>= 0`. ```typescript export declare function ensureNonNegative(value: number, field: string, functionName: string, code?: string): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (code)?: string; default: not declared - (field): string; default: not declared - (functionName): string; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#ensurePositive Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Throw unless `value` is a finite number `> 0`. ```typescript export declare function ensurePositive(value: number, field: string, functionName: string, code?: string): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (code)?: string; default: not declared - (field): string; default: not declared - (functionName): string; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#facade Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pair a plain-value `call` with its envelope-returning `explain` into a single {@link Facade}. `label` is the public name of the facade as the user calls it (e.g. `'blackScholes.call'`) — it opens every guard message. S1 facades take an input OBJECT of named fields, so arrays are rejected here too. ```typescript export declare function facade = Record, ExplainValue = Output>(label: string, call: (input: Input) => Output, explain: (input: Input) => Computed): Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (call): (input: Input) => Output; default: not declared - (explain): (input: Input) => Computed; default: not declared - (label): string; default: not declared - return.explain: (input: Input) => Computed; default: not declared ### @insiderfinance/totalfinance/core#finalizeResult Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate and return a direct Computed result in one expression. ```typescript export declare function finalizeResult>(label: string, result: Result): Result; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (label): string; default: not declared - (result): Result; default: not declared ### @insiderfinance/totalfinance/core#finiteOrNull Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Law 7 helper: a computed quantity that overflowed/underflowed to NaN/±Infinity is reported as `null` (undefined-with-reason at the envelope tier), never as a non-finite "success" value. ```typescript export declare function finiteOrNull(value: number): number | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): number; default: not declared ### @insiderfinance/totalfinance/core#formatMoney Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Format a number as currency using the platform `Intl` (browser-safe). ```typescript export declare function formatMoney(value: number, options?: FormatMoneyOptions): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: FormatMoneyOptions; default: not declared - (options).currency?: string; default: not declared - (options).decimals?: number; default: not declared - (options).locale?: string; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#formatOccSymbol Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Format option components into a compact OCC option symbol. ```typescript export declare function formatOccSymbol(option: Pick): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (option): Pick; default: not declared - (option).expiry: string; default: not declared — ISO `YYYY-MM-DD`. - (option).root: string; default: not declared - (option).strike: number; default: not declared - (option).type: OptionType; default: not declared ### @insiderfinance/totalfinance/core#formatPercent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Format a fraction (`0.22`) as a percent string (`"22.00%"`). ```typescript export declare function formatPercent(value: number, options?: FormatPercentOptions): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: FormatPercentOptions; default: not declared - (options).asPercentagePoints?: boolean; default: not declared — If `true`, the input is already a percentage (e.g. `22`) rather than a fraction (`0.22`). - (options).decimals?: number; default: not declared — Fraction digits (default `2`). - (options).locale?: string; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#goodFriday Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Good Friday (two days before Easter Sunday). ```typescript export declare function goodFriday(year: number): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (year): number; default: not declared ### @insiderfinance/totalfinance/core#isComputed Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Runtime guard for the one-envelope law (dx §7.2): a rich result is `Computed` iff it carries `value`, `assumptions.conventionsVersion`, and a `diagnostics.warnings` array. Exported so generic result handlers (and the conformance sweep in CI) can assert the shape. ```typescript export declare function isComputed(value: unknown): value is Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#isFiniteNumber Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). True only for a real, finite number (rejects `NaN`, `Infinity`, and non-numbers). ```typescript export declare function isFiniteNumber(value: unknown): value is number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#isNonNegative Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function isNonNegative(value: unknown): value is number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#isOccOptionSymbol Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether `symbol` is an OCC option symbol: true exactly when the OCC grammar accepts it — the same parse {@link parseOccSymbol} performs before resolving the expiry instant. The grammar lives in one place; this only asks the question, so a broker or a plan can refuse to treat an option contract as a share without re-describing the symbol layout or bundling the session calendar. ```typescript export declare function isOccOptionSymbol(symbol: string): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (symbol): string; default: not declared ### @insiderfinance/totalfinance/core#isPositive Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function isPositive(value: unknown): value is number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#isQuantError Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Type guard: is this value a QuantError (and optionally a specific code)? ```typescript export declare function isQuantError(value: unknown, code?: string): value is QuantError; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (code)?: string | undefined; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#isTrustworthy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). C (hygiene): the one question a caller asks of any envelope — may I act on this number? A result is trustworthy when its iterative procedure converged (or none ran: `converged` absent) and no warning is an error. `converged` lives on `diagnostics` everywhere; a result that also reports it in its value mirrors the diagnostics slot, so this reads one place. ```typescript export declare function isTrustworthy(result: unknown): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (result): unknown; default: not declared ### @insiderfinance/totalfinance/core#isUsEquityHalfDay Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether a `YYYY-MM-DD` calendar date is a US equity/options early-close day (13:00 ET). Applies {@link US_EQUITY_HALF_DAY_RULES} with the weekend and observed-holiday exclusions, so 2021-12-24 (the observed Christmas holiday) and 2026-07-03 (the observed Independence Day holiday) are full closures, not half days. ```typescript export declare function isUsEquityHalfDay(date: string): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (date): string; default: not declared ### @insiderfinance/totalfinance/core#isoDateToEpochMs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert an ISO `YYYY-MM-DD` date to epoch milliseconds at UTC midnight. ```typescript export declare function isoDateToEpochMs(value: string): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): string; default: not declared ### @insiderfinance/totalfinance/core#lastWeekdayOfMonth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The last `weekday` of a month, e.g. last Monday of May. ```typescript export declare function lastWeekdayOfMonth(year: number, month: number, weekday: Weekday): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (month): number; default: not declared - (weekday): Weekday; default: not declared - (year): number; default: not declared ### @insiderfinance/totalfinance/core#missingFieldError Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the canonical "a required field is missing" error (design law #4 / the first-touch law). One voice across every facade: it names the field and shows a WORKING example call, so the message teaches the fix instead of leaking a raw `TypeError` from a property access. ``` InputError [input.missing_field]: sma: period is required. e.g. sma(closes, { period: 20 }) ``` ```typescript export declare function missingFieldError(functionName: string, field: string, example: string, hint?: string): InputError; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (example): string; default: not declared - (field): string; default: not declared - (functionName): string; default: not declared - (hint)?: string | undefined; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. ### @insiderfinance/totalfinance/core#nthWeekdayOfMonth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `occurrence`-th (1-based) `weekday` of a month, e.g. 3rd Monday of January. Returns `null` when the month has no such occurrence (e.g. a 5th Friday in a 4-Friday February) — the same "not observed" channel {@link HolidayRule} already speaks — rather than fabricating an impossible date like `2026-02-34`. ```typescript export declare function nthWeekdayOfMonth(year: number, month: number, weekday: Weekday, occurrence: number): string | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (month): number; default: not declared - (occurrence): number; default: not declared - (weekday): Weekday; default: not declared - (year): number; default: not declared ### @insiderfinance/totalfinance/core#observedHoliday Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Apply the US observance rule: Saturday → preceding Friday, Sunday → following Monday. ```typescript export declare function observedHoliday(year: number, month: number, day: number): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (day): number; default: not declared - (month): number; default: not declared - (year): number; default: not declared ### @insiderfinance/totalfinance/core#optionExpiryToMs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Parse an option-expiry label to epoch-ms. A bare `YYYY-MM-DD` resolves to {@link usEquityCloseUtcMs} (16:00 ET) — not UTC midnight — so an intraday `asOf` on the expiry date still sees positive time-to-expiry; a full datetime string is parsed as-is. Throws on an unparseable value. ```typescript export declare function optionExpiryToMs(expiry: string): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (expiry): string; default: not declared ### @insiderfinance/totalfinance/core#parseIsoDate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Parse an ISO `YYYY-MM-DD` date into calendar components, validating it is a real date. ```typescript export declare function parseIsoDate(value: string): CalendarDate; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): string; default: not declared - return.day: number; default: not declared - return.month: number; default: not declared - return.year: number; default: not declared ### @insiderfinance/totalfinance/core#parseOccSymbol Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Parse an OCC option symbol into its components. ```typescript export declare function parseOccSymbol(symbol: string): OccOptionSymbol; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (symbol): string; default: not declared - return.expiresAt: number; default: not declared — Resolved expiry instant (one expiry law, E2): OCC symbols are always US-equity date-only. - return.expiry: string; default: not declared — ISO `YYYY-MM-DD`. - return.expiryConvention: 'us-equity-close'; default: not declared - return.root: string; default: not declared - return.strike: number; default: not declared - return.type: OptionType; default: not declared ### @insiderfinance/totalfinance/core#plausibilityWarnings Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plausibility warnings for the two classic quant footguns (the first-touch law §2.4). Facades stay silent-and-correct on the plain-value path (a 2200% vol is legal — memecoins exist), but the `.explain()` envelope should say what it sees. Never throws; returns `[]` when inputs look normal. - `vol > 3` → likely a percent typed as a decimal (`vol: 22` → 2200%). - `t > 5` & integer → likely a day count typed as a year fraction (`t: 30` → a 30-year option). - `|rate| > 0.5` → likely a percent typed as a decimal (`rate: 4.5` → a 450% risk-free rate). ```typescript export declare function plausibilityWarnings(inputs: { volatility?: number; timeToExpiryYears?: number; riskFreeRate?: number; }): QuantWarning[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (inputs): { riskFreeRate?: number; timeToExpiryYears?: number; volatility?: number; }; default: not declared - (inputs).riskFreeRate?: number; default: not declared - (inputs).timeToExpiryYears?: number; default: not declared - (inputs).volatility?: number; default: not declared ### @insiderfinance/totalfinance/core#requireArgumentArray Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Throw unless `value` is a real array (or typed array). ```typescript export declare function requireArgumentArray(functionName: string, field: string, value: unknown): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#requireArgumentObject Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireArgumentObject(functionName: string, field: string, value: unknown): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#requireFiniteFields Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireFiniteFields(functionName: string, input: unknown, fields: readonly string[], options: RequireFiniteFieldsOptions): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (fields): readonly string[]; default: not declared - (functionName): string; default: not declared - (input): unknown; default: not declared - (options): RequireFiniteFieldsOptions; default: not declared - (options).exampleCall: string | (() => string); default: not declared — A THUNK is accepted so a derived example costs nothing on the success path. Shared validators must build their example from the reported function name, and RV6 first wrote that as `exampleCall: facadeExampleCall(functionName)` — evaluated on EVERY call, including the millions that never fail. That put string construction inside `blackScholes.price`, a documented hot path, to produce a message thrown away unused. The lazy form keeps the example correct and the success path free; it is only invoked when a field is actually missing. - (options).hints?: Readonly>; default: not declared — Optional per-field note appended on its own line — the unit trap or range the call shape cannot carry (`annualized decimal, not 20`). Keyed by the BARE field name. - (options).path?: string; default: not declared — Dotted prefix for a NESTED contract, so the error reads `parameters.kappa` rather than `kappa`. The caller is holding an outer request; the bare name does not say which object to fix. ### @insiderfinance/totalfinance/core#requireRateCurveData Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The ONE full validator for a stored/observed {@link RateCurve} as PLAIN DATA — shared by the Gate B market-snapshot spine (`observations.curves`) and the Gate C pricing protocol (the `discountCurve` observation value), so both refuse the same malformed curves with the same teaching. Core-internal on purpose: it is validation plumbing, not analysis API. Checks: `currency` a non-empty string; `asOf` finite epoch ms; `dayCount`/`compounding` valid conventions (a curve states its own — no silent economics); `points` an array of AT LEAST ONE pillar (an empty curve discounts nothing — a consumer handed zero pillars has no discount function, so emptiness is refused here rather than downstream) whose entries have a REAL `'YYYY-MM-DD'` calendar date (parsed with core's date parser, so `'2025-02-30'` is refused), strictly ascending pillar dates, dates at or after the curve's own `asOf` (a pillar BEFORE the curve's valuation instant discounts into the past — no consumer has a meaning for it; a pillar exactly AT `asOf` is the legal t = 0 anchor), and a finite `zeroRate` whose discount factor is actually computable and representable under the curve's compounding at that pillar's tenor; `interpolation` a non-empty string when present (the declared type). Entries stay open (Law 12): vendor decoration is preserved, not enumerated here. **Pillar authority — `zeroRate` is the ONE datum (2026-08-23, second external review).** The semantics are the existing fixed-income consumer's: `curves.fromZeroRates(...)` consumes ZERO RATES quoted under the curve's own `compounding`/`dayCount` and DERIVES every discount factor through that compounding transform. The former advisory `discountFactor` pillar member is GONE: a second, potentially contradictory answer must not share a pillar (the old sign-consistency tolerance accepted `rate: 0.05` beside `discountFactor: 0.2`), and no consumer in the workspace ever read it — discount-factor-quoted data has its own constructor (`curves.fromDiscountFactors`), whose pillars carry no rates. What replaced the tolerance is a REAL economics check through core's own transform (`discountFactor` in `dates.ts` — the one compounding engine, not a second one): every pillar's derived discount factor must exist and be a positive finite number, so `zeroRate: -2` under annual compounding (growth factor `1 + r/m ≤ 0` — no real discount factor exists) and rate/tenor pairs whose factor overflows, underflows to zero, or goes negative are refused with the arithmetic named. ```typescript export declare function requireRateCurveData(functionName: string, path: string, value: unknown): RateCurve; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (path): string; default: not declared - (value): unknown; default: not declared - return.asOf: number; default: not declared - return.compounding: InterestCompounding; default: not declared - return.currency: string; default: not declared - return.dayCount: DayCount; default: not declared - return.interpolation?: string; default: not declared - return.points: RateCurvePoint[]; default: not declared ### @insiderfinance/totalfinance/core#requireRepresentableResult Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Law 7's INPUT-DRIVEN twin (2026-08-23 review wave): refuse a computed result that finite inputs pushed past IEEE-754 double precision. `assertFiniteValue` reports a non-finite success as a LIBRARY defect ("please report it"); this finalizer reports it as the caller's magnitudes overflowing the arithmetic — a teaching refusal, not a bug report. Every public facade/analysis/ratified-plain answer in the Stage 4 domain packages returns through one of the two; the overflow mutant (`tools/first-touch/overflow-sweep.test.ts`) holds the law. ```typescript export declare function requireRepresentableResult(functionName: string, result: T): T; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (result): T; default: not declared ### @insiderfinance/totalfinance/core#requireSelection Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate an explicit SELECTION list — `outputs: ['price', 'gamma']`, `metrics: ['gex']` — and return a dense copy in request order. A selection decides what is computed, so every malformed form teaches instead of being repaired: not an array (`input.wrong_type`), empty (`input.out_of_range` — an empty request computes nothing and would read as a successful empty answer), a sparse hole (`input.missing_field`), an unknown or non-string name (`input.invalid_enum`, with a did-you-mean), and a repeated name (`input.duplicate_entry`). A duplicate is never silently collapsed: it usually means the caller meant a different name. `functionName` and `field` name the caller's boundary in every one of those errors, so they are checked first: a missing label would otherwise surface as `undefined: undefined must be …`. ```typescript export declare function requireSelection(functionName: string, field: string, value: unknown, allowed: readonly T[]): T[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (allowed): readonly T[]; default: not declared - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#resolveAsOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a DATE-GRANULAR `asOf` to epoch ms — ledgers, calendars, fundamentals, performance and research windows, where "as of 2026-07-06" means the calendar date. Deterministic by construction: bare dates resolve to UTC midnight, datetimes require an explicit zone, and anything else throws a teaching error (never a machine-local parse). Option-pricing paths must NOT use this door: a bare date hides the time of day that a same-day option's value depends on. They resolve through {@link resolveValuationAsOf}, which rejects a date-only `asOf` with the fix. ```typescript export declare function resolveAsOf(asOf: EpochMs | string, functionName?: string): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (asOf): string | number; default: not declared - (functionName)?: string; default: not declared ### @insiderfinance/totalfinance/core#resolveValuationAsOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a VALUATION instant (`asOf`) to epoch ms — the door every option-pricing path uses (options, strategy, volatility, structure, scenarios, risk marking). Accepts finite epoch milliseconds or a zoned ISO datetime. A date-only string is REJECTED with the fix: the time of day is the whole answer for a same-day option (a bare date resolved to UTC midnight valued a 0DTE at 10:30 ET with 3.6× its remaining life), and the expiry side already refuses a bare date that does not name its instant. `usEquitySessionInstant(date, 'close')` is the one-call form for an end-of-day mark. ```typescript export declare function resolveValuationAsOf(asOf: EpochMs | string, functionName?: string): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (asOf): string | number; default: not declared - (functionName)?: string; default: not declared ### @insiderfinance/totalfinance/core#resolvedExpiry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve an expiry label to the REQUIRED contract fields (E2): the spreadable `{ expiresAt, expiryConvention }` pair for constructing an `OptionContract` from a label — the same resolution the option builders stamp. Prefer the builders for user-facing code; this exists for adapters and tests assembling contracts inline. ```typescript export declare function resolvedExpiry(expiry: string): { expiresAt: EpochMs; expiryConvention: 'us-equity-close' | 'explicit-instant'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (expiry): string; default: not declared - return.expiresAt: number; default: not declared - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared ### @insiderfinance/totalfinance/core#round Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Round half-away-from-zero to `decimals` places, robust to floating-point representation. Total over the double domain: `decimals` must be an integer in [-323, 323] (10^±323 spans the whole representable grid — beyond it nothing survives double precision), and the extremes are exact identities rather than overflow artifacts: an integer input with `decimals >= 0` is returned unchanged (so `round(1e16, 0)` is 1e16, not 1e16+2, and `round(Number.MAX_VALUE, 2)` is MAX_VALUE, not Infinity), and when the requested grid is coarser than the value's own ulp the value is already its rounded self. ```typescript export declare function round(value: number, decimals?: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (decimals)?: number; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#selectQuotePrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a single price from an option quote per the requested source. Returns `undefined` when the requested fields are absent. `mid` falls back to (bid+ask)/2 when an explicit mid is missing. An unknown `source` is a typed error, never a silent `undefined` — "field absent" and "you typed `'midd'`" must not be the same answer. ```typescript export declare function selectQuotePrice(quote: OptionQuote, source: PriceSource): number | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (quote): OptionQuote; default: not declared - (quote).ask?: number; default: not declared - (quote).askSize?: number; default: not declared - (quote).bid?: number; default: not declared - (quote).bidSize?: number; default: not declared - (quote).conditions?: string[]; default: not declared - (quote).contract: OptionContract; default: not declared - (quote).exchange?: string; default: not declared - (quote).greeks?: OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - (quote).impliedVolatility?: number; default: not declared - (quote).last?: number; default: not declared - (quote).mark?: number; default: not declared - (quote).mid?: number; default: not declared - (quote).openInterest?: number; default: not declared - (quote).timestampMs: number; default: not declared - (quote).underlyingPrice?: number; default: not declared - (quote).volume?: number; default: not declared - (source): PriceSource; default: not declared ### @insiderfinance/totalfinance/core#seriesFacade Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pair a series-first `call` with an `.explain()` that takes the same arguments (S2 facades). `label` is the public name of the facade as the user calls it (e.g. `'sharpe'`). ```typescript export declare function seriesFacade = Record>(label: string, call: (...callArguments: Args) => Output, explain: (...callArguments: Args) => Computed): SeriesFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (call): (...callArguments: Args) => Output; default: not declared - (explain): (...callArguments: Args) => Computed; default: not declared - (label): string; default: not declared - return.explain: (...callArguments: Args) => Computed; default: not declared ### @insiderfinance/totalfinance/core#sideOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The side of a signed quantity: positive buys, negative sells. Zero and non-finite values have no side and are refused — a caller that reaches here with `0` has a sizing bug, not an order. ```typescript export declare function sideOf(signed: number, functionName?: string): OrderSide; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName)?: string; default: not declared - (signed): number; default: not declared ### @insiderfinance/totalfinance/core#signOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The sign of a side: `+1` for a buy, `-1` for a sell. Any other value is refused. ```typescript export declare function signOf(side: OrderSide, functionName?: string): 1 | -1; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName)?: string; default: not declared - (side): OrderSide; default: not declared ### @insiderfinance/totalfinance/core#stableSum Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sum signed finite addends without losing a representable answer to evaluation order. The ordinary path uses a non-overlapping floating-point expansion: low-order residuals survive cancellation (`1e16 + 1 − 1e16 === 1`). If one partial addition itself overflows, the fallback decodes each double into an exact BigInt superaccumulator and rounds the exact total once. That fallback is what makes `1e308 + 1e308 + 1 − 1e308 − 1e308` return `1` in every permutation while still returning Infinity when the mathematical sum of the supplied doubles exceeds `Number.MAX_VALUE`. Non-finite addends retain ordinary IEEE-754 propagation semantics. ```typescript export declare function stableSum(addends: readonly number[]): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (addends): readonly number[]; default: not declared ### @insiderfinance/totalfinance/core#suspiciousReturnsWarning Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The third classic footgun (dx WS-3 / R6): a PRICE or equity series passed where per-period RETURNS are expected. Returns are decimals (`0.01` = +1%); a series whose mean magnitude exceeds 0.5 (50% per period) is almost certainly prices — a monotonic 100→160 price series fed to `sharpe()` yields an absurd-but-silent 117. Warning only, never an error (a genuine >50%/period return series is legal — it is just worth flagging). Returns `undefined` when the series looks like returns. ```typescript export declare function suspiciousReturnsWarning(returns: ArrayLike): QuantWarning | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (returns): ArrayLike; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.message: string; default: not declared - return.severity: WarningSeverity; default: not declared ### @insiderfinance/totalfinance/core#toFixedSafe Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `toFixed` that never throws on non-finite input and never returns `"NaN"` silently. ```typescript export declare function toFixedSafe(value: number, decimals?: number): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (decimals)?: number; default: not declared - (value): number; default: not declared ### @insiderfinance/totalfinance/core#usEquityCloseUtcMs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). UTC epoch-ms for the **US equity/options market close** on a calendar date — 16:00 America/New_York, or 13:00 on an early-close day ({@link isUsEquityHalfDay}) — DST-aware via `Intl`. Use it to resolve a *date-only* option expiry to its end-of-session instant instead of UTC midnight, so a contract stays alive through its expiry trading day. This encodes US-equity hours specifically; it is not a generic exchange close. ```typescript export declare function usEquityCloseUtcMs(year: number, month: number, day: number): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (day): number; default: not declared - (month): number; default: not declared - (year): number; default: not declared ### @insiderfinance/totalfinance/core#usEquityMarketDateUtcMs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). UTC-midnight epoch of the market DATE an instant falls on — the anchor for weekday / day-of-month arithmetic (`getUTCDay()` on it is the ET weekday) and for whole-day counts against date labels. ```typescript export declare function usEquityMarketDateUtcMs(epochMs: EpochMs): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (epochMs): number; default: not declared ### @insiderfinance/totalfinance/core#usEquityMarketDayIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The US equity/options market's calendar DAY an instant falls on, as a whole-day index (days since the epoch of the America/New_York calendar date). Differencing two indices gives whole CALENDAR DAYS between two market dates; equality means "same trading date". This is the ONE day boundary shared by 0DTE classification, days-to-expiry counts and earnings day counts: expiries resolve to 16:00 ET (20:00/21:00 UTC), so a UTC-day comparison is already "tomorrow" between 20:00 and 23:59 ET. Pure and clock-free. ```typescript export declare function usEquityMarketDayIndex(epochMs: EpochMs): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (epochMs): number; default: not declared ### @insiderfinance/totalfinance/core#usEquitySessionInstant Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The instant of a US equity/options session boundary on a `YYYY-MM-DD` date — the one-call way to say "as of today's close" without remembering the DST offset: ```ts market({ spot: 195.3, riskFreeRate: 0.045, volatility: 0.24, asOf: usEquitySessionInstant('2026-07-20', 'close') }) ``` `'open'` is 09:30 ET; `'close'` is 16:00 ET, or 13:00 ET on an early-close day. Weekends and holidays are not rejected here (the instant still exists); use `@insiderfinance/totalfinance/calendars` to ask whether the market was open. ```typescript export declare function usEquitySessionInstant(date: string, session: 'open' | 'close'): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (date): string; default: not declared - (session): 'open' | 'close'; default: not declared ### @insiderfinance/totalfinance/core#validateClosedRequest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one public closed request against its GENERATED contract spec. Call ONCE at the public boundary; internals stay unchecked. Domain semantics (positivity, coordinate relationships, plausibility) remain the boundary's own code — this enforces shape, presence, type, finiteness, domain literals, and closedness, with the exact code each mistake owns. ```typescript export declare function validateClosedRequest(functionName: string, value: unknown, specification: ClosedRequestSpecification, teaching: ClosedRequestTeaching): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (specification): ClosedRequestSpecification; default: not declared - (specification).branches?: readonly ValidationBranchSpecification[]; default: not declared — ROOT union alternatives — the whole argument is a discriminated union (`phiValue`'s `SSVIPhi`). When present, `fields` holds the arms' COMMON members (the discriminant) and resolution runs discriminant-first over these arms exactly as a union FIELD's branches do. - (specification).contract: string; default: not declared — The stable contract identity this spec was generated from — drift gates compare through it. - (specification).fields: readonly ValidationFieldSpecification[]; default: not declared - (teaching): ClosedRequestTeaching; default: not declared - (teaching).argumentName?: string; default: not declared — The argument's own label in container errors — defaults to `input`. - (teaching).exampleCall: string | (() => string); default: not declared — ONE complete, runnable call for this boundary, or a thunk so the string is only built on the failing path. Hand-authored at the call site: the generator knows the keys, never the values. - (teaching).hints?: Readonly>; default: not declared — Per-field unit-trap notes, keyed by BARE field name (`volatility: 'annualized decimal'`). - (teaching).open?: boolean; default: not declared — The argument is an OPEN structural artifact per its manifest policy (Law 12): every consumed field runs its ladder, but unknown keys are PRESERVED decoration, never rejected — a fit result or market snapshot a user hands back may legitimately carry their own annotations. Curated from the manifest's per-argument `inputPolicies`; closed remains the default. - (teaching).subject?: boolean; default: not declared — This argument IS the request — field paths stay bare (`volatility`, `issueDate`) even under a domain-specific argument name like `specification`. Secondary arguments (an options bag beside a subject) omit it and get prefixed paths so a two-object call says which object to fix. - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core#validateResolvedExpiry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ONE expiry law, cross-field (E2): validate that a resolved option-expiry triple — `expiry` label, `expiresAt` instant, `expiryConvention` — is internally consistent: - the label parses, and its form matches the convention (date-only ⇔ `us-equity-close`, zoned datetime ⇔ `explicit-instant`); - `expiresAt` is the finite instant the label resolves to under that convention. Shared by the contract schema and the pro pricing entrypoints, so a hand-assembled or post-hoc-edited contract can never smuggle a contradictory resolution past an engine. ```typescript export declare function validateResolvedExpiry(functionName: string, expiry: string, expiresAt: unknown, expiryConvention: unknown): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (expiresAt): unknown; default: not declared - (expiry): string; default: not declared - (expiryConvention): unknown; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/core#warning Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a warning helper, defaulting severity to `warn`. ```typescript export declare function warning(code: string, message: string, severity?: WarningSeverity, context?: Record): QuantWarning; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (code): string; default: not declared - (context)?: Record | undefined; default: not declared - (message): string; default: not declared - (severity)?: WarningSeverity; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.message: string; default: not declared - return.severity: WarningSeverity; default: not declared ### @insiderfinance/totalfinance/core#weekendsOnly Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A calendar whose only non-business days are weekends. ```typescript export declare const weekendsOnly: Calendar; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addBusinessDays: (date: string, days: number) => string; default: not declared - addBusinessDays(date): string; default: not declared - addBusinessDays(days): number; default: not declared - businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - businessDaysBetween(from): string; default: not declared - businessDaysBetween(to): string; default: not declared - isBusinessDay: (date: string) => boolean; default: not declared - isBusinessDay(date): string; default: not declared - isHalfDay: (date: string) => boolean; default: not declared - isHalfDay(date): string; default: not declared - isHoliday: (date: string) => boolean; default: not declared - isHoliday(date): string; default: not declared - name: string; default: not declared - nextBusinessDay: (date: string) => string; default: not declared - nextBusinessDay(date): string; default: not declared - previousBusinessDay: (date: string) => string; default: not declared - previousBusinessDay(date): string; default: not declared - session: (date: string) => DaySession; default: not declared - session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session().return.date: string; default: not declared - session().return.isBusinessDay: boolean; default: not declared - session().return.isHalfDay: boolean; default: not declared - session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session(date): string; default: not declared - timezone: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/core#wrongShapeError Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a "this object isn't the expected shape" error that echoes the keys the caller DID pass. The received-keys echo turns the error into documentation of the expected shape — a reasonable wrong guess (`{ putLongStrike: … }`) is answered with the real slot names rather than a raw `TypeError`. ```typescript export declare function wrongShapeError(functionName: string, expected: string, received: unknown): InputError; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (expected): string; default: not declared - (functionName): string; default: not declared - (received): unknown; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. ### @insiderfinance/totalfinance/core#yearFraction Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Year fraction between two dates under a day-count convention. - `ACT/365F` and `ACT/360` use actual elapsed days. - `30/360` uses the US (NASD) bond-basis adjustment on calendar components. ```typescript export declare function yearFraction(from: string | EpochMs, to: string | EpochMs, dayCount?: DayCount): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (dayCount)?: DayCount; default: not declared - (from): string | number; default: not declared - (to): string | number; default: not declared ### @insiderfinance/totalfinance/core#ymd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compose an ISO date from components. ```typescript export declare function ymd(year: number, month: number, day: number): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (day): number; default: not declared - (month): number; default: not declared - (year): number; default: not declared ## Entrypoint @insiderfinance/totalfinance/core/artifacts ### @insiderfinance/totalfinance/core/artifacts#ANALYSIS_ARTIFACT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ANALYSIS_ARTIFACT_KIND: 'totalfinance.analysis-artifact'; ``` ### @insiderfinance/totalfinance/core/artifacts#ANALYSIS_ARTIFACT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Current artifact schema version — same bump-with-migration policy as the market snapshot. ```typescript export declare const ANALYSIS_ARTIFACT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/core/artifacts#ARTIFACT_WORK_LIMITS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9's bounded-work table: what a caller may lower, and the hard maxima never passed. ```typescript export declare const ARTIFACT_WORK_LIMITS: Readonly<{ maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; gridPoints: Readonly<{ default: 256; maximum: 4096; }>; restarts: Readonly<{ maximum: 64; }>; holdoutEvaluations: Readonly<{ maximum: 100000; }>; listedIds: Readonly<{ default: 200; maximum: 10000; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; default: not declared - embeddedRowLimit.default: 5000; default: not declared - embeddedRowLimit.maximum: 50000; default: not declared - gridPoints: Readonly<{ default: 256; maximum: 4096; }>; default: not declared - gridPoints.default: 256; default: not declared - gridPoints.maximum: 4096; default: not declared - holdoutEvaluations: Readonly<{ maximum: 100000; }>; default: not declared - holdoutEvaluations.maximum: 100000; default: not declared - listedIds: Readonly<{ default: 200; maximum: 10000; }>; default: not declared - listedIds.default: 200; default: not declared - listedIds.maximum: 10000; default: not declared - maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; default: not declared - maximumDifferences.default: 1000; default: not declared - maximumDifferences.maximum: 100000; default: not declared - maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; default: not declared - maximumEmbeddedBytes.default: 1048576; default: not declared - maximumEmbeddedBytes.maximum: 8388608; default: not declared - maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; default: not declared - maximumLeaves.default: 2000000; default: not declared - maximumLeaves.maximum: 2000000; default: not declared - restarts: Readonly<{ maximum: 64; }>; default: not declared - restarts.maximum: 64; default: not declared ### @insiderfinance/totalfinance/core/artifacts#AnalysisArtifact Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AnalysisArtifact { kind: typeof ANALYSIS_ARTIFACT_KIND; schemaVersion: number; /** Content hash of the body (everything but `id` and `provenance`) — stamped at creation. */ id: string; /** Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. */ artifactType: string; producedBy: ArtifactProducedBy; /** * The library conventions revision the artifact was CREATED under — stamped from core's * `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and * never caller-set. Covered by the id; validated as a non-empty string on read. */ conventionsVersion: string; inputs: ArtifactInputs; /** Parent artifact ids this one was derived from, oldest first. */ createdFrom?: string[]; /** The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. */ result: Record; /** Named large-table references — rows live where storage puts them, identity lives here. */ tables?: Record; /** Data lineage, caller-supplied, outside the id (labels are not identity). */ provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - inputs: ArtifactInputs; default: not declared - inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - kind: 'totalfinance.analysis-artifact'; default: not declared - producedBy: ArtifactProducedBy; default: not declared - producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - schemaVersion: number; default: not declared - tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ### @insiderfinance/totalfinance/core/artifacts#AppliedMigration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One applied step, echoed by the readers so an upgrade is never invisible. ```typescript /** One applied step, echoed by the readers so an upgrade is never invisible. */ export interface AppliedMigration { kind: string; fromVersion: number; toVersion: number; description: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - description: string; default: not declared - fromVersion: number; default: not declared - kind: string; default: not declared - toVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#ArtifactComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ArtifactComparison { artifactType: string; /** Same content-hash id — the two artifacts are one artifact. */ identical: boolean; artifactIds: { baseline: string; candidate: string; }; inputs: { sameInputsHash: boolean; /** `null` when either side carries no snapshot hash. */ sameSnapshotHash: boolean | null; parameterDifferences: ValueDifference[]; }; producedBy: { sameOperation: boolean; libraryVersions: { baseline: string | null; candidate: string | null; }; conventionsVersions: { baseline: string; candidate: string; }; }; result: { differences: ValueDifference[]; /** Paths present in the candidate only (keys or trailing array indices). */ addedPaths: string[]; /** Paths present in the baseline only. */ removedPaths: string[]; comparedLeafCount: number; /** `true` when more differences existed than `maximumDifferences` retained — never silent. */ truncated: boolean; /** Every difference found, retained or not. */ differenceCount: number; }; warningCounts: { baseline: number; candidate: number; }; /** Under an explicit tolerance: every result difference within it, no paths added or removed, nothing truncated; `null` without one. */ withinTolerance: boolean | null; assumptions: { conventionsVersion: string; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; }; comparison: string; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactIds: { baseline: string; candidate: string; }; default: not declared - artifactIds.baseline: string; default: not declared - artifactIds.candidate: string; default: not declared - artifactType: string; default: not declared - assumptions: { comparison: string; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; tolerance: ComparisonTolerance | null; }; default: not declared - assumptions.comparison: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - assumptions.tolerance: ComparisonTolerance | null; default: not declared - assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - identical: boolean; default: not declared — Same content-hash id — the two artifacts are one artifact. - inputs: { parameterDifferences: ValueDifference[]; sameInputsHash: boolean; sameSnapshotHash: boolean | null; }; default: not declared - inputs.parameterDifferences: ValueDifference[]; default: not declared - inputs.sameInputsHash: boolean; default: not declared - inputs.sameSnapshotHash: boolean | null; default: not declared — `null` when either side carries no snapshot hash. - producedBy: { conventionsVersions: { baseline: string; candidate: string; }; libraryVersions: { baseline: string | null; candidate: string | null; }; sameOperation: boolean; }; default: not declared - producedBy.conventionsVersions: { baseline: string; candidate: string; }; default: not declared - producedBy.conventionsVersions.baseline: string; default: not declared - producedBy.conventionsVersions.candidate: string; default: not declared - producedBy.libraryVersions: { baseline: string | null; candidate: string | null; }; default: not declared - producedBy.libraryVersions.baseline: string | null; default: not declared - producedBy.libraryVersions.candidate: string | null; default: not declared - producedBy.sameOperation: boolean; default: not declared - result: { addedPaths: string[]; comparedLeafCount: number; differenceCount: number; differences: ValueDifference[]; removedPaths: string[]; truncated: boolean; }; default: not declared - result.addedPaths: string[]; default: not declared — Paths present in the candidate only (keys or trailing array indices). - result.comparedLeafCount: number; default: not declared - result.differenceCount: number; default: not declared — Every difference found, retained or not. - result.differences: ValueDifference[]; default: not declared - result.removedPaths: string[]; default: not declared — Paths present in the baseline only. - result.truncated: boolean; default: not declared — `true` when more differences existed than `maximumDifferences` retained — never silent. - warningCounts: { baseline: number; candidate: number; }; default: not declared - warningCounts.baseline: number; default: not declared - warningCounts.candidate: number; default: not declared - withinTolerance: boolean | null; default: not declared — Under an explicit tolerance: every result difference within it, no paths added or removed, nothing truncated; `null` without one. ### @insiderfinance/totalfinance/core/artifacts#ArtifactInputs Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input identity for replay: hashes for bulk, embedded values only for small parameters. ```typescript /** Input identity for replay: hashes for bulk, embedded values only for small parameters. */ export interface ArtifactInputs { /** * Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, * and RECOMPUTED from the stored fields on every validation pass (create and read), so a * tampered hash or tampered inputs are refused even when the outer id was re-minted to match. */ inputsHash: string; /** `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. */ snapshotHash?: string; /** The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. */ parameters?: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. ### @insiderfinance/totalfinance/core/artifacts#ArtifactMigration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One explicit schema-upgrade step for one envelope kind. ```typescript /** One explicit schema-upgrade step for one envelope kind. */ export interface ArtifactMigration { /** The envelope `kind` this step migrates, e.g. `'totalfinance.market-snapshot'`. */ kind: string; /** The stored version this step reads. */ fromVersion: number; /** Always `fromVersion + 1` — chains are single steps, applied in order, each one reviewable. */ toVersion: number; /** Why the schema changed — reported to the caller with every application. */ description: string; /** * Pure shape-to-shape upgrade. Receives the whole envelope at `fromVersion`; returns the whole * envelope at `toVersion` (including the bumped `schemaVersion` field). Must not fetch, read * the clock, or mutate its input. */ migrate: (envelope: Record) => Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - description: string; default: not declared — Why the schema changed — reported to the caller with every application. - fromVersion: number; default: not declared — The stored version this step reads. - kind: string; default: not declared — The envelope `kind` this step migrates, e.g. `'totalfinance.market-snapshot'`. - migrate: (envelope: Record) => Record; default: not declared — Pure shape-to-shape upgrade. Receives the whole envelope at `fromVersion`; returns the whole envelope at `toVersion` (including the bumped `schemaVersion` field). Must not fetch, read the clock, or mutate its input. - migrate(envelope): Record; default: not declared - toVersion: number; default: not declared — Always `fromVersion + 1` — chains are single steps, applied in order, each one reviewable. ### @insiderfinance/totalfinance/core/artifacts#ArtifactMigrationRegistry Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ArtifactMigrationRegistry { /** Register one step. A second registration for the same `(kind, fromVersion)` is refused. */ register: (migration: ArtifactMigration) => void; /** The registered step out of `(kind, fromVersion)`, if any. */ find: (kind: string, fromVersion: number) => ArtifactMigration | undefined; /** * Apply registered steps until `targetVersion`, reporting each. Refuses (rather than skips) the * first missing link — a partial upgrade is a corrupt envelope with a plausible version number. */ upgrade: (input: { envelope: Record; targetVersion: number; }) => { envelope: Record; migrationsApplied: AppliedMigration[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - find: (kind: string, fromVersion: number) => ArtifactMigration | undefined; default: not declared — The registered step out of `(kind, fromVersion)`, if any. - find().return.description: string; default: not declared — Why the schema changed — reported to the caller with every application. - find().return.fromVersion: number; default: not declared — The stored version this step reads. - find().return.kind: string; default: not declared — The envelope `kind` this step migrates, e.g. `'totalfinance.market-snapshot'`. - find().return.migrate: (envelope: Record) => Record; default: not declared — Pure shape-to-shape upgrade. Receives the whole envelope at `fromVersion`; returns the whole envelope at `toVersion` (including the bumped `schemaVersion` field). Must not fetch, read the clock, or mutate its input. - find().return.toVersion: number; default: not declared — Always `fromVersion + 1` — chains are single steps, applied in order, each one reviewable. - find(fromVersion): number; default: not declared - find(kind): string; default: not declared - register: (migration: ArtifactMigration) => void; default: not declared — Register one step. A second registration for the same `(kind, fromVersion)` is refused. - register(migration): ArtifactMigration; default: not declared - register(migration).description: string; default: not declared — Why the schema changed — reported to the caller with every application. - register(migration).fromVersion: number; default: not declared — The stored version this step reads. - register(migration).kind: string; default: not declared — The envelope `kind` this step migrates, e.g. `'totalfinance.market-snapshot'`. - register(migration).migrate: (envelope: Record) => Record; default: not declared — Pure shape-to-shape upgrade. Receives the whole envelope at `fromVersion`; returns the whole envelope at `toVersion` (including the bumped `schemaVersion` field). Must not fetch, read the clock, or mutate its input. - register(migration).toVersion: number; default: not declared — Always `fromVersion + 1` — chains are single steps, applied in order, each one reviewable. - upgrade: (input: { envelope: Record; targetVersion: number; }) => { envelope: Record; migrationsApplied: AppliedMigration[]; }; default: not declared — Apply registered steps until `targetVersion`, reporting each. Refuses (rather than skips) the first missing link — a partial upgrade is a corrupt envelope with a plausible version number. - upgrade().return.envelope: Record; default: not declared - upgrade().return.migrationsApplied: AppliedMigration[]; default: not declared - upgrade(input): { envelope: Record; targetVersion: number; }; default: not declared - upgrade(input).envelope: Record; default: not declared - upgrade(input).targetVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#ArtifactProducedBy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What produced the result — the call a replay re-issues. ```typescript /** What produced the result — the call a replay re-issues. */ export interface ArtifactProducedBy { /** The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. */ operation: string; /** The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). */ libraryVersion?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. ### @insiderfinance/totalfinance/core/artifacts#ArtifactReplayParity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ArtifactReplayParity { identical: boolean; savedHash: string; recomputedHash: string; differences: ValueDifference[]; addedPaths: string[]; removedPaths: string[]; comparedLeafCount: number; truncated: boolean; differenceCount: number; assumptions: { conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; comparison: 'canonical JSON bytes'; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addedPaths: string[]; default: not declared - assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - assumptions.comparison: 'canonical JSON bytes'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - comparedLeafCount: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - differenceCount: number; default: not declared - differences: ValueDifference[]; default: not declared - identical: boolean; default: not declared - recomputedHash: string; default: not declared - removedPaths: string[]; default: not declared - savedHash: string; default: not declared - truncated: boolean; default: not declared ### @insiderfinance/totalfinance/core/artifacts#CANONICAL_DATA_MAX_DEPTH Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The default nesting limit: deeper stored data is refused as a structural hazard. ```typescript export declare const CANONICAL_DATA_MAX_DEPTH: 64; ``` ### @insiderfinance/totalfinance/core/artifacts#CANONICAL_JSON_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The canonicalization rules above, as a versioned public fact. ```typescript export declare const CANONICAL_JSON_VERSION: 1; ``` ### @insiderfinance/totalfinance/core/artifacts#COMPARISON_LIMITS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const COMPARISON_LIMITS: Readonly<{ maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; default: not declared - maximumDifferences.default: 1000; default: not declared - maximumDifferences.maximum: 100000; default: not declared - maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; default: not declared - maximumLeaves.default: 2000000; default: not declared - maximumLeaves.maximum: 2000000; default: not declared ### @insiderfinance/totalfinance/core/artifacts#CONTENT_HASH_PREFIX Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The hash-string grammar: algorithm prefix + lowercase hex digest. ```typescript export declare const CONTENT_HASH_PREFIX: 'sha256:'; ``` ### @insiderfinance/totalfinance/core/artifacts#CalculationArtifactComparison Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalculationArtifactComparison = { /** Match covers declared metrics under the operation policy and matching inputs/assumptions, not universal equivalence. Source failures always mean insufficient evidence. */ status: 'match' | 'mismatch' | 'not-comparable' | 'insufficient-evidence'; reasons: CalculationComparisonReason[]; artifactIds: { baseline: string; candidate: string; }; metrics: CalculationMetricComparison[]; /** Numeric agreement alone does not certify matching economics. */ numericAgreement: boolean | null; context: { inputs: 'same' | 'different' | 'unrecorded'; /** Exact comparisons, never tolerance-smoothed. These expose model/day-count/source/etc. paths. */ parameterComparison: ArtifactReplayParity; assumptionComparison: ArtifactReplayParity; sameSnapshotHash: boolean | null; sameConventionsVersion: boolean; sameOperation: boolean; operations: { baseline: string; candidate: string; }; sourceDiagnostics: { baseline: CalculationSourceDiagnostics; candidate: CalculationSourceDiagnostics; }; libraryVersions: { baseline: string | null; candidate: string | null; }; }; assumptions: { conventionsVersion: string; scope: string; units: string; comparison: string; operationPolicy: CalculationOperationPolicy; limits: { maximumMetrics: number; maximumPathComponents: number; maximumLeaves: number; maximumDifferences: number; }; }; diagnostics: { warnings: QuantWarning[]; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactIds: { baseline: string; candidate: string; }; default: not declared - artifactIds.baseline: string; default: not declared - artifactIds.candidate: string; default: not declared - assumptions: { comparison: string; conventionsVersion: string; limits: { maximumMetrics: number; maximumPathComponents: number; maximumLeaves: number; maximumDifferences: number; }; operationPolicy: CalculationOperationPolicy; scope: string; units: string; }; default: not declared - assumptions.comparison: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.limits: { maximumDifferences: number; maximumLeaves: number; maximumMetrics: number; maximumPathComponents: number; }; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - assumptions.limits.maximumMetrics: number; default: not declared - assumptions.limits.maximumPathComponents: number; default: not declared - assumptions.operationPolicy: CalculationOperationPolicy; default: not declared - assumptions.scope: string; default: not declared - assumptions.units: string; default: not declared - context: { assumptionComparison: ArtifactReplayParity; inputs: 'same' | 'different' | 'unrecorded'; libraryVersions: { baseline: string | null; candidate: string | null; }; operations: { baseline: string; candidate: string; }; parameterComparison: ArtifactReplayParity; sameConventionsVersion: boolean; sameOperation: boolean; sameSnapshotHash: boolean | null; sourceDiagnostics: { baseline: CalculationSourceDiagnostics; candidate: CalculationSourceDiagnostics; }; }; default: not declared - context.assumptionComparison: ArtifactReplayParity; default: not declared - context.assumptionComparison.addedPaths: string[]; default: not declared - context.assumptionComparison.assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - context.assumptionComparison.assumptions.comparison: 'canonical JSON bytes'; default: not declared - context.assumptionComparison.assumptions.conventionsVersion: string; default: not declared - context.assumptionComparison.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - context.assumptionComparison.assumptions.limits.maximumDifferences: number; default: not declared - context.assumptionComparison.assumptions.limits.maximumLeaves: number; default: not declared - context.assumptionComparison.comparedLeafCount: number; default: not declared - context.assumptionComparison.diagnostics: { warnings: QuantWarning[]; }; default: not declared - context.assumptionComparison.diagnostics.warnings: QuantWarning[]; default: not declared - context.assumptionComparison.differenceCount: number; default: not declared - context.assumptionComparison.differences: import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]; default: not declared - context.assumptionComparison.identical: boolean; default: not declared - context.assumptionComparison.recomputedHash: string; default: not declared - context.assumptionComparison.removedPaths: string[]; default: not declared - context.assumptionComparison.savedHash: string; default: not declared - context.assumptionComparison.truncated: boolean; default: not declared - context.inputs: 'same' | 'different' | 'unrecorded'; default: not declared - context.libraryVersions: { baseline: string | null; candidate: string | null; }; default: not declared - context.libraryVersions.baseline: string | null; default: not declared - context.libraryVersions.candidate: string | null; default: not declared - context.operations: { baseline: string; candidate: string; }; default: not declared - context.operations.baseline: string; default: not declared - context.operations.candidate: string; default: not declared - context.parameterComparison: ArtifactReplayParity; default: not declared — Exact comparisons, never tolerance-smoothed. These expose model/day-count/source/etc. paths. - context.parameterComparison.addedPaths: string[]; default: not declared - context.parameterComparison.assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - context.parameterComparison.assumptions.comparison: 'canonical JSON bytes'; default: not declared - context.parameterComparison.assumptions.conventionsVersion: string; default: not declared - context.parameterComparison.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - context.parameterComparison.assumptions.limits.maximumDifferences: number; default: not declared - context.parameterComparison.assumptions.limits.maximumLeaves: number; default: not declared - context.parameterComparison.comparedLeafCount: number; default: not declared - context.parameterComparison.diagnostics: { warnings: QuantWarning[]; }; default: not declared - context.parameterComparison.diagnostics.warnings: QuantWarning[]; default: not declared - context.parameterComparison.differenceCount: number; default: not declared - context.parameterComparison.differences: import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]; default: not declared - context.parameterComparison.identical: boolean; default: not declared - context.parameterComparison.recomputedHash: string; default: not declared - context.parameterComparison.removedPaths: string[]; default: not declared - context.parameterComparison.savedHash: string; default: not declared - context.parameterComparison.truncated: boolean; default: not declared - context.sameConventionsVersion: boolean; default: not declared - context.sameOperation: boolean; default: not declared - context.sameSnapshotHash: boolean | null; default: not declared - context.sourceDiagnostics: { baseline: CalculationSourceDiagnostics; candidate: CalculationSourceDiagnostics; }; default: not declared - context.sourceDiagnostics.baseline: CalculationSourceDiagnostics; default: not declared - context.sourceDiagnostics.baseline.converged?: boolean; default: not declared - context.sourceDiagnostics.baseline.warnings: QuantWarning[]; default: not declared - context.sourceDiagnostics.candidate: CalculationSourceDiagnostics; default: not declared - context.sourceDiagnostics.candidate.converged?: boolean; default: not declared - context.sourceDiagnostics.candidate.warnings: QuantWarning[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - metrics: CalculationMetricComparison[]; default: not declared - numericAgreement: boolean | null; default: not declared — Numeric agreement alone does not certify matching economics. - reasons: CalculationComparisonReason[]; default: not declared - status: 'match' | 'mismatch' | 'not-comparable' | 'insufficient-evidence'; default: not declared — Match covers declared metrics under the operation policy and matching inputs/assumptions, not universal equivalence. Source failures always mean insufficient evidence. ### @insiderfinance/totalfinance/core/artifacts#CalculationComparisonReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalculationComparisonReason = 'different-inputs' | 'unrecorded-inputs' | 'different-assumptions' | 'unrecorded-assumptions' | 'different-conventions' | 'different-operations' | 'source-failure' | 'different-units' | 'unavailable-metric' | 'metric-outside-tolerance' | 'truncated-context'; ``` ### @insiderfinance/totalfinance/core/artifacts#CalculationMetric Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The same economic metric mapped explicitly across two (possibly different) result schemas. ```typescript /** The same economic metric mapped explicitly across two (possibly different) result schemas. */ export interface CalculationMetric { name: string; baseline: CalculationMetricSelector; candidate: CalculationMetricSelector; /** Both absolute (in the declared unit) and relative (decimal fraction) are required. */ tolerance: ComparisonTolerance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseline: CalculationMetricSelector; default: not declared - baseline.path: readonly (string | number)[]; default: not declared - baseline.unit: string; default: not declared — Exact caller-declared unit/basis, e.g. `USD/share` or `delta/share`. Never inferred or converted. - candidate: CalculationMetricSelector; default: not declared - candidate.path: readonly (string | number)[]; default: not declared - candidate.unit: string; default: not declared — Exact caller-declared unit/basis, e.g. `USD/share` or `delta/share`. Never inferred or converted. - name: string; default: not declared - tolerance: ComparisonTolerance; default: not declared — Both absolute (in the declared unit) and relative (decimal fraction) are required. - tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. ### @insiderfinance/totalfinance/core/artifacts#CalculationMetricComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CalculationMetricComparison { name: string; baseline: CalculationMetricObservation; candidate: CalculationMetricObservation; tolerance: ComparisonTolerance; sameUnit: boolean; /** Signed candidate minus baseline; null when units differ, unavailable, or not representable. */ absoluteDelta: number | null; /** Signed change over |baseline|; null at a zero baseline or when unrepresentable/unavailable. */ relativeDelta: number | null; /** Null when either value is unavailable or the declared units differ. */ withinTolerance: boolean | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared — Signed candidate minus baseline; null when units differ, unavailable, or not representable. - baseline: CalculationMetricObservation; default: not declared - baseline.path: readonly (string | number)[]; default: not declared - baseline.unavailableReason: CalculationMetricUnavailableReason | null; default: not declared - baseline.unit: string; default: not declared - baseline.value: number | null; default: not declared - candidate: CalculationMetricObservation; default: not declared - candidate.path: readonly (string | number)[]; default: not declared - candidate.unavailableReason: CalculationMetricUnavailableReason | null; default: not declared - candidate.unit: string; default: not declared - candidate.value: number | null; default: not declared - name: string; default: not declared - relativeDelta: number | null; default: not declared — Signed change over |baseline|; null at a zero baseline or when unrepresentable/unavailable. - sameUnit: boolean; default: not declared - tolerance: ComparisonTolerance; default: not declared - tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - withinTolerance: boolean | null; default: not declared — Null when either value is unavailable or the declared units differ. ### @insiderfinance/totalfinance/core/artifacts#CalculationMetricObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CalculationMetricObservation { path: readonly (string | number)[]; unit: string; value: number | null; unavailableReason: CalculationMetricUnavailableReason | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - path: readonly (string | number)[]; default: not declared - unavailableReason: CalculationMetricUnavailableReason | null; default: not declared - unit: string; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/core/artifacts#CalculationMetricSelector Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Own-property path relative to an artifact's `result`; components avoid ambiguous dotted keys. ```typescript /** Own-property path relative to an artifact's `result`; components avoid ambiguous dotted keys. */ export interface CalculationMetricSelector { path: readonly (string | number)[]; /** Exact caller-declared unit/basis, e.g. `USD/share` or `delta/share`. Never inferred or converted. */ unit: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - path: readonly (string | number)[]; default: not declared - unit: string; default: not declared — Exact caller-declared unit/basis, e.g. `USD/share` or `delta/share`. Never inferred or converted. ### @insiderfinance/totalfinance/core/artifacts#CalculationMetricUnavailableReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalculationMetricUnavailableReason = 'missing' | 'null' | 'non-numeric' | 'non-finite'; ``` ### @insiderfinance/totalfinance/core/artifacts#CalculationOperationPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalculationOperationPolicy = 'require-same' | 'compare-declared-metrics'; ``` ### @insiderfinance/totalfinance/core/artifacts#CalculationSourceDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Preserved source diagnostics: consumed fields are validated; harmless metadata remains intact. ```typescript /** Preserved source diagnostics: consumed fields are validated; harmless metadata remains intact. */ export interface CalculationSourceDiagnostics { warnings: QuantWarning[]; converged?: boolean; [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged?: boolean; default: not declared - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/core/artifacts#CanonicalDataScanOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CanonicalDataScanOptions { /** The public function whose input is being scanned — every refusal names it. */ readonly functionName: string; /** The root path label in refusals (`'input.market'`, `'artifact.result'`, …). */ readonly label: string; /** Container nesting limit; default {@link CANONICAL_DATA_MAX_DEPTH}. */ readonly maximumDepth?: number; /** Stop-at-limit budget in work units; omitted means unbounded (the caller has already bounded). */ readonly maximumWorkUnits?: number; /** Symbol keys the caller owns and deliberately excludes from the data law (private bindings). */ readonly ignoredSymbols?: ReadonlySet; /** Refuse NaN / ±Infinity as data (successful envelopes) instead of admitting them as leaves. */ readonly requireFiniteNumbers?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - functionName: string; default: not declared — The public function whose input is being scanned — every refusal names it. - ignoredSymbols?: ReadonlySet; default: not declared — Symbol keys the caller owns and deliberately excludes from the data law (private bindings). - label: string; default: not declared — The root path label in refusals (`'input.market'`, `'artifact.result'`, …). - maximumDepth?: number; default: not declared — Container nesting limit; default {@link CANONICAL_DATA_MAX_DEPTH}. - maximumWorkUnits?: number; default: not declared — Stop-at-limit budget in work units; omitted means unbounded (the caller has already bounded). - requireFiniteNumbers?: boolean; default: not declared — Refuse NaN / ±Infinity as data (successful envelopes) instead of admitting them as leaves. ### @insiderfinance/totalfinance/core/artifacts#CompareCalculationArtifactsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CompareCalculationArtifactsInput { baseline: AnalysisArtifact; candidate: AnalysisArtifact; /** At least one metric; at most 1,000. No implicit single dollar tolerance applied to Greeks. */ metrics: readonly CalculationMetric[]; /** Require identical operation names by default; cross-operation metric comparison is explicit. */ operationPolicy?: CalculationOperationPolicy; /** maximumLeaves also bounds the combined control data (metrics, paths, units, policy and limits). */ limits?: ComparisonLimits; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseline: AnalysisArtifact; default: not declared - baseline.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - baseline.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - baseline.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - baseline.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - baseline.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - baseline.inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - baseline.inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - baseline.inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - baseline.kind: 'totalfinance.analysis-artifact'; default: not declared - baseline.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - baseline.producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - baseline.producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - baseline.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - baseline.provenance.asOf?: number; default: not declared - baseline.provenance.dataset?: string; default: not declared - baseline.provenance.provider?: string; default: not declared - baseline.provenance.receivedAt?: number; default: not declared - baseline.provenance.requestId?: string; default: not declared - baseline.provenance.sourceVersion?: string; default: not declared - baseline.provenance.warnings?: QuantWarning[]; default: not declared - baseline.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - baseline.schemaVersion: number; default: not declared - baseline.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - candidate: AnalysisArtifact; default: not declared - candidate.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - candidate.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - candidate.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - candidate.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - candidate.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - candidate.inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - candidate.inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - candidate.inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - candidate.kind: 'totalfinance.analysis-artifact'; default: not declared - candidate.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - candidate.producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - candidate.producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - candidate.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - candidate.provenance.asOf?: number; default: not declared - candidate.provenance.dataset?: string; default: not declared - candidate.provenance.provider?: string; default: not declared - candidate.provenance.receivedAt?: number; default: not declared - candidate.provenance.requestId?: string; default: not declared - candidate.provenance.sourceVersion?: string; default: not declared - candidate.provenance.warnings?: QuantWarning[]; default: not declared - candidate.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - candidate.schemaVersion: number; default: not declared - candidate.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - limits?: ComparisonLimits; default: not declared — maximumLeaves also bounds the combined control data (metrics, paths, units, policy and limits). - limits.maximumDifferences?: number; default: not declared — Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted. - limits.maximumLeaves?: number; default: not declared — Canonical work units each side may cost before the comparison refuses (default and maximum 2,000,000). A leaf costs one unit, so this bounds the leaves walked from above. - metrics: readonly CalculationMetric[]; default: not declared — At least one metric; at most 1,000. No implicit single dollar tolerance applied to Greeks. - operationPolicy?: CalculationOperationPolicy; default: not declared — Require identical operation names by default; cross-operation metric comparison is explicit. ### @insiderfinance/totalfinance/core/artifacts#ComparisonLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Work caps for one comparison or parity check. Defaults and hard maxima are Decision 9's. ```typescript /** Work caps for one comparison or parity check. Defaults and hard maxima are Decision 9's. */ export interface ComparisonLimits { /** Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted. */ maximumDifferences?: number; /** * Canonical work units each side may cost before the comparison refuses (default and maximum * 2,000,000). A leaf costs one unit, so this bounds the leaves walked from above. */ maximumLeaves?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumDifferences?: number; default: not declared — Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted. - maximumLeaves?: number; default: not declared — Canonical work units each side may cost before the comparison refuses (default and maximum 2,000,000). A leaf costs one unit, so this bounds the leaves walked from above. ### @insiderfinance/totalfinance/core/artifacts#ComparisonTolerance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A two-sided tolerance: `|Δ| ≤ absolute + relative · |baseline|`, evaluated exactly on the supplied IEEE values. ```typescript /** A two-sided tolerance: `|Δ| ≤ absolute + relative · |baseline|`, evaluated exactly on the supplied IEEE values. */ export interface ComparisonTolerance { /** Absolute tolerance in the leaf's own unit; `≥ 0`, finite. */ absolute: number; /** Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. */ relative: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. ### @insiderfinance/totalfinance/core/artifacts#CreateMarketSnapshotInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link createMarketSnapshot}. ```typescript /** Input for {@link createMarketSnapshot}. */ export interface CreateMarketSnapshotInput { /** * Epoch ms or a zoned ISO datetime (stamped `asOfConvention: 'explicit-instant'`), or a bare * `'YYYY-MM-DD'` for a date-granular ledger snapshot (calendar date D at 00:00 UTC, stamped * `'date-midnight-utc'`). Option-pricing consumers refuse the date form with the fix. */ asOf: EpochMs | string; conventions?: CreateMarketSnapshotInputConventions; observations: MarketSnapshotObservations; /** Where the observations came from — supplied by the caller, never fetched (law #7). */ provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Epoch ms or a zoned ISO datetime (stamped `asOfConvention: 'explicit-instant'`), or a bare `'YYYY-MM-DD'` for a date-granular ledger snapshot (calendar date D at 00:00 UTC, stamped `'date-midnight-utc'`). Option-pricing consumers refuse the date form with the fix. - conventions?: CreateMarketSnapshotInputConventions; default: not declared - conventions.calendar?: string; default: not declared - conventions.compounding?: InterestCompounding; default: not declared - conventions.compounding.periodsPerYear: number; default: not declared - conventions.compounding.type: 'periodic'; default: not declared - conventions.dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - observations: MarketSnapshotObservations; default: not declared - observations.chains?: Record; default: not declared - observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - observations.spots?: Record; default: not declared - observations.surfaces?: Record; default: not declared - observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - provenance?: Provenance; default: not declared — Where the observations came from — supplied by the caller, never fetched (law #7). - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/core/artifacts#CreateMarketSnapshotInputConventions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The caller-facing conventions at create time: everything in {@link MarketSnapshotConventions} EXCEPT `conventionsVersion` and `asOfConvention`, which the library stamps. Spelled out rather than `Omit<…>` so the declaration stays walkable by tooling and readable without resolving a mapped type. ```typescript /** * The caller-facing conventions at create time: everything in {@link MarketSnapshotConventions} * EXCEPT `conventionsVersion` and `asOfConvention`, which the library stamps. Spelled out rather than `Omit<…>` so the * declaration stays walkable by tooling and readable without resolving a mapped type. */ export interface CreateMarketSnapshotInputConventions { /** Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. */ dayCount?: DayCount; compounding?: InterestCompounding; calendar?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calendar?: string; default: not declared - compounding?: InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. ### @insiderfinance/totalfinance/core/artifacts#FittedModelObjectiveKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FittedModelObjectiveKind = 'root-mean-square-error' | 'log-likelihood' | 'r-squared' | 'exact-fit' | 'exact-bootstrap' | 'not-applicable'; ``` ### @insiderfinance/totalfinance/core/artifacts#FittedModelResidualSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FittedModelResidualSource = 'reported-by-calibrator' | 'direct-evaluator'; ``` ### @insiderfinance/totalfinance/core/artifacts#FittedModelSummary Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelSummary { /** Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. */ family: string; /** The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. */ modelVersion: number; /** Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). */ parameters: Record; objective: { kind: FittedModelObjectiveKind; value: number | null; /** The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. */ unit: string; /** Required exactly when `value` is null. */ reason?: string; }; convergence: { converged: boolean; iterations: number | null; reason?: string; }; /** Null when the family has no per-point residual (with the reason in `modelRisk.notes`). */ residuals: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; unit: string; source: FittedModelResidualSource; } | null; modelRisk: { /** Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. */ arbitrageFree: boolean | null; /** The coordinate range the fit was calibrated over; evaluation outside it warns. */ calibratedRange: Record; notes: string[]; }; /** The weighting the calibrator applied, when it applied one; null otherwise. */ weighting: string | null; /** Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. */ inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; warningCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - convergence.converged: boolean; default: not declared - convergence.iterations: number | null; default: not declared - convergence.reason?: string; default: not declared - family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - inputIdentity.calibrationHash: string; default: not declared - inputIdentity.snapshotHash: string | null; default: not declared - modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - modelRisk.notes: string[]; default: not declared - modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - objective: { kind: FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - objective.kind: FittedModelObjectiveKind; default: not declared - objective.reason?: string; default: not declared — Required exactly when `value` is null. - objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - objective.value: number | null; default: not declared - parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - residuals.count: number; default: not declared - residuals.maximumAbsolute: number | null; default: not declared - residuals.rootMeanSquare: number | null; default: not declared - residuals.source: FittedModelResidualSource; default: not declared - residuals.unit: string; default: not declared - warningCount: number; default: not declared - weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/core/artifacts#MARKET_SNAPSHOT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const MARKET_SNAPSHOT_KIND: 'totalfinance.market-snapshot'; ``` ### @insiderfinance/totalfinance/core/artifacts#MARKET_SNAPSHOT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Current market-snapshot schema version. Bump ONLY with a shape change, and land the bump with a registered migration — `readMarketSnapshot` refuses an older stored version without one, and refuses a newer version outright (this build cannot know what changed). ```typescript export declare const MARKET_SNAPSHOT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/core/artifacts#MarketSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarketSnapshot { kind: typeof MARKET_SNAPSHOT_KIND; schemaVersion: number; asOf: EpochMs; conventions: MarketSnapshotConventions; observations: MarketSnapshotObservations; provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - conventions: MarketSnapshotConventions; default: not declared - conventions.asOfConvention: MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - conventions.calendar?: string; default: not declared - conventions.compounding?: InterestCompounding; default: not declared - conventions.compounding.periodsPerYear: number; default: not declared - conventions.compounding.type: 'periodic'; default: not declared - conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - conventions.dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - kind: 'totalfinance.market-snapshot'; default: not declared - observations: MarketSnapshotObservations; default: not declared - observations.chains?: Record; default: not declared - observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - observations.spots?: Record; default: not declared - observations.surfaces?: Record; default: not declared - observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#MarketSnapshotAsOfConvention Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a snapshot's `asOf` was expressed at create time (stamped by `createMarketSnapshot`). ```typescript /** How a snapshot's `asOf` was expressed at create time (stamped by `createMarketSnapshot`). */ export type MarketSnapshotAsOfConvention = 'explicit-instant' | 'date-midnight-utc'; ``` ### @insiderfinance/totalfinance/core/artifacts#MarketSnapshotConventions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarketSnapshotConventions { /** The library conventions revision the snapshot was created under; stamped, not caller-set. */ conventionsVersion: string; /** * How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch * ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular * convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular * snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. */ asOfConvention: MarketSnapshotAsOfConvention; /** Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. */ dayCount?: DayCount; compounding?: InterestCompounding; calendar?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOfConvention: MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - calendar?: string; default: not declared - compounding?: InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. ### @insiderfinance/totalfinance/core/artifacts#MarketSnapshotObservations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarketSnapshotObservations { spots?: Record; /** Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. */ riskFreeRates?: Record; /** Flat continuous dividend/borrow yields as decimals, keyed by symbol. */ dividendYields?: Record; /** Flat annualized volatilities as decimals, keyed by symbol. */ volatilities?: Record; /** Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. */ curves?: Record; surfaces?: Record; chains?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - chains?: Record; default: not declared - curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - spots?: Record; default: not declared - surfaces?: Record; default: not declared - volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. ### @insiderfinance/totalfinance/core/artifacts#NonFiniteNumber Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a non-finite number is carried through JSON — one grammar, library-wide. ```typescript /** How a non-finite number is carried through JSON — one grammar, library-wide. */ export interface NonFiniteNumber { nonFinite: 'NaN' | 'Infinity' | '-Infinity'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - nonFinite: 'NaN' | 'Infinity' | '-Infinity'; default: not declared ### @insiderfinance/totalfinance/core/artifacts#OptionChainObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An option-chain observation: EITHER inline rows (small chains) or a {@link TableHandle} reference (large chains stay out of the envelope). Exactly one of the two. Rows are core `OptionQuote`-shaped and validated openly: the numeric fields TotalFinance consumes must be finite numbers when present; vendor decoration is preserved. ```typescript /** * An option-chain observation: EITHER inline rows (small chains) or a {@link TableHandle} * reference (large chains stay out of the envelope). Exactly one of the two. * Rows are core `OptionQuote`-shaped and validated openly: the numeric fields TotalFinance consumes * must be finite numbers when present; vendor decoration is preserved. */ export interface OptionChainObservation { quotes?: Record[]; table?: TableHandle; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - quotes?: Record[]; default: not declared - table?: TableHandle; default: not declared - table.columnCount: number; default: not declared - table.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - table.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - table.kind: 'totalfinance.table-handle'; default: not declared - table.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - table.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - table.rowCount: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#SCENARIO_SET_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const SCENARIO_SET_KIND: 'totalfinance.scenario-set'; ``` ### @insiderfinance/totalfinance/core/artifacts#SCENARIO_SET_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Current scenario-set schema version — same bump-with-migration policy as the other envelopes. ```typescript export declare const SCENARIO_SET_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/core/artifacts#ScenarioDefinition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioDefinition { /** Unique within the set — result cells trace back to scenarios by name. */ name: string; shocks: ScenarioShock[]; overrides?: ScenarioOverride[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared — Unique within the set — result cells trace back to scenarios by name. - overrides?: ScenarioOverride[]; default: not declared - shocks: ScenarioShock[]; default: not declared ### @insiderfinance/totalfinance/core/artifacts#ScenarioFactor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The factor vocabulary shared with `@insiderfinance/totalfinance/risk`'s scenario engine; open for custom labels. ```typescript /** The factor vocabulary shared with `@insiderfinance/totalfinance/risk`'s scenario engine; open for custom labels. */ export type ScenarioFactor = 'spot' | 'volatility' | 'riskFreeRate' | 'time' | 'dividend' | string; ``` ### @insiderfinance/totalfinance/core/artifacts#ScenarioOverride Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An absolute set: the observation for `(factor, target)` BECOMES `value` before shocks apply. ```typescript /** An absolute set: the observation for `(factor, target)` BECOMES `value` before shocks apply. */ export interface ScenarioOverride { factor: ScenarioFactor; value: number; target?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor: string; default: not declared - target?: string; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#ScenarioSet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioSet { kind: typeof SCENARIO_SET_KIND; schemaVersion: number; name: string; scenarios: ScenarioDefinition[]; /** Where the definitions came from (a historical-event library, a desk doc) — caller-supplied. */ provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'totalfinance.scenario-set'; default: not declared - name: string; default: not declared - provenance?: Provenance; default: not declared — Where the definitions came from (a historical-event library, a desk doc) — caller-supplied. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - scenarios: ScenarioDefinition[]; default: not declared - schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#ScenarioShock Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A relative change: `percent` scales the base level; `absolute` adds in the factor's own unit. ```typescript /** A relative change: `percent` scales the base level; `absolute` adds in the factor's own unit. */ export interface ScenarioShock { factor: ScenarioFactor; kind: 'percent' | 'absolute'; value: number; /** Which symbol the shock hits; absent = every target the runner prices with this factor. */ target?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor: string; default: not declared - kind: 'percent' | 'absolute'; default: not declared - target?: string; default: not declared — Which symbol the shock hits; absent = every target the runner prices with this factor. - value: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#SpotObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A spot observation. Open per Law 12: extra vendor fields are preserved, finite, and unread. ```typescript /** A spot observation. Open per Law 12: extra vendor fields are preserved, finite, and unread. */ export interface SpotObservation { /** Observed price in `currency`. Finite; sign unconstrained (negative commodity prints are real). */ price: number; currency?: string; /** When this particular print was observed, if it differs from the snapshot's `asOf`. */ timestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency?: string; default: not declared - price: number; default: not declared — Observed price in `currency`. Finite; sign unconstrained (negative commodity prints are real). - timestampMs?: number; default: not declared — When this particular print was observed, if it differs from the snapshot's `asOf`. ### @insiderfinance/totalfinance/core/artifacts#TABLE_HANDLE_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TABLE_HANDLE_KIND: 'totalfinance.table-handle'; ``` ### @insiderfinance/totalfinance/core/artifacts#TABLE_MEDIA_TYPE_ARROW_RESERVED Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The reserved (unimplemented) Arrow media type — reserved here so no caller invents a second name. ```typescript export declare const TABLE_MEDIA_TYPE_ARROW_RESERVED: 'application/vnd.apache.arrow.file'; ``` ### @insiderfinance/totalfinance/core/artifacts#TableHandle Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TableHandle { kind: typeof TABLE_HANDLE_KIND; /** `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. */ contentHash: string; rowCount: number; columnCount: number; /** Column names, in table order; when present, `columns.length === columnCount`. */ columns?: string[]; /** Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. */ locator?: string; /** Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. */ mediaType?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - columnCount: number; default: not declared - columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - kind: 'totalfinance.table-handle'; default: not declared - locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - rowCount: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#ValueDifference Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One differing leaf between the baseline and the candidate. ```typescript /** One differing leaf between the baseline and the candidate. */ export interface ValueDifference { /** Dot/bracket path from the compared root, e.g. `parameters.rho` or `perSliceRmse[2].rmse`. */ path: string; baselineValue: unknown; candidateValue: unknown; /** `candidate − baseline` for two finite numbers; `null` if unavailable or unrepresentable. */ absoluteDelta: number | null; /** `(candidate − baseline) / |baseline|`; `null` at zero or if unavailable/unrepresentable. */ relativeDelta: number | null; /** Under an explicit tolerance: whether this leaf is within it (non-numeric differences never are); `null` without one. */ withinTolerance: boolean | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared — `candidate − baseline` for two finite numbers; `null` if unavailable or unrepresentable. - baselineValue: unknown; default: not declared - candidateValue: unknown; default: not declared - path: string; default: not declared — Dot/bracket path from the compared root, e.g. `parameters.rho` or `perSliceRmse[2].rmse`. - relativeDelta: number | null; default: not declared — `(candidate − baseline) / |baseline|`; `null` at zero or if unavailable/unrepresentable. - withinTolerance: boolean | null; default: not declared — Under an explicit tolerance: whether this leaf is within it (non-numeric differences never are); `null` without one. ### @insiderfinance/totalfinance/core/artifacts#VolatilitySurfaceObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An implied-volatility surface grid; `impliedVolatilities[i][j]` pairs expiry `i` with strike `j`. ```typescript /** An implied-volatility surface grid; `impliedVolatilities[i][j]` pairs expiry `i` with strike `j`. */ export interface VolatilitySurfaceObservation { timeToExpiryYears: number[]; strikes: number[]; /** Annualized decimal implied volatilities, row per expiry, column per strike. */ impliedVolatilities: number[][]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatilities: number[][]; default: not declared — Annualized decimal implied volatilities, row per expiry, column per strike. - strikes: number[]; default: not declared - timeToExpiryYears: number[]; default: not declared ### @insiderfinance/totalfinance/core/artifacts#WorkLimitLaw Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WorkLimitLaw { default?: number; maximum: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - default?: number; default: not declared - maximum: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#applyReportMigrations Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gate B's migration policy at the REPORT level (Decision 5). The report is presented to the caller's registry through the envelope view `{ kind, schemaVersion: , report }`, so the one registry runs its one policy; the migrated `report` is returned with the target version stamped and every applied step echoed. ```typescript export declare function applyReportMigrations(input: { functionName: string; kind: string; report: Record; storedVersion: unknown; currentVersion: number; versionField: string; migrations?: ArtifactMigrationRegistry; subject: string; }): { report: Record; modelMigrationsApplied: AppliedMigration[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { functionName: string; kind: string; report: Record; storedVersion: unknown; currentVersion: number; versionField: string; migrations?: ArtifactMigrationRegistry; subject: string; }; default: not declared - (input).currentVersion: number; default: not declared - (input).functionName: string; default: not declared - (input).kind: string; default: not declared — The family-scoped kind, e.g. `'volatility.fitted-model:ssvi'` or `'research.run:screen'`. - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).report: Record; default: not declared - (input).storedVersion: unknown; default: not declared - (input).subject: string; default: not declared — What the stored report describes, for the teachings: `'ssvi report'`. - (input).versionField: string; default: not declared — The report's version field name (`'modelVersion'` or `'runVersion'`). - return.modelMigrationsApplied: AppliedMigration[]; default: not declared - return.report: Record; default: not declared ### @insiderfinance/totalfinance/core/artifacts#artifactReplayParity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Byte-exact replay parity between a saved value and its recomputation (Decision 7). ```typescript export declare function artifactReplayParity(input: { saved: Record; recomputed: Record; limits?: ComparisonLimits; }): ArtifactReplayParity; ``` Example (source JSDoc): ```ts const parity = artifactReplayParity({ saved: artifact.result, recomputed: rerun }); parity.identical; // true — or the first differing paths with both values ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { saved: Record; recomputed: Record; limits?: ComparisonLimits; }; default: not declared - (input).limits?: ComparisonLimits; default: not declared - (input).recomputed: Record; default: not declared — The value the producing call returned when re-issued from the stored inputs. - (input).saved: Record; default: not declared — The artifact's stored result (or its verbatim `fit` / `run`) — a plain object, never a bare value. - return.addedPaths: string[]; default: not declared - return.assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - return.assumptions.comparison: 'canonical JSON bytes'; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.comparedLeafCount: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.differenceCount: number; default: not declared - return.differences: ValueDifference[]; default: not declared - return.identical: boolean; default: not declared - return.recomputedHash: string; default: not declared - return.removedPaths: string[]; default: not declared - return.savedHash: string; default: not declared - return.truncated: boolean; default: not declared ### @insiderfinance/totalfinance/core/artifacts#canonicalJsonOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serialize a JSON-safe value to its ONE canonical string. Deterministic: the same logical value — whatever key order, whatever `-0`s — always yields the same bytes, which is what makes `contentHash` an identity rather than a formatting accident. ```typescript export declare function canonicalJsonOf(value: unknown): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#canonicalStringWorkUnits Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The canonical work cost of one string: one unit plus one per 64 characters. ```typescript export declare function canonicalStringWorkUnits(value: string): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): string; default: not declared ### @insiderfinance/totalfinance/core/artifacts#compareAnalysisArtifacts Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare two analysis artifacts of one `artifactType`, leaf by leaf (module header). ```typescript export declare function compareAnalysisArtifacts(input: { baseline: AnalysisArtifact; candidate: AnalysisArtifact; tolerance?: ComparisonTolerance; limits?: ComparisonLimits; }): ArtifactComparison; ``` Example (source JSDoc): ```ts const comparison = compareAnalysisArtifacts({ baseline: yesterdayArtifact, candidate: todayArtifact, tolerance: { absolute: 1e-6, relative: 1e-4 }, }); comparison.result.differences; // [{ path: 'parameters.rho', baselineValue: -0.31, candidateValue: -0.29, … }] ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { baseline: AnalysisArtifact; candidate: AnalysisArtifact; tolerance?: ComparisonTolerance; limits?: ComparisonLimits; }; default: not declared - (input).baseline: AnalysisArtifact; default: not declared - (input).candidate: AnalysisArtifact; default: not declared - (input).limits?: ComparisonLimits; default: not declared - (input).tolerance?: ComparisonTolerance; default: not declared - return.artifactIds: { baseline: string; candidate: string; }; default: not declared - return.artifactIds.baseline: string; default: not declared - return.artifactIds.candidate: string; default: not declared - return.artifactType: string; default: not declared - return.assumptions: { conventionsVersion: string; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; }; comparison: string; }; default: not declared - return.assumptions.comparison: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.assumptions.tolerance: ComparisonTolerance | null; default: not declared - return.assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - return.assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.identical: boolean; default: not declared — Same content-hash id — the two artifacts are one artifact. - return.inputs: { sameInputsHash: boolean; sameSnapshotHash: boolean | null; parameterDifferences: ValueDifference[]; }; default: not declared - return.inputs.parameterDifferences: ValueDifference[]; default: not declared - return.inputs.sameInputsHash: boolean; default: not declared - return.inputs.sameSnapshotHash: boolean | null; default: not declared — `null` when either side carries no snapshot hash. - return.producedBy: { sameOperation: boolean; libraryVersions: { baseline: string | null; candidate: string | null; }; conventionsVersions: { baseline: string; candidate: string; }; }; default: not declared - return.producedBy.conventionsVersions: { baseline: string; candidate: string; }; default: not declared - return.producedBy.conventionsVersions.baseline: string; default: not declared - return.producedBy.conventionsVersions.candidate: string; default: not declared - return.producedBy.libraryVersions: { baseline: string | null; candidate: string | null; }; default: not declared - return.producedBy.libraryVersions.baseline: string | null; default: not declared - return.producedBy.libraryVersions.candidate: string | null; default: not declared - return.producedBy.sameOperation: boolean; default: not declared - return.result: { differences: ValueDifference[]; addedPaths: string[]; removedPaths: string[]; comparedLeafCount: number; truncated: boolean; differenceCount: number; }; default: not declared - return.result.addedPaths: string[]; default: not declared — Paths present in the candidate only (keys or trailing array indices). - return.result.comparedLeafCount: number; default: not declared - return.result.differenceCount: number; default: not declared — Every difference found, retained or not. - return.result.differences: ValueDifference[]; default: not declared - return.result.removedPaths: string[]; default: not declared — Paths present in the baseline only. - return.result.truncated: boolean; default: not declared — `true` when more differences existed than `maximumDifferences` retained — never silent. - return.warningCounts: { baseline: number; candidate: number; }; default: not declared - return.warningCounts.baseline: number; default: not declared - return.warningCounts.candidate: number; default: not declared - return.withinTolerance: boolean | null; default: not declared — Under an explicit tolerance: every result difference within it, no paths added or removed, nothing truncated; `null` without one. ### @insiderfinance/totalfinance/core/artifacts#compareCalculationArtifacts Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare selected financial metrics without confusing numerical closeness with matching economics. Uses existing AnalysisArtifact validation/hashes and exact replay for recorded inputs/assumptions. Different result schemas are supported only through explicit per-side metric paths. No unit conversion, field-name guessing, engine execution, I/O or causal attribution is performed. ```typescript export declare function compareCalculationArtifacts(input: CompareCalculationArtifactsInput): CalculationArtifactComparison; ``` Example (source JSDoc): ```ts const comparison = compareCalculationArtifacts({ baseline, candidate, metrics: [{ name: 'premium', baseline: { path: ['value'], unit: 'USD/share' }, candidate: { path: ['value'], unit: 'USD/share' }, tolerance: { absolute: 0.0001, relative: 0 }, }], }); comparison.status; // 'match', 'mismatch', 'not-comparable', or 'insufficient-evidence' ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CompareCalculationArtifactsInput; default: not declared - (input).baseline: AnalysisArtifact; default: not declared - (input).candidate: AnalysisArtifact; default: not declared - (input).limits?: ComparisonLimits; default: not declared — maximumLeaves also bounds the combined control data (metrics, paths, units, policy and limits). - (input).metrics: readonly CalculationMetric[]; default: not declared — At least one metric; at most 1,000. No implicit single dollar tolerance applied to Greeks. - (input).operationPolicy?: CalculationOperationPolicy; default: not declared — Require identical operation names by default; cross-operation metric comparison is explicit. - return.artifactIds: { baseline: string; candidate: string; }; default: not declared - return.artifactIds.baseline: string; default: not declared - return.artifactIds.candidate: string; default: not declared - return.assumptions: { conventionsVersion: string; scope: string; units: string; comparison: string; operationPolicy: CalculationOperationPolicy; limits: { maximumMetrics: number; maximumPathComponents: number; maximumLeaves: number; maximumDifferences: number; }; }; default: not declared - return.assumptions.comparison: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.limits: { maximumMetrics: number; maximumPathComponents: number; maximumLeaves: number; maximumDifferences: number; }; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.assumptions.limits.maximumMetrics: number; default: not declared - return.assumptions.limits.maximumPathComponents: number; default: not declared - return.assumptions.operationPolicy: CalculationOperationPolicy; default: not declared - return.assumptions.scope: string; default: not declared - return.assumptions.units: string; default: not declared - return.context: { inputs: 'same' | 'different' | 'unrecorded'; parameterComparison: ArtifactReplayParity; assumptionComparison: ArtifactReplayParity; sameSnapshotHash: boolean | null; sameConventionsVersion: boolean; sameOperation: boolean; operations: { baseline: string; candidate: string; }; sourceDiagnostics: { baseline: CalculationSourceDiagnostics; candidate: CalculationSourceDiagnostics; }; libraryVersions: { baseline: string | null; candidate: string | null; }; }; default: not declared - return.context.assumptionComparison: ArtifactReplayParity; default: not declared - return.context.inputs: 'same' | 'different' | 'unrecorded'; default: not declared - return.context.libraryVersions: { baseline: string | null; candidate: string | null; }; default: not declared - return.context.libraryVersions.baseline: string | null; default: not declared - return.context.libraryVersions.candidate: string | null; default: not declared - return.context.operations: { baseline: string; candidate: string; }; default: not declared - return.context.operations.baseline: string; default: not declared - return.context.operations.candidate: string; default: not declared - return.context.parameterComparison: ArtifactReplayParity; default: not declared — Exact comparisons, never tolerance-smoothed. These expose model/day-count/source/etc. paths. - return.context.sameConventionsVersion: boolean; default: not declared - return.context.sameOperation: boolean; default: not declared - return.context.sameSnapshotHash: boolean | null; default: not declared - return.context.sourceDiagnostics: { baseline: CalculationSourceDiagnostics; candidate: CalculationSourceDiagnostics; }; default: not declared - return.context.sourceDiagnostics.baseline: CalculationSourceDiagnostics; default: not declared - return.context.sourceDiagnostics.candidate: CalculationSourceDiagnostics; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.metrics: CalculationMetricComparison[]; default: not declared - return.numericAgreement: boolean | null; default: not declared — Numeric agreement alone does not certify matching economics. - return.reasons: CalculationComparisonReason[]; default: not declared - return.status: 'match' | 'mismatch' | 'not-comparable' | 'insufficient-evidence'; default: not declared — Match covers declared metrics under the operation policy and matching inputs/assumptions, not universal equivalence. Source failures always mean insufficient evidence. ### @insiderfinance/totalfinance/core/artifacts#contentHash Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The spine's content identity: `sha256:` + SHA-256 of the value's canonical JSON. Same logical value → same hash, regardless of key order or `-0`; any covered field change → a different hash. What a given envelope's hash COVERS (and that provenance labels are excluded) is decided by that envelope's own `…ContentHash` function, not here — this is the mechanism, not the policy. ```typescript export declare function contentHash(value: unknown): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#createAnalysisArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Save a computed result as an identified, immutable artifact. ```typescript export declare function createAnalysisArtifact(input: { artifactType: string; producedBy: ArtifactProducedBy; inputs?: { snapshotHash?: string; parameters?: unknown; }; createdFrom?: string[]; result: Record; tables?: Record; provenance?: Provenance; }): AnalysisArtifact; ``` Example (source JSDoc): ```ts import { createAnalysisArtifact, marketSnapshotContentHash } from '@insiderfinance/totalfinance/core/artifacts'; const report = impliedVolatilitySurface({ ... }); // any Law-2 result, verbatim const artifact = createAnalysisArtifact({ artifactType: 'volatility.surface', producedBy: { operation: 'impliedVolatilitySurface', libraryVersion: '0.0.1' }, inputs: { snapshotHash: marketSnapshotContentHash(snapshot), parameters: { model: 'svi' } }, result: report, }); artifact.id; // 'sha256:…' — recomputable from the body forever ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifactType: string; producedBy: ArtifactProducedBy; inputs?: { snapshotHash?: string; parameters?: unknown; }; createdFrom?: string[]; result: Record; tables?: Record; provenance?: Provenance; }; default: not declared - (input).artifactType: string; default: not declared - (input).createdFrom?: string[]; default: not declared - (input).inputs?: { snapshotHash?: string; parameters?: unknown; }; default: not declared - (input).inputs.parameters?: unknown; default: not declared - (input).inputs.snapshotHash?: string; default: not declared - (input).producedBy: ArtifactProducedBy; default: not declared - (input).provenance?: Provenance; default: not declared - (input).result: Record; default: not declared - (input).tables?: Record; default: not declared - return.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - return.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - return.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - return.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - return.inputs: ArtifactInputs; default: not declared - return.kind: 'totalfinance.analysis-artifact'; default: not declared - return.producedBy: ArtifactProducedBy; default: not declared - return.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - return.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - return.schemaVersion: number; default: not declared - return.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ### @insiderfinance/totalfinance/core/artifacts#createArtifactMigrationRegistry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Create an empty, caller-owned migration registry. ```typescript export declare function createArtifactMigrationRegistry(): ArtifactMigrationRegistry; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.find: (kind: string, fromVersion: number) => ArtifactMigration | undefined; default: not declared — The registered step out of `(kind, fromVersion)`, if any. - return.register: (migration: ArtifactMigration) => void; default: not declared — Register one step. A second registration for the same `(kind, fromVersion)` is refused. - return.upgrade: (input: { envelope: Record; targetVersion: number; }) => { envelope: Record; migrationsApplied: AppliedMigration[]; }; default: not declared — Apply registered steps until `targetVersion`, reporting each. Refuses (rather than skips) the first missing link — a partial upgrade is a corrupt envelope with a plausible version number. ### @insiderfinance/totalfinance/core/artifacts#createMarketSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build an immutable, versioned market snapshot from caller-supplied observations. ```typescript export declare function createMarketSnapshot(input: CreateMarketSnapshotInput): MarketSnapshot; ``` Example (source JSDoc): ```ts import { createMarketSnapshot, marketSnapshotContentHash } from '@insiderfinance/totalfinance/core/artifacts'; const snapshot = createMarketSnapshot({ asOf: '2026-07-20T10:30:00-04:00', conventions: { dayCount: 'ACT/365F', compounding: 'continuous' }, observations: { spots: { AAPL: { price: 195.3, currency: 'USD' } }, riskFreeRates: { USD: 0.045 }, volatilities: { AAPL: 0.24 }, }, provenance: { provider: 'insiderfinance', dataset: 'eod', asOf: 1784505600000 }, }); const identity = marketSnapshotContentHash(snapshot); // 'sha256:…' ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CreateMarketSnapshotInput; default: not declared - (input).asOf: string | number; default: not declared — Epoch ms or a zoned ISO datetime (stamped `asOfConvention: 'explicit-instant'`), or a bare `'YYYY-MM-DD'` for a date-granular ledger snapshot (calendar date D at 00:00 UTC, stamped `'date-midnight-utc'`). Option-pricing consumers refuse the date form with the fix. - (input).conventions?: CreateMarketSnapshotInputConventions; default: not declared - (input).observations: MarketSnapshotObservations; default: not declared - (input).provenance?: Provenance; default: not declared — Where the observations came from — supplied by the caller, never fetched (law #7). - return.asOf: number; default: not declared - return.conventions: MarketSnapshotConventions; default: not declared - return.kind: 'totalfinance.market-snapshot'; default: not declared - return.observations: MarketSnapshotObservations; default: not declared - return.provenance?: Provenance; default: not declared - return.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#createScenarioSet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build an immutable, serializable scenario set. ```typescript export declare function createScenarioSet(input: { name: string; scenarios: ScenarioDefinition[]; provenance?: Provenance; }): ScenarioSet; ``` Example (source JSDoc): ```ts const stress = createScenarioSet({ name: 'q3-desk-stress', scenarios: [ { name: 'crash -20%', shocks: [{ factor: 'spot', kind: 'percent', value: -0.20 }, { factor: 'volatility', kind: 'absolute', value: 0.15 }] }, { name: 'rates 2019', overrides: [{ factor: 'riskFreeRate', value: 0.0155 }], shocks: [] }, ], }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { name: string; scenarios: ScenarioDefinition[]; provenance?: Provenance; }; default: not declared - (input).name: string; default: not declared - (input).provenance?: Provenance; default: not declared - (input).scenarios: ScenarioDefinition[]; default: not declared - return.kind: 'totalfinance.scenario-set'; default: not declared - return.name: string; default: not declared - return.provenance?: Provenance; default: not declared — Where the definitions came from (a historical-event library, a desk doc) — caller-supplied. - return.scenarios: ScenarioDefinition[]; default: not declared - return.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#createTableHandle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a validated, frozen table handle. ```typescript export declare function createTableHandle(input: { contentHash: string; rowCount: number; columnCount: number; columns?: string[]; locator?: string; mediaType?: string; }): TableHandle; ``` Example (source JSDoc): ```ts const handle = createTableHandle({ contentHash: contentHash(chainRows), rowCount: chainRows.length, columnCount: 8, columns: ['strike', 'expiry', 'bid', 'ask', 'mid', 'volume', 'openInterest', 'impliedVolatility'], locator: 'artifacts/chains/aapl-2026-07-20.json', }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { contentHash: string; rowCount: number; columnCount: number; columns?: string[]; locator?: string; mediaType?: string; }; default: not declared - (input).columnCount: number; default: not declared - (input).columns?: string[]; default: not declared - (input).contentHash: string; default: not declared - (input).locator?: string; default: not declared - (input).mediaType?: string; default: not declared - (input).rowCount: number; default: not declared - return.columnCount: number; default: not declared - return.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - return.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - return.kind: 'totalfinance.table-handle'; default: not declared - return.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - return.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - return.rowCount: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#flattenSummaryParameters Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A validated summary's flat parameter view: arrays become indexed keys (`thetaTerm.theta[2]`). Takes the whole summary (validated here, like every door) rather than a bare record, so the parameters it flattens are the ones `requireFittedModelSummary` admits. ```typescript export declare function flattenSummaryParameters(summary: FittedModelSummary): Record; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (summary): FittedModelSummary; default: not declared - (summary).convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - (summary).convergence.converged: boolean; default: not declared - (summary).convergence.iterations: number | null; default: not declared - (summary).convergence.reason?: string; default: not declared - (summary).family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - (summary).inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - (summary).inputIdentity.calibrationHash: string; default: not declared - (summary).inputIdentity.snapshotHash: string | null; default: not declared - (summary).modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - (summary).modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - (summary).modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - (summary).modelRisk.notes: string[]; default: not declared - (summary).modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - (summary).objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - (summary).objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - (summary).objective.reason?: string; default: not declared — Required exactly when `value` is null. - (summary).objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - (summary).objective.value: number | null; default: not declared - (summary).parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - (summary).residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - (summary).residuals.count: number; default: not declared - (summary).residuals.maximumAbsolute: number | null; default: not declared - (summary).residuals.rootMeanSquare: number | null; default: not declared - (summary).residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - (summary).residuals.unit: string; default: not declared - (summary).warningCount: number; default: not declared - (summary).weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/core/artifacts#fromCanonicalJson Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Parse a canonical (or any) JSON text back to the runtime value, decoding every non-finite wrapper to its number. The inverse of {@link canonicalJsonOf}: `fromCanonicalJson(canonicalJsonOf(x))` deep-equals `x` (with `-0` read back as `0` — the one disclosed loss), and `canonicalJsonOf(fromCanonicalJson(text))` returns `text` unchanged for canonical `text`. ```typescript export declare function fromCanonicalJson(text: string): unknown; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (text): string; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isAnalysisArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sound structural test for a CURRENT-version analysis-artifact envelope: the complete read-door body validation behind a boolean door — closed keys, report shape, re-derived `inputs.inputsHash`, table handles, provenance, all of it. Does NOT verify the id (its one documented omission, unchanged): `true` means the envelope is well-formed, and `readAnalysisArtifact` proves the id on top. (An earlier version sniffed five fields, so `{ …, inputs: undefined }` passed as `AnalysisArtifact` and detonated at first use.) Full-walk, not constant-time. ```typescript export declare function isAnalysisArtifact(value: unknown): value is AnalysisArtifact; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isContentHashString Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exact shape test for a spine hash string (used by handle/artifact validation). ```typescript export declare function isContentHashString(value: unknown): value is string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isFittedModelSummary Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sound structural predicate for a fitted-model summary: the COMPLETE {@link requireFittedModelSummary} validation behind a boolean door, so `value is FittedModelSummary` is a claim every consumer can act on. ```typescript export declare function isFittedModelSummary(value: unknown): value is FittedModelSummary; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isMarketSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sound structural test for a CURRENT-version market snapshot envelope: the complete read-door validation (closed keys, kind, version, finite `asOf`, every observation, provenance shape) behind a boolean door — `true` means `readMarketSnapshot` would accept the value unchanged, with no migrations. (An earlier version sniffed five fields, so `{ …, asOf: NaN }` and a conventions-free bag passed as `MarketSnapshot` and detonated downstream.) Full-walk, not constant-time; when you also need the restored copy, call the read door instead. ```typescript export declare function isMarketSnapshot(value: unknown): value is MarketSnapshot; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isNonFiniteNumber Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exact wrapper test: a plain object whose ONLY member is a valid `nonFinite` tag. ```typescript export declare function isNonFiniteNumber(value: unknown): value is NonFiniteNumber; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isScenarioSet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sound structural test for a CURRENT-version scenario-set envelope: the complete read-door validation behind a boolean door — `true` means `readScenarioSet` would accept the value unchanged, with no migrations. (An earlier version checked four fields, so `{ …, scenarios: [42] }` passed as `ScenarioSet` and detonated at first use.) Full-walk, not constant-time; call the read door when you also need the restored copy. ```typescript export declare function isScenarioSet(value: unknown): value is ScenarioSet; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#isTableHandle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Structural PREDICATE for a table handle: the COMPLETE {@link requireTableHandle} validation behind a boolean door, so `value is TableHandle` is a sound claim — `true` means every envelope site would accept the handle unchanged. (An earlier version checked only the required fields, so `{ …, columns: 42 }` passed the guard and then detonated at the first validation site; a guard that is a weaker law than the validator is a `false` dressed as a `true`.) It runs the full field walk — not a constant-time tag sniff — which for a handle (a dozen scalar fields) is still trivially cheap. ```typescript export declare function isTableHandle(value: unknown): value is TableHandle; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#marketSnapshotContentHash Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The snapshot's content identity: `sha256:` over the canonical envelope WITHOUT `provenance`. Conventions, `asOf`, and every observation are covered (two snapshots that price differently must never collide); source labels are not (two vendors delivering identical numbers ARE the same market — dedup and replay comparison depend on that). ```typescript export declare function marketSnapshotContentHash(snapshot: MarketSnapshot): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (snapshot): MarketSnapshot; default: not declared - (snapshot).asOf: number; default: not declared - (snapshot).conventions: MarketSnapshotConventions; default: not declared - (snapshot).kind: 'totalfinance.market-snapshot'; default: not declared - (snapshot).observations: MarketSnapshotObservations; default: not declared - (snapshot).provenance?: Provenance; default: not declared - (snapshot).schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#readAnalysisArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore a stored artifact: envelope validation, explicit migration, full body re-validation — and TWO hash verifications. `inputs.inputsHash` is recomputed from the stored `{ snapshotHash, parameters }` (via the body validator), and the recomputed content hash must equal the stored `id`; either mismatch means the artifact was edited after creation, and it is refused rather than trusted. ```typescript export declare function readAnalysisArtifact(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; }): { artifact: AnalysisArtifact; migrationsApplied: AppliedMigration[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; }; default: not declared - (input).artifact: unknown; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - return.artifact: AnalysisArtifact; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared ### @insiderfinance/totalfinance/core/artifacts#readMarketSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The ONE door back in for stored snapshots: validates the envelope (closed key set, kind, version) BEFORE reading any observation, applies explicitly registered migrations for older versions, refuses newer versions, re-validates the full body, and returns a frozen snapshot plus the exact migration steps applied (possibly none). ```typescript export declare function readMarketSnapshot(input: { snapshot: unknown; migrations?: ArtifactMigrationRegistry; }): { snapshot: MarketSnapshot; migrationsApplied: AppliedMigration[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { snapshot: unknown; migrations?: ArtifactMigrationRegistry; }; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).snapshot: unknown; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared - return.snapshot: MarketSnapshot; default: not declared ### @insiderfinance/totalfinance/core/artifacts#readScenarioSet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore a stored scenario set, with the shared version/migration policy. ```typescript export declare function readScenarioSet(input: { scenarioSet: unknown; migrations?: ArtifactMigrationRegistry; }): { scenarioSet: ScenarioSet; migrationsApplied: AppliedMigration[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { scenarioSet: unknown; migrations?: ArtifactMigrationRegistry; }; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).scenarioSet: unknown; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared - return.scenarioSet: ScenarioSet; default: not declared ### @insiderfinance/totalfinance/core/artifacts#requireComparisonTolerance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The explicit two-sided tolerance law: both members finite and ≥ 0, or no tolerance at all. ```typescript export declare function requireComparisonTolerance(input: { functionName: string; tolerance?: unknown; }): ComparisonTolerance | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { functionName: string; tolerance?: unknown; }; default: not declared - (input).functionName: string; default: not declared - (input).tolerance?: unknown; default: not declared — The caller's raw tolerance; omitted (undefined) means no tolerance — exact comparison. - return.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - return.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. ### @insiderfinance/totalfinance/core/artifacts#requireFittedModelSummary Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The FULL summary validator — closed keys at every level, typed and finite fields, and the honesty rules (a null objective or residual statistic needs its reason; a calibrated range is ordered; identity fields are content hashes). Shared by the domain adapters (which project a summary and then prove it here) and by {@link isFittedModelSummary}. Returns the validated value. ```typescript export declare function requireFittedModelSummary(functionName: string, label: string, value: unknown): FittedModelSummary; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - return.convergence.converged: boolean; default: not declared - return.convergence.iterations: number | null; default: not declared - return.convergence.reason?: string; default: not declared - return.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - return.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - return.inputIdentity.calibrationHash: string; default: not declared - return.inputIdentity.snapshotHash: string | null; default: not declared - return.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - return.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - return.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - return.modelRisk.notes: string[]; default: not declared - return.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - return.objective: { kind: FittedModelObjectiveKind; value: number | null; unit: string; reason?: string; }; default: not declared - return.objective.kind: FittedModelObjectiveKind; default: not declared - return.objective.reason?: string; default: not declared — Required exactly when `value` is null. - return.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - return.objective.value: number | null; default: not declared - return.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - return.residuals: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; unit: string; source: FittedModelResidualSource; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - return.residuals.count: number; default: not declared - return.residuals.maximumAbsolute: number | null; default: not declared - return.residuals.rootMeanSquare: number | null; default: not declared - return.residuals.source: FittedModelResidualSource; default: not declared - return.residuals.unit: string; default: not declared - return.warningCount: number; default: not declared - return.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/core/artifacts#requireInstantMarketSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The instant of a market snapshot for an OPTION-PRICING consumer. A snapshot created from a bare date (`asOfConvention: 'date-midnight-utc'`) is refused with the fix: 00:00 UTC is 19:00/20:00 ET the previous evening, and a same-day option's value depends on the time of day. Ledger consumers (dated marks) do not call this; they keep the date-granular convention. ```typescript export declare function requireInstantMarketSnapshot(functionName: string, snapshot: MarketSnapshot): EpochMs; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (snapshot): MarketSnapshot; default: not declared - (snapshot).asOf: number; default: not declared - (snapshot).conventions: MarketSnapshotConventions; default: not declared - (snapshot).kind: 'totalfinance.market-snapshot'; default: not declared - (snapshot).observations: MarketSnapshotObservations; default: not declared - (snapshot).provenance?: Provenance; default: not declared - (snapshot).schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#requireWorkLimit Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one work limit: a safe integer at or above `floor` (default 1), at or below the law's hard maximum; `undefined` takes the law's default when it has one and refuses when it has none. ```typescript export declare function requireWorkLimit(input: { functionName: string; field: string; value?: unknown; law: WorkLimitLaw; floor?: number; }): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { functionName: string; field: string; value?: unknown; law: WorkLimitLaw; floor?: number; }; default: not declared - (input).field: string; default: not declared - (input).floor?: number; default: not declared - (input).functionName: string; default: not declared - (input).law: WorkLimitLaw; default: not declared - (input).value?: unknown; default: not declared — The caller's raw value; omitted (undefined) takes the law's default. ### @insiderfinance/totalfinance/core/artifacts#residualStatistics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Count, root-mean-square, and maximum absolute value of a residual list (null statistics when empty). ```typescript export declare function residualStatistics(residuals: readonly number[]): { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (residuals): readonly number[]; default: not declared - return.count: number; default: not declared - return.maximumAbsolute: number | null; default: not declared - return.rootMeanSquare: number | null; default: not declared ### @insiderfinance/totalfinance/core/artifacts#scanCanonicalData Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Prove and measure behavior-free canonical stored data (see the module header). Returns the deterministic canonical work cost; throws the first structural refusal or the budget refusal. ```typescript export declare function scanCanonicalData(value: unknown, options: CanonicalDataScanOptions): number; ``` Example (source JSDoc): ```ts const cost = scanCanonicalData(input.report, { functionName: 'readReport', label: 'input.report', maximumWorkUnits: 200_000, requireFiniteNumbers: true, }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): CanonicalDataScanOptions; default: not declared - (options).functionName: string; default: not declared — The public function whose input is being scanned — every refusal names it. - (options).ignoredSymbols?: ReadonlySet; default: not declared — Symbol keys the caller owns and deliberately excludes from the data law (private bindings). - (options).label: string; default: not declared — The root path label in refusals (`'input.market'`, `'artifact.result'`, …). - (options).maximumDepth?: number; default: not declared — Container nesting limit; default {@link CANONICAL_DATA_MAX_DEPTH}. - (options).maximumWorkUnits?: number; default: not declared — Stop-at-limit budget in work units; omitted means unbounded (the caller has already bounded). - (options).requireFiniteNumbers?: boolean; default: not declared — Refuse NaN / ±Infinity as data (successful envelopes) instead of admitting them as leaves. - (value): unknown; default: not declared ### @insiderfinance/totalfinance/core/artifacts#scenarioSetContentHash Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Content identity for a scenario set: the canonical envelope WITHOUT `provenance`. ```typescript export declare function scenarioSetContentHash(scenarioSet: ScenarioSet): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (scenarioSet): ScenarioSet; default: not declared - (scenarioSet).kind: 'totalfinance.scenario-set'; default: not declared - (scenarioSet).name: string; default: not declared - (scenarioSet).provenance?: Provenance; default: not declared — Where the definitions came from (a historical-event library, a desk doc) — caller-supplied. - (scenarioSet).scenarios: ScenarioDefinition[]; default: not declared - (scenarioSet).schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#sha256Hex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). SHA-256 of a UTF-8 string, as 64 lowercase hex characters. The raw primitive under {@link contentHash}, exported so golden vectors and external comparisons (`echo -n … | shasum -a 256`, Python's `hashlib`) can target it directly. ```typescript export declare function sha256Hex(text: string): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (text): string; default: not declared ### @insiderfinance/totalfinance/core/artifacts#tableHandleForRows Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Mint the table handle for a row set the caller holds (Stage 4.5 Decision 4 — the ONE column law every package shares, so the same rows always mint the same handle): - an array of plain records → `columns` is the sorted union of the rows' own keys; - an array of numbers (a returns or realized-variance vector) → one column, `['value']`; - anything else (mixed rows, nested arrays, non-plain objects) is refused with the teaching. `contentHash` is the canonical-JSON hash of the rows exactly as given, so a consumer that later receives rows can prove they are the referenced ones by re-minting and comparing hashes. ```typescript export declare function tableHandleForRows(input: { rows: readonly unknown[]; locator?: string; mediaType?: string; }): TableHandle; ``` Example (source JSDoc): ```ts const handle = tableHandleForRows({ rows: observations, locator: 'universe/2026-09-01.json' }); // { kind: 'totalfinance.table-handle', contentHash: 'sha256:…', rowCount: 4200, columnCount: 3, columns: ['availableTimestampMs', 'fields', 'instrumentId'] } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { rows: readonly unknown[]; locator?: string; mediaType?: string; }; default: not declared - (input).locator?: string; default: not declared - (input).mediaType?: string; default: not declared - (input).rows: readonly unknown[]; default: not declared - return.columnCount: number; default: not declared - return.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - return.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - return.kind: 'totalfinance.table-handle'; default: not declared - return.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - return.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - return.rowCount: number; default: not declared ### @insiderfinance/totalfinance/core/artifacts#verifyReferencedRows Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Prove caller-supplied rows are the referenced table: they must be an array whose canonical content hash equals the stored handle's. Returns the rows (as given) on success. ```typescript export declare function verifyReferencedRows(input: { functionName: string; label: string; handle: TableHandle; rows: unknown; }): unknown[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { functionName: string; label: string; handle: TableHandle; rows: unknown; }; default: not declared - (input).functionName: string; default: not declared - (input).handle: TableHandle; default: not declared - (input).label: string; default: not declared - (input).rows: unknown; default: not declared ## Entrypoint @insiderfinance/totalfinance/core/data ### @insiderfinance/totalfinance/core/data#CommonPageFacts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#CommonPageFacts`. ### @insiderfinance/totalfinance/core/data#ConnectedData Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ConnectedData`. ### @insiderfinance/totalfinance/core/data#DATA_CONTRACT_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Public provider-neutral research contract, separate from all provider HTTP packages. ```typescript export declare const DATA_CONTRACT_VERSION: 2; ``` ### @insiderfinance/totalfinance/core/data#DataCallOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCallOptions`. ### @insiderfinance/totalfinance/core/data#DataCapabilities Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCapabilities`. ### @insiderfinance/totalfinance/core/data#DataCapability Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCapability`. ### @insiderfinance/totalfinance/core/data#DataCapabilityDeclaration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCapabilityDeclaration`. ### @insiderfinance/totalfinance/core/data#DataConnectionOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataConnectionOptions`. ### @insiderfinance/totalfinance/core/data#DataContinuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataContinuation`. ### @insiderfinance/totalfinance/core/data#DataFor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataFor`. ### @insiderfinance/totalfinance/core/data#DataGuidanceRule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataGuidanceRule`. ### @insiderfinance/totalfinance/core/data#DataInterval Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataInterval`. ### @insiderfinance/totalfinance/core/data#DataKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataKind`. ### @insiderfinance/totalfinance/core/data#DataPage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPage`. ### @insiderfinance/totalfinance/core/data#DataPageMetadata Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPageMetadata`. ### @insiderfinance/totalfinance/core/data#DataPageOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPageOptions`. ### @insiderfinance/totalfinance/core/data#DataPins Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPins`. ### @insiderfinance/totalfinance/core/data#DataProvider Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProvider`. ### @insiderfinance/totalfinance/core/data#DataProviderError Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DataProviderError extends QuantError { constructor(options: DataProviderErrorOptions); static captureStackTrace(targetObject: object, constructorOpt?: Function): void; static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; static stackTraceLimit: number; readonly dataFailure: DataProviderFailure; readonly code: string; readonly context?: Record; toJSON(): { serialization: 1; name: string; code: string; message: string; context?: Record; }; name: string; message: string; stack?: string; cause?: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): DataProviderErrorOptions; default: not declared - (options).cause?: unknown; default: not declared - (options).code: string; default: not declared - (options).guidance?: { readonly field: KnownDataField; readonly rule: DataGuidanceRule; }; default: not declared - (options).guidance.field: KnownDataField; default: not declared - (options).guidance.rule: DataGuidanceRule; default: not declared - (options).retryAfterMs?: number; default: not declared - (options).retryable?: boolean; default: not declared - (options).status?: number; default: not declared - code: string; default: not declared - context?: Record; default: not declared - dataFailure: DataProviderFailure; default: not declared - dataFailure.code: string; default: not declared - dataFailure.guidance?: { readonly field: KnownDataField; readonly rule: DataGuidanceRule; }; default: not declared - dataFailure.guidance.field: KnownDataField; default: not declared - dataFailure.guidance.rule: DataGuidanceRule; default: not declared - dataFailure.retryAfterMs?: number; default: not declared - dataFailure.retryable?: boolean; default: not declared - dataFailure.status?: number; default: not declared - dataFailure.version: 1; default: not declared - return.code: string; default: not declared - return.context?: Record; default: not declared - return.dataFailure: DataProviderFailure; default: not declared - return.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - toJSON().return.code: string; default: not declared - toJSON().return.context?: Record; default: not declared - toJSON().return.message: string; default: not declared - toJSON().return.name: string; default: not declared - toJSON().return.serialization: 1; default: not declared ### @insiderfinance/totalfinance/core/data#DataProviderErrorOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProviderErrorOptions`. ### @insiderfinance/totalfinance/core/data#DataProviderFailure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProviderFailure`. ### @insiderfinance/totalfinance/core/data#DataProviderSource Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProviderSource`. ### @insiderfinance/totalfinance/core/data#DataQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataQuery`. ### @insiderfinance/totalfinance/core/data#DataQueryBinding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataQueryBinding`. ### @insiderfinance/totalfinance/core/data#DataQueryOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataQueryOptions`. ### @insiderfinance/totalfinance/core/data#DataView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataView`. ### @insiderfinance/totalfinance/core/data#DataViewFor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataViewFor`. ### @insiderfinance/totalfinance/core/data#KnownDataField Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#KnownDataField`. ### @insiderfinance/totalfinance/core/data#OHLCField Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OHLCField`. ### @insiderfinance/totalfinance/core/data#ObservationTimes Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ObservationTimes`. ### @insiderfinance/totalfinance/core/data#OhlcvInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OhlcvInput`. ### @insiderfinance/totalfinance/core/data#OptionChainResearchQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionChainResearchQuery`. ### @insiderfinance/totalfinance/core/data#OptionChainResearchRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionChainResearchRecord`. ### @insiderfinance/totalfinance/core/data#OptionChainResearchView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionChainResearchView`. ### @insiderfinance/totalfinance/core/data#OptionResearchTerms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionResearchTerms`. ### @insiderfinance/totalfinance/core/data#PriceBarRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarRecord`. ### @insiderfinance/totalfinance/core/data#PriceBarsCheckpoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsCheckpoint`. ### @insiderfinance/totalfinance/core/data#PriceBarsPageFacts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsPageFacts`. ### @insiderfinance/totalfinance/core/data#PriceBarsPaging Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsPaging`. ### @insiderfinance/totalfinance/core/data#PriceBarsQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsQuery`. ### @insiderfinance/totalfinance/core/data#PriceBarsSelections Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsSelections`. ### @insiderfinance/totalfinance/core/data#PriceBarsView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsView`. ### @insiderfinance/totalfinance/core/data#PriceBarsWindow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindow`. ### @insiderfinance/totalfinance/core/data#PriceBarsWindowOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindowOptions`. ### @insiderfinance/totalfinance/core/data#PriceBarsWindowRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindowRequest`. ### @insiderfinance/totalfinance/core/data#PriceBarsWindowView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindowView`. ### @insiderfinance/totalfinance/core/data#ResearchBarChoice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ResearchBarChoice`. ### @insiderfinance/totalfinance/core/data#ResearchBarIssue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ResearchBarIssue`. ### @insiderfinance/totalfinance/core/data#ResearchBarSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ResearchBarSelection`. ### @insiderfinance/totalfinance/core/data#RowReference Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#RowReference`. ### @insiderfinance/totalfinance/core/data#SourceOptionChainPage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SourceOptionChainPage`. ### @insiderfinance/totalfinance/core/data#SourcePriceBarRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SourcePriceBarRecord`. ### @insiderfinance/totalfinance/core/data#SourcePriceBarsPage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SourcePriceBarsPage`. ### @insiderfinance/totalfinance/core/data#TimestampedOhlcvInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#TimestampedOhlcvInput`. ### @insiderfinance/totalfinance/core/data#connect Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#connect`. ### @insiderfinance/totalfinance/core/data#createDataView Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore canonical page facts and choices; never infer missing v1 query/provider context. ```typescript export declare function createDataView(input: unknown, selection?: unknown): DataView; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): unknown; default: not declared - (selection)?: unknown; default: not declared - return.bars: readonly Readonly[]; default: not declared - return.closePrices: readonly number[]; default: not declared - return.continuation: import('@insiderfinance/totalfinance/core/data').DataContinuation | null; default: not declared - return.continuation.binding: import('@insiderfinance/totalfinance/core/data').DataQueryBinding; default: not declared - return.continuation.cursor: string; default: not declared - return.continuation.pins: import('@insiderfinance/totalfinance/core/data').DataPins; default: not declared - return.continuation.version: 2; default: not declared - return.continuationStatus: 'available' | 'terminal' | 'unavailable-legacy-context'; default: not declared - return.issues: readonly import('@insiderfinance/totalfinance/core/data').ResearchBarIssue[]; default: not declared - return.kind: ('option-chain-research') | ('price-bars'); default: not declared - return.ohlcvBars: readonly import('@insiderfinance/totalfinance/core/data').OhlcvInput[]; default: not declared - return.page: (DataPage) | (DataPage); default: not declared - return.resolve: (choice: ResearchBarChoice) => import('@insiderfinance/totalfinance/core/data').PriceBarsView; default: not declared - return.selection: import('@insiderfinance/totalfinance/core/data').ResearchBarSelection; default: not declared - return.selections: readonly ['closePrices', 'ohlcvBars', 'bars']; default: not declared ### @insiderfinance/totalfinance/core/data#createPriceBarsWindowView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#createPriceBarsWindowView`. ### @insiderfinance/totalfinance/core/data#defineDataProvider Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function defineDataProvider(source: DataProviderSource): DataProvider; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (source): DataProviderSource; default: not declared - (source).capabilities: (options?: DataCallOptions) => Promise; default: not declared - (source).contractVersion: 2; default: not declared - (source).id: string; default: not declared - (source).protocol: 'totalfinance-data-source'; default: not declared - (source).query: (query: DataQuery, page: import('@insiderfinance/totalfinance/core/data').DataPageOptions) => Promise; default: not declared - (source).version: string; default: not declared - return.capabilities: (options?: DataCallOptions) => Promise; default: not declared - return.contractVersion: 2; default: not declared - return.id: string; default: not declared - return.query: (query: R, options: DataQueryOptions) => Promise>; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/core/data#priceBarsCheckpoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#priceBarsCheckpoint`. ## Entrypoint @insiderfinance/totalfinance/core/data-conformance ### @insiderfinance/totalfinance/core/data-conformance#DataAbortProbe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataAbortProbe { readonly name: string; readonly kind: 'abort'; readonly request: DataQuery; readonly pageSize: number; readonly waitUntilStarted: () => Promise; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'abort'; default: not declared - name: string; default: not declared - pageSize: number; default: not declared - request: DataQuery; default: not declared - request.expirationFrom?: string; default: not declared - request.expirationTo?: string; default: not declared - request.from: string; default: not declared - request.interval: import('@insiderfinance/totalfinance/core/data').DataInterval; default: not declared - request.kind: ('option-chain-research') | ('price-bars'); default: not declared - request.maxStrike?: number; default: not declared - request.minStrike?: number; default: not declared - request.rights?: readonly ('call' | 'put')[]; default: not declared - request.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - request.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - request.snapshot.sessionDate: string; default: not declared - request.snapshot.snapshotId: string; default: not declared - request.symbol: string; default: not declared - request.to: string; default: not declared - waitUntilStarted: () => Promise; default: not declared ### @insiderfinance/totalfinance/core/data-conformance#DataErrorProbe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataErrorProbe { readonly name: string; readonly kind: 'error'; readonly request: unknown; readonly pageSize: number; readonly expectedCode: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedCode: string; default: not declared - kind: 'error'; default: not declared - name: string; default: not declared - pageSize: number; default: not declared - request: unknown; default: not declared ### @insiderfinance/totalfinance/core/data-conformance#DataPagesProbe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataPagesProbe { readonly name: string; readonly kind: 'pages'; readonly request: DataQuery; readonly pageSize: number; readonly expectedPages: readonly DataPage[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedPages: readonly DataPage[]; default: not declared - kind: 'pages'; default: not declared - name: string; default: not declared - pageSize: number; default: not declared - request: DataQuery; default: not declared - request.expirationFrom?: string; default: not declared - request.expirationTo?: string; default: not declared - request.from: string; default: not declared - request.interval: import('@insiderfinance/totalfinance/core/data').DataInterval; default: not declared - request.kind: ('option-chain-research') | ('price-bars'); default: not declared - request.maxStrike?: number; default: not declared - request.minStrike?: number; default: not declared - request.rights?: readonly ('call' | 'put')[]; default: not declared - request.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - request.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - request.snapshot.sessionDate: string; default: not declared - request.snapshot.snapshotId: string; default: not declared - request.symbol: string; default: not declared - request.to: string; default: not declared ### @insiderfinance/totalfinance/core/data-conformance#DataProviderProbe Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DataProviderProbe = DataPagesProbe | DataRecordsProbe | DataErrorProbe | DataAbortProbe; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedCode: string; default: not declared - expectedFacts: readonly { readonly datasetId: string; readonly datasetVersion: string; readonly adjustment: string; readonly consistency: string; }[]; default: not declared - expectedPages: readonly DataPage[]; default: not declared - expectedRecords: readonly (PriceBarRecord | OptionChainResearchRecord)[]; default: not declared - kind: ('abort') | ('error') | ('pages') | ('records'); default: not declared - name: string; default: not declared - pageSize: number; default: not declared - request: (DataQuery) | (unknown); default: not declared - request.expirationFrom?: string; default: not declared - request.expirationTo?: string; default: not declared - request.from: string; default: not declared - request.interval: import('@insiderfinance/totalfinance/core/data').DataInterval; default: not declared - request.kind: ('option-chain-research') | ('price-bars'); default: not declared - request.maxStrike?: number; default: not declared - request.minStrike?: number; default: not declared - request.rights?: readonly ('call' | 'put')[]; default: not declared - request.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - request.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - request.snapshot.sessionDate: string; default: not declared - request.snapshot.snapshotId: string; default: not declared - request.symbol: string; default: not declared - request.to: string; default: not declared - waitUntilStarted: () => Promise; default: not declared ### @insiderfinance/totalfinance/core/data-conformance#DataRecordsProbe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DataRecordsProbe { readonly name: string; readonly kind: 'records'; readonly request: DataQuery; readonly pageSize: number; readonly expectedRecords: readonly (PriceBarRecord | OptionChainResearchRecord)[]; readonly expectedFacts: readonly { readonly datasetId: string; readonly datasetVersion: string; readonly adjustment: string; readonly consistency: string; }[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedFacts: readonly { readonly datasetId: string; readonly datasetVersion: string; readonly adjustment: string; readonly consistency: string; }[]; default: not declared - expectedRecords: readonly (PriceBarRecord | OptionChainResearchRecord)[]; default: not declared - kind: 'records'; default: not declared - name: string; default: not declared - pageSize: number; default: not declared - request: DataQuery; default: not declared - request.expirationFrom?: string; default: not declared - request.expirationTo?: string; default: not declared - request.from: string; default: not declared - request.interval: import('@insiderfinance/totalfinance/core/data').DataInterval; default: not declared - request.kind: ('option-chain-research') | ('price-bars'); default: not declared - request.maxStrike?: number; default: not declared - request.minStrike?: number; default: not declared - request.rights?: readonly ('call' | 'put')[]; default: not declared - request.snapshot: { readonly kind: 'latest'; } | { readonly kind: 'session'; readonly sessionDate: string; } | { readonly kind: 'id'; readonly snapshotId: string; }; default: not declared - request.snapshot.kind: ('id') | ('latest') | ('session'); default: not declared - request.snapshot.sessionDate: string; default: not declared - request.snapshot.snapshotId: string; default: not declared - request.symbol: string; default: not declared - request.to: string; default: not declared ### @insiderfinance/totalfinance/core/data-conformance#ValidateDataProviderInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ValidateDataProviderInput { readonly provider: DataProvider; readonly probes: readonly DataProviderProbe[]; readonly maxPages: number; readonly maxRecords: number; readonly timeoutMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxPages: number; default: not declared - maxRecords: number; default: not declared - probes: readonly DataProviderProbe[]; default: not declared - provider: DataProvider; default: not declared - provider.capabilities: (options?: import('@insiderfinance/totalfinance/core/data').DataCallOptions) => Promise; default: not declared - provider.capabilities(options)?: import('@insiderfinance/totalfinance/core/data').DataCallOptions | undefined; default: not declared - provider.capabilities(options).signal?: AbortSignal; default: not declared - provider.contractVersion: 2; default: not declared - provider.id: string; default: not declared - provider.query: (query: R, options: import('@insiderfinance/totalfinance/core/data').DataQueryOptions) => Promise>; default: not declared - provider.query(options): import('@insiderfinance/totalfinance/core/data').DataQueryOptions; default: not declared - provider.query(options).cursor?: DataContinuation; default: not declared - provider.query(options).limit: number; default: not declared - provider.query(options).signal?: AbortSignal; default: not declared - provider.query(query): R; default: not declared - provider.version: string; default: not declared - timeoutMs: number; default: not declared ### @insiderfinance/totalfinance/core/data-conformance#validateDataProvider Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function validateDataProvider(input: ValidateDataProviderInput): Promise; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ValidateDataProviderInput; default: not declared - (input).maxPages: number; default: not declared - (input).maxRecords: number; default: not declared - (input).probes: readonly DataProviderProbe[]; default: not declared - (input).provider: DataProvider; default: not declared - (input).timeoutMs: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/core/pricing ### @insiderfinance/totalfinance/core/pricing#DiscountCurveRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ONE named discount curve, satisfied by a core {@link RateCurve} — PLAIN DATA, the same payload a Gate B market snapshot stores under `observations.curves`, so the observation list stays serializable and replayable end to end. Consumers (e.g. a fixed-income adapter) evaluate the curve with their own machinery; the protocol carries data, never behavior. `curveId` IS the snapshot `curves` label (e.g. `'USD.sofr'`) — that binding is the identity: a snapshot stores multiple same-currency curves under caller labels, so a currency alone cannot name one, and a runner satisfies this requirement by `snapshot.observations.curves[curveId]`. `currency` remains a subject field AND a cross-check: the satisfying curve's own declared `currency` must equal it, so a USD requirement can never be quietly satisfied by an EUR curve that happened to sit under the requested label. ```typescript /** * ONE named discount curve, satisfied by a core {@link RateCurve} — PLAIN DATA, the same payload a * Gate B market snapshot stores under `observations.curves`, so the observation list stays * serializable and replayable end to end. Consumers (e.g. a fixed-income adapter) evaluate the * curve with their own machinery; the protocol carries data, never behavior. * * `curveId` IS the snapshot `curves` label (e.g. `'USD.sofr'`) — that binding is the identity: a * snapshot stores multiple same-currency curves under caller labels, so a currency alone cannot * name one, and a runner satisfies this requirement by `snapshot.observations.curves[curveId]`. * `currency` remains a subject field AND a cross-check: the satisfying curve's own declared * `currency` must equal it, so a USD requirement can never be quietly satisfied by an EUR curve * that happened to sit under the requested label. */ export interface DiscountCurveRequirement { kind: 'discountCurve'; /** The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). */ curveId: string; currency: string; optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - kind: 'discountCurve'; default: not declared - optional?: boolean; default: not declared ### @insiderfinance/totalfinance/core/pricing#DividendYieldRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A continuous dividend yield (decimal) for one underlying. ```typescript /** A continuous dividend yield (decimal) for one underlying. */ export interface DividendYieldRequirement { kind: 'dividendYield'; symbol: string; optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'dividendYield'; default: not declared - optional?: boolean; default: not declared - symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#ForwardRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The forward price of one underlying to a delivery/expiry instant. ```typescript /** The forward price of one underlying to a delivery/expiry instant. */ export interface ForwardRequirement { kind: 'forward'; symbol: string; /** Delivery/expiry instant (epoch ms) the forward settles to. */ expiresAt: EpochMs; optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. - kind: 'forward'; default: not declared - optional?: boolean; default: not declared - symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#ImpliedVolatilityRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An implied volatility (decimal, e.g. `0.24`) for one contract coordinate. ```typescript /** An implied volatility (decimal, e.g. `0.24`) for one contract coordinate. */ export interface ImpliedVolatilityRequirement { kind: 'impliedVolatility'; symbol: string; strike: number; /** Expiration instant (epoch ms) of the contract the volatility belongs to. */ expiresAt: EpochMs; optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiresAt: number; default: not declared — Expiration instant (epoch ms) of the contract the volatility belongs to. - kind: 'impliedVolatility'; default: not declared - optional?: boolean; default: not declared - strike: number; default: not declared - symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#MarketObservation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One satisfied requirement: the descriptor it answers plus the value. Carrying the DESCRIPTOR (not a bare keyed map) keeps matching structural and lets the same observation list serialize, diff, and replay alongside Gate B snapshots. ```typescript /** * One satisfied requirement: the descriptor it answers plus the value. Carrying the DESCRIPTOR * (not a bare keyed map) keeps matching structural and lets the same observation list serialize, * diff, and replay alongside Gate B snapshots. */ export type MarketObservation = { [K in ObservationKind]: { requirement: RequirementOfKind; value: ObservationValueByKind[K]; }; }[ObservationKind]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - requirement: (DiscountCurveRequirement) | (DividendYieldRequirement) | (ForwardRequirement) | (ImpliedVolatilityRequirement) | (RiskFreeRateRequirement) | (SpotRequirement) | (ValuationInstantRequirement); default: not declared - requirement.currency: string; default: not declared - requirement.curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - requirement.expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - requirement.kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - requirement.optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - requirement.strike: number; default: not declared - requirement.symbol: string; default: not declared - value: (RateCurve) | (number) | (string | number); default: not declared - value.asOf: number; default: not declared - value.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - value.compounding.periodsPerYear: number; default: not declared - value.compounding.type: 'periodic'; default: not declared - value.currency: string; default: not declared - value.dayCount: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - value.interpolation?: string; default: not declared - value.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared ### @insiderfinance/totalfinance/core/pricing#MarketRequirement Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One typed market-requirement descriptor — plain, serializable data. A pricer returns these from `requirements(instrument)`; a runner satisfies them from a snapshot; a missing REQUIRED one is a teaching error (`pricer.requirement_unsatisfied`), never a guessed value. There is deliberately no "god market object": each pricer names exactly the observations it consumes, so a book runner can gather the union for a heterogeneous book and know it is complete. ```typescript /** * One typed market-requirement descriptor — plain, serializable data. A pricer returns these from * `requirements(instrument)`; a runner satisfies them from a snapshot; a missing REQUIRED one is a * teaching error (`pricer.requirement_unsatisfied`), never a guessed value. There is deliberately * no "god market object": each pricer names exactly the observations it consumes, so a book runner * can gather the union for a heterogeneous book and know it is complete. */ export type MarketRequirement = ValuationInstantRequirement | SpotRequirement | ForwardRequirement | ImpliedVolatilityRequirement | RiskFreeRateRequirement | DividendYieldRequirement | DiscountCurveRequirement; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - strike: number; default: not declared - symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#ObservationKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed set of observation kinds a pricer may require. These names are the shared vocabulary with the Gate B market-snapshot spine: a snapshot stores observations under the SAME kinds, so a runner can satisfy a requirement by lookup without either side importing the other. The set is extended here (one union member + one row in `REQUIREMENT_SUBJECT_FIELDS` + one value type), and every extension is a reviewed vocabulary decision, not a runtime registration. ```typescript // ──────────────────────────────────────────────────────────────────────────────────────────────── // Market requirements — "what I need to price", stated as data // ──────────────────────────────────────────────────────────────────────────────────────────────── /** * The closed set of observation kinds a pricer may require. These names are the shared vocabulary * with the Gate B market-snapshot spine: a snapshot stores observations under the SAME kinds, so a * runner can satisfy a requirement by lookup without either side importing the other. The set is * extended here (one union member + one row in `REQUIREMENT_SUBJECT_FIELDS` + one value type), and * every extension is a reviewed vocabulary decision, not a runtime registration. */ export type ObservationKind = 'valuationInstant' | 'spot' | 'forward' | 'impliedVolatility' | 'riskFreeRate' | 'dividendYield' | 'discountCurve'; ``` ### @insiderfinance/totalfinance/core/pricing#ObservationValueByKind Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The value type each observation kind is satisfied with. Every value is plain, serializable data. ```typescript /** The value type each observation kind is satisfied with. Every value is plain, serializable data. */ export interface ObservationValueByKind { /** * Epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime — the workspace `asOf` grammar, validated * through core's `resolveAsOf` (the same resolution the market snapshot's create path applies), * so `'yesterday-ish'` and impossible calendar dates teach here, not downstream. */ valuationInstant: EpochMs | string; spot: number; forward: number; /** Annualized decimal, ≥ 0 — a volatility quote is a magnitude, never a signed number. */ impliedVolatility: number; riskFreeRate: number; dividendYield: number; /** * Core's plain-data {@link RateCurve} — the SAME payload Gate B snapshots store under * `observations.curves`, validated with the shared core curve validator. Consumers evaluate it * with their own machinery (a fixed-income adapter bootstraps/interpolates as its heads already * do); the observation itself carries no methods, so the list serializes and replays. */ discountCurve: RateCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountCurve: RateCurve; default: not declared — Core's plain-data {@link RateCurve} — the SAME payload Gate B snapshots store under `observations.curves`, validated with the shared core curve validator. Consumers evaluate it with their own machinery (a fixed-income adapter bootstraps/interpolates as its heads already do); the observation itself carries no methods, so the list serializes and replays. - discountCurve.asOf: number; default: not declared - discountCurve.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - discountCurve.compounding.periodsPerYear: number; default: not declared - discountCurve.compounding.type: 'periodic'; default: not declared - discountCurve.currency: string; default: not declared - discountCurve.dayCount: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - discountCurve.interpolation?: string; default: not declared - discountCurve.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - dividendYield: number; default: not declared - forward: number; default: not declared - impliedVolatility: number; default: not declared — Annualized decimal, ≥ 0 — a volatility quote is a magnitude, never a signed number. - riskFreeRate: number; default: not declared - spot: number; default: not declared - valuationInstant: string | number; default: not declared — Epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime — the workspace `asOf` grammar, validated through core's `resolveAsOf` (the same resolution the market snapshot's create path applies), so `'yesterday-ish'` and impossible calendar dates teach here, not downstream. ### @insiderfinance/totalfinance/core/pricing#Pricer Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Pricer> { /** Stable identity, reported in diagnostics and selection reports. */ readonly name: string; readonly version: string; /** Verified by {@link validatePricer}; never self-certified marketing. */ readonly capabilities: PricerCapabilities; /** Whether this pricer can price the instrument. Runners gate on this before `requirements`. */ supports(instrument: TInstrument): boolean; /** * The typed market requirements pricing THIS instrument consumes — required ones missing at * `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must * not influence the result (both are conformance-probed). */ requirements(instrument: TInstrument): readonly MarketRequirement[]; price(input: PricerPriceInput): TValuation; /** Present iff `capabilities.batch`; must agree with `price` result-for-result. */ priceBatch?(input: PricerBatchPriceInput): readonly TValuation[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - price: (input: PricerPriceInput) => TValuation; default: not declared - price(input): PricerPriceInput; default: not declared - price(input).instrument: TInstrument; default: not declared - price(input).observations: readonly MarketObservation[]; default: not declared — Observations satisfying the pricer's declared requirements for this instrument. - price(input).request?: PricerValuationRequest; default: not declared - priceBatch?: (input: PricerBatchPriceInput) => readonly TValuation[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - priceBatch(input): PricerBatchPriceInput; default: not declared - priceBatch(input).instruments: readonly TInstrument[]; default: not declared - priceBatch(input).observations: readonly MarketObservation[]; default: not declared - priceBatch(input).request?: PricerValuationRequest; default: not declared - requirements: (instrument: TInstrument) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - requirements(instrument): TInstrument; default: not declared - supports: (instrument: TInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - supports(instrument): TInstrument; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#PricerBatchPriceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One complete batch pricing request: one coherent observation set across many instruments. ```typescript /** One complete batch pricing request: one coherent observation set across many instruments. */ export interface PricerBatchPriceInput { instruments: readonly TInstrument[]; observations: readonly MarketObservation[]; request?: PricerValuationRequest; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instruments: readonly TInstrument[]; default: not declared - observations: readonly MarketObservation[]; default: not declared - request?: PricerValuationRequest; default: not declared - request.greeks?: boolean; default: not declared — Compute Greeks when the pricer's capability allows (adapter default follows the wrapped API). - request.seed?: number; default: not declared — Randomness seed — a non-negative safe integer when present. REQUIRED by `randomness: 'seeded'` pricers (a call without it is a typed `input.missing_field` refusal naming this field) and echoed at `assumptions.seed`, so every stochastic result names what reproduces it; IGNORED entirely by `randomness: 'none'` pricers (complete results with and without a seed are identical — verified). THE BATCH DERIVATION LAW (stated here so implementors can comply, verified by {@link validatePricer}): `priceBatch({ instruments, observations, request })` item `i` must deep-equal `price(instruments[i], observations, { ...request, seed: request.seed + i })` — one documented, stable derivation, so a batch replays item-by-item through the scalar path. A seeded batch whose `seed + instruments.length - 1` would exceed `Number.MAX_SAFE_INTEGER` is refused rather than letting derived seeds silently collide. ### @insiderfinance/totalfinance/core/pricing#PricerCapabilities Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Machine-readable pricer capabilities, behaviorally verified by {@link validatePricer} — a claim the kit cannot confirm fails conformance, so capabilities can never drift into marketing (the same discipline as the options package's `EngineCapabilities`). Deliberately NOT here: `price` (a Pricer that cannot price is not a Pricer — it is the one mandatory method) and `scenarios` (revaluing under shocked observations is what `price` over requirement-satisfied observations MEANS; every conformant pricer supports scenarios structurally, so a flag would be noise). ```typescript // ──────────────────────────────────────────────────────────────────────────────────────────────── // The Pricer protocol // ──────────────────────────────────────────────────────────────────────────────────────────────── /** * Machine-readable pricer capabilities, behaviorally verified by {@link validatePricer} — a claim * the kit cannot confirm fails conformance, so capabilities can never drift into marketing (the * same discipline as the options package's `EngineCapabilities`). * * Deliberately NOT here: `price` (a Pricer that cannot price is not a Pricer — it is the one * mandatory method) and `scenarios` (revaluing under shocked observations is what `price` over * requirement-satisfied observations MEANS; every conformant pricer supports scenarios * structurally, so a flag would be noise). */ export interface PricerCapabilities { /** * How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- * reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all * (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). */ readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; /** * Where the pricer's randomness lives — behaviorally verified, replacing the earlier * `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): * * - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, * and a supplied `request.seed` is IGNORED entirely (verified: identical results with and * without one). * - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's * `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` * refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed * calls return byte-identical COMPLETE results. Batches obey the derivation law documented * on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. * * There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce * under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is * marketing. Free-running randomness is non-conformant. */ readonly randomness: 'none' | 'seeded'; /** Whether `priceBatch` exists (one observation set, many instruments — the book fast path). */ readonly batch: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. ### @insiderfinance/totalfinance/core/pricing#PricerPriceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One complete scalar pricing request. ```typescript /** One complete scalar pricing request. */ export interface PricerPriceInput { instrument: TInstrument; /** Observations satisfying the pricer's declared requirements for this instrument. */ observations: readonly MarketObservation[]; request?: PricerValuationRequest; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrument: TInstrument; default: not declared - observations: readonly MarketObservation[]; default: not declared — Observations satisfying the pricer's declared requirements for this instrument. - request?: PricerValuationRequest; default: not declared - request.greeks?: boolean; default: not declared — Compute Greeks when the pricer's capability allows (adapter default follows the wrapped API). - request.seed?: number; default: not declared — Randomness seed — a non-negative safe integer when present. REQUIRED by `randomness: 'seeded'` pricers (a call without it is a typed `input.missing_field` refusal naming this field) and echoed at `assumptions.seed`, so every stochastic result names what reproduces it; IGNORED entirely by `randomness: 'none'` pricers (complete results with and without a seed are identical — verified). THE BATCH DERIVATION LAW (stated here so implementors can comply, verified by {@link validatePricer}): `priceBatch({ instruments, observations, request })` item `i` must deep-equal `price(instruments[i], observations, { ...request, seed: request.seed + i })` — one documented, stable derivation, so a batch replays item-by-item through the scalar path. A seeded batch whose `seed + instruments.length - 1` would exceed `Number.MAX_SAFE_INTEGER` is refused rather than letting derived seeds silently collide. ### @insiderfinance/totalfinance/core/pricing#PricerProbe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One caller-supplied behavioral fixture for {@link validatePricer}. The CALLER supplies the instrument and a full observation set — the kit cannot invent meaningful market data for an arbitrary domain (the same reasoning as `validateOptionPricingEngine`). ```typescript // ──────────────────────────────────────────────────────────────────────────────────────────────── // Conformance kit — caller-supplied fixtures, behavioral proof // ──────────────────────────────────────────────────────────────────────────────────────────────── /** * One caller-supplied behavioral fixture for {@link validatePricer}. The CALLER supplies the * instrument and a full observation set — the kit cannot invent meaningful market data for an * arbitrary domain (the same reasoning as `validateOptionPricingEngine`). */ export interface PricerProbe { /** An instrument the pricer claims to support. */ instrument: TInstrument; /** * Observations satisfying every REQUIRED declared requirement (optional ones too, when the * probe should exercise them). Extra observations beyond the declaration are allowed — the kit * uses them to prove the pricer does not read what it does not declare. */ observations: readonly MarketObservation[]; request?: PricerValuationRequest; /** * Assert that this probe's result carries a selection report of the given mode. Selection * disclosure is per-pricer (a single-model pricer has nothing to select), so the CALLER states * the expectation where one exists; the kit always validates a present report's grammar. */ expectSelection?: 'explicit' | 'automatic'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectSelection?: 'explicit' | 'automatic'; default: not declared — Assert that this probe's result carries a selection report of the given mode. Selection disclosure is per-pricer (a single-model pricer has nothing to select), so the CALLER states the expectation where one exists; the kit always validates a present report's grammar. - instrument: TInstrument; default: not declared — An instrument the pricer claims to support. - observations: readonly MarketObservation[]; default: not declared — Observations satisfying every REQUIRED declared requirement (optional ones too, when the probe should exercise them). Extra observations beyond the declaration are allowed — the kit uses them to prove the pricer does not read what it does not declare. - request?: PricerValuationRequest; default: not declared - request.greeks?: boolean; default: not declared — Compute Greeks when the pricer's capability allows (adapter default follows the wrapped API). - request.seed?: number; default: not declared — Randomness seed — a non-negative safe integer when present. REQUIRED by `randomness: 'seeded'` pricers (a call without it is a typed `input.missing_field` refusal naming this field) and echoed at `assumptions.seed`, so every stochastic result names what reproduces it; IGNORED entirely by `randomness: 'none'` pricers (complete results with and without a seed are identical — verified). THE BATCH DERIVATION LAW (stated here so implementors can comply, verified by {@link validatePricer}): `priceBatch({ instruments, observations, request })` item `i` must deep-equal `price(instruments[i], observations, { ...request, seed: request.seed + i })` — one documented, stable derivation, so a batch replays item-by-item through the scalar path. A seeded batch whose `seed + instruments.length - 1` would exceed `Number.MAX_SAFE_INTEGER` is refused rather than letting derived seeds silently collide. ### @insiderfinance/totalfinance/core/pricing#PricerValuationRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-call request flags. Closed; adapters map them onto their wrapped function's own options. ```typescript /** Per-call request flags. Closed; adapters map them onto their wrapped function's own options. */ export interface PricerValuationRequest { /** Compute Greeks when the pricer's capability allows (adapter default follows the wrapped API). */ greeks?: boolean; /** * Randomness seed — a non-negative safe integer when present. REQUIRED by * `randomness: 'seeded'` pricers (a call without it is a typed `input.missing_field` refusal * naming this field) and echoed at `assumptions.seed`, so every stochastic result names what * reproduces it; IGNORED entirely by `randomness: 'none'` pricers (complete results with and * without a seed are identical — verified). THE BATCH DERIVATION LAW (stated here so * implementors can comply, verified by {@link validatePricer}): * `priceBatch({ instruments, observations, request })` item `i` must deep-equal * `price(instruments[i], observations, { ...request, seed: request.seed + i })` — one * documented, stable derivation, so a batch replays item-by-item through the scalar path. A * seeded batch whose `seed + instruments.length - 1` would exceed `Number.MAX_SAFE_INTEGER` * is refused rather than letting derived seeds silently collide. */ seed?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks?: boolean; default: not declared — Compute Greeks when the pricer's capability allows (adapter default follows the wrapped API). - seed?: number; default: not declared — Randomness seed — a non-negative safe integer when present. REQUIRED by `randomness: 'seeded'` pricers (a call without it is a typed `input.missing_field` refusal naming this field) and echoed at `assumptions.seed`, so every stochastic result names what reproduces it; IGNORED entirely by `randomness: 'none'` pricers (complete results with and without a seed are identical — verified). THE BATCH DERIVATION LAW (stated here so implementors can comply, verified by {@link validatePricer}): `priceBatch({ instruments, observations, request })` item `i` must deep-equal `price(instruments[i], observations, { ...request, seed: request.seed + i })` — one documented, stable derivation, so a batch replays item-by-item through the scalar path. A seeded batch whose `seed + instruments.length - 1` would exceed `Number.MAX_SAFE_INTEGER` is refused rather than letting derived seeds silently collide. ### @insiderfinance/totalfinance/core/pricing#PricerValuationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Domain-neutral static floor for a Gate-C valuation result. `Computed` is the default, but domains may legitimately widen assumption vocabularies (fixed income uses `compounding: 'curve'`). Gate C consumes only this structural Law-2 floor and preserves every extra field, matching the existing `isComputed` runtime law. ```typescript /** * The minimal structural protocol a heterogeneous position is priced through (Gate C). * * Small on purpose: identity (`name`/`version`), verified `capabilities`, a `supports` gate, a * `requirements` declaration, and `price` returning the workspace's EXISTING result envelope * (the structural {@link PricerValuationResult} floor — Law 2's grammar, never a new envelope; * domain pricers preserve their richer result, e.g. options `PriceResult` or a bond result with * fixed-income-specific assumptions). That is enough * for Gate D's book to run one scenario across mixed instruments: gather the union of * requirements, satisfy them from one snapshot, shock observations, and call `price` per position * — while every direct function underneath stays independently callable. * * Implementations are ADAPTERS around existing public functions. If writing a Pricer requires * writing pricing math that does not already exist as a direct public function, the math lands as * a direct function first (the no-second-engine law). */ /** * Domain-neutral static floor for a Gate-C valuation result. * * `Computed` is the default, but domains may legitimately widen assumption vocabularies * (fixed income uses `compounding: 'curve'`). Gate C consumes only this structural Law-2 floor and * preserves every extra field, matching the existing `isComputed` runtime law. */ export interface PricerValuationResult { readonly value: number; readonly assumptions: { readonly conventionsVersion: string; }; readonly diagnostics: { readonly warnings: readonly QuantWarning[]; readonly engine?: string; readonly selection?: SelectionReport; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { readonly conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - diagnostics: { readonly warnings: readonly QuantWarning[]; readonly engine?: string; readonly selection?: SelectionReport; }; default: not declared - diagnostics.engine?: string; default: not declared - diagnostics.selection?: SelectionReport; default: not declared - diagnostics.selection.candidates?: readonly SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.warnings: readonly QuantWarning[]; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/core/pricing#RequirementOfKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The requirement-descriptor variant for one kind. ```typescript /** The requirement-descriptor variant for one kind. */ export type RequirementOfKind = Extract; ``` ### @insiderfinance/totalfinance/core/pricing#RiskFreeRateRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A continuously-compounded risk-free rate (decimal) for one currency. ```typescript /** A continuously-compounded risk-free rate (decimal) for one currency. */ export interface RiskFreeRateRequirement { kind: 'riskFreeRate'; currency: string; optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - kind: 'riskFreeRate'; default: not declared - optional?: boolean; default: not declared ### @insiderfinance/totalfinance/core/pricing#SelectionCandidate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One engine an automatic selection considered, with why it was or was not usable/chosen. ```typescript // ──────────────────────────────────────────────────────────────────────────────────────────────── // Engine-selection report — "you chose FOR me; show me why" // ──────────────────────────────────────────────────────────────────────────────────────────────── /** One engine an automatic selection considered, with why it was or was not usable/chosen. */ export interface SelectionCandidate { /** Engine name exactly as `diagnostics.engine` would report it. */ name: string; /** Whether the candidate could have priced this request at all. */ eligible: boolean; /** One sentence: why it was chosen, passed over, or ineligible. */ reason: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eligible: boolean; default: not declared — Whether the candidate could have priced this request at all. - name: string; default: not declared — Engine name exactly as `diagnostics.engine` would report it. - reason: string; default: not declared — One sentence: why it was chosen, passed over, or ineligible. ### @insiderfinance/totalfinance/core/pricing#SelectionReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The inspectable engine-selection report carried at `diagnostics.selection`. This FORMALIZES the options package's existing `diagnostics.engine` + `diagnostics.autoReason` disclosure — one grammar, not a parallel scheme: `selected.name` always agrees with `diagnostics.engine`, and for automatic mode `reason` is the same sentence `autoReason` carries. - `mode: 'explicit'` — the caller named the engine; nothing was considered, so `candidates` is ABSENT (an empty considered-list would fabricate deliberation that never happened). - `mode: 'automatic'` — the pricer chose, and must show its work: `candidates` lists every engine the routing considered, each with an eligibility verdict and a reason, and the selected engine appears among them as an eligible row. ```typescript /** * The inspectable engine-selection report carried at `diagnostics.selection`. This FORMALIZES the * options package's existing `diagnostics.engine` + `diagnostics.autoReason` disclosure — one * grammar, not a parallel scheme: `selected.name` always agrees with `diagnostics.engine`, and for * automatic mode `reason` is the same sentence `autoReason` carries. * * - `mode: 'explicit'` — the caller named the engine; nothing was considered, so `candidates` * is ABSENT (an empty considered-list would fabricate deliberation that never happened). * - `mode: 'automatic'` — the pricer chose, and must show its work: `candidates` lists every * engine the routing considered, each with an eligibility verdict and a reason, and the * selected engine appears among them as an eligible row. */ export interface SelectionReport { mode: 'explicit' | 'automatic'; selected: { name: string; version?: string; }; /** Why the selected engine answers this request. */ reason: string; /** Candidates an automatic selection considered; absent for explicit mode. */ candidates?: readonly SelectionCandidate[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - candidates?: readonly SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - mode: 'explicit' | 'automatic'; default: not declared - reason: string; default: not declared — Why the selected engine answers this request. - selected: { name: string; version?: string; }; default: not declared - selected.name: string; default: not declared - selected.version?: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#SpotRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The spot price of one underlying. ```typescript /** The spot price of one underlying. */ export interface SpotRequirement { kind: 'spot'; symbol: string; optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'spot'; default: not declared - optional?: boolean; default: not declared - symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#ValuationInstantRequirement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The instant a valuation is "as of". Required by any pricer that discounts or measures time to expiry. Making it a requirement — rather than ambient state — is what makes "no mutable global evaluation date" structural: two books can value the same instruments at two instants concurrently, and a scenario that shifts time shifts an observation, not a process global. ```typescript /** * The instant a valuation is "as of". Required by any pricer that discounts or measures time to * expiry. Making it a requirement — rather than ambient state — is what makes "no mutable global * evaluation date" structural: two books can value the same instruments at two instants * concurrently, and a scenario that shifts time shifts an observation, not a process global. */ export interface ValuationInstantRequirement { kind: 'valuationInstant'; /** `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. */ optional?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'valuationInstant'; default: not declared - optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. ### @insiderfinance/totalfinance/core/pricing#definePricer Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Structural, side-effect-free validation of a pricer definition (identity, capability grammar, method presence, batch coherence). Mirrors `defineOptionPricingEngine`: definition stays cheap and fixture-free; behavioral proof is the explicit opt-in ({@link validatePricer}), because the protocol cannot invent a valid instrument or market for an arbitrary domain. Returns a frozen pricer with bound methods. ```typescript export declare function definePricer>>(pricer: Pricer): Pricer; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (pricer): Pricer; default: not declared - (pricer).capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - (pricer).name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - (pricer).price: (input: PricerPriceInput) => TValuation; default: not declared - (pricer).priceBatch?: (input: PricerBatchPriceInput) => readonly TValuation[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - (pricer).requirements: (instrument: TInstrument) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - (pricer).supports: (instrument: TInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - (pricer).version: string; default: not declared - return.capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - return.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - return.price: (input: PricerPriceInput) => TValuation; default: not declared - return.priceBatch?: (input: PricerBatchPriceInput) => readonly TValuation[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - return.requirements: (instrument: TInstrument) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - return.supports: (instrument: TInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - return.version: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#missingRequirements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The REQUIRED requirements not satisfied by `observations` — a runner's pre-flight, so a book can report every gap at once instead of failing one missing observation at a time. Optional requirements never appear here. ```typescript export declare function missingRequirements(input: { requirements: readonly MarketRequirement[]; observations: readonly MarketObservation[]; }): readonly MarketRequirement[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { requirements: readonly MarketRequirement[]; observations: readonly MarketObservation[]; }; default: not declared - (input).observations: readonly MarketObservation[]; default: not declared - (input).requirements: readonly MarketRequirement[]; default: not declared ### @insiderfinance/totalfinance/core/pricing#observationFor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Find the observation satisfying `requirement`, or `undefined`. Pure lookup, no validation walk. ```typescript export declare function observationFor(observations: readonly MarketObservation[], requirement: MarketRequirement): MarketObservation | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (observations): readonly MarketObservation[]; default: not declared - (requirement): MarketRequirement; default: not declared - (requirement).currency: string; default: not declared - (requirement).curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - (requirement).expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - (requirement).kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - (requirement).optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - (requirement).strike: number; default: not declared - (requirement).symbol: string; default: not declared - return.requirement: (DiscountCurveRequirement) | (DividendYieldRequirement) | (ForwardRequirement) | (ImpliedVolatilityRequirement) | (RiskFreeRateRequirement) | (SpotRequirement) | (ValuationInstantRequirement); default: not declared - return.value: (RateCurve) | (number) | (string | number); default: not declared ### @insiderfinance/totalfinance/core/pricing#optionalObservationValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The value satisfying an OPTIONAL requirement, or `undefined` when absent. The consuming pricer owns disclosing whatever default it applies (the no-silent-economics law); this helper only makes "absent" unambiguous. ```typescript export declare function optionalObservationValue(functionName: string, observations: readonly MarketObservation[], requirement: MarketRequirement & { kind: K; }): ObservationValueByKind[K] | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (observations): readonly MarketObservation[]; default: not declared - (requirement): MarketRequirement & { kind: K; }; default: not declared ### @insiderfinance/totalfinance/core/pricing#requireObservationValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The value satisfying a REQUIRED requirement. Missing → the protocol's teaching error (`pricer.requirement_unsatisfied`, naming the exact descriptor and what was received) — the one error code the conformance kit demands, so adapters built on this helper conform by construction. ```typescript export declare function requireObservationValue(functionName: string, observations: readonly MarketObservation[], requirement: MarketRequirement & { kind: K; }): ObservationValueByKind[K]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (observations): readonly MarketObservation[]; default: not declared - (requirement): MarketRequirement & { kind: K; }; default: not declared ### @insiderfinance/totalfinance/core/pricing#requirementKey Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical identity of a requirement: kind plus subject fields in declaration order, e.g. `impliedVolatility(symbol=AAPL, strike=200, expiresAt=1789430400000)` or `discountCurve(curveId=USD.sofr, currency=USD)`. The `optional` marker is NOT part of identity — an optional and a required descriptor for the same coordinate match the same observation. This string is how runners match, deduplicate across a book, and how missing requirements are NAMED in teaching errors. ```typescript export declare function requirementKey(requirement: MarketRequirement): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (requirement): MarketRequirement; default: not declared - (requirement).currency: string; default: not declared - (requirement).curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - (requirement).expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - (requirement).kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - (requirement).optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - (requirement).strike: number; default: not declared - (requirement).symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#sameRequirement Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether two descriptors identify the same observation (same kind + subject; `optional` ignored). ```typescript export declare function sameRequirement(first: MarketRequirement, second: MarketRequirement): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): MarketRequirement; default: not declared - (first).currency: string; default: not declared - (first).curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - (first).expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - (first).kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - (first).optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - (first).strike: number; default: not declared - (first).symbol: string; default: not declared - (second): MarketRequirement; default: not declared - (second).currency: string; default: not declared - (second).curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - (second).expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - (second).kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - (second).optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - (second).strike: number; default: not declared - (second).symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#validateMarketObservation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one observation: a valid descriptor plus a value of that kind's type. ```typescript export declare function validateMarketObservation(functionName: string, label: string, observation: unknown): MarketObservation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (observation): unknown; default: not declared - return.requirement: (DiscountCurveRequirement) | (DividendYieldRequirement) | (ForwardRequirement) | (ImpliedVolatilityRequirement) | (RiskFreeRateRequirement) | (SpotRequirement) | (ValuationInstantRequirement); default: not declared - return.value: (RateCurve) | (number) | (string | number); default: not declared ### @insiderfinance/totalfinance/core/pricing#validateMarketRequirement Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one requirement descriptor: known kind, closed keys, correctly-typed subject fields. Used by the helpers below and by the conformance kit; adapters get it for free through them. ```typescript export declare function validateMarketRequirement(functionName: string, label: string, requirement: unknown): MarketRequirement; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (requirement): unknown; default: not declared - return.currency: string; default: not declared - return.curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - return.expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - return.kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - return.optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - return.strike: number; default: not declared - return.symbol: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#validatePricer Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Behaviorally verify a Pricer against CALLER-SUPPLIED fixtures. Every failure teaches: the error names the probe, the broken law, and the fix. Per probe, the kit proves: 1. `supports(instrument)` returns `true` (a probe instrument the pricer rejects is a fixture error, reported as such); 2. `requirements(instrument)` returns valid, duplicate-free descriptors and is STABLE across calls — a runner must be able to gather once and price after; 3. pricing with exactly the declared observations succeeds and returns the Law-2 envelope (`value`/`assumptions`/`diagnostics`) with a fully finite success (Law 7, via the same walker the library uses); 4. requirement honesty, both directions: each REQUIRED observation removed one at a time makes `price` throw `pricer.requirement_unsatisfied` naming the requirement (never a silent guess); each OPTIONAL observation removed still succeeds; and undeclared observations (the probe's extras plus an injected foreign one) leave the COMPLETE result identical — compared as canonical JSON over the whole envelope (value, greeks, assumptions, diagnostics), so a pricer cannot consume what it does not declare and hide the read in a field the probe forgot to look at; 5. capability honesty (randomness — 2026-08-23, second external review; every comparison is the COMPLETE canonical result, never `.value` alone): for `randomness: 'none'`, a repeat call is byte-identical AND a supplied `request.seed` changes nothing (the seed-ignoring law); for `randomness: 'seeded'`, every law is proved under a fixed seed (the probe's `request.seed`, else {@link CONFORMANCE_PROBE_SEED}): a call WITHOUT a seed is a typed `input.missing_field` refusal naming `request.seed`, the seed is echoed at `assumptions.seed`, two same-seed calls are byte-identical, undeclared-observation independence holds under that seed, and `priceBatch` obeys the documented derivation law — item `i` deep-equals the scalar result under `seed + i` (a two-copy batch is probed so the derivation is actually exercised; a probe seed leaving no safe-integer room for `seed + i` is refused, typed). `greeks` mode → a NON-EMPTY greeks object with finite-or-null leaves exactly when claimed (`{}` measures nothing and fails); `batch` → `priceBatch` exists and agrees with `price` COMPLETE-result-for-result on the probe — and (2026-08-23, fourth external review) EVERY seed law proved against `price()` is proved against `priceBatch()` too, on an at-least-two-instrument batch: a `'seeded'` batch without `request.seed` must refuse exactly as the scalar path does (a silently defaulted seed is unreproducible), a `'none'` batch must ignore a supplied seed item-for-item, and undeclared-observation independence must hold on the batch path in both modes; 6. selection honesty: any `diagnostics.selection` present validates against the report grammar and agrees with `diagnostics.engine`; `expectSelection` makes the report mandatory. Returns the validated (frozen, bound) pricer for inline use. ```typescript export declare function validatePricer>>(pricer: Pricer, probes: readonly PricerProbe[]): Pricer; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (pricer): Pricer; default: not declared - (pricer).capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - (pricer).name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - (pricer).price: (input: PricerPriceInput) => TValuation; default: not declared - (pricer).priceBatch?: (input: PricerBatchPriceInput) => readonly TValuation[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - (pricer).requirements: (instrument: TInstrument) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - (pricer).supports: (instrument: TInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - (pricer).version: string; default: not declared - (probes): readonly PricerProbe[]; default: not declared - return.capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - return.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - return.price: (input: PricerPriceInput) => TValuation; default: not declared - return.priceBatch?: (input: PricerBatchPriceInput) => readonly TValuation[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - return.requirements: (instrument: TInstrument) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - return.supports: (instrument: TInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - return.version: string; default: not declared ### @insiderfinance/totalfinance/core/pricing#validateSelectionReport Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a selection report's grammar (shape, mode/candidates coherence, chosen-among-candidates). ```typescript export declare function validateSelectionReport(functionName: string, report: unknown): SelectionReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (report): unknown; default: not declared - return.candidates?: readonly SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - return.mode: 'explicit' | 'automatic'; default: not declared - return.reason: string; default: not declared — Why the selected engine answers this request. - return.selected: { name: string; version?: string; }; default: not declared - return.selected.name: string; default: not declared - return.selected.version?: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/core/schema ### @insiderfinance/totalfinance/core/schema#ArraySchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ArraySchema extends BaseSchema { constructor(item: BaseSchema, bounds?: { min?: number; max?: number; }); readonly kind: 'array'; min(minimum: number): ArraySchema; max(maximum: number): ArraySchema; _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; readonly isOptional: boolean; description: string | undefined; parse(input: unknown, options?: ParseOptions): Item[]; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; optional(): OptionalSchema; describe(description: string): ArraySchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bounds)?: { min?: number; max?: number; }; default: not declared - (bounds).max?: number; default: not declared - (bounds).min?: number; default: not declared - (item): BaseSchema; default: not declared - (item)._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - (item)._toJSONSchema: () => JSONSchema; default: not declared — @internal - (item).describe: (description: string) => BaseSchema; default: not declared - (item).description: string | undefined; default: not declared - (item).isOptional: boolean; default: not declared - (item).kind: string; default: not declared - (item).optional: () => OptionalSchema; default: not declared - (item).parse: (input: unknown, options?: ParseOptions) => Item; default: not declared - (item).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - (item).toJSONSchema: () => JSONSchema; default: not declared - (item).~standard: StandardSchemaV1Props; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: Item[]; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => ArraySchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'array'; default: not declared - max: (maximum: number) => ArraySchema; default: not declared - max(maximum): number; default: not declared - min: (minimum: number) => ArraySchema; default: not declared - min(minimum): number; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => Item[] | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => Item[]; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => ArraySchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'array'; default: not declared - return.max: (maximum: number) => ArraySchema; default: not declared - return.min: (minimum: number) => ArraySchema; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => Item[]; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: Item[]; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: Item[]; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: Item[]; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: Item[]; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#BarSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const BarSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - safeParse().return.data: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#BooleanSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BooleanSchema extends BaseSchema { constructor(); _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; describe(description: string): BooleanSchema; description: string | undefined; readonly isOptional: boolean; readonly kind: 'boolean'; optional(): OptionalSchema; parse(input: unknown, options?: ParseOptions): boolean; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: boolean; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => BooleanSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'boolean'; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => boolean | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => boolean; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => BooleanSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'boolean'; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => boolean; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: boolean; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: boolean; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: boolean; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: boolean; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#CorporateActionSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const CorporateActionSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined>; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - safeParse().return.data: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#DividendSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const DividendSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - safeParse().return.data: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#EnumSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class EnumSchema extends BaseSchema { constructor(values: readonly V[]); readonly kind: 'enum'; _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; readonly isOptional: boolean; description: string | undefined; parse(input: unknown, options?: ParseOptions): V; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; optional(): OptionalSchema; describe(description: string): EnumSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (values): readonly V[]; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: V; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => EnumSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'enum'; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => V | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => V; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => EnumSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'enum'; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => V; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: V; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: V; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: V; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: V; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#Infer Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extract the validated output type of a schema. ```typescript /** Extract the validated output type of a schema. */ export type Infer = S extends Schema ? O : never; ``` ### @insiderfinance/totalfinance/core/schema#InferObject Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type InferObject>> = Prettify<{ [K in RequiredShapeKeys]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; }>; ``` ### @insiderfinance/totalfinance/core/schema#JSONSchema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#JSONSchema`. ### @insiderfinance/totalfinance/core/schema#JSONSchemaTypeName Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A pragmatic JSON Schema (Draft 2020-12) shape — enough for MCP tools and docs. ```typescript /** A pragmatic JSON Schema (Draft 2020-12) shape — enough for MCP tools and docs. */ export type JSONSchemaTypeName = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null'; ``` ### @insiderfinance/totalfinance/core/schema#JSON_SCHEMA_MAX_DEPTH Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The deepest nesting a document may declare; deeper is a cycle, not a schema. ```typescript export declare const JSON_SCHEMA_MAX_DEPTH: 64; ``` ### @insiderfinance/totalfinance/core/schema#LiteralSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class LiteralSchema extends BaseSchema { constructor(value: V); readonly kind: 'literal'; _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; readonly isOptional: boolean; description: string | undefined; parse(input: unknown, options?: ParseOptions): V; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; optional(): OptionalSchema; describe(description: string): LiteralSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): V; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: V; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => LiteralSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'literal'; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => V | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => V; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => LiteralSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'literal'; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => V; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: V; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: V; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: V; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: V; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#NumberConstraints Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------- // number // --------------------------------------------------------------------------- export interface NumberConstraints { integer?: boolean; min?: number; max?: number; exclusiveMin?: number; exclusiveMax?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exclusiveMax?: number; default: not declared - exclusiveMin?: number; default: not declared - integer?: boolean; default: not declared - max?: number; default: not declared - min?: number; default: not declared ### @insiderfinance/totalfinance/core/schema#NumberSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class NumberSchema extends BaseSchema { constructor(constraints?: NumberConstraints); _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; describe(description: string): NumberSchema; description: string | undefined; gt(value: number): NumberSchema; integer(): NumberSchema; readonly isOptional: boolean; readonly kind: 'number'; lt(value: number): NumberSchema; max(value: number): NumberSchema; min(value: number): NumberSchema; nonnegative(): NumberSchema; optional(): OptionalSchema; parse(input: unknown, options?: ParseOptions): number; positive(): NumberSchema; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (constraints)?: NumberConstraints; default: not declared - (constraints).exclusiveMax?: number; default: not declared - (constraints).exclusiveMin?: number; default: not declared - (constraints).integer?: boolean; default: not declared - (constraints).max?: number; default: not declared - (constraints).min?: number; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: number; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => NumberSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - gt: (value: number) => NumberSchema; default: not declared - gt(value): number; default: not declared - integer: () => NumberSchema; default: not declared - isOptional: boolean; default: not declared - kind: 'number'; default: not declared - lt: (value: number) => NumberSchema; default: not declared - lt(value): number; default: not declared - max: (value: number) => NumberSchema; default: not declared - max(value): number; default: not declared - min: (value: number) => NumberSchema; default: not declared - min(value): number; default: not declared - nonnegative: () => NumberSchema; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => number | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => number; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - positive: () => NumberSchema; default: not declared - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => NumberSchema; default: not declared - return.description: string | undefined; default: not declared - return.gt: (value: number) => NumberSchema; default: not declared - return.integer: () => NumberSchema; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'number'; default: not declared - return.lt: (value: number) => NumberSchema; default: not declared - return.max: (value: number) => NumberSchema; default: not declared - return.min: (value: number) => NumberSchema; default: not declared - return.nonnegative: () => NumberSchema; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => number; default: not declared - return.positive: () => NumberSchema; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: number; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: number; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: number; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: number; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#ObjectSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ObjectSchema>> extends BaseSchema< InferObject > { constructor(shape: Shape); readonly kind: 'object'; open(): ObjectSchema; _check(input: unknown, context: SchemaCheckContext): CheckResult>; _toJSONSchema(): JSONSchema; readonly isOptional: boolean; description: string | undefined; parse(input: unknown, options?: ParseOptions): { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; safeParse(input: unknown, options?: ParseOptions): SafeParseResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; toJSONSchema(): JSONSchema; optional(): OptionalSchema<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; describe(description: string): ObjectSchema; ~standard: StandardSchemaV1Props>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (shape): Shape; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult>; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => ObjectSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => ObjectSchema; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => OptionalSchema<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; } | undefined>; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; } | undefined>; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; } | undefined>; default: not declared - parse: (input: unknown, options?: ParseOptions) => { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult>; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => ObjectSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'object'; default: not declared - return.open: () => ObjectSchema; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - return.optional: () => OptionalSchema<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - safeParse().return.data: { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#OptionContractSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). E2 — the contract schema validates the RESOLVED ARTIFACT cross-field, not just field shapes: after the structural parse, `validateResolvedExpiry` confirms the label ↔ instant ↔ convention triple is internally consistent (impossible dates, mismatched epochs, and contradictory conventions all reject), and the parsed value is DEEP-frozen — the artifact (including `deliverable` and its `shares[]`) stays immutable through the schema boundary exactly as it left the builders. ```typescript export declare const OptionContractSchema: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - safeParse().return.data: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#OptionQuoteSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const OptionQuoteSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - safeParse().return.data: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#OptionTradeSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const OptionTradeSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - safeParse().return.data: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#OptionalSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class OptionalSchema extends BaseSchema { constructor(inner: BaseSchema); readonly isOptional: true; readonly kind: 'optional'; _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; optional(): OptionalSchema; description: string | undefined; parse(input: unknown, options?: ParseOptions): T | undefined; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; describe(description: string): OptionalSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (inner): BaseSchema; default: not declared - (inner)._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - (inner)._toJSONSchema: () => JSONSchema; default: not declared — @internal - (inner).describe: (description: string) => BaseSchema; default: not declared - (inner).description: string | undefined; default: not declared - (inner).isOptional: boolean; default: not declared - (inner).kind: string; default: not declared - (inner).optional: () => OptionalSchema; default: not declared - (inner).parse: (input: unknown, options?: ParseOptions) => T; default: not declared - (inner).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - (inner).toJSONSchema: () => JSONSchema; default: not declared - (inner).~standard: StandardSchemaV1Props; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: T | undefined; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => OptionalSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: true; default: not declared - kind: 'optional'; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult<(T | undefined) | undefined>; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema<(T | undefined) | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => T | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => T | undefined; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => OptionalSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: true; default: not declared - return.kind: 'optional'; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => T | undefined; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: T | undefined; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: T | undefined; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: T | undefined; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: T | undefined; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#OrderBookLevelSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const OrderBookLevelSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { exchange?: string; price: number; size: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { exchange?: string; price: number; size: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ exchange?: string; price: number; size: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { exchange?: string; price: number; size: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ exchange?: string; price: number; size: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ exchange?: string; price: number; size: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { exchange?: string; price: number; size: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ exchange?: string; price: number; size: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { exchange?: string; price: number; size: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ exchange?: string; price: number; size: number; }>; default: not declared - safeParse().return.data: { exchange?: string; price: number; size: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { exchange?: string; price: number; size: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { exchange?: string; price: number; size: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ exchange?: string; price: number; size: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { exchange?: string; price: number; size: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#OrderBookSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const OrderBookSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ exchange?: string; price: number; size: number; }>; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }>; default: not declared - safeParse().return.data: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { asks: { exchange?: string; price: number; size: number; }[]; bids: { exchange?: string; price: number; size: number; }[]; symbol: string; timestampMs: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#ParseOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ParseOptions { /** Validation strictness (spec §6). Defaults to `strict`. */ mode?: ValidationMode; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. ### @insiderfinance/totalfinance/core/schema#QuoteSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const QuoteSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - safeParse().return.data: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#RateCurvePointSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). OPEN (2026-08-23, fourth external review): `RateCurvePoint` entries are documented "open to vendor decoration (Law 12)" and the runtime curve validator accepts a decorated pillar, but this schema was CLOSED — the one schema-vs-runtime openness misstatement in this module. `.open()` validates the declared pillar shape and preserves decoration, and the emitted JSON Schema now says `additionalProperties: true` instead of lying `false`. ```typescript export declare const RateCurvePointSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { date: string; zeroRate: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { date: string; zeroRate: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ date: string; zeroRate: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { date: string; zeroRate: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ date: string; zeroRate: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ date: string; zeroRate: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { date: string; zeroRate: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ date: string; zeroRate: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { date: string; zeroRate: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ date: string; zeroRate: number; }>; default: not declared - safeParse().return.data: { date: string; zeroRate: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { date: string; zeroRate: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { date: string; zeroRate: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ date: string; zeroRate: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { date: string; zeroRate: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#RateCurveSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const RateCurveSchema: import('@insiderfinance/totalfinance/core/schema').Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core').RateCurve | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - parse().return.asOf: number; default: not declared - parse().return.compounding: InterestCompounding; default: not declared - parse().return.currency: string; default: not declared - parse().return.dayCount: DayCount; default: not declared - parse().return.interpolation?: string; default: not declared - parse().return.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: import('@insiderfinance/totalfinance/core').RateCurve; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - ~standard.types.output.asOf: number; default: not declared - ~standard.types.output.compounding: InterestCompounding; default: not declared - ~standard.types.output.compounding.periodsPerYear: number; default: not declared - ~standard.types.output.compounding.type: 'periodic'; default: not declared - ~standard.types.output.currency: string; default: not declared - ~standard.types.output.dayCount: DayCount; default: not declared - ~standard.types.output.interpolation?: string; default: not declared - ~standard.types.output.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#RawFundamentalsRecordSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const RawFundamentalsRecordSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; fiscalPeriod?: string; symbol: string; } | undefined>; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - safeParse().return.data: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; fiscalPeriod?: string; symbol: string; }>; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#RecordSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An object with arbitrary string keys whose values all satisfy `value` (e.g. `Fundamentals.fields`). ```typescript export declare class RecordSchema extends BaseSchema> { constructor(value: BaseSchema); readonly kind: 'record'; _check(input: unknown, context: SchemaCheckContext): CheckResult>; _toJSONSchema(): JSONSchema; readonly isOptional: boolean; description: string | undefined; parse(input: unknown, options?: ParseOptions): Record; safeParse(input: unknown, options?: ParseOptions): SafeParseResult>; toJSONSchema(): JSONSchema; optional(): OptionalSchema>; describe(description: string): RecordSchema; ~standard: StandardSchemaV1Props>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): BaseSchema; default: not declared - (value)._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - (value)._toJSONSchema: () => JSONSchema; default: not declared — @internal - (value).describe: (description: string) => BaseSchema; default: not declared - (value).description: string | undefined; default: not declared - (value).isOptional: boolean; default: not declared - (value).kind: string; default: not declared - (value).optional: () => OptionalSchema; default: not declared - (value).parse: (input: unknown, options?: ParseOptions) => V; default: not declared - (value).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - (value).toJSONSchema: () => JSONSchema; default: not declared - (value).~standard: StandardSchemaV1Props; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult>; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: Record; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => RecordSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'record'; default: not declared - optional: () => OptionalSchema>; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult | undefined>; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => Record | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult | undefined>; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props | undefined>; default: not declared - parse: (input: unknown, options?: ParseOptions) => Record; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult>; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => RecordSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'record'; default: not declared - return.optional: () => OptionalSchema>; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => Record; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult>; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props>; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult>; default: not declared - safeParse().return.data: Record; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props>; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: Record; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: Record; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: Record; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#SafeParseResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SafeParseResult = { success: true; data: T; } | { success: false; issues: SchemaIssue[]; error: InputError; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - data: T; default: not declared - error: InputError; default: not declared - error.code: string; default: not declared - error.context?: Record; default: not declared - error.toJSON: () => { serialization: 1; name: string; code: string; message: string; context?: Record; }; default: not declared — Versioned JSON shape. `message` is a non-enumerable Error property, so a bare `JSON.stringify(error)` used to drop the one field a human needs; `serialization: 1` lets a consumer detect future shape changes. - error.toJSON().return.code: string; default: not declared - error.toJSON().return.context?: Record; default: not declared - error.toJSON().return.message: string; default: not declared - error.toJSON().return.name: string; default: not declared - error.toJSON().return.serialization: 1; default: not declared - issues: SchemaIssue[]; default: not declared - success: (false) | (true); default: not declared ### @insiderfinance/totalfinance/core/schema#Schema Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Public schema interface. Concrete builder implementations stay internal. ```typescript /** Public schema interface. Concrete builder implementations stay internal. */ export interface Schema extends StandardSchemaV1 { readonly kind: string; readonly isOptional: boolean; parse(input: unknown, options?: ParseOptions): Output; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; optional(): Schema; describe(description: string): this; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema<(Output | undefined) | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => Output | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => Output; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: Output; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: Output; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: Output; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: Output; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#SchemaCheckContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SchemaCheckContext`. ### @insiderfinance/totalfinance/core/schema#SchemaIssue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SchemaIssue { code: string; message: string; path: (string | number)[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared - message: string; default: not declared - path: (string | number)[]; default: not declared ### @insiderfinance/totalfinance/core/schema#StandardSchemaV1 Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Standard Schema v1 interface (https://standardschema.dev). TotalFinance schemas implement this so users can plug them into any Standard-Schema-aware tool (form libraries, RPC frameworks, etc.) without TotalFinance taking a dependency on a validator. ```typescript /** * The Standard Schema v1 interface (https://standardschema.dev). * * TotalFinance schemas implement this so users can plug them into any Standard-Schema-aware tool * (form libraries, RPC frameworks, etc.) without TotalFinance taking a dependency on a validator. */ export interface StandardSchemaV1 { readonly '~standard': StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: StandardSchemaV1Types | undefined; default: not declared - ~standard.types.input: Input; default: not declared - ~standard.types.output: Output; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: Output; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#StandardSchemaV1Issue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StandardSchemaV1Issue { readonly message: string; readonly path?: ReadonlyArray | undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - message: string; default: not declared - path?: readonly PropertyKey[] | undefined; default: not declared ### @insiderfinance/totalfinance/core/schema#StandardSchemaV1Props Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StandardSchemaV1Props { readonly version: 1; readonly vendor: string; readonly validate: (value: unknown) => StandardSchemaV1Result; readonly types?: StandardSchemaV1Types | undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - types?: StandardSchemaV1Types | undefined; default: not declared - types.input: Input; default: not declared - types.output: Output; default: not declared - validate: (value: unknown) => StandardSchemaV1Result; default: not declared - validate().return.issues?: (readonly StandardSchemaV1Issue[]) | (undefined); default: not declared - validate().return.value: Output; default: not declared - validate(value): unknown; default: not declared - vendor: string; default: not declared - version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#StandardSchemaV1Result Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type StandardSchemaV1Result = StandardSchemaV1SuccessResult | StandardSchemaV1FailureResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - issues?: (readonly StandardSchemaV1Issue[]) | (undefined); default: not declared - value: Output; default: not declared ### @insiderfinance/totalfinance/core/schema#StringConstraints Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------- // string // --------------------------------------------------------------------------- export interface StringConstraints { minLength?: number; maxLength?: number; pattern?: string; format?: 'date' | 'date-time' | string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - format?: string; default: not declared - maxLength?: number; default: not declared - minLength?: number; default: not declared - pattern?: string; default: not declared ### @insiderfinance/totalfinance/core/schema#StringSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class StringSchema extends BaseSchema { constructor(constraints?: StringConstraints); _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; date(): StringSchema; datetime(): StringSchema; describe(description: string): StringSchema; description: string | undefined; readonly isOptional: boolean; readonly kind: 'string'; max(length: number): StringSchema; min(length: number): StringSchema; nonempty(): StringSchema; optional(): OptionalSchema; parse(input: unknown, options?: ParseOptions): string; regex(pattern: RegExp | string): StringSchema; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (constraints)?: StringConstraints; default: not declared - (constraints).format?: string; default: not declared - (constraints).maxLength?: number; default: not declared - (constraints).minLength?: number; default: not declared - (constraints).pattern?: string; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: string; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - date: () => StringSchema; default: not declared - datetime: () => StringSchema; default: not declared - describe: (description: string) => StringSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'string'; default: not declared - max: (length: number) => StringSchema; default: not declared - max(length): number; default: not declared - min: (length: number) => StringSchema; default: not declared - min(length): number; default: not declared - nonempty: () => StringSchema; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => string | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => string; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - regex: (pattern: RegExp | string) => StringSchema; default: not declared - regex(pattern): string | RegExp; default: not declared - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.date: () => StringSchema; default: not declared - return.datetime: () => StringSchema; default: not declared - return.describe: (description: string) => StringSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'string'; default: not declared - return.max: (length: number) => StringSchema; default: not declared - return.min: (length: number) => StringSchema; default: not declared - return.nonempty: () => StringSchema; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => string; default: not declared - return.regex: (pattern: RegExp | string) => StringSchema; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: string; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: string; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: string; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: string; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#TradeSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TradeSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - safeParse().return.data: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#UnionSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class UnionSchema extends BaseSchema { constructor(members: BaseSchema[]); readonly kind: 'union'; _check(input: unknown, context: SchemaCheckContext): CheckResult; _toJSONSchema(): JSONSchema; readonly isOptional: boolean; description: string | undefined; parse(input: unknown, options?: ParseOptions): T; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; optional(): OptionalSchema; describe(description: string): UnionSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (members): BaseSchema[]; default: not declared - _check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: T; default: not declared - _check(context): SchemaCheckContext; default: not declared - _check(context).mode: ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => UnionSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'union'; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => T | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => T; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => UnionSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'union'; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => T; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: T; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: T; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: T; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: T; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#UnknownSchema Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Accepts any value unchanged. For genuinely open payloads (e.g. `Record` maps). ```typescript export declare class UnknownSchema extends BaseSchema { constructor(); _check(input: unknown): CheckResult; _toJSONSchema(): JSONSchema; describe(description: string): UnknownSchema; description: string | undefined; readonly isOptional: boolean; readonly kind: 'unknown'; optional(): OptionalSchema; parse(input: unknown, options?: ParseOptions): unknown; safeParse(input: unknown, options?: ParseOptions): SafeParseResult; toJSONSchema(): JSONSchema; ~standard: StandardSchemaV1Props; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown) => CheckResult; default: not declared — @internal - _check().return.issues: SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: unknown; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => UnknownSchema; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'unknown'; default: not declared - optional: () => OptionalSchema; default: not declared - optional().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - optional().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => OptionalSchema; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => OptionalSchema; default: not declared - optional().return.parse: (input: unknown, options?: ParseOptions) => unknown; default: not declared - optional().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - optional().return.toJSONSchema: () => JSONSchema; default: not declared - optional().return.~standard: StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: ParseOptions) => unknown; default: not declared - parse(input): unknown; default: not declared - parse(options)?: ParseOptions | undefined; default: not declared - parse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - return._check: (input: unknown) => CheckResult; default: not declared — @internal - return._toJSONSchema: () => JSONSchema; default: not declared — @internal - return.describe: (description: string) => UnknownSchema; default: not declared - return.description: string | undefined; default: not declared - return.isOptional: boolean; default: not declared - return.kind: 'unknown'; default: not declared - return.optional: () => OptionalSchema; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => unknown; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared - safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - safeParse().return.data: unknown; default: not declared - safeParse().return.error: InputError; default: not declared - safeParse().return.issues: SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: ParseOptions | undefined; default: not declared - safeParse(options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: unknown; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: unknown; default: not declared - ~standard.validate: (value: unknown) => StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: unknown; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#ValidationMode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ValidationMode = 'strict' | 'coerce' | 'passthrough' | 'off'; ``` ### @insiderfinance/totalfinance/core/schema#__TOTALFINANCE_SCHEMA_FACADE__ Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Marker so the bundle harness can prove this module never leaks into a compute entrypoint. ```typescript export declare const __TOTALFINANCE_SCHEMA_FACADE__: 'totalfinance/schema'; ``` ### @insiderfinance/totalfinance/core/schema#coreSchemas Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convenience namespace of the core payload schemas. Covers every exported market-data object type, so the schema/interface drift test (`schema-parity.test.ts`) can enumerate it exhaustively (WS3.10). ```typescript export declare const coreSchemas: { readonly Bar: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly Quote: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly Trade: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly OptionContract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; readonly OptionQuote: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly OptionTrade: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly Dividend: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; readonly CorporateAction: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; readonly RateCurvePoint: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; readonly RateCurve: import('@insiderfinance/totalfinance/core/schema').Schema; readonly OrderBookLevel: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly OrderBook: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; }>; readonly RawFundamentalsRecord: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - Bar: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - Bar._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }; }; default: not declared — @internal - Bar._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Bar._check().return.ok: (false) | (true); default: not declared - Bar._check().return.value: { symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }; default: not declared - Bar._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - Bar._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - Bar._check(context).path: (string | number)[]; default: not declared - Bar._check(input): unknown; default: not declared - Bar._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Bar._toJSONSchema().return.$id?: string; default: not declared - Bar._toJSONSchema().return.$schema?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Bar._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Bar._toJSONSchema().return.additionalProperties.description?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Bar._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.format?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Bar._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Bar._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Bar._toJSONSchema().return.additionalProperties.title?: string; default: not declared - Bar._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Bar._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar._toJSONSchema().return.const?: unknown; default: not declared - Bar._toJSONSchema().return.default?: unknown; default: not declared - Bar._toJSONSchema().return.description?: string; default: not declared - Bar._toJSONSchema().return.enum?: unknown[]; default: not declared - Bar._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Bar._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Bar._toJSONSchema().return.format?: string; default: not declared - Bar._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar._toJSONSchema().return.maxItems?: number; default: not declared - Bar._toJSONSchema().return.maxLength?: number; default: not declared - Bar._toJSONSchema().return.maximum?: number; default: not declared - Bar._toJSONSchema().return.minItems?: number; default: not declared - Bar._toJSONSchema().return.minLength?: number; default: not declared - Bar._toJSONSchema().return.minimum?: number; default: not declared - Bar._toJSONSchema().return.multipleOf?: number; default: not declared - Bar._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar._toJSONSchema().return.pattern?: string; default: not declared - Bar._toJSONSchema().return.properties?: Record; default: not declared - Bar._toJSONSchema().return.required?: string[]; default: not declared - Bar._toJSONSchema().return.title?: string; default: not declared - Bar._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Bar.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - Bar.describe(description): string; default: not declared - Bar.description: string | undefined; default: not declared - Bar.isOptional: boolean; default: not declared - Bar.kind: 'object'; default: not declared - Bar.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; open: import('@insiderfinance/totalfinance/core/schema').NumberSchema; high: import('@insiderfinance/totalfinance/core/schema').NumberSchema; low: import('@insiderfinance/totalfinance/core/schema').NumberSchema; close: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; vwap: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; adjusted: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - Bar.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }>; default: not declared - Bar.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined; }; default: not declared — @internal - Bar.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Bar.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - Bar.optional().return.description: string | undefined; default: not declared - Bar.optional().return.isOptional: true; default: not declared - Bar.optional().return.kind: 'optional'; default: not declared - Bar.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; } | undefined>; default: not declared - Bar.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined; default: not declared - Bar.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; } | undefined>; default: not declared - Bar.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Bar.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }; default: not declared - Bar.parse(input): unknown; default: not declared - Bar.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Bar.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Bar.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - Bar.safeParse().return.data: { symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }; default: not declared - Bar.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - Bar.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Bar.safeParse().return.success: (false) | (true); default: not declared - Bar.safeParse(input): unknown; default: not declared - Bar.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Bar.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Bar.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar.toJSONSchema().return.$id?: string; default: not declared - Bar.toJSONSchema().return.$schema?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Bar.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Bar.toJSONSchema().return.additionalProperties.description?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Bar.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.format?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Bar.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Bar.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Bar.toJSONSchema().return.additionalProperties.title?: string; default: not declared - Bar.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Bar.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar.toJSONSchema().return.const?: unknown; default: not declared - Bar.toJSONSchema().return.default?: unknown; default: not declared - Bar.toJSONSchema().return.description?: string; default: not declared - Bar.toJSONSchema().return.enum?: unknown[]; default: not declared - Bar.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Bar.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Bar.toJSONSchema().return.format?: string; default: not declared - Bar.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Bar.toJSONSchema().return.maxItems?: number; default: not declared - Bar.toJSONSchema().return.maxLength?: number; default: not declared - Bar.toJSONSchema().return.maximum?: number; default: not declared - Bar.toJSONSchema().return.minItems?: number; default: not declared - Bar.toJSONSchema().return.minLength?: number; default: not declared - Bar.toJSONSchema().return.minimum?: number; default: not declared - Bar.toJSONSchema().return.multipleOf?: number; default: not declared - Bar.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Bar.toJSONSchema().return.pattern?: string; default: not declared - Bar.toJSONSchema().return.properties?: Record; default: not declared - Bar.toJSONSchema().return.required?: string[]; default: not declared - Bar.toJSONSchema().return.title?: string; default: not declared - Bar.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Bar.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Bar.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }; }) | undefined; default: not declared - Bar.~standard.types.input: unknown; default: not declared - Bar.~standard.types.output: { symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }; default: not declared - Bar.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; close: number; high: number; low: number; open: number; symbol: string; timestampMs: number; volume?: number; vwap?: number; }>; default: not declared - Bar.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - Bar.~standard.validate().return.value: { symbol: string; open: number; close: number; timestampMs: number; high: number; low: number; adjusted?: boolean; volume?: number; vwap?: number; }; default: not declared - Bar.~standard.validate(value): unknown; default: not declared - Bar.~standard.vendor: string; default: not declared - Bar.~standard.version: 1; default: not declared - CorporateAction: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; default: not declared - CorporateAction._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }; }; default: not declared — @internal - CorporateAction._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - CorporateAction._check().return.ok: (false) | (true); default: not declared - CorporateAction._check().return.value: { symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }; default: not declared - CorporateAction._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - CorporateAction._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - CorporateAction._check(context).path: (string | number)[]; default: not declared - CorporateAction._check(input): unknown; default: not declared - CorporateAction._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - CorporateAction._toJSONSchema().return.$id?: string; default: not declared - CorporateAction._toJSONSchema().return.$schema?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.description?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.format?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.title?: string; default: not declared - CorporateAction._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - CorporateAction._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction._toJSONSchema().return.const?: unknown; default: not declared - CorporateAction._toJSONSchema().return.default?: unknown; default: not declared - CorporateAction._toJSONSchema().return.description?: string; default: not declared - CorporateAction._toJSONSchema().return.enum?: unknown[]; default: not declared - CorporateAction._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - CorporateAction._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - CorporateAction._toJSONSchema().return.format?: string; default: not declared - CorporateAction._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction._toJSONSchema().return.maxItems?: number; default: not declared - CorporateAction._toJSONSchema().return.maxLength?: number; default: not declared - CorporateAction._toJSONSchema().return.maximum?: number; default: not declared - CorporateAction._toJSONSchema().return.minItems?: number; default: not declared - CorporateAction._toJSONSchema().return.minLength?: number; default: not declared - CorporateAction._toJSONSchema().return.minimum?: number; default: not declared - CorporateAction._toJSONSchema().return.multipleOf?: number; default: not declared - CorporateAction._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction._toJSONSchema().return.pattern?: string; default: not declared - CorporateAction._toJSONSchema().return.properties?: Record; default: not declared - CorporateAction._toJSONSchema().return.required?: string[]; default: not declared - CorporateAction._toJSONSchema().return.title?: string; default: not declared - CorporateAction._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - CorporateAction.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; default: not declared - CorporateAction.describe(description): string; default: not declared - CorporateAction.description: string | undefined; default: not declared - CorporateAction.isOptional: boolean; default: not declared - CorporateAction.kind: 'object'; default: not declared - CorporateAction.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; effectiveDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'>; ratio: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; cash: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; newSymbol: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; details: import('@insiderfinance/totalfinance/core/schema').OptionalSchema>; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - CorporateAction.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }>; default: not declared - CorporateAction.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined; }; default: not declared — @internal - CorporateAction.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - CorporateAction.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - CorporateAction.optional().return.description: string | undefined; default: not declared - CorporateAction.optional().return.isOptional: true; default: not declared - CorporateAction.optional().return.kind: 'optional'; default: not declared - CorporateAction.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; } | undefined>; default: not declared - CorporateAction.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined; default: not declared - CorporateAction.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; } | undefined>; default: not declared - CorporateAction.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; } | undefined>; default: not declared - CorporateAction.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }; default: not declared - CorporateAction.parse(input): unknown; default: not declared - CorporateAction.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - CorporateAction.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - CorporateAction.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - CorporateAction.safeParse().return.data: { symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }; default: not declared - CorporateAction.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - CorporateAction.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - CorporateAction.safeParse().return.success: (false) | (true); default: not declared - CorporateAction.safeParse(input): unknown; default: not declared - CorporateAction.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - CorporateAction.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - CorporateAction.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction.toJSONSchema().return.$id?: string; default: not declared - CorporateAction.toJSONSchema().return.$schema?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.description?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.format?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.title?: string; default: not declared - CorporateAction.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - CorporateAction.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction.toJSONSchema().return.const?: unknown; default: not declared - CorporateAction.toJSONSchema().return.default?: unknown; default: not declared - CorporateAction.toJSONSchema().return.description?: string; default: not declared - CorporateAction.toJSONSchema().return.enum?: unknown[]; default: not declared - CorporateAction.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - CorporateAction.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - CorporateAction.toJSONSchema().return.format?: string; default: not declared - CorporateAction.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - CorporateAction.toJSONSchema().return.maxItems?: number; default: not declared - CorporateAction.toJSONSchema().return.maxLength?: number; default: not declared - CorporateAction.toJSONSchema().return.maximum?: number; default: not declared - CorporateAction.toJSONSchema().return.minItems?: number; default: not declared - CorporateAction.toJSONSchema().return.minLength?: number; default: not declared - CorporateAction.toJSONSchema().return.minimum?: number; default: not declared - CorporateAction.toJSONSchema().return.multipleOf?: number; default: not declared - CorporateAction.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - CorporateAction.toJSONSchema().return.pattern?: string; default: not declared - CorporateAction.toJSONSchema().return.properties?: Record; default: not declared - CorporateAction.toJSONSchema().return.required?: string[]; default: not declared - CorporateAction.toJSONSchema().return.title?: string; default: not declared - CorporateAction.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - CorporateAction.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; }>; default: not declared - CorporateAction.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }; }) | undefined; default: not declared - CorporateAction.~standard.types.input: unknown; default: not declared - CorporateAction.~standard.types.output: { symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }; default: not declared - CorporateAction.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ cash?: number; details?: Record; effectiveDate: string; newSymbol?: string; ratio?: number; symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; }>; default: not declared - CorporateAction.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - CorporateAction.~standard.validate().return.value: { symbol: string; type: 'dividend' | 'split' | 'reverseSplit' | 'symbolChange' | 'merger' | 'spinoff' | 'other'; effectiveDate: string; cash?: number; ratio?: number; newSymbol?: string; details?: Record; }; default: not declared - CorporateAction.~standard.validate(value): unknown; default: not declared - CorporateAction.~standard.vendor: string; default: not declared - CorporateAction.~standard.version: 1; default: not declared - Dividend: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; default: not declared - Dividend._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }; }; default: not declared — @internal - Dividend._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Dividend._check().return.ok: (false) | (true); default: not declared - Dividend._check().return.value: { symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }; default: not declared - Dividend._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - Dividend._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - Dividend._check(context).path: (string | number)[]; default: not declared - Dividend._check(input): unknown; default: not declared - Dividend._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Dividend._toJSONSchema().return.$id?: string; default: not declared - Dividend._toJSONSchema().return.$schema?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Dividend._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Dividend._toJSONSchema().return.additionalProperties.description?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Dividend._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.format?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Dividend._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Dividend._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Dividend._toJSONSchema().return.additionalProperties.title?: string; default: not declared - Dividend._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Dividend._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend._toJSONSchema().return.const?: unknown; default: not declared - Dividend._toJSONSchema().return.default?: unknown; default: not declared - Dividend._toJSONSchema().return.description?: string; default: not declared - Dividend._toJSONSchema().return.enum?: unknown[]; default: not declared - Dividend._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Dividend._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Dividend._toJSONSchema().return.format?: string; default: not declared - Dividend._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend._toJSONSchema().return.maxItems?: number; default: not declared - Dividend._toJSONSchema().return.maxLength?: number; default: not declared - Dividend._toJSONSchema().return.maximum?: number; default: not declared - Dividend._toJSONSchema().return.minItems?: number; default: not declared - Dividend._toJSONSchema().return.minLength?: number; default: not declared - Dividend._toJSONSchema().return.minimum?: number; default: not declared - Dividend._toJSONSchema().return.multipleOf?: number; default: not declared - Dividend._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend._toJSONSchema().return.pattern?: string; default: not declared - Dividend._toJSONSchema().return.properties?: Record; default: not declared - Dividend._toJSONSchema().return.required?: string[]; default: not declared - Dividend._toJSONSchema().return.title?: string; default: not declared - Dividend._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Dividend.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; default: not declared - Dividend.describe(description): string; default: not declared - Dividend.description: string | undefined; default: not declared - Dividend.isOptional: boolean; default: not declared - Dividend.kind: 'object'; default: not declared - Dividend.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; exDate: import('@insiderfinance/totalfinance/core/schema').StringSchema; payDate: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; amount: import('@insiderfinance/totalfinance/core/schema').NumberSchema; currency: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; type: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'unknown' | 'regular' | 'special' | 'returnOfCapital'>; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - Dividend.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }>; default: not declared - Dividend.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined; }; default: not declared — @internal - Dividend.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Dividend.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - Dividend.optional().return.description: string | undefined; default: not declared - Dividend.optional().return.isOptional: true; default: not declared - Dividend.optional().return.kind: 'optional'; default: not declared - Dividend.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; } | undefined>; default: not declared - Dividend.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined; default: not declared - Dividend.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; } | undefined>; default: not declared - Dividend.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Dividend.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }; default: not declared - Dividend.parse(input): unknown; default: not declared - Dividend.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Dividend.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Dividend.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - Dividend.safeParse().return.data: { symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }; default: not declared - Dividend.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - Dividend.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Dividend.safeParse().return.success: (false) | (true); default: not declared - Dividend.safeParse(input): unknown; default: not declared - Dividend.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Dividend.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Dividend.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend.toJSONSchema().return.$id?: string; default: not declared - Dividend.toJSONSchema().return.$schema?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Dividend.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Dividend.toJSONSchema().return.additionalProperties.description?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Dividend.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.format?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Dividend.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Dividend.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Dividend.toJSONSchema().return.additionalProperties.title?: string; default: not declared - Dividend.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Dividend.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend.toJSONSchema().return.const?: unknown; default: not declared - Dividend.toJSONSchema().return.default?: unknown; default: not declared - Dividend.toJSONSchema().return.description?: string; default: not declared - Dividend.toJSONSchema().return.enum?: unknown[]; default: not declared - Dividend.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Dividend.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Dividend.toJSONSchema().return.format?: string; default: not declared - Dividend.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Dividend.toJSONSchema().return.maxItems?: number; default: not declared - Dividend.toJSONSchema().return.maxLength?: number; default: not declared - Dividend.toJSONSchema().return.maximum?: number; default: not declared - Dividend.toJSONSchema().return.minItems?: number; default: not declared - Dividend.toJSONSchema().return.minLength?: number; default: not declared - Dividend.toJSONSchema().return.minimum?: number; default: not declared - Dividend.toJSONSchema().return.multipleOf?: number; default: not declared - Dividend.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Dividend.toJSONSchema().return.pattern?: string; default: not declared - Dividend.toJSONSchema().return.properties?: Record; default: not declared - Dividend.toJSONSchema().return.required?: string[]; default: not declared - Dividend.toJSONSchema().return.title?: string; default: not declared - Dividend.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Dividend.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Dividend.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }; }) | undefined; default: not declared - Dividend.~standard.types.input: unknown; default: not declared - Dividend.~standard.types.output: { symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }; default: not declared - Dividend.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ amount: number; currency?: string; exDate: string; payDate?: string; symbol: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; }>; default: not declared - Dividend.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - Dividend.~standard.validate().return.value: { symbol: string; exDate: string; amount: number; currency?: string; type?: 'unknown' | 'regular' | 'special' | 'returnOfCapital'; payDate?: string; }; default: not declared - Dividend.~standard.validate(value): unknown; default: not declared - Dividend.~standard.vendor: string; default: not declared - Dividend.~standard.version: 1; default: not declared - OptionContract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.describe(description): string; default: not declared - OptionContract.isOptional: boolean; default: not declared - OptionContract.kind: string; default: not declared - OptionContract.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.isOptional: boolean; default: not declared - OptionContract.optional().return.kind: string; default: not declared - OptionContract.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined; default: not declared - OptionContract.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionContract.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.parse(input): unknown; default: not declared - OptionContract.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionContract.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionContract.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.safeParse().return.data: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OptionContract.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionContract.safeParse().return.success: (false) | (true); default: not declared - OptionContract.safeParse(input): unknown; default: not declared - OptionContract.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionContract.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionContract.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.$id?: string; default: not declared - OptionContract.toJSONSchema().return.$schema?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionContract.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.const?: unknown; default: not declared - OptionContract.toJSONSchema().return.default?: unknown; default: not declared - OptionContract.toJSONSchema().return.description?: string; default: not declared - OptionContract.toJSONSchema().return.enum?: unknown[]; default: not declared - OptionContract.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionContract.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionContract.toJSONSchema().return.format?: string; default: not declared - OptionContract.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.maxItems?: number; default: not declared - OptionContract.toJSONSchema().return.maxLength?: number; default: not declared - OptionContract.toJSONSchema().return.maximum?: number; default: not declared - OptionContract.toJSONSchema().return.minItems?: number; default: not declared - OptionContract.toJSONSchema().return.minLength?: number; default: not declared - OptionContract.toJSONSchema().return.minimum?: number; default: not declared - OptionContract.toJSONSchema().return.multipleOf?: number; default: not declared - OptionContract.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.pattern?: string; default: not declared - OptionContract.toJSONSchema().return.properties?: Record; default: not declared - OptionContract.toJSONSchema().return.required?: string[]; default: not declared - OptionContract.toJSONSchema().return.title?: string; default: not declared - OptionContract.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionContract.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionContract.~standard.types?: ({ readonly input: unknown; readonly output: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; }) | undefined; default: not declared - OptionContract.~standard.types.input: unknown; default: not declared - OptionContract.~standard.types.output: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OptionContract.~standard.validate().return.value: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.~standard.validate(value): unknown; default: not declared - OptionContract.~standard.vendor: string; default: not declared - OptionContract.~standard.version: 1; default: not declared - OptionQuote: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - OptionQuote._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; }; default: not declared — @internal - OptionQuote._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionQuote._check().return.ok: (false) | (true); default: not declared - OptionQuote._check().return.value: { contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - OptionQuote._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - OptionQuote._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - OptionQuote._check(context).path: (string | number)[]; default: not declared - OptionQuote._check(input): unknown; default: not declared - OptionQuote._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OptionQuote._toJSONSchema().return.$id?: string; default: not declared - OptionQuote._toJSONSchema().return.$schema?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionQuote._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionQuote._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote._toJSONSchema().return.const?: unknown; default: not declared - OptionQuote._toJSONSchema().return.default?: unknown; default: not declared - OptionQuote._toJSONSchema().return.description?: string; default: not declared - OptionQuote._toJSONSchema().return.enum?: unknown[]; default: not declared - OptionQuote._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionQuote._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionQuote._toJSONSchema().return.format?: string; default: not declared - OptionQuote._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote._toJSONSchema().return.maxItems?: number; default: not declared - OptionQuote._toJSONSchema().return.maxLength?: number; default: not declared - OptionQuote._toJSONSchema().return.maximum?: number; default: not declared - OptionQuote._toJSONSchema().return.minItems?: number; default: not declared - OptionQuote._toJSONSchema().return.minLength?: number; default: not declared - OptionQuote._toJSONSchema().return.minimum?: number; default: not declared - OptionQuote._toJSONSchema().return.multipleOf?: number; default: not declared - OptionQuote._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote._toJSONSchema().return.pattern?: string; default: not declared - OptionQuote._toJSONSchema().return.properties?: Record; default: not declared - OptionQuote._toJSONSchema().return.required?: string[]; default: not declared - OptionQuote._toJSONSchema().return.title?: string; default: not declared - OptionQuote._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionQuote.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - OptionQuote.describe(description): string; default: not declared - OptionQuote.description: string | undefined; default: not declared - OptionQuote.isOptional: boolean; default: not declared - OptionQuote.kind: 'object'; default: not declared - OptionQuote.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; greeks: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }>; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - OptionQuote.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }>; default: not declared - OptionQuote.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; }; default: not declared — @internal - OptionQuote.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OptionQuote.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - OptionQuote.optional().return.description: string | undefined; default: not declared - OptionQuote.optional().return.isOptional: true; default: not declared - OptionQuote.optional().return.kind: 'optional'; default: not declared - OptionQuote.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; } | undefined>; default: not declared - OptionQuote.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; default: not declared - OptionQuote.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined>; default: not declared - OptionQuote.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionQuote.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - OptionQuote.parse(input): unknown; default: not declared - OptionQuote.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionQuote.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionQuote.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - OptionQuote.safeParse().return.data: { contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - OptionQuote.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OptionQuote.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionQuote.safeParse().return.success: (false) | (true); default: not declared - OptionQuote.safeParse(input): unknown; default: not declared - OptionQuote.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionQuote.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionQuote.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote.toJSONSchema().return.$id?: string; default: not declared - OptionQuote.toJSONSchema().return.$schema?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionQuote.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionQuote.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote.toJSONSchema().return.const?: unknown; default: not declared - OptionQuote.toJSONSchema().return.default?: unknown; default: not declared - OptionQuote.toJSONSchema().return.description?: string; default: not declared - OptionQuote.toJSONSchema().return.enum?: unknown[]; default: not declared - OptionQuote.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionQuote.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionQuote.toJSONSchema().return.format?: string; default: not declared - OptionQuote.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionQuote.toJSONSchema().return.maxItems?: number; default: not declared - OptionQuote.toJSONSchema().return.maxLength?: number; default: not declared - OptionQuote.toJSONSchema().return.maximum?: number; default: not declared - OptionQuote.toJSONSchema().return.minItems?: number; default: not declared - OptionQuote.toJSONSchema().return.minLength?: number; default: not declared - OptionQuote.toJSONSchema().return.minimum?: number; default: not declared - OptionQuote.toJSONSchema().return.multipleOf?: number; default: not declared - OptionQuote.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionQuote.toJSONSchema().return.pattern?: string; default: not declared - OptionQuote.toJSONSchema().return.properties?: Record; default: not declared - OptionQuote.toJSONSchema().return.required?: string[]; default: not declared - OptionQuote.toJSONSchema().return.title?: string; default: not declared - OptionQuote.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionQuote.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionQuote.~standard.types?: ({ readonly input: unknown; readonly output: { contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; }) | undefined; default: not declared - OptionQuote.~standard.types.input: unknown; default: not declared - OptionQuote.~standard.types.output: { contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - OptionQuote.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; impliedVolatility?: number; last?: number; mark?: number; mid?: number; openInterest?: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - OptionQuote.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OptionQuote.~standard.validate().return.value: { contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; greeks?: { delta: number; gamma?: number; theta?: number; vega?: number; rho?: number; provenance?: { source: string; model?: string; timestampMs?: number; }; }; volume?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - OptionQuote.~standard.validate(value): unknown; default: not declared - OptionQuote.~standard.vendor: string; default: not declared - OptionQuote.~standard.version: 1; default: not declared - OptionTrade: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - OptionTrade._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }; }; default: not declared — @internal - OptionTrade._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionTrade._check().return.ok: (false) | (true); default: not declared - OptionTrade._check().return.value: { price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }; default: not declared - OptionTrade._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - OptionTrade._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - OptionTrade._check(context).path: (string | number)[]; default: not declared - OptionTrade._check(input): unknown; default: not declared - OptionTrade._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OptionTrade._toJSONSchema().return.$id?: string; default: not declared - OptionTrade._toJSONSchema().return.$schema?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionTrade._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionTrade._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade._toJSONSchema().return.const?: unknown; default: not declared - OptionTrade._toJSONSchema().return.default?: unknown; default: not declared - OptionTrade._toJSONSchema().return.description?: string; default: not declared - OptionTrade._toJSONSchema().return.enum?: unknown[]; default: not declared - OptionTrade._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionTrade._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionTrade._toJSONSchema().return.format?: string; default: not declared - OptionTrade._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade._toJSONSchema().return.maxItems?: number; default: not declared - OptionTrade._toJSONSchema().return.maxLength?: number; default: not declared - OptionTrade._toJSONSchema().return.maximum?: number; default: not declared - OptionTrade._toJSONSchema().return.minItems?: number; default: not declared - OptionTrade._toJSONSchema().return.minLength?: number; default: not declared - OptionTrade._toJSONSchema().return.minimum?: number; default: not declared - OptionTrade._toJSONSchema().return.multipleOf?: number; default: not declared - OptionTrade._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade._toJSONSchema().return.pattern?: string; default: not declared - OptionTrade._toJSONSchema().return.properties?: Record; default: not declared - OptionTrade._toJSONSchema().return.required?: string[]; default: not declared - OptionTrade._toJSONSchema().return.title?: string; default: not declared - OptionTrade._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionTrade.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - OptionTrade.describe(description): string; default: not declared - OptionTrade.description: string | undefined; default: not declared - OptionTrade.isOptional: boolean; default: not declared - OptionTrade.kind: 'object'; default: not declared - OptionTrade.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ contract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; ask: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mid: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; last: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; mark: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; volume: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openInterest: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; underlyingPrice: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; impliedVolatility: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; aggressorSide: import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'buy' | 'sell' | 'unknown'>; premium: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; notional: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; openingLikely: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - OptionTrade.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }>; default: not declared - OptionTrade.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; }; default: not declared — @internal - OptionTrade.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OptionTrade.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - OptionTrade.optional().return.description: string | undefined; default: not declared - OptionTrade.optional().return.isOptional: true; default: not declared - OptionTrade.optional().return.kind: 'optional'; default: not declared - OptionTrade.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; } | undefined>; default: not declared - OptionTrade.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined; default: not declared - OptionTrade.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; } | undefined>; default: not declared - OptionTrade.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionTrade.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }; default: not declared - OptionTrade.parse(input): unknown; default: not declared - OptionTrade.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionTrade.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionTrade.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - OptionTrade.safeParse().return.data: { price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }; default: not declared - OptionTrade.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OptionTrade.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionTrade.safeParse().return.success: (false) | (true); default: not declared - OptionTrade.safeParse(input): unknown; default: not declared - OptionTrade.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionTrade.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionTrade.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade.toJSONSchema().return.$id?: string; default: not declared - OptionTrade.toJSONSchema().return.$schema?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionTrade.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionTrade.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade.toJSONSchema().return.const?: unknown; default: not declared - OptionTrade.toJSONSchema().return.default?: unknown; default: not declared - OptionTrade.toJSONSchema().return.description?: string; default: not declared - OptionTrade.toJSONSchema().return.enum?: unknown[]; default: not declared - OptionTrade.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionTrade.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionTrade.toJSONSchema().return.format?: string; default: not declared - OptionTrade.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionTrade.toJSONSchema().return.maxItems?: number; default: not declared - OptionTrade.toJSONSchema().return.maxLength?: number; default: not declared - OptionTrade.toJSONSchema().return.maximum?: number; default: not declared - OptionTrade.toJSONSchema().return.minItems?: number; default: not declared - OptionTrade.toJSONSchema().return.minLength?: number; default: not declared - OptionTrade.toJSONSchema().return.minimum?: number; default: not declared - OptionTrade.toJSONSchema().return.multipleOf?: number; default: not declared - OptionTrade.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionTrade.toJSONSchema().return.pattern?: string; default: not declared - OptionTrade.toJSONSchema().return.properties?: Record; default: not declared - OptionTrade.toJSONSchema().return.required?: string[]; default: not declared - OptionTrade.toJSONSchema().return.title?: string; default: not declared - OptionTrade.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionTrade.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionTrade.~standard.types?: ({ readonly input: unknown; readonly output: { price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }; }) | undefined; default: not declared - OptionTrade.~standard.types.input: unknown; default: not declared - OptionTrade.~standard.types.output: { price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }; default: not declared - OptionTrade.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ aggressorSide?: 'buy' | 'sell' | 'unknown'; ask?: number; askSize?: number; bid?: number; bidSize?: number; conditions?: string[]; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; exchange?: string; impliedVolatility?: number; last?: number; mark?: number; mid?: number; notional?: number; openInterest?: number; openingLikely?: boolean; premium?: number; price: number; sequence?: number; size: number; timestampMs: number; underlyingPrice?: number; volume?: number; }>; default: not declared - OptionTrade.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OptionTrade.~standard.validate().return.value: { price: number; contract: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; timestampMs: number; size: number; bid?: number; ask?: number; mid?: number; last?: number; mark?: number; impliedVolatility?: number; openInterest?: number; volume?: number; premium?: number; notional?: number; underlyingPrice?: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; sequence?: number; aggressorSide?: 'buy' | 'sell' | 'unknown'; openingLikely?: boolean; }; default: not declared - OptionTrade.~standard.validate(value): unknown; default: not declared - OptionTrade.~standard.vendor: string; default: not declared - OptionTrade.~standard.version: 1; default: not declared - OrderBook: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; }>; default: not declared - OrderBook._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }; }; default: not declared — @internal - OrderBook._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OrderBook._check().return.ok: (false) | (true); default: not declared - OrderBook._check().return.value: { symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }; default: not declared - OrderBook._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - OrderBook._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - OrderBook._check(context).path: (string | number)[]; default: not declared - OrderBook._check(input): unknown; default: not declared - OrderBook._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OrderBook._toJSONSchema().return.$id?: string; default: not declared - OrderBook._toJSONSchema().return.$schema?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.description?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.format?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.title?: string; default: not declared - OrderBook._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBook._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook._toJSONSchema().return.const?: unknown; default: not declared - OrderBook._toJSONSchema().return.default?: unknown; default: not declared - OrderBook._toJSONSchema().return.description?: string; default: not declared - OrderBook._toJSONSchema().return.enum?: unknown[]; default: not declared - OrderBook._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OrderBook._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OrderBook._toJSONSchema().return.format?: string; default: not declared - OrderBook._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook._toJSONSchema().return.maxItems?: number; default: not declared - OrderBook._toJSONSchema().return.maxLength?: number; default: not declared - OrderBook._toJSONSchema().return.maximum?: number; default: not declared - OrderBook._toJSONSchema().return.minItems?: number; default: not declared - OrderBook._toJSONSchema().return.minLength?: number; default: not declared - OrderBook._toJSONSchema().return.minimum?: number; default: not declared - OrderBook._toJSONSchema().return.multipleOf?: number; default: not declared - OrderBook._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook._toJSONSchema().return.pattern?: string; default: not declared - OrderBook._toJSONSchema().return.properties?: Record; default: not declared - OrderBook._toJSONSchema().return.required?: string[]; default: not declared - OrderBook._toJSONSchema().return.title?: string; default: not declared - OrderBook._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBook.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; }>; default: not declared - OrderBook.describe(description): string; default: not declared - OrderBook.description: string | undefined; default: not declared - OrderBook.isOptional: boolean; default: not declared - OrderBook.kind: 'object'; default: not declared - OrderBook.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bids: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; asks: import('@insiderfinance/totalfinance/core/schema').ArraySchema<{ price: number; size: number; exchange?: string; }>; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - OrderBook.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }>; default: not declared - OrderBook.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; } | undefined; }; default: not declared — @internal - OrderBook.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OrderBook.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; }>; default: not declared - OrderBook.optional().return.description: string | undefined; default: not declared - OrderBook.optional().return.isOptional: true; default: not declared - OrderBook.optional().return.kind: 'optional'; default: not declared - OrderBook.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; } | undefined>; default: not declared - OrderBook.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; } | undefined; default: not declared - OrderBook.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; } | undefined>; default: not declared - OrderBook.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OrderBook.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; }; default: not declared - OrderBook.parse(input): unknown; default: not declared - OrderBook.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OrderBook.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OrderBook.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; }>; default: not declared - OrderBook.safeParse().return.data: { symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }; default: not declared - OrderBook.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OrderBook.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OrderBook.safeParse().return.success: (false) | (true); default: not declared - OrderBook.safeParse(input): unknown; default: not declared - OrderBook.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OrderBook.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OrderBook.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook.toJSONSchema().return.$id?: string; default: not declared - OrderBook.toJSONSchema().return.$schema?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OrderBook.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBook.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook.toJSONSchema().return.const?: unknown; default: not declared - OrderBook.toJSONSchema().return.default?: unknown; default: not declared - OrderBook.toJSONSchema().return.description?: string; default: not declared - OrderBook.toJSONSchema().return.enum?: unknown[]; default: not declared - OrderBook.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OrderBook.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OrderBook.toJSONSchema().return.format?: string; default: not declared - OrderBook.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBook.toJSONSchema().return.maxItems?: number; default: not declared - OrderBook.toJSONSchema().return.maxLength?: number; default: not declared - OrderBook.toJSONSchema().return.maximum?: number; default: not declared - OrderBook.toJSONSchema().return.minItems?: number; default: not declared - OrderBook.toJSONSchema().return.minLength?: number; default: not declared - OrderBook.toJSONSchema().return.minimum?: number; default: not declared - OrderBook.toJSONSchema().return.multipleOf?: number; default: not declared - OrderBook.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBook.toJSONSchema().return.pattern?: string; default: not declared - OrderBook.toJSONSchema().return.properties?: Record; default: not declared - OrderBook.toJSONSchema().return.required?: string[]; default: not declared - OrderBook.toJSONSchema().return.title?: string; default: not declared - OrderBook.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBook.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OrderBook.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }; }) | undefined; default: not declared - OrderBook.~standard.types.input: unknown; default: not declared - OrderBook.~standard.types.output: { symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }; default: not declared - OrderBook.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ asks: { price: number; size: number; exchange?: string; }[]; bids: { price: number; size: number; exchange?: string; }[]; symbol: string; timestampMs: number; }>; default: not declared - OrderBook.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OrderBook.~standard.validate().return.value: { symbol: string; timestampMs: number; bids: { price: number; size: number; exchange?: string; }[]; asks: { price: number; size: number; exchange?: string; }[]; }; default: not declared - OrderBook.~standard.validate(value): unknown; default: not declared - OrderBook.~standard.vendor: string; default: not declared - OrderBook.~standard.version: 1; default: not declared - OrderBookLevel: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - OrderBookLevel._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { price: number; size: number; exchange?: string; }; }; default: not declared — @internal - OrderBookLevel._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OrderBookLevel._check().return.ok: (false) | (true); default: not declared - OrderBookLevel._check().return.value: { price: number; size: number; exchange?: string; }; default: not declared - OrderBookLevel._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - OrderBookLevel._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - OrderBookLevel._check(context).path: (string | number)[]; default: not declared - OrderBookLevel._check(input): unknown; default: not declared - OrderBookLevel._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OrderBookLevel._toJSONSchema().return.$id?: string; default: not declared - OrderBookLevel._toJSONSchema().return.$schema?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.description?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.format?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.title?: string; default: not declared - OrderBookLevel._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBookLevel._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel._toJSONSchema().return.const?: unknown; default: not declared - OrderBookLevel._toJSONSchema().return.default?: unknown; default: not declared - OrderBookLevel._toJSONSchema().return.description?: string; default: not declared - OrderBookLevel._toJSONSchema().return.enum?: unknown[]; default: not declared - OrderBookLevel._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.format?: string; default: not declared - OrderBookLevel._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel._toJSONSchema().return.maxItems?: number; default: not declared - OrderBookLevel._toJSONSchema().return.maxLength?: number; default: not declared - OrderBookLevel._toJSONSchema().return.maximum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.minItems?: number; default: not declared - OrderBookLevel._toJSONSchema().return.minLength?: number; default: not declared - OrderBookLevel._toJSONSchema().return.minimum?: number; default: not declared - OrderBookLevel._toJSONSchema().return.multipleOf?: number; default: not declared - OrderBookLevel._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel._toJSONSchema().return.pattern?: string; default: not declared - OrderBookLevel._toJSONSchema().return.properties?: Record; default: not declared - OrderBookLevel._toJSONSchema().return.required?: string[]; default: not declared - OrderBookLevel._toJSONSchema().return.title?: string; default: not declared - OrderBookLevel._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBookLevel.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - OrderBookLevel.describe(description): string; default: not declared - OrderBookLevel.description: string | undefined; default: not declared - OrderBookLevel.isOptional: boolean; default: not declared - OrderBookLevel.kind: 'object'; default: not declared - OrderBookLevel.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - OrderBookLevel.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; size: number; exchange?: string; }>; default: not declared - OrderBookLevel.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { exchange?: string; price: number; size: number; } | undefined; }; default: not declared — @internal - OrderBookLevel.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - OrderBookLevel.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ exchange?: string; price: number; size: number; }>; default: not declared - OrderBookLevel.optional().return.description: string | undefined; default: not declared - OrderBookLevel.optional().return.isOptional: true; default: not declared - OrderBookLevel.optional().return.kind: 'optional'; default: not declared - OrderBookLevel.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ price: number; size: number; exchange?: string; } | undefined>; default: not declared - OrderBookLevel.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { exchange?: string; price: number; size: number; } | undefined; default: not declared - OrderBookLevel.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ exchange?: string; price: number; size: number; } | undefined>; default: not declared - OrderBookLevel.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OrderBookLevel.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { exchange?: string; price: number; size: number; }; default: not declared - OrderBookLevel.parse(input): unknown; default: not declared - OrderBookLevel.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OrderBookLevel.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OrderBookLevel.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ exchange?: string; price: number; size: number; }>; default: not declared - OrderBookLevel.safeParse().return.data: { price: number; size: number; exchange?: string; }; default: not declared - OrderBookLevel.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OrderBookLevel.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OrderBookLevel.safeParse().return.success: (false) | (true); default: not declared - OrderBookLevel.safeParse(input): unknown; default: not declared - OrderBookLevel.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OrderBookLevel.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OrderBookLevel.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel.toJSONSchema().return.$id?: string; default: not declared - OrderBookLevel.toJSONSchema().return.$schema?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OrderBookLevel.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBookLevel.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel.toJSONSchema().return.const?: unknown; default: not declared - OrderBookLevel.toJSONSchema().return.default?: unknown; default: not declared - OrderBookLevel.toJSONSchema().return.description?: string; default: not declared - OrderBookLevel.toJSONSchema().return.enum?: unknown[]; default: not declared - OrderBookLevel.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.format?: string; default: not declared - OrderBookLevel.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OrderBookLevel.toJSONSchema().return.maxItems?: number; default: not declared - OrderBookLevel.toJSONSchema().return.maxLength?: number; default: not declared - OrderBookLevel.toJSONSchema().return.maximum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.minItems?: number; default: not declared - OrderBookLevel.toJSONSchema().return.minLength?: number; default: not declared - OrderBookLevel.toJSONSchema().return.minimum?: number; default: not declared - OrderBookLevel.toJSONSchema().return.multipleOf?: number; default: not declared - OrderBookLevel.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OrderBookLevel.toJSONSchema().return.pattern?: string; default: not declared - OrderBookLevel.toJSONSchema().return.properties?: Record; default: not declared - OrderBookLevel.toJSONSchema().return.required?: string[]; default: not declared - OrderBookLevel.toJSONSchema().return.title?: string; default: not declared - OrderBookLevel.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OrderBookLevel.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OrderBookLevel.~standard.types?: ({ readonly input: unknown; readonly output: { price: number; size: number; exchange?: string; }; }) | undefined; default: not declared - OrderBookLevel.~standard.types.input: unknown; default: not declared - OrderBookLevel.~standard.types.output: { price: number; size: number; exchange?: string; }; default: not declared - OrderBookLevel.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ exchange?: string; price: number; size: number; }>; default: not declared - OrderBookLevel.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OrderBookLevel.~standard.validate().return.value: { price: number; size: number; exchange?: string; }; default: not declared - OrderBookLevel.~standard.validate(value): unknown; default: not declared - OrderBookLevel.~standard.vendor: string; default: not declared - OrderBookLevel.~standard.version: 1; default: not declared - Quote: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - Quote._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; }; default: not declared — @internal - Quote._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Quote._check().return.ok: (false) | (true); default: not declared - Quote._check().return.value: { symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - Quote._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - Quote._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - Quote._check(context).path: (string | number)[]; default: not declared - Quote._check(input): unknown; default: not declared - Quote._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Quote._toJSONSchema().return.$id?: string; default: not declared - Quote._toJSONSchema().return.$schema?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Quote._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Quote._toJSONSchema().return.additionalProperties.description?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Quote._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.format?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Quote._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Quote._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Quote._toJSONSchema().return.additionalProperties.title?: string; default: not declared - Quote._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Quote._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote._toJSONSchema().return.const?: unknown; default: not declared - Quote._toJSONSchema().return.default?: unknown; default: not declared - Quote._toJSONSchema().return.description?: string; default: not declared - Quote._toJSONSchema().return.enum?: unknown[]; default: not declared - Quote._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Quote._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Quote._toJSONSchema().return.format?: string; default: not declared - Quote._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote._toJSONSchema().return.maxItems?: number; default: not declared - Quote._toJSONSchema().return.maxLength?: number; default: not declared - Quote._toJSONSchema().return.maximum?: number; default: not declared - Quote._toJSONSchema().return.minItems?: number; default: not declared - Quote._toJSONSchema().return.minLength?: number; default: not declared - Quote._toJSONSchema().return.minimum?: number; default: not declared - Quote._toJSONSchema().return.multipleOf?: number; default: not declared - Quote._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote._toJSONSchema().return.pattern?: string; default: not declared - Quote._toJSONSchema().return.properties?: Record; default: not declared - Quote._toJSONSchema().return.required?: string[]; default: not declared - Quote._toJSONSchema().return.title?: string; default: not declared - Quote._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Quote.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - Quote.describe(description): string; default: not declared - Quote.description: string | undefined; default: not declared - Quote.isOptional: boolean; default: not declared - Quote.kind: 'object'; default: not declared - Quote.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bid: import('@insiderfinance/totalfinance/core/schema').NumberSchema; ask: import('@insiderfinance/totalfinance/core/schema').NumberSchema; bidSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; askSize: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - Quote.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }>; default: not declared - Quote.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined; }; default: not declared — @internal - Quote.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Quote.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - Quote.optional().return.description: string | undefined; default: not declared - Quote.optional().return.isOptional: true; default: not declared - Quote.optional().return.kind: 'optional'; default: not declared - Quote.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; } | undefined>; default: not declared - Quote.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined; default: not declared - Quote.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; } | undefined>; default: not declared - Quote.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Quote.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }; default: not declared - Quote.parse(input): unknown; default: not declared - Quote.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Quote.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Quote.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - Quote.safeParse().return.data: { symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - Quote.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - Quote.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Quote.safeParse().return.success: (false) | (true); default: not declared - Quote.safeParse(input): unknown; default: not declared - Quote.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Quote.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Quote.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote.toJSONSchema().return.$id?: string; default: not declared - Quote.toJSONSchema().return.$schema?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Quote.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Quote.toJSONSchema().return.additionalProperties.description?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Quote.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.format?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Quote.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Quote.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Quote.toJSONSchema().return.additionalProperties.title?: string; default: not declared - Quote.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Quote.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote.toJSONSchema().return.const?: unknown; default: not declared - Quote.toJSONSchema().return.default?: unknown; default: not declared - Quote.toJSONSchema().return.description?: string; default: not declared - Quote.toJSONSchema().return.enum?: unknown[]; default: not declared - Quote.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Quote.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Quote.toJSONSchema().return.format?: string; default: not declared - Quote.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Quote.toJSONSchema().return.maxItems?: number; default: not declared - Quote.toJSONSchema().return.maxLength?: number; default: not declared - Quote.toJSONSchema().return.maximum?: number; default: not declared - Quote.toJSONSchema().return.minItems?: number; default: not declared - Quote.toJSONSchema().return.minLength?: number; default: not declared - Quote.toJSONSchema().return.minimum?: number; default: not declared - Quote.toJSONSchema().return.multipleOf?: number; default: not declared - Quote.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Quote.toJSONSchema().return.pattern?: string; default: not declared - Quote.toJSONSchema().return.properties?: Record; default: not declared - Quote.toJSONSchema().return.required?: string[]; default: not declared - Quote.toJSONSchema().return.title?: string; default: not declared - Quote.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Quote.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Quote.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; }) | undefined; default: not declared - Quote.~standard.types.input: unknown; default: not declared - Quote.~standard.types.output: { symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - Quote.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ ask: number; askSize?: number; bid: number; bidSize?: number; conditions?: string[]; exchange?: string; symbol: string; timestampMs: number; }>; default: not declared - Quote.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - Quote.~standard.validate().return.value: { symbol: string; bid: number; ask: number; timestampMs: number; bidSize?: number; askSize?: number; exchange?: string; conditions?: string[]; }; default: not declared - Quote.~standard.validate(value): unknown; default: not declared - Quote.~standard.vendor: string; default: not declared - Quote.~standard.version: 1; default: not declared - RateCurve: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - RateCurve.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - RateCurve.describe(description): string; default: not declared - RateCurve.isOptional: boolean; default: not declared - RateCurve.kind: string; default: not declared - RateCurve.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - RateCurve.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - RateCurve.optional().return.isOptional: boolean; default: not declared - RateCurve.optional().return.kind: string; default: not declared - RateCurve.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - RateCurve.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core').RateCurve | undefined; default: not declared - RateCurve.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - RateCurve.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurve.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - RateCurve.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - RateCurve.parse().return.asOf: number; default: not declared - RateCurve.parse().return.compounding: InterestCompounding; default: not declared - RateCurve.parse().return.currency: string; default: not declared - RateCurve.parse().return.dayCount: DayCount; default: not declared - RateCurve.parse().return.interpolation?: string; default: not declared - RateCurve.parse().return.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - RateCurve.parse(input): unknown; default: not declared - RateCurve.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - RateCurve.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - RateCurve.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - RateCurve.safeParse().return.data: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - RateCurve.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - RateCurve.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - RateCurve.safeParse().return.success: (false) | (true); default: not declared - RateCurve.safeParse(input): unknown; default: not declared - RateCurve.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - RateCurve.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - RateCurve.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurve.toJSONSchema().return.$id?: string; default: not declared - RateCurve.toJSONSchema().return.$schema?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.description?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.format?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.title?: string; default: not declared - RateCurve.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RateCurve.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurve.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurve.toJSONSchema().return.const?: unknown; default: not declared - RateCurve.toJSONSchema().return.default?: unknown; default: not declared - RateCurve.toJSONSchema().return.description?: string; default: not declared - RateCurve.toJSONSchema().return.enum?: unknown[]; default: not declared - RateCurve.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - RateCurve.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - RateCurve.toJSONSchema().return.format?: string; default: not declared - RateCurve.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurve.toJSONSchema().return.maxItems?: number; default: not declared - RateCurve.toJSONSchema().return.maxLength?: number; default: not declared - RateCurve.toJSONSchema().return.maximum?: number; default: not declared - RateCurve.toJSONSchema().return.minItems?: number; default: not declared - RateCurve.toJSONSchema().return.minLength?: number; default: not declared - RateCurve.toJSONSchema().return.minimum?: number; default: not declared - RateCurve.toJSONSchema().return.multipleOf?: number; default: not declared - RateCurve.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurve.toJSONSchema().return.pattern?: string; default: not declared - RateCurve.toJSONSchema().return.properties?: Record; default: not declared - RateCurve.toJSONSchema().return.required?: string[]; default: not declared - RateCurve.toJSONSchema().return.title?: string; default: not declared - RateCurve.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RateCurve.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - RateCurve.~standard.types?: ({ readonly input: unknown; readonly output: import('@insiderfinance/totalfinance/core').RateCurve; }) | undefined; default: not declared - RateCurve.~standard.types.input: unknown; default: not declared - RateCurve.~standard.types.output: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - RateCurve.~standard.types.output.asOf: number; default: not declared - RateCurve.~standard.types.output.compounding: InterestCompounding; default: not declared - RateCurve.~standard.types.output.compounding.periodsPerYear: number; default: not declared - RateCurve.~standard.types.output.compounding.type: 'periodic'; default: not declared - RateCurve.~standard.types.output.currency: string; default: not declared - RateCurve.~standard.types.output.dayCount: DayCount; default: not declared - RateCurve.~standard.types.output.interpolation?: string; default: not declared - RateCurve.~standard.types.output.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared - RateCurve.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - RateCurve.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - RateCurve.~standard.validate().return.value: import('@insiderfinance/totalfinance/core').RateCurve; default: not declared - RateCurve.~standard.validate(value): unknown; default: not declared - RateCurve.~standard.vendor: string; default: not declared - RateCurve.~standard.version: 1; default: not declared - RateCurvePoint: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; default: not declared - RateCurvePoint._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { date: string; zeroRate: number; }; }; default: not declared — @internal - RateCurvePoint._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - RateCurvePoint._check().return.ok: (false) | (true); default: not declared - RateCurvePoint._check().return.value: { date: string; zeroRate: number; }; default: not declared - RateCurvePoint._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - RateCurvePoint._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - RateCurvePoint._check(context).path: (string | number)[]; default: not declared - RateCurvePoint._check(input): unknown; default: not declared - RateCurvePoint._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - RateCurvePoint._toJSONSchema().return.$id?: string; default: not declared - RateCurvePoint._toJSONSchema().return.$schema?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.description?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.format?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.title?: string; default: not declared - RateCurvePoint._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RateCurvePoint._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint._toJSONSchema().return.const?: unknown; default: not declared - RateCurvePoint._toJSONSchema().return.default?: unknown; default: not declared - RateCurvePoint._toJSONSchema().return.description?: string; default: not declared - RateCurvePoint._toJSONSchema().return.enum?: unknown[]; default: not declared - RateCurvePoint._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.format?: string; default: not declared - RateCurvePoint._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint._toJSONSchema().return.maxItems?: number; default: not declared - RateCurvePoint._toJSONSchema().return.maxLength?: number; default: not declared - RateCurvePoint._toJSONSchema().return.maximum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.minItems?: number; default: not declared - RateCurvePoint._toJSONSchema().return.minLength?: number; default: not declared - RateCurvePoint._toJSONSchema().return.minimum?: number; default: not declared - RateCurvePoint._toJSONSchema().return.multipleOf?: number; default: not declared - RateCurvePoint._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint._toJSONSchema().return.pattern?: string; default: not declared - RateCurvePoint._toJSONSchema().return.properties?: Record; default: not declared - RateCurvePoint._toJSONSchema().return.required?: string[]; default: not declared - RateCurvePoint._toJSONSchema().return.title?: string; default: not declared - RateCurvePoint._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RateCurvePoint.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; default: not declared - RateCurvePoint.describe(description): string; default: not declared - RateCurvePoint.description: string | undefined; default: not declared - RateCurvePoint.isOptional: boolean; default: not declared - RateCurvePoint.kind: 'object'; default: not declared - RateCurvePoint.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ date: import('@insiderfinance/totalfinance/core/schema').StringSchema; zeroRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - RateCurvePoint.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ date: string; zeroRate: number; }>; default: not declared - RateCurvePoint.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { date: string; zeroRate: number; } | undefined; }; default: not declared — @internal - RateCurvePoint.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - RateCurvePoint.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ date: string; zeroRate: number; }>; default: not declared - RateCurvePoint.optional().return.description: string | undefined; default: not declared - RateCurvePoint.optional().return.isOptional: true; default: not declared - RateCurvePoint.optional().return.kind: 'optional'; default: not declared - RateCurvePoint.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ date: string; zeroRate: number; } | undefined>; default: not declared - RateCurvePoint.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { date: string; zeroRate: number; } | undefined; default: not declared - RateCurvePoint.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ date: string; zeroRate: number; } | undefined>; default: not declared - RateCurvePoint.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - RateCurvePoint.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { date: string; zeroRate: number; }; default: not declared - RateCurvePoint.parse(input): unknown; default: not declared - RateCurvePoint.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - RateCurvePoint.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - RateCurvePoint.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ date: string; zeroRate: number; }>; default: not declared - RateCurvePoint.safeParse().return.data: { date: string; zeroRate: number; }; default: not declared - RateCurvePoint.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - RateCurvePoint.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - RateCurvePoint.safeParse().return.success: (false) | (true); default: not declared - RateCurvePoint.safeParse(input): unknown; default: not declared - RateCurvePoint.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - RateCurvePoint.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - RateCurvePoint.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint.toJSONSchema().return.$id?: string; default: not declared - RateCurvePoint.toJSONSchema().return.$schema?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.description?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.format?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.title?: string; default: not declared - RateCurvePoint.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RateCurvePoint.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint.toJSONSchema().return.const?: unknown; default: not declared - RateCurvePoint.toJSONSchema().return.default?: unknown; default: not declared - RateCurvePoint.toJSONSchema().return.description?: string; default: not declared - RateCurvePoint.toJSONSchema().return.enum?: unknown[]; default: not declared - RateCurvePoint.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.format?: string; default: not declared - RateCurvePoint.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RateCurvePoint.toJSONSchema().return.maxItems?: number; default: not declared - RateCurvePoint.toJSONSchema().return.maxLength?: number; default: not declared - RateCurvePoint.toJSONSchema().return.maximum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.minItems?: number; default: not declared - RateCurvePoint.toJSONSchema().return.minLength?: number; default: not declared - RateCurvePoint.toJSONSchema().return.minimum?: number; default: not declared - RateCurvePoint.toJSONSchema().return.multipleOf?: number; default: not declared - RateCurvePoint.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RateCurvePoint.toJSONSchema().return.pattern?: string; default: not declared - RateCurvePoint.toJSONSchema().return.properties?: Record; default: not declared - RateCurvePoint.toJSONSchema().return.required?: string[]; default: not declared - RateCurvePoint.toJSONSchema().return.title?: string; default: not declared - RateCurvePoint.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RateCurvePoint.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - RateCurvePoint.~standard.types?: ({ readonly input: unknown; readonly output: { date: string; zeroRate: number; }; }) | undefined; default: not declared - RateCurvePoint.~standard.types.input: unknown; default: not declared - RateCurvePoint.~standard.types.output: { date: string; zeroRate: number; }; default: not declared - RateCurvePoint.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ date: string; zeroRate: number; }>; default: not declared - RateCurvePoint.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - RateCurvePoint.~standard.validate().return.value: { date: string; zeroRate: number; }; default: not declared - RateCurvePoint.~standard.validate(value): unknown; default: not declared - RateCurvePoint.~standard.vendor: string; default: not declared - RateCurvePoint.~standard.version: 1; default: not declared - RawFundamentalsRecord: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; default: not declared - RawFundamentalsRecord._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }; }; default: not declared — @internal - RawFundamentalsRecord._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - RawFundamentalsRecord._check().return.ok: (false) | (true); default: not declared - RawFundamentalsRecord._check().return.value: { symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }; default: not declared - RawFundamentalsRecord._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - RawFundamentalsRecord._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - RawFundamentalsRecord._check(context).path: (string | number)[]; default: not declared - RawFundamentalsRecord._check(input): unknown; default: not declared - RawFundamentalsRecord._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - RawFundamentalsRecord._toJSONSchema().return.$id?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.$schema?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.description?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.format?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.title?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.const?: unknown; default: not declared - RawFundamentalsRecord._toJSONSchema().return.default?: unknown; default: not declared - RawFundamentalsRecord._toJSONSchema().return.description?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.enum?: unknown[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.format?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord._toJSONSchema().return.maxItems?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.maxLength?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.maximum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.minItems?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.minLength?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.minimum?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.multipleOf?: number; default: not declared - RawFundamentalsRecord._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.pattern?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.properties?: Record; default: not declared - RawFundamentalsRecord._toJSONSchema().return.required?: string[]; default: not declared - RawFundamentalsRecord._toJSONSchema().return.title?: string; default: not declared - RawFundamentalsRecord._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RawFundamentalsRecord.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; default: not declared - RawFundamentalsRecord.describe(description): string; default: not declared - RawFundamentalsRecord.description: string | undefined; default: not declared - RawFundamentalsRecord.isOptional: boolean; default: not declared - RawFundamentalsRecord.kind: 'object'; default: not declared - RawFundamentalsRecord.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; fiscalPeriod: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; asOf: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; fields: import('@insiderfinance/totalfinance/core/schema').RecordSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - RawFundamentalsRecord.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }>; default: not declared - RawFundamentalsRecord.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined; }; default: not declared — @internal - RawFundamentalsRecord.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - RawFundamentalsRecord.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - RawFundamentalsRecord.optional().return.description: string | undefined; default: not declared - RawFundamentalsRecord.optional().return.isOptional: true; default: not declared - RawFundamentalsRecord.optional().return.kind: 'optional'; default: not declared - RawFundamentalsRecord.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; } | undefined>; default: not declared - RawFundamentalsRecord.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined; default: not declared - RawFundamentalsRecord.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; } | undefined>; default: not declared - RawFundamentalsRecord.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; asOf?: number; fiscalPeriod?: string; } | undefined>; default: not declared - RawFundamentalsRecord.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }; default: not declared - RawFundamentalsRecord.parse(input): unknown; default: not declared - RawFundamentalsRecord.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - RawFundamentalsRecord.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - RawFundamentalsRecord.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - RawFundamentalsRecord.safeParse().return.data: { symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }; default: not declared - RawFundamentalsRecord.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - RawFundamentalsRecord.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - RawFundamentalsRecord.safeParse().return.success: (false) | (true); default: not declared - RawFundamentalsRecord.safeParse(input): unknown; default: not declared - RawFundamentalsRecord.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - RawFundamentalsRecord.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - RawFundamentalsRecord.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord.toJSONSchema().return.$id?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.$schema?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.description?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.format?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.title?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.const?: unknown; default: not declared - RawFundamentalsRecord.toJSONSchema().return.default?: unknown; default: not declared - RawFundamentalsRecord.toJSONSchema().return.description?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.enum?: unknown[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.format?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - RawFundamentalsRecord.toJSONSchema().return.maxItems?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.maxLength?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.maximum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.minItems?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.minLength?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.minimum?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.multipleOf?: number; default: not declared - RawFundamentalsRecord.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.pattern?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.properties?: Record; default: not declared - RawFundamentalsRecord.toJSONSchema().return.required?: string[]; default: not declared - RawFundamentalsRecord.toJSONSchema().return.title?: string; default: not declared - RawFundamentalsRecord.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - RawFundamentalsRecord.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; asOf?: number; fiscalPeriod?: string; }>; default: not declared - RawFundamentalsRecord.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }; }) | undefined; default: not declared - RawFundamentalsRecord.~standard.types.input: unknown; default: not declared - RawFundamentalsRecord.~standard.types.output: { symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }; default: not declared - RawFundamentalsRecord.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ asOf?: number; fields: Record; fiscalPeriod?: string; symbol: string; }>; default: not declared - RawFundamentalsRecord.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - RawFundamentalsRecord.~standard.validate().return.value: { symbol: string; fields: Record; asOf?: number; fiscalPeriod?: string; }; default: not declared - RawFundamentalsRecord.~standard.validate(value): unknown; default: not declared - RawFundamentalsRecord.~standard.vendor: string; default: not declared - RawFundamentalsRecord.~standard.version: 1; default: not declared - Trade: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - Trade._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }; }; default: not declared — @internal - Trade._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Trade._check().return.ok: (false) | (true); default: not declared - Trade._check().return.value: { symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }; default: not declared - Trade._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - Trade._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - Trade._check(context).path: (string | number)[]; default: not declared - Trade._check(input): unknown; default: not declared - Trade._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Trade._toJSONSchema().return.$id?: string; default: not declared - Trade._toJSONSchema().return.$schema?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Trade._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Trade._toJSONSchema().return.additionalProperties.description?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Trade._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.format?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Trade._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Trade._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Trade._toJSONSchema().return.additionalProperties.title?: string; default: not declared - Trade._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Trade._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade._toJSONSchema().return.const?: unknown; default: not declared - Trade._toJSONSchema().return.default?: unknown; default: not declared - Trade._toJSONSchema().return.description?: string; default: not declared - Trade._toJSONSchema().return.enum?: unknown[]; default: not declared - Trade._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Trade._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Trade._toJSONSchema().return.format?: string; default: not declared - Trade._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade._toJSONSchema().return.maxItems?: number; default: not declared - Trade._toJSONSchema().return.maxLength?: number; default: not declared - Trade._toJSONSchema().return.maximum?: number; default: not declared - Trade._toJSONSchema().return.minItems?: number; default: not declared - Trade._toJSONSchema().return.minLength?: number; default: not declared - Trade._toJSONSchema().return.minimum?: number; default: not declared - Trade._toJSONSchema().return.multipleOf?: number; default: not declared - Trade._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade._toJSONSchema().return.pattern?: string; default: not declared - Trade._toJSONSchema().return.properties?: Record; default: not declared - Trade._toJSONSchema().return.required?: string[]; default: not declared - Trade._toJSONSchema().return.title?: string; default: not declared - Trade._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Trade.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - Trade.describe(description): string; default: not declared - Trade.description: string | undefined; default: not declared - Trade.isOptional: boolean; default: not declared - Trade.kind: 'object'; default: not declared - Trade.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ symbol: import('@insiderfinance/totalfinance/core/schema').StringSchema; timestampMs: import('@insiderfinance/totalfinance/core/schema').NumberSchema; price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; size: import('@insiderfinance/totalfinance/core/schema').NumberSchema; exchange: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; conditions: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; sequence: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - Trade.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }>; default: not declared - Trade.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined; }; default: not declared — @internal - Trade.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - Trade.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - Trade.optional().return.description: string | undefined; default: not declared - Trade.optional().return.isOptional: true; default: not declared - Trade.optional().return.kind: 'optional'; default: not declared - Trade.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; } | undefined>; default: not declared - Trade.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined; default: not declared - Trade.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; } | undefined>; default: not declared - Trade.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Trade.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }; default: not declared - Trade.parse(input): unknown; default: not declared - Trade.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Trade.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Trade.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - Trade.safeParse().return.data: { symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }; default: not declared - Trade.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - Trade.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - Trade.safeParse().return.success: (false) | (true); default: not declared - Trade.safeParse(input): unknown; default: not declared - Trade.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - Trade.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - Trade.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade.toJSONSchema().return.$id?: string; default: not declared - Trade.toJSONSchema().return.$schema?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - Trade.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - Trade.toJSONSchema().return.additionalProperties.description?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - Trade.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.format?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - Trade.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - Trade.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - Trade.toJSONSchema().return.additionalProperties.title?: string; default: not declared - Trade.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Trade.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade.toJSONSchema().return.const?: unknown; default: not declared - Trade.toJSONSchema().return.default?: unknown; default: not declared - Trade.toJSONSchema().return.description?: string; default: not declared - Trade.toJSONSchema().return.enum?: unknown[]; default: not declared - Trade.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - Trade.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - Trade.toJSONSchema().return.format?: string; default: not declared - Trade.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - Trade.toJSONSchema().return.maxItems?: number; default: not declared - Trade.toJSONSchema().return.maxLength?: number; default: not declared - Trade.toJSONSchema().return.maximum?: number; default: not declared - Trade.toJSONSchema().return.minItems?: number; default: not declared - Trade.toJSONSchema().return.minLength?: number; default: not declared - Trade.toJSONSchema().return.minimum?: number; default: not declared - Trade.toJSONSchema().return.multipleOf?: number; default: not declared - Trade.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - Trade.toJSONSchema().return.pattern?: string; default: not declared - Trade.toJSONSchema().return.properties?: Record; default: not declared - Trade.toJSONSchema().return.required?: string[]; default: not declared - Trade.toJSONSchema().return.title?: string; default: not declared - Trade.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - Trade.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - Trade.~standard.types?: ({ readonly input: unknown; readonly output: { symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }; }) | undefined; default: not declared - Trade.~standard.types.input: unknown; default: not declared - Trade.~standard.types.output: { symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }; default: not declared - Trade.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ conditions?: string[]; exchange?: string; price: number; sequence?: number; size: number; symbol: string; timestampMs: number; }>; default: not declared - Trade.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - Trade.~standard.validate().return.value: { symbol: string; price: number; timestampMs: number; size: number; exchange?: string; conditions?: string[]; sequence?: number; }; default: not declared - Trade.~standard.validate(value): unknown; default: not declared - Trade.~standard.vendor: string; default: not declared - Trade.~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/core/schema#requireJSONSchema Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assert that `value` is a well-formed JSON Schema document; throws a typed `InputError` naming the offending path (`.properties..type`, …) otherwise. ```typescript export declare function requireJSONSchema(functionName: string, field: string, value: unknown): asserts value is JSONSchema; ``` @param: functionName - The public function reporting the refusal (core's own guard order). @param: field - The argument path the document was received under. @param: value - The candidate document. Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared — - The argument path the document was received under. @param field - The argument path the document was received under. - (functionName): string; default: not declared — - The public function reporting the refusal (core's own guard order). @param functionName - The public function reporting the refusal (core's own guard order). - (value): unknown; default: not declared — - The candidate document. @param value - The candidate document. ### @insiderfinance/totalfinance/core/schema#schema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The schema builder. Returns typed schemas with `parse`/`safeParse`/`toJSONSchema`. ```typescript export declare const schema: { readonly number: () => NumberSchema; readonly string: () => StringSchema; readonly boolean: () => BooleanSchema; readonly literal: (value: V) => LiteralSchema; readonly enum: (values: readonly V[]) => EnumSchema; readonly array: (item: Schema) => ArraySchema; readonly object: >>(shape: Shape) => ObjectSchema; readonly union: []>(members: Members) => UnionSchema>; readonly record: (value: Schema) => RecordSchema; readonly unknown: () => UnknownSchema; readonly null: () => NullSchema; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - array: (item: Schema) => ArraySchema; default: not declared - array().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - array().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - array().return.describe: (description: string) => ArraySchema; default: not declared - array().return.description: string | undefined; default: not declared - array().return.isOptional: boolean; default: not declared - array().return.kind: 'array'; default: not declared - array().return.max: (maximum: number) => ArraySchema; default: not declared - array().return.min: (minimum: number) => ArraySchema; default: not declared - array().return.optional: () => OptionalSchema; default: not declared - array().return.parse: (input: unknown, options?: ParseOptions) => Item[]; default: not declared - array().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - array().return.toJSONSchema: () => JSONSchema; default: not declared - array().return.~standard: StandardSchemaV1Props; default: not declared - array(item): Schema; default: not declared - array(item).describe: (description: string) => Schema; default: not declared - array(item).isOptional: boolean; default: not declared - array(item).kind: string; default: not declared - array(item).optional: () => Schema; default: not declared - array(item).parse: (input: unknown, options?: ParseOptions) => Item; default: not declared - array(item).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - array(item).toJSONSchema: () => JSONSchema; default: not declared - array(item).~standard: StandardSchemaV1Props; default: not declared - boolean: () => BooleanSchema; default: not declared - boolean().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - boolean().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - boolean().return.describe: (description: string) => BooleanSchema; default: not declared - boolean().return.description: string | undefined; default: not declared - boolean().return.isOptional: boolean; default: not declared - boolean().return.kind: 'boolean'; default: not declared - boolean().return.optional: () => OptionalSchema; default: not declared - boolean().return.parse: (input: unknown, options?: ParseOptions) => boolean; default: not declared - boolean().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - boolean().return.toJSONSchema: () => JSONSchema; default: not declared - boolean().return.~standard: StandardSchemaV1Props; default: not declared - enum: (values: readonly V[]) => EnumSchema; default: not declared - enum().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - enum().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - enum().return.describe: (description: string) => EnumSchema; default: not declared - enum().return.description: string | undefined; default: not declared - enum().return.isOptional: boolean; default: not declared - enum().return.kind: 'enum'; default: not declared - enum().return.optional: () => OptionalSchema; default: not declared - enum().return.parse: (input: unknown, options?: ParseOptions) => V; default: not declared - enum().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - enum().return.toJSONSchema: () => JSONSchema; default: not declared - enum().return.~standard: StandardSchemaV1Props; default: not declared - enum(values): readonly V[]; default: not declared - literal: (value: V) => LiteralSchema; default: not declared - literal().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - literal().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - literal().return.describe: (description: string) => LiteralSchema; default: not declared - literal().return.description: string | undefined; default: not declared - literal().return.isOptional: boolean; default: not declared - literal().return.kind: 'literal'; default: not declared - literal().return.optional: () => OptionalSchema; default: not declared - literal().return.parse: (input: unknown, options?: ParseOptions) => V; default: not declared - literal().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - literal().return.toJSONSchema: () => JSONSchema; default: not declared - literal().return.~standard: StandardSchemaV1Props; default: not declared - literal(value): V; default: not declared - null: () => NullSchema; default: not declared - null().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - null().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - null().return.describe: (description: string) => NullSchema; default: not declared - null().return.description: string | undefined; default: not declared - null().return.isOptional: boolean; default: not declared - null().return.kind: 'null'; default: not declared - null().return.optional: () => OptionalSchema; default: not declared - null().return.parse: (input: unknown, options?: ParseOptions) => null; default: not declared - null().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - null().return.toJSONSchema: () => JSONSchema; default: not declared - null().return.~standard: StandardSchemaV1Props; default: not declared - number: () => NumberSchema; default: not declared - number().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - number().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - number().return.describe: (description: string) => NumberSchema; default: not declared - number().return.description: string | undefined; default: not declared - number().return.gt: (value: number) => NumberSchema; default: not declared - number().return.integer: () => NumberSchema; default: not declared - number().return.isOptional: boolean; default: not declared - number().return.kind: 'number'; default: not declared - number().return.lt: (value: number) => NumberSchema; default: not declared - number().return.max: (value: number) => NumberSchema; default: not declared - number().return.min: (value: number) => NumberSchema; default: not declared - number().return.nonnegative: () => NumberSchema; default: not declared - number().return.optional: () => OptionalSchema; default: not declared - number().return.parse: (input: unknown, options?: ParseOptions) => number; default: not declared - number().return.positive: () => NumberSchema; default: not declared - number().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - number().return.toJSONSchema: () => JSONSchema; default: not declared - number().return.~standard: StandardSchemaV1Props; default: not declared - object: >>(shape: Shape) => ObjectSchema; default: not declared - object().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared — @internal - object().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - object().return.describe: (description: string) => ObjectSchema; default: not declared - object().return.description: string | undefined; default: not declared - object().return.isOptional: boolean; default: not declared - object().return.kind: 'object'; default: not declared - object().return.open: () => ObjectSchema; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - object().return.optional: () => OptionalSchema<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - object().return.parse: (input: unknown, options?: ParseOptions) => { [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }; default: not declared - object().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult<{ [K in keyof ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - object().return.toJSONSchema: () => JSONSchema; default: not declared - object().return.~standard: StandardSchemaV1Props>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })]: ({ [K in Exclude>]: Infer; } & { [K in OptionalShapeKeys]?: Exclude, undefined>; })[K]; }>; default: not declared - object(shape): Shape; default: not declared - record: (value: Schema) => RecordSchema; default: not declared - record().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult>; default: not declared — @internal - record().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - record().return.describe: (description: string) => RecordSchema; default: not declared - record().return.description: string | undefined; default: not declared - record().return.isOptional: boolean; default: not declared - record().return.kind: 'record'; default: not declared - record().return.optional: () => OptionalSchema>; default: not declared - record().return.parse: (input: unknown, options?: ParseOptions) => Record; default: not declared - record().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult>; default: not declared - record().return.toJSONSchema: () => JSONSchema; default: not declared - record().return.~standard: StandardSchemaV1Props>; default: not declared - record(value): Schema; default: not declared - record(value).describe: (description: string) => Schema; default: not declared - record(value).isOptional: boolean; default: not declared - record(value).kind: string; default: not declared - record(value).optional: () => Schema; default: not declared - record(value).parse: (input: unknown, options?: ParseOptions) => V; default: not declared - record(value).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - record(value).toJSONSchema: () => JSONSchema; default: not declared - record(value).~standard: StandardSchemaV1Props; default: not declared - string: () => StringSchema; default: not declared - string().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult; default: not declared — @internal - string().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - string().return.date: () => StringSchema; default: not declared - string().return.datetime: () => StringSchema; default: not declared - string().return.describe: (description: string) => StringSchema; default: not declared - string().return.description: string | undefined; default: not declared - string().return.isOptional: boolean; default: not declared - string().return.kind: 'string'; default: not declared - string().return.max: (length: number) => StringSchema; default: not declared - string().return.min: (length: number) => StringSchema; default: not declared - string().return.nonempty: () => StringSchema; default: not declared - string().return.optional: () => OptionalSchema; default: not declared - string().return.parse: (input: unknown, options?: ParseOptions) => string; default: not declared - string().return.regex: (pattern: RegExp | string) => StringSchema; default: not declared - string().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - string().return.toJSONSchema: () => JSONSchema; default: not declared - string().return.~standard: StandardSchemaV1Props; default: not declared - union: []>(members: Members) => UnionSchema>; default: not declared - union().return._check: (input: unknown, context: SchemaCheckContext) => CheckResult>; default: not declared — @internal - union().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - union().return.describe: (description: string) => UnionSchema>; default: not declared - union().return.description: string | undefined; default: not declared - union().return.isOptional: boolean; default: not declared - union().return.kind: 'union'; default: not declared - union().return.optional: () => OptionalSchema>; default: not declared - union().return.parse: (input: unknown, options?: ParseOptions) => Infer; default: not declared - union().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult>; default: not declared - union().return.toJSONSchema: () => JSONSchema; default: not declared - union().return.~standard: StandardSchemaV1Props>; default: not declared - union(members): Members; default: not declared - unknown: () => UnknownSchema; default: not declared - unknown().return._check: (input: unknown) => CheckResult; default: not declared — @internal - unknown().return._toJSONSchema: () => JSONSchema; default: not declared — @internal - unknown().return.describe: (description: string) => UnknownSchema; default: not declared - unknown().return.description: string | undefined; default: not declared - unknown().return.isOptional: boolean; default: not declared - unknown().return.kind: 'unknown'; default: not declared - unknown().return.optional: () => OptionalSchema; default: not declared - unknown().return.parse: (input: unknown, options?: ParseOptions) => unknown; default: not declared - unknown().return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - unknown().return.toJSONSchema: () => JSONSchema; default: not declared - unknown().return.~standard: StandardSchemaV1Props; default: not declared ### @insiderfinance/totalfinance/core/schema#validate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate `input` against `schema`, returning a typed `SafeParseResult`. ```typescript export declare function validate(schema: Schema, input: unknown, options?: ParseOptions): SafeParseResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): unknown; default: not declared - (options)?: ParseOptions | undefined; default: not declared - (options).mode?: ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - (schema): Schema; default: not declared - (schema).describe: (description: string) => Schema; default: not declared - (schema).isOptional: boolean; default: not declared - (schema).kind: string; default: not declared - (schema).optional: () => Schema; default: not declared - (schema).parse: (input: unknown, options?: ParseOptions) => Output; default: not declared - (schema).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - (schema).toJSONSchema: () => JSONSchema; default: not declared - (schema).~standard: StandardSchemaV1Props; default: not declared - return.data: Output; default: not declared - return.error: InputError; default: not declared - return.issues: SchemaIssue[]; default: not declared - return.success: (false) | (true); default: not declared ## Entrypoint @insiderfinance/totalfinance/crypto ### @insiderfinance/totalfinance/crypto#BasisStructure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether a dated future trades above (contango) or below (backwardation) spot. ```typescript // ── futuresBasis ────────────────────────────────────────────────────────────── /** Whether a dated future trades above (contango) or below (backwardation) spot. */ export type BasisStructure = 'contango' | 'backwardation' | 'flat'; ``` ### @insiderfinance/totalfinance/crypto#CarryCurve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The futures carry term structure. ```typescript /** The futures carry term structure. */ export interface CarryCurve { spot: number; /** One point per future, sorted by expiry. */ points: CarryCurvePoint[]; /** Forward carries: `spot → F₁`, `F₁ → F₂`, … (one per future). */ forwards: CarryForward[]; shape: CarryCurveShape; /** Interpolated carries — present only when `queryTenors` is supplied. */ interpolated?: CarryInterp[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forwards: CarryForward[]; default: not declared — Forward carries: `spot → F₁`, `F₁ → F₂`, … (one per future). - interpolated?: CarryInterp[]; default: not declared — Interpolated carries — present only when `queryTenors` is supplied. - points: CarryCurvePoint[]; default: not declared — One point per future, sorted by expiry. - shape: CarryCurveShape; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/crypto#CarryCurveFuture Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A single dated future on the underlying. ```typescript /** A single dated future on the underlying. */ export interface CarryCurveFuture { /** Time to expiry in years. */ timeToExpiryYears: number; /** Future price. */ price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared — Future price. - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/crypto#CarryCurveInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link carryCurve}. ```typescript /** Input for {@link carryCurve}. */ export interface CarryCurveInput { /** Spot / index price (`t = 0`). */ spot: number; /** Dated futures on the same underlying (≥ 1; distinct expiries). */ futures: CarryCurveFuture[]; /** Quote financing rate — enables per-point cash-and-carry richness. */ financingRate?: number; /** Coin (base) yield. Default 0. */ coinYield?: number; /** Tenors (years) to interpolate the carry at. */ queryTenors?: number[]; /** |forward-carry| range below which the shape is `flat`. Default 5e-4 (5 bp). */ flatTolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coinYield?: number; default: not declared — Coin (base) yield. Default 0. - financingRate?: number; default: not declared — Quote financing rate — enables per-point cash-and-carry richness. - flatTolerance?: number; default: not declared — |forward-carry| range below which the shape is `flat`. Default 5e-4 (5 bp). - futures: CarryCurveFuture[]; default: not declared — Dated futures on the same underlying (≥ 1; distinct expiries). - queryTenors?: number[]; default: not declared — Tenors (years) to interpolate the carry at. - spot: number; default: not declared — Spot / index price (`t = 0`). ### @insiderfinance/totalfinance/crypto#CarryCurvePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A carry-curve point (one expiry). ```typescript /** A carry-curve point (one expiry). */ export interface CarryCurvePoint { timeToExpiryYears: number; price: number; /** `ln(price/spot)/t` — the continuously-compounded implied carry. */ annualizedCarry: number; structure: BasisStructure; /** `price − spot·e^{(r−q)t}` — present only when `financingRate` is supplied. */ richness?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedCarry: number; default: not declared — `ln(price/spot)/t` — the continuously-compounded implied carry. - price: number; default: not declared - richness?: number; default: not declared — `price − spot·e^{(r−q)t}` — present only when `financingRate` is supplied. - structure: BasisStructure; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/crypto#CarryCurveShape Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The overall term-structure shape (from the forward-carry sequence). ```typescript /** The overall term-structure shape (from the forward-carry sequence). */ export type CarryCurveShape = 'upward' | 'downward' | 'humped' | 'flat' | 'mixed'; ``` ### @insiderfinance/totalfinance/crypto#CarryForward Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The market's marginal carry over a window between two expiries (the first is `spot → F₁`). ```typescript /** The market's marginal carry over a window between two expiries (the first is `spot → F₁`). */ export interface CarryForward { fromTenorYears: number; toTenorYears: number; forwardCarry: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forwardCarry: number; default: not declared - fromTenorYears: number; default: not declared - toTenorYears: number; default: not declared ### @insiderfinance/totalfinance/crypto#CarryInterp Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An interpolated carry point. ```typescript /** An interpolated carry point. */ export interface CarryInterp { timeToExpiryYears: number; impliedForward: number; annualizedCarry: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedCarry: number; default: not declared - impliedForward: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/crypto#CarrySignal Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Which instrument prices richer carry. ```typescript // ── fundingBasisSpread ────────────────────────────────────────────────────────── /** Which instrument prices richer carry. */ export type CarrySignal = 'future-rich' | 'perpetual-rich' | 'aligned'; ``` ### @insiderfinance/totalfinance/crypto#FundingBasisSpread Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The perp-vs-future carry spread and its signal. ```typescript /** The perp-vs-future carry spread and its signal. */ export interface FundingBasisSpread { /** The perp's annualized funding (`fundingRate · periodsPerYear`). */ fundingImpliedCarry: number; /** The future's annualized log-basis (`ln(future/spot)/t`). */ basisImpliedCarry: number; /** `basisImpliedCarry − fundingImpliedCarry`. */ spread: number; signal: CarrySignal; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - basisImpliedCarry: number; default: not declared — The future's annualized log-basis (`ln(future/spot)/t`). - fundingImpliedCarry: number; default: not declared — The perp's annualized funding (`fundingRate · periodsPerYear`). - signal: CarrySignal; default: not declared - spread: number; default: not declared — `basisImpliedCarry − fundingImpliedCarry`. ### @insiderfinance/totalfinance/crypto#FundingBasisSpreadInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link fundingBasisSpread}. ```typescript /** Input for {@link fundingBasisSpread}. */ export interface FundingBasisSpreadInput { /** Perp funding for the interval. */ fundingRate: number; /** Funding interval in hours. Default 8. */ intervalHours?: number; /** Index (spot) price. */ spot: number; /** Dated-future price on the same underlying. */ future: number; /** Future's time to expiry in years. */ timeToExpiryYears: number; /** |spread| below which the two are 'aligned'. Default 0.005 (0.5 %/yr). */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fundingRate: number; default: not declared — Perp funding for the interval. - future: number; default: not declared — Dated-future price on the same underlying. - intervalHours?: number; default: not declared — Funding interval in hours. Default 8. - spot: number; default: not declared — Index (spot) price. - timeToExpiryYears: number; default: not declared — Future's time to expiry in years. - tolerance?: number; default: not declared — |spread| below which the two are 'aligned'. Default 0.005 (0.5 %/yr). ### @insiderfinance/totalfinance/crypto#FuturesBasis Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A dated future's basis and (when financing is given) its cash-and-carry edge. ```typescript /** A dated future's basis and (when financing is given) its cash-and-carry edge. */ export interface FuturesBasis { /** `future − spot`. */ basis: number; /** `future/spot − 1`. */ basisFraction: number; /** `basisPct / t` — simple annualization. */ annualizedSimple: number; /** `ln(future/spot) / t` — the continuously-compounded implied carry `r − q`. */ annualizedLog: number; structure: BasisStructure; /** `spot · e^{(r−q)·t}` — present only when `financingRate` is supplied. */ fairFuture?: number; /** `future − fairFuture` — the riskless profit at expiry (per unit) of short-future + carry-spot. */ richness?: number; /** `annualizedLog − (r − q)` — annualized excess of long-spot / short-future over financing. */ carryArbitrage?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedLog: number; default: not declared — `ln(future/spot) / t` — the continuously-compounded implied carry `r − q`. - annualizedSimple: number; default: not declared — `basisPct / t` — simple annualization. - basis: number; default: not declared — `future − spot`. - basisFraction: number; default: not declared — `future/spot − 1`. - carryArbitrage?: number; default: not declared — `annualizedLog − (r − q)` — annualized excess of long-spot / short-future over financing. - fairFuture?: number; default: not declared — `spot · e^{(r−q)·t}` — present only when `financingRate` is supplied. - richness?: number; default: not declared — `future − fairFuture` — the riskless profit at expiry (per unit) of short-future + carry-spot. - structure: BasisStructure; default: not declared ### @insiderfinance/totalfinance/crypto#FuturesBasisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link futuresBasis}. ```typescript /** Input for {@link futuresBasis}. */ export interface FuturesBasisInput { /** Index (spot) price. */ spot: number; /** Dated-future price. */ future: number; /** Time to expiry in years. */ timeToExpiryYears: number; /** Quote financing rate — supply to enable `fairFuture`/`richness`/`carryArbitrage`. */ financingRate?: number; /** Coin (base) yield. Default 0. */ coinYield?: number; /** |carryArbitrage| above which a cash-and-carry arbitrage is flagged. Default 0.05 (5 %/yr). */ arbitrageThreshold?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - arbitrageThreshold?: number; default: not declared — |carryArbitrage| above which a cash-and-carry arbitrage is flagged. Default 0.05 (5 %/yr). - coinYield?: number; default: not declared — Coin (base) yield. Default 0. - financingRate?: number; default: not declared — Quote financing rate — supply to enable `fairFuture`/`richness`/`carryArbitrage`. - future: number; default: not declared — Dated-future price. - spot: number; default: not declared — Index (spot) price. - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/crypto#InverseFuture Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The coin economics of an inverse-margined futures/perp position. ```typescript /** The coin economics of an inverse-margined futures/perp position. */ export interface InverseFuture { /** Coin PnL since entry: `s · notionalUsd · (1/entry − 1/mark)`. */ coinPnl: number; /** USD value of that coin PnL at the mark (`coinPnl · markPrice`). */ usdPnl: number; /** `∂coinPnl/∂mark = s · notionalUsd / mark²` — coin per $1 move; NOT constant (inverse convexity). */ coinDelta: number; /** `∂²coinPnl/∂mark² = s · (−2·notionalUsd / mark³)` — a LONG inverse future is SHORT gamma in coin. */ coinGamma: number; /** Coin-equivalent size at the mark (`s · notionalUsd / mark`) — how many coins the position is long. */ coinExposure: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coinDelta: number; default: not declared — `∂coinPnl/∂mark = s · notionalUsd / mark²` — coin per $1 move; NOT constant (inverse convexity). - coinExposure: number; default: not declared — Coin-equivalent size at the mark (`s · notionalUsd / mark`) — how many coins the position is long. - coinGamma: number; default: not declared — `∂²coinPnl/∂mark² = s · (−2·notionalUsd / mark³)` — a LONG inverse future is SHORT gamma in coin. - coinPnl: number; default: not declared — Coin PnL since entry: `s · notionalUsd · (1/entry − 1/mark)`. - usdPnl: number; default: not declared — USD value of that coin PnL at the mark (`coinPnl · markPrice`). ### @insiderfinance/totalfinance/crypto#InverseFutureInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link inverseFuture}. ```typescript // ── inverseFuture ─────────────────────────────────────────────────────────────── /** Input for {@link inverseFuture}. */ export interface InverseFutureInput { /** USD notional (= contracts × contract multiplier, e.g. $10/contract on Deribit). */ notionalUsd: number; /** Entry price (USD per coin). */ entryPrice: number; /** Current mark price (USD per coin). */ markPrice: number; /** Position side. Default 'long'. */ side?: InverseSide; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entryPrice: number; default: not declared — Entry price (USD per coin). - markPrice: number; default: not declared — Current mark price (USD per coin). - notionalUsd: number; default: not declared — USD notional (= contracts × contract multiplier, e.g. $10/contract on Deribit). - side?: 'long' | 'short'; default: not declared — Position side. Default 'long'. ### @insiderfinance/totalfinance/crypto#InverseHedge Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The inverse future/perp trade that neutralizes a coin delta. ```typescript /** The inverse future/perp trade that neutralizes a coin delta. */ export interface InverseHedge { /** USD notional of the inverse future to trade. */ notionalUsd: number; /** Which way to trade it. */ side: InverseSide; /** The hedge future's coin delta — equal and opposite to the input `coinDelta` (combined ⇒ 0). */ hedgeCoinDelta: number; /** Residual coin gamma after the delta hedge (`positionGamma + hedgeFutureGamma`) — iff `coinGamma` given. */ residualCoinGamma?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - hedgeCoinDelta: number; default: not declared — The hedge future's coin delta — equal and opposite to the input `coinDelta` (combined ⇒ 0). - notionalUsd: number; default: not declared — USD notional of the inverse future to trade. - residualCoinGamma?: number; default: not declared — Residual coin gamma after the delta hedge (`positionGamma + hedgeFutureGamma`) — iff `coinGamma` given. - side: 'long' | 'short'; default: not declared — Which way to trade it. ### @insiderfinance/totalfinance/crypto#InverseHedgeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link inverseHedge}. ```typescript // ── inverseHedge ──────────────────────────────────────────────────────────────── /** Input for {@link inverseHedge}. */ export interface InverseHedgeInput { /** The coin delta to neutralize (e.g. `inverseOption.greeks(…).value.coin.delta`). */ coinDelta: number; /** Mark price of the inverse future/perp used to hedge (USD per coin; a perp ≈ spot). */ markPrice: number; /** Coin gamma of the position being hedged — supply to get the residual gamma after the delta hedge. */ coinGamma?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coinDelta: number; default: not declared — The coin delta to neutralize (e.g. `inverseOption.greeks(…).value.coin.delta`). - coinGamma?: number; default: not declared — Coin gamma of the position being hedged — supply to get the residual gamma after the delta hedge. - markPrice: number; default: not declared — Mark price of the inverse future/perp used to hedge (USD per coin; a perp ≈ spot). ### @insiderfinance/totalfinance/crypto#InverseSide Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Position side of an inverse contract. ```typescript /** Position side of an inverse contract. */ export type InverseSide = (typeof SIDES)[number]; ``` ### @insiderfinance/totalfinance/crypto#Liquidation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Isolated-margin liquidation economics of a leveraged perp/future position. ```typescript /** Isolated-margin liquidation economics of a leveraged perp/future position. */ export interface Liquidation { /** Mark price at which account equity first equals the maintenance margin (isolated, at-mark). */ liquidationPrice: number; /** Mark price at which equity reaches 0 (all posted margin gone) — beyond `liquidationPrice`. */ bankruptcyPrice: number; /** Adverse move to liquidation as a fraction of entry: `|liquidationPrice − entryPrice| / entryPrice`. */ distanceToLiquidation: number; /** Initial-margin rate used, `1/leverage`. */ initialMarginRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bankruptcyPrice: number; default: not declared — Mark price at which equity reaches 0 (all posted margin gone) — beyond `liquidationPrice`. - distanceToLiquidation: number; default: not declared — Adverse move to liquidation as a fraction of entry: `|liquidationPrice − entryPrice| / entryPrice`. - initialMarginRate: number; default: not declared — Initial-margin rate used, `1/leverage`. - liquidationPrice: number; default: not declared — Mark price at which account equity first equals the maintenance margin (isolated, at-mark). ### @insiderfinance/totalfinance/crypto#LiquidationAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The convention fields {@link liquidationPrice} echoes in `assumptions` (Law 2). ```typescript /** The convention fields {@link liquidationPrice} echoes in `assumptions` (Law 2). */ export interface LiquidationAssumptions extends Record { margin: MarginMode; side: InverseSide; maintenanceMarginRate: number; marginBasis: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maintenanceMarginRate: number; default: not declared - margin: 'linear' | 'inverse'; default: not declared - marginBasis: string; default: not declared - side: 'long' | 'short'; default: not declared ### @insiderfinance/totalfinance/crypto#LiquidationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link liquidationPrice}. ```typescript /** Input for {@link liquidationPrice}. */ export interface LiquidationInput { /** Margin mode: coin-margined (`inverse`) or USDT-margined (`linear`). */ margin: MarginMode; /** Entry (average) price, USD per coin. */ entryPrice: number; /** Position leverage (`> 1`); the initial-margin rate is `1/leverage`. */ leverage: number; /** Maintenance-margin rate `m` (fraction, e.g. `0.005` = 0.5%). `0 ≤ m < 1`. */ maintenanceMarginRate: number; /** Position side. Default `'long'`. */ side?: InverseSide; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entryPrice: number; default: not declared — Entry (average) price, USD per coin. - leverage: number; default: not declared — Position leverage (`> 1`); the initial-margin rate is `1/leverage`. - maintenanceMarginRate: number; default: not declared — Maintenance-margin rate `m` (fraction, e.g. `0.005` = 0.5%). `0 ≤ m < 1`. - margin: 'linear' | 'inverse'; default: not declared — Margin mode: coin-margined (`inverse`) or USDT-margined (`linear`). - side?: 'long' | 'short'; default: not declared — Position side. Default `'long'`. ### @insiderfinance/totalfinance/crypto#MarginMode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Margin mode: `inverse` = coin-margined (Deribit/BitMEX), `linear` = USDT-margined. ```typescript /** Margin mode: `inverse` = coin-margined (Deribit/BitMEX), `linear` = USDT-margined. */ export type MarginMode = (typeof MARGIN_MODES)[number]; ``` ### @insiderfinance/totalfinance/crypto#OptionsBasisSpread Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The options-implied (put-call-parity) synthetic forward reconciled against the dated future. ```typescript /** The options-implied (put-call-parity) synthetic forward reconciled against the dated future. */ export interface OptionsBasisSpread { /** Put-call-parity synthetic forward: `strike + e^{rt}·(call − put)`. */ optionsImpliedForward: number; /** The options market's annualized implied carry: `ln(optionsImpliedForward/spot)/t`. */ optionsImpliedCarry: number; /** The future's annualized log-basis carry: `ln(future/spot)/t`. */ basisImpliedCarry: number; /** `basisImpliedCarry − optionsImpliedCarry` (annualized carry the two markets disagree by). */ spread: number; signal: OptionsCarrySignal; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - basisImpliedCarry: number; default: not declared — The future's annualized log-basis carry: `ln(future/spot)/t`. - optionsImpliedCarry: number; default: not declared — The options market's annualized implied carry: `ln(optionsImpliedForward/spot)/t`. - optionsImpliedForward: number; default: not declared — Put-call-parity synthetic forward: `strike + e^{rt}·(call − put)`. - signal: OptionsCarrySignal; default: not declared - spread: number; default: not declared — `basisImpliedCarry − optionsImpliedCarry` (annualized carry the two markets disagree by). ### @insiderfinance/totalfinance/crypto#OptionsBasisSpreadInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link optionsBasisSpread}. ```typescript /** Input for {@link optionsBasisSpread}. */ export interface OptionsBasisSpreadInput { /** Index (spot) price. */ spot: number; /** The strike at which the European call & put are quoted (the parity strike). */ strike: number; /** European call price at `strike`/expiry, in USD (same numéraire as `spot`/`put`). */ call: number; /** European put price at `strike`/expiry, in USD. */ put: number; /** Time to expiry in years. */ timeToExpiryYears: number; /** Continuously-compounded financing/discount rate used to un-discount the parity gap. */ riskFreeRate: number; /** Observed dated-future price on the same underlying/expiry. */ future: number; /** |spread| below which the two forwards are 'aligned'. Default 0.005 (0.5 %/yr). */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: number; default: not declared — European call price at `strike`/expiry, in USD (same numéraire as `spot`/`put`). - future: number; default: not declared — Observed dated-future price on the same underlying/expiry. - put: number; default: not declared — European put price at `strike`/expiry, in USD. - riskFreeRate: number; default: not declared — Continuously-compounded financing/discount rate used to un-discount the parity gap. - spot: number; default: not declared — Index (spot) price. - strike: number; default: not declared — The strike at which the European call & put are quoted (the parity strike). - timeToExpiryYears: number; default: not declared — Time to expiry in years. - tolerance?: number; default: not declared — |spread| below which the two forwards are 'aligned'. Default 0.005 (0.5 %/yr). ### @insiderfinance/totalfinance/crypto#OptionsCarrySignal Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Which market prices the richer forward: the dated future, the options-implied synthetic, or neither. ```typescript // ── optionsBasisSpread ────────────────────────────────────────────────────────── /** Which market prices the richer forward: the dated future, the options-implied synthetic, or neither. */ export type OptionsCarrySignal = 'future-rich' | 'options-rich' | 'aligned'; ``` ### @insiderfinance/totalfinance/crypto#PerpetualFunding Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The annualized carry a funding rate implies. ```typescript /** The annualized carry a funding rate implies. */ export interface PerpetualFunding { /** `markPrice/indexPrice − 1`. */ premium: number; fundingRate: number; intervalHours: number; periodsPerYear: number; /** `fundingRate · periodsPerYear` — the perp's implied cost-of-carry `r − q`. */ annualizedSimple: number; /** * `(1 + fundingRate)^periodsPerYear − 1`. `null` when `fundingRate <= −1` (−100% or worse per * interval): fractional compounding of a non-positive base is mathematically undefined — * disclosed via a `crypto.compounding_undefined` warning, never NaN (Law 7). */ annualizedCompounded: number | null; /** Carry of a LONG perp — `−annualizedSimple` (a long pays funding when it is positive). */ longCarry: number; /** Carry of a SHORT perp — `+annualizedSimple`. */ shortCarry: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedCompounded: number | null; default: not declared — `(1 + fundingRate)^periodsPerYear − 1`. `null` when `fundingRate <= −1` (−100% or worse per interval): fractional compounding of a non-positive base is mathematically undefined — disclosed via a `crypto.compounding_undefined` warning, never NaN (Law 7). - annualizedSimple: number; default: not declared — `fundingRate · periodsPerYear` — the perp's implied cost-of-carry `r − q`. - fundingRate: number; default: not declared - intervalHours: number; default: not declared - longCarry: number; default: not declared — Carry of a LONG perp — `−annualizedSimple` (a long pays funding when it is positive). - periodsPerYear: number; default: not declared - premium: number; default: not declared — `markPrice/indexPrice − 1`. - shortCarry: number; default: not declared — Carry of a SHORT perp — `+annualizedSimple`. ### @insiderfinance/totalfinance/crypto#PerpetualFundingInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link perpetualFunding}. ```typescript // ── perpetualFunding ─────────────────────────────────────────────────────────────── /** Input for {@link perpetualFunding}. */ export interface PerpetualFundingInput { /** Perpetual mark price. */ markPrice: number; /** Index (spot) price. */ indexPrice: number; /** Realized funding for the interval (fraction; 0.0001 = 0.01 %). Longs pay shorts when positive. */ fundingRate: number; /** Funding interval in hours. Default 8. */ intervalHours?: number; /** |annualized| above which the funding is flagged extreme. Default 1 (100 %/yr). */ extremeAnnualized?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - extremeAnnualized?: number; default: not declared — |annualized| above which the funding is flagged extreme. Default 1 (100 %/yr). - fundingRate: number; default: not declared — Realized funding for the interval (fraction; 0.0001 = 0.01 %). Longs pay shorts when positive. - indexPrice: number; default: not declared — Index (spot) price. - intervalHours?: number; default: not declared — Funding interval in hours. Default 8. - markPrice: number; default: not declared — Perpetual mark price. ### @insiderfinance/totalfinance/crypto#PredictedFunding Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The venue-formula next-interval funding. ```typescript /** The venue-formula next-interval funding. */ export interface PredictedFunding { /** `premium + clamp(interestRate − premium, −clamp, +clamp)`, then capped to `±cap`. */ fundingRate: number; premium: number; interestRate: number; clamp: number; /** Whether the hard `cap` bound the result. */ capped: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capped: boolean; default: not declared — Whether the hard `cap` bound the result. - clamp: number; default: not declared - fundingRate: number; default: not declared — `premium + clamp(interestRate − premium, −clamp, +clamp)`, then capped to `±cap`. - interestRate: number; default: not declared - premium: number; default: not declared ### @insiderfinance/totalfinance/crypto#PredictedFundingInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link predictedFunding}. ```typescript // ── predictedFunding ────────────────────────────────────────────────────────── /** Input for {@link predictedFunding}. */ export interface PredictedFundingInput { /** Premium index — the TWAP of `(perp − index)/index` over the interval. */ premium: number; /** Interest-rate component per interval (quote − base). Default 0. */ interestRate?: number; /** Clamp half-width applied to the interest component. Default 0.0005 (Binance). */ clamp?: number; /** Optional hard cap on |funding|. */ cap?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cap?: number; default: not declared — Optional hard cap on |funding|. - clamp?: number; default: not declared — Clamp half-width applied to the interest component. Default 0.0005 (Binance). - interestRate?: number; default: not declared — Interest-rate component per interval (quote − base). Default 0. - premium: number; default: not declared — Premium index — the TWAP of `(perp − index)/index` over the interval. ### @insiderfinance/totalfinance/crypto#carryCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function carryCurve(input: CarryCurveInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CarryCurveInput; default: not declared - (input).coinYield?: number; default: not declared — Coin (base) yield. Default 0. - (input).financingRate?: number; default: not declared — Quote financing rate — enables per-point cash-and-carry richness. - (input).flatTolerance?: number; default: not declared — |forward-carry| range below which the shape is `flat`. Default 5e-4 (5 bp). - (input).futures: CarryCurveFuture[]; default: not declared — Dated futures on the same underlying (≥ 1; distinct expiries). - (input).queryTenors?: number[]; default: not declared — Tenors (years) to interpolate the carry at. - (input).spot: number; default: not declared — Spot / index price (`t = 0`). - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: CarryCurve; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#fundingBasisSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function fundingBasisSpread(input: FundingBasisSpreadInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FundingBasisSpreadInput; default: not declared - (input).fundingRate: number; default: not declared — Perp funding for the interval. - (input).future: number; default: not declared — Dated-future price on the same underlying. - (input).intervalHours?: number; default: not declared — Funding interval in hours. Default 8. - (input).spot: number; default: not declared — Index (spot) price. - (input).timeToExpiryYears: number; default: not declared — Future's time to expiry in years. - (input).tolerance?: number; default: not declared — |spread| below which the two are 'aligned'. Default 0.005 (0.5 %/yr). - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: FundingBasisSpread; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#futuresBasis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function futuresBasis(input: FuturesBasisInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FuturesBasisInput; default: not declared - (input).arbitrageThreshold?: number; default: not declared — |carryArbitrage| above which a cash-and-carry arbitrage is flagged. Default 0.05 (5 %/yr). - (input).coinYield?: number; default: not declared — Coin (base) yield. Default 0. - (input).financingRate?: number; default: not declared — Quote financing rate — supply to enable `fairFuture`/`richness`/`carryArbitrage`. - (input).future: number; default: not declared — Dated-future price. - (input).spot: number; default: not declared — Index (spot) price. - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: FuturesBasis; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#inverseFuture Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function inverseFuture(input: InverseFutureInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InverseFutureInput; default: not declared - (input).entryPrice: number; default: not declared — Entry price (USD per coin). - (input).markPrice: number; default: not declared — Current mark price (USD per coin). - (input).notionalUsd: number; default: not declared — USD notional (= contracts × contract multiplier, e.g. $10/contract on Deribit). - (input).side?: 'long' | 'short'; default: not declared — Position side. Default 'long'. - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: InverseFuture; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#inverseHedge Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function inverseHedge(input: InverseHedgeInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InverseHedgeInput; default: not declared - (input).coinDelta: number; default: not declared — The coin delta to neutralize (e.g. `inverseOption.greeks(…).value.coin.delta`). - (input).coinGamma?: number; default: not declared — Coin gamma of the position being hedged — supply to get the residual gamma after the delta hedge. - (input).markPrice: number; default: not declared — Mark price of the inverse future/perp used to hedge (USD per coin; a perp ≈ spot). - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: InverseHedge; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#liquidationPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Isolated-margin liquidation & bankruptcy price of a leveraged perpetual/future position (inverse or linear). Size-independent: depends only on entry price, leverage, maintenance-margin rate, side, and margin mode. Maintenance is assessed at the mark (see the module doc for the convention and the closed forms). Requires `leverage > 1` — an isolated liquidation price is degenerate at ≤1×. ```typescript export declare function liquidationPrice(input: LiquidationInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LiquidationInput; default: not declared - (input).entryPrice: number; default: not declared — Entry (average) price, USD per coin. - (input).leverage: number; default: not declared — Position leverage (`> 1`); the initial-margin rate is `1/leverage`. - (input).maintenanceMarginRate: number; default: not declared — Maintenance-margin rate `m` (fraction, e.g. `0.005` = 0.5%). `0 ≤ m < 1`. - (input).margin: 'linear' | 'inverse'; default: not declared — Margin mode: coin-margined (`inverse`) or USDT-margined (`linear`). - (input).side?: 'long' | 'short'; default: not declared — Position side. Default `'long'`. - return.assumptions: Assumptions; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: Liquidation; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#optionsBasisSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function optionsBasisSpread(input: OptionsBasisSpreadInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OptionsBasisSpreadInput; default: not declared - (input).call: number; default: not declared — European call price at `strike`/expiry, in USD (same numéraire as `spot`/`put`). - (input).future: number; default: not declared — Observed dated-future price on the same underlying/expiry. - (input).put: number; default: not declared — European put price at `strike`/expiry, in USD. - (input).riskFreeRate: number; default: not declared — Continuously-compounded financing/discount rate used to un-discount the parity gap. - (input).spot: number; default: not declared — Index (spot) price. - (input).strike: number; default: not declared — The strike at which the European call & put are quoted (the parity strike). - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).tolerance?: number; default: not declared — |spread| below which the two forwards are 'aligned'. Default 0.005 (0.5 %/yr). - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: OptionsBasisSpread; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#perpetualFunding Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Annualize a perpetual funding rate into its implied cost-of-carry, in both simple and compounded terms, with the long/short carry sign made explicit. See `docs/specs/crypto-carry.md`. ```typescript export declare function perpetualFunding(input: PerpetualFundingInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PerpetualFundingInput; default: not declared - (input).extremeAnnualized?: number; default: not declared — |annualized| above which the funding is flagged extreme. Default 1 (100 %/yr). - (input).fundingRate: number; default: not declared — Realized funding for the interval (fraction; 0.0001 = 0.01 %). Longs pay shorts when positive. - (input).indexPrice: number; default: not declared — Index (spot) price. - (input).intervalHours?: number; default: not declared — Funding interval in hours. Default 8. - (input).markPrice: number; default: not declared — Perpetual mark price. - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: PerpetualFunding; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/crypto#predictedFunding Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function predictedFunding(input: PredictedFundingInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PredictedFundingInput; default: not declared - (input).cap?: number; default: not declared — Optional hard cap on |funding|. - (input).clamp?: number; default: not declared — Clamp half-width applied to the interest component. Default 0.0005 (Binance). - (input).interestRate?: number; default: not declared — Interest-rate component per interval (quote − base). Default 0. - (input).premium: number; default: not declared — Premium index — the TWAP of `(perp − index)/index` over the interval. - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: PredictedFunding; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ## Entrypoint @insiderfinance/totalfinance/crypto/carry ### @insiderfinance/totalfinance/crypto/carry#BasisStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#BasisStructure`. ### @insiderfinance/totalfinance/crypto/carry#CarrySignal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarrySignal`. ### @insiderfinance/totalfinance/crypto/carry#FundingBasisSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#FundingBasisSpread`. ### @insiderfinance/totalfinance/crypto/carry#FundingBasisSpreadInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#FundingBasisSpreadInput`. ### @insiderfinance/totalfinance/crypto/carry#FuturesBasis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#FuturesBasis`. ### @insiderfinance/totalfinance/crypto/carry#FuturesBasisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#FuturesBasisInput`. ### @insiderfinance/totalfinance/crypto/carry#OptionsBasisSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#OptionsBasisSpread`. ### @insiderfinance/totalfinance/crypto/carry#OptionsBasisSpreadInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#OptionsBasisSpreadInput`. ### @insiderfinance/totalfinance/crypto/carry#OptionsCarrySignal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#OptionsCarrySignal`. ### @insiderfinance/totalfinance/crypto/carry#PerpetualFunding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#PerpetualFunding`. ### @insiderfinance/totalfinance/crypto/carry#PerpetualFundingInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#PerpetualFundingInput`. ### @insiderfinance/totalfinance/crypto/carry#PredictedFunding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#PredictedFunding`. ### @insiderfinance/totalfinance/crypto/carry#PredictedFundingInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#PredictedFundingInput`. ### @insiderfinance/totalfinance/crypto/carry#fundingBasisSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#fundingBasisSpread`. ### @insiderfinance/totalfinance/crypto/carry#futuresBasis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#futuresBasis`. ### @insiderfinance/totalfinance/crypto/carry#optionsBasisSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#optionsBasisSpread`. ### @insiderfinance/totalfinance/crypto/carry#perpetualFunding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#perpetualFunding`. ### @insiderfinance/totalfinance/crypto/carry#predictedFunding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#predictedFunding`. ## Entrypoint @insiderfinance/totalfinance/crypto/curve ### @insiderfinance/totalfinance/crypto/curve#CarryCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryCurve`. ### @insiderfinance/totalfinance/crypto/curve#CarryCurveFuture Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryCurveFuture`. ### @insiderfinance/totalfinance/crypto/curve#CarryCurveInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryCurveInput`. ### @insiderfinance/totalfinance/crypto/curve#CarryCurvePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryCurvePoint`. ### @insiderfinance/totalfinance/crypto/curve#CarryCurveShape Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryCurveShape`. ### @insiderfinance/totalfinance/crypto/curve#CarryForward Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryForward`. ### @insiderfinance/totalfinance/crypto/curve#CarryInterp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#CarryInterp`. ### @insiderfinance/totalfinance/crypto/curve#carryCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#carryCurve`. ## Entrypoint @insiderfinance/totalfinance/crypto/inverse ### @insiderfinance/totalfinance/crypto/inverse#InverseFuture Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#InverseFuture`. ### @insiderfinance/totalfinance/crypto/inverse#InverseFutureInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#InverseFutureInput`. ### @insiderfinance/totalfinance/crypto/inverse#InverseHedge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#InverseHedge`. ### @insiderfinance/totalfinance/crypto/inverse#InverseHedgeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#InverseHedgeInput`. ### @insiderfinance/totalfinance/crypto/inverse#InverseSide Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#InverseSide`. ### @insiderfinance/totalfinance/crypto/inverse#inverseFuture Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#inverseFuture`. ### @insiderfinance/totalfinance/crypto/inverse#inverseHedge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#inverseHedge`. ## Entrypoint @insiderfinance/totalfinance/crypto/liquidation ### @insiderfinance/totalfinance/crypto/liquidation#Liquidation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#Liquidation`. ### @insiderfinance/totalfinance/crypto/liquidation#LiquidationAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#LiquidationAssumptions`. ### @insiderfinance/totalfinance/crypto/liquidation#LiquidationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#LiquidationInput`. ### @insiderfinance/totalfinance/crypto/liquidation#MarginMode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#MarginMode`. ### @insiderfinance/totalfinance/crypto/liquidation#liquidationPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/crypto#liquidationPrice`. ## Entrypoint @insiderfinance/totalfinance/data ### @insiderfinance/totalfinance/data#CommonPageFacts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#CommonPageFacts`. ### @insiderfinance/totalfinance/data#ConnectedData Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ConnectedData`. ### @insiderfinance/totalfinance/data#DataCallOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCallOptions`. ### @insiderfinance/totalfinance/data#DataCapabilities Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCapabilities`. ### @insiderfinance/totalfinance/data#DataCapability Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCapability`. ### @insiderfinance/totalfinance/data#DataCapabilityDeclaration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataCapabilityDeclaration`. ### @insiderfinance/totalfinance/data#DataConnectionOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataConnectionOptions`. ### @insiderfinance/totalfinance/data#DataContinuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataContinuation`. ### @insiderfinance/totalfinance/data#DataFor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataFor`. ### @insiderfinance/totalfinance/data#DataGuidanceRule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataGuidanceRule`. ### @insiderfinance/totalfinance/data#DataInterval Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataInterval`. ### @insiderfinance/totalfinance/data#DataKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataKind`. ### @insiderfinance/totalfinance/data#DataPage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPage`. ### @insiderfinance/totalfinance/data#DataPageMetadata Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPageMetadata`. ### @insiderfinance/totalfinance/data#DataPageOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPageOptions`. ### @insiderfinance/totalfinance/data#DataPins Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataPins`. ### @insiderfinance/totalfinance/data#DataProvider Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProvider`. ### @insiderfinance/totalfinance/data#DataProviderErrorOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProviderErrorOptions`. ### @insiderfinance/totalfinance/data#DataProviderFailure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProviderFailure`. ### @insiderfinance/totalfinance/data#DataProviderSource Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataProviderSource`. ### @insiderfinance/totalfinance/data#DataQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataQuery`. ### @insiderfinance/totalfinance/data#DataQueryBinding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataQueryBinding`. ### @insiderfinance/totalfinance/data#DataQueryOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataQueryOptions`. ### @insiderfinance/totalfinance/data#DataView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataView`. ### @insiderfinance/totalfinance/data#DataViewFor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DataViewFor`. ### @insiderfinance/totalfinance/data#KnownDataField Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#KnownDataField`. ### @insiderfinance/totalfinance/data#OHLCField Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OHLCField`. ### @insiderfinance/totalfinance/data#ObservationTimes Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ObservationTimes`. ### @insiderfinance/totalfinance/data#OhlcvInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OhlcvInput`. ### @insiderfinance/totalfinance/data#OptionChainResearchQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionChainResearchQuery`. ### @insiderfinance/totalfinance/data#OptionChainResearchRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionChainResearchRecord`. ### @insiderfinance/totalfinance/data#OptionChainResearchView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionChainResearchView`. ### @insiderfinance/totalfinance/data#OptionResearchTerms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OptionResearchTerms`. ### @insiderfinance/totalfinance/data#PriceBarRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarRecord`. ### @insiderfinance/totalfinance/data#PriceBarsCheckpoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsCheckpoint`. ### @insiderfinance/totalfinance/data#PriceBarsPageFacts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsPageFacts`. ### @insiderfinance/totalfinance/data#PriceBarsPaging Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsPaging`. ### @insiderfinance/totalfinance/data#PriceBarsQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsQuery`. ### @insiderfinance/totalfinance/data#PriceBarsSelections Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsSelections`. ### @insiderfinance/totalfinance/data#PriceBarsView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsView`. ### @insiderfinance/totalfinance/data#PriceBarsWindow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindow`. ### @insiderfinance/totalfinance/data#PriceBarsWindowOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindowOptions`. ### @insiderfinance/totalfinance/data#PriceBarsWindowRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindowRequest`. ### @insiderfinance/totalfinance/data#PriceBarsWindowView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#PriceBarsWindowView`. ### @insiderfinance/totalfinance/data#ResearchBarChoice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ResearchBarChoice`. ### @insiderfinance/totalfinance/data#ResearchBarIssue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ResearchBarIssue`. ### @insiderfinance/totalfinance/data#ResearchBarSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ResearchBarSelection`. ### @insiderfinance/totalfinance/data#RowReference Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#RowReference`. ### @insiderfinance/totalfinance/data#SourceOptionChainPage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SourceOptionChainPage`. ### @insiderfinance/totalfinance/data#SourcePriceBarRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SourcePriceBarRecord`. ### @insiderfinance/totalfinance/data#SourcePriceBarsPage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SourcePriceBarsPage`. ### @insiderfinance/totalfinance/data#TimestampedOhlcvInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#TimestampedOhlcvInput`. ### @insiderfinance/totalfinance/data#connect Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#connect`. ### @insiderfinance/totalfinance/data#createPriceBarsWindowView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#createPriceBarsWindowView`. ### @insiderfinance/totalfinance/data#priceBarsCheckpoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#priceBarsCheckpoint`. ## Entrypoint @insiderfinance/totalfinance/fixed-income ### @insiderfinance/totalfinance/fixed-income#Amortization Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Amortization style for an amortizing bond. ```typescript /** Amortization style for an amortizing bond. */ export type Amortization = { type: 'straight'; } // equal principal each period | { type: 'annuity'; } // level total payment (principal + interest) | { principalByPeriod: readonly number[]; }; // explicit principal repayments, one per coupon period ``` Members/parameters (default = JSDoc only; not declared means no documented default): - principalByPeriod: readonly number[]; default: not declared - type: ('annuity') | ('straight'); default: not declared ### @insiderfinance/totalfinance/fixed-income#AmortizingBondSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AmortizingBondSpecification extends BaseSpecification { amortization: Amortization; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amortization: Amortization; default: not declared - amortization.principalByPeriod: readonly number[]; default: not declared - amortization.type: ('annuity') | ('straight'); default: not declared - convention?: BusinessDayConvention; default: not declared - couponRate: number; default: not declared — Annualized coupon rate (decimal). - dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - endOfMonth?: boolean; default: not declared - faceValue?: number; default: not declared — Redemption / par value. Default 100. - frequency: Frequency; default: not declared - issueDate: string; default: not declared — Dated date / first accrual date. - maturityDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#BaseSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The fields every bond specification shares — the base the per-kind specifications extend. ```typescript /** The fields every bond specification shares — the base the per-kind specifications extend. */ export interface BaseSpecification { /** Dated date / first accrual date. */ issueDate: string; maturityDate: string; /** Annualized coupon rate (decimal). */ couponRate: number; frequency: Frequency; /** Redemption / par value. Default 100. */ faceValue?: number; /** Accrual day count. Default `30/360`. */ dayCount?: FixedIncomeDayCount; convention?: BusinessDayConvention; endOfMonth?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention?: BusinessDayConvention; default: not declared - couponRate: number; default: not declared — Annualized coupon rate (decimal). - dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - endOfMonth?: boolean; default: not declared - faceValue?: number; default: not declared — Redemption / par value. Default 100. - frequency: Frequency; default: not declared - issueDate: string; default: not declared — Dated date / first accrual date. - maturityDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#BermudanSwaptionResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BermudanSwaptionResult { /** Option value, scaled by `notional`. */ price: number; /** The exercise schedule actually used, sorted ascending from the valuation date. */ exerciseDates: string[]; /** Applied conventions and model knobs, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; model: 'hull-white'; dayCount: 'ACT/365F'; settlementDate: string; stepsPerYear: number; meanReversion: number; sigma: number; fixedFrequency: Frequency; fixedDayCount: FixedIncomeDayCount; notional: number; }; /** Honest computation report: the lattice method behind the price (Law 2 report grammar). */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; fixedDayCount: FixedIncomeDayCount; fixedFrequency: Frequency; meanReversion: number; model: 'hull-white'; notional: number; settlementDate: string; sigma: number; stepsPerYear: number; }; default: not declared — Applied conventions and model knobs, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: 'ACT/365F'; default: not declared - assumptions.fixedDayCount: FixedIncomeDayCount; default: not declared - assumptions.fixedFrequency: Frequency; default: not declared - assumptions.meanReversion: number; default: not declared - assumptions.model: 'hull-white'; default: not declared - assumptions.notional: number; default: not declared - assumptions.settlementDate: string; default: not declared - assumptions.sigma: number; default: not declared - assumptions.stepsPerYear: number; default: not declared - diagnostics: Diagnostics; default: not declared — Honest computation report: the lattice method behind the price (Law 2 report grammar). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - exerciseDates: string[]; default: not declared — The exercise schedule actually used, sorted ascending from the valuation date. - price: number; default: not declared — Option value, scaled by `notional`. ### @insiderfinance/totalfinance/fixed-income#BermudanSwaptionSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Bermudan swaptions ───────────────────────── export interface BermudanSwaptionSpecification { /** Discount/forecast curve (single-curve); its reference date is the valuation date. */ curve: YieldCurve; /** Underlying swap maturity. */ maturityDate: string; /** Fixed rate of the underlying swap. */ fixedRate: number; /** `payer` = option to pay fixed; `receiver` = option to receive fixed. */ optionType: 'payer' | 'receiver'; /** Dates on which the holder may exercise into the swap (each is a swap start). */ exerciseDates: string[]; /** Fixed-leg frequency (default semiannual). */ fixedFrequency?: Frequency; /** Fixed-leg day count (default `30/360`). */ fixedDayCount?: FixedIncomeDayCount; /** Mean reversion and short-rate vol. */ meanReversion: number; sigma: number; notional?: number; /** Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). */ stepsPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - curve: YieldCurve; default: not declared — Discount/forecast curve (single-curve); its reference date is the valuation date. - curve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curve.addSpread(spread): YieldCurve; default: not declared - curve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curve.bumpPillar(delta): number; default: not declared - curve.bumpPillar(index): number; default: not declared - curve.dayCount: FixedIncomeDayCount; default: not declared - curve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curve.discount(at): string | number; default: not declared - curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - curve.forwardRate(from): string | number; default: not declared - curve.forwardRate(to): string | number; default: not declared - curve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curve.instantaneousForward(at): string | number; default: not declared - curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curve.referenceDate: string; default: not declared - curve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curve.shift(delta): number; default: not declared - curve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curve.timeTo(at): string | number; default: not declared - curve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curve.zeroRate(at): string | number; default: not declared - curve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - curve.zeroRate(compounding).periodsPerYear: number; default: not declared - curve.zeroRate(compounding).type: 'periodic'; default: not declared - exerciseDates: string[]; default: not declared — Dates on which the holder may exercise into the swap (each is a swap start). - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - fixedRate: number; default: not declared — Fixed rate of the underlying swap. - maturityDate: string; default: not declared — Underlying swap maturity. - meanReversion: number; default: not declared — Mean reversion and short-rate vol. - notional?: number; default: not declared - optionType: 'payer' | 'receiver'; default: not declared — `payer` = option to pay fixed; `receiver` = option to receive fixed. - sigma: number; default: not declared - stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). ### @insiderfinance/totalfinance/fixed-income#Bond Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A constructed bond: schedule, cash flows, and settlement-relative helpers. ```typescript /** A constructed bond: schedule, cash flows, and settlement-relative helpers. */ export interface Bond { readonly kind: BondKind; readonly faceValue: number; readonly issueDate: string; readonly maturityDate: string; readonly couponRate: number; readonly frequency: number; readonly dayCount: FixedIncomeDayCount; /** Business-day convention applied when the payment schedule was generated. */ readonly businessDayConvention: BusinessDayConvention; readonly schedule: readonly SchedulePeriod[]; /** Every life cash flow (projected via `context` for FRN/inflation). */ cashflows(context?: ProjectionContext): CashFlow[]; /** Cash flows strictly after `settlementDate` — what a buyer settling then receives. */ futureCashflows(settlementDate: string, context?: ProjectionContext): CashFlow[]; /** Accrued interest at `settlementDate` (per the bond's face value). */ accrued(settlementDate: string, context?: ProjectionContext): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - accrued(context)?: ProjectionContext | undefined; default: not declared - accrued(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - accrued(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - accrued(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - accrued(settlementDate): string; default: not declared - businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - cashflows(context)?: ProjectionContext | undefined; default: not declared - cashflows(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - cashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - cashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - couponRate: number; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - faceValue: number; default: not declared - frequency: number; default: not declared - futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - futureCashflows(context)?: ProjectionContext | undefined; default: not declared - futureCashflows(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - futureCashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - futureCashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - futureCashflows(settlementDate): string; default: not declared - issueDate: string; default: not declared - kind: BondKind; default: not declared - maturityDate: string; default: not declared - schedule: readonly SchedulePeriod[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#BondAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Conventions echoed on every bond pricing/metrics result (spec §7.4 / WS2.2). Bonds discount either actuarially (`(1 + y/f)^(−f·τ)`) or off a curve, so `compounding` and `dayCount` are widened past the core enums; the rest matches the shared `Assumptions` shape. ```typescript /** * Conventions echoed on every bond pricing/metrics result (spec §7.4 / WS2.2). Bonds discount either * actuarially (`(1 + y/f)^(−f·τ)`) or off a curve, so `compounding` and `dayCount` are widened past * the core enums; the rest matches the shared `Assumptions` shape. */ export type BondAssumptions = Omit & { dayCount: FixedIncomeDayCount; /** `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. */ compounding: 'actuarial' | 'curve'; /** Coupon payments per year actually used in discounting. */ frequency: number; /** Settlement date the result was computed as of. */ settlementDate: string; /** Business-day convention baked into the payment schedule. */ businessDayConvention: BusinessDayConvention; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - conventionsVersion: string; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - frequency: number; default: not declared — Coupon payments per year actually used in discounting. - model?: string; default: not declared - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - settlementDate: string; default: not declared — Settlement date the result was computed as of. - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared ### @insiderfinance/totalfinance/fixed-income#BondComputed Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The {@link Computed} envelope specialised to bond results (dx §2.7): `assumptions` is the widened {@link BondAssumptions} — fixed income needs the `ACT/ACT`/`30E/360` day counts and the `actuarial`/`curve` compounding modes that the core enums do not carry. Structurally this IS the core envelope (`value` + `assumptions.conventionsVersion` + `diagnostics.warnings`), so it satisfies `isComputed` and the WS-7.2 conformance sweep. ```typescript /** * The {@link Computed} envelope specialised to bond results (dx §2.7): `assumptions` is the widened * {@link BondAssumptions} — fixed income needs the `ACT/ACT`/`30E/360` day counts and the * `actuarial`/`curve` compounding modes that the core enums do not carry. Structurally this IS the * core envelope (`value` + `assumptions.conventionsVersion` + `diagnostics.warnings`), so it * satisfies `isComputed` and the WS-7.2 conformance sweep. */ export interface BondComputed { value: T; assumptions: BondAssumptions; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: BondAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: FixedIncomeDayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.frequency: number; default: not declared — Coupon payments per year actually used in discounting. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.settlementDate: string; default: not declared — Settlement date the result was computed as of. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - value: T; default: not declared ### @insiderfinance/totalfinance/fixed-income#BondFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A bond facade: the plain call plus an `.explain()` companion returning {@link BondComputed}. ```typescript /** A bond facade: the plain call plus an `.explain()` companion returning {@link BondComputed}. */ export type BondFacade = ((...callArguments: Args) => Out) & { explain: (...callArguments: Args) => BondComputed; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): Args; default: not declared - explain: (...callArguments: Args) => BondComputed; default: not declared - explain().return.assumptions: BondAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared - explain().return.value: EOut; default: not declared - explain(callArguments): Args; default: not declared ### @insiderfinance/totalfinance/fixed-income#BondFutureCtdFrontierInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link bondFutureCtdFrontier} — a {@link BondFutureInput} basket plus the scan controls. ```typescript /** Input for {@link bondFutureCtdFrontier} — a {@link BondFutureInput} basket plus the scan controls. */ export interface BondFutureCtdFrontierInput extends BondFutureInput { /** Parallel yield shifts (bp) to scan. Default `{ from: -200, to: 200, step: 25 }` (17 nodes incl. 0). */ yieldShiftsBp?: YieldShiftGrid; /** * Optional futures-price path, one entry per *explicit* shift (the `(shift, price)` pairs are sorted * together). Omit to hold the input futures quote constant across the scan (a ceteris-paribus basis * question). A discrete path does not define values between nodes, so its switches stay grid-labeled. */ futuresPrices?: readonly number[]; /** Refine held-constant-policy switch brackets to a crossing; default `true`. Invalid with `futuresPrices`. */ refineSwitches?: boolean; /** Maximum reported switch-location bracket width in shift basis points; default `0.01`. */ switchLocationToleranceBp?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deliverables: DeliverableBond[]; default: not declared - deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - futuresPrice: number; default: not declared — Futures price per 100 face. - futuresPrices?: readonly number[]; default: not declared — Optional futures-price path, one entry per *explicit* shift (the `(shift, price)` pairs are sorted together). Omit to hold the input futures quote constant across the scan (a ceteris-paribus basis question). A discrete path does not define values between nodes, so its switches stay grid-labeled. - notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - refineSwitches?: boolean; default: not declared — Refine held-constant-policy switch brackets to a crossing; default `true`. Invalid with `futuresPrices`. - repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - switchLocationToleranceBp?: number; default: not declared — Maximum reported switch-location bracket width in shift basis points; default `0.01`. - yieldShiftsBp?: YieldShiftGrid; default: not declared — Parallel yield shifts (bp) to scan. Default `{ from: -200, to: 200, step: 25 }` (17 nodes incl. 0). - yieldShiftsBp.from: number; default: not declared - yieldShiftsBp.step: number; default: not declared - yieldShiftsBp.to: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#BondFutureCtdFrontierResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The bond-future CTD switching-frontier analysis. ```typescript /** The bond-future CTD switching-frontier analysis. */ export interface BondFutureCtdFrontierResult { /** The current (unshifted) cheapest-to-deliver. */ current: { ctdId: string; ctdYield: number; conversionFactor: number; }; /** Every scanned node, ordered by ascending yield shift. */ scenarios: CtdFrontierScenario[]; /** Every CTD switch across the scan (a third-deliverable window splits into two transitions). */ switches: CtdSwitch[]; risk: { /** The current futures DV01 from the spot cash DV01 / CF (matches {@link bondFutureHedge}). */ spotFuturesDv01: number; /** The futures DV01 from the CTD's *forward* DV01 at the delivery date / CF — the delivery risk. */ deliveryDateFuturesDv01: number; /** The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. */ impliedForwardYield: number; }; assumptions: { conventionsVersion: string; settlementDate: string; deliveryDate: string; futuresPriceScenario: 'held-constant' | 'supplied-path'; yieldShock: 'parallel'; yieldShiftsBp: number[]; refineSwitches: boolean; switchLocationToleranceBp: number | null; /** Internal global-tie test, decimal annualized implied-repo rate; a fixed library assumption. */ repoRateTieTolerance: 1e-10; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; deliveryDate: string; futuresPriceScenario: 'held-constant' | 'supplied-path'; refineSwitches: boolean; repoRateTieTolerance: 1e-10; settlementDate: string; switchLocationToleranceBp: number | null; yieldShiftsBp: number[]; yieldShock: 'parallel'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.deliveryDate: string; default: not declared - assumptions.futuresPriceScenario: 'held-constant' | 'supplied-path'; default: not declared - assumptions.refineSwitches: boolean; default: not declared - assumptions.repoRateTieTolerance: 1e-10; default: not declared — Internal global-tie test, decimal annualized implied-repo rate; a fixed library assumption. - assumptions.settlementDate: string; default: not declared - assumptions.switchLocationToleranceBp: number | null; default: not declared - assumptions.yieldShiftsBp: number[]; default: not declared - assumptions.yieldShock: 'parallel'; default: not declared - current: { conversionFactor: number; ctdId: string; ctdYield: number; }; default: not declared — The current (unshifted) cheapest-to-deliver. - current.conversionFactor: number; default: not declared - current.ctdId: string; default: not declared - current.ctdYield: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - risk: { deliveryDateFuturesDv01: number; impliedForwardYield: number; spotFuturesDv01: number; }; default: not declared - risk.deliveryDateFuturesDv01: number; default: not declared — The futures DV01 from the CTD's *forward* DV01 at the delivery date / CF — the delivery risk. - risk.impliedForwardYield: number; default: not declared — The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. - risk.spotFuturesDv01: number; default: not declared — The current futures DV01 from the spot cash DV01 / CF (matches {@link bondFutureHedge}). - scenarios: CtdFrontierScenario[]; default: not declared — Every scanned node, ordered by ascending yield shift. - switches: CtdSwitch[]; default: not declared — Every CTD switch across the scan (a third-deliverable window splits into two transitions). ### @insiderfinance/totalfinance/fixed-income#BondFutureHedgeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link bondFutureHedge} — the basket plus an optional position to hedge. ```typescript // --------------------------------------------------------------------------------------------------- // Bond-future DV01 hedge & futures-implied yield // --------------------------------------------------------------------------------------------------- /** Input for {@link bondFutureHedge} — the basket plus an optional position to hedge. */ export interface BondFutureHedgeInput extends BondFutureInput { /** DV01 (per 100 face) of the position to hedge; when given, the result reports `hedgeRatio`. */ hedgeDv01?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deliverables: DeliverableBond[]; default: not declared - deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - futuresPrice: number; default: not declared — Futures price per 100 face. - hedgeDv01?: number; default: not declared — DV01 (per 100 face) of the position to hedge; when given, the result reports `hedgeRatio`. - notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). ### @insiderfinance/totalfinance/fixed-income#BondFutureHedgeResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The bond-future hedge analysis. ```typescript /** The bond-future hedge analysis. */ export interface BondFutureHedgeResult { ctdId: string; ctdConversionFactor: number; /** Spot yield of the CTD at its market clean price. */ ctdYield: number; /** DV01 of the CTD cash bond per 100 face (at its market yield). */ ctdDv01: number; /** The futures contract's DV01 per 100 face of notional (`ctdDv01 / CF_ctd`). */ futuresDv01: number; /** The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. */ impliedForwardYield: number; /** # futures (per 100 face) whose DV01 offsets `hedgeDv01` — SELL them to hedge a long book. Present iff `hedgeDv01` was supplied. */ hedgeRatio?: number; /** Per-deliverable spot yield + DV01 across the basket (CTD first). */ deliverables: DeliverableRisk[]; assumptions: { conventionsVersion: string; futuresPrice: number; settlementDate: string; deliveryDate: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; deliveryDate: string; futuresPrice: number; settlementDate: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.deliveryDate: string; default: not declared - assumptions.futuresPrice: number; default: not declared - assumptions.settlementDate: string; default: not declared - ctdConversionFactor: number; default: not declared - ctdDv01: number; default: not declared — DV01 of the CTD cash bond per 100 face (at its market yield). - ctdId: string; default: not declared - ctdYield: number; default: not declared — Spot yield of the CTD at its market clean price. - deliverables: DeliverableRisk[]; default: not declared — Per-deliverable spot yield + DV01 across the basket (CTD first). - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - futuresDv01: number; default: not declared — The futures contract's DV01 per 100 face of notional (`ctdDv01 / CF_ctd`). - hedgeRatio?: number; default: not declared — # futures (per 100 face) whose DV01 offsets `hedgeDv01` — SELL them to hedge a long book. Present iff `hedgeDv01` was supplied. - impliedForwardYield: number; default: not declared — The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. ### @insiderfinance/totalfinance/fixed-income#BondFutureInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link bondFuture}. ```typescript /** Input for {@link bondFuture}. */ export interface BondFutureInput { /** Futures price per 100 face. */ futuresPrice: number; /** Settlement date — when the cash bond is bought (ISO). */ settlementDate: string; /** Delivery date — when the short delivers into the future (ISO). */ deliveryDate: string; /** ACT/360 financing (repo) rate (decimal) used for carry / net basis. */ repoRate: number; /** The contract's notional coupon (decimal); default `0.06`. */ notionalCoupon?: number; deliverables: DeliverableBond[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deliverables: DeliverableBond[]; default: not declared - deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - futuresPrice: number; default: not declared — Futures price per 100 face. - notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). ### @insiderfinance/totalfinance/fixed-income#BondFutureResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The bond-future basket analysis. ```typescript /** The bond-future basket analysis. */ export interface BondFutureResult { /** Per-deliverable rows, sorted by implied repo rate descending (CTD first). */ deliverables: DeliverableAnalysis[]; /** The cheapest-to-deliver (max implied repo rate). */ cheapestToDeliver: DeliverableAnalysis; yearsToDelivery: number; summary: string; assumptions: { conventionsVersion: string; futuresPrice: number; repoRate: number; notionalCoupon: number; settlementDate: string; deliveryDate: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; deliveryDate: string; futuresPrice: number; notionalCoupon: number; repoRate: number; settlementDate: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.deliveryDate: string; default: not declared - assumptions.futuresPrice: number; default: not declared - assumptions.notionalCoupon: number; default: not declared - assumptions.repoRate: number; default: not declared - assumptions.settlementDate: string; default: not declared - cheapestToDeliver: DeliverableAnalysis; default: not declared — The cheapest-to-deliver (max implied repo rate). - cheapestToDeliver.accruedAtDelivery: number; default: not declared - cheapestToDeliver.accruedAtSettlement: number; default: not declared - cheapestToDeliver.carry: number; default: not declared — `coupon income − financing cost` over the hold. - cheapestToDeliver.cleanPrice: number; default: not declared - cheapestToDeliver.conversionFactor: number; default: not declared - cheapestToDeliver.conversionFactorSource: 'supplied' | 'computed'; default: not declared - cheapestToDeliver.grossBasis: number; default: not declared — `cleanPrice − F·CF`. - cheapestToDeliver.id: string; default: not declared - cheapestToDeliver.impliedRepoRate: number; default: not declared — Annualized break-even return of the buy-and-deliver trade (ACT/360). - cheapestToDeliver.interimCoupons: number; default: not declared — Interim coupons paid in `(settlement, delivery]`. - cheapestToDeliver.invoicePrice: number; default: not declared — What the short receives on delivery (`F·CF + accruedAtDelivery`). - cheapestToDeliver.isCheapestToDeliver: boolean; default: not declared - cheapestToDeliver.netBasis: number; default: not declared — `grossBasis − carry`. - cheapestToDeliver.purchaseCost: number; default: not declared — Dirty purchase cost today (`cleanPrice + accruedAtSettlement`). - deliverables: DeliverableAnalysis[]; default: not declared — Per-deliverable rows, sorted by implied repo rate descending (CTD first). - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - summary: string; default: not declared - yearsToDelivery: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#BondKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type BondKind = 'fixed' | 'zero' | 'frn' | 'amortizing' | 'inflation'; ``` ### @insiderfinance/totalfinance/fixed-income#BondOption Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── callable / putable bonds ───────────────────────── export interface BondOption { /** Option date (issuer call / holder put opportunity). */ date: string; /** Strike (clean redemption price per the bond's face value, e.g. 102). */ price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared — Option date (issuer call / holder put opportunity). - price: number; default: not declared — Strike (clean redemption price per the bond's face value, e.g. 102). ### @insiderfinance/totalfinance/fixed-income#BondPrice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BondPrice { dirtyPrice: number; cleanPrice: number; accruedInterest: number; assumptions: BondAssumptions; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest: number; default: not declared - assumptions: BondAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: FixedIncomeDayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.frequency: number; default: not declared — Coupon payments per year actually used in discounting. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.settlementDate: string; default: not declared — Settlement date the result was computed as of. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - cleanPrice: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dirtyPrice: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#BootstrapInstrument Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type BootstrapInstrument = DepositInstrument | FraInstrument | FutureInstrument | SwapInstrument; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convexityAdjustment?: number; default: not declared — Forward = (100 − price)/100 − convexityAdjustment. Supplied by the caller; default 0 (none). - dayCount?: FixedIncomeDayCount; default: not declared — Default `ACT/360`. - end: string; default: not declared - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg accrual day count. Default `30/360`. - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency. Default annual for `ois`, semiannual for `swap`. - floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count. Default `ACT/360`. - floatFrequency?: Frequency; default: not declared — Floating-leg frequency. Used by BOTH bootstraps: each now sums the floating leg explicitly, so that a bootstrapped curve reprices its input swaps under `swapValue` (the single-curve bootstrap used to telescope the leg to `1 − DF(T)` and ignore this field, which is exact only while no payment date rolls to a business day). Default `quarterly`. - maturity: string; default: not declared - price: number; default: not declared - rate: number; default: not declared - start: string; default: not declared - type: ('deposit') | ('fra') | ('future') | ('swap' | 'ois'); default: not declared ### @insiderfinance/totalfinance/fixed-income#BootstrapOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BootstrapOptions { /** Curve reference/settlement date (t = 0). */ referenceDate: string; /** Curve day count (default `ACT/365F`). */ dayCount?: FixedIncomeDayCount; interpolation?: CurveInterpolation; extrapolation?: CurveExtrapolation; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - extrapolation?: CurveExtrapolation; default: not declared - interpolation?: CurveInterpolation; default: not declared - referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). ### @insiderfinance/totalfinance/fixed-income#BreakevenInflationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link breakevenInflation}. ```typescript // --------------------------------------------------------------------------------------------------- // 2. Breakeven inflation // --------------------------------------------------------------------------------------------------- /** Input for {@link breakevenInflation}. */ export interface BreakevenInflationInput { /** Nominal bond yield (decimal, annualized). */ nominalYield: number; /** Real (TIPS) yield (decimal, annualized). */ realYield: number; /** Inflation risk premium (decimal); lifts the breakeven above expected inflation. */ inflationRiskPremium?: number; /** TIPS liquidity premium (decimal); illiquidity depresses the real yield, lifting the breakeven. */ liquidityPremium?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - inflationRiskPremium?: number; default: not declared — Inflation risk premium (decimal); lifts the breakeven above expected inflation. - liquidityPremium?: number; default: not declared — TIPS liquidity premium (decimal); illiquidity depresses the real yield, lifting the breakeven. - nominalYield: number; default: not declared — Nominal bond yield (decimal, annualized). - realYield: number; default: not declared — Real (TIPS) yield (decimal, annualized). ### @insiderfinance/totalfinance/fixed-income#BreakevenInflationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The breakeven inflation rate and its decomposition. ```typescript /** The breakeven inflation rate and its decomposition. */ export interface BreakevenInflationResult { /** Arithmetic breakeven: `nominalYield − realYield` (the quoted number). */ breakeven: number; /** Exact Fisher-compounded breakeven: `(1+nominal)/(1+real) − 1`. */ breakevenCompounded: number; /** `breakeven − inflationRiskPremium + liquidityPremium`, or `null` when no premia are supplied. */ expectedInflation: number | null; nominalYield: number; realYield: number; assumptions: { conventionsVersion: string; method: 'fisher'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'fisher'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'fisher'; default: not declared - breakeven: number; default: not declared — Arithmetic breakeven: `nominalYield − realYield` (the quoted number). - breakevenCompounded: number; default: not declared — Exact Fisher-compounded breakeven: `(1+nominal)/(1+real) − 1`. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - expectedInflation: number | null; default: not declared — `breakeven − inflationRiskPremium + liquidityPremium`, or `null` when no premia are supplied. - nominalYield: number; default: not declared - realYield: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#BusinessDayConvention Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Business-day roll conventions (spec §14). ```typescript // --------------------------------------------------------------------------------------------------- // Business-day adjustment // --------------------------------------------------------------------------------------------------- /** Business-day roll conventions (spec §14). */ export type BusinessDayConvention = 'unadjusted' | 'following' | 'modifiedFollowing' | 'preceding' | 'modifiedPreceding'; ``` ### @insiderfinance/totalfinance/fixed-income#CallFeature Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ---- yield to call ---- export interface CallFeature { /** First/earliest call date. */ callDate: string; /** * Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the * bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an * amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance * is not derivable from the schedule. */ callPrice?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callDate: string; default: not declared — First/earliest call date. - callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. ### @insiderfinance/totalfinance/fixed-income#CallableBondResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CallableBondResult { /** Model dirty price including the embedded option(s). */ price: number; /** Model dirty price of the otherwise-identical straight bond (no embedded options). */ straightPrice: number; /** Value of the embedded option(s): `straightPrice − price` (positive for a callable). */ optionValue: number; /** Effective duration from a ±1bp parallel curve shock (re-trees each side). */ effectiveDuration: number; /** Option-adjusted spread (parallel curve shift repricing the model to `marketPrice`); present only when `marketPrice` is supplied. */ oas?: number; /** Applied conventions and model knobs, echoed (R2). */ assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; settlementDate: string; model: TreeModel; stepsPerYear: number; meanReversion: number; sigma: number; }; /** Honest computation report: the lattice method, and the OAS root-find when one ran (R2). */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; meanReversion: number; model: TreeModel; settlementDate: string; sigma: number; stepsPerYear: number; }; default: not declared — Applied conventions and model knobs, echoed (R2). - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: 'ACT/365F'; default: not declared - assumptions.meanReversion: number; default: not declared - assumptions.model: TreeModel; default: not declared - assumptions.settlementDate: string; default: not declared - assumptions.sigma: number; default: not declared - assumptions.stepsPerYear: number; default: not declared - diagnostics: Diagnostics; default: not declared — Honest computation report: the lattice method, and the OAS root-find when one ran (R2). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - effectiveDuration: number; default: not declared — Effective duration from a ±1bp parallel curve shock (re-trees each side). - oas?: number; default: not declared — Option-adjusted spread (parallel curve shift repricing the model to `marketPrice`); present only when `marketPrice` is supplied. - optionValue: number; default: not declared — Value of the embedded option(s): `straightPrice − price` (positive for a callable). - price: number; default: not declared — Model dirty price including the embedded option(s). - straightPrice: number; default: not declared — Model dirty price of the otherwise-identical straight bond (no embedded options). ### @insiderfinance/totalfinance/fixed-income#CallableBondSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CallableBondSpecification { bond: Bond; /** Calibration/discount curve (its reference date is the valuation date). */ curve: YieldCurve; /** Mean reversion and short-rate volatility for the tree model. */ meanReversion: number; sigma: number; /** Tree model (default `hull-white`). */ model?: TreeModel; /** Issuer call schedule (caps the bond's value at each strike). */ calls?: BondOption[]; /** Holder put schedule (floors the bond's value at each strike). */ puts?: BondOption[]; /** Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). */ stepsPerYear?: number; /** Market dirty price; when given, the result includes the option-adjusted spread. */ marketPrice?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bond: Bond; default: not declared - bond.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bond.accrued(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.accrued(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.accrued(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.accrued(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.accrued(settlementDate): string; default: not declared - bond.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bond.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bond.cashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.cashflows(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.cashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.cashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.couponRate: number; default: not declared - bond.dayCount: FixedIncomeDayCount; default: not declared - bond.faceValue: number; default: not declared - bond.frequency: number; default: not declared - bond.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bond.futureCashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.futureCashflows(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.futureCashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.futureCashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.futureCashflows(settlementDate): string; default: not declared - bond.issueDate: string; default: not declared - bond.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bond.maturityDate: string; default: not declared - bond.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - calls?: BondOption[]; default: not declared — Issuer call schedule (caps the bond's value at each strike). - curve: YieldCurve; default: not declared — Calibration/discount curve (its reference date is the valuation date). - curve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curve.addSpread(spread): YieldCurve; default: not declared - curve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curve.bumpPillar(delta): number; default: not declared - curve.bumpPillar(index): number; default: not declared - curve.dayCount: FixedIncomeDayCount; default: not declared - curve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curve.discount(at): string | number; default: not declared - curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - curve.forwardRate(from): string | number; default: not declared - curve.forwardRate(to): string | number; default: not declared - curve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curve.instantaneousForward(at): string | number; default: not declared - curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curve.referenceDate: string; default: not declared - curve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curve.shift(delta): number; default: not declared - curve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curve.timeTo(at): string | number; default: not declared - curve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curve.zeroRate(at): string | number; default: not declared - curve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - curve.zeroRate(compounding).periodsPerYear: number; default: not declared - curve.zeroRate(compounding).type: 'periodic'; default: not declared - marketPrice?: number; default: not declared — Market dirty price; when given, the result includes the option-adjusted spread. - meanReversion: number; default: not declared — Mean reversion and short-rate volatility for the tree model. - model?: TreeModel; default: not declared — Tree model (default `hull-white`). - puts?: BondOption[]; default: not declared — Holder put schedule (floors the bond's value at each strike). - sigma: number; default: not declared - stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). ### @insiderfinance/totalfinance/fixed-income#CapFloorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CapFloorResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; price: number; caplets: CapletResult[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - caplets: CapletResult[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - price: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CapFloorSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Caps & floors // --------------------------------------------------------------------------------------------------- export interface CapFloorSpecification { startDate: string; maturityDate: string; strike: number; /** Flat volatility applied to every caplet/floorlet (lognormal for `black`, normal for `bachelier`). */ volatility: number; type: 'cap' | 'floor'; notional?: number; /** Reset/payment frequency (default quarterly). */ frequency?: Frequency; /** Day count for accrual and forward projection (default `ACT/360`). */ dayCount?: FixedIncomeDayCount; model?: RatesVolatilityModel; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Day count for accrual and forward projection (default `ACT/360`). - frequency?: Frequency; default: not declared — Reset/payment frequency (default quarterly). - maturityDate: string; default: not declared - model?: RatesVolatilityModel; default: not declared - notional?: number; default: not declared - startDate: string; default: not declared - strike: number; default: not declared - type: 'floor' | 'cap'; default: not declared - volatility: number; default: not declared — Flat volatility applied to every caplet/floorlet (lognormal for `black`, normal for `bachelier`). ### @insiderfinance/totalfinance/fixed-income#CapletResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CapletResult { start: string; end: string; expiry: number; forwardRate: number; /** PV of this caplet/floorlet (per notional × accrual already applied). */ value: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - end: string; default: not declared - expiry: number; default: not declared - forwardRate: number; default: not declared - start: string; default: not declared - value: number; default: not declared — PV of this caplet/floorlet (per notional × accrual already applied). ### @insiderfinance/totalfinance/fixed-income#CashFlow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Cash flows // --------------------------------------------------------------------------------------------------- export interface CashFlow { /** Regular (unadjusted) schedule date — used for accrual, time-to-cashflow, and yield discounting. */ date: string; /** Business-day-adjusted payment date — used for curve discounting. */ paymentDate: string; /** Total payment (interest + principal). */ amount: number; /** Coupon/interest portion. */ interest: number; /** Principal (redemption/amortization) portion. */ principal: number; /** Outstanding notional accruing over the period that produced this flow. */ notional: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Total payment (interest + principal). - date: string; default: not declared — Regular (unadjusted) schedule date — used for accrual, time-to-cashflow, and yield discounting. - interest: number; default: not declared — Coupon/interest portion. - notional: number; default: not declared — Outstanding notional accruing over the period that produced this flow. - paymentDate: string; default: not declared — Business-day-adjusted payment date — used for curve discounting. - principal: number; default: not declared — Principal (redemption/amortization) portion. ### @insiderfinance/totalfinance/fixed-income#CdsCurves Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CdsCurves { discountCurve: YieldCurve; survivalCurve: SurvivalCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountCurve: YieldCurve; default: not declared - discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discountCurve.addSpread(spread): YieldCurve; default: not declared - discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discountCurve.bumpPillar(delta): number; default: not declared - discountCurve.bumpPillar(index): number; default: not declared - discountCurve.dayCount: FixedIncomeDayCount; default: not declared - discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discountCurve.discount(at): string | number; default: not declared - discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discountCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - discountCurve.forwardRate(from): string | number; default: not declared - discountCurve.forwardRate(to): string | number; default: not declared - discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discountCurve.instantaneousForward(at): string | number; default: not declared - discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discountCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - discountCurve.referenceDate: string; default: not declared - discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discountCurve.shift(delta): number; default: not declared - discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discountCurve.timeTo(at): string | number; default: not declared - discountCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discountCurve.zeroRate(at): string | number; default: not declared - discountCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - survivalCurve: SurvivalCurve; default: not declared - survivalCurve.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - survivalCurve.conditionalDefaultProbability(from): string | number; default: not declared - survivalCurve.conditionalDefaultProbability(to): string | number; default: not declared - survivalCurve.dayCount: FixedIncomeDayCount; default: not declared - survivalCurve.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - survivalCurve.defaultProbability(from): string | number; default: not declared - survivalCurve.defaultProbability(to): string | number; default: not declared - survivalCurve.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - survivalCurve.hazard(at): string | number; default: not declared - survivalCurve.pillars: readonly SurvivalPillar[]; default: not declared - survivalCurve.referenceDate: string; default: not declared - survivalCurve.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - survivalCurve.survival(at): string | number; default: not declared - survivalCurve.timeTo: (at: string | number) => number; default: not declared - survivalCurve.timeTo(at): string | number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CdsQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Hazard bootstrap from CDS spreads + spread-curve / basis helpers // --------------------------------------------------------------------------------------------------- export interface CdsQuote { maturity: string; /** Par spread quote (e.g. 0.012 = 120 bp). */ spread: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maturity: string; default: not declared - spread: number; default: not declared — Par spread quote (e.g. 0.012 = 120 bp). ### @insiderfinance/totalfinance/fixed-income#CdsSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // CDS pricing // --------------------------------------------------------------------------------------------------- export interface CdsSpecification { effectiveDate: string; maturityDate: string; /** Running premium (coupon) rate, e.g. 0.01 = 100 bp. */ spread: number; /** Recovery rate on default. Default 0.4. */ recovery?: number; notional?: number; /** Premium payment frequency. Default quarterly. */ frequency?: Frequency; /** Premium accrual day count. Default `ACT/360`. */ dayCount?: FixedIncomeDayCount; /** Pay premium accrued since the last coupon on default. Default true. */ accrualOnDefault?: boolean; /** Subdivisions per premium period for the protection-leg integral. Default 4. */ protectionSteps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - effectiveDate: string; default: not declared - frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - maturityDate: string; default: not declared - notional?: number; default: not declared - protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - spread: number; default: not declared — Running premium (coupon) rate, e.g. 0.01 = 100 bp. ### @insiderfinance/totalfinance/fixed-income#CdsValuation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CdsValuation { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** PV to the protection buyer (pays premium, receives default protection). */ value: number; protectionLeg: number; premiumLeg: number; /** Risky annuity / PV01 basis: Σ τᵢ·DF·Q (+ accrual-on-default), per unit spread × notional. */ riskyAnnuity: number; parSpread: number; /** Upfront value as a fraction of notional (protection-buyer sign). */ upfront: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - parSpread: number; default: not declared - premiumLeg: number; default: not declared - protectionLeg: number; default: not declared - riskyAnnuity: number; default: not declared — Risky annuity / PV01 basis: Σ τᵢ·DF·Q (+ accrual-on-default), per unit spread × notional. - upfront: number; default: not declared — Upfront value as a fraction of notional (protection-buyer sign). - value: number; default: not declared — PV to the protection buyer (pays premium, receives default protection). ### @insiderfinance/totalfinance/fixed-income#CirModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A CIR model plus the honest disclosure of whether its parameters keep the short rate strictly positive. Structurally a {@link ShortRateModel}, so existing consumers are unaffected. ```typescript /** * A CIR model plus the honest disclosure of whether its parameters keep the short rate strictly * positive. Structurally a {@link ShortRateModel}, so existing consumers are unaffected. */ export interface CirModel extends ShortRateModel { /** Structured warnings about the calibration (currently: the Feller condition). Always present. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings about the calibration (currently: the Feller condition). Always present. - diagnostics.warnings: QuantWarning[]; default: not declared - discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - discountBond(shortRate): number; default: not declared - discountBond(tau): number; default: not declared - shortRateMoments: (years: number) => ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - shortRateMoments().return.mean: number; default: not declared - shortRateMoments().return.standardDeviation: number; default: not declared - shortRateMoments().return.variance: number; default: not declared - shortRateMoments(years): number; default: not declared - zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. - zeroRate(shortRate): number; default: not declared - zeroRate(tau): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CirParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // CIR // --------------------------------------------------------------------------------------------------- export interface CirParameters { a: number; b: number; sigma: number; r0: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - a: number; default: not declared - b: number; default: not declared - r0: number; default: not declared - sigma: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CmsConvexityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CmsConvexityInput { /** Plain forward swap rate `y₀` of the underlying swap. */ forwardSwapRate: number; /** Underlying swap tenor in whole years. */ swapTenorYears: number; /** Fixed-leg payments per year `m` (drives the bond function G(y)). */ paymentsPerYear: number; /** Lognormal volatility of the underlying swap rate. */ volatility: number; /** Time to the CMS observation, in years. */ expiry: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: number; default: not declared — Time to the CMS observation, in years. - forwardSwapRate: number; default: not declared — Plain forward swap rate `y₀` of the underlying swap. - paymentsPerYear: number; default: not declared — Fixed-leg payments per year `m` (drives the bond function G(y)). - swapTenorYears: number; default: not declared — Underlying swap tenor in whole years. - volatility: number; default: not declared — Lognormal volatility of the underlying swap rate. ### @insiderfinance/totalfinance/fixed-income#CmsConvexityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The convexity-adjustment envelope: the adjustment plus what produced it (Law 2). ```typescript /** The convexity-adjustment envelope: the adjustment plus what produced it (Law 2). */ export interface CmsConvexityResult { /** The additive adjustment Δ (rate units): expected CMS rate minus the plain forward swap rate. */ value: number; /** Applied conventions, echoed (Law 2 envelope grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - value: number; default: not declared — The additive adjustment Δ (rate units): expected CMS rate minus the plain forward swap rate. ### @insiderfinance/totalfinance/fixed-income#CmsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CmsResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Plain forward swap rate of the underlying CMS swap. */ forwardSwapRate: number; /** Convexity adjustment added because the swap rate is not a martingale under its payment measure. */ convexityAdjustment: number; /** Convexity-adjusted expected CMS rate `forwardSwapRate + convexityAdjustment`. */ cmsRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - cmsRate: number; default: not declared — Convexity-adjusted expected CMS rate `forwardSwapRate + convexityAdjustment`. - convexityAdjustment: number; default: not declared — Convexity adjustment added because the swap rate is not a martingale under its payment measure. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - forwardSwapRate: number; default: not declared — Plain forward swap rate of the underlying CMS swap. ### @insiderfinance/totalfinance/fixed-income#CmsSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // CMS (constant-maturity swap rate, convexity-adjusted) // --------------------------------------------------------------------------------------------------- export interface CmsSpecification { /** When the CMS rate is observed (the underlying swap's start). */ resetDate: string; /** Underlying swap tenor in whole years (e.g. 10 for a 10y CMS). */ swapTenorYears: number; /** Lognormal volatility of the underlying swap rate. */ volatility: number; /** Underlying swap fixed-leg frequency (drives the convexity G(y); default semiannual). */ fixedFrequency?: Frequency; fixedDayCount?: FixedIncomeDayCount; floatFrequency?: Frequency; floatDayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fixedDayCount?: FixedIncomeDayCount; default: not declared - fixedFrequency?: Frequency; default: not declared — Underlying swap fixed-leg frequency (drives the convexity G(y); default semiannual). - floatDayCount?: FixedIncomeDayCount; default: not declared - floatFrequency?: Frequency; default: not declared - resetDate: string; default: not declared — When the CMS rate is observed (the underlying swap's start). - swapTenorYears: number; default: not declared — Underlying swap tenor in whole years (e.g. 10 for a 10y CMS). - volatility: number; default: not declared — Lognormal volatility of the underlying swap rate. ### @insiderfinance/totalfinance/fixed-income#ConversionFactorInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link conversionFactor}. ```typescript // --------------------------------------------------------------------------------------------------- // Conversion factor (CME/CBOT) // --------------------------------------------------------------------------------------------------- /** Input for {@link conversionFactor}. */ export interface ConversionFactorInput { /** The deliverable bond — its (semiannual) coupon and maturity drive the factor. */ bond: Bond; /** The conversion factor is computed as of the first day of THIS date's month. */ deliveryDate: string; /** The contract's notional coupon (decimal); default `0.06` (CME Treasury futures). */ notionalCoupon?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bond: Bond; default: not declared — The deliverable bond — its (semiannual) coupon and maturity drive the factor. - bond.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bond.accrued(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.accrued(context).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.accrued(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.accrued(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.accrued(settlementDate): string; default: not declared - bond.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bond.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bond.cashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.cashflows(context).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.cashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.cashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.couponRate: number; default: not declared - bond.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bond.faceValue: number; default: not declared - bond.frequency: number; default: not declared - bond.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bond.futureCashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.futureCashflows(context).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.futureCashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.futureCashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.futureCashflows(settlementDate): string; default: not declared - bond.issueDate: string; default: not declared - bond.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bond.maturityDate: string; default: not declared - bond.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - deliveryDate: string; default: not declared — The conversion factor is computed as of the first day of THIS date's month. - notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06` (CME Treasury futures). ### @insiderfinance/totalfinance/fixed-income#ConversionFactorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conversion factor plus the rounding breakdown that produced it. ```typescript /** The conversion factor plus the rounding breakdown that produced it. */ export interface ConversionFactorResult { /** Price per $1 face that makes the bond yield the notional coupon on the first delivery day. */ factor: number; /** Whole years to maturity after rounding down to a quarter (`n`). */ wholeYears: number; /** Residual months after rounding, `z ∈ {0, 3, 6, 9}`. */ extraMonths: number; notionalCoupon: number; assumptions: { conventionsVersion: string; couponFrequency: 'semiannual'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; couponFrequency: 'semiannual'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.couponFrequency: 'semiannual'; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - extraMonths: number; default: not declared — Residual months after rounding, `z ∈ {0, 3, 6, 9}`. - factor: number; default: not declared — Price per $1 face that makes the bond yield the notional coupon on the first delivery day. - notionalCoupon: number; default: not declared - wholeYears: number; default: not declared — Whole years to maturity after rounding down to a quarter (`n`). ### @insiderfinance/totalfinance/fixed-income#ConvertibleBondOption Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ConvertibleBondOption { date: string; /** Strike per the bond's face value (e.g. 102). */ price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared - price: number; default: not declared — Strike per the bond's face value (e.g. 102). ### @insiderfinance/totalfinance/fixed-income#ConvertibleBondResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ConvertibleBondResult { /** Convertible value. */ price: number; /** Value of the otherwise-identical risky bond with conversion disabled (the bond floor). */ bondFloor: number; /** Current conversion (parity) value `conversionRatio · spot`. */ conversionValue: number; /** Embedded equity-option value: `price − bondFloor`. */ optionValue: number; /** Applied conventions and model knobs, echoed (R2). */ assumptions: { conventionsVersion: string; model: 'equity-lattice+reduced-form-credit'; stepsPerYear: number; recovery: number; creditModel: 'survivalCurve' | 'flatHazard' | 'none'; }; /** Honest computation report (R2). */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; creditModel: 'survivalCurve' | 'flatHazard' | 'none'; model: 'equity-lattice+reduced-form-credit'; recovery: number; stepsPerYear: number; }; default: not declared — Applied conventions and model knobs, echoed (R2). - assumptions.conventionsVersion: string; default: not declared - assumptions.creditModel: 'none' | 'survivalCurve' | 'flatHazard'; default: not declared - assumptions.model: 'equity-lattice+reduced-form-credit'; default: not declared - assumptions.recovery: number; default: not declared - assumptions.stepsPerYear: number; default: not declared - bondFloor: number; default: not declared — Value of the otherwise-identical risky bond with conversion disabled (the bond floor). - conversionValue: number; default: not declared — Current conversion (parity) value `conversionRatio · spot`. - diagnostics: Diagnostics; default: not declared — Honest computation report (R2). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - optionValue: number; default: not declared — Embedded equity-option value: `price − bondFloor`. - price: number; default: not declared — Convertible value. ### @insiderfinance/totalfinance/fixed-income#ConvertibleBondSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ConvertibleBondSpecification { issueDate: string; maturityDate: string; /** Annualized coupon rate (0 for a zero-coupon convertible). */ couponRate: number; frequency: Frequency; faceValue?: number; /** Coupon accrual day count (default `30/360`). */ dayCount?: FixedIncomeDayCount; /** Shares received per bond on conversion. */ conversionRatio: number; /** Current share price. */ spot: number; /** Equity volatility. */ volatility: number; /** Continuous dividend yield on the share (default 0). */ dividendYield?: number; /** Flat continuously-compounded risk-free rate used for lattice discounting. */ riskFreeRate: number; /** Term-structured hazard (credit) — provide this or `hazardRate`. */ survival?: SurvivalCurve; /** Flat hazard rate alternative to `survival`. */ hazardRate?: number; /** Recovery on default, as a fraction of face (default 0.4). */ recovery?: number; /** Issuer call schedule. */ calls?: ConvertibleBondOption[]; /** Holder put schedule. */ puts?: ConvertibleBondOption[]; /** Lattice steps per year (default 200, hard outer maximum 1,000,000; tree cap may be lower). */ stepsPerYear?: number; /** Valuation date (default = issue date). */ settlementDate?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calls?: ConvertibleBondOption[]; default: not declared — Issuer call schedule. - conversionRatio: number; default: not declared — Shares received per bond on conversion. - couponRate: number; default: not declared — Annualized coupon rate (0 for a zero-coupon convertible). - dayCount?: FixedIncomeDayCount; default: not declared — Coupon accrual day count (default `30/360`). - dividendYield?: number; default: not declared — Continuous dividend yield on the share (default 0). - faceValue?: number; default: not declared - frequency: Frequency; default: not declared - hazardRate?: number; default: not declared — Flat hazard rate alternative to `survival`. - issueDate: string; default: not declared - maturityDate: string; default: not declared - puts?: ConvertibleBondOption[]; default: not declared — Holder put schedule. - recovery?: number; default: not declared — Recovery on default, as a fraction of face (default 0.4). - riskFreeRate: number; default: not declared — Flat continuously-compounded risk-free rate used for lattice discounting. - settlementDate?: string; default: not declared — Valuation date (default = issue date). - spot: number; default: not declared — Current share price. - stepsPerYear?: number; default: not declared — Lattice steps per year (default 200, hard outer maximum 1,000,000; tree cap may be lower). - survival?: SurvivalCurve; default: not declared — Term-structured hazard (credit) — provide this or `hazardRate`. - survival.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - survival.conditionalDefaultProbability(from): string | number; default: not declared - survival.conditionalDefaultProbability(to): string | number; default: not declared - survival.dayCount: FixedIncomeDayCount; default: not declared - survival.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - survival.defaultProbability(from): string | number; default: not declared - survival.defaultProbability(to): string | number; default: not declared - survival.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - survival.hazard(at): string | number; default: not declared - survival.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - survival.referenceDate: string; default: not declared - survival.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - survival.survival(at): string | number; default: not declared - survival.timeTo: (at: string | number) => number; default: not declared - survival.timeTo(at): string | number; default: not declared - volatility: number; default: not declared — Equity volatility. ### @insiderfinance/totalfinance/fixed-income#CpiSeasonalityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link cpiSeasonality}. ```typescript // --------------------------------------------------------------------------------------------------- // 3. CPI seasonality // --------------------------------------------------------------------------------------------------- /** Input for {@link cpiSeasonality}. */ export interface CpiSeasonalityInput { /** NSA CPI history: `{ month: 'YYYY-MM', level }`; ≥ 24 contiguous months (order-independent). */ series: Array<{ month: string; level: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - series: { month: string; level: number; }[]; default: not declared — NSA CPI history: `{ month: 'YYYY-MM', level }`; ≥ 24 contiguous months (order-independent). ### @insiderfinance/totalfinance/fixed-income#CpiSeasonalityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The extracted monthly seasonal factors. ```typescript /** The extracted monthly seasonal factors. */ export interface CpiSeasonalityResult { /** 12 multiplicative factors, index 0 = January … 11 = December; they average to 1. */ factors: number[]; /** Calendar month (1-12) with the largest factor. */ peakMonth: number; /** Calendar month (1-12) with the smallest factor. */ troughMonth: number; /** Number of month observations that fed the estimate (ratios computed). */ monthsUsed: number; /** Calendar years the history spans. */ yearsSpanned: number; assumptions: { conventionsVersion: string; method: 'ratio-to-2x12-moving-average'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'ratio-to-2x12-moving-average'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'ratio-to-2x12-moving-average'; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - factors: number[]; default: not declared — 12 multiplicative factors, index 0 = January … 11 = December; they average to 1. - monthsUsed: number; default: not declared — Number of month observations that fed the estimate (ratios computed). - peakMonth: number; default: not declared — Calendar month (1-12) with the largest factor. - troughMonth: number; default: not declared — Calendar month (1-12) with the smallest factor. - yearsSpanned: number; default: not declared — Calendar years the history spans. ### @insiderfinance/totalfinance/fixed-income#CreditSpreadCurveAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `creditSpreadCurve.explain` echoes (H03) — every knob the per-tenor CDS runs on. ```typescript /** The conventions `creditSpreadCurve.explain` echoes (H03) — every knob the per-tenor CDS runs on. */ export interface CreditSpreadCurveAssumptions { conventionsVersion: string; referenceDate: string; recovery: number; frequency: Frequency; dayCount: FixedIncomeDayCount; accrualOnDefault: boolean; /** Subdivisions per premium period in the protection-leg integral. */ protectionSteps: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualOnDefault: boolean; default: not declared - conventionsVersion: string; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - frequency: Frequency; default: not declared - protectionSteps: number; default: not declared — Subdivisions per premium period in the protection-leg integral. - recovery: number; default: not declared - referenceDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#CreditSpreadCurveFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CreditSpreadCurveFacade = ((tenors: string[], options: HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }) => CreditSpreadPoint[]) & { explain: (tenors: string[], options: HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }) => Omit, 'assumptions'> & { assumptions: CreditSpreadCurveAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }; default: not declared - (options).accrualOnDefault?: boolean; default: not declared - (options).dayCount?: FixedIncomeDayCount; default: not declared - (options).discountCurve: YieldCurve; default: not declared - (options).frequency?: Frequency; default: not declared - (options).protectionSteps?: number; default: not declared - (options).recovery?: number; default: not declared - (options).referenceDate: string; default: not declared - (options).survivalCurve: SurvivalCurve; default: not declared - (tenors): string[]; default: not declared - explain: (tenors: string[], options: HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }) => Omit, 'assumptions'> & { assumptions: CreditSpreadCurveAssumptions; }; default: not declared - explain().return.assumptions: CreditSpreadCurveAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: CreditSpreadPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(options): HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }; default: not declared - explain(options).accrualOnDefault?: boolean; default: not declared - explain(options).dayCount?: FixedIncomeDayCount; default: not declared - explain(options).discountCurve: YieldCurve; default: not declared - explain(options).frequency?: Frequency; default: not declared - explain(options).protectionSteps?: number; default: not declared - explain(options).recovery?: number; default: not declared - explain(options).referenceDate: string; default: not declared - explain(options).survivalCurve: SurvivalCurve; default: not declared - explain(tenors): string[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#CreditSpreadPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One tenor of a {@link creditSpreadCurve}: the maturity and its par (breakeven) CDS spread. ```typescript /** Par CDS spread term structure implied by a survival + discount curve, one entry per tenor. */ /** One tenor of a {@link creditSpreadCurve}: the maturity and its par (breakeven) CDS spread. */ export interface CreditSpreadPoint { maturity: string; parSpread: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maturity: string; default: not declared - parSpread: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CreditTriangleHazardResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The credit-triangle envelope: the implied hazard plus the recovery it assumed (Law 2). ```typescript /** The credit-triangle envelope: the implied hazard plus the recovery it assumed (Law 2). */ export interface CreditTriangleHazardResult { /** Implied flat hazard rate λ (per year). */ value: number; /** Applied conventions, echoed (Law 2 envelope grammar). */ assumptions: { conventionsVersion: string; recovery: number; approximation: 'continuous-premium credit triangle'; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { approximation: 'continuous-premium credit triangle'; conventionsVersion: string; recovery: number; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - assumptions.approximation: 'continuous-premium credit triangle'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.recovery: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - value: number; default: not declared — Implied flat hazard rate λ (per year). ### @insiderfinance/totalfinance/fixed-income#CrossCurrencyBasisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossCurrencyBasisInput { /** FX spot: domestic units per 1 foreign unit. */ spot: number; /** Domestic collateral (OIS) discount curve. */ domestic: YieldCurve; /** Foreign index/OIS discount curve (pre-basis). */ foreign: YieldCurve; /** * Cross-currency basis term structure added to the foreign curve (its zero rates ARE the basis * spreads). Omit for the pure covered-interest-parity case (no basis): `fxForward` is then * `spot · D_for(t)/D_dom(t)` and the collateralized curve is the foreign curve itself. */ basis?: YieldCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - basis?: YieldCurve; default: not declared — Cross-currency basis term structure added to the foreign curve (its zero rates ARE the basis spreads). Omit for the pure covered-interest-parity case (no basis): `fxForward` is then `spot · D_for(t)/D_dom(t)` and the collateralized curve is the foreign curve itself. - basis.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - basis.addSpread(spread): YieldCurve; default: not declared - basis.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - basis.bumpPillar(delta): number; default: not declared - basis.bumpPillar(index): number; default: not declared - basis.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - basis.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - basis.discount(at): string | number; default: not declared - basis.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - basis.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - basis.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - basis.forwardRate(from): string | number; default: not declared - basis.forwardRate(to): string | number; default: not declared - basis.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - basis.instantaneousForward(at): string | number; default: not declared - basis.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - basis.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - basis.referenceDate: string; default: not declared - basis.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - basis.shift(delta): number; default: not declared - basis.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - basis.timeTo(at): string | number; default: not declared - basis.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - basis.zeroRate(at): string | number; default: not declared - basis.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - basis.zeroRate(compounding).periodsPerYear: number; default: not declared - basis.zeroRate(compounding).type: 'periodic'; default: not declared - domestic: YieldCurve; default: not declared — Domestic collateral (OIS) discount curve. - domestic.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - domestic.addSpread(spread): YieldCurve; default: not declared - domestic.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - domestic.bumpPillar(delta): number; default: not declared - domestic.bumpPillar(index): number; default: not declared - domestic.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - domestic.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - domestic.discount(at): string | number; default: not declared - domestic.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - domestic.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - domestic.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - domestic.forwardRate(from): string | number; default: not declared - domestic.forwardRate(to): string | number; default: not declared - domestic.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - domestic.instantaneousForward(at): string | number; default: not declared - domestic.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - domestic.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - domestic.referenceDate: string; default: not declared - domestic.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - domestic.shift(delta): number; default: not declared - domestic.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - domestic.timeTo(at): string | number; default: not declared - domestic.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - domestic.zeroRate(at): string | number; default: not declared - domestic.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - domestic.zeroRate(compounding).periodsPerYear: number; default: not declared - domestic.zeroRate(compounding).type: 'periodic'; default: not declared - foreign: YieldCurve; default: not declared — Foreign index/OIS discount curve (pre-basis). - foreign.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - foreign.addSpread(spread): YieldCurve; default: not declared - foreign.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - foreign.bumpPillar(delta): number; default: not declared - foreign.bumpPillar(index): number; default: not declared - foreign.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - foreign.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - foreign.discount(at): string | number; default: not declared - foreign.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - foreign.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - foreign.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - foreign.forwardRate(from): string | number; default: not declared - foreign.forwardRate(to): string | number; default: not declared - foreign.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - foreign.instantaneousForward(at): string | number; default: not declared - foreign.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - foreign.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - foreign.referenceDate: string; default: not declared - foreign.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - foreign.shift(delta): number; default: not declared - foreign.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - foreign.timeTo(at): string | number; default: not declared - foreign.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - foreign.zeroRate(at): string | number; default: not declared - foreign.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - foreign.zeroRate(compounding).periodsPerYear: number; default: not declared - foreign.zeroRate(compounding).type: 'periodic'; default: not declared - spot: number; default: not declared — FX spot: domestic units per 1 foreign unit. ### @insiderfinance/totalfinance/fixed-income#CrossCurrencyBasisResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossCurrencyBasisResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** The domestic-collateralized foreign discount curve (`foreign + basis`). Discount foreign cash flows on THIS. */ collateralizedCurve: YieldCurve; /** Market FX forward at `at`, from the collateralized curve: `spot · D_for^dom(at) / D_dom(at)`. */ fxForward(at: string | number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - collateralizedCurve: YieldCurve; default: not declared — The domestic-collateralized foreign discount curve (`foreign + basis`). Discount foreign cash flows on THIS. - collateralizedCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - collateralizedCurve.addSpread(spread): YieldCurve; default: not declared - collateralizedCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - collateralizedCurve.bumpPillar(delta): number; default: not declared - collateralizedCurve.bumpPillar(index): number; default: not declared - collateralizedCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - collateralizedCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - collateralizedCurve.discount(at): string | number; default: not declared - collateralizedCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - collateralizedCurve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - collateralizedCurve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - collateralizedCurve.forwardRate(from): string | number; default: not declared - collateralizedCurve.forwardRate(to): string | number; default: not declared - collateralizedCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - collateralizedCurve.instantaneousForward(at): string | number; default: not declared - collateralizedCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - collateralizedCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - collateralizedCurve.referenceDate: string; default: not declared - collateralizedCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - collateralizedCurve.shift(delta): number; default: not declared - collateralizedCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - collateralizedCurve.timeTo(at): string | number; default: not declared - collateralizedCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - collateralizedCurve.zeroRate(at): string | number; default: not declared - collateralizedCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - collateralizedCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - collateralizedCurve.zeroRate(compounding).type: 'periodic'; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - fxForward: (at: string | number) => number; default: not declared — Market FX forward at `at`, from the collateralized curve: `spot · D_for^dom(at) / D_dom(at)`. - fxForward(at): string | number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CtdFrontierScenario Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One node of the CTD frontier scan: the whole basket, repriced at a parallel shift + a futures price. ```typescript /** One node of the CTD frontier scan: the whole basket, repriced at a parallel shift + a futures price. */ export interface CtdFrontierScenario { /** The parallel yield shift (bp) applied to every deliverable's current yield. */ yieldShiftBp: number; /** The futures price used at this node (held constant, or the supplied path entry). */ futuresPrice: number; /** The cheapest-to-deliver at this node. */ ctdId: string; /** The CTD's net basis at this node. */ netBasis: number; /** The CTD's implied repo rate at this node. */ impliedRepoRate: number; /** The full per-deliverable basis rows at this node (CTD first), straight from {@link bondFuture}. */ deliverables: DeliverableAnalysis[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ctdId: string; default: not declared — The cheapest-to-deliver at this node. - deliverables: DeliverableAnalysis[]; default: not declared — The full per-deliverable basis rows at this node (CTD first), straight from {@link bondFuture}. - futuresPrice: number; default: not declared — The futures price used at this node (held constant, or the supplied path entry). - impliedRepoRate: number; default: not declared — The CTD's implied repo rate at this node. - netBasis: number; default: not declared — The CTD's net basis at this node. - yieldShiftBp: number; default: not declared — The parallel yield shift (bp) applied to every deliverable's current yield. ### @insiderfinance/totalfinance/fixed-income#CtdSwitch Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A cheapest-to-deliver switch between two frontier nodes. ```typescript /** A cheapest-to-deliver switch between two frontier nodes. */ export interface CtdSwitch { /** The CTD on the low-shift side of the transition. */ fromCtd: string; /** The CTD on the high-shift side of the transition. */ toCtd: string; /** The refined (or grid) bracket, in shift bp, that contains the transition. */ bracketBp: readonly [ number, number ]; /** Best estimate of the switch shift (bp): the root under `root-refined`, else the bracket midpoint. */ estimatedSwitchBp: number; /** * `root-refined` — the two rivals' implied-repo rates were equalized to tolerance and neither is * beaten by a third deliverable at the root. `grid-midpoint` — a discrete futures path (no * interpolation) or a bracket that could not be root-refined; the estimate is the bracket midpoint. */ method: 'root-refined' | 'grid-midpoint'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bracketBp: readonly [number, number]; default: not declared — The refined (or grid) bracket, in shift bp, that contains the transition. - estimatedSwitchBp: number; default: not declared — Best estimate of the switch shift (bp): the root under `root-refined`, else the bracket midpoint. - fromCtd: string; default: not declared — The CTD on the low-shift side of the transition. - method: 'root-refined' | 'grid-midpoint'; default: not declared — `root-refined` — the two rivals' implied-repo rates were equalized to tolerance and neither is beaten by a third deliverable at the root. `grid-midpoint` — a discrete futures path (no interpolation) or a bracket that could not be root-refined; the estimate is the bracket midpoint. - toCtd: string; default: not declared — The CTD on the high-shift side of the transition. ### @insiderfinance/totalfinance/fixed-income#CurveExtrapolation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What to do outside the pillar range. ```typescript /** What to do outside the pillar range. */ export type CurveExtrapolation = 'flatForward' | 'flatZero' | 'throw'; ``` ### @insiderfinance/totalfinance/fixed-income#CurveInterpolation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Interpolation policy across pillars. ```typescript /** How zero rates are quoted/converted at the API boundary (internal storage is always continuous). */ // FC0: the curve grammar is core's ONE InterestCompounding — the local union (and its bare-number // periodic form, which never said it meant periods-per-year) is removed with no aliases (pre-1.0). /** Interpolation policy across pillars. */ export type CurveInterpolation = 'logLinearDiscount' // linear in ln(discount) ⇒ piecewise-constant instantaneous forwards (market default) | 'linearZero' // linear in the continuous zero rate | 'linearDiscount' // linear in the discount factor | 'cubicZero' // natural cubic spline on zero rates (smooth forwards) | 'pchipZero'; // shape-preserving monotone cubic on zero rates ``` ### @insiderfinance/totalfinance/fixed-income#CurveMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CurveMetrics { dirtyPrice: number; cleanPrice: number; accruedInterest: number; /** Effective duration from a parallel curve shock. */ effectiveDuration: number; /** Effective convexity from a parallel curve shock. */ effectiveConvexity: number; /** Dollar value of a 1bp parallel curve shift (per face). */ dv01: number; /** Per-pillar key-rate durations, aligned to the curve's pillars. */ keyRateDurations: { tenorYears: number; date: string; duration: number; }[]; assumptions: BondAssumptions; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest: number; default: not declared - assumptions: BondAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: FixedIncomeDayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.frequency: number; default: not declared — Coupon payments per year actually used in discounting. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.settlementDate: string; default: not declared — Settlement date the result was computed as of. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - cleanPrice: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dirtyPrice: number; default: not declared - dv01: number; default: not declared — Dollar value of a 1bp parallel curve shift (per face). - effectiveConvexity: number; default: not declared — Effective convexity from a parallel curve shock. - effectiveDuration: number; default: not declared — Effective duration from a parallel curve shock. - keyRateDurations: { tenorYears: number; date: string; duration: number; }[]; default: not declared — Per-pillar key-rate durations, aligned to the curve's pillars. ### @insiderfinance/totalfinance/fixed-income#CurveOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CurveOptions { /** Valuation/reference date (t = 0). Defaults to the first pillar date. */ referenceDate?: string; /** Day count mapping dates → year fractions. Default `ACT/365F`. */ dayCount?: FixedIncomeDayCount; interpolation?: CurveInterpolation; extrapolation?: CurveExtrapolation; /** Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - compounding?: InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - extrapolation?: CurveExtrapolation; default: not declared - interpolation?: CurveInterpolation; default: not declared - referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. ### @insiderfinance/totalfinance/fixed-income#CurvePillar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A resolved pillar: its date, year fraction from the reference date, continuous zero, and discount. ```typescript /** A resolved pillar: its date, year fraction from the reference date, continuous zero, and discount. */ export interface CurvePillar { date: string; tenorYears: number; zero: number; // continuously compounded discount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared - discount: number; default: not declared - tenorYears: number; default: not declared - zero: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#CurvePricingOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CurvePricingOptions { settlementDate: string; context?: ProjectionContext; /** Yield bump for the finite-difference effective measures (default 1bp). */ bump?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bump?: number; default: not declared — Yield bump for the finite-difference effective measures (default 1bp). - context?: ProjectionContext; default: not declared - context.forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - context.forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - context.forecastCurve.addSpread(spread): YieldCurve; default: not declared - context.forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - context.forecastCurve.bumpPillar(delta): number; default: not declared - context.forecastCurve.bumpPillar(index): number; default: not declared - context.forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - context.forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - context.forecastCurve.discount(at): string | number; default: not declared - context.forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - context.forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - context.forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - context.forecastCurve.forwardRate(from): string | number; default: not declared - context.forecastCurve.forwardRate(to): string | number; default: not declared - context.forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - context.forecastCurve.instantaneousForward(at): string | number; default: not declared - context.forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - context.forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - context.forecastCurve.referenceDate: string; default: not declared - context.forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - context.forecastCurve.shift(delta): number; default: not declared - context.forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - context.forecastCurve.timeTo(at): string | number; default: not declared - context.forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - context.forecastCurve.zeroRate(at): string | number; default: not declared - context.forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - context.forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - context.forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared - context.knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - context.referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - context.referenceIndex(date): string; default: not declared - settlementDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#DeliverableAnalysis Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The full basis analysis for one deliverable. ```typescript /** The full basis analysis for one deliverable. */ export interface DeliverableAnalysis { id: string; conversionFactor: number; conversionFactorSource: 'computed' | 'supplied'; cleanPrice: number; accruedAtSettlement: number; accruedAtDelivery: number; /** Interim coupons paid in `(settlement, delivery]`. */ interimCoupons: number; /** Dirty purchase cost today (`cleanPrice + accruedAtSettlement`). */ purchaseCost: number; /** What the short receives on delivery (`F·CF + accruedAtDelivery`). */ invoicePrice: number; /** `cleanPrice − F·CF`. */ grossBasis: number; /** `coupon income − financing cost` over the hold. */ carry: number; /** `grossBasis − carry`. */ netBasis: number; /** Annualized break-even return of the buy-and-deliver trade (ACT/360). */ impliedRepoRate: number; isCheapestToDeliver: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedAtDelivery: number; default: not declared - accruedAtSettlement: number; default: not declared - carry: number; default: not declared — `coupon income − financing cost` over the hold. - cleanPrice: number; default: not declared - conversionFactor: number; default: not declared - conversionFactorSource: 'supplied' | 'computed'; default: not declared - grossBasis: number; default: not declared — `cleanPrice − F·CF`. - id: string; default: not declared - impliedRepoRate: number; default: not declared — Annualized break-even return of the buy-and-deliver trade (ACT/360). - interimCoupons: number; default: not declared — Interim coupons paid in `(settlement, delivery]`. - invoicePrice: number; default: not declared — What the short receives on delivery (`F·CF + accruedAtDelivery`). - isCheapestToDeliver: boolean; default: not declared - netBasis: number; default: not declared — `grossBasis − carry`. - purchaseCost: number; default: not declared — Dirty purchase cost today (`cleanPrice + accruedAtSettlement`). ### @insiderfinance/totalfinance/fixed-income#DeliverableBond Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One deliverable in the futures basket. ```typescript // --------------------------------------------------------------------------------------------------- // Bond future basis / carry / implied repo / CTD // --------------------------------------------------------------------------------------------------- /** One deliverable in the futures basket. */ export interface DeliverableBond { bond: Bond; /** Clean market price per 100 face. */ cleanPrice: number; /** Label for reporting; defaults to the basket index. */ id?: string; /** Exchange-published conversion factor; if omitted, computed via the CME formula. */ conversionFactor?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bond: Bond; default: not declared - bond.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bond.accrued(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.accrued(context).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.accrued(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.accrued(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.accrued(settlementDate): string; default: not declared - bond.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bond.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bond.cashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.cashflows(context).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.cashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.cashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.couponRate: number; default: not declared - bond.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - bond.faceValue: number; default: not declared - bond.frequency: number; default: not declared - bond.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bond.futureCashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.futureCashflows(context).forecastCurve?: import('@insiderfinance/totalfinance/fixed-income').YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.futureCashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.futureCashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.futureCashflows(settlementDate): string; default: not declared - bond.issueDate: string; default: not declared - bond.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bond.maturityDate: string; default: not declared - bond.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - cleanPrice: number; default: not declared — Clean market price per 100 face. - conversionFactor?: number; default: not declared — Exchange-published conversion factor; if omitted, computed via the CME formula. - id?: string; default: not declared — Label for reporting; defaults to the basket index. ### @insiderfinance/totalfinance/fixed-income#DeliverableRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-deliverable interest-rate risk. ```typescript /** Per-deliverable interest-rate risk. */ export interface DeliverableRisk { id: string; conversionFactor: number; /** Spot yield of the deliverable at its market clean price. */ yield: number; /** DV01 of the cash bond per 100 face. */ dv01: number; /** DV01 the futures inherit through this bond: `dv01 / CF`. */ futuresDv01ViaBond: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conversionFactor: number; default: not declared - dv01: number; default: not declared — DV01 of the cash bond per 100 face. - futuresDv01ViaBond: number; default: not declared — DV01 the futures inherit through this bond: `dv01 / CF`. - id: string; default: not declared - yield: number; default: not declared — Spot yield of the deliverable at its market clean price. ### @insiderfinance/totalfinance/fixed-income#DepositInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A money-market deposit: simple rate accruing to `maturity`. ```typescript // --------------------------------------------------------------------------------------------------- // Bootstrapping (spec §14.2): deposits, FRAs, futures, OIS, and swaps → a single discount curve // --------------------------------------------------------------------------------------------------- /** A money-market deposit: simple rate accruing to `maturity`. */ export interface DepositInstrument { type: 'deposit'; maturity: string; rate: number; /** Default `ACT/360`. */ dayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Default `ACT/360`. - maturity: string; default: not declared - rate: number; default: not declared - type: 'deposit'; default: not declared ### @insiderfinance/totalfinance/fixed-income#ExposurePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExposurePoint { tenorYears: number; /** Expected positive exposure `E[max(V, 0)]` (undiscounted). */ epe: number; /** Expected negative exposure `E[max(−V, 0)]` (undiscounted). */ ene: number; /** 95% potential future exposure (95th percentile of the swap value). */ pfe95: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ene: number; default: not declared — Expected negative exposure `E[max(−V, 0)]` (undiscounted). - epe: number; default: not declared — Expected positive exposure `E[max(V, 0)]` (undiscounted). - pfe95: number; default: not declared — 95% potential future exposure (95th percentile of the swap value). - tenorYears: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#FixedIncomeDayCount Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Day-count conventions supported by the fixed-income surface — the three from `@insiderfinance/totalfinance/core` plus `ACT/ACT` (ISDA, calendar-year split) and `30E/360` (the Eurobond 30/360 variant). ```typescript /** * Day-count conventions supported by the fixed-income surface — the three from `@insiderfinance/totalfinance/core` plus * `ACT/ACT` (ISDA, calendar-year split) and `30E/360` (the Eurobond 30/360 variant). */ export type FixedIncomeDayCount = CoreDayCount | 'ACT/ACT' | '30E/360'; ``` ### @insiderfinance/totalfinance/fixed-income#FixedRateBondSpecification Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Bond constructors // --------------------------------------------------------------------------------------------------- export type FixedRateBondSpecification = BaseSpecification; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention?: BusinessDayConvention; default: not declared - couponRate: number; default: not declared — Annualized coupon rate (decimal). - dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - endOfMonth?: boolean; default: not declared - faceValue?: number; default: not declared — Redemption / par value. Default 100. - frequency: Frequency; default: not declared - issueDate: string; default: not declared — Dated date / first accrual date. - maturityDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#FloatingRateNoteSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FloatingRateNoteSpecification extends BaseSpecification { /** Quoted margin over the projected index (decimal), e.g. 0.0025 = 25bp. Default 0. */ spread?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention?: BusinessDayConvention; default: not declared - couponRate: number; default: not declared — Annualized coupon rate (decimal). - dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - endOfMonth?: boolean; default: not declared - faceValue?: number; default: not declared — Redemption / par value. Default 100. - frequency: Frequency; default: not declared - issueDate: string; default: not declared — Dated date / first accrual date. - maturityDate: string; default: not declared - spread?: number; default: not declared — Quoted margin over the projected index (decimal), e.g. 0.0025 = 25bp. Default 0. ### @insiderfinance/totalfinance/fixed-income#ForwardSwapResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ForwardSwapResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Par (forward) swap rate `S = floatLegPv / annuity` — a swaption's natural forward under the annuity measure. */ forwardSwapRate: number; /** Fixed-leg annuity `Σ τ·DF(payDate)` (the level / PV of a unit annuity). */ annuity: number; /** PV of a 1bp fixed-rate change (`notional · annuity · 1e-4`). */ pv01: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annuity: number; default: not declared — Fixed-leg annuity `Σ τ·DF(payDate)` (the level / PV of a unit annuity). - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - forwardSwapRate: number; default: not declared — Par (forward) swap rate `S = floatLegPv / annuity` — a swaption's natural forward under the annuity measure. - pv01: number; default: not declared — PV of a 1bp fixed-rate change (`notional · annuity · 1e-4`). ### @insiderfinance/totalfinance/fixed-income#ForwardSwapSpecification Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A forward-starting swap; the fixed rate is the OUTPUT (the par forward rate), so it is omitted. ```typescript /** A forward-starting swap; the fixed rate is the OUTPUT (the par forward rate), so it is omitted. */ export type ForwardSwapSpecification = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - maturityDate: string; default: not declared - notional?: number; default: not declared - startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#FraInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A forward rate agreement fixing `rate` over `[start, end]`. ```typescript /** A forward rate agreement fixing `rate` over `[start, end]`. */ export interface FraInstrument { type: 'fra'; start: string; end: string; rate: number; /** Default `ACT/360`. */ dayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Default `ACT/360`. - end: string; default: not declared - rate: number; default: not declared - start: string; default: not declared - type: 'fra'; default: not declared ### @insiderfinance/totalfinance/fixed-income#FraResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FraResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** PV to the fixed-rate payer (receives floating). */ value: number; forwardRate: number; discountFactor: number; accrual: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrual: number; default: not declared - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - discountFactor: number; default: not declared - forwardRate: number; default: not declared - value: number; default: not declared — PV to the fixed-rate payer (receives floating). ### @insiderfinance/totalfinance/fixed-income#FraSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // FRA // --------------------------------------------------------------------------------------------------- export interface FraSpecification { start: string; end: string; /** Contract (fixed) rate the buyer pays. */ fixedRate: number; notional?: number; /** Default `ACT/360`. */ dayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Default `ACT/360`. - end: string; default: not declared - fixedRate: number; default: not declared — Contract (fixed) rate the buyer pays. - notional?: number; default: not declared - start: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#Frequency Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Coupon payment frequency, named or as an explicit number of payments per year. ```typescript // --------------------------------------------------------------------------------------------------- // Coupon schedule generation // --------------------------------------------------------------------------------------------------- /** Coupon payment frequency, named or as an explicit number of payments per year. */ export type Frequency = 'annual' | 'semiannual' | 'quarterly' | 'bimonthly' | 'monthly' | number; ``` ### @insiderfinance/totalfinance/fixed-income#FutureInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A rate future quoted as `price = 100·(1 − impliedRate)` over `[start, end]`. ```typescript /** A rate future quoted as `price = 100·(1 − impliedRate)` over `[start, end]`. */ export interface FutureInstrument { type: 'future'; start: string; end: string; price: number; /** Forward = (100 − price)/100 − convexityAdjustment. Supplied by the caller; default 0 (none). */ convexityAdjustment?: number; /** Default `ACT/360`. */ dayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convexityAdjustment?: number; default: not declared — Forward = (100 − price)/100 − convexityAdjustment. Supplied by the caller; default 0 (none). - dayCount?: FixedIncomeDayCount; default: not declared — Default `ACT/360`. - end: string; default: not declared - price: number; default: not declared - start: string; default: not declared - type: 'future'; default: not declared ### @insiderfinance/totalfinance/fixed-income#G2ppModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface G2ppModel { /** Reconstructed discount bond `P(t,T)` given factor values `(x, y)` at `t` (default 0 ⇒ the curve). */ discountBond(input: G2ppDiscountBondInput): number; /** Analytic zero-coupon-bond option as of t = 0 (Gaussian, like Hull-White but with the G2++ variance). */ zeroCouponBondOption(input: ZeroCouponBondOptionInput): number; caplet(input: RateOptionletInput): number; floorlet(input: RateOptionletInput): number; /** Variance of the short rate at horizonYears `t`. */ shortRateVariance(years: number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - caplet: (input: RateOptionletInput) => number; default: not declared - caplet(input): RateOptionletInput; default: not declared - caplet(input).accrualFraction: number; default: not declared - caplet(input).bondMaturity: number; default: not declared - caplet(input).optionMaturity: number; default: not declared - caplet(input).strikeRate: number; default: not declared - discountBond: (input: G2ppDiscountBondInput) => number; default: not declared — Reconstructed discount bond `P(t,T)` given factor values `(x, y)` at `t` (default 0 ⇒ the curve). - discountBond(input): G2ppDiscountBondInput; default: not declared - discountBond(input).timeToMaturity: number; default: not declared - discountBond(input).valuationTime: number; default: not declared - discountBond(input).x?: number; default: not declared - discountBond(input).y?: number; default: not declared - floorlet: (input: RateOptionletInput) => number; default: not declared - floorlet(input): RateOptionletInput; default: not declared - floorlet(input).accrualFraction: number; default: not declared - floorlet(input).bondMaturity: number; default: not declared - floorlet(input).optionMaturity: number; default: not declared - floorlet(input).strikeRate: number; default: not declared - shortRateVariance: (years: number) => number; default: not declared — Variance of the short rate at horizonYears `t`. - shortRateVariance(years): number; default: not declared - zeroCouponBondOption: (input: ZeroCouponBondOptionInput) => number; default: not declared — Analytic zero-coupon-bond option as of t = 0 (Gaussian, like Hull-White but with the G2++ variance). - zeroCouponBondOption(input): ZeroCouponBondOptionInput; default: not declared - zeroCouponBondOption(input).bondMaturity: number; default: not declared - zeroCouponBondOption(input).optionMaturity: number; default: not declared - zeroCouponBondOption(input).right: 'call' | 'put'; default: not declared - zeroCouponBondOption(input).strike: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#G2ppParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ─────────────────────────────────────────────────────────────────────────────────────────────── // G2++ two-factor Gaussian model (fit to the initial curve) // ─────────────────────────────────────────────────────────────────────────────────────────────── export interface G2ppParameters { /** Mean reversion of factor x. */ a: number; /** Volatility of factor x. */ sigma: number; /** Mean reversion of factor y. */ b: number; /** Volatility of factor y. */ eta: number; /** Instantaneous correlation of the two factors, in [-1, 1]. */ rho: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - a: number; default: not declared — Mean reversion of factor x. - b: number; default: not declared — Mean reversion of factor y. - eta: number; default: not declared — Volatility of factor y. - rho: number; default: not declared — Instantaneous correlation of the two factors, in [-1, 1]. - sigma: number; default: not declared — Volatility of factor x. ### @insiderfinance/totalfinance/fixed-income#GaussianShortRateModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GaussianShortRateModel extends ShortRateModel { /** * Analytic price of a European call/put on a zero-coupon bond maturing at `tBond`, exercised at * `tOption` (years), struck at `strike` (per unit face) — the Jamshidian decomposition's building * block. Returns a present value as of t = 0. */ zeroCouponBondOption(input: ZeroCouponBondOptionInput): number; /** Caplet on the simple rate over `[tOption, tBond]`, strike `capRate`, per unit notional. */ caplet(input: RateOptionletInput): number; /** Floorlet on the simple rate over `[tOption, tBond]`, strike `floorRate`, per unit notional. */ floorlet(input: RateOptionletInput): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - caplet: (input: RateOptionletInput) => number; default: not declared — Caplet on the simple rate over `[tOption, tBond]`, strike `capRate`, per unit notional. - caplet(input): RateOptionletInput; default: not declared - caplet(input).accrualFraction: number; default: not declared - caplet(input).bondMaturity: number; default: not declared - caplet(input).optionMaturity: number; default: not declared - caplet(input).strikeRate: number; default: not declared - discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - discountBond(shortRate): number; default: not declared - discountBond(tau): number; default: not declared - floorlet: (input: RateOptionletInput) => number; default: not declared — Floorlet on the simple rate over `[tOption, tBond]`, strike `floorRate`, per unit notional. - floorlet(input): RateOptionletInput; default: not declared - floorlet(input).accrualFraction: number; default: not declared - floorlet(input).bondMaturity: number; default: not declared - floorlet(input).optionMaturity: number; default: not declared - floorlet(input).strikeRate: number; default: not declared - shortRateMoments: (years: number) => ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - shortRateMoments().return.mean: number; default: not declared - shortRateMoments().return.standardDeviation: number; default: not declared - shortRateMoments().return.variance: number; default: not declared - shortRateMoments(years): number; default: not declared - zeroCouponBondOption: (input: ZeroCouponBondOptionInput) => number; default: not declared — Analytic price of a European call/put on a zero-coupon bond maturing at `tBond`, exercised at `tOption` (years), struck at `strike` (per unit face) — the Jamshidian decomposition's building block. Returns a present value as of t = 0. - zeroCouponBondOption(input): ZeroCouponBondOptionInput; default: not declared - zeroCouponBondOption(input).bondMaturity: number; default: not declared - zeroCouponBondOption(input).optionMaturity: number; default: not declared - zeroCouponBondOption(input).right: 'call' | 'put'; default: not declared - zeroCouponBondOption(input).strike: number; default: not declared - zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. - zeroRate(shortRate): number; default: not declared - zeroRate(tau): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#HazardBootstrapOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HazardBootstrapOptions { referenceDate: string; discountCurve: YieldCurve; recovery?: number; frequency?: Frequency; dayCount?: FixedIncomeDayCount; accrualOnDefault?: boolean; protectionSteps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualOnDefault?: boolean; default: not declared - dayCount?: FixedIncomeDayCount; default: not declared - discountCurve: YieldCurve; default: not declared - discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discountCurve.addSpread(spread): YieldCurve; default: not declared - discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discountCurve.bumpPillar(delta): number; default: not declared - discountCurve.bumpPillar(index): number; default: not declared - discountCurve.dayCount: FixedIncomeDayCount; default: not declared - discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discountCurve.discount(at): string | number; default: not declared - discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discountCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - discountCurve.forwardRate(from): string | number; default: not declared - discountCurve.forwardRate(to): string | number; default: not declared - discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discountCurve.instantaneousForward(at): string | number; default: not declared - discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discountCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - discountCurve.referenceDate: string; default: not declared - discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discountCurve.shift(delta): number; default: not declared - discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discountCurve.timeTo(at): string | number; default: not declared - discountCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discountCurve.zeroRate(at): string | number; default: not declared - discountCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - frequency?: Frequency; default: not declared - protectionSteps?: number; default: not declared - recovery?: number; default: not declared - referenceDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#HullWhiteModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HullWhiteModel { /** Reconstructed discount bond `P(t,T)` consistent with the initial curve, given short rate `r` at t. */ discountBond(input: HullWhiteDiscountBondInput): number; /** Analytic ZCB option as of t = 0 (uses the market curve directly). */ zeroCouponBondOption(input: ZeroCouponBondOptionInput): number; caplet(input: RateOptionletInput): number; floorlet(input: RateOptionletInput): number; /** Standard deviation of the short rate at horizonYears `t`. */ shortRateStandardDeviation(years: number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - caplet: (input: RateOptionletInput) => number; default: not declared - caplet(input): RateOptionletInput; default: not declared - caplet(input).accrualFraction: number; default: not declared - caplet(input).bondMaturity: number; default: not declared - caplet(input).optionMaturity: number; default: not declared - caplet(input).strikeRate: number; default: not declared - discountBond: (input: HullWhiteDiscountBondInput) => number; default: not declared — Reconstructed discount bond `P(t,T)` consistent with the initial curve, given short rate `r` at t. - discountBond(input): HullWhiteDiscountBondInput; default: not declared - discountBond(input).shortRate: number; default: not declared - discountBond(input).timeToMaturity: number; default: not declared - discountBond(input).valuationTime: number; default: not declared - floorlet: (input: RateOptionletInput) => number; default: not declared - floorlet(input): RateOptionletInput; default: not declared - floorlet(input).accrualFraction: number; default: not declared - floorlet(input).bondMaturity: number; default: not declared - floorlet(input).optionMaturity: number; default: not declared - floorlet(input).strikeRate: number; default: not declared - shortRateStandardDeviation: (years: number) => number; default: not declared — Standard deviation of the short rate at horizonYears `t`. - shortRateStandardDeviation(years): number; default: not declared - zeroCouponBondOption: (input: ZeroCouponBondOptionInput) => number; default: not declared — Analytic ZCB option as of t = 0 (uses the market curve directly). - zeroCouponBondOption(input): ZeroCouponBondOptionInput; default: not declared - zeroCouponBondOption(input).bondMaturity: number; default: not declared - zeroCouponBondOption(input).optionMaturity: number; default: not declared - zeroCouponBondOption(input).right: 'call' | 'put'; default: not declared - zeroCouponBondOption(input).strike: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#HullWhiteParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Hull-White (extended Vasicek, fit to the initial curve) // --------------------------------------------------------------------------------------------------- export interface HullWhiteParameters { a: number; sigma: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - a: number; default: not declared - sigma: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#ImpliedCrossCurrencyBasisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ImpliedCrossCurrencyBasisInput { /** FX spot: domestic units per 1 foreign unit. */ spot: number; /** Domestic collateral (OIS) discount curve. */ domestic: YieldCurve; /** Foreign index/OIS discount curve (pre-basis). */ foreign: YieldCurve; /** Observed market FX forwards `[date, forward]` (domestic per foreign). */ forwards: [ string, number ][]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - domestic: YieldCurve; default: not declared — Domestic collateral (OIS) discount curve. - domestic.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - domestic.addSpread(spread): YieldCurve; default: not declared - domestic.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - domestic.bumpPillar(delta): number; default: not declared - domestic.bumpPillar(index): number; default: not declared - domestic.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - domestic.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - domestic.discount(at): string | number; default: not declared - domestic.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - domestic.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - domestic.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - domestic.forwardRate(from): string | number; default: not declared - domestic.forwardRate(to): string | number; default: not declared - domestic.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - domestic.instantaneousForward(at): string | number; default: not declared - domestic.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - domestic.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - domestic.referenceDate: string; default: not declared - domestic.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - domestic.shift(delta): number; default: not declared - domestic.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - domestic.timeTo(at): string | number; default: not declared - domestic.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - domestic.zeroRate(at): string | number; default: not declared - domestic.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - domestic.zeroRate(compounding).periodsPerYear: number; default: not declared - domestic.zeroRate(compounding).type: 'periodic'; default: not declared - foreign: YieldCurve; default: not declared — Foreign index/OIS discount curve (pre-basis). - foreign.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - foreign.addSpread(spread): YieldCurve; default: not declared - foreign.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - foreign.bumpPillar(delta): number; default: not declared - foreign.bumpPillar(index): number; default: not declared - foreign.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - foreign.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - foreign.discount(at): string | number; default: not declared - foreign.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - foreign.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - foreign.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - foreign.forwardRate(from): string | number; default: not declared - foreign.forwardRate(to): string | number; default: not declared - foreign.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - foreign.instantaneousForward(at): string | number; default: not declared - foreign.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - foreign.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - foreign.referenceDate: string; default: not declared - foreign.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - foreign.shift(delta): number; default: not declared - foreign.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - foreign.timeTo(at): string | number; default: not declared - foreign.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - foreign.zeroRate(at): string | number; default: not declared - foreign.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - foreign.zeroRate(compounding).periodsPerYear: number; default: not declared - foreign.zeroRate(compounding).type: 'periodic'; default: not declared - forwards: [string, number][]; default: not declared — Observed market FX forwards `[date, forward]` (domestic per foreign). - spot: number; default: not declared — FX spot: domestic units per 1 foreign unit. ### @insiderfinance/totalfinance/fixed-income#ImpliedCrossCurrencyBasisResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ImpliedCrossCurrencyBasisResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Implied continuous cross-currency basis spread at each forward date (collateralized zero − foreign zero). */ basis: { date: string; spread: number; }[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - basis: { date: string; spread: number; }[]; default: not declared — Implied continuous cross-currency basis spread at each forward date (collateralized zero − foreign zero). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#InflationLinkedBondSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface InflationLinkedBondSpecification extends BaseSpecification { /** Reference index level at issuance (the indexation base). */ baseIndex: number; /** Floor the redeemed principal at par against deflation (TIPS-style). Default false. */ deflationFloor?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseIndex: number; default: not declared — Reference index level at issuance (the indexation base). - convention?: BusinessDayConvention; default: not declared - couponRate: number; default: not declared — Annualized coupon rate (decimal). - dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - deflationFloor?: boolean; default: not declared — Floor the redeemed principal at par against deflation (TIPS-style). Default false. - endOfMonth?: boolean; default: not declared - faceValue?: number; default: not declared — Redemption / par value. Default 100. - frequency: Frequency; default: not declared - issueDate: string; default: not declared — Dated date / first accrual date. - maturityDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#InterestCompounding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#InterestCompounding`. ### @insiderfinance/totalfinance/fixed-income#MultiCurve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A dual-curve set (spec §14.2): an OIS `discountCurve` and an index `forecastCurve`. Its shape is exactly the `SwapCurves` every swap analytic (`swapValue`, `swaptionPrice`, `capFloorPrice`, `cmsConvexityAdjustment`) already consumes, so a bootstrapped set drops straight in. ```typescript /** * A dual-curve set (spec §14.2): an OIS `discountCurve` and an index `forecastCurve`. Its shape is * exactly the `SwapCurves` every swap analytic (`swapValue`, `swaptionPrice`, `capFloorPrice`, * `cmsConvexityAdjustment`) already consumes, so a bootstrapped set drops straight in. */ export interface MultiCurve { discountCurve: YieldCurve; forecastCurve: YieldCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountCurve: YieldCurve; default: not declared - discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discountCurve.addSpread(spread): YieldCurve; default: not declared - discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discountCurve.bumpPillar(delta): number; default: not declared - discountCurve.bumpPillar(index): number; default: not declared - discountCurve.dayCount: FixedIncomeDayCount; default: not declared - discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discountCurve.discount(at): string | number; default: not declared - discountCurve.extrapolation: CurveExtrapolation; default: not declared - discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discountCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - discountCurve.forwardRate(from): string | number; default: not declared - discountCurve.forwardRate(to): string | number; default: not declared - discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discountCurve.instantaneousForward(at): string | number; default: not declared - discountCurve.interpolation: CurveInterpolation; default: not declared - discountCurve.pillars: readonly CurvePillar[]; default: not declared - discountCurve.referenceDate: string; default: not declared - discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discountCurve.shift(delta): number; default: not declared - discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discountCurve.timeTo(at): string | number; default: not declared - discountCurve.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discountCurve.zeroRate(at): string | number; default: not declared - discountCurve.zeroRate(compounding)?: InterestCompounding | undefined; default: not declared - discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - forecastCurve: YieldCurve; default: not declared - forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - forecastCurve.addSpread(spread): YieldCurve; default: not declared - forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - forecastCurve.bumpPillar(delta): number; default: not declared - forecastCurve.bumpPillar(index): number; default: not declared - forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - forecastCurve.discount(at): string | number; default: not declared - forecastCurve.extrapolation: CurveExtrapolation; default: not declared - forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - forecastCurve.forwardRate(from): string | number; default: not declared - forecastCurve.forwardRate(to): string | number; default: not declared - forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - forecastCurve.instantaneousForward(at): string | number; default: not declared - forecastCurve.interpolation: CurveInterpolation; default: not declared - forecastCurve.pillars: readonly CurvePillar[]; default: not declared - forecastCurve.referenceDate: string; default: not declared - forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - forecastCurve.shift(delta): number; default: not declared - forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - forecastCurve.timeTo(at): string | number; default: not declared - forecastCurve.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - forecastCurve.zeroRate(at): string | number; default: not declared - forecastCurve.zeroRate(compounding)?: InterestCompounding | undefined; default: not declared - forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/fixed-income#MultiCurveBootstrapOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link bootstrapMultiCurve}: the OIS + projection instrument sets share one build config. ```typescript /** Options for {@link bootstrapMultiCurve}: the OIS + projection instrument sets share one build config. */ export interface MultiCurveBootstrapOptions extends BootstrapOptions { /** Instruments defining the OIS discount curve (self-discounting). */ ois: BootstrapInstrument[]; /** Instruments defining the index projection curve (discounted on the OIS curve). */ projection: BootstrapInstrument[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - extrapolation?: CurveExtrapolation; default: not declared - interpolation?: CurveInterpolation; default: not declared - ois: BootstrapInstrument[]; default: not declared — Instruments defining the OIS discount curve (self-discounting). - projection: BootstrapInstrument[]; default: not declared — Instruments defining the index projection curve (discounted on the OIS curve). - referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). ### @insiderfinance/totalfinance/fixed-income#OasAnalyticsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OasAnalyticsResult { /** Parallel curve shift repricing the callable model to `marketPrice` (decimal; ×1e4 = bps). */ oas: number; /** Zero-volatility spread on the same lattice's straight leg (decimal). */ zSpread: number; /** `zSpread − oas` (decimal) — the embedded-option cost. Positive callable / negative putable. */ optionCost: number; /** OAS-consistent effective duration (curve shocked ±`durationShock` at constant OAS). */ effectiveDuration: number; /** OAS-consistent effective convexity. */ effectiveConvexity: number; /** The no-spread lattice model price (the gap `marketPrice − modelPrice` is what the OAS explains). */ modelPrice: number; marketPrice: number; assumptions: CallableBondResult['assumptions']; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; meanReversion: number; model: TreeModel; settlementDate: string; sigma: number; stepsPerYear: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: 'ACT/365F'; default: not declared - assumptions.meanReversion: number; default: not declared - assumptions.model: TreeModel; default: not declared - assumptions.settlementDate: string; default: not declared - assumptions.sigma: number; default: not declared - assumptions.stepsPerYear: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - effectiveConvexity: number; default: not declared — OAS-consistent effective convexity. - effectiveDuration: number; default: not declared — OAS-consistent effective duration (curve shocked ±`durationShock` at constant OAS). - marketPrice: number; default: not declared - modelPrice: number; default: not declared — The no-spread lattice model price (the gap `marketPrice − modelPrice` is what the OAS explains). - oas: number; default: not declared — Parallel curve shift repricing the callable model to `marketPrice` (decimal; ×1e4 = bps). - optionCost: number; default: not declared — `zSpread − oas` (decimal) — the embedded-option cost. Positive callable / negative putable. - zSpread: number; default: not declared — Zero-volatility spread on the same lattice's straight leg (decimal). ### @insiderfinance/totalfinance/fixed-income#OasAnalyticsSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── OAS analytics ───────────────────────── export interface OasAnalyticsSpecification extends Omit { /** Market dirty price the OAS and Z-spread are solved to. */ marketPrice: number; /** Curve shock for the effective duration/convexity, in decimal. Default 1e-4 (1 bp). */ durationShock?: number; /** * Optional term-structure spread curve added to `curve` before the spreads are solved. The effective * benchmark becomes `curve` + `spreadCurve` (continuous zeros add ⇔ discount factors multiply), so the * reported OAS and Z-spread are measured OVER a NON-FLAT benchmark — e.g. an OIS discount curve plus a * sector/rating spread curve — rather than the plain `curve`. Its zero rates ARE the spreads (build one * with `curves.fromZeroRates(spreadPillars)`); it must share `curve`'s reference date. */ spreadCurve?: YieldCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bond: Bond; default: not declared - bond.accrued: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - bond.accrued(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.accrued(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.accrued(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.accrued(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.accrued(settlementDate): string; default: not declared - bond.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - bond.cashflows: (context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - bond.cashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.cashflows(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.cashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.cashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.couponRate: number; default: not declared - bond.dayCount: FixedIncomeDayCount; default: not declared - bond.faceValue: number; default: not declared - bond.frequency: number; default: not declared - bond.futureCashflows: (settlementDate: string, context?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext) => import('@insiderfinance/totalfinance/fixed-income').CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - bond.futureCashflows(context)?: import('@insiderfinance/totalfinance/fixed-income').ProjectionContext | undefined; default: not declared - bond.futureCashflows(context).forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - bond.futureCashflows(context).knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - bond.futureCashflows(context).referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - bond.futureCashflows(settlementDate): string; default: not declared - bond.issueDate: string; default: not declared - bond.kind: import('@insiderfinance/totalfinance/fixed-income').BondKind; default: not declared - bond.maturityDate: string; default: not declared - bond.schedule: readonly import('@insiderfinance/totalfinance/fixed-income').SchedulePeriod[]; default: not declared - calls?: BondOption[]; default: not declared — Issuer call schedule (caps the bond's value at each strike). - curve: YieldCurve; default: not declared — Calibration/discount curve (its reference date is the valuation date). - curve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curve.addSpread(spread): YieldCurve; default: not declared - curve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curve.bumpPillar(delta): number; default: not declared - curve.bumpPillar(index): number; default: not declared - curve.dayCount: FixedIncomeDayCount; default: not declared - curve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curve.discount(at): string | number; default: not declared - curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - curve.forwardRate(from): string | number; default: not declared - curve.forwardRate(to): string | number; default: not declared - curve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curve.instantaneousForward(at): string | number; default: not declared - curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curve.referenceDate: string; default: not declared - curve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curve.shift(delta): number; default: not declared - curve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curve.timeTo(at): string | number; default: not declared - curve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curve.zeroRate(at): string | number; default: not declared - curve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - curve.zeroRate(compounding).periodsPerYear: number; default: not declared - curve.zeroRate(compounding).type: 'periodic'; default: not declared - durationShock?: number; default: not declared — Curve shock for the effective duration/convexity, in decimal. Default 1e-4 (1 bp). - marketPrice: number; default: not declared — Market dirty price the OAS and Z-spread are solved to. - meanReversion: number; default: not declared — Mean reversion and short-rate volatility for the tree model. - model?: TreeModel; default: not declared — Tree model (default `hull-white`). - puts?: BondOption[]; default: not declared — Holder put schedule (floors the bond's value at each strike). - sigma: number; default: not declared - spreadCurve?: YieldCurve; default: not declared — Optional term-structure spread curve added to `curve` before the spreads are solved. The effective benchmark becomes `curve` + `spreadCurve` (continuous zeros add ⇔ discount factors multiply), so the reported OAS and Z-spread are measured OVER a NON-FLAT benchmark — e.g. an OIS discount curve plus a sector/rating spread curve — rather than the plain `curve`. Its zero rates ARE the spreads (build one with `curves.fromZeroRates(spreadPillars)`); it must share `curve`'s reference date. - spreadCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - spreadCurve.addSpread(spread): YieldCurve; default: not declared - spreadCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - spreadCurve.bumpPillar(delta): number; default: not declared - spreadCurve.bumpPillar(index): number; default: not declared - spreadCurve.dayCount: FixedIncomeDayCount; default: not declared - spreadCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - spreadCurve.discount(at): string | number; default: not declared - spreadCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - spreadCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - spreadCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - spreadCurve.forwardRate(from): string | number; default: not declared - spreadCurve.forwardRate(to): string | number; default: not declared - spreadCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - spreadCurve.instantaneousForward(at): string | number; default: not declared - spreadCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - spreadCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - spreadCurve.referenceDate: string; default: not declared - spreadCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - spreadCurve.shift(delta): number; default: not declared - spreadCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - spreadCurve.timeTo(at): string | number; default: not declared - spreadCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - spreadCurve.zeroRate(at): string | number; default: not declared - spreadCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - spreadCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - spreadCurve.zeroRate(compounding).type: 'periodic'; default: not declared - stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). ### @insiderfinance/totalfinance/fixed-income#OptionRight Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionRight = 'call' | 'put'; ``` ### @insiderfinance/totalfinance/fixed-income#ParCdsSpecification Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A par-spread request: a {@link CdsSpecification} WITHOUT `spread` (H02) — the par spread is the ANSWER, so requiring a current spread demanded an input the calculation never reads. Passing one anyway teaches (Law 12: accepted-but-ignored implies it mattered). ```typescript /** Par CDS spread (the running coupon that makes the CDS value zero). */ /** * A par-spread request: a {@link CdsSpecification} WITHOUT `spread` (H02) — the par spread is the * ANSWER, so requiring a current spread demanded an input the calculation never reads. Passing one * anyway teaches (Law 12: accepted-but-ignored implies it mattered). */ export type ParCdsSpecification = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - effectiveDate: string; default: not declared - frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - maturityDate: string; default: not declared - notional?: number; default: not declared - protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - recovery?: number; default: not declared — Recovery rate on default. Default 0.4. ### @insiderfinance/totalfinance/fixed-income#ParSwapSpecification Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A par-rate request: a {@link SwapSpecification} WITHOUT `fixedRate` (H04) — the par rate is the ANSWER, so requiring a fixed coupon demanded an input the calculation never reads. Passing one anyway teaches (Law 12: accepted-but-ignored implies it mattered). Structurally the same shape as {@link ForwardSwapSpecification}; each name states which question is being asked. ```typescript /** * A par-rate request: a {@link SwapSpecification} WITHOUT `fixedRate` (H04) — the par rate is the * ANSWER, so requiring a fixed coupon demanded an input the calculation never reads. Passing one * anyway teaches (Law 12: accepted-but-ignored implies it mattered). Structurally the same shape * as {@link ForwardSwapSpecification}; each name states which question is being asked. */ export type ParSwapSpecification = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - maturityDate: string; default: not declared - notional?: number; default: not declared - startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#PriceFromYieldOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceFromYieldOptions { settlementDate: string; /** Annualized yield (decimal). */ yield: number; context?: ProjectionContext; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - context?: ProjectionContext; default: not declared - context.forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - context.forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - context.forecastCurve.addSpread(spread): YieldCurve; default: not declared - context.forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - context.forecastCurve.bumpPillar(delta): number; default: not declared - context.forecastCurve.bumpPillar(index): number; default: not declared - context.forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - context.forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - context.forecastCurve.discount(at): string | number; default: not declared - context.forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - context.forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - context.forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - context.forecastCurve.forwardRate(from): string | number; default: not declared - context.forecastCurve.forwardRate(to): string | number; default: not declared - context.forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - context.forecastCurve.instantaneousForward(at): string | number; default: not declared - context.forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - context.forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - context.forecastCurve.referenceDate: string; default: not declared - context.forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - context.forecastCurve.shift(delta): number; default: not declared - context.forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - context.forecastCurve.timeTo(at): string | number; default: not declared - context.forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - context.forecastCurve.zeroRate(at): string | number; default: not declared - context.forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - context.forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - context.forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared - context.knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - context.referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - context.referenceIndex(date): string; default: not declared - settlementDate: string; default: not declared - yield: number; default: not declared — Annualized yield (decimal). ### @insiderfinance/totalfinance/fixed-income#ProjectionBootstrapOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link bootstrapProjection}: {@link BootstrapOptions} plus the OIS discount curve. ```typescript /** Options for {@link bootstrapProjection}: {@link BootstrapOptions} plus the OIS discount curve. */ export interface ProjectionBootstrapOptions extends BootstrapOptions { /** * The (OIS) discount curve. Each par swap discounts its legs on THIS curve while its floating * forwards project off the curve being built — the post-2008 dual-curve convention. Build it first * with {@link bootstrap} (self-discounting OIS), then pass it here. */ discountCurve: YieldCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - discountCurve: YieldCurve; default: not declared — The (OIS) discount curve. Each par swap discounts its legs on THIS curve while its floating forwards project off the curve being built — the post-2008 dual-curve convention. Build it first with {@link bootstrap} (self-discounting OIS), then pass it here. - discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discountCurve.addSpread(spread): YieldCurve; default: not declared - discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discountCurve.bumpPillar(delta): number; default: not declared - discountCurve.bumpPillar(index): number; default: not declared - discountCurve.dayCount: FixedIncomeDayCount; default: not declared - discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discountCurve.discount(at): string | number; default: not declared - discountCurve.extrapolation: CurveExtrapolation; default: not declared - discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discountCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - discountCurve.forwardRate(from): string | number; default: not declared - discountCurve.forwardRate(to): string | number; default: not declared - discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discountCurve.instantaneousForward(at): string | number; default: not declared - discountCurve.interpolation: CurveInterpolation; default: not declared - discountCurve.pillars: readonly CurvePillar[]; default: not declared - discountCurve.referenceDate: string; default: not declared - discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discountCurve.shift(delta): number; default: not declared - discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discountCurve.timeTo(at): string | number; default: not declared - discountCurve.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discountCurve.zeroRate(at): string | number; default: not declared - discountCurve.zeroRate(compounding)?: InterestCompounding | undefined; default: not declared - discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - extrapolation?: CurveExtrapolation; default: not declared - interpolation?: CurveInterpolation; default: not declared - referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). ### @insiderfinance/totalfinance/fixed-income#ProjectionContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Projection inputs for instruments whose coupons are not fixed at issuance. ```typescript /** Projection inputs for instruments whose coupons are not fixed at issuance. */ export interface ProjectionContext { /** Forecast curve for projecting floating-rate coupons. */ forecastCurve?: YieldCurve; /** Price-index level at a date, for inflation-linked indexation. */ referenceIndex?: (date: string) => number; /** * The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently * accruing on a floating-rate note — the one whose accrual period began before the forecast * curve's reference date. * * A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the * past, on a date the curve does not reach. Asking the curve for it is a query before its * reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) * and it is used verbatim for that one coupon; every later coupon still projects off the curve. * The note's quoted `spread` is added on top, exactly as for a projected coupon. * * Only the in-progress coupon is substituted. Coupons that both began AND ended before the * curve's reference date are settled history, not projections — one fixing cannot honestly stand * in for a whole strip of past resets, so those are rejected rather than fabricated. */ knownFixingRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - forecastCurve.addSpread(spread): YieldCurve; default: not declared - forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - forecastCurve.bumpPillar(delta): number; default: not declared - forecastCurve.bumpPillar(index): number; default: not declared - forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - forecastCurve.discount(at): string | number; default: not declared - forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - forecastCurve.forwardRate(from): string | number; default: not declared - forecastCurve.forwardRate(to): string | number; default: not declared - forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - forecastCurve.instantaneousForward(at): string | number; default: not declared - forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - forecastCurve.referenceDate: string; default: not declared - forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - forecastCurve.shift(delta): number; default: not declared - forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - forecastCurve.timeTo(at): string | number; default: not declared - forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - forecastCurve.zeroRate(at): string | number; default: not declared - forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared - knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - referenceIndex(date): string; default: not declared ### @insiderfinance/totalfinance/fixed-income#RatesVolatilityModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RatesVolatilityModel = 'black' | 'bachelier'; ``` ### @insiderfinance/totalfinance/fixed-income#ScheduleOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScheduleOptions { /** First accrual date (dated/effective date). */ effectiveDate: string; /** Final accrual date (maturity). */ maturityDate: string; frequency: Frequency; /** Business-day roll applied to payment dates (default `modifiedFollowing`). */ convention?: BusinessDayConvention; /** Calendar deciding business days (default weekends-only). */ calendar?: Calendar; /** Force month-end rolling; defaults to auto-detect from whether `maturityDate` is a month end. */ endOfMonth?: boolean; /** Business days between a period's accrual end and its payment (settlement lag). Default 0. */ paymentLagDays?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calendar?: Calendar; default: not declared — Calendar deciding business days (default weekends-only). - calendar.addBusinessDays: (date: string, days: number) => string; default: not declared - calendar.addBusinessDays(date): string; default: not declared - calendar.addBusinessDays(days): number; default: not declared - calendar.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - calendar.businessDaysBetween(from): string; default: not declared - calendar.businessDaysBetween(to): string; default: not declared - calendar.isBusinessDay: (date: string) => boolean; default: not declared - calendar.isBusinessDay(date): string; default: not declared - calendar.isHalfDay: (date: string) => boolean; default: not declared - calendar.isHalfDay(date): string; default: not declared - calendar.isHoliday: (date: string) => boolean; default: not declared - calendar.isHoliday(date): string; default: not declared - calendar.name: string; default: not declared - calendar.nextBusinessDay: (date: string) => string; default: not declared - calendar.nextBusinessDay(date): string; default: not declared - calendar.previousBusinessDay: (date: string) => string; default: not declared - calendar.previousBusinessDay(date): string; default: not declared - calendar.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - calendar.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - calendar.session().return.date: string; default: not declared - calendar.session().return.isBusinessDay: boolean; default: not declared - calendar.session().return.isHalfDay: boolean; default: not declared - calendar.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - calendar.session(date): string; default: not declared - calendar.timezone: string; default: not declared - calendar.version: string; default: not declared - convention?: BusinessDayConvention; default: not declared — Business-day roll applied to payment dates (default `modifiedFollowing`). - effectiveDate: string; default: not declared — First accrual date (dated/effective date). - endOfMonth?: boolean; default: not declared — Force month-end rolling; defaults to auto-detect from whether `maturityDate` is a month end. - frequency: Frequency; default: not declared - maturityDate: string; default: not declared — Final accrual date (maturity). - paymentLagDays?: number; default: not declared — Business days between a period's accrual end and its payment (settlement lag). Default 0. ### @insiderfinance/totalfinance/fixed-income#SchedulePeriod Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SchedulePeriod { /** Unadjusted accrual start (regular schedule date). */ accrualStart: string; /** Unadjusted accrual end (regular schedule date). */ accrualEnd: string; /** Business-day-adjusted payment date (accrual end rolled, plus any settlement lag). */ paymentDate: string; /** True when this period is a short front stub (shorter than a regular coupon period). */ isStub: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualEnd: string; default: not declared — Unadjusted accrual end (regular schedule date). - accrualStart: string; default: not declared — Unadjusted accrual start (regular schedule date). - isStub: boolean; default: not declared — True when this period is a short front stub (shorter than a regular coupon period). - paymentDate: string; default: not declared — Business-day-adjusted payment date (accrual end rolled, plus any settlement lag). ### @insiderfinance/totalfinance/fixed-income#ShortRateModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ShortRateModel { /** Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). */ discountBond(shortRate: number, tau: number): number; /** Continuously-compounded zero rate `−ln P / τ`. */ zeroRate(shortRate: number, tau: number): number; /** Mean/variance of the short rate at horizonYears `T` (years), from `r0`. */ shortRateMoments(years: number): ShortRateMoments; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - discountBond(shortRate): number; default: not declared - discountBond(tau): number; default: not declared - shortRateMoments: (years: number) => ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - shortRateMoments().return.mean: number; default: not declared - shortRateMoments().return.standardDeviation: number; default: not declared - shortRateMoments().return.variance: number; default: not declared - shortRateMoments(years): number; default: not declared - zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. - zeroRate(shortRate): number; default: not declared - zeroRate(tau): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#ShortRateMoments Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ShortRateMoments { mean: number; variance: number; standardDeviation: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - mean: number; default: not declared - standardDeviation: number; default: not declared - variance: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#ShortRateTree Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ShortRateTree { readonly model: TreeModel; readonly steps: number; readonly timeStepYears: number; /** Short rate at tree node `(i, j)` (time step i, level j). */ shortRate(stepIndex: number, nodeIndex: number): number; /** Tree-implied discount bond price `P(0, T)` for a maturity on the time grid (years). */ discountBond(maturity: number): number; /** Reference discount factors the tree was calibrated to, at each grid time. */ readonly gridTimes: readonly number[]; /** Map a year fraction to its grid step, validating it lands on the grid. */ stepOf(years: number): number; /** Half-width of reachable levels at step `i` (nodes span `[-reach, +reach]`). */ reachAt(stepIndex: number): number; /** * Generic backward induction from `terminalStep` to the root. `terminal(j)` seeds the value at each * terminal node; at every earlier node the discounted expected continuation is passed to `atNode`, * which returns the node value (inject cashflows, apply call/exercise via min/max). Returns the root * value. The engine behind callable bonds and Bermudan swaptions. */ rollback(terminalStep: number, terminal: (j: number) => number, atNode?: (i: number, j: number, continuation: number) => number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountBond: (maturity: number) => number; default: not declared — Tree-implied discount bond price `P(0, T)` for a maturity on the time grid (years). - discountBond(maturity): number; default: not declared - gridTimes: readonly number[]; default: not declared — Reference discount factors the tree was calibrated to, at each grid time. - model: TreeModel; default: not declared - reachAt: (stepIndex: number) => number; default: not declared — Half-width of reachable levels at step `i` (nodes span `[-reach, +reach]`). - reachAt(stepIndex): number; default: not declared - rollback: (terminalStep: number, terminal: (j: number) => number, atNode?: (i: number, j: number, continuation: number) => number) => number; default: not declared — Generic backward induction from `terminalStep` to the root. `terminal(j)` seeds the value at each terminal node; at every earlier node the discounted expected continuation is passed to `atNode`, which returns the node value (inject cashflows, apply call/exercise via min/max). Returns the root value. The engine behind callable bonds and Bermudan swaptions. - rollback(atNode)?: ((i: number, j: number, continuation: number) => number) | undefined; default: not declared - rollback(terminal): (j: number) => number; default: not declared - rollback(terminalStep): number; default: not declared - shortRate: (stepIndex: number, nodeIndex: number) => number; default: not declared — Short rate at tree node `(i, j)` (time step i, level j). - shortRate(nodeIndex): number; default: not declared - shortRate(stepIndex): number; default: not declared - stepOf: (years: number) => number; default: not declared — Map a year fraction to its grid step, validating it lands on the grid. - stepOf(years): number; default: not declared - steps: number; default: not declared - timeStepYears: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#ShortRateTreeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ShortRateTreeOptions { meanReversion: number; sigma: number; /** `hull-white` (Gaussian short rate) or `black-karasinski` (lognormal short rate). */ model: TreeModel; /** Tree horizonYears in years. */ horizonYears: number; /** Number of time steps (default 50). */ steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - horizonYears: number; default: not declared — Tree horizonYears in years. - meanReversion: number; default: not declared - model: TreeModel; default: not declared — `hull-white` (Gaussian short rate) or `black-karasinski` (lognormal short rate). - sigma: number; default: not declared - steps?: number; default: not declared — Number of time steps (default 50). ### @insiderfinance/totalfinance/fixed-income#SurvivalCurve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SurvivalCurve { readonly referenceDate: string; readonly dayCount: FixedIncomeDayCount; readonly pillars: readonly SurvivalPillar[]; timeTo(at: string | number): number; /** Survival probability Q to a date or year fraction. */ survival(at: string | number): number; /** Instantaneous (piecewise-constant) hazard rate at a date or year fraction. */ hazard(at: string | number): number; /** Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). */ defaultProbability(from: string | number, to: string | number): number; /** Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). */ conditionalDefaultProbability(from: string | number, to: string | number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - conditionalDefaultProbability(from): string | number; default: not declared - conditionalDefaultProbability(to): string | number; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - defaultProbability(from): string | number; default: not declared - defaultProbability(to): string | number; default: not declared - hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - hazard(at): string | number; default: not declared - pillars: readonly SurvivalPillar[]; default: not declared - referenceDate: string; default: not declared - survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - survival(at): string | number; default: not declared - timeTo: (at: string | number) => number; default: not declared - timeTo(at): string | number; default: not declared ### @insiderfinance/totalfinance/fixed-income#SurvivalCurveOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SurvivalCurveOptions { /** Reference date (t = 0, where Q = 1). Default: the first pillar date. */ referenceDate?: string; /** Day count mapping dates → year fractions. Default `ACT/365F`. */ dayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - referenceDate?: string; default: not declared — Reference date (t = 0, where Q = 1). Default: the first pillar date. ### @insiderfinance/totalfinance/fixed-income#SurvivalPillar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Survival / hazard curve // --------------------------------------------------------------------------------------------------- export interface SurvivalPillar { date: string; tenorYears: number; /** Cumulative hazard H(t) = ∫₀ᵗ λ. */ cumulativeHazard: number; /** Survival probability Q(t) = exp(−H(t)). */ survival: number; /** Piecewise-constant forward hazard on the segment ending at this pillar. */ hazard: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cumulativeHazard: number; default: not declared — Cumulative hazard H(t) = ∫₀ᵗ λ. - date: string; default: not declared - hazard: number; default: not declared — Piecewise-constant forward hazard on the segment ending at this pillar. - survival: number; default: not declared — Survival probability Q(t) = exp(−H(t)). - tenorYears: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwapCurves Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SwapCurves { discountCurve: YieldCurve; /** Projection curve for floating coupons; defaults to the discount curve (single-curve). */ forecastCurve?: YieldCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountCurve: YieldCurve; default: not declared - discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discountCurve.addSpread(spread): YieldCurve; default: not declared - discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discountCurve.bumpPillar(delta): number; default: not declared - discountCurve.bumpPillar(index): number; default: not declared - discountCurve.dayCount: FixedIncomeDayCount; default: not declared - discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discountCurve.discount(at): string | number; default: not declared - discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discountCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - discountCurve.forwardRate(from): string | number; default: not declared - discountCurve.forwardRate(to): string | number; default: not declared - discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discountCurve.instantaneousForward(at): string | number; default: not declared - discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discountCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - discountCurve.referenceDate: string; default: not declared - discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discountCurve.shift(delta): number; default: not declared - discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discountCurve.timeTo(at): string | number; default: not declared - discountCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discountCurve.zeroRate(at): string | number; default: not declared - discountCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - forecastCurve.addSpread(spread): YieldCurve; default: not declared - forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - forecastCurve.bumpPillar(delta): number; default: not declared - forecastCurve.bumpPillar(index): number; default: not declared - forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - forecastCurve.discount(at): string | number; default: not declared - forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - forecastCurve.forwardRate(from): string | number; default: not declared - forecastCurve.forwardRate(to): string | number; default: not declared - forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - forecastCurve.instantaneousForward(at): string | number; default: not declared - forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - forecastCurve.referenceDate: string; default: not declared - forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - forecastCurve.shift(delta): number; default: not declared - forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - forecastCurve.timeTo(at): string | number; default: not declared - forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - forecastCurve.zeroRate(at): string | number; default: not declared - forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwapInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A par swap or OIS: the fixed leg pays `rate` at `fixedFrequency`; single-curve par condition. ```typescript /** A par swap or OIS: the fixed leg pays `rate` at `fixedFrequency`; single-curve par condition. */ export interface SwapInstrument { type: 'swap' | 'ois'; maturity: string; rate: number; /** Fixed-leg frequency. Default annual for `ois`, semiannual for `swap`. */ fixedFrequency?: Frequency; /** Fixed-leg accrual day count. Default `30/360`. */ fixedDayCount?: FixedIncomeDayCount; /** * Floating-leg frequency. Used by BOTH bootstraps: each now sums the floating leg explicitly, so * that a bootstrapped curve reprices its input swaps under `swapValue` (the single-curve * bootstrap used to telescope the leg to `1 − DF(T)` and ignore this field, which is exact only * while no payment date rolls to a business day). Default `quarterly`. */ floatFrequency?: Frequency; /** Floating-leg day count. Default `ACT/360`. */ floatDayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg accrual day count. Default `30/360`. - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency. Default annual for `ois`, semiannual for `swap`. - floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count. Default `ACT/360`. - floatFrequency?: Frequency; default: not declared — Floating-leg frequency. Used by BOTH bootstraps: each now sums the floating leg explicitly, so that a bootstrapped curve reprices its input swaps under `swapValue` (the single-curve bootstrap used to telescope the leg to `1 − DF(T)` and ignore this field, which is exact only while no payment date rolls to a business day). Default `quarterly`. - maturity: string; default: not declared - rate: number; default: not declared - type: 'swap' | 'ois'; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwapRateAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `swapRate.explain` echoes (FI day-count vocabulary — wider than core's `Assumptions` enum, so the facade construction below carries the same type-level-only cast as `bondFacade`; the runtime shape is exactly the core envelope). ```typescript /** The conventions `swapRate.explain` echoes (FI day-count vocabulary — wider than core's * `Assumptions` enum, so the facade construction below carries the same type-level-only cast as * `bondFacade`; the runtime shape is exactly the core envelope). */ export interface SwapRateAssumptions { conventionsVersion: string; startDate: string; maturityDate: string; notional: number; fixedFrequency: Frequency; fixedDayCount: FixedIncomeDayCount; floatFrequency: Frequency; floatDayCount: FixedIncomeDayCount; floatSpread: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - fixedDayCount: FixedIncomeDayCount; default: not declared - fixedFrequency: Frequency; default: not declared - floatDayCount: FixedIncomeDayCount; default: not declared - floatFrequency: Frequency; default: not declared - floatSpread: number; default: not declared - maturityDate: string; default: not declared - notional: number; default: not declared - startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwapRateFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SwapRateFacade = ((specification: ParSwapSpecification, curves: SwapCurves) => number) & { explain: (specification: ParSwapSpecification, curves: SwapCurves) => Omit, 'assumptions'> & { assumptions: SwapRateAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): ParSwapSpecification; default: not declared - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - (specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - (specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - (specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - (specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).startDate: string; default: not declared - explain: (specification: ParSwapSpecification, curves: SwapCurves) => Omit, 'assumptions'> & { assumptions: SwapRateAssumptions; }; default: not declared - explain().return.assumptions: SwapRateAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(curves): SwapCurves; default: not declared - explain(curves).discountCurve: YieldCurve; default: not declared - explain(curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - explain(specification): ParSwapSpecification; default: not declared - explain(specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - explain(specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - explain(specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - explain(specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - explain(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - explain(specification).maturityDate: string; default: not declared - explain(specification).notional?: number; default: not declared - explain(specification).startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwapSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Swaps & OIS // --------------------------------------------------------------------------------------------------- export interface SwapSpecification { startDate: string; maturityDate: string; /** Fixed-leg rate. */ fixedRate: number; notional?: number; /** Fixed-leg frequency (default semiannual). */ fixedFrequency?: Frequency; /** Fixed-leg day count (default `30/360`). */ fixedDayCount?: FixedIncomeDayCount; /** Floating-leg frequency (default quarterly). */ floatFrequency?: Frequency; /** Floating-leg day count (default `ACT/360`). */ floatDayCount?: FixedIncomeDayCount; /** Spread over the projected index on the floating leg (default 0). */ floatSpread?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - fixedRate: number; default: not declared — Fixed-leg rate. - floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - maturityDate: string; default: not declared - notional?: number; default: not declared - startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwapValuation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SwapValuation { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** PV to the payer (pays fixed, receives floating). Receiver PV is the negative. */ value: number; parRate: number; /** Σ τᵢ·DF(tᵢ) over the fixed leg (the level / PV of a unit annuity). */ annuity: number; fixedLegPresentValue: number; floatLegPresentValue: number; /** PV of a 1bp change in the fixed rate (per notional). */ pv01: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annuity: number; default: not declared — Σ τᵢ·DF(tᵢ) over the fixed leg (the level / PV of a unit annuity). - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - fixedLegPresentValue: number; default: not declared - floatLegPresentValue: number; default: not declared - parRate: number; default: not declared - pv01: number; default: not declared — PV of a 1bp change in the fixed rate (per notional). - value: number; default: not declared — PV to the payer (pays fixed, receives floating). Receiver PV is the negative. ### @insiderfinance/totalfinance/fixed-income#SwaptionResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SwaptionResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; price: number; forwardSwapRate: number; annuity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annuity: number; default: not declared - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - forwardSwapRate: number; default: not declared - price: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#SwaptionSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Swaptions // --------------------------------------------------------------------------------------------------- export interface SwaptionSpecification extends SwapSpecification { /** Option expiry (typically the swap start). */ expiry: string; /** Volatility — lognormal for `black`, normal (absolute) for `bachelier`. */ volatility: number; /** `payer` = option to pay fixed (call on the swap rate); `receiver` = option to receive fixed. */ optionType: 'payer' | 'receiver'; model?: RatesVolatilityModel; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared — Option expiry (typically the swap start). - fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - fixedRate: number; default: not declared — Fixed-leg rate. - floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - maturityDate: string; default: not declared - model?: RatesVolatilityModel; default: not declared - notional?: number; default: not declared - optionType: 'payer' | 'receiver'; default: not declared — `payer` = option to pay fixed (call on the swap rate); `receiver` = option to receive fixed. - startDate: string; default: not declared - volatility: number; default: not declared — Volatility — lognormal for `black`, normal (absolute) for `bachelier`. ### @insiderfinance/totalfinance/fixed-income#TipsIndexRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link tipsIndexRatio}. ```typescript // --------------------------------------------------------------------------------------------------- // 1. TIPS index ratio // --------------------------------------------------------------------------------------------------- /** Input for {@link tipsIndexRatio}. */ export interface TipsIndexRatioInput { /** The date the index ratio is for (ISO). */ settlementDate: string; /** NSA CPI by month `'YYYY-MM'` → level; must cover the 3-month-lag window of every date used. */ cpi: Record; /** The dated-date reference CPI (indexation base) — supply this OR `datedDate`, exactly one. */ baseReferenceCpi?: number; /** The bond's dated date; its reference CPI (interpolated from `cpi`) becomes the base. */ datedDate?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseReferenceCpi?: number; default: not declared — The dated-date reference CPI (indexation base) — supply this OR `datedDate`, exactly one. - cpi: Record; default: not declared — NSA CPI by month `'YYYY-MM'` → level; must cover the 3-month-lag window of every date used. - datedDate?: string; default: not declared — The bond's dated date; its reference CPI (interpolated from `cpi`) becomes the base. - settlementDate: string; default: not declared — The date the index ratio is for (ISO). ### @insiderfinance/totalfinance/fixed-income#TipsIndexRatioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The reference CPI and index ratio for a settlement date. ```typescript /** The reference CPI and index ratio for a settlement date. */ export interface TipsIndexRatioResult { settlementDate: string; /** Interpolated reference CPI (raw). */ referenceCpi: number; /** Reference CPI rounded to the Treasury's 5 decimals. */ referenceCpiRounded: number; baseReferenceCpi: number; /** `referenceCpi / baseReferenceCpi` (raw). */ indexRatio: number; /** Index ratio rounded to 5 decimals (the official ratio). */ indexRatioRounded: number; /** CPI three months prior (`CPI₋₃`) and its month. */ lagMonth3: string; lagMonth3Cpi: number; /** CPI two months prior (`CPI₋₂`) and its month. */ lagMonth2: string; lagMonth2Cpi: number; /** `indexRatio − 1`. */ inflationSinceBase: number; assumptions: { conventionsVersion: string; lagMonths: 3; interpolation: 'daily-linear'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; interpolation: 'daily-linear'; lagMonths: 3; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.interpolation: 'daily-linear'; default: not declared - assumptions.lagMonths: 3; default: not declared - baseReferenceCpi: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - indexRatio: number; default: not declared — `referenceCpi / baseReferenceCpi` (raw). - indexRatioRounded: number; default: not declared — Index ratio rounded to 5 decimals (the official ratio). - inflationSinceBase: number; default: not declared — `indexRatio − 1`. - lagMonth2: string; default: not declared — CPI two months prior (`CPI₋₂`) and its month. - lagMonth2Cpi: number; default: not declared - lagMonth3: string; default: not declared — CPI three months prior (`CPI₋₃`) and its month. - lagMonth3Cpi: number; default: not declared - referenceCpi: number; default: not declared — Interpolated reference CPI (raw). - referenceCpiRounded: number; default: not declared — Reference CPI rounded to the Treasury's 5 decimals. - settlementDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#TreeModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Trinomial tree (Hull-White / Black-Karasinski), calibrated to the initial curve // --------------------------------------------------------------------------------------------------- export type TreeModel = 'hull-white' | 'black-karasinski'; ``` ### @insiderfinance/totalfinance/fixed-income#VasicekParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Vasicek // --------------------------------------------------------------------------------------------------- export interface VasicekParameters { /** Mean-reversion speed (> 0). */ a: number; /** Long-run mean level. */ b: number; /** Instantaneous volatility (> 0). */ sigma: number; /** Current short rate. */ r0: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - a: number; default: not declared — Mean-reversion speed (> 0). - b: number; default: not declared — Long-run mean level. - r0: number; default: not declared — Current short rate. - sigma: number; default: not declared — Instantaneous volatility (> 0). ### @insiderfinance/totalfinance/fixed-income#XvaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface XvaParameters { /** Hull-White mean reversion and short-rate volatility. */ meanReversion: number; sigma: number; /** Counterparty survival curve (drives CVA). */ counterpartySurvival: SurvivalCurve; /** Own survival curve (drives DVA); omit to skip DVA. */ ownSurvival?: SurvivalCurve; /** Counterparty recovery (default 0.4). */ recovery?: number; /** Own recovery (default 0.4). */ ownRecovery?: number; /** Funding spread over the risk-free curve for FVA (default 0 ⇒ FVA = 0). */ fundingSpread?: number; /** Seed for the deterministic PRNG. */ seed: number; /** Number of simulated paths (default 5000). */ paths?: number; /** Simulation steps per year (default 24, hard outer maximum 1,000,000; paths×steps cap may be lower). */ stepsPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - counterpartySurvival: SurvivalCurve; default: not declared — Counterparty survival curve (drives CVA). - counterpartySurvival.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - counterpartySurvival.conditionalDefaultProbability(from): string | number; default: not declared - counterpartySurvival.conditionalDefaultProbability(to): string | number; default: not declared - counterpartySurvival.dayCount: FixedIncomeDayCount; default: not declared - counterpartySurvival.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - counterpartySurvival.defaultProbability(from): string | number; default: not declared - counterpartySurvival.defaultProbability(to): string | number; default: not declared - counterpartySurvival.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - counterpartySurvival.hazard(at): string | number; default: not declared - counterpartySurvival.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - counterpartySurvival.referenceDate: string; default: not declared - counterpartySurvival.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - counterpartySurvival.survival(at): string | number; default: not declared - counterpartySurvival.timeTo: (at: string | number) => number; default: not declared - counterpartySurvival.timeTo(at): string | number; default: not declared - fundingSpread?: number; default: not declared — Funding spread over the risk-free curve for FVA (default 0 ⇒ FVA = 0). - meanReversion: number; default: not declared — Hull-White mean reversion and short-rate volatility. - ownRecovery?: number; default: not declared — Own recovery (default 0.4). - ownSurvival?: SurvivalCurve; default: not declared — Own survival curve (drives DVA); omit to skip DVA. - ownSurvival.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - ownSurvival.conditionalDefaultProbability(from): string | number; default: not declared - ownSurvival.conditionalDefaultProbability(to): string | number; default: not declared - ownSurvival.dayCount: FixedIncomeDayCount; default: not declared - ownSurvival.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - ownSurvival.defaultProbability(from): string | number; default: not declared - ownSurvival.defaultProbability(to): string | number; default: not declared - ownSurvival.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - ownSurvival.hazard(at): string | number; default: not declared - ownSurvival.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - ownSurvival.referenceDate: string; default: not declared - ownSurvival.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - ownSurvival.survival(at): string | number; default: not declared - ownSurvival.timeTo: (at: string | number) => number; default: not declared - ownSurvival.timeTo(at): string | number; default: not declared - paths?: number; default: not declared — Number of simulated paths (default 5000). - recovery?: number; default: not declared — Counterparty recovery (default 0.4). - seed: number; default: not declared — Seed for the deterministic PRNG. - sigma: number; default: not declared - stepsPerYear?: number; default: not declared — Simulation steps per year (default 24, hard outer maximum 1,000,000; paths×steps cap may be lower). ### @insiderfinance/totalfinance/fixed-income#XvaResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface XvaResult { cva: number; dva: number; fva: number; /** Bilateral CVA: `cva − dva`. */ bilateralCva: number; /** The exposure profile across the measurement dates. */ exposure: ExposurePoint[]; /** Echoed reproducibility knobs (R2): the seed, paths, and grid resolution actually used. */ assumptions: { conventionsVersion: string; model: 'hull-white'; seed: number; paths: number; stepsPerYear: number; }; /** * Honest computation report (R2). `repricingError` is the worst zero-coupon repricing error of * the simulator (martingale check) — the honesty signal for the whole exposure profile. */ diagnostics: Diagnostics & { repricingError: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; model: 'hull-white'; paths: number; seed: number; stepsPerYear: number; }; default: not declared — Echoed reproducibility knobs (R2): the seed, paths, and grid resolution actually used. - assumptions.conventionsVersion: string; default: not declared - assumptions.model: 'hull-white'; default: not declared - assumptions.paths: number; default: not declared - assumptions.seed: number; default: not declared - assumptions.stepsPerYear: number; default: not declared - bilateralCva: number; default: not declared — Bilateral CVA: `cva − dva`. - cva: number; default: not declared - diagnostics: Diagnostics & { repricingError: number; }; default: not declared — Honest computation report (R2). `repricingError` is the worst zero-coupon repricing error of the simulator (martingale check) — the honesty signal for the whole exposure profile. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.repricingError: number; default: not declared - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dva: number; default: not declared - exposure: ExposurePoint[]; default: not declared — The exposure profile across the measurement dates. - fva: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#XvaSwapSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface XvaSwapSpecification { /** Discount/forecast curve (single-curve); its reference date is the valuation date. */ curve: YieldCurve; startDate: string; maturityDate: string; fixedRate: number; /** `payer` = we pay fixed; `receiver` = we receive fixed. */ optionType: 'payer' | 'receiver'; notional?: number; fixedFrequency?: Frequency; fixedDayCount?: FixedIncomeDayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - curve: YieldCurve; default: not declared — Discount/forecast curve (single-curve); its reference date is the valuation date. - curve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - curve.addSpread(spread): YieldCurve; default: not declared - curve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - curve.bumpPillar(delta): number; default: not declared - curve.bumpPillar(index): number; default: not declared - curve.dayCount: FixedIncomeDayCount; default: not declared - curve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - curve.discount(at): string | number; default: not declared - curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - curve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - curve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - curve.forwardRate(from): string | number; default: not declared - curve.forwardRate(to): string | number; default: not declared - curve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - curve.instantaneousForward(at): string | number; default: not declared - curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - curve.referenceDate: string; default: not declared - curve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - curve.shift(delta): number; default: not declared - curve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - curve.timeTo(at): string | number; default: not declared - curve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - curve.zeroRate(at): string | number; default: not declared - curve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - curve.zeroRate(compounding).periodsPerYear: number; default: not declared - curve.zeroRate(compounding).type: 'periodic'; default: not declared - fixedDayCount?: FixedIncomeDayCount; default: not declared - fixedFrequency?: Frequency; default: not declared - fixedRate: number; default: not declared - maturityDate: string; default: not declared - notional?: number; default: not declared - optionType: 'payer' | 'receiver'; default: not declared — `payer` = we pay fixed; `receiver` = we receive fixed. - startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldCurve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A discount/zero/forward curve. Immutable; shocks return new curves. ```typescript /** A discount/zero/forward curve. Immutable; shocks return new curves. */ export interface YieldCurve { readonly referenceDate: string; readonly dayCount: FixedIncomeDayCount; readonly interpolation: CurveInterpolation; readonly extrapolation: CurveExtrapolation; readonly pillars: readonly CurvePillar[]; /** Year fraction from the reference date to a date (or pass a number through unchanged). */ timeTo(at: string | number): number; /** Discount factor to a date or year fraction. */ discount(at: string | number): number; /** Zero rate to a date or year fraction, in the requested compounding (default continuous). */ zeroRate(at: string | number, compounding?: InterestCompounding): number; /** Simple (money-market) forward rate between two times/dates under `dayCount`. */ forwardRate(from: string | number, to: string | number, dayCount?: FixedIncomeDayCount): number; /** Instantaneous (continuously-compounded) forward rate at a time/date. */ instantaneousForward(at: string | number): number; /** Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). */ shift(delta: number): YieldCurve; /** Bump a single pillar's continuous zero by `delta` (key-rate risk). */ bumpPillar(index: number, delta: number): YieldCurve; /** * Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently * discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's * shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a * sector/rating spread) while keeping curve construction out of leaf entrypoints. */ addSpread(spread: YieldCurve): YieldCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - addSpread(spread): YieldCurve; default: not declared - bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - bumpPillar(delta): number; default: not declared - bumpPillar(index): number; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discount(at): string | number; default: not declared - extrapolation: CurveExtrapolation; default: not declared - forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - forwardRate(from): string | number; default: not declared - forwardRate(to): string | number; default: not declared - instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - instantaneousForward(at): string | number; default: not declared - interpolation: CurveInterpolation; default: not declared - pillars: readonly CurvePillar[]; default: not declared - referenceDate: string; default: not declared - shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - shift(delta): number; default: not declared - timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - timeTo(at): string | number; default: not declared - zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - zeroRate(at): string | number; default: not declared - zeroRate(compounding)?: InterestCompounding | undefined; default: not declared - zeroRate(compounding).periodsPerYear: number; default: not declared - zeroRate(compounding).type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldFromPriceOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface YieldFromPriceOptions { settlementDate: string; /** Either a clean price (default) or a dirty price — set `priceType`. */ price: number; priceType?: 'clean' | 'dirty'; context?: ProjectionContext; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - context?: ProjectionContext; default: not declared - context.forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - context.forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - context.forecastCurve.addSpread(spread): YieldCurve; default: not declared - context.forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - context.forecastCurve.bumpPillar(delta): number; default: not declared - context.forecastCurve.bumpPillar(index): number; default: not declared - context.forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - context.forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - context.forecastCurve.discount(at): string | number; default: not declared - context.forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - context.forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - context.forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - context.forecastCurve.forwardRate(from): string | number; default: not declared - context.forecastCurve.forwardRate(to): string | number; default: not declared - context.forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - context.forecastCurve.instantaneousForward(at): string | number; default: not declared - context.forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - context.forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - context.forecastCurve.referenceDate: string; default: not declared - context.forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - context.forecastCurve.shift(delta): number; default: not declared - context.forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - context.forecastCurve.timeTo(at): string | number; default: not declared - context.forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - context.forecastCurve.zeroRate(at): string | number; default: not declared - context.forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - context.forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - context.forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared - context.knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - context.referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - context.referenceIndex(date): string; default: not declared - price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - priceType?: 'clean' | 'dirty'; default: not declared - settlementDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface YieldMetrics { yield: number; dirtyPrice: number; cleanPrice: number; accruedInterest: number; macaulayDuration: number; modifiedDuration: number; convexity: number; /** Dollar value of a 1bp yield increase (per the bond's face value). */ dv01: number; /** Price value of a 1bp move (synonym for DV01 here, per face). */ pv01: number; assumptions: BondAssumptions; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest: number; default: not declared - assumptions: BondAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: FixedIncomeDayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.frequency: number; default: not declared — Coupon payments per year actually used in discounting. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.settlementDate: string; default: not declared — Settlement date the result was computed as of. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - cleanPrice: number; default: not declared - convexity: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dirtyPrice: number; default: not declared - dv01: number; default: not declared — Dollar value of a 1bp yield increase (per the bond's face value). - macaulayDuration: number; default: not declared - modifiedDuration: number; default: not declared - pv01: number; default: not declared — Price value of a 1bp move (synonym for DV01 here, per face). - yield: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldMetricsOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link yieldMetrics}. ```typescript /** Input for {@link yieldMetrics}. */ export interface YieldMetricsOptions { settlementDate: string; yield: number; context?: ProjectionContext; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - context?: ProjectionContext; default: not declared - context.forecastCurve?: YieldCurve; default: not declared — Forecast curve for projecting floating-rate coupons. - context.forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - context.forecastCurve.addSpread(spread): YieldCurve; default: not declared - context.forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - context.forecastCurve.bumpPillar(delta): number; default: not declared - context.forecastCurve.bumpPillar(index): number; default: not declared - context.forecastCurve.dayCount: FixedIncomeDayCount; default: not declared - context.forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - context.forecastCurve.discount(at): string | number; default: not declared - context.forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - context.forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - context.forecastCurve.forwardRate(dayCount)?: FixedIncomeDayCount | undefined; default: not declared - context.forecastCurve.forwardRate(from): string | number; default: not declared - context.forecastCurve.forwardRate(to): string | number; default: not declared - context.forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - context.forecastCurve.instantaneousForward(at): string | number; default: not declared - context.forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - context.forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - context.forecastCurve.referenceDate: string; default: not declared - context.forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - context.forecastCurve.shift(delta): number; default: not declared - context.forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - context.forecastCurve.timeTo(at): string | number; default: not declared - context.forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - context.forecastCurve.zeroRate(at): string | number; default: not declared - context.forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - context.forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - context.forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared - context.knownFixingRate?: number; default: not declared — The index fixing (decimal, e.g. `0.0532` for 5.32%) that ALREADY SET the coupon currently accruing on a floating-rate note — the one whose accrual period began before the forecast curve's reference date. A settled-mid-period FRN has one coupon that is no longer a projection: it was fixed in the past, on a date the curve does not reach. Asking the curve for it is a query before its reference date, which throws. Supply the observed fixing (SOFR/EURIBOR print for that reset) and it is used verbatim for that one coupon; every later coupon still projects off the curve. The note's quoted `spread` is added on top, exactly as for a projected coupon. Only the in-progress coupon is substituted. Coupons that both began AND ended before the curve's reference date are settled history, not projections — one fixing cannot honestly stand in for a whole strip of past resets, so those are rejected rather than fabricated. - context.referenceIndex?: (date: string) => number; default: not declared — Price-index level at a date, for inflation-linked indexation. - context.referenceIndex(date): string; default: not declared - settlementDate: string; default: not declared - yield: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldShiftGrid Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A parallel-yield-shift grid: either an explicit list of basis-point shifts, or an inclusive `{ from, to, step }` range. The default (`{ from: -200, to: 200, step: 25 }`) resolves to 17 ordered nodes and contains a zero node. ```typescript // --------------------------------------------------------------------------------------------------- // Bond-future CTD switching frontier + delivery-date DV01 (Wave 6) // --------------------------------------------------------------------------------------------------- /** * A parallel-yield-shift grid: either an explicit list of basis-point shifts, or an inclusive * `{ from, to, step }` range. The default (`{ from: -200, to: 200, step: 25 }`) resolves to 17 ordered * nodes and contains a zero node. */ export type YieldShiftGrid = readonly number[] | { from: number; to: number; step: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: number; default: not declared - step: number; default: not declared - to: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldToCallAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link yieldToCall}.explain assumptions: the bond conventions plus the call/price basis echo. ```typescript /** {@link yieldToCall}.explain assumptions: the bond conventions plus the call/price basis echo. */ export type YieldToCallAssumptions = BondAssumptions & { callDate: string; /** Whether `options.price` was read as a clean or dirty price. */ priceType: 'clean' | 'dirty'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - callDate: string; default: not declared - compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - conventionsVersion: string; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - frequency: number; default: not declared — Coupon payments per year actually used in discounting. - model?: string; default: not declared - priceType: 'clean' | 'dirty'; default: not declared — Whether `options.price` was read as a clean or dirty price. - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - settlementDate: string; default: not declared — Settlement date the result was computed as of. - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared ### @insiderfinance/totalfinance/fixed-income#YieldToCallFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type YieldToCallFacade = ((bond: Bond, call: CallFeature, options: YieldFromPriceOptions) => number) & { explain: (bond: Bond, call: CallFeature, options: YieldFromPriceOptions) => Omit, 'assumptions'> & { assumptions: YieldToCallAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bond): Bond; default: not declared - (bond).accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - (bond).businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - (bond).cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - (bond).couponRate: number; default: not declared - (bond).dayCount: FixedIncomeDayCount; default: not declared - (bond).faceValue: number; default: not declared - (bond).frequency: number; default: not declared - (bond).futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - (bond).issueDate: string; default: not declared - (bond).kind: BondKind; default: not declared - (bond).maturityDate: string; default: not declared - (bond).schedule: readonly SchedulePeriod[]; default: not declared - (call): CallFeature; default: not declared - (call).callDate: string; default: not declared — First/earliest call date. - (call).callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. - (options): YieldFromPriceOptions; default: not declared - (options).context?: ProjectionContext; default: not declared - (options).price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - (options).priceType?: 'clean' | 'dirty'; default: not declared - (options).settlementDate: string; default: not declared - explain: (bond: Bond, call: CallFeature, options: YieldFromPriceOptions) => Omit, 'assumptions'> & { assumptions: YieldToCallAssumptions; }; default: not declared - explain().return.assumptions: YieldToCallAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(bond): Bond; default: not declared - explain(bond).accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - explain(bond).businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - explain(bond).cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - explain(bond).couponRate: number; default: not declared - explain(bond).dayCount: FixedIncomeDayCount; default: not declared - explain(bond).faceValue: number; default: not declared - explain(bond).frequency: number; default: not declared - explain(bond).futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - explain(bond).issueDate: string; default: not declared - explain(bond).kind: BondKind; default: not declared - explain(bond).maturityDate: string; default: not declared - explain(bond).schedule: readonly SchedulePeriod[]; default: not declared - explain(call): CallFeature; default: not declared - explain(call).callDate: string; default: not declared — First/earliest call date. - explain(call).callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. - explain(options): YieldFromPriceOptions; default: not declared - explain(options).context?: ProjectionContext; default: not declared - explain(options).price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - explain(options).priceType?: 'clean' | 'dirty'; default: not declared - explain(options).settlementDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#ZeroCouponBondSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ZeroCouponBondSpecification { issueDate: string; maturityDate: string; faceValue?: number; dayCount?: FixedIncomeDayCount; /** Yield compounding frequency for analytics. Default 1 (annual). */ frequency?: Frequency; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount?: FixedIncomeDayCount; default: not declared - faceValue?: number; default: not declared - frequency?: Frequency; default: not declared — Yield compounding frequency for analytics. Default 1 (annual). - issueDate: string; default: not declared - maturityDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#ZeroCouponInflationSwapInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link zeroCouponInflationSwap}. ```typescript // --------------------------------------------------------------------------------------------------- // 4. Zero-coupon inflation swap (ZCIS) // --------------------------------------------------------------------------------------------------- /** Input for {@link zeroCouponInflationSwap}. */ export interface ZeroCouponInflationSwapInput { /** Swap maturity in years (`N`). The single ZCIS cashflow is exchanged at maturity. */ maturityYears: number; /** * The par/market ZCIS rate `K` (the geometric annual breakeven). Supply **this or** * `forwardIndexRatio` — exactly one. */ swapRate?: number; /** * The forward index ratio `I(T)/I(0)`. Supply **this or** `swapRate` — exactly one. Implies * `swapRate = forwardIndexRatio^(1/N) − 1`. */ forwardIndexRatio?: number; /** An existing position's contracted fixed rate `K_c` — supply to value the swap (MTM). */ contractRate?: number; /** Discount factor to maturity for the MTM (default `1` → the undiscounted at-maturity value). */ discountFactor?: number; /** Notional (default `1`). */ notional?: number; /** Which leg the holder **pays** (default `'fixed'` = pay fixed, receive inflation). Signs the MTM. */ payer?: 'fixed' | 'inflation'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contractRate?: number; default: not declared — An existing position's contracted fixed rate `K_c` — supply to value the swap (MTM). - discountFactor?: number; default: not declared — Discount factor to maturity for the MTM (default `1` → the undiscounted at-maturity value). - forwardIndexRatio?: number; default: not declared — The forward index ratio `I(T)/I(0)`. Supply **this or** `swapRate` — exactly one. Implies `swapRate = forwardIndexRatio^(1/N) − 1`. - maturityYears: number; default: not declared — Swap maturity in years (`N`). The single ZCIS cashflow is exchanged at maturity. - notional?: number; default: not declared — Notional (default `1`). - payer?: 'fixed' | 'inflation'; default: not declared — Which leg the holder **pays** (default `'fixed'` = pay fixed, receive inflation). Signs the MTM. - swapRate?: number; default: not declared — The par/market ZCIS rate `K` (the geometric annual breakeven). Supply **this or** `forwardIndexRatio` — exactly one. ### @insiderfinance/totalfinance/fixed-income#ZeroCouponInflationSwapResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The economics of a zero-coupon inflation swap. ```typescript /** The economics of a zero-coupon inflation swap. */ export interface ZeroCouponInflationSwapResult { /** Par ZCIS rate (geometric annual breakeven): `forwardIndexRatio^(1/N) − 1`. */ parRate: number; /** Forward index ratio `I(T)/I(0) = (1 + parRate)^N`. */ forwardIndexRatio: number; /** * The single fixed-leg payoff per unit notional at maturity: `(1 + parRate)^N − 1`. Equals the * expected inflation-leg payoff (they match at par). */ fixedLeg: number; /** * Mark-to-market PV of a position at `contractRate` (present only when `contractRate` is supplied): * `±notional·DF·[(1+parRate)^N − (1+contractRate)^N]`, signed by `payer`. `null` otherwise. */ markToMarket: number | null; assumptions: { conventionsVersion: string; method: 'zero-coupon-inflation-swap'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'zero-coupon-inflation-swap'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'zero-coupon-inflation-swap'; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fixedLeg: number; default: not declared — The single fixed-leg payoff per unit notional at maturity: `(1 + parRate)^N − 1`. Equals the expected inflation-leg payoff (they match at par). - forwardIndexRatio: number; default: not declared — Forward index ratio `I(T)/I(0) = (1 + parRate)^N`. - markToMarket: number | null; default: not declared — Mark-to-market PV of a position at `contractRate` (present only when `contractRate` is supplied): `±notional·DF·[(1+parRate)^N − (1+contractRate)^N]`, signed by `payer`. `null` otherwise. - parRate: number; default: not declared — Par ZCIS rate (geometric annual breakeven): `forwardIndexRatio^(1/N) − 1`. ### @insiderfinance/totalfinance/fixed-income#addMonths Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Add `months` to an ISO date. The day-of-month is clamped to the target month's length; when `endOfMonth` is set the result snaps to the last day of the target month (the convention used when a coupon schedule anchors on a month-end date). ```typescript export declare function addMonths(date: string, months: number, endOfMonth?: boolean): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (date): string; default: not declared - (endOfMonth)?: boolean; default: not declared - (months): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#adjustDate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function adjustDate(date: string, convention?: BusinessDayConvention, calendar?: Calendar): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (calendar)?: Calendar; default: not declared - (calendar).addBusinessDays: (date: string, days: number) => string; default: not declared - (calendar).businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - (calendar).isBusinessDay: (date: string) => boolean; default: not declared - (calendar).isHalfDay: (date: string) => boolean; default: not declared - (calendar).isHoliday: (date: string) => boolean; default: not declared - (calendar).name: string; default: not declared - (calendar).nextBusinessDay: (date: string) => string; default: not declared - (calendar).previousBusinessDay: (date: string) => string; default: not declared - (calendar).session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - (calendar).timezone: string; default: not declared - (calendar).version: string; default: not declared - (convention)?: BusinessDayConvention; default: not declared - (date): string; default: not declared ### @insiderfinance/totalfinance/fixed-income#bermudanSwaption Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a Bermudan swaption on the Hull-White tree. At each exercise date the holder takes `max(continuation, swapValue)`, where the node-level forward swap value uses the Hull-White analytic bond reconstruction `P(tᵢ, T; r_node)`. (Hull-White only — the lognormal Black-Karasinski tree has no analytic node bond.) ```typescript export declare function bermudanSwaption(specification: BermudanSwaptionSpecification): BermudanSwaptionResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (specification): BermudanSwaptionSpecification; default: not declared - (specification).curve: YieldCurve; default: not declared — Discount/forecast curve (single-curve); its reference date is the valuation date. - (specification).exerciseDates: string[]; default: not declared — Dates on which the holder may exercise into the swap (each is a swap start). - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - (specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - (specification).fixedRate: number; default: not declared — Fixed rate of the underlying swap. - (specification).maturityDate: string; default: not declared — Underlying swap maturity. - (specification).meanReversion: number; default: not declared — Mean reversion and short-rate vol. - (specification).notional?: number; default: not declared - (specification).optionType: 'payer' | 'receiver'; default: not declared — `payer` = option to pay fixed; `receiver` = option to receive fixed. - (specification).sigma: number; default: not declared - (specification).stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). - return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; fixedDayCount: FixedIncomeDayCount; fixedFrequency: Frequency; meanReversion: number; model: 'hull-white'; notional: number; settlementDate: string; sigma: number; stepsPerYear: number; }; default: not declared — Applied conventions and model knobs, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.dayCount: 'ACT/365F'; default: not declared - return.assumptions.fixedDayCount: FixedIncomeDayCount; default: not declared - return.assumptions.fixedFrequency: Frequency; default: not declared - return.assumptions.meanReversion: number; default: not declared - return.assumptions.model: 'hull-white'; default: not declared - return.assumptions.notional: number; default: not declared - return.assumptions.settlementDate: string; default: not declared - return.assumptions.sigma: number; default: not declared - return.assumptions.stepsPerYear: number; default: not declared - return.diagnostics: Diagnostics; default: not declared — Honest computation report: the lattice method behind the price (Law 2 report grammar). - return.exerciseDates: string[]; default: not declared — The exercise schedule actually used, sorted ascending from the valuation date. - return.price: number; default: not declared — Option value, scaled by `notional`. ### @insiderfinance/totalfinance/fixed-income#bondFuture Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bond-future basis, carry, implied repo rate, and cheapest-to-deliver across a basket. See `docs/specs/bond-future-ctd.md`. ```typescript export declare function bondFuture(input: BondFutureInput): BondFutureResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BondFutureInput; default: not declared - (input).deliverables: DeliverableBond[]; default: not declared - (input).deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - (input).futuresPrice: number; default: not declared — Futures price per 100 face. - (input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - (input).repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - (input).settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - return.assumptions: { conventionsVersion: string; deliveryDate: string; futuresPrice: number; notionalCoupon: number; repoRate: number; settlementDate: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.deliveryDate: string; default: not declared - return.assumptions.futuresPrice: number; default: not declared - return.assumptions.notionalCoupon: number; default: not declared - return.assumptions.repoRate: number; default: not declared - return.assumptions.settlementDate: string; default: not declared - return.cheapestToDeliver: DeliverableAnalysis; default: not declared — The cheapest-to-deliver (max implied repo rate). - return.deliverables: DeliverableAnalysis[]; default: not declared — Per-deliverable rows, sorted by implied repo rate descending (CTD first). - return.diagnostics: Diagnostics; default: not declared - return.summary: string; default: not declared - return.yearsToDelivery: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#bondFutureCtdFrontier Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The cheapest-to-deliver *frontier*: how the CTD identity and the futures risk move under explicit parallel-yield (and optional futures-price) scenarios. This is a **switching frontier**, not a valuation of the short's timing/quality delivery option (which stays deferred). It composes {@link bondFuture} at every node (one source of basis/carry/implied-repo truth), reprices each deliverable with {@link priceFromYield}, refines held-constant switch brackets by re-evaluating the *whole* basket (so a narrow third-deliverable window splits into two honest transitions and no pairwise root off the global frontier is accepted), and reports the delivery-date futures DV01 from the CTD's futures-implied forward yield — distinct from the spot cash DV01 / CF. See `docs/specs/wave6-quant-moats.md` §1 and `docs/specs/bond-future-ctd.md`. ```typescript export declare function bondFutureCtdFrontier(input: BondFutureCtdFrontierInput): BondFutureCtdFrontierResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BondFutureCtdFrontierInput; default: not declared - (input).deliverables: DeliverableBond[]; default: not declared - (input).deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - (input).futuresPrice: number; default: not declared — Futures price per 100 face. - (input).futuresPrices?: readonly number[]; default: not declared — Optional futures-price path, one entry per *explicit* shift (the `(shift, price)` pairs are sorted together). Omit to hold the input futures quote constant across the scan (a ceteris-paribus basis question). A discrete path does not define values between nodes, so its switches stay grid-labeled. - (input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - (input).refineSwitches?: boolean; default: not declared — Refine held-constant-policy switch brackets to a crossing; default `true`. Invalid with `futuresPrices`. - (input).repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - (input).settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - (input).switchLocationToleranceBp?: number; default: not declared — Maximum reported switch-location bracket width in shift basis points; default `0.01`. - (input).yieldShiftsBp?: YieldShiftGrid; default: not declared — Parallel yield shifts (bp) to scan. Default `{ from: -200, to: 200, step: 25 }` (17 nodes incl. 0). - return.assumptions: { conventionsVersion: string; deliveryDate: string; futuresPriceScenario: 'held-constant' | 'supplied-path'; refineSwitches: boolean; repoRateTieTolerance: 1e-10; settlementDate: string; switchLocationToleranceBp: number | null; yieldShiftsBp: number[]; yieldShock: 'parallel'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.deliveryDate: string; default: not declared - return.assumptions.futuresPriceScenario: 'held-constant' | 'supplied-path'; default: not declared - return.assumptions.refineSwitches: boolean; default: not declared - return.assumptions.repoRateTieTolerance: 1e-10; default: not declared — Internal global-tie test, decimal annualized implied-repo rate; a fixed library assumption. - return.assumptions.settlementDate: string; default: not declared - return.assumptions.switchLocationToleranceBp: number | null; default: not declared - return.assumptions.yieldShiftsBp: number[]; default: not declared - return.assumptions.yieldShock: 'parallel'; default: not declared - return.current: { conversionFactor: number; ctdId: string; ctdYield: number; }; default: not declared — The current (unshifted) cheapest-to-deliver. - return.current.conversionFactor: number; default: not declared - return.current.ctdId: string; default: not declared - return.current.ctdYield: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.risk: { deliveryDateFuturesDv01: number; impliedForwardYield: number; spotFuturesDv01: number; }; default: not declared - return.risk.deliveryDateFuturesDv01: number; default: not declared — The futures DV01 from the CTD's *forward* DV01 at the delivery date / CF — the delivery risk. - return.risk.impliedForwardYield: number; default: not declared — The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. - return.risk.spotFuturesDv01: number; default: not declared — The current futures DV01 from the spot cash DV01 / CF (matches {@link bondFutureHedge}). - return.scenarios: CtdFrontierScenario[]; default: not declared — Every scanned node, ordered by ascending yield shift. - return.switches: CtdSwitch[]; default: not declared — Every CTD switch across the scan (a third-deliverable window splits into two transitions). ### @insiderfinance/totalfinance/fixed-income#bondFutureHedge Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bond-future DV01 hedge ratio and futures-implied yield. Composes {@link bondFuture} (to find the CTD and the conversion factors) with the bond yield/DV01 analytics: the futures DV01 is the CTD's DV01 divided by its conversion factor (Hull), so a `hedgeDv01` of risk is offset by `hedgeDv01 / futuresDv01` contracts — exactly `CF` to hedge the CTD itself. Also reports the CTD yield implied by the forward clean price `F·CF`. See `docs/specs/bond-future-hedge.md`. ```typescript export declare function bondFutureHedge(input: BondFutureHedgeInput): BondFutureHedgeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BondFutureHedgeInput; default: not declared - (input).deliverables: DeliverableBond[]; default: not declared - (input).deliveryDate: string; default: not declared — Delivery date — when the short delivers into the future (ISO). - (input).futuresPrice: number; default: not declared — Futures price per 100 face. - (input).hedgeDv01?: number; default: not declared — DV01 (per 100 face) of the position to hedge; when given, the result reports `hedgeRatio`. - (input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06`. - (input).repoRate: number; default: not declared — ACT/360 financing (repo) rate (decimal) used for carry / net basis. - (input).settlementDate: string; default: not declared — Settlement date — when the cash bond is bought (ISO). - return.assumptions: { conventionsVersion: string; deliveryDate: string; futuresPrice: number; settlementDate: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.deliveryDate: string; default: not declared - return.assumptions.futuresPrice: number; default: not declared - return.assumptions.settlementDate: string; default: not declared - return.ctdConversionFactor: number; default: not declared - return.ctdDv01: number; default: not declared — DV01 of the CTD cash bond per 100 face (at its market yield). - return.ctdId: string; default: not declared - return.ctdYield: number; default: not declared — Spot yield of the CTD at its market clean price. - return.deliverables: DeliverableRisk[]; default: not declared — Per-deliverable spot yield + DV01 across the basket (CTD first). - return.diagnostics: Diagnostics; default: not declared - return.futuresDv01: number; default: not declared — The futures contract's DV01 per 100 face of notional (`ctdDv01 / CF_ctd`). - return.hedgeRatio?: number; default: not declared — # futures (per 100 face) whose DV01 offsets `hedgeDv01` — SELL them to hedge a long book. Present iff `hedgeDv01` was supplied. - return.impliedForwardYield: number; default: not declared — The CTD yield the futures price implies at the forward clean price `F·CF`, as of delivery. ### @insiderfinance/totalfinance/fixed-income#bonds Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bond constructors (spec §14.1). ```typescript export declare const bonds: { amortizing: (specification: AmortizingBondSpecification) => Bond; fixedRate: (specification: FixedRateBondSpecification) => Bond; floatingRateNote: (specification: FloatingRateNoteSpecification) => Bond; inflationLinked: (specification: InflationLinkedBondSpecification) => Bond; zeroCoupon: (specification: ZeroCouponBondSpecification) => Bond; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amortizing: (specification: AmortizingBondSpecification) => Bond; default: not declared - amortizing().return.accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - amortizing().return.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - amortizing().return.cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - amortizing().return.couponRate: number; default: not declared - amortizing().return.dayCount: FixedIncomeDayCount; default: not declared - amortizing().return.faceValue: number; default: not declared - amortizing().return.frequency: number; default: not declared - amortizing().return.futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - amortizing().return.issueDate: string; default: not declared - amortizing().return.kind: BondKind; default: not declared - amortizing().return.maturityDate: string; default: not declared - amortizing().return.schedule: readonly SchedulePeriod[]; default: not declared - amortizing(specification): AmortizingBondSpecification; default: not declared - amortizing(specification).amortization: Amortization; default: not declared - amortizing(specification).convention?: BusinessDayConvention; default: not declared - amortizing(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - amortizing(specification).dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - amortizing(specification).endOfMonth?: boolean; default: not declared - amortizing(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - amortizing(specification).frequency: Frequency; default: not declared - amortizing(specification).issueDate: string; default: not declared — Dated date / first accrual date. - amortizing(specification).maturityDate: string; default: not declared - fixedRate: (specification: FixedRateBondSpecification) => Bond; default: not declared - fixedRate().return.accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - fixedRate().return.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - fixedRate().return.cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - fixedRate().return.couponRate: number; default: not declared - fixedRate().return.dayCount: FixedIncomeDayCount; default: not declared - fixedRate().return.faceValue: number; default: not declared - fixedRate().return.frequency: number; default: not declared - fixedRate().return.futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - fixedRate().return.issueDate: string; default: not declared - fixedRate().return.kind: BondKind; default: not declared - fixedRate().return.maturityDate: string; default: not declared - fixedRate().return.schedule: readonly SchedulePeriod[]; default: not declared - fixedRate(specification): BaseSpecification; default: not declared - fixedRate(specification).convention?: BusinessDayConvention; default: not declared - fixedRate(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - fixedRate(specification).dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - fixedRate(specification).endOfMonth?: boolean; default: not declared - fixedRate(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - fixedRate(specification).frequency: Frequency; default: not declared - fixedRate(specification).issueDate: string; default: not declared — Dated date / first accrual date. - fixedRate(specification).maturityDate: string; default: not declared - floatingRateNote: (specification: FloatingRateNoteSpecification) => Bond; default: not declared - floatingRateNote().return.accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - floatingRateNote().return.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - floatingRateNote().return.cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - floatingRateNote().return.couponRate: number; default: not declared - floatingRateNote().return.dayCount: FixedIncomeDayCount; default: not declared - floatingRateNote().return.faceValue: number; default: not declared - floatingRateNote().return.frequency: number; default: not declared - floatingRateNote().return.futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - floatingRateNote().return.issueDate: string; default: not declared - floatingRateNote().return.kind: BondKind; default: not declared - floatingRateNote().return.maturityDate: string; default: not declared - floatingRateNote().return.schedule: readonly SchedulePeriod[]; default: not declared - floatingRateNote(specification): FloatingRateNoteSpecification; default: not declared - floatingRateNote(specification).convention?: BusinessDayConvention; default: not declared - floatingRateNote(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - floatingRateNote(specification).dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - floatingRateNote(specification).endOfMonth?: boolean; default: not declared - floatingRateNote(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - floatingRateNote(specification).frequency: Frequency; default: not declared - floatingRateNote(specification).issueDate: string; default: not declared — Dated date / first accrual date. - floatingRateNote(specification).maturityDate: string; default: not declared - floatingRateNote(specification).spread?: number; default: not declared — Quoted margin over the projected index (decimal), e.g. 0.0025 = 25bp. Default 0. - inflationLinked: (specification: InflationLinkedBondSpecification) => Bond; default: not declared - inflationLinked().return.accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - inflationLinked().return.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - inflationLinked().return.cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - inflationLinked().return.couponRate: number; default: not declared - inflationLinked().return.dayCount: FixedIncomeDayCount; default: not declared - inflationLinked().return.faceValue: number; default: not declared - inflationLinked().return.frequency: number; default: not declared - inflationLinked().return.futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - inflationLinked().return.issueDate: string; default: not declared - inflationLinked().return.kind: BondKind; default: not declared - inflationLinked().return.maturityDate: string; default: not declared - inflationLinked().return.schedule: readonly SchedulePeriod[]; default: not declared - inflationLinked(specification): InflationLinkedBondSpecification; default: not declared - inflationLinked(specification).baseIndex: number; default: not declared — Reference index level at issuance (the indexation base). - inflationLinked(specification).convention?: BusinessDayConvention; default: not declared - inflationLinked(specification).couponRate: number; default: not declared — Annualized coupon rate (decimal). - inflationLinked(specification).dayCount?: FixedIncomeDayCount; default: not declared — Accrual day count. Default `30/360`. - inflationLinked(specification).deflationFloor?: boolean; default: not declared — Floor the redeemed principal at par against deflation (TIPS-style). Default false. - inflationLinked(specification).endOfMonth?: boolean; default: not declared - inflationLinked(specification).faceValue?: number; default: not declared — Redemption / par value. Default 100. - inflationLinked(specification).frequency: Frequency; default: not declared - inflationLinked(specification).issueDate: string; default: not declared — Dated date / first accrual date. - inflationLinked(specification).maturityDate: string; default: not declared - zeroCoupon: (specification: ZeroCouponBondSpecification) => Bond; default: not declared - zeroCoupon().return.accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - zeroCoupon().return.businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - zeroCoupon().return.cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - zeroCoupon().return.couponRate: number; default: not declared - zeroCoupon().return.dayCount: FixedIncomeDayCount; default: not declared - zeroCoupon().return.faceValue: number; default: not declared - zeroCoupon().return.frequency: number; default: not declared - zeroCoupon().return.futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - zeroCoupon().return.issueDate: string; default: not declared - zeroCoupon().return.kind: BondKind; default: not declared - zeroCoupon().return.maturityDate: string; default: not declared - zeroCoupon().return.schedule: readonly SchedulePeriod[]; default: not declared - zeroCoupon(specification): ZeroCouponBondSpecification; default: not declared - zeroCoupon(specification).dayCount?: FixedIncomeDayCount; default: not declared - zeroCoupon(specification).faceValue?: number; default: not declared - zeroCoupon(specification).frequency?: Frequency; default: not declared — Yield compounding frequency for analytics. Default 1 (annual). - zeroCoupon(specification).issueDate: string; default: not declared - zeroCoupon(specification).maturityDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#bootstrapHazardFromCds Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bootstrap a survival curve from a CDS par-spread term structure. Hazard is piecewise-constant between quote maturities; each segment is solved so the CDS to that tenor prices to par. ```typescript export declare function bootstrapHazardFromCds(quotes: CdsQuote[], options: HazardBootstrapOptions): SurvivalCurve; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): HazardBootstrapOptions; default: not declared - (options).accrualOnDefault?: boolean; default: not declared - (options).dayCount?: FixedIncomeDayCount; default: not declared - (options).discountCurve: YieldCurve; default: not declared - (options).frequency?: Frequency; default: not declared - (options).protectionSteps?: number; default: not declared - (options).recovery?: number; default: not declared - (options).referenceDate: string; default: not declared - (quotes): CdsQuote[]; default: not declared - return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - return.dayCount: FixedIncomeDayCount; default: not declared - return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - return.pillars: readonly SurvivalPillar[]; default: not declared - return.referenceDate: string; default: not declared - return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - return.timeTo: (at: string | number) => number; default: not declared ### @insiderfinance/totalfinance/fixed-income#breakevenInflation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The breakeven inflation rate implied by a nominal and a real (TIPS) yield — arithmetic and exact Fisher-compounded — with the standard premium decomposition. See `docs/specs/inflation.md`. ```typescript export declare function breakevenInflation(input: BreakevenInflationInput): BreakevenInflationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BreakevenInflationInput; default: not declared - (input).inflationRiskPremium?: number; default: not declared — Inflation risk premium (decimal); lifts the breakeven above expected inflation. - (input).liquidityPremium?: number; default: not declared — TIPS liquidity premium (decimal); illiquidity depresses the real yield, lifting the breakeven. - (input).nominalYield: number; default: not declared — Nominal bond yield (decimal, annualized). - (input).realYield: number; default: not declared — Real (TIPS) yield (decimal, annualized). - return.assumptions: { conventionsVersion: string; method: 'fisher'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'fisher'; default: not declared - return.breakeven: number; default: not declared — Arithmetic breakeven: `nominalYield − realYield` (the quoted number). - return.breakevenCompounded: number; default: not declared — Exact Fisher-compounded breakeven: `(1+nominal)/(1+real) − 1`. - return.diagnostics: Diagnostics; default: not declared - return.expectedInflation: number | null; default: not declared — `breakeven − inflationRiskPremium + liquidityPremium`, or `null` when no premia are supplied. - return.nominalYield: number; default: not declared - return.realYield: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#callableBond Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a callable and/or putable bond on a short-rate tree, with option value, effective duration, and OAS. ```typescript export declare function callableBond(specification: CallableBondSpecification): CallableBondResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (specification): CallableBondSpecification; default: not declared - (specification).bond: Bond; default: not declared - (specification).calls?: BondOption[]; default: not declared — Issuer call schedule (caps the bond's value at each strike). - (specification).curve: YieldCurve; default: not declared — Calibration/discount curve (its reference date is the valuation date). - (specification).marketPrice?: number; default: not declared — Market dirty price; when given, the result includes the option-adjusted spread. - (specification).meanReversion: number; default: not declared — Mean reversion and short-rate volatility for the tree model. - (specification).model?: TreeModel; default: not declared — Tree model (default `hull-white`). - (specification).puts?: BondOption[]; default: not declared — Holder put schedule (floors the bond's value at each strike). - (specification).sigma: number; default: not declared - (specification).stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). - return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; meanReversion: number; model: TreeModel; settlementDate: string; sigma: number; stepsPerYear: number; }; default: not declared — Applied conventions and model knobs, echoed (R2). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.dayCount: 'ACT/365F'; default: not declared - return.assumptions.meanReversion: number; default: not declared - return.assumptions.model: TreeModel; default: not declared - return.assumptions.settlementDate: string; default: not declared - return.assumptions.sigma: number; default: not declared - return.assumptions.stepsPerYear: number; default: not declared - return.diagnostics: Diagnostics; default: not declared — Honest computation report: the lattice method, and the OAS root-find when one ran (R2). - return.effectiveDuration: number; default: not declared — Effective duration from a ±1bp parallel curve shock (re-trees each side). - return.oas?: number; default: not declared — Option-adjusted spread (parallel curve shift repricing the model to `marketPrice`); present only when `marketPrice` is supplied. - return.optionValue: number; default: not declared — Value of the embedded option(s): `straightPrice − price` (positive for a callable). - return.price: number; default: not declared — Model dirty price including the embedded option(s). - return.straightPrice: number; default: not declared — Model dirty price of the otherwise-identical straight bond (no embedded options). ### @insiderfinance/totalfinance/fixed-income#capFloorPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a cap or floor as a strip of Black/Bachelier caplets/floorlets off discount/forecast curves. ```typescript export declare function capFloorPrice(specification: CapFloorSpecification, curves: SwapCurves): CapFloorResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): CapFloorSpecification; default: not declared - (specification).dayCount?: FixedIncomeDayCount; default: not declared — Day count for accrual and forward projection (default `ACT/360`). - (specification).frequency?: Frequency; default: not declared — Reset/payment frequency (default quarterly). - (specification).maturityDate: string; default: not declared - (specification).model?: RatesVolatilityModel; default: not declared - (specification).notional?: number; default: not declared - (specification).startDate: string; default: not declared - (specification).strike: number; default: not declared - (specification).type: 'floor' | 'cap'; default: not declared - (specification).volatility: number; default: not declared — Flat volatility applied to every caplet/floorlet (lognormal for `black`, normal for `bachelier`). - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.caplets: CapletResult[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.price: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#cdsBasis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CDS–bond basis: `cdsParSpread − bondImpliedSpread`, both DECIMAL annualized spreads (H01, ratified plain). **Positive = the CDS is rich relative to the bond** (protection costs more than the bond's credit spread pays); negative = the bond is cheap to the CDS. ```typescript export declare function cdsBasis(input: CdsBasisInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CdsBasisInput; default: not declared - (input).bondImpliedSpread: number; default: not declared - (input).cdsParSpread: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#cdsParSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cdsParSpread: CdsParSpreadFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): CdsCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).survivalCurve: SurvivalCurve; default: not declared - (specification): ParCdsSpecification; default: not declared - (specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - (specification).dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - (specification).effectiveDate: string; default: not declared - (specification).frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - (specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - explain: (specification: ParCdsSpecification, curves: CdsCurves) => Omit, 'assumptions'> & { assumptions: CdsParSpreadAssumptions; }; default: not declared - explain().return.assumptions: CdsParSpreadAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(curves): CdsCurves; default: not declared - explain(curves).discountCurve: YieldCurve; default: not declared - explain(curves).survivalCurve: SurvivalCurve; default: not declared - explain(specification): ParCdsSpecification; default: not declared - explain(specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - explain(specification).dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - explain(specification).effectiveDate: string; default: not declared - explain(specification).frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - explain(specification).maturityDate: string; default: not declared - explain(specification).notional?: number; default: not declared - explain(specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - explain(specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. ### @insiderfinance/totalfinance/fixed-income#cdsValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Value a CDS off discount and survival curves (PV to the protection buyer). ```typescript export declare function cdsValue(specification: CdsSpecification, curves: CdsCurves): CdsValuation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): CdsCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).survivalCurve: SurvivalCurve; default: not declared - (specification): CdsSpecification; default: not declared - (specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - (specification).dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - (specification).effectiveDate: string; default: not declared - (specification).frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - (specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - (specification).spread: number; default: not declared — Running premium (coupon) rate, e.g. 0.01 = 100 bp. - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.parSpread: number; default: not declared - return.premiumLeg: number; default: not declared - return.protectionLeg: number; default: not declared - return.riskyAnnuity: number; default: not declared — Risky annuity / PV01 basis: Σ τᵢ·DF·Q (+ accrual-on-default), per unit spread × notional. - return.upfront: number; default: not declared — Upfront value as a fraction of notional (protection-buyer sign). - return.value: number; default: not declared — PV to the protection buyer (pays premium, receives default protection). ### @insiderfinance/totalfinance/fixed-income#cir Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Construct a CIR model `dr = a(b − r)dt + σ√r dW` (affine, non-negative rates). The Feller condition `2ab ≥ σ²` is what keeps the short rate strictly positive. Parameters that violate it are perfectly ACCEPTABLE — CIR fits to real curves routinely land there, and the affine bond price stays valid — but the model then puts mass at r = 0, which changes what the output means. Violation is therefore disclosed (`model.feller_condition_violated`), never thrown and never silently absorbed. ```typescript export declare function cir(parameters: CirParameters): CirModel; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): CirParameters; default: not declared - (parameters).a: number; default: not declared - (parameters).b: number; default: not declared - (parameters).r0: number; default: not declared - (parameters).sigma: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings about the calibration (currently: the Feller condition). Always present. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - return.shortRateMoments: (years: number) => ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - return.zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. ### @insiderfinance/totalfinance/fixed-income#cmsConvexityAdjustment Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The standard CMS convexity adjustment (Hull): valuing the swap-rate payoff with the bond function `G(y) = Σ cᵢ·(1 + y/m)^(−i)` of a par bond paying the swap's fixed cash flows gives `Δ = −½·y₀²·σ²·T·G''(y₀)/G'(y₀)` (positive, since `G' < 0` and `G'' > 0`). Returns a Law-2 envelope: the adjustment in `value` plus the applied conventions and a warnings channel. ```typescript export declare function cmsConvexityAdjustment(specification: CmsConvexityInput): CmsConvexityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (specification): CmsConvexityInput; default: not declared - (specification).expiry: number; default: not declared — Time to the CMS observation, in years. - (specification).forwardSwapRate: number; default: not declared — Plain forward swap rate `y₀` of the underlying swap. - (specification).paymentsPerYear: number; default: not declared — Fixed-leg payments per year `m` (drives the bond function G(y)). - (specification).swapTenorYears: number; default: not declared — Underlying swap tenor in whole years. - (specification).volatility: number; default: not declared — Lognormal volatility of the underlying swap rate. - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.value: number; default: not declared — The additive adjustment Δ (rate units): expected CMS rate minus the plain forward swap rate. ### @insiderfinance/totalfinance/fixed-income#compareDates Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare two ISO dates: negative if `a < b`, 0 if equal, positive if `a > b`. ```typescript export declare function compareDates(first: string, second: string): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): string; default: not declared - (second): string; default: not declared ### @insiderfinance/totalfinance/fixed-income#conversionFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The CME/CBOT conversion factor for a deliverable bond: the price per $1 face that would make it yield the contract's notional coupon (default 6%) on the first day of the delivery month, with the time to maturity rounded down to whole quarters. Assumes semiannual coupons (Treasury/Gilt convention). See `docs/specs/bond-future-ctd.md`. ```typescript export declare function conversionFactor(input: ConversionFactorInput): ConversionFactorResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ConversionFactorInput; default: not declared - (input).bond: Bond; default: not declared — The deliverable bond — its (semiannual) coupon and maturity drive the factor. - (input).deliveryDate: string; default: not declared — The conversion factor is computed as of the first day of THIS date's month. - (input).notionalCoupon?: number; default: not declared — The contract's notional coupon (decimal); default `0.06` (CME Treasury futures). - return.assumptions: { conventionsVersion: string; couponFrequency: 'semiannual'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.couponFrequency: 'semiannual'; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.extraMonths: number; default: not declared — Residual months after rounding, `z ∈ {0, 3, 6, 9}`. - return.factor: number; default: not declared — Price per $1 face that makes the bond yield the notional coupon on the first delivery day. - return.notionalCoupon: number; default: not declared - return.wholeYears: number; default: not declared — Whole years to maturity after rounding down to a quarter (`n`). ### @insiderfinance/totalfinance/fixed-income#convertibleBond Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a convertible bond on an equity lattice with reduced-form credit (spec §14.1). ```typescript export declare function convertibleBond(specification: ConvertibleBondSpecification): ConvertibleBondResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (specification): ConvertibleBondSpecification; default: not declared - (specification).calls?: ConvertibleBondOption[]; default: not declared — Issuer call schedule. - (specification).conversionRatio: number; default: not declared — Shares received per bond on conversion. - (specification).couponRate: number; default: not declared — Annualized coupon rate (0 for a zero-coupon convertible). - (specification).dayCount?: FixedIncomeDayCount; default: not declared — Coupon accrual day count (default `30/360`). - (specification).dividendYield?: number; default: not declared — Continuous dividend yield on the share (default 0). - (specification).faceValue?: number; default: not declared - (specification).frequency: Frequency; default: not declared - (specification).hazardRate?: number; default: not declared — Flat hazard rate alternative to `survival`. - (specification).issueDate: string; default: not declared - (specification).maturityDate: string; default: not declared - (specification).puts?: ConvertibleBondOption[]; default: not declared — Holder put schedule. - (specification).recovery?: number; default: not declared — Recovery on default, as a fraction of face (default 0.4). - (specification).riskFreeRate: number; default: not declared — Flat continuously-compounded risk-free rate used for lattice discounting. - (specification).settlementDate?: string; default: not declared — Valuation date (default = issue date). - (specification).spot: number; default: not declared — Current share price. - (specification).stepsPerYear?: number; default: not declared — Lattice steps per year (default 200, hard outer maximum 1,000,000; tree cap may be lower). - (specification).survival?: SurvivalCurve; default: not declared — Term-structured hazard (credit) — provide this or `hazardRate`. - (specification).volatility: number; default: not declared — Equity volatility. - return.assumptions: { conventionsVersion: string; creditModel: 'survivalCurve' | 'flatHazard' | 'none'; model: 'equity-lattice+reduced-form-credit'; recovery: number; stepsPerYear: number; }; default: not declared — Applied conventions and model knobs, echoed (R2). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.creditModel: 'none' | 'survivalCurve' | 'flatHazard'; default: not declared - return.assumptions.model: 'equity-lattice+reduced-form-credit'; default: not declared - return.assumptions.recovery: number; default: not declared - return.assumptions.stepsPerYear: number; default: not declared - return.bondFloor: number; default: not declared — Value of the otherwise-identical risky bond with conversion disabled (the bond floor). - return.conversionValue: number; default: not declared — Current conversion (parity) value `conversionRatio · spot`. - return.diagnostics: Diagnostics; default: not declared — Honest computation report (R2). - return.optionValue: number; default: not declared — Embedded equity-option value: `price − bondFloor`. - return.price: number; default: not declared — Convertible value. ### @insiderfinance/totalfinance/fixed-income#cpiSeasonality Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extract 12 multiplicative CPI seasonal factors from an NSA history via the classic ratio-to-centered- 2×12-moving-average, normalized to average 1. See `docs/specs/inflation.md`. ```typescript export declare function cpiSeasonality(input: CpiSeasonalityInput): CpiSeasonalityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CpiSeasonalityInput; default: not declared - (input).series: { month: string; level: number; }[]; default: not declared — NSA CPI history: `{ month: 'YYYY-MM', level }`; ≥ 24 contiguous months (order-independent). - return.assumptions: { conventionsVersion: string; method: 'ratio-to-2x12-moving-average'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'ratio-to-2x12-moving-average'; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.factors: number[]; default: not declared — 12 multiplicative factors, index 0 = January … 11 = December; they average to 1. - return.monthsUsed: number; default: not declared — Number of month observations that fed the estimate (ratios computed). - return.peakMonth: number; default: not declared — Calendar month (1-12) with the largest factor. - return.troughMonth: number; default: not declared — Calendar month (1-12) with the smallest factor. - return.yearsSpanned: number; default: not declared — Calendar years the history spans. ### @insiderfinance/totalfinance/fixed-income#credit Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Survival-curve constructors and credit analytics (spec §14.4). ```typescript export declare const credit: { bootstrapHazardFromCds: (quotes: CdsQuote[], options: HazardBootstrapOptions) => SurvivalCurve; cdsBasis: (input: CdsBasisInput) => number; creditSpreadCurve: CreditSpreadCurveFacade; creditTriangleHazard: (input: CreditTriangleHazardInput) => CreditTriangleHazardResult; flatHazard: (input: FlatHazardInput) => SurvivalCurve; survivalFromHazards: (points: ReadonlyArray, options?: SurvivalCurveOptions) => SurvivalCurve; survivalFromProbabilities: (points: ReadonlyArray, options?: SurvivalCurveOptions) => SurvivalCurve; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bootstrapHazardFromCds: (quotes: CdsQuote[], options: HazardBootstrapOptions) => SurvivalCurve; default: not declared - bootstrapHazardFromCds().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - bootstrapHazardFromCds().return.dayCount: FixedIncomeDayCount; default: not declared - bootstrapHazardFromCds().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - bootstrapHazardFromCds().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - bootstrapHazardFromCds().return.pillars: readonly SurvivalPillar[]; default: not declared - bootstrapHazardFromCds().return.referenceDate: string; default: not declared - bootstrapHazardFromCds().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - bootstrapHazardFromCds().return.timeTo: (at: string | number) => number; default: not declared - bootstrapHazardFromCds(options): HazardBootstrapOptions; default: not declared - bootstrapHazardFromCds(options).accrualOnDefault?: boolean; default: not declared - bootstrapHazardFromCds(options).dayCount?: FixedIncomeDayCount; default: not declared - bootstrapHazardFromCds(options).discountCurve: YieldCurve; default: not declared - bootstrapHazardFromCds(options).frequency?: Frequency; default: not declared - bootstrapHazardFromCds(options).protectionSteps?: number; default: not declared - bootstrapHazardFromCds(options).recovery?: number; default: not declared - bootstrapHazardFromCds(options).referenceDate: string; default: not declared - bootstrapHazardFromCds(quotes): CdsQuote[]; default: not declared - cdsBasis: (input: CdsBasisInput) => number; default: not declared - cdsBasis(input): CdsBasisInput; default: not declared - cdsBasis(input).bondImpliedSpread: number; default: not declared - cdsBasis(input).cdsParSpread: number; default: not declared - creditSpreadCurve: CreditSpreadCurveFacade; default: not declared - creditSpreadCurve(options): HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }; default: not declared - creditSpreadCurve(options).accrualOnDefault?: boolean; default: not declared - creditSpreadCurve(options).dayCount?: FixedIncomeDayCount; default: not declared - creditSpreadCurve(options).discountCurve: YieldCurve; default: not declared - creditSpreadCurve(options).frequency?: Frequency; default: not declared - creditSpreadCurve(options).protectionSteps?: number; default: not declared - creditSpreadCurve(options).recovery?: number; default: not declared - creditSpreadCurve(options).referenceDate: string; default: not declared - creditSpreadCurve(options).survivalCurve: SurvivalCurve; default: not declared - creditSpreadCurve(tenors): string[]; default: not declared - creditSpreadCurve.explain: (tenors: string[], options: HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }) => Omit, 'assumptions'> & { assumptions: CreditSpreadCurveAssumptions; }; default: not declared - creditSpreadCurve.explain().return.assumptions: CreditSpreadCurveAssumptions; default: not declared - creditSpreadCurve.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - creditSpreadCurve.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - creditSpreadCurve.explain().return.value: CreditSpreadPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - creditSpreadCurve.explain(options): HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }; default: not declared - creditSpreadCurve.explain(options).accrualOnDefault?: boolean; default: not declared - creditSpreadCurve.explain(options).dayCount?: FixedIncomeDayCount; default: not declared - creditSpreadCurve.explain(options).discountCurve: YieldCurve; default: not declared - creditSpreadCurve.explain(options).frequency?: Frequency; default: not declared - creditSpreadCurve.explain(options).protectionSteps?: number; default: not declared - creditSpreadCurve.explain(options).recovery?: number; default: not declared - creditSpreadCurve.explain(options).referenceDate: string; default: not declared - creditSpreadCurve.explain(options).survivalCurve: SurvivalCurve; default: not declared - creditSpreadCurve.explain(tenors): string[]; default: not declared - creditTriangleHazard: (input: CreditTriangleHazardInput) => CreditTriangleHazardResult; default: not declared - creditTriangleHazard().return.assumptions: { approximation: 'continuous-premium credit triangle'; conventionsVersion: string; recovery: number; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - creditTriangleHazard().return.assumptions.approximation: 'continuous-premium credit triangle'; default: not declared - creditTriangleHazard().return.assumptions.conventionsVersion: string; default: not declared - creditTriangleHazard().return.assumptions.recovery: number; default: not declared - creditTriangleHazard().return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - creditTriangleHazard().return.diagnostics.warnings: QuantWarning[]; default: not declared - creditTriangleHazard().return.value: number; default: not declared — Implied flat hazard rate λ (per year). - creditTriangleHazard(input): CreditTriangleHazardInput; default: not declared - creditTriangleHazard(input).recovery?: number; default: not declared - creditTriangleHazard(input).spread: number; default: not declared - flatHazard: (input: FlatHazardInput) => SurvivalCurve; default: not declared - flatHazard().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - flatHazard().return.dayCount: FixedIncomeDayCount; default: not declared - flatHazard().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - flatHazard().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - flatHazard().return.pillars: readonly SurvivalPillar[]; default: not declared - flatHazard().return.referenceDate: string; default: not declared - flatHazard().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - flatHazard().return.timeTo: (at: string | number) => number; default: not declared - flatHazard(input): FlatHazardInput; default: not declared - flatHazard(input).hazardRate: number; default: not declared - flatHazard(input).options?: Omit; default: not declared - flatHazard(input).options.dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - flatHazard(input).referenceDate: string; default: not declared - survivalFromHazards: (points: ReadonlyArray, options?: SurvivalCurveOptions) => SurvivalCurve; default: not declared - survivalFromHazards().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - survivalFromHazards().return.dayCount: FixedIncomeDayCount; default: not declared - survivalFromHazards().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - survivalFromHazards().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - survivalFromHazards().return.pillars: readonly SurvivalPillar[]; default: not declared - survivalFromHazards().return.referenceDate: string; default: not declared - survivalFromHazards().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - survivalFromHazards().return.timeTo: (at: string | number) => number; default: not declared - survivalFromHazards(options)?: SurvivalCurveOptions; default: not declared - survivalFromHazards(options).dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - survivalFromHazards(options).referenceDate?: string; default: not declared — Reference date (t = 0, where Q = 1). Default: the first pillar date. - survivalFromHazards(points): readonly (readonly [string, number])[]; default: not declared - survivalFromProbabilities: (points: ReadonlyArray, options?: SurvivalCurveOptions) => SurvivalCurve; default: not declared - survivalFromProbabilities().return.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - survivalFromProbabilities().return.dayCount: FixedIncomeDayCount; default: not declared - survivalFromProbabilities().return.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - survivalFromProbabilities().return.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - survivalFromProbabilities().return.pillars: readonly SurvivalPillar[]; default: not declared - survivalFromProbabilities().return.referenceDate: string; default: not declared - survivalFromProbabilities().return.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - survivalFromProbabilities().return.timeTo: (at: string | number) => number; default: not declared - survivalFromProbabilities(options)?: SurvivalCurveOptions; default: not declared - survivalFromProbabilities(options).dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - survivalFromProbabilities(options).referenceDate?: string; default: not declared — Reference date (t = 0, where Q = 1). Default: the first pillar date. - survivalFromProbabilities(points): readonly (readonly [string, number])[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#creditSpreadCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Par CDS spreads at each tenor off the survival/discount curves. Facade (H03): the plain call returns the points; `.explain()` echoes every convention the per-tenor CDS actually ran on — the wave that landed the propagation fix proved `accrualOnDefault`/`protectionSteps` are MATERIAL (the round trip missed its own quotes by ~0.24bp when they were dropped). ```typescript export declare const creditSpreadCurve: CreditSpreadCurveFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }; default: not declared - (options).accrualOnDefault?: boolean; default: not declared - (options).dayCount?: FixedIncomeDayCount; default: not declared - (options).discountCurve: YieldCurve; default: not declared - (options).frequency?: Frequency; default: not declared - (options).protectionSteps?: number; default: not declared - (options).recovery?: number; default: not declared - (options).referenceDate: string; default: not declared - (options).survivalCurve: SurvivalCurve; default: not declared - (tenors): string[]; default: not declared - explain: (tenors: string[], options: HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }) => Omit, 'assumptions'> & { assumptions: CreditSpreadCurveAssumptions; }; default: not declared - explain().return.assumptions: CreditSpreadCurveAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: CreditSpreadPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(options): HazardBootstrapOptions & { survivalCurve: SurvivalCurve; }; default: not declared - explain(options).accrualOnDefault?: boolean; default: not declared - explain(options).dayCount?: FixedIncomeDayCount; default: not declared - explain(options).discountCurve: YieldCurve; default: not declared - explain(options).frequency?: Frequency; default: not declared - explain(options).protectionSteps?: number; default: not declared - explain(options).recovery?: number; default: not declared - explain(options).referenceDate: string; default: not declared - explain(options).survivalCurve: SurvivalCurve; default: not declared - explain(tenors): string[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#creditTriangleHazard Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function creditTriangleHazard(input: CreditTriangleHazardInput): CreditTriangleHazardResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CreditTriangleHazardInput; default: not declared - (input).recovery?: number; default: not declared - (input).spread: number; default: not declared - return.assumptions: { approximation: 'continuous-premium credit triangle'; conventionsVersion: string; recovery: number; }; default: not declared — Applied conventions, echoed (Law 2 envelope grammar). - return.assumptions.approximation: 'continuous-premium credit triangle'; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.recovery: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.value: number; default: not declared — Implied flat hazard rate λ (per year). ### @insiderfinance/totalfinance/fixed-income#crossCurrencyBasisCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the domestic-collateralized foreign discount curve (spec §14.5): the foreign OIS curve plus the cross-currency basis, `D_for^dom = foreign.addSpread(basis)`. This is the curve on which to discount foreign cash flows collateralized in the domestic currency, and it reprices the FX forwards the xccy basis market quotes: `F(0,t) = spot · D_for^dom(t) / D_dom(t)`. ```typescript export declare function crossCurrencyBasisCurve(input: CrossCurrencyBasisInput): CrossCurrencyBasisResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CrossCurrencyBasisInput; default: not declared - (input).basis?: YieldCurve; default: not declared — Cross-currency basis term structure added to the foreign curve (its zero rates ARE the basis spreads). Omit for the pure covered-interest-parity case (no basis): `fxForward` is then `spot · D_for(t)/D_dom(t)` and the collateralized curve is the foreign curve itself. - (input).domestic: YieldCurve; default: not declared — Domestic collateral (OIS) discount curve. - (input).foreign: YieldCurve; default: not declared — Foreign index/OIS discount curve (pre-basis). - (input).spot: number; default: not declared — FX spot: domestic units per 1 foreign unit. - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.collateralizedCurve: YieldCurve; default: not declared — The domestic-collateralized foreign discount curve (`foreign + basis`). Discount foreign cash flows on THIS. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.fxForward: (at: string | number) => number; default: not declared — Market FX forward at `at`, from the collateralized curve: `spot · D_for^dom(at) / D_dom(at)`. ### @insiderfinance/totalfinance/fixed-income#curveMetrics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a bond against a discount curve and report effective/key-rate risk from curve shocks. Facade (dx §2.7): the plain call returns the rich {@link CurveMetrics}; `.explain()` wraps the same result in the core envelope with the conventions echoed at the top level. ```typescript export declare const curveMetrics: BondFacade<[bond: Bond, curve: YieldCurve, options: CurvePricingOptions], CurveMetrics, CurveMetrics>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [bond: Bond, curve: YieldCurve, options: CurvePricingOptions]; default: not declared - explain: (bond: Bond, curve: YieldCurve, options: CurvePricingOptions) => BondComputed; default: not declared - explain().return.assumptions: BondAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared - explain().return.value: CurveMetrics; default: not declared - explain(callArguments): [bond: Bond, curve: YieldCurve, options: CurvePricingOptions]; default: not declared - return.accruedInterest: number; default: not declared - return.assumptions: BondAssumptions; default: not declared - return.cleanPrice: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.dirtyPrice: number; default: not declared - return.dv01: number; default: not declared — Dollar value of a 1bp parallel curve shift (per face). - return.effectiveConvexity: number; default: not declared — Effective convexity from a parallel curve shock. - return.effectiveDuration: number; default: not declared — Effective duration from a parallel curve shock. - return.keyRateDurations: { tenorYears: number; date: string; duration: number; }[]; default: not declared — Per-pillar key-rate durations, aligned to the curve's pillars. ### @insiderfinance/totalfinance/fixed-income#curves Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Curve constructors (spec §14.2). Every builder returns an immutable {@link YieldCurve} whose discount factors, zero rates, and forwards are mutually consistent. ```typescript export declare const curves: { bootstrap: (instruments: BootstrapInstrument[], options: BootstrapOptions) => YieldCurve; bootstrapMultiCurve: (options: MultiCurveBootstrapOptions) => MultiCurve; bootstrapProjection: (instruments: BootstrapInstrument[], options: ProjectionBootstrapOptions) => YieldCurve; discountFactor: (points: ReadonlyArray, options?: CurveOptions) => YieldCurve; flat: (input: FlatCurveInput) => YieldCurve; fromDiscountFactors: (points: ReadonlyArray, options?: CurveOptions) => YieldCurve; fromZeroRates: (points: ReadonlyArray, options?: CurveOptions) => YieldCurve; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bootstrap: (instruments: BootstrapInstrument[], options: BootstrapOptions) => YieldCurve; default: not declared - bootstrap().return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - bootstrap().return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - bootstrap().return.dayCount: FixedIncomeDayCount; default: not declared - bootstrap().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - bootstrap().return.extrapolation: CurveExtrapolation; default: not declared - bootstrap().return.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - bootstrap().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - bootstrap().return.interpolation: CurveInterpolation; default: not declared - bootstrap().return.pillars: readonly CurvePillar[]; default: not declared - bootstrap().return.referenceDate: string; default: not declared - bootstrap().return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - bootstrap().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - bootstrap().return.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - bootstrap(instruments): BootstrapInstrument[]; default: not declared - bootstrap(options): BootstrapOptions; default: not declared - bootstrap(options).dayCount?: FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - bootstrap(options).extrapolation?: CurveExtrapolation; default: not declared - bootstrap(options).interpolation?: CurveInterpolation; default: not declared - bootstrap(options).referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - bootstrapMultiCurve: (options: MultiCurveBootstrapOptions) => MultiCurve; default: not declared — One-call dual-curve set: OIS discount + index projection → `{ discountCurve, forecastCurve }`. - bootstrapMultiCurve().return.discountCurve: YieldCurve; default: not declared - bootstrapMultiCurve().return.forecastCurve: YieldCurve; default: not declared - bootstrapMultiCurve(options): MultiCurveBootstrapOptions; default: not declared - bootstrapMultiCurve(options).dayCount?: FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - bootstrapMultiCurve(options).extrapolation?: CurveExtrapolation; default: not declared - bootstrapMultiCurve(options).interpolation?: CurveInterpolation; default: not declared - bootstrapMultiCurve(options).ois: BootstrapInstrument[]; default: not declared — Instruments defining the OIS discount curve (self-discounting). - bootstrapMultiCurve(options).projection: BootstrapInstrument[]; default: not declared — Instruments defining the index projection curve (discounted on the OIS curve). - bootstrapMultiCurve(options).referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - bootstrapProjection: (instruments: BootstrapInstrument[], options: ProjectionBootstrapOptions) => YieldCurve; default: not declared — Dual-curve (OIS-discounted) projection-curve bootstrap. - bootstrapProjection().return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - bootstrapProjection().return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - bootstrapProjection().return.dayCount: FixedIncomeDayCount; default: not declared - bootstrapProjection().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - bootstrapProjection().return.extrapolation: CurveExtrapolation; default: not declared - bootstrapProjection().return.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - bootstrapProjection().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - bootstrapProjection().return.interpolation: CurveInterpolation; default: not declared - bootstrapProjection().return.pillars: readonly CurvePillar[]; default: not declared - bootstrapProjection().return.referenceDate: string; default: not declared - bootstrapProjection().return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - bootstrapProjection().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - bootstrapProjection().return.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - bootstrapProjection(instruments): BootstrapInstrument[]; default: not declared - bootstrapProjection(options): ProjectionBootstrapOptions; default: not declared - bootstrapProjection(options).dayCount?: FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - bootstrapProjection(options).discountCurve: YieldCurve; default: not declared — The (OIS) discount curve. Each par swap discounts its legs on THIS curve while its floating forwards project off the curve being built — the post-2008 dual-curve convention. Build it first with {@link bootstrap} (self-discounting OIS), then pass it here. - bootstrapProjection(options).extrapolation?: CurveExtrapolation; default: not declared - bootstrapProjection(options).interpolation?: CurveInterpolation; default: not declared - bootstrapProjection(options).referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - discountFactor: (points: ReadonlyArray, options?: CurveOptions) => YieldCurve; default: not declared — Build a curve from discount-factor pillars. - discountFactor().return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discountFactor().return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discountFactor().return.dayCount: FixedIncomeDayCount; default: not declared - discountFactor().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discountFactor().return.extrapolation: CurveExtrapolation; default: not declared - discountFactor().return.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discountFactor().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discountFactor().return.interpolation: CurveInterpolation; default: not declared - discountFactor().return.pillars: readonly CurvePillar[]; default: not declared - discountFactor().return.referenceDate: string; default: not declared - discountFactor().return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discountFactor().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discountFactor().return.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discountFactor(options)?: CurveOptions; default: not declared - discountFactor(options).compounding?: InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - discountFactor(options).dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - discountFactor(options).extrapolation?: CurveExtrapolation; default: not declared - discountFactor(options).interpolation?: CurveInterpolation; default: not declared - discountFactor(options).referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. - discountFactor(points): readonly (readonly [string, number])[]; default: not declared - flat: (input: FlatCurveInput) => YieldCurve; default: not declared - flat().return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - flat().return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - flat().return.dayCount: FixedIncomeDayCount; default: not declared - flat().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - flat().return.extrapolation: CurveExtrapolation; default: not declared - flat().return.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - flat().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - flat().return.interpolation: CurveInterpolation; default: not declared - flat().return.pillars: readonly CurvePillar[]; default: not declared - flat().return.referenceDate: string; default: not declared - flat().return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - flat().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - flat().return.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - flat(input): FlatCurveInput; default: not declared - flat(input).options?: Omit; default: not declared - flat(input).options.compounding?: InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - flat(input).options.dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - flat(input).options.extrapolation?: CurveExtrapolation; default: not declared - flat(input).options.interpolation?: CurveInterpolation; default: not declared - flat(input).rate: number; default: not declared - flat(input).referenceDate: string; default: not declared - fromDiscountFactors: (points: ReadonlyArray, options?: CurveOptions) => YieldCurve; default: not declared - fromDiscountFactors().return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - fromDiscountFactors().return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - fromDiscountFactors().return.dayCount: FixedIncomeDayCount; default: not declared - fromDiscountFactors().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - fromDiscountFactors().return.extrapolation: CurveExtrapolation; default: not declared - fromDiscountFactors().return.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - fromDiscountFactors().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - fromDiscountFactors().return.interpolation: CurveInterpolation; default: not declared - fromDiscountFactors().return.pillars: readonly CurvePillar[]; default: not declared - fromDiscountFactors().return.referenceDate: string; default: not declared - fromDiscountFactors().return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - fromDiscountFactors().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - fromDiscountFactors().return.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - fromDiscountFactors(options)?: CurveOptions; default: not declared - fromDiscountFactors(options).compounding?: InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - fromDiscountFactors(options).dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - fromDiscountFactors(options).extrapolation?: CurveExtrapolation; default: not declared - fromDiscountFactors(options).interpolation?: CurveInterpolation; default: not declared - fromDiscountFactors(options).referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. - fromDiscountFactors(points): readonly (readonly [string, number])[]; default: not declared - fromZeroRates: (points: ReadonlyArray, options?: CurveOptions) => YieldCurve; default: not declared - fromZeroRates().return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - fromZeroRates().return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - fromZeroRates().return.dayCount: FixedIncomeDayCount; default: not declared - fromZeroRates().return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - fromZeroRates().return.extrapolation: CurveExtrapolation; default: not declared - fromZeroRates().return.forwardRate: (from: string | number, to: string | number, dayCount?: FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - fromZeroRates().return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - fromZeroRates().return.interpolation: CurveInterpolation; default: not declared - fromZeroRates().return.pillars: readonly CurvePillar[]; default: not declared - fromZeroRates().return.referenceDate: string; default: not declared - fromZeroRates().return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - fromZeroRates().return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - fromZeroRates().return.zeroRate: (at: string | number, compounding?: InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - fromZeroRates(options)?: CurveOptions; default: not declared - fromZeroRates(options).compounding?: InterestCompounding; default: not declared — Compounding the *input* zero rates are quoted in (zero-rate builder only). Default continuous. - fromZeroRates(options).dayCount?: FixedIncomeDayCount; default: not declared — Day count mapping dates → year fractions. Default `ACT/365F`. - fromZeroRates(options).extrapolation?: CurveExtrapolation; default: not declared - fromZeroRates(options).interpolation?: CurveInterpolation; default: not declared - fromZeroRates(options).referenceDate?: string; default: not declared — Valuation/reference date (t = 0). Defaults to the first pillar date. - fromZeroRates(points): readonly (readonly [string, number])[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#daysInMonth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Days in a given month (`month` is 1-12). ```typescript export declare function daysInMonth(year: number, month: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (month): number; default: not declared - (year): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#daysInYear Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Days in a Gregorian year (365 or 366). ```typescript export declare function daysInYear(year: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (year): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#discountFromZero Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Discount factor implied by a zero rate quoted in `compounding` over time `t`. ```typescript export declare function discountFromZero(zero: number, years: number, compounding: InterestCompounding): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (compounding): InterestCompounding; default: not declared - (compounding).periodsPerYear: number; default: not declared - (compounding).type: 'periodic'; default: not declared - (years): number; default: not declared - (zero): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#forwardCmsRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Forward CMS rate off a curve: the forward swap rate of the underlying constant-maturity swap plus the convexity adjustment. Discount the resulting rate on the relevant payment date to value a CMS leg. ```typescript export declare function forwardCmsRate(specification: CmsSpecification, curves: SwapCurves): CmsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): CmsSpecification; default: not declared - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared - (specification).fixedFrequency?: Frequency; default: not declared — Underlying swap fixed-leg frequency (drives the convexity G(y); default semiannual). - (specification).floatDayCount?: FixedIncomeDayCount; default: not declared - (specification).floatFrequency?: Frequency; default: not declared - (specification).resetDate: string; default: not declared — When the CMS rate is observed (the underlying swap's start). - (specification).swapTenorYears: number; default: not declared — Underlying swap tenor in whole years (e.g. 10 for a 10y CMS). - (specification).volatility: number; default: not declared — Lognormal volatility of the underlying swap rate. - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.cmsRate: number; default: not declared — Convexity-adjusted expected CMS rate `forwardSwapRate + convexityAdjustment`. - return.convexityAdjustment: number; default: not declared — Convexity adjustment added because the swap rate is not a martingale under its payment measure. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.forwardSwapRate: number; default: not declared — Plain forward swap rate of the underlying CMS swap. ### @insiderfinance/totalfinance/fixed-income#forwardSwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The curve-driven forward swap rate and annuity of a (possibly forward-starting) swap — the two curve inputs a swaption needs, in one call. For a swaption struck at `K` expiring at `startDate`, the price is `annuity · Black(forwardSwapRate, K, σ, T)` (Bachelier for normal σ). Pair this with a vol from `@insiderfinance/totalfinance/volatility`'s swaption cube (`swaptionCubeVolatility`) for a fully curve-consistent swaption price, so the forward and annuity come from the live (OIS/projection) curves rather than stale market nodes. ```typescript export declare function forwardSwap(specification: ForwardSwapSpecification, curves: SwapCurves): ForwardSwapResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): ForwardSwapSpecification; default: not declared - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - (specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - (specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - (specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - (specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).startDate: string; default: not declared - return.annuity: number; default: not declared — Fixed-leg annuity `Σ τ·DF(payDate)` (the level / PV of a unit annuity). - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.forwardSwapRate: number; default: not declared — Par (forward) swap rate `S = floatLegPv / annuity` — a swaption's natural forward under the annuity measure. - return.pv01: number; default: not declared — PV of a 1bp fixed-rate change (`notional · annuity · 1e-4`). ### @insiderfinance/totalfinance/fixed-income#fraValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function fraValue(specification: FraSpecification, options: { curve: YieldCurve; }): FraResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { curve: YieldCurve; }; default: not declared - (options).curve: YieldCurve; default: not declared - (specification): FraSpecification; default: not declared - (specification).dayCount?: FixedIncomeDayCount; default: not declared — Default `ACT/360`. - (specification).end: string; default: not declared - (specification).fixedRate: number; default: not declared — Contract (fixed) rate the buyer pays. - (specification).notional?: number; default: not declared - (specification).start: string; default: not declared - return.accrual: number; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.discountFactor: number; default: not declared - return.forwardRate: number; default: not declared - return.value: number; default: not declared — PV to the fixed-rate payer (receives floating). ### @insiderfinance/totalfinance/fixed-income#g2pp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). G2++ (two-additive-factor Gaussian) short-rate model `r(t) = φ(t) + x(t) + y(t)` with correlated Ornstein-Uhlenbeck factors, fit to the initial `curve` (Brigo–Mercurio). Two factors give a richer, de-correlating term structure of volatility than one-factor Hull-White, while keeping analytic discount bonds and (Gaussian) zero-coupon-bond options. Reduces to Hull-White when `eta = 0`. ```typescript export declare function g2pp(curve: YieldCurve, parameters: G2ppParameters): G2ppModel; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curve): YieldCurve; default: not declared - (curve).addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - (curve).bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - (curve).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - (curve).discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - (curve).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - (curve).forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - (curve).instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - (curve).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - (curve).pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - (curve).referenceDate: string; default: not declared - (curve).shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - (curve).timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - (curve).zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - (parameters): G2ppParameters; default: not declared - (parameters).a: number; default: not declared — Mean reversion of factor x. - (parameters).b: number; default: not declared — Mean reversion of factor y. - (parameters).eta: number; default: not declared — Volatility of factor y. - (parameters).rho: number; default: not declared — Instantaneous correlation of the two factors, in [-1, 1]. - (parameters).sigma: number; default: not declared — Volatility of factor x. - return.caplet: (input: RateOptionletInput) => number; default: not declared - return.discountBond: (input: G2ppDiscountBondInput) => number; default: not declared — Reconstructed discount bond `P(t,T)` given factor values `(x, y)` at `t` (default 0 ⇒ the curve). - return.floorlet: (input: RateOptionletInput) => number; default: not declared - return.shortRateVariance: (years: number) => number; default: not declared — Variance of the short rate at horizonYears `t`. - return.zeroCouponBondOption: (input: ZeroCouponBondOptionInput) => number; default: not declared — Analytic zero-coupon-bond option as of t = 0 (Gaussian, like Hull-White but with the G2++ variance). ### @insiderfinance/totalfinance/fixed-income#generateSchedule Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Generate a coupon schedule by rolling backward from maturity at the coupon interval — the market default, which places any irregular ("stub") period at the front. Accrual boundaries are the regular unadjusted dates (so coupon amounts use the true period length); payment dates are business-day-adjusted and optionally lagged. ```typescript export declare function generateSchedule(options: ScheduleOptions): SchedulePeriod[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): ScheduleOptions; default: not declared - (options).calendar?: Calendar; default: not declared — Calendar deciding business days (default weekends-only). - (options).convention?: BusinessDayConvention; default: not declared — Business-day roll applied to payment dates (default `modifiedFollowing`). - (options).effectiveDate: string; default: not declared — First accrual date (dated/effective date). - (options).endOfMonth?: boolean; default: not declared — Force month-end rolling; defaults to auto-detect from whether `maturityDate` is a month end. - (options).frequency: Frequency; default: not declared - (options).maturityDate: string; default: not declared — Final accrual date (maturity). - (options).paymentLagDays?: number; default: not declared — Business days between a period's accrual end and its payment (settlement lag). Default 0. ### @insiderfinance/totalfinance/fixed-income#hullWhite Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Construct a Hull-White model `dr = (θ(t) − a·r)dt + σ dW`, with θ implied by `curve`. ```typescript export declare function hullWhite(curve: YieldCurve, parameters: HullWhiteParameters): HullWhiteModel; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curve): YieldCurve; default: not declared - (curve).addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - (curve).bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - (curve).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - (curve).discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - (curve).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - (curve).forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - (curve).instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - (curve).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - (curve).pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - (curve).referenceDate: string; default: not declared - (curve).shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - (curve).timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - (curve).zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - (parameters): HullWhiteParameters; default: not declared - (parameters).a: number; default: not declared - (parameters).sigma: number; default: not declared - return.caplet: (input: RateOptionletInput) => number; default: not declared - return.discountBond: (input: HullWhiteDiscountBondInput) => number; default: not declared — Reconstructed discount bond `P(t,T)` consistent with the initial curve, given short rate `r` at t. - return.floorlet: (input: RateOptionletInput) => number; default: not declared - return.shortRateStandardDeviation: (years: number) => number; default: not declared — Standard deviation of the short rate at horizonYears `t`. - return.zeroCouponBondOption: (input: ZeroCouponBondOptionInput) => number; default: not declared — Analytic ZCB option as of t = 0 (uses the market curve directly). ### @insiderfinance/totalfinance/fixed-income#impliedCrossCurrencyBasis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Invert market FX forwards to the cross-currency basis (spec §14.5) — the inverse of {@link crossCurrencyBasisCurve}. From `F(0,t) = spot · D_for^dom(t)/D_dom(t)`, the collateralized foreign discount factor is `D_for^dom(t) = F(0,t)·D_dom(t)/spot`, and the implied basis is its continuous zero minus the foreign curve's own zero. ```typescript export declare function impliedCrossCurrencyBasis(input: ImpliedCrossCurrencyBasisInput): ImpliedCrossCurrencyBasisResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedCrossCurrencyBasisInput; default: not declared - (input).domestic: YieldCurve; default: not declared — Domestic collateral (OIS) discount curve. - (input).foreign: YieldCurve; default: not declared — Foreign index/OIS discount curve (pre-basis). - (input).forwards: [string, number][]; default: not declared — Observed market FX forwards `[date, forward]` (domestic per foreign). - (input).spot: number; default: not declared — FX spot: domestic units per 1 foreign unit. - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.basis: { date: string; spread: number; }[]; default: not declared — Implied continuous cross-currency basis spread at each forward date (collateralized zero − foreign zero). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#isEndOfMonth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether an ISO date is the last calendar day of its month. ```typescript export declare function isEndOfMonth(date: string): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (date): string; default: not declared ### @insiderfinance/totalfinance/fixed-income#isLeapYear Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gregorian leap-year test. ```typescript export declare function isLeapYear(year: number): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (year): number; default: not declared ### @insiderfinance/totalfinance/fixed-income#oasAnalytics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market-calibrated option-adjusted-spread analytics for a callable/putable bond: the OAS, the Z-spread, their difference (the embedded-**option cost**), and the **OAS-consistent** effective duration and convexity (the curve shocked with the spread held fixed). Composes the same short-rate lattice as {@link callableBond}. See `docs/specs/oas-analytics.md`. ```typescript export declare function oasAnalytics(specification: OasAnalyticsSpecification): OasAnalyticsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (specification): OasAnalyticsSpecification; default: not declared - (specification).bond: Bond; default: not declared - (specification).calls?: BondOption[]; default: not declared — Issuer call schedule (caps the bond's value at each strike). - (specification).curve: YieldCurve; default: not declared — Calibration/discount curve (its reference date is the valuation date). - (specification).durationShock?: number; default: not declared — Curve shock for the effective duration/convexity, in decimal. Default 1e-4 (1 bp). - (specification).marketPrice: number; default: not declared — Market dirty price the OAS and Z-spread are solved to. - (specification).meanReversion: number; default: not declared — Mean reversion and short-rate volatility for the tree model. - (specification).model?: TreeModel; default: not declared — Tree model (default `hull-white`). - (specification).puts?: BondOption[]; default: not declared — Holder put schedule (floors the bond's value at each strike). - (specification).sigma: number; default: not declared - (specification).spreadCurve?: YieldCurve; default: not declared — Optional term-structure spread curve added to `curve` before the spreads are solved. The effective benchmark becomes `curve` + `spreadCurve` (continuous zeros add ⇔ discount factors multiply), so the reported OAS and Z-spread are measured OVER a NON-FLAT benchmark — e.g. an OIS discount curve plus a sector/rating spread curve — rather than the plain `curve`. Its zero rates ARE the spreads (build one with `curves.fromZeroRates(spreadPillars)`); it must share `curve`'s reference date. - (specification).stepsPerYear?: number; default: not declared — Tree steps per year (default 24, hard outer maximum 1,000,000; total-tree cap may be lower). - return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; meanReversion: number; model: TreeModel; settlementDate: string; sigma: number; stepsPerYear: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.dayCount: 'ACT/365F'; default: not declared - return.assumptions.meanReversion: number; default: not declared - return.assumptions.model: TreeModel; default: not declared - return.assumptions.settlementDate: string; default: not declared - return.assumptions.sigma: number; default: not declared - return.assumptions.stepsPerYear: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.effectiveConvexity: number; default: not declared — OAS-consistent effective convexity. - return.effectiveDuration: number; default: not declared — OAS-consistent effective duration (curve shocked ±`durationShock` at constant OAS). - return.marketPrice: number; default: not declared - return.modelPrice: number; default: not declared — The no-spread lattice model price (the gap `marketPrice − modelPrice` is what the OAS explains). - return.oas: number; default: not declared — Parallel curve shift repricing the callable model to `marketPrice` (decimal; ×1e4 = bps). - return.optionCost: number; default: not declared — `zSpread − oas` (decimal) — the embedded-option cost. Positive callable / negative putable. - return.zSpread: number; default: not declared — Zero-volatility spread on the same lattice's straight leg (decimal). ### @insiderfinance/totalfinance/fixed-income#paymentsPerYear Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a {@link Frequency} to an integer number of payments per year (must divide 12 evenly). ```typescript export declare function paymentsPerYear(frequency: Frequency): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (frequency): Frequency; default: not declared ### @insiderfinance/totalfinance/fixed-income#priceFromYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dirty/clean price and accrued interest for a bond at a given yield. Facade (dx §2.7): the plain call returns the rich {@link BondPrice}; `.explain()` wraps the same result in the core envelope with the conventions echoed at the top level. ```typescript export declare const priceFromYield: BondFacade<[bond: Bond, options: PriceFromYieldOptions], BondPrice, BondPrice>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [bond: Bond, options: PriceFromYieldOptions]; default: not declared - explain: (bond: Bond, options: PriceFromYieldOptions) => BondComputed; default: not declared - explain().return.assumptions: BondAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared - explain().return.value: BondPrice; default: not declared - explain(callArguments): [bond: Bond, options: PriceFromYieldOptions]; default: not declared - return.accruedInterest: number; default: not declared - return.assumptions: BondAssumptions; default: not declared - return.cleanPrice: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.dirtyPrice: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#priceMultiCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a bond with separate discount and forecast curves (multi-curve framework, no shock). `knownFixingRate` is the FRN in-progress coupon's observed reset — see {@link ProjectionContext.knownFixingRate}. It is surfaced here because this is the multi-curve pricing front door: without it, an FRN settled between two coupon dates could not be priced through the function most callers reach for. ```typescript export declare function priceMultiCurve(bond: Bond, options: { settlementDate: string; discountCurve: YieldCurve; forecastCurve?: YieldCurve; knownFixingRate?: number; }): BondPrice; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bond): Bond; default: not declared - (bond).accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - (bond).businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - (bond).cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - (bond).couponRate: number; default: not declared - (bond).dayCount: FixedIncomeDayCount; default: not declared - (bond).faceValue: number; default: not declared - (bond).frequency: number; default: not declared - (bond).futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - (bond).issueDate: string; default: not declared - (bond).kind: BondKind; default: not declared - (bond).maturityDate: string; default: not declared - (bond).schedule: readonly SchedulePeriod[]; default: not declared - (options): { discountCurve: YieldCurve; forecastCurve?: YieldCurve; knownFixingRate?: number; settlementDate: string; }; default: not declared - (options).discountCurve: YieldCurve; default: not declared - (options).forecastCurve?: YieldCurve; default: not declared - (options).knownFixingRate?: number; default: not declared - (options).settlementDate: string; default: not declared - return.accruedInterest: number; default: not declared - return.assumptions: BondAssumptions; default: not declared - return.cleanPrice: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.dirtyPrice: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#rateCurveFromYieldCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Project a live {@link YieldCurve} to core `RateCurve` data (module header). ```typescript export declare function rateCurveFromYieldCurve(input: { curve: YieldCurve; currency: string; }): RateCurve; ``` Example (source JSDoc): ```ts const data = rateCurveFromYieldCurve({ curve: curves.bootstrap(instruments, options), currency: 'USD' }); createMarketSnapshot({ asOf, observations: { curves: { 'USD.ois': data } } }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { currency: string; curve: YieldCurve; }; default: not declared - (input).currency: string; default: not declared - (input).curve: YieldCurve; default: not declared - return.asOf: number; default: not declared - return.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - return.currency: string; default: not declared - return.dayCount: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - return.interpolation?: string; default: not declared - return.points: import('@insiderfinance/totalfinance/core').RateCurvePoint[]; default: not declared ### @insiderfinance/totalfinance/fixed-income#shortRateTree Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a Hull-White / Black-Karasinski trinomial tree calibrated to `curve` via forward induction (Hull's two-stage procedure). Stage 1 lays out a symmetric mean-reverting tree for the transformed state `x`; stage 2 shifts each time slice by `α(t)` so the tree reprices every grid discount factor. For Black-Karasinski the short rate is `exp(x)`, so `α` is solved numerically per step. ```typescript export declare function shortRateTree(curve: YieldCurve, options: ShortRateTreeOptions): ShortRateTree; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curve): YieldCurve; default: not declared - (curve).addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - (curve).bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - (curve).dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - (curve).discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - (curve).extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - (curve).forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - (curve).instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - (curve).interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - (curve).pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - (curve).referenceDate: string; default: not declared - (curve).shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - (curve).timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - (curve).zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - (options): ShortRateTreeOptions; default: not declared - (options).horizonYears: number; default: not declared — Tree horizonYears in years. - (options).meanReversion: number; default: not declared - (options).model: TreeModel; default: not declared — `hull-white` (Gaussian short rate) or `black-karasinski` (lognormal short rate). - (options).sigma: number; default: not declared - (options).steps?: number; default: not declared — Number of time steps (default 50). - return.discountBond: (maturity: number) => number; default: not declared — Tree-implied discount bond price `P(0, T)` for a maturity on the time grid (years). - return.gridTimes: readonly number[]; default: not declared — Reference discount factors the tree was calibrated to, at each grid time. - return.model: TreeModel; default: not declared - return.reachAt: (stepIndex: number) => number; default: not declared — Half-width of reachable levels at step `i` (nodes span `[-reach, +reach]`). - return.rollback: (terminalStep: number, terminal: (j: number) => number, atNode?: (i: number, j: number, continuation: number) => number) => number; default: not declared — Generic backward induction from `terminalStep` to the root. `terminal(j)` seeds the value at each terminal node; at every earlier node the discounted expected continuation is passed to `atNode`, which returns the node value (inject cashflows, apply call/exercise via min/max). Returns the root value. The engine behind callable bonds and Bermudan swaptions. - return.shortRate: (stepIndex: number, nodeIndex: number) => number; default: not declared — Short rate at tree node `(i, j)` (time step i, level j). - return.stepOf: (years: number) => number; default: not declared — Map a year fraction to its grid step, validating it lands on the grid. - return.steps: number; default: not declared - return.timeStepYears: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#swapRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Par swap rate that makes the swap value zero: `floatLegPv / annuity`. Facade (H04): the plain call returns the scalar; `.explain()` discloses the leg decomposition and every applied convention. ```typescript export declare const swapRate: SwapRateFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): ParSwapSpecification; default: not declared - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - (specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - (specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - (specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - (specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).startDate: string; default: not declared - explain: (specification: ParSwapSpecification, curves: SwapCurves) => Omit, 'assumptions'> & { assumptions: SwapRateAssumptions; }; default: not declared - explain().return.assumptions: SwapRateAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(curves): SwapCurves; default: not declared - explain(curves).discountCurve: YieldCurve; default: not declared - explain(curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - explain(specification): ParSwapSpecification; default: not declared - explain(specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - explain(specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - explain(specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - explain(specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - explain(specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - explain(specification).maturityDate: string; default: not declared - explain(specification).notional?: number; default: not declared - explain(specification).startDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#swapValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Value an interest-rate swap (or OIS) off discount/forecast curves. ```typescript export declare function swapValue(specification: SwapSpecification, curves: SwapCurves): SwapValuation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): SwapSpecification; default: not declared - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - (specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - (specification).fixedRate: number; default: not declared — Fixed-leg rate. - (specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - (specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - (specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).startDate: string; default: not declared - return.annuity: number; default: not declared — Σ τᵢ·DF(tᵢ) over the fixed leg (the level / PV of a unit annuity). - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.fixedLegPresentValue: number; default: not declared - return.floatLegPresentValue: number; default: not declared - return.parRate: number; default: not declared - return.pv01: number; default: not declared — PV of a 1bp change in the fixed rate (per notional). - return.value: number; default: not declared — PV to the payer (pays fixed, receives floating). Receiver PV is the negative. ### @insiderfinance/totalfinance/fixed-income#swapXva Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compute CVA / DVA / FVA for an interest-rate swap via a Hull-White exposure simulation. ```typescript export declare function swapXva(specification: XvaSwapSpecification, parameters: XvaParameters): XvaResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): XvaParameters; default: not declared - (parameters).counterpartySurvival: SurvivalCurve; default: not declared — Counterparty survival curve (drives CVA). - (parameters).fundingSpread?: number; default: not declared — Funding spread over the risk-free curve for FVA (default 0 ⇒ FVA = 0). - (parameters).meanReversion: number; default: not declared — Hull-White mean reversion and short-rate volatility. - (parameters).ownRecovery?: number; default: not declared — Own recovery (default 0.4). - (parameters).ownSurvival?: SurvivalCurve; default: not declared — Own survival curve (drives DVA); omit to skip DVA. - (parameters).paths?: number; default: not declared — Number of simulated paths (default 5000). - (parameters).recovery?: number; default: not declared — Counterparty recovery (default 0.4). - (parameters).seed: number; default: not declared — Seed for the deterministic PRNG. - (parameters).sigma: number; default: not declared - (parameters).stepsPerYear?: number; default: not declared — Simulation steps per year (default 24, hard outer maximum 1,000,000; paths×steps cap may be lower). - (specification): XvaSwapSpecification; default: not declared - (specification).curve: YieldCurve; default: not declared — Discount/forecast curve (single-curve); its reference date is the valuation date. - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared - (specification).fixedFrequency?: Frequency; default: not declared - (specification).fixedRate: number; default: not declared - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).optionType: 'payer' | 'receiver'; default: not declared — `payer` = we pay fixed; `receiver` = we receive fixed. - (specification).startDate: string; default: not declared - return.assumptions: { conventionsVersion: string; model: 'hull-white'; paths: number; seed: number; stepsPerYear: number; }; default: not declared — Echoed reproducibility knobs (R2): the seed, paths, and grid resolution actually used. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.model: 'hull-white'; default: not declared - return.assumptions.paths: number; default: not declared - return.assumptions.seed: number; default: not declared - return.assumptions.stepsPerYear: number; default: not declared - return.bilateralCva: number; default: not declared — Bilateral CVA: `cva − dva`. - return.cva: number; default: not declared - return.diagnostics: Diagnostics & { repricingError: number; }; default: not declared — Honest computation report (R2). `repricingError` is the worst zero-coupon repricing error of the simulator (martingale check) — the honesty signal for the whole exposure profile. - return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.diagnostics.repricingError: number; default: not declared - return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - return.dva: number; default: not declared - return.exposure: ExposurePoint[]; default: not declared — The exposure profile across the measurement dates. - return.fva: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#swaptionPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European swaption. The forward swap rate `S` is the natural martingale under the annuity measure, so the price is `annuity · ForwardOption(S, K, σ, T)` — Black for lognormal vol, Bachelier for normal vol. ```typescript export declare function swaptionPrice(specification: SwaptionSpecification, curves: SwapCurves): SwaptionResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): SwapCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).forecastCurve?: YieldCurve; default: not declared — Projection curve for floating coupons; defaults to the discount curve (single-curve). - (specification): SwaptionSpecification; default: not declared - (specification).expiry: string; default: not declared — Option expiry (typically the swap start). - (specification).fixedDayCount?: FixedIncomeDayCount; default: not declared — Fixed-leg day count (default `30/360`). - (specification).fixedFrequency?: Frequency; default: not declared — Fixed-leg frequency (default semiannual). - (specification).fixedRate: number; default: not declared — Fixed-leg rate. - (specification).floatDayCount?: FixedIncomeDayCount; default: not declared — Floating-leg day count (default `ACT/360`). - (specification).floatFrequency?: Frequency; default: not declared — Floating-leg frequency (default quarterly). - (specification).floatSpread?: number; default: not declared — Spread over the projected index on the floating leg (default 0). - (specification).maturityDate: string; default: not declared - (specification).model?: RatesVolatilityModel; default: not declared - (specification).notional?: number; default: not declared - (specification).optionType: 'payer' | 'receiver'; default: not declared — `payer` = option to pay fixed (call on the swap rate); `receiver` = option to receive fixed. - (specification).startDate: string; default: not declared - (specification).volatility: number; default: not declared — Volatility — lognormal for `black`, normal (absolute) for `bachelier`. - return.annuity: number; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.forwardSwapRate: number; default: not declared - return.price: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#tipsIndexRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The TIPS reference CPI and index ratio for a settlement date: the 3-month-lagged NSA CPI, linearly interpolated by day across the settlement month, over the dated-date base. See `docs/specs/inflation.md`. ```typescript export declare function tipsIndexRatio(input: TipsIndexRatioInput): TipsIndexRatioResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TipsIndexRatioInput; default: not declared - (input).baseReferenceCpi?: number; default: not declared — The dated-date reference CPI (indexation base) — supply this OR `datedDate`, exactly one. - (input).cpi: Record; default: not declared — NSA CPI by month `'YYYY-MM'` → level; must cover the 3-month-lag window of every date used. - (input).datedDate?: string; default: not declared — The bond's dated date; its reference CPI (interpolated from `cpi`) becomes the base. - (input).settlementDate: string; default: not declared — The date the index ratio is for (ISO). - return.assumptions: { conventionsVersion: string; interpolation: 'daily-linear'; lagMonths: 3; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.interpolation: 'daily-linear'; default: not declared - return.assumptions.lagMonths: 3; default: not declared - return.baseReferenceCpi: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.indexRatio: number; default: not declared — `referenceCpi / baseReferenceCpi` (raw). - return.indexRatioRounded: number; default: not declared — Index ratio rounded to 5 decimals (the official ratio). - return.inflationSinceBase: number; default: not declared — `indexRatio − 1`. - return.lagMonth2: string; default: not declared — CPI two months prior (`CPI₋₂`) and its month. - return.lagMonth2Cpi: number; default: not declared - return.lagMonth3: string; default: not declared — CPI three months prior (`CPI₋₃`) and its month. - return.lagMonth3Cpi: number; default: not declared - return.referenceCpi: number; default: not declared — Interpolated reference CPI (raw). - return.referenceCpiRounded: number; default: not declared — Reference CPI rounded to the Treasury's 5 decimals. - return.settlementDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#vasicek Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Construct a Vasicek model `dr = a(b − r)dt + σ dW`. ```typescript export declare function vasicek(parameters: VasicekParameters): GaussianShortRateModel; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): VasicekParameters; default: not declared - (parameters).a: number; default: not declared — Mean-reversion speed (> 0). - (parameters).b: number; default: not declared — Long-run mean level. - (parameters).r0: number; default: not declared — Current short rate. - (parameters).sigma: number; default: not declared — Instantaneous volatility (> 0). - return.caplet: (input: RateOptionletInput) => number; default: not declared — Caplet on the simple rate over `[tOption, tBond]`, strike `capRate`, per unit notional. - return.discountBond: (shortRate: number, tau: number) => number; default: not declared — Affine discount-bond price `P(t,T)` for a short rate `r` at time `t` (τ = T − t in years). - return.floorlet: (input: RateOptionletInput) => number; default: not declared — Floorlet on the simple rate over `[tOption, tBond]`, strike `floorRate`, per unit notional. - return.shortRateMoments: (years: number) => ShortRateMoments; default: not declared — Mean/variance of the short rate at horizonYears `T` (years), from `r0`. - return.zeroCouponBondOption: (input: ZeroCouponBondOptionInput) => number; default: not declared — Analytic price of a European call/put on a zero-coupon bond maturing at `tBond`, exercised at `tOption` (years), struck at `strike` (per unit face) — the Jamshidian decomposition's building block. Returns a present value as of t = 0. - return.zeroRate: (shortRate: number, tau: number) => number; default: not declared — Continuously-compounded zero rate `−ln P / τ`. ### @insiderfinance/totalfinance/fixed-income#yearFraction Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Year fraction between two ISO dates under a fixed-income day-count convention. `ACT/ACT` and `30E/360` are implemented here; the three core conventions delegate to `@insiderfinance/totalfinance/core`. ```typescript export declare function yearFraction(from: string, to: string, dayCount?: FixedIncomeDayCount): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (dayCount)?: FixedIncomeDayCount; default: not declared - (from): string; default: not declared - (to): string; default: not declared ### @insiderfinance/totalfinance/fixed-income#yieldCurveFromRateCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a live {@link YieldCurve} from core `RateCurve` data (module header). ```typescript export declare function yieldCurveFromRateCurve(input: { curve: RateCurve; interpolation: CurveInterpolation; extrapolation: CurveExtrapolation; }): YieldCurve; ``` Example (source JSDoc): ```ts const curve = yieldCurveFromRateCurve({ curve: snapshot.observations.curves['USD.treasury'], interpolation: 'logLinearDiscount', extrapolation: 'flatForward', }); curve.discount('2028-06-30'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { curve: RateCurve; extrapolation: CurveExtrapolation; interpolation: CurveInterpolation; }; default: not declared - (input).curve: RateCurve; default: not declared - (input).extrapolation: CurveExtrapolation; default: not declared - (input).interpolation: CurveInterpolation; default: not declared - return.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - return.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - return.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - return.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - return.extrapolation: CurveExtrapolation; default: not declared - return.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - return.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - return.interpolation: CurveInterpolation; default: not declared - return.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - return.referenceDate: string; default: not declared - return.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - return.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - return.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). ### @insiderfinance/totalfinance/fixed-income#yieldMetrics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Full set of yield-based risk metrics at a given yield (actuarial convention). Duration and convexity are the closed-form analytic sensitivities of the dirty price to a parallel yield move. Facade (dx §2.7): the plain call returns the rich {@link YieldMetrics}; `.explain()` wraps the same result in the core envelope with the conventions echoed at the top level. ```typescript export declare const yieldMetrics: BondFacade<[bond: Bond, options: YieldMetricsOptions], YieldMetrics, YieldMetrics>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [bond: Bond, options: YieldMetricsOptions]; default: not declared - explain: (bond: Bond, options: YieldMetricsOptions) => BondComputed; default: not declared - explain().return.assumptions: BondAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared - explain().return.value: YieldMetrics; default: not declared - explain(callArguments): [bond: Bond, options: YieldMetricsOptions]; default: not declared - return.accruedInterest: number; default: not declared - return.assumptions: BondAssumptions; default: not declared - return.cleanPrice: number; default: not declared - return.convexity: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.dirtyPrice: number; default: not declared - return.dv01: number; default: not declared — Dollar value of a 1bp yield increase (per the bond's face value). - return.macaulayDuration: number; default: not declared - return.modifiedDuration: number; default: not declared - return.pv01: number; default: not declared — Price value of a 1bp move (synonym for DV01 here, per face). - return.yield: number; default: not declared ### @insiderfinance/totalfinance/fixed-income#yieldToCall Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Yield to a call date (H05): the plain call returns the scalar; `.explain()` mirrors `yieldToMaturity.explain()` — solver facts in diagnostics, the resolved call price and settlement accrued in the decomposition, and the call/price basis echoed in assumptions. ```typescript export declare const yieldToCall: YieldToCallFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bond): Bond; default: not declared - (bond).accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - (bond).businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - (bond).cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - (bond).couponRate: number; default: not declared - (bond).dayCount: FixedIncomeDayCount; default: not declared - (bond).faceValue: number; default: not declared - (bond).frequency: number; default: not declared - (bond).futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - (bond).issueDate: string; default: not declared - (bond).kind: BondKind; default: not declared - (bond).maturityDate: string; default: not declared - (bond).schedule: readonly SchedulePeriod[]; default: not declared - (call): CallFeature; default: not declared - (call).callDate: string; default: not declared — First/earliest call date. - (call).callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. - (options): YieldFromPriceOptions; default: not declared - (options).context?: ProjectionContext; default: not declared - (options).price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - (options).priceType?: 'clean' | 'dirty'; default: not declared - (options).settlementDate: string; default: not declared - explain: (bond: Bond, call: CallFeature, options: YieldFromPriceOptions) => Omit, 'assumptions'> & { assumptions: YieldToCallAssumptions; }; default: not declared - explain().return.assumptions: YieldToCallAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(bond): Bond; default: not declared - explain(bond).accrued: (settlementDate: string, context?: ProjectionContext) => number; default: not declared — Accrued interest at `settlementDate` (per the bond's face value). - explain(bond).businessDayConvention: BusinessDayConvention; default: not declared — Business-day convention applied when the payment schedule was generated. - explain(bond).cashflows: (context?: ProjectionContext) => CashFlow[]; default: not declared — Every life cash flow (projected via `context` for FRN/inflation). - explain(bond).couponRate: number; default: not declared - explain(bond).dayCount: FixedIncomeDayCount; default: not declared - explain(bond).faceValue: number; default: not declared - explain(bond).frequency: number; default: not declared - explain(bond).futureCashflows: (settlementDate: string, context?: ProjectionContext) => CashFlow[]; default: not declared — Cash flows strictly after `settlementDate` — what a buyer settling then receives. - explain(bond).issueDate: string; default: not declared - explain(bond).kind: BondKind; default: not declared - explain(bond).maturityDate: string; default: not declared - explain(bond).schedule: readonly SchedulePeriod[]; default: not declared - explain(call): CallFeature; default: not declared - explain(call).callDate: string; default: not declared — First/earliest call date. - explain(call).callPrice?: number; default: not declared — Call (redemption) price. Default: the OUTSTANDING notional at the call date, derived from the bond's cash-flow schedule — the face value for a bullet bond, the un-amortized balance for an amortizing bond. Pass explicitly for premium calls (e.g. 102) or when the outstanding balance is not derivable from the schedule. - explain(options): YieldFromPriceOptions; default: not declared - explain(options).context?: ProjectionContext; default: not declared - explain(options).price: number; default: not declared — Either a clean price (default) or a dirty price — set `priceType`. - explain(options).priceType?: 'clean' | 'dirty'; default: not declared - explain(options).settlementDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income#yieldToMaturity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve the yield to maturity that reprices a bond to the observed price (Brent on [−0.99·f, 1]). Facade (dx §2.7): the plain call returns the bare yield; `.explain()` returns the core envelope echoing the bond's conventions plus honest solver diagnostics (this is a root-find, so `converged`/`iterations` are disclosed — a non-converged solve throws rather than returning). ```typescript export declare const yieldToMaturity: BondFacade<[bond: Bond, options: YieldFromPriceOptions], number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [bond: Bond, options: YieldFromPriceOptions]; default: not declared - explain: (bond: Bond, options: YieldFromPriceOptions) => BondComputed; default: not declared - explain().return.assumptions: BondAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared - explain().return.value: number; default: not declared - explain(callArguments): [bond: Bond, options: YieldFromPriceOptions]; default: not declared ### @insiderfinance/totalfinance/fixed-income#zeroCouponInflationSwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A **zero-coupon inflation swap** (ZCIS) — the standard inflation-market instrument. At maturity the inflation leg pays `I(T)/I(0) − 1` and the fixed leg pays `(1+K)^N − 1`; the par rate `K` is set so the two match, i.e. `(1+K)^N = I(T)/I(0)`, so the par ZCIS rate **is** the geometric breakeven inflation. Supply the market rate or the forward index ratio (each implies the other); supply a `contractRate` to mark an existing position: `MTM = ±notional·DF·[(1+parRate)^N − (1+contractRate)^N]`. Deterministic (forward-measure) — no inflation-vol model. See `docs/specs/inflation.md`. ```typescript export declare function zeroCouponInflationSwap(input: ZeroCouponInflationSwapInput): ZeroCouponInflationSwapResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ZeroCouponInflationSwapInput; default: not declared - (input).contractRate?: number; default: not declared — An existing position's contracted fixed rate `K_c` — supply to value the swap (MTM). - (input).discountFactor?: number; default: not declared — Discount factor to maturity for the MTM (default `1` → the undiscounted at-maturity value). - (input).forwardIndexRatio?: number; default: not declared — The forward index ratio `I(T)/I(0)`. Supply **this or** `swapRate` — exactly one. Implies `swapRate = forwardIndexRatio^(1/N) − 1`. - (input).maturityYears: number; default: not declared — Swap maturity in years (`N`). The single ZCIS cashflow is exchanged at maturity. - (input).notional?: number; default: not declared — Notional (default `1`). - (input).payer?: 'fixed' | 'inflation'; default: not declared — Which leg the holder **pays** (default `'fixed'` = pay fixed, receive inflation). Signs the MTM. - (input).swapRate?: number; default: not declared — The par/market ZCIS rate `K` (the geometric annual breakeven). Supply **this or** `forwardIndexRatio` — exactly one. - return.assumptions: { conventionsVersion: string; method: 'zero-coupon-inflation-swap'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'zero-coupon-inflation-swap'; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.fixedLeg: number; default: not declared — The single fixed-leg payoff per unit notional at maturity: `(1 + parRate)^N − 1`. Equals the expected inflation-leg payoff (they match at par). - return.forwardIndexRatio: number; default: not declared — Forward index ratio `I(T)/I(0) = (1 + parRate)^N`. - return.markToMarket: number | null; default: not declared — Mark-to-market PV of a position at `contractRate` (present only when `contractRate` is supplied): `±notional·DF·[(1+parRate)^N − (1+contractRate)^N]`, signed by `payer`. `null` otherwise. - return.parRate: number; default: not declared — Par ZCIS rate (geometric annual breakeven): `forwardIndexRatio^(1/N) − 1`. ### @insiderfinance/totalfinance/fixed-income#zeroFromDiscount Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Zero rate (in `compounding`) implied by a discount factor over time `t`. ```typescript export declare function zeroFromDiscount(discountFactor: number, years: number, compounding: InterestCompounding): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (compounding): InterestCompounding; default: not declared - (compounding).periodsPerYear: number; default: not declared - (compounding).type: 'periodic'; default: not declared - (discountFactor): number; default: not declared - (years): number; default: not declared ## Entrypoint @insiderfinance/totalfinance/fixed-income/artifacts ### @insiderfinance/totalfinance/fixed-income/artifacts#CURVE_MODEL_FAMILIES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const CURVE_MODEL_FAMILIES: readonly CurveModelFamily[]; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#CalibrationOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalibrationOf = CurveCalibrations[F]; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveCalibrations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The direct bootstrap's input per family, verbatim (live curves where the bootstrap takes them). ```typescript /** The direct bootstrap's input per family, verbatim (live curves where the bootstrap takes them). */ export interface CurveCalibrations { 'discount-curve': { instruments: BootstrapInstrument[]; options: BootstrapOptions; }; 'projection-curve': { instruments: BootstrapInstrument[]; options: ProjectionBootstrapOptions; }; 'multi-curve': { options: MultiCurveBootstrapOptions; }; 'hazard-curve': { quotes: CdsQuote[]; options: HazardBootstrapOptions; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discount-curve: { instruments: BootstrapInstrument[]; options: BootstrapOptions; }; default: not declared - discount-curve.instruments: BootstrapInstrument[]; default: not declared - discount-curve.options: BootstrapOptions; default: not declared - discount-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - discount-curve.options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discount-curve.options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discount-curve.options.referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - hazard-curve: { quotes: CdsQuote[]; options: HazardBootstrapOptions; }; default: not declared - hazard-curve.options: HazardBootstrapOptions; default: not declared - hazard-curve.options.accrualOnDefault?: boolean; default: not declared - hazard-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hazard-curve.options.discountCurve: YieldCurve; default: not declared - hazard-curve.options.discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - hazard-curve.options.discountCurve.addSpread(spread): YieldCurve; default: not declared - hazard-curve.options.discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - hazard-curve.options.discountCurve.bumpPillar(delta): number; default: not declared - hazard-curve.options.discountCurve.bumpPillar(index): number; default: not declared - hazard-curve.options.discountCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hazard-curve.options.discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - hazard-curve.options.discountCurve.discount(at): string | number; default: not declared - hazard-curve.options.discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - hazard-curve.options.discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - hazard-curve.options.discountCurve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - hazard-curve.options.discountCurve.forwardRate(from): string | number; default: not declared - hazard-curve.options.discountCurve.forwardRate(to): string | number; default: not declared - hazard-curve.options.discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - hazard-curve.options.discountCurve.instantaneousForward(at): string | number; default: not declared - hazard-curve.options.discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - hazard-curve.options.discountCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - hazard-curve.options.discountCurve.referenceDate: string; default: not declared - hazard-curve.options.discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - hazard-curve.options.discountCurve.shift(delta): number; default: not declared - hazard-curve.options.discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - hazard-curve.options.discountCurve.timeTo(at): string | number; default: not declared - hazard-curve.options.discountCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - hazard-curve.options.discountCurve.zeroRate(at): string | number; default: not declared - hazard-curve.options.discountCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - hazard-curve.options.discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - hazard-curve.options.discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - hazard-curve.options.frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - hazard-curve.options.protectionSteps?: number; default: not declared - hazard-curve.options.recovery?: number; default: not declared - hazard-curve.options.referenceDate: string; default: not declared - hazard-curve.quotes: CdsQuote[]; default: not declared - multi-curve: { options: MultiCurveBootstrapOptions; }; default: not declared - multi-curve.options: MultiCurveBootstrapOptions; default: not declared - multi-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - multi-curve.options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - multi-curve.options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - multi-curve.options.ois: BootstrapInstrument[]; default: not declared — Instruments defining the OIS discount curve (self-discounting). - multi-curve.options.projection: BootstrapInstrument[]; default: not declared — Instruments defining the index projection curve (discounted on the OIS curve). - multi-curve.options.referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - projection-curve: { instruments: BootstrapInstrument[]; options: ProjectionBootstrapOptions; }; default: not declared - projection-curve.instruments: BootstrapInstrument[]; default: not declared - projection-curve.options: ProjectionBootstrapOptions; default: not declared - projection-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - projection-curve.options.discountCurve: YieldCurve; default: not declared — The (OIS) discount curve. Each par swap discounts its legs on THIS curve while its floating forwards project off the curve being built — the post-2008 dual-curve convention. Build it first with {@link bootstrap} (self-discounting OIS), then pass it here. - projection-curve.options.discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - projection-curve.options.discountCurve.addSpread(spread): YieldCurve; default: not declared - projection-curve.options.discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - projection-curve.options.discountCurve.bumpPillar(delta): number; default: not declared - projection-curve.options.discountCurve.bumpPillar(index): number; default: not declared - projection-curve.options.discountCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - projection-curve.options.discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - projection-curve.options.discountCurve.discount(at): string | number; default: not declared - projection-curve.options.discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - projection-curve.options.discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - projection-curve.options.discountCurve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - projection-curve.options.discountCurve.forwardRate(from): string | number; default: not declared - projection-curve.options.discountCurve.forwardRate(to): string | number; default: not declared - projection-curve.options.discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - projection-curve.options.discountCurve.instantaneousForward(at): string | number; default: not declared - projection-curve.options.discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - projection-curve.options.discountCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - projection-curve.options.discountCurve.referenceDate: string; default: not declared - projection-curve.options.discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - projection-curve.options.discountCurve.shift(delta): number; default: not declared - projection-curve.options.discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - projection-curve.options.discountCurve.timeTo(at): string | number; default: not declared - projection-curve.options.discountCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - projection-curve.options.discountCurve.zeroRate(at): string | number; default: not declared - projection-curve.options.discountCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - projection-curve.options.discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - projection-curve.options.discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - projection-curve.options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - projection-curve.options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - projection-curve.options.referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveEvaluationDifference Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CurveEvaluationDifference { measure: string; unit: string; grid: Array>; comparedCount: number; nullCount: number; maximumAbsoluteDifference: number | null; rootMeanSquareDifference: number | null; placement: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comparedCount: number; default: not declared - grid: Record[]; default: not declared - maximumAbsoluteDifference: number | null; default: not declared - measure: string; default: not declared - nullCount: number; default: not declared - placement: string; default: not declared - rootMeanSquareDifference: number | null; default: not declared - unit: string; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveEvaluations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What `evaluateFittedModel` takes per family — the restored curve's own query, at dates. ```typescript /** What `evaluateFittedModel` takes per family — the restored curve's own query, at dates. */ export interface CurveEvaluations { 'discount-curve': { dates: string[]; measure: YieldCurveMeasure; }; 'projection-curve': { dates: string[]; measure: YieldCurveMeasure; }; 'multi-curve': { curve: 'discountCurve' | 'forecastCurve'; dates: string[]; measure: YieldCurveMeasure; }; 'hazard-curve': { dates: string[]; measure: SurvivalCurveMeasure; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discount-curve: { dates: string[]; measure: YieldCurveMeasure; }; default: not declared - discount-curve.dates: string[]; default: not declared - discount-curve.measure: YieldCurveMeasure; default: not declared - hazard-curve: { dates: string[]; measure: SurvivalCurveMeasure; }; default: not declared - hazard-curve.dates: string[]; default: not declared - hazard-curve.measure: SurvivalCurveMeasure; default: not declared - multi-curve: { curve: 'discountCurve' | 'forecastCurve'; dates: string[]; measure: YieldCurveMeasure; }; default: not declared - multi-curve.curve: 'discountCurve' | 'forecastCurve'; default: not declared - multi-curve.dates: string[]; default: not declared - multi-curve.measure: YieldCurveMeasure; default: not declared - projection-curve: { dates: string[]; measure: YieldCurveMeasure; }; default: not declared - projection-curve.dates: string[]; default: not declared - projection-curve.measure: YieldCurveMeasure; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveFits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The stored fit per family: the live result's own data members. ```typescript /** The stored fit per family: the live result's own data members. */ export interface CurveFits { 'discount-curve': YieldCurveData; 'projection-curve': YieldCurveData; 'multi-curve': { discountCurve: YieldCurveData; forecastCurve: YieldCurveData; }; 'hazard-curve': SurvivalCurveData; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discount-curve: YieldCurveData; default: not declared - discount-curve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - discount-curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discount-curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discount-curve.pillars: import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - discount-curve.referenceDate: string; default: not declared - discount-curve.zeroRateAtOrigin: import('@insiderfinance/totalfinance/fixed-income/artifacts').ZeroRateAtOrigin; default: not declared - hazard-curve: SurvivalCurveData; default: not declared - hazard-curve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hazard-curve.pillars: import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - hazard-curve.referenceDate: string; default: not declared - multi-curve: { discountCurve: YieldCurveData; forecastCurve: YieldCurveData; }; default: not declared - multi-curve.discountCurve: YieldCurveData; default: not declared - multi-curve.discountCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - multi-curve.discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - multi-curve.discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - multi-curve.discountCurve.pillars: import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - multi-curve.discountCurve.referenceDate: string; default: not declared - multi-curve.discountCurve.zeroRateAtOrigin: import('@insiderfinance/totalfinance/fixed-income/artifacts').ZeroRateAtOrigin; default: not declared - multi-curve.forecastCurve: YieldCurveData; default: not declared - multi-curve.forecastCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - multi-curve.forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - multi-curve.forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - multi-curve.forecastCurve.pillars: import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - multi-curve.forecastCurve.referenceDate: string; default: not declared - multi-curve.forecastCurve.zeroRateAtOrigin: import('@insiderfinance/totalfinance/fixed-income/artifacts').ZeroRateAtOrigin; default: not declared - projection-curve: YieldCurveData; default: not declared - projection-curve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - projection-curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - projection-curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - projection-curve.pillars: import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - projection-curve.referenceDate: string; default: not declared - projection-curve.zeroRateAtOrigin: import('@insiderfinance/totalfinance/fixed-income/artifacts').ZeroRateAtOrigin; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveFittedModelReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The typed report every curve verb reads and writes — the artifact's `result`, verbatim. ```typescript /** The typed report every curve verb reads and writes — the artifact's `result`, verbatim. */ export type CurveFittedModelReport = Readonly> & { family: F; modelVersion: number; summary: FittedModelSummary; /** The bootstrap's result as its own data (restored exactly by the public constructors). */ fit: FitOf; /** The bootstrap's input, verbatim, with live curves as their data and referenced row sets as handles. */ calibration: StoredCalibrationOf; referencedData: Record; assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; evaluator: string | null; inputPolicy: 'embedded' | 'referenced'; /** The curve's currency — a stored curve without a unit is a number without one. */ currency: string; projection: string; }; diagnostics: { warnings: QuantWarning[]; fitWarningCount: number; embeddedCalibrationBytes: number; referencedRowSets: string[]; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; evaluator: string | null; inputPolicy: 'embedded' | 'referenced'; currency: string; projection: string; }; default: not declared - assumptions.calibrator: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.currency: string; default: not declared — The curve's currency — a stored curve without a unit is a number without one. - assumptions.evaluator: string | null; default: not declared - assumptions.family: F; default: not declared - assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.projection: string; default: not declared - calibration: StoredCalibrationOf; default: not declared — The bootstrap's input, verbatim, with live curves as their data and referenced row sets as handles. - diagnostics: { warnings: QuantWarning[]; fitWarningCount: number; embeddedCalibrationBytes: number; referencedRowSets: string[]; }; default: not declared - diagnostics.embeddedCalibrationBytes: number; default: not declared - diagnostics.fitWarningCount: number; default: not declared - diagnostics.referencedRowSets: string[]; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - fit: FitOf; default: not declared — The bootstrap's result as its own data (restored exactly by the public constructors). - modelVersion: number; default: not declared - referencedData: Record; default: not declared - summary: FittedModelSummary; default: not declared - summary.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - summary.convergence.converged: boolean; default: not declared - summary.convergence.iterations: number | null; default: not declared - summary.convergence.reason?: string; default: not declared - summary.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - summary.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - summary.inputIdentity.calibrationHash: string; default: not declared - summary.inputIdentity.snapshotHash: string | null; default: not declared - summary.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - summary.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - summary.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - summary.modelRisk.notes: string[]; default: not declared - summary.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - summary.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - summary.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - summary.objective.reason?: string; default: not declared — Required exactly when `value` is null. - summary.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - summary.objective.value: number | null; default: not declared - summary.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - summary.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - summary.residuals.count: number; default: not declared - summary.residuals.maximumAbsolute: number | null; default: not declared - summary.residuals.rootMeanSquare: number | null; default: not declared - summary.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - summary.residuals.unit: string; default: not declared - summary.warningCount: number; default: not declared - summary.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveLiveFits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The live result per family — what the direct bootstrap returns and what `fittedModelArtifact` accepts. ```typescript /** The live result per family — what the direct bootstrap returns and what `fittedModelArtifact` accepts. */ export interface CurveLiveFits { 'discount-curve': YieldCurve; 'projection-curve': YieldCurve; 'multi-curve': MultiCurve; 'hazard-curve': SurvivalCurve; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discount-curve: YieldCurve; default: not declared - discount-curve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - discount-curve.addSpread(spread): YieldCurve; default: not declared - discount-curve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - discount-curve.bumpPillar(delta): number; default: not declared - discount-curve.bumpPillar(index): number; default: not declared - discount-curve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - discount-curve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - discount-curve.discount(at): string | number; default: not declared - discount-curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discount-curve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - discount-curve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - discount-curve.forwardRate(from): string | number; default: not declared - discount-curve.forwardRate(to): string | number; default: not declared - discount-curve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - discount-curve.instantaneousForward(at): string | number; default: not declared - discount-curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discount-curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - discount-curve.referenceDate: string; default: not declared - discount-curve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - discount-curve.shift(delta): number; default: not declared - discount-curve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - discount-curve.timeTo(at): string | number; default: not declared - discount-curve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - discount-curve.zeroRate(at): string | number; default: not declared - discount-curve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - discount-curve.zeroRate(compounding).periodsPerYear: number; default: not declared - discount-curve.zeroRate(compounding).type: 'periodic'; default: not declared - hazard-curve: SurvivalCurve; default: not declared - hazard-curve.conditionalDefaultProbability: (from: string | number, to: string | number) => number; default: not declared — Conditional default probability over `[from, to]` given survival to `from`: 1 − Q(to)/Q(from). - hazard-curve.conditionalDefaultProbability(from): string | number; default: not declared - hazard-curve.conditionalDefaultProbability(to): string | number; default: not declared - hazard-curve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hazard-curve.defaultProbability: (from: string | number, to: string | number) => number; default: not declared — Unconditional default probability in the window `[from, to]`: Q(from) − Q(to). - hazard-curve.defaultProbability(from): string | number; default: not declared - hazard-curve.defaultProbability(to): string | number; default: not declared - hazard-curve.hazard: (at: string | number) => number; default: not declared — Instantaneous (piecewise-constant) hazard rate at a date or year fraction. - hazard-curve.hazard(at): string | number; default: not declared - hazard-curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').SurvivalPillar[]; default: not declared - hazard-curve.referenceDate: string; default: not declared - hazard-curve.survival: (at: string | number) => number; default: not declared — Survival probability Q to a date or year fraction. - hazard-curve.survival(at): string | number; default: not declared - hazard-curve.timeTo: (at: string | number) => number; default: not declared - hazard-curve.timeTo(at): string | number; default: not declared - multi-curve: MultiCurve; default: not declared - multi-curve.discountCurve: YieldCurve; default: not declared - multi-curve.discountCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - multi-curve.discountCurve.addSpread(spread): YieldCurve; default: not declared - multi-curve.discountCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - multi-curve.discountCurve.bumpPillar(delta): number; default: not declared - multi-curve.discountCurve.bumpPillar(index): number; default: not declared - multi-curve.discountCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - multi-curve.discountCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - multi-curve.discountCurve.discount(at): string | number; default: not declared - multi-curve.discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - multi-curve.discountCurve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - multi-curve.discountCurve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - multi-curve.discountCurve.forwardRate(from): string | number; default: not declared - multi-curve.discountCurve.forwardRate(to): string | number; default: not declared - multi-curve.discountCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - multi-curve.discountCurve.instantaneousForward(at): string | number; default: not declared - multi-curve.discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - multi-curve.discountCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - multi-curve.discountCurve.referenceDate: string; default: not declared - multi-curve.discountCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - multi-curve.discountCurve.shift(delta): number; default: not declared - multi-curve.discountCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - multi-curve.discountCurve.timeTo(at): string | number; default: not declared - multi-curve.discountCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - multi-curve.discountCurve.zeroRate(at): string | number; default: not declared - multi-curve.discountCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - multi-curve.discountCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - multi-curve.discountCurve.zeroRate(compounding).type: 'periodic'; default: not declared - multi-curve.forecastCurve: YieldCurve; default: not declared - multi-curve.forecastCurve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - multi-curve.forecastCurve.addSpread(spread): YieldCurve; default: not declared - multi-curve.forecastCurve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - multi-curve.forecastCurve.bumpPillar(delta): number; default: not declared - multi-curve.forecastCurve.bumpPillar(index): number; default: not declared - multi-curve.forecastCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - multi-curve.forecastCurve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - multi-curve.forecastCurve.discount(at): string | number; default: not declared - multi-curve.forecastCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - multi-curve.forecastCurve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - multi-curve.forecastCurve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - multi-curve.forecastCurve.forwardRate(from): string | number; default: not declared - multi-curve.forecastCurve.forwardRate(to): string | number; default: not declared - multi-curve.forecastCurve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - multi-curve.forecastCurve.instantaneousForward(at): string | number; default: not declared - multi-curve.forecastCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - multi-curve.forecastCurve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - multi-curve.forecastCurve.referenceDate: string; default: not declared - multi-curve.forecastCurve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - multi-curve.forecastCurve.shift(delta): number; default: not declared - multi-curve.forecastCurve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - multi-curve.forecastCurve.timeTo(at): string | number; default: not declared - multi-curve.forecastCurve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - multi-curve.forecastCurve.zeroRate(at): string | number; default: not declared - multi-curve.forecastCurve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - multi-curve.forecastCurve.zeroRate(compounding).periodsPerYear: number; default: not declared - multi-curve.forecastCurve.zeroRate(compounding).type: 'periodic'; default: not declared - projection-curve: YieldCurve; default: not declared - projection-curve.addSpread: (spread: YieldCurve) => YieldCurve; default: not declared — Combine with a term-structure spread curve: the continuous zeros ADD at each tenor (equivalently discount factors multiply, `D(t)·D_spread(t)`). Unions both curves' pillar tenors so the spread's shape — not just a level — is preserved. Used to discount over `benchmark + spread` (e.g. OIS + a sector/rating spread) while keeping curve construction out of leaf entrypoints. - projection-curve.addSpread(spread): YieldCurve; default: not declared - projection-curve.bumpPillar: (index: number, delta: number) => YieldCurve; default: not declared — Bump a single pillar's continuous zero by `delta` (key-rate risk). - projection-curve.bumpPillar(delta): number; default: not declared - projection-curve.bumpPillar(index): number; default: not declared - projection-curve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - projection-curve.discount: (at: string | number) => number; default: not declared — Discount factor to a date or year fraction. - projection-curve.discount(at): string | number; default: not declared - projection-curve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - projection-curve.forwardRate: (from: string | number, to: string | number, dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount) => number; default: not declared — Simple (money-market) forward rate between two times/dates under `dayCount`. - projection-curve.forwardRate(dayCount)?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount | undefined; default: not declared - projection-curve.forwardRate(from): string | number; default: not declared - projection-curve.forwardRate(to): string | number; default: not declared - projection-curve.instantaneousForward: (at: string | number) => number; default: not declared — Instantaneous (continuously-compounded) forward rate at a time/date. - projection-curve.instantaneousForward(at): string | number; default: not declared - projection-curve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - projection-curve.pillars: readonly import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - projection-curve.referenceDate: string; default: not declared - projection-curve.shift: (delta: number) => YieldCurve; default: not declared — Parallel shift of every pillar's continuous zero by `delta` (e.g. +0.0001 = +1bp). - projection-curve.shift(delta): number; default: not declared - projection-curve.timeTo: (at: string | number) => number; default: not declared — Year fraction from the reference date to a date (or pass a number through unchanged). - projection-curve.timeTo(at): string | number; default: not declared - projection-curve.zeroRate: (at: string | number, compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding) => number; default: not declared — Zero rate to a date or year fraction, in the requested compounding (default continuous). - projection-curve.zeroRate(at): string | number; default: not declared - projection-curve.zeroRate(compounding)?: import('@insiderfinance/totalfinance/core').InterestCompounding | undefined; default: not declared - projection-curve.zeroRate(compounding).periodsPerYear: number; default: not declared - projection-curve.zeroRate(compounding).type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveModelFamily Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ─────────────────────────────────────────── the grammar ─────────────────────────────────────────── export type CurveModelFamily = 'discount-curve' | 'projection-curve' | 'multi-curve' | 'hazard-curve'; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#CurveStoredCalibrations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The STORED calibration: live curves as their data, the bulk row sets optionally as `TableHandle`s. ```typescript /** The STORED calibration: live curves as their data, the bulk row sets optionally as `TableHandle`s. */ export interface CurveStoredCalibrations { 'discount-curve': { instruments: BootstrapInstrument[] | TableHandle; options: BootstrapOptions; }; 'projection-curve': { instruments: BootstrapInstrument[] | TableHandle; options: Omit & { discountCurve: YieldCurveData; }; }; 'multi-curve': { options: Omit & { ois: BootstrapInstrument[] | TableHandle; projection: BootstrapInstrument[] | TableHandle; }; }; 'hazard-curve': { quotes: CdsQuote[] | TableHandle; options: Omit & { discountCurve: YieldCurveData; }; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discount-curve: { instruments: BootstrapInstrument[] | TableHandle; options: BootstrapOptions; }; default: not declared - discount-curve.instruments: BootstrapInstrument[] | TableHandle; default: not declared - discount-curve.instruments.columnCount: number; default: not declared - discount-curve.instruments.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - discount-curve.instruments.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - discount-curve.instruments.kind: 'totalfinance.table-handle'; default: not declared - discount-curve.instruments.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - discount-curve.instruments.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - discount-curve.instruments.rowCount: number; default: not declared - discount-curve.options: BootstrapOptions; default: not declared - discount-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - discount-curve.options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - discount-curve.options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - discount-curve.options.referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - hazard-curve: { quotes: CdsQuote[] | TableHandle; options: Omit & { discountCurve: YieldCurveData; }; }; default: not declared - hazard-curve.options: Omit & { discountCurve: YieldCurveData; }; default: not declared - hazard-curve.options.accrualOnDefault?: boolean; default: not declared - hazard-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hazard-curve.options.discountCurve: YieldCurveData; default: not declared - hazard-curve.options.discountCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - hazard-curve.options.discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - hazard-curve.options.discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - hazard-curve.options.discountCurve.pillars: import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - hazard-curve.options.discountCurve.referenceDate: string; default: not declared - hazard-curve.options.discountCurve.zeroRateAtOrigin: import('@insiderfinance/totalfinance/fixed-income/artifacts').ZeroRateAtOrigin; default: not declared - hazard-curve.options.frequency?: import('@insiderfinance/totalfinance/fixed-income').Frequency; default: not declared - hazard-curve.options.protectionSteps?: number; default: not declared - hazard-curve.options.recovery?: number; default: not declared - hazard-curve.options.referenceDate: string; default: not declared - hazard-curve.quotes: CdsQuote[] | TableHandle; default: not declared - hazard-curve.quotes.columnCount: number; default: not declared - hazard-curve.quotes.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - hazard-curve.quotes.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - hazard-curve.quotes.kind: 'totalfinance.table-handle'; default: not declared - hazard-curve.quotes.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - hazard-curve.quotes.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - hazard-curve.quotes.rowCount: number; default: not declared - multi-curve: { options: Omit & { ois: BootstrapInstrument[] | TableHandle; projection: BootstrapInstrument[] | TableHandle; }; }; default: not declared - multi-curve.options: Omit & { ois: BootstrapInstrument[] | TableHandle; projection: BootstrapInstrument[] | TableHandle; }; default: not declared - multi-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - multi-curve.options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - multi-curve.options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - multi-curve.options.ois: BootstrapInstrument[] | TableHandle; default: not declared - multi-curve.options.ois.columnCount: number; default: not declared - multi-curve.options.ois.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - multi-curve.options.ois.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - multi-curve.options.ois.kind: 'totalfinance.table-handle'; default: not declared - multi-curve.options.ois.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - multi-curve.options.ois.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - multi-curve.options.ois.rowCount: number; default: not declared - multi-curve.options.projection: BootstrapInstrument[] | TableHandle; default: not declared - multi-curve.options.projection.columnCount: number; default: not declared - multi-curve.options.projection.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - multi-curve.options.projection.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - multi-curve.options.projection.kind: 'totalfinance.table-handle'; default: not declared - multi-curve.options.projection.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - multi-curve.options.projection.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - multi-curve.options.projection.rowCount: number; default: not declared - multi-curve.options.referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). - projection-curve: { instruments: BootstrapInstrument[] | TableHandle; options: Omit & { discountCurve: YieldCurveData; }; }; default: not declared - projection-curve.instruments: BootstrapInstrument[] | TableHandle; default: not declared - projection-curve.instruments.columnCount: number; default: not declared - projection-curve.instruments.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - projection-curve.instruments.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - projection-curve.instruments.kind: 'totalfinance.table-handle'; default: not declared - projection-curve.instruments.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - projection-curve.instruments.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - projection-curve.instruments.rowCount: number; default: not declared - projection-curve.options: Omit & { discountCurve: YieldCurveData; }; default: not declared - projection-curve.options.dayCount?: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared — Curve day count (default `ACT/365F`). - projection-curve.options.discountCurve: YieldCurveData; default: not declared - projection-curve.options.discountCurve.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - projection-curve.options.discountCurve.extrapolation: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - projection-curve.options.discountCurve.interpolation: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - projection-curve.options.discountCurve.pillars: import('@insiderfinance/totalfinance/fixed-income').CurvePillar[]; default: not declared - projection-curve.options.discountCurve.referenceDate: string; default: not declared - projection-curve.options.discountCurve.zeroRateAtOrigin: import('@insiderfinance/totalfinance/fixed-income/artifacts').ZeroRateAtOrigin; default: not declared - projection-curve.options.extrapolation?: import('@insiderfinance/totalfinance/fixed-income').CurveExtrapolation; default: not declared - projection-curve.options.interpolation?: import('@insiderfinance/totalfinance/fixed-income').CurveInterpolation; default: not declared - projection-curve.options.referenceDate: string; default: not declared — Curve reference/settlement date (t = 0). ### @insiderfinance/totalfinance/fixed-income/artifacts#EvaluationOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type EvaluationOf = CurveEvaluations[F]; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#FITTED_MODEL_FAMILIES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The frozen, data-only descriptor table (Program 5's registry metadata) for the curve families. ```typescript export declare const FITTED_MODEL_FAMILIES: Readonly>; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#FIXED_INCOME_FITTED_MODEL_ARTIFACT_TYPE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const FIXED_INCOME_FITTED_MODEL_ARTIFACT_TYPE: 'fixed-income.fitted-model'; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#FitOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FitOf = CurveFits[F]; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelArtifactInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelArtifactInput { family: F; /** The live result the bootstrap returned (a YieldCurve, a MultiCurve, a SurvivalCurve). */ fit: LiveFitOf; /** The bootstrap's input with its rows and live curves — the adapter stores curve data and mints handles. */ calibration: CalibrationOf; currency: string; referenceRowSets?: readonly string[]; locators?: Record; snapshotHash?: string; libraryVersion?: string; createdFrom?: string[]; provenance?: Provenance; limits?: FittedModelArtifactLimits; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibration: CalibrationOf; default: not declared — The bootstrap's input with its rows and live curves — the adapter stores curve data and mints handles. - createdFrom?: string[]; default: not declared - currency: string; default: not declared - family: F; default: not declared - fit: LiveFitOf; default: not declared — The live result the bootstrap returned (a YieldCurve, a MultiCurve, a SurvivalCurve). - libraryVersion?: string; default: not declared - limits?: FittedModelArtifactLimits; default: not declared - limits.embeddedRowLimit?: number; default: not declared - limits.maximumEmbeddedBytes?: number; default: not declared - locators?: Record; default: not declared - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - referenceRowSets?: readonly string[]; default: not declared - snapshotHash?: string; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelArtifactLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelArtifactLimits { maximumEmbeddedBytes?: number; embeddedRowLimit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit?: number; default: not declared - maximumEmbeddedBytes?: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelComparison { family: F; artifactIds: { baseline: string | null; candidate: string | null; }; sameMarket: boolean | null; sameCalibrationInput: boolean; sameCurrency: boolean; parameters: ParameterDelta[]; objective: { kind: string; unit: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; }; convergence: { baseline: boolean; candidate: boolean; }; residuals: { baselineRootMeanSquare: number | null; candidateRootMeanSquare: number | null; absoluteDelta: number | null; }; fit: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; /** One section per measure on the union of both fits' pillar dates (Decision 6's curve rule). */ evaluation: CurveEvaluationDifference[]; withinTolerance: boolean | null; assumptions: { conventionsVersion: string; family: F; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; }; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - artifactIds.baseline: string | null; default: not declared - artifactIds.candidate: string | null; default: not declared - assumptions: { conventionsVersion: string; family: F; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.family: F; default: not declared - assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - assumptions.tolerance: ComparisonTolerance | null; default: not declared - assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - convergence: { baseline: boolean; candidate: boolean; }; default: not declared - convergence.baseline: boolean; default: not declared - convergence.candidate: boolean; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - evaluation: CurveEvaluationDifference[]; default: not declared — One section per measure on the union of both fits' pillar dates (Decision 6's curve rule). - family: F; default: not declared - fit: { addedPaths: string[]; differenceCount: number; removedPaths: string[]; retainedDifferences: number; truncated: boolean; }; default: not declared - fit.addedPaths: string[]; default: not declared - fit.differenceCount: number; default: not declared - fit.removedPaths: string[]; default: not declared - fit.retainedDifferences: number; default: not declared - fit.truncated: boolean; default: not declared - objective: { absoluteDelta: number | null; baselineValue: number | null; candidateValue: number | null; kind: string; unit: string; }; default: not declared - objective.absoluteDelta: number | null; default: not declared - objective.baselineValue: number | null; default: not declared - objective.candidateValue: number | null; default: not declared - objective.kind: string; default: not declared - objective.unit: string; default: not declared - parameters: ParameterDelta[]; default: not declared - residuals: { absoluteDelta: number | null; baselineRootMeanSquare: number | null; candidateRootMeanSquare: number | null; }; default: not declared - residuals.absoluteDelta: number | null; default: not declared - residuals.baselineRootMeanSquare: number | null; default: not declared - residuals.candidateRootMeanSquare: number | null; default: not declared - sameCalibrationInput: boolean; default: not declared - sameCurrency: boolean; default: not declared - sameMarket: boolean | null; default: not declared - withinTolerance: boolean | null; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelEvaluation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelEvaluation { family: F; at: EvaluationOf; values: (number | null)[]; reasons: Array<{ index: number; reason: string; }>; coordinates: Array>; unit: string; assumptions: { conventionsVersion: string; family: F; modelVersion: number; currency: string; evaluator: string; options: Record; extrapolation: string; }; diagnostics: { warnings: QuantWarning[]; outsideCalibratedRange: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; currency: string; evaluator: string; options: Record; extrapolation: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.currency: string; default: not declared - assumptions.evaluator: string; default: not declared - assumptions.extrapolation: string; default: not declared - assumptions.family: F; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.options: Record; default: not declared - at: EvaluationOf; default: not declared - coordinates: Record[]; default: not declared - diagnostics: { outsideCalibratedRange: number; warnings: QuantWarning[]; }; default: not declared - diagnostics.outsideCalibratedRange: number; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - reasons: { index: number; reason: string; }[]; default: not declared - unit: string; default: not declared - values: (number | null)[]; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelFamilyDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelFamilyDescriptor { family: string; qualifiedFamily: string; modelVersion: number; calibrator: string; evaluator: string | null; warmStart: boolean; referenceableRowSets: readonly string[]; costClass: 'closed-form' | 'least-squares' | 'iterative-pricing' | 'bootstrap' | 'statistic'; requiredData: string; supportedProducts: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibrator: string; default: not declared - costClass: 'statistic' | 'closed-form' | 'least-squares' | 'iterative-pricing' | 'bootstrap'; default: not declared - evaluator: string | null; default: not declared - family: string; default: not declared - modelVersion: number; default: not declared - qualifiedFamily: string; default: not declared - referenceableRowSets: readonly string[]; default: not declared - requiredData: string; default: not declared - supportedProducts: string; default: not declared - warmStart: boolean; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelHoldoutInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelHoldoutInput { family: F; calibration: CalibrationOf; holdout: FittedModelHoldoutSelection; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibration: CalibrationOf; default: not declared - family: F; default: not declared - holdout: FittedModelHoldoutSelection; default: not declared - holdout.everyNth: number; default: not declared - holdout.indices: number[]; default: not declared - holdout.offset: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelHoldoutReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelHoldoutReport { family: F; retainedCount: number; heldOutCount: number; inSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; outOfSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; /** Per held-out instrument: its index and its repricing residual (curve-implied − quoted). */ heldOut: Array<{ index: number; residual: number; }>; unit: string; retainedFit: FittedModelSummary; assumptions: { conventionsVersion: string; family: F; modelVersion: number; holdout: FittedModelHoldoutSelection; instruments: string; residualSource: 'direct-evaluator'; partition: 'cross-sectional instruments'; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; holdout: FittedModelHoldoutSelection; instruments: string; residualSource: 'direct-evaluator'; partition: 'cross-sectional instruments'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.family: F; default: not declared - assumptions.holdout: FittedModelHoldoutSelection; default: not declared - assumptions.holdout.everyNth: number; default: not declared - assumptions.holdout.indices: number[]; default: not declared - assumptions.holdout.offset: number; default: not declared - assumptions.instruments: string; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.partition: 'cross-sectional instruments'; default: not declared - assumptions.residualSource: 'direct-evaluator'; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - heldOut: { index: number; residual: number; }[]; default: not declared — Per held-out instrument: its index and its repricing residual (curve-implied − quoted). - heldOutCount: number; default: not declared - inSample: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; }; default: not declared - inSample.count: number; default: not declared - inSample.maximumAbsolute: number | null; default: not declared - inSample.rootMeanSquare: number | null; default: not declared - outOfSample: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; }; default: not declared - outOfSample.count: number; default: not declared - outOfSample.maximumAbsolute: number | null; default: not declared - outOfSample.rootMeanSquare: number | null; default: not declared - retainedCount: number; default: not declared - retainedFit: FittedModelSummary; default: not declared - retainedFit.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - retainedFit.convergence.converged: boolean; default: not declared - retainedFit.convergence.iterations: number | null; default: not declared - retainedFit.convergence.reason?: string; default: not declared - retainedFit.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - retainedFit.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - retainedFit.inputIdentity.calibrationHash: string; default: not declared - retainedFit.inputIdentity.snapshotHash: string | null; default: not declared - retainedFit.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - retainedFit.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - retainedFit.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - retainedFit.modelRisk.notes: string[]; default: not declared - retainedFit.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - retainedFit.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - retainedFit.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - retainedFit.objective.reason?: string; default: not declared — Required exactly when `value` is null. - retainedFit.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - retainedFit.objective.value: number | null; default: not declared - retainedFit.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - retainedFit.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - retainedFit.residuals.count: number; default: not declared - retainedFit.residuals.maximumAbsolute: number | null; default: not declared - retainedFit.residuals.rootMeanSquare: number | null; default: not declared - retainedFit.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - retainedFit.residuals.unit: string; default: not declared - retainedFit.warningCount: number; default: not declared - retainedFit.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. - unit: string; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelHoldoutSelection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FittedModelHoldoutSelection = { indices: number[]; } | { everyNth: number; offset: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - everyNth: number; default: not declared - indices: number[]; default: not declared - offset: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#FittedModelReplay Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelReplay { family: F; artifactId: string; recomputed: CurveFittedModelReport; parity: ArtifactReplayParity; assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactId: string; default: not declared - assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; default: not declared - assumptions.calibrator: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.family: F; default: not declared - assumptions.libraryVersion: { current: string | null; saved: string | null; }; default: not declared - assumptions.libraryVersion.current: string | null; default: not declared - assumptions.libraryVersion.saved: string | null; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.referencedRowSets: string[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - parity: ArtifactReplayParity; default: not declared - parity.addedPaths: string[]; default: not declared - parity.assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - parity.assumptions.comparison: 'canonical JSON bytes'; default: not declared - parity.assumptions.conventionsVersion: string; default: not declared - parity.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - parity.assumptions.limits.maximumDifferences: number; default: not declared - parity.assumptions.limits.maximumLeaves: number; default: not declared - parity.comparedLeafCount: number; default: not declared - parity.diagnostics: { warnings: QuantWarning[]; }; default: not declared - parity.diagnostics.warnings: QuantWarning[]; default: not declared - parity.differenceCount: number; default: not declared - parity.differences: import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]; default: not declared - parity.identical: boolean; default: not declared - parity.recomputedHash: string; default: not declared - parity.removedPaths: string[]; default: not declared - parity.savedHash: string; default: not declared - parity.truncated: boolean; default: not declared - recomputed: CurveFittedModelReport; default: not declared - recomputed.assumptions: { calibrator: string; conventionsVersion: string; currency: string; evaluator: string | null; family: F; inputPolicy: 'embedded' | 'referenced'; modelVersion: number; projection: string; }; default: not declared - recomputed.assumptions.calibrator: string; default: not declared - recomputed.assumptions.conventionsVersion: string; default: not declared - recomputed.assumptions.currency: string; default: not declared — The curve's currency — a stored curve without a unit is a number without one. - recomputed.assumptions.evaluator: string | null; default: not declared - recomputed.assumptions.family: F; default: not declared - recomputed.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - recomputed.assumptions.modelVersion: number; default: not declared - recomputed.assumptions.projection: string; default: not declared - recomputed.calibration: StoredCalibrationOf; default: not declared — The bootstrap's input, verbatim, with live curves as their data and referenced row sets as handles. - recomputed.diagnostics: { embeddedCalibrationBytes: number; fitWarningCount: number; referencedRowSets: string[]; warnings: QuantWarning[]; }; default: not declared - recomputed.diagnostics.embeddedCalibrationBytes: number; default: not declared - recomputed.diagnostics.fitWarningCount: number; default: not declared - recomputed.diagnostics.referencedRowSets: string[]; default: not declared - recomputed.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.family: F; default: not declared - recomputed.fit: FitOf; default: not declared — The bootstrap's result as its own data (restored exactly by the public constructors). - recomputed.modelVersion: number; default: not declared - recomputed.referencedData: Record; default: not declared - recomputed.summary: FittedModelSummary; default: not declared - recomputed.summary.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - recomputed.summary.convergence.converged: boolean; default: not declared - recomputed.summary.convergence.iterations: number | null; default: not declared - recomputed.summary.convergence.reason?: string; default: not declared - recomputed.summary.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - recomputed.summary.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - recomputed.summary.inputIdentity.calibrationHash: string; default: not declared - recomputed.summary.inputIdentity.snapshotHash: string | null; default: not declared - recomputed.summary.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - recomputed.summary.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - recomputed.summary.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - recomputed.summary.modelRisk.notes: string[]; default: not declared - recomputed.summary.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - recomputed.summary.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - recomputed.summary.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - recomputed.summary.objective.reason?: string; default: not declared — Required exactly when `value` is null. - recomputed.summary.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - recomputed.summary.objective.value: number | null; default: not declared - recomputed.summary.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - recomputed.summary.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - recomputed.summary.residuals.count: number; default: not declared - recomputed.summary.residuals.maximumAbsolute: number | null; default: not declared - recomputed.summary.residuals.rootMeanSquare: number | null; default: not declared - recomputed.summary.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - recomputed.summary.residuals.unit: string; default: not declared - recomputed.summary.warningCount: number; default: not declared - recomputed.summary.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/fixed-income/artifacts#LiveFitOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type LiveFitOf = CurveLiveFits[F]; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#ParameterDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ParameterDelta { parameter: string; baselineValue: number | string; candidateValue: number | string; absoluteDelta: number | null; relativeDelta: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared - baselineValue: string | number; default: not declared - candidateValue: string | number; default: not declared - parameter: string; default: not declared - relativeDelta: number | null; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#ReadFittedModelResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReadFittedModelResult { report: CurveFittedModelReport; artifact: AnalysisArtifact; migrationsApplied: AppliedMigration[]; modelMigrationsApplied: AppliedMigration[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifact: AnalysisArtifact; default: not declared - artifact.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - artifact.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - artifact.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - artifact.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - artifact.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - artifact.inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - artifact.inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - artifact.inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - artifact.kind: 'totalfinance.analysis-artifact'; default: not declared - artifact.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - artifact.producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - artifact.producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - artifact.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - artifact.provenance.asOf?: number; default: not declared - artifact.provenance.dataset?: string; default: not declared - artifact.provenance.provider?: string; default: not declared - artifact.provenance.receivedAt?: number; default: not declared - artifact.provenance.requestId?: string; default: not declared - artifact.provenance.sourceVersion?: string; default: not declared - artifact.provenance.warnings?: QuantWarning[]; default: not declared - artifact.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - artifact.schemaVersion: number; default: not declared - artifact.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - migrationsApplied: AppliedMigration[]; default: not declared - modelMigrationsApplied: AppliedMigration[]; default: not declared - report: CurveFittedModelReport; default: not declared - report.assumptions: { calibrator: string; conventionsVersion: string; currency: string; evaluator: string | null; family: F; inputPolicy: 'embedded' | 'referenced'; modelVersion: number; projection: string; }; default: not declared - report.assumptions.calibrator: string; default: not declared - report.assumptions.conventionsVersion: string; default: not declared - report.assumptions.currency: string; default: not declared — The curve's currency — a stored curve without a unit is a number without one. - report.assumptions.evaluator: string | null; default: not declared - report.assumptions.family: F; default: not declared - report.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - report.assumptions.modelVersion: number; default: not declared - report.assumptions.projection: string; default: not declared - report.calibration: StoredCalibrationOf; default: not declared — The bootstrap's input, verbatim, with live curves as their data and referenced row sets as handles. - report.diagnostics: { embeddedCalibrationBytes: number; fitWarningCount: number; referencedRowSets: string[]; warnings: QuantWarning[]; }; default: not declared - report.diagnostics.embeddedCalibrationBytes: number; default: not declared - report.diagnostics.fitWarningCount: number; default: not declared - report.diagnostics.referencedRowSets: string[]; default: not declared - report.diagnostics.warnings: QuantWarning[]; default: not declared - report.family: F; default: not declared - report.fit: FitOf; default: not declared — The bootstrap's result as its own data (restored exactly by the public constructors). - report.modelVersion: number; default: not declared - report.referencedData: Record; default: not declared - report.summary: FittedModelSummary; default: not declared - report.summary.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - report.summary.convergence.converged: boolean; default: not declared - report.summary.convergence.iterations: number | null; default: not declared - report.summary.convergence.reason?: string; default: not declared - report.summary.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - report.summary.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - report.summary.inputIdentity.calibrationHash: string; default: not declared - report.summary.inputIdentity.snapshotHash: string | null; default: not declared - report.summary.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - report.summary.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - report.summary.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - report.summary.modelRisk.notes: string[]; default: not declared - report.summary.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - report.summary.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - report.summary.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - report.summary.objective.reason?: string; default: not declared — Required exactly when `value` is null. - report.summary.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - report.summary.objective.value: number | null; default: not declared - report.summary.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - report.summary.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - report.summary.residuals.count: number; default: not declared - report.summary.residuals.maximumAbsolute: number | null; default: not declared - report.summary.residuals.rootMeanSquare: number | null; default: not declared - report.summary.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - report.summary.residuals.unit: string; default: not declared - report.summary.warningCount: number; default: not declared - report.summary.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/fixed-income/artifacts#StoredCalibrationOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type StoredCalibrationOf = CurveStoredCalibrations[F]; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#SurvivalCurveData Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A `SurvivalCurve`'s own data — exactly its non-method members. ```typescript /** A `SurvivalCurve`'s own data — exactly its non-method members. */ export interface SurvivalCurveData { referenceDate: string; dayCount: FixedIncomeDayCount; pillars: SurvivalPillar[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount: FixedIncomeDayCount; default: not declared - pillars: SurvivalPillar[]; default: not declared - referenceDate: string; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#SurvivalCurveMeasure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SurvivalCurveMeasure = 'survival' | 'hazard'; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#YieldCurveData Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A `YieldCurve`'s own data — its non-method members plus {@link ZeroRateAtOrigin}. ```typescript /** A `YieldCurve`'s own data — its non-method members plus {@link ZeroRateAtOrigin}. */ export interface YieldCurveData { referenceDate: string; dayCount: FixedIncomeDayCount; interpolation: CurveInterpolation; extrapolation: CurveExtrapolation; zeroRateAtOrigin: ZeroRateAtOrigin; pillars: CurvePillar[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dayCount: FixedIncomeDayCount; default: not declared - extrapolation: CurveExtrapolation; default: not declared - interpolation: CurveInterpolation; default: not declared - pillars: CurvePillar[]; default: not declared - referenceDate: string; default: not declared - zeroRateAtOrigin: ZeroRateAtOrigin; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#YieldCurveMeasure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type YieldCurveMeasure = 'discount' | 'zeroRate' | 'instantaneousForward'; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#ZeroRateAtOrigin Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a curve answers `zeroRate(referenceDate)` when a pillar sits ON the reference date: `'quoted'` echoes that pillar's zero (curves built from zero rates, whose t = 0 pillar is a rate the caller supplied); `'limit'` takes the first segment's t → 0⁺ limit under the curve's interpolation (bootstrapped and discount-factor curves, whose origin pillar is the `DF = 1` anchor with a placeholder zero). The two build identical discount functions; the distinction is stored so a restored curve answers exactly as the live one did. ```typescript /** * How a curve answers `zeroRate(referenceDate)` when a pillar sits ON the reference date: * `'quoted'` echoes that pillar's zero (curves built from zero rates, whose t = 0 pillar is a * rate the caller supplied); `'limit'` takes the first segment's t → 0⁺ limit under the curve's * interpolation (bootstrapped and discount-factor curves, whose origin pillar is the `DF = 1` * anchor with a placeholder zero). The two build identical discount functions; the distinction * is stored so a restored curve answers exactly as the live one did. */ export type ZeroRateAtOrigin = 'quoted' | 'limit'; ``` ### @insiderfinance/totalfinance/fixed-income/artifacts#compareFittedModels Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare two curve fits of one family (Decision 6). ```typescript export declare function compareFittedModels(input: { baseline: CurveFittedModelReport | AnalysisArtifact; candidate: CurveFittedModelReport | AnalysisArtifact; tolerance?: ComparisonTolerance; limits?: ComparisonLimits; }): FittedModelComparison; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { baseline: CurveFittedModelReport | AnalysisArtifact; candidate: CurveFittedModelReport | AnalysisArtifact; tolerance?: ComparisonTolerance; limits?: ComparisonLimits; }; default: not declared - (input).baseline: AnalysisArtifact | CurveFittedModelReport; default: not declared - (input).baseline.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).baseline.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).baseline.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).baseline.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).baseline.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).baseline.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).baseline.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).baseline.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).baseline.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).baseline.schemaVersion: number; default: not declared - (input).baseline.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).candidate: AnalysisArtifact | CurveFittedModelReport; default: not declared - (input).candidate.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).candidate.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).candidate.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).candidate.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).candidate.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).candidate.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).candidate.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).candidate.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).candidate.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).candidate.schemaVersion: number; default: not declared - (input).candidate.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).limits?: ComparisonLimits; default: not declared - (input).tolerance?: ComparisonTolerance; default: not declared - return.artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - return.artifactIds.baseline: string | null; default: not declared - return.artifactIds.candidate: string | null; default: not declared - return.assumptions: { conventionsVersion: string; family: F; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.assumptions.tolerance: ComparisonTolerance | null; default: not declared - return.assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - return.assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - return.convergence: { baseline: boolean; candidate: boolean; }; default: not declared - return.convergence.baseline: boolean; default: not declared - return.convergence.candidate: boolean; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.evaluation: CurveEvaluationDifference[]; default: not declared — One section per measure on the union of both fits' pillar dates (Decision 6's curve rule). - return.family: F; default: not declared - return.fit: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; default: not declared - return.fit.addedPaths: string[]; default: not declared - return.fit.differenceCount: number; default: not declared - return.fit.removedPaths: string[]; default: not declared - return.fit.retainedDifferences: number; default: not declared - return.fit.truncated: boolean; default: not declared - return.objective: { kind: string; unit: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; }; default: not declared - return.objective.absoluteDelta: number | null; default: not declared - return.objective.baselineValue: number | null; default: not declared - return.objective.candidateValue: number | null; default: not declared - return.objective.kind: string; default: not declared - return.objective.unit: string; default: not declared - return.parameters: ParameterDelta[]; default: not declared - return.residuals: { baselineRootMeanSquare: number | null; candidateRootMeanSquare: number | null; absoluteDelta: number | null; }; default: not declared - return.residuals.absoluteDelta: number | null; default: not declared - return.residuals.baselineRootMeanSquare: number | null; default: not declared - return.residuals.candidateRootMeanSquare: number | null; default: not declared - return.sameCalibrationInput: boolean; default: not declared - return.sameCurrency: boolean; default: not declared - return.sameMarket: boolean | null; default: not declared - return.withinTolerance: boolean | null; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#evaluateFittedModel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate a restored curve through its own methods, at dates, in one stated measure. ```typescript export declare function evaluateFittedModel(input: { model: CurveFittedModelReport | AnalysisArtifact; at: EvaluationOf; }): FittedModelEvaluation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { model: CurveFittedModelReport | AnalysisArtifact; at: EvaluationOf; }; default: not declared - (input).at: EvaluationOf; default: not declared - (input).model: AnalysisArtifact | CurveFittedModelReport; default: not declared - (input).model.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).model.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).model.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).model.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).model.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).model.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).model.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).model.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).model.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).model.schemaVersion: number; default: not declared - (input).model.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - return.assumptions: { conventionsVersion: string; family: F; modelVersion: number; currency: string; evaluator: string; options: Record; extrapolation: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.currency: string; default: not declared - return.assumptions.evaluator: string; default: not declared - return.assumptions.extrapolation: string; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.options: Record; default: not declared - return.at: EvaluationOf; default: not declared - return.coordinates: Record[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; outsideCalibratedRange: number; }; default: not declared - return.diagnostics.outsideCalibratedRange: number; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: F; default: not declared - return.reasons: { index: number; reason: string; }[]; default: not declared - return.unit: string; default: not declared - return.values: (number | null)[]; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#fittedModelArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Describe a bootstrap's result and save it as an identified, immutable artifact. ```typescript export declare function fittedModelArtifact(input: FittedModelArtifactInput): AnalysisArtifact; ``` Example (source JSDoc): ```ts const curve = curves.bootstrap(instruments, { referenceDate: '2026-01-01' }); const artifact = fittedModelArtifact({ family: 'discount-curve', fit: curve, calibration: { instruments, options: { referenceDate: '2026-01-01' } }, currency: 'USD', }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FittedModelArtifactInput; default: not declared - (input).calibration: CalibrationOf; default: not declared — The bootstrap's input with its rows and live curves — the adapter stores curve data and mints handles. - (input).createdFrom?: string[]; default: not declared - (input).currency: string; default: not declared - (input).family: F; default: not declared - (input).fit: LiveFitOf; default: not declared — The live result the bootstrap returned (a YieldCurve, a MultiCurve, a SurvivalCurve). - (input).libraryVersion?: string; default: not declared - (input).limits?: FittedModelArtifactLimits; default: not declared - (input).locators?: Record; default: not declared - (input).provenance?: Provenance; default: not declared - (input).referenceRowSets?: readonly string[]; default: not declared - (input).snapshotHash?: string; default: not declared - return.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - return.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - return.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - return.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - return.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - return.kind: 'totalfinance.analysis-artifact'; default: not declared - return.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - return.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - return.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - return.schemaVersion: number; default: not declared - return.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ### @insiderfinance/totalfinance/fixed-income/artifacts#fittedModelHoldout Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit on the retained instruments and reprice the held-out ones with the restored curve through the package's public valuation (Decision 8 — Program 5's residuals for an exact bootstrap). ```typescript export declare function fittedModelHoldout(input: FittedModelHoldoutInput): FittedModelHoldoutReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FittedModelHoldoutInput; default: not declared - (input).calibration: CalibrationOf; default: not declared - (input).family: F; default: not declared - (input).holdout: FittedModelHoldoutSelection; default: not declared - return.assumptions: { conventionsVersion: string; family: F; modelVersion: number; holdout: FittedModelHoldoutSelection; instruments: string; residualSource: 'direct-evaluator'; partition: 'cross-sectional instruments'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.holdout: FittedModelHoldoutSelection; default: not declared - return.assumptions.instruments: string; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.partition: 'cross-sectional instruments'; default: not declared - return.assumptions.residualSource: 'direct-evaluator'; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: F; default: not declared - return.heldOut: { index: number; residual: number; }[]; default: not declared — Per held-out instrument: its index and its repricing residual (curve-implied − quoted). - return.heldOutCount: number; default: not declared - return.inSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; default: not declared - return.inSample.count: number; default: not declared - return.inSample.maximumAbsolute: number | null; default: not declared - return.inSample.rootMeanSquare: number | null; default: not declared - return.outOfSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; default: not declared - return.outOfSample.count: number; default: not declared - return.outOfSample.maximumAbsolute: number | null; default: not declared - return.outOfSample.rootMeanSquare: number | null; default: not declared - return.retainedCount: number; default: not declared - return.retainedFit: FittedModelSummary; default: not declared - return.unit: string; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#readFittedModel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore a curve artifact: Gate B's read door, a foreign-type refusal, the report-level migration policy, report re-validation. ```typescript export declare function readFittedModel(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; }): ReadFittedModelResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).migrations?: ArtifactMigrationRegistry; default: not declared - return.artifact: AnalysisArtifact; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared - return.modelMigrationsApplied: AppliedMigration[]; default: not declared - return.report: CurveFittedModelReport; default: not declared ### @insiderfinance/totalfinance/fixed-income/artifacts#replayFittedModel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-issue the bootstrap from the stored calibration (curves restored exactly, referenced rows verified) and prove byte parity. ```typescript export declare function replayFittedModel(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; libraryVersion?: string; limits?: ComparisonLimits; }): FittedModelReplay; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; libraryVersion?: string; limits?: ComparisonLimits; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).libraryVersion?: string; default: not declared - (input).limits?: ComparisonLimits; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).referencedData?: Record; default: not declared - return.artifactId: string; default: not declared - return.assumptions: { conventionsVersion: string; family: CurveModelFamily; modelVersion: number; calibrator: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; default: not declared - return.assumptions.calibrator: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.family: CurveModelFamily; default: not declared - return.assumptions.libraryVersion: { saved: string | null; current: string | null; }; default: not declared - return.assumptions.libraryVersion.current: string | null; default: not declared - return.assumptions.libraryVersion.saved: string | null; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.referencedRowSets: string[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: CurveModelFamily; default: not declared - return.parity: ArtifactReplayParity; default: not declared - return.recomputed: CurveFittedModelReport; default: not declared ## Entrypoint @insiderfinance/totalfinance/fixed-income/bonds ### @insiderfinance/totalfinance/fixed-income/bonds#Amortization Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#Amortization`. ### @insiderfinance/totalfinance/fixed-income/bonds#AmortizingBondSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#AmortizingBondSpecification`. ### @insiderfinance/totalfinance/fixed-income/bonds#BaseSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BaseSpecification`. ### @insiderfinance/totalfinance/fixed-income/bonds#Bond Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#Bond`. ### @insiderfinance/totalfinance/fixed-income/bonds#BondAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondAssumptions`. ### @insiderfinance/totalfinance/fixed-income/bonds#BondComputed Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondComputed`. ### @insiderfinance/totalfinance/fixed-income/bonds#BondFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFacade`. ### @insiderfinance/totalfinance/fixed-income/bonds#BondKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondKind`. ### @insiderfinance/totalfinance/fixed-income/bonds#BondPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondPrice`. ### @insiderfinance/totalfinance/fixed-income/bonds#CallFeature Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CallFeature`. ### @insiderfinance/totalfinance/fixed-income/bonds#CashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CashFlow`. ### @insiderfinance/totalfinance/fixed-income/bonds#CurveMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CurveMetrics`. ### @insiderfinance/totalfinance/fixed-income/bonds#CurvePricingOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CurvePricingOptions`. ### @insiderfinance/totalfinance/fixed-income/bonds#FixedRateBondSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FixedRateBondSpecification`. ### @insiderfinance/totalfinance/fixed-income/bonds#FloatingRateNoteSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FloatingRateNoteSpecification`. ### @insiderfinance/totalfinance/fixed-income/bonds#InflationLinkedBondSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#InflationLinkedBondSpecification`. ### @insiderfinance/totalfinance/fixed-income/bonds#PriceFromYieldOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#PriceFromYieldOptions`. ### @insiderfinance/totalfinance/fixed-income/bonds#ProjectionContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ProjectionContext`. ### @insiderfinance/totalfinance/fixed-income/bonds#YieldFromPriceOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldFromPriceOptions`. ### @insiderfinance/totalfinance/fixed-income/bonds#YieldMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldMetrics`. ### @insiderfinance/totalfinance/fixed-income/bonds#YieldMetricsOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldMetricsOptions`. ### @insiderfinance/totalfinance/fixed-income/bonds#YieldToCallAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldToCallAssumptions`. ### @insiderfinance/totalfinance/fixed-income/bonds#YieldToCallFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldToCallFacade`. ### @insiderfinance/totalfinance/fixed-income/bonds#ZeroCouponBondSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ZeroCouponBondSpecification`. ### @insiderfinance/totalfinance/fixed-income/bonds#bonds Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#bonds`. ### @insiderfinance/totalfinance/fixed-income/bonds#curveMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#curveMetrics`. ### @insiderfinance/totalfinance/fixed-income/bonds#priceFromYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#priceFromYield`. ### @insiderfinance/totalfinance/fixed-income/bonds#priceMultiCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#priceMultiCurve`. ### @insiderfinance/totalfinance/fixed-income/bonds#yieldMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#yieldMetrics`. ### @insiderfinance/totalfinance/fixed-income/bonds#yieldToCall Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#yieldToCall`. ### @insiderfinance/totalfinance/fixed-income/bonds#yieldToMaturity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#yieldToMaturity`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/conventions ### @insiderfinance/totalfinance/fixed-income/conventions#BusinessDayConvention Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BusinessDayConvention`. ### @insiderfinance/totalfinance/fixed-income/conventions#FixedIncomeDayCount Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FixedIncomeDayCount`. ### @insiderfinance/totalfinance/fixed-income/conventions#Frequency Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#Frequency`. ### @insiderfinance/totalfinance/fixed-income/conventions#ScheduleOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ScheduleOptions`. ### @insiderfinance/totalfinance/fixed-income/conventions#SchedulePeriod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SchedulePeriod`. ### @insiderfinance/totalfinance/fixed-income/conventions#addMonths Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#addMonths`. ### @insiderfinance/totalfinance/fixed-income/conventions#adjustDate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#adjustDate`. ### @insiderfinance/totalfinance/fixed-income/conventions#compareDates Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#compareDates`. ### @insiderfinance/totalfinance/fixed-income/conventions#daysInMonth Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#daysInMonth`. ### @insiderfinance/totalfinance/fixed-income/conventions#daysInYear Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#daysInYear`. ### @insiderfinance/totalfinance/fixed-income/conventions#generateSchedule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#generateSchedule`. ### @insiderfinance/totalfinance/fixed-income/conventions#isEndOfMonth Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#isEndOfMonth`. ### @insiderfinance/totalfinance/fixed-income/conventions#isLeapYear Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#isLeapYear`. ### @insiderfinance/totalfinance/fixed-income/conventions#paymentsPerYear Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#paymentsPerYear`. ### @insiderfinance/totalfinance/fixed-income/conventions#yearFraction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#yearFraction`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/convertible ### @insiderfinance/totalfinance/fixed-income/convertible#ConvertibleBondOption Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ConvertibleBondOption`. ### @insiderfinance/totalfinance/fixed-income/convertible#ConvertibleBondResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ConvertibleBondResult`. ### @insiderfinance/totalfinance/fixed-income/convertible#ConvertibleBondSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ConvertibleBondSpecification`. ### @insiderfinance/totalfinance/fixed-income/convertible#convertibleBond Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#convertibleBond`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/credit ### @insiderfinance/totalfinance/fixed-income/credit#CdsBasisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#CdsBasisInput`. ### @insiderfinance/totalfinance/fixed-income/credit#CdsCurves Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CdsCurves`. ### @insiderfinance/totalfinance/fixed-income/credit#CdsParSpreadAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `cdsParSpread.explain` echoes (FI day-count vocabulary — wider than core's `Assumptions` enum, so the facade construction below carries the same type-level-only cast as `bondFacade`; the runtime shape is exactly the core envelope). ```typescript /** * The par (breakeven) CDS spread: protection leg / risky annuity. Facade (H02): the plain call * returns the scalar; `.explain()` discloses the leg decomposition and every applied convention. */ /** The conventions `cdsParSpread.explain` echoes (FI day-count vocabulary — wider than core's * `Assumptions` enum, so the facade construction below carries the same type-level-only cast as * `bondFacade`; the runtime shape is exactly the core envelope). */ export interface CdsParSpreadAssumptions { conventionsVersion: string; effectiveDate: string; maturityDate: string; recovery: number; notional: number; frequency: Frequency; dayCount: FixedIncomeDayCount; accrualOnDefault: boolean; protectionSteps: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualOnDefault: boolean; default: not declared - conventionsVersion: string; default: not declared - dayCount: FixedIncomeDayCount; default: not declared - effectiveDate: string; default: not declared - frequency: Frequency; default: not declared - maturityDate: string; default: not declared - notional: number; default: not declared - protectionSteps: number; default: not declared - recovery: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/credit#CdsParSpreadFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CdsParSpreadFacade = ((specification: ParCdsSpecification, curves: CdsCurves) => number) & { explain: (specification: ParCdsSpecification, curves: CdsCurves) => Omit, 'assumptions'> & { assumptions: CdsParSpreadAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (curves): CdsCurves; default: not declared - (curves).discountCurve: YieldCurve; default: not declared - (curves).survivalCurve: SurvivalCurve; default: not declared - (specification): ParCdsSpecification; default: not declared - (specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - (specification).dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - (specification).effectiveDate: string; default: not declared - (specification).frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - (specification).maturityDate: string; default: not declared - (specification).notional?: number; default: not declared - (specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - (specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. - explain: (specification: ParCdsSpecification, curves: CdsCurves) => Omit, 'assumptions'> & { assumptions: CdsParSpreadAssumptions; }; default: not declared - explain().return.assumptions: CdsParSpreadAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(curves): CdsCurves; default: not declared - explain(curves).discountCurve: YieldCurve; default: not declared - explain(curves).survivalCurve: SurvivalCurve; default: not declared - explain(specification): ParCdsSpecification; default: not declared - explain(specification).accrualOnDefault?: boolean; default: not declared — Pay premium accrued since the last coupon on default. Default true. - explain(specification).dayCount?: FixedIncomeDayCount; default: not declared — Premium accrual day count. Default `ACT/360`. - explain(specification).effectiveDate: string; default: not declared - explain(specification).frequency?: Frequency; default: not declared — Premium payment frequency. Default quarterly. - explain(specification).maturityDate: string; default: not declared - explain(specification).notional?: number; default: not declared - explain(specification).protectionSteps?: number; default: not declared — Subdivisions per premium period for the protection-leg integral. Default 4. - explain(specification).recovery?: number; default: not declared — Recovery rate on default. Default 0.4. ### @insiderfinance/totalfinance/fixed-income/credit#CdsQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CdsQuote`. ### @insiderfinance/totalfinance/fixed-income/credit#CdsSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CdsSpecification`. ### @insiderfinance/totalfinance/fixed-income/credit#CdsValuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CdsValuation`. ### @insiderfinance/totalfinance/fixed-income/credit#CreditSpreadCurveAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CreditSpreadCurveAssumptions`. ### @insiderfinance/totalfinance/fixed-income/credit#CreditSpreadCurveFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CreditSpreadCurveFacade`. ### @insiderfinance/totalfinance/fixed-income/credit#CreditSpreadPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CreditSpreadPoint`. ### @insiderfinance/totalfinance/fixed-income/credit#CreditTriangleHazardInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#CreditTriangleHazardInput`. ### @insiderfinance/totalfinance/fixed-income/credit#CreditTriangleHazardResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CreditTriangleHazardResult`. ### @insiderfinance/totalfinance/fixed-income/credit#FlatHazardInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#FlatHazardInput`. ### @insiderfinance/totalfinance/fixed-income/credit#HazardBootstrapOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#HazardBootstrapOptions`. ### @insiderfinance/totalfinance/fixed-income/credit#ParCdsSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ParCdsSpecification`. ### @insiderfinance/totalfinance/fixed-income/credit#SurvivalCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SurvivalCurve`. ### @insiderfinance/totalfinance/fixed-income/credit#SurvivalCurveOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SurvivalCurveOptions`. ### @insiderfinance/totalfinance/fixed-income/credit#SurvivalPillar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SurvivalPillar`. ### @insiderfinance/totalfinance/fixed-income/credit#bootstrapHazardFromCds Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#bootstrapHazardFromCds`. ### @insiderfinance/totalfinance/fixed-income/credit#cdsBasis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#cdsBasis`. ### @insiderfinance/totalfinance/fixed-income/credit#cdsParSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#cdsParSpread`. ### @insiderfinance/totalfinance/fixed-income/credit#cdsValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#cdsValue`. ### @insiderfinance/totalfinance/fixed-income/credit#credit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#credit`. ### @insiderfinance/totalfinance/fixed-income/credit#creditSpreadCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#creditSpreadCurve`. ### @insiderfinance/totalfinance/fixed-income/credit#creditTriangleHazard Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#creditTriangleHazard`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/cross-currency ### @insiderfinance/totalfinance/fixed-income/cross-currency#CrossCurrencyBasisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CrossCurrencyBasisInput`. ### @insiderfinance/totalfinance/fixed-income/cross-currency#CrossCurrencyBasisResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CrossCurrencyBasisResult`. ### @insiderfinance/totalfinance/fixed-income/cross-currency#ImpliedCrossCurrencyBasisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ImpliedCrossCurrencyBasisInput`. ### @insiderfinance/totalfinance/fixed-income/cross-currency#ImpliedCrossCurrencyBasisResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ImpliedCrossCurrencyBasisResult`. ### @insiderfinance/totalfinance/fixed-income/cross-currency#crossCurrencyBasisCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#crossCurrencyBasisCurve`. ### @insiderfinance/totalfinance/fixed-income/cross-currency#impliedCrossCurrencyBasis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#impliedCrossCurrencyBasis`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/curves ### @insiderfinance/totalfinance/fixed-income/curves#BootstrapInstrument Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BootstrapInstrument`. ### @insiderfinance/totalfinance/fixed-income/curves#BootstrapOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BootstrapOptions`. ### @insiderfinance/totalfinance/fixed-income/curves#CurveExtrapolation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CurveExtrapolation`. ### @insiderfinance/totalfinance/fixed-income/curves#CurveInterpolation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CurveInterpolation`. ### @insiderfinance/totalfinance/fixed-income/curves#CurveOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CurveOptions`. ### @insiderfinance/totalfinance/fixed-income/curves#CurvePillar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CurvePillar`. ### @insiderfinance/totalfinance/fixed-income/curves#DepositInstrument Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#DepositInstrument`. ### @insiderfinance/totalfinance/fixed-income/curves#FlatCurveInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#FlatCurveInput`. ### @insiderfinance/totalfinance/fixed-income/curves#FraInstrument Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FraInstrument`. ### @insiderfinance/totalfinance/fixed-income/curves#FutureInstrument Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FutureInstrument`. ### @insiderfinance/totalfinance/fixed-income/curves#MultiCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#MultiCurve`. ### @insiderfinance/totalfinance/fixed-income/curves#MultiCurveBootstrapOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#MultiCurveBootstrapOptions`. ### @insiderfinance/totalfinance/fixed-income/curves#ProjectionBootstrapOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ProjectionBootstrapOptions`. ### @insiderfinance/totalfinance/fixed-income/curves#SwapInstrument Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwapInstrument`. ### @insiderfinance/totalfinance/fixed-income/curves#YieldCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldCurve`. ### @insiderfinance/totalfinance/fixed-income/curves#curves Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#curves`. ### @insiderfinance/totalfinance/fixed-income/curves#discountFromZero Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#discountFromZero`. ### @insiderfinance/totalfinance/fixed-income/curves#zeroFromDiscount Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#zeroFromDiscount`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/futures ### @insiderfinance/totalfinance/fixed-income/futures#BondFutureCtdFrontierInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFutureCtdFrontierInput`. ### @insiderfinance/totalfinance/fixed-income/futures#BondFutureCtdFrontierResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFutureCtdFrontierResult`. ### @insiderfinance/totalfinance/fixed-income/futures#BondFutureHedgeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFutureHedgeInput`. ### @insiderfinance/totalfinance/fixed-income/futures#BondFutureHedgeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFutureHedgeResult`. ### @insiderfinance/totalfinance/fixed-income/futures#BondFutureInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFutureInput`. ### @insiderfinance/totalfinance/fixed-income/futures#BondFutureResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondFutureResult`. ### @insiderfinance/totalfinance/fixed-income/futures#ConversionFactorInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ConversionFactorInput`. ### @insiderfinance/totalfinance/fixed-income/futures#ConversionFactorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ConversionFactorResult`. ### @insiderfinance/totalfinance/fixed-income/futures#CtdFrontierScenario Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CtdFrontierScenario`. ### @insiderfinance/totalfinance/fixed-income/futures#CtdSwitch Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CtdSwitch`. ### @insiderfinance/totalfinance/fixed-income/futures#DeliverableAnalysis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#DeliverableAnalysis`. ### @insiderfinance/totalfinance/fixed-income/futures#DeliverableBond Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#DeliverableBond`. ### @insiderfinance/totalfinance/fixed-income/futures#DeliverableRisk Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#DeliverableRisk`. ### @insiderfinance/totalfinance/fixed-income/futures#YieldShiftGrid Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#YieldShiftGrid`. ### @insiderfinance/totalfinance/fixed-income/futures#bondFuture Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#bondFuture`. ### @insiderfinance/totalfinance/fixed-income/futures#bondFutureCtdFrontier Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#bondFutureCtdFrontier`. ### @insiderfinance/totalfinance/fixed-income/futures#bondFutureHedge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#bondFutureHedge`. ### @insiderfinance/totalfinance/fixed-income/futures#conversionFactor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#conversionFactor`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/inflation ### @insiderfinance/totalfinance/fixed-income/inflation#BreakevenInflationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BreakevenInflationInput`. ### @insiderfinance/totalfinance/fixed-income/inflation#BreakevenInflationResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BreakevenInflationResult`. ### @insiderfinance/totalfinance/fixed-income/inflation#CpiSeasonalityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CpiSeasonalityInput`. ### @insiderfinance/totalfinance/fixed-income/inflation#CpiSeasonalityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CpiSeasonalityResult`. ### @insiderfinance/totalfinance/fixed-income/inflation#TipsIndexRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#TipsIndexRatioInput`. ### @insiderfinance/totalfinance/fixed-income/inflation#TipsIndexRatioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#TipsIndexRatioResult`. ### @insiderfinance/totalfinance/fixed-income/inflation#ZeroCouponInflationSwapInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ZeroCouponInflationSwapInput`. ### @insiderfinance/totalfinance/fixed-income/inflation#ZeroCouponInflationSwapResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ZeroCouponInflationSwapResult`. ### @insiderfinance/totalfinance/fixed-income/inflation#breakevenInflation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#breakevenInflation`. ### @insiderfinance/totalfinance/fixed-income/inflation#cpiSeasonality Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#cpiSeasonality`. ### @insiderfinance/totalfinance/fixed-income/inflation#tipsIndexRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#tipsIndexRatio`. ### @insiderfinance/totalfinance/fixed-income/inflation#zeroCouponInflationSwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#zeroCouponInflationSwap`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/lattice ### @insiderfinance/totalfinance/fixed-income/lattice#BermudanSwaptionResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BermudanSwaptionResult`. ### @insiderfinance/totalfinance/fixed-income/lattice#BermudanSwaptionSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BermudanSwaptionSpecification`. ### @insiderfinance/totalfinance/fixed-income/lattice#BondOption Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#BondOption`. ### @insiderfinance/totalfinance/fixed-income/lattice#CallableBondResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CallableBondResult`. ### @insiderfinance/totalfinance/fixed-income/lattice#CallableBondSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CallableBondSpecification`. ### @insiderfinance/totalfinance/fixed-income/lattice#OasAnalyticsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#OasAnalyticsResult`. ### @insiderfinance/totalfinance/fixed-income/lattice#OasAnalyticsSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#OasAnalyticsSpecification`. ### @insiderfinance/totalfinance/fixed-income/lattice#bermudanSwaption Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#bermudanSwaption`. ### @insiderfinance/totalfinance/fixed-income/lattice#callableBond Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#callableBond`. ### @insiderfinance/totalfinance/fixed-income/lattice#oasAnalytics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#oasAnalytics`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/models ### @insiderfinance/totalfinance/fixed-income/models#CirModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CirModel`. ### @insiderfinance/totalfinance/fixed-income/models#CirParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CirParameters`. ### @insiderfinance/totalfinance/fixed-income/models#G2ppDiscountBondInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface G2ppDiscountBondInput { valuationTime: number; timeToMaturity: number; x?: number; y?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - timeToMaturity: number; default: not declared - valuationTime: number; default: not declared - x?: number; default: not declared - y?: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/models#G2ppModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#G2ppModel`. ### @insiderfinance/totalfinance/fixed-income/models#G2ppParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#G2ppParameters`. ### @insiderfinance/totalfinance/fixed-income/models#GaussianShortRateModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#GaussianShortRateModel`. ### @insiderfinance/totalfinance/fixed-income/models#HullWhiteDiscountBondInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HullWhiteDiscountBondInput { valuationTime: number; timeToMaturity: number; shortRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - shortRate: number; default: not declared - timeToMaturity: number; default: not declared - valuationTime: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/models#HullWhiteModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#HullWhiteModel`. ### @insiderfinance/totalfinance/fixed-income/models#HullWhiteParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#HullWhiteParameters`. ### @insiderfinance/totalfinance/fixed-income/models#RateOptionletInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs shared by Gaussian caplet and floorlet methods. ```typescript /** Inputs shared by Gaussian caplet and floorlet methods. */ export interface RateOptionletInput { optionMaturity: number; bondMaturity: number; strikeRate: number; accrualFraction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accrualFraction: number; default: not declared - bondMaturity: number; default: not declared - optionMaturity: number; default: not declared - strikeRate: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/models#ShortRateModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ShortRateModel`. ### @insiderfinance/totalfinance/fixed-income/models#ShortRateMoments Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ShortRateMoments`. ### @insiderfinance/totalfinance/fixed-income/models#ShortRateTree Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ShortRateTree`. ### @insiderfinance/totalfinance/fixed-income/models#ShortRateTreeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ShortRateTreeOptions`. ### @insiderfinance/totalfinance/fixed-income/models#TreeModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#TreeModel`. ### @insiderfinance/totalfinance/fixed-income/models#VasicekParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#VasicekParameters`. ### @insiderfinance/totalfinance/fixed-income/models#ZeroCouponBondOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs shared by Gaussian zero-coupon-bond option methods. ```typescript /** Inputs shared by Gaussian zero-coupon-bond option methods. */ export interface ZeroCouponBondOptionInput { optionMaturity: number; bondMaturity: number; strike: number; right: 'call' | 'put'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bondMaturity: number; default: not declared - optionMaturity: number; default: not declared - right: 'call' | 'put'; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/models#cir Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#cir`. ### @insiderfinance/totalfinance/fixed-income/models#g2pp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#g2pp`. ### @insiderfinance/totalfinance/fixed-income/models#hullWhite Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#hullWhite`. ### @insiderfinance/totalfinance/fixed-income/models#shortRateTree Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#shortRateTree`. ### @insiderfinance/totalfinance/fixed-income/models#vasicek Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#vasicek`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/pricer ### @insiderfinance/totalfinance/fixed-income/pricer#BOND_DISCOUNT_CURVE_PRICER_NAME Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const BOND_DISCOUNT_CURVE_PRICER_NAME: 'fixed-income.bond-discount-curve'; ``` ### @insiderfinance/totalfinance/fixed-income/pricer#BOND_SETTLEMENT_DATE_PROJECTION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const BOND_SETTLEMENT_DATE_PROJECTION: 'UTC calendar date containing valuationInstant'; ``` ### @insiderfinance/totalfinance/fixed-income/pricer#BondDiscountCurvePriceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The complete direct `priceMultiCurve` result plus Gate C's scalar value and adapter disclosures. ```typescript /** * The complete direct `priceMultiCurve` result plus Gate C's scalar value and adapter disclosures. */ export interface BondDiscountCurvePriceResult { value: number; dirtyPrice: number; cleanPrice: number; accruedInterest: number; assumptions: BondDiscountCurvePricerAssumptions; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest: number; default: not declared - assumptions: BondDiscountCurvePricerAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - assumptions.conventionsVersion: string; default: not declared - assumptions.currency: string; default: not declared - assumptions.curveId: string; default: not declared - assumptions.curveReferenceDate: string; default: not declared — The stored curve anchor, preserved exactly rather than silently rolled to valuation time. - assumptions.dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.extrapolation: CurveExtrapolation; default: not declared - assumptions.frequency: number; default: not declared — Coupon payments per year actually used in discounting. - assumptions.interpolation: CurveInterpolation; default: not declared - assumptions.model?: string; default: not declared - assumptions.priceType: 'clean' | 'dirty'; default: not declared — The clean/dirty quote selected as the adapter's numeric `value`. - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.settlementDate: string; default: not declared — Settlement date the result was computed as of. - assumptions.settlementDateProjection: 'UTC calendar date containing valuationInstant'; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.valuationInstant: number; default: not declared — Resolved epoch milliseconds consumed from the valuation-instant observation. - cleanPrice: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - dirtyPrice: number; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/pricer#BondDiscountCurvePricerAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type BondDiscountCurvePricerAssumptions = BondAssumptions & { /** The clean/dirty quote selected as the adapter's numeric `value`. */ priceType: 'clean' | 'dirty'; curveId: string; currency: string; interpolation: CurveInterpolation; extrapolation: CurveExtrapolation; /** Resolved epoch milliseconds consumed from the valuation-instant observation. */ valuationInstant: EpochMs; /** The stored curve anchor, preserved exactly rather than silently rolled to valuation time. */ curveReferenceDate: string; settlementDateProjection: typeof BOND_SETTLEMENT_DATE_PROJECTION; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - businessDayConvention: import('@insiderfinance/totalfinance/fixed-income').BusinessDayConvention; default: not declared — Business-day convention baked into the payment schedule. - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding: 'curve' | 'actuarial'; default: not declared — `actuarial` for yield-based results; `curve` when discounted off a {@link YieldCurve}. - conventionsVersion: string; default: not declared - currency: string; default: not declared - curveId: string; default: not declared - curveReferenceDate: string; default: not declared — The stored curve anchor, preserved exactly rather than silently rolled to valuation time. - dayCount: import('@insiderfinance/totalfinance/fixed-income').FixedIncomeDayCount; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - extrapolation: CurveExtrapolation; default: not declared - frequency: number; default: not declared — Coupon payments per year actually used in discounting. - interpolation: CurveInterpolation; default: not declared - model?: string; default: not declared - priceType: 'clean' | 'dirty'; default: not declared — The clean/dirty quote selected as the adapter's numeric `value`. - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - settlementDate: string; default: not declared — Settlement date the result was computed as of. - settlementDateProjection: 'UTC calendar date containing valuationInstant'; default: not declared - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - valuationInstant: number; default: not declared — Resolved epoch milliseconds consumed from the valuation-instant observation. ### @insiderfinance/totalfinance/fixed-income/pricer#BondDiscountCurvePricerOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BondDiscountCurvePricerOptions { curveId: string; currency: string; priceType: 'clean' | 'dirty'; interpolation: CurveInterpolation; extrapolation: CurveExtrapolation; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - curveId: string; default: not declared - extrapolation: CurveExtrapolation; default: not declared - interpolation: CurveInterpolation; default: not declared - priceType: 'clean' | 'dirty'; default: not declared ### @insiderfinance/totalfinance/fixed-income/pricer#bondDiscountCurvePricer Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adapt the existing fixed-income discount-curve bond pricing path to Gate C. ```typescript export declare function bondDiscountCurvePricer(options: BondDiscountCurvePricerOptions): Pricer; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): BondDiscountCurvePricerOptions; default: not declared - (options).currency: string; default: not declared - (options).curveId: string; default: not declared - (options).extrapolation: CurveExtrapolation; default: not declared - (options).interpolation: CurveInterpolation; default: not declared - (options).priceType: 'clean' | 'dirty'; default: not declared - return.capabilities: import('@insiderfinance/totalfinance/core/pricing').PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - return.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - return.price: (input: PricerPriceInput) => BondDiscountCurvePriceResult; default: not declared - return.priceBatch?: (input: import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput) => readonly BondDiscountCurvePriceResult[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - return.requirements: (instrument: Bond) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - return.supports: (instrument: Bond) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - return.version: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/fixed-income/rates ### @insiderfinance/totalfinance/fixed-income/rates#BachelierKernelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bachelier (normal) kernel: value of an option on a forward, undiscounted. Handles ≤0 forwards/strikes. Named `bachelierKernel` to avoid colliding with the options `bachelier` facade. ```typescript /** * Bachelier (normal) kernel: value of an option on a forward, undiscounted. Handles ≤0 * forwards/strikes. Named `bachelierKernel` to avoid colliding with the options `bachelier` facade. */ export interface BachelierKernelInput { forward: number; strike: number; /** Normal volatility in absolute rate units. */ normalVolatility: number; timeToExpiryYears: number; right: OptionRight; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - normalVolatility: number; default: not declared — Normal volatility in absolute rate units. - right: OptionRight; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/rates#BlackKernelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black-76 kernel: value of an option on a forward, undiscounted. Falls back to intrinsic at T=0 or σ=0. Named `blackKernel` (not `black`) to avoid colliding with the options `black76` facade. ```typescript /** * Black-76 kernel: value of an option on a forward, undiscounted. Falls back to intrinsic * at T=0 or σ=0. Named `blackKernel` (not `black`) to avoid colliding with the options `black76` facade. */ export interface BlackKernelInput { forward: number; strike: number; volatility: number; timeToExpiryYears: number; right: OptionRight; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - right: OptionRight; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/rates#CapFloorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CapFloorResult`. ### @insiderfinance/totalfinance/fixed-income/rates#CapFloorSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CapFloorSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#CapletResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CapletResult`. ### @insiderfinance/totalfinance/fixed-income/rates#CmsConvexityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CmsConvexityInput`. ### @insiderfinance/totalfinance/fixed-income/rates#CmsConvexityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CmsConvexityResult`. ### @insiderfinance/totalfinance/fixed-income/rates#CmsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CmsResult`. ### @insiderfinance/totalfinance/fixed-income/rates#CmsSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#CmsSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#ForwardSwapResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ForwardSwapResult`. ### @insiderfinance/totalfinance/fixed-income/rates#ForwardSwapSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ForwardSwapSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#FraResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FraResult`. ### @insiderfinance/totalfinance/fixed-income/rates#FraSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#FraSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#OptionRight Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#OptionRight`. ### @insiderfinance/totalfinance/fixed-income/rates#ParSwapSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ParSwapSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#RatesVolatilityModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#RatesVolatilityModel`. ### @insiderfinance/totalfinance/fixed-income/rates#SwapCurves Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwapCurves`. ### @insiderfinance/totalfinance/fixed-income/rates#SwapRateAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwapRateAssumptions`. ### @insiderfinance/totalfinance/fixed-income/rates#SwapRateFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwapRateFacade`. ### @insiderfinance/totalfinance/fixed-income/rates#SwapSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwapSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#SwapValuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwapValuation`. ### @insiderfinance/totalfinance/fixed-income/rates#SwaptionResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwaptionResult`. ### @insiderfinance/totalfinance/fixed-income/rates#SwaptionSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#SwaptionSpecification`. ### @insiderfinance/totalfinance/fixed-income/rates#bachelierKernel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function bachelierKernel(input: BachelierKernelInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BachelierKernelInput; default: not declared - (input).forward: number; default: not declared - (input).normalVolatility: number; default: not declared — Normal volatility in absolute rate units. - (input).right: OptionRight; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/rates#blackKernel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function blackKernel(input: BlackKernelInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackKernelInput; default: not declared - (input).forward: number; default: not declared - (input).right: OptionRight; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).volatility: number; default: not declared ### @insiderfinance/totalfinance/fixed-income/rates#capFloorPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#capFloorPrice`. ### @insiderfinance/totalfinance/fixed-income/rates#cmsConvexityAdjustment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#cmsConvexityAdjustment`. ### @insiderfinance/totalfinance/fixed-income/rates#forwardCmsRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#forwardCmsRate`. ### @insiderfinance/totalfinance/fixed-income/rates#forwardSwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#forwardSwap`. ### @insiderfinance/totalfinance/fixed-income/rates#fraValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#fraValue`. ### @insiderfinance/totalfinance/fixed-income/rates#swapRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#swapRate`. ### @insiderfinance/totalfinance/fixed-income/rates#swapValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#swapValue`. ### @insiderfinance/totalfinance/fixed-income/rates#swaptionPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#swaptionPrice`. ## Entrypoint @insiderfinance/totalfinance/fixed-income/xva ### @insiderfinance/totalfinance/fixed-income/xva#ExposurePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#ExposurePoint`. ### @insiderfinance/totalfinance/fixed-income/xva#XvaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#XvaParameters`. ### @insiderfinance/totalfinance/fixed-income/xva#XvaResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#XvaResult`. ### @insiderfinance/totalfinance/fixed-income/xva#XvaSwapSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#XvaSwapSpecification`. ### @insiderfinance/totalfinance/fixed-income/xva#swapXva Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income#swapXva`. ## Entrypoint @insiderfinance/totalfinance/foreign-exchange ### @insiderfinance/totalfinance/foreign-exchange#ConvertCurrencyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link convertCurrency} — the FC5 canonical first-touch shape. ```typescript // --------------------------------------------------------------------------------------------------- // Conversion // --------------------------------------------------------------------------------------------------- /** Input for {@link convertCurrency} — the FC5 canonical first-touch shape. */ export interface ConvertCurrencyInput { /** Amount of `fromCurrency` to convert (any finite sign — a liability converts like an asset). */ amount: number; fromCurrency: string; toCurrency: string; /** A quote connecting the two currencies, in EITHER orientation — inverted internally, disclosed. */ spotRate: CurrencyPairQuote; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Amount of `fromCurrency` to convert (any finite sign — a liability converts like an asset). - fromCurrency: string; default: not declared - spotRate: CurrencyPairQuote; default: not declared — A quote connecting the two currencies, in EITHER orientation — inverted internally, disclosed. - spotRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - spotRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - spotRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - toCurrency: string; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#ConvertCurrencyResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link convertCurrency}. ```typescript /** Result of {@link convertCurrency}. */ export interface ConvertCurrencyResult { convertedAmount: number; assumptions: { fromCurrency: string; toCurrency: string; /** The caller's quote, echoed verbatim. */ quoteUsed: CurrencyPairQuote; /** `'direct'`: multiplied by `quotePerBase`; `'inverted'`: divided by it. */ orientation: 'direct' | 'inverted'; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { fromCurrency: string; orientation: 'direct' | 'inverted'; quoteUsed: CurrencyPairQuote; toCurrency: string; }; default: not declared - assumptions.fromCurrency: string; default: not declared - assumptions.orientation: 'direct' | 'inverted'; default: not declared — `'direct'`: multiplied by `quotePerBase`; `'inverted'`: divided by it. - assumptions.quoteUsed: CurrencyPairQuote; default: not declared — The caller's quote, echoed verbatim. - assumptions.quoteUsed.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - assumptions.quoteUsed.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - assumptions.quoteUsed.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - assumptions.toCurrency: string; default: not declared - convertedAmount: number; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#CoveredInterestParityForwardInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link coveredInterestParityForward}. ```typescript // --------------------------------------------------------------------------------------------------- // Covered interest parity // --------------------------------------------------------------------------------------------------- /** Input for {@link coveredInterestParityForward}. */ export interface CoveredInterestParityForwardInput { spotRate: CurrencyPairQuote; /** Annual rate (decimal) of the QUOTE currency — the 'domestic' leg (USD in EUR/USD). */ domesticAnnualRate: number; /** Annual rate (decimal) of the BASE currency — the 'foreign' leg (EUR in EUR/USD). */ foreignAnnualRate: number; timeYears: number; /** Default `'annual'` — the FC1 ordinary-flow convention, echoed in the assumptions. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - compounding?: InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, echoed in the assumptions. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - domesticAnnualRate: number; default: not declared — Annual rate (decimal) of the QUOTE currency — the 'domestic' leg (USD in EUR/USD). - foreignAnnualRate: number; default: not declared — Annual rate (decimal) of the BASE currency — the 'foreign' leg (EUR in EUR/USD). - spotRate: CurrencyPairQuote; default: not declared - spotRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - spotRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - spotRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - timeYears: number; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#CoveredInterestParityForwardResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link coveredInterestParityForward}. ```typescript /** Result of {@link coveredInterestParityForward}. */ export interface CoveredInterestParityForwardResult { /** The parity forward for the SAME pair as the spot quote. */ forwardRate: CurrencyPairQuote; assumptions: { rateRoles: 'domestic = quote currency, foreign = base currency'; compounding: InterestCompounding; timeYears: number; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { compounding: InterestCompounding; rateRoles: 'domestic = quote currency, foreign = base currency'; timeYears: number; }; default: not declared - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.rateRoles: 'domestic = quote currency, foreign = base currency'; default: not declared - assumptions.timeYears: number; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - forwardRate: CurrencyPairQuote; default: not declared — The parity forward for the SAME pair as the spot quote. - forwardRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - forwardRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - forwardRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#CrossRateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link crossRate}. ```typescript // --------------------------------------------------------------------------------------------------- // Cross rates // --------------------------------------------------------------------------------------------------- /** Input for {@link crossRate}. */ export interface CrossRateInput { firstQuote: CurrencyPairQuote; secondQuote: CurrencyPairQuote; /** Base currency of the derived cross pair — one of the two non-shared currencies. */ crossBaseCurrency: string; /** Quote currency of the derived cross pair — the other non-shared currency. */ crossQuoteCurrency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - crossBaseCurrency: string; default: not declared — Base currency of the derived cross pair — one of the two non-shared currencies. - crossQuoteCurrency: string; default: not declared — Quote currency of the derived cross pair — the other non-shared currency. - firstQuote: CurrencyPairQuote; default: not declared - firstQuote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - firstQuote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - firstQuote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - secondQuote: CurrencyPairQuote; default: not declared - secondQuote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - secondQuote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - secondQuote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#CrossRateResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link crossRate}. ```typescript /** Result of {@link crossRate}. */ export interface CrossRateResult { /** The derived cross pair, oriented as requested. */ quote: CurrencyPairQuote; assumptions: { /** The ONE currency the two supplied quotes share — the leg the cross goes through. */ throughCurrency: string; /** The exact arithmetic, with each leg's source quote and orientation named. */ derivation: string; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { derivation: string; throughCurrency: string; }; default: not declared - assumptions.derivation: string; default: not declared — The exact arithmetic, with each leg's source quote and orientation named. - assumptions.throughCurrency: string; default: not declared — The ONE currency the two supplied quotes share — the leg the cross goes through. - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - quote: CurrencyPairQuote; default: not declared — The derived cross pair, oriented as requested. - quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#CurrencyExposureInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link currencyExposure}. ```typescript /** Input for {@link currencyExposure}. */ export interface CurrencyExposureInput { positions: CurrencyExposurePosition[]; /** The reporting currency every value is restated into. */ baseCurrency: string; /** * Enough quotes to connect every position currency to the base currency, in either orientation. * A currency with no connecting quote has its positions excluded WITH reason — never guessed. */ spotRates: CurrencyPairQuote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared — The reporting currency every value is restated into. - positions: CurrencyExposurePosition[]; default: not declared - spotRates: CurrencyPairQuote[]; default: not declared — Enough quotes to connect every position currency to the base currency, in either orientation. A currency with no connecting quote has its positions excluded WITH reason — never guessed. ### @insiderfinance/totalfinance/foreign-exchange#CurrencyExposurePosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One position handed to {@link currencyExposure}. ```typescript // --------------------------------------------------------------------------------------------------- // Currency exposure // --------------------------------------------------------------------------------------------------- /** One position handed to {@link currencyExposure}. */ export interface CurrencyExposurePosition { /** The caller's identifier for the position — echoed in exclusions so they stay attributable. */ positionLabel: string; /** Uppercase three-letter code of the currency the position is denominated in. */ currency: string; /** Market value in the position's OWN currency (negative for shorts/liabilities). */ marketValueInPositionCurrency: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared — Uppercase three-letter code of the currency the position is denominated in. - marketValueInPositionCurrency: number; default: not declared — Market value in the position's OWN currency (negative for shorts/liabilities). - positionLabel: string; default: not declared — The caller's identifier for the position — echoed in exclusions so they stay attributable. ### @insiderfinance/totalfinance/foreign-exchange#CurrencyExposureQuoteUse Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How one currency was restated into the base currency. ```typescript /** How one currency was restated into the base currency. */ export interface CurrencyExposureQuoteUse { currency: string; /** The caller's quote, echoed verbatim. */ quote: CurrencyPairQuote; /** `'direct'`: multiplied by `quotePerBase`; `'inverted'`: divided by it. */ orientation: 'direct' | 'inverted'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - orientation: 'direct' | 'inverted'; default: not declared — `'direct'`: multiplied by `quotePerBase`; `'inverted'`: divided by it. - quote: CurrencyPairQuote; default: not declared — The caller's quote, echoed verbatim. - quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#CurrencyExposureResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link currencyExposure}. ```typescript /** Result of {@link currencyExposure}. */ export interface CurrencyExposureResult { /** Sum of every INCLUDED position's value in the base currency. */ totalBaseValue: number; /** Per-currency rows in first-appearance order, included currencies only. */ byCurrency: CurrencyExposureRow[]; excludedPositions: ExcludedCurrencyExposurePosition[]; assumptions: { baseCurrency: string; /** The fixed policy prose: a position with no connecting quote is excluded with its reason. */ missingPairPolicy: string; /** Which quote restated each non-base currency, and in which orientation. */ quotesUsed: CurrencyExposureQuoteUse[]; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { baseCurrency: string; missingPairPolicy: string; quotesUsed: CurrencyExposureQuoteUse[]; }; default: not declared - assumptions.baseCurrency: string; default: not declared - assumptions.missingPairPolicy: string; default: not declared — The fixed policy prose: a position with no connecting quote is excluded with its reason. - assumptions.quotesUsed: CurrencyExposureQuoteUse[]; default: not declared — Which quote restated each non-base currency, and in which orientation. - byCurrency: CurrencyExposureRow[]; default: not declared — Per-currency rows in first-appearance order, included currencies only. - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - excludedPositions: ExcludedCurrencyExposurePosition[]; default: not declared - totalBaseValue: number; default: not declared — Sum of every INCLUDED position's value in the base currency. ### @insiderfinance/totalfinance/foreign-exchange#CurrencyExposureRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One aggregated per-currency exposure row. ```typescript /** One aggregated per-currency exposure row. */ export interface CurrencyExposureRow { currency: string; positionCount: number; /** Sum of position values in the row's own currency. */ valueInCurrency: number; /** The same sum restated in the base currency at the supplied quote. */ valueInBaseCurrency: number; /** Share of `totalBaseValue`; `null` (with a warning) when the total is exactly zero. */ exposureFraction: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - exposureFraction: number | null; default: not declared — Share of `totalBaseValue`; `null` (with a warning) when the total is exactly zero. - positionCount: number; default: not declared - valueInBaseCurrency: number; default: not declared — The same sum restated in the base currency at the supplied quote. - valueInCurrency: number; default: not declared — Sum of position values in the row's own currency. ### @insiderfinance/totalfinance/foreign-exchange#CurrencyPairQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One foreign-exchange quote. `quotePerBase` is the price of ONE unit of `baseCurrency` expressed in `quoteCurrency` — EUR/USD 1.08 is `{ baseCurrency: 'EUR', quoteCurrency: 'USD', quotePerBase: 1.08 }`: one euro costs 1.08 dollars. ```typescript // --------------------------------------------------------------------------------------------------- // The pair contract and its guards // --------------------------------------------------------------------------------------------------- /** * One foreign-exchange quote. `quotePerBase` is the price of ONE unit of `baseCurrency` expressed * in `quoteCurrency` — EUR/USD 1.08 is `{ baseCurrency: 'EUR', quoteCurrency: 'USD', * quotePerBase: 1.08 }`: one euro costs 1.08 dollars. */ export interface CurrencyPairQuote { /** Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). */ baseCurrency: string; /** Uppercase three-letter ISO-style code of the currency the price is expressed in. */ quoteCurrency: string; /** Units of quote currency per ONE base unit; must be finite and > 0. */ quotePerBase: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#ExcludedCurrencyExposurePosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One excluded position, with the reason it could not participate. ```typescript /** One excluded position, with the reason it could not participate. */ export interface ExcludedCurrencyExposurePosition { positionLabel: string; reason: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - positionLabel: string; default: not declared - reason: string; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnostics every FC5 analysis result carries (the FC2 result grammar). ```typescript // --------------------------------------------------------------------------------------------------- // The result grammar // --------------------------------------------------------------------------------------------------- /** Diagnostics every FC5 analysis result carries (the FC2 result grammar). */ export interface ForeignExchangeDiagnostics { warnings: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - warnings: string[]; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardPointsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link foreignExchangeForwardPoints}. ```typescript // --------------------------------------------------------------------------------------------------- // Forward points // --------------------------------------------------------------------------------------------------- /** Input for {@link foreignExchangeForwardPoints}. */ export interface ForeignExchangeForwardPointsInput { spotRate: CurrencyPairQuote; /** The forward for the SAME pair in the SAME direction. */ forwardRate: CurrencyPairQuote; /** The size of one point in quotePerBase units (e.g. `0.0001` for EUR/USD). REQUIRED — never guessed. */ pointSize: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forwardRate: CurrencyPairQuote; default: not declared — The forward for the SAME pair in the SAME direction. - forwardRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - forwardRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - forwardRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - pointSize: number; default: not declared — The size of one point in quotePerBase units (e.g. `0.0001` for EUR/USD). REQUIRED — never guessed. - spotRate: CurrencyPairQuote; default: not declared - spotRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - spotRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - spotRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardPointsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link foreignExchangeForwardPoints}. ```typescript /** Result of {@link foreignExchangeForwardPoints}. */ export interface ForeignExchangeForwardPointsResult { forwardPoints: number; assumptions: { pointSize: number; pointSizeSource: 'explicit'; formula: 'forwardPoints = (forwardRate.quotePerBase − spotRate.quotePerBase) / pointSize'; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { formula: 'forwardPoints = (forwardRate.quotePerBase \u2212 spotRate.quotePerBase) / pointSize'; pointSize: number; pointSizeSource: 'explicit'; }; default: not declared - assumptions.formula: 'forwardPoints = (forwardRate.quotePerBase − spotRate.quotePerBase) / pointSize'; default: not declared - assumptions.pointSize: number; default: not declared - assumptions.pointSizeSource: 'explicit'; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - forwardPoints: number; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link foreignExchangeForwardValue} — also one leg of {@link foreignExchangeSwapValue}. ```typescript // --------------------------------------------------------------------------------------------------- // Forward valuation // --------------------------------------------------------------------------------------------------- /** Input for {@link foreignExchangeForwardValue} — also one leg of {@link foreignExchangeSwapValue}. */ export interface ForeignExchangeForwardValueInput { /** The rate contracted at inception, for the pair being valued. */ contractRate: CurrencyPairQuote; /** Today's forward to the SAME settlement date, SAME pair, SAME direction. */ currentForwardRate: CurrencyPairQuote; /** Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. */ notionalBaseAmount: number; /** * An explicit discount factor in the QUOTE currency to the settlement date. A factor, not a * rate — the matched-conventions law: accepting a rate here would let day-count and compounding * conventions mismatch silently against the forward's own quotation. */ discountFactorToSettlement: number; /** Which side is being valued: the buyer of the base currency, or the seller. */ perspective: 'buyer-of-base' | 'seller-of-base'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contractRate: CurrencyPairQuote; default: not declared — The rate contracted at inception, for the pair being valued. - contractRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - contractRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - contractRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - currentForwardRate: CurrencyPairQuote; default: not declared — Today's forward to the SAME settlement date, SAME pair, SAME direction. - currentForwardRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - currentForwardRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - currentForwardRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - discountFactorToSettlement: number; default: not declared — An explicit discount factor in the QUOTE currency to the settlement date. A factor, not a rate — the matched-conventions law: accepting a rate here would let day-count and compounding conventions mismatch silently against the forward's own quotation. - notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared — Which side is being valued: the buyer of the base currency, or the seller. ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardValueResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link foreignExchangeForwardValue}. ```typescript /** Result of {@link foreignExchangeForwardValue}. */ export interface ForeignExchangeForwardValueResult { /** Present value of the position in the QUOTE currency; zero at the contracted fair forward. */ forwardValueInQuoteCurrency: number; assumptions: { perspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; perspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; default: not declared - assumptions.discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; default: not declared - assumptions.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - assumptions.signConvention: string; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - forwardValueInQuoteCurrency: number; default: not declared — Present value of the position in the QUOTE currency; zero at the contracted fair forward. ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeSwapValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link foreignExchangeSwapValue}: two forward legs on the SAME pair. ```typescript // --------------------------------------------------------------------------------------------------- // Swap valuation // --------------------------------------------------------------------------------------------------- /** Input for {@link foreignExchangeSwapValue}: two forward legs on the SAME pair. */ export interface ForeignExchangeSwapValueInput { nearLeg: ForeignExchangeForwardValueInput; farLeg: ForeignExchangeForwardValueInput; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - farLeg: ForeignExchangeForwardValueInput; default: not declared - farLeg.contractRate: CurrencyPairQuote; default: not declared — The rate contracted at inception, for the pair being valued. - farLeg.contractRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - farLeg.contractRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - farLeg.contractRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - farLeg.currentForwardRate: CurrencyPairQuote; default: not declared — Today's forward to the SAME settlement date, SAME pair, SAME direction. - farLeg.currentForwardRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - farLeg.currentForwardRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - farLeg.currentForwardRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - farLeg.discountFactorToSettlement: number; default: not declared — An explicit discount factor in the QUOTE currency to the settlement date. A factor, not a rate — the matched-conventions law: accepting a rate here would let day-count and compounding conventions mismatch silently against the forward's own quotation. - farLeg.notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - farLeg.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared — Which side is being valued: the buyer of the base currency, or the seller. - nearLeg: ForeignExchangeForwardValueInput; default: not declared - nearLeg.contractRate: CurrencyPairQuote; default: not declared — The rate contracted at inception, for the pair being valued. - nearLeg.contractRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - nearLeg.contractRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - nearLeg.contractRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - nearLeg.currentForwardRate: CurrencyPairQuote; default: not declared — Today's forward to the SAME settlement date, SAME pair, SAME direction. - nearLeg.currentForwardRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - nearLeg.currentForwardRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - nearLeg.currentForwardRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - nearLeg.discountFactorToSettlement: number; default: not declared — An explicit discount factor in the QUOTE currency to the settlement date. A factor, not a rate — the matched-conventions law: accepting a rate here would let day-count and compounding conventions mismatch silently against the forward's own quotation. - nearLeg.notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - nearLeg.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared — Which side is being valued: the buyer of the base currency, or the seller. ### @insiderfinance/totalfinance/foreign-exchange#ForeignExchangeSwapValueResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link foreignExchangeSwapValue}. ```typescript /** Result of {@link foreignExchangeSwapValue}. */ export interface ForeignExchangeSwapValueResult { /** `nearLegValue + farLegValue`, in the pair's QUOTE currency. */ swapValueInQuoteCurrency: number; nearLegValue: number; farLegValue: number; assumptions: { composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; farLegPerspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; farLegPerspective: 'buyer-of-base' | 'seller-of-base'; nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; default: not declared - assumptions.composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; default: not declared - assumptions.farLegPerspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - assumptions.nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - assumptions.signConvention: string; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - farLegValue: number; default: not declared - nearLegValue: number; default: not declared - swapValueInQuoteCurrency: number; default: not declared — `nearLegValue + farLegValue`, in the pair's QUOTE currency. ### @insiderfinance/totalfinance/foreign-exchange#HEDGED_PROFIT_AND_LOSS_DECOMPOSITION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The exact decomposition prose, frozen so tests and docs can quote it. ```typescript export declare const HEDGED_PROFIT_AND_LOSS_DECOMPOSITION: 'totalProfitAndLossInQuoteCurrency = (1 − hedgedFraction) × (finalSpotRate.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount + hedgedFraction × (forwardRateAtHedge.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount, every term in the quote currency'; ``` ### @insiderfinance/totalfinance/foreign-exchange#HedgeRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link hedgeRatio}. ```typescript // --------------------------------------------------------------------------------------------------- // Hedge ratio // --------------------------------------------------------------------------------------------------- /** Input for {@link hedgeRatio}. */ export interface HedgeRatioInput { /** The exposure being hedged, in base-currency units (sign allowed — a short exposure is negative). */ exposureBaseAmount: number; /** The hedge's notional, in the same base-currency units. */ hedgeNotionalBaseAmount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exposureBaseAmount: number; default: not declared — The exposure being hedged, in base-currency units (sign allowed — a short exposure is negative). - hedgeNotionalBaseAmount: number; default: not declared — The hedge's notional, in the same base-currency units. ### @insiderfinance/totalfinance/foreign-exchange#HedgeRatioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link hedgeRatio}. ```typescript /** Result of {@link hedgeRatio}. */ export interface HedgeRatioResult { /** `hedgeNotionalBaseAmount / exposureBaseAmount`; `null` when the exposure is exactly zero. */ hedgeRatio: number | null; /** Present exactly when `hedgeRatio` is null. */ hedgeRatioAbsentReason?: string; assumptions: { exposureBaseAmount: number; hedgeNotionalBaseAmount: number; definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; exposureBaseAmount: number; hedgeNotionalBaseAmount: number; }; default: not declared - assumptions.definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; default: not declared - assumptions.exposureBaseAmount: number; default: not declared - assumptions.hedgeNotionalBaseAmount: number; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - hedgeRatio: number | null; default: not declared — `hedgeNotionalBaseAmount / exposureBaseAmount`; `null` when the exposure is exactly zero. - hedgeRatioAbsentReason?: string; default: not declared — Present exactly when `hedgeRatio` is null. ### @insiderfinance/totalfinance/foreign-exchange#InvertCurrencyPairQuoteInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link invertCurrencyPairQuote}. ```typescript // --------------------------------------------------------------------------------------------------- // Inversion // --------------------------------------------------------------------------------------------------- /** Input for {@link invertCurrencyPairQuote}. */ export interface InvertCurrencyPairQuoteInput { quote: CurrencyPairQuote; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - quote: CurrencyPairQuote; default: not declared - quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#InvertCurrencyPairQuoteResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link invertCurrencyPairQuote}. ```typescript /** Result of {@link invertCurrencyPairQuote}. */ export interface InvertCurrencyPairQuoteResult { /** The flipped pair: base and quote swapped, `quotePerBase` reciprocated. */ quote: CurrencyPairQuote; assumptions: { inversion: '1 / quotePerBase'; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { inversion: '1 / quotePerBase'; }; default: not declared - assumptions.inversion: '1 / quotePerBase'; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - quote: CurrencyPairQuote; default: not declared — The flipped pair: base and quote swapped, `quotePerBase` reciprocated. - quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#NonDeliverableForwardValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link nonDeliverableForwardValue}. ```typescript // --------------------------------------------------------------------------------------------------- // Non-deliverable forwards // --------------------------------------------------------------------------------------------------- /** Input for {@link nonDeliverableForwardValue}. */ export interface NonDeliverableForwardValueInput { /** The rate contracted at inception. */ contractRate: CurrencyPairQuote; /** The OBSERVED fixing for the SAME pair — caller-supplied, never fetched or guessed. */ fixingRate: CurrencyPairQuote; /** Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. */ notionalBaseAmount: number; /** Where cash settles. v1 supports ONLY the pair's quote currency; anything else is rejected. */ settlementCurrency: string; /** An explicit discount factor in the settlement (quote) currency to the settlement date. */ discountFactorToSettlement: number; perspective: 'buyer-of-base' | 'seller-of-base'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contractRate: CurrencyPairQuote; default: not declared — The rate contracted at inception. - contractRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - contractRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - contractRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - discountFactorToSettlement: number; default: not declared — An explicit discount factor in the settlement (quote) currency to the settlement date. - fixingRate: CurrencyPairQuote; default: not declared — The OBSERVED fixing for the SAME pair — caller-supplied, never fetched or guessed. - fixingRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - fixingRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - fixingRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - settlementCurrency: string; default: not declared — Where cash settles. v1 supports ONLY the pair's quote currency; anything else is rejected. ### @insiderfinance/totalfinance/foreign-exchange#NonDeliverableForwardValueResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link nonDeliverableForwardValue}. ```typescript /** Result of {@link nonDeliverableForwardValue}. */ export interface NonDeliverableForwardValueResult { /** The discounted cash settlement, in the settlement (= quote) currency. */ nonDeliverableForwardValueInSettlementCurrency: number; assumptions: { fixingSource: 'caller-supplied fixing rate'; settlementCurrency: string; /** The fixed v1 constraint prose: settlement in the pair's quote currency only. */ settlementConstraint: string; perspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { fixingSource: 'caller-supplied fixing rate'; perspective: 'buyer-of-base' | 'seller-of-base'; settlementConstraint: string; settlementCurrency: string; signConvention: string; }; default: not declared - assumptions.fixingSource: 'caller-supplied fixing rate'; default: not declared - assumptions.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - assumptions.settlementConstraint: string; default: not declared — The fixed v1 constraint prose: settlement in the pair's quote currency only. - assumptions.settlementCurrency: string; default: not declared - assumptions.signConvention: string; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - nonDeliverableForwardValueInSettlementCurrency: number; default: not declared — The discounted cash settlement, in the settlement (= quote) currency. ### @insiderfinance/totalfinance/foreign-exchange#PipValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link pipValue}. ```typescript // --------------------------------------------------------------------------------------------------- // Pip value // --------------------------------------------------------------------------------------------------- /** Input for {@link pipValue}. */ export interface PipValueInput { quote: CurrencyPairQuote; /** * The size of one pip in quote-currency units per base unit (e.g. `0.0001` for EUR/USD, * `0.01` for USD/JPY). REQUIRED — never guessed from symbol spelling (FC5 law). */ pipSize: number; /** Position notional, expressed in `notionalCurrency` units. */ notionalAmount: number; /** Which currency the notional is stated in — must be the pair's base or quote currency. */ notionalCurrency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - notionalAmount: number; default: not declared — Position notional, expressed in `notionalCurrency` units. - notionalCurrency: string; default: not declared — Which currency the notional is stated in — must be the pair's base or quote currency. - pipSize: number; default: not declared — The size of one pip in quote-currency units per base unit (e.g. `0.0001` for EUR/USD, `0.01` for USD/JPY). REQUIRED — never guessed from symbol spelling (FC5 law). - quote: CurrencyPairQuote; default: not declared - quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#PipValueResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link pipValue}. ```typescript /** Result of {@link pipValue}. */ export interface PipValueResult { /** Value of a one-pip move in the QUOTE currency. */ pipValueInQuoteCurrency: number; /** The same value converted to the base currency at the supplied spot quote. */ pipValueInBaseCurrency: number; assumptions: { pipSize: number; pipSizeSource: 'explicit'; notionalCurrency: string; /** How the notional was read: already in base units, or converted from quote units at spot. */ notionalCurrencyRole: 'base' | 'quote'; baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; notionalCurrency: string; notionalCurrencyRole: 'base' | 'quote'; pipSize: number; pipSizeSource: 'explicit'; }; default: not declared - assumptions.baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; default: not declared - assumptions.notionalCurrency: string; default: not declared - assumptions.notionalCurrencyRole: 'base' | 'quote'; default: not declared — How the notional was read: already in base units, or converted from quote units at spot. - assumptions.pipSize: number; default: not declared - assumptions.pipSizeSource: 'explicit'; default: not declared - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - pipValueInBaseCurrency: number; default: not declared — The same value converted to the base currency at the supplied spot quote. - pipValueInQuoteCurrency: number; default: not declared — Value of a one-pip move in the QUOTE currency. ### @insiderfinance/totalfinance/foreign-exchange#SpotForwardHedgedProfitAndLossInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link spotForwardHedgedProfitAndLoss}. ```typescript // --------------------------------------------------------------------------------------------------- // Spot/forward hedged P&L // --------------------------------------------------------------------------------------------------- /** Input for {@link spotForwardHedgedProfitAndLoss}. */ export interface SpotForwardHedgedProfitAndLossInput { /** The spot when the position was opened. */ initialSpotRate: CurrencyPairQuote; /** The spot at measurement, SAME pair, SAME direction. */ finalSpotRate: CurrencyPairQuote; /** The forward locked when the hedge was placed. REQUIRED whenever `hedgedFraction` > 0. */ forwardRateAtHedge?: CurrencyPairQuote; /** Fraction of the notional hedged at the forward, in [0, 1]. */ hedgedFraction: number; /** Position size in BASE-currency units; positive = long the base currency, negative flips every sign. */ notionalBaseAmount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - finalSpotRate: CurrencyPairQuote; default: not declared — The spot at measurement, SAME pair, SAME direction. - finalSpotRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - finalSpotRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - finalSpotRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - forwardRateAtHedge?: CurrencyPairQuote; default: not declared — The forward locked when the hedge was placed. REQUIRED whenever `hedgedFraction` > 0. - forwardRateAtHedge.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - forwardRateAtHedge.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - forwardRateAtHedge.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - hedgedFraction: number; default: not declared — Fraction of the notional hedged at the forward, in [0, 1]. - initialSpotRate: CurrencyPairQuote; default: not declared — The spot when the position was opened. - initialSpotRate.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - initialSpotRate.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - initialSpotRate.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - notionalBaseAmount: number; default: not declared — Position size in BASE-currency units; positive = long the base currency, negative flips every sign. ### @insiderfinance/totalfinance/foreign-exchange#SpotForwardHedgedProfitAndLossResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link spotForwardHedgedProfitAndLoss}. ```typescript /** Result of {@link spotForwardHedgedProfitAndLoss}. */ export interface SpotForwardHedgedProfitAndLossResult { totalProfitAndLossInQuoteCurrency: number; /** `(1 − hedgedFraction) × (finalSpot − initialSpot) × notional` — the part left floating. */ unhedgedComponent: number; /** `hedgedFraction × (forwardRateAtHedge − initialSpot) × notional` — the part locked at the forward. */ hedgedComponent: number; assumptions: { decomposition: typeof HEDGED_PROFIT_AND_LOSS_DECOMPOSITION; hedgedFraction: number; /** The fixed direction prose: positive notional is long the base; negative flips every sign. */ notionalDirection: string; }; diagnostics: ForeignExchangeDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { decomposition: typeof HEDGED_PROFIT_AND_LOSS_DECOMPOSITION; hedgedFraction: number; notionalDirection: string; }; default: not declared - assumptions.decomposition: 'totalProfitAndLossInQuoteCurrency = (1 − hedgedFraction) × (finalSpotRate.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount + hedgedFraction × (forwardRateAtHedge.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount, every term in the quote currency'; default: not declared - assumptions.hedgedFraction: number; default: not declared - assumptions.notionalDirection: string; default: not declared — The fixed direction prose: positive notional is long the base; negative flips every sign. - diagnostics: ForeignExchangeDiagnostics; default: not declared - diagnostics.warnings: string[]; default: not declared - hedgedComponent: number; default: not declared — `hedgedFraction × (forwardRateAtHedge − initialSpot) × notional` — the part locked at the forward. - totalProfitAndLossInQuoteCurrency: number; default: not declared - unhedgedComponent: number; default: not declared — `(1 − hedgedFraction) × (finalSpot − initialSpot) × notional` — the part left floating. ### @insiderfinance/totalfinance/foreign-exchange#convertCurrency Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert an amount between two currencies at the supplied spot quote. The quote must connect the two currencies; when it is oriented the other way the conversion divides instead of multiplies and the result discloses `orientation: 'inverted'`. Converting there and back with the same quote returns the original amount (the round-trip identity, tested at 1e-12). A same-currency conversion with a quote supplied is rejected — the identity conversion needs no quote. ```typescript export declare function convertCurrency(input: ConvertCurrencyInput): ConvertCurrencyResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ConvertCurrencyInput; default: not declared - (input).amount: number; default: not declared — Amount of `fromCurrency` to convert (any finite sign — a liability converts like an asset). - (input).fromCurrency: string; default: not declared - (input).spotRate: CurrencyPairQuote; default: not declared — A quote connecting the two currencies, in EITHER orientation — inverted internally, disclosed. - (input).toCurrency: string; default: not declared - return.assumptions: { fromCurrency: string; orientation: 'direct' | 'inverted'; quoteUsed: CurrencyPairQuote; toCurrency: string; }; default: not declared - return.assumptions.fromCurrency: string; default: not declared - return.assumptions.orientation: 'direct' | 'inverted'; default: not declared — `'direct'`: multiplied by `quotePerBase`; `'inverted'`: divided by it. - return.assumptions.quoteUsed: CurrencyPairQuote; default: not declared — The caller's quote, echoed verbatim. - return.assumptions.toCurrency: string; default: not declared - return.convertedAmount: number; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#coveredInterestParityForward Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The no-arbitrage forward: `forward = spot × growthFactor(domestic) / growthFactor(foreign)`. The DOMESTIC rate is the QUOTE currency's rate and the FOREIGN rate is the BASE currency's rate — investing the converted amount at the domestic rate must equal investing one base unit at the foreign rate and converting at this forward (the covered-interest-parity round trip, tested at 1e-12). Under continuous compounding this is exactly `spot × e^((domestic − foreign) × t)`. ```typescript export declare function coveredInterestParityForward(input: CoveredInterestParityForwardInput): CoveredInterestParityForwardResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CoveredInterestParityForwardInput; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, echoed in the assumptions. - (input).domesticAnnualRate: number; default: not declared — Annual rate (decimal) of the QUOTE currency — the 'domestic' leg (USD in EUR/USD). - (input).foreignAnnualRate: number; default: not declared — Annual rate (decimal) of the BASE currency — the 'foreign' leg (EUR in EUR/USD). - (input).spotRate: CurrencyPairQuote; default: not declared - (input).timeYears: number; default: not declared - return.assumptions: { compounding: InterestCompounding; rateRoles: 'domestic = quote currency, foreign = base currency'; timeYears: number; }; default: not declared - return.assumptions.compounding: InterestCompounding; default: not declared - return.assumptions.rateRoles: 'domestic = quote currency, foreign = base currency'; default: not declared - return.assumptions.timeYears: number; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.forwardRate: CurrencyPairQuote; default: not declared — The parity forward for the SAME pair as the spot quote. ### @insiderfinance/totalfinance/foreign-exchange#crossRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Derive a cross pair through the ONE currency the two supplied quotes share (EUR/USD × USD/JPY → EUR/JPY). Every orientation case is handled by explicit inversion, and the derivation prose in the assumptions shows each leg's price, source quote, and orientation. Quotes sharing zero or both currencies are rejected with the currencies named — there is no cross to derive. ```typescript export declare function crossRate(input: CrossRateInput): CrossRateResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CrossRateInput; default: not declared - (input).crossBaseCurrency: string; default: not declared — Base currency of the derived cross pair — one of the two non-shared currencies. - (input).crossQuoteCurrency: string; default: not declared — Quote currency of the derived cross pair — the other non-shared currency. - (input).firstQuote: CurrencyPairQuote; default: not declared - (input).secondQuote: CurrencyPairQuote; default: not declared - return.assumptions: { derivation: string; throughCurrency: string; }; default: not declared - return.assumptions.derivation: string; default: not declared — The exact arithmetic, with each leg's source quote and orientation named. - return.assumptions.throughCurrency: string; default: not declared — The ONE currency the two supplied quotes share — the leg the cross goes through. - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.quote: CurrencyPairQuote; default: not declared — The derived cross pair, oriented as requested. ### @insiderfinance/totalfinance/foreign-exchange#currencyExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate positions into per-currency exposure in one declared base currency. Base-currency positions pass through unconverted; every other currency is restated with {@link convertCurrency} at the supplied quote in whichever orientation connects it (disclosed in `assumptions.quotesUsed`). A currency with no connecting quote is excluded position-by-position WITH the reason, and `exposureFraction` is each included currency's share of `totalBaseValue`. ```typescript export declare function currencyExposure(input: CurrencyExposureInput): CurrencyExposureResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CurrencyExposureInput; default: not declared - (input).baseCurrency: string; default: not declared — The reporting currency every value is restated into. - (input).positions: CurrencyExposurePosition[]; default: not declared - (input).spotRates: CurrencyPairQuote[]; default: not declared — Enough quotes to connect every position currency to the base currency, in either orientation. A currency with no connecting quote has its positions excluded WITH reason — never guessed. - return.assumptions: { baseCurrency: string; missingPairPolicy: string; quotesUsed: CurrencyExposureQuoteUse[]; }; default: not declared - return.assumptions.baseCurrency: string; default: not declared - return.assumptions.missingPairPolicy: string; default: not declared — The fixed policy prose: a position with no connecting quote is excluded with its reason. - return.assumptions.quotesUsed: CurrencyExposureQuoteUse[]; default: not declared — Which quote restated each non-base currency, and in which orientation. - return.byCurrency: CurrencyExposureRow[]; default: not declared — Per-currency rows in first-appearance order, included currencies only. - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.excludedPositions: ExcludedCurrencyExposurePosition[]; default: not declared - return.totalBaseValue: number; default: not declared — Sum of every INCLUDED position's value in the base currency. ### @insiderfinance/totalfinance/foreign-exchange#foreignExchangeForwardPoints Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Forward points: `(forward − spot) / pointSize`. Positive when the base currency trades at a forward premium. `pointSize` is always explicit — a symbol's spelling never decides it. ```typescript export declare function foreignExchangeForwardPoints(input: ForeignExchangeForwardPointsInput): ForeignExchangeForwardPointsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ForeignExchangeForwardPointsInput; default: not declared - (input).forwardRate: CurrencyPairQuote; default: not declared — The forward for the SAME pair in the SAME direction. - (input).pointSize: number; default: not declared — The size of one point in quotePerBase units (e.g. `0.0001` for EUR/USD). REQUIRED — never guessed. - (input).spotRate: CurrencyPairQuote; default: not declared - return.assumptions: { formula: 'forwardPoints = (forwardRate.quotePerBase \u2212 spotRate.quotePerBase) / pointSize'; pointSize: number; pointSizeSource: 'explicit'; }; default: not declared - return.assumptions.formula: 'forwardPoints = (forwardRate.quotePerBase − spotRate.quotePerBase) / pointSize'; default: not declared - return.assumptions.pointSize: number; default: not declared - return.assumptions.pointSizeSource: 'explicit'; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.forwardPoints: number; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#foreignExchangeForwardValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Mark-to-market of an outstanding forward: `±(currentForward − contract) × notionalBase × discountFactorToSettlement`, positive sign for `'buyer-of-base'`, negative for `'seller-of-base'`, in the QUOTE currency. At `currentForwardRate === contractRate` the value is exactly zero under unchanged inputs (the FC5 acceptance law). ```typescript export declare function foreignExchangeForwardValue(input: ForeignExchangeForwardValueInput): ForeignExchangeForwardValueResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ForeignExchangeForwardValueInput; default: not declared - (input).contractRate: CurrencyPairQuote; default: not declared — The rate contracted at inception, for the pair being valued. - (input).currentForwardRate: CurrencyPairQuote; default: not declared — Today's forward to the SAME settlement date, SAME pair, SAME direction. - (input).discountFactorToSettlement: number; default: not declared — An explicit discount factor in the QUOTE currency to the settlement date. A factor, not a rate — the matched-conventions law: accepting a rate here would let day-count and compounding conventions mismatch silently against the forward's own quotation. - (input).notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - (input).perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared — Which side is being valued: the buyer of the base currency, or the seller. - return.assumptions: { discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; perspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; default: not declared - return.assumptions.discountFactorSource: 'caller-supplied quote-currency discount factor to the settlement date'; default: not declared - return.assumptions.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - return.assumptions.signConvention: string; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.forwardValueInQuoteCurrency: number; default: not declared — Present value of the position in the QUOTE currency; zero at the contracted fair forward. ### @insiderfinance/totalfinance/foreign-exchange#foreignExchangeSwapValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Value of a foreign-exchange swap as the sum of its two forward legs, each valued with {@link foreignExchangeForwardValue} (composed, not copied). Both legs must quote the SAME pair; a classic swap holds opposite perspectives on the two legs, but that is the caller's economics and is not enforced — each leg's perspective is echoed. ```typescript export declare function foreignExchangeSwapValue(input: ForeignExchangeSwapValueInput): ForeignExchangeSwapValueResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ForeignExchangeSwapValueInput; default: not declared - (input).farLeg: ForeignExchangeForwardValueInput; default: not declared - (input).nearLeg: ForeignExchangeForwardValueInput; default: not declared - return.assumptions: { composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; farLegPerspective: 'buyer-of-base' | 'seller-of-base'; nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; signConvention: string; }; default: not declared - return.assumptions.composition: 'swapValueInQuoteCurrency = nearLegValue + farLegValue; each leg valued with foreignExchangeForwardValue under its own perspective and discount factor'; default: not declared - return.assumptions.farLegPerspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - return.assumptions.nearLegPerspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - return.assumptions.signConvention: string; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.farLegValue: number; default: not declared - return.nearLegValue: number; default: not declared - return.swapValueInQuoteCurrency: number; default: not declared — `nearLegValue + farLegValue`, in the pair's QUOTE currency. ### @insiderfinance/totalfinance/foreign-exchange#hedgeRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The simple hedge ratio: `hedgeNotionalBaseAmount / exposureBaseAmount`, both amounts echoed. A zero exposure has no ratio — the result is `null` with the reason, never Infinity or NaN. ```typescript export declare function hedgeRatio(input: HedgeRatioInput): HedgeRatioResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): HedgeRatioInput; default: not declared - (input).exposureBaseAmount: number; default: not declared — The exposure being hedged, in base-currency units (sign allowed — a short exposure is negative). - (input).hedgeNotionalBaseAmount: number; default: not declared — The hedge's notional, in the same base-currency units. - return.assumptions: { definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; exposureBaseAmount: number; hedgeNotionalBaseAmount: number; }; default: not declared - return.assumptions.definition: 'hedgeRatio = hedgeNotionalBaseAmount / exposureBaseAmount'; default: not declared - return.assumptions.exposureBaseAmount: number; default: not declared - return.assumptions.hedgeNotionalBaseAmount: number; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.hedgeRatio: number | null; default: not declared — `hedgeNotionalBaseAmount / exposureBaseAmount`; `null` when the exposure is exactly zero. - return.hedgeRatioAbsentReason?: string; default: not declared — Present exactly when `hedgeRatio` is null. ### @insiderfinance/totalfinance/foreign-exchange#invertCurrencyPairQuote Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Flip a quote's direction: EUR/USD 1.08 becomes USD/EUR 1/1.08. Inverting twice returns the original pair (the quote-direction identity, tested at 1e-12). ```typescript export declare function invertCurrencyPairQuote(input: InvertCurrencyPairQuoteInput): InvertCurrencyPairQuoteResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InvertCurrencyPairQuoteInput; default: not declared - (input).quote: CurrencyPairQuote; default: not declared - return.assumptions: { inversion: '1 / quotePerBase'; }; default: not declared - return.assumptions.inversion: '1 / quotePerBase'; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.quote: CurrencyPairQuote; default: not declared — The flipped pair: base and quote swapped, `quotePerBase` reciprocated. ### @insiderfinance/totalfinance/foreign-exchange#nonDeliverableForwardValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cash-settled value of a non-deliverable forward at its OBSERVED fixing: `±(fixing − contract) × notionalBase × discountFactorToSettlement`, in the settlement currency. The fixing is the caller's — this function never selects a fixing source. v1 settles only in the pair's quote currency; other settlement currencies are rejected with the constraint named. ```typescript export declare function nonDeliverableForwardValue(input: NonDeliverableForwardValueInput): NonDeliverableForwardValueResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NonDeliverableForwardValueInput; default: not declared - (input).contractRate: CurrencyPairQuote; default: not declared — The rate contracted at inception. - (input).discountFactorToSettlement: number; default: not declared — An explicit discount factor in the settlement (quote) currency to the settlement date. - (input).fixingRate: CurrencyPairQuote; default: not declared — The OBSERVED fixing for the SAME pair — caller-supplied, never fetched or guessed. - (input).notionalBaseAmount: number; default: not declared — Contract size in BASE-currency units; direction is carried by `perspective`, so this is > 0. - (input).perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - (input).settlementCurrency: string; default: not declared — Where cash settles. v1 supports ONLY the pair's quote currency; anything else is rejected. - return.assumptions: { fixingSource: 'caller-supplied fixing rate'; perspective: 'buyer-of-base' | 'seller-of-base'; settlementConstraint: string; settlementCurrency: string; signConvention: string; }; default: not declared - return.assumptions.fixingSource: 'caller-supplied fixing rate'; default: not declared - return.assumptions.perspective: 'buyer-of-base' | 'seller-of-base'; default: not declared - return.assumptions.settlementConstraint: string; default: not declared — The fixed v1 constraint prose: settlement in the pair's quote currency only. - return.assumptions.settlementCurrency: string; default: not declared - return.assumptions.signConvention: string; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.nonDeliverableForwardValueInSettlementCurrency: number; default: not declared — The discounted cash settlement, in the settlement (= quote) currency. ### @insiderfinance/totalfinance/foreign-exchange#pipValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Value of one pip for a position. A pip moves `quotePerBase` by `pipSize`, so a notional of `N` BASE units gains/loses `pipSize × N` quote-currency units per pip; a notional stated in the quote currency is first restated in base units at the supplied spot quote. `pipSize` is always explicit — a symbol's spelling never decides it. ```typescript export declare function pipValue(input: PipValueInput): PipValueResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PipValueInput; default: not declared - (input).notionalAmount: number; default: not declared — Position notional, expressed in `notionalCurrency` units. - (input).notionalCurrency: string; default: not declared — Which currency the notional is stated in — must be the pair's base or quote currency. - (input).pipSize: number; default: not declared — The size of one pip in quote-currency units per base unit (e.g. `0.0001` for EUR/USD, `0.01` for USD/JPY). REQUIRED — never guessed from symbol spelling (FC5 law). - (input).quote: CurrencyPairQuote; default: not declared - return.assumptions: { baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; notionalCurrency: string; notionalCurrencyRole: 'base' | 'quote'; pipSize: number; pipSizeSource: 'explicit'; }; default: not declared - return.assumptions.baseConversion: 'pip value in base currency = pip value in quote currency / quotePerBase (converted at the supplied spot quote)'; default: not declared - return.assumptions.notionalCurrency: string; default: not declared - return.assumptions.notionalCurrencyRole: 'base' | 'quote'; default: not declared — How the notional was read: already in base units, or converted from quote units at spot. - return.assumptions.pipSize: number; default: not declared - return.assumptions.pipSizeSource: 'explicit'; default: not declared - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.pipValueInBaseCurrency: number; default: not declared — The same value converted to the base currency at the supplied spot quote. - return.pipValueInQuoteCurrency: number; default: not declared — Value of a one-pip move in the QUOTE currency. ### @insiderfinance/totalfinance/foreign-exchange#requireCurrencyCode Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one currency-code field at a public boundary: a string matching `/^[A-Z]{3}$/` (uppercase three-letter ISO-4217 style). A lowercase spelling is answered with the exact uppercase fix rather than a bare rejection. ```typescript export declare function requireCurrencyCode(functionName: string, field: string, value: unknown): asserts value is string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/foreign-exchange#requireCurrencyPairQuote Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link CurrencyPairQuote} at a public boundary (Law 12 closed request): known keys, two DISTINCT uppercase currency codes, and a finite `quotePerBase` > 0. The guard validates its own `functionName` and `label` first — invoked without them, every error it teaches would blame "undefined" (see `requireFundamentalPeriod` for the precedent). ```typescript export declare function requireCurrencyPairQuote(functionName: string, label: string, quote: CurrencyPairQuote): asserts quote is CurrencyPairQuote; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (quote): CurrencyPairQuote; default: not declared - (quote).baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - (quote).quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - (quote).quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/foreign-exchange#spotForwardHedgedProfitAndLoss Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). P&L of a base-currency position that hedged `hedgedFraction` of its notional at a forward. The decomposition is exact and disclosed: the unhedged part rides the spot move `(finalSpot − initialSpot)`, the hedged part locked `(forwardRateAtHedge − initialSpot)` the moment the hedge was placed, and the total is their notional-weighted sum in the QUOTE currency. `hedgedFraction: 0` is the pure spot P&L; `hedgedFraction: 1` is fully locked at the forward and indifferent to the final spot. `forwardRateAtHedge` is REQUIRED whenever `hedgedFraction` > 0. ```typescript export declare function spotForwardHedgedProfitAndLoss(input: SpotForwardHedgedProfitAndLossInput): SpotForwardHedgedProfitAndLossResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SpotForwardHedgedProfitAndLossInput; default: not declared - (input).finalSpotRate: CurrencyPairQuote; default: not declared — The spot at measurement, SAME pair, SAME direction. - (input).forwardRateAtHedge?: CurrencyPairQuote; default: not declared — The forward locked when the hedge was placed. REQUIRED whenever `hedgedFraction` > 0. - (input).hedgedFraction: number; default: not declared — Fraction of the notional hedged at the forward, in [0, 1]. - (input).initialSpotRate: CurrencyPairQuote; default: not declared — The spot when the position was opened. - (input).notionalBaseAmount: number; default: not declared — Position size in BASE-currency units; positive = long the base currency, negative flips every sign. - return.assumptions: { decomposition: typeof HEDGED_PROFIT_AND_LOSS_DECOMPOSITION; hedgedFraction: number; notionalDirection: string; }; default: not declared - return.assumptions.decomposition: 'totalProfitAndLossInQuoteCurrency = (1 − hedgedFraction) × (finalSpotRate.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount + hedgedFraction × (forwardRateAtHedge.quotePerBase − initialSpotRate.quotePerBase) × notionalBaseAmount, every term in the quote currency'; default: not declared - return.assumptions.hedgedFraction: number; default: not declared - return.assumptions.notionalDirection: string; default: not declared — The fixed direction prose: positive notional is long the base; negative flips every sign. - return.diagnostics: ForeignExchangeDiagnostics; default: not declared - return.hedgedComponent: number; default: not declared — `hedgedFraction × (forwardRateAtHedge − initialSpot) × notional` — the part locked at the forward. - return.totalProfitAndLossInQuoteCurrency: number; default: not declared - return.unhedgedComponent: number; default: not declared — `(1 − hedgedFraction) × (finalSpot − initialSpot) × notional` — the part left floating. ## Entrypoint @insiderfinance/totalfinance/foreign-exchange/forwards ### @insiderfinance/totalfinance/foreign-exchange/forwards#CoveredInterestParityForwardInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CoveredInterestParityForwardInput`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#CoveredInterestParityForwardResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CoveredInterestParityForwardResult`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#ForeignExchangeForwardPointsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardPointsInput`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#ForeignExchangeForwardPointsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardPointsResult`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#ForeignExchangeForwardValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardValueInput`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#ForeignExchangeForwardValueResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeForwardValueResult`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#ForeignExchangeSwapValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeSwapValueInput`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#ForeignExchangeSwapValueResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeSwapValueResult`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#NonDeliverableForwardValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#NonDeliverableForwardValueInput`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#NonDeliverableForwardValueResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#NonDeliverableForwardValueResult`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#coveredInterestParityForward Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#coveredInterestParityForward`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#foreignExchangeForwardPoints Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#foreignExchangeForwardPoints`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#foreignExchangeForwardValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#foreignExchangeForwardValue`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#foreignExchangeSwapValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#foreignExchangeSwapValue`. ### @insiderfinance/totalfinance/foreign-exchange/forwards#nonDeliverableForwardValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#nonDeliverableForwardValue`. ## Entrypoint @insiderfinance/totalfinance/foreign-exchange/risk ### @insiderfinance/totalfinance/foreign-exchange/risk#CurrencyExposureInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CurrencyExposureInput`. ### @insiderfinance/totalfinance/foreign-exchange/risk#CurrencyExposurePosition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CurrencyExposurePosition`. ### @insiderfinance/totalfinance/foreign-exchange/risk#CurrencyExposureQuoteUse Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CurrencyExposureQuoteUse`. ### @insiderfinance/totalfinance/foreign-exchange/risk#CurrencyExposureResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CurrencyExposureResult`. ### @insiderfinance/totalfinance/foreign-exchange/risk#CurrencyExposureRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CurrencyExposureRow`. ### @insiderfinance/totalfinance/foreign-exchange/risk#ExcludedCurrencyExposurePosition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ExcludedCurrencyExposurePosition`. ### @insiderfinance/totalfinance/foreign-exchange/risk#HEDGED_PROFIT_AND_LOSS_DECOMPOSITION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#HEDGED_PROFIT_AND_LOSS_DECOMPOSITION`. ### @insiderfinance/totalfinance/foreign-exchange/risk#HedgeRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#HedgeRatioInput`. ### @insiderfinance/totalfinance/foreign-exchange/risk#HedgeRatioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#HedgeRatioResult`. ### @insiderfinance/totalfinance/foreign-exchange/risk#SpotForwardHedgedProfitAndLossInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#SpotForwardHedgedProfitAndLossInput`. ### @insiderfinance/totalfinance/foreign-exchange/risk#SpotForwardHedgedProfitAndLossResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#SpotForwardHedgedProfitAndLossResult`. ### @insiderfinance/totalfinance/foreign-exchange/risk#currencyExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#currencyExposure`. ### @insiderfinance/totalfinance/foreign-exchange/risk#hedgeRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#hedgeRatio`. ### @insiderfinance/totalfinance/foreign-exchange/risk#spotForwardHedgedProfitAndLoss Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#spotForwardHedgedProfitAndLoss`. ## Entrypoint @insiderfinance/totalfinance/foreign-exchange/spot ### @insiderfinance/totalfinance/foreign-exchange/spot#ConvertCurrencyInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ConvertCurrencyInput`. ### @insiderfinance/totalfinance/foreign-exchange/spot#ConvertCurrencyResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ConvertCurrencyResult`. ### @insiderfinance/totalfinance/foreign-exchange/spot#CrossRateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CrossRateInput`. ### @insiderfinance/totalfinance/foreign-exchange/spot#CrossRateResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CrossRateResult`. ### @insiderfinance/totalfinance/foreign-exchange/spot#CurrencyPairQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#CurrencyPairQuote`. ### @insiderfinance/totalfinance/foreign-exchange/spot#ForeignExchangeDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#ForeignExchangeDiagnostics`. ### @insiderfinance/totalfinance/foreign-exchange/spot#InvertCurrencyPairQuoteInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#InvertCurrencyPairQuoteInput`. ### @insiderfinance/totalfinance/foreign-exchange/spot#InvertCurrencyPairQuoteResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#InvertCurrencyPairQuoteResult`. ### @insiderfinance/totalfinance/foreign-exchange/spot#PipValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#PipValueInput`. ### @insiderfinance/totalfinance/foreign-exchange/spot#PipValueResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#PipValueResult`. ### @insiderfinance/totalfinance/foreign-exchange/spot#convertCurrency Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#convertCurrency`. ### @insiderfinance/totalfinance/foreign-exchange/spot#crossRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#crossRate`. ### @insiderfinance/totalfinance/foreign-exchange/spot#invertCurrencyPairQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#invertCurrencyPairQuote`. ### @insiderfinance/totalfinance/foreign-exchange/spot#pipValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#pipValue`. ### @insiderfinance/totalfinance/foreign-exchange/spot#requireCurrencyCode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#requireCurrencyCode`. ### @insiderfinance/totalfinance/foreign-exchange/spot#requireCurrencyPairQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/foreign-exchange#requireCurrencyPairQuote`. ## Entrypoint @insiderfinance/totalfinance/fundamentals ### @insiderfinance/totalfinance/fundamentals#AltmanComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One Altman component. ```typescript /** One Altman component. */ export interface AltmanComponent { component: 'X1' | 'X2' | 'X3' | 'X4' | 'X5'; definition: string; value: number; coefficient: number; contribution: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coefficient: number; default: not declared - component: 'X1' | 'X2' | 'X3' | 'X4' | 'X5'; default: not declared - contribution: number; default: not declared - definition: string; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#AltmanInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link altmanZScore}. ```typescript /** Input for {@link altmanZScore}. */ export interface AltmanInput { statements: FinancialStatements; variant: AltmanVariant; /** REQUIRED for `public-manufacturing` (its X4 uses market equity); rejected otherwise. */ marketEquity?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - marketEquity?: number; default: not declared — REQUIRED for `public-manufacturing` (its X4 uses market equity); rejected otherwise. - statements: FinancialStatements; default: not declared - statements.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - variant: AltmanVariant; default: not declared ### @insiderfinance/totalfinance/fundamentals#AltmanResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link altmanZScore}. ```typescript /** Result of {@link altmanZScore}. */ export interface AltmanResult { assumptions: { /** The published model name (a label, deliberately not a literal type). */ model: string; variant: AltmanVariant; equityBasis: 'market' | 'book'; }; diagnostics: { warnings: string[]; }; zScore: number; variant: AltmanVariant; components: AltmanComponent[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { equityBasis: 'market' | 'book'; model: string; variant: AltmanVariant; }; default: not declared - assumptions.equityBasis: 'market' | 'book'; default: not declared - assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - assumptions.variant: AltmanVariant; default: not declared - components: AltmanComponent[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - variant: AltmanVariant; default: not declared - zScore: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#AltmanVariant Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The published Altman variants; each fixes its coefficients and its equity basis. ```typescript // --------------------------------------------------------------------------------------------------- // Altman Z-score // --------------------------------------------------------------------------------------------------- /** The published Altman variants; each fixes its coefficients and its equity basis. */ export type AltmanVariant = 'public-manufacturing' | 'private-manufacturing' | 'non-manufacturing'; ``` ### @insiderfinance/totalfinance/fundamentals#AnalyzeFundamentalsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link analyzeFundamentals}. ```typescript /** Input for {@link analyzeFundamentals}. */ export interface AnalyzeFundamentalsInput { /** The reported history (restatements included) — the analysis sees only what `asOf` allows. */ statements: readonly FinancialStatements[]; /** The market side for valuation multiples; without it they are reported missing, not guessed. */ marketSnapshot?: MarketObservation; asOf: EpochMs; restatementPolicy: RestatementPolicy; /** Day metrics need the explicit period-day count; absent → they are reported missing. */ periodDays?: number; /** Bounds market-observation staleness for the multiples when supplied. */ maximumStalenessMs?: number; /** Explicit tax rate for return on invested capital; else the effective rate is derived. */ taxRate?: number; /** The exact debt-service denominator; absent → debtServiceCoverage is reported missing. */ debtServiceAmount?: number; /** Separately supplied non-operating assets for enterprise value. */ nonOperatingAssets?: number; /** Runs the Altman Z-score under this explicit published variant; absent → reported missing. */ altmanVariant?: AltmanVariant; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - altmanVariant?: AltmanVariant; default: not declared — Runs the Altman Z-score under this explicit published variant; absent → reported missing. - asOf: number; default: not declared - debtServiceAmount?: number; default: not declared — The exact debt-service denominator; absent → debtServiceCoverage is reported missing. - marketSnapshot?: MarketObservation; default: not declared — The market side for valuation multiples; without it they are reported missing, not guessed. - marketSnapshot.marketCapitalization?: number; default: not declared - marketSnapshot.observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - marketSnapshot.sharePrice: number; default: not declared - marketSnapshot.sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. - maximumStalenessMs?: number; default: not declared — Bounds market-observation staleness for the multiples when supplied. - nonOperatingAssets?: number; default: not declared — Separately supplied non-operating assets for enterprise value. - periodDays?: number; default: not declared — Day metrics need the explicit period-day count; absent → they are reported missing. - restatementPolicy: RestatementPolicy; default: not declared - statements: readonly FinancialStatements[]; default: not declared — The reported history (restatements included) — the analysis sees only what `asOf` allows. - taxRate?: number; default: not declared — Explicit tax rate for return on invested capital; else the effective rate is derived. ### @insiderfinance/totalfinance/fundamentals#AnalyzeFundamentalsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link analyzeFundamentals}. ```typescript /** Result of {@link analyzeFundamentals}. */ export interface AnalyzeFundamentalsResult { assumptions: { asOf: EpochMs; restatementPolicy: RestatementPolicy; periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; }; diagnostics: { /** One warning per metric that could not be formed (mirrors `missing`). */ warnings: string[]; }; asOf: EpochMs; restatementPolicy: RestatementPolicy; /** How many statement sets were visible at `asOf` after restatement resolution. */ periodsVisible: number; /** The period the single-period metrics used. */ periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; /** The prior period the average-balance metrics used, when one was visible. */ priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; ratios: Record; scores: { piotroski?: PiotroskiResult; altman?: AltmanResult; beneish?: BeneishResult; }; /** Every metric that could not be formed, with its reason — the honest gaps ledger. */ missing: Array<{ metric: string; reason: string; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - assumptions: { asOf: EpochMs; periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; restatementPolicy: RestatementPolicy; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.periodUsed: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared - assumptions.periodUsed.fiscalYear: number; default: not declared - assumptions.periodUsed.periodEndDate: string; default: not declared - assumptions.periodUsed.periodType: string; default: not declared - assumptions.priorPeriodUsed?: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared - assumptions.priorPeriodUsed.fiscalYear: number; default: not declared - assumptions.priorPeriodUsed.periodEndDate: string; default: not declared - assumptions.priorPeriodUsed.periodType: string; default: not declared - assumptions.restatementPolicy: RestatementPolicy; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — One warning per metric that could not be formed (mirrors `missing`). - missing: { metric: string; reason: string; }[]; default: not declared — Every metric that could not be formed, with its reason — the honest gaps ledger. - periodUsed: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared — The period the single-period metrics used. - periodUsed.fiscalYear: number; default: not declared - periodUsed.periodEndDate: string; default: not declared - periodUsed.periodType: string; default: not declared - periodsVisible: number; default: not declared — How many statement sets were visible at `asOf` after restatement resolution. - priorPeriodUsed?: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared — The prior period the average-balance metrics used, when one was visible. - priorPeriodUsed.fiscalYear: number; default: not declared - priorPeriodUsed.periodEndDate: string; default: not declared - priorPeriodUsed.periodType: string; default: not declared - ratios: Record; default: not declared - restatementPolicy: RestatementPolicy; default: not declared - scores: { altman?: AltmanResult; beneish?: BeneishResult; piotroski?: PiotroskiResult; }; default: not declared - scores.altman?: AltmanResult; default: not declared - scores.altman.assumptions: { equityBasis: 'market' | 'book'; model: string; variant: AltmanVariant; }; default: not declared - scores.altman.assumptions.equityBasis: 'market' | 'book'; default: not declared - scores.altman.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - scores.altman.assumptions.variant: AltmanVariant; default: not declared - scores.altman.components: import('@insiderfinance/totalfinance/fundamentals').AltmanComponent[]; default: not declared - scores.altman.diagnostics: { warnings: string[]; }; default: not declared - scores.altman.diagnostics.warnings: string[]; default: not declared - scores.altman.variant: AltmanVariant; default: not declared - scores.altman.zScore: number; default: not declared - scores.beneish?: BeneishResult; default: not declared - scores.beneish.assumptions: { model: string; }; default: not declared - scores.beneish.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - scores.beneish.components: import('@insiderfinance/totalfinance/fundamentals').BeneishComponent[]; default: not declared - scores.beneish.diagnostics: { warnings: string[]; }; default: not declared - scores.beneish.diagnostics.warnings: string[]; default: not declared — Conventions the inputs forced (e.g. D&A standing in for pure depreciation) — disclosed. - scores.beneish.mScore: number; default: not declared - scores.beneish.notes: string[]; default: not declared — The same disclosures as `diagnostics.warnings` (kept for direct reading). - scores.piotroski?: PiotroskiResult; default: not declared - scores.piotroski.assumptions: { model: string; returnBasis: 'beginning total assets'; }; default: not declared - scores.piotroski.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - scores.piotroski.assumptions.returnBasis: 'beginning total assets'; default: not declared — Returns and turnover use BEGINNING total assets, per the paper. - scores.piotroski.diagnostics: { warnings: string[]; }; default: not declared - scores.piotroski.diagnostics.warnings: string[]; default: not declared — One warning per unevaluable signal. - scores.piotroski.evaluableSignals: number; default: not declared — How many of the nine signals could be evaluated; 9 when every input line was present. - scores.piotroski.fScore: number; default: not declared — Sum of the evaluable signals (each 0 or 1). - scores.piotroski.signals: import('@insiderfinance/totalfinance/fundamentals').PiotroskiSignal[]; default: not declared ### @insiderfinance/totalfinance/fundamentals#AnalyzedRatio Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One computed (or explicitly not-computed) metric. ```typescript /** One computed (or explicitly not-computed) metric. */ export interface AnalyzedRatio { value: number | null; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - reason?: string; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/fundamentals#BalanceSheet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One reported balance sheet (balances at `period.periodEndDate`). ```typescript /** One reported balance sheet (balances at `period.periodEndDate`). */ export interface BalanceSheet { period: FundamentalPeriod; cashAndCashEquivalents: number; shortTermInvestments?: number; accountsReceivable?: number; inventory?: number; currentAssets?: number; /** Net property, plant, and equipment. */ propertyPlantEquipmentNet?: number; totalAssets: number; currentLiabilities?: number; accountsPayable?: number; /** Interest-bearing debt due within one year. */ shortTermDebt?: number; /** Interest-bearing debt due beyond one year. */ longTermDebt?: number; /** * Total interest-bearing debt. When absent and both maturities are present, consumers may derive * `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. */ totalDebt?: number; totalLiabilities: number; preferredEquity?: number; minorityInterest?: number; totalEquity: number; retainedEarnings?: number; /** Source-specific extras, preserved verbatim and never consumed by compute functions. */ metadata?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountsPayable?: number; default: not declared - accountsReceivable?: number; default: not declared - cashAndCashEquivalents: number; default: not declared - currentAssets?: number; default: not declared - currentLiabilities?: number; default: not declared - inventory?: number; default: not declared - longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - minorityInterest?: number; default: not declared - period: FundamentalPeriod; default: not declared - period.accession?: string; default: not declared — Source accession identifier, when known. - period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - period.fiscalYear: number; default: not declared - period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - preferredEquity?: number; default: not declared - propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - retainedEarnings?: number; default: not declared - shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - shortTermInvestments?: number; default: not declared - totalAssets: number; default: not declared - totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - totalEquity: number; default: not declared - totalLiabilities: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#BalanceSheetRatioInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Balance-only formulas: use the actual balance sheet or the existing complete set. ```typescript /** Balance-only formulas: use the actual balance sheet or the existing complete set. */ export type BalanceSheetRatioInput = BalanceSheet> = (SingleStatementRatioInput & { balance?: never; }) | { balance: Facts & Partial; statements?: never; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balance: Facts & Partial; default: not declared - balance.accountsPayable?: number; default: not declared - balance.accountsReceivable?: number; default: not declared - balance.cashAndCashEquivalents?: number; default: not declared - balance.currentAssets?: number; default: not declared - balance.currentLiabilities?: number; default: not declared - balance.inventory?: number; default: not declared - balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - balance.minorityInterest?: number; default: not declared - balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - balance.period.accession?: string; default: not declared — Source accession identifier, when known. - balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - balance.period.fiscalYear: number; default: not declared - balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - balance.preferredEquity?: number; default: not declared - balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - balance.retainedEarnings?: number; default: not declared - balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - balance.shortTermInvestments?: number; default: not declared - balance.totalAssets?: number; default: not declared - balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - balance.totalEquity?: number; default: not declared - balance.totalLiabilities?: number; default: not declared - statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#BeneishComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One Beneish component index. ```typescript /** One Beneish component index. */ export interface BeneishComponent { index: 'DSRI' | 'GMI' | 'AQI' | 'SGI' | 'DEPI' | 'SGAI' | 'LVGI' | 'TATA'; expandedName: string; value: number; coefficient: number; contribution: number; currentPeriodEndDate: string; priorPeriodEndDate: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coefficient: number; default: not declared - contribution: number; default: not declared - currentPeriodEndDate: string; default: not declared - expandedName: string; default: not declared - index: 'DSRI' | 'GMI' | 'AQI' | 'SGI' | 'DEPI' | 'SGAI' | 'LVGI' | 'TATA'; default: not declared - priorPeriodEndDate: string; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#BeneishInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link beneishMScore}: two consecutive periods. ```typescript // --------------------------------------------------------------------------------------------------- // Beneish M-score // --------------------------------------------------------------------------------------------------- /** Input for {@link beneishMScore}: two consecutive periods. */ export interface BeneishInput { current: FinancialStatements; prior: FinancialStatements; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: FinancialStatements; default: not declared - current.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - current.balance.accountsPayable?: number; default: not declared - current.balance.accountsReceivable?: number; default: not declared - current.balance.cashAndCashEquivalents: number; default: not declared - current.balance.currentAssets?: number; default: not declared - current.balance.currentLiabilities?: number; default: not declared - current.balance.inventory?: number; default: not declared - current.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - current.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.balance.minorityInterest?: number; default: not declared - current.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - current.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.balance.period.fiscalYear: number; default: not declared - current.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.balance.preferredEquity?: number; default: not declared - current.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - current.balance.retainedEarnings?: number; default: not declared - current.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - current.balance.shortTermInvestments?: number; default: not declared - current.balance.totalAssets: number; default: not declared - current.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - current.balance.totalEquity: number; default: not declared - current.balance.totalLiabilities: number; default: not declared - current.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - current.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - current.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - current.cashFlow.depreciationAndAmortization?: number; default: not declared - current.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - current.cashFlow.financingCashFlow: number; default: not declared - current.cashFlow.investingCashFlow: number; default: not declared - current.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.cashFlow.operatingCashFlow: number; default: not declared - current.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - current.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.cashFlow.period.fiscalYear: number; default: not declared - current.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - current.cashFlow.stockBasedCompensation?: number; default: not declared - current.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - current.income.costOfRevenue?: number; default: not declared — Positive magnitude. - current.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - current.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - current.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - current.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - current.income.interestExpense?: number; default: not declared — Positive magnitude. - current.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.income.netIncome: number; default: not declared - current.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - current.income.operatingIncome: number; default: not declared - current.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.income.period.accession?: string; default: not declared — Source accession identifier, when known. - current.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.income.period.fiscalYear: number; default: not declared - current.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.income.revenue: number; default: not declared - current.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - prior: FinancialStatements; default: not declared - prior.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - prior.balance.accountsPayable?: number; default: not declared - prior.balance.accountsReceivable?: number; default: not declared - prior.balance.cashAndCashEquivalents: number; default: not declared - prior.balance.currentAssets?: number; default: not declared - prior.balance.currentLiabilities?: number; default: not declared - prior.balance.inventory?: number; default: not declared - prior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - prior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.balance.minorityInterest?: number; default: not declared - prior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.balance.period.fiscalYear: number; default: not declared - prior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.balance.preferredEquity?: number; default: not declared - prior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - prior.balance.retainedEarnings?: number; default: not declared - prior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - prior.balance.shortTermInvestments?: number; default: not declared - prior.balance.totalAssets: number; default: not declared - prior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - prior.balance.totalEquity: number; default: not declared - prior.balance.totalLiabilities: number; default: not declared - prior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - prior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - prior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - prior.cashFlow.depreciationAndAmortization?: number; default: not declared - prior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - prior.cashFlow.financingCashFlow: number; default: not declared - prior.cashFlow.investingCashFlow: number; default: not declared - prior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.cashFlow.operatingCashFlow: number; default: not declared - prior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.cashFlow.period.fiscalYear: number; default: not declared - prior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - prior.cashFlow.stockBasedCompensation?: number; default: not declared - prior.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - prior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - prior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - prior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - prior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - prior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - prior.income.interestExpense?: number; default: not declared — Positive magnitude. - prior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.income.netIncome: number; default: not declared - prior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - prior.income.operatingIncome: number; default: not declared - prior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.income.period.fiscalYear: number; default: not declared - prior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.income.revenue: number; default: not declared - prior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#BeneishResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link beneishMScore}. ```typescript /** Result of {@link beneishMScore}. */ export interface BeneishResult { assumptions: { /** The published model name (a label, deliberately not a literal type). */ model: string; }; diagnostics: { /** Conventions the inputs forced (e.g. D&A standing in for pure depreciation) — disclosed. */ warnings: string[]; }; mScore: number; components: BeneishComponent[]; /** The same disclosures as `diagnostics.warnings` (kept for direct reading). */ notes: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { model: string; }; default: not declared - assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - components: BeneishComponent[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — Conventions the inputs forced (e.g. D&A standing in for pure depreciation) — disclosed. - mScore: number; default: not declared - notes: string[]; default: not declared — The same disclosures as `diagnostics.warnings` (kept for direct reading). ### @insiderfinance/totalfinance/fundamentals#CashFlowStatement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One reported cash-flow statement (flows over the period). ```typescript /** One reported cash-flow statement (flows over the period). */ export interface CashFlowStatement { period: FundamentalPeriod; operatingCashFlow: number; investingCashFlow: number; financingCashFlow: number; /** Positive magnitude of cash spent on property, plant, and equipment. */ capitalExpenditure?: number; depreciationAndAmortization?: number; stockBasedCompensation?: number; /** Positive magnitude of cash spent on acquisitions. */ acquisitions?: number; /** Positive magnitude of cash paid out as dividends. */ dividendsPaid?: number; /** Positive magnitude of cash spent repurchasing shares. */ shareRepurchases?: number; /** Source-specific extras, preserved verbatim and never consumed by compute functions. */ metadata?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - depreciationAndAmortization?: number; default: not declared - dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - financingCashFlow: number; default: not declared - investingCashFlow: number; default: not declared - metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - operatingCashFlow: number; default: not declared - period: FundamentalPeriod; default: not declared - period.accession?: string; default: not declared — Source accession identifier, when known. - period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - period.fiscalYear: number; default: not declared - period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - stockBasedCompensation?: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#CommonSizeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link commonSizeFinancialStatements}. ```typescript // --------------------------------------------------------------------------------------------------- // commonSizeFinancialStatements // --------------------------------------------------------------------------------------------------- /** Input for {@link commonSizeFinancialStatements}. */ export interface CommonSizeInput { statements: FinancialStatements; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#CommonSizeResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link commonSizeFinancialStatements}: each line as a FRACTION of its stated base. ```typescript /** Result of {@link commonSizeFinancialStatements}: each line as a FRACTION of its stated base. */ export interface CommonSizeResult { assumptions: { incomeBasis: 'revenue'; balanceBasis: 'totalAssets'; cashFlowBasis: 'revenue'; }; diagnostics: { warnings: string[]; }; /** Income lines over `revenue`. */ income: { basis: 'revenue'; lines: Record; }; /** Balance lines over `totalAssets`. */ balance: { basis: 'totalAssets'; lines: Record; }; /** Cash-flow lines over `revenue`. */ cashFlow: { basis: 'revenue'; lines: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { balanceBasis: 'totalAssets'; cashFlowBasis: 'revenue'; incomeBasis: 'revenue'; }; default: not declared - assumptions.balanceBasis: 'totalAssets'; default: not declared - assumptions.cashFlowBasis: 'revenue'; default: not declared - assumptions.incomeBasis: 'revenue'; default: not declared - balance: { basis: 'totalAssets'; lines: Record; }; default: not declared — Balance lines over `totalAssets`. - balance.basis: 'totalAssets'; default: not declared - balance.lines: Record; default: not declared - cashFlow: { basis: 'revenue'; lines: Record; }; default: not declared — Cash-flow lines over `revenue`. - cashFlow.basis: 'revenue'; default: not declared - cashFlow.lines: Record; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - income: { basis: 'revenue'; lines: Record; }; default: not declared — Income lines over `revenue`. - income.basis: 'revenue'; default: not declared - income.lines: Record; default: not declared ### @insiderfinance/totalfinance/fundamentals#DayMetricRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Day metrics: the pair plus the explicit period-day count (never guessed). ```typescript /** Day metrics: the pair plus the explicit period-day count (never guessed). */ export interface DayMetricRatioInput extends PairRatioInput { periodDays: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: FinancialStatements; default: not declared - current.balance: BalanceSheet; default: not declared - current.balance.accountsPayable?: number; default: not declared - current.balance.accountsReceivable?: number; default: not declared - current.balance.cashAndCashEquivalents: number; default: not declared - current.balance.currentAssets?: number; default: not declared - current.balance.currentLiabilities?: number; default: not declared - current.balance.inventory?: number; default: not declared - current.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - current.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.balance.minorityInterest?: number; default: not declared - current.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - current.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.balance.period.fiscalYear: number; default: not declared - current.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.balance.preferredEquity?: number; default: not declared - current.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - current.balance.retainedEarnings?: number; default: not declared - current.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - current.balance.shortTermInvestments?: number; default: not declared - current.balance.totalAssets: number; default: not declared - current.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - current.balance.totalEquity: number; default: not declared - current.balance.totalLiabilities: number; default: not declared - current.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - current.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - current.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - current.cashFlow.depreciationAndAmortization?: number; default: not declared - current.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - current.cashFlow.financingCashFlow: number; default: not declared - current.cashFlow.investingCashFlow: number; default: not declared - current.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.cashFlow.operatingCashFlow: number; default: not declared - current.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - current.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.cashFlow.period.fiscalYear: number; default: not declared - current.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - current.cashFlow.stockBasedCompensation?: number; default: not declared - current.income: IncomeStatement; default: not declared - current.income.costOfRevenue?: number; default: not declared — Positive magnitude. - current.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - current.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - current.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - current.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - current.income.interestExpense?: number; default: not declared — Positive magnitude. - current.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.income.netIncome: number; default: not declared - current.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - current.income.operatingIncome: number; default: not declared - current.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.income.period.accession?: string; default: not declared — Source accession identifier, when known. - current.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.income.period.fiscalYear: number; default: not declared - current.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.income.revenue: number; default: not declared - current.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - periodDays: number; default: not declared - prior: FinancialStatements; default: not declared - prior.balance: BalanceSheet; default: not declared - prior.balance.accountsPayable?: number; default: not declared - prior.balance.accountsReceivable?: number; default: not declared - prior.balance.cashAndCashEquivalents: number; default: not declared - prior.balance.currentAssets?: number; default: not declared - prior.balance.currentLiabilities?: number; default: not declared - prior.balance.inventory?: number; default: not declared - prior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - prior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.balance.minorityInterest?: number; default: not declared - prior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.balance.period.fiscalYear: number; default: not declared - prior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.balance.preferredEquity?: number; default: not declared - prior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - prior.balance.retainedEarnings?: number; default: not declared - prior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - prior.balance.shortTermInvestments?: number; default: not declared - prior.balance.totalAssets: number; default: not declared - prior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - prior.balance.totalEquity: number; default: not declared - prior.balance.totalLiabilities: number; default: not declared - prior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - prior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - prior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - prior.cashFlow.depreciationAndAmortization?: number; default: not declared - prior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - prior.cashFlow.financingCashFlow: number; default: not declared - prior.cashFlow.investingCashFlow: number; default: not declared - prior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.cashFlow.operatingCashFlow: number; default: not declared - prior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.cashFlow.period.fiscalYear: number; default: not declared - prior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - prior.cashFlow.stockBasedCompensation?: number; default: not declared - prior.income: IncomeStatement; default: not declared - prior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - prior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - prior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - prior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - prior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - prior.income.interestExpense?: number; default: not declared — Positive magnitude. - prior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.income.netIncome: number; default: not declared - prior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - prior.income.operatingIncome: number; default: not declared - prior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.income.period.fiscalYear: number; default: not declared - prior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.income.revenue: number; default: not declared - prior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#DebtServiceCoverageInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Additive income-only coverage request; the existing extendable full-set interface is preserved. ```typescript /** Additive income-only coverage request; the existing extendable full-set interface is preserved. */ export type DebtServiceCoverageInput = IncomeStatementRatioInput> & { debtServiceAmount: number; }; ``` ### @insiderfinance/totalfinance/fundamentals#DebtServiceRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Debt-service coverage: the exact supplied denominator. ```typescript /** Debt-service coverage: the exact supplied denominator. */ export interface DebtServiceRatioInput extends SingleStatementRatioInput { debtServiceAmount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - debtServiceAmount: number; default: not declared - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#EnterpriseMultipleRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Enterprise-value multiples: separately supplied non-operating assets. ```typescript /** Enterprise-value multiples: separately supplied non-operating assets. */ export interface EnterpriseMultipleRatioInput extends MarketMultipleRatioInput { nonOperatingAssets?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - marketObservation: MarketObservation; default: not declared - marketObservation.marketCapitalization?: number; default: not declared - marketObservation.observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - marketObservation.sharePrice: number; default: not declared - marketObservation.sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. - maximumStalenessMs?: number; default: not declared - nonOperatingAssets?: number; default: not declared - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#FinancialStatements Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The three statements of ONE period. The periods must agree on their identity — end date, type, currency, and monetary scale — because every ratio that crosses statements assumes it; the set's point-in-time availability is the LATEST of the three (a set is visible only when whole). ```typescript /** * The three statements of ONE period. The periods must agree on their identity — end date, type, * currency, and monetary scale — because every ratio that crosses statements assumes it; the set's * point-in-time availability is the LATEST of the three (a set is visible only when whole). */ export interface FinancialStatements { income: IncomeStatement; balance: BalanceSheet; cashFlow: CashFlowStatement; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balance: BalanceSheet; default: not declared - balance.accountsPayable?: number; default: not declared - balance.accountsReceivable?: number; default: not declared - balance.cashAndCashEquivalents: number; default: not declared - balance.currentAssets?: number; default: not declared - balance.currentLiabilities?: number; default: not declared - balance.inventory?: number; default: not declared - balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - balance.minorityInterest?: number; default: not declared - balance.period: FundamentalPeriod; default: not declared - balance.period.accession?: string; default: not declared — Source accession identifier, when known. - balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - balance.period.fiscalYear: number; default: not declared - balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - balance.preferredEquity?: number; default: not declared - balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - balance.retainedEarnings?: number; default: not declared - balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - balance.shortTermInvestments?: number; default: not declared - balance.totalAssets: number; default: not declared - balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - balance.totalEquity: number; default: not declared - balance.totalLiabilities: number; default: not declared - cashFlow: CashFlowStatement; default: not declared - cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - cashFlow.depreciationAndAmortization?: number; default: not declared - cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - cashFlow.financingCashFlow: number; default: not declared - cashFlow.investingCashFlow: number; default: not declared - cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - cashFlow.operatingCashFlow: number; default: not declared - cashFlow.period: FundamentalPeriod; default: not declared - cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - cashFlow.period.fiscalYear: number; default: not declared - cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - cashFlow.stockBasedCompensation?: number; default: not declared - income: IncomeStatement; default: not declared - income.costOfRevenue?: number; default: not declared — Positive magnitude. - income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - income.interestExpense?: number; default: not declared — Positive magnitude. - income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - income.netIncome: number; default: not declared - income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - income.operatingIncome: number; default: not declared - income.period: FundamentalPeriod; default: not declared - income.period.accession?: string; default: not declared — Source accession identifier, when known. - income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - income.period.fiscalYear: number; default: not declared - income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - income.revenue: number; default: not declared - income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#FundamentalGrowthInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link fundamentalGrowth}. ```typescript // --------------------------------------------------------------------------------------------------- // fundamentalGrowth // --------------------------------------------------------------------------------------------------- /** Input for {@link fundamentalGrowth}. */ export interface FundamentalGrowthInput { /** At least two observations of one amount, period end ascending. */ observations: readonly { periodEndDate: string; amount: number; }[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - observations: readonly { periodEndDate: string; amount: number; }[]; default: not declared — At least two observations of one amount, period end ascending. ### @insiderfinance/totalfinance/fundamentals#FundamentalGrowthResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link fundamentalGrowth} — the one analysis report grammar. ```typescript /** Result of {@link fundamentalGrowth} — the one analysis report grammar. */ export interface FundamentalGrowthResult { assumptions: { /** Elapsed time between period ends is an ACT/365F year fraction (a label, not a literal). */ elapsedYearsBasis: string; observationCount: number; }; diagnostics: { /** Every null growth's reason surfaces here too, so a reader scans one place. */ warnings: string[]; }; /** * One row per adjacent pair: fractional growth `current / prior - 1`, or `null` with the reason * when the prior amount is zero or the pair crosses sign (a growth rate through zero has no * meaningful magnitude). */ periodOverPeriod: Array<{ fromPeriodEndDate: string; toPeriodEndDate: string; growth: number | null; reason?: string; }>; /** * Compound annual growth from the first to the last observation over the ACTUAL elapsed years * (ACT/365F between the period ends), or `null` with the reason when the endpoints make the * exponent meaningless (non-positive start, sign change, or zero elapsed time). */ compoundAnnualGrowthRate: number | null; compoundAnnualGrowthReason?: string; elapsedYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { elapsedYearsBasis: string; observationCount: number; }; default: not declared - assumptions.elapsedYearsBasis: string; default: not declared — Elapsed time between period ends is an ACT/365F year fraction (a label, not a literal). - assumptions.observationCount: number; default: not declared - compoundAnnualGrowthRate: number | null; default: not declared — Compound annual growth from the first to the last observation over the ACTUAL elapsed years (ACT/365F between the period ends), or `null` with the reason when the endpoints make the exponent meaningless (non-positive start, sign change, or zero elapsed time). - compoundAnnualGrowthReason?: string; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — Every null growth's reason surfaces here too, so a reader scans one place. - elapsedYears: number; default: not declared - periodOverPeriod: { fromPeriodEndDate: string; toPeriodEndDate: string; growth: number | null; reason?: string; }[]; default: not declared — One row per adjacent pair: fractional growth `current / prior - 1`, or `null` with the reason when the prior amount is zero or the pair crosses sign (a growth rate through zero has no meaningful magnitude). ### @insiderfinance/totalfinance/fundamentals#FundamentalPeriod Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One reported fundamental period, point-in-time aware (FC0 — frozen). ```typescript /** One reported fundamental period, point-in-time aware (FC0 — frozen). */ export interface FundamentalPeriod { /** Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. */ periodStartDate?: string; /** Strict `YYYY-MM-DD` calendar date the period ends on. */ periodEndDate: string; fiscalYear: number; fiscalQuarter?: 1 | 2 | 3 | 4; periodType: 'quarter' | 'year' | 'trailing-twelve-months'; /** When the filing was made, when known. */ filedTimestampMs?: EpochMs; /** * When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A * backtest or event study must not see this period before this time; `periodEndDate` never * controls eligibility. */ availableTimestampMs: EpochMs; /** ISO 4217 currency of the monetary figures. */ currency: string; /** Monetary figures are reported in units of this scale. */ monetaryScale: 1 | 1000 | 1000000; /** Source form (e.g. `10-Q`), when known. */ form?: string; /** Source accession identifier, when known. */ accession?: string; /** When this record restates an earlier one, the accession (or identifier) it restates. */ restatementOf?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accession?: string; default: not declared — Source accession identifier, when known. - availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - currency: string; default: not declared — ISO 4217 currency of the monetary figures. - filedTimestampMs?: number; default: not declared — When the filing was made, when known. - fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - fiscalYear: number; default: not declared - form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. ### @insiderfinance/totalfinance/fundamentals#FundamentalSeries Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The full reported history of one entity, restatements included: ordered by period end ascending, with a restatement appearing as a SECOND record for the same period carrying its own `availableTimestampMs` and `restatementOf` provenance. Nothing is ever overwritten. ```typescript /** * The full reported history of one entity, restatements included: ordered by period end ascending, * with a restatement appearing as a SECOND record for the same period carrying its own * `availableTimestampMs` and `restatementOf` provenance. Nothing is ever overwritten. */ export interface FundamentalSeries { /** Optional entity label carried into diagnostics (a symbol, CIK, or internal id). */ entity?: string; statements: readonly FinancialStatements[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entity?: string; default: not declared — Optional entity label carried into diagnostics (a symbol, CIK, or internal id). - statements: readonly FinancialStatements[]; default: not declared ### @insiderfinance/totalfinance/fundamentals#FundamentalSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The point-in-time view of a series: exactly the statement sets an observer at `asOf` could have seen, one version per period under the stated restatement policy. This is what point-in-time consumers (backtests, event studies, screens) iterate — never the raw series. ```typescript /** * The point-in-time view of a series: exactly the statement sets an observer at `asOf` could have * seen, one version per period under the stated restatement policy. This is what point-in-time * consumers (backtests, event studies, screens) iterate — never the raw series. */ export interface FundamentalSnapshot { entity?: string; asOf: number; restatementPolicy: RestatementPolicy; /** One resolved version per (periodType, periodEndDate), period end ascending. */ statements: readonly FinancialStatements[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - entity?: string; default: not declared - restatementPolicy: RestatementPolicy; default: not declared - statements: readonly FinancialStatements[]; default: not declared — One resolved version per (periodType, periodEndDate), period end ascending. ### @insiderfinance/totalfinance/fundamentals#IncomeStatement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One reported income statement (flows over the period). ```typescript // --------------------------------------------------------------------------------------------------- // Contracts // --------------------------------------------------------------------------------------------------- /** One reported income statement (flows over the period). */ export interface IncomeStatement { period: FundamentalPeriod; revenue: number; /** Positive magnitude. */ costOfRevenue?: number; /** Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. */ grossProfit?: number; /** Positive magnitude of total operating expenses below gross profit. */ operatingExpenses?: number; operatingIncome: number; /** Positive magnitude. */ interestExpense?: number; /** Positive magnitude (a net tax benefit is a negative amount and is stated as such). */ incomeTaxExpense?: number; netIncome: number; /** When reported separately from `netIncome` (the Beneish accrual basis prefers it). */ incomeFromContinuingOperations?: number; /** Positive magnitude (Beneish SGAI consumes it). */ sellingGeneralAdministrativeExpense?: number; /** Split-adjusted weighted-average diluted shares for the period. */ dilutedSharesOutstanding?: number; /** Source-specific extras, preserved verbatim and never consumed by compute functions. */ metadata?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - costOfRevenue?: number; default: not declared — Positive magnitude. - dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - interestExpense?: number; default: not declared — Positive magnitude. - metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - netIncome: number; default: not declared - operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - operatingIncome: number; default: not declared - period: FundamentalPeriod; default: not declared - period.accession?: string; default: not declared — Source accession identifier, when known. - period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - period.fiscalYear: number; default: not declared - period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - revenue: number; default: not declared - sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#IncomeStatementRatioInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Income-only formulas: use the actual income statement or the existing complete set. ```typescript /** Income-only formulas: use the actual income statement or the existing complete set. */ export type IncomeStatementRatioInput = IncomeStatement> = (SingleStatementRatioInput & { income?: never; }) | { income: Facts & Partial; statements?: never; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - income: Facts & Partial; default: not declared - income.costOfRevenue?: number; default: not declared — Positive magnitude. - income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - income.interestExpense?: number; default: not declared — Positive magnitude. - income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - income.netIncome?: number; default: not declared - income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - income.operatingIncome?: number; default: not declared - income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - income.period.accession?: string; default: not declared — Source accession identifier, when known. - income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - income.period.fiscalYear: number; default: not declared - income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - income.revenue?: number; default: not declared - income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#InvestedCapitalRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Return on invested capital: the pair plus an optional explicit tax rate. ```typescript /** Return on invested capital: the pair plus an optional explicit tax rate. */ export interface InvestedCapitalRatioInput extends PairRatioInput { taxRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: FinancialStatements; default: not declared - current.balance: BalanceSheet; default: not declared - current.balance.accountsPayable?: number; default: not declared - current.balance.accountsReceivable?: number; default: not declared - current.balance.cashAndCashEquivalents: number; default: not declared - current.balance.currentAssets?: number; default: not declared - current.balance.currentLiabilities?: number; default: not declared - current.balance.inventory?: number; default: not declared - current.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - current.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.balance.minorityInterest?: number; default: not declared - current.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - current.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.balance.period.fiscalYear: number; default: not declared - current.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.balance.preferredEquity?: number; default: not declared - current.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - current.balance.retainedEarnings?: number; default: not declared - current.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - current.balance.shortTermInvestments?: number; default: not declared - current.balance.totalAssets: number; default: not declared - current.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - current.balance.totalEquity: number; default: not declared - current.balance.totalLiabilities: number; default: not declared - current.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - current.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - current.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - current.cashFlow.depreciationAndAmortization?: number; default: not declared - current.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - current.cashFlow.financingCashFlow: number; default: not declared - current.cashFlow.investingCashFlow: number; default: not declared - current.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.cashFlow.operatingCashFlow: number; default: not declared - current.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - current.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.cashFlow.period.fiscalYear: number; default: not declared - current.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - current.cashFlow.stockBasedCompensation?: number; default: not declared - current.income: IncomeStatement; default: not declared - current.income.costOfRevenue?: number; default: not declared — Positive magnitude. - current.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - current.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - current.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - current.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - current.income.interestExpense?: number; default: not declared — Positive magnitude. - current.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.income.netIncome: number; default: not declared - current.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - current.income.operatingIncome: number; default: not declared - current.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.income.period.accession?: string; default: not declared — Source accession identifier, when known. - current.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.income.period.fiscalYear: number; default: not declared - current.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.income.revenue: number; default: not declared - current.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - prior: FinancialStatements; default: not declared - prior.balance: BalanceSheet; default: not declared - prior.balance.accountsPayable?: number; default: not declared - prior.balance.accountsReceivable?: number; default: not declared - prior.balance.cashAndCashEquivalents: number; default: not declared - prior.balance.currentAssets?: number; default: not declared - prior.balance.currentLiabilities?: number; default: not declared - prior.balance.inventory?: number; default: not declared - prior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - prior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.balance.minorityInterest?: number; default: not declared - prior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.balance.period.fiscalYear: number; default: not declared - prior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.balance.preferredEquity?: number; default: not declared - prior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - prior.balance.retainedEarnings?: number; default: not declared - prior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - prior.balance.shortTermInvestments?: number; default: not declared - prior.balance.totalAssets: number; default: not declared - prior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - prior.balance.totalEquity: number; default: not declared - prior.balance.totalLiabilities: number; default: not declared - prior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - prior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - prior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - prior.cashFlow.depreciationAndAmortization?: number; default: not declared - prior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - prior.cashFlow.financingCashFlow: number; default: not declared - prior.cashFlow.investingCashFlow: number; default: not declared - prior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.cashFlow.operatingCashFlow: number; default: not declared - prior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.cashFlow.period.fiscalYear: number; default: not declared - prior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - prior.cashFlow.stockBasedCompensation?: number; default: not declared - prior.income: IncomeStatement; default: not declared - prior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - prior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - prior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - prior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - prior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - prior.income.interestExpense?: number; default: not declared — Positive magnitude. - prior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.income.netIncome: number; default: not declared - prior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - prior.income.operatingIncome: number; default: not declared - prior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.income.period.fiscalYear: number; default: not declared - prior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.income.revenue: number; default: not declared - prior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - taxRate?: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#MarketMultipleRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market multiples: the market side plus the optional freshness bound. ```typescript /** Market multiples: the market side plus the optional freshness bound. */ export interface MarketMultipleRatioInput extends SingleStatementRatioInput { marketObservation: MarketObservation; maximumStalenessMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - marketObservation: MarketObservation; default: not declared - marketObservation.marketCapitalization?: number; default: not declared - marketObservation.observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - marketObservation.sharePrice: number; default: not declared - marketObservation.sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. - maximumStalenessMs?: number; default: not declared - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#MarketObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The market side of a valuation multiple — a narrow structural view, not a market-data feed. `marketCapitalization` may be given directly or derived as `sharePrice × sharesOutstanding` (the derivation is disclosed). UNITS: market amounts are ABSOLUTE currency, not the statements' `monetaryScale`. The kernel converts statement amounts to absolute currency before a multiple divides, and discloses the conversion — a thousands-scale filing must not shift every multiple by 1,000×. ```typescript // --------------------------------------------------------------------------------------------------- // Market observation (a ratio input this package owns) // --------------------------------------------------------------------------------------------------- /** * The market side of a valuation multiple — a narrow structural view, not a market-data feed. * `marketCapitalization` may be given directly or derived as `sharePrice × sharesOutstanding` * (the derivation is disclosed). * * UNITS: market amounts are ABSOLUTE currency, not the statements' `monetaryScale`. The kernel * converts statement amounts to absolute currency before a multiple divides, and discloses the * conversion — a thousands-scale filing must not shift every multiple by 1,000×. */ export interface MarketObservation { /** When the price was observed (epoch ms). Must not precede the fundamentals' availability. */ observedTimestampMs: EpochMs; sharePrice: number; /** Split-adjusted shares consistent with `sharePrice`. */ sharesOutstanding?: number; marketCapitalization?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - marketCapitalization?: number; default: not declared - observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - sharePrice: number; default: not declared - sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. ### @insiderfinance/totalfinance/fundamentals#PairRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Average-balance heads: the period being measured and the immediately prior period. ```typescript /** Average-balance heads: the period being measured and the immediately prior period. */ export interface PairRatioInput { current: FinancialStatements; prior: FinancialStatements; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: FinancialStatements; default: not declared - current.balance: BalanceSheet; default: not declared - current.balance.accountsPayable?: number; default: not declared - current.balance.accountsReceivable?: number; default: not declared - current.balance.cashAndCashEquivalents: number; default: not declared - current.balance.currentAssets?: number; default: not declared - current.balance.currentLiabilities?: number; default: not declared - current.balance.inventory?: number; default: not declared - current.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - current.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.balance.minorityInterest?: number; default: not declared - current.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - current.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.balance.period.fiscalYear: number; default: not declared - current.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.balance.preferredEquity?: number; default: not declared - current.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - current.balance.retainedEarnings?: number; default: not declared - current.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - current.balance.shortTermInvestments?: number; default: not declared - current.balance.totalAssets: number; default: not declared - current.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - current.balance.totalEquity: number; default: not declared - current.balance.totalLiabilities: number; default: not declared - current.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - current.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - current.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - current.cashFlow.depreciationAndAmortization?: number; default: not declared - current.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - current.cashFlow.financingCashFlow: number; default: not declared - current.cashFlow.investingCashFlow: number; default: not declared - current.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.cashFlow.operatingCashFlow: number; default: not declared - current.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - current.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.cashFlow.period.fiscalYear: number; default: not declared - current.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - current.cashFlow.stockBasedCompensation?: number; default: not declared - current.income: IncomeStatement; default: not declared - current.income.costOfRevenue?: number; default: not declared — Positive magnitude. - current.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - current.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - current.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - current.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - current.income.interestExpense?: number; default: not declared — Positive magnitude. - current.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.income.netIncome: number; default: not declared - current.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - current.income.operatingIncome: number; default: not declared - current.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.income.period.accession?: string; default: not declared — Source accession identifier, when known. - current.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.income.period.fiscalYear: number; default: not declared - current.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.income.revenue: number; default: not declared - current.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - prior: FinancialStatements; default: not declared - prior.balance: BalanceSheet; default: not declared - prior.balance.accountsPayable?: number; default: not declared - prior.balance.accountsReceivable?: number; default: not declared - prior.balance.cashAndCashEquivalents: number; default: not declared - prior.balance.currentAssets?: number; default: not declared - prior.balance.currentLiabilities?: number; default: not declared - prior.balance.inventory?: number; default: not declared - prior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - prior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.balance.minorityInterest?: number; default: not declared - prior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.balance.period.fiscalYear: number; default: not declared - prior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.balance.preferredEquity?: number; default: not declared - prior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - prior.balance.retainedEarnings?: number; default: not declared - prior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - prior.balance.shortTermInvestments?: number; default: not declared - prior.balance.totalAssets: number; default: not declared - prior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - prior.balance.totalEquity: number; default: not declared - prior.balance.totalLiabilities: number; default: not declared - prior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - prior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - prior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - prior.cashFlow.depreciationAndAmortization?: number; default: not declared - prior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - prior.cashFlow.financingCashFlow: number; default: not declared - prior.cashFlow.investingCashFlow: number; default: not declared - prior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.cashFlow.operatingCashFlow: number; default: not declared - prior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.cashFlow.period.fiscalYear: number; default: not declared - prior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - prior.cashFlow.stockBasedCompensation?: number; default: not declared - prior.income: IncomeStatement; default: not declared - prior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - prior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - prior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - prior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - prior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - prior.income.interestExpense?: number; default: not declared — Positive magnitude. - prior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.income.netIncome: number; default: not declared - prior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - prior.income.operatingIncome: number; default: not declared - prior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.income.period.fiscalYear: number; default: not declared - prior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.income.revenue: number; default: not declared - prior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#PerShareFundamentalsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link perShareFundamentals}. ```typescript // --------------------------------------------------------------------------------------------------- // perShareFundamentals // --------------------------------------------------------------------------------------------------- /** Input for {@link perShareFundamentals}. */ export interface PerShareFundamentalsInput { statements: FinancialStatements; /** * Cumulative split factor between the period and the observer's share basis (e.g. `2` after a * 2-for-1 split since the period end). Default `1` — no split; the factor used is echoed. */ splitFactorSincePeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - splitFactorSincePeriod?: number; default: not declared — Cumulative split factor between the period and the observer's share basis (e.g. `2` after a 2-for-1 split since the period end). Default `1` — no split; the factor used is echoed. - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#PerShareFundamentalsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link perShareFundamentals}. ```typescript /** Result of {@link perShareFundamentals}. */ export interface PerShareFundamentalsResult { assumptions: { splitFactorSincePeriod: number; dilutedSharesUsed: number; /** Per-share values are ABSOLUTE currency per share (amount × monetaryScale / shares). */ unitBasis: 'absolute currency per share'; }; diagnostics: { warnings: string[]; }; /** Split-adjusted diluted shares actually used as the denominator. */ dilutedSharesUsed: number; splitFactorSincePeriod: number; earningsPerShare: number; revenuePerShare: number; bookValuePerShare: number; /** `operatingCashFlow - capitalExpenditure` per share; `null` when capex is absent. */ freeCashFlowPerShare: number | null; freeCashFlowPerShareReason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { dilutedSharesUsed: number; splitFactorSincePeriod: number; unitBasis: 'absolute currency per share'; }; default: not declared - assumptions.dilutedSharesUsed: number; default: not declared - assumptions.splitFactorSincePeriod: number; default: not declared - assumptions.unitBasis: 'absolute currency per share'; default: not declared — Per-share values are ABSOLUTE currency per share (amount × monetaryScale / shares). - bookValuePerShare: number; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - dilutedSharesUsed: number; default: not declared — Split-adjusted diluted shares actually used as the denominator. - earningsPerShare: number; default: not declared - freeCashFlowPerShare: number | null; default: not declared — `operatingCashFlow - capitalExpenditure` per share; `null` when capex is absent. - freeCashFlowPerShareReason?: string; default: not declared - revenuePerShare: number; default: not declared - splitFactorSincePeriod: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#PiotroskiInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link piotroskiFScore}: three consecutive periods of one entity. ```typescript // --------------------------------------------------------------------------------------------------- // Piotroski F-score // --------------------------------------------------------------------------------------------------- /** Input for {@link piotroskiFScore}: three consecutive periods of one entity. */ export interface PiotroskiInput { current: FinancialStatements; prior: FinancialStatements; /** * The period before `prior`. Needed because the paper's return and turnover use BEGINNING * assets, so the prior year's own signal needs the balance sheet one further back. */ priorPrior: FinancialStatements; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: FinancialStatements; default: not declared - current.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - current.balance.accountsPayable?: number; default: not declared - current.balance.accountsReceivable?: number; default: not declared - current.balance.cashAndCashEquivalents: number; default: not declared - current.balance.currentAssets?: number; default: not declared - current.balance.currentLiabilities?: number; default: not declared - current.balance.inventory?: number; default: not declared - current.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - current.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.balance.minorityInterest?: number; default: not declared - current.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - current.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.balance.period.fiscalYear: number; default: not declared - current.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.balance.preferredEquity?: number; default: not declared - current.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - current.balance.retainedEarnings?: number; default: not declared - current.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - current.balance.shortTermInvestments?: number; default: not declared - current.balance.totalAssets: number; default: not declared - current.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - current.balance.totalEquity: number; default: not declared - current.balance.totalLiabilities: number; default: not declared - current.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - current.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - current.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - current.cashFlow.depreciationAndAmortization?: number; default: not declared - current.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - current.cashFlow.financingCashFlow: number; default: not declared - current.cashFlow.investingCashFlow: number; default: not declared - current.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.cashFlow.operatingCashFlow: number; default: not declared - current.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - current.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.cashFlow.period.fiscalYear: number; default: not declared - current.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - current.cashFlow.stockBasedCompensation?: number; default: not declared - current.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - current.income.costOfRevenue?: number; default: not declared — Positive magnitude. - current.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - current.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - current.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - current.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - current.income.interestExpense?: number; default: not declared — Positive magnitude. - current.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.income.netIncome: number; default: not declared - current.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - current.income.operatingIncome: number; default: not declared - current.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.income.period.accession?: string; default: not declared — Source accession identifier, when known. - current.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.income.period.fiscalYear: number; default: not declared - current.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.income.revenue: number; default: not declared - current.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - prior: FinancialStatements; default: not declared - prior.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - prior.balance.accountsPayable?: number; default: not declared - prior.balance.accountsReceivable?: number; default: not declared - prior.balance.cashAndCashEquivalents: number; default: not declared - prior.balance.currentAssets?: number; default: not declared - prior.balance.currentLiabilities?: number; default: not declared - prior.balance.inventory?: number; default: not declared - prior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - prior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.balance.minorityInterest?: number; default: not declared - prior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.balance.period.fiscalYear: number; default: not declared - prior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.balance.preferredEquity?: number; default: not declared - prior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - prior.balance.retainedEarnings?: number; default: not declared - prior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - prior.balance.shortTermInvestments?: number; default: not declared - prior.balance.totalAssets: number; default: not declared - prior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - prior.balance.totalEquity: number; default: not declared - prior.balance.totalLiabilities: number; default: not declared - prior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - prior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - prior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - prior.cashFlow.depreciationAndAmortization?: number; default: not declared - prior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - prior.cashFlow.financingCashFlow: number; default: not declared - prior.cashFlow.investingCashFlow: number; default: not declared - prior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.cashFlow.operatingCashFlow: number; default: not declared - prior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.cashFlow.period.fiscalYear: number; default: not declared - prior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - prior.cashFlow.stockBasedCompensation?: number; default: not declared - prior.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - prior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - prior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - prior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - prior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - prior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - prior.income.interestExpense?: number; default: not declared — Positive magnitude. - prior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.income.netIncome: number; default: not declared - prior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - prior.income.operatingIncome: number; default: not declared - prior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.income.period.fiscalYear: number; default: not declared - prior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.income.revenue: number; default: not declared - prior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - priorPrior: FinancialStatements; default: not declared — The period before `prior`. Needed because the paper's return and turnover use BEGINNING assets, so the prior year's own signal needs the balance sheet one further back. - priorPrior.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - priorPrior.balance.accountsPayable?: number; default: not declared - priorPrior.balance.accountsReceivable?: number; default: not declared - priorPrior.balance.cashAndCashEquivalents: number; default: not declared - priorPrior.balance.currentAssets?: number; default: not declared - priorPrior.balance.currentLiabilities?: number; default: not declared - priorPrior.balance.inventory?: number; default: not declared - priorPrior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - priorPrior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - priorPrior.balance.minorityInterest?: number; default: not declared - priorPrior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - priorPrior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - priorPrior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - priorPrior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - priorPrior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - priorPrior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - priorPrior.balance.period.fiscalYear: number; default: not declared - priorPrior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - priorPrior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - priorPrior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - priorPrior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - priorPrior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - priorPrior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - priorPrior.balance.preferredEquity?: number; default: not declared - priorPrior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - priorPrior.balance.retainedEarnings?: number; default: not declared - priorPrior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - priorPrior.balance.shortTermInvestments?: number; default: not declared - priorPrior.balance.totalAssets: number; default: not declared - priorPrior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - priorPrior.balance.totalEquity: number; default: not declared - priorPrior.balance.totalLiabilities: number; default: not declared - priorPrior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - priorPrior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - priorPrior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - priorPrior.cashFlow.depreciationAndAmortization?: number; default: not declared - priorPrior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - priorPrior.cashFlow.financingCashFlow: number; default: not declared - priorPrior.cashFlow.investingCashFlow: number; default: not declared - priorPrior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - priorPrior.cashFlow.operatingCashFlow: number; default: not declared - priorPrior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - priorPrior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - priorPrior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - priorPrior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - priorPrior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - priorPrior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - priorPrior.cashFlow.period.fiscalYear: number; default: not declared - priorPrior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - priorPrior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - priorPrior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - priorPrior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - priorPrior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - priorPrior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - priorPrior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - priorPrior.cashFlow.stockBasedCompensation?: number; default: not declared - priorPrior.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - priorPrior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - priorPrior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - priorPrior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - priorPrior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - priorPrior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - priorPrior.income.interestExpense?: number; default: not declared — Positive magnitude. - priorPrior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - priorPrior.income.netIncome: number; default: not declared - priorPrior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - priorPrior.income.operatingIncome: number; default: not declared - priorPrior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - priorPrior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - priorPrior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - priorPrior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - priorPrior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - priorPrior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - priorPrior.income.period.fiscalYear: number; default: not declared - priorPrior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - priorPrior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - priorPrior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - priorPrior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - priorPrior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - priorPrior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - priorPrior.income.revenue: number; default: not declared - priorPrior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#PiotroskiResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link piotroskiFScore}. ```typescript /** Result of {@link piotroskiFScore}. */ export interface PiotroskiResult { assumptions: { /** The published model name (a label, deliberately not a literal type). */ model: string; /** Returns and turnover use BEGINNING total assets, per the paper. */ returnBasis: 'beginning total assets'; }; diagnostics: { /** One warning per unevaluable signal. */ warnings: string[]; }; /** Sum of the evaluable signals (each 0 or 1). */ fScore: number; /** How many of the nine signals could be evaluated; 9 when every input line was present. */ evaluableSignals: number; signals: PiotroskiSignal[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { model: string; returnBasis: 'beginning total assets'; }; default: not declared - assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - assumptions.returnBasis: 'beginning total assets'; default: not declared — Returns and turnover use BEGINNING total assets, per the paper. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — One warning per unevaluable signal. - evaluableSignals: number; default: not declared — How many of the nine signals could be evaluated; 9 when every input line was present. - fScore: number; default: not declared — Sum of the evaluable signals (each 0 or 1). - signals: PiotroskiSignal[]; default: not declared ### @insiderfinance/totalfinance/fundamentals#PiotroskiSignal Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One of the nine binary signals. ```typescript /** One of the nine binary signals. */ export interface PiotroskiSignal { signal: string; /** 1 or 0 per the paper; `null` with `reason` when an optional statement line is absent. */ value: 0 | 1 | null; detail: string; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: string; default: not declared - reason?: string; default: not declared - signal: string; default: not declared - value: 0 | 1 | null; default: not declared — 1 or 0 per the paper; `null` with `reason` when an optional statement line is absent. ### @insiderfinance/totalfinance/fundamentals#RatioCategory Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Report shape // --------------------------------------------------------------------------------------------------- export type RatioCategory = 'profitability' | 'returns' | 'liquidity' | 'leverage' | 'efficiency' | 'quality' | 'per-share' | 'valuation'; ``` ### @insiderfinance/totalfinance/fundamentals#RatioFacade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A ratio head: plain value + `.explain`. The DECLARED input is the head's exact shape — the declaration never licenses a key the runtime refuses (the shared bag stays kernel-internal). ```typescript /** * A ratio head: plain value + `.explain`. The DECLARED input is the head's exact shape — the * declaration never licenses a key the runtime refuses (the shared bag stays kernel-internal). */ export interface RatioFacade { (input: Input): number | null; explain(input: Input): RatioReport; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Input; default: not declared - explain: (input: Input) => RatioReport; default: not declared - explain().return.assumptions: { category: RatioCategory; conventionsVersion: string; formula: string; period: RatioPeriodIdentity; priorPeriod?: RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): Input; default: not declared ### @insiderfinance/totalfinance/fundamentals#RatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Common inputs a ratio head can declare. ```typescript // --------------------------------------------------------------------------------------------------- // The maker // --------------------------------------------------------------------------------------------------- /** Common inputs a ratio head can declare. */ export interface RatioInput { /** Single-period heads. */ statements?: FinancialStatements; /** Additive direct path for an income-only formula. */ income?: IncomeStatement; /** Additive direct path for a balance-only formula. */ balance?: BalanceSheet; /** Average-denominator heads: the period being measured… */ current?: FinancialStatements; /** …and the immediately prior period (average balances need both endpoints). */ prior?: FinancialStatements; /** Day-count heads: the explicit number of days in the period (never guessed from periodType). */ periodDays?: number; /** Market-multiple heads. */ marketObservation?: MarketObservation; /** Market-multiple heads: reject a price observed more than this after availability. */ maximumStalenessMs?: number; /** ROIC: explicit tax rate; when absent the effective rate is derived and disclosed. */ taxRate?: number; /** debtServiceCoverage: the exact debt-service denominator (interest + scheduled principal). */ debtServiceAmount?: number; /** Enterprise-value heads: separately supplied non-operating assets. */ nonOperatingAssets?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balance?: BalanceSheet; default: not declared — Additive direct path for a balance-only formula. - balance.accountsPayable?: number; default: not declared - balance.accountsReceivable?: number; default: not declared - balance.cashAndCashEquivalents: number; default: not declared - balance.currentAssets?: number; default: not declared - balance.currentLiabilities?: number; default: not declared - balance.inventory?: number; default: not declared - balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - balance.minorityInterest?: number; default: not declared - balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - balance.period.accession?: string; default: not declared — Source accession identifier, when known. - balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - balance.period.fiscalYear: number; default: not declared - balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - balance.preferredEquity?: number; default: not declared - balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - balance.retainedEarnings?: number; default: not declared - balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - balance.shortTermInvestments?: number; default: not declared - balance.totalAssets: number; default: not declared - balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - balance.totalEquity: number; default: not declared - balance.totalLiabilities: number; default: not declared - current?: FinancialStatements; default: not declared — Average-denominator heads: the period being measured… - current.balance: BalanceSheet; default: not declared - current.balance.accountsPayable?: number; default: not declared - current.balance.accountsReceivable?: number; default: not declared - current.balance.cashAndCashEquivalents: number; default: not declared - current.balance.currentAssets?: number; default: not declared - current.balance.currentLiabilities?: number; default: not declared - current.balance.inventory?: number; default: not declared - current.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - current.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.balance.minorityInterest?: number; default: not declared - current.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - current.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.balance.period.fiscalYear: number; default: not declared - current.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.balance.preferredEquity?: number; default: not declared - current.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - current.balance.retainedEarnings?: number; default: not declared - current.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - current.balance.shortTermInvestments?: number; default: not declared - current.balance.totalAssets: number; default: not declared - current.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - current.balance.totalEquity: number; default: not declared - current.balance.totalLiabilities: number; default: not declared - current.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - current.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - current.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - current.cashFlow.depreciationAndAmortization?: number; default: not declared - current.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - current.cashFlow.financingCashFlow: number; default: not declared - current.cashFlow.investingCashFlow: number; default: not declared - current.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.cashFlow.operatingCashFlow: number; default: not declared - current.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - current.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.cashFlow.period.fiscalYear: number; default: not declared - current.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - current.cashFlow.stockBasedCompensation?: number; default: not declared - current.income: IncomeStatement; default: not declared - current.income.costOfRevenue?: number; default: not declared — Positive magnitude. - current.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - current.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - current.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - current.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - current.income.interestExpense?: number; default: not declared — Positive magnitude. - current.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - current.income.netIncome: number; default: not declared - current.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - current.income.operatingIncome: number; default: not declared - current.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - current.income.period.accession?: string; default: not declared — Source accession identifier, when known. - current.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - current.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - current.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - current.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - current.income.period.fiscalYear: number; default: not declared - current.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - current.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - current.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - current.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - current.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - current.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - current.income.revenue: number; default: not declared - current.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - debtServiceAmount?: number; default: not declared — debtServiceCoverage: the exact debt-service denominator (interest + scheduled principal). - income?: IncomeStatement; default: not declared — Additive direct path for an income-only formula. - income.costOfRevenue?: number; default: not declared — Positive magnitude. - income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - income.interestExpense?: number; default: not declared — Positive magnitude. - income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - income.netIncome: number; default: not declared - income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - income.operatingIncome: number; default: not declared - income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - income.period.accession?: string; default: not declared — Source accession identifier, when known. - income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - income.period.fiscalYear: number; default: not declared - income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - income.revenue: number; default: not declared - income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - marketObservation?: MarketObservation; default: not declared — Market-multiple heads. - marketObservation.marketCapitalization?: number; default: not declared - marketObservation.observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - marketObservation.sharePrice: number; default: not declared - marketObservation.sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. - maximumStalenessMs?: number; default: not declared — Market-multiple heads: reject a price observed more than this after availability. - nonOperatingAssets?: number; default: not declared — Enterprise-value heads: separately supplied non-operating assets. - periodDays?: number; default: not declared — Day-count heads: the explicit number of days in the period (never guessed from periodType). - prior?: FinancialStatements; default: not declared — …and the immediately prior period (average balances need both endpoints). - prior.balance: BalanceSheet; default: not declared - prior.balance.accountsPayable?: number; default: not declared - prior.balance.accountsReceivable?: number; default: not declared - prior.balance.cashAndCashEquivalents: number; default: not declared - prior.balance.currentAssets?: number; default: not declared - prior.balance.currentLiabilities?: number; default: not declared - prior.balance.inventory?: number; default: not declared - prior.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - prior.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.balance.minorityInterest?: number; default: not declared - prior.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.balance.period.fiscalYear: number; default: not declared - prior.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.balance.preferredEquity?: number; default: not declared - prior.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - prior.balance.retainedEarnings?: number; default: not declared - prior.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - prior.balance.shortTermInvestments?: number; default: not declared - prior.balance.totalAssets: number; default: not declared - prior.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - prior.balance.totalEquity: number; default: not declared - prior.balance.totalLiabilities: number; default: not declared - prior.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - prior.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - prior.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - prior.cashFlow.depreciationAndAmortization?: number; default: not declared - prior.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - prior.cashFlow.financingCashFlow: number; default: not declared - prior.cashFlow.investingCashFlow: number; default: not declared - prior.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.cashFlow.operatingCashFlow: number; default: not declared - prior.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.cashFlow.period.fiscalYear: number; default: not declared - prior.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - prior.cashFlow.stockBasedCompensation?: number; default: not declared - prior.income: IncomeStatement; default: not declared - prior.income.costOfRevenue?: number; default: not declared — Positive magnitude. - prior.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - prior.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - prior.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - prior.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - prior.income.interestExpense?: number; default: not declared — Positive magnitude. - prior.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - prior.income.netIncome: number; default: not declared - prior.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - prior.income.operatingIncome: number; default: not declared - prior.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - prior.income.period.accession?: string; default: not declared — Source accession identifier, when known. - prior.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - prior.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - prior.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - prior.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - prior.income.period.fiscalYear: number; default: not declared - prior.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - prior.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - prior.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - prior.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - prior.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - prior.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - prior.income.revenue: number; default: not declared - prior.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - statements?: FinancialStatements; default: not declared — Single-period heads. - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - taxRate?: number; default: not declared — ROIC: explicit tax rate; when absent the effective rate is derived and disclosed. ### @insiderfinance/totalfinance/fundamentals#RatioPeriodIdentity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The identity of the period a ratio was computed over. ```typescript /** The identity of the period a ratio was computed over. */ export interface RatioPeriodIdentity { periodEndDate: string; periodType: string; fiscalYear: number; currency: string; monetaryScale: number; /** Direct statement availability, or the latest availability in a complete validated set. */ availableTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - availableTimestampMs?: number; default: not declared — Direct statement availability, or the latest availability in a complete validated set. - currency: string; default: not declared - fiscalYear: number; default: not declared - monetaryScale: number; default: not declared - periodEndDate: string; default: not declared - periodType: string; default: not declared ### @insiderfinance/totalfinance/fundamentals#RatioReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What `.explain()` returns for every ratio head — the ONE `Computed` envelope (dx §7.2). ```typescript /** What `.explain()` returns for every ratio head — the ONE `Computed` envelope (dx §7.2). */ export interface RatioReport { /** A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. */ value: number | null; assumptions: { conventionsVersion: string; ratioName: string; category: RatioCategory; /** The fixed formula, stated as prose (also in the generated reference documentation). */ formula: string; period: RatioPeriodIdentity; priorPeriod?: RatioPeriodIdentity; }; diagnostics: { warnings: string[]; numerator: { label: string; amount: number; } | null; denominator: { label: string; amount: number; } | null; /** Every derivation, omission, and convention the computation relied on. */ notes: string[]; /** Present exactly when `value` is null. */ reason?: string; /** For market multiples: how far the price sits after the fundamentals became available. */ marketStalenessMs?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { category: RatioCategory; conventionsVersion: string; formula: string; period: RatioPeriodIdentity; priorPeriod?: RatioPeriodIdentity; ratioName: string; }; default: not declared - assumptions.category: RatioCategory; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - assumptions.period: RatioPeriodIdentity; default: not declared - assumptions.period.availableTimestampMs?: number; default: not declared — Direct statement availability, or the latest availability in a complete validated set. - assumptions.period.currency: string; default: not declared - assumptions.period.fiscalYear: number; default: not declared - assumptions.period.monetaryScale: number; default: not declared - assumptions.period.periodEndDate: string; default: not declared - assumptions.period.periodType: string; default: not declared - assumptions.priorPeriod?: RatioPeriodIdentity; default: not declared - assumptions.priorPeriod.availableTimestampMs?: number; default: not declared — Direct statement availability, or the latest availability in a complete validated set. - assumptions.priorPeriod.currency: string; default: not declared - assumptions.priorPeriod.fiscalYear: number; default: not declared - assumptions.priorPeriod.monetaryScale: number; default: not declared - assumptions.priorPeriod.periodEndDate: string; default: not declared - assumptions.priorPeriod.periodType: string; default: not declared - assumptions.ratioName: string; default: not declared - diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - diagnostics.denominator.amount: number; default: not declared - diagnostics.denominator.label: string; default: not declared - diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - diagnostics.numerator.amount: number; default: not declared - diagnostics.numerator.label: string; default: not declared - diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - diagnostics.warnings: string[]; default: not declared - value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. ### @insiderfinance/totalfinance/fundamentals#RawFundamentalsRecord Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#RawFundamentalsRecord`. ### @insiderfinance/totalfinance/fundamentals#ReconcileStatementsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link reconcileFinancialStatements}. ```typescript // --------------------------------------------------------------------------------------------------- // reconcileFinancialStatements // --------------------------------------------------------------------------------------------------- /** Input for {@link reconcileFinancialStatements}. */ export interface ReconcileStatementsInput { statements: FinancialStatements; /** The immediately prior period, enabling the cash-articulation check across the two. */ priorStatements?: FinancialStatements; /** * Absolute tolerance in reported units (period.monetaryScale). Default `1` — one reported unit, * the rounding a scaled filing can legitimately carry. Documented and echoed in the result. */ toleranceAmount?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - priorStatements?: FinancialStatements; default: not declared — The immediately prior period, enabling the cash-articulation check across the two. - priorStatements.balance: BalanceSheet; default: not declared - priorStatements.balance.accountsPayable?: number; default: not declared - priorStatements.balance.accountsReceivable?: number; default: not declared - priorStatements.balance.cashAndCashEquivalents: number; default: not declared - priorStatements.balance.currentAssets?: number; default: not declared - priorStatements.balance.currentLiabilities?: number; default: not declared - priorStatements.balance.inventory?: number; default: not declared - priorStatements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - priorStatements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - priorStatements.balance.minorityInterest?: number; default: not declared - priorStatements.balance.period: FundamentalPeriod; default: not declared - priorStatements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - priorStatements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - priorStatements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - priorStatements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - priorStatements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - priorStatements.balance.period.fiscalYear: number; default: not declared - priorStatements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - priorStatements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - priorStatements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - priorStatements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - priorStatements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - priorStatements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - priorStatements.balance.preferredEquity?: number; default: not declared - priorStatements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - priorStatements.balance.retainedEarnings?: number; default: not declared - priorStatements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - priorStatements.balance.shortTermInvestments?: number; default: not declared - priorStatements.balance.totalAssets: number; default: not declared - priorStatements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - priorStatements.balance.totalEquity: number; default: not declared - priorStatements.balance.totalLiabilities: number; default: not declared - priorStatements.cashFlow: CashFlowStatement; default: not declared - priorStatements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - priorStatements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - priorStatements.cashFlow.depreciationAndAmortization?: number; default: not declared - priorStatements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - priorStatements.cashFlow.financingCashFlow: number; default: not declared - priorStatements.cashFlow.investingCashFlow: number; default: not declared - priorStatements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - priorStatements.cashFlow.operatingCashFlow: number; default: not declared - priorStatements.cashFlow.period: FundamentalPeriod; default: not declared - priorStatements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - priorStatements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - priorStatements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - priorStatements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - priorStatements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - priorStatements.cashFlow.period.fiscalYear: number; default: not declared - priorStatements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - priorStatements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - priorStatements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - priorStatements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - priorStatements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - priorStatements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - priorStatements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - priorStatements.cashFlow.stockBasedCompensation?: number; default: not declared - priorStatements.income: IncomeStatement; default: not declared - priorStatements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - priorStatements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - priorStatements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - priorStatements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - priorStatements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - priorStatements.income.interestExpense?: number; default: not declared — Positive magnitude. - priorStatements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - priorStatements.income.netIncome: number; default: not declared - priorStatements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - priorStatements.income.operatingIncome: number; default: not declared - priorStatements.income.period: FundamentalPeriod; default: not declared - priorStatements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - priorStatements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - priorStatements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - priorStatements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - priorStatements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - priorStatements.income.period.fiscalYear: number; default: not declared - priorStatements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - priorStatements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - priorStatements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - priorStatements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - priorStatements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - priorStatements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - priorStatements.income.revenue: number; default: not declared - priorStatements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - toleranceAmount?: number; default: not declared — Absolute tolerance in reported units (period.monetaryScale). Default `1` — one reported unit, the rounding a scaled filing can legitimately carry. Documented and echoed in the result. ### @insiderfinance/totalfinance/fundamentals#ReconciliationCheck Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One accounting-identity check. ```typescript /** One accounting-identity check. */ export interface ReconciliationCheck { name: string; /** `left - right` in reported units; `null` when a required field is absent. */ difference: number | null; withinTolerance: boolean | null; detail: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: string; default: not declared - difference: number | null; default: not declared — `left - right` in reported units; `null` when a required field is absent. - name: string; default: not declared - withinTolerance: boolean | null; default: not declared ### @insiderfinance/totalfinance/fundamentals#ReconciliationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link reconcileFinancialStatements}. ```typescript /** Result of {@link reconcileFinancialStatements}. */ export interface ReconciliationResult { assumptions: { /** Absolute tolerance in reported units, echoed (default 1). */ toleranceAmount: number; }; diagnostics: { /** One warning per failed or unevaluable check. */ warnings: string[]; }; checks: ReconciliationCheck[]; toleranceAmount: number; /** True when every evaluable check is within tolerance. */ reconciles: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { toleranceAmount: number; }; default: not declared - assumptions.toleranceAmount: number; default: not declared — Absolute tolerance in reported units, echoed (default 1). - checks: ReconciliationCheck[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — One warning per failed or unevaluable check. - reconciles: boolean; default: not declared — True when every evaluable check is within tolerance. - toleranceAmount: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#RestatementPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How {@link selectFundamentalSnapshot } resolves multiple visible versions of one period. ```typescript /** How {@link selectFundamentalSnapshot} resolves multiple visible versions of one period. */ export type RestatementPolicy = 'latest-available' | 'first-reported'; ``` ### @insiderfinance/totalfinance/fundamentals#SelectFundamentalSnapshotInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link selectFundamentalSnapshot}. ```typescript // --------------------------------------------------------------------------------------------------- // selectFundamentalSnapshot // --------------------------------------------------------------------------------------------------- /** Input for {@link selectFundamentalSnapshot}. */ export interface SelectFundamentalSnapshotInput { series: FundamentalSeries; /** The observation instant (epoch ms). Only sets whose availability is at or before it qualify. */ asOf: EpochMs; /** How multiple visible versions of one period resolve. */ restatementPolicy: RestatementPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared — The observation instant (epoch ms). Only sets whose availability is at or before it qualify. - restatementPolicy: RestatementPolicy; default: not declared — How multiple visible versions of one period resolve. - series: FundamentalSeries; default: not declared - series.entity?: string; default: not declared — Optional entity label carried into diagnostics (a symbol, CIK, or internal id). - series.statements: readonly FinancialStatements[]; default: not declared ### @insiderfinance/totalfinance/fundamentals#SingleStatementRatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Single-period heads. ```typescript /** Single-period heads. */ export interface SingleStatementRatioInput { statements: FinancialStatements; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - statements: FinancialStatements; default: not declared - statements.balance: BalanceSheet; default: not declared - statements.balance.accountsPayable?: number; default: not declared - statements.balance.accountsReceivable?: number; default: not declared - statements.balance.cashAndCashEquivalents: number; default: not declared - statements.balance.currentAssets?: number; default: not declared - statements.balance.currentLiabilities?: number; default: not declared - statements.balance.inventory?: number; default: not declared - statements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - statements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.balance.minorityInterest?: number; default: not declared - statements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.balance.period.fiscalYear: number; default: not declared - statements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.balance.preferredEquity?: number; default: not declared - statements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - statements.balance.retainedEarnings?: number; default: not declared - statements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - statements.balance.shortTermInvestments?: number; default: not declared - statements.balance.totalAssets: number; default: not declared - statements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - statements.balance.totalEquity: number; default: not declared - statements.balance.totalLiabilities: number; default: not declared - statements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - statements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - statements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - statements.cashFlow.depreciationAndAmortization?: number; default: not declared - statements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - statements.cashFlow.financingCashFlow: number; default: not declared - statements.cashFlow.investingCashFlow: number; default: not declared - statements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.cashFlow.operatingCashFlow: number; default: not declared - statements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.cashFlow.period.fiscalYear: number; default: not declared - statements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - statements.cashFlow.stockBasedCompensation?: number; default: not declared - statements.income: IncomeStatement; default: not declared - statements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - statements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - statements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - statements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - statements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - statements.income.interestExpense?: number; default: not declared — Positive magnitude. - statements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - statements.income.netIncome: number; default: not declared - statements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - statements.income.operatingIncome: number; default: not declared - statements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - statements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - statements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - statements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - statements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - statements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - statements.income.period.fiscalYear: number; default: not declared - statements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - statements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - statements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - statements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - statements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - statements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - statements.income.revenue: number; default: not declared - statements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#TrailingTwelveMonthInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link trailingTwelveMonthStatements}. ```typescript // --------------------------------------------------------------------------------------------------- // trailingTwelveMonthStatements // --------------------------------------------------------------------------------------------------- /** Input for {@link trailingTwelveMonthStatements}. */ export interface TrailingTwelveMonthInput { /** Exactly four consecutive fiscal quarters, period end ascending. */ statements: readonly FinancialStatements[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - statements: readonly FinancialStatements[]; default: not declared — Exactly four consecutive fiscal quarters, period end ascending. ### @insiderfinance/totalfinance/fundamentals#accrualRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const accrualRatio: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#altmanZScore Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Altman Z-score with the published coefficients and denominator definitions per variant. `X1` working capital / assets, `X2` retained earnings / assets, `X3` operating income / assets, `X4` the variant's equity basis / total liabilities, `X5` sales / assets where the variant has one. The variant is REQUIRED — there is no default bankruptcy model. ```typescript export declare function altmanZScore(input: AltmanInput): AltmanResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AltmanInput; default: not declared - (input).marketEquity?: number; default: not declared — REQUIRED for `public-manufacturing` (its X4 uses market equity); rejected otherwise. - (input).statements: FinancialStatements; default: not declared - (input).variant: AltmanVariant; default: not declared - return.assumptions: { equityBasis: 'market' | 'book'; model: string; variant: AltmanVariant; }; default: not declared - return.assumptions.equityBasis: 'market' | 'book'; default: not declared - return.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - return.assumptions.variant: AltmanVariant; default: not declared - return.components: AltmanComponent[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.variant: AltmanVariant; default: not declared - return.zScore: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#analyzeFundamentals Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The one-call analysis. Missing inputs disable exactly the metrics that need them, each with a stated reason; nothing is guessed, proxied, or silently skipped. ```typescript export declare function analyzeFundamentals(input: AnalyzeFundamentalsInput): AnalyzeFundamentalsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AnalyzeFundamentalsInput; default: not declared - (input).altmanVariant?: AltmanVariant; default: not declared — Runs the Altman Z-score under this explicit published variant; absent → reported missing. - (input).asOf: number; default: not declared - (input).debtServiceAmount?: number; default: not declared — The exact debt-service denominator; absent → debtServiceCoverage is reported missing. - (input).marketSnapshot?: MarketObservation; default: not declared — The market side for valuation multiples; without it they are reported missing, not guessed. - (input).maximumStalenessMs?: number; default: not declared — Bounds market-observation staleness for the multiples when supplied. - (input).nonOperatingAssets?: number; default: not declared — Separately supplied non-operating assets for enterprise value. - (input).periodDays?: number; default: not declared — Day metrics need the explicit period-day count; absent → they are reported missing. - (input).restatementPolicy: RestatementPolicy; default: not declared - (input).statements: readonly FinancialStatements[]; default: not declared — The reported history (restatements included) — the analysis sees only what `asOf` allows. - (input).taxRate?: number; default: not declared — Explicit tax rate for return on invested capital; else the effective rate is derived. - return.asOf: number; default: not declared - return.assumptions: { asOf: EpochMs; periodUsed: { periodEndDate: string; periodType: string; fiscalYear: number; }; priorPeriodUsed?: { periodEndDate: string; periodType: string; fiscalYear: number; }; restatementPolicy: RestatementPolicy; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.periodUsed: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared - return.assumptions.periodUsed.fiscalYear: number; default: not declared - return.assumptions.periodUsed.periodEndDate: string; default: not declared - return.assumptions.periodUsed.periodType: string; default: not declared - return.assumptions.priorPeriodUsed?: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared - return.assumptions.priorPeriodUsed.fiscalYear: number; default: not declared - return.assumptions.priorPeriodUsed.periodEndDate: string; default: not declared - return.assumptions.priorPeriodUsed.periodType: string; default: not declared - return.assumptions.restatementPolicy: RestatementPolicy; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — One warning per metric that could not be formed (mirrors `missing`). - return.missing: { metric: string; reason: string; }[]; default: not declared — Every metric that could not be formed, with its reason — the honest gaps ledger. - return.periodUsed: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared — The period the single-period metrics used. - return.periodUsed.fiscalYear: number; default: not declared - return.periodUsed.periodEndDate: string; default: not declared - return.periodUsed.periodType: string; default: not declared - return.periodsVisible: number; default: not declared — How many statement sets were visible at `asOf` after restatement resolution. - return.priorPeriodUsed?: { fiscalYear: number; periodEndDate: string; periodType: string; }; default: not declared — The prior period the average-balance metrics used, when one was visible. - return.priorPeriodUsed.fiscalYear: number; default: not declared - return.priorPeriodUsed.periodEndDate: string; default: not declared - return.priorPeriodUsed.periodType: string; default: not declared - return.ratios: Record; default: not declared - return.restatementPolicy: RestatementPolicy; default: not declared - return.scores: { altman?: AltmanResult; beneish?: BeneishResult; piotroski?: PiotroskiResult; }; default: not declared - return.scores.altman?: AltmanResult; default: not declared - return.scores.beneish?: BeneishResult; default: not declared - return.scores.piotroski?: PiotroskiResult; default: not declared ### @insiderfinance/totalfinance/fundamentals#assetTurnover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const assetTurnover: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#beneishMScore Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The original eight-variable 1999 Beneish equation `-4.84 + 0.920 DSRI + 0.528 GMI + 0.404 AQI + 0.892 SGI + 0.115 DEPI - 0.172 SGAI + 4.679 TATA - 0.327 LVGI`, with the component definitions fixed to the paper. Every variable the model needs must be present in both periods — there is NO five-variable fallback, silent or otherwise. ```typescript export declare function beneishMScore(input: BeneishInput): BeneishResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BeneishInput; default: not declared - (input).current: FinancialStatements; default: not declared - (input).prior: FinancialStatements; default: not declared - return.assumptions: { model: string; }; default: not declared - return.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - return.components: BeneishComponent[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — Conventions the inputs forced (e.g. D&A standing in for pure depreciation) — disclosed. - return.mScore: number; default: not declared - return.notes: string[]; default: not declared — The same disclosures as `diagnostics.warnings` (kept for direct reading). ### @insiderfinance/totalfinance/fundamentals#bookValuePerShare Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bookValuePerShare: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SingleStatementRatioInput; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): SingleStatementRatioInput; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#cashConversionCycle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cashConversionCycle: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DayMetricRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).periodDays: number; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): DayMetricRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).periodDays: number; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#cashFlowToNetIncome Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cashFlowToNetIncome: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SingleStatementRatioInput; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): SingleStatementRatioInput; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#cashRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cashRatio: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BalanceSheetRatioInput>; default: not declared - (input).balance: Pick & Partial; default: not declared - (input).balance.accountsPayable?: number; default: not declared - (input).balance.accountsReceivable?: number; default: not declared - (input).balance.cashAndCashEquivalents?: number; default: not declared - (input).balance.currentAssets?: number; default: not declared - (input).balance.currentLiabilities?: number; default: not declared - (input).balance.inventory?: number; default: not declared - (input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - (input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).balance.minorityInterest?: number; default: not declared - (input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).balance.preferredEquity?: number; default: not declared - (input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - (input).balance.retainedEarnings?: number; default: not declared - (input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - (input).balance.shortTermInvestments?: number; default: not declared - (input).balance.totalAssets?: number; default: not declared - (input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - (input).balance.totalEquity?: number; default: not declared - (input).balance.totalLiabilities?: number; default: not declared - (input).statements?: never; default: not declared - explain: (input: BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): BalanceSheetRatioInput>; default: not declared - explain(input).balance: Pick & Partial; default: not declared - explain(input).balance.accountsPayable?: number; default: not declared - explain(input).balance.accountsReceivable?: number; default: not declared - explain(input).balance.cashAndCashEquivalents?: number; default: not declared - explain(input).balance.currentAssets?: number; default: not declared - explain(input).balance.currentLiabilities?: number; default: not declared - explain(input).balance.inventory?: number; default: not declared - explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).balance.minorityInterest?: number; default: not declared - explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).balance.preferredEquity?: number; default: not declared - explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - explain(input).balance.retainedEarnings?: number; default: not declared - explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - explain(input).balance.shortTermInvestments?: number; default: not declared - explain(input).balance.totalAssets?: number; default: not declared - explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - explain(input).balance.totalEquity?: number; default: not declared - explain(input).balance.totalLiabilities?: number; default: not declared - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#cashReturnOnAssets Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cashReturnOnAssets: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#commonSizeFinancialStatements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Common-size statements: every reported numeric line divided by its conventional base — income and cash-flow lines by revenue, balance lines by total assets. Fractions, never display percentages. A zero base is an error naming itself, not an Infinity. ```typescript export declare function commonSizeFinancialStatements(input: CommonSizeInput): CommonSizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CommonSizeInput; default: not declared - (input).statements: FinancialStatements; default: not declared - return.assumptions: { balanceBasis: 'totalAssets'; cashFlowBasis: 'revenue'; incomeBasis: 'revenue'; }; default: not declared - return.assumptions.balanceBasis: 'totalAssets'; default: not declared - return.assumptions.cashFlowBasis: 'revenue'; default: not declared - return.assumptions.incomeBasis: 'revenue'; default: not declared - return.balance: { basis: 'totalAssets'; lines: Record; }; default: not declared — Balance lines over `totalAssets`. - return.balance.basis: 'totalAssets'; default: not declared - return.balance.lines: Record; default: not declared - return.cashFlow: { basis: 'revenue'; lines: Record; }; default: not declared — Cash-flow lines over `revenue`. - return.cashFlow.basis: 'revenue'; default: not declared - return.cashFlow.lines: Record; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.income: { basis: 'revenue'; lines: Record; }; default: not declared — Income lines over `revenue`. - return.income.basis: 'revenue'; default: not declared - return.income.lines: Record; default: not declared ### @insiderfinance/totalfinance/fundamentals#currentRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const currentRatio: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BalanceSheetRatioInput>; default: not declared - (input).balance: Pick & Partial; default: not declared - (input).balance.accountsPayable?: number; default: not declared - (input).balance.accountsReceivable?: number; default: not declared - (input).balance.cashAndCashEquivalents?: number; default: not declared - (input).balance.currentAssets?: number; default: not declared - (input).balance.currentLiabilities?: number; default: not declared - (input).balance.inventory?: number; default: not declared - (input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - (input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).balance.minorityInterest?: number; default: not declared - (input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).balance.preferredEquity?: number; default: not declared - (input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - (input).balance.retainedEarnings?: number; default: not declared - (input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - (input).balance.shortTermInvestments?: number; default: not declared - (input).balance.totalAssets?: number; default: not declared - (input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - (input).balance.totalEquity?: number; default: not declared - (input).balance.totalLiabilities?: number; default: not declared - (input).statements?: never; default: not declared - explain: (input: BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): BalanceSheetRatioInput>; default: not declared - explain(input).balance: Pick & Partial; default: not declared - explain(input).balance.accountsPayable?: number; default: not declared - explain(input).balance.accountsReceivable?: number; default: not declared - explain(input).balance.cashAndCashEquivalents?: number; default: not declared - explain(input).balance.currentAssets?: number; default: not declared - explain(input).balance.currentLiabilities?: number; default: not declared - explain(input).balance.inventory?: number; default: not declared - explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).balance.minorityInterest?: number; default: not declared - explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).balance.preferredEquity?: number; default: not declared - explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - explain(input).balance.retainedEarnings?: number; default: not declared - explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - explain(input).balance.shortTermInvestments?: number; default: not declared - explain(input).balance.totalAssets?: number; default: not declared - explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - explain(input).balance.totalEquity?: number; default: not declared - explain(input).balance.totalLiabilities?: number; default: not declared - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#daysInventoryOutstanding Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const daysInventoryOutstanding: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DayMetricRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).periodDays: number; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): DayMetricRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).periodDays: number; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#daysPayablesOutstanding Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const daysPayablesOutstanding: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DayMetricRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).periodDays: number; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): DayMetricRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).periodDays: number; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#daysSalesOutstanding Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const daysSalesOutstanding: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DayMetricRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).periodDays: number; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: DayMetricRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): DayMetricRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).periodDays: number; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#debtServiceCoverage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const debtServiceCoverage: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DebtServiceCoverageInput; default: not declared - explain: (input: DebtServiceCoverageInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): DebtServiceCoverageInput; default: not declared ### @insiderfinance/totalfinance/fundamentals#debtToAssets Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const debtToAssets: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BalanceSheetRatioInput>; default: not declared - (input).balance: Pick & Partial; default: not declared - (input).balance.accountsPayable?: number; default: not declared - (input).balance.accountsReceivable?: number; default: not declared - (input).balance.cashAndCashEquivalents?: number; default: not declared - (input).balance.currentAssets?: number; default: not declared - (input).balance.currentLiabilities?: number; default: not declared - (input).balance.inventory?: number; default: not declared - (input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - (input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).balance.minorityInterest?: number; default: not declared - (input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).balance.preferredEquity?: number; default: not declared - (input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - (input).balance.retainedEarnings?: number; default: not declared - (input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - (input).balance.shortTermInvestments?: number; default: not declared - (input).balance.totalAssets?: number; default: not declared - (input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - (input).balance.totalEquity?: number; default: not declared - (input).balance.totalLiabilities?: number; default: not declared - (input).statements?: never; default: not declared - explain: (input: BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): BalanceSheetRatioInput>; default: not declared - explain(input).balance: Pick & Partial; default: not declared - explain(input).balance.accountsPayable?: number; default: not declared - explain(input).balance.accountsReceivable?: number; default: not declared - explain(input).balance.cashAndCashEquivalents?: number; default: not declared - explain(input).balance.currentAssets?: number; default: not declared - explain(input).balance.currentLiabilities?: number; default: not declared - explain(input).balance.inventory?: number; default: not declared - explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).balance.minorityInterest?: number; default: not declared - explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).balance.preferredEquity?: number; default: not declared - explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - explain(input).balance.retainedEarnings?: number; default: not declared - explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - explain(input).balance.shortTermInvestments?: number; default: not declared - explain(input).balance.totalAssets?: number; default: not declared - explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - explain(input).balance.totalEquity?: number; default: not declared - explain(input).balance.totalLiabilities?: number; default: not declared - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#debtToEquity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const debtToEquity: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BalanceSheetRatioInput>; default: not declared - (input).balance: Pick & Partial; default: not declared - (input).balance.accountsPayable?: number; default: not declared - (input).balance.accountsReceivable?: number; default: not declared - (input).balance.cashAndCashEquivalents?: number; default: not declared - (input).balance.currentAssets?: number; default: not declared - (input).balance.currentLiabilities?: number; default: not declared - (input).balance.inventory?: number; default: not declared - (input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - (input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).balance.minorityInterest?: number; default: not declared - (input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).balance.preferredEquity?: number; default: not declared - (input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - (input).balance.retainedEarnings?: number; default: not declared - (input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - (input).balance.shortTermInvestments?: number; default: not declared - (input).balance.totalAssets?: number; default: not declared - (input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - (input).balance.totalEquity?: number; default: not declared - (input).balance.totalLiabilities?: number; default: not declared - (input).statements?: never; default: not declared - explain: (input: BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): BalanceSheetRatioInput>; default: not declared - explain(input).balance: Pick & Partial; default: not declared - explain(input).balance.accountsPayable?: number; default: not declared - explain(input).balance.accountsReceivable?: number; default: not declared - explain(input).balance.cashAndCashEquivalents?: number; default: not declared - explain(input).balance.currentAssets?: number; default: not declared - explain(input).balance.currentLiabilities?: number; default: not declared - explain(input).balance.inventory?: number; default: not declared - explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).balance.minorityInterest?: number; default: not declared - explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).balance.preferredEquity?: number; default: not declared - explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - explain(input).balance.retainedEarnings?: number; default: not declared - explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - explain(input).balance.shortTermInvestments?: number; default: not declared - explain(input).balance.totalAssets?: number; default: not declared - explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - explain(input).balance.totalEquity?: number; default: not declared - explain(input).balance.totalLiabilities?: number; default: not declared - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#dividendYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const dividendYield: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MarketMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): MarketMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#earningsPerShare Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const earningsPerShare: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IncomeStatementRatioInput>; default: not declared - (input).income: Pick & Partial; default: not declared - (input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - (input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (input).income.interestExpense?: number; default: not declared — Positive magnitude. - (input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).income.netIncome?: number; default: not declared - (input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (input).income.operatingIncome?: number; default: not declared - (input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).income.revenue?: number; default: not declared - (input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - (input).statements?: never; default: not declared - explain: (input: IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): IncomeStatementRatioInput>; default: not declared - explain(input).income: Pick & Partial; default: not declared - explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).income.netIncome?: number; default: not declared - explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - explain(input).income.operatingIncome?: number; default: not declared - explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).income.revenue?: number; default: not declared - explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#earningsYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const earningsYield: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MarketMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): MarketMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#ebitdaMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ebitdaMargin: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SingleStatementRatioInput; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): SingleStatementRatioInput; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#enterpriseValueToEbitda Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const enterpriseValueToEbitda: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EnterpriseMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).nonOperatingAssets?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: EnterpriseMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): EnterpriseMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).nonOperatingAssets?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#enterpriseValueToRevenue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const enterpriseValueToRevenue: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EnterpriseMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).nonOperatingAssets?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: EnterpriseMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): EnterpriseMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).nonOperatingAssets?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#freeCashFlowPerShare Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const freeCashFlowPerShare: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SingleStatementRatioInput; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): SingleStatementRatioInput; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#freeCashFlowYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const freeCashFlowYield: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MarketMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): MarketMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#fundamentalGrowth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Period-over-period and compound annual growth of one fundamental amount. ```typescript export declare function fundamentalGrowth(input: FundamentalGrowthInput): FundamentalGrowthResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FundamentalGrowthInput; default: not declared - (input).observations: readonly { periodEndDate: string; amount: number; }[]; default: not declared — At least two observations of one amount, period end ascending. - return.assumptions: { elapsedYearsBasis: string; observationCount: number; }; default: not declared - return.assumptions.elapsedYearsBasis: string; default: not declared — Elapsed time between period ends is an ACT/365F year fraction (a label, not a literal). - return.assumptions.observationCount: number; default: not declared - return.compoundAnnualGrowthRate: number | null; default: not declared — Compound annual growth from the first to the last observation over the ACTUAL elapsed years (ACT/365F between the period ends), or `null` with the reason when the endpoints make the exponent meaningless (non-positive start, sign change, or zero elapsed time). - return.compoundAnnualGrowthReason?: string; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — Every null growth's reason surfaces here too, so a reader scans one place. - return.elapsedYears: number; default: not declared - return.periodOverPeriod: { fromPeriodEndDate: string; toPeriodEndDate: string; growth: number | null; reason?: string; }[]; default: not declared — One row per adjacent pair: fractional growth `current / prior - 1`, or `null` with the reason when the prior amount is zero or the pair crosses sign (a growth rate through zero has no meaningful magnitude). ### @insiderfinance/totalfinance/fundamentals#grossMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const grossMargin: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IncomeStatementRatioInput>; default: not declared - (input).income: Pick & Partial; default: not declared - (input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - (input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (input).income.interestExpense?: number; default: not declared — Positive magnitude. - (input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).income.netIncome?: number; default: not declared - (input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (input).income.operatingIncome?: number; default: not declared - (input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).income.revenue?: number; default: not declared - (input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - (input).statements?: never; default: not declared - explain: (input: IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): IncomeStatementRatioInput>; default: not declared - explain(input).income: Pick & Partial; default: not declared - explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).income.netIncome?: number; default: not declared - explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - explain(input).income.operatingIncome?: number; default: not declared - explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).income.revenue?: number; default: not declared - explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#interestCoverage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const interestCoverage: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IncomeStatementRatioInput>; default: not declared - (input).income: Pick & Partial; default: not declared - (input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - (input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (input).income.interestExpense?: number; default: not declared — Positive magnitude. - (input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).income.netIncome?: number; default: not declared - (input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (input).income.operatingIncome?: number; default: not declared - (input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).income.revenue?: number; default: not declared - (input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - (input).statements?: never; default: not declared - explain: (input: IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): IncomeStatementRatioInput>; default: not declared - explain(input).income: Pick & Partial; default: not declared - explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).income.netIncome?: number; default: not declared - explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - explain(input).income.operatingIncome?: number; default: not declared - explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).income.revenue?: number; default: not declared - explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#inventoryTurnover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inventoryTurnover: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#isPeriodAvailableAt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Point-in-time eligibility: whether `period` was AVAILABLE to an observer at `asOf` (epoch ms). `availableTimestampMs`, not `periodEndDate`, controls eligibility — a restatement is a NEW version with its own availability and provenance, so a backtest never sees it early. ```typescript export declare function isPeriodAvailableAt(period: FundamentalPeriod, asOf: EpochMs): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (asOf): number; default: not declared - (period): FundamentalPeriod; default: not declared - (period).accession?: string; default: not declared — Source accession identifier, when known. - (period).availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - (period).currency: string; default: not declared — ISO 4217 currency of the monetary figures. - (period).filedTimestampMs?: number; default: not declared — When the filing was made, when known. - (period).fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - (period).fiscalYear: number; default: not declared - (period).form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - (period).monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - (period).periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - (period).periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - (period).periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - (period).restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. ### @insiderfinance/totalfinance/fundamentals#netDebtToEbitda Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const netDebtToEbitda: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SingleStatementRatioInput; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: SingleStatementRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): SingleStatementRatioInput; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#netProfitMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const netProfitMargin: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IncomeStatementRatioInput>; default: not declared - (input).income: Pick & Partial; default: not declared - (input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - (input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (input).income.interestExpense?: number; default: not declared — Positive magnitude. - (input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).income.netIncome?: number; default: not declared - (input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (input).income.operatingIncome?: number; default: not declared - (input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).income.revenue?: number; default: not declared - (input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - (input).statements?: never; default: not declared - explain: (input: IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): IncomeStatementRatioInput>; default: not declared - explain(input).income: Pick & Partial; default: not declared - explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).income.netIncome?: number; default: not declared - explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - explain(input).income.operatingIncome?: number; default: not declared - explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).income.revenue?: number; default: not declared - explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#operatingMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const operatingMargin: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IncomeStatementRatioInput>; default: not declared - (input).income: Pick & Partial; default: not declared - (input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - (input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (input).income.interestExpense?: number; default: not declared — Positive magnitude. - (input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).income.netIncome?: number; default: not declared - (input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (input).income.operatingIncome?: number; default: not declared - (input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).income.revenue?: number; default: not declared - (input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - (input).statements?: never; default: not declared - explain: (input: IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): IncomeStatementRatioInput>; default: not declared - explain(input).income: Pick & Partial; default: not declared - explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).income.netIncome?: number; default: not declared - explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - explain(input).income.operatingIncome?: number; default: not declared - explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).income.revenue?: number; default: not declared - explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#payablesTurnover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const payablesTurnover: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#perShareFundamentals Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Split-aware per-share normalization: the period's diluted shares are multiplied by the supplied cumulative split factor so a pre-split period and a post-split observer meet on one basis. The factor and the shares used are echoed; shares absent or non-positive is an error, never a NaN. ```typescript export declare function perShareFundamentals(input: PerShareFundamentalsInput): PerShareFundamentalsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PerShareFundamentalsInput; default: not declared - (input).splitFactorSincePeriod?: number; default: not declared — Cumulative split factor between the period and the observer's share basis (e.g. `2` after a 2-for-1 split since the period end). Default `1` — no split; the factor used is echoed. - (input).statements: FinancialStatements; default: not declared - return.assumptions: { dilutedSharesUsed: number; splitFactorSincePeriod: number; unitBasis: 'absolute currency per share'; }; default: not declared - return.assumptions.dilutedSharesUsed: number; default: not declared - return.assumptions.splitFactorSincePeriod: number; default: not declared - return.assumptions.unitBasis: 'absolute currency per share'; default: not declared — Per-share values are ABSOLUTE currency per share (amount × monetaryScale / shares). - return.bookValuePerShare: number; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.dilutedSharesUsed: number; default: not declared — Split-adjusted diluted shares actually used as the denominator. - return.earningsPerShare: number; default: not declared - return.freeCashFlowPerShare: number | null; default: not declared — `operatingCashFlow - capitalExpenditure` per share; `null` when capex is absent. - return.freeCashFlowPerShareReason?: string; default: not declared - return.revenuePerShare: number; default: not declared - return.splitFactorSincePeriod: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#piotroskiFScore Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The standard nine binary signals, per the paper: profitability (return on beginning assets, operating cash flow, their improvement, accruals), leverage/liquidity/funding (falling long-term-debt ratio, improving current ratio, no net share issuance), and efficiency (improving gross margin, improving beginning-assets turnover). Each signal is reported, not only the total; a signal whose statement line is absent reports `null` with the reason and is excluded from `fScore` — never guessed to 0 or 1. ```typescript export declare function piotroskiFScore(input: PiotroskiInput): PiotroskiResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PiotroskiInput; default: not declared - (input).current: FinancialStatements; default: not declared - (input).prior: FinancialStatements; default: not declared - (input).priorPrior: FinancialStatements; default: not declared — The period before `prior`. Needed because the paper's return and turnover use BEGINNING assets, so the prior year's own signal needs the balance sheet one further back. - return.assumptions: { model: string; returnBasis: 'beginning total assets'; }; default: not declared - return.assumptions.model: string; default: not declared — The published model name (a label, deliberately not a literal type). - return.assumptions.returnBasis: 'beginning total assets'; default: not declared — Returns and turnover use BEGINNING total assets, per the paper. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — One warning per unevaluable signal. - return.evaluableSignals: number; default: not declared — How many of the nine signals could be evaluated; 9 when every input line was present. - return.fScore: number; default: not declared — Sum of the evaluable signals (each 0 or 1). - return.signals: PiotroskiSignal[]; default: not declared ### @insiderfinance/totalfinance/fundamentals#priceToBook Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const priceToBook: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MarketMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): MarketMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#priceToEarnings Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const priceToEarnings: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MarketMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): MarketMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#priceToSales Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const priceToSales: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MarketMultipleRatioInput; default: not declared - (input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - (input).maximumStalenessMs?: number; default: not declared - (input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: MarketMultipleRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): MarketMultipleRatioInput; default: not declared - explain(input).marketObservation: import('@insiderfinance/totalfinance/fundamentals').MarketObservation; default: not declared - explain(input).maximumStalenessMs?: number; default: not declared - explain(input).statements: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#quickRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const quickRatio: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BalanceSheetRatioInput>; default: not declared - (input).balance: Pick & Partial; default: not declared - (input).balance.accountsPayable?: number; default: not declared - (input).balance.accountsReceivable?: number; default: not declared - (input).balance.cashAndCashEquivalents?: number; default: not declared - (input).balance.currentAssets?: number; default: not declared - (input).balance.currentLiabilities?: number; default: not declared - (input).balance.inventory?: number; default: not declared - (input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - (input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).balance.minorityInterest?: number; default: not declared - (input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).balance.preferredEquity?: number; default: not declared - (input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - (input).balance.retainedEarnings?: number; default: not declared - (input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - (input).balance.shortTermInvestments?: number; default: not declared - (input).balance.totalAssets?: number; default: not declared - (input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - (input).balance.totalEquity?: number; default: not declared - (input).balance.totalLiabilities?: number; default: not declared - (input).statements?: never; default: not declared - explain: (input: BalanceSheetRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): BalanceSheetRatioInput>; default: not declared - explain(input).balance: Pick & Partial; default: not declared - explain(input).balance.accountsPayable?: number; default: not declared - explain(input).balance.accountsReceivable?: number; default: not declared - explain(input).balance.cashAndCashEquivalents?: number; default: not declared - explain(input).balance.currentAssets?: number; default: not declared - explain(input).balance.currentLiabilities?: number; default: not declared - explain(input).balance.inventory?: number; default: not declared - explain(input).balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - explain(input).balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).balance.minorityInterest?: number; default: not declared - explain(input).balance.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).balance.preferredEquity?: number; default: not declared - explain(input).balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - explain(input).balance.retainedEarnings?: number; default: not declared - explain(input).balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - explain(input).balance.shortTermInvestments?: number; default: not declared - explain(input).balance.totalAssets?: number; default: not declared - explain(input).balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - explain(input).balance.totalEquity?: number; default: not declared - explain(input).balance.totalLiabilities?: number; default: not declared - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#receivablesTurnover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const receivablesTurnover: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#reconcileFinancialStatements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Accounting-identity diagnostics: the balance-sheet identity, gross-profit articulation, current-versus-total containment, and — with the prior period — cash articulation (`Δcash = operating + investing + financing`). A check whose fields are absent reports `null`, never a silent pass presented as proof. ```typescript export declare function reconcileFinancialStatements(input: ReconcileStatementsInput): ReconciliationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ReconcileStatementsInput; default: not declared - (input).priorStatements?: FinancialStatements; default: not declared — The immediately prior period, enabling the cash-articulation check across the two. - (input).statements: FinancialStatements; default: not declared - (input).toleranceAmount?: number; default: not declared — Absolute tolerance in reported units (period.monetaryScale). Default `1` — one reported unit, the rounding a scaled filing can legitimately carry. Documented and echoed in the result. - return.assumptions: { toleranceAmount: number; }; default: not declared - return.assumptions.toleranceAmount: number; default: not declared — Absolute tolerance in reported units, echoed (default 1). - return.checks: ReconciliationCheck[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — One warning per failed or unevaluable check. - return.reconciles: boolean; default: not declared — True when every evaluable check is within tolerance. - return.toleranceAmount: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#requireBalanceSheet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one {@link BalanceSheet} at a public boundary. ```typescript export declare function requireBalanceSheet(functionName: string, balance: BalanceSheet): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (balance): BalanceSheet; default: not declared - (balance).accountsPayable?: number; default: not declared - (balance).accountsReceivable?: number; default: not declared - (balance).cashAndCashEquivalents: number; default: not declared - (balance).currentAssets?: number; default: not declared - (balance).currentLiabilities?: number; default: not declared - (balance).inventory?: number; default: not declared - (balance).longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - (balance).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (balance).minorityInterest?: number; default: not declared - (balance).period: FundamentalPeriod; default: not declared - (balance).preferredEquity?: number; default: not declared - (balance).propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - (balance).retainedEarnings?: number; default: not declared - (balance).shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - (balance).shortTermInvestments?: number; default: not declared - (balance).totalAssets: number; default: not declared - (balance).totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - (balance).totalEquity: number; default: not declared - (balance).totalLiabilities: number; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/fundamentals#requireCashFlowStatement Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one {@link CashFlowStatement} at a public boundary. ```typescript export declare function requireCashFlowStatement(functionName: string, cashFlow: CashFlowStatement): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (cashFlow): CashFlowStatement; default: not declared - (cashFlow).acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - (cashFlow).capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - (cashFlow).depreciationAndAmortization?: number; default: not declared - (cashFlow).dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - (cashFlow).financingCashFlow: number; default: not declared - (cashFlow).investingCashFlow: number; default: not declared - (cashFlow).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (cashFlow).operatingCashFlow: number; default: not declared - (cashFlow).period: FundamentalPeriod; default: not declared - (cashFlow).shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - (cashFlow).stockBasedCompensation?: number; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/fundamentals#requireFinancialStatements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link FinancialStatements} set: each statement, then the identity agreement — the three periods must share `periodEndDate`, `periodType`, `currency`, and `monetaryScale`, because every cross-statement ratio assumes one period and one unit. ```typescript export declare function requireFinancialStatements(functionName: string, statements: FinancialStatements): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (statements): FinancialStatements; default: not declared - (statements).balance: BalanceSheet; default: not declared - (statements).cashFlow: CashFlowStatement; default: not declared - (statements).income: IncomeStatement; default: not declared ### @insiderfinance/totalfinance/fundamentals#requireFundamentalPeriod Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link FundamentalPeriod} at a public boundary (Law 12 closed request): presence, types, the strict date grammar, the literal domains, and the ordering facts a period must obey. ```typescript export declare function requireFundamentalPeriod(functionName: string, period: FundamentalPeriod): asserts period is FundamentalPeriod; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (period): FundamentalPeriod; default: not declared - (period).accession?: string; default: not declared — Source accession identifier, when known. - (period).availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - (period).currency: string; default: not declared — ISO 4217 currency of the monetary figures. - (period).filedTimestampMs?: number; default: not declared — When the filing was made, when known. - (period).fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - (period).fiscalYear: number; default: not declared - (period).form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - (period).monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - (period).periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - (period).periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - (period).periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - (period).restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. ### @insiderfinance/totalfinance/fundamentals#requireIncomeStatement Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one {@link IncomeStatement} at a public boundary. ```typescript export declare function requireIncomeStatement(functionName: string, income: IncomeStatement): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (income): IncomeStatement; default: not declared - (income).costOfRevenue?: number; default: not declared — Positive magnitude. - (income).dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (income).grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (income).incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (income).incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (income).interestExpense?: number; default: not declared — Positive magnitude. - (income).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (income).netIncome: number; default: not declared - (income).operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (income).operatingIncome: number; default: not declared - (income).period: FundamentalPeriod; default: not declared - (income).revenue: number; default: not declared - (income).sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). ### @insiderfinance/totalfinance/fundamentals#requireMarketObservation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link MarketObservation} at a public boundary. ```typescript export declare function requireMarketObservation(functionName: string, observation: MarketObservation): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (observation): MarketObservation; default: not declared - (observation).marketCapitalization?: number; default: not declared - (observation).observedTimestampMs: number; default: not declared — When the price was observed (epoch ms). Must not precede the fundamentals' availability. - (observation).sharePrice: number; default: not declared - (observation).sharesOutstanding?: number; default: not declared — Split-adjusted shares consistent with `sharePrice`. ### @insiderfinance/totalfinance/fundamentals#returnOnAssets Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const returnOnAssets: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#returnOnCapitalEmployed Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const returnOnCapitalEmployed: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#returnOnEquity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const returnOnEquity: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PairRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain: (input: PairRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): PairRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared ### @insiderfinance/totalfinance/fundamentals#returnOnInvestedCapital Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const returnOnInvestedCapital: RatioFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InvestedCapitalRatioInput; default: not declared - (input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - (input).taxRate?: number; default: not declared - explain: (input: InvestedCapitalRatioInput) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): InvestedCapitalRatioInput; default: not declared - explain(input).current: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).prior: import('@insiderfinance/totalfinance/fundamentals').FinancialStatements; default: not declared - explain(input).taxRate?: number; default: not declared ### @insiderfinance/totalfinance/fundamentals#revenuePerShare Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const revenuePerShare: RatioFacade>>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IncomeStatementRatioInput>; default: not declared - (input).income: Pick & Partial; default: not declared - (input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - (input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - (input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - (input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - (input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - (input).income.interestExpense?: number; default: not declared — Positive magnitude. - (input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (input).income.netIncome?: number; default: not declared - (input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - (input).income.operatingIncome?: number; default: not declared - (input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - (input).income.revenue?: number; default: not declared - (input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - (input).statements?: never; default: not declared - explain: (input: IncomeStatementRatioInput>) => import('@insiderfinance/totalfinance/fundamentals').RatioReport; default: not declared - explain().return.assumptions: { category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; conventionsVersion: string; formula: string; period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; ratioName: string; }; default: not declared - explain().return.assumptions.category: import('@insiderfinance/totalfinance/fundamentals').RatioCategory; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.formula: string; default: not declared — The fixed formula, stated as prose (also in the generated reference documentation). - explain().return.assumptions.period: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.priorPeriod?: import('@insiderfinance/totalfinance/fundamentals').RatioPeriodIdentity; default: not declared - explain().return.assumptions.ratioName: string; default: not declared - explain().return.diagnostics: { denominator: { label: string; amount: number; } | null; marketStalenessMs?: number; notes: string[]; numerator: { label: string; amount: number; } | null; reason?: string; warnings: string[]; }; default: not declared - explain().return.diagnostics.denominator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.denominator.amount: number; default: not declared - explain().return.diagnostics.denominator.label: string; default: not declared - explain().return.diagnostics.marketStalenessMs?: number; default: not declared — For market multiples: how far the price sits after the fundamentals became available. - explain().return.diagnostics.notes: string[]; default: not declared — Every derivation, omission, and convention the computation relied on. - explain().return.diagnostics.numerator: { amount: number; label: string; } | null; default: not declared - explain().return.diagnostics.numerator.amount: number; default: not declared - explain().return.diagnostics.numerator.label: string; default: not declared - explain().return.diagnostics.reason?: string; default: not declared — Present exactly when `value` is null. - explain().return.diagnostics.warnings: string[]; default: not declared - explain().return.value: number | null; default: not declared — A decimal ratio (never a displayed percentage), or `null` with `diagnostics.reason`. - explain(input): IncomeStatementRatioInput>; default: not declared - explain(input).income: Pick & Partial; default: not declared - explain(input).income.costOfRevenue?: number; default: not declared — Positive magnitude. - explain(input).income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - explain(input).income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - explain(input).income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - explain(input).income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - explain(input).income.interestExpense?: number; default: not declared — Positive magnitude. - explain(input).income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - explain(input).income.netIncome?: number; default: not declared - explain(input).income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - explain(input).income.operatingIncome?: number; default: not declared - explain(input).income.period?: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - explain(input).income.revenue?: number; default: not declared - explain(input).income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - explain(input).statements?: never; default: not declared ### @insiderfinance/totalfinance/fundamentals#selectFundamentalSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The point-in-time view of a series: availability-gated by `statementsAvailableTimestampMs` (never by period end), then resolved to ONE version per (periodType, periodEndDate) under the stated restatement policy — `'latest-available'` takes the newest visible version, `'first-reported'` takes the original filing and ignores restatements entirely. ```typescript export declare function selectFundamentalSnapshot(input: SelectFundamentalSnapshotInput): FundamentalSnapshot; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SelectFundamentalSnapshotInput; default: not declared - (input).asOf: number; default: not declared — The observation instant (epoch ms). Only sets whose availability is at or before it qualify. - (input).restatementPolicy: RestatementPolicy; default: not declared — How multiple visible versions of one period resolve. - (input).series: FundamentalSeries; default: not declared - return.asOf: number; default: not declared - return.entity?: string; default: not declared - return.restatementPolicy: RestatementPolicy; default: not declared - return.statements: readonly FinancialStatements[]; default: not declared — One resolved version per (periodType, periodEndDate), period end ascending. ### @insiderfinance/totalfinance/fundamentals#statementsAvailableTimestampMs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The point-in-time availability of a statement SET: the latest of the three statements' `availableTimestampMs` — a set is visible only when every statement in it is. The set is validated IN FULL: a helper that answers an eligibility instant from a malformed set would smuggle that malformation into every point-in-time decision built on it. ```typescript export declare function statementsAvailableTimestampMs(statements: FinancialStatements): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (statements): FinancialStatements; default: not declared - (statements).balance: BalanceSheet; default: not declared - (statements).cashFlow: CashFlowStatement; default: not declared - (statements).income: IncomeStatement; default: not declared ### @insiderfinance/totalfinance/fundamentals#trailingTwelveMonthStatements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compose four consecutive fiscal quarters into one trailing-twelve-months set: income and cash-flow FLOWS sum; BALANCES are the latest quarter's (a balance is a point, not a flow); `dilutedSharesOutstanding` is the four-quarter arithmetic mean (disclosed convention). The quarter chain is verified — a gap or an overlap is an error naming the break, never a silent annualization. ```typescript export declare function trailingTwelveMonthStatements(input: TrailingTwelveMonthInput): FinancialStatements; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TrailingTwelveMonthInput; default: not declared - (input).statements: readonly FinancialStatements[]; default: not declared — Exactly four consecutive fiscal quarters, period end ascending. - return.balance: BalanceSheet; default: not declared - return.cashFlow: CashFlowStatement; default: not declared - return.income: IncomeStatement; default: not declared ## Entrypoint @insiderfinance/totalfinance/fundamentals/ratios ### @insiderfinance/totalfinance/fundamentals/ratios#BalanceSheetRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#BalanceSheetRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#DayMetricRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#DayMetricRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#DebtServiceCoverageInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#DebtServiceCoverageInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#DebtServiceRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#DebtServiceRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#EnterpriseMultipleRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#EnterpriseMultipleRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#IncomeStatementRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#IncomeStatementRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#InvestedCapitalRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#InvestedCapitalRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#MarketMultipleRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#MarketMultipleRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#MarketObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#MarketObservation`. ### @insiderfinance/totalfinance/fundamentals/ratios#PairRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#PairRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#RatioCategory Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#RatioCategory`. ### @insiderfinance/totalfinance/fundamentals/ratios#RatioFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#RatioFacade`. ### @insiderfinance/totalfinance/fundamentals/ratios#RatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#RatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#RatioPeriodIdentity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#RatioPeriodIdentity`. ### @insiderfinance/totalfinance/fundamentals/ratios#RatioReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#RatioReport`. ### @insiderfinance/totalfinance/fundamentals/ratios#SingleStatementRatioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#SingleStatementRatioInput`. ### @insiderfinance/totalfinance/fundamentals/ratios#accrualRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#accrualRatio`. ### @insiderfinance/totalfinance/fundamentals/ratios#assetTurnover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#assetTurnover`. ### @insiderfinance/totalfinance/fundamentals/ratios#bookValuePerShare Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#bookValuePerShare`. ### @insiderfinance/totalfinance/fundamentals/ratios#cashConversionCycle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#cashConversionCycle`. ### @insiderfinance/totalfinance/fundamentals/ratios#cashFlowToNetIncome Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#cashFlowToNetIncome`. ### @insiderfinance/totalfinance/fundamentals/ratios#cashRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#cashRatio`. ### @insiderfinance/totalfinance/fundamentals/ratios#cashReturnOnAssets Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#cashReturnOnAssets`. ### @insiderfinance/totalfinance/fundamentals/ratios#currentRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#currentRatio`. ### @insiderfinance/totalfinance/fundamentals/ratios#daysInventoryOutstanding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#daysInventoryOutstanding`. ### @insiderfinance/totalfinance/fundamentals/ratios#daysPayablesOutstanding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#daysPayablesOutstanding`. ### @insiderfinance/totalfinance/fundamentals/ratios#daysSalesOutstanding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#daysSalesOutstanding`. ### @insiderfinance/totalfinance/fundamentals/ratios#debtServiceCoverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#debtServiceCoverage`. ### @insiderfinance/totalfinance/fundamentals/ratios#debtToAssets Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#debtToAssets`. ### @insiderfinance/totalfinance/fundamentals/ratios#debtToEquity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#debtToEquity`. ### @insiderfinance/totalfinance/fundamentals/ratios#dividendYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#dividendYield`. ### @insiderfinance/totalfinance/fundamentals/ratios#earningsPerShare Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#earningsPerShare`. ### @insiderfinance/totalfinance/fundamentals/ratios#earningsYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#earningsYield`. ### @insiderfinance/totalfinance/fundamentals/ratios#ebitdaMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#ebitdaMargin`. ### @insiderfinance/totalfinance/fundamentals/ratios#enterpriseValueToEbitda Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#enterpriseValueToEbitda`. ### @insiderfinance/totalfinance/fundamentals/ratios#enterpriseValueToRevenue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#enterpriseValueToRevenue`. ### @insiderfinance/totalfinance/fundamentals/ratios#freeCashFlowPerShare Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#freeCashFlowPerShare`. ### @insiderfinance/totalfinance/fundamentals/ratios#freeCashFlowYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#freeCashFlowYield`. ### @insiderfinance/totalfinance/fundamentals/ratios#grossMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#grossMargin`. ### @insiderfinance/totalfinance/fundamentals/ratios#interestCoverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#interestCoverage`. ### @insiderfinance/totalfinance/fundamentals/ratios#inventoryTurnover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#inventoryTurnover`. ### @insiderfinance/totalfinance/fundamentals/ratios#netDebtToEbitda Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#netDebtToEbitda`. ### @insiderfinance/totalfinance/fundamentals/ratios#netProfitMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#netProfitMargin`. ### @insiderfinance/totalfinance/fundamentals/ratios#operatingMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#operatingMargin`. ### @insiderfinance/totalfinance/fundamentals/ratios#payablesTurnover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#payablesTurnover`. ### @insiderfinance/totalfinance/fundamentals/ratios#priceToBook Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#priceToBook`. ### @insiderfinance/totalfinance/fundamentals/ratios#priceToEarnings Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#priceToEarnings`. ### @insiderfinance/totalfinance/fundamentals/ratios#priceToSales Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#priceToSales`. ### @insiderfinance/totalfinance/fundamentals/ratios#quickRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#quickRatio`. ### @insiderfinance/totalfinance/fundamentals/ratios#receivablesTurnover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#receivablesTurnover`. ### @insiderfinance/totalfinance/fundamentals/ratios#requireMarketObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#requireMarketObservation`. ### @insiderfinance/totalfinance/fundamentals/ratios#returnOnAssets Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#returnOnAssets`. ### @insiderfinance/totalfinance/fundamentals/ratios#returnOnCapitalEmployed Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#returnOnCapitalEmployed`. ### @insiderfinance/totalfinance/fundamentals/ratios#returnOnEquity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#returnOnEquity`. ### @insiderfinance/totalfinance/fundamentals/ratios#returnOnInvestedCapital Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#returnOnInvestedCapital`. ### @insiderfinance/totalfinance/fundamentals/ratios#revenuePerShare Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#revenuePerShare`. ## Entrypoint @insiderfinance/totalfinance/fundamentals/scores ### @insiderfinance/totalfinance/fundamentals/scores#AltmanComponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#AltmanComponent`. ### @insiderfinance/totalfinance/fundamentals/scores#AltmanInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#AltmanInput`. ### @insiderfinance/totalfinance/fundamentals/scores#AltmanResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#AltmanResult`. ### @insiderfinance/totalfinance/fundamentals/scores#AltmanVariant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#AltmanVariant`. ### @insiderfinance/totalfinance/fundamentals/scores#BeneishComponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#BeneishComponent`. ### @insiderfinance/totalfinance/fundamentals/scores#BeneishInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#BeneishInput`. ### @insiderfinance/totalfinance/fundamentals/scores#BeneishResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#BeneishResult`. ### @insiderfinance/totalfinance/fundamentals/scores#PiotroskiInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#PiotroskiInput`. ### @insiderfinance/totalfinance/fundamentals/scores#PiotroskiResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#PiotroskiResult`. ### @insiderfinance/totalfinance/fundamentals/scores#PiotroskiSignal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#PiotroskiSignal`. ### @insiderfinance/totalfinance/fundamentals/scores#altmanZScore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#altmanZScore`. ### @insiderfinance/totalfinance/fundamentals/scores#beneishMScore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#beneishMScore`. ### @insiderfinance/totalfinance/fundamentals/scores#piotroskiFScore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#piotroskiFScore`. ## Entrypoint @insiderfinance/totalfinance/fundamentals/statements ### @insiderfinance/totalfinance/fundamentals/statements#BalanceSheet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#BalanceSheet`. ### @insiderfinance/totalfinance/fundamentals/statements#CashFlowStatement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#CashFlowStatement`. ### @insiderfinance/totalfinance/fundamentals/statements#CommonSizeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#CommonSizeInput`. ### @insiderfinance/totalfinance/fundamentals/statements#CommonSizeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#CommonSizeResult`. ### @insiderfinance/totalfinance/fundamentals/statements#FinancialStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#FinancialStatements`. ### @insiderfinance/totalfinance/fundamentals/statements#FundamentalGrowthInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#FundamentalGrowthInput`. ### @insiderfinance/totalfinance/fundamentals/statements#FundamentalGrowthResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#FundamentalGrowthResult`. ### @insiderfinance/totalfinance/fundamentals/statements#FundamentalSeries Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#FundamentalSeries`. ### @insiderfinance/totalfinance/fundamentals/statements#FundamentalSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#FundamentalSnapshot`. ### @insiderfinance/totalfinance/fundamentals/statements#IncomeStatement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#IncomeStatement`. ### @insiderfinance/totalfinance/fundamentals/statements#PerShareFundamentalsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#PerShareFundamentalsInput`. ### @insiderfinance/totalfinance/fundamentals/statements#PerShareFundamentalsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#PerShareFundamentalsResult`. ### @insiderfinance/totalfinance/fundamentals/statements#ReconcileStatementsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#ReconcileStatementsInput`. ### @insiderfinance/totalfinance/fundamentals/statements#ReconciliationCheck Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#ReconciliationCheck`. ### @insiderfinance/totalfinance/fundamentals/statements#ReconciliationResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#ReconciliationResult`. ### @insiderfinance/totalfinance/fundamentals/statements#RestatementPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#RestatementPolicy`. ### @insiderfinance/totalfinance/fundamentals/statements#SelectFundamentalSnapshotInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#SelectFundamentalSnapshotInput`. ### @insiderfinance/totalfinance/fundamentals/statements#TrailingTwelveMonthInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#TrailingTwelveMonthInput`. ### @insiderfinance/totalfinance/fundamentals/statements#commonSizeFinancialStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#commonSizeFinancialStatements`. ### @insiderfinance/totalfinance/fundamentals/statements#fundamentalGrowth Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#fundamentalGrowth`. ### @insiderfinance/totalfinance/fundamentals/statements#perShareFundamentals Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#perShareFundamentals`. ### @insiderfinance/totalfinance/fundamentals/statements#reconcileFinancialStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#reconcileFinancialStatements`. ### @insiderfinance/totalfinance/fundamentals/statements#requireBalanceSheet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#requireBalanceSheet`. ### @insiderfinance/totalfinance/fundamentals/statements#requireCashFlowStatement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#requireCashFlowStatement`. ### @insiderfinance/totalfinance/fundamentals/statements#requireFinancialStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#requireFinancialStatements`. ### @insiderfinance/totalfinance/fundamentals/statements#requireIncomeStatement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#requireIncomeStatement`. ### @insiderfinance/totalfinance/fundamentals/statements#selectFundamentalSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#selectFundamentalSnapshot`. ### @insiderfinance/totalfinance/fundamentals/statements#statementsAvailableTimestampMs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#statementsAvailableTimestampMs`. ### @insiderfinance/totalfinance/fundamentals/statements#trailingTwelveMonthStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fundamentals#trailingTwelveMonthStatements`. ## Entrypoint @insiderfinance/totalfinance/http ### @insiderfinance/totalfinance/http#LocalHttpServer Kind: interface; stability: preview (pre-1.0). ```typescript export interface LocalHttpServer { document: OpenApiDocument; /** The bound address once started (`null` before `start()` / after `stop()`). */ address(): { host: string; port: number; url: string; } | null; /** Bind and listen; resolves with the bound address (port 0 picks a free port). */ start(): Promise<{ host: string; port: number; url: string; }>; stop(): Promise; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - address: () => { host: string; port: number; url: string; } | null; default: not declared — The bound address once started (`null` before `start()` / after `stop()`). - address().return.host: string; default: not declared - address().return.port: number; default: not declared - address().return.url: string; default: not declared - document: OpenApiDocument; default: not declared - document.components: { schemas: Record; securitySchemes: Record; }; default: not declared - document.components.schemas: Record; default: not declared - document.components.securitySchemes: Record; default: not declared - document.info: { description: string; title: string; version: string; }; default: not declared - document.info.description: string; default: not declared - document.info.title: string; default: not declared - document.info.version: string; default: not declared - document.openapi: '3.1.0'; default: not declared - document.paths: Record>; default: not declared - document.servers: { url: string; description: string; }[]; default: not declared - start: () => Promise<{ host: string; port: number; url: string; }>; default: not declared — Bind and listen; resolves with the bound address (port 0 picks a free port). - stop: () => Promise; default: not declared ### @insiderfinance/totalfinance/http#LocalHttpServerBudgets Kind: interface; stability: preview (pre-1.0). ```typescript export interface LocalHttpServerBudgets { /** The wire byte budget (default 65,536; maximum 16,777,216). */ maxInputBytes?: number; /** Post-hoc deadline for an inline run (ms). */ deadlineMs?: number; /** The default seed injected into a stochastic call that omits its own. */ defaultSeed?: number; /** Spill threshold for a writable store (default 256 KiB). */ inlineResultBytes?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deadlineMs?: number; default: not declared — Post-hoc deadline for an inline run (ms). - defaultSeed?: number; default: not declared — The default seed injected into a stochastic call that omits its own. - inlineResultBytes?: number; default: not declared — Spill threshold for a writable store (default 256 KiB). - maxInputBytes?: number; default: not declared — The wire byte budget (default 65,536; maximum 16,777,216). ### @insiderfinance/totalfinance/http#LocalHttpServerInput Kind: interface; stability: preview (pre-1.0). ```typescript export interface LocalHttpServerInput { registry: OperationRegistry; /** Handles resolve through this store; a writable store also receives spilled results. */ artifacts?: ArtifactStoreReader | ArtifactStore; /** The server's capability ceiling (default the runtime's defaults). Writes also need the bearer credential. */ capabilities?: readonly string[]; /** Server-owned bearer credential, at least 32 cryptographically random characters (e.g. randomBytes(32).toString('hex')). Required for enabled write operations, including trade:approve. Never returned by discovery. Read-only analytics remain public; job submission/cancellation always require this token. */ authenticationToken?: string; /** The trade lifecycle's stores (Decision 10). */ stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; /** The job runner (`@insiderfinance/totalfinance/workflows/local`'s or another implementation of the contract). */ jobs?: JobRunner; host?: string; port?: number; /** Binding anything but loopback needs this flag and your own network/TLS boundary; reads remain unauthenticated. */ allowNonLoopback?: boolean; budgets?: LocalHttpServerBudgets; /** The caller's clock (ISO instants for spilled results and job transitions); default `Date`. */ clock?: () => string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allowNonLoopback?: boolean; default: not declared — Binding anything but loopback needs this flag and your own network/TLS boundary; reads remain unauthenticated. - artifacts?: ArtifactStore | ArtifactStoreReader; default: not declared — Handles resolve through this store; a writable store also receives spilled results. - artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - artifacts.get().return.handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - artifacts.get().return.value: Record; default: not declared - artifacts.get(uri): string; default: not declared - artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - artifacts.list(filter)?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; } | undefined; default: not declared - artifacts.list(filter).kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - artifacts.put().return.contentHash: string | null; default: not declared - artifacts.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - artifacts.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - artifacts.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - artifacts.put().return.schema: string; default: not declared - artifacts.put().return.uri: string; default: not declared - artifacts.put().return.version: string; default: not declared - artifacts.put(input): import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput; default: not declared - artifacts.put(input).createdTimestampMs: number; default: not declared — Epoch ms — the caller's clock, never read by the library. - artifacts.put(input).expiresTimestampMs?: number; default: not declared — Epoch ms; must be after `createdTimestampMs`. - artifacts.put(input).kind: 'market' | 'portfolio' | 'report' | 'scenario' | 'authorization' | 'journal'; default: not declared - artifacts.put(input).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - artifacts.put(input).value: Record; default: not declared — The stored data — an envelope or an operation's structured result; JSON-safe by construction. - authenticationToken?: string; default: not declared — Server-owned bearer credential, at least 32 cryptographically random characters (e.g. randomBytes(32).toString('hex')). Required for enabled write operations, including trade:approve. Never returned by discovery. Read-only analytics remain public; job submission/cancellation always require this token. - budgets?: LocalHttpServerBudgets; default: not declared - budgets.deadlineMs?: number; default: not declared — Post-hoc deadline for an inline run (ms). - budgets.defaultSeed?: number; default: not declared — The default seed injected into a stochastic call that omits its own. - budgets.inlineResultBytes?: number; default: not declared — Spill threshold for a writable store (default 256 KiB). - budgets.maxInputBytes?: number; default: not declared — The wire byte budget (default 65,536; maximum 16,777,216). - capabilities?: readonly string[]; default: not declared — The server's capability ceiling (default the runtime's defaults). Writes also need the bearer credential. - clock?: () => string; default: not declared — The caller's clock (ISO instants for spilled results and job transitions); default `Date`. - host?: string; default: not declared - jobs?: JobRunner; default: not declared — The job runner (`@insiderfinance/totalfinance/workflows/local`'s or another implementation of the contract). - jobs.cancel: (id: string) => JobRecord; default: not declared - jobs.cancel().return.error: OperationError | null; default: not declared - jobs.cancel().return.error.code: string; default: not declared - jobs.cancel().return.error.context: Record; default: not declared - jobs.cancel().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.cancel().return.error.message: string; default: not declared - jobs.cancel().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.cancel().return.error.operation.id: string; default: not declared - jobs.cancel().return.error.operation.version: string; default: not declared - jobs.cancel().return.finishedAt: string | null; default: not declared - jobs.cancel().return.id: string; default: not declared - jobs.cancel().return.inputsHash: string; default: not declared - jobs.cancel().return.operation: { id: string; version: string; }; default: not declared - jobs.cancel().return.operation.id: string; default: not declared - jobs.cancel().return.operation.version: string; default: not declared - jobs.cancel().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.cancel().return.progress.fraction: number | null; default: not declared - jobs.cancel().return.progress.stage: string; default: not declared - jobs.cancel().return.result: import('@insiderfinance/totalfinance/workflows').ResourceHandle | null; default: not declared - jobs.cancel().return.result.contentHash: string | null; default: not declared - jobs.cancel().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.cancel().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.cancel().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.cancel().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.cancel().return.result.schema: string; default: not declared - jobs.cancel().return.result.uri: string; default: not declared - jobs.cancel().return.result.version: string; default: not declared - jobs.cancel().return.seed: number | null; default: not declared - jobs.cancel().return.startedAt: string | null; default: not declared - jobs.cancel().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.cancel().return.submittedAt: string; default: not declared - jobs.cancel().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.cancel().return.usage.elapsedMs: number | null; default: not declared - jobs.cancel(id): string; default: not declared - jobs.get: (id: string) => JobRecord | null; default: not declared - jobs.get().return.error: OperationError | null; default: not declared - jobs.get().return.error.code: string; default: not declared - jobs.get().return.error.context: Record; default: not declared - jobs.get().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.get().return.error.message: string; default: not declared - jobs.get().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.get().return.error.operation.id: string; default: not declared - jobs.get().return.error.operation.version: string; default: not declared - jobs.get().return.finishedAt: string | null; default: not declared - jobs.get().return.id: string; default: not declared - jobs.get().return.inputsHash: string; default: not declared - jobs.get().return.operation: { id: string; version: string; }; default: not declared - jobs.get().return.operation.id: string; default: not declared - jobs.get().return.operation.version: string; default: not declared - jobs.get().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.get().return.progress.fraction: number | null; default: not declared - jobs.get().return.progress.stage: string; default: not declared - jobs.get().return.result: import('@insiderfinance/totalfinance/workflows').ResourceHandle | null; default: not declared - jobs.get().return.result.contentHash: string | null; default: not declared - jobs.get().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.get().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.get().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.get().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.get().return.result.schema: string; default: not declared - jobs.get().return.result.uri: string; default: not declared - jobs.get().return.result.version: string; default: not declared - jobs.get().return.seed: number | null; default: not declared - jobs.get().return.startedAt: string | null; default: not declared - jobs.get().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.get().return.submittedAt: string; default: not declared - jobs.get().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.get().return.usage.elapsedMs: number | null; default: not declared - jobs.get(id): string; default: not declared - jobs.list: () => JobRecord[]; default: not declared - jobs.submit: (submission: import('@insiderfinance/totalfinance/workflows/local').JobSubmission) => import('@insiderfinance/totalfinance/workflows/local').JobRun; default: not declared - jobs.submit().return.cancel: () => Promise; default: not declared — Terminate the worker now; resolves with the cancelled (or already terminal) record. - jobs.submit().return.completion: Promise; default: not declared — Resolves with the terminal record — completed, failed, or cancelled. Never rejects. - jobs.submit().return.record: JobRecord; default: not declared — The record as accepted (or, for an inline non-job operation, as completed). - jobs.submit(submission): import('@insiderfinance/totalfinance/workflows/local').JobSubmission; default: not declared - jobs.submit(submission).deadlineMs?: number; default: not declared - jobs.submit(submission).id: string; default: not declared — The operation id. - jobs.submit(submission).inlineResultBytes?: number; default: not declared - jobs.submit(submission).input: unknown; default: not declared - jobs.submit(submission).maxInputBytes?: number; default: not declared - jobs.submit(submission).requestId?: string; default: not declared - jobs.submit(submission).seed?: number; default: not declared - port?: number; default: not declared - registry: OperationRegistry; default: not declared - registry.describe: (id: string) => import('@insiderfinance/totalfinance/workflows').OperationDescription; default: not declared - registry.describe().return.annotations: import('@insiderfinance/totalfinance/workflows').OperationAnnotations; default: not declared - registry.describe().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.describe().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.describe().return.description: string; default: not declared - registry.describe().return.deterministic: boolean; default: not declared - registry.describe().return.handleFields: string[]; default: not declared - registry.describe().return.id: string; default: not declared - registry.describe().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.describe().return.inputSchema: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.describe().return.outputSchema.$id?: string; default: not declared - registry.describe().return.outputSchema.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.describe().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.const?: unknown; default: not declared - registry.describe().return.outputSchema.default?: unknown; default: not declared - registry.describe().return.outputSchema.description?: string; default: not declared - registry.describe().return.outputSchema.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.format?: string; default: not declared - registry.describe().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.describe().return.outputSchema.maxItems?: number; default: not declared - registry.describe().return.outputSchema.maxLength?: number; default: not declared - registry.describe().return.outputSchema.maximum?: number; default: not declared - registry.describe().return.outputSchema.minItems?: number; default: not declared - registry.describe().return.outputSchema.minLength?: number; default: not declared - registry.describe().return.outputSchema.minimum?: number; default: not declared - registry.describe().return.outputSchema.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.describe().return.outputSchema.pattern?: string; default: not declared - registry.describe().return.outputSchema.properties?: Record; default: not declared - registry.describe().return.outputSchema.required?: string[]; default: not declared - registry.describe().return.outputSchema.title?: string; default: not declared - registry.describe().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.requiredCapabilities: string[]; default: not declared - registry.describe().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.describe().return.stochastic: boolean | 'per-call'; default: not declared - registry.describe().return.supportsCancellation: boolean; default: not declared - registry.describe().return.title: string; default: not declared - registry.describe().return.version: string; default: not declared - registry.describe(id): string; default: not declared - registry.get: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation | null; default: not declared - registry.get().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.get().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.get().return.description: string; default: not declared - registry.get().return.deterministic: boolean; default: not declared - registry.get().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.get().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.get().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.get().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.get().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.get().return.outputSchema.$id?: string; default: not declared - registry.get().return.outputSchema.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.get().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.get().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.const?: unknown; default: not declared - registry.get().return.outputSchema.default?: unknown; default: not declared - registry.get().return.outputSchema.description?: string; default: not declared - registry.get().return.outputSchema.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.format?: string; default: not declared - registry.get().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.get().return.outputSchema.maxItems?: number; default: not declared - registry.get().return.outputSchema.maxLength?: number; default: not declared - registry.get().return.outputSchema.maximum?: number; default: not declared - registry.get().return.outputSchema.minItems?: number; default: not declared - registry.get().return.outputSchema.minLength?: number; default: not declared - registry.get().return.outputSchema.minimum?: number; default: not declared - registry.get().return.outputSchema.multipleOf?: number; default: not declared - registry.get().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.get().return.outputSchema.pattern?: string; default: not declared - registry.get().return.outputSchema.properties?: Record; default: not declared - registry.get().return.outputSchema.required?: string[]; default: not declared - registry.get().return.outputSchema.title?: string; default: not declared - registry.get().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.requiredCapabilities: readonly string[]; default: not declared - registry.get().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.get().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.get().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.get().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.get().return.title: string; default: not declared - registry.get().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.get(id): string; default: not declared - registry.list: () => import('@insiderfinance/totalfinance/workflows').OperationDescription[]; default: not declared - registry.packs: () => import('@insiderfinance/totalfinance/workflows').OperationPack[]; default: not declared - registry.require: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - registry.require().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.require().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.require().return.description: string; default: not declared - registry.require().return.deterministic: boolean; default: not declared - registry.require().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.require().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.require().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.require().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.require().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - registry.require().return.outputSchema.$id?: string; default: not declared - registry.require().return.outputSchema.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.require().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.require().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.const?: unknown; default: not declared - registry.require().return.outputSchema.default?: unknown; default: not declared - registry.require().return.outputSchema.description?: string; default: not declared - registry.require().return.outputSchema.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.format?: string; default: not declared - registry.require().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - registry.require().return.outputSchema.maxItems?: number; default: not declared - registry.require().return.outputSchema.maxLength?: number; default: not declared - registry.require().return.outputSchema.maximum?: number; default: not declared - registry.require().return.outputSchema.minItems?: number; default: not declared - registry.require().return.outputSchema.minLength?: number; default: not declared - registry.require().return.outputSchema.minimum?: number; default: not declared - registry.require().return.outputSchema.multipleOf?: number; default: not declared - registry.require().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - registry.require().return.outputSchema.pattern?: string; default: not declared - registry.require().return.outputSchema.properties?: Record; default: not declared - registry.require().return.outputSchema.required?: string[]; default: not declared - registry.require().return.outputSchema.title?: string; default: not declared - registry.require().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.requiredCapabilities: readonly string[]; default: not declared - registry.require().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.require().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.require().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.require().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.require().return.title: string; default: not declared - registry.require().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.require(id): string; default: not declared - registry.run: (request: { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions) => import('@insiderfinance/totalfinance/workflows').OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - registry.run().return.artifacts: import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - registry.run().return.assumptions: Record; default: not declared - registry.run().return.diagnostics: { incomplete: string[]; status: 'complete' | 'partial'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - registry.run().return.diagnostics.incomplete: string[]; default: not declared - registry.run().return.diagnostics.status: 'complete' | 'partial'; default: not declared - registry.run().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - registry.run().return.identity: { artifactIds: string[]; inputsHash: string; snapshotHash: string | null; }; default: not declared - registry.run().return.identity.artifactIds: string[]; default: not declared - registry.run().return.identity.inputsHash: string; default: not declared - registry.run().return.identity.snapshotHash: string | null; default: not declared - registry.run().return.library: { version: string; }; default: not declared - registry.run().return.library.version: string; default: not declared - registry.run().return.operation: { id: string; version: string; }; default: not declared - registry.run().return.operation.id: string; default: not declared - registry.run().return.operation.version: string; default: not declared - registry.run().return.structured: Record; default: not declared - registry.run().return.summary: string; default: not declared - registry.run().return.trace: { requestId: string | null; }; default: not declared - registry.run().return.trace.requestId: string | null; default: not declared - registry.run().return.usage: { elapsedMs: number | null; inputBytes: number; }; default: not declared - registry.run().return.usage.elapsedMs: number | null; default: not declared - registry.run().return.usage.inputBytes: number; default: not declared - registry.run(request): { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions; default: not declared - registry.run(request).artifacts?: ArtifactStore | ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - registry.run(request).artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - registry.run(request).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - registry.run(request).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - registry.run(request).capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - registry.run(request).createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - registry.run(request).deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - registry.run(request).defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - registry.run(request).id: string; default: not declared - registry.run(request).inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - registry.run(request).input: unknown; default: not declared - registry.run(request).maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - registry.run(request).now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - registry.run(request).requestId?: string; default: not declared - registry.run(request).signal?: import('@insiderfinance/totalfinance/workflows').OperationSignal; default: not declared - registry.run(request).stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - registry.run(request).stores.authorization?: AuthorizationStore; default: not declared - registry.run(request).stores.journal?: ExecutionJournalStore; default: not declared - registry.size: number; default: not declared - stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10). - stores.authorization?: AuthorizationStore; default: not declared - stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - stores.authorization.consume().return.consumedTimestampMs: number; default: not declared - stores.authorization.consume().return.idempotencyKey: string; default: not declared - stores.authorization.consume().return.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume().return.journalId: string; default: not declared - stores.authorization.consume().return.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume().return.receiptId: string; default: not declared - stores.authorization.consume(input): import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }; default: not declared - stores.authorization.consume(input).consumedTimestampMs: number; default: not declared - stores.authorization.consume(input).hashOrUri: string; default: not declared - stores.authorization.consume(input).idempotencyKey: string; default: not declared - stores.authorization.consume(input).journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume(input).journalId: string; default: not declared - stores.authorization.consume(input).journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume(input).receiptId: string; default: not declared - stores.authorization.get: (hashOrUri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - stores.authorization.get().return.consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; default: not declared - stores.authorization.get().return.consumed.consumedTimestampMs: number; default: not declared - stores.authorization.get().return.consumed.idempotencyKey: string; default: not declared - stores.authorization.get().return.consumed.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.get().return.consumed.journalId: string; default: not declared - stores.authorization.get().return.consumed.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.get().return.consumed.receiptId: string; default: not declared - stores.authorization.get().return.grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.authorization.get().return.handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - stores.authorization.get(hashOrUri): string; default: not declared - stores.authorization.list: () => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - stores.authorization.put().return.contentHash: string | null; default: not declared - stores.authorization.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - stores.authorization.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - stores.authorization.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - stores.authorization.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - stores.authorization.put().return.schema: string; default: not declared - stores.authorization.put().return.uri: string; default: not declared - stores.authorization.put().return.version: string; default: not declared - stores.authorization.put(input): { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs; }; default: not declared - stores.authorization.put(input).createdTimestampMs: number; default: not declared - stores.authorization.put(input).grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.journal?: ExecutionJournalStore; default: not declared - stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - stores.journal.append().return.appended: number; default: not declared - stores.journal.append().return.journalId: string; default: not declared - stores.journal.append().return.skipped: number; default: not declared - stores.journal.append().return.total: number; default: not declared - stores.journal.append(input): { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }; default: not declared - stores.journal.append(input).events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared - stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - stores.journal.read(journalId): string; default: not declared - stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - stores.journal.transact(input): { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }; default: not declared - stores.journal.transact(input).execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; default: not declared - stores.journal.transact(input).journalId: string; default: not declared ### @insiderfinance/totalfinance/http#OpenApiDocument Kind: interface; stability: preview (pre-1.0). The subset of OpenAPI 3.1 this document uses — enough to be typed, validated, and diffed. ```typescript /** The subset of OpenAPI 3.1 this document uses — enough to be typed, validated, and diffed. */ export interface OpenApiDocument { openapi: '3.1.0'; info: { title: string; version: string; description: string; }; servers: { url: string; description: string; }[]; paths: Record>; components: { schemas: Record; securitySchemes: Record; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - components: { schemas: Record; securitySchemes: Record; }; default: not declared - components.schemas: Record; default: not declared - components.securitySchemes: Record; default: not declared - info: { description: string; title: string; version: string; }; default: not declared - info.description: string; default: not declared - info.title: string; default: not declared - info.version: string; default: not declared - openapi: '3.1.0'; default: not declared - paths: Record>; default: not declared - servers: { url: string; description: string; }[]; default: not declared ### @insiderfinance/totalfinance/http#OpenApiDocumentInput Kind: interface; stability: preview (pre-1.0). ```typescript export interface OpenApiDocumentInput { registry: OperationRegistry; /** The server url advertised in `servers` (default `http://127.0.0.1:8787`). */ serverUrl?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - registry: OperationRegistry; default: not declared - registry.describe: (id: string) => OperationDescription; default: not declared - registry.describe().return.annotations: import('@insiderfinance/totalfinance/workflows').OperationAnnotations; default: not declared - registry.describe().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.describe().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.describe().return.description: string; default: not declared - registry.describe().return.deterministic: boolean; default: not declared - registry.describe().return.handleFields: string[]; default: not declared - registry.describe().return.id: string; default: not declared - registry.describe().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.describe().return.inputSchema: JSONSchema; default: not declared - registry.describe().return.outputSchema: JSONSchema | null; default: not declared - registry.describe().return.outputSchema.$id?: string; default: not declared - registry.describe().return.outputSchema.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.describe().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.items?: JSONSchema; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.describe().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.describe().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.describe().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.outputSchema.allOf?: JSONSchema[]; default: not declared - registry.describe().return.outputSchema.anyOf?: JSONSchema[]; default: not declared - registry.describe().return.outputSchema.const?: unknown; default: not declared - registry.describe().return.outputSchema.default?: unknown; default: not declared - registry.describe().return.outputSchema.description?: string; default: not declared - registry.describe().return.outputSchema.enum?: unknown[]; default: not declared - registry.describe().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.describe().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.describe().return.outputSchema.format?: string; default: not declared - registry.describe().return.outputSchema.items?: JSONSchema; default: not declared - registry.describe().return.outputSchema.maxItems?: number; default: not declared - registry.describe().return.outputSchema.maxLength?: number; default: not declared - registry.describe().return.outputSchema.maximum?: number; default: not declared - registry.describe().return.outputSchema.minItems?: number; default: not declared - registry.describe().return.outputSchema.minLength?: number; default: not declared - registry.describe().return.outputSchema.minimum?: number; default: not declared - registry.describe().return.outputSchema.multipleOf?: number; default: not declared - registry.describe().return.outputSchema.oneOf?: JSONSchema[]; default: not declared - registry.describe().return.outputSchema.pattern?: string; default: not declared - registry.describe().return.outputSchema.properties?: Record; default: not declared - registry.describe().return.outputSchema.required?: string[]; default: not declared - registry.describe().return.outputSchema.title?: string; default: not declared - registry.describe().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.describe().return.requiredCapabilities: string[]; default: not declared - registry.describe().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.describe().return.stochastic: boolean | 'per-call'; default: not declared - registry.describe().return.supportsCancellation: boolean; default: not declared - registry.describe().return.title: string; default: not declared - registry.describe().return.version: string; default: not declared - registry.describe(id): string; default: not declared - registry.get: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation | null; default: not declared - registry.get().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.get().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.get().return.description: string; default: not declared - registry.get().return.deterministic: boolean; default: not declared - registry.get().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.get().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.get().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.get().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.get().return.outputSchema: JSONSchema | null; default: not declared - registry.get().return.outputSchema.$id?: string; default: not declared - registry.get().return.outputSchema.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.get().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.items?: JSONSchema; default: not declared - registry.get().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.get().return.outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - registry.get().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.get().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.get().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.get().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.outputSchema.allOf?: JSONSchema[]; default: not declared - registry.get().return.outputSchema.anyOf?: JSONSchema[]; default: not declared - registry.get().return.outputSchema.const?: unknown; default: not declared - registry.get().return.outputSchema.default?: unknown; default: not declared - registry.get().return.outputSchema.description?: string; default: not declared - registry.get().return.outputSchema.enum?: unknown[]; default: not declared - registry.get().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.get().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.get().return.outputSchema.format?: string; default: not declared - registry.get().return.outputSchema.items?: JSONSchema; default: not declared - registry.get().return.outputSchema.maxItems?: number; default: not declared - registry.get().return.outputSchema.maxLength?: number; default: not declared - registry.get().return.outputSchema.maximum?: number; default: not declared - registry.get().return.outputSchema.minItems?: number; default: not declared - registry.get().return.outputSchema.minLength?: number; default: not declared - registry.get().return.outputSchema.minimum?: number; default: not declared - registry.get().return.outputSchema.multipleOf?: number; default: not declared - registry.get().return.outputSchema.oneOf?: JSONSchema[]; default: not declared - registry.get().return.outputSchema.pattern?: string; default: not declared - registry.get().return.outputSchema.properties?: Record; default: not declared - registry.get().return.outputSchema.required?: string[]; default: not declared - registry.get().return.outputSchema.title?: string; default: not declared - registry.get().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.get().return.requiredCapabilities: readonly string[]; default: not declared - registry.get().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.get().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.get().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.get().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.get().return.title: string; default: not declared - registry.get().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.get(id): string; default: not declared - registry.list: () => OperationDescription[]; default: not declared - registry.packs: () => import('@insiderfinance/totalfinance/workflows').OperationPack[]; default: not declared - registry.require: (id: string) => import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - registry.require().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - registry.require().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - registry.require().return.description: string; default: not declared - registry.require().return.deterministic: boolean; default: not declared - registry.require().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - registry.require().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - registry.require().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - registry.require().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - registry.require().return.outputSchema: JSONSchema | null; default: not declared - registry.require().return.outputSchema.$id?: string; default: not declared - registry.require().return.outputSchema.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.$id?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.$schema?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.const?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.default?: unknown; default: not declared - registry.require().return.outputSchema.additionalProperties.description?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.format?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.items?: JSONSchema; default: not declared - registry.require().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.maximum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minItems?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minLength?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.minimum?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - registry.require().return.outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - registry.require().return.outputSchema.additionalProperties.pattern?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.properties?: Record; default: not declared - registry.require().return.outputSchema.additionalProperties.required?: string[]; default: not declared - registry.require().return.outputSchema.additionalProperties.title?: string; default: not declared - registry.require().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.outputSchema.allOf?: JSONSchema[]; default: not declared - registry.require().return.outputSchema.anyOf?: JSONSchema[]; default: not declared - registry.require().return.outputSchema.const?: unknown; default: not declared - registry.require().return.outputSchema.default?: unknown; default: not declared - registry.require().return.outputSchema.description?: string; default: not declared - registry.require().return.outputSchema.enum?: unknown[]; default: not declared - registry.require().return.outputSchema.exclusiveMaximum?: number; default: not declared - registry.require().return.outputSchema.exclusiveMinimum?: number; default: not declared - registry.require().return.outputSchema.format?: string; default: not declared - registry.require().return.outputSchema.items?: JSONSchema; default: not declared - registry.require().return.outputSchema.maxItems?: number; default: not declared - registry.require().return.outputSchema.maxLength?: number; default: not declared - registry.require().return.outputSchema.maximum?: number; default: not declared - registry.require().return.outputSchema.minItems?: number; default: not declared - registry.require().return.outputSchema.minLength?: number; default: not declared - registry.require().return.outputSchema.minimum?: number; default: not declared - registry.require().return.outputSchema.multipleOf?: number; default: not declared - registry.require().return.outputSchema.oneOf?: JSONSchema[]; default: not declared - registry.require().return.outputSchema.pattern?: string; default: not declared - registry.require().return.outputSchema.properties?: Record; default: not declared - registry.require().return.outputSchema.required?: string[]; default: not declared - registry.require().return.outputSchema.title?: string; default: not declared - registry.require().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - registry.require().return.requiredCapabilities: readonly string[]; default: not declared - registry.require().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - registry.require().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - registry.require().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - registry.require().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - registry.require().return.title: string; default: not declared - registry.require().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - registry.require(id): string; default: not declared - registry.run: (request: { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions) => import('@insiderfinance/totalfinance/workflows').OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - registry.run().return.artifacts: import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - registry.run().return.assumptions: Record; default: not declared - registry.run().return.diagnostics: { incomplete: string[]; status: 'complete' | 'partial'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - registry.run().return.diagnostics.incomplete: string[]; default: not declared - registry.run().return.diagnostics.status: 'complete' | 'partial'; default: not declared - registry.run().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - registry.run().return.identity: { artifactIds: string[]; inputsHash: string; snapshotHash: string | null; }; default: not declared - registry.run().return.identity.artifactIds: string[]; default: not declared - registry.run().return.identity.inputsHash: string; default: not declared - registry.run().return.identity.snapshotHash: string | null; default: not declared - registry.run().return.library: { version: string; }; default: not declared - registry.run().return.library.version: string; default: not declared - registry.run().return.operation: { id: string; version: string; }; default: not declared - registry.run().return.operation.id: string; default: not declared - registry.run().return.operation.version: string; default: not declared - registry.run().return.structured: Record; default: not declared - registry.run().return.summary: string; default: not declared - registry.run().return.trace: { requestId: string | null; }; default: not declared - registry.run().return.trace.requestId: string | null; default: not declared - registry.run().return.usage: { elapsedMs: number | null; inputBytes: number; }; default: not declared - registry.run().return.usage.elapsedMs: number | null; default: not declared - registry.run().return.usage.inputBytes: number; default: not declared - registry.run(request): { id: string; input: unknown; } & import('@insiderfinance/totalfinance/workflows').RunOperationOptions; default: not declared - registry.run(request).artifacts?: import('@insiderfinance/totalfinance/workflows').ArtifactStore | import('@insiderfinance/totalfinance/workflows').ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - registry.run(request).artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - registry.run(request).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - registry.run(request).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - registry.run(request).capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - registry.run(request).createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - registry.run(request).deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - registry.run(request).defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - registry.run(request).id: string; default: not declared - registry.run(request).inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - registry.run(request).input: unknown; default: not declared - registry.run(request).maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - registry.run(request).now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - registry.run(request).requestId?: string; default: not declared - registry.run(request).signal?: import('@insiderfinance/totalfinance/workflows').OperationSignal; default: not declared - registry.run(request).stores?: { authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - registry.run(request).stores.authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; default: not declared - registry.run(request).stores.journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; default: not declared - registry.size: number; default: not declared - serverUrl?: string; default: not declared — The server url advertised in `servers` (default `http://127.0.0.1:8787`). ### @insiderfinance/totalfinance/http#createLocalHttpServer Kind: function; stability: preview (pre-1.0). Create the server (not yet listening). ```typescript export declare function createLocalHttpServer(rawInput: LocalHttpServerInput): LocalHttpServer; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (rawInput): LocalHttpServerInput; default: not declared - (rawInput).allowNonLoopback?: boolean; default: not declared — Binding anything but loopback needs this flag and your own network/TLS boundary; reads remain unauthenticated. - (rawInput).artifacts?: ArtifactStore | ArtifactStoreReader; default: not declared — Handles resolve through this store; a writable store also receives spilled results. - (rawInput).artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - (rawInput).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - (rawInput).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - (rawInput).authenticationToken?: string; default: not declared — Server-owned bearer credential, at least 32 cryptographically random characters (e.g. randomBytes(32).toString('hex')). Required for enabled write operations, including trade:approve. Never returned by discovery. Read-only analytics remain public; job submission/cancellation always require this token. - (rawInput).budgets?: LocalHttpServerBudgets; default: not declared - (rawInput).capabilities?: readonly string[]; default: not declared — The server's capability ceiling (default the runtime's defaults). Writes also need the bearer credential. - (rawInput).clock?: () => string; default: not declared — The caller's clock (ISO instants for spilled results and job transitions); default `Date`. - (rawInput).host?: string; default: not declared - (rawInput).jobs?: JobRunner; default: not declared — The job runner (`@insiderfinance/totalfinance/workflows/local`'s or another implementation of the contract). - (rawInput).port?: number; default: not declared - (rawInput).registry: OperationRegistry; default: not declared - (rawInput).stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10). - (rawInput).stores.authorization?: AuthorizationStore; default: not declared - (rawInput).stores.journal?: ExecutionJournalStore; default: not declared - return.address: () => { host: string; port: number; url: string; } | null; default: not declared — The bound address once started (`null` before `start()` / after `stop()`). - return.document: OpenApiDocument; default: not declared - return.start: () => Promise<{ host: string; port: number; url: string; }>; default: not declared — Bind and listen; resolves with the bound address (port 0 picks a free port). - return.stop: () => Promise; default: not declared ### @insiderfinance/totalfinance/http#openApiDocument Kind: function; stability: preview (pre-1.0). Generate the OpenAPI 3.1 document for a registry. ```typescript export declare function openApiDocument(input: OpenApiDocumentInput): OpenApiDocument; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OpenApiDocumentInput; default: not declared - (input).registry: OperationRegistry; default: not declared - (input).serverUrl?: string; default: not declared — The server url advertised in `servers` (default `http://127.0.0.1:8787`). - return.components: { schemas: Record; securitySchemes: Record; }; default: not declared - return.components.schemas: Record; default: not declared - return.components.securitySchemes: Record; default: not declared - return.info: { title: string; version: string; description: string; }; default: not declared - return.info.description: string; default: not declared - return.info.title: string; default: not declared - return.info.version: string; default: not declared - return.openapi: '3.1.0'; default: not declared - return.paths: Record>; default: not declared - return.servers: { url: string; description: string; }[]; default: not declared ### @insiderfinance/totalfinance/http#statusForError Kind: function; stability: preview (pre-1.0). HTTP status for an OperationError (Decision 7). ```typescript export declare function statusForError(error: OperationError): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (error): OperationError; default: not declared - (error).code: string; default: not declared - (error).context: Record; default: not declared - (error).issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - (error).message: string; default: not declared - (error).operation: { id: string; version: string; } | null; default: not declared - (error).operation.id: string; default: not declared - (error).operation.version: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/math ### @insiderfinance/totalfinance/math#AdaptiveSimpsonOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AdaptiveSimpsonOptions { tolerance?: number; maxDepth?: number; /** * Maximum integrand evaluations before stopping with `converged: false`. Default 100,000. * * `maxDepth` bounds the DEPTH of a binary subdivision, so it bounds the work at 2^depth — the * default of 50 therefore permits about 10^15 evaluations, which is a budget in name only. This is * the bound that actually holds. */ maxEvaluations?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxDepth?: number; default: not declared - maxEvaluations?: number; default: not declared — Maximum integrand evaluations before stopping with `converged: false`. Default 100,000. `maxDepth` bounds the DEPTH of a binary subdivision, so it bounds the work at 2^depth — the default of 50 therefore permits about 10^15 evaluations, which is a budget in name only. This is the bound that actually holds. - tolerance?: number; default: not declared ### @insiderfinance/totalfinance/math#AdaptiveSimpsonResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AdaptiveSimpsonResult { /** The integral estimate (best available even when `converged` is false). */ value: number; /** Whether every subinterval met its (halved) tolerance before the depth budget ran out. */ converged: boolean; /** The deepest recursion level reached (0 = no subdivision). */ deepestLevel: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared — Whether every subinterval met its (halved) tolerance before the depth budget ran out. - deepestLevel: number; default: not declared — The deepest recursion level reached (0 = no subdivision). - value: number; default: not declared — The integral estimate (best available even when `converged` is false). ### @insiderfinance/totalfinance/math#AugmentedDickeyFullerOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AugmentedDickeyFullerOptions { /** Deterministic terms: `'c'` = constant (default), `'ct'` = constant + linear trend. */ regression?: 'c' | 'ct'; /** Number of augmenting lagged differences (default 0 ⇒ plain Dickey–Fuller). */ lags?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lags?: number; default: not declared — Number of augmenting lagged differences (default 0 ⇒ plain Dickey–Fuller). - regression?: 'c' | 'ct'; default: not declared — Deterministic terms: `'c'` = constant (default), `'ct'` = constant + linear trend. ### @insiderfinance/totalfinance/math#AxisOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AxisOptions { /** Skip validation (trusted fast path for pre-validated data). */ assumeSorted?: boolean; /** How to handle duplicate x-values. Omitted → duplicates are rejected. */ aggregate?: 'mean' | 'first' | 'last'; /** * Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` * (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). */ extrapolate?: ExtrapolationPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - extrapolate?: ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). ### @insiderfinance/totalfinance/math#BootstrapOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BootstrapOptions { /** Number of resamples (default 1000). */ iterations?: number; /** Seed — required so results are reproducible (and echoed back). */ seed: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - iterations?: number; default: not declared — Number of resamples (default 1000). - seed: number; default: not declared — Seed — required so results are reproducible (and echoed back). ### @insiderfinance/totalfinance/math#BootstrapResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BootstrapResult { estimates: number[]; mean: number; standardDeviation: number; /** 95% percentile confidence interval. */ confidenceInterval95: [ number, number ]; seed: number; iterations: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidenceInterval95: [number, number]; default: not declared — 95% percentile confidence interval. - estimates: number[]; default: not declared - iterations: number; default: not declared - mean: number; default: not declared - seed: number; default: not declared - standardDeviation: number; default: not declared ### @insiderfinance/totalfinance/math#Bracket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Bracket { lowerBound: number; upperBound: number; objectiveAtLowerBound: number; objectiveAtUpperBound: number; found: boolean; /** Expansion steps taken (so callers like findRoot can report a truthful total iteration count). */ iterations: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - found: boolean; default: not declared - iterations: number; default: not declared — Expansion steps taken (so callers like findRoot can report a truthful total iteration count). - lowerBound: number; default: not declared - objectiveAtLowerBound: number; default: not declared - objectiveAtUpperBound: number; default: not declared - upperBound: number; default: not declared ### @insiderfinance/totalfinance/math#BracketExpandOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BracketExpandOptions { /** Growth factor per step (default 1.6). */ factor?: number; /** Maximum expansion steps (default 60). */ maximumIterations?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor?: number; default: not declared — Growth factor per step (default 1.6). - maximumIterations?: number; default: not declared — Maximum expansion steps (default 60). ### @insiderfinance/totalfinance/math#Complex Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A complex number `re + im·i`. ```typescript // ───────────────────────── general (non-symmetric) eigenvalues ───────────────────────── /** A complex number `re + im·i`. */ export interface Complex { re: number; im: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - im: number; default: not declared - re: number; default: not declared ### @insiderfinance/totalfinance/math#CovarianceEstimate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A well-conditioned covariance estimate plus its conditioning diagnostics. ```typescript /** A well-conditioned covariance estimate plus its conditioning diagnostics. */ export interface CovarianceEstimate { /** The estimated covariance. */ covariance: Matrix; /** The estimator actually used (`'auto'` resolves to one of these). */ method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; /** Number of variables `p`. */ variables: number; /** Number of observations `T`. */ observations: number; /** Smallest eigenvalue of the returned covariance. */ minEigenvalue: number; /** Largest eigenvalue of the returned covariance. */ maxEigenvalue: number; /** `maxEigenvalue / minEigenvalue` (`Infinity` when singular). */ conditionNumber: number; /** Whether the returned covariance is positive-definite (invertible). */ isPositiveDefinite: boolean; /** Number of eigenvalues `> 1e-9 · maxEigenvalue` — the effective rank. */ effectiveRank: number; /** Ledoit–Wolf shrinkage intensity, present when `method` is `'ledoit-wolf'`. */ shrinkage?: number; /** The EWMA decay used — present only for method `'ewma'`. */ lambda?: number; /** Kish effective sample size `1/Σwₜ²` — present only for method `'ewma'`. */ effectiveObservations?: number; assumptions: { conventionsVersion: string; method: string; population: boolean; /** Single-index target only: the caller's observed market series vs the equal-weight proxy. */ marketProxy?: 'observed-series' | 'equal-weight'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; marketProxy?: 'observed-series' | 'equal-weight'; method: string; population: boolean; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.marketProxy?: 'observed-series' | 'equal-weight'; default: not declared — Single-index target only: the caller's observed market series vs the equal-weight proxy. - assumptions.method: string; default: not declared - assumptions.population: boolean; default: not declared - conditionNumber: number; default: not declared — `maxEigenvalue / minEigenvalue` (`Infinity` when singular). - covariance: Matrix; default: not declared — The estimated covariance. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - effectiveObservations?: number; default: not declared — Kish effective sample size `1/Σwₜ²` — present only for method `'ewma'`. - effectiveRank: number; default: not declared — Number of eigenvalues `> 1e-9 · maxEigenvalue` — the effective rank. - isPositiveDefinite: boolean; default: not declared — Whether the returned covariance is positive-definite (invertible). - lambda?: number; default: not declared — The EWMA decay used — present only for method `'ewma'`. - maxEigenvalue: number; default: not declared — Largest eigenvalue of the returned covariance. - method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; default: not declared — The estimator actually used (`'auto'` resolves to one of these). - minEigenvalue: number; default: not declared — Smallest eigenvalue of the returned covariance. - observations: number; default: not declared — Number of observations `T`. - shrinkage?: number; default: not declared — Ledoit–Wolf shrinkage intensity, present when `method` is `'ledoit-wolf'`. - variables: number; default: not declared — Number of variables `p`. ### @insiderfinance/totalfinance/math#CovarianceMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Covariance estimator selector for {@link estimateCovariance}. ```typescript // ── covariance-estimation front door ─────────────────────────────────────────────────────────── /** Covariance estimator selector for {@link estimateCovariance}. */ export type CovarianceMethod = 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma' | 'auto'; ``` ### @insiderfinance/totalfinance/math#Derivatives Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). First through third derivatives at a point, for derivative-based solvers. ```typescript /** First through third derivatives at a point, for derivative-based solvers. */ export interface Derivatives { f: number; df: number; d2f?: number; d3f?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - d2f?: number; default: not declared - d3f?: number; default: not declared - df: number; default: not declared - f: number; default: not declared ### @insiderfinance/totalfinance/math#DifferentialEvolutionOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DifferentialEvolutionOptions { /** Population size. Default `max(20, 10·dim)`. */ populationSize?: number; /** Maximum generations. Default 300. */ maxGenerations?: number; /** Differential weight `F ∈ (0, 2]`. Default 0.8. */ mutation?: number; /** Crossover probability `CR ∈ [0, 1]`. Default 0.9. */ crossover?: number; /** Seed for the deterministic PRNG. Default 0x5eed. */ seed?: number; /** Converge when the population's objective spread falls below this. Default 1e-12. */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - crossover?: number; default: not declared — Crossover probability `CR ∈ [0, 1]`. Default 0.9. - maxGenerations?: number; default: not declared — Maximum generations. Default 300. - mutation?: number; default: not declared — Differential weight `F ∈ (0, 2]`. Default 0.8. - populationSize?: number; default: not declared — Population size. Default `max(20, 10·dim)`. - seed?: number; default: not declared — Seed for the deterministic PRNG. Default 0x5eed. - tolerance?: number; default: not declared — Converge when the population's objective spread falls below this. Default 1e-12. ### @insiderfinance/totalfinance/math#EigenResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EigenResult { /** Eigenvalues (not sorted). */ values: number[]; /** Eigenvectors as columns of the matrix. */ vectors: Matrix; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - values: number[]; default: not declared — Eigenvalues (not sorted). - vectors: Matrix; default: not declared — Eigenvectors as columns of the matrix. ### @insiderfinance/totalfinance/math#EngleGrangerResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EngleGrangerResult { /** Slope of the cointegrating regression `y = α + β·x + resid`. */ beta: number; /** Intercept of the cointegrating regression. */ alpha: number; /** ADF test on the regression residuals (the cointegration test statistic). */ residualAugmentedDickeyFuller: TestResult; /** `true` when the residual ADF statistic falls below the 5% Engle–Granger critical value. */ cointegrated: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha: number; default: not declared — Intercept of the cointegrating regression. - beta: number; default: not declared — Slope of the cointegrating regression `y = α + β·x + resid`. - cointegrated: boolean; default: not declared — `true` when the residual ADF statistic falls below the 5% Engle–Granger critical value. - residualAugmentedDickeyFuller: TestResult; default: not declared — ADF test on the regression residuals (the cointegration test statistic). - residualAugmentedDickeyFuller.criticalValues?: { '1%': number; '10%': number; '5%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - residualAugmentedDickeyFuller.criticalValues.1%: number; default: not declared - residualAugmentedDickeyFuller.criticalValues.10%: number; default: not declared - residualAugmentedDickeyFuller.criticalValues.5%: number; default: not declared - residualAugmentedDickeyFuller.method: string; default: not declared — Human-readable identifier of the test and its configuration. - residualAugmentedDickeyFuller.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - residualAugmentedDickeyFuller.statistic: number; default: not declared — The test statistic. ### @insiderfinance/totalfinance/math#EstimateCovarianceOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link estimateCovariance}. ```typescript /** Options for {@link estimateCovariance}. */ export interface EstimateCovarianceOptions { /** Estimator; default `'auto'`. */ method?: CovarianceMethod; /** Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. */ ridge?: number; /** Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. */ conditionThreshold?: number; /** Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). */ population?: boolean; /** EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). */ lambda?: number; /** EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. */ halfLife?: number; /** * Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). * `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` * (the market-model target, best-specified for stock returns). */ ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; /** * Observed market return series for the `'single-index'` target (length `T`). Omitted → the * equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. */ market?: ArrayLike; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conditionThreshold?: number; default: not declared — Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. - halfLife?: number; default: not declared — EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. - lambda?: number; default: not declared — EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). - ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` (the market-model target, best-specified for stock returns). - market?: ArrayLike; default: not declared — Observed market return series for the `'single-index'` target (length `T`). Omitted → the equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. - method?: CovarianceMethod; default: not declared — Estimator; default `'auto'`. - population?: boolean; default: not declared — Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). - ridge?: number; default: not declared — Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. ### @insiderfinance/totalfinance/math#ExtrapolationPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExtrapolationPolicy = 'flat' | 'linear' | 'forbid'; ``` ### @insiderfinance/totalfinance/math#FunctionWithDerivatives Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FunctionWithDerivatives = (x: number) => Derivatives; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared - return.d2f?: number; default: not declared - return.d3f?: number; default: not declared - return.df: number; default: not declared - return.f: number; default: not declared ### @insiderfinance/totalfinance/math#GeneralEigenResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GeneralEigenResult { /** Eigenvalues (real, or complex-conjugate pairs), in real-Schur order. */ values: Complex[]; /** * Eigenvector for each real eigenvalue (via inverse iteration), aligned to `values`; `null` for * complex eigenvalues (their eigenvectors are complex and not returned in this real interface). */ vectors: (number[] | null)[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - values: Complex[]; default: not declared — Eigenvalues (real, or complex-conjugate pairs), in real-Schur order. - vectors: (number[] | null)[]; default: not declared — Eigenvector for each real eigenvalue (via inverse iteration), aligned to `values`; `null` for complex eigenvalues (their eigenvectors are complex and not returned in this real interface). ### @insiderfinance/totalfinance/math#InterpolateOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface InterpolateOptions { extrapolate?: ExtrapolationPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - extrapolate?: ExtrapolationPolicy; default: not declared ### @insiderfinance/totalfinance/math#KalmanFilterResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Forward-pass (filter) output. All arrays are length `T`, aligned to the observation sequence. ```typescript /** Forward-pass (filter) output. All arrays are length `T`, aligned to the observation sequence. */ export interface KalmanFilterResult { /** Filtered state means `x̂ₜ|ₜ` (`T × n`). */ filteredStates: number[][]; /** Filtered state covariances `Pₜ|ₜ`. */ filteredCovariances: Matrix[]; /** One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). */ predictedStates: number[][]; /** One-step predicted state covariances `Pₜ|ₜ₋₁`. */ predictedCovariances: Matrix[]; /** Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). */ innovations: (number[] | null)[]; /** Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). */ innovationCovariances: (Matrix | null)[]; /** Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. */ logLikelihood: number; /** Number of steps that contributed to the likelihood (observed steps). */ observedCount: number; /** State dimension. */ stateDimension: number; /** Observation dimension. */ observationDimension: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - filteredCovariances: Matrix[]; default: not declared — Filtered state covariances `Pₜ|ₜ`. - filteredStates: number[][]; default: not declared — Filtered state means `x̂ₜ|ₜ` (`T × n`). - innovationCovariances: (Matrix | null)[]; default: not declared — Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). - innovations: (number[] | null)[]; default: not declared — Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). - logLikelihood: number; default: not declared — Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. - observationDimension: number; default: not declared — Observation dimension. - observedCount: number; default: not declared — Number of steps that contributed to the likelihood (observed steps). - predictedCovariances: Matrix[]; default: not declared — One-step predicted state covariances `Pₜ|ₜ₋₁`. - predictedStates: number[][]; default: not declared — One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). - stateDimension: number; default: not declared — State dimension. ### @insiderfinance/totalfinance/math#KalmanModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Linear-Gaussian state-space parameters. `n` = state dimension, `m` = observation dimension. ```typescript /** Linear-Gaussian state-space parameters. `n` = state dimension, `m` = observation dimension. */ export interface KalmanModel { /** Prior state mean `x₀`, length `n`. */ x0: number[]; /** Prior state covariance `P₀`, `n × n` (symmetric PSD). */ P0: Matrix; /** State-transition matrix `F`, `n × n`. */ F: Matrix; /** Observation matrix `H`, `m × n`. */ H: Matrix; /** Process-noise covariance `Q`, `n × n` (symmetric PSD). */ Q: Matrix; /** Observation-noise covariance `R`, `m × m` (symmetric PD). */ R: Matrix; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - F: Matrix; default: not declared — State-transition matrix `F`, `n × n`. - H: Matrix; default: not declared — Observation matrix `H`, `m × n`. - P0: Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - Q: Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - R: Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. ### @insiderfinance/totalfinance/math#KalmanObservation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A single observation: an `m`-vector, a bare number (only when `m = 1`), or `null` / a vector containing `NaN` to mark a MISSING observation (that step predicts only). ```typescript /** * A single observation: an `m`-vector, a bare number (only when `m = 1`), or `null` / a vector * containing `NaN` to mark a MISSING observation (that step predicts only). */ export type KalmanObservation = number[] | number | null; ``` ### @insiderfinance/totalfinance/math#KalmanSmoothResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). RTS-smoother output — the filter result plus the backward-smoothed estimates. ```typescript /** RTS-smoother output — the filter result plus the backward-smoothed estimates. */ export interface KalmanSmoothResult extends KalmanFilterResult { /** Smoothed state means `x̂ₜ|T` using all `T` observations (`T × n`). */ smoothedStates: number[][]; /** Smoothed state covariances `Pₜ|T`. */ smoothedCovariances: Matrix[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - filteredCovariances: Matrix[]; default: not declared — Filtered state covariances `Pₜ|ₜ`. - filteredStates: number[][]; default: not declared — Filtered state means `x̂ₜ|ₜ` (`T × n`). - innovationCovariances: (Matrix | null)[]; default: not declared — Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). - innovations: (number[] | null)[]; default: not declared — Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). - logLikelihood: number; default: not declared — Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. - observationDimension: number; default: not declared — Observation dimension. - observedCount: number; default: not declared — Number of steps that contributed to the likelihood (observed steps). - predictedCovariances: Matrix[]; default: not declared — One-step predicted state covariances `Pₜ|ₜ₋₁`. - predictedStates: number[][]; default: not declared — One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). - smoothedCovariances: Matrix[]; default: not declared — Smoothed state covariances `Pₜ|T`. - smoothedStates: number[][]; default: not declared — Smoothed state means `x̂ₜ|T` using all `T` observations (`T × n`). - stateDimension: number; default: not declared — State dimension. ### @insiderfinance/totalfinance/math#KpssOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KpssOptions { /** `'c'` = level stationarity (default), `'ct'` = trend stationarity. */ regression?: 'c' | 'ct'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - regression?: 'c' | 'ct'; default: not declared — `'c'` = level stationarity (default), `'ct'` = trend stationarity. ### @insiderfinance/totalfinance/math#KurtosisOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KurtosisOptions extends StatisticsOptions { /** Return excess kurtosis (subtract 3). Default `true`. */ excess?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - excess?: boolean; default: not declared — Return excess kurtosis (subtract 3). Default `true`. - nanPolicy?: NanPolicy; default: not declared ### @insiderfinance/totalfinance/math#LMOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LMOptions { tolerance?: number; maximumIterations?: number; lambda0?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lambda0?: number; default: not declared - maximumIterations?: number; default: not declared - tolerance?: number; default: not declared ### @insiderfinance/totalfinance/math#LedoitWolfOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link ledoitWolfShrinkage}. ```typescript /** Options for {@link ledoitWolfShrinkage}. */ export interface LedoitWolfOptions { /** * Shrinkage target: `'identity'` (the scaled identity `μI`, the default and original), * `'constant-correlation'` (the Ledoit–Wolf 2004 target — each variable's own variance with the * **average** sample correlation on every off-diagonal, which fits correlated asset returns far better), or * `'single-index'` (the Ledoit–Wolf 2003 market-model target — a one-factor structure built from each * variable's covariance with the equal-weighted market, the best-specified target for stock returns). */ target?: 'identity' | 'constant-correlation' | 'single-index'; /** * Observed market return series (length `T`, chronological) for the `'single-index'` target. * When omitted the equal-weight cross-sectional average of `series` is used as the market proxy * (Ledoit–Wolf 2003's construction); {@link estimateCovariance} discloses which was used. */ market?: ArrayLike; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - market?: ArrayLike; default: not declared — Observed market return series (length `T`, chronological) for the `'single-index'` target. When omitted the equal-weight cross-sectional average of `series` is used as the market proxy (Ledoit–Wolf 2003's construction); {@link estimateCovariance} discloses which was used. - target?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Shrinkage target: `'identity'` (the scaled identity `μI`, the default and original), `'constant-correlation'` (the Ledoit–Wolf 2004 target — each variable's own variance with the **average** sample correlation on every off-diagonal, which fits correlated asset returns far better), or `'single-index'` (the Ledoit–Wolf 2003 market-model target — a one-factor structure built from each variable's covariance with the equal-weighted market, the best-specified target for stock returns). ### @insiderfinance/totalfinance/math#LedoitWolfResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Ledoit–Wolf shrunk covariance and the intensity that produced it. ```typescript /** The Ledoit–Wolf shrunk covariance and the intensity that produced it. */ export interface LedoitWolfResult { /** Shrunk covariance `Σ* = δ·F + (1−δ)·S` (`F` = the chosen target) — symmetric positive-definite even when `T < p`. */ covariance: Matrix; /** Optimal shrinkage intensity `δ ∈ [0, 1]`. */ shrinkage: number; /** Raw sample covariance `S` (`1/T` / MLE normalization). */ sampleCovariance: Matrix; /** Average variance `μ = tr(S)/p` — the scaled-identity target's diagonal. */ averageVariance: number; /** Number of observations `T`. */ observations: number; /** The shrinkage target used. */ target: 'identity' | 'constant-correlation' | 'single-index'; /** Average off-diagonal sample correlation `r̄` — the constant-correlation target's correlation (that target only). */ averageCorrelation?: number; /** Variance of the equal-weighted market proxy `varmkt` — the single-index target's factor variance (that target only). */ marketVariance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageCorrelation?: number; default: not declared — Average off-diagonal sample correlation `r̄` — the constant-correlation target's correlation (that target only). - averageVariance: number; default: not declared — Average variance `μ = tr(S)/p` — the scaled-identity target's diagonal. - covariance: Matrix; default: not declared — Shrunk covariance `Σ* = δ·F + (1−δ)·S` (`F` = the chosen target) — symmetric positive-definite even when `T < p`. - marketVariance?: number; default: not declared — Variance of the equal-weighted market proxy `varmkt` — the single-index target's factor variance (that target only). - observations: number; default: not declared — Number of observations `T`. - sampleCovariance: Matrix; default: not declared — Raw sample covariance `S` (`1/T` / MLE normalization). - shrinkage: number; default: not declared — Optimal shrinkage intensity `δ ∈ [0, 1]`. - target: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — The shrinkage target used. ### @insiderfinance/totalfinance/math#LevenbergMarquardtResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LevenbergMarquardtResult { parameters: number[]; residualNorm: number; converged: boolean; iterations: number; /** Residual-vector evaluations performed (interpretability parity with the other optimizers). */ evaluations?: number; reason?: 'max_iterations'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared - evaluations?: number; default: not declared — Residual-vector evaluations performed (interpretability parity with the other optimizers). - iterations: number; default: not declared - parameters: number[]; default: not declared - reason?: 'max_iterations'; default: not declared - residualNorm: number; default: not declared ### @insiderfinance/totalfinance/math#LjungBoxOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Ljung–Box ───────────────────────── export interface LjungBoxOptions { /** * Number of parameters ESTIMATED from the same series before the test (e.g. `p + q` for the * residuals of an ARMA(p, q) fit). The reference distribution loses one degree of freedom per * fitted parameter: `Q ~ χ²(lags − fittedParameterCount)`. Default 0 — the raw white-noise null, * which is the right reference only for a series that was NOT fitted. */ fittedParameterCount?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fittedParameterCount?: number; default: not declared — Number of parameters ESTIMATED from the same series before the test (e.g. `p + q` for the residuals of an ARMA(p, q) fit). The reference distribution loses one degree of freedom per fitted parameter: `Q ~ χ²(lags − fittedParameterCount)`. Default 0 — the raw white-noise null, which is the right reference only for a series that was NOT fitted. ### @insiderfinance/totalfinance/math#LuResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── LU decomposition (partial pivoting) ───────────────────────── export interface LuResult { /** Combined lower/upper factors (unit-diagonal `L` below, `U` on and above the diagonal). */ lu: Matrix; /** Row permutation: `pivotIndices[i]` is the source row moved into row `i`. */ pivotIndices: number[]; /** Sign of the permutation (+1 or −1), for the determinant. */ sign: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lu: Matrix; default: not declared — Combined lower/upper factors (unit-diagonal `L` below, `U` on and above the diagonal). - pivotIndices: number[]; default: not declared — Row permutation: `pivotIndices[i]` is the source row moved into row `i`. - sign: number; default: not declared — Sign of the permutation (+1 or −1), for the determinant. ### @insiderfinance/totalfinance/math#Matrix Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type Matrix = number[][]; ``` ### @insiderfinance/totalfinance/math#MedianAbsoluteDeviationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ---- robust statistics ---- export interface MedianAbsoluteDeviationOptions extends StatisticsOptions { /** Scale by 1.4826 for consistency with the normal stddev (default `true`). */ scale?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - nanPolicy?: NanPolicy; default: not declared - scale?: boolean; default: not declared — Scale by 1.4826 for consistency with the normal stddev (default `true`). ### @insiderfinance/totalfinance/math#MinOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MinOptions { tolerance?: number; maximumIterations?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumIterations?: number; default: not declared - tolerance?: number; default: not declared ### @insiderfinance/totalfinance/math#MinResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MinResult { argMin: number; minimum: number; converged: boolean; iterations: number; /** Objective evaluations performed (interpretability parity across optimizers). */ evaluations?: number; reason?: 'max_iterations' | 'non_finite'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - argMin: number; default: not declared - converged: boolean; default: not declared - evaluations?: number; default: not declared — Objective evaluations performed (interpretability parity across optimizers). - iterations: number; default: not declared - minimum: number; default: not declared - reason?: 'max_iterations' | 'non_finite'; default: not declared ### @insiderfinance/totalfinance/math#MonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonteCarloOptions { /** Maximum paths (default 100_000). */ paths?: number; /** Seed — required and echoed for reproducibility. */ seed: number; /** Stop once the standard error falls to/below this (after `minPaths`). */ targetStandardError?: number; /** Minimum paths before the stopping rule applies (default 1000). */ minPaths?: number; /** Confidence level for the interval (default 0.95). */ confidence?: number; /** RNG factory (default mulberry32). */ randomNumberGenerator?: (seed: number) => RandomNumberGenerator; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - minPaths?: number; default: not declared — Minimum paths before the stopping rule applies (default 1000). - paths?: number; default: not declared — Maximum paths (default 100_000). - randomNumberGenerator?: (seed: number) => RandomNumberGenerator; default: not declared — RNG factory (default mulberry32). - randomNumberGenerator().return.getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - randomNumberGenerator().return.next: () => number; default: not declared — Uniform sample in [0, 1). - randomNumberGenerator().return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - randomNumberGenerator(seed): number; default: not declared - seed: number; default: not declared — Seed — required and echoed for reproducibility. - targetStandardError?: number; default: not declared — Stop once the standard error falls to/below this (after `minPaths`). ### @insiderfinance/totalfinance/math#MonteCarloResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonteCarloResult { value: number; variance: number; standardError: number; /** Confidence interval at the requested level (default 95%). */ confidenceInterval: [ number, number ]; paths: number; seed: number; /** Whether the target standard error was reached (always true when no target is set). */ converged: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidenceInterval: [number, number]; default: not declared — Confidence interval at the requested level (default 95%). - converged: boolean; default: not declared — Whether the target standard error was reached (always true when no target is set). - paths: number; default: not declared - seed: number; default: not declared - standardError: number; default: not declared - value: number; default: not declared - variance: number; default: not declared ### @insiderfinance/totalfinance/math#MultiMinOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MultiMinOptions { tolerance?: number; maximumIterations?: number; /** Analytic gradient; if omitted, a central-difference gradient is used (BFGS only). */ grad?: (point: number[]) => number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - grad?: (point: number[]) => number[]; default: not declared — Analytic gradient; if omitted, a central-difference gradient is used (BFGS only). - grad(point): number[]; default: not declared - maximumIterations?: number; default: not declared - tolerance?: number; default: not declared ### @insiderfinance/totalfinance/math#MultiMinResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MultiMinResult { argMin: number[]; minimum: number; converged: boolean; iterations: number; /** Objective evaluations performed. */ evaluations?: number; /** Seeded global optimizers (differential evolution) echo the PRNG seed actually used. */ seed?: number; reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - argMin: number[]; default: not declared - converged: boolean; default: not declared - evaluations?: number; default: not declared — Objective evaluations performed. - iterations: number; default: not declared - minimum: number; default: not declared - reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. ### @insiderfinance/totalfinance/math#MultivariateFunction Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MultivariateFunction = (x: number[]) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number[]; default: not declared ### @insiderfinance/totalfinance/math#NanPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type NanPolicy = 'propagate' | 'omit' | 'throw'; ``` ### @insiderfinance/totalfinance/math#OlsHacOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Newey–West HAC configuration: Bartlett-kernel bandwidth (number of lags). ```typescript /** Newey–West HAC configuration: Bartlett-kernel bandwidth (number of lags). */ export interface OlsHacOptions { /** Bartlett-kernel bandwidth `L`; weights are `1 − j/(L+1)` for lag `j = 1..L`. The covariance includes the finite-sample factor n/(n−k) at every bandwidth; `L = 0` ⇒ HC1. */ lags: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lags: number; default: not declared — Bartlett-kernel bandwidth `L`; weights are `1 − j/(L+1)` for lag `j = 1..L`. The covariance includes the finite-sample factor n/(n−k) at every bandwidth; `L = 0` ⇒ HC1. ### @insiderfinance/totalfinance/math#OlsOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OlsOptions { /** Prepend an intercept column of ones (default `true`). */ intercept?: boolean; /** Replace the classical covariance with the Newey–West HAC estimator. */ hac?: OlsHacOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - hac?: OlsHacOptions; default: not declared — Replace the classical covariance with the Newey–West HAC estimator. - hac.lags: number; default: not declared — Bartlett-kernel bandwidth `L`; weights are `1 − j/(L+1)` for lag `j = 1..L`. The covariance includes the finite-sample factor n/(n−k) at every bandwidth; `L = 0` ⇒ HC1. - intercept?: boolean; default: not declared — Prepend an intercept column of ones (default `true`). ### @insiderfinance/totalfinance/math#OlsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OlsResult { /** Fitted coefficients; the intercept is first when `intercept !== false`. */ coefficients: number[]; /** Standard error of each coefficient (√ of the covariance diagonal). */ standardErrors: number[]; /** t-statistic `βⱼ / se(βⱼ)` for each coefficient. */ tStatistics: number[]; /** Coefficient of determination `R²` (centered when an intercept is present). */ rSquared: number; /** Degrees-of-freedom-adjusted `R̄²`. */ adjustedRSquared: number; /** Residuals `y − Xβ`, aligned to the input rows. */ residuals: number[]; /** Number of observations. */ observationCount: number; /** Number of estimated coefficients (including the intercept). */ coefficientCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustedRSquared: number; default: not declared — Degrees-of-freedom-adjusted `R̄²`. - coefficientCount: number; default: not declared — Number of estimated coefficients (including the intercept). - coefficients: number[]; default: not declared — Fitted coefficients; the intercept is first when `intercept !== false`. - observationCount: number; default: not declared — Number of observations. - rSquared: number; default: not declared — Coefficient of determination `R²` (centered when an intercept is present). - residuals: number[]; default: not declared — Residuals `y − Xβ`, aligned to the input rows. - standardErrors: number[]; default: not declared — Standard error of each coefficient (√ of the covariance diagonal). - tStatistics: number[]; default: not declared — t-statistic `βⱼ / se(βⱼ)` for each coefficient. ### @insiderfinance/totalfinance/math#PopulationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The estimator choice alone — the whole contract of the rolling family and `covarianceMatrix`. ```typescript /** The estimator choice alone — the whole contract of the rolling family and `covarianceMatrix`. */ export interface PopulationOptions { /** Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). */ population?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). ### @insiderfinance/totalfinance/math#QrResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── QR decomposition (Householder) ───────────────────────── export interface QrResult { /** Orthonormal `Q` (`m × n`, thin). */ q: Matrix; /** Upper-triangular `R` (`n × n`). */ r: Matrix; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - q: Matrix; default: not declared — Orthonormal `Q` (`m × n`, thin). - r: Matrix; default: not declared — Upper-triangular `R` (`n × n`). ### @insiderfinance/totalfinance/math#RandomNumberGenerator Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RandomNumberGenerator { /** Uniform sample in [0, 1). */ next(): number; /** The seed this generator was created with (echoed for reproducibility). */ readonly seed: number; /** Snapshot the current internal state for exact restoration. */ getState(): RandomNumberGeneratorState; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - getState: () => RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - getState().return.algorithm: ('mulberry32') | ('xoshiro128ss'); default: not declared - getState().return.seed: number; default: not declared - getState().return.state: ([number, number, number, number]) | ([number]); default: not declared - next: () => number; default: not declared — Uniform sample in [0, 1). - seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). ### @insiderfinance/totalfinance/math#RandomNumberGeneratorState Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable PRNG state — restore an RNG mid-stream with `restoreRandomNumberGenerator`. A DISCRIMINATED UNION, because `algorithm: string` with `state: number[]` declared something the runtime does not accept: every string was a legal algorithm and every length a legal state, while the implementation admits exactly two algorithms and a fixed word count for each. A caller reading the type could not tell that `{ algorithm: 'mt19937', state: [] }` is unusable, and the harness could not either — it filed the refusal as a boundary that rejects valid input. The state word counts are part of the contract, not an implementation note: mulberry32 carries one 32-bit word, xoshiro128** carries four. Tuple types state that, so the length check below is a restatement of the declaration rather than a rule that lives only in the runtime. ```typescript /** * Serializable PRNG state — restore an RNG mid-stream with `restoreRandomNumberGenerator`. * * A DISCRIMINATED UNION, because `algorithm: string` with `state: number[]` declared something the * runtime does not accept: every string was a legal algorithm and every length a legal state, while * the implementation admits exactly two algorithms and a fixed word count for each. A caller reading * the type could not tell that `{ algorithm: 'mt19937', state: [] }` is unusable, and the harness * could not either — it filed the refusal as a boundary that rejects valid input. * * The state word counts are part of the contract, not an implementation note: mulberry32 carries one * 32-bit word, xoshiro128** carries four. Tuple types state that, so the length check below is a * restatement of the declaration rather than a rule that lives only in the runtime. */ export type RandomNumberGeneratorState = { algorithm: 'mulberry32'; state: [ number ]; seed: number; } | { algorithm: 'xoshiro128ss'; state: [ number, number, number, number ]; seed: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - algorithm: ('mulberry32') | ('xoshiro128ss'); default: not declared - seed: number; default: not declared - state: ([number, number, number, number]) | ([number]); default: not declared ### @insiderfinance/totalfinance/math#RootProblem Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RootProblem { objective: ScalarFunction; lowerBound: number; upperBound: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lowerBound: number; default: not declared - objective: ScalarFunction; default: not declared - objective(x): number; default: not declared - upperBound: number; default: not declared ### @insiderfinance/totalfinance/math#SOBOL_MAX_DIMENSIONS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const SOBOL_MAX_DIMENSIONS: 1111; ``` ### @insiderfinance/totalfinance/math#ScalarFunction Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ScalarFunction = (x: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#SolverFailureReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SolverFailureReason = 'no_sign_change' | 'non_finite_endpoint' | 'non_finite_iteration' | 'zero_derivative' | 'domain_error' | 'max_iterations' | 'stagnation'; ``` ### @insiderfinance/totalfinance/math#SolverOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SolverOptions { /** Tolerance on the bracket width / x-step (alias for `stepTolerance`). */ tolerance?: number; /** Absolute tolerance on the x-step / bracket width. */ stepTolerance?: number; /** Absolute tolerance on |f|. When `f` falls below this, the solve converges early. */ residualTolerance?: number; /** Maximum iterations before reporting non-convergence. */ maximumIterations?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). ### @insiderfinance/totalfinance/math#SolverResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SolverResult { /** Best estimate of the root. May be `NaN` when bracketing failed. */ value: number; /** Whether the method actually converged to the requested tolerance. */ converged: boolean; /** Iterations performed. */ iterations: number; /** Residual |f(value)| at the returned estimate, when finite. */ residual?: number; /** Final bracket `[lo, hi]` for bracketing methods, when one was established. */ bracket?: [ number, number ]; /** Machine-readable failure reason when `converged` is `false`. */ reason?: SolverFailureReason; /** The method that produced this result (e.g. `brent`, `newton`). */ method: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - iterations: number; default: not declared — Iterations performed. - method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#StatisticsOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StatisticsOptions { nanPolicy?: NanPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - nanPolicy?: NanPolicy; default: not declared ### @insiderfinance/totalfinance/math#SvdResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── SVD (one-sided Jacobi) ───────────────────────── export interface SvdResult { /** Left singular vectors as columns (`m × n`, thin). */ u: Matrix; /** Singular values, descending. */ s: number[]; /** Right singular vectors as columns (`n × n`). */ v: Matrix; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - s: number[]; default: not declared — Singular values, descending. - u: Matrix; default: not declared — Left singular vectors as columns (`m × n`, thin). - v: Matrix; default: not declared — Right singular vectors as columns (`n × n`). ### @insiderfinance/totalfinance/math#TestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Uniform result shape for every hypothesis test in this module. ```typescript /** Uniform result shape for every hypothesis test in this module. */ export interface TestResult { /** The test statistic. */ statistic: number; /** Approximate (or, for Ljung–Box, exact) p-value, when defined. */ pValue?: number; /** Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. */ criticalValues?: { '1%': number; '5%': number; '10%': number; }; /** Human-readable identifier of the test and its configuration. */ method: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - criticalValues?: { '1%': number; '10%': number; '5%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - criticalValues.1%: number; default: not declared - criticalValues.10%: number; default: not declared - criticalValues.5%: number; default: not declared - method: string; default: not declared — Human-readable identifier of the test and its configuration. - pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - statistic: number; default: not declared — The test statistic. ### @insiderfinance/totalfinance/math#VarianceOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VarianceOptions extends StatisticsOptions, PopulationOptions { } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - nanPolicy?: NanPolicy; default: not declared - population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). ### @insiderfinance/totalfinance/math#WinsorizeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WinsorizeOptions extends StatisticsOptions { /** Lower tail fraction to clip (default 0.05). */ lower?: number; /** Upper tail fraction to clip (default 0.05). */ upper?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lower?: number; default: not declared — Lower tail fraction to clip (default 0.05). - nanPolicy?: NanPolicy; default: not declared - upper?: number; default: not declared — Upper tail fraction to clip (default 0.05). ### @insiderfinance/totalfinance/math#acf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sample autocorrelation function through `maxLag`, using the biased (÷N) estimator that guarantees a positive-semidefinite sequence. Returns `[1, ρ₁, …, ρ_maxLag]` — index 0 is lag 0 and equals 1 exactly. ```typescript export declare function acf(series: number[], maxLag: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (maxLag): number; default: not declared - (series): number[]; default: not declared ### @insiderfinance/totalfinance/math#adaptiveSimpson Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adaptive Simpson integration of `f` on `[a, b]` to the requested tolerance. Throws `ConvergenceError` (`integration.max_depth`) if the depth budget is exhausted before the tolerance is met — use {@link adaptiveSimpsonSafe} for a soft result with diagnostics. ```typescript export declare function adaptiveSimpson(integrand: ScalarFunction, lowerBound: number, upperBound: number, options?: AdaptiveSimpsonOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (integrand): ScalarFunction; default: not declared - (lowerBound): number; default: not declared - (options)?: AdaptiveSimpsonOptions; default: not declared - (options).maxDepth?: number; default: not declared - (options).maxEvaluations?: number; default: not declared — Maximum integrand evaluations before stopping with `converged: false`. Default 100,000. `maxDepth` bounds the DEPTH of a binary subdivision, so it bounds the work at 2^depth — the default of 50 therefore permits about 10^15 evaluations, which is a budget in name only. This is the bound that actually holds. - (options).tolerance?: number; default: not declared - (upperBound): number; default: not declared ### @insiderfinance/totalfinance/math#adaptiveSimpsonSafe Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adaptive Simpson integration returning diagnostics instead of throwing. The tolerance is HALVED at each recursion level so the total error stays bounded by `tolerance` regardless of how many subintervals are created; depth exhaustion is reported via `converged: false` rather than being indistinguishable from success. ```typescript export declare function adaptiveSimpsonSafe(integrand: ScalarFunction, lowerBound: number, upperBound: number, options?: AdaptiveSimpsonOptions): AdaptiveSimpsonResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (integrand): ScalarFunction; default: not declared - (lowerBound): number; default: not declared - (options)?: AdaptiveSimpsonOptions; default: not declared - (options).maxDepth?: number; default: not declared - (options).maxEvaluations?: number; default: not declared — Maximum integrand evaluations before stopping with `converged: false`. Default 100,000. `maxDepth` bounds the DEPTH of a binary subdivision, so it bounds the work at 2^depth — the default of 50 therefore permits about 10^15 evaluations, which is a budget in name only. This is the bound that actually holds. - (options).tolerance?: number; default: not declared - (upperBound): number; default: not declared - return.converged: boolean; default: not declared — Whether every subinterval met its (halved) tolerance before the depth budget ran out. - return.deepestLevel: number; default: not declared — The deepest recursion level reached (0 = no subdivision). - return.value: number; default: not declared — The integral estimate (best available even when `converged` is false). ### @insiderfinance/totalfinance/math#antitheticSampler Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Wrap a payoff over a standard-normal vector into an antithetic sampler: each path evaluates the payoff at `Z` and `-Z` and averages, reducing variance for monotone payoffs. ```typescript export declare function antitheticSampler(payoff: (normals: number[]) => number, dimensions: number): (randomNumberGenerator: RandomNumberGenerator) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (dimensions): number; default: not declared - (payoff): (normals: number[]) => number; default: not declared ### @insiderfinance/totalfinance/math#augmentedDickeyFullerTest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Augmented Dickey–Fuller test for a unit root. Regresses `Δyₜ` on `y_{t−1}`, a constant (and a trend for `'ct'`), and `lags` lagged differences; the statistic is the t-ratio on `y_{t−1}`. A very negative statistic (below the critical value) rejects the unit-root null in favour of stationarity. ```typescript export declare function augmentedDickeyFullerTest(series: number[], options?: AugmentedDickeyFullerOptions): TestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: AugmentedDickeyFullerOptions; default: not declared - (options).lags?: number; default: not declared — Number of augmenting lagged differences (default 0 ⇒ plain Dickey–Fuller). - (options).regression?: 'c' | 'ct'; default: not declared — Deterministic terms: `'c'` = constant (default), `'ct'` = constant + linear trend. - (series): number[]; default: not declared - return.criticalValues?: { '1%': number; '10%': number; '5%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - return.criticalValues.1%: number; default: not declared - return.criticalValues.10%: number; default: not declared - return.criticalValues.5%: number; default: not declared - return.method: string; default: not declared — Human-readable identifier of the test and its configuration. - return.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - return.statistic: number; default: not declared — The test statistic. ### @insiderfinance/totalfinance/math#bfgs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). BFGS quasi-Newton minimization with a backtracking (Armijo) line search. ```typescript export declare function bfgs(objective: MultivariateFunction, start: number[], options?: MultiMinOptions): MultiMinResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (objective): MultivariateFunction; default: not declared - (options)?: MultiMinOptions; default: not declared - (options).grad?: (point: number[]) => number[]; default: not declared — Analytic gradient; if omitted, a central-difference gradient is used (BFGS only). - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - (start): number[]; default: not declared - return.argMin: number[]; default: not declared - return.converged: boolean; default: not declared - return.evaluations?: number; default: not declared — Objective evaluations performed. - return.iterations: number; default: not declared - return.minimum: number; default: not declared - return.reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - return.seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. ### @insiderfinance/totalfinance/math#bicubicInterp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bicubic interpolation at a single `(x, y)` (see {@link makeBicubicInterpolator}). ```typescript export declare function bicubicInterp(xs: ArrayLike, ys: ArrayLike, z: number[][], x: number, y: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared - (xs): ArrayLike; default: not declared - (y): number; default: not declared - (ys): ArrayLike; default: not declared - (z): number[][]; default: not declared ### @insiderfinance/totalfinance/math#bilinearInterp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bilinear interpolation on a grid. `z[i][j]` is the value at `(xs[i], ys[j])`. Clamps to the grid edges outside the domain. ```typescript export declare function bilinearInterp(xs: ArrayLike, ys: ArrayLike, z: number[][], x: number, y: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared - (xs): ArrayLike; default: not declared - (y): number; default: not declared - (ys): ArrayLike; default: not declared - (z): number[][]; default: not declared ### @insiderfinance/totalfinance/math#bisection Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function bisection(objective: ScalarFunction, a0: number, b0: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a0): number; default: not declared - (b0): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#bivariateNormalCdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cumulative bivariate normal: P(X ≤ a, Y ≤ b) where (X, Y) is standard bivariate normal with correlation `rho ∈ [-1, 1]`. Returns `NaN` if any argument is `NaN` or `|rho| > 1`. ```typescript export declare function bivariateNormalCdf(a: number, b: number, rho: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a): number; default: not declared - (b): number; default: not declared - (rho): number; default: not declared ### @insiderfinance/totalfinance/math#bootstrap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Nonparametric bootstrap: resample `data` with replacement `iterations` times, apply `statistic`, and summarize the distribution of the estimate. Deterministic given `seed`. ```typescript export declare function bootstrap(data: ArrayLike, statistic: (sample: number[]) => number, options: BootstrapOptions): BootstrapResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (data): ArrayLike; default: not declared - (options): BootstrapOptions; default: not declared - (options).iterations?: number; default: not declared — Number of resamples (default 1000). - (options).seed: number; default: not declared — Seed — required so results are reproducible (and echoed back). - (statistic): (sample: number[]) => number; default: not declared - return.confidenceInterval95: [number, number]; default: not declared — 95% percentile confidence interval. - return.estimates: number[]; default: not declared - return.iterations: number; default: not declared - return.mean: number; default: not declared - return.seed: number; default: not declared - return.standardDeviation: number; default: not declared ### @insiderfinance/totalfinance/math#bracketExpand Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Expand an initial interval outward until it brackets a sign change. ```typescript export declare function bracketExpand(objective: ScalarFunction, a0: number, b0: number, options?: BracketExpandOptions): Bracket; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a0): number; default: not declared - (b0): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: BracketExpandOptions; default: not declared - (options).factor?: number; default: not declared — Growth factor per step (default 1.6). - (options).maximumIterations?: number; default: not declared — Maximum expansion steps (default 60). - return.found: boolean; default: not declared - return.iterations: number; default: not declared — Expansion steps taken (so callers like findRoot can report a truthful total iteration count). - return.lowerBound: number; default: not declared - return.objectiveAtLowerBound: number; default: not declared - return.objectiveAtUpperBound: number; default: not declared - return.upperBound: number; default: not declared ### @insiderfinance/totalfinance/math#brent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Brent's method: inverse-quadratic / secant interpolation with a bisection safeguard. The robust default root solver. ```typescript export declare function brent(objective: ScalarFunction, a0: number, b0: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a0): number; default: not declared - (b0): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#brentMin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Brent's method for 1-D minimization (parabolic interpolation with a golden-section safeguard). ```typescript export declare function brentMin(objective: ScalarFunction, a0: number, b0: number, options?: MinOptions): MinResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a0): number; default: not declared - (b0): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: MinOptions; default: not declared - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - return.argMin: number; default: not declared - return.converged: boolean; default: not declared - return.evaluations?: number; default: not declared — Objective evaluations performed (interpretability parity across optimizers). - return.iterations: number; default: not declared - return.minimum: number; default: not declared - return.reason?: 'max_iterations' | 'non_finite'; default: not declared ### @insiderfinance/totalfinance/math#brownianBridge Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Brownian-bridge path construction on a uniform grid of `n` steps of size `stepSize` (a DIMENSIONLESS grid spacing — callers building a unit grid pass `1` and scale later, so this is deliberately not a `*Years` quantity). Consumes `n` standard normals, assigning the most significant (endpoint, then successive midpoints) first — ideal for quasi-Monte Carlo. Returns `W[0..n]` with `W[0] = 0`. ```typescript export declare function brownianBridge(normals: ArrayLike, stepSize: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (normals): ArrayLike; default: not declared - (stepSize): number; default: not declared ### @insiderfinance/totalfinance/math#chiSquare Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The chi-square distribution with `df` degrees of freedom (`df > 0`) — gamma(k = df/2, θ = 2). ```typescript export declare const chiSquare: { readonly cdf: (x: number, degreesOfFreedom: number) => number; readonly inverseCdf: (probability: number, degreesOfFreedom: number) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cdf: (x: number, degreesOfFreedom: number) => number; default: not declared — Cumulative distribution `F(x; k) = P(k/2, x/2)`. For `k = 2` this collapses to the closed form `1 − e^(−x/2)`. - cdf(degreesOfFreedom): number; default: not declared - cdf(x): number; default: not declared - inverseCdf: (probability: number, degreesOfFreedom: number) => number; default: not declared — Quantile (inverse CDF) on `(0, ∞)`. - inverseCdf(degreesOfFreedom): number; default: not declared - inverseCdf(probability): number; default: not declared ### @insiderfinance/totalfinance/math#cholesky Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cholesky factorization: lower-triangular `L` with `A = L Lᵀ`. Throws if `A` is not PD. ```typescript export declare function cholesky(matrix: Matrix): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared ### @insiderfinance/totalfinance/math#choleskySolve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve `A x = b` given the Cholesky factor `L` of `A`. ```typescript export declare function choleskySolve(L: Matrix, b: number[]): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (L): Matrix; default: not declared - (b): number[]; default: not declared ### @insiderfinance/totalfinance/math#controlVariateEstimate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Control-variate adjusted estimate: `E[Y] ≈ Ȳ − c·(X̄ − E[X])`, with `c = cov(Y,X)/var(X)`. `samples` are the target outputs, `controls` the control outputs, `controlMean` the known `E[X]`. ```typescript export declare function controlVariateEstimate(samples: ArrayLike, controls: ArrayLike, controlMean: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (controlMean): number; default: not declared - (controls): ArrayLike; default: not declared - (samples): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#correlatedNormalSampler Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a sampler of correlated standard normals from a covariance/correlation matrix (via Cholesky). ```typescript export declare function correlatedNormalSampler(covarianceOrCorrelation: Matrix): (randomNumberGenerator: RandomNumberGenerator) => number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covarianceOrCorrelation): Matrix; default: not declared ### @insiderfinance/totalfinance/math#correlation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pearson correlation coefficient. Throws on unequal lengths. ```typescript export declare function correlation(xs: ArrayLike, ys: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#covariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Covariance of two equal-length series (sample by default). Throws on unequal lengths. ```typescript export declare function covariance(xs: ArrayLike, ys: ArrayLike, options?: VarianceOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: VarianceOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#covarianceMatrix Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Covariance matrix of a set of equal-length variables (`series[k]` is variable k). ```typescript export declare function covarianceMatrix(series: number[][], options?: PopulationOptions): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: PopulationOptions | undefined; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (series): number[][]; default: not declared ### @insiderfinance/totalfinance/math#determinant Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Determinant via LU; returns 0 for a singular matrix instead of throwing. ```typescript export declare function determinant(matrix: Matrix): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared ### @insiderfinance/totalfinance/math#differentialEvolution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Differential evolution (Storn–Price `rand/1/bin`): a seeded, bound-constrained **global** optimizer for multimodal objectives the local methods (Nelder–Mead/BFGS) get stuck on. Deterministic given the seed; trial vectors are reflected back inside `bounds`. Returns the best member found. ```typescript export declare function differentialEvolution(objective: MultivariateFunction, bounds: ReadonlyArray, options?: DifferentialEvolutionOptions): MultiMinResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bounds): readonly (readonly [number, number])[]; default: not declared - (objective): MultivariateFunction; default: not declared - (options)?: DifferentialEvolutionOptions; default: not declared - (options).crossover?: number; default: not declared — Crossover probability `CR ∈ [0, 1]`. Default 0.9. - (options).maxGenerations?: number; default: not declared — Maximum generations. Default 300. - (options).mutation?: number; default: not declared — Differential weight `F ∈ (0, 2]`. Default 0.8. - (options).populationSize?: number; default: not declared — Population size. Default `max(20, 10·dim)`. - (options).seed?: number; default: not declared — Seed for the deterministic PRNG. Default 0x5eed. - (options).tolerance?: number; default: not declared — Converge when the population's objective spread falls below this. Default 1e-12. - return.argMin: number[]; default: not declared - return.converged: boolean; default: not declared - return.evaluations?: number; default: not declared — Objective evaluations performed. - return.iterations: number; default: not declared - return.minimum: number; default: not declared - return.reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - return.seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. ### @insiderfinance/totalfinance/math#eigen Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Eigenvalues and (for real eigenvalues) eigenvectors of a general real matrix. Eigenvalues come from the Francis QR algorithm ({@link eigenvalues}); each real eigenvalue's eigenvector is recovered by inverse iteration. Complex eigenvalues report a `null` vector in this real-valued interface. ```typescript export declare function eigen(matrix: Matrix): GeneralEigenResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared - return.values: Complex[]; default: not declared — Eigenvalues (real, or complex-conjugate pairs), in real-Schur order. - return.vectors: (number[] | null)[]; default: not declared — Eigenvector for each real eigenvalue (via inverse iteration), aligned to `values`; `null` for complex eigenvalues (their eigenvectors are complex and not returned in this real interface). ### @insiderfinance/totalfinance/math#eigenvalues Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Eigenvalues of a general real matrix via the **Francis double-shift QR** algorithm on its Hessenberg form (the EISPACK/JAMA `hqr2` reduction to real Schur form). Returns real eigenvalues and complex-conjugate pairs. For symmetric matrices prefer {@link jacobiEigen} (which also gives vectors). ```typescript export declare function eigenvalues(matrix: Matrix): Complex[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared ### @insiderfinance/totalfinance/math#engleGranger Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Engle–Granger two-step cointegration test. Step 1 regresses `y` on `x` (with intercept); step 2 runs an ADF test on the residuals. Because the residuals are estimated, the decision uses the residual-based Engle–Granger critical value (≈ −3.34 at 5% for one regressor), not the raw ADF table. ```typescript export declare function engleGranger(dependent: number[], independent: number[]): EngleGrangerResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (dependent): number[]; default: not declared - (independent): number[]; default: not declared - return.alpha: number; default: not declared — Intercept of the cointegrating regression. - return.beta: number; default: not declared — Slope of the cointegrating regression `y = α + β·x + resid`. - return.cointegrated: boolean; default: not declared — `true` when the residual ADF statistic falls below the 5% Engle–Granger critical value. - return.residualAugmentedDickeyFuller: TestResult; default: not declared — ADF test on the regression residuals (the cointegration test statistic). ### @insiderfinance/totalfinance/math#estimateCovariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The covariance-estimation front door: turn a returns matrix into a well-conditioned (usually invertible) covariance and report its **conditioning** so a caller knows whether it is safe to invert. `'sample'` and `'ewma'` are the raw estimators (never altered; flagged + `converged: false` when singular); `'ledoit-wolf'` and `'ridge'` GUARANTEE an SPD result — degenerate/collinear inputs are eigenvalue-floored with a `math.covariance_floored` warning rather than returned singular; `'auto'` (default) uses the sample when it is SPD and well-conditioned, else shrinks (inheriting the SPD guarantee). `series[k]` is variable k's observations (p × T), matching {@link covarianceMatrix}. See `docs/specs/estimate-covariance.md`. ```typescript export declare function estimateCovariance(series: number[][], options?: EstimateCovarianceOptions): CovarianceEstimate; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: EstimateCovarianceOptions; default: not declared - (options).conditionThreshold?: number; default: not declared — Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. - (options).halfLife?: number; default: not declared — EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. - (options).lambda?: number; default: not declared — EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). - (options).ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` (the market-model target, best-specified for stock returns). - (options).market?: ArrayLike; default: not declared — Observed market return series for the `'single-index'` target (length `T`). Omitted → the equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. - (options).method?: CovarianceMethod; default: not declared — Estimator; default `'auto'`. - (options).population?: boolean; default: not declared — Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). - (options).ridge?: number; default: not declared — Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. - (series): number[][]; default: not declared - return.assumptions: { conventionsVersion: string; marketProxy?: 'observed-series' | 'equal-weight'; method: string; population: boolean; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.marketProxy?: 'observed-series' | 'equal-weight'; default: not declared — Single-index target only: the caller's observed market series vs the equal-weight proxy. - return.assumptions.method: string; default: not declared - return.assumptions.population: boolean; default: not declared - return.conditionNumber: number; default: not declared — `maxEigenvalue / minEigenvalue` (`Infinity` when singular). - return.covariance: Matrix; default: not declared — The estimated covariance. - return.diagnostics: Diagnostics; default: not declared - return.effectiveObservations?: number; default: not declared — Kish effective sample size `1/Σwₜ²` — present only for method `'ewma'`. - return.effectiveRank: number; default: not declared — Number of eigenvalues `> 1e-9 · maxEigenvalue` — the effective rank. - return.isPositiveDefinite: boolean; default: not declared — Whether the returned covariance is positive-definite (invertible). - return.lambda?: number; default: not declared — The EWMA decay used — present only for method `'ewma'`. - return.maxEigenvalue: number; default: not declared — Largest eigenvalue of the returned covariance. - return.method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; default: not declared — The estimator actually used (`'auto'` resolves to one of these). - return.minEigenvalue: number; default: not declared — Smallest eigenvalue of the returned covariance. - return.observations: number; default: not declared — Number of observations `T`. - return.shrinkage?: number; default: not declared — Ledoit–Wolf shrinkage intensity, present when `method` is `'ledoit-wolf'`. - return.variables: number; default: not declared — Number of variables `p`. ### @insiderfinance/totalfinance/math#findRoot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Safe hybrid solver: expand a bracket if needed, then run Brent. Kept as a named entrypoint so callers express intent ("give me the robust default"). ```typescript export declare function findRoot(objective: ScalarFunction, lowerBound: number, upperBound: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (lowerBound): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: SolverOptions | undefined; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - (upperBound): number; default: not declared - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#gamma Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The gamma distribution with shape `k > 0` and scale `θ > 0` (default `θ = 1`). ```typescript export declare const gamma: { readonly cdf: (x: number, shape: number, theta?: number) => number; readonly inverseCdf: (probability: number, shape: number, theta?: number) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cdf: (x: number, shape: number, theta?: number) => number; default: not declared — Cumulative distribution `F(x; k, θ) = P(k, x/θ)`. For `k = 1` this is the exponential CDF `1 − e^(−x/θ)`. - cdf(shape): number; default: not declared - cdf(theta)?: number; default: not declared - cdf(x): number; default: not declared - inverseCdf: (probability: number, shape: number, theta?: number) => number; default: not declared — Quantile (inverse CDF) on `(0, ∞)`. - inverseCdf(probability): number; default: not declared - inverseCdf(shape): number; default: not declared - inverseCdf(theta)?: number; default: not declared ### @insiderfinance/totalfinance/math#gaussLegendre Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gauss–Legendre integration of `f` on `[a, b]` using `n` points (default 10). ```typescript export declare function gaussLegendre(integrand: ScalarFunction, lowerBound: number, upperBound: number, nodeCount?: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (integrand): ScalarFunction; default: not declared - (lowerBound): number; default: not declared - (nodeCount)?: number; default: not declared - (upperBound): number; default: not declared ### @insiderfinance/totalfinance/math#gaussLegendreNodes Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gauss–Legendre nodes and weights on `[-1, 1]` for `n` points, as a FRESH pair of arrays. The rule is computed once per order and memoized, but the cached arrays are never handed out: a caller who scaled the returned nodes in place (the obvious way to map them onto `[a, b]`) used to corrupt the shared cache, and every later integral at that order — anywhere in the process — silently integrated against the mutated rule. A copy per call costs `2n` doubles; the alternative is a global that any caller can poison. ```typescript export declare function gaussLegendreNodes(nodeCount: number): Quadrature; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (nodeCount): number; default: not declared - return.nodes: number[]; default: not declared - return.weights: number[]; default: not declared ### @insiderfinance/totalfinance/math#goldenSectionMin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function goldenSectionMin(objective: ScalarFunction, lowerBound: number, upperBound: number, options?: MinOptions): MinResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (lowerBound): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: MinOptions; default: not declared - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - (upperBound): number; default: not declared - return.argMin: number; default: not declared - return.converged: boolean; default: not declared - return.evaluations?: number; default: not declared — Objective evaluations performed (interpretability parity across optimizers). - return.iterations: number; default: not declared - return.minimum: number; default: not declared - return.reason?: 'max_iterations' | 'non_finite'; default: not declared ### @insiderfinance/totalfinance/math#halley Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Halley's method (cubic convergence). `objective` returns `{ f, df, d2f }`. ```typescript export declare function halley(objective: FunctionWithDerivatives, x0: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (objective): FunctionWithDerivatives; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - (x0): number; default: not declared - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#haltonPoint Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Halton point at `index` in `dimensions` dimensions. ```typescript export declare function haltonPoint(index: number, dimensions: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (dimensions): number; default: not declared - (index): number; default: not declared ### @insiderfinance/totalfinance/math#haltonSequence Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Halton sequence of `n` points in `dimensions` dimensions, starting at `start` (default 1, skips origin). ```typescript export declare function haltonSequence(count: number, dimensions: number, options?: { start?: number; }): number[][]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (count): number; default: not declared - (dimensions): number; default: not declared - (options)?: { start?: number; }; default: not declared - (options).start?: number; default: not declared ### @insiderfinance/totalfinance/math#householder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Householder's method of order 3 (quartic convergence). `objective` returns `{ f, df, d2f, d3f }`. ```typescript export declare function householder(objective: FunctionWithDerivatives, x0: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (objective): FunctionWithDerivatives; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - (x0): number; default: not declared - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#hurstExponent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Hurst exponent via rescaled-range (R/S) analysis. For a geometric progression of window sizes the mean rescaled range `⟨R/S⟩ₙ` scales as `nᴴ`; `H` is the slope of `log⟨R/S⟩` on `log n`. R/S is computed on the input series AS GIVEN, so the usual reading — `H ≈ 0.5` random walk, `H > 0.5` persistence/trending, `H < 0.5` mean reversion — assumes an INCREMENT (returns) series. Passing an integrated level series (e.g. a price path) instead yields `H ≈ 1`. BIAS CAVEAT — read this before calling 0.55 "persistence". This is PLAIN R/S with no Anis–Lloyd (1976) small-sample correction, and plain R/S is biased UPWARD at every finite sample size: for independent data `E[R/S]ₙ` is not `n^0.5`, so the slope is not 0.5 either. Measured on this implementation over 20 seeds of iid normal input (mean, and the spread across seeds): - `n = 512` → `H ≈ 0.565` (0.52 … 0.65) - `n = 4096` → `H ≈ 0.538` (0.48 … 0.59) - `n = 32768` → `H ≈ 0.534` (0.51 … 0.56) The bias shrinks with `n` but is still ~0.03 at 32k points, and the seed-to-seed spread is wider than the bias itself. So a lone `H = 0.55` on 4k observations is evidence of NOTHING. Compare against a shuffled (or synthetic iid) version of your own series at the SAME length rather than against the textbook 0.5, or use a corrected estimator. The ORDERING (anti-persistent < iid < persistent, as the test suite asserts) is reliable; the absolute level is not. ```typescript export declare function hurstExponent(series: number[]): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (series): number[]; default: not declared ### @insiderfinance/totalfinance/math#identity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `n × n` identity matrix. ```typescript export declare function identity(size: number): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (size): number; default: not declared ### @insiderfinance/totalfinance/math#jacobiEigen Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Symmetric eigendecomposition via cyclic Jacobi rotations. The tolerance is RELATIVE to the input's off-diagonal Frobenius norm, so a matrix scaled by any constant converges identically (an absolute tolerance would spin to `maximumIterations` on a large-scaled covariance matrix). Throws `ConvergenceError` (`linalg.no_convergence`) if the sweeps do not reach the tolerance within `maximumIterations`. The input must be SQUARE and finite. It used to be neither checked nor needed: every loop is indexed by `input.length`, so a `2×3` matrix quietly returned the eigenvalues of its leading `2×2` block — the right shape, the wrong matrix, and no way for the caller to tell. (Non-symmetric square input is still accepted and still reports non-convergence through `ConvergenceError` when the rotations cannot diagonalize it; use {@link eigenvalues} for the general case.) ```typescript export declare function jacobiEigen(input: Matrix, options?: { maximumIterations?: number; tolerance?: number; }): EigenResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Matrix; default: not declared - (options)?: { maximumIterations?: number; tolerance?: number; }; default: not declared - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - return.values: number[]; default: not declared — Eigenvalues (not sorted). - return.vectors: Matrix; default: not declared — Eigenvectors as columns of the matrix. ### @insiderfinance/totalfinance/math#kalmanFilter Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run the forward Kalman recursion over `observations`. Each step predicts `xₜ|ₜ₋₁` from the previous filtered state, then (when the observation is present) updates to `xₜ|ₜ` and accumulates the Gaussian log-likelihood. Missing observations predict only. ```typescript export declare function kalmanFilter(model: KalmanModel, observations: KalmanObservation[]): KalmanFilterResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (model): KalmanModel; default: not declared - (model).F: Matrix; default: not declared — State-transition matrix `F`, `n × n`. - (model).H: Matrix; default: not declared — Observation matrix `H`, `m × n`. - (model).P0: Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - (model).Q: Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - (model).R: Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - (model).x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. - (observations): KalmanObservation[]; default: not declared - return.filteredCovariances: Matrix[]; default: not declared — Filtered state covariances `Pₜ|ₜ`. - return.filteredStates: number[][]; default: not declared — Filtered state means `x̂ₜ|ₜ` (`T × n`). - return.innovationCovariances: (Matrix | null)[]; default: not declared — Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). - return.innovations: (number[] | null)[]; default: not declared — Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). - return.logLikelihood: number; default: not declared — Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. - return.observationDimension: number; default: not declared — Observation dimension. - return.observedCount: number; default: not declared — Number of steps that contributed to the likelihood (observed steps). - return.predictedCovariances: Matrix[]; default: not declared — One-step predicted state covariances `Pₜ|ₜ₋₁`. - return.predictedStates: number[][]; default: not declared — One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). - return.stateDimension: number; default: not declared — State dimension. ### @insiderfinance/totalfinance/math#kalmanLogLikelihood Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Gaussian log-likelihood of `observations` under `model` — the innovation-form likelihood from the forward pass. This is the objective to maximise when calibrating `{ F, H, Q, R }` (e.g. by a Nelder–Mead search over a parameterisation of the system matrices). ```typescript export declare function kalmanLogLikelihood(model: KalmanModel, observations: KalmanObservation[]): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (model): KalmanModel; default: not declared - (model).F: Matrix; default: not declared — State-transition matrix `F`, `n × n`. - (model).H: Matrix; default: not declared — Observation matrix `H`, `m × n`. - (model).P0: Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - (model).Q: Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - (model).R: Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - (model).x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. - (observations): KalmanObservation[]; default: not declared ### @insiderfinance/totalfinance/math#kalmanSmooth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rauch–Tung–Striebel fixed-interval smoother. Runs the forward filter, then a backward pass giving `xₜ|T` / `Pₜ|T` — the state estimates conditioned on the WHOLE sample, always at least as sharp as the filtered estimates. The backward gain is `Cₜ = Pₜ|ₜ·Fᵀ·(Pₜ₊₁|ₜ)⁻¹`, solved through the Cholesky factor of the predicted covariance — or, when that covariance is singular because the model has a deterministic component, through its pseudoinverse (see {@link rtsGain}). ```typescript export declare function kalmanSmooth(model: KalmanModel, observations: KalmanObservation[]): KalmanSmoothResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (model): KalmanModel; default: not declared - (model).F: Matrix; default: not declared — State-transition matrix `F`, `n × n`. - (model).H: Matrix; default: not declared — Observation matrix `H`, `m × n`. - (model).P0: Matrix; default: not declared — Prior state covariance `P₀`, `n × n` (symmetric PSD). - (model).Q: Matrix; default: not declared — Process-noise covariance `Q`, `n × n` (symmetric PSD). - (model).R: Matrix; default: not declared — Observation-noise covariance `R`, `m × m` (symmetric PD). - (model).x0: number[]; default: not declared — Prior state mean `x₀`, length `n`. - (observations): KalmanObservation[]; default: not declared - return.filteredCovariances: Matrix[]; default: not declared — Filtered state covariances `Pₜ|ₜ`. - return.filteredStates: number[][]; default: not declared — Filtered state means `x̂ₜ|ₜ` (`T × n`). - return.innovationCovariances: (Matrix | null)[]; default: not declared — Innovation covariances `Sₜ = H·Pₜ|ₜ₋₁·Hᵀ + R` (`null` at missing steps). - return.innovations: (number[] | null)[]; default: not declared — Innovations `zₜ − H·x̂ₜ|ₜ₋₁` (`null` at missing-observation steps). - return.logLikelihood: number; default: not declared — Gaussian log-likelihood `Σₜ log N(zₜ; H·x̂ₜ|ₜ₋₁, Sₜ)`, summed over OBSERVED steps only. - return.observationDimension: number; default: not declared — Observation dimension. - return.observedCount: number; default: not declared — Number of steps that contributed to the likelihood (observed steps). - return.predictedCovariances: Matrix[]; default: not declared — One-step predicted state covariances `Pₜ|ₜ₋₁`. - return.predictedStates: number[][]; default: not declared — One-step predicted state means `x̂ₜ|ₜ₋₁` (`T × n`). - return.smoothedCovariances: Matrix[]; default: not declared — Smoothed state covariances `Pₜ|T`. - return.smoothedStates: number[][]; default: not declared — Smoothed state means `x̂ₜ|T` using all `T` observations (`T × n`). - return.stateDimension: number; default: not declared — State dimension. ### @insiderfinance/totalfinance/math#kpssTest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Kwiatkowski–Phillips–Schmidt–Shin (KPSS) stationarity test. The null is (level or trend) stationarity, so a LARGE statistic (above the critical value) rejects stationarity — the mirror image of ADF. The bandwidth for the long-run variance defaults to `⌊4·(T/100)^¼⌋`. ```typescript export declare function kpssTest(series: number[], options?: KpssOptions): TestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: KpssOptions; default: not declared - (options).regression?: 'c' | 'ct'; default: not declared — `'c'` = level stationarity (default), `'ct'` = trend stationarity. - (series): number[]; default: not declared - return.criticalValues?: { '1%': number; '10%': number; '5%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - return.criticalValues.1%: number; default: not declared - return.criticalValues.10%: number; default: not declared - return.criticalValues.5%: number; default: not declared - return.method: string; default: not declared — Human-readable identifier of the test and its configuration. - return.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - return.statistic: number; default: not declared — The test statistic. ### @insiderfinance/totalfinance/math#kurtosis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Population kurtosis; excess (−3) by default. ```typescript export declare function kurtosis(xs: ArrayLike, options?: KurtosisOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: KurtosisOptions | undefined; default: not declared - (options).excess?: boolean; default: not declared — Return excess kurtosis (subtract 3). Default `true`. - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#ledoitWolfShrinkage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function ledoitWolfShrinkage(series: number[][], options?: LedoitWolfOptions): LedoitWolfResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: LedoitWolfOptions; default: not declared - (options).market?: ArrayLike; default: not declared — Observed market return series (length `T`, chronological) for the `'single-index'` target. When omitted the equal-weight cross-sectional average of `series` is used as the market proxy (Ledoit–Wolf 2003's construction); {@link estimateCovariance} discloses which was used. - (options).target?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Shrinkage target: `'identity'` (the scaled identity `μI`, the default and original), `'constant-correlation'` (the Ledoit–Wolf 2004 target — each variable's own variance with the **average** sample correlation on every off-diagonal, which fits correlated asset returns far better), or `'single-index'` (the Ledoit–Wolf 2003 market-model target — a one-factor structure built from each variable's covariance with the equal-weighted market, the best-specified target for stock returns). - (series): number[][]; default: not declared - return.averageCorrelation?: number; default: not declared — Average off-diagonal sample correlation `r̄` — the constant-correlation target's correlation (that target only). - return.averageVariance: number; default: not declared — Average variance `μ = tr(S)/p` — the scaled-identity target's diagonal. - return.covariance: Matrix; default: not declared — Shrunk covariance `Σ* = δ·F + (1−δ)·S` (`F` = the chosen target) — symmetric positive-definite even when `T < p`. - return.marketVariance?: number; default: not declared — Variance of the equal-weighted market proxy `varmkt` — the single-index target's factor variance (that target only). - return.observations: number; default: not declared — Number of observations `T`. - return.sampleCovariance: Matrix; default: not declared — Raw sample covariance `S` (`1/T` / MLE normalization). - return.shrinkage: number; default: not declared — Optimal shrinkage intensity `δ ∈ [0, 1]`. - return.target: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — The shrinkage target used. ### @insiderfinance/totalfinance/math#levenbergMarquardt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Levenberg–Marquardt least-squares minimization of `||residuals(parameters)||²`. ```typescript export declare function levenbergMarquardt(residuals: (p: number[]) => number[], p0: number[], options?: LMOptions): LevenbergMarquardtResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: LMOptions; default: not declared - (options).lambda0?: number; default: not declared - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - (p0): number[]; default: not declared - (residuals): (p: number[]) => number[]; default: not declared - return.converged: boolean; default: not declared - return.evaluations?: number; default: not declared — Residual-vector evaluations performed (interpretability parity with the other optimizers). - return.iterations: number; default: not declared - return.parameters: number[]; default: not declared - return.reason?: 'max_iterations'; default: not declared - return.residualNorm: number; default: not declared ### @insiderfinance/totalfinance/math#lgamma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Natural log of the gamma function, `ln Γ(x)`, via the Lanczos approximation (g = 7, 9 coefficients), accurate to ~1e-15 for `x > 0`. Uses the reflection formula `Γ(x)Γ(1−x) = π / sin(πx)` for `x < 0.5`. ```typescript export declare function lgamma(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#linearInterp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Interpolate `y` at `x` over the points `(xs[i], ys[i])`. TRUSTED FAST PATH: `xs` MUST be strictly ascending and the same length as `ys` — this function does not validate (it binary-searches and assumes order), so out-of-order input yields nonsense. For validated, axis-checked construction use {@link makePchipInterpolator} / {@link makeNaturalCubicSpline} (or call {@link validateInterpolationData} first). ```typescript export declare function linearInterp(xs: ArrayLike, ys: ArrayLike, x: number, options?: InterpolateOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: InterpolateOptions; default: not declared - (options).extrapolate?: ExtrapolationPolicy; default: not declared - (x): number; default: not declared - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#ljungBox Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ljung–Box portmanteau test for autocorrelation up to `lags`: `Q = N(N+2) Σ_{k=1}^{h} ρ̂ₖ² / (N−k)`, distributed `χ²(h)` under the white-noise null. The p-value is the exact chi-square survival function. On ARMA RESIDUALS the white-noise null is the wrong reference: fitting `p + q` parameters to the same data absorbs autocorrelation the statistic then fails to see, so `χ²(h)` is too conservative and the test under-rejects. Pass `fittedParameterCount` to use the standard corrected reference `χ²(h − p − q)` (Box–Jenkins); the returned `method` discloses the degrees of freedom actually used. The statistic itself is unchanged — only the reference distribution moves. ```typescript export declare function ljungBox(series: number[], lags: number, options?: LjungBoxOptions): TestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (lags): number; default: not declared - (options)?: LjungBoxOptions; default: not declared - (options).fittedParameterCount?: number; default: not declared — Number of parameters ESTIMATED from the same series before the test (e.g. `p + q` for the residuals of an ARMA(p, q) fit). The reference distribution loses one degree of freedom per fitted parameter: `Q ~ χ²(lags − fittedParameterCount)`. Default 0 — the raw white-noise null, which is the right reference only for a series that was NOT fitted. - (series): number[]; default: not declared - return.criticalValues?: { '1%': number; '10%': number; '5%': number; }; default: not declared — Asymptotic critical values at the 1% / 5% / 10% levels, when the test tabulates them. - return.criticalValues.1%: number; default: not declared - return.criticalValues.10%: number; default: not declared - return.criticalValues.5%: number; default: not declared - return.method: string; default: not declared — Human-readable identifier of the test and its configuration. - return.pValue?: number; default: not declared — Approximate (or, for Ljung–Box, exact) p-value, when defined. - return.statistic: number; default: not declared — The test statistic. ### @insiderfinance/totalfinance/math#luDecompose Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). LU decomposition with partial pivoting: `P·A = L·U`. Throws on a singular matrix. ```typescript export declare function luDecompose(matrix: Matrix): LuResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared - return.lu: Matrix; default: not declared — Combined lower/upper factors (unit-diagonal `L` below, `U` on and above the diagonal). - return.pivotIndices: number[]; default: not declared — Row permutation: `pivotIndices[i]` is the source row moved into row `i`. - return.sign: number; default: not declared — Sign of the permutation (+1 or −1), for the determinant. ### @insiderfinance/totalfinance/math#luSolve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve `A·x = b` from a precomputed {@link luDecompose} result. ```typescript export declare function luSolve(result: LuResult, b: number[]): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (b): number[]; default: not declared - (result): LuResult; default: not declared - (result).lu: Matrix; default: not declared — Combined lower/upper factors (unit-diagonal `L` below, `U` on and above the diagonal). - (result).pivotIndices: number[]; default: not declared — Row permutation: `pivotIndices[i]` is the source row moved into row `i`. - (result).sign: number; default: not declared — Sign of the permutation (+1 or −1), for the determinant. ### @insiderfinance/totalfinance/math#makeBicubicInterpolator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a reusable **bicubic** interpolator over a regular grid `z[i][j] = f(xs[i], ys[j])` — a smooth tensor-product natural cubic spline (C² in both axes). One x-spline is precomputed per y-column; each query splines those column values along y. Smoother than {@link bilinearInterp} for vol/price surfaces. Both axes must be strictly increasing and `z` must be `xs.length × ys.length`; both are CHECKED once here, at construction. ```typescript export declare function makeBicubicInterpolator(xs: ArrayLike, ys: ArrayLike, z: number[][]): (x: number, y: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared - (z): number[][]; default: not declared ### @insiderfinance/totalfinance/math#makeLinearInterpolator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a reusable linear interpolator over fixed points (validates the axis by default). ```typescript export declare function makeLinearInterpolator(xs: ArrayLike, ys: ArrayLike, options?: InterpolateOptions & AxisOptions): (x: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: (InterpolateOptions & AxisOptions) | undefined; default: not declared - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#makeNaturalCubicSpline Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a natural cubic spline interpolator (second derivative zero at both ends). ```typescript export declare function makeNaturalCubicSpline(xs: ArrayLike, ys: ArrayLike, options?: AxisOptions): (x: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: AxisOptions; default: not declared - (options).aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - (options).assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - (options).extrapolate?: ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#makePchipInterpolator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a PCHIP (monotone cubic Hermite) interpolator — shape-preserving, no overshoot. ```typescript export declare function makePchipInterpolator(xs: ArrayLike, ys: ArrayLike, options?: AxisOptions): (x: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: AxisOptions; default: not declared - (options).aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - (options).assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - (options).extrapolate?: ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#matrixMultiply Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Matrix product `A (m×k) · B (k×n)` → `m×n`. Throws on a dimension mismatch. ```typescript export declare function matrixMultiply(left: Matrix, right: Matrix): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (left): Matrix; default: not declared - (right): Matrix; default: not declared ### @insiderfinance/totalfinance/math#matrixVectorProduct Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Matrix–vector product `A (m×n) · x (n)` → `m`. ```typescript export declare function matrixVectorProduct(matrix: Matrix, vector: number[]): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared - (vector): number[]; default: not declared ### @insiderfinance/totalfinance/math#max Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function max(xs: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#mean Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function mean(xs: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#median Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function median(xs: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#medianAbsoluteDeviation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Median absolute deviation. ```typescript export declare function medianAbsoluteDeviation(xs: ArrayLike, options?: MedianAbsoluteDeviationOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: MedianAbsoluteDeviationOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (options).scale?: boolean; default: not declared — Scale by 1.4826 for consistency with the normal stddev (default `true`). - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#min Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function min(xs: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#monteCarlo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function monteCarlo(sampler: (randomNumberGenerator: RandomNumberGenerator) => number, options: MonteCarloOptions): MonteCarloResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): MonteCarloOptions; default: not declared - (options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - (options).minPaths?: number; default: not declared — Minimum paths before the stopping rule applies (default 1000). - (options).paths?: number; default: not declared — Maximum paths (default 100_000). - (options).randomNumberGenerator?: (seed: number) => RandomNumberGenerator; default: not declared — RNG factory (default mulberry32). - (options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - (options).targetStandardError?: number; default: not declared — Stop once the standard error falls to/below this (after `minPaths`). - (sampler): (randomNumberGenerator: RandomNumberGenerator) => number; default: not declared - return.confidenceInterval: [number, number]; default: not declared — Confidence interval at the requested level (default 95%). - return.converged: boolean; default: not declared — Whether the target standard error was reached (always true when no target is set). - return.paths: number; default: not declared - return.seed: number; default: not declared - return.standardError: number; default: not declared - return.value: number; default: not declared - return.variance: number; default: not declared ### @insiderfinance/totalfinance/math#mulberry32 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Mulberry32 — a small, fast, well-distributed seedable PRNG. The state is seeded with `seed >>> 0` (the algorithm is 32-bit), but the ECHOED `seed` is the caller's literal argument: a run seeded with `-1` is reproduced by passing `-1`, and reporting `4294967295` back would send a reader looking for a seed they never used. ```typescript export declare function mulberry32(seed: number): RandomNumberGenerator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (seed): number; default: not declared - return.getState: () => RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - return.next: () => number; default: not declared — Uniform sample in [0, 1). - return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). ### @insiderfinance/totalfinance/math#nearestCorrelation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A valid correlation matrix near `matrix`: ONE eigenvalue-clipping pass to PSD ({@link nearestPsd}), then a rescale to a unit diagonal. Not the Frobenius-NEAREST correlation matrix. That is Higham's (2002) alternating-projections problem, iterated to convergence between the PSD cone and the unit-diagonal set; the rescale here is a single projection that can push the result slightly off the PSD cone again (the output is PSD to within the rescale, not by construction). It is the standard cheap repair — good enough to make a noisy correlation estimate usable for Cholesky/simulation — and it is deterministic and O(n³), but a caller who needs the true minimizer needs Higham's iteration, not this. ```typescript export declare function nearestCorrelation(matrix: Matrix): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared ### @insiderfinance/totalfinance/math#nearestPsd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Nearest positive-semidefinite matrix (eigenvalue clipping). ```typescript export declare function nearestPsd(matrix: Matrix): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared ### @insiderfinance/totalfinance/math#nelderMead Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Nelder–Mead simplex minimization (derivative-free). ```typescript export declare function nelderMead(objective: MultivariateFunction, start: number[], options?: MultiMinOptions): MultiMinResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (objective): MultivariateFunction; default: not declared - (options)?: MultiMinOptions; default: not declared - (options).grad?: (point: number[]) => number[]; default: not declared — Analytic gradient; if omitted, a central-difference gradient is used (BFGS only). - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - (start): number[]; default: not declared - return.argMin: number[]; default: not declared - return.converged: boolean; default: not declared - return.evaluations?: number; default: not declared — Objective evaluations performed. - return.iterations: number; default: not declared - return.minimum: number; default: not declared - return.reason?: 'max_iterations' | 'non_finite' | 'line_search_failed'; default: not declared - return.seed?: number; default: not declared — Seeded global optimizers (differential evolution) echo the PRNG seed actually used. ### @insiderfinance/totalfinance/math#newton Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Newton–Raphson. `objective` returns `{ f, df }`. ```typescript export declare function newton(objective: FunctionWithDerivatives, x0: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (objective): FunctionWithDerivatives; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - (x0): number; default: not declared - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#normal Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convenience namespace mirroring the spec's `normal.pdf/cdf/inverseCdf` facade. ```typescript export declare const normal: { readonly cdf: (x: number) => number; readonly inverseCdf: (probability: number) => number; readonly logCdf: (x: number) => number; readonly logPdf: (x: number) => number; readonly logSurvivalFunction: (x: number) => number; readonly pdf: (x: number) => number; readonly survivalFunction: (x: number) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cdf: (x: number) => number; default: not declared - cdf(x): number; default: not declared - inverseCdf: (probability: number) => number; default: not declared - inverseCdf(probability): number; default: not declared - logCdf: (x: number) => number; default: not declared - logCdf(x): number; default: not declared - logPdf: (x: number) => number; default: not declared - logPdf(x): number; default: not declared - logSurvivalFunction: (x: number) => number; default: not declared - logSurvivalFunction(x): number; default: not declared - pdf: (x: number) => number; default: not declared - pdf(x): number; default: not declared - survivalFunction: (x: number) => number; default: not declared - survivalFunction(x): number; default: not declared ### @insiderfinance/totalfinance/math#normalCdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Standard normal cumulative distribution function Φ(x). ```typescript export declare function normalCdf(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#normalInverseCdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inverse standard normal CDF (quantile function). Returns `-Infinity` at p<=0 and `+Infinity` at p>=1. ```typescript export declare function normalInverseCdf(probability: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (probability): number; default: not declared ### @insiderfinance/totalfinance/math#normalLogCdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Log of the standard normal CDF, stable into the far-left tail (where Φ(x) underflows to 0). Uses `log(Φ(x))` for `x ≥ -20` and the asymptotic expansion `Φ(x) = φ(x)/(-x)·(1 − 1/x² + 3/x⁴ − 15/x⁶ + …)` below that. ```typescript export declare function normalLogCdf(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#normalLogPdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Log of the standard normal PDF — exact and stable everywhere. ```typescript export declare function normalLogPdf(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#normalLogSurvivalFunction Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Log of the standard normal survival function (stable in the far-right tail). ```typescript export declare function normalLogSurvivalFunction(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#normalPdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Standard normal probability density function φ(x). ```typescript export declare function normalPdf(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#normalSample Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function normalSample(randomNumberGenerator: RandomNumberGenerator, mu?: number, sigma?: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (mu)?: number; default: not declared - (randomNumberGenerator): RandomNumberGenerator; default: not declared - (randomNumberGenerator).getState: () => RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - (randomNumberGenerator).next: () => number; default: not declared — Uniform sample in [0, 1). - (randomNumberGenerator).seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). - (sigma)?: number; default: not declared ### @insiderfinance/totalfinance/math#normalSurvivalFunction Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Standard normal survival function: 1 − Φ(x) = Φ(−x) (stable in the right tail). ```typescript export declare function normalSurvivalFunction(x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): number; default: not declared ### @insiderfinance/totalfinance/math#ols Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ordinary least squares fit of `y` on `X` (rows = observations, columns = predictors, no intercept column). Returns coefficients, standard errors, t-statistics, `R²`/`R̄²`, and residuals. ```typescript export declare function ols(response: number[], design: number[][], options?: OlsOptions): OlsResult; ``` @param: y Response vector, length `n`. @param: X Design rows, `n × p` (predictors only; the intercept is added unless disabled). @param: options.intercept Prepend an intercept column (default `true`). @param: options.hac Newey–West HAC standard errors with a Bartlett kernel of the given bandwidth. Members/parameters (default = JSDoc only; not declared means no documented default): - (design): number[][]; default: not declared - (options)?: OlsOptions; default: not declared - (options).hac?: OlsHacOptions; default: not declared — Replace the classical covariance with the Newey–West HAC estimator. - (options).intercept?: boolean; default: not declared — Prepend an intercept column of ones (default `true`). - (response): number[]; default: not declared - return.adjustedRSquared: number; default: not declared — Degrees-of-freedom-adjusted `R̄²`. - return.coefficientCount: number; default: not declared — Number of estimated coefficients (including the intercept). - return.coefficients: number[]; default: not declared — Fitted coefficients; the intercept is first when `intercept !== false`. - return.observationCount: number; default: not declared — Number of observations. - return.rSquared: number; default: not declared — Coefficient of determination `R²` (centered when an intercept is present). - return.residuals: number[]; default: not declared — Residuals `y − Xβ`, aligned to the input rows. - return.standardErrors: number[]; default: not declared — Standard error of each coefficient (√ of the covariance diagonal). - return.tStatistics: number[]; default: not declared — t-statistic `βⱼ / se(βⱼ)` for each coefficient. ### @insiderfinance/totalfinance/math#ouHalfLife Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Half-life of mean reversion from an AR(1) fit `xₜ = a + b·x_{t−1} + εₜ`: `halfLife = −ln 2 / ln b`. Defined (positive) only for a mean-reverting series with `0 < b < 1`; returns `NaN` when `b ≤ 0` and a non-positive value when `b ≥ 1` (no reversion), by construction. ```typescript export declare function ouHalfLife(series: number[]): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (series): number[]; default: not declared ### @insiderfinance/totalfinance/math#pacf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Partial autocorrelation function through `maxLag` via the Durbin–Levinson recursion on the sample ACF. Returns `[1, φ₁₁, …, φ_maxLag,maxLag]` (index 0 = 1 by convention). ```typescript export declare function pacf(series: number[], maxLag: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (maxLag): number; default: not declared - (series): number[]; default: not declared ### @insiderfinance/totalfinance/math#pseudoInverse Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Moore–Penrose pseudoinverse `A⁺` via SVD (singular values below `rcond·σ_max` are dropped). ```typescript export declare function pseudoInverse(matrix: Matrix, options?: { rcond?: number; }): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared - (options)?: { rcond?: number; }; default: not declared - (options).rcond?: number; default: not declared ### @insiderfinance/totalfinance/math#qrDecompose Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Householder QR of an `m × n` matrix (`m ≥ n`): `A = Q·R`, `Q` thin with orthonormal columns. ```typescript export declare function qrDecompose(matrix: Matrix): QrResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared - return.q: Matrix; default: not declared — Orthonormal `Q` (`m × n`, thin). - return.r: Matrix; default: not declared — Upper-triangular `R` (`n × n`). ### @insiderfinance/totalfinance/math#qrSolve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Least-squares solve of `A·x ≈ b` (`m ≥ n`) via QR back-substitution. Rejects a rank-deficient (numerically singular) system rather than silently returning zeroed or blown-up coefficients: if the smallest `|Rᵢᵢ|` pivot falls below `rcond × max|Rᵢᵢ|`, the columns of `A` are collinear and the least-squares solution is not well defined (design law #4 — no silent garbage). Raise `rcond` to reject more aggressively; lower it to admit borderline-conditioned fits. ```typescript export declare function qrSolve(matrix: Matrix, b: number[], options?: { rcond?: number; }): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (b): number[]; default: not declared - (matrix): Matrix; default: not declared - (options)?: { rcond?: number; }; default: not declared - (options).rcond?: number; default: not declared ### @insiderfinance/totalfinance/math#quantile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Quantile via the type-7 (linear interpolation of order statistics) method — the default used by NumPy and R. `p` is in [0, 1]. ```typescript export declare function quantile(xs: ArrayLike, probability: number, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (probability): number; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#regularizedBeta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Regularized incomplete beta `Iₓ(a, b)` — exported primitive behind the Student-t CDF. ```typescript export declare function regularizedBeta(a: number, b: number, x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a): number; default: not declared - (b): number; default: not declared - (x): number; default: not declared ### @insiderfinance/totalfinance/math#regularizedGammaP Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Regularized lower incomplete gamma `P(a, x)` — exported for callers (e.g. the chi-square survival used by Ljung–Box) that want the primitive directly rather than through a distribution facade. ```typescript export declare function regularizedGammaP(a: number, x: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a): number; default: not declared - (x): number; default: not declared ### @insiderfinance/totalfinance/math#restoreRandomNumberGenerator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore an RNG from a serialized state snapshot. Rejects malformed snapshots (no silent degeneracy). ```typescript export declare function restoreRandomNumberGenerator(snapshot: RandomNumberGeneratorState): RandomNumberGenerator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (snapshot): RandomNumberGeneratorState; default: not declared - (snapshot).algorithm: ('mulberry32') | ('xoshiro128ss'); default: not declared - (snapshot).seed: number; default: not declared - (snapshot).state: ([number, number, number, number]) | ([number]); default: not declared - return.getState: () => RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - return.next: () => number; default: not declared — Uniform sample in [0, 1). - return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). ### @insiderfinance/totalfinance/math#ridder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ridder's method: exponential interpolation on a sign-changing bracket. Often beats bisection. ```typescript export declare function ridder(objective: ScalarFunction, a0: number, b0: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (a0): number; default: not declared - (b0): number; default: not declared - (objective): ScalarFunction; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#rollingCorrelation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling Pearson correlation over a window. Aligned with `NaN` warmup. ```typescript export declare function rollingCorrelation(xs: ArrayLike, ys: ArrayLike, window: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (window): number; default: not declared - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#rollingCovariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling covariance over a window. Aligned with `NaN` warmup. Takes {@link PopulationOptions} for the same reason as {@link rollingStandardDeviation}. ```typescript export declare function rollingCovariance(xs: ArrayLike, ys: ArrayLike, window: number, options?: PopulationOptions): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: PopulationOptions | undefined; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (window): number; default: not declared - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#rollingMean Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling mean. Output length equals input; the first `window-1` values are `NaN`. A window holding a non-finite value — or whose own sum overflows — is reported `NaN`, never `±Infinity` (see {@link finiteOrNaN}). ```typescript export declare function rollingMean(xs: ArrayLike, window: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (window): number; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#rollingStandardDeviation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling standard deviation (sample by default). Aligned with `NaN` warmup. Takes {@link PopulationOptions}, not `VarianceOptions`: the rolling family has no `nanPolicy` (see the module conventions), so the field is rejected as unknown rather than accepted and ignored. ```typescript export declare function rollingStandardDeviation(xs: ArrayLike, window: number, options?: PopulationOptions): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: PopulationOptions | undefined; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (window): number; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#secant Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Secant method from two starting points. Fast but not bracketed. ```typescript export declare function secant(objective: ScalarFunction, x0: number, x1: number, options?: SolverOptions): SolverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (objective): ScalarFunction; default: not declared - (options)?: SolverOptions; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - (x0): number; default: not declared - (x1): number; default: not declared - return.bracket?: [number, number]; default: not declared — Final bracket `[lo, hi]` for bracketing methods, when one was established. - return.converged: boolean; default: not declared — Whether the method actually converged to the requested tolerance. - return.iterations: number; default: not declared — Iterations performed. - return.method: string; default: not declared — The method that produced this result (e.g. `brent`, `newton`). - return.reason?: SolverFailureReason; default: not declared — Machine-readable failure reason when `converged` is `false`. - return.residual?: number; default: not declared — Residual |f(value)| at the returned estimate, when finite. - return.value: number; default: not declared — Best estimate of the root. May be `NaN` when bracketing failed. ### @insiderfinance/totalfinance/math#skewness Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Population skewness (third standardized moment). ```typescript export declare function skewness(xs: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#sobolSequence Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sobol sequence of `n` points in `dimensions` dimensions (indices `0..n-1`; index 0 is the origin). The first `2^m` points form a regular `(0, m, dim)`-net. ```typescript export declare function sobolSequence(count: number, dimensions: number): number[][]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (count): number; default: not declared - (dimensions): number; default: not declared ### @insiderfinance/totalfinance/math#solveAll Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve a batch of bracketed root problems, returning one diagnostic-carrying result per row. ```typescript export declare function solveAll(problems: RootProblem[], options?: SolverOptions): SolverResult[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: SolverOptions | undefined; default: not declared - (options).maximumIterations?: number; default: not declared — Maximum iterations before reporting non-convergence. - (options).residualTolerance?: number; default: not declared — Absolute tolerance on |f|. When `f` falls below this, the solve converges early. - (options).stepTolerance?: number; default: not declared — Absolute tolerance on the x-step / bracket width. - (options).tolerance?: number; default: not declared — Tolerance on the bracket width / x-step (alias for `stepTolerance`). - (problems): RootProblem[]; default: not declared ### @insiderfinance/totalfinance/math#standardDeviation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function standardDeviation(xs: ArrayLike, options?: VarianceOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: VarianceOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#stratifiedUniforms Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `n` stratified uniforms — one sample in each stratum `[i/n, (i+1)/n)`. ```typescript export declare function stratifiedUniforms(randomNumberGenerator: RandomNumberGenerator, count: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (count): number; default: not declared - (randomNumberGenerator): RandomNumberGenerator; default: not declared - (randomNumberGenerator).getState: () => import('@insiderfinance/totalfinance/math').RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - (randomNumberGenerator).next: () => number; default: not declared — Uniform sample in [0, 1). - (randomNumberGenerator).seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). ### @insiderfinance/totalfinance/math#studentT Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Student's t-distribution with `df` degrees of freedom (`df > 0`, need not be an integer). ```typescript export declare const studentT: { readonly cdf: (x: number, degreesOfFreedom: number) => number; readonly inverseCdf: (probability: number, degreesOfFreedom: number) => number; readonly pdf: (x: number, degreesOfFreedom: number) => number; readonly survivalFunction: (x: number, degreesOfFreedom: number) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cdf: (x: number, degreesOfFreedom: number) => number; default: not declared — Cumulative distribution `F(x; ν)`. Uses `F(x) = 1 − ½·I_{ν/(ν+x²)}(ν/2, ½)` for `x > 0` and the mirror image for `x < 0`; `F(0) = ½` exactly by symmetry. - cdf(degreesOfFreedom): number; default: not declared - cdf(x): number; default: not declared - inverseCdf: (probability: number, degreesOfFreedom: number) => number; default: not declared — Quantile (inverse CDF). Returns `±Infinity` at the boundaries `p = 0` / `p = 1`. - inverseCdf(degreesOfFreedom): number; default: not declared - inverseCdf(probability): number; default: not declared - pdf: (x: number, degreesOfFreedom: number) => number; default: not declared — Probability density `f(x; ν)`. - pdf(degreesOfFreedom): number; default: not declared - pdf(x): number; default: not declared - survivalFunction: (x: number, degreesOfFreedom: number) => number; default: not declared — Survival function `1 − F(x; ν)` (equivalently `F(−x; ν)` by symmetry). - survivalFunction(degreesOfFreedom): number; default: not declared - survivalFunction(x): number; default: not declared ### @insiderfinance/totalfinance/math#sum Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Kahan-compensated sum — minimizes rounding error over long series. ```typescript export declare function sum(xs: ArrayLike, options?: StatisticsOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: StatisticsOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#svd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Thin singular value decomposition `A = U·diag(s)·Vᵀ` via the one-sided Jacobi (Hestenes) method — accurate and dependency-free for the small matrices TotalFinance handles. `s` is sorted descending. ```typescript export declare function svd(matrix: Matrix, options?: { maxSweeps?: number; tolerance?: number; }): SvdResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared - (options)?: { maxSweeps?: number; tolerance?: number; }; default: not declared - (options).maxSweeps?: number; default: not declared - (options).tolerance?: number; default: not declared - return.s: number[]; default: not declared — Singular values, descending. - return.u: Matrix; default: not declared — Left singular vectors as columns (`m × n`, thin). - return.v: Matrix; default: not declared — Right singular vectors as columns (`n × n`). ### @insiderfinance/totalfinance/math#transpose Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Transpose of an `m × n` matrix → `n × m`. ```typescript export declare function transpose(matrix: Matrix): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (matrix): Matrix; default: not declared ### @insiderfinance/totalfinance/math#trimmedMean Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Trimmed mean: drop `fraction` of the data from each tail, then average the rest. ```typescript export declare function trimmedMean(xs: ArrayLike, options?: TrimmedMeanOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: TrimmedMeanOptions | undefined; default: not declared - (options).fraction?: number; default: not declared — Fraction dropped from EACH tail before averaging (default 0.1), in [0, 0.5]. At 0.5 nothing but the middle remains and the result is the median; the same fallback applies whenever the two trims would consume the whole sample. - (options).nanPolicy?: NanPolicy; default: not declared - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#uniformSamples Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fill a typed array with uniform [0, 1) samples. ```typescript export declare function uniformSamples(randomNumberGenerator: RandomNumberGenerator, count: number): Float64Array; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (count): number; default: not declared - (randomNumberGenerator): RandomNumberGenerator; default: not declared - (randomNumberGenerator).getState: () => RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - (randomNumberGenerator).next: () => number; default: not declared — Uniform sample in [0, 1). - (randomNumberGenerator).seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). ### @insiderfinance/totalfinance/math#validateInterpolationData Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function validateInterpolationData(xs: ArrayLike, ys: ArrayLike, options?: AxisOptions): { xs: number[]; ys: number[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: AxisOptions; default: not declared - (options).aggregate?: 'last' | 'mean' | 'first'; default: not declared — How to handle duplicate x-values. Omitted → duplicates are rejected. - (options).assumeSorted?: boolean; default: not declared — Skip validation (trusted fast path for pre-validated data). - (options).extrapolate?: ExtrapolationPolicy; default: not declared — Behavior outside the data range: `flat` (default — clamp to the nearest endpoint), `linear` (extend the end slope), or `forbid` (throw `interpolation.out_of_domain`). - (xs): ArrayLike; default: not declared - (ys): ArrayLike; default: not declared - return.xs: number[]; default: not declared - return.ys: number[]; default: not declared ### @insiderfinance/totalfinance/math#variance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Two-pass variance (stable under large constant offsets). ```typescript export declare function variance(xs: ArrayLike, options?: VarianceOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: VarianceOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#welfordVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Online (Welford) variance — single pass, numerically stable. Equivalent to `variance`. ```typescript export declare function welfordVariance(xs: ArrayLike, options?: VarianceOptions): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: VarianceOptions | undefined; default: not declared - (options).nanPolicy?: NanPolicy; default: not declared - (options).population?: boolean; default: not declared — Use the population estimator (÷n) instead of the sample estimator (÷(n-1)). - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#winsorize Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Winsorize: clip values beyond the lower/upper quantiles to those quantiles. Returns a new array. Under `propagate`, a NaN anywhere yields an all-NaN array of the input's length. ```typescript export declare function winsorize(xs: ArrayLike, options?: WinsorizeOptions): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: WinsorizeOptions | undefined; default: not declared - (options).lower?: number; default: not declared — Lower tail fraction to clip (default 0.05). - (options).nanPolicy?: NanPolicy; default: not declared - (options).upper?: number; default: not declared — Upper tail fraction to clip (default 0.05). - (xs): ArrayLike; default: not declared ### @insiderfinance/totalfinance/math#xoshiro128ss Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). xoshiro128** — a higher-quality seedable PRNG (longer period, better statistical properties). As with {@link mulberry32}, the state is derived from `seed >>> 0` but the caller's literal `seed` is echoed. ```typescript export declare function xoshiro128ss(seed: number): RandomNumberGenerator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (seed): number; default: not declared - return.getState: () => RandomNumberGeneratorState; default: not declared — Snapshot the current internal state for exact restoration. - return.next: () => number; default: not declared — Uniform sample in [0, 1). - return.seed: number; default: not declared — The seed this generator was created with (echoed for reproducibility). ## Entrypoint @insiderfinance/totalfinance/math/bivariate ### @insiderfinance/totalfinance/math/bivariate#bivariateNormalCdf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bivariateNormalCdf`. ## Entrypoint @insiderfinance/totalfinance/math/distributions ### @insiderfinance/totalfinance/math/distributions#chiSquare Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#chiSquare`. ### @insiderfinance/totalfinance/math/distributions#gamma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#gamma`. ### @insiderfinance/totalfinance/math/distributions#lgamma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#lgamma`. ### @insiderfinance/totalfinance/math/distributions#regularizedBeta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#regularizedBeta`. ### @insiderfinance/totalfinance/math/distributions#regularizedGammaP Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#regularizedGammaP`. ### @insiderfinance/totalfinance/math/distributions#studentT Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#studentT`. ## Entrypoint @insiderfinance/totalfinance/math/filters ### @insiderfinance/totalfinance/math/filters#KalmanFilterResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#KalmanFilterResult`. ### @insiderfinance/totalfinance/math/filters#KalmanModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#KalmanModel`. ### @insiderfinance/totalfinance/math/filters#KalmanObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#KalmanObservation`. ### @insiderfinance/totalfinance/math/filters#KalmanSmoothResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#KalmanSmoothResult`. ### @insiderfinance/totalfinance/math/filters#kalmanFilter Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#kalmanFilter`. ### @insiderfinance/totalfinance/math/filters#kalmanLogLikelihood Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#kalmanLogLikelihood`. ### @insiderfinance/totalfinance/math/filters#kalmanSmooth Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#kalmanSmooth`. ## Entrypoint @insiderfinance/totalfinance/math/integration ### @insiderfinance/totalfinance/math/integration#AdaptiveSimpsonOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#AdaptiveSimpsonOptions`. ### @insiderfinance/totalfinance/math/integration#AdaptiveSimpsonResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#AdaptiveSimpsonResult`. ### @insiderfinance/totalfinance/math/integration#adaptiveSimpson Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#adaptiveSimpson`. ### @insiderfinance/totalfinance/math/integration#adaptiveSimpsonSafe Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#adaptiveSimpsonSafe`. ### @insiderfinance/totalfinance/math/integration#gaussLegendre Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#gaussLegendre`. ### @insiderfinance/totalfinance/math/integration#gaussLegendreNodes Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#gaussLegendreNodes`. ## Entrypoint @insiderfinance/totalfinance/math/interpolation ### @insiderfinance/totalfinance/math/interpolation#AxisOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#AxisOptions`. ### @insiderfinance/totalfinance/math/interpolation#ExtrapolationPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ExtrapolationPolicy`. ### @insiderfinance/totalfinance/math/interpolation#InterpolateOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#InterpolateOptions`. ### @insiderfinance/totalfinance/math/interpolation#bicubicInterp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bicubicInterp`. ### @insiderfinance/totalfinance/math/interpolation#bilinearInterp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bilinearInterp`. ### @insiderfinance/totalfinance/math/interpolation#linearInterp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#linearInterp`. ### @insiderfinance/totalfinance/math/interpolation#makeBicubicInterpolator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#makeBicubicInterpolator`. ### @insiderfinance/totalfinance/math/interpolation#makeLinearInterpolator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#makeLinearInterpolator`. ### @insiderfinance/totalfinance/math/interpolation#makeNaturalCubicSpline Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#makeNaturalCubicSpline`. ### @insiderfinance/totalfinance/math/interpolation#makePchipInterpolator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#makePchipInterpolator`. ### @insiderfinance/totalfinance/math/interpolation#validateInterpolationData Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#validateInterpolationData`. ## Entrypoint @insiderfinance/totalfinance/math/linalg ### @insiderfinance/totalfinance/math/linalg#Complex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#Complex`. ### @insiderfinance/totalfinance/math/linalg#CovarianceEstimate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#CovarianceEstimate`. ### @insiderfinance/totalfinance/math/linalg#CovarianceMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#CovarianceMethod`. ### @insiderfinance/totalfinance/math/linalg#EigenResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#EigenResult`. ### @insiderfinance/totalfinance/math/linalg#EstimateCovarianceOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#EstimateCovarianceOptions`. ### @insiderfinance/totalfinance/math/linalg#GeneralEigenResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#GeneralEigenResult`. ### @insiderfinance/totalfinance/math/linalg#LedoitWolfOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#LedoitWolfOptions`. ### @insiderfinance/totalfinance/math/linalg#LedoitWolfResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#LedoitWolfResult`. ### @insiderfinance/totalfinance/math/linalg#LuResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#LuResult`. ### @insiderfinance/totalfinance/math/linalg#Matrix Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#Matrix`. ### @insiderfinance/totalfinance/math/linalg#QrResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#QrResult`. ### @insiderfinance/totalfinance/math/linalg#SvdResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#SvdResult`. ### @insiderfinance/totalfinance/math/linalg#cholesky Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#cholesky`. ### @insiderfinance/totalfinance/math/linalg#choleskySolve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#choleskySolve`. ### @insiderfinance/totalfinance/math/linalg#covarianceMatrix Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#covarianceMatrix`. ### @insiderfinance/totalfinance/math/linalg#determinant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#determinant`. ### @insiderfinance/totalfinance/math/linalg#eigen Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#eigen`. ### @insiderfinance/totalfinance/math/linalg#eigenvalues Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#eigenvalues`. ### @insiderfinance/totalfinance/math/linalg#estimateCovariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#estimateCovariance`. ### @insiderfinance/totalfinance/math/linalg#identity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#identity`. ### @insiderfinance/totalfinance/math/linalg#jacobiEigen Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#jacobiEigen`. ### @insiderfinance/totalfinance/math/linalg#ledoitWolfShrinkage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ledoitWolfShrinkage`. ### @insiderfinance/totalfinance/math/linalg#luDecompose Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#luDecompose`. ### @insiderfinance/totalfinance/math/linalg#luSolve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#luSolve`. ### @insiderfinance/totalfinance/math/linalg#matrixMultiply Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#matrixMultiply`. ### @insiderfinance/totalfinance/math/linalg#matrixVectorProduct Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#matrixVectorProduct`. ### @insiderfinance/totalfinance/math/linalg#nearestCorrelation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#nearestCorrelation`. ### @insiderfinance/totalfinance/math/linalg#nearestPsd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#nearestPsd`. ### @insiderfinance/totalfinance/math/linalg#pseudoInverse Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#pseudoInverse`. ### @insiderfinance/totalfinance/math/linalg#qrDecompose Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#qrDecompose`. ### @insiderfinance/totalfinance/math/linalg#qrSolve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#qrSolve`. ### @insiderfinance/totalfinance/math/linalg#svd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#svd`. ### @insiderfinance/totalfinance/math/linalg#transpose Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#transpose`. ## Entrypoint @insiderfinance/totalfinance/math/lowdiscrepancy ### @insiderfinance/totalfinance/math/lowdiscrepancy#SOBOL_MAX_DIMENSIONS Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#SOBOL_MAX_DIMENSIONS`. ### @insiderfinance/totalfinance/math/lowdiscrepancy#haltonPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#haltonPoint`. ### @insiderfinance/totalfinance/math/lowdiscrepancy#haltonSequence Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#haltonSequence`. ### @insiderfinance/totalfinance/math/lowdiscrepancy#sobolSequence Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#sobolSequence`. ## Entrypoint @insiderfinance/totalfinance/math/montecarlo ### @insiderfinance/totalfinance/math/montecarlo#MonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MonteCarloOptions`. ### @insiderfinance/totalfinance/math/montecarlo#MonteCarloResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MonteCarloResult`. ### @insiderfinance/totalfinance/math/montecarlo#antitheticSampler Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#antitheticSampler`. ### @insiderfinance/totalfinance/math/montecarlo#brownianBridge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#brownianBridge`. ### @insiderfinance/totalfinance/math/montecarlo#controlVariateEstimate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#controlVariateEstimate`. ### @insiderfinance/totalfinance/math/montecarlo#correlatedNormalSampler Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#correlatedNormalSampler`. ### @insiderfinance/totalfinance/math/montecarlo#monteCarlo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#monteCarlo`. ### @insiderfinance/totalfinance/math/montecarlo#stratifiedUniforms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#stratifiedUniforms`. ## Entrypoint @insiderfinance/totalfinance/math/normal ### @insiderfinance/totalfinance/math/normal#normal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normal`. ### @insiderfinance/totalfinance/math/normal#normalCdf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalCdf`. ### @insiderfinance/totalfinance/math/normal#normalInverseCdf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalInverseCdf`. ### @insiderfinance/totalfinance/math/normal#normalLogCdf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalLogCdf`. ### @insiderfinance/totalfinance/math/normal#normalLogPdf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalLogPdf`. ### @insiderfinance/totalfinance/math/normal#normalLogSurvivalFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalLogSurvivalFunction`. ### @insiderfinance/totalfinance/math/normal#normalPdf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalPdf`. ### @insiderfinance/totalfinance/math/normal#normalSurvivalFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalSurvivalFunction`. ## Entrypoint @insiderfinance/totalfinance/math/optimize ### @insiderfinance/totalfinance/math/optimize#DifferentialEvolutionOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#DifferentialEvolutionOptions`. ### @insiderfinance/totalfinance/math/optimize#LMOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#LMOptions`. ### @insiderfinance/totalfinance/math/optimize#LevenbergMarquardtResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#LevenbergMarquardtResult`. ### @insiderfinance/totalfinance/math/optimize#MinOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MinOptions`. ### @insiderfinance/totalfinance/math/optimize#MinResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MinResult`. ### @insiderfinance/totalfinance/math/optimize#MultiMinOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MultiMinOptions`. ### @insiderfinance/totalfinance/math/optimize#MultiMinResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MultiMinResult`. ### @insiderfinance/totalfinance/math/optimize#MultivariateFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MultivariateFunction`. ### @insiderfinance/totalfinance/math/optimize#bfgs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bfgs`. ### @insiderfinance/totalfinance/math/optimize#brentMin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#brentMin`. ### @insiderfinance/totalfinance/math/optimize#differentialEvolution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#differentialEvolution`. ### @insiderfinance/totalfinance/math/optimize#goldenSectionMin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#goldenSectionMin`. ### @insiderfinance/totalfinance/math/optimize#levenbergMarquardt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#levenbergMarquardt`. ### @insiderfinance/totalfinance/math/optimize#nelderMead Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#nelderMead`. ## Entrypoint @insiderfinance/totalfinance/math/random ### @insiderfinance/totalfinance/math/random#BootstrapOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#BootstrapOptions`. ### @insiderfinance/totalfinance/math/random#BootstrapResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#BootstrapResult`. ### @insiderfinance/totalfinance/math/random#RandomNumberGenerator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#RandomNumberGenerator`. ### @insiderfinance/totalfinance/math/random#RandomNumberGeneratorState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#RandomNumberGeneratorState`. ### @insiderfinance/totalfinance/math/random#bootstrap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bootstrap`. ### @insiderfinance/totalfinance/math/random#mulberry32 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#mulberry32`. ### @insiderfinance/totalfinance/math/random#normalSample Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#normalSample`. ### @insiderfinance/totalfinance/math/random#restoreRandomNumberGenerator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#restoreRandomNumberGenerator`. ### @insiderfinance/totalfinance/math/random#uniformSamples Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#uniformSamples`. ### @insiderfinance/totalfinance/math/random#xoshiro128ss Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#xoshiro128ss`. ## Entrypoint @insiderfinance/totalfinance/math/regression ### @insiderfinance/totalfinance/math/regression#OlsHacOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#OlsHacOptions`. ### @insiderfinance/totalfinance/math/regression#OlsOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#OlsOptions`. ### @insiderfinance/totalfinance/math/regression#OlsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#OlsResult`. ### @insiderfinance/totalfinance/math/regression#ols Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ols`. ## Entrypoint @insiderfinance/totalfinance/math/solvers ### @insiderfinance/totalfinance/math/solvers#Bracket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#Bracket`. ### @insiderfinance/totalfinance/math/solvers#BracketExpandOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#BracketExpandOptions`. ### @insiderfinance/totalfinance/math/solvers#Derivatives Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#Derivatives`. ### @insiderfinance/totalfinance/math/solvers#FunctionWithDerivatives Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#FunctionWithDerivatives`. ### @insiderfinance/totalfinance/math/solvers#RootProblem Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#RootProblem`. ### @insiderfinance/totalfinance/math/solvers#ScalarFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ScalarFunction`. ### @insiderfinance/totalfinance/math/solvers#SolverFailureReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#SolverFailureReason`. ### @insiderfinance/totalfinance/math/solvers#SolverOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#SolverOptions`. ### @insiderfinance/totalfinance/math/solvers#SolverResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#SolverResult`. ### @insiderfinance/totalfinance/math/solvers#bisection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bisection`. ### @insiderfinance/totalfinance/math/solvers#bracketExpand Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#bracketExpand`. ### @insiderfinance/totalfinance/math/solvers#brent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#brent`. ### @insiderfinance/totalfinance/math/solvers#findRoot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#findRoot`. ### @insiderfinance/totalfinance/math/solvers#halley Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#halley`. ### @insiderfinance/totalfinance/math/solvers#householder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#householder`. ### @insiderfinance/totalfinance/math/solvers#newton Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#newton`. ### @insiderfinance/totalfinance/math/solvers#ridder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ridder`. ### @insiderfinance/totalfinance/math/solvers#secant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#secant`. ### @insiderfinance/totalfinance/math/solvers#solveAll Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#solveAll`. ## Entrypoint @insiderfinance/totalfinance/math/statistics ### @insiderfinance/totalfinance/math/statistics#KurtosisOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#KurtosisOptions`. ### @insiderfinance/totalfinance/math/statistics#MedianAbsoluteDeviationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#MedianAbsoluteDeviationOptions`. ### @insiderfinance/totalfinance/math/statistics#NanPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#NanPolicy`. ### @insiderfinance/totalfinance/math/statistics#PopulationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#PopulationOptions`. ### @insiderfinance/totalfinance/math/statistics#StatisticsOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#StatisticsOptions`. ### @insiderfinance/totalfinance/math/statistics#TrimmedMeanOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TrimmedMeanOptions extends StatisticsOptions { /** * Fraction dropped from EACH tail before averaging (default 0.1), in [0, 0.5]. At 0.5 nothing * but the middle remains and the result is the median; the same fallback applies whenever the * two trims would consume the whole sample. */ fraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fraction?: number; default: not declared — Fraction dropped from EACH tail before averaging (default 0.1), in [0, 0.5]. At 0.5 nothing but the middle remains and the result is the median; the same fallback applies whenever the two trims would consume the whole sample. - nanPolicy?: NanPolicy; default: not declared ### @insiderfinance/totalfinance/math/statistics#VarianceOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#VarianceOptions`. ### @insiderfinance/totalfinance/math/statistics#WinsorizeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#WinsorizeOptions`. ### @insiderfinance/totalfinance/math/statistics#correlation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#correlation`. ### @insiderfinance/totalfinance/math/statistics#covariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#covariance`. ### @insiderfinance/totalfinance/math/statistics#kurtosis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#kurtosis`. ### @insiderfinance/totalfinance/math/statistics#max Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#max`. ### @insiderfinance/totalfinance/math/statistics#mean Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#mean`. ### @insiderfinance/totalfinance/math/statistics#median Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#median`. ### @insiderfinance/totalfinance/math/statistics#medianAbsoluteDeviation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#medianAbsoluteDeviation`. ### @insiderfinance/totalfinance/math/statistics#min Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#min`. ### @insiderfinance/totalfinance/math/statistics#quantile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#quantile`. ### @insiderfinance/totalfinance/math/statistics#rollingCorrelation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#rollingCorrelation`. ### @insiderfinance/totalfinance/math/statistics#rollingCovariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#rollingCovariance`. ### @insiderfinance/totalfinance/math/statistics#rollingMean Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#rollingMean`. ### @insiderfinance/totalfinance/math/statistics#rollingStandardDeviation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#rollingStandardDeviation`. ### @insiderfinance/totalfinance/math/statistics#skewness Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#skewness`. ### @insiderfinance/totalfinance/math/statistics#standardDeviation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#standardDeviation`. ### @insiderfinance/totalfinance/math/statistics#sum Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#sum`. ### @insiderfinance/totalfinance/math/statistics#trimmedMean Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#trimmedMean`. ### @insiderfinance/totalfinance/math/statistics#variance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#variance`. ### @insiderfinance/totalfinance/math/statistics#welfordVariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#welfordVariance`. ### @insiderfinance/totalfinance/math/statistics#winsorize Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#winsorize`. ## Entrypoint @insiderfinance/totalfinance/math/timeseries ### @insiderfinance/totalfinance/math/timeseries#AugmentedDickeyFullerOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#AugmentedDickeyFullerOptions`. ### @insiderfinance/totalfinance/math/timeseries#EngleGrangerResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#EngleGrangerResult`. ### @insiderfinance/totalfinance/math/timeseries#KpssOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#KpssOptions`. ### @insiderfinance/totalfinance/math/timeseries#LjungBoxOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#LjungBoxOptions`. ### @insiderfinance/totalfinance/math/timeseries#TestResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#TestResult`. ### @insiderfinance/totalfinance/math/timeseries#acf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#acf`. ### @insiderfinance/totalfinance/math/timeseries#augmentedDickeyFullerTest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#augmentedDickeyFullerTest`. ### @insiderfinance/totalfinance/math/timeseries#engleGranger Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#engleGranger`. ### @insiderfinance/totalfinance/math/timeseries#hurstExponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#hurstExponent`. ### @insiderfinance/totalfinance/math/timeseries#kpssTest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#kpssTest`. ### @insiderfinance/totalfinance/math/timeseries#ljungBox Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ljungBox`. ### @insiderfinance/totalfinance/math/timeseries#ouHalfLife Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#ouHalfLife`. ### @insiderfinance/totalfinance/math/timeseries#pacf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/math#pacf`. ## Entrypoint @insiderfinance/totalfinance/options ### @insiderfinance/totalfinance/options#AmericanExerciseInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for American exercise analysis. ```typescript /** One cohesive request for American exercise analysis. */ export interface AmericanExerciseInput { contract: OptionContract; market: OptionMarket; options?: AmericanExerciseOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - options?: AmericanExerciseOptions; default: not declared - options.boundaryPoints?: number; default: not declared — Number of maturities in the boundary curve (from τ down to τ/N); default 24. `0` skips the curve. ### @insiderfinance/totalfinance/options#AmericanExerciseOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link americanExercise}. ```typescript /** Options for {@link americanExercise}. */ export interface AmericanExerciseOptions { /** Number of maturities in the boundary curve (from τ down to τ/N); default 24. `0` skips the curve. */ boundaryPoints?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - boundaryPoints?: number; default: not declared — Number of maturities in the boundary curve (from τ down to τ/N); default 24. `0` skips the curve. ### @insiderfinance/totalfinance/options#AmericanExerciseResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The American exercise analysis. ```typescript /** The American exercise analysis. */ export interface AmericanExerciseResult { /** * Which leg was analysed — `'call'` or `'put'`. * * Named `optionType` because that is what it holds: in TotalFinance `style` is the EXERCISE style * (`'european' | 'american'`) everywhere else, and every one of these results is American by * construction, so a field called `style` reading `'put'` was a straight collision of two * vocabularies (pre-1.0 clean break, defect-fix wave, review-1). */ optionType: 'call' | 'put'; spot: number; /** American value (Barone–Adesi–Whaley). */ american: number; /** European value (BSM) — the value stripped of the early-exercise right. */ european: number; /** `american − european ≥ 0` — the dollars the early-exercise right adds. */ earlyExercisePremium: number; /** `premium / american`. */ premiumFractionOfValue: number; intrinsic: number; /** `american − intrinsic ≥ 0`. */ timeValue: number; /** `false` for a non-dividend call (early exercise never optimal). */ earlyExerciseCanBeOptimal: boolean; /** `S*(τ)` at the current maturity; `null` when early exercise is never optimal. */ criticalSpot: number | null; /** The American value has collapsed to intrinsic — no time value left to give up. */ shouldExerciseNow: boolean; /** Signed fraction of spot to the boundary (put: `(S−S*)/S`, call: `(S*−S)/S`); `null` if no boundary. */ spotToBoundary: number | null; /** The `S*(τ)` curve over the remaining life (empty when never optimal). */ boundary: BoundaryPoint[]; /** Prose an agent relays. */ rationale: string; assumptions: { conventionsVersion: string; valueEngine: 'barone-adesi-whaley'; dividendModel: DividendModel; timeToExpiryYears: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - american: number; default: not declared — American value (Barone–Adesi–Whaley). - assumptions: { conventionsVersion: string; dividendModel: DividendModel; timeToExpiryYears: number; valueEngine: 'barone-adesi-whaley'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dividendModel: DividendModel; default: not declared - assumptions.timeToExpiryYears: number; default: not declared - assumptions.valueEngine: 'barone-adesi-whaley'; default: not declared - boundary: BoundaryPoint[]; default: not declared — The `S*(τ)` curve over the remaining life (empty when never optimal). - criticalSpot: number | null; default: not declared — `S*(τ)` at the current maturity; `null` when early exercise is never optimal. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - earlyExerciseCanBeOptimal: boolean; default: not declared — `false` for a non-dividend call (early exercise never optimal). - earlyExercisePremium: number; default: not declared — `american − european ≥ 0` — the dollars the early-exercise right adds. - european: number; default: not declared — European value (BSM) — the value stripped of the early-exercise right. - intrinsic: number; default: not declared - optionType: 'call' | 'put'; default: not declared — Which leg was analysed — `'call'` or `'put'`. Named `optionType` because that is what it holds: in TotalFinance `style` is the EXERCISE style (`'european' | 'american'`) everywhere else, and every one of these results is American by construction, so a field called `style` reading `'put'` was a straight collision of two vocabularies (pre-1.0 clean break, defect-fix wave, review-1). - premiumFractionOfValue: number; default: not declared — `premium / american`. - rationale: string; default: not declared — Prose an agent relays. - shouldExerciseNow: boolean; default: not declared — The American value has collapsed to intrinsic — no time value left to give up. - spot: number; default: not declared - spotToBoundary: number | null; default: not declared — Signed fraction of spot to the boundary (put: `(S−S*)/S`, call: `(S*−S)/S`); `null` if no boundary. - timeValue: number; default: not declared — `american − intrinsic ≥ 0`. ### @insiderfinance/totalfinance/options#AmericanImpliedVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for American implied-volatility inversion. ```typescript /** One cohesive request for American implied-volatility inversion. */ export interface AmericanImpliedVolatilityInput { contract: OptionContract; market: OptionMarket; options?: AmericanImpliedVolatilityOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - options?: AmericanImpliedVolatilityOptions; default: not declared - options.engine?: OptionPricingEngine; default: not declared — Engine to invert. Default `engines.bjerksundStensland2002()`. Pass e.g. a binomial engine to handle discrete dividends — the inversion is generic and the reported engine follows the override. - options.engine.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - options.engine.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - options.engine.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - options.engine.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - options.engine.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - options.engine.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - options.engine.name: string; default: not declared - options.engine.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - options.engine.price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - options.engine.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - options.engine.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - options.engine.price().return.greeks.charm: number; default: not declared - options.engine.price().return.greeks.color: number; default: not declared - options.engine.price().return.greeks.delta: number; default: not declared - options.engine.price().return.greeks.gamma: number; default: not declared - options.engine.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - options.engine.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - options.engine.price().return.greeks.rho: number; default: not declared - options.engine.price().return.greeks.speed: number; default: not declared - options.engine.price().return.greeks.theta: number; default: not declared - options.engine.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - options.engine.price().return.greeks.vanna: number; default: not declared - options.engine.price().return.greeks.vega: number; default: not declared - options.engine.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - options.engine.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - options.engine.price().return.greeks.vomma: number; default: not declared - options.engine.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - options.engine.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - options.engine.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - options.engine.price(input): import('@insiderfinance/totalfinance/options').OptionEnginePriceInput; default: not declared - options.engine.price(input).contract: OptionContract; default: not declared - options.engine.price(input).market: OptionMarket; default: not declared - options.engine.price(input).options?: import('@insiderfinance/totalfinance/options').PriceOptions; default: not declared - options.engine.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - options.engine.supports(contract): OptionContract; default: not declared - options.engine.supports(contract).adjusted?: boolean; default: not declared - options.engine.supports(contract).currency?: string; default: not declared - options.engine.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - options.engine.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - options.engine.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - options.engine.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - options.engine.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - options.engine.supports(contract).multiplier?: number; default: not declared - options.engine.supports(contract).occSymbol?: string; default: not declared - options.engine.supports(contract).root?: string; default: not declared - options.engine.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - options.engine.supports(contract).strike: number; default: not declared - options.engine.supports(contract).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - options.engine.supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - options.engine.supports(contract).underlying: string; default: not declared - options.engine.version: string; default: not declared ### @insiderfinance/totalfinance/options#AmericanImpliedVolatilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link americanImpliedVolatility}. Mirrors the subset of `ImpliedVolatilityOptions` it honours. ```typescript /** Options for {@link americanImpliedVolatility}. Mirrors the subset of `ImpliedVolatilityOptions` it honours. */ export interface AmericanImpliedVolatilityOptions { /** * Engine to invert. Default `engines.bjerksundStensland2002()`. Pass e.g. a binomial engine to * handle discrete dividends — the inversion is generic and the reported engine follows the override. */ engine?: OptionPricingEngine; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - engine?: OptionPricingEngine; default: not declared — Engine to invert. Default `engines.bjerksundStensland2002()`. Pass e.g. a binomial engine to handle discrete dividends — the inversion is generic and the reported engine follows the override. - engine.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engine.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engine.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engine.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engine.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engine.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engine.name: string; default: not declared - engine.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => import('@insiderfinance/totalfinance/options').PriceResult; default: not declared - engine.price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - engine.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - engine.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - engine.price().return.greeks.charm: number; default: not declared - engine.price().return.greeks.color: number; default: not declared - engine.price().return.greeks.delta: number; default: not declared - engine.price().return.greeks.gamma: number; default: not declared - engine.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - engine.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - engine.price().return.greeks.rho: number; default: not declared - engine.price().return.greeks.speed: number; default: not declared - engine.price().return.greeks.theta: number; default: not declared - engine.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - engine.price().return.greeks.vanna: number; default: not declared - engine.price().return.greeks.vega: number; default: not declared - engine.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - engine.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - engine.price().return.greeks.vomma: number; default: not declared - engine.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - engine.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - engine.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - engine.price(input): import('@insiderfinance/totalfinance/options').OptionEnginePriceInput; default: not declared - engine.price(input).contract: OptionContract; default: not declared - engine.price(input).market: OptionMarket; default: not declared - engine.price(input).options?: import('@insiderfinance/totalfinance/options').PriceOptions; default: not declared - engine.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engine.supports(contract): OptionContract; default: not declared - engine.supports(contract).adjusted?: boolean; default: not declared - engine.supports(contract).currency?: string; default: not declared - engine.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - engine.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - engine.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - engine.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - engine.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - engine.supports(contract).multiplier?: number; default: not declared - engine.supports(contract).occSymbol?: string; default: not declared - engine.supports(contract).root?: string; default: not declared - engine.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - engine.supports(contract).strike: number; default: not declared - engine.supports(contract).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - engine.supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - engine.supports(contract).underlying: string; default: not declared - engine.version: string; default: not declared ### @insiderfinance/totalfinance/options#AsianInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for the exact discrete geometric-average Asian price. ```typescript /** Inputs for the exact discrete geometric-average Asian price. */ export interface AsianInput extends AsianMonteCarloInput { /** Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). */ averagingPoints?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averagingPoints?: number; default: not declared — Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#AsianMonteCarloInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market and contract inputs shared by arithmetic Asian Monte-Carlo pricing. ```typescript // ──────────────────────────────────────────────────────────────────────────── // Asian options (arithmetic via geometric control variate) // ──────────────────────────────────────────────────────────────────────────── /** Market and contract inputs shared by arithmetic Asian Monte-Carlo pricing. */ export interface AsianMonteCarloInput { spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#AsianMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AsianMonteCarloOptions extends MonteCarloSamplingOptions { /** Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). */ averagingPoints?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - averagingPoints?: number; default: not declared — Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#AutoEngineOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AutoEngineOptions { /** `'accuracy'` (default) picks the most accurate engine; `'speed'` the fastest closed form. */ objective?: AutoObjective; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - objective?: AutoObjective; default: not declared — `'accuracy'` (default) picks the most accurate engine; `'speed'` the fastest closed form. ### @insiderfinance/totalfinance/options#AutoObjective Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Objective steering {@link engines.auto}: maximise accuracy (default) or speed. ```typescript /** Objective steering {@link engines.auto}: maximise accuracy (default) or speed. */ export type AutoObjective = 'speed' | 'accuracy'; ``` ### @insiderfinance/totalfinance/options#AutocallableInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── autocallable note (Monte-Carlo) ───────────────────────── export interface AutocallableInput { spot: number; /** Strictly-increasing observation times in years; the last is maturity. */ observationTimes: number[]; riskFreeRate: number; volatility: number; dividendYield?: number; /** Autocall trigger level: if `S(tᵢ) ≥ autocallBarrier`, the note redeems early. */ autocallBarrier: number; /** Coupon per elapsed period (fraction of notional), paid cumulatively on redemption. */ couponRate: number; /** Downside knock-in level checked at maturity (capital is at risk below it). */ knockInBarrier: number; /** Notional. Default 100. */ notional?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autocallBarrier: number; default: not declared — Autocall trigger level: if `S(tᵢ) ≥ autocallBarrier`, the note redeems early. - couponRate: number; default: not declared — Coupon per elapsed period (fraction of notional), paid cumulatively on redemption. - dividendYield?: number; default: not declared - knockInBarrier: number; default: not declared — Downside knock-in level checked at maturity (capital is at risk below it). - notional?: number; default: not declared — Notional. Default 100. - observationTimes: number[]; default: not declared — Strictly-increasing observation times in years; the last is maturity. - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#BachelierImpliedVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BachelierImpliedVolatilityInput { price: number; forward: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; type: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - price: number; default: not declared - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#BachelierImpliedVolatilityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BachelierImpliedVolatilityResult { value: number; converged: boolean; iterations: number; reason?: 'below_intrinsic' | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared - iterations: number; default: not declared - reason?: 'below_intrinsic' | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/options#BachelierInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BachelierInput { forward: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; /** * NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the * lognormal decimal and the price-unit normal vol must never share a field name. `vega` is * reported per 1.00 of normal vol (`units.vega: perPoint`). */ normalVolatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/options#BachelierTypedInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BachelierTypedInput extends BachelierInput { type: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#BarrierInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // The enum runtime domains (BARRIER_TYPES, OPTION_TYPES, …) used to live here as hand consts for // `ensureEnum`; they now travel inside the GENERATED validation specs, so the declaration is the // single source and a hand copy cannot drift. export interface BarrierInput { spot: number; strike: number; /** Barrier level H. */ barrier: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - barrier: number; default: not declared — Barrier level H. - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#BarrierMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BarrierMonteCarloOptions extends MonteCarloSamplingOptions { /** Monitoring steps per path (default 100). */ steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. - steps?: number; default: not declared — Monitoring steps per path (default 100). ### @insiderfinance/totalfinance/options#BarrierType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Barrier options // ──────────────────────────────────────────────────────────────────────────── export type BarrierType = 'down-in' | 'down-out' | 'up-in' | 'up-out'; ``` ### @insiderfinance/totalfinance/options#BasketInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BasketInput extends MultiAssetInput { /** Basket weights (one per asset). */ weights: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - dividendYields?: number[]; default: not declared - riskFreeRate: number; default: not declared - spots: number[]; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatilities: number[]; default: not declared - weights: number[]; default: not declared — Basket weights (one per asset). ### @insiderfinance/totalfinance/options#BinomialEngineOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BinomialEngineOptions { variant?: BinomialVariant; steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - steps?: number; default: not declared - variant?: BinomialVariant; default: not declared ### @insiderfinance/totalfinance/options#BinomialVariant Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type BinomialVariant = 'crr' | 'jarrow-rudd' | 'tian' | 'leisen-reimer'; ``` ### @insiderfinance/totalfinance/options#Black76ImpliedVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Black76ImpliedVolatilityInput { price: number; forward: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; type: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - price: number; default: not declared - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#Black76ImpliedVolatilityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Black76ImpliedVolatilityResult { value: number; converged: boolean; iterations: number; reason?: 'below_intrinsic' | 'above_max_bound' | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; /** Explanatory detail when a usable numeric pricing bracket cannot be established. */ message?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared - iterations: number; default: not declared - message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - reason?: 'below_intrinsic' | 'above_max_bound' | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/options#Black76Input Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Black76Input { forward: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#Black76TypedInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Black76TypedInput extends Black76Input { type: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#BlackScholesEvaluateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link blackScholes}.evaluate: the typed Black–Scholes input plus the outputs to compute. `outputs` is required, nonempty, dense and duplicate-free. ```typescript /** * Input for {@link blackScholes}.evaluate: the typed Black–Scholes input plus the outputs to compute. * `outputs` is required, nonempty, dense and duplicate-free. */ export interface BlackScholesEvaluateInput extends BlackScholesTypedInput { /** The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. */ outputs: O; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - spot: number; default: not declared — Spot price of the underlying. - strike: number; default: not declared — Strike price. - timeToExpiryYears: number; default: not declared — Time to expiry in years. - type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). ### @insiderfinance/totalfinance/options#BlackScholesEvaluateManyOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link blackScholesEvaluateMany}. ```typescript // ---- selective batch evaluation (selective Greeks spec, decisions 6–8) ---- /** Options for {@link blackScholesEvaluateMany}. */ export interface BlackScholesEvaluateManyOptions { /** * The outputs to compute, e.g. `['gamma']` or `['price', 'delta']`. Required, nonempty, dense and * duplicate-free; only these are computed and returned. */ outputs: O; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - outputs: O; default: not declared — The outputs to compute, e.g. `['gamma']` or `['price', 'delta']`. Required, nonempty, dense and duplicate-free; only these are computed and returned. ### @insiderfinance/totalfinance/options#BlackScholesEvaluateManyResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One `Float64Array` (one value per row) for each selected output. The outputs the selection is certain to contain are required columns; any other output it might contain is optional ({@link GuaranteedSelection}): a literal selection gives exactly its columns, while a dynamic selection, a conditional between selections or a union-valued element gives optional ones. ```typescript /** * One `Float64Array` (one value per row) for each selected output. The outputs the selection is * certain to contain are required columns; any other output it might contain is optional * ({@link GuaranteedSelection}): a literal selection gives exactly its columns, while a dynamic * selection, a conditional between selections or a union-valued element gives optional ones. */ export type BlackScholesEvaluateManyResult = { [K in GuaranteedSelection]: Float64Array; } & { [K in Exclude>]?: Float64Array; }; ``` ### @insiderfinance/totalfinance/options#BlackScholesEvaluation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The result of a selected evaluation. The outputs the selection is certain to contain are required numbers; any other output it might contain is optional ({@link GuaranteedSelection}). So a literal `['price', 'gamma']` gives exactly those two required, while a dynamic selection (`BlackScholesOutput[]`), a conditional (`c ? ['gamma'] : ['delta']`) or a union-valued element gives optional properties: the type never claims a value exists that was not requested. ```typescript /** * The result of a selected evaluation. The outputs the selection is certain to contain are required * numbers; any other output it might contain is optional ({@link GuaranteedSelection}). So a * literal `['price', 'gamma']` gives exactly those two required, while a dynamic selection * (`BlackScholesOutput[]`), a conditional (`c ? ['gamma'] : ['delta']`) or a union-valued element * gives optional properties: the type never claims a value exists that was not requested. */ export type BlackScholesEvaluation = { [K in GuaranteedSelection]: number; } & { [K in Exclude>]?: number; }; ``` ### @insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Facade input for implied-volatility solving. ```typescript /** Facade input for implied-volatility solving. */ export interface BlackScholesImpliedVolatilityInput { /** Observed option price to invert. */ price: number; spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; type: OptionType; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - price: number; default: not declared — Observed option price to invert. - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Schema for an implied-volatility request. Built from {@link blackScholesShape} (minus `volatility`, which is the unknown being solved) so its fields carry the same descriptions as every other option schema rather than the bare, description-less duplicate this used to be. ```typescript export declare const BlackScholesImpliedVolatilityInputSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - safeParse().return.data: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BlackScholesImpliedVolatilityOptions { /** Lower σ bracket (default `1e-7`). */ lowerVolatilityBound?: number; /** Upper σ bracket before expansion (default `5`). */ upperVolatilityBound?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lowerVolatilityBound?: number; default: not declared — Lower σ bracket (default `1e-7`). - upperVolatilityBound?: number; default: not declared — Upper σ bracket before expansion (default `5`). ### @insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BlackScholesImpliedVolatilityResult { value: number; converged: boolean; iterations: number; error?: number; reason?: ImpliedVolatilityReason; /** Explanatory detail when a usable numeric pricing bracket cannot be established. */ message?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared - error?: number; default: not declared - iterations: number; default: not declared - message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - reason?: ImpliedVolatilityReason; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/options#BlackScholesInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Flat facade input for a single Black–Scholes–Merton computation. ```typescript /** Flat facade input for a single Black–Scholes–Merton computation. */ export interface BlackScholesInput { /** Spot price of the underlying. */ spot: number; /** Strike price. */ strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; /** Continuously-compounded risk-free rate (decimal, e.g. `0.045`). */ riskFreeRate: number; /** Volatility (decimal, e.g. `0.22`). */ volatility: number; /** Continuous dividend yield (decimal, default `0`). */ dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - spot: number; default: not declared — Spot price of the underlying. - strike: number; default: not declared — Strike price. - timeToExpiryYears: number; default: not declared — Time to expiry in years. - volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). ### @insiderfinance/totalfinance/options#BlackScholesInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Schema for a `BlackScholesInput` facade payload. ```typescript export declare const BlackScholesInputSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - safeParse().return.data: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/options#BlackScholesNoArbitrageInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link checkBlackScholesNoArbitrage} — the observed price plus the BSM inputs it's bounded against. ```typescript /** Input for {@link checkBlackScholesNoArbitrage} — the observed price plus the BSM inputs it's bounded against. */ export interface BlackScholesNoArbitrageInput { type: OptionType; /** The observed option price to test. */ price: number; spot: number; strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; riskFreeRate: number; /** Continuous dividend yield (decimal, default 0). */ dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - price: number; default: not declared — The observed option price to test. - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#BlackScholesOutput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A Black–Scholes output a selective call can request. First-order Greeks use the library's display units (theta per calendar day, vega and rho per 1%); higher-order Greeks use the raw units documented on `blackScholesExtendedGreeks`. ```typescript /** * A Black–Scholes output a selective call can request. First-order Greeks use the library's display * units (theta per calendar day, vega and rho per 1%); higher-order Greeks use the raw units * documented on `blackScholesExtendedGreeks`. */ export type BlackScholesOutput = (typeof BLACK_SCHOLES_OUTPUTS)[number]; ``` ### @insiderfinance/totalfinance/options#BlackScholesOutputBuffers Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Caller-owned output storage for {@link blackScholesEvaluateManyInto}: the property names ARE the selection. Each buffer is a `Float64Array` with at least one element per row; only elements `[0, rows)` are written. ```typescript /** * Caller-owned output storage for {@link blackScholesEvaluateManyInto}: the property names ARE the * selection. Each buffer is a `Float64Array` with at least one element per row; only elements * `[0, rows)` are written. */ export interface BlackScholesOutputBuffers { /** Option value. */ price?: Float64Array; /** ∂V/∂S. */ delta?: Float64Array; /** ∂²V/∂S². */ gamma?: Float64Array; /** Value change per calendar day elapsed. */ theta?: Float64Array; /** Value change per 1% (0.01) volatility move. */ vega?: Float64Array; /** Value change per 1% (0.01) rate move. */ rho?: Float64Array; /** ∂Δ/∂σ, per 1.00 σ. */ vanna?: Float64Array; /** ∂Δ/∂T, per added year of time-to-expiry. */ charm?: Float64Array; /** ∂²V/∂σ², per 1.00 σ². */ vomma?: Float64Array; /** ∂Γ/∂S. */ speed?: Float64Array; /** ∂Γ/∂T, per added year of time-to-expiry. */ color?: Float64Array; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm?: Float64Array; default: not declared — ∂Δ/∂T, per added year of time-to-expiry. - color?: Float64Array; default: not declared — ∂Γ/∂T, per added year of time-to-expiry. - delta?: Float64Array; default: not declared — ∂V/∂S. - gamma?: Float64Array; default: not declared — ∂²V/∂S². - price?: Float64Array; default: not declared — Option value. - rho?: Float64Array; default: not declared — Value change per 1% (0.01) rate move. - speed?: Float64Array; default: not declared — ∂Γ/∂S. - theta?: Float64Array; default: not declared — Value change per calendar day elapsed. - vanna?: Float64Array; default: not declared — ∂Δ/∂σ, per 1.00 σ. - vega?: Float64Array; default: not declared — Value change per 1% (0.01) volatility move. - vomma?: Float64Array; default: not declared — ∂²V/∂σ², per 1.00 σ². ### @insiderfinance/totalfinance/options#BlackScholesOutputSelection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A selection of outputs, as an array or (inferred from a literal) a tuple. ```typescript /** A selection of outputs, as an array or (inferred from a literal) a tuple. */ export type BlackScholesOutputSelection = readonly BlackScholesOutput[]; ``` ### @insiderfinance/totalfinance/options#BlackScholesTypedInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Facade input where the option type is explicit (`blackScholes.price`, `blackScholes.greeks`). ```typescript /** Facade input where the option type is explicit (`blackScholes.price`, `blackScholes.greeks`). */ export interface BlackScholesTypedInput extends BlackScholesInput { type: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - spot: number; default: not declared — Spot price of the underlying. - strike: number; default: not declared — Strike price. - timeToExpiryYears: number; default: not declared — Time to expiry in years. - type: OptionType; default: not declared - volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). ### @insiderfinance/totalfinance/options#BlackScholesTypedInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Schema for a typed BSM payload (`blackScholes.price` / `blackScholes.greeks`). ```typescript export declare const BlackScholesTypedInputSchema: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'object'; default: not declared - open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - safeParse().return.data: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/options#BoundaryPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One point on the exercise-boundary curve. ```typescript /** One point on the exercise-boundary curve. */ export interface BoundaryPoint { /** Time to expiry (years) at this point. */ yearsToExpiry: number; /** The critical spot `S*` at that maturity. */ criticalSpot: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - criticalSpot: number; default: not declared — The critical spot `S*` at that maturity. - yearsToExpiry: number; default: not declared — Time to expiry (years) at this point. ### @insiderfinance/totalfinance/options#BoxSpreadAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assumptions echoed by {@link boxSpreadRate}. ```typescript /** Assumptions echoed by {@link boxSpreadRate}. */ export type BoxSpreadAssumptions = Assumptions<{ priceSource: PriceSource; lowerStrike: number; upperStrike: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - conventionsVersion: string; default: not declared - dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - lowerStrike: number; default: not declared - model?: string; default: not declared - priceSource: PriceSource; default: not declared - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - upperStrike: number; default: not declared ### @insiderfinance/totalfinance/options#BoxSpreadDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnostics for {@link boxSpreadRate}. ```typescript /** Diagnostics for {@link boxSpreadRate}. */ export interface BoxSpreadDiagnostics extends Diagnostics { /** Net debit of the box `(C(k1) − C(k2)) + (P(k2) − P(k1))`. */ debit: number; /** Strike width `k2 − k1`, the guaranteed expiry payoff. */ width: number; /** `debit / width = e^(−rT)`, the implied discount factor. */ discountFactor: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - debit: number; default: not declared — Net debit of the box `(C(k1) − C(k2)) + (P(k2) − P(k1))`. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - discountFactor: number; default: not declared — `debit / width = e^(−rT)`, the implied discount factor. - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - width: number; default: not declared — Strike width `k2 − k1`, the guaranteed expiry payoff. ### @insiderfinance/totalfinance/options#BoxSpreadOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link boxSpreadRate}. ```typescript /** Options for {@link boxSpreadRate}. */ export interface BoxSpreadOptions { /** Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime). */ asOf: EpochMs | string; /** Quote price source per leg (default `mid`). */ source?: PriceSource; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime). - source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). ### @insiderfinance/totalfinance/options#BoxSpreadResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The rich envelope returned by {@link boxSpreadRate}. ```typescript /** The rich envelope returned by {@link boxSpreadRate}. */ export interface BoxSpreadResult { value: number; assumptions: BoxSpreadAssumptions; diagnostics: BoxSpreadDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: BoxSpreadAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.lowerStrike: number; default: not declared - assumptions.model?: string; default: not declared - assumptions.priceSource: PriceSource; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.upperStrike: number; default: not declared - diagnostics: BoxSpreadDiagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.debit: number; default: not declared — Net debit of the box `(C(k1) − C(k2)) + (P(k2) − P(k1))`. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.discountFactor: number; default: not declared — `debit / width = e^(−rT)`, the implied discount factor. - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.width: number; default: not declared — Strike width `k2 − k1`, the guaranteed expiry payoff. - value: number; default: not declared ### @insiderfinance/totalfinance/options#ChainGreeksAssumptionsExtra Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extra assumptions `chainGreeks` echoes beyond the shared conventions. ```typescript /** Extra assumptions `chainGreeks` echoes beyond the shared conventions. */ export interface ChainGreeksAssumptionsExtra extends Record { priceSource: PriceSource; /** The engine each exercise style is solved with. */ engines: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; /** The provenance stamped on every solved row's Greeks. */ provenanceSource: 'chainGreeks'; spot: number; riskFreeRate: number; dividendYield: number; units: GreekUnits; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - engines: { american: 'bjerksund-stensland-2002'; european: 'black-scholes-merton'; }; default: not declared — The engine each exercise style is solved with. - engines.american: 'bjerksund-stensland-2002'; default: not declared - engines.european: 'black-scholes-merton'; default: not declared - priceSource: PriceSource; default: not declared - provenanceSource: 'chainGreeks'; default: not declared — The provenance stamped on every solved row's Greeks. - riskFreeRate: number; default: not declared - spot: number; default: not declared - units: GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared ### @insiderfinance/totalfinance/options#ChainGreeksDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChainGreeksDiagnostics extends Diagnostics { warnings: QuantWarning[]; /** One entry per input row, in order. */ rows: ChainGreeksRowDiagnostic[]; solvedCount: number; skippedCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - iterations?: number; default: not declared — Iteration count for iterative methods. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - rows: ChainGreeksRowDiagnostic[]; default: not declared — One entry per input row, in order. - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - skippedCount: number; default: not declared - solvedCount: number; default: not declared - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/options#ChainGreeksInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChainGreeksInput { /** The chain rows; each is returned in order, stamped when its Greeks could be solved. */ quotes: readonly OptionQuote[]; /** Spot, rate, optional continuous yield and the valuation instant (a bare date is refused). */ market: MarketInputs; /** Which observed price to invert per row (default `'mid'`; no fallback across sources). */ priceSource?: PriceSource; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - market: MarketInputs; default: not declared — Spot, rate, optional continuous yield and the valuation instant (a bare date is refused). - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - priceSource?: PriceSource; default: not declared — Which observed price to invert per row (default `'mid'`; no fallback across sources). - quotes: readonly OptionQuote[]; default: not declared — The chain rows; each is returned in order, stamped when its Greeks could be solved. ### @insiderfinance/totalfinance/options#ChainGreeksResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `value` is the input rows in order: a solved row carries `impliedVolatility` and `greeks`; a skipped row is returned unchanged and named in `diagnostics.rows`. ```typescript /** * `value` is the input rows in order: a solved row carries `impliedVolatility` and `greeks`; a * skipped row is returned unchanged and named in `diagnostics.rows`. */ export type ChainGreeksResult = Computed & { diagnostics: ChainGreeksDiagnostics; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.dividendYield: number; default: not declared - assumptions.engine?: string; default: not declared - assumptions.engines: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; default: not declared — The engine each exercise style is solved with. - assumptions.engines.american: 'bjerksund-stensland-2002'; default: not declared - assumptions.engines.european: 'black-scholes-merton'; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.priceSource: PriceSource; default: not declared - assumptions.provenanceSource: 'chainGreeks'; default: not declared — The provenance stamped on every solved row's Greeks. - assumptions.riskFreeRate: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.spot: number; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: (ChainGreeksDiagnostics) | (Diagnostics); default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.rows: ChainGreeksRowDiagnostic[]; default: not declared — One entry per input row, in order. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.skippedCount: number; default: not declared - diagnostics.solvedCount: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: OptionQuote[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#ChainGreeksRowDiagnostic Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChainGreeksRowDiagnostic { /** Input index of the row. */ index: number; status: ChainGreeksRowStatus; /** The engine that solved the row, or null when it was skipped. */ engine: string | null; /** Why the row was skipped (a typed code, e.g. `implied_volatility.below_intrinsic`), else null. */ reason: string | null; /** The message behind `reason`, else null. */ message: string | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - engine: string | null; default: not declared — The engine that solved the row, or null when it was skipped. - index: number; default: not declared — Input index of the row. - message: string | null; default: not declared — The message behind `reason`, else null. - reason: string | null; default: not declared — Why the row was skipped (a typed code, e.g. `implied_volatility.below_intrinsic`), else null. - status: ChainGreeksRowStatus; default: not declared ### @insiderfinance/totalfinance/options#ChainGreeksRowStatus Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ChainGreeksRowStatus = 'solved' | 'skipped'; ``` ### @insiderfinance/totalfinance/options#CliquetInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Cliquet / ratchet options — a capped strip of forward-start caplets // ──────────────────────────────────────────────────────────────────────────── export interface CliquetInput { spot: number; /** Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. */ resetTimes: number[]; riskFreeRate: number; volatility: number; dividendYield?: number; /** Per-period return floor; default 0 (lock in non-negative gains). Must be ≥ −1. */ localFloor?: number; /** Per-period return cap; default `+∞` (uncapped). Must be > `localFloor`. */ localCap?: number; /** Global (summed) floor; default `−∞`. Requires `monteCarloPrice`. */ globalFloor?: number; /** Global (summed) cap; default `+∞`. Requires `monteCarloPrice`. */ globalCap?: number; /** Notional multiplier; default 1. */ notional?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - globalCap?: number; default: not declared — Global (summed) cap; default `+∞`. Requires `monteCarloPrice`. - globalFloor?: number; default: not declared — Global (summed) floor; default `−∞`. Requires `monteCarloPrice`. - localCap?: number; default: not declared — Per-period return cap; default `+∞` (uncapped). Must be > `localFloor`. - localFloor?: number; default: not declared — Per-period return floor; default 0 (lock in non-negative gains). Must be ≥ −1. - notional?: number; default: not declared — Notional multiplier; default 1. - resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#CompareEnginesInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cohesive request for side-by-side engine comparison. ```typescript /** One cohesive request for side-by-side engine comparison. */ export interface CompareEnginesInput { contract: OptionContract; market: OptionMarket; options?: CompareEnginesOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - options?: CompareEnginesOptions; default: not declared - options.engines?: OptionPricingEngine[]; default: not declared — Engines to compare. Defaults to the built-in panel that supports the contract. - options.now?: () => number; default: not declared — Optional monotonic clock (e.g. `() => performance.now()`). When supplied, each engine's wall-clock pricing time is measured into `timingMs`. Omitted by default so the function stays pure (no system-clock read) — timing is opt-in instrumentation the caller injects. - options.reference?: OptionPricingEngine; default: not declared — Convergence benchmark. Defaults to a 1001-step Leisen–Reimer lattice. - options.reference.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - options.reference.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - options.reference.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - options.reference.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - options.reference.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - options.reference.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - options.reference.name: string; default: not declared - options.reference.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - options.reference.price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - options.reference.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - options.reference.price().return.greeks?: Greeks | ExtendedGreeks; default: not declared - options.reference.price().return.greeks.charm: number; default: not declared - options.reference.price().return.greeks.color: number; default: not declared - options.reference.price().return.greeks.delta: number; default: not declared - options.reference.price().return.greeks.gamma: number; default: not declared - options.reference.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - options.reference.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - options.reference.price().return.greeks.rho: number; default: not declared - options.reference.price().return.greeks.speed: number; default: not declared - options.reference.price().return.greeks.theta: number; default: not declared - options.reference.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - options.reference.price().return.greeks.vanna: number; default: not declared - options.reference.price().return.greeks.vega: number; default: not declared - options.reference.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - options.reference.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - options.reference.price().return.greeks.vomma: number; default: not declared - options.reference.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - options.reference.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - options.reference.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - options.reference.price(input): OptionEnginePriceInput; default: not declared - options.reference.price(input).contract: OptionContract; default: not declared - options.reference.price(input).market: OptionMarket; default: not declared - options.reference.price(input).options?: PriceOptions; default: not declared - options.reference.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - options.reference.supports(contract): OptionContract; default: not declared - options.reference.supports(contract).adjusted?: boolean; default: not declared - options.reference.supports(contract).currency?: string; default: not declared - options.reference.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - options.reference.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - options.reference.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - options.reference.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - options.reference.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - options.reference.supports(contract).multiplier?: number; default: not declared - options.reference.supports(contract).occSymbol?: string; default: not declared - options.reference.supports(contract).root?: string; default: not declared - options.reference.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - options.reference.supports(contract).strike: number; default: not declared - options.reference.supports(contract).style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - options.reference.supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - options.reference.supports(contract).underlying: string; default: not declared - options.reference.version: string; default: not declared ### @insiderfinance/totalfinance/options#CompoGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The compo's multi-factor risk. ```typescript /** The compo's multi-factor risk. */ export interface CompoGreeks { /** `∂C/∂S_f` — foreign-asset delta. */ assetDelta: number; /** `∂C/∂X` — FX delta. */ fxDelta: number; /** `∂²C/∂S_f²` — foreign-asset gamma. */ assetGamma: number; /** `∂C/∂σ_S`, per vol point. */ assetVega: number; /** `∂C/∂σ_X`, per vol point. */ fxVega: number; /** `∂C/∂ρ`, per 0.01 of correlation — the distinctive compo greek (long correlation). */ correlationVega: number; /** Per calendar day. */ theta: number; /** Domestic, per 1% rate. */ rho: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assetDelta: number; default: not declared — `∂C/∂S_f` — foreign-asset delta. - assetGamma: number; default: not declared — `∂²C/∂S_f²` — foreign-asset gamma. - assetVega: number; default: not declared — `∂C/∂σ_S`, per vol point. - correlationVega: number; default: not declared — `∂C/∂ρ`, per 0.01 of correlation — the distinctive compo greek (long correlation). - fxDelta: number; default: not declared — `∂C/∂X` — FX delta. - fxVega: number; default: not declared — `∂C/∂σ_X`, per vol point. - rho: number; default: not declared — Domestic, per 1% rate. - theta: number; default: not declared — Per calendar day. ### @insiderfinance/totalfinance/options#CompoInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for the {@link compo} composite option. ```typescript // ──────────────────────────────────────────────────────────────────────────── // Composite (compo) option — foreign asset × floating FX, domestic strike // ──────────────────────────────────────────────────────────────────────────── /** Input for the {@link compo} composite option. */ export interface CompoInput { /** Foreign-asset spot (in foreign currency). */ spot: number; /** FX rate — units of domestic currency per unit of foreign (`X₀`). */ fxSpot: number; /** Strike, in DOMESTIC currency. */ strike: number; timeToExpiryYears: number; /** Domestic discount / growth rate. */ domesticRate: number; /** Foreign-asset volatility `σ_S`. */ volatility: number; /** FX volatility `σ_X`. */ fxVolatility: number; /** Correlation between the asset and the FX rate, in `[−1, 1]`. */ correlation: number; /** Foreign dividend yield `q`. Default 0. */ dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - domesticRate: number; default: not declared — Domestic discount / growth rate. - fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - fxVolatility: number; default: not declared — FX volatility `σ_X`. - spot: number; default: not declared — Foreign-asset spot (in foreign currency). - strike: number; default: not declared — Strike, in DOMESTIC currency. - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared — Foreign-asset volatility `σ_S`. ### @insiderfinance/totalfinance/options#CompoMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Monte-Carlo options for {@link compo.monteCarloPrice}. ```typescript /** Monte-Carlo options for {@link compo.monteCarloPrice}. */ export interface CompoMonteCarloOptions extends MonteCarloSamplingOptions { /** Foreign rate used only to split the two-factor drift; the price is invariant to it. Default = `domesticRate`. */ foreignRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - foreignRate?: number; default: not declared — Foreign rate used only to split the two-factor drift; the price is invariant to it. Default = `domesticRate`. - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#ControlVariate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A control variate: a per-path quantity `fn(z)` with a known expectation `mean`. ```typescript /** A control variate: a per-path quantity `fn(z)` with a known expectation `mean`. */ export interface ControlVariate { estimate: (normalDraws: number[]) => number; mean: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - estimate: (normalDraws: number[]) => number; default: not declared - estimate(normalDraws): number[]; default: not declared - mean: number; default: not declared ### @insiderfinance/totalfinance/options#DEFAULT_OUTLIER_THRESHOLD Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Default MAD multiplier `k`: a strike whose parity residual exceeds `k·MAD` is trimmed. ```typescript export declare const DEFAULT_OUTLIER_THRESHOLD: 3.5; ``` ### @insiderfinance/totalfinance/options#DigitalInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DigitalInput { spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; /** Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. */ cash?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#DigitalKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Digital (binary) options — European cash-or-nothing / asset-or-nothing // ──────────────────────────────────────────────────────────────────────────── export type DigitalKind = 'cash-or-nothing' | 'asset-or-nothing'; ``` ### @insiderfinance/totalfinance/options#DiscreteDividend Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A discrete cash dividend with an ex-date (ISO) and per-share amount. ```typescript /** A discrete cash dividend with an ex-date (ISO) and per-share amount. */ export interface DiscreteDividend { /** * Ex-date, `YYYY-MM-DD` or a zoned ISO datetime. * * A DATE-ONLY label resolves to the US equity market OPEN, **09:30 America/New_York** — the * instant the share starts trading without the dividend. This is deliberately NOT the 16:00 ET * convention a date-only option EXPIRY uses: they are different events. The practical consequence * is that an `asOf` from 09:30 ET on the ex-date onward treats the dividend as PAID (it is already * out of the spot) and stops discounting it into the escrowed spot, while `asOf` earlier that * morning, or any time the day before, still accrues it. * * Pass a zoned datetime (e.g. `'2026-06-01T09:30:00-04:00'`) to name the instant yourself. */ exDate: string; /** Cash amount per share (must be finite and non-negative). */ amount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Cash amount per share (must be finite and non-negative). - exDate: string; default: not declared — Ex-date, `YYYY-MM-DD` or a zoned ISO datetime. A DATE-ONLY label resolves to the US equity market OPEN, **09:30 America/New_York** — the instant the share starts trading without the dividend. This is deliberately NOT the 16:00 ET convention a date-only option EXPIRY uses: they are different events. The practical consequence is that an `asOf` from 09:30 ET on the ex-date onward treats the dividend as PAID (it is already out of the spot) and stops discounting it into the escrowed spot, while `asOf` earlier that morning, or any time the day before, still accrues it. Pass a zoned datetime (e.g. `'2026-06-01T09:30:00-04:00'`) to name the instant yourself. ### @insiderfinance/totalfinance/options#DividendTermStructure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The dividend term structure across the requested expiries. ```typescript /** The dividend term structure across the requested expiries. */ export interface DividendTermStructure { /** One row per requested expiry, sorted ascending by tenor. */ points: DividendTermStructurePoint[]; /** PV of every *future* dividend in the schedule (all `τᵢ > 0`), independent of the maturities asked. */ totalDividendPresentValue: number; /** The continuous yield echoed back (`0` when none supplied). */ continuousYield: number; /** One-line, agent-relayable summary. */ summary: string; assumptions: { conventionsVersion: string; spot: number; riskFreeRate: number; continuousYield: number; dividendModel: DividendModel; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { continuousYield: number; conventionsVersion: string; dividendModel: DividendModel; riskFreeRate: number; spot: number; }; default: not declared - assumptions.continuousYield: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dividendModel: DividendModel; default: not declared - assumptions.riskFreeRate: number; default: not declared - assumptions.spot: number; default: not declared - continuousYield: number; default: not declared — The continuous yield echoed back (`0` when none supplied). - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - points: DividendTermStructurePoint[]; default: not declared — One row per requested expiry, sorted ascending by tenor. - summary: string; default: not declared — One-line, agent-relayable summary. - totalDividendPresentValue: number; default: not declared — PV of every *future* dividend in the schedule (all `τᵢ > 0`), independent of the maturities asked. ### @insiderfinance/totalfinance/options#DividendTermStructureInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link dividendTermStructure}. ```typescript /** Input for {@link dividendTermStructure}. */ export interface DividendTermStructureInput { spot: number; /** Continuously-compounded risk-free rate (decimal, e.g. `0.045`). */ riskFreeRate: number; /** Continuous dividend yield applied alongside the discrete schedule (decimal); default `0`. */ dividendYield?: number; /** Discrete cash dividends (ISO ex-date + per-share amount). Omitted / empty ⇒ continuous-only. */ dividends?: DiscreteDividend[]; /** Valuation date; ex-dates and maturities are measured from here (epoch ms or ISO). Required. */ asOf: EpochMs | string; /** The expiries (ISO dates) to report the term structure at. At least one, each after `asOf`. */ maturities: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Valuation date; ex-dates and maturities are measured from here (epoch ms or ISO). Required. - dividendYield?: number; default: not declared — Continuous dividend yield applied alongside the discrete schedule (decimal); default `0`. - dividends?: DiscreteDividend[]; default: not declared — Discrete cash dividends (ISO ex-date + per-share amount). Omitted / empty ⇒ continuous-only. - maturities: string[]; default: not declared — The expiries (ISO dates) to report the term structure at. At least one, each after `asOf`. - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - spot: number; default: not declared ### @insiderfinance/totalfinance/options#DividendTermStructurePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One expiry's row of the dividend term structure. ```typescript /** One expiry's row of the dividend term structure. */ export interface DividendTermStructurePoint { /** The maturity (ISO), echoed. */ maturity: string; /** Year fraction from `asOf` (ACT/365F). */ yearsToExpiry: number; /** PV of the discrete dividends accruing strictly before this expiry. */ dividendPresentValue: number; /** How many discrete dividends accrue strictly before this expiry. */ discreteCount: number; /** Dividend-adjusted (escrowed) forward `F(T) = (S − PV)·e^{(r−q)T}`. */ forward: number; /** The discrete schedule expressed as a continuous yield: `−ln(1−PV/S)/T`. */ discreteEquivalentYield: number; /** The single continuous yield that reproduces `F(T)`: `q + discreteEquivalentYield`. */ impliedContinuousYield: number; /** Net cost-of-carry the forward grows at: `r − impliedContinuousYield` (so `F = S·e^{carry·T}`). */ carry: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - carry: number; default: not declared — Net cost-of-carry the forward grows at: `r − impliedContinuousYield` (so `F = S·e^{carry·T}`). - discreteCount: number; default: not declared — How many discrete dividends accrue strictly before this expiry. - discreteEquivalentYield: number; default: not declared — The discrete schedule expressed as a continuous yield: `−ln(1−PV/S)/T`. - dividendPresentValue: number; default: not declared — PV of the discrete dividends accruing strictly before this expiry. - forward: number; default: not declared — Dividend-adjusted (escrowed) forward `F(T) = (S − PV)·e^{(r−q)T}`. - impliedContinuousYield: number; default: not declared — The single continuous yield that reproduces `F(T)`: `q + discreteEquivalentYield`. - maturity: string; default: not declared — The maturity (ISO), echoed. - yearsToExpiry: number; default: not declared — Year fraction from `asOf` (ACT/365F). ### @insiderfinance/totalfinance/options#DoubleTouchInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DoubleTouchInput { spot: number; /** Lower barrier `L` (> 0). */ lower: number; /** Upper barrier `U` (> L). */ upper: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; /** Payout on the winning outcome; default 1. */ cash?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cash?: number; default: not declared — Payout on the winning outcome; default 1. - dividendYield?: number; default: not declared - lower: number; default: not declared — Lower barrier `L` (> 0). - riskFreeRate: number; default: not declared - spot: number; default: not declared - timeToExpiryYears: number; default: not declared - upper: number; default: not declared — Upper barrier `U` (> L). - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#DoubleTouchKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Double one-touch / double no-touch — corridor binaries on two barriers // ──────────────────────────────────────────────────────────────────────────── export type DoubleTouchKind = 'double-no-touch' | 'double-one-touch'; ``` ### @insiderfinance/totalfinance/options#DupireOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DupireOptions { /** Log-moneyness finite-difference step (default 0.01). */ logMoneynessStep?: number; /** Time finite-difference step in years (default 1/365). */ timeStepYears?: number; /** Floor for local vol (default 1e-3) — also the clamp when a local arbitrage drives σ_loc² ≤ 0. */ floorVolatility?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - floorVolatility?: number; default: not declared — Floor for local vol (default 1e-3) — also the clamp when a local arbitrage drives σ_loc² ≤ 0. - logMoneynessStep?: number; default: not declared — Log-moneyness finite-difference step (default 0.01). - timeStepYears?: number; default: not declared — Time finite-difference step in years (default 1/365). ### @insiderfinance/totalfinance/options#EngineComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link compareEngines}: rows sorted by accuracy against a high-resolution reference. ```typescript /** Result of {@link compareEngines}: rows sorted by accuracy against a high-resolution reference. */ export interface EngineComparison { reference: { engine: string; value: number; }; rows: EngineComparisonRow[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; referenceEngine: string; engines: number; }; /** Structured warnings; always present — engine failures are summarized here (details per row). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; engines: number; referenceEngine: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.engines: number; default: not declared - assumptions.referenceEngine: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present — engine failures are summarized here (details per row). - diagnostics.warnings: QuantWarning[]; default: not declared - reference: { engine: string; value: number; }; default: not declared - reference.engine: string; default: not declared - reference.value: number; default: not declared - rows: EngineComparisonRow[]; default: not declared ### @insiderfinance/totalfinance/options#EngineComparisonRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One engine's result inside a {@link compareEngines} comparison. ```typescript /** One engine's result inside a {@link compareEngines} comparison. */ export interface EngineComparisonRow { engine: string; /** Diagnostic method label (e.g. `binomial-crr`, `crank-nicolson`). */ method: string; /** `null` when the engine failed to price — the failure rides `warnings` (Law 7: never NaN). */ value: number | null; /** Absent when the engine did not compute Greeks (e.g. a Monte-Carlo engine) or failed to price. */ greeks?: Greeks; converged: boolean; warnings: QuantWarning[]; /** Wall-clock pricing time in ms, measured only when a `now` clock is injected (else 0). */ timingMs: number; /** Signed deviation from the reference engine's value; `null` for a failed row. */ differenceFromReference: number | null; absoluteDifferenceFromReference: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDifferenceFromReference: number | null; default: not declared - converged: boolean; default: not declared - differenceFromReference: number | null; default: not declared — Signed deviation from the reference engine's value; `null` for a failed row. - engine: string; default: not declared - greeks?: Greeks; default: not declared — Absent when the engine did not compute Greeks (e.g. a Monte-Carlo engine) or failed to price. - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.rho: number; default: not declared - greeks.theta: number; default: not declared - greeks.vega: number; default: not declared - method: string; default: not declared — Diagnostic method label (e.g. `binomial-crr`, `crank-nicolson`). - timingMs: number; default: not declared — Wall-clock pricing time in ms, measured only when a `now` clock is injected (else 0). - value: number | null; default: not declared — `null` when the engine failed to price — the failure rides `warnings` (Law 7: never NaN). - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/options#EquityLattice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EquityLattice { readonly steps: number; readonly timeStepYears: number; /** Up-probability (risk-neutral). */ readonly upProbability: number; /** Underlying price at node `(stepIndex, upMoveCount)` (`upMoveCount` up-moves out of `stepIndex`). */ spotAt(stepIndex: number, upMoveCount: number): number; /** * Backward induction from the terminal step to the root. `terminal(spot)` seeds each leaf; `combine` * returns each interior node's value from its children + context (apply discounting, exercise, * conversion, default adjustment — whatever the instrument needs). Returns the root value. */ rollback(terminal: (spot: number) => number, combine: (node: LatticeNode) => number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - rollback: (terminal: (spot: number) => number, combine: (node: LatticeNode) => number) => number; default: not declared — Backward induction from the terminal step to the root. `terminal(spot)` seeds each leaf; `combine` returns each interior node's value from its children + context (apply discounting, exercise, conversion, default adjustment — whatever the instrument needs). Returns the root value. - rollback(combine): (node: LatticeNode) => number; default: not declared - rollback(terminal): (spot: number) => number; default: not declared - spotAt: (stepIndex: number, upMoveCount: number) => number; default: not declared — Underlying price at node `(stepIndex, upMoveCount)` (`upMoveCount` up-moves out of `stepIndex`). - spotAt(stepIndex): number; default: not declared - spotAt(upMoveCount): number; default: not declared - steps: number; default: not declared - timeStepYears: number; default: not declared - upProbability: number; default: not declared — Up-probability (risk-neutral). ### @insiderfinance/totalfinance/options#EquityLatticeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EquityLatticeOptions { spot: number; riskFreeRate: number; dividendYield?: number; volatility: number; /** Horizon in years. */ horizonYears: number; /** Number of time steps (default 200). */ steps?: number; /** `crr` (Cox–Ross–Rubinstein, default) or `jarrow-rudd` (equal-probability). */ variant?: LatticeVariant; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - horizonYears: number; default: not declared — Horizon in years. - riskFreeRate: number; default: not declared - spot: number; default: not declared - steps?: number; default: not declared — Number of time steps (default 200). - variant?: LatticeVariant; default: not declared — `crr` (Cox–Ross–Rubinstein, default) or `jarrow-rudd` (equal-probability). - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#ExoticMonteCarloResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A Monte-Carlo exotic result, enriched with the error statistics. ```typescript /** A Monte-Carlo exotic result, enriched with the error statistics. */ export interface ExoticMonteCarloResult extends Computed { monteCarlo: MonteCarloStatistics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - monteCarlo: MonteCarloStatistics; default: not declared - monteCarlo.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarlo.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarlo.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarlo.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarlo.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarlo.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarlo.varianceReduction.antithetic: boolean; default: not declared - monteCarlo.varianceReduction.brownianBridge: boolean; default: not declared - monteCarlo.varianceReduction.controlVariate: boolean; default: not declared - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#ExoticResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A plain exotic-pricing result: value + assumptions + diagnostics. ```typescript /** A plain exotic-pricing result: value + assumptions + diagnostics. */ export type ExoticResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#ExtendedGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extended (higher-order) Greeks (spec §9.4). ```typescript /** Extended (higher-order) Greeks (spec §9.4). */ export interface ExtendedGreeks extends Greeks { vanna: number; charm: number; vomma: number; speed: number; color: number; /** Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). */ phi: number; /** `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). */ zomma: number; /** `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. */ veta: number; /** `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). */ vera: number; /** `∂vomma/∂σ = ∂³V/∂σ³` (raw). */ ultima: number; /** * Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price * underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with * a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). */ lambda: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared - color: number; default: not declared - delta: number; default: not declared - gamma: number; default: not declared - lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - rho: number; default: not declared - speed: number; default: not declared - theta: number; default: not declared - ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - vanna: number; default: not declared - vega: number; default: not declared - vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - vomma: number; default: not declared - zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). ### @insiderfinance/totalfinance/options#Facade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#Facade`. ### @insiderfinance/totalfinance/options#FiniteDifferenceEngineOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FiniteDifferenceEngineOptions { gridPoints?: number; timeSteps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - gridPoints?: number; default: not declared - timeSteps?: number; default: not declared ### @insiderfinance/totalfinance/options#ForwardStartInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Forward-start options — strike set to α·S(t₁) at a future reset date // ──────────────────────────────────────────────────────────────────────────── export interface ForwardStartInput { spot: number; /** Strike multiplier α: the strike is set to `α·S(t₁)` at the reset (α=1 ⇒ at-the-money-at-reset). Default 1. */ strikeMultiplier?: number; /** Reset time `t₁` (years) at which the strike is fixed; must be in `(0, t)`. */ resetTime: number; /** Expiry `T` (years). */ timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - resetTime: number; default: not declared — Reset time `t₁` (years) at which the strike is fixed; must be in `(0, t)`. - riskFreeRate: number; default: not declared - spot: number; default: not declared - strikeMultiplier?: number; default: not declared — Strike multiplier α: the strike is set to `α·S(t₁)` at the reset (α=1 ⇒ at-the-money-at-reset). Default 1. - timeToExpiryYears: number; default: not declared — Expiry `T` (years). - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#GbmPathInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A geometric-Brownian-motion path from `steps` standard normals: `S[0..steps]` with `S[k+1] = S[k]·exp((r − q − ½σ²)·dt + σ·√dt·z[k])`, `dt = T/steps`. Exact (no Euler discretisation error) — GBM has lognormal increments at any step size. Expert kernel form (model-subpath surface) — the curated root surface is {@link gbm.path}. ```typescript /** * A geometric-Brownian-motion path from `steps` standard normals: `S[0..steps]` with * `S[k+1] = S[k]·exp((r − q − ½σ²)·dt + σ·√dt·z[k])`, `dt = T/steps`. Exact (no Euler discretisation * error) — GBM has lognormal increments at any step size. * * Expert kernel form (model-subpath surface) — the curated root surface is {@link gbm.path}. */ export interface GbmPathInput { spot: number; riskFreeRate: number; dividendYield: number; volatility: number; timeToExpiryYears: number; shocks: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - riskFreeRate: number; default: not declared - shocks: number[]; default: not declared - spot: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#GbmTerminalInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The terminal GBM price from a single standard normal — `gbmPath` specialised to one step. Expert kernel form (model-subpath surface) — the curated root surface is {@link gbm.terminal}. ```typescript /** * The terminal GBM price from a single standard normal — `gbmPath` specialised to one step. * * Expert kernel form (model-subpath surface) — the curated root surface is {@link gbm.terminal}. */ export interface GbmTerminalInput { spot: number; riskFreeRate: number; dividendYield: number; volatility: number; timeToExpiryYears: number; shock: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - riskFreeRate: number; default: not declared - shock: number; default: not declared - spot: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#Greeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). First-order Greeks in TotalFinance default units: - `theta` per calendar day (ACT/365F), - `vega` per 1 volatility point (1% = 0.01), - `rho` per 1% change in the rate. The applied units are always echoed in `assumptions.units`. ```typescript /** * First-order Greeks in TotalFinance default units: * - `theta` per calendar day (ACT/365F), * - `vega` per 1 volatility point (1% = 0.01), * - `rho` per 1% change in the rate. * The applied units are always echoed in `assumptions.units`. */ export interface Greeks { delta: number; gamma: number; theta: number; vega: number; rho: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared - gamma: number; default: not declared - rho: number; default: not declared - theta: number; default: not declared - vega: number; default: not declared ### @insiderfinance/totalfinance/options#HestonCosineExpansionOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for the COS analytic pricer. ```typescript /** Options for the COS analytic pricer. */ export interface HestonCosineExpansionOptions { /** Number of cosine terms (default 256, maximum 8,192; COS converges exponentially). */ terms?: number; /** Truncation width in standard deviations (default 12). */ truncation?: number; /** Compute Greeks by finite differences (default `true`). */ greeks?: boolean; /** * Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) * are w.r.t. the **vol level** — `√v₀` and `√θ` bumped together — extending the `vega` convention. The * COS price is accurate, so the finite differences are converged (verified stable across term counts). */ extendedGreeks?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the **vol level** — `√v₀` and `√θ` bumped together — extending the `vega` convention. The COS price is accurate, so the finite differences are converged (verified stable across term counts). - greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192; COS converges exponentially). - truncation?: number; default: not declared — Truncation width in standard deviations (default 12). ### @insiderfinance/totalfinance/options#HestonInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market inputs for a Heston computation. ```typescript /** Market inputs for a Heston computation. */ export interface HestonInput { spot: number; strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; riskFreeRate: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/options#HestonMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for the QE Monte-Carlo pricer. ```typescript /** Options for the QE Monte-Carlo pricer. */ export interface HestonMonteCarloOptions extends MonteCarloSamplingOptions { /** Time steps per path (default 64). */ steps?: number; /** Compute Greeks by common-random-number finite differences (default `false` — MC Greeks are noisy). */ greeks?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `false` — MC Greeks are noisy). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. - steps?: number; default: not declared — Time steps per path (default 64). ### @insiderfinance/totalfinance/options#HestonMonteCarloResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A Heston MC result enriched with the Monte-Carlo error statistics. ```typescript /** A Heston MC result enriched with the Monte-Carlo error statistics. */ export interface HestonMonteCarloResult extends PriceResult { monteCarlo: MonteCarloStatistics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks?: Greeks | ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarlo: MonteCarloStatistics; default: not declared - monteCarlo.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarlo.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarlo.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarlo.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarlo.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarlo.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarlo.varianceReduction.antithetic: boolean; default: not declared - monteCarlo.varianceReduction.brownianBridge: boolean; default: not declared - monteCarlo.varianceReduction.controlVariate: boolean; default: not declared - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#HestonParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Heston parameters (variances, not volatilities). ```typescript /** Heston parameters (variances, not volatilities). */ export interface HestonParameters { /** Initial instantaneous variance v₀ (= σ₀²). */ v0: number; /** Mean-reversion speed κ. */ kappa: number; /** Long-run variance θ. */ theta: number; /** Volatility of variance ξ ("vol of vol"). */ sigma: number; /** Spot/variance correlation ρ ∈ [−1, 1]. */ rho: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kappa: number; default: not declared — Mean-reversion speed κ. - rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - theta: number; default: not declared — Long-run variance θ. - v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). ### @insiderfinance/totalfinance/options#ImpliedBorrowOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link impliedBorrow} — adds the spot used in diagnostics. ```typescript /** Options for {@link impliedBorrow} — adds the spot used in diagnostics. */ export interface ImpliedBorrowOptions extends ImpliedForwardOptions { spot: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. - outlierThreshold?: number; default: not declared — MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate. - source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). - spot: number; default: not declared ### @insiderfinance/totalfinance/options#ImpliedDividendYieldOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link impliedDividendYield} — adds the spot needed to back out `q`. ```typescript /** Options for {@link impliedDividendYield} — adds the spot needed to back out `q`. */ export interface ImpliedDividendYieldOptions extends ImpliedForwardOptions { spot: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. - outlierThreshold?: number; default: not declared — MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate. - source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). - spot: number; default: not declared ### @insiderfinance/totalfinance/options#ImpliedForwardOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options shared by the regression-based parity functions. ```typescript /** Options shared by the regression-based parity functions. */ export interface ImpliedForwardOptions { /** Continuously-compounded risk-free rate. */ riskFreeRate: number; /** Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. */ asOf: EpochMs | string; /** Quote price source per leg (default `mid`). */ source?: PriceSource; /** MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). */ outlierThreshold?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time (epoch ms, 'YYYY-MM-DD', or zoned ISO datetime); time-to-expiry is measured from here under ACT/365F. - outlierThreshold?: number; default: not declared — MAD multiplier for outlier trimming (default {@link DEFAULT_OUTLIER_THRESHOLD}). - riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate. - source?: PriceSource; default: not declared — Quote price source per leg (default `mid`). ### @insiderfinance/totalfinance/options#ImpliedVolatilityDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ImpliedVolatilityDiagnostics { engine: string; /** The method actually used (may differ from the requested method after a fallback). */ method: string; converged: boolean; iterations: number; /** Whether a fallback path was taken. */ fallback: boolean; warnings: QuantWarning[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared - engine: string; default: not declared - fallback: boolean; default: not declared — Whether a fallback path was taken. - iterations: number; default: not declared - method: string; default: not declared — The method actually used (may differ from the requested method after a fallback). - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/options#ImpliedVolatilityFunction Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A market implied-volatility surface as a function of strike and time-to-expiry (years). ```typescript /** A market implied-volatility surface as a function of strike and time-to-expiry (years). */ export type ImpliedVolatilityFunction = (strike: number, timeToExpiryYears: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (strike): number; default: not declared - (timeToExpiryYears): number; default: not declared ### @insiderfinance/totalfinance/options#ImpliedVolatilityMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ImpliedVolatilityMethod = 'auto' | 'brent' | 'newton' | 'halley' | 'householder'; ``` ### @insiderfinance/totalfinance/options#ImpliedVolatilityOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link impliedVolatilityOption} — one object: `{ contract, market, ...solver options }`. ```typescript /** * Solve implied volatility from `market.price`, returning a rich envelope with diagnostics. Routes on * contract style and on whether an engine is named (WS4.2): a European contract with no engine * inverts closed-form Black–Scholes–Merton (`method` chooses `auto`/`brent`/`newton`/`halley`/ * `householder`, `fallback` and `failFast` shape it); an American contract, or any contract with an * `engine`, inverts that engine (default Bjerksund–Stensland 2002 for American) over a safeguarded * Brent bracket, where the closed-form knobs do not apply and are refused. The engine and * actually-used method are reported in `diagnostics`. */ /** Input for {@link impliedVolatilityOption} — one object: `{ contract, market, ...solver options }`. */ export interface ImpliedVolatilityOptionInput extends ImpliedVolatilityOptions { contract: OptionContract; market: OptionMarket; /** * Engine to invert numerically. An American contract always inverts an engine (default * `engines.bjerksundStensland2002()`); a European contract inverts closed-form * Black–Scholes–Merton unless an engine is named here, in which case THAT engine is inverted — * e.g. a lattice for discrete dividends, or a custom model. `method`/`fallback`/`failFast` belong * to the closed-form route and are refused alongside an engine. */ engine?: OptionPricingEngine; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - engine?: OptionPricingEngine; default: not declared — Engine to invert numerically. An American contract always inverts an engine (default `engines.bjerksundStensland2002()`); a European contract inverts closed-form Black–Scholes–Merton unless an engine is named here, in which case THAT engine is inverted — e.g. a lattice for discrete dividends, or a custom model. `method`/`fallback`/`failFast` belong to the closed-form route and are refused alongside an engine. - engine.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engine.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engine.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engine.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engine.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engine.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engine.name: string; default: not declared - engine.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => PriceResult; default: not declared - engine.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - engine.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - engine.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - engine.price().return.greeks.charm: number; default: not declared - engine.price().return.greeks.color: number; default: not declared - engine.price().return.greeks.delta: number; default: not declared - engine.price().return.greeks.gamma: number; default: not declared - engine.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - engine.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - engine.price().return.greeks.rho: number; default: not declared - engine.price().return.greeks.speed: number; default: not declared - engine.price().return.greeks.theta: number; default: not declared - engine.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - engine.price().return.greeks.vanna: number; default: not declared - engine.price().return.greeks.vega: number; default: not declared - engine.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - engine.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - engine.price().return.greeks.vomma: number; default: not declared - engine.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - engine.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - engine.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - engine.price(input): import('@insiderfinance/totalfinance/options').OptionEnginePriceInput; default: not declared - engine.price(input).contract: OptionContract; default: not declared - engine.price(input).market: OptionMarket; default: not declared - engine.price(input).options?: PriceOptions; default: not declared - engine.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engine.supports(contract): OptionContract; default: not declared - engine.supports(contract).adjusted?: boolean; default: not declared - engine.supports(contract).currency?: string; default: not declared - engine.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - engine.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - engine.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - engine.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - engine.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - engine.supports(contract).multiplier?: number; default: not declared - engine.supports(contract).occSymbol?: string; default: not declared - engine.supports(contract).root?: string; default: not declared - engine.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - engine.supports(contract).strike: number; default: not declared - engine.supports(contract).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - engine.supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - engine.supports(contract).underlying: string; default: not declared - engine.version: string; default: not declared - failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared ### @insiderfinance/totalfinance/options#ImpliedVolatilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ImpliedVolatilityOptions { method?: ImpliedVolatilityMethod; /** Fall back to Brent when a derivative method fails (default `true`). */ fallback?: boolean; /** In batch mode, throw on the first bad row instead of recording it (default `false`). */ failFast?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - method?: ImpliedVolatilityMethod; default: not declared ### @insiderfinance/totalfinance/options#ImpliedVolatilityReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ImpliedVolatilityReason = 'below_intrinsic' | 'above_max_bound' /** * The target premium is smaller than the model price at the lowest σ the solver represents, so no * volatility in the bracket reproduces it (the σ→0 floor sits ABOVE the target). Distinct from * `below_intrinsic` (a no-arbitrage violation) and from `no_bracket` (no usable bracket was * established; see `message` for precision limits). The no_bracket reason does not assert that a root exists. */ | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; ``` ### @insiderfinance/totalfinance/options#ImpliedVolatilityResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of a pro `option.impliedVolatility(...)` call. ```typescript /** Result of a pro `option.impliedVolatility(...)` call. */ export type ImpliedVolatilityResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#ImpliedVolatilitySolveResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `value` is `null` when the solve failed (no-arbitrage violation / no convergence) — the reason rides `diagnostics` (`converged: false` + a warning). Never NaN (Law 7 / E3). ```typescript /** `value` is `null` when the solve failed (no-arbitrage violation / no convergence) — the * reason rides `diagnostics` (`converged: false` + a warning). Never NaN (Law 7 / E3). */ export type ImpliedVolatilitySolveResult = Computed & { diagnostics: ImpliedVolatilityDiagnostics; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: (ImpliedVolatilityDiagnostics) | (import('@insiderfinance/totalfinance/core').Diagnostics); default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.fallback: boolean; default: not declared — Whether a fallback path was taken. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. The method actually used (may differ from the requested method after a fallback). - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#InstrumentBuilderInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Instrument-builder input: the convention lives in the builder name, so no `style` here. ```typescript /** Instrument-builder input: the convention lives in the builder name, so no `style` here. */ export type InstrumentBuilderInput = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - currency?: string; default: not declared - expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - multiplier?: number; default: not declared - root?: string; default: not declared - strike: number; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/options#InverseGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An inverse option's risk in both denominations. ```typescript /** An inverse option's risk in both denominations. */ export interface InverseGreeks { /** * Coin-denominated greeks — derivatives of the coin premium `V_usd/S`. delta/gamma are raw (per $1 * move in spot), vega/1%, theta/day, rho/1%. The delta carries the `−V_coin/S` correction (the * embedded short-coin from paying premium in the coin), so it is NOT the Black–Scholes delta. */ coin: Greeks; /** USD-linear greeks — equal to the vanilla BSM greeks, since the inverse option's USD payoff is a vanilla's. */ usd: Greeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coin: Greeks; default: not declared — Coin-denominated greeks — derivatives of the coin premium `V_usd/S`. delta/gamma are raw (per $1 move in spot), vega/1%, theta/day, rho/1%. The delta carries the `−V_coin/S` correction (the embedded short-coin from paying premium in the coin), so it is NOT the Black–Scholes delta. - coin.delta: number; default: not declared - coin.gamma: number; default: not declared - coin.rho: number; default: not declared - coin.theta: number; default: not declared - coin.vega: number; default: not declared - usd: Greeks; default: not declared — USD-linear greeks — equal to the vanilla BSM greeks, since the inverse option's USD payoff is a vanilla's. - usd.delta: number; default: not declared - usd.gamma: number; default: not declared - usd.rho: number; default: not declared - usd.theta: number; default: not declared - usd.vega: number; default: not declared ### @insiderfinance/totalfinance/options#InverseOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for the {@link inverseOption} coin-settled option. ```typescript // ──────────────────────────────────────────────────────────────────────────── // Inverse (coin-settled / Deribit-style) options // ──────────────────────────────────────────────────────────────────────────── /** Input for the {@link inverseOption} coin-settled option. */ export interface InverseOptionInput { /** Underlying spot, quote per coin (e.g. BTC/USD). */ spot: number; /** Strike, in the QUOTE currency (USD). */ strike: number; timeToExpiryYears: number; /** USD (quote-currency) risk-free rate. */ riskFreeRate: number; /** Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. */ coinYield?: number; /** Volatility. */ volatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - strike: number; default: not declared — Strike, in the QUOTE currency (USD). - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared — Volatility. ### @insiderfinance/totalfinance/options#InverseOptionMonteCarloOptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Monte-Carlo options for {@link inverseOption.monteCarloPrice}. ```typescript /** Monte-Carlo options for {@link inverseOption.monteCarloPrice}. */ export type InverseOptionMonteCarloOptions = MonteCarloSamplingOptions; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#LatticeNode Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-node context handed to a {@link EquityLattice.rollback} combiner. ```typescript /** Per-node context handed to a {@link EquityLattice.rollback} combiner. */ export interface LatticeNode { /** Time step index (0 = today). */ stepIndex: number; /** Up-move count at the node (`0..stepIndex`). */ upMoveCount: number; /** Underlying price at the node. */ spot: number; /** Node time in years (`i·dt`). */ timeToExpiryYears: number; /** Continuation value from the upper child. */ up: number; /** Continuation value from the lower child. */ down: number; /** Risk-neutral up-probability. */ upProbability: number; /** Per-step discount factor `e^{−r·dt}`. */ discount: number; /** Step length in years. */ timeStepYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discount: number; default: not declared — Per-step discount factor `e^{−r·dt}`. - down: number; default: not declared — Continuation value from the lower child. - spot: number; default: not declared — Underlying price at the node. - stepIndex: number; default: not declared — Time step index (0 = today). - timeStepYears: number; default: not declared — Step length in years. - timeToExpiryYears: number; default: not declared — Node time in years (`i·dt`). - up: number; default: not declared — Continuation value from the upper child. - upMoveCount: number; default: not declared — Up-move count at the node (`0..stepIndex`). - upProbability: number; default: not declared — Risk-neutral up-probability. ### @insiderfinance/totalfinance/options#LatticeVariant Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type LatticeVariant = 'crr' | 'jarrow-rudd'; ``` ### @insiderfinance/totalfinance/options#LocalVolatilityFunction Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Local volatility as a function of underlying level and time (years). ```typescript /** Local volatility as a function of underlying level and time (years). */ export type LocalVolatilityFunction = (level: number, timeToExpiryYears: number) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (level): number; default: not declared - (timeToExpiryYears): number; default: not declared ### @insiderfinance/totalfinance/options#LocalVolatilityGridSpecification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Grid specification for {@link localVolatilityGrid}: strictly-ascending level and time knots. ```typescript /** Grid specification for {@link localVolatilityGrid}: strictly-ascending level and time knots. */ export interface LocalVolatilityGridSpecification { /** Underlying levels, ascending (e.g. 0.4·S₀ … 2.5·S₀). */ levels: number[]; /** Times in years, ascending (e.g. up to the longest expiry priced). */ times: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - levels: number[]; default: not declared — Underlying levels, ascending (e.g. 0.4·S₀ … 2.5·S₀). - times: number[]; default: not declared — Times in years, ascending (e.g. up to the longest expiry priced). ### @insiderfinance/totalfinance/options#LocalVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market inputs for a local-volatility MC price. ```typescript /** Market inputs for a local-volatility MC price. */ export interface LocalVolatilityInput { spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/options#LocalVolatilityMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market context the Dupire transform needs to convert strikes to moneyness. ```typescript /** Market context the Dupire transform needs to convert strikes to moneyness. */ export interface LocalVolatilityMarket { spot: number; riskFreeRate: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/options#LocalVolatilityMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LocalVolatilityMonteCarloOptions extends MonteCarloSamplingOptions { /** Time steps per path (default 100). */ steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. - steps?: number; default: not declared — Time steps per path (default 100). ### @insiderfinance/totalfinance/options#LocalVolatilityMonteCarloResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A local-volatility MC result enriched with the Monte-Carlo error statistics. ```typescript /** A local-volatility MC result enriched with the Monte-Carlo error statistics. */ export interface LocalVolatilityMonteCarloResult extends PriceResult { monteCarlo: MonteCarloStatistics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarlo: MonteCarloStatistics; default: not declared - monteCarlo.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarlo.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarlo.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarlo.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarlo.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarlo.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarlo.varianceReduction.antithetic: boolean; default: not declared - monteCarlo.varianceReduction.brownianBridge: boolean; default: not declared - monteCarlo.varianceReduction.controlVariate: boolean; default: not declared - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#LookbackInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LookbackInput { spot: number; /** Strike (fixed-strike lookbacks only). */ strike?: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; /** Running minimum observed so far (default = spot, a newly-issued option). */ runningMin?: number; /** Running maximum observed so far (default = spot). */ runningMax?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - runningMax?: number; default: not declared — Running maximum observed so far (default = spot). - runningMin?: number; default: not declared — Running minimum observed so far (default = spot, a newly-issued option). - spot: number; default: not declared - strike?: number; default: not declared — Strike (fixed-strike lookbacks only). - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#LookbackMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LookbackMonteCarloOptions extends MonteCarloSamplingOptions { /** Monitoring steps per path (default 150). */ steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. - steps?: number; default: not declared — Monitoring steps per path (default 150). ### @insiderfinance/totalfinance/options#LookbackStrike Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Lookback options // ──────────────────────────────────────────────────────────────────────────── export type LookbackStrike = 'floating' | 'fixed'; ``` ### @insiderfinance/totalfinance/options#MonteCarloEstimate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The raw estimate returned by {@link monteCarloEstimate}, before it is wrapped in a pricing envelope. ```typescript /** The raw estimate returned by {@link monteCarloEstimate}, before it is wrapped in a pricing envelope. */ export interface MonteCarloEstimate extends MonteCarloStatistics { value: number; /** Whether the estimate is trustworthy (finite value and standard error). */ converged: boolean; /** Structured warnings (e.g. a QMC dimension fallback). */ warnings: QuantWarning[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - method: MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - seed: number; default: not declared — The seed, echoed for reproducibility. - standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - value: number; default: not declared - varianceReduction: VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - varianceReduction.antithetic: boolean; default: not declared - varianceReduction.brownianBridge: boolean; default: not declared - varianceReduction.controlVariate: boolean; default: not declared - warnings: QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). ### @insiderfinance/totalfinance/options#MonteCarloMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sampling strategy for a Monte-Carlo estimate. ```typescript /** Sampling strategy for a Monte-Carlo estimate. */ export type MonteCarloMethod = 'pseudo' | 'sobol' | 'halton'; ``` ### @insiderfinance/totalfinance/options#MonteCarloPriceOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link monteCarloPrice}. Extends the shared MC sampling options. ```typescript /** Options for {@link monteCarloPrice}. Extends the shared MC sampling options. */ export interface MonteCarloPriceOptions extends MonteCarloSamplingOptions { /** Compute Greeks by common-random-number finite differences (default `true`). */ greeks?: boolean; /** * Compute the full higher-order (extended) Greek set by CRN finite differences (implies `greeks`). * Third-order Greeks (speed/color/ultima) carry more Monte-Carlo error than the first/second order — * raise `paths` when you need them tight. */ extendedGreeks?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set by CRN finite differences (implies `greeks`). Third-order Greeks (speed/color/ultima) carry more Monte-Carlo error than the first/second order — raise `paths` when you need them tight. - greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `true`). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#MonteCarloPriceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A pricing result enriched with the Monte-Carlo error statistics. ```typescript /** A pricing result enriched with the Monte-Carlo error statistics. */ export interface MonteCarloPriceResult extends PriceResult { /** Standard error, confidence interval, path count, seed, method, and variance-reduction flags. */ monteCarlo: MonteCarloStatistics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks?: Greeks | ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarlo: MonteCarloStatistics; default: not declared — Standard error, confidence interval, path count, seed, method, and variance-reduction flags. - monteCarlo.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarlo.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarlo.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarlo.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarlo.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarlo.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarlo.varianceReduction.antithetic: boolean; default: not declared - monteCarlo.varianceReduction.brownianBridge: boolean; default: not declared - monteCarlo.varianceReduction.controlVariate: boolean; default: not declared - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#MonteCarloRandomNumberGenerator Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pseudo-random generator choice for `method: 'pseudo'`. ```typescript /** Pseudo-random generator choice for `method: 'pseudo'`. */ export type MonteCarloRandomNumberGenerator = 'mulberry32' | 'xoshiro128'; ``` ### @insiderfinance/totalfinance/options#MonteCarloSamplingOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options shared by every Monte-Carlo pricer. ```typescript /** Options shared by every Monte-Carlo pricer. */ export interface MonteCarloSamplingOptions { /** Number of paths (antithetic pairs when `antithetic`). Default 50_000. */ paths?: number; /** Seed — required and echoed for reproducibility. */ seed: number; /** Sampling method (default `'pseudo'`). */ method?: MonteCarloMethod; /** Antithetic variates (pseudo only; ignored for QMC). Default `true`. */ antithetic?: boolean; /** Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). */ brownianBridge?: boolean; /** Confidence level for the interval (default 0.95). */ confidence?: number; /** PRNG for `method: 'pseudo'` (default `'mulberry32'`). */ randomNumberGenerator?: MonteCarloRandomNumberGenerator; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#MonteCarloStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The diagnostics block shared by every Monte-Carlo result. ```typescript /** The diagnostics block shared by every Monte-Carlo result. */ export interface MonteCarloStatistics { /** * Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). * * The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is * deterministic and negatively correlated by construction, so that formula does not estimate its * error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a * confidence interval built from it was neither a confidence nor an interval. QMC error is * estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS * independent randomizations — which this estimator does not do, so it reports `null` and says so. */ standardError: number | null; /** Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. */ confidenceInterval: [ number, number ] | null; /** Number of paths actually evaluated (antithetic pairs count as one path). */ paths: number; /** The seed, echoed for reproducibility. */ seed: number; /** The sampling method actually used (may differ from the request if QMC fell back to pseudo). */ method: MonteCarloMethod; /** Which variance-reduction techniques were applied. */ varianceReduction: VarianceReduction; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - method: MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - seed: number; default: not declared — The seed, echoed for reproducibility. - standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - varianceReduction: VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - varianceReduction.antithetic: boolean; default: not declared - varianceReduction.brownianBridge: boolean; default: not declared - varianceReduction.controlVariate: boolean; default: not declared ### @insiderfinance/totalfinance/options#MultiAssetInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── basket & rainbow (multi-asset Monte-Carlo) ───────────────────────── export interface MultiAssetInput { spots: number[]; strike: number; timeToExpiryYears: number; riskFreeRate: number; volatilities: number[]; /** Correlation matrix (n × n, symmetric, unit diagonal, positive definite). */ correlation: number[][]; dividendYields?: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - dividendYields?: number[]; default: not declared - riskFreeRate: number; default: not declared - spots: number[]; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatilities: number[]; default: not declared ### @insiderfinance/totalfinance/options#NapoleonInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link napoleon} and {@link reverseCliquet} (same shape; the coupon is degraded differently). ```typescript // ──────────────────────────────────────────────────────────────────────────── // Napoleon & reverse cliquet — coupon-degraded cliquet structures (short vol) // ──────────────────────────────────────────────────────────────────────────── /** Input for {@link napoleon} and {@link reverseCliquet} (same shape; the coupon is degraded differently). */ export interface NapoleonInput { spot: number; /** Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. */ resetTimes: number[]; riskFreeRate: number; volatility: number; dividendYield?: number; /** The fixed coupon degraded by the period returns. */ coupon: number; /** Floor on the payoff. Default 0 (the note cannot pay less than 0). */ globalFloor?: number; /** Notional multiplier. Default 1. */ notional?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coupon: number; default: not declared — The fixed coupon degraded by the period returns. - dividendYield?: number; default: not declared - globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - notional?: number; default: not declared — Notional multiplier. Default 1. - resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#OptionBatchColumns Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Struct-of-arrays columnar batch input. `type`: 1 = call, ≤ 0 = put. ```typescript /** Struct-of-arrays columnar batch input. `type`: 1 = call, ≤ 0 = put. */ export interface OptionBatchColumns { spot: Float64Array; strike: Float64Array; volatility: Float64Array; riskFreeRate: Float64Array; /** Time to expiry in years. */ timeToExpiryYears: Float64Array; type: Int8Array; /** Optional per-row continuous dividend yield (defaults to 0). */ dividendYield?: Float64Array; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - riskFreeRate: Float64Array; default: not declared - spot: Float64Array; default: not declared - strike: Float64Array; default: not declared - timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - type: Int8Array; default: not declared - volatility: Float64Array; default: not declared ### @insiderfinance/totalfinance/options#OptionBatchResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionBatchResult { price: Float64Array; delta?: Float64Array; gamma?: Float64Array; theta?: Float64Array; vega?: Float64Array; rho?: Float64Array; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta?: Float64Array; default: not declared - gamma?: Float64Array; default: not declared - price: Float64Array; default: not declared - rho?: Float64Array; default: not declared - theta?: Float64Array; default: not declared - vega?: Float64Array; default: not declared ### @insiderfinance/totalfinance/options#OptionBuilderInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionBuilderInput { underlying: string; strike: number; /** Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. */ expiry: string; /** * REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its * INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the * 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. */ convention?: 'us-equity-close'; /** * REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put * is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you * want the convention encoded in the builder's name instead. */ style: OptionStyle; multiplier?: number; currency?: string; root?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - currency?: string; default: not declared - expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - multiplier?: number; default: not declared - root?: string; default: not declared - strike: number; default: not declared - style: OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - underlying: string; default: not declared ### @insiderfinance/totalfinance/options#OptionChainHealthConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainHealthConfig { /** * Omit for quote-only health. `'black-scholes-merton'` names the dynamics: European rows invert * closed-form Black–Scholes–Merton and American rows invert the Bjerksund–Stensland 2002 engine * under the same dynamics, each inside its own style's no-arbitrage band. No row is ever priced * as the other exercise style. */ model?: 'black-scholes-merton'; /** No fallback to last/mark. mid uses explicit mid, otherwise the bid/ask midpoint. */ priceSource: PriceSource; /** Non-negative elapsed milliseconds; stale iff age strictly exceeds this threshold. */ maximumQuoteAgeMs: number; /** Non-negative spread / bid-ask midpoint ratio; wide iff strictly greater. */ maximumRelativeSpread: number; /** Default 1; positive safe integer ≤10,000. Distinct expiration instants, including expired ones. */ minimumExpiries?: number; /** Default 1; positive safe integer ≤10,000; per expiration instant AND exercise style. */ minimumStrikesPerExpiry?: number; /** Optional smaller row budget; default and hard ceiling 10,000. No silent truncation. */ maximumQuotes?: number; /** Model rows only. Closed optional σ bracket; defaults 1e-7 and 5, hard bounds, never expanded. */ solver?: { lowerVolatilityBound?: number; upperVolatilityBound?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumQuoteAgeMs: number; default: not declared — Non-negative elapsed milliseconds; stale iff age strictly exceeds this threshold. - maximumQuotes?: number; default: not declared — Optional smaller row budget; default and hard ceiling 10,000. No silent truncation. - maximumRelativeSpread: number; default: not declared — Non-negative spread / bid-ask midpoint ratio; wide iff strictly greater. - minimumExpiries?: number; default: not declared — Default 1; positive safe integer ≤10,000. Distinct expiration instants, including expired ones. - minimumStrikesPerExpiry?: number; default: not declared — Default 1; positive safe integer ≤10,000; per expiration instant AND exercise style. - model?: 'black-scholes-merton'; default: not declared — Omit for quote-only health. `'black-scholes-merton'` names the dynamics: European rows invert closed-form Black–Scholes–Merton and American rows invert the Bjerksund–Stensland 2002 engine under the same dynamics, each inside its own style's no-arbitrage band. No row is ever priced as the other exercise style. - priceSource: PriceSource; default: not declared — No fallback to last/mark. mid uses explicit mid, otherwise the bid/ask midpoint. - solver?: { lowerVolatilityBound?: number; upperVolatilityBound?: number; }; default: not declared — Model rows only. Closed optional σ bracket; defaults 1e-7 and 5, hard bounds, never expanded. - solver.lowerVolatilityBound?: number; default: not declared - solver.upperVolatilityBound?: number; default: not declared ### @insiderfinance/totalfinance/options#OptionChainHealthContract Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pricing identity only: accounting/venue metadata is not used to scale or interpret premiums. ```typescript /** Pricing identity only: accounting/venue metadata is not used to scale or interpret premiums. */ export type OptionChainHealthContract = Pick; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - strike: number; default: not declared - style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/options#OptionChainHealthExpiryCoverage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainHealthExpiryCoverage { expiresAt: number; style: OptionContract['style']; expired: boolean; quoteCount: number; selectedPriceCount: number; solvedCount: number; strikes: number[]; callStrikes: number[]; putStrikes: number[]; /** Missing side at an observed strike, NOT proof that the exchange lists that side. */ missingCallStrikes: number[]; missingPutStrikes: number[]; belowMinimumStrikes: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - belowMinimumStrikes: boolean; default: not declared - callStrikes: number[]; default: not declared - expired: boolean; default: not declared - expiresAt: number; default: not declared - missingCallStrikes: number[]; default: not declared — Missing side at an observed strike, NOT proof that the exchange lists that side. - missingPutStrikes: number[]; default: not declared - putStrikes: number[]; default: not declared - quoteCount: number; default: not declared - selectedPriceCount: number; default: not declared - solvedCount: number; default: not declared - strikes: number[]; default: not declared - style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared ### @insiderfinance/totalfinance/options#OptionChainHealthInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionChainHealthInput = { /** Dense, open observation records. Unconsumed provider metadata is neither traversed nor copied. */ quotes: readonly OptionChainHealthQuote[]; /** Optional dense explicit universe (≤10,000). No exchange listing universe is inferred. */ expectedContracts?: readonly OptionContract[]; } & ({ market: OptionChainHealthModelMarket; config: OptionChainHealthConfig & { model: 'black-scholes-merton'; }; } | { market: OptionChainHealthMarket; config: OptionChainHealthConfig & { model?: never; solver?: never; }; }); ``` ### @insiderfinance/totalfinance/options#OptionChainHealthIssue Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionChainHealthIssue = 'stale' | 'future' | 'missing_timestamp' | 'missing_bid' | 'missing_ask' | 'missing_price' | 'crossed' | 'wide' | 'expired'; ``` ### @insiderfinance/totalfinance/options#OptionChainHealthMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainHealthMarket extends Pick { /** All quote and expected-contract underlyings must match exactly. */ underlying: string; /** Required only when BSM assessment is requested. */ spot?: number; /** Annual continuous risk-free rate, decimal; required only for BSM assessment. */ riskFreeRate?: number; /** * Annual continuous yield, decimal. The package dividend rule applies: omitted means 0 (no * continuous yield), echoed in `assumptions.dividendYield` and disclosed by a warning when the * model assessment defaulted it. */ dividendYield?: number; /** Nonempty cash schedules are validated but explicitly unsupported by this BSM report. */ dividends?: readonly DiscreteDividend[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - dividendYield?: number; default: not declared — Annual continuous yield, decimal. The package dividend rule applies: omitted means 0 (no continuous yield), echoed in `assumptions.dividendYield` and disclosed by a warning when the model assessment defaulted it. - dividends?: readonly DiscreteDividend[]; default: not declared — Nonempty cash schedules are validated but explicitly unsupported by this BSM report. - riskFreeRate?: number; default: not declared — Annual continuous risk-free rate, decimal; required only for BSM assessment. - spot?: number; default: not declared — Required only when BSM assessment is requested. - underlying: string; default: not declared — All quote and expected-contract underlyings must match exactly. ### @insiderfinance/totalfinance/options#OptionChainHealthModelMarket Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The model path requires real caller-supplied economics; the quote-only path does not. ```typescript /** The model path requires real caller-supplied economics; the quote-only path does not. */ export type OptionChainHealthModelMarket = OptionChainHealthMarket & Required>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - dividendYield?: number; default: not declared — Annual continuous yield, decimal. The package dividend rule applies: omitted means 0 (no continuous yield), echoed in `assumptions.dividendYield` and disclosed by a warning when the model assessment defaulted it. - dividends?: readonly DiscreteDividend[]; default: not declared — Nonempty cash schedules are validated but explicitly unsupported by this BSM report. - riskFreeRate?: number; default: not declared — Annual continuous risk-free rate, decimal; required only for BSM assessment. - spot?: number; default: not declared — Required only when BSM assessment is requested. - underlying: string; default: not declared — All quote and expected-contract underlyings must match exactly. ### @insiderfinance/totalfinance/options#OptionChainHealthModelResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainHealthModelResult { /** Compatibility with the specified model, NOT a verdict that a market observation is bad. */ status: OptionChainHealthModelStatus; /** * The engine this row's bounds and inverse come from under the requested dynamics — closed-form * BSM for a European contract, Bjerksund–Stensland 2002 for an American one. Null when no model * assessment was requested. */ engine: 'black-scholes-merton' | 'bjerksund-stensland-2002' | null; /** * The style's no-arbitrage price band per underlying share, or null when not evaluable: the * discounted band for a European row, the undiscounted intrinsic-to-spot/strike band for an * American row. */ bounds: { lower: number; upper: number; } | null; /** Every applicable unsupported assumption, not just the first one encountered. */ unsupportedReasons: ('discrete_dividends' | 'adjusted_deliverable')[]; impliedVolatility: number | null; solver: { status: 'converged' | 'not-run' | 'unavailable' | 'failed'; /** null when no model assessment was requested. */ method: 'brent' | null; converged: boolean; iterations: number; /** Null only on success. Failed inverses never receive a guessed or supplied IV. */ reason: string | null; /** Absolute repricing residual per share; null if no finite solve was accepted. */ priceResidual: number | null; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds: { lower: number; upper: number; } | null; default: not declared — The style's no-arbitrage price band per underlying share, or null when not evaluable: the discounted band for a European row, the undiscounted intrinsic-to-spot/strike band for an American row. - bounds.lower: number; default: not declared - bounds.upper: number; default: not declared - engine: 'black-scholes-merton' | 'bjerksund-stensland-2002' | null; default: not declared — The engine this row's bounds and inverse come from under the requested dynamics — closed-form BSM for a European contract, Bjerksund–Stensland 2002 for an American one. Null when no model assessment was requested. - impliedVolatility: number | null; default: not declared - solver: { status: 'converged' | 'not-run' | 'unavailable' | 'failed'; method: 'brent' | null; converged: boolean; iterations: number; reason: string | null; priceResidual: number | null; }; default: not declared - solver.converged: boolean; default: not declared - solver.iterations: number; default: not declared - solver.method: 'brent' | null; default: not declared — null when no model assessment was requested. - solver.priceResidual: number | null; default: not declared — Absolute repricing residual per share; null if no finite solve was accepted. - solver.reason: string | null; default: not declared — Null only on success. Failed inverses never receive a guessed or supplied IV. - solver.status: 'unavailable' | 'failed' | 'converged' | 'not-run'; default: not declared - status: OptionChainHealthModelStatus; default: not declared — Compatibility with the specified model, NOT a verdict that a market observation is bad. - unsupportedReasons: ('discrete_dividends' | 'adjusted_deliverable')[]; default: not declared — Every applicable unsupported assumption, not just the first one encountered. ### @insiderfinance/totalfinance/options#OptionChainHealthModelStatus Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionChainHealthModelStatus = 'not-requested' | 'compatible' | 'model-incompatible' | 'unsupported' | 'not-evaluated' | 'unavailable'; ``` ### @insiderfinance/totalfinance/options#OptionChainHealthQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical quote fields; only timestamp absence is relaxed so it can be reported honestly. ```typescript /** Canonical quote fields; only timestamp absence is relaxed so it can be reported honestly. */ export interface OptionChainHealthQuote extends Omit { /** Epoch milliseconds when known. Missing is reported, never replaced by market.asOf. */ timestampMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ask?: number; default: not declared - askSize?: number; default: not declared - bid?: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - exchange?: string; default: not declared - greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - greeks.delta: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.provenance?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeksProvenance; default: not declared - greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - impliedVolatility?: number; default: not declared - last?: number; default: not declared - mark?: number; default: not declared - mid?: number; default: not declared - openInterest?: number; default: not declared - timestampMs?: number; default: not declared — Epoch milliseconds when known. Missing is reported, never replaced by market.asOf. - underlyingPrice?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/options#OptionChainHealthReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Concrete report shape, directly assignable to createAnalysisArtifact's result without a cast. ```typescript /** Concrete report shape, directly assignable to createAnalysisArtifact's result without a cast. */ export type OptionChainHealthReport = { rows: OptionChainHealthRow[]; summary: { quoteCount: number; quotesWithIssues: number; issueCounts: Record; modelStatusCounts: Record; solvedCount: number; }; coverage: { /** Sorted by expiration instant, then style (code-unit order); no locale or clock dependency. */ expiries: OptionChainHealthExpiryCoverage[]; expiryCount: number; belowMinimumExpiries: boolean; duplicateQuoteCount: number; /** null means no expected universe supplied; [] means the supplied universe is covered. */ missingContracts: OptionChainHealthContract[] | null; expectedContractCount: number | null; }; assumptions: Assumptions<{ underlying: string; spot?: number; riskFreeRate?: number; dividendYield?: number; dividends: DiscreteDividend[]; modelAssessment: 'not-requested' | 'black-scholes-merton'; priceSource: PriceSource; priceUnit: 'per-underlying-share'; impliedVolatilityUnit: 'annualized-decimal'; /** Each row is bounded and inverted under its own contract's exercise style. */ exercisePolicy: 'by-contract-style' | 'not-assessed'; /** Present when a model was requested: the engine each exercise style is assessed with. */ exerciseEngines?: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; quotePolicy: 'report-only'; coverageIdentity: 'underlying-expiresAt-style-type-strike'; maximumQuoteAgeMs: number; maximumRelativeSpread: number; minimumExpiries: number; minimumStrikesPerExpiry: number; maximumQuotes: number; lowerVolatilityBound: number | null; upperVolatilityBound: number | null; maximumSolverIterations: number; }>; diagnostics: { warnings: QuantWarning[]; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions<{ underlying: string; spot?: number; riskFreeRate?: number; dividendYield?: number; dividends: DiscreteDividend[]; modelAssessment: 'not-requested' | 'black-scholes-merton'; priceSource: PriceSource; priceUnit: 'per-underlying-share'; impliedVolatilityUnit: 'annualized-decimal'; exercisePolicy: 'by-contract-style' | 'not-assessed'; exerciseEngines?: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; quotePolicy: 'report-only'; coverageIdentity: 'underlying-expiresAt-style-type-strike'; maximumQuoteAgeMs: number; maximumRelativeSpread: number; minimumExpiries: number; minimumStrikesPerExpiry: number; maximumQuotes: number; lowerVolatilityBound: number | null; upperVolatilityBound: number | null; maximumSolverIterations: number; }>; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.coverageIdentity: 'underlying-expiresAt-style-type-strike'; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.dividendYield?: number; default: not declared - assumptions.dividends: DiscreteDividend[]; default: not declared - assumptions.engine?: string; default: not declared - assumptions.exerciseEngines?: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; default: not declared — Present when a model was requested: the engine each exercise style is assessed with. - assumptions.exerciseEngines.american: 'bjerksund-stensland-2002'; default: not declared - assumptions.exerciseEngines.european: 'black-scholes-merton'; default: not declared - assumptions.exercisePolicy: 'by-contract-style' | 'not-assessed'; default: not declared — Each row is bounded and inverted under its own contract's exercise style. - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.impliedVolatilityUnit: 'annualized-decimal'; default: not declared - assumptions.lowerVolatilityBound: number | null; default: not declared - assumptions.maximumQuoteAgeMs: number; default: not declared - assumptions.maximumQuotes: number; default: not declared - assumptions.maximumRelativeSpread: number; default: not declared - assumptions.maximumSolverIterations: number; default: not declared - assumptions.minimumExpiries: number; default: not declared - assumptions.minimumStrikesPerExpiry: number; default: not declared - assumptions.model?: string; default: not declared - assumptions.modelAssessment: 'not-requested' | 'black-scholes-merton'; default: not declared - assumptions.priceSource: PriceSource; default: not declared - assumptions.priceUnit: 'per-underlying-share'; default: not declared - assumptions.quotePolicy: 'report-only'; default: not declared - assumptions.riskFreeRate?: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.spot?: number; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.underlying: string; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.upperVolatilityBound: number | null; default: not declared - coverage: { belowMinimumExpiries: boolean; duplicateQuoteCount: number; expectedContractCount: number | null; expiries: OptionChainHealthExpiryCoverage[]; expiryCount: number; missingContracts: OptionChainHealthContract[] | null; }; default: not declared - coverage.belowMinimumExpiries: boolean; default: not declared - coverage.duplicateQuoteCount: number; default: not declared - coverage.expectedContractCount: number | null; default: not declared - coverage.expiries: OptionChainHealthExpiryCoverage[]; default: not declared — Sorted by expiration instant, then style (code-unit order); no locale or clock dependency. - coverage.expiryCount: number; default: not declared - coverage.missingContracts: OptionChainHealthContract[] | null; default: not declared — null means no expected universe supplied; [] means the supplied universe is covered. - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - rows: OptionChainHealthRow[]; default: not declared - summary: { issueCounts: Record; modelStatusCounts: Record; quoteCount: number; quotesWithIssues: number; solvedCount: number; }; default: not declared - summary.issueCounts: Record; default: not declared - summary.modelStatusCounts: Record; default: not declared - summary.quoteCount: number; default: not declared - summary.quotesWithIssues: number; default: not declared - summary.solvedCount: number; default: not declared ### @insiderfinance/totalfinance/options#OptionChainHealthRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionChainHealthRow { /** Input order is preserved, including duplicate observations. */ quoteIndex: number; contract: OptionChainHealthContract; timestampMs: number | null; ageMs: number | null; selectedPrice: number | null; bid: number | null; ask: number | null; spread: number | null; /** null for absent/crossed sides or two zero sides; the reason is in diagnostics.warnings. */ relativeSpread: number | null; timeToExpiryYears: number; issues: OptionChainHealthIssue[]; model: OptionChainHealthModelResult; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ageMs: number | null; default: not declared - ask: number | null; default: not declared - bid: number | null; default: not declared - contract: OptionChainHealthContract; default: not declared - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - issues: OptionChainHealthIssue[]; default: not declared - model: OptionChainHealthModelResult; default: not declared - model.bounds: { lower: number; upper: number; } | null; default: not declared — The style's no-arbitrage price band per underlying share, or null when not evaluable: the discounted band for a European row, the undiscounted intrinsic-to-spot/strike band for an American row. - model.bounds.lower: number; default: not declared - model.bounds.upper: number; default: not declared - model.engine: 'black-scholes-merton' | 'bjerksund-stensland-2002' | null; default: not declared — The engine this row's bounds and inverse come from under the requested dynamics — closed-form BSM for a European contract, Bjerksund–Stensland 2002 for an American one. Null when no model assessment was requested. - model.impliedVolatility: number | null; default: not declared - model.solver: { converged: boolean; iterations: number; method: 'brent' | null; priceResidual: number | null; reason: string | null; status: 'converged' | 'not-run' | 'unavailable' | 'failed'; }; default: not declared - model.solver.converged: boolean; default: not declared - model.solver.iterations: number; default: not declared - model.solver.method: 'brent' | null; default: not declared — null when no model assessment was requested. - model.solver.priceResidual: number | null; default: not declared — Absolute repricing residual per share; null if no finite solve was accepted. - model.solver.reason: string | null; default: not declared — Null only on success. Failed inverses never receive a guessed or supplied IV. - model.solver.status: 'unavailable' | 'failed' | 'converged' | 'not-run'; default: not declared - model.status: OptionChainHealthModelStatus; default: not declared — Compatibility with the specified model, NOT a verdict that a market observation is bad. - model.unsupportedReasons: ('discrete_dividends' | 'adjusted_deliverable')[]; default: not declared — Every applicable unsupported assumption, not just the first one encountered. - quoteIndex: number; default: not declared — Input order is preserved, including duplicate observations. - relativeSpread: number | null; default: not declared — null for absent/crossed sides or two zero sides; the reason is in diagnostics.warnings. - selectedPrice: number | null; default: not declared - spread: number | null; default: not declared - timeToExpiryYears: number; default: not declared - timestampMs: number | null; default: not declared ### @insiderfinance/totalfinance/options#OptionContract Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#OptionContract`. ### @insiderfinance/totalfinance/options#OptionContractSchema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core/schema#OptionContractSchema`. ### @insiderfinance/totalfinance/options#OptionEnginePriceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One complete request to a pluggable option-pricing engine. ```typescript /** One complete request to a pluggable option-pricing engine. */ export interface OptionEnginePriceInput { contract: OptionContract; market: OptionMarket; options?: PriceOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - options?: PriceOptions; default: not declared - options.extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - options.greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. ### @insiderfinance/totalfinance/options#OptionImpliedVolatilityBatchColumns Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Columnar input for batch implied-volatility inversion (an option chain). `type`: 1 = call, ≤ 0 = put. ```typescript /** Columnar input for batch implied-volatility inversion (an option chain). `type`: 1 = call, ≤ 0 = put. */ export interface OptionImpliedVolatilityBatchColumns { /** Observed option prices to invert. */ price: Float64Array; spot: Float64Array; strike: Float64Array; riskFreeRate: Float64Array; /** Time to expiry in years. */ timeToExpiryYears: Float64Array; type: Int8Array; /** Optional per-row continuous dividend yield (defaults to 0). */ dividendYield?: Float64Array; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - price: Float64Array; default: not declared — Observed option prices to invert. - riskFreeRate: Float64Array; default: not declared - spot: Float64Array; default: not declared - strike: Float64Array; default: not declared - timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - type: Int8Array; default: not declared ### @insiderfinance/totalfinance/options#OptionImpliedVolatilityBatchResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionImpliedVolatilityBatchResult { impliedVolatility: Float64Array; /** Per row: 1 = converged, 0 = failed (inspect `reasons[i]`). */ converged: Uint8Array; /** Per-row failure reason, or `undefined` where the solve converged. */ reasons: (ImpliedVolatilityReason | undefined)[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: Uint8Array; default: not declared — Per row: 1 = converged, 0 = failed (inspect `reasons[i]`). - impliedVolatility: Float64Array; default: not declared - reasons: (ImpliedVolatilityReason | undefined)[]; default: not declared — Per-row failure reason, or `undefined` where the solve converged. ### @insiderfinance/totalfinance/options#OptionMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market inputs for the pro pricing API (spec §9.1). Extends the workspace-canonical {@link MarketInputs} (spot/rate/dividendYield/asOf) and adds the option-specific fields. `spot` is required (every pro engine resolves off it — forward-only pricing uses the flat `black76`/ `bachelier` facades). `rate`/`volatility` are scalars in this milestone; a `VolatilityLookup` variant for `volatility` arrives with the surface integration. ```typescript /** * Market inputs for the pro pricing API (spec §9.1). Extends the workspace-canonical * {@link MarketInputs} (spot/rate/dividendYield/asOf) and adds the option-specific fields. `spot` is * required (every pro engine resolves off it — forward-only pricing uses the flat `black76`/ * `bachelier` facades). `rate`/`volatility` are scalars in this milestone; a `VolatilityLookup` variant for * `volatility` arrives with the surface integration. */ export interface OptionMarket extends MarketInputs { forward?: number; /** Discrete cash dividends (American engines use the escrowed-dividend approximation). */ dividends?: DiscreteDividend[]; volatility?: number; /** The observed premium an inversion reproduces (`option.impliedVolatility`). */ price?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - dividends?: DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - forward?: number; default: not declared - price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility?: number; default: not declared ### @insiderfinance/totalfinance/options#OptionPricingEngine Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionPricingEngine { readonly name: string; readonly version: string; /** Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). */ readonly capabilities: EngineCapabilities; /** Whether this engine can price the given contract. */ supports(contract: OptionContract): boolean; price(input: OptionEnginePriceInput): PriceResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - name: string; default: not declared - price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.greeks?: Greeks | ExtendedGreeks; default: not declared - price().return.greeks.charm: number; default: not declared - price().return.greeks.color: number; default: not declared - price().return.greeks.delta: number; default: not declared - price().return.greeks.gamma: number; default: not declared - price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - price().return.greeks.rho: number; default: not declared - price().return.greeks.speed: number; default: not declared - price().return.greeks.theta: number; default: not declared - price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - price().return.greeks.vanna: number; default: not declared - price().return.greeks.vega: number; default: not declared - price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - price().return.greeks.vomma: number; default: not declared - price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): OptionEnginePriceInput; default: not declared - price(input).contract: OptionContract; default: not declared - price(input).market: OptionMarket; default: not declared - price(input).options?: PriceOptions; default: not declared - supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - supports(contract): OptionContract; default: not declared - supports(contract).adjusted?: boolean; default: not declared - supports(contract).currency?: string; default: not declared - supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - supports(contract).multiplier?: number; default: not declared - supports(contract).occSymbol?: string; default: not declared - supports(contract).root?: string; default: not declared - supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - supports(contract).strike: number; default: not declared - supports(contract).style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - supports(contract).underlying: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/options#OptionPricingEngineProbe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One caller-supplied behavioral probe for {@link validateOptionPricingEngine}. ```typescript /** One caller-supplied behavioral probe for {@link validateOptionPricingEngine}. */ export interface OptionPricingEngineProbe { /** A representative contract the engine claims to support. */ contract: OptionContract; /** Market data appropriate for this engine (for example `forward` for Black-76). */ market: OptionMarket; /** Optional baseline pricing flags used for this probe. */ options?: PriceOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared — A representative contract the engine claims to support. - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - market: OptionMarket; default: not declared — Market data appropriate for this engine (for example `forward` for Black-76). - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - options?: PriceOptions; default: not declared — Optional baseline pricing flags used for this probe. - options.extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - options.greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. ### @insiderfinance/totalfinance/options#OptionQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#OptionQuote`. ### @insiderfinance/totalfinance/options#OptionStyle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#OptionStyle`. ### @insiderfinance/totalfinance/options#OptionType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#OptionType`. ### @insiderfinance/totalfinance/options#ParityAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assumptions echoed by the regression-based parity functions. ```typescript /** Assumptions echoed by the regression-based parity functions. */ export type ParityAssumptions = Assumptions<{ riskFreeRate: number; priceSource: PriceSource; outlierThreshold: number; spot?: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - conventionsVersion: string; default: not declared - dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - model?: string; default: not declared - outlierThreshold: number; default: not declared - priceSource: PriceSource; default: not declared - riskFreeRate: number; default: not declared - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - spot?: number; default: not declared - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared ### @insiderfinance/totalfinance/options#ParityCode Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Stable `parity.*` error/warning codes (public API; the set is open). ```typescript export declare const ParityCode: { readonly DegenerateBox: 'parity.degenerate_box'; readonly InsufficientStrikes: 'parity.insufficient_strikes'; readonly NonPositiveDiscount: 'parity.nonpositive_discount'; readonly NonPositiveForward: 'parity.nonpositive_forward'; readonly RateMismatch: 'parity.rate_mismatch'; readonly StrikeUnavailable: 'parity.strike_unavailable'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - DegenerateBox: 'parity.degenerate_box'; default: not declared — The box debit is non-positive, so no real financing rate exists. - InsufficientStrikes: 'parity.insufficient_strikes'; default: not declared — Fewer than two usable strikes with both a call and a put — a line cannot be fit. - NonPositiveDiscount: 'parity.nonpositive_discount'; default: not declared — The regression slope is non-negative, so no positive discount factor exists. - NonPositiveForward: 'parity.nonpositive_forward'; default: not declared — The implied forward came out non-positive / non-finite. - RateMismatch: 'parity.rate_mismatch'; default: not declared — The regression-implied rate disagrees materially with the supplied rate. - StrikeUnavailable: 'parity.strike_unavailable'; default: not declared — A specifically requested strike/leg quote is missing (box spread). ### @insiderfinance/totalfinance/options#ParityDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnostics for the regression-based parity functions. Extends the shared {@link Diagnostics}. ```typescript /** Diagnostics for the regression-based parity functions. Extends the shared {@link Diagnostics}. */ export interface ParityDiagnostics extends Diagnostics { /** Number of strikes used in the final fit (after trimming). */ strikesUsed: number; /** Number of strikes trimmed as MAD outliers. */ trimmedCount: number; /** The strikes that were trimmed, ascending. */ trimmedStrikes: number[]; /** Per-strike parity residuals for every usable strike (trimmed ones flagged). */ perStrike: ParityStrikeResidual[]; /** Median absolute deviation of the initial-fit residuals used for trimming. */ medianAbsoluteDeviationResidual: number; /** Coefficient of determination of the final regression. */ rSquared: number; /** Implied discount factor `DF = −slope = e^(−rT)`. */ impliedDiscountFactor: number; /** Implied continuously-compounded financing rate `r* = −ln(DF)/T`. */ impliedRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - impliedDiscountFactor: number; default: not declared — Implied discount factor `DF = −slope = e^(−rT)`. - impliedRate: number; default: not declared — Implied continuously-compounded financing rate `r* = −ln(DF)/T`. - iterations?: number; default: not declared — Iteration count for iterative methods. - medianAbsoluteDeviationResidual: number; default: not declared — Median absolute deviation of the initial-fit residuals used for trimming. - method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - perStrike: ParityStrikeResidual[]; default: not declared — Per-strike parity residuals for every usable strike (trimmed ones flagged). - rSquared: number; default: not declared — Coefficient of determination of the final regression. - selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - selection.mode: 'explicit' | 'automatic'; default: not declared - selection.reason: string; default: not declared — Why the selected engine answers this request. - selection.selected: { name: string; version?: string; }; default: not declared - selection.selected.name: string; default: not declared - selection.selected.version?: string; default: not declared - strikesUsed: number; default: not declared — Number of strikes used in the final fit (after trimming). - timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - trimmedCount: number; default: not declared — Number of strikes trimmed as MAD outliers. - trimmedStrikes: number[]; default: not declared — The strikes that were trimmed, ascending. - warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/options#ParityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The rich envelope returned by {@link impliedForward}/{@link impliedDividendYield}/{@link impliedBorrow}. ```typescript /** The rich envelope returned by {@link impliedForward}/{@link impliedDividendYield}/{@link impliedBorrow}. */ export interface ParityResult { value: number; assumptions: ParityAssumptions; diagnostics: ParityDiagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: ParityAssumptions; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.outlierThreshold: number; default: not declared - assumptions.priceSource: PriceSource; default: not declared - assumptions.riskFreeRate: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.spot?: number; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: ParityDiagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.impliedDiscountFactor: number; default: not declared — Implied discount factor `DF = −slope = e^(−rT)`. - diagnostics.impliedRate: number; default: not declared — Implied continuously-compounded financing rate `r* = −ln(DF)/T`. - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.medianAbsoluteDeviationResidual: number; default: not declared — Median absolute deviation of the initial-fit residuals used for trimming. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.perStrike: ParityStrikeResidual[]; default: not declared — Per-strike parity residuals for every usable strike (trimmed ones flagged). - diagnostics.rSquared: number; default: not declared — Coefficient of determination of the final regression. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.strikesUsed: number; default: not declared — Number of strikes used in the final fit (after trimming). - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.trimmedCount: number; default: not declared — Number of strikes trimmed as MAD outliers. - diagnostics.trimmedStrikes: number[]; default: not declared — The strikes that were trimmed, ascending. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - value: number; default: not declared ### @insiderfinance/totalfinance/options#ParityStrikeResidual Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-strike parity diagnostic echoed for every usable strike (design law: nothing hidden). ```typescript // --------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------- /** Per-strike parity diagnostic echoed for every usable strike (design law: nothing hidden). */ export interface ParityStrikeResidual { strike: number; /** Call price at this strike (from the chosen `source`). */ call: number; /** Put price at this strike. */ put: number; /** Observed parity spread `C − P`. */ spread: number; /** Fitted spread `intercept + slope·K` from the final (post-trim) regression. */ fitted: number; /** `spread − fitted`. */ residual: number; /** Whether this strike was dropped as a MAD outlier before the final fit. */ trimmed: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: number; default: not declared — Call price at this strike (from the chosen `source`). - fitted: number; default: not declared — Fitted spread `intercept + slope·K` from the final (post-trim) regression. - put: number; default: not declared — Put price at this strike. - residual: number; default: not declared — `spread − fitted`. - spread: number; default: not declared — Observed parity spread `C − P`. - strike: number; default: not declared - trimmed: boolean; default: not declared — Whether this strike was dropped as a MAD outlier before the final fit. ### @insiderfinance/totalfinance/options#PriceManyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceManyInput { contracts: OptionContract[]; market: OptionMarket; /** Engine to use; defaults to {@link engines.auto}, the same default as `option.price`. */ engine?: OptionPricingEngine; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contracts: OptionContract[]; default: not declared - engine?: OptionPricingEngine; default: not declared — Engine to use; defaults to {@link engines.auto}, the same default as `option.price`. - engine.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engine.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engine.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engine.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engine.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engine.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engine.name: string; default: not declared - engine.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => PriceResult; default: not declared - engine.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - engine.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - engine.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - engine.price().return.greeks.charm: number; default: not declared - engine.price().return.greeks.color: number; default: not declared - engine.price().return.greeks.delta: number; default: not declared - engine.price().return.greeks.gamma: number; default: not declared - engine.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - engine.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - engine.price().return.greeks.rho: number; default: not declared - engine.price().return.greeks.speed: number; default: not declared - engine.price().return.greeks.theta: number; default: not declared - engine.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - engine.price().return.greeks.vanna: number; default: not declared - engine.price().return.greeks.vega: number; default: not declared - engine.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - engine.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - engine.price().return.greeks.vomma: number; default: not declared - engine.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - engine.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - engine.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - engine.price(input): import('@insiderfinance/totalfinance/options').OptionEnginePriceInput; default: not declared - engine.price(input).contract: OptionContract; default: not declared - engine.price(input).market: OptionMarket; default: not declared - engine.price(input).options?: import('@insiderfinance/totalfinance/options').PriceOptions; default: not declared - engine.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engine.supports(contract): OptionContract; default: not declared - engine.supports(contract).adjusted?: boolean; default: not declared - engine.supports(contract).currency?: string; default: not declared - engine.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - engine.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - engine.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - engine.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - engine.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - engine.supports(contract).multiplier?: number; default: not declared - engine.supports(contract).occSymbol?: string; default: not declared - engine.supports(contract).root?: string; default: not declared - engine.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - engine.supports(contract).strike: number; default: not declared - engine.supports(contract).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - engine.supports(contract).type: OptionType; default: not declared - engine.supports(contract).underlying: string; default: not declared - engine.version: string; default: not declared - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared ### @insiderfinance/totalfinance/options#PriceOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link priceOption} — ONE options-bearing object (alignment spec P3.5b). ```typescript /** Input for {@link priceOption} — ONE options-bearing object (alignment spec P3.5b). */ export interface PriceOptionInput extends PriceOptions { contract: OptionContract; /** Market snapshot. `asOf` is required on the market; the clock is never read. */ market: OptionMarket; /** Engine override; defaults to {@link engines.auto} (European → BSM, American → lattice/approx). */ engine?: OptionPricingEngine; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - engine?: OptionPricingEngine; default: not declared — Engine override; defaults to {@link engines.auto} (European → BSM, American → lattice/approx). - engine.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engine.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engine.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engine.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engine.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engine.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engine.name: string; default: not declared - engine.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => PriceResult; default: not declared - engine.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - engine.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - engine.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - engine.price().return.greeks.charm: number; default: not declared - engine.price().return.greeks.color: number; default: not declared - engine.price().return.greeks.delta: number; default: not declared - engine.price().return.greeks.gamma: number; default: not declared - engine.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - engine.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - engine.price().return.greeks.rho: number; default: not declared - engine.price().return.greeks.speed: number; default: not declared - engine.price().return.greeks.theta: number; default: not declared - engine.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - engine.price().return.greeks.vanna: number; default: not declared - engine.price().return.greeks.vega: number; default: not declared - engine.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - engine.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - engine.price().return.greeks.vomma: number; default: not declared - engine.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - engine.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - engine.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - engine.price(input): import('@insiderfinance/totalfinance/options').OptionEnginePriceInput; default: not declared - engine.price(input).contract: OptionContract; default: not declared - engine.price(input).market: OptionMarket; default: not declared - engine.price(input).options?: PriceOptions; default: not declared - engine.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engine.supports(contract): OptionContract; default: not declared - engine.supports(contract).adjusted?: boolean; default: not declared - engine.supports(contract).currency?: string; default: not declared - engine.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - engine.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - engine.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - engine.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - engine.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - engine.supports(contract).multiplier?: number; default: not declared - engine.supports(contract).occSymbol?: string; default: not declared - engine.supports(contract).root?: string; default: not declared - engine.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - engine.supports(contract).strike: number; default: not declared - engine.supports(contract).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - engine.supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - engine.supports(contract).underlying: string; default: not declared - engine.version: string; default: not declared - extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. - market: OptionMarket; default: not declared — Market snapshot. `asOf` is required on the market; the clock is never read. - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared ### @insiderfinance/totalfinance/options#PriceOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceOptions { /** * Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent * means "not requested", never fabricated zeros — and flags `greeks.not_computed` in * diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); * `extendedGreeks: true` implies `greeks`. */ greeks?: boolean; /** * Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, * veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the * numerical (lattice / PDE / approximation) engines. Implies `greeks`. */ extendedGreeks?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. ### @insiderfinance/totalfinance/options#PriceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of a pro `option.price(...)` call: a value envelope plus Greeks. `greeks` is OPTIONAL — absent means "not computed" (e.g. a Monte-Carlo engine priced without the extra Greek budget). Absent is never the same as a genuine zero: engines never fabricate `{delta:0, …}`. It is the **first-order** `Greeks` by default, or the full {@link ExtendedGreeks} when the call passes `{ extendedGreeks: true }`. ```typescript /** * Result of a pro `option.price(...)` call: a value envelope plus Greeks. `greeks` is OPTIONAL — absent * means "not computed" (e.g. a Monte-Carlo engine priced without the extra Greek budget). Absent is never * the same as a genuine zero: engines never fabricate `{delta:0, …}`. It is the **first-order** `Greeks` * by default, or the full {@link ExtendedGreeks} when the call passes `{ extendedGreeks: true }`. */ export interface PriceResult extends Computed { greeks?: Greeks | ExtendedGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks?: Greeks | ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#PriceSource Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#PriceSource`. ### @insiderfinance/totalfinance/options#QuantoInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── quanto option (closed form) ───────────────────────── export interface QuantoInput { /** Foreign-asset spot (in foreign currency). */ spot: number; strike: number; timeToExpiryYears: number; /** Domestic discount rate. */ domesticRate: number; /** Foreign risk-free rate. */ foreignRate: number; /** Asset volatility. */ volatility: number; /** Volatility of the domestic/foreign FX rate. */ fxVolatility: number; /** Correlation between the asset and the FX rate, in [-1, 1]. */ correlation: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlation: number; default: not declared — Correlation between the asset and the FX rate, in [-1, 1]. - dividendYield?: number; default: not declared - domesticRate: number; default: not declared — Domestic discount rate. - foreignRate: number; default: not declared — Foreign risk-free rate. - fxVolatility: number; default: not declared — Volatility of the domestic/foreign FX rate. - spot: number; default: not declared — Foreign-asset spot (in foreign currency). - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared — Asset volatility. ### @insiderfinance/totalfinance/options#RainbowKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RainbowKind = 'max' | 'min'; ``` ### @insiderfinance/totalfinance/options#ReverseCliquetInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reverse cliquet takes the same inputs as {@link napoleon}; the coupon is degraded by `Σ min(rᵢ, 0)`. ```typescript /** Reverse cliquet takes the same inputs as {@link napoleon}; the coupon is degraded by `Σ min(rᵢ, 0)`. */ export type ReverseCliquetInput = NapoleonInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coupon: number; default: not declared — The fixed coupon degraded by the period returns. - dividendYield?: number; default: not declared - globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - notional?: number; default: not declared — Notional multiplier. Default 1. - resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#SabrInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market inputs for a SABR computation. Provide `forward`, or `spot` (+ `rate`, `dividendYield`). ```typescript /** Market inputs for a SABR computation. Provide `forward`, or `spot` (+ `rate`, `dividendYield`). */ export interface SabrInput { forward?: number; spot?: number; strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; /** Discount/forward rate (default 0). */ riskFreeRate?: number; dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - forward?: number; default: not declared - riskFreeRate?: number; default: not declared — Discount/forward rate (default 0). - spot?: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/options#SabrMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SabrMonteCarloOptions extends MonteCarloSamplingOptions { /** Time steps per path (default 100). */ steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. - steps?: number; default: not declared — Time steps per path (default 100). ### @insiderfinance/totalfinance/options#SabrMonteCarloResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A SABR MC result enriched with the Monte-Carlo error statistics. ```typescript /** A SABR MC result enriched with the Monte-Carlo error statistics. */ export interface SabrMonteCarloResult extends PriceResult { monteCarlo: MonteCarloStatistics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks?: Greeks | ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarlo: MonteCarloStatistics; default: not declared - monteCarlo.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarlo.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarlo.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarlo.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarlo.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarlo.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarlo.varianceReduction.antithetic: boolean; default: not declared - monteCarlo.varianceReduction.brownianBridge: boolean; default: not declared - monteCarlo.varianceReduction.controlVariate: boolean; default: not declared - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#SabrOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SabrOptions { /** Hagan expansion (default `'lognormal'`). */ volatilityType?: SabrVolatilityType; /** Compute Greeks by finite differences (default `true`). */ greeks?: boolean; /** * Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) * are w.r.t. the SABR level `α` — extending the `vega` convention; `phi = 0` (forward model). Hagan's * vol is smooth, so the finite differences are stable. */ extendedGreeks?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set (implies `greeks`). Volatility Greeks (vega, vanna, …) are w.r.t. the SABR level `α` — extending the `vega` convention; `phi = 0` (forward model). Hagan's vol is smooth, so the finite differences are stable. - greeks?: boolean; default: not declared — Compute Greeks by finite differences (default `true`). - volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion (default `'lognormal'`). ### @insiderfinance/totalfinance/options#SabrParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). SABR parameters. ```typescript /** SABR parameters. */ export interface SabrParameters { /** Initial volatility level α (> 0). */ alpha: number; /** Backbone exponent β ∈ [0, 1]. */ beta: number; /** Correlation ρ ∈ (−1, 1). */ rho: number; /** Volatility of volatility ν (≥ 0). */ nu: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha: number; default: not declared — Initial volatility level α (> 0). - beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - nu: number; default: not declared — Volatility of volatility ν (≥ 0). - rho: number; default: not declared — Correlation ρ ∈ (−1, 1). ### @insiderfinance/totalfinance/options#SabrVolatilityType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Which Hagan expansion to use. ```typescript /** Which Hagan expansion to use. */ export type SabrVolatilityType = 'lognormal' | 'normal'; ``` ### @insiderfinance/totalfinance/options#SpreadInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── spread option (Kirk + Monte-Carlo) ───────────────────────── export interface SpreadInput { spot1: number; spot2: number; /** Strike on `S1 − S2`. May be negative; Kirk requires `F2 + K > 0`. */ strike: number; timeToExpiryYears: number; riskFreeRate: number; /** * Per-asset volatilities. * * These were `vol1`/`vol2` under a retired rule ("flat inputs use `vol`") that survived in this * comment long after the rule went. The denylist has forbidden `vol` since N0 — the digit is what * hid these two, which is the whole reason the tokenizer now tests the letter run in front of a * numeric suffix. */ volatility1: number; volatility2: number; /** Correlation between the two assets, in [-1, 1]. */ correlation: number; dividendYield1?: number; dividendYield2?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlation: number; default: not declared — Correlation between the two assets, in [-1, 1]. - dividendYield1?: number; default: not declared - dividendYield2?: number; default: not declared - riskFreeRate: number; default: not declared - spot1: number; default: not declared - spot2: number; default: not declared - strike: number; default: not declared — Strike on `S1 − S2`. May be negative; Kirk requires `F2 + K > 0`. - timeToExpiryYears: number; default: not declared - volatility1: number; default: not declared — Per-asset volatilities. These were `vol1`/`vol2` under a retired rule ("flat inputs use `vol`") that survived in this comment long after the rule went. The denylist has forbidden `vol` since N0 — the digit is what hid these two, which is the whole reason the tokenizer now tests the letter run in front of a numeric suffix. - volatility2: number; default: not declared ### @insiderfinance/totalfinance/options#TouchInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TouchInput { spot: number; /** Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. */ barrier: number; timeToExpiryYears: number; riskFreeRate: number; volatility: number; dividendYield?: number; /** Rebate paid on the touch outcome; default 1. */ cash?: number; /** When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. */ payAt?: 'expiry' | 'hit'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - dividendYield?: number; default: not declared - payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - riskFreeRate: number; default: not declared - spot: number; default: not declared - timeToExpiryYears: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options#TouchKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ──────────────────────────────────────────────────────────────────────────── // One-touch / no-touch options — American binaries on a barrier // ──────────────────────────────────────────────────────────────────────────── export type TouchKind = 'one-touch' | 'no-touch'; ``` ### @insiderfinance/totalfinance/options#TouchMonteCarloOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TouchMonteCarloOptions extends MonteCarloSamplingOptions { /** Monitoring steps per path (default 100). */ steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - seed: number; default: not declared — Seed — required and echoed for reproducibility. - steps?: number; default: not declared — Monitoring steps per path (default 100). ### @insiderfinance/totalfinance/options#TrinomialEngineOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TrinomialEngineOptions { steps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - steps?: number; default: not declared ### @insiderfinance/totalfinance/options#UsEquityOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link usEquityOption}: an OCC symbol, or the contract's data with its `type`. ```typescript /** Input for {@link usEquityOption}: an OCC symbol, or the contract's data with its `type`. */ export interface UsEquityOptionInput extends Partial { /** A compact OCC symbol (`AAPL260918C00200000`); its root, expiry, type and strike are the contract. */ occSymbol?: string; /** `'call' | 'put'` — required unless `occSymbol` names it. */ type?: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - currency?: string; default: not declared - expiry?: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - multiplier?: number; default: not declared - occSymbol?: string; default: not declared — A compact OCC symbol (`AAPL260918C00200000`); its root, expiry, type and strike are the contract. - root?: string; default: not declared - strike?: number; default: not declared - type?: OptionType; default: not declared — `'call' | 'put'` — required unless `occSymbol` names it. - underlying?: string; default: not declared ### @insiderfinance/totalfinance/options#VanillaIntrinsicInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link vanillaIntrinsicUnchecked} and the public `vanillaIntrinsic`. ```typescript /** Input for {@link vanillaIntrinsicUnchecked} and the public `vanillaIntrinsic`. */ export interface VanillaIntrinsicInput { /** Which leg — `'call'` or `'put'`. */ type: OptionType; /** The underlying's price per unit, in the same currency unit as `strike`. */ underlyingPrice: number; /** The option's strike price per unit. */ strike: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - strike: number; default: not declared — The option's strike price per unit. - type: OptionType; default: not declared — Which leg — `'call'` or `'put'`. - underlyingPrice: number; default: not declared — The underlying's price per unit, in the same currency unit as `strike`. ### @insiderfinance/totalfinance/options#VarianceReduction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Variance-reduction techniques actually applied to an estimate (echoed for reproducibility). ```typescript /** Variance-reduction techniques actually applied to an estimate (echoed for reproducibility). */ export interface VarianceReduction { antithetic: boolean; controlVariate: boolean; brownianBridge: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - antithetic: boolean; default: not declared - brownianBridge: boolean; default: not declared - controlVariate: boolean; default: not declared ### @insiderfinance/totalfinance/options#americanExercise Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose an American option into its European value plus early-exercise premium, recover the exercise boundary `S*(τ)`, and say whether to exercise now. See `docs/specs/american-exercise.md`. ```typescript export declare function americanExercise(input: AmericanExerciseInput): AmericanExerciseResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AmericanExerciseInput; default: not declared - (input).contract: OptionContract; default: not declared - (input).market: OptionMarket; default: not declared - (input).options?: AmericanExerciseOptions; default: not declared - return.american: number; default: not declared — American value (Barone–Adesi–Whaley). - return.assumptions: { conventionsVersion: string; dividendModel: DividendModel; timeToExpiryYears: number; valueEngine: 'barone-adesi-whaley'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.dividendModel: DividendModel; default: not declared - return.assumptions.timeToExpiryYears: number; default: not declared - return.assumptions.valueEngine: 'barone-adesi-whaley'; default: not declared - return.boundary: BoundaryPoint[]; default: not declared — The `S*(τ)` curve over the remaining life (empty when never optimal). - return.criticalSpot: number | null; default: not declared — `S*(τ)` at the current maturity; `null` when early exercise is never optimal. - return.diagnostics: Diagnostics; default: not declared - return.earlyExerciseCanBeOptimal: boolean; default: not declared — `false` for a non-dividend call (early exercise never optimal). - return.earlyExercisePremium: number; default: not declared — `american − european ≥ 0` — the dollars the early-exercise right adds. - return.european: number; default: not declared — European value (BSM) — the value stripped of the early-exercise right. - return.intrinsic: number; default: not declared - return.optionType: 'call' | 'put'; default: not declared — Which leg was analysed — `'call'` or `'put'`. Named `optionType` because that is what it holds: in TotalFinance `style` is the EXERCISE style (`'european' | 'american'`) everywhere else, and every one of these results is American by construction, so a field called `style` reading `'put'` was a straight collision of two vocabularies (pre-1.0 clean break, defect-fix wave, review-1). - return.premiumFractionOfValue: number; default: not declared — `premium / american`. - return.rationale: string; default: not declared — Prose an agent relays. - return.shouldExerciseNow: boolean; default: not declared — The American value has collapsed to intrinsic — no time value left to give up. - return.spot: number; default: not declared - return.spotToBoundary: number | null; default: not declared — Signed fraction of spot to the boundary (put: `(S−S*)/S`, call: `(S*−S)/S`); `null` if no boundary. - return.timeValue: number; default: not declared — `american − intrinsic ≥ 0`. ### @insiderfinance/totalfinance/options#americanImpliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve the implied volatility of an American contract from `market.price` by inverting an American pricing engine over σ with a safeguarded Brent bracket (`[1e-4, 5]`, expanded once to `[1e-6, 10]`). No-arbitrage bounds use the American intrinsic (`max(S−K,0)` calls, `max(K−S,0)` puts, no discounting): a price below intrinsic, above the upper bound, or at intrinsic (no time value to imply a vol) fails honestly instead of returning a fabricated number. A European contract is refused — its door is `option.impliedVolatility`, closed-form by default or engine-inverted when an engine is named. ```typescript export declare function americanImpliedVolatility(input: AmericanImpliedVolatilityInput): ImpliedVolatilitySolveResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AmericanImpliedVolatilityInput; default: not declared - (input).contract: OptionContract; default: not declared - (input).market: OptionMarket; default: not declared - (input).options?: AmericanImpliedVolatilityOptions; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#asian Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const asian: { readonly geometricPrice: (input: AsianInput & { type: OptionType; }) => ExoticResult; readonly monteCarloPrice: (input: AsianMonteCarloInput & { type: OptionType; }, options: AsianMonteCarloOptions) => ExoticMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - geometricPrice: (input: AsianInput & { type: OptionType; }) => ExoticResult; default: not declared — Exact discrete geometric-average Asian price. - geometricPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - geometricPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - geometricPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - geometricPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - geometricPrice(input): AsianInput & { type: OptionType; }; default: not declared - geometricPrice(input).averagingPoints?: number; default: not declared — Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). - geometricPrice(input).dividendYield?: number; default: not declared - geometricPrice(input).riskFreeRate: number; default: not declared - geometricPrice(input).spot: number; default: not declared - geometricPrice(input).strike: number; default: not declared - geometricPrice(input).timeToExpiryYears: number; default: not declared - geometricPrice(input).type: OptionType; default: not declared - geometricPrice(input).volatility: number; default: not declared - monteCarloPrice: (input: AsianMonteCarloInput & { type: OptionType; }, options: AsianMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — Arithmetic-average Asian price by Monte-Carlo, with the geometric Asian as control variate. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): AsianMonteCarloInput & { type: OptionType; }; default: not declared - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).strike: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): AsianMonteCarloOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).averagingPoints?: number; default: not declared — Number of equally-spaced averaging dates t_i = i·T/m, i = 1..m (default 50). - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#autocallable Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const autocallable: { readonly monteCarloPrice: (input: AutocallableInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: AutocallableInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo price of a canonical autocallable note: on each observation date the note redeems at `notional·(1 + couponRate·periods)` if the spot is at or above `autocallBarrier`; if it never does, at maturity it returns the notional when `S(T) ≥ knockInBarrier`, else the loss-bearing `notional·S(T)/S(0)`. The payoff is discounted at the per-path redemption time. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): AutocallableInput; default: not declared - monteCarloPrice(input).autocallBarrier: number; default: not declared — Autocall trigger level: if `S(tᵢ) ≥ autocallBarrier`, the note redeems early. - monteCarloPrice(input).couponRate: number; default: not declared — Coupon per elapsed period (fraction of notional), paid cumulatively on redemption. - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).knockInBarrier: number; default: not declared — Downside knock-in level checked at maturity (capital is at risk below it). - monteCarloPrice(input).notional?: number; default: not declared — Notional. Default 100. - monteCarloPrice(input).observationTimes: number[]; default: not declared — Strictly-increasing observation times in years; the last is maturity. - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#bachelier Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Bachelier facade namespace. ```typescript export declare const bachelier: { call: Facade; extendedGreeks: Facade; greeks: Facade; impliedVolatility: Facade, number | null>; price: Facade; put: Facade; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Facade; default: not declared - call(input): BachelierInput; default: not declared - call(input).forward: number; default: not declared - call(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - call(input).riskFreeRate: number; default: not declared - call(input).strike: number; default: not declared - call(input).timeToExpiryYears: number; default: not declared - call.explain: (input: BachelierInput) => Computed>; default: not declared - call.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - call.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - call.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - call.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - call.explain(input): BachelierInput; default: not declared - call.explain(input).forward: number; default: not declared - call.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - call.explain(input).riskFreeRate: number; default: not declared - call.explain(input).strike: number; default: not declared - call.explain(input).timeToExpiryYears: number; default: not declared - extendedGreeks: Facade; default: not declared - extendedGreeks().return.charm: number; default: not declared - extendedGreeks().return.color: number; default: not declared - extendedGreeks().return.delta: number; default: not declared - extendedGreeks().return.gamma: number; default: not declared - extendedGreeks().return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - extendedGreeks().return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - extendedGreeks().return.rho: number; default: not declared - extendedGreeks().return.speed: number; default: not declared - extendedGreeks().return.theta: number; default: not declared - extendedGreeks().return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - extendedGreeks().return.vanna: number; default: not declared - extendedGreeks().return.vega: number; default: not declared - extendedGreeks().return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - extendedGreeks().return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - extendedGreeks().return.vomma: number; default: not declared - extendedGreeks().return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - extendedGreeks(input): BachelierTypedInput; default: not declared - extendedGreeks(input).forward: number; default: not declared - extendedGreeks(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - extendedGreeks(input).riskFreeRate: number; default: not declared - extendedGreeks(input).strike: number; default: not declared - extendedGreeks(input).timeToExpiryYears: number; default: not declared - extendedGreeks(input).type: OptionType; default: not declared - extendedGreeks.explain: (input: BachelierTypedInput) => Computed>; default: not declared - extendedGreeks.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - extendedGreeks.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - extendedGreeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - extendedGreeks.explain().return.value: ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - extendedGreeks.explain(input): BachelierTypedInput; default: not declared - extendedGreeks.explain(input).forward: number; default: not declared - extendedGreeks.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - extendedGreeks.explain(input).riskFreeRate: number; default: not declared - extendedGreeks.explain(input).strike: number; default: not declared - extendedGreeks.explain(input).timeToExpiryYears: number; default: not declared - extendedGreeks.explain(input).type: OptionType; default: not declared - greeks: Facade; default: not declared - greeks().return.delta: number; default: not declared - greeks().return.gamma: number; default: not declared - greeks().return.rho: number; default: not declared - greeks().return.theta: number; default: not declared - greeks().return.vega: number; default: not declared - greeks(input): BachelierTypedInput; default: not declared - greeks(input).forward: number; default: not declared - greeks(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - greeks(input).riskFreeRate: number; default: not declared - greeks(input).strike: number; default: not declared - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).type: OptionType; default: not declared - greeks.explain: (input: BachelierTypedInput) => Computed>; default: not declared - greeks.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks.explain().return.value: Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks.explain(input): BachelierTypedInput; default: not declared - greeks.explain(input).forward: number; default: not declared - greeks.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - greeks.explain(input).riskFreeRate: number; default: not declared - greeks.explain(input).strike: number; default: not declared - greeks.explain(input).timeToExpiryYears: number; default: not declared - greeks.explain(input).type: OptionType; default: not declared - impliedVolatility: Facade, number | null>; default: not declared - impliedVolatility(input): BachelierImpliedVolatilityInput; default: not declared - impliedVolatility(input).forward: number; default: not declared - impliedVolatility(input).price: number; default: not declared - impliedVolatility(input).riskFreeRate: number; default: not declared - impliedVolatility(input).strike: number; default: not declared - impliedVolatility(input).timeToExpiryYears: number; default: not declared - impliedVolatility(input).type: OptionType; default: not declared - impliedVolatility.explain: (input: BachelierImpliedVolatilityInput) => Computed>; default: not declared - impliedVolatility.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - impliedVolatility.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - impliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatility.explain(input): BachelierImpliedVolatilityInput; default: not declared - impliedVolatility.explain(input).forward: number; default: not declared - impliedVolatility.explain(input).price: number; default: not declared - impliedVolatility.explain(input).riskFreeRate: number; default: not declared - impliedVolatility.explain(input).strike: number; default: not declared - impliedVolatility.explain(input).timeToExpiryYears: number; default: not declared - impliedVolatility.explain(input).type: OptionType; default: not declared - price: Facade; default: not declared - price(input): BachelierTypedInput; default: not declared - price(input).forward: number; default: not declared - price(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - price(input).riskFreeRate: number; default: not declared - price(input).strike: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price.explain: (input: BachelierTypedInput) => Computed>; default: not declared - price.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price.explain(input): BachelierTypedInput; default: not declared - price.explain(input).forward: number; default: not declared - price.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - price.explain(input).riskFreeRate: number; default: not declared - price.explain(input).strike: number; default: not declared - price.explain(input).timeToExpiryYears: number; default: not declared - price.explain(input).type: OptionType; default: not declared - put: Facade; default: not declared - put(input): BachelierInput; default: not declared - put(input).forward: number; default: not declared - put(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - put(input).riskFreeRate: number; default: not declared - put(input).strike: number; default: not declared - put(input).timeToExpiryYears: number; default: not declared - put.explain: (input: BachelierInput) => Computed>; default: not declared - put.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - put.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - put.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - put.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - put.explain(input): BachelierInput; default: not declared - put.explain(input).forward: number; default: not declared - put.explain(input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - put.explain(input).riskFreeRate: number; default: not declared - put.explain(input).strike: number; default: not declared - put.explain(input).timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/options#barrier Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const barrier: { readonly monteCarloPrice: (input: BarrierInput & { type: OptionType; barrierType: BarrierType; }, options: BarrierMonteCarloOptions) => ExoticMonteCarloResult; readonly price: (input: BarrierInput & { type: OptionType; barrierType: BarrierType; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: BarrierInput & { type: OptionType; barrierType: BarrierType; }, options: BarrierMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — Brownian-bridge-corrected Monte-Carlo barrier price (converges to the continuous analytic). - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): BarrierInput & { barrierType: BarrierType; type: OptionType; }; default: not declared - monteCarloPrice(input).barrier: number; default: not declared — Barrier level H. - monteCarloPrice(input).barrierType: BarrierType; default: not declared - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).strike: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): BarrierMonteCarloOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 100). - price: (input: BarrierInput & { type: OptionType; barrierType: BarrierType; }) => ExoticResult; default: not declared — Continuous-monitoring single-barrier price (Reiner–Rubinstein / Haug, zero rebate). - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): BarrierInput & { barrierType: BarrierType; type: OptionType; }; default: not declared - price(input).barrier: number; default: not declared — Barrier level H. - price(input).barrierType: BarrierType; default: not declared - price(input).dividendYield?: number; default: not declared - price(input).riskFreeRate: number; default: not declared - price(input).spot: number; default: not declared - price(input).strike: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#basket Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const basket: { readonly approximatePrice: (input: BasketInput & { type: OptionType; }) => ExoticResult; readonly monteCarloPrice: (input: BasketInput & { type: OptionType; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - approximatePrice: (input: BasketInput & { type: OptionType; }) => ExoticResult; default: not declared — Levy moment-matched lognormal approximation (closed form) for a weighted-basket option. - approximatePrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - approximatePrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - approximatePrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - approximatePrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - approximatePrice(input): BasketInput & { type: OptionType; }; default: not declared - approximatePrice(input).correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - approximatePrice(input).dividendYields?: number[]; default: not declared - approximatePrice(input).riskFreeRate: number; default: not declared - approximatePrice(input).spots: number[]; default: not declared - approximatePrice(input).strike: number; default: not declared - approximatePrice(input).timeToExpiryYears: number; default: not declared - approximatePrice(input).type: OptionType; default: not declared - approximatePrice(input).volatilities: number[]; default: not declared - approximatePrice(input).weights: number[]; default: not declared — Basket weights (one per asset). - monteCarloPrice: (input: BasketInput & { type: OptionType; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo price of a weighted-basket option (exact; corroborates the Levy approximation). - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): BasketInput & { type: OptionType; }; default: not declared - monteCarloPrice(input).correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - monteCarloPrice(input).dividendYields?: number[]; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spots: number[]; default: not declared - monteCarloPrice(input).strike: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatilities: number[]; default: not declared - monteCarloPrice(input).weights: number[]; default: not declared — Basket weights (one per asset). - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#black76 Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Black-76 facade namespace. ```typescript export declare const black76: { call: Facade; extendedGreeks: Facade; greeks: Facade; impliedVolatility: Facade, number | null>; price: Facade; put: Facade; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Facade; default: not declared - call(input): Black76Input; default: not declared - call(input).forward: number; default: not declared - call(input).riskFreeRate: number; default: not declared - call(input).strike: number; default: not declared - call(input).timeToExpiryYears: number; default: not declared - call(input).volatility: number; default: not declared - call.explain: (input: Black76Input) => Computed>; default: not declared - call.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - call.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - call.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - call.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - call.explain(input): Black76Input; default: not declared - call.explain(input).forward: number; default: not declared - call.explain(input).riskFreeRate: number; default: not declared - call.explain(input).strike: number; default: not declared - call.explain(input).timeToExpiryYears: number; default: not declared - call.explain(input).volatility: number; default: not declared - extendedGreeks: Facade; default: not declared - extendedGreeks().return.charm: number; default: not declared - extendedGreeks().return.color: number; default: not declared - extendedGreeks().return.delta: number; default: not declared - extendedGreeks().return.gamma: number; default: not declared - extendedGreeks().return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - extendedGreeks().return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - extendedGreeks().return.rho: number; default: not declared - extendedGreeks().return.speed: number; default: not declared - extendedGreeks().return.theta: number; default: not declared - extendedGreeks().return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - extendedGreeks().return.vanna: number; default: not declared - extendedGreeks().return.vega: number; default: not declared - extendedGreeks().return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - extendedGreeks().return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - extendedGreeks().return.vomma: number; default: not declared - extendedGreeks().return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - extendedGreeks(input): Black76TypedInput; default: not declared - extendedGreeks(input).forward: number; default: not declared - extendedGreeks(input).riskFreeRate: number; default: not declared - extendedGreeks(input).strike: number; default: not declared - extendedGreeks(input).timeToExpiryYears: number; default: not declared - extendedGreeks(input).type: OptionType; default: not declared - extendedGreeks(input).volatility: number; default: not declared - extendedGreeks.explain: (input: Black76TypedInput) => Computed>; default: not declared - extendedGreeks.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - extendedGreeks.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - extendedGreeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - extendedGreeks.explain().return.value: ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - extendedGreeks.explain(input): Black76TypedInput; default: not declared - extendedGreeks.explain(input).forward: number; default: not declared - extendedGreeks.explain(input).riskFreeRate: number; default: not declared - extendedGreeks.explain(input).strike: number; default: not declared - extendedGreeks.explain(input).timeToExpiryYears: number; default: not declared - extendedGreeks.explain(input).type: OptionType; default: not declared - extendedGreeks.explain(input).volatility: number; default: not declared - greeks: Facade; default: not declared - greeks().return.delta: number; default: not declared - greeks().return.gamma: number; default: not declared - greeks().return.rho: number; default: not declared - greeks().return.theta: number; default: not declared - greeks().return.vega: number; default: not declared - greeks(input): Black76TypedInput; default: not declared - greeks(input).forward: number; default: not declared - greeks(input).riskFreeRate: number; default: not declared - greeks(input).strike: number; default: not declared - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).type: OptionType; default: not declared - greeks(input).volatility: number; default: not declared - greeks.explain: (input: Black76TypedInput) => Computed>; default: not declared - greeks.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks.explain().return.value: Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks.explain(input): Black76TypedInput; default: not declared - greeks.explain(input).forward: number; default: not declared - greeks.explain(input).riskFreeRate: number; default: not declared - greeks.explain(input).strike: number; default: not declared - greeks.explain(input).timeToExpiryYears: number; default: not declared - greeks.explain(input).type: OptionType; default: not declared - greeks.explain(input).volatility: number; default: not declared - impliedVolatility: Facade, number | null>; default: not declared - impliedVolatility(input): Black76ImpliedVolatilityInput; default: not declared - impliedVolatility(input).forward: number; default: not declared - impliedVolatility(input).price: number; default: not declared - impliedVolatility(input).riskFreeRate: number; default: not declared - impliedVolatility(input).strike: number; default: not declared - impliedVolatility(input).timeToExpiryYears: number; default: not declared - impliedVolatility(input).type: OptionType; default: not declared - impliedVolatility.explain: (input: Black76ImpliedVolatilityInput) => Computed>; default: not declared - impliedVolatility.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - impliedVolatility.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - impliedVolatility.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - impliedVolatility.explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - impliedVolatility.explain(input): Black76ImpliedVolatilityInput; default: not declared - impliedVolatility.explain(input).forward: number; default: not declared - impliedVolatility.explain(input).price: number; default: not declared - impliedVolatility.explain(input).riskFreeRate: number; default: not declared - impliedVolatility.explain(input).strike: number; default: not declared - impliedVolatility.explain(input).timeToExpiryYears: number; default: not declared - impliedVolatility.explain(input).type: OptionType; default: not declared - price: Facade; default: not declared - price(input): Black76TypedInput; default: not declared - price(input).forward: number; default: not declared - price(input).riskFreeRate: number; default: not declared - price(input).strike: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared - price.explain: (input: Black76TypedInput) => Computed>; default: not declared - price.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price.explain(input): Black76TypedInput; default: not declared - price.explain(input).forward: number; default: not declared - price.explain(input).riskFreeRate: number; default: not declared - price.explain(input).strike: number; default: not declared - price.explain(input).timeToExpiryYears: number; default: not declared - price.explain(input).type: OptionType; default: not declared - price.explain(input).volatility: number; default: not declared - put: Facade; default: not declared - put(input): Black76Input; default: not declared - put(input).forward: number; default: not declared - put(input).riskFreeRate: number; default: not declared - put(input).strike: number; default: not declared - put(input).timeToExpiryYears: number; default: not declared - put(input).volatility: number; default: not declared - put.explain: (input: Black76Input) => Computed>; default: not declared - put.explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - put.explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - put.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - put.explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - put.explain(input): Black76Input; default: not declared - put.explain(input).forward: number; default: not declared - put.explain(input).riskFreeRate: number; default: not declared - put.explain(input).strike: number; default: not declared - put.explain(input).timeToExpiryYears: number; default: not declared - put.explain(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#blackScholes Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#blackScholes`. ### @insiderfinance/totalfinance/options#boxSpreadRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied financing rate from the box spread between strikes `k1 < k2`. A box (bull call spread `+` bear put spread) locks in `(k2 − k1)` at expiry for a net debit `box = (C(k1) − C(k2)) + (P(k2) − P(k1))`, so `box = (k2 − k1)·e^(−rT)` and `rate = −ln(box / (k2 − k1)) / T`. Throws `parity.strike_unavailable` when a needed leg is missing. ```typescript export declare function boxSpreadRate(input: BoxSpreadRateInput): BoxSpreadResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BoxSpreadRateInput; default: not declared - (input).expiry: string; default: not declared - (input).lowerStrike: number; default: not declared - (input).options: BoxSpreadOptions; default: not declared - (input).quotes: readonly OptionQuote[]; default: not declared - (input).upperStrike: number; default: not declared - return.assumptions: BoxSpreadAssumptions; default: not declared - return.diagnostics: BoxSpreadDiagnostics; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options#callContract Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Generic call builder — `style` REQUIRED. ```typescript export declare function callContract(input: OptionBuilderInput): OptionContract; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OptionBuilderInput; default: not declared - (input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - (input).currency?: string; default: not declared - (input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - (input).multiplier?: number; default: not declared - (input).root?: string; default: not declared - (input).strike: number; default: not declared - (input).style: OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - (input).underlying: string; default: not declared - return.adjusted?: boolean; default: not declared - return.currency?: string; default: not declared - return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - return.multiplier?: number; default: not declared - return.occSymbol?: string; default: not declared - return.root?: string; default: not declared - return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - return.strike: number; default: not declared - return.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - return.type: OptionType; default: not declared - return.underlying: string; default: not declared ### @insiderfinance/totalfinance/options#chainGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve every chain row's implied volatility and Greeks from its observed price. See the module note: non-throwing per row, style-routed, display units, provenance stamped. ```typescript export declare function chainGreeks(input: ChainGreeksInput): ChainGreeksResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ChainGreeksInput; default: not declared - (input).market: MarketInputs; default: not declared — Spot, rate, optional continuous yield and the valuation instant (a bare date is refused). - (input).priceSource?: PriceSource; default: not declared — Which observed price to invert per row (default `'mid'`; no fallback across sources). - (input).quotes: readonly OptionQuote[]; default: not declared — The chain rows; each is returned in order, stamped when its Greeks could be solved. - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - return.diagnostics: (ChainGreeksDiagnostics) | (Diagnostics); default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: OptionQuote[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#checkBlackScholesNoArbitrage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Check an observed price against BSM no-arbitrage bounds. Returns a report: `admissible` plus the `[lower, upper]` band, with each violation as a structured `severity: 'error'` warning on `diagnostics.warnings` (empty when the price is admissible). Callers decide whether to treat a violation as fatal. ```typescript export declare function checkBlackScholesNoArbitrage(input: BlackScholesNoArbitrageInput): BlackScholesNoArbitrageReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesNoArbitrageInput; default: not declared - (input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - (input).price: number; default: not declared — The observed option price to test. - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).type: OptionType; default: not declared - return.admissible: boolean; default: not declared — True when the observed price sits inside the BSM no-arbitrage band (within tolerance). - return.assumptions: Assumptions; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — The violations as structured warnings (empty when admissible). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.lower: number; default: not declared — The no-arbitrage lower bound (discounted intrinsic). - return.upper: number; default: not declared — The no-arbitrage upper bound (call: discounted spot; put: discounted strike). ### @insiderfinance/totalfinance/options#cliquet Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cliquet: { readonly monteCarloPrice: (input: CliquetInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; readonly price: (input: CliquetInput) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: CliquetInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — General Monte-Carlo cliquet (local + global caps/floors); converges to the analytic in the no-global case. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): CliquetInput; default: not declared - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).globalCap?: number; default: not declared — Global (summed) cap; default `+∞`. Requires `monteCarloPrice`. - monteCarloPrice(input).globalFloor?: number; default: not declared — Global (summed) floor; default `−∞`. Requires `monteCarloPrice`. - monteCarloPrice(input).localCap?: number; default: not declared — Per-period return cap; default `+∞` (uncapped). Must be > `localFloor`. - monteCarloPrice(input).localFloor?: number; default: not declared — Per-period return floor; default 0 (lock in non-negative gains). Must be ≥ −1. - monteCarloPrice(input).notional?: number; default: not declared — Notional multiplier; default 1. - monteCarloPrice(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - price: (input: CliquetInput) => ExoticResult; default: not declared — Closed-form cliquet (a strip of forward-start caplets), valid when there is NO global cap/floor — the value is then the discounted sum of the per-period expected clipped returns (Black-76 on each period return). A global cap/floor makes the total path-dependent; this throws and points to `monteCarloPrice`. See `docs/specs/cliquet.md`. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): CliquetInput; default: not declared - price(input).dividendYield?: number; default: not declared - price(input).globalCap?: number; default: not declared — Global (summed) cap; default `+∞`. Requires `monteCarloPrice`. - price(input).globalFloor?: number; default: not declared — Global (summed) floor; default `−∞`. Requires `monteCarloPrice`. - price(input).localCap?: number; default: not declared — Per-period return cap; default `+∞` (uncapped). Must be > `localFloor`. - price(input).localFloor?: number; default: not declared — Per-period return floor; default 0 (lock in non-negative gains). Must be ≥ −1. - price(input).notional?: number; default: not declared — Notional multiplier; default 1. - price(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - price(input).riskFreeRate: number; default: not declared - price(input).spot: number; default: not declared - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#compareEngines Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price one contract across many engines and report each engine's value, Greeks, convergence, timing, and deviation from a high-resolution reference (spec §9.7). Rows are sorted most-accurate first. This is the tool for choosing an engine and for validating new ones against the lattice convergence benchmark — no silent "best" pick, every number is shown with its diagnostics. Supply a custom panel as `options.engines`; all request fields live in one object so adding a benchmark or clock never creates a second calling form. ```typescript export declare function compareEngines(input: CompareEnginesInput): EngineComparison; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CompareEnginesInput; default: not declared - (input).contract: OptionContract; default: not declared - (input).market: OptionMarket; default: not declared - (input).options?: CompareEnginesOptions; default: not declared - (input).options.engines?: OptionPricingEngine[]; default: not declared — Engines to compare. Defaults to the built-in panel that supports the contract. - (input).options.now?: () => number; default: not declared — Optional monotonic clock (e.g. `() => performance.now()`). When supplied, each engine's wall-clock pricing time is measured into `timingMs`. Omitted by default so the function stays pure (no system-clock read) — timing is opt-in instrumentation the caller injects. - (input).options.reference?: OptionPricingEngine; default: not declared — Convergence benchmark. Defaults to a 1001-step Leisen–Reimer lattice. - return.assumptions: { conventionsVersion: string; engines: number; referenceEngine: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.engines: number; default: not declared - return.assumptions.referenceEngine: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present — engine failures are summarized here (details per row). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.reference: { engine: string; value: number; }; default: not declared - return.reference.engine: string; default: not declared - return.reference.value: number; default: not declared - return.rows: EngineComparisonRow[]; default: not declared ### @insiderfinance/totalfinance/options#compo Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const compo: { readonly greeks: (input: CompoInput & { type: OptionType; }) => Computed; readonly monteCarloPrice: (input: CompoInput & { type: OptionType; }, options: CompoMonteCarloOptions) => ExoticMonteCarloResult; readonly price: (input: CompoInput & { type: OptionType; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: (input: CompoInput & { type: OptionType; }) => Computed; default: not declared — The compo's multi-factor risk: foreign-asset and FX deltas, foreign-asset gamma, the asset and FX vegas, the **correlation vega** (a compo is long correlation), plus theta and domestic rho — all exact chain-rule derivatives of the composite BSM greeks through `A₀ = S_f·X` and `σ_A`. - greeks().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks().return.value: CompoGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks(input): CompoInput & { type: OptionType; }; default: not declared - greeks(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - greeks(input).dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - greeks(input).domesticRate: number; default: not declared — Domestic discount / growth rate. - greeks(input).fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - greeks(input).fxVolatility: number; default: not declared — FX volatility `σ_X`. - greeks(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - greeks(input).strike: number; default: not declared — Strike, in DOMESTIC currency. - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).type: OptionType; default: not declared - greeks(input).volatility: number; default: not declared — Foreign-asset volatility `σ_S`. - monteCarloPrice: (input: CompoInput & { type: OptionType; }, options: CompoMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — Two-factor Monte-Carlo: simulate `S_f` and `X` as correlated GBMs under the domestic measure and price `(S_f(T)·X(T) − K)⁺` discounted at `r_d`. Converges to the closed form, corroborating the `σ_A` combination. `options.foreignRate` (default `domesticRate`) only splits the two drifts — the price is invariant to it. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): CompoInput & { type: OptionType; }; default: not declared - monteCarloPrice(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - monteCarloPrice(input).dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - monteCarloPrice(input).domesticRate: number; default: not declared — Domestic discount / growth rate. - monteCarloPrice(input).fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - monteCarloPrice(input).fxVolatility: number; default: not declared — FX volatility `σ_X`. - monteCarloPrice(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - monteCarloPrice(input).strike: number; default: not declared — Strike, in DOMESTIC currency. - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared — Foreign-asset volatility `σ_S`. - monteCarloPrice(options): CompoMonteCarloOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).foreignRate?: number; default: not declared — Foreign rate used only to split the two-factor drift; the price is invariant to it. Default = `domesticRate`. - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - price: (input: CompoInput & { type: OptionType; }) => ExoticResult; default: not declared — Composite option paying `(S_f(T)·X(T) − K_d)⁺` in domestic currency — the foreign asset at the FLOATING FX rate against a domestic strike. The domestic value `A = S_f·X` is a domestic asset drifting at `r_d − q`, so this is exactly `BSM(A₀ = S_f·X, K_d, T, r_d, q, σ_A)` with the composite vol `σ_A = √(σ_S² + σ_X² + 2ρσ_Sσ_X)`. The foreign rate drops out. See `docs/specs/compo-option.md`. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): CompoInput & { type: OptionType; }; default: not declared - price(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in `[−1, 1]`. - price(input).dividendYield?: number; default: not declared — Foreign dividend yield `q`. Default 0. - price(input).domesticRate: number; default: not declared — Domestic discount / growth rate. - price(input).fxSpot: number; default: not declared — FX rate — units of domestic currency per unit of foreign (`X₀`). - price(input).fxVolatility: number; default: not declared — FX volatility `σ_X`. - price(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - price(input).strike: number; default: not declared — Strike, in DOMESTIC currency. - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared — Foreign-asset volatility `σ_S`. ### @insiderfinance/totalfinance/options#defineOptionPricingEngine Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Define a custom pricing engine (spec §22.1). TotalFinance treats it like any built-in engine: pass it to `option.price({ contract: contract, market: market, engine: engine })`. ```typescript export declare function defineOptionPricingEngine(engine: OptionPricingEngine): OptionPricingEngine; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (engine): OptionPricingEngine; default: not declared - (engine).capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - (engine).capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - (engine).capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - (engine).capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - (engine).capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - (engine).capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - (engine).name: string; default: not declared - (engine).price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - (engine).supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - (engine).version: string; default: not declared - return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - return.name: string; default: not declared - return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - return.version: string; default: not declared ### @insiderfinance/totalfinance/options#digital Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const digital: { readonly extendedGreeks: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }) => Computed; readonly greeks: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }) => Computed; readonly monteCarloPrice: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; readonly price: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - extendedGreeks: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }) => Computed; default: not declared — The full higher-order (extended) Greek set for the European binary — completing {@link digital.greeks} with vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, and lambda. The binary price is a smooth function of `(S, σ, r, q, T)` for `T > 0`, so the higher-order Greeks are taken by central finite differences of the exact `digital.price` closed form (the shared `finiteDifferenceExtendedGreeks` helper); the first-order fields are the exact analytic Greeks of {@link digital.greeks}. Units match the package (higher-order raw; `phi` per 1% dividend yield; `lambda` dimensionless). Near the strike a binary's Greeks spike (pin risk) — they stay finite for `T > 0`, but very close to expiry-at-the-pin the higher-order finite differences lose precision; widen `t` or read the sign/scale rather than the digit. See `docs/specs/digital-extended-greeks.md`. - extendedGreeks().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - extendedGreeks().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - extendedGreeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - extendedGreeks().return.value: ExtendedGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - extendedGreeks(input): DigitalInput & { kind: DigitalKind; type: OptionType; }; default: not declared - extendedGreeks(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - extendedGreeks(input).dividendYield?: number; default: not declared - extendedGreeks(input).kind: DigitalKind; default: not declared - extendedGreeks(input).riskFreeRate: number; default: not declared - extendedGreeks(input).spot: number; default: not declared - extendedGreeks(input).strike: number; default: not declared - extendedGreeks(input).timeToExpiryYears: number; default: not declared - extendedGreeks(input).type: OptionType; default: not declared - extendedGreeks(input).volatility: number; default: not declared - greeks: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }) => Computed; default: not declared — Closed-form greeks (delta, gamma, vega, theta, rho) for the European binary. Every greek is an exact derivative of the `digital.price` closed form — pinned to a finite-difference bump in the tests. Units match the package: `vega` per vol point, `theta` per calendar day, `rho` per 1% (echoed in `assumptions.units`). A cash-or-nothing's delta spikes and gamma flips sign across the strike (pin risk); the asset-or-nothing's gamma/vega are exactly `0` at `d₂ = 0`. See `docs/specs/digital-greeks.md`. - greeks().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks().return.value: Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks(input): DigitalInput & { kind: DigitalKind; type: OptionType; }; default: not declared - greeks(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - greeks(input).dividendYield?: number; default: not declared - greeks(input).kind: DigitalKind; default: not declared - greeks(input).riskFreeRate: number; default: not declared - greeks(input).spot: number; default: not declared - greeks(input).strike: number; default: not declared - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).type: OptionType; default: not declared - greeks(input).volatility: number; default: not declared - monteCarloPrice: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo binary price (discount the terminal indicator payoff); converges to the analytic. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): DigitalInput & { kind: DigitalKind; type: OptionType; }; default: not declared - monteCarloPrice(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).kind: DigitalKind; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).strike: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - price: (input: DigitalInput & { type: OptionType; kind: DigitalKind; }) => ExoticResult; default: not declared — European binary price (closed form). A vanilla call ≡ asset-or-nothing call − K·cash-or-nothing call. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): DigitalInput & { kind: DigitalKind; type: OptionType; }; default: not declared - price(input).cash?: number; default: not declared — Fixed payout for `cash-or-nothing` (ignored by `asset-or-nothing`); default 1. - price(input).dividendYield?: number; default: not declared - price(input).kind: DigitalKind; default: not declared - price(input).riskFreeRate: number; default: not declared - price(input).spot: number; default: not declared - price(input).strike: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#dividendTermStructure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the dividend term structure — per-expiry forward, dividend PV, and continuous-equivalent yield — from a discrete cash schedule and/or a continuous yield. See `docs/specs/dividend-term-structure.md`. ```typescript export declare function dividendTermStructure(input: DividendTermStructureInput): DividendTermStructure; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DividendTermStructureInput; default: not declared - (input).asOf: string | number; default: not declared — Valuation date; ex-dates and maturities are measured from here (epoch ms or ISO). Required. - (input).dividendYield?: number; default: not declared — Continuous dividend yield applied alongside the discrete schedule (decimal); default `0`. - (input).dividends?: DiscreteDividend[]; default: not declared — Discrete cash dividends (ISO ex-date + per-share amount). Omitted / empty ⇒ continuous-only. - (input).maturities: string[]; default: not declared — The expiries (ISO dates) to report the term structure at. At least one, each after `asOf`. - (input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - (input).spot: number; default: not declared - return.assumptions: { continuousYield: number; conventionsVersion: string; dividendModel: DividendModel; riskFreeRate: number; spot: number; }; default: not declared - return.assumptions.continuousYield: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.dividendModel: DividendModel; default: not declared - return.assumptions.riskFreeRate: number; default: not declared - return.assumptions.spot: number; default: not declared - return.continuousYield: number; default: not declared — The continuous yield echoed back (`0` when none supplied). - return.diagnostics: Diagnostics; default: not declared - return.points: DividendTermStructurePoint[]; default: not declared — One row per requested expiry, sorted ascending by tenor. - return.summary: string; default: not declared — One-line, agent-relayable summary. - return.totalDividendPresentValue: number; default: not declared — PV of every *future* dividend in the schedule (all `τᵢ > 0`), independent of the maturities asked. ### @insiderfinance/totalfinance/options#doubleTouch Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const doubleTouch: { readonly greeks: (input: DoubleTouchInput & { kind: DoubleTouchKind; }) => Computed; readonly monteCarloPrice: (input: DoubleTouchInput & { kind: DoubleTouchKind; }, options: TouchMonteCarloOptions) => ExoticMonteCarloResult; readonly price: (input: DoubleTouchInput & { kind: DoubleTouchKind; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: (input: DoubleTouchInput & { kind: DoubleTouchKind; }) => Computed; default: not declared — First-order greeks (delta, gamma, vega, theta, rho) for the double-no-touch / double-one-touch corridor binary, by central finite-difference of the exact `doubleTouch.price` (the image-series precludes clean analytic greeks). Units match the package (vega/1%, theta/day, rho/1%; echoed in `assumptions.units`). The spot bump is shrunk near either barrier so it never straddles the corridor edge. Pinned to the exact `DNT + DOT = cash·e^{−rT}` greek identity. See `docs/specs/touch-greeks.md`. - greeks().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks().return.value: Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks(input): DoubleTouchInput & { kind: DoubleTouchKind; }; default: not declared - greeks(input).cash?: number; default: not declared — Payout on the winning outcome; default 1. - greeks(input).dividendYield?: number; default: not declared - greeks(input).kind: DoubleTouchKind; default: not declared - greeks(input).lower: number; default: not declared — Lower barrier `L` (> 0). - greeks(input).riskFreeRate: number; default: not declared - greeks(input).spot: number; default: not declared - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).upper: number; default: not declared — Upper barrier `U` (> L). - greeks(input).volatility: number; default: not declared - monteCarloPrice: (input: DoubleTouchInput & { kind: DoubleTouchKind; }, options: TouchMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo double-no-touch / double-one-touch. The corridor survival per path is the product of the two single-barrier Brownian-bridge survivals (lower down × upper up), so discrete monitoring converges to the continuous analytic. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): DoubleTouchInput & { kind: DoubleTouchKind; }; default: not declared - monteCarloPrice(input).cash?: number; default: not declared — Payout on the winning outcome; default 1. - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).kind: DoubleTouchKind; default: not declared - monteCarloPrice(input).lower: number; default: not declared — Lower barrier `L` (> 0). - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).upper: number; default: not declared — Upper barrier `U` (> L). - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): TouchMonteCarloOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 100). - price: (input: DoubleTouchInput & { kind: DoubleTouchKind; }) => ExoticResult; default: not declared — Double no-touch (pays if `S` stays in `(L, U)` the whole life) / double one-touch (pays if it ever leaves), continuous monitoring, settled at expiry. The image-series survival `P_stay` drives both: `DNT = cash·e^{−rT}·P_stay`, `DOT = cash·e^{−rT}·(1 − P_stay)`, so `DNT + DOT = cash·e^{−rT}`. A spot already outside the corridor short-circuits (DNT = 0, DOT = cash·e^{−rT}). See `docs/specs/double-touch.md`. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): DoubleTouchInput & { kind: DoubleTouchKind; }; default: not declared - price(input).cash?: number; default: not declared — Payout on the winning outcome; default 1. - price(input).dividendYield?: number; default: not declared - price(input).kind: DoubleTouchKind; default: not declared - price(input).lower: number; default: not declared — Lower barrier `L` (> 0). - price(input).riskFreeRate: number; default: not declared - price(input).spot: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).upper: number; default: not declared — Upper barrier `U` (> L). - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#engines Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#engines`. ### @insiderfinance/totalfinance/options#european Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). European-exercise contract with the convention in the name (index-style options). A DATE-ONLY expiry must say which instant it means: pass a zoned datetime, or add `convention: 'us-equity-close'` to opt into the 16:00 ET close explicitly. The silent US-equity default belongs to `usEquityCall`/`usEquityPut`, whose NAMES carry it — European index products settle at different instants (AM auctions, European closes), so guessing here would be silent economics (Law 6). ```typescript export declare function european(input: InstrumentBuilderInput & { type: OptionType; convention?: 'us-equity-close'; }): OptionContract; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InstrumentBuilderInput & { convention?: 'us-equity-close'; type: OptionType; }; default: not declared - (input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - (input).currency?: string; default: not declared - (input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - (input).multiplier?: number; default: not declared - (input).root?: string; default: not declared - (input).strike: number; default: not declared - (input).type: OptionType; default: not declared - (input).underlying: string; default: not declared - return.adjusted?: boolean; default: not declared - return.currency?: string; default: not declared - return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - return.multiplier?: number; default: not declared - return.occSymbol?: string; default: not declared - return.root?: string; default: not declared - return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - return.strike: number; default: not declared - return.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - return.type: OptionType; default: not declared - return.underlying: string; default: not declared ### @insiderfinance/totalfinance/options#forwardStart Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const forwardStart: { readonly monteCarloPrice: (input: ForwardStartInput & { type: OptionType; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; readonly price: (input: ForwardStartInput & { type: OptionType; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: ForwardStartInput & { type: OptionType; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Two-step-GBM Monte-Carlo forward-start price (converges to the analytic). - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): ForwardStartInput & { type: OptionType; }; default: not declared - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).resetTime: number; default: not declared — Reset time `t₁` (years) at which the strike is fixed; must be in `(0, t)`. - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).strikeMultiplier?: number; default: not declared — Strike multiplier α: the strike is set to `α·S(t₁)` at the reset (α=1 ⇒ at-the-money-at-reset). Default 1. - monteCarloPrice(input).timeToExpiryYears: number; default: not declared — Expiry `T` (years). - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - price: (input: ForwardStartInput & { type: OptionType; }) => ExoticResult; default: not declared — Closed-form forward-start price (Rubinstein 1991); the value scales with today's spot. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): ForwardStartInput & { type: OptionType; }; default: not declared - price(input).dividendYield?: number; default: not declared - price(input).resetTime: number; default: not declared — Reset time `t₁` (years) at which the strike is fixed; must be in `(0, t)`. - price(input).riskFreeRate: number; default: not declared - price(input).spot: number; default: not declared - price(input).strikeMultiplier?: number; default: not declared — Strike multiplier α: the strike is set to `α·S(t₁)` at the reset (α=1 ⇒ at-the-money-at-reset). Default 1. - price(input).timeToExpiryYears: number; default: not declared — Expiry `T` (years). - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#gbm Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The geometric-Brownian-motion namespace — the grouped surface over the flat `gbm*` kernels. `gbm.path` / `gbm.terminal` are the same functions; prefer the namespace over the deprecated flats. ```typescript export declare const gbm: { readonly path: (input: GbmPathInput) => Float64Array; readonly terminal: (input: GbmTerminalInput) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - path: (input: GbmPathInput) => Float64Array; default: not declared - path(input): GbmPathInput; default: not declared - path(input).dividendYield: number; default: not declared - path(input).riskFreeRate: number; default: not declared - path(input).shocks: number[]; default: not declared - path(input).spot: number; default: not declared - path(input).timeToExpiryYears: number; default: not declared - path(input).volatility: number; default: not declared - terminal: (input: GbmTerminalInput) => number; default: not declared - terminal(input): GbmTerminalInput; default: not declared - terminal(input).dividendYield: number; default: not declared - terminal(input).riskFreeRate: number; default: not declared - terminal(input).shock: number; default: not declared - terminal(input).spot: number; default: not declared - terminal(input).timeToExpiryYears: number; default: not declared - terminal(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#heston Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Heston model namespace — the grouped, discoverable surface over the flat `heston*` functions. `heston.price` / `heston.monteCarloPrice` / `heston.cosineExpansion` / `heston.impliedVolatility` / `heston.monteCarloEstimate` are the same functions; prefer the namespace over the deprecated flat exports. ```typescript export declare const heston: { readonly cosineExpansion: (input: HestonCosineExpansionPriceInput) => number; readonly impliedVolatility: (request: HestonPriceRequest) => BlackScholesImpliedVolatilityResult; readonly monteCarloEstimate: (input: HestonMonteCarloEstimateInput) => MonteCarloEstimate; readonly monteCarloPrice: (request: HestonPriceMonteCarloRequest) => HestonMonteCarloResult; readonly price: (request: HestonPriceRequest) => PriceResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cosineExpansion: (input: HestonCosineExpansionPriceInput) => number; default: not declared - cosineExpansion(input): HestonCosineExpansionPriceInput; default: not declared - cosineExpansion(input).dividendYield: number; default: not declared - cosineExpansion(input).parameters: HestonParameters; default: not declared - cosineExpansion(input).riskFreeRate: number; default: not declared - cosineExpansion(input).spot: number; default: not declared - cosineExpansion(input).strike: number; default: not declared - cosineExpansion(input).terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192). - cosineExpansion(input).timeToExpiryYears: number; default: not declared - cosineExpansion(input).truncation?: number; default: not declared - cosineExpansion(input).type: OptionType; default: not declared - impliedVolatility: (request: HestonPriceRequest) => BlackScholesImpliedVolatilityResult; default: not declared - impliedVolatility().return.converged: boolean; default: not declared - impliedVolatility().return.error?: number; default: not declared - impliedVolatility().return.iterations: number; default: not declared - impliedVolatility().return.message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - impliedVolatility().return.reason?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityReason; default: not declared - impliedVolatility().return.value: number; default: not declared - impliedVolatility(request): HestonPriceRequest; default: not declared - impliedVolatility(request).input: HestonInput; default: not declared - impliedVolatility(request).options?: HestonCosineExpansionOptions; default: not declared - impliedVolatility(request).parameters: HestonParameters; default: not declared - impliedVolatility(request).type: OptionType; default: not declared - monteCarloEstimate: (input: HestonMonteCarloEstimateInput) => MonteCarloEstimate; default: not declared - monteCarloEstimate().return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarloEstimate().return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - monteCarloEstimate().return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarloEstimate().return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarloEstimate().return.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarloEstimate().return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarloEstimate().return.value: number; default: not declared - monteCarloEstimate().return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarloEstimate().return.warnings: QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). - monteCarloEstimate(input): HestonMonteCarloEstimateInput; default: not declared - monteCarloEstimate(input).dividendYield: number; default: not declared - monteCarloEstimate(input).options: HestonMonteCarloOptions; default: not declared - monteCarloEstimate(input).parameters: HestonParameters; default: not declared - monteCarloEstimate(input).riskFreeRate: number; default: not declared - monteCarloEstimate(input).spot: number; default: not declared - monteCarloEstimate(input).strike: number; default: not declared - monteCarloEstimate(input).timeToExpiryYears: number; default: not declared - monteCarloEstimate(input).type: OptionType; default: not declared - monteCarloPrice: (request: HestonPriceMonteCarloRequest) => HestonMonteCarloResult; default: not declared - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.greeks?: Greeks | ExtendedGreeks; default: not declared - monteCarloPrice().return.greeks.charm: number; default: not declared - monteCarloPrice().return.greeks.color: number; default: not declared - monteCarloPrice().return.greeks.delta: number; default: not declared - monteCarloPrice().return.greeks.gamma: number; default: not declared - monteCarloPrice().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - monteCarloPrice().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - monteCarloPrice().return.greeks.rho: number; default: not declared - monteCarloPrice().return.greeks.speed: number; default: not declared - monteCarloPrice().return.greeks.theta: number; default: not declared - monteCarloPrice().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - monteCarloPrice().return.greeks.vanna: number; default: not declared - monteCarloPrice().return.greeks.vega: number; default: not declared - monteCarloPrice().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - monteCarloPrice().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - monteCarloPrice().return.greeks.vomma: number; default: not declared - monteCarloPrice().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(request): HestonPriceMonteCarloRequest; default: not declared - monteCarloPrice(request).input: HestonInput; default: not declared - monteCarloPrice(request).options: HestonMonteCarloOptions; default: not declared - monteCarloPrice(request).parameters: HestonParameters; default: not declared - monteCarloPrice(request).type: OptionType; default: not declared - price: (request: HestonPriceRequest) => PriceResult; default: not declared - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.greeks?: Greeks | ExtendedGreeks; default: not declared - price().return.greeks.charm: number; default: not declared - price().return.greeks.color: number; default: not declared - price().return.greeks.delta: number; default: not declared - price().return.greeks.gamma: number; default: not declared - price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - price().return.greeks.rho: number; default: not declared - price().return.greeks.speed: number; default: not declared - price().return.greeks.theta: number; default: not declared - price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - price().return.greeks.vanna: number; default: not declared - price().return.greeks.vega: number; default: not declared - price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - price().return.greeks.vomma: number; default: not declared - price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(request): HestonPriceRequest; default: not declared - price(request).input: HestonInput; default: not declared - price(request).options?: HestonCosineExpansionOptions; default: not declared - price(request).parameters: HestonParameters; default: not declared - price(request).type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#impliedBorrow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied borrow / financing spread: the regression-implied financing rate `r*` (from the parity slope) minus the supplied `rate`. Zero when the chain was priced at exactly `rate`. ```typescript export declare function impliedBorrow(input: ImpliedBorrowInput): ParityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedBorrowInput; default: not declared - (input).expiry: string; default: not declared - (input).options: ImpliedBorrowOptions; default: not declared - (input).quotes: readonly OptionQuote[]; default: not declared - return.assumptions: ParityAssumptions; default: not declared - return.diagnostics: ParityDiagnostics; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options#impliedDividendYield Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied continuous dividend yield `q` from `F = S·e^((r−q)T)` ⇒ `q = r − ln(F/S)/T`, using the regression forward and the supplied `spot`/`rate`. ```typescript export declare function impliedDividendYield(input: ImpliedDividendYieldInput): ParityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedDividendYieldInput; default: not declared - (input).expiry: string; default: not declared - (input).options: ImpliedDividendYieldOptions; default: not declared - (input).quotes: readonly OptionQuote[]; default: not declared - return.assumptions: ParityAssumptions; default: not declared - return.diagnostics: ParityDiagnostics; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options#impliedForward Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied forward `F` from put-call parity across one expiry's chain. Regresses `C(K) − P(K)` on `K`; from `slope = −e^(−rT)` and `intercept = e^(−rT)·F`, `F = −intercept / slope`. The supplied `rate` is echoed and compared against the regression-implied financing rate (reported in `diagnostics.impliedRate`); it does not bias `F`. ```typescript export declare function impliedForward(input: ImpliedForwardInput): ParityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedForwardInput; default: not declared - (input).expiry: string; default: not declared - (input).options: ImpliedForwardOptions; default: not declared - (input).quotes: readonly OptionQuote[]; default: not declared - return.assumptions: ParityAssumptions; default: not declared - return.diagnostics: ParityDiagnostics; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options#impliedVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#impliedVolatility`. ### @insiderfinance/totalfinance/options#impliedVolatilityMany Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Batch implied volatility with per-row diagnostics on `results`. A bad row yields a non-converged row result rather than aborting the chain — unless `failFast` is set. ```typescript export declare function impliedVolatilityMany(rows: BlackScholesImpliedVolatilityInput[], options?: ImpliedVolatilityOptions): ImpliedVolatilityBatchResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: ImpliedVolatilityOptions; default: not declared - (options).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - (options).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - (options).method?: ImpliedVolatilityMethod; default: not declared - (rows): BlackScholesImpliedVolatilityInput[]; default: not declared - return.assumptions: Assumptions<{ rows: number; }>; default: not declared — Applied conventions, echoed (per-row `timeToExpiryYears` rides each row's own assumptions). - return.diagnostics: { converged: boolean; engine: string; method: string; warnings: QuantWarning[]; }; default: not declared — Batch diagnostics: `converged` is true iff EVERY row converged. - return.diagnostics.converged: boolean; default: not declared - return.diagnostics.engine: string; default: not declared - return.diagnostics.method: string; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.results: ImpliedVolatilitySolveResult[]; default: not declared — One solve envelope per input row, in input order. ### @insiderfinance/totalfinance/options#impliedVolatilityOption Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function impliedVolatilityOption(input: ImpliedVolatilityOptionInput): ImpliedVolatilitySolveResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedVolatilityOptionInput; default: not declared - (input).contract: OptionContract; default: not declared - (input).engine?: OptionPricingEngine; default: not declared — Engine to invert numerically. An American contract always inverts an engine (default `engines.bjerksundStensland2002()`); a European contract inverts closed-form Black–Scholes–Merton unless an engine is named here, in which case THAT engine is inverted — e.g. a lattice for discrete dividends, or a custom model. `method`/`fallback`/`failFast` belong to the closed-form route and are refused alongside an engine. - (input).failFast?: boolean; default: not declared — In batch mode, throw on the first bad row instead of recording it (default `false`). - (input).fallback?: boolean; default: not declared — Fall back to Brent when a derivative method fails (default `true`). - (input).market: OptionMarket; default: not declared - (input).method?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityMethod; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: (import('@insiderfinance/totalfinance/core').Diagnostics) | (import('@insiderfinance/totalfinance/options').ImpliedVolatilityDiagnostics); default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#inverseOption Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inverseOption: { readonly barrier: (input: InverseOptionInput & { type: OptionType; barrierType: BarrierType; barrier: number; }) => ExoticResult; readonly digital: (input: InverseOptionInput & { type: OptionType; kind: DigitalKind; cash?: number; }) => ExoticResult; readonly greeks: (input: InverseOptionInput & { type: OptionType; }) => Computed; readonly monteCarloPrice: (input: InverseOptionInput & { type: OptionType; }, options: InverseOptionMonteCarloOptions) => ExoticMonteCarloResult; readonly price: (input: InverseOptionInput & { type: OptionType; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - barrier: (input: InverseOptionInput & { type: OptionType; barrierType: BarrierType; barrier: number; }) => ExoticResult; default: not declared — The **coin premium** of a coin-settled (inverse) **barrier** (continuous monitoring, zero rebate). By the same universal identity, the coin premium is the vanilla barrier's USD price divided by spot. `value·spot` recovers the USD premium. See `docs/specs/inverse-option.md`. - barrier().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - barrier().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - barrier().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - barrier().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - barrier(input): InverseOptionInput & { barrier: number; barrierType: BarrierType; type: OptionType; }; default: not declared - barrier(input).barrier: number; default: not declared - barrier(input).barrierType: BarrierType; default: not declared - barrier(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - barrier(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - barrier(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - barrier(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - barrier(input).timeToExpiryYears: number; default: not declared - barrier(input).type: OptionType; default: not declared - barrier(input).volatility: number; default: not declared — Volatility. - digital: (input: InverseOptionInput & { type: OptionType; kind: DigitalKind; cash?: number; }) => ExoticResult; default: not declared — The **coin premium** of a coin-settled (inverse) **binary**. Every coin-settled exotic obeys the same universal identity as the vanilla: a coin payoff `H(S_T)/S_T` is worth `H(S_T)` USD at expiry (1 coin = `S_T` USD then), so its USD price is the vanilla's and its coin premium is exactly `vanillaUsd/spot`. A `cash-or-nothing` therefore settles its `cash` USD-equivalent in the coin, an `asset-or-nothing` settles 1 coin if in-the-money. `value·spot` recovers the USD premium. See `docs/specs/inverse-option.md`. - digital().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - digital().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - digital().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - digital().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - digital(input): InverseOptionInput & { cash?: number; kind: DigitalKind; type: OptionType; }; default: not declared - digital(input).cash?: number; default: not declared - digital(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - digital(input).kind: DigitalKind; default: not declared - digital(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - digital(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - digital(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - digital(input).timeToExpiryYears: number; default: not declared - digital(input).type: OptionType; default: not declared - digital(input).volatility: number; default: not declared — Volatility. - greeks: (input: InverseOptionInput & { type: OptionType; }) => Computed; default: not declared — The inverse option's risk in **both** denominations. The `coin` greeks are the exact derivatives of the coin premium `V_usd/S`: delta and gamma carry the numeraire corrections (`Δ_coin = Δ_usd/S − V_usd/S²`, `Γ_coin = Γ_usd/S − 2Δ_usd/S² + 2V_usd/S³`), while vega/theta/rho scale by `1/S`. The `usd` greeks equal the vanilla BSM greeks. The `−V_coin/S` delta term is the embedded short-coin from the coin-denominated premium — an inverse option is NOT hedged at its Black–Scholes delta. - greeks().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks().return.value: InverseGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks(input): InverseOptionInput & { type: OptionType; }; default: not declared - greeks(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - greeks(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - greeks(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - greeks(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).type: OptionType; default: not declared - greeks(input).volatility: number; default: not declared — Volatility. - monteCarloPrice: (input: InverseOptionInput & { type: OptionType; }, options: InverseOptionMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — One-factor **coin-numeraire** Monte-Carlo: under the coin money-market numeraire the spot drifts at the self-quanto rate `r − q + σ²`, and the coin premium is `E[e^{−qT}·(±(S_T−K))⁺/S_T]`. Converges to the closed-form coin premium, corroborating the `V_usd/S` identity from the other measure. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): InverseOptionInput & { type: OptionType; }; default: not declared - monteCarloPrice(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - monteCarloPrice(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - monteCarloPrice(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - monteCarloPrice(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared — Volatility. - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - price: (input: InverseOptionInput & { type: OptionType; }) => ExoticResult; default: not declared — The **coin (base-currency) premium** of a Deribit-style inverse option, settling `(±(S_T−K))⁺/S_T` in the coin. The USD payoff is a vanilla's, so the coin premium is exactly `blackScholesPrice/spot`. `value·spot` recovers the USD premium. `rate` is the USD/quote rate; `coinYield` the coin lending/staking yield. See `docs/specs/inverse-option.md`. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): InverseOptionInput & { type: OptionType; }; default: not declared - price(input).coinYield?: number; default: not declared — Coin (base-currency) yield — lending/staking. Default 0. Enters the forward as the dividend yield. - price(input).riskFreeRate: number; default: not declared — USD (quote-currency) risk-free rate. - price(input).spot: number; default: not declared — Underlying spot, quote per coin (e.g. BTC/USD). - price(input).strike: number; default: not declared — Strike, in the QUOTE currency (USD). - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared — Volatility. ### @insiderfinance/totalfinance/options#localVolatility Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The local-volatility namespace — the grouped, discoverable surface over the flat local-volatility functions. `localVolatility.fromImplied` / `localVolatility.grid` / `localVolatility.monteCarloPrice` / `localVolatility.monteCarloEstimate` are the same functions; prefer the namespace over the deprecated flat exports. ```typescript export declare const localVolatility: { readonly fromImplied: (input: DupireLocalVolatilityInput) => LocalVolatilityFunction; readonly grid: (localVolatility: LocalVolatilityFunction, specification: LocalVolatilityGridSpecification) => LocalVolatilityFunction; readonly monteCarloEstimate: (input: LocalVolatilityMonteCarloEstimateInput) => MonteCarloEstimate; readonly monteCarloPrice: (request: LocalVolatilityPriceMonteCarloRequest) => LocalVolatilityMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromImplied: (input: DupireLocalVolatilityInput) => LocalVolatilityFunction; default: not declared - fromImplied(input): DupireLocalVolatilityInput; default: not declared - fromImplied(input).impliedVolatility: ImpliedVolatilityFunction; default: not declared - fromImplied(input).market: LocalVolatilityMarket; default: not declared - fromImplied(input).options?: DupireOptions; default: not declared - grid: (localVolatility: LocalVolatilityFunction, specification: LocalVolatilityGridSpecification) => LocalVolatilityFunction; default: not declared - grid(localVolatility): LocalVolatilityFunction; default: not declared - grid(specification): LocalVolatilityGridSpecification; default: not declared - grid(specification).levels: number[]; default: not declared — Underlying levels, ascending (e.g. 0.4·S₀ … 2.5·S₀). - grid(specification).times: number[]; default: not declared — Times in years, ascending (e.g. up to the longest expiry priced). - monteCarloEstimate: (input: LocalVolatilityMonteCarloEstimateInput) => MonteCarloEstimate; default: not declared - monteCarloEstimate().return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarloEstimate().return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - monteCarloEstimate().return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarloEstimate().return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarloEstimate().return.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarloEstimate().return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarloEstimate().return.value: number; default: not declared - monteCarloEstimate().return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarloEstimate().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). - monteCarloEstimate(input): LocalVolatilityMonteCarloEstimateInput; default: not declared - monteCarloEstimate(input).dividendYield: number; default: not declared - monteCarloEstimate(input).localVolatility: LocalVolatilityFunction; default: not declared - monteCarloEstimate(input).options: LocalVolatilityMonteCarloOptions; default: not declared - monteCarloEstimate(input).riskFreeRate: number; default: not declared - monteCarloEstimate(input).spot: number; default: not declared - monteCarloEstimate(input).strike: number; default: not declared - monteCarloEstimate(input).timeToExpiryYears: number; default: not declared - monteCarloEstimate(input).type: OptionType; default: not declared - monteCarloPrice: (request: LocalVolatilityPriceMonteCarloRequest) => LocalVolatilityMonteCarloResult; default: not declared - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - monteCarloPrice().return.greeks.charm: number; default: not declared - monteCarloPrice().return.greeks.color: number; default: not declared - monteCarloPrice().return.greeks.delta: number; default: not declared - monteCarloPrice().return.greeks.gamma: number; default: not declared - monteCarloPrice().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - monteCarloPrice().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - monteCarloPrice().return.greeks.rho: number; default: not declared - monteCarloPrice().return.greeks.speed: number; default: not declared - monteCarloPrice().return.greeks.theta: number; default: not declared - monteCarloPrice().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - monteCarloPrice().return.greeks.vanna: number; default: not declared - monteCarloPrice().return.greeks.vega: number; default: not declared - monteCarloPrice().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - monteCarloPrice().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - monteCarloPrice().return.greeks.vomma: number; default: not declared - monteCarloPrice().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(request): LocalVolatilityPriceMonteCarloRequest; default: not declared - monteCarloPrice(request).input: LocalVolatilityInput; default: not declared - monteCarloPrice(request).localVolatility: LocalVolatilityFunction; default: not declared - monteCarloPrice(request).options: LocalVolatilityMonteCarloOptions; default: not declared - monteCarloPrice(request).type: OptionType; default: not declared ### @insiderfinance/totalfinance/options#lookback Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const lookback: { readonly monteCarloPrice: (input: LookbackInput & { type: OptionType; strikeType: LookbackStrike; }, options: LookbackMonteCarloOptions) => ExoticMonteCarloResult; readonly price: (input: LookbackInput & { type: OptionType; strikeType: LookbackStrike; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: LookbackInput & { type: OptionType; strikeType: LookbackStrike; }, options: LookbackMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo lookback price with the Broadie–Glasserman–Kou discrete-monitoring correction. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): LookbackInput & { strikeType: LookbackStrike; type: OptionType; }; default: not declared - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).runningMax?: number; default: not declared — Running maximum observed so far (default = spot). - monteCarloPrice(input).runningMin?: number; default: not declared — Running minimum observed so far (default = spot, a newly-issued option). - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).strike?: number; default: not declared — Strike (fixed-strike lookbacks only). - monteCarloPrice(input).strikeType: LookbackStrike; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): LookbackMonteCarloOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 150). - price: (input: LookbackInput & { type: OptionType; strikeType: LookbackStrike; }) => ExoticResult; default: not declared — Continuous-monitoring lookback price (Conze–Viswanathan / Goldman–Sosin–Gatto). - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): LookbackInput & { strikeType: LookbackStrike; type: OptionType; }; default: not declared - price(input).dividendYield?: number; default: not declared - price(input).riskFreeRate: number; default: not declared - price(input).runningMax?: number; default: not declared — Running maximum observed so far (default = spot). - price(input).runningMin?: number; default: not declared — Running minimum observed so far (default = spot, a newly-issued option). - price(input).spot: number; default: not declared - price(input).strike?: number; default: not declared — Strike (fixed-strike lookbacks only). - price(input).strikeType: LookbackStrike; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#market Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#market`. ### @insiderfinance/totalfinance/options#napoleon Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const napoleon: { readonly monteCarloPrice: (input: NapoleonInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: NapoleonInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Napoleon option: pays the coupon plus the **single worst** period return, `max(floor, C + minᵢ rᵢ)`. The investor is SHORT the volatility of the minimum return — a higher `volatility` LOWERS the value. No clean closed form (the minimum of `n` dependent lognormals), so Monte-Carlo only. See `docs/specs/napoleon-reverse-cliquet.md`. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): NapoleonInput; default: not declared - monteCarloPrice(input).coupon: number; default: not declared — The fixed coupon degraded by the period returns. - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - monteCarloPrice(input).notional?: number; default: not declared — Notional multiplier. Default 1. - monteCarloPrice(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#option Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#option`. ### @insiderfinance/totalfinance/options#optionChainHealth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Consolidated chain-health report. Structural malformations throw indexed InputError; absent prices/timestamps, empty chains and unavailable inverses are valid reports, never fake IVs. Omit config.model for quote health and coverage only: market needs just underlying and asOf, with no invented spot/rate/yield. Each model.status is 'not-requested', bounds/IV are null and the solver is not run. Select config.model: 'black-scholes-merton' to additionally assess compatibility under BSM dynamics, supplying market.spot and riskFreeRate (dividendYield follows the package rule: omitted is 0, echoed and disclosed). Each row is assessed under its OWN exercise style — a European row against the discounted closed-form band and inverse, an American row against the undiscounted intrinsic band and the Bjerksund–Stensland 2002 engine — never as the other style. This is quote health plus SELECTED model compatibility, NOT certification of all option pricing. Nonempty canonical DiscreteDividend schedules and adjusted deliverables report unsupported; no escrowed-dividend approximation is performed here. No clock, rate, exercise, or quote-source inference. Prices are per underlying share; multiplier and unconsumed provider fields are ignored. Stale/future/wide quotes are retained and may be inverted with their warnings attached; crossed markets are not inverted. BSM compatibility is NOT proof of quote validity, nor is incompatibility proof of a bad market observation. This report checks individual model bounds, not cross-strike/calendar static arbitrage. Controls are closed. Quote/contract/dividend observations are open and never mutated. Coverage counts all observations (including expired/unavailable), not an automatically filtered universe. Expected contracts use pricing identity; different venue/multiplier metadata does not create a second slot. A missing call/put side is only an observed-grid gap unless explicitly expected. Work: ≤10,000 quotes, ≤10,000 expected contracts, ≤1,000 dividends, bounded strings and at most 100 Brent iterations per quote. All lengths are checked before row traversal or result allocation. Rows preserve input order; coverage and missing-contract identities are sorted deterministically. ```typescript export declare function optionChainHealth(input: OptionChainHealthInput): OptionChainHealthReport; ``` Example (source JSDoc): ```ts import { option, optionChainHealth } from '@insiderfinance/totalfinance/options'; const contract = option.call({ underlying: 'X', style: 'european', strike: 100, expiry: '2027-01-01T00:00:00Z', }); const report = optionChainHealth({ quotes: [{ contract, timestampMs: 1767225600000, bid: 7.9, ask: 8.1 }], market: { underlying: 'X', spot: 100, asOf: '2026-01-01T00:00:00Z', riskFreeRate: 0, dividendYield: 0 }, config: { model: 'black-scholes-merton', priceSource: 'mid', maximumQuoteAgeMs: 60_000, maximumRelativeSpread: 0.1, }, }); if (!report.rows[0]?.model.solver.converged) throw new Error('IV unavailable'); // One-year ATM price 8 => annualized IV about 0.20086744, NOT an assumed 20%. if (Math.abs(report.rows[0].model.impliedVolatility! - 0.20086744) > 1e-7) throw new Error('Unexpected IV'); if (report.coverage.expiries[0]?.missingPutStrikes[0] !== 100) throw new Error('Expected unobserved put side'); const quotesOnly = optionChainHealth({ quotes: [{ contract, timestampMs: 1767225600000, bid: 9, ask: 7 }], market: { underlying: 'X', asOf: '2026-01-01T00:00:00Z' }, config: { priceSource: 'mid', maximumQuoteAgeMs: 60_000, maximumRelativeSpread: 0.1 }, }); if (quotesOnly.summary.issueCounts.crossed !== 1) throw new Error('Expected crossed quote'); if (quotesOnly.rows[0]?.model.status !== 'not-requested') throw new Error('No model requested'); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OptionChainHealthInput; default: not declared - return.assumptions: Assumptions<{ underlying: string; spot?: number; riskFreeRate?: number; dividendYield?: number; dividends: DiscreteDividend[]; modelAssessment: 'not-requested' | 'black-scholes-merton'; priceSource: PriceSource; priceUnit: 'per-underlying-share'; impliedVolatilityUnit: 'annualized-decimal'; exercisePolicy: 'by-contract-style' | 'not-assessed'; exerciseEngines?: { european: 'black-scholes-merton'; american: 'bjerksund-stensland-2002'; }; quotePolicy: 'report-only'; coverageIdentity: 'underlying-expiresAt-style-type-strike'; maximumQuoteAgeMs: number; maximumRelativeSpread: number; minimumExpiries: number; minimumStrikesPerExpiry: number; maximumQuotes: number; lowerVolatilityBound: number | null; upperVolatilityBound: number | null; maximumSolverIterations: number; }>; default: not declared - return.coverage: { belowMinimumExpiries: boolean; duplicateQuoteCount: number; expectedContractCount: number | null; expiries: OptionChainHealthExpiryCoverage[]; expiryCount: number; missingContracts: OptionChainHealthContract[] | null; }; default: not declared - return.coverage.belowMinimumExpiries: boolean; default: not declared - return.coverage.duplicateQuoteCount: number; default: not declared - return.coverage.expectedContractCount: number | null; default: not declared - return.coverage.expiries: OptionChainHealthExpiryCoverage[]; default: not declared — Sorted by expiration instant, then style (code-unit order); no locale or clock dependency. - return.coverage.expiryCount: number; default: not declared - return.coverage.missingContracts: OptionChainHealthContract[] | null; default: not declared — null means no expected universe supplied; [] means the supplied universe is covered. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.rows: OptionChainHealthRow[]; default: not declared - return.summary: { issueCounts: Record; modelStatusCounts: Record; quoteCount: number; quotesWithIssues: number; solvedCount: number; }; default: not declared - return.summary.issueCounts: Record; default: not declared - return.summary.modelStatusCounts: Record; default: not declared - return.summary.quoteCount: number; default: not declared - return.summary.quotesWithIssues: number; default: not declared - return.summary.solvedCount: number; default: not declared ### @insiderfinance/totalfinance/options#priceMany Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price many contracts against one market, returning a rich `PriceResult` per contract (rows form). ```typescript export declare function priceMany(input: PriceManyInput): PriceResult[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PriceManyInput; default: not declared - (input).contracts: OptionContract[]; default: not declared - (input).engine?: OptionPricingEngine; default: not declared — Engine to use; defaults to {@link engines.auto}, the same default as `option.price`. - (input).market: OptionMarket; default: not declared ### @insiderfinance/totalfinance/options#priceOption Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function priceOption(input: PriceOptionInput): PriceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PriceOptionInput; default: not declared - (input).contract: OptionContract; default: not declared - (input).engine?: OptionPricingEngine; default: not declared — Engine override; defaults to {@link engines.auto} (European → BSM, American → lattice/approx). - (input).extendedGreeks?: boolean; default: not declared — Also compute the **higher-order (extended) Greek set** (vanna, charm, vomma, speed, color, phi, zomma, veta, vera, ultima, lambda). Analytic on the closed-form engines; by finite difference on the numerical (lattice / PDE / approximation) engines. Implies `greeks`. - (input).greeks?: boolean; default: not declared — Compute first-order Greeks (default `true`). `false` omits `result.greeks` entirely — absent means "not requested", never fabricated zeros — and flags `greeks.not_computed` in diagnostics. Honored identically by EVERY engine (the substitutability contract, spec P2.4); `extendedGreeks: true` implies `greeks`. - (input).market: OptionMarket; default: not declared — Market snapshot. `asOf` is required on the market; the clock is never read. - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options#putContract Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Generic put builder — `style` REQUIRED. ```typescript export declare function putContract(input: OptionBuilderInput): OptionContract; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OptionBuilderInput; default: not declared - (input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - (input).currency?: string; default: not declared - (input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - (input).multiplier?: number; default: not declared - (input).root?: string; default: not declared - (input).strike: number; default: not declared - (input).style: OptionStyle; default: not declared — REQUIRED (P3.4): exercise style is meaning-changing and is never defaulted — an American put is worth more than its European twin. Use `usEquityCall`/`usEquityPut`/`european` when you want the convention encoded in the builder's name instead. - (input).underlying: string; default: not declared - return.adjusted?: boolean; default: not declared - return.currency?: string; default: not declared - return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - return.multiplier?: number; default: not declared - return.occSymbol?: string; default: not declared - return.root?: string; default: not declared - return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - return.strike: number; default: not declared - return.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - return.type: OptionType; default: not declared - return.underlying: string; default: not declared ### @insiderfinance/totalfinance/options#quanto Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const quanto: { readonly price: (input: QuantoInput & { type: OptionType; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: (input: QuantoInput & { type: OptionType; }) => ExoticResult; default: not declared — Quanto option paying `(S_foreign(T) − K)⁺` in domestic currency at a fixed FX rate. The asset's drift is adjusted by `−ρ·σ_S·σ_FX` (the quanto correction) and discounting is domestic. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): QuantoInput & { type: OptionType; }; default: not declared - price(input).correlation: number; default: not declared — Correlation between the asset and the FX rate, in [-1, 1]. - price(input).dividendYield?: number; default: not declared - price(input).domesticRate: number; default: not declared — Domestic discount rate. - price(input).foreignRate: number; default: not declared — Foreign risk-free rate. - price(input).fxVolatility: number; default: not declared — Volatility of the domestic/foreign FX rate. - price(input).spot: number; default: not declared — Foreign-asset spot (in foreign currency). - price(input).strike: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility: number; default: not declared — Asset volatility. ### @insiderfinance/totalfinance/options#rainbow Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rainbow: { readonly monteCarloPrice: (input: MultiAssetInput & { type: OptionType; kind: RainbowKind; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: MultiAssetInput & { type: OptionType; kind: RainbowKind; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo price of a rainbow option on the max or min of several assets. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): MultiAssetInput & { kind: RainbowKind; type: OptionType; }; default: not declared - monteCarloPrice(input).correlation: number[][]; default: not declared — Correlation matrix (n × n, symmetric, unit diagonal, positive definite). - monteCarloPrice(input).dividendYields?: number[]; default: not declared - monteCarloPrice(input).kind: RainbowKind; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spots: number[]; default: not declared - monteCarloPrice(input).strike: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatilities: number[]; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#reverseCliquet Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const reverseCliquet: { readonly floorlessValue: (input: ReverseCliquetInput) => ExoticResult; readonly monteCarloPrice: (input: ReverseCliquetInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - floorlessValue: (input: ReverseCliquetInput) => ExoticResult; default: not declared — Closed-form reverse-cliquet value **ignoring the global floor**: `df·notional·(C + Σᵢ E[min(rᵢ, 0)])`, with `E[min(rᵢ, 0)] = (e^{b·τᵢ} − 1) − returnCaplet(1, τᵢ, b, σ)` (reusing the cliquet caplet). Exact for an unfloored note (`globalFloor = −∞`) and a fast lower bound for the floored one (large coupon ⇒ the floor rarely binds ⇒ this ≈ the MC price). See `docs/specs/napoleon-reverse-cliquet.md`. - floorlessValue().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - floorlessValue().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - floorlessValue().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - floorlessValue().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - floorlessValue(input): NapoleonInput; default: not declared - floorlessValue(input).coupon: number; default: not declared — The fixed coupon degraded by the period returns. - floorlessValue(input).dividendYield?: number; default: not declared - floorlessValue(input).globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - floorlessValue(input).notional?: number; default: not declared — Notional multiplier. Default 1. - floorlessValue(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - floorlessValue(input).riskFreeRate: number; default: not declared - floorlessValue(input).spot: number; default: not declared - floorlessValue(input).volatility: number; default: not declared - monteCarloPrice: (input: ReverseCliquetInput, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Reverse cliquet: pays the coupon eroded by the **sum of the negative** period returns, `max(floor, C + Σᵢ min(rᵢ, 0))`. Up-periods don't help, down-periods subtract — the investor is short downside vol, so a higher `volatility` LOWERS the value. Path-dependent (the floored sum) ⇒ Monte-Carlo. See `docs/specs/napoleon-reverse-cliquet.md`. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): NapoleonInput; default: not declared - monteCarloPrice(input).coupon: number; default: not declared — The fixed coupon degraded by the period returns. - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).globalFloor?: number; default: not declared — Floor on the payoff. Default 0 (the note cannot pay less than 0). - monteCarloPrice(input).notional?: number; default: not declared — Notional multiplier. Default 1. - monteCarloPrice(input).resetTimes: number[]; default: not declared — Reset times `t₁…tₙ` (years, strictly increasing, > 0); `t₀ = 0` (today), `tₙ = maturity`. - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options#sabr Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The SABR model namespace — the grouped, discoverable surface over the flat `sabr*` functions. `sabr.volatility` / `sabr.price` / `sabr.monteCarloPrice` / `sabr.monteCarloEstimate` are the same functions; prefer the namespace over the deprecated flat exports. ```typescript export declare const sabr: { readonly monteCarloEstimate: (input: SabrMonteCarloEstimateInput) => MonteCarloEstimate; readonly monteCarloPrice: (request: SabrPriceMonteCarloRequest) => SabrMonteCarloResult; readonly price: (request: SabrPriceRequest) => PriceResult; readonly volatility: (request: SabrVolatilityRequest) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloEstimate: (input: SabrMonteCarloEstimateInput) => MonteCarloEstimate; default: not declared - monteCarloEstimate().return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - monteCarloEstimate().return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - monteCarloEstimate().return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - monteCarloEstimate().return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - monteCarloEstimate().return.seed: number; default: not declared — The seed, echoed for reproducibility. - monteCarloEstimate().return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - monteCarloEstimate().return.value: number; default: not declared - monteCarloEstimate().return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - monteCarloEstimate().return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). - monteCarloEstimate(input): SabrMonteCarloEstimateInput; default: not declared - monteCarloEstimate(input).forward: number; default: not declared - monteCarloEstimate(input).options: SabrMonteCarloOptions; default: not declared - monteCarloEstimate(input).parameters: SabrParameters; default: not declared - monteCarloEstimate(input).riskFreeRate: number; default: not declared - monteCarloEstimate(input).strike: number; default: not declared - monteCarloEstimate(input).timeToExpiryYears: number; default: not declared - monteCarloEstimate(input).type: OptionType; default: not declared - monteCarloPrice: (request: SabrPriceMonteCarloRequest) => SabrMonteCarloResult; default: not declared - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.greeks?: Greeks | ExtendedGreeks; default: not declared - monteCarloPrice().return.greeks.charm: number; default: not declared - monteCarloPrice().return.greeks.color: number; default: not declared - monteCarloPrice().return.greeks.delta: number; default: not declared - monteCarloPrice().return.greeks.gamma: number; default: not declared - monteCarloPrice().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - monteCarloPrice().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - monteCarloPrice().return.greeks.rho: number; default: not declared - monteCarloPrice().return.greeks.speed: number; default: not declared - monteCarloPrice().return.greeks.theta: number; default: not declared - monteCarloPrice().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - monteCarloPrice().return.greeks.vanna: number; default: not declared - monteCarloPrice().return.greeks.vega: number; default: not declared - monteCarloPrice().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - monteCarloPrice().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - monteCarloPrice().return.greeks.vomma: number; default: not declared - monteCarloPrice().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(request): SabrPriceMonteCarloRequest; default: not declared - monteCarloPrice(request).input: SabrInput; default: not declared - monteCarloPrice(request).options: SabrMonteCarloOptions; default: not declared - monteCarloPrice(request).parameters: SabrParameters; default: not declared - monteCarloPrice(request).type: OptionType; default: not declared - price: (request: SabrPriceRequest) => PriceResult; default: not declared - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.greeks?: Greeks | ExtendedGreeks; default: not declared - price().return.greeks.charm: number; default: not declared - price().return.greeks.color: number; default: not declared - price().return.greeks.delta: number; default: not declared - price().return.greeks.gamma: number; default: not declared - price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - price().return.greeks.rho: number; default: not declared - price().return.greeks.speed: number; default: not declared - price().return.greeks.theta: number; default: not declared - price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - price().return.greeks.vanna: number; default: not declared - price().return.greeks.vega: number; default: not declared - price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - price().return.greeks.vomma: number; default: not declared - price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(request): SabrPriceRequest; default: not declared - price(request).input: SabrInput; default: not declared - price(request).options?: SabrOptions; default: not declared - price(request).parameters: SabrParameters; default: not declared - price(request).type: OptionType; default: not declared - volatility: (request: SabrVolatilityRequest) => number; default: not declared - volatility(request): SabrVolatilityRequest; default: not declared - volatility(request).input: SabrVolatilityInput; default: not declared - volatility(request).options?: SabrVolatilityOptions; default: not declared - volatility(request).parameters: SabrParameters; default: not declared ### @insiderfinance/totalfinance/options#schemas Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convenience namespace mirroring the spec's `schemas.OptionContract.parse(...)` usage. ```typescript export declare const schemas: { readonly BlackScholesImpliedVolatilityInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly BlackScholesInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly BlackScholesTypedInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; readonly OptionContract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - BlackScholesImpliedVolatilityInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesImpliedVolatilityInput._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; }; default: not declared — @internal - BlackScholesImpliedVolatilityInput._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesImpliedVolatilityInput._check().return.ok: (false) | (true); default: not declared - BlackScholesImpliedVolatilityInput._check().return.value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - BlackScholesImpliedVolatilityInput._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - BlackScholesImpliedVolatilityInput._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - BlackScholesImpliedVolatilityInput._check(context).path: (string | number)[]; default: not declared - BlackScholesImpliedVolatilityInput._check(input): unknown; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesImpliedVolatilityInput._toJSONSchema().return.$id?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.description?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.format?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.title?: string; default: not declared - BlackScholesImpliedVolatilityInput._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInput.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesImpliedVolatilityInput.describe(description): string; default: not declared - BlackScholesImpliedVolatilityInput.description: string | undefined; default: not declared - BlackScholesImpliedVolatilityInput.isOptional: boolean; default: not declared - BlackScholesImpliedVolatilityInput.kind: 'object'; default: not declared - BlackScholesImpliedVolatilityInput.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ price: import('@insiderfinance/totalfinance/core/schema').NumberSchema; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - BlackScholesImpliedVolatilityInput.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInput.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; }; default: not declared — @internal - BlackScholesImpliedVolatilityInput.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesImpliedVolatilityInput.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.description: string | undefined; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.isOptional: true; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.kind: 'optional'; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined>; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; } | undefined>; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesImpliedVolatilityInput.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - BlackScholesImpliedVolatilityInput.parse(input): unknown; default: not declared - BlackScholesImpliedVolatilityInput.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesImpliedVolatilityInput.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesImpliedVolatilityInput.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInput.safeParse().return.data: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - BlackScholesImpliedVolatilityInput.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - BlackScholesImpliedVolatilityInput.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesImpliedVolatilityInput.safeParse().return.success: (false) | (true); default: not declared - BlackScholesImpliedVolatilityInput.safeParse(input): unknown; default: not declared - BlackScholesImpliedVolatilityInput.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesImpliedVolatilityInput.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesImpliedVolatilityInput.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.$id?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.const?: unknown; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.default?: unknown; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.description?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.format?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.maximum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.minItems?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.minLength?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.minimum?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.pattern?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.properties?: Record; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.required?: string[]; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.title?: string; default: not declared - BlackScholesImpliedVolatilityInput.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesImpliedVolatilityInput.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesImpliedVolatilityInput.~standard.types?: ({ readonly input: unknown; readonly output: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; }) | undefined; default: not declared - BlackScholesImpliedVolatilityInput.~standard.types.input: unknown; default: not declared - BlackScholesImpliedVolatilityInput.~standard.types.output: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - BlackScholesImpliedVolatilityInput.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }>; default: not declared - BlackScholesImpliedVolatilityInput.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - BlackScholesImpliedVolatilityInput.~standard.validate().return.value: { dividendYield?: number; price: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; }; default: not declared - BlackScholesImpliedVolatilityInput.~standard.validate(value): unknown; default: not declared - BlackScholesImpliedVolatilityInput.~standard.vendor: string; default: not declared - BlackScholesImpliedVolatilityInput.~standard.version: 1; default: not declared - BlackScholesInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesInput._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; }; default: not declared — @internal - BlackScholesInput._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesInput._check().return.ok: (false) | (true); default: not declared - BlackScholesInput._check().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - BlackScholesInput._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - BlackScholesInput._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - BlackScholesInput._check(context).path: (string | number)[]; default: not declared - BlackScholesInput._check(input): unknown; default: not declared - BlackScholesInput._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesInput._toJSONSchema().return.$id?: string; default: not declared - BlackScholesInput._toJSONSchema().return.$schema?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesInput._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInput._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput._toJSONSchema().return.const?: unknown; default: not declared - BlackScholesInput._toJSONSchema().return.default?: unknown; default: not declared - BlackScholesInput._toJSONSchema().return.description?: string; default: not declared - BlackScholesInput._toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesInput._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.format?: string; default: not declared - BlackScholesInput._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput._toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesInput._toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesInput._toJSONSchema().return.maximum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.minItems?: number; default: not declared - BlackScholesInput._toJSONSchema().return.minLength?: number; default: not declared - BlackScholesInput._toJSONSchema().return.minimum?: number; default: not declared - BlackScholesInput._toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesInput._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput._toJSONSchema().return.pattern?: string; default: not declared - BlackScholesInput._toJSONSchema().return.properties?: Record; default: not declared - BlackScholesInput._toJSONSchema().return.required?: string[]; default: not declared - BlackScholesInput._toJSONSchema().return.title?: string; default: not declared - BlackScholesInput._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInput.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesInput.describe(description): string; default: not declared - BlackScholesInput.description: string | undefined; default: not declared - BlackScholesInput.isOptional: boolean; default: not declared - BlackScholesInput.kind: 'object'; default: not declared - BlackScholesInput.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - BlackScholesInput.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInput.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; }; default: not declared — @internal - BlackScholesInput.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesInput.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInput.optional().return.description: string | undefined; default: not declared - BlackScholesInput.optional().return.isOptional: true; default: not declared - BlackScholesInput.optional().return.kind: 'optional'; default: not declared - BlackScholesInput.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined>; default: not declared - BlackScholesInput.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined; default: not declared - BlackScholesInput.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; } | undefined>; default: not declared - BlackScholesInput.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesInput.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - BlackScholesInput.parse(input): unknown; default: not declared - BlackScholesInput.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesInput.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesInput.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInput.safeParse().return.data: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - BlackScholesInput.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - BlackScholesInput.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesInput.safeParse().return.success: (false) | (true); default: not declared - BlackScholesInput.safeParse(input): unknown; default: not declared - BlackScholesInput.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesInput.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesInput.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput.toJSONSchema().return.$id?: string; default: not declared - BlackScholesInput.toJSONSchema().return.$schema?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesInput.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInput.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput.toJSONSchema().return.const?: unknown; default: not declared - BlackScholesInput.toJSONSchema().return.default?: unknown; default: not declared - BlackScholesInput.toJSONSchema().return.description?: string; default: not declared - BlackScholesInput.toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesInput.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.format?: string; default: not declared - BlackScholesInput.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesInput.toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesInput.toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesInput.toJSONSchema().return.maximum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.minItems?: number; default: not declared - BlackScholesInput.toJSONSchema().return.minLength?: number; default: not declared - BlackScholesInput.toJSONSchema().return.minimum?: number; default: not declared - BlackScholesInput.toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesInput.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesInput.toJSONSchema().return.pattern?: string; default: not declared - BlackScholesInput.toJSONSchema().return.properties?: Record; default: not declared - BlackScholesInput.toJSONSchema().return.required?: string[]; default: not declared - BlackScholesInput.toJSONSchema().return.title?: string; default: not declared - BlackScholesInput.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesInput.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesInput.~standard.types?: ({ readonly input: unknown; readonly output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; }) | undefined; default: not declared - BlackScholesInput.~standard.types.input: unknown; default: not declared - BlackScholesInput.~standard.types.output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - BlackScholesInput.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }>; default: not declared - BlackScholesInput.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - BlackScholesInput.~standard.validate().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; volatility: number; }; default: not declared - BlackScholesInput.~standard.validate(value): unknown; default: not declared - BlackScholesInput.~standard.vendor: string; default: not declared - BlackScholesInput.~standard.version: 1; default: not declared - BlackScholesTypedInput: import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesTypedInput._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; }; default: not declared — @internal - BlackScholesTypedInput._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesTypedInput._check().return.ok: (false) | (true); default: not declared - BlackScholesTypedInput._check().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - BlackScholesTypedInput._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - BlackScholesTypedInput._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - BlackScholesTypedInput._check(context).path: (string | number)[]; default: not declared - BlackScholesTypedInput._check(input): unknown; default: not declared - BlackScholesTypedInput._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesTypedInput._toJSONSchema().return.$id?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.$schema?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.const?: unknown; default: not declared - BlackScholesTypedInput._toJSONSchema().return.default?: unknown; default: not declared - BlackScholesTypedInput._toJSONSchema().return.description?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.format?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput._toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.maximum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.minItems?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.minLength?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.minimum?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesTypedInput._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.pattern?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.properties?: Record; default: not declared - BlackScholesTypedInput._toJSONSchema().return.required?: string[]; default: not declared - BlackScholesTypedInput._toJSONSchema().return.title?: string; default: not declared - BlackScholesTypedInput._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInput.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared - BlackScholesTypedInput.describe(description): string; default: not declared - BlackScholesTypedInput.description: string | undefined; default: not declared - BlackScholesTypedInput.isOptional: boolean; default: not declared - BlackScholesTypedInput.kind: 'object'; default: not declared - BlackScholesTypedInput.open: () => import('@insiderfinance/totalfinance/core/schema').ObjectSchema<{ type: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }>; default: not declared — Structured-OPEN object mode (2026-08-23, fourth external review). The declared shape is still fully validated, but unknown keys are ALLOWED and preserved — the schema form for a payload whose contract documents vendor decoration (Law 12: entries stay open). `toJSONSchema()` then emits the complete `properties`/`required` map with `additionalProperties: true`, so MCP tools, agents, and generated forms see the real field shape instead of a shapeless object. Distinct from parse-time `mode: 'passthrough'` on purpose: openness declared here is a property of the PAYLOAD's contract (every caller, every mode, and the emitted JSON Schema all agree), while `passthrough` is one caller's per-parse leniency toward a schema that itself remains closed. Like every refiner, returns a NEW schema; the receiver stays closed. - BlackScholesTypedInput.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInput.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; }; default: not declared — @internal - BlackScholesTypedInput.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - BlackScholesTypedInput.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInput.optional().return.description: string | undefined; default: not declared - BlackScholesTypedInput.optional().return.isOptional: true; default: not declared - BlackScholesTypedInput.optional().return.kind: 'optional'; default: not declared - BlackScholesTypedInput.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined>; default: not declared - BlackScholesTypedInput.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined; default: not declared - BlackScholesTypedInput.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; } | undefined>; default: not declared - BlackScholesTypedInput.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesTypedInput.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - BlackScholesTypedInput.parse(input): unknown; default: not declared - BlackScholesTypedInput.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesTypedInput.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesTypedInput.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInput.safeParse().return.data: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - BlackScholesTypedInput.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - BlackScholesTypedInput.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - BlackScholesTypedInput.safeParse().return.success: (false) | (true); default: not declared - BlackScholesTypedInput.safeParse(input): unknown; default: not declared - BlackScholesTypedInput.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - BlackScholesTypedInput.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - BlackScholesTypedInput.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput.toJSONSchema().return.$id?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.$schema?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.description?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.format?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.title?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.const?: unknown; default: not declared - BlackScholesTypedInput.toJSONSchema().return.default?: unknown; default: not declared - BlackScholesTypedInput.toJSONSchema().return.description?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.enum?: unknown[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.format?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - BlackScholesTypedInput.toJSONSchema().return.maxItems?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.maxLength?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.maximum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.minItems?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.minLength?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.minimum?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.multipleOf?: number; default: not declared - BlackScholesTypedInput.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.pattern?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.properties?: Record; default: not declared - BlackScholesTypedInput.toJSONSchema().return.required?: string[]; default: not declared - BlackScholesTypedInput.toJSONSchema().return.title?: string; default: not declared - BlackScholesTypedInput.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - BlackScholesTypedInput.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - BlackScholesTypedInput.~standard.types?: ({ readonly input: unknown; readonly output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; }) | undefined; default: not declared - BlackScholesTypedInput.~standard.types.input: unknown; default: not declared - BlackScholesTypedInput.~standard.types.output: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - BlackScholesTypedInput.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }>; default: not declared - BlackScholesTypedInput.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - BlackScholesTypedInput.~standard.validate().return.value: { dividendYield?: number; riskFreeRate: number; spot: number; strike: number; timeToExpiryYears: number; type: 'call' | 'put'; volatility: number; }; default: not declared - BlackScholesTypedInput.~standard.validate(value): unknown; default: not declared - BlackScholesTypedInput.~standard.vendor: string; default: not declared - BlackScholesTypedInput.~standard.version: 1; default: not declared - OptionContract: import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.describe(description): string; default: not declared - OptionContract.isOptional: boolean; default: not declared - OptionContract.kind: string; default: not declared - OptionContract.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.isOptional: boolean; default: not declared - OptionContract.optional().return.kind: string; default: not declared - OptionContract.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined; default: not declared - OptionContract.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; } | undefined>; default: not declared - OptionContract.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionContract.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.parse(input): unknown; default: not declared - OptionContract.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionContract.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionContract.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.safeParse().return.data: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - OptionContract.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - OptionContract.safeParse().return.success: (false) | (true); default: not declared - OptionContract.safeParse(input): unknown; default: not declared - OptionContract.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - OptionContract.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - OptionContract.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.$id?: string; default: not declared - OptionContract.toJSONSchema().return.$schema?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.description?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.format?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.title?: string; default: not declared - OptionContract.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionContract.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.const?: unknown; default: not declared - OptionContract.toJSONSchema().return.default?: unknown; default: not declared - OptionContract.toJSONSchema().return.description?: string; default: not declared - OptionContract.toJSONSchema().return.enum?: unknown[]; default: not declared - OptionContract.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - OptionContract.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - OptionContract.toJSONSchema().return.format?: string; default: not declared - OptionContract.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - OptionContract.toJSONSchema().return.maxItems?: number; default: not declared - OptionContract.toJSONSchema().return.maxLength?: number; default: not declared - OptionContract.toJSONSchema().return.maximum?: number; default: not declared - OptionContract.toJSONSchema().return.minItems?: number; default: not declared - OptionContract.toJSONSchema().return.minLength?: number; default: not declared - OptionContract.toJSONSchema().return.minimum?: number; default: not declared - OptionContract.toJSONSchema().return.multipleOf?: number; default: not declared - OptionContract.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - OptionContract.toJSONSchema().return.pattern?: string; default: not declared - OptionContract.toJSONSchema().return.properties?: Record; default: not declared - OptionContract.toJSONSchema().return.required?: string[]; default: not declared - OptionContract.toJSONSchema().return.title?: string; default: not declared - OptionContract.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - OptionContract.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - OptionContract.~standard.types?: ({ readonly input: unknown; readonly output: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; }) | undefined; default: not declared - OptionContract.~standard.types.input: unknown; default: not declared - OptionContract.~standard.types.output: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<{ adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }>; default: not declared - OptionContract.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - OptionContract.~standard.validate().return.value: { adjusted?: boolean; currency?: string; deliverable?: { cash?: number; shares?: { symbol: string; quantity: number; }[]; notes?: string; }; exerciseTime?: 'AM' | 'PM'; expiresAt: number; expiry: string; expiryConvention: 'us-equity-close' | 'explicit-instant'; multiplier?: number; occSymbol?: string; root?: string; settlement?: 'physical' | 'cash'; strike: number; style: 'european' | 'american'; type: 'call' | 'put'; underlying: string; }; default: not declared - OptionContract.~standard.validate(value): unknown; default: not declared - OptionContract.~standard.vendor: string; default: not declared - OptionContract.~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/options#selectQuotePrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a single price from an option quote per the requested source. Returns `undefined` when the requested fields are absent. `mid` falls back to (bid+ask)/2 when an explicit mid is missing. Quote records are structural artifacts, so venue/provenance fields and declared subtypes may decorate them; only the fields consumed by the selected source are interpreted here. ```typescript export declare function selectQuotePrice(quote: OptionQuote, source: PriceSource): number | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (quote): OptionQuote; default: not declared - (quote).ask?: number; default: not declared - (quote).askSize?: number; default: not declared - (quote).bid?: number; default: not declared - (quote).bidSize?: number; default: not declared - (quote).conditions?: string[]; default: not declared - (quote).contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - (quote).exchange?: string; default: not declared - (quote).greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - (quote).impliedVolatility?: number; default: not declared - (quote).last?: number; default: not declared - (quote).mark?: number; default: not declared - (quote).mid?: number; default: not declared - (quote).openInterest?: number; default: not declared - (quote).timestampMs: number; default: not declared - (quote).underlyingPrice?: number; default: not declared - (quote).volume?: number; default: not declared - (source): PriceSource; default: not declared ### @insiderfinance/totalfinance/options#spread Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const spread: { readonly monteCarloPrice: (input: SpreadInput & { type: OptionType; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; readonly price: (input: SpreadInput & { type: OptionType; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monteCarloPrice: (input: SpreadInput & { type: OptionType; }, options: MonteCarloSamplingOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo price of the spread option (validator for, and generalization of, Kirk). - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): SpreadInput & { type: OptionType; }; default: not declared - monteCarloPrice(input).correlation: number; default: not declared — Correlation between the two assets, in [-1, 1]. - monteCarloPrice(input).dividendYield1?: number; default: not declared - monteCarloPrice(input).dividendYield2?: number; default: not declared - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot1: number; default: not declared - monteCarloPrice(input).spot2: number; default: not declared - monteCarloPrice(input).strike: number; default: not declared — Strike on `S1 − S2`. May be negative; Kirk requires `F2 + K > 0`. - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).type: OptionType; default: not declared - monteCarloPrice(input).volatility1: number; default: not declared — Per-asset volatilities. These were `vol1`/`vol2` under a retired rule ("flat inputs use `vol`") that survived in this comment long after the rule went. The denylist has forbidden `vol` since N0 — the digit is what hid these two, which is the whole reason the tokenizer now tests the letter run in front of a numeric suffix. - monteCarloPrice(input).volatility2: number; default: not declared - monteCarloPrice(options): MonteCarloSamplingOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - price: (input: SpreadInput & { type: OptionType; }) => ExoticResult; default: not declared — Kirk's-approximation analytic price of an option on `S1 − S2`. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): SpreadInput & { type: OptionType; }; default: not declared - price(input).correlation: number; default: not declared — Correlation between the two assets, in [-1, 1]. - price(input).dividendYield1?: number; default: not declared - price(input).dividendYield2?: number; default: not declared - price(input).riskFreeRate: number; default: not declared - price(input).spot1: number; default: not declared - price(input).spot2: number; default: not declared - price(input).strike: number; default: not declared — Strike on `S1 − S2`. May be negative; Kirk requires `F2 + K > 0`. - price(input).timeToExpiryYears: number; default: not declared - price(input).type: OptionType; default: not declared - price(input).volatility1: number; default: not declared — Per-asset volatilities. These were `vol1`/`vol2` under a retired rule ("flat inputs use `vol`") that survived in this comment long after the rule went. The denylist has forbidden `vol` since N0 — the digit is what hid these two, which is the whole reason the tokenizer now tests the letter run in front of a numeric suffix. - price(input).volatility2: number; default: not declared ### @insiderfinance/totalfinance/options#touch Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const touch: { readonly greeks: (input: TouchInput & { kind: TouchKind; }) => Computed; readonly monteCarloPrice: (input: TouchInput & { kind: TouchKind; }, options: TouchMonteCarloOptions) => ExoticMonteCarloResult; readonly price: (input: TouchInput & { kind: TouchKind; }) => ExoticResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: (input: TouchInput & { kind: TouchKind; }) => Computed; default: not declared — First-order greeks (delta, gamma, vega, theta, rho) for the one-touch / no-touch binary, by central finite-difference of the exact `touch.price` (the analytic greeks are a research-grade first-passage series). Units match the package (vega/1%, theta/day, rho/1%; echoed in `assumptions.units`). The spot bump is shrunk near the barrier so it never straddles it. Pinned to the exact identity that a one-touch (pay-at-expiry) and a no-touch greek sum to the `cash·e^{−rT}` greeks. See `docs/specs/touch-greeks.md`. - greeks().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - greeks().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - greeks().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - greeks().return.value: Greeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - greeks(input): TouchInput & { kind: TouchKind; }; default: not declared - greeks(input).barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - greeks(input).cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - greeks(input).dividendYield?: number; default: not declared - greeks(input).kind: TouchKind; default: not declared - greeks(input).payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - greeks(input).riskFreeRate: number; default: not declared - greeks(input).spot: number; default: not declared - greeks(input).timeToExpiryYears: number; default: not declared - greeks(input).volatility: number; default: not declared - monteCarloPrice: (input: TouchInput & { kind: TouchKind; }, options: TouchMonteCarloOptions) => ExoticMonteCarloResult; default: not declared — Monte-Carlo one-touch / no-touch. Pay-at-expiry reuses the Brownian-bridge survival so discrete monitoring converges to the continuous analytic; pay-at-hit detects the first crossing on the grid and discounts at the hit time. - monteCarloPrice().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - monteCarloPrice().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - monteCarloPrice().return.monteCarlo: MonteCarloStatistics; default: not declared - monteCarloPrice().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - monteCarloPrice().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - monteCarloPrice(input): TouchInput & { kind: TouchKind; }; default: not declared - monteCarloPrice(input).barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - monteCarloPrice(input).cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - monteCarloPrice(input).dividendYield?: number; default: not declared - monteCarloPrice(input).kind: TouchKind; default: not declared - monteCarloPrice(input).payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - monteCarloPrice(input).riskFreeRate: number; default: not declared - monteCarloPrice(input).spot: number; default: not declared - monteCarloPrice(input).timeToExpiryYears: number; default: not declared - monteCarloPrice(input).volatility: number; default: not declared - monteCarloPrice(options): TouchMonteCarloOptions; default: not declared - monteCarloPrice(options).antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - monteCarloPrice(options).brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - monteCarloPrice(options).confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - monteCarloPrice(options).method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - monteCarloPrice(options).paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - monteCarloPrice(options).randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - monteCarloPrice(options).seed: number; default: not declared — Seed — required and echoed for reproducibility. - monteCarloPrice(options).steps?: number; default: not declared — Monitoring steps per path (default 100). - price: (input: TouchInput & { kind: TouchKind; }) => ExoticResult; default: not declared — One-touch (pays if `H` is ever touched) / no-touch (pays if it never is), continuous monitoring. `one-touch` settles at expiry by default or at the hit (`payAt: 'hit'`, Reiner–Rubinstein); `no-touch` is always expiry-settled. An already-touched spot (`S = H`) short-circuits to the certain payoff. See `docs/specs/digital-touch.md`. - price().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - price().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - price(input): TouchInput & { kind: TouchKind; }; default: not declared - price(input).barrier: number; default: not declared — Barrier level `H`; below spot ⇒ a down-touch, above ⇒ an up-touch. - price(input).cash?: number; default: not declared — Rebate paid on the touch outcome; default 1. - price(input).dividendYield?: number; default: not declared - price(input).kind: TouchKind; default: not declared - price(input).payAt?: 'expiry' | 'hit'; default: not declared — When a `one-touch` pays: `'expiry'` (default) or `'hit'` (immediate). Not applicable to `no-touch`. - price(input).riskFreeRate: number; default: not declared - price(input).spot: number; default: not declared - price(input).timeToExpiryYears: number; default: not declared - price(input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options#usEquityCall Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function usEquityCall(input: InstrumentBuilderInput): OptionContract; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InstrumentBuilderInput; default: not declared - (input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - (input).currency?: string; default: not declared - (input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - (input).multiplier?: number; default: not declared - (input).root?: string; default: not declared - (input).strike: number; default: not declared - (input).underlying: string; default: not declared - return.adjusted?: boolean; default: not declared - return.currency?: string; default: not declared - return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - return.multiplier?: number; default: not declared - return.occSymbol?: string; default: not declared - return.root?: string; default: not declared - return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - return.strike: number; default: not declared - return.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - return.type: OptionType; default: not declared - return.underlying: string; default: not declared ### @insiderfinance/totalfinance/options#usEquityOption Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). US listed equity option from DATA (B7): either an OCC symbol, or `type` plus the fields `usEquityCall`/`usEquityPut` take. The two named builders remain the sugar; this is the door a chain row, a fill, or a broker symbol goes through without branching on `type` first. A field given beside `occSymbol` must agree with the symbol — a contradiction is refused, never resolved by preference. ```typescript export declare function usEquityOption(input: UsEquityOptionInput): OptionContract; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): UsEquityOptionInput; default: not declared - (input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - (input).currency?: string; default: not declared - (input).expiry?: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - (input).multiplier?: number; default: not declared - (input).occSymbol?: string; default: not declared — A compact OCC symbol (`AAPL260918C00200000`); its root, expiry, type and strike are the contract. - (input).root?: string; default: not declared - (input).strike?: number; default: not declared - (input).type?: OptionType; default: not declared — `'call' | 'put'` — required unless `occSymbol` names it. - (input).underlying?: string; default: not declared - return.adjusted?: boolean; default: not declared - return.currency?: string; default: not declared - return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - return.multiplier?: number; default: not declared - return.occSymbol?: string; default: not declared - return.root?: string; default: not declared - return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - return.strike: number; default: not declared - return.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - return.type: OptionType; default: not declared - return.underlying: string; default: not declared ### @insiderfinance/totalfinance/options#usEquityPut Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). US listed equity put — see {@link usEquityCall}. ```typescript export declare function usEquityPut(input: InstrumentBuilderInput): OptionContract; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InstrumentBuilderInput; default: not declared - (input).convention?: 'us-equity-close'; default: not declared — REQUIRED for a date-only `expiry` (D2, one expiry law): a bare date does not name its INSTANT, and the generic builders never guess one — `'us-equity-close'` options into the 16:00 ET session close explicitly. The `usEquityCall`/`usEquityPut` names carry it for you. - (input).currency?: string; default: not declared - (input).expiry: string; default: not declared — Expiry label: `YYYY-MM-DD` (requires `convention`) or a zoned ISO datetime. - (input).multiplier?: number; default: not declared - (input).root?: string; default: not declared - (input).strike: number; default: not declared - (input).underlying: string; default: not declared - return.adjusted?: boolean; default: not declared - return.currency?: string; default: not declared - return.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - return.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - return.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - return.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - return.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - return.multiplier?: number; default: not declared - return.occSymbol?: string; default: not declared - return.root?: string; default: not declared - return.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - return.strike: number; default: not declared - return.style: OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - return.type: OptionType; default: not declared - return.underlying: string; default: not declared ### @insiderfinance/totalfinance/options#validateOptionPricingEngine Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Behaviorally verify a custom pricing engine against CALLER-SUPPLIED fixtures. Registration via {@link defineOptionPricingEngine} is deliberately side-effect-free; this explicit companion is the place for potentially expensive pricing calls and therefore works for spot, forward, stateful, remote, and domain-specific engines without TotalFinance guessing their inputs. At least one probe is required for every claimed exercise style. Each probe verifies `supports()`, a finite non-negative price, Greek capability claims, extended-Greek claims, and repeat-call value equality when `deterministic` is true. The validated immutable engine is returned for convenient inline use. ```typescript export declare function validateOptionPricingEngine(engine: OptionPricingEngine, probes: readonly OptionPricingEngineProbe[]): OptionPricingEngine; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (engine): OptionPricingEngine; default: not declared - (engine).capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - (engine).capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - (engine).capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - (engine).capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - (engine).capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - (engine).capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - (engine).name: string; default: not declared - (engine).price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - (engine).supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - (engine).version: string; default: not declared - (probes): readonly OptionPricingEngineProbe[]; default: not declared - return.capabilities: EngineCapabilities; default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - return.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - return.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - return.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - return.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - return.capabilities.styles: readonly OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - return.name: string; default: not declared - return.price: (input: OptionEnginePriceInput) => PriceResult; default: not declared - return.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - return.version: string; default: not declared ### @insiderfinance/totalfinance/options#vanillaIntrinsic Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gross vanilla intrinsic value per unit: `max(underlyingPrice − strike, 0)` for a call, `max(strike − underlyingPrice, 0)` for a put. A plain number out, and nothing else in: no premium (this is not P&L), no quantity or multiplier (per unit), no volatility or time (intrinsic is model-free). `underlyingPrice` and `strike` must be finite and `>= 0` — zero is legal on either leg (a worthless underlying or a zero strike still has a well-defined intrinsic value). ```typescript export declare function vanillaIntrinsic(input: VanillaIntrinsicInput): number; ``` Example (source JSDoc): ```ts import { vanillaIntrinsic } from '@insiderfinance/totalfinance/options/payoff'; vanillaIntrinsic({ type: 'call', underlyingPrice: 112, strike: 100 }); // 12 vanillaIntrinsic({ type: 'put', underlyingPrice: 88, strike: 100 }); // 12 vanillaIntrinsic({ type: 'put', underlyingPrice: 112, strike: 100 }); // 0 ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VanillaIntrinsicInput; default: not declared - (input).strike: number; default: not declared — The option's strike price per unit. - (input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared — Which leg — `'call'` or `'put'`. - (input).underlyingPrice: number; default: not declared — The underlying's price per unit, in the same currency unit as `strike`. ### @insiderfinance/totalfinance/options#varianceSwap Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const varianceSwap: { readonly hestonFairVariance: (parameters: { v0: number; kappa: number; theta: number; }, timeToExpiryYears: number) => number; readonly value: (input: { realizedVariance: number; strikeVariance: number; varianceNotional?: number; riskFreeRate: number; timeToExpiryYears: number; }) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - hestonFairVariance: (parameters: { v0: number; kappa: number; theta: number; }, timeToExpiryYears: number) => number; default: not declared — Fair variance strike under Heston: `θ + (v₀ − θ)·(1 − e^{−κT})/(κT)`. Depends only on the mean-reversion `κ`, long-run variance `θ`, and initial variance `v₀` (not on vol-of-vol/ρ). - hestonFairVariance(parameters): { kappa: number; theta: number; v0: number; }; default: not declared - hestonFairVariance(parameters).kappa: number; default: not declared - hestonFairVariance(parameters).theta: number; default: not declared - hestonFairVariance(parameters).v0: number; default: not declared - hestonFairVariance(timeToExpiryYears): number; default: not declared - value: (input: { realizedVariance: number; strikeVariance: number; varianceNotional?: number; riskFreeRate: number; timeToExpiryYears: number; }) => number; default: not declared — Present value of a variance swap: `e^{−rT}·varianceNotional·(realizedVariance − strikeVariance)`. - value(input): { realizedVariance: number; riskFreeRate: number; strikeVariance: number; timeToExpiryYears: number; varianceNotional?: number; }; default: not declared - value(input).realizedVariance: number; default: not declared - value(input).riskFreeRate: number; default: not declared - value(input).strikeVariance: number; default: not declared - value(input).timeToExpiryYears: number; default: not declared - value(input).varianceNotional?: number; default: not declared ### @insiderfinance/totalfinance/options#volatilitySwap Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const volatilitySwap: { readonly approximateFairVolatility: (input: { fairVariance: number; varianceOfVariance?: number; }) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - approximateFairVolatility: (input: { fairVariance: number; varianceOfVariance?: number; }) => number; default: not declared — Brockhaus–Long convexity-adjusted fair vol: `K_vol ≈ √K_var·(1 − Var[realized variance]/(8·K_var²))`. With no variance-of-variance it reduces to `√K_var`; the adjustment captures the (downward) Jensen gap between √E[var] and E[√var]. - approximateFairVolatility(input): { fairVariance: number; varianceOfVariance?: number; }; default: not declared - approximateFairVolatility(input).fairVariance: number; default: not declared - approximateFairVolatility(input).varianceOfVariance?: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/options/bachelier ### @insiderfinance/totalfinance/options/bachelier#BachelierImpliedVolatilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BachelierImpliedVolatilityInput`. ### @insiderfinance/totalfinance/options/bachelier#BachelierImpliedVolatilityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BachelierImpliedVolatilityResult`. ### @insiderfinance/totalfinance/options/bachelier#BachelierInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BachelierInput`. ### @insiderfinance/totalfinance/options/bachelier#BachelierTypedInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BachelierTypedInput`. ### @insiderfinance/totalfinance/options/bachelier#bachelier Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#bachelier`. ### @insiderfinance/totalfinance/options/bachelier#bachelierExtendedGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bachelier (normal-model) higher-order Greeks (w.r.t. the forward `F` and the NORMAL vol `σ_N`). These are the arithmetic-BM analogues of {@link blackScholesExtendedGreeks } — different formulas, since the density is `φ((F−K)/σ_N√T)`, and `vega`/`vanna`/… are per 1.00 of normal vol (price units). `phi` (dividend rho) is 0 (a forward model has no dividend yield); `lambda = Δ·F/V`. All validated against finite differences of the first-order Greeks / the price. ```typescript export declare function bachelierExtendedGreeks(input: BachelierTypedInput): ExtendedGreeks; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BachelierTypedInput; default: not declared - (input).forward: number; default: not declared - (input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.charm: number; default: not declared - return.color: number; default: not declared - return.delta: number; default: not declared - return.gamma: number; default: not declared - return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.rho: number; default: not declared - return.speed: number; default: not declared - return.theta: number; default: not declared - return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.vanna: number; default: not declared - return.vega: number; default: not declared - return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.vomma: number; default: not declared - return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). ### @insiderfinance/totalfinance/options/bachelier#bachelierGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bachelier first-order Greeks (vega is per 1.00 of normal vol). ```typescript export declare function bachelierGreeks(input: BachelierTypedInput): Greeks; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BachelierTypedInput; default: not declared - (input).forward: number; default: not declared - (input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.delta: number; default: not declared - return.gamma: number; default: not declared - return.rho: number; default: not declared - return.theta: number; default: not declared - return.vega: number; default: not declared ### @insiderfinance/totalfinance/options/bachelier#bachelierImpliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve Bachelier (normal) implied volatility. Reports failure honestly. Endpoint acceptance uses the same RELATIVE tolerance as the BSM kernel (see {@link impliedVolatilityPriceTolerance}), so a target below the σ_N→0 price floor fails as `price_below_resolvable` instead of being "matched" by the bracket's low endpoint. The normal model has no upper price bound (the call price grows without limit in σ_N), so there is no above-max case here. ```typescript export declare function bachelierImpliedVolatility(input: BachelierImpliedVolatilityInput): BachelierImpliedVolatilityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BachelierImpliedVolatilityInput; default: not declared - (input).forward: number; default: not declared - (input).price: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.converged: boolean; default: not declared - return.iterations: number; default: not declared - return.reason?: 'below_intrinsic' | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options/bachelier#bachelierPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function bachelierPrice(input: BachelierTypedInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BachelierTypedInput; default: not declared - (input).forward: number; default: not declared - (input).normalVolatility: number; default: not declared — NORMAL (absolute) volatility in PRICE UNITS — deliberately NOT named `vol` (Law 4): the lognormal decimal and the price-unit normal vol must never share a field name. `vega` is reported per 1.00 of normal vol (`units.vega: perPoint`). - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared ## Entrypoint @insiderfinance/totalfinance/options/batch ### @insiderfinance/totalfinance/options/batch#BlackScholesEvaluateManyOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesEvaluateManyOptions`. ### @insiderfinance/totalfinance/options/batch#BlackScholesEvaluateManyResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesEvaluateManyResult`. ### @insiderfinance/totalfinance/options/batch#BlackScholesOutput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesOutput`. ### @insiderfinance/totalfinance/options/batch#BlackScholesOutputBuffers Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesOutputBuffers`. ### @insiderfinance/totalfinance/options/batch#BlackScholesOutputSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesOutputSelection`. ### @insiderfinance/totalfinance/options/batch#OptionBatchColumns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#OptionBatchColumns`. ### @insiderfinance/totalfinance/options/batch#OptionBatchResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#OptionBatchResult`. ### @insiderfinance/totalfinance/options/batch#OptionImpliedVolatilityBatchColumns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#OptionImpliedVolatilityBatchColumns`. ### @insiderfinance/totalfinance/options/batch#OptionImpliedVolatilityBatchResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#OptionImpliedVolatilityBatchResult`. ### @insiderfinance/totalfinance/options/batch#PriceManyInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#PriceManyInput`. ### @insiderfinance/totalfinance/options/batch#blackScholesEvaluateMany Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black–Scholes–Merton outputs for every row of a columnar batch, computing ONLY the selected outputs and their dependencies — `{ outputs: ['gamma'] }` evaluates no cumulative normal. Validates the columns (closed keys, exact row counts), every row's values (positive finite spot, strike, time and volatility; finite rate, dividend yield and type) and the selection, then allocates one `Float64Array` per selected output. Values are bit-identical to the scalar `blackScholes` functions on the same row. Units: theta per calendar day, vega and rho per 1%, higher-order Greeks in the raw units of `blackScholes.extendedGreeks`. ```typescript export declare function blackScholesEvaluateMany(columns: OptionBatchColumns, options: BlackScholesEvaluateManyOptions): BlackScholesEvaluateManyResult; ``` Example (source JSDoc): const { gamma } = blackScholesEvaluateMany(columns, { outputs: ['gamma'] }); Members/parameters (default = JSDoc only; not declared means no documented default): - (columns): OptionBatchColumns; default: not declared - (columns).dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - (columns).riskFreeRate: Float64Array; default: not declared - (columns).spot: Float64Array; default: not declared - (columns).strike: Float64Array; default: not declared - (columns).timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - (columns).type: Int8Array; default: not declared - (columns).volatility: Float64Array; default: not declared - (options): BlackScholesEvaluateManyOptions; default: not declared - (options).outputs: O; default: not declared — The outputs to compute, e.g. `['gamma']` or `['price', 'delta']`. Required, nonempty, dense and duplicate-free; only these are computed and returned. ### @insiderfinance/totalfinance/options/batch#blackScholesEvaluateManyInto Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Write the selected Black–Scholes–Merton outputs for every row into caller-owned buffers — the buffer-writing form of {@link blackScholesEvaluateMany}. Temporary result columns ensure atomic writes. The property names of `outputs` are the selection: `{ gamma: buffer }` computes gamma only. Reusable storage is not unchecked input. Before anything is written this validates the columns and every row's values exactly as {@link blackScholesEvaluateMany} does, and every buffer: a `Float64Array` (not a plain array or another typed array) with at least one element per row. No buffer may overlap an input column or another output buffer in memory — not even an exact alias — because a write would then change values that are still to be read or returned. A rejected call writes nothing; a successful one writes elements `[0, rows)` of each buffer and leaves the rest untouched. An `undefined` entry is treated as omitted. ```typescript export declare function blackScholesEvaluateManyInto(columns: OptionBatchColumns, outputs: BlackScholesOutputBuffers): void; ``` Example (source JSDoc): const gamma = new Float64Array(capacity); blackScholesEvaluateManyInto(columns, { gamma }); Members/parameters (default = JSDoc only; not declared means no documented default): - (columns): OptionBatchColumns; default: not declared - (columns).dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - (columns).riskFreeRate: Float64Array; default: not declared - (columns).spot: Float64Array; default: not declared - (columns).strike: Float64Array; default: not declared - (columns).timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - (columns).type: Int8Array; default: not declared - (columns).volatility: Float64Array; default: not declared - (outputs): BlackScholesOutputBuffers; default: not declared - (outputs).charm?: Float64Array; default: not declared — ∂Δ/∂T, per added year of time-to-expiry. - (outputs).color?: Float64Array; default: not declared — ∂Γ/∂T, per added year of time-to-expiry. - (outputs).delta?: Float64Array; default: not declared — ∂V/∂S. - (outputs).gamma?: Float64Array; default: not declared — ∂²V/∂S². - (outputs).price?: Float64Array; default: not declared — Option value. - (outputs).rho?: Float64Array; default: not declared — Value change per 1% (0.01) rate move. - (outputs).speed?: Float64Array; default: not declared — ∂Γ/∂S. - (outputs).theta?: Float64Array; default: not declared — Value change per calendar day elapsed. - (outputs).vanna?: Float64Array; default: not declared — ∂Δ/∂σ, per 1.00 σ. - (outputs).vega?: Float64Array; default: not declared — Value change per 1% (0.01) volatility move. - (outputs).vomma?: Float64Array; default: not declared — ∂²V/∂σ², per 1.00 σ². ### @insiderfinance/totalfinance/options/batch#blackScholesImpliedVolatilityMany Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Batch implied volatility over a columnar option chain (spec §9.6). Each row is inverted with the bounded Brent solver; rows that cannot be solved report `converged[i] = 0` and a machine-readable `reasons[i]` rather than a fabricated number (design law #4). The non-converged `iv[i]` is `NaN`. ```typescript export declare function blackScholesImpliedVolatilityMany(cols: OptionImpliedVolatilityBatchColumns): OptionImpliedVolatilityBatchResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (cols): OptionImpliedVolatilityBatchColumns; default: not declared - (cols).dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - (cols).price: Float64Array; default: not declared — Observed option prices to invert. - (cols).riskFreeRate: Float64Array; default: not declared - (cols).spot: Float64Array; default: not declared - (cols).strike: Float64Array; default: not declared - (cols).timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - (cols).type: Int8Array; default: not declared - return.converged: Uint8Array; default: not declared — Per row: 1 = converged, 0 = failed (inspect `reasons[i]`). - return.impliedVolatility: Float64Array; default: not declared - return.reasons: (ImpliedVolatilityReason | undefined)[]; default: not declared — Per-row failure reason, or `undefined` where the solve converged. ### @insiderfinance/totalfinance/options/batch#blackScholesPriceMany Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). BSM batch pricing over columnar input. Pass `{ greeks: true }` to also fill the five first-order Greek columns (theta per calendar day, vega and rho per 1%), computed in the SAME pass as price so `d1`, `d2`, the discounts and the distribution terms are evaluated once per row. For any other selection — gamma alone, price and gamma, the higher-order Greeks — use {@link blackScholesEvaluateMany}. ```typescript export declare function blackScholesPriceMany(cols: OptionBatchColumns, options?: { greeks?: boolean; }): OptionBatchResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (cols): OptionBatchColumns; default: not declared - (cols).dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - (cols).riskFreeRate: Float64Array; default: not declared - (cols).spot: Float64Array; default: not declared - (cols).strike: Float64Array; default: not declared - (cols).timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - (cols).type: Int8Array; default: not declared - (cols).volatility: Float64Array; default: not declared - (options)?: { greeks?: boolean; }; default: not declared - (options).greeks?: boolean; default: not declared - return.delta?: Float64Array; default: not declared - return.gamma?: Float64Array; default: not declared - return.price: Float64Array; default: not declared - return.rho?: Float64Array; default: not declared - return.theta?: Float64Array; default: not declared - return.vega?: Float64Array; default: not declared ### @insiderfinance/totalfinance/options/batch#blackScholesPriceManyInto Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Write BSM prices for `cols` into the provided `out` buffer, committing only after all rows succeed. Validates the columns (closed keys, exact row counts) and every row's values — positive finite spot, strike, time and volatility; finite rate, dividend yield and type — before writing anything, exactly as {@link blackScholesPriceMany} does. Elements of `out` past the row count are untouched. `out` may alias an input column EXACTLY (in-place pricing); a partial overlap is rejected. ```typescript export declare function blackScholesPriceManyInto(cols: OptionBatchColumns, out: Float64Array): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (cols): OptionBatchColumns; default: not declared - (cols).dividendYield?: Float64Array; default: not declared — Optional per-row continuous dividend yield (defaults to 0). - (cols).riskFreeRate: Float64Array; default: not declared - (cols).spot: Float64Array; default: not declared - (cols).strike: Float64Array; default: not declared - (cols).timeToExpiryYears: Float64Array; default: not declared — Time to expiry in years. - (cols).type: Int8Array; default: not declared - (cols).volatility: Float64Array; default: not declared - (out): Float64Array; default: not declared ### @insiderfinance/totalfinance/options/batch#priceMany Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#priceMany`. ## Entrypoint @insiderfinance/totalfinance/options/black-scholes ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesEvaluateFacade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `blackScholes.evaluate` — a selected calculation with its `.explain` companion. An empty selection is refused at run time (`input.out_of_range`). ```typescript /** * `blackScholes.evaluate` — a selected calculation with its `.explain` companion. An empty * selection is refused at run time (`input.out_of_range`). */ export interface BlackScholesEvaluateFacade { (input: BlackScholesEvaluateInput): BlackScholesEvaluation; explain(input: BlackScholesEvaluateInput): Computed>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesEvaluateInput; default: not declared - (input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - (input).outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - (input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - (input).spot: number; default: not declared — Spot price of the underlying. - (input).strike: number; default: not declared — Strike price. - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - (input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). - explain: (input: BlackScholesEvaluateInput) => Computed>; default: not declared - explain().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: BlackScholesEvaluation; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): BlackScholesEvaluateInput; default: not declared - explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default `0`). - explain(input).outputs: O; default: not declared — The outputs to compute, e.g. `['price', 'delta', 'gamma']`. Only these appear in the result. - explain(input).riskFreeRate: number; default: not declared — Continuously-compounded risk-free rate (decimal, e.g. `0.045`). - explain(input).spot: number; default: not declared — Spot price of the underlying. - explain(input).strike: number; default: not declared — Strike price. - explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - explain(input).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - explain(input).volatility: number; default: not declared — Volatility (decimal, e.g. `0.22`). ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesEvaluateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesEvaluateInput`. ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesEvaluation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesEvaluation`. ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesImpliedVolatilityKernelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BlackScholesImpliedVolatilityKernelInput extends BlackScholesPriceBoundsInput, BlackScholesImpliedVolatilityOptions { price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - lowerVolatilityBound?: number; default: not declared — Lower σ bracket (default `1e-7`). - price: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared - upperVolatilityBound?: number; default: not declared — Upper σ bracket before expansion (default `5`). ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesImpliedVolatilityOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityOptions`. ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesImpliedVolatilityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityResult`. ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesKernelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BlackScholesKernelInput extends BlackScholesPriceBoundsInput { volatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesOutput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesOutput`. ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesOutputSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesOutputSelection`. ### @insiderfinance/totalfinance/options/black-scholes#BlackScholesPriceBoundsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BlackScholesPriceBoundsInput { type: OptionType; spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; dividendYield: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options/black-scholes#blackScholes Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#blackScholes`. ### @insiderfinance/totalfinance/options/black-scholes#blackScholesExtendedGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Higher-order Greeks under BSM (spec §9.4), analytic and exact. First-order fields (`delta`…`rho`) carry the same default units as {@link blackScholesGreeks}; the second/third-order fields are in raw units: - `vanna` = ∂Δ/∂σ = ∂²V/∂S∂σ (per 1.00 σ, per $), - `vomma` = ∂(vega)/∂σ = ∂²V/∂σ² (per 1.00 σ²; vega here is per 1.00 σ), - `charm` = ∂Δ/∂T (delta drift per added year of time-to-expiry), - `speed` = ∂Γ/∂S = ∂³V/∂S³, - `color` = ∂Γ/∂T (gamma drift per added year of time-to-expiry), - `phi` = ε = ∂V/∂q (dividend rho, per 1% dividend yield — scaled like rho), - `zomma` = ∂Γ/∂σ = ∂³V/∂S²∂σ, - `veta` = ∂vega/∂T (per year of time-to-expiry; the ∂/∂T sibling of vega), - `vera` = ∂rho/∂σ = ∂²V/∂r∂σ, - `ultima`= ∂vomma/∂σ = ∂³V/∂σ³, - `lambda`= Δ·S/V (elasticity / effective leverage, dimensionless). All are validated against finite differences of the first-order Greeks / the price. ```typescript export declare function blackScholesExtendedGreeks(input: BlackScholesKernelInput): ExtendedGreeks; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesKernelInput; default: not declared - (input).dividendYield: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared - return.charm: number; default: not declared - return.color: number; default: not declared - return.delta: number; default: not declared - return.gamma: number; default: not declared - return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.rho: number; default: not declared - return.speed: number; default: not declared - return.theta: number; default: not declared - return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.vanna: number; default: not declared - return.vega: number; default: not declared - return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.vomma: number; default: not declared - return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). ### @insiderfinance/totalfinance/options/black-scholes#blackScholesGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). First-order Greeks in TotalFinance default units (theta/day, vega/1%, rho/1%). ```typescript export declare function blackScholesGreeks(input: BlackScholesKernelInput): Greeks; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesKernelInput; default: not declared - (input).dividendYield: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared - return.delta: number; default: not declared - return.gamma: number; default: not declared - return.rho: number; default: not declared - return.theta: number; default: not declared - return.vega: number; default: not declared ### @insiderfinance/totalfinance/options/black-scholes#blackScholesImpliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve implied volatility from a price using Brent with no-arbitrage bound checks. Returns `converged: false` with a machine-readable `reason` on failure — never a fabricated value (design law #4). Three ways there is no answer, reported apart: the price violates the intrinsic floor (`below_intrinsic`), it sits at or above the upper no-arbitrage bound, which is a SUPREMUM attained only as σ→∞ (`above_max_bound`), or it is below the model price at the lowest σ in the bracket (`price_below_resolvable`). ```typescript export declare function blackScholesImpliedVolatility(input: BlackScholesImpliedVolatilityKernelInput): BlackScholesImpliedVolatilityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesImpliedVolatilityKernelInput; default: not declared - (input).dividendYield: number; default: not declared - (input).lowerVolatilityBound?: number; default: not declared — Lower σ bracket (default `1e-7`). - (input).price: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).upperVolatilityBound?: number; default: not declared — Upper σ bracket before expansion (default `5`). - return.converged: boolean; default: not declared - return.error?: number; default: not declared - return.iterations: number; default: not declared - return.message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - return.reason?: ImpliedVolatilityReason; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options/black-scholes#blackScholesPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black–Scholes–Merton price for a European call/put with continuous dividend yield `q`. This is the seed defect Phase 3B was opened on. It validated the object and the `type` enum, then destructured six numeric fields and checked none of them: omitting `volatility` made `sigma` `undefined`, `d1` `NaN`, and the returned PRICE `NaN` — handed back as a success, through a declaration that said the field was required. A pricing function that answers `NaN` is worse than one that throws, because every layer above it treats the answer as a number. ```typescript export declare function blackScholesPrice(input: BlackScholesKernelInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesKernelInput; default: not declared - (input).dividendYield: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options/black-scholes#blackScholesPriceBounds Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). No-arbitrage price bounds for a vanilla under BSM (forward intrinsic ≤ price ≤ discounted spot/strike). ```typescript export declare function blackScholesPriceBounds(input: BlackScholesPriceBoundsInput): { lower: number; upper: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BlackScholesPriceBoundsInput; default: not declared - (input).dividendYield: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.lower: number; default: not declared - return.upper: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/options/black76 ### @insiderfinance/totalfinance/options/black76#Black76ImpliedVolatilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#Black76ImpliedVolatilityInput`. ### @insiderfinance/totalfinance/options/black76#Black76ImpliedVolatilityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#Black76ImpliedVolatilityResult`. ### @insiderfinance/totalfinance/options/black76#Black76Input Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#Black76Input`. ### @insiderfinance/totalfinance/options/black76#Black76PriceBoundsInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type Black76PriceBoundsInput = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - riskFreeRate: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/options/black76#Black76TypedInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#Black76TypedInput`. ### @insiderfinance/totalfinance/options/black76#black76 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#black76`. ### @insiderfinance/totalfinance/options/black76#black76ExtendedGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black-76 higher-order Greeks (w.r.t. the forward `F`). The forward-price derivatives (vanna, charm, vomma, speed, color, zomma, veta, ultima) coincide with BSM's at `S = F`, `q = r` — Black-76 has the same `d1`/`d2` and discount as that BSM instance — so they are borrowed from {@link blackScholesExtendedGreeks}; the forward-model-specific ones are computed directly: - `vera` = ∂rho/∂σ = ∂(−T·price)/∂σ = −T·vega, - `phi` = 0 (the forward model has no dividend yield; carry is embedded in `F`), - `lambda` = Δ·F/V. First-order fields (theta/rho) come from {@link black76Greeks}, which are the Black-76 conventions. ```typescript export declare function black76ExtendedGreeks(input: Black76TypedInput): ExtendedGreeks; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Black76TypedInput; default: not declared - (input).forward: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared - return.charm: number; default: not declared - return.color: number; default: not declared - return.delta: number; default: not declared - return.gamma: number; default: not declared - return.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.rho: number; default: not declared - return.speed: number; default: not declared - return.theta: number; default: not declared - return.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.vanna: number; default: not declared - return.vega: number; default: not declared - return.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.vomma: number; default: not declared - return.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). ### @insiderfinance/totalfinance/options/black76#black76Greeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black-76 first-order Greeks (theta/day, vega/1%, rho/1%; delta/gamma w.r.t. the forward). ```typescript export declare function black76Greeks(input: Black76TypedInput): Greeks; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Black76TypedInput; default: not declared - (input).forward: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared - return.delta: number; default: not declared - return.gamma: number; default: not declared - return.rho: number; default: not declared - return.theta: number; default: not declared - return.vega: number; default: not declared ### @insiderfinance/totalfinance/options/black76#black76ImpliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve Black-76 implied volatility. Reports failure honestly; never fabricates a value. Bounds and endpoint acceptance follow the same RELATIVE-tolerance rules as the BSM kernel (see {@link impliedVolatilityPriceTolerance}): a target below the σ→0 price floor fails as `price_below_resolvable`, and a target at the σ→∞ upper bound as `above_max_bound`. ```typescript export declare function black76ImpliedVolatility(input: Black76ImpliedVolatilityInput): Black76ImpliedVolatilityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Black76ImpliedVolatilityInput; default: not declared - (input).forward: number; default: not declared - (input).price: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.converged: boolean; default: not declared - return.iterations: number; default: not declared - return.message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - return.reason?: 'below_intrinsic' | 'above_max_bound' | 'price_below_resolvable' | 'no_bracket' | 'max_iterations'; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options/black76#black76Price Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black-76 price. The second seed defect named in the spec, and the same shape as the first: omitting `volatility` made `sigma` `undefined`, `d1` `NaN`, and the returned price `NaN` — a success-typed wrong number. ```typescript export declare function black76Price(input: Black76TypedInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Black76TypedInput; default: not declared - (input).forward: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options/black76#black76PriceBounds Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). No-arbitrage price bounds for Black-76. ```typescript export declare function black76PriceBounds(input: Black76PriceBoundsInput): { lower: number; upper: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Black76PriceBoundsInput; default: not declared - (input).forward: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.lower: number; default: not declared - return.upper: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/options/exotics ### @insiderfinance/totalfinance/options/exotics#AsianInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#AsianInput`. ### @insiderfinance/totalfinance/options/exotics#AsianMonteCarloInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#AsianMonteCarloInput`. ### @insiderfinance/totalfinance/options/exotics#AsianMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#AsianMonteCarloOptions`. ### @insiderfinance/totalfinance/options/exotics#AutocallableInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#AutocallableInput`. ### @insiderfinance/totalfinance/options/exotics#BarrierInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BarrierInput`. ### @insiderfinance/totalfinance/options/exotics#BarrierMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BarrierMonteCarloOptions`. ### @insiderfinance/totalfinance/options/exotics#BarrierType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BarrierType`. ### @insiderfinance/totalfinance/options/exotics#BasketInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BasketInput`. ### @insiderfinance/totalfinance/options/exotics#CliquetInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#CliquetInput`. ### @insiderfinance/totalfinance/options/exotics#CompoGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#CompoGreeks`. ### @insiderfinance/totalfinance/options/exotics#CompoInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#CompoInput`. ### @insiderfinance/totalfinance/options/exotics#CompoMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#CompoMonteCarloOptions`. ### @insiderfinance/totalfinance/options/exotics#DigitalInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DigitalInput`. ### @insiderfinance/totalfinance/options/exotics#DigitalKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DigitalKind`. ### @insiderfinance/totalfinance/options/exotics#DoubleTouchInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DoubleTouchInput`. ### @insiderfinance/totalfinance/options/exotics#DoubleTouchKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DoubleTouchKind`. ### @insiderfinance/totalfinance/options/exotics#ExoticMonteCarloResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ExoticMonteCarloResult`. ### @insiderfinance/totalfinance/options/exotics#ExoticResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ExoticResult`. ### @insiderfinance/totalfinance/options/exotics#ForwardStartInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ForwardStartInput`. ### @insiderfinance/totalfinance/options/exotics#InverseGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#InverseGreeks`. ### @insiderfinance/totalfinance/options/exotics#InverseOptionInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#InverseOptionInput`. ### @insiderfinance/totalfinance/options/exotics#InverseOptionMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#InverseOptionMonteCarloOptions`. ### @insiderfinance/totalfinance/options/exotics#LookbackInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LookbackInput`. ### @insiderfinance/totalfinance/options/exotics#LookbackMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LookbackMonteCarloOptions`. ### @insiderfinance/totalfinance/options/exotics#LookbackStrike Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LookbackStrike`. ### @insiderfinance/totalfinance/options/exotics#MultiAssetInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MultiAssetInput`. ### @insiderfinance/totalfinance/options/exotics#NapoleonInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#NapoleonInput`. ### @insiderfinance/totalfinance/options/exotics#QuantoInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#QuantoInput`. ### @insiderfinance/totalfinance/options/exotics#RainbowKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#RainbowKind`. ### @insiderfinance/totalfinance/options/exotics#ReverseCliquetInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ReverseCliquetInput`. ### @insiderfinance/totalfinance/options/exotics#SpreadInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SpreadInput`. ### @insiderfinance/totalfinance/options/exotics#TouchInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#TouchInput`. ### @insiderfinance/totalfinance/options/exotics#TouchKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#TouchKind`. ### @insiderfinance/totalfinance/options/exotics#TouchMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#TouchMonteCarloOptions`. ### @insiderfinance/totalfinance/options/exotics#asian Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#asian`. ### @insiderfinance/totalfinance/options/exotics#autocallable Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#autocallable`. ### @insiderfinance/totalfinance/options/exotics#barrier Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#barrier`. ### @insiderfinance/totalfinance/options/exotics#basket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#basket`. ### @insiderfinance/totalfinance/options/exotics#cliquet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#cliquet`. ### @insiderfinance/totalfinance/options/exotics#compo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#compo`. ### @insiderfinance/totalfinance/options/exotics#digital Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#digital`. ### @insiderfinance/totalfinance/options/exotics#doubleTouch Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#doubleTouch`. ### @insiderfinance/totalfinance/options/exotics#forwardStart Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#forwardStart`. ### @insiderfinance/totalfinance/options/exotics#inverseOption Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#inverseOption`. ### @insiderfinance/totalfinance/options/exotics#lookback Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#lookback`. ### @insiderfinance/totalfinance/options/exotics#napoleon Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#napoleon`. ### @insiderfinance/totalfinance/options/exotics#quanto Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#quanto`. ### @insiderfinance/totalfinance/options/exotics#rainbow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#rainbow`. ### @insiderfinance/totalfinance/options/exotics#reverseCliquet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#reverseCliquet`. ### @insiderfinance/totalfinance/options/exotics#spread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#spread`. ### @insiderfinance/totalfinance/options/exotics#touch Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#touch`. ### @insiderfinance/totalfinance/options/exotics#varianceSwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#varianceSwap`. ### @insiderfinance/totalfinance/options/exotics#volatilitySwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#volatilitySwap`. ## Entrypoint @insiderfinance/totalfinance/options/heston ### @insiderfinance/totalfinance/options/heston#HestonCosineExpansionOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#HestonCosineExpansionOptions`. ### @insiderfinance/totalfinance/options/heston#HestonCosineExpansionPriceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#HestonCosineExpansionPriceInput`. ### @insiderfinance/totalfinance/options/heston#HestonFirstOrderStepsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The EXACT first-order FD sizes cosGreeks differences with — shared with the disclosure (D6). ```typescript /** The EXACT first-order FD sizes cosGreeks differences with — shared with the disclosure (D6). */ export interface HestonFirstOrderStepsInput { spot: number; timeToExpiryYears: number; parameters: HestonParameters; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - parameters: HestonParameters; default: not declared - parameters.kappa: number; default: not declared — Mean-reversion speed κ. - parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - parameters.theta: number; default: not declared — Long-run variance θ. - parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - spot: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/options/heston#HestonInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#HestonInput`. ### @insiderfinance/totalfinance/options/heston#HestonMonteCarloEstimateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#HestonMonteCarloEstimateInput`. ### @insiderfinance/totalfinance/options/heston#HestonMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#HestonMonteCarloOptions`. ### @insiderfinance/totalfinance/options/heston#HestonMonteCarloResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#HestonMonteCarloResult`. ### @insiderfinance/totalfinance/options/heston#HestonParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#HestonParameters`. ### @insiderfinance/totalfinance/options/heston#HestonPriceMonteCarloRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#HestonPriceMonteCarloRequest`. ### @insiderfinance/totalfinance/options/heston#HestonPriceRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#HestonPriceRequest`. ### @insiderfinance/totalfinance/options/heston#heston Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#heston`. ### @insiderfinance/totalfinance/options/heston#hestonCosineExpansionPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function hestonCosineExpansionPrice(input: HestonCosineExpansionPriceInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): HestonCosineExpansionPriceInput; default: not declared - (input).dividendYield: number; default: not declared - (input).parameters: HestonParameters; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).terms?: number; default: not declared — Number of cosine terms (default 256, maximum 8,192). - (input).timeToExpiryYears: number; default: not declared - (input).truncation?: number; default: not declared - (input).type: OptionType; default: not declared ### @insiderfinance/totalfinance/options/heston#hestonFirstOrderSteps Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function hestonFirstOrderSteps(input: HestonFirstOrderStepsInput): { spotStep: number; volatilityStep: number; timeStepYears: number; rateStep: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): HestonFirstOrderStepsInput; default: not declared - (input).parameters: HestonParameters; default: not declared - (input).spot: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - return.rateStep: number; default: not declared - return.spotStep: number; default: not declared - return.timeStepYears: number; default: not declared - return.volatilityStep: number; default: not declared ### @insiderfinance/totalfinance/options/heston#hestonImpliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black–Scholes implied volatility of the Heston COS price — the bridge to a Heston vol surface. Returns the standard IV envelope: on a failed inversion `value` is `NaN` but `converged` is `false` with a machine-readable `reason` (design law #4 — a bare NaN would hide why). Expert kernel form (model-subpath surface) — the curated root surface is {@link heston.impliedVolatility}. ```typescript export declare function hestonImpliedVolatility(request: HestonPriceRequest): BlackScholesImpliedVolatilityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): HestonPriceRequest; default: not declared - (request).input: HestonInput; default: not declared - (request).options?: HestonCosineExpansionOptions; default: not declared - (request).parameters: HestonParameters; default: not declared - (request).type: OptionType; default: not declared - return.converged: boolean; default: not declared - return.error?: number; default: not declared - return.iterations: number; default: not declared - return.message?: string; default: not declared — Explanatory detail when a usable numeric pricing bracket cannot be established. - return.reason?: import('@insiderfinance/totalfinance/options').ImpliedVolatilityReason; default: not declared - return.value: number; default: not declared ### @insiderfinance/totalfinance/options/heston#hestonMonteCarloEstimate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Low-level kernel: Heston QE Monte-Carlo estimate of the discounted European payoff. Expert kernel form (model-subpath surface) — the curated root surface is {@link heston.monteCarloEstimate}. ```typescript export declare function hestonMonteCarloEstimate(input: HestonMonteCarloEstimateInput): MonteCarloEstimate; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): HestonMonteCarloEstimateInput; default: not declared - (input).dividendYield: number; default: not declared - (input).options: HestonMonteCarloOptions; default: not declared - (input).parameters: HestonParameters; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - return.seed: number; default: not declared — The seed, echoed for reproducibility. - return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - return.value: number; default: not declared - return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - return.warnings: QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). ### @insiderfinance/totalfinance/options/heston#hestonMonteCarloPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European option under Heston by QE Monte-Carlo, returning value + MC stats. Expert kernel form (model-subpath surface) — the curated root surface is {@link heston.monteCarloPrice}. ```typescript export declare function hestonMonteCarloPrice(request: HestonPriceMonteCarloRequest): HestonMonteCarloResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): HestonPriceMonteCarloRequest; default: not declared - (request).input: HestonInput; default: not declared - (request).options: HestonMonteCarloOptions; default: not declared - (request).parameters: HestonParameters; default: not declared - (request).type: OptionType; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: Greeks | ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.monteCarlo: MonteCarloStatistics; default: not declared - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options/heston#hestonPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European option under Heston via the COS method, with finite-difference Greeks. Expert kernel form (model-subpath surface) — the curated root surface is {@link heston.price}. ```typescript export declare function hestonPrice(request: HestonPriceRequest): PriceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): HestonPriceRequest; default: not declared - (request).input: HestonInput; default: not declared - (request).options?: HestonCosineExpansionOptions; default: not declared - (request).parameters: HestonParameters; default: not declared - (request).type: OptionType; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: Greeks | ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ## Entrypoint @insiderfinance/totalfinance/options/lattice ### @insiderfinance/totalfinance/options/lattice#EquityLattice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#EquityLattice`. ### @insiderfinance/totalfinance/options/lattice#EquityLatticeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#EquityLatticeOptions`. ### @insiderfinance/totalfinance/options/lattice#LatticeNode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LatticeNode`. ### @insiderfinance/totalfinance/options/lattice#LatticeVariant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LatticeVariant`. ### @insiderfinance/totalfinance/options/lattice#equityLattice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a Cox–Ross–Rubinstein / Jarrow–Rudd equity binomial lattice. ```typescript export declare function equityLattice(options: EquityLatticeOptions): EquityLattice; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): EquityLatticeOptions; default: not declared - (options).dividendYield?: number; default: not declared - (options).horizonYears: number; default: not declared — Horizon in years. - (options).riskFreeRate: number; default: not declared - (options).spot: number; default: not declared - (options).steps?: number; default: not declared — Number of time steps (default 200). - (options).variant?: LatticeVariant; default: not declared — `crr` (Cox–Ross–Rubinstein, default) or `jarrow-rudd` (equal-probability). - (options).volatility: number; default: not declared - return.rollback: (terminal: (spot: number) => number, combine: (node: LatticeNode) => number) => number; default: not declared — Backward induction from the terminal step to the root. `terminal(spot)` seeds each leaf; `combine` returns each interior node's value from its children + context (apply discounting, exercise, conversion, default adjustment — whatever the instrument needs). Returns the root value. - return.spotAt: (stepIndex: number, upMoveCount: number) => number; default: not declared — Underlying price at node `(stepIndex, upMoveCount)` (`upMoveCount` up-moves out of `stepIndex`). - return.steps: number; default: not declared - return.timeStepYears: number; default: not declared - return.upProbability: number; default: not declared — Up-probability (risk-neutral). ## Entrypoint @insiderfinance/totalfinance/options/local-volatility ### @insiderfinance/totalfinance/options/local-volatility#DupireLocalVolatilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DupireLocalVolatilityInput`. ### @insiderfinance/totalfinance/options/local-volatility#DupireOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DupireOptions`. ### @insiderfinance/totalfinance/options/local-volatility#ImpliedVolatilityFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ImpliedVolatilityFunction`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityFunction`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityGridSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityGridSpecification`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityInput`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityMarket`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityMonteCarloEstimateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#LocalVolatilityMonteCarloEstimateInput`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityMonteCarloOptions`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityMonteCarloResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityMonteCarloResult`. ### @insiderfinance/totalfinance/options/local-volatility#LocalVolatilityPriceMonteCarloRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#LocalVolatilityPriceMonteCarloRequest`. ### @insiderfinance/totalfinance/options/local-volatility#dupireLocalVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the Dupire local-volatility function σ_loc(level, t) from an implied-vol surface. The returned function is pure and can be evaluated anywhere on the (level, t) plane; out-of-range or locally arbitrageable points are floored at `floorVolatility` rather than returning NaN. Expert kernel form (model-subpath surface) — the curated root surface is {@link localVolatility.fromImplied}. ```typescript export declare function dupireLocalVolatility(input: DupireLocalVolatilityInput): LocalVolatilityFunction; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DupireLocalVolatilityInput; default: not declared - (input).impliedVolatility: ImpliedVolatilityFunction; default: not declared - (input).market: LocalVolatilityMarket; default: not declared - (input).options?: DupireOptions; default: not declared ### @insiderfinance/totalfinance/options/local-volatility#localVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#localVolatility`. ### @insiderfinance/totalfinance/options/local-volatility#localVolatilityGrid Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Precompute a local-volatility function onto a (level × time) grid and return a fast bilinear-interpolating `LocalVolatilityFunction`. The exact `dupireLocalVolatility` does ~4 surface evaluations per call — far too slow to run inside a Monte-Carlo step loop — so cache it once on a grid and interpolate. Off-grid queries clamp to the nearest edge (a documented, no-NaN extrapolation). Expert kernel form (model-subpath surface) — the curated root surface is {@link localVolatility.grid}. ```typescript export declare function localVolatilityGrid(localVolatility: LocalVolatilityFunction, specification: LocalVolatilityGridSpecification): LocalVolatilityFunction; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (localVolatility): LocalVolatilityFunction; default: not declared - (specification): LocalVolatilityGridSpecification; default: not declared - (specification).levels: number[]; default: not declared — Underlying levels, ascending (e.g. 0.4·S₀ … 2.5·S₀). - (specification).times: number[]; default: not declared — Times in years, ascending (e.g. up to the longest expiry priced). ### @insiderfinance/totalfinance/options/local-volatility#localVolatilityMonteCarloEstimate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Low-level kernel: local-volatility Monte-Carlo estimate of the discounted European payoff. Expert kernel form (model-subpath surface) — the curated root surface is {@link localVolatility.monteCarloEstimate }. ```typescript export declare function localVolatilityMonteCarloEstimate(input: LocalVolatilityMonteCarloEstimateInput): MonteCarloEstimate; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LocalVolatilityMonteCarloEstimateInput; default: not declared - (input).dividendYield: number; default: not declared - (input).localVolatility: LocalVolatilityFunction; default: not declared - (input).options: LocalVolatilityMonteCarloOptions; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - return.seed: number; default: not declared — The seed, echoed for reproducibility. - return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - return.value: number; default: not declared - return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). ### @insiderfinance/totalfinance/options/local-volatility#localVolatilityMonteCarloPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European option under a local-volatility diffusion by Monte-Carlo. Pass a `LocalVolatilityFunction` (typically from {@link dupireLocalVolatility}); the result carries MC error statistics on `result.mc`. Expert kernel form (model-subpath surface) — the curated root surface is {@link localVolatility.monteCarloPrice }. ```typescript export declare function localVolatilityMonteCarloPrice(request: LocalVolatilityPriceMonteCarloRequest): LocalVolatilityMonteCarloResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): LocalVolatilityPriceMonteCarloRequest; default: not declared - (request).input: LocalVolatilityInput; default: not declared - (request).localVolatility: LocalVolatilityFunction; default: not declared - (request).options: LocalVolatilityMonteCarloOptions; default: not declared - (request).type: OptionType; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.monteCarlo: MonteCarloStatistics; default: not declared - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ## Entrypoint @insiderfinance/totalfinance/options/monte-carlo ### @insiderfinance/totalfinance/options/monte-carlo#ControlVariate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ControlVariate`. ### @insiderfinance/totalfinance/options/monte-carlo#GbmPathInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#GbmPathInput`. ### @insiderfinance/totalfinance/options/monte-carlo#GbmTerminalInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#GbmTerminalInput`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloEstimate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloEstimate`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloEuropeanInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Required raw inputs for one discounted European GBM estimate. ```typescript /** Required raw inputs for one discounted European GBM estimate. */ export interface MonteCarloEuropeanInput { type: OptionType; spot: number; strike: number; timeToExpiryYears: number; riskFreeRate: number; dividendYield: number; volatility: number; options: MonteCarloPriceOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - options: MonteCarloPriceOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set by CRN finite differences (implies `greeks`). Third-order Greeks (speed/color/ultima) carry more Monte-Carlo error than the first/second order — raise `paths` when you need them tight. - options.greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `true`). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloMethod`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloPriceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European contract by Monte-Carlo simulation, returning value, Greeks, assumptions, and the MC error statistics (`result.mc`). Validates the market the same way the analytic engines do, and applies the escrowed-spot model for discrete dividends. ```typescript /** * Price a European contract by Monte-Carlo simulation, returning value, Greeks, assumptions, and the * MC error statistics (`result.mc`). Validates the market the same way the analytic engines do, and * applies the escrowed-spot model for discrete dividends. */ export interface MonteCarloPriceInput { contract: OptionContract; market: OptionMarket; options: MonteCarloPriceOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: OptionType; default: not declared - contract.underlying: string; default: not declared - market: OptionMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.dividends?: import('@insiderfinance/totalfinance/options').DiscreteDividend[]; default: not declared — Discrete cash dividends (American engines use the escrowed-dividend approximation). - market.forward?: number; default: not declared - market.price?: number; default: not declared — The observed premium an inversion reproduces (`option.impliedVolatility`). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared - options: MonteCarloPriceOptions; default: not declared - options.antithetic?: boolean; default: not declared — Antithetic variates (pseudo only; ignored for QMC). Default `true`. - options.brownianBridge?: boolean; default: not declared — Brownian-bridge path ordering (QMC only; concentrates variance in the leading dimensions). - options.confidence?: number; default: not declared — Confidence level for the interval (default 0.95). - options.extendedGreeks?: boolean; default: not declared — Compute the full higher-order (extended) Greek set by CRN finite differences (implies `greeks`). Third-order Greeks (speed/color/ultima) carry more Monte-Carlo error than the first/second order — raise `paths` when you need them tight. - options.greeks?: boolean; default: not declared — Compute Greeks by common-random-number finite differences (default `true`). - options.method?: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — Sampling method (default `'pseudo'`). - options.paths?: number; default: not declared — Number of paths (antithetic pairs when `antithetic`). Default 50_000. - options.randomNumberGenerator?: import('@insiderfinance/totalfinance/options').MonteCarloRandomNumberGenerator; default: not declared — PRNG for `method: 'pseudo'` (default `'mulberry32'`). - options.seed: number; default: not declared — Seed — required and echoed for reproducibility. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloPriceOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloPriceOptions`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloPriceResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloPriceResult`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloRandomNumberGenerator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloRandomNumberGenerator`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloSamplingOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloSamplingOptions`. ### @insiderfinance/totalfinance/options/monte-carlo#MonteCarloStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#MonteCarloStatistics`. ### @insiderfinance/totalfinance/options/monte-carlo#VarianceReduction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#VarianceReduction`. ### @insiderfinance/totalfinance/options/monte-carlo#gbm Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#gbm`. ### @insiderfinance/totalfinance/options/monte-carlo#gbmPath Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function gbmPath(input: GbmPathInput): Float64Array; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): GbmPathInput; default: not declared - (input).dividendYield: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).shocks: number[]; default: not declared - (input).spot: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options/monte-carlo#gbmTerminal Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function gbmTerminal(input: GbmTerminalInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): GbmTerminalInput; default: not declared - (input).dividendYield: number; default: not declared - (input).riskFreeRate: number; default: not declared - (input).shock: number; default: not declared - (input).spot: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).volatility: number; default: not declared ### @insiderfinance/totalfinance/options/monte-carlo#monteCarloEuropean Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Low-level kernel: estimate the discounted European payoff on GBM. Inputs are assumed validated (S, K, T, σ all > 0). Uses the discounted terminal price as a control variate. The raw kernel remains direct and assumption-light, but its financially interchangeable values are named so a transposed rate, yield, time, or volatility cannot typecheck unnoticed. ```typescript export declare function monteCarloEuropean(input: MonteCarloEuropeanInput): MonteCarloEstimate; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MonteCarloEuropeanInput; default: not declared - (input).dividendYield: number; default: not declared - (input).options: MonteCarloPriceOptions; default: not declared - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared - return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - return.seed: number; default: not declared — The seed, echoed for reproducibility. - return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - return.value: number; default: not declared - return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). ### @insiderfinance/totalfinance/options/monte-carlo#monteCarloPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function monteCarloPrice(input: MonteCarloPriceInput): MonteCarloPriceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MonteCarloPriceInput; default: not declared - (input).contract: OptionContract; default: not declared - (input).market: OptionMarket; default: not declared - (input).options: MonteCarloPriceOptions; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: Greeks | ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.monteCarlo: MonteCarloStatistics; default: not declared — Standard error, confidence interval, path count, seed, method, and variance-reduction flags. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ## Entrypoint @insiderfinance/totalfinance/options/parity ### @insiderfinance/totalfinance/options/parity#BoxSpreadAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BoxSpreadAssumptions`. ### @insiderfinance/totalfinance/options/parity#BoxSpreadDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BoxSpreadDiagnostics`. ### @insiderfinance/totalfinance/options/parity#BoxSpreadOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BoxSpreadOptions`. ### @insiderfinance/totalfinance/options/parity#BoxSpreadRateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#BoxSpreadRateInput`. ### @insiderfinance/totalfinance/options/parity#BoxSpreadResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BoxSpreadResult`. ### @insiderfinance/totalfinance/options/parity#DEFAULT_OUTLIER_THRESHOLD Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DEFAULT_OUTLIER_THRESHOLD`. ### @insiderfinance/totalfinance/options/parity#ImpliedBorrowInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ImpliedBorrowInput`. ### @insiderfinance/totalfinance/options/parity#ImpliedBorrowOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ImpliedBorrowOptions`. ### @insiderfinance/totalfinance/options/parity#ImpliedDividendYieldInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ImpliedDividendYieldInput`. ### @insiderfinance/totalfinance/options/parity#ImpliedDividendYieldOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ImpliedDividendYieldOptions`. ### @insiderfinance/totalfinance/options/parity#ImpliedForwardInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ImpliedForwardInput`. ### @insiderfinance/totalfinance/options/parity#ImpliedForwardOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ImpliedForwardOptions`. ### @insiderfinance/totalfinance/options/parity#ParityAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ParityAssumptions`. ### @insiderfinance/totalfinance/options/parity#ParityCode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ParityCode`. ### @insiderfinance/totalfinance/options/parity#ParityDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ParityDiagnostics`. ### @insiderfinance/totalfinance/options/parity#ParityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ParityResult`. ### @insiderfinance/totalfinance/options/parity#ParityStrikeResidual Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#ParityStrikeResidual`. ### @insiderfinance/totalfinance/options/parity#boxSpreadRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#boxSpreadRate`. ### @insiderfinance/totalfinance/options/parity#impliedBorrow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#impliedBorrow`. ### @insiderfinance/totalfinance/options/parity#impliedDividendYield Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#impliedDividendYield`. ### @insiderfinance/totalfinance/options/parity#impliedForward Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#impliedForward`. ## Entrypoint @insiderfinance/totalfinance/options/payoff ### @insiderfinance/totalfinance/options/payoff#VanillaIntrinsicInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#VanillaIntrinsicInput`. ### @insiderfinance/totalfinance/options/payoff#vanillaIntrinsic Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#vanillaIntrinsic`. ## Entrypoint @insiderfinance/totalfinance/options/pricer ### @insiderfinance/totalfinance/options/pricer#OPTION_CONTRACT_PRICER_NAME Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adapter identity, reported via `definePricer` and usable in selection/diagnostics tooling. ```typescript export declare const OPTION_CONTRACT_PRICER_NAME: 'options.option-contract'; ``` ### @insiderfinance/totalfinance/options/pricer#OptionContractPricerOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionContractPricerOptions { /** * Explicit engine selection — the same engine objects `option.price` accepts (`engines.*` or * `defineOptionPricingEngine(...)`). Omit for automatic selection via `engines.auto()`; either * way the result's `diagnostics.selection` discloses who priced and why. Passing `engines.auto()` * here yields an AUTOMATIC report — auto genuinely chose, and the report never pretends * otherwise. */ engine?: OptionPricingEngine; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - engine?: OptionPricingEngine; default: not declared — Explicit engine selection — the same engine objects `option.price` accepts (`engines.*` or `defineOptionPricingEngine(...)`). Omit for automatic selection via `engines.auto()`; either way the result's `diagnostics.selection` discloses who priced and why. Passing `engines.auto()` here yields an AUTOMATIC report — auto genuinely chose, and the report never pretends otherwise. - engine.capabilities: ({ readonly styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; readonly dividends: readonly ('none' | 'continuous' | 'discrete')[]; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly extendedGreeks: boolean; readonly deterministic: boolean; }); default: not declared — Machine-readable capabilities, behaviorally verified by the engine contract suite (Law 8). - engine.capabilities.deterministic: boolean; default: not declared — Same inputs → identical outputs. `false` marks stochastic engines (Monte-Carlo): a FIXED SEED makes them reproducible, which is what the contract suite verifies for them. - engine.capabilities.dividends: readonly ('continuous' | 'none' | 'discrete')[]; default: not declared — Dividend models the engine honors. - engine.capabilities.extendedGreeks: boolean; default: not declared — Whether the extended (higher-order) Greek set is available on request. - engine.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How first-order Greeks are produced when requested: closed-form (`analytic`), bump-and-reprice (`finite-difference`), by the selected delegate (`delegated`, meta-engines), or not at all (`none` — requests are disclosed as unhonored, never silently dropped). - engine.capabilities.styles: readonly import('@insiderfinance/totalfinance/core').OptionStyle[]; default: not declared — Exercise styles this engine prices (must agree with `supports()`). - engine.name: string; default: not declared - engine.price: (input: import('@insiderfinance/totalfinance/options').OptionEnginePriceInput) => PriceResult; default: not declared - engine.price().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - engine.price().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - engine.price().return.greeks?: import('@insiderfinance/totalfinance/options').Greeks | import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - engine.price().return.greeks.charm: number; default: not declared - engine.price().return.greeks.color: number; default: not declared - engine.price().return.greeks.delta: number; default: not declared - engine.price().return.greeks.gamma: number; default: not declared - engine.price().return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - engine.price().return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - engine.price().return.greeks.rho: number; default: not declared - engine.price().return.greeks.speed: number; default: not declared - engine.price().return.greeks.theta: number; default: not declared - engine.price().return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - engine.price().return.greeks.vanna: number; default: not declared - engine.price().return.greeks.vega: number; default: not declared - engine.price().return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - engine.price().return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - engine.price().return.greeks.vomma: number; default: not declared - engine.price().return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - engine.price().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - engine.price().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - engine.price(input): import('@insiderfinance/totalfinance/options').OptionEnginePriceInput; default: not declared - engine.price(input).contract: OptionContract; default: not declared - engine.price(input).market: OptionMarket; default: not declared - engine.price(input).options?: import('@insiderfinance/totalfinance/options').PriceOptions; default: not declared - engine.supports: (contract: OptionContract) => boolean; default: not declared — Whether this engine can price the given contract. - engine.supports(contract): OptionContract; default: not declared - engine.supports(contract).adjusted?: boolean; default: not declared - engine.supports(contract).currency?: string; default: not declared - engine.supports(contract).deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - engine.supports(contract).exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - engine.supports(contract).expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - engine.supports(contract).expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - engine.supports(contract).expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - engine.supports(contract).multiplier?: number; default: not declared - engine.supports(contract).occSymbol?: string; default: not declared - engine.supports(contract).root?: string; default: not declared - engine.supports(contract).settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - engine.supports(contract).strike: number; default: not declared - engine.supports(contract).style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - engine.supports(contract).type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - engine.supports(contract).underlying: string; default: not declared - engine.version: string; default: not declared ### @insiderfinance/totalfinance/options/pricer#optionContractPricer Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a `Pricer` around the EXISTING `option.price`. `optionContractPricer()` — automatic engine selection (`engines.auto()`), disclosed candidate by candidate in `diagnostics.selection`. `optionContractPricer({ engine: engines.binomial({ steps: 501 }) })` — explicit selection, disclosed as explicit. The `greeks` capability is inherited from the chosen engine's own verified capabilities, never re-asserted; `randomness` is `'none'` for every engine (see the capabilities note below — engine randomness is construction-seeded, so the wrapped engine is per-instance deterministic). ```typescript export declare function optionContractPricer(options?: OptionContractPricerOptions): Pricer; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: OptionContractPricerOptions; default: not declared - (options).engine?: OptionPricingEngine; default: not declared — Explicit engine selection — the same engine objects `option.price` accepts (`engines.*` or `defineOptionPricingEngine(...)`). Omit for automatic selection via `engines.auto()`; either way the result's `diagnostics.selection` discloses who priced and why. Passing `engines.auto()` here yields an AUTOMATIC report — auto genuinely chose, and the report never pretends otherwise. - return.capabilities: import('@insiderfinance/totalfinance/core/pricing').PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - return.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - return.price: (input: PricerPriceInput) => PriceResult; default: not declared - return.priceBatch?: (input: import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput) => readonly PriceResult[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - return.requirements: (instrument: OptionContract) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - return.supports: (instrument: OptionContract) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - return.version: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/options/sabr ### @insiderfinance/totalfinance/options/sabr#SabrInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SabrInput`. ### @insiderfinance/totalfinance/options/sabr#SabrMonteCarloEstimateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SabrMonteCarloEstimateInput`. ### @insiderfinance/totalfinance/options/sabr#SabrMonteCarloOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SabrMonteCarloOptions`. ### @insiderfinance/totalfinance/options/sabr#SabrMonteCarloResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SabrMonteCarloResult`. ### @insiderfinance/totalfinance/options/sabr#SabrOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SabrOptions`. ### @insiderfinance/totalfinance/options/sabr#SabrParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SabrParameters`. ### @insiderfinance/totalfinance/options/sabr#SabrPriceMonteCarloRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SabrPriceMonteCarloRequest`. ### @insiderfinance/totalfinance/options/sabr#SabrPriceRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SabrPriceRequest`. ### @insiderfinance/totalfinance/options/sabr#SabrVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Point at which to evaluate a SABR smile: forward, strike, and time to expiry. ```typescript /** Point at which to evaluate a SABR smile: forward, strike, and time to expiry. */ export interface SabrVolatilityInput { forward: number; strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/options/sabr#SabrVolatilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Knobs for {@link sabrVolatility}. ```typescript /** Knobs for {@link sabrVolatility}. */ export interface SabrVolatilityOptions { /** Hagan expansion: `'lognormal'` (Black, default) or `'normal'` (Bachelier). */ volatilityType?: SabrVolatilityType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion: `'lognormal'` (Black, default) or `'normal'` (Bachelier). ### @insiderfinance/totalfinance/options/sabr#SabrVolatilityRequest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SabrVolatilityRequest`. ### @insiderfinance/totalfinance/options/sabr#SabrVolatilityType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#SabrVolatilityType`. ### @insiderfinance/totalfinance/options/sabr#sabr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#sabr`. ### @insiderfinance/totalfinance/options/sabr#sabrMonteCarloEstimate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Low-level kernel: SABR Euler Monte-Carlo estimate of the discounted European payoff. Expert kernel form (model-subpath surface) — the curated root surface is {@link sabr.monteCarloEstimate}. ```typescript export declare function sabrMonteCarloEstimate(input: SabrMonteCarloEstimateInput): MonteCarloEstimate; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SabrMonteCarloEstimateInput; default: not declared - (input).forward: number; default: not declared - (input).options: SabrMonteCarloOptions; default: not declared - (input).parameters: SabrParameters; default: not declared - (input).riskFreeRate: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - (input).type: OptionType; default: not declared - return.confidenceInterval: [number, number] | null; default: not declared — Confidence interval at the requested level (default 95%); null for unsupported QMC uncertainty or unrepresentable endpoints (disclosed with nonconvergence), even when standardError is positive. - return.converged: boolean; default: not declared — Whether the estimate is trustworthy (finite value and standard error). - return.method: import('@insiderfinance/totalfinance/options').MonteCarloMethod; default: not declared — The sampling method actually used (may differ from the request if QMC fell back to pseudo). - return.paths: number; default: not declared — Number of paths actually evaluated (antithetic pairs count as one path). - return.seed: number; default: not declared — The seed, echoed for reproducibility. - return.standardError: number | null; default: not declared — Standard error of the mean estimate — `null` for the QUASI-random methods (`sobol`, `halton`). The sample-variance formula `√(s²/n)` assumes independent draws. A low-discrepancy sequence is deterministic and negatively correlated by construction, so that formula does not estimate its error: at 16k Sobol points on a European call it overstated the true deviation by ~75×, and a confidence interval built from it was neither a confidence nor an interval. QMC error is estimated by RANDOMIZING the sequence (scrambling/shifting) and taking the variance ACROSS independent randomizations — which this estimator does not do, so it reports `null` and says so. - return.value: number; default: not declared - return.varianceReduction: import('@insiderfinance/totalfinance/options').VarianceReduction; default: not declared — Which variance-reduction techniques were applied. - return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings (e.g. a QMC dimension fallback). ### @insiderfinance/totalfinance/options/sabr#sabrMonteCarloPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European option under SABR by Euler Monte-Carlo of the SDE (validates the Hagan formula). Expert kernel form (model-subpath surface) — the curated root surface is {@link sabr.monteCarloPrice}. ```typescript export declare function sabrMonteCarloPrice(request: SabrPriceMonteCarloRequest): SabrMonteCarloResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): SabrPriceMonteCarloRequest; default: not declared - (request).input: SabrInput; default: not declared - (request).options: SabrMonteCarloOptions; default: not declared - (request).parameters: SabrParameters; default: not declared - (request).type: OptionType; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: Greeks | ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.monteCarlo: MonteCarloStatistics; default: not declared - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options/sabr#sabrPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price a European option under SABR by evaluating Hagan's implied vol and pricing with Black-76 (lognormal) or Bachelier (normal). Greeks are finite differences: `delta`/`gamma` w.r.t. the forward, `theta` per day, `vega` per 1% change in α, `rho` per 1% change in the rate — all echoed in `assumptions.units`. A point outside Hagan's expansion domain (see {@link requireExpansionInDomain}) REFUSES with a typed `input.out_of_range` error carrying the ν²T·ρ diagnosis — never a negative volatility, never a negative "price" reported as converged. Through `engines.sabr()` that surfaces as a failed `compareEngines` row; the value type stays `number` so no caller has to defend against a null. Expert kernel form (model-subpath surface) — the curated root surface is {@link sabr.price}. ```typescript export declare function sabrPrice(request: SabrPriceRequest): PriceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): SabrPriceRequest; default: not declared - (request).input: SabrInput; default: not declared - (request).options?: SabrOptions; default: not declared - (request).parameters: SabrParameters; default: not declared - (request).type: OptionType; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.greeks?: Greeks | ExtendedGreeks; default: not declared - return.greeks.charm: number; default: not declared - return.greeks.color: number; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - return.greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - return.greeks.rho: number; default: not declared - return.greeks.speed: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - return.greeks.vanna: number; default: not declared - return.greeks.vega: number; default: not declared - return.greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - return.greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - return.greeks.vomma: number; default: not declared - return.greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/options/sabr#sabrVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Hagan implied volatility (lognormal/Black by default, or normal/Bachelier). Returns the volatility to feed into Black-76 (lognormal) or Bachelier (normal) at the same forward, strike, and maturity. Subject-first like its namespace sibling `sabr.price(type, input, parameters, options)`: the smile POINT (`input`) comes before the model PARAMETERS (`parameters`). Expert kernel form (model-subpath surface) — the curated root surface is {@link sabr.volatility}. ```typescript export declare function sabrVolatility(request: SabrVolatilityRequest): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): SabrVolatilityRequest; default: not declared - (request).input: SabrVolatilityInput; default: not declared - (request).options?: SabrVolatilityOptions; default: not declared - (request).parameters: SabrParameters; default: not declared ## Entrypoint @insiderfinance/totalfinance/options/schema ### @insiderfinance/totalfinance/options/schema#BlackScholesImpliedVolatilityInputSchema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesImpliedVolatilityInputSchema`. ### @insiderfinance/totalfinance/options/schema#BlackScholesInputSchema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesInputSchema`. ### @insiderfinance/totalfinance/options/schema#BlackScholesInputShape Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type BlackScholesInputShape = Infer; ``` ### @insiderfinance/totalfinance/options/schema#BlackScholesTypedInputSchema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#BlackScholesTypedInputSchema`. ### @insiderfinance/totalfinance/options/schema#BlackScholesTypedInputShape Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type BlackScholesTypedInputShape = Infer; ``` ### @insiderfinance/totalfinance/options/schema#OptionContractSchema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core/schema#OptionContractSchema`. ### @insiderfinance/totalfinance/options/schema#OptionContractShape Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionContractShape = Infer; ``` ### @insiderfinance/totalfinance/options/schema#blackScholesShape Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Black–Scholes–Merton input field descriptors — the ONE source of truth for every option payload schema (facade, typed, implied-vol) and for consumers (MCP tools) that compose date-aware variants. Reusing these fields is why every option schema carries the same field descriptions instead of drifting apart. ```typescript export declare const blackScholesShape: { readonly spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; readonly dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - dividendYield._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - dividendYield._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - dividendYield._check().return.ok: (false) | (true); default: not declared - dividendYield._check().return.value: number | undefined; default: not declared - dividendYield._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - dividendYield._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - dividendYield._check(context).path: (string | number)[]; default: not declared - dividendYield._check(input): unknown; default: not declared - dividendYield._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - dividendYield._toJSONSchema().return.$id?: string; default: not declared - dividendYield._toJSONSchema().return.$schema?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.description?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.format?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.title?: string; default: not declared - dividendYield._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - dividendYield._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield._toJSONSchema().return.const?: unknown; default: not declared - dividendYield._toJSONSchema().return.default?: unknown; default: not declared - dividendYield._toJSONSchema().return.description?: string; default: not declared - dividendYield._toJSONSchema().return.enum?: unknown[]; default: not declared - dividendYield._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - dividendYield._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - dividendYield._toJSONSchema().return.format?: string; default: not declared - dividendYield._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield._toJSONSchema().return.maxItems?: number; default: not declared - dividendYield._toJSONSchema().return.maxLength?: number; default: not declared - dividendYield._toJSONSchema().return.maximum?: number; default: not declared - dividendYield._toJSONSchema().return.minItems?: number; default: not declared - dividendYield._toJSONSchema().return.minLength?: number; default: not declared - dividendYield._toJSONSchema().return.minimum?: number; default: not declared - dividendYield._toJSONSchema().return.multipleOf?: number; default: not declared - dividendYield._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield._toJSONSchema().return.pattern?: string; default: not declared - dividendYield._toJSONSchema().return.properties?: Record; default: not declared - dividendYield._toJSONSchema().return.required?: string[]; default: not declared - dividendYield._toJSONSchema().return.title?: string; default: not declared - dividendYield._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - dividendYield.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - dividendYield.describe(description): string; default: not declared - dividendYield.description: string | undefined; default: not declared - dividendYield.isOptional: true; default: not declared - dividendYield.kind: 'optional'; default: not declared - dividendYield.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - dividendYield.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - dividendYield.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - dividendYield.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - dividendYield.optional().return.description: string | undefined; default: not declared - dividendYield.optional().return.isOptional: true; default: not declared - dividendYield.optional().return.kind: 'optional'; default: not declared - dividendYield.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - dividendYield.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - dividendYield.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - dividendYield.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - dividendYield.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - dividendYield.parse(input): unknown; default: not declared - dividendYield.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - dividendYield.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - dividendYield.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - dividendYield.safeParse().return.data: number | undefined; default: not declared - dividendYield.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - dividendYield.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - dividendYield.safeParse().return.success: (false) | (true); default: not declared - dividendYield.safeParse(input): unknown; default: not declared - dividendYield.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - dividendYield.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - dividendYield.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield.toJSONSchema().return.$id?: string; default: not declared - dividendYield.toJSONSchema().return.$schema?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.description?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.format?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.title?: string; default: not declared - dividendYield.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - dividendYield.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield.toJSONSchema().return.const?: unknown; default: not declared - dividendYield.toJSONSchema().return.default?: unknown; default: not declared - dividendYield.toJSONSchema().return.description?: string; default: not declared - dividendYield.toJSONSchema().return.enum?: unknown[]; default: not declared - dividendYield.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - dividendYield.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - dividendYield.toJSONSchema().return.format?: string; default: not declared - dividendYield.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - dividendYield.toJSONSchema().return.maxItems?: number; default: not declared - dividendYield.toJSONSchema().return.maxLength?: number; default: not declared - dividendYield.toJSONSchema().return.maximum?: number; default: not declared - dividendYield.toJSONSchema().return.minItems?: number; default: not declared - dividendYield.toJSONSchema().return.minLength?: number; default: not declared - dividendYield.toJSONSchema().return.minimum?: number; default: not declared - dividendYield.toJSONSchema().return.multipleOf?: number; default: not declared - dividendYield.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - dividendYield.toJSONSchema().return.pattern?: string; default: not declared - dividendYield.toJSONSchema().return.properties?: Record; default: not declared - dividendYield.toJSONSchema().return.required?: string[]; default: not declared - dividendYield.toJSONSchema().return.title?: string; default: not declared - dividendYield.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - dividendYield.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - dividendYield.~standard.types?: ({ readonly input: unknown; readonly output: number | undefined; }) | undefined; default: not declared - dividendYield.~standard.types.input: unknown; default: not declared - dividendYield.~standard.types.output: number | undefined; default: not declared - dividendYield.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - dividendYield.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - dividendYield.~standard.validate().return.value: number | undefined; default: not declared - dividendYield.~standard.validate(value): unknown; default: not declared - dividendYield.~standard.vendor: string; default: not declared - dividendYield.~standard.version: 1; default: not declared - riskFreeRate: import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number; }; default: not declared — @internal - riskFreeRate._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - riskFreeRate._check().return.ok: (false) | (true); default: not declared - riskFreeRate._check().return.value: number; default: not declared - riskFreeRate._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - riskFreeRate._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - riskFreeRate._check(context).path: (string | number)[]; default: not declared - riskFreeRate._check(input): unknown; default: not declared - riskFreeRate._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - riskFreeRate._toJSONSchema().return.$id?: string; default: not declared - riskFreeRate._toJSONSchema().return.$schema?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.description?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.format?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.title?: string; default: not declared - riskFreeRate._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - riskFreeRate._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate._toJSONSchema().return.const?: unknown; default: not declared - riskFreeRate._toJSONSchema().return.default?: unknown; default: not declared - riskFreeRate._toJSONSchema().return.description?: string; default: not declared - riskFreeRate._toJSONSchema().return.enum?: unknown[]; default: not declared - riskFreeRate._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - riskFreeRate._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - riskFreeRate._toJSONSchema().return.format?: string; default: not declared - riskFreeRate._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate._toJSONSchema().return.maxItems?: number; default: not declared - riskFreeRate._toJSONSchema().return.maxLength?: number; default: not declared - riskFreeRate._toJSONSchema().return.maximum?: number; default: not declared - riskFreeRate._toJSONSchema().return.minItems?: number; default: not declared - riskFreeRate._toJSONSchema().return.minLength?: number; default: not declared - riskFreeRate._toJSONSchema().return.minimum?: number; default: not declared - riskFreeRate._toJSONSchema().return.multipleOf?: number; default: not declared - riskFreeRate._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate._toJSONSchema().return.pattern?: string; default: not declared - riskFreeRate._toJSONSchema().return.properties?: Record; default: not declared - riskFreeRate._toJSONSchema().return.required?: string[]; default: not declared - riskFreeRate._toJSONSchema().return.title?: string; default: not declared - riskFreeRate._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - riskFreeRate.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.describe(description): string; default: not declared - riskFreeRate.description: string | undefined; default: not declared - riskFreeRate.gt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.gt(value): number; default: not declared - riskFreeRate.integer: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.isOptional: boolean; default: not declared - riskFreeRate.kind: 'number'; default: not declared - riskFreeRate.lt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.lt(value): number; default: not declared - riskFreeRate.max: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.max(value): number; default: not declared - riskFreeRate.min: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.min(value): number; default: not declared - riskFreeRate.nonnegative: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - riskFreeRate.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - riskFreeRate.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - riskFreeRate.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - riskFreeRate.optional().return.description: string | undefined; default: not declared - riskFreeRate.optional().return.isOptional: true; default: not declared - riskFreeRate.optional().return.kind: 'optional'; default: not declared - riskFreeRate.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - riskFreeRate.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - riskFreeRate.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - riskFreeRate.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - riskFreeRate.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number; default: not declared - riskFreeRate.parse(input): unknown; default: not declared - riskFreeRate.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - riskFreeRate.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - riskFreeRate.positive: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - riskFreeRate.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - riskFreeRate.safeParse().return.data: number; default: not declared - riskFreeRate.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - riskFreeRate.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - riskFreeRate.safeParse().return.success: (false) | (true); default: not declared - riskFreeRate.safeParse(input): unknown; default: not declared - riskFreeRate.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - riskFreeRate.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - riskFreeRate.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate.toJSONSchema().return.$id?: string; default: not declared - riskFreeRate.toJSONSchema().return.$schema?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.description?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.format?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.title?: string; default: not declared - riskFreeRate.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - riskFreeRate.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate.toJSONSchema().return.const?: unknown; default: not declared - riskFreeRate.toJSONSchema().return.default?: unknown; default: not declared - riskFreeRate.toJSONSchema().return.description?: string; default: not declared - riskFreeRate.toJSONSchema().return.enum?: unknown[]; default: not declared - riskFreeRate.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - riskFreeRate.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - riskFreeRate.toJSONSchema().return.format?: string; default: not declared - riskFreeRate.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - riskFreeRate.toJSONSchema().return.maxItems?: number; default: not declared - riskFreeRate.toJSONSchema().return.maxLength?: number; default: not declared - riskFreeRate.toJSONSchema().return.maximum?: number; default: not declared - riskFreeRate.toJSONSchema().return.minItems?: number; default: not declared - riskFreeRate.toJSONSchema().return.minLength?: number; default: not declared - riskFreeRate.toJSONSchema().return.minimum?: number; default: not declared - riskFreeRate.toJSONSchema().return.multipleOf?: number; default: not declared - riskFreeRate.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - riskFreeRate.toJSONSchema().return.pattern?: string; default: not declared - riskFreeRate.toJSONSchema().return.properties?: Record; default: not declared - riskFreeRate.toJSONSchema().return.required?: string[]; default: not declared - riskFreeRate.toJSONSchema().return.title?: string; default: not declared - riskFreeRate.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - riskFreeRate.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - riskFreeRate.~standard.types?: ({ readonly input: unknown; readonly output: number; }) | undefined; default: not declared - riskFreeRate.~standard.types.input: unknown; default: not declared - riskFreeRate.~standard.types.output: number; default: not declared - riskFreeRate.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - riskFreeRate.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - riskFreeRate.~standard.validate().return.value: number; default: not declared - riskFreeRate.~standard.validate(value): unknown; default: not declared - riskFreeRate.~standard.vendor: string; default: not declared - riskFreeRate.~standard.version: 1; default: not declared - spot: import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number; }; default: not declared — @internal - spot._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - spot._check().return.ok: (false) | (true); default: not declared - spot._check().return.value: number; default: not declared - spot._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - spot._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - spot._check(context).path: (string | number)[]; default: not declared - spot._check(input): unknown; default: not declared - spot._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - spot._toJSONSchema().return.$id?: string; default: not declared - spot._toJSONSchema().return.$schema?: string; default: not declared - spot._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - spot._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - spot._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - spot._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - spot._toJSONSchema().return.additionalProperties.description?: string; default: not declared - spot._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - spot._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.format?: string; default: not declared - spot._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - spot._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - spot._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - spot._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - spot._toJSONSchema().return.additionalProperties.title?: string; default: not declared - spot._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - spot._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot._toJSONSchema().return.const?: unknown; default: not declared - spot._toJSONSchema().return.default?: unknown; default: not declared - spot._toJSONSchema().return.description?: string; default: not declared - spot._toJSONSchema().return.enum?: unknown[]; default: not declared - spot._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - spot._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - spot._toJSONSchema().return.format?: string; default: not declared - spot._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot._toJSONSchema().return.maxItems?: number; default: not declared - spot._toJSONSchema().return.maxLength?: number; default: not declared - spot._toJSONSchema().return.maximum?: number; default: not declared - spot._toJSONSchema().return.minItems?: number; default: not declared - spot._toJSONSchema().return.minLength?: number; default: not declared - spot._toJSONSchema().return.minimum?: number; default: not declared - spot._toJSONSchema().return.multipleOf?: number; default: not declared - spot._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot._toJSONSchema().return.pattern?: string; default: not declared - spot._toJSONSchema().return.properties?: Record; default: not declared - spot._toJSONSchema().return.required?: string[]; default: not declared - spot._toJSONSchema().return.title?: string; default: not declared - spot._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - spot.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.describe(description): string; default: not declared - spot.description: string | undefined; default: not declared - spot.gt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.gt(value): number; default: not declared - spot.integer: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.isOptional: boolean; default: not declared - spot.kind: 'number'; default: not declared - spot.lt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.lt(value): number; default: not declared - spot.max: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.max(value): number; default: not declared - spot.min: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.min(value): number; default: not declared - spot.nonnegative: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - spot.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - spot.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - spot.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - spot.optional().return.description: string | undefined; default: not declared - spot.optional().return.isOptional: true; default: not declared - spot.optional().return.kind: 'optional'; default: not declared - spot.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - spot.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - spot.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - spot.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - spot.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number; default: not declared - spot.parse(input): unknown; default: not declared - spot.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - spot.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - spot.positive: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - spot.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - spot.safeParse().return.data: number; default: not declared - spot.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - spot.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - spot.safeParse().return.success: (false) | (true); default: not declared - spot.safeParse(input): unknown; default: not declared - spot.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - spot.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - spot.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot.toJSONSchema().return.$id?: string; default: not declared - spot.toJSONSchema().return.$schema?: string; default: not declared - spot.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - spot.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - spot.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - spot.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - spot.toJSONSchema().return.additionalProperties.description?: string; default: not declared - spot.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - spot.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.format?: string; default: not declared - spot.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - spot.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - spot.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - spot.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - spot.toJSONSchema().return.additionalProperties.title?: string; default: not declared - spot.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - spot.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot.toJSONSchema().return.const?: unknown; default: not declared - spot.toJSONSchema().return.default?: unknown; default: not declared - spot.toJSONSchema().return.description?: string; default: not declared - spot.toJSONSchema().return.enum?: unknown[]; default: not declared - spot.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - spot.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - spot.toJSONSchema().return.format?: string; default: not declared - spot.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - spot.toJSONSchema().return.maxItems?: number; default: not declared - spot.toJSONSchema().return.maxLength?: number; default: not declared - spot.toJSONSchema().return.maximum?: number; default: not declared - spot.toJSONSchema().return.minItems?: number; default: not declared - spot.toJSONSchema().return.minLength?: number; default: not declared - spot.toJSONSchema().return.minimum?: number; default: not declared - spot.toJSONSchema().return.multipleOf?: number; default: not declared - spot.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - spot.toJSONSchema().return.pattern?: string; default: not declared - spot.toJSONSchema().return.properties?: Record; default: not declared - spot.toJSONSchema().return.required?: string[]; default: not declared - spot.toJSONSchema().return.title?: string; default: not declared - spot.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - spot.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - spot.~standard.types?: ({ readonly input: unknown; readonly output: number; }) | undefined; default: not declared - spot.~standard.types.input: unknown; default: not declared - spot.~standard.types.output: number; default: not declared - spot.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - spot.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - spot.~standard.validate().return.value: number; default: not declared - spot.~standard.validate(value): unknown; default: not declared - spot.~standard.vendor: string; default: not declared - spot.~standard.version: 1; default: not declared - strike: import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number; }; default: not declared — @internal - strike._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - strike._check().return.ok: (false) | (true); default: not declared - strike._check().return.value: number; default: not declared - strike._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - strike._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - strike._check(context).path: (string | number)[]; default: not declared - strike._check(input): unknown; default: not declared - strike._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - strike._toJSONSchema().return.$id?: string; default: not declared - strike._toJSONSchema().return.$schema?: string; default: not declared - strike._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - strike._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - strike._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - strike._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - strike._toJSONSchema().return.additionalProperties.description?: string; default: not declared - strike._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - strike._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.format?: string; default: not declared - strike._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - strike._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - strike._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - strike._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - strike._toJSONSchema().return.additionalProperties.title?: string; default: not declared - strike._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - strike._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike._toJSONSchema().return.const?: unknown; default: not declared - strike._toJSONSchema().return.default?: unknown; default: not declared - strike._toJSONSchema().return.description?: string; default: not declared - strike._toJSONSchema().return.enum?: unknown[]; default: not declared - strike._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - strike._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - strike._toJSONSchema().return.format?: string; default: not declared - strike._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike._toJSONSchema().return.maxItems?: number; default: not declared - strike._toJSONSchema().return.maxLength?: number; default: not declared - strike._toJSONSchema().return.maximum?: number; default: not declared - strike._toJSONSchema().return.minItems?: number; default: not declared - strike._toJSONSchema().return.minLength?: number; default: not declared - strike._toJSONSchema().return.minimum?: number; default: not declared - strike._toJSONSchema().return.multipleOf?: number; default: not declared - strike._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike._toJSONSchema().return.pattern?: string; default: not declared - strike._toJSONSchema().return.properties?: Record; default: not declared - strike._toJSONSchema().return.required?: string[]; default: not declared - strike._toJSONSchema().return.title?: string; default: not declared - strike._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - strike.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.describe(description): string; default: not declared - strike.description: string | undefined; default: not declared - strike.gt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.gt(value): number; default: not declared - strike.integer: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.isOptional: boolean; default: not declared - strike.kind: 'number'; default: not declared - strike.lt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.lt(value): number; default: not declared - strike.max: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.max(value): number; default: not declared - strike.min: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.min(value): number; default: not declared - strike.nonnegative: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - strike.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - strike.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - strike.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - strike.optional().return.description: string | undefined; default: not declared - strike.optional().return.isOptional: true; default: not declared - strike.optional().return.kind: 'optional'; default: not declared - strike.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - strike.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - strike.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - strike.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - strike.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number; default: not declared - strike.parse(input): unknown; default: not declared - strike.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - strike.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - strike.positive: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - strike.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - strike.safeParse().return.data: number; default: not declared - strike.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - strike.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - strike.safeParse().return.success: (false) | (true); default: not declared - strike.safeParse(input): unknown; default: not declared - strike.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - strike.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - strike.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike.toJSONSchema().return.$id?: string; default: not declared - strike.toJSONSchema().return.$schema?: string; default: not declared - strike.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - strike.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - strike.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - strike.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - strike.toJSONSchema().return.additionalProperties.description?: string; default: not declared - strike.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - strike.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.format?: string; default: not declared - strike.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - strike.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - strike.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - strike.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - strike.toJSONSchema().return.additionalProperties.title?: string; default: not declared - strike.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - strike.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike.toJSONSchema().return.const?: unknown; default: not declared - strike.toJSONSchema().return.default?: unknown; default: not declared - strike.toJSONSchema().return.description?: string; default: not declared - strike.toJSONSchema().return.enum?: unknown[]; default: not declared - strike.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - strike.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - strike.toJSONSchema().return.format?: string; default: not declared - strike.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - strike.toJSONSchema().return.maxItems?: number; default: not declared - strike.toJSONSchema().return.maxLength?: number; default: not declared - strike.toJSONSchema().return.maximum?: number; default: not declared - strike.toJSONSchema().return.minItems?: number; default: not declared - strike.toJSONSchema().return.minLength?: number; default: not declared - strike.toJSONSchema().return.minimum?: number; default: not declared - strike.toJSONSchema().return.multipleOf?: number; default: not declared - strike.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - strike.toJSONSchema().return.pattern?: string; default: not declared - strike.toJSONSchema().return.properties?: Record; default: not declared - strike.toJSONSchema().return.required?: string[]; default: not declared - strike.toJSONSchema().return.title?: string; default: not declared - strike.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - strike.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - strike.~standard.types?: ({ readonly input: unknown; readonly output: number; }) | undefined; default: not declared - strike.~standard.types.input: unknown; default: not declared - strike.~standard.types.output: number; default: not declared - strike.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - strike.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - strike.~standard.validate().return.value: number; default: not declared - strike.~standard.validate(value): unknown; default: not declared - strike.~standard.vendor: string; default: not declared - strike.~standard.version: 1; default: not declared - timeToExpiryYears: import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number; }; default: not declared — @internal - timeToExpiryYears._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - timeToExpiryYears._check().return.ok: (false) | (true); default: not declared - timeToExpiryYears._check().return.value: number; default: not declared - timeToExpiryYears._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - timeToExpiryYears._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - timeToExpiryYears._check(context).path: (string | number)[]; default: not declared - timeToExpiryYears._check(input): unknown; default: not declared - timeToExpiryYears._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - timeToExpiryYears._toJSONSchema().return.$id?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.$schema?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.description?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.format?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.title?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - timeToExpiryYears._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears._toJSONSchema().return.const?: unknown; default: not declared - timeToExpiryYears._toJSONSchema().return.default?: unknown; default: not declared - timeToExpiryYears._toJSONSchema().return.description?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.enum?: unknown[]; default: not declared - timeToExpiryYears._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.format?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears._toJSONSchema().return.maxItems?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.maxLength?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.maximum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.minItems?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.minLength?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.minimum?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.multipleOf?: number; default: not declared - timeToExpiryYears._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears._toJSONSchema().return.pattern?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.properties?: Record; default: not declared - timeToExpiryYears._toJSONSchema().return.required?: string[]; default: not declared - timeToExpiryYears._toJSONSchema().return.title?: string; default: not declared - timeToExpiryYears._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - timeToExpiryYears.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.describe(description): string; default: not declared - timeToExpiryYears.description: string | undefined; default: not declared - timeToExpiryYears.gt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.gt(value): number; default: not declared - timeToExpiryYears.integer: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.isOptional: boolean; default: not declared - timeToExpiryYears.kind: 'number'; default: not declared - timeToExpiryYears.lt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.lt(value): number; default: not declared - timeToExpiryYears.max: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.max(value): number; default: not declared - timeToExpiryYears.min: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.min(value): number; default: not declared - timeToExpiryYears.nonnegative: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - timeToExpiryYears.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - timeToExpiryYears.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - timeToExpiryYears.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - timeToExpiryYears.optional().return.description: string | undefined; default: not declared - timeToExpiryYears.optional().return.isOptional: true; default: not declared - timeToExpiryYears.optional().return.kind: 'optional'; default: not declared - timeToExpiryYears.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - timeToExpiryYears.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - timeToExpiryYears.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - timeToExpiryYears.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - timeToExpiryYears.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number; default: not declared - timeToExpiryYears.parse(input): unknown; default: not declared - timeToExpiryYears.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - timeToExpiryYears.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - timeToExpiryYears.positive: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - timeToExpiryYears.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - timeToExpiryYears.safeParse().return.data: number; default: not declared - timeToExpiryYears.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - timeToExpiryYears.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - timeToExpiryYears.safeParse().return.success: (false) | (true); default: not declared - timeToExpiryYears.safeParse(input): unknown; default: not declared - timeToExpiryYears.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - timeToExpiryYears.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - timeToExpiryYears.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears.toJSONSchema().return.$id?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.$schema?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.description?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.format?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.title?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - timeToExpiryYears.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears.toJSONSchema().return.const?: unknown; default: not declared - timeToExpiryYears.toJSONSchema().return.default?: unknown; default: not declared - timeToExpiryYears.toJSONSchema().return.description?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.enum?: unknown[]; default: not declared - timeToExpiryYears.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.format?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - timeToExpiryYears.toJSONSchema().return.maxItems?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.maxLength?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.maximum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.minItems?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.minLength?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.minimum?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.multipleOf?: number; default: not declared - timeToExpiryYears.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - timeToExpiryYears.toJSONSchema().return.pattern?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.properties?: Record; default: not declared - timeToExpiryYears.toJSONSchema().return.required?: string[]; default: not declared - timeToExpiryYears.toJSONSchema().return.title?: string; default: not declared - timeToExpiryYears.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - timeToExpiryYears.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - timeToExpiryYears.~standard.types?: ({ readonly input: unknown; readonly output: number; }) | undefined; default: not declared - timeToExpiryYears.~standard.types.input: unknown; default: not declared - timeToExpiryYears.~standard.types.output: number; default: not declared - timeToExpiryYears.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - timeToExpiryYears.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - timeToExpiryYears.~standard.validate().return.value: number; default: not declared - timeToExpiryYears.~standard.validate(value): unknown; default: not declared - timeToExpiryYears.~standard.vendor: string; default: not declared - timeToExpiryYears.~standard.version: 1; default: not declared - volatility: import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number; }; default: not declared — @internal - volatility._check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - volatility._check().return.ok: (false) | (true); default: not declared - volatility._check().return.value: number; default: not declared - volatility._check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - volatility._check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - volatility._check(context).path: (string | number)[]; default: not declared - volatility._check(input): unknown; default: not declared - volatility._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - volatility._toJSONSchema().return.$id?: string; default: not declared - volatility._toJSONSchema().return.$schema?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility._toJSONSchema().return.additionalProperties.$id?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility._toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility._toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility._toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - volatility._toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - volatility._toJSONSchema().return.additionalProperties.description?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - volatility._toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.format?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility._toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - volatility._toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility._toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - volatility._toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - volatility._toJSONSchema().return.additionalProperties.title?: string; default: not declared - volatility._toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - volatility._toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility._toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility._toJSONSchema().return.const?: unknown; default: not declared - volatility._toJSONSchema().return.default?: unknown; default: not declared - volatility._toJSONSchema().return.description?: string; default: not declared - volatility._toJSONSchema().return.enum?: unknown[]; default: not declared - volatility._toJSONSchema().return.exclusiveMaximum?: number; default: not declared - volatility._toJSONSchema().return.exclusiveMinimum?: number; default: not declared - volatility._toJSONSchema().return.format?: string; default: not declared - volatility._toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility._toJSONSchema().return.maxItems?: number; default: not declared - volatility._toJSONSchema().return.maxLength?: number; default: not declared - volatility._toJSONSchema().return.maximum?: number; default: not declared - volatility._toJSONSchema().return.minItems?: number; default: not declared - volatility._toJSONSchema().return.minLength?: number; default: not declared - volatility._toJSONSchema().return.minimum?: number; default: not declared - volatility._toJSONSchema().return.multipleOf?: number; default: not declared - volatility._toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility._toJSONSchema().return.pattern?: string; default: not declared - volatility._toJSONSchema().return.properties?: Record; default: not declared - volatility._toJSONSchema().return.required?: string[]; default: not declared - volatility._toJSONSchema().return.title?: string; default: not declared - volatility._toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - volatility.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.describe(description): string; default: not declared - volatility.description: string | undefined; default: not declared - volatility.gt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.gt(value): number; default: not declared - volatility.integer: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.isOptional: boolean; default: not declared - volatility.kind: 'number'; default: not declared - volatility.lt: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.lt(value): number; default: not declared - volatility.max: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.max(value): number; default: not declared - volatility.min: (value: number) => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.min(value): number; default: not declared - volatility.nonnegative: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - volatility.optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: number | undefined; }; default: not declared — @internal - volatility.optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - volatility.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - volatility.optional().return.description: string | undefined; default: not declared - volatility.optional().return.isOptional: true; default: not declared - volatility.optional().return.kind: 'optional'; default: not declared - volatility.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema; default: not declared - volatility.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number | undefined; default: not declared - volatility.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - volatility.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - volatility.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => number; default: not declared - volatility.parse(input): unknown; default: not declared - volatility.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - volatility.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - volatility.positive: () => import('@insiderfinance/totalfinance/core/schema').NumberSchema; default: not declared - volatility.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - volatility.safeParse().return.data: number; default: not declared - volatility.safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - volatility.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - volatility.safeParse().return.success: (false) | (true); default: not declared - volatility.safeParse(input): unknown; default: not declared - volatility.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - volatility.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - volatility.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility.toJSONSchema().return.$id?: string; default: not declared - volatility.toJSONSchema().return.$schema?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - volatility.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - volatility.toJSONSchema().return.additionalProperties.description?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - volatility.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.format?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - volatility.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - volatility.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - volatility.toJSONSchema().return.additionalProperties.title?: string; default: not declared - volatility.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - volatility.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility.toJSONSchema().return.const?: unknown; default: not declared - volatility.toJSONSchema().return.default?: unknown; default: not declared - volatility.toJSONSchema().return.description?: string; default: not declared - volatility.toJSONSchema().return.enum?: unknown[]; default: not declared - volatility.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - volatility.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - volatility.toJSONSchema().return.format?: string; default: not declared - volatility.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - volatility.toJSONSchema().return.maxItems?: number; default: not declared - volatility.toJSONSchema().return.maxLength?: number; default: not declared - volatility.toJSONSchema().return.maximum?: number; default: not declared - volatility.toJSONSchema().return.minItems?: number; default: not declared - volatility.toJSONSchema().return.minLength?: number; default: not declared - volatility.toJSONSchema().return.minimum?: number; default: not declared - volatility.toJSONSchema().return.multipleOf?: number; default: not declared - volatility.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - volatility.toJSONSchema().return.pattern?: string; default: not declared - volatility.toJSONSchema().return.properties?: Record; default: not declared - volatility.toJSONSchema().return.required?: string[]; default: not declared - volatility.toJSONSchema().return.title?: string; default: not declared - volatility.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - volatility.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - volatility.~standard.types?: ({ readonly input: unknown; readonly output: number; }) | undefined; default: not declared - volatility.~standard.types.input: unknown; default: not declared - volatility.~standard.types.output: number; default: not declared - volatility.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - volatility.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - volatility.~standard.validate().return.value: number; default: not declared - volatility.~standard.validate(value): unknown; default: not declared - volatility.~standard.vendor: string; default: not declared - volatility.~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/options/schema#optionType Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `call | put` option-type enum, shared by every typed option schema. ```typescript export declare const optionType: import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - _check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: 'call' | 'put'; }; default: not declared — @internal - _check().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - _check().return.ok: (false) | (true); default: not declared - _check().return.value: 'call' | 'put'; default: not declared - _check(context): import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext; default: not declared - _check(context).mode: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared - _check(context).path: (string | number)[]; default: not declared - _check(input): unknown; default: not declared - _toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - _toJSONSchema().return.$id?: string; default: not declared - _toJSONSchema().return.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.$id?: string; default: not declared - _toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - _toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - _toJSONSchema().return.additionalProperties.description?: string; default: not declared - _toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.format?: string; default: not declared - _toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - _toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - _toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - _toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - _toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - _toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - _toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - _toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - _toJSONSchema().return.additionalProperties.title?: string; default: not declared - _toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - _toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.const?: unknown; default: not declared - _toJSONSchema().return.default?: unknown; default: not declared - _toJSONSchema().return.description?: string; default: not declared - _toJSONSchema().return.enum?: unknown[]; default: not declared - _toJSONSchema().return.exclusiveMaximum?: number; default: not declared - _toJSONSchema().return.exclusiveMinimum?: number; default: not declared - _toJSONSchema().return.format?: string; default: not declared - _toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - _toJSONSchema().return.maxItems?: number; default: not declared - _toJSONSchema().return.maxLength?: number; default: not declared - _toJSONSchema().return.maximum?: number; default: not declared - _toJSONSchema().return.minItems?: number; default: not declared - _toJSONSchema().return.minLength?: number; default: not declared - _toJSONSchema().return.minimum?: number; default: not declared - _toJSONSchema().return.multipleOf?: number; default: not declared - _toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - _toJSONSchema().return.pattern?: string; default: not declared - _toJSONSchema().return.properties?: Record; default: not declared - _toJSONSchema().return.required?: string[]; default: not declared - _toJSONSchema().return.title?: string; default: not declared - _toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').EnumSchema<'call' | 'put'>; default: not declared - describe(description): string; default: not declared - description: string | undefined; default: not declared - isOptional: boolean; default: not declared - kind: 'enum'; default: not declared - optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'call' | 'put'>; default: not declared - optional().return._check: (input: unknown, context: import('@insiderfinance/totalfinance/core/schema').SchemaCheckContext) => { issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; ok: false; } | { ok: true; value: 'call' | 'put' | undefined; }; default: not declared — @internal - optional().return._toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared — @internal - optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'call' | 'put'>; default: not declared - optional().return.description: string | undefined; default: not declared - optional().return.isOptional: true; default: not declared - optional().return.kind: 'optional'; default: not declared - optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').OptionalSchema<'call' | 'put' | undefined>; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => 'call' | 'put' | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<'call' | 'put' | undefined>; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => 'call' | 'put'; default: not declared - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<'call' | 'put'>; default: not declared - safeParse().return.data: 'call' | 'put'; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: 'call' | 'put'; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: 'call' | 'put'; default: not declared - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<'call' | 'put'>; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: 'call' | 'put'; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/options/schema#schemas Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#schemas`. ## Entrypoint @insiderfinance/totalfinance/performance ### @insiderfinance/totalfinance/performance#AccountFlowSegment Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-account external-flow totals. `accountId` is `'unassigned'` for flows without one. ```typescript // --------------------------------------------------------------------------------------------------- // segmentExternalFlows // --------------------------------------------------------------------------------------------------- /** Per-account external-flow totals. `accountId` is `'unassigned'` for flows without one. */ export interface AccountFlowSegment { accountId: string; /** Sum of positive external amounts (≥ 0). */ deposits: number; /** Sum of negative external amounts (≤ 0, kept signed so `net = deposits + withdrawals`). */ withdrawals: number; net: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - deposits: number; default: not declared — Sum of positive external amounts (≥ 0). - net: number; default: not declared - withdrawals: number; default: not declared — Sum of negative external amounts (≤ 0, kept signed so `net = deposits + withdrawals`). ### @insiderfinance/totalfinance/performance#AnalyzeInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link analyze}: an explicit `equity` curve (growth of capital) **or** a per-period `returns` series — a tagged union so the caller can never silently confuse the two (WS3.3b). ```typescript /** * Input for {@link analyze}: an explicit `equity` curve (growth of capital) **or** a per-period * `returns` series — a tagged union so the caller can never silently confuse the two (WS3.3b). */ export type AnalyzeInput = { equity: ArrayLike; } | { returns: ArrayLike; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - equity: ArrayLike; default: not declared - returns: ArrayLike; default: not declared ### @insiderfinance/totalfinance/performance#AnalyzeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AnalyzeOptions { /** Annualization factor. Defaults to 252 (daily); echoed in the summary's `assumptions`. */ periodsPerYear?: number; riskFreeRate?: number; /** * Per-period benchmark **return** series aligned to the equity curve's returns (length = * `equity.length − 1`). When supplied, the summary adds beta, alpha, tracking error, information * ratio, and the Treynor ratio. */ benchmark?: ArrayLike; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - benchmark?: ArrayLike; default: not declared — Per-period benchmark **return** series aligned to the equity curve's returns (length = `equity.length − 1`). When supplied, the summary adds beta, alpha, tracking error, information ratio, and the Treynor ratio. - periodsPerYear?: number; default: not declared — Annualization factor. Defaults to 252 (daily); echoed in the summary's `assumptions`. - riskFreeRate?: number; default: not declared ### @insiderfinance/totalfinance/performance#AnnualizationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AnnualizationOptions { /** Periods per year for annualization. Defaults to 252 (daily); pass 12 monthly, 52 weekly. */ periodsPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear?: number; default: not declared — Periods per year for annualization. Defaults to 252 (daily); pass 12 monthly, 52 weekly. ### @insiderfinance/totalfinance/performance#AnnualizationPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The explicit annualization policy: `'none'` or a declared day-count basis. ```typescript /** The explicit annualization policy: `'none'` or a declared day-count basis. */ export type AnnualizationPolicy = 'none' | { basis: 'ACT/365F'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - basis: 'ACT/365F'; default: not declared ### @insiderfinance/totalfinance/performance#BenchmarkRelativeRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One aligned relative-performance row. ```typescript /** One aligned relative-performance row. */ export interface BenchmarkRelativeRow { date: string; /** Portfolio index level relative to the anchor level, minus one. */ portfolioCumulativeReturn: number; /** Compounded benchmark returns from just after the anchor through this date, minus one. */ benchmarkCumulativeReturn: number; /** Geometric excess: `(1 + portfolioCumulative) / (1 + benchmarkCumulative) − 1`. */ relativePerformance: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - benchmarkCumulativeReturn: number; default: not declared — Compounded benchmark returns from just after the anchor through this date, minus one. - date: string; default: not declared - portfolioCumulativeReturn: number; default: not declared — Portfolio index level relative to the anchor level, minus one. - relativePerformance: number; default: not declared — Geometric excess: `(1 + portfolioCumulative) / (1 + benchmarkCumulative) − 1`. ### @insiderfinance/totalfinance/performance#BenchmarkRelativeTimelineInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link benchmarkRelativeTimeline}. ```typescript /** Input for {@link benchmarkRelativeTimeline}. */ export interface BenchmarkRelativeTimelineInput { portfolioIndex: readonly ReturnIndexPoint[]; benchmarkReturns: readonly BenchmarkReturnObservation[]; /** REQUIRED — a benchmark states its basis; price-return omits dividend/income return. */ benchmarkBasis: 'total-return' | 'price-return'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - benchmarkBasis: 'total-return' | 'price-return'; default: not declared — REQUIRED — a benchmark states its basis; price-return omits dividend/income return. - benchmarkReturns: readonly BenchmarkReturnObservation[]; default: not declared - portfolioIndex: readonly ReturnIndexPoint[]; default: not declared ### @insiderfinance/totalfinance/performance#BenchmarkRelativeTimelineResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link benchmarkRelativeTimeline}. ```typescript /** Result of {@link benchmarkRelativeTimeline}. */ export interface BenchmarkRelativeTimelineResult { rows: BenchmarkRelativeRow[]; assumptions: { benchmarkBasis: 'total-return' | 'price-return'; relativeMethod: string; anchorDate: string; benchmarkReturnConvention: string; }; diagnostics: { warnings: string[]; gaps: PerformanceGap[]; rowCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { anchorDate: string; benchmarkBasis: 'total-return' | 'price-return'; benchmarkReturnConvention: string; relativeMethod: string; }; default: not declared - assumptions.anchorDate: string; default: not declared - assumptions.benchmarkBasis: 'total-return' | 'price-return'; default: not declared - assumptions.benchmarkReturnConvention: string; default: not declared - assumptions.relativeMethod: string; default: not declared - diagnostics: { gaps: PerformanceGap[]; rowCount: number; warnings: string[]; }; default: not declared - diagnostics.gaps: PerformanceGap[]; default: not declared - diagnostics.rowCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - rows: BenchmarkRelativeRow[]; default: not declared ### @insiderfinance/totalfinance/performance#BenchmarkReturnObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One benchmark observation: the simple return of the period ENDING on `date`. ```typescript // --------------------------------------------------------------------------------------------------- // benchmarkRelativeTimeline // --------------------------------------------------------------------------------------------------- /** One benchmark observation: the simple return of the period ENDING on `date`. */ export interface BenchmarkReturnObservation { date: string; simpleReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared - simpleReturn: number; default: not declared ### @insiderfinance/totalfinance/performance#ContributionByGroupInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link contributionByGroup}. ```typescript /** Input for {@link contributionByGroup}. */ export interface ContributionByGroupInput { /** ONE period's per-group weights and returns (position/account/strategy/asset class/…). */ groupReturns: readonly GroupReturn[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - groupReturns: readonly GroupReturn[]; default: not declared — ONE period's per-group weights and returns (position/account/strategy/asset class/…). ### @insiderfinance/totalfinance/performance#ContributionByGroupResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link contributionByGroup}. ```typescript /** Result of {@link contributionByGroup}. */ export interface ContributionByGroupResult { contributions: GroupContribution[]; /** The weighted total return `Σ weightᵢ · simpleReturnᵢ` the contributions reconcile to. */ totalReturn: number; assumptions: { formula: string; scope: 'single-period'; }; diagnostics: { warnings: string[]; groupCount: number; weightSum: number; /** `totalReturn − Σ contributionᵢ` — identically 0 at single-period scope (the linking-residual law). */ reconciliationResidual: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { formula: string; scope: 'single-period'; }; default: not declared - assumptions.formula: string; default: not declared - assumptions.scope: 'single-period'; default: not declared - contributions: GroupContribution[]; default: not declared - diagnostics: { groupCount: number; reconciliationResidual: number; warnings: string[]; weightSum: number; }; default: not declared - diagnostics.groupCount: number; default: not declared - diagnostics.reconciliationResidual: number; default: not declared — `totalReturn − Σ contributionᵢ` — identically 0 at single-period scope (the linking-residual law). - diagnostics.warnings: string[]; default: not declared - diagnostics.weightSum: number; default: not declared - totalReturn: number; default: not declared — The weighted total return `Σ weightᵢ · simpleReturnᵢ` the contributions reconcile to. ### @insiderfinance/totalfinance/performance#DrawdownResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DrawdownResult { /** Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). */ maxDrawdown: number; /** Index of the peak preceding the worst drawdown. */ peakIndex: number; /** Index of the trough of the worst drawdown. */ troughIndex: number; /** Longest underwater stretch, in periods. */ longestDurationPeriods: number; /** * Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). * Absent when the curve never recovered by the end of the series (still underwater). */ recoveryIndex?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - troughIndex: number; default: not declared — Index of the trough of the worst drawdown. ### @insiderfinance/totalfinance/performance#ExposureResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExposureResult { /** Fraction of periods with any non-zero net position (`Σ_i w ≠ 0`). */ timeInMarket: number | null; /** Average gross exposure `mean_t( Σ_i |w_{t,i}| )`. */ averageGross: number | null; /** Average net exposure `mean_t( Σ_i w_{t,i} )`. */ averageNet: number | null; /** Average long exposure `mean_t( Σ_i max(w_{t,i}, 0) )`. */ averageLong: number | null; /** Average short exposure as a positive number `mean_t( Σ_i max(−w_{t,i}, 0) )`. */ averageShort: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageGross: number | null; default: not declared — Average gross exposure `mean_t( Σ_i |w_{t,i}| )`. - averageLong: number | null; default: not declared — Average long exposure `mean_t( Σ_i max(w_{t,i}, 0) )`. - averageNet: number | null; default: not declared — Average net exposure `mean_t( Σ_i w_{t,i} )`. - averageShort: number | null; default: not declared — Average short exposure as a positive number `mean_t( Σ_i max(−w_{t,i}, 0) )`. - timeInMarket: number | null; default: not declared — Fraction of periods with any non-zero net position (`Σ_i w ≠ 0`). ### @insiderfinance/totalfinance/performance#ExternalCashFlow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One EXTERNAL cash flow: money crossing the portfolio boundary, never profit or loss. ```typescript /** One EXTERNAL cash flow: money crossing the portfolio boundary, never profit or loss. */ export interface ExternalCashFlow { /** Strict `YYYY-MM-DD` calendar date. */ cashFlowDate: string; /** Positive = deposit INTO the portfolio, negative = withdrawal FROM it. */ amount: number; label?: string; /** The account the flow touched — required on both legs for internal-transfer detection. */ accountId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId?: string; default: not declared — The account the flow touched — required on both legs for internal-transfer detection. - amount: number; default: not declared — Positive = deposit INTO the portfolio, negative = withdrawal FROM it. - cashFlowDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date. - label?: string; default: not declared ### @insiderfinance/totalfinance/performance#GroupContribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One group's contribution row. ```typescript /** One group's contribution row. */ export interface GroupContribution { groupLabel: string; weight: number; simpleReturn: number; /** `weight × simpleReturn`. */ contribution: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contribution: number; default: not declared — `weight × simpleReturn`. - groupLabel: string; default: not declared - simpleReturn: number; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/performance#GroupReturn Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One group's weight and simple return over ONE period. ```typescript // --------------------------------------------------------------------------------------------------- // contributionByGroup // --------------------------------------------------------------------------------------------------- /** One group's weight and simple return over ONE period. */ export interface GroupReturn { groupLabel: string; /** The group's weight of the portfolio over the period (may be negative or exceed 1). */ weight: number; simpleReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - groupLabel: string; default: not declared - simpleReturn: number; default: not declared - weight: number; default: not declared — The group's weight of the portfolio over the period (may be negative or exceed 1). ### @insiderfinance/totalfinance/performance#InternalTransfer Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One identified transfer between two accounts of the SAME portfolio — internal, not external. ```typescript /** One identified transfer between two accounts of the SAME portfolio — internal, not external. */ export interface InternalTransfer { cashFlowDate: string; /** The positive magnitude moved. */ amount: number; fromAccountId: string; toAccountId: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — The positive magnitude moved. - cashFlowDate: string; default: not declared - fromAccountId: string; default: not declared - toAccountId: string; default: not declared ### @insiderfinance/totalfinance/performance#LinkSubperiodReturnsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link linkSubperiodReturns}. ```typescript // --------------------------------------------------------------------------------------------------- // linkSubperiodReturns // --------------------------------------------------------------------------------------------------- /** Input for {@link linkSubperiodReturns}. */ export interface LinkSubperiodReturnsInput { subperiodReturns: readonly number[]; /** REQUIRED and explicit — linking is a policy, never a guess. */ linking: 'geometric' | 'arithmetic'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - linking: 'geometric' | 'arithmetic'; default: not declared — REQUIRED and explicit — linking is a policy, never a guess. - subperiodReturns: readonly number[]; default: not declared ### @insiderfinance/totalfinance/performance#LinkSubperiodReturnsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link linkSubperiodReturns}. ```typescript /** Result of {@link linkSubperiodReturns}. */ export interface LinkSubperiodReturnsResult { linkedReturn: number; assumptions: { linking: 'geometric' | 'arithmetic'; formula: string; }; diagnostics: { warnings: string[]; subperiodCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { formula: string; linking: 'geometric' | 'arithmetic'; }; default: not declared - assumptions.formula: string; default: not declared - assumptions.linking: 'geometric' | 'arithmetic'; default: not declared - diagnostics: { subperiodCount: number; warnings: string[]; }; default: not declared - diagnostics.subperiodCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - linkedReturn: number; default: not declared ### @insiderfinance/totalfinance/performance#ModifiedDietzFlowWeight Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One flow with the day-weight Modified Dietz applied to it. ```typescript // --------------------------------------------------------------------------------------------------- // modifiedDietzReturn // --------------------------------------------------------------------------------------------------- /** One flow with the day-weight Modified Dietz applied to it. */ export interface ModifiedDietzFlowWeight { cashFlowDate: string; amount: number; /** `(daysInPeriod − daysSinceStart) / daysInPeriod` — 1 on the start date, 0 on the end date. */ weight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - cashFlowDate: string; default: not declared - weight: number; default: not declared — `(daysInPeriod − daysSinceStart) / daysInPeriod` — 1 on the start date, 0 on the end date. ### @insiderfinance/totalfinance/performance#ModifiedDietzReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link modifiedDietzReturn}. ```typescript /** Input for {@link modifiedDietzReturn}. */ export interface ModifiedDietzReturnInput { /** EXACTLY the two period endpoints: the start and end valuations. */ valuations: readonly PortfolioValuation[]; externalCashFlows: readonly ExternalCashFlow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - externalCashFlows: readonly ExternalCashFlow[]; default: not declared - valuations: readonly PortfolioValuation[]; default: not declared — EXACTLY the two period endpoints: the start and end valuations. ### @insiderfinance/totalfinance/performance#ModifiedDietzReturnResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link modifiedDietzReturn}. ```typescript /** Result of {@link modifiedDietzReturn}. */ export interface ModifiedDietzReturnResult { /** `null` (with `reason`) when the average-capital denominator is not positive. */ modifiedDietzReturn: number | null; /** Present exactly when `modifiedDietzReturn` is `null`. */ reason?: string; /** The exact weight applied to each flow — exposed, never hidden. */ flowWeights: ModifiedDietzFlowWeight[]; assumptions: { weightFormula: string; dayCount: 'ACT (actual calendar days)'; }; diagnostics: { warnings: string[]; flowCount: number; daysInPeriod: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { dayCount: 'ACT (actual calendar days)'; weightFormula: string; }; default: not declared - assumptions.dayCount: 'ACT (actual calendar days)'; default: not declared - assumptions.weightFormula: string; default: not declared - diagnostics: { daysInPeriod: number; flowCount: number; warnings: string[]; }; default: not declared - diagnostics.daysInPeriod: number; default: not declared - diagnostics.flowCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - flowWeights: ModifiedDietzFlowWeight[]; default: not declared — The exact weight applied to each flow — exposed, never hidden. - modifiedDietzReturn: number | null; default: not declared — `null` (with `reason`) when the average-capital denominator is not positive. - reason?: string; default: not declared — Present exactly when `modifiedDietzReturn` is `null`. ### @insiderfinance/totalfinance/performance#MoneyWeightedReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link moneyWeightedReturn}. ```typescript // --------------------------------------------------------------------------------------------------- // moneyWeightedReturn // --------------------------------------------------------------------------------------------------- /** Input for {@link moneyWeightedReturn}. */ export interface MoneyWeightedReturnInput { /** First and last valuations REQUIRED — they anchor the schedule. Interior marks do not enter. */ valuations: readonly PortfolioValuation[]; externalCashFlows: readonly ExternalCashFlow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - externalCashFlows: readonly ExternalCashFlow[]; default: not declared - valuations: readonly PortfolioValuation[]; default: not declared — First and last valuations REQUIRED — they anchor the schedule. Interior marks do not enter. ### @insiderfinance/totalfinance/performance#MoneyWeightedReturnResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link moneyWeightedReturn}. ```typescript /** Result of {@link moneyWeightedReturn}. */ export interface MoneyWeightedReturnResult { /** The dated internal rate of return of the investor schedule; `null` on no root or ambiguity. */ moneyWeightedReturn: number | null; /** Present exactly when `moneyWeightedReturn` is `null` — why the solver withheld a value. */ reason?: string; /** The FC1 solver's full `.explain()` report: roots, convergence, and warnings ride along. */ solverReport: InternalRateOfReturnReport; assumptions: { signConvention: string; /** The first valuation date — the solver's valuation instant. */ asOf: string; }; diagnostics: { warnings: string[]; scheduleRowCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: string; signConvention: string; }; default: not declared - assumptions.asOf: string; default: not declared — The first valuation date — the solver's valuation instant. - assumptions.signConvention: string; default: not declared - diagnostics: { scheduleRowCount: number; warnings: string[]; }; default: not declared - diagnostics.scheduleRowCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - moneyWeightedReturn: number | null; default: not declared — The dated internal rate of return of the investor schedule; `null` on no root or ambiguity. - reason?: string; default: not declared — Present exactly when `moneyWeightedReturn` is `null` — why the solver withheld a value. - solverReport: InternalRateOfReturnReport; default: not declared — The FC1 solver's full `.explain()` report: roots, convergence, and warnings ride along. - solverReport.assumptions: { asOf?: string; compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; conventionsVersion: string; dayCount?: import('@insiderfinance/totalfinance/core').DayCount; searchRange: { from: number; to: number; }; }; default: not declared - solverReport.assumptions.asOf?: string; default: not declared — Present only on the dated head. - solverReport.assumptions.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - solverReport.assumptions.compounding.periodsPerYear: number; default: not declared - solverReport.assumptions.compounding.type: 'periodic'; default: not declared - solverReport.assumptions.conventionsVersion: string; default: not declared - solverReport.assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Present only on the dated head. - solverReport.assumptions.searchRange: { from: number; to: number; }; default: not declared - solverReport.assumptions.searchRange.from: number; default: not declared - solverReport.assumptions.searchRange.to: number; default: not declared - solverReport.diagnostics: { converged: boolean; iterations: number; method: 'scan-bisect'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - solverReport.diagnostics.converged: boolean; default: not declared - solverReport.diagnostics.iterations: number; default: not declared - solverReport.diagnostics.method: 'scan-bisect'; default: not declared - solverReport.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - solverReport.roots: import('@insiderfinance/totalfinance/valuation').InternalRateRoot[]; default: not declared — EVERY economically admissible root found in the search range. - solverReport.value: number | null; default: not declared — The plain call's answer: the single root, or null when none or many. ### @insiderfinance/totalfinance/performance#PerformanceGap Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One excluded date range with the reason it was excluded — never forward-filled. ```typescript /** One excluded date range with the reason it was excluded — never forward-filled. */ export interface PerformanceGap { fromDate: string; toDate: string; reason: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromDate: string; default: not declared - reason: string; default: not declared - toDate: string; default: not declared ### @insiderfinance/totalfinance/performance#PerformanceSummary Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PerformanceSummary { periods: number; /** `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). */ totalReturn: number | null; /** `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). */ annualizedReturn: number | null; annualizedVolatility: number | null; /** `null` when the metric is undefined for this input (disclosed via warnings). */ sharpe: number | null; /** `null` when the metric is undefined for this input (disclosed via warnings). */ sortino: number | null; /** `null` when the metric is undefined for this input (disclosed via warnings). */ calmar: number | null; maxDrawdown: number; drawdown: DrawdownResult; /** Omega ratio at a 0 per-period threshold. */ /** `null` when the metric is undefined for this input (disclosed via warnings). */ omega: number | null; /** Fraction of non-zero return periods that were positive. */ /** `null` when the metric is undefined for this input (disclosed via warnings). */ hitRate: number | null; /** Gross gains ÷ gross losses across the return series. */ /** `null` when the metric is undefined for this input (disclosed via warnings). */ profitFactor: number | null; /** Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). */ expectancy: number | null; /** Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. */ warnings: QuantWarning[]; /** Beta to the benchmark (only when `options.benchmark` is supplied). */ beta?: number | null; /** Annualized Jensen's alpha (only when `options.benchmark` is supplied). */ alpha?: number | null; /** Annualized tracking error (only when `options.benchmark` is supplied). */ trackingError?: number | null; /** Information ratio (only when `options.benchmark` is supplied). */ informationRatio?: number | null; /** Treynor ratio (only when `options.benchmark` is supplied). */ treynor?: number | null; /** The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). */ assumptions: { /** Annualization factor used for all annualized metrics. */ periodsPerYear: number; /** Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). */ riskFreeRate: number; /** Length of the benchmark return series, present only when a benchmark was supplied. */ benchmarkLength?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - annualizedVolatility: number | null; default: not declared - assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - drawdown: DrawdownResult; default: not declared - drawdown.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - drawdown.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - drawdown.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - drawdown.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - drawdown.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. - expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - maxDrawdown: number; default: not declared - omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - periods: number; default: not declared - profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. ### @insiderfinance/totalfinance/performance#PortfolioReturnIndexInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link portfolioReturnIndex}. ```typescript /** Input for {@link portfolioReturnIndex}. */ export interface PortfolioReturnIndexInput { valuations: readonly PortfolioValuation[]; externalCashFlows: readonly ExternalCashFlow[]; /** The index level at the first valuation date. Default `100`, echoed in `assumptions`. */ baseValue?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseValue?: number; default: not declared — The index level at the first valuation date. Default `100`, echoed in `assumptions`. - externalCashFlows: readonly ExternalCashFlow[]; default: not declared - valuations: readonly PortfolioValuation[]; default: not declared ### @insiderfinance/totalfinance/performance#PortfolioReturnIndexResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link portfolioReturnIndex}. ```typescript /** Result of {@link portfolioReturnIndex}. */ export interface PortfolioReturnIndexResult { /** `null` (with `reason`) under the null-on-any-gap policy — see `assumptions.gapPolicy`. */ indexSeries: ReturnIndexPoint[] | null; /** Present exactly when `indexSeries` is `null`. */ reason?: string; assumptions: { baseValue: number; gapPolicy: string; flowTiming: 'at-flow-timestamp'; flowConvention: string; linking: 'geometric'; }; diagnostics: { warnings: string[]; gaps: PerformanceGap[]; flowCount: number; subperiodCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { baseValue: number; flowConvention: string; flowTiming: 'at-flow-timestamp'; gapPolicy: string; linking: 'geometric'; }; default: not declared - assumptions.baseValue: number; default: not declared - assumptions.flowConvention: string; default: not declared - assumptions.flowTiming: 'at-flow-timestamp'; default: not declared - assumptions.gapPolicy: string; default: not declared - assumptions.linking: 'geometric'; default: not declared - diagnostics: { flowCount: number; gaps: PerformanceGap[]; subperiodCount: number; warnings: string[]; }; default: not declared - diagnostics.flowCount: number; default: not declared - diagnostics.gaps: PerformanceGap[]; default: not declared - diagnostics.subperiodCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - indexSeries: ReturnIndexPoint[] | null; default: not declared — `null` (with `reason`) under the null-on-any-gap policy — see `assumptions.gapPolicy`. - reason?: string; default: not declared — Present exactly when `indexSeries` is `null`. ### @insiderfinance/totalfinance/performance#PortfolioValuation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One portfolio mark: the net asset value observed on a strict calendar date. ```typescript // --------------------------------------------------------------------------------------------------- // Shared contracts // --------------------------------------------------------------------------------------------------- /** One portfolio mark: the net asset value observed on a strict calendar date. */ export interface PortfolioValuation { /** Strict `YYYY-MM-DD` calendar date. */ valuationDate: string; /** The portfolio's net asset value — finite and ≥ 0 (`0` only for an empty portfolio). */ netAssetValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - netAssetValue: number; default: not declared — The portfolio's net asset value — finite and ≥ 0 (`0` only for an empty portfolio). - valuationDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date. ### @insiderfinance/totalfinance/performance#ReturnIndexPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One point of a total-return index series. ```typescript // --------------------------------------------------------------------------------------------------- // portfolioReturnIndex // --------------------------------------------------------------------------------------------------- /** One point of a total-return index series. */ export interface ReturnIndexPoint { date: string; indexValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared - indexValue: number; default: not declared ### @insiderfinance/totalfinance/performance#SectorClassificationObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One effective-dated, bitemporal sector-classification observation. ```typescript /** One effective-dated, bitemporal sector-classification observation. */ export interface SectorClassificationObservation { /** Harmless caller decoration is accepted but is not copied into selected-input lineage. */ [key: string]: unknown; classificationObservationId: string; securityId: string; taxonomyId: string; taxonomyVersion: string; /** Inclusive strict `YYYY-MM-DD` boundary. */ effectiveFromSessionDate: string; /** Exclusive strict `YYYY-MM-DD` boundary, or `null` while the state remains effective. */ effectiveToSessionDate: string | null; /** `null` together with `sectorName` explicitly records an unclassified state. */ sectorId: string | null; /** `null` together with `sectorId` explicitly records an unclassified state. */ sectorName: string | null; sourceId: string; sourceTimestampMs: number; knownAtTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classificationObservationId: string; default: not declared - effectiveFromSessionDate: string; default: not declared — Inclusive strict `YYYY-MM-DD` boundary. - effectiveToSessionDate: string | null; default: not declared — Exclusive strict `YYYY-MM-DD` boundary, or `null` while the state remains effective. - knownAtTimestampMs: number; default: not declared - sectorId: string | null; default: not declared — `null` together with `sectorName` explicitly records an unclassified state. - sectorName: string | null; default: not declared — `null` together with `sectorId` explicitly records an unclassified state. - securityId: string; default: not declared - sourceId: string; default: not declared - sourceTimestampMs: number; default: not declared - taxonomyId: string; default: not declared - taxonomyVersion: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceAssignedClassificationLineage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assigned classification lineage carried by every included member. ```typescript /** Assigned classification lineage carried by every included member. */ export interface SectorPerformanceAssignedClassificationLineage extends SectorPerformanceClassificationLineage { sectorId: string; sectorName: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classificationObservationId: string; default: not declared - effectiveFromSessionDate: string; default: not declared - effectiveToSessionDate: string | null; default: not declared - knownAtTimestampMs: number; default: not declared - sectorId: string; default: not declared - sectorName: string; default: not declared - securityId: string; default: not declared - sourceId: string; default: not declared - sourceTimestampMs: number; default: not declared - taxonomyId: string; default: not declared - taxonomyVersion: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SectorPerformanceAssumptions { policyVersion: typeof POLICY_VERSION; returnBasis: string; weighting: string; rounding: string; rankingAndTies: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - policyVersion: 'sector-performance-v1'; default: not declared - rankingAndTies: string; default: not declared - returnBasis: string; default: not declared - rounding: string; default: not declared - weighting: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceBlocker Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A calculation-level reason that no complete sector result could be produced. ```typescript /** A calculation-level reason that no complete sector result could be produced. */ export type SectorPerformanceBlocker = 'target-session-not-completed' | 'previous-completed-session-unavailable' | 'eligible-universe-empty' | 'no-includable-members'; ``` ### @insiderfinance/totalfinance/performance#SectorPerformanceClassificationLineage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Selected classification lineage sufficient to replay a member's sector assignment. ```typescript /** Selected classification lineage sufficient to replay a member's sector assignment. */ export interface SectorPerformanceClassificationLineage { classificationObservationId: string; securityId: string; taxonomyId: string; taxonomyVersion: string; effectiveFromSessionDate: string; effectiveToSessionDate: string | null; sectorId: string | null; sectorName: string | null; sourceId: string; sourceTimestampMs: number; knownAtTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classificationObservationId: string; default: not declared - effectiveFromSessionDate: string; default: not declared - effectiveToSessionDate: string | null; default: not declared - knownAtTimestampMs: number; default: not declared - sectorId: string | null; default: not declared - sectorName: string | null; default: not declared - securityId: string; default: not declared - sourceId: string; default: not declared - sourceTimestampMs: number; default: not declared - taxonomyId: string; default: not declared - taxonomyVersion: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceCloseLineage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Selected close lineage sufficient to replay one return leg. ```typescript /** Selected close lineage sufficient to replay one return leg. */ export interface SectorPerformanceCloseLineage { closeObservationId: string; securityId: string; listingId: string; sessionId: string; splitAdjustedClose: number; currency: string; adjustmentVersion: string; quality: 'final' | 'stale'; sourceId: string; sourceTimestampMs: number; knownAtTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustmentVersion: string; default: not declared - closeObservationId: string; default: not declared - currency: string; default: not declared - knownAtTimestampMs: number; default: not declared - listingId: string; default: not declared - quality: 'stale' | 'final'; default: not declared - securityId: string; default: not declared - sessionId: string; default: not declared - sourceId: string; default: not declared - sourceTimestampMs: number; default: not declared - splitAdjustedClose: number; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceCloseObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One exact-session split-adjusted close observation. ```typescript /** One exact-session split-adjusted close observation. */ export interface SectorPerformanceCloseObservation { /** Harmless caller decoration is accepted but is not copied into selected-input lineage. */ [key: string]: unknown; closeObservationId: string; securityId: string; listingId: string; sessionId: string; /** Positive split-adjusted close in `currency`. */ splitAdjustedClose: number; currency: string; /** Both return legs must use the same caller-declared adjustment version. */ adjustmentVersion: string; /** A stale exact-session observation is disclosed but never used. */ quality: 'final' | 'stale'; sourceId: string; sourceTimestampMs: number; knownAtTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustmentVersion: string; default: not declared — Both return legs must use the same caller-declared adjustment version. - closeObservationId: string; default: not declared - currency: string; default: not declared - knownAtTimestampMs: number; default: not declared - listingId: string; default: not declared - quality: 'stale' | 'final'; default: not declared — A stale exact-session observation is disclosed but never used. - securityId: string; default: not declared - sessionId: string; default: not declared - sourceId: string; default: not declared - sourceTimestampMs: number; default: not declared - splitAdjustedClose: number; default: not declared — Positive split-adjusted close in `currency`. ### @insiderfinance/totalfinance/performance#SectorPerformanceCompletedSession Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One caller-supplied completed market session. ```typescript /** One caller-supplied completed market session. */ export interface SectorPerformanceCompletedSession { /** Harmless caller decoration is accepted but is not copied into selected-input lineage. */ [key: string]: unknown; sessionId: string; /** Strict `YYYY-MM-DD` session date. */ sessionDate: string; /** When the caller considered the session complete. */ completedAtTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - completedAtTimestampMs: number; default: not declared — When the caller considered the session complete. - sessionDate: string; default: not declared — Strict `YYYY-MM-DD` session date. - sessionId: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceCutoffs Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit point-in-time and session-completion cutoffs. All comparisons are inclusive. ```typescript /** Explicit point-in-time and session-completion cutoffs. All comparisons are inclusive. */ export interface SectorPerformanceCutoffs { sourceCutoffTimestampMs: number; knowledgeCutoffTimestampMs: number; sessionCompletedCutoffTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - knowledgeCutoffTimestampMs: number; default: not declared - sessionCompletedCutoffTimestampMs: number; default: not declared - sourceCutoffTimestampMs: number; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceExclusion Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit partial lineage for a nominated security excluded from calculation. ```typescript /** Explicit partial lineage for a nominated security excluded from calculation. */ export interface SectorPerformanceExclusion { universeMembershipId: string; securityId: string; listingId: string; reasons: SectorPerformanceExclusionReason[]; classification?: SectorPerformanceClassificationLineage; previousClose?: SectorPerformanceCloseLineage; targetClose?: SectorPerformanceCloseLineage; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classification?: SectorPerformanceClassificationLineage; default: not declared - classification.classificationObservationId: string; default: not declared - classification.effectiveFromSessionDate: string; default: not declared - classification.effectiveToSessionDate: string | null; default: not declared - classification.knownAtTimestampMs: number; default: not declared - classification.sectorId: string | null; default: not declared - classification.sectorName: string | null; default: not declared - classification.securityId: string; default: not declared - classification.sourceId: string; default: not declared - classification.sourceTimestampMs: number; default: not declared - classification.taxonomyId: string; default: not declared - classification.taxonomyVersion: string; default: not declared - listingId: string; default: not declared - previousClose?: SectorPerformanceCloseLineage; default: not declared - previousClose.adjustmentVersion: string; default: not declared - previousClose.closeObservationId: string; default: not declared - previousClose.currency: string; default: not declared - previousClose.knownAtTimestampMs: number; default: not declared - previousClose.listingId: string; default: not declared - previousClose.quality: 'stale' | 'final'; default: not declared - previousClose.securityId: string; default: not declared - previousClose.sessionId: string; default: not declared - previousClose.sourceId: string; default: not declared - previousClose.sourceTimestampMs: number; default: not declared - previousClose.splitAdjustedClose: number; default: not declared - reasons: SectorPerformanceExclusionReason[]; default: not declared - securityId: string; default: not declared - targetClose?: SectorPerformanceCloseLineage; default: not declared - targetClose.adjustmentVersion: string; default: not declared - targetClose.closeObservationId: string; default: not declared - targetClose.currency: string; default: not declared - targetClose.knownAtTimestampMs: number; default: not declared - targetClose.listingId: string; default: not declared - targetClose.quality: 'stale' | 'final'; default: not declared - targetClose.securityId: string; default: not declared - targetClose.sessionId: string; default: not declared - targetClose.sourceId: string; default: not declared - targetClose.sourceTimestampMs: number; default: not declared - targetClose.splitAdjustedClose: number; default: not declared - universeMembershipId: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceExclusionReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Why a nominated member could not contribute; reasons are emitted in this declared order. ```typescript /** Why a nominated member could not contribute; reasons are emitted in this declared order. */ export type SectorPerformanceExclusionReason = 'classification-missing' | 'classification-after-cutoff' | 'classification-unassigned' | 'previous-close-missing' | 'previous-close-after-cutoff' | 'previous-close-stale' | 'target-close-missing' | 'target-close-after-cutoff' | 'target-close-stale' | 'currency-mismatch' | 'adjustment-version-mismatch'; ``` ### @insiderfinance/totalfinance/performance#SectorPerformanceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The simple on-ramp needs no invented price, calendar, classification or source lineage. ```typescript /** The simple on-ramp needs no invented price, calendar, classification or source lineage. */ export interface SectorPerformanceInput { /** Dense observations with unique securityId; at most 1,000,000 rows. Empty is disclosed. */ members: readonly SectorPerformanceMember[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - members: readonly SectorPerformanceMember[]; default: not declared — Dense observations with unique securityId; at most 1,000,000 rows. Empty is disclosed. ### @insiderfinance/totalfinance/performance#SectorPerformanceMember Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A supplied decimal return over the SAME caller-chosen period and comparable return basis. ```typescript /** A supplied decimal return over the SAME caller-chosen period and comparable return basis. */ export interface SectorPerformanceMember extends SectorPerformanceMemberResult { /** Extra observation metadata is accepted, not traversed or copied into the report. */ [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodReturn: number; default: not declared — Decimal simple return (0.01 = +1%), at least -1. No daily/annual horizon is inferred. - sectorId: string; default: not declared - sectorName: string; default: not declared - securityId: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceMemberResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The selected fields of one same-period return observation. ```typescript /** The selected fields of one same-period return observation. */ export interface SectorPerformanceMemberResult { securityId: string; sectorId: string; sectorName: string; /** Decimal simple return (0.01 = +1%), at least -1. No daily/annual horizon is inferred. */ periodReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodReturn: number; default: not declared — Decimal simple return (0.01 = +1%), at least -1. No daily/annual horizon is inferred. - sectorId: string; default: not declared - sectorName: string; default: not declared - securityId: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceReasonCount Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Deterministic count of one exclusion reason. ```typescript /** Deterministic count of one exclusion reason. */ export interface SectorPerformanceReasonCount { reason: SectorPerformanceExclusionReason; count: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - reason: SectorPerformanceExclusionReason; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rich report accepted directly by createAnalysisArtifact; raw calculation needs no artifact. ```typescript /** Rich report accepted directly by createAnalysisArtifact; raw calculation needs no artifact. */ export type SectorPerformanceReport = { policyVersion: typeof POLICY_VERSION; assumptions: Readonly; sectors: SectorPerformanceSectorResult[]; diagnostics: { warnings: QuantWarning[]; status: 'complete' | 'empty'; inputMemberCount: number; includedSecurityCount: number; sectorCount: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Readonly; default: not declared - assumptions.policyVersion: 'sector-performance-v1'; default: not declared - assumptions.rankingAndTies: string; default: not declared - assumptions.returnBasis: string; default: not declared - assumptions.rounding: string; default: not declared - assumptions.weighting: string; default: not declared - diagnostics: { includedSecurityCount: number; inputMemberCount: number; sectorCount: number; status: 'complete' | 'empty'; warnings: QuantWarning[]; }; default: not declared - diagnostics.includedSecurityCount: number; default: not declared - diagnostics.inputMemberCount: number; default: not declared - diagnostics.sectorCount: number; default: not declared - diagnostics.status: 'complete' | 'empty'; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - policyVersion: 'sector-performance-v1'; default: not declared - sectors: SectorPerformanceSectorResult[]; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSectorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SectorPerformanceSectorResult { sectorId: string; sectorName: string; /** Equal-security mean, rounded once to eight decimal-return places. */ periodReturn: number; /** Descending competition rank on rounded returns. */ rank: number; includedSecurityCount: number; members: SectorPerformanceMemberResult[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - includedSecurityCount: number; default: not declared - members: SectorPerformanceMemberResult[]; default: not declared - periodReturn: number; default: not declared — Equal-security mean, rounded once to eight decimal-return places. - rank: number; default: not declared — Descending competition rank on rounded returns. - sectorId: string; default: not declared - sectorName: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSessionLineage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Selected completed-session lineage. ```typescript /** Selected completed-session lineage. */ export interface SectorPerformanceSessionLineage { sessionId: string; sessionDate: string; completedAtTimestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - completedAtTimestampMs: number; default: not declared - sessionDate: string; default: not declared - sessionId: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSnapshotAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The immutable semantics echoed by every result. ```typescript /** The immutable semantics echoed by every result. */ export interface SectorPerformanceSnapshotAssumptions { policyVersion: typeof POLICY_VERSION; eligibility: string; sessionSelection: string; temporalSelection: string; classification: string; returnBasis: string; weighting: string; missingAndStale: string; rounding: string; rankingAndTies: string; cacheAndFreshness: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cacheAndFreshness: string; default: not declared - classification: string; default: not declared - eligibility: string; default: not declared - missingAndStale: string; default: not declared - policyVersion: 'sector-performance-v1'; default: not declared - rankingAndTies: string; default: not declared - returnBasis: string; default: not declared - rounding: string; default: not declared - sessionSelection: string; default: not declared - temporalSelection: string; default: not declared - weighting: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSnapshotDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input, coverage, and exclusion diagnostics for the calculation. ```typescript /** Input, coverage, and exclusion diagnostics for the calculation. */ export interface SectorPerformanceSnapshotDiagnostics { warnings: QuantWarning[]; status: 'complete' | 'partial' | 'empty'; blockers: SectorPerformanceBlocker[]; inputCounts: { eligibleUniverse: number; completedSessions: number; classifications: number; splitAdjustedCloses: number; }; eligibleSecurityCount: number; includedSecurityCount: number; excludedSecurityCount: number; sectorCount: number; reasonCounts: SectorPerformanceReasonCount[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - blockers: SectorPerformanceBlocker[]; default: not declared - eligibleSecurityCount: number; default: not declared - excludedSecurityCount: number; default: not declared - includedSecurityCount: number; default: not declared - inputCounts: { eligibleUniverse: number; completedSessions: number; classifications: number; splitAdjustedCloses: number; }; default: not declared - inputCounts.classifications: number; default: not declared - inputCounts.completedSessions: number; default: not declared - inputCounts.eligibleUniverse: number; default: not declared - inputCounts.splitAdjustedCloses: number; default: not declared - reasonCounts: SectorPerformanceReasonCount[]; default: not declared - sectorCount: number; default: not declared - status: 'complete' | 'empty' | 'partial'; default: not declared - warnings: QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSnapshotInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete, caller-supplied input to the pure calculation. No policy argument is needed: the implemented version is stamped in the report. The four dense arrays share a 1,000,000-row synchronous work ceiling, checked before any observation is accessed. ```typescript /** * Complete, caller-supplied input to the pure calculation. No policy argument is needed: the * implemented version is stamped in the report. The four dense arrays share a 1,000,000-row * synchronous work ceiling, checked before any observation is accessed. */ export interface SectorPerformanceSnapshotInput { /** Exact requested session date. A non-session date produces an empty diagnostic report. */ targetSessionDate: string; /** Caller-declared calendar identity; TotalFinance does not infer holidays or sessions. */ marketCalendarId: string; classificationTaxonomy: SectorPerformanceTaxonomy; cutoffs: SectorPerformanceCutoffs; /** Exactly one nominated listing per eligible security for the target session. */ eligibleUniverse: readonly SectorPerformanceUniverseMember[]; completedSessions: readonly SectorPerformanceCompletedSession[]; classifications: readonly SectorClassificationObservation[]; splitAdjustedCloses: readonly SectorPerformanceCloseObservation[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classificationTaxonomy: SectorPerformanceTaxonomy; default: not declared - classificationTaxonomy.taxonomyId: string; default: not declared - classificationTaxonomy.taxonomyVersion: string; default: not declared - classifications: readonly SectorClassificationObservation[]; default: not declared - completedSessions: readonly SectorPerformanceCompletedSession[]; default: not declared - cutoffs: SectorPerformanceCutoffs; default: not declared - cutoffs.knowledgeCutoffTimestampMs: number; default: not declared - cutoffs.sessionCompletedCutoffTimestampMs: number; default: not declared - cutoffs.sourceCutoffTimestampMs: number; default: not declared - eligibleUniverse: readonly SectorPerformanceUniverseMember[]; default: not declared — Exactly one nominated listing per eligible security for the target session. - marketCalendarId: string; default: not declared — Caller-declared calendar identity; TotalFinance does not infer holidays or sessions. - splitAdjustedCloses: readonly SectorPerformanceCloseObservation[]; default: not declared - targetSessionDate: string; default: not declared — Exact requested session date. A non-session date produces an empty diagnostic report. ### @insiderfinance/totalfinance/performance#SectorPerformanceSnapshotMemberResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One included security and every selected input that contributed to its return. ```typescript /** One included security and every selected input that contributed to its return. */ export interface SectorPerformanceSnapshotMemberResult { universeMembershipId: string; securityId: string; listingId: string; /** Unrounded decimal simple return for this security. */ dailyReturn: number; classification: SectorPerformanceAssignedClassificationLineage; previousClose: SectorPerformanceCloseLineage; targetClose: SectorPerformanceCloseLineage; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classification: SectorPerformanceAssignedClassificationLineage; default: not declared - classification.classificationObservationId: string; default: not declared - classification.effectiveFromSessionDate: string; default: not declared - classification.effectiveToSessionDate: string | null; default: not declared - classification.knownAtTimestampMs: number; default: not declared - classification.sectorId: string; default: not declared - classification.sectorName: string; default: not declared - classification.securityId: string; default: not declared - classification.sourceId: string; default: not declared - classification.sourceTimestampMs: number; default: not declared - classification.taxonomyId: string; default: not declared - classification.taxonomyVersion: string; default: not declared - dailyReturn: number; default: not declared — Unrounded decimal simple return for this security. - listingId: string; default: not declared - previousClose: SectorPerformanceCloseLineage; default: not declared - previousClose.adjustmentVersion: string; default: not declared - previousClose.closeObservationId: string; default: not declared - previousClose.currency: string; default: not declared - previousClose.knownAtTimestampMs: number; default: not declared - previousClose.listingId: string; default: not declared - previousClose.quality: 'stale' | 'final'; default: not declared - previousClose.securityId: string; default: not declared - previousClose.sessionId: string; default: not declared - previousClose.sourceId: string; default: not declared - previousClose.sourceTimestampMs: number; default: not declared - previousClose.splitAdjustedClose: number; default: not declared - securityId: string; default: not declared - targetClose: SectorPerformanceCloseLineage; default: not declared - targetClose.adjustmentVersion: string; default: not declared - targetClose.closeObservationId: string; default: not declared - targetClose.currency: string; default: not declared - targetClose.knownAtTimestampMs: number; default: not declared - targetClose.listingId: string; default: not declared - targetClose.quality: 'stale' | 'final'; default: not declared - targetClose.securityId: string; default: not declared - targetClose.sessionId: string; default: not declared - targetClose.sourceId: string; default: not declared - targetClose.sourceTimestampMs: number; default: not declared - targetClose.splitAdjustedClose: number; default: not declared - universeMembershipId: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSnapshotReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical, replayable result of one requested daily sector-performance calculation. ```typescript /** Canonical, replayable result of one requested daily sector-performance calculation. */ export type SectorPerformanceSnapshotReport = { policyVersion: typeof POLICY_VERSION; assumptions: Readonly; targetSessionDate: string; marketCalendarId: string; classificationTaxonomy: SectorPerformanceTaxonomy; cutoffs: SectorPerformanceCutoffs; selectedSessions: { target: SectorPerformanceSessionLineage | null; previous: SectorPerformanceSessionLineage | null; }; sectors: SectorPerformanceSnapshotSectorResult[]; exclusions: SectorPerformanceExclusion[]; diagnostics: SectorPerformanceSnapshotDiagnostics; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Readonly; default: not declared - assumptions.cacheAndFreshness: string; default: not declared - assumptions.classification: string; default: not declared - assumptions.eligibility: string; default: not declared - assumptions.missingAndStale: string; default: not declared - assumptions.policyVersion: 'sector-performance-v1'; default: not declared - assumptions.rankingAndTies: string; default: not declared - assumptions.returnBasis: string; default: not declared - assumptions.rounding: string; default: not declared - assumptions.sessionSelection: string; default: not declared - assumptions.temporalSelection: string; default: not declared - assumptions.weighting: string; default: not declared - classificationTaxonomy: SectorPerformanceTaxonomy; default: not declared - classificationTaxonomy.taxonomyId: string; default: not declared - classificationTaxonomy.taxonomyVersion: string; default: not declared - cutoffs: SectorPerformanceCutoffs; default: not declared - cutoffs.knowledgeCutoffTimestampMs: number; default: not declared - cutoffs.sessionCompletedCutoffTimestampMs: number; default: not declared - cutoffs.sourceCutoffTimestampMs: number; default: not declared - diagnostics: SectorPerformanceSnapshotDiagnostics; default: not declared - diagnostics.blockers: SectorPerformanceBlocker[]; default: not declared - diagnostics.eligibleSecurityCount: number; default: not declared - diagnostics.excludedSecurityCount: number; default: not declared - diagnostics.includedSecurityCount: number; default: not declared - diagnostics.inputCounts: { classifications: number; completedSessions: number; eligibleUniverse: number; splitAdjustedCloses: number; }; default: not declared - diagnostics.inputCounts.classifications: number; default: not declared - diagnostics.inputCounts.completedSessions: number; default: not declared - diagnostics.inputCounts.eligibleUniverse: number; default: not declared - diagnostics.inputCounts.splitAdjustedCloses: number; default: not declared - diagnostics.reasonCounts: SectorPerformanceReasonCount[]; default: not declared - diagnostics.sectorCount: number; default: not declared - diagnostics.status: 'complete' | 'empty' | 'partial'; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - exclusions: SectorPerformanceExclusion[]; default: not declared - marketCalendarId: string; default: not declared - policyVersion: 'sector-performance-v1'; default: not declared - sectors: SectorPerformanceSnapshotSectorResult[]; default: not declared - selectedSessions: { previous: SectorPerformanceSessionLineage | null; target: SectorPerformanceSessionLineage | null; }; default: not declared - selectedSessions.previous: SectorPerformanceSessionLineage | null; default: not declared - selectedSessions.previous.completedAtTimestampMs: number; default: not declared - selectedSessions.previous.sessionDate: string; default: not declared - selectedSessions.previous.sessionId: string; default: not declared - selectedSessions.target: SectorPerformanceSessionLineage | null; default: not declared - selectedSessions.target.completedAtTimestampMs: number; default: not declared - selectedSessions.target.sessionDate: string; default: not declared - selectedSessions.target.sessionId: string; default: not declared - targetSessionDate: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceSnapshotSectorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One canonical sector result. No provider compatibility alias is part of this contract. ```typescript /** One canonical sector result. No provider compatibility alias is part of this contract. */ export interface SectorPerformanceSnapshotSectorResult { sectorId: string; sectorName: string; /** Equal-security arithmetic mean, in decimal return units, rounded once to eight places. */ dailyReturn: number; /** Descending competition rank (`1, 1, 3`) on the rounded sector return. */ rank: number; eligibleSecurityCount: number; includedSecurityCount: number; excludedSecurityCount: number; members: SectorPerformanceSnapshotMemberResult[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dailyReturn: number; default: not declared — Equal-security arithmetic mean, in decimal return units, rounded once to eight places. - eligibleSecurityCount: number; default: not declared - excludedSecurityCount: number; default: not declared - includedSecurityCount: number; default: not declared - members: SectorPerformanceSnapshotMemberResult[]; default: not declared - rank: number; default: not declared — Descending competition rank (`1, 1, 3`) on the rounded sector return. - sectorId: string; default: not declared - sectorName: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceTaxonomy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The classification taxonomy selected for this calculation. ```typescript /** The classification taxonomy selected for this calculation. */ export interface SectorPerformanceTaxonomy { taxonomyId: string; taxonomyVersion: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - taxonomyId: string; default: not declared - taxonomyVersion: string; default: not declared ### @insiderfinance/totalfinance/performance#SectorPerformanceUniverseMember Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A caller-nominated eligible security and listing. Ticker decoration is not used as identity. ```typescript /** A caller-nominated eligible security and listing. Ticker decoration is not used as identity. */ export interface SectorPerformanceUniverseMember { /** Harmless caller decoration is accepted but is not copied into selected-input lineage. */ [key: string]: unknown; /** Stable identity for the supplied universe membership decision. */ universeMembershipId: string; /** Stable security identity; sector returns receive one equal weight per security. */ securityId: string; /** Stable listing identity used for exact close joins. */ listingId: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - listingId: string; default: not declared — Stable listing identity used for exact close joins. - securityId: string; default: not declared — Stable security identity; sector returns receive one equal weight per security. - universeMembershipId: string; default: not declared — Stable identity for the supplied universe membership decision. ### @insiderfinance/totalfinance/performance#SegmentExternalFlowsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link segmentExternalFlows}. ```typescript /** Input for {@link segmentExternalFlows}. */ export interface SegmentExternalFlowsInput { externalCashFlows: readonly ExternalCashFlow[]; /** * Keep only flows whose `accountId` is listed (flows without an `accountId` are excluded by any * filter). Transfer identification runs BEFORE the filter so a filter can never orphan one leg. */ accountFilter?: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountFilter?: readonly string[]; default: not declared — Keep only flows whose `accountId` is listed (flows without an `accountId` are excluded by any filter). Transfer identification runs BEFORE the filter so a filter can never orphan one leg. - externalCashFlows: readonly ExternalCashFlow[]; default: not declared ### @insiderfinance/totalfinance/performance#SegmentExternalFlowsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link segmentExternalFlows}. ```typescript /** Result of {@link segmentExternalFlows}. */ export interface SegmentExternalFlowsResult { /** Net EXTERNAL flow across the kept accounts — internal transfers contribute exactly zero. */ externalNetAmount: number; byAccount: AccountFlowSegment[]; internalTransfers: InternalTransfer[]; assumptions: { transferIdentification: string; accountFilter: readonly string[] | 'none'; }; diagnostics: { warnings: string[]; flowCount: number; internalTransferCount: number; excludedByFilterCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { accountFilter: readonly string[] | 'none'; transferIdentification: string; }; default: not declared - assumptions.accountFilter: 'none' | readonly string[]; default: not declared - assumptions.transferIdentification: string; default: not declared - byAccount: AccountFlowSegment[]; default: not declared - diagnostics: { excludedByFilterCount: number; flowCount: number; internalTransferCount: number; warnings: string[]; }; default: not declared - diagnostics.excludedByFilterCount: number; default: not declared - diagnostics.flowCount: number; default: not declared - diagnostics.internalTransferCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - externalNetAmount: number; default: not declared — Net EXTERNAL flow across the kept accounts — internal transfers contribute exactly zero. - internalTransfers: InternalTransfer[]; default: not declared ### @insiderfinance/totalfinance/performance#SharpeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SharpeOptions extends AnnualizationOptions { /** Annualized risk-free rate (decimal, default 0). */ riskFreeRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear?: number; default: not declared — Periods per year for annualization. Defaults to 252 (daily); pass 12 monthly, 52 weekly. - riskFreeRate?: number; default: not declared — Annualized risk-free rate (decimal, default 0). ### @insiderfinance/totalfinance/performance#SortinoOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SortinoOptions extends SharpeOptions { /** Minimum acceptable per-period return (default 0). */ targetReturn?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear?: number; default: not declared — Periods per year for annualization. Defaults to 252 (daily); pass 12 monthly, 52 weekly. - riskFreeRate?: number; default: not declared — Annualized risk-free rate (decimal, default 0). - targetReturn?: number; default: not declared — Minimum acceptable per-period return (default 0). ### @insiderfinance/totalfinance/performance#TimeWeightedReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link timeWeightedReturn}. ```typescript // --------------------------------------------------------------------------------------------------- // timeWeightedReturn // --------------------------------------------------------------------------------------------------- /** Input for {@link timeWeightedReturn}. */ export interface TimeWeightedReturnInput { valuations: readonly PortfolioValuation[]; externalCashFlows: readonly ExternalCashFlow[]; /** * The only v1 policy: a flow is valued at the net asset value dated the SAME date; a flow date * with no valuation makes its surrounding subperiod a gap — never a forward fill. */ flowTiming: 'at-flow-timestamp'; /** REQUIRED and explicit: `'none'` or `{ basis: 'ACT/365F' }` — never inferred from timestamps. */ annualization: AnnualizationPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualization: AnnualizationPolicy; default: not declared — REQUIRED and explicit: `'none'` or `{ basis: 'ACT/365F' }` — never inferred from timestamps. - annualization.basis: 'ACT/365F'; default: not declared - externalCashFlows: readonly ExternalCashFlow[]; default: not declared - flowTiming: 'at-flow-timestamp'; default: not declared — The only v1 policy: a flow is valued at the net asset value dated the SAME date; a flow date with no valuation makes its surrounding subperiod a gap — never a forward fill. - valuations: readonly PortfolioValuation[]; default: not declared ### @insiderfinance/totalfinance/performance#TimeWeightedReturnResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link timeWeightedReturn}. ```typescript /** Result of {@link timeWeightedReturn}. */ export interface TimeWeightedReturnResult { /** Geometric link of the measured subperiod returns; `null` when every subperiod is a gap. */ timeWeightedReturn: number | null; /** Present exactly when `timeWeightedReturn` is `null`. */ reason?: string; /** * Present only when `annualization` declared a basis AND the linked return exists, is * annualizable (its growth factor is positive), AND NO subperiod is a gap: * `(1 + timeWeightedReturn)^(1 / elapsedYears) − 1` over the ACT/365F year fraction between the * first and last valuation dates. When any subperiod is a gap the linked return does not cover * the whole window, so no annualized rate is stated (withheld with a warning). */ annualizedReturn?: number; subperiods: TimeWeightedSubperiod[]; assumptions: { flowTiming: 'at-flow-timestamp'; flowConvention: string; annualization: AnnualizationPolicy; linking: 'geometric'; }; diagnostics: { warnings: string[]; gaps: PerformanceGap[]; flowCount: number; subperiodCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedReturn?: number; default: not declared — Present only when `annualization` declared a basis AND the linked return exists, is annualizable (its growth factor is positive), AND NO subperiod is a gap: `(1 + timeWeightedReturn)^(1 / elapsedYears) − 1` over the ACT/365F year fraction between the first and last valuation dates. When any subperiod is a gap the linked return does not cover the whole window, so no annualized rate is stated (withheld with a warning). - assumptions: { annualization: AnnualizationPolicy; flowConvention: string; flowTiming: 'at-flow-timestamp'; linking: 'geometric'; }; default: not declared - assumptions.annualization: AnnualizationPolicy; default: not declared - assumptions.annualization.basis: 'ACT/365F'; default: not declared - assumptions.flowConvention: string; default: not declared - assumptions.flowTiming: 'at-flow-timestamp'; default: not declared - assumptions.linking: 'geometric'; default: not declared - diagnostics: { flowCount: number; gaps: PerformanceGap[]; subperiodCount: number; warnings: string[]; }; default: not declared - diagnostics.flowCount: number; default: not declared - diagnostics.gaps: PerformanceGap[]; default: not declared - diagnostics.subperiodCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - reason?: string; default: not declared — Present exactly when `timeWeightedReturn` is `null`. - subperiods: TimeWeightedSubperiod[]; default: not declared - timeWeightedReturn: number | null; default: not declared — Geometric link of the measured subperiod returns; `null` when every subperiod is a gap. ### @insiderfinance/totalfinance/performance#TimeWeightedSubperiod Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One measured subperiod between consecutive valuation dates. ```typescript // --------------------------------------------------------------------------------------------------- // Time-weighted subperiod core (shared by timeWeightedReturn and portfolioReturnIndex) // --------------------------------------------------------------------------------------------------- /** One measured subperiod between consecutive valuation dates. */ export interface TimeWeightedSubperiod { startDate: string; endDate: string; startNetAssetValue: number; endNetAssetValue: number; /** * Net external flows attributed to this subperiod (dated on its start valuation date). Under the * flow convention the mark precedes the same-dated flow, so this amount lands at the START of * the subperiod and is invested for its whole length — it joins the return base. */ externalFlowAmount: number; /** `endNetAssetValue / (startNetAssetValue + externalFlowAmount) − 1` — the flow rides in the base. */ simpleReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - endDate: string; default: not declared - endNetAssetValue: number; default: not declared - externalFlowAmount: number; default: not declared — Net external flows attributed to this subperiod (dated on its start valuation date). Under the flow convention the mark precedes the same-dated flow, so this amount lands at the START of the subperiod and is invested for its whole length — it joins the return base. - simpleReturn: number; default: not declared — `endNetAssetValue / (startNetAssetValue + externalFlowAmount) − 1` — the flow rides in the base. - startDate: string; default: not declared - startNetAssetValue: number; default: not declared ### @insiderfinance/totalfinance/performance#WinLossStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Win/loss decomposition of a per-period return series (see {@link winLossStatistics}). ```typescript /** Win/loss decomposition of a per-period return series (see {@link winLossStatistics}). */ export interface WinLossStatistics { /** * Mean per-period return over ALL periods (zeros included). With `active` = the fraction of * non-zero periods, `expectancy = active · (hitRate·averageWin + (1 − hitRate)·averageLoss)`; the bare * `hitRate·averageWin + (1 − hitRate)·averageLoss` identity holds only when no period is exactly zero. */ expectancy: number | null; hitRate: number | null; /** Average winning return; 0 when the series has no winning periods (not NaN — disclosed here). */ averageWin: number; /** Average losing return (negative); 0 when the series has no losing periods. */ averageLoss: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageLoss: number; default: not declared — Average losing return (negative); 0 when the series has no losing periods. - averageWin: number; default: not declared — Average winning return; 0 when the series has no winning periods (not NaN — disclosed here). - expectancy: number | null; default: not declared — Mean per-period return over ALL periods (zeros included). With `active` = the fraction of non-zero periods, `expectancy = active · (hitRate·averageWin + (1 − hitRate)·averageLoss)`; the bare `hitRate·averageWin + (1 − hitRate)·averageLoss` identity holds only when no period is exactly zero. - hitRate: number | null; default: not declared ### @insiderfinance/totalfinance/performance#alpha Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Annualized Jensen's alpha: the strategy's average return in excess of what its beta exposure to the benchmark would predict, `α = ppy · (r̄ − [rf_p + β·(b̄ − rf_p)])` (rf split to a per-period rate). ```typescript export declare const alpha: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined], number | null, RiskAdjustedExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined]; default: not declared - explain: (returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#analyze Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The performance summary facade (dx §2.3): plain call → the summary; `.explain()` → the core Computed envelope around it (the summary's own warnings ride `diagnostics.warnings`, its echoed conventions ride `assumptions`). ```typescript export declare const analyze: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: AnalyzeInput, options?: AnalyzeOptions | undefined], PerformanceSummary, { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [input: AnalyzeInput, options?: AnalyzeOptions | undefined]; default: not declared - explain: (input: AnalyzeInput, options?: AnalyzeOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: PerformanceSummary; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [input: AnalyzeInput, options?: AnalyzeOptions | undefined]; default: not declared - return.alpha?: number | null; default: not declared — Annualized Jensen's alpha (only when `options.benchmark` is supplied). - return.annualizedReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - return.annualizedVolatility: number | null; default: not declared - return.assumptions: { benchmarkLength?: number; periodsPerYear: number; riskFreeRate: number; }; default: not declared — The conventions actually applied — a serialized summary is self-interpreting (spec §7.4). - return.assumptions.benchmarkLength?: number; default: not declared — Length of the benchmark return series, present only when a benchmark was supplied. - return.assumptions.periodsPerYear: number; default: not declared — Annualization factor used for all annualized metrics. - return.assumptions.riskFreeRate: number; default: not declared — Per-period risk-free rate used for Sharpe/Sortino/alpha/Treynor (0 when unspecified). - return.beta?: number | null; default: not declared — Beta to the benchmark (only when `options.benchmark` is supplied). - return.calmar: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.drawdown: DrawdownResult; default: not declared - return.expectancy: number | null; default: not declared — Mean per-period return (expectancy); `null` on an empty series or overflow (disclosed). - return.hitRate: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.informationRatio?: number | null; default: not declared — Information ratio (only when `options.benchmark` is supplied). - return.maxDrawdown: number; default: not declared - return.omega: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.periods: number; default: not declared - return.profitFactor: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.sharpe: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.sortino: number | null; default: not declared — `null` when the metric is undefined for this input (disclosed via warnings). - return.totalReturn: number | null; default: not declared — `null` when compounding overflowed (disclosed via `performance.non_finite_metric`). - return.trackingError?: number | null; default: not declared — Annualized tracking error (only when `options.benchmark` is supplied). - return.treynor?: number | null; default: not declared — Treynor ratio (only when `options.benchmark` is supplied). - return.warnings: QuantWarning[]; default: not declared — Diagnostics — e.g. `performance.suspicious_equity_input` when an equity curve looks like returns. ### @insiderfinance/totalfinance/performance#annualizedReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Geometric annualized return from a per-period return series. ```typescript export declare const annualizedReturn: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: AnnualizationOptions | undefined], number | null, AnnualizationExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: AnnualizationOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#annualizedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Annualized volatility: per-period stddev scaled by √periodsPerYear. ```typescript export declare const annualizedVolatility: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: AnnualizationOptions | undefined], number | null, AnnualizationExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: AnnualizationOptions | undefined) => Computed; default: not declared - explain().return.assumptions: Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#benchmarkRelativeTimeline Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Benchmark-relative timeline: aligns a portfolio total-return index with benchmark period returns BY DATE and reports cumulative relative performance rows. A row exists only where BOTH a portfolio index value and a benchmark return dated exactly that day exist; missing dates on either side become `diagnostics.gaps` — never interpolated. Benchmark observations on non-portfolio dates are real growth: they still compound into the benchmark cumulative at the next aligned row (compounding observed returns is not interpolation), and their absence of a row is recorded as a gap. ```typescript export declare function benchmarkRelativeTimeline(input: BenchmarkRelativeTimelineInput): BenchmarkRelativeTimelineResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): BenchmarkRelativeTimelineInput; default: not declared - (input).benchmarkBasis: 'total-return' | 'price-return'; default: not declared — REQUIRED — a benchmark states its basis; price-return omits dividend/income return. - (input).benchmarkReturns: readonly BenchmarkReturnObservation[]; default: not declared - (input).portfolioIndex: readonly ReturnIndexPoint[]; default: not declared - return.assumptions: { anchorDate: string; benchmarkBasis: 'total-return' | 'price-return'; benchmarkReturnConvention: string; relativeMethod: string; }; default: not declared - return.assumptions.anchorDate: string; default: not declared - return.assumptions.benchmarkBasis: 'total-return' | 'price-return'; default: not declared - return.assumptions.benchmarkReturnConvention: string; default: not declared - return.assumptions.relativeMethod: string; default: not declared - return.diagnostics: { gaps: PerformanceGap[]; rowCount: number; warnings: string[]; }; default: not declared - return.diagnostics.gaps: PerformanceGap[]; default: not declared - return.diagnostics.rowCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.rows: BenchmarkRelativeRow[]; default: not declared ### @insiderfinance/totalfinance/performance#beta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Beta: sensitivity of the strategy to the benchmark, `cov(r, b) / var(b)`. ```typescript export declare const beta: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike], number | null, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, benchmark: ArrayLike]; default: not declared - explain: (returns: ArrayLike, benchmark: ArrayLike) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike]; default: not declared ### @insiderfinance/totalfinance/performance#calmar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calmar ratio: annualized return divided by maximum drawdown. ```typescript export declare const calmar: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: AnnualizationOptions | undefined], number | null, AnnualizationExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: AnnualizationOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#contributionByGroup Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Single-period contribution by group: `contribution = weight × simpleReturn` per group, summing to the weighted total return. At single-period scope the reconciliation is exact — the residual (disclosed in `diagnostics.reconciliationResidual`) is 0 within 1e-12, the linking-residual law with no linking involved. ```typescript export declare function contributionByGroup(input: ContributionByGroupInput): ContributionByGroupResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ContributionByGroupInput; default: not declared - (input).groupReturns: readonly GroupReturn[]; default: not declared — ONE period's per-group weights and returns (position/account/strategy/asset class/…). - return.assumptions: { formula: string; scope: 'single-period'; }; default: not declared - return.assumptions.formula: string; default: not declared - return.assumptions.scope: 'single-period'; default: not declared - return.contributions: GroupContribution[]; default: not declared - return.diagnostics: { groupCount: number; reconciliationResidual: number; warnings: string[]; weightSum: number; }; default: not declared - return.diagnostics.groupCount: number; default: not declared - return.diagnostics.reconciliationResidual: number; default: not declared — `totalReturn − Σ contributionᵢ` — identically 0 at single-period scope (the linking-residual law). - return.diagnostics.warnings: string[]; default: not declared - return.diagnostics.weightSum: number; default: not declared - return.totalReturn: number; default: not declared — The weighted total return `Σ weightᵢ · simpleReturnᵢ` the contributions reconcile to. ### @insiderfinance/totalfinance/performance#cumulativeReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cumulative compounded return at each step from a series of simple returns. ```typescript export declare function cumulativeReturns(returns: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (returns): ArrayLike; default: not declared ### @insiderfinance/totalfinance/performance#equityCurve Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equity curve (growth of `start`) from a series of simple returns. The curve begins at `start` and has length `returns.length + 1`, so `analyze({ equity: equityCurve(returns) })` recovers every return — the starting capital is the first point, not an implicit one. (`equityCurve([])` is `[start]`.) ```typescript export declare function equityCurve(returns: ArrayLike, start?: number): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (returns): ArrayLike; default: not declared - (start)?: number; default: not declared ### @insiderfinance/totalfinance/performance#expectancy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Expectancy: the mean per-period return — `null` when undefined (empty series), exactly as `analyze().expectancy` reports it (one word, one shape). For the win/loss decomposition that explains it (hit rate, average win/loss), use {@link winLossStatistics}. ```typescript export declare const expectancy: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], number | null, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike]; default: not declared - explain: (returns: ArrayLike) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike]; default: not declared ### @insiderfinance/totalfinance/performance#exposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exposure facade (dx §2.3): plain call → the profile; `.explain()` → the Computed envelope. ```typescript export declare const exposure: import('@insiderfinance/totalfinance/core').SeriesFacade<[weights: readonly ArrayLike[]], ExposureResult, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [weights: readonly ArrayLike[]]; default: not declared - explain: (weights: readonly ArrayLike[]) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ExposureResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [weights: readonly ArrayLike[]]; default: not declared - return.averageGross: number | null; default: not declared — Average gross exposure `mean_t( Σ_i |w_{t,i}| )`. - return.averageLong: number | null; default: not declared — Average long exposure `mean_t( Σ_i max(w_{t,i}, 0) )`. - return.averageNet: number | null; default: not declared — Average net exposure `mean_t( Σ_i w_{t,i} )`. - return.averageShort: number | null; default: not declared — Average short exposure as a positive number `mean_t( Σ_i max(−w_{t,i}, 0) )`. - return.timeInMarket: number | null; default: not declared — Fraction of periods with any non-zero net position (`Σ_i w ≠ 0`). ### @insiderfinance/totalfinance/performance#hitRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Hit rate: fraction of non-zero periods that were positive (`wins / (wins + losses)`). ```typescript export declare const hitRate: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], number | null, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike]; default: not declared - explain: (returns: ArrayLike) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike]; default: not declared ### @insiderfinance/totalfinance/performance#informationRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Information ratio: annualized mean active return divided by annualized tracking error — the Sharpe ratio of the active (strategy − benchmark) return series. ```typescript export declare const informationRatio: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined], number | null, AnnualizationExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared - explain: (returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#linkSubperiodReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit subperiod linking: `'geometric'` compounds (`Π(1 + rᵢ) − 1`, the time-weighted convention), `'arithmetic'` sums (`Σ rᵢ`, no compounding — an approximation that ignores base drift). The policy is required; nothing is inferred. ```typescript export declare function linkSubperiodReturns(input: LinkSubperiodReturnsInput): LinkSubperiodReturnsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LinkSubperiodReturnsInput; default: not declared - (input).linking: 'geometric' | 'arithmetic'; default: not declared — REQUIRED and explicit — linking is a policy, never a guess. - (input).subperiodReturns: readonly number[]; default: not declared - return.assumptions: { formula: string; linking: 'geometric' | 'arithmetic'; }; default: not declared - return.assumptions.formula: string; default: not declared - return.assumptions.linking: 'geometric' | 'arithmetic'; default: not declared - return.diagnostics: { subperiodCount: number; warnings: string[]; }; default: not declared - return.diagnostics.subperiodCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.linkedReturn: number; default: not declared ### @insiderfinance/totalfinance/performance#logReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Continuously-compounded (log) returns; output length is `prices.length - 1`. ```typescript export declare function logReturns(prices: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (prices): ArrayLike; default: not declared ### @insiderfinance/totalfinance/performance#maxDrawdown Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Maximum drawdown facade (dx §2.3): plain call → the `DrawdownResult`; `.explain()` → the `Computed` envelope. `equity` is a PRICE-level series by contract, so the prices-as-returns plausibility guard deliberately does not apply here. ```typescript export declare const maxDrawdown: import('@insiderfinance/totalfinance/core').SeriesFacade<[equity: ArrayLike], DrawdownResult, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [equity: ArrayLike]; default: not declared - explain: (equity: ArrayLike) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: DrawdownResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [equity: ArrayLike]; default: not declared - return.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - return.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - return.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - return.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - return.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. ### @insiderfinance/totalfinance/performance#maxDrawdownFromReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Maximum drawdown of the growth-of-1 equity curve implied by a per-period **return** series (WS3.3b) — the returns-input counterpart to {@link maxDrawdown}, which expects an equity curve. ```typescript export declare function maxDrawdownFromReturns(returns: ArrayLike): DrawdownResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (returns): ArrayLike; default: not declared - return.longestDurationPeriods: number; default: not declared — Longest underwater stretch, in periods. - return.maxDrawdown: number; default: not declared — Maximum drawdown as a positive fraction (0.2 = a 20% peak-to-trough decline). - return.peakIndex: number; default: not declared — Index of the peak preceding the worst drawdown. - return.recoveryIndex?: number; default: not declared — Index at which equity first regained the pre-drawdown peak after the worst trough (WS3.3c). Absent when the curve never recovered by the end of the series (still underwater). - return.troughIndex: number; default: not declared — Index of the trough of the worst drawdown. ### @insiderfinance/totalfinance/performance#modifiedDietzReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Classic Modified Dietz single-period return: `(netAssetValue₁ − netAssetValue₀ − F) / (netAssetValue₀ + Σ weightᵢ·flowᵢ)` where `F` is the net external flow and each `weightᵢ = (daysInPeriod − daysSinceStartᵢ) / daysInPeriod` under ACT day counts. The weights actually used are exposed in `flowWeights`. When the average-capital denominator is not positive the result is `null` with a reason — never a fabricated rate. ```typescript export declare function modifiedDietzReturn(input: ModifiedDietzReturnInput): ModifiedDietzReturnResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ModifiedDietzReturnInput; default: not declared - (input).externalCashFlows: readonly ExternalCashFlow[]; default: not declared - (input).valuations: readonly PortfolioValuation[]; default: not declared — EXACTLY the two period endpoints: the start and end valuations. - return.assumptions: { dayCount: 'ACT (actual calendar days)'; weightFormula: string; }; default: not declared - return.assumptions.dayCount: 'ACT (actual calendar days)'; default: not declared - return.assumptions.weightFormula: string; default: not declared - return.diagnostics: { daysInPeriod: number; flowCount: number; warnings: string[]; }; default: not declared - return.diagnostics.daysInPeriod: number; default: not declared - return.diagnostics.flowCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.flowWeights: ModifiedDietzFlowWeight[]; default: not declared — The exact weight applied to each flow — exposed, never hidden. - return.modifiedDietzReturn: number | null; default: not declared — `null` (with `reason`) when the average-capital denominator is not positive. - return.reason?: string; default: not declared — Present exactly when `modifiedDietzReturn` is `null`. ### @insiderfinance/totalfinance/performance#moneyWeightedReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Money-weighted return: the dated internal rate of return of the INVESTOR's cash-flow schedule, composed from `datedInternalRateOfReturn` in `@insiderfinance/totalfinance/valuation` (annual compounding, ACT/365F — echoed in `solverReport.assumptions`). Sign convention (echoed in `assumptions.signConvention`): flows are stated from the INVESTOR's perspective — the beginning net asset value is money the investor has committed (an outflow, `−netAssetValue₀`), a deposit is the investor paying in (an outflow, `−amount`), a withdrawal is the investor taking money out (an inflow, `+amount`), and the ending net asset value is what the investor could take out (an inflow, `+netAssetValueₙ`). The solver's `.explain()` report is preserved whole in `solverReport` so every admissible root and convergence detail rides along. ```typescript export declare function moneyWeightedReturn(input: MoneyWeightedReturnInput): MoneyWeightedReturnResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MoneyWeightedReturnInput; default: not declared - (input).externalCashFlows: readonly ExternalCashFlow[]; default: not declared - (input).valuations: readonly PortfolioValuation[]; default: not declared — First and last valuations REQUIRED — they anchor the schedule. Interior marks do not enter. - return.assumptions: { asOf: string; signConvention: string; }; default: not declared - return.assumptions.asOf: string; default: not declared — The first valuation date — the solver's valuation instant. - return.assumptions.signConvention: string; default: not declared - return.diagnostics: { scheduleRowCount: number; warnings: string[]; }; default: not declared - return.diagnostics.scheduleRowCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.moneyWeightedReturn: number | null; default: not declared — The dated internal rate of return of the investor schedule; `null` on no root or ambiguity. - return.reason?: string; default: not declared — Present exactly when `moneyWeightedReturn` is `null` — why the solver withheld a value. - return.solverReport: InternalRateOfReturnReport; default: not declared — The FC1 solver's full `.explain()` report: roots, convergence, and warnings ride along. ### @insiderfinance/totalfinance/performance#omega Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Omega ratio at a per-period `threshold` (default 0): Σ gains above θ ÷ Σ losses below θ. **`null`, never `Infinity`** (Law 7): with gains but no losses the ratio is unbounded, and with neither it is undefined — both are reported as `null`, and `.explain()` carries an `input.degenerate` warning naming the reason. A JSON payload can hold `null`; it cannot hold `Infinity` (`JSON.stringify` silently corrupts it to `null` anyway, without the reason). ```typescript export declare const omega: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: { threshold?: number; } | undefined], number | null, { threshold: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: { threshold?: number; } | undefined]; default: not declared - explain: (returns: ArrayLike, options?: { threshold?: number; } | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ threshold: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: { threshold?: number; } | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#portfolioReturnIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The portfolio's total-return index: the time-weighted subperiod returns (same flow convention and gap rules as {@link timeWeightedReturn}) chained geometrically from `baseValue` at the first valuation date. Gap policy — decided, documented, echoed: ANY gap makes the WHOLE index `null` with a reason (`assumptions.gapPolicy`), because an index that silently restarts across a hole misrepresents cumulative growth. ```typescript export declare function portfolioReturnIndex(input: PortfolioReturnIndexInput): PortfolioReturnIndexResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioReturnIndexInput; default: not declared - (input).baseValue?: number; default: not declared — The index level at the first valuation date. Default `100`, echoed in `assumptions`. - (input).externalCashFlows: readonly ExternalCashFlow[]; default: not declared - (input).valuations: readonly PortfolioValuation[]; default: not declared - return.assumptions: { baseValue: number; flowConvention: string; flowTiming: 'at-flow-timestamp'; gapPolicy: string; linking: 'geometric'; }; default: not declared - return.assumptions.baseValue: number; default: not declared - return.assumptions.flowConvention: string; default: not declared - return.assumptions.flowTiming: 'at-flow-timestamp'; default: not declared - return.assumptions.gapPolicy: string; default: not declared - return.assumptions.linking: 'geometric'; default: not declared - return.diagnostics: { flowCount: number; gaps: PerformanceGap[]; subperiodCount: number; warnings: string[]; }; default: not declared - return.diagnostics.flowCount: number; default: not declared - return.diagnostics.gaps: PerformanceGap[]; default: not declared - return.diagnostics.subperiodCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.indexSeries: ReturnIndexPoint[] | null; default: not declared — `null` (with `reason`) under the null-on-any-gap policy — see `assumptions.gapPolicy`. - return.reason?: string; default: not declared — Present exactly when `indexSeries` is `null`. ### @insiderfinance/totalfinance/performance#profitFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Profit factor: gross gains ÷ gross losses. **`null`, never `Infinity`** (Law 7): a series with gains but no losses has an unbounded profit factor, and a series with neither has an undefined one — both are reported as `null`, with an `input.degenerate` warning on `.explain()` naming which case it was. (The doc used to promise `Infinity`; the facade has always returned `null`, and `null` is the law-conform answer — a caller branching on `=== Infinity` would never have matched.) ```typescript export declare const profitFactor: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], number | null, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike]; default: not declared - explain: (returns: ArrayLike) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike]; default: not declared ### @insiderfinance/totalfinance/performance#rollingReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling compounded return over a trailing window (`Π(1 + r) − 1`), aligned to the input index with the leading `window − 1` entries set to `NaN`. ```typescript export declare const rollingReturn: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, window: number], number[], { window: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, window: number]; default: not declared - explain: (returns: ArrayLike, window: number) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, window: number]; default: not declared ### @insiderfinance/totalfinance/performance#rollingSharpe Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling annualized Sharpe ratio over a trailing window (leading `window − 1` entries are `NaN`). ```typescript export declare const rollingSharpe: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, window: number, options?: SharpeOptions | undefined], number[], { window: number; periodsPerYear: number; riskFreeRate: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, window: number, options?: SharpeOptions | undefined]; default: not declared - explain: (returns: ArrayLike, window: number, options?: SharpeOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; periodsPerYear: number; riskFreeRate: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, window: number, options?: SharpeOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#rollingVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling annualized volatility over a trailing window (leading `window − 1` entries are `NaN`). `options.periodsPerYear` defaults to 252 — matching every other `rolling*(series, window, options?)` sibling, so the annualization factor is no longer a bare positional scalar. ```typescript export declare const rollingVolatility: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, window: number, options?: AnnualizationOptions | undefined], number[], { window: number; periodsPerYear: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, window: number, options?: AnnualizationOptions | undefined]; default: not declared - explain: (returns: ArrayLike, window: number, options?: AnnualizationOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ window: number; periodsPerYear: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, window: number, options?: AnnualizationOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#sectorPerformance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equal-weight sectors from same-period decimal returns. Rows are open observations, the request is closed. Inputs are copied, never mutated; identities, not ticker aliases, determine membership. ```typescript export declare function sectorPerformance(input: SectorPerformanceInput): SectorPerformanceReport; ``` Example (source JSDoc): sectorPerformance({ members: [{ securityId: 'A', sectorId: 'technology', sectorName: 'Technology', periodReturn: 0.01 }] }) Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SectorPerformanceInput; default: not declared - (input).members: readonly SectorPerformanceMember[]; default: not declared — Dense observations with unique securityId; at most 1,000,000 rows. Empty is disclosed. - return.assumptions: Readonly; default: not declared - return.assumptions.policyVersion: 'sector-performance-v1'; default: not declared - return.assumptions.rankingAndTies: string; default: not declared - return.assumptions.returnBasis: string; default: not declared - return.assumptions.rounding: string; default: not declared - return.assumptions.weighting: string; default: not declared - return.diagnostics: { includedSecurityCount: number; inputMemberCount: number; sectorCount: number; status: 'complete' | 'empty'; warnings: QuantWarning[]; }; default: not declared - return.diagnostics.includedSecurityCount: number; default: not declared - return.diagnostics.inputMemberCount: number; default: not declared - return.diagnostics.sectorCount: number; default: not declared - return.diagnostics.status: 'complete' | 'empty'; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.policyVersion: 'sector-performance-v1'; default: not declared - return.sectors: SectorPerformanceSectorResult[]; default: not declared ### @insiderfinance/totalfinance/performance#sectorPerformanceSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calculate one target session's audited sector returns from governed inputs. The function is deterministic and pure: it performs no I/O, reads no clock, mutates no input, and never infers a universe, session, classification, or price. ```typescript export declare function sectorPerformanceSnapshot(input: SectorPerformanceSnapshotInput): SectorPerformanceSnapshotReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SectorPerformanceSnapshotInput; default: not declared - (input).classificationTaxonomy: SectorPerformanceTaxonomy; default: not declared - (input).classifications: readonly SectorClassificationObservation[]; default: not declared - (input).completedSessions: readonly SectorPerformanceCompletedSession[]; default: not declared - (input).cutoffs: SectorPerformanceCutoffs; default: not declared - (input).eligibleUniverse: readonly SectorPerformanceUniverseMember[]; default: not declared — Exactly one nominated listing per eligible security for the target session. - (input).marketCalendarId: string; default: not declared — Caller-declared calendar identity; TotalFinance does not infer holidays or sessions. - (input).splitAdjustedCloses: readonly SectorPerformanceCloseObservation[]; default: not declared - (input).targetSessionDate: string; default: not declared — Exact requested session date. A non-session date produces an empty diagnostic report. - return.assumptions: Readonly; default: not declared - return.assumptions.cacheAndFreshness: string; default: not declared - return.assumptions.classification: string; default: not declared - return.assumptions.eligibility: string; default: not declared - return.assumptions.missingAndStale: string; default: not declared - return.assumptions.policyVersion: 'sector-performance-v1'; default: not declared - return.assumptions.rankingAndTies: string; default: not declared - return.assumptions.returnBasis: string; default: not declared - return.assumptions.rounding: string; default: not declared - return.assumptions.sessionSelection: string; default: not declared - return.assumptions.temporalSelection: string; default: not declared - return.assumptions.weighting: string; default: not declared - return.classificationTaxonomy: SectorPerformanceTaxonomy; default: not declared - return.cutoffs: SectorPerformanceCutoffs; default: not declared - return.diagnostics: SectorPerformanceSnapshotDiagnostics; default: not declared - return.exclusions: SectorPerformanceExclusion[]; default: not declared - return.marketCalendarId: string; default: not declared - return.policyVersion: 'sector-performance-v1'; default: not declared - return.sectors: SectorPerformanceSnapshotSectorResult[]; default: not declared - return.selectedSessions: { previous: SectorPerformanceSessionLineage | null; target: SectorPerformanceSessionLineage | null; }; default: not declared - return.selectedSessions.previous: SectorPerformanceSessionLineage | null; default: not declared - return.selectedSessions.previous.completedAtTimestampMs: number; default: not declared - return.selectedSessions.previous.sessionDate: string; default: not declared - return.selectedSessions.previous.sessionId: string; default: not declared - return.selectedSessions.target: SectorPerformanceSessionLineage | null; default: not declared - return.selectedSessions.target.completedAtTimestampMs: number; default: not declared - return.selectedSessions.target.sessionDate: string; default: not declared - return.selectedSessions.target.sessionId: string; default: not declared - return.targetSessionDate: string; default: not declared ### @insiderfinance/totalfinance/performance#segmentExternalFlows Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). External-flow segmentation: totals by account plus the net, with transfers BETWEEN accounts of one portfolio identified and reported as internal — a transfer nets to zero external flow (the acceptance law) and appears only in `internalTransfers`, never in the external totals. ```typescript export declare function segmentExternalFlows(input: SegmentExternalFlowsInput): SegmentExternalFlowsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SegmentExternalFlowsInput; default: not declared - (input).accountFilter?: readonly string[]; default: not declared — Keep only flows whose `accountId` is listed (flows without an `accountId` are excluded by any filter). Transfer identification runs BEFORE the filter so a filter can never orphan one leg. - (input).externalCashFlows: readonly ExternalCashFlow[]; default: not declared - return.assumptions: { accountFilter: readonly string[] | 'none'; transferIdentification: string; }; default: not declared - return.assumptions.accountFilter: 'none' | readonly string[]; default: not declared - return.assumptions.transferIdentification: string; default: not declared - return.byAccount: AccountFlowSegment[]; default: not declared - return.diagnostics: { excludedByFilterCount: number; flowCount: number; internalTransferCount: number; warnings: string[]; }; default: not declared - return.diagnostics.excludedByFilterCount: number; default: not declared - return.diagnostics.flowCount: number; default: not declared - return.diagnostics.internalTransferCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.externalNetAmount: number; default: not declared — Net EXTERNAL flow across the kept accounts — internal transfers contribute exactly zero. - return.internalTransfers: InternalTransfer[]; default: not declared ### @insiderfinance/totalfinance/performance#sharpe Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Annualized Sharpe ratio of a per-period return series. ```typescript export declare const sharpe: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: SharpeOptions | undefined], number | null, RiskAdjustedExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: SharpeOptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: SharpeOptions | undefined) => Computed; default: not declared - explain().return.assumptions: Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: SharpeOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#simpleReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Simple period-over-period returns; output length is `prices.length - 1`. A zero price before the final observation throws (that period's return divides by zero) rather than emitting a NaN that poisons every downstream metric. ```typescript export declare function simpleReturns(prices: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (prices): ArrayLike; default: not declared ### @insiderfinance/totalfinance/performance#sortino Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Annualized Sortino ratio (downside-deviation-adjusted). ```typescript export declare const sortino: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: SortinoOptions | undefined], number | null, RiskAdjustedExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: SortinoOptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: SortinoOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: SortinoOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#timeWeightedReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Time-weighted return: simple returns between consecutive valuation dates, linked geometrically. Flow convention (also echoed in `assumptions.flowConvention`): a valuation dated D marks the portfolio BEFORE any external flow dated D lands, so a flow dated on a valuation date is attributed to the START of the subperiod beginning at D and is invested for its whole length. Each subperiod uses `simpleReturn = endNetAssetValue / (startNetAssetValue + netExternalFlows) − 1` — the flow principal joins the start-of-subperiod base (denominator), so external deposits and withdrawals are never profit or loss. A flow dated between valuations has no mark to be valued at, so its surrounding subperiod becomes a GAP: excluded from linking, recorded in `diagnostics.gaps`, never forward-filled. `annualizedReturn` appears only under the explicit `{ basis: 'ACT/365F' }` policy, and only when NO subperiod is a gap — a linked return that covers part of the window is never annualized over the whole window. ```typescript export declare function timeWeightedReturn(input: TimeWeightedReturnInput): TimeWeightedReturnResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TimeWeightedReturnInput; default: not declared - (input).annualization: AnnualizationPolicy; default: not declared — REQUIRED and explicit: `'none'` or `{ basis: 'ACT/365F' }` — never inferred from timestamps. - (input).externalCashFlows: readonly ExternalCashFlow[]; default: not declared - (input).flowTiming: 'at-flow-timestamp'; default: not declared — The only v1 policy: a flow is valued at the net asset value dated the SAME date; a flow date with no valuation makes its surrounding subperiod a gap — never a forward fill. - (input).valuations: readonly PortfolioValuation[]; default: not declared - return.annualizedReturn?: number; default: not declared — Present only when `annualization` declared a basis AND the linked return exists, is annualizable (its growth factor is positive), AND NO subperiod is a gap: `(1 + timeWeightedReturn)^(1 / elapsedYears) − 1` over the ACT/365F year fraction between the first and last valuation dates. When any subperiod is a gap the linked return does not cover the whole window, so no annualized rate is stated (withheld with a warning). - return.assumptions: { annualization: AnnualizationPolicy; flowConvention: string; flowTiming: 'at-flow-timestamp'; linking: 'geometric'; }; default: not declared - return.assumptions.annualization: AnnualizationPolicy; default: not declared - return.assumptions.flowConvention: string; default: not declared - return.assumptions.flowTiming: 'at-flow-timestamp'; default: not declared - return.assumptions.linking: 'geometric'; default: not declared - return.diagnostics: { flowCount: number; gaps: PerformanceGap[]; subperiodCount: number; warnings: string[]; }; default: not declared - return.diagnostics.flowCount: number; default: not declared - return.diagnostics.gaps: PerformanceGap[]; default: not declared - return.diagnostics.subperiodCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.reason?: string; default: not declared — Present exactly when `timeWeightedReturn` is `null`. - return.subperiods: TimeWeightedSubperiod[]; default: not declared - return.timeWeightedReturn: number | null; default: not declared — Geometric link of the measured subperiod returns; `null` when every subperiod is a gap. ### @insiderfinance/totalfinance/performance#trackingError Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Annualized tracking error: the volatility of the active (strategy − benchmark) return series. ```typescript export declare const trackingError: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined], number | null, AnnualizationExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared - explain: (returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: AnnualizationOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#treynor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Treynor ratio: excess (over risk-free) annualized return per unit of systematic risk (beta), `(annualizedReturn − rf) / β`. Uses the geometric annualized return for the numerator. ```typescript export declare const treynor: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined], number | null, RiskAdjustedExtra>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined]; default: not declared - explain: (returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, benchmark: ArrayLike, options?: SharpeOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/performance#turnover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Turnover facade (dx §2.3): plain call → the ratio; `.explain()` → the Computed envelope. ```typescript export declare const turnover: import('@insiderfinance/totalfinance/core').SeriesFacade<[weights: readonly ArrayLike[]], number | null, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [weights: readonly ArrayLike[]]; default: not declared - explain: (weights: readonly ArrayLike[]) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [weights: readonly ArrayLike[]]; default: not declared ### @insiderfinance/totalfinance/performance#underwater Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-period drawdown series (input-aligned): the fractional decline from the running peak at each index, as a non-negative number (0 at a fresh high). The series that drives an underwater chart (WS3.3c); its maximum equals `maxDrawdown(equity).maxDrawdown`. ```typescript export declare function underwater(equity: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (equity): ArrayLike; default: not declared ### @insiderfinance/totalfinance/performance#winLossStatistics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const winLossStatistics: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike], WinLossStatistics, Record>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike]; default: not declared - explain: (returns: ArrayLike) => Computed>; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: WinLossStatistics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike]; default: not declared - return.averageLoss: number; default: not declared — Average losing return (negative); 0 when the series has no losing periods. - return.averageWin: number; default: not declared — Average winning return; 0 when the series has no winning periods (not NaN — disclosed here). - return.expectancy: number | null; default: not declared — Mean per-period return over ALL periods (zeros included). With `active` = the fraction of non-zero periods, `expectancy = active · (hitRate·averageWin + (1 − hitRate)·averageLoss)`; the bare `hitRate·averageWin + (1 − hitRate)·averageLoss` identity holds only when no period is exactly zero. - return.hitRate: number | null; default: not declared ## Entrypoint @insiderfinance/totalfinance/performance/activity ### @insiderfinance/totalfinance/performance/activity#ExposureResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ExposureResult`. ### @insiderfinance/totalfinance/performance/activity#exposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#exposure`. ### @insiderfinance/totalfinance/performance/activity#turnover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#turnover`. ## Entrypoint @insiderfinance/totalfinance/performance/analyze ### @insiderfinance/totalfinance/performance/analyze#AnalyzeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#AnalyzeInput`. ### @insiderfinance/totalfinance/performance/analyze#AnalyzeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#AnalyzeOptions`. ### @insiderfinance/totalfinance/performance/analyze#PerformanceSummary Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#PerformanceSummary`. ### @insiderfinance/totalfinance/performance/analyze#analyze Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#analyze`. ## Entrypoint @insiderfinance/totalfinance/performance/drawdown ### @insiderfinance/totalfinance/performance/drawdown#DrawdownResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#DrawdownResult`. ### @insiderfinance/totalfinance/performance/drawdown#maxDrawdown Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#maxDrawdown`. ### @insiderfinance/totalfinance/performance/drawdown#maxDrawdownFromReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#maxDrawdownFromReturns`. ### @insiderfinance/totalfinance/performance/drawdown#underwater Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#underwater`. ## Entrypoint @insiderfinance/totalfinance/performance/flow-aware ### @insiderfinance/totalfinance/performance/flow-aware#AccountFlowSegment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#AccountFlowSegment`. ### @insiderfinance/totalfinance/performance/flow-aware#AnnualizationPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#AnnualizationPolicy`. ### @insiderfinance/totalfinance/performance/flow-aware#BenchmarkRelativeRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#BenchmarkRelativeRow`. ### @insiderfinance/totalfinance/performance/flow-aware#BenchmarkRelativeTimelineInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#BenchmarkRelativeTimelineInput`. ### @insiderfinance/totalfinance/performance/flow-aware#BenchmarkRelativeTimelineResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#BenchmarkRelativeTimelineResult`. ### @insiderfinance/totalfinance/performance/flow-aware#BenchmarkReturnObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#BenchmarkReturnObservation`. ### @insiderfinance/totalfinance/performance/flow-aware#ContributionByGroupInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ContributionByGroupInput`. ### @insiderfinance/totalfinance/performance/flow-aware#ContributionByGroupResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ContributionByGroupResult`. ### @insiderfinance/totalfinance/performance/flow-aware#ExternalCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ExternalCashFlow`. ### @insiderfinance/totalfinance/performance/flow-aware#GroupContribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#GroupContribution`. ### @insiderfinance/totalfinance/performance/flow-aware#GroupReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#GroupReturn`. ### @insiderfinance/totalfinance/performance/flow-aware#InternalTransfer Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#InternalTransfer`. ### @insiderfinance/totalfinance/performance/flow-aware#LinkSubperiodReturnsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#LinkSubperiodReturnsInput`. ### @insiderfinance/totalfinance/performance/flow-aware#LinkSubperiodReturnsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#LinkSubperiodReturnsResult`. ### @insiderfinance/totalfinance/performance/flow-aware#ModifiedDietzFlowWeight Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ModifiedDietzFlowWeight`. ### @insiderfinance/totalfinance/performance/flow-aware#ModifiedDietzReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ModifiedDietzReturnInput`. ### @insiderfinance/totalfinance/performance/flow-aware#ModifiedDietzReturnResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ModifiedDietzReturnResult`. ### @insiderfinance/totalfinance/performance/flow-aware#MoneyWeightedReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#MoneyWeightedReturnInput`. ### @insiderfinance/totalfinance/performance/flow-aware#MoneyWeightedReturnResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#MoneyWeightedReturnResult`. ### @insiderfinance/totalfinance/performance/flow-aware#PerformanceGap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#PerformanceGap`. ### @insiderfinance/totalfinance/performance/flow-aware#PortfolioReturnIndexInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#PortfolioReturnIndexInput`. ### @insiderfinance/totalfinance/performance/flow-aware#PortfolioReturnIndexResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#PortfolioReturnIndexResult`. ### @insiderfinance/totalfinance/performance/flow-aware#PortfolioValuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#PortfolioValuation`. ### @insiderfinance/totalfinance/performance/flow-aware#ReturnIndexPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#ReturnIndexPoint`. ### @insiderfinance/totalfinance/performance/flow-aware#SegmentExternalFlowsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SegmentExternalFlowsInput`. ### @insiderfinance/totalfinance/performance/flow-aware#SegmentExternalFlowsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SegmentExternalFlowsResult`. ### @insiderfinance/totalfinance/performance/flow-aware#TimeWeightedReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#TimeWeightedReturnInput`. ### @insiderfinance/totalfinance/performance/flow-aware#TimeWeightedReturnResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#TimeWeightedReturnResult`. ### @insiderfinance/totalfinance/performance/flow-aware#TimeWeightedSubperiod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#TimeWeightedSubperiod`. ### @insiderfinance/totalfinance/performance/flow-aware#benchmarkRelativeTimeline Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#benchmarkRelativeTimeline`. ### @insiderfinance/totalfinance/performance/flow-aware#contributionByGroup Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#contributionByGroup`. ### @insiderfinance/totalfinance/performance/flow-aware#linkSubperiodReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#linkSubperiodReturns`. ### @insiderfinance/totalfinance/performance/flow-aware#modifiedDietzReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#modifiedDietzReturn`. ### @insiderfinance/totalfinance/performance/flow-aware#moneyWeightedReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#moneyWeightedReturn`. ### @insiderfinance/totalfinance/performance/flow-aware#portfolioReturnIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#portfolioReturnIndex`. ### @insiderfinance/totalfinance/performance/flow-aware#segmentExternalFlows Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#segmentExternalFlows`. ### @insiderfinance/totalfinance/performance/flow-aware#timeWeightedReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#timeWeightedReturn`. ## Entrypoint @insiderfinance/totalfinance/performance/metrics ### @insiderfinance/totalfinance/performance/metrics#SortinoOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SortinoOptions`. ### @insiderfinance/totalfinance/performance/metrics#annualizedReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#annualizedReturn`. ### @insiderfinance/totalfinance/performance/metrics#calmar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#calmar`. ### @insiderfinance/totalfinance/performance/metrics#sortino Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#sortino`. ## Entrypoint @insiderfinance/totalfinance/performance/ratios ### @insiderfinance/totalfinance/performance/ratios#WinLossStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#WinLossStatistics`. ### @insiderfinance/totalfinance/performance/ratios#expectancy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#expectancy`. ### @insiderfinance/totalfinance/performance/ratios#hitRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#hitRate`. ### @insiderfinance/totalfinance/performance/ratios#omega Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#omega`. ### @insiderfinance/totalfinance/performance/ratios#profitFactor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#profitFactor`. ### @insiderfinance/totalfinance/performance/ratios#winLossStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#winLossStatistics`. ## Entrypoint @insiderfinance/totalfinance/performance/relative ### @insiderfinance/totalfinance/performance/relative#alpha Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#alpha`. ### @insiderfinance/totalfinance/performance/relative#beta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#beta`. ### @insiderfinance/totalfinance/performance/relative#informationRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#informationRatio`. ### @insiderfinance/totalfinance/performance/relative#trackingError Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#trackingError`. ### @insiderfinance/totalfinance/performance/relative#treynor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#treynor`. ## Entrypoint @insiderfinance/totalfinance/performance/returns ### @insiderfinance/totalfinance/performance/returns#cumulativeReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#cumulativeReturns`. ### @insiderfinance/totalfinance/performance/returns#equityCurve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#equityCurve`. ### @insiderfinance/totalfinance/performance/returns#logReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#logReturns`. ### @insiderfinance/totalfinance/performance/returns#simpleReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#simpleReturns`. ## Entrypoint @insiderfinance/totalfinance/performance/rolling ### @insiderfinance/totalfinance/performance/rolling#rollingReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#rollingReturn`. ### @insiderfinance/totalfinance/performance/rolling#rollingSharpe Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#rollingSharpe`. ### @insiderfinance/totalfinance/performance/rolling#rollingVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#rollingVolatility`. ## Entrypoint @insiderfinance/totalfinance/performance/sector-performance ### @insiderfinance/totalfinance/performance/sector-performance#SectorClassificationObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorClassificationObservation`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceAssignedClassificationLineage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceAssignedClassificationLineage`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceAssumptions`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceBlocker Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceBlocker`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceClassificationLineage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceClassificationLineage`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceCloseLineage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceCloseLineage`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceCloseObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceCloseObservation`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceCompletedSession Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceCompletedSession`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceCutoffs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceCutoffs`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceExclusion Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceExclusion`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceExclusionReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceExclusionReason`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceInput`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceMember Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceMember`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceMemberResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceMemberResult`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceReasonCount Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceReasonCount`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceReport`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSectorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSectorResult`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSessionLineage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSessionLineage`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSnapshotAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSnapshotAssumptions`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSnapshotDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSnapshotDiagnostics`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSnapshotInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSnapshotInput`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSnapshotMemberResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSnapshotMemberResult`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSnapshotReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSnapshotReport`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceSnapshotSectorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceSnapshotSectorResult`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceTaxonomy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceTaxonomy`. ### @insiderfinance/totalfinance/performance/sector-performance#SectorPerformanceUniverseMember Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SectorPerformanceUniverseMember`. ### @insiderfinance/totalfinance/performance/sector-performance#sectorPerformance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#sectorPerformance`. ### @insiderfinance/totalfinance/performance/sector-performance#sectorPerformanceSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#sectorPerformanceSnapshot`. ## Entrypoint @insiderfinance/totalfinance/performance/sharpe ### @insiderfinance/totalfinance/performance/sharpe#ANNUALIZATION_KEYS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Law 12 allowlist for {@link AnnualizationOptions} — a `periodsPeryear` typo teaches, never silently annualizes at 252. ```typescript export declare const ANNUALIZATION_KEYS: readonly ['periodsPerYear']; ``` ### @insiderfinance/totalfinance/performance/sharpe#AnnualizationExtra Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Conventions disclosed by an annualization-only metric. ```typescript /** Conventions disclosed by an annualization-only metric. */ export type AnnualizationExtra = { periodsPerYear: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear: number; default: not declared ### @insiderfinance/totalfinance/performance/sharpe#AnnualizationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#AnnualizationOptions`. ### @insiderfinance/totalfinance/performance/sharpe#DEFAULT_PERIODS_PER_YEAR Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The daily-data annualization convention. It is an industry constant (252 trading days), not a hidden finance choice — so it DEFAULTS when omitted and is echoed back in the result's assumptions. Use 12 for monthly data, 52 for weekly. ```typescript export declare const DEFAULT_PERIODS_PER_YEAR: 252; ``` ### @insiderfinance/totalfinance/performance/sharpe#RiskAdjustedExtra Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Conventions disclosed by a risk-adjusted (excess-return) metric. ```typescript /** Conventions disclosed by a risk-adjusted (excess-return) metric. */ export type RiskAdjustedExtra = { periodsPerYear: number; riskFreeRate: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear: number; default: not declared - riskFreeRate: number; default: not declared ### @insiderfinance/totalfinance/performance/sharpe#SHARPE_KEYS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Law 12 allowlist for {@link SharpeOptions} — the parent's keys plus the risk-free rate. ```typescript export declare const SHARPE_KEYS: readonly ['periodsPerYear', 'riskFreeRate']; ``` ### @insiderfinance/totalfinance/performance/sharpe#SharpeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#SharpeOptions`. ### @insiderfinance/totalfinance/performance/sharpe#annualizationAssumptions Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assumptions echoing just the annualization factor. ```typescript export declare function annualizationAssumptions(periodsPerYear: number): Assumptions; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (periodsPerYear): number; default: not declared - return.asOf?: number; default: not declared - return.calendar?: string; default: not declared - return.calendarVersion?: string; default: not declared - return.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - return.conventionsVersion: string; default: not declared - return.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - return.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - return.engine?: string; default: not declared - return.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - return.model?: string; default: not declared - return.periodsPerYear: number; default: not declared - return.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - return.timeToExpiryConvention?: never; default: not declared - return.timeToExpiryYears?: number; default: not declared - return.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared ### @insiderfinance/totalfinance/performance/sharpe#annualizedVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#annualizedVolatility`. ### @insiderfinance/totalfinance/performance/sharpe#degenerateAwareDiagnostics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Degenerate-NaN honesty (design law #4: a NaN result must ride with an explicit diagnostic, never alone). Wraps {@link returnsDiagnostics} and — when the computed `value` is NaN — appends a `WarningCode.DegenerateInput` warning saying WHY the metric is undefined for this input. Used by the `.explain()` paths only; plain calls stay silent-and-correct (they still return the NaN). Pass no `series` for non-returns inputs (e.g. weight rows) where the prices-as-returns plausibility scan must not apply. ```typescript export declare function degenerateAwareDiagnostics(value: number, functionName: string, reason: string, ...series: ArrayLike[]): Diagnostics; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (reason): string; default: not declared - (series): ArrayLike[]; default: not declared - (value): number; default: not declared - return.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.iterations?: number; default: not declared — Iteration count for iterative methods. - return.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/performance/sharpe#requireSeries Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Boundary guard for every series-consuming performance facade (dx §1.2 applied here): the input must be a real array (or typed array) of numbers — a string, `undefined`, or a plain object throws a typed teaching error instead of a raw `TypeError` from `series.length` downstream. The container being an array is not enough: EVERY element is validated (E4) — a single NaN, `undefined`, or string mid-series poisons a mean/stddev into a silently-wrong number, and a `sharpe([0.01, NaN, 0.02])` masquerading as a real ratio is exactly the corruption Law 7 kills at the boundary. A `Float64Array` of finite values always passes; empty arrays keep their documented null-with-reason behavior downstream. ```typescript export declare function requireSeries(series: ArrayLike, functionName: string, field?: string): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field)?: string; default: not declared - (functionName): string; default: not declared - (series): ArrayLike; default: not declared ### @insiderfinance/totalfinance/performance/sharpe#returnsDiagnostics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnostics for a returns-consuming explain path (dx WS-3/R6): flags any input series whose values look like prices rather than per-period decimal returns. Shared by every returns-typed metric in this package (and risk); equity/price-typed parameters must NOT use it. ```typescript export declare function returnsDiagnostics(...series: ArrayLike[]): Diagnostics; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (series): ArrayLike[]; default: not declared - return.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.iterations?: number; default: not declared — Iteration count for iterative methods. - return.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/performance/sharpe#riskAdjustedAssumptions Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assumptions echoing the annualization factor and the applied risk-free rate. ```typescript export declare function riskAdjustedAssumptions(input: RiskAdjustedExtra): Assumptions; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RiskAdjustedExtra; default: not declared - (input).periodsPerYear: number; default: not declared - (input).riskFreeRate: number; default: not declared - return.asOf?: number; default: not declared - return.calendar?: string; default: not declared - return.calendarVersion?: string; default: not declared - return.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - return.conventionsVersion: string; default: not declared - return.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - return.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - return.engine?: string; default: not declared - return.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - return.model?: string; default: not declared - return.periodsPerYear: number; default: not declared - return.riskFreeRate: number; default: not declared - return.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - return.timeToExpiryConvention?: never; default: not declared - return.timeToExpiryYears?: number; default: not declared - return.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared ### @insiderfinance/totalfinance/performance/sharpe#sharpe Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/performance#sharpe`. ## Entrypoint @insiderfinance/totalfinance/portfolio ### @insiderfinance/totalfinance/portfolio#AccountMigrationMarker Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An account-migration marker as folded (slice 3): the fact IS the marker; no economic effect. ```typescript /** An account-migration marker as folded (slice 3): the fact IS the marker; no economic effect. */ export interface AccountMigrationMarker { eventId: string; fromAccountId: string; toAccountId: string; effectiveTimestampMs: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - effectiveTimestampMs: number; default: not declared - eventId: string; default: not declared - fromAccountId: string; default: not declared - toAccountId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#AccountState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One account's derived facts. Accumulators are keyed by uppercase currency code. ```typescript /** One account's derived facts. Accumulators are keyed by uppercase currency code. */ export interface AccountState { cashBalances: Record; positions: Record; /** Realized P&L from lot relief under the state's `lotRelief` policy, by currency. */ realizedPnl: Record; /** Income received (dividends, coupons, interest, staking, funding receipts), by currency. */ incomeReceived: Record; /** Transaction costs charged (commissions, fees, slippage adjustments), by currency. */ transactionCosts: Record; /** Financing charged (margin interest, borrow, funding payments), by currency. */ financingCosts: Record; /** * Per-instrument attribution of the realized, income, and cost accumulators (slice 2, * 2026-08-28): `instrumentId → currency → amount`. Realized P&L always carries the instrument; * income and costs carry it only when the event named one (unattributed amounts stay in the * account-level totals above and are reported as such by `portfolioPnl`). These survive a * position closing — `positions` drops a flat instrument, its history does not disappear. */ realizedPnlByInstrument: Record>; incomeByInstrument: Record>; transactionCostsByInstrument: Record>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashBalances: Record; default: not declared - financingCosts: Record; default: not declared — Financing charged (margin interest, borrow, funding payments), by currency. - incomeByInstrument: Record>; default: not declared - incomeReceived: Record; default: not declared — Income received (dividends, coupons, interest, staking, funding receipts), by currency. - positions: Record; default: not declared - realizedPnl: Record; default: not declared — Realized P&L from lot relief under the state's `lotRelief` policy, by currency. - realizedPnlByInstrument: Record>; default: not declared — Per-instrument attribution of the realized, income, and cost accumulators (slice 2, 2026-08-28): `instrumentId → currency → amount`. Realized P&L always carries the instrument; income and costs carry it only when the event named one (unattributed amounts stay in the account-level totals above and are reported as such by `portfolioPnl`). These survive a position closing — `positions` drops a flat instrument, its history does not disappear. - transactionCosts: Record; default: not declared — Transaction costs charged (commissions, fees, slippage adjustments), by currency. - transactionCostsByInstrument: Record>; default: not declared ### @insiderfinance/totalfinance/portfolio#AdminAccountMigrationEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An audit marker that an account's identity moved; no economic effect (the marker is the fact). ```typescript /** An audit marker that an account's identity moved; no economic effect (the marker is the fact). */ export interface AdminAccountMigrationEvent { eventType: 'admin.account-migration'; fromAccountId: string; toAccountId: string; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'admin.account-migration'; default: not declared - fromAccountId: string; default: not declared - reason?: string; default: not declared - toAccountId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#AdminCorrectionEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reverse an applied fact exactly and record what it should have been, atomically. The `replacement` folds at the ORIGINAL's effective instant (so lot order and settlement timing are what they would have been had the fact been recorded right), under the correction's identity. ```typescript /** * Reverse an applied fact exactly and record what it should have been, atomically. The * `replacement` folds at the ORIGINAL's effective instant (so lot order and settlement timing are * what they would have been had the fact been recorded right), under the correction's identity. */ export interface AdminCorrectionEvent { eventType: 'admin.correction'; original: PortfolioEventEnvelope; replacement: EconomicPortfolioEvent; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'admin.correction'; default: not declared - original: PortfolioEventEnvelope; default: not declared - original.accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - original.causationId?: string; default: not declared - original.correlationId?: string; default: not declared - original.effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - original.event: PortfolioEvent; default: not declared - original.event.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - original.event.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - original.event.amountPerShare: number; default: not declared - original.event.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - original.event.cashPerShare?: number; default: not declared - original.event.childInstrumentId: string; default: not declared - original.event.closePricePerUnit: number; default: not declared - original.event.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - original.event.contract.expiryTimestampMs: number; default: not declared - original.event.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - original.event.contract.strikePricePerUnit: number; default: not declared - original.event.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - original.event.contract.underlyingInstrumentId: string; default: not declared - original.event.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - original.event.contractMultiplierAfter: number; default: not declared - original.event.costType: CostType; default: not declared - original.event.currency?: string; default: not declared — Required with `cashPerShare`. - original.event.eventType: ('admin.account-migration') | ('admin.correction') | ('admin.reversal') | ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - original.event.financingType: FinancingType; default: not declared - original.event.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - original.event.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - original.event.fromCurrency: string; default: not declared - original.event.fromInstrumentId: string; default: not declared - original.event.incomeType: IncomeType; default: not declared - original.event.instrumentId?: string; default: not declared - original.event.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - original.event.openPricePerUnit: number; default: not declared - original.event.original: PortfolioEventEnvelope; default: not declared - original.event.parentInstrumentId: string; default: not declared - original.event.premiumTreatment: PremiumTreatment; default: not declared - original.event.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - original.event.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - original.event.reason?: string; default: not declared - original.event.redemptionType: RedemptionType; default: not declared - original.event.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - original.event.replacement: EconomicPortfolioEvent; default: not declared - original.event.replacement.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - original.event.replacement.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - original.event.replacement.amountPerShare: number; default: not declared - original.event.replacement.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - original.event.replacement.cashPerShare?: number; default: not declared - original.event.replacement.childInstrumentId: string; default: not declared - original.event.replacement.closePricePerUnit: number; default: not declared - original.event.replacement.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - original.event.replacement.contract.expiryTimestampMs: number; default: not declared - original.event.replacement.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - original.event.replacement.contract.strikePricePerUnit: number; default: not declared - original.event.replacement.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - original.event.replacement.contract.underlyingInstrumentId: string; default: not declared - original.event.replacement.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - original.event.replacement.contractMultiplierAfter: number; default: not declared - original.event.replacement.costType: CostType; default: not declared - original.event.replacement.currency?: string; default: not declared — Required with `cashPerShare`. - original.event.replacement.eventType: ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - original.event.replacement.financingType: FinancingType; default: not declared - original.event.replacement.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - original.event.replacement.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - original.event.replacement.fromCurrency: string; default: not declared - original.event.replacement.fromInstrumentId: string; default: not declared - original.event.replacement.incomeType: IncomeType; default: not declared - original.event.replacement.instrumentId?: string; default: not declared - original.event.replacement.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - original.event.replacement.openPricePerUnit: number; default: not declared - original.event.replacement.parentInstrumentId: string; default: not declared - original.event.replacement.premiumTreatment: PremiumTreatment; default: not declared - original.event.replacement.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - original.event.replacement.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - original.event.replacement.reason?: string; default: not declared - original.event.replacement.redemptionType: RedemptionType; default: not declared - original.event.replacement.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - original.event.replacement.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - original.event.replacement.settlement: DerivativeSettlement; default: not declared - original.event.replacement.settlement.kind: ('cash') | ('physical'); default: not declared - original.event.replacement.settlement.settlementPricePerUnit: number; default: not declared - original.event.replacement.settlementPricePerUnit: number; default: not declared - original.event.replacement.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - original.event.replacement.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - original.event.replacement.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - original.event.replacement.sharesPerParentShare: number; default: not declared - original.event.replacement.sharesPerShare?: number; default: not declared - original.event.replacement.side: 'buy' | 'sell'; default: not declared - original.event.replacement.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - original.event.replacement.toAccountId: string; default: not declared - original.event.replacement.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - original.event.replacement.toCurrency: string; default: not declared - original.event.replacement.toInstrumentId?: string; default: not declared - original.event.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - original.event.settlement: DerivativeSettlement; default: not declared - original.event.settlement.kind: ('cash') | ('physical'); default: not declared - original.event.settlement.settlementPricePerUnit: number; default: not declared - original.event.settlementPricePerUnit: number; default: not declared - original.event.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - original.event.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - original.event.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - original.event.sharesPerParentShare: number; default: not declared - original.event.sharesPerShare?: number; default: not declared - original.event.side: 'buy' | 'sell'; default: not declared - original.event.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - original.event.toAccountId: string; default: not declared - original.event.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - original.event.toCurrency: string; default: not declared - original.event.toInstrumentId?: string; default: not declared - original.eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - original.eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - original.provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - original.provenance.asOf?: number; default: not declared - original.provenance.dataset?: string; default: not declared - original.provenance.provider?: string; default: not declared - original.provenance.receivedAt?: number; default: not declared - original.provenance.requestId?: string; default: not declared - original.provenance.sourceVersion?: string; default: not declared - original.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - original.recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - original.reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - original.schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - original.sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - reason?: string; default: not declared - replacement: EconomicPortfolioEvent; default: not declared - replacement.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - replacement.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - replacement.amountPerShare: number; default: not declared - replacement.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - replacement.cashPerShare?: number; default: not declared - replacement.childInstrumentId: string; default: not declared - replacement.closePricePerUnit: number; default: not declared - replacement.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - replacement.contract.expiryTimestampMs: number; default: not declared - replacement.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - replacement.contract.strikePricePerUnit: number; default: not declared - replacement.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - replacement.contract.underlyingInstrumentId: string; default: not declared - replacement.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - replacement.contractMultiplierAfter: number; default: not declared - replacement.costType: CostType; default: not declared - replacement.currency?: string; default: not declared — Required with `cashPerShare`. - replacement.eventType: ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - replacement.financingType: FinancingType; default: not declared - replacement.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - replacement.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - replacement.fromCurrency: string; default: not declared - replacement.fromInstrumentId: string; default: not declared - replacement.incomeType: IncomeType; default: not declared - replacement.instrumentId?: string; default: not declared - replacement.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - replacement.openPricePerUnit: number; default: not declared - replacement.parentInstrumentId: string; default: not declared - replacement.premiumTreatment: PremiumTreatment; default: not declared - replacement.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - replacement.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - replacement.reason?: string; default: not declared - replacement.redemptionType: RedemptionType; default: not declared - replacement.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - replacement.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - replacement.settlement: DerivativeSettlement; default: not declared - replacement.settlement.kind: ('cash') | ('physical'); default: not declared - replacement.settlement.settlementPricePerUnit: number; default: not declared - replacement.settlementPricePerUnit: number; default: not declared - replacement.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - replacement.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - replacement.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - replacement.sharesPerParentShare: number; default: not declared - replacement.sharesPerShare?: number; default: not declared - replacement.side: 'buy' | 'sell'; default: not declared - replacement.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - replacement.toAccountId: string; default: not declared - replacement.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - replacement.toCurrency: string; default: not declared - replacement.toInstrumentId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#AdminReversalEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reverse an applied fact EXACTLY. The envelope's `reversesEventId` names it; `original` carries the applied envelope verbatim so the fold can prove (by content hash against its registry) that what is being reversed is what was applied — a reversal never targets an imagined fact. History is not rewritten: the original stays in the registry, the reversal is registered beside it, and the state records the link. ```typescript /** The closed first-slice economic-event union (agent-native doc's decided event families). */ // --------------------------------------------------------------------------------------------------- // Administration (slice 3, 2026-08-28; agent-native "Administration" family, Permanent law 1) // --------------------------------------------------------------------------------------------------- /** * Reverse an applied fact EXACTLY. The envelope's `reversesEventId` names it; `original` carries * the applied envelope verbatim so the fold can prove (by content hash against its registry) that * what is being reversed is what was applied — a reversal never targets an imagined fact. * History is not rewritten: the original stays in the registry, the reversal is registered beside * it, and the state records the link. */ export interface AdminReversalEvent { eventType: 'admin.reversal'; original: PortfolioEventEnvelope; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'admin.reversal'; default: not declared - original: PortfolioEventEnvelope; default: not declared - original.accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - original.causationId?: string; default: not declared - original.correlationId?: string; default: not declared - original.effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - original.event: PortfolioEvent; default: not declared - original.event.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - original.event.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - original.event.amountPerShare: number; default: not declared - original.event.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - original.event.cashPerShare?: number; default: not declared - original.event.childInstrumentId: string; default: not declared - original.event.closePricePerUnit: number; default: not declared - original.event.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - original.event.contract.expiryTimestampMs: number; default: not declared - original.event.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - original.event.contract.strikePricePerUnit: number; default: not declared - original.event.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - original.event.contract.underlyingInstrumentId: string; default: not declared - original.event.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - original.event.contractMultiplierAfter: number; default: not declared - original.event.costType: CostType; default: not declared - original.event.currency?: string; default: not declared — Required with `cashPerShare`. - original.event.eventType: ('admin.account-migration') | ('admin.correction') | ('admin.reversal') | ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - original.event.financingType: FinancingType; default: not declared - original.event.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - original.event.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - original.event.fromCurrency: string; default: not declared - original.event.fromInstrumentId: string; default: not declared - original.event.incomeType: IncomeType; default: not declared - original.event.instrumentId?: string; default: not declared - original.event.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - original.event.openPricePerUnit: number; default: not declared - original.event.original: PortfolioEventEnvelope; default: not declared - original.event.parentInstrumentId: string; default: not declared - original.event.premiumTreatment: PremiumTreatment; default: not declared - original.event.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - original.event.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - original.event.reason?: string; default: not declared - original.event.redemptionType: RedemptionType; default: not declared - original.event.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - original.event.replacement: EconomicPortfolioEvent; default: not declared - original.event.replacement.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - original.event.replacement.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - original.event.replacement.amountPerShare: number; default: not declared - original.event.replacement.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - original.event.replacement.cashPerShare?: number; default: not declared - original.event.replacement.childInstrumentId: string; default: not declared - original.event.replacement.closePricePerUnit: number; default: not declared - original.event.replacement.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - original.event.replacement.contract.expiryTimestampMs: number; default: not declared - original.event.replacement.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - original.event.replacement.contract.strikePricePerUnit: number; default: not declared - original.event.replacement.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - original.event.replacement.contract.underlyingInstrumentId: string; default: not declared - original.event.replacement.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - original.event.replacement.contractMultiplierAfter: number; default: not declared - original.event.replacement.costType: CostType; default: not declared - original.event.replacement.currency?: string; default: not declared — Required with `cashPerShare`. - original.event.replacement.eventType: ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - original.event.replacement.financingType: FinancingType; default: not declared - original.event.replacement.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - original.event.replacement.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - original.event.replacement.fromCurrency: string; default: not declared - original.event.replacement.fromInstrumentId: string; default: not declared - original.event.replacement.incomeType: IncomeType; default: not declared - original.event.replacement.instrumentId?: string; default: not declared - original.event.replacement.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - original.event.replacement.openPricePerUnit: number; default: not declared - original.event.replacement.parentInstrumentId: string; default: not declared - original.event.replacement.premiumTreatment: PremiumTreatment; default: not declared - original.event.replacement.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - original.event.replacement.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - original.event.replacement.reason?: string; default: not declared - original.event.replacement.redemptionType: RedemptionType; default: not declared - original.event.replacement.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - original.event.replacement.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - original.event.replacement.settlement: DerivativeSettlement; default: not declared - original.event.replacement.settlement.kind: ('cash') | ('physical'); default: not declared - original.event.replacement.settlement.settlementPricePerUnit: number; default: not declared - original.event.replacement.settlementPricePerUnit: number; default: not declared - original.event.replacement.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - original.event.replacement.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - original.event.replacement.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - original.event.replacement.sharesPerParentShare: number; default: not declared - original.event.replacement.sharesPerShare?: number; default: not declared - original.event.replacement.side: 'buy' | 'sell'; default: not declared - original.event.replacement.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - original.event.replacement.toAccountId: string; default: not declared - original.event.replacement.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - original.event.replacement.toCurrency: string; default: not declared - original.event.replacement.toInstrumentId?: string; default: not declared - original.event.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - original.event.settlement: DerivativeSettlement; default: not declared - original.event.settlement.kind: ('cash') | ('physical'); default: not declared - original.event.settlement.settlementPricePerUnit: number; default: not declared - original.event.settlementPricePerUnit: number; default: not declared - original.event.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - original.event.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - original.event.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - original.event.sharesPerParentShare: number; default: not declared - original.event.sharesPerShare?: number; default: not declared - original.event.side: 'buy' | 'sell'; default: not declared - original.event.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - original.event.toAccountId: string; default: not declared - original.event.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - original.event.toCurrency: string; default: not declared - original.event.toInstrumentId?: string; default: not declared - original.eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - original.eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - original.provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - original.provenance.asOf?: number; default: not declared - original.provenance.dataset?: string; default: not declared - original.provenance.provider?: string; default: not declared - original.provenance.receivedAt?: number; default: not declared - original.provenance.requestId?: string; default: not declared - original.provenance.sourceVersion?: string; default: not declared - original.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - original.recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - original.reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - original.schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - original.sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - reason?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#AllocatePortfolioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AllocatePortfolioInput extends AllocationSizingInput { /** Targets inline or via a model artifact (resolved at `asOf`). */ policy: InvestmentPolicy; /** REQUIRED — model targets are dated; echoed on the result. */ asOf: EpochMs | string; baseCurrency: string; /** The investable total in base currency (> 0). Weights are shares of this. */ netAssetValue: number; /** Per instrument. Required for every instrument with a target or a holding. */ prices: Record; /** FC5 quotes; required exactly when a priced instrument's currency ≠ `baseCurrency`. */ currencyConversions?: CurrencyPairQuote[]; /** Signed quantity per instrument; omitted = no holdings. */ currentHoldings?: Record; /** * Units of the underlying per unit of quantity, per instrument (slice 5): an option's 100, a * futures contract size. Omitted = 1. Notional = quantity × price × multiplier; lot rounding * stays on quantity. */ contractMultipliers?: Record; instrumentClassification?: Record; /** Base currency held back from the investable amount (≥ 0), on top of the cash target. */ cashReserve?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — REQUIRED — model targets are dated; echoed on the result. - baseCurrency: string; default: not declared - cashReserve?: number; default: not declared — Base currency held back from the investable amount (≥ 0), on top of the cash target. - contractMultipliers?: Record; default: not declared — Units of the underlying per unit of quantity, per instrument (slice 5): an option's 100, a futures contract size. Omitted = 1. Notional = quantity × price × multiplier; lot rounding stays on quantity. - currencyConversions?: CurrencyPairQuote[]; default: not declared — FC5 quotes; required exactly when a priced instrument's currency ≠ `baseCurrency`. - currentHoldings?: Record; default: not declared — Signed quantity per instrument; omitted = no holdings. - defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - instrumentClassification?: Record; default: not declared - lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - netAssetValue: number; default: not declared — The investable total in base currency (> 0). Weights are shares of this. - policy: InvestmentPolicy; default: not declared — Targets inline or via a model artifact (resolved at `asOf`). - policy.allowedAccounts?: string[]; default: not declared - policy.allowedInstruments?: string[]; default: not declared - policy.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.benchmark.benchmarkId: string; default: not declared - policy.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.contributionHandling?: import('@insiderfinance/totalfinance/portfolio').ContributionHandling; default: not declared - policy.driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - policy.incomeReinvestment?: import('@insiderfinance/totalfinance/portfolio').IncomeReinvestment; default: not declared - policy.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - policy.lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - policy.maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - policy.maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - policy.minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - policy.minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - policy.model?: import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared - policy.model.baseCurrency: string; default: not declared - policy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.model.benchmark.benchmarkId: string; default: not declared - policy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - policy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - policy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - policy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - policy.model.horizonEndDate?: string | number; default: not declared - policy.model.kind: 'totalfinance.model-portfolio'; default: not declared - policy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - policy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - policy.model.liabilities.note?: string; default: not declared - policy.model.modelId: string; default: not declared - policy.model.note?: string; default: not declared - policy.model.schemaVersion: number; default: not declared - policy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - policy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - policy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - policy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - policy.model.strategic.note?: string; default: not declared - policy.model.strategic.targets: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - policy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - policy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - policy.performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - policy.restrictedInstruments?: string[]; default: not declared - policy.reviewCadenceDays?: number; default: not declared - policy.targets?: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - policy.withdrawalHandling?: import('@insiderfinance/totalfinance/portfolio').WithdrawalHandling; default: not declared - policy.withinGroupAllocation?: import('@insiderfinance/totalfinance/portfolio').WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. - prices: Record; default: not declared — Per instrument. Required for every instrument with a target or a holding. - transactionCosts?: AllocationTransactionCosts; default: not declared - transactionCosts.commissionPerTrade?: number; default: not declared — Base-currency commission per non-zero trade. - transactionCosts.commissionPerUnit?: number; default: not declared — Base-currency commission per unit traded (× |quantity|). - transactionCosts.slippageBasisPoints?: number; default: not declared — Market-impact/slippage cost in basis points of |notional|. - transactionCosts.spreadBasisPoints?: number; default: not declared — Half-spread cost in basis points of |notional|. ### @insiderfinance/totalfinance/portfolio#AllocatePortfolioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AllocatePortfolioResult { asOf: EpochMs; baseCurrency: string; netAssetValue: number; /** Sorted by instrumentId. */ allocations: AllocationRow[]; cash: AllocationCash; /** Sorted by instrumentId; dust and zero trades excluded. */ trades: AllocationTrade[]; /** Sorted by instrumentId. */ dust: AllocationDustRow[]; estimatedTransactionCost: number; /** `Σ |trade notional| ÷ netAssetValue` (buys and sells both counted). */ turnover: number; /** Sorted by key, then reason. */ unresolved: UnresolvedTarget[]; /** No unresolved target AND the buys are funded (cash residual ≥ 0). */ feasible: boolean; assumptions: { conventionsVersion: string; targetSource: ResolvedTargetSource; rounding: string; costModel: string; pricing: string; currencyConversionsUsed: CurrencyPairQuote[]; }; diagnostics: { warnings: string[]; instrumentCount: number; tradeCount: number; dustCount: number; unresolvedCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allocations: AllocationRow[]; default: not declared — Sorted by instrumentId. - asOf: number; default: not declared - assumptions: { conventionsVersion: string; costModel: string; currencyConversionsUsed: CurrencyPairQuote[]; pricing: string; rounding: string; targetSource: ResolvedTargetSource; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.costModel: string; default: not declared - assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared - assumptions.pricing: string; default: not declared - assumptions.rounding: string; default: not declared - assumptions.targetSource: ResolvedTargetSource; default: not declared - baseCurrency: string; default: not declared - cash: AllocationCash; default: not declared - cash.achievedWeight: number; default: not declared — Post-trade cash ÷ `netAssetValue`. - cash.reserve: number; default: not declared - cash.residualAmount: number; default: not declared — Post-trade cash minus `targetAmount`: rounding residuals + dust residuals; negative when the buys are not funded (then `feasible` is false). - cash.targetAmount: number; default: not declared — `reserve + targetWeight × netAssetValue` — the cash the plan intends to hold. - cash.targetWeight: number; default: not declared - diagnostics: { dustCount: number; instrumentCount: number; tradeCount: number; unresolvedCount: number; warnings: string[]; }; default: not declared - diagnostics.dustCount: number; default: not declared - diagnostics.instrumentCount: number; default: not declared - diagnostics.tradeCount: number; default: not declared - diagnostics.unresolvedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - dust: AllocationDustRow[]; default: not declared — Sorted by instrumentId. - estimatedTransactionCost: number; default: not declared - feasible: boolean; default: not declared — No unresolved target AND the buys are funded (cash residual ≥ 0). - netAssetValue: number; default: not declared - trades: AllocationTrade[]; default: not declared — Sorted by instrumentId; dust and zero trades excluded. - turnover: number; default: not declared — `Σ |trade notional| ÷ netAssetValue` (buys and sells both counted). - unresolved: UnresolvedTarget[]; default: not declared — Sorted by key, then reason. ### @insiderfinance/totalfinance/portfolio#AllocationCash Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AllocationCash { targetWeight: number; reserve: number; /** `reserve + targetWeight × netAssetValue` — the cash the plan intends to hold. */ targetAmount: number; /** * Post-trade cash minus `targetAmount`: rounding residuals + dust residuals; negative when the * buys are not funded (then `feasible` is false). */ residualAmount: number; /** Post-trade cash ÷ `netAssetValue`. */ achievedWeight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - achievedWeight: number; default: not declared — Post-trade cash ÷ `netAssetValue`. - reserve: number; default: not declared - residualAmount: number; default: not declared — Post-trade cash minus `targetAmount`: rounding residuals + dust residuals; negative when the buys are not funded (then `feasible` is false). - targetAmount: number; default: not declared — `reserve + targetWeight × netAssetValue` — the cash the plan intends to hold. - targetWeight: number; default: not declared ### @insiderfinance/totalfinance/portfolio#AllocationDustRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AllocationDustRow { instrumentId: string; /** The skipped trade's signed base-currency notional (+ an unspent buy, − an unraised sell). */ tradeNotional: number; reason: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - reason: string; default: not declared - tradeNotional: number; default: not declared — The skipped trade's signed base-currency notional (+ an unspent buy, − an unraised sell). ### @insiderfinance/totalfinance/portfolio#AllocationPrice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One instrument's price at the allocation instant, in its trading currency. ```typescript // --------------------------------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------------------------------- /** One instrument's price at the allocation instant, in its trading currency. */ export interface AllocationPrice { /** Finite; sign unconstrained (a target on a non-positive price is reported unresolved). */ price: number; currency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - price: number; default: not declared — Finite; sign unconstrained (a target on a non-positive price is reported unresolved). ### @insiderfinance/totalfinance/portfolio#AllocationRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One instrument's sizing. Notionals are base currency. ```typescript /** One instrument's sizing. Notionals are base currency. */ export interface AllocationRow { instrumentId: string; targetWeight: number; /** `targetWeight × netAssetValue`. */ targetNotional: number; /** The supplied price, in `currency`. */ price: number; currency: string; priceInBaseCurrency: number; /** Units of the underlying per unit of quantity (1 unless the caller declared a multiplier). */ contractMultiplier: number; currentQuantity: number; /** The rounded target quantity (toward zero to `lotSize`). */ targetQuantity: number; /** `targetQuantity − currentQuantity` (signed: + buy, − sell); 0 when the trade is dust. */ tradeQuantity: number; /** `tradeQuantity × priceInBaseCurrency` (signed). */ tradeNotional: number; lotSize: number | null; /** `(unrounded target quantity − targetQuantity) × priceInBaseCurrency` — stays in cash. */ roundingResidualNotional: number; /** The post-trade weight of NAV (the CURRENT weight when the trade is dust). */ achievedWeight: number; dust: boolean; sourceGroups: string[]; implied: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - achievedWeight: number; default: not declared — The post-trade weight of NAV (the CURRENT weight when the trade is dust). - contractMultiplier: number; default: not declared — Units of the underlying per unit of quantity (1 unless the caller declared a multiplier). - currency: string; default: not declared - currentQuantity: number; default: not declared - dust: boolean; default: not declared - implied: boolean; default: not declared - instrumentId: string; default: not declared - lotSize: number | null; default: not declared - price: number; default: not declared — The supplied price, in `currency`. - priceInBaseCurrency: number; default: not declared - roundingResidualNotional: number; default: not declared — `(unrounded target quantity − targetQuantity) × priceInBaseCurrency` — stays in cash. - sourceGroups: string[]; default: not declared - targetNotional: number; default: not declared — `targetWeight × netAssetValue`. - targetQuantity: number; default: not declared — The rounded target quantity (toward zero to `lotSize`). - targetWeight: number; default: not declared - tradeNotional: number; default: not declared — `tradeQuantity × priceInBaseCurrency` (signed). - tradeQuantity: number; default: not declared — `targetQuantity − currentQuantity` (signed: + buy, − sell); 0 when the trade is dust. ### @insiderfinance/totalfinance/portfolio#AllocationSizing Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The validated sizing grammar. `null` = not supplied (fractional quantities / no dust threshold). ```typescript // --------------------------------------------------------------------------------------------------- // Shared sizing grammar (validation + arithmetic reused by the rebalance proposal) // --------------------------------------------------------------------------------------------------- /** The validated sizing grammar. `null` = not supplied (fractional quantities / no dust threshold). */ export interface AllocationSizing { lotSizes: Record; defaultLotSize: number | null; minimumNotional: number | null; transactionCosts: Required; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - defaultLotSize: number | null; default: not declared - lotSizes: Record; default: not declared - minimumNotional: number | null; default: not declared - transactionCosts: Required; default: not declared - transactionCosts.commissionPerTrade: number; default: not declared — Base-currency commission per non-zero trade. - transactionCosts.commissionPerUnit: number; default: not declared — Base-currency commission per unit traded (× |quantity|). - transactionCosts.slippageBasisPoints: number; default: not declared — Market-impact/slippage cost in basis points of |notional|. - transactionCosts.spreadBasisPoints: number; default: not declared — Half-spread cost in basis points of |notional|. ### @insiderfinance/totalfinance/portfolio#AllocationSizingInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The sizing grammar {@link allocatePortfolio} and `proposePortfolioRebalance` share. ```typescript /** The sizing grammar {@link allocatePortfolio} and `proposePortfolioRebalance` share. */ export interface AllocationSizingInput { /** Lot size per instrument (> 0, finite). */ lotSizes?: Record; /** Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. */ defaultLotSize?: number; /** Base-currency notional below which a trade is dust (skipped and reported). */ minimumNotional?: number; transactionCosts?: AllocationTransactionCosts; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - transactionCosts?: AllocationTransactionCosts; default: not declared - transactionCosts.commissionPerTrade?: number; default: not declared — Base-currency commission per non-zero trade. - transactionCosts.commissionPerUnit?: number; default: not declared — Base-currency commission per unit traded (× |quantity|). - transactionCosts.slippageBasisPoints?: number; default: not declared — Market-impact/slippage cost in basis points of |notional|. - transactionCosts.spreadBasisPoints?: number; default: not declared — Half-spread cost in basis points of |notional|. ### @insiderfinance/totalfinance/portfolio#AllocationTarget Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One allocation goal. Exactly one of `weight` (share of NAV) or `riskBudget` (share of risk). ```typescript /** One allocation goal. Exactly one of `weight` (share of NAV) or `riskBudget` (share of risk). */ export interface AllocationTarget { group: TargetGroup; /** Target weight as a decimal fraction of net asset value (negative = short target). */ weight?: number; /** * Target share of total portfolio risk (decimal). Carried on the artifact; this build's * portfolio-side calls act on WEIGHTS and report a risk-budget target as unresolved — turning a * risk budget into weights needs a covariance, which lives on the risk side (`@insiderfinance/totalfinance/risk`). */ riskBudget?: number; /** Absolute drift band for this target (decimal of NAV); overrides the policy's `driftBand`. */ driftBand?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - driftBand?: number; default: not declared — Absolute drift band for this target (decimal of NAV); overrides the policy's `driftBand`. - group: TargetGroup; default: not declared - group.assetClass?: string; default: not declared - group.currency?: string; default: not declared - group.instrumentId?: string; default: not declared - group.sleeveId?: string; default: not declared - group.strategy?: string; default: not declared - group.tag?: string; default: not declared - group.underlying?: string; default: not declared - riskBudget?: number; default: not declared — Target share of total portfolio risk (decimal). Carried on the artifact; this build's portfolio-side calls act on WEIGHTS and report a risk-budget target as unresolved — turning a risk budget into weights needs a covariance, which lives on the risk side (`@insiderfinance/totalfinance/risk`). - weight?: number; default: not declared — Target weight as a decimal fraction of net asset value (negative = short target). ### @insiderfinance/totalfinance/portfolio#AllocationTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AllocationTrade { instrumentId: string; side: 'buy' | 'sell'; /** Unsigned magnitude. */ quantity: number; /** `quantity × priceInBaseCurrency`, base currency. */ estimatedNotional: number; /** The instrument's trading currency (the price's currency). */ currency: string; /** Base-currency estimate under the cost model. */ estimatedCost: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared — The instrument's trading currency (the price's currency). - estimatedCost: number; default: not declared — Base-currency estimate under the cost model. - estimatedNotional: number; default: not declared — `quantity × priceInBaseCurrency`, base currency. - instrumentId: string; default: not declared - quantity: number; default: not declared — Unsigned magnitude. - side: 'buy' | 'sell'; default: not declared ### @insiderfinance/totalfinance/portfolio#AllocationTransactionCosts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The transaction-cost model — every term optional and explicit; an omitted term estimates 0. ```typescript /** The transaction-cost model — every term optional and explicit; an omitted term estimates 0. */ export interface AllocationTransactionCosts { /** Base-currency commission per non-zero trade. */ commissionPerTrade?: number; /** Base-currency commission per unit traded (× |quantity|). */ commissionPerUnit?: number; /** Half-spread cost in basis points of |notional|. */ spreadBasisPoints?: number; /** Market-impact/slippage cost in basis points of |notional|. */ slippageBasisPoints?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commissionPerTrade?: number; default: not declared — Base-currency commission per non-zero trade. - commissionPerUnit?: number; default: not declared — Base-currency commission per unit traded (× |quantity|). - slippageBasisPoints?: number; default: not declared — Market-impact/slippage cost in basis points of |notional|. - spreadBasisPoints?: number; default: not declared — Half-spread cost in basis points of |notional|. ### @insiderfinance/totalfinance/portfolio#ApplyJournalEventsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ApplyJournalEventsInput { events: readonly ExecutionJournalEvent[]; previousState?: ExecutionJournalState; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - events: readonly ExecutionJournalEvent[]; default: not declared - previousState?: ExecutionJournalState; default: not declared - previousState.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - previousState.eventCount: number; default: not declared - previousState.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - previousState.journalId: string | null; default: not declared — Null until the first event. - previousState.orders: Record; default: not declared - previousState.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. ### @insiderfinance/totalfinance/portfolio#ApplyJournalEventsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ApplyJournalEventsResult { state: ExecutionJournalState; applied: number; duplicates: string[]; lateFills: { orderId: string; fillId: string; eventId: string; }[]; diagnostics: { warnings: string[]; eventCount: number; orderCount: number; duplicateCount: number; lateFillCount: number; unresolvedCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - applied: number; default: not declared - diagnostics: { duplicateCount: number; eventCount: number; lateFillCount: number; orderCount: number; unresolvedCount: number; warnings: string[]; }; default: not declared - diagnostics.duplicateCount: number; default: not declared - diagnostics.eventCount: number; default: not declared - diagnostics.lateFillCount: number; default: not declared - diagnostics.orderCount: number; default: not declared - diagnostics.unresolvedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - duplicates: string[]; default: not declared - lateFills: { orderId: string; fillId: string; eventId: string; }[]; default: not declared - state: ExecutionJournalState; default: not declared - state.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - state.eventCount: number; default: not declared - state.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - state.journalId: string | null; default: not declared — Null until the first event. - state.orders: Record; default: not declared - state.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. ### @insiderfinance/totalfinance/portfolio#ApplyPortfolioEventsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link applyPortfolioEvents}: exactly ONE of `portfolio` (fresh) or `previousState`. ```typescript /** Input for {@link applyPortfolioEvents}: exactly ONE of `portfolio` (fresh) or `previousState`. */ export interface ApplyPortfolioEventsInput { portfolio?: PortfolioDefinition; previousState?: PortfolioState; events: readonly PortfolioEventEnvelope[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - events: readonly PortfolioEventEnvelope[]; default: not declared - portfolio?: PortfolioDefinition; default: not declared - portfolio.baseCurrency: string; default: not declared - portfolio.lotRelief?: LotReliefPolicy; default: not declared — Defaults to `'fifo'` (documented; echoed on the state and every ledger envelope). - portfolio.portfolioId?: string; default: not declared - previousState?: PortfolioState; default: not declared - previousState.accountMigrations: AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - previousState.accounts: Record; default: not declared - previousState.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - previousState.baseCurrency: string; default: not declared - previousState.eventCount: number; default: not declared - previousState.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - previousState.lastEffectiveTimestampMs: number | null; default: not declared - previousState.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - previousState.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - previousState.portfolioId?: string; default: not declared - previousState.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - previousState.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#AuthorizationGrant Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Human authority bound to one plan, one preflight, and the snapshots they were judged against. ```typescript /** Human authority bound to one plan, one preflight, and the snapshots they were judged against. */ export interface AuthorizationGrant { kind: typeof AUTHORIZATION_GRANT_KIND; schemaVersion: typeof AUTHORIZATION_GRANT_SCHEMA_VERSION; grantId: string; planHash: string; preflightHash: string; portfolioHash: string; marketHash: string; /** The market instant the preflight judged; execution must not see an older market. */ marketAsOf: EpochMs; /** At execution the market may be at most this old (`now − marketAsOf`). */ marketMaximumAgeMs: number; mode: 'paper'; accountId: string; baseCurrency: string; /** The plan's order ids, in plan order. */ orderIds: string[]; /** The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. */ comboIds: string[]; variance: GrantVariance; issuedAt: EpochMs; expiresAt: EpochMs; approvedBy: string; /** The scope the preflight asked for (`require-approval`), or null when it allowed outright. */ requiredScope: string | null; /** The closed set of submission keys this grant licenses — one per attempt. */ idempotencyKeys: string[]; contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - approvedBy: string; default: not declared - baseCurrency: string; default: not declared - comboIds: string[]; default: not declared — The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. - contentHash: string; default: not declared - expiresAt: number; default: not declared - grantId: string; default: not declared - idempotencyKeys: string[]; default: not declared — The closed set of submission keys this grant licenses — one per attempt. - issuedAt: number; default: not declared - kind: 'totalfinance.authorization-grant'; default: not declared - marketAsOf: number; default: not declared — The market instant the preflight judged; execution must not see an older market. - marketHash: string; default: not declared - marketMaximumAgeMs: number; default: not declared — At execution the market may be at most this old (`now − marketAsOf`). - mode: 'paper'; default: not declared - orderIds: string[]; default: not declared — The plan's order ids, in plan order. - planHash: string; default: not declared - portfolioHash: string; default: not declared - preflightHash: string; default: not declared - requiredScope: string | null; default: not declared — The scope the preflight asked for (`require-approval`), or null when it allowed outright. - schemaVersion: 1; default: not declared - variance: GrantVariance; default: not declared - variance.maximumNotionalRatio: number; default: not declared — `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. - variance.maximumQuantityRatio: number; default: not declared — `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). - variance.maximumSlippageBps: number; default: not declared — A limit price may sit at most this many bps from the plan's reference price. ### @insiderfinance/totalfinance/portfolio#BenchmarkConstituent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BenchmarkConstituent { instrumentId: string; weight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/portfolio#BenchmarkIdentity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Benchmark identity — a name and, when known, its dated membership. ```typescript /** Benchmark identity — a name and, when known, its dated membership. */ export interface BenchmarkIdentity { benchmarkId: string; /** The instant the membership below is stated at. */ asOf?: EpochMs | string; /** Constituent weights (sum to 1) — the identity a tracking comparison is made against. */ constituents?: BenchmarkConstituent[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: string | number; default: not declared — The instant the membership below is stated at. - benchmarkId: string; default: not declared - constituents?: BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. ### @insiderfinance/totalfinance/portfolio#CashBalance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One currency's cash: the booked total plus the settlement schedule of its dated legs. ```typescript /** One currency's cash: the booked total plus the settlement schedule of its dated legs. */ export interface CashBalance { /** The booked balance including not-yet-settled legs. May be negative (margin/overdraft). */ totalAmount: number; settlementSchedule: ScheduledSettlement[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - settlementSchedule: ScheduledSettlement[]; default: not declared - totalAmount: number; default: not declared — The booked balance including not-yet-settled legs. May be negative (margin/overdraft). ### @insiderfinance/totalfinance/portfolio#CashConversionEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A realized FX conversion between two cash balances of one account. Both legs are explicit amounts — the realized rate is `toAmount / fromAmount`; no rate arithmetic is guessed here. ```typescript /** * A realized FX conversion between two cash balances of one account. Both legs are explicit * amounts — the realized rate is `toAmount / fromAmount`; no rate arithmetic is guessed here. */ export interface CashConversionEvent { eventType: 'cash.conversion'; fromCurrency: string; toCurrency: string; /** Magnitude of `fromCurrency` sold, > 0. */ fromAmount: number; /** Magnitude of `toCurrency` received, > 0. */ toAmount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'cash.conversion'; default: not declared - fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - fromCurrency: string; default: not declared - toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - toCurrency: string; default: not declared ### @insiderfinance/totalfinance/portfolio#CashDepositEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). External money INTO the portfolio — an external flow, never investment profit (FC4's law). ```typescript // --------------------------------------------------------------------------------------------------- // Event payloads (closed discriminated union) // --------------------------------------------------------------------------------------------------- /** External money INTO the portfolio — an external flow, never investment profit (FC4's law). */ export interface CashDepositEvent { eventType: 'cash.deposit'; /** Magnitude deposited, > 0, in `currency`. */ amount: number; currency: string; /** When the cash leg settles; omitted = settled at `effectiveTimestampMs`. */ settleTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. - currency: string; default: not declared - eventType: 'cash.deposit'; default: not declared - settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. ### @insiderfinance/totalfinance/portfolio#CashDifference Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CashDifference { currency: string; ledgerTotal: number; ledgerSettled: number; ledgerUnsettledReceivable: number; ledgerUnsettledPayable: number; externalTotal: number; externalSettled: number | null; /** `externalTotal − ledgerTotal`. */ totalDifference: number; /** `externalSettled − ledgerSettled`, `null` when the source reports no settled figure. */ settledDifference: number | null; withinTolerance: boolean; explanation?: ReconciliationExplanation; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - explanation?: ReconciliationExplanation; default: not declared - explanation.detail: string; default: not declared - explanation.kind: ('corporate-action-candidate') | ('pending-settlement'); default: not declared - explanation.ratio: number; default: not declared - externalSettled: number | null; default: not declared - externalTotal: number; default: not declared - ledgerSettled: number; default: not declared - ledgerTotal: number; default: not declared - ledgerUnsettledPayable: number; default: not declared - ledgerUnsettledReceivable: number; default: not declared - settledDifference: number | null; default: not declared — `externalSettled − ledgerSettled`, `null` when the source reports no settled figure. - totalDifference: number; default: not declared — `externalTotal − ledgerTotal`. - withinTolerance: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio#CashInLieuEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cash in lieu of a fractional quantity surrendered (after a split, merger, or spin-off). ```typescript /** Cash in lieu of a fractional quantity surrendered (after a split, merger, or spin-off). */ export interface CashInLieuEvent { eventType: 'corporate.cash-in-lieu'; instrumentId: string; /** Fractional quantity surrendered, > 0. */ quantity: number; /** Cash received, in `currency`. */ amount: number; currency: string; relatesToEventId?: string; settleTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Cash received, in `currency`. - currency: string; default: not declared - eventType: 'corporate.cash-in-lieu'; default: not declared - instrumentId: string; default: not declared - quantity: number; default: not declared — Fractional quantity surrendered, > 0. - relatesToEventId?: string; default: not declared - settleTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#CashTransferEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cash moved between two accounts of the SAME portfolio — internal, never an external flow. ```typescript /** Cash moved between two accounts of the SAME portfolio — internal, never an external flow. */ export interface CashTransferEvent { eventType: 'cash.transfer'; /** Magnitude transferred, > 0, in `currency`. */ amount: number; currency: string; /** Must equal the envelope's `accountId` — the account the transfer leaves. */ fromAccountId: string; toAccountId: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Magnitude transferred, > 0, in `currency`. - currency: string; default: not declared - eventType: 'cash.transfer'; default: not declared - fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - toAccountId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#CashWithdrawalEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). External money OUT of the portfolio — an external flow, never investment loss. ```typescript /** External money OUT of the portfolio — an external flow, never investment loss. */ export interface CashWithdrawalEvent { eventType: 'cash.withdrawal'; /** Magnitude withdrawn, > 0, in `currency`. */ amount: number; currency: string; settleTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Magnitude withdrawn, > 0, in `currency`. - currency: string; default: not declared - eventType: 'cash.withdrawal'; default: not declared - settleTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#CompareDisclosedHoldingPartitionsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CompareDisclosedHoldingPartitionsInput { baseline: DisclosedHoldingPartitionsSnapshot; current: DisclosedHoldingPartitionsSnapshot; comparisonMode: 'reported-period-change' | 'same-period-revision'; policy: DisclosedHoldingPartitionsPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseline: DisclosedHoldingPartitionsSnapshot; default: not declared - baseline.comparisonEligible: boolean; default: not declared — Caller attests that upstream source/report-selection review permits using this snapshot for the requested comparison (including amendment selection and known disclosure limitations). The SDK does not authenticate evidence or select reports. Unknown means false; explain known issues in reviewReasons. True never overrides row reviews, reference scope or changed bases. All three flags gate totals/weights; both snapshots must pass before absence or deltas are inferred. - baseline.evidenceIds: readonly string[]; default: not declared - baseline.holdings: readonly DisclosedHoldingPartition[]; default: not declared - baseline.managerId: string; default: not declared - baseline.mappingComplete: boolean; default: not declared — Caller attests that every supplied holding has an authenticated issuer/security/class mapping. Keep unresolved rows in holdings; never drop them to make this true. The library also checks consumed mapping fields and conflicts. Unknown means false. - baseline.periodEnd: string; default: not declared — Strict YYYY-MM-DD reporting date, not an availability timestamp. - baseline.reportComplete: boolean; default: not declared — Caller attests that holdings contains the entire selected reported universe for this period, not a page, filtered subset, or a report with known withheld/missing holdings. This does not assert that a disclosure covers all of the manager's economic assets. Unknown means false. - baseline.reportIds: readonly string[]; default: not declared - baseline.reviewReasons: readonly string[]; default: not declared - comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - current: DisclosedHoldingPartitionsSnapshot; default: not declared - current.comparisonEligible: boolean; default: not declared — Caller attests that upstream source/report-selection review permits using this snapshot for the requested comparison (including amendment selection and known disclosure limitations). The SDK does not authenticate evidence or select reports. Unknown means false; explain known issues in reviewReasons. True never overrides row reviews, reference scope or changed bases. All three flags gate totals/weights; both snapshots must pass before absence or deltas are inferred. - current.evidenceIds: readonly string[]; default: not declared - current.holdings: readonly DisclosedHoldingPartition[]; default: not declared - current.managerId: string; default: not declared - current.mappingComplete: boolean; default: not declared — Caller attests that every supplied holding has an authenticated issuer/security/class mapping. Keep unresolved rows in holdings; never drop them to make this true. The library also checks consumed mapping fields and conflicts. Unknown means false. - current.periodEnd: string; default: not declared — Strict YYYY-MM-DD reporting date, not an availability timestamp. - current.reportComplete: boolean; default: not declared — Caller attests that holdings contains the entire selected reported universe for this period, not a page, filtered subset, or a report with known withheld/missing holdings. This does not assert that a disclosure covers all of the manager's economic assets. Unknown means false. - current.reportIds: readonly string[]; default: not declared - current.reviewReasons: readonly string[]; default: not declared - policy: DisclosedHoldingPartitionsPolicy; default: not declared - policy.discretionPolicy: 'reported-partitions-without-cross-manager-netting'; default: not declared - policy.ratioDecimalPlaces: number; default: not declared — Ratios rounded once, half away from zero, to this many decimal places (0–18). - policy.supportedProfile: 'common-stock-reported-partitions-v1'; default: not declared ### @insiderfinance/totalfinance/portfolio#CompareDisclosedHoldingsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CompareDisclosedHoldingsInput { baseline: DisclosedHoldingsSnapshot; current: DisclosedHoldingsSnapshot; comparisonMode: 'reported-period-change' | 'same-period-revision'; policy: DisclosedHoldingsPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseline: DisclosedHoldingsSnapshot; default: not declared - baseline.comparisonEligible: boolean; default: not declared - baseline.evidenceIds: readonly string[]; default: not declared - baseline.holdings: readonly DisclosedHolding[]; default: not declared - baseline.managerId: string; default: not declared - baseline.mappingComplete: boolean; default: not declared - baseline.periodEnd: string; default: not declared — Strict YYYY-MM-DD reporting date, not an availability timestamp. - baseline.reportComplete: boolean; default: not declared - baseline.reportIds: readonly string[]; default: not declared - baseline.reviewReasons: readonly string[]; default: not declared - comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - current: DisclosedHoldingsSnapshot; default: not declared - current.comparisonEligible: boolean; default: not declared - current.evidenceIds: readonly string[]; default: not declared - current.holdings: readonly DisclosedHolding[]; default: not declared - current.managerId: string; default: not declared - current.mappingComplete: boolean; default: not declared - current.periodEnd: string; default: not declared — Strict YYYY-MM-DD reporting date, not an availability timestamp. - current.reportComplete: boolean; default: not declared - current.reportIds: readonly string[]; default: not declared - current.reviewReasons: readonly string[]; default: not declared - policy: DisclosedHoldingsPolicy; default: not declared - policy.discretionPolicy: 'sole-without-other-managers'; default: not declared - policy.ratioDecimalPlaces: number; default: not declared — Ratios rounded once, half away from zero, to this many decimal places (0–18). - policy.supportedProfile: 'common-stock-shares-v1'; default: not declared ### @insiderfinance/totalfinance/portfolio#ContractMultiplierChangeEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A contract adjustment rescales the multiplier; total basis is preserved exactly. ```typescript /** A contract adjustment rescales the multiplier; total basis is preserved exactly. */ export interface ContractMultiplierChangeEvent { eventType: 'derivative.multiplier-change'; instrumentId: string; contractMultiplierAfter: number; /** An adjusted strike (OCC-style adjustments change both); only for a position with option terms. */ strikePricePerUnitAfter?: number; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contractMultiplierAfter: number; default: not declared - eventType: 'derivative.multiplier-change'; default: not declared - instrumentId: string; default: not declared - reason?: string; default: not declared - strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. ### @insiderfinance/totalfinance/portfolio#ContributionHandling Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ContributionHandling = 'invest-to-targets' | 'hold-as-cash'; ``` ### @insiderfinance/totalfinance/portfolio#CostChargeEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An explicit transaction cost — a SEPARATE event, never folded into lot cost basis (FC7 mandatory state: costs are separate components), attributed via `instrumentId`/`relatesToEventId`. ```typescript /** * An explicit transaction cost — a SEPARATE event, never folded into lot cost basis (FC7 * mandatory state: costs are separate components), attributed via `instrumentId`/`relatesToEventId`. */ export interface CostChargeEvent { eventType: 'cost.charge'; costType: CostType; /** Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. */ amount: number; currency: string; instrumentId?: string; /** The `eventId` of the fill (or other event) this cost belongs to, when known. */ relatesToEventId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. - costType: CostType; default: not declared - currency: string; default: not declared - eventType: 'cost.charge'; default: not declared - instrumentId?: string; default: not declared - relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. ### @insiderfinance/totalfinance/portfolio#CostType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CostType = 'commission' | 'exchange-fee' | 'regulatory-fee' | 'slippage-adjustment'; ``` ### @insiderfinance/totalfinance/portfolio#CreateAuthorizationGrantInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CreateAuthorizationGrantInput { plan: ExecutionPlan; preflight: PreflightReport; /** Defaults to the preflight's; given, it must match (a grant binds what preflight saw). */ portfolioHash?: string; /** Defaults to the preflight's; given, it must match. */ marketHash?: string; marketMaximumAgeMs: number; mode: 'paper'; /** Defaults to the plan's account; given, it must match. */ account?: string; variance: GrantVariance; expiresAt: EpochMs; approvedBy: string; idempotencyKeys: string[] | { prefix: string; count: number; }; /** The issue instant — supplied, never read from a clock. */ now: EpochMs; /** Default `grant::`. */ grantId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared — Defaults to the plan's account; given, it must match. - approvedBy: string; default: not declared - expiresAt: number; default: not declared - grantId?: string; default: not declared — Default `grant::`. - idempotencyKeys: string[] | { count: number; prefix: string; }; default: not declared - idempotencyKeys.count: number; default: not declared - idempotencyKeys.prefix: string; default: not declared - marketHash?: string; default: not declared — Defaults to the preflight's; given, it must match. - marketMaximumAgeMs: number; default: not declared - mode: 'paper'; default: not declared - now: number; default: not declared — The issue instant — supplied, never read from a clock. - plan: ExecutionPlan; default: not declared - plan.accountId: string; default: not declared - plan.asOf: number; default: not declared - plan.baseCurrency: string; default: not declared - plan.combos: ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - plan.contentHash: string; default: not declared - plan.evidence: string[]; default: not declared - plan.kind: 'totalfinance.execution-plan'; default: not declared - plan.orders: TradeOrder[]; default: not declared - plan.portfolioId?: string; default: not declared - plan.rationale?: string; default: not declared - plan.schemaVersion: number; default: not declared - plan.source: ExecutionPlanSource; default: not declared - plan.source.intentHash: string; default: not declared - plan.source.kind: ('intent') | ('rebalance-proposal'); default: not declared - plan.source.planHash: string; default: not declared - plan.source.policyContentHash: string; default: not declared - plan.trades: TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. - portfolioHash?: string; default: not declared — Defaults to the preflight's; given, it must match (a grant binds what preflight saw). - preflight: PreflightReport; default: not declared - preflight.after: PortfolioSnapshotResult; default: not declared - preflight.after.asOf: number; default: not declared - preflight.after.assumptions: { conventionsVersion: string; currencyConversionsUsed: CurrencyPairQuote[]; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; marketAsOf: EpochMs; valuationConvention: string; }; default: not declared - preflight.after.assumptions.conventionsVersion: string; default: not declared - preflight.after.assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - preflight.after.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - preflight.after.assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - preflight.after.assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - preflight.after.baseCurrency: string; default: not declared - preflight.after.cash: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - preflight.after.diagnostics: { accountCount: number; positionCount: number; warnings: string[]; }; default: not declared - preflight.after.diagnostics.accountCount: number; default: not declared - preflight.after.diagnostics.positionCount: number; default: not declared - preflight.after.diagnostics.warnings: string[]; default: not declared - preflight.after.netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - preflight.after.positions: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - preflight.after.totalCashBaseCurrencyValue: number; default: not declared - preflight.after.totalPositionsBaseCurrencyValue: number; default: not declared - preflight.alerts: MonitorAlert[]; default: not declared - preflight.asOf: number; default: not declared - preflight.assumptions: { conventionsVersion: string; costRates: Required; decisionConvention: string; fillConvention: string; instrumentSources: Record; mode: 'paper'; policyContentHash: string; }; default: not declared - preflight.assumptions.conventionsVersion: string; default: not declared - preflight.assumptions.costRates: Required; default: not declared - preflight.assumptions.costRates.commissionBps: number; default: not declared - preflight.assumptions.costRates.commissionPerOrder: number; default: not declared - preflight.assumptions.costRates.slippageBps: number; default: not declared - preflight.assumptions.costRates.spreadBps: number; default: not declared - preflight.assumptions.decisionConvention: string; default: not declared - preflight.assumptions.fillConvention: string; default: not declared - preflight.assumptions.instrumentSources: Record; default: not declared — Where each instrument's currency and multiplier came from: the ledger position, the caller's description, or the market spot (priced as a plain cash instrument). - preflight.assumptions.mode: 'paper'; default: not declared - preflight.assumptions.policyContentHash: string; default: not declared - preflight.before: PortfolioSnapshotResult; default: not declared - preflight.before.asOf: number; default: not declared - preflight.before.assumptions: { conventionsVersion: string; currencyConversionsUsed: CurrencyPairQuote[]; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; marketAsOf: EpochMs; valuationConvention: string; }; default: not declared - preflight.before.assumptions.conventionsVersion: string; default: not declared - preflight.before.assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - preflight.before.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - preflight.before.assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - preflight.before.assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - preflight.before.baseCurrency: string; default: not declared - preflight.before.cash: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - preflight.before.diagnostics: { accountCount: number; positionCount: number; warnings: string[]; }; default: not declared - preflight.before.diagnostics.accountCount: number; default: not declared - preflight.before.diagnostics.positionCount: number; default: not declared - preflight.before.diagnostics.warnings: string[]; default: not declared - preflight.before.netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - preflight.before.positions: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - preflight.before.totalCashBaseCurrencyValue: number; default: not declared - preflight.before.totalPositionsBaseCurrencyValue: number; default: not declared - preflight.checks: PolicyCheck[]; default: not declared - preflight.contentHash: string; default: not declared - preflight.decision: PolicyDecision; default: not declared - preflight.decision.checks: PolicyCheck[]; default: not declared - preflight.decision.requiredScope: string; default: not declared - preflight.decision.verdict: ('allow') | ('deny') | ('require-approval'); default: not declared - preflight.diagnostics: { checkCount: number; converged: true; engine: 'trade-preflight'; failedCount: number; method: 'hypothetical-fold'; unverifiableCount: number; warnings: QuantWarning[]; }; default: not declared - preflight.diagnostics.checkCount: number; default: not declared - preflight.diagnostics.converged: true; default: not declared - preflight.diagnostics.engine: 'trade-preflight'; default: not declared - preflight.diagnostics.failedCount: number; default: not declared - preflight.diagnostics.method: 'hypothetical-fold'; default: not declared - preflight.diagnostics.unverifiableCount: number; default: not declared - preflight.diagnostics.warnings: QuantWarning[]; default: not declared - preflight.estimates: PreflightEstimates; default: not declared - preflight.estimates.commission: number; default: not declared - preflight.estimates.slippage: number; default: not declared - preflight.estimates.spread: number; default: not declared - preflight.estimates.totalCost: number; default: not declared - preflight.estimates.tradedNotional: number; default: not declared - preflight.estimates.turnover: number; default: not declared - preflight.hypotheticalEvents: PortfolioEventEnvelope[]; default: not declared - preflight.hypotheticalFills: NormalizedFill[]; default: not declared — The hypothetical fills the after-state was folded from. - preflight.kind: 'totalfinance.preflight-report'; default: not declared - preflight.marketAsOf: number; default: not declared - preflight.marketHash: string; default: not declared - preflight.monitorState: PortfolioMonitorState | null; default: not declared - preflight.monitorState.asOf: number; default: not declared - preflight.monitorState.evaluationCount: number; default: not declared - preflight.monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - preflight.monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - preflight.monitorState.rules: Record; default: not declared - preflight.monitorState.schemaVersion: number; default: not declared - preflight.planHash: string; default: not declared - preflight.portfolioHash: string; default: not declared - preflight.schemaVersion: number; default: not declared - preflight.unverifiable: string[]; default: not declared - variance: GrantVariance; default: not declared - variance.maximumNotionalRatio: number; default: not declared — `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. - variance.maximumQuantityRatio: number; default: not declared — `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). - variance.maximumSlippageBps: number; default: not declared — A limit price may sit at most this many bps from the plan's reference price. ### @insiderfinance/totalfinance/portfolio#CreatePortfolioLedgerInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link createPortfolioLedger}. ```typescript /** Input for {@link createPortfolioLedger}. */ export interface CreatePortfolioLedgerInput { portfolioId?: string; baseCurrency: string; /** Defaults to `'fifo'`; echoed on the artifact, the state, and every serialized envelope. */ lotRelief?: LotReliefPolicy; events: readonly PortfolioEventEnvelope[]; provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - events: readonly PortfolioEventEnvelope[]; default: not declared - lotRelief?: LotReliefPolicy; default: not declared — Defaults to `'fifo'`; echoed on the artifact, the state, and every serialized envelope. - portfolioId?: string; default: not declared - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/portfolio#CurrencyPairQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One spot exchange-rate quote — `@insiderfinance/totalfinance/foreign-exchange`'s (FC5) `CurrencyPairQuote` vocabulary, reused STRUCTURALLY because the FC0 dependency row for `@insiderfinance/totalfinance/portfolio` (`tools/package-graph.test.ts`) allows only core and performance as runtime edges. The fields, semantics, and conversion arithmetic (direct = multiply by `quotePerBase`, inverted = divide) are identical to FC5's, and the parity test in `test/snapshot.test.ts` proves both compile-time mutual assignability and runtime equality with `convertCurrency` — the Gate B precedent of a grammar defined below its owner staying structurally identical (core ↔ risk `Shock`). ```typescript // --------------------------------------------------------------------------------------------------- // Currency codes and the FC5 currency-pair vocabulary (structural reuse) // --------------------------------------------------------------------------------------------------- /** * One spot exchange-rate quote — `@insiderfinance/totalfinance/foreign-exchange`'s (FC5) `CurrencyPairQuote` * vocabulary, reused STRUCTURALLY because the FC0 dependency row for `@insiderfinance/totalfinance/portfolio` * (`tools/package-graph.test.ts`) allows only core and performance as runtime edges. The fields, * semantics, and conversion arithmetic (direct = multiply by `quotePerBase`, inverted = divide) * are identical to FC5's, and the parity test in * `test/snapshot.test.ts` proves both compile-time mutual assignability and runtime equality with * `convertCurrency` — the Gate B precedent of a grammar defined below its owner staying * structurally identical (core ↔ risk `Shock`). */ export interface CurrencyPairQuote { /** Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). */ baseCurrency: string; /** Uppercase three-letter ISO-style code of the currency the price is expressed in. */ quoteCurrency: string; /** Units of quote currency per ONE base unit; must be finite and > 0. */ quotePerBase: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. ### @insiderfinance/totalfinance/portfolio#DerivativeContractTerms Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The terms a derivative position carries from its opening fill. ```typescript /** The terms a derivative position carries from its opening fill. */ export type DerivativeContractTerms = OptionContractTerms | FutureContractTerms | PerpetualContractTerms; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiryTimestampMs: number; default: not declared - kind: ('future') | ('option') | ('perpetual'); default: not declared - strikePricePerUnit: number; default: not declared - type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - underlyingInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#DerivativeRollEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Close a contract and open its successor in one economic event (one provenance). ```typescript /** Close a contract and open its successor in one economic event (one provenance). */ export interface DerivativeRollEvent { eventType: 'derivative.roll'; fromInstrumentId: string; toInstrumentId: string; /** Contracts rolled, > 0. */ quantity: number; closePricePerUnit: number; openPricePerUnit: number; /** Terms of the successor contract (the multiplier and settlement style carry over). */ contract?: DerivativeContractTerms; lotSelections?: TradeFillLotSelection[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - closePricePerUnit: number; default: not declared - contract?: DerivativeContractTerms; default: not declared — Terms of the successor contract (the multiplier and settlement style carry over). - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - eventType: 'derivative.roll'; default: not declared - fromInstrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared - openPricePerUnit: number; default: not declared - quantity: number; default: not declared — Contracts rolled, > 0. - toInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#DerivativeSettlement Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Physical delivery of the underlying at the strike, or cash at an explicit settlement price. ```typescript /** Physical delivery of the underlying at the strike, or cash at an explicit settlement price. */ export type DerivativeSettlement = { kind: 'physical'; } | { kind: 'cash'; settlementPricePerUnit: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: ('cash') | ('physical'); default: not declared - settlementPricePerUnit: number; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHolding Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A source holding observation. Extra metadata is accepted but is not consumed or copied. ```typescript /** A source holding observation. Extra metadata is accepted but is not consumed or copied. */ export interface DisclosedHolding { holdingId: string; issuerId: string | null; securityId: string | null; classId: string | null; mappingStatus: 'mapped' | 'unresolved'; instrumentType: string; /** Exact nonnegative plain decimal string, at most 100 digits and 18 fractional places. */ quantity: string; quantityUnit: string; /** Exact reported amount before multiplying by valueScale. */ reportedValue: string; valueCurrency: string; /** Explicit multiplier, exactly '1' or '1000'. */ valueScale: '1' | '1000'; putCall: 'none' | 'put' | 'call'; investmentDiscretion: string; otherManagerIds: readonly string[]; evidenceIds: readonly string[]; reviewReasons: readonly string[]; [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classId: string | null; default: not declared - evidenceIds: readonly string[]; default: not declared - holdingId: string; default: not declared - instrumentType: string; default: not declared - investmentDiscretion: string; default: not declared - issuerId: string | null; default: not declared - mappingStatus: 'unresolved' | 'mapped'; default: not declared - otherManagerIds: readonly string[]; default: not declared - putCall: 'none' | 'call' | 'put'; default: not declared - quantity: string; default: not declared — Exact nonnegative plain decimal string, at most 100 digits and 18 fractional places. - quantityUnit: string; default: not declared - reportedValue: string; default: not declared — Exact reported amount before multiplying by valueScale. - reviewReasons: readonly string[]; default: not declared - securityId: string | null; default: not declared - valueCurrency: string; default: not declared - valueScale: '1' | '1000'; default: not declared — Explicit multiplier, exactly '1' or '1000'. ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingChange Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingChange = { issuerId: string | null; securityId: string; classId: string; baselineHoldingIds: string[]; currentHoldingIds: string[]; classification: 'newly_disclosed' | 'still_disclosed' | 'no_longer_disclosed' | 'unknown'; baselineQuantity: string | null; currentQuantity: string | null; quantityDifference: string | null; baselineReportedValue: string | null; currentReportedValue: string | null; valueDifference: string | null; valueCurrency: string | null; reasons: DisclosedHoldingChangeReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baselineHoldingIds: string[]; default: not declared - baselineQuantity: string | null; default: not declared - baselineReportedValue: string | null; default: not declared - classId: string; default: not declared - classification: 'unknown' | 'newly_disclosed' | 'still_disclosed' | 'no_longer_disclosed'; default: not declared - currentHoldingIds: string[]; default: not declared - currentQuantity: string | null; default: not declared - currentReportedValue: string | null; default: not declared - issuerId: string | null; default: not declared - quantityDifference: string | null; default: not declared - reasons: DisclosedHoldingChangeReason[]; default: not declared - securityId: string; default: not declared - valueCurrency: string | null; default: not declared - valueDifference: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingChangeReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Snapshot eligibility codes identify the side; row and currency codes describe the pair. ```typescript /** Snapshot eligibility codes identify the side; row and currency codes describe the pair. */ export type DisclosedHoldingChangeReason = DisclosedHoldingReason | `baseline_${DisclosedHoldingsSnapshotReason}` | `current_${DisclosedHoldingsSnapshotReason}` | 'currency_mismatch'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A source holding observation. Extra metadata is accepted but is not consumed or copied. ```typescript /** A source holding observation. Extra metadata is accepted but is not consumed or copied. */ export interface DisclosedHoldingPartition { holdingId: string; issuerId: string | null; securityId: string | null; classId: string | null; mappingStatus: 'mapped' | 'unresolved'; instrumentType: string; /** Exact nonnegative plain decimal string, at most 100 digits and 18 fractional places. */ quantity: string; quantityUnit: string; /** Exact reported amount before multiplying by valueScale. */ reportedValue: string; valueCurrency: string; /** Explicit multiplier, exactly '1' or '1000'. */ valueScale: '1' | '1000'; putCall: 'none' | 'put' | 'call'; investmentDiscretion: string; sourceReportId: string; otherManagerReferences: readonly string[]; evidenceIds: readonly string[]; reviewReasons: readonly string[]; [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classId: string | null; default: not declared - evidenceIds: readonly string[]; default: not declared - holdingId: string; default: not declared - instrumentType: string; default: not declared - investmentDiscretion: string; default: not declared - issuerId: string | null; default: not declared - mappingStatus: 'unresolved' | 'mapped'; default: not declared - otherManagerReferences: readonly string[]; default: not declared - putCall: 'none' | 'call' | 'put'; default: not declared - quantity: string; default: not declared — Exact nonnegative plain decimal string, at most 100 digits and 18 fractional places. - quantityUnit: string; default: not declared - reportedValue: string; default: not declared — Exact reported amount before multiplying by valueScale. - reviewReasons: readonly string[]; default: not declared - securityId: string | null; default: not declared - sourceReportId: string; default: not declared - valueCurrency: string; default: not declared - valueScale: '1' | '1000'; default: not declared — Explicit multiplier, exactly '1' or '1000'. ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionChange Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingPartitionChange = { partitionKey: DisclosedHoldingPartitionKey; issuerId: string | null; baselineHoldingIds: string[]; currentHoldingIds: string[]; classification: 'newly_disclosed' | 'still_disclosed' | 'no_longer_disclosed' | 'unknown'; baselineQuantity: string | null; currentQuantity: string | null; quantityDifference: string | null; baselineReportedValue: string | null; currentReportedValue: string | null; valueDifference: string | null; valueCurrency: string | null; reasons: DisclosedHoldingPartitionChangeReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baselineHoldingIds: string[]; default: not declared - baselineQuantity: string | null; default: not declared - baselineReportedValue: string | null; default: not declared - classification: 'unknown' | 'newly_disclosed' | 'still_disclosed' | 'no_longer_disclosed'; default: not declared - currentHoldingIds: string[]; default: not declared - currentQuantity: string | null; default: not declared - currentReportedValue: string | null; default: not declared - issuerId: string | null; default: not declared - partitionKey: DisclosedHoldingPartitionKey; default: not declared - partitionKey.classId: string; default: not declared - partitionKey.investmentDiscretion: string; default: not declared - partitionKey.otherManagerReferences: string[]; default: not declared - partitionKey.securityId: string; default: not declared - partitionKey.sourceReportId?: string; default: not declared - quantityDifference: string | null; default: not declared - reasons: DisclosedHoldingPartitionChangeReason[]; default: not declared - valueCurrency: string | null; default: not declared - valueDifference: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionChangeReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Snapshot eligibility codes identify the side; row and currency codes describe the pair. ```typescript /** Snapshot eligibility codes identify the side; row and currency codes describe the pair. */ export type DisclosedHoldingPartitionChangeReason = DisclosedHoldingPartitionReason | `baseline_${DisclosedHoldingPartitionsSnapshotReason}` | `current_${DisclosedHoldingPartitionsSnapshotReason}` | 'currency_mismatch' | 'report_scoped_reference_basis' | 'partition_basis_changed'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionKey Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reported line basis; sourceReportId is present only with filing-local references. ```typescript /** Reported line basis; sourceReportId is present only with filing-local references. */ export type DisclosedHoldingPartitionKey = { securityId: string; classId: string; investmentDiscretion: string; otherManagerReferences: string[]; sourceReportId?: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classId: string; default: not declared - investmentDiscretion: string; default: not declared - otherManagerReferences: string[]; default: not declared - securityId: string; default: not declared - sourceReportId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Library-generated row/position review codes; source reviewReasons remain free-form. ```typescript /** Library-generated row/position review codes; source reviewReasons remain free-form. */ export type DisclosedHoldingPartitionReason = 'unresolved_identity' | 'unsupported_instrument_type' | 'unsupported_quantity_unit' | 'option_position' | 'unsupported_discretion' | 'source_row_review' | 'duplicate_partition' | 'invalid_other_manager_references' | 'conflicting_security_identity'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingPartitionResult = { partitionKey: DisclosedHoldingPartitionKey; issuerId: string | null; holdingIds: string[]; evidenceIds: string[]; quantity: string | null; reportedValue: string | null; valueCurrency: string | null; partitionWeight: string | null; status: 'supported' | 'review'; reasons: DisclosedHoldingPartitionReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - evidenceIds: string[]; default: not declared - holdingIds: string[]; default: not declared - issuerId: string | null; default: not declared - partitionKey: DisclosedHoldingPartitionKey; default: not declared - partitionKey.classId: string; default: not declared - partitionKey.investmentDiscretion: string; default: not declared - partitionKey.otherManagerReferences: string[]; default: not declared - partitionKey.securityId: string; default: not declared - partitionKey.sourceReportId?: string; default: not declared - partitionWeight: string | null; default: not declared - quantity: string | null; default: not declared - reasons: DisclosedHoldingPartitionReason[]; default: not declared - reportedValue: string | null; default: not declared - status: 'review' | 'supported'; default: not declared - valueCurrency: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionRowResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingPartitionRowResult = { holdingId: string; issuerId: string | null; securityId: string | null; classId: string | null; mappingStatus: 'mapped' | 'unresolved'; instrumentType: string; quantity: string; quantityUnit: string; reportedValue: string; valueCurrency: string; valueScale: '1' | '1000'; putCall: 'none' | 'put' | 'call'; investmentDiscretion: string; sourceReportId: string; otherManagerReferences: string[]; partitionKey: DisclosedHoldingPartitionKey | null; evidenceIds: string[]; reviewReasons: string[]; normalizedReportedValue: string; status: 'supported' | 'review'; reasons: DisclosedHoldingPartitionReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classId: string | null; default: not declared - evidenceIds: string[]; default: not declared - holdingId: string; default: not declared - instrumentType: string; default: not declared - investmentDiscretion: string; default: not declared - issuerId: string | null; default: not declared - mappingStatus: 'unresolved' | 'mapped'; default: not declared - normalizedReportedValue: string; default: not declared - otherManagerReferences: string[]; default: not declared - partitionKey: DisclosedHoldingPartitionKey | null; default: not declared - partitionKey.classId: string; default: not declared - partitionKey.investmentDiscretion: string; default: not declared - partitionKey.otherManagerReferences: string[]; default: not declared - partitionKey.securityId: string; default: not declared - partitionKey.sourceReportId?: string; default: not declared - putCall: 'none' | 'call' | 'put'; default: not declared - quantity: string; default: not declared - quantityUnit: string; default: not declared - reasons: DisclosedHoldingPartitionReason[]; default: not declared - reportedValue: string; default: not declared - reviewReasons: string[]; default: not declared - securityId: string | null; default: not declared - sourceReportId: string; default: not declared - status: 'review' | 'supported'; default: not declared - valueCurrency: string; default: not declared - valueScale: '1' | '1000'; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsConcentration Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingPartitionsConcentration = { status: 'available' | 'review'; /** Sum of all supplied reported values, only when the complete supported universe is known. */ denominatorReportedValue: string | null; valueCurrency: string | null; largestPartitionWeight: string | null; /** Sum of squared unrounded reported-value weights, not a percentage. */ partitionHerfindahlIndex: string | null; reasons: DisclosedHoldingPartitionsConcentrationReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - largestPartitionWeight: string | null; default: not declared - partitionHerfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - reasons: DisclosedHoldingPartitionsConcentrationReason[]; default: not declared - status: 'review' | 'available'; default: not declared - valueCurrency: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsConcentrationReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Zero totals additionally withhold ratios, but do not invalidate otherwise justified absence. ```typescript /** Zero totals additionally withhold ratios, but do not invalidate otherwise justified absence. */ export type DisclosedHoldingPartitionsConcentrationReason = DisclosedHoldingPartitionsSnapshotReason | 'zero_denominator'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingPartitionsPolicy = { supportedProfile: 'common-stock-reported-partitions-v1'; discretionPolicy: 'reported-partitions-without-cross-manager-netting'; /** Ratios rounded once, half away from zero, to this many decimal places (0–18). */ ratioDecimalPlaces: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discretionPolicy: 'reported-partitions-without-cross-manager-netting'; default: not declared - ratioDecimalPlaces: number; default: not declared — Ratios rounded once, half away from zero, to this many decimal places (0–18). - supportedProfile: 'common-stock-reported-partitions-v1'; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rich JSON-safe report directly accepted by createAnalysisArtifact. ```typescript /** Rich JSON-safe report directly accepted by createAnalysisArtifact. */ export type DisclosedHoldingPartitionsReport = { policyVersion: 'disclosed-holding-partitions-v1'; comparisonMode: 'reported-period-change' | 'same-period-revision'; baseline: DisclosedHoldingPartitionsSnapshotReport; current: DisclosedHoldingPartitionsSnapshotReport; changes: DisclosedHoldingPartitionChange[]; uncomparedPartitions: DisclosedUncomparedHoldingPartition[]; assumptions: { /** Validated policy used for this report, copied independently of the caller's request. */ policy: DisclosedHoldingPartitionsPolicy; profile: string; discretion: string; denominator: string; rounding: string; changes: string; partitionBasis: string; }; diagnostics: { status: 'complete' | 'review'; warnings: QuantWarning[]; baselineHoldingCount: number; currentHoldingCount: number; changeCount: number; baselinePartitionCount: number; currentPartitionCount: number; uncomparedPartitionCount: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { changes: string; denominator: string; discretion: string; partitionBasis: string; policy: DisclosedHoldingPartitionsPolicy; profile: string; rounding: string; }; default: not declared - assumptions.changes: string; default: not declared - assumptions.denominator: string; default: not declared - assumptions.discretion: string; default: not declared - assumptions.partitionBasis: string; default: not declared - assumptions.policy: DisclosedHoldingPartitionsPolicy; default: not declared — Validated policy used for this report, copied independently of the caller's request. - assumptions.policy.discretionPolicy: 'reported-partitions-without-cross-manager-netting'; default: not declared - assumptions.policy.ratioDecimalPlaces: number; default: not declared — Ratios rounded once, half away from zero, to this many decimal places (0–18). - assumptions.policy.supportedProfile: 'common-stock-reported-partitions-v1'; default: not declared - assumptions.profile: string; default: not declared - assumptions.rounding: string; default: not declared - baseline: DisclosedHoldingPartitionsSnapshotReport; default: not declared - baseline.comparisonEligible: boolean; default: not declared - baseline.concentration: DisclosedHoldingPartitionsConcentration; default: not declared - baseline.concentration.denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - baseline.concentration.largestPartitionWeight: string | null; default: not declared - baseline.concentration.partitionHerfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - baseline.concentration.reasons: DisclosedHoldingPartitionsConcentrationReason[]; default: not declared - baseline.concentration.status: 'review' | 'available'; default: not declared - baseline.concentration.valueCurrency: string | null; default: not declared - baseline.evidenceIds: string[]; default: not declared - baseline.holdings: DisclosedHoldingPartitionRowResult[]; default: not declared - baseline.managerId: string; default: not declared - baseline.mappingComplete: boolean; default: not declared - baseline.partitions: DisclosedHoldingPartitionResult[]; default: not declared - baseline.periodEnd: string; default: not declared - baseline.reportComplete: boolean; default: not declared - baseline.reportIds: string[]; default: not declared - baseline.reviewReasons: string[]; default: not declared - changes: DisclosedHoldingPartitionChange[]; default: not declared - comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - current: DisclosedHoldingPartitionsSnapshotReport; default: not declared - current.comparisonEligible: boolean; default: not declared - current.concentration: DisclosedHoldingPartitionsConcentration; default: not declared - current.concentration.denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - current.concentration.largestPartitionWeight: string | null; default: not declared - current.concentration.partitionHerfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - current.concentration.reasons: DisclosedHoldingPartitionsConcentrationReason[]; default: not declared - current.concentration.status: 'review' | 'available'; default: not declared - current.concentration.valueCurrency: string | null; default: not declared - current.evidenceIds: string[]; default: not declared - current.holdings: DisclosedHoldingPartitionRowResult[]; default: not declared - current.managerId: string; default: not declared - current.mappingComplete: boolean; default: not declared - current.partitions: DisclosedHoldingPartitionResult[]; default: not declared - current.periodEnd: string; default: not declared - current.reportComplete: boolean; default: not declared - current.reportIds: string[]; default: not declared - current.reviewReasons: string[]; default: not declared - diagnostics: { baselineHoldingCount: number; baselinePartitionCount: number; changeCount: number; currentHoldingCount: number; currentPartitionCount: number; status: 'complete' | 'review'; uncomparedPartitionCount: number; warnings: QuantWarning[]; }; default: not declared - diagnostics.baselineHoldingCount: number; default: not declared - diagnostics.baselinePartitionCount: number; default: not declared - diagnostics.changeCount: number; default: not declared - diagnostics.currentHoldingCount: number; default: not declared - diagnostics.currentPartitionCount: number; default: not declared - diagnostics.status: 'complete' | 'review'; default: not declared - diagnostics.uncomparedPartitionCount: number; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - policyVersion: 'disclosed-holding-partitions-v1'; default: not declared - uncomparedPartitions: DisclosedUncomparedHoldingPartition[]; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Selected disclosure facts, not a cash/transaction portfolio or amendment-selection request. ```typescript /** Selected disclosure facts, not a cash/transaction portfolio or amendment-selection request. */ export interface DisclosedHoldingPartitionsSnapshot { managerId: string; /** Strict YYYY-MM-DD reporting date, not an availability timestamp. */ periodEnd: string; reportIds: readonly string[]; evidenceIds: readonly string[]; /** * Caller attests that holdings contains the entire selected reported universe for this period, * not a page, filtered subset, or a report with known withheld/missing holdings. This does not * assert that a disclosure covers all of the manager's economic assets. Unknown means false. */ reportComplete: boolean; /** * Caller attests that every supplied holding has an authenticated issuer/security/class mapping. * Keep unresolved rows in holdings; never drop them to make this true. The library also checks * consumed mapping fields and conflicts. Unknown means false. */ mappingComplete: boolean; /** * Caller attests that upstream source/report-selection review permits using this snapshot for * the requested comparison (including amendment selection and known disclosure limitations). * The SDK does not authenticate evidence or select reports. Unknown means false; explain known * issues in reviewReasons. True never overrides row reviews, reference scope or changed bases. * All three flags gate totals/weights; both snapshots must pass before absence or deltas are inferred. */ comparisonEligible: boolean; reviewReasons: readonly string[]; holdings: readonly DisclosedHoldingPartition[]; [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comparisonEligible: boolean; default: not declared — Caller attests that upstream source/report-selection review permits using this snapshot for the requested comparison (including amendment selection and known disclosure limitations). The SDK does not authenticate evidence or select reports. Unknown means false; explain known issues in reviewReasons. True never overrides row reviews, reference scope or changed bases. All three flags gate totals/weights; both snapshots must pass before absence or deltas are inferred. - evidenceIds: readonly string[]; default: not declared - holdings: readonly DisclosedHoldingPartition[]; default: not declared - managerId: string; default: not declared - mappingComplete: boolean; default: not declared — Caller attests that every supplied holding has an authenticated issuer/security/class mapping. Keep unresolved rows in holdings; never drop them to make this true. The library also checks consumed mapping fields and conflicts. Unknown means false. - periodEnd: string; default: not declared — Strict YYYY-MM-DD reporting date, not an availability timestamp. - reportComplete: boolean; default: not declared — Caller attests that holdings contains the entire selected reported universe for this period, not a page, filtered subset, or a report with known withheld/missing holdings. This does not assert that a disclosure covers all of the manager's economic assets. Unknown means false. - reportIds: readonly string[]; default: not declared - reviewReasons: readonly string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsSnapshotReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reasons the supplied universe cannot establish absence or comparable whole-universe totals. ```typescript /** Reasons the supplied universe cannot establish absence or comparable whole-universe totals. */ export type DisclosedHoldingPartitionsSnapshotReason = 'report_incomplete' | 'mapping_incomplete' | 'comparison_ineligible' | 'source_snapshot_review' | 'holdings_require_review' | 'mixed_currencies'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsSnapshotReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingPartitionsSnapshotReport = { managerId: string; periodEnd: string; reportIds: string[]; evidenceIds: string[]; reportComplete: boolean; mappingComplete: boolean; comparisonEligible: boolean; reviewReasons: string[]; holdings: DisclosedHoldingPartitionRowResult[]; partitions: DisclosedHoldingPartitionResult[]; concentration: DisclosedHoldingPartitionsConcentration; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comparisonEligible: boolean; default: not declared - concentration: DisclosedHoldingPartitionsConcentration; default: not declared - concentration.denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - concentration.largestPartitionWeight: string | null; default: not declared - concentration.partitionHerfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - concentration.reasons: DisclosedHoldingPartitionsConcentrationReason[]; default: not declared - concentration.status: 'review' | 'available'; default: not declared - concentration.valueCurrency: string | null; default: not declared - evidenceIds: string[]; default: not declared - holdings: DisclosedHoldingPartitionRowResult[]; default: not declared - managerId: string; default: not declared - mappingComplete: boolean; default: not declared - partitions: DisclosedHoldingPartitionResult[]; default: not declared - periodEnd: string; default: not declared - reportComplete: boolean; default: not declared - reportIds: string[]; default: not declared - reviewReasons: string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Library-generated row/position review codes; source reviewReasons remain free-form. ```typescript /** Library-generated row/position review codes; source reviewReasons remain free-form. */ export type DisclosedHoldingReason = 'unresolved_identity' | 'unsupported_instrument_type' | 'unsupported_quantity_unit' | 'option_position' | 'unsupported_discretion' | 'source_row_review' | 'duplicate_security_class' | 'conflicting_security_identity'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingResult = { holdingId: string; issuerId: string | null; securityId: string | null; classId: string | null; mappingStatus: 'mapped' | 'unresolved'; instrumentType: string; quantity: string; quantityUnit: string; reportedValue: string; valueCurrency: string; valueScale: '1' | '1000'; putCall: 'none' | 'put' | 'call'; investmentDiscretion: string; otherManagerIds: string[]; evidenceIds: string[]; reviewReasons: string[]; normalizedReportedValue: string; status: 'supported' | 'review'; reasons: DisclosedHoldingReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classId: string | null; default: not declared - evidenceIds: string[]; default: not declared - holdingId: string; default: not declared - instrumentType: string; default: not declared - investmentDiscretion: string; default: not declared - issuerId: string | null; default: not declared - mappingStatus: 'unresolved' | 'mapped'; default: not declared - normalizedReportedValue: string; default: not declared - otherManagerIds: string[]; default: not declared - putCall: 'none' | 'call' | 'put'; default: not declared - quantity: string; default: not declared - quantityUnit: string; default: not declared - reasons: DisclosedHoldingReason[]; default: not declared - reportedValue: string; default: not declared - reviewReasons: string[]; default: not declared - securityId: string | null; default: not declared - status: 'review' | 'supported'; default: not declared - valueCurrency: string; default: not declared - valueScale: '1' | '1000'; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsConcentration Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingsConcentration = { status: 'available' | 'review'; /** Sum of all supplied reported values, only when the complete supported universe is known. */ denominatorReportedValue: string | null; valueCurrency: string | null; largestWeight: string | null; /** Sum of squared unrounded reported-value weights, not a percentage. */ herfindahlIndex: string | null; reasons: DisclosedHoldingsConcentrationReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - herfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - largestWeight: string | null; default: not declared - reasons: DisclosedHoldingsConcentrationReason[]; default: not declared - status: 'review' | 'available'; default: not declared - valueCurrency: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsConcentrationReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Zero totals additionally withhold ratios, but do not invalidate otherwise justified absence. ```typescript /** Zero totals additionally withhold ratios, but do not invalidate otherwise justified absence. */ export type DisclosedHoldingsConcentrationReason = DisclosedHoldingsSnapshotReason | 'zero_denominator'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingsPolicy = { supportedProfile: 'common-stock-shares-v1'; discretionPolicy: 'sole-without-other-managers'; /** Ratios rounded once, half away from zero, to this many decimal places (0–18). */ ratioDecimalPlaces: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discretionPolicy: 'sole-without-other-managers'; default: not declared - ratioDecimalPlaces: number; default: not declared — Ratios rounded once, half away from zero, to this many decimal places (0–18). - supportedProfile: 'common-stock-shares-v1'; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rich JSON-safe report directly accepted by createAnalysisArtifact. ```typescript /** Rich JSON-safe report directly accepted by createAnalysisArtifact. */ export type DisclosedHoldingsReport = { policyVersion: 'disclosed-holdings-v1'; comparisonMode: 'reported-period-change' | 'same-period-revision'; baseline: DisclosedHoldingsSnapshotReport; current: DisclosedHoldingsSnapshotReport; changes: DisclosedHoldingChange[]; assumptions: { /** Validated policy used for this report, copied independently of the caller's request. */ policy: DisclosedHoldingsPolicy; profile: string; discretion: string; denominator: string; rounding: string; changes: string; }; diagnostics: { status: 'complete' | 'review'; warnings: QuantWarning[]; baselineHoldingCount: number; currentHoldingCount: number; changeCount: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { changes: string; denominator: string; discretion: string; policy: DisclosedHoldingsPolicy; profile: string; rounding: string; }; default: not declared - assumptions.changes: string; default: not declared - assumptions.denominator: string; default: not declared - assumptions.discretion: string; default: not declared - assumptions.policy: DisclosedHoldingsPolicy; default: not declared — Validated policy used for this report, copied independently of the caller's request. - assumptions.policy.discretionPolicy: 'sole-without-other-managers'; default: not declared - assumptions.policy.ratioDecimalPlaces: number; default: not declared — Ratios rounded once, half away from zero, to this many decimal places (0–18). - assumptions.policy.supportedProfile: 'common-stock-shares-v1'; default: not declared - assumptions.profile: string; default: not declared - assumptions.rounding: string; default: not declared - baseline: DisclosedHoldingsSnapshotReport; default: not declared - baseline.comparisonEligible: boolean; default: not declared - baseline.concentration: DisclosedHoldingsConcentration; default: not declared - baseline.concentration.denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - baseline.concentration.herfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - baseline.concentration.largestWeight: string | null; default: not declared - baseline.concentration.reasons: DisclosedHoldingsConcentrationReason[]; default: not declared - baseline.concentration.status: 'review' | 'available'; default: not declared - baseline.concentration.valueCurrency: string | null; default: not declared - baseline.evidenceIds: string[]; default: not declared - baseline.holdings: DisclosedHoldingResult[]; default: not declared - baseline.managerId: string; default: not declared - baseline.mappingComplete: boolean; default: not declared - baseline.periodEnd: string; default: not declared - baseline.positions: DisclosedPositionResult[]; default: not declared - baseline.reportComplete: boolean; default: not declared - baseline.reportIds: string[]; default: not declared - baseline.reviewReasons: string[]; default: not declared - changes: DisclosedHoldingChange[]; default: not declared - comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - current: DisclosedHoldingsSnapshotReport; default: not declared - current.comparisonEligible: boolean; default: not declared - current.concentration: DisclosedHoldingsConcentration; default: not declared - current.concentration.denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - current.concentration.herfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - current.concentration.largestWeight: string | null; default: not declared - current.concentration.reasons: DisclosedHoldingsConcentrationReason[]; default: not declared - current.concentration.status: 'review' | 'available'; default: not declared - current.concentration.valueCurrency: string | null; default: not declared - current.evidenceIds: string[]; default: not declared - current.holdings: DisclosedHoldingResult[]; default: not declared - current.managerId: string; default: not declared - current.mappingComplete: boolean; default: not declared - current.periodEnd: string; default: not declared - current.positions: DisclosedPositionResult[]; default: not declared - current.reportComplete: boolean; default: not declared - current.reportIds: string[]; default: not declared - current.reviewReasons: string[]; default: not declared - diagnostics: { baselineHoldingCount: number; changeCount: number; currentHoldingCount: number; status: 'complete' | 'review'; warnings: QuantWarning[]; }; default: not declared - diagnostics.baselineHoldingCount: number; default: not declared - diagnostics.changeCount: number; default: not declared - diagnostics.currentHoldingCount: number; default: not declared - diagnostics.status: 'complete' | 'review'; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - policyVersion: 'disclosed-holdings-v1'; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Selected disclosure facts, not a cash/transaction portfolio or amendment-selection request. ```typescript /** Selected disclosure facts, not a cash/transaction portfolio or amendment-selection request. */ export interface DisclosedHoldingsSnapshot { managerId: string; /** Strict YYYY-MM-DD reporting date, not an availability timestamp. */ periodEnd: string; reportIds: readonly string[]; evidenceIds: readonly string[]; reportComplete: boolean; mappingComplete: boolean; comparisonEligible: boolean; reviewReasons: readonly string[]; holdings: readonly DisclosedHolding[]; [key: string]: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comparisonEligible: boolean; default: not declared - evidenceIds: readonly string[]; default: not declared - holdings: readonly DisclosedHolding[]; default: not declared - managerId: string; default: not declared - mappingComplete: boolean; default: not declared - periodEnd: string; default: not declared — Strict YYYY-MM-DD reporting date, not an availability timestamp. - reportComplete: boolean; default: not declared - reportIds: readonly string[]; default: not declared - reviewReasons: readonly string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsSnapshotReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reasons the supplied universe cannot establish absence or comparable whole-universe totals. ```typescript /** Reasons the supplied universe cannot establish absence or comparable whole-universe totals. */ export type DisclosedHoldingsSnapshotReason = 'report_incomplete' | 'mapping_incomplete' | 'comparison_ineligible' | 'source_snapshot_review' | 'holdings_require_review' | 'mixed_currencies'; ``` ### @insiderfinance/totalfinance/portfolio#DisclosedHoldingsSnapshotReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedHoldingsSnapshotReport = { managerId: string; periodEnd: string; reportIds: string[]; evidenceIds: string[]; reportComplete: boolean; mappingComplete: boolean; comparisonEligible: boolean; reviewReasons: string[]; holdings: DisclosedHoldingResult[]; positions: DisclosedPositionResult[]; concentration: DisclosedHoldingsConcentration; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comparisonEligible: boolean; default: not declared - concentration: DisclosedHoldingsConcentration; default: not declared - concentration.denominatorReportedValue: string | null; default: not declared — Sum of all supplied reported values, only when the complete supported universe is known. - concentration.herfindahlIndex: string | null; default: not declared — Sum of squared unrounded reported-value weights, not a percentage. - concentration.largestWeight: string | null; default: not declared - concentration.reasons: DisclosedHoldingsConcentrationReason[]; default: not declared - concentration.status: 'review' | 'available'; default: not declared - concentration.valueCurrency: string | null; default: not declared - evidenceIds: string[]; default: not declared - holdings: DisclosedHoldingResult[]; default: not declared - managerId: string; default: not declared - mappingComplete: boolean; default: not declared - periodEnd: string; default: not declared - positions: DisclosedPositionResult[]; default: not declared - reportComplete: boolean; default: not declared - reportIds: string[]; default: not declared - reviewReasons: string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedPositionResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedPositionResult = { issuerId: string | null; securityId: string; classId: string; holdingIds: string[]; evidenceIds: string[]; quantity: string | null; reportedValue: string | null; valueCurrency: string | null; weight: string | null; status: 'supported' | 'review'; reasons: DisclosedHoldingReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classId: string; default: not declared - evidenceIds: string[]; default: not declared - holdingIds: string[]; default: not declared - issuerId: string | null; default: not declared - quantity: string | null; default: not declared - reasons: DisclosedHoldingReason[]; default: not declared - reportedValue: string | null; default: not declared - securityId: string; default: not declared - status: 'review' | 'supported'; default: not declared - valueCurrency: string | null; default: not declared - weight: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#DisclosedUncomparedHoldingPartition Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DisclosedUncomparedHoldingPartition = { side: 'baseline' | 'current'; partitionKey: DisclosedHoldingPartitionKey; issuerId: string | null; holdingIds: string[]; evidenceIds: string[]; quantity: string | null; reportedValue: string | null; valueCurrency: string | null; classification: 'unknown'; reasons: DisclosedHoldingPartitionChangeReason[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classification: 'unknown'; default: not declared - evidenceIds: string[]; default: not declared - holdingIds: string[]; default: not declared - issuerId: string | null; default: not declared - partitionKey: DisclosedHoldingPartitionKey; default: not declared - partitionKey.classId: string; default: not declared - partitionKey.investmentDiscretion: string; default: not declared - partitionKey.otherManagerReferences: string[]; default: not declared - partitionKey.securityId: string; default: not declared - partitionKey.sourceReportId?: string; default: not declared - quantity: string | null; default: not declared - reasons: DisclosedHoldingPartitionChangeReason[]; default: not declared - reportedValue: string | null; default: not declared - side: 'current' | 'baseline'; default: not declared - valueCurrency: string | null; default: not declared ### @insiderfinance/totalfinance/portfolio#EconomicPortfolioEvent Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The events with an economic effect — everything an `admin.*` event can reference or replace. ```typescript /** The events with an economic effect — everything an `admin.*` event can reference or replace. */ export type EconomicPortfolioEvent = CashDepositEvent | CashWithdrawalEvent | CashTransferEvent | CashConversionEvent | TradeFillEvent | CostChargeEvent | IncomeReceivedEvent | FinancingChargeEvent | StockSplitEvent | OptionExerciseEvent | OptionAssignmentEvent | OptionExpirationEvent | ContractMultiplierChangeEvent | VariationMarginEvent | DerivativeRollEvent | FixedIncomeRedemptionEvent | SymbolChangeEvent | MergerEvent | SpinOffEvent | ReturnOfCapitalEvent | CashInLieuEvent | PositionTransferEvent; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - amountPerShare: number; default: not declared - basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - cashPerShare?: number; default: not declared - childInstrumentId: string; default: not declared - closePricePerUnit: number; default: not declared - contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - contractMultiplierAfter: number; default: not declared - costType: CostType; default: not declared - currency?: string; default: not declared — Required with `cashPerShare`. - eventType: ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - financingType: FinancingType; default: not declared - fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - fromCurrency: string; default: not declared - fromInstrumentId: string; default: not declared - incomeType: IncomeType; default: not declared - instrumentId?: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - openPricePerUnit: number; default: not declared - parentInstrumentId: string; default: not declared - premiumTreatment: PremiumTreatment; default: not declared - pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - reason?: string; default: not declared - redemptionType: RedemptionType; default: not declared - relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - settlement: DerivativeSettlement; default: not declared - settlement.kind: ('cash') | ('physical'); default: not declared - settlement.settlementPricePerUnit: number; default: not declared - settlementPricePerUnit: number; default: not declared - settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - sharesPerParentShare: number; default: not declared - sharesPerShare?: number; default: not declared - side: 'buy' | 'sell'; default: not declared - strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - toAccountId: string; default: not declared - toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - toCurrency: string; default: not declared - toInstrumentId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#ExecutionJournalEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExecutionJournalEvent { eventId: string; journalId: string; timestampMs: EpochMs; orderId: string; planHash: string; idempotencyKey?: string; eventType: ExecutionJournalEventType; detail: ExecutionJournalDetail; sourceId: string; provenance: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: ExecutionJournalDetail; default: not declared - detail.accountId?: string; default: not declared — Paper `submitted`: the account/base-currency binding of the broker. - detail.artifactHash?: string; default: not declared — `proposed` / `preflighted` / `authorized` / `reconciled`: the artifact's content hash. - detail.baseCurrency?: string; default: not declared - detail.comboId?: string; default: not declared — Paper `submitted`: the combo this order is a leg of (B5), so a restored broker fills it all-or-none. - detail.executionPolicyHash?: string; default: not declared — Hash of the complete declared policy data and callback labels/versions; not serialized code. - detail.fill?: NormalizedFill; default: not declared — The complete accounting fact, including settlement and costs, for durable recovery. - detail.fill.accountId: string; default: not declared - detail.fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - detail.fill.contract?: DerivativeContractTerms; default: not declared - detail.fill.contract.expiryTimestampMs: number; default: not declared - detail.fill.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - detail.fill.contract.strikePricePerUnit: number; default: not declared - detail.fill.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - detail.fill.contract.underlyingInstrumentId: string; default: not declared - detail.fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - detail.fill.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - detail.fill.costs.commission?: number; default: not declared - detail.fill.costs.exchangeFees?: number; default: not declared - detail.fill.costs.regulatoryFees?: number; default: not declared - detail.fill.costs.slippageAdjustment?: number; default: not declared - detail.fill.currency: string; default: not declared - detail.fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - detail.fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - detail.fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - detail.fill.instrumentId: string; default: not declared - detail.fill.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - detail.fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - detail.fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - detail.fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - detail.fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - detail.fill.settlementStyle?: SettlementStyle; default: not declared - detail.fill.side: 'buy' | 'sell'; default: not declared - detail.fill.venue?: string; default: not declared - detail.fillId?: string; default: not declared — `partially-filled` / `filled`: the fill id — the ledger's `trade.fill` event id. - detail.instrument?: { contract?: DerivativeContractTerms; contractMultiplier?: number; currency: string; settlementLag?: 0 | 1 | 2; settlementStyle?: SettlementStyle; }; default: not declared — Paper `submitted`: instrument terms captured at submission, never replaced by restart defaults. - detail.instrument.contract?: DerivativeContractTerms; default: not declared - detail.instrument.contract.expiryTimestampMs: number; default: not declared - detail.instrument.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - detail.instrument.contract.strikePricePerUnit: number; default: not declared - detail.instrument.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - detail.instrument.contract.underlyingInstrumentId: string; default: not declared - detail.instrument.contractMultiplier?: number; default: not declared - detail.instrument.currency: string; default: not declared - detail.instrument.settlementLag?: 0 | 1 | 2; default: not declared — Paper currently measures this lag in 24-hour days, not exchange-calendar sessions. - detail.instrument.settlementStyle?: SettlementStyle; default: not declared - detail.netLimitPrice?: number; default: not declared — Paper `submitted`: the combo's net limit per combo unit, repeated on every leg. - detail.note?: string; default: not declared - detail.observationTimestampMs?: number; default: not declared — Paper fills: the consumed market observation's instant, preventing retry from consuming it again. - detail.order?: TradeOrder; default: not declared — Paper `submitted`: complete intent, with the effective time-in-force made explicit. - detail.order.comboId?: string; default: not declared — The multi-leg order this is a leg of (B5); the plan's `combos` names the legs and the net limit. - detail.order.instrumentId: string; default: not declared - detail.order.limitPrice?: number; default: not declared - detail.order.orderId: string; default: not declared - detail.order.plannedTimestampMs: number; default: not declared — The plan's instant — when the order was planned, never when it reached a broker. - detail.order.quantity: number; default: not declared - detail.order.side: OrderSide; default: not declared - detail.order.stopPrice?: number; default: not declared - detail.order.submittedTimestampMs?: number; default: not declared — Stamped by the broker at submission; absent on a plan's order. A fill never consumes an observation older than it. - detail.order.timeInForce?: TimeInForce; default: not declared - detail.order.type: OrderType; default: not declared - detail.pricePerUnit?: number; default: not declared — `partially-filled` / `filled`: the fill price, for the average. - detail.quantity?: number; default: not declared — `submitted`: the submitted quantity; `partially-filled` / `filled`: the fill's quantity. - detail.reason?: string; default: not declared — `rejected` / `cancelled` / `expired` / `unresolved`: why. - detail.replacementOrderId?: string; default: not declared — `replaced`: the replacing order. - eventId: string; default: not declared - eventType: 'expired' | 'proposed' | 'preflighted' | 'authorized' | 'submitted' | 'acknowledged' | 'partially-filled' | 'filled' | 'rejected' | 'cancel-requested' | 'cancelled' | 'replaced' | 'reconciled' | 'unresolved'; default: not declared - idempotencyKey?: string; default: not declared - journalId: string; default: not declared - orderId: string; default: not declared - planHash: string; default: not declared - provenance: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - sourceId: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/portfolio#ExecutionJournalState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExecutionJournalState { /** Null until the first event. */ journalId: string | null; eventCount: number; /** Applied event ids in order (duplicates excluded). */ eventIds: string[]; orders: Record; /** Orders journaled only before submission: the pre-submission event types seen. */ preSubmission: Record; /** Every duplicate delivery skipped across folds. */ duplicateEventIds: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - eventCount: number; default: not declared - eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - journalId: string | null; default: not declared — Null until the first event. - orders: Record; default: not declared - preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. ### @insiderfinance/totalfinance/portfolio#ExecutionOrderState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExecutionOrderState { orderId: string; planHash: string; state: ExecutionOrderStatus; submittedQuantity: number; filledQuantity: number; remainingQuantity: number; /** Quantity-weighted; null until a priced fill, and null again if any fill came unpriced. */ averageFillPrice: number | null; fillIds: string[]; /** Fills journaled after the order was closed — the order is `unresolved` while any exist. */ lateFillIds: string[]; lastEventId: string; lastTimestampMs: EpochMs; terminal: boolean; cancelRequested: boolean; reason: string | null; replacedBy: string | null; reconciledEventId: string | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageFillPrice: number | null; default: not declared — Quantity-weighted; null until a priced fill, and null again if any fill came unpriced. - cancelRequested: boolean; default: not declared - fillIds: string[]; default: not declared - filledQuantity: number; default: not declared - lastEventId: string; default: not declared - lastTimestampMs: number; default: not declared - lateFillIds: string[]; default: not declared — Fills journaled after the order was closed — the order is `unresolved` while any exist. - orderId: string; default: not declared - planHash: string; default: not declared - reason: string | null; default: not declared - reconciledEventId: string | null; default: not declared - remainingQuantity: number; default: not declared - replacedBy: string | null; default: not declared - state: ExecutionOrderStatus; default: not declared - submittedQuantity: number; default: not declared - terminal: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio#ExecutionPlan Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The normalized, content-addressed plan every later stage binds to — the actionable boundary. ```typescript /** The normalized, content-addressed plan every later stage binds to — the actionable boundary. */ export interface ExecutionPlan { kind: typeof EXECUTION_PLAN_KIND; schemaVersion: number; accountId: string; asOf: EpochMs; baseCurrency: string; portfolioId?: string; orders: TradeOrder[]; /** Every multi-leg order, each with at least two legs; empty when every order stands alone. */ combos: ExecutionPlanCombo[]; /** The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. */ trades: TradePlanTrade[]; source: ExecutionPlanSource; rationale?: string; evidence: string[]; contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - asOf: number; default: not declared - baseCurrency: string; default: not declared - combos: ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - contentHash: string; default: not declared - evidence: string[]; default: not declared - kind: 'totalfinance.execution-plan'; default: not declared - orders: TradeOrder[]; default: not declared - portfolioId?: string; default: not declared - rationale?: string; default: not declared - schemaVersion: number; default: not declared - source: ExecutionPlanSource; default: not declared - source.intentHash: string; default: not declared - source.kind: ('intent') | ('rebalance-proposal'); default: not declared - source.planHash: string; default: not declared - source.policyContentHash: string; default: not declared - trades: TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. ### @insiderfinance/totalfinance/portfolio#ExpandedTargets Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The expansion of group targets to instrument targets — what allocation and rebalancing act on. ```typescript /** The expansion of group targets to instrument targets — what allocation and rebalancing act on. */ export interface ExpandedTargets { instrumentTargets: InstrumentTarget[]; groupTargets: GroupTarget[]; /** The cash target (`{ assetClass: 'cash' }`), implied zero when the targets sum to 1 without one. */ cashTarget: { targetWeight: number; driftBand: number | null; implied: boolean; } | null; /** Σ of the resolved group weights including cash (before implied zeros). */ declaredWeightTotal: number; unresolved: UnresolvedTarget[]; warnings: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashTarget: { targetWeight: number; driftBand: number | null; implied: boolean; } | null; default: not declared — The cash target (`{ assetClass: 'cash' }`), implied zero when the targets sum to 1 without one. - cashTarget.driftBand: number | null; default: not declared - cashTarget.implied: boolean; default: not declared - cashTarget.targetWeight: number; default: not declared - declaredWeightTotal: number; default: not declared — Σ of the resolved group weights including cash (before implied zeros). - groupTargets: GroupTarget[]; default: not declared - instrumentTargets: InstrumentTarget[]; default: not declared - unresolved: UnresolvedTarget[]; default: not declared - warnings: string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#ExternalAccountSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExternalAccountSnapshot { cash: Record; positions: ExternalPosition[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cash: Record; default: not declared - positions: ExternalPosition[]; default: not declared ### @insiderfinance/totalfinance/portfolio#ExternalCashBalance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One currency's cash as the external source reports it. `settled` is optional — many report only totals. ```typescript // --------------------------------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------------------------------- /** One currency's cash as the external source reports it. `settled` is optional — many report only totals. */ export interface ExternalCashBalance { total: number; settled?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - settled?: number; default: not declared - total: number; default: not declared ### @insiderfinance/totalfinance/portfolio#ExternalFlow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A planned contribution (`amount > 0`) or withdrawal (`amount < 0`) at `asOf`. ```typescript /** A planned contribution (`amount > 0`) or withdrawal (`amount < 0`) at `asOf`. */ export interface ExternalFlow { amount: number; /** Base currency only in this build (a foreign-currency flow is a typed refusal). */ currency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - currency: string; default: not declared — Base currency only in this build (a foreign-currency flow is a typed refusal). ### @insiderfinance/totalfinance/portfolio#ExternalPortfolioSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A normalized external snapshot — the shape adapters produce from broker/custodian statements. ```typescript /** A normalized external snapshot — the shape adapters produce from broker/custodian statements. */ export interface ExternalPortfolioSnapshot { asOf: EpochMs | string; accounts: Record; /** Free-text origin (e.g. a broker name); echoed into suggested corrections' provenance. */ source?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accounts: Record; default: not declared - asOf: string | number; default: not declared - source?: string; default: not declared — Free-text origin (e.g. a broker name); echoed into suggested corrections' provenance. ### @insiderfinance/totalfinance/portfolio#ExternalPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExternalPosition { instrumentId: string; /** Signed; short positions negative. */ quantity: number; currency?: string; /** Total cost basis in the position's currency, when the source supplies it. */ costBasis?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - costBasis?: number; default: not declared — Total cost basis in the position's currency, when the source supplies it. - currency?: string; default: not declared - instrumentId: string; default: not declared - quantity: number; default: not declared — Signed; short positions negative. ### @insiderfinance/totalfinance/portfolio#FillEffect Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What one applied fill did — the facts an exact reversal needs (slice 3). ```typescript /** What one applied fill did — the facts an exact reversal needs (slice 3). */ export interface FillEffect { accountId: string; instrumentId: string; currency: string; /** Lot ids this fill OPENED (in order). Empty when the fill only relieved. */ openedLotIds: string[]; /** Quantity this fill relieved from prior lots — non-zero means the fill is not exactly reversible. */ relievedQuantity: number; realizedPnl: number; /** The signed cash the fill booked (price × quantity × multiplier, or the realized variation-margin P&L), incl. accrued interest. */ cashDelta: number; /** Signed accrued interest exchanged (negative = paid on a buy), booked as income. */ accruedInterest: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - accruedInterest: number; default: not declared — Signed accrued interest exchanged (negative = paid on a buy), booked as income. - cashDelta: number; default: not declared — The signed cash the fill booked (price × quantity × multiplier, or the realized variation-margin P&L), incl. accrued interest. - currency: string; default: not declared - instrumentId: string; default: not declared - openedLotIds: string[]; default: not declared — Lot ids this fill OPENED (in order). Empty when the fill only relieved. - realizedPnl: number; default: not declared - relievedQuantity: number; default: not declared — Quantity this fill relieved from prior lots — non-zero means the fill is not exactly reversible. ### @insiderfinance/totalfinance/portfolio#FinancingChargeEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A financing charge paid in cash — margin interest, borrow fee, or perpetual funding paid. ```typescript /** A financing charge paid in cash — margin interest, borrow fee, or perpetual funding paid. */ export interface FinancingChargeEvent { eventType: 'financing.charge'; financingType: FinancingType; /** Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). */ amount: number; currency: string; instrumentId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). - currency: string; default: not declared - eventType: 'financing.charge'; default: not declared - financingType: FinancingType; default: not declared - instrumentId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#FinancingType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FinancingType = 'margin-interest' | 'borrow-charge' | 'funding-payment'; ``` ### @insiderfinance/totalfinance/portfolio#FixedIncomeRedemptionEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Principal settled on a fixed-income position: long or short lots relieved at the redemption price. Long holdings receive principal; short holdings pay it. Direction comes from the held position, while the event quantity is always an unsigned magnitude. ```typescript /** * Principal settled on a fixed-income position: long or short lots relieved at the redemption * price. Long holdings receive principal; short holdings pay it. Direction comes from the * held position, while the event quantity is always an unsigned magnitude. */ export interface FixedIncomeRedemptionEvent { eventType: 'fixed-income.redemption'; instrumentId: string; redemptionType: RedemptionType; /** Magnitude of face units redeemed, > 0, for either a long or short holding. */ quantity: number; /** Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). */ pricePerUnit: number; currency: string; settleTimestampMs?: EpochMs; lotSelections?: TradeFillLotSelection[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currency: string; default: not declared - eventType: 'fixed-income.redemption'; default: not declared - instrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared - pricePerUnit: number; default: not declared — Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - quantity: number; default: not declared — Magnitude of face units redeemed, > 0, for either a long or short holding. - redemptionType: RedemptionType; default: not declared - settleTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#FutureContractTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FutureContractTerms { kind: 'future'; underlyingInstrumentId: string; expiryTimestampMs: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiryTimestampMs: number; default: not declared - kind: 'future'; default: not declared - underlyingInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#GlidePath Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dated strategic target sets along a horizon; `interpolation` is REQUIRED (never guessed). ```typescript /** Dated strategic target sets along a horizon; `interpolation` is REQUIRED (never guessed). */ export interface GlidePath { interpolation: 'step' | 'linear'; points: GlidePathPoint[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - interpolation: 'linear' | 'step'; default: not declared - points: GlidePathPoint[]; default: not declared ### @insiderfinance/totalfinance/portfolio#GlidePathPoint Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One glide-path point: a dated target set that runs until the next point (no `effectiveTo`). ```typescript /** One glide-path point: a dated target set that runs until the next point (no `effectiveTo`). */ export type GlidePathPoint = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - note?: string; default: not declared - targets: AllocationTarget[]; default: not declared ### @insiderfinance/totalfinance/portfolio#GrantVerification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GrantVerification { valid: boolean; /** Every failed binding, never only the first. */ reasons: GrantRefusal[]; grantHash: string; planHash: string; checkedAt: EpochMs; assumptions: { conventionsVersion: string; mode: 'paper'; /** The market instant and age the verification judged. */ marketAsOf: EpochMs; marketAgeMs: number; marketMaximumAgeMs: number; /** Whether the orders judged for variance were the plan's own (no variance) or supplied. */ ordersJudged: 'plan' | 'supplied'; bindingConvention: string; }; diagnostics: { engine: 'grant-verification'; warnings: string[]; bindingCount: number; reasonCount: number; orderCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { bindingConvention: string; conventionsVersion: string; marketAgeMs: number; marketAsOf: EpochMs; marketMaximumAgeMs: number; mode: 'paper'; ordersJudged: 'plan' | 'supplied'; }; default: not declared - assumptions.bindingConvention: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.marketAgeMs: number; default: not declared - assumptions.marketAsOf: number; default: not declared — The market instant and age the verification judged. - assumptions.marketMaximumAgeMs: number; default: not declared - assumptions.mode: 'paper'; default: not declared - assumptions.ordersJudged: 'supplied' | 'plan'; default: not declared — Whether the orders judged for variance were the plan's own (no variance) or supplied. - checkedAt: number; default: not declared - diagnostics: { bindingCount: number; engine: 'grant-verification'; orderCount: number; reasonCount: number; warnings: string[]; }; default: not declared - diagnostics.bindingCount: number; default: not declared - diagnostics.engine: 'grant-verification'; default: not declared - diagnostics.orderCount: number; default: not declared - diagnostics.reasonCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - grantHash: string; default: not declared - planHash: string; default: not declared - reasons: GrantRefusal[]; default: not declared — Every failed binding, never only the first. - valid: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio#GroupTarget Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One group target after membership resolution. ```typescript /** One group target after membership resolution. */ export interface GroupTarget { key: string; group: TargetGroup; targetWeight: number; driftBand: number | null; members: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - driftBand: number | null; default: not declared - group: TargetGroup; default: not declared - group.assetClass?: string; default: not declared - group.currency?: string; default: not declared - group.instrumentId?: string; default: not declared - group.sleeveId?: string; default: not declared - group.strategy?: string; default: not declared - group.tag?: string; default: not declared - group.underlying?: string; default: not declared - key: string; default: not declared - members: string[]; default: not declared - targetWeight: number; default: not declared ### @insiderfinance/totalfinance/portfolio#GroupWeightLimit Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GroupWeightLimit { group: TargetGroup; /** Maximum absolute weight of the group (decimal of NAV). */ maximumWeight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - group: TargetGroup; default: not declared - group.assetClass?: string; default: not declared - group.currency?: string; default: not declared - group.instrumentId?: string; default: not declared - group.sleeveId?: string; default: not declared - group.strategy?: string; default: not declared - group.tag?: string; default: not declared - group.underlying?: string; default: not declared - maximumWeight: number; default: not declared — Maximum absolute weight of the group (decimal of NAV). ### @insiderfinance/totalfinance/portfolio#IncomeReceivedEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Income cash effect — dividend, coupon, interest, staking reward, or funding receipt. Despite the historical `income.received` event name, dividends and coupons are signed: positive receives income; negative pays the corresponding short-position obligation. Either sign belongs to income attribution, not external flows or financing costs. ```typescript /** * Income cash effect — dividend, coupon, interest, staking reward, or funding receipt. * Despite the historical `income.received` event name, dividends and coupons are signed: * positive receives income; negative pays the corresponding short-position obligation. * Either sign belongs to income attribution, not external flows or financing costs. */ export interface IncomeReceivedEvent { eventType: 'income.received'; incomeType: IncomeType; /** * Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a * short); other income types must be positive (funding payments use `financing.charge`). */ amount: number; currency: string; instrumentId?: string; settleTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). - currency: string; default: not declared - eventType: 'income.received'; default: not declared - incomeType: IncomeType; default: not declared - instrumentId?: string; default: not declared - settleTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#IncomeReinvestment Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type IncomeReinvestment = 'reinvest' | 'hold-as-cash'; ``` ### @insiderfinance/totalfinance/portfolio#IncomeType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type IncomeType = 'dividend' | 'coupon' | 'interest' | 'staking-reward' | 'funding-receipt'; ``` ### @insiderfinance/totalfinance/portfolio#InstrumentClassification Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Caller-supplied identity metadata for grouping; every field optional, unknown instruments group as `unclassified`. ```typescript // --------------------------------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------------------------------- /** Caller-supplied identity metadata for grouping; every field optional, unknown instruments group as `unclassified`. */ export interface InstrumentClassification { underlying?: string; assetClass?: string; strategy?: string; /** Overlapping by nature — the `tag` grouping does not partition the total. */ tags?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assetClass?: string; default: not declared - strategy?: string; default: not declared - tags?: string[]; default: not declared — Overlapping by nature — the `tag` grouping does not partition the total. - underlying?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#InstrumentTarget Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One instrument's resolved target after group expansion. ```typescript /** One instrument's resolved target after group expansion. */ export interface InstrumentTarget { instrumentId: string; targetWeight: number; driftBand: number | null; /** The target group keys (`'assetClass:equity'`) that produced this weight. */ sourceGroups: string[]; /** True when the instrument was covered by no target and the targets sum to 1 (implied zero). */ implied: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - driftBand: number | null; default: not declared - implied: boolean; default: not declared — True when the instrument was covered by no target and the targets sum to 1 (implied zero). - instrumentId: string; default: not declared - sourceGroups: string[]; default: not declared — The target group keys (`'assetClass:equity'`) that produced this weight. - targetWeight: number; default: not declared ### @insiderfinance/totalfinance/portfolio#InvestmentPolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The user-supplied investment policy (agent-native "Investment policy"). Targets come inline or from a model artifact — never both. Everything else is optional and explicit. ```typescript /** * The user-supplied investment policy (agent-native "Investment policy"). Targets come inline or * from a model artifact — never both. Everything else is optional and explicit. */ export interface InvestmentPolicy { targets?: AllocationTarget[]; model?: ModelPortfolio; /** * How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member * instruments. REQUIRED whenever such a target resolves to more than one instrument. */ withinGroupAllocation?: WithinGroupAllocation; /** Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. */ driftBand?: number; reviewCadenceDays?: number; /** Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). */ maximumTurnover?: number; /** Maximum estimated transaction cost per proposal, in base currency. */ maximumEstimatedTransactionCost?: number; /** Cash reserve in base currency that a proposal may never spend below. */ minimumCash?: number; /** Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). */ minimumCashWeight?: number; limits?: PolicyLimits; allowedInstruments?: string[]; restrictedInstruments?: string[]; allowedAccounts?: string[]; benchmark?: BenchmarkIdentity; /** Prose statement of the performance objective. String-typed by design. */ performanceObjective?: string; contributionHandling?: ContributionHandling; withdrawalHandling?: WithdrawalHandling; incomeReinvestment?: IncomeReinvestment; /** * Identity of an external tax-aware lot-selection objective. This build reports lots under the * ledger's own relief policy and echoes this identity; it never applies an objective it does not * implement. */ lotSelectionObjective?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allowedAccounts?: string[]; default: not declared - allowedInstruments?: string[]; default: not declared - benchmark?: BenchmarkIdentity; default: not declared - benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - benchmark.benchmarkId: string; default: not declared - benchmark.constituents?: BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - contributionHandling?: ContributionHandling; default: not declared - driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - incomeReinvestment?: IncomeReinvestment; default: not declared - limits?: PolicyLimits; default: not declared - limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - limits.maximumGroupWeights?: GroupWeightLimit[]; default: not declared - limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - model?: ModelPortfolio; default: not declared - model.baseCurrency: string; default: not declared - model.benchmark?: BenchmarkIdentity; default: not declared - model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - model.benchmark.benchmarkId: string; default: not declared - model.benchmark.constituents?: BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - model.glidePath?: GlidePath; default: not declared - model.glidePath.interpolation: 'linear' | 'step'; default: not declared - model.glidePath.points: GlidePathPoint[]; default: not declared - model.horizonEndDate?: string | number; default: not declared - model.kind: 'totalfinance.model-portfolio'; default: not declared - model.liabilities?: LiabilitySchedule; default: not declared - model.liabilities.entries: LiabilityEntry[]; default: not declared - model.liabilities.note?: string; default: not declared - model.modelId: string; default: not declared - model.note?: string; default: not declared - model.schemaVersion: number; default: not declared - model.sleeves?: ModelSleeve[]; default: not declared - model.strategic: TargetSet; default: not declared - model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - model.strategic.note?: string; default: not declared - model.strategic.targets: AllocationTarget[]; default: not declared - model.tactical?: TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - restrictedInstruments?: string[]; default: not declared - reviewCadenceDays?: number; default: not declared - targets?: AllocationTarget[]; default: not declared - withdrawalHandling?: WithdrawalHandling; default: not declared - withinGroupAllocation?: WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. ### @insiderfinance/totalfinance/portfolio#LiabilityEntry Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LiabilityEntry { date: EpochMs | string; /** Positive amount due on `date`, in `currency`. */ amount: number; currency: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Positive amount due on `date`, in `currency`. - currency: string; default: not declared - date: string | number; default: not declared ### @insiderfinance/totalfinance/portfolio#LiabilitySchedule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A schedule of dated liabilities / planned withdrawals the portfolio must fund. ```typescript /** A schedule of dated liabilities / planned withdrawals the portfolio must fund. */ export interface LiabilitySchedule { entries: LiabilityEntry[]; note?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entries: LiabilityEntry[]; default: not declared - note?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#LotReliefPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The decided lot-relief set (agent-native doc, "Initial accounting scope"). ```typescript // --------------------------------------------------------------------------------------------------- // State contracts // --------------------------------------------------------------------------------------------------- /** The decided lot-relief set (agent-native doc, "Initial accounting scope"). */ export type LotReliefPolicy = 'fifo' | 'lifo' | 'highest-cost' | 'specific-lot'; ``` ### @insiderfinance/totalfinance/portfolio#MODEL_PORTFOLIO_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const MODEL_PORTFOLIO_KIND: 'totalfinance.model-portfolio'; ``` ### @insiderfinance/totalfinance/portfolio#MODEL_PORTFOLIO_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const MODEL_PORTFOLIO_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio#MONITOR_ALERT_FAMILIES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const MONITOR_ALERT_FAMILIES: readonly MonitorAlertFamily[]; ``` ### @insiderfinance/totalfinance/portfolio#MONITOR_LIQUIDITY_PARTICIPATION_RATE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Days to liquidate = |quantity| ÷ (averageDailyVolume × this rate). Stated in assumptions. ```typescript export declare const MONITOR_LIQUIDITY_PARTICIPATION_RATE: 0.1; ``` ### @insiderfinance/totalfinance/portfolio#MergerEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A merger: stock-for-stock (`sharesPerShare` of `toInstrumentId` per share held), cash (`cashPerShare`), or both. At least one consideration is REQUIRED. ```typescript /** * A merger: stock-for-stock (`sharesPerShare` of `toInstrumentId` per share held), cash * (`cashPerShare`), or both. At least one consideration is REQUIRED. */ export interface MergerEvent { eventType: 'corporate.merger'; fromInstrumentId: string; toInstrumentId?: string; sharesPerShare?: number; cashPerShare?: number; /** Required with `cashPerShare`. */ currency?: string; settleTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashPerShare?: number; default: not declared - currency?: string; default: not declared — Required with `cashPerShare`. - eventType: 'corporate.merger'; default: not declared - fromInstrumentId: string; default: not declared - settleTimestampMs?: number; default: not declared - sharesPerShare?: number; default: not declared - toInstrumentId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#ModelPortfolio Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The immutable, content-addressed model artifact. ```typescript /** The immutable, content-addressed model artifact. */ export interface ModelPortfolio extends ModelPortfolioDefinition { kind: typeof MODEL_PORTFOLIO_KIND; schemaVersion: number; /** `sha256:` over the canonical definition (kind and schemaVersion included). */ contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - benchmark?: BenchmarkIdentity; default: not declared - benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - benchmark.benchmarkId: string; default: not declared - benchmark.constituents?: BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - glidePath?: GlidePath; default: not declared - glidePath.interpolation: 'linear' | 'step'; default: not declared - glidePath.points: GlidePathPoint[]; default: not declared - horizonEndDate?: string | number; default: not declared - kind: 'totalfinance.model-portfolio'; default: not declared - liabilities?: LiabilitySchedule; default: not declared - liabilities.entries: LiabilityEntry[]; default: not declared - liabilities.note?: string; default: not declared - modelId: string; default: not declared - note?: string; default: not declared - schemaVersion: number; default: not declared - sleeves?: ModelSleeve[]; default: not declared - strategic: TargetSet; default: not declared - strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - strategic.note?: string; default: not declared - strategic.targets: AllocationTarget[]; default: not declared - tactical?: TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. ### @insiderfinance/totalfinance/portfolio#ModelPortfolioDefinition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The definition {@link createModelPortfolio} freezes. ```typescript /** The definition {@link createModelPortfolio} freezes. */ export interface ModelPortfolioDefinition { modelId: string; /** Safe integer ≥ 1 — a changed model is a new version, never an edit in place. */ version: number; baseCurrency: string; strategic: TargetSet; /** Dated complete overrides; the latest set effective at `asOf` wins. */ tactical?: TargetSet[]; glidePath?: GlidePath; sleeves?: ModelSleeve[]; benchmark?: BenchmarkIdentity; liabilities?: LiabilitySchedule; horizonEndDate?: EpochMs | string; note?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - benchmark?: BenchmarkIdentity; default: not declared - benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - benchmark.benchmarkId: string; default: not declared - benchmark.constituents?: BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - glidePath?: GlidePath; default: not declared - glidePath.interpolation: 'linear' | 'step'; default: not declared - glidePath.points: GlidePathPoint[]; default: not declared - horizonEndDate?: string | number; default: not declared - liabilities?: LiabilitySchedule; default: not declared - liabilities.entries: LiabilityEntry[]; default: not declared - liabilities.note?: string; default: not declared - modelId: string; default: not declared - note?: string; default: not declared - sleeves?: ModelSleeve[]; default: not declared - strategic: TargetSet; default: not declared - strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - strategic.note?: string; default: not declared - strategic.targets: AllocationTarget[]; default: not declared - tactical?: TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. ### @insiderfinance/totalfinance/portfolio#ModelSleeve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A hierarchical sleeve. A LEAF declares `members`; a CHILD declares `parentSleeveId` and its `weightWithinParent` (siblings sum to 1). A parent's own target weight flows down the tree. ```typescript /** * A hierarchical sleeve. A LEAF declares `members`; a CHILD declares `parentSleeveId` and its * `weightWithinParent` (siblings sum to 1). A parent's own target weight flows down the tree. */ export interface ModelSleeve { sleeveId: string; parentSleeveId?: string; weightWithinParent?: number; members?: SleeveMember[]; note?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - members?: SleeveMember[]; default: not declared - note?: string; default: not declared - parentSleeveId?: string; default: not declared - sleeveId: string; default: not declared - weightWithinParent?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#MonitorAlert Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonitorAlert { /** `'family:key'` — the rule identity, stable across evaluations. */ key: string; family: MonitorAlertFamily; /** Prose naming the subject (`'instrument AAPL'`, `'group tag:equity'`, `'portfolio'`). */ subject: string; severity: MonitorAlertSeverity; state: MonitorAlertState; value: number | null; threshold: number | null; direction: MonitorAlertDirection; message: string; evidence: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: MonitorAlertDirection; default: not declared - evidence: Record; default: not declared - family: MonitorAlertFamily; default: not declared - key: string; default: not declared — `'family:key'` — the rule identity, stable across evaluations. - message: string; default: not declared - severity: MonitorAlertSeverity; default: not declared - state: MonitorAlertState; default: not declared - subject: string; default: not declared — Prose naming the subject (`'instrument AAPL'`, `'group tag:equity'`, `'portfolio'`). - threshold: number | null; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/portfolio#MonitorAlertDirection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MonitorAlertDirection = 'above' | 'below'; ``` ### @insiderfinance/totalfinance/portfolio#MonitorAlertFamily Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The alert families this build evaluates. ```typescript // --------------------------------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------------------------------- /** The alert families this build evaluates. */ export type MonitorAlertFamily = 'allocation-drift' | 'concentration-limit' | 'leverage-limit' | 'drawdown' | 'daily-loss' | 'cash-reserve' | 'margin-pressure' | 'liquidity' | 'option-expiration' | 'assignment-risk' | 'stale-market-data' | 'reconciliation-difference' | 'unexplained-residual' | 'unusual-pnl'; ``` ### @insiderfinance/totalfinance/portfolio#MonitorAlertSeverity Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MonitorAlertSeverity = 'informational' | 'warning' | 'critical'; ``` ### @insiderfinance/totalfinance/portfolio#MonitorAlertState Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MonitorAlertState = 'raised' | 'active' | 'acknowledged' | 'suppressed' | 'cleared'; ``` ### @insiderfinance/totalfinance/portfolio#MonitorDeferredFamily Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The doc's families this build declares unsupported: dividend risk needs an ex-dividend calendar (none in this build), order status lives in the execution journal, scenario-loss change waits for the Gate D scenario runner. ```typescript /** * The doc's families this build declares unsupported: dividend risk needs an ex-dividend calendar * (none in this build), order status lives in the execution journal, scenario-loss change waits * for the Gate D scenario runner. */ export type MonitorDeferredFamily = 'dividend-risk' | 'order-status' | 'scenario-loss-change'; ``` ### @insiderfinance/totalfinance/portfolio#MonitorFamilyEvaluation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonitorFamilyEvaluation { family: MonitorAlertFamily; status: 'evaluated' | 'skipped'; observationCount: number; /** Present exactly when `status` is `'skipped'`. */ reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - family: MonitorAlertFamily; default: not declared - observationCount: number; default: not declared - reason?: string; default: not declared — Present exactly when `status` is `'skipped'`. - status: 'skipped' | 'evaluated'; default: not declared ### @insiderfinance/totalfinance/portfolio#MonitorHysteresis Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Enter/exit bounds: a rule ENTERS past `enter` and only CLEARS past `exit`. ```typescript /** Enter/exit bounds: a rule ENTERS past `enter` and only CLEARS past `exit`. */ export interface MonitorHysteresis { enter: number; exit: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - enter: number; default: not declared - exit: number; default: not declared ### @insiderfinance/totalfinance/portfolio#MonitorPortfolioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonitorPortfolioInput { portfolio: PortfolioState; market: MarketSnapshot; /** The evaluation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. */ asOf: EpochMs | string; currencyConversions?: CurrencyPairQuote[]; policy: InvestmentPolicy; instrumentClassification?: Record; /** REQUIRED: the prior evaluation's `state`, or `null` for the first evaluation. */ previousState: PortfolioMonitorState | null; rules?: Partial>; /** Alert keys the host acknowledged since `previousState`. */ acknowledgments?: string[]; reconciliation?: ReconcilePortfolioResult; pnl?: PortfolioPnlResult; /** Units per day per instrument — the liquidity family's denominator. */ averageDailyVolumes?: Record; /** A mark observed before `asOf − marketStalenessLimitMs` is stale. */ marketStalenessLimitMs?: number; /** Decimal of NAV above which `|pnl.components.totalPnl| ÷ NAV` is unusual. */ unusualPnlThreshold?: number; /** Base-currency amount above which `|pnl.residual|` is unexplained. */ residualTolerance?: number; /** * Days to expiry (≥ 0) at or below which an option position is near expiry — the * `option-expiration` family's bound (direction below). Skipped without one (or a rule threshold). */ optionExpirationWarningDays?: number; /** * Moneyness (a decimal of the strike; positive = in the money) above which a SHORT option is at * risk of assignment — the `assignment-risk` family's bound. A negative value alerts while still * out of the money. Skipped without one (or a rule threshold). */ assignmentRiskMoneyness?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - acknowledgments?: string[]; default: not declared — Alert keys the host acknowledged since `previousState`. - asOf: string | number; default: not declared — The evaluation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. - assignmentRiskMoneyness?: number; default: not declared — Moneyness (a decimal of the strike; positive = in the money) above which a SHORT option is at risk of assignment — the `assignment-risk` family's bound. A negative value alerts while still out of the money. Skipped without one (or a rule threshold). - averageDailyVolumes?: Record; default: not declared — Units per day per instrument — the liquidity family's denominator. - currencyConversions?: CurrencyPairQuote[]; default: not declared - instrumentClassification?: Record; default: not declared - market: MarketSnapshot; default: not declared - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - marketStalenessLimitMs?: number; default: not declared — A mark observed before `asOf − marketStalenessLimitMs` is stale. - optionExpirationWarningDays?: number; default: not declared — Days to expiry (≥ 0) at or below which an option position is near expiry — the `option-expiration` family's bound (direction below). Skipped without one (or a rule threshold). - pnl?: PortfolioPnlResult; default: not declared - pnl.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - pnl.assumptions.conventionsVersion: string; default: not declared - pnl.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - pnl.assumptions.identity: string; default: not declared — The identity, stated. - pnl.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - pnl.assumptions.residualTolerance: number; default: not declared - pnl.baseCurrency: string; default: not declared - pnl.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - pnl.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - pnl.components.financing: number; default: not declared - pnl.components.foreignExchangePnl: number; default: not declared - pnl.components.income: number; default: not declared - pnl.components.realizedPnl: number; default: not declared - pnl.components.totalPnl: number; default: not declared - pnl.components.transactionCosts: number; default: not declared - pnl.components.unrealizedPnl: number; default: not declared - pnl.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - pnl.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - pnl.diagnostics.residualWithinTolerance: boolean; default: not declared - pnl.diagnostics.warnings: string[]; default: not declared - pnl.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - pnl.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - pnl.from.asOf: number; default: not declared - pnl.from.netAssetValue: number; default: not declared - pnl.from.valuationDate: string; default: not declared - pnl.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - pnl.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - pnl.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - pnl.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - pnl.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - pnl.to.asOf: number; default: not declared - pnl.to.netAssetValue: number; default: not declared - pnl.to.valuationDate: string; default: not declared - policy: InvestmentPolicy; default: not declared - policy.allowedAccounts?: string[]; default: not declared - policy.allowedInstruments?: string[]; default: not declared - policy.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.benchmark.benchmarkId: string; default: not declared - policy.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.contributionHandling?: import('@insiderfinance/totalfinance/portfolio').ContributionHandling; default: not declared - policy.driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - policy.incomeReinvestment?: import('@insiderfinance/totalfinance/portfolio').IncomeReinvestment; default: not declared - policy.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - policy.lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - policy.maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - policy.maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - policy.minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - policy.minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - policy.model?: import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared - policy.model.baseCurrency: string; default: not declared - policy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.model.benchmark.benchmarkId: string; default: not declared - policy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - policy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - policy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - policy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - policy.model.horizonEndDate?: string | number; default: not declared - policy.model.kind: 'totalfinance.model-portfolio'; default: not declared - policy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - policy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - policy.model.liabilities.note?: string; default: not declared - policy.model.modelId: string; default: not declared - policy.model.note?: string; default: not declared - policy.model.schemaVersion: number; default: not declared - policy.model.sleeves?: import('@insiderfinance/totalfinance/portfolio').ModelSleeve[]; default: not declared - policy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - policy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - policy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - policy.model.strategic.note?: string; default: not declared - policy.model.strategic.targets: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - policy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - policy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - policy.performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - policy.restrictedInstruments?: string[]; default: not declared - policy.reviewCadenceDays?: number; default: not declared - policy.targets?: import('@insiderfinance/totalfinance/portfolio').AllocationTarget[]; default: not declared - policy.withdrawalHandling?: import('@insiderfinance/totalfinance/portfolio').WithdrawalHandling; default: not declared - policy.withinGroupAllocation?: import('@insiderfinance/totalfinance/portfolio').WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. - portfolio: PortfolioState; default: not declared - portfolio.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - portfolio.accounts: Record; default: not declared - portfolio.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - portfolio.baseCurrency: string; default: not declared - portfolio.eventCount: number; default: not declared - portfolio.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - portfolio.lastEffectiveTimestampMs: number | null; default: not declared - portfolio.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - portfolio.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolio.portfolioId?: string; default: not declared - portfolio.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - portfolio.schemaVersion: number; default: not declared - previousState: PortfolioMonitorState | null; default: not declared — REQUIRED: the prior evaluation's `state`, or `null` for the first evaluation. - previousState.asOf: number; default: not declared - previousState.evaluationCount: number; default: not declared - previousState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - previousState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - previousState.rules: Record; default: not declared - previousState.schemaVersion: number; default: not declared - reconciliation?: ReconcilePortfolioResult; default: not declared - reconciliation.accounts: import('@insiderfinance/totalfinance/portfolio').ReconciliationAccountReport[]; default: not declared - reconciliation.asOf: number; default: not declared - reconciliation.assumptions: { comparisonConvention: string; conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; tolerance: Required; }; default: not declared - reconciliation.assumptions.comparisonConvention: string; default: not declared - reconciliation.assumptions.conventionsVersion: string; default: not declared - reconciliation.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - reconciliation.assumptions.tolerance: Required; default: not declared - reconciliation.assumptions.tolerance.cashAmount: number; default: not declared - reconciliation.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - reconciliation.assumptions.tolerance.quantity: number; default: not declared - reconciliation.baseCurrency: string; default: not declared - reconciliation.diagnostics: { externalAccountCount: number; ledgerAccountCount: number; warnings: string[]; }; default: not declared - reconciliation.diagnostics.externalAccountCount: number; default: not declared - reconciliation.diagnostics.ledgerAccountCount: number; default: not declared - reconciliation.diagnostics.warnings: string[]; default: not declared - reconciliation.differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - reconciliation.explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - reconciliation.reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - reconciliation.suggestedCorrections: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - reconciliation.undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. - residualTolerance?: number; default: not declared — Base-currency amount above which `|pnl.residual|` is unexplained. - rules?: Partial>; default: not declared - unusualPnlThreshold?: number; default: not declared — Decimal of NAV above which `|pnl.components.totalPnl| ÷ NAV` is unusual. ### @insiderfinance/totalfinance/portfolio#MonitorPortfolioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonitorPortfolioResult { asOf: EpochMs; baseCurrency: string; netAssetValue: number | null; /** Raised / active / acknowledged / suppressed / cleared entries only, sorted by key. */ alerts: MonitorAlert[]; /** One row per family, in the family order. */ evaluated: MonitorFamilyEvaluation[]; state: PortfolioMonitorState; assumptions: { conventionsVersion: string; liquidityParticipationRate: number; /** Prose statement of every convention. String-typed by design. */ conventions: string; rulesApplied: Record; }; diagnostics: { warnings: string[]; unsupportedFamilies: { family: MonitorDeferredFamily; reason: string; }[]; raisedCount: number; /** Rules active AFTER this evaluation (raised, active, acknowledged, and carried-forward). */ activeCount: number; clearedCount: number; suppressedCount: number; acknowledgedCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alerts: MonitorAlert[]; default: not declared — Raised / active / acknowledged / suppressed / cleared entries only, sorted by key. - asOf: number; default: not declared - assumptions: { conventions: string; conventionsVersion: string; liquidityParticipationRate: number; rulesApplied: Record; }; default: not declared - assumptions.conventions: string; default: not declared — Prose statement of every convention. String-typed by design. - assumptions.conventionsVersion: string; default: not declared - assumptions.liquidityParticipationRate: number; default: not declared - assumptions.rulesApplied: Record; default: not declared - baseCurrency: string; default: not declared - diagnostics: { acknowledgedCount: number; activeCount: number; clearedCount: number; raisedCount: number; suppressedCount: number; unsupportedFamilies: { family: MonitorDeferredFamily; reason: string; }[]; warnings: string[]; }; default: not declared - diagnostics.acknowledgedCount: number; default: not declared - diagnostics.activeCount: number; default: not declared — Rules active AFTER this evaluation (raised, active, acknowledged, and carried-forward). - diagnostics.clearedCount: number; default: not declared - diagnostics.raisedCount: number; default: not declared - diagnostics.suppressedCount: number; default: not declared - diagnostics.unsupportedFamilies: { family: MonitorDeferredFamily; reason: string; }[]; default: not declared - diagnostics.warnings: string[]; default: not declared - evaluated: MonitorFamilyEvaluation[]; default: not declared — One row per family, in the family order. - netAssetValue: number | null; default: not declared - state: PortfolioMonitorState; default: not declared - state.asOf: number; default: not declared - state.evaluationCount: number; default: not declared - state.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - state.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - state.rules: Record; default: not declared - state.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#MonitorRule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A per-family rule override. Every field optional; the resolved rule is echoed in the result. ```typescript /** A per-family rule override. Every field optional; the resolved rule is echoed in the result. */ export interface MonitorRule { /** `false` skips the family (its prior state is carried forward untouched). */ enabled?: boolean; /** Replaces the policy's limit (an explicit goal — e.g. an "approach" level below the limit). */ threshold?: number; direction?: MonitorAlertDirection; /** Mutually exclusive with `threshold`; `enter` is the threshold. */ hysteresis?: MonitorHysteresis; /** Consecutive breaching evaluations required before raising. Safe integer ≥ 1 (default 1). */ debounceEvaluations?: number; /** Milliseconds after the last raise during which a re-raise is suppressed. ≥ 0 (default 0). */ cooldownMs?: number; severity?: MonitorAlertSeverity; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cooldownMs?: number; default: not declared — Milliseconds after the last raise during which a re-raise is suppressed. ≥ 0 (default 0). - debounceEvaluations?: number; default: not declared — Consecutive breaching evaluations required before raising. Safe integer ≥ 1 (default 1). - direction?: MonitorAlertDirection; default: not declared - enabled?: boolean; default: not declared — `false` skips the family (its prior state is carried forward untouched). - hysteresis?: MonitorHysteresis; default: not declared — Mutually exclusive with `threshold`; `enter` is the threshold. - hysteresis.enter: number; default: not declared - hysteresis.exit: number; default: not declared - severity?: MonitorAlertSeverity; default: not declared - threshold?: number; default: not declared — Replaces the policy's limit (an explicit goal — e.g. an "approach" level below the limit). ### @insiderfinance/totalfinance/portfolio#MonitorRuleState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One rule's carried state, keyed `'family:key'` in {@link PortfolioMonitorState.rules}. ```typescript /** One rule's carried state, keyed `'family:key'` in {@link PortfolioMonitorState.rules}. */ export interface MonitorRuleState { active: boolean; consecutiveBreaches: number; lastRaisedAtMs: EpochMs | null; acknowledged: boolean; lastValue: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - acknowledged: boolean; default: not declared - active: boolean; default: not declared - consecutiveBreaches: number; default: not declared - lastRaisedAtMs: number | null; default: not declared - lastValue: number | null; default: not declared ### @insiderfinance/totalfinance/portfolio#MonitorThresholdSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MonitorThresholdSource = 'policy' | 'input' | 'rule' | 'per-observation' | 'none'; ``` ### @insiderfinance/totalfinance/portfolio#NORMALIZED_FILL_KEYS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const NORMALIZED_FILL_KEYS: readonly ['fillId', 'accountId', 'instrumentId', 'side', 'quantity', 'pricePerUnit', 'currency', 'filledTimestampMs', 'settleTimestampMs', 'contractMultiplier', 'settlementStyle', 'contract', 'accruedInterest', 'costs', 'executionPriceAdjustment', 'orderId', 'venue', 'liquidity']; ``` ### @insiderfinance/totalfinance/portfolio#NormalizedFill Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One execution fact, normalized. Everything an economic ledger needs to book the fill is here; nothing about the order's journey (acknowledgements, partials, replacements) is — that is the execution journal's, which stays separate from the ledger by design. ```typescript /** * One execution fact, normalized. Everything an economic ledger needs to book the fill is here; * nothing about the order's journey (acknowledgements, partials, replacements) is — that is the * execution journal's, which stays separate from the ledger by design. */ export interface NormalizedFill { /** Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. */ fillId: string; accountId: string; instrumentId: string; side: 'buy' | 'sell'; /** Filled quantity, > 0 (fractional supported); `side` carries the direction. */ quantity: number; /** Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). */ pricePerUnit: number; currency: string; /** When the fill happened — the event's effective instant. */ filledTimestampMs: EpochMs; /** When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. */ settleTimestampMs?: EpochMs; /** Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). */ contractMultiplier?: number; settlementStyle?: SettlementStyle; contract?: DerivativeContractTerms; /** Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. */ accruedInterest?: number; costs?: NormalizedFillCosts; /** Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution * only: already embedded in pricePerUnit, NEVER emitted as another cash charge. */ executionPriceAdjustment?: number; /** The order this fill answers; becomes the events' `correlationId`. */ orderId?: string; venue?: string; liquidity?: NormalizedFillLiquidity; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - contract?: DerivativeContractTerms; default: not declared - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - costs?: NormalizedFillCosts; default: not declared - costs.commission?: number; default: not declared - costs.exchangeFees?: number; default: not declared - costs.regulatoryFees?: number; default: not declared - costs.slippageAdjustment?: number; default: not declared - currency: string; default: not declared - executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - instrumentId: string; default: not declared - liquidity?: NormalizedFillLiquidity; default: not declared - orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - settlementStyle?: SettlementStyle; default: not declared - side: 'buy' | 'sell'; default: not declared - venue?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#NormalizedFillCosts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Additional cash charges, each in the fill's currency, ≥ 0. Never repeat costs embedded in pricePerUnit. ```typescript // --------------------------------------------------------------------------------------------------- // The normalized fill — the audited bridge from an execution fact to economic events (Stage 4.6, // FC8 Decision 2). Backtest, deterministic replay, paper, and live adapters all produce THIS shape; // the ledger records the `trade.fill` and `cost.charge` events it maps to. The package owns the // bridge so no simulator or broker adapter defines a fill of its own. // --------------------------------------------------------------------------------------------------- /** Additional cash charges, each in the fill's currency, ≥ 0. Never repeat costs embedded in pricePerUnit. */ export interface NormalizedFillCosts { commission?: number; exchangeFees?: number; regulatoryFees?: number; slippageAdjustment?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission?: number; default: not declared - exchangeFees?: number; default: not declared - regulatoryFees?: number; default: not declared - slippageAdjustment?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#NormalizedFillLiquidity Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether the fill added liquidity (rested) or removed it (crossed); unknown when the venue did not say. ```typescript /** Whether the fill added liquidity (rested) or removed it (crossed); unknown when the venue did not say. */ export type NormalizedFillLiquidity = 'maker' | 'taker' | 'unknown'; ``` ### @insiderfinance/totalfinance/portfolio#OptionAssignmentEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A writer is assigned on short option contracts. ```typescript /** A writer is assigned on short option contracts. */ export interface OptionAssignmentEvent { eventType: 'derivative.assignment'; instrumentId: string; /** Contracts assigned, > 0. */ quantity: number; settlement: DerivativeSettlement; premiumTreatment: PremiumTreatment; settleTimestampMs?: EpochMs; lotSelections?: TradeFillLotSelection[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'derivative.assignment'; default: not declared - instrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared - premiumTreatment: PremiumTreatment; default: not declared - quantity: number; default: not declared — Contracts assigned, > 0. - settleTimestampMs?: number; default: not declared - settlement: DerivativeSettlement; default: not declared - settlement.kind: ('cash') | ('physical'); default: not declared - settlement.settlementPricePerUnit: number; default: not declared ### @insiderfinance/totalfinance/portfolio#OptionContractTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionContractTerms { kind: 'option'; underlyingInstrumentId: string; /** `'call' | 'put'` — the same word the option contract and every chain row use (B6). */ type: 'call' | 'put'; strikePricePerUnit: number; expiryTimestampMs: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiryTimestampMs: number; default: not declared - kind: 'option'; default: not declared - strikePricePerUnit: number; default: not declared - type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - underlyingInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#OptionExerciseEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A holder exercises long option contracts. ```typescript /** A holder exercises long option contracts. */ export interface OptionExerciseEvent { eventType: 'derivative.exercise'; instrumentId: string; /** Contracts exercised, > 0. */ quantity: number; settlement: DerivativeSettlement; premiumTreatment: PremiumTreatment; settleTimestampMs?: EpochMs; lotSelections?: TradeFillLotSelection[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'derivative.exercise'; default: not declared - instrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared - premiumTreatment: PremiumTreatment; default: not declared - quantity: number; default: not declared — Contracts exercised, > 0. - settleTimestampMs?: number; default: not declared - settlement: DerivativeSettlement; default: not declared - settlement.kind: ('cash') | ('physical'); default: not declared - settlement.settlementPricePerUnit: number; default: not declared ### @insiderfinance/totalfinance/portfolio#OptionExpirationEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Option contracts expire worthless: lots are relieved at zero, no cash moves. ```typescript /** Option contracts expire worthless: lots are relieved at zero, no cash moves. */ export interface OptionExpirationEvent { eventType: 'derivative.expiration'; instrumentId: string; /** Contracts expiring, > 0. */ quantity: number; lotSelections?: TradeFillLotSelection[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'derivative.expiration'; default: not declared - instrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared - quantity: number; default: not declared — Contracts expiring, > 0. ### @insiderfinance/totalfinance/portfolio#OrderSide Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderSide`. ### @insiderfinance/totalfinance/portfolio#OrderType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderType`. ### @insiderfinance/totalfinance/portfolio#PORTFOLIO_EVENT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Version of the event grammar carried by EVERY envelope. Bump only with a payload shape change, landed together with a registered ledger migration. ```typescript export declare const PORTFOLIO_EVENT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio#PORTFOLIO_LEDGER_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const PORTFOLIO_LEDGER_KIND: 'totalfinance.portfolio-ledger'; ``` ### @insiderfinance/totalfinance/portfolio#PORTFOLIO_LEDGER_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Current ledger-envelope schema version. Bump ONLY with a shape change, landed together with a registered migration — `readPortfolioLedgerSnapshot` refuses an older stored version without one, and refuses a newer version outright (this build cannot know what changed). ```typescript export declare const PORTFOLIO_LEDGER_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio#PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio#PORTFOLIO_STATE_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 2 (2026-08-28, FC7 slice 2): accounts gained the per-instrument attribution maps. 3 (2026-08-28, FC7 slice 3): the fold records per-fill effects (for exact reversal), the reversal links, and account-migration markers. 4 (2026-08-29, FC7 slice 5): positions carry their instrument profile (contract multiplier, settlement style, derivative terms) and fill effects record the cash they booked. ```typescript export declare const PORTFOLIO_STATE_SCHEMA_VERSION: 4; ``` ### @insiderfinance/totalfinance/portfolio#PerpetualContractTerms Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PerpetualContractTerms { kind: 'perpetual'; underlyingInstrumentId: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'perpetual'; default: not declared - underlyingInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PolicyCheck Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PolicyCheck { name: string; verdict: PolicyCheckVerdict; value: number | string | null; limit: number | string | null; detail: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: string; default: not declared - limit: string | number | null; default: not declared - name: string; default: not declared - value: string | number | null; default: not declared - verdict: PolicyCheckVerdict; default: not declared ### @insiderfinance/totalfinance/portfolio#PolicyDecision Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PolicyDecision = { verdict: 'allow'; checks: PolicyCheck[]; } | { verdict: 'deny'; checks: PolicyCheck[]; } | { verdict: 'require-approval'; checks: PolicyCheck[]; requiredScope: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - checks: PolicyCheck[]; default: not declared - requiredScope: string; default: not declared - verdict: ('allow') | ('deny') | ('require-approval'); default: not declared ### @insiderfinance/totalfinance/portfolio#PolicyLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Hard limits a proposal must satisfy and a monitor evaluates. Every limit is explicit. ```typescript /** Hard limits a proposal must satisfy and a monitor evaluates. Every limit is explicit. */ export interface PolicyLimits { /** Maximum absolute weight of any single instrument (decimal of NAV). */ maximumPositionWeight?: number; maximumGroupWeights?: GroupWeightLimit[]; /** Maximum gross exposure ÷ NAV (1 = unlevered). */ maximumGrossLeverage?: number; /** Maximum peak-to-trough drawdown of NAV (decimal). */ maximumDrawdown?: number; /** Maximum one-evaluation NAV loss (decimal of the prior NAV). */ maximumDailyLoss?: number; /** Maximum days to liquidate any position at the supplied participation rate. */ maximumDaysToLiquidate?: number; /** Minimum settled cash in base currency (a margin/buying-power floor; may be negative). */ minimumSettledCash?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - maximumGroupWeights?: GroupWeightLimit[]; default: not declared - maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). ### @insiderfinance/totalfinance/portfolio#PortfolioDefinition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The fresh-ledger definition accepted by {@link applyPortfolioEvents} and the ledger artifact. ```typescript /** The fresh-ledger definition accepted by {@link applyPortfolioEvents} and the ledger artifact. */ export interface PortfolioDefinition { portfolioId?: string; baseCurrency: string; /** Defaults to `'fifo'` (documented; echoed on the state and every ledger envelope). */ lotRelief?: LotReliefPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - lotRelief?: LotReliefPolicy; default: not declared — Defaults to `'fifo'` (documented; echoed on the state and every ledger envelope). - portfolioId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioEvent Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PortfolioEvent = EconomicPortfolioEvent | AdminReversalEvent | AdminCorrectionEvent | AdminAccountMigrationEvent; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - amountPerShare: number; default: not declared - basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - cashPerShare?: number; default: not declared - childInstrumentId: string; default: not declared - closePricePerUnit: number; default: not declared - contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - contractMultiplierAfter: number; default: not declared - costType: CostType; default: not declared - currency?: string; default: not declared — Required with `cashPerShare`. - eventType: ('admin.account-migration') | ('admin.correction') | ('admin.reversal') | ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - financingType: FinancingType; default: not declared - fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - fromCurrency: string; default: not declared - fromInstrumentId: string; default: not declared - incomeType: IncomeType; default: not declared - instrumentId?: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - openPricePerUnit: number; default: not declared - original: PortfolioEventEnvelope; default: not declared - original.accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - original.causationId?: string; default: not declared - original.correlationId?: string; default: not declared - original.effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - original.event: PortfolioEvent; default: not declared - original.eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - original.eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - original.provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - original.provenance.asOf?: number; default: not declared - original.provenance.dataset?: string; default: not declared - original.provenance.provider?: string; default: not declared - original.provenance.receivedAt?: number; default: not declared - original.provenance.requestId?: string; default: not declared - original.provenance.sourceVersion?: string; default: not declared - original.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - original.recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - original.reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - original.schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - original.sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - parentInstrumentId: string; default: not declared - premiumTreatment: PremiumTreatment; default: not declared - pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - reason?: string; default: not declared - redemptionType: RedemptionType; default: not declared - relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - replacement: EconomicPortfolioEvent; default: not declared - replacement.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - replacement.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - replacement.amountPerShare: number; default: not declared - replacement.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - replacement.cashPerShare?: number; default: not declared - replacement.childInstrumentId: string; default: not declared - replacement.closePricePerUnit: number; default: not declared - replacement.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - replacement.contract.expiryTimestampMs: number; default: not declared - replacement.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - replacement.contract.strikePricePerUnit: number; default: not declared - replacement.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - replacement.contract.underlyingInstrumentId: string; default: not declared - replacement.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - replacement.contractMultiplierAfter: number; default: not declared - replacement.costType: CostType; default: not declared - replacement.currency?: string; default: not declared — Required with `cashPerShare`. - replacement.eventType: ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - replacement.financingType: FinancingType; default: not declared - replacement.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - replacement.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - replacement.fromCurrency: string; default: not declared - replacement.fromInstrumentId: string; default: not declared - replacement.incomeType: IncomeType; default: not declared - replacement.instrumentId?: string; default: not declared - replacement.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - replacement.openPricePerUnit: number; default: not declared - replacement.parentInstrumentId: string; default: not declared - replacement.premiumTreatment: PremiumTreatment; default: not declared - replacement.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - replacement.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - replacement.reason?: string; default: not declared - replacement.redemptionType: RedemptionType; default: not declared - replacement.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - replacement.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - replacement.settlement: DerivativeSettlement; default: not declared - replacement.settlement.kind: ('cash') | ('physical'); default: not declared - replacement.settlement.settlementPricePerUnit: number; default: not declared - replacement.settlementPricePerUnit: number; default: not declared - replacement.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - replacement.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - replacement.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - replacement.sharesPerParentShare: number; default: not declared - replacement.sharesPerShare?: number; default: not declared - replacement.side: 'buy' | 'sell'; default: not declared - replacement.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - replacement.toAccountId: string; default: not declared - replacement.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - replacement.toCurrency: string; default: not declared - replacement.toInstrumentId?: string; default: not declared - settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - settlement: DerivativeSettlement; default: not declared - settlement.kind: ('cash') | ('physical'); default: not declared - settlement.settlementPricePerUnit: number; default: not declared - settlementPricePerUnit: number; default: not declared - settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - sharesPerParentShare: number; default: not declared - sharesPerShare?: number; default: not declared - side: 'buy' | 'sell'; default: not declared - strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - toAccountId: string; default: not declared - toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - toCurrency: string; default: not declared - toInstrumentId?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioEventEnvelope Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The canonical event envelope — JSON-safe, CloudEvents-mappable without the dependency, and clock-free: BOTH timestamps are supplied explicitly; the package never reads the system clock. `(sourceId, eventId)` is the duplicate boundary: replaying an identical envelope is a no-op, and a same-key envelope with a different body is a typed conflict (`portfolio.duplicate_event_conflict`). ```typescript // --------------------------------------------------------------------------------------------------- // The envelope (the agent-native doc's decided shape) // --------------------------------------------------------------------------------------------------- /** * The canonical event envelope — JSON-safe, CloudEvents-mappable without the dependency, and * clock-free: BOTH timestamps are supplied explicitly; the package never reads the system clock. * `(sourceId, eventId)` is the duplicate boundary: replaying an identical envelope is a no-op, * and a same-key envelope with a different body is a typed conflict * (`portfolio.duplicate_event_conflict`). */ export interface PortfolioEventEnvelope { /** Unique within `sourceId` — together they are the duplicate boundary. */ eventId: string; /** Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. */ schemaVersion: number; /** Redundant discriminator; must equal `event.eventType`. */ eventType: PortfolioEventType; /** The system that emitted the event (a broker import, a simulator, a manual entry). */ sourceId: string; /** The account the event is recorded against (for transfers, the FROM account). */ accountId: string; /** When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. */ effectiveTimestampMs: EpochMs; /** When the event was recorded — may lag the effect; never read from a clock by this package. */ recordedTimestampMs: EpochMs; correlationId?: string; causationId?: string; /** Names a prior event this one reverses. Recorded now; the repair fold is a later slice. */ reversesEventId?: string; event: PortfolioEvent; /** Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. */ provenance: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - causationId?: string; default: not declared - correlationId?: string; default: not declared - effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - event: PortfolioEvent; default: not declared - event.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - event.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - event.amountPerShare: number; default: not declared - event.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - event.cashPerShare?: number; default: not declared - event.childInstrumentId: string; default: not declared - event.closePricePerUnit: number; default: not declared - event.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - event.contract.expiryTimestampMs: number; default: not declared - event.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - event.contract.strikePricePerUnit: number; default: not declared - event.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - event.contract.underlyingInstrumentId: string; default: not declared - event.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - event.contractMultiplierAfter: number; default: not declared - event.costType: CostType; default: not declared - event.currency?: string; default: not declared — Required with `cashPerShare`. - event.eventType: ('admin.account-migration') | ('admin.correction') | ('admin.reversal') | ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - event.financingType: FinancingType; default: not declared - event.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - event.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - event.fromCurrency: string; default: not declared - event.fromInstrumentId: string; default: not declared - event.incomeType: IncomeType; default: not declared - event.instrumentId?: string; default: not declared - event.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - event.openPricePerUnit: number; default: not declared - event.original: PortfolioEventEnvelope; default: not declared - event.parentInstrumentId: string; default: not declared - event.premiumTreatment: PremiumTreatment; default: not declared - event.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - event.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - event.reason?: string; default: not declared - event.redemptionType: RedemptionType; default: not declared - event.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - event.replacement: EconomicPortfolioEvent; default: not declared - event.replacement.accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - event.replacement.amount: number; default: not declared — Magnitude deposited, > 0, in `currency`. Magnitude withdrawn, > 0, in `currency`. Magnitude transferred, > 0, in `currency`. Finite and non-zero: > 0 charges cash, < 0 is a rebate/credit. Finite and non-zero, in `currency`. Dividends/coupons may be negative (income owed on a short); other income types must be positive (funding payments use `financing.charge`). Magnitude charged, > 0, in `currency` (a funding RECEIPT is `income.received`). Cash received, in `currency`. - event.replacement.amountPerShare: number; default: not declared - event.replacement.basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - event.replacement.cashPerShare?: number; default: not declared - event.replacement.childInstrumentId: string; default: not declared - event.replacement.closePricePerUnit: number; default: not declared - event.replacement.contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. Terms of the successor contract (the multiplier and settlement style carry over). - event.replacement.contract.expiryTimestampMs: number; default: not declared - event.replacement.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - event.replacement.contract.strikePricePerUnit: number; default: not declared - event.replacement.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - event.replacement.contract.underlyingInstrumentId: string; default: not declared - event.replacement.contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - event.replacement.contractMultiplierAfter: number; default: not declared - event.replacement.costType: CostType; default: not declared - event.replacement.currency?: string; default: not declared — Required with `cashPerShare`. - event.replacement.eventType: ('cash.conversion') | ('cash.deposit') | ('cash.transfer') | ('cash.withdrawal') | ('corporate.cash-in-lieu') | ('corporate.merger') | ('corporate.return-of-capital') | ('corporate.spin-off') | ('corporate.split') | ('corporate.symbol-change') | ('cost.charge') | ('derivative.assignment') | ('derivative.exercise') | ('derivative.expiration') | ('derivative.multiplier-change') | ('derivative.roll') | ('derivative.variation-margin') | ('financing.charge') | ('fixed-income.redemption') | ('income.received') | ('position.transfer') | ('trade.fill'); default: not declared - event.replacement.financingType: FinancingType; default: not declared - event.replacement.fromAccountId: string; default: not declared — Must equal the envelope's `accountId` — the account the transfer leaves. - event.replacement.fromAmount: number; default: not declared — Magnitude of `fromCurrency` sold, > 0. - event.replacement.fromCurrency: string; default: not declared - event.replacement.fromInstrumentId: string; default: not declared - event.replacement.incomeType: IncomeType; default: not declared - event.replacement.instrumentId?: string; default: not declared - event.replacement.lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - event.replacement.openPricePerUnit: number; default: not declared - event.replacement.parentInstrumentId: string; default: not declared - event.replacement.premiumTreatment: PremiumTreatment; default: not declared - event.replacement.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). Redemption price per unit (par = 1 per unit of face, or 100 per 100 face — the fill's unit). - event.replacement.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. Contracts exercised, > 0. Contracts assigned, > 0. Contracts expiring, > 0. Contracts rolled, > 0. Magnitude of face units redeemed, > 0, for either a long or short holding. Fractional quantity surrendered, > 0. Unsigned quantity moved, > 0. - event.replacement.reason?: string; default: not declared - event.replacement.redemptionType: RedemptionType; default: not declared - event.replacement.relatesToEventId?: string; default: not declared — The `eventId` of the fill (or other event) this cost belongs to, when known. - event.replacement.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - event.replacement.settlement: DerivativeSettlement; default: not declared - event.replacement.settlement.kind: ('cash') | ('physical'); default: not declared - event.replacement.settlement.settlementPricePerUnit: number; default: not declared - event.replacement.settlementPricePerUnit: number; default: not declared - event.replacement.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - event.replacement.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - event.replacement.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - event.replacement.sharesPerParentShare: number; default: not declared - event.replacement.sharesPerShare?: number; default: not declared - event.replacement.side: 'buy' | 'sell'; default: not declared - event.replacement.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - event.replacement.toAccountId: string; default: not declared - event.replacement.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - event.replacement.toCurrency: string; default: not declared - event.replacement.toInstrumentId?: string; default: not declared - event.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settled at `effectiveTimestampMs`. When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - event.settlement: DerivativeSettlement; default: not declared - event.settlement.kind: ('cash') | ('physical'); default: not declared - event.settlement.settlementPricePerUnit: number; default: not declared - event.settlementPricePerUnit: number; default: not declared - event.settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - event.sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - event.sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. - event.sharesPerParentShare: number; default: not declared - event.sharesPerShare?: number; default: not declared - event.side: 'buy' | 'sell'; default: not declared - event.strikePricePerUnitAfter?: number; default: not declared — An adjusted strike (OCC-style adjustments change both); only for a position with option terms. - event.toAccountId: string; default: not declared - event.toAmount: number; default: not declared — Magnitude of `toCurrency` received, > 0. - event.toCurrency: string; default: not declared - event.toInstrumentId?: string; default: not declared - eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). ### @insiderfinance/totalfinance/portfolio#PortfolioEventType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PortfolioEventType = PortfolioEvent['eventType']; ``` ### @insiderfinance/totalfinance/portfolio#PortfolioEventsFromFillInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link portfolioEventsFromFill}. ```typescript /** Input for {@link portfolioEventsFromFill}. */ export interface PortfolioEventsFromFillInput { fill: NormalizedFill; /** The system that produced the fill — `'backtest:'`, a broker import id, a paper account. */ sourceId: string; /** When the events are recorded — supplied, never read from a clock. */ recordedTimestampMs: EpochMs; /** Where the fill came from; `{}` when there is no further detail. Outside the event identity. */ provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fill: NormalizedFill; default: not declared - fill.accountId: string; default: not declared - fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - fill.contract?: DerivativeContractTerms; default: not declared - fill.contract.expiryTimestampMs: number; default: not declared - fill.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - fill.contract.strikePricePerUnit: number; default: not declared - fill.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - fill.contract.underlyingInstrumentId: string; default: not declared - fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - fill.costs?: NormalizedFillCosts; default: not declared - fill.costs.commission?: number; default: not declared - fill.costs.exchangeFees?: number; default: not declared - fill.costs.regulatoryFees?: number; default: not declared - fill.costs.slippageAdjustment?: number; default: not declared - fill.currency: string; default: not declared - fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - fill.instrumentId: string; default: not declared - fill.liquidity?: NormalizedFillLiquidity; default: not declared - fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - fill.settlementStyle?: SettlementStyle; default: not declared - fill.side: 'buy' | 'sell'; default: not declared - fill.venue?: string; default: not declared - provenance?: Provenance; default: not declared — Where the fill came from; `{}` when there is no further detail. Outside the event identity. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - recordedTimestampMs: number; default: not declared — When the events are recorded — supplied, never read from a clock. - sourceId: string; default: not declared — The system that produced the fill — `'backtest:'`, a broker import id, a paper account. ### @insiderfinance/totalfinance/portfolio#PortfolioExposure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------------------------------- export interface PortfolioExposure { /** Σ positive position base values. */ long: number; /** Σ |negative position base values| (a positive magnitude). */ short: number; /** `long + short`. */ gross: number; /** `long − short`. */ net: number; /** `gross / netAssetValue`, `null` when NAV is 0. */ grossLeverage: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - gross: number; default: not declared — `long + short`. - grossLeverage: number | null; default: not declared — `gross / netAssetValue`, `null` when NAV is 0. - long: number; default: not declared — Σ positive position base values. - net: number; default: not declared — `long − short`. - short: number; default: not declared — Σ |negative position base values| (a positive magnitude). ### @insiderfinance/totalfinance/portfolio#PortfolioExposureGroupRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioExposureGroupRow { label: string; /** The group's notional exposure in base currency (quantity × mark × multiplier), signed. */ baseCurrencyNotionalValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrencyNotionalValue: number; default: not declared — The group's notional exposure in base currency (quantity × mark × multiplier), signed. - label: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioExposureGrouping Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioExposureGrouping { dimension: PortfolioGroupingDimension; rows: PortfolioExposureGroupRow[]; /** `Σ rows − positions base value`; 0 within 1e-9 for partitioning dimensions. */ reconciliationResidual: number; reconciles: boolean; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dimension: PortfolioGroupingDimension; default: not declared - reason?: string; default: not declared - reconciles: boolean; default: not declared - reconciliationResidual: number; default: not declared — `Σ rows − positions base value`; 0 within 1e-9 for partitioning dimensions. - rows: PortfolioExposureGroupRow[]; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioGroupingDimension Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PortfolioGroupingDimension = 'position' | 'instrument' | 'account' | 'currency' | 'underlying' | 'assetClass' | 'strategy' | 'tag'; ``` ### @insiderfinance/totalfinance/portfolio#PortfolioLedger Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The immutable reusable ledger artifact (the agent-native doc's decided API ladder). It earns its existence through repeated queries, identity, migration, and replay; it does not hide the reducer (`applyPortfolioEvents` stays independently public) and requires no storage. ```typescript /** * The immutable reusable ledger artifact (the agent-native doc's decided API ladder). It earns * its existence through repeated queries, identity, migration, and replay; it does not hide the * reducer (`applyPortfolioEvents` stays independently public) and requires no storage. */ export interface PortfolioLedger { readonly portfolioId?: string; readonly baseCurrency: string; readonly lotRelief: LotReliefPolicy; /** The applied economic events, canonical and frozen. Identical no-op replays are not stored. */ readonly events: readonly PortfolioEventEnvelope[]; /** The derived state — the fold of `events` under `lotRelief`. */ readonly state: PortfolioState; readonly provenance?: Provenance; /** Fold more events and return a NEW immutable ledger; this one is untouched. */ apply(events: readonly PortfolioEventEnvelope[]): PortfolioLedger; /** The serialized envelope (also what `JSON.stringify(ledger)` emits). */ toJSON(): PortfolioLedgerSnapshot; /** `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). */ pnl(input: Omit): PortfolioPnlResult; /** `portfolioTimeline` over this ledger (slice 2). */ timeline(input: Omit): PortfolioTimelineResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - apply: (events: readonly PortfolioEventEnvelope[]) => PortfolioLedger; default: not declared — Fold more events and return a NEW immutable ledger; this one is untouched. - apply(events): readonly PortfolioEventEnvelope[]; default: not declared - baseCurrency: string; default: not declared - events: readonly PortfolioEventEnvelope[]; default: not declared — The applied economic events, canonical and frozen. Identical no-op replays are not stored. - lotRelief: LotReliefPolicy; default: not declared - pnl: (input: Omit) => PortfolioPnlResult; default: not declared — `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). - pnl().return.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - pnl().return.assumptions.conventionsVersion: string; default: not declared - pnl().return.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - pnl().return.assumptions.identity: string; default: not declared — The identity, stated. - pnl().return.assumptions.lotRelief: LotReliefPolicy; default: not declared - pnl().return.assumptions.residualTolerance: number; default: not declared - pnl().return.baseCurrency: string; default: not declared - pnl().return.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - pnl().return.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - pnl().return.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - pnl().return.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - pnl().return.diagnostics.residualWithinTolerance: boolean; default: not declared - pnl().return.diagnostics.warnings: string[]; default: not declared - pnl().return.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - pnl().return.from: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - pnl().return.from.asOf: number; default: not declared - pnl().return.from.netAssetValue: number; default: not declared - pnl().return.from.valuationDate: string; default: not declared - pnl().return.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - pnl().return.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - pnl().return.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - pnl().return.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - pnl().return.to: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - pnl().return.to.asOf: number; default: not declared - pnl().return.to.netAssetValue: number; default: not declared - pnl().return.to.valuationDate: string; default: not declared - pnl(input): Omit; default: not declared - pnl(input).from: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark; default: not declared - pnl(input).instrumentClassification?: Record; default: not declared - pnl(input).to: import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark; default: not declared - portfolioId?: string; default: not declared - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - state: PortfolioState; default: not declared — The derived state — the fold of `events` under `lotRelief`. - state.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - state.accounts: Record; default: not declared - state.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - state.baseCurrency: string; default: not declared - state.eventCount: number; default: not declared - state.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - state.lastEffectiveTimestampMs: number | null; default: not declared - state.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - state.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - state.portfolioId?: string; default: not declared - state.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - state.schemaVersion: number; default: not declared - timeline: (input: Omit) => PortfolioTimelineResult; default: not declared — `portfolioTimeline` over this ledger (slice 2). - timeline().return.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - timeline().return.assumptions.conventionsVersion: string; default: not declared - timeline().return.assumptions.exposureConvention: string; default: not declared - timeline().return.assumptions.indexConvention: string; default: not declared - timeline().return.assumptions.lotRelief: LotReliefPolicy; default: not declared - timeline().return.assumptions.markInstant: string; default: not declared - timeline().return.baseCurrency: string; default: not declared - timeline().return.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - timeline().return.cumulativePnl.financing: number; default: not declared - timeline().return.cumulativePnl.foreignExchangePnl: number; default: not declared - timeline().return.cumulativePnl.income: number; default: not declared - timeline().return.cumulativePnl.realizedPnl: number; default: not declared - timeline().return.cumulativePnl.residual: number; default: not declared - timeline().return.cumulativePnl.totalPnl: number; default: not declared - timeline().return.cumulativePnl.transactionCosts: number; default: not declared - timeline().return.cumulativePnl.unrealizedPnl: number; default: not declared - timeline().return.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - timeline().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - timeline().return.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - timeline().return.diagnostics.markCount: number; default: not declared - timeline().return.diagnostics.warnings: string[]; default: not declared - timeline().return.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - timeline().return.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - timeline().return.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - timeline().return.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - timeline(input): Omit; default: not declared - timeline(input).instrumentClassification?: Record; default: not declared - timeline(input).valuationMarks: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. - toJSON: () => PortfolioLedgerSnapshot; default: not declared — The serialized envelope (also what `JSON.stringify(ledger)` emits). - toJSON().return.baseCurrency: string; default: not declared - toJSON().return.events: PortfolioEventEnvelope[]; default: not declared - toJSON().return.kind: 'totalfinance.portfolio-ledger'; default: not declared - toJSON().return.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - toJSON().return.portfolioId?: string; default: not declared - toJSON().return.provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - toJSON().return.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioLedgerSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The serialized ledger: pure JSON, canonical-JSON-stable, storable anywhere. Derived state is deliberately ABSENT — restoring re-folds the events, so the stored form can never disagree with the accounting that produced it. ```typescript /** * The serialized ledger: pure JSON, canonical-JSON-stable, storable anywhere. Derived state is * deliberately ABSENT — restoring re-folds the events, so the stored form can never disagree * with the accounting that produced it. */ export interface PortfolioLedgerSnapshot { kind: typeof PORTFOLIO_LEDGER_KIND; schemaVersion: number; portfolioId?: string; baseCurrency: string; /** The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). */ lotRelief: LotReliefPolicy; events: PortfolioEventEnvelope[]; /** Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. */ provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseCurrency: string; default: not declared - events: PortfolioEventEnvelope[]; default: not declared - kind: 'totalfinance.portfolio-ledger'; default: not declared - lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - portfolioId?: string; default: not declared - provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioMonitorState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The JSON-safe, frozen monitor state handed back as the next evaluation's `previousState`. ```typescript /** The JSON-safe, frozen monitor state handed back as the next evaluation's `previousState`. */ export interface PortfolioMonitorState { schemaVersion: number; asOf: EpochMs; /** The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). */ netAssetValue: number | null; /** The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. */ peakNetAssetValue: number | null; evaluationCount: number; rules: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - evaluationCount: number; default: not declared - netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - rules: Record; default: not declared - schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioPerformanceInputsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link portfolioPerformanceInputs}. ```typescript /** Input for {@link portfolioPerformanceInputs}. */ export interface PortfolioPerformanceInputsInput { ledger: PortfolioLedger; /** At least two marks, strictly ascending by date — a return is measured BETWEEN valuations. */ valuationMarks: readonly PortfolioValuationMark[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ledger: PortfolioLedger; default: not declared - ledger.apply: (events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]) => PortfolioLedger; default: not declared — Fold more events and return a NEW immutable ledger; this one is untouched. - ledger.apply(events): readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.baseCurrency: string; default: not declared - ledger.events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — The applied economic events, canonical and frozen. Identical no-op replays are not stored. - ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - ledger.pnl: (input: Omit) => import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult; default: not declared — `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). - ledger.pnl().return.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; residualTolerance: number; }; default: not declared - ledger.pnl().return.assumptions.conventionsVersion: string; default: not declared - ledger.pnl().return.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - ledger.pnl().return.assumptions.identity: string; default: not declared — The identity, stated. - ledger.pnl().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - ledger.pnl().return.assumptions.residualTolerance: number; default: not declared - ledger.pnl().return.baseCurrency: string; default: not declared - ledger.pnl().return.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - ledger.pnl().return.components: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - ledger.pnl().return.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - ledger.pnl().return.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - ledger.pnl().return.diagnostics.residualWithinTolerance: boolean; default: not declared - ledger.pnl().return.diagnostics.warnings: string[]; default: not declared - ledger.pnl().return.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - ledger.pnl().return.from: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - ledger.pnl().return.from.asOf: number; default: not declared - ledger.pnl().return.from.netAssetValue: number; default: not declared - ledger.pnl().return.from.valuationDate: string; default: not declared - ledger.pnl().return.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - ledger.pnl().return.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - ledger.pnl().return.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - ledger.pnl().return.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - ledger.pnl().return.to: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - ledger.pnl().return.to.asOf: number; default: not declared - ledger.pnl().return.to.netAssetValue: number; default: not declared - ledger.pnl().return.to.valuationDate: string; default: not declared - ledger.pnl(input): Omit; default: not declared - ledger.pnl(input).from: PortfolioValuationMark; default: not declared - ledger.pnl(input).instrumentClassification?: Record; default: not declared - ledger.pnl(input).to: PortfolioValuationMark; default: not declared - ledger.portfolioId?: string; default: not declared - ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - ledger.provenance.asOf?: number; default: not declared - ledger.provenance.dataset?: string; default: not declared - ledger.provenance.provider?: string; default: not declared - ledger.provenance.receivedAt?: number; default: not declared - ledger.provenance.requestId?: string; default: not declared - ledger.provenance.sourceVersion?: string; default: not declared - ledger.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - ledger.state: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared — The derived state — the fold of `events` under `lotRelief`. - ledger.state.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - ledger.state.accounts: Record; default: not declared - ledger.state.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - ledger.state.baseCurrency: string; default: not declared - ledger.state.eventCount: number; default: not declared - ledger.state.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - ledger.state.lastEffectiveTimestampMs: number | null; default: not declared - ledger.state.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - ledger.state.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - ledger.state.portfolioId?: string; default: not declared - ledger.state.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - ledger.state.schemaVersion: number; default: not declared - ledger.timeline: (input: Omit) => import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared — `portfolioTimeline` over this ledger (slice 2). - ledger.timeline().return.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; markInstant: string; }; default: not declared - ledger.timeline().return.assumptions.conventionsVersion: string; default: not declared - ledger.timeline().return.assumptions.exposureConvention: string; default: not declared - ledger.timeline().return.assumptions.indexConvention: string; default: not declared - ledger.timeline().return.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - ledger.timeline().return.assumptions.markInstant: string; default: not declared - ledger.timeline().return.baseCurrency: string; default: not declared - ledger.timeline().return.cumulativePnl: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - ledger.timeline().return.cumulativePnl.financing: number; default: not declared - ledger.timeline().return.cumulativePnl.foreignExchangePnl: number; default: not declared - ledger.timeline().return.cumulativePnl.income: number; default: not declared - ledger.timeline().return.cumulativePnl.realizedPnl: number; default: not declared - ledger.timeline().return.cumulativePnl.residual: number; default: not declared - ledger.timeline().return.cumulativePnl.totalPnl: number; default: not declared - ledger.timeline().return.cumulativePnl.transactionCosts: number; default: not declared - ledger.timeline().return.cumulativePnl.unrealizedPnl: number; default: not declared - ledger.timeline().return.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - ledger.timeline().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - ledger.timeline().return.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - ledger.timeline().return.diagnostics.markCount: number; default: not declared - ledger.timeline().return.diagnostics.warnings: string[]; default: not declared - ledger.timeline().return.externalCashFlows: ExternalCashFlow[]; default: not declared - ledger.timeline().return.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - ledger.timeline().return.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - ledger.timeline().return.valuations: PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - ledger.timeline(input): Omit; default: not declared - ledger.timeline(input).instrumentClassification?: Record; default: not declared - ledger.timeline(input).valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. - ledger.toJSON: () => import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared — The serialized envelope (also what `JSON.stringify(ledger)` emits). - ledger.toJSON().return.baseCurrency: string; default: not declared - ledger.toJSON().return.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.toJSON().return.kind: 'totalfinance.portfolio-ledger'; default: not declared - ledger.toJSON().return.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - ledger.toJSON().return.portfolioId?: string; default: not declared - ledger.toJSON().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - ledger.toJSON().return.schemaVersion: number; default: not declared - valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date — a return is measured BETWEEN valuations. ### @insiderfinance/totalfinance/portfolio#PortfolioPerformanceInputsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link portfolioPerformanceInputs} — FC4's exact input series. ```typescript /** Result of {@link portfolioPerformanceInputs} — FC4's exact input series. */ export interface PortfolioPerformanceInputsResult { /** Feed directly to `timeWeightedReturn` / `moneyWeightedReturn` as `valuations`. */ valuations: PortfolioValuation[]; /** Feed directly as `externalCashFlows`; `label` carries the source `eventId`. */ externalCashFlows: ExternalCashFlow[]; assumptions: { conventionsVersion: string; /** Prose statement of the mark instant and its agreement with FC4's flow convention. */ markInstant: string; /** Prose statement of which events are external flows and how they convert. */ flowMapping: string; }; diagnostics: { warnings: string[]; markCount: number; flowCount: number; /** Deposits/withdrawals outside the [first, last] mark window — excluded, disclosed. */ excludedFlowCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; flowMapping: string; markInstant: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.flowMapping: string; default: not declared — Prose statement of which events are external flows and how they convert. - assumptions.markInstant: string; default: not declared — Prose statement of the mark instant and its agreement with FC4's flow convention. - diagnostics: { excludedFlowCount: number; flowCount: number; markCount: number; warnings: string[]; }; default: not declared - diagnostics.excludedFlowCount: number; default: not declared — Deposits/withdrawals outside the [first, last] mark window — excluded, disclosed. - diagnostics.flowCount: number; default: not declared - diagnostics.markCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - externalCashFlows: ExternalCashFlow[]; default: not declared — Feed directly as `externalCashFlows`; `label` carries the source `eventId`. - valuations: PortfolioValuation[]; default: not declared — Feed directly to `timeWeightedReturn` / `moneyWeightedReturn` as `valuations`. ### @insiderfinance/totalfinance/portfolio#PortfolioPnlComponents Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). P&L components in the base currency. `totalPnl` is their signed sum. ```typescript /** P&L components in the base currency. `totalPnl` is their signed sum. */ export interface PortfolioPnlComponents { realizedPnl: number; unrealizedPnl: number; income: number; transactionCosts: number; financing: number; foreignExchangePnl: number; totalPnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - financing: number; default: not declared - foreignExchangePnl: number; default: not declared - income: number; default: not declared - realizedPnl: number; default: not declared - totalPnl: number; default: not declared - transactionCosts: number; default: not declared - unrealizedPnl: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioPnlCurrencyRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One currency's ledger over the window, in that currency's own units unless stated. ```typescript /** One currency's ledger over the window, in that currency's own units unless stated. */ export interface PortfolioPnlCurrencyRow { currency: string; /** Base per unit of this currency at the opening and closing marks (1 for the base currency). */ quoteAtStart: number; quoteAtEnd: number; /** Cash plus position market value in this currency at the opening / closing mark. */ openingLocalValue: number; closingLocalValue: number; realizedPnl: number; unrealizedPnl: number; income: number; transactionCosts: number; financing: number; /** Deposits − withdrawals in this currency over the window. */ externalFlows: number; /** Net local effect of `cash.conversion` events on this currency (received − given). */ conversionNet: number; /** BASE currency: `openingLocalValue × (quoteAtEnd − quoteAtStart)`. */ translationEffectBaseCurrency: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - closingLocalValue: number; default: not declared - conversionNet: number; default: not declared — Net local effect of `cash.conversion` events on this currency (received − given). - currency: string; default: not declared - externalFlows: number; default: not declared — Deposits − withdrawals in this currency over the window. - financing: number; default: not declared - income: number; default: not declared - openingLocalValue: number; default: not declared — Cash plus position market value in this currency at the opening / closing mark. - quoteAtEnd: number; default: not declared - quoteAtStart: number; default: not declared — Base per unit of this currency at the opening and closing marks (1 for the base currency). - realizedPnl: number; default: not declared - transactionCosts: number; default: not declared - translationEffectBaseCurrency: number; default: not declared — BASE currency: `openingLocalValue × (quoteAtEnd − quoteAtStart)`. - unrealizedPnl: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioPnlGroupRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioPnlGroupRow extends PortfolioPnlComponents { label: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - financing: number; default: not declared - foreignExchangePnl: number; default: not declared - income: number; default: not declared - label: string; default: not declared - realizedPnl: number; default: not declared - totalPnl: number; default: not declared - transactionCosts: number; default: not declared - unrealizedPnl: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioPnlGrouping Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioPnlGrouping { dimension: PortfolioGroupingDimension; /** Sorted by label — deterministic. */ rows: PortfolioPnlGroupRow[]; /** Components no row owns (account-level costs, financing, foreign exchange) — explicit, never dropped. */ unattributed: PortfolioPnlComponents; /** `components.totalPnl − Σ rows.totalPnl − unattributed.totalPnl`; 0 within 1e-9 for partitioning dimensions. */ reconciliationResidual: number; reconciles: boolean; /** Present exactly when `reconciles` is false. */ reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dimension: PortfolioGroupingDimension; default: not declared - reason?: string; default: not declared — Present exactly when `reconciles` is false. - reconciles: boolean; default: not declared - reconciliationResidual: number; default: not declared — `components.totalPnl − Σ rows.totalPnl − unattributed.totalPnl`; 0 within 1e-9 for partitioning dimensions. - rows: PortfolioPnlGroupRow[]; default: not declared — Sorted by label — deterministic. - unattributed: PortfolioPnlComponents; default: not declared — Components no row owns (account-level costs, financing, foreign exchange) — explicit, never dropped. - unattributed.financing: number; default: not declared - unattributed.foreignExchangePnl: number; default: not declared - unattributed.income: number; default: not declared - unattributed.realizedPnl: number; default: not declared - unattributed.totalPnl: number; default: not declared - unattributed.transactionCosts: number; default: not declared - unattributed.unrealizedPnl: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioPnlInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioPnlInput { ledger: PortfolioLedger; from: PortfolioValuationMark; to: PortfolioValuationMark; instrumentClassification?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: PortfolioValuationMark; default: not declared - from.currencyConversions?: CurrencyPairQuote[]; default: not declared — Quotes to the base currency for every non-base cash balance and position currency. - from.market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared — A Gate B market snapshot carrying `observations.spots[instrumentId]` for every held instrument. - from.market.asOf: number; default: not declared - from.market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - from.market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - from.market.conventions.calendar?: string; default: not declared - from.market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - from.market.conventions.compounding.periodsPerYear: number; default: not declared - from.market.conventions.compounding.type: 'periodic'; default: not declared - from.market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - from.market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - from.market.kind: 'totalfinance.market-snapshot'; default: not declared - from.market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - from.market.observations.chains?: Record; default: not declared - from.market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - from.market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - from.market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - from.market.observations.spots?: Record; default: not declared - from.market.observations.surfaces?: Record; default: not declared - from.market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - from.market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - from.market.provenance.asOf?: number; default: not declared - from.market.provenance.dataset?: string; default: not declared - from.market.provenance.provider?: string; default: not declared - from.market.provenance.receivedAt?: number; default: not declared - from.market.provenance.requestId?: string; default: not declared - from.market.provenance.sourceVersion?: string; default: not declared - from.market.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - from.market.schemaVersion: number; default: not declared - from.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`; the mark instant is 00:00 UTC of this date. - instrumentClassification?: Record; default: not declared - ledger: PortfolioLedger; default: not declared - ledger.apply: (events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]) => PortfolioLedger; default: not declared — Fold more events and return a NEW immutable ledger; this one is untouched. - ledger.apply(events): readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.baseCurrency: string; default: not declared - ledger.events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — The applied economic events, canonical and frozen. Identical no-op replays are not stored. - ledger.lotRelief: LotReliefPolicy; default: not declared - ledger.pnl: (input: Omit) => PortfolioPnlResult; default: not declared — `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). - ledger.pnl().return.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - ledger.pnl().return.assumptions.conventionsVersion: string; default: not declared - ledger.pnl().return.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - ledger.pnl().return.assumptions.identity: string; default: not declared — The identity, stated. - ledger.pnl().return.assumptions.lotRelief: LotReliefPolicy; default: not declared - ledger.pnl().return.assumptions.residualTolerance: number; default: not declared - ledger.pnl().return.baseCurrency: string; default: not declared - ledger.pnl().return.byCurrency: PortfolioPnlCurrencyRow[]; default: not declared - ledger.pnl().return.components: PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - ledger.pnl().return.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - ledger.pnl().return.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - ledger.pnl().return.diagnostics.residualWithinTolerance: boolean; default: not declared - ledger.pnl().return.diagnostics.warnings: string[]; default: not declared - ledger.pnl().return.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - ledger.pnl().return.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - ledger.pnl().return.from.asOf: number; default: not declared - ledger.pnl().return.from.netAssetValue: number; default: not declared - ledger.pnl().return.from.valuationDate: string; default: not declared - ledger.pnl().return.groupings: PortfolioPnlGrouping[]; default: not declared - ledger.pnl().return.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - ledger.pnl().return.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - ledger.pnl().return.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - ledger.pnl().return.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - ledger.pnl().return.to.asOf: number; default: not declared - ledger.pnl().return.to.netAssetValue: number; default: not declared - ledger.pnl().return.to.valuationDate: string; default: not declared - ledger.pnl(input): Omit; default: not declared - ledger.pnl(input).from: PortfolioValuationMark; default: not declared - ledger.pnl(input).instrumentClassification?: Record; default: not declared - ledger.pnl(input).to: PortfolioValuationMark; default: not declared - ledger.portfolioId?: string; default: not declared - ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - ledger.provenance.asOf?: number; default: not declared - ledger.provenance.dataset?: string; default: not declared - ledger.provenance.provider?: string; default: not declared - ledger.provenance.receivedAt?: number; default: not declared - ledger.provenance.requestId?: string; default: not declared - ledger.provenance.sourceVersion?: string; default: not declared - ledger.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - ledger.state: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared — The derived state — the fold of `events` under `lotRelief`. - ledger.state.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - ledger.state.accounts: Record; default: not declared - ledger.state.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - ledger.state.baseCurrency: string; default: not declared - ledger.state.eventCount: number; default: not declared - ledger.state.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - ledger.state.lastEffectiveTimestampMs: number | null; default: not declared - ledger.state.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - ledger.state.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - ledger.state.portfolioId?: string; default: not declared - ledger.state.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - ledger.state.schemaVersion: number; default: not declared - ledger.timeline: (input: Omit) => import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineResult; default: not declared — `portfolioTimeline` over this ledger (slice 2). - ledger.timeline().return.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - ledger.timeline().return.assumptions.conventionsVersion: string; default: not declared - ledger.timeline().return.assumptions.exposureConvention: string; default: not declared - ledger.timeline().return.assumptions.indexConvention: string; default: not declared - ledger.timeline().return.assumptions.lotRelief: LotReliefPolicy; default: not declared - ledger.timeline().return.assumptions.markInstant: string; default: not declared - ledger.timeline().return.baseCurrency: string; default: not declared - ledger.timeline().return.cumulativePnl: PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - ledger.timeline().return.cumulativePnl.financing: number; default: not declared - ledger.timeline().return.cumulativePnl.foreignExchangePnl: number; default: not declared - ledger.timeline().return.cumulativePnl.income: number; default: not declared - ledger.timeline().return.cumulativePnl.realizedPnl: number; default: not declared - ledger.timeline().return.cumulativePnl.residual: number; default: not declared - ledger.timeline().return.cumulativePnl.totalPnl: number; default: not declared - ledger.timeline().return.cumulativePnl.transactionCosts: number; default: not declared - ledger.timeline().return.cumulativePnl.unrealizedPnl: number; default: not declared - ledger.timeline().return.diagnostics: { gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - ledger.timeline().return.diagnostics.gaps: import('@insiderfinance/totalfinance/performance').PerformanceGap[]; default: not declared - ledger.timeline().return.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - ledger.timeline().return.diagnostics.markCount: number; default: not declared - ledger.timeline().return.diagnostics.warnings: string[]; default: not declared - ledger.timeline().return.externalCashFlows: import('@insiderfinance/totalfinance/performance').ExternalCashFlow[]; default: not declared - ledger.timeline().return.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - ledger.timeline().return.rows: import('@insiderfinance/totalfinance/portfolio').PortfolioTimelineRow[]; default: not declared - ledger.timeline().return.valuations: import('@insiderfinance/totalfinance/performance').PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - ledger.timeline(input): Omit; default: not declared - ledger.timeline(input).instrumentClassification?: Record; default: not declared - ledger.timeline(input).valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. - ledger.toJSON: () => import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared — The serialized envelope (also what `JSON.stringify(ledger)` emits). - ledger.toJSON().return.baseCurrency: string; default: not declared - ledger.toJSON().return.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.toJSON().return.kind: 'totalfinance.portfolio-ledger'; default: not declared - ledger.toJSON().return.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - ledger.toJSON().return.portfolioId?: string; default: not declared - ledger.toJSON().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - ledger.toJSON().return.schemaVersion: number; default: not declared - to: PortfolioValuationMark; default: not declared - to.currencyConversions?: CurrencyPairQuote[]; default: not declared — Quotes to the base currency for every non-base cash balance and position currency. - to.market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared — A Gate B market snapshot carrying `observations.spots[instrumentId]` for every held instrument. - to.market.asOf: number; default: not declared - to.market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - to.market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - to.market.conventions.calendar?: string; default: not declared - to.market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - to.market.conventions.compounding.periodsPerYear: number; default: not declared - to.market.conventions.compounding.type: 'periodic'; default: not declared - to.market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - to.market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - to.market.kind: 'totalfinance.market-snapshot'; default: not declared - to.market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - to.market.observations.chains?: Record; default: not declared - to.market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - to.market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - to.market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - to.market.observations.spots?: Record; default: not declared - to.market.observations.surfaces?: Record; default: not declared - to.market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - to.market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - to.market.provenance.asOf?: number; default: not declared - to.market.provenance.dataset?: string; default: not declared - to.market.provenance.provider?: string; default: not declared - to.market.provenance.receivedAt?: number; default: not declared - to.market.provenance.requestId?: string; default: not declared - to.market.provenance.sourceVersion?: string; default: not declared - to.market.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - to.market.schemaVersion: number; default: not declared - to.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`; the mark instant is 00:00 UTC of this date. ### @insiderfinance/totalfinance/portfolio#PortfolioPnlResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioPnlResult { baseCurrency: string; from: { valuationDate: string; asOf: EpochMs; netAssetValue: number; }; to: { valuationDate: string; asOf: EpochMs; netAssetValue: number; }; /** `to.netAssetValue − from.netAssetValue`. */ netAssetValueChange: number; /** Deposits − withdrawals over the window, in base currency at closing quotes. */ externalFlows: number; /** `netAssetValueChange − externalFlows` — the investment return the components explain. */ investmentReturn: number; /** The explained decomposition; `components.totalPnl + residual === investmentReturn`. */ components: PortfolioPnlComponents; /** `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. */ residual: number; byCurrency: PortfolioPnlCurrencyRow[]; groupings: PortfolioPnlGrouping[]; assumptions: { conventionsVersion: string; lotRelief: LotReliefPolicy; /** The identity, stated. */ identity: string; /** The conversion convention, stated. */ conversionConvention: string; residualTolerance: number; }; diagnostics: { warnings: string[]; /** Events with `from ≤ effectiveTimestampMs < to`. */ eventCount: number; residualWithinTolerance: boolean; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - assumptions.identity: string; default: not declared — The identity, stated. - assumptions.lotRelief: LotReliefPolicy; default: not declared - assumptions.residualTolerance: number; default: not declared - baseCurrency: string; default: not declared - byCurrency: PortfolioPnlCurrencyRow[]; default: not declared - components: PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - components.financing: number; default: not declared - components.foreignExchangePnl: number; default: not declared - components.income: number; default: not declared - components.realizedPnl: number; default: not declared - components.totalPnl: number; default: not declared - components.transactionCosts: number; default: not declared - components.unrealizedPnl: number; default: not declared - diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - diagnostics.residualWithinTolerance: boolean; default: not declared - diagnostics.warnings: string[]; default: not declared - externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - from.asOf: number; default: not declared - from.netAssetValue: number; default: not declared - from.valuationDate: string; default: not declared - groupings: PortfolioPnlGrouping[]; default: not declared - investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - to.asOf: number; default: not declared - to.netAssetValue: number; default: not declared - to.valuationDate: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioSnapshotCashRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One account × currency cash row at the valuation instant. ```typescript /** One account × currency cash row at the valuation instant. */ export interface PortfolioSnapshotCashRow { accountId: string; currency: string; /** The booked balance including unsettled legs. */ totalAmount: number; /** `totalAmount − unsettledReceivable + unsettledPayable` (the tested identity). */ settledAmount: number; /** Magnitude of incoming cash legs settling after `asOf` (receivable), ≥ 0. */ unsettledReceivable: number; /** Magnitude of outgoing cash legs settling after `asOf` (payable), ≥ 0. */ unsettledPayable: number; /** `totalAmount` in the portfolio's base currency at the supplied conversion quote. */ baseCurrencyValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - baseCurrencyValue: number; default: not declared — `totalAmount` in the portfolio's base currency at the supplied conversion quote. - currency: string; default: not declared - settledAmount: number; default: not declared — `totalAmount − unsettledReceivable + unsettledPayable` (the tested identity). - totalAmount: number; default: not declared — The booked balance including unsettled legs. - unsettledPayable: number; default: not declared — Magnitude of outgoing cash legs settling after `asOf` (payable), ≥ 0. - unsettledReceivable: number; default: not declared — Magnitude of incoming cash legs settling after `asOf` (receivable), ≥ 0. ### @insiderfinance/totalfinance/portfolio#PortfolioSnapshotInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link portfolioSnapshot}. ```typescript /** Input for {@link portfolioSnapshot}. */ export interface PortfolioSnapshotInput { /** A derived {@link PortfolioState} (from `applyPortfolioEvents` or `ledger.state`). */ portfolio: PortfolioState; /** The valuation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. */ asOf: EpochMs | string; /** The Gate B market snapshot supplying instrument marks. */ market: MarketSnapshot; /** * Explicit valuation-time exchange-rate quotes (FC5 vocabulary), one per currency pair, in * either orientation. Required exactly when the portfolio holds cash or positions outside its * base currency. */ currencyConversions?: CurrencyPairQuote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — The valuation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. - currencyConversions?: CurrencyPairQuote[]; default: not declared — Explicit valuation-time exchange-rate quotes (FC5 vocabulary), one per currency pair, in either orientation. Required exactly when the portfolio holds cash or positions outside its base currency. - market: MarketSnapshot; default: not declared — The Gate B market snapshot supplying instrument marks. - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - portfolio: PortfolioState; default: not declared — A derived {@link PortfolioState} (from `applyPortfolioEvents` or `ledger.state`). - portfolio.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - portfolio.accounts: Record; default: not declared - portfolio.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - portfolio.baseCurrency: string; default: not declared - portfolio.eventCount: number; default: not declared - portfolio.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - portfolio.lastEffectiveTimestampMs: number | null; default: not declared - portfolio.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - portfolio.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolio.portfolioId?: string; default: not declared - portfolio.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - portfolio.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioSnapshotPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One valued position at the valuation instant. ```typescript /** One valued position at the valuation instant. */ export interface PortfolioSnapshotPosition { accountId: string; instrumentId: string; /** The position's trading currency (marks must be quoted in it). */ currency: string; quantity: number; markPricePerUnit: number; /** Units of the underlying per unit of quantity (slice 5): shares 1, an option's 100, a futures size. */ contractMultiplier: number; settlementStyle: SettlementStyle; /** * The position's contribution to NAV, in `currency`: `quantity × mark × multiplier` for a * cash-on-trade position; for a variation-margin position the UNSETTLED P&L since the last * settlement, `Σ (mark − lot basis) × lot quantity × multiplier` (its notional is not owned). */ marketValue: number; baseCurrencyMarketValue: number; /** `quantity × mark × multiplier` — the economic exposure, in `currency` (equals marketValue for cash-on-trade). */ notionalValue: number; baseCurrencyNotionalValue: number; /** Remaining open-lot basis `Σ lot.quantity × lot.costBasisPerUnit × multiplier` (signed), in `currency`; 0 for variation-margin positions (their basis is the last settlement, not capital). */ costBasis: number; /** `marketValue − costBasis`, in `currency` — mark-to-market on the OPEN lots only. */ unrealizedPnl: number; baseCurrencyUnrealizedPnl: number; lotCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - baseCurrencyMarketValue: number; default: not declared - baseCurrencyNotionalValue: number; default: not declared - baseCurrencyUnrealizedPnl: number; default: not declared - contractMultiplier: number; default: not declared — Units of the underlying per unit of quantity (slice 5): shares 1, an option's 100, a futures size. - costBasis: number; default: not declared — Remaining open-lot basis `Σ lot.quantity × lot.costBasisPerUnit × multiplier` (signed), in `currency`; 0 for variation-margin positions (their basis is the last settlement, not capital). - currency: string; default: not declared — The position's trading currency (marks must be quoted in it). - instrumentId: string; default: not declared - lotCount: number; default: not declared - markPricePerUnit: number; default: not declared - marketValue: number; default: not declared — The position's contribution to NAV, in `currency`: `quantity × mark × multiplier` for a cash-on-trade position; for a variation-margin position the UNSETTLED P&L since the last settlement, `Σ (mark − lot basis) × lot quantity × multiplier` (its notional is not owned). - notionalValue: number; default: not declared — `quantity × mark × multiplier` — the economic exposure, in `currency` (equals marketValue for cash-on-trade). - quantity: number; default: not declared - settlementStyle: SettlementStyle; default: not declared - unrealizedPnl: number; default: not declared — `marketValue − costBasis`, in `currency` — mark-to-market on the OPEN lots only. ### @insiderfinance/totalfinance/portfolio#PortfolioSnapshotResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link portfolioSnapshot}. ```typescript /** Result of {@link portfolioSnapshot}. */ export interface PortfolioSnapshotResult { asOf: EpochMs; baseCurrency: string; /** `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). */ netAssetValue: number; /** Sorted by (accountId, currency) — deterministic. */ cash: PortfolioSnapshotCashRow[]; totalCashBaseCurrencyValue: number; /** Sorted by (accountId, instrumentId) — deterministic. */ positions: PortfolioSnapshotPosition[]; totalPositionsBaseCurrencyValue: number; assumptions: { conventionsVersion: string; /** The relief policy behind every realized figure in the underlying state — echoed. */ lotRelief: LotReliefPolicy; /** The market snapshot's own instant — a warning discloses any mismatch with `asOf`. */ marketAsOf: EpochMs; /** The exchange-rate quotes actually used, echoed verbatim. */ currencyConversionsUsed: CurrencyPairQuote[]; /** Prose statement of the valuation convention. String-typed by design. */ valuationConvention: string; }; diagnostics: { warnings: string[]; accountCount: number; positionCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - assumptions: { conventionsVersion: string; currencyConversionsUsed: CurrencyPairQuote[]; lotRelief: LotReliefPolicy; marketAsOf: EpochMs; valuationConvention: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - assumptions.lotRelief: LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - baseCurrency: string; default: not declared - cash: PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - diagnostics: { accountCount: number; positionCount: number; warnings: string[]; }; default: not declared - diagnostics.accountCount: number; default: not declared - diagnostics.positionCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - positions: PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - totalCashBaseCurrencyValue: number; default: not declared - totalPositionsBaseCurrencyValue: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The derived portfolio state: a JSON-safe, deeply frozen fold result. The economic policy that shaped it (`baseCurrency`, `lotRelief`) is echoed ON the state, and the applied-event registry makes replay idempotent and conflict-detecting. ```typescript /** * The derived portfolio state: a JSON-safe, deeply frozen fold result. The economic policy that * shaped it (`baseCurrency`, `lotRelief`) is echoed ON the state, and the applied-event registry * makes replay idempotent and conflict-detecting. */ export interface PortfolioState { schemaVersion: number; portfolioId?: string; baseCurrency: string; /** The lot-relief policy every realized figure in this state was computed under. */ lotRelief: LotReliefPolicy; accounts: Record; /** `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. */ appliedEvents: Record; eventCount: number; lastEffectiveTimestampMs: EpochMs | null; /** Fold-deterministic lot-id counter (`lot-`). */ lotSequence: number; /** Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). */ fillEffects: Record; /** Registry key of every reversed fact → registry key of the admin event that reversed it. */ reversals: Record; /** Account-migration markers in fold order. */ accountMigrations: AccountMigrationMarker[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountMigrations: AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - accounts: Record; default: not declared - appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - baseCurrency: string; default: not declared - eventCount: number; default: not declared - fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - lastEffectiveTimestampMs: number | null; default: not declared - lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolioId?: string; default: not declared - reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioTimelineInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioTimelineInput { ledger: PortfolioLedger; /** At least two marks, strictly ascending by date. */ valuationMarks: readonly PortfolioValuationMark[]; instrumentClassification?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentClassification?: Record; default: not declared - ledger: PortfolioLedger; default: not declared - ledger.apply: (events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]) => PortfolioLedger; default: not declared — Fold more events and return a NEW immutable ledger; this one is untouched. - ledger.apply(events): readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.baseCurrency: string; default: not declared - ledger.events: readonly import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — The applied economic events, canonical and frozen. Identical no-op replays are not stored. - ledger.lotRelief: LotReliefPolicy; default: not declared - ledger.pnl: (input: Omit) => import('@insiderfinance/totalfinance/portfolio').PortfolioPnlResult; default: not declared — `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). - ledger.pnl().return.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - ledger.pnl().return.assumptions.conventionsVersion: string; default: not declared - ledger.pnl().return.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - ledger.pnl().return.assumptions.identity: string; default: not declared — The identity, stated. - ledger.pnl().return.assumptions.lotRelief: LotReliefPolicy; default: not declared - ledger.pnl().return.assumptions.residualTolerance: number; default: not declared - ledger.pnl().return.baseCurrency: string; default: not declared - ledger.pnl().return.byCurrency: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlCurrencyRow[]; default: not declared - ledger.pnl().return.components: PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - ledger.pnl().return.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - ledger.pnl().return.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - ledger.pnl().return.diagnostics.residualWithinTolerance: boolean; default: not declared - ledger.pnl().return.diagnostics.warnings: string[]; default: not declared - ledger.pnl().return.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - ledger.pnl().return.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - ledger.pnl().return.from.asOf: number; default: not declared - ledger.pnl().return.from.netAssetValue: number; default: not declared - ledger.pnl().return.from.valuationDate: string; default: not declared - ledger.pnl().return.groupings: import('@insiderfinance/totalfinance/portfolio').PortfolioPnlGrouping[]; default: not declared - ledger.pnl().return.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - ledger.pnl().return.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - ledger.pnl().return.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - ledger.pnl().return.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - ledger.pnl().return.to.asOf: number; default: not declared - ledger.pnl().return.to.netAssetValue: number; default: not declared - ledger.pnl().return.to.valuationDate: string; default: not declared - ledger.pnl(input): Omit; default: not declared - ledger.pnl(input).from: PortfolioValuationMark; default: not declared - ledger.pnl(input).instrumentClassification?: Record; default: not declared - ledger.pnl(input).to: PortfolioValuationMark; default: not declared - ledger.portfolioId?: string; default: not declared - ledger.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - ledger.provenance.asOf?: number; default: not declared - ledger.provenance.dataset?: string; default: not declared - ledger.provenance.provider?: string; default: not declared - ledger.provenance.receivedAt?: number; default: not declared - ledger.provenance.requestId?: string; default: not declared - ledger.provenance.sourceVersion?: string; default: not declared - ledger.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - ledger.state: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared — The derived state — the fold of `events` under `lotRelief`. - ledger.state.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - ledger.state.accounts: Record; default: not declared - ledger.state.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - ledger.state.baseCurrency: string; default: not declared - ledger.state.eventCount: number; default: not declared - ledger.state.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - ledger.state.lastEffectiveTimestampMs: number | null; default: not declared - ledger.state.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - ledger.state.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - ledger.state.portfolioId?: string; default: not declared - ledger.state.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - ledger.state.schemaVersion: number; default: not declared - ledger.timeline: (input: Omit) => PortfolioTimelineResult; default: not declared — `portfolioTimeline` over this ledger (slice 2). - ledger.timeline().return.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - ledger.timeline().return.assumptions.conventionsVersion: string; default: not declared - ledger.timeline().return.assumptions.exposureConvention: string; default: not declared - ledger.timeline().return.assumptions.indexConvention: string; default: not declared - ledger.timeline().return.assumptions.lotRelief: LotReliefPolicy; default: not declared - ledger.timeline().return.assumptions.markInstant: string; default: not declared - ledger.timeline().return.baseCurrency: string; default: not declared - ledger.timeline().return.cumulativePnl: PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - ledger.timeline().return.cumulativePnl.financing: number; default: not declared - ledger.timeline().return.cumulativePnl.foreignExchangePnl: number; default: not declared - ledger.timeline().return.cumulativePnl.income: number; default: not declared - ledger.timeline().return.cumulativePnl.realizedPnl: number; default: not declared - ledger.timeline().return.cumulativePnl.residual: number; default: not declared - ledger.timeline().return.cumulativePnl.totalPnl: number; default: not declared - ledger.timeline().return.cumulativePnl.transactionCosts: number; default: not declared - ledger.timeline().return.cumulativePnl.unrealizedPnl: number; default: not declared - ledger.timeline().return.diagnostics: { gaps: PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - ledger.timeline().return.diagnostics.gaps: PerformanceGap[]; default: not declared - ledger.timeline().return.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - ledger.timeline().return.diagnostics.markCount: number; default: not declared - ledger.timeline().return.diagnostics.warnings: string[]; default: not declared - ledger.timeline().return.externalCashFlows: ExternalCashFlow[]; default: not declared - ledger.timeline().return.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - ledger.timeline().return.rows: PortfolioTimelineRow[]; default: not declared - ledger.timeline().return.valuations: PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. - ledger.timeline(input): Omit; default: not declared - ledger.timeline(input).instrumentClassification?: Record; default: not declared - ledger.timeline(input).valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. - ledger.toJSON: () => import('@insiderfinance/totalfinance/portfolio').PortfolioLedgerSnapshot; default: not declared — The serialized envelope (also what `JSON.stringify(ledger)` emits). - ledger.toJSON().return.baseCurrency: string; default: not declared - ledger.toJSON().return.events: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - ledger.toJSON().return.kind: 'totalfinance.portfolio-ledger'; default: not declared - ledger.toJSON().return.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - ledger.toJSON().return.portfolioId?: string; default: not declared - ledger.toJSON().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - ledger.toJSON().return.schemaVersion: number; default: not declared - valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. ### @insiderfinance/totalfinance/portfolio#PortfolioTimelineResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioTimelineResult { baseCurrency: string; rows: PortfolioTimelineRow[]; /** The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. */ valuations: PortfolioValuation[]; externalCashFlows: ExternalCashFlow[]; /** * `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s * investment return exactly; individual components equal it only when every currency is the * base — otherwise each step's closing-quote translation moves value between a component and * `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). */ cumulativePnl: PortfolioPnlComponents & { residual: number; }; /** Worst drawdown from the index, `null` when the index is withheld. */ maxDrawdown: number | null; assumptions: { conventionsVersion: string; lotRelief: LotReliefPolicy; markInstant: string; indexConvention: string; exposureConvention: string; }; diagnostics: { warnings: string[]; markCount: number; /** Why the index (and drawdown) is null, when it is. */ indexWithheldReason?: string; gaps: PerformanceGap[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.exposureConvention: string; default: not declared - assumptions.indexConvention: string; default: not declared - assumptions.lotRelief: LotReliefPolicy; default: not declared - assumptions.markInstant: string; default: not declared - baseCurrency: string; default: not declared - cumulativePnl: PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - cumulativePnl.financing: number; default: not declared - cumulativePnl.foreignExchangePnl: number; default: not declared - cumulativePnl.income: number; default: not declared - cumulativePnl.realizedPnl: number; default: not declared - cumulativePnl.residual: number; default: not declared - cumulativePnl.totalPnl: number; default: not declared - cumulativePnl.transactionCosts: number; default: not declared - cumulativePnl.unrealizedPnl: number; default: not declared - diagnostics: { gaps: PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - diagnostics.gaps: PerformanceGap[]; default: not declared - diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - diagnostics.markCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - externalCashFlows: ExternalCashFlow[]; default: not declared - maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - rows: PortfolioTimelineRow[]; default: not declared - valuations: PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. ### @insiderfinance/totalfinance/portfolio#PortfolioTimelineRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioTimelineRow { valuationDate: string; asOf: EpochMs; netAssetValue: number; cashBaseCurrencyValue: number; positionsBaseCurrencyValue: number; exposure: PortfolioExposure; exposureByGroup: PortfolioExposureGrouping[]; /** Deposits − withdrawals since the prior mark, in base at this mark's quotes; 0 on the first row. */ externalFlowsSincePrior: number; /** The `portfolioPnl` kernel over [prior mark, this mark); `null` on the first row. */ pnlSincePrior: (PortfolioPnlComponents & { residual: number; }) | null; /** FC4's total-return index at this mark (`null` when the index is withheld — see diagnostics). */ indexValue: number | null; /** Drawdown from the running index peak as a positive fraction (`null` with the index). */ drawdown: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - cashBaseCurrencyValue: number; default: not declared - drawdown: number | null; default: not declared — Drawdown from the running index peak as a positive fraction (`null` with the index). - exposure: PortfolioExposure; default: not declared - exposure.gross: number; default: not declared — `long + short`. - exposure.grossLeverage: number | null; default: not declared — `gross / netAssetValue`, `null` when NAV is 0. - exposure.long: number; default: not declared — Σ positive position base values. - exposure.net: number; default: not declared — `long − short`. - exposure.short: number; default: not declared — Σ |negative position base values| (a positive magnitude). - exposureByGroup: PortfolioExposureGrouping[]; default: not declared - externalFlowsSincePrior: number; default: not declared — Deposits − withdrawals since the prior mark, in base at this mark's quotes; 0 on the first row. - indexValue: number | null; default: not declared — FC4's total-return index at this mark (`null` when the index is withheld — see diagnostics). - netAssetValue: number; default: not declared - pnlSincePrior: (PortfolioPnlComponents & { residual: number; }) | null; default: not declared — The `portfolioPnl` kernel over [prior mark, this mark); `null` on the first row. - positionsBaseCurrencyValue: number; default: not declared - valuationDate: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PortfolioValuationMark Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One dated valuation: the market snapshot (and base-currency quotes) to value the ledger at. ```typescript /** One dated valuation: the market snapshot (and base-currency quotes) to value the ledger at. */ export interface PortfolioValuationMark { /** Strict `YYYY-MM-DD`; the mark instant is 00:00 UTC of this date. */ valuationDate: string; /** A Gate B market snapshot carrying `observations.spots[instrumentId]` for every held instrument. */ market: MarketSnapshot; /** Quotes to the base currency for every non-base cash balance and position currency. */ currencyConversions?: CurrencyPairQuote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currencyConversions?: CurrencyPairQuote[]; default: not declared — Quotes to the base currency for every non-base cash balance and position currency. - market: MarketSnapshot; default: not declared — A Gate B market snapshot carrying `observations.spots[instrumentId]` for every held instrument. - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - valuationDate: string; default: not declared — Strict `YYYY-MM-DD`; the mark instant is 00:00 UTC of this date. ### @insiderfinance/totalfinance/portfolio#PositionDifference Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PositionDifference { instrumentId: string; kind: PositionDifferenceKind; ledgerQuantity: number; externalQuantity: number; /** `externalQuantity − ledgerQuantity`. */ quantityDifference: number; withinTolerance: boolean; currency: string | null; /** Present when the external source states a currency that differs from the ledger's. */ currencyMismatch?: { ledger: string; external: string; }; /** Present when the external source supplies a cost basis. */ costBasis?: { ledger: number; external: number; difference: number; withinTolerance: boolean; }; explanation?: ReconciliationExplanation; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - costBasis?: { ledger: number; external: number; difference: number; withinTolerance: boolean; }; default: not declared — Present when the external source supplies a cost basis. - costBasis.difference: number; default: not declared - costBasis.external: number; default: not declared - costBasis.ledger: number; default: not declared - costBasis.withinTolerance: boolean; default: not declared - currency: string | null; default: not declared - currencyMismatch?: { ledger: string; external: string; }; default: not declared — Present when the external source states a currency that differs from the ledger's. - currencyMismatch.external: string; default: not declared - currencyMismatch.ledger: string; default: not declared - explanation?: ReconciliationExplanation; default: not declared - explanation.detail: string; default: not declared - explanation.kind: ('corporate-action-candidate') | ('pending-settlement'); default: not declared - explanation.ratio: number; default: not declared - externalQuantity: number; default: not declared - instrumentId: string; default: not declared - kind: PositionDifferenceKind; default: not declared - ledgerQuantity: number; default: not declared - quantityDifference: number; default: not declared — `externalQuantity − ledgerQuantity`. - withinTolerance: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio#PositionDifferenceKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PositionDifferenceKind = 'matched' | 'quantity-difference' | 'missing-in-external' | 'extra-in-external'; ``` ### @insiderfinance/totalfinance/portfolio#PositionState Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One instrument's open position in one account. ```typescript /** One instrument's open position in one account. */ export interface PositionState { instrumentId: string; /** The ONE trading currency of this position's fills (mixed currencies refuse). */ currency: string; /** Units of the underlying per unit of `quantity` (slice 5): 1 for shares, an option's 100, a futures contract size. */ contractMultiplier: number; /** `'cash-on-trade'` (equities, options, spot) or `'variation-margin'` (futures, perpetuals). */ settlementStyle: SettlementStyle; /** The derivative's terms, carried from the opening fill. */ contract?: DerivativeContractTerms; /** Signed net quantity — always the sum of `lots[].quantity`. */ quantity: number; lots: TaxLot[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract?: DerivativeContractTerms; default: not declared — The derivative's terms, carried from the opening fill. - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier: number; default: not declared — Units of the underlying per unit of `quantity` (slice 5): 1 for shares, an option's 100, a futures contract size. - currency: string; default: not declared — The ONE trading currency of this position's fills (mixed currencies refuse). - instrumentId: string; default: not declared - lots: TaxLot[]; default: not declared - quantity: number; default: not declared — Signed net quantity — always the sum of `lots[].quantity`. - settlementStyle: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot) or `'variation-margin'` (futures, perpetuals). ### @insiderfinance/totalfinance/portfolio#PositionTransferEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Lots move between two accounts of the portfolio; basis and opening dates are preserved. ```typescript /** Lots move between two accounts of the portfolio; basis and opening dates are preserved. */ export interface PositionTransferEvent { eventType: 'position.transfer'; instrumentId: string; /** Unsigned quantity moved, > 0. */ quantity: number; fromAccountId: string; toAccountId: string; lotSelections?: TradeFillLotSelection[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'position.transfer'; default: not declared - fromAccountId: string; default: not declared - instrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared - quantity: number; default: not declared — Unsigned quantity moved, > 0. - toAccountId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#PreflightReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PreflightReport { kind: typeof PREFLIGHT_REPORT_KIND; schemaVersion: number; asOf: EpochMs; planHash: string; portfolioHash: string; marketHash: string; marketAsOf: EpochMs; before: PortfolioSnapshotResult; after: PortfolioSnapshotResult; /** The hypothetical fills the after-state was folded from. */ hypotheticalFills: NormalizedFill[]; hypotheticalEvents: PortfolioEventEnvelope[]; estimates: PreflightEstimates; checks: PolicyCheck[]; alerts: MonitorAlert[]; decision: PolicyDecision; unverifiable: string[]; monitorState: PortfolioMonitorState | null; assumptions: { conventionsVersion: string; policyContentHash: string; mode: 'paper'; costRates: Required; fillConvention: string; /** Where each instrument's currency and multiplier came from: the ledger position, the caller's description, or the market spot (priced as a plain cash instrument). */ instrumentSources: Record; decisionConvention: string; }; diagnostics: { engine: 'trade-preflight'; method: 'hypothetical-fold'; converged: true; warnings: QuantWarning[]; checkCount: number; failedCount: number; unverifiableCount: number; }; contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - after: PortfolioSnapshotResult; default: not declared - after.asOf: number; default: not declared - after.assumptions: { conventionsVersion: string; currencyConversionsUsed: CurrencyPairQuote[]; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; marketAsOf: EpochMs; valuationConvention: string; }; default: not declared - after.assumptions.conventionsVersion: string; default: not declared - after.assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - after.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - after.assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - after.assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - after.baseCurrency: string; default: not declared - after.cash: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - after.diagnostics: { accountCount: number; positionCount: number; warnings: string[]; }; default: not declared - after.diagnostics.accountCount: number; default: not declared - after.diagnostics.positionCount: number; default: not declared - after.diagnostics.warnings: string[]; default: not declared - after.netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - after.positions: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - after.totalCashBaseCurrencyValue: number; default: not declared - after.totalPositionsBaseCurrencyValue: number; default: not declared - alerts: MonitorAlert[]; default: not declared - asOf: number; default: not declared - assumptions: { conventionsVersion: string; costRates: Required; decisionConvention: string; fillConvention: string; instrumentSources: Record; mode: 'paper'; policyContentHash: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.costRates: Required; default: not declared - assumptions.costRates.commissionBps: number; default: not declared - assumptions.costRates.commissionPerOrder: number; default: not declared - assumptions.costRates.slippageBps: number; default: not declared - assumptions.costRates.spreadBps: number; default: not declared - assumptions.decisionConvention: string; default: not declared - assumptions.fillConvention: string; default: not declared - assumptions.instrumentSources: Record; default: not declared — Where each instrument's currency and multiplier came from: the ledger position, the caller's description, or the market spot (priced as a plain cash instrument). - assumptions.mode: 'paper'; default: not declared - assumptions.policyContentHash: string; default: not declared - before: PortfolioSnapshotResult; default: not declared - before.asOf: number; default: not declared - before.assumptions: { conventionsVersion: string; currencyConversionsUsed: CurrencyPairQuote[]; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; marketAsOf: EpochMs; valuationConvention: string; }; default: not declared - before.assumptions.conventionsVersion: string; default: not declared - before.assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - before.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - before.assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - before.assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - before.baseCurrency: string; default: not declared - before.cash: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - before.diagnostics: { accountCount: number; positionCount: number; warnings: string[]; }; default: not declared - before.diagnostics.accountCount: number; default: not declared - before.diagnostics.positionCount: number; default: not declared - before.diagnostics.warnings: string[]; default: not declared - before.netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - before.positions: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - before.totalCashBaseCurrencyValue: number; default: not declared - before.totalPositionsBaseCurrencyValue: number; default: not declared - checks: PolicyCheck[]; default: not declared - contentHash: string; default: not declared - decision: PolicyDecision; default: not declared - decision.checks: PolicyCheck[]; default: not declared - decision.requiredScope: string; default: not declared - decision.verdict: ('allow') | ('deny') | ('require-approval'); default: not declared - diagnostics: { checkCount: number; converged: true; engine: 'trade-preflight'; failedCount: number; method: 'hypothetical-fold'; unverifiableCount: number; warnings: QuantWarning[]; }; default: not declared - diagnostics.checkCount: number; default: not declared - diagnostics.converged: true; default: not declared - diagnostics.engine: 'trade-preflight'; default: not declared - diagnostics.failedCount: number; default: not declared - diagnostics.method: 'hypothetical-fold'; default: not declared - diagnostics.unverifiableCount: number; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - estimates: PreflightEstimates; default: not declared - estimates.commission: number; default: not declared - estimates.slippage: number; default: not declared - estimates.spread: number; default: not declared - estimates.totalCost: number; default: not declared - estimates.tradedNotional: number; default: not declared - estimates.turnover: number; default: not declared - hypotheticalEvents: PortfolioEventEnvelope[]; default: not declared - hypotheticalFills: NormalizedFill[]; default: not declared — The hypothetical fills the after-state was folded from. - kind: 'totalfinance.preflight-report'; default: not declared - marketAsOf: number; default: not declared - marketHash: string; default: not declared - monitorState: PortfolioMonitorState | null; default: not declared - monitorState.asOf: number; default: not declared - monitorState.evaluationCount: number; default: not declared - monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - monitorState.rules: Record; default: not declared - monitorState.schemaVersion: number; default: not declared - planHash: string; default: not declared - portfolioHash: string; default: not declared - schemaVersion: number; default: not declared - unverifiable: string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#PremiumTreatment Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What happens to the option premium on physical exercise/assignment: folded into the delivered underlying's basis or proceeds (the common tax-lot convention), or realized on the option lots. REQUIRED — a convention is a goal, not a default. ```typescript /** * What happens to the option premium on physical exercise/assignment: folded into the delivered * underlying's basis or proceeds (the common tax-lot convention), or realized on the option lots. * REQUIRED — a convention is a goal, not a default. */ export type PremiumTreatment = 'fold-into-underlying-basis' | 'realize'; ``` ### @insiderfinance/totalfinance/portfolio#ProposePortfolioRebalanceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ProposePortfolioRebalanceInput extends AllocationSizingInput { portfolio: PortfolioState; /** Marks come from `observations.spots` through `portfolioSnapshot`. */ market: MarketSnapshot; asOf: EpochMs | string; currencyConversions?: CurrencyPairQuote[]; policy: InvestmentPolicy; instrumentClassification?: Record; scope: RebalanceScope; externalFlow?: ExternalFlow; /** Where BUYS book. REQUIRED when more than one allowed account; with exactly one it is that account. */ tradingAccountId?: string; /** Units per day; with `limits.maximumDaysToLiquidate`, days = |post-trade quantity| ÷ (volume × 0.1). */ averageDailyVolumes?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - averageDailyVolumes?: Record; default: not declared — Units per day; with `limits.maximumDaysToLiquidate`, days = |post-trade quantity| ÷ (volume × 0.1). - currencyConversions?: CurrencyPairQuote[]; default: not declared - defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - externalFlow?: ExternalFlow; default: not declared - externalFlow.amount: number; default: not declared - externalFlow.currency: string; default: not declared — Base currency only in this build (a foreign-currency flow is a typed refusal). - instrumentClassification?: Record; default: not declared - lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - market: MarketSnapshot; default: not declared — Marks come from `observations.spots` through `portfolioSnapshot`. - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - policy: InvestmentPolicy; default: not declared - policy.allowedAccounts?: string[]; default: not declared - policy.allowedInstruments?: string[]; default: not declared - policy.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.benchmark.benchmarkId: string; default: not declared - policy.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.contributionHandling?: import('@insiderfinance/totalfinance/portfolio').ContributionHandling; default: not declared - policy.driftBand?: number; default: not declared — Default absolute drift band (decimal of NAV) — a target outside its band triggers trades/alerts. - policy.incomeReinvestment?: import('@insiderfinance/totalfinance/portfolio').IncomeReinvestment; default: not declared - policy.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - policy.lotSelectionObjective?: string; default: not declared — Identity of an external tax-aware lot-selection objective. This build reports lots under the ledger's own relief policy and echoes this identity; it never applies an objective it does not implement. - policy.maximumEstimatedTransactionCost?: number; default: not declared — Maximum estimated transaction cost per proposal, in base currency. - policy.maximumTurnover?: number; default: not declared — Maximum turnover per proposal: `Σ|trade notional| ÷ NAV` (buys and sells both counted). - policy.minimumCash?: number; default: not declared — Cash reserve in base currency that a proposal may never spend below. - policy.minimumCashWeight?: number; default: not declared — Cash reserve as a decimal of NAV (alternative spelling; both may be set — the larger binds). - policy.model?: import('@insiderfinance/totalfinance/portfolio').ModelPortfolio; default: not declared - policy.model.baseCurrency: string; default: not declared - policy.model.benchmark?: import('@insiderfinance/totalfinance/portfolio').BenchmarkIdentity; default: not declared - policy.model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - policy.model.benchmark.benchmarkId: string; default: not declared - policy.model.benchmark.constituents?: import('@insiderfinance/totalfinance/portfolio').BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - policy.model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - policy.model.glidePath?: import('@insiderfinance/totalfinance/portfolio').GlidePath; default: not declared - policy.model.glidePath.interpolation: 'linear' | 'step'; default: not declared - policy.model.glidePath.points: import('@insiderfinance/totalfinance/portfolio').GlidePathPoint[]; default: not declared - policy.model.horizonEndDate?: string | number; default: not declared - policy.model.kind: 'totalfinance.model-portfolio'; default: not declared - policy.model.liabilities?: import('@insiderfinance/totalfinance/portfolio').LiabilitySchedule; default: not declared - policy.model.liabilities.entries: import('@insiderfinance/totalfinance/portfolio').LiabilityEntry[]; default: not declared - policy.model.liabilities.note?: string; default: not declared - policy.model.modelId: string; default: not declared - policy.model.note?: string; default: not declared - policy.model.schemaVersion: number; default: not declared - policy.model.sleeves?: ModelSleeve[]; default: not declared - policy.model.strategic: import('@insiderfinance/totalfinance/portfolio').TargetSet; default: not declared - policy.model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - policy.model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - policy.model.strategic.note?: string; default: not declared - policy.model.strategic.targets: AllocationTarget[]; default: not declared - policy.model.tactical?: import('@insiderfinance/totalfinance/portfolio').TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - policy.model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - policy.performanceObjective?: string; default: not declared — Prose statement of the performance objective. String-typed by design. - policy.restrictedInstruments?: string[]; default: not declared - policy.reviewCadenceDays?: number; default: not declared - policy.targets?: AllocationTarget[]; default: not declared - policy.withdrawalHandling?: import('@insiderfinance/totalfinance/portfolio').WithdrawalHandling; default: not declared - policy.withinGroupAllocation?: import('@insiderfinance/totalfinance/portfolio').WithinGroupAllocation; default: not declared — How a GROUP target (assetClass/currency/tag/underlying/strategy) is split across its member instruments. REQUIRED whenever such a target resolves to more than one instrument. - portfolio: PortfolioState; default: not declared - portfolio.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - portfolio.accounts: Record; default: not declared - portfolio.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - portfolio.baseCurrency: string; default: not declared - portfolio.eventCount: number; default: not declared - portfolio.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - portfolio.lastEffectiveTimestampMs: number | null; default: not declared - portfolio.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - portfolio.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolio.portfolioId?: string; default: not declared - portfolio.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - portfolio.schemaVersion: number; default: not declared - scope: RebalanceScope; default: not declared - tradingAccountId?: string; default: not declared — Where BUYS book. REQUIRED when more than one allowed account; with exactly one it is that account. - transactionCosts?: import('@insiderfinance/totalfinance/portfolio').AllocationTransactionCosts; default: not declared - transactionCosts.commissionPerTrade?: number; default: not declared — Base-currency commission per non-zero trade. - transactionCosts.commissionPerUnit?: number; default: not declared — Base-currency commission per unit traded (× |quantity|). - transactionCosts.slippageBasisPoints?: number; default: not declared — Market-impact/slippage cost in basis points of |notional|. - transactionCosts.spreadBasisPoints?: number; default: not declared — Half-spread cost in basis points of |notional|. ### @insiderfinance/totalfinance/portfolio#ProposePortfolioRebalanceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ProposePortfolioRebalanceResult { asOf: EpochMs; baseCurrency: string; /** The managed (allowed-account) NAV before the flow. */ netAssetValue: number; netAssetValueAfterFlow: number; weights: { instruments: RebalanceInstrumentWeight[]; groups: RebalanceGroupWeight[]; cash: RebalanceCashWeight; }; cash: RebalanceCashSummary; /** Sorted by (instrumentId, accountId). */ trades: RebalanceTrade[]; estimates: RebalanceEstimates; objective: { before: RebalanceObjectivePoint; after: RebalanceObjectivePoint; convention: string; }; risk: { before: RebalanceRiskPoint; after: RebalanceRiskPoint; }; unresolvedTargets: UnresolvedTarget[]; unresolvedConstraints: UnresolvedConstraint[]; convergence: { converged: boolean; iterations: number; }; dust: RebalanceDustSummary; feasible: boolean; plan: TradePlanArtifact; assumptions: { conventionsVersion: string; lotRelief: LotReliefPolicy; targetSource: ResolvedTargetSource; scope: RebalanceScope; flowHandling: string; rounding: string; costModel: string; liquidityParticipationRate: number; conventions: string; }; diagnostics: { warnings: string[]; accountsConsidered: string[]; accountsExcluded: string[]; tradeCount: number; dustCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - assumptions: { conventions: string; conventionsVersion: string; costModel: string; flowHandling: string; liquidityParticipationRate: number; lotRelief: LotReliefPolicy; rounding: string; scope: RebalanceScope; targetSource: ResolvedTargetSource; }; default: not declared - assumptions.conventions: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.costModel: string; default: not declared - assumptions.flowHandling: string; default: not declared - assumptions.liquidityParticipationRate: number; default: not declared - assumptions.lotRelief: LotReliefPolicy; default: not declared - assumptions.rounding: string; default: not declared - assumptions.scope: RebalanceScope; default: not declared - assumptions.targetSource: ResolvedTargetSource; default: not declared - baseCurrency: string; default: not declared - cash: RebalanceCashSummary; default: not declared - cash.available: number; default: not declared — Settled cash of the allowed accounts (base currency) plus the external flow. - cash.minimumReserve: number; default: not declared — The binding cash floor: the larger of `minimumCash` and `minimumCashWeight × post-flow NAV` (0 when neither is declared). - cash.raised: number; default: not declared — Σ proposed sell notionals (base). - cash.remainingReserve: number; default: not declared — Post-trade settled cash: `available + raised − used`. - cash.used: number; default: not declared — Σ proposed buy notionals (base). - convergence: { converged: boolean; iterations: number; }; default: not declared - convergence.converged: boolean; default: not declared - convergence.iterations: number; default: not declared - diagnostics: { accountsConsidered: string[]; accountsExcluded: string[]; dustCount: number; tradeCount: number; warnings: string[]; }; default: not declared - diagnostics.accountsConsidered: string[]; default: not declared - diagnostics.accountsExcluded: string[]; default: not declared - diagnostics.dustCount: number; default: not declared - diagnostics.tradeCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - dust: RebalanceDustSummary; default: not declared - dust.aggregateNotional: number; default: not declared — Σ signed skipped notionals (the net cash effect of skipping). - dust.skipped: AllocationDustRow[]; default: not declared - estimates: RebalanceEstimates; default: not declared - estimates.commission: number; default: not declared - estimates.slippage: number; default: not declared - estimates.spread: number; default: not declared - estimates.totalCost: number; default: not declared - estimates.turnover: number; default: not declared — `Σ |trade notional| ÷ post-flow NAV`. - feasible: boolean; default: not declared - netAssetValue: number; default: not declared — The managed (allowed-account) NAV before the flow. - netAssetValueAfterFlow: number; default: not declared - objective: { after: RebalanceObjectivePoint; before: RebalanceObjectivePoint; convention: string; }; default: not declared - objective.after: RebalanceObjectivePoint; default: not declared - objective.after.driftDistance: number; default: not declared — `Σ |weight − target| ÷ 2` over instrument targets and cash. - objective.after.trackingDistance: number | null; default: not declared — Active share vs `policy.benchmark.constituents`; `null` (with a diagnostics warning) when none are given. - objective.before: RebalanceObjectivePoint; default: not declared - objective.before.driftDistance: number; default: not declared — `Σ |weight − target| ÷ 2` over instrument targets and cash. - objective.before.trackingDistance: number | null; default: not declared — Active share vs `policy.benchmark.constituents`; `null` (with a diagnostics warning) when none are given. - objective.convention: string; default: not declared - plan: TradePlanArtifact; default: not declared - plan.asOf: number; default: not declared - plan.baseCurrency: string; default: not declared - plan.contentHash: string; default: not declared — `sha256:` over every field above. - plan.kind: 'totalfinance.trade-plan'; default: not declared - plan.policyContentHash: string; default: not declared — `contentHash` over the validated policy the plan was built from. - plan.portfolioId?: string; default: not declared - plan.schemaVersion: number; default: not declared - plan.trades: TradePlanTrade[]; default: not declared — Sorted by (accountId, instrumentId, side). - risk: { after: RebalanceRiskPoint; before: RebalanceRiskPoint; }; default: not declared - risk.after: RebalanceRiskPoint; default: not declared - risk.after.cashWeight: number; default: not declared - risk.after.grossLeverage: number; default: not declared — `Σ |weight|` over instruments. - risk.after.herfindahlIndex: number; default: not declared — `Σ weight²` over instruments (cash excluded). - risk.after.maximumPositionWeight: number; default: not declared - risk.after.topThreeWeight: number; default: not declared - risk.before: RebalanceRiskPoint; default: not declared - risk.before.cashWeight: number; default: not declared - risk.before.grossLeverage: number; default: not declared — `Σ |weight|` over instruments. - risk.before.herfindahlIndex: number; default: not declared — `Σ weight²` over instruments (cash excluded). - risk.before.maximumPositionWeight: number; default: not declared - risk.before.topThreeWeight: number; default: not declared - trades: RebalanceTrade[]; default: not declared — Sorted by (instrumentId, accountId). - unresolvedConstraints: UnresolvedConstraint[]; default: not declared - unresolvedTargets: UnresolvedTarget[]; default: not declared - weights: { cash: RebalanceCashWeight; groups: RebalanceGroupWeight[]; instruments: RebalanceInstrumentWeight[]; }; default: not declared - weights.cash: RebalanceCashWeight; default: not declared - weights.cash.current: number; default: not declared - weights.cash.postTrade: number; default: not declared - weights.cash.target: number | null; default: not declared - weights.groups: RebalanceGroupWeight[]; default: not declared - weights.instruments: RebalanceInstrumentWeight[]; default: not declared ### @insiderfinance/totalfinance/portfolio#ReadPortfolioLedgerSnapshotInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link readPortfolioLedgerSnapshot}. ```typescript /** Input for {@link readPortfolioLedgerSnapshot}. */ export interface ReadPortfolioLedgerSnapshotInput { snapshot: unknown; /** Explicitly registered migrations for OLDER stored versions — never module-global state. */ migrations?: ArtifactMigrationRegistry; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - migrations?: ArtifactMigrationRegistry; default: not declared — Explicitly registered migrations for OLDER stored versions — never module-global state. - migrations.find: (kind: string, fromVersion: number) => import('@insiderfinance/totalfinance/core/artifacts').ArtifactMigration | undefined; default: not declared — The registered step out of `(kind, fromVersion)`, if any. - migrations.find().return.description: string; default: not declared — Why the schema changed — reported to the caller with every application. - migrations.find().return.fromVersion: number; default: not declared — The stored version this step reads. - migrations.find().return.kind: string; default: not declared — The envelope `kind` this step migrates, e.g. `'totalfinance.market-snapshot'`. - migrations.find().return.migrate: (envelope: Record) => Record; default: not declared — Pure shape-to-shape upgrade. Receives the whole envelope at `fromVersion`; returns the whole envelope at `toVersion` (including the bumped `schemaVersion` field). Must not fetch, read the clock, or mutate its input. - migrations.find().return.toVersion: number; default: not declared — Always `fromVersion + 1` — chains are single steps, applied in order, each one reviewable. - migrations.find(fromVersion): number; default: not declared - migrations.find(kind): string; default: not declared - migrations.register: (migration: import('@insiderfinance/totalfinance/core/artifacts').ArtifactMigration) => void; default: not declared — Register one step. A second registration for the same `(kind, fromVersion)` is refused. - migrations.register(migration): import('@insiderfinance/totalfinance/core/artifacts').ArtifactMigration; default: not declared - migrations.register(migration).description: string; default: not declared — Why the schema changed — reported to the caller with every application. - migrations.register(migration).fromVersion: number; default: not declared — The stored version this step reads. - migrations.register(migration).kind: string; default: not declared — The envelope `kind` this step migrates, e.g. `'totalfinance.market-snapshot'`. - migrations.register(migration).migrate: (envelope: Record) => Record; default: not declared — Pure shape-to-shape upgrade. Receives the whole envelope at `fromVersion`; returns the whole envelope at `toVersion` (including the bumped `schemaVersion` field). Must not fetch, read the clock, or mutate its input. - migrations.register(migration).toVersion: number; default: not declared — Always `fromVersion + 1` — chains are single steps, applied in order, each one reviewable. - migrations.upgrade: (input: { envelope: Record; targetVersion: number; }) => { envelope: Record; migrationsApplied: AppliedMigration[]; }; default: not declared — Apply registered steps until `targetVersion`, reporting each. Refuses (rather than skips) the first missing link — a partial upgrade is a corrupt envelope with a plausible version number. - migrations.upgrade().return.envelope: Record; default: not declared - migrations.upgrade().return.migrationsApplied: AppliedMigration[]; default: not declared - migrations.upgrade(input): { envelope: Record; targetVersion: number; }; default: not declared - migrations.upgrade(input).envelope: Record; default: not declared - migrations.upgrade(input).targetVersion: number; default: not declared - snapshot: unknown; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceCashSummary Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceCashSummary { /** Settled cash of the allowed accounts (base currency) plus the external flow. */ available: number; /** Σ proposed sell notionals (base). */ raised: number; /** Σ proposed buy notionals (base). */ used: number; /** Post-trade settled cash: `available + raised − used`. */ remainingReserve: number; /** The binding cash floor: the larger of `minimumCash` and `minimumCashWeight × post-flow NAV` (0 when neither is declared). */ minimumReserve: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - available: number; default: not declared — Settled cash of the allowed accounts (base currency) plus the external flow. - minimumReserve: number; default: not declared — The binding cash floor: the larger of `minimumCash` and `minimumCashWeight × post-flow NAV` (0 when neither is declared). - raised: number; default: not declared — Σ proposed sell notionals (base). - remainingReserve: number; default: not declared — Post-trade settled cash: `available + raised − used`. - used: number; default: not declared — Σ proposed buy notionals (base). ### @insiderfinance/totalfinance/portfolio#RebalanceCashWeight Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceCashWeight { current: number; target: number | null; postTrade: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: number; default: not declared - postTrade: number; default: not declared - target: number | null; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceDustSummary Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceDustSummary { skipped: AllocationDustRow[]; /** Σ signed skipped notionals (the net cash effect of skipping). */ aggregateNotional: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregateNotional: number; default: not declared — Σ signed skipped notionals (the net cash effect of skipping). - skipped: AllocationDustRow[]; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceEstimates Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceEstimates { commission: number; spread: number; slippage: number; totalCost: number; /** `Σ |trade notional| ÷ post-flow NAV`. */ turnover: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: number; default: not declared - slippage: number; default: not declared - spread: number; default: not declared - totalCost: number; default: not declared - turnover: number; default: not declared — `Σ |trade notional| ÷ post-flow NAV`. ### @insiderfinance/totalfinance/portfolio#RebalanceGroupWeight Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceGroupWeight { key: string; current: number; target: number; postTrade: number; driftBand: number | null; outsideBand: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: number; default: not declared - driftBand: number | null; default: not declared - key: string; default: not declared - outsideBand: boolean; default: not declared - postTrade: number; default: not declared - target: number; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceInstrumentWeight Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceInstrumentWeight { instrumentId: string; /** Weight of the pre-flow managed NAV. */ current: number; /** `null` when the instrument's goal is unresolved (an `unresolvedTargets` row names why). */ target: number | null; /** Weight of the post-flow NAV after the proposed trades. */ postTrade: number; driftBand: number | null; outsideBand: boolean; sourceGroups: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: number; default: not declared — Weight of the pre-flow managed NAV. - driftBand: number | null; default: not declared - instrumentId: string; default: not declared - outsideBand: boolean; default: not declared - postTrade: number; default: not declared — Weight of the post-flow NAV after the proposed trades. - sourceGroups: string[]; default: not declared - target: number | null; default: not declared — `null` when the instrument's goal is unresolved (an `unresolvedTargets` row names why). ### @insiderfinance/totalfinance/portfolio#RebalanceLotPreview Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceLotPreview { lotId: string; /** Unsigned quantity relieved from this lot. */ quantity: number; costBasisPerUnit: number; /** At the mark, in the position's currency: long `(mark − basis) × quantity`; short `(basis − mark) × quantity`. */ estimatedRealizedPnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - costBasisPerUnit: number; default: not declared - estimatedRealizedPnl: number; default: not declared — At the mark, in the position's currency: long `(mark − basis) × quantity`; short `(basis − mark) × quantity`. - lotId: string; default: not declared - quantity: number; default: not declared — Unsigned quantity relieved from this lot. ### @insiderfinance/totalfinance/portfolio#RebalanceLotSelection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceLotSelection { policy: LotReliefPolicy; lots: RebalanceLotPreview[]; estimatedRealizedPnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - estimatedRealizedPnl: number; default: not declared - lots: RebalanceLotPreview[]; default: not declared - policy: LotReliefPolicy; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceObjectivePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceObjectivePoint { /** `Σ |weight − target| ÷ 2` over instrument targets and cash. */ driftDistance: number; /** Active share vs `policy.benchmark.constituents`; `null` (with a diagnostics warning) when none are given. */ trackingDistance: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - driftDistance: number; default: not declared — `Σ |weight − target| ÷ 2` over instrument targets and cash. - trackingDistance: number | null; default: not declared — Active share vs `policy.benchmark.constituents`; `null` (with a diagnostics warning) when none are given. ### @insiderfinance/totalfinance/portfolio#RebalanceRiskPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceRiskPoint { maximumPositionWeight: number; /** `Σ weight²` over instruments (cash excluded). */ herfindahlIndex: number; topThreeWeight: number; /** `Σ |weight|` over instruments. */ grossLeverage: number; cashWeight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashWeight: number; default: not declared - grossLeverage: number; default: not declared — `Σ |weight|` over instruments. - herfindahlIndex: number; default: not declared — `Σ weight²` over instruments (cash excluded). - maximumPositionWeight: number; default: not declared - topThreeWeight: number; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceScope Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Trade every instrument to target, or only what is outside its drift band. REQUIRED. ```typescript // --------------------------------------------------------------------------------------------------- // Public types // --------------------------------------------------------------------------------------------------- /** Trade every instrument to target, or only what is outside its drift band. REQUIRED. */ export type RebalanceScope = 'to-target' | 'drift-only'; ``` ### @insiderfinance/totalfinance/portfolio#RebalanceTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RebalanceTrade { accountId: string; instrumentId: string; side: 'buy' | 'sell'; /** Unsigned magnitude. */ quantity: number; /** The mark, in `currency`. */ markPricePerUnit: number; currency: string; /** `quantity × mark` converted to the base currency. */ estimatedNotional: number; estimatedCommission: number; estimatedSpreadCost: number; estimatedSlippageCost: number; /** Present when the trade relieves lots under the ledger's own `lotRelief` policy. */ lotSelection: RebalanceLotSelection | null; /** Why `lotSelection` is null (the trade opens/extends, or the policy is 'specific-lot'); null otherwise. */ lotSelectionReason: string | null; reason: RebalanceTradeReason; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - currency: string; default: not declared - estimatedCommission: number; default: not declared - estimatedNotional: number; default: not declared — `quantity × mark` converted to the base currency. - estimatedSlippageCost: number; default: not declared - estimatedSpreadCost: number; default: not declared - instrumentId: string; default: not declared - lotSelection: RebalanceLotSelection | null; default: not declared — Present when the trade relieves lots under the ledger's own `lotRelief` policy. - lotSelection.estimatedRealizedPnl: number; default: not declared - lotSelection.lots: RebalanceLotPreview[]; default: not declared - lotSelection.policy: LotReliefPolicy; default: not declared - lotSelectionReason: string | null; default: not declared — Why `lotSelection` is null (the trade opens/extends, or the policy is 'specific-lot'); null otherwise. - markPricePerUnit: number; default: not declared — The mark, in `currency`. - quantity: number; default: not declared — Unsigned magnitude. - reason: RebalanceTradeReason; default: not declared - side: 'buy' | 'sell'; default: not declared ### @insiderfinance/totalfinance/portfolio#RebalanceTradeReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RebalanceTradeReason = 'drift' | 'to-target' | 'contribution' | 'withdrawal'; ``` ### @insiderfinance/totalfinance/portfolio#ReconcileExecutionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconcileExecutionInput { /** The journal's events (folded here) or an already-folded state. */ journal: readonly ExecutionJournalEvent[] | ExecutionJournalState; ledger: PortfolioState; /** The `sourceId` the execution's fills were folded into the ledger under. */ sourceId: string; /** The execution's fills as delivered. */ fills: readonly NormalizedFill[]; external?: ExternalPortfolioSnapshot; asOf: EpochMs | string; /** Explicit — reconciliation never assumes a tolerance. */ tolerance: ReconciliationTolerance; /** Exclude other plans' journaled orders and fills; unattributed source fills remain discrepancies. */ planHash?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - external?: ExternalPortfolioSnapshot; default: not declared - external.accounts: Record; default: not declared - external.asOf: string | number; default: not declared - external.source?: string; default: not declared — Free-text origin (e.g. a broker name); echoed into suggested corrections' provenance. - fills: readonly NormalizedFill[]; default: not declared — The execution's fills as delivered. - journal: readonly ExecutionJournalEvent[] | ExecutionJournalState; default: not declared — The journal's events (folded here) or an already-folded state. - journal.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - journal.eventCount: number; default: not declared - journal.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - journal.journalId: string | null; default: not declared — Null until the first event. - journal.orders: Record; default: not declared - journal.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. - ledger: PortfolioState; default: not declared - ledger.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - ledger.accounts: Record; default: not declared - ledger.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - ledger.baseCurrency: string; default: not declared - ledger.eventCount: number; default: not declared - ledger.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - ledger.lastEffectiveTimestampMs: number | null; default: not declared - ledger.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - ledger.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - ledger.portfolioId?: string; default: not declared - ledger.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - ledger.schemaVersion: number; default: not declared - planHash?: string; default: not declared — Exclude other plans' journaled orders and fills; unattributed source fills remain discrepancies. - sourceId: string; default: not declared — The `sourceId` the execution's fills were folded into the ledger under. - tolerance: ReconciliationTolerance; default: not declared — Explicit — reconciliation never assumes a tolerance. - tolerance.cashAmount: number; default: not declared - tolerance.costBasis?: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - tolerance.quantity: number; default: not declared ### @insiderfinance/totalfinance/portfolio#ReconcilePortfolioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconcilePortfolioInput { portfolio: PortfolioState; external: ExternalPortfolioSnapshot; /** The comparison instant (settled/unsettled cash is classified here); ISO date or epoch ms. */ asOf: EpochMs | string; tolerance: ReconciliationTolerance; /** `sourceId` stamped on suggested correction drafts. Default `'reconciliation'`. */ correctionSourceId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — The comparison instant (settled/unsettled cash is classified here); ISO date or epoch ms. - correctionSourceId?: string; default: not declared — `sourceId` stamped on suggested correction drafts. Default `'reconciliation'`. - external: ExternalPortfolioSnapshot; default: not declared - external.accounts: Record; default: not declared - external.asOf: string | number; default: not declared - external.source?: string; default: not declared — Free-text origin (e.g. a broker name); echoed into suggested corrections' provenance. - portfolio: PortfolioState; default: not declared - portfolio.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - portfolio.accounts: Record; default: not declared - portfolio.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - portfolio.baseCurrency: string; default: not declared - portfolio.eventCount: number; default: not declared - portfolio.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - portfolio.lastEffectiveTimestampMs: number | null; default: not declared - portfolio.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - portfolio.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolio.portfolioId?: string; default: not declared - portfolio.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - portfolio.schemaVersion: number; default: not declared - tolerance: ReconciliationTolerance; default: not declared - tolerance.cashAmount: number; default: not declared - tolerance.costBasis?: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - tolerance.quantity: number; default: not declared ### @insiderfinance/totalfinance/portfolio#ReconcilePortfolioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconcilePortfolioResult { asOf: EpochMs; baseCurrency: string; /** Every difference is within tolerance (or explained by pending settlement). */ reconciled: boolean; accounts: ReconciliationAccountReport[]; /** Differences beyond tolerance, before explanations. */ differenceCount: number; /** Beyond-tolerance differences an explanation accounts for. */ explainedCount: number; /** * DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with * `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a * separate authorized portfolio write. */ suggestedCorrections: PortfolioEventEnvelope[]; /** Differences for which no complete draft could be written, and what would be needed. */ undraftable: { accountId: string; subject: string; reason: string; }[]; assumptions: { conventionsVersion: string; lotRelief: LotReliefPolicy; tolerance: Required; comparisonConvention: string; }; diagnostics: { warnings: string[]; ledgerAccountCount: number; externalAccountCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accounts: ReconciliationAccountReport[]; default: not declared - asOf: number; default: not declared - assumptions: { comparisonConvention: string; conventionsVersion: string; lotRelief: LotReliefPolicy; tolerance: Required; }; default: not declared - assumptions.comparisonConvention: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.lotRelief: LotReliefPolicy; default: not declared - assumptions.tolerance: Required; default: not declared - assumptions.tolerance.cashAmount: number; default: not declared - assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - assumptions.tolerance.quantity: number; default: not declared - baseCurrency: string; default: not declared - diagnostics: { externalAccountCount: number; ledgerAccountCount: number; warnings: string[]; }; default: not declared - diagnostics.externalAccountCount: number; default: not declared - diagnostics.ledgerAccountCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - suggestedCorrections: PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. ### @insiderfinance/totalfinance/portfolio#ReconciliationAccountReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconciliationAccountReport { accountId: string; presentInLedger: boolean; presentInExternal: boolean; /** Sorted by currency. */ cash: CashDifference[]; /** Sorted by instrumentId; every ledger or external position appears exactly once. */ positions: PositionDifference[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - cash: CashDifference[]; default: not declared — Sorted by currency. - positions: PositionDifference[]; default: not declared — Sorted by instrumentId; every ledger or external position appears exactly once. - presentInExternal: boolean; default: not declared - presentInLedger: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio#ReconciliationExplanation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ReconciliationExplanation = { kind: 'pending-settlement'; detail: string; } | { kind: 'corporate-action-candidate'; detail: string; ratio: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: string; default: not declared - kind: ('corporate-action-candidate') | ('pending-settlement'); default: not declared - ratio: number; default: not declared ### @insiderfinance/totalfinance/portfolio#ReconciliationReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconciliationReport { kind: typeof RECONCILIATION_REPORT_KIND; schemaVersion: typeof RECONCILIATION_REPORT_SCHEMA_VERSION; asOf: EpochMs; planHash: string | null; journalId: string | null; sourceId: string; reconciled: boolean; orders: ExecutionOrderState[]; orderChecks: ReconciliationOrderCheck[]; fills: ReconciliationFillMatch[]; /** Journaled fill ids with no `trade.fill` under the source in the ledger. */ journaledNotInLedger: string[]; /** Ledger `trade.fill` ids under the source that no order journaled. */ ledgerNotJournaled: string[]; unresolved: { orderId: string; reason: string; }[]; /** `reconcilePortfolio`'s result when an external snapshot was given. */ portfolio: ReconcilePortfolioResult | null; assumptions: { conventionsVersion: string; tolerance: Required; matchConvention: string; }; diagnostics: { engine: 'trade-reconciliation'; warnings: string[]; orderCount: number; openCount: number; fillCount: number; ledgerFillCount: number; unresolvedCount: number; differenceCount: number; }; contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - assumptions: { conventionsVersion: string; matchConvention: string; tolerance: Required; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.matchConvention: string; default: not declared - assumptions.tolerance: Required; default: not declared - assumptions.tolerance.cashAmount: number; default: not declared - assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - assumptions.tolerance.quantity: number; default: not declared - contentHash: string; default: not declared - diagnostics: { differenceCount: number; engine: 'trade-reconciliation'; fillCount: number; ledgerFillCount: number; openCount: number; orderCount: number; unresolvedCount: number; warnings: string[]; }; default: not declared - diagnostics.differenceCount: number; default: not declared - diagnostics.engine: 'trade-reconciliation'; default: not declared - diagnostics.fillCount: number; default: not declared - diagnostics.ledgerFillCount: number; default: not declared - diagnostics.openCount: number; default: not declared - diagnostics.orderCount: number; default: not declared - diagnostics.unresolvedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - fills: ReconciliationFillMatch[]; default: not declared - journalId: string | null; default: not declared - journaledNotInLedger: string[]; default: not declared — Journaled fill ids with no `trade.fill` under the source in the ledger. - kind: 'totalfinance.reconciliation-report'; default: not declared - ledgerNotJournaled: string[]; default: not declared — Ledger `trade.fill` ids under the source that no order journaled. - orderChecks: ReconciliationOrderCheck[]; default: not declared - orders: ExecutionOrderState[]; default: not declared - planHash: string | null; default: not declared - portfolio: ReconcilePortfolioResult | null; default: not declared — `reconcilePortfolio`'s result when an external snapshot was given. - portfolio.accounts: import('@insiderfinance/totalfinance/portfolio').ReconciliationAccountReport[]; default: not declared - portfolio.asOf: number; default: not declared - portfolio.assumptions: { comparisonConvention: string; conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; tolerance: Required; }; default: not declared - portfolio.assumptions.comparisonConvention: string; default: not declared - portfolio.assumptions.conventionsVersion: string; default: not declared - portfolio.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - portfolio.assumptions.tolerance: Required; default: not declared - portfolio.assumptions.tolerance.cashAmount: number; default: not declared - portfolio.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - portfolio.assumptions.tolerance.quantity: number; default: not declared - portfolio.baseCurrency: string; default: not declared - portfolio.diagnostics: { externalAccountCount: number; ledgerAccountCount: number; warnings: string[]; }; default: not declared - portfolio.diagnostics.externalAccountCount: number; default: not declared - portfolio.diagnostics.ledgerAccountCount: number; default: not declared - portfolio.diagnostics.warnings: string[]; default: not declared - portfolio.differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - portfolio.explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - portfolio.reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - portfolio.suggestedCorrections: PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - portfolio.undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. - reconciled: boolean; default: not declared - schemaVersion: 1; default: not declared - sourceId: string; default: not declared - unresolved: { orderId: string; reason: string; }[]; default: not declared ### @insiderfinance/totalfinance/portfolio#ReconciliationTolerance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit — never defaulted. Absolute amounts in position units and in each currency's units. ```typescript /** Explicit — never defaulted. Absolute amounts in position units and in each currency's units. */ export interface ReconciliationTolerance { quantity: number; cashAmount: number; /** Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. */ costBasis?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashAmount: number; default: not declared - costBasis?: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - quantity: number; default: not declared ### @insiderfinance/totalfinance/portfolio#RedemptionType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RedemptionType = 'maturity' | 'call' | 'principal-paydown' | 'sinking-fund'; ``` ### @insiderfinance/totalfinance/portfolio#ResolveModelTargetsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link resolveModelTargets}. ```typescript /** Input for {@link resolveModelTargets}. */ export interface ResolveModelTargetsInput { model: ModelPortfolio; /** The instant to resolve at (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). */ asOf: EpochMs | string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — The instant to resolve at (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - model: ModelPortfolio; default: not declared - model.baseCurrency: string; default: not declared - model.benchmark?: BenchmarkIdentity; default: not declared - model.benchmark.asOf?: string | number; default: not declared — The instant the membership below is stated at. - model.benchmark.benchmarkId: string; default: not declared - model.benchmark.constituents?: BenchmarkConstituent[]; default: not declared — Constituent weights (sum to 1) — the identity a tracking comparison is made against. - model.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - model.glidePath?: GlidePath; default: not declared - model.glidePath.interpolation: 'linear' | 'step'; default: not declared - model.glidePath.points: GlidePathPoint[]; default: not declared - model.horizonEndDate?: string | number; default: not declared - model.kind: 'totalfinance.model-portfolio'; default: not declared - model.liabilities?: LiabilitySchedule; default: not declared - model.liabilities.entries: LiabilityEntry[]; default: not declared - model.liabilities.note?: string; default: not declared - model.modelId: string; default: not declared - model.note?: string; default: not declared - model.schemaVersion: number; default: not declared - model.sleeves?: ModelSleeve[]; default: not declared - model.strategic: TargetSet; default: not declared - model.strategic.effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - model.strategic.effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - model.strategic.note?: string; default: not declared - model.strategic.targets: AllocationTarget[]; default: not declared - model.tactical?: TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - model.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. ### @insiderfinance/totalfinance/portfolio#ResolvedMonitorRule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The rule actually applied to a family — defaults, policy limits, and overrides resolved. ```typescript /** The rule actually applied to a family — defaults, policy limits, and overrides resolved. */ export interface ResolvedMonitorRule { enabled: boolean; /** The family-level threshold; `null` when thresholds are per observation (drift bands, group limits) or undeclared. */ threshold: number | null; thresholdSource: MonitorThresholdSource; direction: MonitorAlertDirection; hysteresis: MonitorHysteresis | null; debounceEvaluations: number; cooldownMs: number; severity: MonitorAlertSeverity; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cooldownMs: number; default: not declared - debounceEvaluations: number; default: not declared - direction: MonitorAlertDirection; default: not declared - enabled: boolean; default: not declared - hysteresis: MonitorHysteresis | null; default: not declared - hysteresis.enter: number; default: not declared - hysteresis.exit: number; default: not declared - severity: MonitorAlertSeverity; default: not declared - threshold: number | null; default: not declared — The family-level threshold; `null` when thresholds are per observation (drift bands, group limits) or undeclared. - thresholdSource: MonitorThresholdSource; default: not declared ### @insiderfinance/totalfinance/portfolio#ResolvedTargetSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Public types — resolution // --------------------------------------------------------------------------------------------------- export type ResolvedTargetSource = 'inline' | 'strategic' | 'tactical' | 'glide-path'; ``` ### @insiderfinance/totalfinance/portfolio#ResolvedTargets Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The targets effective at one instant, with where they came from. ```typescript /** The targets effective at one instant, with where they came from. */ export interface ResolvedTargets { targets: AllocationTarget[]; source: ResolvedTargetSource; /** The effective-from instant of the winning set (`null` for inline targets). */ effectiveFrom: EpochMs | null; /** Present when a linear glide path interpolated between two points. */ interpolation?: { from: EpochMs; to: EpochMs; fraction: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - effectiveFrom: number | null; default: not declared — The effective-from instant of the winning set (`null` for inline targets). - interpolation?: { fraction: number; from: EpochMs; to: EpochMs; }; default: not declared — Present when a linear glide path interpolated between two points. - interpolation.fraction: number; default: not declared - interpolation.from: number; default: not declared - interpolation.to: number; default: not declared - source: ResolvedTargetSource; default: not declared - targets: AllocationTarget[]; default: not declared ### @insiderfinance/totalfinance/portfolio#ReturnOfCapitalEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A return of capital: cash received reduces basis (never income); excess over basis is realized. ```typescript /** A return of capital: cash received reduces basis (never income); excess over basis is realized. */ export interface ReturnOfCapitalEvent { eventType: 'corporate.return-of-capital'; instrumentId: string; amountPerShare: number; currency: string; settleTimestampMs?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amountPerShare: number; default: not declared - currency: string; default: not declared - eventType: 'corporate.return-of-capital'; default: not declared - instrumentId: string; default: not declared - settleTimestampMs?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#ScheduledSettlement Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One dated cash leg: `amount` (signed) becomes settled once `asOf ≥ settleTimestampMs`. ```typescript /** One dated cash leg: `amount` (signed) becomes settled once `asOf ≥ settleTimestampMs`. */ export interface ScheduledSettlement { /** The envelope `eventId` that booked this leg. */ eventId: string; /** Signed cash effect: positive = incoming (receivable until settled), negative = payable. */ amount: number; settleTimestampMs: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Signed cash effect: positive = incoming (receivable until settled), negative = payable. - eventId: string; default: not declared — The envelope `eventId` that booked this leg. - settleTimestampMs: number; default: not declared ### @insiderfinance/totalfinance/portfolio#SettlementStyle Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a position's cash settles: at the fill, or through variation margin. ```typescript // --------------------------------------------------------------------------------------------------- // Instrument profile and lifecycle families (slice 5, 2026-08-29; agent-native "Derivative // lifecycle" and "Corporate actions" families; FC7 mandatory state) // --------------------------------------------------------------------------------------------------- /** How a position's cash settles: at the fill, or through variation margin. */ export type SettlementStyle = 'cash-on-trade' | 'variation-margin'; ``` ### @insiderfinance/totalfinance/portfolio#SleeveMember Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A sleeve member: an instrument and its weight WITHIN the sleeve (members sum to 1). ```typescript /** A sleeve member: an instrument and its weight WITHIN the sleeve (members sum to 1). */ export interface SleeveMember { instrumentId: string; weight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/portfolio#SpinOffEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A spin-off: child shares per parent share with an EXPLICIT basis allocation fraction. ```typescript /** A spin-off: child shares per parent share with an EXPLICIT basis allocation fraction. */ export interface SpinOffEvent { eventType: 'corporate.spin-off'; parentInstrumentId: string; childInstrumentId: string; sharesPerParentShare: number; /** Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. */ basisAllocationFraction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - basisAllocationFraction: number; default: not declared — Fraction of the parent's basis that moves to the child, in [0, 1]. REQUIRED. - childInstrumentId: string; default: not declared - eventType: 'corporate.spin-off'; default: not declared - parentInstrumentId: string; default: not declared - sharesPerParentShare: number; default: not declared ### @insiderfinance/totalfinance/portfolio#StockSplitEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A forward or reverse stock split: every lot's quantity scales by `sharesAfterSplit / sharesBeforeSplit` and its per-unit basis by the inverse, so total cost basis is preserved exactly. Cash-in-lieu of fractional shares is a separate (later) event. ```typescript /** * A forward or reverse stock split: every lot's quantity scales by * `sharesAfterSplit / sharesBeforeSplit` and its per-unit basis by the inverse, so total cost * basis is preserved exactly. Cash-in-lieu of fractional shares is a separate (later) event. */ export interface StockSplitEvent { eventType: 'corporate.split'; instrumentId: string; /** Shares held after the split per `sharesBeforeSplit` held before; positive integer. */ sharesAfterSplit: number; /** Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. */ sharesBeforeSplit: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'corporate.split'; default: not declared - instrumentId: string; default: not declared - sharesAfterSplit: number; default: not declared — Shares held after the split per `sharesBeforeSplit` held before; positive integer. - sharesBeforeSplit: number; default: not declared — Positive integer; a 2-for-1 split is `{ sharesAfterSplit: 2, sharesBeforeSplit: 1 }`. ### @insiderfinance/totalfinance/portfolio#SymbolChangeEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The instrument is renamed; lots, basis, and lot ids carry over. ```typescript /** The instrument is renamed; lots, basis, and lot ids carry over. */ export interface SymbolChangeEvent { eventType: 'corporate.symbol-change'; fromInstrumentId: string; toInstrumentId: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'corporate.symbol-change'; default: not declared - fromInstrumentId: string; default: not declared - toInstrumentId: string; default: not declared ### @insiderfinance/totalfinance/portfolio#TRADE_PLAN_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TRADE_PLAN_KIND: 'totalfinance.trade-plan'; ``` ### @insiderfinance/totalfinance/portfolio#TRADE_PLAN_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TRADE_PLAN_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio#TargetGroup Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The group a target applies to — EXACTLY ONE key. `instrumentId` and `sleeveId` resolve through the model; the classification keys resolve through the caller's `instrumentClassification` (`currency` through each position's trading currency). `{ assetClass: 'cash' }` targets cash. ```typescript // --------------------------------------------------------------------------------------------------- // Public types — targets // --------------------------------------------------------------------------------------------------- /** * The group a target applies to — EXACTLY ONE key. `instrumentId` and `sleeveId` resolve through * the model; the classification keys resolve through the caller's `instrumentClassification` * (`currency` through each position's trading currency). `{ assetClass: 'cash' }` targets cash. */ export interface TargetGroup { instrumentId?: string; sleeveId?: string; assetClass?: string; currency?: string; tag?: string; underlying?: string; strategy?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assetClass?: string; default: not declared - currency?: string; default: not declared - instrumentId?: string; default: not declared - sleeveId?: string; default: not declared - strategy?: string; default: not declared - tag?: string; default: not declared - underlying?: string; default: not declared ### @insiderfinance/totalfinance/portfolio#TargetGroupKey Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type TargetGroupKey = keyof TargetGroup; ``` ### @insiderfinance/totalfinance/portfolio#TargetSet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A dated, complete set of targets. ```typescript /** A dated, complete set of targets. */ export interface TargetSet { /** When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). */ effectiveFrom: EpochMs | string; /** Optional end of effectiveness (exclusive) — for tactical overrides. */ effectiveTo?: EpochMs | string; targets: AllocationTarget[]; note?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - effectiveFrom: string | number; default: not declared — When the set becomes effective (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - effectiveTo?: string | number; default: not declared — Optional end of effectiveness (exclusive) — for tactical overrides. - note?: string; default: not declared - targets: AllocationTarget[]; default: not declared ### @insiderfinance/totalfinance/portfolio#TaxLot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One tax lot. Long lots have `quantity > 0`; short lots `quantity < 0`. ```typescript /** One tax lot. Long lots have `quantity > 0`; short lots `quantity < 0`. */ export interface TaxLot { /** Deterministic fold identity (`lot-`), stable across replays — addressable by * `specific-lot` relief. */ lotId: string; openedByEventId: string; openedTimestampMs: EpochMs; /** Signed remaining quantity; fractional supported. */ quantity: number; /** For long lots: acquisition price per unit. For short lots: opening proceeds per unit. */ costBasisPerUnit: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - costBasisPerUnit: number; default: not declared — For long lots: acquisition price per unit. For short lots: opening proceeds per unit. - lotId: string; default: not declared — Deterministic fold identity (`lot-`), stable across replays — addressable by `specific-lot` relief. - openedByEventId: string; default: not declared - openedTimestampMs: number; default: not declared - quantity: number; default: not declared — Signed remaining quantity; fractional supported. ### @insiderfinance/totalfinance/portfolio#TimeInForce Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TimeInForce`. ### @insiderfinance/totalfinance/portfolio#TradeCostEstimate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TradeCostEstimate { commission: number; spread: number; slippage: number; total: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: number; default: not declared - slippage: number; default: not declared - spread: number; default: not declared - total: number; default: not declared ### @insiderfinance/totalfinance/portfolio#TradeFillEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An executed fill — the audited bridge from the execution journal into economic holdings (Permanent law 3). Buys open/extend long lots or cover short lots; sells relieve long lots or open short lots. This slice prices cash as `quantity × pricePerUnit` (contract multipliers arrive with the derivative-lifecycle slice). ```typescript /** * An executed fill — the audited bridge from the execution journal into economic holdings * (Permanent law 3). Buys open/extend long lots or cover short lots; sells relieve long lots or * open short lots. This slice prices cash as `quantity × pricePerUnit` (contract multipliers * arrive with the derivative-lifecycle slice). */ export interface TradeFillEvent { eventType: 'trade.fill'; instrumentId: string; side: 'buy' | 'sell'; /** Filled quantity, > 0 (fractional supported); `side` carries the direction. */ quantity: number; /** Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). */ pricePerUnit: number; currency: string; /** When the cash leg settles (trade date vs settlement date); omitted = settles immediately. */ settleTimestampMs?: EpochMs; /** Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. */ lotSelections?: TradeFillLotSelection[]; /** * Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract * size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill * states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. */ contractMultiplier?: number; /** * `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × * contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at * the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED * as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. */ settlementStyle?: SettlementStyle; /** The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. */ contract?: DerivativeContractTerms; /** * Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as * an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. */ accruedInterest?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accruedInterest?: number; default: not declared — Accrued interest paid with a bond purchase (or received on a sale), in `currency` — booked as an income adjustment (negative on a buy), NEVER into the lot basis; the next coupon recovers it. - contract?: DerivativeContractTerms; default: not declared — The derivative's terms (option type/strike/expiry, future expiry, perpetual) — stored on the position. - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared — Units of the underlying per unit of `quantity` (an equity option's 100, a futures contract size). Omitted = 1 (one unit per unit). REQUIRED when `contract` is given — a derivative fill states its multiplier. Cash and lot values scale by it; the lot basis stays per unit. - currency: string; default: not declared - eventType: 'trade.fill'; default: not declared - instrumentId: string; default: not declared - lotSelections?: TradeFillLotSelection[]; default: not declared — Required exactly when the ledger's `lotRelief` is `'specific-lot'` AND this fill closes. - pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - settleTimestampMs?: number; default: not declared — When the cash leg settles (trade date vs settlement date); omitted = settles immediately. - settlementStyle?: SettlementStyle; default: not declared — `'cash-on-trade'` (equities, options, spot; the default) books `quantity × pricePerUnit × contractMultiplier` at the fill. `'variation-margin'` (futures, perpetuals) books NO cash at the fill: P&L is realized by `derivative.variation-margin` settlements and on close. REQUIRED as `'variation-margin'` when `contract.kind` is `'future'` or `'perpetual'`. - side: 'buy' | 'sell'; default: not declared ### @insiderfinance/totalfinance/portfolio#TradeFillLotSelection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One `specific-lot` relief instruction: which lot, and how much of it, this fill closes. ```typescript /** One `specific-lot` relief instruction: which lot, and how much of it, this fill closes. */ export interface TradeFillLotSelection { lotId: string; /** Quantity relieved from the named lot, > 0 (an unsigned magnitude). */ quantity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lotId: string; default: not declared - quantity: number; default: not declared — Quantity relieved from the named lot, > 0 (an unsigned magnitude). ### @insiderfinance/totalfinance/portfolio#TradeIntent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The desired economic action, without a broker payload or a credential (law 5). ```typescript /** The desired economic action, without a broker payload or a credential (law 5). */ export interface TradeIntent { kind: typeof TRADE_INTENT_KIND; schemaVersion: number; accountId: string; asOf: EpochMs; orders: TradeIntentOrder[]; /** The combos the lines' `comboId`s name, when a net limit is wanted; a combo without terms needs no entry. */ combos?: TradeIntentCombo[]; /** Metadata: recorded, never read by any stage. */ rationale?: string; /** Artifact ids the intent rests on. */ evidence?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - asOf: number; default: not declared - combos?: TradeIntentCombo[]; default: not declared — The combos the lines' `comboId`s name, when a net limit is wanted; a combo without terms needs no entry. - evidence?: string[]; default: not declared — Artifact ids the intent rests on. - kind: 'totalfinance.trade-intent'; default: not declared - orders: TradeIntentOrder[]; default: not declared - rationale?: string; default: not declared — Metadata: recorded, never read by any stage. - schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#TradeOrder Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One executable order — field for field the execution grammar every engine and the paper broker fill. ```typescript // B6 — one order vocabulary: `OrderSide`, `OrderType` and `TimeInForce` are core's, re-exported here. /** One executable order — field for field the execution grammar every engine and the paper broker fill. */ export interface TradeOrder { orderId: string; instrumentId: string; side: OrderSide; quantity: number; type: OrderType; limitPrice?: number; stopPrice?: number; timeInForce?: TimeInForce; /** The plan's instant — when the order was planned, never when it reached a broker. */ plannedTimestampMs: EpochMs; /** Stamped by the broker at submission; absent on a plan's order. A fill never consumes an observation older than it. */ submittedTimestampMs?: EpochMs; /** The multi-leg order this is a leg of (B5); the plan's `combos` names the legs and the net limit. */ comboId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comboId?: string; default: not declared — The multi-leg order this is a leg of (B5); the plan's `combos` names the legs and the net limit. - instrumentId: string; default: not declared - limitPrice?: number; default: not declared - orderId: string; default: not declared - plannedTimestampMs: number; default: not declared — The plan's instant — when the order was planned, never when it reached a broker. - quantity: number; default: not declared - side: OrderSide; default: not declared - stopPrice?: number; default: not declared - submittedTimestampMs?: number; default: not declared — Stamped by the broker at submission; absent on a plan's order. A fill never consumes an observation older than it. - timeInForce?: TimeInForce; default: not declared - type: OrderType; default: not declared ### @insiderfinance/totalfinance/portfolio#TradePlanArtifact Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A normalized, content-addressed plan suitable for preflight. It contains NO execution capability. ```typescript /** A normalized, content-addressed plan suitable for preflight. It contains NO execution capability. */ export interface TradePlanArtifact { kind: typeof TRADE_PLAN_KIND; schemaVersion: number; asOf: EpochMs; baseCurrency: string; portfolioId?: string; /** `contentHash` over the validated policy the plan was built from. */ policyContentHash: string; /** Sorted by (accountId, instrumentId, side). */ trades: TradePlanTrade[]; /** `sha256:` over every field above. */ contentHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - baseCurrency: string; default: not declared - contentHash: string; default: not declared — `sha256:` over every field above. - kind: 'totalfinance.trade-plan'; default: not declared - policyContentHash: string; default: not declared — `contentHash` over the validated policy the plan was built from. - portfolioId?: string; default: not declared - schemaVersion: number; default: not declared - trades: TradePlanTrade[]; default: not declared — Sorted by (accountId, instrumentId, side). ### @insiderfinance/totalfinance/portfolio#TradePlanTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TradePlanTrade { accountId: string; instrumentId: string; side: 'buy' | 'sell'; quantity: number; /** The instrument's trading currency. */ currency: string; referencePricePerUnit: number; /** * The contract multiplier the estimate applied: the ledger position's, the `instruments` * description's, or 1 for a plain instrument known only from a market spot. An OCC option symbol * never takes that share default — the plan refuses it until the multiplier is declared. */ contractMultiplier: number; /** `quantity × referencePricePerUnit × contractMultiplier`, in `currency`. */ estimatedNotional: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - contractMultiplier: number; default: not declared — The contract multiplier the estimate applied: the ledger position's, the `instruments` description's, or 1 for a plain instrument known only from a market spot. An OCC option symbol never takes that share default — the plan refuses it until the multiplier is declared. - currency: string; default: not declared — The instrument's trading currency. - estimatedNotional: number; default: not declared — `quantity × referencePricePerUnit × contractMultiplier`, in `currency`. - instrumentId: string; default: not declared - quantity: number; default: not declared - referencePricePerUnit: number; default: not declared - side: 'buy' | 'sell'; default: not declared ### @insiderfinance/totalfinance/portfolio#TradePolicy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A closed, deterministic policy over a plan: FC7's limits verbatim plus the order-level bounds. ```typescript /** A closed, deterministic policy over a plan: FC7's limits verbatim plus the order-level bounds. */ export interface TradePolicy { /** The only mode this stage accepts; `'live'` is a typed refusal naming AT8. */ mode: 'paper'; limits?: PolicyLimits; allowedAccounts?: string[]; allowedAssetClasses?: string[]; allowedInstruments?: string[]; allowedOrderTypes?: OrderType[]; maximumOrderQuantity?: number; maximumOrderNotional?: number; /** Base currency, the plan's total estimated commission + spread + slippage. */ maximumEstimatedCost?: number; maximumSlippageBps?: number; maximumParticipation?: number; /** Default false: a plan that leaves an option net short (a call uncovered) is denied. */ allowUndefinedRiskOptions?: boolean; marketMaximumAgeMs?: number; /** Traded notional ÷ NAV before the plan. */ maximumTurnover?: number; /** Above either bound the decision is `require-approval` rather than `allow`. */ requireApprovalAbove?: { notional?: number; quantity?: number; }; /** What an unverifiable check does to the decision (default `'require-approval'`). */ onUnverifiable?: 'require-approval' | 'deny'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a plan that leaves an option net short (a call uncovered) is denied. - allowedAccounts?: string[]; default: not declared - allowedAssetClasses?: string[]; default: not declared - allowedInstruments?: string[]; default: not declared - allowedOrderTypes?: OrderType[]; default: not declared - limits?: PolicyLimits; default: not declared - limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - marketMaximumAgeMs?: number; default: not declared - maximumEstimatedCost?: number; default: not declared — Base currency, the plan's total estimated commission + spread + slippage. - maximumOrderNotional?: number; default: not declared - maximumOrderQuantity?: number; default: not declared - maximumParticipation?: number; default: not declared - maximumSlippageBps?: number; default: not declared - maximumTurnover?: number; default: not declared — Traded notional ÷ NAV before the plan. - mode: 'paper'; default: not declared — The only mode this stage accepts; `'live'` is a typed refusal naming AT8. - onUnverifiable?: 'require-approval' | 'deny'; default: not declared — What an unverifiable check does to the decision (default `'require-approval'`). - requireApprovalAbove?: { notional?: number; quantity?: number; }; default: not declared — Above either bound the decision is `require-approval` rather than `allow`. - requireApprovalAbove.notional?: number; default: not declared - requireApprovalAbove.quantity?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#UnresolvedConstraint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface UnresolvedConstraint { constraint: string; status: UnresolvedConstraintStatus; reason: string; value: number | null; limit: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - constraint: string; default: not declared - limit: number | null; default: not declared - reason: string; default: not declared - status: UnresolvedConstraintStatus; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/portfolio#UnresolvedConstraintStatus Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `capped`: the constraint bound the plan (trimmed to honour it; the goal is unmet). `violated`: the plan as proposed breaks the limit (never auto-fixed; `feasible` is false). `unverifiable`: the limit could not be evaluated (data missing); `feasible` is false. ```typescript /** * `capped`: the constraint bound the plan (trimmed to honour it; the goal is unmet). * `violated`: the plan as proposed breaks the limit (never auto-fixed; `feasible` is false). * `unverifiable`: the limit could not be evaluated (data missing); `feasible` is false. */ export type UnresolvedConstraintStatus = 'capped' | 'violated' | 'unverifiable'; ``` ### @insiderfinance/totalfinance/portfolio#UnresolvedTarget Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface UnresolvedTarget { key: string; group: TargetGroup; reason: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - group: TargetGroup; default: not declared - group.assetClass?: string; default: not declared - group.currency?: string; default: not declared - group.instrumentId?: string; default: not declared - group.sleeveId?: string; default: not declared - group.strategy?: string; default: not declared - group.tag?: string; default: not declared - group.underlying?: string; default: not declared - key: string; default: not declared - reason: string; default: not declared ### @insiderfinance/totalfinance/portfolio#VariationMarginEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A variation-margin settlement: every open lot of a `'variation-margin'` position re-bases to the settlement price and the difference is realized in cash — the fold computes the amount from the lots, so a statement's figure reconciles rather than being trusted. ```typescript /** * A variation-margin settlement: every open lot of a `'variation-margin'` position re-bases to * the settlement price and the difference is realized in cash — the fold computes the amount * from the lots, so a statement's figure reconciles rather than being trusted. */ export interface VariationMarginEvent { eventType: 'derivative.variation-margin'; instrumentId: string; settlementPricePerUnit: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventType: 'derivative.variation-margin'; default: not declared - instrumentId: string; default: not declared - settlementPricePerUnit: number; default: not declared ### @insiderfinance/totalfinance/portfolio#VerifyAuthorizationGrantInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VerifyAuthorizationGrantInput { grant: AuthorizationGrant; plan: ExecutionPlan; now: EpochMs; /** The portfolio's content hash at execution. */ portfolioHash: string; /** The market snapshot's content hash at execution. */ marketHash: string; /** The market snapshot's instant at execution. */ marketAsOf: EpochMs; /** Default `'paper'`. */ mode?: 'paper'; /** The submission's key; must be one the grant licenses. */ idempotencyKey: string; /** * The orders about to be submitted when they differ from the plan's (a re-priced limit, a resized * quantity), judged against the grant's variance envelope. Default: the plan's orders. */ orders?: readonly TradeOrder[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - grant: AuthorizationGrant; default: not declared - grant.accountId: string; default: not declared - grant.approvedBy: string; default: not declared - grant.baseCurrency: string; default: not declared - grant.comboIds: string[]; default: not declared — The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. - grant.contentHash: string; default: not declared - grant.expiresAt: number; default: not declared - grant.grantId: string; default: not declared - grant.idempotencyKeys: string[]; default: not declared — The closed set of submission keys this grant licenses — one per attempt. - grant.issuedAt: number; default: not declared - grant.kind: 'totalfinance.authorization-grant'; default: not declared - grant.marketAsOf: number; default: not declared — The market instant the preflight judged; execution must not see an older market. - grant.marketHash: string; default: not declared - grant.marketMaximumAgeMs: number; default: not declared — At execution the market may be at most this old (`now − marketAsOf`). - grant.mode: 'paper'; default: not declared - grant.orderIds: string[]; default: not declared — The plan's order ids, in plan order. - grant.planHash: string; default: not declared - grant.portfolioHash: string; default: not declared - grant.preflightHash: string; default: not declared - grant.requiredScope: string | null; default: not declared — The scope the preflight asked for (`require-approval`), or null when it allowed outright. - grant.schemaVersion: 1; default: not declared - grant.variance: GrantVariance; default: not declared - grant.variance.maximumNotionalRatio: number; default: not declared — `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. - grant.variance.maximumQuantityRatio: number; default: not declared — `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). - grant.variance.maximumSlippageBps: number; default: not declared — A limit price may sit at most this many bps from the plan's reference price. - idempotencyKey: string; default: not declared — The submission's key; must be one the grant licenses. - marketAsOf: number; default: not declared — The market snapshot's instant at execution. - marketHash: string; default: not declared — The market snapshot's content hash at execution. - mode?: 'paper'; default: not declared — Default `'paper'`. - now: number; default: not declared - orders?: readonly TradeOrder[]; default: not declared — The orders about to be submitted when they differ from the plan's (a re-priced limit, a resized quantity), judged against the grant's variance envelope. Default: the plan's orders. - plan: ExecutionPlan; default: not declared - plan.accountId: string; default: not declared - plan.asOf: number; default: not declared - plan.baseCurrency: string; default: not declared - plan.combos: ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - plan.contentHash: string; default: not declared - plan.evidence: string[]; default: not declared - plan.kind: 'totalfinance.execution-plan'; default: not declared - plan.orders: TradeOrder[]; default: not declared - plan.portfolioId?: string; default: not declared - plan.rationale?: string; default: not declared - plan.schemaVersion: number; default: not declared - plan.source: ExecutionPlanSource; default: not declared - plan.source.intentHash: string; default: not declared - plan.source.kind: ('intent') | ('rebalance-proposal'); default: not declared - plan.source.planHash: string; default: not declared - plan.source.policyContentHash: string; default: not declared - plan.trades: TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. - portfolioHash: string; default: not declared — The portfolio's content hash at execution. ### @insiderfinance/totalfinance/portfolio#WithdrawalHandling Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type WithdrawalHandling = 'raise-from-overweights' | 'pro-rata'; ``` ### @insiderfinance/totalfinance/portfolio#WithinGroupAllocation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Public types — the investment policy // --------------------------------------------------------------------------------------------------- export type WithinGroupAllocation = 'proportional-to-current' | 'equal'; ``` ### @insiderfinance/totalfinance/portfolio#allocatePortfolio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Turn a policy's target weights into executable quantities at `asOf` — see the module comment for the laws. A proposal built on this is a PLAN: nothing here executes anything. ```typescript export declare function allocatePortfolio(input: AllocatePortfolioInput): AllocatePortfolioResult; ``` Example (source JSDoc): ```ts import { allocatePortfolio } from '@insiderfinance/totalfinance/portfolio/policy'; const plan = allocatePortfolio({ policy: { targets: [ { group: { instrumentId: 'SPY' }, weight: 0.6 }, { group: { instrumentId: 'AGG' }, weight: 0.3 }, { group: { assetClass: 'cash' }, weight: 0.1 }, ], }, asOf: '2026-08-29', baseCurrency: 'USD', netAssetValue: 100_000, prices: { SPY: { price: 150, currency: 'USD' }, AGG: { price: 100, currency: 'USD' } }, defaultLotSize: 1, }); plan.trades; // buy 400 SPY, buy 300 AGG; plan.cash.residualAmount === 0 ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AllocatePortfolioInput; default: not declared - (input).asOf: string | number; default: not declared — REQUIRED — model targets are dated; echoed on the result. - (input).baseCurrency: string; default: not declared - (input).cashReserve?: number; default: not declared — Base currency held back from the investable amount (≥ 0), on top of the cash target. - (input).contractMultipliers?: Record; default: not declared — Units of the underlying per unit of quantity, per instrument (slice 5): an option's 100, a futures contract size. Omitted = 1. Notional = quantity × price × multiplier; lot rounding stays on quantity. - (input).currencyConversions?: CurrencyPairQuote[]; default: not declared — FC5 quotes; required exactly when a priced instrument's currency ≠ `baseCurrency`. - (input).currentHoldings?: Record; default: not declared — Signed quantity per instrument; omitted = no holdings. - (input).defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - (input).instrumentClassification?: Record; default: not declared - (input).lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - (input).minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - (input).netAssetValue: number; default: not declared — The investable total in base currency (> 0). Weights are shares of this. - (input).policy: InvestmentPolicy; default: not declared — Targets inline or via a model artifact (resolved at `asOf`). - (input).prices: Record; default: not declared — Per instrument. Required for every instrument with a target or a holding. - (input).transactionCosts?: AllocationTransactionCosts; default: not declared - return.allocations: AllocationRow[]; default: not declared — Sorted by instrumentId. - return.asOf: number; default: not declared - return.assumptions: { conventionsVersion: string; costModel: string; currencyConversionsUsed: CurrencyPairQuote[]; pricing: string; rounding: string; targetSource: ResolvedTargetSource; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.costModel: string; default: not declared - return.assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared - return.assumptions.pricing: string; default: not declared - return.assumptions.rounding: string; default: not declared - return.assumptions.targetSource: ResolvedTargetSource; default: not declared - return.baseCurrency: string; default: not declared - return.cash: AllocationCash; default: not declared - return.diagnostics: { dustCount: number; instrumentCount: number; tradeCount: number; unresolvedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.dustCount: number; default: not declared - return.diagnostics.instrumentCount: number; default: not declared - return.diagnostics.tradeCount: number; default: not declared - return.diagnostics.unresolvedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.dust: AllocationDustRow[]; default: not declared — Sorted by instrumentId. - return.estimatedTransactionCost: number; default: not declared - return.feasible: boolean; default: not declared — No unresolved target AND the buys are funded (cash residual ≥ 0). - return.netAssetValue: number; default: not declared - return.trades: AllocationTrade[]; default: not declared — Sorted by instrumentId; dust and zero trades excluded. - return.turnover: number; default: not declared — `Σ |trade notional| ÷ netAssetValue` (buys and sells both counted). - return.unresolved: UnresolvedTarget[]; default: not declared — Sorted by key, then reason. ### @insiderfinance/totalfinance/portfolio#applyJournalEvents Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fold journal events onto a state (Decision 6). The transition table: - `proposed` / `preflighted` / `authorized` are accepted only before `submitted`; - `submitted` opens the order (its `detail.quantity` is the submitted quantity); - `acknowledged` follows `submitted` once; - `partially-filled` and `filled` carry `detail.fillId` and `detail.quantity`; a partial fill must leave quantity open, a fill must complete it; - `cancel-requested` flags the order, `cancelled` / `replaced` / `expired` / `rejected` close it; - `reconciled` marks any existing order; `unresolved` closes any existing order with a reason; - a fill on an order closed by cancellation, replacement, expiry, or rejection is a LATE FILL: the fill is recorded, the order becomes `unresolved` (terminal), and the result lists it. Any other sequence refuses with `trade.journal_transition_invalid`; a store appends only what folds. A duplicate `eventId` is skipped and reported. ```typescript export declare function applyJournalEvents(input: ApplyJournalEventsInput): ApplyJournalEventsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ApplyJournalEventsInput; default: not declared - (input).events: readonly ExecutionJournalEvent[]; default: not declared - (input).previousState?: ExecutionJournalState; default: not declared - return.applied: number; default: not declared - return.diagnostics: { duplicateCount: number; eventCount: number; lateFillCount: number; orderCount: number; unresolvedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.duplicateCount: number; default: not declared - return.diagnostics.eventCount: number; default: not declared - return.diagnostics.lateFillCount: number; default: not declared - return.diagnostics.orderCount: number; default: not declared - return.diagnostics.unresolvedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.duplicates: string[]; default: not declared - return.lateFills: { orderId: string; fillId: string; eventId: string; }[]; default: not declared - return.state: ExecutionJournalState; default: not declared ### @insiderfinance/totalfinance/portfolio#applyPortfolioEvents Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The direct pure reducer (FC7 required API; the agent-native doc's decided API ladder): fold `events` over a fresh `portfolio` definition or a `previousState`, returning a new deeply frozen {@link PortfolioState}. Laws (tested in `test/apply.test.ts`): - **replay determinism** — same events, same order → deep-equal state; - **duplicate idempotence** — an already-applied `(sourceId, eventId)` with an identical body (content hash, provenance excluded) is a no-op; - **conflict detection** — a same-key body change throws `portfolio.duplicate_event_conflict`; - **ordering** — events fold in array order and must be non-decreasing in `effectiveTimestampMs` (ties keep array order); - **immutability** — neither `previousState` nor any envelope is mutated; the result owns its own frozen tree. ```typescript export declare function applyPortfolioEvents(input: ApplyPortfolioEventsInput): PortfolioState; ``` Example (source JSDoc): ```ts import { applyPortfolioEvents } from '@insiderfinance/totalfinance/portfolio'; const state = applyPortfolioEvents({ portfolio: { baseCurrency: 'USD' }, events }); const next = applyPortfolioEvents({ previousState: state, events: moreEvents }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ApplyPortfolioEventsInput; default: not declared - (input).events: readonly PortfolioEventEnvelope[]; default: not declared - (input).portfolio?: PortfolioDefinition; default: not declared - (input).previousState?: PortfolioState; default: not declared - return.accountMigrations: AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - return.accounts: Record; default: not declared - return.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - return.baseCurrency: string; default: not declared - return.eventCount: number; default: not declared - return.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - return.lastEffectiveTimestampMs: number | null; default: not declared - return.lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - return.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - return.portfolioId?: string; default: not declared - return.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - return.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#compareDisclosedHoldingPartitions Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare supplied reported partitions without treating discretion redistribution as a position change. ```typescript export declare function compareDisclosedHoldingPartitions(input: CompareDisclosedHoldingPartitionsInput): DisclosedHoldingPartitionsReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CompareDisclosedHoldingPartitionsInput; default: not declared - (input).baseline: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsSnapshot; default: not declared - (input).comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - (input).current: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsSnapshot; default: not declared - (input).policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsPolicy; default: not declared - return.assumptions: { changes: string; denominator: string; discretion: string; partitionBasis: string; policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsPolicy; profile: string; rounding: string; }; default: not declared - return.assumptions.changes: string; default: not declared - return.assumptions.denominator: string; default: not declared - return.assumptions.discretion: string; default: not declared - return.assumptions.partitionBasis: string; default: not declared - return.assumptions.policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingPartitionsPolicy; default: not declared — Validated policy used for this report, copied independently of the caller's request. - return.assumptions.profile: string; default: not declared - return.assumptions.rounding: string; default: not declared - return.baseline: DisclosedHoldingPartitionsSnapshotReport; default: not declared - return.changes: DisclosedHoldingPartitionChange[]; default: not declared - return.comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - return.current: DisclosedHoldingPartitionsSnapshotReport; default: not declared - return.diagnostics: { baselineHoldingCount: number; baselinePartitionCount: number; changeCount: number; currentHoldingCount: number; currentPartitionCount: number; status: 'complete' | 'review'; uncomparedPartitionCount: number; warnings: QuantWarning[]; }; default: not declared - return.diagnostics.baselineHoldingCount: number; default: not declared - return.diagnostics.baselinePartitionCount: number; default: not declared - return.diagnostics.changeCount: number; default: not declared - return.diagnostics.currentHoldingCount: number; default: not declared - return.diagnostics.currentPartitionCount: number; default: not declared - return.diagnostics.status: 'complete' | 'review'; default: not declared - return.diagnostics.uncomparedPartitionCount: number; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.policyVersion: 'disclosed-holding-partitions-v1'; default: not declared - return.uncomparedPartitions: DisclosedUncomparedHoldingPartition[]; default: not declared ### @insiderfinance/totalfinance/portfolio#compareDisclosedHoldings Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare supplied reported holdings; exact decimal quantities and values are never inferred trades. A complete supported universe establishes absence; incomplete/unsupported evidence stays visible with withheld deltas or ratios. Source/system cutoffs belong in the caller's artifact envelope. ```typescript export declare function compareDisclosedHoldings(input: CompareDisclosedHoldingsInput): DisclosedHoldingsReport; ``` Example (source JSDoc): compareDisclosedHoldings({ baseline, current, comparisonMode: 'reported-period-change', policy: { supportedProfile: 'common-stock-shares-v1', discretionPolicy: 'sole-without-other-managers', ratioDecimalPlaces: 12 } }) Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CompareDisclosedHoldingsInput; default: not declared - (input).baseline: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsSnapshot; default: not declared - (input).comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - (input).current: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsSnapshot; default: not declared - (input).policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsPolicy; default: not declared - return.assumptions: { changes: string; denominator: string; discretion: string; policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsPolicy; profile: string; rounding: string; }; default: not declared - return.assumptions.changes: string; default: not declared - return.assumptions.denominator: string; default: not declared - return.assumptions.discretion: string; default: not declared - return.assumptions.policy: import('@insiderfinance/totalfinance/portfolio').DisclosedHoldingsPolicy; default: not declared — Validated policy used for this report, copied independently of the caller's request. - return.assumptions.profile: string; default: not declared - return.assumptions.rounding: string; default: not declared - return.baseline: DisclosedHoldingsSnapshotReport; default: not declared - return.changes: DisclosedHoldingChange[]; default: not declared - return.comparisonMode: 'reported-period-change' | 'same-period-revision'; default: not declared - return.current: DisclosedHoldingsSnapshotReport; default: not declared - return.diagnostics: { baselineHoldingCount: number; changeCount: number; currentHoldingCount: number; status: 'complete' | 'review'; warnings: QuantWarning[]; }; default: not declared - return.diagnostics.baselineHoldingCount: number; default: not declared - return.diagnostics.changeCount: number; default: not declared - return.diagnostics.currentHoldingCount: number; default: not declared - return.diagnostics.status: 'complete' | 'review'; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.policyVersion: 'disclosed-holdings-v1'; default: not declared ### @insiderfinance/totalfinance/portfolio#createAuthorizationGrant Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Mint a grant (Decision 5). Refuses a preflight whose decision is `deny` (`trade.preflight_denied`), a plan the preflight did not judge, a portfolio or market hash that differs from the preflight's, an account the plan is not for (`trade.grant_invalid`), an expiry not after `now` (`trade.grant_expired`), and `mode: 'live'` (`trade.live_unavailable`). A `require-approval` preflight carries its scope into the grant; the runtime (slice 4) checks the approver holds it. ```typescript export declare function createAuthorizationGrant(input: CreateAuthorizationGrantInput): AuthorizationGrant; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CreateAuthorizationGrantInput; default: not declared - (input).account?: string; default: not declared — Defaults to the plan's account; given, it must match. - (input).approvedBy: string; default: not declared - (input).expiresAt: number; default: not declared - (input).grantId?: string; default: not declared — Default `grant::`. - (input).idempotencyKeys: string[] | { count: number; prefix: string; }; default: not declared - (input).idempotencyKeys.count: number; default: not declared - (input).idempotencyKeys.prefix: string; default: not declared - (input).marketHash?: string; default: not declared — Defaults to the preflight's; given, it must match. - (input).marketMaximumAgeMs: number; default: not declared - (input).mode: 'paper'; default: not declared - (input).now: number; default: not declared — The issue instant — supplied, never read from a clock. - (input).plan: ExecutionPlan; default: not declared - (input).portfolioHash?: string; default: not declared — Defaults to the preflight's; given, it must match (a grant binds what preflight saw). - (input).preflight: import('@insiderfinance/totalfinance/portfolio').PreflightReport; default: not declared - (input).variance: import('@insiderfinance/totalfinance/portfolio/trade').GrantVariance; default: not declared - return.accountId: string; default: not declared - return.approvedBy: string; default: not declared - return.baseCurrency: string; default: not declared - return.comboIds: string[]; default: not declared — The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. - return.contentHash: string; default: not declared - return.expiresAt: number; default: not declared - return.grantId: string; default: not declared - return.idempotencyKeys: string[]; default: not declared — The closed set of submission keys this grant licenses — one per attempt. - return.issuedAt: number; default: not declared - return.kind: 'totalfinance.authorization-grant'; default: not declared - return.marketAsOf: number; default: not declared — The market instant the preflight judged; execution must not see an older market. - return.marketHash: string; default: not declared - return.marketMaximumAgeMs: number; default: not declared — At execution the market may be at most this old (`now − marketAsOf`). - return.mode: 'paper'; default: not declared - return.orderIds: string[]; default: not declared — The plan's order ids, in plan order. - return.planHash: string; default: not declared - return.portfolioHash: string; default: not declared - return.preflightHash: string; default: not declared - return.requiredScope: string | null; default: not declared — The scope the preflight asked for (`require-approval`), or null when it allowed outright. - return.schemaVersion: 1; default: not declared - return.variance: import('@insiderfinance/totalfinance/portfolio/trade').GrantVariance; default: not declared ### @insiderfinance/totalfinance/portfolio#createModelPortfolio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Freeze a {@link ModelPortfolioDefinition} into an immutable, content-addressed {@link ModelPortfolio} artifact. The definition is fully validated first; the hash covers everything (a changed target is a different model). ```typescript export declare function createModelPortfolio(definition: ModelPortfolioDefinition): ModelPortfolio; ``` Example (source JSDoc): ```ts import { createModelPortfolio } from '@insiderfinance/totalfinance/portfolio/policy'; const model = createModelPortfolio({ modelId: 'balanced', version: 1, baseCurrency: 'USD', strategic: { effectiveFrom: '2026-01-01', targets: [ { group: { tag: 'equity' }, weight: 0.6 }, { group: { tag: 'fixed-income' }, weight: 0.3 }, { group: { assetClass: 'cash' }, weight: 0.1 }, ], }, }); model.contentHash; // 'sha256:…' ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definition): ModelPortfolioDefinition; default: not declared - (definition).baseCurrency: string; default: not declared - (definition).benchmark?: BenchmarkIdentity; default: not declared - (definition).glidePath?: GlidePath; default: not declared - (definition).horizonEndDate?: string | number; default: not declared - (definition).liabilities?: LiabilitySchedule; default: not declared - (definition).modelId: string; default: not declared - (definition).note?: string; default: not declared - (definition).sleeves?: ModelSleeve[]; default: not declared - (definition).strategic: TargetSet; default: not declared - (definition).tactical?: TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - (definition).version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. - return.baseCurrency: string; default: not declared - return.benchmark?: BenchmarkIdentity; default: not declared - return.contentHash: string; default: not declared — `sha256:` over the canonical definition (kind and schemaVersion included). - return.glidePath?: GlidePath; default: not declared - return.horizonEndDate?: string | number; default: not declared - return.kind: 'totalfinance.model-portfolio'; default: not declared - return.liabilities?: LiabilitySchedule; default: not declared - return.modelId: string; default: not declared - return.note?: string; default: not declared - return.schemaVersion: number; default: not declared - return.sleeves?: ModelSleeve[]; default: not declared - return.strategic: TargetSet; default: not declared - return.tactical?: TargetSet[]; default: not declared — Dated complete overrides; the latest set effective at `asOf` wins. - return.version: number; default: not declared — Safe integer ≥ 1 — a changed model is a new version, never an edit in place. ### @insiderfinance/totalfinance/portfolio#createPortfolioLedger Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the immutable ledger artifact from a definition and its economic events. Validates every envelope, folds the state through `applyPortfolioEvents` (the ONE reducer — no second engine), and returns a frozen artifact whose serialized form rides the Gate B spine. ```typescript export declare function createPortfolioLedger(input: CreatePortfolioLedgerInput): PortfolioLedger; ``` Example (source JSDoc): ```ts import { createPortfolioLedger, readPortfolioLedgerSnapshot } from '@insiderfinance/totalfinance/portfolio'; const ledger = createPortfolioLedger({ portfolioId: 'primary', baseCurrency: 'USD', events }); const nextLedger = ledger.apply(moreEvents); // NEW artifact; `ledger` is untouched const stored = JSON.stringify(nextLedger); // the versioned envelope const { ledger: restored } = readPortfolioLedgerSnapshot({ snapshot: JSON.parse(stored) }); // restored.state deep-equals nextLedger.state — replay IS the deserializer ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CreatePortfolioLedgerInput; default: not declared - (input).baseCurrency: string; default: not declared - (input).events: readonly PortfolioEventEnvelope[]; default: not declared - (input).lotRelief?: LotReliefPolicy; default: not declared — Defaults to `'fifo'`; echoed on the artifact, the state, and every serialized envelope. - (input).portfolioId?: string; default: not declared - (input).provenance?: Provenance; default: not declared - return.apply: (events: readonly PortfolioEventEnvelope[]) => PortfolioLedger; default: not declared — Fold more events and return a NEW immutable ledger; this one is untouched. - return.baseCurrency: string; default: not declared - return.events: readonly PortfolioEventEnvelope[]; default: not declared — The applied economic events, canonical and frozen. Identical no-op replays are not stored. - return.lotRelief: LotReliefPolicy; default: not declared - return.pnl: (input: Omit) => PortfolioPnlResult; default: not declared — `portfolioPnl` over this ledger (slice 2; the agent-native API ladder's `ledger.pnl`). - return.portfolioId?: string; default: not declared - return.provenance?: Provenance; default: not declared - return.state: PortfolioState; default: not declared — The derived state — the fold of `events` under `lotRelief`. - return.timeline: (input: Omit) => PortfolioTimelineResult; default: not declared — `portfolioTimeline` over this ledger (slice 2). - return.toJSON: () => PortfolioLedgerSnapshot; default: not declared — The serialized envelope (also what `JSON.stringify(ledger)` emits). ### @insiderfinance/totalfinance/portfolio#duplicateBoundaryKey Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `(sourceId, eventId)` duplicate-boundary key — the exact registry key `PortfolioState` records under `appliedEvents`, exposed so stores and importers can pre-check delivery without re-deriving the encoding. ```typescript export declare function duplicateBoundaryKey(envelope: PortfolioEventEnvelope): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (envelope): PortfolioEventEnvelope; default: not declared - (envelope).accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - (envelope).causationId?: string; default: not declared - (envelope).correlationId?: string; default: not declared - (envelope).effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - (envelope).event: PortfolioEvent; default: not declared - (envelope).eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - (envelope).eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - (envelope).provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - (envelope).recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - (envelope).reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - (envelope).schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - (envelope).sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). ### @insiderfinance/totalfinance/portfolio#isModelPortfolio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether a value is a structurally valid, untampered model artifact (a predicate: never throws). ```typescript export declare function isModelPortfolio(value: unknown): value is ModelPortfolio; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/portfolio#isPortfolioLedgerSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Structural test for a (current-version) serialized ledger envelope. ```typescript export declare function isPortfolioLedgerSnapshot(value: unknown): value is PortfolioLedgerSnapshot; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/portfolio#mergeTradePolicies Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The stricter of every policy given: the minimum of each bound, the intersection of each allow list, the stricter unverifiable handling. ```typescript export declare function mergeTradePolicies(input: MergeTradePoliciesInput): TradePolicy; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MergeTradePoliciesInput; default: not declared - (input).policies: readonly TradePolicy[]; default: not declared - return.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a plan that leaves an option net short (a call uncovered) is denied. - return.allowedAccounts?: string[]; default: not declared - return.allowedAssetClasses?: string[]; default: not declared - return.allowedInstruments?: string[]; default: not declared - return.allowedOrderTypes?: OrderType[]; default: not declared - return.limits?: PolicyLimits; default: not declared - return.marketMaximumAgeMs?: number; default: not declared - return.maximumEstimatedCost?: number; default: not declared — Base currency, the plan's total estimated commission + spread + slippage. - return.maximumOrderNotional?: number; default: not declared - return.maximumOrderQuantity?: number; default: not declared - return.maximumParticipation?: number; default: not declared - return.maximumSlippageBps?: number; default: not declared - return.maximumTurnover?: number; default: not declared — Traded notional ÷ NAV before the plan. - return.mode: 'paper'; default: not declared — The only mode this stage accepts; `'live'` is a typed refusal naming AT8. - return.onUnverifiable?: 'require-approval' | 'deny'; default: not declared — What an unverifiable check does to the decision (default `'require-approval'`). - return.requireApprovalAbove?: { notional?: number; quantity?: number; }; default: not declared — Above either bound the decision is `require-approval` rather than `allow`. - return.requireApprovalAbove.notional?: number; default: not declared - return.requireApprovalAbove.quantity?: number; default: not declared ### @insiderfinance/totalfinance/portfolio#monitorPortfolio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate one explicit valuation against the policy and the prior monitor state — see the module comment for the decisions. Pure: same inputs, same alerts and state. ```typescript export declare function monitorPortfolio(input: MonitorPortfolioInput): MonitorPortfolioResult; ``` Example (source JSDoc): ```ts import { monitorPortfolio } from '@insiderfinance/totalfinance/portfolio/policy'; const first = monitorPortfolio({ portfolio: ledger.state, market, asOf: '2026-08-20', policy: { limits: { maximumPositionWeight: 0.25, maximumDrawdown: 0.1 } }, previousState: null, }); const next = monitorPortfolio({ ...sameInputs, asOf: '2026-08-21', previousState: first.state }); next.alerts; // [{ key: 'concentration-limit:AAPL', state: 'raised', value: 0.31, threshold: 0.25, … }] ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MonitorPortfolioInput; default: not declared - (input).acknowledgments?: string[]; default: not declared — Alert keys the host acknowledged since `previousState`. - (input).asOf: string | number; default: not declared — The evaluation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. - (input).assignmentRiskMoneyness?: number; default: not declared — Moneyness (a decimal of the strike; positive = in the money) above which a SHORT option is at risk of assignment — the `assignment-risk` family's bound. A negative value alerts while still out of the money. Skipped without one (or a rule threshold). - (input).averageDailyVolumes?: Record; default: not declared — Units per day per instrument — the liquidity family's denominator. - (input).currencyConversions?: CurrencyPairQuote[]; default: not declared - (input).instrumentClassification?: Record; default: not declared - (input).market: MarketSnapshot; default: not declared - (input).marketStalenessLimitMs?: number; default: not declared — A mark observed before `asOf − marketStalenessLimitMs` is stale. - (input).optionExpirationWarningDays?: number; default: not declared — Days to expiry (≥ 0) at or below which an option position is near expiry — the `option-expiration` family's bound (direction below). Skipped without one (or a rule threshold). - (input).pnl?: PortfolioPnlResult; default: not declared - (input).policy: InvestmentPolicy; default: not declared - (input).portfolio: PortfolioState; default: not declared - (input).previousState: PortfolioMonitorState | null; default: not declared — REQUIRED: the prior evaluation's `state`, or `null` for the first evaluation. - (input).previousState.asOf: number; default: not declared - (input).previousState.evaluationCount: number; default: not declared - (input).previousState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - (input).previousState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - (input).previousState.rules: Record; default: not declared - (input).previousState.schemaVersion: number; default: not declared - (input).reconciliation?: ReconcilePortfolioResult; default: not declared - (input).residualTolerance?: number; default: not declared — Base-currency amount above which `|pnl.residual|` is unexplained. - (input).rules?: Partial>; default: not declared - (input).unusualPnlThreshold?: number; default: not declared — Decimal of NAV above which `|pnl.components.totalPnl| ÷ NAV` is unusual. - return.alerts: MonitorAlert[]; default: not declared — Raised / active / acknowledged / suppressed / cleared entries only, sorted by key. - return.asOf: number; default: not declared - return.assumptions: { conventions: string; conventionsVersion: string; liquidityParticipationRate: number; rulesApplied: Record; }; default: not declared - return.assumptions.conventions: string; default: not declared — Prose statement of every convention. String-typed by design. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.liquidityParticipationRate: number; default: not declared - return.assumptions.rulesApplied: Record; default: not declared - return.baseCurrency: string; default: not declared - return.diagnostics: { acknowledgedCount: number; activeCount: number; clearedCount: number; raisedCount: number; suppressedCount: number; unsupportedFamilies: { family: MonitorDeferredFamily; reason: string; }[]; warnings: string[]; }; default: not declared - return.diagnostics.acknowledgedCount: number; default: not declared - return.diagnostics.activeCount: number; default: not declared — Rules active AFTER this evaluation (raised, active, acknowledged, and carried-forward). - return.diagnostics.clearedCount: number; default: not declared - return.diagnostics.raisedCount: number; default: not declared - return.diagnostics.suppressedCount: number; default: not declared - return.diagnostics.unsupportedFamilies: { family: MonitorDeferredFamily; reason: string; }[]; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.evaluated: MonitorFamilyEvaluation[]; default: not declared — One row per family, in the family order. - return.netAssetValue: number | null; default: not declared - return.state: PortfolioMonitorState; default: not declared ### @insiderfinance/totalfinance/portfolio#normalizeTradePlan Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function normalizeTradePlan(input: NormalizeTradePlanInput): ExecutionPlan; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NormalizeTradePlanInput; default: not declared - (input).accountId?: string; default: not declared - (input).asOf: string | number; default: not declared - (input).currencyConversions?: CurrencyPairQuote[]; default: not declared - (input).evidence?: string[]; default: not declared - (input).instruments?: Record; default: not declared - (input).intent?: import('@insiderfinance/totalfinance/portfolio').TradeIntent; default: not declared - (input).market: MarketSnapshot; default: not declared - (input).portfolio: PortfolioState; default: not declared - (input).proposal?: TradePlanArtifact; default: not declared - (input).rationale?: string; default: not declared - return.accountId: string; default: not declared - return.asOf: number; default: not declared - return.baseCurrency: string; default: not declared - return.combos: ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - return.contentHash: string; default: not declared - return.evidence: string[]; default: not declared - return.kind: 'totalfinance.execution-plan'; default: not declared - return.orders: TradeOrder[]; default: not declared - return.portfolioId?: string; default: not declared - return.rationale?: string; default: not declared - return.schemaVersion: number; default: not declared - return.source: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanSource; default: not declared - return.trades: TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. ### @insiderfinance/totalfinance/portfolio#portfolioEventContentHash Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The event's content identity and the CONFLICT boundary for duplicate `(sourceId, eventId)` delivery: the `sha256:` content hash (Gate B canonical JSON) of the envelope EXCLUDING `provenance` — two deliveries of the same economic fact under different source labels are the SAME event (Gate B Decision 3: provenance is outside every identity). The envelope is fully validated first; a malformed envelope never acquires a confident-looking hash. ```typescript export declare function portfolioEventContentHash(envelope: PortfolioEventEnvelope): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (envelope): PortfolioEventEnvelope; default: not declared - (envelope).accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - (envelope).causationId?: string; default: not declared - (envelope).correlationId?: string; default: not declared - (envelope).effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - (envelope).event: PortfolioEvent; default: not declared - (envelope).eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - (envelope).eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - (envelope).provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - (envelope).recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - (envelope).reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - (envelope).schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - (envelope).sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). ### @insiderfinance/totalfinance/portfolio#portfolioEventsFromFill Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Map one {@link NormalizedFill} to the economic events the ledger folds: exactly one `trade.fill` (id = `fillId`) followed by one `cost.charge` per non-zero cost component (id = `:cost:`, `relatesToEventId` = the fill), in the fixed order commission → exchange fees → regulatory fees → slippage adjustment. The mapping is deterministic and the ids are derived from the fill, so an identical fill delivered twice folds once (the ledger's duplicate boundary) and a replay emits identical envelopes. Every envelope passes the same validator a hand-written one would. ```typescript export declare function portfolioEventsFromFill(input: PortfolioEventsFromFillInput): PortfolioEventEnvelope[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioEventsFromFillInput; default: not declared - (input).fill: NormalizedFill; default: not declared - (input).provenance?: Provenance; default: not declared — Where the fill came from; `{}` when there is no further detail. Outside the event identity. - (input).recordedTimestampMs: number; default: not declared — When the events are recorded — supplied, never read from a clock. - (input).sourceId: string; default: not declared — The system that produced the fill — `'backtest:'`, a broker import id, a paper account. ### @insiderfinance/totalfinance/portfolio#portfolioLedgerContentHash Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The ledger's content identity: `sha256:` over the canonical envelope with `provenance` removed at BOTH levels — the ledger's own and every event's (Gate B Decision 3: identical economic facts from two vendors are the SAME ledger; dedup and replay comparison depend on that). `baseCurrency` and `lotRelief` ARE covered: they change the derived economics, so two ledgers differing only in relief policy must never collide. The envelope is fully validated through the read path first — a malformed envelope never acquires a confident-looking hash (the Gate B serial-landing lesson) — and identity is defined over the CURRENT grammar: hash an older stored version by reading it with its registered migrations and hashing `ledger.toJSON()`. ```typescript export declare function portfolioLedgerContentHash(snapshot: PortfolioLedgerSnapshot): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (snapshot): PortfolioLedgerSnapshot; default: not declared - (snapshot).baseCurrency: string; default: not declared - (snapshot).events: PortfolioEventEnvelope[]; default: not declared - (snapshot).kind: 'totalfinance.portfolio-ledger'; default: not declared - (snapshot).lotRelief: LotReliefPolicy; default: not declared — The lot-relief policy the fold runs under — INSIDE the content identity (it changes P&L). - (snapshot).portfolioId?: string; default: not declared - (snapshot).provenance?: Provenance; default: not declared — Ledger-level provenance — caller-supplied, preserved, OUTSIDE the content identity. - (snapshot).schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio#portfolioPerformanceInputs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Derive the EXACT `valuations` + `externalCashFlows` series FC4's flow-aware calls consume, from a ledger and explicit per-date marks. The identity test in `test/performance-seam.test.ts` proves ledger-derived series → `timeWeightedReturn`/`moneyWeightedReturn` equal the same FC4 calls on hand-built series (the FC7 exit-gate hook, closed in this slice). ```typescript export declare function portfolioPerformanceInputs(input: PortfolioPerformanceInputsInput): PortfolioPerformanceInputsResult; ``` Example (source JSDoc): ```ts import { timeWeightedReturn } from '@insiderfinance/totalfinance/performance'; import { portfolioPerformanceInputs } from '@insiderfinance/totalfinance/portfolio/performance'; const series = portfolioPerformanceInputs({ ledger, valuationMarks }); const twr = timeWeightedReturn({ valuations: series.valuations, externalCashFlows: series.externalCashFlows, flowTiming: 'at-flow-timestamp', annualization: 'none', }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioPerformanceInputsInput; default: not declared - (input).ledger: PortfolioLedger; default: not declared - (input).valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date — a return is measured BETWEEN valuations. - return.assumptions: { conventionsVersion: string; flowMapping: string; markInstant: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.flowMapping: string; default: not declared — Prose statement of which events are external flows and how they convert. - return.assumptions.markInstant: string; default: not declared — Prose statement of the mark instant and its agreement with FC4's flow convention. - return.diagnostics: { excludedFlowCount: number; flowCount: number; markCount: number; warnings: string[]; }; default: not declared - return.diagnostics.excludedFlowCount: number; default: not declared — Deposits/withdrawals outside the [first, last] mark window — excluded, disclosed. - return.diagnostics.flowCount: number; default: not declared - return.diagnostics.markCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.externalCashFlows: ExternalCashFlow[]; default: not declared — Feed directly as `externalCashFlows`; `label` carries the source `eventId`. - return.valuations: PortfolioValuation[]; default: not declared — Feed directly to `timeWeightedReturn` / `moneyWeightedReturn` as `valuations`. ### @insiderfinance/totalfinance/portfolio#portfolioPnl Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reconciled P&L between two valuation marks — see the module comment for the identity and the conversion convention. Never mutates the ledger; every number is base currency unless the row says otherwise. ```typescript export declare function portfolioPnl(input: PortfolioPnlInput): PortfolioPnlResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioPnlInput; default: not declared - (input).from: PortfolioValuationMark; default: not declared - (input).instrumentClassification?: Record; default: not declared - (input).ledger: PortfolioLedger; default: not declared - (input).to: PortfolioValuationMark; default: not declared - return.assumptions: { conventionsVersion: string; conversionConvention: string; identity: string; lotRelief: LotReliefPolicy; residualTolerance: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.conversionConvention: string; default: not declared — The conversion convention, stated. - return.assumptions.identity: string; default: not declared — The identity, stated. - return.assumptions.lotRelief: LotReliefPolicy; default: not declared - return.assumptions.residualTolerance: number; default: not declared - return.baseCurrency: string; default: not declared - return.byCurrency: PortfolioPnlCurrencyRow[]; default: not declared - return.components: PortfolioPnlComponents; default: not declared — The explained decomposition; `components.totalPnl + residual === investmentReturn`. - return.diagnostics: { eventCount: number; residualWithinTolerance: boolean; warnings: string[]; }; default: not declared - return.diagnostics.eventCount: number; default: not declared — Events with `from ≤ effectiveTimestampMs < to`. - return.diagnostics.residualWithinTolerance: boolean; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.externalFlows: number; default: not declared — Deposits − withdrawals over the window, in base currency at closing quotes. - return.from: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - return.from.asOf: number; default: not declared - return.from.netAssetValue: number; default: not declared - return.from.valuationDate: string; default: not declared - return.groupings: PortfolioPnlGrouping[]; default: not declared - return.investmentReturn: number; default: not declared — `netAssetValueChange − externalFlows` — the investment return the components explain. - return.netAssetValueChange: number; default: not declared — `to.netAssetValue − from.netAssetValue`. - return.residual: number; default: not declared — `investmentReturn − components.totalPnl` — float rounding by construction; larger is warned. - return.to: { asOf: EpochMs; netAssetValue: number; valuationDate: string; }; default: not declared - return.to.asOf: number; default: not declared - return.to.netAssetValue: number; default: not declared - return.to.valuationDate: string; default: not declared ### @insiderfinance/totalfinance/portfolio#portfolioSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Value a portfolio state against an explicit market snapshot at an explicit instant. ```typescript export declare function portfolioSnapshot(input: PortfolioSnapshotInput): PortfolioSnapshotResult; ``` Example (source JSDoc): ```ts import { createMarketSnapshot } from '@insiderfinance/totalfinance/core/artifacts'; import { applyPortfolioEvents, portfolioSnapshot } from '@insiderfinance/totalfinance/portfolio'; const state = applyPortfolioEvents({ portfolio: { baseCurrency: 'USD' }, events }); const market = createMarketSnapshot({ asOf: '2026-08-20', observations: { spots: { AAPL: { price: 232.5, currency: 'USD' } } }, }); const valued = portfolioSnapshot({ portfolio: state, asOf: '2026-08-20', market }); valued.netAssetValue; // cash + positions, in USD ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioSnapshotInput; default: not declared - (input).asOf: string | number; default: not declared — The valuation instant: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime. - (input).currencyConversions?: CurrencyPairQuote[]; default: not declared — Explicit valuation-time exchange-rate quotes (FC5 vocabulary), one per currency pair, in either orientation. Required exactly when the portfolio holds cash or positions outside its base currency. - (input).market: MarketSnapshot; default: not declared — The Gate B market snapshot supplying instrument marks. - (input).portfolio: PortfolioState; default: not declared — A derived {@link PortfolioState} (from `applyPortfolioEvents` or `ledger.state`). - return.asOf: number; default: not declared - return.assumptions: { conventionsVersion: string; currencyConversionsUsed: CurrencyPairQuote[]; lotRelief: LotReliefPolicy; marketAsOf: EpochMs; valuationConvention: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.currencyConversionsUsed: CurrencyPairQuote[]; default: not declared — The exchange-rate quotes actually used, echoed verbatim. - return.assumptions.lotRelief: LotReliefPolicy; default: not declared — The relief policy behind every realized figure in the underlying state — echoed. - return.assumptions.marketAsOf: number; default: not declared — The market snapshot's own instant — a warning discloses any mismatch with `asOf`. - return.assumptions.valuationConvention: string; default: not declared — Prose statement of the valuation convention. String-typed by design. - return.baseCurrency: string; default: not declared - return.cash: PortfolioSnapshotCashRow[]; default: not declared — Sorted by (accountId, currency) — deterministic. - return.diagnostics: { accountCount: number; positionCount: number; warnings: string[]; }; default: not declared - return.diagnostics.accountCount: number; default: not declared - return.diagnostics.positionCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.netAssetValue: number; default: not declared — `totalCashBaseCurrencyValue + totalPositionsBaseCurrencyValue` (the tested identity). - return.positions: PortfolioSnapshotPosition[]; default: not declared — Sorted by (accountId, instrumentId) — deterministic. - return.totalCashBaseCurrencyValue: number; default: not declared - return.totalPositionsBaseCurrencyValue: number; default: not declared ### @insiderfinance/totalfinance/portfolio#portfolioTimeline Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). NAV, cash, flows, exposure, drawdown, and P&L components through time — see the module comment. ```typescript export declare function portfolioTimeline(input: PortfolioTimelineInput): PortfolioTimelineResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioTimelineInput; default: not declared - (input).instrumentClassification?: Record; default: not declared - (input).ledger: PortfolioLedger; default: not declared - (input).valuationMarks: readonly PortfolioValuationMark[]; default: not declared — At least two marks, strictly ascending by date. - return.assumptions: { conventionsVersion: string; exposureConvention: string; indexConvention: string; lotRelief: LotReliefPolicy; markInstant: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.exposureConvention: string; default: not declared - return.assumptions.indexConvention: string; default: not declared - return.assumptions.lotRelief: LotReliefPolicy; default: not declared - return.assumptions.markInstant: string; default: not declared - return.baseCurrency: string; default: not declared - return.cumulativePnl: PortfolioPnlComponents & { residual: number; }; default: not declared — `Σ rows.pnlSincePrior` per component. `totalPnl` equals `portfolioPnl(first, last)`'s investment return exactly; individual components equal it only when every currency is the base — otherwise each step's closing-quote translation moves value between a component and `foreignExchangePnl` (path-dependent attribution, stated in `assumptions.markInstant`). - return.cumulativePnl.financing: number; default: not declared - return.cumulativePnl.foreignExchangePnl: number; default: not declared - return.cumulativePnl.income: number; default: not declared - return.cumulativePnl.realizedPnl: number; default: not declared - return.cumulativePnl.residual: number; default: not declared - return.cumulativePnl.totalPnl: number; default: not declared - return.cumulativePnl.transactionCosts: number; default: not declared - return.cumulativePnl.unrealizedPnl: number; default: not declared - return.diagnostics: { gaps: PerformanceGap[]; indexWithheldReason?: string; markCount: number; warnings: string[]; }; default: not declared - return.diagnostics.gaps: PerformanceGap[]; default: not declared - return.diagnostics.indexWithheldReason?: string; default: not declared — Why the index (and drawdown) is null, when it is. - return.diagnostics.markCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.externalCashFlows: ExternalCashFlow[]; default: not declared - return.maxDrawdown: number | null; default: not declared — Worst drawdown from the index, `null` when the index is withheld. - return.rows: PortfolioTimelineRow[]; default: not declared - return.valuations: PortfolioValuation[]; default: not declared — The exact FC4 series behind the index — feed straight to timeWeightedReturn / moneyWeightedReturn. ### @insiderfinance/totalfinance/portfolio#preflightTradePlan Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function preflightTradePlan(input: PreflightTradePlanInput): PreflightReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PreflightTradePlanInput; default: not declared - (input).asOf: string | number; default: not declared - (input).averageDailyVolumes?: Record; default: not declared - (input).costs?: PreflightCostRates; default: not declared - (input).currencyConversions?: CurrencyPairQuote[]; default: not declared - (input).instruments?: Record; default: not declared - (input).market: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshot; default: not declared - (input).monitorState?: PortfolioMonitorState | null; default: not declared — The monitor state carried from the previous evaluation, when the caller keeps one. - (input).monitorState.asOf: number; default: not declared - (input).monitorState.evaluationCount: number; default: not declared - (input).monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - (input).monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - (input).monitorState.rules: Record; default: not declared - (input).monitorState.schemaVersion: number; default: not declared - (input).openOrders?: TradeOrder[]; default: not declared — Orders already open in the journal; a plan that repeats one is a conflict. - (input).plan: import('@insiderfinance/totalfinance/portfolio').ExecutionPlan; default: not declared - (input).policy: import('@insiderfinance/totalfinance/portfolio').TradePolicy; default: not declared - (input).portfolio: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - (input).session?: import('@insiderfinance/totalfinance/portfolio/trade').PreflightSession; default: not declared - return.after: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared - return.alerts: MonitorAlert[]; default: not declared - return.asOf: number; default: not declared - return.assumptions: { conventionsVersion: string; costRates: Required; decisionConvention: string; fillConvention: string; instrumentSources: Record; mode: 'paper'; policyContentHash: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.costRates: Required; default: not declared - return.assumptions.costRates.commissionBps: number; default: not declared - return.assumptions.costRates.commissionPerOrder: number; default: not declared - return.assumptions.costRates.slippageBps: number; default: not declared - return.assumptions.costRates.spreadBps: number; default: not declared - return.assumptions.decisionConvention: string; default: not declared - return.assumptions.fillConvention: string; default: not declared - return.assumptions.instrumentSources: Record; default: not declared — Where each instrument's currency and multiplier came from: the ledger position, the caller's description, or the market spot (priced as a plain cash instrument). - return.assumptions.mode: 'paper'; default: not declared - return.assumptions.policyContentHash: string; default: not declared - return.before: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared - return.checks: PolicyCheck[]; default: not declared - return.contentHash: string; default: not declared - return.decision: import('@insiderfinance/totalfinance/portfolio').PolicyDecision; default: not declared - return.diagnostics: { checkCount: number; converged: true; engine: 'trade-preflight'; failedCount: number; method: 'hypothetical-fold'; unverifiableCount: number; warnings: QuantWarning[]; }; default: not declared - return.diagnostics.checkCount: number; default: not declared - return.diagnostics.converged: true; default: not declared - return.diagnostics.engine: 'trade-preflight'; default: not declared - return.diagnostics.failedCount: number; default: not declared - return.diagnostics.method: 'hypothetical-fold'; default: not declared - return.diagnostics.unverifiableCount: number; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.estimates: import('@insiderfinance/totalfinance/portfolio/trade').PreflightEstimates; default: not declared - return.hypotheticalEvents: PortfolioEventEnvelope[]; default: not declared - return.hypotheticalFills: NormalizedFill[]; default: not declared — The hypothetical fills the after-state was folded from. - return.kind: 'totalfinance.preflight-report'; default: not declared - return.marketAsOf: number; default: not declared - return.marketHash: string; default: not declared - return.monitorState: PortfolioMonitorState | null; default: not declared - return.monitorState.asOf: number; default: not declared - return.monitorState.evaluationCount: number; default: not declared - return.monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - return.monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - return.monitorState.rules: Record; default: not declared - return.monitorState.schemaVersion: number; default: not declared - return.planHash: string; default: not declared - return.portfolioHash: string; default: not declared - return.schemaVersion: number; default: not declared - return.unverifiable: string[]; default: not declared ### @insiderfinance/totalfinance/portfolio#proposePortfolioRebalance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Propose a rebalance of the ledger's managed book toward the policy's targets at `asOf` — a plan, never an execution. See the module comment for the laws and the accepted example. ```typescript export declare function proposePortfolioRebalance(input: ProposePortfolioRebalanceInput): ProposePortfolioRebalanceResult; ``` Example (source JSDoc): ```ts import { createMarketSnapshot } from '@insiderfinance/totalfinance/core/artifacts'; import { proposePortfolioRebalance } from '@insiderfinance/totalfinance/portfolio/policy'; const proposal = proposePortfolioRebalance({ portfolio: ledger.state, market: createMarketSnapshot({ asOf: '2026-08-29', observations: { spots: { SPY: { price: 120, currency: 'USD' }, AGG: { price: 100, currency: 'USD' } } } }), asOf: '2026-08-29', scope: 'drift-only', policy: { targets: [ { group: { tag: 'equity' }, weight: 0.6 }, { group: { tag: 'fixed-income' }, weight: 0.3 }, { group: { assetClass: 'cash' }, weight: 0.1 }, ], driftBand: 0.03, maximumTurnover: 0.15, minimumCash: 5_000, }, instrumentClassification: { SPY: { tags: ['equity'] }, AGG: { tags: ['fixed-income'] } }, defaultLotSize: 1, }); proposal.trades; // sell SPY, buy AGG — only what is outside the 3% band proposal.plan.contentHash; // 'sha256:…' — a normalized plan for preflight ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ProposePortfolioRebalanceInput; default: not declared - (input).asOf: string | number; default: not declared - (input).averageDailyVolumes?: Record; default: not declared — Units per day; with `limits.maximumDaysToLiquidate`, days = |post-trade quantity| ÷ (volume × 0.1). - (input).currencyConversions?: CurrencyPairQuote[]; default: not declared - (input).defaultLotSize?: number; default: not declared — Lot size for instruments without a `lotSizes` row; when neither covers an instrument its quantity stays fractional. - (input).externalFlow?: ExternalFlow; default: not declared - (input).instrumentClassification?: Record; default: not declared - (input).lotSizes?: Record; default: not declared — Lot size per instrument (> 0, finite). - (input).market: MarketSnapshot; default: not declared — Marks come from `observations.spots` through `portfolioSnapshot`. - (input).minimumNotional?: number; default: not declared — Base-currency notional below which a trade is dust (skipped and reported). - (input).policy: InvestmentPolicy; default: not declared - (input).portfolio: PortfolioState; default: not declared - (input).scope: RebalanceScope; default: not declared - (input).tradingAccountId?: string; default: not declared — Where BUYS book. REQUIRED when more than one allowed account; with exactly one it is that account. - (input).transactionCosts?: import('@insiderfinance/totalfinance/portfolio').AllocationTransactionCosts; default: not declared - return.asOf: number; default: not declared - return.assumptions: { conventions: string; conventionsVersion: string; costModel: string; flowHandling: string; liquidityParticipationRate: number; lotRelief: LotReliefPolicy; rounding: string; scope: RebalanceScope; targetSource: ResolvedTargetSource; }; default: not declared - return.assumptions.conventions: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.costModel: string; default: not declared - return.assumptions.flowHandling: string; default: not declared - return.assumptions.liquidityParticipationRate: number; default: not declared - return.assumptions.lotRelief: LotReliefPolicy; default: not declared - return.assumptions.rounding: string; default: not declared - return.assumptions.scope: RebalanceScope; default: not declared - return.assumptions.targetSource: ResolvedTargetSource; default: not declared - return.baseCurrency: string; default: not declared - return.cash: RebalanceCashSummary; default: not declared - return.convergence: { converged: boolean; iterations: number; }; default: not declared - return.convergence.converged: boolean; default: not declared - return.convergence.iterations: number; default: not declared - return.diagnostics: { accountsConsidered: string[]; accountsExcluded: string[]; dustCount: number; tradeCount: number; warnings: string[]; }; default: not declared - return.diagnostics.accountsConsidered: string[]; default: not declared - return.diagnostics.accountsExcluded: string[]; default: not declared - return.diagnostics.dustCount: number; default: not declared - return.diagnostics.tradeCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.dust: RebalanceDustSummary; default: not declared - return.estimates: RebalanceEstimates; default: not declared - return.feasible: boolean; default: not declared - return.netAssetValue: number; default: not declared — The managed (allowed-account) NAV before the flow. - return.netAssetValueAfterFlow: number; default: not declared - return.objective: { after: RebalanceObjectivePoint; before: RebalanceObjectivePoint; convention: string; }; default: not declared - return.objective.after: RebalanceObjectivePoint; default: not declared - return.objective.before: RebalanceObjectivePoint; default: not declared - return.objective.convention: string; default: not declared - return.plan: TradePlanArtifact; default: not declared - return.risk: { after: RebalanceRiskPoint; before: RebalanceRiskPoint; }; default: not declared - return.risk.after: RebalanceRiskPoint; default: not declared - return.risk.before: RebalanceRiskPoint; default: not declared - return.trades: RebalanceTrade[]; default: not declared — Sorted by (instrumentId, accountId). - return.unresolvedConstraints: UnresolvedConstraint[]; default: not declared - return.unresolvedTargets: UnresolvedTarget[]; default: not declared - return.weights: { cash: RebalanceCashWeight; groups: RebalanceGroupWeight[]; instruments: RebalanceInstrumentWeight[]; }; default: not declared - return.weights.cash: RebalanceCashWeight; default: not declared - return.weights.groups: RebalanceGroupWeight[]; default: not declared - return.weights.instruments: RebalanceInstrumentWeight[]; default: not declared ### @insiderfinance/totalfinance/portfolio#readPortfolioLedgerSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The ONE door back in for stored ledgers: validates the envelope (closed key set, kind, version) BEFORE reading any event, applies explicitly registered migrations for older versions, refuses newer versions, then restores by RE-FOLDING the events through `createPortfolioLedger` — full re-validation and deterministic replay in one step — and reports the exact migrations applied. ```typescript export declare function readPortfolioLedgerSnapshot(input: ReadPortfolioLedgerSnapshotInput): { ledger: PortfolioLedger; migrationsApplied: AppliedMigration[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ReadPortfolioLedgerSnapshotInput; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared — Explicitly registered migrations for OLDER stored versions — never module-global state. - (input).snapshot: unknown; default: not declared - return.ledger: PortfolioLedger; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared ### @insiderfinance/totalfinance/portfolio#reconcileExecution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reconcile an execution (Decision 8). Pure: the journal (events or a folded state), the ledger, the fills, and the optional external snapshot are inputs; the tolerance is explicit; the result is a content-addressed `totalfinance.reconciliation-report`. ```typescript export declare function reconcileExecution(input: ReconcileExecutionInput): ReconciliationReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ReconcileExecutionInput; default: not declared - (input).asOf: string | number; default: not declared - (input).external?: import('@insiderfinance/totalfinance/portfolio').ExternalPortfolioSnapshot; default: not declared - (input).fills: readonly NormalizedFill[]; default: not declared — The execution's fills as delivered. - (input).journal: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[] | ExecutionJournalState; default: not declared — The journal's events (folded here) or an already-folded state. - (input).journal.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - (input).journal.eventCount: number; default: not declared - (input).journal.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - (input).journal.journalId: string | null; default: not declared — Null until the first event. - (input).journal.orders: Record; default: not declared - (input).journal.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. - (input).ledger: import('@insiderfinance/totalfinance/portfolio').PortfolioState; default: not declared - (input).planHash?: string; default: not declared — Exclude other plans' journaled orders and fills; unattributed source fills remain discrepancies. - (input).sourceId: string; default: not declared — The `sourceId` the execution's fills were folded into the ledger under. - (input).tolerance: ReconciliationTolerance; default: not declared — Explicit — reconciliation never assumes a tolerance. - return.asOf: number; default: not declared - return.assumptions: { conventionsVersion: string; matchConvention: string; tolerance: Required; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.matchConvention: string; default: not declared - return.assumptions.tolerance: Required; default: not declared - return.assumptions.tolerance.cashAmount: number; default: not declared - return.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - return.assumptions.tolerance.quantity: number; default: not declared - return.contentHash: string; default: not declared - return.diagnostics: { differenceCount: number; engine: 'trade-reconciliation'; fillCount: number; ledgerFillCount: number; openCount: number; orderCount: number; unresolvedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.differenceCount: number; default: not declared - return.diagnostics.engine: 'trade-reconciliation'; default: not declared - return.diagnostics.fillCount: number; default: not declared - return.diagnostics.ledgerFillCount: number; default: not declared - return.diagnostics.openCount: number; default: not declared - return.diagnostics.orderCount: number; default: not declared - return.diagnostics.unresolvedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.fills: ReconciliationFillMatch[]; default: not declared - return.journalId: string | null; default: not declared - return.journaledNotInLedger: string[]; default: not declared — Journaled fill ids with no `trade.fill` under the source in the ledger. - return.kind: 'totalfinance.reconciliation-report'; default: not declared - return.ledgerNotJournaled: string[]; default: not declared — Ledger `trade.fill` ids under the source that no order journaled. - return.orderChecks: ReconciliationOrderCheck[]; default: not declared - return.orders: ExecutionOrderState[]; default: not declared - return.planHash: string | null; default: not declared - return.portfolio: ReconcilePortfolioResult | null; default: not declared — `reconcilePortfolio`'s result when an external snapshot was given. - return.portfolio.accounts: import('@insiderfinance/totalfinance/portfolio').ReconciliationAccountReport[]; default: not declared - return.portfolio.asOf: number; default: not declared - return.portfolio.assumptions: { comparisonConvention: string; conventionsVersion: string; lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; tolerance: Required; }; default: not declared - return.portfolio.assumptions.comparisonConvention: string; default: not declared - return.portfolio.assumptions.conventionsVersion: string; default: not declared - return.portfolio.assumptions.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared - return.portfolio.assumptions.tolerance: Required; default: not declared - return.portfolio.assumptions.tolerance.cashAmount: number; default: not declared - return.portfolio.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - return.portfolio.assumptions.tolerance.quantity: number; default: not declared - return.portfolio.baseCurrency: string; default: not declared - return.portfolio.diagnostics: { externalAccountCount: number; ledgerAccountCount: number; warnings: string[]; }; default: not declared - return.portfolio.diagnostics.externalAccountCount: number; default: not declared - return.portfolio.diagnostics.ledgerAccountCount: number; default: not declared - return.portfolio.diagnostics.warnings: string[]; default: not declared - return.portfolio.differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - return.portfolio.explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - return.portfolio.reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - return.portfolio.suggestedCorrections: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - return.portfolio.undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. - return.reconciled: boolean; default: not declared - return.schemaVersion: 1; default: not declared - return.sourceId: string; default: not declared - return.unresolved: { orderId: string; reason: string; }[]; default: not declared ### @insiderfinance/totalfinance/portfolio#reconcilePortfolio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare a derived state with a normalized external snapshot at `asOf` — see the module comment. ```typescript export declare function reconcilePortfolio(input: ReconcilePortfolioInput): ReconcilePortfolioResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ReconcilePortfolioInput; default: not declared - (input).asOf: string | number; default: not declared — The comparison instant (settled/unsettled cash is classified here); ISO date or epoch ms. - (input).correctionSourceId?: string; default: not declared — `sourceId` stamped on suggested correction drafts. Default `'reconciliation'`. - (input).external: ExternalPortfolioSnapshot; default: not declared - (input).portfolio: PortfolioState; default: not declared - (input).tolerance: ReconciliationTolerance; default: not declared - return.accounts: ReconciliationAccountReport[]; default: not declared - return.asOf: number; default: not declared - return.assumptions: { comparisonConvention: string; conventionsVersion: string; lotRelief: LotReliefPolicy; tolerance: Required; }; default: not declared - return.assumptions.comparisonConvention: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.lotRelief: LotReliefPolicy; default: not declared - return.assumptions.tolerance: Required; default: not declared - return.assumptions.tolerance.cashAmount: number; default: not declared - return.assumptions.tolerance.costBasis: number; default: not declared — Cost-basis tolerance in currency units; defaults to `cashAmount` when omitted. - return.assumptions.tolerance.quantity: number; default: not declared - return.baseCurrency: string; default: not declared - return.diagnostics: { externalAccountCount: number; ledgerAccountCount: number; warnings: string[]; }; default: not declared - return.diagnostics.externalAccountCount: number; default: not declared - return.diagnostics.ledgerAccountCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.differenceCount: number; default: not declared — Differences beyond tolerance, before explanations. - return.explainedCount: number; default: not declared — Beyond-tolerance differences an explanation accounts for. - return.reconciled: boolean; default: not declared — Every difference is within tolerance (or explained by pending settlement). - return.suggestedCorrections: PortfolioEventEnvelope[]; default: not declared — DRAFT envelopes that would bring the ledger to the external figures — validated, stamped with `sourceId: correctionSourceId`, effective at `asOf`, and NEVER applied here. Applying them is a separate authorized portfolio write. - return.undraftable: { accountId: string; subject: string; reason: string; }[]; default: not declared — Differences for which no complete draft could be written, and what would be needed. ### @insiderfinance/totalfinance/portfolio#requireNormalizedFill Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link NormalizedFill} at a public boundary: a closed plain-data record whose numbers are finite, whose quantity is positive, whose settlement never precedes the fill, whose cost components are non-negative, and whose derivative terms come with their multiplier. The economic laws a fill must satisfy inside the ledger (a future settles by variation margin, a lot selection names real lots, …) are enforced by the event validator the mapped events pass through. ```typescript export declare function requireNormalizedFill(functionName: string, label: string, fill: unknown): asserts fill is NormalizedFill; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (fill): unknown; default: not declared - (functionName): string; default: not declared - (label): string; default: not declared ### @insiderfinance/totalfinance/portfolio#requirePortfolioEventEnvelope Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one {@link PortfolioEventEnvelope} at a public boundary (Law 12 closed request): known keys at every level, identity strings, finite explicit timestamps, the schema version, the envelope/payload discriminator agreement, and the full per-variant payload contract. The guard validates its own `functionName` and `label` first (the `requireFundamentalPeriod` precedent) so its teaching errors always name the real boundary. ```typescript export declare function requirePortfolioEventEnvelope(functionName: string, label: string, envelope: PortfolioEventEnvelope): asserts envelope is PortfolioEventEnvelope; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (envelope): PortfolioEventEnvelope; default: not declared - (envelope).accountId: string; default: not declared — The account the event is recorded against (for transfers, the FROM account). - (envelope).causationId?: string; default: not declared - (envelope).correlationId?: string; default: not declared - (envelope).effectiveTimestampMs: number; default: not declared — When the economic effect occurred. Events fold in non-decreasing `effectiveTimestampMs`. - (envelope).event: PortfolioEvent; default: not declared - (envelope).eventId: string; default: not declared — Unique within `sourceId` — together they are the duplicate boundary. - (envelope).eventType: 'cash.deposit' | 'cash.withdrawal' | 'cash.transfer' | 'cash.conversion' | 'trade.fill' | 'cost.charge' | 'income.received' | 'financing.charge' | 'corporate.split' | 'derivative.exercise' | 'derivative.assignment' | 'derivative.expiration' | 'derivative.multiplier-change' | 'derivative.variation-margin' | 'derivative.roll' | 'fixed-income.redemption' | 'corporate.symbol-change' | 'corporate.merger' | 'corporate.spin-off' | 'corporate.return-of-capital' | 'corporate.cash-in-lieu' | 'position.transfer' | 'admin.reversal' | 'admin.correction' | 'admin.account-migration'; default: not declared — Redundant discriminator; must equal `event.eventType`. - (envelope).provenance: Provenance; default: not declared — Where the event came from — caller-supplied, never fetched; OUTSIDE the event identity. - (envelope).recordedTimestampMs: number; default: not declared — When the event was recorded — may lag the effect; never read from a clock by this package. - (envelope).reversesEventId?: string; default: not declared — Names a prior event this one reverses. Recorded now; the repair fold is a later slice. - (envelope).schemaVersion: number; default: not declared — Must equal {@link PORTFOLIO_EVENT_SCHEMA_VERSION}. - (envelope).sourceId: string; default: not declared — The system that emitted the event (a broker import, a simulator, a manual entry). - (functionName): string; default: not declared - (label): string; default: not declared ### @insiderfinance/totalfinance/portfolio#resolveModelTargets Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The targets a model makes effective at `asOf`: the latest tactical set covering the instant, else the glide path (stepped or interpolated), else the strategic set. An instant before the strategic set is effective is a typed refusal — a model has no targets there. ```typescript export declare function resolveModelTargets(input: ResolveModelTargetsInput): ResolvedTargets; ``` Example (source JSDoc): ```ts const effective = resolveModelTargets({ model, asOf: '2026-06-30' }); effective.source; // 'strategic' | 'tactical' | 'glide-path' ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ResolveModelTargetsInput; default: not declared - (input).asOf: string | number; default: not declared — The instant to resolve at (`'YYYY-MM-DD'`, zoned ISO datetime, or epoch ms). - (input).model: ModelPortfolio; default: not declared - return.effectiveFrom: number | null; default: not declared — The effective-from instant of the winning set (`null` for inline targets). - return.interpolation?: { fraction: number; from: EpochMs; to: EpochMs; }; default: not declared — Present when a linear glide path interpolated between two points. - return.interpolation.fraction: number; default: not declared - return.interpolation.from: number; default: not declared - return.interpolation.to: number; default: not declared - return.source: ResolvedTargetSource; default: not declared - return.targets: AllocationTarget[]; default: not declared ### @insiderfinance/totalfinance/portfolio#verifyAuthorizationGrant Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-verify a grant at execution (Decision 5): expiry, the plan hash, the portfolio and market hashes, the market's age against the grant's allowance, the mode, the account, the idempotency key, and — when the orders about to be submitted differ from the plan's — the variance envelope (quantity ratio, notional ratio, limit-price slippage). Every binding is checked; the result lists every reason, never the first. ```typescript export declare function verifyAuthorizationGrant(input: VerifyAuthorizationGrantInput): GrantVerification; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VerifyAuthorizationGrantInput; default: not declared - (input).grant: AuthorizationGrant; default: not declared - (input).idempotencyKey: string; default: not declared — The submission's key; must be one the grant licenses. - (input).marketAsOf: number; default: not declared — The market snapshot's instant at execution. - (input).marketHash: string; default: not declared — The market snapshot's content hash at execution. - (input).mode?: 'paper'; default: not declared — Default `'paper'`. - (input).now: number; default: not declared - (input).orders?: readonly TradeOrder[]; default: not declared — The orders about to be submitted when they differ from the plan's (a re-priced limit, a resized quantity), judged against the grant's variance envelope. Default: the plan's orders. - (input).plan: ExecutionPlan; default: not declared - (input).portfolioHash: string; default: not declared — The portfolio's content hash at execution. - return.assumptions: { bindingConvention: string; conventionsVersion: string; marketAgeMs: number; marketAsOf: import('@insiderfinance/totalfinance/core').EpochMs; marketMaximumAgeMs: number; mode: 'paper'; ordersJudged: 'plan' | 'supplied'; }; default: not declared - return.assumptions.bindingConvention: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.marketAgeMs: number; default: not declared - return.assumptions.marketAsOf: number; default: not declared — The market instant and age the verification judged. - return.assumptions.marketMaximumAgeMs: number; default: not declared - return.assumptions.mode: 'paper'; default: not declared - return.assumptions.ordersJudged: 'supplied' | 'plan'; default: not declared — Whether the orders judged for variance were the plan's own (no variance) or supplied. - return.checkedAt: number; default: not declared - return.diagnostics: { bindingCount: number; engine: 'grant-verification'; orderCount: number; reasonCount: number; warnings: string[]; }; default: not declared - return.diagnostics.bindingCount: number; default: not declared - return.diagnostics.engine: 'grant-verification'; default: not declared - return.diagnostics.orderCount: number; default: not declared - return.diagnostics.reasonCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.grantHash: string; default: not declared - return.planHash: string; default: not declared - return.reasons: GrantRefusal[]; default: not declared — Every failed binding, never only the first. - return.valid: boolean; default: not declared ## Entrypoint @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#CompareDisclosedHoldingPartitionsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CompareDisclosedHoldingPartitionsInput`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartition`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionChange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionChange`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionChangeReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionChangeReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionKey Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionKey`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionResult`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionRowResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionRowResult`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsConcentration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsConcentration`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsConcentrationReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsConcentrationReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsPolicy`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsReport`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsSnapshot`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsSnapshotReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsSnapshotReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedHoldingPartitionsSnapshotReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingPartitionsSnapshotReport`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#DisclosedUncomparedHoldingPartition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedUncomparedHoldingPartition`. ### @insiderfinance/totalfinance/portfolio/disclosed-holding-partitions#compareDisclosedHoldingPartitions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#compareDisclosedHoldingPartitions`. ## Entrypoint @insiderfinance/totalfinance/portfolio/disclosed-holdings ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#CompareDisclosedHoldingsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CompareDisclosedHoldingsInput`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHolding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHolding`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingChange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingChange`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingChangeReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingChangeReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingResult`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsConcentration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsConcentration`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsConcentrationReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsConcentrationReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsPolicy`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsReport`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsSnapshot`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsSnapshotReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsSnapshotReason`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedHoldingsSnapshotReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedHoldingsSnapshotReport`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#DisclosedPositionResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DisclosedPositionResult`. ### @insiderfinance/totalfinance/portfolio/disclosed-holdings#compareDisclosedHoldings Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#compareDisclosedHoldings`. ## Entrypoint @insiderfinance/totalfinance/portfolio/events ### @insiderfinance/totalfinance/portfolio/events#AdminAccountMigrationEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AdminAccountMigrationEvent`. ### @insiderfinance/totalfinance/portfolio/events#AdminCorrectionEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AdminCorrectionEvent`. ### @insiderfinance/totalfinance/portfolio/events#AdminReversalEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AdminReversalEvent`. ### @insiderfinance/totalfinance/portfolio/events#CashConversionEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CashConversionEvent`. ### @insiderfinance/totalfinance/portfolio/events#CashDepositEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CashDepositEvent`. ### @insiderfinance/totalfinance/portfolio/events#CashInLieuEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CashInLieuEvent`. ### @insiderfinance/totalfinance/portfolio/events#CashTransferEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CashTransferEvent`. ### @insiderfinance/totalfinance/portfolio/events#CashWithdrawalEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CashWithdrawalEvent`. ### @insiderfinance/totalfinance/portfolio/events#ContractMultiplierChangeEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ContractMultiplierChangeEvent`. ### @insiderfinance/totalfinance/portfolio/events#CostChargeEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CostChargeEvent`. ### @insiderfinance/totalfinance/portfolio/events#CostType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CostType`. ### @insiderfinance/totalfinance/portfolio/events#DerivativeContractTerms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DerivativeContractTerms`. ### @insiderfinance/totalfinance/portfolio/events#DerivativeRollEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DerivativeRollEvent`. ### @insiderfinance/totalfinance/portfolio/events#DerivativeSettlement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#DerivativeSettlement`. ### @insiderfinance/totalfinance/portfolio/events#EconomicPortfolioEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#EconomicPortfolioEvent`. ### @insiderfinance/totalfinance/portfolio/events#FinancingChargeEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#FinancingChargeEvent`. ### @insiderfinance/totalfinance/portfolio/events#FinancingType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#FinancingType`. ### @insiderfinance/totalfinance/portfolio/events#FixedIncomeRedemptionEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#FixedIncomeRedemptionEvent`. ### @insiderfinance/totalfinance/portfolio/events#FutureContractTerms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#FutureContractTerms`. ### @insiderfinance/totalfinance/portfolio/events#IncomeReceivedEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#IncomeReceivedEvent`. ### @insiderfinance/totalfinance/portfolio/events#IncomeType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#IncomeType`. ### @insiderfinance/totalfinance/portfolio/events#MergerEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MergerEvent`. ### @insiderfinance/totalfinance/portfolio/events#NORMALIZED_FILL_KEYS Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#NORMALIZED_FILL_KEYS`. ### @insiderfinance/totalfinance/portfolio/events#NormalizedFill Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#NormalizedFill`. ### @insiderfinance/totalfinance/portfolio/events#NormalizedFillCosts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#NormalizedFillCosts`. ### @insiderfinance/totalfinance/portfolio/events#NormalizedFillLiquidity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#NormalizedFillLiquidity`. ### @insiderfinance/totalfinance/portfolio/events#OptionAssignmentEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#OptionAssignmentEvent`. ### @insiderfinance/totalfinance/portfolio/events#OptionContractTerms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#OptionContractTerms`. ### @insiderfinance/totalfinance/portfolio/events#OptionExerciseEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#OptionExerciseEvent`. ### @insiderfinance/totalfinance/portfolio/events#OptionExpirationEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#OptionExpirationEvent`. ### @insiderfinance/totalfinance/portfolio/events#PORTFOLIO_EVENT_SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PORTFOLIO_EVENT_SCHEMA_VERSION`. ### @insiderfinance/totalfinance/portfolio/events#PerpetualContractTerms Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PerpetualContractTerms`. ### @insiderfinance/totalfinance/portfolio/events#PortfolioEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioEvent`. ### @insiderfinance/totalfinance/portfolio/events#PortfolioEventEnvelope Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioEventEnvelope`. ### @insiderfinance/totalfinance/portfolio/events#PortfolioEventType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioEventType`. ### @insiderfinance/totalfinance/portfolio/events#PortfolioEventsFromFillInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioEventsFromFillInput`. ### @insiderfinance/totalfinance/portfolio/events#PositionTransferEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PositionTransferEvent`. ### @insiderfinance/totalfinance/portfolio/events#PremiumTreatment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PremiumTreatment`. ### @insiderfinance/totalfinance/portfolio/events#RedemptionType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RedemptionType`. ### @insiderfinance/totalfinance/portfolio/events#ReturnOfCapitalEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReturnOfCapitalEvent`. ### @insiderfinance/totalfinance/portfolio/events#SettlementStyle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#SettlementStyle`. ### @insiderfinance/totalfinance/portfolio/events#SpinOffEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#SpinOffEvent`. ### @insiderfinance/totalfinance/portfolio/events#StockSplitEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#StockSplitEvent`. ### @insiderfinance/totalfinance/portfolio/events#SymbolChangeEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#SymbolChangeEvent`. ### @insiderfinance/totalfinance/portfolio/events#TradeFillEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradeFillEvent`. ### @insiderfinance/totalfinance/portfolio/events#TradeFillLotSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradeFillLotSelection`. ### @insiderfinance/totalfinance/portfolio/events#VariationMarginEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#VariationMarginEvent`. ### @insiderfinance/totalfinance/portfolio/events#duplicateBoundaryKey Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#duplicateBoundaryKey`. ### @insiderfinance/totalfinance/portfolio/events#portfolioEventContentHash Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#portfolioEventContentHash`. ### @insiderfinance/totalfinance/portfolio/events#portfolioEventsFromFill Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#portfolioEventsFromFill`. ### @insiderfinance/totalfinance/portfolio/events#requireNormalizedFill Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#requireNormalizedFill`. ### @insiderfinance/totalfinance/portfolio/events#requirePortfolioEventEnvelope Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#requirePortfolioEventEnvelope`. ## Entrypoint @insiderfinance/totalfinance/portfolio/ledger ### @insiderfinance/totalfinance/portfolio/ledger#CreatePortfolioLedgerInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CreatePortfolioLedgerInput`. ### @insiderfinance/totalfinance/portfolio/ledger#LotReliefPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#LotReliefPolicy`. ### @insiderfinance/totalfinance/portfolio/ledger#PORTFOLIO_LEDGER_KIND Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PORTFOLIO_LEDGER_KIND`. ### @insiderfinance/totalfinance/portfolio/ledger#PORTFOLIO_LEDGER_SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PORTFOLIO_LEDGER_SCHEMA_VERSION`. ### @insiderfinance/totalfinance/portfolio/ledger#PortfolioEventEnvelope Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioEventEnvelope`. ### @insiderfinance/totalfinance/portfolio/ledger#PortfolioLedger Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioLedger`. ### @insiderfinance/totalfinance/portfolio/ledger#PortfolioLedgerSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioLedgerSnapshot`. ### @insiderfinance/totalfinance/portfolio/ledger#PortfolioState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioState`. ### @insiderfinance/totalfinance/portfolio/ledger#ReadPortfolioLedgerSnapshotInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReadPortfolioLedgerSnapshotInput`. ### @insiderfinance/totalfinance/portfolio/ledger#createPortfolioLedger Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#createPortfolioLedger`. ### @insiderfinance/totalfinance/portfolio/ledger#isPortfolioLedgerSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#isPortfolioLedgerSnapshot`. ### @insiderfinance/totalfinance/portfolio/ledger#portfolioLedgerContentHash Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#portfolioLedgerContentHash`. ### @insiderfinance/totalfinance/portfolio/ledger#readPortfolioLedgerSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#readPortfolioLedgerSnapshot`. ## Entrypoint @insiderfinance/totalfinance/portfolio/performance ### @insiderfinance/totalfinance/portfolio/performance#CurrencyPairQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CurrencyPairQuote`. ### @insiderfinance/totalfinance/portfolio/performance#InstrumentClassification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#InstrumentClassification`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioExposure`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioExposureGroupRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioExposureGroupRow`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioExposureGrouping Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioExposureGrouping`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioGroupingDimension Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioGroupingDimension`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPerformanceInputsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPerformanceInputsInput`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPerformanceInputsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPerformanceInputsResult`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPnlComponents Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPnlComponents`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPnlCurrencyRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPnlCurrencyRow`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPnlGroupRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPnlGroupRow`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPnlGrouping Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPnlGrouping`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPnlInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPnlInput`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioPnlResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioPnlResult`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioTimelineInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioTimelineInput`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioTimelineResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioTimelineResult`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioTimelineRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioTimelineRow`. ### @insiderfinance/totalfinance/portfolio/performance#PortfolioValuationMark Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioValuationMark`. ### @insiderfinance/totalfinance/portfolio/performance#portfolioPerformanceInputs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#portfolioPerformanceInputs`. ### @insiderfinance/totalfinance/portfolio/performance#portfolioPnl Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#portfolioPnl`. ### @insiderfinance/totalfinance/portfolio/performance#portfolioTimeline Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#portfolioTimeline`. ## Entrypoint @insiderfinance/totalfinance/portfolio/policy ### @insiderfinance/totalfinance/portfolio/policy#AllocatePortfolioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocatePortfolioInput`. ### @insiderfinance/totalfinance/portfolio/policy#AllocatePortfolioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocatePortfolioResult`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationCash Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationCash`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationDustRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationDustRow`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationPrice`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationRow`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationSizing Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationSizing`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationSizingInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationSizingInput`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationTarget Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationTarget`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationTrade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationTrade`. ### @insiderfinance/totalfinance/portfolio/policy#AllocationTransactionCosts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AllocationTransactionCosts`. ### @insiderfinance/totalfinance/portfolio/policy#BenchmarkConstituent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#BenchmarkConstituent`. ### @insiderfinance/totalfinance/portfolio/policy#BenchmarkIdentity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#BenchmarkIdentity`. ### @insiderfinance/totalfinance/portfolio/policy#ContributionHandling Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ContributionHandling`. ### @insiderfinance/totalfinance/portfolio/policy#ExpandedTargets Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExpandedTargets`. ### @insiderfinance/totalfinance/portfolio/policy#ExternalFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExternalFlow`. ### @insiderfinance/totalfinance/portfolio/policy#GlidePath Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#GlidePath`. ### @insiderfinance/totalfinance/portfolio/policy#GlidePathPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#GlidePathPoint`. ### @insiderfinance/totalfinance/portfolio/policy#GroupTarget Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#GroupTarget`. ### @insiderfinance/totalfinance/portfolio/policy#GroupWeightLimit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#GroupWeightLimit`. ### @insiderfinance/totalfinance/portfolio/policy#IncomeReinvestment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#IncomeReinvestment`. ### @insiderfinance/totalfinance/portfolio/policy#InstrumentTarget Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#InstrumentTarget`. ### @insiderfinance/totalfinance/portfolio/policy#InvestmentPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#InvestmentPolicy`. ### @insiderfinance/totalfinance/portfolio/policy#LiabilityEntry Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#LiabilityEntry`. ### @insiderfinance/totalfinance/portfolio/policy#LiabilitySchedule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#LiabilitySchedule`. ### @insiderfinance/totalfinance/portfolio/policy#MODEL_PORTFOLIO_KIND Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MODEL_PORTFOLIO_KIND`. ### @insiderfinance/totalfinance/portfolio/policy#MODEL_PORTFOLIO_SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MODEL_PORTFOLIO_SCHEMA_VERSION`. ### @insiderfinance/totalfinance/portfolio/policy#MONITOR_ALERT_FAMILIES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MONITOR_ALERT_FAMILIES`. ### @insiderfinance/totalfinance/portfolio/policy#MONITOR_LIQUIDITY_PARTICIPATION_RATE Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MONITOR_LIQUIDITY_PARTICIPATION_RATE`. ### @insiderfinance/totalfinance/portfolio/policy#ModelPortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ModelPortfolio`. ### @insiderfinance/totalfinance/portfolio/policy#ModelPortfolioDefinition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ModelPortfolioDefinition`. ### @insiderfinance/totalfinance/portfolio/policy#ModelSleeve Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ModelSleeve`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorAlert Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorAlert`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorAlertDirection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorAlertDirection`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorAlertFamily Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorAlertFamily`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorAlertSeverity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorAlertSeverity`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorAlertState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorAlertState`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorDeferredFamily Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorDeferredFamily`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorFamilyEvaluation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorFamilyEvaluation`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorHysteresis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorHysteresis`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorPortfolioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorPortfolioInput`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorPortfolioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorPortfolioResult`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorRule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorRule`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorRuleState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorRuleState`. ### @insiderfinance/totalfinance/portfolio/policy#MonitorThresholdSource Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#MonitorThresholdSource`. ### @insiderfinance/totalfinance/portfolio/policy#PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PORTFOLIO_MONITOR_STATE_SCHEMA_VERSION`. ### @insiderfinance/totalfinance/portfolio/policy#PolicyLimits Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PolicyLimits`. ### @insiderfinance/totalfinance/portfolio/policy#PortfolioMonitorState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PortfolioMonitorState`. ### @insiderfinance/totalfinance/portfolio/policy#ProposePortfolioRebalanceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ProposePortfolioRebalanceInput`. ### @insiderfinance/totalfinance/portfolio/policy#ProposePortfolioRebalanceResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ProposePortfolioRebalanceResult`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceCashSummary Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceCashSummary`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceCashWeight Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceCashWeight`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceDustSummary Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceDustSummary`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceEstimates Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceEstimates`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceGroupWeight Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceGroupWeight`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceInstrumentWeight Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceInstrumentWeight`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceLotPreview Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceLotPreview`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceLotSelection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceLotSelection`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceObjectivePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceObjectivePoint`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceRiskPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceRiskPoint`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceScope Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceScope`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceTrade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceTrade`. ### @insiderfinance/totalfinance/portfolio/policy#RebalanceTradeReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#RebalanceTradeReason`. ### @insiderfinance/totalfinance/portfolio/policy#ResolveModelTargetsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ResolveModelTargetsInput`. ### @insiderfinance/totalfinance/portfolio/policy#ResolvedMonitorRule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ResolvedMonitorRule`. ### @insiderfinance/totalfinance/portfolio/policy#ResolvedTargetSource Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ResolvedTargetSource`. ### @insiderfinance/totalfinance/portfolio/policy#ResolvedTargets Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ResolvedTargets`. ### @insiderfinance/totalfinance/portfolio/policy#SleeveMember Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#SleeveMember`. ### @insiderfinance/totalfinance/portfolio/policy#TRADE_PLAN_KIND Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TRADE_PLAN_KIND`. ### @insiderfinance/totalfinance/portfolio/policy#TRADE_PLAN_SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TRADE_PLAN_SCHEMA_VERSION`. ### @insiderfinance/totalfinance/portfolio/policy#TargetGroup Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TargetGroup`. ### @insiderfinance/totalfinance/portfolio/policy#TargetGroupKey Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TargetGroupKey`. ### @insiderfinance/totalfinance/portfolio/policy#TargetSet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TargetSet`. ### @insiderfinance/totalfinance/portfolio/policy#TradeCostEstimate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradeCostEstimate`. ### @insiderfinance/totalfinance/portfolio/policy#TradePlanArtifact Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradePlanArtifact`. ### @insiderfinance/totalfinance/portfolio/policy#TradePlanTrade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradePlanTrade`. ### @insiderfinance/totalfinance/portfolio/policy#UnresolvedConstraint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#UnresolvedConstraint`. ### @insiderfinance/totalfinance/portfolio/policy#UnresolvedConstraintStatus Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#UnresolvedConstraintStatus`. ### @insiderfinance/totalfinance/portfolio/policy#UnresolvedTarget Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#UnresolvedTarget`. ### @insiderfinance/totalfinance/portfolio/policy#WithdrawalHandling Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#WithdrawalHandling`. ### @insiderfinance/totalfinance/portfolio/policy#WithinGroupAllocation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#WithinGroupAllocation`. ### @insiderfinance/totalfinance/portfolio/policy#allocatePortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#allocatePortfolio`. ### @insiderfinance/totalfinance/portfolio/policy#createModelPortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#createModelPortfolio`. ### @insiderfinance/totalfinance/portfolio/policy#isModelPortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#isModelPortfolio`. ### @insiderfinance/totalfinance/portfolio/policy#monitorPortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#monitorPortfolio`. ### @insiderfinance/totalfinance/portfolio/policy#proposePortfolioRebalance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#proposePortfolioRebalance`. ### @insiderfinance/totalfinance/portfolio/policy#resolveModelTargets Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#resolveModelTargets`. ## Entrypoint @insiderfinance/totalfinance/portfolio/reconciliation ### @insiderfinance/totalfinance/portfolio/reconciliation#CashDifference Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CashDifference`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ExternalAccountSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExternalAccountSnapshot`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ExternalCashBalance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExternalCashBalance`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ExternalPortfolioSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExternalPortfolioSnapshot`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ExternalPosition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExternalPosition`. ### @insiderfinance/totalfinance/portfolio/reconciliation#PositionDifference Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PositionDifference`. ### @insiderfinance/totalfinance/portfolio/reconciliation#PositionDifferenceKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PositionDifferenceKind`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ReconcilePortfolioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconcilePortfolioInput`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ReconcilePortfolioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconcilePortfolioResult`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ReconciliationAccountReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconciliationAccountReport`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ReconciliationExplanation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconciliationExplanation`. ### @insiderfinance/totalfinance/portfolio/reconciliation#ReconciliationTolerance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconciliationTolerance`. ### @insiderfinance/totalfinance/portfolio/reconciliation#reconcilePortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#reconcilePortfolio`. ## Entrypoint @insiderfinance/totalfinance/portfolio/trade ### @insiderfinance/totalfinance/portfolio/trade#AUTHORIZATION_GRANT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const AUTHORIZATION_GRANT_KIND: 'totalfinance.authorization-grant'; ``` ### @insiderfinance/totalfinance/portfolio/trade#AUTHORIZATION_GRANT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const AUTHORIZATION_GRANT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio/trade#ApplyJournalEventsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ApplyJournalEventsInput`. ### @insiderfinance/totalfinance/portfolio/trade#ApplyJournalEventsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ApplyJournalEventsResult`. ### @insiderfinance/totalfinance/portfolio/trade#AuthorizationGrant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#AuthorizationGrant`. ### @insiderfinance/totalfinance/portfolio/trade#CreateAuthorizationGrantInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#CreateAuthorizationGrantInput`. ### @insiderfinance/totalfinance/portfolio/trade#EXECUTION_JOURNAL_EVENT_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A journal read folds at most this many events (Decision 11). ```typescript export declare const EXECUTION_JOURNAL_EVENT_CEILING: 100000; ``` ### @insiderfinance/totalfinance/portfolio/trade#EXECUTION_JOURNAL_EVENT_TYPES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const EXECUTION_JOURNAL_EVENT_TYPES: readonly ['proposed', 'preflighted', 'authorized', 'submitted', 'acknowledged', 'partially-filled', 'filled', 'rejected', 'cancel-requested', 'cancelled', 'replaced', 'expired', 'reconciled', 'unresolved']; ``` ### @insiderfinance/totalfinance/portfolio/trade#EXECUTION_PLAN_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const EXECUTION_PLAN_KIND: 'totalfinance.execution-plan'; ``` ### @insiderfinance/totalfinance/portfolio/trade#EXECUTION_PLAN_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const EXECUTION_PLAN_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio/trade#ExecutionJournalDetail Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed detail record; which fields matter depends on the event type (see `applyJournalEvents`). ```typescript /** The closed detail record; which fields matter depends on the event type (see `applyJournalEvents`). */ export interface ExecutionJournalDetail { /** `submitted`: the submitted quantity; `partially-filled` / `filled`: the fill's quantity. */ quantity?: number; /** `partially-filled` / `filled`: the fill id — the ledger's `trade.fill` event id. */ fillId?: string; /** `partially-filled` / `filled`: the fill price, for the average. */ pricePerUnit?: number; /** `rejected` / `cancelled` / `expired` / `unresolved`: why. */ reason?: string; /** `replaced`: the replacing order. */ replacementOrderId?: string; /** `proposed` / `preflighted` / `authorized` / `reconciled`: the artifact's content hash. */ artifactHash?: string; note?: string; /** Paper `submitted`: complete intent, with the effective time-in-force made explicit. */ order?: TradeOrder; /** Paper `submitted`: instrument terms captured at submission, never replaced by restart defaults. */ instrument?: { currency: string; contractMultiplier?: number; settlementStyle?: SettlementStyle; contract?: DerivativeContractTerms; /** Paper currently measures this lag in 24-hour days, not exchange-calendar sessions. */ settlementLag?: 0 | 1 | 2; }; /** Paper `submitted`: the account/base-currency binding of the broker. */ accountId?: string; baseCurrency?: string; /** Hash of the complete declared policy data and callback labels/versions; not serialized code. */ executionPolicyHash?: string; /** Paper fills: the consumed market observation's instant, preventing retry from consuming it again. */ observationTimestampMs?: EpochMs; /** Paper `submitted`: the combo this order is a leg of (B5), so a restored broker fills it all-or-none. */ comboId?: string; /** Paper `submitted`: the combo's net limit per combo unit, repeated on every leg. */ netLimitPrice?: number; /** The complete accounting fact, including settlement and costs, for durable recovery. */ fill?: NormalizedFill; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId?: string; default: not declared — Paper `submitted`: the account/base-currency binding of the broker. - artifactHash?: string; default: not declared — `proposed` / `preflighted` / `authorized` / `reconciled`: the artifact's content hash. - baseCurrency?: string; default: not declared - comboId?: string; default: not declared — Paper `submitted`: the combo this order is a leg of (B5), so a restored broker fills it all-or-none. - executionPolicyHash?: string; default: not declared — Hash of the complete declared policy data and callback labels/versions; not serialized code. - fill?: NormalizedFill; default: not declared — The complete accounting fact, including settlement and costs, for durable recovery. - fill.accountId: string; default: not declared - fill.accruedInterest?: number; default: not declared — Accrued interest paid (bought) or received (sold) with a bond fill, in `currency`. - fill.contract?: DerivativeContractTerms; default: not declared - fill.contract.expiryTimestampMs: number; default: not declared - fill.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - fill.contract.strikePricePerUnit: number; default: not declared - fill.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - fill.contract.underlyingInstrumentId: string; default: not declared - fill.contractMultiplier?: number; default: not declared — Units of the underlying per unit of quantity; REQUIRED when `contract` is given (the ledger's law). - fill.costs?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillCosts; default: not declared - fill.costs.commission?: number; default: not declared - fill.costs.exchangeFees?: number; default: not declared - fill.costs.regulatoryFees?: number; default: not declared - fill.costs.slippageAdjustment?: number; default: not declared - fill.currency: string; default: not declared - fill.executionPriceAdjustment?: number; default: not declared — Absolute execution-price deviation × quantity × multiplier, in currency, ≥ 0. Attribution only: already embedded in pricePerUnit, NEVER emitted as another cash charge. - fill.fillId: string; default: not declared — Unique within `sourceId`; becomes the `trade.fill` event's id, so a replayed fill folds once. - fill.filledTimestampMs: number; default: not declared — When the fill happened — the event's effective instant. - fill.instrumentId: string; default: not declared - fill.liquidity?: import('@insiderfinance/totalfinance/portfolio').NormalizedFillLiquidity; default: not declared - fill.orderId?: string; default: not declared — The order this fill answers; becomes the events' `correlationId`. - fill.pricePerUnit: number; default: not declared — Execution price per unit in `currency`. Finite; sign-unconstrained (negative prints are real). - fill.quantity: number; default: not declared — Filled quantity, > 0 (fractional supported); `side` carries the direction. - fill.settleTimestampMs?: number; default: not declared — When the cash leg settles; omitted = settles at the fill. Never before `filledTimestampMs`. - fill.settlementStyle?: SettlementStyle; default: not declared - fill.side: 'buy' | 'sell'; default: not declared - fill.venue?: string; default: not declared - fillId?: string; default: not declared — `partially-filled` / `filled`: the fill id — the ledger's `trade.fill` event id. - instrument?: { contract?: DerivativeContractTerms; contractMultiplier?: number; currency: string; settlementLag?: 0 | 1 | 2; settlementStyle?: SettlementStyle; }; default: not declared — Paper `submitted`: instrument terms captured at submission, never replaced by restart defaults. - instrument.contract?: DerivativeContractTerms; default: not declared - instrument.contract.expiryTimestampMs: number; default: not declared - instrument.contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - instrument.contract.strikePricePerUnit: number; default: not declared - instrument.contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - instrument.contract.underlyingInstrumentId: string; default: not declared - instrument.contractMultiplier?: number; default: not declared - instrument.currency: string; default: not declared - instrument.settlementLag?: 0 | 1 | 2; default: not declared — Paper currently measures this lag in 24-hour days, not exchange-calendar sessions. - instrument.settlementStyle?: SettlementStyle; default: not declared - netLimitPrice?: number; default: not declared — Paper `submitted`: the combo's net limit per combo unit, repeated on every leg. - note?: string; default: not declared - observationTimestampMs?: number; default: not declared — Paper fills: the consumed market observation's instant, preventing retry from consuming it again. - order?: TradeOrder; default: not declared — Paper `submitted`: complete intent, with the effective time-in-force made explicit. - order.comboId?: string; default: not declared — The multi-leg order this is a leg of (B5); the plan's `combos` names the legs and the net limit. - order.instrumentId: string; default: not declared - order.limitPrice?: number; default: not declared - order.orderId: string; default: not declared - order.plannedTimestampMs: number; default: not declared — The plan's instant — when the order was planned, never when it reached a broker. - order.quantity: number; default: not declared - order.side: OrderSide; default: not declared - order.stopPrice?: number; default: not declared - order.submittedTimestampMs?: number; default: not declared — Stamped by the broker at submission; absent on a plan's order. A fill never consumes an observation older than it. - order.timeInForce?: TimeInForce; default: not declared - order.type: OrderType; default: not declared - pricePerUnit?: number; default: not declared — `partially-filled` / `filled`: the fill price, for the average. - quantity?: number; default: not declared — `submitted`: the submitted quantity; `partially-filled` / `filled`: the fill's quantity. - reason?: string; default: not declared — `rejected` / `cancelled` / `expired` / `unresolved`: why. - replacementOrderId?: string; default: not declared — `replaced`: the replacing order. ### @insiderfinance/totalfinance/portfolio/trade#ExecutionJournalEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExecutionJournalEvent`. ### @insiderfinance/totalfinance/portfolio/trade#ExecutionJournalEventType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExecutionJournalEventType = (typeof EXECUTION_JOURNAL_EVENT_TYPES)[number]; ``` ### @insiderfinance/totalfinance/portfolio/trade#ExecutionJournalState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExecutionJournalState`. ### @insiderfinance/totalfinance/portfolio/trade#ExecutionOrderState Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExecutionOrderState`. ### @insiderfinance/totalfinance/portfolio/trade#ExecutionOrderStatus Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExecutionOrderStatus = 'submitted' | 'acknowledged' | 'partially-filled' | 'filled' | 'cancelled' | 'rejected' | 'expired' | 'unresolved'; ``` ### @insiderfinance/totalfinance/portfolio/trade#ExecutionPlan Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ExecutionPlan`. ### @insiderfinance/totalfinance/portfolio/trade#ExecutionPlanCombo Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A multi-leg order on a plan: one order to the broker, filled all-or-none against one observation. ```typescript /** A multi-leg order on a plan: one order to the broker, filled all-or-none against one observation. */ export interface ExecutionPlanCombo { comboId: string; /** The leg order ids, in plan order (at least two). */ orderIds: string[]; /** See {@link TradeIntentCombo.netLimitPrice}. */ netLimitPrice?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comboId: string; default: not declared - netLimitPrice?: number; default: not declared — See {@link TradeIntentCombo.netLimitPrice}. - orderIds: string[]; default: not declared — The leg order ids, in plan order (at least two). ### @insiderfinance/totalfinance/portfolio/trade#ExecutionPlanSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExecutionPlanSource = { kind: 'intent'; intentHash: string; } | { kind: 'rebalance-proposal'; planHash: string; policyContentHash: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - intentHash: string; default: not declared - kind: ('intent') | ('rebalance-proposal'); default: not declared - planHash: string; default: not declared - policyContentHash: string; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#GRANT_IDEMPOTENCY_KEY_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A grant carries at most this many idempotency keys — one per submission attempt it licenses. ```typescript export declare const GRANT_IDEMPOTENCY_KEY_CEILING: 1000; ``` ### @insiderfinance/totalfinance/portfolio/trade#GrantRefusal Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GrantRefusal { reason: GrantRefusalReason; detail: string; orderId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - detail: string; default: not declared - orderId?: string; default: not declared - reason: GrantRefusalReason; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#GrantRefusalReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type GrantRefusalReason = 'expired' | 'premature' | 'plan-hash-mismatch' | 'portfolio-hash-mismatch' | 'market-hash-mismatch' | 'market-stale' | 'mode-mismatch' | 'account-mismatch' | 'idempotency-key-unknown' | 'order-unknown' | 'order-mismatch' | 'combo-mismatch' | 'quantity-variance' | 'notional-variance' | 'slippage-variance'; ``` ### @insiderfinance/totalfinance/portfolio/trade#GrantVariance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How far an executed order may drift from the authorized plan before the grant refuses it. ```typescript /** How far an executed order may drift from the authorized plan before the grant refuses it. */ export interface GrantVariance { /** `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). */ maximumQuantityRatio: number; /** `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. */ maximumNotionalRatio: number; /** A limit price may sit at most this many bps from the plan's reference price. */ maximumSlippageBps: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maximumNotionalRatio: number; default: not declared — `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. - maximumQuantityRatio: number; default: not declared — `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). - maximumSlippageBps: number; default: not declared — A limit price may sit at most this many bps from the plan's reference price. ### @insiderfinance/totalfinance/portfolio/trade#GrantVerification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#GrantVerification`. ### @insiderfinance/totalfinance/portfolio/trade#MergeTradePoliciesInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The stricter of two policies: the minimum of every bound, the intersection of every allow list. ```typescript /** The stricter of two policies: the minimum of every bound, the intersection of every allow list. */ export type MergeTradePoliciesInput = { policies: readonly TradePolicy[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - policies: readonly TradePolicy[]; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#NormalizeTradePlanInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface NormalizeTradePlanInput { intent?: TradeIntent; proposal?: TradePlanArtifact; portfolio: PortfolioState; market: MarketSnapshot; asOf: EpochMs | string; accountId?: string; instruments?: Record; currencyConversions?: CurrencyPairQuote[]; rationale?: string; evidence?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId?: string; default: not declared - asOf: string | number; default: not declared - currencyConversions?: CurrencyPairQuote[]; default: not declared - evidence?: string[]; default: not declared - instruments?: Record; default: not declared - intent?: TradeIntent; default: not declared - intent.accountId: string; default: not declared - intent.asOf: number; default: not declared - intent.combos?: TradeIntentCombo[]; default: not declared — The combos the lines' `comboId`s name, when a net limit is wanted; a combo without terms needs no entry. - intent.evidence?: string[]; default: not declared — Artifact ids the intent rests on. - intent.kind: 'totalfinance.trade-intent'; default: not declared - intent.orders: TradeIntentOrder[]; default: not declared - intent.rationale?: string; default: not declared — Metadata: recorded, never read by any stage. - intent.schemaVersion: number; default: not declared - market: MarketSnapshot; default: not declared - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - portfolio: PortfolioState; default: not declared - portfolio.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - portfolio.accounts: Record; default: not declared - portfolio.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - portfolio.baseCurrency: string; default: not declared - portfolio.eventCount: number; default: not declared - portfolio.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - portfolio.lastEffectiveTimestampMs: number | null; default: not declared - portfolio.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - portfolio.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolio.portfolioId?: string; default: not declared - portfolio.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - portfolio.schemaVersion: number; default: not declared - proposal?: TradePlanArtifact; default: not declared - proposal.asOf: number; default: not declared - proposal.baseCurrency: string; default: not declared - proposal.contentHash: string; default: not declared — `sha256:` over every field above. - proposal.kind: 'totalfinance.trade-plan'; default: not declared - proposal.policyContentHash: string; default: not declared — `contentHash` over the validated policy the plan was built from. - proposal.portfolioId?: string; default: not declared - proposal.schemaVersion: number; default: not declared - proposal.trades: TradePlanTrade[]; default: not declared — Sorted by (accountId, instrumentId, side). - rationale?: string; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#OrderSide Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderSide`. ### @insiderfinance/totalfinance/portfolio/trade#OrderType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#OrderType`. ### @insiderfinance/totalfinance/portfolio/trade#PREFLIGHT_REPORT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const PREFLIGHT_REPORT_KIND: 'totalfinance.preflight-report'; ``` ### @insiderfinance/totalfinance/portfolio/trade#PREFLIGHT_REPORT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const PREFLIGHT_REPORT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio/trade#PolicyCheck Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PolicyCheck`. ### @insiderfinance/totalfinance/portfolio/trade#PolicyCheckVerdict Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PolicyCheckVerdict = 'pass' | 'fail' | 'unverifiable' | 'require-approval'; ``` ### @insiderfinance/totalfinance/portfolio/trade#PolicyDecision Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PolicyDecision`. ### @insiderfinance/totalfinance/portfolio/trade#PreflightCostRates Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Declared cost rates preflight estimates with (the execution policy's own models live in the broker). ```typescript /** Declared cost rates preflight estimates with (the execution policy's own models live in the broker). */ export interface PreflightCostRates { commissionBps?: number; commissionPerOrder?: number; spreadBps?: number; slippageBps?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commissionBps?: number; default: not declared - commissionPerOrder?: number; default: not declared - slippageBps?: number; default: not declared - spreadBps?: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#PreflightEstimates Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PreflightEstimates { tradedNotional: number; commission: number; spread: number; slippage: number; totalCost: number; turnover: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - commission: number; default: not declared - slippage: number; default: not declared - spread: number; default: not declared - totalCost: number; default: not declared - tradedNotional: number; default: not declared - turnover: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#PreflightInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Instrument description for preflight; held economic terms remain ledger-authoritative. ```typescript /** Instrument description for preflight; held economic terms remain ledger-authoritative. */ export interface PreflightInstrument { currency: string; contractMultiplier?: number; contract?: DerivativeContractTerms; /** Caller-supplied policy classification, also used when the ledger already holds the instrument. */ assetClass?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assetClass?: string; default: not declared — Caller-supplied policy classification, also used when the ledger already holds the instrument. - contract?: DerivativeContractTerms; default: not declared - contract.expiryTimestampMs: number; default: not declared - contract.kind: ('future') | ('option') | ('perpetual'); default: not declared - contract.strikePricePerUnit: number; default: not declared - contract.type: 'call' | 'put'; default: not declared — `'call' | 'put'` — the same word the option contract and every chain row use (B6). - contract.underlyingInstrumentId: string; default: not declared - contractMultiplier?: number; default: not declared - currency: string; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#PreflightReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#PreflightReport`. ### @insiderfinance/totalfinance/portfolio/trade#PreflightSession Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PreflightSession { open: boolean; /** Instrument ids halted at the instant. */ halted?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - halted?: string[]; default: not declared — Instrument ids halted at the instant. - open: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#PreflightTradePlanInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PreflightTradePlanInput { plan: ExecutionPlan; portfolio: PortfolioState; market: MarketSnapshot; asOf: EpochMs | string; policy: TradePolicy; instruments?: Record; currencyConversions?: CurrencyPairQuote[]; /** Orders already open in the journal; a plan that repeats one is a conflict. */ openOrders?: TradeOrder[]; costs?: PreflightCostRates; averageDailyVolumes?: Record; session?: PreflightSession; /** The monitor state carried from the previous evaluation, when the caller keeps one. */ monitorState?: PortfolioMonitorState | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - averageDailyVolumes?: Record; default: not declared - costs?: PreflightCostRates; default: not declared - costs.commissionBps?: number; default: not declared - costs.commissionPerOrder?: number; default: not declared - costs.slippageBps?: number; default: not declared - costs.spreadBps?: number; default: not declared - currencyConversions?: CurrencyPairQuote[]; default: not declared - instruments?: Record; default: not declared - market: MarketSnapshot; default: not declared - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - monitorState?: PortfolioMonitorState | null; default: not declared — The monitor state carried from the previous evaluation, when the caller keeps one. - monitorState.asOf: number; default: not declared - monitorState.evaluationCount: number; default: not declared - monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - monitorState.rules: Record; default: not declared - monitorState.schemaVersion: number; default: not declared - openOrders?: TradeOrder[]; default: not declared — Orders already open in the journal; a plan that repeats one is a conflict. - plan: ExecutionPlan; default: not declared - plan.accountId: string; default: not declared - plan.asOf: number; default: not declared - plan.baseCurrency: string; default: not declared - plan.combos: ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - plan.contentHash: string; default: not declared - plan.evidence: string[]; default: not declared - plan.kind: 'totalfinance.execution-plan'; default: not declared - plan.orders: TradeOrder[]; default: not declared - plan.portfolioId?: string; default: not declared - plan.rationale?: string; default: not declared - plan.schemaVersion: number; default: not declared - plan.source: ExecutionPlanSource; default: not declared - plan.source.intentHash: string; default: not declared - plan.source.kind: ('intent') | ('rebalance-proposal'); default: not declared - plan.source.planHash: string; default: not declared - plan.source.policyContentHash: string; default: not declared - plan.trades: TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. - policy: TradePolicy; default: not declared - policy.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a plan that leaves an option net short (a call uncovered) is denied. - policy.allowedAccounts?: string[]; default: not declared - policy.allowedAssetClasses?: string[]; default: not declared - policy.allowedInstruments?: string[]; default: not declared - policy.allowedOrderTypes?: OrderType[]; default: not declared - policy.limits?: PolicyLimits; default: not declared - policy.limits.maximumDailyLoss?: number; default: not declared — Maximum one-evaluation NAV loss (decimal of the prior NAV). - policy.limits.maximumDaysToLiquidate?: number; default: not declared — Maximum days to liquidate any position at the supplied participation rate. - policy.limits.maximumDrawdown?: number; default: not declared — Maximum peak-to-trough drawdown of NAV (decimal). - policy.limits.maximumGrossLeverage?: number; default: not declared — Maximum gross exposure ÷ NAV (1 = unlevered). - policy.limits.maximumGroupWeights?: import('@insiderfinance/totalfinance/portfolio').GroupWeightLimit[]; default: not declared - policy.limits.maximumPositionWeight?: number; default: not declared — Maximum absolute weight of any single instrument (decimal of NAV). - policy.limits.minimumSettledCash?: number; default: not declared — Minimum settled cash in base currency (a margin/buying-power floor; may be negative). - policy.marketMaximumAgeMs?: number; default: not declared - policy.maximumEstimatedCost?: number; default: not declared — Base currency, the plan's total estimated commission + spread + slippage. - policy.maximumOrderNotional?: number; default: not declared - policy.maximumOrderQuantity?: number; default: not declared - policy.maximumParticipation?: number; default: not declared - policy.maximumSlippageBps?: number; default: not declared - policy.maximumTurnover?: number; default: not declared — Traded notional ÷ NAV before the plan. - policy.mode: 'paper'; default: not declared — The only mode this stage accepts; `'live'` is a typed refusal naming AT8. - policy.onUnverifiable?: 'require-approval' | 'deny'; default: not declared — What an unverifiable check does to the decision (default `'require-approval'`). - policy.requireApprovalAbove?: { notional?: number; quantity?: number; }; default: not declared — Above either bound the decision is `require-approval` rather than `allow`. - policy.requireApprovalAbove.notional?: number; default: not declared - policy.requireApprovalAbove.quantity?: number; default: not declared - portfolio: PortfolioState; default: not declared - portfolio.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - portfolio.accounts: Record; default: not declared - portfolio.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - portfolio.baseCurrency: string; default: not declared - portfolio.eventCount: number; default: not declared - portfolio.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - portfolio.lastEffectiveTimestampMs: number | null; default: not declared - portfolio.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - portfolio.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - portfolio.portfolioId?: string; default: not declared - portfolio.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - portfolio.schemaVersion: number; default: not declared - session?: PreflightSession; default: not declared - session.halted?: string[]; default: not declared — Instrument ids halted at the instant. - session.open: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#RECONCILIATION_REPORT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const RECONCILIATION_REPORT_KIND: 'totalfinance.reconciliation-report'; ``` ### @insiderfinance/totalfinance/portfolio/trade#RECONCILIATION_REPORT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const RECONCILIATION_REPORT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio/trade#ReconcileExecutionInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconcileExecutionInput`. ### @insiderfinance/totalfinance/portfolio/trade#ReconciliationFillMatch Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconciliationFillMatch { fillId: string; orderId: string | null; quantity: number; journaled: boolean; inLedger: boolean; ledgerKey: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fillId: string; default: not declared - inLedger: boolean; default: not declared - journaled: boolean; default: not declared - ledgerKey: string; default: not declared - orderId: string | null; default: not declared - quantity: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#ReconciliationOrderCheck Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReconciliationOrderCheck { orderId: string; state: ExecutionOrderStatus; journaledQuantity: number; fillQuantity: number; /** `fillQuantity − journaledQuantity`. */ difference: number; withinTolerance: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - difference: number; default: not declared — `fillQuantity − journaledQuantity`. - fillQuantity: number; default: not declared - journaledQuantity: number; default: not declared - orderId: string; default: not declared - state: ExecutionOrderStatus; default: not declared - withinTolerance: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#ReconciliationReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#ReconciliationReport`. ### @insiderfinance/totalfinance/portfolio/trade#TRADE_INTENT_KIND Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TRADE_INTENT_KIND: 'totalfinance.trade-intent'; ``` ### @insiderfinance/totalfinance/portfolio/trade#TRADE_INTENT_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const TRADE_INTENT_SCHEMA_VERSION: 1; ``` ### @insiderfinance/totalfinance/portfolio/trade#TRADE_PLAN_ORDER_CEILING Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The most orders one plan may carry (Decision 11). ```typescript export declare const TRADE_PLAN_ORDER_CEILING: 1000; ``` ### @insiderfinance/totalfinance/portfolio/trade#TimeInForce Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/backtest#TimeInForce`. ### @insiderfinance/totalfinance/portfolio/trade#TradeIntent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradeIntent`. ### @insiderfinance/totalfinance/portfolio/trade#TradeIntentCombo Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A combo's terms on an intent: the net limit its legs must meet together. ```typescript /** A combo's terms on an intent: the net limit its legs must meet together. */ export interface TradeIntentCombo { comboId: string; /** * Net price limit per combo unit: a net debit is positive (pay at most), a net credit negative * (receive at least the magnitude). A combo unit is the legs' quantities divided by their greatest * common divisor for integer quantities, or by the smallest leg quantity otherwise — a 10-lot * 1×1 vertical is ten units. Allowed quantity scaling preserves these authorized economics; * the broker translates the quote if the submitted unit size changes. Absent: each leg fills * at its own price. */ netLimitPrice?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comboId: string; default: not declared - netLimitPrice?: number; default: not declared — Net price limit per combo unit: a net debit is positive (pay at most), a net credit negative (receive at least the magnitude). A combo unit is the legs' quantities divided by their greatest common divisor for integer quantities, or by the smallest leg quantity otherwise — a 10-lot 1×1 vertical is ten units. Allowed quantity scaling preserves these authorized economics; the broker translates the quote if the submitted unit size changes. Absent: each leg fills at its own price. ### @insiderfinance/totalfinance/portfolio/trade#TradeIntentOrder Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One line of an intent: a quantity, or a notional weight of NAV the normalization sizes at the mark. ```typescript /** One line of an intent: a quantity, or a notional weight of NAV the normalization sizes at the mark. */ export interface TradeIntentOrder { instrumentId: string; side: OrderSide; quantity?: number; /** Size the order so its notional is this fraction of NAV at the mark, (0, 1]; mutually exclusive with `quantity`. */ notionalWeight?: number; type: OrderType; limitPrice?: number; stopPrice?: number; timeInForce?: TimeInForce; /** The multi-leg order this line is a leg of; at least two lines share a combo id. */ comboId?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - comboId?: string; default: not declared — The multi-leg order this line is a leg of; at least two lines share a combo id. - instrumentId: string; default: not declared - limitPrice?: number; default: not declared - notionalWeight?: number; default: not declared — Size the order so its notional is this fraction of NAV at the mark, (0, 1]; mutually exclusive with `quantity`. - quantity?: number; default: not declared - side: OrderSide; default: not declared - stopPrice?: number; default: not declared - timeInForce?: TimeInForce; default: not declared - type: OrderType; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#TradeOrder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradeOrder`. ### @insiderfinance/totalfinance/portfolio/trade#TradePolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#TradePolicy`. ### @insiderfinance/totalfinance/portfolio/trade#VerifyAuthorizationGrantInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#VerifyAuthorizationGrantInput`. ### @insiderfinance/totalfinance/portfolio/trade#applyJournalEvents Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#applyJournalEvents`. ### @insiderfinance/totalfinance/portfolio/trade#createAuthorizationGrant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#createAuthorizationGrant`. ### @insiderfinance/totalfinance/portfolio/trade#decideFromChecks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function decideFromChecks(checks: readonly PolicyCheck[], onUnverifiable: 'require-approval' | 'deny'): PolicyDecision; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (checks): readonly PolicyCheck[]; default: not declared - (onUnverifiable): 'require-approval' | 'deny'; default: not declared - return.checks: PolicyCheck[]; default: not declared - return.requiredScope: string; default: not declared - return.verdict: ('allow') | ('deny') | ('require-approval'); default: not declared ### @insiderfinance/totalfinance/portfolio/trade#journalOrderStates Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The journal's order states in id order — a stable listing for receipts and reconciliation. ```typescript export declare function journalOrderStates(state: ExecutionJournalState): ExecutionOrderState[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (state): ExecutionJournalState; default: not declared - (state).duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - (state).eventCount: number; default: not declared - (state).eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - (state).journalId: string | null; default: not declared — Null until the first event. - (state).orders: Record; default: not declared - (state).preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. ### @insiderfinance/totalfinance/portfolio/trade#mergeTradePolicies Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#mergeTradePolicies`. ### @insiderfinance/totalfinance/portfolio/trade#normalizeTradePlan Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#normalizeTradePlan`. ### @insiderfinance/totalfinance/portfolio/trade#preflightTradePlan Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#preflightTradePlan`. ### @insiderfinance/totalfinance/portfolio/trade#reconcileExecution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#reconcileExecution`. ### @insiderfinance/totalfinance/portfolio/trade#referencePriceOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The reference price for an instrument: the snapshot's spot when it has one at a positive price, else null (a limit price stands in only without one). The snapshot is read through its own door. ```typescript export declare function referencePriceOf(market: MarketSnapshot, instrumentId: string): { price: number; currency: string | null; } | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (instrumentId): string; default: not declared - (market): MarketSnapshot; default: not declared - (market).asOf: number; default: not declared - (market).conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - (market).kind: 'totalfinance.market-snapshot'; default: not declared - (market).observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - (market).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - (market).schemaVersion: number; default: not declared - return.currency: string | null; default: not declared - return.price: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireAuthorizationGrant Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An authorization grant: closed, its kind and version, every binding typed, the hash re-verified. ```typescript export declare function requireAuthorizationGrant(functionName: string, label: string, value: unknown): AuthorizationGrant; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accountId: string; default: not declared - return.approvedBy: string; default: not declared - return.baseCurrency: string; default: not declared - return.comboIds: string[]; default: not declared — The plan's combo ids, in plan order — a grant binds the multi-leg structure, not only the legs. - return.contentHash: string; default: not declared - return.expiresAt: number; default: not declared - return.grantId: string; default: not declared - return.idempotencyKeys: string[]; default: not declared — The closed set of submission keys this grant licenses — one per attempt. - return.issuedAt: number; default: not declared - return.kind: 'totalfinance.authorization-grant'; default: not declared - return.marketAsOf: number; default: not declared — The market instant the preflight judged; execution must not see an older market. - return.marketHash: string; default: not declared - return.marketMaximumAgeMs: number; default: not declared — At execution the market may be at most this old (`now − marketAsOf`). - return.mode: 'paper'; default: not declared - return.orderIds: string[]; default: not declared — The plan's order ids, in plan order. - return.planHash: string; default: not declared - return.portfolioHash: string; default: not declared - return.preflightHash: string; default: not declared - return.requiredScope: string | null; default: not declared — The scope the preflight asked for (`require-approval`), or null when it allowed outright. - return.schemaVersion: 1; default: not declared - return.variance: GrantVariance; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireExecutionJournalEvent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A journal event: closed, typed, its detail record closed; the fold judges the sequence. ```typescript export declare function requireExecutionJournalEvent(functionName: string, label: string, value: unknown): ExecutionJournalEvent; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.detail: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionJournalDetail; default: not declared - return.eventId: string; default: not declared - return.eventType: 'expired' | 'proposed' | 'preflighted' | 'authorized' | 'submitted' | 'acknowledged' | 'partially-filled' | 'filled' | 'rejected' | 'cancel-requested' | 'cancelled' | 'replaced' | 'reconciled' | 'unresolved'; default: not declared - return.idempotencyKey?: string; default: not declared - return.journalId: string; default: not declared - return.orderId: string; default: not declared - return.planHash: string; default: not declared - return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - return.sourceId: string; default: not declared - return.timestampMs: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireExecutionJournalState Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A folded journal state, as `applyJournalEvents` returns it. ```typescript export declare function requireExecutionJournalState(functionName: string, label: string, value: unknown): ExecutionJournalState; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.duplicateEventIds: string[]; default: not declared — Every duplicate delivery skipped across folds. - return.eventCount: number; default: not declared - return.eventIds: string[]; default: not declared — Applied event ids in order (duplicates excluded). - return.journalId: string | null; default: not declared — Null until the first event. - return.orders: Record; default: not declared - return.preSubmission: Record; default: not declared — Orders journaled only before submission: the pre-submission event types seen. ### @insiderfinance/totalfinance/portfolio/trade#requireExecutionOrderState Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireExecutionOrderState(functionName: string, label: string, value: unknown): ExecutionOrderState; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.averageFillPrice: number | null; default: not declared — Quantity-weighted; null until a priced fill, and null again if any fill came unpriced. - return.cancelRequested: boolean; default: not declared - return.fillIds: string[]; default: not declared - return.filledQuantity: number; default: not declared - return.lastEventId: string; default: not declared - return.lastTimestampMs: number; default: not declared - return.lateFillIds: string[]; default: not declared — Fills journaled after the order was closed — the order is `unresolved` while any exist. - return.orderId: string; default: not declared - return.planHash: string; default: not declared - return.reason: string | null; default: not declared - return.reconciledEventId: string | null; default: not declared - return.remainingQuantity: number; default: not declared - return.replacedBy: string | null; default: not declared - return.state: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionOrderStatus; default: not declared - return.submittedQuantity: number; default: not declared - return.terminal: boolean; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireExecutionPlan Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An execution plan: the closed artifact every later stage binds to; its content hash must match its body. ```typescript export declare function requireExecutionPlan(functionName: string, label: string, value: unknown): ExecutionPlan; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accountId: string; default: not declared - return.asOf: number; default: not declared - return.baseCurrency: string; default: not declared - return.combos: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanCombo[]; default: not declared — Every multi-leg order, each with at least two legs; empty when every order stands alone. - return.contentHash: string; default: not declared - return.evidence: string[]; default: not declared - return.kind: 'totalfinance.execution-plan'; default: not declared - return.orders: TradeOrder[]; default: not declared - return.portfolioId?: string; default: not declared - return.rationale?: string; default: not declared - return.schemaVersion: number; default: not declared - return.source: import('@insiderfinance/totalfinance/portfolio/trade').ExecutionPlanSource; default: not declared - return.trades: import('@insiderfinance/totalfinance/portfolio').TradePlanTrade[]; default: not declared — The FC7 rows — reference prices and estimated notional per trade — for estimates and comparison. ### @insiderfinance/totalfinance/portfolio/trade#requireGrantVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requireGrantVariance(functionName: string, field: string, value: unknown): GrantVariance; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared - return.maximumNotionalRatio: number; default: not declared — `|executed notional / authorized notional − 1|` at most this, at the plan's reference prices. - return.maximumQuantityRatio: number; default: not declared — `|executed quantity / authorized quantity − 1|` at most this (0 = exactly the plan). - return.maximumSlippageBps: number; default: not declared — A limit price may sit at most this many bps from the plan's reference price. ### @insiderfinance/totalfinance/portfolio/trade#requirePreflightCostRates Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function requirePreflightCostRates(functionName: string, label: string, value: unknown): PreflightCostRates; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.commissionBps?: number; default: not declared - return.commissionPerOrder?: number; default: not declared - return.slippageBps?: number; default: not declared - return.spreadBps?: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requirePreflightInstrument Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An instrument description preflight and the broker read for an instrument the ledger may not hold. ```typescript export declare function requirePreflightInstrument(functionName: string, label: string, value: unknown): PreflightInstrument; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.assetClass?: string; default: not declared — Caller-supplied policy classification, also used when the ledger already holds the instrument. - return.contract?: import('@insiderfinance/totalfinance/portfolio').DerivativeContractTerms; default: not declared - return.contractMultiplier?: number; default: not declared - return.currency: string; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requirePreflightReport Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A preflight report: closed, its kind and version, its content hash re-verified over the body. ```typescript export declare function requirePreflightReport(functionName: string, label: string, value: unknown): PreflightReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.after: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared - return.alerts: import('@insiderfinance/totalfinance/portfolio').MonitorAlert[]; default: not declared - return.asOf: number; default: not declared - return.assumptions: { conventionsVersion: string; costRates: Required; decisionConvention: string; fillConvention: string; instrumentSources: Record; mode: 'paper'; policyContentHash: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.costRates: Required; default: not declared - return.assumptions.costRates.commissionBps: number; default: not declared - return.assumptions.costRates.commissionPerOrder: number; default: not declared - return.assumptions.costRates.slippageBps: number; default: not declared - return.assumptions.costRates.spreadBps: number; default: not declared - return.assumptions.decisionConvention: string; default: not declared - return.assumptions.fillConvention: string; default: not declared - return.assumptions.instrumentSources: Record; default: not declared — Where each instrument's currency and multiplier came from: the ledger position, the caller's description, or the market spot (priced as a plain cash instrument). - return.assumptions.mode: 'paper'; default: not declared - return.assumptions.policyContentHash: string; default: not declared - return.before: import('@insiderfinance/totalfinance/portfolio').PortfolioSnapshotResult; default: not declared - return.checks: PolicyCheck[]; default: not declared - return.contentHash: string; default: not declared - return.decision: import('@insiderfinance/totalfinance/portfolio').PolicyDecision; default: not declared - return.diagnostics: { checkCount: number; converged: true; engine: 'trade-preflight'; failedCount: number; method: 'hypothetical-fold'; unverifiableCount: number; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - return.diagnostics.checkCount: number; default: not declared - return.diagnostics.converged: true; default: not declared - return.diagnostics.engine: 'trade-preflight'; default: not declared - return.diagnostics.failedCount: number; default: not declared - return.diagnostics.method: 'hypothetical-fold'; default: not declared - return.diagnostics.unverifiableCount: number; default: not declared - return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - return.estimates: import('@insiderfinance/totalfinance/portfolio/trade').PreflightEstimates; default: not declared - return.hypotheticalEvents: import('@insiderfinance/totalfinance/portfolio').PortfolioEventEnvelope[]; default: not declared - return.hypotheticalFills: import('@insiderfinance/totalfinance/portfolio').NormalizedFill[]; default: not declared — The hypothetical fills the after-state was folded from. - return.kind: 'totalfinance.preflight-report'; default: not declared - return.marketAsOf: number; default: not declared - return.marketHash: string; default: not declared - return.monitorState: import('@insiderfinance/totalfinance/portfolio').PortfolioMonitorState | null; default: not declared - return.monitorState.asOf: number; default: not declared - return.monitorState.evaluationCount: number; default: not declared - return.monitorState.netAssetValue: number | null; default: not declared — The evaluation's NAV; `null` when the portfolio could not be valued (a missing mark). - return.monitorState.peakNetAssetValue: number | null; default: not declared — The running NAV peak (drawdown base); `null` until an evaluation has valued the portfolio. - return.monitorState.rules: Record; default: not declared - return.monitorState.schemaVersion: number; default: not declared - return.planHash: string; default: not declared - return.portfolioHash: string; default: not declared - return.schemaVersion: number; default: not declared - return.unverifiable: string[]; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireTradeIntent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A trade intent: closed, without a credential, a quantity or a notional weight per line. ```typescript export declare function requireTradeIntent(functionName: string, label: string, value: unknown): TradeIntent; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.accountId: string; default: not declared - return.asOf: number; default: not declared - return.combos?: import('@insiderfinance/totalfinance/portfolio/trade').TradeIntentCombo[]; default: not declared — The combos the lines' `comboId`s name, when a net limit is wanted; a combo without terms needs no entry. - return.evidence?: string[]; default: not declared — Artifact ids the intent rests on. - return.kind: 'totalfinance.trade-intent'; default: not declared - return.orders: import('@insiderfinance/totalfinance/portfolio/trade').TradeIntentOrder[]; default: not declared - return.rationale?: string; default: not declared — Metadata: recorded, never read by any stage. - return.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireTradeOrder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One executable order in the frozen execution grammar. ```typescript export declare function requireTradeOrder(functionName: string, label: string, value: unknown): TradeOrder; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.comboId?: string; default: not declared — The multi-leg order this is a leg of (B5); the plan's `combos` names the legs and the net limit. - return.instrumentId: string; default: not declared - return.limitPrice?: number; default: not declared - return.orderId: string; default: not declared - return.plannedTimestampMs: number; default: not declared — The plan's instant — when the order was planned, never when it reached a broker. - return.quantity: number; default: not declared - return.side: import('@insiderfinance/totalfinance/core').OrderSide; default: not declared - return.stopPrice?: number; default: not declared - return.submittedTimestampMs?: number; default: not declared — Stamped by the broker at submission; absent on a plan's order. A fill never consumes an observation older than it. - return.timeInForce?: import('@insiderfinance/totalfinance/core').TimeInForce; default: not declared - return.type: import('@insiderfinance/totalfinance/core').OrderType; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#requireTradePolicy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The structured trade policy: closed, deterministic, paper-only in this stage. ```typescript export declare function requireTradePolicy(functionName: string, label: string, value: unknown): TradePolicy; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (value): unknown; default: not declared - return.allowUndefinedRiskOptions?: boolean; default: not declared — Default false: a plan that leaves an option net short (a call uncovered) is denied. - return.allowedAccounts?: string[]; default: not declared - return.allowedAssetClasses?: string[]; default: not declared - return.allowedInstruments?: string[]; default: not declared - return.allowedOrderTypes?: import('@insiderfinance/totalfinance/core').OrderType[]; default: not declared - return.limits?: import('@insiderfinance/totalfinance/portfolio').PolicyLimits; default: not declared - return.marketMaximumAgeMs?: number; default: not declared - return.maximumEstimatedCost?: number; default: not declared — Base currency, the plan's total estimated commission + spread + slippage. - return.maximumOrderNotional?: number; default: not declared - return.maximumOrderQuantity?: number; default: not declared - return.maximumParticipation?: number; default: not declared - return.maximumSlippageBps?: number; default: not declared - return.maximumTurnover?: number; default: not declared — Traded notional ÷ NAV before the plan. - return.mode: 'paper'; default: not declared — The only mode this stage accepts; `'live'` is a typed refusal naming AT8. - return.onUnverifiable?: 'require-approval' | 'deny'; default: not declared — What an unverifiable check does to the decision (default `'require-approval'`). - return.requireApprovalAbove?: { notional?: number; quantity?: number; }; default: not declared — Above either bound the decision is `require-approval` rather than `allow`. - return.requireApprovalAbove.notional?: number; default: not declared - return.requireApprovalAbove.quantity?: number; default: not declared ### @insiderfinance/totalfinance/portfolio/trade#verifyAuthorizationGrant Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/portfolio#verifyAuthorizationGrant`. ## Entrypoint @insiderfinance/totalfinance/research ### @insiderfinance/totalfinance/research#AbnormalReturnRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One aligned event-window session with actual, expected, and abnormal return. ```typescript /** One aligned event-window session with actual, expected, and abnormal return. */ export interface AbnormalReturnRow { tradingSessionOffset: number; tradingSessionDate: string; actualReturn: number; expectedReturn: number; abnormalReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - abnormalReturn: number; default: not declared - actualReturn: number; default: not declared - expectedReturn: number; default: not declared - tradingSessionDate: string; default: not declared - tradingSessionOffset: number; default: not declared ### @insiderfinance/totalfinance/research#AggregateEventStudiesAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate assumptions — per-study fields that legitimately differ are labelled, not hidden. ```typescript /** Aggregate assumptions — per-study fields that legitimately differ are labelled, not hidden. */ export interface AggregateEventStudiesAssumptions { sessionPolicy: EventStudySessionPolicy; cumulativeConvention: CumulativeConvention; /** The shared model name, or `'mixed (…)'` naming each model pooled. */ expectedReturnModel: string; eventWindow: TradingSessionWindow; /** Present only when every study declared the identical estimation window. */ estimationWindow?: TradingSessionWindow; /** The shared policy, or `'mixed'` when studies differ. */ overlappingEventPolicy: OverlappingEventPolicy | 'mixed'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cumulativeConvention: CumulativeConvention; default: not declared - estimationWindow?: TradingSessionWindow; default: not declared — Present only when every study declared the identical estimation window. - estimationWindow.endTradingSessionOffset: number; default: not declared - estimationWindow.startTradingSessionOffset: number; default: not declared - eventWindow: TradingSessionWindow; default: not declared - eventWindow.endTradingSessionOffset: number; default: not declared - eventWindow.startTradingSessionOffset: number; default: not declared - expectedReturnModel: string; default: not declared — The shared model name, or `'mixed (…)'` naming each model pooled. - overlappingEventPolicy: OverlappingEventPolicy | 'mixed'; default: not declared — The shared policy, or `'mixed'` when studies differ. - sessionPolicy: EventStudySessionPolicy; default: not declared ### @insiderfinance/totalfinance/research#AggregateEventStudiesInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link aggregateEventStudies}. ```typescript /** Input for {@link aggregateEventStudies}. */ export interface AggregateEventStudiesInput { studies: readonly EventStudyResult[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - studies: readonly EventStudyResult[]; default: not declared ### @insiderfinance/totalfinance/research#AggregateEventStudiesResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The pooled result: same grammar, plus how many studies were pooled. ```typescript /** The pooled result: same grammar, plus how many studies were pooled. */ export interface AggregateEventStudiesResult { assumptions: AggregateEventStudiesAssumptions; diagnostics: EventStudyDiagnostics; events: EventStudyEventResult[]; averageAbnormalReturns: AverageAbnormalReturnRow[]; studiesAggregated: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: AggregateEventStudiesAssumptions; default: not declared - assumptions.cumulativeConvention: CumulativeConvention; default: not declared - assumptions.estimationWindow?: TradingSessionWindow; default: not declared — Present only when every study declared the identical estimation window. - assumptions.estimationWindow.endTradingSessionOffset: number; default: not declared - assumptions.estimationWindow.startTradingSessionOffset: number; default: not declared - assumptions.eventWindow: TradingSessionWindow; default: not declared - assumptions.eventWindow.endTradingSessionOffset: number; default: not declared - assumptions.eventWindow.startTradingSessionOffset: number; default: not declared - assumptions.expectedReturnModel: string; default: not declared — The shared model name, or `'mixed (…)'` naming each model pooled. - assumptions.overlappingEventPolicy: OverlappingEventPolicy | 'mixed'; default: not declared — The shared policy, or `'mixed'` when studies differ. - assumptions.sessionPolicy: EventStudySessionPolicy; default: not declared - averageAbnormalReturns: AverageAbnormalReturnRow[]; default: not declared - diagnostics: EventStudyDiagnostics; default: not declared - diagnostics.contaminatedEventIds: string[]; default: not declared — Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed). - diagnostics.eventsIncluded: number; default: not declared - diagnostics.eventsSupplied: number; default: not declared - diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - diagnostics.warnings: string[]; default: not declared - events: EventStudyEventResult[]; default: not declared - studiesAggregated: number; default: not declared ### @insiderfinance/totalfinance/research#AlignEventWindowsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link alignEventWindows}. ```typescript /** Input for {@link alignEventWindows}. */ export interface AlignEventWindowsInput { events: readonly MarketEvent[]; returnObservations: readonly ReturnObservation[]; eventWindow: TradingSessionWindow; /** Default `'next-session'` — the same policy, the same code path, as {@link eventStudy}. */ sessionPolicy?: EventStudySessionPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eventWindow: TradingSessionWindow; default: not declared - eventWindow.endTradingSessionOffset: number; default: not declared - eventWindow.startTradingSessionOffset: number; default: not declared - events: readonly MarketEvent[]; default: not declared - returnObservations: readonly ReturnObservation[]; default: not declared - sessionPolicy?: EventStudySessionPolicy; default: not declared — Default `'next-session'` — the same policy, the same code path, as {@link eventStudy}. ### @insiderfinance/totalfinance/research#AlignEventWindowsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The alignment helper's result — the anchoring truth {@link eventStudy} itself computes over. ```typescript /** The alignment helper's result — the anchoring truth {@link eventStudy} itself computes over. */ export interface AlignEventWindowsResult { assumptions: { sessionPolicy: EventStudySessionPolicy; eventWindow: TradingSessionWindow; }; diagnostics: { warnings: string[]; eventsSupplied: number; eventsAligned: number; excludedEvents: { eventId: string; reason: string; }[]; }; alignments: AlignedEventWindow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alignments: AlignedEventWindow[]; default: not declared - assumptions: { eventWindow: TradingSessionWindow; sessionPolicy: EventStudySessionPolicy; }; default: not declared - assumptions.eventWindow: TradingSessionWindow; default: not declared - assumptions.eventWindow.endTradingSessionOffset: number; default: not declared - assumptions.eventWindow.startTradingSessionOffset: number; default: not declared - assumptions.sessionPolicy: EventStudySessionPolicy; default: not declared - diagnostics: { eventsAligned: number; eventsSupplied: number; excludedEvents: { eventId: string; reason: string; }[]; warnings: string[]; }; default: not declared - diagnostics.eventsAligned: number; default: not declared - diagnostics.eventsSupplied: number; default: not declared - diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#AlignedEventWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One successfully aligned event. ```typescript /** One successfully aligned event. */ export interface AlignedEventWindow { eventId: string; instrumentId: string; anchorTradingSessionDate: string; rows: AlignedSessionRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - anchorTradingSessionDate: string; default: not declared - eventId: string; default: not declared - instrumentId: string; default: not declared - rows: AlignedSessionRow[]; default: not declared ### @insiderfinance/totalfinance/research#AlignedSessionRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One event-relative session row before any expected-return modelling. ```typescript /** One event-relative session row before any expected-return modelling. */ export interface AlignedSessionRow { tradingSessionOffset: number; tradingSessionDate: string; simpleReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - simpleReturn: number; default: not declared - tradingSessionDate: string; default: not declared - tradingSessionOffset: number; default: not declared ### @insiderfinance/totalfinance/research#AverageAbnormalReturnRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cross-sectional row: AAR, CAAR, and the per-offset t-statistic with its sample size. ```typescript /** One cross-sectional row: AAR, CAAR, and the per-offset t-statistic with its sample size. */ export interface AverageAbnormalReturnRow { tradingSessionOffset: number; averageAbnormalReturn: number; cumulativeAverageAbnormalReturn: number; eventCount: number; /** `mean / (sampleStandardDeviation / √n)`; `null` with a reason when n < 2 or variance is 0. */ tStatistic: number | null; tStatisticAbsentReason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageAbnormalReturn: number; default: not declared - cumulativeAverageAbnormalReturn: number; default: not declared - eventCount: number; default: not declared - tStatistic: number | null; default: not declared — `mean / (sampleStandardDeviation / √n)`; `null` with a reason when n < 2 or variance is 0. - tStatisticAbsentReason?: string; default: not declared - tradingSessionOffset: number; default: not declared ### @insiderfinance/totalfinance/research#CANONICAL_FACTOR_RECIPES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The seven canonical recipe families. Each is a frozen, versioned artifact; callers may copy and modify freely (the result is then their recipe, and should carry their name and version). ```typescript export declare const CANONICAL_FACTOR_RECIPES: Readonly>; ``` ### @insiderfinance/totalfinance/research#ComparisonOperator Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every comparison operator, retained as the convenient public vocabulary union. ```typescript /** Every comparison operator, retained as the convenient public vocabulary union. */ export type ComparisonOperator = OrderingComparisonOperator | IdentityComparisonOperator; ``` ### @insiderfinance/totalfinance/research#CompositeComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One composite component: an already-standardized factor vector with a weight and direction. ```typescript // --------------------------------------------------------------------------------------------------- // Composite scoring // --------------------------------------------------------------------------------------------------- /** One composite component: an already-standardized factor vector with a weight and direction. */ export interface CompositeComponent { label: string; entries: readonly FactorEntry[]; weight: number; direction: 'higher-is-better' | 'lower-is-better'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 'higher-is-better' | 'lower-is-better'; default: not declared - entries: readonly FactorEntry[]; default: not declared - label: string; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/research#CompositeFactorScoreInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link compositeFactorScore}. ```typescript /** Input for {@link compositeFactorScore}. */ export interface CompositeFactorScoreInput { components: readonly CompositeComponent[]; /** `'exclude'` drops an instrument missing any component; `'renormalize-weights'` scores what is present. */ missingValuePolicy: 'exclude' | 'renormalize-weights'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - components: readonly CompositeComponent[]; default: not declared - missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'` drops an instrument missing any component; `'renormalize-weights'` scores what is present. ### @insiderfinance/totalfinance/research#CompositeFactorScoreResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link compositeFactorScore}. ```typescript /** Result of {@link compositeFactorScore}. */ export interface CompositeFactorScoreResult { assumptions: { components: Array<{ label: string; weight: number; normalizedWeight: number; direction: string; }>; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; diagnostics: { warnings: string[]; instrumentCount: number; scoredCount: number; exclusionReasons: Record; }; entries: FactorEntry[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { components: Array<{ label: string; weight: number; normalizedWeight: number; direction: string; }>; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - assumptions.components: { label: string; weight: number; normalizedWeight: number; direction: string; }[]; default: not declared - assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - diagnostics: { exclusionReasons: Record; instrumentCount: number; scoredCount: number; warnings: string[]; }; default: not declared - diagnostics.exclusionReasons: Record; default: not declared - diagnostics.instrumentCount: number; default: not declared - diagnostics.scoredCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#CumulativeConvention Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How abnormal returns cumulate: `'sum'` = Σ AR (classic CAR); `'compound'` = Π(1 + AR) − 1. ```typescript /** How abnormal returns cumulate: `'sum'` = Σ AR (classic CAR); `'compound'` = Π(1 + AR) − 1. */ export type CumulativeConvention = 'sum' | 'compound'; ``` ### @insiderfinance/totalfinance/research#EligibilityLag Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // eligibleObservationsAt // --------------------------------------------------------------------------------------------------- export interface EligibilityLag { /** How many trading sessions before `asOf` the data must have been available. */ tradingSessions: number; /** * The session instants the caller's dataset knows, ascending — the lag counts sessions in this * index, never calendar days, so a weekend or holiday is not a session. */ sessionTimestamps: readonly EpochMs[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sessionTimestamps: readonly number[]; default: not declared — The session instants the caller's dataset knows, ascending — the lag counts sessions in this index, never calendar days, so a weekend or holiday is not a session. - tradingSessions: number; default: not declared — How many trading sessions before `asOf` the data must have been available. ### @insiderfinance/totalfinance/research#EligibleObservationsAtInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EligibleObservationsAtInput { observations: readonly UniverseObservation[]; fieldDefinitions: readonly FieldDefinition[]; asOf: EpochMs; /** Omitted = no lag: availability at or before `asOf` is enough. */ lag?: EligibilityLag; /** When given, only members of this universe at `asOf` are eligible. */ universeHistory?: UniverseHistory; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - fieldDefinitions: readonly FieldDefinition[]; default: not declared - lag?: EligibilityLag; default: not declared — Omitted = no lag: availability at or before `asOf` is enough. - lag.sessionTimestamps: readonly number[]; default: not declared — The session instants the caller's dataset knows, ascending — the lag counts sessions in this index, never calendar days, so a weekend or holiday is not a session. - lag.tradingSessions: number; default: not declared — How many trading sessions before `asOf` the data must have been available. - observations: readonly UniverseObservation[]; default: not declared - universeHistory?: UniverseHistory; default: not declared — When given, only members of this universe at `asOf` are eligible. - universeHistory.members: readonly UniverseMember[]; default: not declared - universeHistory.universeId: string; default: not declared ### @insiderfinance/totalfinance/research#EligibleObservationsAtResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EligibleObservationsAtResult { assumptions: { asOf: EpochMs; /** The instant availability is measured against: `asOf`, or the lagged session instant. */ availabilityCutoffMs: EpochMs; lagTradingSessions: number; universeId: string | null; versionResolution: 'latest available at or before the cutoff per instrument'; }; diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; excludedCount: number; exclusionReasons: Record; }; /** One observation per eligible instrument, `instrumentId` ascending. */ observations: UniverseObservation[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: EpochMs; availabilityCutoffMs: EpochMs; lagTradingSessions: number; universeId: string | null; versionResolution: 'latest available at or before the cutoff per instrument'; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.availabilityCutoffMs: number; default: not declared — The instant availability is measured against: `asOf`, or the lagged session instant. - assumptions.lagTradingSessions: number; default: not declared - assumptions.universeId: string | null; default: not declared - assumptions.versionResolution: 'latest available at or before the cutoff per instrument'; default: not declared - diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; suppliedCount: number; warnings: string[]; }; default: not declared - diagnostics.eligibleCount: number; default: not declared - diagnostics.excludedCount: number; default: not declared - diagnostics.exclusionReasons: Record; default: not declared - diagnostics.suppliedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - observations: UniverseObservation[]; default: not declared — One observation per eligible instrument, `instrumentId` ascending. ### @insiderfinance/totalfinance/research#EventMarketModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The market model fitted for one event (`'market'` model only). ```typescript /** The market model fitted for one event (`'market'` model only). */ export interface EventMarketModel { alpha: number; beta: number; /** `null` with a reason when the instrument had zero variance over the estimation window. */ rSquared: number | null; rSquaredAbsentReason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha: number; default: not declared - beta: number; default: not declared - rSquared: number | null; default: not declared — `null` with a reason when the instrument had zero variance over the estimation window. - rSquaredAbsentReason?: string; default: not declared ### @insiderfinance/totalfinance/research#EventStudyAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions an event study ran under, echoed verbatim. ```typescript /** The conventions an event study ran under, echoed verbatim. */ export interface EventStudyAssumptions { sessionPolicy: EventStudySessionPolicy; cumulativeConvention: CumulativeConvention; /** The model name; a caller function is classified `'custom (non-serializable)'`. */ expectedReturnModel: string; eventWindow: TradingSessionWindow; /** Echoed exactly when supplied. */ estimationWindow?: TradingSessionWindow; overlappingEventPolicy: OverlappingEventPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cumulativeConvention: CumulativeConvention; default: not declared - estimationWindow?: TradingSessionWindow; default: not declared — Echoed exactly when supplied. - estimationWindow.endTradingSessionOffset: number; default: not declared - estimationWindow.startTradingSessionOffset: number; default: not declared - eventWindow: TradingSessionWindow; default: not declared - eventWindow.endTradingSessionOffset: number; default: not declared - eventWindow.startTradingSessionOffset: number; default: not declared - expectedReturnModel: string; default: not declared — The model name; a caller function is classified `'custom (non-serializable)'`. - overlappingEventPolicy: OverlappingEventPolicy; default: not declared - sessionPolicy: EventStudySessionPolicy; default: not declared ### @insiderfinance/totalfinance/research#EventStudyDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What the study disclosed about coverage and exclusions. ```typescript /** What the study disclosed about coverage and exclusions. */ export interface EventStudyDiagnostics { warnings: string[]; eventsSupplied: number; eventsIncluded: number; excludedEvents: { eventId: string; reason: string; }[]; /** Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed). */ contaminatedEventIds: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contaminatedEventIds: string[]; default: not declared — Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed). - eventsIncluded: number; default: not declared - eventsSupplied: number; default: not declared - excludedEvents: { eventId: string; reason: string; }[]; default: not declared - warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#EventStudyEventResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One included event's aligned rows and cumulative abnormal return. ```typescript /** One included event's aligned rows and cumulative abnormal return. */ export interface EventStudyEventResult { eventId: string; instrumentId: string; anchorTradingSessionDate: string; /** Present only under the `'market'` model. */ marketModel?: EventMarketModel; rows: AbnormalReturnRow[]; cumulativeAbnormalReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - anchorTradingSessionDate: string; default: not declared - cumulativeAbnormalReturn: number; default: not declared - eventId: string; default: not declared - instrumentId: string; default: not declared - marketModel?: EventMarketModel; default: not declared — Present only under the `'market'` model. - marketModel.alpha: number; default: not declared - marketModel.beta: number; default: not declared - marketModel.rSquared: number | null; default: not declared — `null` with a reason when the instrument had zero variance over the estimation window. - marketModel.rSquaredAbsentReason?: string; default: not declared - rows: AbnormalReturnRow[]; default: not declared ### @insiderfinance/totalfinance/research#EventStudyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link eventStudy}. ```typescript /** Input for {@link eventStudy}. */ export interface EventStudyInput { events: readonly MarketEvent[]; /** Instrument returns per trading session — the sessions ARE these rows' distinct dates. */ returnObservations: readonly ReturnObservation[]; /** Required by the `'market-adjusted'` and `'market'` models. */ marketReturns?: readonly MarketReturnObservation[]; /** Integers, start ≤ end; offset 0 is the event session. */ eventWindow: TradingSessionWindow; /** * REQUIRED by `'mean-adjusted'` and `'market'`; must END strictly BEFORE the event window * starts — a model estimated through the event measures the event twice. */ estimationWindow?: TradingSessionWindow; expectedReturnModel: ExpectedReturnModelInput; /** Default `'next-session'` — documented in the module header and echoed in assumptions. */ sessionPolicy?: EventStudySessionPolicy; /** REQUIRED, no default — overlap handling changes the statistics, so the caller must choose. */ overlappingEventPolicy: OverlappingEventPolicy; /** Default `'sum'` (classic CAR) — documented and echoed. */ cumulativeConvention?: CumulativeConvention; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cumulativeConvention?: CumulativeConvention; default: not declared — Default `'sum'` (classic CAR) — documented and echoed. - estimationWindow?: TradingSessionWindow; default: not declared — REQUIRED by `'mean-adjusted'` and `'market'`; must END strictly BEFORE the event window starts — a model estimated through the event measures the event twice. - estimationWindow.endTradingSessionOffset: number; default: not declared - estimationWindow.startTradingSessionOffset: number; default: not declared - eventWindow: TradingSessionWindow; default: not declared — Integers, start ≤ end; offset 0 is the event session. - eventWindow.endTradingSessionOffset: number; default: not declared - eventWindow.startTradingSessionOffset: number; default: not declared - events: readonly MarketEvent[]; default: not declared - expectedReturnModel: ExpectedReturnModelInput; default: not declared - expectedReturnModel.expectedReturn: (context: ExpectedReturnContext) => number; default: not declared - expectedReturnModel.expectedReturn(context): ExpectedReturnContext; default: not declared - expectedReturnModel.expectedReturn(context).instrumentId: string; default: not declared - expectedReturnModel.expectedReturn(context).marketReturn?: number; default: not declared — Present when `marketReturns` were supplied and carry this session's date. - expectedReturnModel.expectedReturn(context).tradingSessionDate: string; default: not declared - expectedReturnModel.model: ('custom') | ('market') | ('market-adjusted') | ('mean-adjusted'); default: not declared - marketReturns?: readonly MarketReturnObservation[]; default: not declared — Required by the `'market-adjusted'` and `'market'` models. - overlappingEventPolicy: OverlappingEventPolicy; default: not declared — REQUIRED, no default — overlap handling changes the statistics, so the caller must choose. - returnObservations: readonly ReturnObservation[]; default: not declared — Instrument returns per trading session — the sessions ARE these rows' distinct dates. - sessionPolicy?: EventStudySessionPolicy; default: not declared — Default `'next-session'` — documented in the module header and echoed in assumptions. ### @insiderfinance/totalfinance/research#EventStudyResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The full event-study result — assumptions and diagnostics always present. ```typescript /** The full event-study result — assumptions and diagnostics always present. */ export interface EventStudyResult { assumptions: EventStudyAssumptions; diagnostics: EventStudyDiagnostics; events: EventStudyEventResult[]; averageAbnormalReturns: AverageAbnormalReturnRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: EventStudyAssumptions; default: not declared - assumptions.cumulativeConvention: CumulativeConvention; default: not declared - assumptions.estimationWindow?: TradingSessionWindow; default: not declared — Echoed exactly when supplied. - assumptions.estimationWindow.endTradingSessionOffset: number; default: not declared - assumptions.estimationWindow.startTradingSessionOffset: number; default: not declared - assumptions.eventWindow: TradingSessionWindow; default: not declared - assumptions.eventWindow.endTradingSessionOffset: number; default: not declared - assumptions.eventWindow.startTradingSessionOffset: number; default: not declared - assumptions.expectedReturnModel: string; default: not declared — The model name; a caller function is classified `'custom (non-serializable)'`. - assumptions.overlappingEventPolicy: OverlappingEventPolicy; default: not declared - assumptions.sessionPolicy: EventStudySessionPolicy; default: not declared - averageAbnormalReturns: AverageAbnormalReturnRow[]; default: not declared - diagnostics: EventStudyDiagnostics; default: not declared - diagnostics.contaminatedEventIds: string[]; default: not declared — Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed). - diagnostics.eventsIncluded: number; default: not declared - diagnostics.eventsSupplied: number; default: not declared - diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - diagnostics.warnings: string[]; default: not declared - events: EventStudyEventResult[]; default: not declared ### @insiderfinance/totalfinance/research#EventStudySessionPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a timestamp maps to session 0 — see the module header for the exact anchoring rules. ```typescript // --------------------------------------------------------------------------------------------------- // Contracts // --------------------------------------------------------------------------------------------------- /** How a timestamp maps to session 0 — see the module header for the exact anchoring rules. */ export type EventStudySessionPolicy = 'announcement-session' | 'next-session'; ``` ### @insiderfinance/totalfinance/research#ExpectedReturnContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What a caller-supplied factor model is shown per event session. ```typescript /** What a caller-supplied factor model is shown per event session. */ export interface ExpectedReturnContext { instrumentId: string; tradingSessionDate: string; /** Present when `marketReturns` were supplied and carry this session's date. */ marketReturn?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - marketReturn?: number; default: not declared — Present when `marketReturns` were supplied and carry this session's date. - tradingSessionDate: string; default: not declared ### @insiderfinance/totalfinance/research#ExpectedReturnModelInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The declared expected-return model — a closed union; `'custom'` is the structural escape. ```typescript /** The declared expected-return model — a closed union; `'custom'` is the structural escape. */ export type ExpectedReturnModelInput = { model: 'mean-adjusted'; } | { model: 'market-adjusted'; } | { model: 'market'; } | { model: 'custom'; expectedReturn: (context: ExpectedReturnContext) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedReturn: (context: ExpectedReturnContext) => number; default: not declared - expectedReturn(context): ExpectedReturnContext; default: not declared - expectedReturn(context).instrumentId: string; default: not declared - expectedReturn(context).marketReturn?: number; default: not declared — Present when `marketReturns` were supplied and carry this session's date. - expectedReturn(context).tradingSessionDate: string; default: not declared - model: ('custom') | ('market') | ('market-adjusted') | ('mean-adjusted'); default: not declared ### @insiderfinance/totalfinance/research#FactorCoverage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Coverage of a factor vector: what fraction of entries carry a value. ```typescript /** Coverage of a factor vector: what fraction of entries carry a value. */ export interface FactorCoverage { entryCount: number; valuedCount: number; coverageFraction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coverageFraction: number; default: not declared - entryCount: number; default: not declared - valuedCount: number; default: not declared ### @insiderfinance/totalfinance/research#FactorDecayInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link factorDecay}. ```typescript /** Input for {@link factorDecay}. */ export interface FactorDecayInput { factorEntries: readonly FactorEntry[]; /** Forward returns at increasing horizons, each labeled. */ horizons: readonly { horizonLabel: string; forwardReturns: readonly FactorEntry[]; }[]; minimumCoverageFraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factorEntries: readonly FactorEntry[]; default: not declared - horizons: readonly { horizonLabel: string; forwardReturns: readonly FactorEntry[]; }[]; default: not declared — Forward returns at increasing horizons, each labeled. - minimumCoverageFraction?: number; default: not declared ### @insiderfinance/totalfinance/research#FactorDecayResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link factorDecay}. ```typescript /** Result of {@link factorDecay}. */ export interface FactorDecayResult { assumptions: { coefficient: 'rank information coefficient per horizon'; minimumCoverageFraction: number; }; diagnostics: { warnings: string[]; }; byHorizon: Array<{ horizonLabel: string; rankInformationCoefficient: number | null; pairedCount: number; reason?: string; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { coefficient: 'rank information coefficient per horizon'; minimumCoverageFraction: number; }; default: not declared - assumptions.coefficient: 'rank information coefficient per horizon'; default: not declared - assumptions.minimumCoverageFraction: number; default: not declared - byHorizon: { horizonLabel: string; rankInformationCoefficient: number | null; pairedCount: number; reason?: string; }[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#FactorEntry Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One instrument's factor value at a cross-section; `null` = the source had no value. ```typescript // --------------------------------------------------------------------------------------------------- // The factor vector // --------------------------------------------------------------------------------------------------- /** One instrument's factor value at a cross-section; `null` = the source had no value. */ export interface FactorEntry { instrumentId: string; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - value: number | null; default: not declared ### @insiderfinance/totalfinance/research#FactorRecipe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A versioned factor recipe: everything the factor DOES, disclosed — features, transforms, direction, lag, neutralization, weights, and the missing-value policy. A recipe is data; the raw transforms above remain available for any definition a caller prefers. ```typescript /** * A versioned factor recipe: everything the factor DOES, disclosed — features, transforms, * direction, lag, neutralization, weights, and the missing-value policy. A recipe is data; the * raw transforms above remain available for any definition a caller prefers. */ export interface FactorRecipe { recipeName: string; recipeVersion: number; /** The disclosure every canonical recipe carries: a definition, not the definition. */ disclosure: string; direction: 'higher-is-better' | 'lower-is-better'; features: readonly FactorRecipeFeature[]; /** Sessions between the information date and use — the lookahead guard. */ lagTradingSessions: number; neutralization: 'none' | 'sector' | 'sector-and-size'; missingValuePolicy: 'exclude' | 'renormalize-weights'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 'higher-is-better' | 'lower-is-better'; default: not declared - disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - features: readonly FactorRecipeFeature[]; default: not declared - lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - recipeName: string; default: not declared - recipeVersion: number; default: not declared ### @insiderfinance/totalfinance/research#FactorRecipeFeature Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One feature inside a recipe. ```typescript // --------------------------------------------------------------------------------------------------- // Factor recipes — versioned artifacts, not universal truths // --------------------------------------------------------------------------------------------------- /** One feature inside a recipe. */ export interface FactorRecipeFeature { field: string; transform: 'raw' | 'winsorize-then-z-score' | 'percentile-rank'; weight: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - field: string; default: not declared - transform: 'raw' | 'percentile-rank' | 'winsorize-then-z-score'; default: not declared - weight: number; default: not declared ### @insiderfinance/totalfinance/research#FactorSpreadReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link factorSpreadReturn}. ```typescript /** Input for {@link factorSpreadReturn}. */ export interface FactorSpreadReturnInput { entries: readonly FactorEntry[]; forwardReturns: readonly FactorEntry[]; quantileCount: number; /** `'descending'`: portfolio 1 (highest factor) is the LONG leg. */ direction: 'ascending' | 'descending'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 (highest factor) is the LONG leg. - entries: readonly FactorEntry[]; default: not declared - forwardReturns: readonly FactorEntry[]; default: not declared - quantileCount: number; default: not declared ### @insiderfinance/totalfinance/research#FactorSpreadReturnResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link factorSpreadReturn}. ```typescript /** Result of {@link factorSpreadReturn}. */ export interface FactorSpreadReturnResult { assumptions: { quantileCount: number; direction: 'ascending' | 'descending'; legWeighting: 'equal weight within each leg'; }; diagnostics: { warnings: string[]; longLegCount: number; shortLegCount: number; }; /** Mean forward return of portfolio 1 minus portfolio N, or null with the reason. */ spreadReturn: number | null; longLegMeanReturn: number | null; shortLegMeanReturn: number | null; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { direction: 'ascending' | 'descending'; legWeighting: 'equal weight within each leg'; quantileCount: number; }; default: not declared - assumptions.direction: 'ascending' | 'descending'; default: not declared - assumptions.legWeighting: 'equal weight within each leg'; default: not declared - assumptions.quantileCount: number; default: not declared - diagnostics: { longLegCount: number; shortLegCount: number; warnings: string[]; }; default: not declared - diagnostics.longLegCount: number; default: not declared - diagnostics.shortLegCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - longLegMeanReturn: number | null; default: not declared - reason?: string; default: not declared - shortLegMeanReturn: number | null; default: not declared - spreadReturn: number | null; default: not declared — Mean forward return of portfolio 1 minus portfolio N, or null with the reason. ### @insiderfinance/totalfinance/research#FactorTurnoverInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link factorTurnover}. ```typescript /** Input for {@link factorTurnover}. */ export interface FactorTurnoverInput { previousPortfolios: FormQuantilePortfoliosResult['portfolios']; currentPortfolios: FormQuantilePortfoliosResult['portfolios']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currentPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - previousPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared ### @insiderfinance/totalfinance/research#FactorTurnoverResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link factorTurnover}. ```typescript /** Result of {@link factorTurnover}. */ export interface FactorTurnoverResult { assumptions: { definition: 'fraction of the current portfolio not present in the previous one'; }; diagnostics: { warnings: string[]; }; byQuantile: Array<{ quantileIndex: number; turnover: number | null; reason?: string; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { definition: 'fraction of the current portfolio not present in the previous one'; }; default: not declared - assumptions.definition: 'fraction of the current portfolio not present in the previous one'; default: not declared - byQuantile: { quantileIndex: number; turnover: number | null; reason?: string; }[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#FieldDefinition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One declared feature: research fields are DECLARED, never guessed from the data. ```typescript /** One declared feature: research fields are DECLARED, never guessed from the data. */ export interface FieldDefinition { fieldName: string; kind: FieldKind; /** The unit of a numeric field (e.g. 'decimal ratio', 'USD', 'days') — recorded and compared. */ unit?: string; description?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - description?: string; default: not declared - fieldName: string; default: not declared - kind: FieldKind; default: not declared - unit?: string; default: not declared — The unit of a numeric field (e.g. 'decimal ratio', 'USD', 'days') — recorded and compared. ### @insiderfinance/totalfinance/research#FieldKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What kind of value a declared field carries. ```typescript // --------------------------------------------------------------------------------------------------- // Field definitions // --------------------------------------------------------------------------------------------------- /** What kind of value a declared field carries. */ export type FieldKind = 'numeric' | 'category' | 'text' | 'boolean'; ``` ### @insiderfinance/totalfinance/research#FormQuantilePortfoliosInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link formQuantilePortfolios}. ```typescript // --------------------------------------------------------------------------------------------------- // Quantile portfolios // --------------------------------------------------------------------------------------------------- /** Input for {@link formQuantilePortfolios}. */ export interface FormQuantilePortfoliosInput { entries: readonly FactorEntry[]; /** How many portfolios (e.g. 5 = quintiles). */ quantileCount: number; /** `'descending'`: portfolio 1 holds the HIGHEST values (the conventional long leg). */ direction: 'ascending' | 'descending'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 holds the HIGHEST values (the conventional long leg). - entries: readonly FactorEntry[]; default: not declared - quantileCount: number; default: not declared — How many portfolios (e.g. 5 = quintiles). ### @insiderfinance/totalfinance/research#FormQuantilePortfoliosResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link formQuantilePortfolios}. ```typescript /** Result of {@link formQuantilePortfolios}. */ export interface FormQuantilePortfoliosResult { assumptions: { quantileCount: number; direction: 'ascending' | 'descending'; tieBreaker: 'instrumentId ascending'; sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; }; diagnostics: { warnings: string[]; coverage: FactorCoverage; excludedMissingCount: number; }; portfolios: Array<{ quantileIndex: number; instrumentIds: string[]; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { direction: 'ascending' | 'descending'; quantileCount: number; sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; tieBreaker: 'instrumentId ascending'; }; default: not declared - assumptions.direction: 'ascending' | 'descending'; default: not declared - assumptions.quantileCount: number; default: not declared - assumptions.sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; default: not declared - assumptions.tieBreaker: 'instrumentId ascending'; default: not declared - diagnostics: { coverage: FactorCoverage; excludedMissingCount: number; warnings: string[]; }; default: not declared - diagnostics.coverage: FactorCoverage; default: not declared - diagnostics.coverage.coverageFraction: number; default: not declared - diagnostics.coverage.entryCount: number; default: not declared - diagnostics.coverage.valuedCount: number; default: not declared - diagnostics.excludedMissingCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - portfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared ### @insiderfinance/totalfinance/research#IdentityComparisonOperator Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equality comparisons; runtime field declarations decide which value kind is compatible. ```typescript /** Equality comparisons; runtime field declarations decide which value kind is compatible. */ export type IdentityComparisonOperator = 'equals' | 'notEquals'; ``` ### @insiderfinance/totalfinance/research#InformationCoefficientInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link informationCoefficient}. ```typescript // --------------------------------------------------------------------------------------------------- // Information coefficient and diagnostics // --------------------------------------------------------------------------------------------------- /** Input for {@link informationCoefficient}. */ export interface InformationCoefficientInput { factorEntries: readonly FactorEntry[]; /** Forward returns over the evaluation horizon, keyed by instrument. */ forwardReturns: readonly FactorEntry[]; minimumCoverageFraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factorEntries: readonly FactorEntry[]; default: not declared - forwardReturns: readonly FactorEntry[]; default: not declared — Forward returns over the evaluation horizon, keyed by instrument. - minimumCoverageFraction?: number; default: not declared ### @insiderfinance/totalfinance/research#InformationCoefficientResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link informationCoefficient}. ```typescript /** Result of {@link informationCoefficient}. */ export interface InformationCoefficientResult { assumptions: { pearsonBasis: 'values'; rankBasis: 'average ranks (Spearman)'; minimumCoverageFraction: number; }; diagnostics: { warnings: string[]; pairedCount: number; }; /** Pearson correlation of factor values with forward returns, or null with the reason. */ informationCoefficient: number | null; /** Spearman (rank) correlation, or null with the reason. */ rankInformationCoefficient: number | null; reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { minimumCoverageFraction: number; pearsonBasis: 'values'; rankBasis: 'average ranks (Spearman)'; }; default: not declared - assumptions.minimumCoverageFraction: number; default: not declared - assumptions.pearsonBasis: 'values'; default: not declared - assumptions.rankBasis: 'average ranks (Spearman)'; default: not declared - diagnostics: { pairedCount: number; warnings: string[]; }; default: not declared - diagnostics.pairedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - informationCoefficient: number | null; default: not declared — Pearson correlation of factor values with forward returns, or null with the reason. - rankInformationCoefficient: number | null; default: not declared — Spearman (rank) correlation, or null with the reason. - reason?: string; default: not declared ### @insiderfinance/totalfinance/research#MarketEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One market event (FC3 frozen contract) — announcement time is the information instant. ```typescript // --------------------------------------------------------------------------------------------------- // Market events (spec-frozen contract) and return observations // --------------------------------------------------------------------------------------------------- /** One market event (FC3 frozen contract) — announcement time is the information instant. */ export interface MarketEvent { eventId: string; instrumentId: string; /** A caller vocabulary ('earnings', 'guidance', …) — recorded, never interpreted. */ eventType: string; announcedTimestampMs: EpochMs; /** When the event takes economic effect, where that differs from the announcement. */ effectiveTimestampMs?: EpochMs; /** Source-specific extras, preserved verbatim and never consumed by compute functions. */ metadata?: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - announcedTimestampMs: number; default: not declared - effectiveTimestampMs?: number; default: not declared — When the event takes economic effect, where that differs from the announcement. - eventId: string; default: not declared - eventType: string; default: not declared — A caller vocabulary ('earnings', 'guidance', …) — recorded, never interpreted. - instrumentId: string; default: not declared - metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. ### @insiderfinance/totalfinance/research#MarketReturnObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One market (index/benchmark) return for one trading session. ```typescript /** One market (index/benchmark) return for one trading session. */ export interface MarketReturnObservation { /** Strict `YYYY-MM-DD` trading-session date. */ tradingSessionDate: string; /** Simple (arithmetic) market return over the session, as a decimal. */ simpleReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - simpleReturn: number; default: not declared — Simple (arithmetic) market return over the session, as a decimal. - tradingSessionDate: string; default: not declared — Strict `YYYY-MM-DD` trading-session date. ### @insiderfinance/totalfinance/research#MissingValuePolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How rows with a missing value at a consumed field are handled. `'exclude'` is the safe default. ```typescript // --------------------------------------------------------------------------------------------------- // Shared eligibility resolution // --------------------------------------------------------------------------------------------------- /** How rows with a missing value at a consumed field are handled. `'exclude'` is the safe default. */ export type MissingValuePolicy = 'exclude' | 'evaluate-as-false'; ``` ### @insiderfinance/totalfinance/research#NeutralizeFactorInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link neutralizeFactor}. ```typescript // --------------------------------------------------------------------------------------------------- // Neutralization // --------------------------------------------------------------------------------------------------- /** Input for {@link neutralizeFactor}. */ export interface NeutralizeFactorInput { entries: readonly FactorEntry[]; /** Category memberships (sector/industry): the group mean is removed within each group. */ groups?: readonly { instrumentId: string; group: string; }[]; /** Continuous exposures (size, beta, …): the cross-sectional OLS projection is removed. */ exposures?: readonly { instrumentId: string; exposures: readonly number[]; }[]; minimumCoverageFraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entries: readonly FactorEntry[]; default: not declared - exposures?: readonly { instrumentId: string; exposures: readonly number[]; }[]; default: not declared — Continuous exposures (size, beta, …): the cross-sectional OLS projection is removed. - groups?: readonly { instrumentId: string; group: string; }[]; default: not declared — Category memberships (sector/industry): the group mean is removed within each group. - minimumCoverageFraction?: number; default: not declared ### @insiderfinance/totalfinance/research#NeutralizeFactorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link neutralizeFactor}. ```typescript /** Result of {@link neutralizeFactor}. */ export interface NeutralizeFactorResult { assumptions: { groupNeutralization: boolean; continuousNeutralization: boolean; /** Continuous fit always includes an intercept, so residuals are mean-zero. */ intercept: 'included'; minimumCoverageFraction: number; }; diagnostics: { warnings: string[]; coverage: FactorCoverage; groupCount?: number; exposureCount?: number; /** Entries dropped because their group or exposure row was absent, tallied. */ exclusionReasons: Record; }; entries: FactorEntry[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { continuousNeutralization: boolean; groupNeutralization: boolean; intercept: 'included'; minimumCoverageFraction: number; }; default: not declared - assumptions.continuousNeutralization: boolean; default: not declared - assumptions.groupNeutralization: boolean; default: not declared - assumptions.intercept: 'included'; default: not declared — Continuous fit always includes an intercept, so residuals are mean-zero. - assumptions.minimumCoverageFraction: number; default: not declared - diagnostics: { coverage: FactorCoverage; exclusionReasons: Record; exposureCount?: number; groupCount?: number; warnings: string[]; }; default: not declared - diagnostics.coverage: FactorCoverage; default: not declared - diagnostics.coverage.coverageFraction: number; default: not declared - diagnostics.coverage.entryCount: number; default: not declared - diagnostics.coverage.valuedCount: number; default: not declared - diagnostics.exclusionReasons: Record; default: not declared — Entries dropped because their group or exposure row was absent, tallied. - diagnostics.exposureCount?: number; default: not declared - diagnostics.groupCount?: number; default: not declared - diagnostics.warnings: string[]; default: not declared - entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#ObservedValue Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One observed value: a declared field's value, or `null` where the source had none. ```typescript /** One observed value: a declared field's value, or `null` where the source had none. */ export type ObservedValue = number | string | boolean | null; ``` ### @insiderfinance/totalfinance/research#OrderingComparisonOperator Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Numeric ordering comparisons over one declared field. ```typescript // --------------------------------------------------------------------------------------------------- // The filter grammar // --------------------------------------------------------------------------------------------------- /** Numeric ordering comparisons over one declared field. */ export type OrderingComparisonOperator = 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual'; ``` ### @insiderfinance/totalfinance/research#OverlappingEventPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How same-instrument window collisions are handled. REQUIRED — no default. ```typescript /** How same-instrument window collisions are handled. REQUIRED — no default. */ export type OverlappingEventPolicy = 'reject' | 'allow-contaminated'; ``` ### @insiderfinance/totalfinance/research#RankTiePolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How tied values rank. Every policy is stable (ties enumerate by instrumentId ascending). ```typescript // --------------------------------------------------------------------------------------------------- // rankUniverse // --------------------------------------------------------------------------------------------------- /** How tied values rank. Every policy is stable (ties enumerate by instrumentId ascending). */ export type RankTiePolicy = 'competition' | 'dense' | 'ordinal'; ``` ### @insiderfinance/totalfinance/research#RankUniverseInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link rankUniverse}. ```typescript /** Input for {@link rankUniverse}. */ export interface RankUniverseInput { universeId: string; asOf: EpochMs; observations: readonly UniverseObservation[]; fieldDefinitions: readonly FieldDefinition[]; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: RankTiePolicy; missingValuePolicy: MissingValuePolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - fieldDefinitions: readonly FieldDefinition[]; default: not declared - missingValuePolicy: MissingValuePolicy; default: not declared - observations: readonly UniverseObservation[]; default: not declared - rankBy: { direction: 'ascending' | 'descending'; field: string; }; default: not declared - rankBy.direction: 'ascending' | 'descending'; default: not declared - rankBy.field: string; default: not declared - tiePolicy: RankTiePolicy; default: not declared - universeId: string; default: not declared ### @insiderfinance/totalfinance/research#RankUniverseResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link rankUniverse}. ```typescript /** Result of {@link rankUniverse}. */ export interface RankUniverseResult { assumptions: { universeId: string; asOf: EpochMs; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: RankTiePolicy; missingValuePolicy: MissingValuePolicy; finalTieBreaker: 'instrumentId ascending'; versionResolution: 'latest available at or before asOf per instrument'; }; diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; rankedCount: number; excludedCount: number; exclusionReasons: Record; }; rows: Array<{ instrumentId: string; value: number; rank: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: EpochMs; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: MissingValuePolicy; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: RankTiePolicy; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - assumptions.missingValuePolicy: MissingValuePolicy; default: not declared - assumptions.rankBy: { direction: 'ascending' | 'descending'; field: string; }; default: not declared - assumptions.rankBy.direction: 'ascending' | 'descending'; default: not declared - assumptions.rankBy.field: string; default: not declared - assumptions.tiePolicy: RankTiePolicy; default: not declared - assumptions.universeId: string; default: not declared - assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; rankedCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - diagnostics.eligibleCount: number; default: not declared - diagnostics.excludedCount: number; default: not declared - diagnostics.exclusionReasons: Record; default: not declared - diagnostics.rankedCount: number; default: not declared - diagnostics.suppliedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - rows: { instrumentId: string; value: number; rank: number; }[]; default: not declared ### @insiderfinance/totalfinance/research#ReturnObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One per-session simple return for one instrument — the event-study raw material. ```typescript /** One per-session simple return for one instrument — the event-study raw material. */ export interface ReturnObservation { instrumentId: string; /** Strict `YYYY-MM-DD` trading-session date. */ tradingSessionDate: string; /** Simple (arithmetic) return over the session, as a decimal. */ simpleReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instrumentId: string; default: not declared - simpleReturn: number; default: not declared — Simple (arithmetic) return over the session, as a decimal. - tradingSessionDate: string; default: not declared — Strict `YYYY-MM-DD` trading-session date. ### @insiderfinance/totalfinance/research#ScoreComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One weighted component of a composite score. ```typescript // --------------------------------------------------------------------------------------------------- // scoreUniverse // --------------------------------------------------------------------------------------------------- /** One weighted component of a composite score. */ export interface ScoreComponent { field: string; /** Positive weight; the component set is normalized and the normalized weights echoed. */ weight: number; direction: 'higher-is-better' | 'lower-is-better'; standardization: 'z-score' | 'percentile-rank'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 'higher-is-better' | 'lower-is-better'; default: not declared - field: string; default: not declared - standardization: 'z-score' | 'percentile-rank'; default: not declared - weight: number; default: not declared — Positive weight; the component set is normalized and the normalized weights echoed. ### @insiderfinance/totalfinance/research#ScoreUniverseInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link scoreUniverse}. ```typescript /** Input for {@link scoreUniverse}. */ export interface ScoreUniverseInput { universeId: string; asOf: EpochMs; observations: readonly UniverseObservation[]; fieldDefinitions: readonly FieldDefinition[]; components: readonly ScoreComponent[]; /** * `'exclude'`: a row missing ANY component is dropped with the reason. * `'renormalize-weights'`: the row scores over its PRESENT components with weights renormalized * — disclosed per policy, never per row silently. */ missingValuePolicy: 'exclude' | 'renormalize-weights'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - components: readonly ScoreComponent[]; default: not declared - fieldDefinitions: readonly FieldDefinition[]; default: not declared - missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'`: a row missing ANY component is dropped with the reason. `'renormalize-weights'`: the row scores over its PRESENT components with weights renormalized — disclosed per policy, never per row silently. - observations: readonly UniverseObservation[]; default: not declared - universeId: string; default: not declared ### @insiderfinance/totalfinance/research#ScoreUniverseResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link scoreUniverse}. ```typescript /** Result of {@link scoreUniverse}. */ export interface ScoreUniverseResult { assumptions: { universeId: string; asOf: EpochMs; components: Array; missingValuePolicy: 'exclude' | 'renormalize-weights'; finalTieBreaker: 'instrumentId ascending'; versionResolution: 'latest available at or before asOf per instrument'; }; diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; scoredCount: number; excludedCount: number; exclusionReasons: Record; }; rows: Array<{ instrumentId: string; score: number; componentsUsed: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: EpochMs; components: Array; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: 'exclude' | 'renormalize-weights'; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.components: (ScoreComponent & { normalizedWeight: number; })[]; default: not declared - assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - assumptions.universeId: string; default: not declared - assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; scoredCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - diagnostics.eligibleCount: number; default: not declared - diagnostics.excludedCount: number; default: not declared - diagnostics.exclusionReasons: Record; default: not declared - diagnostics.scoredCount: number; default: not declared - diagnostics.suppliedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - rows: { instrumentId: string; score: number; componentsUsed: number; }[]; default: not declared ### @insiderfinance/totalfinance/research#ScreenFilter Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed, serializable filter grammar. ```typescript /** The closed, serializable filter grammar. */ export type ScreenFilter = { all: readonly ScreenFilter[]; } | { any: readonly ScreenFilter[]; } | { not: ScreenFilter; } | { field: string; operator: OrderingComparisonOperator; value: number; } | { field: string; operator: IdentityComparisonOperator; value: number | string | boolean; } | { field: string; operator: 'between'; from: number; to: number; } | { field: string; operator: 'in' | 'notIn'; values: readonly (number | string)[]; } | { field: string; operator: 'isPresent' | 'isMissing'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - all: readonly ScreenFilter[]; default: not declared - any: readonly ScreenFilter[]; default: not declared - field: string; default: not declared - from: number; default: not declared - not: ScreenFilter; default: not declared - operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (IdentityComparisonOperator) | (OrderingComparisonOperator); default: not declared - to: number; default: not declared - value: (number) | (string | number | boolean); default: not declared - values: readonly (string | number)[]; default: not declared ### @insiderfinance/totalfinance/research#ScreenOrdering Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One ordering key. ```typescript // --------------------------------------------------------------------------------------------------- // screenUniverse // --------------------------------------------------------------------------------------------------- /** One ordering key. */ export interface ScreenOrdering { field: string; direction: 'ascending' | 'descending'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 'ascending' | 'descending'; default: not declared - field: string; default: not declared ### @insiderfinance/totalfinance/research#ScreenUniverseInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link screenUniverse}. ```typescript /** Input for {@link screenUniverse}. */ export interface ScreenUniverseInput { /** The universe's identity, echoed — a screen without provenance is a number without a source. */ universeId: string; asOf: EpochMs; observations: readonly UniverseObservation[]; fieldDefinitions: readonly FieldDefinition[]; /** The serializable filter. Omitted → every eligible row passes (ordering still applies). */ filter?: ScreenFilter; /** * The explicit NON-SERIALIZABLE escape hatch: a caller predicate over the observation. Its * presence is classified in `assumptions.customPredicate` so a stored screen recipe cannot * silently claim reproducibility it does not have. */ customPredicate?: (observation: UniverseObservation) => boolean; missingValuePolicy: MissingValuePolicy; /** Ordering keys; `instrumentId` ascending is ALWAYS appended as the stable final tie-breaker. */ orderBy: readonly ScreenOrdering[]; /** Keep at most this many rows after ordering; a non-negative safe integer. Omit for all rows. */ limit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - customPredicate?: (observation: UniverseObservation) => boolean; default: not declared — The explicit NON-SERIALIZABLE escape hatch: a caller predicate over the observation. Its presence is classified in `assumptions.customPredicate` so a stored screen recipe cannot silently claim reproducibility it does not have. - customPredicate(observation): UniverseObservation; default: not declared - customPredicate(observation).availableTimestampMs: number; default: not declared - customPredicate(observation).fields: Record; default: not declared — Values for DECLARED fields only; a key with no declaration is a teaching error. - customPredicate(observation).instrumentId: string; default: not declared - fieldDefinitions: readonly FieldDefinition[]; default: not declared - filter?: ScreenFilter; default: not declared — The serializable filter. Omitted → every eligible row passes (ordering still applies). - filter.all: readonly ScreenFilter[]; default: not declared - filter.any: readonly ScreenFilter[]; default: not declared - filter.field: string; default: not declared - filter.from: number; default: not declared - filter.not: ScreenFilter; default: not declared - filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (IdentityComparisonOperator) | (OrderingComparisonOperator); default: not declared - filter.to: number; default: not declared - filter.value: (number) | (string | number | boolean); default: not declared - filter.values: readonly (string | number)[]; default: not declared - limit?: number; default: not declared — Keep at most this many rows after ordering; a non-negative safe integer. Omit for all rows. - missingValuePolicy: MissingValuePolicy; default: not declared - observations: readonly UniverseObservation[]; default: not declared - orderBy: readonly ScreenOrdering[]; default: not declared — Ordering keys; `instrumentId` ascending is ALWAYS appended as the stable final tie-breaker. - universeId: string; default: not declared — The universe's identity, echoed — a screen without provenance is a number without a source. ### @insiderfinance/totalfinance/research#ScreenUniverseResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link screenUniverse}. ```typescript /** Result of {@link screenUniverse}. */ export interface ScreenUniverseResult { assumptions: { universeId: string; asOf: EpochMs; missingValuePolicy: MissingValuePolicy; orderBy: readonly ScreenOrdering[]; /** The stable final ordering key, always applied — determinism under input permutation. */ finalTieBreaker: 'instrumentId ascending'; limit?: number; /** Present exactly when a caller predicate participated. */ customPredicate?: 'non-serializable caller predicate'; versionResolution: 'latest available at or before asOf per instrument'; }; diagnostics: { warnings: string[]; suppliedCount: number; eligibleCount: number; includedCount: number; excludedCount: number; /** Every exclusion, tallied by reason. */ exclusionReasons: Record; }; rows: ScreenedRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: EpochMs; customPredicate?: 'non-serializable caller predicate'; finalTieBreaker: 'instrumentId ascending'; limit?: number; missingValuePolicy: MissingValuePolicy; orderBy: readonly ScreenOrdering[]; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.customPredicate?: 'non-serializable caller predicate'; default: not declared — Present exactly when a caller predicate participated. - assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared — The stable final ordering key, always applied — determinism under input permutation. - assumptions.limit?: number; default: not declared - assumptions.missingValuePolicy: MissingValuePolicy; default: not declared - assumptions.orderBy: readonly ScreenOrdering[]; default: not declared - assumptions.universeId: string; default: not declared - assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; includedCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - diagnostics.eligibleCount: number; default: not declared - diagnostics.excludedCount: number; default: not declared - diagnostics.exclusionReasons: Record; default: not declared — Every exclusion, tallied by reason. - diagnostics.includedCount: number; default: not declared - diagnostics.suppliedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - rows: ScreenedRow[]; default: not declared ### @insiderfinance/totalfinance/research#ScreenedRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One screened row. ```typescript /** One screened row. */ export interface ScreenedRow { instrumentId: string; availableTimestampMs: EpochMs; fields: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - availableTimestampMs: number; default: not declared - fields: Record; default: not declared - instrumentId: string; default: not declared ### @insiderfinance/totalfinance/research#StandardizeFactorInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link standardizeFactor}. ```typescript // --------------------------------------------------------------------------------------------------- // Standardization // --------------------------------------------------------------------------------------------------- /** Input for {@link standardizeFactor}. */ export interface StandardizeFactorInput { entries: readonly FactorEntry[]; method: 'z-score' | 'percentile-rank'; minimumCoverageFraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entries: readonly FactorEntry[]; default: not declared - method: 'z-score' | 'percentile-rank'; default: not declared - minimumCoverageFraction?: number; default: not declared ### @insiderfinance/totalfinance/research#StandardizeFactorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link standardizeFactor}. ```typescript /** Result of {@link standardizeFactor}. */ export interface StandardizeFactorResult { assumptions: { method: 'z-score' | 'percentile-rank'; minimumCoverageFraction: number; /** Echoed z-score moments (absent for percentile ranks). */ mean?: number; sampleStandardDeviation?: number; tieHandling: 'average rank'; }; diagnostics: { warnings: string[]; coverage: FactorCoverage; }; entries: FactorEntry[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { mean?: number; method: 'z-score' | 'percentile-rank'; minimumCoverageFraction: number; sampleStandardDeviation?: number; tieHandling: 'average rank'; }; default: not declared - assumptions.mean?: number; default: not declared — Echoed z-score moments (absent for percentile ranks). - assumptions.method: 'z-score' | 'percentile-rank'; default: not declared - assumptions.minimumCoverageFraction: number; default: not declared - assumptions.sampleStandardDeviation?: number; default: not declared - assumptions.tieHandling: 'average rank'; default: not declared - diagnostics: { coverage: FactorCoverage; warnings: string[]; }; default: not declared - diagnostics.coverage: FactorCoverage; default: not declared - diagnostics.coverage.coverageFraction: number; default: not declared - diagnostics.coverage.entryCount: number; default: not declared - diagnostics.coverage.valuedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#TradingSessionWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An inclusive event-relative session window; offset 0 is the event session. ```typescript /** An inclusive event-relative session window; offset 0 is the event session. */ export interface TradingSessionWindow { startTradingSessionOffset: number; endTradingSessionOffset: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - endTradingSessionOffset: number; default: not declared - startTradingSessionOffset: number; default: not declared ### @insiderfinance/totalfinance/research#UniverseExit Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface UniverseExit { instrumentId: string; exitTimestampMs: EpochMs; exitReason: UniverseExitReason | null; delistingReturn: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delistingReturn: number | null; default: not declared - exitReason: UniverseExitReason | null; default: not declared - exitTimestampMs: number; default: not declared - instrumentId: string; default: not declared ### @insiderfinance/totalfinance/research#UniverseExitReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // Types // --------------------------------------------------------------------------------------------------- export type UniverseExitReason = 'removed' | 'delisted' | 'merged' | 'other'; ``` ### @insiderfinance/totalfinance/research#UniverseHistory Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface UniverseHistory { universeId: string; members: readonly UniverseMember[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - members: readonly UniverseMember[]; default: not declared - universeId: string; default: not declared ### @insiderfinance/totalfinance/research#UniverseMember Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One membership interval of one instrument. Half-open: `[fromTimestampMs, toTimestampMs)`. ```typescript /** One membership interval of one instrument. Half-open: `[fromTimestampMs, toTimestampMs)`. */ export interface UniverseMember { instrumentId: string; /** First instant the name is a member (inclusive). */ fromTimestampMs: EpochMs; /** First instant it is no longer a member (exclusive); omitted = still a member. */ toTimestampMs?: EpochMs; exitReason?: UniverseExitReason; /** * The simple return a holder earned from the last available price to the exit — a delisting * return (−1 for a total loss). Required by a simulator when `exitReason` is `'delisted'` and a * position is open; recorded here so the fact travels with the universe, not the strategy. */ delistingReturn?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delistingReturn?: number; default: not declared — The simple return a holder earned from the last available price to the exit — a delisting return (−1 for a total loss). Required by a simulator when `exitReason` is `'delisted'` and a position is open; recorded here so the fact travels with the universe, not the strategy. - exitReason?: UniverseExitReason; default: not declared - fromTimestampMs: number; default: not declared — First instant the name is a member (inclusive). - instrumentId: string; default: not declared - toTimestampMs?: number; default: not declared — First instant it is no longer a member (exclusive); omitted = still a member. ### @insiderfinance/totalfinance/research#UniverseMembershipAtInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // --------------------------------------------------------------------------------------------------- // universeMembershipAt // --------------------------------------------------------------------------------------------------- export interface UniverseMembershipAtInput { universeHistory: UniverseHistory; /** The decision instant. */ asOf: EpochMs; /** * The previous decision instant. When given, `additions` and `exits` describe what changed in * `(previousAsOf, asOf]`; when omitted both are empty and only `instrumentIds` is meaningful. */ previousAsOf?: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared — The decision instant. - previousAsOf?: number; default: not declared — The previous decision instant. When given, `additions` and `exits` describe what changed in `(previousAsOf, asOf]`; when omitted both are empty and only `instrumentIds` is meaningful. - universeHistory: UniverseHistory; default: not declared - universeHistory.members: readonly UniverseMember[]; default: not declared - universeHistory.universeId: string; default: not declared ### @insiderfinance/totalfinance/research#UniverseMembershipAtResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface UniverseMembershipAtResult { assumptions: { universeId: string; asOf: EpochMs; previousAsOf: EpochMs | null; membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; }; diagnostics: { warnings: string[]; memberCount: number; additionCount: number; exitCount: number; }; /** Members at `asOf`, `instrumentId` ascending. */ instrumentIds: string[]; /** Names whose membership began in `(previousAsOf, asOf]`, ascending. */ additions: string[]; /** Names whose membership ended in `(previousAsOf, asOf]`, ascending by id then instant. */ exits: UniverseExit[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - additions: string[]; default: not declared — Names whose membership began in `(previousAsOf, asOf]`, ascending. - assumptions: { asOf: EpochMs; membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; previousAsOf: EpochMs | null; universeId: string; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; default: not declared - assumptions.previousAsOf: number | null; default: not declared - assumptions.universeId: string; default: not declared - diagnostics: { additionCount: number; exitCount: number; memberCount: number; warnings: string[]; }; default: not declared - diagnostics.additionCount: number; default: not declared - diagnostics.exitCount: number; default: not declared - diagnostics.memberCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - exits: UniverseExit[]; default: not declared — Names whose membership ended in `(previousAsOf, asOf]`, ascending by id then instant. - instrumentIds: string[]; default: not declared — Members at `asOf`, `instrumentId` ascending. ### @insiderfinance/totalfinance/research#UniverseObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One universe row: an instrument's declared features as of an availability instant. `availableTimestampMs` controls point-in-time eligibility — the same law the fundamentals package states for filings: what an observer could not yet see does not exist for them. ```typescript /** * One universe row: an instrument's declared features as of an availability instant. * `availableTimestampMs` controls point-in-time eligibility — the same law the fundamentals * package states for filings: what an observer could not yet see does not exist for them. */ export interface UniverseObservation { instrumentId: string; availableTimestampMs: EpochMs; /** Values for DECLARED fields only; a key with no declaration is a teaching error. */ fields: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - availableTimestampMs: number; default: not declared - fields: Record; default: not declared — Values for DECLARED fields only; a key with no declaration is a teaching error. - instrumentId: string; default: not declared ### @insiderfinance/totalfinance/research#WinsorizationMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The explicit winsorization method — cutoffs are stated, never implied. ```typescript // --------------------------------------------------------------------------------------------------- // Winsorization // --------------------------------------------------------------------------------------------------- /** The explicit winsorization method — cutoffs are stated, never implied. */ export type WinsorizationMethod = { type: 'percentile'; lowerPercentile: number; upperPercentile: number; } | { type: 'standard-deviations'; multiplier: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lowerPercentile: number; default: not declared - multiplier: number; default: not declared - type: ('percentile') | ('standard-deviations'); default: not declared - upperPercentile: number; default: not declared ### @insiderfinance/totalfinance/research#WinsorizeFactorInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link winsorizeFactor}. ```typescript /** Input for {@link winsorizeFactor}. */ export interface WinsorizeFactorInput { entries: readonly FactorEntry[]; method: WinsorizationMethod; minimumCoverageFraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entries: readonly FactorEntry[]; default: not declared - method: WinsorizationMethod; default: not declared - method.lowerPercentile: number; default: not declared - method.multiplier: number; default: not declared - method.type: ('percentile') | ('standard-deviations'); default: not declared - method.upperPercentile: number; default: not declared - minimumCoverageFraction?: number; default: not declared ### @insiderfinance/totalfinance/research#WinsorizeFactorResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link winsorizeFactor}. ```typescript /** Result of {@link winsorizeFactor}. */ export interface WinsorizeFactorResult { assumptions: { method: WinsorizationMethod; minimumCoverageFraction: number; /** The realized clip bounds, so the transform is reproducible without the input. */ lowerBound: number; upperBound: number; }; diagnostics: { warnings: string[]; coverage: FactorCoverage; clippedLowerCount: number; clippedUpperCount: number; }; entries: FactorEntry[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { lowerBound: number; method: WinsorizationMethod; minimumCoverageFraction: number; upperBound: number; }; default: not declared - assumptions.lowerBound: number; default: not declared — The realized clip bounds, so the transform is reproducible without the input. - assumptions.method: WinsorizationMethod; default: not declared - assumptions.method.lowerPercentile: number; default: not declared - assumptions.method.multiplier: number; default: not declared - assumptions.method.type: ('percentile') | ('standard-deviations'); default: not declared - assumptions.method.upperPercentile: number; default: not declared - assumptions.minimumCoverageFraction: number; default: not declared - assumptions.upperBound: number; default: not declared - diagnostics: { clippedLowerCount: number; clippedUpperCount: number; coverage: FactorCoverage; warnings: string[]; }; default: not declared - diagnostics.clippedLowerCount: number; default: not declared - diagnostics.clippedUpperCount: number; default: not declared - diagnostics.coverage: FactorCoverage; default: not declared - diagnostics.coverage.coverageFraction: number; default: not declared - diagnostics.coverage.entryCount: number; default: not declared - diagnostics.coverage.valuedCount: number; default: not declared - diagnostics.warnings: string[]; default: not declared - entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#aggregateEventStudies Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pool the INCLUDED events of several {@link eventStudy} results and recompute AAR/CAAR and per-offset t-statistics across the pooled cross-section. Studies must share `sessionPolicy`, `cumulativeConvention`, and `eventWindow` — pooled per-offset statistics are meaningless otherwise, and a mismatch is refused naming both values. ```typescript export declare function aggregateEventStudies(input: AggregateEventStudiesInput): AggregateEventStudiesResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AggregateEventStudiesInput; default: not declared - (input).studies: readonly EventStudyResult[]; default: not declared - return.assumptions: AggregateEventStudiesAssumptions; default: not declared - return.averageAbnormalReturns: AverageAbnormalReturnRow[]; default: not declared - return.diagnostics: EventStudyDiagnostics; default: not declared - return.events: EventStudyEventResult[]; default: not declared - return.studiesAggregated: number; default: not declared ### @insiderfinance/totalfinance/research#alignEventWindows Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The alignment step of {@link eventStudy} alone: per event, the anchor session and the resolved event-window rows, or the exclusion reason. Runs the SAME anchoring code path as `eventStudy` — there is exactly one implementation of the session-policy rules in this module. ```typescript export declare function alignEventWindows(input: AlignEventWindowsInput): AlignEventWindowsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AlignEventWindowsInput; default: not declared - (input).eventWindow: TradingSessionWindow; default: not declared - (input).events: readonly MarketEvent[]; default: not declared - (input).returnObservations: readonly ReturnObservation[]; default: not declared - (input).sessionPolicy?: EventStudySessionPolicy; default: not declared — Default `'next-session'` — the same policy, the same code path, as {@link eventStudy}. - return.alignments: AlignedEventWindow[]; default: not declared - return.assumptions: { eventWindow: TradingSessionWindow; sessionPolicy: EventStudySessionPolicy; }; default: not declared - return.assumptions.eventWindow: TradingSessionWindow; default: not declared - return.assumptions.sessionPolicy: EventStudySessionPolicy; default: not declared - return.diagnostics: { eventsAligned: number; eventsSupplied: number; excludedEvents: { eventId: string; reason: string; }[]; warnings: string[]; }; default: not declared - return.diagnostics.eventsAligned: number; default: not declared - return.diagnostics.eventsSupplied: number; default: not declared - return.diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#compositeFactorScore Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Weighted composite of standardized factor vectors; direction flips signs so higher is better. ```typescript export declare function compositeFactorScore(input: CompositeFactorScoreInput): CompositeFactorScoreResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CompositeFactorScoreInput; default: not declared - (input).components: readonly CompositeComponent[]; default: not declared - (input).missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'` drops an instrument missing any component; `'renormalize-weights'` scores what is present. - return.assumptions: { components: Array<{ label: string; weight: number; normalizedWeight: number; direction: string; }>; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - return.assumptions.components: { label: string; weight: number; normalizedWeight: number; direction: string; }[]; default: not declared - return.assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - return.diagnostics: { exclusionReasons: Record; instrumentCount: number; scoredCount: number; warnings: string[]; }; default: not declared - return.diagnostics.exclusionReasons: Record; default: not declared - return.diagnostics.instrumentCount: number; default: not declared - return.diagnostics.scoredCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#eligibleObservationsAt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The observations a decision at `asOf` may see: available at or before the cutoff (an explicit session lag moves the cutoff back through the caller's session index), the latest version per instrument, and — when a universe history is given — members at `asOf` only. Shifting a row's `availableTimestampMs` past the cutoff removes it; the acceptance law every FC3 screen already satisfies, exposed for the simulators. ```typescript export declare function eligibleObservationsAt(input: EligibleObservationsAtInput): EligibleObservationsAtResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EligibleObservationsAtInput; default: not declared - (input).asOf: number; default: not declared - (input).fieldDefinitions: readonly FieldDefinition[]; default: not declared - (input).lag?: EligibilityLag; default: not declared — Omitted = no lag: availability at or before `asOf` is enough. - (input).observations: readonly UniverseObservation[]; default: not declared - (input).universeHistory?: UniverseHistory; default: not declared — When given, only members of this universe at `asOf` are eligible. - return.assumptions: { asOf: EpochMs; availabilityCutoffMs: EpochMs; lagTradingSessions: number; universeId: string | null; versionResolution: 'latest available at or before the cutoff per instrument'; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.availabilityCutoffMs: number; default: not declared — The instant availability is measured against: `asOf`, or the lagged session instant. - return.assumptions.lagTradingSessions: number; default: not declared - return.assumptions.universeId: string | null; default: not declared - return.assumptions.versionResolution: 'latest available at or before the cutoff per instrument'; default: not declared - return.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; suppliedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.eligibleCount: number; default: not declared - return.diagnostics.excludedCount: number; default: not declared - return.diagnostics.exclusionReasons: Record; default: not declared - return.diagnostics.suppliedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.observations: UniverseObservation[]; default: not declared — One observation per eligible instrument, `instrumentId` ascending. ### @insiderfinance/totalfinance/research#eventStudy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run an event study: anchor each event on its instrument's sessions under the declared session policy, model expected returns, and disclose abnormal returns per event and across events. Every convention is echoed in `assumptions`; every dropped event is named with its reason in `diagnostics.excludedEvents` — see the module header for the exact anchoring and overlap rules. ```typescript export declare function eventStudy(input: EventStudyInput): EventStudyResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EventStudyInput; default: not declared - (input).cumulativeConvention?: CumulativeConvention; default: not declared — Default `'sum'` (classic CAR) — documented and echoed. - (input).estimationWindow?: TradingSessionWindow; default: not declared — REQUIRED by `'mean-adjusted'` and `'market'`; must END strictly BEFORE the event window starts — a model estimated through the event measures the event twice. - (input).eventWindow: TradingSessionWindow; default: not declared — Integers, start ≤ end; offset 0 is the event session. - (input).events: readonly MarketEvent[]; default: not declared - (input).expectedReturnModel: ExpectedReturnModelInput; default: not declared - (input).marketReturns?: readonly MarketReturnObservation[]; default: not declared — Required by the `'market-adjusted'` and `'market'` models. - (input).overlappingEventPolicy: OverlappingEventPolicy; default: not declared — REQUIRED, no default — overlap handling changes the statistics, so the caller must choose. - (input).returnObservations: readonly ReturnObservation[]; default: not declared — Instrument returns per trading session — the sessions ARE these rows' distinct dates. - (input).sessionPolicy?: EventStudySessionPolicy; default: not declared — Default `'next-session'` — documented in the module header and echoed in assumptions. - return.assumptions: EventStudyAssumptions; default: not declared - return.averageAbnormalReturns: AverageAbnormalReturnRow[]; default: not declared - return.diagnostics: EventStudyDiagnostics; default: not declared - return.events: EventStudyEventResult[]; default: not declared ### @insiderfinance/totalfinance/research#factorDecay Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The factor's rank information coefficient at each stated horizon — its signal decay curve. ```typescript export declare function factorDecay(input: FactorDecayInput): FactorDecayResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FactorDecayInput; default: not declared - (input).factorEntries: readonly FactorEntry[]; default: not declared - (input).horizons: readonly { horizonLabel: string; forwardReturns: readonly FactorEntry[]; }[]; default: not declared — Forward returns at increasing horizons, each labeled. - (input).minimumCoverageFraction?: number; default: not declared - return.assumptions: { coefficient: 'rank information coefficient per horizon'; minimumCoverageFraction: number; }; default: not declared - return.assumptions.coefficient: 'rank information coefficient per horizon'; default: not declared - return.assumptions.minimumCoverageFraction: number; default: not declared - return.byHorizon: { horizonLabel: string; rankInformationCoefficient: number | null; pairedCount: number; reason?: string; }[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#factorSpreadReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Top-minus-bottom quantile forward return, equal-weighted within each leg. ```typescript export declare function factorSpreadReturn(input: FactorSpreadReturnInput): FactorSpreadReturnResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FactorSpreadReturnInput; default: not declared - (input).direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 (highest factor) is the LONG leg. - (input).entries: readonly FactorEntry[]; default: not declared - (input).forwardReturns: readonly FactorEntry[]; default: not declared - (input).quantileCount: number; default: not declared - return.assumptions: { direction: 'ascending' | 'descending'; legWeighting: 'equal weight within each leg'; quantileCount: number; }; default: not declared - return.assumptions.direction: 'ascending' | 'descending'; default: not declared - return.assumptions.legWeighting: 'equal weight within each leg'; default: not declared - return.assumptions.quantileCount: number; default: not declared - return.diagnostics: { longLegCount: number; shortLegCount: number; warnings: string[]; }; default: not declared - return.diagnostics.longLegCount: number; default: not declared - return.diagnostics.shortLegCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.longLegMeanReturn: number | null; default: not declared - return.reason?: string; default: not declared - return.shortLegMeanReturn: number | null; default: not declared - return.spreadReturn: number | null; default: not declared — Mean forward return of portfolio 1 minus portfolio N, or null with the reason. ### @insiderfinance/totalfinance/research#factorTurnover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-quantile membership turnover between two formations. ```typescript export declare function factorTurnover(input: FactorTurnoverInput): FactorTurnoverResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FactorTurnoverInput; default: not declared - (input).currentPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - (input).previousPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - return.assumptions: { definition: 'fraction of the current portfolio not present in the previous one'; }; default: not declared - return.assumptions.definition: 'fraction of the current portfolio not present in the previous one'; default: not declared - return.byQuantile: { quantileIndex: number; turnover: number | null; reason?: string; }[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared ### @insiderfinance/totalfinance/research#formQuantilePortfolios Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sort the valued entries and cut them into `quantileCount` portfolios. Every valued entry lands in EXACTLY one portfolio and no portfolio repeats a name — the acceptance law, by construction. ```typescript export declare function formQuantilePortfolios(input: FormQuantilePortfoliosInput): FormQuantilePortfoliosResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FormQuantilePortfoliosInput; default: not declared - (input).direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 holds the HIGHEST values (the conventional long leg). - (input).entries: readonly FactorEntry[]; default: not declared - (input).quantileCount: number; default: not declared — How many portfolios (e.g. 5 = quintiles). - return.assumptions: { direction: 'ascending' | 'descending'; quantileCount: number; sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; tieBreaker: 'instrumentId ascending'; }; default: not declared - return.assumptions.direction: 'ascending' | 'descending'; default: not declared - return.assumptions.quantileCount: number; default: not declared - return.assumptions.sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; default: not declared - return.assumptions.tieBreaker: 'instrumentId ascending'; default: not declared - return.diagnostics: { coverage: FactorCoverage; excludedMissingCount: number; warnings: string[]; }; default: not declared - return.diagnostics.coverage: FactorCoverage; default: not declared - return.diagnostics.excludedMissingCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.portfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared ### @insiderfinance/totalfinance/research#informationCoefficient Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The information coefficient: Pearson correlation of a factor with forward returns over the instruments carrying BOTH, plus the Spearman rank version. Fewer than three pairs or zero dispersion answers null with the reason — a correlation of nothing is not zero. ```typescript export declare function informationCoefficient(input: InformationCoefficientInput): InformationCoefficientResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InformationCoefficientInput; default: not declared - (input).factorEntries: readonly FactorEntry[]; default: not declared - (input).forwardReturns: readonly FactorEntry[]; default: not declared — Forward returns over the evaluation horizon, keyed by instrument. - (input).minimumCoverageFraction?: number; default: not declared - return.assumptions: { minimumCoverageFraction: number; pearsonBasis: 'values'; rankBasis: 'average ranks (Spearman)'; }; default: not declared - return.assumptions.minimumCoverageFraction: number; default: not declared - return.assumptions.pearsonBasis: 'values'; default: not declared - return.assumptions.rankBasis: 'average ranks (Spearman)'; default: not declared - return.diagnostics: { pairedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.pairedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.informationCoefficient: number | null; default: not declared — Pearson correlation of factor values with forward returns, or null with the reason. - return.rankInformationCoefficient: number | null; default: not declared — Spearman (rank) correlation, or null with the reason. - return.reason?: string; default: not declared ### @insiderfinance/totalfinance/research#neutralizeFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Neutralize a factor against sector/industry groups (demean within group) and/or continuous exposures (remove the OLS projection, intercept included). Residuals are orthogonal to every controlled exposure within numerical tolerance — the acceptance law, provable from the normal equations this solves. ```typescript export declare function neutralizeFactor(input: NeutralizeFactorInput): NeutralizeFactorResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NeutralizeFactorInput; default: not declared - (input).entries: readonly FactorEntry[]; default: not declared - (input).exposures?: readonly { instrumentId: string; exposures: readonly number[]; }[]; default: not declared — Continuous exposures (size, beta, …): the cross-sectional OLS projection is removed. - (input).groups?: readonly { instrumentId: string; group: string; }[]; default: not declared — Category memberships (sector/industry): the group mean is removed within each group. - (input).minimumCoverageFraction?: number; default: not declared - return.assumptions: { continuousNeutralization: boolean; groupNeutralization: boolean; intercept: 'included'; minimumCoverageFraction: number; }; default: not declared - return.assumptions.continuousNeutralization: boolean; default: not declared - return.assumptions.groupNeutralization: boolean; default: not declared - return.assumptions.intercept: 'included'; default: not declared — Continuous fit always includes an intercept, so residuals are mean-zero. - return.assumptions.minimumCoverageFraction: number; default: not declared - return.diagnostics: { coverage: FactorCoverage; exclusionReasons: Record; exposureCount?: number; groupCount?: number; warnings: string[]; }; default: not declared - return.diagnostics.coverage: FactorCoverage; default: not declared - return.diagnostics.exclusionReasons: Record; default: not declared — Entries dropped because their group or exposure row was absent, tallied. - return.diagnostics.exposureCount?: number; default: not declared - return.diagnostics.groupCount?: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#rankUniverse Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rank one declared numeric field across the point-in-time universe. ```typescript export declare function rankUniverse(input: RankUniverseInput): RankUniverseResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RankUniverseInput; default: not declared - (input).asOf: number; default: not declared - (input).fieldDefinitions: readonly FieldDefinition[]; default: not declared - (input).missingValuePolicy: MissingValuePolicy; default: not declared - (input).observations: readonly UniverseObservation[]; default: not declared - (input).rankBy: { direction: 'ascending' | 'descending'; field: string; }; default: not declared - (input).rankBy.direction: 'ascending' | 'descending'; default: not declared - (input).rankBy.field: string; default: not declared - (input).tiePolicy: RankTiePolicy; default: not declared - (input).universeId: string; default: not declared - return.assumptions: { asOf: EpochMs; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: MissingValuePolicy; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: RankTiePolicy; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - return.assumptions.missingValuePolicy: MissingValuePolicy; default: not declared - return.assumptions.rankBy: { direction: 'ascending' | 'descending'; field: string; }; default: not declared - return.assumptions.rankBy.direction: 'ascending' | 'descending'; default: not declared - return.assumptions.rankBy.field: string; default: not declared - return.assumptions.tiePolicy: RankTiePolicy; default: not declared - return.assumptions.universeId: string; default: not declared - return.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - return.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; rankedCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.eligibleCount: number; default: not declared - return.diagnostics.excludedCount: number; default: not declared - return.diagnostics.exclusionReasons: Record; default: not declared - return.diagnostics.rankedCount: number; default: not declared - return.diagnostics.suppliedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.rows: { instrumentId: string; value: number; rank: number; }[]; default: not declared ### @insiderfinance/totalfinance/research#requireDefinitionsMap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The definitions Map every declaration-aware guard consumes — typed, never assumed. ```typescript export declare function requireDefinitionsMap(functionName: string, definitions: Map): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definitions): Map; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/research#requireFieldDefinitions Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate the field-definition list and return them keyed by name. ```typescript export declare function requireFieldDefinitions(functionName: string, fieldDefinitions: readonly FieldDefinition[]): Map; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (fieldDefinitions): readonly FieldDefinition[]; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/research#requireMarketEvent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one {@link MarketEvent} at a public boundary. ```typescript export declare function requireMarketEvent(functionName: string, path: string, event: MarketEvent): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (event): MarketEvent; default: not declared - (event).announcedTimestampMs: number; default: not declared - (event).effectiveTimestampMs?: number; default: not declared — When the event takes economic effect, where that differs from the announcement. - (event).eventId: string; default: not declared - (event).eventType: string; default: not declared — A caller vocabulary ('earnings', 'guidance', …) — recorded, never interpreted. - (event).instrumentId: string; default: not declared - (event).metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - (functionName): string; default: not declared - (path): string; default: not declared ### @insiderfinance/totalfinance/research#requireReturnObservations Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a return-observation array, naming the failing row. ```typescript export declare function requireReturnObservations(functionName: string, label: string, observations: readonly ReturnObservation[]): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (label): string; default: not declared - (observations): readonly ReturnObservation[]; default: not declared ### @insiderfinance/totalfinance/research#requireScreenFilter Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a filter tree against the declarations: every field declared, every operator known, every comparison kind-compatible (an ordering comparison of a category field is the classic unit-incompatibility, and it teaches instead of silently failing every row). ```typescript export declare function requireScreenFilter(functionName: string, path: string, filter: ScreenFilter, definitions: Map): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definitions): Map; default: not declared - (filter): ScreenFilter; default: not declared - (filter).all: readonly ScreenFilter[]; default: not declared - (filter).any: readonly ScreenFilter[]; default: not declared - (filter).field: string; default: not declared - (filter).from: number; default: not declared - (filter).not: ScreenFilter; default: not declared - (filter).operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (IdentityComparisonOperator) | (OrderingComparisonOperator); default: not declared - (filter).to: number; default: not declared - (filter).value: (number) | (string | number | boolean); default: not declared - (filter).values: readonly (string | number)[]; default: not declared - (functionName): string; default: not declared - (path): string; default: not declared ### @insiderfinance/totalfinance/research#requireUniverseHistory Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a {@link UniverseHistory} at a public boundary: a closed record whose members are closed records with finite instants, a half-open non-empty interval each, a declared exit reason whenever an exit instant is given, a finite delisting return ≥ −1 only beside an exit, and no two overlapping intervals for one instrument (a name cannot be a member twice at once). ```typescript export declare function requireUniverseHistory(functionName: string, label: string, history: UniverseHistory): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (history): UniverseHistory; default: not declared - (history).members: readonly UniverseMember[]; default: not declared - (history).universeId: string; default: not declared - (label): string; default: not declared ### @insiderfinance/totalfinance/research#requireUniverseObservation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate one observation against the declarations: closed keys at the row level, every field key DECLARED, and every value matching its declared kind. `null` means "the source had no value" and is legal for any declared field — the missing-value policy decides what happens next, never the validator. ```typescript export declare function requireUniverseObservation(functionName: string, path: string, observation: UniverseObservation, definitions: Map): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definitions): Map; default: not declared - (functionName): string; default: not declared - (observation): UniverseObservation; default: not declared - (observation).availableTimestampMs: number; default: not declared - (observation).fields: Record; default: not declared — Values for DECLARED fields only; a key with no declaration is a teaching error. - (observation).instrumentId: string; default: not declared - (path): string; default: not declared ### @insiderfinance/totalfinance/research#requireUniverseObservations Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a whole observation array, naming the failing row. ```typescript export declare function requireUniverseObservations(functionName: string, observations: readonly UniverseObservation[], definitions: Map): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definitions): Map; default: not declared - (functionName): string; default: not declared - (observations): readonly UniverseObservation[]; default: not declared ### @insiderfinance/totalfinance/research#scoreUniverse Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Weighted composite scoring over standardized declared fields. Standardization is computed over the rows that carry the component; direction flips the sign so higher is always better in the composite. ```typescript export declare function scoreUniverse(input: ScoreUniverseInput): ScoreUniverseResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ScoreUniverseInput; default: not declared - (input).asOf: number; default: not declared - (input).components: readonly ScoreComponent[]; default: not declared - (input).fieldDefinitions: readonly FieldDefinition[]; default: not declared - (input).missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'`: a row missing ANY component is dropped with the reason. `'renormalize-weights'`: the row scores over its PRESENT components with weights renormalized — disclosed per policy, never per row silently. - (input).observations: readonly UniverseObservation[]; default: not declared - (input).universeId: string; default: not declared - return.assumptions: { asOf: EpochMs; components: Array; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: 'exclude' | 'renormalize-weights'; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.components: (ScoreComponent & { normalizedWeight: number; })[]; default: not declared - return.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - return.assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - return.assumptions.universeId: string; default: not declared - return.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - return.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; scoredCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.eligibleCount: number; default: not declared - return.diagnostics.excludedCount: number; default: not declared - return.diagnostics.exclusionReasons: Record; default: not declared - return.diagnostics.scoredCount: number; default: not declared - return.diagnostics.suppliedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.rows: { instrumentId: string; score: number; componentsUsed: number; }[]; default: not declared ### @insiderfinance/totalfinance/research#screenUniverse Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A point-in-time screen: eligibility, version resolution, filter, ordering with the always-on stable tie-breaker, and the honest exclusion ledger. Deterministic under input permutation by construction. ```typescript export declare function screenUniverse(input: ScreenUniverseInput): ScreenUniverseResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ScreenUniverseInput; default: not declared - (input).asOf: number; default: not declared - (input).customPredicate?: (observation: UniverseObservation) => boolean; default: not declared — The explicit NON-SERIALIZABLE escape hatch: a caller predicate over the observation. Its presence is classified in `assumptions.customPredicate` so a stored screen recipe cannot silently claim reproducibility it does not have. - (input).fieldDefinitions: readonly FieldDefinition[]; default: not declared - (input).filter?: ScreenFilter; default: not declared — The serializable filter. Omitted → every eligible row passes (ordering still applies). - (input).limit?: number; default: not declared — Keep at most this many rows after ordering; a non-negative safe integer. Omit for all rows. - (input).missingValuePolicy: MissingValuePolicy; default: not declared - (input).observations: readonly UniverseObservation[]; default: not declared - (input).orderBy: readonly ScreenOrdering[]; default: not declared — Ordering keys; `instrumentId` ascending is ALWAYS appended as the stable final tie-breaker. - (input).universeId: string; default: not declared — The universe's identity, echoed — a screen without provenance is a number without a source. - return.assumptions: { asOf: EpochMs; customPredicate?: 'non-serializable caller predicate'; finalTieBreaker: 'instrumentId ascending'; limit?: number; missingValuePolicy: MissingValuePolicy; orderBy: readonly ScreenOrdering[]; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.customPredicate?: 'non-serializable caller predicate'; default: not declared — Present exactly when a caller predicate participated. - return.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared — The stable final ordering key, always applied — determinism under input permutation. - return.assumptions.limit?: number; default: not declared - return.assumptions.missingValuePolicy: MissingValuePolicy; default: not declared - return.assumptions.orderBy: readonly ScreenOrdering[]; default: not declared - return.assumptions.universeId: string; default: not declared - return.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - return.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; includedCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - return.diagnostics.eligibleCount: number; default: not declared - return.diagnostics.excludedCount: number; default: not declared - return.diagnostics.exclusionReasons: Record; default: not declared — Every exclusion, tallied by reason. - return.diagnostics.includedCount: number; default: not declared - return.diagnostics.suppliedCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.rows: ScreenedRow[]; default: not declared ### @insiderfinance/totalfinance/research#standardizeFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Standardize a factor cross-sectionally: z-scores over the valued entries, or average-rank percentiles scaled to (0, 1]. Nulls pass through; a zero-dispersion z-score answers 0 for every entry WITH a warning rather than dividing by nothing. ```typescript export declare function standardizeFactor(input: StandardizeFactorInput): StandardizeFactorResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): StandardizeFactorInput; default: not declared - (input).entries: readonly FactorEntry[]; default: not declared - (input).method: 'z-score' | 'percentile-rank'; default: not declared - (input).minimumCoverageFraction?: number; default: not declared - return.assumptions: { mean?: number; method: 'z-score' | 'percentile-rank'; minimumCoverageFraction: number; sampleStandardDeviation?: number; tieHandling: 'average rank'; }; default: not declared - return.assumptions.mean?: number; default: not declared — Echoed z-score moments (absent for percentile ranks). - return.assumptions.method: 'z-score' | 'percentile-rank'; default: not declared - return.assumptions.minimumCoverageFraction: number; default: not declared - return.assumptions.sampleStandardDeviation?: number; default: not declared - return.assumptions.tieHandling: 'average rank'; default: not declared - return.diagnostics: { coverage: FactorCoverage; warnings: string[]; }; default: not declared - return.diagnostics.coverage: FactorCoverage; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.entries: FactorEntry[]; default: not declared ### @insiderfinance/totalfinance/research#universeMembershipAt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Who is in the universe at an instant, and — against a previous instant — who joined and who left (with the exit reason and any delisting return). The membership rule is the half-open interval; ties are impossible because one instant is either inside an interval or not. ```typescript export declare function universeMembershipAt(input: UniverseMembershipAtInput): UniverseMembershipAtResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): UniverseMembershipAtInput; default: not declared - (input).asOf: number; default: not declared — The decision instant. - (input).previousAsOf?: number; default: not declared — The previous decision instant. When given, `additions` and `exits` describe what changed in `(previousAsOf, asOf]`; when omitted both are empty and only `instrumentIds` is meaningful. - (input).universeHistory: UniverseHistory; default: not declared - return.additions: string[]; default: not declared — Names whose membership began in `(previousAsOf, asOf]`, ascending. - return.assumptions: { asOf: EpochMs; membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; previousAsOf: EpochMs | null; universeId: string; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.membershipRule: 'fromTimestampMs <= asOf < toTimestampMs'; default: not declared - return.assumptions.previousAsOf: number | null; default: not declared - return.assumptions.universeId: string; default: not declared - return.diagnostics: { additionCount: number; exitCount: number; memberCount: number; warnings: string[]; }; default: not declared - return.diagnostics.additionCount: number; default: not declared - return.diagnostics.exitCount: number; default: not declared - return.diagnostics.memberCount: number; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.exits: UniverseExit[]; default: not declared — Names whose membership ended in `(previousAsOf, asOf]`, ascending by id then instant. - return.instrumentIds: string[]; default: not declared — Members at `asOf`, `instrumentId` ascending. ### @insiderfinance/totalfinance/research#winsorizeFactor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Winsorize a factor vector under an EXPLICIT method. The percentile form uses the CLASSIC Winsor convention — order-statistic replacement: the `floor(n × lowerPercentile)` smallest values are replaced by the next order statistic (and symmetrically at the top). Chosen over interpolating quantiles deliberately: order-statistic replacement is EXACTLY idempotent (re-winsorizing a winsorized vector is the identity — the metamorphic law in the evidence plan), while an interpolated cutoff moves every time it is recomputed over its own output. Nulls pass through untouched; the realized clip bounds are echoed. ```typescript export declare function winsorizeFactor(input: WinsorizeFactorInput): WinsorizeFactorResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): WinsorizeFactorInput; default: not declared - (input).entries: readonly FactorEntry[]; default: not declared - (input).method: WinsorizationMethod; default: not declared - (input).minimumCoverageFraction?: number; default: not declared - return.assumptions: { lowerBound: number; method: WinsorizationMethod; minimumCoverageFraction: number; upperBound: number; }; default: not declared - return.assumptions.lowerBound: number; default: not declared — The realized clip bounds, so the transform is reproducible without the input. - return.assumptions.method: WinsorizationMethod; default: not declared - return.assumptions.minimumCoverageFraction: number; default: not declared - return.assumptions.upperBound: number; default: not declared - return.diagnostics: { clippedLowerCount: number; clippedUpperCount: number; coverage: FactorCoverage; warnings: string[]; }; default: not declared - return.diagnostics.clippedLowerCount: number; default: not declared - return.diagnostics.clippedUpperCount: number; default: not declared - return.diagnostics.coverage: FactorCoverage; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.entries: FactorEntry[]; default: not declared ## Entrypoint @insiderfinance/totalfinance/research/artifacts ### @insiderfinance/totalfinance/research/artifacts#AbnormalReturnDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AbnormalReturnDelta { tradingSessionOffset: number; baselineAverageAbnormalReturn: number | null; candidateAverageAbnormalReturn: number | null; absoluteDelta: number | null; baselineCumulativeAverageAbnormalReturn: number | null; candidateCumulativeAverageAbnormalReturn: number | null; cumulativeAbsoluteDelta: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared - baselineAverageAbnormalReturn: number | null; default: not declared - baselineCumulativeAverageAbnormalReturn: number | null; default: not declared - candidateAverageAbnormalReturn: number | null; default: not declared - candidateCumulativeAverageAbnormalReturn: number | null; default: not declared - cumulativeAbsoluteDelta: number | null; default: not declared - tradingSessionOffset: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#CountDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CountDelta { reason: string; baselineCount: number; candidateCount: number; delta: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baselineCount: number; default: not declared - candidateCount: number; default: not declared - delta: number; default: not declared - reason: string; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneBacktestOverfitting Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `backtestOverfittingProbability`'s result — risk's `BacktestOverfittingProbabilityResult`, structurally. ```typescript /** `backtestOverfittingProbability`'s result — risk's `BacktestOverfittingProbabilityResult`, structurally. */ export interface HygieneBacktestOverfitting { backtestOverfittingProbability: number; combinations: number; splits: number; observations: number; trials: number; medianLogit: number; assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - backtestOverfittingProbability: number; default: not declared - combinations: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - medianLogit: number; default: not declared - observations: number; default: not declared - splits: number; default: not declared - trials: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneDeflatedSharpe Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `deflatedSharpeRatio`'s result — risk's `DeflatedSharpeResult`, structurally. ```typescript /** `deflatedSharpeRatio`'s result — risk's `DeflatedSharpeResult`, structurally. */ export interface HygieneDeflatedSharpe { assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; /** `null` when the statistics carried no Sharpe (a zero-variance series). */ deflatedSharpe: number | null; probabilisticSharpe: number | null; expectedMaxSharpe: number; trialCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - deflatedSharpe: number | null; default: not declared — `null` when the statistics carried no Sharpe (a zero-variance series). - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - expectedMaxSharpe: number; default: not declared - probabilisticSharpe: number | null; default: not declared - trialCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneLeakageReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `detectLeakage`'s report — risk's `LeakageReport`, structurally. ```typescript /** `detectLeakage`'s report — risk's `LeakageReport`, structurally. */ export interface HygieneLeakageReport { assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; clean: boolean; leaks: Array<{ split: number; overlapCount: number; sample: number[]; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - clean: boolean; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - leaks: { split: number; overlapCount: number; sample: number[]; }[]; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneMultipleTest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `adjustPValues`' result — risk's `MultipleTestResult`, structurally. ```typescript /** `adjustPValues`' result — risk's `MultipleTestResult`, structurally. */ export interface HygieneMultipleTest { method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; alpha: number; adjusted: number[]; rejected: boolean[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjusted: number[]; default: not declared - alpha: number; default: not declared - method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; default: not declared - rejected: boolean[]; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneParameterSweep Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `parameterSweepDiagnostics`' result — risk's `ParameterSweepResult`, structurally. ```typescript /** `parameterSweepDiagnostics`' result — risk's `ParameterSweepResult`, structurally. */ export interface HygieneParameterSweep { trialCount: number; bestSharpe: number; meanSharpe: number; varianceSharpe: number; expectedMaxSharpe: number; /** `null` when the selected statistics carried no Sharpe (a zero-variance series). */ deflatedSharpe: number | null; probabilisticSharpe: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bestSharpe: number; default: not declared - deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carried no Sharpe (a zero-variance series). - expectedMaxSharpe: number; default: not declared - meanSharpe: number; default: not declared - probabilisticSharpe: number | null; default: not declared - trialCount: number; default: not declared - varianceSharpe: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneResearchVerdict Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `researchProtocol`'s verdict — risk's `ResearchVerdict`, structurally. ```typescript /** `researchProtocol`'s verdict — risk's `ResearchVerdict`, structurally. */ export interface HygieneResearchVerdict { verdict: 'significant' | 'inconclusive' | 'likely-overfit'; /** Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. */ inSample: { sharpe: number | null; annualizedSharpe: number | null; observations: number; }; deflatedSharpe: number | null; probabilisticSharpe: number | null; expectedMaxSharpe: number; trialCount: number; /** `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. */ minTrackRecordLength: number; outOfSample?: { sharpe: number | null; annualizedSharpe: number | null; degradation: number | null; }; rationale: string; assumptions: { conventionsVersion: string; confidence: number; periodsPerYear: number; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - assumptions.confidence: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.periodsPerYear: number; default: not declared - deflatedSharpe: number | null; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - expectedMaxSharpe: number; default: not declared - inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. - inSample.annualizedSharpe: number | null; default: not declared - inSample.observations: number; default: not declared - inSample.sharpe: number | null; default: not declared - minTrackRecordLength: number; default: not declared — `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. - outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared - outOfSample.annualizedSharpe: number | null; default: not declared - outOfSample.degradation: number | null; default: not declared - outOfSample.sharpe: number | null; default: not declared - probabilisticSharpe: number | null; default: not declared - rationale: string; default: not declared - trialCount: number; default: not declared - verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared ### @insiderfinance/totalfinance/research/artifacts#HygieneVerdictSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HygieneVerdictSection { baseline: string; candidate: string; changed: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseline: string; default: not declared - candidate: string; default: not declared - changed: boolean; default: not declared ### @insiderfinance/totalfinance/research/artifacts#IdListSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface IdListSection { count: number; /** Listed up to `limits.listedIds`; the remainder is counted. */ ids: string[]; remainderCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - remainderCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#InputOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type InputOf = ResearchRunInputs[K]; ``` ### @insiderfinance/totalfinance/research/artifacts#KeyedDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KeyedDelta { key: Key; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared - baselineValue: number | null; default: not declared - candidateValue: number | null; default: not declared - key: Key; default: not declared ### @insiderfinance/totalfinance/research/artifacts#MembershipSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MembershipSection { entered: IdListSection; exited: IdListSection; kept: IdListSection; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entered: IdListSection; default: not declared - entered.count: number; default: not declared - entered.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - entered.remainderCount: number; default: not declared - exited: IdListSection; default: not declared - exited.count: number; default: not declared - exited.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - exited.remainderCount: number; default: not declared - kept: IdListSection; default: not declared - kept.count: number; default: not declared - kept.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - kept.remainderCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#NamedDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface NamedDelta { name: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number | null; default: not declared - baselineValue: number | null; default: not declared - candidateValue: number | null; default: not declared - name: string; default: not declared ### @insiderfinance/totalfinance/research/artifacts#PortfolioMembership Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioMembership { quantileIndex: number; membership: MembershipSection; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - membership: MembershipSection; default: not declared - membership.entered: IdListSection; default: not declared - membership.entered.count: number; default: not declared - membership.entered.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - membership.entered.remainderCount: number; default: not declared - membership.exited: IdListSection; default: not declared - membership.exited.count: number; default: not declared - membership.exited.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - membership.exited.remainderCount: number; default: not declared - membership.kept: IdListSection; default: not declared - membership.kept.count: number; default: not declared - membership.kept.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - membership.kept.remainderCount: number; default: not declared - quantileIndex: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#RESEARCH_RUN_ARTIFACT_TYPE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const RESEARCH_RUN_ARTIFACT_TYPE: 'research.run'; ``` ### @insiderfinance/totalfinance/research/artifacts#RESEARCH_RUN_KINDS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The frozen descriptor per run kind — Program 5's registry metadata without a registry. ```typescript export declare const RESEARCH_RUN_KINDS: Readonly>; ``` ### @insiderfinance/totalfinance/research/artifacts#RESEARCH_RUN_LIMITS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers). ```typescript export declare const RESEARCH_RUN_LIMITS: Readonly<{ maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; gridPoints: Readonly<{ default: 256; maximum: 4096; }>; restarts: Readonly<{ maximum: 64; }>; holdoutEvaluations: Readonly<{ maximum: 100000; }>; listedIds: Readonly<{ default: 200; maximum: 10000; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; default: not declared - embeddedRowLimit.default: 5000; default: not declared - embeddedRowLimit.maximum: 50000; default: not declared - gridPoints: Readonly<{ default: 256; maximum: 4096; }>; default: not declared - gridPoints.default: 256; default: not declared - gridPoints.maximum: 4096; default: not declared - holdoutEvaluations: Readonly<{ maximum: 100000; }>; default: not declared - holdoutEvaluations.maximum: 100000; default: not declared - listedIds: Readonly<{ default: 200; maximum: 10000; }>; default: not declared - listedIds.default: 200; default: not declared - listedIds.maximum: 10000; default: not declared - maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; default: not declared - maximumDifferences.default: 1000; default: not declared - maximumDifferences.maximum: 100000; default: not declared - maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; default: not declared - maximumEmbeddedBytes.default: 1048576; default: not declared - maximumEmbeddedBytes.maximum: 8388608; default: not declared - maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; default: not declared - maximumLeaves.default: 2000000; default: not declared - maximumLeaves.maximum: 2000000; default: not declared - restarts: Readonly<{ maximum: 64; }>; default: not declared - restarts.maximum: 64; default: not declared ### @insiderfinance/totalfinance/research/artifacts#RankMove Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RankMove { instrumentId: string; baselineRank: number; candidateRank: number; /** candidate − baseline (positive = moved down the ranking). */ delta: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baselineRank: number; default: not declared - candidateRank: number; default: not declared - delta: number; default: not declared — candidate − baseline (positive = moved down the ranking). - instrumentId: string; default: not declared ### @insiderfinance/totalfinance/research/artifacts#RankMovesSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RankMovesSection { /** Instruments ranked on both sides whose rank changed. */ movedCount: number; /** The largest movers by |delta|, listed up to `limits.listedIds`. */ movers: RankMove[]; remainderCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - movedCount: number; default: not declared — Instruments ranked on both sides whose rank changed. - movers: RankMove[]; default: not declared — The largest movers by |delta|, listed up to `limits.listedIds`. - remainderCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ReadResearchRunResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReadResearchRunResult { report: ResearchRunReport; artifact: AnalysisArtifact; /** Envelope-level migrations applied by the Gate B read door. */ migrationsApplied: AppliedMigration[]; /** Report-level (run-version) migrations applied under `research.run:` — the same echo shape as the fitted-model read doors. */ modelMigrationsApplied: AppliedMigration[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifact: AnalysisArtifact; default: not declared - artifact.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - artifact.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - artifact.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - artifact.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - artifact.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - artifact.inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - artifact.inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - artifact.inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - artifact.kind: 'totalfinance.analysis-artifact'; default: not declared - artifact.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - artifact.producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - artifact.producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - artifact.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - artifact.provenance.asOf?: number; default: not declared - artifact.provenance.dataset?: string; default: not declared - artifact.provenance.provider?: string; default: not declared - artifact.provenance.receivedAt?: number; default: not declared - artifact.provenance.requestId?: string; default: not declared - artifact.provenance.sourceVersion?: string; default: not declared - artifact.provenance.warnings?: QuantWarning[]; default: not declared - artifact.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - artifact.schemaVersion: number; default: not declared - artifact.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - migrationsApplied: AppliedMigration[]; default: not declared — Envelope-level migrations applied by the Gate B read door. - modelMigrationsApplied: AppliedMigration[]; default: not declared — Report-level (run-version) migrations applied under `research.run:` — the same echo shape as the fitted-model read doors. - report: ResearchRunReport; default: not declared - report.assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }; default: not declared - report.assumptions.conventionsVersion: string; default: not declared - report.assumptions.embeddedRowLimit: number; default: not declared - report.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - report.assumptions.kind: Kind; default: not declared - report.assumptions.nonReplayableField: string | null; default: not declared — The callback field that made the run non-replayable, when one did. - report.assumptions.operation: string; default: not declared - report.assumptions.projection: string; default: not declared - report.assumptions.replayable: boolean; default: not declared — `false` exactly when a non-serializable callback participated. - report.assumptions.runVersion: number; default: not declared - report.diagnostics: { warnings: QuantWarning[]; embeddedRows: number; referencedRows: number; runWarningCount: number; }; default: not declared - report.diagnostics.embeddedRows: number; default: not declared - report.diagnostics.referencedRows: number; default: not declared - report.diagnostics.runWarningCount: number; default: not declared - report.diagnostics.warnings: QuantWarning[]; default: not declared - report.hygiene: ResearchHygieneBlock | null; default: not declared — Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here. - report.hygiene.backtestOverfitting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting; default: not declared - report.hygiene.backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - report.hygiene.backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - report.hygiene.backtestOverfitting.backtestOverfittingProbability: number; default: not declared - report.hygiene.backtestOverfitting.combinations: number; default: not declared - report.hygiene.backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared - report.hygiene.backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - report.hygiene.backtestOverfitting.medianLogit: number; default: not declared - report.hygiene.backtestOverfitting.observations: number; default: not declared - report.hygiene.backtestOverfitting.splits: number; default: not declared - report.hygiene.backtestOverfitting.trials: number; default: not declared - report.hygiene.deflatedSharpe?: import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe; default: not declared - report.hygiene.deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - report.hygiene.deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - report.hygiene.deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carried no Sharpe (a zero-variance series). - report.hygiene.deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared - report.hygiene.deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - report.hygiene.deflatedSharpe.expectedMaxSharpe: number; default: not declared - report.hygiene.deflatedSharpe.probabilisticSharpe: number | null; default: not declared - report.hygiene.deflatedSharpe.trialCount: number; default: not declared - report.hygiene.leakage?: import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport; default: not declared - report.hygiene.leakage.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - report.hygiene.leakage.assumptions.conventionsVersion: string; default: not declared - report.hygiene.leakage.clean: boolean; default: not declared - report.hygiene.leakage.diagnostics: { warnings: QuantWarning[]; }; default: not declared - report.hygiene.leakage.diagnostics.warnings: QuantWarning[]; default: not declared - report.hygiene.leakage.leaks: { split: number; overlapCount: number; sample: number[]; }[]; default: not declared - report.hygiene.multipleTesting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest; default: not declared - report.hygiene.multipleTesting.adjusted: number[]; default: not declared - report.hygiene.multipleTesting.alpha: number; default: not declared - report.hygiene.multipleTesting.method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; default: not declared - report.hygiene.multipleTesting.rejected: boolean[]; default: not declared - report.hygiene.parameterSweep?: import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep; default: not declared - report.hygiene.parameterSweep.bestSharpe: number; default: not declared - report.hygiene.parameterSweep.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carried no Sharpe (a zero-variance series). - report.hygiene.parameterSweep.expectedMaxSharpe: number; default: not declared - report.hygiene.parameterSweep.meanSharpe: number; default: not declared - report.hygiene.parameterSweep.probabilisticSharpe: number | null; default: not declared - report.hygiene.parameterSweep.trialCount: number; default: not declared - report.hygiene.parameterSweep.varianceSharpe: number; default: not declared - report.hygiene.protocol?: import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict; default: not declared - report.hygiene.protocol.assumptions: { conventionsVersion: string; confidence: number; periodsPerYear: number; }; default: not declared - report.hygiene.protocol.assumptions.confidence: number; default: not declared - report.hygiene.protocol.assumptions.conventionsVersion: string; default: not declared - report.hygiene.protocol.assumptions.periodsPerYear: number; default: not declared - report.hygiene.protocol.deflatedSharpe: number | null; default: not declared - report.hygiene.protocol.diagnostics: { warnings: QuantWarning[]; }; default: not declared - report.hygiene.protocol.diagnostics.warnings: QuantWarning[]; default: not declared - report.hygiene.protocol.expectedMaxSharpe: number; default: not declared - report.hygiene.protocol.inSample: { sharpe: number | null; annualizedSharpe: number | null; observations: number; }; default: not declared — Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. - report.hygiene.protocol.inSample.annualizedSharpe: number | null; default: not declared - report.hygiene.protocol.inSample.observations: number; default: not declared - report.hygiene.protocol.inSample.sharpe: number | null; default: not declared - report.hygiene.protocol.minTrackRecordLength: number; default: not declared — `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. - report.hygiene.protocol.outOfSample?: { sharpe: number | null; annualizedSharpe: number | null; degradation: number | null; }; default: not declared - report.hygiene.protocol.outOfSample.annualizedSharpe: number | null; default: not declared - report.hygiene.protocol.outOfSample.degradation: number | null; default: not declared - report.hygiene.protocol.outOfSample.sharpe: number | null; default: not declared - report.hygiene.protocol.probabilisticSharpe: number | null; default: not declared - report.hygiene.protocol.rationale: string; default: not declared - report.hygiene.protocol.trialCount: number; default: not declared - report.hygiene.protocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - report.inputs: Referenced>; default: not declared — The operation's input with bulk rows either embedded or replaced by verified table references. - report.kind: Kind; default: not declared - report.recipe: FactorRecipe | null; default: not declared — The versioned recipe the caller says produced the factor, when one did. - report.recipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - report.recipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - report.recipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - report.recipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - report.recipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - report.recipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - report.recipe.recipeName: string; default: not declared - report.recipe.recipeVersion: number; default: not declared - report.referencedData: Record; default: not declared — Table references for every bulk row set that was not embedded (Gate B TableHandle). - report.run: RunOf; default: not declared — The direct operation's result, verbatim. - report.runVersion: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#Referenced Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The stored form of an input: every bulk array may be a `TableHandle` instead of its rows, and a caller function is never stored (the run is recorded non-replayable and the field omitted). ```typescript /** * The stored form of an input: every bulk array may be a `TableHandle` instead of its rows, and a * caller function is never stored (the run is recorded non-replayable and the field omitted). */ export type Referenced = T extends (...args: never[]) => unknown ? never : T extends readonly (infer Element)[] ? readonly Referenced[] | TableHandle : T extends object ? { [P in keyof T]: Referenced; } : T; ``` ### @insiderfinance/totalfinance/research/artifacts#ResearchHygieneBlock Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed block: every member optional, every present member verbatim. ```typescript /** The closed block: every member optional, every present member verbatim. */ export interface ResearchHygieneBlock { protocol?: HygieneResearchVerdict; deflatedSharpe?: HygieneDeflatedSharpe; backtestOverfitting?: HygieneBacktestOverfitting; leakage?: HygieneLeakageReport; parameterSweep?: HygieneParameterSweep; multipleTesting?: HygieneMultipleTest; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - backtestOverfitting?: HygieneBacktestOverfitting; default: not declared - backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - backtestOverfitting.backtestOverfittingProbability: number; default: not declared - backtestOverfitting.combinations: number; default: not declared - backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared - backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - backtestOverfitting.medianLogit: number; default: not declared - backtestOverfitting.observations: number; default: not declared - backtestOverfitting.splits: number; default: not declared - backtestOverfitting.trials: number; default: not declared - deflatedSharpe?: HygieneDeflatedSharpe; default: not declared - deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carried no Sharpe (a zero-variance series). - deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared - deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - deflatedSharpe.expectedMaxSharpe: number; default: not declared - deflatedSharpe.probabilisticSharpe: number | null; default: not declared - deflatedSharpe.trialCount: number; default: not declared - leakage?: HygieneLeakageReport; default: not declared - leakage.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - leakage.assumptions.conventionsVersion: string; default: not declared - leakage.clean: boolean; default: not declared - leakage.diagnostics: { warnings: QuantWarning[]; }; default: not declared - leakage.diagnostics.warnings: QuantWarning[]; default: not declared - leakage.leaks: { split: number; overlapCount: number; sample: number[]; }[]; default: not declared - multipleTesting?: HygieneMultipleTest; default: not declared - multipleTesting.adjusted: number[]; default: not declared - multipleTesting.alpha: number; default: not declared - multipleTesting.method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; default: not declared - multipleTesting.rejected: boolean[]; default: not declared - parameterSweep?: HygieneParameterSweep; default: not declared - parameterSweep.bestSharpe: number; default: not declared - parameterSweep.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carried no Sharpe (a zero-variance series). - parameterSweep.expectedMaxSharpe: number; default: not declared - parameterSweep.meanSharpe: number; default: not declared - parameterSweep.probabilisticSharpe: number | null; default: not declared - parameterSweep.trialCount: number; default: not declared - parameterSweep.varianceSharpe: number; default: not declared - protocol?: HygieneResearchVerdict; default: not declared - protocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - protocol.assumptions.confidence: number; default: not declared - protocol.assumptions.conventionsVersion: string; default: not declared - protocol.assumptions.periodsPerYear: number; default: not declared - protocol.deflatedSharpe: number | null; default: not declared - protocol.diagnostics: { warnings: QuantWarning[]; }; default: not declared - protocol.diagnostics.warnings: QuantWarning[]; default: not declared - protocol.expectedMaxSharpe: number; default: not declared - protocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. - protocol.inSample.annualizedSharpe: number | null; default: not declared - protocol.inSample.observations: number; default: not declared - protocol.inSample.sharpe: number | null; default: not declared - protocol.minTrackRecordLength: number; default: not declared — `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. - protocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared - protocol.outOfSample.annualizedSharpe: number | null; default: not declared - protocol.outOfSample.degradation: number | null; default: not declared - protocol.outOfSample.sharpe: number | null; default: not declared - protocol.probabilisticSharpe: number | null; default: not declared - protocol.rationale: string; default: not declared - protocol.trialCount: number; default: not declared - protocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunArtifactInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchRunArtifactInput { kind: Kind; /** The direct operation's result, verbatim. */ run: RunOf; /** The operation's input as it was called — rows included; a caller function is recorded and not stored. */ input: InputOf; /** Concrete row-set labels (`observations`, `horizons[0].forwardReturns`) to store by `TableHandle` instead of embedding. */ referenceRowSets?: readonly string[]; /** Storage locators to stamp on the minted handles, keyed by row-set label. */ locators?: Record; /** Up to six verbatim @insiderfinance/totalfinance/risk results — validated structurally, stored verbatim, never recomputed. */ hygiene?: ResearchHygieneBlock; /** The versioned factor recipe that produced the factor, stored verbatim (covered by the artifact id). */ recipe?: FactorRecipe; snapshotHash?: string; libraryVersion?: string; /** Parent artifact ids (a transform, a prior study, a portfolio set) so lineage is walkable. */ createdFrom?: string[]; provenance?: Provenance; limits?: ResearchRunArtifactLimits; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - createdFrom?: string[]; default: not declared — Parent artifact ids (a transform, a prior study, a portfolio set) so lineage is walkable. - hygiene?: ResearchHygieneBlock; default: not declared — Up to six verbatim @insiderfinance/totalfinance/risk results — validated structurally, stored verbatim, never recomputed. - hygiene.backtestOverfitting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting; default: not declared - hygiene.backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - hygiene.backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - hygiene.backtestOverfitting.backtestOverfittingProbability: number; default: not declared - hygiene.backtestOverfitting.combinations: number; default: not declared - hygiene.backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.backtestOverfitting.medianLogit: number; default: not declared - hygiene.backtestOverfitting.observations: number; default: not declared - hygiene.backtestOverfitting.splits: number; default: not declared - hygiene.backtestOverfitting.trials: number; default: not declared - hygiene.deflatedSharpe?: import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe; default: not declared - hygiene.deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - hygiene.deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - hygiene.deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carried no Sharpe (a zero-variance series). - hygiene.deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.deflatedSharpe.expectedMaxSharpe: number; default: not declared - hygiene.deflatedSharpe.probabilisticSharpe: number | null; default: not declared - hygiene.deflatedSharpe.trialCount: number; default: not declared - hygiene.leakage?: import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport; default: not declared - hygiene.leakage.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - hygiene.leakage.assumptions.conventionsVersion: string; default: not declared - hygiene.leakage.clean: boolean; default: not declared - hygiene.leakage.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.leakage.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.leakage.leaks: { split: number; overlapCount: number; sample: number[]; }[]; default: not declared - hygiene.multipleTesting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest; default: not declared - hygiene.multipleTesting.adjusted: number[]; default: not declared - hygiene.multipleTesting.alpha: number; default: not declared - hygiene.multipleTesting.method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; default: not declared - hygiene.multipleTesting.rejected: boolean[]; default: not declared - hygiene.parameterSweep?: import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep; default: not declared - hygiene.parameterSweep.bestSharpe: number; default: not declared - hygiene.parameterSweep.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carried no Sharpe (a zero-variance series). - hygiene.parameterSweep.expectedMaxSharpe: number; default: not declared - hygiene.parameterSweep.meanSharpe: number; default: not declared - hygiene.parameterSweep.probabilisticSharpe: number | null; default: not declared - hygiene.parameterSweep.trialCount: number; default: not declared - hygiene.parameterSweep.varianceSharpe: number; default: not declared - hygiene.protocol?: import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict; default: not declared - hygiene.protocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - hygiene.protocol.assumptions.confidence: number; default: not declared - hygiene.protocol.assumptions.conventionsVersion: string; default: not declared - hygiene.protocol.assumptions.periodsPerYear: number; default: not declared - hygiene.protocol.deflatedSharpe: number | null; default: not declared - hygiene.protocol.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.protocol.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.protocol.expectedMaxSharpe: number; default: not declared - hygiene.protocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. - hygiene.protocol.inSample.annualizedSharpe: number | null; default: not declared - hygiene.protocol.inSample.observations: number; default: not declared - hygiene.protocol.inSample.sharpe: number | null; default: not declared - hygiene.protocol.minTrackRecordLength: number; default: not declared — `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. - hygiene.protocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared - hygiene.protocol.outOfSample.annualizedSharpe: number | null; default: not declared - hygiene.protocol.outOfSample.degradation: number | null; default: not declared - hygiene.protocol.outOfSample.sharpe: number | null; default: not declared - hygiene.protocol.probabilisticSharpe: number | null; default: not declared - hygiene.protocol.rationale: string; default: not declared - hygiene.protocol.trialCount: number; default: not declared - hygiene.protocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - input: InputOf; default: not declared — The operation's input as it was called — rows included; a caller function is recorded and not stored. - kind: Kind; default: not declared - libraryVersion?: string; default: not declared - limits?: ResearchRunArtifactLimits; default: not declared - limits.embeddedRowLimit?: number; default: not declared - limits.maximumEmbeddedBytes?: number; default: not declared - locators?: Record; default: not declared — Storage locators to stamp on the minted handles, keyed by row-set label. - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - recipe?: FactorRecipe; default: not declared — The versioned factor recipe that produced the factor, stored verbatim (covered by the artifact id). - recipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - recipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - recipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - recipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - recipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - recipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - recipe.recipeName: string; default: not declared - recipe.recipeVersion: number; default: not declared - referenceRowSets?: readonly string[]; default: not declared — Concrete row-set labels (`observations`, `horizons[0].forwardReturns`) to store by `TableHandle` instead of embedding. - run: RunOf; default: not declared — The direct operation's result, verbatim. - snapshotHash?: string; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunArtifactLimits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchRunArtifactLimits { maximumEmbeddedBytes?: number; embeddedRowLimit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit?: number; default: not declared - maximumEmbeddedBytes?: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchRunComparison { kind: Kind; artifactIds: { baseline: string | null; candidate: string | null; }; sameUniverse: boolean | null; sameAsOf: boolean | null; sameFilter: boolean | null; sameRankBy: boolean | null; sameComponents: boolean | null; /** Whether the two stored inputs hash identically. */ sameInputs: boolean; /** Each section is `null` where the kind has no such content. */ membership: MembershipSection | null; rankMoves: RankMovesSection | null; scoreDeltas: ScoreDeltasSection | null; exclusionReasons: CountDelta[] | null; coefficients: NamedDelta[] | null; averageAbnormalReturns: AbnormalReturnDelta[] | null; quantiles: KeyedDelta[] | null; horizons: KeyedDelta[] | null; portfolios: PortfolioMembership[] | null; hygieneVerdict: HygieneVerdictSection | null; /** The structural diff of the two verbatim runs through the parity walk. */ run: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; assumptions: { conventionsVersion: string; kind: Kind; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - artifactIds.baseline: string | null; default: not declared - artifactIds.candidate: string | null; default: not declared - assumptions: { conventionsVersion: string; kind: Kind; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.kind: Kind; default: not declared - assumptions.limits: { listedIds: number; maximumDifferences: number; maximumLeaves: number; }; default: not declared - assumptions.limits.listedIds: number; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - averageAbnormalReturns: AbnormalReturnDelta[] | null; default: not declared - coefficients: NamedDelta[] | null; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - exclusionReasons: CountDelta[] | null; default: not declared - horizons: KeyedDelta[] | null; default: not declared - hygieneVerdict: HygieneVerdictSection | null; default: not declared - hygieneVerdict.baseline: string; default: not declared - hygieneVerdict.candidate: string; default: not declared - hygieneVerdict.changed: boolean; default: not declared - kind: Kind; default: not declared - membership: MembershipSection | null; default: not declared — Each section is `null` where the kind has no such content. - membership.entered: IdListSection; default: not declared - membership.entered.count: number; default: not declared - membership.entered.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - membership.entered.remainderCount: number; default: not declared - membership.exited: IdListSection; default: not declared - membership.exited.count: number; default: not declared - membership.exited.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - membership.exited.remainderCount: number; default: not declared - membership.kept: IdListSection; default: not declared - membership.kept.count: number; default: not declared - membership.kept.ids: string[]; default: not declared — Listed up to `limits.listedIds`; the remainder is counted. - membership.kept.remainderCount: number; default: not declared - portfolios: PortfolioMembership[] | null; default: not declared - quantiles: KeyedDelta[] | null; default: not declared - rankMoves: RankMovesSection | null; default: not declared - rankMoves.movedCount: number; default: not declared — Instruments ranked on both sides whose rank changed. - rankMoves.movers: RankMove[]; default: not declared — The largest movers by |delta|, listed up to `limits.listedIds`. - rankMoves.remainderCount: number; default: not declared - run: { addedPaths: string[]; differenceCount: number; removedPaths: string[]; retainedDifferences: number; truncated: boolean; }; default: not declared — The structural diff of the two verbatim runs through the parity walk. - run.addedPaths: string[]; default: not declared - run.differenceCount: number; default: not declared - run.removedPaths: string[]; default: not declared - run.retainedDifferences: number; default: not declared - run.truncated: boolean; default: not declared - sameAsOf: boolean | null; default: not declared - sameComponents: boolean | null; default: not declared - sameFilter: boolean | null; default: not declared - sameInputs: boolean; default: not declared — Whether the two stored inputs hash identically. - sameRankBy: boolean | null; default: not declared - sameUniverse: boolean | null; default: not declared - scoreDeltas: ScoreDeltasSection | null; default: not declared - scoreDeltas.count: number; default: not declared — Instruments scored on both sides. - scoreDeltas.maximumAbsoluteDelta: number | null; default: not declared - scoreDeltas.meanAbsoluteDelta: number | null; default: not declared - scoreDeltas.perInstrument: ValueDelta[]; default: not declared — Per instrument by |delta| descending, listed up to `limits.listedIds`. - scoreDeltas.remainderCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunCostClass Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ResearchRunCostClass = 'scan' | 'sort' | 'statistic' | 'event-alignment' | 'aggregation'; ``` ### @insiderfinance/totalfinance/research/artifacts#ResearchRunInputs Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchRunInputs { screen: ScreenUniverseInput; rank: RankUniverseInput; score: ScoreUniverseInput; 'event-study': EventStudyInput; 'aggregate-event-studies': AggregateEventStudiesInput; 'information-coefficient': InformationCoefficientInput; 'factor-spread-return': FactorSpreadReturnInput; 'factor-turnover': FactorTurnoverInput; 'factor-decay': FactorDecayInput; 'quantile-portfolios': FormQuantilePortfoliosInput; 'composite-factor-score': CompositeFactorScoreInput; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregate-event-studies: AggregateEventStudiesInput; default: not declared - aggregate-event-studies.studies: readonly EventStudyResult[]; default: not declared - composite-factor-score: CompositeFactorScoreInput; default: not declared - composite-factor-score.components: readonly import('@insiderfinance/totalfinance/research').CompositeComponent[]; default: not declared - composite-factor-score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'` drops an instrument missing any component; `'renormalize-weights'` scores what is present. - event-study: EventStudyInput; default: not declared - event-study.cumulativeConvention?: import('@insiderfinance/totalfinance/research').CumulativeConvention; default: not declared — Default `'sum'` (classic CAR) — documented and echoed. - event-study.estimationWindow?: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared — REQUIRED by `'mean-adjusted'` and `'market'`; must END strictly BEFORE the event window starts — a model estimated through the event measures the event twice. - event-study.estimationWindow.endTradingSessionOffset: number; default: not declared - event-study.estimationWindow.startTradingSessionOffset: number; default: not declared - event-study.eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared — Integers, start ≤ end; offset 0 is the event session. - event-study.eventWindow.endTradingSessionOffset: number; default: not declared - event-study.eventWindow.startTradingSessionOffset: number; default: not declared - event-study.events: readonly import('@insiderfinance/totalfinance/research').MarketEvent[]; default: not declared - event-study.expectedReturnModel: import('@insiderfinance/totalfinance/research').ExpectedReturnModelInput; default: not declared - event-study.expectedReturnModel.expectedReturn: (context: import('@insiderfinance/totalfinance/research').ExpectedReturnContext) => number; default: not declared - event-study.expectedReturnModel.expectedReturn(context): import('@insiderfinance/totalfinance/research').ExpectedReturnContext; default: not declared - event-study.expectedReturnModel.expectedReturn(context).instrumentId: string; default: not declared - event-study.expectedReturnModel.expectedReturn(context).marketReturn?: number; default: not declared — Present when `marketReturns` were supplied and carry this session's date. - event-study.expectedReturnModel.expectedReturn(context).tradingSessionDate: string; default: not declared - event-study.expectedReturnModel.model: ('custom') | ('market') | ('market-adjusted') | ('mean-adjusted'); default: not declared - event-study.marketReturns?: readonly import('@insiderfinance/totalfinance/research').MarketReturnObservation[]; default: not declared — Required by the `'market-adjusted'` and `'market'` models. - event-study.overlappingEventPolicy: import('@insiderfinance/totalfinance/research').OverlappingEventPolicy; default: not declared — REQUIRED, no default — overlap handling changes the statistics, so the caller must choose. - event-study.returnObservations: readonly import('@insiderfinance/totalfinance/research').ReturnObservation[]; default: not declared — Instrument returns per trading session — the sessions ARE these rows' distinct dates. - event-study.sessionPolicy?: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; default: not declared — Default `'next-session'` — documented in the module header and echoed in assumptions. - factor-decay: FactorDecayInput; default: not declared - factor-decay.factorEntries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - factor-decay.horizons: readonly { horizonLabel: string; forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; }[]; default: not declared — Forward returns at increasing horizons, each labeled. - factor-decay.minimumCoverageFraction?: number; default: not declared - factor-spread-return: FactorSpreadReturnInput; default: not declared - factor-spread-return.direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 (highest factor) is the LONG leg. - factor-spread-return.entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - factor-spread-return.forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - factor-spread-return.quantileCount: number; default: not declared - factor-turnover: FactorTurnoverInput; default: not declared - factor-turnover.currentPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - factor-turnover.previousPortfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - information-coefficient: InformationCoefficientInput; default: not declared - information-coefficient.factorEntries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - information-coefficient.forwardReturns: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared — Forward returns over the evaluation horizon, keyed by instrument. - information-coefficient.minimumCoverageFraction?: number; default: not declared - quantile-portfolios: FormQuantilePortfoliosInput; default: not declared - quantile-portfolios.direction: 'ascending' | 'descending'; default: not declared — `'descending'`: portfolio 1 holds the HIGHEST values (the conventional long leg). - quantile-portfolios.entries: readonly import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - quantile-portfolios.quantileCount: number; default: not declared — How many portfolios (e.g. 5 = quintiles). - rank: RankUniverseInput; default: not declared - rank.asOf: number; default: not declared - rank.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - rank.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - rank.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - rank.rankBy: { direction: 'ascending' | 'descending'; field: string; }; default: not declared - rank.rankBy.direction: 'ascending' | 'descending'; default: not declared - rank.rankBy.field: string; default: not declared - rank.tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; default: not declared - rank.universeId: string; default: not declared - score: ScoreUniverseInput; default: not declared - score.asOf: number; default: not declared - score.components: readonly import('@insiderfinance/totalfinance/research').ScoreComponent[]; default: not declared - score.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - score.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared — `'exclude'`: a row missing ANY component is dropped with the reason. `'renormalize-weights'`: the row scores over its PRESENT components with weights renormalized — disclosed per policy, never per row silently. - score.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - score.universeId: string; default: not declared - screen: ScreenUniverseInput; default: not declared - screen.asOf: number; default: not declared - screen.customPredicate?: (observation: import('@insiderfinance/totalfinance/research').UniverseObservation) => boolean; default: not declared — The explicit NON-SERIALIZABLE escape hatch: a caller predicate over the observation. Its presence is classified in `assumptions.customPredicate` so a stored screen recipe cannot silently claim reproducibility it does not have. - screen.customPredicate(observation): import('@insiderfinance/totalfinance/research').UniverseObservation; default: not declared - screen.customPredicate(observation).availableTimestampMs: number; default: not declared - screen.customPredicate(observation).fields: Record; default: not declared — Values for DECLARED fields only; a key with no declaration is a teaching error. - screen.customPredicate(observation).instrumentId: string; default: not declared - screen.fieldDefinitions: readonly import('@insiderfinance/totalfinance/research').FieldDefinition[]; default: not declared - screen.filter?: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared — The serializable filter. Omitted → every eligible row passes (ordering still applies). - screen.filter.all: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - screen.filter.any: readonly import('@insiderfinance/totalfinance/research').ScreenFilter[]; default: not declared - screen.filter.field: string; default: not declared - screen.filter.from: number; default: not declared - screen.filter.not: import('@insiderfinance/totalfinance/research').ScreenFilter; default: not declared - screen.filter.operator: ('between') | ('in' | 'notIn') | ('isPresent' | 'isMissing') | (import('@insiderfinance/totalfinance/research').IdentityComparisonOperator) | (import('@insiderfinance/totalfinance/research').OrderingComparisonOperator); default: not declared - screen.filter.to: number; default: not declared - screen.filter.value: (number) | (string | number | boolean); default: not declared - screen.filter.values: readonly (string | number)[]; default: not declared - screen.limit?: number; default: not declared — Keep at most this many rows after ordering; a non-negative safe integer. Omit for all rows. - screen.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - screen.observations: readonly import('@insiderfinance/totalfinance/research').UniverseObservation[]; default: not declared - screen.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared — Ordering keys; `instrumentId` ascending is ALWAYS appended as the stable final tie-breaker. - screen.universeId: string; default: not declared — The universe's identity, echoed — a screen without provenance is a number without a source. ### @insiderfinance/totalfinance/research/artifacts#ResearchRunKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ResearchRunKind = 'screen' | 'rank' | 'score' | 'event-study' | 'aggregate-event-studies' | 'information-coefficient' | 'factor-spread-return' | 'factor-turnover' | 'factor-decay' | 'quantile-portfolios' | 'composite-factor-score'; ``` ### @insiderfinance/totalfinance/research/artifacts#ResearchRunKindDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The frozen, data-only description of one run kind — the research twin of `FITTED_MODEL_FAMILIES`. ```typescript /** The frozen, data-only description of one run kind — the research twin of `FITTED_MODEL_FAMILIES`. */ export interface ResearchRunKindDescriptor { kind: ResearchRunKind; runVersion: number; /** The direct operation the run re-issues on replay. */ operation: string; /** Bulk row-set patterns in the input (`[]` spans an array: `horizons[].forwardReturns`). */ bulkRowSets: readonly string[]; /** Input fields that, when they carry a caller function, make the run non-replayable. */ callbackFields: readonly string[]; /** Every kind replays from its stored input as long as no callback participated. */ replayableWithoutCallbacks: boolean; costClass: ResearchRunCostClass; requiredData: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bulkRowSets: readonly string[]; default: not declared — Bulk row-set patterns in the input (`[]` spans an array: `horizons[].forwardReturns`). - callbackFields: readonly string[]; default: not declared — Input fields that, when they carry a caller function, make the run non-replayable. - costClass: ResearchRunCostClass; default: not declared - kind: ResearchRunKind; default: not declared - operation: string; default: not declared — The direct operation the run re-issues on replay. - replayableWithoutCallbacks: boolean; default: not declared — Every kind replays from its stored input as long as no callback participated. - requiredData: string; default: not declared - runVersion: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunReplay Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchRunReplay { kind: Kind; artifactId: string; recomputed: ResearchRunReport; parity: ArtifactReplayParity; assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactId: string; default: not declared - assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.kind: Kind; default: not declared - assumptions.libraryVersion: { current: string | null; saved: string | null; }; default: not declared - assumptions.libraryVersion.current: string | null; default: not declared - assumptions.libraryVersion.saved: string | null; default: not declared - assumptions.operation: string; default: not declared - assumptions.referencedRowSets: string[]; default: not declared - assumptions.runVersion: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - kind: Kind; default: not declared - parity: ArtifactReplayParity; default: not declared - parity.addedPaths: string[]; default: not declared - parity.assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - parity.assumptions.comparison: 'canonical JSON bytes'; default: not declared - parity.assumptions.conventionsVersion: string; default: not declared - parity.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - parity.assumptions.limits.maximumDifferences: number; default: not declared - parity.assumptions.limits.maximumLeaves: number; default: not declared - parity.comparedLeafCount: number; default: not declared - parity.diagnostics: { warnings: QuantWarning[]; }; default: not declared - parity.diagnostics.warnings: QuantWarning[]; default: not declared - parity.differenceCount: number; default: not declared - parity.differences: import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]; default: not declared - parity.identical: boolean; default: not declared - parity.recomputedHash: string; default: not declared - parity.removedPaths: string[]; default: not declared - parity.savedHash: string; default: not declared - parity.truncated: boolean; default: not declared - recomputed: ResearchRunReport; default: not declared - recomputed.assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }; default: not declared - recomputed.assumptions.conventionsVersion: string; default: not declared - recomputed.assumptions.embeddedRowLimit: number; default: not declared - recomputed.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - recomputed.assumptions.kind: Kind; default: not declared - recomputed.assumptions.nonReplayableField: string | null; default: not declared — The callback field that made the run non-replayable, when one did. - recomputed.assumptions.operation: string; default: not declared - recomputed.assumptions.projection: string; default: not declared - recomputed.assumptions.replayable: boolean; default: not declared — `false` exactly when a non-serializable callback participated. - recomputed.assumptions.runVersion: number; default: not declared - recomputed.diagnostics: { embeddedRows: number; referencedRows: number; runWarningCount: number; warnings: QuantWarning[]; }; default: not declared - recomputed.diagnostics.embeddedRows: number; default: not declared - recomputed.diagnostics.referencedRows: number; default: not declared - recomputed.diagnostics.runWarningCount: number; default: not declared - recomputed.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.hygiene: ResearchHygieneBlock | null; default: not declared — Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here. - recomputed.hygiene.backtestOverfitting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting; default: not declared - recomputed.hygiene.backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - recomputed.hygiene.backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - recomputed.hygiene.backtestOverfitting.backtestOverfittingProbability: number; default: not declared - recomputed.hygiene.backtestOverfitting.combinations: number; default: not declared - recomputed.hygiene.backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared - recomputed.hygiene.backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.hygiene.backtestOverfitting.medianLogit: number; default: not declared - recomputed.hygiene.backtestOverfitting.observations: number; default: not declared - recomputed.hygiene.backtestOverfitting.splits: number; default: not declared - recomputed.hygiene.backtestOverfitting.trials: number; default: not declared - recomputed.hygiene.deflatedSharpe?: import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe; default: not declared - recomputed.hygiene.deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - recomputed.hygiene.deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - recomputed.hygiene.deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carried no Sharpe (a zero-variance series). - recomputed.hygiene.deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared - recomputed.hygiene.deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.hygiene.deflatedSharpe.expectedMaxSharpe: number; default: not declared - recomputed.hygiene.deflatedSharpe.probabilisticSharpe: number | null; default: not declared - recomputed.hygiene.deflatedSharpe.trialCount: number; default: not declared - recomputed.hygiene.leakage?: import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport; default: not declared - recomputed.hygiene.leakage.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - recomputed.hygiene.leakage.assumptions.conventionsVersion: string; default: not declared - recomputed.hygiene.leakage.clean: boolean; default: not declared - recomputed.hygiene.leakage.diagnostics: { warnings: QuantWarning[]; }; default: not declared - recomputed.hygiene.leakage.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.hygiene.leakage.leaks: { split: number; overlapCount: number; sample: number[]; }[]; default: not declared - recomputed.hygiene.multipleTesting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest; default: not declared - recomputed.hygiene.multipleTesting.adjusted: number[]; default: not declared - recomputed.hygiene.multipleTesting.alpha: number; default: not declared - recomputed.hygiene.multipleTesting.method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; default: not declared - recomputed.hygiene.multipleTesting.rejected: boolean[]; default: not declared - recomputed.hygiene.parameterSweep?: import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep; default: not declared - recomputed.hygiene.parameterSweep.bestSharpe: number; default: not declared - recomputed.hygiene.parameterSweep.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carried no Sharpe (a zero-variance series). - recomputed.hygiene.parameterSweep.expectedMaxSharpe: number; default: not declared - recomputed.hygiene.parameterSweep.meanSharpe: number; default: not declared - recomputed.hygiene.parameterSweep.probabilisticSharpe: number | null; default: not declared - recomputed.hygiene.parameterSweep.trialCount: number; default: not declared - recomputed.hygiene.parameterSweep.varianceSharpe: number; default: not declared - recomputed.hygiene.protocol?: import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict; default: not declared - recomputed.hygiene.protocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - recomputed.hygiene.protocol.assumptions.confidence: number; default: not declared - recomputed.hygiene.protocol.assumptions.conventionsVersion: string; default: not declared - recomputed.hygiene.protocol.assumptions.periodsPerYear: number; default: not declared - recomputed.hygiene.protocol.deflatedSharpe: number | null; default: not declared - recomputed.hygiene.protocol.diagnostics: { warnings: QuantWarning[]; }; default: not declared - recomputed.hygiene.protocol.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.hygiene.protocol.expectedMaxSharpe: number; default: not declared - recomputed.hygiene.protocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. - recomputed.hygiene.protocol.inSample.annualizedSharpe: number | null; default: not declared - recomputed.hygiene.protocol.inSample.observations: number; default: not declared - recomputed.hygiene.protocol.inSample.sharpe: number | null; default: not declared - recomputed.hygiene.protocol.minTrackRecordLength: number; default: not declared — `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. - recomputed.hygiene.protocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared - recomputed.hygiene.protocol.outOfSample.annualizedSharpe: number | null; default: not declared - recomputed.hygiene.protocol.outOfSample.degradation: number | null; default: not declared - recomputed.hygiene.protocol.outOfSample.sharpe: number | null; default: not declared - recomputed.hygiene.protocol.probabilisticSharpe: number | null; default: not declared - recomputed.hygiene.protocol.rationale: string; default: not declared - recomputed.hygiene.protocol.trialCount: number; default: not declared - recomputed.hygiene.protocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - recomputed.inputs: Referenced>; default: not declared — The operation's input with bulk rows either embedded or replaced by verified table references. - recomputed.kind: Kind; default: not declared - recomputed.recipe: FactorRecipe | null; default: not declared — The versioned recipe the caller says produced the factor, when one did. - recomputed.recipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - recomputed.recipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - recomputed.recipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - recomputed.recipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - recomputed.recipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - recomputed.recipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - recomputed.recipe.recipeName: string; default: not declared - recomputed.recipe.recipeVersion: number; default: not declared - recomputed.referencedData: Record; default: not declared — Table references for every bulk row set that was not embedded (Gate B TableHandle). - recomputed.run: RunOf; default: not declared — The direct operation's result, verbatim. - recomputed.runVersion: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The typed report every verb reads and writes — the artifact's `result`, verbatim. ```typescript /** The typed report every verb reads and writes — the artifact's `result`, verbatim. */ export type ResearchRunReport = Readonly> & { kind: Kind; runVersion: number; /** The direct operation's result, verbatim. */ run: RunOf; /** The operation's input with bulk rows either embedded or replaced by verified table references. */ inputs: Referenced>; /** Table references for every bulk row set that was not embedded (Gate B TableHandle). */ referencedData: Record; /** Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here. */ hygiene: ResearchHygieneBlock | null; /** The versioned recipe the caller says produced the factor, when one did. */ recipe: FactorRecipe | null; assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; /** `false` exactly when a non-serializable callback participated. */ replayable: boolean; /** The callback field that made the run non-replayable, when one did. */ nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }; diagnostics: { warnings: QuantWarning[]; embeddedRows: number; referencedRows: number; runWarningCount: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; kind: Kind; runVersion: number; operation: string; replayable: boolean; nonReplayableField: string | null; inputPolicy: 'embedded' | 'referenced'; embeddedRowLimit: number; projection: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.embeddedRowLimit: number; default: not declared - assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - assumptions.kind: Kind; default: not declared - assumptions.nonReplayableField: string | null; default: not declared — The callback field that made the run non-replayable, when one did. - assumptions.operation: string; default: not declared - assumptions.projection: string; default: not declared - assumptions.replayable: boolean; default: not declared — `false` exactly when a non-serializable callback participated. - assumptions.runVersion: number; default: not declared - diagnostics: { embeddedRows: number; referencedRows: number; runWarningCount: number; warnings: QuantWarning[]; }; default: not declared - diagnostics.embeddedRows: number; default: not declared - diagnostics.referencedRows: number; default: not declared - diagnostics.runWarningCount: number; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - hygiene: ResearchHygieneBlock | null; default: not declared — Statistical-hygiene results the caller attached, verbatim — computed by @insiderfinance/totalfinance/risk, never here. - hygiene.backtestOverfitting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneBacktestOverfitting; default: not declared - hygiene.backtestOverfitting.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - hygiene.backtestOverfitting.assumptions.conventionsVersion: string; default: not declared - hygiene.backtestOverfitting.backtestOverfittingProbability: number; default: not declared - hygiene.backtestOverfitting.combinations: number; default: not declared - hygiene.backtestOverfitting.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.backtestOverfitting.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.backtestOverfitting.medianLogit: number; default: not declared - hygiene.backtestOverfitting.observations: number; default: not declared - hygiene.backtestOverfitting.splits: number; default: not declared - hygiene.backtestOverfitting.trials: number; default: not declared - hygiene.deflatedSharpe?: import('@insiderfinance/totalfinance/research/artifacts').HygieneDeflatedSharpe; default: not declared - hygiene.deflatedSharpe.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - hygiene.deflatedSharpe.assumptions.conventionsVersion: string; default: not declared - hygiene.deflatedSharpe.deflatedSharpe: number | null; default: not declared — `null` when the statistics carried no Sharpe (a zero-variance series). - hygiene.deflatedSharpe.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.deflatedSharpe.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.deflatedSharpe.expectedMaxSharpe: number; default: not declared - hygiene.deflatedSharpe.probabilisticSharpe: number | null; default: not declared - hygiene.deflatedSharpe.trialCount: number; default: not declared - hygiene.leakage?: import('@insiderfinance/totalfinance/research/artifacts').HygieneLeakageReport; default: not declared - hygiene.leakage.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared - hygiene.leakage.assumptions.conventionsVersion: string; default: not declared - hygiene.leakage.clean: boolean; default: not declared - hygiene.leakage.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.leakage.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.leakage.leaks: { split: number; overlapCount: number; sample: number[]; }[]; default: not declared - hygiene.multipleTesting?: import('@insiderfinance/totalfinance/research/artifacts').HygieneMultipleTest; default: not declared - hygiene.multipleTesting.adjusted: number[]; default: not declared - hygiene.multipleTesting.alpha: number; default: not declared - hygiene.multipleTesting.method: 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; default: not declared - hygiene.multipleTesting.rejected: boolean[]; default: not declared - hygiene.parameterSweep?: import('@insiderfinance/totalfinance/research/artifacts').HygieneParameterSweep; default: not declared - hygiene.parameterSweep.bestSharpe: number; default: not declared - hygiene.parameterSweep.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carried no Sharpe (a zero-variance series). - hygiene.parameterSweep.expectedMaxSharpe: number; default: not declared - hygiene.parameterSweep.meanSharpe: number; default: not declared - hygiene.parameterSweep.probabilisticSharpe: number | null; default: not declared - hygiene.parameterSweep.trialCount: number; default: not declared - hygiene.parameterSweep.varianceSharpe: number; default: not declared - hygiene.protocol?: import('@insiderfinance/totalfinance/research/artifacts').HygieneResearchVerdict; default: not declared - hygiene.protocol.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - hygiene.protocol.assumptions.confidence: number; default: not declared - hygiene.protocol.assumptions.conventionsVersion: string; default: not declared - hygiene.protocol.assumptions.periodsPerYear: number; default: not declared - hygiene.protocol.deflatedSharpe: number | null; default: not declared - hygiene.protocol.diagnostics: { warnings: QuantWarning[]; }; default: not declared - hygiene.protocol.diagnostics.warnings: QuantWarning[]; default: not declared - hygiene.protocol.expectedMaxSharpe: number; default: not declared - hygiene.protocol.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` when the returns had zero variance (C hygiene); the verdict is then `inconclusive`. - hygiene.protocol.inSample.annualizedSharpe: number | null; default: not declared - hygiene.protocol.inSample.observations: number; default: not declared - hygiene.protocol.inSample.sharpe: number | null; default: not declared - hygiene.protocol.minTrackRecordLength: number; default: not declared — `Infinity` when the Sharpe is at or below its benchmark — a disclosed non-finite the producing law made legal. - hygiene.protocol.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared - hygiene.protocol.outOfSample.annualizedSharpe: number | null; default: not declared - hygiene.protocol.outOfSample.degradation: number | null; default: not declared - hygiene.protocol.outOfSample.sharpe: number | null; default: not declared - hygiene.protocol.probabilisticSharpe: number | null; default: not declared - hygiene.protocol.rationale: string; default: not declared - hygiene.protocol.trialCount: number; default: not declared - hygiene.protocol.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared - inputs: Referenced>; default: not declared — The operation's input with bulk rows either embedded or replaced by verified table references. - kind: Kind; default: not declared - recipe: FactorRecipe | null; default: not declared — The versioned recipe the caller says produced the factor, when one did. - recipe.direction: 'higher-is-better' | 'lower-is-better'; default: not declared - recipe.disclosure: string; default: not declared — The disclosure every canonical recipe carries: a definition, not the definition. - recipe.features: readonly import('@insiderfinance/totalfinance/research').FactorRecipeFeature[]; default: not declared - recipe.lagTradingSessions: number; default: not declared — Sessions between the information date and use — the lookahead guard. - recipe.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - recipe.neutralization: 'none' | 'sector' | 'sector-and-size'; default: not declared - recipe.recipeName: string; default: not declared - recipe.recipeVersion: number; default: not declared - referencedData: Record; default: not declared — Table references for every bulk row set that was not embedded (Gate B TableHandle). - run: RunOf; default: not declared — The direct operation's result, verbatim. - runVersion: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ResearchRunResults Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResearchRunResults { screen: ScreenUniverseResult; rank: RankUniverseResult; score: ScoreUniverseResult; 'event-study': EventStudyResult; 'aggregate-event-studies': AggregateEventStudiesResult; 'information-coefficient': InformationCoefficientResult; 'factor-spread-return': FactorSpreadReturnResult; 'factor-turnover': FactorTurnoverResult; 'factor-decay': FactorDecayResult; 'quantile-portfolios': FormQuantilePortfoliosResult; 'composite-factor-score': CompositeFactorScoreResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregate-event-studies: AggregateEventStudiesResult; default: not declared - aggregate-event-studies.assumptions: import('@insiderfinance/totalfinance/research').AggregateEventStudiesAssumptions; default: not declared - aggregate-event-studies.assumptions.cumulativeConvention: import('@insiderfinance/totalfinance/research').CumulativeConvention; default: not declared - aggregate-event-studies.assumptions.estimationWindow?: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared — Present only when every study declared the identical estimation window. - aggregate-event-studies.assumptions.estimationWindow.endTradingSessionOffset: number; default: not declared - aggregate-event-studies.assumptions.estimationWindow.startTradingSessionOffset: number; default: not declared - aggregate-event-studies.assumptions.eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared - aggregate-event-studies.assumptions.eventWindow.endTradingSessionOffset: number; default: not declared - aggregate-event-studies.assumptions.eventWindow.startTradingSessionOffset: number; default: not declared - aggregate-event-studies.assumptions.expectedReturnModel: string; default: not declared — The shared model name, or `'mixed (…)'` naming each model pooled. - aggregate-event-studies.assumptions.overlappingEventPolicy: import('@insiderfinance/totalfinance/research').OverlappingEventPolicy | 'mixed'; default: not declared — The shared policy, or `'mixed'` when studies differ. - aggregate-event-studies.assumptions.sessionPolicy: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; default: not declared - aggregate-event-studies.averageAbnormalReturns: AverageAbnormalReturnRow[]; default: not declared - aggregate-event-studies.diagnostics: import('@insiderfinance/totalfinance/research').EventStudyDiagnostics; default: not declared - aggregate-event-studies.diagnostics.contaminatedEventIds: string[]; default: not declared — Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed). - aggregate-event-studies.diagnostics.eventsIncluded: number; default: not declared - aggregate-event-studies.diagnostics.eventsSupplied: number; default: not declared - aggregate-event-studies.diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - aggregate-event-studies.diagnostics.warnings: string[]; default: not declared - aggregate-event-studies.events: import('@insiderfinance/totalfinance/research').EventStudyEventResult[]; default: not declared - aggregate-event-studies.studiesAggregated: number; default: not declared - composite-factor-score: CompositeFactorScoreResult; default: not declared - composite-factor-score.assumptions: { components: Array<{ label: string; weight: number; normalizedWeight: number; direction: string; }>; missingValuePolicy: 'exclude' | 'renormalize-weights'; }; default: not declared - composite-factor-score.assumptions.components: { label: string; weight: number; normalizedWeight: number; direction: string; }[]; default: not declared - composite-factor-score.assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - composite-factor-score.diagnostics: { exclusionReasons: Record; instrumentCount: number; scoredCount: number; warnings: string[]; }; default: not declared - composite-factor-score.diagnostics.exclusionReasons: Record; default: not declared - composite-factor-score.diagnostics.instrumentCount: number; default: not declared - composite-factor-score.diagnostics.scoredCount: number; default: not declared - composite-factor-score.diagnostics.warnings: string[]; default: not declared - composite-factor-score.entries: import('@insiderfinance/totalfinance/research').FactorEntry[]; default: not declared - event-study: EventStudyResult; default: not declared - event-study.assumptions: import('@insiderfinance/totalfinance/research').EventStudyAssumptions; default: not declared - event-study.assumptions.cumulativeConvention: import('@insiderfinance/totalfinance/research').CumulativeConvention; default: not declared - event-study.assumptions.estimationWindow?: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared — Echoed exactly when supplied. - event-study.assumptions.estimationWindow.endTradingSessionOffset: number; default: not declared - event-study.assumptions.estimationWindow.startTradingSessionOffset: number; default: not declared - event-study.assumptions.eventWindow: import('@insiderfinance/totalfinance/research').TradingSessionWindow; default: not declared - event-study.assumptions.eventWindow.endTradingSessionOffset: number; default: not declared - event-study.assumptions.eventWindow.startTradingSessionOffset: number; default: not declared - event-study.assumptions.expectedReturnModel: string; default: not declared — The model name; a caller function is classified `'custom (non-serializable)'`. - event-study.assumptions.overlappingEventPolicy: import('@insiderfinance/totalfinance/research').OverlappingEventPolicy; default: not declared - event-study.assumptions.sessionPolicy: import('@insiderfinance/totalfinance/research').EventStudySessionPolicy; default: not declared - event-study.averageAbnormalReturns: AverageAbnormalReturnRow[]; default: not declared - event-study.diagnostics: import('@insiderfinance/totalfinance/research').EventStudyDiagnostics; default: not declared - event-study.diagnostics.contaminatedEventIds: string[]; default: not declared — Populated under `'allow-contaminated'`; empty under `'reject'` (contamination is removed). - event-study.diagnostics.eventsIncluded: number; default: not declared - event-study.diagnostics.eventsSupplied: number; default: not declared - event-study.diagnostics.excludedEvents: { eventId: string; reason: string; }[]; default: not declared - event-study.diagnostics.warnings: string[]; default: not declared - event-study.events: import('@insiderfinance/totalfinance/research').EventStudyEventResult[]; default: not declared - factor-decay: FactorDecayResult; default: not declared - factor-decay.assumptions: { coefficient: 'rank information coefficient per horizon'; minimumCoverageFraction: number; }; default: not declared - factor-decay.assumptions.coefficient: 'rank information coefficient per horizon'; default: not declared - factor-decay.assumptions.minimumCoverageFraction: number; default: not declared - factor-decay.byHorizon: { horizonLabel: string; rankInformationCoefficient: number | null; pairedCount: number; reason?: string; }[]; default: not declared - factor-decay.diagnostics: { warnings: string[]; }; default: not declared - factor-decay.diagnostics.warnings: string[]; default: not declared - factor-spread-return: FactorSpreadReturnResult; default: not declared - factor-spread-return.assumptions: { direction: 'ascending' | 'descending'; legWeighting: 'equal weight within each leg'; quantileCount: number; }; default: not declared - factor-spread-return.assumptions.direction: 'ascending' | 'descending'; default: not declared - factor-spread-return.assumptions.legWeighting: 'equal weight within each leg'; default: not declared - factor-spread-return.assumptions.quantileCount: number; default: not declared - factor-spread-return.diagnostics: { longLegCount: number; shortLegCount: number; warnings: string[]; }; default: not declared - factor-spread-return.diagnostics.longLegCount: number; default: not declared - factor-spread-return.diagnostics.shortLegCount: number; default: not declared - factor-spread-return.diagnostics.warnings: string[]; default: not declared - factor-spread-return.longLegMeanReturn: number | null; default: not declared - factor-spread-return.reason?: string; default: not declared - factor-spread-return.shortLegMeanReturn: number | null; default: not declared - factor-spread-return.spreadReturn: number | null; default: not declared — Mean forward return of portfolio 1 minus portfolio N, or null with the reason. - factor-turnover: FactorTurnoverResult; default: not declared - factor-turnover.assumptions: { definition: 'fraction of the current portfolio not present in the previous one'; }; default: not declared - factor-turnover.assumptions.definition: 'fraction of the current portfolio not present in the previous one'; default: not declared - factor-turnover.byQuantile: { quantileIndex: number; turnover: number | null; reason?: string; }[]; default: not declared - factor-turnover.diagnostics: { warnings: string[]; }; default: not declared - factor-turnover.diagnostics.warnings: string[]; default: not declared - information-coefficient: InformationCoefficientResult; default: not declared - information-coefficient.assumptions: { minimumCoverageFraction: number; pearsonBasis: 'values'; rankBasis: 'average ranks (Spearman)'; }; default: not declared - information-coefficient.assumptions.minimumCoverageFraction: number; default: not declared - information-coefficient.assumptions.pearsonBasis: 'values'; default: not declared - information-coefficient.assumptions.rankBasis: 'average ranks (Spearman)'; default: not declared - information-coefficient.diagnostics: { pairedCount: number; warnings: string[]; }; default: not declared - information-coefficient.diagnostics.pairedCount: number; default: not declared - information-coefficient.diagnostics.warnings: string[]; default: not declared - information-coefficient.informationCoefficient: number | null; default: not declared — Pearson correlation of factor values with forward returns, or null with the reason. - information-coefficient.rankInformationCoefficient: number | null; default: not declared — Spearman (rank) correlation, or null with the reason. - information-coefficient.reason?: string; default: not declared - quantile-portfolios: FormQuantilePortfoliosResult; default: not declared - quantile-portfolios.assumptions: { direction: 'ascending' | 'descending'; quantileCount: number; sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; tieBreaker: 'instrumentId ascending'; }; default: not declared - quantile-portfolios.assumptions.direction: 'ascending' | 'descending'; default: not declared - quantile-portfolios.assumptions.quantileCount: number; default: not declared - quantile-portfolios.assumptions.sizing: 'as equal as arithmetic allows; earlier portfolios take the remainder'; default: not declared - quantile-portfolios.assumptions.tieBreaker: 'instrumentId ascending'; default: not declared - quantile-portfolios.diagnostics: { coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; excludedMissingCount: number; warnings: string[]; }; default: not declared - quantile-portfolios.diagnostics.coverage: import('@insiderfinance/totalfinance/research').FactorCoverage; default: not declared - quantile-portfolios.diagnostics.coverage.coverageFraction: number; default: not declared - quantile-portfolios.diagnostics.coverage.entryCount: number; default: not declared - quantile-portfolios.diagnostics.coverage.valuedCount: number; default: not declared - quantile-portfolios.diagnostics.excludedMissingCount: number; default: not declared - quantile-portfolios.diagnostics.warnings: string[]; default: not declared - quantile-portfolios.portfolios: { quantileIndex: number; instrumentIds: string[]; }[]; default: not declared - rank: RankUniverseResult; default: not declared - rank.assumptions: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; rankBy: { field: string; direction: 'ascending' | 'descending'; }; tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - rank.assumptions.asOf: number; default: not declared - rank.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - rank.assumptions.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - rank.assumptions.rankBy: { direction: 'ascending' | 'descending'; field: string; }; default: not declared - rank.assumptions.rankBy.direction: 'ascending' | 'descending'; default: not declared - rank.assumptions.rankBy.field: string; default: not declared - rank.assumptions.tiePolicy: import('@insiderfinance/totalfinance/research').RankTiePolicy; default: not declared - rank.assumptions.universeId: string; default: not declared - rank.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - rank.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; rankedCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - rank.diagnostics.eligibleCount: number; default: not declared - rank.diagnostics.excludedCount: number; default: not declared - rank.diagnostics.exclusionReasons: Record; default: not declared - rank.diagnostics.rankedCount: number; default: not declared - rank.diagnostics.suppliedCount: number; default: not declared - rank.diagnostics.warnings: string[]; default: not declared - rank.rows: { instrumentId: string; value: number; rank: number; }[]; default: not declared - score: ScoreUniverseResult; default: not declared - score.assumptions: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; components: Array; finalTieBreaker: 'instrumentId ascending'; missingValuePolicy: 'exclude' | 'renormalize-weights'; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - score.assumptions.asOf: number; default: not declared - score.assumptions.components: (import('@insiderfinance/totalfinance/research').ScoreComponent & { normalizedWeight: number; })[]; default: not declared - score.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared - score.assumptions.missingValuePolicy: 'exclude' | 'renormalize-weights'; default: not declared - score.assumptions.universeId: string; default: not declared - score.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - score.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; scoredCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - score.diagnostics.eligibleCount: number; default: not declared - score.diagnostics.excludedCount: number; default: not declared - score.diagnostics.exclusionReasons: Record; default: not declared - score.diagnostics.scoredCount: number; default: not declared - score.diagnostics.suppliedCount: number; default: not declared - score.diagnostics.warnings: string[]; default: not declared - score.rows: { instrumentId: string; score: number; componentsUsed: number; }[]; default: not declared - screen: ScreenUniverseResult; default: not declared - screen.assumptions: { asOf: import('@insiderfinance/totalfinance/core').EpochMs; customPredicate?: 'non-serializable caller predicate'; finalTieBreaker: 'instrumentId ascending'; limit?: number; missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; universeId: string; versionResolution: 'latest available at or before asOf per instrument'; }; default: not declared - screen.assumptions.asOf: number; default: not declared - screen.assumptions.customPredicate?: 'non-serializable caller predicate'; default: not declared — Present exactly when a caller predicate participated. - screen.assumptions.finalTieBreaker: 'instrumentId ascending'; default: not declared — The stable final ordering key, always applied — determinism under input permutation. - screen.assumptions.limit?: number; default: not declared - screen.assumptions.missingValuePolicy: import('@insiderfinance/totalfinance/research').MissingValuePolicy; default: not declared - screen.assumptions.orderBy: readonly import('@insiderfinance/totalfinance/research').ScreenOrdering[]; default: not declared - screen.assumptions.universeId: string; default: not declared - screen.assumptions.versionResolution: 'latest available at or before asOf per instrument'; default: not declared - screen.diagnostics: { eligibleCount: number; excludedCount: number; exclusionReasons: Record; includedCount: number; suppliedCount: number; warnings: string[]; }; default: not declared - screen.diagnostics.eligibleCount: number; default: not declared - screen.diagnostics.excludedCount: number; default: not declared - screen.diagnostics.exclusionReasons: Record; default: not declared — Every exclusion, tallied by reason. - screen.diagnostics.includedCount: number; default: not declared - screen.diagnostics.suppliedCount: number; default: not declared - screen.diagnostics.warnings: string[]; default: not declared - screen.rows: import('@insiderfinance/totalfinance/research').ScreenedRow[]; default: not declared ### @insiderfinance/totalfinance/research/artifacts#RunOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RunOf = ResearchRunResults[K]; ``` ### @insiderfinance/totalfinance/research/artifacts#ScoreDeltasSection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScoreDeltasSection { /** Instruments scored on both sides. */ count: number; meanAbsoluteDelta: number | null; maximumAbsoluteDelta: number | null; /** Per instrument by |delta| descending, listed up to `limits.listedIds`. */ perInstrument: ValueDelta[]; remainderCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared — Instruments scored on both sides. - maximumAbsoluteDelta: number | null; default: not declared - meanAbsoluteDelta: number | null; default: not declared - perInstrument: ValueDelta[]; default: not declared — Per instrument by |delta| descending, listed up to `limits.listedIds`. - remainderCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#ValueDelta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ValueDelta { instrumentId: string; baselineValue: number; candidateValue: number; absoluteDelta: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - absoluteDelta: number; default: not declared - baselineValue: number; default: not declared - candidateValue: number; default: not declared - instrumentId: string; default: not declared ### @insiderfinance/totalfinance/research/artifacts#compareResearchRuns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare two research runs of one kind: identity (universe, as-of, filter / rank field / components), membership, rank moves, score deltas, exclusion-reason deltas, coefficient deltas, abnormal-return deltas per session offset, per-quantile and per-horizon deltas, the hygiene verdict change, and the structural diff of the two verbatim runs (Decision 6). Baseline and candidate are named, never "a" and "b"; nothing is a single similarity score. ```typescript export declare function compareResearchRuns(input: { baseline: ResearchRunReport | AnalysisArtifact; candidate: ResearchRunReport | AnalysisArtifact; limits?: ComparisonLimits & { listedIds?: number; }; }): ResearchRunComparison; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { baseline: ResearchRunReport | AnalysisArtifact; candidate: ResearchRunReport | AnalysisArtifact; limits?: ComparisonLimits & { listedIds?: number; }; }; default: not declared - (input).baseline: AnalysisArtifact | ResearchRunReport; default: not declared - (input).baseline.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).baseline.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).baseline.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).baseline.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).baseline.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).baseline.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).baseline.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).baseline.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).baseline.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).baseline.schemaVersion: number; default: not declared - (input).baseline.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).candidate: AnalysisArtifact | ResearchRunReport; default: not declared - (input).candidate.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).candidate.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).candidate.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).candidate.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).candidate.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).candidate.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).candidate.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).candidate.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).candidate.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).candidate.schemaVersion: number; default: not declared - (input).candidate.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).limits?: ComparisonLimits & { listedIds?: number; }; default: not declared - (input).limits.listedIds?: number; default: not declared - (input).limits.maximumDifferences?: number; default: not declared — Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted. - (input).limits.maximumLeaves?: number; default: not declared — Canonical work units each side may cost before the comparison refuses (default and maximum 2,000,000). A leaf costs one unit, so this bounds the leaves walked from above. - return.artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - return.artifactIds.baseline: string | null; default: not declared - return.artifactIds.candidate: string | null; default: not declared - return.assumptions: { conventionsVersion: string; kind: Kind; limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.kind: Kind; default: not declared - return.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; listedIds: number; }; default: not declared - return.assumptions.limits.listedIds: number; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.averageAbnormalReturns: AbnormalReturnDelta[] | null; default: not declared - return.coefficients: NamedDelta[] | null; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.exclusionReasons: CountDelta[] | null; default: not declared - return.horizons: KeyedDelta[] | null; default: not declared - return.hygieneVerdict: HygieneVerdictSection | null; default: not declared - return.hygieneVerdict.baseline: string; default: not declared - return.hygieneVerdict.candidate: string; default: not declared - return.hygieneVerdict.changed: boolean; default: not declared - return.kind: Kind; default: not declared - return.membership: MembershipSection | null; default: not declared — Each section is `null` where the kind has no such content. - return.membership.entered: IdListSection; default: not declared - return.membership.exited: IdListSection; default: not declared - return.membership.kept: IdListSection; default: not declared - return.portfolios: PortfolioMembership[] | null; default: not declared - return.quantiles: KeyedDelta[] | null; default: not declared - return.rankMoves: RankMovesSection | null; default: not declared - return.rankMoves.movedCount: number; default: not declared — Instruments ranked on both sides whose rank changed. - return.rankMoves.movers: RankMove[]; default: not declared — The largest movers by |delta|, listed up to `limits.listedIds`. - return.rankMoves.remainderCount: number; default: not declared - return.run: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; default: not declared — The structural diff of the two verbatim runs through the parity walk. - return.run.addedPaths: string[]; default: not declared - return.run.differenceCount: number; default: not declared - return.run.removedPaths: string[]; default: not declared - return.run.retainedDifferences: number; default: not declared - return.run.truncated: boolean; default: not declared - return.sameAsOf: boolean | null; default: not declared - return.sameComponents: boolean | null; default: not declared - return.sameFilter: boolean | null; default: not declared - return.sameInputs: boolean; default: not declared — Whether the two stored inputs hash identically. - return.sameRankBy: boolean | null; default: not declared - return.sameUniverse: boolean | null; default: not declared - return.scoreDeltas: ScoreDeltasSection | null; default: not declared - return.scoreDeltas.count: number; default: not declared — Instruments scored on both sides. - return.scoreDeltas.maximumAbsoluteDelta: number | null; default: not declared - return.scoreDeltas.meanAbsoluteDelta: number | null; default: not declared - return.scoreDeltas.perInstrument: ValueDelta[]; default: not declared — Per instrument by |delta| descending, listed up to `limits.listedIds`. - return.scoreDeltas.remainderCount: number; default: not declared ### @insiderfinance/totalfinance/research/artifacts#readResearchRun Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore a research-run artifact: Gate B's read door, a foreign-type refusal, then the caller's registry applied a second time at the run level under `research.run:` (Decision 5), then the report re-validated. ```typescript export declare function readResearchRun(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; }): ReadResearchRunResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).migrations?: ArtifactMigrationRegistry; default: not declared - return.artifact: AnalysisArtifact; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared — Envelope-level migrations applied by the Gate B read door. - return.modelMigrationsApplied: AppliedMigration[]; default: not declared — Report-level (run-version) migrations applied under `research.run:` — the same echo shape as the fitted-model read doors. - return.report: ResearchRunReport; default: not declared ### @insiderfinance/totalfinance/research/artifacts#replayResearchRun Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-issue the run's direct operation from the stored input and compare canonical bytes with the saved run (Decision 7). Referenced row sets must be supplied and re-verify by hash; a run that recorded a caller callback refuses by name. ```typescript export declare function replayResearchRun(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; libraryVersion?: string; limits?: ComparisonLimits; }): ResearchRunReplay; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; libraryVersion?: string; limits?: ComparisonLimits; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).libraryVersion?: string; default: not declared - (input).limits?: ComparisonLimits; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).referencedData?: Record; default: not declared - return.artifactId: string; default: not declared - return.assumptions: { conventionsVersion: string; kind: ResearchRunKind; runVersion: number; operation: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.kind: ResearchRunKind; default: not declared - return.assumptions.libraryVersion: { saved: string | null; current: string | null; }; default: not declared - return.assumptions.libraryVersion.current: string | null; default: not declared - return.assumptions.libraryVersion.saved: string | null; default: not declared - return.assumptions.operation: string; default: not declared - return.assumptions.referencedRowSets: string[]; default: not declared - return.assumptions.runVersion: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.kind: ResearchRunKind; default: not declared - return.parity: ArtifactReplayParity; default: not declared - return.recomputed: ResearchRunReport; default: not declared ### @insiderfinance/totalfinance/research/artifacts#researchRunArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Describe a direct research operation's result and save it as an identified, immutable artifact. ```typescript export declare function researchRunArtifact(input: ResearchRunArtifactInput): AnalysisArtifact; ``` Example (source JSDoc): ```ts const run = screenUniverse(input); const artifact = researchRunArtifact({ kind: 'screen', run, input, referenceRowSets: ['observations'] }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ResearchRunArtifactInput; default: not declared - (input).createdFrom?: string[]; default: not declared — Parent artifact ids (a transform, a prior study, a portfolio set) so lineage is walkable. - (input).hygiene?: ResearchHygieneBlock; default: not declared — Up to six verbatim @insiderfinance/totalfinance/risk results — validated structurally, stored verbatim, never recomputed. - (input).input: InputOf; default: not declared — The operation's input as it was called — rows included; a caller function is recorded and not stored. - (input).kind: Kind; default: not declared - (input).libraryVersion?: string; default: not declared - (input).limits?: ResearchRunArtifactLimits; default: not declared - (input).locators?: Record; default: not declared — Storage locators to stamp on the minted handles, keyed by row-set label. - (input).provenance?: Provenance; default: not declared - (input).recipe?: FactorRecipe; default: not declared — The versioned factor recipe that produced the factor, stored verbatim (covered by the artifact id). - (input).referenceRowSets?: readonly string[]; default: not declared — Concrete row-set labels (`observations`, `horizons[0].forwardReturns`) to store by `TableHandle` instead of embedding. - (input).run: RunOf; default: not declared — The direct operation's result, verbatim. - (input).snapshotHash?: string; default: not declared - return.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - return.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - return.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - return.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - return.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - return.kind: 'totalfinance.analysis-artifact'; default: not declared - return.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - return.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - return.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - return.schemaVersion: number; default: not declared - return.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ## Entrypoint @insiderfinance/totalfinance/research/events ### @insiderfinance/totalfinance/research/events#AbnormalReturnRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AbnormalReturnRow`. ### @insiderfinance/totalfinance/research/events#AggregateEventStudiesAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AggregateEventStudiesAssumptions`. ### @insiderfinance/totalfinance/research/events#AggregateEventStudiesInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AggregateEventStudiesInput`. ### @insiderfinance/totalfinance/research/events#AggregateEventStudiesResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AggregateEventStudiesResult`. ### @insiderfinance/totalfinance/research/events#AlignEventWindowsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AlignEventWindowsInput`. ### @insiderfinance/totalfinance/research/events#AlignEventWindowsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AlignEventWindowsResult`. ### @insiderfinance/totalfinance/research/events#AlignedEventWindow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AlignedEventWindow`. ### @insiderfinance/totalfinance/research/events#AlignedSessionRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AlignedSessionRow`. ### @insiderfinance/totalfinance/research/events#AverageAbnormalReturnRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#AverageAbnormalReturnRow`. ### @insiderfinance/totalfinance/research/events#CumulativeConvention Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#CumulativeConvention`. ### @insiderfinance/totalfinance/research/events#EventMarketModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventMarketModel`. ### @insiderfinance/totalfinance/research/events#EventStudyAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventStudyAssumptions`. ### @insiderfinance/totalfinance/research/events#EventStudyDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventStudyDiagnostics`. ### @insiderfinance/totalfinance/research/events#EventStudyEventResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventStudyEventResult`. ### @insiderfinance/totalfinance/research/events#EventStudyInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventStudyInput`. ### @insiderfinance/totalfinance/research/events#EventStudyResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventStudyResult`. ### @insiderfinance/totalfinance/research/events#EventStudySessionPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EventStudySessionPolicy`. ### @insiderfinance/totalfinance/research/events#ExpectedReturnContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ExpectedReturnContext`. ### @insiderfinance/totalfinance/research/events#ExpectedReturnModelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ExpectedReturnModelInput`. ### @insiderfinance/totalfinance/research/events#MarketReturnObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#MarketReturnObservation`. ### @insiderfinance/totalfinance/research/events#OverlappingEventPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#OverlappingEventPolicy`. ### @insiderfinance/totalfinance/research/events#TradingSessionWindow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#TradingSessionWindow`. ### @insiderfinance/totalfinance/research/events#aggregateEventStudies Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#aggregateEventStudies`. ### @insiderfinance/totalfinance/research/events#alignEventWindows Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#alignEventWindows`. ### @insiderfinance/totalfinance/research/events#eventStudy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#eventStudy`. ## Entrypoint @insiderfinance/totalfinance/research/factors ### @insiderfinance/totalfinance/research/factors#CANONICAL_FACTOR_RECIPES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#CANONICAL_FACTOR_RECIPES`. ### @insiderfinance/totalfinance/research/factors#CompositeComponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#CompositeComponent`. ### @insiderfinance/totalfinance/research/factors#CompositeFactorScoreInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#CompositeFactorScoreInput`. ### @insiderfinance/totalfinance/research/factors#CompositeFactorScoreResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#CompositeFactorScoreResult`. ### @insiderfinance/totalfinance/research/factors#FactorCoverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorCoverage`. ### @insiderfinance/totalfinance/research/factors#FactorDecayInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorDecayInput`. ### @insiderfinance/totalfinance/research/factors#FactorDecayResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorDecayResult`. ### @insiderfinance/totalfinance/research/factors#FactorEntry Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorEntry`. ### @insiderfinance/totalfinance/research/factors#FactorRecipe Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorRecipe`. ### @insiderfinance/totalfinance/research/factors#FactorRecipeFeature Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorRecipeFeature`. ### @insiderfinance/totalfinance/research/factors#FactorSpreadReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorSpreadReturnInput`. ### @insiderfinance/totalfinance/research/factors#FactorSpreadReturnResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorSpreadReturnResult`. ### @insiderfinance/totalfinance/research/factors#FactorTurnoverInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorTurnoverInput`. ### @insiderfinance/totalfinance/research/factors#FactorTurnoverResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FactorTurnoverResult`. ### @insiderfinance/totalfinance/research/factors#FormQuantilePortfoliosInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FormQuantilePortfoliosInput`. ### @insiderfinance/totalfinance/research/factors#FormQuantilePortfoliosResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#FormQuantilePortfoliosResult`. ### @insiderfinance/totalfinance/research/factors#InformationCoefficientInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#InformationCoefficientInput`. ### @insiderfinance/totalfinance/research/factors#InformationCoefficientResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#InformationCoefficientResult`. ### @insiderfinance/totalfinance/research/factors#NeutralizeFactorInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#NeutralizeFactorInput`. ### @insiderfinance/totalfinance/research/factors#NeutralizeFactorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#NeutralizeFactorResult`. ### @insiderfinance/totalfinance/research/factors#StandardizeFactorInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#StandardizeFactorInput`. ### @insiderfinance/totalfinance/research/factors#StandardizeFactorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#StandardizeFactorResult`. ### @insiderfinance/totalfinance/research/factors#WinsorizationMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#WinsorizationMethod`. ### @insiderfinance/totalfinance/research/factors#WinsorizeFactorInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#WinsorizeFactorInput`. ### @insiderfinance/totalfinance/research/factors#WinsorizeFactorResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#WinsorizeFactorResult`. ### @insiderfinance/totalfinance/research/factors#compositeFactorScore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#compositeFactorScore`. ### @insiderfinance/totalfinance/research/factors#factorDecay Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#factorDecay`. ### @insiderfinance/totalfinance/research/factors#factorSpreadReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#factorSpreadReturn`. ### @insiderfinance/totalfinance/research/factors#factorTurnover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#factorTurnover`. ### @insiderfinance/totalfinance/research/factors#formQuantilePortfolios Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#formQuantilePortfolios`. ### @insiderfinance/totalfinance/research/factors#informationCoefficient Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#informationCoefficient`. ### @insiderfinance/totalfinance/research/factors#neutralizeFactor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#neutralizeFactor`. ### @insiderfinance/totalfinance/research/factors#standardizeFactor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#standardizeFactor`. ### @insiderfinance/totalfinance/research/factors#winsorizeFactor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#winsorizeFactor`. ## Entrypoint @insiderfinance/totalfinance/research/screening ### @insiderfinance/totalfinance/research/screening#ComparisonOperator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ComparisonOperator`. ### @insiderfinance/totalfinance/research/screening#EligibilityLag Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EligibilityLag`. ### @insiderfinance/totalfinance/research/screening#EligibleObservationsAtInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EligibleObservationsAtInput`. ### @insiderfinance/totalfinance/research/screening#EligibleObservationsAtResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#EligibleObservationsAtResult`. ### @insiderfinance/totalfinance/research/screening#IdentityComparisonOperator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#IdentityComparisonOperator`. ### @insiderfinance/totalfinance/research/screening#MissingValuePolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#MissingValuePolicy`. ### @insiderfinance/totalfinance/research/screening#OrderingComparisonOperator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#OrderingComparisonOperator`. ### @insiderfinance/totalfinance/research/screening#RankTiePolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#RankTiePolicy`. ### @insiderfinance/totalfinance/research/screening#RankUniverseInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#RankUniverseInput`. ### @insiderfinance/totalfinance/research/screening#RankUniverseResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#RankUniverseResult`. ### @insiderfinance/totalfinance/research/screening#ScoreComponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScoreComponent`. ### @insiderfinance/totalfinance/research/screening#ScoreUniverseInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScoreUniverseInput`. ### @insiderfinance/totalfinance/research/screening#ScoreUniverseResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScoreUniverseResult`. ### @insiderfinance/totalfinance/research/screening#ScreenFilter Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScreenFilter`. ### @insiderfinance/totalfinance/research/screening#ScreenOrdering Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScreenOrdering`. ### @insiderfinance/totalfinance/research/screening#ScreenUniverseInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScreenUniverseInput`. ### @insiderfinance/totalfinance/research/screening#ScreenUniverseResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScreenUniverseResult`. ### @insiderfinance/totalfinance/research/screening#ScreenedRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#ScreenedRow`. ### @insiderfinance/totalfinance/research/screening#UniverseExit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#UniverseExit`. ### @insiderfinance/totalfinance/research/screening#UniverseExitReason Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#UniverseExitReason`. ### @insiderfinance/totalfinance/research/screening#UniverseHistory Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#UniverseHistory`. ### @insiderfinance/totalfinance/research/screening#UniverseMember Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#UniverseMember`. ### @insiderfinance/totalfinance/research/screening#UniverseMembershipAtInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#UniverseMembershipAtInput`. ### @insiderfinance/totalfinance/research/screening#UniverseMembershipAtResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#UniverseMembershipAtResult`. ### @insiderfinance/totalfinance/research/screening#eligibleObservationsAt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#eligibleObservationsAt`. ### @insiderfinance/totalfinance/research/screening#rankUniverse Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#rankUniverse`. ### @insiderfinance/totalfinance/research/screening#requireScreenFilter Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#requireScreenFilter`. ### @insiderfinance/totalfinance/research/screening#requireUniverseHistory Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#requireUniverseHistory`. ### @insiderfinance/totalfinance/research/screening#scoreUniverse Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#scoreUniverse`. ### @insiderfinance/totalfinance/research/screening#screenUniverse Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#screenUniverse`. ### @insiderfinance/totalfinance/research/screening#universeMembershipAt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/research#universeMembershipAt`. ## Entrypoint @insiderfinance/totalfinance/risk ### @insiderfinance/totalfinance/risk#AggregateGreeksResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link aggregateGreeks}'s envelope: `value` carries the book-level totals; `assumptions` echo the position count and the missing-greeks-count-as-0 convention. ```typescript /** * {@link aggregateGreeks}'s envelope: `value` carries the book-level totals; `assumptions` echo the * position count and the missing-greeks-count-as-0 convention. */ export type AggregateGreeksResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ positions: number; missingGreeks: 'counted-as-zero'; contractMultiplier: 'applied'; greekUnits: { theta: 'perDay'; vega: 'per1Percent'; rho: 'per1Percent'; }; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.contractMultiplier: 'applied'; default: not declared — Each position's `multiplier` (default 1) scales its value and Greeks with its `quantity`. - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.greekUnits: { theta: 'perDay'; vega: 'per1Percent'; rho: 'per1Percent'; }; default: not declared — The unit system of the totals: the options package's (theta per day, vega/rho per 1%). - assumptions.greekUnits.rho: 'per1Percent'; default: not declared - assumptions.greekUnits.theta: 'perDay'; default: not declared - assumptions.greekUnits.vega: 'per1Percent'; default: not declared - assumptions.missingGreeks: 'counted-as-zero'; default: not declared - assumptions.model?: string; default: not declared - assumptions.positions: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: PortfolioGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.delta: number; default: not declared — Book totals in the one unit system: theta per calendar day, vega per vol point, rho per 1%. - value.gamma: number; default: not declared - value.rho: number; default: not declared - value.theta: number; default: not declared - value.value: number; default: not declared — Net mark value `Σ qty · multiplier · value`. - value.vega: number; default: not declared ### @insiderfinance/totalfinance/risk#AttributionPeriod Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One period's returns and Brinson effects, to be linked across time. ```typescript /** One period's returns and Brinson effects, to be linked across time. */ export interface AttributionPeriod { portfolioReturn: number; benchmarkReturn: number; allocation: number; selection: number; interaction: number; /** Optional per-segment effects (as from `brinsonAttribution().segments`) to link segment-by-segment. */ segments?: SegmentEffect[]; /** Optional period label, echoed onto its linking coefficient. */ label?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allocation: number; default: not declared - benchmarkReturn: number; default: not declared - interaction: number; default: not declared - label?: string; default: not declared — Optional period label, echoed onto its linking coefficient. - portfolioReturn: number; default: not declared - segments?: SegmentEffect[]; default: not declared — Optional per-segment effects (as from `brinsonAttribution().segments`) to link segment-by-segment. - selection: number; default: not declared ### @insiderfinance/totalfinance/risk#BacktestOverfittingProbabilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link probabilityOfBacktestOverfitting}. ```typescript // ───────────────────────── PBO (combinatorially-symmetric cross-validation) ───────────────────────── /** Options for {@link probabilityOfBacktestOverfitting}. */ export interface BacktestOverfittingProbabilityOptions { /** * Number of disjoint contiguous row-blocks `S` (even, `4 ≤ S ≤ 16`). Default `16` (Bailey & López de * Prado). The `C(S, S/2)` train/test splits grow fast in `S`; the observation count is trimmed to a * multiple of `S` (the oldest rows dropped). */ splits?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - splits?: number; default: not declared — Number of disjoint contiguous row-blocks `S` (even, `4 ≤ S ≤ 16`). Default `16` (Bailey & López de Prado). The `C(S, S/2)` train/test splits grow fast in `S`; the observation count is trimmed to a multiple of `S` (the oldest rows dropped). ### @insiderfinance/totalfinance/risk#BacktestOverfittingProbabilityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The result of a CSCV probability-of-backtest-overfitting analysis. ```typescript /** The result of a CSCV probability-of-backtest-overfitting analysis. */ export interface BacktestOverfittingProbabilityResult { /** * Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on * which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near * `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. */ backtestOverfittingProbability: number; /** Number of symmetric train/test splits evaluated: `C(S, S/2)`. */ combinations: number; /** Blocks `S` actually used. */ splits: number; /** Observations (rows) used after trimming to a multiple of `S`. */ observations: number; /** Number of strategy configurations (columns) `N`. */ trials: number; /** Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. */ medianLogit: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - backtestOverfittingProbability: number; default: not declared — Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. - combinations: number; default: not declared — Number of symmetric train/test splits evaluated: `C(S, S/2)`. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - medianLogit: number; default: not declared — Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. - observations: number; default: not declared — Observations (rows) used after trimming to a multiple of `S`. - splits: number; default: not declared — Blocks `S` actually used. - trials: number; default: not declared — Number of strategy configurations (columns) `N`. ### @insiderfinance/totalfinance/risk#BetaWeightedDeltaResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BetaWeightedDeltaResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Net exposure in index-equivalent shares (`Σ δ·price·β / indexPrice`). */ indexDelta: number; /** Net beta-weighted dollar delta (`Σ δ·price·β`). */ dollarDelta: number; perPosition: { dollarDelta: number; indexDelta: number; }[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - dollarDelta: number; default: not declared — Net beta-weighted dollar delta (`Σ δ·price·β`). - indexDelta: number; default: not declared — Net exposure in index-equivalent shares (`Σ δ·price·β / indexPrice`). - perPosition: { dollarDelta: number; indexDelta: number; }[]; default: not declared ### @insiderfinance/totalfinance/risk#BetaWeightedPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── beta-weighted delta ───────────────────────── export interface BetaWeightedPosition { /** Net delta in shares (already quantity- and multiplier-scaled). */ delta: number; /** The position's underlying (current) price. */ spot: number; /** The underlying's beta to the reference index. */ beta: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beta: number; default: not declared — The underlying's beta to the reference index. - delta: number; default: not declared — Net delta in shares (already quantity- and multiplier-scaled). - spot: number; default: not declared — The position's underlying (current) price. ### @insiderfinance/totalfinance/risk#BinaryEdge Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A binary win/loss bet, amounts expressed per unit staked. ```typescript /** A binary win/loss bet, amounts expressed per unit staked. */ export interface BinaryEdge { /** Probability of the winning outcome, in (0, 1). */ winProbability: number; /** Gain per unit staked on a win (e.g. 2 = win 2× the stake). Must be > 0. */ winAmount: number; /** Loss per unit staked on a loss (e.g. 1 = lose the stake). Default 1. Must be > 0. */ lossAmount?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lossAmount?: number; default: not declared — Loss per unit staked on a loss (e.g. 1 = lose the stake). Default 1. Must be > 0. - winAmount: number; default: not declared — Gain per unit staked on a win (e.g. 2 = win 2× the stake). Must be > 0. - winProbability: number; default: not declared — Probability of the winning outcome, in (0, 1). ### @insiderfinance/totalfinance/risk#BlackLittermanOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BlackLittermanOptions { /** Asset return covariance Σ (n×n). */ covariance: Matrix; /** Prior (equilibrium) expected returns π. Provide this, or `marketWeights` to imply it. */ priorMean?: ArrayLike; /** Market-cap weights to reverse-engineer the prior `π = δ·Σ·w_mkt`. */ marketWeights?: ArrayLike; /** Risk-aversion δ for the implied prior and the posterior mean-variance weights. Default 2.5. */ riskAversion?: number; /** Investor views (at least one). */ views: BlackLittermanView[]; /** Scalar τ scaling the prior uncertainty of the mean (default 0.05). */ tau?: number; /** Constraints applied to the posterior mean-variance weights. */ constraints?: OptimizeConstraints; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - constraints?: OptimizeConstraints; default: not declared — Constraints applied to the posterior mean-variance weights. - constraints.bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - constraints.budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - constraints.groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - constraints.longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - constraints.maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - constraints.tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - constraints.transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - constraints.transactionCosts.perUnitTurnover: number | number[]; default: not declared - constraints.transactionCosts.previousWeights: number[]; default: not declared - constraints.turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - constraints.turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - constraints.turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. - covariance: Matrix; default: not declared — Asset return covariance Σ (n×n). - marketWeights?: ArrayLike; default: not declared — Market-cap weights to reverse-engineer the prior `π = δ·Σ·w_mkt`. - priorMean?: ArrayLike; default: not declared — Prior (equilibrium) expected returns π. Provide this, or `marketWeights` to imply it. - riskAversion?: number; default: not declared — Risk-aversion δ for the implied prior and the posterior mean-variance weights. Default 2.5. - tau?: number; default: not declared — Scalar τ scaling the prior uncertainty of the mean (default 0.05). - views: BlackLittermanView[]; default: not declared — Investor views (at least one). ### @insiderfinance/totalfinance/risk#BlackLittermanResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Black-Litterman result (dx §2.4): the core `Computed` envelope, like the other optimizers. `value` carries the prior/posterior returns and the posterior-optimal weights; `assumptions` echo the (possibly defaulted) `tau` and `riskAversion` plus the number of views blended; `diagnostics` carry the posterior mean-variance solver's `converged`/`iterations` and all warnings. ```typescript /** * The Black-Litterman result (dx §2.4): the core `Computed` envelope, like the other optimizers. * `value` carries the prior/posterior returns and the posterior-optimal weights; `assumptions` echo * the (possibly defaulted) `tau` and `riskAversion` plus the number of views blended; `diagnostics` * carry the posterior mean-variance solver's `converged`/`iterations` and all warnings. */ export type BlackLittermanResult = Computed<{ /** The supplied or market-implied equilibrium prior π. */ priorMean: number[]; /** Posterior (views-blended) expected returns. */ posteriorMean: number[]; /** Posterior return covariance `Σ + M`, where `M` is the posterior covariance of the mean. */ posteriorCovariance: number[][]; /** Mean-variance-optimal weights under the posterior. */ weights: number[]; }, { tau: number; riskAversion: number; views: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ tau: number; riskAversion: number; views: number; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.riskAversion: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.tau: number; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.views: number; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: { posteriorCovariance: number[][]; posteriorMean: number[]; priorMean: number[]; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.posteriorCovariance: number[][]; default: not declared — Posterior return covariance `Σ + M`, where `M` is the posterior covariance of the mean. - value.posteriorMean: number[]; default: not declared — Posterior (views-blended) expected returns. - value.priorMean: number[]; default: not declared — The supplied or market-implied equilibrium prior π. - value.weights: number[]; default: not declared — Mean-variance-optimal weights under the posterior. ### @insiderfinance/totalfinance/risk#BlackLittermanView Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An investor view for {@link blackLitterman}. ```typescript // ───────────────────────── Black-Litterman ───────────────────────── /** An investor view for {@link blackLitterman}. */ export interface BlackLittermanView { /** Asset pick weights (length n): e.g. `[1, -1, 0]` = "asset 0 outperforms asset 1 by `view`". */ pick: number[]; /** The view's expected (per-period) return Q for the pick portfolio. */ view: number; /** View uncertainty (variance Ω_jj). Omit for the He–Litterman default `τ·pᵀΣp`. */ confidence?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared — View uncertainty (variance Ω_jj). Omit for the He–Litterman default `τ·pᵀΣp`. - pick: number[]; default: not declared — Asset pick weights (length n): e.g. `[1, -1, 0]` = "asset 0 outperforms asset 1 by `view`". - view: number; default: not declared — The view's expected (per-period) return Q for the pick portfolio. ### @insiderfinance/totalfinance/risk#BookGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Net book greeks in trader-facing DISPLAY units (delta $, theta/day, vega/1%, rho/1%), dollar-scaled. ```typescript /** Net book greeks in trader-facing DISPLAY units (delta $, theta/day, vega/1%, rho/1%), dollar-scaled. */ export interface BookGreeks { delta: number; gamma: number; vega: number; theta: number; rho: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared - gamma: number; default: not declared - rho: number; default: not declared - theta: number; default: not declared - vega: number; default: not declared ### @insiderfinance/totalfinance/risk#BookOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link analyzeBook}. ```typescript /** Options for {@link analyzeBook}. */ export interface BookOptions { /** Reference index price → beta-weighted delta (the "net delta in SPY terms" read-out). */ indexPrice?: number; /** Optional book P&L under scenarios (reuses `stressTest` / `taylorPnl`). */ scenarios?: readonly Scenario[]; /** Contract multiplier for margin (default 100). */ multiplier?: number; /** Reg-T naked-margin rate knob, forwarded to `optionsMargin` as its `equityRate`. */ regulationTRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - indexPrice?: number; default: not declared — Reference index price → beta-weighted delta (the "net delta in SPY terms" read-out). - multiplier?: number; default: not declared — Contract multiplier for margin (default 100). - regulationTRate?: number; default: not declared — Reg-T naked-margin rate knob, forwarded to `optionsMargin` as its `equityRate`. - scenarios?: readonly Scenario[]; default: not declared — Optional book P&L under scenarios (reuses `stressTest` / `taylorPnl`). ### @insiderfinance/totalfinance/risk#BookPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One position in the book: a strategy Position, its market, and optional grouping/beta metadata. ```typescript /** One position in the book: a strategy Position, its market, and optional grouping/beta metadata. */ export interface BookPosition { position: StrategyPosition; market: PnlMarket; id?: string; /** Grouping key for the per-underlying breakdown (default: `id` ?? `position-${i}`). */ underlying?: string; /** Beta to the reference index (default 1); used only when `options.indexPrice` is given. */ beta?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beta?: number; default: not declared — Beta to the reference index (default 1); used only when `options.indexPrice` is given. - id?: string; default: not declared - market: PnlMarket; default: not declared - market.asOf: string | number; default: not declared - market.dividendYield?: number; default: not declared - market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). - position: StrategyPosition; default: not declared - position.legs: readonly import('@insiderfinance/totalfinance/risk').StrategyLeg[]; default: not declared - position.metrics: () => import('@insiderfinance/totalfinance/risk').StrategyPayoffMetrics; default: not declared - position.metrics().return.bounded: { loss: boolean; profit: boolean; }; default: not declared - position.metrics().return.bounded.loss: boolean; default: not declared - position.metrics().return.bounded.profit: boolean; default: not declared - position.metrics().return.maxLoss: number | null; default: not declared - position.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/risk').StrategyMarkToMarketResult; default: not declared - position.value().return.greeks: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - position.value().return.perLeg: import('@insiderfinance/totalfinance/risk').StrategyLegValuation[]; default: not declared - position.value().return.pnl: number; default: not declared - position.value().return.value: number; default: not declared - position.value(overrides)?: Partial | undefined; default: not declared - position.value(overrides).asOf?: string | number; default: not declared - position.value(overrides).dividendYield?: number; default: not declared - position.value(overrides).expiry?: string; default: not declared - position.value(overrides).riskFreeRate?: number; default: not declared - position.value(overrides).spot?: number; default: not declared - position.value(overrides).volatility?: number; default: not declared - position.value(overrides).volatilityShock?: number; default: not declared - underlying?: string; default: not declared — Grouping key for the per-underlying breakdown (default: `id` ?? `position-${i}`). ### @insiderfinance/totalfinance/risk#BookRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The full book risk read-out. ```typescript /** The full book risk read-out. */ export interface BookRisk { /** Net unrealized P&L of the book ($) — Σ each position's `Position.value()` (P&L since entry), not liquidation NAV. */ value: number; /** Net greeks, display units. */ greeks: BookGreeks; /** Present when `options.indexPrice` is given. */ betaWeightedDelta?: BetaWeightedDeltaResult; margin: { total: number; buyingPowerReduction: number; }; /** Concentration on per-underlying margin — how much buying power sits in one name (bare values; the report wrapper lives on `concentration()` itself). */ concentration: ConcentrationValues; byPosition: PositionRisk[]; byUnderlying: UnderlyingRisk[]; /** Present when `options.scenarios` is given. */ scenarios?: ScenarioResult[]; assumptions: { conventionsVersion: string; indexPrice?: number; multiplier: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; indexPrice?: number; multiplier: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.indexPrice?: number; default: not declared - assumptions.multiplier: number; default: not declared - betaWeightedDelta?: BetaWeightedDeltaResult; default: not declared — Present when `options.indexPrice` is given. - betaWeightedDelta.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - betaWeightedDelta.assumptions.conventionsVersion: string; default: not declared - betaWeightedDelta.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - betaWeightedDelta.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - betaWeightedDelta.dollarDelta: number; default: not declared — Net beta-weighted dollar delta (`Σ δ·price·β`). - betaWeightedDelta.indexDelta: number; default: not declared — Net exposure in index-equivalent shares (`Σ δ·price·β / indexPrice`). - betaWeightedDelta.perPosition: { dollarDelta: number; indexDelta: number; }[]; default: not declared - byPosition: PositionRisk[]; default: not declared - byUnderlying: UnderlyingRisk[]; default: not declared - concentration: ConcentrationValues; default: not declared — Concentration on per-underlying margin — how much buying power sits in one name (bare values; the report wrapper lives on `concentration()` itself). - concentration.effectiveCount: number | null; default: not declared — Effective number of positions `1 / HHI`; `null` when the book has zero gross exposure (there is nothing to concentrate — Law 7: an undefined quantity is null-with-reason, never NaN). - concentration.gini: number; default: not declared — Gini coefficient of the gross-normalized weight distribution (0 = equal, →1 = concentrated). - concentration.hhi: number; default: not declared — Herfindahl-Hirschman index `Σ s_i²` on gross-normalized weights (1 = one name, 1/n = equal). - concentration.topKShare: number; default: not declared — Combined share of the top-`k` names (default `k = min(5, n)`). - concentration.topWeight: number; default: not declared — Largest single name's share of gross exposure. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks: BookGreeks; default: not declared — Net greeks, display units. - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.rho: number; default: not declared - greeks.theta: number; default: not declared - greeks.vega: number; default: not declared - margin: { buyingPowerReduction: number; total: number; }; default: not declared - margin.buyingPowerReduction: number; default: not declared - margin.total: number; default: not declared - scenarios?: ScenarioResult[]; default: not declared — Present when `options.scenarios` is given. - value: number; default: not declared — Net unrealized P&L of the book ($) — Σ each position's `Position.value()` (P&L since entry), not liquidation NAV. ### @insiderfinance/totalfinance/risk#BookVaRComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-underlying risk contribution. ```typescript /** Per-underlying risk contribution. */ export interface BookVaRComponent { underlying: string; /** VaR of this name in isolation. */ standaloneVaR: number; /** * Diversification-aware contribution to the FULL book VaR — its Euler dispersion share less its own * drift, so `Σ componentVaR = z·σ_L − μ` (the parametric VaR before the ≥0 floor). Can be negative for * a hedging name; `standaloneVaR ≥ componentVaR` always. */ componentVaR: number; /** Sensitivities used (audit trail), in the one unit system — `vega` per volatility point. */ delta: number; gamma: number; vega: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - componentVaR: number; default: not declared — Diversification-aware contribution to the FULL book VaR — its Euler dispersion share less its own drift, so `Σ componentVaR = z·σ_L − μ` (the parametric VaR before the ≥0 floor). Can be negative for a hedging name; `standaloneVaR ≥ componentVaR` always. - delta: number; default: not declared — Sensitivities used (audit trail), in the one unit system — `vega` per volatility point. - gamma: number; default: not declared - standaloneVaR: number; default: not declared — VaR of this name in isolation. - underlying: string; default: not declared - vega: number; default: not declared ### @insiderfinance/totalfinance/risk#BookVaRMethodResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A VaR/CVaR read-out for one method (positive loss magnitudes, plus the disclosed P&L moments). ```typescript /** A VaR/CVaR read-out for one method (positive loss magnitudes, plus the disclosed P&L moments). */ export interface BookVaRMethodResult { /** Positive loss magnitude at `confidence`. */ valueAtRisk: number; /** Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. */ conditionalValueAtRisk: number; /** Expected P&L over the horizonPeriods (gamma-convexity mean + theta drift) — disclosed, not hidden. */ pnlMean: number; /** Stdev of the horizonPeriods P&L. */ pnlStandardDeviation: number; /** P&L skewness the gamma induces — populated on the `cornishFisher` result only. */ skewness?: number; /** P&L excess kurtosis the gamma induces — populated on the `cornishFisher` result only. */ excessKurtosis?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - excessKurtosis?: number; default: not declared — P&L excess kurtosis the gamma induces — populated on the `cornishFisher` result only. - pnlMean: number; default: not declared — Expected P&L over the horizonPeriods (gamma-convexity mean + theta drift) — disclosed, not hidden. - pnlStandardDeviation: number; default: not declared — Stdev of the horizonPeriods P&L. - skewness?: number; default: not declared — P&L skewness the gamma induces — populated on the `cornishFisher` result only. - valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#BookVaROptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link bookVaR}. ```typescript /** Options for {@link bookVaR}. */ export interface BookVaROptions { /** Per-underlying risk factors — MUST cover every underlying present in the book. */ factors: Record; /** Confidence level in (0, 1). Default 0.95. */ confidence?: number; /** VaR horizonPeriods in (trading) days. Default 1. */ horizonDays?: number; /** Spot-return correlation matrix, rows/cols in `assumptions.underlyings` (sorted) order. Default I. */ correlation?: readonly (readonly number[])[]; /** Which method(s) to compute. Default `'both'`. */ method?: 'both' | 'parametric' | 'monteCarlo'; /** Monte-Carlo draws. Default 10,000; capped at 1,000,000. */ samples?: number; /** Monte-Carlo PRNG seed (integer). Default 1; echoed for reproducibility. */ seed?: number; /** Trading days per year for vol annualization. Default 252. */ tradingDaysPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared — Confidence level in (0, 1). Default 0.95. - correlation?: readonly (readonly number[])[]; default: not declared — Spot-return correlation matrix, rows/cols in `assumptions.underlyings` (sorted) order. Default I. - factors: Record; default: not declared — Per-underlying risk factors — MUST cover every underlying present in the book. - horizonDays?: number; default: not declared — VaR horizonPeriods in (trading) days. Default 1. - method?: 'both' | 'parametric' | 'monteCarlo'; default: not declared — Which method(s) to compute. Default `'both'`. - samples?: number; default: not declared — Monte-Carlo draws. Default 10,000; capped at 1,000,000. - seed?: number; default: not declared — Monte-Carlo PRNG seed (integer). Default 1; echoed for reproducibility. - tradingDaysPerYear?: number; default: not declared — Trading days per year for vol annualization. Default 252. ### @insiderfinance/totalfinance/risk#BookVaRPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A position in the book: a strategy Position + its market (reuses the {@link PnlMarket} shape). ```typescript /** A position in the book: a strategy Position + its market (reuses the {@link PnlMarket} shape). */ export interface BookVaRPosition { position: StrategyPosition; market: PnlMarket; id?: string; /** Grouping key → shares one spot factor (default: `id` ?? `position-${i}`). */ underlying?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - id?: string; default: not declared - market: PnlMarket; default: not declared - market.asOf: string | number; default: not declared - market.dividendYield?: number; default: not declared - market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). - position: StrategyPosition; default: not declared - position.legs: readonly import('@insiderfinance/totalfinance/risk').StrategyLeg[]; default: not declared - position.metrics: () => import('@insiderfinance/totalfinance/risk').StrategyPayoffMetrics; default: not declared - position.metrics().return.bounded: { loss: boolean; profit: boolean; }; default: not declared - position.metrics().return.bounded.loss: boolean; default: not declared - position.metrics().return.bounded.profit: boolean; default: not declared - position.metrics().return.maxLoss: number | null; default: not declared - position.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/risk').StrategyMarkToMarketResult; default: not declared - position.value().return.greeks: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - position.value().return.perLeg: import('@insiderfinance/totalfinance/risk').StrategyLegValuation[]; default: not declared - position.value().return.pnl: number; default: not declared - position.value().return.value: number; default: not declared - position.value(overrides)?: Partial | undefined; default: not declared - position.value(overrides).asOf?: string | number; default: not declared - position.value(overrides).dividendYield?: number; default: not declared - position.value(overrides).expiry?: string; default: not declared - position.value(overrides).riskFreeRate?: number; default: not declared - position.value(overrides).spot?: number; default: not declared - position.value(overrides).volatility?: number; default: not declared - position.value(overrides).volatilityShock?: number; default: not declared - underlying?: string; default: not declared — Grouping key → shares one spot factor (default: `id` ?? `position-${i}`). ### @insiderfinance/totalfinance/risk#BookVaRResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The full book-VaR read-out. ```typescript /** The full book-VaR read-out. */ export interface BookVaRResult { confidence: number; horizonDays: number; /** Delta-normal (linear) VaR — present unless `method: 'monteCarlo'`. */ parametric?: BookVaRMethodResult; /** * Cornish-Fisher **gamma-adjusted** analytic VaR — the parametric quantile corrected for the P&L * skewness/kurtosis the gamma induces. Present unless `method: 'monteCarlo'` AND the CF expansion is * in its valid (monotone) domain; when a very convex book pushes it out of domain it is omitted and a * `risk.cornish_fisher_out_of_domain` warning points to `monteCarlo`. */ cornishFisher?: BookVaRMethodResult; /** Delta-gamma (gamma-exact), seeded Monte-Carlo VaR — present unless `method: 'parametric'`. */ monteCarlo?: BookVaRMethodResult; /** Per-underlying decomposition (from the linear risk), sorted by `componentVaR` desc. */ components: BookVaRComponent[]; assumptions: { conventionsVersion: string; confidence: number; horizonDays: number; tradingDaysPerYear: number; /** Sorted underlyings — the row/col order of `options.correlation`. */ underlyings: string[]; samples?: number; seed?: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { confidence: number; conventionsVersion: string; horizonDays: number; samples?: number; seed?: number; tradingDaysPerYear: number; underlyings: string[]; }; default: not declared - assumptions.confidence: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.horizonDays: number; default: not declared - assumptions.samples?: number; default: not declared - assumptions.seed?: number; default: not declared - assumptions.tradingDaysPerYear: number; default: not declared - assumptions.underlyings: string[]; default: not declared — Sorted underlyings — the row/col order of `options.correlation`. - components: BookVaRComponent[]; default: not declared — Per-underlying decomposition (from the linear risk), sorted by `componentVaR` desc. - confidence: number; default: not declared - cornishFisher?: BookVaRMethodResult; default: not declared — Cornish-Fisher **gamma-adjusted** analytic VaR — the parametric quantile corrected for the P&L skewness/kurtosis the gamma induces. Present unless `method: 'monteCarlo'` AND the CF expansion is in its valid (monotone) domain; when a very convex book pushes it out of domain it is omitted and a `risk.cornish_fisher_out_of_domain` warning points to `monteCarlo`. - cornishFisher.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - cornishFisher.excessKurtosis?: number; default: not declared — P&L excess kurtosis the gamma induces — populated on the `cornishFisher` result only. - cornishFisher.pnlMean: number; default: not declared — Expected P&L over the horizonPeriods (gamma-convexity mean + theta drift) — disclosed, not hidden. - cornishFisher.pnlStandardDeviation: number; default: not declared — Stdev of the horizonPeriods P&L. - cornishFisher.skewness?: number; default: not declared — P&L skewness the gamma induces — populated on the `cornishFisher` result only. - cornishFisher.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - horizonDays: number; default: not declared - monteCarlo?: BookVaRMethodResult; default: not declared — Delta-gamma (gamma-exact), seeded Monte-Carlo VaR — present unless `method: 'parametric'`. - monteCarlo.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - monteCarlo.excessKurtosis?: number; default: not declared — P&L excess kurtosis the gamma induces — populated on the `cornishFisher` result only. - monteCarlo.pnlMean: number; default: not declared — Expected P&L over the horizonPeriods (gamma-convexity mean + theta drift) — disclosed, not hidden. - monteCarlo.pnlStandardDeviation: number; default: not declared — Stdev of the horizonPeriods P&L. - monteCarlo.skewness?: number; default: not declared — P&L skewness the gamma induces — populated on the `cornishFisher` result only. - monteCarlo.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. - parametric?: BookVaRMethodResult; default: not declared — Delta-normal (linear) VaR — present unless `method: 'monteCarlo'`. - parametric.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - parametric.excessKurtosis?: number; default: not declared — P&L excess kurtosis the gamma induces — populated on the `cornishFisher` result only. - parametric.pnlMean: number; default: not declared — Expected P&L over the horizonPeriods (gamma-convexity mean + theta drift) — disclosed, not hidden. - parametric.pnlStandardDeviation: number; default: not declared — Stdev of the horizonPeriods P&L. - parametric.skewness?: number; default: not declared — P&L skewness the gamma induces — populated on the `cornishFisher` result only. - parametric.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#BrinsonAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Brinson attribution. ```typescript /** The Brinson attribution. */ export interface BrinsonAttribution { portfolioReturn: number; benchmarkReturn: number; /** `portfolioReturn − benchmarkReturn`. */ activeReturn: number; /** Segment-summed effects (`allocation + selection + interaction = activeReturn`, exact). */ allocation: number; selection: number; interaction: number; segments: SegmentEffect[]; method: BrinsonMethod; assumptions: { conventionsVersion: string; method: BrinsonMethod; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - activeReturn: number; default: not declared — `portfolioReturn − benchmarkReturn`. - allocation: number; default: not declared — Segment-summed effects (`allocation + selection + interaction = activeReturn`, exact). - assumptions: { conventionsVersion: string; method: BrinsonMethod; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: BrinsonMethod; default: not declared - benchmarkReturn: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - interaction: number; default: not declared - method: BrinsonMethod; default: not declared - portfolioReturn: number; default: not declared - segments: SegmentEffect[]; default: not declared - selection: number; default: not declared ### @insiderfinance/totalfinance/risk#BrinsonAttributionOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link brinsonAttribution}. ```typescript /** Options for {@link brinsonAttribution}. */ export interface BrinsonAttributionOptions { /** Allocation convention; default `'brinson-fachler'` (benchmark-relative). */ method?: BrinsonMethod; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method?: BrinsonMethod; default: not declared — Allocation convention; default `'brinson-fachler'` (benchmark-relative). ### @insiderfinance/totalfinance/risk#BrinsonSegment Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One segment (sector/bucket) of a Brinson attribution. ```typescript // ─────────────────────────────── Brinson attribution ─────────────────────────────── /** One segment (sector/bucket) of a Brinson attribution. */ export interface BrinsonSegment { name: string; portfolioWeight: number; benchmarkWeight: number; portfolioReturn: number; benchmarkReturn: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - benchmarkReturn: number; default: not declared - benchmarkWeight: number; default: not declared - name: string; default: not declared - portfolioReturn: number; default: not declared - portfolioWeight: number; default: not declared ### @insiderfinance/totalfinance/risk#CVaROptimizeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── CVaR optimization (Rockafellar–Uryasev) ───────────────────────── export interface CVaROptimizeOptions extends OptimizeConstraints { /** Tail confidence α: optimize the mean of the worst `(1 − α)` fraction of losses. Default 0.95. */ alpha?: number; /** Optional minimum mean return `μᵀw ≥ minReturn` (μ = per-asset scenario means). */ minReturn?: number; /** Projected-subgradient iteration cap. Default 4000. */ maximumIterations?: number; /** * Initial subgradient step size (decays as `step/√t`). Defaults to `1/‖g₀‖` — the step that moves * the FIRST iterate a distance of about 1 in weight space, which is the scale weights live on. * A fixed default (this used to be `1`) is unit-dependent: on decimal daily returns ‖g‖ ≈ 0.01, * so every step moved ~1e-2·(1/√t) and the run plateaued a long way from the optimum while * reporting `converged: true`. Pass an explicit `step` only to override that scaling. */ step?: number; /** * Relative-improvement tolerance for convergence: the run is `converged` only once the best CVaR * improves by less than this over the final 25 iterations. Default `1e-6`. */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha?: number; default: not declared — Tail confidence α: optimize the mean of the worst `(1 − α)` fraction of losses. Default 0.95. - bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - maximumIterations?: number; default: not declared — Projected-subgradient iteration cap. Default 4000. - minReturn?: number; default: not declared — Optional minimum mean return `μᵀw ≥ minReturn` (μ = per-asset scenario means). - step?: number; default: not declared — Initial subgradient step size (decays as `step/√t`). Defaults to `1/‖g₀‖` — the step that moves the FIRST iterate a distance of about 1 in weight space, which is the scale weights live on. A fixed default (this used to be `1`) is unit-dependent: on decimal daily returns ‖g‖ ≈ 0.01, so every step moved ~1e-2·(1/√t) and the run plateaued a long way from the optimum while reporting `converged: true`. Pass an explicit `step` only to override that scaling. - tolerance?: number; default: not declared — Relative-improvement tolerance for convergence: the run is `converged` only once the best CVaR improves by less than this over the final 25 iterations. Default `1e-6`. - transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - transactionCosts.perUnitTurnover: number | number[]; default: not declared - transactionCosts.previousWeights: number[]; default: not declared - turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk#CVaROptimizeResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CVaR-optimizer result: the standard envelope whose `value` also carries the optimized tail. ```typescript /** CVaR-optimizer result: the standard envelope whose `value` also carries the optimized tail. */ export type CVaROptimizeResult = Computed<{ weights: number[]; objective: number; /** The optimized CVaR — mean loss over the worst `(1 − α)` tail (a positive magnitude). */ conditionalValueAtRisk: number; /** The VaR threshold (loss quantile at α) at the solution. */ valueAtRisk: number; }, { objective: string; budget: number; confidence: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; confidence: number; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.budget: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.confidence: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.objective: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: { conditionalValueAtRisk: number; objective: number; valueAtRisk: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.conditionalValueAtRisk: number; default: not declared — The optimized CVaR — mean loss over the worst `(1 − α)` tail (a positive magnitude). - value.objective: number; default: not declared - value.valueAtRisk: number; default: not declared — The VaR threshold (loss quantile at α) at the solution. - value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#CapitalAssetPricingExpectedReturnsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CapitalAssetPricingExpectedReturnsInput { method: 'capital-asset-pricing'; /** Per-asset market betas (one per asset). */ betas: number[]; /** Annual risk-free rate (decimal). */ annualRiskFreeRate: number; /** Annual market risk premium (decimal) — the premium itself, not the market return. */ annualMarketRiskPremium: number; /** Optional asset labels aligned to `betas`; echoed on the result. */ assetIds?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - assetIds?: string[]; default: not declared — Optional asset labels aligned to `betas`; echoed on the result. - betas: number[]; default: not declared — Per-asset market betas (one per asset). - method: 'capital-asset-pricing'; default: not declared ### @insiderfinance/totalfinance/risk#ConcentrationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link concentration}'s report: the values plus the applied conventions (Law 2 report grammar). ```typescript /** {@link concentration}'s report: the values plus the applied conventions (Law 2 report grammar). */ export interface ConcentrationResult extends ConcentrationValues { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - effectiveCount: number | null; default: not declared — Effective number of positions `1 / HHI`; `null` when the book has zero gross exposure (there is nothing to concentrate — Law 7: an undefined quantity is null-with-reason, never NaN). - gini: number; default: not declared — Gini coefficient of the gross-normalized weight distribution (0 = equal, →1 = concentrated). - hhi: number; default: not declared — Herfindahl-Hirschman index `Σ s_i²` on gross-normalized weights (1 = one name, 1/n = equal). - topKShare: number; default: not declared — Combined share of the top-`k` names (default `k = min(5, n)`). - topWeight: number; default: not declared — Largest single name's share of gross exposure. ### @insiderfinance/totalfinance/risk#ConcentrationValues Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The bare concentration read-out (the values `analyzeBook` embeds without a nested report). ```typescript // ───────────────────────── concentration risk ───────────────────────── /** The bare concentration read-out (the values `analyzeBook` embeds without a nested report). */ export interface ConcentrationValues { /** Herfindahl-Hirschman index `Σ s_i²` on gross-normalized weights (1 = one name, 1/n = equal). */ hhi: number; /** * Effective number of positions `1 / HHI`; `null` when the book has zero gross exposure (there is * nothing to concentrate — Law 7: an undefined quantity is null-with-reason, never NaN). */ effectiveCount: number | null; /** Largest single name's share of gross exposure. */ topWeight: number; /** Combined share of the top-`k` names (default `k = min(5, n)`). */ topKShare: number; /** Gini coefficient of the gross-normalized weight distribution (0 = equal, →1 = concentrated). */ gini: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - effectiveCount: number | null; default: not declared — Effective number of positions `1 / HHI`; `null` when the book has zero gross exposure (there is nothing to concentrate — Law 7: an undefined quantity is null-with-reason, never NaN). - gini: number; default: not declared — Gini coefficient of the gross-normalized weight distribution (0 = equal, →1 = concentrated). - hhi: number; default: not declared — Herfindahl-Hirschman index `Σ s_i²` on gross-normalized weights (1 = one name, 1/n = equal). - topKShare: number; default: not declared — Combined share of the top-`k` names (default `k = min(5, n)`). - topWeight: number; default: not declared — Largest single name's share of gross exposure. ### @insiderfinance/totalfinance/risk#CostAwareKelly Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The cost-aware sizing verdict. ```typescript /** The cost-aware sizing verdict. */ export interface CostAwareKelly { /** Per-period cost drag `c = holdingCost + roundTripCost/horizonPeriods`. */ costPerPeriod: number; /** `μ/σ²` — the growth-optimal fraction ignoring costs; `null` when the edge has zero variance (C hygiene). */ grossKelly: number | null; /** `max(0, (μ−c)/σ²)` — the cost-aware growth-optimal fraction; `null` with `grossKelly`. */ netKelly: number | null; /** `fraction · netKelly` — the recommended size after fractional-Kelly; `null` with `grossKelly`. */ recommendedFraction: number | null; /** `μ` — the cost at which the edge vanishes. */ breakevenCost: number; /** Whether the net edge is positive (`c < μ`). */ isProfitable: boolean; /** `μ²/(2σ²)` — expected log-growth at gross Kelly with no costs; `null` with `grossKelly`. */ grossGrowth: number | null; /** `(μ−c)²/(2σ²)` — expected log-growth at net Kelly (the achievable optimum with costs); `null` with `grossKelly`. */ netGrowth: number | null; /** `grossGrowth − netGrowth` — the log-growth the costs cost you; `null` with `grossKelly`. */ growthDrag: number | null; /** Log-growth of naively betting gross Kelly while paying costs (`≤ netGrowth`); `null` with `grossKelly`. */ ignoringCostsGrowth: number | null; /** The edge mean `μ` used. */ mean: number; /** The edge variance `σ²` used. */ variance: number; /** Prose an agent relays. */ rationale: string; assumptions: { conventionsVersion: string; fraction: number; edgeType: 'gaussian' | 'returns'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; edgeType: 'gaussian' | 'returns'; fraction: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.edgeType: 'returns' | 'gaussian'; default: not declared - assumptions.fraction: number; default: not declared - breakevenCost: number; default: not declared — `μ` — the cost at which the edge vanishes. - costPerPeriod: number; default: not declared — Per-period cost drag `c = holdingCost + roundTripCost/horizonPeriods`. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - grossGrowth: number | null; default: not declared — `μ²/(2σ²)` — expected log-growth at gross Kelly with no costs; `null` with `grossKelly`. - grossKelly: number | null; default: not declared — `μ/σ²` — the growth-optimal fraction ignoring costs; `null` when the edge has zero variance (C hygiene). - growthDrag: number | null; default: not declared — `grossGrowth − netGrowth` — the log-growth the costs cost you; `null` with `grossKelly`. - ignoringCostsGrowth: number | null; default: not declared — Log-growth of naively betting gross Kelly while paying costs (`≤ netGrowth`); `null` with `grossKelly`. - isProfitable: boolean; default: not declared — Whether the net edge is positive (`c < μ`). - mean: number; default: not declared — The edge mean `μ` used. - netGrowth: number | null; default: not declared — `(μ−c)²/(2σ²)` — expected log-growth at net Kelly (the achievable optimum with costs); `null` with `grossKelly`. - netKelly: number | null; default: not declared — `max(0, (μ−c)/σ²)` — the cost-aware growth-optimal fraction; `null` with `grossKelly`. - rationale: string; default: not declared — Prose an agent relays. - recommendedFraction: number | null; default: not declared — `fraction · netKelly` — the recommended size after fractional-Kelly; `null` with `grossKelly`. - variance: number; default: not declared — The edge variance `σ²` used. ### @insiderfinance/totalfinance/risk#CostAwareKellyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link costAwareKelly}. ```typescript // ─────────────────────────────────────────────────────────────────────────────────────────────── // Cost-aware Kelly (continuous edge) // ─────────────────────────────────────────────────────────────────────────────────────────────── /** Input for {@link costAwareKelly}. */ export interface CostAwareKellyInput { /** The per-period edge: a Gaussian mean/variance, or a return sample (μ, σ² computed from it). */ edge: { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; /** Per-period holding cost per unit of position (financing / borrow / carry). Default 0. */ holdingCost?: number; /** One-time round-trip cost per unit of position (entry + exit). Default 0. Requires `horizonPeriods`. */ roundTripCost?: number; /** Expected holding periods, to amortize `roundTripCost`. Required when `roundTripCost > 0`. */ horizonPeriods?: number; /** Fractional-Kelly multiplier applied to `netKelly`. Default 0.5. Must be > 0. */ fraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - edge: { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; default: not declared — The per-period edge: a Gaussian mean/variance, or a return sample (μ, σ² computed from it). - edge.gaussian: { mean: number; variance: number; }; default: not declared - edge.gaussian.mean: number; default: not declared - edge.gaussian.variance: number; default: not declared - edge.returns: ArrayLike; default: not declared - fraction?: number; default: not declared — Fractional-Kelly multiplier applied to `netKelly`. Default 0.5. Must be > 0. - holdingCost?: number; default: not declared — Per-period holding cost per unit of position (financing / borrow / carry). Default 0. - horizonPeriods?: number; default: not declared — Expected holding periods, to amortize `roundTripCost`. Required when `roundTripCost > 0`. - roundTripCost?: number; default: not declared — One-time round-trip cost per unit of position (entry + exit). Default 0. Requires `horizonPeriods`. ### @insiderfinance/totalfinance/risk#CovarianceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CovarianceInput { /** * Observations-major returns: `returns[t][k]` is asset `k`'s simple return in period `t` — * one row per period, one column per asset (the natural CSV/dataframe orientation, and the * TRANSPOSE of `@insiderfinance/totalfinance/math`'s variables-major `estimateCovariance` input). Every row must * have the same number of assets. */ returns: number[][]; /** Optional asset labels aligned to the columns; echoed on the result for self-description. */ assets?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assets?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result for self-description. - returns: number[][]; default: not declared — Observations-major returns: `returns[t][k]` is asset `k`'s simple return in period `t` — one row per period, one column per asset (the natural CSV/dataframe orientation, and the TRANSPOSE of `@insiderfinance/totalfinance/math`'s variables-major `estimateCovariance` input). Every row must have the same number of assets. ### @insiderfinance/totalfinance/risk#CovarianceOptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Estimator options — delegated verbatim to `@insiderfinance/totalfinance/math`'s `estimateCovariance`. ```typescript /** Estimator options — delegated verbatim to `@insiderfinance/totalfinance/math`'s `estimateCovariance`. */ export type CovarianceOptions = EstimateCovarianceOptions; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conditionThreshold?: number; default: not declared — Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. - halfLife?: number; default: not declared — EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. - lambda?: number; default: not declared — EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). - ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` (the market-model target, best-specified for stock returns). - market?: ArrayLike; default: not declared — Observed market return series for the `'single-index'` target (length `T`). Omitted → the equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. - method?: import('@insiderfinance/totalfinance/math').CovarianceMethod; default: not declared — Estimator; default `'auto'`. - population?: boolean; default: not declared — Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). - ridge?: number; default: not declared — Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. ### @insiderfinance/totalfinance/risk#CovarianceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CovarianceResult { value: CovarianceValue; assumptions: { conventionsVersion: string; /** The estimator actually used (`'auto'` resolves before reporting). */ method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; observations: number; /** Returns are treated as one row per PERIOD; means are per-period, not annualized. */ orientation: 'observations-major'; }; diagnostics: Diagnostics & { /** `null` when the matrix is singular (κ = ∞ has no JSON representation; see warnings). */ conditionNumber: number | null; isPositiveDefinite: boolean; effectiveRank: number; minEigenvalue: number; maxEigenvalue: number; shrinkage?: number; lambda?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; observations: number; orientation: 'observations-major'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; default: not declared — The estimator actually used (`'auto'` resolves before reporting). - assumptions.observations: number; default: not declared - assumptions.orientation: 'observations-major'; default: not declared — Returns are treated as one row per PERIOD; means are per-period, not annualized. - diagnostics: Diagnostics & { conditionNumber: number | null; effectiveRank: number; isPositiveDefinite: boolean; lambda?: number; maxEigenvalue: number; minEigenvalue: number; shrinkage?: number; }; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.conditionNumber: number | null; default: not declared — `null` when the matrix is singular (κ = ∞ has no JSON representation; see warnings). - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.effectiveRank: number; default: not declared - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.isPositiveDefinite: boolean; default: not declared - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.lambda?: number; default: not declared - diagnostics.maxEigenvalue: number; default: not declared - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.minEigenvalue: number; default: not declared - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.shrinkage?: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - value: CovarianceValue; default: not declared - value.assets?: string[]; default: not declared — Asset labels, when provided. - value.covariance: Matrix; default: not declared — The estimated covariance Σ (assets × assets) — feed it to any optimizer. - value.meanReturns: number[]; default: not declared — Per-asset arithmetic mean PERIOD returns, aligned to the columns — feed to `maxSharpe`. ### @insiderfinance/totalfinance/risk#CovarianceValue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CovarianceValue { /** The estimated covariance Σ (assets × assets) — feed it to any optimizer. */ covariance: Matrix; /** Per-asset arithmetic mean PERIOD returns, aligned to the columns — feed to `maxSharpe`. */ meanReturns: number[]; /** Asset labels, when provided. */ assets?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assets?: string[]; default: not declared — Asset labels, when provided. - covariance: Matrix; default: not declared — The estimated covariance Σ (assets × assets) — feed it to any optimizer. - meanReturns: number[]; default: not declared — Per-asset arithmetic mean PERIOD returns, aligned to the columns — feed to `maxSharpe`. ### @insiderfinance/totalfinance/risk#DeflatedSharpeResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DeflatedSharpeResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Probability the true Sharpe beats the multiple-testing-adjusted benchmark `SR₀`. */ /** `null` when the statistics carry no Sharpe (a zero-variance series). */ deflatedSharpe: number | null; /** The un-deflated PSR (benchmark 0), for comparison. */ probabilisticSharpe: number | null; /** Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. */ expectedMaxSharpe: number; trialCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - deflatedSharpe: number | null; default: not declared — `null` when the statistics carry no Sharpe (a zero-variance series). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. - probabilisticSharpe: number | null; default: not declared — The un-deflated PSR (benchmark 0), for comparison. - trialCount: number; default: not declared ### @insiderfinance/totalfinance/risk#DrawdownAtRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Drawdown-at-Risk read-out. ```typescript // ─────────────────────────────── Drawdown-at-Risk ─────────────────────────────── /** Drawdown-at-Risk read-out. */ export interface DrawdownAtRisk { confidence: number; /** `DaR_α` — the `α`-quantile of the fractional drawdown series (≥ 0). */ drawdownAtRisk: number; /** `CDaR_α` — the mean drawdown beyond `DaR_α` (Chekhlov–Uryasev; ≥ `DaR_α`). */ conditionalDrawdownAtRisk: number; /** The worst drawdown on the path (context). */ maxDrawdown: number; observations: number; assumptions: { conventionsVersion: string; confidence: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { confidence: number; conventionsVersion: string; }; default: not declared - assumptions.confidence: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - conditionalDrawdownAtRisk: number; default: not declared — `CDaR_α` — the mean drawdown beyond `DaR_α` (Chekhlov–Uryasev; ≥ `DaR_α`). - confidence: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - drawdownAtRisk: number; default: not declared — `DaR_α` — the `α`-quantile of the fractional drawdown series (≥ 0). - maxDrawdown: number; default: not declared — The worst drawdown on the path (context). - observations: number; default: not declared ### @insiderfinance/totalfinance/risk#EdgeOutcome Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One outcome of a discrete payoff distribution, P&L per unit staked. ```typescript /** One outcome of a discrete payoff distribution, P&L per unit staked. */ export interface EdgeOutcome { /** Probability of this outcome, in [0, 1]; the set must sum to 1. */ probability: number; /** P&L per unit staked (positive = gain, negative = loss). */ payoff: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - payoff: number; default: not declared — P&L per unit staked (positive = gain, negative = loss). - probability: number; default: not declared — Probability of this outcome, in [0, 1]; the set must sum to 1. ### @insiderfinance/totalfinance/risk#EfficientFrontierGrid Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How the frontier is sampled — an explicit choice, never defaulted. ```typescript /** How the frontier is sampled — an explicit choice, never defaulted. */ export type EfficientFrontierGrid = /** One point per risk aversion λ in `max μᵀw − (λ/2)·wᵀΣw` (each > 0). */ { kind: 'risk-aversion'; values: number[]; } /** One point per target expected return, in the units of `mean`. */ | { kind: 'target-return'; values: number[]; } /** * `count` (≥ 2, ≤ 10,000) targets evenly spaced from the minimum-variance return to the maximum * achievable return under the constraints. When that maximum is unbounded or cannot be proved * from the supported constraint grammar, the points fall back to a logarithmic λ grid and the * result says which case occurred. */ | { kind: 'points'; count: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - kind: ('points') | ('risk-aversion') | ('target-return'); default: not declared - values: number[]; default: not declared ### @insiderfinance/totalfinance/risk#EfficientFrontierGridKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type EfficientFrontierGridKind = EfficientFrontierGrid['kind']; ``` ### @insiderfinance/totalfinance/risk#EfficientFrontierInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EfficientFrontierInput { /** Per-asset expected returns as a dense stored-data ArrayLike (same period as covariance). */ mean: ArrayLike; /** Asset return covariance Σ (n×n). */ covariance: Matrix; grid: EfficientFrontierGrid; /** The optimizer's feasible-region grammar (`longOnly`, `bounds`, `budget`, `groups`, …). */ constraints?: EfficientFrontierConstraints; /** * Risk-free rate in the SAME per-period units as `mean` (a daily problem takes 0.04/252, not * 0.04) — the `maxSharpe` spelling. When present every point reports a Sharpe ratio and the * tangency portfolio is solved and reported under `value.tangency`. */ riskFreeRatePerPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - constraints?: EfficientFrontierConstraints; default: not declared — The optimizer's feasible-region grammar (`longOnly`, `bounds`, `budget`, `groups`, …). - constraints.bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - constraints.budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - constraints.groups?: import('@insiderfinance/totalfinance/risk').GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - constraints.longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - constraints.maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - constraints.tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - constraints.turnover?: import('@insiderfinance/totalfinance/risk').TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - constraints.turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - constraints.turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. - covariance: Matrix; default: not declared — Asset return covariance Σ (n×n). - grid: EfficientFrontierGrid; default: not declared - grid.count: number; default: not declared - grid.kind: ('points') | ('risk-aversion') | ('target-return'); default: not declared - grid.values: number[]; default: not declared - mean: ArrayLike; default: not declared — Per-asset expected returns as a dense stored-data ArrayLike (same period as covariance). - riskFreeRatePerPeriod?: number; default: not declared — Risk-free rate in the SAME per-period units as `mean` (a daily problem takes 0.04/252, not 0.04) — the `maxSharpe` spelling. When present every point reports a Sharpe ratio and the tangency portfolio is solved and reported under `value.tangency`. ### @insiderfinance/totalfinance/risk#EfficientFrontierResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EfficientFrontierResult { value: EfficientFrontierValue; assumptions: { conventionsVersion: string; objective: 'mean-variance'; budget: number; grid: { kind: EfficientFrontierGridKind; count: number; }; riskFreeRatePerPeriod?: number; /** Prose summary of the constraint set every point was solved under. */ constraintSummary: string; }; diagnostics: Diagnostics & { /** Every solved point converged (false when any point failed or stopped early). */ converged: boolean; /** Total solver iterations across the sweep. */ iterations: number; solvedCount: number; failedCount: number; /** Volatility is non-decreasing with expected return across the solved points. */ monotone: boolean; /** `true` when finite, `false` when unbounded, `null` when the proof is undetermined. */ maximumReturnBounded: boolean | null; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { budget: number; constraintSummary: string; conventionsVersion: string; grid: { kind: EfficientFrontierGridKind; count: number; }; objective: 'mean-variance'; riskFreeRatePerPeriod?: number; }; default: not declared - assumptions.budget: number; default: not declared - assumptions.constraintSummary: string; default: not declared — Prose summary of the constraint set every point was solved under. - assumptions.conventionsVersion: string; default: not declared - assumptions.grid: { count: number; kind: EfficientFrontierGridKind; }; default: not declared - assumptions.grid.count: number; default: not declared - assumptions.grid.kind: 'risk-aversion' | 'target-return' | 'points'; default: not declared - assumptions.objective: 'mean-variance'; default: not declared - assumptions.riskFreeRatePerPeriod?: number; default: not declared - diagnostics: Diagnostics & { converged: boolean; failedCount: number; iterations: number; maximumReturnBounded: boolean | null; monotone: boolean; solvedCount: number; }; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. Every solved point converged (false when any point failed or stopped early). - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.failedCount: number; default: not declared - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. Total solver iterations across the sweep. - diagnostics.maximumReturnBounded: boolean | null; default: not declared — `true` when finite, `false` when unbounded, `null` when the proof is undetermined. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.monotone: boolean; default: not declared — Volatility is non-decreasing with expected return across the solved points. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.solvedCount: number; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - value: EfficientFrontierValue; default: not declared - value.expectedReturnRange: { minimum: number | null; maximum: number | null; }; default: not declared — The expected-return range the frontier spans under the constraints: the minimum-variance return and the maximum achievable return (`null` when unbounded or not determinable). - value.expectedReturnRange.maximum: number | null; default: not declared - value.expectedReturnRange.minimum: number | null; default: not declared - value.failedCount: number; default: not declared - value.minimumVariance: FrontierPortfolio; default: not declared — The left endpoint: the minimum-variance portfolio under the constraints. - value.minimumVariance.converged: boolean; default: not declared — The underlying solver converged AND (for targets) the requested return was met. - value.minimumVariance.expectedReturn: number | null; default: not declared - value.minimumVariance.feasible: boolean; default: not declared — Whether the point satisfies the constraint set (budget, box, groups, turnover). - value.minimumVariance.iterations: number; default: not declared — Solver iterations spent on this point (all bisection solves included). - value.minimumVariance.reason?: string; default: not declared — Why the point failed or did not converge. - value.minimumVariance.sharpeRatio: number | null; default: not declared — `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. - value.minimumVariance.variance: number | null; default: not declared - value.minimumVariance.volatility: number | null; default: not declared - value.minimumVariance.warnings: QuantWarning[]; default: not declared - value.minimumVariance.weights: number[] | null; default: not declared — `null` when the point failed (unreachable target or a non-finite solve). - value.points: FrontierPoint[]; default: not declared — Every point, in grid order — failed points included. - value.solvedCount: number; default: not declared - value.tangency?: FrontierPortfolio; default: not declared — The maximum-Sharpe (tangency) portfolio — present when `riskFreeRatePerPeriod` was given. - value.tangency.converged: boolean; default: not declared — The underlying solver converged AND (for targets) the requested return was met. - value.tangency.expectedReturn: number | null; default: not declared - value.tangency.feasible: boolean; default: not declared — Whether the point satisfies the constraint set (budget, box, groups, turnover). - value.tangency.iterations: number; default: not declared — Solver iterations spent on this point (all bisection solves included). - value.tangency.reason?: string; default: not declared — Why the point failed or did not converge. - value.tangency.sharpeRatio: number | null; default: not declared — `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. - value.tangency.variance: number | null; default: not declared - value.tangency.volatility: number | null; default: not declared - value.tangency.warnings: QuantWarning[]; default: not declared - value.tangency.weights: number[] | null; default: not declared — `null` when the point failed (unreachable target or a non-finite solve). ### @insiderfinance/totalfinance/risk#EfficientFrontierValue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EfficientFrontierValue { /** Every point, in grid order — failed points included. */ points: FrontierPoint[]; /** The left endpoint: the minimum-variance portfolio under the constraints. */ minimumVariance: FrontierPortfolio; /** The maximum-Sharpe (tangency) portfolio — present when `riskFreeRatePerPeriod` was given. */ tangency?: FrontierPortfolio; /** * The expected-return range the frontier spans under the constraints: the minimum-variance * return and the maximum achievable return (`null` when unbounded or not determinable). */ expectedReturnRange: { minimum: number | null; maximum: number | null; }; solvedCount: number; failedCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedReturnRange: { maximum: number | null; minimum: number | null; }; default: not declared — The expected-return range the frontier spans under the constraints: the minimum-variance return and the maximum achievable return (`null` when unbounded or not determinable). - expectedReturnRange.maximum: number | null; default: not declared - expectedReturnRange.minimum: number | null; default: not declared - failedCount: number; default: not declared - minimumVariance: FrontierPortfolio; default: not declared — The left endpoint: the minimum-variance portfolio under the constraints. - minimumVariance.converged: boolean; default: not declared — The underlying solver converged AND (for targets) the requested return was met. - minimumVariance.expectedReturn: number | null; default: not declared - minimumVariance.feasible: boolean; default: not declared — Whether the point satisfies the constraint set (budget, box, groups, turnover). - minimumVariance.iterations: number; default: not declared — Solver iterations spent on this point (all bisection solves included). - minimumVariance.reason?: string; default: not declared — Why the point failed or did not converge. - minimumVariance.sharpeRatio: number | null; default: not declared — `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. - minimumVariance.variance: number | null; default: not declared - minimumVariance.volatility: number | null; default: not declared - minimumVariance.warnings: QuantWarning[]; default: not declared - minimumVariance.weights: number[] | null; default: not declared — `null` when the point failed (unreachable target or a non-finite solve). - points: FrontierPoint[]; default: not declared — Every point, in grid order — failed points included. - solvedCount: number; default: not declared - tangency?: FrontierPortfolio; default: not declared — The maximum-Sharpe (tangency) portfolio — present when `riskFreeRatePerPeriod` was given. - tangency.converged: boolean; default: not declared — The underlying solver converged AND (for targets) the requested return was met. - tangency.expectedReturn: number | null; default: not declared - tangency.feasible: boolean; default: not declared — Whether the point satisfies the constraint set (budget, box, groups, turnover). - tangency.iterations: number; default: not declared — Solver iterations spent on this point (all bisection solves included). - tangency.reason?: string; default: not declared — Why the point failed or did not converge. - tangency.sharpeRatio: number | null; default: not declared — `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. - tangency.variance: number | null; default: not declared - tangency.volatility: number | null; default: not declared - tangency.warnings: QuantWarning[]; default: not declared - tangency.weights: number[] | null; default: not declared — `null` when the point failed (unreachable target or a non-finite solve). ### @insiderfinance/totalfinance/risk#EstimateExpectedReturnsInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The closed request: an explicit `method` discriminant selects the branch and its own keys. ```typescript /** The closed request: an explicit `method` discriminant selects the branch and its own keys. */ export type EstimateExpectedReturnsInput = HistoricalMeanExpectedReturnsInput | ExponentiallyWeightedExpectedReturnsInput | CapitalAssetPricingExpectedReturnsInput | SuppliedExpectedReturnsInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - annualized: boolean; default: not declared — Whether the supplied values are annual (`true`) or per-period (`false`). Required. - asOf?: string | number; default: not declared — Point-in-time cut: every row whose timestamp is AFTER this instant is excluded from the estimate and the excluded count is disclosed in `diagnostics.excludedAfterAsOf`. Without `observationTimestamps` nothing can be screened — the result then carries a warning. - assetIds?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result. Optional asset labels aligned to `betas`; echoed on the result. Optional asset labels aligned to `expectedReturns`; echoed on the result. - betas: number[]; default: not declared — Per-asset market betas (one per asset). - expectedReturns: number[]; default: not declared — Caller-supplied expected returns, one per asset. - halfLifePeriods: number; default: not declared — Half-life of the observation weights in PERIODS: observation `t` of `T` carries weight `0.5^((T − 1 − t) / halfLifePeriods)` before normalization, so the most recent row is the heaviest. Required — there is no universal decay rate. - method: ('capital-asset-pricing') | ('exponentially-weighted') | ('historical-mean') | ('supplied'); default: not declared - observationTimestamps?: (string | number)[]; default: not declared — Optional observation instants aligned 1:1 with the rows of `returns` (epoch milliseconds or an ISO date / zoned datetime), non-decreasing. Required for `asOf` to screen anything. - periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily, `12` for monthly data): the reported means become `periodMean × periodsPerYear`. OMITTED means per-period means with `annualized: false` — annualization is never silent. - returns: number[][]; default: not declared — Observations-major returns — the same orientation as `CovarianceInput`: `returns[t][k]` is asset `k`'s simple return in period `t` (one row per period, one column per asset). ### @insiderfinance/totalfinance/risk#ExpectedReturnsMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExpectedReturnsMethod = EstimateExpectedReturnsInput['method']; ``` ### @insiderfinance/totalfinance/risk#ExpectedReturnsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExpectedReturnsResult { value: ExpectedReturnsValue; assumptions: { conventionsVersion: string; method: ExpectedReturnsMethod; /** Echoed when annualization was requested (sample methods only). */ periodsPerYear?: number; /** Echoed for `'exponentially-weighted'`. */ halfLifePeriods?: number; /** Echoed for `'capital-asset-pricing'`. */ annualRiskFreeRate?: number; /** Echoed for `'capital-asset-pricing'`. */ annualMarketRiskPremium?: number; /** The resolved point-in-time cut (epoch milliseconds), when `asOf` was given. */ asOf?: EpochMs; /** Prose statement of exactly how the numbers were produced. */ estimationConvention: string; }; diagnostics: Diagnostics & { /** Return observations consumed (after point-in-time screening); 0 for methods without a sample. */ sampleSize: number; /** `(Σw)² / Σw²` of the observation weights (`'exponentially-weighted'` only). */ effectiveSampleSize?: number; /** Rows excluded because their timestamp is after `asOf` (when both were supplied). */ excludedAfterAsOf?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { annualMarketRiskPremium?: number; annualRiskFreeRate?: number; asOf?: EpochMs; conventionsVersion: string; estimationConvention: string; halfLifePeriods?: number; method: ExpectedReturnsMethod; periodsPerYear?: number; }; default: not declared - assumptions.annualMarketRiskPremium?: number; default: not declared — Echoed for `'capital-asset-pricing'`. - assumptions.annualRiskFreeRate?: number; default: not declared — Echoed for `'capital-asset-pricing'`. - assumptions.asOf?: number; default: not declared — The resolved point-in-time cut (epoch milliseconds), when `asOf` was given. - assumptions.conventionsVersion: string; default: not declared - assumptions.estimationConvention: string; default: not declared — Prose statement of exactly how the numbers were produced. - assumptions.halfLifePeriods?: number; default: not declared — Echoed for `'exponentially-weighted'`. - assumptions.method: 'supplied' | 'capital-asset-pricing' | 'historical-mean' | 'exponentially-weighted'; default: not declared - assumptions.periodsPerYear?: number; default: not declared — Echoed when annualization was requested (sample methods only). - diagnostics: Diagnostics & { effectiveSampleSize?: number; excludedAfterAsOf?: number; sampleSize: number; }; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.effectiveSampleSize?: number; default: not declared — `(Σw)² / Σw²` of the observation weights (`'exponentially-weighted'` only). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.excludedAfterAsOf?: number; default: not declared — Rows excluded because their timestamp is after `asOf` (when both were supplied). - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.sampleSize: number; default: not declared — Return observations consumed (after point-in-time screening); 0 for methods without a sample. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - value: ExpectedReturnsValue; default: not declared - value.annualized: boolean; default: not declared — Whether `expectedReturns` are annual (`true`) or per-period (`false`) — never implicit. - value.assetIds?: string[]; default: not declared — Asset labels, when provided. - value.expectedReturns: number[]; default: not declared — Per-asset expected returns, aligned to the input columns / betas / supplied values. ### @insiderfinance/totalfinance/risk#ExpectedReturnsValue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExpectedReturnsValue { /** Per-asset expected returns, aligned to the input columns / betas / supplied values. */ expectedReturns: number[]; /** Whether `expectedReturns` are annual (`true`) or per-period (`false`) — never implicit. */ annualized: boolean; /** Asset labels, when provided. */ assetIds?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualized: boolean; default: not declared — Whether `expectedReturns` are annual (`true`) or per-period (`false`) — never implicit. - assetIds?: string[]; default: not declared — Asset labels, when provided. - expectedReturns: number[]; default: not declared — Per-asset expected returns, aligned to the input columns / betas / supplied values. ### @insiderfinance/totalfinance/risk#ExplainPnlInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose a realized P&L into greek terms + residual, given the position's Greeks (in the options package's units — theta per day, vega per vol point, rho per 1%; see `PositionGreeks`), the realized move, and the actual P&L. The general primitive — works for any instrument whose greeks you can supply. ```typescript /** * Decompose a realized P&L into greek terms + residual, given the position's Greeks (in the options * package's units — theta per day, vega per vol point, rho per 1%; see `PositionGreeks`), the * realized move, and the actual P&L. The general primitive — works for any instrument whose greeks * you can supply. */ export interface ExplainPnlInput { greeks: PositionGreeks; move: PnlMove; actualPnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - actualPnl: number; default: not declared - greeks: PositionGreeks; default: not declared - greeks.charm?: number; default: not declared — ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. - greeks.color?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.delta?: number; default: not declared — ∂V/∂S per $1 of spot. - greeks.deltaRate?: number; default: not declared — ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. - greeks.gamma?: number; default: not declared — ∂²V/∂S² per $1². - greeks.lambda?: number | null; default: not declared — Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. - greeks.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. - greeks.rho?: number; default: not declared — ∂V/∂r per 1% rate (0.01), as the options package reports it. - greeks.rhoConvexity?: number; default: not declared — ∂²V/∂r² per (1%)² — rho convexity. Optional. - greeks.speed?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.spot?: number; default: not declared — Reference spot, required to resolve percent spot shocks into price moves. - greeks.theta?: number; default: not declared — ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. - greeks.thetaConvexity?: number; default: not declared — ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. - greeks.thetaRate?: number; default: not declared — ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. - greeks.ultima?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.value: number; default: not declared — Current mark value of the position (per unit). - greeks.vanna?: number; default: not declared — ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. - greeks.vega?: number; default: not declared — ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. - greeks.vera?: number; default: not declared — ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. - greeks.veta?: number; default: not declared — ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. - greeks.vomma?: number; default: not declared — ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. - greeks.zomma?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - move: PnlMove; default: not declared - move.dDividendYield?: number; default: not declared — Absolute dividend-yield change (decimal; `+0.005` = +50 bp) — drives the `ε·dq` carry term. - move.dRate?: number; default: not declared — Absolute rate change (decimal; `+0.005` = +50 bp). - move.dSpot?: number; default: not declared — Absolute spot change ($). - move.dTimeYears?: number; default: not declared — Time elapsed, in YEARS. The unit is in the name; the Greeks are per DAY (the options package's units) and the engine converts, so a caller never scales either side by 365. - move.dVolatility?: number; default: not declared — Absolute vol change (decimal; `+0.02` = +2 vol points). ### @insiderfinance/totalfinance/risk#ExplainPositionPnlInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose a strategy {@link StrategyPosition}'s realized P&L between two market states, aggregate and per leg. Marks the position at each state with `Position.value()` (respecting per-leg IV and expiry), attributes each leg via t0's greeks, and reports the residual. The aggregate is the term-wise sum of the per-leg attributions — exactly consistent with the breakdown, and correct when different legs respond to different volatilities (below). **Volatility attribution is honest per leg.** A leg built with its own fixed IV holds that IV in `Position.value()`, so a change in the position-level `volatility` does not move it — its actual vol P&L is 0, and its vega is therefore attributed against a **zero** vol move, not the position-level one. So a fixed-IV leg reports vega ≈ 0 (matching reality) rather than a phantom vega offset by the residual. A leg pricing off the position `volatility` (no per-leg IV) is attributed with the full `to.volatility − from.volatility` move. To attribute a per-leg IV change, mark that leg's own IV, or use {@link explainPnl} directly with your greeks + the vol move you observed. ```typescript /** * Decompose a strategy {@link StrategyPosition}'s realized P&L between two market states, aggregate and * per leg. Marks the position at each state with `Position.value()` (respecting per-leg IV and expiry), * attributes each leg via t0's greeks, and reports the residual. The aggregate is the term-wise sum * of the per-leg attributions — exactly consistent with the breakdown, and correct when different * legs respond to different volatilities (below). * * **Volatility attribution is honest per leg.** A leg built with its own fixed IV holds that IV in * `Position.value()`, so a change in the position-level `volatility` does not move it — its actual vol P&L is * 0, and its vega is therefore attributed against a **zero** vol move, not the position-level one. So * a fixed-IV leg reports vega ≈ 0 (matching reality) rather than a phantom vega offset by the * residual. A leg pricing off the position `volatility` (no per-leg IV) is attributed with the full * `to.volatility − from.volatility` move. To attribute a per-leg IV change, mark that leg's own IV, or use * {@link explainPnl} directly with your greeks + the vol move you observed. */ export interface ExplainPositionPnlInput { position: StrategyPosition; from: PnlMarket; to: PnlMarket; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: PnlMarket; default: not declared - from.asOf: string | number; default: not declared - from.dividendYield?: number; default: not declared - from.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - from.riskFreeRate: number; default: not declared - from.spot: number; default: not declared - from.volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). - position: StrategyPosition; default: not declared - position.legs: readonly StrategyLeg[]; default: not declared - position.metrics: () => import('@insiderfinance/totalfinance/risk').StrategyPayoffMetrics; default: not declared - position.metrics().return.bounded: { loss: boolean; profit: boolean; }; default: not declared - position.metrics().return.bounded.loss: boolean; default: not declared - position.metrics().return.bounded.profit: boolean; default: not declared - position.metrics().return.maxLoss: number | null; default: not declared - position.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/risk').StrategyMarkToMarketResult; default: not declared - position.value().return.greeks: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - position.value().return.perLeg: import('@insiderfinance/totalfinance/risk').StrategyLegValuation[]; default: not declared - position.value().return.pnl: number; default: not declared - position.value().return.value: number; default: not declared - position.value(overrides)?: Partial | undefined; default: not declared - position.value(overrides).asOf?: string | number; default: not declared - position.value(overrides).dividendYield?: number; default: not declared - position.value(overrides).expiry?: string; default: not declared - position.value(overrides).riskFreeRate?: number; default: not declared - position.value(overrides).spot?: number; default: not declared - position.value(overrides).volatility?: number; default: not declared - position.value(overrides).volatilityShock?: number; default: not declared - to: PnlMarket; default: not declared - to.asOf: string | number; default: not declared - to.dividendYield?: number; default: not declared - to.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - to.riskFreeRate: number; default: not declared - to.spot: number; default: not declared - to.volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). ### @insiderfinance/totalfinance/risk#ExponentiallyWeightedExpectedReturnsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExponentiallyWeightedExpectedReturnsInput extends SampleExpectedReturnsFields { method: 'exponentially-weighted'; /** * Half-life of the observation weights in PERIODS: observation `t` of `T` carries weight * `0.5^((T − 1 − t) / halfLifePeriods)` before normalization, so the most recent row is the * heaviest. Required — there is no universal decay rate. */ halfLifePeriods: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: string | number; default: not declared — Point-in-time cut: every row whose timestamp is AFTER this instant is excluded from the estimate and the excluded count is disclosed in `diagnostics.excludedAfterAsOf`. Without `observationTimestamps` nothing can be screened — the result then carries a warning. - assetIds?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result. - halfLifePeriods: number; default: not declared — Half-life of the observation weights in PERIODS: observation `t` of `T` carries weight `0.5^((T − 1 − t) / halfLifePeriods)` before normalization, so the most recent row is the heaviest. Required — there is no universal decay rate. - method: 'exponentially-weighted'; default: not declared - observationTimestamps?: (string | number)[]; default: not declared — Optional observation instants aligned 1:1 with the rows of `returns` (epoch milliseconds or an ISO date / zoned datetime), non-decreasing. Required for `asOf` to screen anything. - periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily, `12` for monthly data): the reported means become `periodMean × periodsPerYear`. OMITTED means per-period means with `annualized: false` — annualization is never silent. - returns: number[][]; default: not declared — Observations-major returns — the same orientation as `CovarianceInput`: `returns[t][k]` is asset `k`'s simple return in period `t` (one row per period, one column per asset). ### @insiderfinance/totalfinance/risk#ExtremeValueTailRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). EVT tail-risk read-out. ```typescript // ─────────────────────────────── EVT VaR / ES ─────────────────────────────── /** EVT tail-risk read-out. */ export interface ExtremeValueTailRisk { confidence: number; /** EVT VaR — a positive loss magnitude. */ valueAtRisk: number; /** EVT Expected Shortfall (`≥ var`; `Infinity` when `ξ ≥ 1`). */ conditionalValueAtRisk: number; /** The empirical (historical) VaR/ES at the same confidence, for comparison. */ empirical: { valueAtRisk: number; conditionalValueAtRisk: number; }; /** The normal (Gaussian) VaR/ES at the same confidence, for comparison. */ normal: { valueAtRisk: number; conditionalValueAtRisk: number; }; /** `evt.var / normal.var` — how much fatter the tail is than the Gaussian says. */ tailFatnessRatio: number; /** The underlying GPD fit. */ fit: GeneralizedParetoFit; assumptions: { conventionsVersion: string; confidence: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { confidence: number; conventionsVersion: string; }; default: not declared - assumptions.confidence: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - conditionalValueAtRisk: number; default: not declared — EVT Expected Shortfall (`≥ var`; `Infinity` when `ξ ≥ 1`). - confidence: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - empirical: { conditionalValueAtRisk: number; valueAtRisk: number; }; default: not declared — The empirical (historical) VaR/ES at the same confidence, for comparison. - empirical.conditionalValueAtRisk: number; default: not declared - empirical.valueAtRisk: number; default: not declared - fit: GeneralizedParetoFit; default: not declared — The underlying GPD fit. - fit.assumptions: { conventionsVersion: string; estimator: 'pwm' | 'mle'; }; default: not declared - fit.assumptions.conventionsVersion: string; default: not declared - fit.assumptions.estimator: 'pwm' | 'mle'; default: not declared - fit.diagnostics: Diagnostics; default: not declared - fit.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - fit.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - fit.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - fit.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - fit.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - fit.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - fit.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - fit.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - fit.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - fit.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - fit.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - fit.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - fit.diagnostics.selection.selected.name: string; default: not declared - fit.diagnostics.selection.selected.version?: string; default: not declared - fit.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - fit.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - fit.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fit.exceedances: number; default: not declared — Number of exceedances `Nu` over the threshold. - fit.method: 'pwm' | 'mle'; default: not declared — The estimator that actually produced the fit (`'mle'` may fall back to `'pwm'`). - fit.observationCount: number; default: not declared — Total number of losses. - fit.scale: number; default: not declared — Scale `β > 0`. - fit.shape: number; default: not declared — Tail index `ξ` — `> 0` heavy, `0` exponential, `< 0` finite endpoint. - fit.tailFraction: number; default: not declared — `Nu / observationCount` — the realized tail fraction. - fit.threshold: number; default: not declared — Loss threshold `u` above which the GPD is fitted. - normal: { conditionalValueAtRisk: number; valueAtRisk: number; }; default: not declared — The normal (Gaussian) VaR/ES at the same confidence, for comparison. - normal.conditionalValueAtRisk: number; default: not declared - normal.valueAtRisk: number; default: not declared - tailFatnessRatio: number; default: not declared — `evt.var / normal.var` — how much fatter the tail is than the Gaussian says. - valueAtRisk: number; default: not declared — EVT VaR — a positive loss magnitude. ### @insiderfinance/totalfinance/risk#FactorAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The factor attribution. ```typescript /** The factor attribution. */ export interface FactorAttribution { factors: FactorContribution[]; /** Per-period specific return (the OLS intercept). */ alpha: number; /** Cumulative specific return `n·alpha` — the part no factor explains. */ specificReturn: number; /** Total of the (excess, if `riskFreeRate` given) return series = `specificReturn + Σ contributions`. */ totalReturn: number; rSquared: number; adjustedRSquared: number; observations: number; assumptions: { conventionsVersion: string; riskFreeRate: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustedRSquared: number; default: not declared - alpha: number; default: not declared — Per-period specific return (the OLS intercept). - assumptions: { conventionsVersion: string; riskFreeRate: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.riskFreeRate: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - factors: FactorContribution[]; default: not declared - observations: number; default: not declared - rSquared: number; default: not declared - specificReturn: number; default: not declared — Cumulative specific return `n·alpha` — the part no factor explains. - totalReturn: number; default: not declared — Total of the (excess, if `riskFreeRate` given) return series = `specificReturn + Σ contributions`. ### @insiderfinance/totalfinance/risk#FactorAttributionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link factorAttribution}. ```typescript /** Inputs for {@link factorAttribution}. */ export interface FactorAttributionInput { /** The asset/portfolio return series to attribute. */ returns: ArrayLike; /** Observable factor return series (each aligned to `returns`). */ factors: FactorSeries[]; /** Per-period risk-free rate subtracted from `returns` first; default 0. */ riskFreeRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factors: FactorSeries[]; default: not declared — Observable factor return series (each aligned to `returns`). - returns: ArrayLike; default: not declared — The asset/portfolio return series to attribute. - riskFreeRate?: number; default: not declared — Per-period risk-free rate subtracted from `returns` first; default 0. ### @insiderfinance/totalfinance/risk#FactorContribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A factor's exposure and its contribution to the realized return. ```typescript /** A factor's exposure and its contribution to the realized return. */ export interface FactorContribution { name: string; /** Exposure / loading `β_k`. */ beta: number; /** t-statistic of the exposure. */ tStatistic: number; /** Cumulative return attributable to the factor: `β_k · Σ(factor returns)`. */ contribution: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beta: number; default: not declared — Exposure / loading `β_k`. - contribution: number; default: not declared — Cumulative return attributable to the factor: `β_k · Σ(factor returns)`. - name: string; default: not declared - tStatistic: number; default: not declared — t-statistic of the exposure. ### @insiderfinance/totalfinance/risk#FactorExposureResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FactorExposureResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** The retained top-k principal components. */ factors: PcaComponent[]; /** `exposure[assetIndex][factorIndex]` = that asset's loading on the factor. */ exposure: number[][]; /** Total variance explained by the retained factors. */ varianceExplained: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - exposure: number[][]; default: not declared — `exposure[assetIndex][factorIndex]` = that asset's loading on the factor. - factors: PcaComponent[]; default: not declared — The retained top-k principal components. - varianceExplained: number; default: not declared — Total variance explained by the retained factors. ### @insiderfinance/totalfinance/risk#FactorSeries Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One observable factor's return series. ```typescript // ─────────────────────────────── factor P&L attribution ─────────────────────────────── /** One observable factor's return series. */ export interface FactorSeries { name: string; /** Per-period factor returns, aligned to the subject `returns`. */ returns: ArrayLike; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - returns: ArrayLike; default: not declared — Per-period factor returns, aligned to the subject `returns`. ### @insiderfinance/totalfinance/risk#FrontierPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FrontierPoint extends FrontierPortfolio { /** Position in the grid. */ index: number; /** What this point was asked to be. */ requested: { riskAversion?: number; targetReturn?: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared — The underlying solver converged AND (for targets) the requested return was met. - expectedReturn: number | null; default: not declared - feasible: boolean; default: not declared — Whether the point satisfies the constraint set (budget, box, groups, turnover). - index: number; default: not declared — Position in the grid. - iterations: number; default: not declared — Solver iterations spent on this point (all bisection solves included). - reason?: string; default: not declared — Why the point failed or did not converge. - requested: { riskAversion?: number; targetReturn?: number; }; default: not declared — What this point was asked to be. - requested.riskAversion?: number; default: not declared - requested.targetReturn?: number; default: not declared - sharpeRatio: number | null; default: not declared — `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. - variance: number | null; default: not declared - volatility: number | null; default: not declared - warnings: QuantWarning[]; default: not declared - weights: number[] | null; default: not declared — `null` when the point failed (unreachable target or a non-finite solve). ### @insiderfinance/totalfinance/risk#FrontierPortfolio Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One solved (or failed) portfolio on the frontier. ```typescript /** One solved (or failed) portfolio on the frontier. */ export interface FrontierPortfolio { /** `null` when the point failed (unreachable target or a non-finite solve). */ weights: number[] | null; expectedReturn: number | null; variance: number | null; volatility: number | null; /** `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. */ sharpeRatio: number | null; /** The underlying solver converged AND (for targets) the requested return was met. */ converged: boolean; /** Solver iterations spent on this point (all bisection solves included). */ iterations: number; /** Whether the point satisfies the constraint set (budget, box, groups, turnover). */ feasible: boolean; /** Why the point failed or did not converge. */ reason?: string; warnings: QuantWarning[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - converged: boolean; default: not declared — The underlying solver converged AND (for targets) the requested return was met. - expectedReturn: number | null; default: not declared - feasible: boolean; default: not declared — Whether the point satisfies the constraint set (budget, box, groups, turnover). - iterations: number; default: not declared — Solver iterations spent on this point (all bisection solves included). - reason?: string; default: not declared — Why the point failed or did not converge. - sharpeRatio: number | null; default: not declared — `(expectedReturn − riskFreeRatePerPeriod) / volatility`; `null` without a rate or at zero volatility. - variance: number | null; default: not declared - volatility: number | null; default: not declared - warnings: QuantWarning[]; default: not declared - weights: number[] | null; default: not declared — `null` when the point failed (unreachable target or a non-finite solve). ### @insiderfinance/totalfinance/risk#GeneralizedParetoFit Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A fitted Generalized Pareto tail. ```typescript /** A fitted Generalized Pareto tail. */ export interface GeneralizedParetoFit { /** Tail index `ξ` — `> 0` heavy, `0` exponential, `< 0` finite endpoint. */ shape: number; /** Scale `β > 0`. */ scale: number; /** Loss threshold `u` above which the GPD is fitted. */ threshold: number; /** Number of exceedances `Nu` over the threshold. */ exceedances: number; /** Total number of losses. */ observationCount: number; /** `Nu / observationCount` — the realized tail fraction. */ tailFraction: number; /** The estimator that actually produced the fit (`'mle'` may fall back to `'pwm'`). */ method: 'pwm' | 'mle'; assumptions: { conventionsVersion: string; estimator: 'pwm' | 'mle'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; estimator: 'pwm' | 'mle'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.estimator: 'pwm' | 'mle'; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - exceedances: number; default: not declared — Number of exceedances `Nu` over the threshold. - method: 'pwm' | 'mle'; default: not declared — The estimator that actually produced the fit (`'mle'` may fall back to `'pwm'`). - observationCount: number; default: not declared — Total number of losses. - scale: number; default: not declared — Scale `β > 0`. - shape: number; default: not declared — Tail index `ξ` — `> 0` heavy, `0` exponential, `< 0` finite endpoint. - tailFraction: number; default: not declared — `Nu / observationCount` — the realized tail fraction. - threshold: number; default: not declared — Loss threshold `u` above which the GPD is fitted. ### @insiderfinance/totalfinance/risk#GeneralizedParetoFitOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link fitGeneralizedParetoTail}. ```typescript /** Options for {@link fitGeneralizedParetoTail}. */ export interface GeneralizedParetoFitOptions { /** Worst fraction of losses used as exceedances; default 0.10. Ignored when `threshold` is set. */ tailFraction?: number; /** Explicit loss threshold `u` (overrides `tailFraction`). */ threshold?: number; /** Estimator; default `'pwm'` (closed-form, robust). */ method?: 'pwm' | 'mle'; /** Exceedance count below which the fit is warned as unreliable; default 10. */ minExceedances?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method?: 'pwm' | 'mle'; default: not declared — Estimator; default `'pwm'` (closed-form, robust). - minExceedances?: number; default: not declared — Exceedance count below which the fit is warned as unreliable; default 10. - tailFraction?: number; default: not declared — Worst fraction of losses used as exceedances; default 0.10. Ignored when `threshold` is set. - threshold?: number; default: not declared — Explicit loss threshold `u` (overrides `tailFraction`). ### @insiderfinance/totalfinance/risk#GroupConstraint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A sector/group exposure cap: the listed asset indices must sum within `[min, max]`. ```typescript /** A sector/group exposure cap: the listed asset indices must sum within `[min, max]`. */ export interface GroupConstraint { /** Asset indices belonging to the group. */ members: number[]; /** Minimum aggregate weight for the group (default `-Infinity`). */ min?: number; /** Maximum aggregate weight for the group (default `+Infinity`). */ max?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - max?: number; default: not declared — Maximum aggregate weight for the group (default `+Infinity`). - members: number[]; default: not declared — Asset indices belonging to the group. - min?: number; default: not declared — Minimum aggregate weight for the group (default `-Infinity`). ### @insiderfinance/totalfinance/risk#HistoricalMeanExpectedReturnsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HistoricalMeanExpectedReturnsInput extends SampleExpectedReturnsFields { method: 'historical-mean'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: string | number; default: not declared — Point-in-time cut: every row whose timestamp is AFTER this instant is excluded from the estimate and the excluded count is disclosed in `diagnostics.excludedAfterAsOf`. Without `observationTimestamps` nothing can be screened — the result then carries a warning. - assetIds?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result. - method: 'historical-mean'; default: not declared - observationTimestamps?: (string | number)[]; default: not declared — Optional observation instants aligned 1:1 with the rows of `returns` (epoch milliseconds or an ISO date / zoned datetime), non-decreasing. Required for `asOf` to screen anything. - periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily, `12` for monthly data): the reported means become `periodMean × periodsPerYear`. OMITTED means per-period means with `annualized: false` — annualization is never silent. - returns: number[][]; default: not declared — Observations-major returns — the same orientation as `CovarianceInput`: `returns[t][k]` is asset `k`'s simple return in period `t` (one row per period, one column per asset). ### @insiderfinance/totalfinance/risk#HistoricalPortfolioVaRInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A matrix of asset returns: one row per observation, one column per asset (the weights' order). ```typescript /** A matrix of asset returns: one row per observation, one column per asset (the weights' order). */ export interface HistoricalPortfolioVaRInput { weights: ArrayLike; returns: ArrayLike>; method: 'historical'; options?: HistoricalPortfolioVaROptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method: 'historical'; default: not declared - options?: HistoricalPortfolioVaROptions; default: not declared - options.confidence?: number; default: not declared - options.horizonPeriods?: number; default: not declared - returns: ArrayLike>; default: not declared - weights: ArrayLike; default: not declared ### @insiderfinance/totalfinance/risk#HistoricalPortfolioVaROptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── portfolio VaR — one door, three methods (C hygiene) ───────────────────────── export interface HistoricalPortfolioVaROptions { confidence?: number; horizonPeriods?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared - horizonPeriods?: number; default: not declared ### @insiderfinance/totalfinance/risk#HistoricalPortfolioVaRResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HistoricalPortfolioVaRResult extends VaRResult { assumptions: { conventionsVersion: string; [k: string]: unknown; }; diagnostics: { warnings: QuantWarning[]; }; /** The number of portfolio-return observations the empirical tail was read from. */ observations: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - confidence: number; default: not declared - cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - diagnostics.warnings: QuantWarning[]; default: not declared - horizonPeriods: number; default: not declared - method: VaRMethod; default: not declared - observations: number; default: not declared — The number of portfolio-return observations the empirical tail was read from. - samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. - seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). - valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#KellyBetInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link kellyBet}. Supply the edge exactly one of four ways. ```typescript /** Inputs for {@link kellyBet}. Supply the edge exactly one of four ways. */ export interface KellyBetInput { edge: { binary: BinaryEdge; } | { outcomes: EdgeOutcome[]; } | { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; /** Fraction of full Kelly to apply (0.5 = half-Kelly). Default 0.5. Must be > 0. */ fraction?: number; /** Cap the applied Kelly multiple so `P(ever falling to toFraction of starting bankroll) ≤ maxProbability`. */ drawdownLimit?: { toFraction: number; maxProbability: number; }; /** Hard cap on the recommended fraction of bankroll (e.g. 1 = no leverage). Must be > 0. */ maxFraction?: number; /** Optional horizonPeriods (periods) for the growth projection. Must be > 0 when given. */ horizonPeriods?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drawdownLimit?: { maxProbability: number; toFraction: number; }; default: not declared — Cap the applied Kelly multiple so `P(ever falling to toFraction of starting bankroll) ≤ maxProbability`. - drawdownLimit.maxProbability: number; default: not declared - drawdownLimit.toFraction: number; default: not declared - edge: { binary: BinaryEdge; } | { outcomes: EdgeOutcome[]; } | { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; default: not declared - edge.binary: BinaryEdge; default: not declared - edge.binary.lossAmount?: number; default: not declared — Loss per unit staked on a loss (e.g. 1 = lose the stake). Default 1. Must be > 0. - edge.binary.winAmount: number; default: not declared — Gain per unit staked on a win (e.g. 2 = win 2× the stake). Must be > 0. - edge.binary.winProbability: number; default: not declared — Probability of the winning outcome, in (0, 1). - edge.gaussian: { mean: number; variance: number; }; default: not declared - edge.gaussian.mean: number; default: not declared - edge.gaussian.variance: number; default: not declared - edge.outcomes: EdgeOutcome[]; default: not declared - edge.returns: ArrayLike; default: not declared - fraction?: number; default: not declared — Fraction of full Kelly to apply (0.5 = half-Kelly). Default 0.5. Must be > 0. - horizonPeriods?: number; default: not declared — Optional horizonPeriods (periods) for the growth projection. Must be > 0 when given. - maxFraction?: number; default: not declared — Hard cap on the recommended fraction of bankroll (e.g. 1 = no leverage). Must be > 0. ### @insiderfinance/totalfinance/risk#KellyOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Kelly ───────────────────────── export interface KellyOptions extends OptimizeConstraints { /** Fraction of full Kelly (e.g. 0.5 for half-Kelly). Must be > 0. Default 1. */ fraction?: number; /** * Normalize the Kelly weights to the `budget` (fully invested). Default false (leverage implied). * When the raw Kelly weights sum to ≤ 0 (a net-short growth-optimal book), dividing by that total * would flip every position's sign — instead the UNnormalized weights are returned with * `converged: false` and a `risk.kelly_negative_sum` warning (design law #4: disclose, don't flip). * With `constraints`, this flag is a no-op: the constrained solve already pins Σw to the budget. */ normalize?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - fraction?: number; default: not declared — Fraction of full Kelly (e.g. 0.5 for half-Kelly). Must be > 0. Default 1. - groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - normalize?: boolean; default: not declared — Normalize the Kelly weights to the `budget` (fully invested). Default false (leverage implied). When the raw Kelly weights sum to ≤ 0 (a net-short growth-optimal book), dividing by that total would flip every position's sign — instead the UNnormalized weights are returned with `converged: false` and a `risk.kelly_negative_sum` warning (design law #4: disclose, don't flip). With `constraints`, this flag is a no-op: the constrained solve already pins Σw to the budget. - tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - transactionCosts.perUnitTurnover: number | number[]; default: not declared - transactionCosts.previousWeights: number[]; default: not declared - turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk#KellySizing Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The sizing verdict. ```typescript /** The sizing verdict. */ export interface KellySizing { /** * `f*` — the growth-optimal fraction of bankroll. `null` when the edge has **no downside**, so * log-growth increases without bound and there is no finite unconstrained optimum (finite-success * law — never `Infinity`; a `risk.kelly_unbounded` diagnostic explains it). */ fullKelly: number | null; /** * The recommended fraction after the fractional/drawdown/max caps (≥ 0). `null` only for a * no-downside edge with **no** explicit cap — a finite recommendation then requires a `maxFraction`. */ recommendedFraction: number | null; /** `κ = recommendedFraction / fullKelly` — the applied Kelly multiple (0 when there's no edge); * `null` when `fullKelly` is null (undefined against a non-existent optimum). */ appliedFraction: number | null; /** Expected per-period log-growth at the recommended fraction; `null` when there is none. */ growthRate: number | null; /** Expected per-period log-growth at full Kelly (the maximum); `null` for a no-downside edge. */ growthRateFull: number | null; /** `ln 2 / growthRate` — periods to double at the recommended fraction (`Infinity` when growth ≤ 0, * `null` when there is no finite recommendation). */ periodsToDouble: number | null; /** `P(wealth ever falls to toFraction of the starting bankroll)` at the recommended fraction (continuous model). */ drawdownRisk: { toFraction: number; probability: number; }; /** Which cap set the recommended fraction (`no-downside` = unbounded edge with no cap supplied). */ bindingConstraint: 'fraction' | 'drawdown-limit' | 'max-fraction' | 'no-edge' | 'no-downside'; /** Returns path only: the Gaussian `μ/σ²` estimate, for comparison with the exact empirical `f*`. */ gaussianKelly?: number; /** Present when `horizonPeriods` is given: the median wealth projection over the horizonPeriods. */ horizonGrowth?: { horizonPeriods: number; logGrowth: number; growthMultiple: number; }; /** Prose an agent relays. */ rationale: string; assumptions: { conventionsVersion: string; fraction: number; drawdownModel: 'continuous-gbm'; edgeType: 'binary' | 'outcomes' | 'gaussian' | 'returns'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - appliedFraction: number | null; default: not declared — `κ = recommendedFraction / fullKelly` — the applied Kelly multiple (0 when there's no edge); `null` when `fullKelly` is null (undefined against a non-existent optimum). - assumptions: { conventionsVersion: string; drawdownModel: 'continuous-gbm'; edgeType: 'binary' | 'outcomes' | 'gaussian' | 'returns'; fraction: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.drawdownModel: 'continuous-gbm'; default: not declared - assumptions.edgeType: 'returns' | 'gaussian' | 'binary' | 'outcomes'; default: not declared - assumptions.fraction: number; default: not declared - bindingConstraint: 'fraction' | 'drawdown-limit' | 'max-fraction' | 'no-edge' | 'no-downside'; default: not declared — Which cap set the recommended fraction (`no-downside` = unbounded edge with no cap supplied). - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - drawdownRisk: { probability: number; toFraction: number; }; default: not declared — `P(wealth ever falls to toFraction of the starting bankroll)` at the recommended fraction (continuous model). - drawdownRisk.probability: number; default: not declared - drawdownRisk.toFraction: number; default: not declared - fullKelly: number | null; default: not declared — `f*` — the growth-optimal fraction of bankroll. `null` when the edge has **no downside**, so log-growth increases without bound and there is no finite unconstrained optimum (finite-success law — never `Infinity`; a `risk.kelly_unbounded` diagnostic explains it). - gaussianKelly?: number; default: not declared — Returns path only: the Gaussian `μ/σ²` estimate, for comparison with the exact empirical `f*`. - growthRate: number | null; default: not declared — Expected per-period log-growth at the recommended fraction; `null` when there is none. - growthRateFull: number | null; default: not declared — Expected per-period log-growth at full Kelly (the maximum); `null` for a no-downside edge. - horizonGrowth?: { growthMultiple: number; horizonPeriods: number; logGrowth: number; }; default: not declared — Present when `horizonPeriods` is given: the median wealth projection over the horizonPeriods. - horizonGrowth.growthMultiple: number; default: not declared - horizonGrowth.horizonPeriods: number; default: not declared - horizonGrowth.logGrowth: number; default: not declared - periodsToDouble: number | null; default: not declared — `ln 2 / growthRate` — periods to double at the recommended fraction (`Infinity` when growth ≤ 0, `null` when there is no finite recommendation). - rationale: string; default: not declared — Prose an agent relays. - recommendedFraction: number | null; default: not declared — The recommended fraction after the fractional/drawdown/max caps (≥ 0). `null` only for a no-downside edge with **no** explicit cap — a finite recommendation then requires a `maxFraction`. ### @insiderfinance/totalfinance/risk#LeakageIssue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One leaking split found by {@link checkLeakage}. ```typescript // ───────────────────────── leakage & survivorship diagnostics ───────────────────────── /** One leaking split found by {@link checkLeakage}. */ export interface LeakageIssue { /** Index of the leaking split. */ split: number; /** How many indices appear in both train and test. */ overlapCount: number; /** Up to 10 of the overlapping indices, as a sample. */ sample: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - overlapCount: number; default: not declared — How many indices appear in both train and test. - sample: number[]; default: not declared — Up to 10 of the overlapping indices, as a sample. - split: number; default: not declared — Index of the leaking split. ### @insiderfinance/totalfinance/risk#LeakageReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link checkLeakage}'s report: the leak findings plus the Law 2 report grammar. ```typescript /** {@link checkLeakage}'s report: the leak findings plus the Law 2 report grammar. */ export interface LeakageReport { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** The leakage warnings themselves (one `research.train_test_leakage` per leaking split). */ diagnostics: { warnings: QuantWarning[]; }; /** `true` when no split leaks. */ clean: boolean; /** Per-split leak details, aligned with `diagnostics.warnings`. */ leaks: LeakageIssue[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - clean: boolean; default: not declared — `true` when no split leaks. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — The leakage warnings themselves (one `research.train_test_leakage` per leaking split). - diagnostics.warnings: QuantWarning[]; default: not declared - leaks: LeakageIssue[]; default: not declared — Per-split leak details, aligned with `diagnostics.warnings`. ### @insiderfinance/totalfinance/risk#LegPnlExplain Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-leg realized P&L attribution (bare terms; the report wrapper lives on the position level). ```typescript /** Per-leg realized P&L attribution (bare terms; the report wrapper lives on the position level). */ export interface LegPnlExplain extends Omit { leg: StrategyLeg; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - delta: number; default: not declared — Delta term: `Δ·dS`. - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - leg: StrategyLeg; default: not declared - leg.expiry?: (string) | (undefined); default: not declared - leg.impliedVolatility?: (number) | (undefined); default: not declared - leg.kind: ('call' | 'put') | ('stock'); default: not declared - leg.premium?: (number) | (undefined); default: not declared - leg.price?: (number) | (undefined); default: not declared - leg.quantity: number; default: not declared - leg.strike?: (number) | (undefined); default: not declared - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - rho: number; default: not declared — Rho term: `Rho·dr`. - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - theta: number; default: not declared — Theta term: `Θ·dt`. - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - total: number; default: not declared — The actual realized P&L. - unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - vega: number; default: not declared — Vega term: `Vega·dσ`. - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#LinkAttributionOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link linkAttribution}. ```typescript /** Options for {@link linkAttribution}. */ export interface LinkAttributionOptions { /** Linking method; default (and currently only) `'carino'`. */ method?: LinkMethod; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method?: 'carino'; default: not declared — Linking method; default (and currently only) `'carino'`. ### @insiderfinance/totalfinance/risk#LinkedAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The multi-period-linked attribution. ```typescript /** The multi-period-linked attribution. */ export interface LinkedAttribution { /** Compounded portfolio return `∏(1+Pₜ) − 1`. */ portfolioReturn: number; /** Compounded benchmark return `∏(1+Bₜ) − 1`. */ benchmarkReturn: number; /** `portfolioReturn − benchmarkReturn` (the geometric active return). */ activeReturn: number; /** Linked cumulative effects — `allocation + selection + interaction = activeReturn`, exact. */ allocation: number; selection: number; interaction: number; /** The per-period linking coefficient `βₜ` (with the period `label` when supplied). */ linkingCoefficients: LinkingCoefficient[]; /** Linked per-segment effects — present only when every period supplied segments. */ segments?: SegmentEffect[]; method: LinkMethod; assumptions: { conventionsVersion: string; method: LinkMethod; periods: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - activeReturn: number; default: not declared — `portfolioReturn − benchmarkReturn` (the geometric active return). - allocation: number; default: not declared — Linked cumulative effects — `allocation + selection + interaction = activeReturn`, exact. - assumptions: { conventionsVersion: string; method: LinkMethod; periods: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'carino'; default: not declared - assumptions.periods: number; default: not declared - benchmarkReturn: number; default: not declared — Compounded benchmark return `∏(1+Bₜ) − 1`. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - interaction: number; default: not declared - linkingCoefficients: LinkingCoefficient[]; default: not declared — The per-period linking coefficient `βₜ` (with the period `label` when supplied). - method: 'carino'; default: not declared - portfolioReturn: number; default: not declared — Compounded portfolio return `∏(1+Pₜ) − 1`. - segments?: SegmentEffect[]; default: not declared — Linked per-segment effects — present only when every period supplied segments. - selection: number; default: not declared ### @insiderfinance/totalfinance/risk#LinkingCoefficient Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A per-period Cariño linking coefficient `βₜ`. ```typescript /** A per-period Cariño linking coefficient `βₜ`. */ export interface LinkingCoefficient { label?: string; coefficient: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coefficient: number; default: not declared - label?: string; default: not declared ### @insiderfinance/totalfinance/risk#LiquidityPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── liquidity approximations ───────────────────────── export interface LiquidityPosition { /** Position size (signed), in the same unit as `averageDailyVolume` (shares or notional). */ size: number; /** Average daily volume (> 0), same unit as `size`. */ averageDailyVolume: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageDailyVolume: number; default: not declared — Average daily volume (> 0), same unit as `size`. - size: number; default: not declared — Position size (signed), in the same unit as `averageDailyVolume` (shares or notional). ### @insiderfinance/totalfinance/risk#LiquidityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LiquidityResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; perAsset: { daysToLiquidate: number; averageDailyVolumeMultiple: number; }[]; /** Days to fully unwind the book trading each name at `participation` of its ADV (the slowest name). */ portfolioDaysToLiquidate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - perAsset: { daysToLiquidate: number; averageDailyVolumeMultiple: number; }[]; default: not declared - portfolioDaysToLiquidate: number; default: not declared — Days to fully unwind the book trading each name at `participation` of its ADV (the slowest name). ### @insiderfinance/totalfinance/risk#MarginResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── margin approximations ───────────────────────── export interface MarginResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; grossExposure: number; netExposure: number; longExposure: number; /** Short exposure as a positive magnitude. */ shortExposure: number; /** Initial (Reg-T-style) margin requirement: `initialRate · gross`. */ initialMargin: number; /** Maintenance margin requirement: `maintenanceRate · gross`. */ maintenanceMargin: number; /** Gross leverage `gross / equity`. */ leverage: number; /** Whether `equity ≥ maintenanceMargin`. */ meetsMaintenance: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - grossExposure: number; default: not declared - initialMargin: number; default: not declared — Initial (Reg-T-style) margin requirement: `initialRate · gross`. - leverage: number; default: not declared — Gross leverage `gross / equity`. - longExposure: number; default: not declared - maintenanceMargin: number; default: not declared — Maintenance margin requirement: `maintenanceRate · gross`. - meetsMaintenance: boolean; default: not declared — Whether `equity ≥ maintenanceMargin`. - netExposure: number; default: not declared - shortExposure: number; default: not declared — Short exposure as a positive magnitude. ### @insiderfinance/totalfinance/risk#MarketImpactInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs to {@link marketImpact}: the trade size, the asset's ADV, and its per-period vol. ```typescript /** Inputs to {@link marketImpact}: the trade size, the asset's ADV, and its per-period vol. */ export interface MarketImpactInput { /** Trade size (signed), in the same unit as `averageDailyVolume` (shares or notional). */ size: number; /** Average daily volume (> 0), same unit as `size`. */ averageDailyVolume: number; /** The asset's per-period vol (≥ 0). */ volatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averageDailyVolume: number; default: not declared — Average daily volume (> 0), same unit as `size`. - size: number; default: not declared — Trade size (signed), in the same unit as `averageDailyVolume` (shares or notional). - volatility: number; default: not declared — The asset's per-period vol (≥ 0). ### @insiderfinance/totalfinance/risk#MarketImpactResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link marketImpact}'s envelope: the impact cost plus the applied impact-law coefficient. ```typescript /** {@link marketImpact}'s envelope: the impact cost plus the applied impact-law coefficient. */ export type MarketImpactResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ coefficient: number; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.coefficient: number; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/risk#MaxSharpeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── maximum Sharpe (tangency) ───────────────────────── export interface MaxSharpeOptions extends OptimizeConstraints { /** * Risk-free rate **in the same per-period units as `mean` and `covariance`** — a daily-return * problem takes a daily rate (0.04/252), not 0.04. Default 0. * * Named `riskFreeRatePerPeriod` (renamed from `riskFreeRate` pre-1.0) because every other * `riskFreeRate` in the library — `@insiderfinance/totalfinance/performance`'s sharpe/sortino/alpha, the backtest * report — is an ANNUAL rate that the callee de-annualizes. Passing 0.04 here on daily inputs * silently subtracted a 4%-per-DAY hurdle, turning every excess return negative and dropping * maxSharpe into its min-variance fallback. One spelling per unit: the compiler now catches it. */ riskFreeRatePerPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - riskFreeRatePerPeriod?: number; default: not declared — Risk-free rate **in the same per-period units as `mean` and `covariance`** — a daily-return problem takes a daily rate (0.04/252), not 0.04. Default 0. Named `riskFreeRatePerPeriod` (renamed from `riskFreeRate` pre-1.0) because every other `riskFreeRate` in the library — `@insiderfinance/totalfinance/performance`'s sharpe/sortino/alpha, the backtest report — is an ANNUAL rate that the callee de-annualizes. Passing 0.04 here on daily inputs silently subtracted a 4%-per-DAY hurdle, turning every excess return negative and dropping maxSharpe into its min-variance fallback. One spelling per unit: the compiler now catches it. - tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - transactionCosts.perUnitTurnover: number | number[]; default: not declared - transactionCosts.previousWeights: number[]; default: not declared - turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk#MeanExcessPlot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The mean-excess plot and the threshold it suggests. ```typescript /** The mean-excess plot and the threshold it suggests. */ export interface MeanExcessPlot { points: MeanExcessPoint[]; /** Heuristic tail-onset threshold — the lowest `u` above which `e(·)` is ~linear. */ suggestedThreshold: number; /** `ξ` from the slope over `[suggestedThreshold, uₘₐₓ]`: `ξ = slope/(1+slope)`. */ tailIndexEstimate: number; /** `Nu(suggestedThreshold)/n` — hand to `fitGeneralizedParetoTail({ tailFraction })`. */ suggestedTailFraction: number; assumptions: { conventionsVersion: string; observations: number; losses: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; losses: number; observations: number; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.losses: number; default: not declared - assumptions.observations: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - points: MeanExcessPoint[]; default: not declared - suggestedTailFraction: number; default: not declared — `Nu(suggestedThreshold)/n` — hand to `fitGeneralizedParetoTail({ tailFraction })`. - suggestedThreshold: number; default: not declared — Heuristic tail-onset threshold — the lowest `u` above which `e(·)` is ~linear. - tailIndexEstimate: number; default: not declared — `ξ` from the slope over `[suggestedThreshold, uₘₐₓ]`: `ξ = slope/(1+slope)`. ### @insiderfinance/totalfinance/risk#MeanExcessPlotOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link meanExcessPlot}. ```typescript // ───────────────────────── mean-excess plot / threshold selection ───────────────────────── /** Options for {@link meanExcessPlot}. */ export interface MeanExcessPlotOptions { /** Explicit candidate thresholds (loss units); else an auto grid. */ thresholds?: number[]; /** Auto-grid point count. Default 25. */ gridSize?: number; /** Auto-grid lower bound as a loss quantile in (0, 1). Default 0.5 (the median loss). */ startQuantile?: number; /** Minimum exceedances the top threshold retains (and the fit-reliability floor). Default 10. */ minExceedances?: number; /** Normalized deviation below which the mean-excess counts as linear. Default 0.1. */ linearTolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - gridSize?: number; default: not declared — Auto-grid point count. Default 25. - linearTolerance?: number; default: not declared — Normalized deviation below which the mean-excess counts as linear. Default 0.1. - minExceedances?: number; default: not declared — Minimum exceedances the top threshold retains (and the fit-reliability floor). Default 10. - startQuantile?: number; default: not declared — Auto-grid lower bound as a loss quantile in (0, 1). Default 0.5 (the median loss). - thresholds?: number[]; default: not declared — Explicit candidate thresholds (loss units); else an auto grid. ### @insiderfinance/totalfinance/risk#MeanExcessPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One point of the mean-excess plot. ```typescript /** One point of the mean-excess plot. */ export interface MeanExcessPoint { threshold: number; /** `E[X − u | X > u]` — the mean of the excesses over `u`. */ meanExcess: number; /** Number of losses above `u`. */ exceedances: number; /** `sd(excesses)/√Nu` — the mean-excess standard error. */ standardError: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exceedances: number; default: not declared — Number of losses above `u`. - meanExcess: number; default: not declared — `E[X − u | X > u]` — the mean of the excesses over `u`. - standardError: number; default: not declared — `sd(excesses)/√Nu` — the mean-excess standard error. - threshold: number; default: not declared ### @insiderfinance/totalfinance/risk#MeanReturnsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MeanReturnsInput { /** Observations-major returns — same orientation as {@link CovarianceInput}. */ returns: number[][]; /** * Annualize by this factor (e.g. `252` for daily data): reported means become * `periodMean × periodsPerYear`. OMITTED means per-period means — annualization is never * silent (spec Law 6). */ periodsPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily data): reported means become `periodMean × periodsPerYear`. OMITTED means per-period means — annualization is never silent (spec Law 6). - returns: number[][]; default: not declared — Observations-major returns — same orientation as {@link CovarianceInput}. ### @insiderfinance/totalfinance/risk#MeanVarianceOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── mean-variance utility ───────────────────────── export interface MeanVarianceOptions extends OptimizeConstraints { /** Risk-aversion `λ` in `max μᵀw − (λ/2)·wᵀΣw`. Higher ⇒ more conservative. Default 1. */ riskAversion?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - riskAversion?: number; default: not declared — Risk-aversion `λ` in `max μᵀw − (λ/2)·wᵀΣw`. Higher ⇒ more conservative. Default 1. - tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - transactionCosts.perUnitTurnover: number | number[]; default: not declared - transactionCosts.previousWeights: number[]; default: not declared - turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk#MonteCarloPortfolioVaRInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#MonteCarloPortfolioVaRInput`. ### @insiderfinance/totalfinance/risk#MonteCarloPortfolioVaRResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MonteCarloPortfolioVaRResult extends VaRResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty) — the one warnings channel. */ diagnostics: { warnings: QuantWarning[]; }; /** The PRNG seed actually used (always echoed for reproducibility). */ seed: number; /** The number of simulated samples actually drawn (always echoed). */ samples: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - confidence: number; default: not declared - cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — the one warnings channel. - diagnostics.warnings: QuantWarning[]; default: not declared - horizonPeriods: number; default: not declared - method: VaRMethod; default: not declared - samples: number; default: not declared — The number of simulated samples actually drawn (always echoed). - seed: number; default: not declared — The PRNG seed actually used (always echoed for reproducibility). - valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#MultipleTestMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── multiple-testing correction ───────────────────────── export type MultipleTestMethod = 'bonferroni' | 'sidak' | 'holm' | 'benjaminiHochberg'; ``` ### @insiderfinance/totalfinance/risk#MultipleTestOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MultipleTestOptions { /** Correction method (default `'holm'`). */ method?: MultipleTestMethod; /** Significance level (default 0.05). */ alpha?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha?: number; default: not declared — Significance level (default 0.05). - method?: MultipleTestMethod; default: not declared — Correction method (default `'holm'`). ### @insiderfinance/totalfinance/risk#MultipleTestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MultipleTestResult { method: MultipleTestMethod; alpha: number; /** Adjusted p-values aligned with the input order. */ adjusted: number[]; /** Whether each hypothesis is rejected at `alpha` (`adjusted ≤ alpha`). */ rejected: boolean[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjusted: number[]; default: not declared — Adjusted p-values aligned with the input order. - alpha: number; default: not declared - method: MultipleTestMethod; default: not declared - rejected: boolean[]; default: not declared — Whether each hypothesis is rejected at `alpha` (`adjusted ≤ alpha`). ### @insiderfinance/totalfinance/risk#NakedMarginInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs to {@link nakedCallMargin} / {@link nakedPutMargin}: the underlier spot, strike, and premium. ```typescript /** Inputs to {@link nakedCallMargin} / {@link nakedPutMargin}: the underlier spot, strike, and premium. */ export interface NakedMarginInput { /** Current price of the underlying (> 0). */ spot: number; /** Option strike (> 0). */ strike: number; /** Premium per share, entry mid (≥ 0). */ premium: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - premium: number; default: not declared — Premium per share, entry mid (≥ 0). - spot: number; default: not declared — Current price of the underlying (> 0). - strike: number; default: not declared — Option strike (> 0). ### @insiderfinance/totalfinance/risk#NakedMarginOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── options margin / buying-power (spec §15.3) ───────────────────────── export interface NakedMarginOptions { /** Contract multiplier (default 100). */ multiplier?: number; /** Reg-T naked "equity" rate — the % of underlying (default 0.20). */ equityRate?: number; /** Reg-T naked floor rate — the % of underlying (calls) / strike (puts) minimum (default 0.10). */ floorRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - equityRate?: number; default: not declared — Reg-T naked "equity" rate — the % of underlying (default 0.20). - floorRate?: number; default: not declared — Reg-T naked floor rate — the % of underlying (calls) / strike (puts) minimum (default 0.10). - multiplier?: number; default: not declared — Contract multiplier (default 100). ### @insiderfinance/totalfinance/risk#NakedMarginResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The naked-margin envelope: `value` is the Reg-T requirement in account currency per contract, and the applied multiplier / equity-rate / floor-rate defaults ride `assumptions` (dx §2.4). ```typescript /** * The naked-margin envelope: `value` is the Reg-T requirement in account currency per contract, and * the applied multiplier / equity-rate / floor-rate defaults ride `assumptions` (dx §2.4). */ export type NakedMarginResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.equityRate: number; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.floorRate: number; default: not declared - assumptions.model?: string; default: not declared - assumptions.multiplier: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/risk#OptimizeConstraints Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptimizeConstraints { /** Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. */ longOnly?: boolean; /** Per-asset `[lo, hi]` bounds. */ bounds?: [ number, number ][]; /** Sum-to budget (`Σw`). Default 1 (fully invested). */ budget?: number; /** Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). */ groups?: GroupConstraint[]; /** Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). */ turnover?: TurnoverConstraint; /** * Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the * objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. */ transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; /** Projected-gradient iteration cap. Default 5000. */ maximumIterations?: number; /** Projected-gradient convergence tolerance on the weight step. Default 1e-11. */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - transactionCosts.perUnitTurnover: number | number[]; default: not declared - transactionCosts.previousWeights: number[]; default: not declared - turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk#OptimizeResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The public optimizer result (dx §2.4): the core `Computed` envelope. `value` carries the weights and the objective at the solution; `assumptions` echo which objective ran and the budget; `diagnostics` carry `converged` / `iterations` and all warnings — a non-converged run adds an `optimize.not_converged` warning naming the solver's stop reason instead of hoisting a bespoke `reason` field. ```typescript /** * The public optimizer result (dx §2.4): the core `Computed` envelope. `value` carries the weights * and the objective at the solution; `assumptions` echo which objective ran and the budget; * `diagnostics` carry `converged` / `iterations` and all warnings — a non-converged run adds an * `optimize.not_converged` warning naming the solver's stop reason instead of hoisting a bespoke * `reason` field. */ export type OptimizeResult = Computed<{ weights: number[]; objective: number; }, { objective: string; budget: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.budget: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.objective: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.objective: number; default: not declared - value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#OptionMarginLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One option leg of a position for the margin calculation. ```typescript /** One option leg of a position for the margin calculation. */ export interface OptionMarginLeg { type: 'call' | 'put'; /** Signed contracts: positive = long, negative = short. */ quantity: number; strike: number; /** Premium per share (entry mid). */ premium: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - premium: number; default: not declared — Premium per share (entry mid). - quantity: number; default: not declared — Signed contracts: positive = long, negative = short. - strike: number; default: not declared - type: 'call' | 'put'; default: not declared ### @insiderfinance/totalfinance/risk#OptionsMarginOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionsMarginOptions extends NakedMarginOptions { /** Current price of the underlying (> 0). */ spot: number; /** * Basis for UNCOVERED short puts. Default `'reg-t-naked'` — a margin account's actual * requirement. Use `'cash-secured'` for a cash/IRA account, where the whole exercise value must * be posted. Echoed in `assumptions.putMarginBasis`. */ putMarginBasis?: PutMarginBasis; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - equityRate?: number; default: not declared — Reg-T naked "equity" rate — the % of underlying (default 0.20). - floorRate?: number; default: not declared — Reg-T naked floor rate — the % of underlying (calls) / strike (puts) minimum (default 0.10). - multiplier?: number; default: not declared — Contract multiplier (default 100). - putMarginBasis?: PutMarginBasis; default: not declared — Basis for UNCOVERED short puts. Default `'reg-t-naked'` — a margin account's actual requirement. Use `'cash-secured'` for a cash/IRA account, where the whole exercise value must be posted. Echoed in `assumptions.putMarginBasis`. - spot: number; default: not declared — Current price of the underlying (> 0). ### @insiderfinance/totalfinance/risk#OptionsMarginResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionsMarginResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Initial margin / buying-power requirement, in account currency. */ initialMargin: number; /** * Buying-power reduction — what the account must set aside. Equals `initialMargin` for margin * accounts; for a long-only (fully-paid) position it is the net debit paid. */ buyingPowerReduction: number; /** * Worst-case expiration loss magnitude per contract; `null` when the loss is unbounded (e.g. a * naked call — no finite worst case exists; `Infinity` is not JSON-safe, Law 7). `definedRisk: * false` is the primary unbounded discriminant, and a `risk.unbounded_loss` warning explains the * null. */ maxLoss: number | null; /** Net debit paid (> 0) or credit received (< 0), per contract. */ netDebit: number; /** True when the position's loss is capped (spreads / condors / butterflies / long options). */ definedRisk: boolean; /** * How the requirement was derived. `'reg-t-naked-put'` is the bounded-but-uncovered case: the * loss IS capped (a put's underlying stops at 0), but the position is short naked puts, so the * requirement is the Reg-T naked-put charge on the uncovered contracts plus the capped max loss * of whatever remains — not the cash-secured exercise value. */ method: 'defined-risk-max-loss' | 'reg-t-naked' | 'reg-t-naked-put' | 'long-premium'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - buyingPowerReduction: number; default: not declared — Buying-power reduction — what the account must set aside. Equals `initialMargin` for margin accounts; for a long-only (fully-paid) position it is the net debit paid. - definedRisk: boolean; default: not declared — True when the position's loss is capped (spreads / condors / butterflies / long options). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - initialMargin: number; default: not declared — Initial margin / buying-power requirement, in account currency. - maxLoss: number | null; default: not declared — Worst-case expiration loss magnitude per contract; `null` when the loss is unbounded (e.g. a naked call — no finite worst case exists; `Infinity` is not JSON-safe, Law 7). `definedRisk: false` is the primary unbounded discriminant, and a `risk.unbounded_loss` warning explains the null. - method: 'reg-t-naked' | 'defined-risk-max-loss' | 'reg-t-naked-put' | 'long-premium'; default: not declared — How the requirement was derived. `'reg-t-naked-put'` is the bounded-but-uncovered case: the loss IS capped (a put's underlying stops at 0), but the position is short naked puts, so the requirement is the Reg-T naked-put charge on the uncovered contracts plus the capped max loss of whatever remains — not the cash-secured exercise value. - netDebit: number; default: not declared — Net debit paid (> 0) or credit received (< 0), per contract. ### @insiderfinance/totalfinance/risk#ParameterSweepResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── parameter-sweep diagnostics ───────────────────────── export interface ParameterSweepResult { trialCount: number; bestSharpe: number; meanSharpe: number; varianceSharpe: number; /** Expected maximum Sharpe under the null (the deflation benchmark `SR₀`). */ expectedMaxSharpe: number; /** Deflated Sharpe of the selected (best) configuration. */ /** `null` when the selected statistics carry no Sharpe (a zero-variance series). */ deflatedSharpe: number | null; /** Un-deflated PSR of the selected configuration; `null` with `deflatedSharpe`. */ probabilisticSharpe: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bestSharpe: number; default: not declared - deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carry no Sharpe (a zero-variance series). - expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe under the null (the deflation benchmark `SR₀`). - meanSharpe: number; default: not declared - probabilisticSharpe: number | null; default: not declared — Un-deflated PSR of the selected configuration; `null` with `deflatedSharpe`. - trialCount: number; default: not declared - varianceSharpe: number; default: not declared ### @insiderfinance/totalfinance/risk#ParametricPortfolioVaRInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ParametricPortfolioVaRInput`. ### @insiderfinance/totalfinance/risk#ParametricPortfolioVaROptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ParametricPortfolioVaROptions { confidence?: number; horizonPeriods?: number; /** Expected per-period returns per asset (for a non-zero mean). Default all zeros. */ mean?: ArrayLike; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared - horizonPeriods?: number; default: not declared - mean?: ArrayLike; default: not declared — Expected per-period returns per asset (for a non-zero mean). Default all zeros. ### @insiderfinance/totalfinance/risk#PcaComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PcaComponent { /** Variance along this principal axis (the eigenvalue). */ eigenvalue: number; /** Loadings: the unit eigenvector, length = number of assets. */ loadings: number[]; /** Fraction of total variance this component explains. */ varianceExplained: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eigenvalue: number; default: not declared — Variance along this principal axis (the eigenvalue). - loadings: number[]; default: not declared — Loadings: the unit eigenvector, length = number of assets. - varianceExplained: number; default: not declared — Fraction of total variance this component explains. ### @insiderfinance/totalfinance/risk#PcaResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PcaResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** Components sorted by descending eigenvalue. */ components: PcaComponent[]; eigenvalues: number[]; /** `loadings[k]` = the k-th component's eigenvector. */ loadings: number[][]; varianceExplained: number[]; cumulativeVariance: number[]; /** Sum of eigenvalues (= trace of the input matrix). */ totalVariance: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - components: PcaComponent[]; default: not declared — Components sorted by descending eigenvalue. - cumulativeVariance: number[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - eigenvalues: number[]; default: not declared - loadings: number[][]; default: not declared — `loadings[k]` = the k-th component's eigenvector. - totalVariance: number; default: not declared — Sum of eigenvalues (= trace of the input matrix). - varianceExplained: number[]; default: not declared ### @insiderfinance/totalfinance/risk#PnlAttribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PnlAttribution { total: number; delta: number; gamma: number; vega: number; theta: number; rho: number; /** Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). */ vanna: number; /** Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). */ vomma: number; /** Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). */ charm: number; /** Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). */ veta: number; /** Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). */ vera: number; /** Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). */ deltaRate: number; /** Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). */ thetaRate: number; /** Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). */ rhoConvexity: number; /** Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). */ thetaConvexity: number; /** First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). */ phi: number; /** Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. */ other: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - delta: number; default: not declared - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - gamma: number; default: not declared - other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - rho: number; default: not declared - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - theta: number; default: not declared - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - total: number; default: not declared - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - vega: number; default: not declared - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). ### @insiderfinance/totalfinance/risk#PnlExplain Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A realized P&L attribution: greek terms + the unexplained residual, summing exactly to `total`. ```typescript /** A realized P&L attribution: greek terms + the unexplained residual, summing exactly to `total`. */ export interface PnlExplain { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings (e.g. a dominant residual); always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; /** The actual realized P&L. */ total: number; /** Delta term: `Δ·dS`. */ delta: number; /** Gamma term: `½Γ·dS²`. */ gamma: number; /** Vega term: `Vega·dσ`. */ vega: number; /** Theta term: `Θ·dt`. */ theta: number; /** Rho term: `Rho·dr`. */ rho: number; /** Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). */ vanna: number; /** Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). */ vomma: number; /** Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). */ charm: number; /** Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). */ veta: number; /** Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). */ vera: number; /** Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). */ deltaRate: number; /** Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). */ thetaRate: number; /** Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). */ rhoConvexity: number; /** Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). */ thetaConvexity: number; /** First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). */ phi: number; /** * `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry * is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order * greek the caller did not supply, and model/data. Grows as the greek expansion breaks. */ unexplained: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - delta: number; default: not declared — Delta term: `Δ·dS`. - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - rho: number; default: not declared — Rho term: `Rho·dr`. - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - theta: number; default: not declared — Theta term: `Θ·dt`. - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - total: number; default: not declared — The actual realized P&L. - unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - vega: number; default: not declared — Vega term: `Vega·dσ`. - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#PnlMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A market snapshot for {@link explainPositionPnl}: what changes between the two states. ```typescript /** A market snapshot for {@link explainPositionPnl}: what changes between the two states. */ export interface PnlMarket { spot: number; /** Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). */ volatility?: number; riskFreeRate: number; asOf: EpochMs | string; dividendYield?: number; /** * Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number * marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move * is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's * fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on * its own precedence. This is how a leg re-marked from a current quote reports a live vega. */ legVolatilities?: readonly (number | undefined)[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - dividendYield?: number; default: not declared - legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). ### @insiderfinance/totalfinance/risk#PnlMove Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A realized market move (t0 → t1), in the raw units `taylorPnl` expects. ```typescript /** A realized market move (t0 → t1), in the raw units `taylorPnl` expects. */ export interface PnlMove { /** Absolute spot change ($). */ dSpot?: number; /** Absolute vol change (decimal; `+0.02` = +2 vol points). */ dVolatility?: number; /** * Time elapsed, in YEARS. The unit is in the name; the Greeks are per DAY (the options package's * units) and the engine converts, so a caller never scales either side by 365. */ dTimeYears?: number; /** Absolute rate change (decimal; `+0.005` = +50 bp). */ dRate?: number; /** Absolute dividend-yield change (decimal; `+0.005` = +50 bp) — drives the `ε·dq` carry term. */ dDividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dDividendYield?: number; default: not declared — Absolute dividend-yield change (decimal; `+0.005` = +50 bp) — drives the `ε·dq` carry term. - dRate?: number; default: not declared — Absolute rate change (decimal; `+0.005` = +50 bp). - dSpot?: number; default: not declared — Absolute spot change ($). - dTimeYears?: number; default: not declared — Time elapsed, in YEARS. The unit is in the name; the Greeks are per DAY (the options package's units) and the engine converts, so a caller never scales either side by 365. - dVolatility?: number; default: not declared — Absolute vol change (decimal; `+0.02` = +2 vol points). ### @insiderfinance/totalfinance/risk#PortfolioGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Greeks aggregation ───────────────────────── export interface PortfolioGreeks { /** Net mark value `Σ qty · multiplier · value`. */ value: number; /** Book totals in the one unit system: theta per calendar day, vega per vol point, rho per 1%. */ delta: number; gamma: number; vega: number; theta: number; rho: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared — Book totals in the one unit system: theta per calendar day, vega per vol point, rho per 1%. - gamma: number; default: not declared - rho: number; default: not declared - theta: number; default: not declared - value: number; default: not declared — Net mark value `Σ qty · multiplier · value`. - vega: number; default: not declared ### @insiderfinance/totalfinance/risk#PortfolioPnlExplain Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A book-level realized P&L attribution (term-wise sum), preserving each position's explain. The report wrapper (Law 2) lives at THIS level (and on each `byPosition` entry, which is itself a {@link PositionPnlExplain}); per-leg rows stay bare by design. ```typescript /** * A book-level realized P&L attribution (term-wise sum), preserving each position's explain. The * report wrapper (Law 2) lives at THIS level (and on each `byPosition` entry, which is itself a * {@link PositionPnlExplain}); per-leg rows stay bare by design. */ export interface PortfolioPnlExplain extends PnlExplain { byPosition: (PositionPnlExplain & { id?: string; })[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - byPosition: (PositionPnlExplain & { id?: string; })[]; default: not declared - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - delta: number; default: not declared — Delta term: `Δ·dS`. - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - rho: number; default: not declared — Rho term: `Rho·dr`. - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - theta: number; default: not declared — Theta term: `Θ·dt`. - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - total: number; default: not declared — The actual realized P&L. - unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - vega: number; default: not declared — Vega term: `Vega·dσ`. - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#PortfolioPnlItem Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One position in a portfolio P&L explain, with its own market context. ```typescript /** One position in a portfolio P&L explain, with its own market context. */ export interface PortfolioPnlItem { position: StrategyPosition; from: PnlMarket; to: PnlMarket; id?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: PnlMarket; default: not declared - from.asOf: string | number; default: not declared - from.dividendYield?: number; default: not declared - from.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - from.riskFreeRate: number; default: not declared - from.spot: number; default: not declared - from.volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). - id?: string; default: not declared - position: StrategyPosition; default: not declared - position.legs: readonly StrategyLeg[]; default: not declared - position.metrics: () => import('@insiderfinance/totalfinance/risk').StrategyPayoffMetrics; default: not declared - position.metrics().return.bounded: { profit: boolean; loss: boolean; }; default: not declared - position.metrics().return.bounded.loss: boolean; default: not declared - position.metrics().return.bounded.profit: boolean; default: not declared - position.metrics().return.maxLoss: number | null; default: not declared - position.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/risk').StrategyMarkToMarketResult; default: not declared - position.value().return.greeks: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared - position.value().return.perLeg: import('@insiderfinance/totalfinance/risk').StrategyLegValuation[]; default: not declared - position.value().return.pnl: number; default: not declared - position.value().return.value: number; default: not declared - position.value(overrides)?: Partial | undefined; default: not declared - position.value(overrides).asOf?: string | number; default: not declared - position.value(overrides).dividendYield?: number; default: not declared - position.value(overrides).expiry?: string; default: not declared - position.value(overrides).riskFreeRate?: number; default: not declared - position.value(overrides).spot?: number; default: not declared - position.value(overrides).volatility?: number; default: not declared - position.value(overrides).volatilityShock?: number; default: not declared - to: PnlMarket; default: not declared - to.asOf: string | number; default: not declared - to.dividendYield?: number; default: not declared - to.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatilities at this market state (Preview P1), aligned to `position.legs`: a number marks leg `i` at that volatility (through `Position.value`'s `legVolatilities`) and its vol move is attributed at the LEG level (`to − from`, each side resolving to the override, else the leg's fixed `impliedVolatility`, else the position-level `volatility`). `undefined` leaves that leg on its own precedence. This is how a leg re-marked from a current quote reports a live vega. - to.riskFreeRate: number; default: not declared - to.spot: number; default: not declared - to.volatility?: number; default: not declared — Position-level vol (drives vega attribution; a leg with its own fixed IV ignores it — see docs). ### @insiderfinance/totalfinance/risk#PortfolioVaRInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The one request for a portfolio's VaR: `method` names the model — `'parametric'` (a Gaussian on the covariance), `'monteCarlo'` (correlated normal draws on the covariance, seeded), or `'historical'` (the empirical tail of the weighted return history). No method is defaulted. ```typescript /** * The one request for a portfolio's VaR: `method` names the model — `'parametric'` (a Gaussian on * the covariance), `'monteCarlo'` (correlated normal draws on the covariance, seeded), or * `'historical'` (the empirical tail of the weighted return history). No method is defaulted. */ export type PortfolioVaRInput = (ParametricPortfolioVaRInput & { method: 'parametric'; }) | (MonteCarloPortfolioVaRInput & { method: 'monteCarlo'; }) | HistoricalPortfolioVaRInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method: 'historical'; default: not declared - options?: HistoricalPortfolioVaROptions; default: not declared - options.confidence?: number; default: not declared - options.horizonPeriods?: number; default: not declared - returns: ArrayLike>; default: not declared - weights: ArrayLike; default: not declared ### @insiderfinance/totalfinance/risk#PortfolioVaROutput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type PortfolioVaROutput = PortfolioVaRResult | MonteCarloPortfolioVaRResult | HistoricalPortfolioVaRResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - componentVaR: number[]; default: not declared — Per-asset component VaR; Σ component = total VaR (zero-mean case). - conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - confidence: number; default: not declared - cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — the one warnings channel. Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - diagnostics.warnings: QuantWarning[]; default: not declared - horizonPeriods: number; default: not declared - marginalVaR: number[]; default: not declared — Per-asset marginal VaR (∂VaR/∂w_i). - method: VaRMethod; default: not declared - observations: number; default: not declared — The number of portfolio-return observations the empirical tail was read from. - samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. The number of simulated samples actually drawn (always echoed). - seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). The PRNG seed actually used (always echoed for reproducibility). - valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#PortfolioVaRResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PortfolioVaRResult extends VaRResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty) — the one warnings channel. */ diagnostics: { warnings: QuantWarning[]; }; /** Per-asset component VaR; Σ component = total VaR (zero-mean case). */ componentVaR: number[]; /** Per-asset marginal VaR (∂VaR/∂w_i). */ marginalVaR: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - componentVaR: number[]; default: not declared — Per-asset component VaR; Σ component = total VaR (zero-mean case). - conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - confidence: number; default: not declared - cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — the one warnings channel. - diagnostics.warnings: QuantWarning[]; default: not declared - horizonPeriods: number; default: not declared - marginalVaR: number[]; default: not declared — Per-asset marginal VaR (∂VaR/∂w_i). - method: VaRMethod; default: not declared - samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. - seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). - valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#Position Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Position { id?: string; /** Number of units held (signed). Default 1. */ quantity?: number; /** * Contract multiplier applied to per-unit value and Greeks (100 for a listed US equity option * whose Greeks are per share and whose `quantity` is in contracts). Default 1. Applied by * `aggregateGreeks`, `stressTest` and the book tools; disclosed in their assumptions. */ multiplier?: number; greeks?: PositionGreeks; /** * Current mark per unit — the BASE a custom `reprice` differences against (H11). When `reprice` * is supplied, either this or `greeks.value` must be present; the base is never assumed 0. */ value?: number; data?: T; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - data?: T; default: not declared - greeks?: PositionGreeks; default: not declared - greeks.charm?: number; default: not declared — ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. - greeks.color?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.delta?: number; default: not declared — ∂V/∂S per $1 of spot. - greeks.deltaRate?: number; default: not declared — ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. - greeks.gamma?: number; default: not declared — ∂²V/∂S² per $1². - greeks.lambda?: number | null; default: not declared — Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. - greeks.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. - greeks.rho?: number; default: not declared — ∂V/∂r per 1% rate (0.01), as the options package reports it. - greeks.rhoConvexity?: number; default: not declared — ∂²V/∂r² per (1%)² — rho convexity. Optional. - greeks.speed?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.spot?: number; default: not declared — Reference spot, required to resolve percent spot shocks into price moves. - greeks.theta?: number; default: not declared — ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. - greeks.thetaConvexity?: number; default: not declared — ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. - greeks.thetaRate?: number; default: not declared — ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. - greeks.ultima?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - greeks.value: number; default: not declared — Current mark value of the position (per unit). - greeks.vanna?: number; default: not declared — ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. - greeks.vega?: number; default: not declared — ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. - greeks.vera?: number; default: not declared — ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. - greeks.veta?: number; default: not declared — ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. - greeks.vomma?: number; default: not declared — ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. - greeks.zomma?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - id?: string; default: not declared - multiplier?: number; default: not declared — Contract multiplier applied to per-unit value and Greeks (100 for a listed US equity option whose Greeks are per share and whose `quantity` is in contracts). Default 1. Applied by `aggregateGreeks`, `stressTest` and the book tools; disclosed in their assumptions. - quantity?: number; default: not declared — Number of units held (signed). Default 1. - value?: number; default: not declared — Current mark per unit — the BASE a custom `reprice` differences against (H11). When `reprice` is supplied, either this or `greeks.value` must be present; the base is never assumed 0. ### @insiderfinance/totalfinance/risk#PositionGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A position's Greeks in TotalFinance's ONE unit system — the units `@insiderfinance/totalfinance/options` and `@insiderfinance/totalfinance/strategy` report (`DEFAULT_GREEK_UNITS`), so a `blackScholesGreeks(...)` / `Position.value().greeks` object spreads straight in: `{ value, spot, ...greeks }`. Per unit of the position (per share of one contract when `Position.multiplier` scales it): - `delta` per $1 of spot, `gamma` per $1²; - `theta` per CALENDAR DAY; `vega` per 1 volatility POINT (0.01); `rho` per 1% rate (0.01); `phi` per 1% dividend yield; - the second-order Greeks in the options package's own units: `vanna` ∂Δ/∂σ and `vomma` ∂²V/∂σ² per 1.00 σ, `charm` = ∂Δ/∂T and `veta` = ∂vega/∂T per YEAR of time-to-expiry (vega per 1.00 σ), `vera` per 1.00 σ per 1.00 rate; - the rate cross terms the options package does not emit follow the first-order conventions: `deltaRate` per 1% rate, `thetaRate` per day per 1% rate, `rhoConvexity` per (1%)², `thetaConvexity` per day². The Taylor engine converts to the raw per-year / per-1.00 form internally, in one place. Third-order Greeks (`speed`, `color`, `zomma`, `ultima`) and `lambda` are accepted so a whole `ExtendedGreeks` can be passed, and are not used by the second-order expansion. ```typescript /** * A position's Greeks in TotalFinance's ONE unit system — the units `@insiderfinance/totalfinance/options` and * `@insiderfinance/totalfinance/strategy` report (`DEFAULT_GREEK_UNITS`), so a `blackScholesGreeks(...)` / * `Position.value().greeks` object spreads straight in: `{ value, spot, ...greeks }`. * * Per unit of the position (per share of one contract when `Position.multiplier` scales it): * - `delta` per $1 of spot, `gamma` per $1²; * - `theta` per CALENDAR DAY; `vega` per 1 volatility POINT (0.01); `rho` per 1% rate (0.01); * `phi` per 1% dividend yield; * - the second-order Greeks in the options package's own units: `vanna` ∂Δ/∂σ and `vomma` ∂²V/∂σ² * per 1.00 σ, `charm` = ∂Δ/∂T and `veta` = ∂vega/∂T per YEAR of time-to-expiry (vega per 1.00 σ), * `vera` per 1.00 σ per 1.00 rate; * - the rate cross terms the options package does not emit follow the first-order conventions: * `deltaRate` per 1% rate, `thetaRate` per day per 1% rate, `rhoConvexity` per (1%)², * `thetaConvexity` per day². * The Taylor engine converts to the raw per-year / per-1.00 form internally, in one place. Third-order * Greeks (`speed`, `color`, `zomma`, `ultima`) and `lambda` are accepted so a whole `ExtendedGreeks` * can be passed, and are not used by the second-order expansion. */ export interface PositionGreeks { /** Current mark value of the position (per unit). */ value: number; /** Reference spot, required to resolve percent spot shocks into price moves. */ spot?: number; /** ∂V/∂S per $1 of spot. */ delta?: number; /** ∂²V/∂S² per $1². */ gamma?: number; /** ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. */ vega?: number; /** ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. */ theta?: number; /** ∂V/∂r per 1% rate (0.01), as the options package reports it. */ rho?: number; /** ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. */ vanna?: number; /** ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. */ vomma?: number; /** ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. */ charm?: number; /** ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. */ veta?: number; /** ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. */ vera?: number; /** ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. */ deltaRate?: number; /** ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. */ thetaRate?: number; /** ∂²V/∂r² per (1%)² — rho convexity. Optional. */ rhoConvexity?: number; /** ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. */ thetaConvexity?: number; /** φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. */ phi?: number; /** Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. */ speed?: number; /** Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. */ color?: number; /** Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. */ zomma?: number; /** Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. */ ultima?: number; /** Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. */ lambda?: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm?: number; default: not declared — ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. - color?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - delta?: number; default: not declared — ∂V/∂S per $1 of spot. - deltaRate?: number; default: not declared — ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. - gamma?: number; default: not declared — ∂²V/∂S² per $1². - lambda?: number | null; default: not declared — Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. - phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. - rho?: number; default: not declared — ∂V/∂r per 1% rate (0.01), as the options package reports it. - rhoConvexity?: number; default: not declared — ∂²V/∂r² per (1%)² — rho convexity. Optional. - speed?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - spot?: number; default: not declared — Reference spot, required to resolve percent spot shocks into price moves. - theta?: number; default: not declared — ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. - thetaConvexity?: number; default: not declared — ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. - thetaRate?: number; default: not declared — ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. - ultima?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - value: number; default: not declared — Current mark value of the position (per unit). - vanna?: number; default: not declared — ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. - vega?: number; default: not declared — ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. - vera?: number; default: not declared — ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. - veta?: number; default: not declared — ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. - vomma?: number; default: not declared — ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. - zomma?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. ### @insiderfinance/totalfinance/risk#PositionPnlExplain Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A position's realized P&L attribution, aggregate + per leg. ```typescript /** A position's realized P&L attribution, aggregate + per leg. */ export interface PositionPnlExplain extends PnlExplain { perLeg: LegPnlExplain[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - delta: number; default: not declared — Delta term: `Δ·dS`. - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - perLeg: LegPnlExplain[]; default: not declared - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - rho: number; default: not declared — Rho term: `Rho·dr`. - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - theta: number; default: not declared — Theta term: `Θ·dt`. - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - total: number; default: not declared — The actual realized P&L. - unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - vega: number; default: not declared — Vega term: `Vega·dσ`. - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#PositionRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-position risk row. ```typescript /** Per-position risk row. */ export interface PositionRisk { id: string; underlying: string; /** Net unrealized P&L of the position ($) — `Position.value()` (P&L since entry), not liquidation NAV. */ value: number; greeks: BookGreeks; /** Initial (buying-power) margin for this position. */ margin: number; definedRisk: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - definedRisk: boolean; default: not declared - greeks: BookGreeks; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.rho: number; default: not declared - greeks.theta: number; default: not declared - greeks.vega: number; default: not declared - id: string; default: not declared - margin: number; default: not declared — Initial (buying-power) margin for this position. - underlying: string; default: not declared - value: number; default: not declared — Net unrealized P&L of the position ($) — `Position.value()` (P&L since entry), not liquidation NAV. ### @insiderfinance/totalfinance/risk#PositionScenarioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PositionScenarioResult { id: string; quantity: number; pnl: number; attribution: PnlAttribution; /** How this position was revalued under the scenario (H11 disclosure). */ valuationMethod: 'greeks-taylor' | 'reprice'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - attribution: PnlAttribution; default: not declared - attribution.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - attribution.delta: number; default: not declared - attribution.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - attribution.gamma: number; default: not declared - attribution.other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - attribution.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - attribution.rho: number; default: not declared - attribution.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - attribution.theta: number; default: not declared - attribution.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - attribution.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - attribution.total: number; default: not declared - attribution.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - attribution.vega: number; default: not declared - attribution.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - attribution.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - attribution.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). - id: string; default: not declared - pnl: number; default: not declared - quantity: number; default: not declared - valuationMethod: 'greeks-taylor' | 'reprice'; default: not declared — How this position was revalued under the scenario (H11 disclosure). ### @insiderfinance/totalfinance/risk#ProbabilisticSharpeResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link probabilisticSharpeRatio}'s envelope: the probability plus the applied benchmark. ```typescript /** {@link probabilisticSharpeRatio}'s envelope: the probability plus the applied benchmark. */ export type ProbabilisticSharpeResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ benchmarkSharpe: number; observations: number; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.benchmarkSharpe: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.observations: number; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/risk#PurgedKFoldOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PurgedKFoldOptions { /** Number of folds (≥ 2). */ folds: number; /** Fraction of `n` to embargo after each test fold (default 0). */ embargo?: number; /** Observations to purge on each side of a test fold (label-overlap buffer; default 0). */ purgeGap?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embargo?: number; default: not declared — Fraction of `n` to embargo after each test fold (default 0). - folds: number; default: not declared — Number of folds (≥ 2). - purgeGap?: number; default: not declared — Observations to purge on each side of a test fold (label-overlap buffer; default 0). ### @insiderfinance/totalfinance/risk#ResearchProtocolInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link researchProtocol}. ```typescript /** Inputs for {@link researchProtocol}. */ export interface ResearchProtocolInput { /** The selected strategy's in-sample return series (per period). */ returns: ArrayLike; /** * The pool that produced the selection, for deflation. Omit for a single pre-registered hypothesis * (no selection → SR₀ = 0). `trialSharpes` are the per-observation Sharpes of every config tried. */ trials?: { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }; /** Out-of-sample (e.g. walk-forward) returns of the SAME strategy — confirmatory. */ outOfSampleReturns?: ArrayLike; /** Confidence for "significant" in (0, 1); default 0.95. */ confidence?: number; /** Periods per year for the annualized read-outs; default 252. */ periodsPerYear?: number; riskFreeRate?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared — Confidence for "significant" in (0, 1); default 0.95. - outOfSampleReturns?: ArrayLike; default: not declared — Out-of-sample (e.g. walk-forward) returns of the SAME strategy — confirmatory. - periodsPerYear?: number; default: not declared — Periods per year for the annualized read-outs; default 252. - returns: ArrayLike; default: not declared — The selected strategy's in-sample return series (per period). - riskFreeRate?: number; default: not declared - trials?: { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }; default: not declared — The pool that produced the selection, for deflation. Omit for a single pre-registered hypothesis (no selection → SR₀ = 0). `trialSharpes` are the per-observation Sharpes of every config tried. - trials.trialCount: number; default: not declared - trials.trialSharpes: ArrayLike; default: not declared - trials.varianceSharpe: number; default: not declared ### @insiderfinance/totalfinance/risk#ResearchVerdict Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The research verdict. ```typescript /** The research verdict. */ export interface ResearchVerdict { verdict: 'significant' | 'inconclusive' | 'likely-overfit'; /** Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. */ inSample: { sharpe: number | null; annualizedSharpe: number | null; observations: number; }; /** Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. */ deflatedSharpe: number | null; /** Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. */ probabilisticSharpe: number | null; /** SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). */ expectedMaxSharpe: number; trialCount: number; /** Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). */ minTrackRecordLength: number; /** Present when out-of-sample returns are given; `null` figures when either series has zero variance. */ outOfSample?: { sharpe: number | null; annualizedSharpe: number | null; degradation: number | null; }; /** Prose an agent relays. */ rationale: string; assumptions: { conventionsVersion: string; confidence: number; periodsPerYear: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - assumptions.confidence: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.periodsPerYear: number; default: not declared - deflatedSharpe: number | null; default: not declared — Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - expectedMaxSharpe: number; default: not declared — SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). - inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. - inSample.annualizedSharpe: number | null; default: not declared - inSample.observations: number; default: not declared - inSample.sharpe: number | null; default: not declared - minTrackRecordLength: number; default: not declared — Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). - outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared — Present when out-of-sample returns are given; `null` figures when either series has zero variance. - outOfSample.annualizedSharpe: number | null; default: not declared - outOfSample.degradation: number | null; default: not declared - outOfSample.sharpe: number | null; default: not declared - probabilisticSharpe: number | null; default: not declared — Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. - rationale: string; default: not declared — Prose an agent relays. - trialCount: number; default: not declared - verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared ### @insiderfinance/totalfinance/risk#ResolvedGridShock Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One resolved axis entry of a {@link ScenarioGridResult} (H12). ```typescript /** One resolved axis entry of a {@link ScenarioGridResult} (H12). */ export interface ResolvedGridShock { factor: 'spot' | 'volatility'; kind: ShockKind; value: number; /** The resolved ABSOLUTE move applied (percent spot shocks scaled by `greeks.spot`). */ resolvedMove: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor: 'spot' | 'volatility'; default: not declared - kind: ShockKind; default: not declared - resolvedMove: number; default: not declared — The resolved ABSOLUTE move applied (percent spot shocks scaled by `greeks.spot`). - value: number; default: not declared ### @insiderfinance/totalfinance/risk#RiskContributionRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One asset's row in a {@link RiskContributionsResult} (H10). ```typescript /** One asset's row in a {@link RiskContributionsResult} (H10). */ export interface RiskContributionRow { asset: number; /** ∂σ_p/∂w_i; `null` when σ_p = 0 (the derivative is undefined), with a degenerate-input warning. */ marginal: number | null; /** `w_i · marginal`; Σ component = σ_p. `null` under the same degenerate case. */ component: number | null; /** `component / σ_p`; Σ fraction = 1 (renamed from `percent`). `null` under the same case. */ fraction: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asset: number; default: not declared - component: number | null; default: not declared — `w_i · marginal`; Σ component = σ_p. `null` under the same degenerate case. - fraction: number | null; default: not declared — `component / σ_p`; Σ fraction = 1 (renamed from `percent`). `null` under the same case. - marginal: number | null; default: not declared — ∂σ_p/∂w_i; `null` when σ_p = 0 (the derivative is undefined), with a degenerate-input warning. ### @insiderfinance/totalfinance/risk#RiskContributionsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The H10 report: portfolio volatility + rows + the Law 2 envelope. ```typescript /** The H10 report: portfolio volatility + rows + the Law 2 envelope. */ export interface RiskContributionsResult { assumptions: { conventionsVersion: string; assets: number; }; diagnostics: { warnings: QuantWarning[]; }; portfolioVolatility: number; contributions: RiskContributionRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { assets: number; conventionsVersion: string; }; default: not declared - assumptions.assets: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - contributions: RiskContributionRow[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - portfolioVolatility: number; default: not declared ### @insiderfinance/totalfinance/risk#Scenario Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Scenario { name: string; shocks: Shock[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - shocks: Shock[]; default: not declared ### @insiderfinance/totalfinance/risk#ScenarioGridResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The H12 report: both axes with resolved shock semantics + the P&L cells + the Law 2 envelope. ```typescript /** The H12 report: both axes with resolved shock semantics + the P&L cells + the Law 2 envelope. */ export interface ScenarioGridResult { assumptions: { conventionsVersion: string; greekUnits: typeof GREEK_UNITS; }; diagnostics: { warnings: QuantWarning[]; }; spotAxis: ResolvedGridShock[]; volatilityAxis: ResolvedGridShock[]; /** `pnl[i][j]` = P&L per unit at `spotAxis[i]` × `volatilityAxis[j]`. */ pnl: number[][]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; greekUnits: typeof GREEK_UNITS; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.greekUnits: { readonly phi: 'per1Percent'; readonly rho: import('@insiderfinance/totalfinance/core').RhoUnit; readonly theta: import('@insiderfinance/totalfinance/core').ThetaUnit; readonly vega: import('@insiderfinance/totalfinance/core').VegaUnit; }; default: not declared - assumptions.greekUnits.phi: 'per1Percent'; default: not declared - assumptions.greekUnits.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.greekUnits.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.greekUnits.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - pnl: number[][]; default: not declared — `pnl[i][j]` = P&L per unit at `spotAxis[i]` × `volatilityAxis[j]`. - spotAxis: ResolvedGridShock[]; default: not declared - volatilityAxis: ResolvedGridShock[]; default: not declared ### @insiderfinance/totalfinance/risk#ScenarioResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioResult { scenario: string; /** Book P&L summed over positions. */ pnl: number; byPosition: PositionScenarioResult[]; /** Book-level P&L-explain (sum of position explains). */ attribution: PnlAttribution; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - attribution: PnlAttribution; default: not declared — Book-level P&L-explain (sum of position explains). - attribution.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - attribution.delta: number; default: not declared - attribution.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - attribution.gamma: number; default: not declared - attribution.other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - attribution.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - attribution.rho: number; default: not declared - attribution.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - attribution.theta: number; default: not declared - attribution.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - attribution.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - attribution.total: number; default: not declared - attribution.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - attribution.vega: number; default: not declared - attribution.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - attribution.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - attribution.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). - byPosition: PositionScenarioResult[]; default: not declared - pnl: number; default: not declared — Book P&L summed over positions. - scenario: string; default: not declared ### @insiderfinance/totalfinance/risk#SegmentEffect Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The allocation / selection / interaction effects for one segment. ```typescript /** The allocation / selection / interaction effects for one segment. */ export interface SegmentEffect { name: string; allocation: number; selection: number; interaction: number; /** `allocation + selection + interaction`. */ total: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - allocation: number; default: not declared - interaction: number; default: not declared - name: string; default: not declared - selection: number; default: not declared - total: number; default: not declared — `allocation + selection + interaction`. ### @insiderfinance/totalfinance/risk#SharpeStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sample statistics of a return series needed for Sharpe inference. All in per-observation units. ```typescript // ───────────────────────── Sharpe inference ───────────────────────── /** Sample statistics of a return series needed for Sharpe inference. All in per-observation units. */ export interface SharpeStatistics { /** * Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the * returns have zero variance: there is no dispersion to scale by, and the report says so. */ sharpe: number | null; /** Number of observations. */ observations: number; /** Skewness `γ₃` of the returns. */ skewness: number; /** Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). */ kurtosis: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - observations: number; default: not declared — Number of observations. - sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - skewness: number; default: not declared — Skewness `γ₃` of the returns. ### @insiderfinance/totalfinance/risk#SharpeStatisticsReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link sharpeStatistics}'s report: the stats plus the applied conventions (Law 2 report grammar). ```typescript /** {@link sharpeStatistics}'s report: the stats plus the applied conventions (Law 2 report grammar). */ export interface SharpeStatisticsReport extends SharpeStatistics { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - observations: number; default: not declared — Number of observations. - sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - skewness: number; default: not declared — Skewness `γ₃` of the returns. ### @insiderfinance/totalfinance/risk#Shock Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Shock { factor: ShockFactor; kind: ShockKind; value: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor: string; default: not declared - kind: ShockKind; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/risk#ShockFactor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ShockFactor = 'spot' | 'volatility' | 'riskFreeRate' | 'time' | 'dividend' | string; ``` ### @insiderfinance/totalfinance/risk#ShockKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ShockKind = 'percent' | 'absolute'; ``` ### @insiderfinance/totalfinance/risk#ShrunkKelly Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The estimation-error-shrunk Kelly book. ```typescript /** The estimation-error-shrunk Kelly book. */ export interface ShrunkKelly { /** Estimation-error shrinkage factor `c* ∈ [0, 1]`. */ shrinkage: number; /** The applied scaling `fraction · c*`. */ appliedScaling: number; /** Shrunk Kelly weights `fraction · c* · Σ̂⁻¹μ̂`. */ weights: number[]; /** Naive plug-in Kelly weights `Σ̂⁻¹μ̂` (before any shrinkage). */ naiveWeights: number[]; /** In-sample squared Sharpe `θ̂² = μ̂ᵀΣ̂⁻¹μ̂` (biased high). */ inSampleSharpeSquared: number; /** Bias-corrected out-of-sample squared Sharpe `θ̂² − n/T` (may be ≤ 0). */ correctedSharpeSquared: number; /** Expected out-of-sample log-growth at the applied scaling. */ expectedGrowth: number; /** Expected out-of-sample log-growth of the naive (unshrunk) book — often negative. */ naiveExpectedGrowth: number; assumptions: { conventionsVersion: string; assets: number; sampleSize: number; fraction: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - appliedScaling: number; default: not declared — The applied scaling `fraction · c*`. - assumptions: { assets: number; conventionsVersion: string; fraction: number; sampleSize: number; }; default: not declared - assumptions.assets: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.fraction: number; default: not declared - assumptions.sampleSize: number; default: not declared - correctedSharpeSquared: number; default: not declared — Bias-corrected out-of-sample squared Sharpe `θ̂² − n/T` (may be ≤ 0). - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - expectedGrowth: number; default: not declared — Expected out-of-sample log-growth at the applied scaling. - inSampleSharpeSquared: number; default: not declared — In-sample squared Sharpe `θ̂² = μ̂ᵀΣ̂⁻¹μ̂` (biased high). - naiveExpectedGrowth: number; default: not declared — Expected out-of-sample log-growth of the naive (unshrunk) book — often negative. - naiveWeights: number[]; default: not declared — Naive plug-in Kelly weights `Σ̂⁻¹μ̂` (before any shrinkage). - shrinkage: number; default: not declared — Estimation-error shrinkage factor `c* ∈ [0, 1]`. - weights: number[]; default: not declared — Shrunk Kelly weights `fraction · c* · Σ̂⁻¹μ̂`. ### @insiderfinance/totalfinance/risk#ShrunkKellyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link shrunkKelly}. ```typescript // ─────────────────────────────────────────────────────────────────────────────────────────────── // Estimation-error-shrunk portfolio Kelly // ─────────────────────────────────────────────────────────────────────────────────────────────── /** Input for {@link shrunkKelly}. */ export interface ShrunkKellyInput { /** Estimated per-period expected (excess) returns μ̂, one per asset. */ mean: number[]; /** Estimated covariance Σ̂ (n×n, symmetric positive-definite). */ covariance: number[][]; /** Number of observations T the estimates came from. Must be > 0. */ sampleSize: number; /** Extra fractional-Kelly multiplier applied on top of the estimation shrinkage (e.g. 0.5). Default 1. */ fraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - covariance: number[][]; default: not declared — Estimated covariance Σ̂ (n×n, symmetric positive-definite). - fraction?: number; default: not declared — Extra fractional-Kelly multiplier applied on top of the estimation shrinkage (e.g. 0.5). Default 1. - mean: number[]; default: not declared — Estimated per-period expected (excess) returns μ̂, one per asset. - sampleSize: number; default: not declared — Number of observations T the estimates came from. Must be > 0. ### @insiderfinance/totalfinance/risk#SpectralRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Spectral risk read-out. ```typescript // ─────────────────────────────── Spectral risk ─────────────────────────────── /** Spectral risk read-out. */ export interface SpectralRisk { /** The spectral risk measure — a positive loss magnitude. */ value: number; spectrum: 'exponential' | 'expected-shortfall'; /** Risk-aversion `k` for the exponential spectrum. */ riskAversion?: number; /** Level `α` for the Expected-Shortfall spectrum. */ alpha?: number; assumptions: { conventionsVersion: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha?: number; default: not declared — Level `α` for the Expected-Shortfall spectrum. - assumptions: { conventionsVersion: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - riskAversion?: number; default: not declared — Risk-aversion `k` for the exponential spectrum. - spectrum: 'exponential' | 'expected-shortfall'; default: not declared - value: number; default: not declared — The spectral risk measure — a positive loss magnitude. ### @insiderfinance/totalfinance/risk#Split Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A train/test split as sorted index arrays into a length-`n` sample. ```typescript // ───────────────────────── cross-validation splitters ───────────────────────── /** A train/test split as sorted index arrays into a length-`n` sample. */ export interface Split { train: number[]; test: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - test: number[]; default: not declared - train: number[]; default: not declared ### @insiderfinance/totalfinance/risk#StrategyLeg Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The subset of a strategy `Leg` that risk reads (mirrors `@insiderfinance/totalfinance/strategy`'s `Leg` union). ```typescript /** The subset of a strategy `Leg` that risk reads (mirrors `@insiderfinance/totalfinance/strategy`'s `Leg` union). */ export type StrategyLeg = StrategyStockLeg | StrategyOptionLeg; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: (string) | (undefined); default: not declared - impliedVolatility?: (number) | (undefined); default: not declared - kind: ('call' | 'put') | ('stock'); default: not declared - premium?: (number) | (undefined); default: not declared - price?: (number) | (undefined); default: not declared - quantity: number; default: not declared - strike?: (number) | (undefined); default: not declared ### @insiderfinance/totalfinance/risk#StrategyLegKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A leg's instrument kind (mirrors strategy's `LegKind`). ```typescript /** A leg's instrument kind (mirrors strategy's `LegKind`). */ export type StrategyLegKind = 'call' | 'put' | 'stock'; ``` ### @insiderfinance/totalfinance/risk#StrategyLegValuation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One leg's valuation from `Position.value()` (mirrors `LegValuation`). ```typescript /** One leg's valuation from `Position.value()` (mirrors `LegValuation`). */ export interface StrategyLegValuation { leg: StrategyLeg; value: number; pnl: number; greeks: ExtendedGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - leg: StrategyLeg; default: not declared - leg.expiry?: (string) | (undefined); default: not declared - leg.impliedVolatility?: (number) | (undefined); default: not declared - leg.kind: ('call' | 'put') | ('stock'); default: not declared - leg.premium?: (number) | (undefined); default: not declared - leg.price?: (number) | (undefined); default: not declared - leg.quantity: number; default: not declared - leg.strike?: (number) | (undefined); default: not declared - pnl: number; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/risk#StrategyMarkToMarketMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The mark-to-market market a strategy `Position.value()` accepts (mirrors `MarkToMarketInput`). ```typescript /** The mark-to-market market a strategy `Position.value()` accepts (mirrors `MarkToMarketInput`). */ export interface StrategyMarkToMarketMarket { spot: number; asOf: EpochMs | string; expiry: string; volatility?: number; riskFreeRate: number; dividendYield?: number; volatilityShock?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - dividendYield?: number; default: not declared - expiry: string; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility?: number; default: not declared - volatilityShock?: number; default: not declared ### @insiderfinance/totalfinance/risk#StrategyMarkToMarketResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The mark-to-market result risk reads from `Position.value()` (mirrors `MarkToMarketResult`). ```typescript /** The mark-to-market result risk reads from `Position.value()` (mirrors `MarkToMarketResult`). */ export interface StrategyMarkToMarketResult { value: number; pnl: number; perLeg: StrategyLegValuation[]; greeks: ExtendedGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: ExtendedGreeks; default: not declared - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - perLeg: StrategyLegValuation[]; default: not declared - pnl: number; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/risk#StrategyOptionLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An option row of a strategy position (mirrors strategy's `OptionLeg`). ```typescript /** An option row of a strategy position (mirrors strategy's `OptionLeg`). */ export interface StrategyOptionLeg { kind: 'call' | 'put'; price?: undefined; strike: number; premium: number; quantity: number; expiry?: string; impliedVolatility?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared - impliedVolatility?: number; default: not declared - kind: 'call' | 'put'; default: not declared - premium: number; default: not declared - price?: undefined; default: not declared - quantity: number; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/risk#StrategyPayoffMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The subset of `PayoffMetrics` risk reads from `Position.metrics()` (`null` = unbounded loss). ```typescript /** The subset of `PayoffMetrics` risk reads from `Position.metrics()` (`null` = unbounded loss). */ export interface StrategyPayoffMetrics { maxLoss: number | null; bounded: { profit: boolean; loss: boolean; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounded: { loss: boolean; profit: boolean; }; default: not declared - bounded.loss: boolean; default: not declared - bounded.profit: boolean; default: not declared - maxLoss: number | null; default: not declared ### @insiderfinance/totalfinance/risk#StrategyPosition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The structural surface of a strategy `Position` that risk depends on: signed legs, a `value()` mark-to-market that merges over the position's remembered market, and a single-expiry `metrics()` payoff. A real `Position` (from `strategy(...)` or a named builder) satisfies this without a cast. ```typescript /** * The structural surface of a strategy `Position` that risk depends on: signed legs, a `value()` * mark-to-market that merges over the position's remembered market, and a single-expiry `metrics()` * payoff. A real `Position` (from `strategy(...)` or a named builder) satisfies this without a cast. */ export interface StrategyPosition { readonly legs: readonly StrategyLeg[]; value(overrides?: Partial): StrategyMarkToMarketResult; metrics(): StrategyPayoffMetrics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - legs: readonly StrategyLeg[]; default: not declared - metrics: () => StrategyPayoffMetrics; default: not declared - metrics().return.bounded: { loss: boolean; profit: boolean; }; default: not declared - metrics().return.bounded.loss: boolean; default: not declared - metrics().return.bounded.profit: boolean; default: not declared - metrics().return.maxLoss: number | null; default: not declared - value: (overrides?: Partial) => StrategyMarkToMarketResult; default: not declared - value().return.greeks: ExtendedGreeks; default: not declared - value().return.perLeg: StrategyLegValuation[]; default: not declared - value().return.pnl: number; default: not declared - value().return.value: number; default: not declared - value(overrides)?: Partial | undefined; default: not declared - value(overrides).asOf?: string | number; default: not declared - value(overrides).dividendYield?: number; default: not declared - value(overrides).expiry?: string; default: not declared - value(overrides).riskFreeRate?: number; default: not declared - value(overrides).spot?: number; default: not declared - value(overrides).volatility?: number; default: not declared - value(overrides).volatilityShock?: number; default: not declared ### @insiderfinance/totalfinance/risk#StrategyStockLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A stock row of a strategy position (mirrors strategy's `StockLeg`): signed shares at a price. ```typescript /** A stock row of a strategy position (mirrors strategy's `StockLeg`): signed shares at a price. */ export interface StrategyStockLeg { kind: 'stock'; price: number; quantity: number; strike?: undefined; premium?: undefined; expiry?: undefined; impliedVolatility?: undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: undefined; default: not declared - impliedVolatility?: undefined; default: not declared - kind: 'stock'; default: not declared - premium?: undefined; default: not declared - price: number; default: not declared - quantity: number; default: not declared - strike?: undefined; default: not declared ### @insiderfinance/totalfinance/risk#StressOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StressOptions { /** Custom revaluation: return the position's **new value per unit** under the scenario. Falls back * to the Greeks-Taylor expansion when omitted. */ reprice?: (position: Position, scenario: Scenario) => number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - reprice?: (position: Position, scenario: Scenario) => number; default: not declared — Custom revaluation: return the position's **new value per unit** under the scenario. Falls back to the Greeks-Taylor expansion when omitted. - reprice(position): Position; default: not declared - reprice(position).data?: T; default: not declared - reprice(position).greeks?: PositionGreeks; default: not declared - reprice(position).id?: string; default: not declared - reprice(position).multiplier?: number; default: not declared — Contract multiplier applied to per-unit value and Greeks (100 for a listed US equity option whose Greeks are per share and whose `quantity` is in contracts). Default 1. Applied by `aggregateGreeks`, `stressTest` and the book tools; disclosed in their assumptions. - reprice(position).quantity?: number; default: not declared — Number of units held (signed). Default 1. - reprice(position).value?: number; default: not declared — Current mark per unit — the BASE a custom `reprice` differences against (H11). When `reprice` is supplied, either this or `greeks.value` must be present; the base is never assumed 0. - reprice(scenario): Scenario; default: not declared - reprice(scenario).name: string; default: not declared - reprice(scenario).shocks: Shock[]; default: not declared ### @insiderfinance/totalfinance/risk#StressTestResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The H11 report: scenarios + the Law 2 envelope with the book-level valuation summary. ```typescript /** The H11 report: scenarios + the Law 2 envelope with the book-level valuation summary. */ export interface StressTestResult { assumptions: { conventionsVersion: string; scenarios: number; positions: number; /** Book-level valuation summary: 'greeks-taylor' | 'reprice' | 'mixed'. */ valuation: string; }; diagnostics: { warnings: QuantWarning[]; }; scenarios: ScenarioResult[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; positions: number; scenarios: number; valuation: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.positions: number; default: not declared - assumptions.scenarios: number; default: not declared - assumptions.valuation: string; default: not declared — Book-level valuation summary: 'greeks-taylor' | 'reprice' | 'mixed'. - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - scenarios: ScenarioResult[]; default: not declared ### @insiderfinance/totalfinance/risk#SuppliedExpectedReturnsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SuppliedExpectedReturnsInput { method: 'supplied'; /** Caller-supplied expected returns, one per asset. */ expectedReturns: number[]; /** Whether the supplied values are annual (`true`) or per-period (`false`). Required. */ annualized: boolean; /** Optional asset labels aligned to `expectedReturns`; echoed on the result. */ assetIds?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualized: boolean; default: not declared — Whether the supplied values are annual (`true`) or per-period (`false`). Required. - assetIds?: string[]; default: not declared — Optional asset labels aligned to `expectedReturns`; echoed on the result. - expectedReturns: number[]; default: not declared — Caller-supplied expected returns, one per asset. - method: 'supplied'; default: not declared ### @insiderfinance/totalfinance/risk#SurvivorshipContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SurvivorshipContext { /** Whether delisted / inactive instruments are included in the backtest universe. */ includesDelisted?: boolean; /** Whether the universe is point-in-time (members as they were on each date). */ pointInTimeUniverse?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - includesDelisted?: boolean; default: not declared — Whether delisted / inactive instruments are included in the backtest universe. - pointInTimeUniverse?: boolean; default: not declared — Whether the universe is point-in-time (members as they were on each date). ### @insiderfinance/totalfinance/risk#TaylorPnlResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link taylorPnl}'s report: the attribution inline plus the applied conventions (Law 2). ```typescript /** {@link taylorPnl}'s report: the attribution inline plus the applied conventions (Law 2). */ export interface TaylorPnlResult extends PnlAttribution { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - delta: number; default: not declared - deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - gamma: number; default: not declared - other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - rho: number; default: not declared - rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - theta: number; default: not declared - thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - total: number; default: not declared - vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - vega: number; default: not declared - vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). ### @insiderfinance/totalfinance/risk#TurnoverConstraint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A turnover budget relative to a base (current) portfolio: `Σ|w − previousWeights| ≤ max`. ```typescript /** A turnover budget relative to a base (current) portfolio: `Σ|w − previousWeights| ≤ max`. */ export interface TurnoverConstraint { /** Current weights to measure turnover against. */ previousWeights: number[]; /** Maximum one-way + reverse (L1) turnover allowed. */ max: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk#UnderlyingRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-underlying risk row (positions grouped by `underlying`). ```typescript /** Per-underlying risk row (positions grouped by `underlying`). */ export interface UnderlyingRisk { underlying: string; /** Net unrealized P&L for this name ($) — sum of its positions' `Position.value()`. */ value: number; greeks: BookGreeks; margin: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: BookGreeks; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.rho: number; default: not declared - greeks.theta: number; default: not declared - greeks.vega: number; default: not declared - margin: number; default: not declared - underlying: string; default: not declared - value: number; default: not declared — Net unrealized P&L for this name ($) — sum of its positions' `Position.value()`. ### @insiderfinance/totalfinance/risk#UnderlyingRiskFactor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One underlying's risk-factor parameters. ```typescript /** One underlying's risk-factor parameters. */ export interface UnderlyingRiskFactor { /** Annualized spot RETURN volatility (e.g. `0.30` = 30%/yr). Required, ≥ 0. */ spotReturnVolatility: number; /** Annualized stdev of IV changes (vol points per √year) → vega VaR. Default 0 (no vol risk). */ volatilityOfVolatility?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - spotReturnVolatility: number; default: not declared — Annualized spot RETURN volatility (e.g. `0.30` = 30%/yr). Required, ≥ 0. - volatilityOfVolatility?: number; default: not declared — Annualized stdev of IV changes (vol points per √year) → vega VaR. Default 0 (no vol risk). ### @insiderfinance/totalfinance/risk#VaRMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type VaRMethod = 'parametric' | 'historical' | 'monteCarlo'; ``` ### @insiderfinance/totalfinance/risk#VaROptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VaROptions { /** Confidence level in (0, 1). Default 0.95. */ confidence?: number; /** * Estimation method. Default `'historical'`. * - `'historical'` — the empirical (hyndman-fan-7) tail quantile of the sample; * - `'parametric'` — the Gaussian quantile of the fitted (μ, σ), optionally Cornish-Fisher; * - `'monteCarlo'` — draws from the **fitted NORMAL** and takes its empirical tail. It captures * no non-normality whatsoever (same two moments as `'parametric'`, plus sampling noise), so * prefer `'parametric'` unless you specifically want sampling diagnostics; use * `'historical'` or the EVT tools when the shape of the tail matters. */ method?: VaRMethod; /** Holding-period horizonPeriods in periods; scales by √-time. Default 1. */ horizonPeriods?: number; /** * Parametric only: Cornish-Fisher adjustment for skew/excess-kurtosis. Default false. Applied * only where the expansion is a monotone quantile map; outside that domain the plain Gaussian * quantile is reported with a `risk.cornish_fisher_out_of_domain` warning and * `cornishFisher: false`. Over a multi-period `horizonPeriods` the moments are rescaled to the * horizon under iid aggregation (`skew/√h`, `excessKurtosis/h`), disclosed as * `assumptions.momentScaling: 'iid'`. On a non-parametric method it is ignored with an info * warning, never silently. */ cornishFisher?: boolean; /** Monte-Carlo only: number of simulated paths. Default 10000. */ samples?: number; /** Monte-Carlo only: PRNG seed for reproducibility. Default 1. */ seed?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence?: number; default: not declared — Confidence level in (0, 1). Default 0.95. - cornishFisher?: boolean; default: not declared — Parametric only: Cornish-Fisher adjustment for skew/excess-kurtosis. Default false. Applied only where the expansion is a monotone quantile map; outside that domain the plain Gaussian quantile is reported with a `risk.cornish_fisher_out_of_domain` warning and `cornishFisher: false`. Over a multi-period `horizonPeriods` the moments are rescaled to the horizon under iid aggregation (`skew/√h`, `excessKurtosis/h`), disclosed as `assumptions.momentScaling: 'iid'`. On a non-parametric method it is ignored with an info warning, never silently. - horizonPeriods?: number; default: not declared — Holding-period horizonPeriods in periods; scales by √-time. Default 1. - method?: VaRMethod; default: not declared — Estimation method. Default `'historical'`. - `'historical'` — the empirical (hyndman-fan-7) tail quantile of the sample; - `'parametric'` — the Gaussian quantile of the fitted (μ, σ), optionally Cornish-Fisher; - `'monteCarlo'` — draws from the **fitted NORMAL** and takes its empirical tail. It captures no non-normality whatsoever (same two moments as `'parametric'`, plus sampling noise), so prefer `'parametric'` unless you specifically want sampling diagnostics; use `'historical'` or the EVT tools when the shape of the tail matters. - samples?: number; default: not declared — Monte-Carlo only: number of simulated paths. Default 10000. - seed?: number; default: not declared — Monte-Carlo only: PRNG seed for reproducibility. Default 1. ### @insiderfinance/totalfinance/risk#VaRResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VaRResult { /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; [k: string]: unknown; }; /** * Structured warnings; always present (possibly empty). This is the ONE warnings channel: the * legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is * a defect waiting to happen — a caller reading the stale one silently misses a disclosure). */ diagnostics: { warnings: QuantWarning[]; }; /** Positive loss magnitude at `confidence`. */ valueAtRisk: number; /** Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. */ conditionalValueAtRisk: number; confidence: number; method: VaRMethod; horizonPeriods: number; /** Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). */ seed?: number; /** Monte-Carlo only: the number of simulated samples actually drawn. */ samples?: number; /** * Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric * only). `false` when it was requested but its expansion was out of domain — the plain Gaussian * quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. */ cornishFisher?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - confidence: number; default: not declared - cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - diagnostics.warnings: QuantWarning[]; default: not declared - horizonPeriods: number; default: not declared - method: VaRMethod; default: not declared - samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. - seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). - valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#WalkForwardOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WalkForwardOptions { /** Training window length (in observations). */ trainSize: number; /** Test window length. */ testSize: number; /** Step between successive folds (default `testSize`). */ step?: number; /** `rolling` (sliding train window) or `anchored` (train always starts at 0). Default `rolling`. */ mode?: 'rolling' | 'anchored'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - mode?: 'rolling' | 'anchored'; default: not declared — `rolling` (sliding train window) or `anchored` (train always starts at 0). Default `rolling`. - step?: number; default: not declared — Step between successive folds (default `testSize`). - testSize: number; default: not declared — Test window length. - trainSize: number; default: not declared — Training window length (in observations). ### @insiderfinance/totalfinance/risk#adjustPValues Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adjust a set of p-values for multiple testing. Bonferroni/Šidák/Holm control the family-wise error rate; Benjamini–Hochberg controls the false-discovery rate. Returns adjusted p-values (input order) and the rejection decisions at `alpha`. ```typescript export declare function adjustPValues(pValues: ArrayLike, options?: MultipleTestOptions): MultipleTestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: MultipleTestOptions; default: not declared - (options).alpha?: number; default: not declared — Significance level (default 0.05). - (options).method?: MultipleTestMethod; default: not declared — Correction method (default `'holm'`). - (pValues): ArrayLike; default: not declared - return.adjusted: number[]; default: not declared — Adjusted p-values aligned with the input order. - return.alpha: number; default: not declared - return.method: MultipleTestMethod; default: not declared - return.rejected: boolean[]; default: not declared — Whether each hypothesis is rejected at `alpha` (`adjusted ≤ alpha`). ### @insiderfinance/totalfinance/risk#aggregateGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate per-position Greeks into book-level totals, each scaled by the position's signed `quantity` (default 1) AND its contract `multiplier` (default 1) — per-share option Greeks with `quantity` in contracts need `multiplier: 100`, and the result says so. Missing Greeks count as 0, so a mixed book of options and deltas aggregates cleanly. Greeks are in the one unit system (theta per day, vega per vol point, rho per 1%). Returns the standard `Computed` envelope (`value` = the totals). ```typescript export declare function aggregateGreeks(positions: readonly Position[]): AggregateGreeksResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (positions): readonly Position[]; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ positions: number; missingGreeks: 'counted-as-zero'; contractMultiplier: 'applied'; greekUnits: { theta: 'perDay'; vega: 'per1Percent'; rho: 'per1Percent'; }; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: PortfolioGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/risk#analyzeBook Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate a book of strategy positions into net risk: greeks, beta-weighted delta, margin, concentration, per-position + per-underlying breakdowns, and (optionally) scenario P&L. ```typescript export declare function analyzeBook(positions: readonly BookPosition[], options?: BookOptions): BookRisk; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: BookOptions; default: not declared - (options).indexPrice?: number; default: not declared — Reference index price → beta-weighted delta (the "net delta in SPY terms" read-out). - (options).multiplier?: number; default: not declared — Contract multiplier for margin (default 100). - (options).regulationTRate?: number; default: not declared — Reg-T naked-margin rate knob, forwarded to `optionsMargin` as its `equityRate`. - (options).scenarios?: readonly Scenario[]; default: not declared — Optional book P&L under scenarios (reuses `stressTest` / `taylorPnl`). - (positions): readonly BookPosition[]; default: not declared - return.assumptions: { conventionsVersion: string; indexPrice?: number; multiplier: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.indexPrice?: number; default: not declared - return.assumptions.multiplier: number; default: not declared - return.betaWeightedDelta?: BetaWeightedDeltaResult; default: not declared — Present when `options.indexPrice` is given. - return.byPosition: PositionRisk[]; default: not declared - return.byUnderlying: UnderlyingRisk[]; default: not declared - return.concentration: ConcentrationValues; default: not declared — Concentration on per-underlying margin — how much buying power sits in one name (bare values; the report wrapper lives on `concentration()` itself). - return.diagnostics: Diagnostics; default: not declared - return.greeks: BookGreeks; default: not declared — Net greeks, display units. - return.margin: { buyingPowerReduction: number; total: number; }; default: not declared - return.margin.buyingPowerReduction: number; default: not declared - return.margin.total: number; default: not declared - return.scenarios?: ScenarioResult[]; default: not declared — Present when `options.scenarios` is given. - return.value: number; default: not declared — Net unrealized P&L of the book ($) — Σ each position's `Position.value()` (P&L since entry), not liquidation NAV. ### @insiderfinance/totalfinance/risk#betaWeightedDelta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Beta-weight a book's delta to a reference index — the standard "what's my net delta in SPY terms" read-out. Each position's dollar delta `δ·price` is scaled by its beta and divided by the index price to express the whole book as index-equivalent shares. ```typescript export declare function betaWeightedDelta(positions: readonly BetaWeightedPosition[], options: { indexPrice: number; }): BetaWeightedDeltaResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { indexPrice: number; }; default: not declared - (options).indexPrice: number; default: not declared - (positions): readonly BetaWeightedPosition[]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.dollarDelta: number; default: not declared — Net beta-weighted dollar delta (`Σ δ·price·β`). - return.indexDelta: number; default: not declared — Net exposure in index-equivalent shares (`Σ δ·price·β / indexPrice`). - return.perPosition: { dollarDelta: number; indexDelta: number; }[]; default: not declared ### @insiderfinance/totalfinance/risk#blackLitterman Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Black-Litterman (1992): blend a market-equilibrium prior on expected returns with subjective views to get a posterior `μ_BL` and covariance, then mean-variance-optimize. The prior is either supplied (`priorMean`) or reverse-engineered from market weights (`π = δ·Σ·w_mkt`); each view `j` carries an uncertainty `Ω_jj` (default the He–Litterman `τ·pᵀΣp`). Posterior: `M = [(τΣ)⁻¹ + PᵀΩ⁻¹P]⁻¹`, `μ_BL = M·[(τΣ)⁻¹π + PᵀΩ⁻¹Q]`, `Σ_post = Σ + M`. Returns the standard `Computed` envelope (dx §2.4): the defaulted `tau: 0.05` / `riskAversion: 2.5` are echoed in `assumptions` (never silently applied), and the posterior solve's convergence lives in `diagnostics.converged` with an `optimize.not_converged` warning when it fails. ```typescript export declare function blackLitterman(options: BlackLittermanOptions): BlackLittermanResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): BlackLittermanOptions; default: not declared - (options).constraints?: OptimizeConstraints; default: not declared — Constraints applied to the posterior mean-variance weights. - (options).covariance: Matrix; default: not declared — Asset return covariance Σ (n×n). - (options).marketWeights?: ArrayLike; default: not declared — Market-cap weights to reverse-engineer the prior `π = δ·Σ·w_mkt`. - (options).priorMean?: ArrayLike; default: not declared — Prior (equilibrium) expected returns π. Provide this, or `marketWeights` to imply it. - (options).riskAversion?: number; default: not declared — Risk-aversion δ for the implied prior and the posterior mean-variance weights. Default 2.5. - (options).tau?: number; default: not declared — Scalar τ scaling the prior uncertainty of the mean (default 0.05). - (options).views: BlackLittermanView[]; default: not declared — Investor views (at least one). - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ tau: number; riskAversion: number; views: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { posteriorCovariance: number[][]; posteriorMean: number[]; priorMean: number[]; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.posteriorCovariance: number[][]; default: not declared — Posterior return covariance `Σ + M`, where `M` is the posterior covariance of the mean. - return.value.posteriorMean: number[]; default: not declared — Posterior (views-blended) expected returns. - return.value.priorMean: number[]; default: not declared — The supplied or market-implied equilibrium prior π. - return.value.weights: number[]; default: not declared — Mean-variance-optimal weights under the posterior. ### @insiderfinance/totalfinance/risk#bookVaR Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function bookVaR(positions: readonly BookVaRPosition[], options: BookVaROptions): BookVaRResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): BookVaROptions; default: not declared - (options).confidence?: number; default: not declared — Confidence level in (0, 1). Default 0.95. - (options).correlation?: readonly (readonly number[])[]; default: not declared — Spot-return correlation matrix, rows/cols in `assumptions.underlyings` (sorted) order. Default I. - (options).factors: Record; default: not declared — Per-underlying risk factors — MUST cover every underlying present in the book. - (options).horizonDays?: number; default: not declared — VaR horizonPeriods in (trading) days. Default 1. - (options).method?: 'both' | 'parametric' | 'monteCarlo'; default: not declared — Which method(s) to compute. Default `'both'`. - (options).samples?: number; default: not declared — Monte-Carlo draws. Default 10,000; capped at 1,000,000. - (options).seed?: number; default: not declared — Monte-Carlo PRNG seed (integer). Default 1; echoed for reproducibility. - (options).tradingDaysPerYear?: number; default: not declared — Trading days per year for vol annualization. Default 252. - (positions): readonly BookVaRPosition[]; default: not declared - return.assumptions: { confidence: number; conventionsVersion: string; horizonDays: number; samples?: number; seed?: number; tradingDaysPerYear: number; underlyings: string[]; }; default: not declared - return.assumptions.confidence: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.horizonDays: number; default: not declared - return.assumptions.samples?: number; default: not declared - return.assumptions.seed?: number; default: not declared - return.assumptions.tradingDaysPerYear: number; default: not declared - return.assumptions.underlyings: string[]; default: not declared — Sorted underlyings — the row/col order of `options.correlation`. - return.components: BookVaRComponent[]; default: not declared — Per-underlying decomposition (from the linear risk), sorted by `componentVaR` desc. - return.confidence: number; default: not declared - return.cornishFisher?: BookVaRMethodResult; default: not declared — Cornish-Fisher **gamma-adjusted** analytic VaR — the parametric quantile corrected for the P&L skewness/kurtosis the gamma induces. Present unless `method: 'monteCarlo'` AND the CF expansion is in its valid (monotone) domain; when a very convex book pushes it out of domain it is omitted and a `risk.cornish_fisher_out_of_domain` warning points to `monteCarlo`. - return.diagnostics: Diagnostics; default: not declared - return.horizonDays: number; default: not declared - return.monteCarlo?: BookVaRMethodResult; default: not declared — Delta-gamma (gamma-exact), seeded Monte-Carlo VaR — present unless `method: 'parametric'`. - return.parametric?: BookVaRMethodResult; default: not declared — Delta-normal (linear) VaR — present unless `method: 'monteCarlo'`. ### @insiderfinance/totalfinance/risk#brinsonAttribution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose a portfolio's active return vs a benchmark into allocation (sector bets), selection (security picks), and interaction — an exact decomposition (the three sum to the active return). See `docs/specs/attribution.md`. ```typescript export declare function brinsonAttribution(segments: BrinsonSegment[], options?: BrinsonAttributionOptions): BrinsonAttribution; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: BrinsonAttributionOptions; default: not declared - (options).method?: BrinsonMethod; default: not declared — Allocation convention; default `'brinson-fachler'` (benchmark-relative). - (segments): BrinsonSegment[]; default: not declared - return.activeReturn: number; default: not declared — `portfolioReturn − benchmarkReturn`. - return.allocation: number; default: not declared — Segment-summed effects (`allocation + selection + interaction = activeReturn`, exact). - return.assumptions: { conventionsVersion: string; method: BrinsonMethod; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: BrinsonMethod; default: not declared - return.benchmarkReturn: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.interaction: number; default: not declared - return.method: BrinsonMethod; default: not declared - return.portfolioReturn: number; default: not declared - return.segments: SegmentEffect[]; default: not declared - return.selection: number; default: not declared ### @insiderfinance/totalfinance/risk#checkLeakage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Flag any split whose train and test index sets overlap (look-ahead leakage). The findings are `research.train_test_leakage` warnings on `diagnostics.warnings` (one per leaking split), with the structured per-split detail mirrored on `leaks` and a `clean` verdict. ```typescript export declare function checkLeakage(splits: Split[]): LeakageReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (splits): Split[]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.clean: boolean; default: not declared — `true` when no split leaks. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — The leakage warnings themselves (one `research.train_test_leakage` per leaking split). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.leaks: LeakageIssue[]; default: not declared — Per-split leak details, aligned with `diagnostics.warnings`. ### @insiderfinance/totalfinance/risk#concentration Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Concentration of a (possibly long/short) weight vector, measured on gross-normalized shares `s_i = |w_i| / Σ|w|`: the HHI and its reciprocal effective-N, the largest and top-k shares, and the Gini coefficient. ```typescript export declare function concentration(weights: ArrayLike, options?: { topK?: number; }): ConcentrationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { topK?: number; }; default: not declared - (options).topK?: number; default: not declared - (weights): ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.effectiveCount: number | null; default: not declared — Effective number of positions `1 / HHI`; `null` when the book has zero gross exposure (there is nothing to concentrate — Law 7: an undefined quantity is null-with-reason, never NaN). - return.gini: number; default: not declared — Gini coefficient of the gross-normalized weight distribution (0 = equal, →1 = concentrated). - return.hhi: number; default: not declared — Herfindahl-Hirschman index `Σ s_i²` on gross-normalized weights (1 = one name, 1/n = equal). - return.topKShare: number; default: not declared — Combined share of the top-`k` names (default `k = min(5, n)`). - return.topWeight: number; default: not declared — Largest single name's share of gross exposure. ### @insiderfinance/totalfinance/risk#conditionalValueAtRiskOptimize Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Minimize portfolio CVaR over a scenario set (Rockafellar–Uryasev, projected subgradient). `value` carries the weights plus the optimized `conditionalValueAtRisk` and the `valueAtRisk` threshold; `assumptions` additionally echo the tail confidence `alpha`. ```typescript export declare function conditionalValueAtRiskOptimize(scenarios: number[][], options?: CVaROptimizeOptions): CVaROptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: CVaROptimizeOptions; default: not declared - (options).alpha?: number; default: not declared — Tail confidence α: optimize the mean of the worst `(1 − α)` fraction of losses. Default 0.95. - (options).bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - (options).budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - (options).groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - (options).longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - (options).maximumIterations?: number; default: not declared — Projected-subgradient iteration cap. Default 4000. - (options).minReturn?: number; default: not declared — Optional minimum mean return `μᵀw ≥ minReturn` (μ = per-asset scenario means). - (options).step?: number; default: not declared — Initial subgradient step size (decays as `step/√t`). Defaults to `1/‖g₀‖` — the step that moves the FIRST iterate a distance of about 1 in weight space, which is the scale weights live on. A fixed default (this used to be `1`) is unit-dependent: on decimal daily returns ‖g‖ ≈ 0.01, so every step moved ~1e-2·(1/√t) and the run plateaued a long way from the optimum while reporting `converged: true`. Pass an explicit `step` only to override that scaling. - (options).tolerance?: number; default: not declared — Relative-improvement tolerance for convergence: the run is `converged` only once the best CVaR improves by less than this over the final 25 iterations. Default `1e-6`. - (options).transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - (options).transactionCosts.perUnitTurnover: number | number[]; default: not declared - (options).transactionCosts.previousWeights: number[]; default: not declared - (options).turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - (scenarios): number[][]; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; confidence: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { conditionalValueAtRisk: number; objective: number; valueAtRisk: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.conditionalValueAtRisk: number; default: not declared — The optimized CVaR — mean loss over the worst `(1 − α)` tail (a positive magnitude). - return.value.objective: number; default: not declared - return.value.valueAtRisk: number; default: not declared — The VaR threshold (loss quantile at α) at the solution. - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#costAwareKelly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cost-aware Kelly for a continuous edge. Costs — a per-period holding cost plus an amortized round-trip cost, `c = holdingCost + roundTripCost/horizonPeriods` — reduce the drift (`μ → μ − c`, variance unchanged), so the growth-optimal size shrinks to `netKelly = max(0, (μ−c)/σ²)` and below the breakeven cost `μ` the edge is not worth betting. Reports gross vs net Kelly, the growth drag, the penalty for naively betting gross while paying costs, and refuses a losing bet. See `docs/specs/cost-aware-kelly.md`. ```typescript export declare function costAwareKelly(input: CostAwareKellyInput): CostAwareKelly; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CostAwareKellyInput; default: not declared - (input).edge: { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; default: not declared — The per-period edge: a Gaussian mean/variance, or a return sample (μ, σ² computed from it). - (input).edge.gaussian: { mean: number; variance: number; }; default: not declared - (input).edge.gaussian.mean: number; default: not declared - (input).edge.gaussian.variance: number; default: not declared - (input).edge.returns: ArrayLike; default: not declared - (input).fraction?: number; default: not declared — Fractional-Kelly multiplier applied to `netKelly`. Default 0.5. Must be > 0. - (input).holdingCost?: number; default: not declared — Per-period holding cost per unit of position (financing / borrow / carry). Default 0. - (input).horizonPeriods?: number; default: not declared — Expected holding periods, to amortize `roundTripCost`. Required when `roundTripCost > 0`. - (input).roundTripCost?: number; default: not declared — One-time round-trip cost per unit of position (entry + exit). Default 0. Requires `horizonPeriods`. - return.assumptions: { conventionsVersion: string; edgeType: 'gaussian' | 'returns'; fraction: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.edgeType: 'returns' | 'gaussian'; default: not declared - return.assumptions.fraction: number; default: not declared - return.breakevenCost: number; default: not declared — `μ` — the cost at which the edge vanishes. - return.costPerPeriod: number; default: not declared — Per-period cost drag `c = holdingCost + roundTripCost/horizonPeriods`. - return.diagnostics: Diagnostics; default: not declared - return.grossGrowth: number | null; default: not declared — `μ²/(2σ²)` — expected log-growth at gross Kelly with no costs; `null` with `grossKelly`. - return.grossKelly: number | null; default: not declared — `μ/σ²` — the growth-optimal fraction ignoring costs; `null` when the edge has zero variance (C hygiene). - return.growthDrag: number | null; default: not declared — `grossGrowth − netGrowth` — the log-growth the costs cost you; `null` with `grossKelly`. - return.ignoringCostsGrowth: number | null; default: not declared — Log-growth of naively betting gross Kelly while paying costs (`≤ netGrowth`); `null` with `grossKelly`. - return.isProfitable: boolean; default: not declared — Whether the net edge is positive (`c < μ`). - return.mean: number; default: not declared — The edge mean `μ` used. - return.netGrowth: number | null; default: not declared — `(μ−c)²/(2σ²)` — expected log-growth at net Kelly (the achievable optimum with costs); `null` with `grossKelly`. - return.netKelly: number | null; default: not declared — `max(0, (μ−c)/σ²)` — the cost-aware growth-optimal fraction; `null` with `grossKelly`. - return.rationale: string; default: not declared — Prose an agent relays. - return.recommendedFraction: number | null; default: not declared — `fraction · netKelly` — the recommended size after fractional-Kelly; `null` with `grossKelly`. - return.variance: number; default: not declared — The edge variance `σ²` used. ### @insiderfinance/totalfinance/risk#covariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Estimate a portfolio covariance (and mean returns) from raw return history — the first step of every optimizer journey. Delegates estimation to `estimateCovariance` (`method: 'auto'` defaults to the sample covariance and shrinks only when it is singular/ill-conditioned, always disclosing what it did), and reports the full conditioning diagnostics so a caller knows the matrix is safe to invert BEFORE optimizing with it. ```typescript export declare function covariance(input: CovarianceInput, options?: CovarianceOptions): CovarianceResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CovarianceInput; default: not declared - (input).assets?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result for self-description. - (input).returns: number[][]; default: not declared — Observations-major returns: `returns[t][k]` is asset `k`'s simple return in period `t` — one row per period, one column per asset (the natural CSV/dataframe orientation, and the TRANSPOSE of `@insiderfinance/totalfinance/math`'s variables-major `estimateCovariance` input). Every row must have the same number of assets. - (options)?: EstimateCovarianceOptions; default: not declared - (options).conditionThreshold?: number; default: not declared — Condition-number threshold above which `'auto'` shrinks rather than using the sample. Default 1e4. - (options).halfLife?: number; default: not declared — EWMA half-life in periods (method `'ewma'`); `λ = 2^{−1/halfLife}` when `lambda` is omitted. - (options).lambda?: number; default: not declared — EWMA decay `0 < λ < 1` (method `'ewma'`). Default 0.94 (RiskMetrics). - (options).ledoitWolfTarget?: 'identity' | 'constant-correlation' | 'single-index'; default: not declared — Ledoit–Wolf shrinkage target when the method resolves to `'ledoit-wolf'` (explicitly or via `'auto'`). `'identity'` (default), `'constant-correlation'` (fits correlated returns better), or `'single-index'` (the market-model target, best-specified for stock returns). - (options).market?: ArrayLike; default: not declared — Observed market return series for the `'single-index'` target (length `T`). Omitted → the equal-weight cross-sectional proxy is used and disclosed via `assumptions.marketProxy`. - (options).method?: import('@insiderfinance/totalfinance/math').CovarianceMethod; default: not declared — Estimator; default `'auto'`. - (options).population?: boolean; default: not declared — Population (`1/T`) vs sample (`1/(T−1)`) normalization. Default `true` (matches Ledoit–Wolf). - (options).ridge?: number; default: not declared — Ridge diagonal load as a fraction of the average variance (method `'ridge'`). Default 0.1; > 0. - return.assumptions: { conventionsVersion: string; method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; observations: number; orientation: 'observations-major'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'sample' | 'ledoit-wolf' | 'ridge' | 'ewma'; default: not declared — The estimator actually used (`'auto'` resolves before reporting). - return.assumptions.observations: number; default: not declared - return.assumptions.orientation: 'observations-major'; default: not declared — Returns are treated as one row per PERIOD; means are per-period, not annualized. - return.diagnostics: Diagnostics & { conditionNumber: number | null; effectiveRank: number; isPositiveDefinite: boolean; lambda?: number; maxEigenvalue: number; minEigenvalue: number; shrinkage?: number; }; default: not declared - return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.diagnostics.conditionNumber: number | null; default: not declared — `null` when the matrix is singular (κ = ∞ has no JSON representation; see warnings). - return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.diagnostics.effectiveRank: number; default: not declared - return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.diagnostics.isPositiveDefinite: boolean; default: not declared - return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - return.diagnostics.lambda?: number; default: not declared - return.diagnostics.maxEigenvalue: number; default: not declared - return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.diagnostics.minEigenvalue: number; default: not declared - return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.diagnostics.shrinkage?: number; default: not declared - return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - return.value: CovarianceValue; default: not declared ### @insiderfinance/totalfinance/risk#covarianceToCorrelation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert a covariance matrix to a correlation matrix (unit diagonal). ```typescript export declare function covarianceToCorrelation(covariance: Matrix): Matrix; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared ### @insiderfinance/totalfinance/risk#deflatedSharpeRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Deflated Sharpe Ratio (Bailey & López de Prado 2014): the PSR evaluated against the *expected maximum* Sharpe that `N` independent trials would produce by chance, so selecting the best of a parameter sweep is penalised. Pass the trial Sharpes (variance computed for you) or `trialCount` plus their variance directly. ```typescript export declare function deflatedSharpeRatio(statistics: SharpeStatistics, trials: { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }): DeflatedSharpeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (statistics): SharpeStatistics; default: not declared - (statistics).kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - (statistics).observations: number; default: not declared — Number of observations. - (statistics).sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - (statistics).skewness: number; default: not declared — Skewness `γ₃` of the returns. - (trials): { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }; default: not declared - (trials).trialCount: number; default: not declared - (trials).trialSharpes: ArrayLike; default: not declared - (trials).varianceSharpe: number; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.deflatedSharpe: number | null; default: not declared — `null` when the statistics carry no Sharpe (a zero-variance series). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe across `trialCount` under the null — the deflation benchmark `SR₀`. - return.probabilisticSharpe: number | null; default: not declared — The un-deflated PSR (benchmark 0), for comparison. - return.trialCount: number; default: not declared ### @insiderfinance/totalfinance/risk#diversificationRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diversification ratio: weighted-average asset volatility ÷ portfolio volatility (≥ 1). A zero-volatility portfolio has no finite ratio — that degenerate input throws a typed `input.degenerate` error instead of returning the plausible but false value `1` (H09). ```typescript export declare function diversificationRatio(weights: ArrayLike, covariance: Matrix): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (weights): ArrayLike; default: not declared ### @insiderfinance/totalfinance/risk#drawdownAtRisk Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Drawdown-at-Risk and Conditional Drawdown-at-Risk (Chekhlov–Uryasev) from a return series: the `α`-quantile of the path's underwater (fractional-drawdown) curve, and the mean drawdown beyond it. Deterministic; no simulation. See `docs/specs/evt-tail-risk.md`. ```typescript export declare function drawdownAtRisk(returns: ArrayLike, options?: { confidence?: number; }): DrawdownAtRisk; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { confidence?: number; }; default: not declared - (options).confidence?: number; default: not declared - (returns): ArrayLike; default: not declared - return.assumptions: { confidence: number; conventionsVersion: string; }; default: not declared - return.assumptions.confidence: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.conditionalDrawdownAtRisk: number; default: not declared — `CDaR_α` — the mean drawdown beyond `DaR_α` (Chekhlov–Uryasev; ≥ `DaR_α`). - return.confidence: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.drawdownAtRisk: number; default: not declared — `DaR_α` — the `α`-quantile of the fractional drawdown series (≥ 0). - return.maxDrawdown: number; default: not declared — The worst drawdown on the path (context). - return.observations: number; default: not declared ### @insiderfinance/totalfinance/risk#efficientFrontier Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Trace the constrained mean-variance efficient frontier by composing `minVariance`, `meanVariance`, and (with a risk-free rate) `maxSharpe` under ONE constraint set. ```ts efficientFrontier({ mean, covariance, grid: { kind: 'points', count: 20 }, constraints: { longOnly: true }, riskFreeRatePerPeriod: 0.04 / 252, }); ``` `value.points` keeps every grid point in order; a target outside the achievable range is a `feasible: false` point whose `reason` names the range, never a throw. `diagnostics.monotone` reports whether volatility rises with expected return across the solved points (the shape a correct frontier has) and names the first violation in a warning when it does not. ```typescript export declare function efficientFrontier(input: EfficientFrontierInput): EfficientFrontierResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EfficientFrontierInput; default: not declared - (input).constraints?: EfficientFrontierConstraints; default: not declared — The optimizer's feasible-region grammar (`longOnly`, `bounds`, `budget`, `groups`, …). - (input).covariance: Matrix; default: not declared — Asset return covariance Σ (n×n). - (input).grid: EfficientFrontierGrid; default: not declared - (input).mean: ArrayLike; default: not declared — Per-asset expected returns as a dense stored-data ArrayLike (same period as covariance). - (input).riskFreeRatePerPeriod?: number; default: not declared — Risk-free rate in the SAME per-period units as `mean` (a daily problem takes 0.04/252, not 0.04) — the `maxSharpe` spelling. When present every point reports a Sharpe ratio and the tangency portfolio is solved and reported under `value.tangency`. - return.assumptions: { budget: number; constraintSummary: string; conventionsVersion: string; grid: { kind: EfficientFrontierGridKind; count: number; }; objective: 'mean-variance'; riskFreeRatePerPeriod?: number; }; default: not declared - return.assumptions.budget: number; default: not declared - return.assumptions.constraintSummary: string; default: not declared — Prose summary of the constraint set every point was solved under. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.grid: { count: number; kind: EfficientFrontierGridKind; }; default: not declared - return.assumptions.grid.count: number; default: not declared - return.assumptions.grid.kind: 'risk-aversion' | 'target-return' | 'points'; default: not declared - return.assumptions.objective: 'mean-variance'; default: not declared - return.assumptions.riskFreeRatePerPeriod?: number; default: not declared - return.diagnostics: Diagnostics & { converged: boolean; failedCount: number; iterations: number; maximumReturnBounded: boolean | null; monotone: boolean; solvedCount: number; }; default: not declared - return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. Every solved point converged (false when any point failed or stopped early). - return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.diagnostics.failedCount: number; default: not declared - return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. Total solver iterations across the sweep. - return.diagnostics.maximumReturnBounded: boolean | null; default: not declared — `true` when finite, `false` when unbounded, `null` when the proof is undetermined. - return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.diagnostics.monotone: boolean; default: not declared — Volatility is non-decreasing with expected return across the solved points. - return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.diagnostics.solvedCount: number; default: not declared - return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - return.value: EfficientFrontierValue; default: not declared ### @insiderfinance/totalfinance/risk#estimateExpectedReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Estimate per-asset expected returns under an EXPLICIT method — the `mean` for `maxSharpe`, `meanVariance`, `kelly`, and `efficientFrontier`. ```ts estimateExpectedReturns({ method: 'historical-mean', returns, periodsPerYear: 252 }); estimateExpectedReturns({ method: 'exponentially-weighted', returns, halfLifePeriods: 60 }); estimateExpectedReturns({ method: 'capital-asset-pricing', betas: [0.8, 1.2], annualRiskFreeRate: 0.04, annualMarketRiskPremium: 0.05, }); estimateExpectedReturns({ method: 'supplied', expectedReturns: [0.08, 0.1], annualized: true }); ``` `value.annualized` always states the unit of the result; the sample methods report per-period means unless `periodsPerYear` is given, the capital-asset-pricing method is annual by construction, and the supplied method carries the caller's own flag. ```typescript export declare function estimateExpectedReturns(input: EstimateExpectedReturnsInput): ExpectedReturnsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EstimateExpectedReturnsInput; default: not declared - (input).annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - (input).annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - (input).annualized: boolean; default: not declared — Whether the supplied values are annual (`true`) or per-period (`false`). Required. - (input).asOf?: string | number; default: not declared — Point-in-time cut: every row whose timestamp is AFTER this instant is excluded from the estimate and the excluded count is disclosed in `diagnostics.excludedAfterAsOf`. Without `observationTimestamps` nothing can be screened — the result then carries a warning. - (input).assetIds?: string[]; default: not declared — Optional asset labels aligned to the columns; echoed on the result. Optional asset labels aligned to `betas`; echoed on the result. Optional asset labels aligned to `expectedReturns`; echoed on the result. - (input).betas: number[]; default: not declared — Per-asset market betas (one per asset). - (input).expectedReturns: number[]; default: not declared — Caller-supplied expected returns, one per asset. - (input).halfLifePeriods: number; default: not declared — Half-life of the observation weights in PERIODS: observation `t` of `T` carries weight `0.5^((T − 1 − t) / halfLifePeriods)` before normalization, so the most recent row is the heaviest. Required — there is no universal decay rate. - (input).method: ('capital-asset-pricing') | ('exponentially-weighted') | ('historical-mean') | ('supplied'); default: not declared - (input).observationTimestamps?: (string | number)[]; default: not declared — Optional observation instants aligned 1:1 with the rows of `returns` (epoch milliseconds or an ISO date / zoned datetime), non-decreasing. Required for `asOf` to screen anything. - (input).periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily, `12` for monthly data): the reported means become `periodMean × periodsPerYear`. OMITTED means per-period means with `annualized: false` — annualization is never silent. - (input).returns: number[][]; default: not declared — Observations-major returns — the same orientation as `CovarianceInput`: `returns[t][k]` is asset `k`'s simple return in period `t` (one row per period, one column per asset). - return.assumptions: { annualMarketRiskPremium?: number; annualRiskFreeRate?: number; asOf?: EpochMs; conventionsVersion: string; estimationConvention: string; halfLifePeriods?: number; method: ExpectedReturnsMethod; periodsPerYear?: number; }; default: not declared - return.assumptions.annualMarketRiskPremium?: number; default: not declared — Echoed for `'capital-asset-pricing'`. - return.assumptions.annualRiskFreeRate?: number; default: not declared — Echoed for `'capital-asset-pricing'`. - return.assumptions.asOf?: number; default: not declared — The resolved point-in-time cut (epoch milliseconds), when `asOf` was given. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.estimationConvention: string; default: not declared — Prose statement of exactly how the numbers were produced. - return.assumptions.halfLifePeriods?: number; default: not declared — Echoed for `'exponentially-weighted'`. - return.assumptions.method: 'supplied' | 'capital-asset-pricing' | 'historical-mean' | 'exponentially-weighted'; default: not declared - return.assumptions.periodsPerYear?: number; default: not declared — Echoed when annualization was requested (sample methods only). - return.diagnostics: Diagnostics & { effectiveSampleSize?: number; excludedAfterAsOf?: number; sampleSize: number; }; default: not declared - return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - return.diagnostics.effectiveSampleSize?: number; default: not declared — `(Σw)² / Σw²` of the observation weights (`'exponentially-weighted'` only). - return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - return.diagnostics.excludedAfterAsOf?: number; default: not declared — Rows excluded because their timestamp is after `asOf` (when both were supplied). - return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - return.diagnostics.sampleSize: number; default: not declared — Return observations consumed (after point-in-time screening); 0 for methods without a sample. - return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - return.value: ExpectedReturnsValue; default: not declared ### @insiderfinance/totalfinance/risk#expectedShortfall Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Conditional VaR / expected shortfall (positive loss magnitude), with the same `.explain()`. ```typescript export declare const expectedShortfall: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: VaROptions | undefined], number, ValueAtRiskAssumptionExtras>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: VaROptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: VaROptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: VaROptions | undefined]; default: not declared ### @insiderfinance/totalfinance/risk#explainPnl Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function explainPnl(input: ExplainPnlInput): PnlExplain; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExplainPnlInput; default: not declared - (input).actualPnl: number; default: not declared - (input).greeks: PositionGreeks; default: not declared - (input).move: PnlMove; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - return.delta: number; default: not declared — Delta term: `Δ·dS`. - return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - return.rho: number; default: not declared — Rho term: `Rho·dr`. - return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - return.theta: number; default: not declared — Theta term: `Θ·dt`. - return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - return.total: number; default: not declared — The actual realized P&L. - return.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - return.vega: number; default: not declared — Vega term: `Vega·dσ`. - return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#explainPortfolioPnl Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose a portfolio's realized P&L: each position with its own market context (so a book can span underlyings). The book explain is the term-wise sum; each position's explain is preserved. ```typescript export declare function explainPortfolioPnl(items: readonly PortfolioPnlItem[]): PortfolioPnlExplain; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (items): readonly PortfolioPnlItem[]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.byPosition: (PositionPnlExplain & { id?: string; })[]; default: not declared - return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - return.delta: number; default: not declared — Delta term: `Δ·dS`. - return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - return.rho: number; default: not declared — Rho term: `Rho·dr`. - return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - return.theta: number; default: not declared — Theta term: `Θ·dt`. - return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - return.total: number; default: not declared — The actual realized P&L. - return.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - return.vega: number; default: not declared — Vega term: `Vega·dσ`. - return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#explainPositionPnl Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function explainPositionPnl(input: ExplainPositionPnlInput): PositionPnlExplain; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExplainPositionPnlInput; default: not declared - (input).from: PnlMarket; default: not declared - (input).position: StrategyPosition; default: not declared - (input).to: PnlMarket; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 unless the greeks carry `charm`). - return.delta: number; default: not declared — Delta term: `Δ·dS`. - return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 unless the greeks carry `deltaRate`). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings (e.g. a dominant residual); always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.gamma: number; default: not declared — Gamma term: `½Γ·dS²`. - return.perLeg: LegPnlExplain[]; default: not declared - return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 unless the greeks carry `phi`). - return.rho: number; default: not declared — Rho term: `Rho·dr`. - return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 unless the greeks carry `rhoConvexity`). - return.theta: number; default: not declared — Theta term: `Θ·dt`. - return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 unless the greeks carry `thetaConvexity`). - return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 unless the greeks carry `thetaRate`). - return.total: number; default: not declared — The actual realized P&L. - return.unexplained: number; default: not declared — `total − Σ(terms)` — the full 2nd-order Taylor in (spot, vol, time, rate) plus the dividend carry is now attributed, so the residual is only 3rd-order-and-higher (speed/ultima/…), any 2nd-order greek the caller did not supply, and model/data. Grows as the greek expansion breaks. - return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 unless the greeks carry `vanna`). - return.vega: number; default: not declared — Vega term: `Vega·dσ`. - return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 unless the greeks carry `vera`). - return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 unless the greeks carry `veta`). - return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 unless the greeks carry `vomma`). ### @insiderfinance/totalfinance/risk#extremeValueTailRisk Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extreme-tail VaR and Expected Shortfall via the MonteCarloNeil–Frey peaks-over-threshold method, shown beside the empirical and normal numbers with a fat-tail ratio. When the confidence sits outside the fitted tail (`1 − p ≥ Nu/n`) EVT cannot extrapolate, so the empirical quantile is reported with a warning instead of a fabricated EVT number. See `docs/specs/evt-tail-risk.md`. ```typescript export declare function extremeValueTailRisk(returns: ArrayLike, options?: { confidence?: number; } & GeneralizedParetoFitOptions): ExtremeValueTailRisk; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { confidence?: number; } & GeneralizedParetoFitOptions; default: not declared - (options).confidence?: number; default: not declared - (options).method?: 'pwm' | 'mle'; default: not declared — Estimator; default `'pwm'` (closed-form, robust). - (options).minExceedances?: number; default: not declared — Exceedance count below which the fit is warned as unreliable; default 10. - (options).tailFraction?: number; default: not declared — Worst fraction of losses used as exceedances; default 0.10. Ignored when `threshold` is set. - (options).threshold?: number; default: not declared — Explicit loss threshold `u` (overrides `tailFraction`). - (returns): ArrayLike; default: not declared - return.assumptions: { confidence: number; conventionsVersion: string; }; default: not declared - return.assumptions.confidence: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.conditionalValueAtRisk: number; default: not declared — EVT Expected Shortfall (`≥ var`; `Infinity` when `ξ ≥ 1`). - return.confidence: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.empirical: { conditionalValueAtRisk: number; valueAtRisk: number; }; default: not declared — The empirical (historical) VaR/ES at the same confidence, for comparison. - return.empirical.conditionalValueAtRisk: number; default: not declared - return.empirical.valueAtRisk: number; default: not declared - return.fit: GeneralizedParetoFit; default: not declared — The underlying GPD fit. - return.normal: { conditionalValueAtRisk: number; valueAtRisk: number; }; default: not declared — The normal (Gaussian) VaR/ES at the same confidence, for comparison. - return.normal.conditionalValueAtRisk: number; default: not declared - return.normal.valueAtRisk: number; default: not declared - return.tailFatnessRatio: number; default: not declared — `evt.var / normal.var` — how much fatter the tail is than the Gaussian says. - return.valueAtRisk: number; default: not declared — EVT VaR — a positive loss magnitude. ### @insiderfinance/totalfinance/risk#factorAttribution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Attribute a return series to observable factors by OLS regression, splitting the realized return into a contribution per factor plus a specific (alpha) residual — a decomposition that reconstructs the total exactly. See `docs/specs/attribution.md`. ```typescript export declare function factorAttribution(input: FactorAttributionInput): FactorAttribution; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FactorAttributionInput; default: not declared - (input).factors: FactorSeries[]; default: not declared — Observable factor return series (each aligned to `returns`). - (input).returns: ArrayLike; default: not declared — The asset/portfolio return series to attribute. - (input).riskFreeRate?: number; default: not declared — Per-period risk-free rate subtracted from `returns` first; default 0. - return.adjustedRSquared: number; default: not declared - return.alpha: number; default: not declared — Per-period specific return (the OLS intercept). - return.assumptions: { conventionsVersion: string; riskFreeRate: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.riskFreeRate: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.factors: FactorContribution[]; default: not declared - return.observations: number; default: not declared - return.rSquared: number; default: not declared - return.specificReturn: number; default: not declared — Cumulative specific return `n·alpha` — the part no factor explains. - return.totalReturn: number; default: not declared — Total of the (excess, if `riskFreeRate` given) return series = `specificReturn + Σ contributions`. ### @insiderfinance/totalfinance/risk#factorExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Keep the top-`k` principal components and report each asset's exposure (loading) to them. ```typescript export declare function factorExposure(covariance: Matrix, options?: { factorCount?: number; correlation?: boolean; }): FactorExposureResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (options)?: { correlation?: boolean; factorCount?: number; }; default: not declared - (options).correlation?: boolean; default: not declared - (options).factorCount?: number; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.exposure: number[][]; default: not declared — `exposure[assetIndex][factorIndex]` = that asset's loading on the factor. - return.factors: PcaComponent[]; default: not declared — The retained top-k principal components. - return.varianceExplained: number; default: not declared — Total variance explained by the retained factors. ### @insiderfinance/totalfinance/risk#fitGeneralizedParetoTail Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a Generalized Pareto Distribution to the **loss** tail (peaks-over-threshold). Returns the tail index `ξ`, scale `β`, threshold, and exceedance count, with warnings for a thin sample or infinite-moment tails. See `docs/specs/evt-tail-risk.md`. ```typescript export declare function fitGeneralizedParetoTail(returns: ArrayLike, options?: GeneralizedParetoFitOptions): GeneralizedParetoFit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: GeneralizedParetoFitOptions; default: not declared - (options).method?: 'pwm' | 'mle'; default: not declared — Estimator; default `'pwm'` (closed-form, robust). - (options).minExceedances?: number; default: not declared — Exceedance count below which the fit is warned as unreliable; default 10. - (options).tailFraction?: number; default: not declared — Worst fraction of losses used as exceedances; default 0.10. Ignored when `threshold` is set. - (options).threshold?: number; default: not declared — Explicit loss threshold `u` (overrides `tailFraction`). - (returns): ArrayLike; default: not declared - return.assumptions: { conventionsVersion: string; estimator: 'pwm' | 'mle'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.estimator: 'pwm' | 'mle'; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.exceedances: number; default: not declared — Number of exceedances `Nu` over the threshold. - return.method: 'pwm' | 'mle'; default: not declared — The estimator that actually produced the fit (`'mle'` may fall back to `'pwm'`). - return.observationCount: number; default: not declared — Total number of losses. - return.scale: number; default: not declared — Scale `β > 0`. - return.shape: number; default: not declared — Tail index `ξ` — `> 0` heavy, `0` exponential, `< 0` finite endpoint. - return.tailFraction: number; default: not declared — `Nu / observationCount` — the realized tail fraction. - return.threshold: number; default: not declared — Loss threshold `u` above which the GPD is fitted. ### @insiderfinance/totalfinance/risk#hrp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Hierarchical Risk Parity portfolio (correlation-distance clustering + recursive bisection). ```typescript export declare function hrp(covariance: Matrix, options?: { budget?: number; }): OptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (options)?: { budget?: number; }; default: not declared - (options).budget?: number; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.objective: number; default: not declared - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#kelly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function kelly(input: KellyInput): OptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): KellyInput; default: not declared - (input).covariance: Matrix; default: not declared - (input).mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - (input).options?: KellyOptions; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.objective: number; default: not declared - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#kellyBet Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Size a single bet by the Kelly criterion — compute the growth-optimal fraction from the edge, then scale it down sanely (half-Kelly by default, a drawdown budget, a hard cap) with the growth, the drawdown risk, and the fat-tail correction all disclosed. See `docs/specs/kelly-sizing.md`. ```typescript export declare function kellyBet(input: KellyBetInput): KellySizing; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): KellyBetInput; default: not declared - (input).drawdownLimit?: { maxProbability: number; toFraction: number; }; default: not declared — Cap the applied Kelly multiple so `P(ever falling to toFraction of starting bankroll) ≤ maxProbability`. - (input).drawdownLimit.maxProbability: number; default: not declared - (input).drawdownLimit.toFraction: number; default: not declared - (input).edge: { binary: BinaryEdge; } | { outcomes: EdgeOutcome[]; } | { gaussian: { mean: number; variance: number; }; } | { returns: ArrayLike; }; default: not declared - (input).edge.binary: BinaryEdge; default: not declared - (input).edge.gaussian: { mean: number; variance: number; }; default: not declared - (input).edge.gaussian.mean: number; default: not declared - (input).edge.gaussian.variance: number; default: not declared - (input).edge.outcomes: EdgeOutcome[]; default: not declared - (input).edge.returns: ArrayLike; default: not declared - (input).fraction?: number; default: not declared — Fraction of full Kelly to apply (0.5 = half-Kelly). Default 0.5. Must be > 0. - (input).horizonPeriods?: number; default: not declared — Optional horizonPeriods (periods) for the growth projection. Must be > 0 when given. - (input).maxFraction?: number; default: not declared — Hard cap on the recommended fraction of bankroll (e.g. 1 = no leverage). Must be > 0. - return.appliedFraction: number | null; default: not declared — `κ = recommendedFraction / fullKelly` — the applied Kelly multiple (0 when there's no edge); `null` when `fullKelly` is null (undefined against a non-existent optimum). - return.assumptions: { conventionsVersion: string; drawdownModel: 'continuous-gbm'; edgeType: 'binary' | 'outcomes' | 'gaussian' | 'returns'; fraction: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.drawdownModel: 'continuous-gbm'; default: not declared - return.assumptions.edgeType: 'returns' | 'gaussian' | 'binary' | 'outcomes'; default: not declared - return.assumptions.fraction: number; default: not declared - return.bindingConstraint: 'fraction' | 'drawdown-limit' | 'max-fraction' | 'no-edge' | 'no-downside'; default: not declared — Which cap set the recommended fraction (`no-downside` = unbounded edge with no cap supplied). - return.diagnostics: Diagnostics; default: not declared - return.drawdownRisk: { probability: number; toFraction: number; }; default: not declared — `P(wealth ever falls to toFraction of the starting bankroll)` at the recommended fraction (continuous model). - return.drawdownRisk.probability: number; default: not declared - return.drawdownRisk.toFraction: number; default: not declared - return.fullKelly: number | null; default: not declared — `f*` — the growth-optimal fraction of bankroll. `null` when the edge has **no downside**, so log-growth increases without bound and there is no finite unconstrained optimum (finite-success law — never `Infinity`; a `risk.kelly_unbounded` diagnostic explains it). - return.gaussianKelly?: number; default: not declared — Returns path only: the Gaussian `μ/σ²` estimate, for comparison with the exact empirical `f*`. - return.growthRate: number | null; default: not declared — Expected per-period log-growth at the recommended fraction; `null` when there is none. - return.growthRateFull: number | null; default: not declared — Expected per-period log-growth at full Kelly (the maximum); `null` for a no-downside edge. - return.horizonGrowth?: { growthMultiple: number; horizonPeriods: number; logGrowth: number; }; default: not declared — Present when `horizonPeriods` is given: the median wealth projection over the horizonPeriods. - return.horizonGrowth.growthMultiple: number; default: not declared - return.horizonGrowth.horizonPeriods: number; default: not declared - return.horizonGrowth.logGrowth: number; default: not declared - return.periodsToDouble: number | null; default: not declared — `ln 2 / growthRate` — periods to double at the recommended fraction (`Infinity` when growth ≤ 0, `null` when there is no finite recommendation). - return.rationale: string; default: not declared — Prose an agent relays. - return.recommendedFraction: number | null; default: not declared — The recommended fraction after the fractional/drawdown/max caps (≥ 0). `null` only for a no-downside edge with **no** explicit cap — a finite recommendation then requires a `maxFraction`. ### @insiderfinance/totalfinance/risk#linkAttribution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Link single-period Brinson attributions across time with **Cariño's** logarithmic coefficients, so the cumulative allocation / selection / interaction sum **exactly** to the compounded (geometric) active return — the property the naive arithmetic sum lacks. Each period's effects are scaled by `βₜ = kₜ/k`; per-segment effects are linked with the same `βₜ`. See `docs/specs/attribution-linking.md`. ```typescript export declare function linkAttribution(periods: AttributionPeriod[], options?: LinkAttributionOptions): LinkedAttribution; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: LinkAttributionOptions; default: not declared - (options).method?: 'carino'; default: not declared — Linking method; default (and currently only) `'carino'`. - (periods): AttributionPeriod[]; default: not declared - return.activeReturn: number; default: not declared — `portfolioReturn − benchmarkReturn` (the geometric active return). - return.allocation: number; default: not declared — Linked cumulative effects — `allocation + selection + interaction = activeReturn`, exact. - return.assumptions: { conventionsVersion: string; method: LinkMethod; periods: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'carino'; default: not declared - return.assumptions.periods: number; default: not declared - return.benchmarkReturn: number; default: not declared — Compounded benchmark return `∏(1+Bₜ) − 1`. - return.diagnostics: Diagnostics; default: not declared - return.interaction: number; default: not declared - return.linkingCoefficients: LinkingCoefficient[]; default: not declared — The per-period linking coefficient `βₜ` (with the period `label` when supplied). - return.method: 'carino'; default: not declared - return.portfolioReturn: number; default: not declared — Compounded portfolio return `∏(1+Pₜ) − 1`. - return.segments?: SegmentEffect[]; default: not declared — Linked per-segment effects — present only when every period supplied segments. - return.selection: number; default: not declared ### @insiderfinance/totalfinance/risk#liquidity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Liquidity approximation: days to liquidate each position when trading at most `participation` of its average daily volume (default 20%), plus the slowest name's horizonPeriods for the whole book. ```typescript export declare function liquidity(positions: readonly LiquidityPosition[], options?: { participation?: number; }): LiquidityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { participation?: number; }; default: not declared - (options).participation?: number; default: not declared - (positions): readonly LiquidityPosition[]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.perAsset: { daysToLiquidate: number; averageDailyVolumeMultiple: number; }[]; default: not declared - return.portfolioDaysToLiquidate: number; default: not declared — Days to fully unwind the book trading each name at `participation` of its ADV (the slowest name). ### @insiderfinance/totalfinance/risk#margin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Margin approximation from signed position notionals and account equity: gross/net/long/short exposure, Reg-T-style initial (default 50%) and maintenance (default 25%) requirements, gross leverage, and a maintenance-met flag. ```typescript export declare function margin(positionNotionals: ArrayLike, options: { equity: number; initialRate?: number; maintenanceRate?: number; }): MarginResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { equity: number; initialRate?: number; maintenanceRate?: number; }; default: not declared - (options).equity: number; default: not declared - (options).initialRate?: number; default: not declared - (options).maintenanceRate?: number; default: not declared - (positionNotionals): ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.grossExposure: number; default: not declared - return.initialMargin: number; default: not declared — Initial (Reg-T-style) margin requirement: `initialRate · gross`. - return.leverage: number; default: not declared — Gross leverage `gross / equity`. - return.longExposure: number; default: not declared - return.maintenanceMargin: number; default: not declared — Maintenance margin requirement: `maintenanceRate · gross`. - return.meetsMaintenance: boolean; default: not declared — Whether `equity ≥ maintenanceMargin`. - return.netExposure: number; default: not declared - return.shortExposure: number; default: not declared — Short exposure as a positive magnitude. ### @insiderfinance/totalfinance/risk#marketImpact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain impact cost; use `marketImpact.explain(...)` for the coefficient and diagnostics. ```typescript export declare const marketImpact: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: MarketImpactInput, options?: { coefficient?: number; } | undefined], number, { coefficient: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [input: MarketImpactInput, options?: { coefficient?: number; } | undefined]; default: not declared - explain: (input: MarketImpactInput, options?: { coefficient?: number; } | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ coefficient: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [input: MarketImpactInput, options?: { coefficient?: number; } | undefined]; default: not declared ### @insiderfinance/totalfinance/risk#maxSharpe Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function maxSharpe(input: MaxSharpeInput): OptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MaxSharpeInput; default: not declared - (input).covariance: Matrix; default: not declared - (input).mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - (input).options?: MaxSharpeOptions; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.objective: number; default: not declared - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#meanExcessPlot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The **mean-excess plot** — the standard tool for choosing the EVT peaks-over-threshold cutoff the rest of the pack takes as an input. The mean-excess `e(u) = E[X − u | X > u]` is linear in `u` (slope `ξ/(1−ξ)`) above the true tail threshold and non-linear below it, so the threshold is read off as where the curve straightens. Returns the curve, a heuristic `suggestedThreshold`, the `tailIndexEstimate` from that region's slope, and the `suggestedTailFraction` to hand to {@link fitGeneralizedParetoTail}. See `docs/specs/mean-excess-plot.md`. ```typescript export declare function meanExcessPlot(returns: ArrayLike, options?: MeanExcessPlotOptions): MeanExcessPlot; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: MeanExcessPlotOptions; default: not declared - (options).gridSize?: number; default: not declared — Auto-grid point count. Default 25. - (options).linearTolerance?: number; default: not declared — Normalized deviation below which the mean-excess counts as linear. Default 0.1. - (options).minExceedances?: number; default: not declared — Minimum exceedances the top threshold retains (and the fit-reliability floor). Default 10. - (options).startQuantile?: number; default: not declared — Auto-grid lower bound as a loss quantile in (0, 1). Default 0.5 (the median loss). - (options).thresholds?: number[]; default: not declared — Explicit candidate thresholds (loss units); else an auto grid. - (returns): ArrayLike; default: not declared - return.assumptions: { conventionsVersion: string; losses: number; observations: number; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.losses: number; default: not declared - return.assumptions.observations: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.points: MeanExcessPoint[]; default: not declared - return.suggestedTailFraction: number; default: not declared — `Nu(suggestedThreshold)/n` — hand to `fitGeneralizedParetoTail({ tailFraction })`. - return.suggestedThreshold: number; default: not declared — Heuristic tail-onset threshold — the lowest `u` above which `e(·)` is ~linear. - return.tailIndexEstimate: number; default: not declared — `ξ` from the slope over `[suggestedThreshold, uₘₐₓ]`: `ξ = slope/(1+slope)`. ### @insiderfinance/totalfinance/risk#meanReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-asset arithmetic mean returns from observations-major history — the `mu` for `maxSharpe({ mean, covariance })` / `meanVariance({ mean, covariance })`. Kept deliberately small: it is the journey-completing helper, not a statistics suite (see `@insiderfinance/totalfinance/math` for that). ```typescript export declare function meanReturns(input: MeanReturnsInput): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MeanReturnsInput; default: not declared - (input).periodsPerYear?: number; default: not declared — Annualize by this factor (e.g. `252` for daily data): reported means become `periodMean × periodsPerYear`. OMITTED means per-period means — annualization is never silent (spec Law 6). - (input).returns: number[][]; default: not declared — Observations-major returns — same orientation as {@link CovarianceInput}. ### @insiderfinance/totalfinance/risk#meanVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function meanVariance(input: MeanVarianceInput): OptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MeanVarianceInput; default: not declared - (input).covariance: Matrix; default: not declared - (input).mean: ArrayLike; default: not declared — Dense stored-data ArrayLike; values are snapshotted without coercion. - (input).options?: MeanVarianceOptions; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.objective: number; default: not declared - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#minVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Global minimum-variance portfolio. `value.objective` is the portfolio variance `wᵀΣw`. ```typescript export declare function minVariance(covariance: Matrix, constraints?: OptimizeConstraints): OptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (constraints)?: OptimizeConstraints; default: not declared - (constraints).bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - (constraints).budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - (constraints).groups?: GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - (constraints).longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - (constraints).maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - (constraints).tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - (constraints).transactionCosts?: { perUnitTurnover: number | number[]; previousWeights: number[]; }; default: not declared — Linear transaction cost charged on the trade away from a base portfolio. Subtracted from the objective as `Σ perUnitTurnover_i·|w_i − previousWeights_i|` (a scalar applies to every asset). Needs `previousWeights`. - (constraints).transactionCosts.perUnitTurnover: number | number[]; default: not declared - (constraints).transactionCosts.previousWeights: number[]; default: not declared - (constraints).turnover?: TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - (covariance): Matrix; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.objective: number; default: not declared - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#nakedCallMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain per-contract requirement; use `.explain()` for the applied Reg-T knobs. ```typescript export declare const nakedCallMargin: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: NakedMarginInput, options?: NakedMarginOptions | undefined], number, { multiplier: number; equityRate: number; floorRate: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [input: NakedMarginInput, options?: NakedMarginOptions | undefined]; default: not declared - explain: (input: NakedMarginInput, options?: NakedMarginOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [input: NakedMarginInput, options?: NakedMarginOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/risk#nakedPutMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain per-contract requirement; use `.explain()` for the applied Reg-T knobs. ```typescript export declare const nakedPutMargin: import('@insiderfinance/totalfinance/core').SeriesFacade<[input: NakedMarginInput, options?: NakedMarginOptions | undefined], number, { multiplier: number; equityRate: number; floorRate: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [input: NakedMarginInput, options?: NakedMarginOptions | undefined]; default: not declared - explain: (input: NakedMarginInput, options?: NakedMarginOptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ multiplier: number; equityRate: number; floorRate: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [input: NakedMarginInput, options?: NakedMarginOptions | undefined]; default: not declared ### @insiderfinance/totalfinance/risk#optionsMargin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Initial margin / buying-power for a single-underlying, single-expiry multi-leg option position (spec §15.3, product review §6). The expiration payoff is piecewise-linear, so the requirement is: - **long only** (all legs bought): the net debit paid (fully-paid, no additional margin); - **covered defined risk** (every short leg is offset — verticals, condors, butterflies): the max loss; - **uncovered short puts** (more short put contracts than long ones): the Reg-T naked-put requirement on the uncovered contracts + the max loss of the rest. A short put's loss is *bounded* (the underlying stops at 0), but bounded is not the same as covered: charging the whole `(strike − premium)` exercise value margins a margin account as if it were cash-secured, ~4× the Reg-T requirement one function away (`nakedPutMargin`). Opt into the cash-secured basis for a cash/IRA account with `putMarginBasis: 'cash-secured'`; - **undefined risk** (a net-short call leaves the upside unbounded): the Reg-T naked requirement summed over the short legs — a conservative strategy-based approximation (a portfolio-margin engine would net offsets more finely). Coverage is counted contract-for-contract per option type, pairing the highest strikes first, so a 1×1 spread is covered and the extra short in a 2×1 ratio is not. `maxLoss` is unaffected by the margin basis — it stays the position's true worst case at expiration. Pure and clock-free; premiums, strikes, and the underlier are explicit inputs. ```typescript export declare function optionsMargin(legs: readonly OptionMarginLeg[], options: OptionsMarginOptions): OptionsMarginResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (legs): readonly OptionMarginLeg[]; default: not declared - (options): OptionsMarginOptions; default: not declared - (options).equityRate?: number; default: not declared — Reg-T naked "equity" rate — the % of underlying (default 0.20). - (options).floorRate?: number; default: not declared — Reg-T naked floor rate — the % of underlying (calls) / strike (puts) minimum (default 0.10). - (options).multiplier?: number; default: not declared — Contract multiplier (default 100). - (options).putMarginBasis?: PutMarginBasis; default: not declared — Basis for UNCOVERED short puts. Default `'reg-t-naked'` — a margin account's actual requirement. Use `'cash-secured'` for a cash/IRA account, where the whole exercise value must be posted. Echoed in `assumptions.putMarginBasis`. - (options).spot: number; default: not declared — Current price of the underlying (> 0). - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.buyingPowerReduction: number; default: not declared — Buying-power reduction — what the account must set aside. Equals `initialMargin` for margin accounts; for a long-only (fully-paid) position it is the net debit paid. - return.definedRisk: boolean; default: not declared — True when the position's loss is capped (spreads / condors / butterflies / long options). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.initialMargin: number; default: not declared — Initial margin / buying-power requirement, in account currency. - return.maxLoss: number | null; default: not declared — Worst-case expiration loss magnitude per contract; `null` when the loss is unbounded (e.g. a naked call — no finite worst case exists; `Infinity` is not JSON-safe, Law 7). `definedRisk: false` is the primary unbounded discriminant, and a `risk.unbounded_loss` warning explains the null. - return.method: 'reg-t-naked' | 'defined-risk-max-loss' | 'reg-t-naked-put' | 'long-premium'; default: not declared — How the requirement was derived. `'reg-t-naked-put'` is the bounded-but-uncovered case: the loss IS capped (a put's underlying stops at 0), but the position is short naked puts, so the requirement is the Reg-T naked-put charge on the uncovered contracts plus the capped max loss of whatever remains — not the cash-secured exercise value. - return.netDebit: number; default: not declared — Net debit paid (> 0) or credit received (< 0), per contract. ### @insiderfinance/totalfinance/risk#parameterSweepDiagnostics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Summarize a parameter sweep: given the per-trial Sharpes and the sample statistics of the *selected* (best) configuration's return series, report the dispersion of the trials and the deflated Sharpe — the honest probability the winner is real rather than the luckiest of many. ```typescript export declare function parameterSweepDiagnostics(trialSharpes: ArrayLike, selected: SharpeStatistics): ParameterSweepResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (selected): SharpeStatistics; default: not declared - (selected).kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - (selected).observations: number; default: not declared — Number of observations. - (selected).sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - (selected).skewness: number; default: not declared — Skewness `γ₃` of the returns. - (trialSharpes): ArrayLike; default: not declared - return.bestSharpe: number; default: not declared - return.deflatedSharpe: number | null; default: not declared — `null` when the selected statistics carry no Sharpe (a zero-variance series). - return.expectedMaxSharpe: number; default: not declared — Expected maximum Sharpe under the null (the deflation benchmark `SR₀`). - return.meanSharpe: number; default: not declared - return.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR of the selected configuration; `null` with `deflatedSharpe`. - return.trialCount: number; default: not declared - return.varianceSharpe: number; default: not declared ### @insiderfinance/totalfinance/risk#pca Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Principal-component analysis of a covariance (or, with `correlation`, the standardized) matrix. ```typescript export declare function pca(covariance: Matrix, options?: { correlation?: boolean; }): PcaResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (options)?: { correlation?: boolean; }; default: not declared - (options).correlation?: boolean; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.components: PcaComponent[]; default: not declared — Components sorted by descending eigenvalue. - return.cumulativeVariance: number[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.eigenvalues: number[]; default: not declared - return.loadings: number[][]; default: not declared — `loadings[k]` = the k-th component's eigenvector. - return.totalVariance: number; default: not declared — Sum of eigenvalues (= trace of the input matrix). - return.varianceExplained: number[]; default: not declared ### @insiderfinance/totalfinance/risk#portfolioVaR Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function portfolioVaR(input: PortfolioVaRInput): PortfolioVaROutput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PortfolioVaRInput; default: not declared - (input).method: 'historical'; default: not declared - (input).options?: HistoricalPortfolioVaROptions; default: not declared - (input).returns: ArrayLike>; default: not declared - (input).weights: ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.componentVaR: number[]; default: not declared — Per-asset component VaR; Σ component = total VaR (zero-mean case). - return.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - return.confidence: number; default: not declared - return.cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — the one warnings channel. Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.horizonPeriods: number; default: not declared - return.marginalVaR: number[]; default: not declared — Per-asset marginal VaR (∂VaR/∂w_i). - return.method: VaRMethod; default: not declared - return.observations: number; default: not declared — The number of portfolio-return observations the empirical tail was read from. - return.samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. The number of simulated samples actually drawn (always echoed). - return.seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). The PRNG seed actually used (always echoed for reproducibility). - return.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#portfolioVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Portfolio variance `wᵀΣw` (H07 contract): every weight and covariance cell validated finite, Σ numerically symmetric with a non-negative diagonal, a materially negative quadratic form rejected (`linalg.not_positive_definite`), and only the tiny documented floating-point tolerance (see {@link quadFormNonNegative}) clamped to 0. ```typescript export declare function portfolioVariance(weights: ArrayLike, covariance: Matrix): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (weights): ArrayLike; default: not declared ### @insiderfinance/totalfinance/risk#portfolioVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Portfolio volatility `√(wᵀΣw)` — H08: delegates to H07's variance kernel, validating under its own name. ```typescript export declare function portfolioVolatility(weights: ArrayLike, covariance: Matrix): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (weights): ArrayLike; default: not declared ### @insiderfinance/totalfinance/risk#probabilisticSharpeRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain probability; use `.explain()` for the benchmark and observation count. ```typescript export declare const probabilisticSharpeRatio: import('@insiderfinance/totalfinance/core').SeriesFacade<[stats: SharpeStatistics, benchmarkSharpe?: number | undefined], number | null, { benchmarkSharpe: number; observations: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [stats: SharpeStatistics, benchmarkSharpe?: number | undefined]; default: not declared - explain: (stats: SharpeStatistics, benchmarkSharpe?: number | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ benchmarkSharpe: number; observations: number; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [stats: SharpeStatistics, benchmarkSharpe?: number | undefined]; default: not declared ### @insiderfinance/totalfinance/risk#probabilityOfBacktestOverfitting Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). **Probability of backtest overfitting** (Bailey & López de Prado's CSCV). Given a `T × N` matrix of per-period returns — `T` time observations (rows) × `N` strategy configurations you selected among (columns) — split the rows into `S` blocks, and over **every** `C(S, S/2)` symmetric partition into an in-sample and an out-of-sample half: pick the IS-best configuration, then measure its OOS rank. PBO is the fraction of splits where the IS winner lands **below the OOS median** — the probability that picking the best backtest buys you a below-average live result. `≈ 0.5` means the selection is worthless out of sample; `≈ 0` means a genuinely persistent edge. Depends only on `@insiderfinance/totalfinance/core`/`math`. ```typescript export declare function probabilityOfBacktestOverfitting(returns: number[][], options?: BacktestOverfittingProbabilityOptions): BacktestOverfittingProbabilityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: BacktestOverfittingProbabilityOptions; default: not declared - (options).splits?: number; default: not declared — Number of disjoint contiguous row-blocks `S` (even, `4 ≤ S ≤ 16`). Default `16` (Bailey & López de Prado). The `C(S, S/2)` train/test splits grow fast in `S`; the observation count is trimmed to a multiple of `S` (the oldest rows dropped). - (returns): number[][]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.backtestOverfittingProbability: number; default: not declared — Probability of backtest overfitting: the fraction of the `C(S, S/2)` symmetric train/test splits on which the in-sample-best configuration ranks **below the out-of-sample median** (logit `λ < 0`). Near `0.5` for noise (selection is worthless out of sample), near `0` for a genuinely persistent edge. - return.combinations: number; default: not declared — Number of symmetric train/test splits evaluated: `C(S, S/2)`. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.medianLogit: number; default: not declared — Median logit `λ = ln(r̄/(1−r̄))` across the splits (`r̄` = OOS relative rank of the IS-best); `< 0` ⇒ overfit-leaning. - return.observations: number; default: not declared — Observations (rows) used after trimming to a multiple of `S`. - return.splits: number; default: not declared — Blocks `S` actually used. - return.trials: number; default: not declared — Number of strategy configurations (columns) `N`. ### @insiderfinance/totalfinance/risk#purgedKFold Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Purged & embargoed K-fold cross-validation (López de Prado, *Advances in Financial ML* ch. 7). Each fold's test set is a contiguous block; training drops any observation within `purgeGap` of the test block (label-overlap purge) and within the trailing `embargo·n` window after it. Throws a typed `input.out_of_range` naming the largest viable `purgeGap` when the requested purge (with the embargo) would leave a fold with an empty training set — an unusable split is an error, not an empty array to be discovered downstream. ```typescript export declare function purgedKFold(observationCount: number, options: PurgedKFoldOptions): Split[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (observationCount): number; default: not declared - (options): PurgedKFoldOptions; default: not declared - (options).embargo?: number; default: not declared — Fraction of `n` to embargo after each test fold (default 0). - (options).folds: number; default: not declared — Number of folds (≥ 2). - (options).purgeGap?: number; default: not declared — Observations to purge on each side of a test fold (label-overlap buffer; default 0). ### @insiderfinance/totalfinance/risk#researchProtocol Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Render a statistically honest verdict on a research process — deflate for selection, confirm out-of-sample, and conclude `significant` / `inconclusive` / `likely-overfit`. See the spec. ```typescript export declare function researchProtocol(input: ResearchProtocolInput): ResearchVerdict; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ResearchProtocolInput; default: not declared - (input).confidence?: number; default: not declared — Confidence for "significant" in (0, 1); default 0.95. - (input).outOfSampleReturns?: ArrayLike; default: not declared — Out-of-sample (e.g. walk-forward) returns of the SAME strategy — confirmatory. - (input).periodsPerYear?: number; default: not declared — Periods per year for the annualized read-outs; default 252. - (input).returns: ArrayLike; default: not declared — The selected strategy's in-sample return series (per period). - (input).riskFreeRate?: number; default: not declared - (input).trials?: { trialSharpes: ArrayLike; } | { trialCount: number; varianceSharpe: number; }; default: not declared — The pool that produced the selection, for deflation. Omit for a single pre-registered hypothesis (no selection → SR₀ = 0). `trialSharpes` are the per-observation Sharpes of every config tried. - (input).trials.trialCount: number; default: not declared - (input).trials.trialSharpes: ArrayLike; default: not declared - (input).trials.varianceSharpe: number; default: not declared - return.assumptions: { confidence: number; conventionsVersion: string; periodsPerYear: number; }; default: not declared - return.assumptions.confidence: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.periodsPerYear: number; default: not declared - return.deflatedSharpe: number | null; default: not declared — Probability the true Sharpe beats the selection-adjusted benchmark SR₀; `null` with `inSample.sharpe`. - return.diagnostics: Diagnostics; default: not declared - return.expectedMaxSharpe: number; default: not declared — SR₀ — the expected-max Sharpe of `trialCount` under the null (0 for a single hypothesis). - return.inSample: { annualizedSharpe: number | null; observations: number; sharpe: number | null; }; default: not declared — Sharpe figures are `null` (C hygiene) when the returns have zero variance; the verdict is then `inconclusive`. - return.inSample.annualizedSharpe: number | null; default: not declared - return.inSample.observations: number; default: not declared - return.inSample.sharpe: number | null; default: not declared - return.minTrackRecordLength: number; default: not declared — Observations needed for `deflatedSharpe ≥ confidence` (`Infinity` when SR ≤ SR₀). - return.outOfSample?: { annualizedSharpe: number | null; degradation: number | null; sharpe: number | null; }; default: not declared — Present when out-of-sample returns are given; `null` figures when either series has zero variance. - return.outOfSample.annualizedSharpe: number | null; default: not declared - return.outOfSample.degradation: number | null; default: not declared - return.outOfSample.sharpe: number | null; default: not declared - return.probabilisticSharpe: number | null; default: not declared — Un-deflated PSR (benchmark 0), for comparison; `null` with `inSample.sharpe`. - return.rationale: string; default: not declared — Prose an agent relays. - return.trialCount: number; default: not declared - return.verdict: 'significant' | 'inconclusive' | 'likely-overfit'; default: not declared ### @insiderfinance/totalfinance/risk#riskContributions Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-asset volatility risk contributions (H10 report). A zero-volatility portfolio has no defined marginal/component/fraction — those rows carry `null` with a degenerate-input warning naming the fields, never fabricated zeros. ```typescript export declare function riskContributions(weights: ArrayLike, covariance: Matrix): RiskContributionsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (weights): ArrayLike; default: not declared - return.assumptions: { assets: number; conventionsVersion: string; }; default: not declared - return.assumptions.assets: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.contributions: RiskContributionRow[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.portfolioVolatility: number; default: not declared ### @insiderfinance/totalfinance/risk#riskParity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equal-risk-contribution (risk parity) portfolio. ```typescript export declare function riskParity(covariance: Matrix, options?: { budget?: number; maximumIterations?: number; tolerance?: number; }): OptimizeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (covariance): Matrix; default: not declared - (options)?: { budget?: number; maximumIterations?: number; tolerance?: number; }; default: not declared - (options).budget?: number; default: not declared - (options).maximumIterations?: number; default: not declared - (options).tolerance?: number; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ objective: string; budget: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: { objective: number; weights: number[]; }; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - return.value.objective: number; default: not declared - return.value.weights: number[]; default: not declared ### @insiderfinance/totalfinance/risk#scenario Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a named scenario from shocks. Each shock is validated at build time (use the `shock.*` constructors — they produce exactly this shape), so a malformed shock fails here with a typed error instead of deep inside the Taylor engine. ```typescript export declare function scenario(name: string, ...shocks: Shock[]): Scenario; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared - (shocks): Shock[]; default: not declared - return.name: string; default: not declared - return.shocks: Shock[]; default: not declared ### @insiderfinance/totalfinance/risk#scenarioGrid Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 2-D scenario grid (H12 report): P&L (per unit) of one position's Greeks across a Cartesian product of spot and vol shocks. A serialized result is self-interpreting — both axes carry their resolved shock semantics beside the cells, so a detached matrix never travels alone. ```typescript export declare function scenarioGrid(input: ScenarioGridInput): ScenarioGridResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ScenarioGridInput; default: not declared - (input).greeks: PositionGreeks; default: not declared - (input).spotShocks: readonly Shock[]; default: not declared - (input).volatilityShocks: readonly Shock[]; default: not declared - return.assumptions: { conventionsVersion: string; greekUnits: typeof GREEK_UNITS; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.greekUnits: { readonly phi: 'per1Percent'; readonly rho: import('@insiderfinance/totalfinance/core').RhoUnit; readonly theta: import('@insiderfinance/totalfinance/core').ThetaUnit; readonly vega: import('@insiderfinance/totalfinance/core').VegaUnit; }; default: not declared - return.assumptions.greekUnits.phi: 'per1Percent'; default: not declared - return.assumptions.greekUnits.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - return.assumptions.greekUnits.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - return.assumptions.greekUnits.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.pnl: number[][]; default: not declared — `pnl[i][j]` = P&L per unit at `spotAxis[i]` × `volatilityAxis[j]`. - return.spotAxis: ResolvedGridShock[]; default: not declared - return.volatilityAxis: ResolvedGridShock[]; default: not declared ### @insiderfinance/totalfinance/risk#sharpeStatistics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sample Sharpe statistics of a return series: the per-observation (non-annualized) Sharpe plus the skewness and (non-excess) kurtosis that the probabilistic-Sharpe adjustment needs. ```typescript export declare function sharpeStatistics(returns: ArrayLike, options?: { riskFreeRate?: number; }): SharpeStatisticsReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { riskFreeRate?: number; }; default: not declared - (options).riskFreeRate?: number; default: not declared - (returns): ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.kurtosis: number; default: not declared — Non-excess kurtosis `γ₄` of the returns (3 for a normal distribution). - return.observations: number; default: not declared — Number of observations. - return.sharpe: number | null; default: not declared — Per-observation Sharpe ratio `mean(excess)/std` (NOT annualized). `null` (C hygiene) when the returns have zero variance: there is no dispersion to scale by, and the report says so. - return.skewness: number; default: not declared — Skewness `γ₃` of the returns. ### @insiderfinance/totalfinance/risk#shock Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Typed shock constructors. Strings carry units; raw numbers are absolute. ```typescript export declare const shock: { dividend(change: string | number): Shock; factor(name: string, change: string | number): Shock; riskFreeRate(change: string | number): Shock; spot(change: string | number): Shock; time(years: number): Shock; volatility(change: string | number): Shock; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividend: (change: string | number) => Shock; default: not declared — Dividend-yield move: `'+50bp'` ⇒ +0.005, or a raw `0.005`. Drives the first-order carry term `ε·dq`. Percent (`'%'`) dividend moves are rejected by the Taylor engine — it has no reference dividend level to scale against. - dividend().return.factor: string; default: not declared - dividend().return.kind: ShockKind; default: not declared - dividend().return.value: number; default: not declared - dividend(change): string | number; default: not declared - factor: (name: string, change: string | number) => Shock; default: not declared — A custom named factor shock. Percent (`'%'`) moves resolve only for `'spot'` in the Taylor engine; a custom `reprice` fn receives the raw scenario and may interpret `%` itself. - factor().return.factor: string; default: not declared - factor().return.kind: ShockKind; default: not declared - factor().return.value: number; default: not declared - factor(change): string | number; default: not declared - factor(name): string; default: not declared - riskFreeRate: (change: string | number) => Shock; default: not declared — Rate move: `'+50bp'` ⇒ +0.005, or a raw `0.005`. Percent (`'%'`) rate moves are rejected by the Taylor engine — it has no reference rate to scale against. - riskFreeRate().return.factor: string; default: not declared - riskFreeRate().return.kind: ShockKind; default: not declared - riskFreeRate().return.value: number; default: not declared - riskFreeRate(change): string | number; default: not declared - spot: (change: string | number) => Shock; default: not declared — Spot move: `'-5%'` (relative) or `-5` (absolute price). - spot().return.factor: string; default: not declared - spot().return.kind: ShockKind; default: not declared - spot().return.value: number; default: not declared - spot(change): string | number; default: not declared - time: (years: number) => Shock; default: not declared — Time decay over `years` (e.g. `1/365` for one day). - time().return.factor: string; default: not declared - time().return.kind: ShockKind; default: not declared - time().return.value: number; default: not declared - time(years): number; default: not declared - volatility: (change: string | number) => Shock; default: not declared — Volatility move in absolute vol points (`'+10pts'` ⇒ +0.10) or a raw decimal (`0.10`). Percent (`'%'`) vol moves are rejected by the Taylor engine — it has no reference vol to scale against. - volatility().return.factor: string; default: not declared - volatility().return.kind: ShockKind; default: not declared - volatility().return.value: number; default: not declared - volatility(change): string | number; default: not declared ### @insiderfinance/totalfinance/risk#shrunkKelly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Estimation-error-shrunk portfolio Kelly. The plug-in weights `Σ̂⁻¹μ̂` overbet because `μ̂`/`Σ̂` are estimated from a finite sample; this scales them by the growth-optimal factor `c* = max(0, 1 − (n/T)/θ̂²)` (`θ̂² = μ̂ᵀΣ̂⁻¹μ̂`), returns a zero book when the estimated edge is indistinguishable from sampling noise (`n/T ≥ θ̂²`), and discloses the biased-vs-corrected Sharpe and the naive book's (often negative) expected out-of-sample growth. See `docs/specs/shrunk-kelly.md`. ```typescript export declare function shrunkKelly(input: ShrunkKellyInput): ShrunkKelly; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ShrunkKellyInput; default: not declared - (input).covariance: number[][]; default: not declared — Estimated covariance Σ̂ (n×n, symmetric positive-definite). - (input).fraction?: number; default: not declared — Extra fractional-Kelly multiplier applied on top of the estimation shrinkage (e.g. 0.5). Default 1. - (input).mean: number[]; default: not declared — Estimated per-period expected (excess) returns μ̂, one per asset. - (input).sampleSize: number; default: not declared — Number of observations T the estimates came from. Must be > 0. - return.appliedScaling: number; default: not declared — The applied scaling `fraction · c*`. - return.assumptions: { assets: number; conventionsVersion: string; fraction: number; sampleSize: number; }; default: not declared - return.assumptions.assets: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.fraction: number; default: not declared - return.assumptions.sampleSize: number; default: not declared - return.correctedSharpeSquared: number; default: not declared — Bias-corrected out-of-sample squared Sharpe `θ̂² − n/T` (may be ≤ 0). - return.diagnostics: Diagnostics; default: not declared - return.expectedGrowth: number; default: not declared — Expected out-of-sample log-growth at the applied scaling. - return.inSampleSharpeSquared: number; default: not declared — In-sample squared Sharpe `θ̂² = μ̂ᵀΣ̂⁻¹μ̂` (biased high). - return.naiveExpectedGrowth: number; default: not declared — Expected out-of-sample log-growth of the naive (unshrunk) book — often negative. - return.naiveWeights: number[]; default: not declared — Naive plug-in Kelly weights `Σ̂⁻¹μ̂` (before any shrinkage). - return.shrinkage: number; default: not declared — Estimation-error shrinkage factor `c* ∈ [0, 1]`. - return.weights: number[]; default: not declared — Shrunk Kelly weights `fraction · c* · Σ̂⁻¹μ̂`. ### @insiderfinance/totalfinance/risk#spectralRisk Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A coherent spectral risk measure (Acerbi): a weighted average of the loss quantiles with a non-decreasing weight on worse outcomes. Pass `{ riskAversion }` for the exponential spectrum `φ(p) = k·e^(−k(1−p))/(1−e^(−k))` (default `k = 10`), or `{ alpha }` for the Expected-Shortfall spectrum `φ(p) = 𝟙[p ≥ α]/(1−α)` — ES being the flat-tail special case. See the spec. ```typescript export declare function spectralRisk(returns: ArrayLike, options?: { riskAversion?: number; } | { alpha: number; }): SpectralRisk; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { riskAversion?: number; } | { alpha: number; }; default: not declared - (options).alpha: number; default: not declared - (options).riskAversion?: number; default: not declared - (returns): ArrayLike; default: not declared - return.alpha?: number; default: not declared — Level `α` for the Expected-Shortfall spectrum. - return.assumptions: { conventionsVersion: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.riskAversion?: number; default: not declared — Risk-aversion `k` for the exponential spectrum. - return.spectrum: 'exponential' | 'expected-shortfall'; default: not declared - return.value: number; default: not declared — The spectral risk measure — a positive loss magnitude. ### @insiderfinance/totalfinance/risk#stressTest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Stress a positions book across scenarios (H11 report): per-scenario and per-position P&L. ```typescript export declare function stressTest(input: StressTestInput): StressTestResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): StressTestInput; default: not declared - (input).options?: StressOptions; default: not declared - (input).positions: readonly Position[]; default: not declared - (input).scenarios: readonly Scenario[]; default: not declared - return.assumptions: { conventionsVersion: string; positions: number; scenarios: number; valuation: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.positions: number; default: not declared - return.assumptions.scenarios: number; default: not declared - return.assumptions.valuation: string; default: not declared — Book-level valuation summary: 'greeks-taylor' | 'reprice' | 'mixed'. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.scenarios: ScenarioResult[]; default: not declared ### @insiderfinance/totalfinance/risk#survivorshipWarning Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Return a survivorship-bias warning when the backtest universe excludes delisted names or is not point-in-time — both bias results upward — or `null` when neither concern applies. ```typescript export declare function survivorshipWarning(context: SurvivorshipContext): QuantWarning | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (context): SurvivorshipContext; default: not declared - (context).includesDelisted?: boolean; default: not declared — Whether delisted / inactive instruments are included in the backtest universe. - (context).pointInTimeUniverse?: boolean; default: not declared — Whether the universe is point-in-time (members as they were on each date). - return.code: string; default: not declared - return.context?: Record; default: not declared - return.message: string; default: not declared - return.severity: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared ### @insiderfinance/totalfinance/risk#taylorPnl Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Greeks-Taylor P&L of a single position's Greeks under a scenario (per unit). ```typescript export declare function taylorPnl(greeks: PositionGreeks, scenario: Scenario): TaylorPnlResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (greeks): PositionGreeks; default: not declared - (greeks).charm?: number; default: not declared — ∂Δ/∂T per year of time-to-expiry — the options package's `charm` (delta drift as expiry recedes). Optional. - (greeks).color?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - (greeks).delta?: number; default: not declared — ∂V/∂S per $1 of spot. - (greeks).deltaRate?: number; default: not declared — ∂²V/∂S∂r per $ per 1% rate — the spot-rate cross (`∂Δ/∂r`). Optional. - (greeks).gamma?: number; default: not declared — ∂²V/∂S² per $1². - (greeks).lambda?: number | null; default: not declared — Accepted from a whole `ExtendedGreeks` (`null` = elasticity undefined); not used by the expansion. - (greeks).phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield — the options package's `phi` (dividend rho). Optional. - (greeks).rho?: number; default: not declared — ∂V/∂r per 1% rate (0.01), as the options package reports it. - (greeks).rhoConvexity?: number; default: not declared — ∂²V/∂r² per (1%)² — rho convexity. Optional. - (greeks).speed?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - (greeks).spot?: number; default: not declared — Reference spot, required to resolve percent spot shocks into price moves. - (greeks).theta?: number; default: not declared — ∂V/∂t per CALENDAR DAY (negative for a long option), as the options package reports it. - (greeks).thetaConvexity?: number; default: not declared — ∂²V/∂t² per calendar day² — theta convexity (theta's own bleed). Optional. - (greeks).thetaRate?: number; default: not declared — ∂²V/∂t∂r per calendar day per 1% rate — the time-rate cross (`∂Θ/∂r`). Optional. - (greeks).ultima?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - (greeks).value: number; default: not declared — Current mark value of the position (per unit). - (greeks).vanna?: number; default: not declared — ∂²V/∂S∂σ per 1.00 σ per $ — the options package's `vanna`. Optional — omitted ⇒ its term is 0. - (greeks).vega?: number; default: not declared — ∂V/∂σ per 1 volatility point (0.01), as the options package reports it. - (greeks).vera?: number; default: not declared — ∂²V/∂σ∂r per 1.00 σ per 1.00 rate — the options package's `vera`. Optional. - (greeks).veta?: number; default: not declared — ∂vega/∂T per year of time-to-expiry, vega per 1.00 σ — the options package's `veta`. Optional. - (greeks).vomma?: number; default: not declared — ∂²V/∂σ² per 1.00 σ² — the options package's `vomma`. Optional. - (greeks).zomma?: number; default: not declared — Accepted from a whole `ExtendedGreeks`; not used by the second-order expansion. - (scenario): Scenario; default: not declared - (scenario).name: string; default: not declared - (scenario).shocks: Shock[]; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - return.delta: number; default: not declared - return.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.gamma: number; default: not declared - return.other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - return.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - return.rho: number; default: not declared - return.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - return.theta: number; default: not declared - return.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - return.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - return.total: number; default: not declared - return.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - return.vega: number; default: not declared - return.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - return.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - return.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). ### @insiderfinance/totalfinance/risk#valueAtRisk Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). VaR (positive loss magnitude) for a single return/P&L series. Plain call → the number; `.explain()` → the Computed envelope echoing confidence/method/horizonPeriods (dx §2.4: the applied `confidence: 0.95` default is disclosed, never hidden). ```typescript export declare const valueAtRisk: import('@insiderfinance/totalfinance/core').SeriesFacade<[returns: ArrayLike, options?: VaROptions | undefined], number, ValueAtRiskAssumptionExtras>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [returns: ArrayLike, options?: VaROptions | undefined]; default: not declared - explain: (returns: ArrayLike, options?: VaROptions | undefined) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [returns: ArrayLike, options?: VaROptions | undefined]; default: not declared ### @insiderfinance/totalfinance/risk#valueAtRiskReport Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Full VaR + CVaR report for a single return/P&L series. ```typescript export declare function valueAtRiskReport(returns: ArrayLike, options?: VaROptions): VaRResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: VaROptions; default: not declared - (options).confidence?: number; default: not declared — Confidence level in (0, 1). Default 0.95. - (options).cornishFisher?: boolean; default: not declared — Parametric only: Cornish-Fisher adjustment for skew/excess-kurtosis. Default false. Applied only where the expansion is a monotone quantile map; outside that domain the plain Gaussian quantile is reported with a `risk.cornish_fisher_out_of_domain` warning and `cornishFisher: false`. Over a multi-period `horizonPeriods` the moments are rescaled to the horizon under iid aggregation (`skew/√h`, `excessKurtosis/h`), disclosed as `assumptions.momentScaling: 'iid'`. On a non-parametric method it is ignored with an info warning, never silently. - (options).horizonPeriods?: number; default: not declared — Holding-period horizonPeriods in periods; scales by √-time. Default 1. - (options).method?: VaRMethod; default: not declared — Estimation method. Default `'historical'`. - `'historical'` — the empirical (hyndman-fan-7) tail quantile of the sample; - `'parametric'` — the Gaussian quantile of the fitted (μ, σ), optionally Cornish-Fisher; - `'monteCarlo'` — draws from the **fitted NORMAL** and takes its empirical tail. It captures no non-normality whatsoever (same two moments as `'parametric'`, plus sampling noise), so prefer `'parametric'` unless you specifically want sampling diagnostics; use `'historical'` or the EVT tools when the shape of the tail matters. - (options).samples?: number; default: not declared — Monte-Carlo only: number of simulated paths. Default 10000. - (options).seed?: number; default: not declared — Monte-Carlo only: PRNG seed for reproducibility. Default 1. - (returns): ArrayLike; default: not declared - return.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.conditionalValueAtRisk: number; default: not declared — Conditional VaR / expected shortfall (mean loss beyond VaR); ≥ `var`. - return.confidence: number; default: not declared - return.cornishFisher?: boolean; default: not declared — Whether the Cornish-Fisher adjustment was actually APPLIED to the VaR quantile (parametric only). `false` when it was requested but its expansion was out of domain — the plain Gaussian quantile was reported instead and a `risk.cornish_fisher_out_of_domain` warning says so. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). This is the ONE warnings channel: the legacy top-level `warnings` twin was removed pre-1.0 (two arrays that had to be kept in sync is a defect waiting to happen — a caller reading the stale one silently misses a disclosure). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.horizonPeriods: number; default: not declared - return.method: VaRMethod; default: not declared - return.samples?: number; default: not declared — Monte-Carlo only: the number of simulated samples actually drawn. - return.seed?: number; default: not declared — Monte-Carlo only: the PRNG seed actually used (echoed for reproducibility). - return.valueAtRisk: number; default: not declared — Positive loss magnitude at `confidence`. ### @insiderfinance/totalfinance/risk#walkForwardSplits Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Generate walk-forward (rolling or anchored) train/test splits over `n` ordered observations. ```typescript export declare function walkForwardSplits(observationCount: number, options: WalkForwardOptions): Split[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (observationCount): number; default: not declared - (options): WalkForwardOptions; default: not declared - (options).mode?: 'rolling' | 'anchored'; default: not declared — `rolling` (sliding train window) or `anchored` (train always starts at 0). Default `rolling`. - (options).step?: number; default: not declared — Step between successive folds (default `testSize`). - (options).testSize: number; default: not declared — Test window length. - (options).trainSize: number; default: not declared — Training window length (in observations). ## Entrypoint @insiderfinance/totalfinance/risk/factor ### @insiderfinance/totalfinance/risk/factor#FactorExposureResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#FactorExposureResult`. ### @insiderfinance/totalfinance/risk/factor#PcaComponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PcaComponent`. ### @insiderfinance/totalfinance/risk/factor#PcaResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PcaResult`. ### @insiderfinance/totalfinance/risk/factor#covarianceToCorrelation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#covarianceToCorrelation`. ### @insiderfinance/totalfinance/risk/factor#factorExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#factorExposure`. ### @insiderfinance/totalfinance/risk/factor#pca Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#pca`. ## Entrypoint @insiderfinance/totalfinance/risk/optimize ### @insiderfinance/totalfinance/risk/optimize#BlackLittermanOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BlackLittermanOptions`. ### @insiderfinance/totalfinance/risk/optimize#BlackLittermanResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BlackLittermanResult`. ### @insiderfinance/totalfinance/risk/optimize#BlackLittermanView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BlackLittermanView`. ### @insiderfinance/totalfinance/risk/optimize#CVaROptimizeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#CVaROptimizeOptions`. ### @insiderfinance/totalfinance/risk/optimize#CVaROptimizeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#CVaROptimizeResult`. ### @insiderfinance/totalfinance/risk/optimize#EfficientFrontierConstraints Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Frontier constraints are the shared feasible-region grammar. Linear transaction costs are an objective penalty, not a feasible-region constraint, and therefore belong in a direct `meanVariance` solve rather than a gross mean-variance frontier. ```typescript /** * Frontier constraints are the shared feasible-region grammar. Linear transaction costs are an * objective penalty, not a feasible-region constraint, and therefore belong in a direct * `meanVariance` solve rather than a gross mean-variance frontier. */ export type EfficientFrontierConstraints = Omit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: [number, number][]; default: not declared — Per-asset `[lo, hi]` bounds. - budget?: number; default: not declared — Sum-to budget (`Σw`). Default 1 (fully invested). - groups?: import('@insiderfinance/totalfinance/risk').GroupConstraint[]; default: not declared — Sector/group exposure caps (`min ≤ Σ_group w ≤ max`). - longOnly?: boolean; default: not declared — Forbid short positions (`w ≥ 0`). Ignored where `bounds` is given. - maximumIterations?: number; default: not declared — Projected-gradient iteration cap. Default 5000. - tolerance?: number; default: not declared — Projected-gradient convergence tolerance on the weight step. Default 1e-11. - turnover?: import('@insiderfinance/totalfinance/risk').TurnoverConstraint; default: not declared — Turnover budget against a base portfolio (`Σ|w − previousWeights| ≤ max`). - turnover.max: number; default: not declared — Maximum one-way + reverse (L1) turnover allowed. - turnover.previousWeights: number[]; default: not declared — Current weights to measure turnover against. ### @insiderfinance/totalfinance/risk/optimize#EfficientFrontierGrid Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#EfficientFrontierGrid`. ### @insiderfinance/totalfinance/risk/optimize#EfficientFrontierGridKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#EfficientFrontierGridKind`. ### @insiderfinance/totalfinance/risk/optimize#EfficientFrontierInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#EfficientFrontierInput`. ### @insiderfinance/totalfinance/risk/optimize#EfficientFrontierResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#EfficientFrontierResult`. ### @insiderfinance/totalfinance/risk/optimize#EfficientFrontierValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#EfficientFrontierValue`. ### @insiderfinance/totalfinance/risk/optimize#FrontierPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#FrontierPoint`. ### @insiderfinance/totalfinance/risk/optimize#FrontierPortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#FrontierPortfolio`. ### @insiderfinance/totalfinance/risk/optimize#GroupConstraint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#GroupConstraint`. ### @insiderfinance/totalfinance/risk/optimize#KellyInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#KellyInput`. ### @insiderfinance/totalfinance/risk/optimize#KellyOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#KellyOptions`. ### @insiderfinance/totalfinance/risk/optimize#MaxSharpeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#MaxSharpeInput`. ### @insiderfinance/totalfinance/risk/optimize#MaxSharpeOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MaxSharpeOptions`. ### @insiderfinance/totalfinance/risk/optimize#MeanVarianceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#MeanVarianceInput`. ### @insiderfinance/totalfinance/risk/optimize#MeanVarianceOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MeanVarianceOptions`. ### @insiderfinance/totalfinance/risk/optimize#OptimizeConstraints Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptimizeConstraints`. ### @insiderfinance/totalfinance/risk/optimize#OptimizeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptimizeResult`. ### @insiderfinance/totalfinance/risk/optimize#TurnoverConstraint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#TurnoverConstraint`. ### @insiderfinance/totalfinance/risk/optimize#blackLitterman Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#blackLitterman`. ### @insiderfinance/totalfinance/risk/optimize#conditionalValueAtRiskOptimize Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#conditionalValueAtRiskOptimize`. ### @insiderfinance/totalfinance/risk/optimize#efficientFrontier Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#efficientFrontier`. ### @insiderfinance/totalfinance/risk/optimize#hrp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#hrp`. ### @insiderfinance/totalfinance/risk/optimize#kelly Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#kelly`. ### @insiderfinance/totalfinance/risk/optimize#maxSharpe Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#maxSharpe`. ### @insiderfinance/totalfinance/risk/optimize#meanVariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#meanVariance`. ### @insiderfinance/totalfinance/risk/optimize#minVariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#minVariance`. ### @insiderfinance/totalfinance/risk/optimize#riskParity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#riskParity`. ## Entrypoint @insiderfinance/totalfinance/risk/portfolio ### @insiderfinance/totalfinance/risk/portfolio#AggregateGreeksResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#AggregateGreeksResult`. ### @insiderfinance/totalfinance/risk/portfolio#BetaWeightedDeltaResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BetaWeightedDeltaResult`. ### @insiderfinance/totalfinance/risk/portfolio#BetaWeightedPosition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BetaWeightedPosition`. ### @insiderfinance/totalfinance/risk/portfolio#ConcentrationResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ConcentrationResult`. ### @insiderfinance/totalfinance/risk/portfolio#ConcentrationValues Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ConcentrationValues`. ### @insiderfinance/totalfinance/risk/portfolio#LiquidityPosition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#LiquidityPosition`. ### @insiderfinance/totalfinance/risk/portfolio#LiquidityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#LiquidityResult`. ### @insiderfinance/totalfinance/risk/portfolio#MarginResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MarginResult`. ### @insiderfinance/totalfinance/risk/portfolio#MarketImpactInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MarketImpactInput`. ### @insiderfinance/totalfinance/risk/portfolio#MarketImpactResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MarketImpactResult`. ### @insiderfinance/totalfinance/risk/portfolio#NakedMarginInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#NakedMarginInput`. ### @insiderfinance/totalfinance/risk/portfolio#NakedMarginOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#NakedMarginOptions`. ### @insiderfinance/totalfinance/risk/portfolio#NakedMarginResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#NakedMarginResult`. ### @insiderfinance/totalfinance/risk/portfolio#OptionMarginLeg Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptionMarginLeg`. ### @insiderfinance/totalfinance/risk/portfolio#OptionsMarginOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptionsMarginOptions`. ### @insiderfinance/totalfinance/risk/portfolio#OptionsMarginResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptionsMarginResult`. ### @insiderfinance/totalfinance/risk/portfolio#PortfolioGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PortfolioGreeks`. ### @insiderfinance/totalfinance/risk/portfolio#PutMarginBasis Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How an UNCOVERED short put is margined: - `'reg-t-naked'` (default) — the Reg-T naked-put requirement, i.e. {@link nakedPutMargin}; - `'cash-secured'` — the full expiration max loss `(strike − premium)·multiplier`, i.e. the cash a cash-secured seller must post. That is ~4× the Reg-T number and is what a retail-cash account (or an IRA) actually needs. ```typescript /** * How an UNCOVERED short put is margined: * - `'reg-t-naked'` (default) — the Reg-T naked-put requirement, i.e. {@link nakedPutMargin}; * - `'cash-secured'` — the full expiration max loss `(strike − premium)·multiplier`, i.e. the * cash a cash-secured seller must post. That is ~4× the Reg-T number and is what a * retail-cash account (or an IRA) actually needs. */ export type PutMarginBasis = 'reg-t-naked' | 'cash-secured'; ``` ### @insiderfinance/totalfinance/risk/portfolio#aggregateGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#aggregateGreeks`. ### @insiderfinance/totalfinance/risk/portfolio#betaWeightedDelta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#betaWeightedDelta`. ### @insiderfinance/totalfinance/risk/portfolio#concentration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#concentration`. ### @insiderfinance/totalfinance/risk/portfolio#liquidity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#liquidity`. ### @insiderfinance/totalfinance/risk/portfolio#margin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#margin`. ### @insiderfinance/totalfinance/risk/portfolio#marketImpact Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#marketImpact`. ### @insiderfinance/totalfinance/risk/portfolio#nakedCallMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#nakedCallMargin`. ### @insiderfinance/totalfinance/risk/portfolio#nakedPutMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#nakedPutMargin`. ### @insiderfinance/totalfinance/risk/portfolio#optionsMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#optionsMargin`. ## Entrypoint @insiderfinance/totalfinance/risk/research ### @insiderfinance/totalfinance/risk/research#BacktestOverfittingProbabilityOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BacktestOverfittingProbabilityOptions`. ### @insiderfinance/totalfinance/risk/research#BacktestOverfittingProbabilityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BacktestOverfittingProbabilityResult`. ### @insiderfinance/totalfinance/risk/research#DeflatedSharpeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#DeflatedSharpeResult`. ### @insiderfinance/totalfinance/risk/research#LeakageIssue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#LeakageIssue`. ### @insiderfinance/totalfinance/risk/research#LeakageReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#LeakageReport`. ### @insiderfinance/totalfinance/risk/research#MultipleTestMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MultipleTestMethod`. ### @insiderfinance/totalfinance/risk/research#MultipleTestOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MultipleTestOptions`. ### @insiderfinance/totalfinance/risk/research#MultipleTestResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MultipleTestResult`. ### @insiderfinance/totalfinance/risk/research#ParameterSweepResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ParameterSweepResult`. ### @insiderfinance/totalfinance/risk/research#ProbabilisticSharpeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ProbabilisticSharpeResult`. ### @insiderfinance/totalfinance/risk/research#PurgedKFoldOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PurgedKFoldOptions`. ### @insiderfinance/totalfinance/risk/research#SharpeStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#SharpeStatistics`. ### @insiderfinance/totalfinance/risk/research#SharpeStatisticsReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#SharpeStatisticsReport`. ### @insiderfinance/totalfinance/risk/research#Split Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#Split`. ### @insiderfinance/totalfinance/risk/research#SurvivorshipContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#SurvivorshipContext`. ### @insiderfinance/totalfinance/risk/research#WalkForwardOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#WalkForwardOptions`. ### @insiderfinance/totalfinance/risk/research#adjustPValues Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#adjustPValues`. ### @insiderfinance/totalfinance/risk/research#checkLeakage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#checkLeakage`. ### @insiderfinance/totalfinance/risk/research#deflatedSharpeRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#deflatedSharpeRatio`. ### @insiderfinance/totalfinance/risk/research#parameterSweepDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#parameterSweepDiagnostics`. ### @insiderfinance/totalfinance/risk/research#probabilisticSharpeRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#probabilisticSharpeRatio`. ### @insiderfinance/totalfinance/risk/research#probabilityOfBacktestOverfitting Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#probabilityOfBacktestOverfitting`. ### @insiderfinance/totalfinance/risk/research#purgedKFold Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#purgedKFold`. ### @insiderfinance/totalfinance/risk/research#sharpeStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#sharpeStatistics`. ### @insiderfinance/totalfinance/risk/research#survivorshipWarning Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#survivorshipWarning`. ### @insiderfinance/totalfinance/risk/research#walkForwardSplits Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#walkForwardSplits`. ## Entrypoint @insiderfinance/totalfinance/risk/scenario ### @insiderfinance/totalfinance/risk/scenario#PnlAttribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PnlAttribution`. ### @insiderfinance/totalfinance/risk/scenario#Position Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#Position`. ### @insiderfinance/totalfinance/risk/scenario#PositionGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PositionGreeks`. ### @insiderfinance/totalfinance/risk/scenario#PositionScenarioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PositionScenarioResult`. ### @insiderfinance/totalfinance/risk/scenario#ResolvedGridShock Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ResolvedGridShock`. ### @insiderfinance/totalfinance/risk/scenario#Scenario Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#Scenario`. ### @insiderfinance/totalfinance/risk/scenario#ScenarioGridInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ScenarioGridInput`. ### @insiderfinance/totalfinance/risk/scenario#ScenarioGridResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ScenarioGridResult`. ### @insiderfinance/totalfinance/risk/scenario#ScenarioResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ScenarioResult`. ### @insiderfinance/totalfinance/risk/scenario#Shock Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#Shock`. ### @insiderfinance/totalfinance/risk/scenario#ShockFactor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ShockFactor`. ### @insiderfinance/totalfinance/risk/scenario#ShockKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ShockKind`. ### @insiderfinance/totalfinance/risk/scenario#StressOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#StressOptions`. ### @insiderfinance/totalfinance/risk/scenario#StressTestInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StressTestInput { positions: readonly Position[]; scenarios: readonly Scenario[]; options?: StressOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - options?: StressOptions; default: not declared - options.reprice?: (position: Position, scenario: Scenario) => number; default: not declared — Custom revaluation: return the position's **new value per unit** under the scenario. Falls back to the Greeks-Taylor expansion when omitted. - options.reprice(position): Position; default: not declared - options.reprice(position).data?: T; default: not declared - options.reprice(position).greeks?: PositionGreeks; default: not declared - options.reprice(position).id?: string; default: not declared - options.reprice(position).multiplier?: number; default: not declared — Contract multiplier applied to per-unit value and Greeks (100 for a listed US equity option whose Greeks are per share and whose `quantity` is in contracts). Default 1. Applied by `aggregateGreeks`, `stressTest` and the book tools; disclosed in their assumptions. - options.reprice(position).quantity?: number; default: not declared — Number of units held (signed). Default 1. - options.reprice(position).value?: number; default: not declared — Current mark per unit — the BASE a custom `reprice` differences against (H11). When `reprice` is supplied, either this or `greeks.value` must be present; the base is never assumed 0. - options.reprice(scenario): Scenario; default: not declared - options.reprice(scenario).name: string; default: not declared - options.reprice(scenario).shocks: Shock[]; default: not declared - positions: readonly Position[]; default: not declared - scenarios: readonly Scenario[]; default: not declared ### @insiderfinance/totalfinance/risk/scenario#StressTestResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#StressTestResult`. ### @insiderfinance/totalfinance/risk/scenario#TaylorPnlResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#TaylorPnlResult`. ### @insiderfinance/totalfinance/risk/scenario#scenario Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#scenario`. ### @insiderfinance/totalfinance/risk/scenario#scenarioGrid Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#scenarioGrid`. ### @insiderfinance/totalfinance/risk/scenario#shock Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#shock`. ### @insiderfinance/totalfinance/risk/scenario#stressTest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#stressTest`. ### @insiderfinance/totalfinance/risk/scenario#taylorPnl Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#taylorPnl`. ## Entrypoint @insiderfinance/totalfinance/risk/sizing ### @insiderfinance/totalfinance/risk/sizing#BinaryEdge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#BinaryEdge`. ### @insiderfinance/totalfinance/risk/sizing#EdgeOutcome Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#EdgeOutcome`. ### @insiderfinance/totalfinance/risk/sizing#KellyBetInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#KellyBetInput`. ### @insiderfinance/totalfinance/risk/sizing#KellySizing Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#KellySizing`. ### @insiderfinance/totalfinance/risk/sizing#OptionMarginLeg Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptionMarginLeg`. ### @insiderfinance/totalfinance/risk/sizing#OptionsMarginOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptionsMarginOptions`. ### @insiderfinance/totalfinance/risk/sizing#OptionsMarginResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#OptionsMarginResult`. ### @insiderfinance/totalfinance/risk/sizing#kellyBet Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#kellyBet`. ### @insiderfinance/totalfinance/risk/sizing#optionsMargin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#optionsMargin`. ## Entrypoint @insiderfinance/totalfinance/risk/value-at-risk ### @insiderfinance/totalfinance/risk/value-at-risk#HistoricalPortfolioVaRInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#HistoricalPortfolioVaRInput`. ### @insiderfinance/totalfinance/risk/value-at-risk#HistoricalPortfolioVaROptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#HistoricalPortfolioVaROptions`. ### @insiderfinance/totalfinance/risk/value-at-risk#HistoricalPortfolioVaRResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#HistoricalPortfolioVaRResult`. ### @insiderfinance/totalfinance/risk/value-at-risk#MonteCarloPortfolioVaRInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#MonteCarloPortfolioVaRInput`. ### @insiderfinance/totalfinance/risk/value-at-risk#MonteCarloPortfolioVaRResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#MonteCarloPortfolioVaRResult`. ### @insiderfinance/totalfinance/risk/value-at-risk#ParametricPortfolioVaRInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ParametricPortfolioVaRInput`. ### @insiderfinance/totalfinance/risk/value-at-risk#ParametricPortfolioVaROptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#ParametricPortfolioVaROptions`. ### @insiderfinance/totalfinance/risk/value-at-risk#PortfolioVaRInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PortfolioVaRInput`. ### @insiderfinance/totalfinance/risk/value-at-risk#PortfolioVaROutput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PortfolioVaROutput`. ### @insiderfinance/totalfinance/risk/value-at-risk#PortfolioVaRResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#PortfolioVaRResult`. ### @insiderfinance/totalfinance/risk/value-at-risk#RiskContributionRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#RiskContributionRow`. ### @insiderfinance/totalfinance/risk/value-at-risk#RiskContributionsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#RiskContributionsResult`. ### @insiderfinance/totalfinance/risk/value-at-risk#VaRMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#VaRMethod`. ### @insiderfinance/totalfinance/risk/value-at-risk#VaROptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#VaROptions`. ### @insiderfinance/totalfinance/risk/value-at-risk#VaRResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#VaRResult`. ### @insiderfinance/totalfinance/risk/value-at-risk#ValueAtRiskAssumptionExtras Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Conventions a VaR-family explain envelope discloses. ```typescript /** Conventions a VaR-family explain envelope discloses. */ export type ValueAtRiskAssumptionExtras = { confidence: number; method: VaRMethod; horizonPeriods: number; seed?: number; samples?: number; cornishFisher?: boolean; /** Historical only: the order-statistic interpolation rule (`hyndman-fan-7`, the R/NumPy default). */ quantileEstimator?: string; /** Monte-Carlo only: the law actually simulated (`fitted-normal` — first two moments only). */ distribution?: string; /** Cornish-Fisher over a multi-period horizon: how skew/kurtosis were scaled (`iid`). */ momentScaling?: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - confidence: number; default: not declared - cornishFisher?: boolean; default: not declared - distribution?: string; default: not declared — Monte-Carlo only: the law actually simulated (`fitted-normal` — first two moments only). - horizonPeriods: number; default: not declared - method: VaRMethod; default: not declared - momentScaling?: string; default: not declared — Cornish-Fisher over a multi-period horizon: how skew/kurtosis were scaled (`iid`). - quantileEstimator?: string; default: not declared — Historical only: the order-statistic interpolation rule (`hyndman-fan-7`, the R/NumPy default). - samples?: number; default: not declared - seed?: number; default: not declared ### @insiderfinance/totalfinance/risk/value-at-risk#diversificationRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#diversificationRatio`. ### @insiderfinance/totalfinance/risk/value-at-risk#expectedShortfall Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#expectedShortfall`. ### @insiderfinance/totalfinance/risk/value-at-risk#portfolioVaR Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#portfolioVaR`. ### @insiderfinance/totalfinance/risk/value-at-risk#portfolioVariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#portfolioVariance`. ### @insiderfinance/totalfinance/risk/value-at-risk#portfolioVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#portfolioVolatility`. ### @insiderfinance/totalfinance/risk/value-at-risk#riskContributions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#riskContributions`. ### @insiderfinance/totalfinance/risk/value-at-risk#valueAtRisk Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#valueAtRisk`. ### @insiderfinance/totalfinance/risk/value-at-risk#valueAtRiskReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/risk#valueAtRiskReport`. ## Entrypoint @insiderfinance/totalfinance/scenarios ### @insiderfinance/totalfinance/scenarios#FullRevaluationScenarioPortfolioBindingDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable full-revaluation durable-portfolio binding descriptor. ```typescript /** Serializable full-revaluation durable-portfolio binding descriptor. */ export interface FullRevaluationScenarioPortfolioBindingDescriptor extends ScenarioPortfolioBindingDescriptorBase { readonly valuationMethod: 'full-revaluation'; readonly instrumentDescriptor: unknown; readonly instrumentDescriptorHash: string; readonly pricer: ScenarioPricerDescriptor; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - bindingDescriptorHash: string; default: not declared - book?: string; default: not declared - id: string; default: not declared - instrumentDescriptor: unknown; default: not declared - instrumentDescriptorHash: string; default: not declared - instrumentId: string; default: not declared - pricer: ScenarioPricerDescriptor; default: not declared - pricer.capabilities: Readonly; default: not declared - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared - pricer.version: string; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - valuationMethod: 'full-revaluation'; default: not declared ### @insiderfinance/totalfinance/scenarios#FullRevaluationScenarioPortfolioBindingInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Full-revaluation durable-portfolio binding. ```typescript /** Full-revaluation durable-portfolio binding. */ export interface FullRevaluationScenarioPortfolioBindingInput extends ScenarioPortfolioBindingBaseInput { instrument: TInstrument; instrumentDescriptor?: unknown; pricer: Pricer, PricerValuationResult>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - book?: string; default: not declared - id: string; default: not declared - instrument: TInstrument; default: not declared - instrumentDescriptor?: unknown; default: not declared - instrumentId: string; default: not declared - pricer: Pricer, PricerValuationResult>; default: not declared - pricer.capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - pricer.price: (input: import('@insiderfinance/totalfinance/core/pricing').PricerPriceInput>) => PricerValuationResult; default: not declared - pricer.price().return.assumptions: { readonly conventionsVersion: string; }; default: not declared - pricer.price().return.assumptions.conventionsVersion: string; default: not declared - pricer.price().return.diagnostics: { readonly engine?: string; readonly selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; readonly warnings: readonly QuantWarning[]; }; default: not declared - pricer.price().return.diagnostics.engine?: string; default: not declared - pricer.price().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared - pricer.price().return.diagnostics.warnings: readonly QuantWarning[]; default: not declared - pricer.price().return.value: number; default: not declared - pricer.price(input): import('@insiderfinance/totalfinance/core/pricing').PricerPriceInput>; default: not declared - pricer.price(input).instrument: NoInfer; default: not declared - pricer.price(input).observations: readonly import('@insiderfinance/totalfinance/core/pricing').MarketObservation[]; default: not declared — Observations satisfying the pricer's declared requirements for this instrument. - pricer.price(input).request?: import('@insiderfinance/totalfinance/core/pricing').PricerValuationRequest; default: not declared - pricer.priceBatch?: (input: import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput>) => readonly PricerValuationResult[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - pricer.priceBatch(input): import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput>; default: not declared - pricer.priceBatch(input).instruments: readonly NoInfer[]; default: not declared - pricer.priceBatch(input).observations: readonly import('@insiderfinance/totalfinance/core/pricing').MarketObservation[]; default: not declared - pricer.priceBatch(input).request?: import('@insiderfinance/totalfinance/core/pricing').PricerValuationRequest; default: not declared - pricer.requirements: (instrument: NoInfer) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - pricer.requirements(instrument): NoInfer; default: not declared - pricer.supports: (instrument: NoInfer) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - pricer.supports(instrument): NoInfer; default: not declared - pricer.version: string; default: not declared - strategy?: string; default: not declared - tags?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#FullRevaluationScenarioTargetDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable full-revaluation target descriptor; behavior is deliberately absent. ```typescript /** Serializable full-revaluation target descriptor; behavior is deliberately absent. */ export interface FullRevaluationScenarioTargetDescriptor extends ScenarioTargetDescriptorBase { readonly valuationMethod: 'full-revaluation'; readonly instrumentDescriptor: unknown; readonly instrumentDescriptorHash: string; readonly pricer: ScenarioPricerDescriptor; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - id: string; default: not declared - instrumentDescriptor: unknown; default: not declared - instrumentDescriptorHash: string; default: not declared - pricer: ScenarioPricerDescriptor; default: not declared - pricer.capabilities: Readonly; default: not declared - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared - pricer.version: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - targetDescriptorHash: string; default: not declared - underlying?: string; default: not declared - valuationMethod: 'full-revaluation'; default: not declared ### @insiderfinance/totalfinance/scenarios#FullRevaluationScenarioTargetInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bind one concrete instrument to the pricer that understands it. ```typescript /** Bind one concrete instrument to the pricer that understands it. */ export interface FullRevaluationScenarioTargetInput extends ScenarioTargetBaseInput { instrument: TInstrument; instrumentDescriptor?: unknown; pricer: Pricer, PricerValuationResult>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - id: string; default: not declared - instrument: TInstrument; default: not declared - instrumentDescriptor?: unknown; default: not declared - pricer: Pricer, PricerValuationResult>; default: not declared - pricer.capabilities: PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - pricer.price: (input: import('@insiderfinance/totalfinance/core/pricing').PricerPriceInput>) => PricerValuationResult; default: not declared - pricer.price().return.assumptions: { readonly conventionsVersion: string; }; default: not declared - pricer.price().return.assumptions.conventionsVersion: string; default: not declared - pricer.price().return.diagnostics: { readonly engine?: string; readonly selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; readonly warnings: readonly QuantWarning[]; }; default: not declared - pricer.price().return.diagnostics.engine?: string; default: not declared - pricer.price().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared - pricer.price().return.diagnostics.warnings: readonly QuantWarning[]; default: not declared - pricer.price().return.value: number; default: not declared - pricer.price(input): import('@insiderfinance/totalfinance/core/pricing').PricerPriceInput>; default: not declared - pricer.price(input).instrument: NoInfer; default: not declared - pricer.price(input).observations: readonly import('@insiderfinance/totalfinance/core/pricing').MarketObservation[]; default: not declared — Observations satisfying the pricer's declared requirements for this instrument. - pricer.price(input).request?: import('@insiderfinance/totalfinance/core/pricing').PricerValuationRequest; default: not declared - pricer.priceBatch?: (input: import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput>) => readonly PricerValuationResult[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - pricer.priceBatch(input): import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput>; default: not declared - pricer.priceBatch(input).instruments: readonly NoInfer[]; default: not declared - pricer.priceBatch(input).observations: readonly import('@insiderfinance/totalfinance/core/pricing').MarketObservation[]; default: not declared - pricer.priceBatch(input).request?: import('@insiderfinance/totalfinance/core/pricing').PricerValuationRequest; default: not declared - pricer.requirements: (instrument: NoInfer) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - pricer.requirements(instrument): NoInfer; default: not declared - pricer.supports: (instrument: NoInfer) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - pricer.supports(instrument): NoInfer; default: not declared - pricer.version: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags?: readonly string[]; default: not declared - underlying?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#RunScenariosInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One complete shared-scenario request. ```typescript /** One complete shared-scenario request. */ export interface RunScenariosInput { scenarioSet: ScenarioSet; market: MarketSnapshot; targets: readonly ScenarioTarget[]; reportingCurrency?: string; currencyConversions?: readonly CurrencyPairQuote[]; options?: RunScenariosOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currencyConversions?: readonly CurrencyPairQuote[]; default: not declared - market: MarketSnapshot; default: not declared - market.asOf: number; default: not declared - market.conventions: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotConventions; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: InterestCompounding; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotObservations; default: not declared - market.observations.chains?: Record; default: not declared - market.observations.curves?: Record; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: Record; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: Record; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: Record; default: not declared - market.observations.surfaces?: Record; default: not declared - market.observations.volatilities?: Record; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: QuantWarning[]; default: not declared - market.schemaVersion: number; default: not declared - options?: RunScenariosOptions; default: not declared - options.factorHandlers?: readonly ScenarioFactorHandler[]; default: not declared - options.failureMode?: 'fail-fast' | 'collect'; default: not declared - options.marketResolvers?: readonly ScenarioMarketResolver[]; default: not declared - options.maximumValuationCells?: number; default: not declared - options.maximumWorkUnits?: number; default: not declared - options.seed?: number; default: not declared - reportingCurrency?: string; default: not declared - scenarioSet: ScenarioSet; default: not declared - scenarioSet.kind: 'totalfinance.scenario-set'; default: not declared - scenarioSet.name: string; default: not declared - scenarioSet.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Where the definitions came from (a historical-event library, a desk doc) — caller-supplied. - scenarioSet.provenance.asOf?: number; default: not declared - scenarioSet.provenance.dataset?: string; default: not declared - scenarioSet.provenance.provider?: string; default: not declared - scenarioSet.provenance.receivedAt?: number; default: not declared - scenarioSet.provenance.requestId?: string; default: not declared - scenarioSet.provenance.sourceVersion?: string; default: not declared - scenarioSet.provenance.warnings?: QuantWarning[]; default: not declared - scenarioSet.scenarios: import('@insiderfinance/totalfinance/core/artifacts').ScenarioDefinition[]; default: not declared - scenarioSet.schemaVersion: number; default: not declared - targets: readonly ScenarioTarget[]; default: not declared ### @insiderfinance/totalfinance/scenarios#RunScenariosOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed execution options for `runScenarios`. ```typescript /** Closed execution options for `runScenarios`. */ export interface RunScenariosOptions { failureMode?: 'fail-fast' | 'collect'; seed?: number; maximumValuationCells?: number; maximumWorkUnits?: number; marketResolvers?: readonly ScenarioMarketResolver[]; factorHandlers?: readonly ScenarioFactorHandler[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factorHandlers?: readonly ScenarioFactorHandler[]; default: not declared - failureMode?: 'fail-fast' | 'collect'; default: not declared - marketResolvers?: readonly ScenarioMarketResolver[]; default: not declared - maximumValuationCells?: number; default: not declared - maximumWorkUnits?: number; default: not declared - seed?: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAggregateRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One deterministic aggregate row. ```typescript /** One deterministic aggregate row. */ export interface ScenarioAggregateRow { readonly group: 'target' | 'underlying' | 'strategy' | 'account' | 'book' | 'tag' | 'grand-total'; readonly key: string; readonly reportingCurrency: string; readonly status: 'complete' | 'incomplete'; readonly baseValue: number | null; readonly scenarioValue: number | null; readonly pnl: number | null; readonly targetIds: readonly string[]; readonly failedTargetIds: readonly string[]; readonly reason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseValue: number | null; default: not declared - failedTargetIds: readonly string[]; default: not declared - group: 'underlying' | 'book' | 'target' | 'strategy' | 'account' | 'tag' | 'grand-total'; default: not declared - key: string; default: not declared - pnl: number | null; default: not declared - reason?: string; default: not declared - reportingCurrency: string; default: not declared - scenarioValue: number | null; default: not declared - status: 'complete' | 'incomplete'; default: not declared - targetIds: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAppliedCurveInstruction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compact discount-curve instruction detail. ```typescript /** Compact discount-curve instruction detail. */ export interface ScenarioAppliedCurveInstruction extends ScenarioAppliedInstructionBase { readonly detail: 'discount-curve'; readonly pillarCount: number; readonly beforeCurveHash: string; readonly afterCurveHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - afterCurveHash: string; default: not declared - beforeCurveHash: string; default: not declared - detail: 'discount-curve'; default: not declared - factor: string; default: not declared - instructionIndex: number; default: not declared - phase: 'override' | 'shock'; default: not declared - pillarCount: number; default: not declared - subject: string; default: not declared - target?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAppliedCustomInstruction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compact custom-handler instruction detail. ```typescript /** Compact custom-handler instruction detail. */ export interface ScenarioAppliedCustomInstruction extends ScenarioAppliedInstructionBase { readonly detail: 'custom'; readonly handler: ScenarioBehaviorIdentity; readonly beforeObservationsHash: string; readonly afterObservationsHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - afterObservationsHash: string; default: not declared - beforeObservationsHash: string; default: not declared - detail: 'custom'; default: not declared - factor: string; default: not declared - handler: ScenarioBehaviorIdentity; default: not declared - handler.name: string; default: not declared - handler.version: string; default: not declared - instructionIndex: number; default: not declared - phase: 'override' | 'shock'; default: not declared - subject: string; default: not declared - target?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAppliedInstruction Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Lossless identity of an instruction applied to one target cell. ```typescript /** Lossless identity of an instruction applied to one target cell. */ export type ScenarioAppliedInstruction = ScenarioAppliedScalarInstruction | ScenarioAppliedCurveInstruction | ScenarioAppliedCustomInstruction; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - after: number; default: not declared - afterCurveHash: string; default: not declared - afterObservationsHash: string; default: not declared - before: number; default: not declared - beforeCurveHash: string; default: not declared - beforeObservationsHash: string; default: not declared - detail: ('custom') | ('discount-curve') | ('scalar' | 'foreign-exchange-rate'); default: not declared - factor: string; default: not declared - handler: ScenarioBehaviorIdentity; default: not declared - handler.name: string; default: not declared - handler.version: string; default: not declared - instructionIndex: number; default: not declared - phase: 'override' | 'shock'; default: not declared - pillarCount: number; default: not declared - subject: string; default: not declared - target?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAppliedInstructionBase Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared coordinates recorded for every applied instruction. ```typescript /** Shared coordinates recorded for every applied instruction. */ export interface ScenarioAppliedInstructionBase { readonly phase: 'override' | 'shock'; readonly instructionIndex: number; readonly factor: string; readonly target?: string; readonly subject: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor: string; default: not declared - instructionIndex: number; default: not declared - phase: 'override' | 'shock'; default: not declared - subject: string; default: not declared - target?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAppliedScalarInstruction Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Scalar or foreign-exchange instruction detail. ```typescript /** Scalar or foreign-exchange instruction detail. */ export interface ScenarioAppliedScalarInstruction extends ScenarioAppliedInstructionBase { readonly detail: 'scalar' | 'foreign-exchange-rate'; readonly before: number; readonly after: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - after: number; default: not declared - before: number; default: not declared - detail: 'scalar' | 'foreign-exchange-rate'; default: not declared - factor: string; default: not declared - instructionIndex: number; default: not declared - phase: 'override' | 'shock'; default: not declared - subject: string; default: not declared - target?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioAxisRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Stable scenario-axis metadata. ```typescript /** Stable scenario-axis metadata. */ export interface ScenarioAxisRow { readonly scenarioIndex: number; readonly name: string; readonly scenarioHash: string; readonly overrideCount: number; readonly shockCount: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - overrideCount: number; default: not declared - scenarioHash: string; default: not declared - scenarioIndex: number; default: not declared - shockCount: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioBaseAggregateSet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate rows for the base axis. ```typescript /** Aggregate rows for the base axis. */ export interface ScenarioBaseAggregateSet { readonly kind: 'base'; readonly scenarioIndex: null; readonly scenarioName: null; readonly rows: readonly ScenarioAggregateRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'base'; default: not declared - rows: readonly ScenarioAggregateRow[]; default: not declared - scenarioIndex: null; default: not declared - scenarioName: null; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioBaseCell Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Base valuation cell. ```typescript /** Base valuation cell. */ export type ScenarioBaseCell = (ScenarioFullRevaluationValue & { readonly kind: 'base'; readonly status: 'complete'; }) | (ScenarioSuccessfulValueFields & { readonly kind: 'base'; readonly status: 'complete'; readonly valuationMethod: 'taylor'; readonly baseValueSource: 'supplied-base-value-per-unit'; }) | { readonly kind: 'base'; readonly status: 'failed'; readonly targetIndex: number; readonly targetId: string; readonly valuationMethod: ScenarioValuationMethod; readonly valuePerUnit: null; readonly positionValue: null; readonly reportingPositionValue: null; readonly failure: ScenarioExecutionFailure; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - failure: ScenarioExecutionFailure; default: not declared - failure.code: string; default: not declared - failure.context: Readonly> | null; default: not declared - failure.contextStatus: 'absent' | 'preserved' | 'omitted-unsafe'; default: not declared - failure.message: string; default: not declared - failure.scenarioIndex: number | null; default: not declared - failure.scenarioName: string | null; default: not declared - failure.targetId: string; default: not declared - failure.targetIndex: number; default: not declared - failure.valuationMethod: ScenarioValuationMethod; default: not declared - kind: 'base'; default: not declared - positionValue: null; default: not declared - reportingPositionValue: null; default: not declared - status: 'failed'; default: not declared - targetId: string; default: not declared - targetIndex: number; default: not declared - valuationMethod: ScenarioValuationMethod; default: not declared - valuePerUnit: null; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioBehaviorIdentity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable name/version identity for a callback used by the run. ```typescript /** Serializable name/version identity for a callback used by the run. */ export interface ScenarioBehaviorIdentity { readonly name: string; readonly version: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioCell Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Scenario valuation cell. ```typescript /** Scenario valuation cell. */ export type ScenarioCell = ((ScenarioFullRevaluationValue | ScenarioTaylorValue) & { readonly kind: 'scenario'; readonly status: 'complete'; readonly scenarioIndex: number; readonly scenarioName: string; readonly localPnl: number; readonly reportingPnl: number; }) | { readonly kind: 'scenario'; readonly status: 'failed'; readonly targetIndex: number; readonly targetId: string; readonly scenarioIndex: number; readonly scenarioName: string; readonly valuationMethod: ScenarioValuationMethod; readonly valuePerUnit: null; readonly positionValue: null; readonly reportingPositionValue: null; readonly localPnl: null; readonly reportingPnl: null; readonly failure: ScenarioExecutionFailure; } | { readonly kind: 'scenario'; readonly status: 'blocked'; readonly targetIndex: number; readonly targetId: string; readonly scenarioIndex: number; readonly scenarioName: string; readonly valuationMethod: ScenarioValuationMethod; readonly valuePerUnit: null; readonly positionValue: null; readonly reportingPositionValue: null; readonly localPnl: null; readonly reportingPnl: null; readonly blockedByBaseFailure: ScenarioExecutionFailure; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - blockedByBaseFailure: ScenarioExecutionFailure; default: not declared - blockedByBaseFailure.code: string; default: not declared - blockedByBaseFailure.context: Readonly> | null; default: not declared - blockedByBaseFailure.contextStatus: 'absent' | 'preserved' | 'omitted-unsafe'; default: not declared - blockedByBaseFailure.message: string; default: not declared - blockedByBaseFailure.scenarioIndex: number | null; default: not declared - blockedByBaseFailure.scenarioName: string | null; default: not declared - blockedByBaseFailure.targetId: string; default: not declared - blockedByBaseFailure.targetIndex: number; default: not declared - blockedByBaseFailure.valuationMethod: ScenarioValuationMethod; default: not declared - failure: ScenarioExecutionFailure; default: not declared - failure.code: string; default: not declared - failure.context: Readonly> | null; default: not declared - failure.contextStatus: 'absent' | 'preserved' | 'omitted-unsafe'; default: not declared - failure.message: string; default: not declared - failure.scenarioIndex: number | null; default: not declared - failure.scenarioName: string | null; default: not declared - failure.targetId: string; default: not declared - failure.targetIndex: number; default: not declared - failure.valuationMethod: ScenarioValuationMethod; default: not declared - kind: 'scenario'; default: not declared - localPnl: null; default: not declared - positionValue: null; default: not declared - reportingPnl: null; default: not declared - reportingPositionValue: null; default: not declared - scenarioIndex: number; default: not declared - scenarioName: string; default: not declared - status: ('blocked') | ('failed'); default: not declared - targetId: string; default: not declared - targetIndex: number; default: not declared - valuationMethod: ScenarioValuationMethod; default: not declared - valuePerUnit: null; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioCurrencyConversionUse Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exact currency quote and orientation used for one conversion. ```typescript /** Exact currency quote and orientation used for one conversion. */ export interface ScenarioCurrencyConversionUse { readonly sourceQuoteIndex: number; readonly orientation: 'direct' | 'inverted'; readonly quote: Readonly; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - orientation: 'direct' | 'inverted'; default: not declared - quote: Readonly; default: not declared - quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - sourceQuoteIndex: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioExecutionFailure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Behavior-free execution failure safe to retain in an artifact. ```typescript /** Behavior-free execution failure safe to retain in an artifact. */ export interface ScenarioExecutionFailure { readonly code: string; readonly message: string; readonly context: Readonly> | null; readonly contextStatus: 'absent' | 'preserved' | 'omitted-unsafe'; readonly targetIndex: number; readonly targetId: string; readonly scenarioIndex: number | null; readonly scenarioName: string | null; readonly valuationMethod: ScenarioValuationMethod; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared - context: Readonly> | null; default: not declared - contextStatus: 'absent' | 'preserved' | 'omitted-unsafe'; default: not declared - message: string; default: not declared - scenarioIndex: number | null; default: not declared - scenarioName: string | null; default: not declared - targetId: string; default: not declared - targetIndex: number; default: not declared - valuationMethod: ScenarioValuationMethod; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioFactorHandler Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One synchronous, per-call owner of a non-reserved scenario factor. ```typescript /** One synchronous, per-call owner of a non-reserved scenario factor. */ export interface ScenarioFactorHandler { factor: string; name: string; version: string; apply(this: undefined, input: ScenarioFactorHandlerInput): readonly ScenarioReadonlyMarketObservation[] | undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - apply: (this: undefined, input: ScenarioFactorHandlerInput) => readonly ScenarioReadonlyMarketObservation[] | undefined; default: not declared - apply(input): ScenarioFactorHandlerInput; default: not declared - apply(input).instruction: { readonly factor: import('@insiderfinance/totalfinance/core/artifacts').ScenarioFactor; readonly target?: string; readonly value: number; } | { readonly factor: import('@insiderfinance/totalfinance/core/artifacts').ScenarioFactor; readonly kind: 'percent' | 'absolute'; readonly target?: string; readonly value: number; }; default: not declared - apply(input).instruction.factor: string; default: not declared - apply(input).instruction.kind: 'percent' | 'absolute'; default: not declared - apply(input).instruction.target?: string; default: not declared — Which symbol the shock hits; absent = every target the runner prices with this factor. - apply(input).instruction.value: number; default: not declared - apply(input).observations: readonly ScenarioReadonlyMarketObservation[]; default: not declared - apply(input).target: { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly instrumentDescriptor: unknown; readonly instrumentDescriptorHash: string; readonly pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'full-revaluation'; } | { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; readonly taylorDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'taylor'; }; default: not declared - apply(input).target.account?: string; default: not declared - apply(input).target.book?: string; default: not declared - apply(input).target.contractMultiplier: number; default: not declared - apply(input).target.currency: string; default: not declared - apply(input).target.id: string; default: not declared - apply(input).target.instrumentDescriptor: unknown; default: not declared - apply(input).target.instrumentDescriptorHash: string; default: not declared - apply(input).target.pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; default: not declared - apply(input).target.pricer.capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; default: not declared - apply(input).target.pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - apply(input).target.pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - apply(input).target.pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - apply(input).target.pricer.name: string; default: not declared - apply(input).target.pricer.version: string; default: not declared - apply(input).target.quantity: number; default: not declared - apply(input).target.strategy?: string; default: not declared - apply(input).target.tags: readonly string[]; default: not declared - apply(input).target.targetDescriptorHash: string; default: not declared - apply(input).target.taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; default: not declared - apply(input).target.taylor.baseValuePerUnit: number; default: not declared - apply(input).target.taylor.factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; default: not declared - apply(input).target.taylor.factors.dividend?: { readonly level: number; readonly subject: string; }; default: not declared - apply(input).target.taylor.factors.dividend.level: number; default: not declared - apply(input).target.taylor.factors.dividend.subject: string; default: not declared - apply(input).target.taylor.factors.riskFreeRate?: { readonly level: number; readonly subject: string; }; default: not declared - apply(input).target.taylor.factors.riskFreeRate.level: number; default: not declared - apply(input).target.taylor.factors.riskFreeRate.subject: string; default: not declared - apply(input).target.taylor.factors.spot?: { readonly level: number; readonly subject: string; }; default: not declared - apply(input).target.taylor.factors.spot.level: number; default: not declared - apply(input).target.taylor.factors.spot.subject: string; default: not declared - apply(input).target.taylor.factors.valuationInstant?: { readonly level: EpochMs; }; default: not declared - apply(input).target.taylor.factors.valuationInstant.level: number; default: not declared - apply(input).target.taylor.factors.volatility?: { readonly level: number; readonly subject: string; }; default: not declared - apply(input).target.taylor.factors.volatility.level: number; default: not declared - apply(input).target.taylor.factors.volatility.subject: string; default: not declared - apply(input).target.taylor.sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; default: not declared - apply(input).target.taylor.sensitivities.charm?: number; default: not declared - apply(input).target.taylor.sensitivities.delta?: number; default: not declared - apply(input).target.taylor.sensitivities.deltaRate?: number; default: not declared - apply(input).target.taylor.sensitivities.gamma?: number; default: not declared - apply(input).target.taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - apply(input).target.taylor.sensitivities.rho?: number; default: not declared - apply(input).target.taylor.sensitivities.rhoConvexity?: number; default: not declared - apply(input).target.taylor.sensitivities.theta?: number; default: not declared - apply(input).target.taylor.sensitivities.thetaConvexity?: number; default: not declared - apply(input).target.taylor.sensitivities.thetaRate?: number; default: not declared - apply(input).target.taylor.sensitivities.vanna?: number; default: not declared - apply(input).target.taylor.sensitivities.vega?: number; default: not declared - apply(input).target.taylor.sensitivities.vera?: number; default: not declared - apply(input).target.taylor.sensitivities.veta?: number; default: not declared - apply(input).target.taylor.sensitivities.vomma?: number; default: not declared - apply(input).target.taylorDescriptorHash: string; default: not declared - apply(input).target.underlying?: string; default: not declared - apply(input).target.valuationMethod: ('full-revaluation') | ('taylor'); default: not declared - factor: string; default: not declared - name: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioFactorHandlerInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Frozen, behavior-free input supplied to one custom-factor handler call. ```typescript /** Frozen, behavior-free input supplied to one custom-factor handler call. */ export interface ScenarioFactorHandlerInput { readonly instruction: ScenarioReadonlyData; readonly observations: readonly ScenarioReadonlyMarketObservation[]; readonly target: ScenarioReadonlyData; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - instruction: { readonly factor: import('@insiderfinance/totalfinance/core/artifacts').ScenarioFactor; readonly target?: string; readonly value: number; } | { readonly factor: import('@insiderfinance/totalfinance/core/artifacts').ScenarioFactor; readonly kind: 'percent' | 'absolute'; readonly target?: string; readonly value: number; }; default: not declared - instruction.factor: string; default: not declared - instruction.kind: 'percent' | 'absolute'; default: not declared - instruction.target?: string; default: not declared — Which symbol the shock hits; absent = every target the runner prices with this factor. - instruction.value: number; default: not declared - observations: readonly ScenarioReadonlyMarketObservation[]; default: not declared - target: { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly instrumentDescriptor: unknown; readonly instrumentDescriptorHash: string; readonly pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'full-revaluation'; } | { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; readonly taylorDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'taylor'; }; default: not declared - target.account?: string; default: not declared - target.book?: string; default: not declared - target.contractMultiplier: number; default: not declared - target.currency: string; default: not declared - target.id: string; default: not declared - target.instrumentDescriptor: unknown; default: not declared - target.instrumentDescriptorHash: string; default: not declared - target.pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; default: not declared - target.pricer.capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; default: not declared - target.pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - target.pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - target.pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - target.pricer.name: string; default: not declared - target.pricer.version: string; default: not declared - target.quantity: number; default: not declared - target.strategy?: string; default: not declared - target.tags: readonly string[]; default: not declared - target.targetDescriptorHash: string; default: not declared - target.taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; default: not declared - target.taylor.baseValuePerUnit: number; default: not declared - target.taylor.factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; default: not declared - target.taylor.factors.dividend?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.dividend.level: number; default: not declared - target.taylor.factors.dividend.subject: string; default: not declared - target.taylor.factors.riskFreeRate?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.riskFreeRate.level: number; default: not declared - target.taylor.factors.riskFreeRate.subject: string; default: not declared - target.taylor.factors.spot?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.spot.level: number; default: not declared - target.taylor.factors.spot.subject: string; default: not declared - target.taylor.factors.valuationInstant?: { readonly level: EpochMs; }; default: not declared - target.taylor.factors.valuationInstant.level: number; default: not declared - target.taylor.factors.volatility?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.volatility.level: number; default: not declared - target.taylor.factors.volatility.subject: string; default: not declared - target.taylor.sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; default: not declared - target.taylor.sensitivities.charm?: number; default: not declared - target.taylor.sensitivities.delta?: number; default: not declared - target.taylor.sensitivities.deltaRate?: number; default: not declared - target.taylor.sensitivities.gamma?: number; default: not declared - target.taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - target.taylor.sensitivities.rho?: number; default: not declared - target.taylor.sensitivities.rhoConvexity?: number; default: not declared - target.taylor.sensitivities.theta?: number; default: not declared - target.taylor.sensitivities.thetaConvexity?: number; default: not declared - target.taylor.sensitivities.thetaRate?: number; default: not declared - target.taylor.sensitivities.vanna?: number; default: not declared - target.taylor.sensitivities.vega?: number; default: not declared - target.taylor.sensitivities.vera?: number; default: not declared - target.taylor.sensitivities.veta?: number; default: not declared - target.taylor.sensitivities.vomma?: number; default: not declared - target.taylorDescriptorHash: string; default: not declared - target.underlying?: string; default: not declared - target.valuationMethod: ('full-revaluation') | ('taylor'); default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioFullRevaluationValue Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Successful full-revaluation cell payload. ```typescript /** Successful full-revaluation cell payload. */ export type ScenarioFullRevaluationValue = ScenarioSuccessfulValueFields & { readonly valuationMethod: 'full-revaluation'; readonly pricer: ScenarioPricerDescriptor; readonly pricingResult: ScenarioPricingResult; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - appliedInstructions: readonly ScenarioAppliedInstruction[]; default: not declared - contractMultiplier: number; default: not declared - currencyConversion: ScenarioCurrencyConversionUse | null; default: not declared - currencyConversion.orientation: 'direct' | 'inverted'; default: not declared - currencyConversion.quote: Readonly; default: not declared - currencyConversion.quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - currencyConversion.quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - currencyConversion.quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - currencyConversion.sourceQuoteIndex: number; default: not declared - effectiveSeed: number | null; default: not declared - factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - observationOrFactorSetHash: string; default: not declared - positionValue: number; default: not declared - pricer: ScenarioPricerDescriptor; default: not declared - pricer.capabilities: Readonly; default: not declared - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared - pricer.version: string; default: not declared - pricingResult: ScenarioPricingResult; default: not declared - pricingResult.assumptions: Readonly>; default: not declared - pricingResult.diagnostics: Readonly & { readonly warnings: readonly QuantWarning[]; }; default: not declared - pricingResult.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pricingResult.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pricingResult.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pricingResult.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pricingResult.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pricingResult.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pricingResult.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pricingResult.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pricingResult.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - pricingResult.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - pricingResult.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - pricingResult.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - pricingResult.diagnostics.selection.selected.name: string; default: not declared - pricingResult.diagnostics.selection.selected.version?: string; default: not declared - pricingResult.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pricingResult.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pricingResult.diagnostics.warnings: (QuantWarning[]) | (readonly QuantWarning[]); default: not declared — Structured warnings; always present (possibly empty). - pricingResult.value: number; default: not declared - quantity: number; default: not declared - reportingCurrency: string; default: not declared - reportingPositionValue: number; default: not declared - resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - targetId: string; default: not declared - targetIndex: number; default: not declared - valuationCurrency: string; default: not declared - valuationMethod: 'full-revaluation'; default: not declared - valuePerUnit: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioMarketResolver Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One synchronous, per-call market-requirement resolver. ```typescript /** One synchronous, per-call market-requirement resolver. */ export interface ScenarioMarketResolver { name: string; version: string; resolve(this: undefined, input: ScenarioMarketResolverInput): ScenarioReadonlyMarketObservation | undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - resolve: (this: undefined, input: ScenarioMarketResolverInput) => ScenarioReadonlyMarketObservation | undefined; default: not declared - resolve().return.requirement: (Readonly) | (Readonly) | (Readonly) | (Readonly) | (Readonly) | (Readonly) | (Readonly); default: not declared - resolve().return.requirement.currency: string; default: not declared - resolve().return.requirement.curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - resolve().return.requirement.expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - resolve().return.requirement.kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - resolve().return.requirement.optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - resolve().return.requirement.strike: number; default: not declared - resolve().return.requirement.symbol: string; default: not declared - resolve().return.value: (ScenarioReadonlyRateCurve) | (number) | (string | number); default: not declared - resolve(input): ScenarioMarketResolverInput; default: not declared - resolve(input).market: { readonly asOf: EpochMs; readonly conventions: { readonly asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; readonly calendar?: string; readonly compounding?: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly conventionsVersion: string; readonly dayCount?: DayCount; }; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').MARKET_SNAPSHOT_KIND; readonly observations: { readonly chains?: { readonly [x: string]: { readonly quotes?: readonly { readonly [x: string]: unknown; }[]; readonly table?: { readonly columnCount: number; readonly columns?: readonly string[]; readonly contentHash: string; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').TABLE_HANDLE_KIND; readonly locator?: string; readonly mediaType?: string; readonly rowCount: number; }; }; }; readonly curves?: { readonly [x: string]: { readonly asOf: EpochMs; readonly compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly currency: string; readonly dayCount: DayCount; readonly interpolation?: string; readonly points: readonly { readonly date: string; readonly zeroRate: number; }[]; }; }; readonly dividendYields?: { readonly [x: string]: number; }; readonly riskFreeRates?: { readonly [x: string]: number; }; readonly spots?: { readonly [x: string]: { readonly currency?: string; readonly price: number; readonly timestampMs?: EpochMs; }; }; readonly surfaces?: { readonly [x: string]: { readonly impliedVolatilities: readonly (readonly number[])[]; readonly strikes: readonly number[]; readonly timeToExpiryYears: readonly number[]; }; }; readonly volatilities?: { readonly [x: string]: number; }; }; readonly provenance?: { readonly asOf?: EpochMs; readonly dataset?: string; readonly provider?: string; readonly receivedAt?: EpochMs; readonly requestId?: string; readonly sourceVersion?: string; readonly warnings?: readonly { readonly code: string; readonly context?: { readonly [x: string]: unknown; }; readonly message: string; readonly severity: import('@insiderfinance/totalfinance/core').WarningSeverity; }[]; }; readonly schemaVersion: number; }; default: not declared - resolve(input).market.asOf: number; default: not declared - resolve(input).market.conventions: { readonly asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; readonly calendar?: string; readonly compounding?: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly conventionsVersion: string; readonly dayCount?: DayCount; }; default: not declared - resolve(input).market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - resolve(input).market.conventions.calendar?: string; default: not declared - resolve(input).market.conventions.compounding?: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; default: not declared - resolve(input).market.conventions.compounding.periodsPerYear: number; default: not declared - resolve(input).market.conventions.compounding.type: 'periodic'; default: not declared - resolve(input).market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - resolve(input).market.conventions.dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - resolve(input).market.kind: 'totalfinance.market-snapshot'; default: not declared - resolve(input).market.observations: { readonly chains?: { readonly [x: string]: { readonly quotes?: readonly { readonly [x: string]: unknown; }[]; readonly table?: { readonly columnCount: number; readonly columns?: readonly string[]; readonly contentHash: string; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').TABLE_HANDLE_KIND; readonly locator?: string; readonly mediaType?: string; readonly rowCount: number; }; }; }; readonly curves?: { readonly [x: string]: { readonly asOf: EpochMs; readonly compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly currency: string; readonly dayCount: DayCount; readonly interpolation?: string; readonly points: readonly { readonly date: string; readonly zeroRate: number; }[]; }; }; readonly dividendYields?: { readonly [x: string]: number; }; readonly riskFreeRates?: { readonly [x: string]: number; }; readonly spots?: { readonly [x: string]: { readonly currency?: string; readonly price: number; readonly timestampMs?: EpochMs; }; }; readonly surfaces?: { readonly [x: string]: { readonly impliedVolatilities: readonly (readonly number[])[]; readonly strikes: readonly number[]; readonly timeToExpiryYears: readonly number[]; }; }; readonly volatilities?: { readonly [x: string]: number; }; }; default: not declared - resolve(input).market.observations.chains?: { readonly [x: string]: { readonly quotes?: readonly { readonly [x: string]: unknown; }[]; readonly table?: { readonly columnCount: number; readonly columns?: readonly string[]; readonly contentHash: string; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').TABLE_HANDLE_KIND; readonly locator?: string; readonly mediaType?: string; readonly rowCount: number; }; }; }; default: not declared - resolve(input).market.observations.curves?: { readonly [x: string]: { readonly asOf: EpochMs; readonly compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly currency: string; readonly dayCount: DayCount; readonly interpolation?: string; readonly points: readonly { readonly date: string; readonly zeroRate: number; }[]; }; }; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - resolve(input).market.observations.dividendYields?: { readonly [x: string]: number; }; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - resolve(input).market.observations.riskFreeRates?: { readonly [x: string]: number; }; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - resolve(input).market.observations.spots?: { readonly [x: string]: { readonly currency?: string; readonly price: number; readonly timestampMs?: EpochMs; }; }; default: not declared - resolve(input).market.observations.surfaces?: { readonly [x: string]: { readonly impliedVolatilities: readonly (readonly number[])[]; readonly strikes: readonly number[]; readonly timeToExpiryYears: readonly number[]; }; }; default: not declared - resolve(input).market.observations.volatilities?: { readonly [x: string]: number; }; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - resolve(input).market.provenance?: { readonly asOf?: EpochMs; readonly dataset?: string; readonly provider?: string; readonly receivedAt?: EpochMs; readonly requestId?: string; readonly sourceVersion?: string; readonly warnings?: readonly { readonly code: string; readonly context?: { readonly [x: string]: unknown; }; readonly message: string; readonly severity: import('@insiderfinance/totalfinance/core').WarningSeverity; }[]; }; default: not declared - resolve(input).market.provenance.asOf?: number; default: not declared - resolve(input).market.provenance.dataset?: string; default: not declared - resolve(input).market.provenance.provider?: string; default: not declared - resolve(input).market.provenance.receivedAt?: number; default: not declared - resolve(input).market.provenance.requestId?: string; default: not declared - resolve(input).market.provenance.sourceVersion?: string; default: not declared - resolve(input).market.provenance.warnings?: readonly { readonly code: string; readonly context?: { readonly [x: string]: unknown; }; readonly message: string; readonly severity: import('@insiderfinance/totalfinance/core').WarningSeverity; }[]; default: not declared - resolve(input).market.schemaVersion: number; default: not declared - resolve(input).requirement: { readonly kind: 'valuationInstant'; readonly optional?: boolean; } | { readonly kind: 'spot'; readonly optional?: boolean; readonly symbol: string; } | { readonly expiresAt: EpochMs; readonly kind: 'forward'; readonly optional?: boolean; readonly symbol: string; } | { readonly expiresAt: EpochMs; readonly kind: 'impliedVolatility'; readonly optional?: boolean; readonly strike: number; readonly symbol: string; } | { readonly currency: string; readonly kind: 'riskFreeRate'; readonly optional?: boolean; } | { readonly kind: 'dividendYield'; readonly optional?: boolean; readonly symbol: string; } | { readonly currency: string; readonly curveId: string; readonly kind: 'discountCurve'; readonly optional?: boolean; }; default: not declared - resolve(input).requirement.currency: string; default: not declared - resolve(input).requirement.curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - resolve(input).requirement.expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - resolve(input).requirement.kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - resolve(input).requirement.optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - resolve(input).requirement.strike: number; default: not declared - resolve(input).requirement.symbol: string; default: not declared - resolve(input).target: { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly instrumentDescriptor: unknown; readonly instrumentDescriptorHash: string; readonly pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'full-revaluation'; } | { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; readonly taylorDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'taylor'; }; default: not declared - resolve(input).target.account?: string; default: not declared - resolve(input).target.book?: string; default: not declared - resolve(input).target.contractMultiplier: number; default: not declared - resolve(input).target.currency: string; default: not declared - resolve(input).target.id: string; default: not declared - resolve(input).target.instrumentDescriptor: unknown; default: not declared - resolve(input).target.instrumentDescriptorHash: string; default: not declared - resolve(input).target.pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; default: not declared - resolve(input).target.pricer.capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; default: not declared - resolve(input).target.pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - resolve(input).target.pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - resolve(input).target.pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - resolve(input).target.pricer.name: string; default: not declared - resolve(input).target.pricer.version: string; default: not declared - resolve(input).target.quantity: number; default: not declared - resolve(input).target.strategy?: string; default: not declared - resolve(input).target.tags: readonly string[]; default: not declared - resolve(input).target.targetDescriptorHash: string; default: not declared - resolve(input).target.taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; default: not declared - resolve(input).target.taylor.baseValuePerUnit: number; default: not declared - resolve(input).target.taylor.factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; default: not declared - resolve(input).target.taylor.factors.dividend?: { readonly level: number; readonly subject: string; }; default: not declared - resolve(input).target.taylor.factors.dividend.level: number; default: not declared - resolve(input).target.taylor.factors.dividend.subject: string; default: not declared - resolve(input).target.taylor.factors.riskFreeRate?: { readonly level: number; readonly subject: string; }; default: not declared - resolve(input).target.taylor.factors.riskFreeRate.level: number; default: not declared - resolve(input).target.taylor.factors.riskFreeRate.subject: string; default: not declared - resolve(input).target.taylor.factors.spot?: { readonly level: number; readonly subject: string; }; default: not declared - resolve(input).target.taylor.factors.spot.level: number; default: not declared - resolve(input).target.taylor.factors.spot.subject: string; default: not declared - resolve(input).target.taylor.factors.valuationInstant?: { readonly level: EpochMs; }; default: not declared - resolve(input).target.taylor.factors.valuationInstant.level: number; default: not declared - resolve(input).target.taylor.factors.volatility?: { readonly level: number; readonly subject: string; }; default: not declared - resolve(input).target.taylor.factors.volatility.level: number; default: not declared - resolve(input).target.taylor.factors.volatility.subject: string; default: not declared - resolve(input).target.taylor.sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; default: not declared - resolve(input).target.taylor.sensitivities.charm?: number; default: not declared - resolve(input).target.taylor.sensitivities.delta?: number; default: not declared - resolve(input).target.taylor.sensitivities.deltaRate?: number; default: not declared - resolve(input).target.taylor.sensitivities.gamma?: number; default: not declared - resolve(input).target.taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - resolve(input).target.taylor.sensitivities.rho?: number; default: not declared - resolve(input).target.taylor.sensitivities.rhoConvexity?: number; default: not declared - resolve(input).target.taylor.sensitivities.theta?: number; default: not declared - resolve(input).target.taylor.sensitivities.thetaConvexity?: number; default: not declared - resolve(input).target.taylor.sensitivities.thetaRate?: number; default: not declared - resolve(input).target.taylor.sensitivities.vanna?: number; default: not declared - resolve(input).target.taylor.sensitivities.vega?: number; default: not declared - resolve(input).target.taylor.sensitivities.vera?: number; default: not declared - resolve(input).target.taylor.sensitivities.veta?: number; default: not declared - resolve(input).target.taylor.sensitivities.vomma?: number; default: not declared - resolve(input).target.taylorDescriptorHash: string; default: not declared - resolve(input).target.underlying?: string; default: not declared - resolve(input).target.valuationMethod: ('full-revaluation') | ('taylor'); default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioMarketResolverInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Frozen, behavior-free input supplied to one market resolver call. ```typescript /** Frozen, behavior-free input supplied to one market resolver call. */ export interface ScenarioMarketResolverInput { readonly requirement: ScenarioReadonlyData; readonly market: ScenarioReadonlyData; readonly target: ScenarioReadonlyData; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - market: { readonly asOf: EpochMs; readonly conventions: { readonly asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; readonly calendar?: string; readonly compounding?: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly conventionsVersion: string; readonly dayCount?: DayCount; }; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').MARKET_SNAPSHOT_KIND; readonly observations: { readonly chains?: { readonly [x: string]: { readonly quotes?: readonly { readonly [x: string]: unknown; }[]; readonly table?: { readonly columnCount: number; readonly columns?: readonly string[]; readonly contentHash: string; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').TABLE_HANDLE_KIND; readonly locator?: string; readonly mediaType?: string; readonly rowCount: number; }; }; }; readonly curves?: { readonly [x: string]: { readonly asOf: EpochMs; readonly compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly currency: string; readonly dayCount: DayCount; readonly interpolation?: string; readonly points: readonly { readonly date: string; readonly zeroRate: number; }[]; }; }; readonly dividendYields?: { readonly [x: string]: number; }; readonly riskFreeRates?: { readonly [x: string]: number; }; readonly spots?: { readonly [x: string]: { readonly currency?: string; readonly price: number; readonly timestampMs?: EpochMs; }; }; readonly surfaces?: { readonly [x: string]: { readonly impliedVolatilities: readonly (readonly number[])[]; readonly strikes: readonly number[]; readonly timeToExpiryYears: readonly number[]; }; }; readonly volatilities?: { readonly [x: string]: number; }; }; readonly provenance?: { readonly asOf?: EpochMs; readonly dataset?: string; readonly provider?: string; readonly receivedAt?: EpochMs; readonly requestId?: string; readonly sourceVersion?: string; readonly warnings?: readonly { readonly code: string; readonly context?: { readonly [x: string]: unknown; }; readonly message: string; readonly severity: import('@insiderfinance/totalfinance/core').WarningSeverity; }[]; }; readonly schemaVersion: number; }; default: not declared - market.asOf: number; default: not declared - market.conventions: { readonly asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; readonly calendar?: string; readonly compounding?: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly conventionsVersion: string; readonly dayCount?: DayCount; }; default: not declared - market.conventions.asOfConvention: import('@insiderfinance/totalfinance/core/artifacts').MarketSnapshotAsOfConvention; default: not declared — How `asOf` was expressed at create time; stamped, not caller-set. `'explicit-instant'` — epoch ms or a zoned datetime; `'date-midnight-utc'` — a bare `YYYY-MM-DD`, the ledger's date-granular convention (calendar date D at 00:00 UTC). Option-pricing consumers refuse a date-granular snapshot through {@link requireInstantMarketSnapshot}: the time of day prices a same-day option. - market.conventions.calendar?: string; default: not declared - market.conventions.compounding?: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; default: not declared - market.conventions.compounding.periodsPerYear: number; default: not declared - market.conventions.compounding.type: 'periodic'; default: not declared - market.conventions.conventionsVersion: string; default: not declared — The library conventions revision the snapshot was created under; stamped, not caller-set. - market.conventions.dayCount?: DayCount; default: not declared — Quote basis for the flat `riskFreeRates`/`dividendYields` sections. Required with them. - market.kind: 'totalfinance.market-snapshot'; default: not declared - market.observations: { readonly chains?: { readonly [x: string]: { readonly quotes?: readonly { readonly [x: string]: unknown; }[]; readonly table?: { readonly columnCount: number; readonly columns?: readonly string[]; readonly contentHash: string; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').TABLE_HANDLE_KIND; readonly locator?: string; readonly mediaType?: string; readonly rowCount: number; }; }; }; readonly curves?: { readonly [x: string]: { readonly asOf: EpochMs; readonly compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly currency: string; readonly dayCount: DayCount; readonly interpolation?: string; readonly points: readonly { readonly date: string; readonly zeroRate: number; }[]; }; }; readonly dividendYields?: { readonly [x: string]: number; }; readonly riskFreeRates?: { readonly [x: string]: number; }; readonly spots?: { readonly [x: string]: { readonly currency?: string; readonly price: number; readonly timestampMs?: EpochMs; }; }; readonly surfaces?: { readonly [x: string]: { readonly impliedVolatilities: readonly (readonly number[])[]; readonly strikes: readonly number[]; readonly timeToExpiryYears: readonly number[]; }; }; readonly volatilities?: { readonly [x: string]: number; }; }; default: not declared - market.observations.chains?: { readonly [x: string]: { readonly quotes?: readonly { readonly [x: string]: unknown; }[]; readonly table?: { readonly columnCount: number; readonly columns?: readonly string[]; readonly contentHash: string; readonly kind: typeof import('@insiderfinance/totalfinance/core/artifacts').TABLE_HANDLE_KIND; readonly locator?: string; readonly mediaType?: string; readonly rowCount: number; }; }; }; default: not declared - market.observations.curves?: { readonly [x: string]: { readonly asOf: EpochMs; readonly compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; readonly currency: string; readonly dayCount: DayCount; readonly interpolation?: string; readonly points: readonly { readonly date: string; readonly zeroRate: number; }[]; }; }; default: not declared — Full dated curves, keyed by a caller label (e.g. `'USD.sofr'`). Each carries its own conventions. - market.observations.dividendYields?: { readonly [x: string]: number; }; default: not declared — Flat continuous dividend/borrow yields as decimals, keyed by symbol. - market.observations.riskFreeRates?: { readonly [x: string]: number; }; default: not declared — Flat annual rates as decimals, keyed by currency, quoted under the envelope conventions. - market.observations.spots?: { readonly [x: string]: { readonly currency?: string; readonly price: number; readonly timestampMs?: EpochMs; }; }; default: not declared - market.observations.surfaces?: { readonly [x: string]: { readonly impliedVolatilities: readonly (readonly number[])[]; readonly strikes: readonly number[]; readonly timeToExpiryYears: readonly number[]; }; }; default: not declared - market.observations.volatilities?: { readonly [x: string]: number; }; default: not declared — Flat annualized volatilities as decimals, keyed by symbol. - market.provenance?: { readonly asOf?: EpochMs; readonly dataset?: string; readonly provider?: string; readonly receivedAt?: EpochMs; readonly requestId?: string; readonly sourceVersion?: string; readonly warnings?: readonly { readonly code: string; readonly context?: { readonly [x: string]: unknown; }; readonly message: string; readonly severity: import('@insiderfinance/totalfinance/core').WarningSeverity; }[]; }; default: not declared - market.provenance.asOf?: number; default: not declared - market.provenance.dataset?: string; default: not declared - market.provenance.provider?: string; default: not declared - market.provenance.receivedAt?: number; default: not declared - market.provenance.requestId?: string; default: not declared - market.provenance.sourceVersion?: string; default: not declared - market.provenance.warnings?: readonly { readonly code: string; readonly context?: { readonly [x: string]: unknown; }; readonly message: string; readonly severity: import('@insiderfinance/totalfinance/core').WarningSeverity; }[]; default: not declared - market.schemaVersion: number; default: not declared - requirement: { readonly kind: 'valuationInstant'; readonly optional?: boolean; } | { readonly kind: 'spot'; readonly optional?: boolean; readonly symbol: string; } | { readonly expiresAt: EpochMs; readonly kind: 'forward'; readonly optional?: boolean; readonly symbol: string; } | { readonly expiresAt: EpochMs; readonly kind: 'impliedVolatility'; readonly optional?: boolean; readonly strike: number; readonly symbol: string; } | { readonly currency: string; readonly kind: 'riskFreeRate'; readonly optional?: boolean; } | { readonly kind: 'dividendYield'; readonly optional?: boolean; readonly symbol: string; } | { readonly currency: string; readonly curveId: string; readonly kind: 'discountCurve'; readonly optional?: boolean; }; default: not declared - requirement.currency: string; default: not declared - requirement.curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - requirement.expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - requirement.kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - requirement.optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - requirement.strike: number; default: not declared - requirement.symbol: string; default: not declared - target: { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly instrumentDescriptor: unknown; readonly instrumentDescriptorHash: string; readonly pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'full-revaluation'; } | { readonly account?: string; readonly book?: string; readonly contractMultiplier: number; readonly currency: string; readonly id: string; readonly quantity: number; readonly strategy?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; readonly taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; readonly taylorDescriptorHash: string; readonly underlying?: string; readonly valuationMethod: 'taylor'; }; default: not declared - target.account?: string; default: not declared - target.book?: string; default: not declared - target.contractMultiplier: number; default: not declared - target.currency: string; default: not declared - target.id: string; default: not declared - target.instrumentDescriptor: unknown; default: not declared - target.instrumentDescriptorHash: string; default: not declared - target.pricer: { readonly capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; readonly name: string; readonly version: string; }; default: not declared - target.pricer.capabilities: { readonly batch: boolean; readonly greeks: 'analytic' | 'finite-difference' | 'delegated' | 'none'; readonly randomness: 'none' | 'seeded'; }; default: not declared - target.pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - target.pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - target.pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - target.pricer.name: string; default: not declared - target.pricer.version: string; default: not declared - target.quantity: number; default: not declared - target.strategy?: string; default: not declared - target.tags: readonly string[]; default: not declared - target.targetDescriptorHash: string; default: not declared - target.taylor: { readonly baseValuePerUnit: number; readonly factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; readonly sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; }; default: not declared - target.taylor.baseValuePerUnit: number; default: not declared - target.taylor.factors: { readonly dividend?: { readonly level: number; readonly subject: string; }; readonly riskFreeRate?: { readonly level: number; readonly subject: string; }; readonly spot?: { readonly level: number; readonly subject: string; }; readonly valuationInstant?: { readonly level: EpochMs; }; readonly volatility?: { readonly level: number; readonly subject: string; }; }; default: not declared - target.taylor.factors.dividend?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.dividend.level: number; default: not declared - target.taylor.factors.dividend.subject: string; default: not declared - target.taylor.factors.riskFreeRate?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.riskFreeRate.level: number; default: not declared - target.taylor.factors.riskFreeRate.subject: string; default: not declared - target.taylor.factors.spot?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.spot.level: number; default: not declared - target.taylor.factors.spot.subject: string; default: not declared - target.taylor.factors.valuationInstant?: { readonly level: EpochMs; }; default: not declared - target.taylor.factors.valuationInstant.level: number; default: not declared - target.taylor.factors.volatility?: { readonly level: number; readonly subject: string; }; default: not declared - target.taylor.factors.volatility.level: number; default: not declared - target.taylor.factors.volatility.subject: string; default: not declared - target.taylor.sensitivities: { readonly charm?: number; readonly delta?: number; readonly deltaRate?: number; readonly gamma?: number; readonly phi?: number; readonly rho?: number; readonly rhoConvexity?: number; readonly theta?: number; readonly thetaConvexity?: number; readonly thetaRate?: number; readonly vanna?: number; readonly vega?: number; readonly vera?: number; readonly veta?: number; readonly vomma?: number; }; default: not declared - target.taylor.sensitivities.charm?: number; default: not declared - target.taylor.sensitivities.delta?: number; default: not declared - target.taylor.sensitivities.deltaRate?: number; default: not declared - target.taylor.sensitivities.gamma?: number; default: not declared - target.taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - target.taylor.sensitivities.rho?: number; default: not declared - target.taylor.sensitivities.rhoConvexity?: number; default: not declared - target.taylor.sensitivities.theta?: number; default: not declared - target.taylor.sensitivities.thetaConvexity?: number; default: not declared - target.taylor.sensitivities.thetaRate?: number; default: not declared - target.taylor.sensitivities.vanna?: number; default: not declared - target.taylor.sensitivities.vega?: number; default: not declared - target.taylor.sensitivities.vera?: number; default: not declared - target.taylor.sensitivities.veta?: number; default: not declared - target.taylor.sensitivities.vomma?: number; default: not declared - target.taylorDescriptorHash: string; default: not declared - target.underlying?: string; default: not declared - target.valuationMethod: ('full-revaluation') | ('taylor'); default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioMetric Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Estimated and observed value for one execution metric. ```typescript /** Estimated and observed value for one execution metric. */ export interface ScenarioMetric { readonly estimated: number; readonly actual: number | null; readonly unavailableReason: string | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - actual: number | null; default: not declared - estimated: number; default: not declared - unavailableReason: string | null; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioOutcomeAggregateSet Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate rows for one scenario. ```typescript /** Aggregate rows for one scenario. */ export interface ScenarioOutcomeAggregateSet { readonly kind: 'scenario'; readonly scenarioIndex: number; readonly scenarioName: string; readonly rows: readonly ScenarioAggregateRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'scenario'; default: not declared - rows: readonly ScenarioAggregateRow[]; default: not declared - scenarioIndex: number; default: not declared - scenarioName: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioPortfolioBinding Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opaque, builder-produced durable-portfolio scenario binding. ```typescript /** Opaque, builder-produced durable-portfolio scenario binding. */ export type ScenarioPortfolioBinding = ScenarioPortfolioBindingDescriptor & { readonly [scenarioPortfolioBindingBrand]: true; }; ``` ### @insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingBaseInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Identity and grouping supplied by a durable-portfolio binding. ```typescript /** Identity and grouping supplied by a durable-portfolio binding. */ export interface ScenarioPortfolioBindingBaseInput { id: string; accountId: string; instrumentId: string; strategy?: string; book?: string; tags?: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - book?: string; default: not declared - id: string; default: not declared - instrumentId: string; default: not declared - strategy?: string; default: not declared - tags?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingBuilders Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The public two-builder durable-portfolio binding namespace. ```typescript /** The public two-builder durable-portfolio binding namespace. */ export interface ScenarioPortfolioBindingBuilders { fullRevaluation(input: FullRevaluationScenarioPortfolioBindingInput): ScenarioPortfolioBinding; taylor(input: TaylorScenarioPortfolioBindingInput): ScenarioPortfolioBinding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fullRevaluation: (input: FullRevaluationScenarioPortfolioBindingInput) => ScenarioPortfolioBinding; default: not declared - fullRevaluation(input): FullRevaluationScenarioPortfolioBindingInput; default: not declared - fullRevaluation(input).accountId: string; default: not declared - fullRevaluation(input).book?: string; default: not declared - fullRevaluation(input).id: string; default: not declared - fullRevaluation(input).instrument: TInstrument; default: not declared - fullRevaluation(input).instrumentDescriptor?: unknown; default: not declared - fullRevaluation(input).instrumentId: string; default: not declared - fullRevaluation(input).pricer: Pricer, PricerValuationResult>; default: not declared - fullRevaluation(input).strategy?: string; default: not declared - fullRevaluation(input).tags?: readonly string[]; default: not declared - taylor: (input: TaylorScenarioPortfolioBindingInput) => ScenarioPortfolioBinding; default: not declared - taylor(input): TaylorScenarioPortfolioBindingInput; default: not declared - taylor(input).accountId: string; default: not declared - taylor(input).baseValuePerUnit: number; default: not declared - taylor(input).book?: string; default: not declared - taylor(input).factors: TaylorFactors; default: not declared - taylor(input).greeks: TaylorSensitivities; default: not declared - taylor(input).id: string; default: not declared - taylor(input).instrumentId: string; default: not declared - taylor(input).strategy?: string; default: not declared - taylor(input).tags?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingDescriptor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete public durable-portfolio binding data. ```typescript /** Complete public durable-portfolio binding data. */ export type ScenarioPortfolioBindingDescriptor = FullRevaluationScenarioPortfolioBindingDescriptor | TaylorScenarioPortfolioBindingDescriptor; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - bindingDescriptorHash: string; default: not declared - book?: string; default: not declared - id: string; default: not declared - instrumentDescriptor: unknown; default: not declared - instrumentDescriptorHash: string; default: not declared - instrumentId: string; default: not declared - pricer: ScenarioPricerDescriptor; default: not declared - pricer.capabilities: Readonly; default: not declared - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared - pricer.version: string; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - taylor: { readonly baseValuePerUnit: number; readonly factors: TaylorFactors; readonly sensitivities: Readonly; }; default: not declared - taylor.baseValuePerUnit: number; default: not declared - taylor.factors: TaylorFactors; default: not declared - taylor.factors.dividend?: TaylorFactorLevel; default: not declared - taylor.factors.dividend.level: number; default: not declared - taylor.factors.dividend.subject: string; default: not declared - taylor.factors.riskFreeRate?: TaylorFactorLevel; default: not declared - taylor.factors.riskFreeRate.level: number; default: not declared - taylor.factors.riskFreeRate.subject: string; default: not declared - taylor.factors.spot?: TaylorFactorLevel; default: not declared - taylor.factors.spot.level: number; default: not declared - taylor.factors.spot.subject: string; default: not declared - taylor.factors.valuationInstant?: TaylorValuationInstantLevel; default: not declared - taylor.factors.valuationInstant.level: number; default: not declared - taylor.factors.volatility?: TaylorFactorLevel; default: not declared - taylor.factors.volatility.level: number; default: not declared - taylor.factors.volatility.subject: string; default: not declared - taylor.sensitivities: Readonly; default: not declared - taylor.sensitivities.charm?: number; default: not declared - taylor.sensitivities.delta?: number; default: not declared - taylor.sensitivities.deltaRate?: number; default: not declared - taylor.sensitivities.gamma?: number; default: not declared - taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - taylor.sensitivities.rho?: number; default: not declared - taylor.sensitivities.rhoConvexity?: number; default: not declared - taylor.sensitivities.theta?: number; default: not declared - taylor.sensitivities.thetaConvexity?: number; default: not declared - taylor.sensitivities.thetaRate?: number; default: not declared - taylor.sensitivities.vanna?: number; default: not declared - taylor.sensitivities.vega?: number; default: not declared - taylor.sensitivities.vera?: number; default: not declared - taylor.sensitivities.veta?: number; default: not declared - taylor.sensitivities.vomma?: number; default: not declared - taylorDescriptorHash: string; default: not declared - valuationMethod: ('full-revaluation') | ('taylor'); default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingDescriptorBase Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable durable-portfolio binding identity. ```typescript /** Serializable durable-portfolio binding identity. */ export interface ScenarioPortfolioBindingDescriptorBase { readonly id: string; readonly accountId: string; readonly instrumentId: string; readonly strategy?: string; readonly book?: string; readonly tags: readonly string[]; readonly bindingDescriptorHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - bindingDescriptorHash: string; default: not declared - book?: string; default: not declared - id: string; default: not declared - instrumentId: string; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioPricerDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable identity and capabilities of the behavior bound to a target. ```typescript /** Serializable identity and capabilities of the behavior bound to a target. */ export interface ScenarioPricerDescriptor { readonly name: string; readonly version: string; readonly capabilities: Readonly; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capabilities: Readonly; default: not declared - capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - name: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioPricingResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Detached Gate-C pricing result retained without discarding domain-specific fields. ```typescript /** Detached Gate-C pricing result retained without discarding domain-specific fields. */ export type ScenarioPricingResult = Readonly> & { readonly value: number; readonly assumptions: Readonly>; readonly diagnostics: Readonly & { readonly warnings: readonly QuantWarning[]; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Readonly>; default: not declared - diagnostics: Readonly & { readonly warnings: readonly QuantWarning[]; }; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: (QuantWarning[]) | (readonly QuantWarning[]); default: not declared — Structured warnings; always present (possibly empty). - value: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioReadonlyData Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Recursively readonly view of canonical scenario callback data. ```typescript /** Recursively readonly view of canonical scenario callback data. */ export type ScenarioReadonlyData = T extends object ? { readonly [TKey in keyof T]: ScenarioReadonlyData; } : T; ``` ### @insiderfinance/totalfinance/scenarios#ScenarioReadonlyMarketObservation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Named, tool-walkable readonly projection of core's existing `MarketObservation` union. The arm/value grammar remains owned by `@insiderfinance/totalfinance/core/pricing`; this view references those source types directly and changes only mutability at the callback boundary. ```typescript /** * Named, tool-walkable readonly projection of core's existing `MarketObservation` union. * * The arm/value grammar remains owned by `@insiderfinance/totalfinance/core/pricing`; this view references those * source types directly and changes only mutability at the callback boundary. */ export type ScenarioReadonlyMarketObservation = { readonly requirement: Readonly; readonly value: ObservationValueByKind['valuationInstant']; } | { readonly requirement: Readonly; readonly value: ObservationValueByKind['spot']; } | { readonly requirement: Readonly; readonly value: ObservationValueByKind['forward']; } | { readonly requirement: Readonly; readonly value: ObservationValueByKind['impliedVolatility']; } | { readonly requirement: Readonly; readonly value: ObservationValueByKind['riskFreeRate']; } | { readonly requirement: Readonly; readonly value: ObservationValueByKind['dividendYield']; } | { readonly requirement: Readonly; readonly value: ScenarioReadonlyRateCurve; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - requirement: (Readonly) | (Readonly) | (Readonly) | (Readonly) | (Readonly) | (Readonly) | (Readonly); default: not declared - requirement.currency: string; default: not declared - requirement.curveId: string; default: not declared — The snapshot `observations.curves` label naming the exact curve (e.g. `'USD.sofr'`). - requirement.expiresAt: number; default: not declared — Delivery/expiry instant (epoch ms) the forward settles to. Expiration instant (epoch ms) of the contract the volatility belongs to. - requirement.kind: ('discountCurve') | ('dividendYield') | ('forward') | ('impliedVolatility') | ('riskFreeRate') | ('spot') | ('valuationInstant'); default: not declared - requirement.optional?: boolean; default: not declared — `true` marks a requirement the pricer consumes when present and defaults DISCLOSED otherwise. - requirement.strike: number; default: not declared - requirement.symbol: string; default: not declared - value: (ScenarioReadonlyRateCurve) | (number) | (string | number); default: not declared - value.asOf: number; default: not declared - value.compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; default: not declared - value.compounding.periodsPerYear: number; default: not declared - value.compounding.type: 'periodic'; default: not declared - value.currency: string; default: not declared - value.dayCount: DayCount; default: not declared - value.interpolation?: string | undefined; default: not declared - value.points: readonly ScenarioReadonlyRateCurvePoint[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioReadonlyRateCurve Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Readonly callback view of core's existing plain-data `RateCurve`. ```typescript /** Readonly callback view of core's existing plain-data `RateCurve`. */ export interface ScenarioReadonlyRateCurve { readonly currency: RateCurve['currency']; readonly asOf: RateCurve['asOf']; readonly dayCount: RateCurve['dayCount']; readonly compounding: ScenarioReadonlyData; readonly points: readonly ScenarioReadonlyRateCurvePoint[]; readonly interpolation?: RateCurve['interpolation']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: number; default: not declared - compounding: 'simple' | 'continuous' | 'annual' | 'semiannual' | 'quarterly' | 'monthly' | { readonly periodsPerYear: number; readonly type: 'periodic'; }; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - currency: string; default: not declared - dayCount: DayCount; default: not declared - interpolation?: string | undefined; default: not declared - points: readonly ScenarioReadonlyRateCurvePoint[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioReadonlyRateCurvePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Readonly curve pillar supplied to or returned from a scenario callback. ```typescript /** Readonly curve pillar supplied to or returned from a scenario callback. */ export interface ScenarioReadonlyRateCurvePoint { readonly date: RateCurvePoint['date']; readonly zeroRate: RateCurvePoint['zeroRate']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date: string; default: not declared - zeroRate: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioReplayParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical JSON-safe parameters needed to reproduce a run. ```typescript /** Canonical JSON-safe parameters needed to reproduce a run. */ export interface ScenarioReplayParameters { readonly reportingCurrency: string; readonly currencyConversions: readonly Readonly[]; readonly failureMode: 'fail-fast' | 'collect'; readonly seed: number | null; readonly maximumValuationCells: number; readonly maximumWorkUnits: number; readonly resolvers: readonly ScenarioBehaviorIdentity[]; readonly factorHandlers: readonly ScenarioBehaviorIdentity[]; readonly timeShockDayCount: 'ACT/365F'; readonly millisecondsPerYear: 31536000000; readonly resultLayout: 'scenario-major-v1'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currencyConversions: readonly Readonly[]; default: not declared - factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - failureMode: 'fail-fast' | 'collect'; default: not declared - maximumValuationCells: number; default: not declared - maximumWorkUnits: number; default: not declared - millisecondsPerYear: 31536000000; default: not declared - reportingCurrency: string; default: not declared - resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - resultLayout: 'scenario-major-v1'; default: not declared - seed: number | null; default: not declared - timeShockDayCount: 'ACT/365F'; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioReplayTargetBinding Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit behavior-only handoff used by artifact replay fixtures. ```typescript /** Explicit behavior-only handoff used by artifact replay fixtures. */ export interface ScenarioReplayTargetBinding { readonly targetId: string; readonly target: ScenarioTarget; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - target: ScenarioTarget; default: not declared - targetId: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioResultLayout Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Stable flat-grid indexing contract. ```typescript /** Stable flat-grid indexing contract. */ export interface ScenarioResultLayout { readonly order: 'scenario-major-v1'; readonly targetCount: number; readonly scenarioCount: number; readonly cellsPerScenario: number; readonly cellCount: number; readonly indexFormula: 'scenarioIndex * targetCount + targetIndex'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cellCount: number; default: not declared - cellsPerScenario: number; default: not declared - indexFormula: 'scenarioIndex * targetCount + targetIndex'; default: not declared - order: 'scenario-major-v1'; default: not declared - scenarioCount: number; default: not declared - targetCount: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioRunAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete assumptions and execution laws applied by the runner. ```typescript /** Complete assumptions and execution laws applied by the runner. */ export interface ScenarioRunAssumptions { readonly conventionsVersion: string; readonly scenarioSetName: string; readonly scenarioSetHash: string; readonly marketSnapshotHash: string; readonly marketAsOf: EpochMs; readonly inputRateDayCount: DayCount | null; readonly inputRateCompounding: InterestCompounding | null; readonly resolvedScalarRateDayCount: 'ACT/365F'; readonly resolvedScalarRateCompounding: 'continuous'; readonly reportingCurrency: string; readonly currencyConversionPolicy: 'direct-or-inverse-only'; readonly tagAggregationPolicy: 'overlapping-non-additive; grand total is target-based'; readonly valuationUnitScaling: 'valuePerUnit * quantity * contractMultiplier'; readonly timeShockDayCount: 'ACT/365F'; readonly millisecondsPerYear: 31536000000; readonly failureMode: 'fail-fast' | 'collect'; readonly baseSeed: number | null; readonly seedDerivation: 'seed + targetIndex; common across base and scenarios' | null; readonly resolvers: readonly ScenarioBehaviorIdentity[]; readonly factorHandlers: readonly ScenarioBehaviorIdentity[]; readonly resultLayout: 'scenario-major-v1'; readonly workBudgets: { readonly valuationCells: { readonly configured: number; readonly default: 10000; readonly hardMaximum: 50000; }; readonly workUnits: { readonly configured: number; readonly default: 20000000; readonly hardMaximum: 100000000; }; }; readonly replayParameters: ScenarioReplayParameters; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseSeed: number | null; default: not declared - conventionsVersion: string; default: not declared - currencyConversionPolicy: 'direct-or-inverse-only'; default: not declared - factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - failureMode: 'fail-fast' | 'collect'; default: not declared - inputRateCompounding: InterestCompounding | null; default: not declared - inputRateCompounding.periodsPerYear: number; default: not declared - inputRateCompounding.type: 'periodic'; default: not declared - inputRateDayCount: DayCount | null; default: not declared - marketAsOf: number; default: not declared - marketSnapshotHash: string; default: not declared - millisecondsPerYear: 31536000000; default: not declared - replayParameters: ScenarioReplayParameters; default: not declared - replayParameters.currencyConversions: readonly Readonly[]; default: not declared - replayParameters.factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - replayParameters.failureMode: 'fail-fast' | 'collect'; default: not declared - replayParameters.maximumValuationCells: number; default: not declared - replayParameters.maximumWorkUnits: number; default: not declared - replayParameters.millisecondsPerYear: 31536000000; default: not declared - replayParameters.reportingCurrency: string; default: not declared - replayParameters.resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - replayParameters.resultLayout: 'scenario-major-v1'; default: not declared - replayParameters.seed: number | null; default: not declared - replayParameters.timeShockDayCount: 'ACT/365F'; default: not declared - reportingCurrency: string; default: not declared - resolvedScalarRateCompounding: 'continuous'; default: not declared - resolvedScalarRateDayCount: 'ACT/365F'; default: not declared - resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - resultLayout: 'scenario-major-v1'; default: not declared - scenarioSetHash: string; default: not declared - scenarioSetName: string; default: not declared - seedDerivation: 'seed + targetIndex; common across base and scenarios' | null; default: not declared - tagAggregationPolicy: 'overlapping-non-additive; grand total is target-based'; default: not declared - timeShockDayCount: 'ACT/365F'; default: not declared - valuationUnitScaling: 'valuePerUnit * quantity * contractMultiplier'; default: not declared - workBudgets: { readonly valuationCells: { readonly configured: number; readonly default: 10000; readonly hardMaximum: 50000; }; readonly workUnits: { readonly configured: number; readonly default: 20000000; readonly hardMaximum: 100000000; }; }; default: not declared - workBudgets.valuationCells: { readonly configured: number; readonly default: 10000; readonly hardMaximum: 50000; }; default: not declared - workBudgets.valuationCells.configured: number; default: not declared - workBudgets.valuationCells.default: 10000; default: not declared - workBudgets.valuationCells.hardMaximum: 50000; default: not declared - workBudgets.workUnits: { readonly configured: number; readonly default: 20000000; readonly hardMaximum: 100000000; }; default: not declared - workBudgets.workUnits.configured: number; default: not declared - workBudgets.workUnits.default: 20000000; default: not declared - workBudgets.workUnits.hardMaximum: 100000000; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioRunDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Warnings, failures, unused inputs, and bounded-work evidence. ```typescript /** Warnings, failures, unused inputs, and bounded-work evidence. */ export interface ScenarioRunDiagnostics { readonly warnings: readonly QuantWarning[]; readonly failures: readonly ScenarioExecutionFailure[]; readonly unusedCurrencyConversions: readonly Readonly[]; readonly metrics: ScenarioRunMetrics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - failures: readonly ScenarioExecutionFailure[]; default: not declared - metrics: ScenarioRunMetrics; default: not declared - metrics.blockedCells: ScenarioMetric; default: not declared - metrics.blockedCells.actual: number | null; default: not declared - metrics.blockedCells.estimated: number; default: not declared - metrics.blockedCells.unavailableReason: string | null; default: not declared - metrics.factorHandlerCalls: ScenarioMetric; default: not declared - metrics.factorHandlerCalls.actual: number | null; default: not declared - metrics.factorHandlerCalls.estimated: number; default: not declared - metrics.factorHandlerCalls.unavailableReason: string | null; default: not declared - metrics.failedCells: ScenarioMetric; default: not declared - metrics.failedCells.actual: number | null; default: not declared - metrics.failedCells.estimated: number; default: not declared - metrics.failedCells.unavailableReason: string | null; default: not declared - metrics.failureSnapshotWorkUnits: ScenarioMetric; default: not declared - metrics.failureSnapshotWorkUnits.actual: number | null; default: not declared - metrics.failureSnapshotWorkUnits.estimated: number; default: not declared - metrics.failureSnapshotWorkUnits.unavailableReason: string | null; default: not declared - metrics.inputDataWorkUnits: ScenarioMetric; default: not declared - metrics.inputDataWorkUnits.actual: number | null; default: not declared - metrics.inputDataWorkUnits.estimated: number; default: not declared - metrics.inputDataWorkUnits.unavailableReason: string | null; default: not declared - metrics.pricerCalls: ScenarioMetric; default: not declared - metrics.pricerCalls.actual: number | null; default: not declared - metrics.pricerCalls.estimated: number; default: not declared - metrics.pricerCalls.unavailableReason: string | null; default: not declared - metrics.requirements: ScenarioMetric; default: not declared - metrics.requirements.actual: number | null; default: not declared - metrics.requirements.estimated: number; default: not declared - metrics.requirements.unavailableReason: string | null; default: not declared - metrics.resolverCalls: ScenarioMetric; default: not declared - metrics.resolverCalls.actual: number | null; default: not declared - metrics.resolverCalls.estimated: number; default: not declared - metrics.resolverCalls.unavailableReason: string | null; default: not declared - metrics.resultEnvelopeWorkUnits: ScenarioMetric; default: not declared - metrics.resultEnvelopeWorkUnits.actual: number | null; default: not declared - metrics.resultEnvelopeWorkUnits.estimated: number; default: not declared - metrics.resultEnvelopeWorkUnits.unavailableReason: string | null; default: not declared - metrics.successfulCells: ScenarioMetric; default: not declared - metrics.successfulCells.actual: number | null; default: not declared - metrics.successfulCells.estimated: number; default: not declared - metrics.successfulCells.unavailableReason: string | null; default: not declared - metrics.supportsCalls: ScenarioMetric; default: not declared - metrics.supportsCalls.actual: number | null; default: not declared - metrics.supportsCalls.estimated: number; default: not declared - metrics.supportsCalls.unavailableReason: string | null; default: not declared - metrics.taylorCalls: ScenarioMetric; default: not declared - metrics.taylorCalls.actual: number | null; default: not declared - metrics.taylorCalls.estimated: number; default: not declared - metrics.taylorCalls.unavailableReason: string | null; default: not declared - metrics.totalWorkUnits: ScenarioMetric; default: not declared - metrics.totalWorkUnits.actual: number | null; default: not declared - metrics.totalWorkUnits.estimated: number; default: not declared - metrics.totalWorkUnits.unavailableReason: string | null; default: not declared - metrics.transformationWorkUnits: ScenarioMetric; default: not declared - metrics.transformationWorkUnits.actual: number | null; default: not declared - metrics.transformationWorkUnits.estimated: number; default: not declared - metrics.transformationWorkUnits.unavailableReason: string | null; default: not declared - metrics.valuationCells: ScenarioMetric; default: not declared - metrics.valuationCells.actual: number | null; default: not declared - metrics.valuationCells.estimated: number; default: not declared - metrics.valuationCells.unavailableReason: string | null; default: not declared - metrics.valuationResultWorkUnits: ScenarioMetric; default: not declared - metrics.valuationResultWorkUnits.actual: number | null; default: not declared - metrics.valuationResultWorkUnits.estimated: number; default: not declared - metrics.valuationResultWorkUnits.unavailableReason: string | null; default: not declared - unusedCurrencyConversions: readonly Readonly[]; default: not declared - warnings: readonly QuantWarning[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioRunMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bounded-work and execution counters for one run. ```typescript /** Bounded-work and execution counters for one run. */ export interface ScenarioRunMetrics { readonly valuationCells: ScenarioMetric; readonly pricerCalls: ScenarioMetric; readonly taylorCalls: ScenarioMetric; readonly supportsCalls: ScenarioMetric; readonly requirements: ScenarioMetric; readonly resolverCalls: ScenarioMetric; readonly factorHandlerCalls: ScenarioMetric; readonly inputDataWorkUnits: ScenarioMetric; readonly transformationWorkUnits: ScenarioMetric; readonly valuationResultWorkUnits: ScenarioMetric; readonly resultEnvelopeWorkUnits: ScenarioMetric; readonly failureSnapshotWorkUnits: ScenarioMetric; readonly totalWorkUnits: ScenarioMetric; readonly successfulCells: ScenarioMetric; readonly failedCells: ScenarioMetric; readonly blockedCells: ScenarioMetric; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - blockedCells: ScenarioMetric; default: not declared - blockedCells.actual: number | null; default: not declared - blockedCells.estimated: number; default: not declared - blockedCells.unavailableReason: string | null; default: not declared - factorHandlerCalls: ScenarioMetric; default: not declared - factorHandlerCalls.actual: number | null; default: not declared - factorHandlerCalls.estimated: number; default: not declared - factorHandlerCalls.unavailableReason: string | null; default: not declared - failedCells: ScenarioMetric; default: not declared - failedCells.actual: number | null; default: not declared - failedCells.estimated: number; default: not declared - failedCells.unavailableReason: string | null; default: not declared - failureSnapshotWorkUnits: ScenarioMetric; default: not declared - failureSnapshotWorkUnits.actual: number | null; default: not declared - failureSnapshotWorkUnits.estimated: number; default: not declared - failureSnapshotWorkUnits.unavailableReason: string | null; default: not declared - inputDataWorkUnits: ScenarioMetric; default: not declared - inputDataWorkUnits.actual: number | null; default: not declared - inputDataWorkUnits.estimated: number; default: not declared - inputDataWorkUnits.unavailableReason: string | null; default: not declared - pricerCalls: ScenarioMetric; default: not declared - pricerCalls.actual: number | null; default: not declared - pricerCalls.estimated: number; default: not declared - pricerCalls.unavailableReason: string | null; default: not declared - requirements: ScenarioMetric; default: not declared - requirements.actual: number | null; default: not declared - requirements.estimated: number; default: not declared - requirements.unavailableReason: string | null; default: not declared - resolverCalls: ScenarioMetric; default: not declared - resolverCalls.actual: number | null; default: not declared - resolverCalls.estimated: number; default: not declared - resolverCalls.unavailableReason: string | null; default: not declared - resultEnvelopeWorkUnits: ScenarioMetric; default: not declared - resultEnvelopeWorkUnits.actual: number | null; default: not declared - resultEnvelopeWorkUnits.estimated: number; default: not declared - resultEnvelopeWorkUnits.unavailableReason: string | null; default: not declared - successfulCells: ScenarioMetric; default: not declared - successfulCells.actual: number | null; default: not declared - successfulCells.estimated: number; default: not declared - successfulCells.unavailableReason: string | null; default: not declared - supportsCalls: ScenarioMetric; default: not declared - supportsCalls.actual: number | null; default: not declared - supportsCalls.estimated: number; default: not declared - supportsCalls.unavailableReason: string | null; default: not declared - taylorCalls: ScenarioMetric; default: not declared - taylorCalls.actual: number | null; default: not declared - taylorCalls.estimated: number; default: not declared - taylorCalls.unavailableReason: string | null; default: not declared - totalWorkUnits: ScenarioMetric; default: not declared - totalWorkUnits.actual: number | null; default: not declared - totalWorkUnits.estimated: number; default: not declared - totalWorkUnits.unavailableReason: string | null; default: not declared - transformationWorkUnits: ScenarioMetric; default: not declared - transformationWorkUnits.actual: number | null; default: not declared - transformationWorkUnits.estimated: number; default: not declared - transformationWorkUnits.unavailableReason: string | null; default: not declared - valuationCells: ScenarioMetric; default: not declared - valuationCells.actual: number | null; default: not declared - valuationCells.estimated: number; default: not declared - valuationCells.unavailableReason: string | null; default: not declared - valuationResultWorkUnits: ScenarioMetric; default: not declared - valuationResultWorkUnits.actual: number | null; default: not declared - valuationResultWorkUnits.estimated: number; default: not declared - valuationResultWorkUnits.unavailableReason: string | null; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioRunResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete shared scenario analysis result. ```typescript /** Complete shared scenario analysis result. */ export type ScenarioRunResult = Readonly> & { readonly layout: ScenarioResultLayout; readonly scenarioAxis: readonly ScenarioAxisRow[]; readonly targetAxis: readonly ScenarioTargetAxisRow[]; readonly base: readonly ScenarioBaseCell[]; readonly cells: readonly ScenarioCell[]; readonly aggregates: { readonly base: ScenarioBaseAggregateSet; readonly scenarios: readonly ScenarioOutcomeAggregateSet[]; }; readonly assumptions: ScenarioRunAssumptions; readonly diagnostics: ScenarioRunDiagnostics; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregates: { readonly base: ScenarioBaseAggregateSet; readonly scenarios: readonly ScenarioOutcomeAggregateSet[]; }; default: not declared - aggregates.base: ScenarioBaseAggregateSet; default: not declared - aggregates.base.kind: 'base'; default: not declared - aggregates.base.rows: readonly ScenarioAggregateRow[]; default: not declared - aggregates.base.scenarioIndex: null; default: not declared - aggregates.base.scenarioName: null; default: not declared - aggregates.scenarios: readonly ScenarioOutcomeAggregateSet[]; default: not declared - assumptions: ScenarioRunAssumptions; default: not declared - assumptions.baseSeed: number | null; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.currencyConversionPolicy: 'direct-or-inverse-only'; default: not declared - assumptions.factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - assumptions.failureMode: 'fail-fast' | 'collect'; default: not declared - assumptions.inputRateCompounding: InterestCompounding | null; default: not declared - assumptions.inputRateCompounding.periodsPerYear: number; default: not declared - assumptions.inputRateCompounding.type: 'periodic'; default: not declared - assumptions.inputRateDayCount: DayCount | null; default: not declared - assumptions.marketAsOf: number; default: not declared - assumptions.marketSnapshotHash: string; default: not declared - assumptions.millisecondsPerYear: 31536000000; default: not declared - assumptions.replayParameters: ScenarioReplayParameters; default: not declared - assumptions.replayParameters.currencyConversions: readonly Readonly[]; default: not declared - assumptions.replayParameters.factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - assumptions.replayParameters.failureMode: 'fail-fast' | 'collect'; default: not declared - assumptions.replayParameters.maximumValuationCells: number; default: not declared - assumptions.replayParameters.maximumWorkUnits: number; default: not declared - assumptions.replayParameters.millisecondsPerYear: 31536000000; default: not declared - assumptions.replayParameters.reportingCurrency: string; default: not declared - assumptions.replayParameters.resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - assumptions.replayParameters.resultLayout: 'scenario-major-v1'; default: not declared - assumptions.replayParameters.seed: number | null; default: not declared - assumptions.replayParameters.timeShockDayCount: 'ACT/365F'; default: not declared - assumptions.reportingCurrency: string; default: not declared - assumptions.resolvedScalarRateCompounding: 'continuous'; default: not declared - assumptions.resolvedScalarRateDayCount: 'ACT/365F'; default: not declared - assumptions.resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - assumptions.resultLayout: 'scenario-major-v1'; default: not declared - assumptions.scenarioSetHash: string; default: not declared - assumptions.scenarioSetName: string; default: not declared - assumptions.seedDerivation: 'seed + targetIndex; common across base and scenarios' | null; default: not declared - assumptions.tagAggregationPolicy: 'overlapping-non-additive; grand total is target-based'; default: not declared - assumptions.timeShockDayCount: 'ACT/365F'; default: not declared - assumptions.valuationUnitScaling: 'valuePerUnit * quantity * contractMultiplier'; default: not declared - assumptions.workBudgets: { readonly valuationCells: { readonly configured: number; readonly default: 10000; readonly hardMaximum: 50000; }; readonly workUnits: { readonly configured: number; readonly default: 20000000; readonly hardMaximum: 100000000; }; }; default: not declared - assumptions.workBudgets.valuationCells: { readonly configured: number; readonly default: 10000; readonly hardMaximum: 50000; }; default: not declared - assumptions.workBudgets.valuationCells.configured: number; default: not declared - assumptions.workBudgets.valuationCells.default: 10000; default: not declared - assumptions.workBudgets.valuationCells.hardMaximum: 50000; default: not declared - assumptions.workBudgets.workUnits: { readonly configured: number; readonly default: 20000000; readonly hardMaximum: 100000000; }; default: not declared - assumptions.workBudgets.workUnits.configured: number; default: not declared - assumptions.workBudgets.workUnits.default: 20000000; default: not declared - assumptions.workBudgets.workUnits.hardMaximum: 100000000; default: not declared - base: readonly ScenarioBaseCell[]; default: not declared - cells: readonly ScenarioCell[]; default: not declared - diagnostics: ScenarioRunDiagnostics; default: not declared - diagnostics.failures: readonly ScenarioExecutionFailure[]; default: not declared - diagnostics.metrics: ScenarioRunMetrics; default: not declared - diagnostics.metrics.blockedCells: ScenarioMetric; default: not declared - diagnostics.metrics.blockedCells.actual: number | null; default: not declared - diagnostics.metrics.blockedCells.estimated: number; default: not declared - diagnostics.metrics.blockedCells.unavailableReason: string | null; default: not declared - diagnostics.metrics.factorHandlerCalls: ScenarioMetric; default: not declared - diagnostics.metrics.factorHandlerCalls.actual: number | null; default: not declared - diagnostics.metrics.factorHandlerCalls.estimated: number; default: not declared - diagnostics.metrics.factorHandlerCalls.unavailableReason: string | null; default: not declared - diagnostics.metrics.failedCells: ScenarioMetric; default: not declared - diagnostics.metrics.failedCells.actual: number | null; default: not declared - diagnostics.metrics.failedCells.estimated: number; default: not declared - diagnostics.metrics.failedCells.unavailableReason: string | null; default: not declared - diagnostics.metrics.failureSnapshotWorkUnits: ScenarioMetric; default: not declared - diagnostics.metrics.failureSnapshotWorkUnits.actual: number | null; default: not declared - diagnostics.metrics.failureSnapshotWorkUnits.estimated: number; default: not declared - diagnostics.metrics.failureSnapshotWorkUnits.unavailableReason: string | null; default: not declared - diagnostics.metrics.inputDataWorkUnits: ScenarioMetric; default: not declared - diagnostics.metrics.inputDataWorkUnits.actual: number | null; default: not declared - diagnostics.metrics.inputDataWorkUnits.estimated: number; default: not declared - diagnostics.metrics.inputDataWorkUnits.unavailableReason: string | null; default: not declared - diagnostics.metrics.pricerCalls: ScenarioMetric; default: not declared - diagnostics.metrics.pricerCalls.actual: number | null; default: not declared - diagnostics.metrics.pricerCalls.estimated: number; default: not declared - diagnostics.metrics.pricerCalls.unavailableReason: string | null; default: not declared - diagnostics.metrics.requirements: ScenarioMetric; default: not declared - diagnostics.metrics.requirements.actual: number | null; default: not declared - diagnostics.metrics.requirements.estimated: number; default: not declared - diagnostics.metrics.requirements.unavailableReason: string | null; default: not declared - diagnostics.metrics.resolverCalls: ScenarioMetric; default: not declared - diagnostics.metrics.resolverCalls.actual: number | null; default: not declared - diagnostics.metrics.resolverCalls.estimated: number; default: not declared - diagnostics.metrics.resolverCalls.unavailableReason: string | null; default: not declared - diagnostics.metrics.resultEnvelopeWorkUnits: ScenarioMetric; default: not declared - diagnostics.metrics.resultEnvelopeWorkUnits.actual: number | null; default: not declared - diagnostics.metrics.resultEnvelopeWorkUnits.estimated: number; default: not declared - diagnostics.metrics.resultEnvelopeWorkUnits.unavailableReason: string | null; default: not declared - diagnostics.metrics.successfulCells: ScenarioMetric; default: not declared - diagnostics.metrics.successfulCells.actual: number | null; default: not declared - diagnostics.metrics.successfulCells.estimated: number; default: not declared - diagnostics.metrics.successfulCells.unavailableReason: string | null; default: not declared - diagnostics.metrics.supportsCalls: ScenarioMetric; default: not declared - diagnostics.metrics.supportsCalls.actual: number | null; default: not declared - diagnostics.metrics.supportsCalls.estimated: number; default: not declared - diagnostics.metrics.supportsCalls.unavailableReason: string | null; default: not declared - diagnostics.metrics.taylorCalls: ScenarioMetric; default: not declared - diagnostics.metrics.taylorCalls.actual: number | null; default: not declared - diagnostics.metrics.taylorCalls.estimated: number; default: not declared - diagnostics.metrics.taylorCalls.unavailableReason: string | null; default: not declared - diagnostics.metrics.totalWorkUnits: ScenarioMetric; default: not declared - diagnostics.metrics.totalWorkUnits.actual: number | null; default: not declared - diagnostics.metrics.totalWorkUnits.estimated: number; default: not declared - diagnostics.metrics.totalWorkUnits.unavailableReason: string | null; default: not declared - diagnostics.metrics.transformationWorkUnits: ScenarioMetric; default: not declared - diagnostics.metrics.transformationWorkUnits.actual: number | null; default: not declared - diagnostics.metrics.transformationWorkUnits.estimated: number; default: not declared - diagnostics.metrics.transformationWorkUnits.unavailableReason: string | null; default: not declared - diagnostics.metrics.valuationCells: ScenarioMetric; default: not declared - diagnostics.metrics.valuationCells.actual: number | null; default: not declared - diagnostics.metrics.valuationCells.estimated: number; default: not declared - diagnostics.metrics.valuationCells.unavailableReason: string | null; default: not declared - diagnostics.metrics.valuationResultWorkUnits: ScenarioMetric; default: not declared - diagnostics.metrics.valuationResultWorkUnits.actual: number | null; default: not declared - diagnostics.metrics.valuationResultWorkUnits.estimated: number; default: not declared - diagnostics.metrics.valuationResultWorkUnits.unavailableReason: string | null; default: not declared - diagnostics.unusedCurrencyConversions: readonly Readonly[]; default: not declared - diagnostics.warnings: readonly QuantWarning[]; default: not declared - layout: ScenarioResultLayout; default: not declared - layout.cellCount: number; default: not declared - layout.cellsPerScenario: number; default: not declared - layout.indexFormula: 'scenarioIndex * targetCount + targetIndex'; default: not declared - layout.order: 'scenario-major-v1'; default: not declared - layout.scenarioCount: number; default: not declared - layout.targetCount: number; default: not declared - scenarioAxis: readonly ScenarioAxisRow[]; default: not declared - targetAxis: readonly ScenarioTargetAxisRow[]; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioSuccessfulValueFields Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Successful value fields common to base and scenario cells. ```typescript /** Successful value fields common to base and scenario cells. */ export interface ScenarioSuccessfulValueFields { readonly targetIndex: number; readonly targetId: string; readonly quantity: number; readonly contractMultiplier: number; readonly valuationCurrency: string; readonly reportingCurrency: string; readonly valuePerUnit: number; readonly positionValue: number; readonly reportingPositionValue: number; readonly currencyConversion: ScenarioCurrencyConversionUse | null; readonly observationOrFactorSetHash: string; readonly appliedInstructions: readonly ScenarioAppliedInstruction[]; readonly resolvers: readonly ScenarioBehaviorIdentity[]; readonly factorHandlers: readonly ScenarioBehaviorIdentity[]; readonly effectiveSeed: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - appliedInstructions: readonly ScenarioAppliedInstruction[]; default: not declared - contractMultiplier: number; default: not declared - currencyConversion: ScenarioCurrencyConversionUse | null; default: not declared - currencyConversion.orientation: 'direct' | 'inverted'; default: not declared - currencyConversion.quote: Readonly; default: not declared - currencyConversion.quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - currencyConversion.quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - currencyConversion.quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - currencyConversion.sourceQuoteIndex: number; default: not declared - effectiveSeed: number | null; default: not declared - factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - observationOrFactorSetHash: string; default: not declared - positionValue: number; default: not declared - quantity: number; default: not declared - reportingCurrency: string; default: not declared - reportingPositionValue: number; default: not declared - resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - targetId: string; default: not declared - targetIndex: number; default: not declared - valuationCurrency: string; default: not declared - valuePerUnit: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioTarget Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opaque, builder-produced scenario target. ```typescript /** Opaque, builder-produced scenario target. */ export type ScenarioTarget = ScenarioTargetDescriptor & { readonly [scenarioTargetBrand]: true; }; ``` ### @insiderfinance/totalfinance/scenarios#ScenarioTargetAxisRow Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Stable target-axis metadata. ```typescript /** Stable target-axis metadata. */ export type ScenarioTargetAxisRow = ScenarioTargetDescriptor & { readonly targetIndex: number; }; ``` ### @insiderfinance/totalfinance/scenarios#ScenarioTargetBaseInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared identity, scaling, and grouping fields for a scenario target. ```typescript /** Shared identity, scaling, and grouping fields for a scenario target. */ export interface ScenarioTargetBaseInput { id: string; quantity: number; contractMultiplier: number; currency: string; underlying?: string; strategy?: string; account?: string; book?: string; tags?: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - id: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags?: readonly string[]; default: not declared - underlying?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioTargetBuilders Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The public three-builder target namespace. ```typescript /** The public three-builder target namespace. */ export interface ScenarioTargetBuilders { fullRevaluation(input: FullRevaluationScenarioTargetInput): ScenarioTarget; taylor(input: TaylorScenarioTargetInput): ScenarioTarget; spot(input: SpotScenarioTargetInput): ScenarioTarget; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fullRevaluation: (input: FullRevaluationScenarioTargetInput) => ScenarioTarget; default: not declared - fullRevaluation(input): FullRevaluationScenarioTargetInput; default: not declared - fullRevaluation(input).account?: string; default: not declared - fullRevaluation(input).book?: string; default: not declared - fullRevaluation(input).contractMultiplier: number; default: not declared - fullRevaluation(input).currency: string; default: not declared - fullRevaluation(input).id: string; default: not declared - fullRevaluation(input).instrument: TInstrument; default: not declared - fullRevaluation(input).instrumentDescriptor?: unknown; default: not declared - fullRevaluation(input).pricer: Pricer, PricerValuationResult>; default: not declared - fullRevaluation(input).quantity: number; default: not declared - fullRevaluation(input).strategy?: string; default: not declared - fullRevaluation(input).tags?: readonly string[]; default: not declared - fullRevaluation(input).underlying?: string; default: not declared - spot: (input: SpotScenarioTargetInput) => ScenarioTarget; default: not declared - spot(input): SpotScenarioTargetInput; default: not declared - spot(input).account?: string; default: not declared - spot(input).book?: string; default: not declared - spot(input).currency: string; default: not declared - spot(input).id: string; default: not declared - spot(input).quantity: number; default: not declared - spot(input).strategy?: string; default: not declared - spot(input).symbol: string; default: not declared - spot(input).tags?: readonly string[]; default: not declared - taylor: (input: TaylorScenarioTargetInput) => ScenarioTarget; default: not declared - taylor(input): TaylorScenarioTargetInput; default: not declared - taylor(input).account?: string; default: not declared - taylor(input).baseValuePerUnit: number; default: not declared - taylor(input).book?: string; default: not declared - taylor(input).contractMultiplier: number; default: not declared - taylor(input).currency: string; default: not declared - taylor(input).factors: TaylorFactors; default: not declared - taylor(input).greeks: TaylorSensitivities; default: not declared - taylor(input).id: string; default: not declared - taylor(input).quantity: number; default: not declared - taylor(input).strategy?: string; default: not declared - taylor(input).tags?: readonly string[]; default: not declared - taylor(input).underlying?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioTargetDescriptor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Complete public target data, without the private instrument/pricer binding. ```typescript /** Complete public target data, without the private instrument/pricer binding. */ export type ScenarioTargetDescriptor = FullRevaluationScenarioTargetDescriptor | TaylorScenarioTargetDescriptor; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - id: string; default: not declared - instrumentDescriptor: unknown; default: not declared - instrumentDescriptorHash: string; default: not declared - pricer: ScenarioPricerDescriptor; default: not declared - pricer.capabilities: Readonly; default: not declared - pricer.capabilities.batch: boolean; default: not declared — Whether `priceBatch` exists (one observation set, many instruments — the book fast path). - pricer.capabilities.greeks: 'none' | 'analytic' | 'finite-difference' | 'delegated'; default: not declared — How Greeks are produced when `request.greeks` is set: closed-form (`analytic`), bump-and- reprice (`finite-difference`), by whatever engine was selected (`delegated`), or not at all (`none` — the request is not honored and no `greeks` field appears; never fabricated zeros). - pricer.capabilities.randomness: 'none' | 'seeded'; default: not declared — Where the pricer's randomness lives — behaviorally verified, replacing the earlier `deterministic: boolean` (pre-1.0 rename, 2026-08-23, second external review): - `'none'` — same instrument + observations + request → byte-identical COMPLETE results, and a supplied `request.seed` is IGNORED entirely (verified: identical results with and without one). - `'seeded'` — the pricer consumes randomness, but ONLY through the caller's `request.seed`: the seed is REQUIRED (its absence is a typed `input.missing_field` refusal naming `request.seed`), it is echoed at `assumptions.seed`, and two same-seed calls return byte-identical COMPLETE results. Batches obey the derivation law documented on {@link PricerValuationRequest.seed}: item `i` prices under `seed + i`. There is deliberately NO free-running mode: a pricer whose results the kit cannot reproduce under a fixed seed makes claims the kit cannot verify, and a claim the kit cannot verify is marketing. Free-running randomness is non-conformant. - pricer.name: string; default: not declared - pricer.version: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - targetDescriptorHash: string; default: not declared - taylor: { readonly baseValuePerUnit: number; readonly factors: TaylorFactors; readonly sensitivities: Readonly; }; default: not declared - taylor.baseValuePerUnit: number; default: not declared - taylor.factors: TaylorFactors; default: not declared - taylor.factors.dividend?: TaylorFactorLevel; default: not declared - taylor.factors.dividend.level: number; default: not declared - taylor.factors.dividend.subject: string; default: not declared - taylor.factors.riskFreeRate?: TaylorFactorLevel; default: not declared - taylor.factors.riskFreeRate.level: number; default: not declared - taylor.factors.riskFreeRate.subject: string; default: not declared - taylor.factors.spot?: TaylorFactorLevel; default: not declared - taylor.factors.spot.level: number; default: not declared - taylor.factors.spot.subject: string; default: not declared - taylor.factors.valuationInstant?: TaylorValuationInstantLevel; default: not declared - taylor.factors.valuationInstant.level: number; default: not declared - taylor.factors.volatility?: TaylorFactorLevel; default: not declared - taylor.factors.volatility.level: number; default: not declared - taylor.factors.volatility.subject: string; default: not declared - taylor.sensitivities: Readonly; default: not declared - taylor.sensitivities.charm?: number; default: not declared - taylor.sensitivities.delta?: number; default: not declared - taylor.sensitivities.deltaRate?: number; default: not declared - taylor.sensitivities.gamma?: number; default: not declared - taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - taylor.sensitivities.rho?: number; default: not declared - taylor.sensitivities.rhoConvexity?: number; default: not declared - taylor.sensitivities.theta?: number; default: not declared - taylor.sensitivities.thetaConvexity?: number; default: not declared - taylor.sensitivities.thetaRate?: number; default: not declared - taylor.sensitivities.vanna?: number; default: not declared - taylor.sensitivities.vega?: number; default: not declared - taylor.sensitivities.vera?: number; default: not declared - taylor.sensitivities.veta?: number; default: not declared - taylor.sensitivities.vomma?: number; default: not declared - taylorDescriptorHash: string; default: not declared - underlying?: string; default: not declared - valuationMethod: ('full-revaluation') | ('taylor'); default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioTargetDescriptorBase Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable fields common to every target-axis row. ```typescript /** Serializable fields common to every target-axis row. */ export interface ScenarioTargetDescriptorBase { readonly id: string; readonly quantity: number; readonly contractMultiplier: number; readonly currency: string; readonly underlying?: string; readonly strategy?: string; readonly account?: string; readonly book?: string; readonly tags: readonly string[]; readonly targetDescriptorHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - id: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - targetDescriptorHash: string; default: not declared - underlying?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioTargetsFromPortfolioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert one detached durable portfolio state into runner targets. ```typescript /** Convert one detached durable portfolio state into runner targets. */ export interface ScenarioTargetsFromPortfolioInput { state: PortfolioState; bindings: readonly ScenarioPortfolioBinding[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bindings: readonly ScenarioPortfolioBinding[]; default: not declared - state: PortfolioState; default: not declared - state.accountMigrations: import('@insiderfinance/totalfinance/portfolio').AccountMigrationMarker[]; default: not declared — Account-migration markers in fold order. - state.accounts: Record; default: not declared - state.appliedEvents: Record; default: not declared — `(sourceId, eventId)` → event content hash — the duplicate/conflict boundary. - state.baseCurrency: string; default: not declared - state.eventCount: number; default: not declared - state.fillEffects: Record; default: not declared — Registry key of every applied `trade.fill` → what it did (slice 3; exact reversal needs it). - state.lastEffectiveTimestampMs: number | null; default: not declared - state.lotRelief: import('@insiderfinance/totalfinance/portfolio').LotReliefPolicy; default: not declared — The lot-relief policy every realized figure in this state was computed under. - state.lotSequence: number; default: not declared — Fold-deterministic lot-id counter (`lot-`). - state.portfolioId?: string; default: not declared - state.reversals: Record; default: not declared — Registry key of every reversed fact → registry key of the admin event that reversed it. - state.schemaVersion: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioTaylorValue Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Successful Taylor scenario cell payload. ```typescript /** Successful Taylor scenario cell payload. */ export type ScenarioTaylorValue = ScenarioSuccessfulValueFields & { readonly valuationMethod: 'taylor'; readonly taylorResult: Readonly; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - appliedInstructions: readonly ScenarioAppliedInstruction[]; default: not declared - contractMultiplier: number; default: not declared - currencyConversion: ScenarioCurrencyConversionUse | null; default: not declared - currencyConversion.orientation: 'direct' | 'inverted'; default: not declared - currencyConversion.quote: Readonly; default: not declared - currencyConversion.quote.baseCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency being priced (ONE unit of this). - currencyConversion.quote.quoteCurrency: string; default: not declared — Uppercase three-letter ISO-style code of the currency the price is expressed in. - currencyConversion.quote.quotePerBase: number; default: not declared — Units of quote currency per ONE base unit; must be finite and > 0. - currencyConversion.sourceQuoteIndex: number; default: not declared - effectiveSeed: number | null; default: not declared - factorHandlers: readonly ScenarioBehaviorIdentity[]; default: not declared - observationOrFactorSetHash: string; default: not declared - positionValue: number; default: not declared - quantity: number; default: not declared - reportingCurrency: string; default: not declared - reportingPositionValue: number; default: not declared - resolvers: readonly ScenarioBehaviorIdentity[]; default: not declared - targetId: string; default: not declared - targetIndex: number; default: not declared - taylorResult: Readonly; default: not declared - taylorResult.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - taylorResult.assumptions.conventionsVersion: string; default: not declared - taylorResult.charm: number; default: not declared — Second-order spot–time cross term: `charm·dS·dt` (0 when `charm` is absent). - taylorResult.delta: number; default: not declared - taylorResult.deltaRate: number; default: not declared — Second-order spot–rate cross term: `deltaRate·dS·dr` (0 when `deltaRate` is absent). - taylorResult.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - taylorResult.diagnostics.warnings: QuantWarning[]; default: not declared - taylorResult.gamma: number; default: not declared - taylorResult.other: number; default: not declared — Residual = repriced − value − (the Greek terms); 0 for a pure Taylor reprice. - taylorResult.phi: number; default: not declared — First-order dividend-carry term: `φ·dq` (0 when `phi` is absent). - taylorResult.rho: number; default: not declared - taylorResult.rhoConvexity: number; default: not declared — Second-order rate-convexity term: `½·rhoConvexity·dr²` (0 when `rhoConvexity` is absent). - taylorResult.theta: number; default: not declared - taylorResult.thetaConvexity: number; default: not declared — Second-order time-convexity term: `½·thetaConvexity·dt²` (0 when `thetaConvexity` is absent). - taylorResult.thetaRate: number; default: not declared — Second-order time–rate cross term: `thetaRate·dt·dr` (0 when `thetaRate` is absent). - taylorResult.total: number; default: not declared - taylorResult.vanna: number; default: not declared — Second-order spot–vol cross term: `vanna·dS·dσ` (0 when `vanna` is absent). - taylorResult.vega: number; default: not declared - taylorResult.vera: number; default: not declared — Second-order vol–rate cross term: `vera·dσ·dr` (0 when `vera` is absent). - taylorResult.veta: number; default: not declared — Second-order vol–time cross term: `veta·dσ·dt` (0 when `veta` is absent). - taylorResult.vomma: number; default: not declared — Second-order vol-convexity term: `½·vomma·dσ²` (0 when `vomma` is absent). - valuationCurrency: string; default: not declared - valuationMethod: 'taylor'; default: not declared - valuePerUnit: number; default: not declared ### @insiderfinance/totalfinance/scenarios#ScenarioValuationMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Valuation method used by one target. ```typescript /** Valuation method used by one target. */ export type ScenarioValuationMethod = 'full-revaluation' | 'taylor'; ``` ### @insiderfinance/totalfinance/scenarios#SpotAssetInstrument Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain instrument consumed by the first-party spot pricer. ```typescript /** Plain instrument consumed by the first-party spot pricer. */ export interface SpotAssetInstrument { readonly symbol: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - symbol: string; default: not declared ### @insiderfinance/totalfinance/scenarios#SpotScenarioTargetInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Builder input for the common one-unit spot-asset target. ```typescript /** Builder input for the common one-unit spot-asset target. */ export interface SpotScenarioTargetInput { id: string; symbol: string; quantity: number; currency: string; strategy?: string; account?: string; book?: string; tags?: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - currency: string; default: not declared - id: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - symbol: string; default: not declared - tags?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorFactorLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One named Taylor factor and the level at which the supplied sensitivities were measured. ```typescript /** One named Taylor factor and the level at which the supplied sensitivities were measured. */ export interface TaylorFactorLevel { readonly subject: string; readonly level: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - level: number; default: not declared - subject: string; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorFactors Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit base levels used by a Taylor approximation. ```typescript /** Explicit base levels used by a Taylor approximation. */ export interface TaylorFactors { readonly spot?: TaylorFactorLevel; readonly volatility?: TaylorFactorLevel; readonly riskFreeRate?: TaylorFactorLevel; readonly dividend?: TaylorFactorLevel; readonly valuationInstant?: TaylorValuationInstantLevel; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividend?: TaylorFactorLevel; default: not declared - dividend.level: number; default: not declared - dividend.subject: string; default: not declared - riskFreeRate?: TaylorFactorLevel; default: not declared - riskFreeRate.level: number; default: not declared - riskFreeRate.subject: string; default: not declared - spot?: TaylorFactorLevel; default: not declared - spot.level: number; default: not declared - spot.subject: string; default: not declared - valuationInstant?: TaylorValuationInstantLevel; default: not declared - valuationInstant.level: number; default: not declared - volatility?: TaylorFactorLevel; default: not declared - volatility.level: number; default: not declared - volatility.subject: string; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorScenarioPortfolioBindingDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable Taylor durable-portfolio binding descriptor. ```typescript /** Serializable Taylor durable-portfolio binding descriptor. */ export interface TaylorScenarioPortfolioBindingDescriptor extends ScenarioPortfolioBindingDescriptorBase { readonly valuationMethod: 'taylor'; readonly taylor: { readonly baseValuePerUnit: number; readonly sensitivities: Readonly; readonly factors: TaylorFactors; }; readonly taylorDescriptorHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - bindingDescriptorHash: string; default: not declared - book?: string; default: not declared - id: string; default: not declared - instrumentId: string; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - taylor: { readonly baseValuePerUnit: number; readonly sensitivities: Readonly; readonly factors: TaylorFactors; }; default: not declared - taylor.baseValuePerUnit: number; default: not declared - taylor.factors: TaylorFactors; default: not declared - taylor.factors.dividend?: TaylorFactorLevel; default: not declared - taylor.factors.dividend.level: number; default: not declared - taylor.factors.dividend.subject: string; default: not declared - taylor.factors.riskFreeRate?: TaylorFactorLevel; default: not declared - taylor.factors.riskFreeRate.level: number; default: not declared - taylor.factors.riskFreeRate.subject: string; default: not declared - taylor.factors.spot?: TaylorFactorLevel; default: not declared - taylor.factors.spot.level: number; default: not declared - taylor.factors.spot.subject: string; default: not declared - taylor.factors.valuationInstant?: TaylorValuationInstantLevel; default: not declared - taylor.factors.valuationInstant.level: number; default: not declared - taylor.factors.volatility?: TaylorFactorLevel; default: not declared - taylor.factors.volatility.level: number; default: not declared - taylor.factors.volatility.subject: string; default: not declared - taylor.sensitivities: Readonly; default: not declared - taylor.sensitivities.charm?: number; default: not declared - taylor.sensitivities.delta?: number; default: not declared - taylor.sensitivities.deltaRate?: number; default: not declared - taylor.sensitivities.gamma?: number; default: not declared - taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - taylor.sensitivities.rho?: number; default: not declared - taylor.sensitivities.rhoConvexity?: number; default: not declared - taylor.sensitivities.theta?: number; default: not declared - taylor.sensitivities.thetaConvexity?: number; default: not declared - taylor.sensitivities.thetaRate?: number; default: not declared - taylor.sensitivities.vanna?: number; default: not declared - taylor.sensitivities.vega?: number; default: not declared - taylor.sensitivities.vera?: number; default: not declared - taylor.sensitivities.veta?: number; default: not declared - taylor.sensitivities.vomma?: number; default: not declared - taylorDescriptorHash: string; default: not declared - valuationMethod: 'taylor'; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorScenarioPortfolioBindingInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Taylor durable-portfolio binding. ```typescript /** Taylor durable-portfolio binding. */ export interface TaylorScenarioPortfolioBindingInput extends ScenarioPortfolioBindingBaseInput { baseValuePerUnit: number; greeks: TaylorSensitivities; factors: TaylorFactors; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountId: string; default: not declared - baseValuePerUnit: number; default: not declared - book?: string; default: not declared - factors: TaylorFactors; default: not declared - factors.dividend?: TaylorFactorLevel; default: not declared - factors.dividend.level: number; default: not declared - factors.dividend.subject: string; default: not declared - factors.riskFreeRate?: TaylorFactorLevel; default: not declared - factors.riskFreeRate.level: number; default: not declared - factors.riskFreeRate.subject: string; default: not declared - factors.spot?: TaylorFactorLevel; default: not declared - factors.spot.level: number; default: not declared - factors.spot.subject: string; default: not declared - factors.valuationInstant?: TaylorValuationInstantLevel; default: not declared - factors.valuationInstant.level: number; default: not declared - factors.volatility?: TaylorFactorLevel; default: not declared - factors.volatility.level: number; default: not declared - factors.volatility.subject: string; default: not declared - greeks: TaylorSensitivities; default: not declared - greeks.charm?: number; default: not declared - greeks.delta?: number; default: not declared - greeks.deltaRate?: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - greeks.rho?: number; default: not declared - greeks.rhoConvexity?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.thetaConvexity?: number; default: not declared - greeks.thetaRate?: number; default: not declared - greeks.vanna?: number; default: not declared - greeks.vega?: number; default: not declared - greeks.vera?: number; default: not declared - greeks.veta?: number; default: not declared - greeks.vomma?: number; default: not declared - id: string; default: not declared - instrumentId: string; default: not declared - strategy?: string; default: not declared - tags?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorScenarioTargetDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serializable Taylor target descriptor. ```typescript /** Serializable Taylor target descriptor. */ export interface TaylorScenarioTargetDescriptor extends ScenarioTargetDescriptorBase { readonly valuationMethod: 'taylor'; readonly taylor: { readonly baseValuePerUnit: number; readonly sensitivities: Readonly; readonly factors: TaylorFactors; }; readonly taylorDescriptorHash: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - id: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags: readonly string[]; default: not declared - targetDescriptorHash: string; default: not declared - taylor: { readonly baseValuePerUnit: number; readonly sensitivities: Readonly; readonly factors: TaylorFactors; }; default: not declared - taylor.baseValuePerUnit: number; default: not declared - taylor.factors: TaylorFactors; default: not declared - taylor.factors.dividend?: TaylorFactorLevel; default: not declared - taylor.factors.dividend.level: number; default: not declared - taylor.factors.dividend.subject: string; default: not declared - taylor.factors.riskFreeRate?: TaylorFactorLevel; default: not declared - taylor.factors.riskFreeRate.level: number; default: not declared - taylor.factors.riskFreeRate.subject: string; default: not declared - taylor.factors.spot?: TaylorFactorLevel; default: not declared - taylor.factors.spot.level: number; default: not declared - taylor.factors.spot.subject: string; default: not declared - taylor.factors.valuationInstant?: TaylorValuationInstantLevel; default: not declared - taylor.factors.valuationInstant.level: number; default: not declared - taylor.factors.volatility?: TaylorFactorLevel; default: not declared - taylor.factors.volatility.level: number; default: not declared - taylor.factors.volatility.subject: string; default: not declared - taylor.sensitivities: Readonly; default: not declared - taylor.sensitivities.charm?: number; default: not declared - taylor.sensitivities.delta?: number; default: not declared - taylor.sensitivities.deltaRate?: number; default: not declared - taylor.sensitivities.gamma?: number; default: not declared - taylor.sensitivities.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - taylor.sensitivities.rho?: number; default: not declared - taylor.sensitivities.rhoConvexity?: number; default: not declared - taylor.sensitivities.theta?: number; default: not declared - taylor.sensitivities.thetaConvexity?: number; default: not declared - taylor.sensitivities.thetaRate?: number; default: not declared - taylor.sensitivities.vanna?: number; default: not declared - taylor.sensitivities.vega?: number; default: not declared - taylor.sensitivities.vera?: number; default: not declared - taylor.sensitivities.veta?: number; default: not declared - taylor.sensitivities.vomma?: number; default: not declared - taylorDescriptorHash: string; default: not declared - underlying?: string; default: not declared - valuationMethod: 'taylor'; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorScenarioTargetInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Builder input for an explicit Greeks-Taylor approximation. ```typescript /** Builder input for an explicit Greeks-Taylor approximation. */ export interface TaylorScenarioTargetInput extends ScenarioTargetBaseInput { baseValuePerUnit: number; greeks: TaylorSensitivities; factors: TaylorFactors; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - account?: string; default: not declared - baseValuePerUnit: number; default: not declared - book?: string; default: not declared - contractMultiplier: number; default: not declared - currency: string; default: not declared - factors: TaylorFactors; default: not declared - factors.dividend?: TaylorFactorLevel; default: not declared - factors.dividend.level: number; default: not declared - factors.dividend.subject: string; default: not declared - factors.riskFreeRate?: TaylorFactorLevel; default: not declared - factors.riskFreeRate.level: number; default: not declared - factors.riskFreeRate.subject: string; default: not declared - factors.spot?: TaylorFactorLevel; default: not declared - factors.spot.level: number; default: not declared - factors.spot.subject: string; default: not declared - factors.valuationInstant?: TaylorValuationInstantLevel; default: not declared - factors.valuationInstant.level: number; default: not declared - factors.volatility?: TaylorFactorLevel; default: not declared - factors.volatility.level: number; default: not declared - factors.volatility.subject: string; default: not declared - greeks: TaylorSensitivities; default: not declared - greeks.charm?: number; default: not declared - greeks.delta?: number; default: not declared - greeks.deltaRate?: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - greeks.rho?: number; default: not declared - greeks.rhoConvexity?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.thetaConvexity?: number; default: not declared - greeks.thetaRate?: number; default: not declared - greeks.vanna?: number; default: not declared - greeks.vega?: number; default: not declared - greeks.vera?: number; default: not declared - greeks.veta?: number; default: not declared - greeks.vomma?: number; default: not declared - id: string; default: not declared - quantity: number; default: not declared - strategy?: string; default: not declared - tags?: readonly string[]; default: not declared - underlying?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorSensitivities Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Greeks for a Taylor target in TotalFinance's ONE unit system — the units `@insiderfinance/totalfinance/options` reports (theta per calendar day, vega per volatility point, rho and phi per 1%, second-order terms in the options package's conventions). See `@insiderfinance/totalfinance/risk`'s `PositionGreeks`; the Taylor engine converts internally. ```typescript /** Raw per-unit derivatives in the exact units consumed by `taylorPnl`. */ /** * Greeks for a Taylor target in TotalFinance's ONE unit system — the units `@insiderfinance/totalfinance/options` reports * (theta per calendar day, vega per volatility point, rho and phi per 1%, second-order terms in the * options package's conventions). See `@insiderfinance/totalfinance/risk`'s `PositionGreeks`; the Taylor engine converts * internally. */ export interface TaylorSensitivities { delta?: number; gamma?: number; vega?: number; theta?: number; rho?: number; vanna?: number; vomma?: number; charm?: number; veta?: number; vera?: number; deltaRate?: number; thetaRate?: number; rhoConvexity?: number; thetaConvexity?: number; /** φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). */ phi?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm?: number; default: not declared - delta?: number; default: not declared - deltaRate?: number; default: not declared - gamma?: number; default: not declared - phi?: number; default: not declared — φ = ∂V/∂q per 1% dividend yield (the options package's `phi`). - rho?: number; default: not declared - rhoConvexity?: number; default: not declared - theta?: number; default: not declared - thetaConvexity?: number; default: not declared - thetaRate?: number; default: not declared - vanna?: number; default: not declared - vega?: number; default: not declared - vera?: number; default: not declared - veta?: number; default: not declared - vomma?: number; default: not declared ### @insiderfinance/totalfinance/scenarios#TaylorValuationInstantLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Base valuation instant for time sensitivities. ```typescript /** Base valuation instant for time sensitivities. */ export interface TaylorValuationInstantLevel { readonly level: EpochMs; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - level: number; default: not declared ### @insiderfinance/totalfinance/scenarios#runScenarios Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run one validated ScenarioSet over heterogeneous builder-owned targets and one market snapshot. ```typescript export declare function runScenarios(rawInput: RunScenariosInput): ScenarioRunResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (rawInput): RunScenariosInput; default: not declared - (rawInput).currencyConversions?: readonly import('@insiderfinance/totalfinance/foreign-exchange').CurrencyPairQuote[]; default: not declared - (rawInput).market: MarketSnapshot; default: not declared - (rawInput).options?: import('@insiderfinance/totalfinance/scenarios').RunScenariosOptions; default: not declared - (rawInput).reportingCurrency?: string; default: not declared - (rawInput).scenarioSet: ScenarioSet; default: not declared - (rawInput).targets: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioTarget[]; default: not declared - return.aggregates: { readonly base: import('@insiderfinance/totalfinance/scenarios').ScenarioBaseAggregateSet; readonly scenarios: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioOutcomeAggregateSet[]; }; default: not declared - return.aggregates.base: import('@insiderfinance/totalfinance/scenarios').ScenarioBaseAggregateSet; default: not declared - return.aggregates.scenarios: readonly import('@insiderfinance/totalfinance/scenarios').ScenarioOutcomeAggregateSet[]; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/scenarios').ScenarioRunAssumptions; default: not declared - return.base: readonly ScenarioBaseCell[]; default: not declared - return.cells: readonly ScenarioCell[]; default: not declared - return.diagnostics: import('@insiderfinance/totalfinance/scenarios').ScenarioRunDiagnostics; default: not declared - return.layout: import('@insiderfinance/totalfinance/scenarios').ScenarioResultLayout; default: not declared - return.scenarioAxis: readonly ScenarioAxisRow[]; default: not declared - return.targetAxis: readonly ScenarioTargetAxisRow[]; default: not declared ### @insiderfinance/totalfinance/scenarios#scenarioPortfolioBinding Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opaque builder namespace for durable portfolio-to-scenario bindings. ```typescript export declare const scenarioPortfolioBinding: ScenarioPortfolioBindingBuilders; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fullRevaluation: (input: FullRevaluationScenarioPortfolioBindingInput) => ScenarioPortfolioBinding; default: not declared - fullRevaluation(input): FullRevaluationScenarioPortfolioBindingInput; default: not declared - fullRevaluation(input).accountId: string; default: not declared - fullRevaluation(input).book?: string; default: not declared - fullRevaluation(input).id: string; default: not declared - fullRevaluation(input).instrument: TInstrument; default: not declared - fullRevaluation(input).instrumentDescriptor?: unknown; default: not declared - fullRevaluation(input).instrumentId: string; default: not declared - fullRevaluation(input).pricer: Pricer, PricerValuationResult>; default: not declared - fullRevaluation(input).strategy?: string; default: not declared - fullRevaluation(input).tags?: readonly string[]; default: not declared - taylor: (input: TaylorScenarioPortfolioBindingInput) => ScenarioPortfolioBinding; default: not declared - taylor(input): TaylorScenarioPortfolioBindingInput; default: not declared - taylor(input).accountId: string; default: not declared - taylor(input).baseValuePerUnit: number; default: not declared - taylor(input).book?: string; default: not declared - taylor(input).factors: import('@insiderfinance/totalfinance/scenarios').TaylorFactors; default: not declared - taylor(input).greeks: import('@insiderfinance/totalfinance/scenarios').TaylorSensitivities; default: not declared - taylor(input).id: string; default: not declared - taylor(input).instrumentId: string; default: not declared - taylor(input).strategy?: string; default: not declared - taylor(input).tags?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/scenarios#scenarioTarget Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Builder namespace for opaque, immutable scenario targets. ```typescript export declare const scenarioTarget: ScenarioTargetBuilders; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fullRevaluation: (input: FullRevaluationScenarioTargetInput) => ScenarioTarget; default: not declared - fullRevaluation(input): FullRevaluationScenarioTargetInput; default: not declared - fullRevaluation(input).account?: string; default: not declared - fullRevaluation(input).book?: string; default: not declared - fullRevaluation(input).contractMultiplier: number; default: not declared - fullRevaluation(input).currency: string; default: not declared - fullRevaluation(input).id: string; default: not declared - fullRevaluation(input).instrument: TInstrument; default: not declared - fullRevaluation(input).instrumentDescriptor?: unknown; default: not declared - fullRevaluation(input).pricer: Pricer, PricerValuationResult>; default: not declared - fullRevaluation(input).quantity: number; default: not declared - fullRevaluation(input).strategy?: string; default: not declared - fullRevaluation(input).tags?: readonly string[]; default: not declared - fullRevaluation(input).underlying?: string; default: not declared - spot: (input: SpotScenarioTargetInput) => ScenarioTarget; default: not declared - spot(input): SpotScenarioTargetInput; default: not declared - spot(input).account?: string; default: not declared - spot(input).book?: string; default: not declared - spot(input).currency: string; default: not declared - spot(input).id: string; default: not declared - spot(input).quantity: number; default: not declared - spot(input).strategy?: string; default: not declared - spot(input).symbol: string; default: not declared - spot(input).tags?: readonly string[]; default: not declared - taylor: (input: TaylorScenarioTargetInput) => ScenarioTarget; default: not declared - taylor(input): TaylorScenarioTargetInput; default: not declared - taylor(input).account?: string; default: not declared - taylor(input).baseValuePerUnit: number; default: not declared - taylor(input).book?: string; default: not declared - taylor(input).contractMultiplier: number; default: not declared - taylor(input).currency: string; default: not declared - taylor(input).factors: TaylorFactors; default: not declared - taylor(input).greeks: TaylorSensitivities; default: not declared - taylor(input).id: string; default: not declared - taylor(input).quantity: number; default: not declared - taylor(input).strategy?: string; default: not declared - taylor(input).tags?: readonly string[]; default: not declared - taylor(input).underlying?: string; default: not declared ### @insiderfinance/totalfinance/scenarios#scenarioTargetsFromPortfolio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert every open position in one validated durable portfolio snapshot into exactly one opaque scenario target. Ledger facts remain authoritative; bindings contribute only identity, valuation behavior, and optional strategy/book/tag metadata. ```typescript export declare function scenarioTargetsFromPortfolio(rawInput: ScenarioTargetsFromPortfolioInput): readonly ScenarioTarget[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (rawInput): ScenarioTargetsFromPortfolioInput; default: not declared - (rawInput).bindings: readonly ScenarioPortfolioBinding[]; default: not declared - (rawInput).state: PortfolioState; default: not declared ### @insiderfinance/totalfinance/scenarios#spotAssetPricer Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). First-party Gate-C adapter for a directly observed spot asset. Its per-unit value is exactly the matching spot observation; quantity and any contract multiplier remain target-owned. ```typescript export declare function spotAssetPricer(): Pricer; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.capabilities: import('@insiderfinance/totalfinance/core/pricing').PricerCapabilities; default: not declared — Verified by {@link validatePricer}; never self-certified marketing. - return.name: string; default: not declared — Stable identity, reported in diagnostics and selection reports. - return.price: (input: PricerPriceInput) => SpotAssetPricingResult; default: not declared - return.priceBatch?: (input: import('@insiderfinance/totalfinance/core/pricing').PricerBatchPriceInput) => readonly SpotAssetPricingResult[]; default: not declared — Present iff `capabilities.batch`; must agree with `price` result-for-result. - return.requirements: (instrument: SpotAssetInstrument) => readonly MarketRequirement[]; default: not declared — The typed market requirements pricing THIS instrument consumes — required ones missing at `price` time must throw `pricer.requirement_unsatisfied`; observations outside this list must not influence the result (both are conformance-probed). - return.supports: (instrument: SpotAssetInstrument) => boolean; default: not declared — Whether this pricer can price the instrument. Runners gate on this before `requirements`. - return.version: string; default: not declared ## Entrypoint @insiderfinance/totalfinance/scenarios/portfolio ### @insiderfinance/totalfinance/scenarios/portfolio#FullRevaluationScenarioPortfolioBindingDescriptor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#FullRevaluationScenarioPortfolioBindingDescriptor`. ### @insiderfinance/totalfinance/scenarios/portfolio#FullRevaluationScenarioPortfolioBindingInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#FullRevaluationScenarioPortfolioBindingInput`. ### @insiderfinance/totalfinance/scenarios/portfolio#ScenarioPortfolioBinding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#ScenarioPortfolioBinding`. ### @insiderfinance/totalfinance/scenarios/portfolio#ScenarioPortfolioBindingBaseInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingBaseInput`. ### @insiderfinance/totalfinance/scenarios/portfolio#ScenarioPortfolioBindingBuilders Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingBuilders`. ### @insiderfinance/totalfinance/scenarios/portfolio#ScenarioPortfolioBindingDescriptor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingDescriptor`. ### @insiderfinance/totalfinance/scenarios/portfolio#ScenarioPortfolioBindingDescriptorBase Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#ScenarioPortfolioBindingDescriptorBase`. ### @insiderfinance/totalfinance/scenarios/portfolio#ScenarioTargetsFromPortfolioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#ScenarioTargetsFromPortfolioInput`. ### @insiderfinance/totalfinance/scenarios/portfolio#TaylorScenarioPortfolioBindingDescriptor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#TaylorScenarioPortfolioBindingDescriptor`. ### @insiderfinance/totalfinance/scenarios/portfolio#TaylorScenarioPortfolioBindingInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#TaylorScenarioPortfolioBindingInput`. ### @insiderfinance/totalfinance/scenarios/portfolio#scenarioPortfolioBinding Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#scenarioPortfolioBinding`. ### @insiderfinance/totalfinance/scenarios/portfolio#scenarioTargetsFromPortfolio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/scenarios#scenarioTargetsFromPortfolio`. ## Entrypoint @insiderfinance/totalfinance/strategy ### @insiderfinance/totalfinance/strategy#BuildStrategyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a named strategy chosen at runtime: `buildStrategy({ name: 'ironCondor', input })` is exactly `ironCondor(input)` with the name as data — for agents, UIs, and config-driven callers. Unknown names throw a typed `input.invalid_enum` error carrying the full catalog (with a did-you-mean hint when only the casing is off); `listStrategies()` documents every input shape. ```typescript /** * Build a named strategy chosen at runtime: `buildStrategy({ name: 'ironCondor', input })` is exactly * `ironCondor(input)` with the name as data — for agents, UIs, and config-driven callers. * Unknown names throw a typed `input.invalid_enum` error carrying the full catalog (with a * did-you-mean hint when only the casing is off); `listStrategies()` documents every input shape. */ export interface BuildStrategyInput { /** The exact strategy name returned by {@link listStrategies}. */ name: string; /** Builder-specific strategy fields; inspect the matching descriptor's `exampleInput`. */ input: Record; /** Optional position construction and model-premium configuration. */ config?: PositionConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config?: PositionConfig; default: not declared — Optional position construction and model-premium configuration. - config.expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - config.market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - config.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - config.market.dividendYield?: number; default: not declared - config.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - config.market.riskFreeRate: number; default: not declared - config.market.spot: number; default: not declared - config.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - config.multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - config.premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - input: Record; default: not declared — Builder-specific strategy fields; inspect the matching descriptor's `exampleInput`. - name: string; default: not declared — The exact strategy name returned by {@link listStrategies}. ### @insiderfinance/totalfinance/strategy#CalendarInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A calendar (horizontal) spread: same strike, short near leg + long far leg. Multi-expiry by construction, so there is deliberately NO single `expiry` field — the per-side `nearExpiry`/`farExpiry` are the only spelling (a bare `expiry` throws a teaching error). ```typescript /** * A calendar (horizontal) spread: same strike, short near leg + long far leg. Multi-expiry by * construction, so there is deliberately NO single `expiry` field — the per-side * `nearExpiry`/`farExpiry` are the only spelling (a bare `expiry` throws a teaching error). */ export interface CalendarInput extends Omit { strike: number; /** Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). */ nearExpiry: string; /** Premium received on the short near leg. */ shortPremium?: number; /** Far expiry of the long leg. */ farExpiry: string; /** Premium paid on the long far leg. */ longPremium?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - farExpiry: string; default: not declared — Far expiry of the long leg. - longPremium?: number; default: not declared — Premium paid on the long far leg. - nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPremium?: number; default: not declared — Premium received on the short near leg. - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#ChainFill Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One resolved fill: the traded contract (null for a stock leg), its premium, and its delta. ```typescript /** One resolved fill: the traded contract (null for a stock leg), its premium, and its delta. */ export interface ChainFill { role: string; contract: OptionContract | null; premium: number; delta: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract | null; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - delta: number | null; default: not declared - premium: number; default: not declared - role: string; default: not declared ### @insiderfinance/totalfinance/strategy#ChartInclude Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChartInclude { expirationPnl?: boolean; currentPnl?: boolean; delta?: boolean; theta?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - currentPnl?: boolean; default: not declared - delta?: boolean; default: not declared - expirationPnl?: boolean; default: not declared - theta?: boolean; default: not declared ### @insiderfinance/totalfinance/strategy#ClassifiableLeg Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The members `strategySignature` reads; a stock row carries no strike (`undefined`), an option row must. ```typescript /** The classifiable subset of a leg: kind, strike, signed quantity, optional expiry. */ /** The members `strategySignature` reads; a stock row carries no strike (`undefined`), an option row must. */ export type ClassifiableLeg = { kind: LegKind; quantity: number; strike?: number | undefined; expiry?: string | undefined; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string | undefined; default: not declared - kind: LegKind; default: not declared - quantity: number; default: not declared - strike?: number | undefined; default: not declared ### @insiderfinance/totalfinance/strategy#CollarInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Collar: long 100·q shares + long q protective puts + short q covered calls. ```typescript /** Collar: long 100·q shares + long q protective puts + short q covered calls. */ export interface CollarInput extends StockOptionInput { put: Role; call: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Role; default: not declared - call.premium?: number; default: not declared - call.strike: number; default: not declared - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - put: Role; default: not declared - put.premium?: number; default: not declared - put.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - stockPrice: number; default: not declared — Entry price per share of the stock leg. ### @insiderfinance/totalfinance/strategy#CondorInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Four ascending same-type strikes `k1 < k2 < k3 < k4`. ```typescript // ───────────────────────── condors (4 strikes, one type) ───────────────────────── /** Four ascending same-type strikes `k1 < k2 < k3 < k4`. */ export interface CondorInput extends UnitInput { k1: Role; k2: Role; k3: Role; k4: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - k1: Role; default: not declared - k1.premium?: number; default: not declared - k1.strike: number; default: not declared - k2: Role; default: not declared - k2.premium?: number; default: not declared - k2.strike: number; default: not declared - k3: Role; default: not declared - k3.premium?: number; default: not declared - k3.strike: number; default: not declared - k4: Role; default: not declared - k4.premium?: number; default: not declared - k4.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. ### @insiderfinance/totalfinance/strategy#DiagonalInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A diagonal spread: short near leg and long far leg at different strikes. No single `expiry` field exists (see {@link CalendarInput}); either strike ordering is valid. ```typescript /** * A diagonal spread: short near leg and long far leg at different strikes. No single `expiry` * field exists (see {@link CalendarInput}); either strike ordering is valid. */ export interface DiagonalInput extends Omit { shortStrike: number; shortPremium?: number; nearExpiry: string; longStrike: number; longPremium?: number; farExpiry: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - farExpiry: string; default: not declared - longPremium?: number; default: not declared - longStrike: number; default: not declared - nearExpiry: string; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPremium?: number; default: not declared - shortStrike: number; default: not declared ### @insiderfinance/totalfinance/strategy#DirectionalBias Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type DirectionalBias = 'bullish' | 'bearish' | 'neutral'; ``` ### @insiderfinance/totalfinance/strategy#DoubleDiagonalInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Double diagonal: a short near-dated strangle financing a long far-dated strangle. No single `expiry` field exists (see {@link CalendarInput}). ```typescript /** * Double diagonal: a short near-dated strangle financing a long far-dated strangle. No single * `expiry` field exists (see {@link CalendarInput}). */ export interface DoubleDiagonalInput extends Omit { nearExpiry: string; farExpiry: string; call: DoubleDiagonalSide; put: DoubleDiagonalSide; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: DoubleDiagonalSide; default: not declared - call.longPremium?: number; default: not declared - call.longStrike: number; default: not declared - call.shortPremium?: number; default: not declared - call.shortStrike: number; default: not declared - farExpiry: string; default: not declared - nearExpiry: string; default: not declared - put: DoubleDiagonalSide; default: not declared - put.longPremium?: number; default: not declared - put.longStrike: number; default: not declared - put.shortPremium?: number; default: not declared - put.shortStrike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. ### @insiderfinance/totalfinance/strategy#DoubleDiagonalSide Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One diagonal side (call or put): short near strike + long far strike. ```typescript /** One diagonal side (call or put): short near strike + long far strike. */ export interface DoubleDiagonalSide { shortStrike: number; shortPremium?: number; longStrike: number; longPremium?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - longPremium?: number; default: not declared - longStrike: number; default: not declared - shortPremium?: number; default: not declared - shortStrike: number; default: not declared ### @insiderfinance/totalfinance/strategy#ExplainPositionOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link explainPosition}. ```typescript /** Options for {@link explainPosition}. */ export interface ExplainPositionOptions { /** Market for probability + greeks (spot/vol/rate/asOf); merges over the position's own market. */ market?: Partial; /** Underlying name for the prose (e.g. `'AAPL'`); default `'the underlying'`. */ underlyingLabel?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - market?: Partial; default: not declared — Market for probability + greeks (spot/vol/rate/asOf); merges over the position's own market. - market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - market.dividendYield?: number; default: not declared - market.expiry?: string; default: not declared - market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - market.riskFreeRate?: number; default: not declared - market.spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - underlyingLabel?: string; default: not declared — Underlying name for the prose (e.g. `'AAPL'`); default `'the underlying'`. ### @insiderfinance/totalfinance/strategy#FromChainOptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FromChainOptions = (CommonOptions & { type: 'ironCondor'; shortDelta: number; wingWidth: number; }) | (CommonOptions & { type: 'bullCallSpread' | 'bearCallSpread' | 'bullPutSpread' | 'bearPutSpread'; shortDelta: number; width: number; }) | (CommonOptions & { type: 'straddle'; strike?: number; }) | (CommonOptions & { type: 'strangle'; shortDelta: number; }) | (CommonOptions & { type: 'coveredCall'; shortDelta: number; stockPrice?: number; }) | (CommonOptions & { type: 'protectivePut'; shortDelta: number; stockPrice?: number; }) | (CommonOptions & { type: 'calendar'; farExpiry: string; strike?: number; right?: 'call' | 'put'; }); ``` ### @insiderfinance/totalfinance/strategy#FromChainResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FromChainResult { position: Position; legs: Leg[]; fills: ChainFill[]; /** C (hygiene): the conventions the selection applied — above all which quoted price became each premium. */ assumptions: { conventionsVersion: string; /** The price source every premium was read from (`'mid'` by default; never a silent fallback). */ priceSource: PriceSource; /** The selection expiry (the NEAR expiry for a calendar). */ expiry: string; multiplier: number; quantity: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; expiry: string; multiplier: number; priceSource: PriceSource; quantity: number; }; default: not declared — C (hygiene): the conventions the selection applied — above all which quoted price became each premium. - assumptions.conventionsVersion: string; default: not declared - assumptions.expiry: string; default: not declared — The selection expiry (the NEAR expiry for a calendar). - assumptions.multiplier: number; default: not declared - assumptions.priceSource: PriceSource; default: not declared — The price source every premium was read from (`'mid'` by default; never a silent fallback). - assumptions.quantity: number; default: not declared - fills: ChainFill[]; default: not declared - legs: Leg[]; default: not declared - position: Position; default: not declared - position.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - position.assumptions().return.constructedAs?: string; default: not declared — The named builder that constructed this position (provenance — see `classifyStrategy`). - position.assumptions().return.multiplier: number; default: not declared — Contract multiplier applied to option legs. - position.assumptions().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — `'user'` when every entry premium was supplied; `'model'` when any was priced from `market`. - position.assumptions().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When premiums were modeled, which volatility priced them: each leg's own `impliedVolatility` (`'leg'`), the position-level `market.volatility` (`'position'`), or both across legs (`'mixed'`) — the same source `value()` marks with, so a chain-fed position opens flat. - position.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - position.chartData(options)?: { include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }; default: not declared - position.chartData(options).include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; default: not declared - position.chartData(options).market?: Partial>; default: not declared - position.chartData(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.chartData(options).market.dividendYield?: number; default: not declared - position.chartData(options).market.expiry?: string; default: not declared - position.chartData(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.chartData(options).market.riskFreeRate?: number; default: not declared - position.chartData(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.chartData(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.chartData(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared - position.chartData(options).prices.from: number; default: not declared - position.chartData(options).prices.steps: number; default: not declared - position.chartData(options).prices.to: number; default: not declared - position.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - position.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - position.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - position.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - position.market.dividendYield?: number; default: not declared - position.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - position.market.riskFreeRate: number; default: not declared - position.market.spot: number; default: not declared - position.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - position.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - position.metrics().return.bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - position.metrics().return.bounded.loss: boolean; default: not declared - position.metrics().return.bounded.profit: boolean; default: not declared - position.metrics().return.breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - position.metrics().return.maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - position.metrics().return.maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - position.metrics().return.netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - position.metrics().return.netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - position.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - position.monteCarloProbability().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; probabilityModel: import('@insiderfinance/totalfinance/strategy').ProbabilityModel; }>; default: not declared — Applied conventions, plus where the market fields came from — construction market, call site, or a merge (R5) — as `assumptions.marketSource` (R2: never hoisted to the top level). - position.monteCarloProbability().return.expectedValue: number; default: not declared — Monte-Carlo expected expiration P&L. - position.monteCarloProbability().return.expectedValueStandardError: number; default: not declared — Standard error of the expected-value estimate. - position.monteCarloProbability().return.paths: number; default: not declared — Number of paths simulated. - position.monteCarloProbability().return.pnlQuantiles?: { quantile: number; pnl: number; }[]; default: not declared — Requested expiration-P&L quantiles (the profit cone), present only when `pnlQuantiles` was set. - position.monteCarloProbability().return.probabilityOfProfit: number; default: not declared — Monte-Carlo probability of a positive expiration P&L. - position.monteCarloProbability().return.probabilityOfTouch: import('@insiderfinance/totalfinance/strategy').TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry, estimated from simulated paths with the Brownian-bridge continuous-monitoring correction (discrete sampling alone would under-count). - position.monteCarloProbability().return.seed: number; default: not declared — The PRNG seed, echoed for reproducibility (stochastic-provenance rule, cf. `MonteCarloStatistics.seed`). - position.monteCarloProbability(overrides): Partial & { seed: number; }; default: not declared - position.monteCarloProbability(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.monteCarloProbability(overrides).dividendYield?: number; default: not declared - position.monteCarloProbability(overrides).expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - position.monteCarloProbability(overrides).expiry?: string; default: not declared - position.monteCarloProbability(overrides).localVolatility?: (level: number, timeToExpiryYears: number) => number; default: not declared — Optional Dupire local-volatility function `σ_loc(level, t)` (e.g. from `@insiderfinance/totalfinance/volatility`'s `surfaceLocalVolatility` or `@insiderfinance/totalfinance/options`'s `dupireLocalVolatility`). When provided, the simulation steps under local vol instead of a single lognormal σ, so probability-of-profit, expected P&L, and probability-of-touch all reflect the volatility smile/skew — the smile-aware multi-leg read. The function is evaluated at the price and time reached at each step. - position.monteCarloProbability(overrides).measure?: import('@insiderfinance/totalfinance/strategy').ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - position.monteCarloProbability(overrides).paths?: number; default: not declared — Number of simulated paths (default 50_000). - position.monteCarloProbability(overrides).pnlQuantiles?: number[]; default: not declared — Optional P&L quantiles to report (each in `(0, 1)`), forming an expiration profit "cone" from the simulated terminal distribution. E.g. `[0.05, 0.5, 0.95]` → 5th/50th/95th-percentile P&L. - position.monteCarloProbability(overrides).riskFreeRate?: number; default: not declared - position.monteCarloProbability(overrides).seed?: number; default: not declared — Seed for the deterministic PRNG (required — the simulation never reads the system clock). - position.monteCarloProbability(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - position.monteCarloProbability(overrides).steps?: number; default: not declared — Monitoring steps per path for the probability-of-touch estimate (default 50). - position.monteCarloProbability(overrides).volatility?: number; default: not declared — Annualized volatility of the constant-vol lognormal. Required unless {@link localVolatility} is supplied (a local-volatility path ignores it except as the model echo's representative vol). - position.multiplier: number; default: not declared - position.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - position.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - position.payoff().return.bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - position.payoff().return.bounded.loss: boolean; default: not declared - position.payoff().return.bounded.profit: boolean; default: not declared - position.payoff().return.breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - position.payoff().return.maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - position.payoff().return.maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - position.payoff().return.netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - position.payoff().return.netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - position.payoff().return.points: { underlyingPrice: number; pnl: number; }[]; default: not declared — Chart-ready points of expiration P&L vs. underlying price. - position.payoff(options)?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }; default: not declared - position.payoff(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared - position.payoff(options).prices.from: number; default: not declared - position.payoff(options).prices.steps: number; default: not declared - position.payoff(options).prices.to: number; default: not declared - position.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - position.pnlAtExpiry(underlyingPrice): number; default: not declared - position.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - position.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - position.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - position.probability().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; probabilityModel: import('@insiderfinance/totalfinance/strategy').ProbabilityModel; }>; default: not declared — Applied conventions, where the market fields came from (`assumptions.marketSource`, R5), and the probability model echo (`assumptions.probabilityModel`) — R2: never hoisted to the top level. - position.probability().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings — the undefined reward-to-risk reason rides here (empty otherwise). - position.probability().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - position.probability().return.expectedValue: number; default: not declared — Expected expiration P&L under the model (closed-form expected intrinsic − premium per leg). - position.probability().return.probabilityOfProfit: number; default: not declared — Probability that expiration P&L is positive (sum of profit-region probabilities). - position.probability().return.probabilityOfTouch: import('@insiderfinance/totalfinance/strategy').TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry. - position.probability().return.riskReward: number | null; default: not declared — Reward-to-risk ratio `|maxProfit / maxLoss|`, or `null` when it is undefined — an unbounded profit, an unbounded loss, or a zero maximum loss — with the reason in `diagnostics.warnings` (`strategy.risk_reward_undefined`). Never `Infinity` (B3). - position.probability(overrides)?: Partial; default: not declared - position.probability(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.probability(overrides).dividendYield?: number; default: not declared - position.probability(overrides).expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - position.probability(overrides).expiry?: string; default: not declared - position.probability(overrides).measure?: import('@insiderfinance/totalfinance/strategy').ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - position.probability(overrides).riskFreeRate?: number; default: not declared - position.probability(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - position.probability(overrides).volatility?: number; default: not declared — Annualized volatility of the terminal lognormal (e.g. the ATM implied vol). - position.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - position.scenarioTable().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; }>; default: not declared — Every applied convention, echoed back. - position.scenarioTable().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - position.scenarioTable().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - position.scenarioTable().return.value: import('@insiderfinance/totalfinance/strategy').ScenarioRow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - position.scenarioTable(options)?: { daysForward?: number[]; market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; }; default: not declared - position.scenarioTable(options).daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 1, 7]`. Default `[0]`. - position.scenarioTable(options).market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - position.scenarioTable(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.scenarioTable(options).market.dividendYield?: number; default: not declared - position.scenarioTable(options).market.expiry?: string; default: not declared - position.scenarioTable(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.scenarioTable(options).market.riskFreeRate?: number; default: not declared - position.scenarioTable(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.scenarioTable(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.scenarioTable(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - position.scenarioTable(options).prices.from: number; default: not declared - position.scenarioTable(options).prices.steps: number; default: not declared - position.scenarioTable(options).prices.to: number; default: not declared - position.scenarioTable(options).volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. - position.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - position.value().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ volatilitySource: import('@insiderfinance/totalfinance/strategy').VolatilitySource; marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; }>; default: not declared — Every applied convention, echoed back. - position.value().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - position.value().return.greeks: import('@insiderfinance/totalfinance/options').ExtendedGreeks; default: not declared — Book-aggregate extended greeks: additive fields summed over legs; `lambda` (Δ·S/V) recomputed at the book level (null when the book value underflows to 0). - position.value().return.perLeg: import('@insiderfinance/totalfinance/strategy').LegValuation[]; default: not declared - position.value().return.pnl: number; default: not declared — Current mark-to-market P&L (also `value`). - position.value().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - position.value().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - position.value(overrides)?: Partial; default: not declared - position.value(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.value(overrides).dividendYield?: number; default: not declared - position.value(overrides).expiry?: string; default: not declared - position.value(overrides).legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.value(overrides).riskFreeRate?: number; default: not declared - position.value(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - position.value(overrides).volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.value(overrides).volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - position.whatIfCube().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: import('@insiderfinance/totalfinance/strategy').MarketSource; }>; default: not declared — Every applied convention, echoed back. - position.whatIfCube().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - position.whatIfCube().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - position.whatIfCube().return.value: import('@insiderfinance/totalfinance/strategy').WhatIfCubeValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - position.whatIfCube(options)?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions; default: not declared - position.whatIfCube(options).daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 7, 30]`. Default `[0]`. - position.whatIfCube(options).market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - position.whatIfCube(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - position.whatIfCube(options).market.dividendYield?: number; default: not declared - position.whatIfCube(options).market.expiry?: string; default: not declared - position.whatIfCube(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - position.whatIfCube(options).market.riskFreeRate?: number; default: not declared - position.whatIfCube(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - position.whatIfCube(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - position.whatIfCube(options).objective?: 'max-pnl' | 'min-pnl'; default: not declared — Which extremum the optimal-exit surface picks per (spot, vol); default `'max-pnl'`. - position.whatIfCube(options).prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - position.whatIfCube(options).prices.from: number; default: not declared - position.whatIfCube(options).prices.steps: number; default: not declared - position.whatIfCube(options).prices.to: number; default: not declared - position.whatIfCube(options).probability?: import('@insiderfinance/totalfinance/strategy').WhatIfProbabilityOptions; default: not declared — Opt-in probability weighting (Wave 6 §3). When set, the result gains a `probability` block with the per-day spot mass, disclosed tails, and per-(vol, day) expected P&L. Requires strictly increasing unique prices and non-negative days. - position.whatIfCube(options).volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. ### @insiderfinance/totalfinance/strategy#FromChainType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The v1 structures the bridge can build. ```typescript /** An option-chain row: a quote optionally carrying its Black–Scholes delta. */ /** The v1 structures the bridge can build. */ export type FromChainType = 'ironCondor' | 'bullCallSpread' | 'bearCallSpread' | 'bullPutSpread' | 'bearPutSpread' | 'straddle' | 'strangle' | 'coveredCall' | 'protectivePut' | 'calendar'; ``` ### @insiderfinance/totalfinance/strategy#IronButterflyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Iron butterfly: short ATM call + short ATM put + long OTM wings (a short straddle + long strangle). ```typescript // ───────────────────────── iron butterfly / condor variants ───────────────────────── /** Iron butterfly: short ATM call + short ATM put + long OTM wings (a short straddle + long strangle). */ export interface IronButterflyInput extends UnitInput { /** * ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike * number is shorthand for `{ strike }` (R3). */ body: number | { strike: number; callPremium?: number; putPremium?: number; }; /** Long put wing below the body. */ putWing: Role; /** Long call wing above the body. */ callWing: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - body: number | { callPremium?: number; putPremium?: number; strike: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - body.callPremium?: number; default: not declared - body.putPremium?: number; default: not declared - body.strike: number; default: not declared - callWing: Role; default: not declared — Long call wing above the body. - callWing.premium?: number; default: not declared - callWing.strike: number; default: not declared - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putWing: Role; default: not declared — Long put wing below the body. - putWing.premium?: number; default: not declared - putWing.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. ### @insiderfinance/totalfinance/strategy#IronCondorInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Four ascending roles: long put wing < short put < short call < long call wing. ```typescript /** Four ascending roles: long put wing < short put < short call < long call wing. */ export interface IronCondorInput { putLong: Role; putShort: Role; callShort: Role; callLong: Role; quantity?: number; expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callLong: Role; default: not declared - callLong.premium?: number; default: not declared - callLong.strike: number; default: not declared - callShort: Role; default: not declared - callShort.premium?: number; default: not declared - callShort.strike: number; default: not declared - expiry?: string; default: not declared - putLong: Role; default: not declared - putLong.premium?: number; default: not declared - putLong.strike: number; default: not declared - putShort: Role; default: not declared - putShort.premium?: number; default: not declared - putShort.strike: number; default: not declared - quantity?: number; default: not declared ### @insiderfinance/totalfinance/strategy#JadeLizardInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Jade lizard: short put + short call + long higher call (a short put with a short call spread). ```typescript // ───────────────────────── jade lizard / reverse ───────────────────────── /** Jade lizard: short put + short call + long higher call (a short put with a short call spread). */ export interface JadeLizardInput extends UnitInput { put: Role; shortCall: Role; longCall: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCall: Role; default: not declared - longCall.premium?: number; default: not declared - longCall.strike: number; default: not declared - put: Role; default: not declared - put.premium?: number; default: not declared - put.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCall: Role; default: not declared - shortCall.premium?: number; default: not declared - shortCall.strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#LadderInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three ascending same-type strikes: `lower < middle < upper`. ```typescript // ───────────────────────── ladders (3 strikes, one type) ───────────────────────── /** Three ascending same-type strikes: `lower < middle < upper`. */ export interface LadderInput extends UnitInput { lower: Role; middle: Role; upper: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - lower: Role; default: not declared - lower.premium?: number; default: not declared - lower.strike: number; default: not declared - middle: Role; default: not declared - middle.premium?: number; default: not declared - middle.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - upper: Role; default: not declared - upper.premium?: number; default: not declared - upper.strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#Leg Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A single position leg: a stock row or an option row, discriminated by `kind`. ```typescript /** A single position leg: a stock row or an option row, discriminated by `kind`. */ export type Leg = StockLeg | OptionLeg; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: (string) | (undefined); default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - impliedVolatility?: (number) | (undefined); default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - kind: ('call' | 'put') | ('stock'); default: not declared - premium?: (number) | (undefined); default: not declared — Entry premium per share. - price?: (number) | (undefined); default: not declared — Entry price per share. Never on an option row (a stock row's entry price). - quantity: number; default: not declared — Signed shares: positive = long, negative = short. Signed contracts: positive = long, negative = short. - strike?: (number) | (undefined); default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). ### @insiderfinance/totalfinance/strategy#LegInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A leg before entry-price resolution: an option's `premium` (or a stock's `price`) is optional and filled by the model — the Black–Scholes–Merton premium, the market spot — when omitted under `{ premiums: 'model', market }`. ```typescript /** * A leg before entry-price resolution: an option's `premium` (or a stock's `price`) is optional * and filled by the model — the Black–Scholes–Merton premium, the market spot — when omitted * under `{ premiums: 'model', market }`. */ export type LegInput = (Omit & { price?: number; }) | (Omit & { premium?: number; }); ``` ### @insiderfinance/totalfinance/strategy#LegKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type LegKind = 'call' | 'put' | 'stock'; ``` ### @insiderfinance/totalfinance/strategy#LegValuation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LegValuation { leg: Leg; value: number; pnl: number; /** Full extended greeks (first + second-order) — the second-order fields power higher-order P&L * attribution (`explainPositionPnl`) automatically. A stock leg is pure delta; an expired leg zeroed. */ greeks: ExtendedGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - greeks: ExtendedGreeks; default: not declared — Full extended greeks (first + second-order) — the second-order fields power higher-order P&L attribution (`explainPositionPnl`) automatically. A stock leg is pure delta; an expired leg zeroed. - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - leg: Leg; default: not declared - leg.expiry?: (string) | (undefined); default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - leg.impliedVolatility?: (number) | (undefined); default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - leg.kind: ('call' | 'put') | ('stock'); default: not declared - leg.premium?: (number) | (undefined); default: not declared — Entry premium per share. - leg.price?: (number) | (undefined); default: not declared — Entry price per share. Never on an option row (a stock row's entry price). - leg.quantity: number; default: not declared — Signed shares: positive = long, negative = short. Signed contracts: positive = long, negative = short. - leg.strike?: (number) | (undefined); default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). - pnl: number; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/strategy#MarkToMarketInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarkToMarketInput { /** Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). */ spot: number; /** Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. */ asOf: EpochMs | string; expiry: string; /** * Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own * `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) * only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. */ volatility?: number; riskFreeRate: number; dividendYield?: number; /** * Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg * `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This * is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only * `volatility` is a silent no-op for legs that fix their own implied volatility. */ volatilityShock?: number; /** * Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` * prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at * the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from * CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the * position stays immutable, the call states the market. `assumptions.volatilitySource` reports * `'perCall'` when any override applied. */ legVolatilities?: readonly (number | undefined)[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - dividendYield?: number; default: not declared - expiry: string; default: not declared - legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - riskFreeRate: number; default: not declared - spot: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. ### @insiderfinance/totalfinance/strategy#MarkToMarketResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MarkToMarketResult extends Computed { /** Current mark-to-market P&L (also `value`). */ pnl: number; perLeg: LegValuation[]; /** Book-aggregate extended greeks: additive fields summed over legs; `lambda` (Δ·S/V) recomputed at * the book level (null when the book value underflows to 0). */ greeks: ExtendedGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ volatilitySource: VolatilitySource; marketSource: MarketSource; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.marketSource: MarketSource; default: not declared - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.volatilitySource: VolatilitySource; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - greeks: ExtendedGreeks; default: not declared — Book-aggregate extended greeks: additive fields summed over legs; `lambda` (Δ·S/V) recomputed at the book level (null when the book value underflows to 0). - greeks.charm: number; default: not declared - greeks.color: number; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.lambda: number | null; default: not declared — Elasticity / effective leverage `Λ = Δ·S / V` (dimensionless). `null` when the price underflows to zero (deep-OTM): elasticity is undefined at V = 0 and is disclosed as null with a `greeks.lambda_undefined` warning on explained paths — never NaN/Infinity (Law 7). - greeks.phi: number; default: not declared — Dividend rho (epsilon) `ε = ∂V/∂q`, per 1% dividend yield (scaled like `rho`). - greeks.rho: number; default: not declared - greeks.speed: number; default: not declared - greeks.theta: number; default: not declared - greeks.ultima: number; default: not declared — `∂vomma/∂σ = ∂³V/∂σ³` (raw). - greeks.vanna: number; default: not declared - greeks.vega: number; default: not declared - greeks.vera: number; default: not declared — `∂rho/∂σ = ∂²V/∂r∂σ` (raw, per 1.00 σ; rho here is per 1.00 rate). - greeks.veta: number; default: not declared — `∂vega/∂T` (raw, per year of time-to-expiry; vega here is per 1.00 σ) — the ∂/∂T sibling of vega. - greeks.vomma: number; default: not declared - greeks.zomma: number; default: not declared — `∂Γ/∂σ = ∂³V/∂S²∂σ` (raw, per 1.00 σ). - perLeg: LegValuation[]; default: not declared - pnl: number; default: not declared — Current mark-to-market P&L (also `value`). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/strategy#MarketSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Where the market fields a computation ran with came from (R5): entirely from the construction market (`'construction'`), entirely from the call site (`'call'`), or a merge of both (`'merged'`). Echoed on every market-consuming result so it can answer "what did you assume?". ```typescript /** * Where the market fields a computation ran with came from (R5): entirely from the construction * market (`'construction'`), entirely from the call site (`'call'`), or a merge of both * (`'merged'`). Echoed on every market-consuming result so it can answer "what did you assume?". */ export type MarketSource = 'construction' | 'call' | 'merged'; ``` ### @insiderfinance/totalfinance/strategy#MoveBias Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type MoveBias = 'wants-movement' | 'wants-stability' | 'neutral'; ``` ### @insiderfinance/totalfinance/strategy#OptimalExitPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A point of the optimal-exit surface: per (spot, vol shock), the day that optimizes P&L. ```typescript /** A point of the optimal-exit surface: per (spot, vol shock), the day that optimizes P&L. */ export interface OptimalExitPoint { underlyingPrice: number; volatilityShock: number; /** The `daysForward` (from the time axis) that optimizes P&L at this (spot, vol). */ daysForward: number; /** The optimized P&L there. */ pnl: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysForward: number; default: not declared — The `daysForward` (from the time axis) that optimizes P&L at this (spot, vol). - pnl: number; default: not declared — The optimized P&L there. - underlyingPrice: number; default: not declared - volatilityShock: number; default: not declared ### @insiderfinance/totalfinance/strategy#OptimizeStrategyOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link optimizeStrategy}. ```typescript /** Options for {@link optimizeStrategy}. */ export interface OptimizeStrategyOptions { spot: number; /** * Valuation instant — epoch milliseconds or a zoned ISO datetime, the ONE valuation-instant * grammar shared with `scanStrategies`, `Position.probability()` and the what-if cube. A bare * date is refused everywhere a position is priced: the time of day is the answer for a 0DTE. */ asOf: EpochMs | string; riskFreeRate: number; dividendYield?: number; /** The multi-expiry search space (≥ 1 expiry). */ expiries: OptimizerExpiry[]; thesis: OptimizerThesis; /** Default pricing volatility for missing premiums + the scanner's market-implied metrics. */ volatility?: number; /** Default pricing smile (takes precedence over `volatility` for pricing). */ smile?: (strike: number) => number; /** Which structures to enumerate (default: all the scanner's). */ structures?: ScanStructure[]; maxWidth?: number; /** Keep only candidates whose MARKET-implied PoP ≥ this. */ minProbabilityOfProfit?: number; /** Keep only candidates whose max loss ≤ this (per contract, 100×). */ maxRisk?: number; /** Keep only candidates whose THESIS PoP ≥ this. */ minThesisProbabilityOfProfit?: number; /** Ranking objective (default `'thesisExpectedValuePerRisk'`). */ objective?: OptimizerObjective; /** Top-N across all expiries (default 25). */ top?: number; /** Integration resolution for the thesis metrics (default 801). */ gridPoints?: number; /** Opt-in Kelly sizing. When set, each candidate gains a `kelly` verdict; omit for no Kelly work. */ sizing?: OptimizerSizingOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Valuation instant — epoch milliseconds or a zoned ISO datetime, the ONE valuation-instant grammar shared with `scanStrategies`, `Position.probability()` and the what-if cube. A bare date is refused everywhere a position is priced: the time of day is the answer for a 0DTE. - dividendYield?: number; default: not declared - expiries: OptimizerExpiry[]; default: not declared — The multi-expiry search space (≥ 1 expiry). - gridPoints?: number; default: not declared — Integration resolution for the thesis metrics (default 801). - maxRisk?: number; default: not declared — Keep only candidates whose max loss ≤ this (per contract, 100×). - maxWidth?: number; default: not declared - minProbabilityOfProfit?: number; default: not declared — Keep only candidates whose MARKET-implied PoP ≥ this. - minThesisProbabilityOfProfit?: number; default: not declared — Keep only candidates whose THESIS PoP ≥ this. - objective?: OptimizerObjective; default: not declared — Ranking objective (default `'thesisExpectedValuePerRisk'`). - riskFreeRate: number; default: not declared - sizing?: OptimizerSizingOptions; default: not declared — Opt-in Kelly sizing. When set, each candidate gains a `kelly` verdict; omit for no Kelly work. - sizing.drawdownLimit?: { maxProbability: number; toFraction: number; }; default: not declared — Cap the applied Kelly multiple so `P(ever falling to toFraction of starting bankroll) ≤ maxProbability`. - sizing.drawdownLimit.maxProbability: number; default: not declared - sizing.drawdownLimit.toFraction: number; default: not declared - sizing.enabled: true; default: not declared - sizing.fraction?: number; default: not declared — Fraction of full Kelly to apply (0.5 = half-Kelly). Default 0.5. Must be > 0. - sizing.horizonPeriods?: number; default: not declared — Optional horizonPeriods (periods) for the growth projection. Must be > 0 when given. - sizing.maxFraction?: number; default: not declared — Hard cap on the recommended fraction of bankroll (e.g. 1 = no leverage). Must be > 0. - smile?: (strike: number) => number; default: not declared — Default pricing smile (takes precedence over `volatility` for pricing). - smile(strike): number; default: not declared - spot: number; default: not declared - structures?: ScanStructure[]; default: not declared — Which structures to enumerate (default: all the scanner's). - thesis: OptimizerThesis; default: not declared - thesis.drift?: number; default: not declared — Annualized drift used when `targetPrice` is omitted (default 0 — a flat view). - thesis.pdf?: (price: number, timeToExpiryYears: number) => number; default: not declared — Escape hatch: an arbitrary terminal density `p(price, t)` (replaces the lognormal shape). - thesis.pdf(price): number; default: not declared - thesis.pdf(timeToExpiryYears): number; default: not declared - thesis.pdfRange?: { from: number; to: number; }; default: not declared — Required with `pdf`: the price range `{ from, to }` covering the density's support. The custom density is integrated over exactly this range (not the `volatility` window), so its mass is never silently truncated. Ignored for the lognormal thesis. - thesis.pdfRange.from: number; default: not declared - thesis.pdfRange.to: number; default: not declared - thesis.targetPrice?: number; default: not declared — Median terminal price (the central view). If omitted, the median is `spot·e^{drift·t}`. - thesis.volatility: number; default: not declared — Annualized volatility capturing the trader's UNCERTAINTY (σ_log at expiry = `volatility·√t`). Required, > 0. - top?: number; default: not declared — Top-N across all expiries (default 25). - volatility?: number; default: not declared — Default pricing volatility for missing premiums + the scanner's market-implied metrics. ### @insiderfinance/totalfinance/strategy#OptimizeStrategyResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The optimizer read-out. ```typescript /** The optimizer read-out. */ export interface OptimizeStrategyResult { /** Top-N candidates across all expiries, ranked by `objective` (descending). */ candidates: OptimizedStrategy[]; thesis: { median: 'target' | 'drift'; volatility: number; targetPrice?: number; drift?: number; }; assumptions: { conventionsVersion: string; objective: OptimizerObjective; expiries: number; gridPoints: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; expiries: number; gridPoints: number; objective: OptimizerObjective; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.expiries: number; default: not declared - assumptions.gridPoints: number; default: not declared - assumptions.objective: OptimizerObjective; default: not declared - candidates: OptimizedStrategy[]; default: not declared — Top-N candidates across all expiries, ranked by `objective` (descending). - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - thesis: { drift?: number; median: 'target' | 'drift'; targetPrice?: number; volatility: number; }; default: not declared - thesis.drift?: number; default: not declared - thesis.median: 'drift' | 'target'; default: not declared - thesis.targetPrice?: number; default: not declared - thesis.volatility: number; default: not declared ### @insiderfinance/totalfinance/strategy#OptimizedStrategy Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A scanned candidate re-scored under the trader's thesis. ```typescript /** A scanned candidate re-scored under the trader's thesis. */ export interface OptimizedStrategy extends ScanCandidate { expiry: string; /** Year fraction to this expiry. */ timeToExpiryYears: number; /** Expected P&L under the thesis (per contract, 100×). */ thesisExpectedValue: number; /** Probability of profit under the thesis. */ thesisProbabilityOfProfit: number; /** `thesisEv / |maxLoss|` (0 when risk is unbounded) — the defined-risk read; never falls back to margin. */ thesisExpectedValuePerRisk: number; /** The candidate's Reg-T buying-power requirement (the honest capital denominator). */ capital: OptimizedStrategyCapital; /** `thesisEv / capital.requirement`; `null` (never `Infinity`) when the requirement is zero. */ thesisExpectedValuePerCapital: number | null; /** Kelly sizing verdict — present only when `sizing` was requested (2B never populates it). */ kelly?: OptimizedStrategyKelly; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail of the expiration payoff is bounded (a `null` bound above is unbounded). - bounded.loss: boolean; default: not declared - bounded.profit: boolean; default: not declared - breakevens: number[]; default: not declared - capital: OptimizedStrategyCapital; default: not declared — The candidate's Reg-T buying-power requirement (the honest capital denominator). - capital.assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — The Reg-T / conventions assumptions echoed by `optionsMargin`. - capital.assumptions.conventionsVersion: string; default: not declared - capital.diagnostics: { warnings: QuantWarning[]; }; default: not declared — The `optionsMargin` diagnostics (e.g. the `risk.unbounded_loss` warning behind a `null` maxLoss). - capital.diagnostics.warnings: QuantWarning[]; default: not declared - capital.maxLoss: number | null; default: not declared — Worst-case expiration loss per contract; `null` when the loss is unbounded (Law 7). - capital.method: 'reg-t-naked' | 'defined-risk-max-loss' | 'reg-t-naked-put' | 'long-premium'; default: not declared — How the requirement was derived. - capital.requirement: number; default: not declared — Buying-power reduction the account must set aside (per contract, 100×). - expectedValue: number; default: not declared - expectedValuePerRisk: number; default: not declared — `expectedValue / |maxLoss|` — a risk-normalized EV; 0 when risk is unbounded. - expiry: string; default: not declared - kelly?: OptimizedStrategyKelly; default: not declared — Kelly sizing verdict — present only when `sizing` was requested (2B never populates it). - kelly.reason: 'unbounded-downside' | 'zero-capital'; default: not declared - kelly.sizing: KellySizing; default: not declared - kelly.sizing.appliedFraction: number | null; default: not declared — `κ = recommendedFraction / fullKelly` — the applied Kelly multiple (0 when there's no edge); `null` when `fullKelly` is null (undefined against a non-existent optimum). - kelly.sizing.assumptions: { conventionsVersion: string; drawdownModel: 'continuous-gbm'; edgeType: 'binary' | 'outcomes' | 'gaussian' | 'returns'; fraction: number; }; default: not declared - kelly.sizing.assumptions.conventionsVersion: string; default: not declared - kelly.sizing.assumptions.drawdownModel: 'continuous-gbm'; default: not declared - kelly.sizing.assumptions.edgeType: 'returns' | 'gaussian' | 'binary' | 'outcomes'; default: not declared - kelly.sizing.assumptions.fraction: number; default: not declared - kelly.sizing.bindingConstraint: 'fraction' | 'drawdown-limit' | 'max-fraction' | 'no-edge' | 'no-downside'; default: not declared — Which cap set the recommended fraction (`no-downside` = unbounded edge with no cap supplied). - kelly.sizing.diagnostics: Diagnostics; default: not declared - kelly.sizing.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - kelly.sizing.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - kelly.sizing.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - kelly.sizing.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - kelly.sizing.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - kelly.sizing.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - kelly.sizing.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - kelly.sizing.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - kelly.sizing.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - kelly.sizing.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - kelly.sizing.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - kelly.sizing.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - kelly.sizing.diagnostics.selection.selected.name: string; default: not declared - kelly.sizing.diagnostics.selection.selected.version?: string; default: not declared - kelly.sizing.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - kelly.sizing.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - kelly.sizing.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - kelly.sizing.drawdownRisk: { probability: number; toFraction: number; }; default: not declared — `P(wealth ever falls to toFraction of the starting bankroll)` at the recommended fraction (continuous model). - kelly.sizing.drawdownRisk.probability: number; default: not declared - kelly.sizing.drawdownRisk.toFraction: number; default: not declared - kelly.sizing.fullKelly: number | null; default: not declared — `f*` — the growth-optimal fraction of bankroll. `null` when the edge has **no downside**, so log-growth increases without bound and there is no finite unconstrained optimum (finite-success law — never `Infinity`; a `risk.kelly_unbounded` diagnostic explains it). - kelly.sizing.gaussianKelly?: number; default: not declared — Returns path only: the Gaussian `μ/σ²` estimate, for comparison with the exact empirical `f*`. - kelly.sizing.growthRate: number | null; default: not declared — Expected per-period log-growth at the recommended fraction; `null` when there is none. - kelly.sizing.growthRateFull: number | null; default: not declared — Expected per-period log-growth at full Kelly (the maximum); `null` for a no-downside edge. - kelly.sizing.horizonGrowth?: { growthMultiple: number; horizonPeriods: number; logGrowth: number; }; default: not declared — Present when `horizonPeriods` is given: the median wealth projection over the horizonPeriods. - kelly.sizing.horizonGrowth.growthMultiple: number; default: not declared - kelly.sizing.horizonGrowth.horizonPeriods: number; default: not declared - kelly.sizing.horizonGrowth.logGrowth: number; default: not declared - kelly.sizing.periodsToDouble: number | null; default: not declared — `ln 2 / growthRate` — periods to double at the recommended fraction (`Infinity` when growth ≤ 0, `null` when there is no finite recommendation). - kelly.sizing.rationale: string; default: not declared — Prose an agent relays. - kelly.sizing.recommendedFraction: number | null; default: not declared — The recommended fraction after the fractional/drawdown/max caps (≥ 0). `null` only for a no-downside edge with **no** explicit cap — a finite recommendation then requires a `maxFraction`. - kelly.status: ('not-admissible') | ('sized'); default: not declared - legs: Leg[]; default: not declared — The resolved legs (premiums included, whatever their source), so every candidate is MATERIALIZABLE (WS7.3): `strategy(candidate.legs)` reconstructs the exact position for charting or mark-to-market, and `strategy(candidate.legs).metrics()` reproduces the reported payoff metrics. - liquidity: number | null; default: not declared — Liquidity in `[0, 1]` from the legs' relative bid/ask spreads (1 = tight), null if unpriced. - maxLoss: number | null; default: not declared - maxProfit: number | null; default: not declared — Max profit / max loss / expected value are per contract (100× multiplier, as in `Position`). - netDebit: number; default: not declared — Net debit (> 0 paid) or credit (< 0 received), PER CONTRACT (multiplier-scaled, 100×) — the same units as `maxProfit`/`maxLoss`/`expectedValue` and `Position.netDebit()`. - probabilityOfProfit: number; default: not declared - returnOnRisk: number | null; default: not declared — `|maxProfit / maxLoss|` — the same definition as `Position.probability().riskReward` — or `null` when undefined (an unbounded side or a zero max loss). Never `Infinity` (B3). - score: number | null; default: not declared — The value of the ranking objective for this candidate; `null` when the objective is undefined for it. - strikes: number[]; default: not declared — The structure's strikes, ascending. - structure: ScanStructure; default: not declared - thesisExpectedValue: number; default: not declared — Expected P&L under the thesis (per contract, 100×). - thesisExpectedValuePerCapital: number | null; default: not declared — `thesisEv / capital.requirement`; `null` (never `Infinity`) when the requirement is zero. - thesisExpectedValuePerRisk: number; default: not declared — `thesisEv / |maxLoss|` (0 when risk is unbounded) — the defined-risk read; never falls back to margin. - thesisProbabilityOfProfit: number; default: not declared — Probability of profit under the thesis. - timeToExpiryYears: number; default: not declared — Year fraction to this expiry. ### @insiderfinance/totalfinance/strategy#OptimizedStrategyCapital Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The capital (buying-power) a candidate ties up, from Reg-T options margin — an economically honest denominator that is DISTINCT from `|maxLoss|`: a naked short has unbounded max loss yet a finite Reg-T requirement, so it can still be ranked by capital efficiency. This is a static entry buying-power model, not a liquidation or future house-margin model (echoed in `assumptions`). ```typescript /** * The capital (buying-power) a candidate ties up, from Reg-T options margin — an economically honest * denominator that is DISTINCT from `|maxLoss|`: a naked short has unbounded max loss yet a finite * Reg-T requirement, so it can still be ranked by capital efficiency. This is a static entry * buying-power model, not a liquidation or future house-margin model (echoed in `assumptions`). */ export interface OptimizedStrategyCapital { /** Buying-power reduction the account must set aside (per contract, 100×). */ requirement: number; /** How the requirement was derived. */ method: OptionsMarginResult['method']; /** Worst-case expiration loss per contract; `null` when the loss is unbounded (Law 7). */ maxLoss: number | null; /** The Reg-T / conventions assumptions echoed by `optionsMargin`. */ assumptions: OptionsMarginResult['assumptions']; /** The `optionsMargin` diagnostics (e.g. the `risk.unbounded_loss` warning behind a `null` maxLoss). */ diagnostics: OptionsMarginResult['diagnostics']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { [k: string]: unknown; conventionsVersion: string; }; default: not declared — The Reg-T / conventions assumptions echoed by `optionsMargin`. - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — The `optionsMargin` diagnostics (e.g. the `risk.unbounded_loss` warning behind a `null` maxLoss). - diagnostics.warnings: QuantWarning[]; default: not declared - maxLoss: number | null; default: not declared — Worst-case expiration loss per contract; `null` when the loss is unbounded (Law 7). - method: 'reg-t-naked' | 'defined-risk-max-loss' | 'reg-t-naked-put' | 'long-premium'; default: not declared — How the requirement was derived. - requirement: number; default: not declared — Buying-power reduction the account must set aside (per contract, 100×). ### @insiderfinance/totalfinance/strategy#OptimizedStrategyKelly Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Kelly verdict for a candidate (present only when `sizing` was requested): a full {@link KellySizing} on dimensionless (P&L ÷ capital) returns, or a structured `not-admissible` refusal — an unbounded downside under the thesis support (any positive bankroll fraction can cross zero wealth) or a zero capital requirement (the return is undefined). ```typescript /** * The Kelly verdict for a candidate (present only when `sizing` was requested): a full {@link KellySizing} * on dimensionless (P&L ÷ capital) returns, or a structured `not-admissible` refusal — an unbounded * downside under the thesis support (any positive bankroll fraction can cross zero wealth) or a zero * capital requirement (the return is undefined). */ export type OptimizedStrategyKelly = { status: 'sized'; sizing: KellySizing; } | { status: 'not-admissible'; reason: 'unbounded-downside' | 'zero-capital'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - reason: 'unbounded-downside' | 'zero-capital'; default: not declared - sizing: KellySizing; default: not declared - sizing.appliedFraction: number | null; default: not declared — `κ = recommendedFraction / fullKelly` — the applied Kelly multiple (0 when there's no edge); `null` when `fullKelly` is null (undefined against a non-existent optimum). - sizing.assumptions: { conventionsVersion: string; drawdownModel: 'continuous-gbm'; edgeType: 'binary' | 'outcomes' | 'gaussian' | 'returns'; fraction: number; }; default: not declared - sizing.assumptions.conventionsVersion: string; default: not declared - sizing.assumptions.drawdownModel: 'continuous-gbm'; default: not declared - sizing.assumptions.edgeType: 'returns' | 'gaussian' | 'binary' | 'outcomes'; default: not declared - sizing.assumptions.fraction: number; default: not declared - sizing.bindingConstraint: 'fraction' | 'drawdown-limit' | 'max-fraction' | 'no-edge' | 'no-downside'; default: not declared — Which cap set the recommended fraction (`no-downside` = unbounded edge with no cap supplied). - sizing.diagnostics: Diagnostics; default: not declared - sizing.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sizing.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sizing.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sizing.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sizing.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sizing.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sizing.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sizing.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sizing.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - sizing.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - sizing.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - sizing.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - sizing.diagnostics.selection.selected.name: string; default: not declared - sizing.diagnostics.selection.selected.version?: string; default: not declared - sizing.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sizing.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sizing.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sizing.drawdownRisk: { probability: number; toFraction: number; }; default: not declared — `P(wealth ever falls to toFraction of the starting bankroll)` at the recommended fraction (continuous model). - sizing.drawdownRisk.probability: number; default: not declared - sizing.drawdownRisk.toFraction: number; default: not declared - sizing.fullKelly: number | null; default: not declared — `f*` — the growth-optimal fraction of bankroll. `null` when the edge has **no downside**, so log-growth increases without bound and there is no finite unconstrained optimum (finite-success law — never `Infinity`; a `risk.kelly_unbounded` diagnostic explains it). - sizing.gaussianKelly?: number; default: not declared — Returns path only: the Gaussian `μ/σ²` estimate, for comparison with the exact empirical `f*`. - sizing.growthRate: number | null; default: not declared — Expected per-period log-growth at the recommended fraction; `null` when there is none. - sizing.growthRateFull: number | null; default: not declared — Expected per-period log-growth at full Kelly (the maximum); `null` for a no-downside edge. - sizing.horizonGrowth?: { growthMultiple: number; horizonPeriods: number; logGrowth: number; }; default: not declared — Present when `horizonPeriods` is given: the median wealth projection over the horizonPeriods. - sizing.horizonGrowth.growthMultiple: number; default: not declared - sizing.horizonGrowth.horizonPeriods: number; default: not declared - sizing.horizonGrowth.logGrowth: number; default: not declared - sizing.periodsToDouble: number | null; default: not declared — `ln 2 / growthRate` — periods to double at the recommended fraction (`Infinity` when growth ≤ 0, `null` when there is no finite recommendation). - sizing.rationale: string; default: not declared — Prose an agent relays. - sizing.recommendedFraction: number | null; default: not declared — The recommended fraction after the fractional/drawdown/max caps (≥ 0). `null` only for a no-downside edge with **no** explicit cap — a finite recommendation then requires a `maxFraction`. - status: ('not-admissible') | ('sized'); default: not declared ### @insiderfinance/totalfinance/strategy#OptimizerExpiry Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One expiry in the search space: its chain (+ optional pricing `volatility`/`smile`). ```typescript /** One expiry in the search space: its chain (+ optional pricing `volatility`/`smile`). */ export interface OptimizerExpiry { expiry: string; chain: ScanQuoteRow[]; /** Pricing volatility for this expiry (falls back to `options.volatility`). */ volatility?: number; /** Pricing smile for this expiry (falls back to `options.smile`). */ smile?: (strike: number) => number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - chain: ScanQuoteRow[]; default: not declared - expiry: string; default: not declared - smile?: (strike: number) => number; default: not declared — Pricing smile for this expiry (falls back to `options.smile`). - smile(strike): number; default: not declared - volatility?: number; default: not declared — Pricing volatility for this expiry (falls back to `options.volatility`). ### @insiderfinance/totalfinance/strategy#OptimizerObjective Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ranking objective: a thesis-based one, or the scanner's market-implied ones. ```typescript /** Ranking objective: a thesis-based one, or the scanner's market-implied ones. */ export type OptimizerObjective = 'thesisExpectedValuePerRisk' | 'thesisExpectedValuePerCapital' | 'thesisExpectedValue' | 'thesisProbabilityOfProfit' | ScanObjective; ``` ### @insiderfinance/totalfinance/strategy#OptimizerSizingOptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opt-in Kelly sizing for the optimizer: every {@link kellyBet} knob except `edge` (which the optimizer builds from each candidate's thesis outcomes), plus a required `enabled: true` so sizing is a deliberate request, never an accidental default. Omitting `sizing` performs no Kelly work at all. ```typescript /** * Opt-in Kelly sizing for the optimizer: every {@link kellyBet} knob except `edge` (which the optimizer * builds from each candidate's thesis outcomes), plus a required `enabled: true` so sizing is a * deliberate request, never an accidental default. Omitting `sizing` performs no Kelly work at all. */ export type OptimizerSizingOptions = Omit & { enabled: true; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drawdownLimit?: { maxProbability: number; toFraction: number; }; default: not declared — Cap the applied Kelly multiple so `P(ever falling to toFraction of starting bankroll) ≤ maxProbability`. - drawdownLimit.maxProbability: number; default: not declared - drawdownLimit.toFraction: number; default: not declared - enabled: true; default: not declared - fraction?: number; default: not declared — Fraction of full Kelly to apply (0.5 = half-Kelly). Default 0.5. Must be > 0. - horizonPeriods?: number; default: not declared — Optional horizonPeriods (periods) for the growth projection. Must be > 0 when given. - maxFraction?: number; default: not declared — Hard cap on the recommended fraction of bankroll (e.g. 1 = no leverage). Must be > 0. ### @insiderfinance/totalfinance/strategy#OptimizerThesis Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The trader's view of the terminal price — a lognormal centered at a target (or drift). ```typescript /** The trader's view of the terminal price — a lognormal centered at a target (or drift). */ export interface OptimizerThesis { /** Median terminal price (the central view). If omitted, the median is `spot·e^{drift·t}`. */ targetPrice?: number; /** Annualized volatility capturing the trader's UNCERTAINTY (σ_log at expiry = `volatility·√t`). Required, > 0. */ volatility: number; /** Annualized drift used when `targetPrice` is omitted (default 0 — a flat view). */ drift?: number; /** Escape hatch: an arbitrary terminal density `p(price, t)` (replaces the lognormal shape). */ pdf?: (price: number, timeToExpiryYears: number) => number; /** * Required with `pdf`: the price range `{ from, to }` covering the density's support. The custom * density is integrated over exactly this range (not the `volatility` window), so its mass is never * silently truncated. Ignored for the lognormal thesis. */ pdfRange?: { from: number; to: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drift?: number; default: not declared — Annualized drift used when `targetPrice` is omitted (default 0 — a flat view). - pdf?: (price: number, timeToExpiryYears: number) => number; default: not declared — Escape hatch: an arbitrary terminal density `p(price, t)` (replaces the lognormal shape). - pdf(price): number; default: not declared - pdf(timeToExpiryYears): number; default: not declared - pdfRange?: { from: number; to: number; }; default: not declared — Required with `pdf`: the price range `{ from, to }` covering the density's support. The custom density is integrated over exactly this range (not the `volatility` window), so its mass is never silently truncated. Ignored for the lognormal thesis. - pdfRange.from: number; default: not declared - pdfRange.to: number; default: not declared - targetPrice?: number; default: not declared — Median terminal price (the central view). If omitted, the median is `spot·e^{drift·t}`. - volatility: number; default: not declared — Annualized volatility capturing the trader's UNCERTAINTY (σ_log at expiry = `volatility·√t`). Required, > 0. ### @insiderfinance/totalfinance/strategy#OptionLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An option leg. `quantity` is signed contracts — positive = long, negative = short — scaled by the position multiplier; `premium` is the entry premium per share. ```typescript /** * An option leg. `quantity` is signed contracts — positive = long, negative = short — scaled by the * position multiplier; `premium` is the entry premium per share. */ export interface OptionLeg { kind: 'call' | 'put'; /** Never on an option row (a stock row's entry price). */ price?: undefined; strike: number; /** Entry premium per share. */ premium: number; /** Signed contracts: positive = long, negative = short. */ quantity: number; /** * Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses * the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, * diagonals, double diagonals) so each leg is priced at its own time-to-expiry. */ expiry?: string; /** * Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ * `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real * chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to * the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. */ impliedVolatility?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - impliedVolatility?: number; default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - kind: 'call' | 'put'; default: not declared - premium: number; default: not declared — Entry premium per share. - price?: undefined; default: not declared — Never on an option row (a stock row's entry price). - quantity: number; default: not declared — Signed contracts: positive = long, negative = short. - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#OptionLegInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionLegInput { /** Positive strike price per share. */ strike: number; /** Signed contracts: positive = long, negative = short. Required, finite and nonzero. */ quantity: number; /** * Entry premium per share. Omit it (or pass `undefined`) and supply `{ premiums: 'model', market }` * on the position config to have it priced from the market. Accepts `undefined` explicitly so * builders can forward an optional slot premium without a conditional spread. */ premium?: number | undefined; /** Per-leg expiry: a YYYY-MM-DD label (16:00 ET) or zoned ISO datetime. */ expiry?: string; /** Positive per-leg implied volatility, as an annualized decimal (0.20 = 20%). */ impliedVolatility?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Per-leg expiry: a YYYY-MM-DD label (16:00 ET) or zoned ISO datetime. - impliedVolatility?: number; default: not declared — Positive per-leg implied volatility, as an annualized decimal (0.20 = 20%). - premium?: number | undefined; default: not declared — Entry premium per share. Omit it (or pass `undefined`) and supply `{ premiums: 'model', market }` on the position config to have it priced from the market. Accepts `undefined` explicitly so builders can forward an optional slot premium without a conditional spread. - quantity: number; default: not declared — Signed contracts: positive = long, negative = short. Required, finite and nonzero. - strike: number; default: not declared — Positive strike price per share. ### @insiderfinance/totalfinance/strategy#OptionQuote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/core#OptionQuote`. ### @insiderfinance/totalfinance/strategy#PayoffMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PayoffMetrics { /** Net cash to enter: positive = debit paid, negative = credit received. */ netDebit: number; /** Net credit received (the negation of `netDebit`). */ netCredit: number; /** Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). */ maxProfit: number | null; /** Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). */ maxLoss: number | null; /** * Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a * naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. */ bounded: { profit: boolean; loss: boolean; }; /** Underlying prices at which expiration P&L is zero. */ breakevens: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - bounded.loss: boolean; default: not declared - bounded.profit: boolean; default: not declared - breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. ### @insiderfinance/totalfinance/strategy#PayoffResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PayoffResult extends PayoffMetrics { /** Chart-ready points of expiration P&L vs. underlying price. */ points: Array<{ underlyingPrice: number; pnl: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - bounded.loss: boolean; default: not declared - bounded.profit: boolean; default: not declared - breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - points: { underlyingPrice: number; pnl: number; }[]; default: not declared — Chart-ready points of expiration P&L vs. underlying price. ### @insiderfinance/totalfinance/strategy#PayoffSvgOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link payoffSvg}. ```typescript /** Options for {@link payoffSvg}. */ export interface PayoffSvgOptions { /** X-axis price range. Omit for an auto-range around the strikes + breakevens. */ prices?: PriceRange; /** Width in px (default 640). */ width?: number; /** Height in px (default 360). */ height?: number; /** Draw a marker at the current spot. */ spot?: number; /** Also draw the CURRENT (pre-expiry) P&L curve (dashed); needs a market (or the position's own). */ includeCurrentPnl?: boolean; market?: Partial>; /** Chart title (XML-escaped). */ title?: string; /** Color theme (default 'light'). */ theme?: 'light' | 'dark'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - height?: number; default: not declared — Height in px (default 360). - includeCurrentPnl?: boolean; default: not declared — Also draw the CURRENT (pre-expiry) P&L curve (dashed); needs a market (or the position's own). - market?: Partial>; default: not declared - market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - market.dividendYield?: number; default: not declared - market.expiry?: string; default: not declared - market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - market.riskFreeRate?: number; default: not declared - market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - prices?: PriceRange; default: not declared — X-axis price range. Omit for an auto-range around the strikes + breakevens. - prices.from: number; default: not declared - prices.steps: number; default: not declared - prices.to: number; default: not declared - spot?: number; default: not declared — Draw a marker at the current spot. - theme?: 'light' | 'dark'; default: not declared — Color theme (default 'light'). - title?: string; default: not declared — Chart title (XML-escaped). - width?: number; default: not declared — Width in px (default 640). ### @insiderfinance/totalfinance/strategy#Position Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class Position { constructor(legs: readonly LegInput[], config?: PositionConfig); assumptions(): PositionAssumptions; chartData(options?: { prices?: number[] | PriceRange; include?: ChartInclude; market?: Partial>; }): Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; readonly constructedAs?: string; readonly legs: readonly Readonly[]; readonly market?: Readonly; metrics(): PayoffMetrics; monteCarloProbability(overrides: Partial & { seed: number; }): ProbabilityMonteCarloMetrics; readonly multiplier: number; netDebit(): number; payoff(options?: { prices?: number[] | PriceRange; }): PayoffResult; pnlAtExpiry(underlyingPrice: number): number; readonly premiumSource: PremiumSource; readonly premiumVolatilitySource?: PremiumVolatilitySource; probability(overrides?: Partial): ProbabilityMetrics; scenarioTable(options?: { market?: Partial>; prices?: number[] | PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }): ScenarioTableResult; value(overrides?: Partial): MarkToMarketResult; whatIfCube(options?: WhatIfCubeOptions): WhatIfCubeResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (legs): readonly LegInput[]; default: not declared - assumptions: () => PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - assumptions().return.constructedAs?: string; default: not declared — The named builder that constructed this position (provenance — see `classifyStrategy`). - assumptions().return.multiplier: number; default: not declared — Contract multiplier applied to option legs. - assumptions().return.premiumSource: PremiumSource; default: not declared — `'user'` when every entry premium was supplied; `'model'` when any was priced from `market`. - assumptions().return.premiumVolatilitySource?: PremiumVolatilitySource; default: not declared — When premiums were modeled, which volatility priced them: each leg's own `impliedVolatility` (`'leg'`), the position-level `market.volatility` (`'position'`), or both across legs (`'mixed'`) — the same source `value()` marks with, so a chain-fed position opens flat. - chartData: (options?: { prices?: number[] | PriceRange; include?: ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - chartData(options)?: { include?: ChartInclude; market?: Partial>; prices?: number[] | PriceRange; }; default: not declared - chartData(options).include?: ChartInclude; default: not declared - chartData(options).market?: Partial>; default: not declared - chartData(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - chartData(options).market.dividendYield?: number; default: not declared - chartData(options).market.expiry?: string; default: not declared - chartData(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - chartData(options).market.riskFreeRate?: number; default: not declared - chartData(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - chartData(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - chartData(options).prices?: number[] | PriceRange; default: not declared - chartData(options).prices.from: number; default: not declared - chartData(options).prices.steps: number; default: not declared - chartData(options).prices.to: number; default: not declared - constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - market.dividendYield?: number; default: not declared - market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - metrics: () => PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - metrics().return.bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - metrics().return.bounded.loss: boolean; default: not declared - metrics().return.bounded.profit: boolean; default: not declared - metrics().return.breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - metrics().return.maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - metrics().return.maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - metrics().return.netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - metrics().return.netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - monteCarloProbability: (overrides: Partial & { seed: number; }) => ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - monteCarloProbability().return.assumptions: Assumptions<{ marketSource: MarketSource; probabilityModel: ProbabilityModel; }>; default: not declared — Applied conventions, plus where the market fields came from — construction market, call site, or a merge (R5) — as `assumptions.marketSource` (R2: never hoisted to the top level). - monteCarloProbability().return.expectedValue: number; default: not declared — Monte-Carlo expected expiration P&L. - monteCarloProbability().return.expectedValueStandardError: number; default: not declared — Standard error of the expected-value estimate. - monteCarloProbability().return.paths: number; default: not declared — Number of paths simulated. - monteCarloProbability().return.pnlQuantiles?: { quantile: number; pnl: number; }[]; default: not declared — Requested expiration-P&L quantiles (the profit cone), present only when `pnlQuantiles` was set. - monteCarloProbability().return.probabilityOfProfit: number; default: not declared — Monte-Carlo probability of a positive expiration P&L. - monteCarloProbability().return.probabilityOfTouch: TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry, estimated from simulated paths with the Brownian-bridge continuous-monitoring correction (discrete sampling alone would under-count). - monteCarloProbability().return.seed: number; default: not declared — The PRNG seed, echoed for reproducibility (stochastic-provenance rule, cf. `MonteCarloStatistics.seed`). - monteCarloProbability(overrides): Partial & { seed: number; }; default: not declared - monteCarloProbability(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - monteCarloProbability(overrides).dividendYield?: number; default: not declared - monteCarloProbability(overrides).expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - monteCarloProbability(overrides).expiry?: string; default: not declared - monteCarloProbability(overrides).localVolatility?: (level: number, timeToExpiryYears: number) => number; default: not declared — Optional Dupire local-volatility function `σ_loc(level, t)` (e.g. from `@insiderfinance/totalfinance/volatility`'s `surfaceLocalVolatility` or `@insiderfinance/totalfinance/options`'s `dupireLocalVolatility`). When provided, the simulation steps under local vol instead of a single lognormal σ, so probability-of-profit, expected P&L, and probability-of-touch all reflect the volatility smile/skew — the smile-aware multi-leg read. The function is evaluated at the price and time reached at each step. - monteCarloProbability(overrides).measure?: import('@insiderfinance/totalfinance/strategy').ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - monteCarloProbability(overrides).paths?: number; default: not declared — Number of simulated paths (default 50_000). - monteCarloProbability(overrides).pnlQuantiles?: number[]; default: not declared — Optional P&L quantiles to report (each in `(0, 1)`), forming an expiration profit "cone" from the simulated terminal distribution. E.g. `[0.05, 0.5, 0.95]` → 5th/50th/95th-percentile P&L. - monteCarloProbability(overrides).riskFreeRate?: number; default: not declared - monteCarloProbability(overrides).seed?: number; default: not declared — Seed for the deterministic PRNG (required — the simulation never reads the system clock). - monteCarloProbability(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - monteCarloProbability(overrides).steps?: number; default: not declared — Monitoring steps per path for the probability-of-touch estimate (default 50). - monteCarloProbability(overrides).volatility?: number; default: not declared — Annualized volatility of the constant-vol lognormal. Required unless {@link localVolatility} is supplied (a local-volatility path ignores it except as the model echo's representative vol). - multiplier: number; default: not declared - netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - payoff: (options?: { prices?: number[] | PriceRange; }) => PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - payoff().return.bounded: { loss: boolean; profit: boolean; }; default: not declared — Whether each tail is bounded. An unbounded side is `null` above, never `Infinity` (B3): a naked short call has `bounded.loss === false`, a long call `bounded.profit === false`. - payoff().return.bounded.loss: boolean; default: not declared - payoff().return.bounded.profit: boolean; default: not declared - payoff().return.breakevens: number[]; default: not declared — Underlying prices at which expiration P&L is zero. - payoff().return.maxLoss: number | null; default: not declared — Maximum loss at expiration as a negative number, or `null` when unbounded (`bounded.loss`). - payoff().return.maxProfit: number | null; default: not declared — Maximum profit at expiration, or `null` when the profit is unbounded (`bounded.profit`). - payoff().return.netCredit: number; default: not declared — Net credit received (the negation of `netDebit`). - payoff().return.netDebit: number; default: not declared — Net cash to enter: positive = debit paid, negative = credit received. - payoff().return.points: { underlyingPrice: number; pnl: number; }[]; default: not declared — Chart-ready points of expiration P&L vs. underlying price. - payoff(options)?: { prices?: number[] | PriceRange; }; default: not declared - payoff(options).prices?: number[] | PriceRange; default: not declared - payoff(options).prices.from: number; default: not declared - payoff(options).prices.steps: number; default: not declared - payoff(options).prices.to: number; default: not declared - pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - pnlAtExpiry(underlyingPrice): number; default: not declared - premiumSource: PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - premiumVolatilitySource?: PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - probability: (overrides?: Partial) => ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - probability().return.assumptions: Assumptions<{ marketSource: MarketSource; probabilityModel: ProbabilityModel; }>; default: not declared — Applied conventions, where the market fields came from (`assumptions.marketSource`, R5), and the probability model echo (`assumptions.probabilityModel`) — R2: never hoisted to the top level. - probability().return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings — the undefined reward-to-risk reason rides here (empty otherwise). - probability().return.diagnostics.warnings: QuantWarning[]; default: not declared - probability().return.expectedValue: number; default: not declared — Expected expiration P&L under the model (closed-form expected intrinsic − premium per leg). - probability().return.probabilityOfProfit: number; default: not declared — Probability that expiration P&L is positive (sum of profit-region probabilities). - probability().return.probabilityOfTouch: TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry. - probability().return.riskReward: number | null; default: not declared — Reward-to-risk ratio `|maxProfit / maxLoss|`, or `null` when it is undefined — an unbounded profit, an unbounded loss, or a zero maximum loss — with the reason in `diagnostics.warnings` (`strategy.risk_reward_undefined`). Never `Infinity` (B3). - probability(overrides)?: Partial; default: not declared - probability(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - probability(overrides).dividendYield?: number; default: not declared - probability(overrides).expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - probability(overrides).expiry?: string; default: not declared - probability(overrides).measure?: import('@insiderfinance/totalfinance/strategy').ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - probability(overrides).riskFreeRate?: number; default: not declared - probability(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - probability(overrides).volatility?: number; default: not declared — Annualized volatility of the terminal lognormal (e.g. the ATM implied vol). - return.assumptions: () => PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | PriceRange; include?: ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | PriceRange; }) => PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: WhatIfCubeOptions) => WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - scenarioTable: (options?: { market?: Partial>; prices?: number[] | PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - scenarioTable().return.assumptions: Assumptions<{ marketSource: MarketSource; }>; default: not declared — Every applied convention, echoed back. - scenarioTable().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - scenarioTable().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - scenarioTable().return.value: ScenarioRow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - scenarioTable(options)?: { daysForward?: number[]; market?: Partial>; prices?: number[] | PriceRange; volatilityShocks?: number[]; }; default: not declared - scenarioTable(options).daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 1, 7]`. Default `[0]`. - scenarioTable(options).market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - scenarioTable(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - scenarioTable(options).market.dividendYield?: number; default: not declared - scenarioTable(options).market.expiry?: string; default: not declared - scenarioTable(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - scenarioTable(options).market.riskFreeRate?: number; default: not declared - scenarioTable(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - scenarioTable(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - scenarioTable(options).prices?: number[] | PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - scenarioTable(options).prices.from: number; default: not declared - scenarioTable(options).prices.steps: number; default: not declared - scenarioTable(options).prices.to: number; default: not declared - scenarioTable(options).volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. - value: (overrides?: Partial) => MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - value().return.assumptions: Assumptions<{ volatilitySource: VolatilitySource; marketSource: MarketSource; }>; default: not declared — Every applied convention, echoed back. - value().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - value().return.greeks: ExtendedGreeks; default: not declared — Book-aggregate extended greeks: additive fields summed over legs; `lambda` (Δ·S/V) recomputed at the book level (null when the book value underflows to 0). - value().return.perLeg: import('@insiderfinance/totalfinance/strategy').LegValuation[]; default: not declared - value().return.pnl: number; default: not declared — Current mark-to-market P&L (also `value`). - value().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - value().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value(overrides)?: Partial; default: not declared - value(overrides).asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - value(overrides).dividendYield?: number; default: not declared - value(overrides).expiry?: string; default: not declared - value(overrides).legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - value(overrides).riskFreeRate?: number; default: not declared - value(overrides).spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - value(overrides).volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - value(overrides).volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - whatIfCube: (options?: WhatIfCubeOptions) => WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - whatIfCube().return.assumptions: Assumptions<{ marketSource: MarketSource; }>; default: not declared — Every applied convention, echoed back. - whatIfCube().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - whatIfCube().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - whatIfCube().return.value: import('@insiderfinance/totalfinance/strategy').WhatIfCubeValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - whatIfCube(options)?: WhatIfCubeOptions; default: not declared - whatIfCube(options).daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 7, 30]`. Default `[0]`. - whatIfCube(options).market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - whatIfCube(options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - whatIfCube(options).market.dividendYield?: number; default: not declared - whatIfCube(options).market.expiry?: string; default: not declared - whatIfCube(options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - whatIfCube(options).market.riskFreeRate?: number; default: not declared - whatIfCube(options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - whatIfCube(options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - whatIfCube(options).objective?: 'max-pnl' | 'min-pnl'; default: not declared — Which extremum the optimal-exit surface picks per (spot, vol); default `'max-pnl'`. - whatIfCube(options).prices?: number[] | PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - whatIfCube(options).prices.from: number; default: not declared - whatIfCube(options).prices.steps: number; default: not declared - whatIfCube(options).prices.to: number; default: not declared - whatIfCube(options).probability?: WhatIfProbabilityOptions; default: not declared — Opt-in probability weighting (Wave 6 §3). When set, the result gains a `probability` block with the per-day spot mass, disclosed tails, and per-(vol, day) expected P&L. Requires strictly increasing unique prices and non-negative days. - whatIfCube(options).volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. ### @insiderfinance/totalfinance/strategy#PositionAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Position-construction assumptions (design law #3): how entry premiums were sourced. ```typescript /** Position-construction assumptions (design law #3): how entry premiums were sourced. */ export interface PositionAssumptions { /** `'user'` when every entry premium was supplied; `'model'` when any was priced from `market`. */ premiumSource: PremiumSource; /** * When premiums were modeled, which volatility priced them: each leg's own `impliedVolatility` * (`'leg'`), the position-level `market.volatility` (`'position'`), or both across legs * (`'mixed'`) — the same source `value()` marks with, so a chain-fed position opens flat. */ premiumVolatilitySource?: PremiumVolatilitySource; /** Contract multiplier applied to option legs. */ multiplier: number; /** The named builder that constructed this position (provenance — see `classifyStrategy`). */ constructedAs?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - constructedAs?: string; default: not declared — The named builder that constructed this position (provenance — see `classifyStrategy`). - multiplier: number; default: not declared — Contract multiplier applied to option legs. - premiumSource: PremiumSource; default: not declared — `'user'` when every entry premium was supplied; `'model'` when any was priced from `market`. - premiumVolatilitySource?: PremiumVolatilitySource; default: not declared — When premiums were modeled, which volatility priced them: each leg's own `impliedVolatility` (`'leg'`), the position-level `market.volatility` (`'position'`), or both across legs (`'mixed'`) — the same source `value()` marks with, so a chain-fed position opens flat. ### @insiderfinance/totalfinance/strategy#PositionConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PositionConfig { /** Contract multiplier for option legs (default 100). */ multiplier?: number; /** Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). */ premiums?: PremiumSource; /** * Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its * premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, * `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call * fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. */ market?: PremiumMarket; /** * Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg * that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence * per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). */ expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - market?: PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - market.dividendYield?: number; default: not declared - market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - market.riskFreeRate: number; default: not declared - market.spot: number; default: not declared - market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - premiums?: PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). ### @insiderfinance/totalfinance/strategy#PositionExplanation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A structured, prose-ready explanation of a position. ```typescript /** A structured, prose-ready explanation of a position. */ export interface PositionExplanation { /** The classification, or `'custom'`. */ name: string; /** Other payoff-identical names. */ aliases: string[]; /** Readable leg list, sorted by strike. */ structure: string; directionalBias: DirectionalBias; moveBias: MoveBias; definedRisk: boolean; economics: { /** Net cash: `+` = debit paid, `−` = credit received (per contract). */ net: number; /** Maximum profit, or `null` when unbounded. */ maxProfit: number | null; /** Maximum loss (negative), or `null` when unbounded. */ maxLoss: number | null; breakevens: number[]; /** `|maxProfit / maxLoss|`, or `null` when undefined (an unbounded side or a zero max loss). */ rewardToRisk: number | null; }; /** Present when a market is available. */ volatilityBias?: VolatilityBias; timeBias?: TimeBias; probability?: { probabilityOfProfit: number; expectedValue: number; }; greeks?: { delta: number; gamma: number; theta: number; vega: number; rho: number; }; risks: string[]; /** The prose narrative composing all of the above. */ summary: string; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; /** How the name was derived — always the structural classifier (identity is never remembered). */ classifier: 'structural-base-signature'; /** Whether a usable market priced the greek/probability posture (false = payoff-only read). */ marketDependent: boolean; }; /** Structured warnings; always present (possibly empty) — a missing market explains itself here. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aliases: string[]; default: not declared — Other payoff-identical names. - assumptions: { classifier: 'structural-base-signature'; conventionsVersion: string; marketDependent: boolean; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.classifier: 'structural-base-signature'; default: not declared — How the name was derived — always the structural classifier (identity is never remembered). - assumptions.conventionsVersion: string; default: not declared - assumptions.marketDependent: boolean; default: not declared — Whether a usable market priced the greek/probability posture (false = payoff-only read). - definedRisk: boolean; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — a missing market explains itself here. - diagnostics.warnings: QuantWarning[]; default: not declared - directionalBias: DirectionalBias; default: not declared - economics: { breakevens: number[]; maxLoss: number | null; maxProfit: number | null; net: number; rewardToRisk: number | null; }; default: not declared - economics.breakevens: number[]; default: not declared - economics.maxLoss: number | null; default: not declared — Maximum loss (negative), or `null` when unbounded. - economics.maxProfit: number | null; default: not declared — Maximum profit, or `null` when unbounded. - economics.net: number; default: not declared — Net cash: `+` = debit paid, `−` = credit received (per contract). - economics.rewardToRisk: number | null; default: not declared — `|maxProfit / maxLoss|`, or `null` when undefined (an unbounded side or a zero max loss). - greeks?: { delta: number; gamma: number; rho: number; theta: number; vega: number; }; default: not declared - greeks.delta: number; default: not declared - greeks.gamma: number; default: not declared - greeks.rho: number; default: not declared - greeks.theta: number; default: not declared - greeks.vega: number; default: not declared - moveBias: MoveBias; default: not declared - name: string; default: not declared — The classification, or `'custom'`. - probability?: { expectedValue: number; probabilityOfProfit: number; }; default: not declared - probability.expectedValue: number; default: not declared - probability.probabilityOfProfit: number; default: not declared - risks: string[]; default: not declared - structure: string; default: not declared — Readable leg list, sorted by strike. - summary: string; default: not declared — The prose narrative composing all of the above. - timeBias?: TimeBias; default: not declared - volatilityBias?: VolatilityBias; default: not declared — Present when a market is available. ### @insiderfinance/totalfinance/strategy#PremiumMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market snapshot for MODEL-priced entry premiums (§3.4). Supplied via `PositionConfig.market` with `premiums: 'model'` so a builder given strikes but no fills (the profit-calculator user) still gets breakevens / max P&L / PoP — every unpriced leg is priced from this market by the BSM engine. ```typescript /** * Market snapshot for MODEL-priced entry premiums (§3.4). Supplied via `PositionConfig.market` with * `premiums: 'model'` so a builder given strikes but no fills (the profit-calculator user) still gets * breakevens / max P&L / PoP — every unpriced leg is priced from this market by the BSM engine. */ export interface PremiumMarket { spot: number; /** * Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` * of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. */ volatility: number; riskFreeRate: number; /** Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. */ asOf: EpochMs | string; dividendYield?: number; /** Default expiry for legs without their own `expiry` (single-expiry structures). */ expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - dividendYield?: number; default: not declared - expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - riskFreeRate: number; default: not declared - spot: number; default: not declared - volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. ### @insiderfinance/totalfinance/strategy#PremiumSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a position's entry premiums were obtained. ```typescript /** How a position's entry premiums were obtained. */ export type PremiumSource = 'user' | 'model'; ``` ### @insiderfinance/totalfinance/strategy#PremiumVolatilitySource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Which volatility priced a modeled entry premium (see `PositionAssumptions`). ```typescript /** Which volatility priced a modeled entry premium (see `PositionAssumptions`). */ export type PremiumVolatilitySource = 'leg' | 'position' | 'mixed'; ``` ### @insiderfinance/totalfinance/strategy#PriceRange Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PriceRange { from: number; to: number; steps: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: number; default: not declared - steps: number; default: not declared - to: number; default: not declared ### @insiderfinance/totalfinance/strategy#ProbabilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ProbabilityInput { /** Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). */ spot: number; /** Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. */ asOf: EpochMs | string; expiry: string; /** Annualized volatility of the terminal lognormal (e.g. the ATM implied vol). */ volatility: number; riskFreeRate: number; dividendYield?: number; /** Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). */ measure?: ProbabilityMeasure; /** * Annualized expected return, the drift of the `realWorld` measure. * * **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to * `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the * risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported * `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. * Choosing the real-world measure IS choosing a drift, so the drift must be stated. */ expectedReturn?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - dividendYield?: number; default: not declared - expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - expiry: string; default: not declared - measure?: ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - riskFreeRate: number; default: not declared - spot: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - volatility: number; default: not declared — Annualized volatility of the terminal lognormal (e.g. the ATM implied vol). ### @insiderfinance/totalfinance/strategy#ProbabilityMeasure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ProbabilityMeasure = 'riskNeutral' | 'realWorld'; ``` ### @insiderfinance/totalfinance/strategy#ProbabilityMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ProbabilityMetrics { /** Probability that expiration P&L is positive (sum of profit-region probabilities). */ probabilityOfProfit: number; /** Expected expiration P&L under the model (closed-form expected intrinsic − premium per leg). */ expectedValue: number; /** * Reward-to-risk ratio `|maxProfit / maxLoss|`, or `null` when it is undefined — an unbounded * profit, an unbounded loss, or a zero maximum loss — with the reason in `diagnostics.warnings` * (`strategy.risk_reward_undefined`). Never `Infinity` (B3). */ riskReward: number | null; /** Probability of touching each breakeven before expiry. */ probabilityOfTouch: TouchProbability[]; /** * Applied conventions, where the market fields came from (`assumptions.marketSource`, R5), and * the probability model echo (`assumptions.probabilityModel`) — R2: never hoisted to the top * level. */ assumptions: Assumptions<{ marketSource: MarketSource; probabilityModel: ProbabilityModel; }>; /** Structured warnings — the undefined reward-to-risk reason rides here (empty otherwise). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions<{ marketSource: MarketSource; probabilityModel: ProbabilityModel; }>; default: not declared — Applied conventions, where the market fields came from (`assumptions.marketSource`, R5), and the probability model echo (`assumptions.probabilityModel`) — R2: never hoisted to the top level. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.marketSource: MarketSource; default: not declared - assumptions.model?: string; default: not declared - assumptions.probabilityModel: ProbabilityModel; default: not declared - assumptions.probabilityModel.drift: number; default: not declared — Annualized drift used for the terminal lognormal. - assumptions.probabilityModel.measure: ProbabilityMeasure; default: not declared - assumptions.probabilityModel.timeToExpiryYears: number; default: not declared — Time to expiry in years. - assumptions.probabilityModel.volatility: number; default: not declared — Representative annualized volatility. For a lognormal model this is the constant vol; for a local-volatility model it is `σ_loc(spot, t)` at valuation (the path uses the full surface). - assumptions.probabilityModel.volatilityModel: 'lognormal' | 'localVolatility'; default: not declared — Diffusion used: `lognormal` (constant vol) or `localVolatility` (smile-consistent Dupire surface). - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings — the undefined reward-to-risk reason rides here (empty otherwise). - diagnostics.warnings: QuantWarning[]; default: not declared - expectedValue: number; default: not declared — Expected expiration P&L under the model (closed-form expected intrinsic − premium per leg). - probabilityOfProfit: number; default: not declared — Probability that expiration P&L is positive (sum of profit-region probabilities). - probabilityOfTouch: TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry. - riskReward: number | null; default: not declared — Reward-to-risk ratio `|maxProfit / maxLoss|`, or `null` when it is undefined — an unbounded profit, an unbounded loss, or a zero maximum loss — with the reason in `diagnostics.warnings` (`strategy.risk_reward_undefined`). Never `Infinity` (B3). ### @insiderfinance/totalfinance/strategy#ProbabilityModel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The explicit probability model behind the metrics (echoed, per spec §12.6). ```typescript /** The explicit probability model behind the metrics (echoed, per spec §12.6). */ export interface ProbabilityModel { measure: ProbabilityMeasure; /** Annualized drift used for the terminal lognormal. */ drift: number; /** * Representative annualized volatility. For a lognormal model this is the constant vol; for a * local-volatility model it is `σ_loc(spot, t)` at valuation (the path uses the full surface). */ volatility: number; /** Diffusion used: `lognormal` (constant vol) or `localVolatility` (smile-consistent Dupire surface). */ volatilityModel: 'lognormal' | 'localVolatility'; /** Time to expiry in years. */ timeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drift: number; default: not declared — Annualized drift used for the terminal lognormal. - measure: ProbabilityMeasure; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - volatility: number; default: not declared — Representative annualized volatility. For a lognormal model this is the constant vol; for a local-volatility model it is `σ_loc(spot, t)` at valuation (the path uses the full surface). - volatilityModel: 'lognormal' | 'localVolatility'; default: not declared — Diffusion used: `lognormal` (constant vol) or `localVolatility` (smile-consistent Dupire surface). ### @insiderfinance/totalfinance/strategy#ProbabilityMonteCarloInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ProbabilityMonteCarloInput extends Omit { /** * Annualized volatility of the constant-vol lognormal. Required unless {@link localVolatility} is supplied * (a local-volatility path ignores it except as the model echo's representative vol). */ volatility?: number; /** * Optional Dupire local-volatility function `σ_loc(level, t)` (e.g. from * `@insiderfinance/totalfinance/volatility`'s `surfaceLocalVolatility` or `@insiderfinance/totalfinance/options`'s `dupireLocalVolatility`). When provided, the * simulation steps under local vol instead of a single lognormal σ, so probability-of-profit, * expected P&L, and probability-of-touch all reflect the volatility smile/skew — the smile-aware * multi-leg read. The function is evaluated at the price and time reached at each step. */ localVolatility?: (level: number, timeToExpiryYears: number) => number; /** Seed for the deterministic PRNG (required — the simulation never reads the system clock). */ seed: number; /** Number of simulated paths (default 50_000). */ paths?: number; /** Monitoring steps per path for the probability-of-touch estimate (default 50). */ steps?: number; /** * Optional P&L quantiles to report (each in `(0, 1)`), forming an expiration profit "cone" from the * simulated terminal distribution. E.g. `[0.05, 0.5, 0.95]` → 5th/50th/95th-percentile P&L. */ pnlQuantiles?: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - dividendYield?: number; default: not declared - expectedReturn?: number; default: not declared — Annualized expected return, the drift of the `realWorld` measure. **REQUIRED when `measure: 'realWorld'`, and rejected otherwise.** It used to default to `riskFreeRate`, so `measure: 'realWorld'` with no expected return silently returned the risk-neutral probabilities while `assumptions.probabilityModel.measure` still reported `'realWorld'` — a result whose own echoed assumptions contradicted the number it carried. Choosing the real-world measure IS choosing a drift, so the drift must be stated. - expiry: string; default: not declared - localVolatility?: (level: number, timeToExpiryYears: number) => number; default: not declared — Optional Dupire local-volatility function `σ_loc(level, t)` (e.g. from `@insiderfinance/totalfinance/volatility`'s `surfaceLocalVolatility` or `@insiderfinance/totalfinance/options`'s `dupireLocalVolatility`). When provided, the simulation steps under local vol instead of a single lognormal σ, so probability-of-profit, expected P&L, and probability-of-touch all reflect the volatility smile/skew — the smile-aware multi-leg read. The function is evaluated at the price and time reached at each step. - localVolatility(level): number; default: not declared - localVolatility(timeToExpiryYears): number; default: not declared - measure?: ProbabilityMeasure; default: not declared — Terminal measure: `riskNeutral` (drift `r − q`, default) or `realWorld` (drift `expectedReturn − q`). - paths?: number; default: not declared — Number of simulated paths (default 50_000). - pnlQuantiles?: number[]; default: not declared — Optional P&L quantiles to report (each in `(0, 1)`), forming an expiration profit "cone" from the simulated terminal distribution. E.g. `[0.05, 0.5, 0.95]` → 5th/50th/95th-percentile P&L. - riskFreeRate: number; default: not declared - seed: number; default: not declared — Seed for the deterministic PRNG (required — the simulation never reads the system clock). - spot: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - steps?: number; default: not declared — Monitoring steps per path for the probability-of-touch estimate (default 50). - volatility?: number; default: not declared — Annualized volatility of the constant-vol lognormal. Required unless {@link localVolatility} is supplied (a local-volatility path ignores it except as the model echo's representative vol). ### @insiderfinance/totalfinance/strategy#ProbabilityMonteCarloMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ProbabilityMonteCarloMetrics { /** Monte-Carlo probability of a positive expiration P&L. */ probabilityOfProfit: number; /** Monte-Carlo expected expiration P&L. */ expectedValue: number; /** Standard error of the expected-value estimate. */ expectedValueStandardError: number; /** * Probability of touching each breakeven before expiry, estimated from simulated paths with the * Brownian-bridge continuous-monitoring correction (discrete sampling alone would under-count). */ probabilityOfTouch: TouchProbability[]; /** The probability model, echoed. */ /** * Applied conventions, plus where the market fields came from — construction market, call site, * or a merge (R5) — as `assumptions.marketSource` (R2: never hoisted to the top level). */ assumptions: Assumptions<{ marketSource: MarketSource; probabilityModel: ProbabilityModel; }>; /** Number of paths simulated. */ paths: number; /** The PRNG seed, echoed for reproducibility (stochastic-provenance rule, cf. `MonteCarloStatistics.seed`). */ seed: number; /** Requested expiration-P&L quantiles (the profit cone), present only when `pnlQuantiles` was set. */ pnlQuantiles?: { quantile: number; pnl: number; }[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions<{ marketSource: MarketSource; probabilityModel: ProbabilityModel; }>; default: not declared — Applied conventions, plus where the market fields came from — construction market, call site, or a merge (R5) — as `assumptions.marketSource` (R2: never hoisted to the top level). - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.marketSource: MarketSource; default: not declared - assumptions.model?: string; default: not declared - assumptions.probabilityModel: ProbabilityModel; default: not declared - assumptions.probabilityModel.drift: number; default: not declared — Annualized drift used for the terminal lognormal. - assumptions.probabilityModel.measure: ProbabilityMeasure; default: not declared - assumptions.probabilityModel.timeToExpiryYears: number; default: not declared — Time to expiry in years. - assumptions.probabilityModel.volatility: number; default: not declared — Representative annualized volatility. For a lognormal model this is the constant vol; for a local-volatility model it is `σ_loc(spot, t)` at valuation (the path uses the full surface). - assumptions.probabilityModel.volatilityModel: 'lognormal' | 'localVolatility'; default: not declared — Diffusion used: `lognormal` (constant vol) or `localVolatility` (smile-consistent Dupire surface). - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - expectedValue: number; default: not declared — Monte-Carlo expected expiration P&L. - expectedValueStandardError: number; default: not declared — Standard error of the expected-value estimate. - paths: number; default: not declared — Number of paths simulated. - pnlQuantiles?: { quantile: number; pnl: number; }[]; default: not declared — Requested expiration-P&L quantiles (the profit cone), present only when `pnlQuantiles` was set. - probabilityOfProfit: number; default: not declared — Monte-Carlo probability of a positive expiration P&L. - probabilityOfTouch: TouchProbability[]; default: not declared — Probability of touching each breakeven before expiry, estimated from simulated paths with the Brownian-bridge continuous-monitoring correction (discrete sampling alone would under-count). - seed: number; default: not declared — The PRNG seed, echoed for reproducibility (stochastic-provenance rule, cf. `MonteCarloStatistics.seed`). ### @insiderfinance/totalfinance/strategy#RatioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Long one option and short `ratio` of a further option (default 1×2). ```typescript // ───────────────────────── ratio spreads / backspreads ───────────────────────── /** Long one option and short `ratio` of a further option (default 1×2). */ export interface RatioInput extends UnitInput { long: Role; short: Role; /** Number of short legs per long (default 2). */ ratio?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - long: Role; default: not declared - long.premium?: number; default: not declared - long.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - ratio?: number; default: not declared — Number of short legs per long (default 2). - short: Role; default: not declared - short.premium?: number; default: not declared - short.strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#ReverseJadeLizardInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reverse jade lizard: short call + short put + long lower put (a short call with a short put spread). ```typescript /** Reverse jade lizard: short call + short put + long lower put (a short call with a short put spread). */ export interface ReverseJadeLizardInput extends UnitInput { call: Role; shortPut: Role; longPut: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Role; default: not declared - call.premium?: number; default: not declared - call.strike: number; default: not declared - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPut: Role; default: not declared - longPut.premium?: number; default: not declared - longPut.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPut: Role; default: not declared - shortPut.premium?: number; default: not declared - shortPut.strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#Role Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A distinct-strike builder slot (R3): a bare strike number, or `{ strike, premium? }`. A bare number means "strike only" — the premium is supplied later or model-priced via `{ premiums: 'model', market }`. Legs sharing one strike use `{ strike, callPremium?, putPremium? }` instead (the shared-strike rule). ```typescript /** * A distinct-strike builder slot (R3): a bare strike number, or `{ strike, premium? }`. A bare * number means "strike only" — the premium is supplied later or model-priced via * `{ premiums: 'model', market }`. Legs sharing one strike use `{ strike, callPremium?, * putPremium? }` instead (the shared-strike rule). */ export type Role = number | { strike: number; premium?: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - premium?: number; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#SCAN_OBJECTIVES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every ranking objective a scan accepts, as DATA — the single source the type, the runtime guard and the error message are all derived from. RV11 — these were three copies: a hand-written union here, a hand-written array in `optimizer.ts`, and a third hand-written list inside the error string. The string copy drifted and kept teaching `pop|ev` after both were renamed, because plain prose is invisible to a rename of the quoted literals. One tuple, and `.join(', ')` for the message, is what makes that impossible rather than merely fixed. `'return'` became `'returnOnRisk'` in the same pass: it ranked by `returnOnRisk` and the candidate output already called that number `returnOnRisk`, so one quantity carried two public names. ```typescript export declare const SCAN_OBJECTIVES: readonly ['probabilityOfProfit', 'expectedValue', 'returnOnRisk', 'expectedValuePerRisk']; ``` ### @insiderfinance/totalfinance/strategy#ScanCandidate Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScanCandidate { structure: ScanStructure; /** The structure's strikes, ascending. */ strikes: number[]; /** Net debit (> 0 paid) or credit (< 0 received), PER CONTRACT (multiplier-scaled, 100×) — the * same units as `maxProfit`/`maxLoss`/`expectedValue` and `Position.netDebit()`. */ netDebit: number; /** Max profit / max loss / expected value are per contract (100× multiplier, as in `Position`). */ maxProfit: number | null; maxLoss: number | null; /** Whether each tail of the expiration payoff is bounded (a `null` bound above is unbounded). */ bounded: { profit: boolean; loss: boolean; }; breakevens: number[]; probabilityOfProfit: number; expectedValue: number; /** * `|maxProfit / maxLoss|` — the same definition as `Position.probability().riskReward` — or * `null` when undefined (an unbounded side or a zero max loss). Never `Infinity` (B3). */ returnOnRisk: number | null; /** `expectedValue / |maxLoss|` — a risk-normalized EV; 0 when risk is unbounded. */ expectedValuePerRisk: number; /** Liquidity in `[0, 1]` from the legs' relative bid/ask spreads (1 = tight), null if unpriced. */ liquidity: number | null; /** The value of the ranking objective for this candidate; `null` when the objective is undefined for it. */ score: number | null; /** * The resolved legs (premiums included, whatever their source), so every candidate is * MATERIALIZABLE (WS7.3): `strategy(candidate.legs)` reconstructs the exact position for charting or * mark-to-market, and `strategy(candidate.legs).metrics()` reproduces the reported payoff metrics. */ legs: Leg[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounded: { profit: boolean; loss: boolean; }; default: not declared — Whether each tail of the expiration payoff is bounded (a `null` bound above is unbounded). - bounded.loss: boolean; default: not declared - bounded.profit: boolean; default: not declared - breakevens: number[]; default: not declared - expectedValue: number; default: not declared - expectedValuePerRisk: number; default: not declared — `expectedValue / |maxLoss|` — a risk-normalized EV; 0 when risk is unbounded. - legs: Leg[]; default: not declared — The resolved legs (premiums included, whatever their source), so every candidate is MATERIALIZABLE (WS7.3): `strategy(candidate.legs)` reconstructs the exact position for charting or mark-to-market, and `strategy(candidate.legs).metrics()` reproduces the reported payoff metrics. - liquidity: number | null; default: not declared — Liquidity in `[0, 1]` from the legs' relative bid/ask spreads (1 = tight), null if unpriced. - maxLoss: number | null; default: not declared - maxProfit: number | null; default: not declared — Max profit / max loss / expected value are per contract (100× multiplier, as in `Position`). - netDebit: number; default: not declared — Net debit (> 0 paid) or credit (< 0 received), PER CONTRACT (multiplier-scaled, 100×) — the same units as `maxProfit`/`maxLoss`/`expectedValue` and `Position.netDebit()`. - probabilityOfProfit: number; default: not declared - returnOnRisk: number | null; default: not declared — `|maxProfit / maxLoss|` — the same definition as `Position.probability().riskReward` — or `null` when undefined (an unbounded side or a zero max loss). Never `Infinity` (B3). - score: number | null; default: not declared — The value of the ranking objective for this candidate; `null` when the objective is undefined for it. - strikes: number[]; default: not declared — The structure's strikes, ascending. - structure: ScanStructure; default: not declared ### @insiderfinance/totalfinance/strategy#ScanObjective Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ranking objective; `expectedValuePerRisk` (expected value ÷ max loss) is the default. ```typescript /** Ranking objective; `expectedValuePerRisk` (expected value ÷ max loss) is the default. */ export type ScanObjective = (typeof SCAN_OBJECTIVES)[number]; ``` ### @insiderfinance/totalfinance/strategy#ScanOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScanOptions { /** Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). */ spot: number; /** * Valuation instant. Epoch ms or a zoned ISO datetime, resolved at the boundary by core's * `resolveValuationAsOf` — the ONE valuation-instant grammar shared by `Position.probability()`, * the what-if cube and every other pricing boundary. A bare date is refused: a 0DTE's value * depends on the time of day. */ asOf: EpochMs | string; /** Option expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). */ expiry: string; riskFreeRate: number; dividendYield?: number; /** The option chain — one row per strike, ascending or not (sorted internally). */ chain: ScanQuoteRow[]; /** Constant annualized volatility used for probabilityOfProfit / expectedValue scoring and to price any missing premiums. */ volatility?: number; /** * Per-strike implied-volatility smile. Used to price any missing per-strike premiums (takes * precedence over `volatility`). **Scoring uses a SINGLE volatility:** `probabilityOfProfit` and * `expectedValue` are computed closed-form at the at-spot volatility `smile(spot)` (or * `volatility`), not the full smile — for smile-consistent probabilities, price a specific structure * with `Position.monteCarloProbability({ localVolatility })`. */ smile?: (strike: number) => number; /** Which structures to enumerate (default: all). */ structures?: ScanStructure[]; /** Cap on the width (strike distance) of any single wing/spread, in price units. */ maxWidth?: number; /** Keep only candidates with probability-of-profit ≥ this. */ minProbabilityOfProfit?: number; /** Keep only candidates whose max loss ≤ this (in the position's P&L units — per contract, 100×). */ maxRisk?: number; /** Ranking objective (default `expectedValuePerRisk`). */ rankBy?: ScanObjective; /** Return only the top-N ranked candidates (default 25). */ top?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Valuation instant. Epoch ms or a zoned ISO datetime, resolved at the boundary by core's `resolveValuationAsOf` — the ONE valuation-instant grammar shared by `Position.probability()`, the what-if cube and every other pricing boundary. A bare date is refused: a 0DTE's value depends on the time of day. - chain: ScanQuoteRow[]; default: not declared — The option chain — one row per strike, ascending or not (sorted internally). - dividendYield?: number; default: not declared - expiry: string; default: not declared — Option expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). - maxRisk?: number; default: not declared — Keep only candidates whose max loss ≤ this (in the position's P&L units — per contract, 100×). - maxWidth?: number; default: not declared — Cap on the width (strike distance) of any single wing/spread, in price units. - minProbabilityOfProfit?: number; default: not declared — Keep only candidates with probability-of-profit ≥ this. - rankBy?: 'probabilityOfProfit' | 'expectedValue' | 'returnOnRisk' | 'expectedValuePerRisk'; default: not declared — Ranking objective (default `expectedValuePerRisk`). - riskFreeRate: number; default: not declared - smile?: (strike: number) => number; default: not declared — Per-strike implied-volatility smile. Used to price any missing per-strike premiums (takes precedence over `volatility`). **Scoring uses a SINGLE volatility:** `probabilityOfProfit` and `expectedValue` are computed closed-form at the at-spot volatility `smile(spot)` (or `volatility`), not the full smile — for smile-consistent probabilities, price a specific structure with `Position.monteCarloProbability({ localVolatility })`. - smile(strike): number; default: not declared - spot: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - structures?: ScanStructure[]; default: not declared — Which structures to enumerate (default: all). - top?: number; default: not declared — Return only the top-N ranked candidates (default 25). - volatility?: number; default: not declared — Constant annualized volatility used for probabilityOfProfit / expectedValue scoring and to price any missing premiums. ### @insiderfinance/totalfinance/strategy#ScanQuoteRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One strike's market data. `call`/`put` are mid premiums; bid/ask feed the liquidity score. ```typescript /** One strike's market data. `call`/`put` are mid premiums; bid/ask feed the liquidity score. */ export interface ScanQuoteRow { strike: number; /** Call mid premium. If omitted, priced from `volatility`/`smile` via Black–Scholes. */ call?: number; /** Put mid premium. If omitted, priced from `volatility`/`smile` via Black–Scholes. */ put?: number; callBid?: number; callAsk?: number; putBid?: number; putAsk?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call?: number; default: not declared — Call mid premium. If omitted, priced from `volatility`/`smile` via Black–Scholes. - callAsk?: number; default: not declared - callBid?: number; default: not declared - put?: number; default: not declared — Put mid premium. If omitted, priced from `volatility`/`smile` via Black–Scholes. - putAsk?: number; default: not declared - putBid?: number; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#ScanStructure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The structures the scanner can enumerate (all single-expiry, defined-risk or long-premium). ```typescript /** The structures the scanner can enumerate (all single-expiry, defined-risk or long-premium). */ export type ScanStructure = 'bullCallSpread' | 'bearCallSpread' | 'bullPutSpread' | 'bearPutSpread' | 'ironCondor' | 'ironButterfly' | 'longCallButterfly' | 'longPutButterfly' | 'straddle' | 'strangle'; ``` ### @insiderfinance/totalfinance/strategy#ScenarioRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioRow { underlyingPrice: number; /** Additive vol shock applied (decimal). */ volatilityShock: number; /** Calendar days advanced from `asOf`. */ daysForward: number; /** Mark-to-market P&L in this scenario. */ pnl: number; delta: number; gamma: number; theta: number; vega: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysForward: number; default: not declared — Calendar days advanced from `asOf`. - delta: number; default: not declared - gamma: number; default: not declared - pnl: number; default: not declared — Mark-to-market P&L in this scenario. - theta: number; default: not declared - underlyingPrice: number; default: not declared - vega: number; default: not declared - volatilityShock: number; default: not declared — Additive vol shock applied (decimal). ### @insiderfinance/totalfinance/strategy#ScenarioTableResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of `scenarioTable()` — the R2 one-envelope form: `value` is the grid rows, `assumptions` echoes the conventions plus `marketSource` (construction/call/merged, R5), and warnings ride `diagnostics.warnings` (WS3.7). A shocked volatility that lands at or below the 1e-6 floor is clamped rather than priced at a non-positive vol; when that happens the affected cells are flagged in the diagnostics instead of silently returning floor-vol numbers. ```typescript /** * Result of `scenarioTable()` — the R2 one-envelope form: `value` is the grid rows, `assumptions` * echoes the conventions plus `marketSource` (construction/call/merged, R5), and warnings ride * `diagnostics.warnings` (WS3.7). A shocked volatility that lands at or below the 1e-6 floor is * clamped rather than priced at a non-positive vol; when that happens the affected cells are * flagged in the diagnostics instead of silently returning floor-vol numbers. */ export type ScenarioTableResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions<{ marketSource: MarketSource; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.marketSource: MarketSource; default: not declared - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: ScenarioRow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/strategy#ShortStraddleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── short straddle / strangle, strips / straps ───────────────────────── export interface ShortStraddleInput extends UnitInput { strike: number; callPremium?: number; putPremium?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callPremium?: number; default: not declared - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putPremium?: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#ShortStrangleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ShortStrangleInput extends UnitInput { /** The sold call: a strike, or `{ strike, premium? }`. */ call: Role; /** The sold put: a strike, or `{ strike, premium? }`. */ put: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - call.premium?: number; default: not declared - call.strike: number; default: not declared - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - put: Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - put.premium?: number; default: not declared - put.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. ### @insiderfinance/totalfinance/strategy#SingleLegInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── single legs ───────────────────────── export interface SingleLegInput extends StrikeLeg, UnitInput { } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - premium?: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#StockLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A share position inside a strategy (B4: a stock leg is a stock). `quantity` is signed shares — positive = long, negative = short — never scaled by the option multiplier; `price` is the entry price per share. A stock row carries no strike, no premium and no expiry. ```typescript /** * A share position inside a strategy (B4: a stock leg is a stock). `quantity` is signed shares — * positive = long, negative = short — never scaled by the option multiplier; `price` is the entry * price per share. A stock row carries no strike, no premium and no expiry. */ export interface StockLeg { kind: 'stock'; /** Entry price per share. */ price: number; /** Signed shares: positive = long, negative = short. */ quantity: number; /** Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). */ strike?: undefined; premium?: undefined; expiry?: undefined; impliedVolatility?: undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: undefined; default: not declared - impliedVolatility?: undefined; default: not declared - kind: 'stock'; default: not declared - premium?: undefined; default: not declared - price: number; default: not declared — Entry price per share. - quantity: number; default: not declared — Signed shares: positive = long, negative = short. - strike?: undefined; default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). ### @insiderfinance/totalfinance/strategy#StockLegInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StockLegInput { /** Entry price per share. */ price: number; /** Signed shares: positive = long, negative = short. Not scaled by the option multiplier. */ quantity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared — Entry price per share. - quantity: number; default: not declared — Signed shares: positive = long, negative = short. Not scaled by the option multiplier. ### @insiderfinance/totalfinance/strategy#StockOptionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared: an underlying stock entry price plus a per-contract unit count (100 shares per contract). ```typescript // ───────────────────────── stock + option combinations ───────────────────────── /** Shared: an underlying stock entry price plus a per-contract unit count (100 shares per contract). */ export interface StockOptionInput extends UnitInput { /** Entry price per share of the stock leg. */ stockPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - stockPrice: number; default: not declared — Entry price per share of the stock leg. ### @insiderfinance/totalfinance/strategy#StraddleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StraddleInput { /** The shared strike (shared-strike rule: premiums are named per option type). */ strike: number; callPremium?: number; putPremium?: number; quantity?: number; expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callPremium?: number; default: not declared - expiry?: string; default: not declared - putPremium?: number; default: not declared - quantity?: number; default: not declared - strike: number; default: not declared — The shared strike (shared-strike rule: premiums are named per option type). ### @insiderfinance/totalfinance/strategy#StrangleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StrangleInput { /** The call leg: a strike, or `{ strike, premium? }`. */ call: Role; /** The put leg: a strike, or `{ strike, premium? }`. */ put: Role; quantity?: number; expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: Role; default: not declared — The call leg: a strike, or `{ strike, premium? }`. - call.premium?: number; default: not declared - call.strike: number; default: not declared - expiry?: string; default: not declared - put: Role; default: not declared — The put leg: a strike, or `{ strike, premium? }`. - put.premium?: number; default: not declared - put.strike: number; default: not declared - quantity?: number; default: not declared ### @insiderfinance/totalfinance/strategy#StrategyDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A manifest entry, as served by {@link listStrategies}. ```typescript /** A manifest entry, as served by {@link listStrategies}. */ export interface StrategyDescriptor { name: string; description: string; /** True for calendars/diagonals — structures whose legs span multiple expiries. */ multiExpiry: boolean; /** * A canonical, buildable input for this builder (premiums omitted — build with * `{ premiums: 'model', market }`). Doubles as executable documentation of the input shape. */ example: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - description: string; default: not declared - example: Record; default: not declared — A canonical, buildable input for this builder (premiums omitted — build with `{ premiums: 'model', market }`). Doubles as executable documentation of the input shape. - multiExpiry: boolean; default: not declared — True for calendars/diagonals — structures whose legs span multiple expiries. - name: string; default: not declared ### @insiderfinance/totalfinance/strategy#StrategyMatch Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One classification match. `exact` is always true today (a fuzzy tier can be added later). ```typescript /** One classification match. `exact` is always true today (a fuzzy tier can be added later). */ export interface StrategyMatch { name: string; exact: true; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exact: true; default: not declared - name: string; default: not declared ### @insiderfinance/totalfinance/strategy#StrikeLeg Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A strike + optional entry premium for one option leg. Omit `premium` and build the position with `{ premiums: 'model', market }` to have it priced from the market (§3.4) — the profit-calculator user with strikes but no fills still gets breakevens / max P&L / PoP. Everywhere a builder takes a {@link Role} slot, a bare strike number is shorthand for `{ strike }` (R3). ```typescript /** * A strike + optional entry premium for one option leg. Omit `premium` and build the position with * `{ premiums: 'model', market }` to have it priced from the market (§3.4) — the profit-calculator * user with strikes but no fills still gets breakevens / max P&L / PoP. Everywhere a builder takes * a {@link Role} slot, a bare strike number is shorthand for `{ strike }` (R3). */ export interface StrikeLeg { strike: number; premium?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - premium?: number; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#SyntheticInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A single strike with a call and a put premium (synthetics / same-strike structures). ```typescript /** A single strike with a call and a put premium (synthetics / same-strike structures). */ export interface SyntheticInput extends UnitInput { strike: number; callPremium?: number; putPremium?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callPremium?: number; default: not declared - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putPremium?: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#SyntheticPutInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Synthetic put (synthetic long put): short stock + long call. ```typescript /** Synthetic put (synthetic long put): short stock + long call. */ export interface SyntheticPutInput extends SingleLegInput { /** Entry price of the short stock leg. */ stockPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - premium?: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - stockPrice: number; default: not declared — Entry price of the short stock leg. - strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#TimeBias Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type TimeBias = 'decay-helps' | 'decay-hurts' | 'neutral'; ``` ### @insiderfinance/totalfinance/strategy#TouchProbability Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TouchProbability { /** The breakeven price. */ price: number; /** Probability the underlying touches it at any time before expiry (first passage). */ probability: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared — The breakeven price. - probability: number; default: not declared — Probability the underlying touches it at any time before expiry (first passage). ### @insiderfinance/totalfinance/strategy#TwoStrikeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Two ascending strikes `lower < upper`. ```typescript // ───────────────────────── combos / synthetics / guts ───────────────────────── /** Two ascending strikes `lower < upper`. */ export interface TwoStrikeInput extends UnitInput { lower: Role; upper: Role; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - lower: Role; default: not declared - lower.premium?: number; default: not declared - lower.strike: number; default: not declared - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - upper: Role; default: not declared - upper.premium?: number; default: not declared - upper.strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#UnitInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Unit count + position-level expiry (R4) shared by every builder. ```typescript /** Unit count + position-level expiry (R4) shared by every builder. */ export interface UnitInput { /** Number of structures (default 1). Every leg scales by this. */ quantity?: number; /** Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). */ expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. ### @insiderfinance/totalfinance/strategy#VerticalInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VerticalInput { /** The bought leg: a strike, or `{ strike, premium? }`. */ long: Role; /** The sold leg: a strike, or `{ strike, premium? }`. */ short: Role; quantity?: number; /** Expiry applied to both legs (R4). */ expiry?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared — Expiry applied to both legs (R4). - long: Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - long.premium?: number; default: not declared - long.strike: number; default: not declared - quantity?: number; default: not declared - short: Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - short.premium?: number; default: not declared - short.strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#VolatilityBias Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type VolatilityBias = 'benefits-from-rising-impliedVolatility' | 'benefits-from-falling-impliedVolatility' | 'neutral'; ``` ### @insiderfinance/totalfinance/strategy#VolatilitySource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Where a mark-to-market's volatility came from: all position-level, all per-leg, or a mix. ```typescript /** Where a mark-to-market's volatility came from: all position-level, all per-leg, or a mix. */ export type VolatilitySource = 'position' | 'perLeg' | 'mixed' | 'perCall'; ``` ### @insiderfinance/totalfinance/strategy#WhatIfCell Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cell of a {@link WhatIfCubeValue}: a mark-to-market at a (spot, vol shock, days-forward) point. ```typescript // ─────────────────────────── What-if cube (spec: docs/specs/what-if-cube.md) ─────────────────────────── /** One cell of a {@link WhatIfCubeValue}: a mark-to-market at a (spot, vol shock, days-forward) point. */ export interface WhatIfCell { underlyingPrice: number; /** Additive vol shock applied (decimal). */ volatilityShock: number; /** Calendar days advanced from `asOf`. */ daysForward: number; /** Mark-to-market P&L in this scenario. */ pnl: number; delta: number; gamma: number; theta: number; vega: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysForward: number; default: not declared — Calendar days advanced from `asOf`. - delta: number; default: not declared - gamma: number; default: not declared - pnl: number; default: not declared — Mark-to-market P&L in this scenario. - theta: number; default: not declared - underlyingPrice: number; default: not declared - vega: number; default: not declared - volatilityShock: number; default: not declared — Additive vol shock applied (decimal). ### @insiderfinance/totalfinance/strategy#WhatIfCubeBreakEven Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The what-if cube's break-even-time surface: the first non-negative-P&L day per (price, vol). ```typescript /** The what-if cube's break-even-time surface: the first non-negative-P&L day per (price, vol). */ export interface WhatIfCubeBreakEven { /** Price outer, vol-shock inner. The `daysForward` value of the first non-negative-P&L day, or `null`. */ firstNonNegativeDayByPriceAndVolatility: Array>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - firstNonNegativeDayByPriceAndVolatility: (number | null)[][]; default: not declared — Price outer, vol-shock inner. The `daysForward` value of the first non-negative-P&L day, or `null`. ### @insiderfinance/totalfinance/strategy#WhatIfCubeOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link Position.whatIfCube }. ```typescript /** Options for {@link Position.whatIfCube}. */ export interface WhatIfCubeOptions { /** Market overrides; defaults from the construction market (R5). */ market?: Partial>; /** Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. */ prices?: number[] | PriceRange; /** Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. */ volatilityShocks?: number[]; /** Calendar days to advance `asOf`, e.g. `[0, 7, 30]`. Default `[0]`. */ daysForward?: number[]; /** Which extremum the optimal-exit surface picks per (spot, vol); default `'max-pnl'`. */ objective?: 'max-pnl' | 'min-pnl'; /** * Opt-in probability weighting (Wave 6 §3). When set, the result gains a `probability` block with the * per-day spot mass, disclosed tails, and per-(vol, day) expected P&L. Requires strictly increasing * unique prices and non-negative days. */ probability?: WhatIfProbabilityOptions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysForward?: number[]; default: not declared — Calendar days to advance `asOf`, e.g. `[0, 7, 30]`. Default `[0]`. - market?: Partial>; default: not declared — Market overrides; defaults from the construction market (R5). - market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - market.dividendYield?: number; default: not declared - market.expiry?: string; default: not declared - market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - market.riskFreeRate?: number; default: not declared - market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - objective?: 'max-pnl' | 'min-pnl'; default: not declared — Which extremum the optimal-exit surface picks per (spot, vol); default `'max-pnl'`. - prices?: number[] | PriceRange; default: not declared — Spot axis: an explicit grid array or a `{ from, to, steps }` range. Omit for the default window. - prices.from: number; default: not declared - prices.steps: number; default: not declared - prices.to: number; default: not declared - probability?: WhatIfProbabilityOptions; default: not declared — Opt-in probability weighting (Wave 6 §3). When set, the result gains a `probability` block with the per-day spot mass, disclosed tails, and per-(vol, day) expected P&L. Requires strictly increasing unique prices and non-negative days. - probability.gridPolicy?: 'report-and-renormalize' | 'include-in-edge-bins'; default: not declared — How finite price-grid tails are handled; default `'report-and-renormalize'`. - probability.model: WhatIfProbabilityModel; default: not declared - probability.model.annualizedVolatility: number; default: not declared - probability.model.density: (price: number, yearsForward: number) => number; default: not declared - probability.model.density(price): number; default: not declared - probability.model.density(yearsForward): number; default: not declared - probability.model.drift: number; default: not declared — Annualized arithmetic GBM drift used directly for the underlying process. - probability.model.expectedReturn: number; default: not declared — Annualized total expected return before dividend yield. - probability.model.kind: ('custom') | ('gbm'); default: not declared - probability.model.measure?: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared - probability.model.support: { from: number; to: number; }; default: not declared - probability.model.support.from: number; default: not declared - probability.model.support.to: number; default: not declared - volatilityShocks?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. ### @insiderfinance/totalfinance/strategy#WhatIfCubeProbability Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The what-if cube's probability block — resolved spot mass per day, tails, and expected P&L. ```typescript /** The what-if cube's probability block — resolved spot mass per day, tails, and expected P&L. */ export interface WhatIfCubeProbability { /** Day outer, price inner. Volatility-independent spot mass (renormalized in-grid per `gridPolicy`). */ spotMassByDay: number[][]; /** Per day, the raw mass below the grid's lower edge and above its upper edge (before renormalization). */ tailMassByDay: Array<{ below: number; above: number; }>; gridPolicy: 'report-and-renormalize' | 'include-in-edge-bins'; /** `conditional-on-grid` (tails renormalized out) or `edge-censored` (tails folded into edge bins). */ expectationMeaning: 'conditional-on-grid' | 'edge-censored'; /** The resolved model, echoed — including the resolved drift, so the assumption is inspectable. */ modelAssumptions: { kind: 'gbm'; measure: 'riskNeutral'; annualizedVolatility: number; riskFreeRate: number; dividendYield: number; resolvedDrift: number; } | { kind: 'gbm'; measure: 'realWorld'; annualizedVolatility: number; expectedReturn: number; dividendYield: number; resolvedDrift: number; } | { kind: 'gbm'; measure: 'explicit'; annualizedVolatility: number; drift: number; resolvedDrift: number; } | { kind: 'custom'; support: { from: number; to: number; }; }; /** Volatility-shock outer, day inner. Probability-weighted expected P&L, interpreted by `expectationMeaning`. */ expectedPnlByVolatilityAndDay: number[][]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectationMeaning: 'conditional-on-grid' | 'edge-censored'; default: not declared — `conditional-on-grid` (tails renormalized out) or `edge-censored` (tails folded into edge bins). - expectedPnlByVolatilityAndDay: number[][]; default: not declared — Volatility-shock outer, day inner. Probability-weighted expected P&L, interpreted by `expectationMeaning`. - gridPolicy: 'report-and-renormalize' | 'include-in-edge-bins'; default: not declared - modelAssumptions: { annualizedVolatility: number; dividendYield: number; kind: 'gbm'; measure: 'riskNeutral'; resolvedDrift: number; riskFreeRate: number; } | { annualizedVolatility: number; dividendYield: number; expectedReturn: number; kind: 'gbm'; measure: 'realWorld'; resolvedDrift: number; } | { annualizedVolatility: number; drift: number; kind: 'gbm'; measure: 'explicit'; resolvedDrift: number; } | { kind: 'custom'; support: { from: number; to: number; }; }; default: not declared — The resolved model, echoed — including the resolved drift, so the assumption is inspectable. - modelAssumptions.annualizedVolatility: number; default: not declared - modelAssumptions.dividendYield: number; default: not declared - modelAssumptions.drift: number; default: not declared - modelAssumptions.expectedReturn: number; default: not declared - modelAssumptions.kind: ('custom') | ('gbm'); default: not declared - modelAssumptions.measure: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared - modelAssumptions.resolvedDrift: number; default: not declared - modelAssumptions.riskFreeRate: number; default: not declared - modelAssumptions.support: { from: number; to: number; }; default: not declared - modelAssumptions.support.from: number; default: not declared - modelAssumptions.support.to: number; default: not declared - spotMassByDay: number[][]; default: not declared — Day outer, price inner. Volatility-independent spot mass (renormalized in-grid per `gridPolicy`). - tailMassByDay: { below: number; above: number; }[]; default: not declared — Per day, the raw mass below the grid's lower edge and above its upper edge (before renormalization). ### @insiderfinance/totalfinance/strategy#WhatIfCubeResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link Position.whatIfCube } — the R2 one-envelope form. ```typescript /** Result of {@link Position.whatIfCube} — the R2 one-envelope form. */ export type WhatIfCubeResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ marketSource: MarketSource; }>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.marketSource: MarketSource; default: not declared - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: WhatIfCubeValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.axes: { daysForward: number[]; prices: number[]; volatilityShocks: number[]; }; default: not declared - value.axes.daysForward: number[]; default: not declared - value.axes.prices: number[]; default: not declared - value.axes.volatilityShocks: number[]; default: not declared - value.best: WhatIfCell; default: not declared — The global maximum-P&L cell across the whole cube. - value.best.daysForward: number; default: not declared — Calendar days advanced from `asOf`. - value.best.delta: number; default: not declared - value.best.gamma: number; default: not declared - value.best.pnl: number; default: not declared — Mark-to-market P&L in this scenario. - value.best.theta: number; default: not declared - value.best.underlyingPrice: number; default: not declared - value.best.vega: number; default: not declared - value.best.volatilityShock: number; default: not declared — Additive vol shock applied (decimal). - value.breakEven: WhatIfCubeBreakEven; default: not declared — Time-to-break-even surface — the first non-negative-P&L day per (price, vol). Always present. - value.breakEven.firstNonNegativeDayByPriceAndVolatility: (number | null)[][]; default: not declared — Price outer, vol-shock inner. The `daysForward` value of the first non-negative-P&L day, or `null`. - value.cells: WhatIfCell[]; default: not declared — Flat cells, row-major: price outer, vol middle, day inner. - value.optimalExit: OptimalExitPoint[]; default: not declared — One entry per (price, volatilityShock) — the optimal-exit surface over the (spot, vol) plane. - value.probability?: WhatIfCubeProbability; default: not declared — Probability weighting — present only when `probability` was requested. - value.probability.expectationMeaning: 'conditional-on-grid' | 'edge-censored'; default: not declared — `conditional-on-grid` (tails renormalized out) or `edge-censored` (tails folded into edge bins). - value.probability.expectedPnlByVolatilityAndDay: number[][]; default: not declared — Volatility-shock outer, day inner. Probability-weighted expected P&L, interpreted by `expectationMeaning`. - value.probability.gridPolicy: 'report-and-renormalize' | 'include-in-edge-bins'; default: not declared - value.probability.modelAssumptions: { annualizedVolatility: number; dividendYield: number; kind: 'gbm'; measure: 'riskNeutral'; resolvedDrift: number; riskFreeRate: number; } | { annualizedVolatility: number; dividendYield: number; expectedReturn: number; kind: 'gbm'; measure: 'realWorld'; resolvedDrift: number; } | { annualizedVolatility: number; drift: number; kind: 'gbm'; measure: 'explicit'; resolvedDrift: number; } | { kind: 'custom'; support: { from: number; to: number; }; }; default: not declared — The resolved model, echoed — including the resolved drift, so the assumption is inspectable. - value.probability.modelAssumptions.annualizedVolatility: number; default: not declared - value.probability.modelAssumptions.dividendYield: number; default: not declared - value.probability.modelAssumptions.drift: number; default: not declared - value.probability.modelAssumptions.expectedReturn: number; default: not declared - value.probability.modelAssumptions.kind: ('custom') | ('gbm'); default: not declared - value.probability.modelAssumptions.measure: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared - value.probability.modelAssumptions.resolvedDrift: number; default: not declared - value.probability.modelAssumptions.riskFreeRate: number; default: not declared - value.probability.modelAssumptions.support: { from: number; to: number; }; default: not declared - value.probability.modelAssumptions.support.from: number; default: not declared - value.probability.modelAssumptions.support.to: number; default: not declared - value.probability.spotMassByDay: number[][]; default: not declared — Day outer, price inner. Volatility-independent spot mass (renormalized in-grid per `gridPolicy`). - value.probability.tailMassByDay: { below: number; above: number; }[]; default: not declared — Per day, the raw mass below the grid's lower edge and above its upper edge (before renormalization). - value.worst: WhatIfCell; default: not declared — The global minimum-P&L cell across the whole cube. - value.worst.daysForward: number; default: not declared — Calendar days advanced from `asOf`. - value.worst.delta: number; default: not declared - value.worst.gamma: number; default: not declared - value.worst.pnl: number; default: not declared — Mark-to-market P&L in this scenario. - value.worst.theta: number; default: not declared - value.worst.underlyingPrice: number; default: not declared - value.worst.vega: number; default: not declared - value.worst.volatilityShock: number; default: not declared — Additive vol shock applied (decimal). ### @insiderfinance/totalfinance/strategy#WhatIfCubeValue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The cube value: the axes, the flat (row-major) cells, the optimal-exit surface, and the extremes. ```typescript /** The cube value: the axes, the flat (row-major) cells, the optimal-exit surface, and the extremes. */ export interface WhatIfCubeValue { axes: { prices: number[]; volatilityShocks: number[]; daysForward: number[]; }; /** Flat cells, row-major: price outer, vol middle, day inner. */ cells: WhatIfCell[]; /** One entry per (price, volatilityShock) — the optimal-exit surface over the (spot, vol) plane. */ optimalExit: OptimalExitPoint[]; /** The global maximum-P&L cell across the whole cube. */ best: WhatIfCell; /** The global minimum-P&L cell across the whole cube. */ worst: WhatIfCell; /** Time-to-break-even surface — the first non-negative-P&L day per (price, vol). Always present. */ breakEven: WhatIfCubeBreakEven; /** Probability weighting — present only when `probability` was requested. */ probability?: WhatIfCubeProbability; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - axes: { prices: number[]; volatilityShocks: number[]; daysForward: number[]; }; default: not declared - axes.daysForward: number[]; default: not declared - axes.prices: number[]; default: not declared - axes.volatilityShocks: number[]; default: not declared - best: WhatIfCell; default: not declared — The global maximum-P&L cell across the whole cube. - best.daysForward: number; default: not declared — Calendar days advanced from `asOf`. - best.delta: number; default: not declared - best.gamma: number; default: not declared - best.pnl: number; default: not declared — Mark-to-market P&L in this scenario. - best.theta: number; default: not declared - best.underlyingPrice: number; default: not declared - best.vega: number; default: not declared - best.volatilityShock: number; default: not declared — Additive vol shock applied (decimal). - breakEven: WhatIfCubeBreakEven; default: not declared — Time-to-break-even surface — the first non-negative-P&L day per (price, vol). Always present. - breakEven.firstNonNegativeDayByPriceAndVolatility: (number | null)[][]; default: not declared — Price outer, vol-shock inner. The `daysForward` value of the first non-negative-P&L day, or `null`. - cells: WhatIfCell[]; default: not declared — Flat cells, row-major: price outer, vol middle, day inner. - optimalExit: OptimalExitPoint[]; default: not declared — One entry per (price, volatilityShock) — the optimal-exit surface over the (spot, vol) plane. - probability?: WhatIfCubeProbability; default: not declared — Probability weighting — present only when `probability` was requested. - probability.expectationMeaning: 'conditional-on-grid' | 'edge-censored'; default: not declared — `conditional-on-grid` (tails renormalized out) or `edge-censored` (tails folded into edge bins). - probability.expectedPnlByVolatilityAndDay: number[][]; default: not declared — Volatility-shock outer, day inner. Probability-weighted expected P&L, interpreted by `expectationMeaning`. - probability.gridPolicy: 'report-and-renormalize' | 'include-in-edge-bins'; default: not declared - probability.modelAssumptions: { kind: 'gbm'; measure: 'riskNeutral'; annualizedVolatility: number; riskFreeRate: number; dividendYield: number; resolvedDrift: number; } | { kind: 'gbm'; measure: 'realWorld'; annualizedVolatility: number; expectedReturn: number; dividendYield: number; resolvedDrift: number; } | { kind: 'gbm'; measure: 'explicit'; annualizedVolatility: number; drift: number; resolvedDrift: number; } | { kind: 'custom'; support: { from: number; to: number; }; }; default: not declared — The resolved model, echoed — including the resolved drift, so the assumption is inspectable. - probability.modelAssumptions.annualizedVolatility: number; default: not declared - probability.modelAssumptions.dividendYield: number; default: not declared - probability.modelAssumptions.drift: number; default: not declared - probability.modelAssumptions.expectedReturn: number; default: not declared - probability.modelAssumptions.kind: ('custom') | ('gbm'); default: not declared - probability.modelAssumptions.measure: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared - probability.modelAssumptions.resolvedDrift: number; default: not declared - probability.modelAssumptions.riskFreeRate: number; default: not declared - probability.modelAssumptions.support: { from: number; to: number; }; default: not declared - probability.modelAssumptions.support.from: number; default: not declared - probability.modelAssumptions.support.to: number; default: not declared - probability.spotMassByDay: number[][]; default: not declared — Day outer, price inner. Volatility-independent spot mass (renormalized in-grid per `gridPolicy`). - probability.tailMassByDay: { below: number; above: number; }[]; default: not declared — Per day, the raw mass below the grid's lower edge and above its upper edge (before renormalization). - worst: WhatIfCell; default: not declared — The global minimum-P&L cell across the whole cube. - worst.daysForward: number; default: not declared — Calendar days advanced from `asOf`. - worst.delta: number; default: not declared - worst.gamma: number; default: not declared - worst.pnl: number; default: not declared — Mark-to-market P&L in this scenario. - worst.theta: number; default: not declared - worst.underlyingPrice: number; default: not declared - worst.vega: number; default: not declared - worst.volatilityShock: number; default: not declared — Additive vol shock applied (decimal). ### @insiderfinance/totalfinance/strategy#WhatIfGbmProbabilityModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The GBM terminal-price law for the what-if cube's spot distribution (Wave 6 §3). Drift follows the same measure grammar as {@link Position.probability } — there is no silent zero-drift default. ```typescript /** * The GBM terminal-price law for the what-if cube's spot distribution (Wave 6 §3). Drift follows the * same measure grammar as {@link Position.probability} — there is no silent zero-drift default. */ export type WhatIfGbmProbabilityModel = { kind: 'gbm'; annualizedVolatility: number; measure?: 'riskNeutral'; } | { kind: 'gbm'; annualizedVolatility: number; measure: 'realWorld'; /** Annualized total expected return before dividend yield. */ expectedReturn: number; } | { kind: 'gbm'; annualizedVolatility: number; measure: 'explicit'; /** Annualized arithmetic GBM drift used directly for the underlying process. */ drift: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedVolatility: number; default: not declared - drift: number; default: not declared — Annualized arithmetic GBM drift used directly for the underlying process. - expectedReturn: number; default: not declared — Annualized total expected return before dividend yield. - kind: 'gbm'; default: not declared - measure?: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared ### @insiderfinance/totalfinance/strategy#WhatIfProbabilityModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The what-if cube's spot process: a GBM (by measure) or an explicit terminal density over a support. ```typescript /** The what-if cube's spot process: a GBM (by measure) or an explicit terminal density over a support. */ export type WhatIfProbabilityModel = WhatIfGbmProbabilityModel | { kind: 'custom'; density: (price: number, yearsForward: number) => number; support: { from: number; to: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedVolatility: number; default: not declared - density: (price: number, yearsForward: number) => number; default: not declared - density(price): number; default: not declared - density(yearsForward): number; default: not declared - drift: number; default: not declared — Annualized arithmetic GBM drift used directly for the underlying process. - expectedReturn: number; default: not declared — Annualized total expected return before dividend yield. - kind: ('custom') | ('gbm'); default: not declared - measure?: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared - support: { from: number; to: number; }; default: not declared - support.from: number; default: not declared - support.to: number; default: not declared ### @insiderfinance/totalfinance/strategy#WhatIfProbabilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Probability-mode options for {@link Position.whatIfCube }. ```typescript /** Probability-mode options for {@link Position.whatIfCube}. */ export interface WhatIfProbabilityOptions { model: WhatIfProbabilityModel; /** How finite price-grid tails are handled; default `'report-and-renormalize'`. */ gridPolicy?: 'report-and-renormalize' | 'include-in-edge-bins'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - gridPolicy?: 'report-and-renormalize' | 'include-in-edge-bins'; default: not declared — How finite price-grid tails are handled; default `'report-and-renormalize'`. - model: WhatIfProbabilityModel; default: not declared - model.annualizedVolatility: number; default: not declared - model.density: (price: number, yearsForward: number) => number; default: not declared - model.density(price): number; default: not declared - model.density(yearsForward): number; default: not declared - model.drift: number; default: not declared — Annualized arithmetic GBM drift used directly for the underlying process. - model.expectedReturn: number; default: not declared — Annualized total expected return before dividend yield. - model.kind: ('custom') | ('gbm'); default: not declared - model.measure?: ('explicit') | ('realWorld') | ('riskNeutral'); default: not declared - model.support: { from: number; to: number; }; default: not declared - model.support.from: number; default: not declared - model.support.to: number; default: not declared ### @insiderfinance/totalfinance/strategy#bearCallLadder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bearCallLadder: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bearCallSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bearCallSpread: (input: b.VerticalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.VerticalInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bearPutLadder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bearPutLadder: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bearPutSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bearPutSpread: (input: b.VerticalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.VerticalInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#buildStrategy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function buildStrategy(request: BuildStrategyInput): Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): BuildStrategyInput; default: not declared - (request).config?: PositionConfig; default: not declared — Optional position construction and model-premium configuration. - (request).input: Record; default: not declared — Builder-specific strategy fields; inspect the matching descriptor's `exampleInput`. - (request).name: string; default: not declared — The exact strategy name returned by {@link listStrategies}. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bullCallLadder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bullCallLadder: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bullCallSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bullCallSpread: (input: b.VerticalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.VerticalInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bullPutLadder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bullPutLadder: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#bullPutSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bullPutSpread: (input: b.VerticalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.VerticalInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#calendarCallSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const calendarCallSpread: (input: cal.CalendarInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): cal.CalendarInput; default: not declared - (input).farExpiry: string; default: not declared — Far expiry of the long leg. - (input).longPremium?: number; default: not declared — Premium paid on the long far leg. - (input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).shortPremium?: number; default: not declared — Premium received on the short near leg. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#calendarPutSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const calendarPutSpread: (input: cal.CalendarInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): cal.CalendarInput; default: not declared - (input).farExpiry: string; default: not declared — Far expiry of the long leg. - (input).longPremium?: number; default: not declared — Premium paid on the long far leg. - (input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).shortPremium?: number; default: not declared — Premium received on the short near leg. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#callBrokenWing Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const callBrokenWing: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#callRatioBackspread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const callRatioBackspread: (input: s.RatioInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.RatioInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).ratio?: number; default: not declared — Number of short legs per long (default 2). - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#callRatioSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const callRatioSpread: (input: s.RatioInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.RatioInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).ratio?: number; default: not declared — Number of short legs per long (default 2). - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#cashSecuredPut Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cashSecuredPut: (input: s.SingleLegInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SingleLegInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#classifyStrategy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Classify a leg list (or a Position) against the named-strategy catalog. `matches` carries every matching name in manifest order — payoff-identical aliases all match — and is `[]` when the structure matches nothing (a custom position; every calculation still works, it just has no name). ```typescript export declare function classifyStrategy(input: readonly ClassifiableLeg[] | readonly LegInput[] | Position): StrategyClassification; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): Position | readonly LegInput[] | readonly ClassifiableLeg[]; default: not declared - (input).assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - (input).chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - (input).constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - (input).legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - (input).market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - (input).market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - (input).market.dividendYield?: number; default: not declared - (input).market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - (input).market.riskFreeRate: number; default: not declared - (input).market.spot: number; default: not declared - (input).market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - (input).metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - (input).monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - (input).multiplier: number; default: not declared - (input).netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - (input).payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - (input).pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - (input).premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - (input).premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - (input).probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - (input).scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - (input).value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - (input).whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - return.assumptions: { conventionsVersion: string; matching: 'structural-base-signature'; tieBreaker: 'wing-gap-symmetry'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.matching: 'structural-base-signature'; default: not declared — Identity is the structural base signature: (kind, sign, strike-rank, ratio, expiry-rank). - return.assumptions.tieBreaker: 'wing-gap-symmetry'; default: not declared — Spacing splits base-signature collisions only (butterflies vs broken wings). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.matches: StrategyMatch[]; default: not declared — Every matching name in manifest order — payoff-identical aliases all match. Empty = a custom position (every calculation still works, it just has no name). ### @insiderfinance/totalfinance/strategy#collar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const collar: (input: s.CollarInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.CollarInput; default: not declared - (input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#coveredCall Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const coveredCall: (input: s.StockOptionInput & s.StrikeLeg, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.StockOptionInput & s.StrikeLeg; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#coveredShortStraddle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const coveredShortStraddle: (input: s.StockOptionInput & s.ShortStraddleInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.StockOptionInput & s.ShortStraddleInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#coveredShortStrangle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const coveredShortStrangle: (input: s.StockOptionInput & s.ShortStrangleInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.StockOptionInput & s.ShortStrangleInput; default: not declared - (input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#diagonalCallSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const diagonalCallSpread: (input: cal.DiagonalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): cal.DiagonalInput; default: not declared - (input).farExpiry: string; default: not declared - (input).longPremium?: number; default: not declared - (input).longStrike: number; default: not declared - (input).nearExpiry: string; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).shortPremium?: number; default: not declared - (input).shortStrike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#diagonalPutSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const diagonalPutSpread: (input: cal.DiagonalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): cal.DiagonalInput; default: not declared - (input).farExpiry: string; default: not declared - (input).longPremium?: number; default: not declared - (input).longStrike: number; default: not declared - (input).nearExpiry: string; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).shortPremium?: number; default: not declared - (input).shortStrike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#doubleDiagonal Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const doubleDiagonal: (input: cal.DoubleDiagonalInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): cal.DoubleDiagonalInput; default: not declared - (input).call: cal.DoubleDiagonalSide; default: not declared - (input).farExpiry: string; default: not declared - (input).nearExpiry: string; default: not declared - (input).put: cal.DoubleDiagonalSide; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#explainPosition Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function explainPosition(position: Position, options?: ExplainPositionOptions): PositionExplanation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: ExplainPositionOptions; default: not declared - (options).market?: Partial; default: not declared — Market for probability + greeks (spot/vol/rate/asOf); merges over the position's own market. - (options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - (options).market.dividendYield?: number; default: not declared - (options).market.expiry?: string; default: not declared - (options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - (options).market.riskFreeRate?: number; default: not declared - (options).market.spot?: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - (options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - (options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - (options).underlyingLabel?: string; default: not declared — Underlying name for the prose (e.g. `'AAPL'`); default `'the underlying'`. - (position): Position; default: not declared - (position).assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - (position).chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - (position).constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - (position).legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - (position).market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - (position).market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - (position).market.dividendYield?: number; default: not declared - (position).market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - (position).market.riskFreeRate: number; default: not declared - (position).market.spot: number; default: not declared - (position).market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - (position).metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - (position).monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - (position).multiplier: number; default: not declared - (position).netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - (position).payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - (position).pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - (position).premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - (position).premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - (position).probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - (position).scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - (position).value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - (position).whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - return.aliases: string[]; default: not declared — Other payoff-identical names. - return.assumptions: { classifier: 'structural-base-signature'; conventionsVersion: string; marketDependent: boolean; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.classifier: 'structural-base-signature'; default: not declared — How the name was derived — always the structural classifier (identity is never remembered). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.marketDependent: boolean; default: not declared — Whether a usable market priced the greek/probability posture (false = payoff-only read). - return.definedRisk: boolean; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — a missing market explains itself here. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.directionalBias: DirectionalBias; default: not declared - return.economics: { breakevens: number[]; maxLoss: number | null; maxProfit: number | null; net: number; rewardToRisk: number | null; }; default: not declared - return.economics.breakevens: number[]; default: not declared - return.economics.maxLoss: number | null; default: not declared — Maximum loss (negative), or `null` when unbounded. - return.economics.maxProfit: number | null; default: not declared — Maximum profit, or `null` when unbounded. - return.economics.net: number; default: not declared — Net cash: `+` = debit paid, `−` = credit received (per contract). - return.economics.rewardToRisk: number | null; default: not declared — `|maxProfit / maxLoss|`, or `null` when undefined (an unbounded side or a zero max loss). - return.greeks?: { delta: number; gamma: number; rho: number; theta: number; vega: number; }; default: not declared - return.greeks.delta: number; default: not declared - return.greeks.gamma: number; default: not declared - return.greeks.rho: number; default: not declared - return.greeks.theta: number; default: not declared - return.greeks.vega: number; default: not declared - return.moveBias: MoveBias; default: not declared - return.name: string; default: not declared — The classification, or `'custom'`. - return.probability?: { expectedValue: number; probabilityOfProfit: number; }; default: not declared - return.probability.expectedValue: number; default: not declared - return.probability.probabilityOfProfit: number; default: not declared - return.risks: string[]; default: not declared - return.structure: string; default: not declared — Readable leg list, sorted by strike. - return.summary: string; default: not declared — The prose narrative composing all of the above. - return.timeBias?: TimeBias; default: not declared - return.volatilityBias?: VolatilityBias; default: not declared — Present when a market is available. ### @insiderfinance/totalfinance/strategy#guts Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const guts: (input: s.TwoStrikeInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.TwoStrikeInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#inverseCallBrokenWing Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inverseCallBrokenWing: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#inverseIronButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inverseIronButterfly: (input: s.IronButterflyInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.IronButterflyInput; default: not declared - (input).body: number | { callPremium?: number; putPremium?: number; strike: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - (input).body.callPremium?: number; default: not declared - (input).body.putPremium?: number; default: not declared - (input).body.strike: number; default: not declared - (input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#inverseIronCondor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inverseIronCondor: (input: b.IronCondorInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.IronCondorInput; default: not declared - (input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).expiry?: string; default: not declared - (input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#inversePutBrokenWing Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inversePutBrokenWing: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#ironButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ironButterfly: (input: s.IronButterflyInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.IronButterflyInput; default: not declared - (input).body: number | { callPremium?: number; putPremium?: number; strike: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - (input).body.callPremium?: number; default: not declared - (input).body.putPremium?: number; default: not declared - (input).body.strike: number; default: not declared - (input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#ironCondor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ironCondor: (input: b.IronCondorInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.IronCondorInput; default: not declared - (input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).expiry?: string; default: not declared - (input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#jadeLizard Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const jadeLizard: (input: s.JadeLizardInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.JadeLizardInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).longCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).shortCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#legs Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain leg records for custom strategies. No direction or size is inferred. ```typescript export declare const legs: { readonly call: (input: OptionLegInput) => OptionLegRow; readonly put: (input: OptionLegInput) => OptionLegRow; readonly stock: (input: StockLegInput) => StockLeg; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: (input: OptionLegInput) => OptionLegRow; default: not declared — Build a call leg. Signed quantity is in contracts; premium is per share. - call().return.expiry?: string; default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - call().return.impliedVolatility?: number; default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - call().return.kind: 'call' | 'put'; default: not declared - call().return.premium?: number; default: not declared - call().return.price?: undefined; default: not declared — Never on an option row (a stock row's entry price). - call().return.quantity: number; default: not declared — Signed contracts: positive = long, negative = short. - call().return.strike: number; default: not declared - call(input): OptionLegInput; default: not declared - call(input).expiry?: string; default: not declared — Per-leg expiry: a YYYY-MM-DD label (16:00 ET) or zoned ISO datetime. - call(input).impliedVolatility?: number; default: not declared — Positive per-leg implied volatility, as an annualized decimal (0.20 = 20%). - call(input).premium?: number | undefined; default: not declared — Entry premium per share. Omit it (or pass `undefined`) and supply `{ premiums: 'model', market }` on the position config to have it priced from the market. Accepts `undefined` explicitly so builders can forward an optional slot premium without a conditional spread. - call(input).quantity: number; default: not declared — Signed contracts: positive = long, negative = short. Required, finite and nonzero. - call(input).strike: number; default: not declared — Positive strike price per share. - put: (input: OptionLegInput) => OptionLegRow; default: not declared — Build a put leg. Signed quantity is in contracts; premium is per share. - put().return.expiry?: string; default: not declared — Optional per-leg expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). When omitted the leg uses the position-level expiry supplied to `value()`. Set it for multi-expiry structures (calendars, diagonals, double diagonals) so each leg is priced at its own time-to-expiry. - put().return.impliedVolatility?: number; default: not declared — Optional per-leg implied volatility (decimal, e.g. `0.28`). When set, `value()`/`chartData()`/ `scenarioTable()` price this leg at its own IV instead of the position-level `vol` — so a real chain (four distinct IVs on an iron condor) marks correctly. When omitted, the leg falls back to the position-level `vol`. The result's `assumptions.volatilitySource` reports which was used. - put().return.kind: 'call' | 'put'; default: not declared - put().return.premium?: number; default: not declared - put().return.price?: undefined; default: not declared — Never on an option row (a stock row's entry price). - put().return.quantity: number; default: not declared — Signed contracts: positive = long, negative = short. - put().return.strike: number; default: not declared - put(input): OptionLegInput; default: not declared - put(input).expiry?: string; default: not declared — Per-leg expiry: a YYYY-MM-DD label (16:00 ET) or zoned ISO datetime. - put(input).impliedVolatility?: number; default: not declared — Positive per-leg implied volatility, as an annualized decimal (0.20 = 20%). - put(input).premium?: number | undefined; default: not declared — Entry premium per share. Omit it (or pass `undefined`) and supply `{ premiums: 'model', market }` on the position config to have it priced from the market. Accepts `undefined` explicitly so builders can forward an optional slot premium without a conditional spread. - put(input).quantity: number; default: not declared — Signed contracts: positive = long, negative = short. Required, finite and nonzero. - put(input).strike: number; default: not declared — Positive strike price per share. - stock: (input: StockLegInput) => StockLeg; default: not declared — Build a stock leg. Signed quantity is in shares; price is the entry price per share. - stock().return.expiry?: undefined; default: not declared - stock().return.impliedVolatility?: undefined; default: not declared - stock().return.kind: 'stock'; default: not declared - stock().return.premium?: undefined; default: not declared - stock().return.price: number; default: not declared — Entry price per share. - stock().return.quantity: number; default: not declared — Signed shares: positive = long, negative = short. - stock().return.strike?: undefined; default: not declared — Never on a stock row (typed so a union read narrows to `undefined`, not to a fake 0). - stock(input): StockLegInput; default: not declared - stock(input).price: number; default: not declared — Entry price per share. - stock(input).quantity: number; default: not declared — Signed shares: positive = long, negative = short. Not scaled by the option multiplier. ### @insiderfinance/totalfinance/strategy#listStrategies Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every named builder: name, description, multi-expiry flag, and a canonical example input. ```typescript export declare function listStrategies(): StrategyDescriptor[]; ``` ### @insiderfinance/totalfinance/strategy#longCall Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longCall: (input: s.SingleLegInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SingleLegInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longCallButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longCallButterfly: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longCallCondor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longCallCondor: (input: s.CondorInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.CondorInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longCombo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longCombo: (input: s.TwoStrikeInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.TwoStrikeInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longPut Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longPut: (input: s.SingleLegInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SingleLegInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longPutButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longPutButterfly: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longPutCondor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longPutCondor: (input: s.CondorInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.CondorInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#longSyntheticFuture Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const longSyntheticFuture: (input: s.SyntheticInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SyntheticInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#optimizeStrategy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Search structures × strikes × expiries for the best trade under a thesis. Reuses `scanStrategies` per expiry, re-scores each candidate under the thesis density, and ranks across all expiries. See the spec. ```typescript export declare function optimizeStrategy(options: OptimizeStrategyOptions): OptimizeStrategyResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): OptimizeStrategyOptions; default: not declared - (options).asOf: string | number; default: not declared — Valuation instant — epoch milliseconds or a zoned ISO datetime, the ONE valuation-instant grammar shared with `scanStrategies`, `Position.probability()` and the what-if cube. A bare date is refused everywhere a position is priced: the time of day is the answer for a 0DTE. - (options).dividendYield?: number; default: not declared - (options).expiries: OptimizerExpiry[]; default: not declared — The multi-expiry search space (≥ 1 expiry). - (options).gridPoints?: number; default: not declared — Integration resolution for the thesis metrics (default 801). - (options).maxRisk?: number; default: not declared — Keep only candidates whose max loss ≤ this (per contract, 100×). - (options).maxWidth?: number; default: not declared - (options).minProbabilityOfProfit?: number; default: not declared — Keep only candidates whose MARKET-implied PoP ≥ this. - (options).minThesisProbabilityOfProfit?: number; default: not declared — Keep only candidates whose THESIS PoP ≥ this. - (options).objective?: OptimizerObjective; default: not declared — Ranking objective (default `'thesisExpectedValuePerRisk'`). - (options).riskFreeRate: number; default: not declared - (options).sizing?: OptimizerSizingOptions; default: not declared — Opt-in Kelly sizing. When set, each candidate gains a `kelly` verdict; omit for no Kelly work. - (options).smile?: (strike: number) => number; default: not declared — Default pricing smile (takes precedence over `volatility` for pricing). - (options).spot: number; default: not declared - (options).structures?: ScanStructure[]; default: not declared — Which structures to enumerate (default: all the scanner's). - (options).thesis: OptimizerThesis; default: not declared - (options).top?: number; default: not declared — Top-N across all expiries (default 25). - (options).volatility?: number; default: not declared — Default pricing volatility for missing premiums + the scanner's market-implied metrics. - return.assumptions: { conventionsVersion: string; expiries: number; gridPoints: number; objective: OptimizerObjective; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.expiries: number; default: not declared - return.assumptions.gridPoints: number; default: not declared - return.assumptions.objective: OptimizerObjective; default: not declared - return.candidates: OptimizedStrategy[]; default: not declared — Top-N candidates across all expiries, ranked by `objective` (descending). - return.diagnostics: Diagnostics; default: not declared - return.thesis: { drift?: number; median: 'target' | 'drift'; targetPrice?: number; volatility: number; }; default: not declared - return.thesis.drift?: number; default: not declared - return.thesis.median: 'drift' | 'target'; default: not declared - return.thesis.targetPrice?: number; default: not declared - return.thesis.volatility: number; default: not declared ### @insiderfinance/totalfinance/strategy#payoffSvg Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Render a {@link Position}'s payoff diagram as a self-contained `` string. See the spec. ```typescript export declare function payoffSvg(position: Position, options?: PayoffSvgOptions): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: PayoffSvgOptions; default: not declared - (options).height?: number; default: not declared — Height in px (default 360). - (options).includeCurrentPnl?: boolean; default: not declared — Also draw the CURRENT (pre-expiry) P&L curve (dashed); needs a market (or the position's own). - (options).market?: Partial>; default: not declared - (options).market.asOf?: string | number; default: not declared — Snapshot time. Epoch ms, or an ISO date/datetime string parsed at the boundary. - (options).market.dividendYield?: number; default: not declared - (options).market.expiry?: string; default: not declared - (options).market.legVolatilities?: readonly (number | undefined)[]; default: not declared — Per-leg volatility OVERRIDES for this call (Preview P1), aligned to `position.legs`: leg `i` prices at `legVolatilities[i]` when it is a number, else at its own `impliedVolatility`, else at the position-level `volatility` (`volatilityShock` still adds on top). This is how a mark from CURRENT contract quotes reaches a position whose legs were built with entry volatilities — the position stays immutable, the call states the market. `assumptions.volatilitySource` reports `'perCall'` when any override applied. - (options).market.riskFreeRate?: number; default: not declared - (options).market.volatility?: number; default: not declared — Position-level implied volatility. OPTIONAL: a position whose every option leg carries its own `iv` prices entirely per-leg and needs no position vol. It is required (and validated positive) only when at least one un-expired option leg has no per-leg `iv`; omitting it then throws. - (options).market.volatilityShock?: number; default: not declared — Additive volatility shock (decimal) applied to EVERY effective leg volatility — the per-leg `impliedVolatility` when a leg carries one, and the position-level `volatility` otherwise. This is what makes a volatility scenario reach per-leg-IV legs; without it, shocking only `volatility` is a silent no-op for legs that fix their own implied volatility. - (options).prices?: PriceRange; default: not declared — X-axis price range. Omit for an auto-range around the strikes + breakevens. - (options).spot?: number; default: not declared — Draw a marker at the current spot. - (options).theme?: 'light' | 'dark'; default: not declared — Color theme (default 'light'). - (options).title?: string; default: not declared — Chart title (XML-escaped). - (options).width?: number; default: not declared — Width in px (default 640). - (position): Position; default: not declared - (position).assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - (position).chartData: (options?: { prices?: number[] | PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - (position).constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - (position).legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - (position).market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - (position).market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - (position).market.dividendYield?: number; default: not declared - (position).market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - (position).market.riskFreeRate: number; default: not declared - (position).market.spot: number; default: not declared - (position).market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - (position).metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - (position).monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - (position).multiplier: number; default: not declared - (position).netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - (position).payoff: (options?: { prices?: number[] | PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - (position).pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - (position).premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - (position).premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - (position).probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - (position).scenarioTable: (options?: { market?: Partial>; prices?: number[] | PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - (position).value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - (position).whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#protectivePut Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const protectivePut: (input: s.StockOptionInput & s.StrikeLeg, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.StockOptionInput & s.StrikeLeg; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#putBrokenWing Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const putBrokenWing: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#putRatioBackspread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const putRatioBackspread: (input: s.RatioInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.RatioInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).ratio?: number; default: not declared — Number of short legs per long (default 2). - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#putRatioSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const putRatioSpread: (input: s.RatioInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.RatioInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).ratio?: number; default: not declared — Number of short legs per long (default 2). - (input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#reverseJadeLizard Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const reverseJadeLizard: (input: s.ReverseJadeLizardInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.ReverseJadeLizardInput; default: not declared - (input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).longPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).shortPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#scanStrategies Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Enumerate, score, and rank option structures over a strike grid. `candidates` carries the top-N by the chosen objective, each with the full payoff/probability metrics. ```typescript export declare function scanStrategies(options: ScanOptions): ScanResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): ScanOptions; default: not declared - (options).asOf: string | number; default: not declared — Valuation instant. Epoch ms or a zoned ISO datetime, resolved at the boundary by core's `resolveValuationAsOf` — the ONE valuation-instant grammar shared by `Position.probability()`, the what-if cube and every other pricing boundary. A bare date is refused: a 0DTE's value depends on the time of day. - (options).chain: ScanQuoteRow[]; default: not declared — The option chain — one row per strike, ascending or not (sorted internally). - (options).dividendYield?: number; default: not declared - (options).expiry: string; default: not declared — Option expiry (`YYYY-MM-DD` → 16:00 ET, or a full datetime). - (options).maxRisk?: number; default: not declared — Keep only candidates whose max loss ≤ this (in the position's P&L units — per contract, 100×). - (options).maxWidth?: number; default: not declared — Cap on the width (strike distance) of any single wing/spread, in price units. - (options).minProbabilityOfProfit?: number; default: not declared — Keep only candidates with probability-of-profit ≥ this. - (options).rankBy?: 'probabilityOfProfit' | 'expectedValue' | 'returnOnRisk' | 'expectedValuePerRisk'; default: not declared — Ranking objective (default `expectedValuePerRisk`). - (options).riskFreeRate: number; default: not declared - (options).smile?: (strike: number) => number; default: not declared — Per-strike implied-volatility smile. Used to price any missing per-strike premiums (takes precedence over `volatility`). **Scoring uses a SINGLE volatility:** `probabilityOfProfit` and `expectedValue` are computed closed-form at the at-spot volatility `smile(spot)` (or `volatility`), not the full smile — for smile-consistent probabilities, price a specific structure with `Position.monteCarloProbability({ localVolatility })`. - (options).spot: number; default: not declared — Underlying spot price (WS3.2: renamed from `underlyingPrice` for workspace consistency). - (options).structures?: ScanStructure[]; default: not declared — Which structures to enumerate (default: all). - (options).top?: number; default: not declared — Return only the top-N ranked candidates (default 25). - (options).volatility?: number; default: not declared — Constant annualized volatility used for probabilityOfProfit / expectedValue scoring and to price any missing premiums. - return.assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; rankBy: ScanObjective; scoringVolatility: number; structures: ScanStructure[]; timeToExpiryYears: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.dayCount: 'ACT/365F'; default: not declared - return.assumptions.rankBy: 'probabilityOfProfit' | 'expectedValue' | 'returnOnRisk' | 'expectedValuePerRisk'; default: not declared — The ranking objective that produced the order (and each candidate's `score`). - return.assumptions.scoringVolatility: number; default: not declared — The single at-spot volatility that `probabilityOfProfit`/`expectedValue` are scored at (see the `smile` doc). - return.assumptions.structures: ScanStructure[]; default: not declared — The structures that were enumerated. - return.assumptions.timeToExpiryYears: number; default: not declared — Year fraction to the scanned expiry. - return.candidates: ScanCandidate[]; default: not declared — The top-N candidates by the ranking objective, descending, each fully metric'd. - return.diagnostics: Diagnostics; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/strategy#shortCall Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortCall: (input: s.SingleLegInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SingleLegInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortCallButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortCallButterfly: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortCallCondor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortCallCondor: (input: s.CondorInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.CondorInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortCombo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortCombo: (input: s.TwoStrikeInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.TwoStrikeInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortGuts Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortGuts: (input: s.TwoStrikeInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.TwoStrikeInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortPut Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortPut: (input: s.SingleLegInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SingleLegInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortPutButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortPutButterfly: (input: s.LadderInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.LadderInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortPutCondor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortPutCondor: (input: s.CondorInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.CondorInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortStraddle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortStraddle: (input: s.ShortStraddleInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.ShortStraddleInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortStrangle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortStrangle: (input: s.ShortStrangleInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.ShortStrangleInput; default: not declared - (input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#shortSyntheticFuture Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const shortSyntheticFuture: (input: s.SyntheticInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SyntheticInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#straddle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const straddle: (input: b.StraddleInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.StraddleInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared - (input).strike: number; default: not declared — The shared strike (shared-strike rule: premiums are named per option type). - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#strangle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const strangle: (input: b.StrangleInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): b.StrangleInput; default: not declared - (input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The call leg: a strike, or `{ strike, premium? }`. - (input).expiry?: string; default: not declared - (input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The put leg: a strike, or `{ strike, premium? }`. - (input).quantity?: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#strap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const strap: (input: s.SyntheticInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SyntheticInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#strategy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const strategy: ((positionLegs: readonly LegInput[], config?: PositionConfig) => Position) & { bearCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bearCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bearPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bearPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; buildStrategy(request: manifest.BuildStrategyInput): Position; bullCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bullCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; bullPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; bullPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; calendarCallSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; calendarPutSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; callBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; callRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; callRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; cashSecuredPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; collar: (input: import('@insiderfinance/totalfinance/strategy').CollarInput, config?: PositionConfig) => Position; coveredCall: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; coveredShortStraddle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; coveredShortStrangle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; diagonalCallSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; diagonalPutSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; doubleDiagonal: (input: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput, config?: PositionConfig) => Position; guts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; inverseCallBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; inverseIronButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; inverseIronCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; inversePutBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; ironButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; ironCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; jadeLizard: (input: import('@insiderfinance/totalfinance/strategy').JadeLizardInput, config?: PositionConfig) => Position; listStrategies(): manifest.StrategyDescriptor[]; longCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; longCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; longCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; longCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; longPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; longPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; longPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; longSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; protectivePut: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; putBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; putRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; putRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; reverseJadeLizard: (input: import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput, config?: PositionConfig) => Position; shortCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; shortCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; shortCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; shortCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; shortGuts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; shortPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; shortPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; shortPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; shortStraddle: (input: import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; shortStrangle: (input: import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; shortSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; straddle: (input: import('@insiderfinance/totalfinance/strategy').StraddleInput, config?: PositionConfig) => Position; strangle: (input: import('@insiderfinance/totalfinance/strategy').StrangleInput, config?: PositionConfig) => Position; strap: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; strip: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; syntheticPut: (input: import('@insiderfinance/totalfinance/strategy').SyntheticPutInput, config?: PositionConfig) => Position; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (positionLegs): readonly LegInput[]; default: not declared - bearCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bearCallLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearCallLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearCallLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearCallLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearCallLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearCallLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearCallLadder().return.market.dividendYield?: number; default: not declared - bearCallLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearCallLadder().return.market.riskFreeRate: number; default: not declared - bearCallLadder().return.market.spot: number; default: not declared - bearCallLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearCallLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearCallLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearCallLadder().return.multiplier: number; default: not declared - bearCallLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearCallLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearCallLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearCallLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearCallLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearCallLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearCallLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearCallLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearCallLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearCallLadder(config)?: PositionConfig | undefined; default: not declared - bearCallLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearCallLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearCallLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearCallLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearCallLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bearCallLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bearCallLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearCallLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearCallLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bearCallLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bearCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearCallSpread().return.market.dividendYield?: number; default: not declared - bearCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearCallSpread().return.market.riskFreeRate: number; default: not declared - bearCallSpread().return.market.spot: number; default: not declared - bearCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearCallSpread().return.multiplier: number; default: not declared - bearCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearCallSpread(config)?: PositionConfig | undefined; default: not declared - bearCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearCallSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bearCallSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bearCallSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bearCallSpread(input).quantity?: number; default: not declared - bearCallSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - bearPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bearPutLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearPutLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearPutLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearPutLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearPutLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearPutLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearPutLadder().return.market.dividendYield?: number; default: not declared - bearPutLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearPutLadder().return.market.riskFreeRate: number; default: not declared - bearPutLadder().return.market.spot: number; default: not declared - bearPutLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearPutLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearPutLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearPutLadder().return.multiplier: number; default: not declared - bearPutLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearPutLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearPutLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearPutLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearPutLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearPutLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearPutLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearPutLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearPutLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearPutLadder(config)?: PositionConfig | undefined; default: not declared - bearPutLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearPutLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearPutLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearPutLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearPutLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bearPutLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bearPutLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearPutLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearPutLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bearPutLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bearPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bearPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bearPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bearPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bearPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bearPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bearPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bearPutSpread().return.market.dividendYield?: number; default: not declared - bearPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bearPutSpread().return.market.riskFreeRate: number; default: not declared - bearPutSpread().return.market.spot: number; default: not declared - bearPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bearPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bearPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bearPutSpread().return.multiplier: number; default: not declared - bearPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bearPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bearPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bearPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bearPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bearPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bearPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bearPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bearPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bearPutSpread(config)?: PositionConfig | undefined; default: not declared - bearPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bearPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bearPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bearPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bearPutSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bearPutSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bearPutSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bearPutSpread(input).quantity?: number; default: not declared - bearPutSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - buildStrategy: (request: manifest.BuildStrategyInput) => Position; default: not declared - buildStrategy().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - buildStrategy().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - buildStrategy().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - buildStrategy().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - buildStrategy().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - buildStrategy().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - buildStrategy().return.market.dividendYield?: number; default: not declared - buildStrategy().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - buildStrategy().return.market.riskFreeRate: number; default: not declared - buildStrategy().return.market.spot: number; default: not declared - buildStrategy().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - buildStrategy().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - buildStrategy().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - buildStrategy().return.multiplier: number; default: not declared - buildStrategy().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - buildStrategy().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - buildStrategy().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - buildStrategy().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - buildStrategy().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - buildStrategy().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - buildStrategy().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - buildStrategy().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - buildStrategy().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - buildStrategy(request): manifest.BuildStrategyInput; default: not declared - buildStrategy(request).config?: PositionConfig; default: not declared — Optional position construction and model-premium configuration. - buildStrategy(request).input: Record; default: not declared — Builder-specific strategy fields; inspect the matching descriptor's `exampleInput`. - buildStrategy(request).name: string; default: not declared — The exact strategy name returned by {@link listStrategies}. - bullCallLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bullCallLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullCallLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullCallLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullCallLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullCallLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullCallLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullCallLadder().return.market.dividendYield?: number; default: not declared - bullCallLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullCallLadder().return.market.riskFreeRate: number; default: not declared - bullCallLadder().return.market.spot: number; default: not declared - bullCallLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullCallLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullCallLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullCallLadder().return.multiplier: number; default: not declared - bullCallLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullCallLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullCallLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullCallLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullCallLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullCallLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullCallLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullCallLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullCallLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullCallLadder(config)?: PositionConfig | undefined; default: not declared - bullCallLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullCallLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullCallLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullCallLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullCallLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bullCallLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bullCallLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullCallLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullCallLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bullCallLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullCallSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bullCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullCallSpread().return.market.dividendYield?: number; default: not declared - bullCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullCallSpread().return.market.riskFreeRate: number; default: not declared - bullCallSpread().return.market.spot: number; default: not declared - bullCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullCallSpread().return.multiplier: number; default: not declared - bullCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullCallSpread(config)?: PositionConfig | undefined; default: not declared - bullCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullCallSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bullCallSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bullCallSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bullCallSpread(input).quantity?: number; default: not declared - bullCallSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - bullPutLadder: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - bullPutLadder().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullPutLadder().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullPutLadder().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullPutLadder().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullPutLadder().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullPutLadder().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullPutLadder().return.market.dividendYield?: number; default: not declared - bullPutLadder().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullPutLadder().return.market.riskFreeRate: number; default: not declared - bullPutLadder().return.market.spot: number; default: not declared - bullPutLadder().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullPutLadder().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullPutLadder().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullPutLadder().return.multiplier: number; default: not declared - bullPutLadder().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullPutLadder().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullPutLadder().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullPutLadder().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullPutLadder().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullPutLadder().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullPutLadder().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullPutLadder().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullPutLadder().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullPutLadder(config)?: PositionConfig | undefined; default: not declared - bullPutLadder(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullPutLadder(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullPutLadder(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullPutLadder(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullPutLadder(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - bullPutLadder(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - bullPutLadder(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullPutLadder(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullPutLadder(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - bullPutLadder(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - bullPutSpread: (input: import('@insiderfinance/totalfinance/strategy').VerticalInput, config?: PositionConfig) => Position; default: not declared - bullPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - bullPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - bullPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - bullPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - bullPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - bullPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - bullPutSpread().return.market.dividendYield?: number; default: not declared - bullPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - bullPutSpread().return.market.riskFreeRate: number; default: not declared - bullPutSpread().return.market.spot: number; default: not declared - bullPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - bullPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - bullPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - bullPutSpread().return.multiplier: number; default: not declared - bullPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - bullPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - bullPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - bullPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - bullPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - bullPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - bullPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - bullPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - bullPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - bullPutSpread(config)?: PositionConfig | undefined; default: not declared - bullPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - bullPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - bullPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - bullPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - bullPutSpread(input): import('@insiderfinance/totalfinance/strategy').VerticalInput; default: not declared - bullPutSpread(input).expiry?: string; default: not declared — Expiry applied to both legs (R4). - bullPutSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The bought leg: a strike, or `{ strike, premium? }`. - bullPutSpread(input).quantity?: number; default: not declared - bullPutSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold leg: a strike, or `{ strike, premium? }`. - calendarCallSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; default: not declared - calendarCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - calendarCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - calendarCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - calendarCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - calendarCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - calendarCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - calendarCallSpread().return.market.dividendYield?: number; default: not declared - calendarCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - calendarCallSpread().return.market.riskFreeRate: number; default: not declared - calendarCallSpread().return.market.spot: number; default: not declared - calendarCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - calendarCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - calendarCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - calendarCallSpread().return.multiplier: number; default: not declared - calendarCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - calendarCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - calendarCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - calendarCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - calendarCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - calendarCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - calendarCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - calendarCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - calendarCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - calendarCallSpread(config)?: PositionConfig | undefined; default: not declared - calendarCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - calendarCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - calendarCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - calendarCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - calendarCallSpread(input): import('@insiderfinance/totalfinance/strategy').CalendarInput; default: not declared - calendarCallSpread(input).farExpiry: string; default: not declared — Far expiry of the long leg. - calendarCallSpread(input).longPremium?: number; default: not declared — Premium paid on the long far leg. - calendarCallSpread(input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - calendarCallSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - calendarCallSpread(input).shortPremium?: number; default: not declared — Premium received on the short near leg. - calendarCallSpread(input).strike: number; default: not declared - calendarPutSpread: (input: import('@insiderfinance/totalfinance/strategy').CalendarInput, config?: PositionConfig) => Position; default: not declared - calendarPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - calendarPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - calendarPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - calendarPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - calendarPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - calendarPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - calendarPutSpread().return.market.dividendYield?: number; default: not declared - calendarPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - calendarPutSpread().return.market.riskFreeRate: number; default: not declared - calendarPutSpread().return.market.spot: number; default: not declared - calendarPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - calendarPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - calendarPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - calendarPutSpread().return.multiplier: number; default: not declared - calendarPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - calendarPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - calendarPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - calendarPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - calendarPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - calendarPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - calendarPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - calendarPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - calendarPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - calendarPutSpread(config)?: PositionConfig | undefined; default: not declared - calendarPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - calendarPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - calendarPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - calendarPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - calendarPutSpread(input): import('@insiderfinance/totalfinance/strategy').CalendarInput; default: not declared - calendarPutSpread(input).farExpiry: string; default: not declared — Far expiry of the long leg. - calendarPutSpread(input).longPremium?: number; default: not declared — Premium paid on the long far leg. - calendarPutSpread(input).nearExpiry: string; default: not declared — Near expiry of the short leg (`YYYY-MM-DD` → 16:00 ET, or a datetime). - calendarPutSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - calendarPutSpread(input).shortPremium?: number; default: not declared — Premium received on the short near leg. - calendarPutSpread(input).strike: number; default: not declared - callBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - callBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - callBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - callBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - callBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - callBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - callBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - callBrokenWing().return.market.dividendYield?: number; default: not declared - callBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - callBrokenWing().return.market.riskFreeRate: number; default: not declared - callBrokenWing().return.market.spot: number; default: not declared - callBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - callBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - callBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - callBrokenWing().return.multiplier: number; default: not declared - callBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - callBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - callBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - callBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - callBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - callBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - callBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - callBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - callBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - callBrokenWing(config)?: PositionConfig | undefined; default: not declared - callBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - callBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - callBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - callBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - callBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - callBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - callBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - callBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - callRatioBackspread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - callRatioBackspread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - callRatioBackspread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - callRatioBackspread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - callRatioBackspread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - callRatioBackspread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - callRatioBackspread().return.market.dividendYield?: number; default: not declared - callRatioBackspread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - callRatioBackspread().return.market.riskFreeRate: number; default: not declared - callRatioBackspread().return.market.spot: number; default: not declared - callRatioBackspread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - callRatioBackspread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - callRatioBackspread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - callRatioBackspread().return.multiplier: number; default: not declared - callRatioBackspread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - callRatioBackspread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - callRatioBackspread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - callRatioBackspread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - callRatioBackspread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - callRatioBackspread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - callRatioBackspread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - callRatioBackspread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - callRatioBackspread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - callRatioBackspread(config)?: PositionConfig | undefined; default: not declared - callRatioBackspread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - callRatioBackspread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - callRatioBackspread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - callRatioBackspread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - callRatioBackspread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - callRatioBackspread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - callRatioBackspread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioBackspread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - callRatioBackspread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - callRatioBackspread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - callRatioSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - callRatioSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - callRatioSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - callRatioSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - callRatioSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - callRatioSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - callRatioSpread().return.market.dividendYield?: number; default: not declared - callRatioSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - callRatioSpread().return.market.riskFreeRate: number; default: not declared - callRatioSpread().return.market.spot: number; default: not declared - callRatioSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - callRatioSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - callRatioSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - callRatioSpread().return.multiplier: number; default: not declared - callRatioSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - callRatioSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - callRatioSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - callRatioSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - callRatioSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - callRatioSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - callRatioSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - callRatioSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - callRatioSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - callRatioSpread(config)?: PositionConfig | undefined; default: not declared - callRatioSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - callRatioSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - callRatioSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - callRatioSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - callRatioSpread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - callRatioSpread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - callRatioSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - callRatioSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - callRatioSpread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - callRatioSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - cashSecuredPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - cashSecuredPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - cashSecuredPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - cashSecuredPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - cashSecuredPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - cashSecuredPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - cashSecuredPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - cashSecuredPut().return.market.dividendYield?: number; default: not declared - cashSecuredPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - cashSecuredPut().return.market.riskFreeRate: number; default: not declared - cashSecuredPut().return.market.spot: number; default: not declared - cashSecuredPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - cashSecuredPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - cashSecuredPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - cashSecuredPut().return.multiplier: number; default: not declared - cashSecuredPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - cashSecuredPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - cashSecuredPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - cashSecuredPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - cashSecuredPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - cashSecuredPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - cashSecuredPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - cashSecuredPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - cashSecuredPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - cashSecuredPut(config)?: PositionConfig | undefined; default: not declared - cashSecuredPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - cashSecuredPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - cashSecuredPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - cashSecuredPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - cashSecuredPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - cashSecuredPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - cashSecuredPut(input).premium?: number; default: not declared - cashSecuredPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - cashSecuredPut(input).strike: number; default: not declared - collar: (input: import('@insiderfinance/totalfinance/strategy').CollarInput, config?: PositionConfig) => Position; default: not declared - collar().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - collar().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - collar().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - collar().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - collar().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - collar().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - collar().return.market.dividendYield?: number; default: not declared - collar().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - collar().return.market.riskFreeRate: number; default: not declared - collar().return.market.spot: number; default: not declared - collar().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - collar().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - collar().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - collar().return.multiplier: number; default: not declared - collar().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - collar().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - collar().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - collar().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - collar().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - collar().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - collar().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - collar().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - collar().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - collar(config)?: PositionConfig | undefined; default: not declared - collar(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - collar(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - collar(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - collar(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - collar(input): import('@insiderfinance/totalfinance/strategy').CollarInput; default: not declared - collar(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - collar(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - collar(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - collar(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - collar(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - coveredCall: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; default: not declared - coveredCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - coveredCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - coveredCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - coveredCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - coveredCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - coveredCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - coveredCall().return.market.dividendYield?: number; default: not declared - coveredCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - coveredCall().return.market.riskFreeRate: number; default: not declared - coveredCall().return.market.spot: number; default: not declared - coveredCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - coveredCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - coveredCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - coveredCall().return.multiplier: number; default: not declared - coveredCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - coveredCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - coveredCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - coveredCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - coveredCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - coveredCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - coveredCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - coveredCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - coveredCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - coveredCall(config)?: PositionConfig | undefined; default: not declared - coveredCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - coveredCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - coveredCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - coveredCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - coveredCall(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg; default: not declared - coveredCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - coveredCall(input).premium?: number; default: not declared - coveredCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - coveredCall(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - coveredCall(input).strike: number; default: not declared - coveredShortStraddle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; default: not declared - coveredShortStraddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - coveredShortStraddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - coveredShortStraddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - coveredShortStraddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - coveredShortStraddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - coveredShortStraddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - coveredShortStraddle().return.market.dividendYield?: number; default: not declared - coveredShortStraddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - coveredShortStraddle().return.market.riskFreeRate: number; default: not declared - coveredShortStraddle().return.market.spot: number; default: not declared - coveredShortStraddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - coveredShortStraddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - coveredShortStraddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - coveredShortStraddle().return.multiplier: number; default: not declared - coveredShortStraddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - coveredShortStraddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - coveredShortStraddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - coveredShortStraddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - coveredShortStraddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - coveredShortStraddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - coveredShortStraddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - coveredShortStraddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - coveredShortStraddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - coveredShortStraddle(config)?: PositionConfig | undefined; default: not declared - coveredShortStraddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - coveredShortStraddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - coveredShortStraddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - coveredShortStraddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - coveredShortStraddle(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStraddleInput; default: not declared - coveredShortStraddle(input).callPremium?: number; default: not declared - coveredShortStraddle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - coveredShortStraddle(input).putPremium?: number; default: not declared - coveredShortStraddle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - coveredShortStraddle(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - coveredShortStraddle(input).strike: number; default: not declared - coveredShortStrangle: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; default: not declared - coveredShortStrangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - coveredShortStrangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - coveredShortStrangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - coveredShortStrangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - coveredShortStrangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - coveredShortStrangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - coveredShortStrangle().return.market.dividendYield?: number; default: not declared - coveredShortStrangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - coveredShortStrangle().return.market.riskFreeRate: number; default: not declared - coveredShortStrangle().return.market.spot: number; default: not declared - coveredShortStrangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - coveredShortStrangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - coveredShortStrangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - coveredShortStrangle().return.multiplier: number; default: not declared - coveredShortStrangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - coveredShortStrangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - coveredShortStrangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - coveredShortStrangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - coveredShortStrangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - coveredShortStrangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - coveredShortStrangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - coveredShortStrangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - coveredShortStrangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - coveredShortStrangle(config)?: PositionConfig | undefined; default: not declared - coveredShortStrangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - coveredShortStrangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - coveredShortStrangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - coveredShortStrangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - coveredShortStrangle(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').ShortStrangleInput; default: not declared - coveredShortStrangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - coveredShortStrangle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - coveredShortStrangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - coveredShortStrangle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - coveredShortStrangle(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - diagonalCallSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; default: not declared - diagonalCallSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - diagonalCallSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - diagonalCallSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - diagonalCallSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - diagonalCallSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - diagonalCallSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - diagonalCallSpread().return.market.dividendYield?: number; default: not declared - diagonalCallSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - diagonalCallSpread().return.market.riskFreeRate: number; default: not declared - diagonalCallSpread().return.market.spot: number; default: not declared - diagonalCallSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - diagonalCallSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - diagonalCallSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - diagonalCallSpread().return.multiplier: number; default: not declared - diagonalCallSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - diagonalCallSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - diagonalCallSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - diagonalCallSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - diagonalCallSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - diagonalCallSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - diagonalCallSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - diagonalCallSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - diagonalCallSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - diagonalCallSpread(config)?: PositionConfig | undefined; default: not declared - diagonalCallSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - diagonalCallSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - diagonalCallSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - diagonalCallSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - diagonalCallSpread(input): import('@insiderfinance/totalfinance/strategy').DiagonalInput; default: not declared - diagonalCallSpread(input).farExpiry: string; default: not declared - diagonalCallSpread(input).longPremium?: number; default: not declared - diagonalCallSpread(input).longStrike: number; default: not declared - diagonalCallSpread(input).nearExpiry: string; default: not declared - diagonalCallSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - diagonalCallSpread(input).shortPremium?: number; default: not declared - diagonalCallSpread(input).shortStrike: number; default: not declared - diagonalPutSpread: (input: import('@insiderfinance/totalfinance/strategy').DiagonalInput, config?: PositionConfig) => Position; default: not declared - diagonalPutSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - diagonalPutSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - diagonalPutSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - diagonalPutSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - diagonalPutSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - diagonalPutSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - diagonalPutSpread().return.market.dividendYield?: number; default: not declared - diagonalPutSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - diagonalPutSpread().return.market.riskFreeRate: number; default: not declared - diagonalPutSpread().return.market.spot: number; default: not declared - diagonalPutSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - diagonalPutSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - diagonalPutSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - diagonalPutSpread().return.multiplier: number; default: not declared - diagonalPutSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - diagonalPutSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - diagonalPutSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - diagonalPutSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - diagonalPutSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - diagonalPutSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - diagonalPutSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - diagonalPutSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - diagonalPutSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - diagonalPutSpread(config)?: PositionConfig | undefined; default: not declared - diagonalPutSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - diagonalPutSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - diagonalPutSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - diagonalPutSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - diagonalPutSpread(input): import('@insiderfinance/totalfinance/strategy').DiagonalInput; default: not declared - diagonalPutSpread(input).farExpiry: string; default: not declared - diagonalPutSpread(input).longPremium?: number; default: not declared - diagonalPutSpread(input).longStrike: number; default: not declared - diagonalPutSpread(input).nearExpiry: string; default: not declared - diagonalPutSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - diagonalPutSpread(input).shortPremium?: number; default: not declared - diagonalPutSpread(input).shortStrike: number; default: not declared - doubleDiagonal: (input: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput, config?: PositionConfig) => Position; default: not declared - doubleDiagonal().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - doubleDiagonal().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - doubleDiagonal().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - doubleDiagonal().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - doubleDiagonal().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - doubleDiagonal().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - doubleDiagonal().return.market.dividendYield?: number; default: not declared - doubleDiagonal().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - doubleDiagonal().return.market.riskFreeRate: number; default: not declared - doubleDiagonal().return.market.spot: number; default: not declared - doubleDiagonal().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - doubleDiagonal().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - doubleDiagonal().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - doubleDiagonal().return.multiplier: number; default: not declared - doubleDiagonal().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - doubleDiagonal().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - doubleDiagonal().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - doubleDiagonal().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - doubleDiagonal().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - doubleDiagonal().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - doubleDiagonal().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - doubleDiagonal().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - doubleDiagonal().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - doubleDiagonal(config)?: PositionConfig | undefined; default: not declared - doubleDiagonal(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - doubleDiagonal(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - doubleDiagonal(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - doubleDiagonal(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - doubleDiagonal(input): import('@insiderfinance/totalfinance/strategy').DoubleDiagonalInput; default: not declared - doubleDiagonal(input).call: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalSide; default: not declared - doubleDiagonal(input).farExpiry: string; default: not declared - doubleDiagonal(input).nearExpiry: string; default: not declared - doubleDiagonal(input).put: import('@insiderfinance/totalfinance/strategy').DoubleDiagonalSide; default: not declared - doubleDiagonal(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - guts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - guts().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - guts().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - guts().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - guts().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - guts().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - guts().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - guts().return.market.dividendYield?: number; default: not declared - guts().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - guts().return.market.riskFreeRate: number; default: not declared - guts().return.market.spot: number; default: not declared - guts().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - guts().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - guts().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - guts().return.multiplier: number; default: not declared - guts().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - guts().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - guts().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - guts().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - guts().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - guts().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - guts().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - guts().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - guts().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - guts(config)?: PositionConfig | undefined; default: not declared - guts(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - guts(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - guts(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - guts(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - guts(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - guts(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - guts(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - guts(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - guts(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseCallBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - inverseCallBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inverseCallBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inverseCallBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inverseCallBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inverseCallBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inverseCallBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inverseCallBrokenWing().return.market.dividendYield?: number; default: not declared - inverseCallBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inverseCallBrokenWing().return.market.riskFreeRate: number; default: not declared - inverseCallBrokenWing().return.market.spot: number; default: not declared - inverseCallBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inverseCallBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inverseCallBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inverseCallBrokenWing().return.multiplier: number; default: not declared - inverseCallBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inverseCallBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inverseCallBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inverseCallBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inverseCallBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inverseCallBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inverseCallBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inverseCallBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inverseCallBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inverseCallBrokenWing(config)?: PositionConfig | undefined; default: not declared - inverseCallBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inverseCallBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inverseCallBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inverseCallBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inverseCallBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - inverseCallBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - inverseCallBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseCallBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseCallBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - inverseCallBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; default: not declared - inverseIronButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inverseIronButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inverseIronButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inverseIronButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inverseIronButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inverseIronButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inverseIronButterfly().return.market.dividendYield?: number; default: not declared - inverseIronButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inverseIronButterfly().return.market.riskFreeRate: number; default: not declared - inverseIronButterfly().return.market.spot: number; default: not declared - inverseIronButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inverseIronButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inverseIronButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inverseIronButterfly().return.multiplier: number; default: not declared - inverseIronButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inverseIronButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inverseIronButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inverseIronButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inverseIronButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inverseIronButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inverseIronButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inverseIronButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inverseIronButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inverseIronButterfly(config)?: PositionConfig | undefined; default: not declared - inverseIronButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inverseIronButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inverseIronButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inverseIronButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inverseIronButterfly(input): import('@insiderfinance/totalfinance/strategy').IronButterflyInput; default: not declared - inverseIronButterfly(input).body: number | { callPremium?: number; putPremium?: number; strike: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - inverseIronButterfly(input).body.callPremium?: number; default: not declared - inverseIronButterfly(input).body.putPremium?: number; default: not declared - inverseIronButterfly(input).body.strike: number; default: not declared - inverseIronButterfly(input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - inverseIronButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - inverseIronButterfly(input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - inverseIronButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - inverseIronCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; default: not declared - inverseIronCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inverseIronCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inverseIronCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inverseIronCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inverseIronCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inverseIronCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inverseIronCondor().return.market.dividendYield?: number; default: not declared - inverseIronCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inverseIronCondor().return.market.riskFreeRate: number; default: not declared - inverseIronCondor().return.market.spot: number; default: not declared - inverseIronCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inverseIronCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inverseIronCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inverseIronCondor().return.multiplier: number; default: not declared - inverseIronCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inverseIronCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inverseIronCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inverseIronCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inverseIronCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inverseIronCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inverseIronCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inverseIronCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inverseIronCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inverseIronCondor(config)?: PositionConfig | undefined; default: not declared - inverseIronCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inverseIronCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inverseIronCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inverseIronCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inverseIronCondor(input): import('@insiderfinance/totalfinance/strategy').IronCondorInput; default: not declared - inverseIronCondor(input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).expiry?: string; default: not declared - inverseIronCondor(input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inverseIronCondor(input).quantity?: number; default: not declared - inversePutBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - inversePutBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - inversePutBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - inversePutBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - inversePutBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - inversePutBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - inversePutBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - inversePutBrokenWing().return.market.dividendYield?: number; default: not declared - inversePutBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - inversePutBrokenWing().return.market.riskFreeRate: number; default: not declared - inversePutBrokenWing().return.market.spot: number; default: not declared - inversePutBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - inversePutBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - inversePutBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - inversePutBrokenWing().return.multiplier: number; default: not declared - inversePutBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - inversePutBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - inversePutBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - inversePutBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - inversePutBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - inversePutBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - inversePutBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - inversePutBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - inversePutBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - inversePutBrokenWing(config)?: PositionConfig | undefined; default: not declared - inversePutBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - inversePutBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - inversePutBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - inversePutBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - inversePutBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - inversePutBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - inversePutBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inversePutBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - inversePutBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - inversePutBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironButterfly: (input: import('@insiderfinance/totalfinance/strategy').IronButterflyInput, config?: PositionConfig) => Position; default: not declared - ironButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - ironButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - ironButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - ironButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - ironButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - ironButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - ironButterfly().return.market.dividendYield?: number; default: not declared - ironButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - ironButterfly().return.market.riskFreeRate: number; default: not declared - ironButterfly().return.market.spot: number; default: not declared - ironButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - ironButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - ironButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - ironButterfly().return.multiplier: number; default: not declared - ironButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - ironButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - ironButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - ironButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - ironButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - ironButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - ironButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - ironButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - ironButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - ironButterfly(config)?: PositionConfig | undefined; default: not declared - ironButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - ironButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - ironButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - ironButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - ironButterfly(input): import('@insiderfinance/totalfinance/strategy').IronButterflyInput; default: not declared - ironButterfly(input).body: number | { callPremium?: number; putPremium?: number; strike: number; }; default: not declared — ATM body (shared-strike rule): the strike sold twice, with per-type premiums. A bare strike number is shorthand for `{ strike }` (R3). - ironButterfly(input).body.callPremium?: number; default: not declared - ironButterfly(input).body.putPremium?: number; default: not declared - ironButterfly(input).body.strike: number; default: not declared - ironButterfly(input).callWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long call wing above the body. - ironButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - ironButterfly(input).putWing: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — Long put wing below the body. - ironButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - ironCondor: (input: import('@insiderfinance/totalfinance/strategy').IronCondorInput, config?: PositionConfig) => Position; default: not declared - ironCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - ironCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - ironCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - ironCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - ironCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - ironCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - ironCondor().return.market.dividendYield?: number; default: not declared - ironCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - ironCondor().return.market.riskFreeRate: number; default: not declared - ironCondor().return.market.spot: number; default: not declared - ironCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - ironCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - ironCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - ironCondor().return.multiplier: number; default: not declared - ironCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - ironCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - ironCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - ironCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - ironCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - ironCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - ironCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - ironCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - ironCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - ironCondor(config)?: PositionConfig | undefined; default: not declared - ironCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - ironCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - ironCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - ironCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - ironCondor(input): import('@insiderfinance/totalfinance/strategy').IronCondorInput; default: not declared - ironCondor(input).callLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).callShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).expiry?: string; default: not declared - ironCondor(input).putLong: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).putShort: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - ironCondor(input).quantity?: number; default: not declared - jadeLizard: (input: import('@insiderfinance/totalfinance/strategy').JadeLizardInput, config?: PositionConfig) => Position; default: not declared - jadeLizard().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - jadeLizard().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - jadeLizard().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - jadeLizard().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - jadeLizard().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - jadeLizard().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - jadeLizard().return.market.dividendYield?: number; default: not declared - jadeLizard().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - jadeLizard().return.market.riskFreeRate: number; default: not declared - jadeLizard().return.market.spot: number; default: not declared - jadeLizard().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - jadeLizard().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - jadeLizard().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - jadeLizard().return.multiplier: number; default: not declared - jadeLizard().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - jadeLizard().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - jadeLizard().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - jadeLizard().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - jadeLizard().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - jadeLizard().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - jadeLizard().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - jadeLizard().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - jadeLizard().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - jadeLizard(config)?: PositionConfig | undefined; default: not declared - jadeLizard(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - jadeLizard(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - jadeLizard(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - jadeLizard(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - jadeLizard(input): import('@insiderfinance/totalfinance/strategy').JadeLizardInput; default: not declared - jadeLizard(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - jadeLizard(input).longCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - jadeLizard(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - jadeLizard(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - jadeLizard(input).shortCall: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - listStrategies: () => manifest.StrategyDescriptor[]; default: not declared — Every named builder: name, description, multi-expiry flag, and a canonical example input. - longCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - longCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCall().return.market.dividendYield?: number; default: not declared - longCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCall().return.market.riskFreeRate: number; default: not declared - longCall().return.market.spot: number; default: not declared - longCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCall().return.multiplier: number; default: not declared - longCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCall(config)?: PositionConfig | undefined; default: not declared - longCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCall(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - longCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCall(input).premium?: number; default: not declared - longCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCall(input).strike: number; default: not declared - longCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - longCallButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCallButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCallButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCallButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCallButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCallButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCallButterfly().return.market.dividendYield?: number; default: not declared - longCallButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCallButterfly().return.market.riskFreeRate: number; default: not declared - longCallButterfly().return.market.spot: number; default: not declared - longCallButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCallButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCallButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCallButterfly().return.multiplier: number; default: not declared - longCallButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCallButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCallButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCallButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCallButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCallButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCallButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCallButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCallButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCallButterfly(config)?: PositionConfig | undefined; default: not declared - longCallButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCallButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCallButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCallButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCallButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - longCallButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCallButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCallButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - longCallCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCallCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCallCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCallCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCallCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCallCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCallCondor().return.market.dividendYield?: number; default: not declared - longCallCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCallCondor().return.market.riskFreeRate: number; default: not declared - longCallCondor().return.market.spot: number; default: not declared - longCallCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCallCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCallCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCallCondor().return.multiplier: number; default: not declared - longCallCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCallCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCallCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCallCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCallCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCallCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCallCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCallCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCallCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCallCondor(config)?: PositionConfig | undefined; default: not declared - longCallCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCallCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCallCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCallCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCallCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - longCallCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCallCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCallCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - longCombo().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longCombo().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longCombo().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longCombo().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longCombo().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longCombo().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longCombo().return.market.dividendYield?: number; default: not declared - longCombo().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longCombo().return.market.riskFreeRate: number; default: not declared - longCombo().return.market.spot: number; default: not declared - longCombo().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longCombo().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longCombo().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longCombo().return.multiplier: number; default: not declared - longCombo().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longCombo().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longCombo().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longCombo().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longCombo().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longCombo().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longCombo().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longCombo().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longCombo().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longCombo(config)?: PositionConfig | undefined; default: not declared - longCombo(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longCombo(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longCombo(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longCombo(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longCombo(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - longCombo(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longCombo(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longCombo(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longCombo(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - longPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longPut().return.market.dividendYield?: number; default: not declared - longPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longPut().return.market.riskFreeRate: number; default: not declared - longPut().return.market.spot: number; default: not declared - longPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longPut().return.multiplier: number; default: not declared - longPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longPut(config)?: PositionConfig | undefined; default: not declared - longPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - longPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPut(input).premium?: number; default: not declared - longPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longPut(input).strike: number; default: not declared - longPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - longPutButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longPutButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longPutButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longPutButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longPutButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longPutButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longPutButterfly().return.market.dividendYield?: number; default: not declared - longPutButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longPutButterfly().return.market.riskFreeRate: number; default: not declared - longPutButterfly().return.market.spot: number; default: not declared - longPutButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longPutButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longPutButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longPutButterfly().return.multiplier: number; default: not declared - longPutButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longPutButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longPutButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longPutButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longPutButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longPutButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longPutButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longPutButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longPutButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longPutButterfly(config)?: PositionConfig | undefined; default: not declared - longPutButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longPutButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longPutButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longPutButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longPutButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - longPutButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPutButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longPutButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - longPutCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longPutCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longPutCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longPutCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longPutCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longPutCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longPutCondor().return.market.dividendYield?: number; default: not declared - longPutCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longPutCondor().return.market.riskFreeRate: number; default: not declared - longPutCondor().return.market.spot: number; default: not declared - longPutCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longPutCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longPutCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longPutCondor().return.multiplier: number; default: not declared - longPutCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longPutCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longPutCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longPutCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longPutCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longPutCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longPutCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longPutCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longPutCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longPutCondor(config)?: PositionConfig | undefined; default: not declared - longPutCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longPutCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longPutCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longPutCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longPutCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - longPutCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longPutCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - longPutCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - longSyntheticFuture().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - longSyntheticFuture().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - longSyntheticFuture().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - longSyntheticFuture().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - longSyntheticFuture().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - longSyntheticFuture().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - longSyntheticFuture().return.market.dividendYield?: number; default: not declared - longSyntheticFuture().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - longSyntheticFuture().return.market.riskFreeRate: number; default: not declared - longSyntheticFuture().return.market.spot: number; default: not declared - longSyntheticFuture().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - longSyntheticFuture().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - longSyntheticFuture().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - longSyntheticFuture().return.multiplier: number; default: not declared - longSyntheticFuture().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - longSyntheticFuture().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - longSyntheticFuture().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - longSyntheticFuture().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - longSyntheticFuture().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - longSyntheticFuture().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - longSyntheticFuture().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - longSyntheticFuture().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - longSyntheticFuture().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - longSyntheticFuture(config)?: PositionConfig | undefined; default: not declared - longSyntheticFuture(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - longSyntheticFuture(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - longSyntheticFuture(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - longSyntheticFuture(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - longSyntheticFuture(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - longSyntheticFuture(input).callPremium?: number; default: not declared - longSyntheticFuture(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - longSyntheticFuture(input).putPremium?: number; default: not declared - longSyntheticFuture(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - longSyntheticFuture(input).strike: number; default: not declared - protectivePut: (input: import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg, config?: PositionConfig) => Position; default: not declared - protectivePut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - protectivePut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - protectivePut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - protectivePut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - protectivePut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - protectivePut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - protectivePut().return.market.dividendYield?: number; default: not declared - protectivePut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - protectivePut().return.market.riskFreeRate: number; default: not declared - protectivePut().return.market.spot: number; default: not declared - protectivePut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - protectivePut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - protectivePut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - protectivePut().return.multiplier: number; default: not declared - protectivePut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - protectivePut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - protectivePut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - protectivePut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - protectivePut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - protectivePut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - protectivePut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - protectivePut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - protectivePut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - protectivePut(config)?: PositionConfig | undefined; default: not declared - protectivePut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - protectivePut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - protectivePut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - protectivePut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - protectivePut(input): import('@insiderfinance/totalfinance/strategy').StockOptionInput & import('@insiderfinance/totalfinance/strategy').StrikeLeg; default: not declared - protectivePut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - protectivePut(input).premium?: number; default: not declared - protectivePut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - protectivePut(input).stockPrice: number; default: not declared — Entry price per share of the stock leg. - protectivePut(input).strike: number; default: not declared - putBrokenWing: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - putBrokenWing().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - putBrokenWing().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - putBrokenWing().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - putBrokenWing().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - putBrokenWing().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - putBrokenWing().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - putBrokenWing().return.market.dividendYield?: number; default: not declared - putBrokenWing().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - putBrokenWing().return.market.riskFreeRate: number; default: not declared - putBrokenWing().return.market.spot: number; default: not declared - putBrokenWing().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - putBrokenWing().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - putBrokenWing().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - putBrokenWing().return.multiplier: number; default: not declared - putBrokenWing().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - putBrokenWing().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - putBrokenWing().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - putBrokenWing().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - putBrokenWing().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - putBrokenWing().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - putBrokenWing().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - putBrokenWing().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - putBrokenWing().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - putBrokenWing(config)?: PositionConfig | undefined; default: not declared - putBrokenWing(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - putBrokenWing(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - putBrokenWing(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - putBrokenWing(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - putBrokenWing(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - putBrokenWing(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putBrokenWing(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putBrokenWing(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putBrokenWing(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - putBrokenWing(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioBackspread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - putRatioBackspread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - putRatioBackspread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - putRatioBackspread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - putRatioBackspread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - putRatioBackspread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - putRatioBackspread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - putRatioBackspread().return.market.dividendYield?: number; default: not declared - putRatioBackspread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - putRatioBackspread().return.market.riskFreeRate: number; default: not declared - putRatioBackspread().return.market.spot: number; default: not declared - putRatioBackspread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - putRatioBackspread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - putRatioBackspread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - putRatioBackspread().return.multiplier: number; default: not declared - putRatioBackspread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - putRatioBackspread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - putRatioBackspread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - putRatioBackspread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - putRatioBackspread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - putRatioBackspread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - putRatioBackspread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - putRatioBackspread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - putRatioBackspread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - putRatioBackspread(config)?: PositionConfig | undefined; default: not declared - putRatioBackspread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - putRatioBackspread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - putRatioBackspread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - putRatioBackspread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - putRatioBackspread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - putRatioBackspread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putRatioBackspread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioBackspread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - putRatioBackspread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - putRatioBackspread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioSpread: (input: import('@insiderfinance/totalfinance/strategy').RatioInput, config?: PositionConfig) => Position; default: not declared - putRatioSpread().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - putRatioSpread().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - putRatioSpread().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - putRatioSpread().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - putRatioSpread().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - putRatioSpread().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - putRatioSpread().return.market.dividendYield?: number; default: not declared - putRatioSpread().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - putRatioSpread().return.market.riskFreeRate: number; default: not declared - putRatioSpread().return.market.spot: number; default: not declared - putRatioSpread().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - putRatioSpread().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - putRatioSpread().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - putRatioSpread().return.multiplier: number; default: not declared - putRatioSpread().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - putRatioSpread().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - putRatioSpread().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - putRatioSpread().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - putRatioSpread().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - putRatioSpread().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - putRatioSpread().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - putRatioSpread().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - putRatioSpread().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - putRatioSpread(config)?: PositionConfig | undefined; default: not declared - putRatioSpread(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - putRatioSpread(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - putRatioSpread(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - putRatioSpread(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - putRatioSpread(input): import('@insiderfinance/totalfinance/strategy').RatioInput; default: not declared - putRatioSpread(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - putRatioSpread(input).long: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - putRatioSpread(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - putRatioSpread(input).ratio?: number; default: not declared — Number of short legs per long (default 2). - putRatioSpread(input).short: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - reverseJadeLizard: (input: import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput, config?: PositionConfig) => Position; default: not declared - reverseJadeLizard().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - reverseJadeLizard().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - reverseJadeLizard().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - reverseJadeLizard().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - reverseJadeLizard().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - reverseJadeLizard().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - reverseJadeLizard().return.market.dividendYield?: number; default: not declared - reverseJadeLizard().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - reverseJadeLizard().return.market.riskFreeRate: number; default: not declared - reverseJadeLizard().return.market.spot: number; default: not declared - reverseJadeLizard().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - reverseJadeLizard().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - reverseJadeLizard().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - reverseJadeLizard().return.multiplier: number; default: not declared - reverseJadeLizard().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - reverseJadeLizard().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - reverseJadeLizard().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - reverseJadeLizard().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - reverseJadeLizard().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - reverseJadeLizard().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - reverseJadeLizard().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - reverseJadeLizard().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - reverseJadeLizard().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - reverseJadeLizard(config)?: PositionConfig | undefined; default: not declared - reverseJadeLizard(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - reverseJadeLizard(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - reverseJadeLizard(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - reverseJadeLizard(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - reverseJadeLizard(input): import('@insiderfinance/totalfinance/strategy').ReverseJadeLizardInput; default: not declared - reverseJadeLizard(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - reverseJadeLizard(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - reverseJadeLizard(input).longPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - reverseJadeLizard(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - reverseJadeLizard(input).shortPut: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCall: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - shortCall().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCall().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCall().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCall().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCall().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCall().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCall().return.market.dividendYield?: number; default: not declared - shortCall().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCall().return.market.riskFreeRate: number; default: not declared - shortCall().return.market.spot: number; default: not declared - shortCall().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCall().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCall().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCall().return.multiplier: number; default: not declared - shortCall().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCall().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCall().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCall().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCall().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCall().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCall().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCall().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCall().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCall(config)?: PositionConfig | undefined; default: not declared - shortCall(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCall(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCall(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCall(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCall(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - shortCall(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCall(input).premium?: number; default: not declared - shortCall(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCall(input).strike: number; default: not declared - shortCallButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - shortCallButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCallButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCallButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCallButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCallButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCallButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCallButterfly().return.market.dividendYield?: number; default: not declared - shortCallButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCallButterfly().return.market.riskFreeRate: number; default: not declared - shortCallButterfly().return.market.spot: number; default: not declared - shortCallButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCallButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCallButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCallButterfly().return.multiplier: number; default: not declared - shortCallButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCallButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCallButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCallButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCallButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCallButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCallButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCallButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCallButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCallButterfly(config)?: PositionConfig | undefined; default: not declared - shortCallButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCallButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCallButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCallButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCallButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - shortCallButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCallButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCallButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - shortCallCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCallCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCallCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCallCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCallCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCallCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCallCondor().return.market.dividendYield?: number; default: not declared - shortCallCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCallCondor().return.market.riskFreeRate: number; default: not declared - shortCallCondor().return.market.spot: number; default: not declared - shortCallCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCallCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCallCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCallCondor().return.multiplier: number; default: not declared - shortCallCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCallCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCallCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCallCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCallCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCallCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCallCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCallCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCallCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCallCondor(config)?: PositionConfig | undefined; default: not declared - shortCallCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCallCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCallCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCallCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCallCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - shortCallCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCallCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCallCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCombo: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - shortCombo().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortCombo().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortCombo().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortCombo().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortCombo().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortCombo().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortCombo().return.market.dividendYield?: number; default: not declared - shortCombo().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortCombo().return.market.riskFreeRate: number; default: not declared - shortCombo().return.market.spot: number; default: not declared - shortCombo().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortCombo().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortCombo().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortCombo().return.multiplier: number; default: not declared - shortCombo().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortCombo().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortCombo().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortCombo().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortCombo().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortCombo().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortCombo().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortCombo().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortCombo().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortCombo(config)?: PositionConfig | undefined; default: not declared - shortCombo(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortCombo(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortCombo(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortCombo(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortCombo(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - shortCombo(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortCombo(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortCombo(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortCombo(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortGuts: (input: import('@insiderfinance/totalfinance/strategy').TwoStrikeInput, config?: PositionConfig) => Position; default: not declared - shortGuts().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortGuts().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortGuts().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortGuts().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortGuts().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortGuts().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortGuts().return.market.dividendYield?: number; default: not declared - shortGuts().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortGuts().return.market.riskFreeRate: number; default: not declared - shortGuts().return.market.spot: number; default: not declared - shortGuts().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortGuts().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortGuts().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortGuts().return.multiplier: number; default: not declared - shortGuts().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortGuts().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortGuts().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortGuts().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortGuts().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortGuts().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortGuts().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortGuts().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortGuts().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortGuts(config)?: PositionConfig | undefined; default: not declared - shortGuts(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortGuts(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortGuts(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortGuts(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortGuts(input): import('@insiderfinance/totalfinance/strategy').TwoStrikeInput; default: not declared - shortGuts(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortGuts(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortGuts(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortGuts(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPut: (input: import('@insiderfinance/totalfinance/strategy').SingleLegInput, config?: PositionConfig) => Position; default: not declared - shortPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortPut().return.market.dividendYield?: number; default: not declared - shortPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortPut().return.market.riskFreeRate: number; default: not declared - shortPut().return.market.spot: number; default: not declared - shortPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortPut().return.multiplier: number; default: not declared - shortPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortPut(config)?: PositionConfig | undefined; default: not declared - shortPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortPut(input): import('@insiderfinance/totalfinance/strategy').SingleLegInput; default: not declared - shortPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortPut(input).premium?: number; default: not declared - shortPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPut(input).strike: number; default: not declared - shortPutButterfly: (input: import('@insiderfinance/totalfinance/strategy').LadderInput, config?: PositionConfig) => Position; default: not declared - shortPutButterfly().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortPutButterfly().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortPutButterfly().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortPutButterfly().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortPutButterfly().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortPutButterfly().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortPutButterfly().return.market.dividendYield?: number; default: not declared - shortPutButterfly().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortPutButterfly().return.market.riskFreeRate: number; default: not declared - shortPutButterfly().return.market.spot: number; default: not declared - shortPutButterfly().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortPutButterfly().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortPutButterfly().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortPutButterfly().return.multiplier: number; default: not declared - shortPutButterfly().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortPutButterfly().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortPutButterfly().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortPutButterfly().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortPutButterfly().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortPutButterfly().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortPutButterfly().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortPutButterfly().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortPutButterfly().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortPutButterfly(config)?: PositionConfig | undefined; default: not declared - shortPutButterfly(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortPutButterfly(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortPutButterfly(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortPutButterfly(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortPutButterfly(input): import('@insiderfinance/totalfinance/strategy').LadderInput; default: not declared - shortPutButterfly(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortPutButterfly(input).lower: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutButterfly(input).middle: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutButterfly(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortPutButterfly(input).upper: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor: (input: import('@insiderfinance/totalfinance/strategy').CondorInput, config?: PositionConfig) => Position; default: not declared - shortPutCondor().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortPutCondor().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortPutCondor().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortPutCondor().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortPutCondor().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortPutCondor().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortPutCondor().return.market.dividendYield?: number; default: not declared - shortPutCondor().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortPutCondor().return.market.riskFreeRate: number; default: not declared - shortPutCondor().return.market.spot: number; default: not declared - shortPutCondor().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortPutCondor().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortPutCondor().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortPutCondor().return.multiplier: number; default: not declared - shortPutCondor().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortPutCondor().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortPutCondor().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortPutCondor().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortPutCondor().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortPutCondor().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortPutCondor().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortPutCondor().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortPutCondor().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortPutCondor(config)?: PositionConfig | undefined; default: not declared - shortPutCondor(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortPutCondor(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortPutCondor(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortPutCondor(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortPutCondor(input): import('@insiderfinance/totalfinance/strategy').CondorInput; default: not declared - shortPutCondor(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortPutCondor(input).k1: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).k2: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).k3: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).k4: import('@insiderfinance/totalfinance/strategy').Role; default: not declared - shortPutCondor(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortStraddle: (input: import('@insiderfinance/totalfinance/strategy').ShortStraddleInput, config?: PositionConfig) => Position; default: not declared - shortStraddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortStraddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortStraddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortStraddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortStraddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortStraddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortStraddle().return.market.dividendYield?: number; default: not declared - shortStraddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortStraddle().return.market.riskFreeRate: number; default: not declared - shortStraddle().return.market.spot: number; default: not declared - shortStraddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortStraddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortStraddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortStraddle().return.multiplier: number; default: not declared - shortStraddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortStraddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortStraddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortStraddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortStraddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortStraddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortStraddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortStraddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortStraddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortStraddle(config)?: PositionConfig | undefined; default: not declared - shortStraddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortStraddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortStraddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortStraddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortStraddle(input): import('@insiderfinance/totalfinance/strategy').ShortStraddleInput; default: not declared - shortStraddle(input).callPremium?: number; default: not declared - shortStraddle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortStraddle(input).putPremium?: number; default: not declared - shortStraddle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortStraddle(input).strike: number; default: not declared - shortStrangle: (input: import('@insiderfinance/totalfinance/strategy').ShortStrangleInput, config?: PositionConfig) => Position; default: not declared - shortStrangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortStrangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortStrangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortStrangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortStrangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortStrangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortStrangle().return.market.dividendYield?: number; default: not declared - shortStrangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortStrangle().return.market.riskFreeRate: number; default: not declared - shortStrangle().return.market.spot: number; default: not declared - shortStrangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortStrangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortStrangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortStrangle().return.multiplier: number; default: not declared - shortStrangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortStrangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortStrangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortStrangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortStrangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortStrangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortStrangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortStrangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortStrangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortStrangle(config)?: PositionConfig | undefined; default: not declared - shortStrangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortStrangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortStrangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortStrangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortStrangle(input): import('@insiderfinance/totalfinance/strategy').ShortStrangleInput; default: not declared - shortStrangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold call: a strike, or `{ strike, premium? }`. - shortStrangle(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortStrangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The sold put: a strike, or `{ strike, premium? }`. - shortStrangle(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortSyntheticFuture: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - shortSyntheticFuture().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - shortSyntheticFuture().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - shortSyntheticFuture().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - shortSyntheticFuture().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - shortSyntheticFuture().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - shortSyntheticFuture().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - shortSyntheticFuture().return.market.dividendYield?: number; default: not declared - shortSyntheticFuture().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - shortSyntheticFuture().return.market.riskFreeRate: number; default: not declared - shortSyntheticFuture().return.market.spot: number; default: not declared - shortSyntheticFuture().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - shortSyntheticFuture().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - shortSyntheticFuture().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - shortSyntheticFuture().return.multiplier: number; default: not declared - shortSyntheticFuture().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - shortSyntheticFuture().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - shortSyntheticFuture().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - shortSyntheticFuture().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - shortSyntheticFuture().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - shortSyntheticFuture().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - shortSyntheticFuture().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - shortSyntheticFuture().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - shortSyntheticFuture().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - shortSyntheticFuture(config)?: PositionConfig | undefined; default: not declared - shortSyntheticFuture(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - shortSyntheticFuture(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - shortSyntheticFuture(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - shortSyntheticFuture(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - shortSyntheticFuture(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - shortSyntheticFuture(input).callPremium?: number; default: not declared - shortSyntheticFuture(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - shortSyntheticFuture(input).putPremium?: number; default: not declared - shortSyntheticFuture(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - shortSyntheticFuture(input).strike: number; default: not declared - straddle: (input: import('@insiderfinance/totalfinance/strategy').StraddleInput, config?: PositionConfig) => Position; default: not declared - straddle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - straddle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - straddle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - straddle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - straddle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - straddle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - straddle().return.market.dividendYield?: number; default: not declared - straddle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - straddle().return.market.riskFreeRate: number; default: not declared - straddle().return.market.spot: number; default: not declared - straddle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - straddle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - straddle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - straddle().return.multiplier: number; default: not declared - straddle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - straddle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - straddle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - straddle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - straddle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - straddle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - straddle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - straddle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - straddle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - straddle(config)?: PositionConfig | undefined; default: not declared - straddle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - straddle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - straddle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - straddle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - straddle(input): import('@insiderfinance/totalfinance/strategy').StraddleInput; default: not declared - straddle(input).callPremium?: number; default: not declared - straddle(input).expiry?: string; default: not declared - straddle(input).putPremium?: number; default: not declared - straddle(input).quantity?: number; default: not declared - straddle(input).strike: number; default: not declared — The shared strike (shared-strike rule: premiums are named per option type). - strangle: (input: import('@insiderfinance/totalfinance/strategy').StrangleInput, config?: PositionConfig) => Position; default: not declared - strangle().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strangle().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strangle().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strangle().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strangle().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strangle().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strangle().return.market.dividendYield?: number; default: not declared - strangle().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strangle().return.market.riskFreeRate: number; default: not declared - strangle().return.market.spot: number; default: not declared - strangle().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strangle().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strangle().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strangle().return.multiplier: number; default: not declared - strangle().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strangle().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strangle().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strangle().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strangle().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strangle().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strangle().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strangle().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strangle().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strangle(config)?: PositionConfig | undefined; default: not declared - strangle(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strangle(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strangle(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strangle(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strangle(input): import('@insiderfinance/totalfinance/strategy').StrangleInput; default: not declared - strangle(input).call: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The call leg: a strike, or `{ strike, premium? }`. - strangle(input).expiry?: string; default: not declared - strangle(input).put: import('@insiderfinance/totalfinance/strategy').Role; default: not declared — The put leg: a strike, or `{ strike, premium? }`. - strangle(input).quantity?: number; default: not declared - strap: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strap().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strap().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strap().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strap().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strap().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strap().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strap().return.market.dividendYield?: number; default: not declared - strap().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strap().return.market.riskFreeRate: number; default: not declared - strap().return.market.spot: number; default: not declared - strap().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strap().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strap().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strap().return.multiplier: number; default: not declared - strap().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strap().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strap().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strap().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strap().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strap().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strap().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strap().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strap().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strap(config)?: PositionConfig | undefined; default: not declared - strap(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strap(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strap(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strap(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strap(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strap(input).callPremium?: number; default: not declared - strap(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strap(input).putPremium?: number; default: not declared - strap(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strap(input).strike: number; default: not declared - strip: (input: import('@insiderfinance/totalfinance/strategy').SyntheticInput, config?: PositionConfig) => Position; default: not declared - strip().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - strip().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - strip().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - strip().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - strip().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - strip().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - strip().return.market.dividendYield?: number; default: not declared - strip().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - strip().return.market.riskFreeRate: number; default: not declared - strip().return.market.spot: number; default: not declared - strip().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - strip().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - strip().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - strip().return.multiplier: number; default: not declared - strip().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - strip().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - strip().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - strip().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - strip().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - strip().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - strip().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - strip().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - strip().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - strip(config)?: PositionConfig | undefined; default: not declared - strip(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - strip(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - strip(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - strip(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - strip(input): import('@insiderfinance/totalfinance/strategy').SyntheticInput; default: not declared - strip(input).callPremium?: number; default: not declared - strip(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - strip(input).putPremium?: number; default: not declared - strip(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - strip(input).strike: number; default: not declared - syntheticPut: (input: import('@insiderfinance/totalfinance/strategy').SyntheticPutInput, config?: PositionConfig) => Position; default: not declared - syntheticPut().return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - syntheticPut().return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - syntheticPut().return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - syntheticPut().return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - syntheticPut().return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - syntheticPut().return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - syntheticPut().return.market.dividendYield?: number; default: not declared - syntheticPut().return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - syntheticPut().return.market.riskFreeRate: number; default: not declared - syntheticPut().return.market.spot: number; default: not declared - syntheticPut().return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - syntheticPut().return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - syntheticPut().return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - syntheticPut().return.multiplier: number; default: not declared - syntheticPut().return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - syntheticPut().return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - syntheticPut().return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - syntheticPut().return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - syntheticPut().return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - syntheticPut().return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - syntheticPut().return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - syntheticPut().return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - syntheticPut().return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. - syntheticPut(config)?: PositionConfig | undefined; default: not declared - syntheticPut(config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - syntheticPut(config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - syntheticPut(config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - syntheticPut(config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - syntheticPut(input): import('@insiderfinance/totalfinance/strategy').SyntheticPutInput; default: not declared - syntheticPut(input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - syntheticPut(input).premium?: number; default: not declared - syntheticPut(input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - syntheticPut(input).stockPrice: number; default: not declared — Entry price of the short stock leg. - syntheticPut(input).strike: number; default: not declared ### @insiderfinance/totalfinance/strategy#strategyFromChain Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a {@link Position} from an option chain. Returns the position, its resolved legs (premiums and per-leg IVs attached), and the fills (contract / premium / delta per leg). Missing quotes throw `strategy.strike_unavailable`; delta-targeted selection without deltas throws `strategy.delta_required`. ```typescript export declare function strategyFromChain(rows: OptionQuote[], options: FromChainOptions): FromChainResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): FromChainOptions; default: not declared - (rows): OptionQuote[]; default: not declared - return.assumptions: { conventionsVersion: string; expiry: string; multiplier: number; priceSource: PriceSource; quantity: number; }; default: not declared — C (hygiene): the conventions the selection applied — above all which quoted price became each premium. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.expiry: string; default: not declared — The selection expiry (the NEAR expiry for a calendar). - return.assumptions.multiplier: number; default: not declared - return.assumptions.priceSource: PriceSource; default: not declared — The price source every premium was read from (`'mid'` by default; never a silent fallback). - return.assumptions.quantity: number; default: not declared - return.fills: ChainFill[]; default: not declared - return.legs: Leg[]; default: not declared - return.position: Position; default: not declared ### @insiderfinance/totalfinance/strategy#strategyOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a position from legs. ```typescript export declare function strategyOf(legs: readonly LegInput[], config?: PositionConfig): Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (legs): readonly LegInput[]; default: not declared - return.assumptions: () => PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | PriceRange; include?: ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | PriceRange; }) => PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: WhatIfCubeOptions) => WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#strategySignature Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Normalize legs to a structural BASE signature string (order-, scale-, and spacing-independent). Two leg lists share a base signature iff they have the same (kind, sign, strike-rank, quantity-ratio, expiry-rank) multiset — strike DISTANCES are deliberately not encoded (spacing distinguishes only butterflies from broken wings, handled as a tie-breaker in {@link classifyStrategy}, never here). ```typescript export declare function strategySignature(legs: readonly ClassifiableLeg[]): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (legs): readonly ClassifiableLeg[]; default: not declared ### @insiderfinance/totalfinance/strategy#strip Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const strip: (input: s.SyntheticInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SyntheticInput; default: not declared - (input).callPremium?: number; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).putPremium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ### @insiderfinance/totalfinance/strategy#syntheticPut Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const syntheticPut: (input: s.SyntheticPutInput, config?: PositionConfig) => Position; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (config)?: PositionConfig | undefined; default: not declared - (config).expiry?: string; default: not declared — Position-level default expiry (`YYYY-MM-DD` → 16:00 ET, or a datetime) applied to every leg that has no `expiry` of its own. Named builders route their input's `expiry` here. Precedence per leg: `leg.expiry` > `expiry` > `market.expiry` (R4). - (config).market?: import('@insiderfinance/totalfinance/strategy').PremiumMarket; default: not declared — Market for model-priced entry premiums (required when `premiums: 'model'` and any leg omits its premium) — AND the position's remembered market (R5): `probability()`, `monteCarloProbability()`, `value()`, `scenarioTable()`, and `chartData()` use it as their default market, with per-call fields merged over it. Results echo `marketSource: 'construction' | 'call' | 'merged'`. - (config).multiplier?: number; default: not declared — Contract multiplier for option legs (default 100). - (config).premiums?: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — Entry-premium source: `'user'` (from the leg inputs, default) or `'model'` (priced from `market`). - (input): s.SyntheticPutInput; default: not declared - (input).expiry?: string; default: not declared — Expiry applied to every leg of this structure (`YYYY-MM-DD` → 16:00 ET, or a datetime). - (input).premium?: number; default: not declared - (input).quantity?: number; default: not declared — Number of structures (default 1). Every leg scales by this. - (input).stockPrice: number; default: not declared — Entry price of the short stock leg. - (input).strike: number; default: not declared - return.assumptions: () => import('@insiderfinance/totalfinance/strategy').PositionAssumptions; default: not declared — Position-construction assumptions (design law #3): whether the entry premiums were supplied by the caller (`'user'`) or model-priced from a market (`'model'`), plus the contract multiplier. - return.chartData: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; include?: import('@insiderfinance/totalfinance/strategy').ChartInclude; market?: Partial>; }) => Array<{ underlyingPrice: number; expirationPnl?: number; currentPnl?: number; delta?: number; theta?: number; }>; default: not declared — Chart-ready output (spec §12.5). Current P&L / live Greeks need a market: per-call fields merge over the construction market (R5), so a model-premium position charts with no `market`. - return.constructedAs?: string; default: not declared — PROVENANCE, not identity (dx §4.5): the named builder that constructed this position, absent for raw `strategy(legs)`. Because positions are immutable this can never go stale — but a rebuilt-after-tweak position has no name. For "what is this NOW?" use `classifyStrategy`. - return.legs: readonly Readonly[]; default: not declared — The resolved legs — a frozen snapshot (deep-copied at construction, `Object.freeze`d per leg and as an array). A Position is immutable by design: to tweak a strategy, edit your own leg list and rebuild with `strategy(editedLegs, config)` — every downstream calculation is generic over the legs, so the rebuilt position needs no named builder. Mutating this array throws instead of silently diverging from `assumptions()`/cached results. - return.market?: Readonly; default: not declared — The market this position was built with, if any — a frozen copy (R5), so mutating the caller's market object later never silently retargets the position. `probability()`, `value()`, `scenarioTable()`, and `chartData()` default to it; per-call fields merge over it. - return.market.asOf: string | number; default: not declared — Entry time (epoch ms or ISO). Each leg's entry `t = yearFraction(asOf, leg.expiry ?? market.expiry)`. - return.market.dividendYield?: number; default: not declared - return.market.expiry?: string; default: not declared — Default expiry for legs without their own `expiry` (single-expiry structures). - return.market.riskFreeRate: number; default: not declared - return.market.spot: number; default: not declared - return.market.volatility: number; default: not declared — Entry implied volatility (annualized decimal) for unpriced legs that carry no `impliedVolatility` of their own — a leg's own volatility always wins, exactly as it does when `value()` marks it. - return.metrics: () => import('@insiderfinance/totalfinance/strategy').PayoffMetrics; default: not declared — Net debit/credit, max profit/loss, and breakevens. The expiration payoff is piecewise-linear, so these are computed ANALYTICALLY from the kink set (every option strike plus every stock entry price) and the tail slopes — never by sampling a coarse grid, which missed breakevens beyond the last strike (e.g. a lone long stock, or a deep-ITM option) and ignored stock entry prices. - return.monteCarloProbability: (overrides: Partial & { seed: number; }) => import('@insiderfinance/totalfinance/strategy').ProbabilityMonteCarloMetrics; default: not declared — Monte-Carlo probability metrics (spec §12.6): the simulated analogue of {@link probability}, for cross-validation and path-dependent reads. Terminal lognormal paths give the probability of profit and expected P&L (with a standard error); the probability of touching each breakeven is estimated with the Brownian-bridge continuous-monitoring correction. Seeded and deterministic. - return.multiplier: number; default: not declared - return.netDebit: () => number; default: not declared — Net cash to enter (positive = debit, negative = credit). - return.payoff: (options?: { prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; }) => import('@insiderfinance/totalfinance/strategy').PayoffResult; default: not declared — Expiration payoff metrics plus a chart-ready grid of points (spec §12.2). `prices` is an explicit grid array or a `{ from, to, steps }` range; omit it to frame the strike-derived default window (the same one a payoff diagram draws). - return.pnlAtExpiry: (underlyingPrice: number) => number; default: not declared — Expiration P&L at an underlying price, allowing only relative arithmetic roundoff. - return.premiumSource: import('@insiderfinance/totalfinance/strategy').PremiumSource; default: not declared — How the entry premiums were sourced: `'user'` (supplied) or `'model'` (priced from `market`). - return.premiumVolatilitySource?: import('@insiderfinance/totalfinance/strategy').PremiumVolatilitySource; default: not declared — When modeled, which volatility priced the entries (`'leg'`, `'position'` or `'mixed'`). - return.probability: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').ProbabilityMetrics; default: not declared — Probability & scenario metrics (spec §12.6): probability of profit, expected value, reward/risk, and the probability of touching each breakeven — under an explicit, echoed lognormal model. - return.scenarioTable: (options?: { market?: Partial>; prices?: number[] | import('@insiderfinance/totalfinance/strategy').PriceRange; volatilityShocks?: number[]; daysForward?: number[]; }) => import('@insiderfinance/totalfinance/strategy').ScenarioTableResult; default: not declared — Scenario table (spec §12.6): mark-to-market P&L and Greeks across a grid of underlying prices, additive vol shocks, and days forward — the standard "what-if" matrix for an options ticket. - return.value: (overrides?: Partial) => import('@insiderfinance/totalfinance/strategy').MarkToMarketResult; default: not declared — Mark-to-market value, P&L, per-leg and aggregate Greeks via BSM (spec §12.3). - return.whatIfCube: (options?: import('@insiderfinance/totalfinance/strategy').WhatIfCubeOptions) => import('@insiderfinance/totalfinance/strategy').WhatIfCubeResult; default: not declared — A what-if **cube**: the position marked over the full spot × vol-shock × days-forward grid, plus the **optimal-exit surface** — for each (spot, vol) outcome, the day along the time axis that optimizes P&L (`max-pnl` by default, or `min-pnl`). `scenarioTable` extended a dimension: it returns a navigable cube (axes + row-major cells) with the reductions a trader wants, not a flat row list. Every cell is a `value()` mark (time-aware, per-leg-IV, shock-through-to-leg-IV), so calendars and per-leg volatilities behave identically. The optimal-exit surface is a CONDITIONAL what-if ("if the underlying is here with this vol shock, which day marks best?"), not a path-dependent stopping rule. See `docs/specs/what-if-cube.md`. ## Entrypoint @insiderfinance/totalfinance/strategy/from-chain ### @insiderfinance/totalfinance/strategy/from-chain#ChainFill Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ChainFill`. ### @insiderfinance/totalfinance/strategy/from-chain#FromChainOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#FromChainOptions`. ### @insiderfinance/totalfinance/strategy/from-chain#FromChainResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#FromChainResult`. ### @insiderfinance/totalfinance/strategy/from-chain#FromChainType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#FromChainType`. ### @insiderfinance/totalfinance/strategy/from-chain#strategyFromChain Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#strategyFromChain`. ## Entrypoint @insiderfinance/totalfinance/strategy/probability ### @insiderfinance/totalfinance/strategy/probability#ExpectedIntrinsicInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExpectedIntrinsicInput extends TerminalDistributionInput { type: 'call' | 'put'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drift: number; default: not declared — Annualized drift. - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - type: 'call' | 'put'; default: not declared - volatility: number; default: not declared — Annualized volatility as a decimal. ### @insiderfinance/totalfinance/strategy/probability#ProbabilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ProbabilityInput`. ### @insiderfinance/totalfinance/strategy/probability#ProbabilityMeasure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ProbabilityMeasure`. ### @insiderfinance/totalfinance/strategy/probability#ProbabilityMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ProbabilityMetrics`. ### @insiderfinance/totalfinance/strategy/probability#ProbabilityModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ProbabilityModel`. ### @insiderfinance/totalfinance/strategy/probability#ProbabilityMonteCarloInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ProbabilityMonteCarloInput`. ### @insiderfinance/totalfinance/strategy/probability#ProbabilityMonteCarloMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ProbabilityMonteCarloMetrics`. ### @insiderfinance/totalfinance/strategy/probability#ScenarioRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScenarioRow`. ### @insiderfinance/totalfinance/strategy/probability#ScenarioTableResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScenarioTableResult`. ### @insiderfinance/totalfinance/strategy/probability#TerminalDistributionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TerminalDistributionInput { spot: number; strike: number; /** Annualized drift. */ drift: number; /** Annualized volatility as a decimal. */ volatility: number; /** Time to expiry in years. */ timeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drift: number; default: not declared — Annualized drift. - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - volatility: number; default: not declared — Annualized volatility as a decimal. ### @insiderfinance/totalfinance/strategy/probability#TouchProbability Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#TouchProbability`. ### @insiderfinance/totalfinance/strategy/probability#TouchProbabilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TouchProbabilityInput { spot: number; barrier: number; /** Annualized drift. */ drift: number; /** Annualized volatility as a decimal. */ volatility: number; /** Monitoring horizon in years. */ timeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - barrier: number; default: not declared - drift: number; default: not declared — Annualized drift. - spot: number; default: not declared - timeToExpiryYears: number; default: not declared — Monitoring horizon in years. - volatility: number; default: not declared — Annualized volatility as a decimal. ### @insiderfinance/totalfinance/strategy/probability#expectedIntrinsic Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Undiscounted expected option intrinsic under the supplied terminal distribution. ```typescript export declare function expectedIntrinsic(input: ExpectedIntrinsicInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExpectedIntrinsicInput; default: not declared - (input).drift: number; default: not declared — Annualized drift. - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).type: 'call' | 'put'; default: not declared - (input).volatility: number; default: not declared — Annualized volatility as a decimal. ### @insiderfinance/totalfinance/strategy/probability#terminalCdf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). P(S_T ≤ strike) under a lognormal terminal distribution. ```typescript export declare function terminalCdf(input: TerminalDistributionInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TerminalDistributionInput; default: not declared - (input).drift: number; default: not declared — Annualized drift. - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).volatility: number; default: not declared — Annualized volatility as a decimal. ### @insiderfinance/totalfinance/strategy/probability#touchProbability Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). GBM first-passage probability of touching `barrier` before expiry. ```typescript export declare function touchProbability(input: TouchProbabilityInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TouchProbabilityInput; default: not declared - (input).barrier: number; default: not declared - (input).drift: number; default: not declared — Annualized drift. - (input).spot: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Monitoring horizon in years. - (input).volatility: number; default: not declared — Annualized volatility as a decimal. ## Entrypoint @insiderfinance/totalfinance/strategy/scanner ### @insiderfinance/totalfinance/strategy/scanner#SCAN_OBJECTIVES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#SCAN_OBJECTIVES`. ### @insiderfinance/totalfinance/strategy/scanner#ScanCandidate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScanCandidate`. ### @insiderfinance/totalfinance/strategy/scanner#ScanObjective Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScanObjective`. ### @insiderfinance/totalfinance/strategy/scanner#ScanOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScanOptions`. ### @insiderfinance/totalfinance/strategy/scanner#ScanQuoteRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScanQuoteRow`. ### @insiderfinance/totalfinance/strategy/scanner#ScanResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The scan report (Law 2 report grammar): the ranked candidates plus the applied conventions (`assumptions`) and a warnings channel (`diagnostics`). ```typescript /** * The scan report (Law 2 report grammar): the ranked candidates plus the applied conventions * (`assumptions`) and a warnings channel (`diagnostics`). */ export interface ScanResult { /** The top-N candidates by the ranking objective, descending, each fully metric'd. */ candidates: ScanCandidate[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; /** The ranking objective that produced the order (and each candidate's `score`). */ rankBy: ScanObjective; /** The structures that were enumerated. */ structures: ScanStructure[]; /** Year fraction to the scanned expiry. */ timeToExpiryYears: number; /** The single at-spot volatility that `probabilityOfProfit`/`expectedValue` are scored at (see the `smile` doc). */ scoringVolatility: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; dayCount: 'ACT/365F'; rankBy: ScanObjective; scoringVolatility: number; structures: ScanStructure[]; timeToExpiryYears: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount: 'ACT/365F'; default: not declared - assumptions.rankBy: 'probabilityOfProfit' | 'expectedValue' | 'returnOnRisk' | 'expectedValuePerRisk'; default: not declared — The ranking objective that produced the order (and each candidate's `score`). - assumptions.scoringVolatility: number; default: not declared — The single at-spot volatility that `probabilityOfProfit`/`expectedValue` are scored at (see the `smile` doc). - assumptions.structures: ScanStructure[]; default: not declared — The structures that were enumerated. - assumptions.timeToExpiryYears: number; default: not declared — Year fraction to the scanned expiry. - candidates: ScanCandidate[]; default: not declared — The top-N candidates by the ranking objective, descending, each fully metric'd. - diagnostics: Diagnostics; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/strategy/scanner#ScanStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#ScanStructure`. ### @insiderfinance/totalfinance/strategy/scanner#scanStrategies Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/strategy#scanStrategies`. ## Entrypoint @insiderfinance/totalfinance/structure ### @insiderfinance/totalfinance/structure#AggressorSide Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type AggressorSide = 'buy' | 'sell' | 'unknown'; ``` ### @insiderfinance/totalfinance/structure#AtSpotExposure Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What `atSpot` re-evaluates for a profile: its selected `gex` and/or `dex`. ```typescript /** What `atSpot` re-evaluates for a profile: its selected `gex` and/or `dex`. */ export type AtSpotExposure = Pick<{ gex: number; dex: number; }, Extract> & Partial, 'gex' | 'dex'>>>; ``` ### @insiderfinance/totalfinance/structure#CallPutPremium Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Call-vs-put premium/volume summary with put/call ratios (spec §11.6). ```typescript /** Call-vs-put premium/volume summary with put/call ratios (spec §11.6). */ export interface CallPutPremium { callPremium: number; putPremium: number; callVolume: number; putVolume: number; /** Put ÷ call traded volume (contracts); `null` when there is no call volume. */ putCallVolumeRatio: number | null; /** Put ÷ call premium ($); `null` when there is no call premium. */ putCallPremiumRatio: number | null; /** Net directional premium across all trades (buy − sell). */ netPremium: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callPremium: number; default: not declared - callVolume: number; default: not declared - netPremium: number; default: not declared — Net directional premium across all trades (buy − sell). - putCallPremiumRatio: number | null; default: not declared — Put ÷ call premium ($); `null` when there is no call premium. - putCallVolumeRatio: number | null; default: not declared — Put ÷ call traded volume (contracts); `null` when there is no call volume. - putPremium: number; default: not declared - putVolume: number; default: not declared ### @insiderfinance/totalfinance/structure#ClassifiedTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ClassifiedTrade { trade: OptionTrade; underlying: string; type: OptionType; strike: number; expiry: string; /** Supplied or quote-estimated aggressor side, according to classificationProvenance. */ side: AggressorSide; classificationProvenance: FlowClassificationProvenance; premium: number; size: number; isBlock: boolean; /** True when the trade prints on its own expiration day (0DTE). */ isZeroDaysToExpiry: boolean; /** Opening estimate: `open` when size exceeds prior open interest (definitely new contracts). */ openClose: OpenCloseEstimate; /** Sweep cluster id (undefined when not part of a sweep). */ sweepId?: number; /** Spread group id (undefined when not part of a detected multi-leg spread). */ spreadId?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classificationProvenance: FlowClassificationProvenance; default: not declared - classificationProvenance.policy: FlowClassificationSource; default: not declared - classificationProvenance.providedSide: AggressorSide | null; default: not declared — `null` means absent; `'unknown'` means the provider explicitly declined to classify. - classificationProvenance.reason: 'provided' | 'provided-missing' | 'quotes-missing' | 'quotes-locked-or-crossed' | 'quote-midpoint' | 'quote-rule'; default: not declared - classificationProvenance.source: 'unavailable' | 'quotes' | 'provided'; default: not declared - expiry: string; default: not declared - isBlock: boolean; default: not declared - isZeroDaysToExpiry: boolean; default: not declared — True when the trade prints on its own expiration day (0DTE). - openClose: OpenCloseEstimate; default: not declared — Opening estimate: `open` when size exceeds prior open interest (definitely new contracts). - premium: number; default: not declared - side: AggressorSide; default: not declared — Supplied or quote-estimated aggressor side, according to classificationProvenance. - size: number; default: not declared - spreadId?: number; default: not declared — Spread group id (undefined when not part of a detected multi-leg spread). - strike: number; default: not declared - sweepId?: number; default: not declared — Sweep cluster id (undefined when not part of a sweep). - trade: OptionTrade; default: not declared - trade.aggressorSide?: 'buy' | 'sell' | 'unknown'; default: not declared - trade.ask?: number; default: not declared - trade.askSize?: number; default: not declared - trade.bid?: number; default: not declared - trade.bidSize?: number; default: not declared - trade.conditions?: string[]; default: not declared - trade.contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - trade.contract.adjusted?: boolean; default: not declared - trade.contract.currency?: string; default: not declared - trade.contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - trade.contract.deliverable.cash?: number; default: not declared - trade.contract.deliverable.notes?: string; default: not declared - trade.contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - trade.contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - trade.contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - trade.contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - trade.contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - trade.contract.multiplier?: number; default: not declared - trade.contract.occSymbol?: string; default: not declared - trade.contract.root?: string; default: not declared - trade.contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - trade.contract.strike: number; default: not declared - trade.contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - trade.contract.type: OptionType; default: not declared - trade.contract.underlying: string; default: not declared - trade.exchange?: string; default: not declared - trade.greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - trade.greeks.delta: number; default: not declared - trade.greeks.gamma?: number; default: not declared - trade.greeks.provenance?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeksProvenance; default: not declared - trade.greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - trade.greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - trade.greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - trade.greeks.rho?: number; default: not declared - trade.greeks.theta?: number; default: not declared - trade.greeks.vega?: number; default: not declared - trade.impliedVolatility?: number; default: not declared - trade.last?: number; default: not declared - trade.mark?: number; default: not declared - trade.mid?: number; default: not declared - trade.notional?: number; default: not declared - trade.openInterest?: number; default: not declared - trade.openingLikely?: boolean; default: not declared - trade.premium?: number; default: not declared - trade.price: number; default: not declared - trade.sequence?: number; default: not declared - trade.size: number; default: not declared - trade.timestampMs: number; default: not declared - trade.underlyingPrice?: number; default: not declared - trade.volume?: number; default: not declared - type: OptionType; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/structure#ContractExposure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ContractExposure { expiry: string; strike: number; type: OptionType; timeToExpiryYears: number; impliedVolatility: number; openInterest: number; multiplier: number; /** Applied position sign (+1/−1) from the convention. */ sign: number; gamma: number; delta: number; gex: number; dex: number; vega: number; vanna: number; charm: number; theta: number; vomma: number; speed: number; color: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared - color: number; default: not declared - delta: number; default: not declared - dex: number; default: not declared - expiry: string; default: not declared - gamma: number; default: not declared - gex: number; default: not declared - impliedVolatility: number; default: not declared - multiplier: number; default: not declared - openInterest: number; default: not declared - sign: number; default: not declared — Applied position sign (+1/−1) from the convention. - speed: number; default: not declared - strike: number; default: not declared - theta: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared - vanna: number; default: not declared - vega: number; default: not declared - vomma: number; default: not declared ### @insiderfinance/totalfinance/structure#ContractExposureRow Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A per-contract row of a profile (see {@link ExposureAggregate}): the contract's identity and inputs, its computed metrics, the raw `gamma` only when `gex` was computed and the raw `delta` only when `dex` was. With the defaults this is {@link ContractExposure}. ```typescript /** * A per-contract row of a profile (see {@link ExposureAggregate}): the contract's identity and inputs, * its computed metrics, the raw `gamma` only when `gex` was computed and the raw `delta` only when * `dex` was. With the defaults this is {@link ContractExposure}. */ export type ContractExposureRow = Omit & ExposureAggregate & ('gex' extends G ? { gamma: number; } : 'gex' extends P ? { gamma?: number; } : unknown) & ('dex' extends G ? { delta: number; } : 'dex' extends P ? { delta?: number; } : unknown); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - impliedVolatility: number; default: not declared - multiplier: number; default: not declared - openInterest: number; default: not declared - sign: number; default: not declared — Applied position sign (+1/−1) from the convention. - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/structure#DefaultScenarioMetric Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The metrics a `scenarioMap` computes when none are requested. ```typescript /** The metrics a `scenarioMap` computes when none are requested. */ export type DefaultScenarioMetric = 'gex' | 'dex' | 'vanna' | 'charm'; ``` ### @insiderfinance/totalfinance/structure#DeltaAdjustedPremium Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DeltaAdjustedPremium { /** Σ |delta|·premium over prints whose directional lean is bullish (bought calls / sold puts). */ bullishPremium: number; /** Σ |delta|·premium over bearish prints (bought puts / sold calls). */ bearishPremium: number; /** `bullishPremium − bearishPremium` — net directional delta-adjusted premium (> 0 = net bullish). */ netDirectional: number; /** Σ |delta|·premium regardless of direction — the total delta-weighted premium. */ totalDeltaAdjusted: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bearishPremium: number; default: not declared — Σ |delta|·premium over bearish prints (bought puts / sold calls). - bullishPremium: number; default: not declared — Σ |delta|·premium over prints whose directional lean is bullish (bought calls / sold puts). - netDirectional: number; default: not declared — `bullishPremium − bearishPremium` — net directional delta-adjusted premium (> 0 = net bullish). - totalDeltaAdjusted: number; default: not declared — Σ |delta|·premium regardless of direction — the total delta-weighted premium. ### @insiderfinance/totalfinance/structure#DirectionalFlowTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One directional flow print. `delta` is the option's signed delta at the print — caller-supplied from their own greeks (this package never fabricates greeks), keeping the compute pure. ```typescript // ───────────────────────── directional flow intelligence (spec §11.6) ───────────────────────── /** * One directional flow print. `delta` is the option's signed delta at the print — caller-supplied * from their own greeks (this package never fabricates greeks), keeping the compute pure. */ export interface DirectionalFlowTrade { type: OptionType; /** Estimated aggressor side (e.g. from {@link FlowAnalysis}). */ side: 'buy' | 'sell'; /** Trade premium in dollars (`price · size · multiplier`). */ premium: number; /** Signed option delta at the print (calls > 0, puts < 0). */ delta: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared — Signed option delta at the print (calls > 0, puts < 0). - premium: number; default: not declared — Trade premium in dollars (`price · size · multiplier`). - side: 'buy' | 'sell'; default: not declared — Estimated aggressor side (e.g. from {@link FlowAnalysis}). - type: OptionType; default: not declared ### @insiderfinance/totalfinance/structure#ExpiryRow Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A by-expiry row narrowed to the requested metrics (see {@link StrikeRow}). ```typescript /** A by-expiry row narrowed to the requested metrics (see {@link StrikeRow}). */ export type ExpiryRow = { expiry: string; } & Pick; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared ### @insiderfinance/totalfinance/structure#ExposureAggregate Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The totals of a profile that computed the guaranteed metrics `G` and possibly `P`: guaranteed metrics are required, possible ones optional, everything else absent. With the defaults this is {@link ExposureTotals}. ```typescript /** * The totals of a profile that computed the guaranteed metrics `G` and possibly `P`: guaranteed * metrics are required, possible ones optional, everything else absent. With the defaults this is * {@link ExposureTotals}. */ export type ExposureAggregate = Pick & Partial>>; ``` ### @insiderfinance/totalfinance/structure#ExposureConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Non-market exposure configuration: the sign convention and computation knobs (WS3.2). ```typescript /** Non-market exposure configuration: the sign convention and computation knobs (WS3.2). */ export interface ExposureConfig { /** REQUIRED sign convention; echoed in `assumptions.convention` with its caveat in diagnostics. */ convention: ExposureConvention; priceSource?: PriceSource; /** `per1PercentMove` (default, the spec GEX formula) or `perPoint`. */ gammaUnit?: GammaUnit; /** Skip contracts with time-to-expiry below this many years (default 0). */ minTimeToExpiry?: number; /** Contract multiplier when a quote omits one (default 100). */ defaultMultiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - convention: ExposureConvention; default: not declared — REQUIRED sign convention; echoed in `assumptions.convention` with its caveat in diagnostics. - convention.calls: 1 | -1; default: not declared - convention.puts: 1 | -1; default: not declared - defaultMultiplier?: number; default: not declared — Contract multiplier when a quote omits one (default 100). - gammaUnit?: GammaUnit; default: not declared — `per1PercentMove` (default, the spec GEX formula) or `perPoint`. - minTimeToExpiry?: number; default: not declared — Skip contracts with time-to-expiry below this many years (default 0). - priceSource?: PriceSource; default: not declared ### @insiderfinance/totalfinance/structure#ExposureConvention Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExposureConvention = 'callsPositivePutsNegative' | 'dealerShortGamma' | 'tradeSignedAggressor' | { calls: 1 | -1; puts: 1 | -1; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calls: 1 | -1; default: not declared - puts: 1 | -1; default: not declared ### @insiderfinance/totalfinance/structure#ExposureInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ExposureInput`. ### @insiderfinance/totalfinance/structure#ExposureMarket Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market snapshot for `exposure()` — the workspace-canonical {@link MarketInputs}, except `spot` is optional here because it falls back to each quote's `underlyingPrice` when omitted (WS3.2), and `asOf` also accepts the ONE canonical "when" grammar (core `resolveAsOf`): epoch ms, `YYYY-MM-DD` (UTC midnight), or a ZONED ISO datetime — a bare zone-less datetime throws the teaching error. ```typescript /** * Market snapshot for `exposure()` — the workspace-canonical {@link MarketInputs}, except `spot` is * optional here because it falls back to each quote's `underlyingPrice` when omitted (WS3.2), and * `asOf` also accepts the ONE canonical "when" grammar (core `resolveAsOf`): epoch ms, `YYYY-MM-DD` * (UTC midnight), or a ZONED ISO datetime — a bare zone-less datetime throws the teaching error. */ export type ExposureMarket = Omit & { /** Spot price. Falls back to each quote's `underlyingPrice` when omitted. */ spot?: number; /** Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime (core `resolveAsOf` grammar). */ asOf: EpochMs | string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime (core `resolveAsOf` grammar). - dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - riskFreeRate: number; default: not declared - spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. ### @insiderfinance/totalfinance/structure#ExposureMetric Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ExposureMetric = 'gex' | 'dex' | 'vega' | 'vanna' | 'charm' | 'theta' | 'vomma' | 'speed' | 'color'; ``` ### @insiderfinance/totalfinance/structure#ExposureProfile Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A computed exposure profile with levels, by-strike/by-expiry views, and scenario maps. R2 envelope: the sign convention and every resolved knob live in `assumptions`; model limitations ride `diagnostics.warnings` as `model.limitation` entries — nothing is hoisted top-level. SELECTIVE (selective Greeks and exposure spec, decision 11). A profile built with `exposure({ …, metrics })` — or a shortcut such as {@link gammaExposure} — computed ONLY the selected metrics and the Black–Scholes outputs they need. Its rows and `aggregate` carry exactly those metrics; an uncomputed metric is ABSENT, never zero. `G` is the set the type guarantees (a literal selection) and `P` the set that may be present (a dynamic selection); both default to every metric — the full profile `exposure()` has always returned. ```typescript export declare class ExposureProfile { constructor(request: ExposureInput); readonly aggregate: ExposureAggregate; readonly assumptions: Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: GammaUnit; priceSource: PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly ExposureMetric[]; }>; atSpot(spot: number): AtSpotExposure; byExpiry(metrics?: readonly M[]): ExpiryRow[]; byStrike(metrics?: readonly M[]): StrikeRow[]; readonly contracts: readonly Readonly>[]; readonly diagnostics: Diagnostics; levels(options?: { pinRiskBand?: number; }): Levels; netDrift(): NetDrift; scenarioMap(options?: ScenarioMapOptions): ScenarioMap; readonly spot: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): ExposureInput; default: not declared - (request).config: ExposureConfig; default: not declared - (request).market: ExposureMarket; default: not declared - (request).metrics?: undefined; default: not declared — The exposures to compute, e.g. `['gex']` or `['gex', 'dex', 'vanna']`. Omit it for the full profile (every metric, exactly as before). A selection — explicit, nonempty, each name once — computes only those metrics and the Black–Scholes outputs they need, and is echoed in `assumptions.metrics`; uncomputed metrics are absent from the result, never zero. - (request).quotes: OptionQuote[]; default: not declared - aggregate: ExposureAggregate; default: not declared - assumptions: Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: GammaUnit; priceSource: PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly ExposureMetric[]; }>; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.convention: { name: string; calls: number; puts: number; }; default: not declared — The resolved sign convention (echoed; its caveat rides `diagnostics.warnings`). - assumptions.convention.calls: number; default: not declared - assumptions.convention.name: string; default: not declared - assumptions.convention.puts: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.defaultMultiplier: number; default: not declared — Contract multiplier applied when a quote omits one. - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.gammaUnit: GammaUnit; default: not declared — GEX unit: `per1PercentMove` (spec formula) or `perPoint`. - assumptions.metrics?: readonly ExposureMetric[]; default: not declared — The metrics this profile computed, as requested. Present only when `metrics` was passed; a profile without it is the full profile (every metric). - assumptions.minTimeToExpiry: number; default: not declared — Contracts with time-to-expiry (years) at/below this were skipped. - assumptions.model?: string; default: not declared - assumptions.priceSource: PriceSource; default: not declared — Quote price used for the IV fallback when a quote has no usable `impliedVolatility`. - assumptions.scanVolatilityPolicy: 'stickyStrike'; default: not declared — Spot-shift scans (zeroGamma, scenarioMap) hold each contract's IV fixed (sticky-strike). - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeDecayDirection: 'perCalendarDayElapsed'; default: not declared — Charm/color are reported per calendar day ELAPSED (`−∂/∂T`), matching the passage of time. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - atSpot: (spot: number) => AtSpotExposure; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - atSpot(spot): number; default: not declared - byExpiry: (metrics?: readonly M[]) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - byExpiry(metrics)?: readonly M[] | undefined; default: not declared - byStrike: (metrics?: readonly M[]) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - byStrike(metrics)?: readonly M[] | undefined; default: not declared - contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - levels().return.callWall: number | null; default: not declared — Strike with the largest summed |call GEX| across ALL expiries (resistance). Magnitude, not signed: the wall is where the most call gamma sits, which is the same strike whichever way the convention signs it. - levels().return.charmWall: number | null; default: not declared - levels().return.gammaFlips: number[]; default: not declared — All interpolated gamma-flip levels in [0.8·spot, 1.2·spot], sorted ascending (may be empty). - levels().return.gammaRegime: 'positive' | 'negative' | null; default: not declared — Direction at the current spot: `positive` (mean-reverting) or `negative` (trending), or null. - levels().return.largestCallOpenInterest: number | null; default: not declared - levels().return.largestPutOpenInterest: number | null; default: not declared - levels().return.maxGammaStrike: number | null; default: not declared - levels().return.maxPain: number | null; default: not declared — Strike minimizing total in-the-money option value to holders (max writer profit), computed for the NEAREST expiry only — max pain is expiry-specific and cannot be aggregated across expirations. - levels().return.minGammaStrike: number | null; default: not declared - levels().return.monthlyOpexWall: number | null; default: not declared — Largest net-|GEX| strike (calls + puts summed per strike) in the nearest monthly OPEX (3rd-Friday). - levels().return.pinRisk: { strike: number; atRisk: boolean; } | null; default: not declared — Nearest high-gamma strike to spot, with `atRisk` true when spot is within `pinRiskBand`. - levels().return.pinRisk.atRisk: boolean; default: not declared - levels().return.pinRisk.strike: number; default: not declared - levels().return.putWall: number | null; default: not declared — Strike with the largest summed |put GEX| across ALL expiries, under the convention (support). - levels().return.vannaWall: number | null; default: not declared - levels().return.weeklyOpexWall: number | null; default: not declared — Largest net-|GEX| strike (calls + puts summed per strike) in the nearest Friday (weekly) expiry. - levels().return.zeroDaysToExpiryWall: number | null; default: not declared — Largest net-|GEX| strike (calls + puts summed per strike) among 0DTE contracts — expiring on the snapshot's own **America/New_York** trading date (not its UTC date: after 20:00 ET the UTC date is already tomorrow, which flagged the NEXT session's expiry as 0DTE). - levels().return.zeroGamma: number | null; default: not declared — Spot level where net GEX flips sign, chosen as the interpolated gamma-flip NEAREST spot when the profile has more than one flip in [0.8·spot, 1.2·spot]. Null when no flip exists in range. - levels(options)?: { pinRiskBand?: number; }; default: not declared - levels(options).pinRiskBand?: number; default: not declared - netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - netDrift().return.bias: 'trend' | 'pin' | null; default: not declared — `pin` (gamma pulls spot toward zero-gamma) / `trend` (pushes away) / null. - netDrift().return.charmFlowPerDay: number; default: not declared — Aggregate charm exposure: signed dealer delta to re-hedge as ONE calendar day ELAPSES (drift into expiry). Positive ⇒ dealers accumulate long delta day-over-day. Uses the elapsed-time sign (`−∂DEX/∂T` per day), so it reads the same direction as the passage of time. - netDrift().return.distanceToZeroGamma: number | null; default: not declared — Signed distance from spot to zero-gamma as a fraction of spot (positive ⇒ flip is above spot). - netDrift().return.gammaRegime: 'positive' | 'negative' | null; default: not declared — `positive` (mean-reverting/pinning) or `negative` (trending), or null. - netDrift().return.vannaFlowPerVolatilityPoint: number; default: not declared — Aggregate vanna exposure: signed dealer delta to re-hedge per +1 VOL POINT (a +0.01 move in implied volatility), matching the per-1%-move convention `gex` uses. The unit is in the name because the value is 100x smaller than a per-unit-volatility reading of the same greek. - netDrift().return.zeroGamma: number | null; default: not declared — The zero-gamma level (gamma flip) — the attractor in positive gamma, repeller in negative. - return.aggregate: ExposureAggregate; default: not declared - return.assumptions: Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: GammaUnit; priceSource: PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly ExposureMetric[]; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[]) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[]) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared - scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - scenarioMap().return.cells: ScenarioCell[]; default: not declared - scenarioMap().return.evaluations: number; default: not declared — Total greek recomputations performed (for the acceleration-need benchmark). - scenarioMap().return.metrics: M[]; default: not declared - scenarioMap(options)?: ScenarioMapOptions; default: not declared - scenarioMap(options).metrics?: readonly M[]; default: not declared — Which metrics to compute. Default `['gex','dex','vanna','charm']`. - scenarioMap(options).spot?: number[] | { from: number; to: number; steps: number; }; default: not declared — Spot grid: explicit prices, or `{ from, to, steps }`. Defaults to ±10% around spot, 41 steps. - scenarioMap(options).spot.from: number; default: not declared - scenarioMap(options).spot.steps: number; default: not declared - scenarioMap(options).spot.to: number; default: not declared - scenarioMap(options).timeAdvance?: number[]; default: not declared — Years to advance time (reducing each T), e.g. `[0, 1/365]`. Default `[0]`. - scenarioMap(options).volatilityShock?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. - spot: number; default: not declared ### @insiderfinance/totalfinance/structure#ExposureShortcutInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The chain, market and sign convention every exposure takes — the input of the single-metric shortcuts. ```typescript /** The chain, market and sign convention every exposure takes — the input of the single-metric shortcuts. */ export interface ExposureShortcutInput { quotes: OptionQuote[]; market: ExposureMarket; config: ExposureConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config: ExposureConfig; default: not declared - config.convention: ExposureConvention; default: not declared — REQUIRED sign convention; echoed in `assumptions.convention` with its caveat in diagnostics. - config.convention.calls: 1 | -1; default: not declared - config.convention.puts: 1 | -1; default: not declared - config.defaultMultiplier?: number; default: not declared — Contract multiplier when a quote omits one (default 100). - config.gammaUnit?: GammaUnit; default: not declared — `per1PercentMove` (default, the spec GEX formula) or `perPoint`. - config.minTimeToExpiry?: number; default: not declared — Skip contracts with time-to-expiry below this many years (default 0). - config.priceSource?: PriceSource; default: not declared - market: ExposureMarket; default: not declared - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a zoned ISO datetime (core `resolveAsOf` grammar). - market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - market.riskFreeRate: number; default: not declared - market.spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. - quotes: OptionQuote[]; default: not declared ### @insiderfinance/totalfinance/structure#ExposureTotals Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExposureTotals { /** Dollar gamma exposure (`Γ·OI·mult·spot²·0.01` per-1%-move, signed by convention). */ gex: number; /** Dollar delta exposure (`Δ·OI·mult·spot`). */ dex: number; /** Vega exposure (`vega/1%·OI·mult`). */ vega: number; /** Vanna exposure: dollar-delta change per +1% vol. */ vanna: number; /** * Charm exposure: signed dollar-delta change as ONE calendar day ELAPSES (positive ⇒ dealer delta * increases day-over-day). Reported as `−∂DEX/∂T` per day, so its sign matches the passage of time. */ charm: number; /** Theta exposure: dollar option-price decay per calendar day. */ theta: number; /** Vomma (volga) exposure: change in vega exposure per +1% vol. */ vomma: number; /** * Speed exposure: the CHANGE IN `gex` for a **+1% spot move**, in the same unit as `gex` * (`gammaUnit`). It is the full derivative of the GEX definition, not the bare third-order greek: * per-1%-move, `Δgex = (speed·S + 2·Γ)·OI·mult·sign·S²·1e-4`; per-point, `(speed·S + Γ)·OI·mult·sign·S·0.01`. * So `aggregate.speed ≈ atSpot(spot·1.01).gex − atSpot(spot).gex` (a first-order estimate of it). */ speed: number; /** * Color exposure: signed change in GEX as ONE calendar day ELAPSES (`−∂GEX/∂T` per day), in the * same unit as `gex` (`gammaUnit`), so a positive value means dealer gamma exposure grows as time * passes. Per 1% move it is `−color·OI·mult·sign·S²·0.01/365`; per point, `−color·OI·mult·sign·S/365`. */ color: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - charm: number; default: not declared — Charm exposure: signed dollar-delta change as ONE calendar day ELAPSES (positive ⇒ dealer delta increases day-over-day). Reported as `−∂DEX/∂T` per day, so its sign matches the passage of time. - color: number; default: not declared — Color exposure: signed change in GEX as ONE calendar day ELAPSES (`−∂GEX/∂T` per day), in the same unit as `gex` (`gammaUnit`), so a positive value means dealer gamma exposure grows as time passes. Per 1% move it is `−color·OI·mult·sign·S²·0.01/365`; per point, `−color·OI·mult·sign·S/365`. - dex: number; default: not declared — Dollar delta exposure (`Δ·OI·mult·spot`). - gex: number; default: not declared — Dollar gamma exposure (`Γ·OI·mult·spot²·0.01` per-1%-move, signed by convention). - speed: number; default: not declared — Speed exposure: the CHANGE IN `gex` for a **+1% spot move**, in the same unit as `gex` (`gammaUnit`). It is the full derivative of the GEX definition, not the bare third-order greek: per-1%-move, `Δgex = (speed·S + 2·Γ)·OI·mult·sign·S²·1e-4`; per-point, `(speed·S + Γ)·OI·mult·sign·S·0.01`. So `aggregate.speed ≈ atSpot(spot·1.01).gex − atSpot(spot).gex` (a first-order estimate of it). - theta: number; default: not declared — Theta exposure: dollar option-price decay per calendar day. - vanna: number; default: not declared — Vanna exposure: dollar-delta change per +1% vol. - vega: number; default: not declared — Vega exposure (`vega/1%·OI·mult`). - vomma: number; default: not declared — Vomma (volga) exposure: change in vega exposure per +1% vol. ### @insiderfinance/totalfinance/structure#FlowAnalysis Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of analyzing a stream of option trades. R2 envelope: the rules/windows ride `assumptions` and the heuristic caveats ride `diagnostics.warnings` as `model.limitation` entries — nothing is hoisted top-level. ```typescript export declare class FlowAnalysis { constructor(rawTrades: OptionTrade[], options?: FlowOptions); readonly assumptions: Assumptions<{ nbboRule: 'quote-rule-midpoint-unknown'; classificationSource: FlowClassificationSource; sweepWindowMs: number; spreadWindowMs: number; sweepMinPrints: number; blockMinSize: number; blockMinPremium: number; multiplier: number; venueVerifiedSweeps: boolean; }>; blocks: ClassifiedTrade[]; callPutPremium(): CallPutPremium; readonly diagnostics: Diagnostics; groupBy(keys: Array): FlowGroup[]; rank(groups: FlowGroup[], options?: RankOptions): FlowGroup[]; readonly spreads: readonly Readonly[]; readonly sweeps: readonly Readonly[]; readonly trades: readonly Readonly[]; zeroDaysToExpiry: ClassifiedTrade[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: FlowOptions; default: not declared - (options).blockMinPremium?: number; default: not declared — ...or at/above this premium (price·size·multiplier). Default 100_000. - (options).blockMinSize?: number; default: not declared — A single print is a block at/above this size (contracts). Default 100. - (options).classificationSource?: FlowClassificationSource; default: not declared — Classification authority/fallback rule. Default `'provided-or-quotes'` (legacy behavior). - (options).multiplier?: number; default: not declared — Contract multiplier when a trade omits one. Default 100. - (options).spreadWindowMs?: number; default: not declared — Prints on one underlying within this window (ms) across ≥2 contracts form a spread. Default 100. - (options).sweepMinPrints?: number; default: not declared — Minimum prints to call a cluster a sweep. Default 3. - (options).sweepWindowMs?: number; default: not declared — Prints on one contract within this window (ms), same side, count as one sweep. Default 500. - (rawTrades): OptionTrade[]; default: not declared - assumptions: Assumptions<{ nbboRule: 'quote-rule-midpoint-unknown'; classificationSource: FlowClassificationSource; sweepWindowMs: number; spreadWindowMs: number; sweepMinPrints: number; blockMinSize: number; blockMinPremium: number; multiplier: number; venueVerifiedSweeps: boolean; }>; default: not declared — The rules/windows the analysis ran under — echoed so a serialized report is self-interpreting. - assumptions.asOf?: number; default: not declared - assumptions.blockMinPremium: number; default: not declared - assumptions.blockMinSize: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.classificationSource: FlowClassificationSource; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.multiplier: number; default: not declared - assumptions.nbboRule: 'quote-rule-midpoint-unknown'; default: not declared — The aggressor rule actually applied: the NBBO **quote rule** (at/above ask ⇒ buy, at/below bid ⇒ sell, strictly inside ⇒ compare to the midpoint, AT the midpoint ⇒ `unknown`). It is NOT Lee–Ready, which resolves midpoint prints with a **tick test** against the previous trade — this package never sees a trade's predecessor price, so it declines instead of guessing. - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.spreadWindowMs: number; default: not declared - assumptions.sweepMinPrints: number; default: not declared - assumptions.sweepWindowMs: number; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.venueVerifiedSweeps: boolean; default: not declared — Whether any print carried an `exchange`, enabling venue-verified sweep detection (WS2.13). - blocks: ClassifiedTrade[]; default: not declared — Blocks: single prints large by size or premium. - callPutPremium: () => CallPutPremium; default: not declared — Call-vs-put premium and volume across all trades, with put/call ratios and net premium. - callPutPremium().return.callPremium: number; default: not declared - callPutPremium().return.callVolume: number; default: not declared - callPutPremium().return.netPremium: number; default: not declared — Net directional premium across all trades (buy − sell). - callPutPremium().return.putCallPremiumRatio: number | null; default: not declared — Put ÷ call premium ($); `null` when there is no call premium. - callPutPremium().return.putCallVolumeRatio: number | null; default: not declared — Put ÷ call traded volume (contracts); `null` when there is no call volume. - callPutPremium().return.putPremium: number; default: not declared - callPutPremium().return.putVolume: number; default: not declared - diagnostics: Diagnostics; default: not declared — Structured warnings: `model.limitation` caveats plus any data-quality flags. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - groupBy: (keys: Array) => FlowGroup[]; default: not declared — Aggregate trades into groups keyed by any subset of underlying/expiry/strike/type. - groupBy(keys): (keyof FlowGroupKey)[]; default: not declared - rank: (groups: FlowGroup[], options?: RankOptions) => FlowGroup[]; default: not declared — Filter and sort groups (default: by premium, descending). - rank(groups): FlowGroup[]; default: not declared - rank(options)?: RankOptions; default: not declared - rank(options).by?: RankByKey; default: not declared — Ranking metric (default `'premium'`). - rank(options).limit?: number; default: not declared — Maximum returned groups; a non-negative safe integer. Omit for every group. - rank(options).minPremium?: number; default: not declared — Exclude groups below this aggregate premium. - rank(options).minVolumeOpenInterestRatio?: number; default: not declared — Exclude groups below this volume/open-interest ratio. - return.assumptions: Assumptions<{ nbboRule: 'quote-rule-midpoint-unknown'; classificationSource: FlowClassificationSource; sweepWindowMs: number; spreadWindowMs: number; sweepMinPrints: number; blockMinSize: number; blockMinPremium: number; multiplier: number; venueVerifiedSweeps: boolean; }>; default: not declared — The rules/windows the analysis ran under — echoed so a serialized report is self-interpreting. - return.blocks: ClassifiedTrade[]; default: not declared — Blocks: single prints large by size or premium. - return.callPutPremium: () => CallPutPremium; default: not declared — Call-vs-put premium and volume across all trades, with put/call ratios and net premium. - return.diagnostics: Diagnostics; default: not declared — Structured warnings: `model.limitation` caveats plus any data-quality flags. - return.groupBy: (keys: Array) => FlowGroup[]; default: not declared — Aggregate trades into groups keyed by any subset of underlying/expiry/strike/type. - return.rank: (groups: FlowGroup[], options?: RankOptions) => FlowGroup[]; default: not declared — Filter and sort groups (default: by premium, descending). - return.spreads: readonly Readonly[]; default: not declared - return.sweeps: readonly Readonly[]; default: not declared - return.trades: readonly Readonly[]; default: not declared — Frozen result arrays — an analysis is a snapshot; mutate a copy, never the result. - return.zeroDaysToExpiry: ClassifiedTrade[]; default: not declared — 0DTE trades: prints on a contract expiring the same calendar day. - spreads: readonly Readonly[]; default: not declared - sweeps: readonly Readonly[]; default: not declared - trades: readonly Readonly[]; default: not declared — Frozen result arrays — an analysis is a snapshot; mutate a copy, never the result. - zeroDaysToExpiry: ClassifiedTrade[]; default: not declared — 0DTE trades: prints on a contract expiring the same calendar day. ### @insiderfinance/totalfinance/structure#FlowClassificationProvenance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Lineage of the classification, not a claim that a provider label is exchange-confirmed. ```typescript /** Lineage of the classification, not a claim that a provider label is exchange-confirmed. */ export interface FlowClassificationProvenance { policy: FlowClassificationSource; source: 'provided' | 'quotes' | 'unavailable'; /** `null` means absent; `'unknown'` means the provider explicitly declined to classify. */ providedSide: AggressorSide | null; reason: 'provided' | 'provided-missing' | 'quotes-missing' | 'quotes-locked-or-crossed' | 'quote-midpoint' | 'quote-rule'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - policy: FlowClassificationSource; default: not declared - providedSide: AggressorSide | null; default: not declared — `null` means absent; `'unknown'` means the provider explicitly declined to classify. - reason: 'provided' | 'provided-missing' | 'quotes-missing' | 'quotes-locked-or-crossed' | 'quote-midpoint' | 'quote-rule'; default: not declared - source: 'unavailable' | 'quotes' | 'provided'; default: not declared ### @insiderfinance/totalfinance/structure#FlowClassificationSource Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `provided-or-quotes` is the backwards-compatible rule: supplied buy/sell wins, but unknown or absent classification falls through to quotes. `provided-first` preserves supplied unknowns and uses quotes only when classification is absent. `provided-only` never infers from quotes; `quotes-only` ignores supplied classifications (but still validates their enum). ```typescript /** * `provided-or-quotes` is the backwards-compatible rule: supplied buy/sell wins, but unknown or * absent classification falls through to quotes. `provided-first` preserves supplied unknowns * and uses quotes only when classification is absent. `provided-only` never infers from quotes; * `quotes-only` ignores supplied classifications (but still validates their enum). */ export type FlowClassificationSource = 'provided-or-quotes' | 'provided-first' | 'provided-only' | 'quotes-only'; ``` ### @insiderfinance/totalfinance/structure#FlowGroup Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FlowGroup extends FlowGroupKey { trades: number; size: number; premium: number; buyPremium: number; sellPremium: number; /** Net premium (buy − sell). */ netPremium: number; /** * Volume/open-interest ratio when grouped to a single contract with known OI, else `null` * (chart-facing rows use JSON-safe `null`, never `undefined` or `NaN` — WS2.12). */ volumeOpenInterestRatio: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buyPremium: number; default: not declared - expiry?: string; default: not declared - netPremium: number; default: not declared — Net premium (buy − sell). - premium: number; default: not declared - sellPremium: number; default: not declared - size: number; default: not declared - strike?: number; default: not declared - trades: number; default: not declared - type?: OptionType; default: not declared - underlying?: string; default: not declared - volumeOpenInterestRatio: number | null; default: not declared — Volume/open-interest ratio when grouped to a single contract with known OI, else `null` (chart-facing rows use JSON-safe `null`, never `undefined` or `NaN` — WS2.12). ### @insiderfinance/totalfinance/structure#FlowGroupKey Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FlowGroupKey { underlying?: string; expiry?: string; strike?: number; type?: OptionType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry?: string; default: not declared - strike?: number; default: not declared - type?: OptionType; default: not declared - underlying?: string; default: not declared ### @insiderfinance/totalfinance/structure#FlowOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FlowOptions { /** Classification authority/fallback rule. Default `'provided-or-quotes'` (legacy behavior). */ classificationSource?: FlowClassificationSource; /** A single print is a block at/above this size (contracts). Default 100. */ blockMinSize?: number; /** ...or at/above this premium (price·size·multiplier). Default 100_000. */ blockMinPremium?: number; /** Prints on one contract within this window (ms), same side, count as one sweep. Default 500. */ sweepWindowMs?: number; /** Minimum prints to call a cluster a sweep. Default 3. */ sweepMinPrints?: number; /** Prints on one underlying within this window (ms) across ≥2 contracts form a spread. Default 100. */ spreadWindowMs?: number; /** Contract multiplier when a trade omits one. Default 100. */ multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - blockMinPremium?: number; default: not declared — ...or at/above this premium (price·size·multiplier). Default 100_000. - blockMinSize?: number; default: not declared — A single print is a block at/above this size (contracts). Default 100. - classificationSource?: FlowClassificationSource; default: not declared — Classification authority/fallback rule. Default `'provided-or-quotes'` (legacy behavior). - multiplier?: number; default: not declared — Contract multiplier when a trade omits one. Default 100. - spreadWindowMs?: number; default: not declared — Prints on one underlying within this window (ms) across ≥2 contracts form a spread. Default 100. - sweepMinPrints?: number; default: not declared — Minimum prints to call a cluster a sweep. Default 3. - sweepWindowMs?: number; default: not declared — Prints on one contract within this window (ms), same side, count as one sweep. Default 500. ### @insiderfinance/totalfinance/structure#GammaUnit Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type GammaUnit = 'per1PercentMove' | 'perPoint'; ``` ### @insiderfinance/totalfinance/structure#GexSplit Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The call/put GEX + OI split attached to a by-strike row WHEN `'gex'` is requested (WS4.5): the canonical dashboard chart draws `callGex` bars up and `putGex` bars down. `callGex + putGex` equals the row's net `gex`; `callOpenInterest + putOpenInterest` equals the total open interest at that strike. ```typescript /** * The call/put GEX + OI split attached to a by-strike row WHEN `'gex'` is requested (WS4.5): the * canonical dashboard chart draws `callGex` bars up and `putGex` bars down. `callGex + putGex` * equals the row's net `gex`; `callOpenInterest + putOpenInterest` equals the total open interest at that strike. */ export type GexSplit = { callGex: number; putGex: number; callOpenInterest: number; putOpenInterest: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callGex: number; default: not declared - callOpenInterest: number; default: not declared - putGex: number; default: not declared - putOpenInterest: number; default: not declared ### @insiderfinance/totalfinance/structure#GuaranteedExposureMetrics Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The metrics an `exposure()` call is GUARANTEED to have computed: every metric when `metrics` is omitted, otherwise the names the selection is certain to contain ({@link GuaranteedSelection}) — exactly the names of a literal selection, and none for a selection whose contents the type cannot know (`ExposureMetric[]`, a conditional between selections, a union-valued element). ```typescript /** * The metrics an `exposure()` call is GUARANTEED to have computed: every metric when `metrics` is * omitted, otherwise the names the selection is certain to contain ({@link GuaranteedSelection}) — * exactly the names of a literal selection, and none for a selection whose contents the type cannot * know (`ExposureMetric[]`, a conditional between selections, a union-valued element). */ export type GuaranteedExposureMetrics = [ S ] extends [ undefined ] ? ExposureMetric : [ S ] extends [ readonly ExposureMetric[] ] ? GuaranteedSelection> : never; ``` ### @insiderfinance/totalfinance/structure#GuaranteedSuppliedExposureMetrics Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The metrics a selection guarantees: both when omitted, otherwise the names the selection is certain to contain ({@link GuaranteedSelection}) — none for a dynamic selection, a conditional between selections or a union-valued element. ```typescript /** * The metrics a selection guarantees: both when omitted, otherwise the names the selection is certain * to contain ({@link GuaranteedSelection}) — none for a dynamic selection, a conditional between * selections or a union-valued element. */ export type GuaranteedSuppliedExposureMetrics = [ S ] extends [ undefined ] ? SuppliedExposureMetric : [ S ] extends [ readonly SuppliedExposureMetric[] ] ? GuaranteedSelection> : never; ``` ### @insiderfinance/totalfinance/structure#Levels Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Levels { /** * Spot level where net GEX flips sign, chosen as the interpolated gamma-flip NEAREST spot when the * profile has more than one flip in [0.8·spot, 1.2·spot]. Null when no flip exists in range. */ zeroGamma: number | null; /** All interpolated gamma-flip levels in [0.8·spot, 1.2·spot], sorted ascending (may be empty). */ gammaFlips: number[]; /** Direction at the current spot: `positive` (mean-reverting) or `negative` (trending), or null. */ gammaRegime: 'positive' | 'negative' | null; /** * Strike with the largest summed |call GEX| across ALL expiries (resistance). Magnitude, not signed: * the wall is where the most call gamma sits, which is the same strike whichever way the convention * signs it. */ callWall: number | null; /** Strike with the largest summed |put GEX| across ALL expiries, under the convention (support). */ putWall: number | null; maxGammaStrike: number | null; minGammaStrike: number | null; /** * Strike minimizing total in-the-money option value to holders (max writer profit), computed for the * NEAREST expiry only — max pain is expiry-specific and cannot be aggregated across expirations. */ maxPain: number | null; largestCallOpenInterest: number | null; largestPutOpenInterest: number | null; vannaWall: number | null; charmWall: number | null; /** Nearest high-gamma strike to spot, with `atRisk` true when spot is within `pinRiskBand`. */ pinRisk: { strike: number; atRisk: boolean; } | null; /** * Largest net-|GEX| strike (calls + puts summed per strike) among 0DTE contracts — expiring on the * snapshot's own **America/New_York** trading date (not its UTC date: after 20:00 ET the UTC date is * already tomorrow, which flagged the NEXT session's expiry as 0DTE). */ zeroDaysToExpiryWall: number | null; /** Largest net-|GEX| strike (calls + puts summed per strike) in the nearest Friday (weekly) expiry. */ weeklyOpexWall: number | null; /** Largest net-|GEX| strike (calls + puts summed per strike) in the nearest monthly OPEX (3rd-Friday). */ monthlyOpexWall: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callWall: number | null; default: not declared — Strike with the largest summed |call GEX| across ALL expiries (resistance). Magnitude, not signed: the wall is where the most call gamma sits, which is the same strike whichever way the convention signs it. - charmWall: number | null; default: not declared - gammaFlips: number[]; default: not declared — All interpolated gamma-flip levels in [0.8·spot, 1.2·spot], sorted ascending (may be empty). - gammaRegime: 'positive' | 'negative' | null; default: not declared — Direction at the current spot: `positive` (mean-reverting) or `negative` (trending), or null. - largestCallOpenInterest: number | null; default: not declared - largestPutOpenInterest: number | null; default: not declared - maxGammaStrike: number | null; default: not declared - maxPain: number | null; default: not declared — Strike minimizing total in-the-money option value to holders (max writer profit), computed for the NEAREST expiry only — max pain is expiry-specific and cannot be aggregated across expirations. - minGammaStrike: number | null; default: not declared - monthlyOpexWall: number | null; default: not declared — Largest net-|GEX| strike (calls + puts summed per strike) in the nearest monthly OPEX (3rd-Friday). - pinRisk: { atRisk: boolean; strike: number; } | null; default: not declared — Nearest high-gamma strike to spot, with `atRisk` true when spot is within `pinRiskBand`. - pinRisk.atRisk: boolean; default: not declared - pinRisk.strike: number; default: not declared - putWall: number | null; default: not declared — Strike with the largest summed |put GEX| across ALL expiries, under the convention (support). - vannaWall: number | null; default: not declared - weeklyOpexWall: number | null; default: not declared — Largest net-|GEX| strike (calls + puts summed per strike) in the nearest Friday (weekly) expiry. - zeroDaysToExpiryWall: number | null; default: not declared — Largest net-|GEX| strike (calls + puts summed per strike) among 0DTE contracts — expiring on the snapshot's own **America/New_York** trading date (not its UTC date: after 20:00 ET the UTC date is already tomorrow, which flagged the NEXT session's expiry as 0DTE). - zeroGamma: number | null; default: not declared — Spot level where net GEX flips sign, chosen as the interpolated gamma-flip NEAREST spot when the profile has more than one flip in [0.8·spot, 1.2·spot]. Null when no flip exists in range. ### @insiderfinance/totalfinance/structure#NetDrift Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Net dealer-hedging drift estimate (spec §11.5). ```typescript /** Net dealer-hedging drift estimate (spec §11.5). */ export interface NetDrift { /** `positive` (mean-reverting/pinning) or `negative` (trending), or null. */ gammaRegime: 'positive' | 'negative' | null; /** The zero-gamma level (gamma flip) — the attractor in positive gamma, repeller in negative. */ zeroGamma: number | null; /** Signed distance from spot to zero-gamma as a fraction of spot (positive ⇒ flip is above spot). */ distanceToZeroGamma: number | null; /** `pin` (gamma pulls spot toward zero-gamma) / `trend` (pushes away) / null. */ bias: 'pin' | 'trend' | null; /** * Aggregate charm exposure: signed dealer delta to re-hedge as ONE calendar day ELAPSES (drift into * expiry). Positive ⇒ dealers accumulate long delta day-over-day. Uses the elapsed-time sign * (`−∂DEX/∂T` per day), so it reads the same direction as the passage of time. */ charmFlowPerDay: number; /** * Aggregate vanna exposure: signed dealer delta to re-hedge per +1 VOL POINT (a +0.01 move in * implied volatility), matching the per-1%-move convention `gex` uses. The unit is in the name * because the value is 100x smaller than a per-unit-volatility reading of the same greek. */ vannaFlowPerVolatilityPoint: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bias: 'trend' | 'pin' | null; default: not declared — `pin` (gamma pulls spot toward zero-gamma) / `trend` (pushes away) / null. - charmFlowPerDay: number; default: not declared — Aggregate charm exposure: signed dealer delta to re-hedge as ONE calendar day ELAPSES (drift into expiry). Positive ⇒ dealers accumulate long delta day-over-day. Uses the elapsed-time sign (`−∂DEX/∂T` per day), so it reads the same direction as the passage of time. - distanceToZeroGamma: number | null; default: not declared — Signed distance from spot to zero-gamma as a fraction of spot (positive ⇒ flip is above spot). - gammaRegime: 'positive' | 'negative' | null; default: not declared — `positive` (mean-reverting/pinning) or `negative` (trending), or null. - vannaFlowPerVolatilityPoint: number; default: not declared — Aggregate vanna exposure: signed dealer delta to re-hedge per +1 VOL POINT (a +0.01 move in implied volatility), matching the per-1%-move convention `gex` uses. The unit is in the name because the value is 100x smaller than a per-unit-volatility reading of the same greek. - zeroGamma: number | null; default: not declared — The zero-gamma level (gamma flip) — the attractor in positive gamma, repeller in negative. ### @insiderfinance/totalfinance/structure#OpenCloseEstimate Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opening-vs-closing estimate; only a definite `open` (size exceeds prior OI) is inferred. ```typescript /** Opening-vs-closing estimate; only a definite `open` (size exceeds prior OI) is inferred. */ export type OpenCloseEstimate = 'open' | 'unknown'; ``` ### @insiderfinance/totalfinance/structure#OptionFlowDriftAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionFlowDriftAssumptions = { timezone: string; sessionDate: string; symbol: string | null; priceOverlaySymbol: string | null; bucketMinutes: number; classificationSource: FlowClassificationSource; multiplier: number; minimumClassificationCoverage: number; premiumRule: 'provided-else-price-times-size-times-multiplier'; unknownPolicy: 'zero-drift-full-premium-bounds'; interval: '[open,min(close,asOf))'; priceRule: 'in-session-latest-before-bucket-end-no-backfill'; priceTieBreak: 'underlying-trade-then-quote-then-option-trade-last-input'; orderPolicy: 'stable-timestamp-sort'; duplicatePolicy: 'reject-id-or-identical-idless-print'; coverageMeaning: 'classified-premium-share-not-probability'; heuristicRule: 'empty-low-coverage-volume-opposed-expansion-mixed'; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bucketMinutes: number; default: not declared - classificationSource: FlowClassificationSource; default: not declared - coverageMeaning: 'classified-premium-share-not-probability'; default: not declared - duplicatePolicy: 'reject-id-or-identical-idless-print'; default: not declared - heuristicRule: 'empty-low-coverage-volume-opposed-expansion-mixed'; default: not declared - interval: '[open,min(close,asOf))'; default: not declared - minimumClassificationCoverage: number; default: not declared - multiplier: number; default: not declared - orderPolicy: 'stable-timestamp-sort'; default: not declared - premiumRule: 'provided-else-price-times-size-times-multiplier'; default: not declared - priceOverlaySymbol: string | null; default: not declared - priceRule: 'in-session-latest-before-bucket-end-no-backfill'; default: not declared - priceTieBreak: 'underlying-trade-then-quote-then-option-trade-last-input'; default: not declared - sessionDate: string; default: not declared - symbol: string | null; default: not declared - timezone: string; default: not declared - unknownPolicy: 'zero-drift-full-premium-bounds'; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftBucket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftBucket { /** Interval [startTimestampMs, endTimestampMs); values become available at its END. */ startTimestampMs: number; endTimestampMs: number; /** True only for the final cutoff-shortened interval, not a calendar-shortened closing bucket. */ partial: boolean; change: OptionFlowDriftTotals; cumulative: OptionFlowDriftTotals; /** Latest in-session observation strictly before endTimestampMs; never backfilled. */ price: OptionFlowDriftPrice | null; trades: OptionFlowDriftPrint[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - change: OptionFlowDriftTotals; default: not declared - change.bearishPremium: number; default: not declared - change.bearishVolume: number; default: not declared - change.bullishPremium: number; default: not declared - change.bullishVolume: number; default: not declared - change.callBounds: [number, number]; default: not declared — Worst-case sign-assignment bounds from unknown premium, NOT confidence intervals. - change.callBuyPremium: number; default: not declared - change.callDrift: number; default: not declared — Call buys minus call sells. - change.callPremium: number; default: not declared - change.callSellPremium: number; default: not declared - change.callUnknownPremium: number; default: not declared - change.classificationCoverage: number | null; default: not declared — classifiedPremium / totalPremium; null at zero premium. NOT a probability. - change.classifiedPremium: number; default: not declared - change.classifiedTradeCount: number; default: not declared - change.heuristic: OptionFlowDriftHeuristic; default: not declared — Same-window premium/volume rule. See the function's documentation for precedence. - change.netDirectionalBounds: [number, number]; default: not declared - change.netDirectionalDrift: number; default: not declared — callDrift - putDrift. No delta, gamma, charm, vanna, or income projection. - change.netDirectionalVolume: number; default: not declared - change.putBounds: [number, number]; default: not declared - change.putBuyPremium: number; default: not declared - change.putDrift: number; default: not declared — Put buys minus put sells (positive put drift is bearish in the directional mapping). - change.putPremium: number; default: not declared - change.putSellPremium: number; default: not declared - change.putUnknownPremium: number; default: not declared - change.totalPremium: number; default: not declared - change.totalVolume: number; default: not declared - change.tradeCount: number; default: not declared - change.unknownPremium: number; default: not declared - change.unknownTradeCount: number; default: not declared - change.unknownVolume: number; default: not declared - change.volumeConfirmation: OptionFlowVolumeConfirmation; default: not declared - cumulative: OptionFlowDriftTotals; default: not declared - cumulative.bearishPremium: number; default: not declared - cumulative.bearishVolume: number; default: not declared - cumulative.bullishPremium: number; default: not declared - cumulative.bullishVolume: number; default: not declared - cumulative.callBounds: [number, number]; default: not declared — Worst-case sign-assignment bounds from unknown premium, NOT confidence intervals. - cumulative.callBuyPremium: number; default: not declared - cumulative.callDrift: number; default: not declared — Call buys minus call sells. - cumulative.callPremium: number; default: not declared - cumulative.callSellPremium: number; default: not declared - cumulative.callUnknownPremium: number; default: not declared - cumulative.classificationCoverage: number | null; default: not declared — classifiedPremium / totalPremium; null at zero premium. NOT a probability. - cumulative.classifiedPremium: number; default: not declared - cumulative.classifiedTradeCount: number; default: not declared - cumulative.heuristic: OptionFlowDriftHeuristic; default: not declared — Same-window premium/volume rule. See the function's documentation for precedence. - cumulative.netDirectionalBounds: [number, number]; default: not declared - cumulative.netDirectionalDrift: number; default: not declared — callDrift - putDrift. No delta, gamma, charm, vanna, or income projection. - cumulative.netDirectionalVolume: number; default: not declared - cumulative.putBounds: [number, number]; default: not declared - cumulative.putBuyPremium: number; default: not declared - cumulative.putDrift: number; default: not declared — Put buys minus put sells (positive put drift is bearish in the directional mapping). - cumulative.putPremium: number; default: not declared - cumulative.putSellPremium: number; default: not declared - cumulative.putUnknownPremium: number; default: not declared - cumulative.totalPremium: number; default: not declared - cumulative.totalVolume: number; default: not declared - cumulative.tradeCount: number; default: not declared - cumulative.unknownPremium: number; default: not declared - cumulative.unknownTradeCount: number; default: not declared - cumulative.unknownVolume: number; default: not declared - cumulative.volumeConfirmation: OptionFlowVolumeConfirmation; default: not declared - endTimestampMs: number; default: not declared - partial: boolean; default: not declared — True only for the final cutoff-shortened interval, not a calendar-shortened closing bucket. - price: OptionFlowDriftPrice | null; default: not declared — Latest in-session observation strictly before endTimestampMs; never backfilled. - price.price: number; default: not declared - price.source: 'option-trade-underlying' | 'underlying-quote-midpoint' | 'underlying-trade'; default: not declared - price.symbol: string; default: not declared - price.timestampMs: number; default: not declared - startTimestampMs: number; default: not declared — Interval [startTimestampMs, endTimestampMs); values become available at its END. - trades: OptionFlowDriftPrint[]; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftConfig { /** Omit to aggregate all underlyings. Exact, case-sensitive match. */ symbol?: string; /** Defaults to the scoped symbol's OptionTrade.underlyingPrice; marketwide defaults to no overlay. */ priceOverlay?: OptionFlowPriceOverlay; /** Additional open-anchored bucket width, integer minutes in [1, 1440]. Default 5. */ bucketMinutes?: number; /** Exclusive epoch-ms cutoff; no trade, overlay observation, or bucket at/after this instant. */ asOf?: number; /** Default provided-first: authoritative unknown stays unknown; only absent labels use quotes. */ classificationSource?: FlowClassificationSource; /** Fallback when contract.multiplier is absent. Default 100; supplied premium always wins. */ multiplier?: number; /** Premium classification coverage below this suppresses directional heuristics. Default 0.6. */ minimumClassificationCoverage?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf?: number; default: not declared — Exclusive epoch-ms cutoff; no trade, overlay observation, or bucket at/after this instant. - bucketMinutes?: number; default: not declared — Additional open-anchored bucket width, integer minutes in [1, 1440]. Default 5. - classificationSource?: FlowClassificationSource; default: not declared — Default provided-first: authoritative unknown stays unknown; only absent labels use quotes. - minimumClassificationCoverage?: number; default: not declared — Premium classification coverage below this suppresses directional heuristics. Default 0.6. - multiplier?: number; default: not declared — Fallback when contract.multiplier is absent. Default 100; supplied premium always wins. - priceOverlay?: OptionFlowPriceOverlay; default: not declared — Defaults to the scoped symbol's OptionTrade.underlyingPrice; marketwide defaults to no overlay. - priceOverlay.quotes?: readonly Quote[]; default: not declared — Contemporaneously available quotes; non-crossed, positive bid/ask midpoint is used. - priceOverlay.symbol: string; default: not declared — Required for an explicit overlay, especially in marketwide mode. Exact, case-sensitive. - priceOverlay.trades?: readonly Trade[]; default: not declared — Contemporaneously available underlying trades; use their price, not an option price. - symbol?: string; default: not declared — Omit to aggregate all underlyings. Exact, case-sensitive match. ### @insiderfinance/totalfinance/structure#OptionFlowDriftHeuristic Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionFlowDriftHeuristic = 'no-signal' | 'low-coverage' | 'volume-opposed' | 'bullish-expansion' | 'bearish-expansion' | 'mixed-flow'; ``` ### @insiderfinance/totalfinance/structure#OptionFlowDriftInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftInput { trades: readonly OptionFlowDriftTrade[]; session: OptionFlowDriftSession; config?: OptionFlowDriftConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config?: OptionFlowDriftConfig; default: not declared - config.asOf?: number; default: not declared — Exclusive epoch-ms cutoff; no trade, overlay observation, or bucket at/after this instant. - config.bucketMinutes?: number; default: not declared — Additional open-anchored bucket width, integer minutes in [1, 1440]. Default 5. - config.classificationSource?: FlowClassificationSource; default: not declared — Default provided-first: authoritative unknown stays unknown; only absent labels use quotes. - config.minimumClassificationCoverage?: number; default: not declared — Premium classification coverage below this suppresses directional heuristics. Default 0.6. - config.multiplier?: number; default: not declared — Fallback when contract.multiplier is absent. Default 100; supplied premium always wins. - config.priceOverlay?: OptionFlowPriceOverlay; default: not declared — Defaults to the scoped symbol's OptionTrade.underlyingPrice; marketwide defaults to no overlay. - config.priceOverlay.quotes?: readonly Quote[]; default: not declared — Contemporaneously available quotes; non-crossed, positive bid/ask midpoint is used. - config.priceOverlay.symbol: string; default: not declared — Required for an explicit overlay, especially in marketwide mode. Exact, case-sensitive. - config.priceOverlay.trades?: readonly Trade[]; default: not declared — Contemporaneously available underlying trades; use their price, not an option price. - config.symbol?: string; default: not declared — Omit to aggregate all underlyings. Exact, case-sensitive match. - session: OptionFlowDriftSession; default: not declared - session.calendar?: Calendar; default: not declared — Default NYSE. Accepts core Calendar or calendars.TradingCalendar, including half-days. - session.calendar.addBusinessDays: (date: string, days: number) => string; default: not declared - session.calendar.addBusinessDays(date): string; default: not declared - session.calendar.addBusinessDays(days): number; default: not declared - session.calendar.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - session.calendar.businessDaysBetween(from): string; default: not declared - session.calendar.businessDaysBetween(to): string; default: not declared - session.calendar.isBusinessDay: (date: string) => boolean; default: not declared - session.calendar.isBusinessDay(date): string; default: not declared - session.calendar.isHalfDay: (date: string) => boolean; default: not declared - session.calendar.isHalfDay(date): string; default: not declared - session.calendar.isHoliday: (date: string) => boolean; default: not declared - session.calendar.isHoliday(date): string; default: not declared - session.calendar.name: string; default: not declared - session.calendar.nextBusinessDay: (date: string) => string; default: not declared - session.calendar.nextBusinessDay(date): string; default: not declared - session.calendar.previousBusinessDay: (date: string) => string; default: not declared - session.calendar.previousBusinessDay(date): string; default: not declared - session.calendar.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - session.calendar.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - session.calendar.session().return.date: string; default: not declared - session.calendar.session().return.isBusinessDay: boolean; default: not declared - session.calendar.session().return.isHalfDay: boolean; default: not declared - session.calendar.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - session.calendar.session(date): string; default: not declared - session.calendar.timezone: string; default: not declared - session.calendar.version: string; default: not declared - session.date: string; default: not declared — Explicit ISO YYYY-MM-DD in the calendar's timezone; never inferred from the tape. - trades: readonly OptionFlowDriftTrade[]; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftPrice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftPrice { symbol: string; price: number; timestampMs: number; source: 'option-trade-underlying' | 'underlying-quote-midpoint' | 'underlying-trade'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared - source: 'option-trade-underlying' | 'underlying-quote-midpoint' | 'underlying-trade'; default: not declared - symbol: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftPrint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftPrint { id: string | null; /** Position in the original input tape; ties preserve that order. */ inputIndex: number; timestampMs: number; underlying: string; type: OptionType; side: AggressorSide; classificationProvenance: FlowClassificationProvenance; premium: number; premiumSource: 'provided' | 'price-size-multiplier'; multiplier: number; contracts: number; directionalPremium: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - classificationProvenance: FlowClassificationProvenance; default: not declared - classificationProvenance.policy: FlowClassificationSource; default: not declared - classificationProvenance.providedSide: AggressorSide | null; default: not declared — `null` means absent; `'unknown'` means the provider explicitly declined to classify. - classificationProvenance.reason: 'provided' | 'provided-missing' | 'quotes-missing' | 'quotes-locked-or-crossed' | 'quote-midpoint' | 'quote-rule'; default: not declared - classificationProvenance.source: 'unavailable' | 'quotes' | 'provided'; default: not declared - contracts: number; default: not declared - directionalPremium: number; default: not declared - id: string | null; default: not declared - inputIndex: number; default: not declared — Position in the original input tape; ties preserve that order. - multiplier: number; default: not declared - premium: number; default: not declared - premiumSource: 'provided' | 'price-size-multiplier'; default: not declared - side: AggressorSide; default: not declared - timestampMs: number; default: not declared - type: OptionType; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type OptionFlowDriftResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.bucketMinutes: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.classificationSource: FlowClassificationSource; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.coverageMeaning: 'classified-premium-share-not-probability'; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.duplicatePolicy: 'reject-id-or-identical-idless-print'; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.heuristicRule: 'empty-low-coverage-volume-opposed-expansion-mixed'; default: not declared - assumptions.interval: '[open,min(close,asOf))'; default: not declared - assumptions.minimumClassificationCoverage: number; default: not declared - assumptions.model?: string; default: not declared - assumptions.multiplier: number; default: not declared - assumptions.orderPolicy: 'stable-timestamp-sort'; default: not declared - assumptions.premiumRule: 'provided-else-price-times-size-times-multiplier'; default: not declared - assumptions.priceOverlaySymbol: string | null; default: not declared - assumptions.priceRule: 'in-session-latest-before-bucket-end-no-backfill'; default: not declared - assumptions.priceTieBreak: 'underlying-trade-then-quote-then-option-trade-last-input'; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.sessionDate: string; default: not declared - assumptions.symbol: string | null; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.timezone: string; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.unknownPolicy: 'zero-drift-full-premium-bounds'; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: OptionFlowDriftValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.buckets: OptionFlowDriftBucket[]; default: not declared — The same tape aggregated into config.bucketMinutes intervals. - value.minutes: OptionFlowDriftBucket[]; default: not declared — All elapsed session minutes, including leading/interior/trailing empties. - value.session: { closeTimestampMs: number | null; date: string; endTimestampMs: number | null; isBusinessDay: boolean; isHalfDay: boolean; openTimestampMs: number | null; }; default: not declared - value.session.closeTimestampMs: number | null; default: not declared - value.session.date: string; default: not declared - value.session.endTimestampMs: number | null; default: not declared — Effective exclusive cutoff, clamped to this session; null on closed dates. - value.session.isBusinessDay: boolean; default: not declared - value.session.isHalfDay: boolean; default: not declared - value.session.openTimestampMs: number | null; default: not declared - value.summary: OptionFlowDriftTotals; default: not declared - value.summary.bearishPremium: number; default: not declared - value.summary.bearishVolume: number; default: not declared - value.summary.bullishPremium: number; default: not declared - value.summary.bullishVolume: number; default: not declared - value.summary.callBounds: [number, number]; default: not declared — Worst-case sign-assignment bounds from unknown premium, NOT confidence intervals. - value.summary.callBuyPremium: number; default: not declared - value.summary.callDrift: number; default: not declared — Call buys minus call sells. - value.summary.callPremium: number; default: not declared - value.summary.callSellPremium: number; default: not declared - value.summary.callUnknownPremium: number; default: not declared - value.summary.classificationCoverage: number | null; default: not declared — classifiedPremium / totalPremium; null at zero premium. NOT a probability. - value.summary.classifiedPremium: number; default: not declared - value.summary.classifiedTradeCount: number; default: not declared - value.summary.heuristic: OptionFlowDriftHeuristic; default: not declared — Same-window premium/volume rule. See the function's documentation for precedence. - value.summary.netDirectionalBounds: [number, number]; default: not declared - value.summary.netDirectionalDrift: number; default: not declared — callDrift - putDrift. No delta, gamma, charm, vanna, or income projection. - value.summary.netDirectionalVolume: number; default: not declared - value.summary.putBounds: [number, number]; default: not declared - value.summary.putBuyPremium: number; default: not declared - value.summary.putDrift: number; default: not declared — Put buys minus put sells (positive put drift is bearish in the directional mapping). - value.summary.putPremium: number; default: not declared - value.summary.putSellPremium: number; default: not declared - value.summary.putUnknownPremium: number; default: not declared - value.summary.totalPremium: number; default: not declared - value.summary.totalVolume: number; default: not declared - value.summary.tradeCount: number; default: not declared - value.summary.unknownPremium: number; default: not declared - value.summary.unknownTradeCount: number; default: not declared - value.summary.unknownVolume: number; default: not declared - value.summary.volumeConfirmation: OptionFlowVolumeConfirmation; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftSession Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftSession { /** Explicit ISO YYYY-MM-DD in the calendar's timezone; never inferred from the tape. */ date: string; /** Default NYSE. Accepts core Calendar or calendars.TradingCalendar, including half-days. */ calendar?: Calendar; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calendar?: Calendar; default: not declared — Default NYSE. Accepts core Calendar or calendars.TradingCalendar, including half-days. - calendar.addBusinessDays: (date: string, days: number) => string; default: not declared - calendar.addBusinessDays(date): string; default: not declared - calendar.addBusinessDays(days): number; default: not declared - calendar.businessDaysBetween: (from: string, to: string) => number; default: not declared — Business days in the half-open interval `(from, to]` (negative if `to < from`). - calendar.businessDaysBetween(from): string; default: not declared - calendar.businessDaysBetween(to): string; default: not declared - calendar.isBusinessDay: (date: string) => boolean; default: not declared - calendar.isBusinessDay(date): string; default: not declared - calendar.isHalfDay: (date: string) => boolean; default: not declared - calendar.isHalfDay(date): string; default: not declared - calendar.isHoliday: (date: string) => boolean; default: not declared - calendar.isHoliday(date): string; default: not declared - calendar.name: string; default: not declared - calendar.nextBusinessDay: (date: string) => string; default: not declared - calendar.nextBusinessDay(date): string; default: not declared - calendar.previousBusinessDay: (date: string) => string; default: not declared - calendar.previousBusinessDay(date): string; default: not declared - calendar.session: (date: string) => import('@insiderfinance/totalfinance/core').DaySession; default: not declared - calendar.session().return.close?: string; default: not declared — Local `HH:MM` close (early close on half days). - calendar.session().return.date: string; default: not declared - calendar.session().return.isBusinessDay: boolean; default: not declared - calendar.session().return.isHalfDay: boolean; default: not declared - calendar.session().return.open?: string; default: not declared — Local `HH:MM` open (present only on business days). - calendar.session(date): string; default: not declared - calendar.timezone: string; default: not declared - calendar.version: string; default: not declared - date: string; default: not declared — Explicit ISO YYYY-MM-DD in the calendar's timezone; never inferred from the tape. ### @insiderfinance/totalfinance/structure#OptionFlowDriftTotals Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). All premiums are raw currency amounts; all volumes are contract counts (not shares). ```typescript /** All premiums are raw currency amounts; all volumes are contract counts (not shares). */ export interface OptionFlowDriftTotals { callBuyPremium: number; callSellPremium: number; putBuyPremium: number; putSellPremium: number; callUnknownPremium: number; putUnknownPremium: number; callPremium: number; putPremium: number; bullishPremium: number; bearishPremium: number; classifiedPremium: number; unknownPremium: number; totalPremium: number; /** Call buys minus call sells. */ callDrift: number; /** Put buys minus put sells (positive put drift is bearish in the directional mapping). */ putDrift: number; /** callDrift - putDrift. No delta, gamma, charm, vanna, or income projection. */ netDirectionalDrift: number; /** Worst-case sign-assignment bounds from unknown premium, NOT confidence intervals. */ callBounds: [ number, number ]; putBounds: [ number, number ]; netDirectionalBounds: [ number, number ]; /** classifiedPremium / totalPremium; null at zero premium. NOT a probability. */ classificationCoverage: number | null; bullishVolume: number; bearishVolume: number; unknownVolume: number; totalVolume: number; netDirectionalVolume: number; tradeCount: number; classifiedTradeCount: number; unknownTradeCount: number; volumeConfirmation: OptionFlowVolumeConfirmation; /** Same-window premium/volume rule. See the function's documentation for precedence. */ heuristic: OptionFlowDriftHeuristic; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bearishPremium: number; default: not declared - bearishVolume: number; default: not declared - bullishPremium: number; default: not declared - bullishVolume: number; default: not declared - callBounds: [number, number]; default: not declared — Worst-case sign-assignment bounds from unknown premium, NOT confidence intervals. - callBuyPremium: number; default: not declared - callDrift: number; default: not declared — Call buys minus call sells. - callPremium: number; default: not declared - callSellPremium: number; default: not declared - callUnknownPremium: number; default: not declared - classificationCoverage: number | null; default: not declared — classifiedPremium / totalPremium; null at zero premium. NOT a probability. - classifiedPremium: number; default: not declared - classifiedTradeCount: number; default: not declared - heuristic: OptionFlowDriftHeuristic; default: not declared — Same-window premium/volume rule. See the function's documentation for precedence. - netDirectionalBounds: [number, number]; default: not declared - netDirectionalDrift: number; default: not declared — callDrift - putDrift. No delta, gamma, charm, vanna, or income projection. - netDirectionalVolume: number; default: not declared - putBounds: [number, number]; default: not declared - putBuyPremium: number; default: not declared - putDrift: number; default: not declared — Put buys minus put sells (positive put drift is bearish in the directional mapping). - putPremium: number; default: not declared - putSellPremium: number; default: not declared - putUnknownPremium: number; default: not declared - totalPremium: number; default: not declared - totalVolume: number; default: not declared - tradeCount: number; default: not declared - unknownPremium: number; default: not declared - unknownTradeCount: number; default: not declared - unknownVolume: number; default: not declared - volumeConfirmation: OptionFlowVolumeConfirmation; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftTrade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical epoch-ms print, optionally carrying a caller-normalized, tape-wide unique ID. ```typescript /** Canonical epoch-ms print, optionally carrying a caller-normalized, tape-wide unique ID. */ export interface OptionFlowDriftTrade extends OptionTrade { /** Repeated IDs fail, even across symbols. Namespace provider/venue IDs before combining feeds. */ id?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggressorSide?: 'buy' | 'sell' | 'unknown'; default: not declared - ask?: number; default: not declared - askSize?: number; default: not declared - bid?: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - contract: import('@insiderfinance/totalfinance/core').OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: OptionType; default: not declared - contract.underlying: string; default: not declared - exchange?: string; default: not declared - greeks?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeks; default: not declared — Per-share Greeks in display units, when the source (or `chainGreeks`) supplied them. - greeks.delta: number; default: not declared - greeks.gamma?: number; default: not declared - greeks.provenance?: import('@insiderfinance/totalfinance/core').OptionQuoteGreeksProvenance; default: not declared - greeks.provenance.model?: string; default: not declared — The pricing model behind them when known, e.g. `'black-scholes-merton'`. - greeks.provenance.source: string; default: not declared — The provider or model that produced them, e.g. `'vendor-feed-v2'` or `'chainGreeks'`. - greeks.provenance.timestampMs?: number; default: not declared — When the Greeks were observed or computed (epoch ms). - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - id?: string; default: not declared — Repeated IDs fail, even across symbols. Namespace provider/venue IDs before combining feeds. - impliedVolatility?: number; default: not declared - last?: number; default: not declared - mark?: number; default: not declared - mid?: number; default: not declared - notional?: number; default: not declared - openInterest?: number; default: not declared - openingLikely?: boolean; default: not declared - premium?: number; default: not declared - price: number; default: not declared - sequence?: number; default: not declared - size: number; default: not declared - timestampMs: number; default: not declared - underlyingPrice?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowDriftValue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowDriftValue { session: { date: string; isBusinessDay: boolean; isHalfDay: boolean; openTimestampMs: number | null; closeTimestampMs: number | null; /** Effective exclusive cutoff, clamped to this session; null on closed dates. */ endTimestampMs: number | null; }; /** All elapsed session minutes, including leading/interior/trailing empties. */ minutes: OptionFlowDriftBucket[]; /** The same tape aggregated into config.bucketMinutes intervals. */ buckets: OptionFlowDriftBucket[]; summary: OptionFlowDriftTotals; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buckets: OptionFlowDriftBucket[]; default: not declared — The same tape aggregated into config.bucketMinutes intervals. - minutes: OptionFlowDriftBucket[]; default: not declared — All elapsed session minutes, including leading/interior/trailing empties. - session: { date: string; isBusinessDay: boolean; isHalfDay: boolean; openTimestampMs: number | null; closeTimestampMs: number | null; endTimestampMs: number | null; }; default: not declared - session.closeTimestampMs: number | null; default: not declared - session.date: string; default: not declared - session.endTimestampMs: number | null; default: not declared — Effective exclusive cutoff, clamped to this session; null on closed dates. - session.isBusinessDay: boolean; default: not declared - session.isHalfDay: boolean; default: not declared - session.openTimestampMs: number | null; default: not declared - summary: OptionFlowDriftTotals; default: not declared - summary.bearishPremium: number; default: not declared - summary.bearishVolume: number; default: not declared - summary.bullishPremium: number; default: not declared - summary.bullishVolume: number; default: not declared - summary.callBounds: [number, number]; default: not declared — Worst-case sign-assignment bounds from unknown premium, NOT confidence intervals. - summary.callBuyPremium: number; default: not declared - summary.callDrift: number; default: not declared — Call buys minus call sells. - summary.callPremium: number; default: not declared - summary.callSellPremium: number; default: not declared - summary.callUnknownPremium: number; default: not declared - summary.classificationCoverage: number | null; default: not declared — classifiedPremium / totalPremium; null at zero premium. NOT a probability. - summary.classifiedPremium: number; default: not declared - summary.classifiedTradeCount: number; default: not declared - summary.heuristic: OptionFlowDriftHeuristic; default: not declared — Same-window premium/volume rule. See the function's documentation for precedence. - summary.netDirectionalBounds: [number, number]; default: not declared - summary.netDirectionalDrift: number; default: not declared — callDrift - putDrift. No delta, gamma, charm, vanna, or income projection. - summary.netDirectionalVolume: number; default: not declared - summary.putBounds: [number, number]; default: not declared - summary.putBuyPremium: number; default: not declared - summary.putDrift: number; default: not declared — Put buys minus put sells (positive put drift is bearish in the directional mapping). - summary.putPremium: number; default: not declared - summary.putSellPremium: number; default: not declared - summary.putUnknownPremium: number; default: not declared - summary.totalPremium: number; default: not declared - summary.totalVolume: number; default: not declared - summary.tradeCount: number; default: not declared - summary.unknownPremium: number; default: not declared - summary.unknownTradeCount: number; default: not declared - summary.unknownVolume: number; default: not declared - summary.volumeConfirmation: OptionFlowVolumeConfirmation; default: not declared ### @insiderfinance/totalfinance/structure#OptionFlowPriceOverlay Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OptionFlowPriceOverlay { /** Required for an explicit overlay, especially in marketwide mode. Exact, case-sensitive. */ symbol: string; /** Contemporaneously available quotes; non-crossed, positive bid/ask midpoint is used. */ quotes?: readonly Quote[]; /** Contemporaneously available underlying trades; use their price, not an option price. */ trades?: readonly Trade[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - quotes?: readonly Quote[]; default: not declared — Contemporaneously available quotes; non-crossed, positive bid/ask midpoint is used. - symbol: string; default: not declared — Required for an explicit overlay, especially in marketwide mode. Exact, case-sensitive. - trades?: readonly Trade[]; default: not declared — Contemporaneously available underlying trades; use their price, not an option price. ### @insiderfinance/totalfinance/structure#OptionFlowVolumeConfirmation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Descriptive sign agreement, NOT evidence of predictive power. ```typescript /** Descriptive sign agreement, NOT evidence of predictive power. */ export type OptionFlowVolumeConfirmation = 'aligned' | 'opposed' | 'none'; ``` ### @insiderfinance/totalfinance/structure#PossibleExposureMetrics Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The metrics an `exposure()` call MAY have computed: every metric unless a selection narrows them. ```typescript /** The metrics an `exposure()` call MAY have computed: every metric unless a selection narrows them. */ export type PossibleExposureMetrics = undefined extends S ? ExposureMetric : NonNullable[number]; ``` ### @insiderfinance/totalfinance/structure#PossibleSuppliedExposureMetrics Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The metrics a selection may have computed. ```typescript /** The metrics a selection may have computed. */ export type PossibleSuppliedExposureMetrics = undefined extends S ? SuppliedExposureMetric : NonNullable[number]; ``` ### @insiderfinance/totalfinance/structure#RankByKey Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RankByKey = 'premium' | 'size' | 'netPremium' | 'volumeOpenInterestRatio'; ``` ### @insiderfinance/totalfinance/structure#RankOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RankOptions { /** Ranking metric (default `'premium'`). */ by?: RankByKey; /** Exclude groups below this aggregate premium. */ minPremium?: number; /** Exclude groups below this volume/open-interest ratio. */ minVolumeOpenInterestRatio?: number; /** Maximum returned groups; a non-negative safe integer. Omit for every group. */ limit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - by?: RankByKey; default: not declared — Ranking metric (default `'premium'`). - limit?: number; default: not declared — Maximum returned groups; a non-negative safe integer. Omit for every group. - minPremium?: number; default: not declared — Exclude groups below this aggregate premium. - minVolumeOpenInterestRatio?: number; default: not declared — Exclude groups below this volume/open-interest ratio. ### @insiderfinance/totalfinance/structure#ScenarioCell Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A scenario-grid cell carrying ONLY the requested metrics (WS2.4), plus its grid coordinates. ```typescript /** A scenario-grid cell carrying ONLY the requested metrics (WS2.4), plus its grid coordinates. */ export type ScenarioCell = { spot: number; volatilityShock: number; timeAdvance: number; } & Pick; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - spot: number; default: not declared - timeAdvance: number; default: not declared - volatilityShock: number; default: not declared ### @insiderfinance/totalfinance/structure#ScenarioMap Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioMap { cells: ScenarioCell[]; metrics: M[]; /** Total greek recomputations performed (for the acceleration-need benchmark). */ evaluations: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cells: ScenarioCell[]; default: not declared - evaluations: number; default: not declared — Total greek recomputations performed (for the acceleration-need benchmark). - metrics: M[]; default: not declared ### @insiderfinance/totalfinance/structure#ScenarioMapOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ScenarioMapOptions { /** Spot grid: explicit prices, or `{ from, to, steps }`. Defaults to ±10% around spot, 41 steps. */ spot?: number[] | { from: number; to: number; steps: number; }; /** Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. */ volatilityShock?: number[]; /** Years to advance time (reducing each T), e.g. `[0, 1/365]`. Default `[0]`. */ timeAdvance?: number[]; /** Which metrics to compute. Default `['gex','dex','vanna','charm']`. */ metrics?: readonly M[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - metrics?: readonly M[]; default: not declared — Which metrics to compute. Default `['gex','dex','vanna','charm']`. - spot?: number[] | { from: number; steps: number; to: number; }; default: not declared — Spot grid: explicit prices, or `{ from, to, steps }`. Defaults to ±10% around spot, 41 steps. - spot.from: number; default: not declared - spot.steps: number; default: not declared - spot.to: number; default: not declared - timeAdvance?: number[]; default: not declared — Years to advance time (reducing each T), e.g. `[0, 1/365]`. Default `[0]`. - volatilityShock?: number[]; default: not declared — Additive vol shocks (decimal), e.g. `[-0.05, 0, 0.05]`. Default `[0]`. ### @insiderfinance/totalfinance/structure#Spread Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Spread { id: number; underlying: string; timestampMs: number; legs: number; /** Net premium: positive = net debit (bought), negative = net credit (sold). */ netPremium: number; /** * True only if EVERY leg's aggressor side was estimable (buy/sell). When false, an `unknown`-side * leg was excluded from `netPremium`, so the net direction is partial — do not read it as signed. */ directionKnown: boolean; contracts: Array<{ type: OptionType; strike: number; expiry: string; size: number; side: AggressorSide; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contracts: { type: OptionType; strike: number; expiry: string; size: number; side: AggressorSide; }[]; default: not declared - directionKnown: boolean; default: not declared — True only if EVERY leg's aggressor side was estimable (buy/sell). When false, an `unknown`-side leg was excluded from `netPremium`, so the net direction is partial — do not read it as signed. - id: number; default: not declared - legs: number; default: not declared - netPremium: number; default: not declared — Net premium: positive = net debit (bought), negative = net credit (sold). - timestampMs: number; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/structure#StrikeRow Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A by-strike row narrowed to the requested metrics: only the selected `M` keys are present (WS2.4), never a zero-filled full set. `StrikeRow` with no type argument is the full-metrics row. When `M` includes `'gex'` the row additionally carries the {@link GexSplit} call/put columns (WS4.5); when it does not, the conditional intersects with `unknown` (a no-op) so non-gex rows stay lean. ```typescript /** * A by-strike row narrowed to the requested metrics: only the selected `M` keys are present (WS2.4), * never a zero-filled full set. `StrikeRow` with no type argument is the full-metrics row. When `M` * includes `'gex'` the row additionally carries the {@link GexSplit} call/put columns (WS4.5); when it * does not, the conditional intersects with `unknown` (a no-op) so non-gex rows stay lean. */ export type StrikeRow = { strike: number; } & Pick & ('gex' extends M ? GexSplit : unknown); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - strike: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SuppliedExposureAssumptions = Assumptions<{ greekSource: 'supplied'; suppliedDeltaUnit: 'priceDeltaPerUnderlyingUnit'; suppliedGammaUnit: 'deltaPerSpotPoint'; suppliedGreekSignPolicy: 'signed-as-provided'; currencyPolicy: 'caller-aligned-single-currency-no-fx-conversion'; gammaUnit: GammaUnit; dexUnit: 'dollarDelta'; gexConvention: SuppliedExposurePositionConvention; dexConvention: SuppliedExposurePositionConvention; maximumObservationAgeMs: number; defaultMultiplier: number | null; market: SuppliedExposureMarket & { asOf: number; }; scenarioRepricing: 'unavailable'; aggregationPolicy: 'additive-input-rows-no-deduplication'; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregationPolicy: 'additive-input-rows-no-deduplication'; default: not declared - asOf?: number; default: not declared - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - conventionsVersion: string; default: not declared - currencyPolicy: 'caller-aligned-single-currency-no-fx-conversion'; default: not declared - dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - defaultMultiplier: number | null; default: not declared - dexConvention: SuppliedExposurePositionConvention; default: not declared - dexConvention.calls: 1 | -1; default: not declared - dexConvention.puts: 1 | -1; default: not declared - dexUnit: 'dollarDelta'; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - gammaUnit: GammaUnit; default: not declared - gexConvention: SuppliedExposurePositionConvention; default: not declared - gexConvention.calls: 1 | -1; default: not declared - gexConvention.puts: 1 | -1; default: not declared - greekSource: 'supplied'; default: not declared - market: SuppliedExposureMarket & { asOf: number; }; default: not declared - market.asOf: (number) | (string | number); default: not declared — Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. - market.source: string; default: not declared - market.spot: number; default: not declared - market.timestampMs: number; default: not declared - market.underlying: string; default: not declared - maximumObservationAgeMs: number; default: not declared - model?: string; default: not declared - scenarioRepricing: 'unavailable'; default: not declared - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - suppliedDeltaUnit: 'priceDeltaPerUnderlyingUnit'; default: not declared - suppliedGammaUnit: 'deltaPerSpotPoint'; default: not declared - suppliedGreekSignPolicy: 'signed-as-provided'; default: not declared - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureAssumptionsFor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Assumptions of a report that computed `G` (and possibly `P`): the GEX unit and convention echoes only with `gex`, the DEX ones only with `dex`, plus `metrics` when a selection was passed. ```typescript /** * Assumptions of a report that computed `G` (and possibly `P`): the GEX unit and convention echoes * only with `gex`, the DEX ones only with `dex`, plus `metrics` when a selection was passed. */ export type SuppliedExposureAssumptionsFor = Omit & MetricFields<'gex', G, P, Pick> & MetricFields<'dex', G, P, Pick> & { /** The selection as passed; present only when `metrics` was passed. */ metrics?: readonly SuppliedExposureMetric[]; /** The `breakdowns` flag as passed; present only when it was passed. */ breakdowns?: boolean; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregationPolicy: 'additive-input-rows-no-deduplication'; default: not declared - asOf?: number; default: not declared - breakdowns?: boolean; default: not declared — The `breakdowns` flag as passed; present only when it was passed. - calendar?: string; default: not declared - calendarVersion?: string; default: not declared - compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - conventionsVersion: string; default: not declared - currencyPolicy: 'caller-aligned-single-currency-no-fx-conversion'; default: not declared - dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - defaultMultiplier: number | null; default: not declared - dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - engine?: string; default: not declared - expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - greekSource: 'supplied'; default: not declared - market: SuppliedExposureMarket & { asOf: number; }; default: not declared - market.asOf: (number) | (string | number); default: not declared — Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. - market.source: string; default: not declared - market.spot: number; default: not declared - market.timestampMs: number; default: not declared - market.underlying: string; default: not declared - maximumObservationAgeMs: number; default: not declared - metrics?: readonly SuppliedExposureMetric[]; default: not declared — The selection as passed; present only when `metrics` was passed. - model?: string; default: not declared - scenarioRepricing: 'unavailable'; default: not declared - seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - suppliedGreekSignPolicy: 'signed-as-provided'; default: not declared - timeToExpiryConvention?: never; default: not declared - timeToExpiryYears?: number; default: not declared - units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureBreakdownsFor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `byStrike` and `byExpiry` breakdowns of a report, by the request's `breakdowns` flag: present when it is omitted or `true` (the released report), absent for `false`, and optional when the flag is a runtime `boolean` the type cannot know. ```typescript /** * The `byStrike` and `byExpiry` breakdowns of a report, by the request's `breakdowns` flag: present * when it is omitted or `true` (the released report), absent for `false`, and optional when the flag * is a runtime `boolean` the type cannot know. */ export type SuppliedExposureBreakdownsFor = [ B ] extends [ false ] ? unknown : [ B ] extends [ true | undefined ] ? { byStrike: Array & { strike: number; }>; /** Groups economically identical expiry instants, even when labels use different time zones. */ byExpiry: Array & { expiry: string; expiresAt: number; }>; } : { byStrike?: Array & { strike: number; }>; byExpiry?: Array & { expiry: string; expiresAt: number; }>; }; ``` ### @insiderfinance/totalfinance/structure#SuppliedExposureConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed controls. No rate, dividend, pricing-model, or scenario knobs are accepted. ```typescript /** Closed controls. No rate, dividend, pricing-model, or scenario knobs are accepted. */ export interface SuppliedExposureConfig { gexConvention: SuppliedExposurePositionConvention; dexConvention: SuppliedExposurePositionConvention; /** Output GEX unit: dollar-delta change per +1% spot move or per +1 spot-price point. */ gammaUnit: GammaUnit; /** Inclusive maximum age of quote, Greek, and spot observations, in milliseconds. */ maximumObservationAgeMs: number; /** Explicit fallback only; otherwise every contract must supply a positive multiplier. */ defaultMultiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - defaultMultiplier?: number; default: not declared — Explicit fallback only; otherwise every contract must supply a positive multiplier. - dexConvention: SuppliedExposurePositionConvention; default: not declared - dexConvention.calls: 1 | -1; default: not declared - dexConvention.puts: 1 | -1; default: not declared - gammaUnit: GammaUnit; default: not declared — Output GEX unit: dollar-delta change per +1% spot move or per +1 spot-price point. - gexConvention: SuppliedExposurePositionConvention; default: not declared - gexConvention.calls: 1 | -1; default: not declared - gexConvention.puts: 1 | -1; default: not declared - maximumObservationAgeMs: number; default: not declared — Inclusive maximum age of quote, Greek, and spot observations, in milliseconds. ### @insiderfinance/totalfinance/structure#SuppliedExposureContribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SuppliedExposureContribution { /** Original row index; equal contract identities preserve input order. No implicit deduplication. */ inputIndex: number; /** Detached canonical identity and resolved multiplier; unrelated metadata is not copied. */ contract: OptionContract; source: string; timestampMs: number; greeks: SuppliedExposureGreeks | null; openInterest: number | null; multiplier: number; multiplierSource: 'contract' | 'config.defaultMultiplier'; gexSign: 1 | -1; dexSign: 1 | -1; included: boolean; exclusionReasons: SuppliedExposureExclusion[]; /** Null means excluded, not zero exposure. Units are echoed in assumptions. */ gex: number | null; dex: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared — Detached canonical identity and resolved multiplier; unrelated metadata is not copied. - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - dex: number | null; default: not declared - dexSign: 1 | -1; default: not declared - exclusionReasons: SuppliedExposureExclusion[]; default: not declared - gex: number | null; default: not declared — Null means excluded, not zero exposure. Units are echoed in assumptions. - gexSign: 1 | -1; default: not declared - greeks: SuppliedExposureGreeks | null; default: not declared - greeks.delta: number; default: not declared — Signed price delta per underlying unit; never converted to an absolute put delta. - greeks.gamma: number; default: not declared — Signed change in delta per ONE spot-price point, not per 1% and not dollar gamma. - greeks.provenance: { model?: string; source: string; timestampMs: number; }; default: not declared - greeks.provenance.model?: string; default: not declared - greeks.provenance.source: string; default: not declared — Actual provider/model identifier, e.g. 'vendor-feed-v2' or 'bsm-2026-09'. - greeks.provenance.timestampMs: number; default: not declared — Actual Greek observation instant in epoch milliseconds, not report generation time. - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - included: boolean; default: not declared - inputIndex: number; default: not declared — Original row index; equal contract identities preserve input order. No implicit deduplication. - multiplier: number; default: not declared - multiplierSource: 'contract' | 'config.defaultMultiplier'; default: not declared - openInterest: number | null; default: not declared - source: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureContributionFor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A contribution row of a report that computed `G` (and possibly `P`): the GEX sign and value only with `gex`, the DEX sign and value only with `dex`, and only the supplied Greeks that were read. With the defaults, {@link SuppliedExposureContribution}. ```typescript /** * A contribution row of a report that computed `G` (and possibly `P`): the GEX sign and value only * with `gex`, the DEX sign and value only with `dex`, and only the supplied Greeks that were read. * With the defaults, {@link SuppliedExposureContribution}. */ export type SuppliedExposureContributionFor = Omit & { greeks: ({ provenance: SuppliedExposureGreeks['provenance']; } & MetricFields<'gex', G, P, { gamma: number; }> & MetricFields<'dex', G, P, { delta: number; }>) | null; } & MetricFields<'gex', G, P, Pick> & MetricFields<'dex', G, P, Pick>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contract: OptionContract; default: not declared — Detached canonical identity and resolved multiplier; unrelated metadata is not copied. - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - exclusionReasons: SuppliedExposureExclusion[]; default: not declared - greeks: ({ provenance: SuppliedExposureGreeks['provenance']; } & MetricFields<'gex', G, P, { gamma: number; }> & MetricFields<'dex', G, P, { delta: number; }>) | null; default: not declared - included: boolean; default: not declared - inputIndex: number; default: not declared — Original row index; equal contract identities preserve input order. No implicit deduplication. - multiplier: number; default: not declared - multiplierSource: 'contract' | 'config.defaultMultiplier'; default: not declared - openInterest: number | null; default: not declared - source: string; default: not declared - timestampMs: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureExclusion Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SuppliedExposureExclusion = 'missingGreeks' | 'missingOpenInterest' | 'expired' | 'staleQuote' | 'futureQuote' | 'staleGreeks' | 'futureGreeks' | 'staleMarket' | 'futureMarket'; ``` ### @insiderfinance/totalfinance/structure#SuppliedExposureGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Open observation: the core chain row's Greeks (`OptionQuote.greeks`) with `gamma` and the provenance REQUIRED. Delta and gamma are NOT multiplied by open interest or contract multiplier. ```typescript /** * Open observation: the core chain row's Greeks (`OptionQuote.greeks`) with `gamma` and the * provenance REQUIRED. Delta and gamma are NOT multiplied by open interest or contract multiplier. */ export interface SuppliedExposureGreeks extends OptionQuoteGreeks { /** Signed price delta per underlying unit; never converted to an absolute put delta. */ delta: number; /** Signed change in delta per ONE spot-price point, not per 1% and not dollar gamma. */ gamma: number; provenance: { /** Actual provider/model identifier, e.g. 'vendor-feed-v2' or 'bsm-2026-09'. */ source: string; /** Actual Greek observation instant in epoch milliseconds, not report generation time. */ timestampMs: number; model?: string; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared — Signed price delta per underlying unit; never converted to an absolute put delta. - gamma: number; default: not declared — Signed change in delta per ONE spot-price point, not per 1% and not dollar gamma. - provenance: { source: string; timestampMs: number; model?: string; }; default: not declared - provenance.model?: string; default: not declared - provenance.source: string; default: not declared — Actual provider/model identifier, e.g. 'vendor-feed-v2' or 'bsm-2026-09'. - provenance.timestampMs: number; default: not declared — Actual Greek observation instant in epoch milliseconds, not report generation time. - rho?: number; default: not declared - theta?: number; default: not declared - vega?: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The input of today's (both-metric) report, as released. ```typescript /** The input of today's (both-metric) report, as released. */ export interface SuppliedExposureInput { quotes: readonly SuppliedExposureQuote[]; market: SuppliedExposureMarket; config: SuppliedExposureConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config: SuppliedExposureConfig; default: not declared - config.defaultMultiplier?: number; default: not declared — Explicit fallback only; otherwise every contract must supply a positive multiplier. - config.dexConvention: SuppliedExposurePositionConvention; default: not declared - config.dexConvention.calls: 1 | -1; default: not declared - config.dexConvention.puts: 1 | -1; default: not declared - config.gammaUnit: GammaUnit; default: not declared — Output GEX unit: dollar-delta change per +1% spot move or per +1 spot-price point. - config.gexConvention: SuppliedExposurePositionConvention; default: not declared - config.gexConvention.calls: 1 | -1; default: not declared - config.gexConvention.puts: 1 | -1; default: not declared - config.maximumObservationAgeMs: number; default: not declared — Inclusive maximum age of quote, Greek, and spot observations, in milliseconds. - market: SuppliedExposureMarket; default: not declared - market.asOf: string | number; default: not declared — Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. - market.source: string; default: not declared - market.spot: number; default: not declared - market.timestampMs: number; default: not declared - market.underlying: string; default: not declared - quotes: readonly SuppliedExposureQuote[]; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Open spot observation plus an explicit report cutoff; all quotes must name this underlying. ```typescript /** Open spot observation plus an explicit report cutoff; all quotes must name this underlying. */ export interface SuppliedExposureMarket { underlying: string; spot: number; source: string; timestampMs: number; /** Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. */ asOf: number | string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. - source: string; default: not declared - spot: number; default: not declared - timestampMs: number; default: not declared - underlying: string; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureMetric Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The supplied-Greek exposures {@link exposureFromGreeks} can select. ```typescript /** The supplied-Greek exposures {@link exposureFromGreeks} can select. */ export type SuppliedExposureMetric = 'gex' | 'dex'; ``` ### @insiderfinance/totalfinance/structure#SuppliedExposurePositionConvention Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicit OI-position signs, applied ONCE to the supplied signed Greek, independently per metric. ```typescript /** Explicit OI-position signs, applied ONCE to the supplied signed Greek, independently per metric. */ export interface SuppliedExposurePositionConvention { calls: 1 | -1; puts: 1 | -1; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calls: 1 | -1; default: not declared - puts: 1 | -1; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical OptionQuote with independently sourced Greeks; harmless decoration is accepted. ```typescript /** Canonical OptionQuote with independently sourced Greeks; harmless decoration is accepted. */ export interface SuppliedExposureQuote extends OptionQuote { /** Actual source of this quote/open-interest snapshot. */ source: string; /** Omit when unavailable. Missing Greeks exclude the row; they are never recomputed. */ greeks?: SuppliedExposureGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ask?: number; default: not declared - askSize?: number; default: not declared - bid?: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - exchange?: string; default: not declared - greeks?: SuppliedExposureGreeks; default: not declared — Omit when unavailable. Missing Greeks exclude the row; they are never recomputed. - greeks.delta: number; default: not declared — Signed price delta per underlying unit; never converted to an absolute put delta. - greeks.gamma: number; default: not declared — Signed change in delta per ONE spot-price point, not per 1% and not dollar gamma. - greeks.provenance: { model?: string; source: string; timestampMs: number; }; default: not declared - greeks.provenance.model?: string; default: not declared - greeks.provenance.source: string; default: not declared — Actual provider/model identifier, e.g. 'vendor-feed-v2' or 'bsm-2026-09'. - greeks.provenance.timestampMs: number; default: not declared — Actual Greek observation instant in epoch milliseconds, not report generation time. - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - impliedVolatility?: number; default: not declared - last?: number; default: not declared - mark?: number; default: not declared - mid?: number; default: not declared - openInterest?: number; default: not declared - source: string; default: not declared — Actual source of this quote/open-interest snapshot. - timestampMs: number; default: not declared - underlyingPrice?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain JSON-safe analysis report, directly compatible with saved-analysis report grammar. `G`/`P` follow the `metrics` selection (guaranteed/possible metrics); both default to GEX and DEX, today's report. A GEX+DEX report requires BOTH supplied Greeks on every row that supplies Greeks, so the two metrics are always computed over the same included rows. `B` is the `breakdowns` flag ({@link SuppliedExposureBreakdownsFor}); by default the report carries both breakdowns. ```typescript /** * Plain JSON-safe analysis report, directly compatible with saved-analysis report grammar. * * `G`/`P` follow the `metrics` selection (guaranteed/possible metrics); both default to GEX and DEX, * today's report. A GEX+DEX report requires BOTH supplied Greeks on every row that supplies Greeks, * so the two metrics are always computed over the same included rows. `B` is the `breakdowns` flag * ({@link SuppliedExposureBreakdownsFor}); by default the report carries both breakdowns. */ export type SuppliedExposureReport = { contributions: SuppliedExposureContributionFor[]; aggregate: SuppliedExposureTotalsFor; } & SuppliedExposureBreakdownsFor & { coverage: { scope: 'suppliedQuotesOnly'; status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; totalQuotes: number; includedQuotes: number; excludedQuotes: number; /** Included / supplied rows; null for an empty chain. Not coverage of an unknown full universe. */ fraction: number | null; /** Rows beyond the first matching underlying/type/style/strike/expiry instant, across sources/times. */ duplicateContractQuotes: number; /** Included rows beyond the first included matching identity; these can double-count OI. */ duplicateIncludedContractQuotes: number; /** Counts overlap when a row has several reasons. */ exclusionCounts: Record; }; assumptions: SuppliedExposureAssumptionsFor; diagnostics: Diagnostics; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregate: SuppliedExposureTotalsFor; default: not declared - aggregate.callOpenInterest: number; default: not declared - aggregate.includedQuotes: number; default: not declared - aggregate.openInterest: number; default: not declared - aggregate.putOpenInterest: number; default: not declared - assumptions: SuppliedExposureAssumptionsFor; default: not declared - assumptions.aggregationPolicy: 'additive-input-rows-no-deduplication'; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.breakdowns?: boolean; default: not declared — The `breakdowns` flag as passed; present only when it was passed. - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.currencyPolicy: 'caller-aligned-single-currency-no-fx-conversion'; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.defaultMultiplier: number | null; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.greekSource: 'supplied'; default: not declared - assumptions.market: SuppliedExposureMarket & { asOf: number; }; default: not declared - assumptions.market.asOf: (number) | (string | number); default: not declared — Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. - assumptions.market.source: string; default: not declared - assumptions.market.spot: number; default: not declared - assumptions.market.timestampMs: number; default: not declared - assumptions.market.underlying: string; default: not declared - assumptions.maximumObservationAgeMs: number; default: not declared - assumptions.metrics?: readonly SuppliedExposureMetric[]; default: not declared — The selection as passed; present only when `metrics` was passed. - assumptions.model?: string; default: not declared - assumptions.scenarioRepricing: 'unavailable'; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.suppliedGreekSignPolicy: 'signed-as-provided'; default: not declared - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - contributions: SuppliedExposureContributionFor[]; default: not declared - coverage: { duplicateContractQuotes: number; duplicateIncludedContractQuotes: number; excludedQuotes: number; exclusionCounts: Record; fraction: number | null; includedQuotes: number; scope: 'suppliedQuotesOnly'; status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; totalQuotes: number; }; default: not declared - coverage.duplicateContractQuotes: number; default: not declared — Rows beyond the first matching underlying/type/style/strike/expiry instant, across sources/times. - coverage.duplicateIncludedContractQuotes: number; default: not declared — Included rows beyond the first included matching identity; these can double-count OI. - coverage.excludedQuotes: number; default: not declared - coverage.exclusionCounts: Record; default: not declared — Counts overlap when a row has several reasons. - coverage.fraction: number | null; default: not declared — Included / supplied rows; null for an empty chain. Not coverage of an unknown full universe. - coverage.includedQuotes: number; default: not declared - coverage.scope: 'suppliedQuotesOnly'; default: not declared - coverage.status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; default: not declared - coverage.totalQuotes: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). ### @insiderfinance/totalfinance/structure#SuppliedExposureRequest Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What `exposureFromGreeks` accepts: {@link SuppliedExposureInput} (which it always accepts) widened so a GEX-only or DEX-only selection can omit the other metric's Greek and controls. ```typescript /** * What `exposureFromGreeks` accepts: {@link SuppliedExposureInput} (which it always accepts) widened * so a GEX-only or DEX-only selection can omit the other metric's Greek and controls. */ export interface SuppliedExposureRequest { quotes: readonly SuppliedExposureRequestQuote[]; market: SuppliedExposureMarket; config: SuppliedExposureRequestConfig; /** * `['gex']`, `['dex']` or both. Omit for today's report (both). A GEX-only report needs only * supplied gamma, `gexConvention` and `gammaUnit`; a DEX-only report only supplied delta and * `dexConvention`. The unselected metric's fields are absent from the report, never zero. */ metrics?: S; /** * `false` leaves `byStrike` and `byExpiry` out of the report: no grouping and no per-group exact * totals, two thirds of the summation, for a caller that aggregates the contributions itself. * Omitted or `true`: the released report. Contributions, aggregate, coverage and diagnostics are * the same either way. */ breakdowns?: B; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - breakdowns?: B; default: not declared — `false` leaves `byStrike` and `byExpiry` out of the report: no grouping and no per-group exact totals, two thirds of the summation, for a caller that aggregates the contributions itself. Omitted or `true`: the released report. Contributions, aggregate, coverage and diagnostics are the same either way. - config: SuppliedExposureRequestConfig; default: not declared - config.defaultMultiplier?: number; default: not declared — Explicit fallback only; otherwise every contract must supply a positive multiplier. - config.dexConvention?: SuppliedExposurePositionConvention; default: not declared - config.dexConvention.calls: 1 | -1; default: not declared - config.dexConvention.puts: 1 | -1; default: not declared - config.gammaUnit?: GammaUnit; default: not declared - config.gexConvention?: SuppliedExposurePositionConvention; default: not declared - config.gexConvention.calls: 1 | -1; default: not declared - config.gexConvention.puts: 1 | -1; default: not declared - config.maximumObservationAgeMs: number; default: not declared — Inclusive maximum age of quote, Greek, and spot observations, in milliseconds. - market: SuppliedExposureMarket; default: not declared - market.asOf: string | number; default: not declared — Epoch ms, YYYY-MM-DD (UTC midnight), or a zoned ISO datetime. Never reads the clock. - market.source: string; default: not declared - market.spot: number; default: not declared - market.timestampMs: number; default: not declared - market.underlying: string; default: not declared - metrics?: S; default: not declared — `['gex']`, `['dex']` or both. Omit for today's report (both). A GEX-only report needs only supplied gamma, `gexConvention` and `gammaUnit`; a DEX-only report only supplied delta and `dexConvention`. The unselected metric's fields are absent from the report, never zero. - quotes: readonly SuppliedExposureRequestQuote[]; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureRequestConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The configuration `exposureFromGreeks` accepts. A selected metric's controls are required (checked at run time): `gexConvention` and `gammaUnit` for GEX, `dexConvention` for DEX, all three without a selection, exactly as {@link SuppliedExposureConfig} declares. An unselected metric's controls may be passed; they are shape-checked, not applied. ```typescript /** * The configuration `exposureFromGreeks` accepts. A selected metric's controls are required (checked * at run time): `gexConvention` and `gammaUnit` for GEX, `dexConvention` for DEX, all three without a * selection, exactly as {@link SuppliedExposureConfig} declares. An unselected metric's controls may * be passed; they are shape-checked, not applied. */ export interface SuppliedExposureRequestConfig extends Omit { gexConvention?: SuppliedExposurePositionConvention; dexConvention?: SuppliedExposurePositionConvention; gammaUnit?: GammaUnit; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - defaultMultiplier?: number; default: not declared — Explicit fallback only; otherwise every contract must supply a positive multiplier. - dexConvention?: SuppliedExposurePositionConvention; default: not declared - dexConvention.calls: 1 | -1; default: not declared - dexConvention.puts: 1 | -1; default: not declared - gammaUnit?: GammaUnit; default: not declared - gexConvention?: SuppliedExposurePositionConvention; default: not declared - gexConvention.calls: 1 | -1; default: not declared - gexConvention.puts: 1 | -1; default: not declared - maximumObservationAgeMs: number; default: not declared — Inclusive maximum age of quote, Greek, and spot observations, in milliseconds. ### @insiderfinance/totalfinance/structure#SuppliedExposureRequestGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The supplied Greeks `exposureFromGreeks` accepts on a quote. Which ones are required depends on `metrics`: both without a selection (exactly {@link SuppliedExposureGreeks}), gamma for `['gex']`, delta for `['dex']` — checked per row at run time with a typed `input.missing_field`. ```typescript /** * The supplied Greeks `exposureFromGreeks` accepts on a quote. Which ones are required depends on * `metrics`: both without a selection (exactly {@link SuppliedExposureGreeks}), gamma for `['gex']`, * delta for `['dex']` — checked per row at run time with a typed `input.missing_field`. */ export interface SuppliedExposureRequestGreeks extends Omit { /** Signed price delta per underlying unit. Required unless `metrics` is `['gex']`. */ delta?: number; /** Signed change in delta per ONE spot-price point. Required unless `metrics` is `['dex']`. */ gamma?: number; provenance: SuppliedExposureGreeks['provenance']; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta?: number; default: not declared — Signed price delta per underlying unit. Required unless `metrics` is `['gex']`. - gamma?: number; default: not declared — Signed change in delta per ONE spot-price point. Required unless `metrics` is `['dex']`. - provenance: { model?: string; source: string; timestampMs: number; }; default: not declared - provenance.model?: string; default: not declared - provenance.source: string; default: not declared — Actual provider/model identifier, e.g. 'vendor-feed-v2' or 'bsm-2026-09'. - provenance.timestampMs: number; default: not declared — Actual Greek observation instant in epoch milliseconds, not report generation time. - rho?: number; default: not declared - theta?: number; default: not declared - vega?: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureRequestQuote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A quote as `exposureFromGreeks` accepts it: {@link SuppliedExposureQuote} with selectable Greeks. ```typescript /** A quote as `exposureFromGreeks` accepts it: {@link SuppliedExposureQuote} with selectable Greeks. */ export interface SuppliedExposureRequestQuote extends Omit { /** Omit when unavailable. Missing Greeks exclude the row; they are never recomputed. */ greeks?: SuppliedExposureRequestGreeks; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ask?: number; default: not declared - askSize?: number; default: not declared - bid?: number; default: not declared - bidSize?: number; default: not declared - conditions?: string[]; default: not declared - contract: OptionContract; default: not declared - contract.adjusted?: boolean; default: not declared - contract.currency?: string; default: not declared - contract.deliverable?: import('@insiderfinance/totalfinance/core').Deliverable; default: not declared - contract.deliverable.cash?: number; default: not declared - contract.deliverable.notes?: string; default: not declared - contract.deliverable.shares?: { symbol: string; quantity: number; }[]; default: not declared - contract.exerciseTime?: import('@insiderfinance/totalfinance/core').ExerciseTime; default: not declared — AM- or PM-settled — settlement/display metadata. It does NOT move `expiresAt`: the expiry instant always comes from the `expiry` label and `expiryConvention`. Express an AM-settled index expiry as a zoned datetime (`'2026-09-18T09:30:00-04:00'`) when its instant matters. - contract.expiresAt: number; default: not declared — The exact expiration INSTANT the label resolved to (epoch ms), stamped by the builders at construction: a bare date resolves via the named `expiryConvention`; a zoned datetime is the caller's explicit instant. REQUIRED (E2, one expiry law): engines price against this resolution and cross-validate it against the label — an unresolved literal is not a contract; build one with the option builders. - contract.expiry: string; default: not declared — The expiry LABEL as supplied: `YYYY-MM-DD` (a calendar date) or a zoned ISO datetime. - contract.expiryConvention: 'us-equity-close' | 'explicit-instant'; default: not declared — HOW `expiry` resolved to `expiresAt` — named, never silent (spec P1.6/P3.4). - contract.multiplier?: number; default: not declared - contract.occSymbol?: string; default: not declared - contract.root?: string; default: not declared - contract.settlement?: import('@insiderfinance/totalfinance/core').Settlement; default: not declared - contract.strike: number; default: not declared - contract.style: import('@insiderfinance/totalfinance/core').OptionStyle; default: not declared — REQUIRED at build — never defaulted: US equity options are American, many index options European. - contract.type: import('@insiderfinance/totalfinance/core').OptionType; default: not declared - contract.underlying: string; default: not declared - exchange?: string; default: not declared - greeks?: SuppliedExposureRequestGreeks; default: not declared — Omit when unavailable. Missing Greeks exclude the row; they are never recomputed. - greeks.delta?: number; default: not declared — Signed price delta per underlying unit. Required unless `metrics` is `['gex']`. - greeks.gamma?: number; default: not declared — Signed change in delta per ONE spot-price point. Required unless `metrics` is `['dex']`. - greeks.provenance: { model?: string; source: string; timestampMs: number; }; default: not declared - greeks.provenance.model?: string; default: not declared - greeks.provenance.source: string; default: not declared — Actual provider/model identifier, e.g. 'vendor-feed-v2' or 'bsm-2026-09'. - greeks.provenance.timestampMs: number; default: not declared — Actual Greek observation instant in epoch milliseconds, not report generation time. - greeks.rho?: number; default: not declared - greeks.theta?: number; default: not declared - greeks.vega?: number; default: not declared - impliedVolatility?: number; default: not declared - last?: number; default: not declared - mark?: number; default: not declared - mid?: number; default: not declared - openInterest?: number; default: not declared - source: string; default: not declared — Actual source of this quote/open-interest snapshot. - timestampMs: number; default: not declared - underlyingPrice?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureTotals Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SuppliedExposureTotals { /** Net signed exposures across included rows only. An empty sum is NOT measured zero market exposure. */ gex: number; dex: number; /** Sum of absolute PER-ROW exposures, before any strike/expiry netting. */ grossGex: number; grossDex: number; callGex: number; putGex: number; callDex: number; putDex: number; openInterest: number; callOpenInterest: number; putOpenInterest: number; includedQuotes: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callDex: number; default: not declared - callGex: number; default: not declared - callOpenInterest: number; default: not declared - dex: number; default: not declared - gex: number; default: not declared — Net signed exposures across included rows only. An empty sum is NOT measured zero market exposure. - grossDex: number; default: not declared - grossGex: number; default: not declared — Sum of absolute PER-ROW exposures, before any strike/expiry netting. - includedQuotes: number; default: not declared - openInterest: number; default: not declared - putDex: number; default: not declared - putGex: number; default: not declared - putOpenInterest: number; default: not declared ### @insiderfinance/totalfinance/structure#SuppliedExposureTotalsFor Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Totals of a report that computed `G` (and possibly `P`); with the defaults, {@link SuppliedExposureTotals}. ```typescript /** Totals of a report that computed `G` (and possibly `P`); with the defaults, {@link SuppliedExposureTotals}. */ export type SuppliedExposureTotalsFor = Omit & MetricFields<'gex', G, P, Pick> & MetricFields<'dex', G, P, Pick>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - callOpenInterest: number; default: not declared - includedQuotes: number; default: not declared - openInterest: number; default: not declared - putOpenInterest: number; default: not declared ### @insiderfinance/totalfinance/structure#Sweep Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Sweep { id: number; underlying: string; strike: number; type: OptionType; expiry: string; side: AggressorSide; prints: number; size: number; premium: number; startTimestampMs: number; endTimestampMs: number; /** True only if THIS sweep's own prints spanned ≥2 exchanges; false for a timing-only cluster. */ venueVerified: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - endTimestampMs: number; default: not declared - expiry: string; default: not declared - id: number; default: not declared - premium: number; default: not declared - prints: number; default: not declared - side: AggressorSide; default: not declared - size: number; default: not declared - startTimestampMs: number; default: not declared - strike: number; default: not declared - type: OptionType; default: not declared - underlying: string; default: not declared - venueVerified: boolean; default: not declared — True only if THIS sweep's own prints spanned ≥2 exchanges; false for a timing-only cluster. ### @insiderfinance/totalfinance/structure#Unusualness Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Unusualness { /** `(value − mean) / stdev` of the baseline; `null` when the baseline is flat (no defined z). */ zScore: number | null; /** Percentile of `value` within the baseline, in `[0, 100]` (share strictly below). */ percentile: number; mean: number; /** Sample standard deviation of the baseline. */ stdev: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; baselineLength: number; }; /** Structured warnings; always present (possibly empty) — a flat baseline explains its null z. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { baselineLength: number; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.baselineLength: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — a flat baseline explains its null z. - diagnostics.warnings: QuantWarning[]; default: not declared - mean: number; default: not declared - percentile: number; default: not declared — Percentile of `value` within the baseline, in `[0, 100]` (share strictly below). - stdev: number; default: not declared — Sample standard deviation of the baseline. - zScore: number | null; default: not declared — `(value − mean) / stdev` of the baseline; `null` when the baseline is flat (no defined z). ### @insiderfinance/totalfinance/structure#charmExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Charm exposure alone — the signed dollar-delta change as ONE calendar day elapses (`−∂DEX/∂T` per day). A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['charm'] })`. ```typescript export declare function charmExposure(input: ExposureShortcutInput): ExposureProfile<'charm'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'charm', 'charm'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'charm', 'charm'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#colorExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Color exposure alone — the signed change in GEX as ONE calendar day elapses (`−∂GEX/∂T` per day), in the profile's `gammaUnit`. A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['color'] })`. ```typescript export declare function colorExposure(input: ExposureShortcutInput): ExposureProfile<'color'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'color', 'color'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'color', 'color'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#deltaAdjustedPremium Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Delta-adjusted (delta-weighted) premium of a set of directional flow prints (spec §11.6, product review §4). Weighting premium by |delta| turns raw premium into an approximate directional exposure: deep-ITM bought calls move the tape far more than lottery-ticket wings of the same premium. A print leans **bullish** when it is a bought call or a sold put and **bearish** when it is a bought put or a sold call. Pure; greeks are an explicit input. ```typescript export declare function deltaAdjustedPremium(trades: readonly DirectionalFlowTrade[]): DeltaAdjustedPremium; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (trades): readonly DirectionalFlowTrade[]; default: not declared - return.bearishPremium: number; default: not declared — Σ |delta|·premium over bearish prints (bought puts / sold calls). - return.bullishPremium: number; default: not declared — Σ |delta|·premium over prints whose directional lean is bullish (bought calls / sold puts). - return.netDirectional: number; default: not declared — `bullishPremium − bearishPremium` — net directional delta-adjusted premium (> 0 = net bullish). - return.totalDeltaAdjusted: number; default: not declared — Σ |delta|·premium regardless of direction — the total delta-weighted premium. ### @insiderfinance/totalfinance/structure#deltaExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Delta exposure (DEX) alone — dollar delta (`Δ·OI·multiplier·spot`), signed by the convention. Computes delta only. Equivalent to `exposure({ ...input, metrics: ['dex'] })`. ```typescript export declare function deltaExposure(input: ExposureShortcutInput): ExposureProfile<'dex'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'dex', 'dex'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'dex', 'dex'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#exposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compute an exposure profile from an option chain. Omit `metrics` for the full profile. Pass `metrics` to compute only some exposures — a literal selection types the result precisely (`exposure({ …, metrics: ['gex'] }).aggregate.gex` is a `number`, `.dex` does not exist); a selection held in a variable types its metrics as optional. Name the full profile's types as `ExposureInput` and `ExposureProfile`: `Parameters` and `ReturnType` see the selection's general (dynamic) form. ```typescript export declare function exposure(input: ExposureInput): ExposureProfile, PossibleExposureMetrics>; ``` Example (source JSDoc): const profile = exposure({ quotes, market, config: { convention: 'dealerShortGamma' }, metrics: ['gex', 'dex'] }); profile.aggregate.gex; Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).metrics?: S; default: not declared — The exposures to compute, e.g. `['gex']` or `['gex', 'dex', 'vanna']`. Omit it for the full profile (every metric, exactly as before). A selection — explicit, nonempty, each name once — computes only those metrics and the Black–Scholes outputs they need, and is echoed in `assumptions.metrics`; uncomputed metrics are absent from the result, never zero. - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate, PossibleExposureMetrics>; default: not declared - return.assumptions: Assumptions<{ timeDecayDirection: 'perCalendarDayElapsed'; scanVolatilityPolicy: 'stickyStrike'; convention: { name: string; calls: number; puts: number; }; gammaUnit: GammaUnit; priceSource: PriceSource; minTimeToExpiry: number; defaultMultiplier: number; metrics?: readonly ExposureMetric[]; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure, PossibleExposureMetrics>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: >(metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: >(metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly, PossibleExposureMetrics>>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#exposureFromGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Account for caller-supplied signed Greeks at one spot snapshot. GEX is `gamma * openInterest * multiplier * gexSign * spot * (spot * 0.01)` for `per1PercentMove`, or `gamma * openInterest * multiplier * gexSign * spot` for `perPoint`. DEX is `delta * openInterest * multiplier * dexSign * spot`. A negative put delta is used unchanged: a negative DEX position sign reverses it ONCE. Gamma inputs are signed delta-per-spot-point, never dollar gamma or per-contract gamma. Quotes, contracts, Greeks and market observations are open to harmless decoration; the request, config and both convention objects are closed. Only consumed fields are validated/copied. Quote timestamp/source describe the supplied OI snapshot, not a fabricated exchange OI update. Caller must align currency, deliverable basis, source units and non-overlapping OI observations. Repeated underlying/type/style/strike/expiry identities are counted and warned, never silently deduplicated; differing multipliers, sources, timestamps and provider metadata do not hide repeats. Coverage describes only supplied quote rows, not a full market universe. Empty or entirely excluded chains produce empty sums, NOT an estimate that market exposure is zero. Every row is validated, including rows later excluded. Missing OI/Greeks, expired contracts (`expiresAt <= asOf`), future observations (`timestampMs > asOf`) and stale observations (`asOf - timestampMs > maximumObservationAgeMs`) are excluded with retained lineage. Zero OI is a valid included zero contribution. Missing multipliers require an explicit fallback. Contributions sort by expiry instant, strike, call-before-put, then original input index. Aggregates sort numerically by strike/expiry instant and include excluded-only buckets as zero. At most 100,000 dense quote rows and 512 characters per consumed string are accepted; lengths are refused before traversal. Nonrepresentable contributions or aggregates throw InputError. No rate/dividend model is invented and fixed supplied Greeks cannot yield scenario repricing, gamma flips, or model-driven hedging forecasts. Use exposure() for model-based scenarios. `metrics` selects GEX, DEX or both (omitted: both, exactly as before). `['gex']` reads only supplied gamma, `gexConvention` and `gammaUnit` — a row's delta may be absent — and `['dex']` only supplied delta and `dexConvention`. The unselected metric's contribution sign and value, totals, units and convention echoes are absent from the report (never zero), and `assumptions.metrics` echoes the selection. A GEX+DEX report requires both supplied Greeks on every row that supplies Greeks, so the two metrics always cover the same included rows. Modeled Greeks are never substituted. Name the report as `SuppliedExposureReport` and its input as `SuppliedExposureInput`: `Parameters` and `ReturnType<…>` see the selection's general (dynamic) form. `breakdowns: false` leaves out `byStrike` and `byExpiry` for a caller that aggregates the contributions itself: no grouping and no per-group exact totals (two thirds of the summation), with every other field unchanged and `assumptions.breakdowns` echoing the flag. ```typescript export declare function exposureFromGreeks(request: SuppliedExposureRequest): SuppliedExposureReport, PossibleSuppliedExposureMetrics, B>; ``` Example (source JSDoc): ```ts import { resolvedExpiry } from '@insiderfinance/totalfinance/core'; import { exposureFromGreeks } from '@insiderfinance/totalfinance/structure'; const timestampMs = Date.parse('2026-09-01T15:00:00Z'); const report = exposureFromGreeks({ quotes: [{ contract: { underlying: 'SPY', type: 'put', style: 'american', strike: 100, expiry: '2026-09-18', ...resolvedExpiry('2026-09-18'), multiplier: 100 }, timestampMs, source: 'chain-feed', openInterest: 10, greeks: { delta: -0.4, gamma: 0.02, provenance: { source: 'greek-feed', timestampMs } }, }], market: { underlying: 'SPY', spot: 100, source: 'spot-feed', timestampMs, asOf: timestampMs }, config: { gexConvention: { calls: 1, puts: -1 }, dexConvention: { calls: 1, puts: 1 }, gammaUnit: 'per1PercentMove', maximumObservationAgeMs: 60000 }, }); console.assert(report.aggregate.gex === -2000); console.assert(report.aggregate.dex === -40000); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): SuppliedExposureRequest; default: not declared - (request).breakdowns?: B; default: not declared — `false` leaves `byStrike` and `byExpiry` out of the report: no grouping and no per-group exact totals, two thirds of the summation, for a caller that aggregates the contributions itself. Omitted or `true`: the released report. Contributions, aggregate, coverage and diagnostics are the same either way. - (request).config: SuppliedExposureRequestConfig; default: not declared - (request).market: SuppliedExposureMarket; default: not declared - (request).metrics?: S; default: not declared — `['gex']`, `['dex']` or both. Omit for today's report (both). A GEX-only report needs only supplied gamma, `gexConvention` and `gammaUnit`; a DEX-only report only supplied delta and `dexConvention`. The unselected metric's fields are absent from the report, never zero. - (request).quotes: readonly SuppliedExposureRequestQuote[]; default: not declared - return.aggregate: SuppliedExposureTotalsFor, PossibleSuppliedExposureMetrics>; default: not declared - return.assumptions: SuppliedExposureAssumptionsFor, PossibleSuppliedExposureMetrics>; default: not declared - return.contributions: SuppliedExposureContributionFor, PossibleSuppliedExposureMetrics>[]; default: not declared - return.coverage: { duplicateContractQuotes: number; duplicateIncludedContractQuotes: number; excludedQuotes: number; exclusionCounts: Record; fraction: number | null; includedQuotes: number; scope: 'suppliedQuotesOnly'; status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; totalQuotes: number; }; default: not declared - return.coverage.duplicateContractQuotes: number; default: not declared — Rows beyond the first matching underlying/type/style/strike/expiry instant, across sources/times. - return.coverage.duplicateIncludedContractQuotes: number; default: not declared — Included rows beyond the first included matching identity; these can double-count OI. - return.coverage.excludedQuotes: number; default: not declared - return.coverage.exclusionCounts: Record; default: not declared — Counts overlap when a row has several reasons. - return.coverage.fraction: number | null; default: not declared — Included / supplied rows; null for an empty chain. Not coverage of an unknown full universe. - return.coverage.includedQuotes: number; default: not declared - return.coverage.scope: 'suppliedQuotesOnly'; default: not declared - return.coverage.status: 'emptyInput' | 'noEligibleQuotes' | 'partialInput' | 'allInputQuotesIncluded'; default: not declared - return.coverage.totalQuotes: number; default: not declared - return.diagnostics: Diagnostics; default: not declared ### @insiderfinance/totalfinance/structure#flow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Analyze a stream of option trades for aggressor, sweeps, blocks, and spreads. ```typescript export declare function flow(trades: OptionTrade[], options?: FlowOptions): FlowAnalysis; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: FlowOptions; default: not declared - (options).blockMinPremium?: number; default: not declared — ...or at/above this premium (price·size·multiplier). Default 100_000. - (options).blockMinSize?: number; default: not declared — A single print is a block at/above this size (contracts). Default 100. - (options).classificationSource?: FlowClassificationSource; default: not declared — Classification authority/fallback rule. Default `'provided-or-quotes'` (legacy behavior). - (options).multiplier?: number; default: not declared — Contract multiplier when a trade omits one. Default 100. - (options).spreadWindowMs?: number; default: not declared — Prints on one underlying within this window (ms) across ≥2 contracts form a spread. Default 100. - (options).sweepMinPrints?: number; default: not declared — Minimum prints to call a cluster a sweep. Default 3. - (options).sweepWindowMs?: number; default: not declared — Prints on one contract within this window (ms), same side, count as one sweep. Default 500. - (trades): OptionTrade[]; default: not declared - return.assumptions: Assumptions<{ nbboRule: 'quote-rule-midpoint-unknown'; classificationSource: FlowClassificationSource; sweepWindowMs: number; spreadWindowMs: number; sweepMinPrints: number; blockMinSize: number; blockMinPremium: number; multiplier: number; venueVerifiedSweeps: boolean; }>; default: not declared — The rules/windows the analysis ran under — echoed so a serialized report is self-interpreting. - return.blocks: ClassifiedTrade[]; default: not declared — Blocks: single prints large by size or premium. - return.callPutPremium: () => CallPutPremium; default: not declared — Call-vs-put premium and volume across all trades, with put/call ratios and net premium. - return.diagnostics: Diagnostics; default: not declared — Structured warnings: `model.limitation` caveats plus any data-quality flags. - return.groupBy: (keys: Array) => FlowGroup[]; default: not declared — Aggregate trades into groups keyed by any subset of underlying/expiry/strike/type. - return.rank: (groups: FlowGroup[], options?: RankOptions) => FlowGroup[]; default: not declared — Filter and sort groups (default: by premium, descending). - return.spreads: readonly Readonly[]; default: not declared - return.sweeps: readonly Readonly[]; default: not declared - return.trades: readonly Readonly[]; default: not declared — Frozen result arrays — an analysis is a snapshot; mutate a copy, never the result. - return.zeroDaysToExpiry: ClassifiedTrade[]; default: not declared — 0DTE trades: prints on a contract expiring the same calendar day. ### @insiderfinance/totalfinance/structure#gammaExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gamma exposure (GEX) alone — the dollar change in dealer delta for a 1% spot move (`Γ·OI·multiplier·spot²·0.01`, or per point with `gammaUnit: 'perPoint'`), signed by the convention. Computes gamma only. Equivalent to `exposure({ ...input, metrics: ['gex'] })`; `atSpot` re-evaluates GEX per tick and `levels()` computes what it needs when called. ```typescript export declare function gammaExposure(input: ExposureShortcutInput): ExposureProfile<'gex'>; ``` Example (source JSDoc): const gex = gammaExposure({ quotes, market: { spot: 6500, riskFreeRate: 0.043, asOf }, config: { convention: 'dealerShortGamma' } }); gex.aggregate.gex; Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'gex', 'gex'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'gex', 'gex'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#optionFlowDrift Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate observed raw option trading premium for one explicit session. Example: `optionFlowDrift({ trades, session: { date: '2026-06-04' }, config: { symbol: 'SPY' } })`. Each minute/bucket exposes separate `change` and `cumulative` accounting. Buy calls / sell puts map to bullish premium and volume; sell calls / buy puts map to bearish. Unknowns move neither drift nor directional volume, but contribute all their premium to worst-case sign bounds. Classification coverage is a share of premium, NOT a success probability or confidence band. No delta weighting, dealer-position inference, multi-leg netting, fees, P&L, or income prediction. All combined premiums must already use one currency; this operation does not convert FX. Heuristics apply to the SAME window's totals: no prints/zero premium → no-signal; coverage below the threshold → low-coverage; opposing nonzero volume/premium signs → volume-opposed; call > 0 and put < 0 → bullish-expansion (reverse → bearish-expansion); remaining nonzero net → mixed-flow. These are descriptive accounting rules, not trading recommendations or measured predictiveness. Session/cutoff and bucket ends are exclusive. A bucket is a completed END-of-interval observation, not a value available at its start. Prices carry forward only from observations in this session; missing prices stay null. Overlay ties prefer underlying trades, then quotes, then option-print underlyingPrice, with last input winning within a source. Caller timestamps must express when data was available; embedded underlyingPrice is assumed available at its option print timestamp. Late vendor corrections/publication delays cannot be reconstructed from these fields alone. Trades are validated even outside scope, then stably sorted without mutation. Repeated explicit IDs fail. ID-less prints identical in the consumed trade fields fail (including sequence/venue); give genuinely distinct identical executions distinct IDs. Vendor metadata stays open. No print is silently deduplicated; malformed data or unrepresentable arithmetic throws typed InputError. ```typescript export declare function optionFlowDrift(input: OptionFlowDriftInput): OptionFlowDriftResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OptionFlowDriftInput; default: not declared - (input).config?: OptionFlowDriftConfig; default: not declared - (input).session: OptionFlowDriftSession; default: not declared - (input).trades: readonly OptionFlowDriftTrade[]; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: OptionFlowDriftValue; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/structure#speedExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Speed exposure alone — the change in GEX for a +1% spot move, in the GEX unit (computes speed and gamma). A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['speed'] })`. ```typescript export declare function speedExposure(input: ExposureShortcutInput): ExposureProfile<'speed'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'speed', 'speed'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'speed', 'speed'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#thetaExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Theta exposure alone — dollar option-value decay per calendar day (`θ/day·OI·multiplier`). Equivalent to `exposure({ ...input, metrics: ['theta'] })`. ```typescript export declare function thetaExposure(input: ExposureShortcutInput): ExposureProfile<'theta'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'theta', 'theta'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'theta', 'theta'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#unusualness Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Unusualness of a reading versus a caller-supplied baseline history (spec §11.6, product review §4): the z-score and percentile of `value` against `baseline` (e.g. today's contract volume vs. its trailing daily volumes). The baseline is bring-your-own — this package stores no history. A flat baseline has no defined spread, so the z-score is `null` (never fabricated). ```typescript export declare function unusualness(value: number, baseline: ArrayLike): Unusualness; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (baseline): ArrayLike; default: not declared - (value): number; default: not declared - return.assumptions: { baselineLength: number; conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.baselineLength: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty) — a flat baseline explains its null z. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.mean: number; default: not declared - return.percentile: number; default: not declared — Percentile of `value` within the baseline, in `[0, 100]` (share strictly below). - return.stdev: number; default: not declared — Sample standard deviation of the baseline. - return.zScore: number | null; default: not declared — `(value − mean) / stdev` of the baseline; `null` when the baseline is flat (no defined z). ### @insiderfinance/totalfinance/structure#vannaExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Vanna exposure alone — the dollar-delta change per +1% volatility (`vanna·OI·multiplier·spot·0.01`). A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['vanna'] })`. ```typescript export declare function vannaExposure(input: ExposureShortcutInput): ExposureProfile<'vanna'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'vanna', 'vanna'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'vanna', 'vanna'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#vegaExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Vega exposure alone — the dollar change in option value per 1% (0.01) volatility move (`vega%·OI·multiplier`). Equivalent to `exposure({ ...input, metrics: ['vega'] })`. ```typescript export declare function vegaExposure(input: ExposureShortcutInput): ExposureProfile<'vega'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'vega', 'vega'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'vega', 'vega'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ### @insiderfinance/totalfinance/structure#vommaExposure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Vomma (volga) exposure alone — the change in vega exposure per +1% volatility. A higher-order exposure. Equivalent to `exposure({ ...input, metrics: ['vomma'] })`. ```typescript export declare function vommaExposure(input: ExposureShortcutInput): ExposureProfile<'vomma'>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExposureShortcutInput; default: not declared - (input).config: ExposureConfig; default: not declared - (input).market: ExposureMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.aggregate: ExposureAggregate<'vomma', 'vomma'>; default: not declared - return.assumptions: Assumptions<{ convention: { name: string; calls: number; puts: number; }; defaultMultiplier: number; gammaUnit: GammaUnit; metrics?: readonly ExposureMetric[]; minTimeToExpiry: number; priceSource: PriceSource; scanVolatilityPolicy: 'stickyStrike'; timeDecayDirection: 'perCalendarDayElapsed'; }>; default: not declared - return.atSpot: (spot: number) => AtSpotExposure<'vomma', 'vomma'>; default: not declared — Per-tick fast path: re-evaluate NET dollar-gamma (`gex`) and NET dollar-delta (`dex`) exposure at a new `spot`, holding each contract's IV, time-to-expiry, and open interest FIXED (sticky-strike, echoed in `assumptions.scanVolatilityPolicy`) — only spot moves and gamma/delta are re-evaluated. This is the intraday dashboard path (one cheap greek pass per tick); a full {@link exposure} re-run — which re-derives IV, the extended greeks, and levels — is the per-refresh path. At the profile's original spot this reproduces `aggregate.gex`/`aggregate.dex` exactly (same operations, same order). A selective profile re-evaluates only what it selected: a {@link gammaExposure} profile returns `{ gex }` and computes gamma alone. A profile that selected neither `gex` nor `dex` refuses. - return.byExpiry: (metrics?: readonly M[] | undefined) => ExpiryRow[]; default: not declared — Chart-ready by-expiry profile (one row per expiry), narrowed to `metrics` — by default this profile's own metrics. A metric this profile did not compute is refused. - return.byStrike: (metrics?: readonly M[] | undefined) => StrikeRow[]; default: not declared — Chart-ready by-strike profile (one row per strike, totals summed), narrowed to `metrics` — by default this profile's own metrics (every metric for a full profile). When `'gex'` is requested each row ALSO carries the call/put split — `callGex`/`putGex`/`callOpenInterest`/`putOpenInterest` (the {@link GexSplit} columns) — for the canonical dashboard chart (call bars up, put bars down). `callGex + putGex` equals the row's net `gex` and `callOpenInterest + putOpenInterest` the strike's total OI (WS4.5). A metric this profile did not compute is refused, not reported as zero. - return.contracts: readonly Readonly>[]; default: not declared — Frozen result rows — a profile is a snapshot; mutate a copy, never the result. - return.diagnostics: Diagnostics; default: not declared - return.levels: (options?: { pinRiskBand?: number; }) => Levels; default: not declared — Dealer-positioning levels (walls, zero-gamma, max pain, pin risk). On a selective profile this computes what it reads — per-contract gex, gamma, vanna and charm at the profile's spot, plus a gamma-only zero-gamma sweep — and returns exactly what a full profile returns. - return.netDrift: () => NetDrift; default: not declared — Net dealer-hedging drift estimate (spec §11.5): the gamma regime (pinning vs trending), the zero-gamma attractor, and the aggregate charm/vanna hedging flows that push spot over time and as vol moves. An ESTIMATE from the positioning model — not a price forecast. An empty or identically-zero book has no gamma structure: `zeroGamma`/`distanceToZeroGamma`/`gammaRegime`/ `bias` are all `null` (never fabricated), and the charm/vanna flows echo the (zero) aggregate. On a selective profile the charm and vanna aggregates are computed here if they were not selected. - return.scenarioMap: (options?: ScenarioMapOptions) => ScenarioMap; default: not declared — Recompute aggregate metrics across a spot × volatilityShock × time grid. With no `metrics` the default set is `['gex','dex','vanna','charm']` — and the return type narrows to exactly those, so it never over-claims the metrics not actually computed (WS2.4). Each cell evaluates only the Black–Scholes outputs its metrics need, in one shared pass (`['gex']` evaluates gamma alone). A scenario is an explicitly requested analysis, so it may use any metric, whatever this profile selected. - return.spot: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/structure/exposure ### @insiderfinance/totalfinance/structure/exposure#AtSpotExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#AtSpotExposure`. ### @insiderfinance/totalfinance/structure/exposure#ContractExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ContractExposure`. ### @insiderfinance/totalfinance/structure/exposure#ContractExposureRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ContractExposureRow`. ### @insiderfinance/totalfinance/structure/exposure#DefaultScenarioMetric Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#DefaultScenarioMetric`. ### @insiderfinance/totalfinance/structure/exposure#ExpiryRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExpiryRow`. ### @insiderfinance/totalfinance/structure/exposure#ExposureAggregate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureAggregate`. ### @insiderfinance/totalfinance/structure/exposure#ExposureConfig Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureConfig`. ### @insiderfinance/totalfinance/structure/exposure#ExposureConvention Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureConvention`. ### @insiderfinance/totalfinance/structure/exposure#ExposureInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ExposureInput`. ### @insiderfinance/totalfinance/structure/exposure#ExposureMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureMarket`. ### @insiderfinance/totalfinance/structure/exposure#ExposureMetric Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureMetric`. ### @insiderfinance/totalfinance/structure/exposure#ExposureProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureProfile`. ### @insiderfinance/totalfinance/structure/exposure#ExposureShortcutInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureShortcutInput`. ### @insiderfinance/totalfinance/structure/exposure#ExposureTotals Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ExposureTotals`. ### @insiderfinance/totalfinance/structure/exposure#GammaUnit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#GammaUnit`. ### @insiderfinance/totalfinance/structure/exposure#GexSplit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#GexSplit`. ### @insiderfinance/totalfinance/structure/exposure#GuaranteedExposureMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#GuaranteedExposureMetrics`. ### @insiderfinance/totalfinance/structure/exposure#Levels Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#Levels`. ### @insiderfinance/totalfinance/structure/exposure#NetDrift Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#NetDrift`. ### @insiderfinance/totalfinance/structure/exposure#PossibleExposureMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#PossibleExposureMetrics`. ### @insiderfinance/totalfinance/structure/exposure#ScenarioCell Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ScenarioCell`. ### @insiderfinance/totalfinance/structure/exposure#ScenarioMap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ScenarioMap`. ### @insiderfinance/totalfinance/structure/exposure#ScenarioMapOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ScenarioMapOptions`. ### @insiderfinance/totalfinance/structure/exposure#StrikeRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#StrikeRow`. ### @insiderfinance/totalfinance/structure/exposure#charmExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#charmExposure`. ### @insiderfinance/totalfinance/structure/exposure#colorExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#colorExposure`. ### @insiderfinance/totalfinance/structure/exposure#deltaExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#deltaExposure`. ### @insiderfinance/totalfinance/structure/exposure#exposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#exposure`. ### @insiderfinance/totalfinance/structure/exposure#gammaExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#gammaExposure`. ### @insiderfinance/totalfinance/structure/exposure#speedExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#speedExposure`. ### @insiderfinance/totalfinance/structure/exposure#thetaExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#thetaExposure`. ### @insiderfinance/totalfinance/structure/exposure#vannaExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#vannaExposure`. ### @insiderfinance/totalfinance/structure/exposure#vegaExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#vegaExposure`. ### @insiderfinance/totalfinance/structure/exposure#vommaExposure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#vommaExposure`. ## Entrypoint @insiderfinance/totalfinance/structure/flow ### @insiderfinance/totalfinance/structure/flow#AggressorSide Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#AggressorSide`. ### @insiderfinance/totalfinance/structure/flow#CallPutPremium Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#CallPutPremium`. ### @insiderfinance/totalfinance/structure/flow#ClassifiedTrade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#ClassifiedTrade`. ### @insiderfinance/totalfinance/structure/flow#DeltaAdjustedPremium Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#DeltaAdjustedPremium`. ### @insiderfinance/totalfinance/structure/flow#DirectionalFlowTrade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#DirectionalFlowTrade`. ### @insiderfinance/totalfinance/structure/flow#FlowAnalysis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#FlowAnalysis`. ### @insiderfinance/totalfinance/structure/flow#FlowClassificationProvenance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#FlowClassificationProvenance`. ### @insiderfinance/totalfinance/structure/flow#FlowClassificationSource Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#FlowClassificationSource`. ### @insiderfinance/totalfinance/structure/flow#FlowGroup Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#FlowGroup`. ### @insiderfinance/totalfinance/structure/flow#FlowGroupKey Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#FlowGroupKey`. ### @insiderfinance/totalfinance/structure/flow#FlowOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#FlowOptions`. ### @insiderfinance/totalfinance/structure/flow#OpenCloseEstimate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#OpenCloseEstimate`. ### @insiderfinance/totalfinance/structure/flow#RankByKey Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#RankByKey`. ### @insiderfinance/totalfinance/structure/flow#RankOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#RankOptions`. ### @insiderfinance/totalfinance/structure/flow#Spread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#Spread`. ### @insiderfinance/totalfinance/structure/flow#Sweep Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#Sweep`. ### @insiderfinance/totalfinance/structure/flow#Unusualness Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#Unusualness`. ### @insiderfinance/totalfinance/structure/flow#deltaAdjustedPremium Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#deltaAdjustedPremium`. ### @insiderfinance/totalfinance/structure/flow#flow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#flow`. ### @insiderfinance/totalfinance/structure/flow#unusualness Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/structure#unusualness`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis ### @insiderfinance/totalfinance/technical-analysis#ALIAS_TABLE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Curated TotalFinance ↔ TA-Lib ↔ pandas-ta ↔ TradingView name map. Grouped by family for readability; the order is informational only (resolution and the matrix index it independently). ```typescript export declare const ALIAS_TABLE: readonly IndicatorAliasRow[]; ``` ### @insiderfinance/totalfinance/technical-analysis#AberrationParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Aberration ───────────────────────── export interface AberrationParameters { /** SMA length for the zero-line of HLC3. Default 5. */ period?: number; /** ATR length for the band offset. Default 15. */ atrPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. ### @insiderfinance/totalfinance/technical-analysis#AberrationPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AberrationPoint { /** Zero-line: SMA of HLC3. */ zeroLine: number; /** Upper band: zeroLine + ATR. */ upperBand: number; /** Lower band: zeroLine − ATR. */ lowerBand: number; /** The ATR offset itself. */ atr: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atr: number; default: not declared — The ATR offset itself. - lowerBand: number; default: not declared — Lower band: zeroLine − ATR. - upperBand: number; default: not declared — Upper band: zeroLine + ATR. - zeroLine: number; default: not declared — Zero-line: SMA of HLC3. ### @insiderfinance/totalfinance/technical-analysis#AccelerationBandsParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Acceleration Bands ───────────────────────── export interface AccelerationBandsParameters { period?: number; /** Width factor on the high−low/high+low ratio. Default 4. */ multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AdxPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ---- ADX (Wilder) ---- export interface AdxPoint { adx: number; plusDI: number; minusDI: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adx: number; default: not declared - minusDI: number; default: not declared - plusDI: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AggregateStream Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A streaming aggregator: each input bar yields zero or more completed output units. ```typescript /** A streaming aggregator: each input bar yields zero or more completed output units. */ export interface AggregateStream { next(bar: BarInput): Out[]; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - next: (bar: BarInput) => Out[]; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#AggressorMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type AggressorMethod = 'side' | 'quote' | 'tick'; ``` ### @insiderfinance/totalfinance/technical-analysis#AlignOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AlignOptions { /** The HTF bucket width in ms. Defaults to the smallest positive gap between consecutive HTF bars. */ intervalMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - intervalMs?: number; default: not declared — The HTF bucket width in ms. Defaults to the smallest positive gap between consecutive HTF bars. ### @insiderfinance/totalfinance/technical-analysis#AlmaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── ALMA (Arnaud Legoux) ───────────────────────── export interface AlmaParameters { period: number; /** Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. */ offset?: number; /** Gaussian width. Default 6. */ sigma?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - period: number; default: not declared - sigma?: number; default: not declared — Gaussian width. Default 6. ### @insiderfinance/totalfinance/technical-analysis#AmatParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Archer Moving Averages Trends ───────────────────────── export interface AmatParameters { fast?: number; slow?: number; lookback?: number; movingAverageType?: MovingAverageName; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - lookback?: number; default: not declared - movingAverageType?: MovingAverageName; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AmatPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AmatPoint { long: number; short: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long: number; default: not declared - short: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AnchoredVwapParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── anchored VWAP ───────────────────────── export interface AnchoredVwapParameters { /** Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. */ anchor: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. ### @insiderfinance/totalfinance/technical-analysis#AnchoredVwapPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AnchoredVwapPoint { vwap: number; /** Bars ago of the current anchor (0 = current bar). */ anchorBarsAgo: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - vwap: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ApoParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── APO / PPO ───────────────────────── export interface ApoParameters { fast?: number; slow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ArcherObvParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Archer OBV ───────────────────────── export interface ArcherObvParameters { /** Fast EMA length on OBV. Default 4. */ fast?: number; /** Slow EMA length on OBV. Default 12. */ slow?: number; /** Lookback for the rising/falling run check on the two EMAs. Default 2. */ runLength?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - slow?: number; default: not declared — Slow EMA length on OBV. Default 12. ### @insiderfinance/totalfinance/technical-analysis#ArcherObvPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ArcherObvPoint { obv: number; /** Fast EMA of OBV. */ fast: number; /** Slow EMA of OBV. */ slow: number; /** 1 when both EMAs are rising over `runLength` — a long-run signal. */ long: number; /** 1 when both EMAs are falling over `runLength` — a short-run signal. */ short: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast: number; default: not declared — Fast EMA of OBV. - long: number; default: not declared — 1 when both EMAs are rising over `runLength` — a long-run signal. - obv: number; default: not declared - short: number; default: not declared — 1 when both EMAs are falling over `runLength` — a short-run signal. - slow: number; default: not declared — Slow EMA of OBV. ### @insiderfinance/totalfinance/technical-analysis#AroonPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Aroon ───────────────────────── export interface AroonPoint { up: number; down: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - down: number; default: not declared - up: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AtrBandsParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── ATR Bands ───────────────────────── export interface AtrBandsParameters { period?: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AtrTrailingStopParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AtrTrailingStopParameters { period?: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#AwesomeParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Awesome Oscillator ───────────────────────── export interface AwesomeParameters { fast?: number; slow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#BarAggregator Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BarAggregator implements AggregateStream { constructor(parameters: { kind: string; shouldClose: CloseRule; }); flush(): BarInput[]; next(bar: BarInput): BarInput[]; restore(snapshot: TechnicalAnalysisSnapshot): void; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; shouldClose: CloseRule; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).shouldClose: CloseRule; default: not declared - flush: () => BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - next: (bar: BarInput) => BarInput[]; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - restore: (snapshot: TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - restore(snapshot): TechnicalAnalysisSnapshot; default: not declared - restore(snapshot).kind: string; default: not declared - restore(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - restore(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - return.flush: () => BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - return.next: (bar: BarInput) => BarInput[]; default: not declared - return.restore: (snapshot: TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#BarColumns Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BarColumns { open?: readonly number[]; high?: readonly number[]; low?: readonly number[]; close?: readonly number[]; volume?: readonly number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close?: readonly number[]; default: not declared - high?: readonly number[]; default: not declared - low?: readonly number[]; default: not declared - open?: readonly number[]; default: not declared - volume?: readonly number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#BarInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). OHLCV-style input row for bar indicators. ```typescript /** OHLCV-style input row for bar indicators. */ export interface BarInput { open?: number; high: number; low: number; close: number; volume?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open?: number; default: not declared - volume?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#BollingerParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BollingerParameters { /** SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. */ period?: number; /** Band width in standard deviations. Defaults to 2. */ standardDeviation?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. ### @insiderfinance/totalfinance/technical-analysis#BollingerPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BollingerPoint { upper: number; middle: number; lower: number; bandwidth: number; percentB: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bandwidth: number; default: not declared - lower: number; default: not declared - middle: number; default: not declared - percentB: number; default: not declared - upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#BookImbalanceParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── order-book analytics ───────────────────────── export interface BookImbalanceParameters { /** Depth levels to aggregate from the top of book. Default = all available. */ levels?: number; /** Weight each level by `1/(1+rank)` so nearer levels dominate. Default false (equal weight). */ weighted?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - levels?: number; default: not declared — Depth levels to aggregate from the top of book. Default = all available. - weighted?: boolean; default: not declared — Weight each level by `1/(1+rank)` so nearer levels dominate. Default false (equal weight). ### @insiderfinance/totalfinance/technical-analysis#BookLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface BookLevel { price: number; size: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared - size: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#BrarPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── BRAR ───────────────────────── export interface BrarPoint { /** * AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures * intraday strength against the open. */ popularityIndex: number; /** * BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. * Measures strength against the PRIOR close, which is what distinguishes it from AR. */ willingnessIndex: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. ### @insiderfinance/totalfinance/technical-analysis#CANDLE_SETTINGS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). TA-Lib default candle settings (`TA_RestoreCandleDefaultSettings`). ```typescript export declare const CANDLE_SETTINGS: { readonly bodyDoji: { readonly averagePeriod: 10; readonly factor: 0.1; readonly range: 'highLow'; }; readonly bodyLong: { readonly averagePeriod: 10; readonly factor: 1; readonly range: 'realBody'; }; readonly bodyShort: { readonly averagePeriod: 10; readonly factor: 1; readonly range: 'realBody'; }; readonly bodyVeryLong: { readonly averagePeriod: 10; readonly factor: 3; readonly range: 'realBody'; }; readonly equal: { readonly averagePeriod: 5; readonly factor: 0.05; readonly range: 'highLow'; }; readonly far: { readonly averagePeriod: 5; readonly factor: 0.6; readonly range: 'highLow'; }; readonly near: { readonly averagePeriod: 5; readonly factor: 0.2; readonly range: 'highLow'; }; readonly shadowLong: { readonly averagePeriod: 0; readonly factor: 1; readonly range: 'realBody'; }; readonly shadowShort: { readonly averagePeriod: 10; readonly factor: 1; readonly range: 'shadows'; }; readonly shadowVeryLong: { readonly averagePeriod: 0; readonly factor: 3; readonly range: 'realBody'; }; readonly shadowVeryShort: { readonly averagePeriod: 10; readonly factor: 0.1; readonly range: 'highLow'; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bodyDoji: { readonly averagePeriod: 10; readonly factor: 0.1; readonly range: 'highLow'; }; default: not declared - bodyDoji.averagePeriod: 10; default: not declared - bodyDoji.factor: 0.1; default: not declared - bodyDoji.range: 'highLow'; default: not declared - bodyLong: { readonly averagePeriod: 10; readonly factor: 1; readonly range: 'realBody'; }; default: not declared - bodyLong.averagePeriod: 10; default: not declared - bodyLong.factor: 1; default: not declared - bodyLong.range: 'realBody'; default: not declared - bodyShort: { readonly averagePeriod: 10; readonly factor: 1; readonly range: 'realBody'; }; default: not declared - bodyShort.averagePeriod: 10; default: not declared - bodyShort.factor: 1; default: not declared - bodyShort.range: 'realBody'; default: not declared - bodyVeryLong: { readonly averagePeriod: 10; readonly factor: 3; readonly range: 'realBody'; }; default: not declared - bodyVeryLong.averagePeriod: 10; default: not declared - bodyVeryLong.factor: 3; default: not declared - bodyVeryLong.range: 'realBody'; default: not declared - equal: { readonly averagePeriod: 5; readonly factor: 0.05; readonly range: 'highLow'; }; default: not declared - equal.averagePeriod: 5; default: not declared - equal.factor: 0.05; default: not declared - equal.range: 'highLow'; default: not declared - far: { readonly averagePeriod: 5; readonly factor: 0.6; readonly range: 'highLow'; }; default: not declared - far.averagePeriod: 5; default: not declared - far.factor: 0.6; default: not declared - far.range: 'highLow'; default: not declared - near: { readonly averagePeriod: 5; readonly factor: 0.2; readonly range: 'highLow'; }; default: not declared - near.averagePeriod: 5; default: not declared - near.factor: 0.2; default: not declared - near.range: 'highLow'; default: not declared - shadowLong: { readonly averagePeriod: 0; readonly factor: 1; readonly range: 'realBody'; }; default: not declared - shadowLong.averagePeriod: 0; default: not declared - shadowLong.factor: 1; default: not declared - shadowLong.range: 'realBody'; default: not declared - shadowShort: { readonly averagePeriod: 10; readonly factor: 1; readonly range: 'shadows'; }; default: not declared - shadowShort.averagePeriod: 10; default: not declared - shadowShort.factor: 1; default: not declared - shadowShort.range: 'shadows'; default: not declared - shadowVeryLong: { readonly averagePeriod: 0; readonly factor: 3; readonly range: 'realBody'; }; default: not declared - shadowVeryLong.averagePeriod: 0; default: not declared - shadowVeryLong.factor: 3; default: not declared - shadowVeryLong.range: 'realBody'; default: not declared - shadowVeryShort: { readonly averagePeriod: 10; readonly factor: 0.1; readonly range: 'highLow'; }; default: not declared - shadowVeryShort.averagePeriod: 10; default: not declared - shadowVeryShort.factor: 0.1; default: not declared - shadowVeryShort.range: 'highLow'; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CDL_ALIASES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). TA-Lib `CDL*` function name → TotalFinance catalog name. ```typescript export declare const CDL_ALIASES: Readonly>; ``` ### @insiderfinance/totalfinance/technical-analysis#CandleDetector Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CandleDetector = (view: CandleView) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (view): CandleView; default: not declared - (view).black: (index: number) => boolean; default: not declared - (view).body: (index: number) => number; default: not declared - (view).bodyAverage: number; default: not declared - (view).bodyGapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - (view).bodyGapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared — Real bodies of the two bars do not overlap, `barIndex` gapping up over `priorBarIndex`. - (view).bodyHigh: (index: number) => number; default: not declared - (view).bodyLow: (index: number) => number; default: not declared - (view).close: (index: number) => number; default: not declared - (view).dojiBody: (index: number) => boolean; default: not declared - (view).equalish: (first: number, second: number) => boolean; default: not declared - (view).far: (first: number, second: number) => boolean; default: not declared - (view).gapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - (view).gapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - (view).high: (index: number) => number; default: not declared - (view).longBody: (index: number) => boolean; default: not declared - (view).longLower: (index: number) => boolean; default: not declared - (view).longUpper: (index: number) => boolean; default: not declared - (view).low: (index: number) => number; default: not declared - (view).lower: (index: number) => number; default: not declared - (view).near: (first: number, second: number) => boolean; default: not declared - (view).open: (index: number) => number; default: not declared - (view).range: (index: number) => number; default: not declared - (view).rangeAverage10: number; default: not declared - (view).rangeAverage5: number; default: not declared - (view).shadowAverage: number; default: not declared - (view).shortBody: (index: number) => boolean; default: not declared - (view).shortLower: (index: number) => boolean; default: not declared - (view).shortUpper: (index: number) => boolean; default: not declared - (view).signedBody: (index: number) => number; default: not declared - (view).upper: (index: number) => number; default: not declared - (view).veryLongBody: (index: number) => boolean; default: not declared - (view).veryLongLower: (index: number) => boolean; default: not declared - (view).veryShortLower: (index: number) => boolean; default: not declared - (view).veryShortUpper: (index: number) => boolean; default: not declared - (view).white: (index: number) => boolean; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CandleMatch Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CandleMatch { pattern: string; signal: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - pattern: string; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CandleRangeType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CandleRangeType = 'realBody' | 'highLow' | 'shadows'; ``` ### @insiderfinance/totalfinance/technical-analysis#CandleSetting Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CandleSetting { range: CandleRangeType; /** Trailing-average period; 0 means "use the current bar's range" (no averaging). */ averagePeriod: number; factor: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - averagePeriod: number; default: not declared — Trailing-average period; 0 means "use the current bar's range" (no averaging). - factor: number; default: not declared - range: CandleRangeType; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CandleSettingName Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CandleSettingName = keyof typeof CANDLE_SETTINGS; ``` ### @insiderfinance/totalfinance/technical-analysis#CandleView Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A read-only view of the last `len + 10` bars positioned at the current bar, exposing geometry and TA-Lib candle-average thresholds. `i` is an offset back from the current bar (0 = current, 1 = previous, …); the pattern spans offsets `0 … len − 1`. ```typescript export declare class CandleView { constructor(parameters: { history: BarInput[]; length: number; }); black(index: number): boolean; body(index: number): number; readonly bodyAverage: number; bodyGapDown(barIndex: number, priorBarIndex: number): boolean; bodyGapUp(barIndex: number, priorBarIndex: number): boolean; bodyHigh(index: number): number; bodyLow(index: number): number; close(index: number): number; dojiBody(index: number): boolean; equalish(first: number, second: number): boolean; far(first: number, second: number): boolean; gapDown(barIndex: number, priorBarIndex: number): boolean; gapUp(barIndex: number, priorBarIndex: number): boolean; high(index: number): number; longBody(index: number): boolean; longLower(index: number): boolean; longUpper(index: number): boolean; low(index: number): number; lower(index: number): number; near(first: number, second: number): boolean; open(index: number): number; range(index: number): number; readonly rangeAverage10: number; readonly rangeAverage5: number; readonly shadowAverage: number; shortBody(index: number): boolean; shortLower(index: number): boolean; shortUpper(index: number): boolean; signedBody(index: number): number; upper(index: number): number; veryLongBody(index: number): boolean; veryLongLower(index: number): boolean; veryShortLower(index: number): boolean; veryShortUpper(index: number): boolean; white(index: number): boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { history: BarInput[]; length: number; }; default: not declared - (parameters).history: BarInput[]; default: not declared - (parameters).length: number; default: not declared - black: (index: number) => boolean; default: not declared - black(index): number; default: not declared - body: (index: number) => number; default: not declared - body(index): number; default: not declared - bodyAverage: number; default: not declared - bodyGapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - bodyGapDown(barIndex): number; default: not declared - bodyGapDown(priorBarIndex): number; default: not declared - bodyGapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared — Real bodies of the two bars do not overlap, `barIndex` gapping up over `priorBarIndex`. - bodyGapUp(barIndex): number; default: not declared - bodyGapUp(priorBarIndex): number; default: not declared - bodyHigh: (index: number) => number; default: not declared - bodyHigh(index): number; default: not declared - bodyLow: (index: number) => number; default: not declared - bodyLow(index): number; default: not declared - close: (index: number) => number; default: not declared - close(index): number; default: not declared - dojiBody: (index: number) => boolean; default: not declared - dojiBody(index): number; default: not declared - equalish: (first: number, second: number) => boolean; default: not declared - equalish(first): number; default: not declared - equalish(second): number; default: not declared - far: (first: number, second: number) => boolean; default: not declared - far(first): number; default: not declared - far(second): number; default: not declared - gapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - gapDown(barIndex): number; default: not declared - gapDown(priorBarIndex): number; default: not declared - gapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - gapUp(barIndex): number; default: not declared - gapUp(priorBarIndex): number; default: not declared - high: (index: number) => number; default: not declared - high(index): number; default: not declared - longBody: (index: number) => boolean; default: not declared - longBody(index): number; default: not declared - longLower: (index: number) => boolean; default: not declared - longLower(index): number; default: not declared - longUpper: (index: number) => boolean; default: not declared - longUpper(index): number; default: not declared - low: (index: number) => number; default: not declared - low(index): number; default: not declared - lower: (index: number) => number; default: not declared - lower(index): number; default: not declared - near: (first: number, second: number) => boolean; default: not declared - near(first): number; default: not declared - near(second): number; default: not declared - open: (index: number) => number; default: not declared - open(index): number; default: not declared - range: (index: number) => number; default: not declared - range(index): number; default: not declared - rangeAverage10: number; default: not declared - rangeAverage5: number; default: not declared - return.black: (index: number) => boolean; default: not declared - return.body: (index: number) => number; default: not declared - return.bodyAverage: number; default: not declared - return.bodyGapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - return.bodyGapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared — Real bodies of the two bars do not overlap, `barIndex` gapping up over `priorBarIndex`. - return.bodyHigh: (index: number) => number; default: not declared - return.bodyLow: (index: number) => number; default: not declared - return.close: (index: number) => number; default: not declared - return.dojiBody: (index: number) => boolean; default: not declared - return.equalish: (first: number, second: number) => boolean; default: not declared - return.far: (first: number, second: number) => boolean; default: not declared - return.gapDown: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - return.gapUp: (barIndex: number, priorBarIndex: number) => boolean; default: not declared - return.high: (index: number) => number; default: not declared - return.longBody: (index: number) => boolean; default: not declared - return.longLower: (index: number) => boolean; default: not declared - return.longUpper: (index: number) => boolean; default: not declared - return.low: (index: number) => number; default: not declared - return.lower: (index: number) => number; default: not declared - return.near: (first: number, second: number) => boolean; default: not declared - return.open: (index: number) => number; default: not declared - return.range: (index: number) => number; default: not declared - return.rangeAverage10: number; default: not declared - return.rangeAverage5: number; default: not declared - return.shadowAverage: number; default: not declared - return.shortBody: (index: number) => boolean; default: not declared - return.shortLower: (index: number) => boolean; default: not declared - return.shortUpper: (index: number) => boolean; default: not declared - return.signedBody: (index: number) => number; default: not declared - return.upper: (index: number) => number; default: not declared - return.veryLongBody: (index: number) => boolean; default: not declared - return.veryLongLower: (index: number) => boolean; default: not declared - return.veryShortLower: (index: number) => boolean; default: not declared - return.veryShortUpper: (index: number) => boolean; default: not declared - return.white: (index: number) => boolean; default: not declared - shadowAverage: number; default: not declared - shortBody: (index: number) => boolean; default: not declared - shortBody(index): number; default: not declared - shortLower: (index: number) => boolean; default: not declared - shortLower(index): number; default: not declared - shortUpper: (index: number) => boolean; default: not declared - shortUpper(index): number; default: not declared - signedBody: (index: number) => number; default: not declared - signedBody(index): number; default: not declared - upper: (index: number) => number; default: not declared - upper(index): number; default: not declared - veryLongBody: (index: number) => boolean; default: not declared - veryLongBody(index): number; default: not declared - veryLongLower: (index: number) => boolean; default: not declared - veryLongLower(index): number; default: not declared - veryShortLower: (index: number) => boolean; default: not declared - veryShortLower(index): number; default: not declared - veryShortUpper: (index: number) => boolean; default: not declared - veryShortUpper(index): number; default: not declared - white: (index: number) => boolean; default: not declared - white(index): number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CandleZParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CandleZParameters { period?: number; /** Delta degrees of freedom for the sample standard deviation. Default 1. */ ddof?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CandleZPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CandleZPoint { open: number; high: number; low: number; close: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ChaikinOscParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Chaikin Oscillator ───────────────────────── export interface ChaikinOscParameters { fast?: number; slow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ChaikinVolatilityParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Chaikin Volatility ───────────────────────── export interface ChaikinVolatilityParameters { period: number; rocPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared - rocPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ChandeKrollStopParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Chande Kroll Stop ───────────────────────── export interface ChandeKrollStopParameters { /** ATR length + first-stage high/low lookback (TA `p`). Default 10. */ atrPeriod?: number; /** ATR multiplier (TA `x`). Default 1. */ multiplier?: number; /** Second-stage stop lookback (TA `q`). Default 9. */ period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. ### @insiderfinance/totalfinance/technical-analysis#ChandeKrollStopPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChandeKrollStopPoint { /** Long stop — highest first-stage high-stop over the lookback (trails above price). */ long: number; /** Short stop — lowest first-stage low-stop over the lookback (trails below price). */ short: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long: number; default: not declared — Long stop — highest first-stage high-stop over the lookback (trails above price). - short: number; default: not declared — Short stop — lowest first-stage low-stop over the lookback (trails below price). ### @insiderfinance/totalfinance/technical-analysis#ChandelierParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Chandelier exits ───────────────────────── export interface ChandelierParameters { period: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ChandelierPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChandelierPoint { long: number; short: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long: number; default: not declared - short: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ChannelPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ChannelPoint { upper: number; middle: number; lower: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lower: number; default: not declared - middle: number; default: not declared - upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#Condition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A boolean predicate over the signal context, tagged with the column refs it reads. ```typescript /** A boolean predicate over the signal context, tagged with the column refs it reads. */ export interface Condition { (context: SignalContext, barIndex: number): boolean; /** String operands (column aliases, dotted sub-fields, raw fields) this condition reads. */ readonly refs: readonly string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (barIndex): number; default: not declared - (context): SignalContext; default: not declared - (context).get: (operand: Operand, barIndex: number) => number; default: not declared - refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#ConnorsRsiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Connors RSI ───────────────────────── export interface ConnorsRsiParameters { rsiPeriod?: number; streakPeriod?: number; rankPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - rankPeriod?: number; default: not declared - rsiPeriod?: number; default: not declared - streakPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CoppockParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Coppock curve ───────────────────────── export interface CoppockParameters { longRoc?: number; shortRoc?: number; wma?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - longRoc?: number; default: not declared - shortRoc?: number; default: not declared - wma?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CountBarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CountBarParameters { count: number; flush?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared - flush?: boolean; default: not declared ### @insiderfinance/totalfinance/technical-analysis#CovarianceParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CovarianceParameters { period?: number; /** Use the sample (n−1) denominator. Default true. */ sample?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared - sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. ### @insiderfinance/totalfinance/technical-analysis#CprPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Central Pivot Range ───────────────────────── export interface CprPoint { /** Pivot = (H + L + C) / 3 of the prior bar. */ pivot: number; /** Top central = 2·pivot − bottomCentral. */ topCentral: number; /** Bottom central = (H + L) / 2 of the prior bar. */ bottomCentral: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bottomCentral: number; default: not declared — Bottom central = (H + L) / 2 of the prior bar. - pivot: number; default: not declared — Pivot = (H + L + C) / 3 of the prior bar. - topCentral: number; default: not declared — Top central = 2·pivot − bottomCentral. ### @insiderfinance/totalfinance/technical-analysis#CrossSignalParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CrossSignalParameters { /** Enter long when the series crosses up through this level. Default 0. */ above?: number; /** Exit when the series crosses down through this level. Default 0. */ below?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. ### @insiderfinance/totalfinance/technical-analysis#CvdAggregator Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Streaming, serializable cumulative-volume-delta aggregator — feed it trades (with optional aligned quotes) and it tracks running CVD and buy/sell volume. Mirrors the framework's stream ethos so it can be checkpointed and resumed mid-tape. ```typescript export declare class CvdAggregator { constructor(method?: AggressorMethod); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CvdAggregator; buyVolume: number; cumulative: number; next(trade: Trade, quote?: Quote): { sign: TradeDirection; delta: number; cumulative: number; }; sellVolume: number; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (method)?: AggressorMethod; default: not declared - buyVolume: number; default: not declared - cumulative: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CvdAggregator; default: not declared - fromJSON().return.buyVolume: number; default: not declared - fromJSON().return.cumulative: number; default: not declared - fromJSON().return.next: (trade: Trade, quote?: Quote) => { sign: TradeDirection; delta: number; cumulative: number; }; default: not declared — Process one trade; returns `{ sign, delta, cumulative }` for it. - fromJSON().return.sellVolume: number; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared — Serialize as a {@link TechnicalAnalysisSnapshot}, like every other stream in the package. This class used to return a bare `Record` — no `kind`, no `schemaVersion`, no `state` — so it sat outside the envelope law entirely: its snapshot could not say which aggregator wrote it, could not be version-checked, and lost non-finite numbers to `JSON.stringify` with nothing to notice. The structural gate in `restorer-conformance` is what surfaced it; it was the only serializer in the package building an envelope by hand. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (trade: Trade, quote?: Quote) => { sign: TradeDirection; delta: number; cumulative: number; }; default: not declared — Process one trade; returns `{ sign, delta, cumulative }` for it. - next().return.cumulative: number; default: not declared - next().return.delta: number; default: not declared - next().return.sign: TradeDirection; default: not declared - next(quote)?: Quote | undefined; default: not declared - next(quote).ask: number; default: not declared - next(quote).askSize?: number; default: not declared - next(quote).bid: number; default: not declared - next(quote).bidSize?: number; default: not declared - next(trade): Trade; default: not declared - next(trade).price: number; default: not declared - next(trade).side?: 'buy' | 'sell'; default: not declared — Explicit aggressor side if the feed provides it — takes precedence over inference. - next(trade).size: number; default: not declared - next(trade).time?: number; default: not declared — Epoch milliseconds (optional; required only for time-bucketed footprint bars). - return.buyVolume: number; default: not declared - return.cumulative: number; default: not declared - return.next: (trade: Trade, quote?: Quote) => { sign: TradeDirection; delta: number; cumulative: number; }; default: not declared — Process one trade; returns `{ sign, delta, cumulative }` for it. - return.sellVolume: number; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared — Serialize as a {@link TechnicalAnalysisSnapshot}, like every other stream in the package. This class used to return a bare `Record` — no `kind`, no `schemaVersion`, no `state` — so it sat outside the envelope law entirely: its snapshot could not say which aggregator wrote it, could not be version-checked, and lost non-finite numbers to `JSON.stringify` with nothing to notice. The structural gate in `restorer-conformance` is what surfaced it; it was the only serializer in the package building an envelope by hand. - sellVolume: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared — Serialize as a {@link TechnicalAnalysisSnapshot}, like every other stream in the package. This class used to return a bare `Record` — no `kind`, no `schemaVersion`, no `state` — so it sat outside the envelope law entirely: its snapshot could not say which aggregator wrote it, could not be version-checked, and lost non-finite numbers to `JSON.stringify` with nothing to notice. The structural gate in `restorer-conformance` is what surfaced it; it was the only serializer in the package building an envelope by hand. - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#CvdParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CvdParameters { /** Aggressor inference method. Default `'quote'` (Lee-Ready) when quotes are supplied, else `'tick'`. */ method?: AggressorMethod; /** NBBO quotes aligned 1:1 with `trades` (for the quote rule). */ quotes?: readonly Quote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method?: AggressorMethod; default: not declared — Aggressor inference method. Default `'quote'` (Lee-Ready) when quotes are supplied, else `'tick'`. - quotes?: readonly Quote[]; default: not declared — NBBO quotes aligned 1:1 with `trades` (for the quote rule). ### @insiderfinance/totalfinance/technical-analysis#CvdResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CVD report (Law 2): the aligned series and totals plus conventions and diagnostics. ```typescript // ───────────────────────── cumulative volume delta ───────────────────────── /** CVD report (Law 2): the aligned series and totals plus conventions and diagnostics. */ export interface CvdResult { /** Per-trade signed volume (`sign · size`). */ delta: number[]; /** Running cumulative volume delta after each trade. */ cumulative: number[]; /** Per-trade aggressor sign (+1 / −1 / 0). */ sign: number[]; buyVolume: number; sellVolume: number; /** Applied conventions, echoed — `method` is the aggressor rule actually used. */ assumptions: { conventionsVersion: string; method: AggressorMethod; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: AggressorMethod; }; default: not declared — Applied conventions, echoed — `method` is the aggressor rule actually used. - assumptions.conventionsVersion: string; default: not declared - assumptions.method: AggressorMethod; default: not declared - buyVolume: number; default: not declared - cumulative: number[]; default: not declared — Running cumulative volume delta after each trade. - delta: number[]; default: not declared — Per-trade signed volume (`sign · size`). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - sellVolume: number; default: not declared - sign: number[]; default: not declared — Per-trade aggressor sign (+1 / −1 / 0). ### @insiderfinance/totalfinance/technical-analysis#DivergenceCode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Signed class code for the aligned/streaming {@link DivergencePoint}: sign is bullish(+)/bearish(−), magnitude is regular(1)/hidden(2). `0` marks a confirmed-nothing bar; `NaN` marks warmup. ```typescript /** * Signed class code for the aligned/streaming {@link DivergencePoint}: sign is bullish(+)/bearish(−), * magnitude is regular(1)/hidden(2). `0` marks a confirmed-nothing bar; `NaN` marks warmup. */ export type DivergenceCode = 0 | 1 | -1 | 2 | -2; ``` ### @insiderfinance/totalfinance/technical-analysis#DivergenceEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A confirmed divergence event (the point-list form returned by {@link divergences}). ```typescript /** A confirmed divergence event (the point-list form returned by {@link divergences}). */ export interface DivergenceEvent { /** Confirmation bar index. */ index: number; kind: DivergenceKind; /** `[earlier-swing, confirming-swing]` price. */ priceSwings: [ number, number ]; /** `[earlier-swing, confirming-swing]` indicator value. */ indicatorSwings: [ number, number ]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - index: number; default: not declared — Confirmation bar index. - indicatorSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` indicator value. - kind: DivergenceKind; default: not declared - priceSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` price. ### @insiderfinance/totalfinance/technical-analysis#DivergenceKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The four standard divergence classes. ```typescript /** The four standard divergence classes. */ export type DivergenceKind = 'bullish' | 'bearish' | 'hiddenBullish' | 'hiddenBearish'; ``` ### @insiderfinance/totalfinance/technical-analysis#DivergenceParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DivergenceParameters { /** Fractal confirmation window (default `{ left: 5, right: 5 }`). */ swing?: SwingWindow; /** Which divergence classes to emit (default all four). */ kinds?: DivergenceKind[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kinds?: DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - swing?: SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - swing.left?: number; default: not declared — Bars to the left of a pivot that must be higher/lower. Defaults to 5; echoed via `.explain()`. - swing.right?: number; default: not declared — Bars to the right that confirm the pivot. Defaults to 5; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#DivergencePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One aligned/streaming point. All fields are numeric (so warmup slots are cleanly all-`NaN`): the friendly string `kind` lives on {@link DivergenceEvent}, the event-list shape. `code` is `0` when a bar confirms no divergence and `NaN` during warmup. ```typescript /** * One aligned/streaming point. All fields are numeric (so warmup slots are cleanly all-`NaN`): the * friendly string `kind` lives on {@link DivergenceEvent}, the event-list shape. `code` is `0` when a * bar confirms no divergence and `NaN` during warmup. */ export interface DivergencePoint { /** Confirmation bar index (`NaN` when no divergence / warmup). */ index: number; /** Signed class code (see {@link DivergenceCode}); `0` none, `NaN` warmup. */ code: number; /** `[earlier-swing, confirming-swing]` price (`[NaN, NaN]` when none). */ priceSwings: [ number, number ]; /** `[earlier-swing, confirming-swing]` indicator value (`[NaN, NaN]` when none). */ indicatorSwings: [ number, number ]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: number; default: not declared — Signed class code (see {@link DivergenceCode}); `0` none, `NaN` warmup. - index: number; default: not declared — Confirmation bar index (`NaN` when no divergence / warmup). - indicatorSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` indicator value (`[NaN, NaN]` when none). - priceSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` price (`[NaN, NaN]` when none). ### @insiderfinance/totalfinance/technical-analysis#DmiPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── DMI (+DI / −DI / DX) ───────────────────────── export interface DmiPoint { plusDI: number; minusDI: number; dx: number; /** Wilder-smoothed +DM. */ plusDM: number; /** Wilder-smoothed −DM. */ minusDM: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dx: number; default: not declared - minusDI: number; default: not declared - minusDM: number; default: not declared — Wilder-smoothed −DM. - plusDI: number; default: not declared - plusDM: number; default: not declared — Wilder-smoothed +DM. ### @insiderfinance/totalfinance/technical-analysis#DollarBarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DollarBarParameters { dollar: number; flush?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dollar: number; default: not declared - flush?: boolean; default: not declared ### @insiderfinance/totalfinance/technical-analysis#DrawdownPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface DrawdownPoint { /** Peak-to-current decline in price/equity units. */ drawdown: number; /** Peak-to-current decline as a positive fraction. */ percent: number; /** Log drawdown: `log(peak) - log(value)`. */ log: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - percent: number; default: not declared — Peak-to-current decline as a positive fraction. ### @insiderfinance/totalfinance/technical-analysis#DspParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── pandas-ta cycle additions ───────────────────────── export interface DspParameters { period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#EbswParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EbswParameters { /** Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. */ period?: number; /** Low-pass filtering period. Default 10. */ bars?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bars?: number; default: not declared — Low-pass filtering period. Default 10. - period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. ### @insiderfinance/totalfinance/technical-analysis#ElderRayPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Elder Ray ───────────────────────── export interface ElderRayPoint { bull: number; bear: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bear: number; default: not declared - bull: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ElderThermometerParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Elder's Market Thermometer ───────────────────────── export interface ElderThermometerParameters { period?: number; /** "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. */ long?: number; /** "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. */ short?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - period?: number; default: not declared - short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. ### @insiderfinance/totalfinance/technical-analysis#ElderThermometerPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ElderThermometerPoint { thermo: number; movingAverage: number; /** 1 when thermo < movingAverage·long (calm). */ long: number; /** 1 when thermo > movingAverage·short (active). */ short: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long: number; default: not declared — 1 when thermo < movingAverage·long (calm). - movingAverage: number; default: not declared - short: number; default: not declared — 1 when thermo > movingAverage·short (active). - thermo: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#EomParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Ease of Movement ───────────────────────── export interface EomParameters { period: number; /** Volume scale to keep the box ratio in a sane range. Default 1e8. */ scale?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared - scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. ### @insiderfinance/totalfinance/technical-analysis#EqualLevelParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── equal highs / equal lows (liquidity pools) ───────────────────────── export interface EqualLevelParameters { /** Swing strength (bars on each side). Default 2. */ strength?: number; /** Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). ### @insiderfinance/totalfinance/technical-analysis#EqualLevelPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EqualLevelPoint { /** 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. */ detected: number; /** The (averaged) equal level when detected, else `null`. */ level: number | null; /** Size of the current equal cluster (≥2 when detected, else 0). */ count: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. ### @insiderfinance/totalfinance/technical-analysis#FIB_EXTENSION_LEVELS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const FIB_EXTENSION_LEVELS: readonly [0, 0.618, 1, 1.618, 2, 2.618]; ``` ### @insiderfinance/totalfinance/technical-analysis#FIB_RETRACEMENT_LEVELS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const FIB_RETRACEMENT_LEVELS: readonly [0, 0.236, 0.382, 0.5, 0.618, 0.786, 1]; ``` ### @insiderfinance/totalfinance/technical-analysis#FeatureColumn Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A computed column: one value (scalar or record) per input bar. ```typescript /** A computed column: one value (scalar or record) per input bar. */ export type FeatureColumn = unknown[]; ``` ### @insiderfinance/totalfinance/technical-analysis#FeaturePipeline Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class FeaturePipeline { constructor(candles: BarInput[]); applyBars(indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }): FeaturePipeline; applySeries(field: Field, indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }): FeaturePipeline; atr(parameters?: WilderPeriodParameters, options?: AliasOpt): FeaturePipeline; bbands(field: Field, parameters?: BollingerParameters, options?: AliasOpt): FeaturePipeline; column(alias: string, values: FeatureColumn): FeaturePipeline; ema(field: Field, parameters: PeriodParameters, options?: AliasOpt): FeaturePipeline; field(field: Field): number[]; macd(field: Field, parameters?: MacdParameters, options?: AliasOpt): FeaturePipeline; obv(options?: AliasOpt): FeaturePipeline; returns(field: Field, options?: AliasOpt): FeaturePipeline; rollingVolatility(field: Field, parameters: RollingVolatilityParameters, options?: AliasOpt): FeaturePipeline; rsi(field: Field, parameters?: RsiParameters, options?: AliasOpt): FeaturePipeline; sma(field: Field, parameters: PeriodParameters, options?: AliasOpt): FeaturePipeline; toColumns(): Record; toRows(): Record[]; vwap(options?: AliasOpt): FeaturePipeline; wma(field: Field, parameters: PeriodParameters, options?: AliasOpt): FeaturePipeline; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (candles): BarInput[]; default: not declared - applyBars: (indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }) => FeaturePipeline; default: not declared — Apply any bar indicator (BarInput → Out) to the candles. - applyBars(indicator): Indicator; default: not declared - applyBars(indicator).explain: (input: ArrayLike, parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - applyBars(indicator).fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - applyBars(indicator).stream: (parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - applyBars(options): AliasOpt & { as: string; }; default: not declared - applyBars(options).as?: string; default: not declared - applyBars(parameters): P; default: not declared - applySeries: (field: Field, indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }) => FeaturePipeline; default: not declared — Apply any series indicator (number → Out) to a price field. The generic escape hatch that lets the pipeline reach every indicator in the catalog, not just the named convenience methods. - applySeries(field): Field; default: not declared - applySeries(indicator): Indicator; default: not declared - applySeries(indicator).explain: (input: ArrayLike, parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - applySeries(indicator).fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - applySeries(indicator).stream: (parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - applySeries(options): AliasOpt & { as: string; }; default: not declared - applySeries(options).as?: string; default: not declared - applySeries(parameters): P; default: not declared - atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: ATR's Wilder period defaults to 14, exactly as `atr(bars)` does. - atr(options)?: AliasOpt | undefined; default: not declared - atr(options).as?: string; default: not declared - atr(parameters)?: WilderPeriodParameters | undefined; default: not declared - atr(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - bbands: (field: Field, parameters?: BollingerParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: Bollinger's period defaults to 20, exactly as `bbands(series)` does. - bbands(field): Field; default: not declared - bbands(options)?: AliasOpt | undefined; default: not declared - bbands(options).as?: string; default: not declared - bbands(parameters)?: BollingerParameters | undefined; default: not declared - bbands(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - bbands(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - column: (alias: string, values: FeatureColumn) => FeaturePipeline; default: not declared — Inject a precomputed column under an alias. - column(alias): string; default: not declared - column(values): FeatureColumn; default: not declared - ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - ema(field): Field; default: not declared - ema(options)?: AliasOpt | undefined; default: not declared - ema(options).as?: string; default: not declared - ema(parameters): PeriodParameters; default: not declared - ema(parameters).period: number; default: not declared - field: (field: Field) => number[]; default: not declared — The raw `field` column (`close`, `high`, …) as a number array. - field(field): Field; default: not declared - macd: (field: Field, parameters?: MacdParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - macd(field): Field; default: not declared - macd(options)?: AliasOpt | undefined; default: not declared - macd(options).as?: string; default: not declared - macd(parameters)?: MacdParameters | undefined; default: not declared - macd(parameters).fast?: number; default: not declared - macd(parameters).signal?: number; default: not declared - macd(parameters).slow?: number; default: not declared - obv: (options?: AliasOpt) => FeaturePipeline; default: not declared - obv(options)?: AliasOpt | undefined; default: not declared - obv(options).as?: string; default: not declared - return.applyBars: (indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }) => FeaturePipeline; default: not declared — Apply any bar indicator (BarInput → Out) to the candles. - return.applySeries: (field: Field, indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }) => FeaturePipeline; default: not declared — Apply any series indicator (number → Out) to a price field. The generic escape hatch that lets the pipeline reach every indicator in the catalog, not just the named convenience methods. - return.atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: ATR's Wilder period defaults to 14, exactly as `atr(bars)` does. - return.bbands: (field: Field, parameters?: BollingerParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: Bollinger's period defaults to 20, exactly as `bbands(series)` does. - return.column: (alias: string, values: FeatureColumn) => FeaturePipeline; default: not declared — Inject a precomputed column under an alias. - return.ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - return.field: (field: Field) => number[]; default: not declared — The raw `field` column (`close`, `high`, …) as a number array. - return.macd: (field: Field, parameters?: MacdParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - return.obv: (options?: AliasOpt) => FeaturePipeline; default: not declared - return.returns: (field: Field, options?: AliasOpt) => FeaturePipeline; default: not declared - return.rollingVolatility: (field: Field, parameters: RollingVolatilityParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - return.rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: RSI's period defaults to 14, exactly as `rsi(series)` does. - return.sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — The convenience methods all follow one order, and the order is the point: validate the alias, then CALL THE INDICATOR, then build the auto-name from the parameters it just accepted. The first version built the name first — `` `sma_${field}_${parameters.period}` `` — so a caller who omitted `parameters` got `TypeError: Cannot read properties of undefined (reading 'period')` from the pipeline instead of `sma`'s own teaching `InputError`. Worse for `rsi` and `atr`, whose direct forms default to 14: the fluent wrapper was STRICTER than the thing it wraps. Calling the indicator first delegates every parameter question to the validator that owns it. - return.toColumns: () => Record; default: not declared — Columnar output keyed by alias. - return.toRows: () => Record[]; default: not declared — Row-oriented output: one object per bar with each alias as a key. - return.vwap: (options?: AliasOpt) => FeaturePipeline; default: not declared - return.wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - returns: (field: Field, options?: AliasOpt) => FeaturePipeline; default: not declared - returns(field): Field; default: not declared - returns(options)?: AliasOpt | undefined; default: not declared - returns(options).as?: string; default: not declared - rollingVolatility: (field: Field, parameters: RollingVolatilityParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - rollingVolatility(field): Field; default: not declared - rollingVolatility(options)?: AliasOpt | undefined; default: not declared - rollingVolatility(options).as?: string; default: not declared - rollingVolatility(parameters): RollingVolatilityParameters; default: not declared - rollingVolatility(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - rollingVolatility(parameters).period: number; default: not declared - rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: RSI's period defaults to 14, exactly as `rsi(series)` does. - rsi(field): Field; default: not declared - rsi(options)?: AliasOpt | undefined; default: not declared - rsi(options).as?: string; default: not declared - rsi(parameters)?: RsiParameters | undefined; default: not declared - rsi(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — The convenience methods all follow one order, and the order is the point: validate the alias, then CALL THE INDICATOR, then build the auto-name from the parameters it just accepted. The first version built the name first — `` `sma_${field}_${parameters.period}` `` — so a caller who omitted `parameters` got `TypeError: Cannot read properties of undefined (reading 'period')` from the pipeline instead of `sma`'s own teaching `InputError`. Worse for `rsi` and `atr`, whose direct forms default to 14: the fluent wrapper was STRICTER than the thing it wraps. Calling the indicator first delegates every parameter question to the validator that owns it. - sma(field): Field; default: not declared - sma(options)?: AliasOpt | undefined; default: not declared - sma(options).as?: string; default: not declared - sma(parameters): PeriodParameters; default: not declared - sma(parameters).period: number; default: not declared - toColumns: () => Record; default: not declared — Columnar output keyed by alias. - toRows: () => Record[]; default: not declared — Row-oriented output: one object per bar with each alias as a key. - vwap: (options?: AliasOpt) => FeaturePipeline; default: not declared - vwap(options)?: AliasOpt | undefined; default: not declared - vwap(options).as?: string; default: not declared - wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - wma(field): Field; default: not declared - wma(options)?: AliasOpt | undefined; default: not declared - wma(options).as?: string; default: not declared - wma(parameters): PeriodParameters; default: not declared - wma(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#FibLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FibLevel { ratio: number; price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared - ratio: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#Field Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type Field = 'open' | 'high' | 'low' | 'close'; ``` ### @insiderfinance/totalfinance/technical-analysis#FisherParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Fisher Transform ───────────────────────── export interface FisherParameters { period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#FisherPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FisherPoint { fisher: number; trigger: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fisher: number; default: not declared - trigger: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#FootprintBar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── footprint bars ───────────────────────── export interface FootprintBar extends BarInput { volume: number; buyVolume: number; sellVolume: number; /** `buyVolume − sellVolume`. */ delta: number; trades: number; /** Bar start time (epoch ms) if trades carry timestamps. */ time?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buyVolume: number; default: not declared - close: number; default: not declared - delta: number; default: not declared — `buyVolume − sellVolume`. - high: number; default: not declared - low: number; default: not declared - open?: number; default: not declared - sellVolume: number; default: not declared - time?: number; default: not declared — Bar start time (epoch ms) if trades carry timestamps. - trades: number; default: not declared - volume: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#FootprintBarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FootprintBarParameters { /** Aggregation rule and threshold. `by` defaults to `'volume'`. */ by?: 'count' | 'volume' | 'time'; /** Trades per bar (`count`), volume per bar (`volume`), or milliseconds per bar (`time`). */ threshold: number; method?: AggressorMethod; quotes?: readonly Quote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - by?: 'time' | 'volume' | 'count'; default: not declared — Aggregation rule and threshold. `by` defaults to `'volume'`. - method?: AggressorMethod; default: not declared - quotes?: readonly Quote[]; default: not declared - threshold: number; default: not declared — Trades per bar (`count`), volume per bar (`volume`), or milliseconds per bar (`time`). ### @insiderfinance/totalfinance/technical-analysis#FramaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── FRAMA (fractal adaptive, Ehlers) ───────────────────────── export interface FramaParameters { /** Lookback (rounded up to an even number). Default 16. */ period: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared — Lookback (rounded up to an even number). Default 16. ### @insiderfinance/totalfinance/technical-analysis#FvgParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FvgParameters { /** Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. */ minimumGapPercent?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. ### @insiderfinance/totalfinance/technical-analysis#GannHiLoPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Gann HiLo Activator ───────────────────────── export interface GannHiLoPoint { /** The active HiLo line. */ value: number; /** +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). */ trend: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - value: number; default: not declared — The active HiLo line. ### @insiderfinance/totalfinance/technical-analysis#Gap Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Gap { index: number; direction: 1 | -1; /** Gap size as a FRACTION of the prior close (`0.005` = a 0.5% gap). */ sizeFraction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 1 | -1; default: not declared - index: number; default: not declared - sizeFraction: number; default: not declared — Gap size as a FRACTION of the prior close (`0.005` = a 0.5% gap). ### @insiderfinance/totalfinance/technical-analysis#GapFillEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface GapFillEvent { index: number; direction: 1 | -1; /** Lower / upper bound of the gap zone. */ gapFrom: number; gapTo: number; /** Gap size as a FRACTION of the prior close (`0.005` = a 0.5% gap). */ sizeFraction: number; filled: boolean; /** Index of the bar that first traded back to the prior close, or −1 if never filled. */ fillIndex: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 1 | -1; default: not declared - fillIndex: number; default: not declared — Index of the bar that first traded back to the prior close, or −1 if never filled. - filled: boolean; default: not declared - gapFrom: number; default: not declared — Lower / upper bound of the gap zone. - gapTo: number; default: not declared - index: number; default: not declared - sizeFraction: number; default: not declared — Gap size as a FRACTION of the prior close (`0.005` = a 0.5% gap). ### @insiderfinance/totalfinance/technical-analysis#HeikinAshiBar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ---- Heikin-Ashi (smoothed candles; also re-exported by chart-types) ---- export interface HeikinAshiBar { open: number; high: number; low: number; close: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#HilbertCore Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared Ehlers Hilbert-transform discriminator. Emits once the FIR history has filled (~6 bars). ```typescript export declare class HilbertCore { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HilbertCore; toJSON(): TechnicalAnalysisSnapshot; update(priceValue: number): HilbertOut | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HilbertCore; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.update: (priceValue: number) => HilbertOut | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.update: (priceValue: number) => HilbertOut | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - update: (priceValue: number) => HilbertOut | null; default: not declared - update().return.dcPeriod: number; default: not declared — Dominant cycle period (smoothed), clamped to [6, 50]. - update().return.dcPhase: number; default: not declared — Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). - update().return.inPhase: number; default: not declared — In-phase component. - update().return.quadrature: number; default: not declared — Quadrature component. - update().return.trendline: number; default: not declared — Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). - update(priceValue): number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#HilbertOut Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HilbertOut { /** Dominant cycle period (smoothed), clamped to [6, 50]. */ dcPeriod: number; /** In-phase component. */ inPhase: number; /** Quadrature component. */ quadrature: number; /** Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). */ dcPhase: number; /** Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). */ trendline: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dcPeriod: number; default: not declared — Dominant cycle period (smoothed), clamped to [6, 50]. - dcPhase: number; default: not declared — Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). - inPhase: number; default: not declared — In-phase component. - quadrature: number; default: not declared — Quadrature component. - trendline: number; default: not declared — Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). ### @insiderfinance/totalfinance/technical-analysis#HistoricalVolatilityParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── close-to-close historical volatility ───────────────────────── export interface HistoricalVolatilityParameters { period: number; /** Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. */ annualization: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#HoltWinterChannelParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Holt-Winters Channel ───────────────────────── export interface HoltWinterChannelParameters { /** Level smoothing. Default 0.2. */ levelSmoothing?: number; /** Trend smoothing. Default 0.1. */ trendSmoothing?: number; /** Acceleration smoothing. Default 0.1. */ accelerationSmoothing?: number; /** Variance smoothing for the channel width. Default 0.1. */ varianceSmoothing?: number; /** Standard-deviation multiplier for the bands. Default 1. */ scalar?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. ### @insiderfinance/totalfinance/technical-analysis#HwmaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Holt-Winters MA ───────────────────────── export interface HwmaParameters { /** Level smoothing (levelSmoothing). Default 0.2. */ levelSmoothing?: number; /** Trend smoothing (trendSmoothing). Default 0.1. */ trendSmoothing?: number; /** Acceleration smoothing (accelerationSmoothing). Default 0.1. */ accelerationSmoothing?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. ### @insiderfinance/totalfinance/technical-analysis#IchimokuParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Ichimoku ───────────────────────── export interface IchimokuParameters { conversion?: number; base?: number; spanB?: number; /** * Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component * values themselves are NOT shifted (see `IchimokuPoint`). */ displacement?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - base?: number; default: not declared - conversion?: number; default: not declared - displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - spanB?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IchimokuPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ichimoku components computed causally at the current bar — **no look-ahead, no shifting**. To draw a standard Ichimoku cloud, plot `senkouA`/`senkouB` shifted **forward** by `displacement` bars and `chikou` shifted **backward** by `displacement` bars; `displacement` is echoed here so the caller knows the offset to apply. ```typescript /** * Ichimoku components computed causally at the current bar — **no look-ahead, no shifting**. To draw a * standard Ichimoku cloud, plot `senkouA`/`senkouB` shifted **forward** by `displacement` bars and * `chikou` shifted **backward** by `displacement` bars; `displacement` is echoed here so the caller * knows the offset to apply. */ export interface IchimokuPoint { /** Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. */ tenkan: number; /** Base line (Kijun-sen): midpoint of the last `base` bars. */ kijun: number; /** Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. */ senkouA: number; /** Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. */ senkouB: number; /** Lagging span (Chikou): the current close — plot `displacement` bars behind. */ chikou: number; /** The displacement (in bars) to apply when plotting the spans/chikou. */ displacement: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. ### @insiderfinance/totalfinance/technical-analysis#Indicator Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A facade indicator: callable (batch) with `.explain`, `.stream`, and `.fromJSON`. `parameters` is OPTIONAL on every call form (the first-touch law): a parameters object is never required just to *reach* the facade. When it is omitted, indicators with industry-standard defaults (RSI 14, MACD 12/26/9, BBands 20/2, …) resolve them; indicators whose parameters have no universal default throw a typed teaching `InputError` naming the field — never a raw `TypeError` from a property access. ```typescript /** * A facade indicator: callable (batch) with `.explain`, `.stream`, and `.fromJSON`. * * `parameters` is OPTIONAL on every call form (the first-touch law): a parameters object is never required * just to *reach* the facade. When it is omitted, indicators with industry-standard defaults (RSI 14, * MACD 12/26/9, BBands 20/2, …) resolve them; indicators whose parameters have no universal default throw * a typed teaching `InputError` naming the field — never a raw `TypeError` from a property access. */ export interface Indicator { (input: ArrayLike, parameters?: Params): Out[]; explain(input: ArrayLike, parameters?: Params): TechnicalAnalysisExplain; stream(parameters?: Params): LiveStream; fromJSON(snapshot: TechnicalAnalysisSnapshot): LiveStream; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Params | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Params) => TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: Out[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Params | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => LiveStream; default: not declared - fromJSON().return.next: (input: In) => Out | null; default: not declared - fromJSON().return.peek: (input: In) => Out | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: Out | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Params) => LiveStream; default: not declared - stream().return.next: (input: In) => Out | null; default: not declared - stream().return.peek: (input: In) => Out | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: Out | null; default: not declared - stream(parameters)?: Params | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorAliasRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface IndicatorAliasRow { /** Canonical TotalFinance name (must be registered). */ totalfinance: string; /** TA-Lib function name(s), uppercase. */ talib?: string | string[]; /** pandas-ta name(s), snake_case. */ pandas?: string | string[]; /** TradingView display name. */ tradingview?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - pandas?: string | string[]; default: not declared — pandas-ta name(s), snake_case. - talib?: string | string[]; default: not declared — TA-Lib function name(s), uppercase. - totalfinance: string; default: not declared — Canonical TotalFinance name (must be registered). - tradingview?: string; default: not declared — TradingView display name. ### @insiderfinance/totalfinance/technical-analysis#IndicatorCategory Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type IndicatorCategory = 'transform' | 'moving-average' | 'momentum' | 'trend' | 'volatility' | 'volume' | 'cycle' | 'math' | 'performance' | 'statistic' | 'candlestick' | 'price-action' | 'custom'; ``` ### @insiderfinance/totalfinance/technical-analysis#IndicatorConventions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A JSON-safe record of the CHOICES an indicator made that its parameters do not reveal. Parameters say what you asked for; conventions say what the library decided on your behalf — and those decisions are where two implementations of "the same" indicator disagree. RSI is the canonical case: TotalFinance smooths with Wilder's method (not a plain EMA) and returns 100 on a perfectly flat series, where TA-Lib returns 0 and pandas-ta returns NaN. All three are defensible; none is discoverable from the number alone. Values are scalars so the block survives `JSON.stringify` intact and reads the same over MCP as it does in a REPL. Keys are per indicator, but recurring ones are spelled consistently: `smoothing`, `seeding`, `flatSeries`, `scale`, `reference`, `divergence`. ```typescript // NOTE: the batch shape `{ value, warmup }` returned by `collect`/`collectAsync` is deliberately an // inline structural type, NOT a named public type — R1 deleted `SeriesResult`. The public // `.explain()` envelope is `TechnicalAnalysisExplain` (one envelope law, dx §2.2): `value` + `assumptions` + // `diagnostics`, with the warmup count under `diagnostics.warmup`. /** * A JSON-safe record of the CHOICES an indicator made that its parameters do not reveal. * * Parameters say what you asked for; conventions say what the library decided on your behalf — and * those decisions are where two implementations of "the same" indicator disagree. RSI is the * canonical case: TotalFinance smooths with Wilder's method (not a plain EMA) and returns 100 on a * perfectly flat series, where TA-Lib returns 0 and pandas-ta returns NaN. All three are defensible; * none is discoverable from the number alone. * * Values are scalars so the block survives `JSON.stringify` intact and reads the same over MCP as it * does in a REPL. Keys are per indicator, but recurring ones are spelled consistently: `smoothing`, * `seeding`, `flatSeries`, `scale`, `reference`, `divergence`. */ export type IndicatorConventions = Readonly>; ``` ### @insiderfinance/totalfinance/technical-analysis#IndicatorDefinition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface IndicatorDefinition { name: string; category?: IndicatorCategory; inputs: IndicatorInputs; parameters?: string[]; /** Output metadata (Wave 6 §4) — the recursive value schema + optional visualization. Required. */ output: IndicatorOutputMetadata; /** * Declared default per optional parameter, echoed through `.explain().assumptions.parameters` (the * disclosure law). Every key must appear in `parameters`; parameters without a default are required. */ defaults?: Record; /** See {@link IndicatorMetadata.conventions} — declared here, echoed by every `.explain()`. */ conventions?: IndicatorConventions; /** Stream factory (`makeIndicator`'s `make`). */ stream: (parameters: P) => IndicatorStream; /** TechnicalAnalysisSnapshot restorer (`makeIndicator`'s restore). */ restore: (snapshot: TechnicalAnalysisSnapshot) => IndicatorStream; /** Warmup sentinel factory. */ nan: (parameters: P) => Out; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - category?: IndicatorCategory; default: not declared - conventions?: Readonly>; default: not declared — See {@link IndicatorMetadata.conventions} — declared here, echoed by every `.explain()`. - defaults?: Record; default: not declared — Declared default per optional parameter, echoed through `.explain().assumptions.parameters` (the disclosure law). Every key must appear in `parameters`; parameters without a default are required. - inputs: IndicatorInputs; default: not declared - name: string; default: not declared - nan: (parameters: P) => Out; default: not declared — Warmup sentinel factory. - nan(parameters): P; default: not declared - output: IndicatorOutputMetadata; default: not declared — Output metadata (Wave 6 §4) — the recursive value schema + optional visualization. Required. - output.value: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.bounds?: readonly [number, number]; default: not declared - output.value.fields: Readonly>; default: not declared - output.value.items: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.length?: { fixed: number; } | { parameter: string; }; default: not declared - output.value.length.fixed: number; default: not declared - output.value.length.parameter: string; default: not declared - output.value.role?: string; default: not declared - output.value.type: ('array') | ('boolean') | ('number') | ('record') | ('string'); default: not declared - output.value.unit?: string; default: not declared - output.value.values?: readonly string[]; default: not declared - output.visualization?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorVisualization; default: not declared - output.visualization.kind: 'levels' | 'events' | 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'multi'; default: not declared - output.visualization.plots?: readonly { path: string; role?: string; }[]; default: not declared - output.visualization.referenceLevels?: readonly number[]; default: not declared - parameters?: string[]; default: not declared - restore: (snapshot: TechnicalAnalysisSnapshot) => IndicatorStream; default: not declared — TechnicalAnalysisSnapshot restorer (`makeIndicator`'s restore). - restore().return.next: (input: In) => Out | null; default: not declared - restore().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - restore().return.value: Out | null; default: not declared - restore(snapshot): TechnicalAnalysisSnapshot; default: not declared - restore(snapshot).kind: string; default: not declared - restore(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - restore(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters: P) => IndicatorStream; default: not declared — Stream factory (`makeIndicator`'s `make`). - stream().return.next: (input: In) => Out | null; default: not declared - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: Out | null; default: not declared - stream(parameters): P; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorDescription Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One indicator's full metadata card. ```typescript /** One indicator's full metadata card. */ export interface IndicatorDescription { /** Canonical registered name. */ name: string; category: IndicatorCategory; /** Input kind expected by the indicator. */ inputs: IndicatorInputs; /** All parameter names (including defaulted ones the caller may omit). */ parameters: string[]; /** Declared default per optional parameter; a derived default is a resolver function. */ defaults: Record; /** Parameters with no default — the caller must supply these. */ required: string[]; /** Leading bars before the first real value, or `null` if it never emitted within the probe. */ warmup: number | null; /** The output metadata — recursive value schema + optional visualization (Wave 6 §4). */ output: IndicatorOutputMetadata; /** * The choices this indicator made that its parameters do not reveal (Wilder vs EMA smoothing, what * a flat window resolves to, how the first value is seeded) — present only where such a choice * exists. This is the field that answers "why does your RSI disagree with my other library?" * without leaving the tool schema. */ conventions?: IndicatorConventions; /** Cross-library aliases (TA-Lib / pandas-ta / TradingView), when known. */ aliases?: Omit; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aliases?: Omit; default: not declared — Cross-library aliases (TA-Lib / pandas-ta / TradingView), when known. - aliases.pandas?: string | string[]; default: not declared — pandas-ta name(s), snake_case. - aliases.talib?: string | string[]; default: not declared — TA-Lib function name(s), uppercase. - aliases.tradingview?: string; default: not declared — TradingView display name. - category: IndicatorCategory; default: not declared - conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal (Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded) — present only where such a choice exists. This is the field that answers "why does your RSI disagree with my other library?" without leaving the tool schema. - defaults: Record; default: not declared — Declared default per optional parameter; a derived default is a resolver function. - inputs: IndicatorInputs; default: not declared — Input kind expected by the indicator. - name: string; default: not declared — Canonical registered name. - output: IndicatorOutputMetadata; default: not declared — The output metadata — recursive value schema + optional visualization (Wave 6 §4). - output.value: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.bounds?: readonly [number, number]; default: not declared - output.value.fields: Readonly>; default: not declared - output.value.items: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.length?: { fixed: number; } | { parameter: string; }; default: not declared - output.value.length.fixed: number; default: not declared - output.value.length.parameter: string; default: not declared - output.value.role?: string; default: not declared - output.value.type: ('array') | ('boolean') | ('number') | ('record') | ('string'); default: not declared - output.value.unit?: string; default: not declared - output.value.values?: readonly string[]; default: not declared - output.visualization?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorVisualization; default: not declared - output.visualization.kind: 'levels' | 'events' | 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'multi'; default: not declared - output.visualization.plots?: readonly { path: string; role?: string; }[]; default: not declared - output.visualization.referenceLevels?: readonly number[]; default: not declared - parameters: string[]; default: not declared — All parameter names (including defaulted ones the caller may omit). - required: string[]; default: not declared — Parameters with no default — the caller must supply these. - warmup: number | null; default: not declared — Leading bars before the first real value, or `null` if it never emitted within the probe. ### @insiderfinance/totalfinance/technical-analysis#IndicatorInputs Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type IndicatorInputs = 'series' | 'bars' | 'pair'; ``` ### @insiderfinance/totalfinance/technical-analysis#IndicatorMatchEvidence Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inspectable evidence for why a queried row matched — its match class, score, and the name that hit. ```typescript /** Inspectable evidence for why a queried row matched — its match class, score, and the name that hit. */ export interface IndicatorMatchEvidence { kind: 'canonical-exact' | 'alias-exact' | 'canonical-substring' | 'alias-substring' | 'fuzzy'; /** `1` for an exact match; the substring length ratio; or the normalized fuzzy similarity in `[0, 1]`. */ score: number; /** The canonical name or alias (raw) that produced the match. */ matchedOn: { source: 'canonical' | 'alias'; value: string; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'fuzzy' | 'canonical-exact' | 'alias-exact' | 'canonical-substring' | 'alias-substring'; default: not declared - matchedOn: { source: 'canonical' | 'alias'; value: string; }; default: not declared — The canonical name or alias (raw) that produced the match. - matchedOn.source: 'canonical' | 'alias'; default: not declared - matchedOn.value: string; default: not declared - score: number; default: not declared — `1` for an exact match; the substring length ratio; or the normalized fuzzy similarity in `[0, 1]`. ### @insiderfinance/totalfinance/technical-analysis#IndicatorMetadata Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface IndicatorMetadata { name: string; category: IndicatorCategory; inputs: IndicatorInputs; /** Parameter names (including defaulted ones the caller may omit). */ parameters: string[]; /** * Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in * `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the * rare default computed from another parameter. Bound at built-in construction/custom registration so * `.explain().assumptions.parameters` echoes every default that engages. */ defaults?: Record; /** * The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what * a flat window resolves to, how the first value is seeded. Present only where such a choice exists, * so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by * `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from * the result instead of only from prose. */ conventions?: IndicatorConventions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - category: IndicatorCategory; default: not declared - conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - inputs: IndicatorInputs; default: not declared - name: string; default: not declared - parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). ### @insiderfinance/totalfinance/technical-analysis#IndicatorNumberOutput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A numeric output leaf, optionally with a semantic role, unit, and inclusive value bounds. ```typescript /** A numeric output leaf, optionally with a semantic role, unit, and inclusive value bounds. */ export interface IndicatorNumberOutput { type: 'number'; role?: string; unit?: string; bounds?: readonly [ number, number ]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: readonly [number, number]; default: not declared - role?: string; default: not declared - type: 'number'; default: not declared - unit?: string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorOutputMetadata Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An indicator's output metadata: its runtime value schema plus an optional visualization hint. ```typescript /** An indicator's output metadata: its runtime value schema plus an optional visualization hint. */ export interface IndicatorOutputMetadata { value: IndicatorOutputValue; visualization?: IndicatorVisualization; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - value: IndicatorOutputValue; default: not declared - value.bounds?: readonly [number, number]; default: not declared - value.fields: Readonly>; default: not declared - value.items: IndicatorOutputValue; default: not declared - value.length?: { fixed: number; } | { parameter: string; }; default: not declared - value.length.fixed: number; default: not declared - value.length.parameter: string; default: not declared - value.role?: string; default: not declared - value.type: ('array') | ('boolean') | ('number') | ('record') | ('string'); default: not declared - value.unit?: string; default: not declared - value.values?: readonly string[]; default: not declared - visualization?: IndicatorVisualization; default: not declared - visualization.kind: 'levels' | 'events' | 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'multi'; default: not declared - visualization.plots?: readonly { path: string; role?: string; }[]; default: not declared - visualization.referenceLevels?: readonly number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorOutputValue Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The recursive output value schema — a scalar leaf, a named record, or a vector. ```typescript /** The recursive output value schema — a scalar leaf, a named record, or a vector. */ export type IndicatorOutputValue = IndicatorNumberOutput | { type: 'boolean'; role?: string; } | { type: 'string'; role?: string; values?: readonly string[]; } | { type: 'record'; fields: Readonly>; } | { type: 'array'; items: IndicatorOutputValue; length?: { fixed: number; } | { parameter: string; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bounds?: readonly [number, number]; default: not declared - fields: Readonly>; default: not declared - items: IndicatorOutputValue; default: not declared - length?: { fixed: number; } | { parameter: string; }; default: not declared - length.fixed: number; default: not declared - length.parameter: string; default: not declared - role?: string; default: not declared - type: ('array') | ('boolean') | ('number') | ('record') | ('string'); default: not declared - unit?: string; default: not declared - values?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The bulk-list row shape (no warmup — that is a per-`describe` measurement). ```typescript /** The bulk-list row shape (no warmup — that is a per-`describe` measurement). */ export interface IndicatorRow { name: string; category: IndicatorCategory; inputs: IndicatorInputs; parameters: string[]; defaults: Record; required: string[]; /** The output metadata — recursive value schema + optional visualization (Wave 6 §4). */ output: IndicatorOutputMetadata; /** Present only for a queried search — the deterministic match evidence for ranking/inspection. */ match?: IndicatorMatchEvidence; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - category: IndicatorCategory; default: not declared - defaults: Record; default: not declared - inputs: IndicatorInputs; default: not declared - match?: IndicatorMatchEvidence; default: not declared — Present only for a queried search — the deterministic match evidence for ranking/inspection. - match.kind: 'fuzzy' | 'canonical-exact' | 'alias-exact' | 'canonical-substring' | 'alias-substring'; default: not declared - match.matchedOn: { source: 'canonical' | 'alias'; value: string; }; default: not declared — The canonical name or alias (raw) that produced the match. - match.matchedOn.source: 'canonical' | 'alias'; default: not declared - match.matchedOn.value: string; default: not declared - match.score: number; default: not declared — `1` for an exact match; the substring length ratio; or the normalized fuzzy similarity in `[0, 1]`. - name: string; default: not declared - output: IndicatorOutputMetadata; default: not declared — The output metadata — recursive value schema + optional visualization (Wave 6 §4). - output.value: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.bounds?: readonly [number, number]; default: not declared - output.value.fields: Readonly>; default: not declared - output.value.items: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.length?: { fixed: number; } | { parameter: string; }; default: not declared - output.value.length.fixed: number; default: not declared - output.value.length.parameter: string; default: not declared - output.value.role?: string; default: not declared - output.value.type: ('array') | ('boolean') | ('number') | ('record') | ('string'); default: not declared - output.value.unit?: string; default: not declared - output.value.values?: readonly string[]; default: not declared - output.visualization?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorVisualization; default: not declared - output.visualization.kind: 'levels' | 'events' | 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'multi'; default: not declared - output.visualization.plots?: readonly { path: string; role?: string; }[]; default: not declared - output.visualization.referenceLevels?: readonly number[]; default: not declared - parameters: string[]; default: not declared - required: string[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorStream Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A stateful streaming indicator. `next` returns `null` during warmup. ```typescript /** A stateful streaming indicator. `next` returns `null` during warmup. */ export interface IndicatorStream { next(input: In): Out | null; readonly value: Out | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - next: (input: In) => Out | null; default: not declared - next(input): In; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: Out | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#IndicatorVisualization Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How an indicator plots (one path per drawn series), separate from the runtime `value` shape. ```typescript /** How an indicator plots (one path per drawn series), separate from the runtime `value` shape. */ export interface IndicatorVisualization { kind: 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'events' | 'levels' | 'multi'; plots?: ReadonlyArray<{ path: string; role?: string; }>; referenceLevels?: readonly number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: 'levels' | 'events' | 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'multi'; default: not declared - plots?: readonly { path: string; role?: string; }[]; default: not declared - referenceLevels?: readonly number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#InertiaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── inertia (linreg of RVI) ───────────────────────── export interface InertiaParameters { period?: number; rviPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared - rviPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#InformationBarAggregator Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class InformationBarAggregator implements AggregateStream, FlushableAgg { constructor(parameters: { kind: string; mode: InfoMode; threshold: number; weight: InfoWeight; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): InformationBarAggregator; flush(): BarInput[]; next(bar: BarInput): BarInput[]; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; mode: InfoMode; threshold: number; weight: InfoWeight; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).mode: 'imbalance' | 'run'; default: not declared - (parameters).threshold: number; default: not declared - (parameters).weight: 'tick' | 'volume' | 'dollar'; default: not declared - flush: () => BarInput[]; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => InformationBarAggregator; default: not declared - fromJSON().return.flush: () => BarInput[]; default: not declared - fromJSON().return.next: (bar: BarInput) => BarInput[]; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => BarInput[]; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.flush: () => BarInput[]; default: not declared - return.next: (bar: BarInput) => BarInput[]; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#InformationBarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface InformationBarParameters { /** Imbalance/run magnitude that closes a bar. */ threshold: number; /** Emit the trailing partial bar. Default true. */ flush?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#JmaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Jurik MA ───────────────────────── export interface JmaParameters { period: number; /** Lag/overshoot trade-off, −100…100 (default 0). */ phase?: number; /** Smoothing power on β (default 1). */ power?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared - phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - power?: number; default: not declared — Smoothing power on β (default 1). ### @insiderfinance/totalfinance/technical-analysis#KagiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Kagi (batch) ───────────────────────── export interface KagiParameters { /** Reversal amount. Absolute price by default, or a percent of price if `percent` is true. */ reversal: number; percent?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - percent?: boolean; default: not declared - reversal: number; default: not declared — Reversal amount. Absolute price by default, or a percent of price if `percent` is true. ### @insiderfinance/totalfinance/technical-analysis#KagiSegment Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KagiSegment { from: number; to: number; direction: 1 | -1; /** Yang (thick) once price rises above the prior shoulder; yin (thin) below the prior waist. */ line: 'yang' | 'yin'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 1 | -1; default: not declared - from: number; default: not declared - line: 'yang' | 'yin'; default: not declared — Yang (thick) once price rises above the prior shoulder; yin (thin) below the prior waist. - to: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#KamaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── KAMA (Kaufman adaptive) ───────────────────────── export interface KamaParameters { period: number; /** Fast EMA constant period. Default 2. */ fast?: number; /** Slow EMA constant period. Default 30. */ slow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared — Fast EMA constant period. Default 2. - period: number; default: not declared - slow?: number; default: not declared — Slow EMA constant period. Default 30. ### @insiderfinance/totalfinance/technical-analysis#KdjParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── KDJ ───────────────────────── export interface KdjParameters { period?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared - signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#KdjPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KdjPoint { k: number; d: number; j: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - d: number; default: not declared - j: number; default: not declared - k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#KeltnerParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Keltner Channels ───────────────────────── export interface KeltnerParameters { /** EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. */ period?: number; atrPeriod?: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atrPeriod?: number; default: not declared - multiplier?: number; default: not declared - period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#KlingerParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Klinger Volume Oscillator ───────────────────────── export interface KlingerParameters { fast?: number; slow?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - signal?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#KlingerPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KlingerPoint { klinger: number; signal: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - klinger: number; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#KstParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── KST (Know Sure Thing) ───────────────────────── export interface KstParameters { rocPeriods?: [ number, number, number, number ]; smaPeriods?: [ number, number, number, number ]; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - rocPeriods?: [number, number, number, number]; default: not declared - signal?: number; default: not declared - smaPeriods?: [number, number, number, number]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#KstPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface KstPoint { kst: number; signal: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kst: number; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#LabeledSwing Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LabeledSwing { index: number; kind: 'high' | 'low'; price: number; /** * HH/HL/LH/LL relative to the PREVIOUS swing of the same kind — `null` for the first swing high * and the first swing low of the series, which have nothing to be higher or lower than. (These * used to be labeled `LH`/`HL`, i.e. reported as a lower high / higher low against a comparison * that never happened, which reads as bearish/bullish structure the data does not contain.) */ label: SwingLabel | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - index: number; default: not declared - kind: 'high' | 'low'; default: not declared - label: SwingLabel | null; default: not declared — HH/HL/LH/LL relative to the PREVIOUS swing of the same kind — `null` for the first swing high and the first swing low of the series, which have nothing to be higher or lower than. (These used to be labeled `LH`/`HL`, i.e. reported as a lower high / higher low against a comparison that never happened, which reads as bearish/bullish structure the data does not contain.) - price: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#LaguerreParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Laguerre RSI (Ehlers) ───────────────────────── export interface LaguerreParameters { gamma?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - gamma?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#Line Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── trendlines & channels ───────────────────────── export interface Line { slope: number; intercept: number; from: number; to: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: number; default: not declared - intercept: number; default: not declared - slope: number; default: not declared - to: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#LineBreakBar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LineBreakBar { open: number; close: number; direction: 1 | -1; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - direction: 1 | -1; default: not declared - open: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#LineBreakParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Three-Line Break ───────────────────────── export interface LineBreakParameters { lines?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lines?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#LineBreakStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class LineBreakStream implements AggregateStream { constructor(count: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): LineBreakStream; next(bar: BarInput): LineBreakBar[]; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (count): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => LineBreakStream; default: not declared - fromJSON().return.next: (bar: BarInput) => LineBreakBar[]; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => LineBreakBar[]; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => LineBreakBar[]; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#LinregPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Linear regression / TSF ───────────────────────── export interface LinregPoint { value: number; slope: number; intercept: number; angle: number; forecast: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - angle: number; default: not declared - forecast: number; default: not declared - intercept: number; default: not declared - slope: number; default: not declared - value: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#LiquiditySweepParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Liquidity Sweep ───────────────────────── export interface LiquiditySweepParameters { /** Rolling window of prior bars whose extreme defines the liquidity level. Default 20. */ lookback?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. ### @insiderfinance/totalfinance/technical-analysis#LiquiditySweepPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LiquiditySweepPoint { /** +1 buy-side sweep (high taken then rejected), −1 sell-side, 0 none. */ direction: number; /** The swept liquidity level (the prior-window extreme), NaN when none. */ level: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: number; default: not declared — +1 buy-side sweep (high taken then rejected), −1 sell-side, 0 none. - level: number; default: not declared — The swept liquidity level (the prior-window extreme), NaN when none. ### @insiderfinance/totalfinance/technical-analysis#LiveStream Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A live streaming indicator (spec §13.4, WS6.1) — an {@link IndicatorStream} plus `peek`, the forming-bar affordance. This is the public shape returned by `indicator.stream(...)` / `indicator.fromJSON(...)`; concrete indicator streams only need to implement {@link IndicatorStream} (the wrapper supplies `peek` for all of them). Named `peek` — not `update` — because it NEVER commits (alignment spec P3.5a): `update` is the feed-the-next-value verb in every other streaming TA library, and under that reading a stream fed exclusively through it would silently stay empty forever. `peek` says exactly what happens. ```typescript /** * A live streaming indicator (spec §13.4, WS6.1) — an {@link IndicatorStream} plus `peek`, the * forming-bar affordance. This is the public shape returned by `indicator.stream(...)` / * `indicator.fromJSON(...)`; concrete indicator streams only need to implement {@link IndicatorStream} * (the wrapper supplies `peek` for all of them). * * Named `peek` — not `update` — because it NEVER commits (alignment spec P3.5a): `update` is the * feed-the-next-value verb in every other streaming TA library, and under that reading a stream * fed exclusively through it would silently stay empty forever. `peek` says exactly what happens. */ export interface LiveStream extends IndicatorStream { /** * The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing * it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close * to commit. Between commits the committed state is untouched, so a live chart never repaints its * closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override * with an O(1) form later. */ peek(input: In): Out | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - next: (input: In) => Out | null; default: not declared - next(input): In; default: not declared - peek: (input: In) => Out | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - peek(input): In; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: Out | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MacdExtParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MacdExtParameters { fast?: number; slow?: number; signal?: number; fastMovingAverageType?: MovingAverageType; slowMovingAverageType?: MovingAverageType; signalMovingAverageType?: MovingAverageType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - fastMovingAverageType?: MovingAverageType; default: not declared - signal?: number; default: not declared - signalMovingAverageType?: MovingAverageType; default: not declared - slow?: number; default: not declared - slowMovingAverageType?: MovingAverageType; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MacdFixParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MacdFixParameters { signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MacdParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MacdParameters { fast?: number; slow?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - signal?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MacdPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MacdPoint { macd: number; signal: number; histogram: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - histogram: number; default: not declared - macd: number; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MamaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── MAMA / FAMA (MESA adaptive, Ehlers) ───────────────────────── export interface MamaParameters { /** Fast adaptation limit. Default 0.5. */ fastLimit?: number; /** Slow adaptation limit. Default 0.05. */ slowLimit?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. ### @insiderfinance/totalfinance/technical-analysis#MamaPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MamaPoint { mama: number; fama: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fama: number; default: not declared - mama: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MarketStructure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market-structure report (Law 2): labeled swings and events plus conventions and diagnostics. ```typescript /** Market-structure report (Law 2): labeled swings and events plus conventions and diagnostics. */ export interface MarketStructure { swings: LabeledSwing[]; events: StructureEvent[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; strength: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.strength: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - events: StructureEvent[]; default: not declared - swings: LabeledSwing[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MassIndexParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Mass Index ───────────────────────── export interface MassIndexParameters { /** EMA length for the high−low range and its re-smoothing. Default 9. */ fast?: number; /** Summation window for the EMA ratio. Default 25. */ slow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. ### @insiderfinance/totalfinance/technical-analysis#MavpParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Variable-period MA (TA-Lib MAVP): the period for bar `i` comes from `periods[i]`, clamped to `[minPeriod, maxPeriod]` and rounded. Batch only — the per-bar period makes a single streaming state ill-defined. Computes each distinct period's MA once, then selects per bar. ```typescript /** * Variable-period MA (TA-Lib MAVP): the period for bar `i` comes from `periods[i]`, clamped to * `[minPeriod, maxPeriod]` and rounded. Batch only — the per-bar period makes a single streaming state * ill-defined. Computes each distinct period's MA once, then selects per bar. */ export interface MavpParameters { minPeriod?: number; maxPeriod?: number; movingAverageType?: MovingAverageName; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxPeriod?: number; default: not declared - minPeriod?: number; default: not declared - movingAverageType?: MovingAverageName; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MinMaxIndexPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MinMaxIndexPoint { minIndex: number; maxIndex: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - maxIndex: number; default: not declared - minIndex: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MinMaxPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MinMaxPoint { min: number; max: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - max: number; default: not declared - min: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MovingAverageName Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── movingAverage — MA-type dispatcher ───────────────────────── export type MovingAverageName = 'sma' | 'ema' | 'wma' | 'rma' | 'dema' | 'tema' | 'trima' | 'kama' | 't3' | 'hma' | 'zlema'; ``` ### @insiderfinance/totalfinance/technical-analysis#MovingAverageParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MovingAverageParameters { period: number; movingAverageType?: MovingAverageName; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - movingAverageType?: MovingAverageName; default: not declared - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MovingAverageRibbonParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── MA ribbon ───────────────────────── export interface MovingAverageRibbonParameters { periods?: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periods?: number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MovingAverageType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── MACDEXT / MACDFIX ───────────────────────── export type MovingAverageType = 'sma' | 'ema' | 'wma' | 'dema' | 'tema' | 'trima' | 'rma'; ``` ### @insiderfinance/totalfinance/technical-analysis#MswParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MswParameters { period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#MswPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface MswPoint { sine: number; lead: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lead: number; default: not declared - sine: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#OpeningRange Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface OpeningRange { high: number; low: number; mid: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; periods: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; periods: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.periods: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - high: number; default: not declared - low: number; default: not declared - mid: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#Operand Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type Operand = string | number; ``` ### @insiderfinance/totalfinance/technical-analysis#OrderBlockParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Order Block ───────────────────────── export interface OrderBlockParameters { /** How many bars an origin candle stays eligible to be broken. Default 5. */ lookback?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. ### @insiderfinance/totalfinance/technical-analysis#OrderBook Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Order book with levels sorted best-first (bids descending, asks ascending). ```typescript /** Order book with levels sorted best-first (bids descending, asks ascending). */ export interface OrderBook { bids: readonly BookLevel[]; asks: readonly BookLevel[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asks: readonly BookLevel[]; default: not declared - bids: readonly BookLevel[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#OrderBookLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── order-book imbalance ───────────────────────── export interface OrderBookLevel { bidSize: number; askSize: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - askSize: number; default: not declared - bidSize: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PANDAS_CDL_ALIASES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). pandas-ta `cdl_pattern(name=...)` pattern name → TotalFinance catalog name. ```typescript export declare const PANDAS_CDL_ALIASES: Readonly>; ``` ### @insiderfinance/totalfinance/technical-analysis#Pair Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── beta / correl (paired input) ───────────────────────── export interface Pair { x: number; y: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - x: number; default: not declared - y: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PeriodParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PeriodParameters { period: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PhasorPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── HT_PHASOR ───────────────────────── export interface PhasorPoint { inPhase: number; quadrature: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - inPhase: number; default: not declared - quadrature: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PivotLevels Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pivot-level report (Law 2): the levels plus the applied conventions and diagnostics. ```typescript /** Pivot-level report (Law 2): the levels plus the applied conventions and diagnostics. */ export interface PivotLevels { pivot: number; resistance: number[]; support: number[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; method: PivotMethod; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: PivotMethod; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.method: PivotMethod; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - pivot: number; default: not declared - resistance: number[]; default: not declared - support: number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PivotMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── pivot points ───────────────────────── export type PivotMethod = 'classic' | 'fibonacci' | 'woodie' | 'camarilla' | 'demark'; ``` ### @insiderfinance/totalfinance/technical-analysis#PmaxParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── PMax (MA-based Supertrend) ───────────────────────── export interface PmaxParameters { period?: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PmaxPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PmaxPoint { /** The trailing stop line. */ pmax: number; /** +1 long (MA above the stop), −1 short. */ trend: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - pmax: number; default: not declared — The trailing stop line. - trend: number; default: not declared — +1 long (MA above the stop), −1 short. ### @insiderfinance/totalfinance/technical-analysis#PnfColumn Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PnfColumn { kind: 'X' | 'O'; low: number; high: number; boxes: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - boxes: number; default: not declared - high: number; default: not declared - kind: 'X' | 'O'; default: not declared - low: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PnfParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Point & Figure (batch) ───────────────────────── export interface PnfParameters { boxSize: number; reversal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - boxSize: number; default: not declared - reversal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PpoParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PpoParameters { fast?: number; slow?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - signal?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PpoPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PpoPoint { ppo: number; signal: number; histogram: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - histogram: number; default: not declared - ppo: number; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PriceVolumeParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Price · Volume ───────────────────────── export interface PriceVolumeParameters { /** Multiply by the sign of the close-to-close change (needs a prior bar). Default false. */ signed?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. ### @insiderfinance/totalfinance/technical-analysis#PriorSessionLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── prior-session levels & gap fill ───────────────────────── export interface PriorSessionLevel { high: number; low: number; close: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ProjectionPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── projection oscillator (Widner) ───────────────────────── export interface ProjectionPoint { po: number; upper: number; lower: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lower: number; default: not declared - po: number; default: not declared - upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PsarExtParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Extended SAR (SAREXT) ───────────────────────── export interface PsarExtParameters { /** Force the initial direction: >0 long, <0 short, 0 auto. Default 0. */ startValue?: number; /** Widen the SAR by this fraction of the extreme point on a reversal. Default 0. */ offsetOnReverse?: number; accelInitLong?: number; accelLong?: number; accelMaxLong?: number; accelInitShort?: number; accelShort?: number; accelMaxShort?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accelInitLong?: number; default: not declared - accelInitShort?: number; default: not declared - accelLong?: number; default: not declared - accelMaxLong?: number; default: not declared - accelMaxShort?: number; default: not declared - accelShort?: number; default: not declared - offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. ### @insiderfinance/totalfinance/technical-analysis#PsarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Parabolic SAR ───────────────────────── export interface PsarParameters { step?: number; max?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - max?: number; default: not declared - step?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PsarPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PsarPoint { sar: number; /** +1 rising (long), −1 falling (short). */ trend: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sar: number; default: not declared - trend: number; default: not declared — +1 rising (long), −1 falling (short). ### @insiderfinance/totalfinance/technical-analysis#PvoParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── PVO (percentage volume oscillator) ───────────────────────── export interface PvoParameters { fast?: number; slow?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - signal?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#PvoPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PvoPoint { pvo: number; signal: number; histogram: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - histogram: number; default: not declared - pvo: number; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#QqeParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── QQE (Quantitative Qualitative Estimation) ───────────────────────── export interface QqeParameters { rsiPeriod?: number; smooth?: number; factor?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - factor?: number; default: not declared - rsiPeriod?: number; default: not declared - smooth?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#QqePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface QqePoint { rsiMovingAverage: number; longBand: number; shortBand: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - longBand: number; default: not declared - rsiMovingAverage: number; default: not declared - shortBand: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#QuantileParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface QuantileParameters { period?: number; /** Quantile in [0, 1]. Default 0.5 (median). */ quantile?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared - quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). ### @insiderfinance/totalfinance/technical-analysis#Quote Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Quote { bid: number; ask: number; bidSize?: number; askSize?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ask: number; default: not declared - askSize?: number; default: not declared - bid: number; default: not declared - bidSize?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RainbowParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Rainbow MA ───────────────────────── export interface RainbowParameters { period?: number; levels?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - levels?: number; default: not declared - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RangeBarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RangeBarParameters { size: number; /** Emit the trailing partial bar. Default true. */ flush?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - size: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RangeVolatilityParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RangeVolatilityParameters { period: number; /** Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. */ annualization: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RegisteredIndicator Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RegisteredIndicator extends IndicatorMetadata { indicator: AnyIndicator; /** The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. */ output: IndicatorOutputMetadata; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - category: IndicatorCategory; default: not declared - conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - indicator: AnyIndicator; default: not declared - indicator(input): ArrayLike; default: not declared - indicator(parameters)?: any; default: not declared - indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - indicator.explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - indicator.explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - indicator.explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - indicator.explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - indicator.explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - indicator.explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - indicator.explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - indicator.explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - indicator.explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - indicator.explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - indicator.explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - indicator.explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - indicator.explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - indicator.explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - indicator.explain().return.value: any[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - indicator.explain(input): ArrayLike; default: not declared - indicator.explain(parameters)?: any; default: not declared - indicator.fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - indicator.fromJSON().return.next: (input: any) => any; default: not declared - indicator.fromJSON().return.peek: (input: any) => any; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - indicator.fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - indicator.fromJSON().return.value: any; default: not declared - indicator.fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - indicator.fromJSON(snapshot).kind: string; default: not declared - indicator.fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - indicator.fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - indicator.stream().return.next: (input: any) => any; default: not declared - indicator.stream().return.peek: (input: any) => any; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - indicator.stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - indicator.stream().return.value: any; default: not declared - indicator.stream(parameters)?: any; default: not declared - inputs: IndicatorInputs; default: not declared - name: string; default: not declared - output: IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - output.value: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.bounds?: readonly [number, number]; default: not declared - output.value.fields: Readonly>; default: not declared - output.value.items: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputValue; default: not declared - output.value.length?: { fixed: number; } | { parameter: string; }; default: not declared - output.value.length.fixed: number; default: not declared - output.value.length.parameter: string; default: not declared - output.value.role?: string; default: not declared - output.value.type: ('array') | ('boolean') | ('number') | ('record') | ('string'); default: not declared - output.value.unit?: string; default: not declared - output.value.values?: readonly string[]; default: not declared - output.visualization?: import('@insiderfinance/totalfinance/technical-analysis').IndicatorVisualization; default: not declared - output.visualization.kind: 'levels' | 'events' | 'line' | 'bands' | 'oscillator' | 'histogram' | 'candles' | 'multi'; default: not declared - output.visualization.plots?: readonly { path: string; role?: string; }[]; default: not declared - output.visualization.referenceLevels?: readonly number[]; default: not declared - parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). ### @insiderfinance/totalfinance/technical-analysis#RegressionPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RegressionPoint { /** OLS slope of y on x. */ slope: number; intercept: number; /** Coefficient of determination. */ rSquared: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - intercept: number; default: not declared - rSquared: number; default: not declared — Coefficient of determination. - slope: number; default: not declared — OLS slope of y on x. ### @insiderfinance/totalfinance/technical-analysis#RenkoBrick Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RenkoBrick { open: number; close: number; direction: 1 | -1; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - direction: 1 | -1; default: not declared - open: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RenkoParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Renko ───────────────────────── export interface RenkoParameters { brickSize: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - brickSize: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RenkoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RenkoStream implements AggregateStream { constructor(brick: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RenkoStream; next(bar: BarInput): RenkoBrick[]; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (brick): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RenkoStream; default: not declared - fromJSON().return.next: (bar: BarInput) => RenkoBrick[]; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => RenkoBrick[]; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => RenkoBrick[]; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#ResampleInterval Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Named timeframes, or a raw millisecond interval. ```typescript /** Named timeframes, or a raw millisecond interval. */ export type ResampleInterval = '1m' | '5m' | '15m' | '30m' | '1h' | '4h' | '1d' | number; ``` ### @insiderfinance/totalfinance/technical-analysis#ResampleOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ResampleOptions { /** Emit the final, still-forming bucket (flagged `partial: true`). Default `false`. */ includePartial?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - includePartial?: boolean; default: not declared — Emit the final, still-forming bucket (flagged `partial: true`). Default `false`. ### @insiderfinance/totalfinance/technical-analysis#ResampledBar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A resampled higher-timeframe bar: OHLCV plus the bucket VWAP and a forming-bucket flag. ```typescript /** A resampled higher-timeframe bar: OHLCV plus the bucket VWAP and a forming-bucket flag. */ export interface ResampledBar { /** Bucket start (`floor(ts / intervalMs) * intervalMs`), ms since the epoch. */ timestampMs: number; open: number; high: number; low: number; close: number; /** Summed volume over the bucket. */ volume: number; /** Volume-weighted average of the typical price `(h+l+c)/3`; the last typical price if volume is 0. */ vwap: number; /** `true` for the still-forming final bucket (only emitted with `includePartial: true`). */ partial: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared - partial: boolean; default: not declared — `true` for the still-forming final bucket (only emitted with `includePartial: true`). - timestampMs: number; default: not declared — Bucket start (`floor(ts / intervalMs) * intervalMs`), ms since the epoch. - volume: number; default: not declared — Summed volume over the bucket. - vwap: number; default: not declared — Volume-weighted average of the typical price `(h+l+c)/3`; the last typical price if volume is 0. ### @insiderfinance/totalfinance/technical-analysis#RescaleParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RescaleParameters { period?: number; /** Target range minimum. Default 0. */ min?: number; /** Target range maximum. Default 1. */ max?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - max?: number; default: not declared — Target range maximum. Default 1. - min?: number; default: not declared — Target range minimum. Default 0. - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RocParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── ROC family & Momentum ───────────────────────── export interface RocParameters { /** Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. */ period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#RollingAnchoredVwapParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── rolling auto-anchored VWAP ───────────────────────── export interface RollingAnchoredVwapParameters { /** Rolling lookback to search for the anchor extreme. */ lookback?: number; /** Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). */ anchor?: 'low' | 'high'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. ### @insiderfinance/totalfinance/technical-analysis#RollingVolatilityParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RollingVolatilityParameters { period: number; /** Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. */ annualization: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RsiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RsiParameters { /** Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. */ period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#Rule Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A labeled and/or-combination of conditions — the unit {@link SignalBuilder#addRule } accepts. ```typescript /** A labeled and/or-combination of conditions — the unit {@link SignalBuilder#addRule} accepts. */ export interface Rule { terms: Term[]; label: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - label: string; default: not declared - terms: Term[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RuleBuilder Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Builds one rule as a chain of conditions. Evaluation is STRICT LEFT-TO-RIGHT with NO operator precedence: each `.and(c)` / `.or(c)` folds `c` into the accumulated result immediately, so `when(a).or(b).and(c)` evaluates as `(a || b) && c` — NOT `a || (b && c)`. When you need grouping, compose a single condition instead (e.g. with `condition()` / `not()`), or order the chain so left-to-right folding expresses your intent. ```typescript export declare class RuleBuilder { constructor(__0: { first: Condition; owner: SignalBuilder; }); and(condition: Condition): RuleBuilder; emit(label: string): SignalBuilder; or(condition: Condition): RuleBuilder; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (__0): { first: Condition; owner: SignalBuilder; }; default: not declared - (__0).first: Condition; default: not declared - (__0).owner: SignalBuilder; default: not declared - and: (condition: Condition) => RuleBuilder; default: not declared — Fold `c` into the accumulated result with AND (left-to-right, no precedence — class doc). - and(condition): Condition; default: not declared - and(condition).refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - emit: (label: string) => SignalBuilder; default: not declared — Finalise the rule with a label and return to the signal builder. - emit().return.addRule: (rule: Rule) => void; default: not declared - emit().return.atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - emit().return.columns: () => Record; default: not declared — The underlying feature columns (for inspection / charting). - emit().return.ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - emit().return.events: () => SignalEvent[]; default: not declared — Only the bars that emitted, as `{ index, label }` events. - emit().return.feature: (alias: string, values: unknown[]) => SignalBuilder; default: not declared — Inject a precomputed column. - emit().return.rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => SignalBuilder; default: not declared — `parameters` is optional on the default-bearing methods, matching both `FeaturePipeline` and the direct call: `rsi(closes)` resolves period 14, so `signal(bars).rsi('close')` must too. These two were left required when the pipeline's were relaxed, so the two fluent surfaces disagreed — the delegate compiled and the caller's identical call did not. - emit().return.signals: () => (string | null)[]; default: not declared — Aligned labels: the first matching rule's label per bar, else `null`. - emit().return.sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - emit().return.use: (field: Field, indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any series indicator to a field under an alias. `options.as` is REQUIRED here: the generic escape hatch has no indicator-specific auto-name to fall back on. - emit().return.useBars: (indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any bar indicator to the candles under an alias. `options.as` is required (see {@link use}). - emit().return.when: (condition: Condition) => RuleBuilder; default: not declared - emit().return.wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - emit(label): string; default: not declared - or: (condition: Condition) => RuleBuilder; default: not declared — Fold `c` into the accumulated result with OR (left-to-right, no precedence — class doc). - or(condition): Condition; default: not declared - or(condition).refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - return.and: (condition: Condition) => RuleBuilder; default: not declared — Fold `c` into the accumulated result with AND (left-to-right, no precedence — class doc). - return.emit: (label: string) => SignalBuilder; default: not declared — Finalise the rule with a label and return to the signal builder. - return.or: (condition: Condition) => RuleBuilder; default: not declared — Fold `c` into the accumulated result with OR (left-to-right, no precedence — class doc). ### @insiderfinance/totalfinance/technical-analysis#RvgiPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Relative Vigor Index (RVGI) ───────────────────────── export interface RvgiPoint { rvi: number; signal: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - rvi: number; default: not declared - signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#RviParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RviParameters { period?: number; stdevPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared - stdevPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Current snapshot schema version. Bump when a stored snapshot's shape changes incompatibly. 2 — the flat `{ kind, v?, ...state }` shape became the explicit `{ kind, schemaVersion, state }` envelope. 3 — non-finite numbers inside `state` are ENCODED (see {@link encodeNonFinite}). Before this, `JSON.stringify` turned every one of them into `null`, so a snapshot could not round-trip through the very format it exists for. No legacy parser is retained at either step: pre-1.0 corrections are clean (law N9), and an older snapshot is rejected by {@link checkSnapshotVersion} with a teaching error rather than misread. ```typescript export declare const SCHEMA_VERSION: 3; ``` ### @insiderfinance/totalfinance/technical-analysis#SearchIndicatorsOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link searchIndicators}. ```typescript /** Options for {@link searchIndicators}. */ export interface SearchIndicatorsOptions { /** Case-insensitive substring/fuzzy match of the canonical name OR any alias. */ query?: string; category?: IndicatorCategory; /** Non-negative safe-integer page size; omit for all matches. */ limit?: number; /** Non-negative safe-integer page offset; default 0. */ offset?: number; /** Match mode (default `'auto'`). Only meaningful with a `query`. */ match?: SearchMatchMode; /** Minimum fuzzy similarity in `[0, 1]` (default `0.7`). Only used for fuzzy matching, needs a `query`. */ minScore?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - category?: IndicatorCategory; default: not declared - limit?: number; default: not declared — Non-negative safe-integer page size; omit for all matches. - match?: SearchMatchMode; default: not declared — Match mode (default `'auto'`). Only meaningful with a `query`. - minScore?: number; default: not declared — Minimum fuzzy similarity in `[0, 1]` (default `0.7`). Only used for fuzzy matching, needs a `query`. - offset?: number; default: not declared — Non-negative safe-integer page offset; default 0. - query?: string; default: not declared — Case-insensitive substring/fuzzy match of the canonical name OR any alias. ### @insiderfinance/totalfinance/technical-analysis#SearchIndicatorsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link searchIndicators}. ```typescript /** Result of {@link searchIndicators}. */ export interface SearchIndicatorsResult { /** Matches before pagination. */ total: number; offset: number; /** The applied page size (`null` = unbounded). */ limit: number | null; indicators: IndicatorRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - indicators: IndicatorRow[]; default: not declared - limit: number | null; default: not declared — The applied page size (`null` = unbounded). - offset: number; default: not declared - total: number; default: not declared — Matches before pagination. ### @insiderfinance/totalfinance/technical-analysis#SearchMatchMode Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How a `query` is matched. `auto` (default) uses substring first, deterministic fuzzy only as a fallback. ```typescript /** How a `query` is matched. `auto` (default) uses substring first, deterministic fuzzy only as a fallback. */ export type SearchMatchMode = 'substring' | 'fuzzy' | 'auto'; ``` ### @insiderfinance/totalfinance/technical-analysis#SessionRange Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── session range & opening-range breakout ───────────────────────── export interface SessionRange { session: number; open: number; high: number; low: number; close: number; volume: number; range: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared - range: number; default: not declared - session: number; default: not declared - volume: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SessionVwapParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── session VWAP (periodic reset) ───────────────────────── export interface SessionVwapParameters { /** Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). */ resetEvery: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). ### @insiderfinance/totalfinance/technical-analysis#SignContext Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SignContext { /** NBBO quote in effect at the trade (for the Lee-Ready quote rule). */ quote?: Quote; /** Previous trade price (for the tick rule / quote-rule tie-break). */ previousPrice?: number | null; /** Previous resolved sign, carried when the tick rule is indeterminate (zero tick). */ previousSign?: TradeDirection; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - previousPrice?: number | null; default: not declared — Previous trade price (for the tick rule / quote-rule tie-break). - previousSign?: TradeDirection; default: not declared — Previous resolved sign, carried when the tick rule is indeterminate (zero tick). - quote?: Quote; default: not declared — NBBO quote in effect at the trade (for the Lee-Ready quote rule). - quote.ask: number; default: not declared - quote.askSize?: number; default: not declared - quote.bid: number; default: not declared - quote.bidSize?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SignalBuilder Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SignalBuilder { constructor(candles: BarInput[]); addRule(rule: Rule): void; atr(parameters?: WilderPeriodParameters, options?: AliasOpt): SignalBuilder; columns(): Record; ema(field: Field, parameters: PeriodParameters, options?: AliasOpt): SignalBuilder; events(): SignalEvent[]; feature(alias: string, values: unknown[]): SignalBuilder; rsi(field: Field, parameters?: RsiParameters, options?: AliasOpt): SignalBuilder; signals(): (string | null)[]; sma(field: Field, parameters: PeriodParameters, options?: AliasOpt): SignalBuilder; use(field: Field, indicator: Indicator, parameters: P, options: Required): SignalBuilder; useBars(indicator: Indicator, parameters: P, options: Required): SignalBuilder; when(condition: Condition): RuleBuilder; wma(field: Field, parameters: PeriodParameters, options?: AliasOpt): SignalBuilder; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (candles): BarInput[]; default: not declared - addRule: (rule: Rule) => void; default: not declared - addRule(rule): Rule; default: not declared - addRule(rule).label: string; default: not declared - addRule(rule).terms: Term[]; default: not declared - atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - atr(options)?: AliasOpt | undefined; default: not declared - atr(options).as?: string; default: not declared - atr(parameters)?: WilderPeriodParameters | undefined; default: not declared - atr(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - columns: () => Record; default: not declared — The underlying feature columns (for inspection / charting). - ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - ema(field): Field; default: not declared - ema(options)?: AliasOpt | undefined; default: not declared - ema(options).as?: string; default: not declared - ema(parameters): PeriodParameters; default: not declared - ema(parameters).period: number; default: not declared - events: () => SignalEvent[]; default: not declared — Only the bars that emitted, as `{ index, label }` events. - feature: (alias: string, values: unknown[]) => SignalBuilder; default: not declared — Inject a precomputed column. - feature(alias): string; default: not declared - feature(values): unknown[]; default: not declared - return.addRule: (rule: Rule) => void; default: not declared - return.atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - return.columns: () => Record; default: not declared — The underlying feature columns (for inspection / charting). - return.ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - return.events: () => SignalEvent[]; default: not declared — Only the bars that emitted, as `{ index, label }` events. - return.feature: (alias: string, values: unknown[]) => SignalBuilder; default: not declared — Inject a precomputed column. - return.rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => SignalBuilder; default: not declared — `parameters` is optional on the default-bearing methods, matching both `FeaturePipeline` and the direct call: `rsi(closes)` resolves period 14, so `signal(bars).rsi('close')` must too. These two were left required when the pipeline's were relaxed, so the two fluent surfaces disagreed — the delegate compiled and the caller's identical call did not. - return.signals: () => (string | null)[]; default: not declared — Aligned labels: the first matching rule's label per bar, else `null`. - return.sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - return.use: (field: Field, indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any series indicator to a field under an alias. `options.as` is REQUIRED here: the generic escape hatch has no indicator-specific auto-name to fall back on. - return.useBars: (indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any bar indicator to the candles under an alias. `options.as` is required (see {@link use}). - return.when: (condition: Condition) => RuleBuilder; default: not declared - return.wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => SignalBuilder; default: not declared — `parameters` is optional on the default-bearing methods, matching both `FeaturePipeline` and the direct call: `rsi(closes)` resolves period 14, so `signal(bars).rsi('close')` must too. These two were left required when the pipeline's were relaxed, so the two fluent surfaces disagreed — the delegate compiled and the caller's identical call did not. - rsi(field): Field; default: not declared - rsi(options)?: AliasOpt | undefined; default: not declared - rsi(options).as?: string; default: not declared - rsi(parameters)?: RsiParameters | undefined; default: not declared - rsi(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - signals: () => (string | null)[]; default: not declared — Aligned labels: the first matching rule's label per bar, else `null`. - sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - sma(field): Field; default: not declared - sma(options)?: AliasOpt | undefined; default: not declared - sma(options).as?: string; default: not declared - sma(parameters): PeriodParameters; default: not declared - sma(parameters).period: number; default: not declared - use: (field: Field, indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any series indicator to a field under an alias. `options.as` is REQUIRED here: the generic escape hatch has no indicator-specific auto-name to fall back on. - use(field): Field; default: not declared - use(indicator): Indicator; default: not declared - use(indicator).explain: (input: ArrayLike, parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - use(indicator).fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - use(indicator).stream: (parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - use(options): Required; default: not declared - use(options).as: string; default: not declared - use(parameters): P; default: not declared - useBars: (indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any bar indicator to the candles under an alias. `options.as` is required (see {@link use}). - useBars(indicator): Indicator; default: not declared - useBars(indicator).explain: (input: ArrayLike, parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - useBars(indicator).fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - useBars(indicator).stream: (parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - useBars(options): Required; default: not declared - useBars(options).as: string; default: not declared - useBars(parameters): P; default: not declared - when: (condition: Condition) => RuleBuilder; default: not declared - when().return.and: (condition: Condition) => RuleBuilder; default: not declared — Fold `c` into the accumulated result with AND (left-to-right, no precedence — class doc). - when().return.emit: (label: string) => SignalBuilder; default: not declared — Finalise the rule with a label and return to the signal builder. - when().return.or: (condition: Condition) => RuleBuilder; default: not declared — Fold `c` into the accumulated result with OR (left-to-right, no precedence — class doc). - when(condition): Condition; default: not declared - when(condition).refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - wma(field): Field; default: not declared - wma(options)?: AliasOpt | undefined; default: not declared - wma(options).as?: string; default: not declared - wma(parameters): PeriodParameters; default: not declared - wma(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SignalContext Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SignalContext { constructor(parameters: { candles: BarInput[]; cols: Map; }); get(operand: Operand, barIndex: number): number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { candles: BarInput[]; cols: Map; }; default: not declared - (parameters).candles: BarInput[]; default: not declared - (parameters).cols: Map; default: not declared - get: (operand: Operand, barIndex: number) => number; default: not declared - get(barIndex): number; default: not declared - get(operand): Operand; default: not declared - return.get: (operand: Operand, barIndex: number) => number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SignalEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SignalEvent { index: number; label: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - index: number; default: not declared - label: string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SinePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── HT_SINE ───────────────────────── export interface SinePoint { sine: number; leadSine: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - leadSine: number; default: not declared - sine: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SmcSweepParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── pandas-ta SMC sweep scalar ───────────────────────── export interface SmcSweepParameters { /** Prior-window swing high/low lookback. Default 15. */ period?: number; /** Wick must exceed `body * wickMultiplier`. Default 1.5. */ wickMultiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. ### @insiderfinance/totalfinance/technical-analysis#SmiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── SMI Ergodic ───────────────────────── export interface SmiParameters { long?: number; short?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long?: number; default: not declared - short?: number; default: not declared - signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SmiPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SmiPoint { smi: number; signal: number; oscillator: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - oscillator: number; default: not declared - signal: number; default: not declared - smi: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SnapshotState Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Checked access to one snapshot's opaque state. Every accessor takes the state key and returns the value the restorer needs, or throws a typed `InputError` naming the indicator and the key. There is no accessor that returns `unknown`: a restorer that cannot express what it needs is a restorer that is not checking. ```typescript export declare class SnapshotState { constructor(kind: Kind, state: Record); readonly kind: Kind; raw: Record; has(field: string): boolean; number(field: string): number; numberOrNull(field: string): number | null; optionalNumber(field: string): number | undefined; integer(field: string): number; lookback(field: string): number; boolean(field: string): boolean; text(field: string): string; literal(field: string, allowed: readonly T[]): T; numbers(field: string): number[]; numbersOrNull(field: string): number[] | null; optionalNumbers(field: string): number[] | undefined; numberRows(field: string): number[][]; child(field: string): TechnicalAnalysisSnapshot; children(field: string): TechnicalAnalysisSnapshot[]; cached(field: string): T | null; record(field: string): T; recordOrNull(field: string): T | null; records(field: string): T[]; literals(field: string, allowed: readonly T[]): T[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (kind): Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - (state): Record; default: not declared - boolean: (field: string) => boolean; default: not declared — A boolean flag. - boolean(field): string; default: not declared - cached: (field: string) => T | null; default: not declared — The LAST EMITTED OUTPUT, cached so a restored stream's `.value` is not blank until the next bar. Deliberately the loosest accessor, and the only one that tolerates non-finite: `NaN` is a real output. `acos` outside [-1, 1] is NaN; a `fairValueGaps` point reads `{ top: NaN, bottom: NaN }` until a gap forms. Rejecting those would refuse to restore a correct stream. What it still refuses is a value of a kind no indicator ever outputs — a string, a boolean, a function — which is what a foreign or hand-edited snapshot looks like. A missing key reads as `null` rather than throwing: the cache is an optimisation, and a snapshot that predates an indicator caching its value must restore to "no value yet", not fail. - cached(field): string; default: not declared - child: (field: string) => TechnicalAnalysisSnapshot; default: not declared — A nested snapshot envelope — a composed indicator's child (`macd` carries three EMAs). Only the SHAPE is checked here. The child's own `fromJSON` calls `readSnapshot` with the kind it expects, so a child from the wrong indicator is convicted there, with that indicator's name on the message rather than the parent's. - child().return.kind: string; default: not declared - child().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - child().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - child(field): string; default: not declared - children: (field: string) => TechnicalAnalysisSnapshot[]; default: not declared — A fresh array of nested snapshot envelopes. - children(field): string; default: not declared - has: (field: string) => boolean; default: not declared — Does the state carry this key at all? For a field a newer build may legitimately omit. - has(field): string; default: not declared - integer: (field: string) => number; default: not declared — A whole number ≥ 0 — a count, an index, a bar offset. A fractional count restores a stream whose window boundaries never line up again, which shows up as an off-by-a-fraction output rather than as an error. - integer(field): string; default: not declared - kind: Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - literal: (field: string, allowed: readonly T[]) => T; default: not declared — A value drawn from a closed set — a mode, a method, a moving-average family, a trade direction. Numbers as well as strings: `TradeDirection` is `-1 | 0 | 1`, and reading it as a plain number would accept `7` as a trade direction. - literal(allowed): readonly T[]; default: not declared - literal(field): string; default: not declared - literals: (field: string, allowed: readonly T[]) => T[]; default: not declared — A fresh array of values drawn from a closed set. - literals(allowed): readonly T[]; default: not declared - literals(field): string; default: not declared - lookback: (field: string) => number; default: not declared — A lookback: an integer ≥ 1. This is the asymmetry the reader exists to close. `ta.rsi.stream({ period: -3 })` throws from `requirePeriod`; `RsiStream.fromJSON` read the same number straight out of state and built a stream with a negative window, which produces `undefined` buffer reads and silent NaN. - lookback(field): string; default: not declared - number: (field: string) => number; default: not declared — A number: sums, running averages, thresholds, multipliers. Non-finite is permitted HERE and refused at the door. `readSnapshot` has already walked the whole state: an encoded non-finite has been decoded (the indicator computed it — a zero price series makes every log-return NaN), and a raw one has been rejected as damage. By the time an accessor runs, `NaN` can only mean the first. - number(field): string; default: not declared - numberOrNull: (field: string) => number | null; default: not declared — A number or `null` — a running value that has not been established yet. - numberOrNull(field): string; default: not declared - numberRows: (field: string) => number[][]; default: not declared — A fresh array of fresh number arrays — a matrix of windows. - numberRows(field): string; default: not declared - numbers: (field: string) => number[]; default: not declared — A FRESH array of finite numbers. Fresh matters: the previous `state['buf'] as number[]` aliased the caller's snapshot, so two streams restored from one snapshot object shared a buffer and corrupted each other. Restorers used to spell that defence themselves (`[...(state['buf'] as number[])]`) and could forget to. - numbers(field): string; default: not declared - numbersOrNull: (field: string) => number[] | null; default: not declared — A fresh array of finite numbers, or `null`. - numbersOrNull(field): string; default: not declared - optionalNumber: (field: string) => number | undefined; default: not declared — A number the state may omit entirely (an optional parameter a stream carries). - optionalNumber(field): string; default: not declared - optionalNumbers: (field: string) => number[] | undefined; default: not declared — A fresh array of finite numbers the state may omit. - optionalNumbers(field): string; default: not declared - raw: Record; default: not declared — The raw state object. For a restorer that must hand a whole sub-object to a helper. - record: (field: string) => T; default: not declared — A structured record the indicator persists whole — a bar, a candle, an accumulator. Members are not walked: their shape is the indicator's own business and varies per record type. The check is that it IS a record, which is what separates a usable snapshot from `"acc"` or `7`. - record(field): string; default: not declared - recordOrNull: (field: string) => T | null; default: not declared — A structured record, or `null` when the indicator has not established one. - recordOrNull(field): string; default: not declared - records: (field: string) => T[]; default: not declared — A fresh array of structured records — persisted bars, candles, levels. - records(field): string; default: not declared - return.boolean: (field: string) => boolean; default: not declared — A boolean flag. - return.cached: (field: string) => T | null; default: not declared — The LAST EMITTED OUTPUT, cached so a restored stream's `.value` is not blank until the next bar. Deliberately the loosest accessor, and the only one that tolerates non-finite: `NaN` is a real output. `acos` outside [-1, 1] is NaN; a `fairValueGaps` point reads `{ top: NaN, bottom: NaN }` until a gap forms. Rejecting those would refuse to restore a correct stream. What it still refuses is a value of a kind no indicator ever outputs — a string, a boolean, a function — which is what a foreign or hand-edited snapshot looks like. A missing key reads as `null` rather than throwing: the cache is an optimisation, and a snapshot that predates an indicator caching its value must restore to "no value yet", not fail. - return.child: (field: string) => TechnicalAnalysisSnapshot; default: not declared — A nested snapshot envelope — a composed indicator's child (`macd` carries three EMAs). Only the SHAPE is checked here. The child's own `fromJSON` calls `readSnapshot` with the kind it expects, so a child from the wrong indicator is convicted there, with that indicator's name on the message rather than the parent's. - return.children: (field: string) => TechnicalAnalysisSnapshot[]; default: not declared — A fresh array of nested snapshot envelopes. - return.has: (field: string) => boolean; default: not declared — Does the state carry this key at all? For a field a newer build may legitimately omit. - return.integer: (field: string) => number; default: not declared — A whole number ≥ 0 — a count, an index, a bar offset. A fractional count restores a stream whose window boundaries never line up again, which shows up as an off-by-a-fraction output rather than as an error. - return.kind: Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - return.literal: (field: string, allowed: readonly T[]) => T; default: not declared — A value drawn from a closed set — a mode, a method, a moving-average family, a trade direction. Numbers as well as strings: `TradeDirection` is `-1 | 0 | 1`, and reading it as a plain number would accept `7` as a trade direction. - return.literals: (field: string, allowed: readonly T[]) => T[]; default: not declared — A fresh array of values drawn from a closed set. - return.lookback: (field: string) => number; default: not declared — A lookback: an integer ≥ 1. This is the asymmetry the reader exists to close. `ta.rsi.stream({ period: -3 })` throws from `requirePeriod`; `RsiStream.fromJSON` read the same number straight out of state and built a stream with a negative window, which produces `undefined` buffer reads and silent NaN. - return.number: (field: string) => number; default: not declared — A number: sums, running averages, thresholds, multipliers. Non-finite is permitted HERE and refused at the door. `readSnapshot` has already walked the whole state: an encoded non-finite has been decoded (the indicator computed it — a zero price series makes every log-return NaN), and a raw one has been rejected as damage. By the time an accessor runs, `NaN` can only mean the first. - return.numberOrNull: (field: string) => number | null; default: not declared — A number or `null` — a running value that has not been established yet. - return.numberRows: (field: string) => number[][]; default: not declared — A fresh array of fresh number arrays — a matrix of windows. - return.numbers: (field: string) => number[]; default: not declared — A FRESH array of finite numbers. Fresh matters: the previous `state['buf'] as number[]` aliased the caller's snapshot, so two streams restored from one snapshot object shared a buffer and corrupted each other. Restorers used to spell that defence themselves (`[...(state['buf'] as number[])]`) and could forget to. - return.numbersOrNull: (field: string) => number[] | null; default: not declared — A fresh array of finite numbers, or `null`. - return.optionalNumber: (field: string) => number | undefined; default: not declared — A number the state may omit entirely (an optional parameter a stream carries). - return.optionalNumbers: (field: string) => number[] | undefined; default: not declared — A fresh array of finite numbers the state may omit. - return.raw: Record; default: not declared — The raw state object. For a restorer that must hand a whole sub-object to a helper. - return.record: (field: string) => T; default: not declared — A structured record the indicator persists whole — a bar, a candle, an accumulator. Members are not walked: their shape is the indicator's own business and varies per record type. The check is that it IS a record, which is what separates a usable snapshot from `"acc"` or `7`. - return.recordOrNull: (field: string) => T | null; default: not declared — A structured record, or `null` when the indicator has not established one. - return.records: (field: string) => T[]; default: not declared — A fresh array of structured records — persisted bars, candles, levels. - return.text: (field: string) => string; default: not declared — A string. - text: (field: string) => string; default: not declared — A string. - text(field): string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SqueezeParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SqueezeParameters { bollingerBandPeriod?: number; bollingerStandardDeviations?: number; keltnerChannelPeriod?: number; keltnerChannelMultiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bollingerBandPeriod?: number; default: not declared - bollingerStandardDeviations?: number; default: not declared - keltnerChannelMultiplier?: number; default: not declared - keltnerChannelPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SqueezePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SqueezePoint { /** 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. */ on: number; /** LazyBear squeeze momentum histogram. */ momentum: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - momentum: number; default: not declared — LazyBear squeeze momentum histogram. - on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. ### @insiderfinance/totalfinance/technical-analysis#SqueezeProParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── SqueezePro (3 compression levels) ───────────────────────── export interface SqueezeProParameters { bollingerBandPeriod?: number; bollingerStandardDeviations?: number; keltnerChannelPeriod?: number; /** * Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. * * Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they * inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest * channel, the loosest squeeze) — so the reader had to know which of the two scales the word * referred to. The point's fields are now `lowCompression`/`normalCompression`/ * `highCompression`, so both halves of the indicator say which scale they are on. */ wideKeltnerChannelMultiplier?: number; normalKeltnerChannelMultiplier?: number; narrowKeltnerChannelMultiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bollingerBandPeriod?: number; default: not declared - bollingerStandardDeviations?: number; default: not declared - keltnerChannelPeriod?: number; default: not declared - narrowKeltnerChannelMultiplier?: number; default: not declared - normalKeltnerChannelMultiplier?: number; default: not declared - wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. ### @insiderfinance/totalfinance/technical-analysis#SqueezeProPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SqueezeProPoint { /** * The three compression levels, named for what they measure. * * `low`/`mid`/`high` sat beside multipliers that ran the other way — the loosest squeeze uses the * WIDEST channel (×2) — so a reader had to know which of two scales each word referred to. Renamed * while breaking changes are still cheap. */ /** Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). */ lowCompression: number; /** Normal compression. */ normalCompression: number; /** Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). */ highCompression: number; momentum: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - momentum: number; default: not declared - normalCompression: number; default: not declared — Normal compression. ### @insiderfinance/totalfinance/technical-analysis#SrLevel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── support / resistance ───────────────────────── export interface SrLevel { price: number; touches: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared - touches: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#StandardDeviationParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── rolling stddev / variance ───────────────────────── export interface StandardDeviationParameters { period: number; /** Use the sample (n−1) estimator instead of the population (n) one. Default false. */ sample?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared - sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. ### @insiderfinance/totalfinance/technical-analysis#StcParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Schaff Trend Cycle ───────────────────────── export interface StcParameters { fast?: number; slow?: number; cycle?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cycle?: number; default: not declared - fast?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#StochRsiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── StochRSI ───────────────────────── export interface StochRsiParameters { rsiPeriod?: number; stochPeriod?: number; kPeriod?: number; dPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dPeriod?: number; default: not declared - kPeriod?: number; default: not declared - rsiPeriod?: number; default: not declared - stochPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#StochRsiPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StochRsiPoint { k: number; d: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - d: number; default: not declared - k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#StochasticParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ---- Stochastic oscillator ---- export interface StochasticParameters { /** %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. */ kPeriod?: number; /** %D smoothing. Defaults to 3 (universal). */ dPeriod?: number; /** * SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's * `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. */ smoothK?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. ### @insiderfinance/totalfinance/technical-analysis#StochasticPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StochasticPoint { k: number; d: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - d: number; default: not declared - k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#StructureEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface StructureEvent { index: number; type: StructureEventType; direction: 1 | -1; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: 1 | -1; default: not declared - index: number; default: not declared - type: StructureEventType; default: not declared ### @insiderfinance/totalfinance/technical-analysis#StructureEventType Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type StructureEventType = 'BOS' | 'CHoCH'; ``` ### @insiderfinance/totalfinance/technical-analysis#SupertrendParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Supertrend ───────────────────────── export interface SupertrendParameters { period: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SupertrendPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SupertrendPoint { supertrend: number; /** +1 uptrend (price above), −1 downtrend (price below). */ direction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - supertrend: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SupportResistance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Support/resistance report (Law 2): clustered levels plus conventions and diagnostics. ```typescript /** Support/resistance report (Law 2): clustered levels plus conventions and diagnostics. */ export interface SupportResistance { support: SrLevel[]; resistance: SrLevel[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; strength: number; tolerance: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; strength: number; tolerance: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.strength: number; default: not declared - assumptions.tolerance: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - resistance: SrLevel[]; default: not declared - support: SrLevel[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SwingLabel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── market structure ───────────────────────── export type SwingLabel = 'HH' | 'HL' | 'LH' | 'LL'; ``` ### @insiderfinance/totalfinance/technical-analysis#SwingPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── swings & fractals ───────────────────────── export interface SwingPoint { index: number; price: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - index: number; default: not declared - price: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#SwingTrailingStopParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SwingTrailingStopParameters { /** Swing strength (bars on each side). Default 2. */ strength?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - strength?: number; default: not declared — Swing strength (bars on each side). Default 2. ### @insiderfinance/totalfinance/technical-analysis#SwingWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fractal confirmation window: `left` bars before and `right` bars after the pivot. ```typescript /** Fractal confirmation window: `left` bars before and `right` bars after the pivot. */ export interface SwingWindow { /** Bars to the left of a pivot that must be higher/lower. Defaults to 5; echoed via `.explain()`. */ left?: number; /** Bars to the right that confirm the pivot. Defaults to 5; echoed via `.explain()`. */ right?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - left?: number; default: not declared — Bars to the left of a pivot that must be higher/lower. Defaults to 5; echoed via `.explain()`. - right?: number; default: not declared — Bars to the right that confirm the pivot. Defaults to 5; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#Swings Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Swing report (Law 2): the confirmed swing points plus applied conventions and diagnostics. ```typescript /** Swing report (Law 2): the confirmed swing points plus applied conventions and diagnostics. */ export interface Swings { highs: SwingPoint[]; lows: SwingPoint[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; strength: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.strength: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - highs: SwingPoint[]; default: not declared - lows: SwingPoint[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#T3Parameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── T3 (Tillson) ───────────────────────── export interface T3Parameters { period: number; /** Tillson volume factor (0–1). Default 0.7. */ volumeFactor?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared - volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. ### @insiderfinance/totalfinance/technical-analysis#TALIB_CANDLE_NAMES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pattern names implemented with exact TA-Lib adaptive parity in this module. ```typescript export declare const TALIB_CANDLE_NAMES: string[]; ``` ### @insiderfinance/totalfinance/technical-analysis#TdSequentialParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── TD Sequential (DeMark core) ───────────────────────── export interface TdSequentialParameters { /** Comparison lookback for the setup (DeMark uses 4). */ lookback?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). ### @insiderfinance/totalfinance/technical-analysis#TdSequentialPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TdSequentialPoint { /** Active setup count, 1–9 (0 if none). */ setup: number; /** Active countdown count, 1–13 (0 if none). */ countdown: number; /** +1 sell side (price strength), −1 buy side (price weakness), 0 none. */ direction: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - setup: number; default: not declared — Active setup count, 1–9 (0 if none). ### @insiderfinance/totalfinance/technical-analysis#TechnicalAnalysisAssumptionExtras Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Domain extras every TA explain envelope discloses. ```typescript /** Domain extras every TA explain envelope discloses. */ export interface TechnicalAnalysisAssumptionExtras extends Record { /** The indicator's registry/snapshot kind, e.g. `'rsi'`. */ indicator: string; /** The parameters the computation ran with: declared defaults merged with the caller's parameters. */ parameters: Record; /** * The indicator's declared conventions, when it has any that a caller could otherwise only learn * from prose. Absent — not an empty object — for indicators whose behaviour holds no such choice, * so its presence always means something. */ conventions?: IndicatorConventions; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventions?: Readonly>; default: not declared — The indicator's declared conventions, when it has any that a caller could otherwise only learn from prose. Absent — not an empty object — for indicators whose behaviour holds no such choice, so its presence always means something. - indicator: string; default: not declared — The indicator's registry/snapshot kind, e.g. `'rsi'`. - parameters: Record; default: not declared — The parameters the computation ran with: declared defaults merged with the caller's parameters. ### @insiderfinance/totalfinance/technical-analysis#TechnicalAnalysisExplain Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The TA explain envelope: core `Computed` whose diagnostics ALWAYS carry the warmup count. ```typescript /** The TA explain envelope: core `Computed` whose diagnostics ALWAYS carry the warmup count. */ export type TechnicalAnalysisExplain = Omit, 'diagnostics'> & { diagnostics: Computed['diagnostics'] & { warmup: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventions?: Readonly>; default: not declared — The indicator's declared conventions, when it has any that a caller could otherwise only learn from prose. Absent — not an empty object — for indicators whose behaviour holds no such choice, so its presence always means something. - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.indicator: string; default: not declared — The indicator's registry/snapshot kind, e.g. `'rsi'`. - assumptions.model?: string; default: not declared - assumptions.parameters: Record; default: not declared — The parameters the computation ran with: declared defaults merged with the caller's parameters. - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: Out[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/technical-analysis#TechnicalAnalysisSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Serialized streaming-state snapshot (3B.N7). The ENVELOPE is explicit and public: `kind` says which indicator wrote it, `schemaVersion` says which shape it is in. `state` is deliberately OPAQUE — a consumer may persist it and hand it back to `fromJSON`, but may not branch on indicator-private keys, which is why those keys are allowed to stay compact where size matters. This replaced a flat shape that put an abbreviated `v` and arbitrary stream state at the SAME level, so nothing distinguished the contract from the payload. ```typescript /** * Serialized streaming-state snapshot (3B.N7). * * The ENVELOPE is explicit and public: `kind` says which indicator wrote it, `schemaVersion` says * which shape it is in. `state` is deliberately OPAQUE — a consumer may persist it and hand it back * to `fromJSON`, but may not branch on indicator-private keys, which is why those keys are allowed * to stay compact where size matters. * * This replaced a flat shape that put an abbreviated `v` and arbitrary stream state at the SAME * level, so nothing distinguished the contract from the payload. */ export interface TechnicalAnalysisSnapshot { kind: string; /** Schema version, stamped at the serialization boundary by {@link snapshotOf}. */ schemaVersion: number; /** Indicator-private stream state. Round-trip it; never read into it. */ state: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - kind: string; default: not declared - schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#Term Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One condition inside a rule, with the operator joining it to the PREVIOUS term. ```typescript /** One condition inside a rule, with the operator joining it to the PREVIOUS term. */ export interface Term { condition: Condition; operator: 'and' | 'or'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - condition: Condition; default: not declared - condition(barIndex): number; default: not declared - condition(context): SignalContext; default: not declared - condition(context).get: (operand: Operand, barIndex: number) => number; default: not declared - condition.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - operator: 'and' | 'or'; default: not declared ### @insiderfinance/totalfinance/technical-analysis#TickVolumeBin Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── tick-level volume profile ───────────────────────── export interface TickVolumeBin { /** Bucket lower price bound. */ low: number; /** Bucket upper price bound. */ high: number; volume: number; buyVolume: number; sellVolume: number; /** `buyVolume − sellVolume` (the footprint delta at this price). */ delta: number; trades: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - buyVolume: number; default: not declared - delta: number; default: not declared — `buyVolume − sellVolume` (the footprint delta at this price). - high: number; default: not declared — Bucket upper price bound. - low: number; default: not declared — Bucket lower price bound. - sellVolume: number; default: not declared - trades: number; default: not declared - volume: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#TickVolumeProfile Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Tick-profile report (Law 2): the footprint bins and levels plus conventions and diagnostics. ```typescript /** Tick-profile report (Law 2): the footprint bins and levels plus conventions and diagnostics. */ export interface TickVolumeProfile { bins: TickVolumeBin[]; /** Point of control: price of the highest-volume bucket (its midpoint); null for an empty tape. */ poc: number | null; /** Value-area price bounds holding `valueAreaFraction` of total volume around the POC (nulls when empty). */ valueArea: { low: number | null; high: number | null; }; totalVolume: number; totalDelta: number; /** Applied conventions, echoed — the binning mode that WON is non-null (`tickSize` beats `bins`). */ assumptions: { conventionsVersion: string; tickSize: number | null; bins: number | null; valueAreaFraction: number; method: AggressorMethod; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { bins: number | null; conventionsVersion: string; method: AggressorMethod; tickSize: number | null; valueAreaFraction: number; }; default: not declared — Applied conventions, echoed — the binning mode that WON is non-null (`tickSize` beats `bins`). - assumptions.bins: number | null; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: AggressorMethod; default: not declared - assumptions.tickSize: number | null; default: not declared - assumptions.valueAreaFraction: number; default: not declared - bins: TickVolumeBin[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - poc: number | null; default: not declared — Point of control: price of the highest-volume bucket (its midpoint); null for an empty tape. - totalDelta: number; default: not declared - totalVolume: number; default: not declared - valueArea: { high: number | null; low: number | null; }; default: not declared — Value-area price bounds holding `valueAreaFraction` of total volume around the POC (nulls when empty). - valueArea.high: number | null; default: not declared - valueArea.low: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#TickVolumeProfileParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TickVolumeProfileParameters { /** Bucket width in price units (e.g. one tick). Mutually exclusive with `bins` (tickSize wins). */ tickSize?: number; /** Number of equal-width buckets between the min and max trade price. Default 50. */ bins?: number; /** Fraction of total volume defining the value area. Default 0.7. */ valueAreaFraction?: number; /** Aggressor method for the buy/sell split. Default `'quote'` if quotes given, else `'tick'`. */ method?: AggressorMethod; quotes?: readonly Quote[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bins?: number; default: not declared — Number of equal-width buckets between the min and max trade price. Default 50. - method?: AggressorMethod; default: not declared — Aggressor method for the buy/sell split. Default `'quote'` if quotes given, else `'tick'`. - quotes?: readonly Quote[]; default: not declared - tickSize?: number; default: not declared — Bucket width in price units (e.g. one tick). Mutually exclusive with `bins` (tickSize wins). - valueAreaFraction?: number; default: not declared — Fraction of total volume defining the value area. Default 0.7. ### @insiderfinance/totalfinance/technical-analysis#TimeBar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A timestamped OHLCV bar (ms since the Unix epoch). ```typescript /** A timestamped OHLCV bar (ms since the Unix epoch). */ export interface TimeBar { /** Bar timestamp in milliseconds since the Unix epoch. */ timestampMs: number; open: number; high: number; low: number; close: number; /** Traded volume; treated as 0 when absent. */ volume?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - close: number; default: not declared - high: number; default: not declared - low: number; default: not declared - open: number; default: not declared - timestampMs: number; default: not declared — Bar timestamp in milliseconds since the Unix epoch. - volume?: number; default: not declared — Traded volume; treated as 0 when absent. ### @insiderfinance/totalfinance/technical-analysis#TosStdevAllParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TosStdevAllParameters { /** Rolling window. Omit (or pass null) to use all history seen so far. */ period?: number | null; /** Positive standard-deviation multipliers. Default [1, 2, 3]. */ stds?: readonly number[]; /** Delta degrees of freedom for the source-series standard deviation. Default 1. */ ddof?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. ### @insiderfinance/totalfinance/technical-analysis#TosStdevAllPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TosStdevAllPoint { /** Current value of the OLS centerline. */ line: number; /** Lower bands, in the same order as `stds`. */ lower: number[]; /** Upper bands, in the same order as `stds`. */ upper: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - line: number; default: not declared — Current value of the OLS centerline. - lower: number[]; default: not declared — Lower bands, in the same order as `stds`. - upper: number[]; default: not declared — Upper bands, in the same order as `stds`. ### @insiderfinance/totalfinance/technical-analysis#Trade Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface Trade { price: number; size: number; /** Epoch milliseconds (optional; required only for time-bucketed footprint bars). */ time?: number; /** Explicit aggressor side if the feed provides it — takes precedence over inference. */ side?: 'buy' | 'sell'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - price: number; default: not declared - side?: 'buy' | 'sell'; default: not declared — Explicit aggressor side if the feed provides it — takes precedence over inference. - size: number; default: not declared - time?: number; default: not declared — Epoch milliseconds (optional; required only for time-bucketed footprint bars). ### @insiderfinance/totalfinance/technical-analysis#TrailingStopPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── trailing stops ───────────────────────── export interface TrailingStopPoint { /** The trailing stop line. */ stop: number; /** +1 long (price above the stop), −1 short. */ trend: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - stop: number; default: not declared — The trailing stop line. - trend: number; default: not declared — +1 long (price above the stop), −1 short. ### @insiderfinance/totalfinance/technical-analysis#TrendSignalPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── trend / cross signal state machines ───────────────────────── export interface TrendSignalPoint { /** Current position state: 1 in-trend / 0 flat. */ trend: number; /** 1 on the bar a position is opened. */ entry: number; /** 1 on the bar a position is closed. */ exit: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - entry: number; default: not declared — 1 on the bar a position is opened. - exit: number; default: not declared — 1 on the bar a position is closed. - trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. ### @insiderfinance/totalfinance/technical-analysis#TrendTestParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── increasing / decreasing ───────────────────────── export interface TrendTestParameters { /** Lookback (compare against the value `period` bars ago). Default 1. */ period?: number; /** Require every step in the window to move the same way (default false → just endpoints). */ strict?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). ### @insiderfinance/totalfinance/technical-analysis#TrixHistogramParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TrixHistogramParameters { period?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared - signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#TrixHistogramPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── TRIX histogram ───────────────────────── export interface TrixHistogramPoint { trix: number; signal: number; histogram: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - histogram: number; default: not declared - signal: number; default: not declared - trix: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#TsiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── TSI (True Strength Index) ───────────────────────── export interface TsiParameters { long?: number; short?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long?: number; default: not declared - short?: number; default: not declared - signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#TsiPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface TsiPoint { tsi: number; signal: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - signal: number; default: not declared - tsi: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#UltimateParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Ultimate Oscillator ───────────────────────── export interface UltimateParameters { short?: number; medium?: number; long?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - long?: number; default: not declared - medium?: number; default: not declared - short?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ValueWhenParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ValueWhenParameters { /** Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. */ occurrence?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. ### @insiderfinance/totalfinance/technical-analysis#VfiParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Volume Flow Indicator (Katsanos) ───────────────────────── export interface VfiParameters { period?: number; coefficient?: number; volumeCutoff?: number; smooth?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - coefficient?: number; default: not declared - period?: number; default: not declared - smooth?: number; default: not declared - volumeCutoff?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VidyaParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── VIDYA (Chande variable index) ───────────────────────── export interface VidyaParameters { period: number; /** CMO lookback driving the volatility index. Default = period. */ cmoPeriod?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VolatilityStopParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Volatility Stop ───────────────────────── export interface VolatilityStopParameters { period?: number; multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared - period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VolatilityStopPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VolatilityStopPoint { /** The trailing stop line. */ stop: number; /** +1 long (price above the stop), −1 short. */ trend: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - stop: number; default: not declared — The trailing stop line. - trend: number; default: not declared — +1 long (price above the stop), −1 short. ### @insiderfinance/totalfinance/technical-analysis#VolumeBarParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VolumeBarParameters { volume: number; flush?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - flush?: boolean; default: not declared - volume: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VolumeBin Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VolumeBin { low: number; high: number; volume: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - high: number; default: not declared - low: number; default: not declared - volume: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VolumeOscillatorParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Volume Oscillator ───────────────────────── export interface VolumeOscillatorParameters { /** Fast EMA length on volume. Default 5. */ fast?: number; /** Slow EMA length on volume. Default 10. */ slow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared — Fast EMA length on volume. Default 5. - slow?: number; default: not declared — Slow EMA length on volume. Default 10. ### @insiderfinance/totalfinance/technical-analysis#VolumeProfile Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Volume-profile report (Law 2): the bins and levels plus conventions and diagnostics. ```typescript /** Volume-profile report (Law 2): the bins and levels plus conventions and diagnostics. */ export interface VolumeProfile { bins: VolumeBin[]; /** Point of control: price-bin midpoint with the most volume; null for an empty series. */ poc: number | null; /** Value-area price bounds containing `valueAreaFraction` of total volume around the POC (nulls when empty). */ valueArea: { low: number | null; high: number | null; }; totalVolume: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; bins: number; valueAreaFraction: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { bins: number; conventionsVersion: string; valueAreaFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.bins: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.valueAreaFraction: number; default: not declared - bins: VolumeBin[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - poc: number | null; default: not declared — Point of control: price-bin midpoint with the most volume; null for an empty series. - totalVolume: number; default: not declared - valueArea: { high: number | null; low: number | null; }; default: not declared — Value-area price bounds containing `valueAreaFraction` of total volume around the POC (nulls when empty). - valueArea.high: number | null; default: not declared - valueArea.low: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VolumeProfileParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── volume profile (batch utility) ───────────────────────── export interface VolumeProfileParameters { /** Number of price buckets. Default 24. */ bins?: number; /** Fraction of total volume that defines the value area. Default 0.7. */ valueAreaFraction?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bins?: number; default: not declared — Number of price buckets. Default 24. - valueAreaFraction?: number; default: not declared — Fraction of total volume that defines the value area. Default 0.7. ### @insiderfinance/totalfinance/technical-analysis#VortexPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Vortex ───────────────────────── export interface VortexPoint { viPlus: number; viMinus: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - viMinus: number; default: not declared - viPlus: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VwMacdParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── volume-weighted MACD ───────────────────────── export interface VwMacdParameters { fast?: number; slow?: number; signal?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fast?: number; default: not declared - signal?: number; default: not declared - slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VwapBandsParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── VWAP bands ───────────────────────── export interface VwapBandsParameters { multiplier?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiplier?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#VwapBandsPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface VwapBandsPoint { vwap: number; upper: number; lower: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lower: number; default: not declared - upper: number; default: not declared - vwap: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#WarmupMetadata Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WarmupMetadata { name: string; category: IndicatorCategory; inputs: IndicatorInputs; /** The canonical parameters used to measure the warmup. */ parameters: Record; /** Leading bars before the first real value, or `null` if it never emitted within the probe. */ warmup: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - category: IndicatorCategory; default: not declared - inputs: IndicatorInputs; default: not declared - name: string; default: not declared - parameters: Record; default: not declared — The canonical parameters used to measure the warmup. - warmup: number | null; default: not declared — Leading bars before the first real value, or `null` if it never emitted within the probe. ### @insiderfinance/totalfinance/technical-analysis#WilderPeriodParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WilderPeriodParameters { /** Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. */ period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#WinsorizeParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface WinsorizeParameters { period?: number; /** Lower quantile to clip to, in [0, 1]. Default 0.05. */ lower?: number; /** Upper quantile to clip to, in [0, 1]. Default 0.95. */ upper?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - period?: number; default: not declared - upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. ### @insiderfinance/totalfinance/technical-analysis#ZigZagParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── ZigZag (batch; final leg provisional) ───────────────────────── export interface ZigZagParameters { /** Minimum reversal as a percentage of price (e.g. 5 = 5%). */ deviation: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deviation: number; default: not declared — Minimum reversal as a percentage of price (e.g. 5 = 5%). ### @insiderfinance/totalfinance/technical-analysis#ZigZagPivot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ZigZagPivot { index: number; price: number; kind: 'high' | 'low'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - index: number; default: not declared - kind: 'high' | 'low'; default: not declared - price: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ZonePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Fair Value Gap ───────────────────────── export interface ZonePoint { /** +1 bullish, −1 bearish, 0 none. */ direction: number; /** Upper bound of the zone (NaN when none). */ top: number; /** Lower bound of the zone (NaN when none). */ bottom: number; /** Zone midpoint (NaN when none). */ mid: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bottom: number; default: not declared — Lower bound of the zone (NaN when none). - direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - mid: number; default: not declared — Zone midpoint (NaN when none). - top: number; default: not declared — Upper bound of the zone (NaN when none). ### @insiderfinance/totalfinance/technical-analysis#aberration Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const aberration: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AberrationParameters | undefined; default: not declared - (parameters).atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - (parameters).period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. - explain: (input: ArrayLike, parameters?: AberrationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: AberrationPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AberrationParameters | undefined; default: not declared - explain(parameters).atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - explain(parameters).period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => AberrationPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => AberrationPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AberrationPoint | null; default: not declared - fromJSON().return.value.atr: number; default: not declared — The ATR offset itself. - fromJSON().return.value.lowerBand: number; default: not declared — Lower band: zeroLine − ATR. - fromJSON().return.value.upperBand: number; default: not declared — Upper band: zeroLine + ATR. - fromJSON().return.value.zeroLine: number; default: not declared — Zero-line: SMA of HLC3. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AberrationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => AberrationPoint | null; default: not declared - stream().return.peek: (input: BarInput) => AberrationPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: AberrationPoint | null; default: not declared - stream().return.value.atr: number; default: not declared — The ATR offset itself. - stream().return.value.lowerBand: number; default: not declared — Lower band: zeroLine − ATR. - stream().return.value.upperBand: number; default: not declared — Upper band: zeroLine + ATR. - stream().return.value.zeroLine: number; default: not declared — Zero-line: SMA of HLC3. - stream(parameters)?: AberrationParameters | undefined; default: not declared - stream(parameters).atrPeriod?: number; default: not declared — ATR length for the band offset. Default 15. - stream(parameters).period?: number; default: not declared — SMA length for the zero-line of HLC3. Default 5. ### @insiderfinance/totalfinance/technical-analysis#accelerationBands Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const accelerationBands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AccelerationBandsParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: AccelerationBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AccelerationBandsParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AccelerationBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChannelPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: AccelerationBandsParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared — Width factor on the high−low/high+low ratio. Default 4. - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#acos Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const acos: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#adLine Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const adLine: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#add Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const add: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#adx Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const adx: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: AdxPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => AdxPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => AdxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AdxPoint | null; default: not declared - fromJSON().return.value.adx: number; default: not declared - fromJSON().return.value.minusDI: number; default: not declared - fromJSON().return.value.plusDI: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => AdxPoint | null; default: not declared - stream().return.peek: (input: BarInput) => AdxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: AdxPoint | null; default: not declared - stream().return.value.adx: number; default: not declared - stream().return.value.minusDI: number; default: not declared - stream().return.value.plusDI: number; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#adxr Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const adxr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#aggregators Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Streaming aggregators for live bar construction (each returns completed bars per input bar). ```typescript export declare const aggregators: { readonly dollar: (threshold: number) => BarAggregator; readonly dollarImbalance: (threshold: number) => InformationBarAggregator; readonly dollarRun: (threshold: number) => InformationBarAggregator; readonly imbalance: (threshold: number) => InformationBarAggregator; readonly range: (size: number) => BarAggregator; readonly run: (threshold: number) => InformationBarAggregator; readonly tick: (count: number) => BarAggregator; readonly volume: (threshold: number) => BarAggregator; readonly volumeImbalance: (threshold: number) => InformationBarAggregator; readonly volumeRun: (threshold: number) => InformationBarAggregator; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dollar: (threshold: number) => BarAggregator; default: not declared - dollar().return.flush: () => BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - dollar().return.next: (bar: BarInput) => BarInput[]; default: not declared - dollar().return.restore: (snapshot: TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - dollar().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - dollar(threshold): number; default: not declared - dollarImbalance: (threshold: number) => InformationBarAggregator; default: not declared - dollarImbalance().return.flush: () => BarInput[]; default: not declared - dollarImbalance().return.next: (bar: BarInput) => BarInput[]; default: not declared - dollarImbalance().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - dollarImbalance(threshold): number; default: not declared - dollarRun: (threshold: number) => InformationBarAggregator; default: not declared - dollarRun().return.flush: () => BarInput[]; default: not declared - dollarRun().return.next: (bar: BarInput) => BarInput[]; default: not declared - dollarRun().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - dollarRun(threshold): number; default: not declared - imbalance: (threshold: number) => InformationBarAggregator; default: not declared - imbalance().return.flush: () => BarInput[]; default: not declared - imbalance().return.next: (bar: BarInput) => BarInput[]; default: not declared - imbalance().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - imbalance(threshold): number; default: not declared - range: (size: number) => BarAggregator; default: not declared - range().return.flush: () => BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - range().return.next: (bar: BarInput) => BarInput[]; default: not declared - range().return.restore: (snapshot: TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - range().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - range(size): number; default: not declared - run: (threshold: number) => InformationBarAggregator; default: not declared - run().return.flush: () => BarInput[]; default: not declared - run().return.next: (bar: BarInput) => BarInput[]; default: not declared - run().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - run(threshold): number; default: not declared - tick: (count: number) => BarAggregator; default: not declared - tick().return.flush: () => BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - tick().return.next: (bar: BarInput) => BarInput[]; default: not declared - tick().return.restore: (snapshot: TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - tick().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - tick(count): number; default: not declared - volume: (threshold: number) => BarAggregator; default: not declared - volume().return.flush: () => BarInput[]; default: not declared — Emit the final partial bar (if any) — used by the batch wrappers to flush. - volume().return.next: (bar: BarInput) => BarInput[]; default: not declared - volume().return.restore: (snapshot: TechnicalAnalysisSnapshot) => void; default: not declared — Restore this aggregator's forming-bar state from a snapshot produced by `toJSON()` (the close rule is a function, so rebuild the aggregator via its factory — e.g. `aggregators.volume(500)` — then restore). Validates the schema version and the snapshot `kind`, and deep-copies the state, so restoring twice from one snapshot yields independent aggregators. - volume().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - volume(threshold): number; default: not declared - volumeImbalance: (threshold: number) => InformationBarAggregator; default: not declared - volumeImbalance().return.flush: () => BarInput[]; default: not declared - volumeImbalance().return.next: (bar: BarInput) => BarInput[]; default: not declared - volumeImbalance().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - volumeImbalance(threshold): number; default: not declared - volumeRun: (threshold: number) => InformationBarAggregator; default: not declared - volumeRun().return.flush: () => BarInput[]; default: not declared - volumeRun().return.next: (bar: BarInput) => BarInput[]; default: not declared - volumeRun().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - volumeRun(threshold): number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#aliasesOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The alias row for a canonical TotalFinance name, if one exists. ```typescript export declare function aliasesOf(canonical: string): IndicatorAliasRow | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (canonical): string; default: not declared - return.pandas?: string | string[]; default: not declared — pandas-ta name(s), snake_case. - return.talib?: string | string[]; default: not declared — TA-Lib function name(s), uppercase. - return.totalfinance: string; default: not declared — Canonical TotalFinance name (must be registered). - return.tradingview?: string; default: not declared — TradingView display name. ### @insiderfinance/totalfinance/technical-analysis#alignToBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Project a higher-timeframe series onto a lower-timeframe bar index, strictly causally (spec §13, WS6.2). `higherSeries[j]` is a value computed on `higherBars[j]`, whose bucket `[ts, ts + iv)` is usable only once it has CLOSED, i.e. at LTF times `≥ higherBars[j].timestampMs + intervalMs`. The LTF value at bar `i` is a step-hold of the last HTF bar that has closed by `lowerBars[i].timestampMs`; it is `NaN` before the first HTF bucket closes. No LTF output ever depends on an unclosed HTF bar — the `request.security` lookahead is impossible by construction. `higherBars` must be ascending by `timestampMs`. The interval is `options.intervalMs` if given, else inferred as the smallest positive gap between consecutive HTF bars (with a single HTF bar and no `intervalMs`, the bar never becomes usable and every output is `NaN`). ```typescript export declare function alignToBars(input: AlignToBarsInput): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AlignToBarsInput; default: not declared - (input).higherBars: ArrayLike; default: not declared - (input).higherSeries: ArrayLike; default: not declared - (input).lowerBars: ArrayLike; default: not declared - (input).options?: AlignOptions; default: not declared ### @insiderfinance/totalfinance/technical-analysis#alma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const alma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AlmaParameters | undefined; default: not declared - (parameters).offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - (parameters).period: number; default: not declared - (parameters).sigma?: number; default: not declared — Gaussian width. Default 6. - explain: (input: ArrayLike, parameters?: AlmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AlmaParameters | undefined; default: not declared - explain(parameters).offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - explain(parameters).period: number; default: not declared - explain(parameters).sigma?: number; default: not declared — Gaussian width. Default 6. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AlmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: AlmaParameters | undefined; default: not declared - stream(parameters).offset?: number; default: not declared — Phase offset 0–1 (1 = responsive, 0 = smooth). Default 0.85. - stream(parameters).period: number; default: not declared - stream(parameters).sigma?: number; default: not declared — Gaussian width. Default 6. ### @insiderfinance/totalfinance/technical-analysis#amat Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Archer Moving Averages Trends (pandas-ta `amat`). ```typescript export declare const amat: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AmatParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).lookback?: number; default: not declared - (parameters).movingAverageType?: MovingAverageName; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: AmatParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: AmatPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AmatParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).lookback?: number; default: not declared - explain(parameters).movingAverageType?: MovingAverageName; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => AmatPoint | null; default: not declared - fromJSON().return.peek: (input: number) => AmatPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AmatPoint | null; default: not declared - fromJSON().return.value.long: number; default: not declared - fromJSON().return.value.short: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AmatParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => AmatPoint | null; default: not declared - stream().return.peek: (input: number) => AmatPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: AmatPoint | null; default: not declared - stream().return.value.long: number; default: not declared - stream().return.value.short: number; default: not declared - stream(parameters)?: AmatParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).lookback?: number; default: not declared - stream(parameters).movingAverageType?: MovingAverageName; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#anchoredVwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const anchoredVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AnchoredVwapParameters | undefined; default: not declared - (parameters).anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. - explain: (input: ArrayLike, parameters?: AnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AnchoredVwapParameters | undefined; default: not declared - explain(parameters).anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: AnchoredVwapParameters | undefined; default: not declared - stream(parameters).anchor: number; default: not declared — Bar index (0-based) from which accumulation starts. Bars before the anchor emit null. ### @insiderfinance/totalfinance/technical-analysis#apo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const apo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ApoParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: ApoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ApoParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ApoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: ApoParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#archerObv Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const archerObv: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ArcherObvParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - (parameters).runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - (parameters).slow?: number; default: not declared — Slow EMA length on OBV. Default 12. - explain: (input: ArrayLike, parameters?: ArcherObvParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ArcherObvPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ArcherObvParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - explain(parameters).runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - explain(parameters).slow?: number; default: not declared — Slow EMA length on OBV. Default 12. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ArcherObvPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ArcherObvPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ArcherObvPoint | null; default: not declared - fromJSON().return.value.fast: number; default: not declared — Fast EMA of OBV. - fromJSON().return.value.long: number; default: not declared — 1 when both EMAs are rising over `runLength` — a long-run signal. - fromJSON().return.value.obv: number; default: not declared - fromJSON().return.value.short: number; default: not declared — 1 when both EMAs are falling over `runLength` — a short-run signal. - fromJSON().return.value.slow: number; default: not declared — Slow EMA of OBV. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ArcherObvParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ArcherObvPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ArcherObvPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ArcherObvPoint | null; default: not declared - stream().return.value.fast: number; default: not declared — Fast EMA of OBV. - stream().return.value.long: number; default: not declared — 1 when both EMAs are rising over `runLength` — a long-run signal. - stream().return.value.obv: number; default: not declared - stream().return.value.short: number; default: not declared — 1 when both EMAs are falling over `runLength` — a short-run signal. - stream().return.value.slow: number; default: not declared — Slow EMA of OBV. - stream(parameters)?: ArcherObvParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared — Fast EMA length on OBV. Default 4. - stream(parameters).runLength?: number; default: not declared — Lookback for the rising/falling run check on the two EMAs. Default 2. - stream(parameters).slow?: number; default: not declared — Slow EMA length on OBV. Default 12. ### @insiderfinance/totalfinance/technical-analysis#aroon Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const aroon: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, AroonPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: AroonPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => AroonPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => AroonPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AroonPoint | null; default: not declared - fromJSON().return.value.down: number; default: not declared - fromJSON().return.value.up: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => AroonPoint | null; default: not declared - stream().return.peek: (input: BarInput) => AroonPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: AroonPoint | null; default: not declared - stream().return.value.down: number; default: not declared - stream().return.value.up: number; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#aroonOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const aroonOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#asin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const asin: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#atan Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const atan: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#atr Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const atr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#atrBands Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ATR Bands — SMA(close) ± multiplier·ATR (an SMA-centred ATR channel). ```typescript export declare const atrBands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AtrBandsParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: AtrBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AtrBandsParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AtrBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChannelPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: AtrBandsParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#atrTrailingStop Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ATR trailing stop (Vervoort / UT-Bot): close-anchored `close ± multiplier·ATR`, trailed per leg. ```typescript export declare const atrTrailingStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AtrTrailingStopParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: AtrTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TrailingStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AtrTrailingStopParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => TrailingStopPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TrailingStopPoint | null; default: not declared - fromJSON().return.value.stop: number; default: not declared — The trailing stop line. - fromJSON().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AtrTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => TrailingStopPoint | null; default: not declared - stream().return.peek: (input: BarInput) => TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TrailingStopPoint | null; default: not declared - stream().return.value.stop: number; default: not declared — The trailing stop line. - stream().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - stream(parameters)?: AtrTrailingStopParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#averagePrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const averagePrice: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#awesomeOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const awesomeOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: AwesomeParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: AwesomeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: AwesomeParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: AwesomeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: AwesomeParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#bar Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bar: { readonly average: (bar: BarInput) => number; readonly body: (bar: BarInput) => number; readonly lowerShadow: (bar: BarInput) => number; readonly median: (bar: BarInput) => number; readonly open: (bar: BarInput) => number; readonly range: (bar: BarInput) => number; readonly trueRange: (bar: BarInput, previousClose: number) => number; readonly typical: (bar: BarInput) => number; readonly upperShadow: (bar: BarInput) => number; readonly weighted: (bar: BarInput) => number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - average: (bar: BarInput) => number; default: not declared - average(bar): BarInput; default: not declared - average(bar).close: number; default: not declared - average(bar).high: number; default: not declared - average(bar).low: number; default: not declared - average(bar).open?: number; default: not declared - average(bar).volume?: number; default: not declared - average(rest): []; default: not declared - body: (bar: BarInput) => number; default: not declared - body(bar): BarInput; default: not declared - body(bar).close: number; default: not declared - body(bar).high: number; default: not declared - body(bar).low: number; default: not declared - body(bar).open?: number; default: not declared - body(bar).volume?: number; default: not declared - body(rest): []; default: not declared - lowerShadow: (bar: BarInput) => number; default: not declared - lowerShadow(bar): BarInput; default: not declared - lowerShadow(bar).close: number; default: not declared - lowerShadow(bar).high: number; default: not declared - lowerShadow(bar).low: number; default: not declared - lowerShadow(bar).open?: number; default: not declared - lowerShadow(bar).volume?: number; default: not declared - lowerShadow(rest): []; default: not declared - median: (bar: BarInput) => number; default: not declared - median(bar): BarInput; default: not declared - median(bar).close: number; default: not declared - median(bar).high: number; default: not declared - median(bar).low: number; default: not declared - median(bar).open?: number; default: not declared - median(bar).volume?: number; default: not declared - median(rest): []; default: not declared - open: (bar: BarInput) => number; default: not declared - open(bar): BarInput; default: not declared - open(bar).close: number; default: not declared - open(bar).high: number; default: not declared - open(bar).low: number; default: not declared - open(bar).open?: number; default: not declared - open(bar).volume?: number; default: not declared - open(rest): []; default: not declared - range: (bar: BarInput) => number; default: not declared - range(bar): BarInput; default: not declared - range(bar).close: number; default: not declared - range(bar).high: number; default: not declared - range(bar).low: number; default: not declared - range(bar).open?: number; default: not declared - range(bar).volume?: number; default: not declared - range(rest): []; default: not declared - trueRange: (bar: BarInput, previousClose: number) => number; default: not declared - trueRange(bar): BarInput; default: not declared - trueRange(bar).close: number; default: not declared - trueRange(bar).high: number; default: not declared - trueRange(bar).low: number; default: not declared - trueRange(bar).open?: number; default: not declared - trueRange(bar).volume?: number; default: not declared - trueRange(rest): [previousClose: number]; default: not declared - typical: (bar: BarInput) => number; default: not declared - typical(bar): BarInput; default: not declared - typical(bar).close: number; default: not declared - typical(bar).high: number; default: not declared - typical(bar).low: number; default: not declared - typical(bar).open?: number; default: not declared - typical(bar).volume?: number; default: not declared - typical(rest): []; default: not declared - upperShadow: (bar: BarInput) => number; default: not declared - upperShadow(bar): BarInput; default: not declared - upperShadow(bar).close: number; default: not declared - upperShadow(bar).high: number; default: not declared - upperShadow(bar).low: number; default: not declared - upperShadow(bar).open?: number; default: not declared - upperShadow(bar).volume?: number; default: not declared - upperShadow(rest): []; default: not declared - weighted: (bar: BarInput) => number; default: not declared - weighted(bar): BarInput; default: not declared - weighted(bar).close: number; default: not declared - weighted(bar).high: number; default: not declared - weighted(bar).low: number; default: not declared - weighted(bar).open?: number; default: not declared - weighted(bar).volume?: number; default: not declared - weighted(rest): []; default: not declared ### @insiderfinance/totalfinance/technical-analysis#barSince Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bars since the input condition (`> 0`) was last true (0 on a true bar; NaN before the first). ```typescript export declare const barSince: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#barsFromColumns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert columnar OHLCV arrays into bar rows. All supplied columns must be arrays of one shared length; omitted columns are simply absent from the rows. Throws typed teaching errors on shape garbage — never returns a partial result. ```typescript export declare function barsFromColumns(columns: BarColumns): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (columns): BarColumns; default: not declared - (columns).close?: readonly number[]; default: not declared - (columns).high?: readonly number[]; default: not declared - (columns).low?: readonly number[]; default: not declared - (columns).open?: readonly number[]; default: not declared - (columns).volume?: readonly number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#bb Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bb: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: BollingerParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - (parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - explain: (input: ArrayLike, parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: BollingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: BollingerParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - explain(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => BollingerPoint | null; default: not declared - fromJSON().return.peek: (input: number) => BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: BollingerPoint | null; default: not declared - fromJSON().return.value.bandwidth: number; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.percentB: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => BollingerPoint | null; default: not declared - stream().return.peek: (input: number) => BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: BollingerPoint | null; default: not declared - stream().return.value.bandwidth: number; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.percentB: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: BollingerParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - stream(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. ### @insiderfinance/totalfinance/technical-analysis#bbands Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bbands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: BollingerParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - (parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - explain: (input: ArrayLike, parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: BollingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: BollingerParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - explain(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => BollingerPoint | null; default: not declared - fromJSON().return.peek: (input: number) => BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: BollingerPoint | null; default: not declared - fromJSON().return.value.bandwidth: number; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.percentB: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => BollingerPoint | null; default: not declared - stream().return.peek: (input: number) => BollingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: BollingerPoint | null; default: not declared - stream().return.value.bandwidth: number; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.percentB: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: BollingerParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — SMA lookback. Defaults to 20 (Bollinger; universal); echoed via `.explain()`. - stream(parameters).standardDeviation?: number; default: not declared — Band width in standard deviations. Defaults to 2. ### @insiderfinance/totalfinance/technical-analysis#beta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const beta: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#between Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function between(operand: Operand, low: number, high: number): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (high): number; default: not declared - (low): number; default: not declared - (operand): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#bias Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bias: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#bollingerBandWidth Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bollingerBandWidth: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: BollingerParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).standardDeviation?: number; default: not declared - explain: (input: ArrayLike, parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: BollingerParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).standardDeviation?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: BollingerParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).standardDeviation?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#bollingerPercentB Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bollingerPercentB: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: BollingerParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).standardDeviation?: number; default: not declared - explain: (input: ArrayLike, parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: BollingerParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).standardDeviation?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: BollingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: BollingerParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).standardDeviation?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#bookImbalance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain imbalance; use `.explain()` for effective depth, weighting, and null diagnostics. ```typescript export declare const bookImbalance: import('@insiderfinance/totalfinance/core').SeriesFacade<[book: OrderBook, parameters?: BookImbalanceParameters | undefined], number | null, { conventionsVersion: string; levels: number; weighted: boolean; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [book: OrderBook, parameters?: BookImbalanceParameters | undefined]; default: not declared - explain: (book: OrderBook, parameters?: BookImbalanceParameters | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; levels: number; weighted: boolean; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [book: OrderBook, parameters?: BookImbalanceParameters | undefined]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#bop Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const bop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#brar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const brar: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, BrarPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: BrarPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => BrarPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => BrarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: BrarPoint | null; default: not declared - fromJSON().return.value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - fromJSON().return.value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => BrarPoint | null; default: not declared - stream().return.peek: (input: BarInput) => BrarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: BrarPoint | null; default: not declared - stream().return.value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - stream().return.value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#breakouts Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Breakout signal aligned to the input: at each bar, `+1` if the close exceeds the highest high of the prior `lookback` bars, `−1` if it breaks below the lowest low, else `0` (null during warmup). ```typescript export declare function breakouts(bars: ArrayLike, options?: { lookback?: number; }): BreakoutsReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { lookback?: number; }; default: not declared - (options).lookback?: number; default: not declared - return.assumptions: { conventionsVersion: string; lookback: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.lookback: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.signal: (number | null)[]; default: not declared — Aligned to the input: `+1` when the close exceeds the highest high of the prior `lookback` bars, `−1` below the lowest low, `0` otherwise — `null` during the lookback warmup. ### @insiderfinance/totalfinance/technical-analysis#candleAverage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). TA-Lib's `TA_CANDLEAVERAGE` at every bar: `factor · (avg of `range` over the preceding `averagePeriod` bars) / denom`, where `denom = 2` for the Shadows range type (it sums two shadows) else `1`. With `averagePeriod = 0` the current bar's own range is used. Bars before the trailing window is full get `NaN` (the pattern is in its lookback there). ```typescript export declare function candleAverage(bars: ArrayLike, setting: CandleSetting): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (setting): CandleSetting; default: not declared - (setting).averagePeriod: number; default: not declared — Trailing-average period; 0 means "use the current bar's range" (no averaging). - (setting).factor: number; default: not declared - (setting).range: CandleRangeType; default: not declared ### @insiderfinance/totalfinance/technical-analysis#candleColor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Candle color: +1 white (close ≥ open), −1 black. ```typescript export declare const candleColor: (bar: BarInput) => number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bar): BarInput; default: not declared - (bar).close: number; default: not declared - (bar).high: number; default: not declared - (bar).low: number; default: not declared - (bar).open?: number; default: not declared - (bar).volume?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#candleRange Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const candleRange: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#candlestickNames Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Names of every catalogued candlestick pattern. ```typescript export declare const candlestickNames: string[]; ``` ### @insiderfinance/totalfinance/technical-analysis#candlesticks Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). All candlestick patterns, keyed by name → an aligned batch+stream indicator emitting ±100 / 0. ```typescript export declare const candlesticks: Record>; ``` ### @insiderfinance/totalfinance/technical-analysis#cci Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cci: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlClosingMarubozuTalib Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CDLCLOSINGMARUBOZU (TA-Lib): a long real body where the shadow on the *close* side is shorter than `ShadowVeryShort` (the open-side shadow is unconstrained) → ±100 by color, else 0. ```typescript export declare function cdlClosingMarubozuTalib(bars: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlDoji Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dedicated Doji pattern accessor (pandas-ta `cdl_doji`). ```typescript export declare const cdlDoji: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: {} | undefined; default: not declared - explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: {} | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: {} | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlDojiTalib Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CDLDOJI (TA-Lib): +100 when the real body is no larger than `BodyDoji`'s adaptive threshold (a fraction of the trailing high-low average), else 0. Doji is non-directional, so it is never −100. ```typescript export declare function cdlDojiTalib(bars: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlInside Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inside-bar pattern (TA-Lib `CDLINSIDE`): +100 bullish inside, −100 bearish inside, else 0. ```typescript export declare const cdlInside: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: {} | undefined; default: not declared - explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: {} | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: {} | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlMarubozuTalib Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). CDLMARUBOZU (TA-Lib): a long real body (`BodyLong`) with both shadows shorter than the `ShadowVeryShort` threshold → ±100 by candle color (white +100, black −100), else 0. ```typescript export declare function cdlMarubozuTalib(bars: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlPattern Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run a single candlestick pattern by TotalFinance or TA-Lib name, returning the aligned ±100/0 series. Pass `'all'` to scan the full catalog (returns per-bar matches instead). ```typescript export declare function cdlPattern(bars: ArrayLike, name: string): number[]; export declare function cdlPattern(bars: ArrayLike, name: 'all'): CandleMatch[][]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (name): ('all') | (string); default: not declared ### @insiderfinance/totalfinance/technical-analysis#cdlZ Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). pandas-ta `cdl_z`: rolling sample z-score normalization of OHLC candles. ```typescript export declare const cdlZ: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: CandleZParameters | undefined; default: not declared - (parameters).ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: CandleZParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: CandleZPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: CandleZParameters | undefined; default: not declared - explain(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => CandleZPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => CandleZPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: CandleZPoint | null; default: not declared - fromJSON().return.value.close: number; default: not declared - fromJSON().return.value.high: number; default: not declared - fromJSON().return.value.low: number; default: not declared - fromJSON().return.value.open: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: CandleZParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => CandleZPoint | null; default: not declared - stream().return.peek: (input: BarInput) => CandleZPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: CandleZPoint | null; default: not declared - stream().return.value.close: number; default: not declared - stream().return.value.high: number; default: not declared - stream().return.value.low: number; default: not declared - stream().return.value.open: number; default: not declared - stream(parameters)?: CandleZParameters | undefined; default: not declared - stream(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the sample standard deviation. Default 1. - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ceil Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ceil: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#centerOfGravity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const centerOfGravity: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#centralPivotRange Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const centralPivotRange: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, CprPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: CprPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => CprPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => CprPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: CprPoint | null; default: not declared - fromJSON().return.value.bottomCentral: number; default: not declared — Bottom central = (H + L) / 2 of the prior bar. - fromJSON().return.value.pivot: number; default: not declared — Pivot = (H + L + C) / 3 of the prior bar. - fromJSON().return.value.topCentral: number; default: not declared — Top central = 2·pivot − bottomCentral. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => CprPoint | null; default: not declared - stream().return.peek: (input: BarInput) => CprPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: CprPoint | null; default: not declared - stream().return.value.bottomCentral: number; default: not declared — Bottom central = (H + L) / 2 of the prior bar. - stream().return.value.pivot: number; default: not declared — Pivot = (H + L + C) / 3 of the prior bar. - stream().return.value.topCentral: number; default: not declared — Top central = 2·pivot − bottomCentral. - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cfo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Chande Forecast Oscillator: % distance of price from its linear-regression value. ```typescript export declare const cfo: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#chaikinMoneyFlow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const chaikinMoneyFlow: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#chaikinOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const chaikinOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ChaikinOscParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: ChaikinOscParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ChaikinOscParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ChaikinOscParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: ChaikinOscParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#chaikinVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const chaikinVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ChaikinVolatilityParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).rocPeriod?: number; default: not declared - explain: (input: ArrayLike, parameters?: ChaikinVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ChaikinVolatilityParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).rocPeriod?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ChaikinVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: ChaikinVolatilityParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).rocPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#chandeKrollStop Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const chandeKrollStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ChandeKrollStopParameters | undefined; default: not declared - (parameters).atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - (parameters).multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - (parameters).period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. - explain: (input: ArrayLike, parameters?: ChandeKrollStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChandeKrollStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ChandeKrollStopParameters | undefined; default: not declared - explain(parameters).atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - explain(parameters).multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - explain(parameters).period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ChandeKrollStopPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ChandeKrollStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChandeKrollStopPoint | null; default: not declared - fromJSON().return.value.long: number; default: not declared — Long stop — highest first-stage high-stop over the lookback (trails above price). - fromJSON().return.value.short: number; default: not declared — Short stop — lowest first-stage low-stop over the lookback (trails below price). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ChandeKrollStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ChandeKrollStopPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ChandeKrollStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChandeKrollStopPoint | null; default: not declared - stream().return.value.long: number; default: not declared — Long stop — highest first-stage high-stop over the lookback (trails above price). - stream().return.value.short: number; default: not declared — Short stop — lowest first-stage low-stop over the lookback (trails below price). - stream(parameters)?: ChandeKrollStopParameters | undefined; default: not declared - stream(parameters).atrPeriod?: number; default: not declared — ATR length + first-stage high/low lookback (TA `p`). Default 10. - stream(parameters).multiplier?: number; default: not declared — ATR multiplier (TA `x`). Default 1. - stream(parameters).period?: number; default: not declared — Second-stage stop lookback (TA `q`). Default 9. ### @insiderfinance/totalfinance/technical-analysis#chandelierExit Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const chandelierExit: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ChandelierParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: ChandelierParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChandelierPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ChandelierParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ChandelierPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ChandelierPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChandelierPoint | null; default: not declared - fromJSON().return.value.long: number; default: not declared - fromJSON().return.value.short: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ChandelierParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ChandelierPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ChandelierPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChandelierPoint | null; default: not declared - stream().return.value.long: number; default: not declared - stream().return.value.short: number; default: not declared - stream(parameters)?: ChandelierParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#change Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Alias of `diff`. ```typescript export declare const change: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#channel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The trendline pair as a channel; `support`/`resistance` are the channel rails. ```typescript export declare function channel(bars: ArrayLike, options?: { strength?: number; }): TrendlineChannel; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { strength?: number; }; default: not declared - (options).strength?: number; default: not declared - return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.strength: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.resistance: Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - return.resistance.from: number; default: not declared - return.resistance.intercept: number; default: not declared - return.resistance.slope: number; default: not declared - return.resistance.to: number; default: not declared - return.support: Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - return.support.from: number; default: not declared - return.support.intercept: number; default: not declared - return.support.slope: number; default: not declared - return.support.to: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#charts Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Chart-construction group: alternative chart types built from OHLC bars. ```typescript export declare const charts: { readonly dollarBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly dollarImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly dollarRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly imbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly kagi: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').KagiParameters) => import('@insiderfinance/totalfinance/technical-analysis').KagiSegment[]; readonly lineBreak: (bars: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; readonly pointAndFigure: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').PnfParameters) => import('@insiderfinance/totalfinance/technical-analysis').PnfColumn[]; readonly rangeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly renko: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; readonly runBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly tickBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly volumeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly volumeImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; readonly volumeRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dollarBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - dollarBars(bars): ArrayLike; default: not declared - dollarBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').DollarBarParameters; default: not declared - dollarBars(parameters).dollar: number; default: not declared - dollarBars(parameters).flush?: boolean; default: not declared - dollarImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - dollarImbalanceBars(bars): ArrayLike; default: not declared - dollarImbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - dollarImbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - dollarImbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - dollarRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - dollarRunBars(bars): ArrayLike; default: not declared - dollarRunBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - dollarRunBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - dollarRunBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - imbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - imbalanceBars(bars): ArrayLike; default: not declared - imbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - imbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - imbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - kagi: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').KagiParameters) => import('@insiderfinance/totalfinance/technical-analysis').KagiSegment[]; default: not declared - kagi(bars): ArrayLike; default: not declared - kagi(parameters): import('@insiderfinance/totalfinance/technical-analysis').KagiParameters; default: not declared - kagi(parameters).percent?: boolean; default: not declared - kagi(parameters).reversal: number; default: not declared — Reversal amount. Absolute price by default, or a percent of price if `percent` is true. - lineBreak: (bars: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters) => import('@insiderfinance/totalfinance/technical-analysis').LineBreakBar[]; default: not declared - lineBreak(bars): ArrayLike; default: not declared - lineBreak(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').LineBreakParameters; default: not declared - lineBreak(parameters).lines?: number; default: not declared - pointAndFigure: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').PnfParameters) => import('@insiderfinance/totalfinance/technical-analysis').PnfColumn[]; default: not declared - pointAndFigure(bars): ArrayLike; default: not declared - pointAndFigure(parameters): import('@insiderfinance/totalfinance/technical-analysis').PnfParameters; default: not declared - pointAndFigure(parameters).boxSize: number; default: not declared - pointAndFigure(parameters).reversal?: number; default: not declared - rangeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - rangeBars(bars): ArrayLike; default: not declared - rangeBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').RangeBarParameters; default: not declared - rangeBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - rangeBars(parameters).size: number; default: not declared - renko: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters) => import('@insiderfinance/totalfinance/technical-analysis').RenkoBrick[]; default: not declared - renko(bars): ArrayLike; default: not declared - renko(parameters): import('@insiderfinance/totalfinance/technical-analysis').RenkoParameters; default: not declared - renko(parameters).brickSize: number; default: not declared - runBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - runBars(bars): ArrayLike; default: not declared - runBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - runBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - runBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - tickBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - tickBars(bars): ArrayLike; default: not declared - tickBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').CountBarParameters; default: not declared - tickBars(parameters).count: number; default: not declared - tickBars(parameters).flush?: boolean; default: not declared - volumeBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - volumeBars(bars): ArrayLike; default: not declared - volumeBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').VolumeBarParameters; default: not declared - volumeBars(parameters).flush?: boolean; default: not declared - volumeBars(parameters).volume: number; default: not declared - volumeImbalanceBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - volumeImbalanceBars(bars): ArrayLike; default: not declared - volumeImbalanceBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - volumeImbalanceBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - volumeImbalanceBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. - volumeRunBars: (bars: ArrayLike, parameters: import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters) => import('@insiderfinance/totalfinance/technical-analysis').BarInput[]; default: not declared - volumeRunBars(bars): ArrayLike; default: not declared - volumeRunBars(parameters): import('@insiderfinance/totalfinance/technical-analysis').InformationBarParameters; default: not declared - volumeRunBars(parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - volumeRunBars(parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#checkSnapshotVersion Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a snapshot's schema version before restoring. A newer version is rejected — this build can't know what changed, so restoring would silently corrupt state, which design law #4 forbids. An OLDER version is rejected too: the v1 flat shape has no `state`, so "accepting" it would restore an indicator with every field undefined. ```typescript export declare function checkSnapshotVersion(snapshot: TechnicalAnalysisSnapshot): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (snapshot): TechnicalAnalysisSnapshot; default: not declared - (snapshot).kind: string; default: not declared - (snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - (snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#choppinessIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const choppinessIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cmo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cmo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: CmoParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - (parameters).talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. - explain: (input: ArrayLike, parameters?: CmoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: CmoParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - explain(parameters).talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: CmoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: CmoParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - stream(parameters).talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. ### @insiderfinance/totalfinance/technical-analysis#collectAsync Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Drain an async iterable through a stream into an aligned series (NaN sentinel during warmup). ```typescript export declare function collectAsync(stream: IndicatorStream, source: AsyncIterable, nan: Out): Promise<{ value: Out[]; warmup: number; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (nan): Out; default: not declared - (source): AsyncIterable; default: not declared - (stream): IndicatorStream; default: not declared - (stream).next: (input: In) => Out | null; default: not declared - (stream).toJSON: () => TechnicalAnalysisSnapshot; default: not declared - (stream).value: Out | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#columnsFromBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Convert bar rows back into columnar arrays (only columns present on the first bar are emitted). ```typescript export declare function columnsFromBars(bars: readonly BarInput[]): BarColumns; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): readonly BarInput[]; default: not declared - return.close?: readonly number[]; default: not declared - return.high?: readonly number[]; default: not declared - return.low?: readonly number[]; default: not declared - return.open?: readonly number[]; default: not declared - return.volume?: readonly number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#compatibilityMatrixMarkdown Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Render the TotalFinance ↔ TA-Lib ↔ pandas-ta ↔ TradingView name map as a Markdown matrix. ```typescript export declare function compatibilityMatrixMarkdown(): string; ``` ### @insiderfinance/totalfinance/technical-analysis#condition Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a custom condition. `refs` are the column aliases / `alias.field` / raw OHLCV fields the predicate reads via `context.get(...)` — they are validated up front like the built-in conditions, so a typo fails loud. Pass `[]` for a condition that reads nothing (or reads only constants). ```typescript export declare function condition(refs: readonly string[], predicate: (context: SignalContext, barIndex: number) => boolean): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (predicate): (context: SignalContext, barIndex: number) => boolean; default: not declared - (refs): readonly string[]; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#connorsRsi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const connorsRsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ConnorsRsiParameters | undefined; default: not declared - (parameters).rankPeriod?: number; default: not declared - (parameters).rsiPeriod?: number; default: not declared - (parameters).streakPeriod?: number; default: not declared - explain: (input: ArrayLike, parameters?: ConnorsRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ConnorsRsiParameters | undefined; default: not declared - explain(parameters).rankPeriod?: number; default: not declared - explain(parameters).rsiPeriod?: number; default: not declared - explain(parameters).streakPeriod?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ConnorsRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: ConnorsRsiParameters | undefined; default: not declared - stream(parameters).rankPeriod?: number; default: not declared - stream(parameters).rsiPeriod?: number; default: not declared - stream(parameters).streakPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#coppock Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const coppock: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: CoppockParameters | undefined; default: not declared - (parameters).longRoc?: number; default: not declared - (parameters).shortRoc?: number; default: not declared - (parameters).wma?: number; default: not declared - explain: (input: ArrayLike, parameters?: CoppockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: CoppockParameters | undefined; default: not declared - explain(parameters).longRoc?: number; default: not declared - explain(parameters).shortRoc?: number; default: not declared - explain(parameters).wma?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: CoppockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: CoppockParameters | undefined; default: not declared - stream(parameters).longRoc?: number; default: not declared - stream(parameters).shortRoc?: number; default: not declared - stream(parameters).wma?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#correl Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const correl: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cos Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cos: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cosh Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cosh: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#covariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling covariance of a paired series (sample denominator by default). ```typescript export declare const covariance: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: CovarianceParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - (parameters).sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. - explain: (input: ArrayLike, parameters?: CovarianceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: CovarianceParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: CovarianceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: CovarianceParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).sample?: boolean; default: not declared — Use the sample (n−1) denominator. Default true. ### @insiderfinance/totalfinance/technical-analysis#crossOver Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function crossOver(first: Operand, second: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): Operand; default: not declared - (second): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#crossSignals Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cross-based long/flat state machine: enter when the series crosses above `above`, exit below `below`. ```typescript export declare const crossSignals: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: CrossSignalParameters | undefined; default: not declared - (parameters).above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - (parameters).below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. - explain: (input: ArrayLike, parameters?: CrossSignalParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TrendSignalPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: CrossSignalParameters | undefined; default: not declared - explain(parameters).above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - explain(parameters).below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => TrendSignalPoint | null; default: not declared - fromJSON().return.peek: (input: number) => TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TrendSignalPoint | null; default: not declared - fromJSON().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - fromJSON().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - fromJSON().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: CrossSignalParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => TrendSignalPoint | null; default: not declared - stream().return.peek: (input: number) => TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TrendSignalPoint | null; default: not declared - stream().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - stream().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - stream().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - stream(parameters)?: CrossSignalParameters | undefined; default: not declared - stream(parameters).above?: number; default: not declared — Enter long when the series crosses up through this level. Default 0. - stream(parameters).below?: number; default: not declared — Exit when the series crosses down through this level. Default 0. ### @insiderfinance/totalfinance/technical-analysis#crossUnder Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function crossUnder(first: Operand, second: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (first): Operand; default: not declared - (second): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#crossany Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 on the bar where `x` crosses either above or below `y`, else 0. ```typescript export declare const crossany: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#crossover Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 on the bar where `x` crosses above `y`, else 0. ```typescript export declare const crossover: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cti Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cti: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cumulativeSum Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Running cumulative sum. ```typescript export declare const cumulativeSum: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#cumulativeVolumeDelta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Batch cumulative volume delta over a trade tape. ```typescript export declare function cumulativeVolumeDelta(trades: readonly Trade[], parameters?: CvdParameters): CvdResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters)?: CvdParameters; default: not declared - (parameters).method?: AggressorMethod; default: not declared — Aggressor inference method. Default `'quote'` (Lee-Ready) when quotes are supplied, else `'tick'`. - (parameters).quotes?: readonly Quote[]; default: not declared — NBBO quotes aligned 1:1 with `trades` (for the quote rule). - (trades): readonly Trade[]; default: not declared - return.assumptions: { conventionsVersion: string; method: AggressorMethod; }; default: not declared — Applied conventions, echoed — `method` is the aggressor rule actually used. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: AggressorMethod; default: not declared - return.buyVolume: number; default: not declared - return.cumulative: number[]; default: not declared — Running cumulative volume delta after each trade. - return.delta: number[]; default: not declared — Per-trade signed volume (`sign · size`). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.sellVolume: number; default: not declared - return.sign: number[]; default: not declared — Per-trade aggressor sign (+1 / −1 / 0). ### @insiderfinance/totalfinance/technical-analysis#cvd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const cvd: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#decreasing Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 when the series is lower than `period` bars ago (strict → every step fell). ```typescript export declare const decreasing: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: TrendTestParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - (parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - explain: (input: ArrayLike, parameters?: TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: TrendTestParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - explain(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: TrendTestParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - stream(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). ### @insiderfinance/totalfinance/technical-analysis#defineIndicator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build an aligned batch+stream indicator and register it. Returns the facade. ```typescript export declare function defineIndicator(definition: IndicatorDefinition): Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definition): IndicatorDefinition; default: not declared - (definition).category?: IndicatorCategory; default: not declared - (definition).conventions?: Readonly>; default: not declared — See {@link IndicatorMetadata.conventions} — declared here, echoed by every `.explain()`. - (definition).defaults?: Record; default: not declared — Declared default per optional parameter, echoed through `.explain().assumptions.parameters` (the disclosure law). Every key must appear in `parameters`; parameters without a default are required. - (definition).inputs: IndicatorInputs; default: not declared - (definition).name: string; default: not declared - (definition).nan: (parameters: P) => Out; default: not declared — Warmup sentinel factory. - (definition).output: IndicatorOutputMetadata; default: not declared — Output metadata (Wave 6 §4) — the recursive value schema + optional visualization. Required. - (definition).parameters?: string[]; default: not declared - (definition).restore: (snapshot: TechnicalAnalysisSnapshot) => IndicatorStream; default: not declared — TechnicalAnalysisSnapshot restorer (`makeIndicator`'s restore). - (definition).stream: (parameters: P) => IndicatorStream; default: not declared — Stream factory (`makeIndicator`'s `make`). - return.explain: (input: ArrayLike, parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - return.fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - return.stream: (parameters?: P | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared ### @insiderfinance/totalfinance/technical-analysis#dema Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const dema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#describeIndicator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One indicator's full metadata card (alias-aware): category, input kind, parameters, defaults, which are required, its warmup, and its cross-library aliases. Throws on an unknown name. See the spec. ```typescript export declare function describeIndicator(name: string, probeLength?: number): IndicatorDescription; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared - (probeLength)?: number; default: not declared - return.aliases?: Omit; default: not declared — Cross-library aliases (TA-Lib / pandas-ta / TradingView), when known. - return.aliases.pandas?: string | string[]; default: not declared — pandas-ta name(s), snake_case. - return.aliases.talib?: string | string[]; default: not declared — TA-Lib function name(s), uppercase. - return.aliases.tradingview?: string; default: not declared — TradingView display name. - return.category: IndicatorCategory; default: not declared - return.conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal (Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded) — present only where such a choice exists. This is the field that answers "why does your RSI disagree with my other library?" without leaving the tool schema. - return.defaults: Record; default: not declared — Declared default per optional parameter; a derived default is a resolver function. - return.inputs: IndicatorInputs; default: not declared — Input kind expected by the indicator. - return.name: string; default: not declared — Canonical registered name. - return.output: IndicatorOutputMetadata; default: not declared — The output metadata — recursive value schema + optional visualization (Wave 6 §4). - return.parameters: string[]; default: not declared — All parameter names (including defaulted ones the caller may omit). - return.required: string[]; default: not declared — Parameters with no default — the caller must supply these. - return.warmup: number | null; default: not declared — Leading bars before the first real value, or `null` if it never emitted within the probe. ### @insiderfinance/totalfinance/technical-analysis#detectCandles Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Scan bars with the whole catalog, returning the matched patterns (non-zero signal) at each bar. Index `i` of the result lists patterns that complete on bar `i`. ```typescript export declare function detectCandles(bars: ArrayLike): CandleMatch[][]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#difference Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Discrete difference: `input[i] − input[i − period]`. ```typescript export declare const difference: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#div Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const div: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#divergence Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `divergence` indicator (registry name `divergence`, category `price-action`): a streaming price/indicator divergence detector. Input is a `{ x: price, y: indicator }` pair per bar; each bar yields a numeric {@link DivergencePoint} (`code: 0` when nothing confirms). For the friendly event-list form with string `kind`, use {@link divergences}. ```typescript export declare const divergence: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: DivergenceParameters | undefined; default: not declared - (parameters).kinds?: DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - (parameters).swing?: SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - explain: (input: ArrayLike, parameters?: DivergenceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: DivergencePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: DivergenceParameters | undefined; default: not declared - explain(parameters).kinds?: DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - explain(parameters).swing?: SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => DivergencePoint | null; default: not declared - fromJSON().return.peek: (input: Pair) => DivergencePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: DivergencePoint | null; default: not declared - fromJSON().return.value.code: number; default: not declared — Signed class code (see {@link DivergenceCode}); `0` none, `NaN` warmup. - fromJSON().return.value.index: number; default: not declared — Confirmation bar index (`NaN` when no divergence / warmup). - fromJSON().return.value.indicatorSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` indicator value (`[NaN, NaN]` when none). - fromJSON().return.value.priceSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` price (`[NaN, NaN]` when none). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: DivergenceParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => DivergencePoint | null; default: not declared - stream().return.peek: (input: Pair) => DivergencePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: DivergencePoint | null; default: not declared - stream().return.value.code: number; default: not declared — Signed class code (see {@link DivergenceCode}); `0` none, `NaN` warmup. - stream().return.value.index: number; default: not declared — Confirmation bar index (`NaN` when no divergence / warmup). - stream().return.value.indicatorSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` indicator value (`[NaN, NaN]` when none). - stream().return.value.priceSwings: [number, number]; default: not declared — `[earlier-swing, confirming-swing]` price (`[NaN, NaN]` when none). - stream(parameters)?: DivergenceParameters | undefined; default: not declared - stream(parameters).kinds?: DivergenceKind[]; default: not declared — Which divergence classes to emit (default all four). - stream(parameters).swing?: SwingWindow; default: not declared — Fractal confirmation window (default `{ left: 5, right: 5 }`). ### @insiderfinance/totalfinance/technical-analysis#divergences Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function divergences(input: DivergencesInput): DivergenceEvent[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DivergencesInput; default: not declared - (input).indicator: ArrayLike; default: not declared - (input).parameters?: DivergenceParameters; default: not declared - (input).price: ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#dmi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const dmi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: DmiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => DmiPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => DmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: DmiPoint | null; default: not declared - fromJSON().return.value.dx: number; default: not declared - fromJSON().return.value.minusDI: number; default: not declared - fromJSON().return.value.minusDM: number; default: not declared — Wilder-smoothed −DM. - fromJSON().return.value.plusDI: number; default: not declared - fromJSON().return.value.plusDM: number; default: not declared — Wilder-smoothed +DM. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => DmiPoint | null; default: not declared - stream().return.peek: (input: BarInput) => DmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: DmiPoint | null; default: not declared - stream().return.value.dx: number; default: not declared - stream().return.value.minusDI: number; default: not declared - stream().return.value.minusDM: number; default: not declared — Wilder-smoothed −DM. - stream().return.value.plusDI: number; default: not declared - stream().return.value.plusDM: number; default: not declared — Wilder-smoothed +DM. - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#dollarBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function dollarBars(bars: ArrayLike, parameters: DollarBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): DollarBarParameters; default: not declared - (parameters).dollar: number; default: not declared - (parameters).flush?: boolean; default: not declared ### @insiderfinance/totalfinance/technical-analysis#dollarImbalanceBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dollar imbalance bars — signed dollar value `|Σ sign(Δclose)·close·volume|`. ```typescript export declare function dollarImbalanceBars(bars: ArrayLike, parameters: InformationBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): InformationBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#dollarRunBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dollar run bars — close on the larger one-sided dollar run. ```typescript export declare function dollarRunBars(bars: ArrayLike, parameters: InformationBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): InformationBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#donchian Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const donchian: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChannelPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#donchianTrend Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const donchianTrend: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#dpo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const dpo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#drawdown Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const drawdown: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: DrawdownPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => DrawdownPoint | null; default: not declared - fromJSON().return.peek: (input: number) => DrawdownPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: DrawdownPoint | null; default: not declared - fromJSON().return.value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - fromJSON().return.value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - fromJSON().return.value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => DrawdownPoint | null; default: not declared - stream().return.peek: (input: number) => DrawdownPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: DrawdownPoint | null; default: not declared - stream().return.value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - stream().return.value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - stream().return.value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#dsp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Detrended Synthetic Price: `close - EMA(close, period)` (pandas-ta `dsp`). ```typescript export declare const dsp: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: DspParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: DspParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: DspParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: DspParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: DspParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#dx Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const dx: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#easeOfMovement Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const easeOfMovement: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: EomParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - explain: (input: ArrayLike, parameters?: EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: EomParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: EomParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. ### @insiderfinance/totalfinance/technical-analysis#ebsw Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Even Better Sinewave (pandas-ta `ebsw`), bounded roughly to [-1, 1]. Matches pandas-ta **including its degree/radian translation defect** — it is not Ehlers's published filter (see `EbswStream` and `docs/compatibility/talib-differences.md`). ```typescript export declare const ebsw: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: EbswParameters | undefined; default: not declared - (parameters).bars?: number; default: not declared — Low-pass filtering period. Default 10. - (parameters).period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. - explain: (input: ArrayLike, parameters?: EbswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: EbswParameters | undefined; default: not declared - explain(parameters).bars?: number; default: not declared — Low-pass filtering period. Default 10. - explain(parameters).period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: EbswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: EbswParameters | undefined; default: not declared - stream(parameters).bars?: number; default: not declared — Low-pass filtering period. Default 10. - stream(parameters).period?: number; default: not declared — Max cycle/trend period. pandas-ta enforces a practical minimum of 39. Default 40. ### @insiderfinance/totalfinance/technical-analysis#efficiencyRatio Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const efficiencyRatio: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#efi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Elder's Force Index (alias of `forceIndex`). ```typescript export declare const efi: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#elderRay Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const elderRay: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, ElderRayPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ElderRayPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ElderRayPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ElderRayPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ElderRayPoint | null; default: not declared - fromJSON().return.value.bear: number; default: not declared - fromJSON().return.value.bull: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ElderRayPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ElderRayPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ElderRayPoint | null; default: not declared - stream().return.value.bear: number; default: not declared - stream().return.value.bull: number; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#elderThermometer Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const elderThermometer: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ElderThermometerParameters | undefined; default: not declared - (parameters).long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - (parameters).period?: number; default: not declared - (parameters).short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. - explain: (input: ArrayLike, parameters?: ElderThermometerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ElderThermometerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ElderThermometerParameters | undefined; default: not declared - explain(parameters).long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - explain(parameters).period?: number; default: not declared - explain(parameters).short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ElderThermometerPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ElderThermometerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ElderThermometerPoint | null; default: not declared - fromJSON().return.value.long: number; default: not declared — 1 when thermo < movingAverage·long (calm). - fromJSON().return.value.movingAverage: number; default: not declared - fromJSON().return.value.short: number; default: not declared — 1 when thermo > movingAverage·short (active). - fromJSON().return.value.thermo: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ElderThermometerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ElderThermometerPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ElderThermometerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ElderThermometerPoint | null; default: not declared - stream().return.value.long: number; default: not declared — 1 when thermo < movingAverage·long (calm). - stream().return.value.movingAverage: number; default: not declared - stream().return.value.short: number; default: not declared — 1 when thermo > movingAverage·short (active). - stream().return.value.thermo: number; default: not declared - stream(parameters)?: ElderThermometerParameters | undefined; default: not declared - stream(parameters).long?: number; default: not declared — "Quiet market" factor — thermo below `movingAverage·long` flags a long-friendly regime. Default 2. - stream(parameters).period?: number; default: not declared - stream(parameters).short?: number; default: not declared — "Hot market" factor — thermo above `movingAverage·short` flags volatility. Default 0.5. ### @insiderfinance/totalfinance/technical-analysis#ema Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#emv Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ease of Movement (alias of `easeOfMovement`). ```typescript export declare const emv: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').EomParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).scale?: number; default: not declared — Volume scale to keep the box ratio in a sane range. Default 1e8. ### @insiderfinance/totalfinance/technical-analysis#entropy Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling Shannon entropy (pandas-ta: each value as a fraction of the window sum), in bits. ```typescript export declare const entropy: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#equalHighs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equal highs — consecutive swing highs within `tolerance` (a buy-side liquidity pool). ```typescript export declare const equalHighs: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: EqualLevelParameters | undefined; default: not declared - (parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - (parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - explain: (input: ArrayLike, parameters?: EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: EqualLevelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: EqualLevelParameters | undefined; default: not declared - explain(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - explain(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => EqualLevelPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: EqualLevelPoint | null; default: not declared - fromJSON().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - fromJSON().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - fromJSON().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => EqualLevelPoint | null; default: not declared - stream().return.peek: (input: BarInput) => EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: EqualLevelPoint | null; default: not declared - stream().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - stream().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - stream().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - stream(parameters)?: EqualLevelParameters | undefined; default: not declared - stream(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - stream(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). ### @insiderfinance/totalfinance/technical-analysis#equalLows Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equal lows — consecutive swing lows within `tolerance` (a sell-side liquidity pool). ```typescript export declare const equalLows: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: EqualLevelParameters | undefined; default: not declared - (parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - (parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - explain: (input: ArrayLike, parameters?: EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: EqualLevelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: EqualLevelParameters | undefined; default: not declared - explain(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - explain(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => EqualLevelPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: EqualLevelPoint | null; default: not declared - fromJSON().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - fromJSON().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - fromJSON().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: EqualLevelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => EqualLevelPoint | null; default: not declared - stream().return.peek: (input: BarInput) => EqualLevelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: EqualLevelPoint | null; default: not declared - stream().return.value.count: number; default: not declared — Size of the current equal cluster (≥2 when detected, else 0). - stream().return.value.detected: number; default: not declared — 1 when the swing confirmed on this bar matches the prior swing within tolerance, else 0. - stream().return.value.level: number | null; default: not declared — The (averaged) equal level when detected, else `null`. - stream(parameters)?: EqualLevelParameters | undefined; default: not declared - stream(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - stream(parameters).tolerance?: number; default: not declared — Max fractional distance between consecutive swings to count as "equal". Default 0.001 (0.1%). ### @insiderfinance/totalfinance/technical-analysis#exp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const exp: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#exponentialDecay Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exponential decay floor — same shape, with an `exp(−period)` step (decays far more slowly). ```typescript export declare const exponentialDecay: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#fairValueGaps Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const fairValueGaps: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: FvgParameters | undefined; default: not declared - (parameters).minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. - explain: (input: ArrayLike, parameters?: FvgParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ZonePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: FvgParameters | undefined; default: not declared - explain(parameters).minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ZonePoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ZonePoint | null; default: not declared - fromJSON().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - fromJSON().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - fromJSON().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - fromJSON().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: FvgParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ZonePoint | null; default: not declared - stream().return.peek: (input: BarInput) => ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ZonePoint | null; default: not declared - stream().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - stream().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - stream().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - stream().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - stream(parameters)?: FvgParameters | undefined; default: not declared - stream(parameters).minimumGapPercent?: number; default: not declared — Minimum gap height as a percent of its midpoint to qualify (filters noise). Default 0. ### @insiderfinance/totalfinance/technical-analysis#falling Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function falling(operand: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (operand): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#features Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function features(candles: BarInput[]): FeaturePipeline; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (candles): BarInput[]; default: not declared - return.applyBars: (indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }) => FeaturePipeline; default: not declared — Apply any bar indicator (BarInput → Out) to the candles. - return.applySeries: (field: Field, indicator: Indicator, parameters: P, options: AliasOpt & { as: string; }) => FeaturePipeline; default: not declared — Apply any series indicator (number → Out) to a price field. The generic escape hatch that lets the pipeline reach every indicator in the catalog, not just the named convenience methods. - return.atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: ATR's Wilder period defaults to 14, exactly as `atr(bars)` does. - return.bbands: (field: Field, parameters?: BollingerParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: Bollinger's period defaults to 20, exactly as `bbands(series)` does. - return.column: (alias: string, values: FeatureColumn) => FeaturePipeline; default: not declared — Inject a precomputed column under an alias. - return.ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - return.field: (field: Field) => number[]; default: not declared — The raw `field` column (`close`, `high`, …) as a number array. - return.macd: (field: Field, parameters?: MacdParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - return.obv: (options?: AliasOpt) => FeaturePipeline; default: not declared - return.returns: (field: Field, options?: AliasOpt) => FeaturePipeline; default: not declared - return.rollingVolatility: (field: Field, parameters: RollingVolatilityParameters, options?: AliasOpt) => FeaturePipeline; default: not declared - return.rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — `parameters` is optional: RSI's period defaults to 14, exactly as `rsi(series)` does. - return.sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared — The convenience methods all follow one order, and the order is the point: validate the alias, then CALL THE INDICATOR, then build the auto-name from the parameters it just accepted. The first version built the name first — `` `sma_${field}_${parameters.period}` `` — so a caller who omitted `parameters` got `TypeError: Cannot read properties of undefined (reading 'period')` from the pipeline instead of `sma`'s own teaching `InputError`. Worse for `rsi` and `atr`, whose direct forms default to 14: the fluent wrapper was STRICTER than the thing it wraps. Calling the indicator first delegates every parameter question to the validator that owns it. - return.toColumns: () => Record; default: not declared — Columnar output keyed by alias. - return.toRows: () => Record[]; default: not declared — Row-oriented output: one object per bar with each alias as a key. - return.vwap: (options?: AliasOpt) => FeaturePipeline; default: not declared - return.wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => FeaturePipeline; default: not declared ### @insiderfinance/totalfinance/technical-analysis#fibExtension Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function fibExtension(input: FibExtensionInput): FibLevel[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FibExtensionInput; default: not declared - (input).end: number; default: not declared - (input).levels?: readonly number[]; default: not declared - (input).projectFrom: number; default: not declared - (input).start: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#fibRetracement Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fibonacci retracement levels for a move from `start` (origin / 100% line) to `end` (extreme / 0% line): `price(r) = end + (start − end)·r`. Direction-agnostic — works for up- and down-moves. ```typescript export declare function fibRetracement(start: number, end: number, levels?: readonly number[]): FibLevel[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (end): number; default: not declared - (levels)?: readonly number[]; default: not declared - (start): number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#fisherTransform Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const fisherTransform: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: FisherParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: FisherParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: FisherPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: FisherParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => FisherPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => FisherPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: FisherPoint | null; default: not declared - fromJSON().return.value.fisher: number; default: not declared - fromJSON().return.value.trigger: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: FisherParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => FisherPoint | null; default: not declared - stream().return.peek: (input: BarInput) => FisherPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: FisherPoint | null; default: not declared - stream().return.value.fisher: number; default: not declared - stream().return.value.trigger: number; default: not declared - stream(parameters)?: FisherParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#floor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const floor: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#footprintBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate a trade tape into OHLCV bars annotated with the aggressor footprint (buy/sell volume and delta), bucketing by trade `count`, cumulative `volume`, or `time`. ```typescript export declare function footprintBars(trades: readonly Trade[], parameters: FootprintBarParameters): FootprintBar[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): FootprintBarParameters; default: not declared - (parameters).by?: 'time' | 'volume' | 'count'; default: not declared — Aggregation rule and threshold. `by` defaults to `'volume'`. - (parameters).method?: AggressorMethod; default: not declared - (parameters).quotes?: readonly Quote[]; default: not declared - (parameters).threshold: number; default: not declared — Trades per bar (`count`), volume per bar (`volume`), or milliseconds per bar (`time`). - (trades): readonly Trade[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#forceIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const forceIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#forecastOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Forecast Oscillator: % distance of price from its time-series forecast (one bar ahead). ```typescript export declare const forecastOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#fractals Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bill Williams fractals: a 5-bar swing (strength 2). ```typescript export declare function fractals(bars: ArrayLike): Fractals; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.strength: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.down: SwingPoint[]; default: not declared - return.up: SwingPoint[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#fractionalChange Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fractional change: `(input[i] − input[i − period]) / input[i − period]`. ```typescript export declare const fractionalChange: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#frama Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const frama: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: FramaParameters | undefined; default: not declared - (parameters).period: number; default: not declared — Lookback (rounded up to an even number). Default 16. - explain: (input: ArrayLike, parameters?: FramaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: FramaParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared — Lookback (rounded up to an even number). Default 16. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: FramaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: FramaParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared — Lookback (rounded up to an even number). Default 16. ### @insiderfinance/totalfinance/technical-analysis#fwma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const fwma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#gannHighLowActivator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const gannHighLowActivator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, GannHiLoPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: GannHiLoPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => GannHiLoPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => GannHiLoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: GannHiLoPoint | null; default: not declared - fromJSON().return.value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - fromJSON().return.value.value: number; default: not declared — The active HiLo line. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => GannHiLoPoint | null; default: not declared - stream().return.peek: (input: BarInput) => GannHiLoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: GannHiLoPoint | null; default: not declared - stream().return.value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - stream().return.value.value: number; default: not declared — The active HiLo line. - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#gap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const gap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#gapFill Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opening gaps with fill tracking: the same events {@link gaps} detects, plus whether and when each one closed. A gap fills when a later bar trades back to the prior close. A gap requires the open to leave the prior bar's RANGE — above its high or below its low — which is the definition {@link gaps} uses and the only one that means anything on a real tape. This function previously fired on any open that merely differed from the prior close: on a 500-bar random walk with no true gaps, `gaps()` returned 0 events and this returned 499, one per bar. The two are now the same event universe, so `sizeFraction` and `minSizeFraction` mean the same thing in both and a caller can pair them. `minSizeFraction` filters small gaps as a FRACTION of the prior close (`0.005` = 0.5%), the same unit `sizeFraction` reports. Default 0 — every detected gap. ```typescript export declare function gapFill(bars: ArrayLike, options?: { minSizeFraction?: number; }): GapFillReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { minSizeFraction?: number; }; default: not declared - (options).minSizeFraction?: number; default: not declared - return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.minSizeFraction: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.events: GapFillEvent[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#gaps Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opening gaps: this bar's open leaves the prior bar's RANGE (above its high or below its low). `sizeFraction` is measured from the prior CLOSE — the level a fill has to trade back to — and `minSizeFraction` filters in that same unit (`0.005` = 0.5%). {@link gapFill} detects exactly these events and adds fill tracking. ```typescript export declare function gaps(bars: ArrayLike, options?: { minSizeFraction?: number; }): GapsReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { minSizeFraction?: number; }; default: not declared - (options).minSizeFraction?: number; default: not declared - return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.minSizeFraction: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.gaps: Gap[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#garmanKlass Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const garmanKlass: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RangeVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RangeVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RangeVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#getIndicator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The registered entry for `name`, or `undefined`. The result is DEEPLY FROZEN. It is a view of the registry, not a copy to edit: mutating it used to reach the facade's own validation allowlist. ```typescript export declare function getIndicator(name: string): Readonly | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared - return.category: IndicatorCategory; default: not declared - return.conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - return.defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - return.indicator: AnyIndicator; default: not declared - return.indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - return.indicator.fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - return.indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - return.inputs: IndicatorInputs; default: not declared - return.name: string; default: not declared - return.output: IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - return.parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). ### @insiderfinance/totalfinance/technical-analysis#gt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function gt(left: Operand, right: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (left): Operand; default: not declared - (right): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#gte Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function gte(left: Operand, right: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (left): Operand; default: not declared - (right): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#hasIndicator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function hasIndicator(name: string): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#heikinAshi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const heikinAshi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: HeikinAshiBar[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => HeikinAshiBar | null; default: not declared - fromJSON().return.peek: (input: BarInput) => HeikinAshiBar | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: HeikinAshiBar | null; default: not declared - fromJSON().return.value.close: number; default: not declared - fromJSON().return.value.high: number; default: not declared - fromJSON().return.value.low: number; default: not declared - fromJSON().return.value.open: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => HeikinAshiBar | null; default: not declared - stream().return.peek: (input: BarInput) => HeikinAshiBar | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: HeikinAshiBar | null; default: not declared - stream().return.value.close: number; default: not declared - stream().return.value.high: number; default: not declared - stream().return.value.low: number; default: not declared - stream().return.value.open: number; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#highestBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bars-ago of the rolling window high (alias of `rollingMaxIndex`). ```typescript export declare const highestBars: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#historicalVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const historicalVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: HistoricalVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: HistoricalVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: HistoricalVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#hl2 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). (high + low) / 2 — alias of `medianPrice`. ```typescript export declare const hl2: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: {} | undefined; default: not declared - explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: {} | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: {} | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#hlc3 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). (high + low + close) / 3 — alias of `typicalPrice`. ```typescript export declare const hlc3: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: {} | undefined; default: not declared - explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: {} | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: {} | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#hma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const hma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#holtWinterChannel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const holtWinterChannel: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: HoltWinterChannelParameters | undefined; default: not declared - (parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - (parameters).levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - (parameters).scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - (parameters).trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - (parameters).varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. - explain: (input: ArrayLike, parameters?: HoltWinterChannelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: HoltWinterChannelParameters | undefined; default: not declared - explain(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - explain(parameters).levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - explain(parameters).scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - explain(parameters).trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - explain(parameters).varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => ChannelPoint | null; default: not declared - fromJSON().return.peek: (input: number) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: HoltWinterChannelParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => ChannelPoint | null; default: not declared - stream().return.peek: (input: number) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChannelPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: HoltWinterChannelParameters | undefined; default: not declared - stream(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing. Default 0.1. - stream(parameters).levelSmoothing?: number; default: not declared — Level smoothing. Default 0.2. - stream(parameters).scalar?: number; default: not declared — Standard-deviation multiplier for the bands. Default 1. - stream(parameters).trendSmoothing?: number; default: not declared — Trend smoothing. Default 0.1. - stream(parameters).varianceSmoothing?: number; default: not declared — Variance smoothing for the channel width. Default 0.1. ### @insiderfinance/totalfinance/technical-analysis#holtWinterMovingAverage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const holtWinterMovingAverage: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: HwmaParameters | undefined; default: not declared - (parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - (parameters).levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - (parameters).trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. - explain: (input: ArrayLike, parameters?: HwmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: HwmaParameters | undefined; default: not declared - explain(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - explain(parameters).levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - explain(parameters).trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: HwmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: HwmaParameters | undefined; default: not declared - stream(parameters).accelerationSmoothing?: number; default: not declared — Acceleration smoothing (accelerationSmoothing). Default 0.1. - stream(parameters).levelSmoothing?: number; default: not declared — Level smoothing (levelSmoothing). Default 0.2. - stream(parameters).trendSmoothing?: number; default: not declared — Trend smoothing (trendSmoothing). Default 0.1. ### @insiderfinance/totalfinance/technical-analysis#htDcPeriod Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const htDcPeriod: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#htDcPhase Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const htDcPhase: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#htPhasor Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const htPhasor: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: PhasorPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => PhasorPoint | null; default: not declared - fromJSON().return.peek: (input: number) => PhasorPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PhasorPoint | null; default: not declared - fromJSON().return.value.inPhase: number; default: not declared - fromJSON().return.value.quadrature: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => PhasorPoint | null; default: not declared - stream().return.peek: (input: number) => PhasorPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: PhasorPoint | null; default: not declared - stream().return.value.inPhase: number; default: not declared - stream().return.value.quadrature: number; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#htSine Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const htSine: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: SinePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => SinePoint | null; default: not declared - fromJSON().return.peek: (input: number) => SinePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SinePoint | null; default: not declared - fromJSON().return.value.leadSine: number; default: not declared - fromJSON().return.value.sine: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => SinePoint | null; default: not declared - stream().return.peek: (input: number) => SinePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: SinePoint | null; default: not declared - stream().return.value.leadSine: number; default: not declared - stream().return.value.sine: number; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#htTrendMode Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const htTrendMode: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#htTrendline Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const htTrendline: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ichimoku Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ichimoku: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: IchimokuParameters | undefined; default: not declared - (parameters).base?: number; default: not declared - (parameters).conversion?: number; default: not declared - (parameters).displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - (parameters).spanB?: number; default: not declared - explain: (input: ArrayLike, parameters?: IchimokuParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: IchimokuPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: IchimokuParameters | undefined; default: not declared - explain(parameters).base?: number; default: not declared - explain(parameters).conversion?: number; default: not declared - explain(parameters).displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - explain(parameters).spanB?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => IchimokuPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => IchimokuPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: IchimokuPoint | null; default: not declared - fromJSON().return.value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - fromJSON().return.value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - fromJSON().return.value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - fromJSON().return.value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - fromJSON().return.value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - fromJSON().return.value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: IchimokuParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => IchimokuPoint | null; default: not declared - stream().return.peek: (input: BarInput) => IchimokuPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: IchimokuPoint | null; default: not declared - stream().return.value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - stream().return.value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - stream().return.value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - stream().return.value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - stream().return.value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - stream().return.value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - stream(parameters)?: IchimokuParameters | undefined; default: not declared - stream(parameters).base?: number; default: not declared - stream(parameters).conversion?: number; default: not declared - stream(parameters).displacement?: number; default: not declared — Plotting displacement in bars (default 26). Echoed on each point as `displacement`; the component values themselves are NOT shifted (see `IchimokuPoint`). - stream(parameters).spanB?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#imbalanceBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Tick imbalance bars — close on `|Σ sign(Δclose)|`. ```typescript export declare function imbalanceBars(bars: ArrayLike, parameters: InformationBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): InformationBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#increasing Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 when the series is higher than `period` bars ago (strict → every step rose). ```typescript export declare const increasing: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: TrendTestParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - (parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - explain: (input: ArrayLike, parameters?: TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: TrendTestParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - explain(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: TrendTestParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: TrendTestParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback (compare against the value `period` bars ago). Default 1. - stream(parameters).strict?: boolean; default: not declared — Require every step in the window to move the same way (default false → just endpoints). ### @insiderfinance/totalfinance/technical-analysis#indicatorCategories Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function indicatorCategories(): IndicatorCategory[]; ``` ### @insiderfinance/totalfinance/technical-analysis#indicatorWarmup Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The warmup of a SINGLE indicator (alias-aware name), measured on a probe series — the targeted counterpart to {@link indicatorWarmups} for a `describe`-style lookup that shouldn't probe all 335. ```typescript export declare function indicatorWarmup(name: string, probeLength?: number): WarmupMetadata; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared - (probeLength)?: number; default: not declared - return.category: IndicatorCategory; default: not declared - return.inputs: IndicatorInputs; default: not declared - return.name: string; default: not declared - return.parameters: Record; default: not declared — The canonical parameters used to measure the warmup. - return.warmup: number | null; default: not declared — Leading bars before the first real value, or `null` if it never emitted within the probe. ### @insiderfinance/totalfinance/technical-analysis#indicatorWarmups Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Measure the warmup of every registered indicator at canonical parameters. `probeLength` must exceed the longest warmup (default 512 comfortably covers the catalog). ```typescript export declare function indicatorWarmups(probeLength?: number): WarmupMetadata[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (probeLength)?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#inertia Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const inertia: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: InertiaParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - (parameters).rviPeriod?: number; default: not declared - explain: (input: ArrayLike, parameters?: InertiaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: InertiaParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).rviPeriod?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: InertiaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: InertiaParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).rviPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#jma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const jma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: JmaParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - (parameters).power?: number; default: not declared — Smoothing power on β (default 1). - explain: (input: ArrayLike, parameters?: JmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: JmaParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - explain(parameters).power?: number; default: not declared — Smoothing power on β (default 1). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: JmaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: JmaParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).phase?: number; default: not declared — Lag/overshoot trade-off, −100…100 (default 0). - stream(parameters).power?: number; default: not declared — Smoothing power on β (default 1). ### @insiderfinance/totalfinance/technical-analysis#kagi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function kagi(bars: ArrayLike, parameters: KagiParameters): KagiSegment[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): KagiParameters; default: not declared - (parameters).percent?: boolean; default: not declared - (parameters).reversal: number; default: not declared — Reversal amount. Absolute price by default, or a percent of price if `percent` is true. ### @insiderfinance/totalfinance/technical-analysis#kama Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const kama: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: KamaParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared — Fast EMA constant period. Default 2. - (parameters).period: number; default: not declared - (parameters).slow?: number; default: not declared — Slow EMA constant period. Default 30. - explain: (input: ArrayLike, parameters?: KamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: KamaParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared — Fast EMA constant period. Default 2. - explain(parameters).period: number; default: not declared - explain(parameters).slow?: number; default: not declared — Slow EMA constant period. Default 30. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: KamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: KamaParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared — Fast EMA constant period. Default 2. - stream(parameters).period: number; default: not declared - stream(parameters).slow?: number; default: not declared — Slow EMA constant period. Default 30. ### @insiderfinance/totalfinance/technical-analysis#kdj Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const kdj: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: KdjParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - (parameters).signal?: number; default: not declared - explain: (input: ArrayLike, parameters?: KdjParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: KdjPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: KdjParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).signal?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => KdjPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => KdjPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KdjPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.j: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: KdjParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => KdjPoint | null; default: not declared - stream().return.peek: (input: BarInput) => KdjPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: KdjPoint | null; default: not declared - stream().return.value.d: number; default: not declared - stream().return.value.j: number; default: not declared - stream().return.value.k: number; default: not declared - stream(parameters)?: KdjParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#keltner Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const keltner: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: KeltnerParameters | undefined; default: not declared - (parameters).atrPeriod?: number; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: KeltnerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ChannelPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: KeltnerParameters | undefined; default: not declared - explain(parameters).atrPeriod?: number; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: KeltnerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ChannelPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ChannelPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ChannelPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.middle: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: KeltnerParameters | undefined; default: not declared - stream(parameters).atrPeriod?: number; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period?: number; default: not declared — EMA midline lookback. Defaults to 20 (the standard Keltner channel); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#klinger Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const klinger: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: KlingerParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).signal?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: KlingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: KlingerParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => KlingerPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KlingerPoint | null; default: not declared - fromJSON().return.value.klinger: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => KlingerPoint | null; default: not declared - stream().return.peek: (input: BarInput) => KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: KlingerPoint | null; default: not declared - stream().return.value.klinger: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: KlingerParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#kst Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const kst: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: KstParameters | undefined; default: not declared - (parameters).rocPeriods?: [number, number, number, number]; default: not declared - (parameters).signal?: number; default: not declared - (parameters).smaPeriods?: [number, number, number, number]; default: not declared - explain: (input: ArrayLike, parameters?: KstParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: KstPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: KstParameters | undefined; default: not declared - explain(parameters).rocPeriods?: [number, number, number, number]; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).smaPeriods?: [number, number, number, number]; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => KstPoint | null; default: not declared - fromJSON().return.peek: (input: number) => KstPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KstPoint | null; default: not declared - fromJSON().return.value.kst: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: KstParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => KstPoint | null; default: not declared - stream().return.peek: (input: number) => KstPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: KstPoint | null; default: not declared - stream().return.value.kst: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: KstParameters | undefined; default: not declared - stream(parameters).rocPeriods?: [number, number, number, number]; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).smaPeriods?: [number, number, number, number]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#kurtosis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling sample excess kurtosis (bias-corrected G2). ```typescript export declare const kurtosis: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#kvo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Klinger Volume Oscillator (alias of `klinger`). ```typescript export declare const kvo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).signal?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - fromJSON().return.value.klinger: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - stream().return.peek: (input: BarInput) => import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: import('@insiderfinance/totalfinance/technical-analysis').KlingerPoint | null; default: not declared - stream().return.value.klinger: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').KlingerParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#lag Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Alias of `shift` (causal lag; leading is not possible in a streaming model). ```typescript export declare const lag: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#laguerreRsi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const laguerreRsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: LaguerreParameters | undefined; default: not declared - (parameters).gamma?: number; default: not declared - explain: (input: ArrayLike, parameters?: LaguerreParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: LaguerreParameters | undefined; default: not declared - explain(parameters).gamma?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: LaguerreParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: LaguerreParameters | undefined; default: not declared - stream(parameters).gamma?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#lineAt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate a fitted line (price = intercept + slope·index) at a bar index. ```typescript export declare function lineAt(line: Line, index: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (index): number; default: not declared - (line): Line; default: not declared - (line).from: number; default: not declared - (line).intercept: number; default: not declared - (line).slope: number; default: not declared - (line).to: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#lineBreak Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function lineBreak(bars: ArrayLike, parameters?: LineBreakParameters): LineBreakBar[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters)?: LineBreakParameters; default: not declared - (parameters).lines?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#linearDecay Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Linear decay floor — the series may rise freely but falls no faster than `1/period` per bar. ```typescript export declare const linearDecay: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#linreg Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const linreg: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: LinregPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => LinregPoint | null; default: not declared - fromJSON().return.peek: (input: number) => LinregPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: LinregPoint | null; default: not declared - fromJSON().return.value.angle: number; default: not declared - fromJSON().return.value.forecast: number; default: not declared - fromJSON().return.value.intercept: number; default: not declared - fromJSON().return.value.slope: number; default: not declared - fromJSON().return.value.value: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => LinregPoint | null; default: not declared - stream().return.peek: (input: number) => LinregPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: LinregPoint | null; default: not declared - stream().return.value.angle: number; default: not declared - stream().return.value.forecast: number; default: not declared - stream().return.value.intercept: number; default: not declared - stream().return.value.slope: number; default: not declared - stream().return.value.value: number; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#linregAngle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const linregAngle: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#linregIntercept Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const linregIntercept: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#linregSlope Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const linregSlope: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#liquiditySweeps Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const liquiditySweeps: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: LiquiditySweepParameters | undefined; default: not declared - (parameters).lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. - explain: (input: ArrayLike, parameters?: LiquiditySweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: LiquiditySweepPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: LiquiditySweepParameters | undefined; default: not declared - explain(parameters).lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => LiquiditySweepPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => LiquiditySweepPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: LiquiditySweepPoint | null; default: not declared - fromJSON().return.value.direction: number; default: not declared — +1 buy-side sweep (high taken then rejected), −1 sell-side, 0 none. - fromJSON().return.value.level: number; default: not declared — The swept liquidity level (the prior-window extreme), NaN when none. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: LiquiditySweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => LiquiditySweepPoint | null; default: not declared - stream().return.peek: (input: BarInput) => LiquiditySweepPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: LiquiditySweepPoint | null; default: not declared - stream().return.value.direction: number; default: not declared — +1 buy-side sweep (high taken then rejected), −1 sell-side, 0 none. - stream().return.value.level: number; default: not declared — The swept liquidity level (the prior-window extreme), NaN when none. - stream(parameters)?: LiquiditySweepParameters | undefined; default: not declared - stream(parameters).lookback?: number; default: not declared — Rolling window of prior bars whose extreme defines the liquidity level. Default 20. ### @insiderfinance/totalfinance/technical-analysis#listIndicators Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every registered indicator (optionally one category). The ARRAY is fresh; the entries are frozen. ```typescript export declare function listIndicators(category?: IndicatorCategory): Readonly[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (category)?: IndicatorCategory | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ln Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ln: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#log10 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const log10: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#logReturns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const logReturns: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#longRun Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 when fast (`x`) and slow (`y`) are both rising over the lookback — a confirmed up-run. ```typescript export declare const longRun: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, Pair, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#lowerShadow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const lowerShadow: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#lowestBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bars-ago of the rolling window low (alias of `rollingMinIndex`). ```typescript export declare const lowestBars: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#lt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function lt(left: Operand, right: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (left): Operand; default: not declared - (right): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#lte Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function lte(left: Operand, right: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (left): Operand; default: not declared - (right): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#macd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const macd: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MacdParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).signal?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: MacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MacdParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => MacdPoint | null; default: not declared - fromJSON().return.peek: (input: number) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => MacdPoint | null; default: not declared - stream().return.peek: (input: number) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MacdPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.macd: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: MacdParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#macdExt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const macdExt: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MacdExtParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).fastMovingAverageType?: MovingAverageType; default: not declared - (parameters).signal?: number; default: not declared - (parameters).signalMovingAverageType?: MovingAverageType; default: not declared - (parameters).slow?: number; default: not declared - (parameters).slowMovingAverageType?: MovingAverageType; default: not declared - explain: (input: ArrayLike, parameters?: MacdExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MacdExtParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).fastMovingAverageType?: MovingAverageType; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).signalMovingAverageType?: MovingAverageType; default: not declared - explain(parameters).slow?: number; default: not declared - explain(parameters).slowMovingAverageType?: MovingAverageType; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => MacdPoint | null; default: not declared - fromJSON().return.peek: (input: number) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MacdExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => MacdPoint | null; default: not declared - stream().return.peek: (input: number) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MacdPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.macd: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: MacdExtParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).fastMovingAverageType?: MovingAverageType; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).signalMovingAverageType?: MovingAverageType; default: not declared - stream(parameters).slow?: number; default: not declared - stream(parameters).slowMovingAverageType?: MovingAverageType; default: not declared ### @insiderfinance/totalfinance/technical-analysis#macdFix Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). MACDFIX — fixed 12/26 EMA MACD with a configurable signal period (TA-Lib MACDFIX). ```typescript export declare const macdFix: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MacdFixParameters | undefined; default: not declared - (parameters).signal?: number; default: not declared - explain: (input: ArrayLike, parameters?: MacdFixParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MacdFixParameters | undefined; default: not declared - explain(parameters).signal?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => MacdPoint | null; default: not declared - fromJSON().return.peek: (input: number) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MacdFixParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => MacdPoint | null; default: not declared - stream().return.peek: (input: number) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MacdPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.macd: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: MacdFixParameters | undefined; default: not declared - stream(parameters).signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#mama Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const mama: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MamaParameters | undefined; default: not declared - (parameters).fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - (parameters).slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. - explain: (input: ArrayLike, parameters?: MamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MamaPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MamaParameters | undefined; default: not declared - explain(parameters).fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - explain(parameters).slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => MamaPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => MamaPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MamaPoint | null; default: not declared - fromJSON().return.value.fama: number; default: not declared - fromJSON().return.value.mama: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MamaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => MamaPoint | null; default: not declared - stream().return.peek: (input: BarInput) => MamaPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MamaPoint | null; default: not declared - stream().return.value.fama: number; default: not declared - stream().return.value.mama: number; default: not declared - stream(parameters)?: MamaParameters | undefined; default: not declared - stream(parameters).fastLimit?: number; default: not declared — Fast adaptation limit. Default 0.5. - stream(parameters).slowLimit?: number; default: not declared — Slow adaptation limit. Default 0.05. ### @insiderfinance/totalfinance/technical-analysis#marketFacilitationIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bill Williams Market Facilitation Index — (high − low) / volume. ```typescript export declare const marketFacilitationIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#marketStructure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Label the swing sequence (HH/HL/LH/LL) and flag breaks of structure. A higher-high while already bullish is a continuation (BOS); a higher-high that reverses a bearish run is a change of character (CHoCH), and symmetrically for lower-lows. The first swing high and the first swing low carry `label: null` — a label is a comparison with the previous swing of that kind, and there is none yet. ```typescript export declare function marketStructure(bars: ArrayLike, options?: { strength?: number; }): MarketStructure; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { strength?: number; }; default: not declared - (options).strength?: number; default: not declared - return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.strength: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.events: StructureEvent[]; default: not declared - return.swings: LabeledSwing[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#massIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const massIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MassIndexParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - (parameters).slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. - explain: (input: ArrayLike, parameters?: MassIndexParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MassIndexParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - explain(parameters).slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MassIndexParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: MassIndexParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared — EMA length for the high−low range and its re-smoothing. Default 9. - stream(parameters).slow?: number; default: not declared — Summation window for the EMA ratio. Default 25. ### @insiderfinance/totalfinance/technical-analysis#mavp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function mavp(input: MavpInput): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): MavpInput; default: not declared - (input).parameters?: MavpParameters; default: not declared - (input).periods: ArrayLike; default: not declared - (input).series: ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#mcginley Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const mcginley: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#medianPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const medianPrice: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#mfi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const mfi: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#microprice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain microprice; use `.explain()` for null/fallback diagnostics. ```typescript export declare const microprice: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OrderBook; default: not declared - (input).asks: readonly BookLevel[]; default: not declared - (input).bids: readonly BookLevel[]; default: not declared - explain: (input: OrderBook) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): OrderBook; default: not declared - explain(input).asks: readonly BookLevel[]; default: not declared - explain(input).bids: readonly BookLevel[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#midpoint Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const midpoint: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#midprice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const midprice: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#minusDI Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const minusDI: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#minusDM Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const minusDM: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#momentum Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const momentum: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RocParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RocParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RocParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#movingAverage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const movingAverage: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MovingAverageParameters | undefined; default: not declared - (parameters).movingAverageType?: MovingAverageName; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: MovingAverageParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MovingAverageParameters | undefined; default: not declared - explain(parameters).movingAverageType?: MovingAverageName; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MovingAverageParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: MovingAverageParameters | undefined; default: not declared - stream(parameters).movingAverageType?: MovingAverageName; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#movingAverageRibbon Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const movingAverageRibbon: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MovingAverageRibbonParameters | undefined; default: not declared - (parameters).periods?: number[]; default: not declared - explain: (input: ArrayLike, parameters?: MovingAverageRibbonParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[][]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MovingAverageRibbonParameters | undefined; default: not declared - explain(parameters).periods?: number[]; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number[] | null; default: not declared - fromJSON().return.peek: (input: number) => number[] | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number[] | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MovingAverageRibbonParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number[] | null; default: not declared - stream().return.peek: (input: number) => number[] | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number[] | null; default: not declared - stream(parameters)?: MovingAverageRibbonParameters | undefined; default: not declared - stream(parameters).periods?: number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#msw Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Mesa Sine Wave (pandas-ta/tulipy `msw`). ```typescript export declare const msw: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: MswParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: MswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MswPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: MswParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => MswPoint | null; default: not declared - fromJSON().return.peek: (input: number) => MswPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MswPoint | null; default: not declared - fromJSON().return.value.lead: number; default: not declared - fromJSON().return.value.sine: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: MswParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => MswPoint | null; default: not declared - stream().return.peek: (input: number) => MswPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MswPoint | null; default: not declared - stream().return.value.lead: number; default: not declared - stream().return.value.sine: number; default: not declared - stream(parameters)?: MswParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#mult Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const mult: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#natr Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const natr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#normalize Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling min-max normalization to [0, 1] (0.5 on a flat window). ```typescript export declare const normalize: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#not Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Logical negation of a condition (carries through the inner condition's refs). ```typescript export declare function not(condition: Condition): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (condition): Condition; default: not declared - (condition).refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#nvi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const nvi: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#obv Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const obv: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ talib?: boolean; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { talib?: boolean; } | undefined; default: not declared - (parameters).talib?: boolean; default: not declared - explain: (input: ArrayLike, parameters?: { talib?: boolean; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { talib?: boolean; } | undefined; default: not declared - explain(parameters).talib?: boolean; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { talib?: boolean; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { talib?: boolean; } | undefined; default: not declared - stream(parameters).talib?: boolean; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ohlc4 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). (open + high + low + close) / 4 — alias of `averagePrice`. ```typescript export declare const ohlc4: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: {} | undefined; default: not declared - explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: {} | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: {} | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ohlcvFromBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Explicitly project core Bar records to OHLCV indicator rows. Source identity, timestamps, adjustment flags and caller provenance remain in the original records: retain them alongside the calculation. This adapter neither fetches nor relabels observations. Prices may be negative where the instrument permits; finite values and OHLC range relationships are validated. A source series must contain one symbol in strictly increasing timestamp order; no sorting or deduplication is performed before identity/time are projected away. ```typescript export declare function ohlcvFromBars(bars: readonly Bar[]): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): readonly Bar[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#openingRange Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). High/low of the first `periods` bars — the opening range. ```typescript export declare function openingRange(bars: ArrayLike, options: OpeningRangeParameters): OpeningRange; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options): OpeningRangeParameters; default: not declared - (options).periods: number; default: not declared - return.assumptions: { conventionsVersion: string; periods: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.periods: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.high: number; default: not declared - return.low: number; default: not declared - return.mid: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#openingRangeBreakout Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opening-range breakout signal aligned to the input: `0` within the opening range, then `+1` on the first close above the range high, `−1` below the range low (NaN for the opening-range bars). ```typescript export declare function openingRangeBreakout(bars: ArrayLike, options: OpeningRangeParameters): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options): OpeningRangeParameters; default: not declared - (options).periods: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#orbRetest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Opening-range retest aligned to the input: after a close breaks the range, `+1` on the first bar that pulls back to touch the range high (a retest of an up-breakout), `−1` for a retest of the range low. A new breakout in a direction re-arms that side; NaN during the opening range. ```typescript export declare function orbRetest(bars: ArrayLike, options: OpeningRangeParameters): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options): OpeningRangeParameters; default: not declared - (options).periods: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#orderBlocks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const orderBlocks: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: OrderBlockParameters | undefined; default: not declared - (parameters).lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. - explain: (input: ArrayLike, parameters?: OrderBlockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ZonePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: OrderBlockParameters | undefined; default: not declared - explain(parameters).lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ZonePoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ZonePoint | null; default: not declared - fromJSON().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - fromJSON().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - fromJSON().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - fromJSON().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: OrderBlockParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ZonePoint | null; default: not declared - stream().return.peek: (input: BarInput) => ZonePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ZonePoint | null; default: not declared - stream().return.value.bottom: number; default: not declared — Lower bound of the zone (NaN when none). - stream().return.value.direction: number; default: not declared — +1 bullish, −1 bearish, 0 none. - stream().return.value.mid: number; default: not declared — Zone midpoint (NaN when none). - stream().return.value.top: number; default: not declared — Upper bound of the zone (NaN when none). - stream(parameters)?: OrderBlockParameters | undefined; default: not declared - stream(parameters).lookback?: number; default: not declared — How many bars an origin candle stays eligible to be broken. Default 5. ### @insiderfinance/totalfinance/technical-analysis#orderBookImbalance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain single-level imbalance; use `.explain()` for zero-depth diagnostics. ```typescript export declare const orderBookImbalance: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OrderBookLevel; default: not declared - (input).askSize: number; default: not declared - (input).bidSize: number; default: not declared - explain: (input: OrderBookLevel) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): OrderBookLevel; default: not declared - explain(input).askSize: number; default: not declared - explain(input).bidSize: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pMax Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const pMax: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PmaxParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: PmaxParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: PmaxPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PmaxParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => PmaxPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => PmaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PmaxPoint | null; default: not declared - fromJSON().return.value.pmax: number; default: not declared — The trailing stop line. - fromJSON().return.value.trend: number; default: not declared — +1 long (MA above the stop), −1 short. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PmaxParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => PmaxPoint | null; default: not declared - stream().return.peek: (input: BarInput) => PmaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: PmaxPoint | null; default: not declared - stream().return.value.pmax: number; default: not declared — The trailing stop line. - stream().return.value.trend: number; default: not declared — +1 long (MA above the stop), −1 short. - stream(parameters)?: PmaxParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pairs Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Zip two equal-length series into the `Pair[]` that `beta` / `correl` consume. Throws on a length mismatch — silent truncation would mask a benchmark/asset alignment bug. ```typescript export declare function pairs(x: ArrayLike, y: ArrayLike): Pair[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (x): ArrayLike; default: not declared - (y): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#parkinson Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const parkinson: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RangeVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RangeVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RangeVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pascalWma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const pascalWma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#percentAtr Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ATR as a percent of close (a.k.a. ATRP). ```typescript export declare const percentAtr: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#percentRank Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling percentile position of the current value within the window, in [0, 100]. ```typescript export declare const percentRank: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pgo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const pgo: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pivots Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Pivot levels for the next period from a prior period's OHLC. ```typescript export declare function pivots(bar: BarInput, method?: PivotMethod): PivotLevels; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bar): BarInput; default: not declared - (bar).close: number; default: not declared - (bar).high: number; default: not declared - (bar).low: number; default: not declared - (bar).open?: number; default: not declared - (bar).volume?: number; default: not declared - (method)?: PivotMethod; default: not declared - return.assumptions: { conventionsVersion: string; method: PivotMethod; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: PivotMethod; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.pivot: number; default: not declared - return.resistance: number[]; default: not declared - return.support: number[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#plusDI Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const plusDI: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#plusDM Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const plusDM: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WilderPeriodParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WilderPeriodParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WilderPeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WilderPeriodParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 for ATR, ADX, ADXR and the DMI family (universal); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#pointAndFigure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function pointAndFigure(bars: ArrayLike, parameters: PnfParameters): PnfColumn[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): PnfParameters; default: not declared - (parameters).boxSize: number; default: not declared - (parameters).reversal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ppo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ppo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PpoParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).signal?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: PpoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: PpoPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PpoParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => PpoPoint | null; default: not declared - fromJSON().return.peek: (input: number) => PpoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PpoPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.ppo: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PpoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => PpoPoint | null; default: not declared - stream().return.peek: (input: number) => PpoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: PpoPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.ppo: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: PpoParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#previousSessionLevels Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). For each bar, the high/low/close of the PRIOR session (the fully-completed session before the bar's own). `sessionIds[i]` groups bars (bars carry no timestamp, so the caller supplies the grouping — pass day ids for "previous day high/low", week ids for "previous week high/low"). Bars in the first session get NaN levels. ```typescript export declare function previousSessionLevels(bars: ArrayLike, sessionIds: ArrayLike): (PriorSessionLevel | null)[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (sessionIds): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#priceAction Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price-action group: swings, structure, ranges, and level detection. ```typescript export declare const priceAction: { readonly breakouts: (bars: ArrayLike, options?: { lookback?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').BreakoutsReport; readonly channel: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; readonly fibExtension: (input: import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; readonly fibRetracement: (start: number, end: number, levels?: readonly number[]) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; readonly fractals: (bars: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis/price-action').Fractals; readonly gapFill: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapFillReport; readonly gaps: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapsReport; readonly lineAt: (line: import('@insiderfinance/totalfinance/technical-analysis').Line, index: number) => number; readonly marketStructure: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').MarketStructure; readonly openingRange: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => import('@insiderfinance/totalfinance/technical-analysis').OpeningRange; readonly openingRangeBreakout: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; readonly orbRetest: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; readonly pivots: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, method?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod) => import('@insiderfinance/totalfinance/technical-analysis').PivotLevels; readonly previousSessionLevels: (bars: ArrayLike, sessionIds: ArrayLike) => (import('@insiderfinance/totalfinance/technical-analysis').PriorSessionLevel | null)[]; readonly sessionRanges: (bars: ArrayLike, sessionIds: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').SessionRange[]; readonly supportResistance: (bars: ArrayLike, options?: { strength?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').SupportResistance; readonly swings: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').Swings; readonly trendlines: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - breakouts: (bars: ArrayLike, options?: { lookback?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').BreakoutsReport; default: not declared - breakouts().return.assumptions: { conventionsVersion: string; lookback: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - breakouts().return.assumptions.conventionsVersion: string; default: not declared - breakouts().return.assumptions.lookback: number; default: not declared - breakouts().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - breakouts().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - breakouts().return.signal: (number | null)[]; default: not declared — Aligned to the input: `+1` when the close exceeds the highest high of the prior `lookback` bars, `−1` below the lowest low, `0` otherwise — `null` during the lookback warmup. - breakouts(bars): ArrayLike; default: not declared - breakouts(options)?: { lookback?: number; }; default: not declared - breakouts(options).lookback?: number; default: not declared - channel: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; default: not declared - channel().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - channel().return.assumptions.conventionsVersion: string; default: not declared - channel().return.assumptions.strength: number; default: not declared - channel().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - channel().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - channel().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - channel().return.resistance.from: number; default: not declared - channel().return.resistance.intercept: number; default: not declared - channel().return.resistance.slope: number; default: not declared - channel().return.resistance.to: number; default: not declared - channel().return.support: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - channel().return.support.from: number; default: not declared - channel().return.support.intercept: number; default: not declared - channel().return.support.slope: number; default: not declared - channel().return.support.to: number; default: not declared - channel(bars): ArrayLike; default: not declared - channel(options)?: { strength?: number; }; default: not declared - channel(options).strength?: number; default: not declared - fibExtension: (input: import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; default: not declared - fibExtension(input): import('@insiderfinance/totalfinance/technical-analysis/price-action').FibExtensionInput; default: not declared - fibExtension(input).end: number; default: not declared - fibExtension(input).levels?: readonly number[]; default: not declared - fibExtension(input).projectFrom: number; default: not declared - fibExtension(input).start: number; default: not declared - fibRetracement: (start: number, end: number, levels?: readonly number[]) => import('@insiderfinance/totalfinance/technical-analysis').FibLevel[]; default: not declared - fibRetracement(end): number; default: not declared - fibRetracement(levels)?: readonly number[]; default: not declared - fibRetracement(start): number; default: not declared - fractals: (bars: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis/price-action').Fractals; default: not declared - fractals().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - fractals().return.assumptions.conventionsVersion: string; default: not declared - fractals().return.assumptions.strength: number; default: not declared - fractals().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - fractals().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - fractals().return.down: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - fractals().return.up: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - fractals(bars): ArrayLike; default: not declared - gapFill: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapFillReport; default: not declared - gapFill().return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - gapFill().return.assumptions.conventionsVersion: string; default: not declared - gapFill().return.assumptions.minSizeFraction: number; default: not declared - gapFill().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - gapFill().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - gapFill().return.events: import('@insiderfinance/totalfinance/technical-analysis').GapFillEvent[]; default: not declared - gapFill(bars): ArrayLike; default: not declared - gapFill(options)?: { minSizeFraction?: number; }; default: not declared - gapFill(options).minSizeFraction?: number; default: not declared - gaps: (bars: ArrayLike, options?: { minSizeFraction?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').GapsReport; default: not declared - gaps().return.assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - gaps().return.assumptions.conventionsVersion: string; default: not declared - gaps().return.assumptions.minSizeFraction: number; default: not declared - gaps().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - gaps().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - gaps().return.gaps: import('@insiderfinance/totalfinance/technical-analysis').Gap[]; default: not declared - gaps(bars): ArrayLike; default: not declared - gaps(options)?: { minSizeFraction?: number; }; default: not declared - gaps(options).minSizeFraction?: number; default: not declared - lineAt: (line: import('@insiderfinance/totalfinance/technical-analysis').Line, index: number) => number; default: not declared - lineAt(index): number; default: not declared - lineAt(line): import('@insiderfinance/totalfinance/technical-analysis').Line; default: not declared - lineAt(line).from: number; default: not declared - lineAt(line).intercept: number; default: not declared - lineAt(line).slope: number; default: not declared - lineAt(line).to: number; default: not declared - marketStructure: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').MarketStructure; default: not declared - marketStructure().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - marketStructure().return.assumptions.conventionsVersion: string; default: not declared - marketStructure().return.assumptions.strength: number; default: not declared - marketStructure().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - marketStructure().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - marketStructure().return.events: import('@insiderfinance/totalfinance/technical-analysis').StructureEvent[]; default: not declared - marketStructure().return.swings: import('@insiderfinance/totalfinance/technical-analysis').LabeledSwing[]; default: not declared - marketStructure(bars): ArrayLike; default: not declared - marketStructure(options)?: { strength?: number; }; default: not declared - marketStructure(options).strength?: number; default: not declared - openingRange: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => import('@insiderfinance/totalfinance/technical-analysis').OpeningRange; default: not declared - openingRange().return.assumptions: { conventionsVersion: string; periods: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - openingRange().return.assumptions.conventionsVersion: string; default: not declared - openingRange().return.assumptions.periods: number; default: not declared - openingRange().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - openingRange().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - openingRange().return.high: number; default: not declared - openingRange().return.low: number; default: not declared - openingRange().return.mid: number; default: not declared - openingRange(bars): ArrayLike; default: not declared - openingRange(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - openingRange(options).periods: number; default: not declared - openingRangeBreakout: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; default: not declared - openingRangeBreakout(bars): ArrayLike; default: not declared - openingRangeBreakout(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - openingRangeBreakout(options).periods: number; default: not declared - orbRetest: (bars: ArrayLike, options: import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters) => number[]; default: not declared - orbRetest(bars): ArrayLike; default: not declared - orbRetest(options): import('@insiderfinance/totalfinance/technical-analysis/price-action').OpeningRangeParameters; default: not declared - orbRetest(options).periods: number; default: not declared - pivots: (bar: import('@insiderfinance/totalfinance/technical-analysis').BarInput, method?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod) => import('@insiderfinance/totalfinance/technical-analysis').PivotLevels; default: not declared - pivots().return.assumptions: { conventionsVersion: string; method: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - pivots().return.assumptions.conventionsVersion: string; default: not declared - pivots().return.assumptions.method: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; default: not declared - pivots().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - pivots().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - pivots().return.pivot: number; default: not declared - pivots().return.resistance: number[]; default: not declared - pivots().return.support: number[]; default: not declared - pivots(bar): import('@insiderfinance/totalfinance/technical-analysis').BarInput; default: not declared - pivots(bar).close: number; default: not declared - pivots(bar).high: number; default: not declared - pivots(bar).low: number; default: not declared - pivots(bar).open?: number; default: not declared - pivots(bar).volume?: number; default: not declared - pivots(method)?: import('@insiderfinance/totalfinance/technical-analysis').PivotMethod; default: not declared - previousSessionLevels: (bars: ArrayLike, sessionIds: ArrayLike) => (import('@insiderfinance/totalfinance/technical-analysis').PriorSessionLevel | null)[]; default: not declared - previousSessionLevels(bars): ArrayLike; default: not declared - previousSessionLevels(sessionIds): ArrayLike; default: not declared - sessionRanges: (bars: ArrayLike, sessionIds: ArrayLike) => import('@insiderfinance/totalfinance/technical-analysis').SessionRange[]; default: not declared - sessionRanges(bars): ArrayLike; default: not declared - sessionRanges(sessionIds): ArrayLike; default: not declared - supportResistance: (bars: ArrayLike, options?: { strength?: number; tolerance?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').SupportResistance; default: not declared - supportResistance().return.assumptions: { conventionsVersion: string; strength: number; tolerance: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - supportResistance().return.assumptions.conventionsVersion: string; default: not declared - supportResistance().return.assumptions.strength: number; default: not declared - supportResistance().return.assumptions.tolerance: number; default: not declared - supportResistance().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - supportResistance().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - supportResistance().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').SrLevel[]; default: not declared - supportResistance().return.support: import('@insiderfinance/totalfinance/technical-analysis').SrLevel[]; default: not declared - supportResistance(bars): ArrayLike; default: not declared - supportResistance(options)?: { strength?: number; tolerance?: number; }; default: not declared - supportResistance(options).strength?: number; default: not declared - supportResistance(options).tolerance?: number; default: not declared - swings: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis').Swings; default: not declared - swings().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - swings().return.assumptions.conventionsVersion: string; default: not declared - swings().return.assumptions.strength: number; default: not declared - swings().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - swings().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - swings().return.highs: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - swings().return.lows: import('@insiderfinance/totalfinance/technical-analysis').SwingPoint[]; default: not declared - swings(bars): ArrayLike; default: not declared - swings(options)?: { strength?: number; }; default: not declared - swings(options).strength?: number; default: not declared - trendlines: (bars: ArrayLike, options?: { strength?: number; }) => import('@insiderfinance/totalfinance/technical-analysis/price-action').TrendlineChannel; default: not declared - trendlines().return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - trendlines().return.assumptions.conventionsVersion: string; default: not declared - trendlines().return.assumptions.strength: number; default: not declared - trendlines().return.diagnostics: { warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - trendlines().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - trendlines().return.resistance: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - trendlines().return.resistance.from: number; default: not declared - trendlines().return.resistance.intercept: number; default: not declared - trendlines().return.resistance.slope: number; default: not declared - trendlines().return.resistance.to: number; default: not declared - trendlines().return.support: import('@insiderfinance/totalfinance/technical-analysis').Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - trendlines().return.support.from: number; default: not declared - trendlines().return.support.intercept: number; default: not declared - trendlines().return.support.slope: number; default: not declared - trendlines().return.support.to: number; default: not declared - trendlines(bars): ArrayLike; default: not declared - trendlines(options)?: { strength?: number; }; default: not declared - trendlines(options).strength?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#priceDistance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price Distance — 2·(H−L) + |open − close[drift]| − |close − open|. ```typescript export declare const priceDistance: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ drift?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { drift?: number; } | undefined; default: not declared - (parameters).drift?: number; default: not declared - explain: (input: ArrayLike, parameters?: { drift?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { drift?: number; } | undefined; default: not declared - explain(parameters).drift?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { drift?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { drift?: number; } | undefined; default: not declared - stream(parameters).drift?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#priceVolume Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price · Volume — close × volume, optionally signed by the close-to-close direction. ```typescript export declare const priceVolume: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PriceVolumeParameters | undefined; default: not declared - (parameters).signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. - explain: (input: ArrayLike, parameters?: PriceVolumeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PriceVolumeParameters | undefined; default: not declared - explain(parameters).signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PriceVolumeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PriceVolumeParameters | undefined; default: not declared - stream(parameters).signed?: boolean; default: not declared — Multiply by the sign of the close-to-close change (needs a prior bar). Default false. ### @insiderfinance/totalfinance/technical-analysis#priceVolumeRank Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Price Volume Rank — 1: price↑ & volume↑, 2: price↑ & volume↓, 3: price↓ & volume↑, 4: price↓ & volume↓ (ties count as "down"). ```typescript export declare const priceVolumeRank: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#projectionOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const projectionOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, ProjectionPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ProjectionPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => ProjectionPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => ProjectionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ProjectionPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.po: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => ProjectionPoint | null; default: not declared - stream().return.peek: (input: BarInput) => ProjectionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: ProjectionPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.po: number; default: not declared - stream().return.value.upper: number; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#psar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const psar: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PsarParameters | undefined; default: not declared - (parameters).max?: number; default: not declared - (parameters).step?: number; default: not declared - explain: (input: ArrayLike, parameters?: PsarParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: PsarPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PsarParameters | undefined; default: not declared - explain(parameters).max?: number; default: not declared - explain(parameters).step?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => PsarPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => PsarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PsarPoint | null; default: not declared - fromJSON().return.value.sar: number; default: not declared - fromJSON().return.value.trend: number; default: not declared — +1 rising (long), −1 falling (short). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PsarParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => PsarPoint | null; default: not declared - stream().return.peek: (input: BarInput) => PsarPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: PsarPoint | null; default: not declared - stream().return.value.sar: number; default: not declared - stream().return.value.trend: number; default: not declared — +1 rising (long), −1 falling (short). - stream(parameters)?: PsarParameters | undefined; default: not declared - stream(parameters).max?: number; default: not declared - stream(parameters).step?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#psarExt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const psarExt: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PsarExtParameters | undefined; default: not declared - (parameters).accelInitLong?: number; default: not declared - (parameters).accelInitShort?: number; default: not declared - (parameters).accelLong?: number; default: not declared - (parameters).accelMaxLong?: number; default: not declared - (parameters).accelMaxShort?: number; default: not declared - (parameters).accelShort?: number; default: not declared - (parameters).offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - (parameters).startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. - explain: (input: ArrayLike, parameters?: PsarExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PsarExtParameters | undefined; default: not declared - explain(parameters).accelInitLong?: number; default: not declared - explain(parameters).accelInitShort?: number; default: not declared - explain(parameters).accelLong?: number; default: not declared - explain(parameters).accelMaxLong?: number; default: not declared - explain(parameters).accelMaxShort?: number; default: not declared - explain(parameters).accelShort?: number; default: not declared - explain(parameters).offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - explain(parameters).startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PsarExtParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PsarExtParameters | undefined; default: not declared - stream(parameters).accelInitLong?: number; default: not declared - stream(parameters).accelInitShort?: number; default: not declared - stream(parameters).accelLong?: number; default: not declared - stream(parameters).accelMaxLong?: number; default: not declared - stream(parameters).accelMaxShort?: number; default: not declared - stream(parameters).accelShort?: number; default: not declared - stream(parameters).offsetOnReverse?: number; default: not declared — Widen the SAR by this fraction of the extreme point on a reversal. Default 0. - stream(parameters).startValue?: number; default: not declared — Force the initial direction: >0 long, <0 short, 0 auto. Default 0. ### @insiderfinance/totalfinance/technical-analysis#psychologicalLine Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const psychologicalLine: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pvi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const pvi: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pvo Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const pvo: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PvoParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).signal?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: PvoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: PvoPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PvoParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => PvoPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => PvoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PvoPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.pvo: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PvoParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => PvoPoint | null; default: not declared - stream().return.peek: (input: BarInput) => PvoPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: PvoPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.pvo: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: PvoParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#pvt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const pvt: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#qqe Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const qqe: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: QqeParameters | undefined; default: not declared - (parameters).factor?: number; default: not declared - (parameters).rsiPeriod?: number; default: not declared - (parameters).smooth?: number; default: not declared - explain: (input: ArrayLike, parameters?: QqeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: QqePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: QqeParameters | undefined; default: not declared - explain(parameters).factor?: number; default: not declared - explain(parameters).rsiPeriod?: number; default: not declared - explain(parameters).smooth?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => QqePoint | null; default: not declared - fromJSON().return.peek: (input: number) => QqePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: QqePoint | null; default: not declared - fromJSON().return.value.longBand: number; default: not declared - fromJSON().return.value.rsiMovingAverage: number; default: not declared - fromJSON().return.value.shortBand: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: QqeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => QqePoint | null; default: not declared - stream().return.peek: (input: number) => QqePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: QqePoint | null; default: not declared - stream().return.value.longBand: number; default: not declared - stream().return.value.rsiMovingAverage: number; default: not declared - stream().return.value.shortBand: number; default: not declared - stream(parameters)?: QqeParameters | undefined; default: not declared - stream(parameters).factor?: number; default: not declared - stream(parameters).rsiPeriod?: number; default: not declared - stream(parameters).smooth?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#qstick Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Q Stick — SMA of (close − open); positive = bullish bodies dominate. ```typescript export declare const qstick: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rSquared Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling R² (squared Pearson correlation) of a paired series. ```typescript export declare const rSquared: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, Pair, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rainbowMovingAverage Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rainbowMovingAverage: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RainbowParameters | undefined; default: not declared - (parameters).levels?: number; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: RainbowParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RainbowParameters | undefined; default: not declared - explain(parameters).levels?: number; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RainbowParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RainbowParameters | undefined; default: not declared - stream(parameters).levels?: number; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rangeBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function rangeBars(bars: ArrayLike, parameters: RangeBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): RangeBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).size: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#readSnapshot Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate a snapshot envelope and open its state for checked reading. `expected` is the kind the CALLING restorer produces. Passing it is what turns a restorer from "rebuilds itself out of whatever numbers are in front of it" into one that knows whose snapshot it is holding — and it costs the call site four characters. A LIST is accepted for the handful of restorers that serve a FAMILY: one `MomentStream` class backs both `standardDeviation` and `variance`, and reads which one it is off the snapshot. Those are the restorers that genuinely may not pin a single kind — and a list still pins the family, which is the whole guarantee. A restorer that pins nothing is the defect this parameter exists to remove, so there is no form of this call that omits it. Order matters, and each step is the precondition of the next: an envelope that is not an object has no version; a version this build cannot read makes every field meaningless; a snapshot from another indicator has the wrong fields entirely, so reporting a missing field would send the reader looking in the wrong place. ```typescript export declare function readSnapshot(snapshot: TechnicalAnalysisSnapshot, expected: Kind | readonly Kind[]): SnapshotState; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (expected): Kind | readonly Kind[]; default: not declared - (snapshot): TechnicalAnalysisSnapshot; default: not declared - (snapshot).kind: string; default: not declared - (snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - (snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - return.boolean: (field: string) => boolean; default: not declared — A boolean flag. - return.cached: (field: string) => T | null; default: not declared — The LAST EMITTED OUTPUT, cached so a restored stream's `.value` is not blank until the next bar. Deliberately the loosest accessor, and the only one that tolerates non-finite: `NaN` is a real output. `acos` outside [-1, 1] is NaN; a `fairValueGaps` point reads `{ top: NaN, bottom: NaN }` until a gap forms. Rejecting those would refuse to restore a correct stream. What it still refuses is a value of a kind no indicator ever outputs — a string, a boolean, a function — which is what a foreign or hand-edited snapshot looks like. A missing key reads as `null` rather than throwing: the cache is an optimisation, and a snapshot that predates an indicator caching its value must restore to "no value yet", not fail. - return.child: (field: string) => TechnicalAnalysisSnapshot; default: not declared — A nested snapshot envelope — a composed indicator's child (`macd` carries three EMAs). Only the SHAPE is checked here. The child's own `fromJSON` calls `readSnapshot` with the kind it expects, so a child from the wrong indicator is convicted there, with that indicator's name on the message rather than the parent's. - return.children: (field: string) => TechnicalAnalysisSnapshot[]; default: not declared — A fresh array of nested snapshot envelopes. - return.has: (field: string) => boolean; default: not declared — Does the state carry this key at all? For a field a newer build may legitimately omit. - return.integer: (field: string) => number; default: not declared — A whole number ≥ 0 — a count, an index, a bar offset. A fractional count restores a stream whose window boundaries never line up again, which shows up as an off-by-a-fraction output rather than as an error. - return.kind: Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - return.literal: (field: string, allowed: readonly T[]) => T; default: not declared — A value drawn from a closed set — a mode, a method, a moving-average family, a trade direction. Numbers as well as strings: `TradeDirection` is `-1 | 0 | 1`, and reading it as a plain number would accept `7` as a trade direction. - return.literals: (field: string, allowed: readonly T[]) => T[]; default: not declared — A fresh array of values drawn from a closed set. - return.lookback: (field: string) => number; default: not declared — A lookback: an integer ≥ 1. This is the asymmetry the reader exists to close. `ta.rsi.stream({ period: -3 })` throws from `requirePeriod`; `RsiStream.fromJSON` read the same number straight out of state and built a stream with a negative window, which produces `undefined` buffer reads and silent NaN. - return.number: (field: string) => number; default: not declared — A number: sums, running averages, thresholds, multipliers. Non-finite is permitted HERE and refused at the door. `readSnapshot` has already walked the whole state: an encoded non-finite has been decoded (the indicator computed it — a zero price series makes every log-return NaN), and a raw one has been rejected as damage. By the time an accessor runs, `NaN` can only mean the first. - return.numberOrNull: (field: string) => number | null; default: not declared — A number or `null` — a running value that has not been established yet. - return.numberRows: (field: string) => number[][]; default: not declared — A fresh array of fresh number arrays — a matrix of windows. - return.numbers: (field: string) => number[]; default: not declared — A FRESH array of finite numbers. Fresh matters: the previous `state['buf'] as number[]` aliased the caller's snapshot, so two streams restored from one snapshot object shared a buffer and corrupted each other. Restorers used to spell that defence themselves (`[...(state['buf'] as number[])]`) and could forget to. - return.numbersOrNull: (field: string) => number[] | null; default: not declared — A fresh array of finite numbers, or `null`. - return.optionalNumber: (field: string) => number | undefined; default: not declared — A number the state may omit entirely (an optional parameter a stream carries). - return.optionalNumbers: (field: string) => number[] | undefined; default: not declared — A fresh array of finite numbers the state may omit. - return.raw: Record; default: not declared — The raw state object. For a restorer that must hand a whole sub-object to a helper. - return.record: (field: string) => T; default: not declared — A structured record the indicator persists whole — a bar, a candle, an accumulator. Members are not walked: their shape is the indicator's own business and varies per record type. The check is that it IS a record, which is what separates a usable snapshot from `"acc"` or `7`. - return.recordOrNull: (field: string) => T | null; default: not declared — A structured record, or `null` when the indicator has not established one. - return.records: (field: string) => T[]; default: not declared — A fresh array of structured records — persisted bars, candles, levels. - return.text: (field: string) => string; default: not declared — A string. ### @insiderfinance/totalfinance/technical-analysis#realBody Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const realBody: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#realizedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const realizedVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: HistoricalVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: HistoricalVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: HistoricalVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: HistoricalVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#register Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function register(entry: RegisteredIndicator): void; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (entry): RegisteredIndicator; default: not declared - (entry).category: IndicatorCategory; default: not declared - (entry).conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - (entry).defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - (entry).indicator: AnyIndicator; default: not declared - (entry).indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - (entry).indicator.fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - (entry).indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - (entry).inputs: IndicatorInputs; default: not declared - (entry).name: string; default: not declared - (entry).output: IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - (entry).parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). ### @insiderfinance/totalfinance/technical-analysis#registryMarkdown Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Render the registry as a Markdown reference table, grouped by category. ```typescript export declare function registryMarkdown(): string; ``` ### @insiderfinance/totalfinance/technical-analysis#relativeVigorIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const relativeVigorIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, RvgiPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: RvgiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => RvgiPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => RvgiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: RvgiPoint | null; default: not declared - fromJSON().return.value.rvi: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => RvgiPoint | null; default: not declared - stream().return.peek: (input: BarInput) => RvgiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: RvgiPoint | null; default: not declared - stream().return.value.rvi: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#relativeVolatilityIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const relativeVolatilityIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RviParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - (parameters).stdevPeriod?: number; default: not declared - explain: (input: ArrayLike, parameters?: RviParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RviParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).stdevPeriod?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RviParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RviParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).stdevPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#relativeVolume Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const relativeVolume: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#renko Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function renko(bars: ArrayLike, parameters: RenkoParameters): RenkoBrick[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): RenkoParameters; default: not declared - (parameters).brickSize: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#resample Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resample ascending timestamped bars to a higher timeframe on epoch-aligned buckets. OHLC = first-open / max-high / min-low / last-close; volume is summed; VWAP is volume-weighted over the bucket's typical prices. Only COMPLETED buckets are emitted by default — the final (forming) bucket is emitted only with `{ includePartial: true }` and flagged `partial: true`. Bars must be ascending by `timestampMs` (throws otherwise). ```typescript export declare function resample(bars: ArrayLike, interval: ResampleInterval, options?: ResampleOptions): ResampledBar[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (interval): ResampleInterval; default: not declared - (options)?: ResampleOptions; default: not declared - (options).includePartial?: boolean; default: not declared — Emit the final, still-forming bucket (flagged `partial: true`). Default `false`. ### @insiderfinance/totalfinance/technical-analysis#rescale Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling rescale of the min-max-normalized value into [min, max]. ```typescript export declare const rescale: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RescaleParameters | undefined; default: not declared - (parameters).max?: number; default: not declared — Target range maximum. Default 1. - (parameters).min?: number; default: not declared — Target range minimum. Default 0. - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: RescaleParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RescaleParameters | undefined; default: not declared - explain(parameters).max?: number; default: not declared — Target range maximum. Default 1. - explain(parameters).min?: number; default: not declared — Target range minimum. Default 0. - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RescaleParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RescaleParameters | undefined; default: not declared - stream(parameters).max?: number; default: not declared — Target range maximum. Default 1. - stream(parameters).min?: number; default: not declared — Target range minimum. Default 0. - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#resolveCandleName Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a TotalFinance or TA-Lib `CDL*` pattern name to the TotalFinance catalog name (throws if unknown). ```typescript export declare function resolveCandleName(name: string): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#resolveIndicator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve a name (any convention) to its registered indicator, or `undefined`. ```typescript export declare function resolveIndicator(name: string): RegisteredIndicator | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared - return.category: import('@insiderfinance/totalfinance/technical-analysis').IndicatorCategory; default: not declared - return.conventions?: Readonly>; default: not declared — The choices this indicator made that its parameters do not reveal — Wilder vs EMA smoothing, what a flat window resolves to, how the first value is seeded. Present only where such a choice exists, so its absence is information too. Echoed by `.explain().assumptions.conventions` and surfaced by `describeIndicator`, which is what makes a divergence from TA-Lib or pandas-ta discoverable from the result instead of only from prose. - return.defaults?: Record; default: not declared — Declared default per optional parameter (the disclosure law, dx R1): a parameter listed in `parameters` but absent here is REQUIRED. A value may be a resolver `(resolved) => value` for the rare default computed from another parameter. Bound at built-in construction/custom registration so `.explain().assumptions.parameters` echoes every default that engages. - return.indicator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; default: not declared - return.indicator.explain: (input: ArrayLike, parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - return.indicator.fromJSON: (snapshot: import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - return.indicator.stream: (parameters?: any) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - return.inputs: import('@insiderfinance/totalfinance/technical-analysis').IndicatorInputs; default: not declared - return.name: string; default: not declared - return.output: import('@insiderfinance/totalfinance/technical-analysis').IndicatorOutputMetadata; default: not declared — The indicator's output metadata (recursive value schema + optional visualization) — Wave 6 §4. - return.parameters: string[]; default: not declared — Parameter names (including defaulted ones the caller may omit). ### @insiderfinance/totalfinance/technical-analysis#resolveIndicatorName Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Resolve any TotalFinance / TA-Lib / pandas-ta / TradingView name (case-insensitive) to the canonical TotalFinance indicator name. An exact canonical name wins over a case variant, which wins over an external alias. Returns `undefined` if nothing matches. ```typescript export declare function resolveIndicatorName(name: string): string | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (name): string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#returns Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const returns: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rising Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function rising(operand: Operand): Condition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (operand): Operand; default: not declared - return.refs: readonly string[]; default: not declared — String operands (column aliases, dotted sub-fields, raw fields) this condition reads. ### @insiderfinance/totalfinance/technical-analysis#rma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#roc Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const roc: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RocParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RocParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RocParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#rocp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rocp: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RocParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RocParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RocParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#rocr Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rocr: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RocParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RocParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RocParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#rocr100 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rocr100: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RocParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RocParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RocParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RocParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Lookback. Defaults to 10 for roc/rocp/rocr/rocr100/momentum; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#rogersSatchell Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rogersSatchell: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RangeVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RangeVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RangeVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingAnchoredVwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingAnchoredVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RollingAnchoredVwapParameters | undefined; default: not declared - (parameters).anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - (parameters).lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. - explain: (input: ArrayLike, parameters?: RollingAnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: AnchoredVwapPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RollingAnchoredVwapParameters | undefined; default: not declared - explain(parameters).anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - explain(parameters).lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => AnchoredVwapPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => AnchoredVwapPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AnchoredVwapPoint | null; default: not declared - fromJSON().return.value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - fromJSON().return.value.vwap: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RollingAnchoredVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => AnchoredVwapPoint | null; default: not declared - stream().return.peek: (input: BarInput) => AnchoredVwapPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: AnchoredVwapPoint | null; default: not declared - stream().return.value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - stream().return.value.vwap: number; default: not declared - stream(parameters)?: RollingAnchoredVwapParameters | undefined; default: not declared - stream(parameters).anchor?: 'high' | 'low'; default: not declared — Anchor on the rolling-window lowest low (`'low'`, default) or highest high (`'high'`). - stream(parameters).lookback?: number; default: not declared — Rolling lookback to search for the anchor extreme. ### @insiderfinance/totalfinance/technical-analysis#rollingBeta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling beta vs a benchmark (alias of `beta`). ```typescript export declare const rollingBeta: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingCorrelation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling Pearson correlation (alias of `correl`). ```typescript export declare const rollingCorrelation: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis/statistics').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMax Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingMax: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMaxIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bars ago (0 = current bar) of the highest value in the window. ```typescript export declare const rollingMaxIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMean Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling mean (alias of `sma`). ```typescript export declare const rollingMean: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMeanAbsoluteDeviation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling mean absolute deviation from the window mean. ```typescript export declare const rollingMeanAbsoluteDeviation: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMedian Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling median. ```typescript export declare const rollingMedian: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingMin: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMinIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bars ago (0 = current bar) of the lowest value in the window. ```typescript export declare const rollingMinIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMinMax Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingMinMax: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MinMaxPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => MinMaxPoint | null; default: not declared - fromJSON().return.peek: (input: number) => MinMaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MinMaxPoint | null; default: not declared - fromJSON().return.value.max: number; default: not declared - fromJSON().return.value.min: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => MinMaxPoint | null; default: not declared - stream().return.peek: (input: number) => MinMaxPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MinMaxPoint | null; default: not declared - stream().return.value.max: number; default: not declared - stream().return.value.min: number; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingMinMaxIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingMinMaxIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MinMaxIndexPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => MinMaxIndexPoint | null; default: not declared - fromJSON().return.peek: (input: number) => MinMaxIndexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MinMaxIndexPoint | null; default: not declared - fromJSON().return.value.maxIndex: number; default: not declared - fromJSON().return.value.minIndex: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => MinMaxIndexPoint | null; default: not declared - stream().return.peek: (input: number) => MinMaxIndexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MinMaxIndexPoint | null; default: not declared - stream().return.value.maxIndex: number; default: not declared - stream().return.value.minIndex: number; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingQuantile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling quantile (linear interpolation). ```typescript export declare const rollingQuantile: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: QuantileParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - (parameters).quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). - explain: (input: ArrayLike, parameters?: QuantileParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: QuantileParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: QuantileParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: QuantileParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).quantile?: number; default: not declared — Quantile in [0, 1]. Default 0.5 (median). ### @insiderfinance/totalfinance/technical-analysis#rollingRank Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling 1-based ordinal rank of the current value within the window. ```typescript export declare const rollingRank: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingRegression Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling ordinary-least-squares regression of y on x: `{ slope, intercept, rSquared }`. ```typescript export declare const rollingRegression: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, Pair, RegressionPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: RegressionPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => RegressionPoint | null; default: not declared - fromJSON().return.peek: (input: Pair) => RegressionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: RegressionPoint | null; default: not declared - fromJSON().return.value.intercept: number; default: not declared - fromJSON().return.value.rSquared: number; default: not declared — Coefficient of determination. - fromJSON().return.value.slope: number; default: not declared — OLS slope of y on x. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => RegressionPoint | null; default: not declared - stream().return.peek: (input: Pair) => RegressionPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: RegressionPoint | null; default: not declared - stream().return.value.intercept: number; default: not declared - stream().return.value.rSquared: number; default: not declared — Coefficient of determination. - stream().return.value.slope: number; default: not declared — OLS slope of y on x. - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingSum Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingSum: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingVolatility: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RollingVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: RollingVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RollingVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RollingVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RollingVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-period stddev by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rollingVwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rollingVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#rsi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Wilder's RSI (period 14 default, disclosed via `.explain()`). Flat-series convention: when the average loss over the window is zero (a flat or monotonically rising series), TotalFinance returns **100** (the RS → ∞ limit; TradingView's convention). TA-Lib emits 0 there and pandas-ta NaN — see `docs/compatibility/talib-differences.md`. ```typescript export declare const rsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RsiParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - explain: (input: ArrayLike, parameters?: RsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RsiParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RsiParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Wilder lookback. Defaults to 14 (TA-Lib and pandas-ta agree); echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis#rsx Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const rsx: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#runBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Tick run bars — close on the larger one-sided tick run. ```typescript export declare function runBars(bars: ArrayLike, parameters: InformationBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): InformationBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#schaffTrendCycle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const schaffTrendCycle: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StcParameters | undefined; default: not declared - (parameters).cycle?: number; default: not declared - (parameters).fast?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: StcParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StcParameters | undefined; default: not declared - explain(parameters).cycle?: number; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StcParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: StcParameters | undefined; default: not declared - stream(parameters).cycle?: number; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#searchIndicators Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Filter the registry by a name/alias search and category, then paginate — the token-lean alternative to pulling all ~335 indicators. `query` matches the canonical name or any TA-Lib/pandas/TradingView alias. `match: 'auto'` (default) uses exact/substring hits when any exist and falls back to a deterministic Damerau–Levenshtein fuzzy match only when they do not; queried rows carry inspectable `match` evidence. See `docs/specs/wave6-quant-moats.md` §4. ```typescript export declare function searchIndicators(options?: SearchIndicatorsOptions): SearchIndicatorsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: SearchIndicatorsOptions; default: not declared - (options).category?: IndicatorCategory; default: not declared - (options).limit?: number; default: not declared — Non-negative safe-integer page size; omit for all matches. - (options).match?: SearchMatchMode; default: not declared — Match mode (default `'auto'`). Only meaningful with a `query`. - (options).minScore?: number; default: not declared — Minimum fuzzy similarity in `[0, 1]` (default `0.7`). Only used for fuzzy matching, needs a `query`. - (options).offset?: number; default: not declared — Non-negative safe-integer page offset; default 0. - (options).query?: string; default: not declared — Case-insensitive substring/fuzzy match of the canonical name OR any alias. - return.indicators: IndicatorRow[]; default: not declared - return.limit: number | null; default: not declared — The applied page size (`null` = unbounded). - return.offset: number; default: not declared - return.total: number; default: not declared — Matches before pagination. ### @insiderfinance/totalfinance/technical-analysis#sessionRanges Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggregate bars into per-session OHLCV + range. `sessionIds[i]` is the session a bar belongs to (bars carry no timestamp, so the caller supplies the grouping). Sessions appear in first-seen order. ```typescript export declare function sessionRanges(bars: ArrayLike, sessionIds: ArrayLike): SessionRange[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (sessionIds): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis#sessionVwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sessionVwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SessionVwapParameters | undefined; default: not declared - (parameters).resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). - explain: (input: ArrayLike, parameters?: SessionVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SessionVwapParameters | undefined; default: not declared - explain(parameters).resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SessionVwapParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: SessionVwapParameters | undefined; default: not declared - stream(parameters).resetEvery: number; default: not declared — Reset the cumulative VWAP every `resetEvery` bars (one trading session's bar count). ### @insiderfinance/totalfinance/technical-analysis#shift Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Lag a series by `period` bars: `output[i] = input[i − period]`. ```typescript export declare const shift: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#shortRun Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 when fast (`x`) and slow (`y`) are both falling over the lookback — a confirmed down-run. ```typescript export declare const shortRun: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, Pair, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#signal Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function signal(candles: BarInput[]): SignalBuilder; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (candles): BarInput[]; default: not declared - return.addRule: (rule: Rule) => void; default: not declared - return.atr: (parameters?: WilderPeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - return.columns: () => Record; default: not declared — The underlying feature columns (for inspection / charting). - return.ema: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - return.events: () => SignalEvent[]; default: not declared — Only the bars that emitted, as `{ index, label }` events. - return.feature: (alias: string, values: unknown[]) => SignalBuilder; default: not declared — Inject a precomputed column. - return.rsi: (field: Field, parameters?: RsiParameters, options?: AliasOpt) => SignalBuilder; default: not declared — `parameters` is optional on the default-bearing methods, matching both `FeaturePipeline` and the direct call: `rsi(closes)` resolves period 14, so `signal(bars).rsi('close')` must too. These two were left required when the pipeline's were relaxed, so the two fluent surfaces disagreed — the delegate compiled and the caller's identical call did not. - return.signals: () => (string | null)[]; default: not declared — Aligned labels: the first matching rule's label per bar, else `null`. - return.sma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared - return.use: (field: Field, indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any series indicator to a field under an alias. `options.as` is REQUIRED here: the generic escape hatch has no indicator-specific auto-name to fall back on. - return.useBars: (indicator: Indicator, parameters: P, options: Required) => SignalBuilder; default: not declared — Apply any bar indicator to the candles under an alias. `options.as` is required (see {@link use}). - return.when: (condition: Condition) => RuleBuilder; default: not declared - return.wma: (field: Field, parameters: PeriodParameters, options?: AliasOpt) => SignalBuilder; default: not declared ### @insiderfinance/totalfinance/technical-analysis#sin Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sin: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#sineWma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sineWma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#sinh Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sinh: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#skew Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling sample skewness (bias-corrected Fisher-Pearson G1). ```typescript export declare const skew: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#slope Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const slope: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#sma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#smcSweep Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). pandas-ta `smc_sweep`: +1 bullish low sweep, -1 bearish high sweep, 0 none. ```typescript export declare const smcSweep: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SmcSweepParameters | undefined; default: not declared - (parameters).period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - (parameters).wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. - explain: (input: ArrayLike, parameters?: SmcSweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SmcSweepParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - explain(parameters).wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SmcSweepParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: SmcSweepParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared — Prior-window swing high/low lookback. Default 15. - stream(parameters).wickMultiplier?: number; default: not declared — Wick must exceed `body * wickMultiplier`. Default 1.5. ### @insiderfinance/totalfinance/technical-analysis#smiErgodic Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const smiErgodic: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SmiParameters | undefined; default: not declared - (parameters).long?: number; default: not declared - (parameters).short?: number; default: not declared - (parameters).signal?: number; default: not declared - explain: (input: ArrayLike, parameters?: SmiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: SmiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SmiParameters | undefined; default: not declared - explain(parameters).long?: number; default: not declared - explain(parameters).short?: number; default: not declared - explain(parameters).signal?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => SmiPoint | null; default: not declared - fromJSON().return.peek: (input: number) => SmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SmiPoint | null; default: not declared - fromJSON().return.value.oscillator: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.smi: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SmiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => SmiPoint | null; default: not declared - stream().return.peek: (input: number) => SmiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: SmiPoint | null; default: not declared - stream().return.value.oscillator: number; default: not declared - stream().return.value.signal: number; default: not declared - stream().return.value.smi: number; default: not declared - stream(parameters)?: SmiParameters | undefined; default: not declared - stream(parameters).long?: number; default: not declared - stream(parameters).short?: number; default: not declared - stream(parameters).signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#snapshotOf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Stamp indicator state into the public envelope. Every `toJSON` goes through here. This is also where the state becomes JSON-SAFE: after `snapshotOf`, no number in the tree is non-finite, so `JSON.stringify` is lossless and any raw `NaN` a reader later encounters can only have come from damage — which is what lets {@link SnapshotState} refuse it. `kind` is guarded because the natural wrong call is `snapshotOf(stream)` — reaching for the serializer as if it took the thing to serialize. That produced an envelope whose `kind` was a live stream object and whose `state` was `undefined`: it survives `JSON.stringify` (as `{}`) and only fails much later, at a `fromJSON` that cannot say why. ```typescript export declare function snapshotOf(kind: string, state: Record): TechnicalAnalysisSnapshot; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (kind): string; default: not declared - (state): Record; default: not declared - return.kind: string; default: not declared - return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. ### @insiderfinance/totalfinance/technical-analysis#sqrt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sqrt: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#squeeze Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const squeeze: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SqueezeParameters | undefined; default: not declared - (parameters).bollingerBandPeriod?: number; default: not declared - (parameters).bollingerStandardDeviations?: number; default: not declared - (parameters).keltnerChannelMultiplier?: number; default: not declared - (parameters).keltnerChannelPeriod?: number; default: not declared - explain: (input: ArrayLike, parameters?: SqueezeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: SqueezePoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SqueezeParameters | undefined; default: not declared - explain(parameters).bollingerBandPeriod?: number; default: not declared - explain(parameters).bollingerStandardDeviations?: number; default: not declared - explain(parameters).keltnerChannelMultiplier?: number; default: not declared - explain(parameters).keltnerChannelPeriod?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => SqueezePoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => SqueezePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SqueezePoint | null; default: not declared - fromJSON().return.value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - fromJSON().return.value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SqueezeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => SqueezePoint | null; default: not declared - stream().return.peek: (input: BarInput) => SqueezePoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: SqueezePoint | null; default: not declared - stream().return.value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - stream().return.value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - stream(parameters)?: SqueezeParameters | undefined; default: not declared - stream(parameters).bollingerBandPeriod?: number; default: not declared - stream(parameters).bollingerStandardDeviations?: number; default: not declared - stream(parameters).keltnerChannelMultiplier?: number; default: not declared - stream(parameters).keltnerChannelPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#squeezePro Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const squeezePro: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SqueezeProParameters | undefined; default: not declared - (parameters).bollingerBandPeriod?: number; default: not declared - (parameters).bollingerStandardDeviations?: number; default: not declared - (parameters).keltnerChannelPeriod?: number; default: not declared - (parameters).narrowKeltnerChannelMultiplier?: number; default: not declared - (parameters).normalKeltnerChannelMultiplier?: number; default: not declared - (parameters).wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. - explain: (input: ArrayLike, parameters?: SqueezeProParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: SqueezeProPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SqueezeProParameters | undefined; default: not declared - explain(parameters).bollingerBandPeriod?: number; default: not declared - explain(parameters).bollingerStandardDeviations?: number; default: not declared - explain(parameters).keltnerChannelPeriod?: number; default: not declared - explain(parameters).narrowKeltnerChannelMultiplier?: number; default: not declared - explain(parameters).normalKeltnerChannelMultiplier?: number; default: not declared - explain(parameters).wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => SqueezeProPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => SqueezeProPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SqueezeProPoint | null; default: not declared - fromJSON().return.value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - fromJSON().return.value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - fromJSON().return.value.momentum: number; default: not declared - fromJSON().return.value.normalCompression: number; default: not declared — Normal compression. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SqueezeProParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => SqueezeProPoint | null; default: not declared - stream().return.peek: (input: BarInput) => SqueezeProPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: SqueezeProPoint | null; default: not declared - stream().return.value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - stream().return.value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - stream().return.value.momentum: number; default: not declared - stream().return.value.normalCompression: number; default: not declared — Normal compression. - stream(parameters)?: SqueezeProParameters | undefined; default: not declared - stream(parameters).bollingerBandPeriod?: number; default: not declared - stream(parameters).bollingerStandardDeviations?: number; default: not declared - stream(parameters).keltnerChannelPeriod?: number; default: not declared - stream(parameters).narrowKeltnerChannelMultiplier?: number; default: not declared - stream(parameters).normalKeltnerChannelMultiplier?: number; default: not declared - stream(parameters).wideKeltnerChannelMultiplier?: number; default: not declared — Keltner multipliers, wide → tight. Default 2.0 / 1.5 / 1.0. Named for the CHANNEL, not the compression level they detect. As `low`/`mid`/`high` they inverted against their own values — `lowMultiplier` was the LARGEST number (2.0, the widest channel, the loosest squeeze) — so the reader had to know which of the two scales the word referred to. The point's fields are now `lowCompression`/`normalCompression`/ `highCompression`, so both halves of the indicator say which scale they are on. ### @insiderfinance/totalfinance/technical-analysis#standardDeviation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const standardDeviation: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StandardDeviationParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - explain: (input: ArrayLike, parameters?: StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StandardDeviationParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: StandardDeviationParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. ### @insiderfinance/totalfinance/technical-analysis#standardError Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling standard error of the mean: sampleStd / √n. ```typescript export declare const standardError: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#stoch Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const stoch: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StochasticParameters | undefined; default: not declared - (parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - (parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - (parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - explain: (input: ArrayLike, parameters?: StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: StochasticPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StochasticParameters | undefined; default: not declared - explain(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - explain(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - explain(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => StochasticPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochasticPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => StochasticPoint | null; default: not declared - stream().return.peek: (input: BarInput) => StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: StochasticPoint | null; default: not declared - stream().return.value.d: number; default: not declared - stream().return.value.k: number; default: not declared - stream(parameters)?: StochasticParameters | undefined; default: not declared - stream(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stream(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stream(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. ### @insiderfinance/totalfinance/technical-analysis#stochFast Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Alias of {@link stochastic}: with the default `smoothK: 1` the stochastic IS the fast stochastic (raw %K + SMA %D — TA-Lib STOCHF). One implementation, two registry names; pass `smoothK: 3` for the classic slow stochastic (TA-Lib STOCH's slowk). ```typescript export declare const stochFast: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StochasticParameters | undefined; default: not declared - (parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - (parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - (parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - explain: (input: ArrayLike, parameters?: StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: StochasticPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StochasticParameters | undefined; default: not declared - explain(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - explain(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - explain(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => StochasticPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochasticPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => StochasticPoint | null; default: not declared - stream().return.peek: (input: BarInput) => StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: StochasticPoint | null; default: not declared - stream().return.value.d: number; default: not declared - stream().return.value.k: number; default: not declared - stream(parameters)?: StochasticParameters | undefined; default: not declared - stream(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stream(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stream(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. ### @insiderfinance/totalfinance/technical-analysis#stochRsi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const stochRsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StochRsiParameters | undefined; default: not declared - (parameters).dPeriod?: number; default: not declared - (parameters).kPeriod?: number; default: not declared - (parameters).rsiPeriod?: number; default: not declared - (parameters).stochPeriod?: number; default: not declared - explain: (input: ArrayLike, parameters?: StochRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: StochRsiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StochRsiParameters | undefined; default: not declared - explain(parameters).dPeriod?: number; default: not declared - explain(parameters).kPeriod?: number; default: not declared - explain(parameters).rsiPeriod?: number; default: not declared - explain(parameters).stochPeriod?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => StochRsiPoint | null; default: not declared - fromJSON().return.peek: (input: number) => StochRsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochRsiPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StochRsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => StochRsiPoint | null; default: not declared - stream().return.peek: (input: number) => StochRsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: StochRsiPoint | null; default: not declared - stream().return.value.d: number; default: not declared - stream().return.value.k: number; default: not declared - stream(parameters)?: StochRsiParameters | undefined; default: not declared - stream(parameters).dPeriod?: number; default: not declared - stream(parameters).kPeriod?: number; default: not declared - stream(parameters).rsiPeriod?: number; default: not declared - stream(parameters).stochPeriod?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#stochastic Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const stochastic: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StochasticParameters | undefined; default: not declared - (parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - (parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - (parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - explain: (input: ArrayLike, parameters?: StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: StochasticPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StochasticParameters | undefined; default: not declared - explain(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - explain(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - explain(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => StochasticPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochasticPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StochasticParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => StochasticPoint | null; default: not declared - stream().return.peek: (input: BarInput) => StochasticPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: StochasticPoint | null; default: not declared - stream().return.value.d: number; default: not declared - stream().return.value.k: number; default: not declared - stream(parameters)?: StochasticParameters | undefined; default: not declared - stream(parameters).dPeriod?: number; default: not declared — %D smoothing. Defaults to 3 (universal). - stream(parameters).kPeriod?: number; default: not declared — %K lookback. Defaults to 14 (Lane; universal); echoed via `.explain()`. - stream(parameters).smoothK?: number; default: not declared — SMA smoothing applied to the raw %K before %D — the standard SLOW stochastic (TA-Lib STOCH's `slowk_period`, typically 3). Defaults to 1: no smoothing, i.e. the FAST stochastic. ### @insiderfinance/totalfinance/technical-analysis#streamAsync Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Feed a stream from an **async iterable** source (spec §13.2 streaming adapters), yielding each non-`null` (post-warmup) output as it is produced. Lets indicators consume live feeds — websockets, async DB cursors, generators — without buffering the whole series. Pure: it reads only what the source yields and never touches the clock. ```typescript export declare function streamAsync(stream: IndicatorStream, source: AsyncIterable): AsyncGenerator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (source): AsyncIterable; default: not declared - (stream): IndicatorStream; default: not declared - (stream).next: (input: In) => Out | null; default: not declared - (stream).toJSON: () => TechnicalAnalysisSnapshot; default: not declared - (stream).value: Out | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#sub Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const sub: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#superSmoother Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const superSmoother: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#supertrend Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const supertrend: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SupertrendParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: SupertrendParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: SupertrendPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SupertrendParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => SupertrendPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => SupertrendPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SupertrendPoint | null; default: not declared - fromJSON().return.value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - fromJSON().return.value.supertrend: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SupertrendParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => SupertrendPoint | null; default: not declared - stream().return.peek: (input: BarInput) => SupertrendPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: SupertrendPoint | null; default: not declared - stream().return.value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - stream().return.value.supertrend: number; default: not declared - stream(parameters)?: SupertrendParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#supportResistance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cluster swing highs into resistance levels and swing lows into support levels. ```typescript export declare function supportResistance(bars: ArrayLike, options?: { strength?: number; tolerance?: number; }): SupportResistance; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { strength?: number; tolerance?: number; }; default: not declared - (options).strength?: number; default: not declared - (options).tolerance?: number; default: not declared - return.assumptions: { conventionsVersion: string; strength: number; tolerance: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.strength: number; default: not declared - return.assumptions.tolerance: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.resistance: SrLevel[]; default: not declared - return.support: SrLevel[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#swingTrailingStop Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Structure-based trailing stop: trails the most recent confirmed swing low (long) / high (short). ```typescript export declare const swingTrailingStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: SwingTrailingStopParameters | undefined; default: not declared - (parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - explain: (input: ArrayLike, parameters?: SwingTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TrailingStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: SwingTrailingStopParameters | undefined; default: not declared - explain(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => TrailingStopPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TrailingStopPoint | null; default: not declared - fromJSON().return.value.stop: number; default: not declared — The trailing stop line. - fromJSON().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: SwingTrailingStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => TrailingStopPoint | null; default: not declared - stream().return.peek: (input: BarInput) => TrailingStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TrailingStopPoint | null; default: not declared - stream().return.value.stop: number; default: not declared — The trailing stop line. - stream().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - stream(parameters)?: SwingTrailingStopParameters | undefined; default: not declared - stream(parameters).strength?: number; default: not declared — Swing strength (bars on each side). Default 2. ### @insiderfinance/totalfinance/technical-analysis#swings Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Swing highs/lows: a swing high is a bar whose high strictly exceeds the highs of the `strength` bars on each side (and symmetrically for lows). The first and last `strength` bars can never be swings. `strength` defaults to 2 (the Bill Williams fractal window). ```typescript export declare function swings(bars: ArrayLike, options?: { strength?: number; }): Swings; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { strength?: number; }; default: not declared - (options).strength?: number; default: not declared - return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.strength: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.highs: SwingPoint[]; default: not declared - return.lows: SwingPoint[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#symmetricWma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Symmetric (triangular) weighted MA — identical to the triangular MA (`trima`). ```typescript export declare const symmetricWma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#t3 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const t3: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: T3Parameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. - explain: (input: ArrayLike, parameters?: T3Parameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: T3Parameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: T3Parameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: T3Parameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).volumeFactor?: number; default: not declared — Tillson volume factor (0–1). Default 0.7. ### @insiderfinance/totalfinance/technical-analysis#talibCandle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run an adaptive TA-Lib candlestick pattern by name (camelCase or `CDL*`), returning the ±100/0 series. Throws for patterns not yet ported to the adaptive engine (use the fixed-ratio detectors in `candlesticks.ts` for those — see `TALIB_CANDLE_NAMES` for what's available here). ```typescript export declare function talibCandle(name: string, bars: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (name): string; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tan Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const tan: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tanh Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const tanh: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tdSequential Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const tdSequential: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: TdSequentialParameters | undefined; default: not declared - (parameters).lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). - explain: (input: ArrayLike, parameters?: TdSequentialParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TdSequentialPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: TdSequentialParameters | undefined; default: not declared - explain(parameters).lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => TdSequentialPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => TdSequentialPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TdSequentialPoint | null; default: not declared - fromJSON().return.value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - fromJSON().return.value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - fromJSON().return.value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: TdSequentialParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => TdSequentialPoint | null; default: not declared - stream().return.peek: (input: BarInput) => TdSequentialPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TdSequentialPoint | null; default: not declared - stream().return.value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - stream().return.value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - stream().return.value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - stream(parameters)?: TdSequentialParameters | undefined; default: not declared - stream(parameters).lookback?: number; default: not declared — Comparison lookback for the setup (DeMark uses 4). ### @insiderfinance/totalfinance/technical-analysis#tema Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const tema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tickBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function tickBars(bars: ArrayLike, parameters: CountBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): CountBarParameters; default: not declared - (parameters).count: number; default: not declared - (parameters).flush?: boolean; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tickVolumeProfile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Volume-by-price built from the **actual trade prints** (each trade's full size lands in the bucket of its exact price — no bar-range smearing), with the POC, value area, and a per-price buy/sell delta (footprint). This is the trade-level counterpart to the bar-based `volumeProfile`. ```typescript export declare function tickVolumeProfile(trades: readonly Trade[], parameters?: TickVolumeProfileParameters): TickVolumeProfile; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters)?: TickVolumeProfileParameters; default: not declared - (parameters).bins?: number; default: not declared — Number of equal-width buckets between the min and max trade price. Default 50. - (parameters).method?: AggressorMethod; default: not declared — Aggressor method for the buy/sell split. Default `'quote'` if quotes given, else `'tick'`. - (parameters).quotes?: readonly Quote[]; default: not declared - (parameters).tickSize?: number; default: not declared — Bucket width in price units (e.g. one tick). Mutually exclusive with `bins` (tickSize wins). - (parameters).valueAreaFraction?: number; default: not declared — Fraction of total volume defining the value area. Default 0.7. - (trades): readonly Trade[]; default: not declared - return.assumptions: { bins: number | null; conventionsVersion: string; method: AggressorMethod; tickSize: number | null; valueAreaFraction: number; }; default: not declared — Applied conventions, echoed — the binning mode that WON is non-null (`tickSize` beats `bins`). - return.assumptions.bins: number | null; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: AggressorMethod; default: not declared - return.assumptions.tickSize: number | null; default: not declared - return.assumptions.valueAreaFraction: number; default: not declared - return.bins: TickVolumeBin[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.poc: number | null; default: not declared — Point of control: price of the highest-volume bucket (its midpoint); null for an empty tape. - return.totalDelta: number; default: not declared - return.totalVolume: number; default: not declared - return.valueArea: { high: number | null; low: number | null; }; default: not declared — Value-area price bounds holding `valueAreaFraction` of total volume around the POC (nulls when empty). - return.valueArea.high: number | null; default: not declared - return.valueArea.low: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tosStdevAll Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Thinkorswim Standard Deviation All: OLS line plus source-standard-deviation bands. Omitting `period` uses **all history seen so far** (a causal, stream-friendly expanding window) — a deliberate TotalFinance choice. This is NOT the single full-series regression overlay that ThinkorSwim / pandas-ta's `tos_stdevall` draws (a constant line over the whole chart); pass an explicit `period` for a fixed rolling window. See docs/compatibility/talib-differences.md. ```typescript export declare const tosStdevAll: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: TosStdevAllParameters | undefined; default: not declared - (parameters).ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - (parameters).period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - (parameters).stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. - explain: (input: ArrayLike, parameters?: TosStdevAllParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TosStdevAllPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: TosStdevAllParameters | undefined; default: not declared - explain(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - explain(parameters).period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - explain(parameters).stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => TosStdevAllPoint | null; default: not declared - fromJSON().return.peek: (input: number) => TosStdevAllPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TosStdevAllPoint | null; default: not declared - fromJSON().return.value.line: number; default: not declared — Current value of the OLS centerline. - fromJSON().return.value.lower: number[]; default: not declared — Lower bands, in the same order as `stds`. - fromJSON().return.value.upper: number[]; default: not declared — Upper bands, in the same order as `stds`. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: TosStdevAllParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => TosStdevAllPoint | null; default: not declared - stream().return.peek: (input: number) => TosStdevAllPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TosStdevAllPoint | null; default: not declared - stream().return.value.line: number; default: not declared — Current value of the OLS centerline. - stream().return.value.lower: number[]; default: not declared — Lower bands, in the same order as `stds`. - stream().return.value.upper: number[]; default: not declared — Upper bands, in the same order as `stds`. - stream(parameters)?: TosStdevAllParameters | undefined; default: not declared - stream(parameters).ddof?: number; default: not declared — Delta degrees of freedom for the source-series standard deviation. Default 1. - stream(parameters).period?: number | null; default: not declared — Rolling window. Omit (or pass null) to use all history seen so far. - stream(parameters).stds?: readonly number[]; default: not declared — Positive standard-deviation multipliers. Default [1, 2, 3]. ### @insiderfinance/totalfinance/technical-analysis#tradeSign Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain aggressor sign; use `tradeSign.explain(...)` for the resolving rule and diagnostics. ```typescript export declare const tradeSign: import('@insiderfinance/totalfinance/core').SeriesFacade<[trade: Trade, context?: SignContext | undefined], TradeDirection, { conventionsVersion: string; method: AggressorMethod; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (callArguments): [trade: Trade, context?: SignContext | undefined]; default: not declared - explain: (trade: Trade, context?: SignContext | undefined) => import('@insiderfinance/totalfinance/core').Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ conventionsVersion: string; method: AggressorMethod; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TradeDirection; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(callArguments): [trade: Trade, context?: SignContext | undefined]; default: not declared ### @insiderfinance/totalfinance/technical-analysis#trendSignals Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Turn a trend series (>0 ⇒ in-trend) into trend/entry/exit flags. ```typescript export declare const trendSignals: import('@insiderfinance/totalfinance/technical-analysis').Indicator, number, TrendSignalPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TrendSignalPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => TrendSignalPoint | null; default: not declared - fromJSON().return.peek: (input: number) => TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TrendSignalPoint | null; default: not declared - fromJSON().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - fromJSON().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - fromJSON().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => TrendSignalPoint | null; default: not declared - stream().return.peek: (input: number) => TrendSignalPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TrendSignalPoint | null; default: not declared - stream().return.value.entry: number; default: not declared — 1 on the bar a position is opened. - stream().return.value.exit: number; default: not declared — 1 on the bar a position is closed. - stream().return.value.trend: number; default: not declared — Current position state: 1 in-trend / 0 flat. - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#trendlines Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Connect the two most recent swing lows (support) and swing highs (resistance) into trendlines. ```typescript export declare function trendlines(bars: ArrayLike, options?: { strength?: number; }): TrendlineChannel; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (options)?: { strength?: number; }; default: not declared - (options).strength?: number; default: not declared - return.assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.strength: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.resistance: Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - return.resistance.from: number; default: not declared - return.resistance.intercept: number; default: not declared - return.resistance.slope: number; default: not declared - return.resistance.to: number; default: not declared - return.support: Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - return.support.from: number; default: not declared - return.support.intercept: number; default: not declared - return.support.slope: number; default: not declared - return.support.to: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#trima Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const trima: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#trix Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). TRIX — the 1-bar rate of change of a triple-smoothed EMA, in percent. Warmup is TA-Lib's TRIX lookback, `3·(period − 1) + 1`: the triple EMA itself first exists at `3·(period − 1)`, and the rate of change needs the bar after that. ```typescript export declare const trix: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#trixHistogram Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const trixHistogram: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: TrixHistogramParameters | undefined; default: not declared - (parameters).period?: number; default: not declared - (parameters).signal?: number; default: not declared - explain: (input: ArrayLike, parameters?: TrixHistogramParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TrixHistogramPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: TrixHistogramParameters | undefined; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).signal?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => TrixHistogramPoint | null; default: not declared - fromJSON().return.peek: (input: number) => TrixHistogramPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TrixHistogramPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.trix: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: TrixHistogramParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => TrixHistogramPoint | null; default: not declared - stream().return.peek: (input: number) => TrixHistogramPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TrixHistogramPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.signal: number; default: not declared - stream().return.value.trix: number; default: not declared - stream(parameters)?: TrixHistogramParameters | undefined; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#trueRange Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const trueRange: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tsf Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const tsf: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#tsi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const tsi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: TsiParameters | undefined; default: not declared - (parameters).long?: number; default: not declared - (parameters).short?: number; default: not declared - (parameters).signal?: number; default: not declared - explain: (input: ArrayLike, parameters?: TsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: TsiPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: TsiParameters | undefined; default: not declared - explain(parameters).long?: number; default: not declared - explain(parameters).short?: number; default: not declared - explain(parameters).signal?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => TsiPoint | null; default: not declared - fromJSON().return.peek: (input: number) => TsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TsiPoint | null; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.tsi: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: TsiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => TsiPoint | null; default: not declared - stream().return.peek: (input: number) => TsiPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: TsiPoint | null; default: not declared - stream().return.value.signal: number; default: not declared - stream().return.value.tsi: number; default: not declared - stream(parameters)?: TsiParameters | undefined; default: not declared - stream(parameters).long?: number; default: not declared - stream(parameters).short?: number; default: not declared - stream(parameters).signal?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ttmTrend Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). TTM Trend — +1 when close is above the SMA of HL2 over the lookback, −1 otherwise. ```typescript export declare const ttmTrend: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#typicalPrice Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const typicalPrice: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ulcerIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Ulcer Index — RMS of percent drawdown from the rolling `period` high close. ```typescript export declare const ulcerIndex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#ultimateOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const ultimateOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: UltimateParameters | undefined; default: not declared - (parameters).long?: number; default: not declared - (parameters).medium?: number; default: not declared - (parameters).short?: number; default: not declared - explain: (input: ArrayLike, parameters?: UltimateParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: UltimateParameters | undefined; default: not declared - explain(parameters).long?: number; default: not declared - explain(parameters).medium?: number; default: not declared - explain(parameters).short?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: UltimateParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: UltimateParameters | undefined; default: not declared - stream(parameters).long?: number; default: not declared - stream(parameters).medium?: number; default: not declared - stream(parameters).short?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#upperShadow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const upperShadow: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#valueWhen Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The source (`y`) value when the condition (`x > 0`) was last true (the `occurrence`-th most recent). ```typescript export declare const valueWhen: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: ValueWhenParameters | undefined; default: not declared - (parameters).occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. - explain: (input: ArrayLike, parameters?: ValueWhenParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: ValueWhenParameters | undefined; default: not declared - explain(parameters).occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: Pair) => number | null; default: not declared - fromJSON().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: ValueWhenParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: Pair) => number | null; default: not declared - stream().return.peek: (input: Pair) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: ValueWhenParameters | undefined; default: not declared - stream(parameters).occurrence?: number; default: not declared — Which past occurrence: 0 = most recent true, 1 = the one before, … Default 0. ### @insiderfinance/totalfinance/technical-analysis#variance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const variance: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: StandardDeviationParameters | undefined; default: not declared - (parameters).period: number; default: not declared - (parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - explain: (input: ArrayLike, parameters?: StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: StandardDeviationParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - explain(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: StandardDeviationParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: StandardDeviationParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared - stream(parameters).sample?: boolean; default: not declared — Use the sample (n−1) estimator instead of the population (n) one. Default false. ### @insiderfinance/totalfinance/technical-analysis#verticalHorizontalFilter Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Vertical Horizontal Filter — trend strength = range / summed absolute change. ```typescript export declare const verticalHorizontalFilter: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#vfi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const vfi: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: VfiParameters | undefined; default: not declared - (parameters).coefficient?: number; default: not declared - (parameters).period?: number; default: not declared - (parameters).smooth?: number; default: not declared - (parameters).volumeCutoff?: number; default: not declared - explain: (input: ArrayLike, parameters?: VfiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: VfiParameters | undefined; default: not declared - explain(parameters).coefficient?: number; default: not declared - explain(parameters).period?: number; default: not declared - explain(parameters).smooth?: number; default: not declared - explain(parameters).volumeCutoff?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: VfiParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: VfiParameters | undefined; default: not declared - stream(parameters).coefficient?: number; default: not declared - stream(parameters).period?: number; default: not declared - stream(parameters).smooth?: number; default: not declared - stream(parameters).volumeCutoff?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#vidya Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const vidya: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: VidyaParameters | undefined; default: not declared - (parameters).cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: VidyaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: VidyaParameters | undefined; default: not declared - explain(parameters).cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: VidyaParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: VidyaParameters | undefined; default: not declared - stream(parameters).cmoPeriod?: number; default: not declared — CMO lookback driving the volatility index. Default = period. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#volatilityStop Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const volatilityStop: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: VolatilityStopParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: VolatilityStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: VolatilityStopPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: VolatilityStopParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => VolatilityStopPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => VolatilityStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: VolatilityStopPoint | null; default: not declared - fromJSON().return.value.stop: number; default: not declared — The trailing stop line. - fromJSON().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: VolatilityStopParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => VolatilityStopPoint | null; default: not declared - stream().return.peek: (input: BarInput) => VolatilityStopPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: VolatilityStopPoint | null; default: not declared - stream().return.value.stop: number; default: not declared — The trailing stop line. - stream().return.value.trend: number; default: not declared — +1 long (price above the stop), −1 short. - stream(parameters)?: VolatilityStopParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#volumeBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function volumeBars(bars: ArrayLike, parameters: VolumeBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): VolumeBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared - (parameters).volume: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#volumeImbalanceBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Volume imbalance bars — signed volume `|Σ sign(Δclose)·volume|`. ```typescript export declare function volumeImbalanceBars(bars: ArrayLike, parameters: InformationBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): InformationBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#volumeOscillator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Volume Oscillator — 100·(EMA_fast(volume) − EMA_slow(volume)) / EMA_slow(volume). ```typescript export declare const volumeOscillator: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: VolumeOscillatorParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared — Fast EMA length on volume. Default 5. - (parameters).slow?: number; default: not declared — Slow EMA length on volume. Default 10. - explain: (input: ArrayLike, parameters?: VolumeOscillatorParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: VolumeOscillatorParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared — Fast EMA length on volume. Default 5. - explain(parameters).slow?: number; default: not declared — Slow EMA length on volume. Default 10. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: VolumeOscillatorParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: VolumeOscillatorParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared — Fast EMA length on volume. Default 5. - stream(parameters).slow?: number; default: not declared — Slow EMA length on volume. Default 10. ### @insiderfinance/totalfinance/technical-analysis#volumeProfile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fixed-range volume profile: each bar's volume is spread across the price buckets its high-low range overlaps, **in proportion to the overlap** (a bar contributing 90% of its range to one bucket gives that bucket 90% of its volume), giving volume-by-price, the point of control, and the value area. A zero-range bar puts its whole volume in the bucket holding its close. ```typescript export declare function volumeProfile(bars: ArrayLike, parameters?: VolumeProfileParameters): VolumeProfile; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters)?: VolumeProfileParameters; default: not declared - (parameters).bins?: number; default: not declared — Number of price buckets. Default 24. - (parameters).valueAreaFraction?: number; default: not declared — Fraction of total volume that defines the value area. Default 0.7. - return.assumptions: { bins: number; conventionsVersion: string; valueAreaFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.bins: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.valueAreaFraction: number; default: not declared - return.bins: VolumeBin[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.poc: number | null; default: not declared — Point of control: price-bin midpoint with the most volume; null for an empty series. - return.totalVolume: number; default: not declared - return.valueArea: { high: number | null; low: number | null; }; default: not declared — Value-area price bounds containing `valueAreaFraction` of total volume around the POC (nulls when empty). - return.valueArea.high: number | null; default: not declared - return.valueArea.low: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis#volumeRunBars Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Volume run bars — close on the larger one-sided volume run. ```typescript export declare function volumeRunBars(bars: ArrayLike, parameters: InformationBarParameters): BarInput[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): InformationBarParameters; default: not declared - (parameters).flush?: boolean; default: not declared — Emit the trailing partial bar. Default true. - (parameters).threshold: number; default: not declared — Imbalance/run magnitude that closes a bar. ### @insiderfinance/totalfinance/technical-analysis#volumeWeightedMacd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const volumeWeightedMacd: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: VwMacdParameters | undefined; default: not declared - (parameters).fast?: number; default: not declared - (parameters).signal?: number; default: not declared - (parameters).slow?: number; default: not declared - explain: (input: ArrayLike, parameters?: VwMacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: MacdPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: VwMacdParameters | undefined; default: not declared - explain(parameters).fast?: number; default: not declared - explain(parameters).signal?: number; default: not declared - explain(parameters).slow?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => MacdPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: VwMacdParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => MacdPoint | null; default: not declared - stream().return.peek: (input: BarInput) => MacdPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: MacdPoint | null; default: not declared - stream().return.value.histogram: number; default: not declared - stream().return.value.macd: number; default: not declared - stream().return.value.signal: number; default: not declared - stream(parameters)?: VwMacdParameters | undefined; default: not declared - stream(parameters).fast?: number; default: not declared - stream(parameters).signal?: number; default: not declared - stream(parameters).slow?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#vortex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const vortex: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, VortexPoint>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: VortexPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => VortexPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => VortexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: VortexPoint | null; default: not declared - fromJSON().return.value.viMinus: number; default: not declared - fromJSON().return.value.viPlus: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => VortexPoint | null; default: not declared - stream().return.peek: (input: BarInput) => VortexPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: VortexPoint | null; default: not declared - stream().return.value.viMinus: number; default: not declared - stream().return.value.viPlus: number; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#vwap Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const vwap: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#vwapBands Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const vwapBands: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: VwapBandsParameters | undefined; default: not declared - (parameters).multiplier?: number; default: not declared - explain: (input: ArrayLike, parameters?: VwapBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: VwapBandsPoint[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: VwapBandsParameters | undefined; default: not declared - explain(parameters).multiplier?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => VwapBandsPoint | null; default: not declared - fromJSON().return.peek: (input: BarInput) => VwapBandsPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: VwapBandsPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON().return.value.vwap: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: VwapBandsParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => VwapBandsPoint | null; default: not declared - stream().return.peek: (input: BarInput) => VwapBandsPoint | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: VwapBandsPoint | null; default: not declared - stream().return.value.lower: number; default: not declared - stream().return.value.upper: number; default: not declared - stream().return.value.vwap: number; default: not declared - stream(parameters)?: VwapBandsParameters | undefined; default: not declared - stream(parameters).multiplier?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#vwma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const vwma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#warmupMarkdown Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Render warmup/lookahead/displacement reference as Markdown, grouped by category. ```typescript export declare function warmupMarkdown(): string; ``` ### @insiderfinance/totalfinance/technical-analysis#wcp Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). (high + low + 2·close) / 4 — alias of `weightedClose`. ```typescript export declare const wcp: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{}, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: {} | undefined; default: not declared - explain: (input: ArrayLike, parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: {} | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: {} | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: {} | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#weightedClose Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const weightedClose: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Empty | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Empty | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Empty | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Empty | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#williamsAd Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Williams Accumulation/Distribution — running sum of close − true-low/high on up/down days. ```typescript export declare const williamsAd: import('@insiderfinance/totalfinance/technical-analysis').Indicator, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: Record | undefined; default: not declared - explain: (input: ArrayLike, parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: Record | undefined; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: Record | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: Record | undefined; default: not declared ### @insiderfinance/totalfinance/technical-analysis#williamsR Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const williamsR: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#willr Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const willr: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, BarInput, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#winsorize Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling winsorize: clip the current value to the window's [lower, upper] quantiles. ```typescript export declare const winsorize: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: WinsorizeParameters | undefined; default: not declared - (parameters).lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - (parameters).period?: number; default: not declared - (parameters).upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. - explain: (input: ArrayLike, parameters?: WinsorizeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: WinsorizeParameters | undefined; default: not declared - explain(parameters).lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - explain(parameters).period?: number; default: not declared - explain(parameters).upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: WinsorizeParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: WinsorizeParameters | undefined; default: not declared - stream(parameters).lower?: number; default: not declared — Lower quantile to clip to, in [0, 1]. Default 0.05. - stream(parameters).period?: number; default: not declared - stream(parameters).upper?: number; default: not declared — Upper quantile to clip to, in [0, 1]. Default 0.95. ### @insiderfinance/totalfinance/technical-analysis#wma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const wma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#yangZhang Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const yangZhang: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: RangeVolatilityParameters | undefined; default: not declared - (parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: RangeVolatilityParameters | undefined; default: not declared - explain(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: BarInput) => number | null; default: not declared - fromJSON().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: RangeVolatilityParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: BarInput) => number | null; default: not declared - stream().return.peek: (input: BarInput) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: RangeVolatilityParameters | undefined; default: not declared - stream(parameters).annualization: number; default: not declared — Bars per year: multiplies the per-bar σ by √annualization (252 daily, 52 weekly, 12 monthly); `1` = per-bar σ. Required. - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#zScore Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Rolling z-score: `(value − mean) / populationStd` over the window (0 on a flat window). ```typescript export declare const zScore: import('@insiderfinance/totalfinance/technical-analysis').Indicator<{ period?: number; }, number, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: { period?: number; } | undefined; default: not declared - (parameters).period?: number; default: not declared - explain: (input: ArrayLike, parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: { period?: number; } | undefined; default: not declared - explain(parameters).period?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: { period?: number; } | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: { period?: number; } | undefined; default: not declared - stream(parameters).period?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#zigzag Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ZigZag pivots: alternating swing highs and lows that each reverse price by at least `deviation`%. The last pivot is provisional — a larger move can still extend the final leg — so it is flagged via `provisional`. ZigZag repaints by nature; it is a batch utility, not a streaming indicator. ```typescript export declare function zigzag(bars: ArrayLike, parameters: ZigZagParameters): ZigZagReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared - (parameters): ZigZagParameters; default: not declared - (parameters).deviation: number; default: not declared — Minimum reversal as a percentage of price (e.g. 5 = 5%). - return.assumptions: { conventionsVersion: string; deviation: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.deviation: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.pivots: ZigZagPivot[]; default: not declared - return.provisional: boolean; default: not declared — The last pivot is provisional — a larger move can still extend the final leg. ### @insiderfinance/totalfinance/technical-analysis#zlema Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const zlema: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis#zlma Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Zero-lag EMA — alias of `zlema`. ```typescript export declare const zlma: import('@insiderfinance/totalfinance/technical-analysis').Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - (parameters).period: number; default: not declared - explain: (input: ArrayLike, parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').TechnicalAnalysisExplain; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics & { warmup: number; }; default: not declared - explain().return.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - explain().return.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - explain().return.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - explain().return.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - explain().return.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - explain().return.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - explain().return.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - explain().return.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - explain().return.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - explain().return.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - explain().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ArrayLike; default: not declared - explain(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - explain(parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - fromJSON().return.next: (input: number) => number | null; default: not declared - fromJSON().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - stream: (parameters?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined) => import('@insiderfinance/totalfinance/technical-analysis').LiveStream; default: not declared - stream().return.next: (input: number) => number | null; default: not declared - stream().return.peek: (input: number) => number | null; default: not declared — The value that WOULD result from `next(input)` applied to the committed state, WITHOUT committing it. Call it repeatedly with the forming bar's evolving value; call `next(input)` once at bar close to commit. Between commits the committed state is untouched, so a live chart never repaints its closed bars. The default cost is O(snapshot) per call (clone-and-apply); indicators may override with an O(1) form later. - stream().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - stream().return.value: number | null; default: not declared - stream(parameters)?: import('@insiderfinance/totalfinance/technical-analysis').PeriodParameters | undefined; default: not declared - stream(parameters).period: number; default: not declared ## Entrypoint @insiderfinance/totalfinance/technical-analysis/aliases ### @insiderfinance/totalfinance/technical-analysis/aliases#ALIAS_TABLE Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ALIAS_TABLE`. ### @insiderfinance/totalfinance/technical-analysis/aliases#IndicatorAliasRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorAliasRow`. ### @insiderfinance/totalfinance/technical-analysis/aliases#aliasesOf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#aliasesOf`. ### @insiderfinance/totalfinance/technical-analysis/aliases#compatibilityMatrixMarkdown Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#compatibilityMatrixMarkdown`. ### @insiderfinance/totalfinance/technical-analysis/aliases#resolveIndicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#resolveIndicator`. ### @insiderfinance/totalfinance/technical-analysis/aliases#resolveIndicatorName Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#resolveIndicatorName`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/bands ### @insiderfinance/totalfinance/technical-analysis/bands#BollingerParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BollingerParameters`. ### @insiderfinance/totalfinance/technical-analysis/bands#BollingerPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BollingerPoint`. ### @insiderfinance/totalfinance/technical-analysis/bands#BollingerStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BollingerStream implements IndicatorStream { constructor(parameters: { period: number; standardDeviation: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): BollingerStream; value: BollingerPoint | null; next(value: number): BollingerPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; standardDeviation: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).standardDeviation: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => BollingerStream; default: not declared - fromJSON().return.next: (value: number) => BollingerPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: BollingerPoint | null; default: not declared - fromJSON().return.value.bandwidth: number; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.percentB: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => BollingerPoint | null; default: not declared - next().return.bandwidth: number; default: not declared - next().return.lower: number; default: not declared - next().return.middle: number; default: not declared - next().return.percentB: number; default: not declared - next().return.upper: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => BollingerPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: BollingerPoint | null; default: not declared - return.value.bandwidth: number; default: not declared - return.value.lower: number; default: not declared - return.value.middle: number; default: not declared - return.value.percentB: number; default: not declared - return.value.upper: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: BollingerPoint | null; default: not declared - value.bandwidth: number; default: not declared - value.lower: number; default: not declared - value.middle: number; default: not declared - value.percentB: number; default: not declared - value.upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/bands#bbands Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bbands`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/bars ### @insiderfinance/totalfinance/technical-analysis/bars#AdxPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AdxPoint`. ### @insiderfinance/totalfinance/technical-analysis/bars#AdxStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AdxStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AdxStream; value: AdxPoint | null; next(bar: BarInput): AdxPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AdxStream; default: not declared - fromJSON().return.next: (bar: BarInput) => AdxPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AdxPoint | null; default: not declared - fromJSON().return.value.adx: number; default: not declared - fromJSON().return.value.minusDI: number; default: not declared - fromJSON().return.value.plusDI: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => AdxPoint | null; default: not declared - next().return.adx: number; default: not declared - next().return.minusDI: number; default: not declared - next().return.plusDI: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => AdxPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: AdxPoint | null; default: not declared - return.value.adx: number; default: not declared - return.value.minusDI: number; default: not declared - return.value.plusDI: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: AdxPoint | null; default: not declared - value.adx: number; default: not declared - value.minusDI: number; default: not declared - value.plusDI: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/bars#AtrStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AtrStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AtrStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AtrStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/bars#ObvStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ObvStream implements IndicatorStream { constructor(talib?: boolean); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ObvStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (talib)?: boolean; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ObvStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/bars#StochasticParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StochasticParameters`. ### @insiderfinance/totalfinance/technical-analysis/bars#StochasticPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StochasticPoint`. ### @insiderfinance/totalfinance/technical-analysis/bars#StochasticStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class StochasticStream implements IndicatorStream { constructor(parameters: { kPeriod: number; dPeriod: number; smoothK?: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): StochasticStream; value: StochasticPoint | null; next(bar: BarInput): StochasticPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kPeriod: number; dPeriod: number; smoothK?: number; }; default: not declared - (parameters).dPeriod: number; default: not declared - (parameters).kPeriod: number; default: not declared - (parameters).smoothK?: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => StochasticStream; default: not declared - fromJSON().return.next: (bar: BarInput) => StochasticPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochasticPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => StochasticPoint | null; default: not declared - next().return.d: number; default: not declared - next().return.k: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => StochasticPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: StochasticPoint | null; default: not declared - return.value.d: number; default: not declared - return.value.k: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: StochasticPoint | null; default: not declared - value.d: number; default: not declared - value.k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/bars#VwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VwapStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VwapStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/bars#WilderPeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#WilderPeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/bars#adx Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#adx`. ### @insiderfinance/totalfinance/technical-analysis/bars#atr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#atr`. ### @insiderfinance/totalfinance/technical-analysis/bars#obv Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#obv`. ### @insiderfinance/totalfinance/technical-analysis/bars#stochFast Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#stochFast`. ### @insiderfinance/totalfinance/technical-analysis/bars#stochastic Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#stochastic`. ### @insiderfinance/totalfinance/technical-analysis/bars#vwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vwap`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/candle-aliases ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#CDL_ALIASES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CDL_ALIASES`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#CandleZParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleZParameters`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#CandleZPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleZPoint`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#CandleZStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CandleZStream implements IndicatorStream { constructor(parameters: { period: number; ddof: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CandleZStream; value: CandleZPoint | null; next(bar: BarInput): CandleZPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; ddof: number; }; default: not declared - (parameters).ddof: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CandleZStream; default: not declared - fromJSON().return.next: (bar: BarInput) => CandleZPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: CandleZPoint | null; default: not declared - fromJSON().return.value.close: number; default: not declared - fromJSON().return.value.high: number; default: not declared - fromJSON().return.value.low: number; default: not declared - fromJSON().return.value.open: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => CandleZPoint | null; default: not declared - next().return.close: number; default: not declared - next().return.high: number; default: not declared - next().return.low: number; default: not declared - next().return.open: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => CandleZPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: CandleZPoint | null; default: not declared - return.value.close: number; default: not declared - return.value.high: number; default: not declared - return.value.low: number; default: not declared - return.value.open: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: CandleZPoint | null; default: not declared - value.close: number; default: not declared - value.high: number; default: not declared - value.low: number; default: not declared - value.open: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#PANDAS_CDL_ALIASES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PANDAS_CDL_ALIASES`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#cdlDoji Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlDoji`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#cdlInside Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlInside`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#cdlPattern Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlPattern`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#cdlZ Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlZ`. ### @insiderfinance/totalfinance/technical-analysis/candle-aliases#resolveCandleName Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#resolveCandleName`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/candle-talib ### @insiderfinance/totalfinance/technical-analysis/candle-talib#CANDLE_SETTINGS Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CANDLE_SETTINGS`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#CandleRangeType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleRangeType`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#CandleSetting Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleSetting`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#CandleSettingName Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleSettingName`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#TALIB_CANDLE_NAMES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TALIB_CANDLE_NAMES`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#candleAverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#candleAverage`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#candleColor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#candleColor`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#cdlClosingMarubozuTalib Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlClosingMarubozuTalib`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#cdlDojiTalib Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlDojiTalib`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#cdlMarubozuTalib Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cdlMarubozuTalib`. ### @insiderfinance/totalfinance/technical-analysis/candle-talib#talibCandle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#talibCandle`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/candlesticks ### @insiderfinance/totalfinance/technical-analysis/candlesticks#CandleDetector Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleDetector`. ### @insiderfinance/totalfinance/technical-analysis/candlesticks#CandleMatch Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleMatch`. ### @insiderfinance/totalfinance/technical-analysis/candlesticks#CandleStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CandleStream implements IndicatorStream { constructor(parameters: { name: string; length: number; detect: CandleDetector; }); static restore(name: string, length: number, detect: CandleDetector): (s: TechnicalAnalysisSnapshot) => CandleStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { name: string; length: number; detect: CandleDetector; }; default: not declared - (parameters).detect: CandleDetector; default: not declared - (parameters).length: number; default: not declared - (parameters).name: string; default: not declared - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - restore: (name: string, length: number, detect: CandleDetector) => (s: TechnicalAnalysisSnapshot) => CandleStream; default: not declared - restore(detect): CandleDetector; default: not declared - restore(length): number; default: not declared - restore(name): string; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/candlesticks#CandleView Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CandleView`. ### @insiderfinance/totalfinance/technical-analysis/candlesticks#candlestickNames Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#candlestickNames`. ### @insiderfinance/totalfinance/technical-analysis/candlesticks#candlesticks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#candlesticks`. ### @insiderfinance/totalfinance/technical-analysis/candlesticks#detectCandles Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#detectCandles`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/chart-types ### @insiderfinance/totalfinance/technical-analysis/chart-types#AggregateStream Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AggregateStream`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#BarAggregator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BarAggregator`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#CountBarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CountBarParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#DollarBarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DollarBarParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#HeikinAshiBar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HeikinAshiBar`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#InformationBarAggregator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#InformationBarAggregator`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#InformationBarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#InformationBarParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#KagiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KagiParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#KagiSegment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KagiSegment`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#LineBreakBar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LineBreakBar`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#LineBreakParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LineBreakParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#LineBreakStream Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LineBreakStream`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#PnfColumn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PnfColumn`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#PnfParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PnfParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#RangeBarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RangeBarParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#RenkoBrick Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RenkoBrick`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#RenkoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RenkoParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#RenkoStream Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RenkoStream`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#VolumeBarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolumeBarParameters`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#aggregators Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#aggregators`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#dollarBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dollarBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#dollarImbalanceBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dollarImbalanceBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#dollarRunBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dollarRunBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#heikinAshi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#heikinAshi`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#imbalanceBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#imbalanceBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#kagi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kagi`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#lineBreak Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lineBreak`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#pointAndFigure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pointAndFigure`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#rangeBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rangeBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#renko Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#renko`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#runBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#runBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#tickBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tickBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#volumeBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volumeBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#volumeImbalanceBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volumeImbalanceBars`. ### @insiderfinance/totalfinance/technical-analysis/chart-types#volumeRunBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volumeRunBars`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/cycle ### @insiderfinance/totalfinance/technical-analysis/cycle#DspParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DspParameters`. ### @insiderfinance/totalfinance/technical-analysis/cycle#DspStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DspStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DspStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DspStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#EbswParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#EbswParameters`. ### @insiderfinance/totalfinance/technical-analysis/cycle#EbswStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Even Better Sinewave — **pandas-ta-compatible, including pandas-ta's degree/radian defect.** pandas-ta's `ebsw` feeds `360 / period` (and `√2·180 / bars`) to `sin`/`cos`, which take RADIANS, so the high-pass and super-smoother coefficients are not the ones Ehlers published (his use `2π / period` and `√2·π / bars`). TotalFinance reproduces pandas-ta bit-for-bit — that is what the certified golden pins and what a pandas-ta user comparing outputs expects — which means **this is not Ehlers's published filter**. Treat `ebsw` as "pandas-ta's EBSW", and do not port its coefficients to a from-scratch Ehlers implementation. ```typescript export declare class EbswStream implements IndicatorStream { constructor(parameters: { period: number; bars: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): EbswStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; bars: number; }; default: not declared - (parameters).bars: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => EbswStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#HilbertCore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HilbertCore`. ### @insiderfinance/totalfinance/technical-analysis/cycle#HilbertOut Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HilbertOut`. ### @insiderfinance/totalfinance/technical-analysis/cycle#HtPhasorStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HtPhasorStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HtPhasorStream; core: HilbertCore; value: PhasorPoint | null; next(value: number): PhasorPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - core: HilbertCore; default: not declared - core.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - core.toJSON().return.kind: string; default: not declared - core.toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - core.toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - core.update: (priceValue: number) => HilbertOut | null; default: not declared - core.update().return.dcPeriod: number; default: not declared — Dominant cycle period (smoothed), clamped to [6, 50]. - core.update().return.dcPhase: number; default: not declared — Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). - core.update().return.inPhase: number; default: not declared — In-phase component. - core.update().return.quadrature: number; default: not declared — Quadrature component. - core.update().return.trendline: number; default: not declared — Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). - core.update(priceValue): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HtPhasorStream; default: not declared - fromJSON().return.core: HilbertCore; default: not declared - fromJSON().return.next: (value: number) => PhasorPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PhasorPoint | null; default: not declared - fromJSON().return.value.inPhase: number; default: not declared - fromJSON().return.value.quadrature: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => PhasorPoint | null; default: not declared - next().return.inPhase: number; default: not declared - next().return.quadrature: number; default: not declared - next(value): number; default: not declared - return.core: HilbertCore; default: not declared - return.next: (value: number) => PhasorPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: PhasorPoint | null; default: not declared - return.value.inPhase: number; default: not declared - return.value.quadrature: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: PhasorPoint | null; default: not declared - value.inPhase: number; default: not declared - value.quadrature: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#HtScalarStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HtScalarStream implements IndicatorStream { constructor(parameters: { kind: string; pick: (output: HilbertOut) => number; }); core: HilbertCore; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; pick: (output: HilbertOut) => number; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).pick: (output: HilbertOut) => number; default: not declared - core: HilbertCore; default: not declared - core.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - core.toJSON().return.kind: string; default: not declared - core.toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - core.toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - core.update: (priceValue: number) => HilbertOut | null; default: not declared - core.update().return.dcPeriod: number; default: not declared — Dominant cycle period (smoothed), clamped to [6, 50]. - core.update().return.dcPhase: number; default: not declared — Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). - core.update().return.inPhase: number; default: not declared — In-phase component. - core.update().return.quadrature: number; default: not declared — Quadrature component. - core.update().return.trendline: number; default: not declared — Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). - core.update(priceValue): number; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.core: HilbertCore; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#HtSineStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HtSineStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HtSineStream; core: HilbertCore; value: SinePoint | null; next(value: number): SinePoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - core: HilbertCore; default: not declared - core.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - core.toJSON().return.kind: string; default: not declared - core.toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - core.toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - core.update: (priceValue: number) => HilbertOut | null; default: not declared - core.update().return.dcPeriod: number; default: not declared — Dominant cycle period (smoothed), clamped to [6, 50]. - core.update().return.dcPhase: number; default: not declared — Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). - core.update().return.inPhase: number; default: not declared — In-phase component. - core.update().return.quadrature: number; default: not declared — Quadrature component. - core.update().return.trendline: number; default: not declared — Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). - core.update(priceValue): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HtSineStream; default: not declared - fromJSON().return.core: HilbertCore; default: not declared - fromJSON().return.next: (value: number) => SinePoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SinePoint | null; default: not declared - fromJSON().return.value.leadSine: number; default: not declared - fromJSON().return.value.sine: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => SinePoint | null; default: not declared - next().return.leadSine: number; default: not declared - next().return.sine: number; default: not declared - next(value): number; default: not declared - return.core: HilbertCore; default: not declared - return.next: (value: number) => SinePoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: SinePoint | null; default: not declared - return.value.leadSine: number; default: not declared - return.value.sine: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: SinePoint | null; default: not declared - value.leadSine: number; default: not declared - value.sine: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#HtTrendModeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). 1 = trend, 0 = cycle. Cycle mode is entered on a sine/lead-sine crossing and held for roughly one dominant cycle (an Ehlers-style heuristic; TA-Lib's exact trend test differs in detail). ```typescript export declare class HtTrendModeStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HtTrendModeStream; core: HilbertCore; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - core: HilbertCore; default: not declared - core.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - core.toJSON().return.kind: string; default: not declared - core.toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - core.toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - core.update: (priceValue: number) => HilbertOut | null; default: not declared - core.update().return.dcPeriod: number; default: not declared — Dominant cycle period (smoothed), clamped to [6, 50]. - core.update().return.dcPhase: number; default: not declared — Dominant cycle phase in degrees (TA-Lib DCPhase algorithm). - core.update().return.inPhase: number; default: not declared — In-phase component. - core.update().return.quadrature: number; default: not declared — Quadrature component. - core.update().return.trendline: number; default: not declared — Instantaneous trendline (dominant-cycle SMA of price, 4-3-2-1 smoothed). - core.update(priceValue): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HtTrendModeStream; default: not declared - fromJSON().return.core: HilbertCore; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.core: HilbertCore; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#MswParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MswParameters`. ### @insiderfinance/totalfinance/technical-analysis/cycle#MswPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MswPoint`. ### @insiderfinance/totalfinance/technical-analysis/cycle#MswStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MswStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MswStream; value: MswPoint | null; next(value: number): MswPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MswStream; default: not declared - fromJSON().return.next: (value: number) => MswPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MswPoint | null; default: not declared - fromJSON().return.value.lead: number; default: not declared - fromJSON().return.value.sine: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => MswPoint | null; default: not declared - next().return.lead: number; default: not declared - next().return.sine: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => MswPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MswPoint | null; default: not declared - return.value.lead: number; default: not declared - return.value.sine: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MswPoint | null; default: not declared - value.lead: number; default: not declared - value.sine: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/cycle#PhasorPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PhasorPoint`. ### @insiderfinance/totalfinance/technical-analysis/cycle#SinePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SinePoint`. ### @insiderfinance/totalfinance/technical-analysis/cycle#dsp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dsp`. ### @insiderfinance/totalfinance/technical-analysis/cycle#ebsw Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ebsw`. ### @insiderfinance/totalfinance/technical-analysis/cycle#htDcPeriod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#htDcPeriod`. ### @insiderfinance/totalfinance/technical-analysis/cycle#htDcPhase Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#htDcPhase`. ### @insiderfinance/totalfinance/technical-analysis/cycle#htPhasor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#htPhasor`. ### @insiderfinance/totalfinance/technical-analysis/cycle#htSine Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#htSine`. ### @insiderfinance/totalfinance/technical-analysis/cycle#htTrendMode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#htTrendMode`. ### @insiderfinance/totalfinance/technical-analysis/cycle#htTrendline Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#htTrendline`. ### @insiderfinance/totalfinance/technical-analysis/cycle#msw Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#msw`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/divergence ### @insiderfinance/totalfinance/technical-analysis/divergence#DivergenceCode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DivergenceCode`. ### @insiderfinance/totalfinance/technical-analysis/divergence#DivergenceEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DivergenceEvent`. ### @insiderfinance/totalfinance/technical-analysis/divergence#DivergenceKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DivergenceKind`. ### @insiderfinance/totalfinance/technical-analysis/divergence#DivergenceParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DivergenceParameters`. ### @insiderfinance/totalfinance/technical-analysis/divergence#DivergencePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DivergencePoint`. ### @insiderfinance/totalfinance/technical-analysis/divergence#DivergencesInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#DivergencesInput`. ### @insiderfinance/totalfinance/technical-analysis/divergence#SwingWindow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SwingWindow`. ### @insiderfinance/totalfinance/technical-analysis/divergence#divergence Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#divergence`. ### @insiderfinance/totalfinance/technical-analysis/divergence#divergences Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#divergences`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/features ### @insiderfinance/totalfinance/technical-analysis/features#CovarianceParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CovarianceParameters`. ### @insiderfinance/totalfinance/technical-analysis/features#DrawdownPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DrawdownPoint`. ### @insiderfinance/totalfinance/technical-analysis/features#DrawdownStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DrawdownStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DrawdownStream; value: DrawdownPoint | null; next(value: number): DrawdownPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DrawdownStream; default: not declared - fromJSON().return.next: (value: number) => DrawdownPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: DrawdownPoint | null; default: not declared - fromJSON().return.value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - fromJSON().return.value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - fromJSON().return.value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => DrawdownPoint | null; default: not declared - next().return.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - next().return.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - next().return.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - next(value): number; default: not declared - return.next: (value: number) => DrawdownPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: DrawdownPoint | null; default: not declared - return.value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - return.value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - return.value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: DrawdownPoint | null; default: not declared - value.drawdown: number; default: not declared — Peak-to-current decline in price/equity units. - value.log: number; default: not declared — Log drawdown: `log(peak) - log(value)`. - value.percent: number; default: not declared — Peak-to-current decline as a positive fraction. ### @insiderfinance/totalfinance/technical-analysis/features#QuantileParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#QuantileParameters`. ### @insiderfinance/totalfinance/technical-analysis/features#RegressionPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RegressionPoint`. ### @insiderfinance/totalfinance/technical-analysis/features#RescaleParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RescaleParameters`. ### @insiderfinance/totalfinance/technical-analysis/features#TosStdevAllParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TosStdevAllParameters`. ### @insiderfinance/totalfinance/technical-analysis/features#TosStdevAllPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TosStdevAllPoint`. ### @insiderfinance/totalfinance/technical-analysis/features#ValueWhenParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ValueWhenParameters`. ### @insiderfinance/totalfinance/technical-analysis/features#WinsorizeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#WinsorizeParameters`. ### @insiderfinance/totalfinance/technical-analysis/features#barSince Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#barSince`. ### @insiderfinance/totalfinance/technical-analysis/features#change Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#change`. ### @insiderfinance/totalfinance/technical-analysis/features#covariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#covariance`. ### @insiderfinance/totalfinance/technical-analysis/features#cumulativeSum Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cumulativeSum`. ### @insiderfinance/totalfinance/technical-analysis/features#difference Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#difference`. ### @insiderfinance/totalfinance/technical-analysis/features#drawdown Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#drawdown`. ### @insiderfinance/totalfinance/technical-analysis/features#entropy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#entropy`. ### @insiderfinance/totalfinance/technical-analysis/features#fractionalChange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fractionalChange`. ### @insiderfinance/totalfinance/technical-analysis/features#highestBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#highestBars`. ### @insiderfinance/totalfinance/technical-analysis/features#kurtosis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kurtosis`. ### @insiderfinance/totalfinance/technical-analysis/features#lag Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lag`. ### @insiderfinance/totalfinance/technical-analysis/features#lowestBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lowestBars`. ### @insiderfinance/totalfinance/technical-analysis/features#normalize Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#normalize`. ### @insiderfinance/totalfinance/technical-analysis/features#percentRank Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#percentRank`. ### @insiderfinance/totalfinance/technical-analysis/features#rSquared Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rSquared`. ### @insiderfinance/totalfinance/technical-analysis/features#rescale Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rescale`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingBeta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingBeta`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingCorrelation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingCorrelation`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingMean Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMean`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingMeanAbsoluteDeviation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMeanAbsoluteDeviation`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingMedian Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMedian`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingQuantile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingQuantile`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingRank Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingRank`. ### @insiderfinance/totalfinance/technical-analysis/features#rollingRegression Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingRegression`. ### @insiderfinance/totalfinance/technical-analysis/features#shift Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#shift`. ### @insiderfinance/totalfinance/technical-analysis/features#skew Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#skew`. ### @insiderfinance/totalfinance/technical-analysis/features#standardError Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#standardError`. ### @insiderfinance/totalfinance/technical-analysis/features#tosStdevAll Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tosStdevAll`. ### @insiderfinance/totalfinance/technical-analysis/features#valueWhen Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#valueWhen`. ### @insiderfinance/totalfinance/technical-analysis/features#winsorize Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#winsorize`. ### @insiderfinance/totalfinance/technical-analysis/features#zScore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#zScore`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/framework ### @insiderfinance/totalfinance/technical-analysis/framework#BarInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BarInput`. ### @insiderfinance/totalfinance/technical-analysis/framework#Indicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Indicator`. ### @insiderfinance/totalfinance/technical-analysis/framework#IndicatorConventions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorConventions`. ### @insiderfinance/totalfinance/technical-analysis/framework#IndicatorInputKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The input class an indicator consumes (mirrored by the registry's `IndicatorInputs`). ```typescript /** The input class an indicator consumes (mirrored by the registry's `IndicatorInputs`). */ export type IndicatorInputKind = 'series' | 'bars' | 'pair'; ``` ### @insiderfinance/totalfinance/technical-analysis/framework#IndicatorStream Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorStream`. ### @insiderfinance/totalfinance/technical-analysis/framework#LiveStream Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LiveStream`. ### @insiderfinance/totalfinance/technical-analysis/framework#SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SCHEMA_VERSION`. ### @insiderfinance/totalfinance/technical-analysis/framework#SnapshotState Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Checked access to one snapshot's opaque state. Every accessor takes the state key and returns the value the restorer needs, or throws a typed `InputError` naming the indicator and the key. There is no accessor that returns `unknown`: a restorer that cannot express what it needs is a restorer that is not checking. ```typescript export declare class SnapshotState { constructor(kind: Kind, state: Record); boolean(field: string): boolean; cached(field: string): T | null; child(field: string): TechnicalAnalysisSnapshot; children(field: string): TechnicalAnalysisSnapshot[]; has(field: string): boolean; integer(field: string): number; readonly kind: Kind; literal(field: string, allowed: readonly T[]): T; literals(field: string, allowed: readonly T[]): T[]; lookback(field: string): number; number(field: string): number; numberOrNull(field: string): number | null; numberRows(field: string): number[][]; numbers(field: string): number[]; numbersOrNull(field: string): number[] | null; optionalNumber(field: string): number | undefined; optionalNumbers(field: string): number[] | undefined; raw: Record; record(field: string): T; recordOrNull(field: string): T | null; records(field: string): T[]; text(field: string): string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (kind): Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - (state): Record; default: not declared - boolean: (field: string) => boolean; default: not declared — A boolean flag. - boolean(field): string; default: not declared - cached: (field: string) => T | null; default: not declared — The LAST EMITTED OUTPUT, cached so a restored stream's `.value` is not blank until the next bar. Deliberately the loosest accessor, and the only one that tolerates non-finite: `NaN` is a real output. `acos` outside [-1, 1] is NaN; a `fairValueGaps` point reads `{ top: NaN, bottom: NaN }` until a gap forms. Rejecting those would refuse to restore a correct stream. What it still refuses is a value of a kind no indicator ever outputs — a string, a boolean, a function — which is what a foreign or hand-edited snapshot looks like. A missing key reads as `null` rather than throwing: the cache is an optimisation, and a snapshot that predates an indicator caching its value must restore to "no value yet", not fail. - cached(field): string; default: not declared - child: (field: string) => TechnicalAnalysisSnapshot; default: not declared — A nested snapshot envelope — a composed indicator's child (`macd` carries three EMAs). Only the SHAPE is checked here. The child's own `fromJSON` calls `readSnapshot` with the kind it expects, so a child from the wrong indicator is convicted there, with that indicator's name on the message rather than the parent's. - child().return.kind: string; default: not declared - child().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - child().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - child(field): string; default: not declared - children: (field: string) => TechnicalAnalysisSnapshot[]; default: not declared — A fresh array of nested snapshot envelopes. - children(field): string; default: not declared - has: (field: string) => boolean; default: not declared — Does the state carry this key at all? For a field a newer build may legitimately omit. - has(field): string; default: not declared - integer: (field: string) => number; default: not declared — A whole number ≥ 0 — a count, an index, a bar offset. A fractional count restores a stream whose window boundaries never line up again, which shows up as an off-by-a-fraction output rather than as an error. - integer(field): string; default: not declared - kind: Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - literal: (field: string, allowed: readonly T[]) => T; default: not declared — A value drawn from a closed set — a mode, a method, a moving-average family, a trade direction. Numbers as well as strings: `TradeDirection` is `-1 | 0 | 1`, and reading it as a plain number would accept `7` as a trade direction. - literal(allowed): readonly T[]; default: not declared - literal(field): string; default: not declared - literals: (field: string, allowed: readonly T[]) => T[]; default: not declared — A fresh array of values drawn from a closed set. - literals(allowed): readonly T[]; default: not declared - literals(field): string; default: not declared - lookback: (field: string) => number; default: not declared — A lookback: an integer ≥ 1. This is the asymmetry the reader exists to close. `ta.rsi.stream({ period: -3 })` throws from `requirePeriod`; `RsiStream.fromJSON` read the same number straight out of state and built a stream with a negative window, which produces `undefined` buffer reads and silent NaN. - lookback(field): string; default: not declared - number: (field: string) => number; default: not declared — A number: sums, running averages, thresholds, multipliers. Non-finite is permitted HERE and refused at the door. `readSnapshot` has already walked the whole state: an encoded non-finite has been decoded (the indicator computed it — a zero price series makes every log-return NaN), and a raw one has been rejected as damage. By the time an accessor runs, `NaN` can only mean the first. - number(field): string; default: not declared - numberOrNull: (field: string) => number | null; default: not declared — A number or `null` — a running value that has not been established yet. - numberOrNull(field): string; default: not declared - numberRows: (field: string) => number[][]; default: not declared — A fresh array of fresh number arrays — a matrix of windows. - numberRows(field): string; default: not declared - numbers: (field: string) => number[]; default: not declared — A FRESH array of finite numbers. Fresh matters: the previous `state['buf'] as number[]` aliased the caller's snapshot, so two streams restored from one snapshot object shared a buffer and corrupted each other. Restorers used to spell that defence themselves (`[...(state['buf'] as number[])]`) and could forget to. - numbers(field): string; default: not declared - numbersOrNull: (field: string) => number[] | null; default: not declared — A fresh array of finite numbers, or `null`. - numbersOrNull(field): string; default: not declared - optionalNumber: (field: string) => number | undefined; default: not declared — A number the state may omit entirely (an optional parameter a stream carries). - optionalNumber(field): string; default: not declared - optionalNumbers: (field: string) => number[] | undefined; default: not declared — A fresh array of finite numbers the state may omit. - optionalNumbers(field): string; default: not declared - raw: Record; default: not declared — The raw state object. For a restorer that must hand a whole sub-object to a helper. - record: (field: string) => T; default: not declared — A structured record the indicator persists whole — a bar, a candle, an accumulator. Members are not walked: their shape is the indicator's own business and varies per record type. The check is that it IS a record, which is what separates a usable snapshot from `"acc"` or `7`. - record(field): string; default: not declared - recordOrNull: (field: string) => T | null; default: not declared — A structured record, or `null` when the indicator has not established one. - recordOrNull(field): string; default: not declared - records: (field: string) => T[]; default: not declared — A fresh array of structured records — persisted bars, candles, levels. - records(field): string; default: not declared - return.boolean: (field: string) => boolean; default: not declared — A boolean flag. - return.cached: (field: string) => T | null; default: not declared — The LAST EMITTED OUTPUT, cached so a restored stream's `.value` is not blank until the next bar. Deliberately the loosest accessor, and the only one that tolerates non-finite: `NaN` is a real output. `acos` outside [-1, 1] is NaN; a `fairValueGaps` point reads `{ top: NaN, bottom: NaN }` until a gap forms. Rejecting those would refuse to restore a correct stream. What it still refuses is a value of a kind no indicator ever outputs — a string, a boolean, a function — which is what a foreign or hand-edited snapshot looks like. A missing key reads as `null` rather than throwing: the cache is an optimisation, and a snapshot that predates an indicator caching its value must restore to "no value yet", not fail. - return.child: (field: string) => TechnicalAnalysisSnapshot; default: not declared — A nested snapshot envelope — a composed indicator's child (`macd` carries three EMAs). Only the SHAPE is checked here. The child's own `fromJSON` calls `readSnapshot` with the kind it expects, so a child from the wrong indicator is convicted there, with that indicator's name on the message rather than the parent's. - return.children: (field: string) => TechnicalAnalysisSnapshot[]; default: not declared — A fresh array of nested snapshot envelopes. - return.has: (field: string) => boolean; default: not declared — Does the state carry this key at all? For a field a newer build may legitimately omit. - return.integer: (field: string) => number; default: not declared — A whole number ≥ 0 — a count, an index, a bar offset. A fractional count restores a stream whose window boundaries never line up again, which shows up as an off-by-a-fraction output rather than as an error. - return.kind: Kind; default: not declared — The indicator kind this state belongs to — the prefix on every message, and, for a FAMILY restorer, the narrowed member the guard just proved. `readSnapshot(s, MOMENT_KINDS)` hands back a state whose `kind` is `'standardDeviation' | 'variance'`, so the restorer feeds it straight into its constructor instead of re-asserting `snapshot.kind as string` — which is the cast the guard exists to make unnecessary. - return.literal: (field: string, allowed: readonly T[]) => T; default: not declared — A value drawn from a closed set — a mode, a method, a moving-average family, a trade direction. Numbers as well as strings: `TradeDirection` is `-1 | 0 | 1`, and reading it as a plain number would accept `7` as a trade direction. - return.literals: (field: string, allowed: readonly T[]) => T[]; default: not declared — A fresh array of values drawn from a closed set. - return.lookback: (field: string) => number; default: not declared — A lookback: an integer ≥ 1. This is the asymmetry the reader exists to close. `ta.rsi.stream({ period: -3 })` throws from `requirePeriod`; `RsiStream.fromJSON` read the same number straight out of state and built a stream with a negative window, which produces `undefined` buffer reads and silent NaN. - return.number: (field: string) => number; default: not declared — A number: sums, running averages, thresholds, multipliers. Non-finite is permitted HERE and refused at the door. `readSnapshot` has already walked the whole state: an encoded non-finite has been decoded (the indicator computed it — a zero price series makes every log-return NaN), and a raw one has been rejected as damage. By the time an accessor runs, `NaN` can only mean the first. - return.numberOrNull: (field: string) => number | null; default: not declared — A number or `null` — a running value that has not been established yet. - return.numberRows: (field: string) => number[][]; default: not declared — A fresh array of fresh number arrays — a matrix of windows. - return.numbers: (field: string) => number[]; default: not declared — A FRESH array of finite numbers. Fresh matters: the previous `state['buf'] as number[]` aliased the caller's snapshot, so two streams restored from one snapshot object shared a buffer and corrupted each other. Restorers used to spell that defence themselves (`[...(state['buf'] as number[])]`) and could forget to. - return.numbersOrNull: (field: string) => number[] | null; default: not declared — A fresh array of finite numbers, or `null`. - return.optionalNumber: (field: string) => number | undefined; default: not declared — A number the state may omit entirely (an optional parameter a stream carries). - return.optionalNumbers: (field: string) => number[] | undefined; default: not declared — A fresh array of finite numbers the state may omit. - return.raw: Record; default: not declared — The raw state object. For a restorer that must hand a whole sub-object to a helper. - return.record: (field: string) => T; default: not declared — A structured record the indicator persists whole — a bar, a candle, an accumulator. Members are not walked: their shape is the indicator's own business and varies per record type. The check is that it IS a record, which is what separates a usable snapshot from `"acc"` or `7`. - return.recordOrNull: (field: string) => T | null; default: not declared — A structured record, or `null` when the indicator has not established one. - return.records: (field: string) => T[]; default: not declared — A fresh array of structured records — persisted bars, candles, levels. - return.text: (field: string) => string; default: not declared — A string. - text: (field: string) => string; default: not declared — A string. - text(field): string; default: not declared ### @insiderfinance/totalfinance/technical-analysis/framework#TechnicalAnalysisAssumptionExtras Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TechnicalAnalysisAssumptionExtras`. ### @insiderfinance/totalfinance/technical-analysis/framework#TechnicalAnalysisExplain Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TechnicalAnalysisExplain`. ### @insiderfinance/totalfinance/technical-analysis/framework#TechnicalAnalysisSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TechnicalAnalysisSnapshot`. ### @insiderfinance/totalfinance/technical-analysis/framework#bindIndicatorMetadata Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bind registration metadata onto a facade built by {@link makeIndicator} — the single choke point of the disclosure law: built-in leaves bind their shared private contracts at construction, and custom registry entries bind their declarations at registration. Every `.explain()` call echoes defaults merged under the caller's parameters. Also records the input kind so the batch facade can shape-check the first element (number series vs OHLC bars vs `{ x, y }` pairs). Later bindings merge over earlier ones, so an alias registration re-binding identical data is a no-op. ```typescript export declare function bindIndicatorMetadata(indicator: unknown, metadata: { defaults?: Record; inputs?: IndicatorInputKind; parameters?: readonly string[]; conventions?: IndicatorConventions; }): void; ``` @internal: — called by built-in construction and `registry.register`; not public API. Members/parameters (default = JSDoc only; not declared means no documented default): - (indicator): unknown; default: not declared - (metadata): { defaults?: Record; inputs?: IndicatorInputKind; parameters?: readonly string[]; conventions?: IndicatorConventions; }; default: not declared - (metadata).conventions?: Readonly>; default: not declared - (metadata).defaults?: Record; default: not declared - (metadata).inputs?: IndicatorInputKind; default: not declared - (metadata).parameters?: readonly string[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis/framework#checkSnapshotVersion Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#checkSnapshotVersion`. ### @insiderfinance/totalfinance/technical-analysis/framework#closes Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Map a column of bars to their close prices. ```typescript export declare function closes(bars: ArrayLike): number[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (bars): ArrayLike; default: not declared ### @insiderfinance/totalfinance/technical-analysis/framework#collect Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run a stream over a series, producing aligned output with a NaN sentinel during warmup. `warmup` is the index of the first non-warmup value (equal to the input length if it never emits). ```typescript export declare function collect(stream: IndicatorStream, input: ArrayLike, nan: Out): { value: Out[]; warmup: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ArrayLike; default: not declared - (nan): Out; default: not declared - (stream): IndicatorStream; default: not declared - (stream).next: (input: In) => Out | null; default: not declared - (stream).toJSON: () => TechnicalAnalysisSnapshot; default: not declared - (stream).value: Out | null; default: not declared - return.value: Out[]; default: not declared - return.warmup: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/framework#collectAsync Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#collectAsync`. ### @insiderfinance/totalfinance/technical-analysis/framework#makeIndicator Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build a facade indicator from a stream factory, a restorer, and a NaN-sentinel factory. `defaults` (when declared) are the indicator's industry-standard parameters, echoed through `.explain().assumptions.parameters` merged under the caller's parameters — the disclosure contract: a default that engages is a default that is disclosed. Built-in construction and custom registration bind the complete contract onto the same slot via {@link bindIndicatorMetadata}. ```typescript export declare function makeIndicator(make: (parameters: Params) => IndicatorStream, restore: (snapshot: TechnicalAnalysisSnapshot) => IndicatorStream, nan: (parameters: Params) => Out, defaults?: Record): Indicator; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (defaults)?: Record | undefined; default: not declared - (make): (parameters: Params) => IndicatorStream; default: not declared - (nan): (parameters: Params) => Out; default: not declared - (restore): (snapshot: TechnicalAnalysisSnapshot) => IndicatorStream; default: not declared - return.explain: (input: ArrayLike, parameters?: Params | undefined) => TechnicalAnalysisExplain; default: not declared - return.fromJSON: (snapshot: TechnicalAnalysisSnapshot) => LiveStream; default: not declared - return.stream: (parameters?: Params | undefined) => LiveStream; default: not declared ### @insiderfinance/totalfinance/technical-analysis/framework#readSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#readSnapshot`. ### @insiderfinance/totalfinance/technical-analysis/framework#snapshotOf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#snapshotOf`. ### @insiderfinance/totalfinance/technical-analysis/framework#streamAsync Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#streamAsync`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/macd ### @insiderfinance/totalfinance/technical-analysis/macd#MacdParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MacdParameters`. ### @insiderfinance/totalfinance/technical-analysis/macd#MacdPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MacdPoint`. ### @insiderfinance/totalfinance/technical-analysis/macd#MacdStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MacdStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MacdStream; value: MacdPoint | null; next(value: number): MacdPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; signal: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).signal: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MacdStream; default: not declared - fromJSON().return.next: (value: number) => MacdPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => MacdPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.macd: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => MacdPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MacdPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.macd: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MacdPoint | null; default: not declared - value.histogram: number; default: not declared - value.macd: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/macd#macd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#macd`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/math ### @insiderfinance/totalfinance/technical-analysis/math#BinaryMathStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BinaryMathStream implements IndicatorStream { constructor(parameters: { kind: string; combine: (x: number, y: number) => number; }); static restore(kind: string, operation: (x: number, y: number) => number): (s: TechnicalAnalysisSnapshot) => BinaryMathStream; value: number | null; next(pair: Pair): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; combine: (x: number, y: number) => number; }; default: not declared - (parameters).combine: (x: number, y: number) => number; default: not declared - (parameters).kind: string; default: not declared - next: (pair: Pair) => number | null; default: not declared - next(pair): Pair; default: not declared - next(pair).x: number; default: not declared - next(pair).y: number; default: not declared - restore: (kind: string, operation: (x: number, y: number) => number) => (s: TechnicalAnalysisSnapshot) => BinaryMathStream; default: not declared - restore(kind): string; default: not declared - restore(operation): (x: number, y: number) => number; default: not declared - return.next: (pair: Pair) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/math#CrossPairStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CrossPairStream implements IndicatorStream { constructor(parameters: { kind: CrossPairKind; mode: 'over' | 'any'; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CrossPairStream; value: number | null; next(pair: Pair): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: CrossPairKind; mode: 'over' | 'any'; }; default: not declared - (parameters).kind: 'crossany' | 'crossover'; default: not declared - (parameters).mode: 'any' | 'over'; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CrossPairStream; default: not declared - fromJSON().return.next: (pair: Pair) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (pair: Pair) => number | null; default: not declared - next(pair): Pair; default: not declared - next(pair).x: number; default: not declared - next(pair).y: number; default: not declared - return.next: (pair: Pair) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/math#UnaryMathStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class UnaryMathStream implements IndicatorStream { constructor(parameters: { kind: string; transform: (x: number) => number; }); static restore(kind: string, operation: (x: number) => number): (s: TechnicalAnalysisSnapshot) => UnaryMathStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; transform: (x: number) => number; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).transform: (x: number) => number; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (kind: string, operation: (x: number) => number) => (s: TechnicalAnalysisSnapshot) => UnaryMathStream; default: not declared - restore(kind): string; default: not declared - restore(operation): (x: number) => number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/math#acos Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#acos`. ### @insiderfinance/totalfinance/technical-analysis/math#add Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#add`. ### @insiderfinance/totalfinance/technical-analysis/math#asin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#asin`. ### @insiderfinance/totalfinance/technical-analysis/math#atan Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#atan`. ### @insiderfinance/totalfinance/technical-analysis/math#ceil Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ceil`. ### @insiderfinance/totalfinance/technical-analysis/math#cos Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cos`. ### @insiderfinance/totalfinance/technical-analysis/math#cosh Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cosh`. ### @insiderfinance/totalfinance/technical-analysis/math#crossany Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#crossany`. ### @insiderfinance/totalfinance/technical-analysis/math#crossover Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#crossover`. ### @insiderfinance/totalfinance/technical-analysis/math#div Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#div`. ### @insiderfinance/totalfinance/technical-analysis/math#exp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#exp`. ### @insiderfinance/totalfinance/technical-analysis/math#floor Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#floor`. ### @insiderfinance/totalfinance/technical-analysis/math#ln Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ln`. ### @insiderfinance/totalfinance/technical-analysis/math#log10 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#log10`. ### @insiderfinance/totalfinance/technical-analysis/math#mult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mult`. ### @insiderfinance/totalfinance/technical-analysis/math#sin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sin`. ### @insiderfinance/totalfinance/technical-analysis/math#sinh Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sinh`. ### @insiderfinance/totalfinance/technical-analysis/math#sqrt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sqrt`. ### @insiderfinance/totalfinance/technical-analysis/math#sub Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sub`. ### @insiderfinance/totalfinance/technical-analysis/math#tan Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tan`. ### @insiderfinance/totalfinance/technical-analysis/math#tanh Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tanh`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/microstructure ### @insiderfinance/totalfinance/technical-analysis/microstructure#AggressorMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AggressorMethod`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#BookImbalanceParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BookImbalanceParameters`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#BookImbalanceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Book-imbalance envelope (Law 2): the imbalance plus applied conventions and diagnostics. ```typescript /** Book-imbalance envelope (Law 2): the imbalance plus applied conventions and diagnostics. */ export interface BookImbalanceResult { /** Imbalance in [−1, 1], or null when the aggregated depth is zero (disclosed in diagnostics). */ value: number | null; /** Applied conventions, echoed — `levels` is the depth actually aggregated. */ assumptions: { conventionsVersion: string; levels: number; weighted: boolean; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; levels: number; weighted: boolean; }; default: not declared — Applied conventions, echoed — `levels` is the depth actually aggregated. - assumptions.conventionsVersion: string; default: not declared - assumptions.levels: number; default: not declared - assumptions.weighted: boolean; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - value: number | null; default: not declared — Imbalance in [−1, 1], or null when the aggregated depth is zero (disclosed in diagnostics). ### @insiderfinance/totalfinance/technical-analysis/microstructure#BookLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BookLevel`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#CvdAggregator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CvdAggregator`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#CvdParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CvdParameters`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#CvdResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CvdResult`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#FootprintBar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FootprintBar`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#FootprintBarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FootprintBarParameters`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#MicropriceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Microprice envelope (Law 2): the size-weighted mid plus conventions and diagnostics. ```typescript /** Microprice envelope (Law 2): the size-weighted mid plus conventions and diagnostics. */ export interface MicropriceResult { /** The size-weighted mid, or null when either side of the book is empty (disclosed). */ value: number | null; /** Applied conventions, echoed (Law 2 grammar). */ assumptions: { conventionsVersion: string; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - value: number | null; default: not declared — The size-weighted mid, or null when either side of the book is empty (disclosed). ### @insiderfinance/totalfinance/technical-analysis/microstructure#OrderBook Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#OrderBook`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#Quote Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Quote`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#SignContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SignContext`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#TickVolumeBin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TickVolumeBin`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#TickVolumeProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TickVolumeProfile`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#TickVolumeProfileParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TickVolumeProfileParameters`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#Trade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Trade`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#TradeDirection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type TradeDirection = -1 | 0 | 1; ``` ### @insiderfinance/totalfinance/technical-analysis/microstructure#TradeSignResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Aggressor-classification envelope (Law 2): the sign plus applied conventions and diagnostics. ```typescript /** Aggressor-classification envelope (Law 2): the sign plus applied conventions and diagnostics. */ export interface TradeSignResult { /** +1 buyer-initiated, −1 seller-initiated, 0 indeterminate (disclosed in diagnostics). */ value: TradeDirection; /** Applied conventions, echoed — `method` is the rule that actually resolved the sign. */ assumptions: { conventionsVersion: string; method: AggressorMethod; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: AggressorMethod; }; default: not declared — Applied conventions, echoed — `method` is the rule that actually resolved the sign. - assumptions.conventionsVersion: string; default: not declared - assumptions.method: AggressorMethod; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - value: TradeDirection; default: not declared — +1 buyer-initiated, −1 seller-initiated, 0 indeterminate (disclosed in diagnostics). ### @insiderfinance/totalfinance/technical-analysis/microstructure#bookImbalance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bookImbalance`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#cumulativeVolumeDelta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cumulativeVolumeDelta`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#footprintBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#footprintBars`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#microprice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#microprice`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#tickVolumeProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tickVolumeProfile`. ### @insiderfinance/totalfinance/technical-analysis/microstructure#tradeSign Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tradeSign`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/momentum ### @insiderfinance/totalfinance/technical-analysis/momentum#ApoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ApoParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#ApoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ApoStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ApoStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ApoStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#AwesomeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AwesomeParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#AwesomeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AwesomeStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AwesomeStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AwesomeStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#BiasStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BiasStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): BiasStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => BiasStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#BrarPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#BrarPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#BrarStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BrarStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): BrarStream; value: BrarPoint | null; next(bar: BarInput): BrarPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => BrarStream; default: not declared - fromJSON().return.next: (bar: BarInput) => BrarPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: BrarPoint | null; default: not declared - fromJSON().return.value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - fromJSON().return.value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => BrarPoint | null; default: not declared - next().return.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - next().return.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => BrarPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: BrarPoint | null; default: not declared - return.value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - return.value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: BrarPoint | null; default: not declared - value.popularityIndex: number; default: not declared — AR, the popularity index: `100 · Σ(high − open) / Σ(open − low)` over the window. Measures intraday strength against the open. - value.willingnessIndex: number; default: not declared — BR, the willingness index: `100 · Σmax(0, high − prevClose) / Σmax(0, prevClose − low)`. Measures strength against the PRIOR close, which is what distinguishes it from AR. ### @insiderfinance/totalfinance/technical-analysis/momentum#CciStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CciStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CciStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CciStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#CenterOfGravityStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CenterOfGravityStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CenterOfGravityStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CenterOfGravityStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#CmoParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface CmoParameters { /** Lookback. Defaults to 14; echoed via `.explain()`. */ period?: number; /** Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. */ talib?: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Lookback. Defaults to 14; echoed via `.explain()`. - talib?: boolean; default: not declared — Reproduce TA-Lib's Wilder-smoothed CMO (`2·RSI − 100`) instead of Chande's simple sums. ### @insiderfinance/totalfinance/technical-analysis/momentum#CmoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CmoStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CmoStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CmoStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#ConnorsRsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ConnorsRsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#ConnorsRsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ConnorsRsiStream implements IndicatorStream { constructor(parameters: { rsiPeriod: number; streakPeriod: number; rankPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ConnorsRsiStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rsiPeriod: number; streakPeriod: number; rankPeriod: number; }; default: not declared - (parameters).rankPeriod: number; default: not declared - (parameters).rsiPeriod: number; default: not declared - (parameters).streakPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ConnorsRsiStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#CoppockParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CoppockParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#CoppockStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CoppockStream implements IndicatorStream { constructor(parameters: { longRoc: number; shortRoc: number; wmaPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CoppockStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { longRoc: number; shortRoc: number; wmaPeriod: number; }; default: not declared - (parameters).longRoc: number; default: not declared - (parameters).shortRoc: number; default: not declared - (parameters).wmaPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CoppockStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#CtiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CtiStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CtiStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CtiStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#DpoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Detrended Price Oscillator, Pring's causal form: `close[t − shift] − SMA(close, period)[t]` with `shift = ⌊period/2⌋ + 1` (the same lag pandas-ta applies with `centered=True`, but resolved BACKWARD so no value depends on a future bar). The SMA needs `period` bars and the lagged close needs `shift + 1`, and for a very short period the SECOND is the binding one: `period ≤ 2` puts `close[t − shift]` outside a `period`-deep buffer, and indexing it produced `undefined − sma` = NaN for the whole series. The window is sized to `max(period, shift + 1)` so every period is well defined; for `period ≥ 3` (`shift + 1 ≤ period`) the warmup and every value are exactly as before. ```typescript export declare class DpoStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DpoStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DpoStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#EfficiencyRatioStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class EfficiencyRatioStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): EfficiencyRatioStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => EfficiencyRatioStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#ElderRayPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ElderRayPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#ElderRayStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ElderRayStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ElderRayStream; value: ElderRayPoint | null; next(bar: BarInput): ElderRayPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ElderRayStream; default: not declared - fromJSON().return.next: (bar: BarInput) => ElderRayPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ElderRayPoint | null; default: not declared - fromJSON().return.value.bear: number; default: not declared - fromJSON().return.value.bull: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => ElderRayPoint | null; default: not declared - next().return.bear: number; default: not declared - next().return.bull: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => ElderRayPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: ElderRayPoint | null; default: not declared - return.value.bear: number; default: not declared - return.value.bull: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: ElderRayPoint | null; default: not declared - value.bear: number; default: not declared - value.bull: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#FisherParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FisherParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#FisherPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FisherPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#FisherStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class FisherStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): FisherStream; value: FisherPoint | null; next(bar: BarInput): FisherPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => FisherStream; default: not declared - fromJSON().return.next: (bar: BarInput) => FisherPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: FisherPoint | null; default: not declared - fromJSON().return.value.fisher: number; default: not declared - fromJSON().return.value.trigger: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => FisherPoint | null; default: not declared - next().return.fisher: number; default: not declared - next().return.trigger: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => FisherPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: FisherPoint | null; default: not declared - return.value.fisher: number; default: not declared - return.value.trigger: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: FisherPoint | null; default: not declared - value.fisher: number; default: not declared - value.trigger: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#InertiaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#InertiaParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#InertiaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class InertiaStream implements IndicatorStream { constructor(parameters: { period: number; rviPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): InertiaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; rviPeriod: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).rviPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => InertiaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#KdjParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KdjParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#KdjPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KdjPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#KdjStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KdjStream implements IndicatorStream { constructor(parameters: { period: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KdjStream; value: KdjPoint | null; next(bar: BarInput): KdjPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; signal: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).signal: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KdjStream; default: not declared - fromJSON().return.next: (bar: BarInput) => KdjPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KdjPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.j: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => KdjPoint | null; default: not declared - next().return.d: number; default: not declared - next().return.j: number; default: not declared - next().return.k: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => KdjPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: KdjPoint | null; default: not declared - return.value.d: number; default: not declared - return.value.j: number; default: not declared - return.value.k: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: KdjPoint | null; default: not declared - value.d: number; default: not declared - value.j: number; default: not declared - value.k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#KstParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KstParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#KstPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KstPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#KstStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KstStream implements IndicatorStream { constructor(parameters: { rocPeriods: number[]; smaPeriods: number[]; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KstStream; value: KstPoint | null; next(value: number): KstPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rocPeriods: number[]; smaPeriods: number[]; signal: number; }; default: not declared - (parameters).rocPeriods: number[]; default: not declared - (parameters).signal: number; default: not declared - (parameters).smaPeriods: number[]; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KstStream; default: not declared - fromJSON().return.next: (value: number) => KstPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KstPoint | null; default: not declared - fromJSON().return.value.kst: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => KstPoint | null; default: not declared - next().return.kst: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => KstPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: KstPoint | null; default: not declared - return.value.kst: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: KstPoint | null; default: not declared - value.kst: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#LaguerreParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LaguerreParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#LaguerreRsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class LaguerreRsiStream implements IndicatorStream { constructor(gamma: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): LaguerreRsiStream; value: number | null; next(price: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (gamma): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => LaguerreRsiStream; default: not declared - fromJSON().return.next: (price: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (price: number) => number | null; default: not declared - next(price): number; default: not declared - return.next: (price: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#LinregOscStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class LinregOscStream implements IndicatorStream { constructor(parameters: { period: number; kind: string; useForecast: boolean; }); static restore(kind: string, useForecast: boolean): (s: TechnicalAnalysisSnapshot) => LinregOscStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; kind: string; useForecast: boolean; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).period: number; default: not declared - (parameters).useForecast: boolean; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (kind: string, useForecast: boolean) => (s: TechnicalAnalysisSnapshot) => LinregOscStream; default: not declared - restore(kind): string; default: not declared - restore(useForecast): boolean; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#MOVING_AVERAGE_TYPES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const MOVING_AVERAGE_TYPES: readonly MovingAverageType[]; ``` ### @insiderfinance/totalfinance/technical-analysis/momentum#MacdExtParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MacdExtParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#MacdExtStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MacdExtStream implements IndicatorStream { constructor(__0: { fast: IndicatorStream; slow: IndicatorStream; signalMovingAverage: IndicatorStream; fastType: MovingAverageType; slowType: MovingAverageType; signalType: MovingAverageType; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MacdExtStream; value: MacdPoint | null; next(value: number): MacdPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (__0): { fast: IndicatorStream; slow: IndicatorStream; signalMovingAverage: IndicatorStream; fastType: MovingAverageType; slowType: MovingAverageType; signalType: MovingAverageType; }; default: not declared - (__0).fast: IndicatorStream; default: not declared - (__0).fastType: MovingAverageType; default: not declared - (__0).signalMovingAverage: IndicatorStream; default: not declared - (__0).signalType: MovingAverageType; default: not declared - (__0).slow: IndicatorStream; default: not declared - (__0).slowType: MovingAverageType; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MacdExtStream; default: not declared - fromJSON().return.next: (value: number) => MacdPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => MacdPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.macd: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => MacdPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MacdPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.macd: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MacdPoint | null; default: not declared - value.histogram: number; default: not declared - value.macd: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#MacdFixParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MacdFixParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#MovingAverageType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MovingAverageType`. ### @insiderfinance/totalfinance/technical-analysis/momentum#PeriodParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── CMO (Chande Momentum Oscillator) ───────────────────────── export interface PeriodParameters { period: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#PgoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PgoStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PgoStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PgoStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#PpoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PpoParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#PpoPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PpoPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#PpoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PpoStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PpoStream; value: PpoPoint | null; next(value: number): PpoPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; signal: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).signal: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PpoStream; default: not declared - fromJSON().return.next: (value: number) => PpoPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PpoPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.ppo: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => PpoPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.ppo: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => PpoPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: PpoPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.ppo: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: PpoPoint | null; default: not declared - value.histogram: number; default: not declared - value.ppo: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#ProjectionOscillatorStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ProjectionOscillatorStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ProjectionOscillatorStream; value: ProjectionPoint | null; next(bar: BarInput): ProjectionPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ProjectionOscillatorStream; default: not declared - fromJSON().return.next: (bar: BarInput) => ProjectionPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ProjectionPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.po: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => ProjectionPoint | null; default: not declared - next().return.lower: number; default: not declared - next().return.po: number; default: not declared - next().return.upper: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => ProjectionPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: ProjectionPoint | null; default: not declared - return.value.lower: number; default: not declared - return.value.po: number; default: not declared - return.value.upper: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: ProjectionPoint | null; default: not declared - value.lower: number; default: not declared - value.po: number; default: not declared - value.upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#ProjectionPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ProjectionPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#PsychologicalLineStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PsychologicalLineStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PsychologicalLineStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PsychologicalLineStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#PvoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PvoParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#PvoPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PvoPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#PvoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PvoStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PvoStream; value: PvoPoint | null; next(bar: BarInput): PvoPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; signal: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).signal: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PvoStream; default: not declared - fromJSON().return.next: (bar: BarInput) => PvoPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PvoPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.pvo: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => PvoPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.pvo: number; default: not declared - next().return.signal: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => PvoPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: PvoPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.pvo: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: PvoPoint | null; default: not declared - value.histogram: number; default: not declared - value.pvo: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#QqeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#QqeParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#QqePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#QqePoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#QqeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class QqeStream implements IndicatorStream { constructor(parameters: { rsiPeriod: number; smooth: number; factor: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): QqeStream; value: QqePoint | null; next(value: number): QqePoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rsiPeriod: number; smooth: number; factor: number; }; default: not declared - (parameters).factor: number; default: not declared - (parameters).rsiPeriod: number; default: not declared - (parameters).smooth: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => QqeStream; default: not declared - fromJSON().return.next: (value: number) => QqePoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: QqePoint | null; default: not declared - fromJSON().return.value.longBand: number; default: not declared - fromJSON().return.value.rsiMovingAverage: number; default: not declared - fromJSON().return.value.shortBand: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => QqePoint | null; default: not declared - next().return.longBand: number; default: not declared - next().return.rsiMovingAverage: number; default: not declared - next().return.shortBand: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => QqePoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: QqePoint | null; default: not declared - return.value.longBand: number; default: not declared - return.value.rsiMovingAverage: number; default: not declared - return.value.shortBand: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: QqePoint | null; default: not declared - value.longBand: number; default: not declared - value.rsiMovingAverage: number; default: not declared - value.shortBand: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#RocParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RocParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#RocStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RocStream implements IndicatorStream { constructor(parameters: { period: number; mode: RocMode; }); static restore(mode: RocMode): (s: TechnicalAnalysisSnapshot) => RocStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; mode: RocMode; }; default: not declared - (parameters).mode: RocMode; default: not declared - (parameters).period: number; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (mode: RocMode) => (s: TechnicalAnalysisSnapshot) => RocStream; default: not declared - restore(mode): RocMode; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#RsxStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Jurik RSX — the cascaded double-smoother momentum/|momentum| ratio mapped to [0, 100]. Uses the canonical Jurik filter cascade; the reference's f88/f90 warmup counter is replaced by the framework warmup (emits once `period` bars have been seen). ```typescript export declare class RsxStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RsxStream; value: number | null; next(price: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RsxStream; default: not declared - fromJSON().return.next: (price: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (price: number) => number | null; default: not declared - next(price): number; default: not declared - return.next: (price: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#RvgiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RvgiPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#RvgiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RvgiStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RvgiStream; value: RvgiPoint | null; next(bar: BarInput): RvgiPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RvgiStream; default: not declared - fromJSON().return.next: (bar: BarInput) => RvgiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: RvgiPoint | null; default: not declared - fromJSON().return.value.rvi: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => RvgiPoint | null; default: not declared - next().return.rvi: number; default: not declared - next().return.signal: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => RvgiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: RvgiPoint | null; default: not declared - return.value.rvi: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: RvgiPoint | null; default: not declared - value.rvi: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#SchaffTrendCycleStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SchaffTrendCycleStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; cycle: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SchaffTrendCycleStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; cycle: number; }; default: not declared - (parameters).cycle: number; default: not declared - (parameters).fast: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SchaffTrendCycleStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#SlopeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SlopeStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SlopeStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SlopeStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#SmiErgodicStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SmiErgodicStream implements IndicatorStream { constructor(parameters: { long: number; short: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SmiErgodicStream; value: SmiPoint | null; next(value: number): SmiPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { long: number; short: number; signal: number; }; default: not declared - (parameters).long: number; default: not declared - (parameters).short: number; default: not declared - (parameters).signal: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SmiErgodicStream; default: not declared - fromJSON().return.next: (value: number) => SmiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SmiPoint | null; default: not declared - fromJSON().return.value.oscillator: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.smi: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => SmiPoint | null; default: not declared - next().return.oscillator: number; default: not declared - next().return.signal: number; default: not declared - next().return.smi: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => SmiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: SmiPoint | null; default: not declared - return.value.oscillator: number; default: not declared - return.value.signal: number; default: not declared - return.value.smi: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: SmiPoint | null; default: not declared - value.oscillator: number; default: not declared - value.signal: number; default: not declared - value.smi: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#SmiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SmiParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#SmiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SmiPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezeCore Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared Bollinger-inside-Keltner squeeze machinery + the LazyBear momentum histogram. ```typescript export declare class SqueezeCore { constructor(parameters: { bollingerBandPeriod: number; bollingerStandardDeviations: number; keltnerChannelPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SqueezeCore; readonly bollingerBandPeriod: number; readonly bollingerStandardDeviations: number; readonly keltnerChannelPeriod: number; update(bar: BarInput): { upperBollingerBand: number; lowerBollingerBand: number; keltnerChannelMiddle: number; keltnerChannelRange: number; momentum: number; } | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { bollingerBandPeriod: number; bollingerStandardDeviations: number; keltnerChannelPeriod: number; }; default: not declared - (parameters).bollingerBandPeriod: number; default: not declared - (parameters).bollingerStandardDeviations: number; default: not declared - (parameters).keltnerChannelPeriod: number; default: not declared - bollingerBandPeriod: number; default: not declared - bollingerStandardDeviations: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SqueezeCore; default: not declared - fromJSON().return.bollingerBandPeriod: number; default: not declared - fromJSON().return.bollingerStandardDeviations: number; default: not declared - fromJSON().return.keltnerChannelPeriod: number; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.update: (bar: BarInput) => { upperBollingerBand: number; lowerBollingerBand: number; keltnerChannelMiddle: number; keltnerChannelRange: number; momentum: number; } | null; default: not declared — Returns null until both bands and the momentum regression are warm. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - keltnerChannelPeriod: number; default: not declared - return.bollingerBandPeriod: number; default: not declared - return.bollingerStandardDeviations: number; default: not declared - return.keltnerChannelPeriod: number; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.update: (bar: BarInput) => { upperBollingerBand: number; lowerBollingerBand: number; keltnerChannelMiddle: number; keltnerChannelRange: number; momentum: number; } | null; default: not declared — Returns null until both bands and the momentum regression are warm. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - update: (bar: BarInput) => { upperBollingerBand: number; lowerBollingerBand: number; keltnerChannelMiddle: number; keltnerChannelRange: number; momentum: number; } | null; default: not declared — Returns null until both bands and the momentum regression are warm. - update().return.keltnerChannelMiddle: number; default: not declared - update().return.keltnerChannelRange: number; default: not declared - update().return.lowerBollingerBand: number; default: not declared - update().return.momentum: number; default: not declared - update().return.upperBollingerBand: number; default: not declared - update(bar): BarInput; default: not declared - update(bar).close: number; default: not declared - update(bar).high: number; default: not declared - update(bar).low: number; default: not declared - update(bar).open?: number; default: not declared - update(bar).volume?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SqueezeParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SqueezePoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezeProParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SqueezeProParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezeProPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SqueezeProPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezeProStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SqueezeProStream implements IndicatorStream { constructor(parameters: { bollingerBandPeriod: number; bollingerStandardDeviations: number; keltnerChannelPeriod: number; wideKeltnerChannelMultiplier: number; normalKeltnerChannelMultiplier: number; narrowKeltnerChannelMultiplier: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SqueezeProStream; value: SqueezeProPoint | null; next(bar: BarInput): SqueezeProPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { bollingerBandPeriod: number; bollingerStandardDeviations: number; keltnerChannelPeriod: number; wideKeltnerChannelMultiplier: number; normalKeltnerChannelMultiplier: number; narrowKeltnerChannelMultiplier: number; }; default: not declared - (parameters).bollingerBandPeriod: number; default: not declared - (parameters).bollingerStandardDeviations: number; default: not declared - (parameters).keltnerChannelPeriod: number; default: not declared - (parameters).narrowKeltnerChannelMultiplier: number; default: not declared - (parameters).normalKeltnerChannelMultiplier: number; default: not declared - (parameters).wideKeltnerChannelMultiplier: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SqueezeProStream; default: not declared - fromJSON().return.next: (bar: BarInput) => SqueezeProPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SqueezeProPoint | null; default: not declared - fromJSON().return.value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - fromJSON().return.value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - fromJSON().return.value.momentum: number; default: not declared - fromJSON().return.value.normalCompression: number; default: not declared — Normal compression. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => SqueezeProPoint | null; default: not declared - next().return.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - next().return.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - next().return.momentum: number; default: not declared - next().return.normalCompression: number; default: not declared — Normal compression. - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => SqueezeProPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: SqueezeProPoint | null; default: not declared - return.value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - return.value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - return.value.momentum: number; default: not declared - return.value.normalCompression: number; default: not declared — Normal compression. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: SqueezeProPoint | null; default: not declared - value.highCompression: number; default: not declared — Tightest compression (BB inside KC×narrowKeltnerChannelMultiplier). - value.lowCompression: number; default: not declared — Loosest compression (BB inside KC×wideKeltnerChannelMultiplier). - value.momentum: number; default: not declared - value.normalCompression: number; default: not declared — Normal compression. ### @insiderfinance/totalfinance/technical-analysis/momentum#SqueezeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SqueezeStream implements IndicatorStream { constructor(parameters: { bollingerBandPeriod: number; bollingerStandardDeviations: number; keltnerChannelPeriod: number; keltnerChannelMultiplier: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SqueezeStream; value: SqueezePoint | null; next(bar: BarInput): SqueezePoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { bollingerBandPeriod: number; bollingerStandardDeviations: number; keltnerChannelPeriod: number; keltnerChannelMultiplier: number; }; default: not declared - (parameters).bollingerBandPeriod: number; default: not declared - (parameters).bollingerStandardDeviations: number; default: not declared - (parameters).keltnerChannelMultiplier: number; default: not declared - (parameters).keltnerChannelPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SqueezeStream; default: not declared - fromJSON().return.next: (bar: BarInput) => SqueezePoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SqueezePoint | null; default: not declared - fromJSON().return.value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - fromJSON().return.value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => SqueezePoint | null; default: not declared - next().return.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - next().return.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => SqueezePoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: SqueezePoint | null; default: not declared - return.value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - return.value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: SqueezePoint | null; default: not declared - value.momentum: number; default: not declared — LazyBear squeeze momentum histogram. - value.on: number; default: not declared — 1 when the Bollinger Bands sit inside the Keltner Channel (squeeze on), else 0. ### @insiderfinance/totalfinance/technical-analysis/momentum#StcParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StcParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#StochRsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StochRsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#StochRsiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StochRsiPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#StochRsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class StochRsiStream implements IndicatorStream { constructor(parameters: { rsiPeriod: number; stochPeriod: number; kPeriod: number; dPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): StochRsiStream; value: StochRsiPoint | null; next(value: number): StochRsiPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rsiPeriod: number; stochPeriod: number; kPeriod: number; dPeriod: number; }; default: not declared - (parameters).dPeriod: number; default: not declared - (parameters).kPeriod: number; default: not declared - (parameters).rsiPeriod: number; default: not declared - (parameters).stochPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => StochRsiStream; default: not declared - fromJSON().return.next: (value: number) => StochRsiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochRsiPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => StochRsiPoint | null; default: not declared - next().return.d: number; default: not declared - next().return.k: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => StochRsiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: StochRsiPoint | null; default: not declared - return.value.d: number; default: not declared - return.value.k: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: StochRsiPoint | null; default: not declared - value.d: number; default: not declared - value.k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#TdSequentialParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TdSequentialParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#TdSequentialPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TdSequentialPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#TdSequentialStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Core TD Sequential: the price-flip setup (1–9) and a basic countdown (1–13). This implements the essential setup/countdown signal, not the full DeMark ruleset (no perfection / cancellation / deferral qualifiers). ```typescript export declare class TdSequentialStream implements IndicatorStream { constructor(lookback: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TdSequentialStream; value: TdSequentialPoint | null; next(bar: BarInput): TdSequentialPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (lookback): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TdSequentialStream; default: not declared - fromJSON().return.next: (bar: BarInput) => TdSequentialPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TdSequentialPoint | null; default: not declared - fromJSON().return.value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - fromJSON().return.value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - fromJSON().return.value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => TdSequentialPoint | null; default: not declared - next().return.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - next().return.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - next().return.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => TdSequentialPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: TdSequentialPoint | null; default: not declared - return.value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - return.value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - return.value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: TdSequentialPoint | null; default: not declared - value.countdown: number; default: not declared — Active countdown count, 1–13 (0 if none). - value.direction: number; default: not declared — +1 sell side (price strength), −1 buy side (price weakness), 0 none. - value.setup: number; default: not declared — Active setup count, 1–9 (0 if none). ### @insiderfinance/totalfinance/technical-analysis/momentum#TrixHistogramParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TrixHistogramParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#TrixHistogramPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TrixHistogramPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#TrixHistogramStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TrixHistogramStream implements IndicatorStream { constructor(parameters: { period: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrixHistogramStream; value: TrixHistogramPoint | null; next(value: number): TrixHistogramPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; signal: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).signal: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TrixHistogramStream; default: not declared - fromJSON().return.next: (value: number) => TrixHistogramPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TrixHistogramPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.trix: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => TrixHistogramPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.signal: number; default: not declared - next().return.trix: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => TrixHistogramPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: TrixHistogramPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.signal: number; default: not declared - return.value.trix: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: TrixHistogramPoint | null; default: not declared - value.histogram: number; default: not declared - value.signal: number; default: not declared - value.trix: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#TrixStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TrixStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrixStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TrixStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#TsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#TsiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TsiPoint`. ### @insiderfinance/totalfinance/technical-analysis/momentum#TsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TsiStream implements IndicatorStream { constructor(parameters: { long: number; short: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TsiStream; value: TsiPoint | null; next(value: number): TsiPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { long: number; short: number; signal: number; }; default: not declared - (parameters).long: number; default: not declared - (parameters).short: number; default: not declared - (parameters).signal: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TsiStream; default: not declared - fromJSON().return.next: (value: number) => TsiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TsiPoint | null; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.tsi: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => TsiPoint | null; default: not declared - next().return.signal: number; default: not declared - next().return.tsi: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => TsiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: TsiPoint | null; default: not declared - return.value.signal: number; default: not declared - return.value.tsi: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: TsiPoint | null; default: not declared - value.signal: number; default: not declared - value.tsi: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#UltimateParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#UltimateParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#UltimateStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class UltimateStream implements IndicatorStream { constructor(parameters: { short: number; medium: number; long: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): UltimateStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { short: number; medium: number; long: number; }; default: not declared - (parameters).long: number; default: not declared - (parameters).medium: number; default: not declared - (parameters).short: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => UltimateStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#VolumeWeightedMacdStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VolumeWeightedMacdStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VolumeWeightedMacdStream; value: MacdPoint | null; next(bar: BarInput): MacdPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; signal: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).signal: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VolumeWeightedMacdStream; default: not declared - fromJSON().return.next: (bar: BarInput) => MacdPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => MacdPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.macd: number; default: not declared - next().return.signal: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => MacdPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MacdPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.macd: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MacdPoint | null; default: not declared - value.histogram: number; default: not declared - value.macd: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#VwMacdParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VwMacdParameters`. ### @insiderfinance/totalfinance/technical-analysis/momentum#WilliamsRStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class WilliamsRStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): WilliamsRStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => WilliamsRStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/momentum#apo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#apo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#awesomeOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#awesomeOscillator`. ### @insiderfinance/totalfinance/technical-analysis/momentum#bias Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bias`. ### @insiderfinance/totalfinance/technical-analysis/momentum#brar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#brar`. ### @insiderfinance/totalfinance/technical-analysis/momentum#cci Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cci`. ### @insiderfinance/totalfinance/technical-analysis/momentum#centerOfGravity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#centerOfGravity`. ### @insiderfinance/totalfinance/technical-analysis/momentum#cfo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cfo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#cmo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cmo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#connorsRsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#connorsRsi`. ### @insiderfinance/totalfinance/technical-analysis/momentum#coppock Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#coppock`. ### @insiderfinance/totalfinance/technical-analysis/momentum#cti Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cti`. ### @insiderfinance/totalfinance/technical-analysis/momentum#dpo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dpo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#efficiencyRatio Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#efficiencyRatio`. ### @insiderfinance/totalfinance/technical-analysis/momentum#elderRay Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#elderRay`. ### @insiderfinance/totalfinance/technical-analysis/momentum#fisherTransform Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fisherTransform`. ### @insiderfinance/totalfinance/technical-analysis/momentum#forecastOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#forecastOscillator`. ### @insiderfinance/totalfinance/technical-analysis/momentum#inertia Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#inertia`. ### @insiderfinance/totalfinance/technical-analysis/momentum#kdj Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kdj`. ### @insiderfinance/totalfinance/technical-analysis/momentum#kst Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kst`. ### @insiderfinance/totalfinance/technical-analysis/momentum#laguerreRsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#laguerreRsi`. ### @insiderfinance/totalfinance/technical-analysis/momentum#macd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#macd`. ### @insiderfinance/totalfinance/technical-analysis/momentum#macdExt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#macdExt`. ### @insiderfinance/totalfinance/technical-analysis/momentum#macdFix Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#macdFix`. ### @insiderfinance/totalfinance/technical-analysis/momentum#momentum Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#momentum`. ### @insiderfinance/totalfinance/technical-analysis/momentum#pgo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pgo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#ppo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ppo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#projectionOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#projectionOscillator`. ### @insiderfinance/totalfinance/technical-analysis/momentum#psychologicalLine Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#psychologicalLine`. ### @insiderfinance/totalfinance/technical-analysis/momentum#pvo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pvo`. ### @insiderfinance/totalfinance/technical-analysis/momentum#qqe Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#qqe`. ### @insiderfinance/totalfinance/technical-analysis/momentum#relativeVigorIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#relativeVigorIndex`. ### @insiderfinance/totalfinance/technical-analysis/momentum#roc Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#roc`. ### @insiderfinance/totalfinance/technical-analysis/momentum#rocp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rocp`. ### @insiderfinance/totalfinance/technical-analysis/momentum#rocr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rocr`. ### @insiderfinance/totalfinance/technical-analysis/momentum#rocr100 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rocr100`. ### @insiderfinance/totalfinance/technical-analysis/momentum#rsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rsi`. ### @insiderfinance/totalfinance/technical-analysis/momentum#rsx Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rsx`. ### @insiderfinance/totalfinance/technical-analysis/momentum#schaffTrendCycle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#schaffTrendCycle`. ### @insiderfinance/totalfinance/technical-analysis/momentum#slope Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#slope`. ### @insiderfinance/totalfinance/technical-analysis/momentum#smiErgodic Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#smiErgodic`. ### @insiderfinance/totalfinance/technical-analysis/momentum#squeeze Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#squeeze`. ### @insiderfinance/totalfinance/technical-analysis/momentum#squeezePro Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#squeezePro`. ### @insiderfinance/totalfinance/technical-analysis/momentum#stochRsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#stochRsi`. ### @insiderfinance/totalfinance/technical-analysis/momentum#tdSequential Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tdSequential`. ### @insiderfinance/totalfinance/technical-analysis/momentum#trix Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trix`. ### @insiderfinance/totalfinance/technical-analysis/momentum#trixHistogram Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trixHistogram`. ### @insiderfinance/totalfinance/technical-analysis/momentum#tsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tsi`. ### @insiderfinance/totalfinance/technical-analysis/momentum#ultimateOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ultimateOscillator`. ### @insiderfinance/totalfinance/technical-analysis/momentum#volumeWeightedMacd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volumeWeightedMacd`. ### @insiderfinance/totalfinance/technical-analysis/momentum#williamsR Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#williamsR`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/moving-averages ### @insiderfinance/totalfinance/technical-analysis/moving-averages#AlmaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AlmaParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#AlmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AlmaStream implements IndicatorStream { constructor(parameters: { period: number; offset: number; sigma: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AlmaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; offset: number; sigma: number; }; default: not declared - (parameters).offset: number; default: not declared - (parameters).period: number; default: not declared - (parameters).sigma: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AlmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#AnchoredVwapParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AnchoredVwapParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#AnchoredVwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AnchoredVwapStream implements IndicatorStream { constructor(anchor: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AnchoredVwapStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (anchor): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AnchoredVwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#DemaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DemaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DemaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DemaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#EmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class EmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): EmaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => EmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#FramaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FramaParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#FramaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class FramaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): FramaStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => FramaStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#HmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HmaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#KamaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KamaParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#KamaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KamaStream implements IndicatorStream { constructor(parameters: { period: number; fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KamaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).period: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KamaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#MamaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MamaParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#MamaPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MamaPoint`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#MamaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MamaStream implements IndicatorStream { constructor(parameters: { fastLimit: number; slowLimit: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MamaStream; value: MamaPoint | null; next(bar: BarInput): MamaPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fastLimit: number; slowLimit: number; }; default: not declared - (parameters).fastLimit: number; default: not declared - (parameters).slowLimit: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MamaStream; default: not declared - fromJSON().return.next: (bar: BarInput) => MamaPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MamaPoint | null; default: not declared - fromJSON().return.value.fama: number; default: not declared - fromJSON().return.value.mama: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => MamaPoint | null; default: not declared - next().return.fama: number; default: not declared - next().return.mama: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => MamaPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MamaPoint | null; default: not declared - return.value.fama: number; default: not declared - return.value.mama: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MamaPoint | null; default: not declared - value.fama: number; default: not declared - value.mama: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#McGinleyStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). McGinley Dynamic (John R. McGinley) — an EMA-like average whose smoothing constant self-adjusts by the ratio of price to the current average, so it speeds up in fast markets and slows in quiet ones. Registered as `mcginley`; pandas-ta calls it `mcgd`. ```typescript export declare class McGinleyStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): McGinleyStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => McGinleyStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#PeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#RmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RmaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#RollingVwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RollingVwapStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RollingVwapStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RollingVwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#SmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SmaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#SuperSmootherStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SuperSmootherStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SuperSmootherStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SuperSmootherStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#T3Parameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#T3Parameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#T3Stream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class T3Stream implements IndicatorStream { constructor(parameters: { period: number; volumeFactor: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): T3Stream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; volumeFactor: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).volumeFactor: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => T3Stream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#TemaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TemaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TemaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TemaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#TrimaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TrimaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrimaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TrimaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#VidyaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VidyaParameters`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#VidyaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VidyaStream implements IndicatorStream { constructor(parameters: { period: number; cmoPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VidyaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; cmoPeriod: number; }; default: not declared - (parameters).cmoPeriod: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VidyaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#VwmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VwmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VwmaStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VwmaStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#WmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class WmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): WmaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => WmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#ZlemaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ZlemaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ZlemaStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ZlemaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/moving-averages#alma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#alma`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#anchoredVwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#anchoredVwap`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#dema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dema`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#ema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ema`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#frama Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#frama`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#hma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#hma`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#kama Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kama`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#mama Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mama`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#mcginley Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mcginley`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#rma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rma`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#rollingVwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingVwap`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#sma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sma`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#superSmoother Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#superSmoother`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#t3 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#t3`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#tema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tema`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#trima Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trima`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#vidya Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vidya`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#vwma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vwma`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#wma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#wma`. ### @insiderfinance/totalfinance/technical-analysis/moving-averages#zlema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#zlema`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/oscillators ### @insiderfinance/totalfinance/technical-analysis/oscillators#ApoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ApoParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#ApoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ApoStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ApoStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ApoStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#AwesomeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AwesomeParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#AwesomeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AwesomeStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AwesomeStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AwesomeStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#CciStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CciStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CciStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CciStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#CmoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis/momentum#CmoParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#CmoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CmoStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CmoStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CmoStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#ConnorsRsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ConnorsRsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#ConnorsRsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ConnorsRsiStream implements IndicatorStream { constructor(parameters: { rsiPeriod: number; streakPeriod: number; rankPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ConnorsRsiStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rsiPeriod: number; streakPeriod: number; rankPeriod: number; }; default: not declared - (parameters).rankPeriod: number; default: not declared - (parameters).rsiPeriod: number; default: not declared - (parameters).streakPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ConnorsRsiStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#DpoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Detrended Price Oscillator, Pring's causal form: `close[t − shift] − SMA(close, period)[t]` with `shift = ⌊period/2⌋ + 1` (the same lag pandas-ta applies with `centered=True`, but resolved BACKWARD so no value depends on a future bar). The SMA needs `period` bars and the lagged close needs `shift + 1`, and for a very short period the SECOND is the binding one: `period ≤ 2` puts `close[t − shift]` outside a `period`-deep buffer, and indexing it produced `undefined − sma` = NaN for the whole series. The window is sized to `max(period, shift + 1)` so every period is well defined; for `period ≥ 3` (`shift + 1 ≤ period`) the warmup and every value are exactly as before. ```typescript export declare class DpoStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DpoStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DpoStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#FisherParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FisherParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#FisherPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FisherPoint`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#FisherStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class FisherStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): FisherStream; next(bar: BarInput): FisherPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: FisherPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => FisherStream; default: not declared - fromJSON().return.next: (bar: BarInput) => FisherPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: FisherPoint | null; default: not declared - fromJSON().return.value.fisher: number; default: not declared - fromJSON().return.value.trigger: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => FisherPoint | null; default: not declared - next().return.fisher: number; default: not declared - next().return.trigger: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => FisherPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: FisherPoint | null; default: not declared - return.value.fisher: number; default: not declared - return.value.trigger: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: FisherPoint | null; default: not declared - value.fisher: number; default: not declared - value.trigger: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#KstParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KstParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#KstPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KstPoint`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#KstStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KstStream implements IndicatorStream { constructor(parameters: { rocPeriods: number[]; smaPeriods: number[]; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KstStream; next(value: number): KstPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: KstPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rocPeriods: number[]; smaPeriods: number[]; signal: number; }; default: not declared - (parameters).rocPeriods: number[]; default: not declared - (parameters).signal: number; default: not declared - (parameters).smaPeriods: number[]; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KstStream; default: not declared - fromJSON().return.next: (value: number) => KstPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KstPoint | null; default: not declared - fromJSON().return.value.kst: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => KstPoint | null; default: not declared - next().return.kst: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => KstPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: KstPoint | null; default: not declared - return.value.kst: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: KstPoint | null; default: not declared - value.kst: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#MOVING_AVERAGE_TYPES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis/momentum#MOVING_AVERAGE_TYPES`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#MacdExtParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MacdExtParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#MacdExtStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MacdExtStream implements IndicatorStream { constructor(__0: { fast: IndicatorStream; slow: IndicatorStream; signalMovingAverage: IndicatorStream; fastType: MovingAverageType; slowType: MovingAverageType; signalType: MovingAverageType; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MacdExtStream; next(value: number): MacdPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: MacdPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (__0): { fast: IndicatorStream; slow: IndicatorStream; signalMovingAverage: IndicatorStream; fastType: MovingAverageType; slowType: MovingAverageType; signalType: MovingAverageType; }; default: not declared - (__0).fast: IndicatorStream; default: not declared - (__0).fastType: MovingAverageType; default: not declared - (__0).signalMovingAverage: IndicatorStream; default: not declared - (__0).signalType: MovingAverageType; default: not declared - (__0).slow: IndicatorStream; default: not declared - (__0).slowType: MovingAverageType; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MacdExtStream; default: not declared - fromJSON().return.next: (value: number) => MacdPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MacdPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.macd: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => MacdPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.macd: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => MacdPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MacdPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.macd: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MacdPoint | null; default: not declared - value.histogram: number; default: not declared - value.macd: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#MacdFixParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MacdFixParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#MovingAverageType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MovingAverageType`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#PeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis/momentum#PeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#PpoParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PpoParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#PpoPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PpoPoint`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#PpoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PpoStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PpoStream; next(value: number): PpoPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: PpoPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; signal: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).signal: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PpoStream; default: not declared - fromJSON().return.next: (value: number) => PpoPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PpoPoint | null; default: not declared - fromJSON().return.value.histogram: number; default: not declared - fromJSON().return.value.ppo: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => PpoPoint | null; default: not declared - next().return.histogram: number; default: not declared - next().return.ppo: number; default: not declared - next().return.signal: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => PpoPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: PpoPoint | null; default: not declared - return.value.histogram: number; default: not declared - return.value.ppo: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: PpoPoint | null; default: not declared - value.histogram: number; default: not declared - value.ppo: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#RocParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RocParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#RocStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RocStream implements IndicatorStream { constructor(parameters: { period: number; mode: RocMode; }); static restore(mode: RocMode): (s: TechnicalAnalysisSnapshot) => RocStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; mode: RocMode; }; default: not declared - (parameters).mode: RocMode; default: not declared - (parameters).period: number; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (mode: RocMode) => (s: TechnicalAnalysisSnapshot) => RocStream; default: not declared - restore(mode): RocMode; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#StochRsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StochRsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#StochRsiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StochRsiPoint`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#StochRsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class StochRsiStream implements IndicatorStream { constructor(parameters: { rsiPeriod: number; stochPeriod: number; kPeriod: number; dPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): StochRsiStream; next(value: number): StochRsiPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: StochRsiPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { rsiPeriod: number; stochPeriod: number; kPeriod: number; dPeriod: number; }; default: not declared - (parameters).dPeriod: number; default: not declared - (parameters).kPeriod: number; default: not declared - (parameters).rsiPeriod: number; default: not declared - (parameters).stochPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => StochRsiStream; default: not declared - fromJSON().return.next: (value: number) => StochRsiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: StochRsiPoint | null; default: not declared - fromJSON().return.value.d: number; default: not declared - fromJSON().return.value.k: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => StochRsiPoint | null; default: not declared - next().return.d: number; default: not declared - next().return.k: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => StochRsiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: StochRsiPoint | null; default: not declared - return.value.d: number; default: not declared - return.value.k: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: StochRsiPoint | null; default: not declared - value.d: number; default: not declared - value.k: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#TrixStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TrixStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrixStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TrixStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#TsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#TsiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TsiPoint`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#TsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TsiStream implements IndicatorStream { constructor(parameters: { long: number; short: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TsiStream; next(value: number): TsiPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: TsiPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { long: number; short: number; signal: number; }; default: not declared - (parameters).long: number; default: not declared - (parameters).short: number; default: not declared - (parameters).signal: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TsiStream; default: not declared - fromJSON().return.next: (value: number) => TsiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: TsiPoint | null; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON().return.value.tsi: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => TsiPoint | null; default: not declared - next().return.signal: number; default: not declared - next().return.tsi: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => TsiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: TsiPoint | null; default: not declared - return.value.signal: number; default: not declared - return.value.tsi: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: TsiPoint | null; default: not declared - value.signal: number; default: not declared - value.tsi: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#UltimateParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#UltimateParameters`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#UltimateStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class UltimateStream implements IndicatorStream { constructor(parameters: { short: number; medium: number; long: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): UltimateStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { short: number; medium: number; long: number; }; default: not declared - (parameters).long: number; default: not declared - (parameters).medium: number; default: not declared - (parameters).short: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => UltimateStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#WilliamsRStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class WilliamsRStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): WilliamsRStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => WilliamsRStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/oscillators#apo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#apo`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#awesomeOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#awesomeOscillator`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#cci Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cci`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#cmo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cmo`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#connorsRsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#connorsRsi`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#dpo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dpo`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#fisherTransform Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fisherTransform`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#kst Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kst`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#macdExt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#macdExt`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#macdFix Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#macdFix`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#momentum Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#momentum`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#ppo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ppo`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#roc Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#roc`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#rocp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rocp`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#rocr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rocr`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#rocr100 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rocr100`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#stochRsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#stochRsi`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#trix Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trix`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#tsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tsi`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#ultimateOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ultimateOscillator`. ### @insiderfinance/totalfinance/technical-analysis/oscillators#williamsR Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#williamsR`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/overlap ### @insiderfinance/totalfinance/technical-analysis/overlap#AlmaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AlmaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#AlmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AlmaStream implements IndicatorStream { constructor(parameters: { period: number; offset: number; sigma: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AlmaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; offset: number; sigma: number; }; default: not declared - (parameters).offset: number; default: not declared - (parameters).period: number; default: not declared - (parameters).sigma: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AlmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#AnchoredVwapParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AnchoredVwapParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#AnchoredVwapPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AnchoredVwapPoint`. ### @insiderfinance/totalfinance/technical-analysis/overlap#AnchoredVwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AnchoredVwapStream implements IndicatorStream { constructor(anchor: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AnchoredVwapStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (anchor): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AnchoredVwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#DemaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DemaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DemaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DemaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#EmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class EmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): EmaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => EmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#FramaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FramaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#FramaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class FramaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): FramaStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => FramaStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#GannHiLoPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#GannHiLoPoint`. ### @insiderfinance/totalfinance/technical-analysis/overlap#GannHiLoStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class GannHiLoStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): GannHiLoStream; value: GannHiLoPoint | null; next(bar: BarInput): GannHiLoPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => GannHiLoStream; default: not declared - fromJSON().return.next: (bar: BarInput) => GannHiLoPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: GannHiLoPoint | null; default: not declared - fromJSON().return.value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - fromJSON().return.value.value: number; default: not declared — The active HiLo line. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => GannHiLoPoint | null; default: not declared - next().return.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - next().return.value: number; default: not declared — The active HiLo line. - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => GannHiLoPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: GannHiLoPoint | null; default: not declared - return.value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - return.value.value: number; default: not declared — The active HiLo line. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: GannHiLoPoint | null; default: not declared - value.trend: number; default: not declared — +1 trend up (line = SMA of lows), −1 trend down (line = SMA of highs). - value.value: number; default: not declared — The active HiLo line. ### @insiderfinance/totalfinance/technical-analysis/overlap#HmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HmaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#HwmaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HwmaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#HwmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HwmaStream implements IndicatorStream { constructor(parameters: { levelSmoothing: number; trendSmoothing: number; accelerationSmoothing: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HwmaStream; value: number | null; next(price: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { levelSmoothing: number; trendSmoothing: number; accelerationSmoothing: number; }; default: not declared - (parameters).accelerationSmoothing: number; default: not declared - (parameters).levelSmoothing: number; default: not declared - (parameters).trendSmoothing: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HwmaStream; default: not declared - fromJSON().return.next: (price: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (price: number) => number | null; default: not declared - next(price): number; default: not declared - return.next: (price: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#JmaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#JmaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#JmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class JmaStream implements IndicatorStream { constructor(parameters: { period: number; phase: number; power: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): JmaStream; value: number | null; next(source: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; phase: number; power: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).phase: number; default: not declared - (parameters).power: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => JmaStream; default: not declared - fromJSON().return.next: (source: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (source: number) => number | null; default: not declared - next(source): number; default: not declared - return.next: (source: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#KamaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KamaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#KamaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KamaStream implements IndicatorStream { constructor(parameters: { period: number; fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KamaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).period: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KamaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#MamaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MamaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#MamaPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MamaPoint`. ### @insiderfinance/totalfinance/technical-analysis/overlap#MamaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MamaStream implements IndicatorStream { constructor(parameters: { fastLimit: number; slowLimit: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MamaStream; next(bar: BarInput): MamaPoint | null; toJSON(): TechnicalAnalysisSnapshot; value: MamaPoint | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fastLimit: number; slowLimit: number; }; default: not declared - (parameters).fastLimit: number; default: not declared - (parameters).slowLimit: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MamaStream; default: not declared - fromJSON().return.next: (bar: BarInput) => MamaPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MamaPoint | null; default: not declared - fromJSON().return.value.fama: number; default: not declared - fromJSON().return.value.mama: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => MamaPoint | null; default: not declared - next().return.fama: number; default: not declared - next().return.mama: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => MamaPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MamaPoint | null; default: not declared - return.value.fama: number; default: not declared - return.value.mama: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MamaPoint | null; default: not declared - value.fama: number; default: not declared - value.mama: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#McGinleyStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). McGinley Dynamic (John R. McGinley) — an EMA-like average whose smoothing constant self-adjusts by the ratio of price to the current average, so it speeds up in fast markets and slows in quiet ones. Registered as `mcginley`; pandas-ta calls it `mcgd`. ```typescript export declare class McGinleyStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): McGinleyStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => McGinleyStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#MovingAverageRibbonParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MovingAverageRibbonParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#MovingAverageRibbonStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MovingAverageRibbonStream implements IndicatorStream { constructor(periods: number[]); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MovingAverageRibbonStream; value: number[] | null; next(value: number): number[] | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (periods): number[]; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MovingAverageRibbonStream; default: not declared - fromJSON().return.next: (value: number) => number[] | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number[] | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number[] | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number[] | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number[] | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number[] | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#PeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#RainbowMovingAverageStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RainbowMovingAverageStream implements IndicatorStream { constructor(parameters: { period: number; levels: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RainbowMovingAverageStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; levels: number; }; default: not declared - (parameters).levels: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RainbowMovingAverageStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#RainbowParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RainbowParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#RmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RmaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#RollingAnchoredVwapParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RollingAnchoredVwapParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#RollingAnchoredVwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RollingAnchoredVwapStream implements IndicatorStream { constructor(parameters: { lookback: number; anchorLow: boolean; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RollingAnchoredVwapStream; value: AnchoredVwapPoint | null; next(bar: BarInput): AnchoredVwapPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { lookback: number; anchorLow: boolean; }; default: not declared - (parameters).anchorLow: boolean; default: not declared - (parameters).lookback: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RollingAnchoredVwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => AnchoredVwapPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AnchoredVwapPoint | null; default: not declared - fromJSON().return.value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - fromJSON().return.value.vwap: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => AnchoredVwapPoint | null; default: not declared - next().return.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - next().return.vwap: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => AnchoredVwapPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: AnchoredVwapPoint | null; default: not declared - return.value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - return.value.vwap: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: AnchoredVwapPoint | null; default: not declared - value.anchorBarsAgo: number; default: not declared — Bars ago of the current anchor (0 = current bar). - value.vwap: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#RollingVwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RollingVwapStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RollingVwapStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RollingVwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#SessionVwapParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SessionVwapParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#SessionVwapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SessionVwapStream implements IndicatorStream { constructor(resetEvery: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SessionVwapStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (resetEvery): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SessionVwapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#SmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SmaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#SuperSmootherStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SuperSmootherStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SuperSmootherStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SuperSmootherStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#T3Parameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#T3Parameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#T3Stream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class T3Stream implements IndicatorStream { constructor(parameters: { period: number; volumeFactor: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): T3Stream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; volumeFactor: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).volumeFactor: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => T3Stream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#TemaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TemaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TemaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TemaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#TrimaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TrimaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrimaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TrimaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#VidyaParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VidyaParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#VidyaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VidyaStream implements IndicatorStream { constructor(parameters: { period: number; cmoPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VidyaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; cmoPeriod: number; }; default: not declared - (parameters).cmoPeriod: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VidyaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#VwapBandsParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VwapBandsParameters`. ### @insiderfinance/totalfinance/technical-analysis/overlap#VwapBandsPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VwapBandsPoint`. ### @insiderfinance/totalfinance/technical-analysis/overlap#VwapBandsStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VwapBandsStream implements IndicatorStream { constructor(mult: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VwapBandsStream; value: VwapBandsPoint | null; next(bar: BarInput): VwapBandsPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (mult): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VwapBandsStream; default: not declared - fromJSON().return.next: (bar: BarInput) => VwapBandsPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: VwapBandsPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON().return.value.vwap: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => VwapBandsPoint | null; default: not declared - next().return.lower: number; default: not declared - next().return.upper: number; default: not declared - next().return.vwap: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => VwapBandsPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: VwapBandsPoint | null; default: not declared - return.value.lower: number; default: not declared - return.value.upper: number; default: not declared - return.value.vwap: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: VwapBandsPoint | null; default: not declared - value.lower: number; default: not declared - value.upper: number; default: not declared - value.vwap: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#VwmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VwmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VwmaStream; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VwmaStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#WeightedMovingAverageStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class WeightedMovingAverageStream implements IndicatorStream { constructor(parameters: { kind: string; weights: number[]; }); static restore(kind: string): (s: TechnicalAnalysisSnapshot) => WeightedMovingAverageStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; weights: number[]; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).weights: number[]; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (kind: string) => (s: TechnicalAnalysisSnapshot) => WeightedMovingAverageStream; default: not declared - restore(kind): string; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#WmaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class WmaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): WmaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => WmaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#ZlemaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ZlemaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ZlemaStream; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; value: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ZlemaStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/overlap#alma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#alma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#anchoredVwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#anchoredVwap`. ### @insiderfinance/totalfinance/technical-analysis/overlap#dema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dema`. ### @insiderfinance/totalfinance/technical-analysis/overlap#ema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ema`. ### @insiderfinance/totalfinance/technical-analysis/overlap#frama Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#frama`. ### @insiderfinance/totalfinance/technical-analysis/overlap#fwma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fwma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#gannHighLowActivator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#gannHighLowActivator`. ### @insiderfinance/totalfinance/technical-analysis/overlap#hl2 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#hl2`. ### @insiderfinance/totalfinance/technical-analysis/overlap#hlc3 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#hlc3`. ### @insiderfinance/totalfinance/technical-analysis/overlap#hma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#hma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#holtWinterMovingAverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#holtWinterMovingAverage`. ### @insiderfinance/totalfinance/technical-analysis/overlap#jma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#jma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#kama Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kama`. ### @insiderfinance/totalfinance/technical-analysis/overlap#mama Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mama`. ### @insiderfinance/totalfinance/technical-analysis/overlap#mcginley Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mcginley`. ### @insiderfinance/totalfinance/technical-analysis/overlap#movingAverageRibbon Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#movingAverageRibbon`. ### @insiderfinance/totalfinance/technical-analysis/overlap#ohlc4 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ohlc4`. ### @insiderfinance/totalfinance/technical-analysis/overlap#pascalWma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pascalWma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#rainbowMovingAverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rainbowMovingAverage`. ### @insiderfinance/totalfinance/technical-analysis/overlap#rma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#rollingAnchoredVwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingAnchoredVwap`. ### @insiderfinance/totalfinance/technical-analysis/overlap#rollingVwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingVwap`. ### @insiderfinance/totalfinance/technical-analysis/overlap#sessionVwap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sessionVwap`. ### @insiderfinance/totalfinance/technical-analysis/overlap#sineWma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sineWma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#sma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#superSmoother Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#superSmoother`. ### @insiderfinance/totalfinance/technical-analysis/overlap#symmetricWma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#symmetricWma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#t3 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#t3`. ### @insiderfinance/totalfinance/technical-analysis/overlap#tema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tema`. ### @insiderfinance/totalfinance/technical-analysis/overlap#trima Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trima`. ### @insiderfinance/totalfinance/technical-analysis/overlap#vidya Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vidya`. ### @insiderfinance/totalfinance/technical-analysis/overlap#vwapBands Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vwapBands`. ### @insiderfinance/totalfinance/technical-analysis/overlap#vwma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vwma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#wcp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#wcp`. ### @insiderfinance/totalfinance/technical-analysis/overlap#wma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#wma`. ### @insiderfinance/totalfinance/technical-analysis/overlap#zlema Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#zlema`. ### @insiderfinance/totalfinance/technical-analysis/overlap#zlma Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#zlma`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/pipeline ### @insiderfinance/totalfinance/technical-analysis/pipeline#FeatureColumn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FeatureColumn`. ### @insiderfinance/totalfinance/technical-analysis/pipeline#FeaturePipeline Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FeaturePipeline`. ### @insiderfinance/totalfinance/technical-analysis/pipeline#Field Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Field`. ### @insiderfinance/totalfinance/technical-analysis/pipeline#features Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#features`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/price-action ### @insiderfinance/totalfinance/technical-analysis/price-action#AtrTrailingStopParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AtrTrailingStopParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#BreakoutsReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Breakout report (Law 2): the aligned signal series plus conventions and diagnostics. ```typescript // ───────────────────────── breakout & gap detection ───────────────────────── /** Breakout report (Law 2): the aligned signal series plus conventions and diagnostics. */ export interface BreakoutsReport { /** * Aligned to the input: `+1` when the close exceeds the highest high of the prior `lookback` * bars, `−1` below the lowest low, `0` otherwise — `null` during the lookback warmup. */ signal: Array; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; lookback: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; lookback: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.lookback: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - signal: (number | null)[]; default: not declared — Aligned to the input: `+1` when the close exceeds the highest high of the prior `lookback` bars, `−1` below the lowest low, `0` otherwise — `null` during the lookback warmup. ### @insiderfinance/totalfinance/technical-analysis/price-action#EqualLevelParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#EqualLevelParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#EqualLevelPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#EqualLevelPoint`. ### @insiderfinance/totalfinance/technical-analysis/price-action#FIB_EXTENSION_LEVELS Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FIB_EXTENSION_LEVELS`. ### @insiderfinance/totalfinance/technical-analysis/price-action#FIB_RETRACEMENT_LEVELS Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FIB_RETRACEMENT_LEVELS`. ### @insiderfinance/totalfinance/technical-analysis/price-action#FibExtensionInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#FibExtensionInput`. ### @insiderfinance/totalfinance/technical-analysis/price-action#FibLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FibLevel`. ### @insiderfinance/totalfinance/technical-analysis/price-action#Fractals Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fractal report (Law 2): Bill Williams up/down fractals plus conventions and diagnostics. ```typescript /** Fractal report (Law 2): Bill Williams up/down fractals plus conventions and diagnostics. */ export interface Fractals { up: SwingPoint[]; down: SwingPoint[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; strength: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.strength: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - down: SwingPoint[]; default: not declared - up: SwingPoint[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis/price-action#FvgParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#FvgParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#Gap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Gap`. ### @insiderfinance/totalfinance/technical-analysis/price-action#GapFillEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#GapFillEvent`. ### @insiderfinance/totalfinance/technical-analysis/price-action#GapFillReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gap-fill report (Law 2): the tracked gap events plus conventions and diagnostics. ```typescript /** Gap-fill report (Law 2): the tracked gap events plus conventions and diagnostics. */ export interface GapFillReport { events: GapFillEvent[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; minSizeFraction: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.minSizeFraction: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - events: GapFillEvent[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis/price-action#GapsReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gap report (Law 2): the detected gaps plus conventions and diagnostics. ```typescript /** Gap report (Law 2): the detected gaps plus conventions and diagnostics. */ export interface GapsReport { gaps: Gap[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; minSizeFraction: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; minSizeFraction: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.minSizeFraction: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - gaps: Gap[]; default: not declared ### @insiderfinance/totalfinance/technical-analysis/price-action#LabeledSwing Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LabeledSwing`. ### @insiderfinance/totalfinance/technical-analysis/price-action#Line Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Line`. ### @insiderfinance/totalfinance/technical-analysis/price-action#LiquiditySweepParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LiquiditySweepParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#LiquiditySweepPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LiquiditySweepPoint`. ### @insiderfinance/totalfinance/technical-analysis/price-action#MarketStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MarketStructure`. ### @insiderfinance/totalfinance/technical-analysis/price-action#OpeningRange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#OpeningRange`. ### @insiderfinance/totalfinance/technical-analysis/price-action#OpeningRangeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#OpeningRangeParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#OrderBlockParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#OrderBlockParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#PivotLevels Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PivotLevels`. ### @insiderfinance/totalfinance/technical-analysis/price-action#PivotMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PivotMethod`. ### @insiderfinance/totalfinance/technical-analysis/price-action#PriorSessionLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PriorSessionLevel`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SessionRange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SessionRange`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SmcSweepParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SmcSweepParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SrLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SrLevel`. ### @insiderfinance/totalfinance/technical-analysis/price-action#StructureEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StructureEvent`. ### @insiderfinance/totalfinance/technical-analysis/price-action#StructureEventType Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StructureEventType`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SupportResistance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SupportResistance`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SwingLabel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SwingLabel`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SwingPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SwingPoint`. ### @insiderfinance/totalfinance/technical-analysis/price-action#SwingTrailingStopParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SwingTrailingStopParameters`. ### @insiderfinance/totalfinance/technical-analysis/price-action#Swings Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Swings`. ### @insiderfinance/totalfinance/technical-analysis/price-action#TrailingStopPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TrailingStopPoint`. ### @insiderfinance/totalfinance/technical-analysis/price-action#TrendlineChannel Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Trendline/channel report (Law 2): the two rails plus conventions and diagnostics. ```typescript /** Trendline/channel report (Law 2): the two rails plus conventions and diagnostics. */ export interface TrendlineChannel { /** Line through the two most recent swing lows, or null when fewer than two exist. */ support: Line | null; /** Line through the two most recent swing highs, or null when fewer than two exist. */ resistance: Line | null; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; strength: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; strength: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.strength: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - resistance: Line | null; default: not declared — Line through the two most recent swing highs, or null when fewer than two exist. - resistance.from: number; default: not declared - resistance.intercept: number; default: not declared - resistance.slope: number; default: not declared - resistance.to: number; default: not declared - support: Line | null; default: not declared — Line through the two most recent swing lows, or null when fewer than two exist. - support.from: number; default: not declared - support.intercept: number; default: not declared - support.slope: number; default: not declared - support.to: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/price-action#ZonePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ZonePoint`. ### @insiderfinance/totalfinance/technical-analysis/price-action#atrTrailingStop Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#atrTrailingStop`. ### @insiderfinance/totalfinance/technical-analysis/price-action#breakouts Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#breakouts`. ### @insiderfinance/totalfinance/technical-analysis/price-action#channel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#channel`. ### @insiderfinance/totalfinance/technical-analysis/price-action#equalHighs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#equalHighs`. ### @insiderfinance/totalfinance/technical-analysis/price-action#equalLows Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#equalLows`. ### @insiderfinance/totalfinance/technical-analysis/price-action#fairValueGaps Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fairValueGaps`. ### @insiderfinance/totalfinance/technical-analysis/price-action#fibExtension Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fibExtension`. ### @insiderfinance/totalfinance/technical-analysis/price-action#fibRetracement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fibRetracement`. ### @insiderfinance/totalfinance/technical-analysis/price-action#fractals Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#fractals`. ### @insiderfinance/totalfinance/technical-analysis/price-action#gapFill Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#gapFill`. ### @insiderfinance/totalfinance/technical-analysis/price-action#gaps Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#gaps`. ### @insiderfinance/totalfinance/technical-analysis/price-action#lineAt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lineAt`. ### @insiderfinance/totalfinance/technical-analysis/price-action#liquiditySweeps Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#liquiditySweeps`. ### @insiderfinance/totalfinance/technical-analysis/price-action#marketStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#marketStructure`. ### @insiderfinance/totalfinance/technical-analysis/price-action#openingRange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#openingRange`. ### @insiderfinance/totalfinance/technical-analysis/price-action#openingRangeBreakout Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#openingRangeBreakout`. ### @insiderfinance/totalfinance/technical-analysis/price-action#orbRetest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#orbRetest`. ### @insiderfinance/totalfinance/technical-analysis/price-action#orderBlocks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#orderBlocks`. ### @insiderfinance/totalfinance/technical-analysis/price-action#pivots Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pivots`. ### @insiderfinance/totalfinance/technical-analysis/price-action#previousSessionLevels Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#previousSessionLevels`. ### @insiderfinance/totalfinance/technical-analysis/price-action#sessionRanges Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#sessionRanges`. ### @insiderfinance/totalfinance/technical-analysis/price-action#smcSweep Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#smcSweep`. ### @insiderfinance/totalfinance/technical-analysis/price-action#supportResistance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#supportResistance`. ### @insiderfinance/totalfinance/technical-analysis/price-action#swingTrailingStop Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#swingTrailingStop`. ### @insiderfinance/totalfinance/technical-analysis/price-action#swings Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#swings`. ### @insiderfinance/totalfinance/technical-analysis/price-action#trendlines Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trendlines`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/registry ### @insiderfinance/totalfinance/technical-analysis/registry#IndicatorCategory Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorCategory`. ### @insiderfinance/totalfinance/technical-analysis/registry#IndicatorDefinition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorDefinition`. ### @insiderfinance/totalfinance/technical-analysis/registry#IndicatorInputs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorInputs`. ### @insiderfinance/totalfinance/technical-analysis/registry#IndicatorMetadata Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IndicatorMetadata`. ### @insiderfinance/totalfinance/technical-analysis/registry#RegisteredIndicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RegisteredIndicator`. ### @insiderfinance/totalfinance/technical-analysis/registry#defineIndicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#defineIndicator`. ### @insiderfinance/totalfinance/technical-analysis/registry#getIndicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#getIndicator`. ### @insiderfinance/totalfinance/technical-analysis/registry#hasIndicator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#hasIndicator`. ### @insiderfinance/totalfinance/technical-analysis/registry#indicatorCategories Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#indicatorCategories`. ### @insiderfinance/totalfinance/technical-analysis/registry#listIndicators Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#listIndicators`. ### @insiderfinance/totalfinance/technical-analysis/registry#register Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#register`. ### @insiderfinance/totalfinance/technical-analysis/registry#registryMarkdown Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#registryMarkdown`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/resample ### @insiderfinance/totalfinance/technical-analysis/resample#AlignOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AlignOptions`. ### @insiderfinance/totalfinance/technical-analysis/resample#AlignToBarsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#AlignToBarsInput`. ### @insiderfinance/totalfinance/technical-analysis/resample#ResampleInterval Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ResampleInterval`. ### @insiderfinance/totalfinance/technical-analysis/resample#ResampleOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ResampleOptions`. ### @insiderfinance/totalfinance/technical-analysis/resample#ResampledBar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ResampledBar`. ### @insiderfinance/totalfinance/technical-analysis/resample#TimeBar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TimeBar`. ### @insiderfinance/totalfinance/technical-analysis/resample#alignToBars Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#alignToBars`. ### @insiderfinance/totalfinance/technical-analysis/resample#resample Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#resample`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/rsi ### @insiderfinance/totalfinance/technical-analysis/rsi#RsiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RsiParameters`. ### @insiderfinance/totalfinance/technical-analysis/rsi#RsiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RsiStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RsiStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RsiStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/rsi#rsi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rsi`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/series ### @insiderfinance/totalfinance/technical-analysis/series#LogReturnsStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class LogReturnsStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): LogReturnsStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => LogReturnsStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/series#ReturnsStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ReturnsStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ReturnsStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ReturnsStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/series#RollingVolatilityParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RollingVolatilityParameters`. ### @insiderfinance/totalfinance/technical-analysis/series#RollingVolatilityStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RollingVolatilityStream implements IndicatorStream { constructor(parameters: { period: number; scale: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RollingVolatilityStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; scale: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).scale: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RollingVolatilityStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/series#logReturns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#logReturns`. ### @insiderfinance/totalfinance/technical-analysis/series#returns Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#returns`. ### @insiderfinance/totalfinance/technical-analysis/series#rollingVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingVolatility`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/signal ### @insiderfinance/totalfinance/technical-analysis/signal#Condition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Condition`. ### @insiderfinance/totalfinance/technical-analysis/signal#Operand Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Operand`. ### @insiderfinance/totalfinance/technical-analysis/signal#Rule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Rule`. ### @insiderfinance/totalfinance/technical-analysis/signal#RuleBuilder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RuleBuilder`. ### @insiderfinance/totalfinance/technical-analysis/signal#SignalBuilder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SignalBuilder`. ### @insiderfinance/totalfinance/technical-analysis/signal#SignalContext Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SignalContext`. ### @insiderfinance/totalfinance/technical-analysis/signal#SignalEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SignalEvent`. ### @insiderfinance/totalfinance/technical-analysis/signal#Term Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Term`. ### @insiderfinance/totalfinance/technical-analysis/signal#between Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#between`. ### @insiderfinance/totalfinance/technical-analysis/signal#condition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#condition`. ### @insiderfinance/totalfinance/technical-analysis/signal#crossOver Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#crossOver`. ### @insiderfinance/totalfinance/technical-analysis/signal#crossUnder Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#crossUnder`. ### @insiderfinance/totalfinance/technical-analysis/signal#falling Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#falling`. ### @insiderfinance/totalfinance/technical-analysis/signal#gt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#gt`. ### @insiderfinance/totalfinance/technical-analysis/signal#gte Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#gte`. ### @insiderfinance/totalfinance/technical-analysis/signal#lt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lt`. ### @insiderfinance/totalfinance/technical-analysis/signal#lte Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lte`. ### @insiderfinance/totalfinance/technical-analysis/signal#not Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#not`. ### @insiderfinance/totalfinance/technical-analysis/signal#rising Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rising`. ### @insiderfinance/totalfinance/technical-analysis/signal#signal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#signal`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/statistics ### @insiderfinance/totalfinance/technical-analysis/statistics#BetaStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BetaStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): BetaStream; value: number | null; next(pair: Pair): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => BetaStream; default: not declared - fromJSON().return.next: (pair: Pair) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (pair: Pair) => number | null; default: not declared - next(pair): Pair; default: not declared - next(pair).x: number; default: not declared - next(pair).y: number; default: not declared - return.next: (pair: Pair) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#BopStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BopStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): BopStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => BopStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#CorrelStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CorrelStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CorrelStream; value: number | null; next(pair: Pair): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CorrelStream; default: not declared - fromJSON().return.next: (pair: Pair) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (pair: Pair) => number | null; default: not declared - next(pair): Pair; default: not declared - next(pair).x: number; default: not declared - next(pair).y: number; default: not declared - return.next: (pair: Pair) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#MOVING_AVERAGE_NAMES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const MOVING_AVERAGE_NAMES: readonly MovingAverageName[]; ``` ### @insiderfinance/totalfinance/technical-analysis/statistics#MavpInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#MavpInput`. ### @insiderfinance/totalfinance/technical-analysis/statistics#MavpParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MavpParameters`. ### @insiderfinance/totalfinance/technical-analysis/statistics#MidpointStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MidpointStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MidpointStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MidpointStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#MidpriceStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MidpriceStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MidpriceStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MidpriceStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#MinMaxIndexPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MinMaxIndexPoint`. ### @insiderfinance/totalfinance/technical-analysis/statistics#MinMaxIndexStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MinMaxIndexStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MinMaxIndexStream; value: MinMaxIndexPoint | null; next(value: number): MinMaxIndexPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MinMaxIndexStream; default: not declared - fromJSON().return.next: (value: number) => MinMaxIndexPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MinMaxIndexPoint | null; default: not declared - fromJSON().return.value.maxIndex: number; default: not declared - fromJSON().return.value.minIndex: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => MinMaxIndexPoint | null; default: not declared - next().return.maxIndex: number; default: not declared - next().return.minIndex: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => MinMaxIndexPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MinMaxIndexPoint | null; default: not declared - return.value.maxIndex: number; default: not declared - return.value.minIndex: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MinMaxIndexPoint | null; default: not declared - value.maxIndex: number; default: not declared - value.minIndex: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#MinMaxPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MinMaxPoint`. ### @insiderfinance/totalfinance/technical-analysis/statistics#MinMaxStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MinMaxStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MinMaxStream; value: MinMaxPoint | null; next(value: number): MinMaxPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MinMaxStream; default: not declared - fromJSON().return.next: (value: number) => MinMaxPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: MinMaxPoint | null; default: not declared - fromJSON().return.value.max: number; default: not declared - fromJSON().return.value.min: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => MinMaxPoint | null; default: not declared - next().return.max: number; default: not declared - next().return.min: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => MinMaxPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: MinMaxPoint | null; default: not declared - return.value.max: number; default: not declared - return.value.min: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: MinMaxPoint | null; default: not declared - value.max: number; default: not declared - value.min: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#MovingAverageName Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MovingAverageName`. ### @insiderfinance/totalfinance/technical-analysis/statistics#MovingAverageParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MovingAverageParameters`. ### @insiderfinance/totalfinance/technical-analysis/statistics#Pair Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#Pair`. ### @insiderfinance/totalfinance/technical-analysis/statistics#PeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/statistics#RollStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RollStream implements IndicatorStream { constructor(parameters: { period: number; mode: RollMode; }); static restore(mode: RollMode): (s: TechnicalAnalysisSnapshot) => RollStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; mode: RollMode; }; default: not declared - (parameters).mode: RollMode; default: not declared - (parameters).period: number; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (mode: RollMode) => (s: TechnicalAnalysisSnapshot) => RollStream; default: not declared - restore(mode): RollMode; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/statistics#beta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#beta`. ### @insiderfinance/totalfinance/technical-analysis/statistics#bop Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bop`. ### @insiderfinance/totalfinance/technical-analysis/statistics#correl Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#correl`. ### @insiderfinance/totalfinance/technical-analysis/statistics#mavp Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mavp`. ### @insiderfinance/totalfinance/technical-analysis/statistics#midpoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#midpoint`. ### @insiderfinance/totalfinance/technical-analysis/statistics#midprice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#midprice`. ### @insiderfinance/totalfinance/technical-analysis/statistics#movingAverage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#movingAverage`. ### @insiderfinance/totalfinance/technical-analysis/statistics#pairs Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pairs`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingMax Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMax`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingMaxIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMaxIndex`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingMin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMin`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingMinIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMinIndex`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingMinMax Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMinMax`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingMinMaxIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingMinMaxIndex`. ### @insiderfinance/totalfinance/technical-analysis/statistics#rollingSum Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rollingSum`. ### @insiderfinance/totalfinance/technical-analysis/statistics#stochFast Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#stochFast`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/transforms ### @insiderfinance/totalfinance/technical-analysis/transforms#GapStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class GapStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): GapStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => GapStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/transforms#HeikinAshiBar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HeikinAshiBar`. ### @insiderfinance/totalfinance/technical-analysis/transforms#HeikinAshiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HeikinAshiStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HeikinAshiStream; value: HeikinAshiBar | null; next(bar: BarInput): HeikinAshiBar | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HeikinAshiStream; default: not declared - fromJSON().return.next: (bar: BarInput) => HeikinAshiBar | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: HeikinAshiBar | null; default: not declared - fromJSON().return.value.close: number; default: not declared - fromJSON().return.value.high: number; default: not declared - fromJSON().return.value.low: number; default: not declared - fromJSON().return.value.open: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => HeikinAshiBar | null; default: not declared - next().return.close: number; default: not declared - next().return.high: number; default: not declared - next().return.low: number; default: not declared - next().return.open: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => HeikinAshiBar | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: HeikinAshiBar | null; default: not declared - return.value.close: number; default: not declared - return.value.high: number; default: not declared - return.value.low: number; default: not declared - return.value.open: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: HeikinAshiBar | null; default: not declared - value.close: number; default: not declared - value.high: number; default: not declared - value.low: number; default: not declared - value.open: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/transforms#MapBarStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MapBarStream implements IndicatorStream { constructor(parameters: { kind: string; project: (bar: BarInput) => number; }); value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { kind: string; project: (bar: BarInput) => number; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).project: (bar: BarInput) => number; default: not declared - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/transforms#TrueRangeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class TrueRangeStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): TrueRangeStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => TrueRangeStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/transforms#averagePrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#averagePrice`. ### @insiderfinance/totalfinance/technical-analysis/transforms#bar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bar`. ### @insiderfinance/totalfinance/technical-analysis/transforms#candleRange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#candleRange`. ### @insiderfinance/totalfinance/technical-analysis/transforms#gap Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#gap`. ### @insiderfinance/totalfinance/technical-analysis/transforms#heikinAshi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#heikinAshi`. ### @insiderfinance/totalfinance/technical-analysis/transforms#lowerShadow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#lowerShadow`. ### @insiderfinance/totalfinance/technical-analysis/transforms#medianPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#medianPrice`. ### @insiderfinance/totalfinance/technical-analysis/transforms#realBody Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#realBody`. ### @insiderfinance/totalfinance/technical-analysis/transforms#trueRange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trueRange`. ### @insiderfinance/totalfinance/technical-analysis/transforms#typicalPrice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#typicalPrice`. ### @insiderfinance/totalfinance/technical-analysis/transforms#upperShadow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#upperShadow`. ### @insiderfinance/totalfinance/technical-analysis/transforms#weightedClose Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#weightedClose`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/trend ### @insiderfinance/totalfinance/technical-analysis/trend#AdxrStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AdxrStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AdxrStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AdxrStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#AmatParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AmatParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#AmatPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AmatPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#AroonPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AroonPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#AroonStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AroonStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AroonStream; value: AroonPoint | null; next(bar: BarInput): AroonPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AroonStream; default: not declared - fromJSON().return.next: (bar: BarInput) => AroonPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: AroonPoint | null; default: not declared - fromJSON().return.value.down: number; default: not declared - fromJSON().return.value.up: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => AroonPoint | null; default: not declared - next().return.down: number; default: not declared - next().return.up: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => AroonPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: AroonPoint | null; default: not declared - return.value.down: number; default: not declared - return.value.up: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: AroonPoint | null; default: not declared - value.down: number; default: not declared - value.up: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#ChandeKrollStopParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChandeKrollStopParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#ChandeKrollStopPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChandeKrollStopPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#ChandelierParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChandelierParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#ChandelierPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChandelierPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#ChandelierStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ChandelierStream implements IndicatorStream { constructor(parameters: { period: number; mult: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ChandelierStream; value: ChandelierPoint | null; next(bar: BarInput): ChandelierPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; mult: number; }; default: not declared - (parameters).mult: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ChandelierStream; default: not declared - fromJSON().return.next: (bar: BarInput) => ChandelierPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChandelierPoint | null; default: not declared - fromJSON().return.value.long: number; default: not declared - fromJSON().return.value.short: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => ChandelierPoint | null; default: not declared - next().return.long: number; default: not declared - next().return.short: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => ChandelierPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: ChandelierPoint | null; default: not declared - return.value.long: number; default: not declared - return.value.short: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: ChandelierPoint | null; default: not declared - value.long: number; default: not declared - value.short: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#CprPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CprPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#CrossSignalParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#CrossSignalParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#DmiPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#DmiPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#DmiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DmiStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DmiStream; value: DmiPoint | null; next(bar: BarInput): DmiPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DmiStream; default: not declared - fromJSON().return.next: (bar: BarInput) => DmiPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: DmiPoint | null; default: not declared - fromJSON().return.value.dx: number; default: not declared - fromJSON().return.value.minusDI: number; default: not declared - fromJSON().return.value.minusDM: number; default: not declared — Wilder-smoothed −DM. - fromJSON().return.value.plusDI: number; default: not declared - fromJSON().return.value.plusDM: number; default: not declared — Wilder-smoothed +DM. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => DmiPoint | null; default: not declared - next().return.dx: number; default: not declared - next().return.minusDI: number; default: not declared - next().return.minusDM: number; default: not declared — Wilder-smoothed −DM. - next().return.plusDI: number; default: not declared - next().return.plusDM: number; default: not declared — Wilder-smoothed +DM. - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => DmiPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: DmiPoint | null; default: not declared - return.value.dx: number; default: not declared - return.value.minusDI: number; default: not declared - return.value.minusDM: number; default: not declared — Wilder-smoothed −DM. - return.value.plusDI: number; default: not declared - return.value.plusDM: number; default: not declared — Wilder-smoothed +DM. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: DmiPoint | null; default: not declared - value.dx: number; default: not declared - value.minusDI: number; default: not declared - value.minusDM: number; default: not declared — Wilder-smoothed −DM. - value.plusDI: number; default: not declared - value.plusDM: number; default: not declared — Wilder-smoothed +DM. ### @insiderfinance/totalfinance/technical-analysis/trend#DonchianTrendStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Donchian breakout trend: +1 once the close makes a new `period`-bar high, −1 on a new `period`-bar low, holding the prior state between breakouts. ```typescript export declare class DonchianTrendStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DonchianTrendStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DonchianTrendStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#IchimokuParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IchimokuParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#IchimokuPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#IchimokuPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#IchimokuStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class IchimokuStream implements IndicatorStream { constructor(parameters: { conv: number; basePeriod: number; spanBPeriod: number; displacement: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): IchimokuStream; value: IchimokuPoint | null; next(bar: BarInput): IchimokuPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { conv: number; basePeriod: number; spanBPeriod: number; displacement: number; }; default: not declared - (parameters).basePeriod: number; default: not declared - (parameters).conv: number; default: not declared - (parameters).displacement: number; default: not declared - (parameters).spanBPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => IchimokuStream; default: not declared - fromJSON().return.next: (bar: BarInput) => IchimokuPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: IchimokuPoint | null; default: not declared - fromJSON().return.value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - fromJSON().return.value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - fromJSON().return.value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - fromJSON().return.value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - fromJSON().return.value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - fromJSON().return.value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => IchimokuPoint | null; default: not declared - next().return.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - next().return.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - next().return.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - next().return.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - next().return.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - next().return.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => IchimokuPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: IchimokuPoint | null; default: not declared - return.value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - return.value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - return.value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - return.value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - return.value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - return.value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: IchimokuPoint | null; default: not declared - value.chikou: number; default: not declared — Lagging span (Chikou): the current close — plot `displacement` bars behind. - value.displacement: number; default: not declared — The displacement (in bars) to apply when plotting the spans/chikou. - value.kijun: number; default: not declared — Base line (Kijun-sen): midpoint of the last `base` bars. - value.senkouA: number; default: not declared — Leading span A (Senkou A), unshifted: (tenkan + kijun) / 2 — plot `displacement` bars ahead. - value.senkouB: number; default: not declared — Leading span B (Senkou B), unshifted: midpoint of the last `spanB` bars — plot `displacement` bars ahead. - value.tenkan: number; default: not declared — Conversion line (Tenkan-sen): midpoint of the last `conversion` bars. ### @insiderfinance/totalfinance/technical-analysis/trend#LinregPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#LinregPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#LinregStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class LinregStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): LinregStream; value: LinregPoint | null; next(value: number): LinregPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => LinregStream; default: not declared - fromJSON().return.next: (value: number) => LinregPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: LinregPoint | null; default: not declared - fromJSON().return.value.angle: number; default: not declared - fromJSON().return.value.forecast: number; default: not declared - fromJSON().return.value.intercept: number; default: not declared - fromJSON().return.value.slope: number; default: not declared - fromJSON().return.value.value: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => LinregPoint | null; default: not declared - next().return.angle: number; default: not declared - next().return.forecast: number; default: not declared - next().return.intercept: number; default: not declared - next().return.slope: number; default: not declared - next().return.value: number; default: not declared - next(value): number; default: not declared - return.next: (value: number) => LinregPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: LinregPoint | null; default: not declared - return.value.angle: number; default: not declared - return.value.forecast: number; default: not declared - return.value.intercept: number; default: not declared - return.value.slope: number; default: not declared - return.value.value: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: LinregPoint | null; default: not declared - value.angle: number; default: not declared - value.forecast: number; default: not declared - value.intercept: number; default: not declared - value.slope: number; default: not declared - value.value: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#PeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#PmaxParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PmaxParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#PmaxPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PmaxPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#PsarExtParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PsarExtParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#PsarExtStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). TA-Lib SAREXT — Parabolic SAR with independent acceleration factors per side and an offset applied on reversal. Output is signed: positive while long, negative while short. ```typescript export declare class PsarExtStream implements IndicatorStream { constructor(parameters: { startValue: number; offset: number; afInitLong: number; afLong: number; afMaxLong: number; afInitShort: number; afShort: number; afMaxShort: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PsarExtStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { startValue: number; offset: number; afInitLong: number; afLong: number; afMaxLong: number; afInitShort: number; afShort: number; afMaxShort: number; }; default: not declared - (parameters).afInitLong: number; default: not declared - (parameters).afInitShort: number; default: not declared - (parameters).afLong: number; default: not declared - (parameters).afMaxLong: number; default: not declared - (parameters).afMaxShort: number; default: not declared - (parameters).afShort: number; default: not declared - (parameters).offset: number; default: not declared - (parameters).startValue: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PsarExtStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#PsarParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PsarParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#PsarPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PsarPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#PsarStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PsarStream implements IndicatorStream { constructor(parameters: { step: number; maxAf: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PsarStream; value: PsarPoint | null; next(bar: BarInput): PsarPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { step: number; maxAf: number; }; default: not declared - (parameters).maxAf: number; default: not declared - (parameters).step: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PsarStream; default: not declared - fromJSON().return.next: (bar: BarInput) => PsarPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: PsarPoint | null; default: not declared - fromJSON().return.value.sar: number; default: not declared - fromJSON().return.value.trend: number; default: not declared — +1 rising (long), −1 falling (short). - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => PsarPoint | null; default: not declared - next().return.sar: number; default: not declared - next().return.trend: number; default: not declared — +1 rising (long), −1 falling (short). - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => PsarPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: PsarPoint | null; default: not declared - return.value.sar: number; default: not declared - return.value.trend: number; default: not declared — +1 rising (long), −1 falling (short). - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: PsarPoint | null; default: not declared - value.sar: number; default: not declared - value.trend: number; default: not declared — +1 rising (long), −1 falling (short). ### @insiderfinance/totalfinance/technical-analysis/trend#SupertrendParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SupertrendParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#SupertrendPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#SupertrendPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#SupertrendStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class SupertrendStream implements IndicatorStream { constructor(parameters: { period: number; mult: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): SupertrendStream; value: SupertrendPoint | null; next(bar: BarInput): SupertrendPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; mult: number; }; default: not declared - (parameters).mult: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => SupertrendStream; default: not declared - fromJSON().return.next: (bar: BarInput) => SupertrendPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: SupertrendPoint | null; default: not declared - fromJSON().return.value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - fromJSON().return.value.supertrend: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => SupertrendPoint | null; default: not declared - next().return.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - next().return.supertrend: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => SupertrendPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: SupertrendPoint | null; default: not declared - return.value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - return.value.supertrend: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: SupertrendPoint | null; default: not declared - value.direction: number; default: not declared — +1 uptrend (price above), −1 downtrend (price below). - value.supertrend: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#TrendSignalPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TrendSignalPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#TrendTestParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#TrendTestParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#VortexPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VortexPoint`. ### @insiderfinance/totalfinance/technical-analysis/trend#VortexStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VortexStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VortexStream; value: VortexPoint | null; next(bar: BarInput): VortexPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VortexStream; default: not declared - fromJSON().return.next: (bar: BarInput) => VortexPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: VortexPoint | null; default: not declared - fromJSON().return.value.viMinus: number; default: not declared - fromJSON().return.value.viPlus: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => VortexPoint | null; default: not declared - next().return.viMinus: number; default: not declared - next().return.viPlus: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => VortexPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: VortexPoint | null; default: not declared - return.value.viMinus: number; default: not declared - return.value.viPlus: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: VortexPoint | null; default: not declared - value.viMinus: number; default: not declared - value.viPlus: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/trend#ZigZagParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ZigZagParameters`. ### @insiderfinance/totalfinance/technical-analysis/trend#ZigZagPivot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ZigZagPivot`. ### @insiderfinance/totalfinance/technical-analysis/trend#ZigZagReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ZigZag report (Law 2): the pivot list plus the applied conventions and diagnostics. ```typescript /** ZigZag report (Law 2): the pivot list plus the applied conventions and diagnostics. */ export interface ZigZagReport { pivots: ZigZagPivot[]; /** The last pivot is provisional — a larger move can still extend the final leg. */ provisional: boolean; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; deviation: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; deviation: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.deviation: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - pivots: ZigZagPivot[]; default: not declared - provisional: boolean; default: not declared — The last pivot is provisional — a larger move can still extend the final leg. ### @insiderfinance/totalfinance/technical-analysis/trend#adxr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#adxr`. ### @insiderfinance/totalfinance/technical-analysis/trend#amat Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#amat`. ### @insiderfinance/totalfinance/technical-analysis/trend#aroon Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#aroon`. ### @insiderfinance/totalfinance/technical-analysis/trend#aroonOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#aroonOscillator`. ### @insiderfinance/totalfinance/technical-analysis/trend#centralPivotRange Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#centralPivotRange`. ### @insiderfinance/totalfinance/technical-analysis/trend#chandeKrollStop Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#chandeKrollStop`. ### @insiderfinance/totalfinance/technical-analysis/trend#chandelierExit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#chandelierExit`. ### @insiderfinance/totalfinance/technical-analysis/trend#choppinessIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#choppinessIndex`. ### @insiderfinance/totalfinance/technical-analysis/trend#crossSignals Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#crossSignals`. ### @insiderfinance/totalfinance/technical-analysis/trend#decreasing Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#decreasing`. ### @insiderfinance/totalfinance/technical-analysis/trend#dmi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dmi`. ### @insiderfinance/totalfinance/technical-analysis/trend#donchianTrend Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#donchianTrend`. ### @insiderfinance/totalfinance/technical-analysis/trend#dx Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#dx`. ### @insiderfinance/totalfinance/technical-analysis/trend#exponentialDecay Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#exponentialDecay`. ### @insiderfinance/totalfinance/technical-analysis/trend#ichimoku Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ichimoku`. ### @insiderfinance/totalfinance/technical-analysis/trend#increasing Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#increasing`. ### @insiderfinance/totalfinance/technical-analysis/trend#linearDecay Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#linearDecay`. ### @insiderfinance/totalfinance/technical-analysis/trend#linreg Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#linreg`. ### @insiderfinance/totalfinance/technical-analysis/trend#linregAngle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#linregAngle`. ### @insiderfinance/totalfinance/technical-analysis/trend#linregIntercept Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#linregIntercept`. ### @insiderfinance/totalfinance/technical-analysis/trend#linregSlope Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#linregSlope`. ### @insiderfinance/totalfinance/technical-analysis/trend#longRun Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#longRun`. ### @insiderfinance/totalfinance/technical-analysis/trend#minusDI Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#minusDI`. ### @insiderfinance/totalfinance/technical-analysis/trend#minusDM Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#minusDM`. ### @insiderfinance/totalfinance/technical-analysis/trend#pMax Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pMax`. ### @insiderfinance/totalfinance/technical-analysis/trend#plusDI Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#plusDI`. ### @insiderfinance/totalfinance/technical-analysis/trend#plusDM Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#plusDM`. ### @insiderfinance/totalfinance/technical-analysis/trend#psar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#psar`. ### @insiderfinance/totalfinance/technical-analysis/trend#psarExt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#psarExt`. ### @insiderfinance/totalfinance/technical-analysis/trend#qstick Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#qstick`. ### @insiderfinance/totalfinance/technical-analysis/trend#shortRun Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#shortRun`. ### @insiderfinance/totalfinance/technical-analysis/trend#supertrend Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#supertrend`. ### @insiderfinance/totalfinance/technical-analysis/trend#trendSignals Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#trendSignals`. ### @insiderfinance/totalfinance/technical-analysis/trend#tsf Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#tsf`. ### @insiderfinance/totalfinance/technical-analysis/trend#ttmTrend Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ttmTrend`. ### @insiderfinance/totalfinance/technical-analysis/trend#verticalHorizontalFilter Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#verticalHorizontalFilter`. ### @insiderfinance/totalfinance/technical-analysis/trend#vortex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vortex`. ### @insiderfinance/totalfinance/technical-analysis/trend#zigzag Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#zigzag`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/volatility ### @insiderfinance/totalfinance/technical-analysis/volatility#AberrationParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AberrationParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#AberrationPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AberrationPoint`. ### @insiderfinance/totalfinance/technical-analysis/volatility#AccelerationBandsParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AccelerationBandsParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#AtrBandsParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#AtrBandsParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#BollingerBandFieldStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class BollingerBandFieldStream implements IndicatorStream { constructor(parameters: { period: number; standardDeviation: number; field: 'bandwidth' | 'percentB'; kind: string; }); static restore(field: 'bandwidth' | 'percentB', kind: string): (s: TechnicalAnalysisSnapshot) => BollingerBandFieldStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; standardDeviation: number; field: 'bandwidth' | 'percentB'; kind: string; }; default: not declared - (parameters).field: 'bandwidth' | 'percentB'; default: not declared - (parameters).kind: string; default: not declared - (parameters).period: number; default: not declared - (parameters).standardDeviation: number; default: not declared - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - restore: (field: 'bandwidth' | 'percentB', kind: string) => (s: TechnicalAnalysisSnapshot) => BollingerBandFieldStream; default: not declared - restore(field): 'bandwidth' | 'percentB'; default: not declared - restore(kind): string; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#BollingerParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Bollinger Width & %B ───────────────────────── export interface BollingerParameters { period: number; standardDeviation?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period: number; default: not declared - standardDeviation?: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#ChaikinVolatilityParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChaikinVolatilityParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#ChaikinVolatilityStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ChaikinVolatilityStream implements IndicatorStream { constructor(parameters: { period: number; rocPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ChaikinVolatilityStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; rocPeriod: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).rocPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ChaikinVolatilityStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#ChannelPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChannelPoint`. ### @insiderfinance/totalfinance/technical-analysis/volatility#DonchianStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class DonchianStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): DonchianStream; value: ChannelPoint | null; next(bar: BarInput): ChannelPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => DonchianStream; default: not declared - fromJSON().return.next: (bar: BarInput) => ChannelPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => ChannelPoint | null; default: not declared - next().return.lower: number; default: not declared - next().return.middle: number; default: not declared - next().return.upper: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => ChannelPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: ChannelPoint | null; default: not declared - return.value.lower: number; default: not declared - return.value.middle: number; default: not declared - return.value.upper: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: ChannelPoint | null; default: not declared - value.lower: number; default: not declared - value.middle: number; default: not declared - value.upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#ElderThermometerParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ElderThermometerParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#ElderThermometerPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ElderThermometerPoint`. ### @insiderfinance/totalfinance/technical-analysis/volatility#HistoricalVolatilityParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HistoricalVolatilityParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#HistoricalVolatilityStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class HistoricalVolatilityStream implements IndicatorStream { constructor(parameters: { period: number; scale: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): HistoricalVolatilityStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; scale: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).scale: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => HistoricalVolatilityStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#HoltWinterChannelParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#HoltWinterChannelParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#KeltnerParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KeltnerParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#KeltnerStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KeltnerStream implements IndicatorStream { constructor(parameters: { period: number; atrPeriod: number; mult: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KeltnerStream; value: ChannelPoint | null; next(bar: BarInput): ChannelPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; atrPeriod: number; mult: number; }; default: not declared - (parameters).atrPeriod: number; default: not declared - (parameters).mult: number; default: not declared - (parameters).period: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KeltnerStream; default: not declared - fromJSON().return.next: (bar: BarInput) => ChannelPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: ChannelPoint | null; default: not declared - fromJSON().return.value.lower: number; default: not declared - fromJSON().return.value.middle: number; default: not declared - fromJSON().return.value.upper: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => ChannelPoint | null; default: not declared - next().return.lower: number; default: not declared - next().return.middle: number; default: not declared - next().return.upper: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => ChannelPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: ChannelPoint | null; default: not declared - return.value.lower: number; default: not declared - return.value.middle: number; default: not declared - return.value.upper: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: ChannelPoint | null; default: not declared - value.lower: number; default: not declared - value.middle: number; default: not declared - value.upper: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#MassIndexParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#MassIndexParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#MomentStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MomentStream implements IndicatorStream { constructor(parameters: { period: number; sample: boolean; variance: boolean; kind: MomentKind; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MomentStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; sample: boolean; variance: boolean; kind: MomentKind; }; default: not declared - (parameters).kind: 'standardDeviation' | 'variance'; default: not declared - (parameters).period: number; default: not declared - (parameters).sample: boolean; default: not declared - (parameters).variance: boolean; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MomentStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#NatrStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class NatrStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): NatrStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => NatrStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#PeriodParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface PeriodParameters { /** Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. */ period?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - period?: number; default: not declared — Lookback window. Defaults: NATR 14, Donchian 20; echoed via `.explain()`. ### @insiderfinance/totalfinance/technical-analysis/volatility#RangeVolatilityParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RangeVolatilityParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#RangeVolatilityStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Generic window of per-bar contributions → σ = √(mean·scale). ```typescript export declare class RangeVolatilityStream implements IndicatorStream { constructor(parameters: { period: number; scale: number; term: (bar: BarInput) => number; kind: string; }); value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; scale: number; term: (bar: BarInput) => number; kind: string; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).period: number; default: not declared - (parameters).scale: number; default: not declared - (parameters).term: (bar: BarInput) => number; default: not declared - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#RealizedVolatilityStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Realized volatility — the root-mean-square of log returns over the window (no mean subtraction, the realized-variance convention), versus `historicalVolatility`'s sample standard deviation. ```typescript export declare class RealizedVolatilityStream implements IndicatorStream { constructor(parameters: { period: number; scale: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RealizedVolatilityStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; scale: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).scale: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RealizedVolatilityStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#RviParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#RviParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#RviStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Relative Volatility Index — RSI's logic applied to the rolling standard deviation of price instead of price change: up-day stdev and down-day stdev are Wilder-smoothed and ratioed into [0, 100]. ```typescript export declare class RviStream implements IndicatorStream { constructor(parameters: { stdevPeriod: number; smoothPeriod: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RviStream; value: number | null; next(value: number): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { stdevPeriod: number; smoothPeriod: number; }; default: not declared - (parameters).smoothPeriod: number; default: not declared - (parameters).stdevPeriod: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RviStream; default: not declared - fromJSON().return.next: (value: number) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (value: number) => number | null; default: not declared - next(value): number; default: not declared - return.next: (value: number) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#StandardDeviationParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#StandardDeviationParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#VolatilityStopParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolatilityStopParameters`. ### @insiderfinance/totalfinance/technical-analysis/volatility#VolatilityStopPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolatilityStopPoint`. ### @insiderfinance/totalfinance/technical-analysis/volatility#YangZhangStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class YangZhangStream implements IndicatorStream { constructor(parameters: { period: number; scale: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): YangZhangStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; scale: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).scale: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => YangZhangStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volatility#aberration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#aberration`. ### @insiderfinance/totalfinance/technical-analysis/volatility#accelerationBands Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#accelerationBands`. ### @insiderfinance/totalfinance/technical-analysis/volatility#atrBands Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#atrBands`. ### @insiderfinance/totalfinance/technical-analysis/volatility#bollingerBandWidth Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bollingerBandWidth`. ### @insiderfinance/totalfinance/technical-analysis/volatility#bollingerPercentB Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#bollingerPercentB`. ### @insiderfinance/totalfinance/technical-analysis/volatility#chaikinVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#chaikinVolatility`. ### @insiderfinance/totalfinance/technical-analysis/volatility#donchian Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#donchian`. ### @insiderfinance/totalfinance/technical-analysis/volatility#elderThermometer Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#elderThermometer`. ### @insiderfinance/totalfinance/technical-analysis/volatility#garmanKlass Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#garmanKlass`. ### @insiderfinance/totalfinance/technical-analysis/volatility#historicalVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#historicalVolatility`. ### @insiderfinance/totalfinance/technical-analysis/volatility#holtWinterChannel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#holtWinterChannel`. ### @insiderfinance/totalfinance/technical-analysis/volatility#keltner Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#keltner`. ### @insiderfinance/totalfinance/technical-analysis/volatility#massIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#massIndex`. ### @insiderfinance/totalfinance/technical-analysis/volatility#natr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#natr`. ### @insiderfinance/totalfinance/technical-analysis/volatility#parkinson Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#parkinson`. ### @insiderfinance/totalfinance/technical-analysis/volatility#percentAtr Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#percentAtr`. ### @insiderfinance/totalfinance/technical-analysis/volatility#priceDistance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#priceDistance`. ### @insiderfinance/totalfinance/technical-analysis/volatility#realizedVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#realizedVolatility`. ### @insiderfinance/totalfinance/technical-analysis/volatility#relativeVolatilityIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#relativeVolatilityIndex`. ### @insiderfinance/totalfinance/technical-analysis/volatility#rogersSatchell Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#rogersSatchell`. ### @insiderfinance/totalfinance/technical-analysis/volatility#standardDeviation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#standardDeviation`. ### @insiderfinance/totalfinance/technical-analysis/volatility#ulcerIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ulcerIndex`. ### @insiderfinance/totalfinance/technical-analysis/volatility#variance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#variance`. ### @insiderfinance/totalfinance/technical-analysis/volatility#volatilityStop Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volatilityStop`. ### @insiderfinance/totalfinance/technical-analysis/volatility#yangZhang Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#yangZhang`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/volume ### @insiderfinance/totalfinance/technical-analysis/volume#AdLineStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class AdLineStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): AdLineStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => AdLineStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#ArcherObvParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ArcherObvParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#ArcherObvPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ArcherObvPoint`. ### @insiderfinance/totalfinance/technical-analysis/volume#ChaikinOscParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#ChaikinOscParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#ChaikinOscStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ChaikinOscStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ChaikinOscStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ChaikinOscStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#CmfStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CmfStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CmfStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CmfStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#CvdStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class CvdStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): CvdStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => CvdStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#EomParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#EomParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#EomStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class EomStream implements IndicatorStream { constructor(parameters: { period: number; scale: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): EomStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; scale: number; }; default: not declared - (parameters).period: number; default: not declared - (parameters).scale: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => EomStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#ForceIndexStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class ForceIndexStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): ForceIndexStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => ForceIndexStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#KlingerParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KlingerParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#KlingerPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#KlingerPoint`. ### @insiderfinance/totalfinance/technical-analysis/volume#KlingerStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class KlingerStream implements IndicatorStream { constructor(parameters: { fast: number; slow: number; signal: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): KlingerStream; value: KlingerPoint | null; next(bar: BarInput): KlingerPoint | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { fast: number; slow: number; signal: number; }; default: not declared - (parameters).fast: number; default: not declared - (parameters).signal: number; default: not declared - (parameters).slow: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => KlingerStream; default: not declared - fromJSON().return.next: (bar: BarInput) => KlingerPoint | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: KlingerPoint | null; default: not declared - fromJSON().return.value.klinger: number; default: not declared - fromJSON().return.value.signal: number; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => KlingerPoint | null; default: not declared - next().return.klinger: number; default: not declared - next().return.signal: number; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => KlingerPoint | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: KlingerPoint | null; default: not declared - return.value.klinger: number; default: not declared - return.value.signal: number; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: KlingerPoint | null; default: not declared - value.klinger: number; default: not declared - value.signal: number; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#MfiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class MfiStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): MfiStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => MfiStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#OrderBookImbalanceResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Order-book-imbalance envelope (Law 2): the imbalance plus conventions and diagnostics. ```typescript /** Order-book-imbalance envelope (Law 2): the imbalance plus conventions and diagnostics. */ export interface OrderBookImbalanceResult { /** Imbalance in [−1, 1], or null when both sizes are zero (disclosed in diagnostics). */ value: number | null; /** Applied conventions, echoed (Law 2 grammar). */ assumptions: { conventionsVersion: string; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; }; default: not declared — Applied conventions, echoed (Law 2 grammar). - assumptions.conventionsVersion: string; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - value: number | null; default: not declared — Imbalance in [−1, 1], or null when both sizes are zero (disclosed in diagnostics). ### @insiderfinance/totalfinance/technical-analysis/volume#OrderBookLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#OrderBookLevel`. ### @insiderfinance/totalfinance/technical-analysis/volume#PeriodParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PeriodParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#PriceVolumeParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#PriceVolumeParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#PvtStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class PvtStream implements IndicatorStream { constructor(); static fromJSON(snapshot: TechnicalAnalysisSnapshot): PvtStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => PvtStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#RelativeVolumeStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class RelativeVolumeStream implements IndicatorStream { constructor(period: number); static fromJSON(snapshot: TechnicalAnalysisSnapshot): RelativeVolumeStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (period): number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => RelativeVolumeStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#VfiParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VfiParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#VfiStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VfiStream implements IndicatorStream { constructor(parameters: { period: number; coefficient: number; volumeCutoff: number; smooth: number; }); static fromJSON(snapshot: TechnicalAnalysisSnapshot): VfiStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { period: number; coefficient: number; volumeCutoff: number; smooth: number; }; default: not declared - (parameters).coefficient: number; default: not declared - (parameters).period: number; default: not declared - (parameters).smooth: number; default: not declared - (parameters).volumeCutoff: number; default: not declared - fromJSON: (snapshot: TechnicalAnalysisSnapshot) => VfiStream; default: not declared - fromJSON().return.next: (bar: BarInput) => number | null; default: not declared - fromJSON().return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - fromJSON().return.value: number | null; default: not declared - fromJSON(snapshot): TechnicalAnalysisSnapshot; default: not declared - fromJSON(snapshot).kind: string; default: not declared - fromJSON(snapshot).schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - fromJSON(snapshot).state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#VolumeBin Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolumeBin`. ### @insiderfinance/totalfinance/technical-analysis/volume#VolumeIndexStream Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare class VolumeIndexStream implements IndicatorStream { constructor(parameters: { positive: boolean; kind: string; }); static restore(positive: boolean, kind: string): (s: TechnicalAnalysisSnapshot) => VolumeIndexStream; value: number | null; next(bar: BarInput): number | null; toJSON(): TechnicalAnalysisSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (parameters): { positive: boolean; kind: string; }; default: not declared - (parameters).kind: string; default: not declared - (parameters).positive: boolean; default: not declared - next: (bar: BarInput) => number | null; default: not declared - next(bar): BarInput; default: not declared - next(bar).close: number; default: not declared - next(bar).high: number; default: not declared - next(bar).low: number; default: not declared - next(bar).open?: number; default: not declared - next(bar).volume?: number; default: not declared - restore: (positive: boolean, kind: string) => (s: TechnicalAnalysisSnapshot) => VolumeIndexStream; default: not declared - restore(kind): string; default: not declared - restore(positive): boolean; default: not declared - return.next: (bar: BarInput) => number | null; default: not declared - return.toJSON: () => TechnicalAnalysisSnapshot; default: not declared - return.value: number | null; default: not declared - toJSON: () => TechnicalAnalysisSnapshot; default: not declared - toJSON().return.kind: string; default: not declared - toJSON().return.schemaVersion: number; default: not declared — Schema version, stamped at the serialization boundary by {@link snapshotOf}. - toJSON().return.state: Record; default: not declared — Indicator-private stream state. Round-trip it; never read into it. - value: number | null; default: not declared ### @insiderfinance/totalfinance/technical-analysis/volume#VolumeOscillatorParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolumeOscillatorParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#VolumeProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolumeProfile`. ### @insiderfinance/totalfinance/technical-analysis/volume#VolumeProfileParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#VolumeProfileParameters`. ### @insiderfinance/totalfinance/technical-analysis/volume#adLine Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#adLine`. ### @insiderfinance/totalfinance/technical-analysis/volume#archerObv Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#archerObv`. ### @insiderfinance/totalfinance/technical-analysis/volume#chaikinMoneyFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#chaikinMoneyFlow`. ### @insiderfinance/totalfinance/technical-analysis/volume#chaikinOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#chaikinOscillator`. ### @insiderfinance/totalfinance/technical-analysis/volume#cvd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#cvd`. ### @insiderfinance/totalfinance/technical-analysis/volume#easeOfMovement Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#easeOfMovement`. ### @insiderfinance/totalfinance/technical-analysis/volume#efi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#efi`. ### @insiderfinance/totalfinance/technical-analysis/volume#emv Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#emv`. ### @insiderfinance/totalfinance/technical-analysis/volume#forceIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#forceIndex`. ### @insiderfinance/totalfinance/technical-analysis/volume#klinger Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#klinger`. ### @insiderfinance/totalfinance/technical-analysis/volume#kvo Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#kvo`. ### @insiderfinance/totalfinance/technical-analysis/volume#marketFacilitationIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#marketFacilitationIndex`. ### @insiderfinance/totalfinance/technical-analysis/volume#mfi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#mfi`. ### @insiderfinance/totalfinance/technical-analysis/volume#nvi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#nvi`. ### @insiderfinance/totalfinance/technical-analysis/volume#orderBookImbalance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#orderBookImbalance`. ### @insiderfinance/totalfinance/technical-analysis/volume#priceVolume Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#priceVolume`. ### @insiderfinance/totalfinance/technical-analysis/volume#priceVolumeRank Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#priceVolumeRank`. ### @insiderfinance/totalfinance/technical-analysis/volume#pvi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pvi`. ### @insiderfinance/totalfinance/technical-analysis/volume#pvt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#pvt`. ### @insiderfinance/totalfinance/technical-analysis/volume#relativeVolume Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#relativeVolume`. ### @insiderfinance/totalfinance/technical-analysis/volume#vfi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#vfi`. ### @insiderfinance/totalfinance/technical-analysis/volume#volumeOscillator Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volumeOscillator`. ### @insiderfinance/totalfinance/technical-analysis/volume#volumeProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#volumeProfile`. ### @insiderfinance/totalfinance/technical-analysis/volume#williamsAd Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#williamsAd`. ## Entrypoint @insiderfinance/totalfinance/technical-analysis/warmup ### @insiderfinance/totalfinance/technical-analysis/warmup#WarmupMetadata Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#WarmupMetadata`. ### @insiderfinance/totalfinance/technical-analysis/warmup#indicatorWarmup Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#indicatorWarmup`. ### @insiderfinance/totalfinance/technical-analysis/warmup#indicatorWarmups Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#indicatorWarmups`. ### @insiderfinance/totalfinance/technical-analysis/warmup#warmupMarkdown Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/technical-analysis#warmupMarkdown`. ## Entrypoint @insiderfinance/totalfinance/valuation ### @insiderfinance/totalfinance/valuation#AdjustedPresentValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link adjustedPresentValue}. ```typescript /** Input for {@link adjustedPresentValue}. */ export interface AdjustedPresentValueInput { /** The unlevered (all-equity) operating cash flows, `timeYears: 0` being the valuation instant. */ unleveredCashFlows: readonly TimedCashFlow[]; /** Annual rate (decimal, > −1) for the UNLEVERED operating flows. */ unleveredCostOfCapital: number; /** May be empty — "no side effects" is an explicit statement, not an omission. */ financingSideEffects: readonly FinancingSideEffect[]; /** Default `'annual'` — documented and echoed in `assumptions.compounding`. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `assumptions.compounding`. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - financingSideEffects: readonly FinancingSideEffect[]; default: not declared — May be empty — "no side effects" is an explicit statement, not an omission. - unleveredCashFlows: readonly TimedCashFlow[]; default: not declared — The unlevered (all-equity) operating cash flows, `timeYears: 0` being the valuation instant. - unleveredCostOfCapital: number; default: not declared — Annual rate (decimal, > −1) for the UNLEVERED operating flows. ### @insiderfinance/totalfinance/valuation#AdjustedPresentValueResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link adjustedPresentValue}: the decomposition plus the echoed assumptions. ```typescript /** Result of {@link adjustedPresentValue}: the decomposition plus the echoed assumptions. */ export interface AdjustedPresentValueResult { diagnostics: { warnings: string[]; }; /** `unleveredValue + Σ side-effect present values`. */ adjustedPresentValue: number; /** Present value of the unlevered operating flows at `unleveredCostOfCapital`. */ unleveredValue: number; /** Each side effect's present value at ITS OWN rate, in input order. */ financingSideEffects: FinancingSideEffectValue[]; assumptions: { unleveredCostOfCapital: number; /** The one compounding convention every leg was discounted under. */ compounding: InterestCompounding; sideEffectCount: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - adjustedPresentValue: number; default: not declared — `unleveredValue + Σ side-effect present values`. - assumptions: { compounding: InterestCompounding; sideEffectCount: number; unleveredCostOfCapital: number; }; default: not declared - assumptions.compounding: InterestCompounding; default: not declared — The one compounding convention every leg was discounted under. - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.sideEffectCount: number; default: not declared - assumptions.unleveredCostOfCapital: number; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - financingSideEffects: FinancingSideEffectValue[]; default: not declared — Each side effect's present value at ITS OWN rate, in input order. - unleveredValue: number; default: not declared — Present value of the unlevered operating flows at `unleveredCostOfCapital`. ### @insiderfinance/totalfinance/valuation#AfterTaxCostOfDebtInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link afterTaxCostOfDebt}. ```typescript /** Input for {@link afterTaxCostOfDebt}. */ export interface AfterTaxCostOfDebtInput { /** Annual pre-tax cost of debt (decimal). */ annualPreTaxCostOfDebt: number; /** Marginal tax rate in [0, 1). */ marginalTaxRate: number; /** * An EXPLICIT adjustment (decimal, added to the after-tax cost) for a tax shield the company * cannot use — supplied, never inferred from losses or carryforwards. */ unusableTaxShieldAdjustment?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualPreTaxCostOfDebt: number; default: not declared — Annual pre-tax cost of debt (decimal). - marginalTaxRate: number; default: not declared — Marginal tax rate in [0, 1). - unusableTaxShieldAdjustment?: number; default: not declared — An EXPLICIT adjustment (decimal, added to the after-tax cost) for a tax shield the company cannot use — supplied, never inferred from losses or carryforwards. ### @insiderfinance/totalfinance/valuation#AmortizationRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One row of an {@link amortizationSchedule}. Columns are SIGNED: every column is a positive magnitude for a nonnegative periodic rate, while a negative rate credits interest to the borrower (see the module sign convention above). ```typescript /** * One row of an {@link amortizationSchedule}. Columns are SIGNED: every column is a positive * magnitude for a nonnegative periodic rate, while a negative rate credits interest to the * borrower (see the module sign convention above). */ export interface AmortizationRow { period: number; openingBalance: number; payment: number; /** Interest accrued this period — NEGATIVE when the periodic rate is negative. */ interest: number; /** * Balance reduction this period (`payment − interest`) — EXCEEDS the payment when the interest * component is negative. */ principal: number; /** Present only when the request supplied `periodicFee`. */ fee?: number; closingBalance: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - closingBalance: number; default: not declared - fee?: number; default: not declared — Present only when the request supplied `periodicFee`. - interest: number; default: not declared — Interest accrued this period — NEGATIVE when the periodic rate is negative. - openingBalance: number; default: not declared - payment: number; default: not declared - period: number; default: not declared - principal: number; default: not declared — Balance reduction this period (`payment − interest`) — EXCEEDS the payment when the interest component is negative. ### @insiderfinance/totalfinance/valuation#AmortizationScheduleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link amortizationSchedule}. ```typescript /** Input for {@link amortizationSchedule}. */ export interface AmortizationScheduleInput extends LoanTermsInput { /** A flat per-period fee, reported per row (never folded into interest). */ periodicFee?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - numberOfPeriods: number; default: not declared - paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - periodicFee?: number; default: not declared — A flat per-period fee, reported per row (never folded into interest). - periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - principal: number; default: not declared — Amount borrowed (positive). ### @insiderfinance/totalfinance/valuation#AmortizationScheduleResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The schedule plus its reconciliation facts — the unrounded rows reconcile exactly. ```typescript /** The schedule plus its reconciliation facts — the unrounded rows reconcile exactly. */ export interface AmortizationScheduleResult { rows: AmortizationRow[]; /** Level payment; the final row may differ by the documented binary64 reconciliation drift. */ payment: number; totalInterest: number; totalPrincipal: number; /** The requested residual after the final, roundoff-adjusted installment. */ balloon: number; /** This schedule is UNROUNDED: display rounding is the caller's explicit policy. */ rounding: 'none'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon: number; default: not declared — The requested residual after the final, roundoff-adjusted installment. - payment: number; default: not declared — Level payment; the final row may differ by the documented binary64 reconciliation drift. - rounding: 'none'; default: not declared — This schedule is UNROUNDED: display rounding is the caller's explicit policy. - rows: AmortizationRow[]; default: not declared - totalInterest: number; default: not declared - totalPrincipal: number; default: not declared ### @insiderfinance/totalfinance/valuation#AmountDriver Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An explicit per-period amount, or an explicit fraction of that period's revenue. ```typescript // --------------------------------------------------------------------------------------------------- // Drivers // --------------------------------------------------------------------------------------------------- /** An explicit per-period amount, or an explicit fraction of that period's revenue. */ export type AmountDriver = { amount: number; } | { fractionOfRevenue: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - fractionOfRevenue: number; default: not declared ### @insiderfinance/totalfinance/valuation#CapitalAssetPricingInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link capitalAssetPricingExpectedReturn}. ```typescript // --------------------------------------------------------------------------------------------------- // Expected return and component costs // --------------------------------------------------------------------------------------------------- /** Input for {@link capitalAssetPricingExpectedReturn}. */ export interface CapitalAssetPricingInput { /** Annual risk-free rate (decimal). */ annualRiskFreeRate: number; beta: number; /** Annual market risk premium (decimal) — the premium itself, not the market return. */ annualMarketRiskPremium: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - beta: number; default: not declared ### @insiderfinance/totalfinance/valuation#CapitalComponent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One market-value capital component with its (already after-tax where applicable) annual cost. ```typescript // --------------------------------------------------------------------------------------------------- // Weighted-average cost of capital // --------------------------------------------------------------------------------------------------- /** One market-value capital component with its (already after-tax where applicable) annual cost. */ export interface CapitalComponent { /** e.g. 'equity', 'debt', 'preferred' — a label, echoed; the math treats components uniformly. */ label: string; /** Market value, ≥ 0. */ marketValue: number; /** The component's annual cost (decimal). Tax shields are applied BEFORE this input, explicitly. */ annualCostOfCapital: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualCostOfCapital: number; default: not declared — The component's annual cost (decimal). Tax shields are applied BEFORE this input, explicitly. - label: string; default: not declared — e.g. 'equity', 'debt', 'preferred' — a label, echoed; the math treats components uniformly. - marketValue: number; default: not declared — Market value, ≥ 0. ### @insiderfinance/totalfinance/valuation#ComparableAggregation Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). How the surviving peer multiples collapse into one. REQUIRED — never guessed. ```typescript /** How the surviving peer multiples collapse into one. REQUIRED — never guessed. */ export type ComparableAggregation = 'median' | 'mean' | 'weighted-mean'; ``` ### @insiderfinance/totalfinance/valuation#ComparableCompanyValuationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link comparableCompanyValuation}. ```typescript /** Input for {@link comparableCompanyValuation}. */ export interface ComparableCompanyValuationInput { /** The metric's name (e.g. `'EV/EBITDA'`). Recorded, never inferred. */ metricName: string; /** What the metric MEANS (e.g. `'enterprise value over trailing-twelve-month EBITDA'`). */ metricDefinition: string; /** The period the metric covers (e.g. `'TTM 2025-Q4'`). Recorded, never inferred. */ period: string; /** `'enterprise'` when the multiple prices the firm, `'equity'` when it prices the equity. */ valuationBasis: ComparableValuationBasis; /** The subject company's metric amount the aggregated multiple is applied to. */ subjectMetricAmount: number; peers: readonly ComparablePeer[]; aggregation: ComparableAggregation; /** * Peer weights, REQUIRED for (and only valid with) `'weighted-mean'`, one per peer in peer * order. Each must be a finite number > 0; they need not sum to 1 — they are normalized and * the normalized weights are echoed in `assumptions.weightsNormalized`. */ weights?: readonly number[]; /** REQUIRED — an unstated outlier policy is a silent default. Use `{ method: 'none' }` to keep all. */ outlierPolicy: ComparableOutlierPolicy; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregation: ComparableAggregation; default: not declared - metricDefinition: string; default: not declared — What the metric MEANS (e.g. `'enterprise value over trailing-twelve-month EBITDA'`). - metricName: string; default: not declared — The metric's name (e.g. `'EV/EBITDA'`). Recorded, never inferred. - outlierPolicy: ComparableOutlierPolicy; default: not declared — REQUIRED — an unstated outlier policy is a silent default. Use `{ method: 'none' }` to keep all. - outlierPolicy.method: ('interquartile-range') | ('none'); default: not declared - outlierPolicy.multiplier: number; default: not declared - peers: readonly ComparablePeer[]; default: not declared - period: string; default: not declared — The period the metric covers (e.g. `'TTM 2025-Q4'`). Recorded, never inferred. - subjectMetricAmount: number; default: not declared — The subject company's metric amount the aggregated multiple is applied to. - valuationBasis: ComparableValuationBasis; default: not declared — `'enterprise'` when the multiple prices the firm, `'equity'` when it prices the equity. - weights?: readonly number[]; default: not declared — Peer weights, REQUIRED for (and only valid with) `'weighted-mean'`, one per peer in peer order. Each must be a finite number > 0; they need not sum to 1 — they are normalized and the normalized weights are echoed in `assumptions.weightsNormalized`. ### @insiderfinance/totalfinance/valuation#ComparableCompanyValuationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link comparableCompanyValuation} — every recorded convention echoed. ```typescript /** Result of {@link comparableCompanyValuation} — every recorded convention echoed. */ export interface ComparableCompanyValuationResult { diagnostics: { /** One warning per excluded peer. */ warnings: string[]; }; /** `aggregatedMultiple × subjectMetricAmount`, on the declared `valuationBasis`. */ impliedValue: number; aggregatedMultiple: number; valuationBasis: ComparableValuationBasis; metricName: string; metricDefinition: string; period: string; /** The peers that survived the outlier policy, in input order. */ peersUsed: ComparablePeerUsed[]; /** The peers the outlier policy excluded, in input order, each with its reason. */ peersExcluded: ComparablePeerExcluded[]; aggregation: ComparableAggregation; assumptions: { /** The outlier policy as requested — echoed so the record is self-describing. */ outlierPolicy: ComparableOutlierPolicy; /** Present only under `'weighted-mean'`: the normalized weights, aligned with `peersUsed`. */ weightsNormalized?: number[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aggregatedMultiple: number; default: not declared - aggregation: ComparableAggregation; default: not declared - assumptions: { outlierPolicy: ComparableOutlierPolicy; weightsNormalized?: number[]; }; default: not declared - assumptions.outlierPolicy: ComparableOutlierPolicy; default: not declared — The outlier policy as requested — echoed so the record is self-describing. - assumptions.outlierPolicy.method: ('interquartile-range') | ('none'); default: not declared - assumptions.outlierPolicy.multiplier: number; default: not declared - assumptions.weightsNormalized?: number[]; default: not declared — Present only under `'weighted-mean'`: the normalized weights, aligned with `peersUsed`. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — One warning per excluded peer. - impliedValue: number; default: not declared — `aggregatedMultiple × subjectMetricAmount`, on the declared `valuationBasis`. - metricDefinition: string; default: not declared - metricName: string; default: not declared - peersExcluded: ComparablePeerExcluded[]; default: not declared — The peers the outlier policy excluded, in input order, each with its reason. - peersUsed: ComparablePeerUsed[]; default: not declared — The peers that survived the outlier policy, in input order. - period: string; default: not declared - valuationBasis: ComparableValuationBasis; default: not declared ### @insiderfinance/totalfinance/valuation#ComparableOutlierPolicy Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The EXPLICIT outlier policy, applied to peer multiples BEFORE aggregation. `'interquartile-range'` excludes peers whose multiple lies outside `[Q1 − multiplier·IQR, Q3 + multiplier·IQR]`, with Q1/Q3 the standard linear-interpolation quantiles of the peer multiples. `'none'` keeps every peer — stated, not assumed. ```typescript /** * The EXPLICIT outlier policy, applied to peer multiples BEFORE aggregation. * * `'interquartile-range'` excludes peers whose multiple lies outside * `[Q1 − multiplier·IQR, Q3 + multiplier·IQR]`, with Q1/Q3 the standard linear-interpolation * quantiles of the peer multiples. `'none'` keeps every peer — stated, not assumed. */ export type ComparableOutlierPolicy = { method: 'none'; } | { method: 'interquartile-range'; multiplier: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method: ('interquartile-range') | ('none'); default: not declared - multiplier: number; default: not declared ### @insiderfinance/totalfinance/valuation#ComparablePeer Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One peer observation: the name and its multiple for the SAME metric/period as the subject. ```typescript /** One peer observation: the name and its multiple for the SAME metric/period as the subject. */ export interface ComparablePeer { peerName: string; /** The peer's multiple (e.g. EV/EBITDA of 8.5 is `8.5`). */ multiple: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiple: number; default: not declared — The peer's multiple (e.g. EV/EBITDA of 8.5 is `8.5`). - peerName: string; default: not declared ### @insiderfinance/totalfinance/valuation#ComparablePeerExcluded Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One peer the outlier policy excluded, with the exact reason. ```typescript /** One peer the outlier policy excluded, with the exact reason. */ export interface ComparablePeerExcluded { peerName: string; multiple: number; reason: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiple: number; default: not declared - peerName: string; default: not declared - reason: string; default: not declared ### @insiderfinance/totalfinance/valuation#ComparablePeerUsed Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One peer that survived the outlier policy; `weight` present only under `'weighted-mean'`. ```typescript /** One peer that survived the outlier policy; `weight` present only under `'weighted-mean'`. */ export interface ComparablePeerUsed { peerName: string; multiple: number; /** The NORMALIZED weight applied to this peer (present only under `'weighted-mean'`). */ weight?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - multiple: number; default: not declared - peerName: string; default: not declared - weight?: number; default: not declared — The NORMALIZED weight applied to this peer (present only under `'weighted-mean'`). ### @insiderfinance/totalfinance/valuation#ComparableValuationBasis Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether the multiple prices the whole firm or only the equity. REQUIRED — never guessed. ```typescript /** Whether the multiple prices the whole firm or only the equity. REQUIRED — never guessed. */ export type ComparableValuationBasis = 'enterprise' | 'equity'; ``` ### @insiderfinance/totalfinance/valuation#ConvertPriceLevelInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Select exactly one method; ratio and reference fields cannot be mixed at runtime. ```typescript /** Select exactly one method; ratio and reference fields cannot be mixed at runtime. */ export type ConvertPriceLevelInput = ReferencePriceLevelInput | RatioPriceLevelInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. ### @insiderfinance/totalfinance/valuation#CostOfEquityInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link costOfEquity} — the method is an explicit discriminant, never inferred. ```typescript /** Input for {@link costOfEquity} — the method is an explicit discriminant, never inferred. */ export type CostOfEquityInput = { method: 'capital-asset-pricing'; annualRiskFreeRate: number; beta: number; annualMarketRiskPremium: number; } | { method: 'dividend-growth'; /** The NEXT annual dividend per share (already grown one period). */ nextAnnualDividendPerShare: number; sharePrice: number; perpetualGrowthRate: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualMarketRiskPremium: number; default: not declared - annualRiskFreeRate: number; default: not declared - beta: number; default: not declared - method: ('capital-asset-pricing') | ('dividend-growth'); default: not declared - nextAnnualDividendPerShare: number; default: not declared — The NEXT annual dividend per share (already grown one period). - perpetualGrowthRate: number; default: not declared - sharePrice: number; default: not declared ### @insiderfinance/totalfinance/valuation#DatedCashFlow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cash flow on a strict `YYYY-MM-DD` calendar date. ```typescript /** One cash flow on a strict `YYYY-MM-DD` calendar date. */ export interface DatedCashFlow { /** Positive inflow, negative outflow. */ amount: number; /** Strict `YYYY-MM-DD` calendar date. */ cashFlowDate: string; label?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Positive inflow, negative outflow. - cashFlowDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date. - label?: string; default: not declared ### @insiderfinance/totalfinance/valuation#DatedInternalRateOfReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link datedInternalRateOfReturn}. ```typescript // --------------------------------------------------------------------------------------------------- // datedInternalRateOfReturn // --------------------------------------------------------------------------------------------------- /** Input for {@link datedInternalRateOfReturn}. */ export interface DatedInternalRateOfReturnInput { cashFlows: readonly DatedCashFlow[]; /** Strict `YYYY-MM-DD` valuation date; flows before it ACCUMULATE forward, never drop. */ asOf: string; /** Default `'annual'` — documented and echoed in `.explain()`. */ compounding?: InterestCompounding; /** Default `'ACT/365F'` — documented and echoed in `.explain()`. */ dayCount?: DayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date; flows before it ACCUMULATE forward, never drop. - cashFlows: readonly DatedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - dayCount?: DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed in `.explain()`. ### @insiderfinance/totalfinance/valuation#DatedNetPresentValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link datedNetPresentValue}. ```typescript /** Input for {@link datedNetPresentValue}. */ export interface DatedNetPresentValueInput { cashFlows: readonly DatedCashFlow[]; /** Strict `YYYY-MM-DD` valuation date. */ asOf: string; /** Annual discount rate (decimal). */ annualDiscountRate: number; /** Default `'annual'` — documented and echoed. */ compounding?: InterestCompounding; /** Default `'ACT/365F'` — documented and echoed. */ dayCount?: DayCount; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date. - cashFlows: readonly DatedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - dayCount?: DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed. ### @insiderfinance/totalfinance/valuation#DecliningBalanceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Declining-balance adds its explicit rate multiplier. ```typescript /** Declining-balance adds its explicit rate multiplier. */ export interface DecliningBalanceInput extends DepreciationInput { /** The declining-balance factor (e.g. `1.5`); double-declining uses its own head. */ factor: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cost: number; default: not declared — Acquisition cost (positive). - factor: number; default: not declared — The declining-balance factor (e.g. `1.5`); double-declining uses its own head. - period: number; default: not declared — 1-based period being asked about. - salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). ### @insiderfinance/totalfinance/valuation#DepreciationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The explicit depreciation coordinates every method requires. ```typescript // --------------------------------------------------------------------------------------------------- // Depreciation — cost, salvage, life, period; never inferred tax rules // --------------------------------------------------------------------------------------------------- /** The explicit depreciation coordinates every method requires. */ export interface DepreciationInput { /** Acquisition cost (positive). */ cost: number; /** Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. */ salvageValue: number; /** Useful life in whole periods (≥ 1). */ usefulLifePeriods: number; /** 1-based period being asked about. */ period: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cost: number; default: not declared — Acquisition cost (positive). - period: number; default: not declared — 1-based period being asked about. - salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). ### @insiderfinance/totalfinance/valuation#DiaToDjiaLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate DIA → DJIA proportional mapping. ```typescript /** Three explicit prices for approximate DIA → DJIA proportional mapping. */ export interface DiaToDjiaLevelInput { /** Requested level in USD per DIA share; finite and nonnegative. */ diaPriceLevel: number; /** Comparable reference in USD per DIA share; finite and positive. */ referenceDiaPrice: number; /** Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. */ referenceDjiaPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. ### @insiderfinance/totalfinance/valuation#DiaToYmLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate DIA → YM proportional mapping. ```typescript /** Three explicit prices for approximate DIA → YM proportional mapping. */ export interface DiaToYmLevelInput { /** Requested level in USD per DIA share; finite and nonnegative. */ diaPriceLevel: number; /** Comparable reference in USD per DIA share; finite and positive. */ referenceDiaPrice: number; /** Comparable reference in YM index points; finite and positive. */ referenceYmPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. ### @insiderfinance/totalfinance/valuation#DiscountCashFlowsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link discountCashFlows}: per-flow present values plus their total. ```typescript // --------------------------------------------------------------------------------------------------- // Cash-flow discounting // --------------------------------------------------------------------------------------------------- /** Input for {@link discountCashFlows}: per-flow present values plus their total. */ export interface DiscountCashFlowsInput { cashFlows: readonly TimedCashFlow[]; /** Annual discount rate (decimal). */ annualDiscountRate: number; /** Default `'annual'` — documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Every assumption the valuation rests on — closed and versioned. ```typescript /** Every assumption the valuation rests on — closed and versioned. */ export interface DiscountedCashFlowAssumptions { /** The version of THIS assumptions contract. */ contractVersion: 1; modelVersion: 1; valuationDate: string; currency: string; valuationBasis: 'firm' | 'equity'; annualDiscountRate: number; /** Where the discount rate came from. This analysis never derives one: always user-supplied. */ discountRateSource: 'user-supplied'; compounding: InterestCompounding; dayCount: DayCount; terminalValueMethod: TerminalValueMethod; /** The perpetuity convention: the stated terminal flow is the FINAL forecast-period flow. */ terminalCashFlowConvention: 'final-forecast-period-flow'; /** How the equity bridge was decided. */ bridgeDecision: 'bridge-supplied' | 'no-bridge-supplied-equity-value-absent' | 'equity-basis-no-bridge-applicable'; /** How the per-share denominator was decided. */ shareCountDecision: 'diluted-shares-supplied' | 'no-shares-supplied-per-share-absent'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared - bridgeDecision: 'bridge-supplied' | 'no-bridge-supplied-equity-value-absent' | 'equity-basis-no-bridge-applicable'; default: not declared — How the equity bridge was decided. - compounding: InterestCompounding; default: not declared - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - contractVersion: 1; default: not declared — The version of THIS assumptions contract. - currency: string; default: not declared - dayCount: DayCount; default: not declared - discountRateSource: 'user-supplied'; default: not declared — Where the discount rate came from. This analysis never derives one: always user-supplied. - modelVersion: 1; default: not declared - shareCountDecision: 'diluted-shares-supplied' | 'no-shares-supplied-per-share-absent'; default: not declared — How the per-share denominator was decided. - terminalCashFlowConvention: 'final-forecast-period-flow'; default: not declared — The perpetuity convention: the stated terminal flow is the FINAL forecast-period flow. - terminalValueMethod: TerminalValueMethod; default: not declared - terminalValueMethod.exitMultiple: number; default: not declared - terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - terminalValueMethod.perpetualGrowthRate: number; default: not declared - terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - terminalValueMethod.terminalMetricAmount: number; default: not declared - valuationBasis: 'equity' | 'firm'; default: not declared - valuationDate: string; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowCommonResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The shared core of a DCF result. ```typescript /** The shared core of a DCF result. */ export interface DiscountedCashFlowCommonResult { projectedCashFlows: DiscountedProjectedCashFlowRow[]; projectedCashFlowPresentValue: number; terminalValue: number; terminalValuePresentValue: number; assumptions: DiscountedCashFlowAssumptions; diagnostics: DiscountedCashFlowDiagnostics; provenance?: ValuationProvenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: DiscountedCashFlowAssumptions; default: not declared - assumptions.annualDiscountRate: number; default: not declared - assumptions.bridgeDecision: 'bridge-supplied' | 'no-bridge-supplied-equity-value-absent' | 'equity-basis-no-bridge-applicable'; default: not declared — How the equity bridge was decided. - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.contractVersion: 1; default: not declared — The version of THIS assumptions contract. - assumptions.currency: string; default: not declared - assumptions.dayCount: DayCount; default: not declared - assumptions.discountRateSource: 'user-supplied'; default: not declared — Where the discount rate came from. This analysis never derives one: always user-supplied. - assumptions.modelVersion: 1; default: not declared - assumptions.shareCountDecision: 'diluted-shares-supplied' | 'no-shares-supplied-per-share-absent'; default: not declared — How the per-share denominator was decided. - assumptions.terminalCashFlowConvention: 'final-forecast-period-flow'; default: not declared — The perpetuity convention: the stated terminal flow is the FINAL forecast-period flow. - assumptions.terminalValueMethod: TerminalValueMethod; default: not declared - assumptions.terminalValueMethod.exitMultiple: number; default: not declared - assumptions.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - assumptions.terminalValueMethod.perpetualGrowthRate: number; default: not declared - assumptions.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - assumptions.terminalValueMethod.terminalMetricAmount: number; default: not declared - assumptions.valuationBasis: 'equity' | 'firm'; default: not declared - assumptions.valuationDate: string; default: not declared - diagnostics: DiscountedCashFlowDiagnostics; default: not declared - diagnostics.exclusions: string[]; default: not declared — Inputs deliberately not used, each with the reason (empty when everything participated). - diagnostics.projectedPeriodCount: number; default: not declared - diagnostics.terminalValueShareOfValue: number; default: not declared — Terminal value's share of the TOTAL present value — the classic sanity number. - diagnostics.warnings: string[]; default: not declared - projectedCashFlowPresentValue: number; default: not declared - projectedCashFlows: DiscountedProjectedCashFlowRow[]; default: not declared - provenance?: ValuationProvenance; default: not declared - provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - provenance.source?: string; default: not declared — Who or what prepared the inputs. - provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - terminalValue: number; default: not declared - terminalValuePresentValue: number; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowDiagnostics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnostics the valuation discloses — closed and versioned alongside the assumptions. ```typescript /** Diagnostics the valuation discloses — closed and versioned alongside the assumptions. */ export interface DiscountedCashFlowDiagnostics { projectedPeriodCount: number; /** Terminal value's share of the TOTAL present value — the classic sanity number. */ terminalValueShareOfValue: number; warnings: string[]; /** Inputs deliberately not used, each with the reason (empty when everything participated). */ exclusions: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exclusions: string[]; default: not declared — Inputs deliberately not used, each with the reason (empty when everything participated). - projectedPeriodCount: number; default: not declared - terminalValueShareOfValue: number; default: not declared — Terminal value's share of the TOTAL present value — the classic sanity number. - warnings: string[]; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowFromStatementsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link discountedCashFlowFromStatements}. ```typescript // --------------------------------------------------------------------------------------------------- // discountedCashFlowFromStatements // --------------------------------------------------------------------------------------------------- /** Input for {@link discountedCashFlowFromStatements}. */ export interface DiscountedCashFlowFromStatementsInput { /** The statement projection (see {@link projectFinancialStatements}). */ projection: ProjectStatementsInput; /** Everything the direct DCF needs EXCEPT the flows — those come from the projection. */ valuation: Omit; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - projection: ProjectStatementsInput; default: not declared — The statement projection (see {@link projectFinancialStatements}). - projection.baseStatements: FinancialStatements; default: not declared — The typed historical anchor — beginning balances come from HERE, not from an assumption. - projection.baseStatements.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - projection.baseStatements.balance.accountsPayable?: number; default: not declared - projection.baseStatements.balance.accountsReceivable?: number; default: not declared - projection.baseStatements.balance.cashAndCashEquivalents: number; default: not declared - projection.baseStatements.balance.currentAssets?: number; default: not declared - projection.baseStatements.balance.currentLiabilities?: number; default: not declared - projection.baseStatements.balance.inventory?: number; default: not declared - projection.baseStatements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - projection.baseStatements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - projection.baseStatements.balance.minorityInterest?: number; default: not declared - projection.baseStatements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - projection.baseStatements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - projection.baseStatements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - projection.baseStatements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - projection.baseStatements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - projection.baseStatements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - projection.baseStatements.balance.period.fiscalYear: number; default: not declared - projection.baseStatements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - projection.baseStatements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - projection.baseStatements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - projection.baseStatements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - projection.baseStatements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - projection.baseStatements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - projection.baseStatements.balance.preferredEquity?: number; default: not declared - projection.baseStatements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - projection.baseStatements.balance.retainedEarnings?: number; default: not declared - projection.baseStatements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - projection.baseStatements.balance.shortTermInvestments?: number; default: not declared - projection.baseStatements.balance.totalAssets: number; default: not declared - projection.baseStatements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - projection.baseStatements.balance.totalEquity: number; default: not declared - projection.baseStatements.balance.totalLiabilities: number; default: not declared - projection.baseStatements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - projection.baseStatements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - projection.baseStatements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - projection.baseStatements.cashFlow.depreciationAndAmortization?: number; default: not declared - projection.baseStatements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - projection.baseStatements.cashFlow.financingCashFlow: number; default: not declared - projection.baseStatements.cashFlow.investingCashFlow: number; default: not declared - projection.baseStatements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - projection.baseStatements.cashFlow.operatingCashFlow: number; default: not declared - projection.baseStatements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - projection.baseStatements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - projection.baseStatements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - projection.baseStatements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - projection.baseStatements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - projection.baseStatements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - projection.baseStatements.cashFlow.period.fiscalYear: number; default: not declared - projection.baseStatements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - projection.baseStatements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - projection.baseStatements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - projection.baseStatements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - projection.baseStatements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - projection.baseStatements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - projection.baseStatements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - projection.baseStatements.cashFlow.stockBasedCompensation?: number; default: not declared - projection.baseStatements.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - projection.baseStatements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - projection.baseStatements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - projection.baseStatements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - projection.baseStatements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - projection.baseStatements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - projection.baseStatements.income.interestExpense?: number; default: not declared — Positive magnitude. - projection.baseStatements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - projection.baseStatements.income.netIncome: number; default: not declared - projection.baseStatements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - projection.baseStatements.income.operatingIncome: number; default: not declared - projection.baseStatements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - projection.baseStatements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - projection.baseStatements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - projection.baseStatements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - projection.baseStatements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - projection.baseStatements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - projection.baseStatements.income.period.fiscalYear: number; default: not declared - projection.baseStatements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - projection.baseStatements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - projection.baseStatements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - projection.baseStatements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - projection.baseStatements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - projection.baseStatements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - projection.baseStatements.income.revenue: number; default: not declared - projection.baseStatements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - projection.periods: readonly StatementProjectionPeriod[]; default: not declared - valuation: Omit; default: not declared — Everything the direct DCF needs EXCEPT the flows — those come from the projection. - valuation.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - valuation.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - valuation.compounding.periodsPerYear: number; default: not declared - valuation.compounding.type: 'periodic'; default: not declared - valuation.currency: string; default: not declared - valuation.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - valuation.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - valuation.enterpriseToEquityBridge?: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - valuation.enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - valuation.enterpriseToEquityBridge.minorityInterest: number; default: not declared - valuation.enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - valuation.enterpriseToEquityBridge.preferredEquity: number; default: not declared - valuation.enterpriseToEquityBridge.totalDebt: number; default: not declared - valuation.provenance?: import('@insiderfinance/totalfinance/valuation').ValuationProvenance; default: not declared - valuation.provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - valuation.provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - valuation.provenance.source?: string; default: not declared — Who or what prepared the inputs. - valuation.provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - valuation.terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - valuation.terminalValueMethod.exitMultiple: number; default: not declared - valuation.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - valuation.terminalValueMethod.perpetualGrowthRate: number; default: not declared - valuation.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - valuation.terminalValueMethod.terminalMetricAmount: number; default: not declared - valuation.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - valuation.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowFromStatementsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link discountedCashFlowFromStatements}. ```typescript /** Result of {@link discountedCashFlowFromStatements}. */ export interface DiscountedCashFlowFromStatementsResult { assumptions: { /** Which flow column fed the valuation, decided by the basis — never relabeled. */ cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; projectedPeriodCount: number; }; diagnostics: { warnings: string[]; }; projection: ProjectStatementsResult; /** Which flow column fed the valuation, decided by the valuation basis — never relabeled. */ cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; valuation: DiscountedCashFlowResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; projectedPeriodCount: number; }; default: not declared - assumptions.cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; default: not declared — Which flow column fed the valuation, decided by the basis — never relabeled. - assumptions.projectedPeriodCount: number; default: not declared - cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; default: not declared — Which flow column fed the valuation, decided by the valuation basis — never relabeled. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - projection: ProjectStatementsResult; default: not declared - projection.assumptions: { periods: readonly StatementProjectionPeriod[]; }; default: not declared - projection.assumptions.periods: readonly StatementProjectionPeriod[]; default: not declared - projection.balancingItem: 'cash'; default: not declared — The named balancing item. CASH absorbs the residual of the articulated statements — the identity `assets = liabilities + equity` then holds by construction, and the proof is the per-period `identityDifference` (floating-point dust, gated in tests). - projection.diagnostics: { warnings: string[]; }; default: not declared - projection.diagnostics.warnings: string[]; default: not declared — Any period whose identity residual exceeds floating-point dust. - projection.reconciliation: { periodLabel: string; identityDifference: number; }[]; default: not declared - projection.statements: ProjectedStatements[]; default: not declared - valuation: DiscountedCashFlowResult; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link discountedCashFlow}. ```typescript /** Input for {@link discountedCashFlow}. */ export interface DiscountedCashFlowInput { /** * Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for * FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. */ valuationBasis: 'firm' | 'equity'; /** Strict `YYYY-MM-DD`. Every dated flow discounts from here. */ valuationDate: string; currency: string; projectedCashFlows: ProjectedCashFlowSchedule; /** Annual discount rate (decimal). A professional DCF never obtains one from a default. */ annualDiscountRate: number; /** REQUIRED — a professional DCF states its convention. */ compounding: InterestCompounding; /** REQUIRED when any flow is dated; rejected as unused when every flow is timed. */ dayCount?: DayCount; terminalValueMethod: TerminalValueMethod; /** Firm basis only: enables the equity bridge. */ enterpriseToEquityBridge?: EnterpriseToEquityBridge; /** Enables per-share value. */ dilutedSharesOutstanding?: number; provenance?: ValuationProvenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - compounding: InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - currency: string; default: not declared - dayCount?: DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - enterpriseToEquityBridge?: EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - enterpriseToEquityBridge.minorityInterest: number; default: not declared - enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - enterpriseToEquityBridge.preferredEquity: number; default: not declared - enterpriseToEquityBridge.totalDebt: number; default: not declared - projectedCashFlows: ProjectedCashFlowSchedule; default: not declared - provenance?: ValuationProvenance; default: not declared - provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - provenance.source?: string; default: not declared — Who or what prepared the inputs. - provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - terminalValueMethod: TerminalValueMethod; default: not declared - terminalValueMethod.exitMultiple: number; default: not declared - terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - terminalValueMethod.perpetualGrowthRate: number; default: not declared - terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - terminalValueMethod.terminalMetricAmount: number; default: not declared - valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The basis-discriminated DCF result: FCFF → firm, FCFE → equity, never relabeled. ```typescript /** The basis-discriminated DCF result: FCFF → firm, FCFE → equity, never relabeled. */ export type DiscountedCashFlowResult = DiscountedCashFlowCommonResult & ({ valuationBasis: 'firm'; enterpriseValue: number; enterpriseToEquityBridge?: EnterpriseToEquityBridge; equityValue?: number; /** Present exactly when a bridge was supplied but equity value is still absent. */ equityValueAbsentReason?: string; valuePerShare?: number; valuePerShareAbsentReason?: string; } | { valuationBasis: 'equity'; equityValue: number; valuePerShare?: number; valuePerShareAbsentReason?: string; }); ``` ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One discounted flow: the input flow plus its discount factor and present value. ```typescript /** One discounted flow: the input flow plus its discount factor and present value. */ export interface DiscountedCashFlowRow { amount: number; timeYears: number; label?: string; discountFactor: number; presentValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - discountFactor: number; default: not declared - label?: string; default: not declared - presentValue: number; default: not declared - timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedCashFlowScenario Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One named deterministic scenario: explicit overrides of the base input, nothing invented. ```typescript // --------------------------------------------------------------------------------------------------- // Scenario analysis // --------------------------------------------------------------------------------------------------- /** One named deterministic scenario: explicit overrides of the base input, nothing invented. */ export interface DiscountedCashFlowScenario { scenarioName: string; overrides: Partial>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - overrides: Partial>; default: not declared - overrides.annualDiscountRate?: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - overrides.dayCount?: DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - overrides.projectedCashFlows?: ProjectedCashFlowSchedule; default: not declared - overrides.terminalValueMethod?: TerminalValueMethod; default: not declared - overrides.terminalValueMethod.exitMultiple: number; default: not declared - overrides.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - overrides.terminalValueMethod.perpetualGrowthRate: number; default: not declared - overrides.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - overrides.terminalValueMethod.terminalMetricAmount: number; default: not declared - scenarioName: string; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedPaybackInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link discountedPaybackPeriod}. A separate interface rather than optional fields on {@link PaybackInput}: the discounted head REQUIRES its rate at runtime, and a shared type with `annualDiscountRate?` would license a call the function refuses. ```typescript /** * Input for {@link discountedPaybackPeriod}. A separate interface rather than optional fields on * {@link PaybackInput}: the discounted head REQUIRES its rate at runtime, and a shared type with * `annualDiscountRate?` would license a call the function refuses. */ export interface DiscountedPaybackInput { cashFlows: readonly TimedCashFlow[]; /** Annual rate (decimal). */ annualDiscountRate: number; /** Default `'annual'` — documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual rate (decimal). - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/valuation#DiscountedProjectedCashFlowRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One discounted projection row. ```typescript /** One discounted projection row. */ export interface DiscountedProjectedCashFlowRow { cashFlowDate?: string; timeYears: number; cashFlowAmount: number; discountFactor: number; presentValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashFlowAmount: number; default: not declared - cashFlowDate?: string; default: not declared - discountFactor: number; default: not declared - presentValue: number; default: not declared - timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#DividendDiscountInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link dividendDiscountValuation}. ```typescript // --------------------------------------------------------------------------------------------------- // Dividend discount // --------------------------------------------------------------------------------------------------- /** Input for {@link dividendDiscountValuation}. */ export interface DividendDiscountInput { /** * Explicit projected dividends PER SHARE (timed from today). An empty projection stage with a * perpetual-growth terminal is the classic single-stage Gordon model. */ projectedDividendsPerShare: readonly TimedCashFlow[]; /** Annual cost of equity (decimal) — the discount rate for dividends. */ annualCostOfEquity: number; terminalValueMethod: TerminalValueMethod; /** Default `'annual'` — documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualCostOfEquity: number; default: not declared — Annual cost of equity (decimal) — the discount rate for dividends. - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - projectedDividendsPerShare: readonly TimedCashFlow[]; default: not declared — Explicit projected dividends PER SHARE (timed from today). An empty projection stage with a perpetual-growth terminal is the classic single-stage Gordon model. - terminalValueMethod: TerminalValueMethod; default: not declared - terminalValueMethod.exitMultiple: number; default: not declared - terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - terminalValueMethod.perpetualGrowthRate: number; default: not declared - terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - terminalValueMethod.terminalMetricAmount: number; default: not declared ### @insiderfinance/totalfinance/valuation#DividendDiscountResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link dividendDiscountValuation}. ```typescript /** Result of {@link dividendDiscountValuation}. */ export interface DividendDiscountResult { diagnostics: { warnings: string[]; }; valuePerShare: number; rows: Array<{ timeYears: number; dividendPerShare: number; discountFactor: number; presentValue: number; }>; projectedDividendPresentValue: number; terminalValue: number; terminalValuePresentValue: number; assumptions: { annualCostOfEquity: number; compounding: InterestCompounding; terminalValueMethod: TerminalValueMethod; terminalCashFlowConvention: 'final-forecast-period-flow'; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { annualCostOfEquity: number; compounding: InterestCompounding; terminalCashFlowConvention: 'final-forecast-period-flow'; terminalValueMethod: TerminalValueMethod; }; default: not declared - assumptions.annualCostOfEquity: number; default: not declared - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.terminalCashFlowConvention: 'final-forecast-period-flow'; default: not declared - assumptions.terminalValueMethod: TerminalValueMethod; default: not declared - assumptions.terminalValueMethod.exitMultiple: number; default: not declared - assumptions.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - assumptions.terminalValueMethod.perpetualGrowthRate: number; default: not declared - assumptions.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - assumptions.terminalValueMethod.terminalMetricAmount: number; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - projectedDividendPresentValue: number; default: not declared - rows: { timeYears: number; dividendPerShare: number; discountFactor: number; presentValue: number; }[]; default: not declared - terminalValue: number; default: not declared - terminalValuePresentValue: number; default: not declared - valuePerShare: number; default: not declared ### @insiderfinance/totalfinance/valuation#DjiaToDiaLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate DJIA → DIA proportional mapping. ```typescript /** Three explicit prices for approximate DJIA → DIA proportional mapping. */ export interface DjiaToDiaLevelInput { /** Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. */ djiaPriceLevel: number; /** Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. */ referenceDjiaPrice: number; /** Comparable reference in USD per DIA share; finite and positive. */ referenceDiaPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. ### @insiderfinance/totalfinance/valuation#EffectiveAnnualRateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link effectiveAnnualRate}: the EAR of a nominal rate under its compounding. ```typescript // --------------------------------------------------------------------------------------------------- // Rate conversion // --------------------------------------------------------------------------------------------------- /** Input for {@link effectiveAnnualRate}: the EAR of a nominal rate under its compounding. */ export interface EffectiveAnnualRateInput { /** Nominal (stated) annual rate (decimal). */ nominalAnnualRate: number; /** REQUIRED — a rate conversion never guesses its convention. */ compounding: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - compounding: InterestCompounding; default: not declared — REQUIRED — a rate conversion never guesses its convention. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - nominalAnnualRate: number; default: not declared — Nominal (stated) annual rate (decimal). ### @insiderfinance/totalfinance/valuation#EnterpriseToEquityBridge Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The enterprise-to-equity bridge — every field explicit, none silently zeroed. ```typescript // --------------------------------------------------------------------------------------------------- // Enterprise ⇄ equity bridge // --------------------------------------------------------------------------------------------------- /** The enterprise-to-equity bridge — every field explicit, none silently zeroed. */ export interface EnterpriseToEquityBridge { cashAndCashEquivalents: number; totalDebt: number; preferredEquity: number; minorityInterest: number; nonOperatingAssets: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashAndCashEquivalents: number; default: not declared - minorityInterest: number; default: not declared - nonOperatingAssets: number; default: not declared - preferredEquity: number; default: not declared - totalDebt: number; default: not declared ### @insiderfinance/totalfinance/valuation#EnterpriseToEquityValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link enterpriseToEquityValue}. ```typescript /** Input for {@link enterpriseToEquityValue}. */ export interface EnterpriseToEquityValueInput { enterpriseValue: number; enterpriseToEquityBridge: EnterpriseToEquityBridge; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - enterpriseToEquityBridge: EnterpriseToEquityBridge; default: not declared - enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - enterpriseToEquityBridge.minorityInterest: number; default: not declared - enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - enterpriseToEquityBridge.preferredEquity: number; default: not declared - enterpriseToEquityBridge.totalDebt: number; default: not declared - enterpriseValue: number; default: not declared ### @insiderfinance/totalfinance/valuation#EquivalentAnnualAnnuityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link equivalentAnnualAnnuity}. ```typescript /** Input for {@link equivalentAnnualAnnuity}. */ export interface EquivalentAnnualAnnuityInput { cashFlows: readonly TimedCashFlow[]; annualDiscountRate: number; /** Project length in years (the annuity horizon). */ projectLifeYears: number; /** Default `'annual'`. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'`. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - projectLifeYears: number; default: not declared — Project length in years (the annuity horizon). ### @insiderfinance/totalfinance/valuation#EquivalentInterestRateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link equivalentInterestRate}: re-express a rate in another convention. ```typescript /** Input for {@link equivalentInterestRate}: re-express a rate in another convention. */ export interface EquivalentInterestRateInput { /** Annual rate (decimal) quoted in `fromCompounding`. */ annualInterestRate: number; /** REQUIRED source convention. */ fromCompounding: InterestCompounding; /** REQUIRED target convention. */ toCompounding: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualInterestRate: number; default: not declared — Annual rate (decimal) quoted in `fromCompounding`. - fromCompounding: InterestCompounding; default: not declared — REQUIRED source convention. - fromCompounding.periodsPerYear: number; default: not declared - fromCompounding.type: 'periodic'; default: not declared - toCompounding: InterestCompounding; default: not declared — REQUIRED target convention. - toCompounding.periodsPerYear: number; default: not declared - toCompounding.type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/valuation#EsToSpyLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate ES → SPY proportional mapping. ```typescript /** Three explicit prices for approximate ES → SPY proportional mapping. */ export interface EsToSpyLevelInput { /** Requested level in ES index points; finite and nonnegative. */ esPriceLevel: number; /** Comparable reference in ES index points; finite and positive. */ referenceEsPrice: number; /** Comparable reference in USD per SPY share; finite and positive. */ referenceSpyPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. ### @insiderfinance/totalfinance/valuation#FinancingSideEffect Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One financing side effect: a labeled stream discounted at ITS OWN rate. ```typescript /** One financing side effect: a labeled stream discounted at ITS OWN rate. */ export interface FinancingSideEffect { /** What this side effect IS (e.g. `'interest tax shield'`, `'issuance costs'`). */ label: string; cashFlows: readonly TimedCashFlow[]; /** Annual rate (decimal) reflecting THIS side effect's risk — never inherited silently. */ annualDiscountRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual rate (decimal) reflecting THIS side effect's risk — never inherited silently. - cashFlows: readonly TimedCashFlow[]; default: not declared - label: string; default: not declared — What this side effect IS (e.g. `'interest tax shield'`, `'issuance costs'`). ### @insiderfinance/totalfinance/valuation#FinancingSideEffectValue Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One side effect echoed with its present value — the decomposition the method exists for. ```typescript /** One side effect echoed with its present value — the decomposition the method exists for. */ export interface FinancingSideEffectValue { label: string; presentValue: number; annualDiscountRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared - label: string; default: not declared - presentValue: number; default: not declared ### @insiderfinance/totalfinance/valuation#FreeCashFlowToEquityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link freeCashFlowToEquity} — net borrowing is NET, not the total debt change. ```typescript /** Input for {@link freeCashFlowToEquity} — net borrowing is NET, not the total debt change. */ export interface FreeCashFlowToEquityInput { netIncome: number; depreciationAndAmortization: number; capitalExpenditure: number; /** The INCREASE in net working capital over the period (a decrease is negative). */ increaseInNetWorkingCapital: number; /** New borrowing minus repayments over the period. */ netBorrowing: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capitalExpenditure: number; default: not declared - depreciationAndAmortization: number; default: not declared - increaseInNetWorkingCapital: number; default: not declared — The INCREASE in net working capital over the period (a decrease is negative). - netBorrowing: number; default: not declared — New borrowing minus repayments over the period. - netIncome: number; default: not declared ### @insiderfinance/totalfinance/valuation#FreeCashFlowToFirmInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link freeCashFlowToFirm} — the exact quantities, never proxies. ```typescript // --------------------------------------------------------------------------------------------------- // Free cash flow // --------------------------------------------------------------------------------------------------- /** Input for {@link freeCashFlowToFirm} — the exact quantities, never proxies. */ export interface FreeCashFlowToFirmInput { operatingIncome: number; /** Tax rate in [0, 1) applied to operating income. */ taxRate: number; depreciationAndAmortization: number; capitalExpenditure: number; /** The INCREASE in net working capital over the period (a decrease is negative). */ increaseInNetWorkingCapital: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capitalExpenditure: number; default: not declared - depreciationAndAmortization: number; default: not declared - increaseInNetWorkingCapital: number; default: not declared — The INCREASE in net working capital over the period (a decrease is negative). - operatingIncome: number; default: not declared - taxRate: number; default: not declared — Tax rate in [0, 1) applied to operating income. ### @insiderfinance/totalfinance/valuation#FutureValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link futureValue}: what one present amount grows to. ```typescript /** Input for {@link futureValue}: what one present amount grows to. */ export interface FutureValueInput { /** The amount held at time zero. */ presentAmount: number; /** Annual rate (decimal). */ annualInterestRate: number; timeYears: number; /** Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualInterestRate: number; default: not declared — Annual rate (decimal). - compounding?: InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - presentAmount: number; default: not declared — The amount held at time zero. - timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#InternalRateOfReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link internalRateOfReturn}. ```typescript // --------------------------------------------------------------------------------------------------- // internalRateOfReturn // --------------------------------------------------------------------------------------------------- /** Input for {@link internalRateOfReturn}. */ export interface InternalRateOfReturnInput { cashFlows: readonly TimedCashFlow[]; /** Default `'annual'` — documented and echoed in `.explain()`. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/valuation#InternalRateOfReturnReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The `.explain()` report shared by the IRR family (Law 2 envelope). ```typescript /** The `.explain()` report shared by the IRR family (Law 2 envelope). */ export interface InternalRateOfReturnReport { assumptions: { conventionsVersion: string; compounding: InterestCompounding; /** Present only on the dated head. */ dayCount?: DayCount; /** Present only on the dated head. */ asOf?: string; searchRange: { from: number; to: number; }; }; diagnostics: { method: 'scan-bisect'; converged: boolean; iterations: number; warnings: QuantWarning[]; }; /** The plain call's answer: the single root, or null when none or many. */ value: number | null; /** EVERY economically admissible root found in the search range. */ roots: InternalRateRoot[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf?: string; compounding: InterestCompounding; conventionsVersion: string; dayCount?: DayCount; searchRange: { from: number; to: number; }; }; default: not declared - assumptions.asOf?: string; default: not declared — Present only on the dated head. - assumptions.compounding: InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: DayCount; default: not declared — Present only on the dated head. - assumptions.searchRange: { from: number; to: number; }; default: not declared - assumptions.searchRange.from: number; default: not declared - assumptions.searchRange.to: number; default: not declared - diagnostics: { converged: boolean; iterations: number; method: 'scan-bisect'; warnings: QuantWarning[]; }; default: not declared - diagnostics.converged: boolean; default: not declared - diagnostics.iterations: number; default: not declared - diagnostics.method: 'scan-bisect'; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - roots: InternalRateRoot[]; default: not declared — EVERY economically admissible root found in the search range. - value: number | null; default: not declared — The plain call's answer: the single root, or null when none or many. ### @insiderfinance/totalfinance/valuation#InternalRateRoot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One admissible root with the residual NPV at that rate (≈ 0 by construction). ```typescript /** One admissible root with the residual NPV at that rate (≈ 0 by construction). */ export interface InternalRateRoot { annualRate: number; residualNetPresentValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualRate: number; default: not declared - residualNetPresentValue: number; default: not declared ### @insiderfinance/totalfinance/valuation#IwmToRtyLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate IWM → RTY proportional mapping. ```typescript /** Three explicit prices for approximate IWM → RTY proportional mapping. */ export interface IwmToRtyLevelInput { /** Requested level in USD per IWM share; finite and nonnegative. */ iwmPriceLevel: number; /** Comparable reference in USD per IWM share; finite and positive. */ referenceIwmPrice: number; /** Comparable reference in RTY index points; finite and positive. */ referenceRtyPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. ### @insiderfinance/totalfinance/valuation#IwmToRutLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate IWM → RUT proportional mapping. ```typescript /** Three explicit prices for approximate IWM → RUT proportional mapping. */ export interface IwmToRutLevelInput { /** Requested level in USD per IWM share; finite and nonnegative. */ iwmPriceLevel: number; /** Comparable reference in USD per IWM share; finite and positive. */ referenceIwmPrice: number; /** Comparable reference in RUT index points; finite and positive. */ referenceRutPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutAnalysisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link leveragedBuyoutAnalysis}. ```typescript /** Input for {@link leveragedBuyoutAnalysis}. */ export interface LeveragedBuyoutAnalysisInput { transaction: LeveragedBuyoutTransactionInput; sources: LeveragedBuyoutSourcesInput; operatingForecast: readonly LeveragedBuyoutOperatingYearInput[]; /** Fraction (0 ≤ f ≤ 1) of positive post-mandatory-amortization FCF swept to debt each year. */ cashSweepFraction: number; exit: LeveragedBuyoutExitInput; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashSweepFraction: number; default: not declared — Fraction (0 ≤ f ≤ 1) of positive post-mandatory-amortization FCF swept to debt each year. - exit: LeveragedBuyoutExitInput; default: not declared - exit.exitEbitdaMultiple: number; default: not declared — Exit enterprise value = exit-year EBITDA × this multiple (> 0). - exit.exitFees: number; default: not declared — Fees paid on exit (≥ 0), deducted from equity proceeds. - exit.year: number; default: not declared - operatingForecast: readonly LeveragedBuyoutOperatingYearInput[]; default: not declared - sources: LeveragedBuyoutSourcesInput; default: not declared - sources.sponsorEquity: number; default: not declared — The sponsor's equity check (> 0). - sources.tranches: readonly LeveragedBuyoutDebtTrancheInput[]; default: not declared — May be empty — an explicit all-equity structure. - transaction: LeveragedBuyoutTransactionInput; default: not declared - transaction.cashToBalanceSheet: number; default: not declared — Cash funded onto the opening balance sheet at close (≥ 0). - transaction.purchaseEnterpriseValue: number; default: not declared — Enterprise value paid for the target (> 0). - transaction.transactionFees: number; default: not declared — Advisory/financing fees paid at close (≥ 0). ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutAnalysisResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link leveragedBuyoutAnalysis}. ```typescript /** Result of {@link leveragedBuyoutAnalysis}. */ export interface LeveragedBuyoutAnalysisResult { diagnostics: { /** The disclosed simplifications, surfaced in the one grammar every analysis shares. */ warnings: string[]; }; sourcesAndUses: LeveragedBuyoutSourcesAndUses; annualSchedule: LeveragedBuyoutAnnualScheduleRow[]; exitBridge: LeveragedBuyoutExitBridge; /** −sponsorEquity at year 0, +equityProceeds at the exit year (no interim dividends, v1). */ equityCashFlows: TimedCashFlow[]; /** `equityProceeds / sponsorEquity`. */ multipleOnInvestedCapital: number; /** * The sponsor's IRR from the FC1 solver, or `null` when no admissible rate exists (equity * proceeds ≤ 0 have no positive-flow leg for an internal rate to equate). */ internalRateOfReturn: number | null; assumptions: { /** Every modeling simplification this analysis makes, stated — never implied. */ disclosedSimplifications: string[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualSchedule: LeveragedBuyoutAnnualScheduleRow[]; default: not declared - assumptions: { disclosedSimplifications: string[]; }; default: not declared - assumptions.disclosedSimplifications: string[]; default: not declared — Every modeling simplification this analysis makes, stated — never implied. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — The disclosed simplifications, surfaced in the one grammar every analysis shares. - equityCashFlows: TimedCashFlow[]; default: not declared — −sponsorEquity at year 0, +equityProceeds at the exit year (no interim dividends, v1). - exitBridge: LeveragedBuyoutExitBridge; default: not declared - exitBridge.enterpriseValue: number; default: not declared - exitBridge.equityProceeds: number; default: not declared — `enterpriseValue − netDebtAtExit − exitFees`. - exitBridge.exitEbitda: number; default: not declared - exitBridge.exitEbitdaMultiple: number; default: not declared - exitBridge.exitFees: number; default: not declared - exitBridge.netDebtAtExit: number; default: not declared — Σ ending debt balances − accumulated cash, at the exit year. - internalRateOfReturn: number | null; default: not declared — The sponsor's IRR from the FC1 solver, or `null` when no admissible rate exists (equity proceeds ≤ 0 have no positive-flow leg for an internal rate to equate). - multipleOnInvestedCapital: number; default: not declared — `equityProceeds / sponsorEquity`. - sourcesAndUses: LeveragedBuyoutSourcesAndUses; default: not declared - sourcesAndUses.sources: { sponsorEquity: number; totalSources: number; tranches: { trancheName: string; principal: number; }[]; }; default: not declared - sourcesAndUses.sources.sponsorEquity: number; default: not declared - sourcesAndUses.sources.totalSources: number; default: not declared - sourcesAndUses.sources.tranches: { trancheName: string; principal: number; }[]; default: not declared - sourcesAndUses.uses: { cashToBalanceSheet: number; purchaseEnterpriseValue: number; totalUses: number; transactionFees: number; }; default: not declared - sourcesAndUses.uses.cashToBalanceSheet: number; default: not declared - sourcesAndUses.uses.purchaseEnterpriseValue: number; default: not declared - sourcesAndUses.uses.totalUses: number; default: not declared - sourcesAndUses.uses.transactionFees: number; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutAnnualScheduleRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One year of the annual schedule: the operating totals plus every tranche's row. ```typescript /** One year of the annual schedule: the operating totals plus every tranche's row. */ export interface LeveragedBuyoutAnnualScheduleRow { year: number; ebitda: number; /** Total interest across tranches, on beginning-of-year balances. */ interest: number; taxes: number; /** EBITDA − taxes − capitalExpenditure − increaseInNetWorkingCapital − interest. */ freeCashFlow: number; /** Total swept to debt this year (mandatory amortization is reported per tranche). */ cashSweptToDebt: number; /** The cumulative cash balance at year end. */ cashAccumulated: number; /** Per-tranche detail, in input order. */ trancheRows: LeveragedBuyoutDebtScheduleRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashAccumulated: number; default: not declared — The cumulative cash balance at year end. - cashSweptToDebt: number; default: not declared — Total swept to debt this year (mandatory amortization is reported per tranche). - ebitda: number; default: not declared - freeCashFlow: number; default: not declared — EBITDA − taxes − capitalExpenditure − increaseInNetWorkingCapital − interest. - interest: number; default: not declared — Total interest across tranches, on beginning-of-year balances. - taxes: number; default: not declared - trancheRows: LeveragedBuyoutDebtScheduleRow[]; default: not declared — Per-tranche detail, in input order. - year: number; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutDebtScheduleRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One tranche-year of the debt schedule. Closing law: ending = beginning − mandatory − sweep. ```typescript /** One tranche-year of the debt schedule. Closing law: ending = beginning − mandatory − sweep. */ export interface LeveragedBuyoutDebtScheduleRow { year: number; trancheName: string; beginningBalance: number; interest: number; mandatoryAmortization: number; cashSweep: number; endingBalance: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beginningBalance: number; default: not declared - cashSweep: number; default: not declared - endingBalance: number; default: not declared - interest: number; default: not declared - mandatoryAmortization: number; default: not declared - trancheName: string; default: not declared - year: number; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutDebtTrancheInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One debt tranche in the capital structure. ```typescript /** One debt tranche in the capital structure. */ export interface LeveragedBuyoutDebtTrancheInput { trancheName: string; /** Amount drawn at close (> 0). */ principal: number; /** Annual interest rate (decimal) on the beginning-of-year balance. */ annualInterestRate: number; /** Fraction of the ORIGINAL principal repaid per year (0 ≤ f ≤ 1), capped at the balance. */ mandatoryAmortizationFraction: number; /** Sweep order: 1 is repaid first. Distinct positive integers across tranches. */ cashSweepPriority: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualInterestRate: number; default: not declared — Annual interest rate (decimal) on the beginning-of-year balance. - cashSweepPriority: number; default: not declared — Sweep order: 1 is repaid first. Distinct positive integers across tranches. - mandatoryAmortizationFraction: number; default: not declared — Fraction of the ORIGINAL principal repaid per year (0 ≤ f ≤ 1), capped at the balance. - principal: number; default: not declared — Amount drawn at close (> 0). - trancheName: string; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutExitBridge Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The walk from exit enterprise value to sponsor proceeds. ```typescript /** The walk from exit enterprise value to sponsor proceeds. */ export interface LeveragedBuyoutExitBridge { exitEbitda: number; exitEbitdaMultiple: number; enterpriseValue: number; /** Σ ending debt balances − accumulated cash, at the exit year. */ netDebtAtExit: number; exitFees: number; /** `enterpriseValue − netDebtAtExit − exitFees`. */ equityProceeds: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - enterpriseValue: number; default: not declared - equityProceeds: number; default: not declared — `enterpriseValue − netDebtAtExit − exitFees`. - exitEbitda: number; default: not declared - exitEbitdaMultiple: number; default: not declared - exitFees: number; default: not declared - netDebtAtExit: number; default: not declared — Σ ending debt balances − accumulated cash, at the exit year. ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutExitInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exit assumptions. `year` must equal the last forecast year. ```typescript /** Exit assumptions. `year` must equal the last forecast year. */ export interface LeveragedBuyoutExitInput { year: number; /** Exit enterprise value = exit-year EBITDA × this multiple (> 0). */ exitEbitdaMultiple: number; /** Fees paid on exit (≥ 0), deducted from equity proceeds. */ exitFees: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exitEbitdaMultiple: number; default: not declared — Exit enterprise value = exit-year EBITDA × this multiple (> 0). - exitFees: number; default: not declared — Fees paid on exit (≥ 0), deducted from equity proceeds. - year: number; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutOperatingYearInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One forecast year. Years are 1..N consecutive from the close. ```typescript /** One forecast year. Years are 1..N consecutive from the close. */ export interface LeveragedBuyoutOperatingYearInput { year: number; ebitda: number; capitalExpenditure: number; increaseInNetWorkingCapital: number; /** Marginal cash tax rate for the year (0 ≤ t ≤ 1). */ taxRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capitalExpenditure: number; default: not declared - ebitda: number; default: not declared - increaseInNetWorkingCapital: number; default: not declared - taxRate: number; default: not declared — Marginal cash tax rate for the year (0 ≤ t ≤ 1). - year: number; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutSourcesAndUses Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Both sides of the entry, itemized — the "sources equal uses" law made inspectable. ```typescript /** Both sides of the entry, itemized — the "sources equal uses" law made inspectable. */ export interface LeveragedBuyoutSourcesAndUses { sources: { sponsorEquity: number; tranches: { trancheName: string; principal: number; }[]; totalSources: number; }; uses: { purchaseEnterpriseValue: number; transactionFees: number; cashToBalanceSheet: number; totalUses: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sources: { sponsorEquity: number; tranches: { trancheName: string; principal: number; }[]; totalSources: number; }; default: not declared - sources.sponsorEquity: number; default: not declared - sources.totalSources: number; default: not declared - sources.tranches: { trancheName: string; principal: number; }[]; default: not declared - uses: { purchaseEnterpriseValue: number; transactionFees: number; cashToBalanceSheet: number; totalUses: number; }; default: not declared - uses.cashToBalanceSheet: number; default: not declared - uses.purchaseEnterpriseValue: number; default: not declared - uses.totalUses: number; default: not declared - uses.transactionFees: number; default: not declared ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutSourcesInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The sources side of the entry: who funds the purchase. ```typescript /** The sources side of the entry: who funds the purchase. */ export interface LeveragedBuyoutSourcesInput { /** The sponsor's equity check (> 0). */ sponsorEquity: number; /** May be empty — an explicit all-equity structure. */ tranches: readonly LeveragedBuyoutDebtTrancheInput[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sponsorEquity: number; default: not declared — The sponsor's equity check (> 0). - tranches: readonly LeveragedBuyoutDebtTrancheInput[]; default: not declared — May be empty — an explicit all-equity structure. ### @insiderfinance/totalfinance/valuation#LeveragedBuyoutTransactionInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The uses side of the entry: what the purchase consumes. All explicit. ```typescript /** The uses side of the entry: what the purchase consumes. All explicit. */ export interface LeveragedBuyoutTransactionInput { /** Enterprise value paid for the target (> 0). */ purchaseEnterpriseValue: number; /** Advisory/financing fees paid at close (≥ 0). */ transactionFees: number; /** Cash funded onto the opening balance sheet at close (≥ 0). */ cashToBalanceSheet: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashToBalanceSheet: number; default: not declared — Cash funded onto the opening balance sheet at close (≥ 0). - purchaseEnterpriseValue: number; default: not declared — Enterprise value paid for the target (> 0). - transactionFees: number; default: not declared — Advisory/financing fees paid at close (≥ 0). ### @insiderfinance/totalfinance/valuation#LoanNumberOfPeriodsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link loanNumberOfPeriods}: how long a payment takes to retire a loan. ```typescript /** Input for {@link loanNumberOfPeriods}: how long a payment takes to retire a loan. */ export interface LoanNumberOfPeriodsInput { principal: number; periodicInterestRate: number; /** The level payment (positive magnitude). */ payment: number; paymentTiming: PaymentTiming; balloon?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon?: number; default: not declared - payment: number; default: not declared — The level payment (positive magnitude). - paymentTiming: PaymentTiming; default: not declared - periodicInterestRate: number; default: not declared - principal: number; default: not declared ### @insiderfinance/totalfinance/valuation#LoanPeriodInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input naming one period of an existing loan. ```typescript /** Input naming one period of an existing loan. */ export interface LoanPeriodInput extends LoanTermsInput { /** 1-based period the question is about. */ period: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - numberOfPeriods: number; default: not declared - paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - period: number; default: not declared — 1-based period the question is about. - periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - principal: number; default: not declared — Amount borrowed (positive). ### @insiderfinance/totalfinance/valuation#LoanPeriodicInterestRateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link loanPeriodicInterestRate}: the rate implied by a known payment. ```typescript /** Input for {@link loanPeriodicInterestRate}: the rate implied by a known payment. */ export interface LoanPeriodicInterestRateInput { principal: number; numberOfPeriods: number; /** The level payment (positive magnitude). */ payment: number; paymentTiming: PaymentTiming; balloon?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon?: number; default: not declared - numberOfPeriods: number; default: not declared - payment: number; default: not declared — The level payment (positive magnitude). - paymentTiming: PaymentTiming; default: not declared - principal: number; default: not declared ### @insiderfinance/totalfinance/valuation#LoanRangeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for the two cumulative heads: an inclusive period range. ```typescript /** Input for the two cumulative heads: an inclusive period range. */ export interface LoanRangeInput extends LoanTermsInput { /** 1-based first period, inclusive. */ fromPeriod: number; /** 1-based last period, inclusive. */ toPeriod: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - fromPeriod: number; default: not declared — 1-based first period, inclusive. - numberOfPeriods: number; default: not declared - paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - principal: number; default: not declared — Amount borrowed (positive). - toPeriod: number; default: not declared — 1-based last period, inclusive. ### @insiderfinance/totalfinance/valuation#LoanTermsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The shared loan coordinates every head below validates the same way. ```typescript /** The shared loan coordinates every head below validates the same way. */ export interface LoanTermsInput { /** Amount borrowed (positive). */ principal: number; /** Per-period interest rate (decimal) — callers convert annual rates explicitly. */ periodicInterestRate: number; numberOfPeriods: number; /** REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). */ paymentTiming: PaymentTiming; /** Residual balance due at the end (explicit; default 0 means fully amortizing). */ balloon?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - numberOfPeriods: number; default: not declared - paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - principal: number; default: not declared — Amount borrowed (positive). ### @insiderfinance/totalfinance/valuation#MarginalDistribution Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An explicit marginal distribution. ```typescript // --------------------------------------------------------------------------------------------------- // Input // --------------------------------------------------------------------------------------------------- /** An explicit marginal distribution. */ export type MarginalDistribution = { type: 'normal'; mean: number; standardDeviation: number; } | { type: 'uniform'; from: number; to: number; } | { type: 'triangular'; minimum: number; mode: number; maximum: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - from: number; default: not declared - maximum: number; default: not declared - mean: number; default: not declared - minimum: number; default: not declared - mode: number; default: not declared - standardDeviation: number; default: not declared - to: number; default: not declared - type: ('normal') | ('triangular') | ('uniform'); default: not declared ### @insiderfinance/totalfinance/valuation#ModifiedInternalRateOfReturnInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link modifiedInternalRateOfReturn}. ```typescript // --------------------------------------------------------------------------------------------------- // modifiedInternalRateOfReturn // --------------------------------------------------------------------------------------------------- /** Input for {@link modifiedInternalRateOfReturn}. */ export interface ModifiedInternalRateOfReturnInput { cashFlows: readonly TimedCashFlow[]; /** Annual rate financing the negative flows (decimal). */ financeRate: number; /** Annual rate reinvesting the positive flows (decimal). */ reinvestmentRate: number; /** Default `'annual'` — documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - financeRate: number; default: not declared — Annual rate financing the negative flows (decimal). - reinvestmentRate: number; default: not declared — Annual rate reinvesting the positive flows (decimal). ### @insiderfinance/totalfinance/valuation#NamedPriceLevelConversionAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Named coordinates plus the explicit reference-price mapping supplied by a pair helper. ```typescript /** Named coordinates plus the explicit reference-price mapping supplied by a pair helper. */ export type NamedPriceLevelConversionAssumptions = { /** A copy of the three named coordinates exactly as supplied to the helper. */ input: Input; /** The canonical mapping, with descriptive instrument labels; never a fixed market ratio. */ conversion: ReferencePriceLevelInput & { sourcePriceUnit: string; targetPriceUnit: string; }; /** Known descriptive output unit fixed by the helper's name. */ resultUnit: string; /** Target price units per one source price unit. */ ratioDirection: 'target-price-per-source-price'; /** The supplied proportional mapping is assumed valid at the requested level. */ mappingAssumption: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conversion: ReferencePriceLevelInput & { sourcePriceUnit: string; targetPriceUnit: string; }; default: not declared — The canonical mapping, with descriptive instrument labels; never a fixed market ratio. - conversion.method: 'reference-prices'; default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. - conversion.referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - conversion.referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - conversion.sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - conversion.sourcePriceUnit?: (string) | (string | undefined); default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - conversion.targetPriceUnit?: (string) | (string | undefined); default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - input: Input; default: not declared — A copy of the three named coordinates exactly as supplied to the helper. - mappingAssumption: string; default: not declared — The supplied proportional mapping is assumed valid at the requested level. - ratioDirection: 'target-price-per-source-price'; default: not declared — Target price units per one source price unit. - resultUnit: string; default: not declared — Known descriptive output unit fixed by the helper's name. ### @insiderfinance/totalfinance/valuation#NdxToQqqLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate NDX → QQQ proportional mapping. ```typescript /** Three explicit prices for approximate NDX → QQQ proportional mapping. */ export interface NdxToQqqLevelInput { /** Requested level in NDX index points; finite and nonnegative. */ ndxPriceLevel: number; /** Comparable reference in NDX index points; finite and positive. */ referenceNdxPrice: number; /** Comparable reference in USD per QQQ share; finite and positive. */ referenceQqqPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#NetPresentValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link netPresentValue}. ```typescript /** Input for {@link netPresentValue}. */ export interface NetPresentValueInput { cashFlows: readonly TimedCashFlow[]; /** Annual discount rate (decimal). */ annualDiscountRate: number; /** Default `'annual'` — documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/valuation#NominalAnnualRateInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link nominalAnnualRate}: the nominal rate whose EAR is the given effective rate. ```typescript /** Input for {@link nominalAnnualRate}: the nominal rate whose EAR is the given effective rate. */ export interface NominalAnnualRateInput { /** Effective annual rate (decimal). */ effectiveAnnualRate: number; /** REQUIRED — a rate conversion never guesses its convention. */ compounding: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - compounding: InterestCompounding; default: not declared — REQUIRED — a rate conversion never guesses its convention. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - effectiveAnnualRate: number; default: not declared — Effective annual rate (decimal). ### @insiderfinance/totalfinance/valuation#NqToQqqLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate NQ → QQQ proportional mapping. ```typescript /** Three explicit prices for approximate NQ → QQQ proportional mapping. */ export interface NqToQqqLevelInput { /** Requested level in NQ index points; finite and nonnegative. */ nqPriceLevel: number; /** Comparable reference in NQ index points; finite and positive. */ referenceNqPrice: number; /** Comparable reference in USD per QQQ share; finite and positive. */ referenceQqqPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#OperatingForecastInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link operatingForecast}. ```typescript /** Input for {@link operatingForecast}. */ export interface OperatingForecastInput { /** The revenue base the first growth-driven period grows FROM (the last historical revenue). */ baseRevenue: number; periods: readonly OperatingForecastPeriod[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseRevenue: number; default: not declared — The revenue base the first growth-driven period grows FROM (the last historical revenue). - periods: readonly OperatingForecastPeriod[]; default: not declared ### @insiderfinance/totalfinance/valuation#OperatingForecastPeriod Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One forecast period's explicit drivers. ```typescript // --------------------------------------------------------------------------------------------------- // operatingForecast // --------------------------------------------------------------------------------------------------- /** One forecast period's explicit drivers. */ export interface OperatingForecastPeriod { periodLabel: string; revenue: RevenueDriver; /** Operating income as a fraction of revenue. */ operatingMargin: number; taxRate: number; depreciationAndAmortization: AmountDriver; capitalExpenditure: AmountDriver; increaseInNetWorkingCapital: AmountDriver; /** Enables the FCFE column (with interestExpense). */ netBorrowing?: number; /** Enables net income and (with netBorrowing) FCFE. */ interestExpense?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capitalExpenditure: AmountDriver; default: not declared - capitalExpenditure.amount: number; default: not declared - capitalExpenditure.fractionOfRevenue: number; default: not declared - depreciationAndAmortization: AmountDriver; default: not declared - depreciationAndAmortization.amount: number; default: not declared - depreciationAndAmortization.fractionOfRevenue: number; default: not declared - increaseInNetWorkingCapital: AmountDriver; default: not declared - increaseInNetWorkingCapital.amount: number; default: not declared - increaseInNetWorkingCapital.fractionOfRevenue: number; default: not declared - interestExpense?: number; default: not declared — Enables net income and (with netBorrowing) FCFE. - netBorrowing?: number; default: not declared — Enables the FCFE column (with interestExpense). - operatingMargin: number; default: not declared — Operating income as a fraction of revenue. - periodLabel: string; default: not declared - revenue: RevenueDriver; default: not declared - revenue.amount: number; default: not declared - revenue.growthRate: number; default: not declared - taxRate: number; default: not declared ### @insiderfinance/totalfinance/valuation#OperatingForecastResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link operatingForecast}. ```typescript /** Result of {@link operatingForecast}. */ export interface OperatingForecastResult { diagnostics: { /** One warning per row output disabled by an absent driver. */ warnings: string[]; }; rows: OperatingForecastRow[]; /** The drivers, echoed verbatim per period. */ assumptions: { baseRevenue: number; periods: readonly OperatingForecastPeriod[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { baseRevenue: number; periods: readonly OperatingForecastPeriod[]; }; default: not declared — The drivers, echoed verbatim per period. - assumptions.baseRevenue: number; default: not declared - assumptions.periods: readonly OperatingForecastPeriod[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — One warning per row output disabled by an absent driver. - rows: OperatingForecastRow[]; default: not declared ### @insiderfinance/totalfinance/valuation#OperatingForecastRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One forecast row — every derived figure alongside the drivers that produced it. ```typescript /** One forecast row — every derived figure alongside the drivers that produced it. */ export interface OperatingForecastRow { periodLabel: string; revenue: number; operatingIncome: number; taxes: number; interestExpense?: number; netIncome?: number; netIncomeAbsentReason?: string; depreciationAndAmortization: number; capitalExpenditure: number; increaseInNetWorkingCapital: number; freeCashFlowToFirm: number; freeCashFlowToEquity?: number; freeCashFlowToEquityAbsentReason?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - capitalExpenditure: number; default: not declared - depreciationAndAmortization: number; default: not declared - freeCashFlowToEquity?: number; default: not declared - freeCashFlowToEquityAbsentReason?: string; default: not declared - freeCashFlowToFirm: number; default: not declared - increaseInNetWorkingCapital: number; default: not declared - interestExpense?: number; default: not declared - netIncome?: number; default: not declared - netIncomeAbsentReason?: string; default: not declared - operatingIncome: number; default: not declared - periodLabel: string; default: not declared - revenue: number; default: not declared - taxes: number; default: not declared ### @insiderfinance/totalfinance/valuation#PaybackInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link paybackPeriod}. ```typescript // --------------------------------------------------------------------------------------------------- // Payback and project comparison // --------------------------------------------------------------------------------------------------- /** Input for {@link paybackPeriod}. */ export interface PaybackInput { cashFlows: readonly TimedCashFlow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cashFlows: readonly TimedCashFlow[]; default: not declared ### @insiderfinance/totalfinance/valuation#PaymentTiming Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). When within each period the payment falls. REQUIRED — timing changes every number. ```typescript /** When within each period the payment falls. REQUIRED — timing changes every number. */ export type PaymentTiming = 'end' | 'beginning'; ``` ### @insiderfinance/totalfinance/valuation#PresentValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link presentValue}: what one future amount is worth today. ```typescript // --------------------------------------------------------------------------------------------------- // Present / future value // --------------------------------------------------------------------------------------------------- /** Input for {@link presentValue}: what one future amount is worth today. */ export interface PresentValueInput { /** The amount received at `timeYears`. */ futureAmount: number; /** Annual rate (decimal, e.g. `0.08`). */ annualInterestRate: number; timeYears: number; /** Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualInterestRate: number; default: not declared — Annual rate (decimal, e.g. `0.08`). - compounding?: InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared - futureAmount: number; default: not declared — The amount received at `timeYears`. - timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#PriceLevelConversionAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Disclosures on {@link convertPriceLevel}'s `.explain()` companion. ```typescript /** Disclosures on {@link convertPriceLevel}'s `.explain()` companion. */ export type PriceLevelConversionAssumptions = { /** Copy of every supplied coordinate, reference or directed ratio, method, and unit label. */ conversion: ConvertPriceLevelInput; /** Caller-supplied target unit label, or null when the caller did not label the result's units. */ resultUnit: string | null; /** Target price units per one source price unit. */ ratioDirection: 'target-price-per-source-price'; /** The supplied proportional mapping is assumed valid at the requested price level. */ mappingAssumption: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conversion: ConvertPriceLevelInput; default: not declared — Copy of every supplied coordinate, reference or directed ratio, method, and unit label. - conversion.method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - conversion.referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - conversion.referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - conversion.sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - conversion.sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - conversion.targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - conversion.targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - mappingAssumption: string; default: not declared — The supplied proportional mapping is assumed valid at the requested price level. - ratioDirection: 'target-price-per-source-price'; default: not declared — Target price units per one source price unit. - resultUnit: string | null; default: not declared — Caller-supplied target unit label, or null when the caller did not label the result's units. ### @insiderfinance/totalfinance/valuation#PriceLevelCoordinates Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Coordinates shared by both methods of {@link convertPriceLevel }. ```typescript /** Coordinates shared by both methods of {@link convertPriceLevel}. */ export interface PriceLevelCoordinates { /** Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. */ sourcePriceLevel: number; /** Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. */ sourcePriceUnit?: string | undefined; /** Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. */ targetPriceUnit?: string | undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. ### @insiderfinance/totalfinance/valuation#ProbabilisticDiscountedCashFlowInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link probabilisticDiscountedCashFlow}. ```typescript /** Input for {@link probabilisticDiscountedCashFlow}. */ export interface ProbabilisticDiscountedCashFlowInput { discountedCashFlowInput: DiscountedCashFlowInput; distributions: readonly RandomizedVariable[]; /** * Correlation matrix over `distributions` (Gaussian dependence, applied before the marginal * transforms). Omitted → independent. */ correlationMatrix?: readonly (readonly number[])[]; sampleCount: number; seed: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlationMatrix?: readonly (readonly number[])[]; default: not declared — Correlation matrix over `distributions` (Gaussian dependence, applied before the marginal transforms). Omitted → independent. - discountedCashFlowInput: DiscountedCashFlowInput; default: not declared - discountedCashFlowInput.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - discountedCashFlowInput.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - discountedCashFlowInput.compounding.periodsPerYear: number; default: not declared - discountedCashFlowInput.compounding.type: 'periodic'; default: not declared - discountedCashFlowInput.currency: string; default: not declared - discountedCashFlowInput.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - discountedCashFlowInput.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - discountedCashFlowInput.enterpriseToEquityBridge?: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - discountedCashFlowInput.enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.minorityInterest: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.preferredEquity: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.totalDebt: number; default: not declared - discountedCashFlowInput.projectedCashFlows: import('@insiderfinance/totalfinance/valuation').ProjectedCashFlowSchedule; default: not declared - discountedCashFlowInput.provenance?: import('@insiderfinance/totalfinance/valuation').ValuationProvenance; default: not declared - discountedCashFlowInput.provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - discountedCashFlowInput.provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - discountedCashFlowInput.provenance.source?: string; default: not declared — Who or what prepared the inputs. - discountedCashFlowInput.provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - discountedCashFlowInput.terminalValueMethod: TerminalValueMethod; default: not declared - discountedCashFlowInput.terminalValueMethod.exitMultiple: number; default: not declared - discountedCashFlowInput.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - discountedCashFlowInput.terminalValueMethod.perpetualGrowthRate: number; default: not declared - discountedCashFlowInput.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - discountedCashFlowInput.terminalValueMethod.terminalMetricAmount: number; default: not declared - discountedCashFlowInput.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - discountedCashFlowInput.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - distributions: readonly RandomizedVariable[]; default: not declared - sampleCount: number; default: not declared - seed: number; default: not declared ### @insiderfinance/totalfinance/valuation#ProbabilisticDiscountedCashFlowResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link probabilisticDiscountedCashFlow}. ```typescript /** Result of {@link probabilisticDiscountedCashFlow}. */ export interface ProbabilisticDiscountedCashFlowResult { diagnostics: { /** One warning per rejected-sample reason (count included). */ warnings: string[]; }; /** The value the distribution describes (per the base input's valuation basis). */ valueDescribed: 'enterpriseValue' | 'equityValue'; sampleCount: number; seed: number; /** Samples whose drawn variables kept the model inside its domain. */ validSampleCount: number; /** Samples the model's own laws rejected (e.g. growth ≥ rate), with the reasons tallied. */ rejectedSamples: { count: number; reasons: Record; }; mean: number; standardDeviation: number; quantiles: { p05: number; p10: number; p25: number; p50: number; p75: number; p90: number; p95: number; }; minimum: number; maximum: number; /** Left-tail diagnostics: the sampled probability that the value falls at or below zero. */ probabilityAtOrBelowZero: number; /** The exact seeded assumptions, echoed for reproduction. */ assumptions: { distributions: readonly RandomizedVariable[]; correlationMatrix: readonly (readonly number[])[] | 'independent'; dependence: 'gaussian-copula-over-declared-correlations'; baseCase: DiscountedCashFlowResult; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { baseCase: DiscountedCashFlowResult; correlationMatrix: readonly (readonly number[])[] | 'independent'; dependence: 'gaussian-copula-over-declared-correlations'; distributions: readonly RandomizedVariable[]; }; default: not declared — The exact seeded assumptions, echoed for reproduction. - assumptions.baseCase: DiscountedCashFlowResult; default: not declared - assumptions.correlationMatrix: readonly (readonly number[])[] | 'independent'; default: not declared - assumptions.dependence: 'gaussian-copula-over-declared-correlations'; default: not declared - assumptions.distributions: readonly RandomizedVariable[]; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — One warning per rejected-sample reason (count included). - maximum: number; default: not declared - mean: number; default: not declared - minimum: number; default: not declared - probabilityAtOrBelowZero: number; default: not declared — Left-tail diagnostics: the sampled probability that the value falls at or below zero. - quantiles: { p05: number; p10: number; p25: number; p50: number; p75: number; p90: number; p95: number; }; default: not declared - quantiles.p05: number; default: not declared - quantiles.p10: number; default: not declared - quantiles.p25: number; default: not declared - quantiles.p50: number; default: not declared - quantiles.p75: number; default: not declared - quantiles.p90: number; default: not declared - quantiles.p95: number; default: not declared - rejectedSamples: { count: number; reasons: Record; }; default: not declared — Samples the model's own laws rejected (e.g. growth ≥ rate), with the reasons tallied. - rejectedSamples.count: number; default: not declared - rejectedSamples.reasons: Record; default: not declared - sampleCount: number; default: not declared - seed: number; default: not declared - standardDeviation: number; default: not declared - validSampleCount: number; default: not declared — Samples whose drawn variables kept the model inside its domain. - valueDescribed: 'enterpriseValue' | 'equityValue'; default: not declared — The value the distribution describes (per the base input's valuation basis). ### @insiderfinance/totalfinance/valuation#ProfitabilityIndexInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link profitabilityIndex}. ```typescript /** Input for {@link profitabilityIndex}. */ export interface ProfitabilityIndexInput { cashFlows: readonly TimedCashFlow[]; annualDiscountRate: number; /** Default `'annual'`. */ compounding?: InterestCompounding; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared - cashFlows: readonly TimedCashFlow[]; default: not declared - compounding?: InterestCompounding; default: not declared — Default `'annual'`. - compounding.periodsPerYear: number; default: not declared - compounding.type: 'periodic'; default: not declared ### @insiderfinance/totalfinance/valuation#ProjectStatementsInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link projectFinancialStatements}. ```typescript /** Input for {@link projectFinancialStatements}. */ export interface ProjectStatementsInput { /** The typed historical anchor — beginning balances come from HERE, not from an assumption. */ baseStatements: FinancialStatements; periods: readonly StatementProjectionPeriod[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - baseStatements: FinancialStatements; default: not declared — The typed historical anchor — beginning balances come from HERE, not from an assumption. - baseStatements.balance: import('@insiderfinance/totalfinance/fundamentals').BalanceSheet; default: not declared - baseStatements.balance.accountsPayable?: number; default: not declared - baseStatements.balance.accountsReceivable?: number; default: not declared - baseStatements.balance.cashAndCashEquivalents: number; default: not declared - baseStatements.balance.currentAssets?: number; default: not declared - baseStatements.balance.currentLiabilities?: number; default: not declared - baseStatements.balance.inventory?: number; default: not declared - baseStatements.balance.longTermDebt?: number; default: not declared — Interest-bearing debt due beyond one year. - baseStatements.balance.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - baseStatements.balance.minorityInterest?: number; default: not declared - baseStatements.balance.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - baseStatements.balance.period.accession?: string; default: not declared — Source accession identifier, when known. - baseStatements.balance.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - baseStatements.balance.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - baseStatements.balance.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - baseStatements.balance.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - baseStatements.balance.period.fiscalYear: number; default: not declared - baseStatements.balance.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - baseStatements.balance.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - baseStatements.balance.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - baseStatements.balance.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - baseStatements.balance.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - baseStatements.balance.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - baseStatements.balance.preferredEquity?: number; default: not declared - baseStatements.balance.propertyPlantEquipmentNet?: number; default: not declared — Net property, plant, and equipment. - baseStatements.balance.retainedEarnings?: number; default: not declared - baseStatements.balance.shortTermDebt?: number; default: not declared — Interest-bearing debt due within one year. - baseStatements.balance.shortTermInvestments?: number; default: not declared - baseStatements.balance.totalAssets: number; default: not declared - baseStatements.balance.totalDebt?: number; default: not declared — Total interest-bearing debt. When absent and both maturities are present, consumers may derive `shortTermDebt + longTermDebt` and say so; "debt" NEVER silently means total liabilities. - baseStatements.balance.totalEquity: number; default: not declared - baseStatements.balance.totalLiabilities: number; default: not declared - baseStatements.cashFlow: import('@insiderfinance/totalfinance/fundamentals').CashFlowStatement; default: not declared - baseStatements.cashFlow.acquisitions?: number; default: not declared — Positive magnitude of cash spent on acquisitions. - baseStatements.cashFlow.capitalExpenditure?: number; default: not declared — Positive magnitude of cash spent on property, plant, and equipment. - baseStatements.cashFlow.depreciationAndAmortization?: number; default: not declared - baseStatements.cashFlow.dividendsPaid?: number; default: not declared — Positive magnitude of cash paid out as dividends. - baseStatements.cashFlow.financingCashFlow: number; default: not declared - baseStatements.cashFlow.investingCashFlow: number; default: not declared - baseStatements.cashFlow.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - baseStatements.cashFlow.operatingCashFlow: number; default: not declared - baseStatements.cashFlow.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - baseStatements.cashFlow.period.accession?: string; default: not declared — Source accession identifier, when known. - baseStatements.cashFlow.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - baseStatements.cashFlow.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - baseStatements.cashFlow.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - baseStatements.cashFlow.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - baseStatements.cashFlow.period.fiscalYear: number; default: not declared - baseStatements.cashFlow.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - baseStatements.cashFlow.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - baseStatements.cashFlow.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - baseStatements.cashFlow.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - baseStatements.cashFlow.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - baseStatements.cashFlow.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - baseStatements.cashFlow.shareRepurchases?: number; default: not declared — Positive magnitude of cash spent repurchasing shares. - baseStatements.cashFlow.stockBasedCompensation?: number; default: not declared - baseStatements.income: import('@insiderfinance/totalfinance/fundamentals').IncomeStatement; default: not declared - baseStatements.income.costOfRevenue?: number; default: not declared — Positive magnitude. - baseStatements.income.dilutedSharesOutstanding?: number; default: not declared — Split-adjusted weighted-average diluted shares for the period. - baseStatements.income.grossProfit?: number; default: not declared — Reported gross profit; when absent, consumers may derive `revenue - costOfRevenue` and say so. - baseStatements.income.incomeFromContinuingOperations?: number; default: not declared — When reported separately from `netIncome` (the Beneish accrual basis prefers it). - baseStatements.income.incomeTaxExpense?: number; default: not declared — Positive magnitude (a net tax benefit is a negative amount and is stated as such). - baseStatements.income.interestExpense?: number; default: not declared — Positive magnitude. - baseStatements.income.metadata?: Record; default: not declared — Source-specific extras, preserved verbatim and never consumed by compute functions. - baseStatements.income.netIncome: number; default: not declared - baseStatements.income.operatingExpenses?: number; default: not declared — Positive magnitude of total operating expenses below gross profit. - baseStatements.income.operatingIncome: number; default: not declared - baseStatements.income.period: import('@insiderfinance/totalfinance/fundamentals').FundamentalPeriod; default: not declared - baseStatements.income.period.accession?: string; default: not declared — Source accession identifier, when known. - baseStatements.income.period.availableTimestampMs: number; default: not declared — When the data became AVAILABLE to an observer — the point-in-time eligibility instant. A backtest or event study must not see this period before this time; `periodEndDate` never controls eligibility. - baseStatements.income.period.currency: string; default: not declared — ISO 4217 currency of the monetary figures. - baseStatements.income.period.filedTimestampMs?: number; default: not declared — When the filing was made, when known. - baseStatements.income.period.fiscalQuarter?: 1 | 2 | 3 | 4; default: not declared - baseStatements.income.period.fiscalYear: number; default: not declared - baseStatements.income.period.form?: string; default: not declared — Source form (e.g. `10-Q`), when known. - baseStatements.income.period.monetaryScale: 1 | 1000 | 1000000; default: not declared — Monetary figures are reported in units of this scale. - baseStatements.income.period.periodEndDate: string; default: not declared — Strict `YYYY-MM-DD` calendar date the period ends on. - baseStatements.income.period.periodStartDate?: string; default: not declared — Strict `YYYY-MM-DD` calendar date; optional because some sources report only period ends. - baseStatements.income.period.periodType: 'quarter' | 'year' | 'trailing-twelve-months'; default: not declared - baseStatements.income.period.restatementOf?: string; default: not declared — When this record restates an earlier one, the accession (or identifier) it restates. - baseStatements.income.revenue: number; default: not declared - baseStatements.income.sellingGeneralAdministrativeExpense?: number; default: not declared — Positive magnitude (Beneish SGAI consumes it). - periods: readonly StatementProjectionPeriod[]; default: not declared ### @insiderfinance/totalfinance/valuation#ProjectStatementsResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link projectFinancialStatements}. ```typescript /** Result of {@link projectFinancialStatements}. */ export interface ProjectStatementsResult { diagnostics: { /** Any period whose identity residual exceeds floating-point dust. */ warnings: string[]; }; statements: ProjectedStatements[]; /** * The named balancing item. CASH absorbs the residual of the articulated statements — the * identity `assets = liabilities + equity` then holds by construction, and the proof is the * per-period `identityDifference` (floating-point dust, gated in tests). */ balancingItem: 'cash'; reconciliation: Array<{ periodLabel: string; identityDifference: number; }>; assumptions: { periods: readonly StatementProjectionPeriod[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { periods: readonly StatementProjectionPeriod[]; }; default: not declared - assumptions.periods: readonly StatementProjectionPeriod[]; default: not declared - balancingItem: 'cash'; default: not declared — The named balancing item. CASH absorbs the residual of the articulated statements — the identity `assets = liabilities + equity` then holds by construction, and the proof is the per-period `identityDifference` (floating-point dust, gated in tests). - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared — Any period whose identity residual exceeds floating-point dust. - reconciliation: { periodLabel: string; identityDifference: number; }[]; default: not declared - statements: ProjectedStatements[]; default: not declared ### @insiderfinance/totalfinance/valuation#ProjectedCashFlow Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One projected cash flow: dated (with the valuation-date day count) or timed. ```typescript // --------------------------------------------------------------------------------------------------- // Input // --------------------------------------------------------------------------------------------------- /** One projected cash flow: dated (with the valuation-date day count) or timed. */ export type ProjectedCashFlow = { cashFlowDate: string; amount: number; } | { timeYears: number; amount: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - cashFlowDate: string; default: not declared - timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#ProjectedCashFlowSchedule Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One coherent projection time basis. A schedule is entirely dated or entirely year-fraction based; the type rejects the mixed array the runtime has always refused. ```typescript /** * One coherent projection time basis. A schedule is entirely dated or entirely year-fraction based; * the type rejects the mixed array the runtime has always refused. */ export type ProjectedCashFlowSchedule = readonly { cashFlowDate: string; amount: number; }[] | readonly { timeYears: number; amount: number; }[]; ``` ### @insiderfinance/totalfinance/valuation#ProjectedStatements Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One projected period's three articulated statements (a closed forecast contract). ```typescript /** One projected period's three articulated statements (a closed forecast contract). */ export interface ProjectedStatements { periodLabel: string; income: { revenue: number; operatingIncome: number; interestExpense: number; pretaxIncome: number; incomeTaxExpense: number; netIncome: number; }; balance: { cashAndCashEquivalents: number; accountsReceivable: number; inventory: number; propertyPlantEquipmentNet: number; otherAssets: number; totalAssets: number; accountsPayable: number; totalDebt: number; otherLiabilities: number; totalLiabilities: number; totalEquity: number; }; cashFlow: { netIncome: number; depreciationAndAmortization: number; increaseInNetWorkingCapital: number; operatingCashFlow: number; capitalExpenditure: number; investingCashFlow: number; netBorrowing: number; dividendsPaid: number; financingCashFlow: number; netChangeInCash: number; }; freeCashFlowToFirm: number; freeCashFlowToEquity: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - balance: { cashAndCashEquivalents: number; accountsReceivable: number; inventory: number; propertyPlantEquipmentNet: number; otherAssets: number; totalAssets: number; accountsPayable: number; totalDebt: number; otherLiabilities: number; totalLiabilities: number; totalEquity: number; }; default: not declared - balance.accountsPayable: number; default: not declared - balance.accountsReceivable: number; default: not declared - balance.cashAndCashEquivalents: number; default: not declared - balance.inventory: number; default: not declared - balance.otherAssets: number; default: not declared - balance.otherLiabilities: number; default: not declared - balance.propertyPlantEquipmentNet: number; default: not declared - balance.totalAssets: number; default: not declared - balance.totalDebt: number; default: not declared - balance.totalEquity: number; default: not declared - balance.totalLiabilities: number; default: not declared - cashFlow: { netIncome: number; depreciationAndAmortization: number; increaseInNetWorkingCapital: number; operatingCashFlow: number; capitalExpenditure: number; investingCashFlow: number; netBorrowing: number; dividendsPaid: number; financingCashFlow: number; netChangeInCash: number; }; default: not declared - cashFlow.capitalExpenditure: number; default: not declared - cashFlow.depreciationAndAmortization: number; default: not declared - cashFlow.dividendsPaid: number; default: not declared - cashFlow.financingCashFlow: number; default: not declared - cashFlow.increaseInNetWorkingCapital: number; default: not declared - cashFlow.investingCashFlow: number; default: not declared - cashFlow.netBorrowing: number; default: not declared - cashFlow.netChangeInCash: number; default: not declared - cashFlow.netIncome: number; default: not declared - cashFlow.operatingCashFlow: number; default: not declared - freeCashFlowToEquity: number; default: not declared - freeCashFlowToFirm: number; default: not declared - income: { revenue: number; operatingIncome: number; interestExpense: number; pretaxIncome: number; incomeTaxExpense: number; netIncome: number; }; default: not declared - income.incomeTaxExpense: number; default: not declared - income.interestExpense: number; default: not declared - income.netIncome: number; default: not declared - income.operatingIncome: number; default: not declared - income.pretaxIncome: number; default: not declared - income.revenue: number; default: not declared - periodLabel: string; default: not declared ### @insiderfinance/totalfinance/valuation#QqqToNdxLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate QQQ → NDX proportional mapping. ```typescript /** Three explicit prices for approximate QQQ → NDX proportional mapping. */ export interface QqqToNdxLevelInput { /** Requested level in USD per QQQ share; finite and nonnegative. */ qqqPriceLevel: number; /** Comparable reference in USD per QQQ share; finite and positive. */ referenceQqqPrice: number; /** Comparable reference in NDX index points; finite and positive. */ referenceNdxPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#QqqToNqLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate QQQ → NQ proportional mapping. ```typescript /** Three explicit prices for approximate QQQ → NQ proportional mapping. */ export interface QqqToNqLevelInput { /** Requested level in USD per QQQ share; finite and nonnegative. */ qqqPriceLevel: number; /** Comparable reference in USD per QQQ share; finite and positive. */ referenceQqqPrice: number; /** Comparable reference in NQ index points; finite and positive. */ referenceNqPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#RandomizedVariable Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One randomized DCF variable. `'cash-flow-scale'` shocks the whole stream proportionally. ```typescript /** One randomized DCF variable. `'cash-flow-scale'` shocks the whole stream proportionally. */ export interface RandomizedVariable { variable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'cash-flow-scale'; distribution: MarginalDistribution; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - distribution: MarginalDistribution; default: not declared - distribution.from: number; default: not declared - distribution.maximum: number; default: not declared - distribution.mean: number; default: not declared - distribution.minimum: number; default: not declared - distribution.mode: number; default: not declared - distribution.standardDeviation: number; default: not declared - distribution.to: number; default: not declared - distribution.type: ('normal') | ('triangular') | ('uniform'); default: not declared - variable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'cash-flow-scale'; default: not declared ### @insiderfinance/totalfinance/valuation#RatioPriceLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Proportional mapping from an explicit directed ratio. ```typescript /** Proportional mapping from an explicit directed ratio. */ export interface RatioPriceLevelInput extends PriceLevelCoordinates { /** Use `sourcePriceLevel * targetPricePerSourcePrice`. */ method: 'ratio'; /** Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. */ targetPricePerSourcePrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method: 'ratio'; default: not declared — Use `sourcePriceLevel * targetPricePerSourcePrice`. - sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. ### @insiderfinance/totalfinance/valuation#ReferencePriceLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Proportional mapping from a pair of caller-supplied reference prices. ```typescript /** Proportional mapping from a pair of caller-supplied reference prices. */ export interface ReferencePriceLevelInput extends PriceLevelCoordinates { /** Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. */ method: 'reference-prices'; /** Finite price > 0 in `sourcePriceUnit`; the reference denominator. */ referenceSourcePrice: number; /** Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. */ referenceTargetPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - method: 'reference-prices'; default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. - referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. ### @insiderfinance/totalfinance/valuation#ResidualIncomeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link residualIncomeValuation}. ```typescript /** Input for {@link residualIncomeValuation}. */ export interface ResidualIncomeInput { /** Book value per share at the valuation date. */ beginningBookValuePerShare: number; /** Annual cost of equity (decimal). */ annualCostOfEquity: number; /** One entry per forecast YEAR, in order — clean surplus rolls the book value between them. */ projections: readonly ResidualIncomeProjection[]; /** * The residual-income terminal stage: `'none'` states that residual income is competed away * after the horizon; `'perpetuity'` continues the FINAL residual income at a growth rate. */ terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualCostOfEquity: number; default: not declared — Annual cost of equity (decimal). - beginningBookValuePerShare: number; default: not declared — Book value per share at the valuation date. - projections: readonly ResidualIncomeProjection[]; default: not declared — One entry per forecast YEAR, in order — clean surplus rolls the book value between them. - terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; default: not declared — The residual-income terminal stage: `'none'` states that residual income is competed away after the horizon; `'perpetuity'` continues the FINAL residual income at a growth rate. - terminalResidualIncome.method: ('none') | ('perpetuity'); default: not declared - terminalResidualIncome.perpetualGrowthRate: number; default: not declared ### @insiderfinance/totalfinance/valuation#ResidualIncomeProjection Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One projected clean-surplus year. ```typescript // --------------------------------------------------------------------------------------------------- // Residual income // --------------------------------------------------------------------------------------------------- /** One projected clean-surplus year. */ export interface ResidualIncomeProjection { earningsPerShare: number; dividendsPerShare: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendsPerShare: number; default: not declared - earningsPerShare: number; default: not declared ### @insiderfinance/totalfinance/valuation#ResidualIncomeResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link residualIncomeValuation}. ```typescript /** Result of {@link residualIncomeValuation}. */ export interface ResidualIncomeResult { diagnostics: { warnings: string[]; }; valuePerShare: number; beginningBookValuePerShare: number; rows: Array<{ year: number; beginningBookValuePerShare: number; earningsPerShare: number; dividendsPerShare: number; endingBookValuePerShare: number; equityCharge: number; residualIncomePerShare: number; presentValue: number; }>; residualIncomePresentValue: number; terminalValuePresentValue: number; assumptions: { annualCostOfEquity: number; cleanSurplus: 'ending book = beginning book + earnings - dividends'; terminalResidualIncome: ResidualIncomeInput['terminalResidualIncome']; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { annualCostOfEquity: number; cleanSurplus: 'ending book = beginning book + earnings - dividends'; terminalResidualIncome: ResidualIncomeInput['terminalResidualIncome']; }; default: not declared - assumptions.annualCostOfEquity: number; default: not declared - assumptions.cleanSurplus: 'ending book = beginning book + earnings - dividends'; default: not declared - assumptions.terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; default: not declared - assumptions.terminalResidualIncome.method: ('none') | ('perpetuity'); default: not declared - assumptions.terminalResidualIncome.perpetualGrowthRate: number; default: not declared - beginningBookValuePerShare: number; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - residualIncomePresentValue: number; default: not declared - rows: { year: number; beginningBookValuePerShare: number; earningsPerShare: number; dividendsPerShare: number; endingBookValuePerShare: number; equityCharge: number; residualIncomePerShare: number; presentValue: number; }[]; default: not declared - terminalValuePresentValue: number; default: not declared - valuePerShare: number; default: not declared ### @insiderfinance/totalfinance/valuation#RevenueDriver Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Revenue is stated directly or grown EXPLICITLY from the prior period — never extrapolated. ```typescript /** Revenue is stated directly or grown EXPLICITLY from the prior period — never extrapolated. */ export type RevenueDriver = { amount: number; } | { growthRate: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared - growthRate: number; default: not declared ### @insiderfinance/totalfinance/valuation#ReverseDiscountedCashFlowInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link reverseDiscountedCashFlow}. ```typescript /** Input for {@link reverseDiscountedCashFlow}. */ export interface ReverseDiscountedCashFlowInput { /** The full direct-DCF input to hold fixed (except the solved variable). */ discountedCashFlowInput: DiscountedCashFlowInput; target: ReverseDiscountedCashFlowTarget; /** The observed value to match: enterprise value on the firm basis, equity value on equity. */ targetValue: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountedCashFlowInput: DiscountedCashFlowInput; default: not declared — The full direct-DCF input to hold fixed (except the solved variable). - discountedCashFlowInput.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - discountedCashFlowInput.compounding: InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - discountedCashFlowInput.compounding.periodsPerYear: number; default: not declared - discountedCashFlowInput.compounding.type: 'periodic'; default: not declared - discountedCashFlowInput.currency: string; default: not declared - discountedCashFlowInput.dayCount?: DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - discountedCashFlowInput.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - discountedCashFlowInput.enterpriseToEquityBridge?: EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - discountedCashFlowInput.enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.minorityInterest: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.preferredEquity: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.totalDebt: number; default: not declared - discountedCashFlowInput.projectedCashFlows: ProjectedCashFlowSchedule; default: not declared - discountedCashFlowInput.provenance?: ValuationProvenance; default: not declared - discountedCashFlowInput.provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - discountedCashFlowInput.provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - discountedCashFlowInput.provenance.source?: string; default: not declared — Who or what prepared the inputs. - discountedCashFlowInput.provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - discountedCashFlowInput.terminalValueMethod: TerminalValueMethod; default: not declared - discountedCashFlowInput.terminalValueMethod.exitMultiple: number; default: not declared - discountedCashFlowInput.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - discountedCashFlowInput.terminalValueMethod.perpetualGrowthRate: number; default: not declared - discountedCashFlowInput.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - discountedCashFlowInput.terminalValueMethod.terminalMetricAmount: number; default: not declared - discountedCashFlowInput.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - discountedCashFlowInput.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - target: ReverseDiscountedCashFlowTarget; default: not declared - target.searchRange: { from: number; to: number; }; default: not declared — The bracket to search. Explicit — the admissible range is an economic statement. - target.searchRange.from: number; default: not declared - target.searchRange.to: number; default: not declared - target.variable: ('annual-discount-rate') | ('perpetual-growth-rate'); default: not declared - targetValue: number; default: not declared — The observed value to match: enterprise value on the firm basis, equity value on equity. ### @insiderfinance/totalfinance/valuation#ReverseDiscountedCashFlowResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link reverseDiscountedCashFlow}. ```typescript /** Result of {@link reverseDiscountedCashFlow}. */ export interface ReverseDiscountedCashFlowResult { assumptions: { variable: ReverseDiscountedCashFlowTarget['variable']; searchRange: { from: number; to: number; }; targetValue: number; method: 'bisection'; }; diagnostics: { warnings: string[]; }; variable: ReverseDiscountedCashFlowTarget['variable']; /** The implied value of the solved variable, or `null` when no root lies in the range. */ impliedValue: number | null; /** Why `impliedValue` is null, when it is. */ reason?: string; searchRange: { from: number; to: number; }; converged: boolean; iterations: number; /** |model(implied) − target| at the reported solution (absolute). */ residual: number | null; /** The valuation the implied variable reproduces, for inspection. */ impliedResult: DiscountedCashFlowResult | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { method: 'bisection'; searchRange: { from: number; to: number; }; targetValue: number; variable: ReverseDiscountedCashFlowTarget['variable']; }; default: not declared - assumptions.method: 'bisection'; default: not declared - assumptions.searchRange: { from: number; to: number; }; default: not declared - assumptions.searchRange.from: number; default: not declared - assumptions.searchRange.to: number; default: not declared - assumptions.targetValue: number; default: not declared - assumptions.variable: 'annual-discount-rate' | 'perpetual-growth-rate'; default: not declared - converged: boolean; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - impliedResult: DiscountedCashFlowResult | null; default: not declared — The valuation the implied variable reproduces, for inspection. - impliedValue: number | null; default: not declared — The implied value of the solved variable, or `null` when no root lies in the range. - iterations: number; default: not declared - reason?: string; default: not declared — Why `impliedValue` is null, when it is. - residual: number | null; default: not declared — |model(implied) − target| at the reported solution (absolute). - searchRange: { from: number; to: number; }; default: not declared - searchRange.from: number; default: not declared - searchRange.to: number; default: not declared - variable: 'annual-discount-rate' | 'perpetual-growth-rate'; default: not declared ### @insiderfinance/totalfinance/valuation#ReverseDiscountedCashFlowTarget Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The variable the reverse analysis solves for — an explicit discriminant. ```typescript // --------------------------------------------------------------------------------------------------- // reverseDiscountedCashFlow // --------------------------------------------------------------------------------------------------- /** The variable the reverse analysis solves for — an explicit discriminant. */ export type ReverseDiscountedCashFlowTarget = { variable: 'perpetual-growth-rate'; /** The bracket to search. Explicit — the admissible range is an economic statement. */ searchRange: { from: number; to: number; }; } | { variable: 'annual-discount-rate'; searchRange: { from: number; to: number; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - searchRange: { from: number; to: number; }; default: not declared — The bracket to search. Explicit — the admissible range is an economic statement. - searchRange.from: number; default: not declared - searchRange.to: number; default: not declared - variable: ('annual-discount-rate') | ('perpetual-growth-rate'); default: not declared ### @insiderfinance/totalfinance/valuation#RtyToIwmLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate RTY → IWM proportional mapping. ```typescript /** Three explicit prices for approximate RTY → IWM proportional mapping. */ export interface RtyToIwmLevelInput { /** Requested level in RTY index points; finite and nonnegative. */ rtyPriceLevel: number; /** Comparable reference in RTY index points; finite and positive. */ referenceRtyPrice: number; /** Comparable reference in USD per IWM share; finite and positive. */ referenceIwmPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#RutToIwmLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate RUT → IWM proportional mapping. ```typescript /** Three explicit prices for approximate RUT → IWM proportional mapping. */ export interface RutToIwmLevelInput { /** Requested level in RUT index points; finite and nonnegative. */ rutPriceLevel: number; /** Comparable reference in RUT index points; finite and positive. */ referenceRutPrice: number; /** Comparable reference in USD per IWM share; finite and positive. */ referenceIwmPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#ScenarioAnalysisInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link discountedCashFlowScenarioAnalysis}. ```typescript /** Input for {@link discountedCashFlowScenarioAnalysis}. */ export interface ScenarioAnalysisInput { discountedCashFlowInput: DiscountedCashFlowInput; scenarios: readonly DiscountedCashFlowScenario[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - discountedCashFlowInput: DiscountedCashFlowInput; default: not declared - discountedCashFlowInput.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - discountedCashFlowInput.compounding: InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - discountedCashFlowInput.compounding.periodsPerYear: number; default: not declared - discountedCashFlowInput.compounding.type: 'periodic'; default: not declared - discountedCashFlowInput.currency: string; default: not declared - discountedCashFlowInput.dayCount?: DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - discountedCashFlowInput.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - discountedCashFlowInput.enterpriseToEquityBridge?: EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - discountedCashFlowInput.enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.minorityInterest: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.preferredEquity: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.totalDebt: number; default: not declared - discountedCashFlowInput.projectedCashFlows: ProjectedCashFlowSchedule; default: not declared - discountedCashFlowInput.provenance?: ValuationProvenance; default: not declared - discountedCashFlowInput.provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - discountedCashFlowInput.provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - discountedCashFlowInput.provenance.source?: string; default: not declared — Who or what prepared the inputs. - discountedCashFlowInput.provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - discountedCashFlowInput.terminalValueMethod: TerminalValueMethod; default: not declared - discountedCashFlowInput.terminalValueMethod.exitMultiple: number; default: not declared - discountedCashFlowInput.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - discountedCashFlowInput.terminalValueMethod.perpetualGrowthRate: number; default: not declared - discountedCashFlowInput.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - discountedCashFlowInput.terminalValueMethod.terminalMetricAmount: number; default: not declared - discountedCashFlowInput.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - discountedCashFlowInput.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - scenarios: readonly DiscountedCashFlowScenario[]; default: not declared ### @insiderfinance/totalfinance/valuation#ScenarioAnalysisResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link discountedCashFlowScenarioAnalysis}. ```typescript /** Result of {@link discountedCashFlowScenarioAnalysis}. */ export interface ScenarioAnalysisResult { assumptions: { scenarioNames: string[]; }; diagnostics: { warnings: string[]; }; baseCase: DiscountedCashFlowResult; scenarios: Array<{ scenarioName: string; /** Exactly which fields this scenario overrode. */ overriddenFields: string[]; result: DiscountedCashFlowResult; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { scenarioNames: string[]; }; default: not declared - assumptions.scenarioNames: string[]; default: not declared - baseCase: DiscountedCashFlowResult; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - scenarios: { scenarioName: string; overriddenFields: string[]; result: DiscountedCashFlowResult; }[]; default: not declared ### @insiderfinance/totalfinance/valuation#SensitivityAxis Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A sensitivity axis: which variable, and the explicit values to evaluate. ```typescript // --------------------------------------------------------------------------------------------------- // Sensitivity table // --------------------------------------------------------------------------------------------------- /** A sensitivity axis: which variable, and the explicit values to evaluate. */ export interface SensitivityAxis { variable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; /** Decimal rates for the rate variables; a plain multiple for 'exit-multiple'. */ values: readonly number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - values: readonly number[]; default: not declared — Decimal rates for the rate variables; a plain multiple for 'exit-multiple'. - variable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared ### @insiderfinance/totalfinance/valuation#SensitivityTableInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link discountedCashFlowSensitivityTable}. ```typescript /** Input for {@link discountedCashFlowSensitivityTable}. */ export interface SensitivityTableInput { discountedCashFlowInput: DiscountedCashFlowInput; rowAxis: SensitivityAxis; columnAxis: SensitivityAxis; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - columnAxis: SensitivityAxis; default: not declared - columnAxis.values: readonly number[]; default: not declared — Decimal rates for the rate variables; a plain multiple for 'exit-multiple'. - columnAxis.variable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - discountedCashFlowInput: DiscountedCashFlowInput; default: not declared - discountedCashFlowInput.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - discountedCashFlowInput.compounding: InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - discountedCashFlowInput.compounding.periodsPerYear: number; default: not declared - discountedCashFlowInput.compounding.type: 'periodic'; default: not declared - discountedCashFlowInput.currency: string; default: not declared - discountedCashFlowInput.dayCount?: DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - discountedCashFlowInput.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - discountedCashFlowInput.enterpriseToEquityBridge?: EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - discountedCashFlowInput.enterpriseToEquityBridge.cashAndCashEquivalents: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.minorityInterest: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.nonOperatingAssets: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.preferredEquity: number; default: not declared - discountedCashFlowInput.enterpriseToEquityBridge.totalDebt: number; default: not declared - discountedCashFlowInput.projectedCashFlows: ProjectedCashFlowSchedule; default: not declared - discountedCashFlowInput.provenance?: ValuationProvenance; default: not declared - discountedCashFlowInput.provenance.forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - discountedCashFlowInput.provenance.restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - discountedCashFlowInput.provenance.source?: string; default: not declared — Who or what prepared the inputs. - discountedCashFlowInput.provenance.statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. - discountedCashFlowInput.terminalValueMethod: TerminalValueMethod; default: not declared - discountedCashFlowInput.terminalValueMethod.exitMultiple: number; default: not declared - discountedCashFlowInput.terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - discountedCashFlowInput.terminalValueMethod.perpetualGrowthRate: number; default: not declared - discountedCashFlowInput.terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - discountedCashFlowInput.terminalValueMethod.terminalMetricAmount: number; default: not declared - discountedCashFlowInput.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - discountedCashFlowInput.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - rowAxis: SensitivityAxis; default: not declared - rowAxis.values: readonly number[]; default: not declared — Decimal rates for the rate variables; a plain multiple for 'exit-multiple'. - rowAxis.variable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared ### @insiderfinance/totalfinance/valuation#SensitivityTableResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link discountedCashFlowSensitivityTable}. ```typescript /** Result of {@link discountedCashFlowSensitivityTable}. */ export interface SensitivityTableResult { assumptions: { rowVariable: SensitivityAxis['variable']; rowUnit: string; columnVariable: SensitivityAxis['variable']; columnUnit: string; cellValue: 'enterpriseValue' | 'equityValue'; }; diagnostics: { warnings: string[]; }; /** The value each cell reports: enterprise value (firm basis) or equity value (equity basis). */ cellValue: 'enterpriseValue' | 'equityValue'; rowVariable: SensitivityAxis['variable']; /** The unit of the row/column values, stated. */ rowUnit: string; columnVariable: SensitivityAxis['variable']; columnUnit: string; rowValues: number[]; columnValues: number[]; /** `cells[rowIndex][columnIndex]` — each PROVEN equal to a direct DCF call by construction. */ cells: number[][]; /** The unmodified base case, retained. */ baseCase: DiscountedCashFlowResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { cellValue: 'enterpriseValue' | 'equityValue'; columnUnit: string; columnVariable: SensitivityAxis['variable']; rowUnit: string; rowVariable: SensitivityAxis['variable']; }; default: not declared - assumptions.cellValue: 'enterpriseValue' | 'equityValue'; default: not declared - assumptions.columnUnit: string; default: not declared - assumptions.columnVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - assumptions.rowUnit: string; default: not declared - assumptions.rowVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - baseCase: DiscountedCashFlowResult; default: not declared — The unmodified base case, retained. - cellValue: 'enterpriseValue' | 'equityValue'; default: not declared — The value each cell reports: enterprise value (firm basis) or equity value (equity basis). - cells: number[][]; default: not declared — `cells[rowIndex][columnIndex]` — each PROVEN equal to a direct DCF call by construction. - columnUnit: string; default: not declared - columnValues: number[]; default: not declared - columnVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - rowUnit: string; default: not declared — The unit of the row/column values, stated. - rowValues: number[]; default: not declared - rowVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared ### @insiderfinance/totalfinance/valuation#SpxToSpyLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate SPX → SPY proportional mapping. ```typescript /** Three explicit prices for approximate SPX → SPY proportional mapping. */ export interface SpxToSpyLevelInput { /** Requested level in SPX index points; finite and nonnegative. */ spxPriceLevel: number; /** Comparable reference in SPX index points; finite and positive. */ referenceSpxPrice: number; /** Comparable reference in USD per SPY share; finite and positive. */ referenceSpyPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#SpyToEsLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate SPY → ES proportional mapping. ```typescript /** Three explicit prices for approximate SPY → ES proportional mapping. */ export interface SpyToEsLevelInput { /** Requested level in USD per SPY share; finite and nonnegative. */ spyPriceLevel: number; /** Comparable reference in USD per SPY share; finite and positive. */ referenceSpyPrice: number; /** Comparable reference in ES index points; finite and positive. */ referenceEsPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#SpyToSpxLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate SPY → SPX proportional mapping. ```typescript /** Three explicit prices for approximate SPY → SPX proportional mapping. */ export interface SpyToSpxLevelInput { /** Requested level in USD per SPY share; finite and nonnegative. */ spyPriceLevel: number; /** Comparable reference in USD per SPY share; finite and positive. */ referenceSpyPrice: number; /** Comparable reference in SPX index points; finite and positive. */ referenceSpxPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#StatementProjectionPeriod Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One projected period's explicit drivers — operating AND balance-sheet. ```typescript // --------------------------------------------------------------------------------------------------- // projectFinancialStatements // --------------------------------------------------------------------------------------------------- /** One projected period's explicit drivers — operating AND balance-sheet. */ export interface StatementProjectionPeriod { periodLabel: string; revenue: RevenueDriver; operatingMargin: number; taxRate: number; /** Explicit financing cost for the period. */ interestExpense: number; depreciationAndAmortization: AmountDriver; capitalExpenditure: AmountDriver; /** Operating working-capital balances (cash is NOT working capital here — it is the balancer). */ accountsReceivable: AmountDriver; inventory: AmountDriver; accountsPayable: AmountDriver; /** New borrowing minus repayments. */ netBorrowing: number; dividendsPaid: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - accountsPayable: AmountDriver; default: not declared - accountsPayable.amount: number; default: not declared - accountsPayable.fractionOfRevenue: number; default: not declared - accountsReceivable: AmountDriver; default: not declared — Operating working-capital balances (cash is NOT working capital here — it is the balancer). - accountsReceivable.amount: number; default: not declared - accountsReceivable.fractionOfRevenue: number; default: not declared - capitalExpenditure: AmountDriver; default: not declared - capitalExpenditure.amount: number; default: not declared - capitalExpenditure.fractionOfRevenue: number; default: not declared - depreciationAndAmortization: AmountDriver; default: not declared - depreciationAndAmortization.amount: number; default: not declared - depreciationAndAmortization.fractionOfRevenue: number; default: not declared - dividendsPaid: number; default: not declared - interestExpense: number; default: not declared — Explicit financing cost for the period. - inventory: AmountDriver; default: not declared - inventory.amount: number; default: not declared - inventory.fractionOfRevenue: number; default: not declared - netBorrowing: number; default: not declared — New borrowing minus repayments. - operatingMargin: number; default: not declared - periodLabel: string; default: not declared - revenue: RevenueDriver; default: not declared - revenue.amount: number; default: not declared - revenue.growthRate: number; default: not declared - taxRate: number; default: not declared ### @insiderfinance/totalfinance/valuation#TerminalValueInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link terminalValue}. ```typescript /** Input for {@link terminalValue}. */ export interface TerminalValueInput { terminalValueMethod: TerminalValueMethod; /** Annual discount rate (decimal). Perpetual growth requires it to EXCEED the growth rate. */ annualDiscountRate: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualDiscountRate: number; default: not declared — Annual discount rate (decimal). Perpetual growth requires it to EXCEED the growth rate. - terminalValueMethod: TerminalValueMethod; default: not declared - terminalValueMethod.exitMultiple: number; default: not declared - terminalValueMethod.method: ('exit-multiple') | ('perpetual-growth'); default: not declared - terminalValueMethod.perpetualGrowthRate: number; default: not declared - terminalValueMethod.terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - terminalValueMethod.terminalMetricAmount: number; default: not declared ### @insiderfinance/totalfinance/valuation#TerminalValueMethod Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The terminal method — a discriminated union, and the discriminant is validated FIRST. ```typescript // --------------------------------------------------------------------------------------------------- // Terminal value // --------------------------------------------------------------------------------------------------- /** The terminal method — a discriminated union, and the discriminant is validated FIRST. */ export type TerminalValueMethod = { method: 'perpetual-growth'; /** * The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value * is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, * exactly once (echoed by every consumer). */ terminalCashFlow: number; perpetualGrowthRate: number; } | { method: 'exit-multiple'; terminalMetricAmount: number; exitMultiple: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - exitMultiple: number; default: not declared - method: ('exit-multiple') | ('perpetual-growth'); default: not declared - perpetualGrowthRate: number; default: not declared - terminalCashFlow: number; default: not declared — The FINAL forecast-period cash flow. The perpetuity begins one period later, so the value is `terminalCashFlow × (1 + g) / (r − g)` — the one-period growth step is applied HERE, exactly once (echoed by every consumer). - terminalMetricAmount: number; default: not declared ### @insiderfinance/totalfinance/valuation#TimedCashFlow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One cash flow at a year offset from the valuation instant (`timeYears: 0`). ```typescript /** One cash flow at a year offset from the valuation instant (`timeYears: 0`). */ export interface TimedCashFlow { /** Positive inflow, negative outflow. */ amount: number; /** Years from the valuation instant; `0` IS the valuation instant. */ timeYears: number; label?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - amount: number; default: not declared — Positive inflow, negative outflow. - label?: string; default: not declared - timeYears: number; default: not declared — Years from the valuation instant; `0` IS the valuation instant. ### @insiderfinance/totalfinance/valuation#ValuationProvenance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Caller-supplied provenance, echoed verbatim — a closed contract, not a bag. ```typescript // --------------------------------------------------------------------------------------------------- // Closed field contracts // --------------------------------------------------------------------------------------------------- /** Caller-supplied provenance, echoed verbatim — a closed contract, not a bag. */ export interface ValuationProvenance { /** Which forecast produced the projected flows (an id, label, or file reference). */ forecastIdentity?: string; /** Which statement set (accession or label) grounded the analysis. */ statementIdentity?: string; /** Which restatement version, when that distinction matters. */ restatementIdentity?: string; /** Who or what prepared the inputs. */ source?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forecastIdentity?: string; default: not declared — Which forecast produced the projected flows (an id, label, or file reference). - restatementIdentity?: string; default: not declared — Which restatement version, when that distinction matters. - source?: string; default: not declared — Who or what prepared the inputs. - statementIdentity?: string; default: not declared — Which statement set (accession or label) grounded the analysis. ### @insiderfinance/totalfinance/valuation#WeightedAverageCostOfCapitalInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link weightedAverageCostOfCapital}. ```typescript /** Input for {@link weightedAverageCostOfCapital}. */ export interface WeightedAverageCostOfCapitalInput { components: readonly CapitalComponent[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - components: readonly CapitalComponent[]; default: not declared ### @insiderfinance/totalfinance/valuation#WeightedAverageCostOfCapitalResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link weightedAverageCostOfCapital}. ```typescript /** Result of {@link weightedAverageCostOfCapital}. */ export interface WeightedAverageCostOfCapitalResult { assumptions: { weightBasis: 'market values, normalized to sum to one'; componentCount: number; }; diagnostics: { warnings: string[]; }; weightedAverageCostOfCapital: number; /** * `null` when the summed capital base exceeds `Number.MAX_VALUE` — the WEIGHTS and the average * are still exact (computed in scaled space), but the raw total itself has no IEEE-754 * representation; `totalCapitalAbsentReason` says so (2026-08-23 review wave). */ totalCapital: number | null; totalCapitalAbsentReason?: string; /** Normalized weights, echoed per component — they sum to one by construction. */ components: Array<{ label: string; marketValue: number; weight: number; annualCostOfCapital: number; contribution: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { componentCount: number; weightBasis: 'market values, normalized to sum to one'; }; default: not declared - assumptions.componentCount: number; default: not declared - assumptions.weightBasis: 'market values, normalized to sum to one'; default: not declared - components: { label: string; marketValue: number; weight: number; annualCostOfCapital: number; contribution: number; }[]; default: not declared — Normalized weights, echoed per component — they sum to one by construction. - diagnostics: { warnings: string[]; }; default: not declared - diagnostics.warnings: string[]; default: not declared - totalCapital: number | null; default: not declared — `null` when the summed capital base exceeds `Number.MAX_VALUE` — the WEIGHTS and the average are still exact (computed in scaled space), but the raw total itself has no IEEE-754 representation; `totalCapitalAbsentReason` says so (2026-08-23 review wave). - totalCapitalAbsentReason?: string; default: not declared - weightedAverageCostOfCapital: number; default: not declared ### @insiderfinance/totalfinance/valuation#YmToDiaLevelInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Three explicit prices for approximate YM → DIA proportional mapping. ```typescript /** Three explicit prices for approximate YM → DIA proportional mapping. */ export interface YmToDiaLevelInput { /** Requested level in YM index points; finite and nonnegative. */ ymPriceLevel: number; /** Comparable reference in YM index points; finite and positive. */ referenceYmPrice: number; /** Comparable reference in USD per DIA share; finite and positive. */ referenceDiaPrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#adjustedPresentValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adjusted present value: the unlevered operating value at the unlevered cost of capital PLUS the present value of each financing side effect at its own declared rate. The decomposition is the result — nothing is netted away silently. ```typescript export declare function adjustedPresentValue(input: AdjustedPresentValueInput): AdjustedPresentValueResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AdjustedPresentValueInput; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `assumptions.compounding`. - (input).financingSideEffects: readonly FinancingSideEffect[]; default: not declared — May be empty — "no side effects" is an explicit statement, not an omission. - (input).unleveredCashFlows: readonly TimedCashFlow[]; default: not declared — The unlevered (all-equity) operating cash flows, `timeYears: 0` being the valuation instant. - (input).unleveredCostOfCapital: number; default: not declared — Annual rate (decimal, > −1) for the UNLEVERED operating flows. - return.adjustedPresentValue: number; default: not declared — `unleveredValue + Σ side-effect present values`. - return.assumptions: { compounding: InterestCompounding; sideEffectCount: number; unleveredCostOfCapital: number; }; default: not declared - return.assumptions.compounding: InterestCompounding; default: not declared — The one compounding convention every leg was discounted under. - return.assumptions.sideEffectCount: number; default: not declared - return.assumptions.unleveredCostOfCapital: number; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.financingSideEffects: FinancingSideEffectValue[]; default: not declared — Each side effect's present value at ITS OWN rate, in input order. - return.unleveredValue: number; default: not declared — Present value of the unlevered operating flows at `unleveredCostOfCapital`. ### @insiderfinance/totalfinance/valuation#afterTaxCostOfDebt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). After-tax cost of debt = annual pre-tax cost × (1 − marginal tax rate), plus any EXPLICIT unusable-tax-shield adjustment. ```typescript export declare function afterTaxCostOfDebt(input: AfterTaxCostOfDebtInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AfterTaxCostOfDebtInput; default: not declared - (input).annualPreTaxCostOfDebt: number; default: not declared — Annual pre-tax cost of debt (decimal). - (input).marginalTaxRate: number; default: not declared — Marginal tax rate in [0, 1). - (input).unusableTaxShieldAdjustment?: number; default: not declared — An EXPLICIT adjustment (decimal, added to the after-tax cost) for a tax shield the company cannot use — supplied, never inferred from losses or carryforwards. ### @insiderfinance/totalfinance/valuation#amortizationSchedule Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The full amortization schedule. Unrounded binary64 values reconcile within arithmetic precision (closing balance = opening − principal; Σ principal ≈ principal − balloon) and any display rounding is the caller's explicit, documented policy applied afterwards. The final installment may absorb arithmetic drift only within a compounding-propagated roundoff allowance, capped at 1e-10 of original principal; larger drift is refused. The `payment` headline is the level installment; inspect the final row's payment for its explicit roundoff reconciliation. ```typescript export declare function amortizationSchedule(input: AmortizationScheduleInput): AmortizationScheduleResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): AmortizationScheduleInput; default: not declared - (input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - (input).numberOfPeriods: number; default: not declared - (input).paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - (input).periodicFee?: number; default: not declared — A flat per-period fee, reported per row (never folded into interest). - (input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - (input).principal: number; default: not declared — Amount borrowed (positive). - return.balloon: number; default: not declared — The requested residual after the final, roundoff-adjusted installment. - return.payment: number; default: not declared — Level payment; the final row may differ by the documented binary64 reconciliation drift. - return.rounding: 'none'; default: not declared — This schedule is UNROUNDED: display rounding is the caller's explicit policy. - return.rows: AmortizationRow[]; default: not declared - return.totalInterest: number; default: not declared - return.totalPrincipal: number; default: not declared ### @insiderfinance/totalfinance/valuation#annuityPayment Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The level payment that amortizes `principal` down to `balloon` over `numberOfPeriods` at the periodic rate, under the explicit payment timing. Positive for every nonnegative-rate loan; SIGNED in general — a negative periodic rate can decay the principal below a balloon on its own, making the level payment zero or negative (the lender pays the borrower to hold the schedule to its residual). A payment the arithmetic cannot represent (IEEE-754 overflow at extreme magnitudes) is a typed refusal, never Infinity/NaN (2026-08-23 review, finding 1). ```typescript export declare function annuityPayment(input: LoanTermsInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanTermsInput; default: not declared - (input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - (input).numberOfPeriods: number; default: not declared - (input).paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - (input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - (input).principal: number; default: not declared — Amount borrowed (positive). ### @insiderfinance/totalfinance/valuation#capitalAssetPricingExpectedReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Capital-asset-pricing expected return = annual risk-free rate + beta × annual market risk premium. The premium is supplied AS a premium — passing the market return here would double the risk-free rate, so the field name says exactly which number it wants. ```typescript export declare function capitalAssetPricingExpectedReturn(input: CapitalAssetPricingInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CapitalAssetPricingInput; default: not declared - (input).annualMarketRiskPremium: number; default: not declared — Annual market risk premium (decimal) — the premium itself, not the market return. - (input).annualRiskFreeRate: number; default: not declared — Annual risk-free rate (decimal). - (input).beta: number; default: not declared ### @insiderfinance/totalfinance/valuation#comparableCompanyValuation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Comparable-company valuation: apply the EXPLICIT outlier policy to the peer multiples, aggregate the survivors under the declared method, and price the subject's metric on the declared enterprise/equity basis. Every excluded peer is named with the reason; the metric definition, period, basis, aggregation, policy, and normalized weights are all echoed in the result. ```typescript export declare function comparableCompanyValuation(input: ComparableCompanyValuationInput): ComparableCompanyValuationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ComparableCompanyValuationInput; default: not declared - (input).aggregation: ComparableAggregation; default: not declared - (input).metricDefinition: string; default: not declared — What the metric MEANS (e.g. `'enterprise value over trailing-twelve-month EBITDA'`). - (input).metricName: string; default: not declared — The metric's name (e.g. `'EV/EBITDA'`). Recorded, never inferred. - (input).outlierPolicy: ComparableOutlierPolicy; default: not declared — REQUIRED — an unstated outlier policy is a silent default. Use `{ method: 'none' }` to keep all. - (input).peers: readonly ComparablePeer[]; default: not declared - (input).period: string; default: not declared — The period the metric covers (e.g. `'TTM 2025-Q4'`). Recorded, never inferred. - (input).subjectMetricAmount: number; default: not declared — The subject company's metric amount the aggregated multiple is applied to. - (input).valuationBasis: ComparableValuationBasis; default: not declared — `'enterprise'` when the multiple prices the firm, `'equity'` when it prices the equity. - (input).weights?: readonly number[]; default: not declared — Peer weights, REQUIRED for (and only valid with) `'weighted-mean'`, one per peer in peer order. Each must be a finite number > 0; they need not sum to 1 — they are normalized and the normalized weights are echoed in `assumptions.weightsNormalized`. - return.aggregatedMultiple: number; default: not declared - return.aggregation: ComparableAggregation; default: not declared - return.assumptions: { outlierPolicy: ComparableOutlierPolicy; weightsNormalized?: number[]; }; default: not declared - return.assumptions.outlierPolicy: ComparableOutlierPolicy; default: not declared — The outlier policy as requested — echoed so the record is self-describing. - return.assumptions.weightsNormalized?: number[]; default: not declared — Present only under `'weighted-mean'`: the normalized weights, aligned with `peersUsed`. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — One warning per excluded peer. - return.impliedValue: number; default: not declared — `aggregatedMultiple × subjectMetricAmount`, on the declared `valuationBasis`. - return.metricDefinition: string; default: not declared - return.metricName: string; default: not declared - return.peersExcluded: ComparablePeerExcluded[]; default: not declared — The peers the outlier policy excluded, in input order, each with its reason. - return.peersUsed: ComparablePeerUsed[]; default: not declared — The peers that survived the outlier policy, in input order. - return.period: string; default: not declared - return.valuationBasis: ComparableValuationBasis; default: not declared ### @insiderfinance/totalfinance/valuation#convertPriceLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Map a source price level to an approximate target level in the supplied target price unit. Reference mode: `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Ratio mode: `sourcePriceLevel * targetPricePerSourcePrice` (target units per source unit). To invert, swap source/target references and unit labels, or supply the reciprocal ratio. Inputs are closed and validated on both calls; prices/ratios must be finite and positive, except the requested level may be zero. No cents/tick rounding or instrument inference occurs. Overflow and positive underflow to zero throw typed `input.out_of_range` errors. Unit labels are optional descriptive metadata, not financial defaults or conversion factors. `.explain()` echoes supplied metadata; resultUnit is null when targetPriceUnit is omitted. It assumes that the proportional mapping remains valid at the requested level. This approximation is not a live quote, predicted ETF open, arbitrage/fair-value result, option premium or notional/delta hedge. The caller supplies comparable references and freshness policy. For named pairs, start with helpers such as `esToSpyLevel` or `nqToQqqLevel`; they need only three named prices. ```typescript export declare const convertPriceLevel: { (input: ConvertPriceLevelInput): number; explain: (input: ConvertPriceLevelInput) => Computed; }; ``` Example (source JSDoc): ```ts import { convertPriceLevel } from '@insiderfinance/totalfinance/valuation/price-levels'; const estimatedSpy = convertPriceLevel({ method: 'reference-prices', sourcePriceLevel: 6030, referenceSourcePrice: 6000, referenceTargetPrice: 596, sourcePriceUnit: 'ES index points', targetPriceUnit: 'USD per SPY share', }); // approximately 598.98 ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ConvertPriceLevelInput; default: not declared - (input).method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - (input).referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - (input).referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - (input).sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - (input).sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - (input).targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - (input).targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - explain: (input: ConvertPriceLevelInput) => Computed; default: not declared — Same closed input and arithmetic; echoes the method, units, references/ratio and limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ConvertPriceLevelInput; default: not declared - explain(input).method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - explain(input).referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - explain(input).referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - explain(input).sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - explain(input).sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - explain(input).targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - explain(input).targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. ### @insiderfinance/totalfinance/valuation#costOfEquity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Cost of equity under an EXPLICIT method: `'capital-asset-pricing'` (risk-free + beta × premium) or `'dividend-growth'` (next dividend / price + growth). The dividend-growth form requires a positive share price and takes the NEXT dividend — the field name carries the timing so the one-period growth step is never applied twice or forgotten. ```typescript export declare function costOfEquity(input: CostOfEquityInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): CostOfEquityInput; default: not declared - (input).annualMarketRiskPremium: number; default: not declared - (input).annualRiskFreeRate: number; default: not declared - (input).beta: number; default: not declared - (input).method: ('capital-asset-pricing') | ('dividend-growth'); default: not declared - (input).nextAnnualDividendPerShare: number; default: not declared — The NEXT annual dividend per share (already grown one period). - (input).perpetualGrowthRate: number; default: not declared - (input).sharePrice: number; default: not declared ### @insiderfinance/totalfinance/valuation#cumulativeLoanInterest Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Total interest across an inclusive period range — SIGNED: positive for a nonnegative rate, negative when the periodic rate is negative (interest credited to the borrower). ```typescript export declare function cumulativeLoanInterest(input: LoanRangeInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanRangeInput; default: not declared - (input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - (input).fromPeriod: number; default: not declared — 1-based first period, inclusive. - (input).numberOfPeriods: number; default: not declared - (input).paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - (input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - (input).principal: number; default: not declared — Amount borrowed (positive). - (input).toPeriod: number; default: not declared — 1-based last period, inclusive. ### @insiderfinance/totalfinance/valuation#cumulativeLoanPrincipal Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Total balance reduction across an inclusive period range — SIGNED: exceeds the payments made when the periodic rate is negative (each period's principal component exceeds its payment). ```typescript export declare function cumulativeLoanPrincipal(input: LoanRangeInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanRangeInput; default: not declared - (input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - (input).fromPeriod: number; default: not declared — 1-based first period, inclusive. - (input).numberOfPeriods: number; default: not declared - (input).paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - (input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - (input).principal: number; default: not declared — Amount borrowed (positive). - (input).toPeriod: number; default: not declared — 1-based last period, inclusive. ### @insiderfinance/totalfinance/valuation#datedInternalRateOfReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The dated internal rate of return AT `asOf` — historical flows accumulate forward, future flows discount back, under one declared convention. `null` on no root or ambiguity; `.explain()` carries every root. ```typescript export declare const datedInternalRateOfReturn: ((input: DatedInternalRateOfReturnInput) => number | null) & { explain: (input: DatedInternalRateOfReturnInput) => InternalRateOfReturnReport; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DatedInternalRateOfReturnInput; default: not declared - (input).asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date; flows before it ACCUMULATE forward, never drop. - (input).cashFlows: readonly DatedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - (input).dayCount?: DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed in `.explain()`. - explain: (input: DatedInternalRateOfReturnInput) => InternalRateOfReturnReport; default: not declared - explain().return.assumptions: { asOf?: string; compounding: InterestCompounding; conventionsVersion: string; dayCount?: DayCount; searchRange: { from: number; to: number; }; }; default: not declared - explain().return.assumptions.asOf?: string; default: not declared — Present only on the dated head. - explain().return.assumptions.compounding: InterestCompounding; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.dayCount?: DayCount; default: not declared — Present only on the dated head. - explain().return.assumptions.searchRange: { from: number; to: number; }; default: not declared - explain().return.assumptions.searchRange.from: number; default: not declared - explain().return.assumptions.searchRange.to: number; default: not declared - explain().return.diagnostics: { converged: boolean; iterations: number; method: 'scan-bisect'; warnings: QuantWarning[]; }; default: not declared - explain().return.diagnostics.converged: boolean; default: not declared - explain().return.diagnostics.iterations: number; default: not declared - explain().return.diagnostics.method: 'scan-bisect'; default: not declared - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared - explain().return.roots: InternalRateRoot[]; default: not declared — EVERY economically admissible root found in the search range. - explain().return.value: number | null; default: not declared — The plain call's answer: the single root, or null when none or many. - explain(input): DatedInternalRateOfReturnInput; default: not declared - explain(input).asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date; flows before it ACCUMULATE forward, never drop. - explain(input).cashFlows: readonly DatedCashFlow[]; default: not declared - explain(input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - explain(input).dayCount?: DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed in `.explain()`. ### @insiderfinance/totalfinance/valuation#datedNetPresentValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Dated net present value AT `asOf`. Future flows discount back and HISTORICAL flows accumulate forward under the same declared convention — a realized flow is never discarded merely because it precedes the valuation date. A flow ON `asOf` enters at face value, exactly once. ```typescript export declare function datedNetPresentValue(input: DatedNetPresentValueInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DatedNetPresentValueInput; default: not declared - (input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - (input).asOf: string; default: not declared — Strict `YYYY-MM-DD` valuation date. - (input).cashFlows: readonly DatedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - (input).dayCount?: DayCount; default: not declared — Default `'ACT/365F'` — documented and echoed. ### @insiderfinance/totalfinance/valuation#decliningBalanceDepreciation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Declining-balance charge in `period` at the explicit `factor`, floored at salvage. ```typescript export declare function decliningBalanceDepreciation(input: DecliningBalanceInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DecliningBalanceInput; default: not declared - (input).cost: number; default: not declared — Acquisition cost (positive). - (input).factor: number; default: not declared — The declining-balance factor (e.g. `1.5`); double-declining uses its own head. - (input).period: number; default: not declared — 1-based period being asked about. - (input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - (input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). ### @insiderfinance/totalfinance/valuation#diaToDjiaLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate DJIA level corresponding to the supplied DIA level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const diaToDjiaLevel: { (input: DiaToDjiaLevelInput): number; explain: (input: DiaToDjiaLevelInput) => Computed>; }; ``` Example (source JSDoc): diaToDjiaLevel({ diaPriceLevel: 401.98, referenceDiaPrice: 398, referenceDjiaPrice: 40000 }); // ≈ 40400 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DiaToDjiaLevelInput; default: not declared - (input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - (input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - (input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - explain: (input: DiaToDjiaLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): DiaToDjiaLevelInput; default: not declared - explain(input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - explain(input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. ### @insiderfinance/totalfinance/valuation#diaToYmLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate YM level corresponding to the supplied DIA level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const diaToYmLevel: { (input: DiaToYmLevelInput): number; explain: (input: DiaToYmLevelInput) => Computed>; }; ``` Example (source JSDoc): diaToYmLevel({ diaPriceLevel: 401.98, referenceDiaPrice: 398, referenceYmPrice: 40000 }); // ≈ 40400 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DiaToYmLevelInput; default: not declared - (input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - (input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - (input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - explain: (input: DiaToYmLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): DiaToYmLevelInput; default: not declared - explain(input).diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - explain(input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. ### @insiderfinance/totalfinance/valuation#discountCashFlows Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Discount each flow individually (a supplied time-zero flow discounts by exactly 1 — included once, never inferred). Rows preserve input order; `presentValueTotal` is their sum. ```typescript export declare function discountCashFlows(input: DiscountCashFlowsInput): { rows: DiscountedCashFlowRow[]; presentValueTotal: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DiscountCashFlowsInput; default: not declared - (input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - return.presentValueTotal: number; default: not declared - return.rows: DiscountedCashFlowRow[]; default: not declared ### @insiderfinance/totalfinance/valuation#discountedCashFlow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The direct DCF: explicit projections, explicit conventions, explicit terminal method. The top-level `annualDiscountRate` feeds the terminal primitive too, so a caller never repeats the rate inside the terminal method. Firm basis returns enterprise value (equity only across a supplied bridge); equity basis returns equity value directly. ```typescript export declare function discountedCashFlow(input: DiscountedCashFlowInput): DiscountedCashFlowResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DiscountedCashFlowInput; default: not declared - (input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - (input).compounding: InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - (input).currency: string; default: not declared - (input).dayCount?: DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - (input).dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - (input).enterpriseToEquityBridge?: EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - (input).projectedCashFlows: ProjectedCashFlowSchedule; default: not declared - (input).provenance?: ValuationProvenance; default: not declared - (input).terminalValueMethod: TerminalValueMethod; default: not declared - (input).valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - (input).valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. ### @insiderfinance/totalfinance/valuation#discountedCashFlowFromStatements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The composition the acceptance law names: project the statements, take the emitted FCFF (firm basis) or FCFE (equity basis) at whole-year offsets, and hand them to the direct {@link discountedCashFlow} — so the composed valuation IS a direct valuation of the projected flows, reproducible by construction. ```typescript export declare function discountedCashFlowFromStatements(input: DiscountedCashFlowFromStatementsInput): DiscountedCashFlowFromStatementsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DiscountedCashFlowFromStatementsInput; default: not declared - (input).projection: ProjectStatementsInput; default: not declared — The statement projection (see {@link projectFinancialStatements}). - (input).valuation: Omit; default: not declared — Everything the direct DCF needs EXCEPT the flows — those come from the projection. - (input).valuation.annualDiscountRate: number; default: not declared — Annual discount rate (decimal). A professional DCF never obtains one from a default. - (input).valuation.compounding: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared — REQUIRED — a professional DCF states its convention. - (input).valuation.currency: string; default: not declared - (input).valuation.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared — REQUIRED when any flow is dated; rejected as unused when every flow is timed. - (input).valuation.dilutedSharesOutstanding?: number; default: not declared — Enables per-share value. - (input).valuation.enterpriseToEquityBridge?: import('@insiderfinance/totalfinance/valuation').EnterpriseToEquityBridge; default: not declared — Firm basis only: enables the equity bridge. - (input).valuation.provenance?: import('@insiderfinance/totalfinance/valuation').ValuationProvenance; default: not declared - (input).valuation.terminalValueMethod: import('@insiderfinance/totalfinance/valuation').TerminalValueMethod; default: not declared - (input).valuation.valuationBasis: 'equity' | 'firm'; default: not declared — Which value the projected flows produce: `'firm'` for FCFF (enterprise value), `'equity'` for FCFE (equity value). The basis is a statement about WHAT the flows are, so it is required. - (input).valuation.valuationDate: string; default: not declared — Strict `YYYY-MM-DD`. Every dated flow discounts from here. - return.assumptions: { cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; projectedPeriodCount: number; }; default: not declared - return.assumptions.cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; default: not declared — Which flow column fed the valuation, decided by the basis — never relabeled. - return.assumptions.projectedPeriodCount: number; default: not declared - return.cashFlowsUsed: 'freeCashFlowToFirm' | 'freeCashFlowToEquity'; default: not declared — Which flow column fed the valuation, decided by the valuation basis — never relabeled. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.projection: ProjectStatementsResult; default: not declared - return.valuation: DiscountedCashFlowResult; default: not declared ### @insiderfinance/totalfinance/valuation#discountedCashFlowScenarioAnalysis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Named deterministic assumption sets over one base case. Each scenario is the base input with ONLY its stated overrides replaced — scenario values are supplied, never invented — and each result is a direct {@link discountedCashFlow} call. ```typescript export declare function discountedCashFlowScenarioAnalysis(input: ScenarioAnalysisInput): ScenarioAnalysisResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ScenarioAnalysisInput; default: not declared - (input).discountedCashFlowInput: DiscountedCashFlowInput; default: not declared - (input).scenarios: readonly DiscountedCashFlowScenario[]; default: not declared - return.assumptions: { scenarioNames: string[]; }; default: not declared - return.assumptions.scenarioNames: string[]; default: not declared - return.baseCase: DiscountedCashFlowResult; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.scenarios: { scenarioName: string; overriddenFields: string[]; result: DiscountedCashFlowResult; }[]; default: not declared ### @insiderfinance/totalfinance/valuation#discountedCashFlowSensitivityTable Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A two-axis sensitivity table where EVERY cell is a direct {@link discountedCashFlow} call with exactly one row and one column value substituted — no incremental shortcuts, so the equality the acceptance law demands holds by construction. The base case is retained unmodified. ```typescript export declare function discountedCashFlowSensitivityTable(input: SensitivityTableInput): SensitivityTableResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SensitivityTableInput; default: not declared - (input).columnAxis: SensitivityAxis; default: not declared - (input).discountedCashFlowInput: DiscountedCashFlowInput; default: not declared - (input).rowAxis: SensitivityAxis; default: not declared - return.assumptions: { cellValue: 'enterpriseValue' | 'equityValue'; columnUnit: string; columnVariable: SensitivityAxis['variable']; rowUnit: string; rowVariable: SensitivityAxis['variable']; }; default: not declared - return.assumptions.cellValue: 'enterpriseValue' | 'equityValue'; default: not declared - return.assumptions.columnUnit: string; default: not declared - return.assumptions.columnVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - return.assumptions.rowUnit: string; default: not declared - return.assumptions.rowVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - return.baseCase: DiscountedCashFlowResult; default: not declared — The unmodified base case, retained. - return.cellValue: 'enterpriseValue' | 'equityValue'; default: not declared — The value each cell reports: enterprise value (firm basis) or equity value (equity basis). - return.cells: number[][]; default: not declared — `cells[rowIndex][columnIndex]` — each PROVEN equal to a direct DCF call by construction. - return.columnUnit: string; default: not declared - return.columnValues: number[]; default: not declared - return.columnVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.rowUnit: string; default: not declared — The unit of the row/column values, stated. - return.rowValues: number[]; default: not declared - return.rowVariable: 'annual-discount-rate' | 'perpetual-growth-rate' | 'exit-multiple'; default: not declared ### @insiderfinance/totalfinance/valuation#discountedPaybackPeriod Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). {@link paybackPeriod} on DISCOUNTED flows — the recovery clock respects the time value. ```typescript export declare function discountedPaybackPeriod(input: DiscountedPaybackInput): number | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DiscountedPaybackInput; default: not declared - (input).annualDiscountRate: number; default: not declared — Annual rate (decimal). - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. ### @insiderfinance/totalfinance/valuation#dividendDiscountValuation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Present value of explicit projected dividends per share plus a terminal stage. With an EMPTY projection stage and a perpetual-growth terminal (its `terminalCashFlow` being the CURRENT annual dividend), this is exactly the Gordon growth model: `D0 × (1 + g) / (r − g)`. ```typescript export declare function dividendDiscountValuation(input: DividendDiscountInput): DividendDiscountResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DividendDiscountInput; default: not declared - (input).annualCostOfEquity: number; default: not declared — Annual cost of equity (decimal) — the discount rate for dividends. - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - (input).projectedDividendsPerShare: readonly TimedCashFlow[]; default: not declared — Explicit projected dividends PER SHARE (timed from today). An empty projection stage with a perpetual-growth terminal is the classic single-stage Gordon model. - (input).terminalValueMethod: TerminalValueMethod; default: not declared - return.assumptions: { annualCostOfEquity: number; compounding: InterestCompounding; terminalCashFlowConvention: 'final-forecast-period-flow'; terminalValueMethod: TerminalValueMethod; }; default: not declared - return.assumptions.annualCostOfEquity: number; default: not declared - return.assumptions.compounding: InterestCompounding; default: not declared - return.assumptions.terminalCashFlowConvention: 'final-forecast-period-flow'; default: not declared - return.assumptions.terminalValueMethod: TerminalValueMethod; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.projectedDividendPresentValue: number; default: not declared - return.rows: { timeYears: number; dividendPerShare: number; discountFactor: number; presentValue: number; }[]; default: not declared - return.terminalValue: number; default: not declared - return.terminalValuePresentValue: number; default: not declared - return.valuePerShare: number; default: not declared ### @insiderfinance/totalfinance/valuation#djiaToDiaLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate DIA level corresponding to the supplied DJIA level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const djiaToDiaLevel: { (input: DjiaToDiaLevelInput): number; explain: (input: DjiaToDiaLevelInput) => Computed>; }; ``` Example (source JSDoc): djiaToDiaLevel({ djiaPriceLevel: 40400, referenceDjiaPrice: 40000, referenceDiaPrice: 398 }); // ≈ 401.98 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DjiaToDiaLevelInput; default: not declared - (input).djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - (input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - (input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - explain: (input: DjiaToDiaLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): DjiaToDiaLevelInput; default: not declared - explain(input).djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - explain(input).referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. ### @insiderfinance/totalfinance/valuation#doubleDecliningBalanceDepreciation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Double-declining balance: {@link decliningBalanceDepreciation} at factor 2. ```typescript export declare function doubleDecliningBalanceDepreciation(input: DepreciationInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DepreciationInput; default: not declared - (input).cost: number; default: not declared — Acquisition cost (positive). - (input).period: number; default: not declared — 1-based period being asked about. - (input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - (input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). ### @insiderfinance/totalfinance/valuation#effectiveAnnualRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Effective annual rate: the one-year growth of the nominal rate under its convention, minus 1. ```typescript export declare function effectiveAnnualRate(input: EffectiveAnnualRateInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EffectiveAnnualRateInput; default: not declared - (input).compounding: InterestCompounding; default: not declared — REQUIRED — a rate conversion never guesses its convention. - (input).nominalAnnualRate: number; default: not declared — Nominal (stated) annual rate (decimal). ### @insiderfinance/totalfinance/valuation#enterpriseToEquityValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Equity value = enterprise value − total debt − preferred equity − minority interest + cash and cash equivalents + non-operating assets. The bridge is EXPLICIT: a field the company genuinely lacks is a stated zero, not an omission. ```typescript export declare function enterpriseToEquityValue(input: EnterpriseToEquityValueInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EnterpriseToEquityValueInput; default: not declared - (input).enterpriseToEquityBridge: EnterpriseToEquityBridge; default: not declared - (input).enterpriseValue: number; default: not declared ### @insiderfinance/totalfinance/valuation#equivalentAnnualAnnuity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The level annual amount whose PV over `projectLifeYears` equals the project NPV — the standard yardstick for comparing projects of unequal length. The annuity factor honors the SAME declared `compounding` convention the NPV used: it is `Σ discountFactor(rate, t, compounding)` over the integer payment years `t = 1..projectLifeYears`, so discounting the returned annuity back over the project life under that convention recovers the NPV exactly. (Under `'annual'` the sum equals the classic closed-form annuity factor `(1 − (1 + r)^−L) / r`.) ```typescript export declare function equivalentAnnualAnnuity(input: EquivalentAnnualAnnuityInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EquivalentAnnualAnnuityInput; default: not declared - (input).annualDiscountRate: number; default: not declared - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'`. - (input).projectLifeYears: number; default: not declared — Project length in years (the annuity horizon). ### @insiderfinance/totalfinance/valuation#equivalentInterestRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-express a rate in another convention so both produce the SAME one-year growth. ```typescript export declare function equivalentInterestRate(input: EquivalentInterestRateInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EquivalentInterestRateInput; default: not declared - (input).annualInterestRate: number; default: not declared — Annual rate (decimal) quoted in `fromCompounding`. - (input).fromCompounding: InterestCompounding; default: not declared — REQUIRED source convention. - (input).toCompounding: InterestCompounding; default: not declared — REQUIRED target convention. ### @insiderfinance/totalfinance/valuation#esToSpyLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate SPY level corresponding to the supplied ES level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const esToSpyLevel: { (input: EsToSpyLevelInput): number; explain: (input: EsToSpyLevelInput) => Computed>; }; ``` Example (source JSDoc): esToSpyLevel({ esPriceLevel: 6030, referenceEsPrice: 6000, referenceSpyPrice: 596 }); // ≈ 598.98 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): EsToSpyLevelInput; default: not declared - (input).esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - (input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - (input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - explain: (input: EsToSpyLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): EsToSpyLevelInput; default: not declared - explain(input).esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - explain(input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. ### @insiderfinance/totalfinance/valuation#freeCashFlowToEquity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FCFE = net income + depreciation/amortization − capital expenditure − increase in net working capital + net borrowing. ```typescript export declare function freeCashFlowToEquity(input: FreeCashFlowToEquityInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FreeCashFlowToEquityInput; default: not declared - (input).capitalExpenditure: number; default: not declared - (input).depreciationAndAmortization: number; default: not declared - (input).increaseInNetWorkingCapital: number; default: not declared — The INCREASE in net working capital over the period (a decrease is negative). - (input).netBorrowing: number; default: not declared — New borrowing minus repayments over the period. - (input).netIncome: number; default: not declared ### @insiderfinance/totalfinance/valuation#freeCashFlowToFirm Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FCFF = operating income × (1 − tax rate) + depreciation/amortization − capital expenditure − increase in net working capital. Wants OPERATING income — handing it net income double-counts interest, and the field name refuses the swap. ```typescript export declare function freeCashFlowToFirm(input: FreeCashFlowToFirmInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FreeCashFlowToFirmInput; default: not declared - (input).capitalExpenditure: number; default: not declared - (input).depreciationAndAmortization: number; default: not declared - (input).increaseInNetWorkingCapital: number; default: not declared — The INCREASE in net working capital over the period (a decrease is negative). - (input).operatingIncome: number; default: not declared - (input).taxRate: number; default: not declared — Tax rate in [0, 1) applied to operating income. ### @insiderfinance/totalfinance/valuation#futureValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Future value of one present amount: `presentAmount · compoundFactor(rate, t, compounding)`. ```typescript export declare function futureValue(input: FutureValueInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FutureValueInput; default: not declared - (input).annualInterestRate: number; default: not declared — Annual rate (decimal). - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. - (input).presentAmount: number; default: not declared — The amount held at time zero. - (input).timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#internalRateOfReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The internal rate of return of explicit timed flows, or `null` when no admissible root exists or MORE THAN ONE does — an ambiguous IRR is never chosen silently. `.explain()` carries every root and the ambiguity warning. ```typescript export declare const internalRateOfReturn: ((input: InternalRateOfReturnInput) => number | null) & { explain: (input: InternalRateOfReturnInput) => InternalRateOfReturnReport; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): InternalRateOfReturnInput; default: not declared - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. - explain: (input: InternalRateOfReturnInput) => InternalRateOfReturnReport; default: not declared - explain().return.assumptions: { asOf?: string; compounding: InterestCompounding; conventionsVersion: string; dayCount?: DayCount; searchRange: { from: number; to: number; }; }; default: not declared - explain().return.assumptions.asOf?: string; default: not declared — Present only on the dated head. - explain().return.assumptions.compounding: InterestCompounding; default: not declared - explain().return.assumptions.conventionsVersion: string; default: not declared - explain().return.assumptions.dayCount?: DayCount; default: not declared — Present only on the dated head. - explain().return.assumptions.searchRange: { from: number; to: number; }; default: not declared - explain().return.assumptions.searchRange.from: number; default: not declared - explain().return.assumptions.searchRange.to: number; default: not declared - explain().return.diagnostics: { converged: boolean; iterations: number; method: 'scan-bisect'; warnings: QuantWarning[]; }; default: not declared - explain().return.diagnostics.converged: boolean; default: not declared - explain().return.diagnostics.iterations: number; default: not declared - explain().return.diagnostics.method: 'scan-bisect'; default: not declared - explain().return.diagnostics.warnings: QuantWarning[]; default: not declared - explain().return.roots: InternalRateRoot[]; default: not declared — EVERY economically admissible root found in the search range. - explain().return.value: number | null; default: not declared — The plain call's answer: the single root, or null when none or many. - explain(input): InternalRateOfReturnInput; default: not declared - explain(input).cashFlows: readonly TimedCashFlow[]; default: not declared - explain(input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed in `.explain()`. ### @insiderfinance/totalfinance/valuation#iwmToRtyLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate RTY level corresponding to the supplied IWM level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const iwmToRtyLevel: { (input: IwmToRtyLevelInput): number; explain: (input: IwmToRtyLevelInput) => Computed>; }; ``` Example (source JSDoc): iwmToRtyLevel({ iwmPriceLevel: 199.98, referenceIwmPrice: 198, referenceRtyPrice: 2000 }); // ≈ 2020 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IwmToRtyLevelInput; default: not declared - (input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - (input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - (input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - explain: (input: IwmToRtyLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): IwmToRtyLevelInput; default: not declared - explain(input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - explain(input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. ### @insiderfinance/totalfinance/valuation#iwmToRutLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate RUT level corresponding to the supplied IWM level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const iwmToRutLevel: { (input: IwmToRutLevelInput): number; explain: (input: IwmToRutLevelInput) => Computed>; }; ``` Example (source JSDoc): iwmToRutLevel({ iwmPriceLevel: 199.98, referenceIwmPrice: 198, referenceRutPrice: 2000 }); // ≈ 2020 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): IwmToRutLevelInput; default: not declared - (input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - (input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - (input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - explain: (input: IwmToRutLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): IwmToRutLevelInput; default: not declared - explain(input).iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - explain(input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. ### @insiderfinance/totalfinance/valuation#leveragedBuyoutAnalysis Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Leveraged buyout analysis: entry sources/uses, an annual debt/cash schedule under mandatory amortization plus a priority-ordered cash sweep, the exit bridge from enterprise value to sponsor proceeds, the sponsor's equity cash flows, MOIC, and IRR (via the FC1 solver). See the module doc comment for the DISCLOSED simplifications, echoed in the result. ```typescript export declare function leveragedBuyoutAnalysis(input: LeveragedBuyoutAnalysisInput): LeveragedBuyoutAnalysisResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LeveragedBuyoutAnalysisInput; default: not declared - (input).cashSweepFraction: number; default: not declared — Fraction (0 ≤ f ≤ 1) of positive post-mandatory-amortization FCF swept to debt each year. - (input).exit: LeveragedBuyoutExitInput; default: not declared - (input).operatingForecast: readonly LeveragedBuyoutOperatingYearInput[]; default: not declared - (input).sources: LeveragedBuyoutSourcesInput; default: not declared - (input).transaction: LeveragedBuyoutTransactionInput; default: not declared - return.annualSchedule: LeveragedBuyoutAnnualScheduleRow[]; default: not declared - return.assumptions: { disclosedSimplifications: string[]; }; default: not declared - return.assumptions.disclosedSimplifications: string[]; default: not declared — Every modeling simplification this analysis makes, stated — never implied. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — The disclosed simplifications, surfaced in the one grammar every analysis shares. - return.equityCashFlows: TimedCashFlow[]; default: not declared — −sponsorEquity at year 0, +equityProceeds at the exit year (no interim dividends, v1). - return.exitBridge: LeveragedBuyoutExitBridge; default: not declared - return.internalRateOfReturn: number | null; default: not declared — The sponsor's IRR from the FC1 solver, or `null` when no admissible rate exists (equity proceeds ≤ 0 have no positive-flow leg for an internal rate to equate). - return.multipleOnInvestedCapital: number; default: not declared — `equityProceeds / sponsorEquity`. - return.sourcesAndUses: LeveragedBuyoutSourcesAndUses; default: not declared ### @insiderfinance/totalfinance/valuation#loanInterestPayment Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Interest portion of the payment in one period — SIGNED: positive for a nonnegative rate, negative when the periodic rate is negative (the period credits interest to the borrower). ```typescript export declare function loanInterestPayment(input: LoanPeriodInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanPeriodInput; default: not declared - (input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - (input).numberOfPeriods: number; default: not declared - (input).paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - (input).period: number; default: not declared — 1-based period the question is about. - (input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - (input).principal: number; default: not declared — Amount borrowed (positive). ### @insiderfinance/totalfinance/valuation#loanNumberOfPeriods Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Periods (possibly fractional) for `payment` to amortize `principal` down to `balloon`. ```typescript export declare function loanNumberOfPeriods(input: LoanNumberOfPeriodsInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanNumberOfPeriodsInput; default: not declared - (input).balloon?: number; default: not declared - (input).payment: number; default: not declared — The level payment (positive magnitude). - (input).paymentTiming: PaymentTiming; default: not declared - (input).periodicInterestRate: number; default: not declared - (input).principal: number; default: not declared ### @insiderfinance/totalfinance/valuation#loanPeriodicInterestRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The per-period rate that makes `payment` amortize `principal` — a PROVEN bracket on the monotone payment-in-rate map (geometric expansion until the sign changes, over the full economic domain `rate > −1`), then bisection, then a residual check that the found rate actually reproduces the payment. The closed form for one period shows the rate can be astronomically large (`payment / principal − 1`), so the expansion never stops at an arbitrary cap and returns — failing to bracket is a refusal with a teaching error, never a number. One shape is refused BEFORE the solver: a one-period `'beginning'` loan with no balloon pays its single installment at time zero, so the rate never touches a cash flow — the rate is unidentifiable when `payment === principal` (every rate satisfies the identity) and no rate solves it otherwise. See the inline teaching errors for both sub-cases. ```typescript export declare function loanPeriodicInterestRate(input: LoanPeriodicInterestRateInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanPeriodicInterestRateInput; default: not declared - (input).balloon?: number; default: not declared - (input).numberOfPeriods: number; default: not declared - (input).payment: number; default: not declared — The level payment (positive magnitude). - (input).paymentTiming: PaymentTiming; default: not declared - (input).principal: number; default: not declared ### @insiderfinance/totalfinance/valuation#loanPrincipalPayment Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Balance reduction in one period (`payment − interest`) — SIGNED: exceeds the payment when the periodic rate (and so the interest component) is negative. ```typescript export declare function loanPrincipalPayment(input: LoanPeriodInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LoanPeriodInput; default: not declared - (input).balloon?: number; default: not declared — Residual balance due at the end (explicit; default 0 means fully amortizing). - (input).numberOfPeriods: number; default: not declared - (input).paymentTiming: PaymentTiming; default: not declared — REQUIRED: `'end'` (ordinary annuity) or `'beginning'` (annuity due). - (input).period: number; default: not declared — 1-based period the question is about. - (input).periodicInterestRate: number; default: not declared — Per-period interest rate (decimal) — callers convert annual rates explicitly. - (input).principal: number; default: not declared — Amount borrowed (positive). ### @insiderfinance/totalfinance/valuation#modifiedInternalRateOfReturn Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Modified IRR: negative flows discount to time zero at `financeRate`; positive flows compound to the horizon at `reinvestmentRate`; the MIRR is the single rate equating them over the horizon. Deterministic — no root ambiguity exists, so the plain call returns a number. ```typescript export declare function modifiedInternalRateOfReturn(input: ModifiedInternalRateOfReturnInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ModifiedInternalRateOfReturnInput; default: not declared - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. - (input).financeRate: number; default: not declared — Annual rate financing the negative flows (decimal). - (input).reinvestmentRate: number; default: not declared — Annual rate reinvesting the positive flows (decimal). ### @insiderfinance/totalfinance/valuation#ndxToQqqLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate QQQ level corresponding to the supplied NDX level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const ndxToQqqLevel: { (input: NdxToQqqLevelInput): number; explain: (input: NdxToQqqLevelInput) => Computed>; }; ``` Example (source JSDoc): ndxToQqqLevel({ ndxPriceLevel: 20250, referenceNdxPrice: 20000, referenceQqqPrice: 500 }); // ≈ 506.25 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NdxToQqqLevelInput; default: not declared - (input).ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - (input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - (input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - explain: (input: NdxToQqqLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): NdxToQqqLevelInput; default: not declared - explain(input).ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - explain(input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#netPresentValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Net present value of explicit timed flows. A supplied `timeYears: 0` flow is included exactly once at face value; no time-zero flow is ever inferred. ```typescript export declare function netPresentValue(input: NetPresentValueInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NetPresentValueInput; default: not declared - (input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — documented and echoed. ### @insiderfinance/totalfinance/valuation#nominalAnnualRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Nominal annual rate whose EAR under `compounding` equals the given effective rate. ```typescript export declare function nominalAnnualRate(input: NominalAnnualRateInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NominalAnnualRateInput; default: not declared - (input).compounding: InterestCompounding; default: not declared — REQUIRED — a rate conversion never guesses its convention. - (input).effectiveAnnualRate: number; default: not declared — Effective annual rate (decimal). ### @insiderfinance/totalfinance/valuation#nqToQqqLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate QQQ level corresponding to the supplied NQ level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const nqToQqqLevel: { (input: NqToQqqLevelInput): number; explain: (input: NqToQqqLevelInput) => Computed>; }; ``` Example (source JSDoc): nqToQqqLevel({ nqPriceLevel: 20250, referenceNqPrice: 20000, referenceQqqPrice: 500 }); // ≈ 506.25 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): NqToQqqLevelInput; default: not declared - (input).nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - (input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - (input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - explain: (input: NqToQqqLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): NqToQqqLevelInput; default: not declared - explain(input).nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - explain(input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#operatingForecast Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Revenue, margins, taxes, working capital, capital expenditure, depreciation, and the resulting FCFF (and FCFE where the financing drivers are supplied) — from EXPLICIT per-period drivers. FCFF taxes operating income at the period's rate (the {@link freeCashFlowToFirm} primitive); net income and FCFE additionally need the period's interest expense, stated, never assumed zero. ```typescript export declare function operatingForecast(input: OperatingForecastInput): OperatingForecastResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): OperatingForecastInput; default: not declared - (input).baseRevenue: number; default: not declared — The revenue base the first growth-driven period grows FROM (the last historical revenue). - (input).periods: readonly OperatingForecastPeriod[]; default: not declared - return.assumptions: { baseRevenue: number; periods: readonly OperatingForecastPeriod[]; }; default: not declared — The drivers, echoed verbatim per period. - return.assumptions.baseRevenue: number; default: not declared - return.assumptions.periods: readonly OperatingForecastPeriod[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — One warning per row output disabled by an absent driver. - return.rows: OperatingForecastRow[]; default: not declared ### @insiderfinance/totalfinance/valuation#paybackPeriod Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Years until cumulative cash flow first reaches zero (linear interpolation within the recovering interval), or `null` when the outlay is never recovered. ```typescript export declare function paybackPeriod(input: PaybackInput): number | null; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PaybackInput; default: not declared - (input).cashFlows: readonly TimedCashFlow[]; default: not declared ### @insiderfinance/totalfinance/valuation#presentValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Present value of one future amount: `futureAmount · discountFactor(rate, t, compounding)`. ```typescript export declare function presentValue(input: PresentValueInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): PresentValueInput; default: not declared - (input).annualInterestRate: number; default: not declared — Annual rate (decimal, e.g. `0.08`). - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'` — the FC1 ordinary-flow convention, documented and echoed. - (input).futureAmount: number; default: not declared — The amount received at `timeYears`. - (input).timeYears: number; default: not declared ### @insiderfinance/totalfinance/valuation#probabilisticDiscountedCashFlow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Monte-Carlo DCF over the DECLARED randomized variables: Gaussian dependence per the supplied correlations, inverse-CDF marginal transforms, one direct {@link discountedCashFlow} call per sample. A draw the model's own domain rejects (e.g. growth at or above the rate) is counted and excluded with its reason — never clamped into validity. With every distribution degenerate the run collapses to the deterministic result exactly. ```typescript export declare function probabilisticDiscountedCashFlow(input: ProbabilisticDiscountedCashFlowInput): ProbabilisticDiscountedCashFlowResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ProbabilisticDiscountedCashFlowInput; default: not declared - (input).correlationMatrix?: readonly (readonly number[])[]; default: not declared — Correlation matrix over `distributions` (Gaussian dependence, applied before the marginal transforms). Omitted → independent. - (input).discountedCashFlowInput: DiscountedCashFlowInput; default: not declared - (input).distributions: readonly RandomizedVariable[]; default: not declared - (input).sampleCount: number; default: not declared - (input).seed: number; default: not declared - return.assumptions: { baseCase: DiscountedCashFlowResult; correlationMatrix: readonly (readonly number[])[] | 'independent'; dependence: 'gaussian-copula-over-declared-correlations'; distributions: readonly RandomizedVariable[]; }; default: not declared — The exact seeded assumptions, echoed for reproduction. - return.assumptions.baseCase: DiscountedCashFlowResult; default: not declared - return.assumptions.correlationMatrix: readonly (readonly number[])[] | 'independent'; default: not declared - return.assumptions.dependence: 'gaussian-copula-over-declared-correlations'; default: not declared - return.assumptions.distributions: readonly RandomizedVariable[]; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — One warning per rejected-sample reason (count included). - return.maximum: number; default: not declared - return.mean: number; default: not declared - return.minimum: number; default: not declared - return.probabilityAtOrBelowZero: number; default: not declared — Left-tail diagnostics: the sampled probability that the value falls at or below zero. - return.quantiles: { p05: number; p10: number; p25: number; p50: number; p75: number; p90: number; p95: number; }; default: not declared - return.quantiles.p05: number; default: not declared - return.quantiles.p10: number; default: not declared - return.quantiles.p25: number; default: not declared - return.quantiles.p50: number; default: not declared - return.quantiles.p75: number; default: not declared - return.quantiles.p90: number; default: not declared - return.quantiles.p95: number; default: not declared - return.rejectedSamples: { count: number; reasons: Record; }; default: not declared — Samples the model's own laws rejected (e.g. growth ≥ rate), with the reasons tallied. - return.rejectedSamples.count: number; default: not declared - return.rejectedSamples.reasons: Record; default: not declared - return.sampleCount: number; default: not declared - return.seed: number; default: not declared - return.standardDeviation: number; default: not declared - return.validSampleCount: number; default: not declared — Samples whose drawn variables kept the model inside its domain. - return.valueDescribed: 'enterpriseValue' | 'equityValue'; default: not declared — The value the distribution describes (per the base input's valuation basis). ### @insiderfinance/totalfinance/valuation#profitabilityIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). PV of the positive flows ÷ PV of the outlays (positive magnitude): > 1 means value-creating at the discount rate. ```typescript export declare function profitabilityIndex(input: ProfitabilityIndexInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ProfitabilityIndexInput; default: not declared - (input).annualDiscountRate: number; default: not declared - (input).cashFlows: readonly TimedCashFlow[]; default: not declared - (input).compounding?: InterestCompounding; default: not declared — Default `'annual'`. ### @insiderfinance/totalfinance/valuation#projectFinancialStatements Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A three-statement projection from a typed historical base and explicit per-period drivers. The articulation, written out (Δ = period change): ΔtotalAssets = Δcash + ΔAR + Δinventory + ΔPPE = (CFO + CFI + CFF) + ΔAR + Δinventory + (capex − D&A) = netIncome + ΔAP + netBorrowing − dividends ΔtotalLiabilities + Δequity = ΔAP + netBorrowing + netIncome − dividends — identical, so the balance sheet ties EXACTLY with cash as the named balancer. Other assets and other liabilities are carried CONSTANT from the base (disclosed), never grown silently. ```typescript export declare function projectFinancialStatements(input: ProjectStatementsInput): ProjectStatementsResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ProjectStatementsInput; default: not declared - (input).baseStatements: FinancialStatements; default: not declared — The typed historical anchor — beginning balances come from HERE, not from an assumption. - (input).periods: readonly StatementProjectionPeriod[]; default: not declared - return.assumptions: { periods: readonly StatementProjectionPeriod[]; }; default: not declared - return.assumptions.periods: readonly StatementProjectionPeriod[]; default: not declared - return.balancingItem: 'cash'; default: not declared — The named balancing item. CASH absorbs the residual of the articulated statements — the identity `assets = liabilities + equity` then holds by construction, and the proof is the per-period `identityDifference` (floating-point dust, gated in tests). - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared — Any period whose identity residual exceeds floating-point dust. - return.reconciliation: { periodLabel: string; identityDifference: number; }[]; default: not declared - return.statements: ProjectedStatements[]; default: not declared ### @insiderfinance/totalfinance/valuation#qqqToNdxLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate NDX level corresponding to the supplied QQQ level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const qqqToNdxLevel: { (input: QqqToNdxLevelInput): number; explain: (input: QqqToNdxLevelInput) => Computed>; }; ``` Example (source JSDoc): qqqToNdxLevel({ qqqPriceLevel: 506.25, referenceQqqPrice: 500, referenceNdxPrice: 20000 }); // ≈ 20250 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): QqqToNdxLevelInput; default: not declared - (input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - (input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - (input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - explain: (input: QqqToNdxLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): QqqToNdxLevelInput; default: not declared - explain(input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - explain(input).referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#qqqToNqLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate NQ level corresponding to the supplied QQQ level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const qqqToNqLevel: { (input: QqqToNqLevelInput): number; explain: (input: QqqToNqLevelInput) => Computed>; }; ``` Example (source JSDoc): qqqToNqLevel({ qqqPriceLevel: 506.25, referenceQqqPrice: 500, referenceNqPrice: 20000 }); // ≈ 20250 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): QqqToNqLevelInput; default: not declared - (input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - (input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - (input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - explain: (input: QqqToNqLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): QqqToNqLevelInput; default: not declared - explain(input).qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - explain(input).referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - explain(input).referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. ### @insiderfinance/totalfinance/valuation#requireCompoundingWhenPresent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared when-present compounding ladder — the seven-form grammar, taught at the boundary. ```typescript export declare function requireCompoundingWhenPresent(functionName: string, compounding: unknown): asserts compounding is InterestCompounding | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (compounding): unknown; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/valuation#requireDayCountWhenPresent Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Shared when-present day-count ladder over core's ONE vocabulary. ```typescript export declare function requireDayCountWhenPresent(functionName: string, dayCount: unknown): asserts dayCount is DayCount | undefined; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (dayCount): unknown; default: not declared - (functionName): string; default: not declared ### @insiderfinance/totalfinance/valuation#residualIncomeValuation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Clean-surplus residual income: value = beginning book value + Σ PV(EPS_t − r × B_{t−1}) + PV of the stated terminal stage. Book value rolls forward as `B_t = B_{t−1} + EPS_t − DPS_t`; annual discrete discounting (the model is annual by construction). ```typescript export declare function residualIncomeValuation(input: ResidualIncomeInput): ResidualIncomeResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ResidualIncomeInput; default: not declared - (input).annualCostOfEquity: number; default: not declared — Annual cost of equity (decimal). - (input).beginningBookValuePerShare: number; default: not declared — Book value per share at the valuation date. - (input).projections: readonly ResidualIncomeProjection[]; default: not declared — One entry per forecast YEAR, in order — clean surplus rolls the book value between them. - (input).terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; default: not declared — The residual-income terminal stage: `'none'` states that residual income is competed away after the horizon; `'perpetuity'` continues the FINAL residual income at a growth rate. - (input).terminalResidualIncome.method: ('none') | ('perpetuity'); default: not declared - (input).terminalResidualIncome.perpetualGrowthRate: number; default: not declared - return.assumptions: { annualCostOfEquity: number; cleanSurplus: 'ending book = beginning book + earnings - dividends'; terminalResidualIncome: ResidualIncomeInput['terminalResidualIncome']; }; default: not declared - return.assumptions.annualCostOfEquity: number; default: not declared - return.assumptions.cleanSurplus: 'ending book = beginning book + earnings - dividends'; default: not declared - return.assumptions.terminalResidualIncome: { method: 'none'; } | { method: 'perpetuity'; perpetualGrowthRate: number; }; default: not declared - return.assumptions.terminalResidualIncome.method: ('none') | ('perpetuity'); default: not declared - return.assumptions.terminalResidualIncome.perpetualGrowthRate: number; default: not declared - return.beginningBookValuePerShare: number; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.residualIncomePresentValue: number; default: not declared - return.rows: { year: number; beginningBookValuePerShare: number; earningsPerShare: number; dividendsPerShare: number; endingBookValuePerShare: number; equityCharge: number; residualIncomePerShare: number; presentValue: number; }[]; default: not declared - return.terminalValuePresentValue: number; default: not declared - return.valuePerShare: number; default: not declared ### @insiderfinance/totalfinance/valuation#reverseDiscountedCashFlow Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Solve for the stated variable so the DCF reproduces `targetValue` (enterprise value on the firm basis, equity value on equity). Bisection over the EXPLICIT search range; bounds and convergence are reported, and a no-root range answers `null` with the reason — never the nearest endpoint. ```typescript export declare function reverseDiscountedCashFlow(input: ReverseDiscountedCashFlowInput): ReverseDiscountedCashFlowResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ReverseDiscountedCashFlowInput; default: not declared - (input).discountedCashFlowInput: DiscountedCashFlowInput; default: not declared — The full direct-DCF input to hold fixed (except the solved variable). - (input).target: ReverseDiscountedCashFlowTarget; default: not declared - (input).targetValue: number; default: not declared — The observed value to match: enterprise value on the firm basis, equity value on equity. - return.assumptions: { method: 'bisection'; searchRange: { from: number; to: number; }; targetValue: number; variable: ReverseDiscountedCashFlowTarget['variable']; }; default: not declared - return.assumptions.method: 'bisection'; default: not declared - return.assumptions.searchRange: { from: number; to: number; }; default: not declared - return.assumptions.searchRange.from: number; default: not declared - return.assumptions.searchRange.to: number; default: not declared - return.assumptions.targetValue: number; default: not declared - return.assumptions.variable: 'annual-discount-rate' | 'perpetual-growth-rate'; default: not declared - return.converged: boolean; default: not declared - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.impliedResult: DiscountedCashFlowResult | null; default: not declared — The valuation the implied variable reproduces, for inspection. - return.impliedValue: number | null; default: not declared — The implied value of the solved variable, or `null` when no root lies in the range. - return.iterations: number; default: not declared - return.reason?: string; default: not declared — Why `impliedValue` is null, when it is. - return.residual: number | null; default: not declared — |model(implied) − target| at the reported solution (absolute). - return.searchRange: { from: number; to: number; }; default: not declared - return.searchRange.from: number; default: not declared - return.searchRange.to: number; default: not declared - return.variable: 'annual-discount-rate' | 'perpetual-growth-rate'; default: not declared ### @insiderfinance/totalfinance/valuation#rtyToIwmLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate IWM level corresponding to the supplied RTY level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const rtyToIwmLevel: { (input: RtyToIwmLevelInput): number; explain: (input: RtyToIwmLevelInput) => Computed>; }; ``` Example (source JSDoc): rtyToIwmLevel({ rtyPriceLevel: 2020, referenceRtyPrice: 2000, referenceIwmPrice: 198 }); // ≈ 199.98 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RtyToIwmLevelInput; default: not declared - (input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - (input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - (input).rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. - explain: (input: RtyToIwmLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): RtyToIwmLevelInput; default: not declared - explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - explain(input).referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - explain(input).rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#rutToIwmLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate IWM level corresponding to the supplied RUT level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const rutToIwmLevel: { (input: RutToIwmLevelInput): number; explain: (input: RutToIwmLevelInput) => Computed>; }; ``` Example (source JSDoc): rutToIwmLevel({ rutPriceLevel: 2020, referenceRutPrice: 2000, referenceIwmPrice: 198 }); // ≈ 199.98 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RutToIwmLevelInput; default: not declared - (input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - (input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - (input).rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. - explain: (input: RutToIwmLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): RutToIwmLevelInput; default: not declared - explain(input).referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - explain(input).referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - explain(input).rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#spxToSpyLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate SPY level corresponding to the supplied SPX level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const spxToSpyLevel: { (input: SpxToSpyLevelInput): number; explain: (input: SpxToSpyLevelInput) => Computed>; }; ``` Example (source JSDoc): spxToSpyLevel({ spxPriceLevel: 6030, referenceSpxPrice: 6000, referenceSpyPrice: 596 }); // ≈ 598.98 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SpxToSpyLevelInput; default: not declared - (input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - (input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - (input).spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. - explain: (input: SpxToSpyLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): SpxToSpyLevelInput; default: not declared - explain(input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - explain(input).spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#spyToEsLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate ES level corresponding to the supplied SPY level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const spyToEsLevel: { (input: SpyToEsLevelInput): number; explain: (input: SpyToEsLevelInput) => Computed>; }; ``` Example (source JSDoc): spyToEsLevel({ spyPriceLevel: 598.98, referenceSpyPrice: 596, referenceEsPrice: 6000 }); // ≈ 6030 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SpyToEsLevelInput; default: not declared - (input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - (input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - (input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - explain: (input: SpyToEsLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): SpyToEsLevelInput; default: not declared - explain(input).referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - explain(input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#spyToSpxLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate SPX level corresponding to the supplied SPY level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const spyToSpxLevel: { (input: SpyToSpxLevelInput): number; explain: (input: SpyToSpxLevelInput) => Computed>; }; ``` Example (source JSDoc): spyToSpxLevel({ spyPriceLevel: 598.98, referenceSpyPrice: 596, referenceSpxPrice: 6000 }); // ≈ 6030 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SpyToSpxLevelInput; default: not declared - (input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - (input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - (input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - explain: (input: SpyToSpxLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): SpyToSpxLevelInput; default: not declared - explain(input).referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - explain(input).referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - explain(input).spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. ### @insiderfinance/totalfinance/valuation#straightLineDepreciation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Straight-line: the same charge every period, `(cost − salvage) / life`. ```typescript export declare function straightLineDepreciation(input: DepreciationInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DepreciationInput; default: not declared - (input).cost: number; default: not declared — Acquisition cost (positive). - (input).period: number; default: not declared — 1-based period being asked about. - (input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - (input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). ### @insiderfinance/totalfinance/valuation#sumOfYearsDigitsDepreciation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Sum-of-years'-digits charge in `period`: `(cost − salvage) · remainingLife / Σ digits`. ```typescript export declare function sumOfYearsDigitsDepreciation(input: DepreciationInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): DepreciationInput; default: not declared - (input).cost: number; default: not declared — Acquisition cost (positive). - (input).period: number; default: not declared — 1-based period being asked about. - (input).salvageValue: number; default: not declared — Salvage (residual) value at the end of useful life; 0 ≤ salvage < cost. - (input).usefulLifePeriods: number; default: not declared — Useful life in whole periods (≥ 1). ### @insiderfinance/totalfinance/valuation#terminalValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The terminal value AT the end of the forecast horizon (not yet discounted to the valuation date): perpetual growth `terminalCashFlow × (1 + g) / (r − g)`, or the exit multiple `terminalMetricAmount × exitMultiple`. ```typescript export declare function terminalValue(input: TerminalValueInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): TerminalValueInput; default: not declared - (input).annualDiscountRate: number; default: not declared — Annual discount rate (decimal). Perpetual growth requires it to EXCEED the growth rate. - (input).terminalValueMethod: TerminalValueMethod; default: not declared ### @insiderfinance/totalfinance/valuation#weightedAverageCostOfCapital Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market-value weighted average of the supplied component costs. Weights are normalized from the market values and REPORTED; a zero or negative total capital base is refused — there is no average over nothing. Tax shields are explicit: hand this function the after-tax cost of debt (see {@link afterTaxCostOfDebt}), it never applies a tax rate itself. ```typescript export declare function weightedAverageCostOfCapital(input: WeightedAverageCostOfCapitalInput): WeightedAverageCostOfCapitalResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): WeightedAverageCostOfCapitalInput; default: not declared - (input).components: readonly CapitalComponent[]; default: not declared - return.assumptions: { componentCount: number; weightBasis: 'market values, normalized to sum to one'; }; default: not declared - return.assumptions.componentCount: number; default: not declared - return.assumptions.weightBasis: 'market values, normalized to sum to one'; default: not declared - return.components: { label: string; marketValue: number; weight: number; annualCostOfCapital: number; contribution: number; }[]; default: not declared — Normalized weights, echoed per component — they sum to one by construction. - return.diagnostics: { warnings: string[]; }; default: not declared - return.diagnostics.warnings: string[]; default: not declared - return.totalCapital: number | null; default: not declared — `null` when the summed capital base exceeds `Number.MAX_VALUE` — the WEIGHTS and the average are still exact (computed in scaled space), but the raw total itself has no IEEE-754 representation; `totalCapitalAbsentReason` says so (2026-08-23 review wave). - return.totalCapitalAbsentReason?: string; default: not declared - return.weightedAverageCostOfCapital: number; default: not declared ### @insiderfinance/totalfinance/valuation#ymToDiaLevel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Approximate DIA level corresponding to the supplied YM level and reference prices. Assumes the proportional mapping holds; not a quote, forecast, fair value or hedge ratio. No fixed ratio, contract multiplier or tick rounding. Caller owns reference comparability. ```typescript export declare const ymToDiaLevel: { (input: YmToDiaLevelInput): number; explain: (input: YmToDiaLevelInput) => Computed>; }; ``` Example (source JSDoc): ymToDiaLevel({ ymPriceLevel: 40400, referenceYmPrice: 40000, referenceDiaPrice: 398 }); // ≈ 401.98 Members/parameters (default = JSDoc only; not declared means no documented default): - (input): YmToDiaLevelInput; default: not declared - (input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - (input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - (input).ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. - explain: (input: YmToDiaLevelInput) => Computed>; default: not declared — Same calculation with original coordinates, named units and mapping limitations. - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): YmToDiaLevelInput; default: not declared - explain(input).referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - explain(input).referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - explain(input).ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. ## Entrypoint @insiderfinance/totalfinance/valuation/cash-flows ### @insiderfinance/totalfinance/valuation/cash-flows#AmortizationRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AmortizationRow`. ### @insiderfinance/totalfinance/valuation/cash-flows#AmortizationScheduleInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AmortizationScheduleInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#AmortizationScheduleResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AmortizationScheduleResult`. ### @insiderfinance/totalfinance/valuation/cash-flows#DatedCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DatedCashFlow`. ### @insiderfinance/totalfinance/valuation/cash-flows#DatedInternalRateOfReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DatedInternalRateOfReturnInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#DatedNetPresentValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DatedNetPresentValueInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#DecliningBalanceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DecliningBalanceInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#DepreciationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DepreciationInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#DiscountCashFlowsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountCashFlowsInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#DiscountedCashFlowRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowRow`. ### @insiderfinance/totalfinance/valuation/cash-flows#DiscountedPaybackInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedPaybackInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#EffectiveAnnualRateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#EffectiveAnnualRateInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#EquivalentAnnualAnnuityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#EquivalentAnnualAnnuityInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#EquivalentInterestRateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#EquivalentInterestRateInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#FutureValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#FutureValueInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#InternalRateOfReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#InternalRateOfReturnInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#InternalRateOfReturnReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#InternalRateOfReturnReport`. ### @insiderfinance/totalfinance/valuation/cash-flows#InternalRateRoot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#InternalRateRoot`. ### @insiderfinance/totalfinance/valuation/cash-flows#LoanNumberOfPeriodsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LoanNumberOfPeriodsInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#LoanPeriodInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LoanPeriodInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#LoanPeriodicInterestRateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LoanPeriodicInterestRateInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#LoanRangeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LoanRangeInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#LoanTermsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LoanTermsInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#ModifiedInternalRateOfReturnInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ModifiedInternalRateOfReturnInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#NetPresentValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#NetPresentValueInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#NominalAnnualRateInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#NominalAnnualRateInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#PaybackInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#PaybackInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#PaymentTiming Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#PaymentTiming`. ### @insiderfinance/totalfinance/valuation/cash-flows#PresentValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#PresentValueInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#ProfitabilityIndexInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProfitabilityIndexInput`. ### @insiderfinance/totalfinance/valuation/cash-flows#TimedCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#TimedCashFlow`. ### @insiderfinance/totalfinance/valuation/cash-flows#amortizationSchedule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#amortizationSchedule`. ### @insiderfinance/totalfinance/valuation/cash-flows#annuityPayment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#annuityPayment`. ### @insiderfinance/totalfinance/valuation/cash-flows#cumulativeLoanInterest Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#cumulativeLoanInterest`. ### @insiderfinance/totalfinance/valuation/cash-flows#cumulativeLoanPrincipal Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#cumulativeLoanPrincipal`. ### @insiderfinance/totalfinance/valuation/cash-flows#datedInternalRateOfReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#datedInternalRateOfReturn`. ### @insiderfinance/totalfinance/valuation/cash-flows#datedNetPresentValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#datedNetPresentValue`. ### @insiderfinance/totalfinance/valuation/cash-flows#decliningBalanceDepreciation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#decliningBalanceDepreciation`. ### @insiderfinance/totalfinance/valuation/cash-flows#discountCashFlows Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#discountCashFlows`. ### @insiderfinance/totalfinance/valuation/cash-flows#discountedPaybackPeriod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#discountedPaybackPeriod`. ### @insiderfinance/totalfinance/valuation/cash-flows#doubleDecliningBalanceDepreciation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#doubleDecliningBalanceDepreciation`. ### @insiderfinance/totalfinance/valuation/cash-flows#effectiveAnnualRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#effectiveAnnualRate`. ### @insiderfinance/totalfinance/valuation/cash-flows#equivalentAnnualAnnuity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#equivalentAnnualAnnuity`. ### @insiderfinance/totalfinance/valuation/cash-flows#equivalentInterestRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#equivalentInterestRate`. ### @insiderfinance/totalfinance/valuation/cash-flows#futureValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#futureValue`. ### @insiderfinance/totalfinance/valuation/cash-flows#internalRateOfReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#internalRateOfReturn`. ### @insiderfinance/totalfinance/valuation/cash-flows#loanInterestPayment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#loanInterestPayment`. ### @insiderfinance/totalfinance/valuation/cash-flows#loanNumberOfPeriods Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#loanNumberOfPeriods`. ### @insiderfinance/totalfinance/valuation/cash-flows#loanPeriodicInterestRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#loanPeriodicInterestRate`. ### @insiderfinance/totalfinance/valuation/cash-flows#loanPrincipalPayment Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#loanPrincipalPayment`. ### @insiderfinance/totalfinance/valuation/cash-flows#modifiedInternalRateOfReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#modifiedInternalRateOfReturn`. ### @insiderfinance/totalfinance/valuation/cash-flows#netPresentValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#netPresentValue`. ### @insiderfinance/totalfinance/valuation/cash-flows#nominalAnnualRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#nominalAnnualRate`. ### @insiderfinance/totalfinance/valuation/cash-flows#paybackPeriod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#paybackPeriod`. ### @insiderfinance/totalfinance/valuation/cash-flows#presentValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#presentValue`. ### @insiderfinance/totalfinance/valuation/cash-flows#profitabilityIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#profitabilityIndex`. ### @insiderfinance/totalfinance/valuation/cash-flows#requireCompoundingWhenPresent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#requireCompoundingWhenPresent`. ### @insiderfinance/totalfinance/valuation/cash-flows#requireDayCountWhenPresent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#requireDayCountWhenPresent`. ### @insiderfinance/totalfinance/valuation/cash-flows#straightLineDepreciation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#straightLineDepreciation`. ### @insiderfinance/totalfinance/valuation/cash-flows#sumOfYearsDigitsDepreciation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#sumOfYearsDigitsDepreciation`. ## Entrypoint @insiderfinance/totalfinance/valuation/corporate ### @insiderfinance/totalfinance/valuation/corporate#AdjustedPresentValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AdjustedPresentValueInput`. ### @insiderfinance/totalfinance/valuation/corporate#AdjustedPresentValueResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AdjustedPresentValueResult`. ### @insiderfinance/totalfinance/valuation/corporate#AfterTaxCostOfDebtInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AfterTaxCostOfDebtInput`. ### @insiderfinance/totalfinance/valuation/corporate#CapitalAssetPricingInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#CapitalAssetPricingInput`. ### @insiderfinance/totalfinance/valuation/corporate#CapitalComponent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#CapitalComponent`. ### @insiderfinance/totalfinance/valuation/corporate#ComparableAggregation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparableAggregation`. ### @insiderfinance/totalfinance/valuation/corporate#ComparableCompanyValuationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparableCompanyValuationInput`. ### @insiderfinance/totalfinance/valuation/corporate#ComparableCompanyValuationResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparableCompanyValuationResult`. ### @insiderfinance/totalfinance/valuation/corporate#ComparableOutlierPolicy Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparableOutlierPolicy`. ### @insiderfinance/totalfinance/valuation/corporate#ComparablePeer Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparablePeer`. ### @insiderfinance/totalfinance/valuation/corporate#ComparablePeerExcluded Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparablePeerExcluded`. ### @insiderfinance/totalfinance/valuation/corporate#ComparablePeerUsed Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparablePeerUsed`. ### @insiderfinance/totalfinance/valuation/corporate#ComparableValuationBasis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ComparableValuationBasis`. ### @insiderfinance/totalfinance/valuation/corporate#CostOfEquityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#CostOfEquityInput`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedCashFlowAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowAssumptions`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedCashFlowCommonResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowCommonResult`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedCashFlowDiagnostics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowDiagnostics`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedCashFlowInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowInput`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedCashFlowResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowResult`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedCashFlowScenario Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowScenario`. ### @insiderfinance/totalfinance/valuation/corporate#DiscountedProjectedCashFlowRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedProjectedCashFlowRow`. ### @insiderfinance/totalfinance/valuation/corporate#DividendDiscountInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DividendDiscountInput`. ### @insiderfinance/totalfinance/valuation/corporate#DividendDiscountResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DividendDiscountResult`. ### @insiderfinance/totalfinance/valuation/corporate#EnterpriseToEquityBridge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#EnterpriseToEquityBridge`. ### @insiderfinance/totalfinance/valuation/corporate#EnterpriseToEquityValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#EnterpriseToEquityValueInput`. ### @insiderfinance/totalfinance/valuation/corporate#FinancingSideEffect Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#FinancingSideEffect`. ### @insiderfinance/totalfinance/valuation/corporate#FinancingSideEffectValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#FinancingSideEffectValue`. ### @insiderfinance/totalfinance/valuation/corporate#FreeCashFlowToEquityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#FreeCashFlowToEquityInput`. ### @insiderfinance/totalfinance/valuation/corporate#FreeCashFlowToFirmInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#FreeCashFlowToFirmInput`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutAnalysisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutAnalysisInput`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutAnalysisResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutAnalysisResult`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutAnnualScheduleRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutAnnualScheduleRow`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutDebtScheduleRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutDebtScheduleRow`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutDebtTrancheInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutDebtTrancheInput`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutExitBridge Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutExitBridge`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutExitInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutExitInput`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutOperatingYearInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutOperatingYearInput`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutSourcesAndUses Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutSourcesAndUses`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutSourcesInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutSourcesInput`. ### @insiderfinance/totalfinance/valuation/corporate#LeveragedBuyoutTransactionInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#LeveragedBuyoutTransactionInput`. ### @insiderfinance/totalfinance/valuation/corporate#MarginalDistribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#MarginalDistribution`. ### @insiderfinance/totalfinance/valuation/corporate#ProbabilisticDiscountedCashFlowInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProbabilisticDiscountedCashFlowInput`. ### @insiderfinance/totalfinance/valuation/corporate#ProbabilisticDiscountedCashFlowResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProbabilisticDiscountedCashFlowResult`. ### @insiderfinance/totalfinance/valuation/corporate#ProjectedCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProjectedCashFlow`. ### @insiderfinance/totalfinance/valuation/corporate#ProjectedCashFlowSchedule Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProjectedCashFlowSchedule`. ### @insiderfinance/totalfinance/valuation/corporate#RandomizedVariable Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#RandomizedVariable`. ### @insiderfinance/totalfinance/valuation/corporate#ResidualIncomeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ResidualIncomeInput`. ### @insiderfinance/totalfinance/valuation/corporate#ResidualIncomeProjection Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ResidualIncomeProjection`. ### @insiderfinance/totalfinance/valuation/corporate#ResidualIncomeResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ResidualIncomeResult`. ### @insiderfinance/totalfinance/valuation/corporate#ReverseDiscountedCashFlowInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ReverseDiscountedCashFlowInput`. ### @insiderfinance/totalfinance/valuation/corporate#ReverseDiscountedCashFlowResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ReverseDiscountedCashFlowResult`. ### @insiderfinance/totalfinance/valuation/corporate#ReverseDiscountedCashFlowTarget Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ReverseDiscountedCashFlowTarget`. ### @insiderfinance/totalfinance/valuation/corporate#ScenarioAnalysisInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ScenarioAnalysisInput`. ### @insiderfinance/totalfinance/valuation/corporate#ScenarioAnalysisResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ScenarioAnalysisResult`. ### @insiderfinance/totalfinance/valuation/corporate#SensitivityAxis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#SensitivityAxis`. ### @insiderfinance/totalfinance/valuation/corporate#SensitivityTableInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#SensitivityTableInput`. ### @insiderfinance/totalfinance/valuation/corporate#SensitivityTableResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#SensitivityTableResult`. ### @insiderfinance/totalfinance/valuation/corporate#TerminalValueInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#TerminalValueInput`. ### @insiderfinance/totalfinance/valuation/corporate#TerminalValueMethod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#TerminalValueMethod`. ### @insiderfinance/totalfinance/valuation/corporate#ValuationProvenance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ValuationProvenance`. ### @insiderfinance/totalfinance/valuation/corporate#WeightedAverageCostOfCapitalInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#WeightedAverageCostOfCapitalInput`. ### @insiderfinance/totalfinance/valuation/corporate#WeightedAverageCostOfCapitalResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#WeightedAverageCostOfCapitalResult`. ### @insiderfinance/totalfinance/valuation/corporate#adjustedPresentValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#adjustedPresentValue`. ### @insiderfinance/totalfinance/valuation/corporate#afterTaxCostOfDebt Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#afterTaxCostOfDebt`. ### @insiderfinance/totalfinance/valuation/corporate#capitalAssetPricingExpectedReturn Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#capitalAssetPricingExpectedReturn`. ### @insiderfinance/totalfinance/valuation/corporate#comparableCompanyValuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#comparableCompanyValuation`. ### @insiderfinance/totalfinance/valuation/corporate#costOfEquity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#costOfEquity`. ### @insiderfinance/totalfinance/valuation/corporate#discountedCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#discountedCashFlow`. ### @insiderfinance/totalfinance/valuation/corporate#discountedCashFlowScenarioAnalysis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#discountedCashFlowScenarioAnalysis`. ### @insiderfinance/totalfinance/valuation/corporate#discountedCashFlowSensitivityTable Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#discountedCashFlowSensitivityTable`. ### @insiderfinance/totalfinance/valuation/corporate#dividendDiscountValuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#dividendDiscountValuation`. ### @insiderfinance/totalfinance/valuation/corporate#enterpriseToEquityValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#enterpriseToEquityValue`. ### @insiderfinance/totalfinance/valuation/corporate#freeCashFlowToEquity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#freeCashFlowToEquity`. ### @insiderfinance/totalfinance/valuation/corporate#freeCashFlowToFirm Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#freeCashFlowToFirm`. ### @insiderfinance/totalfinance/valuation/corporate#leveragedBuyoutAnalysis Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#leveragedBuyoutAnalysis`. ### @insiderfinance/totalfinance/valuation/corporate#probabilisticDiscountedCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#probabilisticDiscountedCashFlow`. ### @insiderfinance/totalfinance/valuation/corporate#residualIncomeValuation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#residualIncomeValuation`. ### @insiderfinance/totalfinance/valuation/corporate#reverseDiscountedCashFlow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#reverseDiscountedCashFlow`. ### @insiderfinance/totalfinance/valuation/corporate#terminalValue Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#terminalValue`. ### @insiderfinance/totalfinance/valuation/corporate#weightedAverageCostOfCapital Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#weightedAverageCostOfCapital`. ## Entrypoint @insiderfinance/totalfinance/valuation/forecasting ### @insiderfinance/totalfinance/valuation/forecasting#AmountDriver Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#AmountDriver`. ### @insiderfinance/totalfinance/valuation/forecasting#DiscountedCashFlowFromStatementsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowFromStatementsInput`. ### @insiderfinance/totalfinance/valuation/forecasting#DiscountedCashFlowFromStatementsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiscountedCashFlowFromStatementsResult`. ### @insiderfinance/totalfinance/valuation/forecasting#OperatingForecastInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#OperatingForecastInput`. ### @insiderfinance/totalfinance/valuation/forecasting#OperatingForecastPeriod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#OperatingForecastPeriod`. ### @insiderfinance/totalfinance/valuation/forecasting#OperatingForecastResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#OperatingForecastResult`. ### @insiderfinance/totalfinance/valuation/forecasting#OperatingForecastRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#OperatingForecastRow`. ### @insiderfinance/totalfinance/valuation/forecasting#ProjectStatementsInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProjectStatementsInput`. ### @insiderfinance/totalfinance/valuation/forecasting#ProjectStatementsResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProjectStatementsResult`. ### @insiderfinance/totalfinance/valuation/forecasting#ProjectedStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ProjectedStatements`. ### @insiderfinance/totalfinance/valuation/forecasting#RevenueDriver Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#RevenueDriver`. ### @insiderfinance/totalfinance/valuation/forecasting#StatementProjectionPeriod Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#StatementProjectionPeriod`. ### @insiderfinance/totalfinance/valuation/forecasting#discountedCashFlowFromStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#discountedCashFlowFromStatements`. ### @insiderfinance/totalfinance/valuation/forecasting#operatingForecast Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#operatingForecast`. ### @insiderfinance/totalfinance/valuation/forecasting#projectFinancialStatements Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#projectFinancialStatements`. ## Entrypoint @insiderfinance/totalfinance/valuation/price-levels ### @insiderfinance/totalfinance/valuation/price-levels#ConvertPriceLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ConvertPriceLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#DiaToDjiaLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiaToDjiaLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#DiaToYmLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DiaToYmLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#DjiaToDiaLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#DjiaToDiaLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#EsToSpyLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#EsToSpyLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#IwmToRtyLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#IwmToRtyLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#IwmToRutLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#IwmToRutLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#NamedPriceLevelConversionAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#NamedPriceLevelConversionAssumptions`. ### @insiderfinance/totalfinance/valuation/price-levels#NdxToQqqLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#NdxToQqqLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#NqToQqqLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#NqToQqqLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#PriceLevelConversionAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#PriceLevelConversionAssumptions`. ### @insiderfinance/totalfinance/valuation/price-levels#PriceLevelCoordinates Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#PriceLevelCoordinates`. ### @insiderfinance/totalfinance/valuation/price-levels#QqqToNdxLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#QqqToNdxLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#QqqToNqLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#QqqToNqLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#RatioPriceLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#RatioPriceLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#ReferencePriceLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ReferencePriceLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#RtyToIwmLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#RtyToIwmLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#RutToIwmLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#RutToIwmLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#SpxToSpyLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#SpxToSpyLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#SpyToEsLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#SpyToEsLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#SpyToSpxLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#SpyToSpxLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#YmToDiaLevelInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#YmToDiaLevelInput`. ### @insiderfinance/totalfinance/valuation/price-levels#convertPriceLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#convertPriceLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#diaToDjiaLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#diaToDjiaLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#diaToYmLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#diaToYmLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#djiaToDiaLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#djiaToDiaLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#esToSpyLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#esToSpyLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#iwmToRtyLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#iwmToRtyLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#iwmToRutLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#iwmToRutLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#ndxToQqqLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ndxToQqqLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#nqToQqqLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#nqToQqqLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#qqqToNdxLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#qqqToNdxLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#qqqToNqLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#qqqToNqLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#rtyToIwmLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#rtyToIwmLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#rutToIwmLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#rutToIwmLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#spxToSpyLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#spxToSpyLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#spyToEsLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#spyToEsLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#spyToSpxLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#spyToSpxLevel`. ### @insiderfinance/totalfinance/valuation/price-levels#ymToDiaLevel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/valuation#ymToDiaLevel`. ## Entrypoint @insiderfinance/totalfinance/valuation/schemas ### @insiderfinance/totalfinance/valuation/schemas#ConvertPriceLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed request schema for {@link convertPriceLevel }; select exactly one explicit method. ```typescript export declare const ConvertPriceLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => ConvertPriceLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => ConvertPriceLevelInput; default: not declared - parse().return.method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - parse().return.referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - parse().return.referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - parse().return.sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - parse().return.sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - parse().return.targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - parse().return.targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: ConvertPriceLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: ConvertPriceLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: ConvertPriceLevelInput; default: not declared - ~standard.types.output.method: ('ratio') | ('reference-prices'); default: not declared — Use `sourcePriceLevel * referenceTargetPrice / referenceSourcePrice`. Use `sourcePriceLevel * targetPricePerSourcePrice`. - ~standard.types.output.referenceSourcePrice: number; default: not declared — Finite price > 0 in `sourcePriceUnit`; the reference denominator. - ~standard.types.output.referenceTargetPrice: number; default: not declared — Finite price > 0 in `targetPriceUnit`; caller owns comparability and freshness. - ~standard.types.output.sourcePriceLevel: number; default: not declared — Finite nonnegative level in `sourcePriceUnit`; zero maps to zero. - ~standard.types.output.sourcePriceUnit?: string | undefined; default: not declared — Optional descriptive label, e.g. 'ES index points'; nonblank when supplied. No unit inference. - ~standard.types.output.targetPricePerSourcePrice: number; default: not declared — Finite ratio > 0: target price units per ONE source price unit, never the reciprocal. - ~standard.types.output.targetPriceUnit?: string | undefined; default: not declared — Optional descriptive result-unit label, e.g. 'USD per SPY share'; nonblank when supplied. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: ConvertPriceLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#DiaToDjiaLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link diaToDjiaLevel }; never fetches or assumes reference prices. ```typescript export declare const DiaToDjiaLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => DiaToDjiaLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => DiaToDjiaLevelInput; default: not declared - parse().return.diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - parse().return.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - parse().return.referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: DiaToDjiaLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: DiaToDjiaLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: DiaToDjiaLevelInput; default: not declared - ~standard.types.output.diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - ~standard.types.output.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - ~standard.types.output.referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: DiaToDjiaLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#DiaToYmLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link diaToYmLevel }; never fetches or assumes reference prices. ```typescript export declare const DiaToYmLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => DiaToYmLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => DiaToYmLevelInput; default: not declared - parse().return.diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - parse().return.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - parse().return.referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: DiaToYmLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: DiaToYmLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: DiaToYmLevelInput; default: not declared - ~standard.types.output.diaPriceLevel: number; default: not declared — Requested level in USD per DIA share; finite and nonnegative. - ~standard.types.output.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - ~standard.types.output.referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: DiaToYmLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#DjiaToDiaLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link djiaToDiaLevel }; never fetches or assumes reference prices. ```typescript export declare const DjiaToDiaLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => DjiaToDiaLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => DjiaToDiaLevelInput; default: not declared - parse().return.djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - parse().return.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - parse().return.referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: DjiaToDiaLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: DjiaToDiaLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: DjiaToDiaLevelInput; default: not declared - ~standard.types.output.djiaPriceLevel: number; default: not declared — Requested level in DJIA index points (full Dow Jones Industrial Average); finite and nonnegative. - ~standard.types.output.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - ~standard.types.output.referenceDjiaPrice: number; default: not declared — Comparable reference in DJIA index points (full Dow Jones Industrial Average); finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: DjiaToDiaLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#EsToSpyLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link esToSpyLevel }; never fetches or assumes reference prices. ```typescript export declare const EsToSpyLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => EsToSpyLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => EsToSpyLevelInput; default: not declared - parse().return.esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - parse().return.referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - parse().return.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: EsToSpyLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: EsToSpyLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: EsToSpyLevelInput; default: not declared - ~standard.types.output.esPriceLevel: number; default: not declared — Requested level in ES index points; finite and nonnegative. - ~standard.types.output.referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - ~standard.types.output.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: EsToSpyLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#IwmToRtyLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link iwmToRtyLevel }; never fetches or assumes reference prices. ```typescript export declare const IwmToRtyLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => IwmToRtyLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => IwmToRtyLevelInput; default: not declared - parse().return.iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - parse().return.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - parse().return.referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: IwmToRtyLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: IwmToRtyLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: IwmToRtyLevelInput; default: not declared - ~standard.types.output.iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - ~standard.types.output.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - ~standard.types.output.referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: IwmToRtyLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#IwmToRutLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link iwmToRutLevel }; never fetches or assumes reference prices. ```typescript export declare const IwmToRutLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => IwmToRutLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => IwmToRutLevelInput; default: not declared - parse().return.iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - parse().return.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - parse().return.referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: IwmToRutLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: IwmToRutLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: IwmToRutLevelInput; default: not declared - ~standard.types.output.iwmPriceLevel: number; default: not declared — Requested level in USD per IWM share; finite and nonnegative. - ~standard.types.output.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - ~standard.types.output.referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: IwmToRutLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#NdxToQqqLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link ndxToQqqLevel }; never fetches or assumes reference prices. ```typescript export declare const NdxToQqqLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => NdxToQqqLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => NdxToQqqLevelInput; default: not declared - parse().return.ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - parse().return.referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - parse().return.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: NdxToQqqLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: NdxToQqqLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: NdxToQqqLevelInput; default: not declared - ~standard.types.output.ndxPriceLevel: number; default: not declared — Requested level in NDX index points; finite and nonnegative. - ~standard.types.output.referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - ~standard.types.output.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: NdxToQqqLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#NqToQqqLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link nqToQqqLevel }; never fetches or assumes reference prices. ```typescript export declare const NqToQqqLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => NqToQqqLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => NqToQqqLevelInput; default: not declared - parse().return.nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - parse().return.referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - parse().return.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: NqToQqqLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: NqToQqqLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: NqToQqqLevelInput; default: not declared - ~standard.types.output.nqPriceLevel: number; default: not declared — Requested level in NQ index points; finite and nonnegative. - ~standard.types.output.referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - ~standard.types.output.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: NqToQqqLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#QqqToNdxLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link qqqToNdxLevel }; never fetches or assumes reference prices. ```typescript export declare const QqqToNdxLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => QqqToNdxLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => QqqToNdxLevelInput; default: not declared - parse().return.qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - parse().return.referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - parse().return.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: QqqToNdxLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: QqqToNdxLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: QqqToNdxLevelInput; default: not declared - ~standard.types.output.qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - ~standard.types.output.referenceNdxPrice: number; default: not declared — Comparable reference in NDX index points; finite and positive. - ~standard.types.output.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: QqqToNdxLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#QqqToNqLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link qqqToNqLevel }; never fetches or assumes reference prices. ```typescript export declare const QqqToNqLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => QqqToNqLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => QqqToNqLevelInput; default: not declared - parse().return.qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - parse().return.referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - parse().return.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: QqqToNqLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: QqqToNqLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: QqqToNqLevelInput; default: not declared - ~standard.types.output.qqqPriceLevel: number; default: not declared — Requested level in USD per QQQ share; finite and nonnegative. - ~standard.types.output.referenceNqPrice: number; default: not declared — Comparable reference in NQ index points; finite and positive. - ~standard.types.output.referenceQqqPrice: number; default: not declared — Comparable reference in USD per QQQ share; finite and positive. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: QqqToNqLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#RtyToIwmLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link rtyToIwmLevel }; never fetches or assumes reference prices. ```typescript export declare const RtyToIwmLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => RtyToIwmLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => RtyToIwmLevelInput; default: not declared - parse().return.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - parse().return.referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - parse().return.rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: RtyToIwmLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: RtyToIwmLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: RtyToIwmLevelInput; default: not declared - ~standard.types.output.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - ~standard.types.output.referenceRtyPrice: number; default: not declared — Comparable reference in RTY index points; finite and positive. - ~standard.types.output.rtyPriceLevel: number; default: not declared — Requested level in RTY index points; finite and nonnegative. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: RtyToIwmLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#RutToIwmLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link rutToIwmLevel }; never fetches or assumes reference prices. ```typescript export declare const RutToIwmLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => RutToIwmLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => RutToIwmLevelInput; default: not declared - parse().return.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - parse().return.referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - parse().return.rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: RutToIwmLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: RutToIwmLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: RutToIwmLevelInput; default: not declared - ~standard.types.output.referenceIwmPrice: number; default: not declared — Comparable reference in USD per IWM share; finite and positive. - ~standard.types.output.referenceRutPrice: number; default: not declared — Comparable reference in RUT index points; finite and positive. - ~standard.types.output.rutPriceLevel: number; default: not declared — Requested level in RUT index points; finite and nonnegative. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: RutToIwmLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#SpxToSpyLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link spxToSpyLevel }; never fetches or assumes reference prices. ```typescript export declare const SpxToSpyLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => SpxToSpyLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => SpxToSpyLevelInput; default: not declared - parse().return.referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - parse().return.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - parse().return.spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: SpxToSpyLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: SpxToSpyLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: SpxToSpyLevelInput; default: not declared - ~standard.types.output.referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - ~standard.types.output.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - ~standard.types.output.spxPriceLevel: number; default: not declared — Requested level in SPX index points; finite and nonnegative. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: SpxToSpyLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#SpyToEsLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link spyToEsLevel }; never fetches or assumes reference prices. ```typescript export declare const SpyToEsLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => SpyToEsLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => SpyToEsLevelInput; default: not declared - parse().return.referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - parse().return.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - parse().return.spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: SpyToEsLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: SpyToEsLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: SpyToEsLevelInput; default: not declared - ~standard.types.output.referenceEsPrice: number; default: not declared — Comparable reference in ES index points; finite and positive. - ~standard.types.output.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - ~standard.types.output.spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: SpyToEsLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#SpyToSpxLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link spyToSpxLevel }; never fetches or assumes reference prices. ```typescript export declare const SpyToSpxLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => SpyToSpxLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => SpyToSpxLevelInput; default: not declared - parse().return.referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - parse().return.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - parse().return.spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: SpyToSpxLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: SpyToSpxLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: SpyToSpxLevelInput; default: not declared - ~standard.types.output.referenceSpxPrice: number; default: not declared — Comparable reference in SPX index points; finite and positive. - ~standard.types.output.referenceSpyPrice: number; default: not declared — Comparable reference in USD per SPY share; finite and positive. - ~standard.types.output.spyPriceLevel: number; default: not declared — Requested level in USD per SPY share; finite and nonnegative. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: SpyToSpxLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ### @insiderfinance/totalfinance/valuation/schemas#YmToDiaLevelInputSchema Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Closed three-price request for {@link ymToDiaLevel }; never fetches or assumes reference prices. ```typescript export declare const YmToDiaLevelInputSchema: Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (description: string) => Schema; default: not declared - describe(description): string; default: not declared - isOptional: boolean; default: not declared - kind: string; default: not declared - optional: () => Schema; default: not declared - optional().return.describe: (description: string) => Schema; default: not declared - optional().return.isOptional: boolean; default: not declared - optional().return.kind: string; default: not declared - optional().return.optional: () => Schema; default: not declared - optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => YmToDiaLevelInput | undefined; default: not declared - optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => YmToDiaLevelInput; default: not declared - parse().return.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - parse().return.referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - parse().return.ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. - parse(input): unknown; default: not declared - parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - safeParse().return.data: YmToDiaLevelInput; default: not declared - safeParse().return.error: import('@insiderfinance/totalfinance/core').InputError; default: not declared - safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - safeParse().return.success: (false) | (true); default: not declared - safeParse(input): unknown; default: not declared - safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.$id?: string; default: not declared - toJSONSchema().return.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.$id?: string; default: not declared - toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - toJSONSchema().return.additionalProperties.description?: string; default: not declared - toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.additionalProperties.format?: string; default: not declared - toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - toJSONSchema().return.additionalProperties.title?: string; default: not declared - toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.const?: unknown; default: not declared - toJSONSchema().return.default?: unknown; default: not declared - toJSONSchema().return.description?: string; default: not declared - toJSONSchema().return.enum?: unknown[]; default: not declared - toJSONSchema().return.exclusiveMaximum?: number; default: not declared - toJSONSchema().return.exclusiveMinimum?: number; default: not declared - toJSONSchema().return.format?: string; default: not declared - toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - toJSONSchema().return.maxItems?: number; default: not declared - toJSONSchema().return.maxLength?: number; default: not declared - toJSONSchema().return.maximum?: number; default: not declared - toJSONSchema().return.minItems?: number; default: not declared - toJSONSchema().return.minLength?: number; default: not declared - toJSONSchema().return.minimum?: number; default: not declared - toJSONSchema().return.multipleOf?: number; default: not declared - toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - toJSONSchema().return.pattern?: string; default: not declared - toJSONSchema().return.properties?: Record; default: not declared - toJSONSchema().return.required?: string[]; default: not declared - toJSONSchema().return.title?: string; default: not declared - toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - ~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - ~standard.types?: ({ readonly input: unknown; readonly output: YmToDiaLevelInput; }) | undefined; default: not declared - ~standard.types.input: unknown; default: not declared - ~standard.types.output: YmToDiaLevelInput; default: not declared - ~standard.types.output.referenceDiaPrice: number; default: not declared — Comparable reference in USD per DIA share; finite and positive. - ~standard.types.output.referenceYmPrice: number; default: not declared — Comparable reference in YM index points; finite and positive. - ~standard.types.output.ymPriceLevel: number; default: not declared — Requested level in YM index points; finite and nonnegative. - ~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - ~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - ~standard.validate().return.value: YmToDiaLevelInput; default: not declared - ~standard.validate(value): unknown; default: not declared - ~standard.vendor: string; default: not declared - ~standard.version: 1; default: not declared ## Entrypoint @insiderfinance/totalfinance/volatility ### @insiderfinance/totalfinance/volatility#ArbitrageCheckOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Combined knobs for reports that deliberately run both checks. ```typescript /** Combined knobs for reports that deliberately run both checks. */ export interface ArbitrageCheckOptions extends ButterflyCheckOptions, CalendarCheckOptions { } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). ### @insiderfinance/totalfinance/volatility#ArbitrageKind Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ArbitrageKind = 'calendar' | 'butterfly'; ``` ### @insiderfinance/totalfinance/volatility#ArbitrageReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ArbitrageReport { /** True when no calendar or butterfly violation was found. */ arbitrageFree: boolean; violations: ArbitrageViolation[]; /** Per-check pass/fail summary. */ checks: { calendar: boolean; butterfly: boolean; }; /** Applied conventions/knobs, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; tolerance: number; butterflyPoints: number; calendarPoints: number; step: number; }; /** Structured warnings (carried-through surface warnings live here); always present. */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - assumptions: { butterflyPoints: number; calendarPoints: number; conventionsVersion: string; step: number; tolerance: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - assumptions.butterflyPoints: number; default: not declared - assumptions.calendarPoints: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.step: number; default: not declared - assumptions.tolerance: number; default: not declared - checks: { butterfly: boolean; calendar: boolean; }; default: not declared — Per-check pass/fail summary. - checks.butterfly: boolean; default: not declared - checks.calendar: boolean; default: not declared - diagnostics: Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - violations: ArbitrageViolation[]; default: not declared ### @insiderfinance/totalfinance/volatility#ArbitrageSlice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A single expiry slice, as the arbitrage checks see it. ```typescript /** A single expiry slice, as the arbitrage checks see it. */ export interface ArbitrageSlice { expiry: string; /** Time to expiry in years. */ timeToExpiryYears: number; /** Forward price `S·e^{(r−q)t}`. */ forward: number; /** Implied volatility at an absolute strike. */ impliedVolatility: (strike: number) => number; /** Fitted strike range `[Kmin, Kmax]`. */ strikeRange: [ number, number ]; /** * The slice's actual strike ladder, when known. Used ONLY to size the DEFAULT scan grids: the * checks then sample at least {@link SAMPLES_PER_STRIKE_GAP} points per adjacent-strike gap, so a * violation planted at a single strike cannot hide between two scan points (an explicit * `butterflyPoints`/`calendarPoints` still wins). Omitted ⇒ the fixed 40/21-point defaults. */ strikes?: readonly number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - forward: number; default: not declared — Forward price `S·e^{(r−q)t}`. - impliedVolatility: (strike: number) => number; default: not declared — Implied volatility at an absolute strike. - impliedVolatility(strike): number; default: not declared - strikeRange: [number, number]; default: not declared — Fitted strike range `[Kmin, Kmax]`. - strikes?: readonly number[]; default: not declared — The slice's actual strike ladder, when known. Used ONLY to size the DEFAULT scan grids: the checks then sample at least {@link SAMPLES_PER_STRIKE_GAP} points per adjacent-strike gap, so a violation planted at a single strike cannot hide between two scan points (an explicit `butterflyPoints`/`calendarPoints` still wins). Omitted ⇒ the fixed 40/21-point defaults. - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#ArbitrageViolation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ArbitrageViolation { kind: ArbitrageKind; /** The expiry where the breach occurs (the later expiry for a calendar breach). */ expiry: string; /** Approximate strike of the worst breach. */ strike: number; /** Forward log-moneyness of the worst breach. */ logMoneyness: number; /** Severity: the total-variance drop (calendar) or the most-negative `g(k)` (butterfly). */ magnitude: number; message: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared — The expiry where the breach occurs (the later expiry for a calendar breach). - kind: ArbitrageKind; default: not declared - logMoneyness: number; default: not declared — Forward log-moneyness of the worst breach. - magnitude: number; default: not declared — Severity: the total-variance drop (calendar) or the most-negative `g(k)` (butterfly). - message: string; default: not declared - strike: number; default: not declared — Approximate strike of the worst breach. ### @insiderfinance/totalfinance/volatility#AtmTermPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AtmTermPoint { expiry: string; timeToExpiryYears: number; atmImpliedVolatility: number; /** ATM total variance `σ_atm²·t` — the calendar-arbitrage axis (must be non-decreasing in `t`). */ atmTotalVariance: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmImpliedVolatility: number; default: not declared - atmTotalVariance: number; default: not declared — ATM total variance `σ_atm²·t` — the calendar-arbitrage axis (must be non-decreasing in `t`). - expiry: string; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#AtmTermStructure Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface AtmTermStructure { points: AtmTermPoint[]; /** Whether ATM total variance is non-decreasing across maturities (calendar-arbitrage-free ATM). */ calendarMonotone: boolean; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; coordinate: 'atm-total-variance'; }; /** Structured warnings; a non-monotone ATM structure discloses itself here. */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; coordinate: 'atm-total-variance'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.coordinate: 'atm-total-variance'; default: not declared - calendarMonotone: boolean; default: not declared — Whether ATM total variance is non-decreasing across maturities (calendar-arbitrage-free ATM). - diagnostics: Diagnostics; default: not declared — Structured warnings; a non-monotone ATM structure discloses itself here. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - points: AtmTermPoint[]; default: not declared ### @insiderfinance/totalfinance/volatility#AtmVolatilityPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One point on the ATM-vol term structure. ```typescript /** One point on the ATM-vol term structure. */ export interface AtmVolatilityPoint { /** ISO expiry date → `t` computed from `asOf` (ACT/365F). */ expiry: string; /** Annualized ATM implied vol (decimal). */ atmVolatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared — Annualized ATM implied vol (decimal). - expiry: string; default: not declared — ISO expiry date → `t` computed from `asOf` (ACT/365F). ### @insiderfinance/totalfinance/volatility#ButterflyCheckOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Knobs used only by the butterfly-density scan. ```typescript /** Knobs used only by the butterfly-density scan. */ export interface ButterflyCheckOptions { /** Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). */ butterflyPoints?: number; /** Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). */ step?: number; /** Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). ### @insiderfinance/totalfinance/volatility#CalendarCheckOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Knobs used only by the calendar total-variance scan. ```typescript /** Knobs used only by the calendar total-variance scan. */ export interface CalendarCheckOptions { /** Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). */ calendarPoints?: number; /** Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). ### @insiderfinance/totalfinance/volatility#CalendarSkewAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `calendarSkew.explain` echoes: the sorted expiry pair and the canonical step. ```typescript /** The conventions `calendarSkew.explain` echoes: the sorted expiry pair and the canonical step. */ export interface CalendarSkewAssumptions { conventionsVersion: string; /** The nearer of the two requested expiries after resolution (ascending in time). */ nearExpiry: string; /** The farther of the two requested expiries after resolution. */ farExpiry: string; nearTimeToExpiryYears: number; farTimeToExpiryYears: number; /** The canonical central-difference step in log-moneyness (fixed — ledger H22). */ logMoneynessStep: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - farExpiry: string; default: not declared — The farther of the two requested expiries after resolution. - farTimeToExpiryYears: number; default: not declared - logMoneynessStep: number; default: not declared — The canonical central-difference step in log-moneyness (fixed — ledger H22). - nearExpiry: string; default: not declared — The nearer of the two requested expiries after resolution (ascending in time). - nearTimeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#CalendarSkewFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalendarSkewFacade = ((surface: VolatilitySurface, from: string | number, to: string | number) => number) & { explain: (surface: VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: CalendarSkewAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (from): string | number; default: not declared - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - (to): string | number; default: not declared - explain: (surface: VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: CalendarSkewAssumptions; }; default: not declared - explain().return.assumptions: CalendarSkewAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(from): string | number; default: not declared - explain(surface): VolatilitySurface; default: not declared - explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - explain(surface).diagnostics: Diagnostics; default: not declared - explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - explain(to): string | number; default: not declared ### @insiderfinance/totalfinance/volatility#CalibratedEvent Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One calibrated past event. ```typescript /** One calibrated past event. */ export interface CalibratedEvent extends EventMoveObservation { /** `realizedMove − impliedMove`. */ error: number; /** `impliedMove > realizedMove` — the straddle seller won. */ overpriced: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date?: string; default: not declared — Optional label (e.g. the event date). - error: number; default: not declared — `realizedMove − impliedMove`. - impliedMove: number; default: not declared — Straddle-implied move BEFORE the event (fraction of spot), > 0. - overpriced: boolean; default: not declared — `impliedMove > realizedMove` — the straddle seller won. - realizedMove: number; default: not declared — Realized |move| AFTER the event (fraction of spot), ≥ 0. ### @insiderfinance/totalfinance/volatility#CalibratedSwaptionNode Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A calibrated `(expiry, tenor)` node. ```typescript /** A calibrated `(expiry, tenor)` node. */ export interface CalibratedSwaptionNode { expiryYears: number; tenorYears: number; forward: number; parameters: SabrParameters; /** SABR vol at `strike = forward`. */ atmVolatility: number; rmse: number; converged: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared — SABR vol at `strike = forward`. - converged: boolean; default: not declared - expiryYears: number; default: not declared - forward: number; default: not declared - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - rmse: number; default: not declared - tenorYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#DupireOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DupireOptions`. ### @insiderfinance/totalfinance/volatility#ESSVIArbitrage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). No-arbitrage diagnosis of an eSSVI surface. ```typescript /** No-arbitrage diagnosis of an eSSVI surface. */ export interface ESSVIArbitrage { /** No calendar-spread arbitrage — `w(k, t)` non-decreasing in `t` at every grid `k` (the definition). */ calendarArbitrageFree: boolean; /** No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every grid maturity. */ butterflyArbitrageFree: boolean; /** The minimum Gatheral `g(k)` over the grid and maturities (`≥ 0` ⇔ butterfly-free). */ minButterflyG: number; /** Minimum `Δw` between adjacent maturities over the grid (`≥ 0` ⇔ calendar-free). */ minCalendarSlope: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every grid maturity. - calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage — `w(k, t)` non-decreasing in `t` at every grid `k` (the definition). - minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and maturities (`≥ 0` ⇔ butterfly-free). - minCalendarSlope: number; default: not declared — Minimum `Δw` between adjacent maturities over the grid (`≥ 0` ⇔ calendar-free). ### @insiderfinance/totalfinance/volatility#ESSVICalibration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link calibrateEssvi}. ```typescript /** Result of {@link calibrateEssvi}. */ export interface ESSVICalibration { parameters: ESSVIParameters; /** Root-mean-square total-variance error across all points. */ rmse: number; perSliceRmse: Array<{ timeToExpiryYears: number; rmse: number; }>; /** The fitted skew term structure — the payoff of eSSVI over global-ρ SSVI. */ rhoTerm: Array<{ timeToExpiryYears: number; rho: number; }>; arbitrage: ESSVIArbitrage; converged: boolean; assumptions: { conventionsVersion: string; phi: 'power-law' | 'heston'; skew: 'per-maturity'; weight: 'uniform' | 'vega'; /** Whether the search began from a caller-supplied start or the internal global-SSVI warm start. */ initialParameters: 'supplied' | 'ssvi-warm-start'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - arbitrage: ESSVIArbitrage; default: not declared - arbitrage.butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every grid maturity. - arbitrage.calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage — `w(k, t)` non-decreasing in `t` at every grid `k` (the definition). - arbitrage.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and maturities (`≥ 0` ⇔ butterfly-free). - arbitrage.minCalendarSlope: number; default: not declared — Minimum `Δw` between adjacent maturities over the grid (`≥ 0` ⇔ calendar-free). - assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'ssvi-warm-start'; phi: 'power-law' | 'heston'; skew: 'per-maturity'; weight: 'uniform' | 'vega'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.initialParameters: 'supplied' | 'ssvi-warm-start'; default: not declared — Whether the search began from a caller-supplied start or the internal global-SSVI warm start. - assumptions.phi: 'power-law' | 'heston'; default: not declared - assumptions.skew: 'per-maturity'; default: not declared - assumptions.weight: 'vega' | 'uniform'; default: not declared - converged: boolean; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - parameters: ESSVIParameters; default: not declared - parameters.phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - parameters.phi.eta: number; default: not declared - parameters.phi.gamma: number; default: not declared - parameters.phi.kind: ('heston') | ('power-law'); default: not declared - parameters.phi.lambda: number; default: not declared - parameters.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - rhoTerm: { timeToExpiryYears: number; rho: number; }[]; default: not declared — The fitted skew term structure — the payoff of eSSVI over global-ρ SSVI. - rmse: number; default: not declared — Root-mean-square total-variance error across all points. ### @insiderfinance/totalfinance/volatility#ESSVICalibrationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link calibrateEssvi}. ```typescript /** Input for {@link calibrateEssvi}. */ export interface ESSVICalibrationInput { slices: ESSVISliceInput[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - slices: SSVISliceInput[]; default: not declared ### @insiderfinance/totalfinance/volatility#ESSVICalibrationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link calibrateEssvi}. ```typescript /** Options for {@link calibrateEssvi}. */ export interface ESSVICalibrationOptions { /** Curvature family; default `'power-law'`. */ phi?: 'power-law' | 'heston'; /** * Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each * point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit. Threaded * through the SSVI warm-start too. */ weight?: 'uniform' | 'vega'; /** Outer-search iteration budget (default 2,000, maximum 10,000). */ maximumIterations?: number; /** Outer-search tolerance (default 1e-12). */ tolerance?: number; /** * Warm start (Stage 4.5): a scalar `rho` broadcasts to every maturity knot, an array must match * the slice count; `phi.kind` must equal the calibration's `phi` family. A supplied start REPLACES * the internal SSVI warm start (echoed in `assumptions.initialParameters`). */ initialParameters?: { rho: number | number[]; phi: SSVIPhi; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - initialParameters?: { phi: SSVIPhi; rho: number | number[]; }; default: not declared — Warm start (Stage 4.5): a scalar `rho` broadcasts to every maturity knot, an array must match the slice count; `phi.kind` must equal the calibration's `phi` family. A supplied start REPLACES the internal SSVI warm start (echoed in `assumptions.initialParameters`). - initialParameters.phi: SSVIPhi; default: not declared - initialParameters.phi.eta: number; default: not declared - initialParameters.phi.gamma: number; default: not declared - initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - initialParameters.phi.lambda: number; default: not declared - initialParameters.rho: number | number[]; default: not declared - maximumIterations?: number; default: not declared — Outer-search iteration budget (default 2,000, maximum 10,000). - phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit. Threaded through the SSVI warm-start too. ### @insiderfinance/totalfinance/volatility#ESSVIParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calibrated eSSVI surface parameters — SSVI with a per-maturity skew. ```typescript /** Calibrated eSSVI surface parameters — SSVI with a per-maturity skew. */ export interface ESSVIParameters { /** Curvature function (global), same family as SSVI. */ phi: SSVIPhi; /** Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. */ thetaTerm: Array<{ timeToExpiryYears: number; theta: number; rho: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - phi.eta: number; default: not declared - phi.gamma: number; default: not declared - phi.kind: ('heston') | ('power-law'); default: not declared - phi.lambda: number; default: not declared - thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. ### @insiderfinance/totalfinance/volatility#ESSVISliceInput Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One maturity slice of the market surface (same shape as SSVI's). ```typescript /** One maturity slice of the market surface (same shape as SSVI's). */ export type ESSVISliceInput = SSVISliceInput; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility?: number[]; default: not declared — Implied volatilities aligned to `k` (converted to `w = iv²·t`). Provide this or `w`. - k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - timeToExpiryYears: number; default: not declared — Maturity in years. - w?: number[]; default: not declared — Total variance `σ²·t` aligned to `k`. Provide this or `iv`. ### @insiderfinance/totalfinance/volatility#EventMoveCalibration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The straddle-implied vs realized-move calibration. ```typescript /** The straddle-implied vs realized-move calibration. */ export interface EventMoveCalibration { count: number; averageImplied: number; averageRealized: number; /** `averageRealized / averageImplied` — > 1 ⇒ the stock moves MORE than the straddle prices. */ ratio: number; /** Fraction of events where implied > realized (how often selling the straddle won). */ overpricedFraction: number; /** Mean `realized − implied` — positive ⇒ straddles underpriced on average. */ bias: number; /** Mean `|realized − implied|`. */ meanAbsoluteError: number; perEvent: CalibratedEvent[]; assumptions: { conventionsVersion: string; method: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.method: string; default: not declared - averageImplied: number; default: not declared - averageRealized: number; default: not declared - bias: number; default: not declared — Mean `realized − implied` — positive ⇒ straddles underpriced on average. - count: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - meanAbsoluteError: number; default: not declared — Mean `|realized − implied|`. - overpricedFraction: number; default: not declared — Fraction of events where implied > realized (how often selling the straddle won). - perEvent: CalibratedEvent[]; default: not declared - ratio: number; default: not declared — `averageRealized / averageImplied` — > 1 ⇒ the stock moves MORE than the straddle prices. ### @insiderfinance/totalfinance/volatility#EventMoveObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One past event: the straddle-implied move before it and the realized move after. ```typescript /** One past event: the straddle-implied move before it and the realized move after. */ export interface EventMoveObservation { /** Straddle-implied move BEFORE the event (fraction of spot), > 0. */ impliedMove: number; /** Realized |move| AFTER the event (fraction of spot), ≥ 0. */ realizedMove: number; /** Optional label (e.g. the event date). */ date?: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - date?: string; default: not declared — Optional label (e.g. the event date). - impliedMove: number; default: not declared — Straddle-implied move BEFORE the event (fraction of spot), > 0. - realizedMove: number; default: not declared — Realized |move| AFTER the event (fraction of spot), ≥ 0. ### @insiderfinance/totalfinance/volatility#EventVolatilityAtExpiryResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EventVolatilityAtExpiryResult { /** The model ATM volatilities, aligned to `input.expiries`. */ values: number[]; rows: EventVolatilityAtExpiryRow[]; assumptions: { conventionsVersion: string; method: 'additive-event-variance'; eventDate: string; asOf: EpochMs; baseVolatility: number; eventMove: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: EpochMs; baseVolatility: number; conventionsVersion: string; eventDate: string; eventMove: number; method: 'additive-event-variance'; }; default: not declared - assumptions.asOf: number; default: not declared - assumptions.baseVolatility: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.eventDate: string; default: not declared - assumptions.eventMove: number; default: not declared - assumptions.method: 'additive-event-variance'; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - rows: EventVolatilityAtExpiryRow[]; default: not declared - values: number[]; default: not declared — The model ATM volatilities, aligned to `input.expiries`. ### @insiderfinance/totalfinance/volatility#EventVolatilityAtExpiryRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One evaluated expiry of {@link eventVolatilityAtExpiry}. ```typescript /** One evaluated expiry of {@link eventVolatilityAtExpiry}. */ export interface EventVolatilityAtExpiryRow { expiry: string; daysToExpiry: number; timeToExpiryYears: number; spansEvent: boolean; /** The model's annualized ATM volatility at this expiry. */ value: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysToExpiry: number; default: not declared - expiry: string; default: not declared - spansEvent: boolean; default: not declared - timeToExpiryYears: number; default: not declared - value: number; default: not declared — The model's annualized ATM volatility at this expiry. ### @insiderfinance/totalfinance/volatility#EventVolatilityCalibration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The event-vol fit. ```typescript /** The event-vol fit. */ export interface EventVolatilityCalibration { /** Annualized continuous (non-event) vol `√σ_base²`. */ baseVolatility: number; /** `σ_base²` — the fitted continuous variance itself (exact; `baseVolatility` is its root). */ baseVariance: number; /** Implied event move as a fraction of spot (`J`) — the "earnings move" (`spot·J` in price units). */ eventMove: number; /** `J²` — the discrete event variance. */ eventVariance: number; daysToEvent: number; perExpiry: FittedExpiry[]; /** Fit quality on total variance (1 = perfect). */ rSquared: number; assumptions: { conventionsVersion: string; method: string; eventDate: string; /** The valuation instant the maturities were measured from (epoch ms) — what {@link eventVolatilityAtExpiry} evaluates against. */ asOf: EpochMs; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { asOf: EpochMs; conventionsVersion: string; eventDate: string; method: string; }; default: not declared - assumptions.asOf: number; default: not declared — The valuation instant the maturities were measured from (epoch ms) — what {@link eventVolatilityAtExpiry} evaluates against. - assumptions.conventionsVersion: string; default: not declared - assumptions.eventDate: string; default: not declared - assumptions.method: string; default: not declared - baseVariance: number; default: not declared — `σ_base²` — the fitted continuous variance itself (exact; `baseVolatility` is its root). - baseVolatility: number; default: not declared — Annualized continuous (non-event) vol `√σ_base²`. - daysToEvent: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - eventMove: number; default: not declared — Implied event move as a fraction of spot (`J`) — the "earnings move" (`spot·J` in price units). - eventVariance: number; default: not declared — `J²` — the discrete event variance. - perExpiry: FittedExpiry[]; default: not declared - rSquared: number; default: not declared — Fit quality on total variance (1 = perfect). ### @insiderfinance/totalfinance/volatility#EventVolatilityDecomposition Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface EventVolatilityDecomposition { /** Total variance over the tenor `σ_atm²·t`. */ totalVariance: number; /** Continuous (non-event) variance over the tenor `σ_base²·t`. */ baseVariance: number; /** Variance attributed to the discrete event `σ_atm²·t − σ_base²·t` (clamped ≥ 0). */ eventVariance: number; /** Implied one-event move as a fraction of spot, `√(eventVariance)` — the earnings/event jump size. */ eventMove: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; timeToExpiryYears: number; method: 'additive-event-variance'; }; /** Structured warnings; a clamped (base > total) decomposition explains itself here. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'additive-event-variance'; timeToExpiryYears: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'additive-event-variance'; default: not declared - assumptions.timeToExpiryYears: number; default: not declared - baseVariance: number; default: not declared — Continuous (non-event) variance over the tenor `σ_base²·t`. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a clamped (base > total) decomposition explains itself here. - diagnostics.warnings: QuantWarning[]; default: not declared - eventMove: number; default: not declared — Implied one-event move as a fraction of spot, `√(eventVariance)` — the earnings/event jump size. - eventVariance: number; default: not declared — Variance attributed to the discrete event `σ_atm²·t − σ_base²·t` (clamped ≥ 0). - totalVariance: number; default: not declared — Total variance over the tenor `σ_atm²·t`. ### @insiderfinance/totalfinance/volatility#ExpectedMove Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ExpectedMove { /** One standard-deviation move in price units: `spot · σ · √t`. */ oneSigma: number; /** One-σ move as a fraction of spot: `σ · √t`. */ oneSigmaFraction: number; /** Expected absolute move `E|S_t − S_0| = oneSigma · √(2/π)` (≈ the ATM straddle price). */ expectedAbsolute: number; /** Spot − oneSigma. */ lower: number; /** Spot + oneSigma. */ upper: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expectedAbsolute: number; default: not declared — Expected absolute move `E|S_t − S_0| = oneSigma · √(2/π)` (≈ the ATM straddle price). - lower: number; default: not declared — Spot − oneSigma. - oneSigma: number; default: not declared — One standard-deviation move in price units: `spot · σ · √t`. - oneSigmaFraction: number; default: not declared — One-σ move as a fraction of spot: `σ · √t`. - upper: number; default: not declared — Spot + oneSigma. ### @insiderfinance/totalfinance/volatility#ExpectedMoveImpliedVolatilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link expectedMoveFromImpliedVolatility}. ```typescript /** Input for {@link expectedMoveFromImpliedVolatility}. */ export interface ExpectedMoveImpliedVolatilityInput { spot: number; /** Implied volatility (annualized decimal) — the one volatility vocabulary across the library. */ impliedVolatility: number; /** Time to expiry in years. */ timeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility: number; default: not declared — Implied volatility (annualized decimal) — the one volatility vocabulary across the library. - spot: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#ExpectedMoveStraddleInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link expectedMoveFromStraddle}. ```typescript /** * Expected move implied by the ATM straddle price. The ATM-forward straddle ≈ `E|move|` * (= `oneSigma · √(2/π)`), so `oneSigma = straddlePrice / √(2/π) ≈ 1.2533 · straddlePrice`. */ /** Input for {@link expectedMoveFromStraddle}. */ export interface ExpectedMoveStraddleInput { spot: number; /** The ATM straddle mid-price (call + put at the spot strike). */ straddlePrice: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - spot: number; default: not declared - straddlePrice: number; default: not declared — The ATM straddle mid-price (call + put at the spot strike). ### @insiderfinance/totalfinance/volatility#ExpiryTailRisk Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One expiry's model-free tail-risk moments. ```typescript /** One expiry's model-free tail-risk moments. */ export interface ExpiryTailRisk { expiry: string; daysToExpiry: number; timeToExpiryYears: number; forward: number; /** Risk-neutral skewness of `ln(S_T/F)` (negative for the usual equity put-skew). */ skewness: number; /** Risk-neutral excess kurtosis (`kurtosis − 3`; > 0 ⇒ fat tails). */ excessKurtosis: number; /** `100 − 10·skewness` — the CBOE-style SKEW value (> 100 ⇒ fat left tail). */ skewIndex: number; strikesUsed: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysToExpiry: number; default: not declared - excessKurtosis: number; default: not declared — Risk-neutral excess kurtosis (`kurtosis − 3`; > 0 ⇒ fat tails). - expiry: string; default: not declared - forward: number; default: not declared - skewIndex: number; default: not declared — `100 − 10·skewness` — the CBOE-style SKEW value (> 100 ⇒ fat left tail). - skewness: number; default: not declared — Risk-neutral skewness of `ln(S_T/F)` (negative for the usual equity put-skew). - strikesUsed: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#ExpiryVariance Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One expiry's model-free fair variance/vol. ```typescript /** One expiry's model-free fair variance/vol. */ export interface ExpiryVariance { expiry: string; /** Calendar days to expiry. */ daysToExpiry: number; /** Year fraction (ACT/365F). */ timeToExpiryYears: number; /** Parity forward. */ forward: number; /** Annualized fair variance (decimal). */ variance: number; /** `√variance` — model-free implied vol (decimal, e.g. 0.20). */ fairVolatility: number; /** OTM strikes used in the replication. */ strikesUsed: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysToExpiry: number; default: not declared — Calendar days to expiry. - expiry: string; default: not declared - fairVolatility: number; default: not declared — `√variance` — model-free implied vol (decimal, e.g. 0.20). - forward: number; default: not declared — Parity forward. - strikesUsed: number; default: not declared — OTM strikes used in the replication. - timeToExpiryYears: number; default: not declared — Year fraction (ACT/365F). - variance: number; default: not declared — Annualized fair variance (decimal). ### @insiderfinance/totalfinance/volatility#FitEventVolatilityOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link calibrateEventVolatility}. ```typescript /** Inputs for {@link calibrateEventVolatility}. */ export interface FitEventVolatilityOptions { /** The ATM-vol term structure (≥ 1 expiry; ≥ 2 to fit both `σ_base` and `J`, unless `baseVolatility` given). */ termStructure: readonly AtmVolatilityPoint[]; /** ISO date of the earnings/event. */ eventDate: string; asOf: EpochMs | string; /** Pin the continuous vol when the term structure can't identify it (single expiry / no maturity spread). */ baseVolatility?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - baseVolatility?: number; default: not declared — Pin the continuous vol when the term structure can't identify it (single expiry / no maturity spread). - eventDate: string; default: not declared — ISO date of the earnings/event. - termStructure: readonly AtmVolatilityPoint[]; default: not declared — The ATM-vol term structure (≥ 1 expiry; ≥ 2 to fit both `σ_base` and `J`, unless `baseVolatility` given). ### @insiderfinance/totalfinance/volatility#FittedExpiry Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One expiry's fitted vs actual ATM vol. ```typescript /** One expiry's fitted vs actual ATM vol. */ export interface FittedExpiry { expiry: string; daysToExpiry: number; timeToExpiryYears: number; atmVolatility: number; spansEvent: boolean; /** The model's ATM vol at this expiry. */ fittedVolatility: number; /** `atmVolatility − fittedVolatility`. */ residual: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared - daysToExpiry: number; default: not declared - expiry: string; default: not declared - fittedVolatility: number; default: not declared — The model's ATM vol at this expiry. - residual: number; default: not declared — `atmVolatility − fittedVolatility`. - spansEvent: boolean; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#ForwardSkewAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `forwardSkew.explain` echoes: the sorted expiry pair and the applied step. ```typescript /** The conventions `forwardSkew.explain` echoes: the sorted expiry pair and the applied step. */ export interface ForwardSkewAssumptions { conventionsVersion: string; /** The nearer of the two requested expiries after resolution (ascending in time). */ nearExpiry: string; /** The farther of the two requested expiries after resolution. */ farExpiry: string; nearTimeToExpiryYears: number; farTimeToExpiryYears: number; /** The applied central-difference step in forward log-moneyness (`options.step`, default 0.05). */ step: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - farExpiry: string; default: not declared — The farther of the two requested expiries after resolution. - farTimeToExpiryYears: number; default: not declared - nearExpiry: string; default: not declared — The nearer of the two requested expiries after resolution (ascending in time). - nearTimeToExpiryYears: number; default: not declared - step: number; default: not declared — The applied central-difference step in forward log-moneyness (`options.step`, default 0.05). ### @insiderfinance/totalfinance/volatility#ForwardSkewFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ForwardSkewFacade = ((surface: VolatilitySurface, from: string | number, to: string | number, options?: { step?: number; }) => number) & { explain: (surface: VolatilitySurface, from: string | number, to: string | number, options?: { step?: number; }) => Omit, 'assumptions'> & { assumptions: ForwardSkewAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (from): string | number; default: not declared - (options)?: { step?: number; } | undefined; default: not declared - (options).step?: number; default: not declared - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - (to): string | number; default: not declared - explain: (surface: VolatilitySurface, from: string | number, to: string | number, options?: { step?: number; }) => Omit, 'assumptions'> & { assumptions: ForwardSkewAssumptions; }; default: not declared - explain().return.assumptions: ForwardSkewAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(from): string | number; default: not declared - explain(options)?: { step?: number; } | undefined; default: not declared - explain(options).step?: number; default: not declared - explain(surface): VolatilitySurface; default: not declared - explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - explain(surface).diagnostics: Diagnostics; default: not declared - explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - explain(to): string | number; default: not declared ### @insiderfinance/totalfinance/volatility#ForwardVolatilityAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `forwardVolatility.explain` echoes: the resolved (time-ordered) expiry pair. ```typescript /** The conventions `forwardVolatility.explain` echoes: the resolved (time-ordered) expiry pair. */ export interface ForwardVolatilityAssumptions { conventionsVersion: string; /** The nearer of the two requested expiries after resolution (ascending in time). */ nearExpiry: string; /** The farther of the two requested expiries after resolution. */ farExpiry: string; nearTimeToExpiryYears: number; farTimeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - farExpiry: string; default: not declared — The farther of the two requested expiries after resolution. - farTimeToExpiryYears: number; default: not declared - nearExpiry: string; default: not declared — The nearer of the two requested expiries after resolution (ascending in time). - nearTimeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#ForwardVolatilityFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ForwardVolatilityFacade = ((surface: VolatilitySurface, from: string | number, to: string | number) => number) & { explain: (surface: VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: ForwardVolatilityAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (from): string | number; default: not declared - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - (to): string | number; default: not declared - explain: (surface: VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: ForwardVolatilityAssumptions; }; default: not declared - explain().return.assumptions: ForwardVolatilityAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(from): string | number; default: not declared - explain(surface): VolatilitySurface; default: not declared - explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - explain(surface).diagnostics: Diagnostics; default: not declared - explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - explain(to): string | number; default: not declared ### @insiderfinance/totalfinance/volatility#GarchFit Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A fitted GARCH(1,1) model. `converged`/`iterations` mirror the optimizer result honestly. ```typescript // ───────────────────────────────────── GARCH(1,1) ───────────────────────────────────── /** A fitted GARCH(1,1) model. `converged`/`iterations` mirror the optimizer result honestly. */ export interface GarchFit { /** Constant term of the variance recursion (`> 0`). */ omega: number; /** ARCH coefficient on the lagged squared return (`≥ 0`). */ alpha: number; /** GARCH coefficient on the lagged conditional variance (`≥ 0`). */ beta: number; /** `α + β` — the variance half-life driver; `< 1` for a stationary fit. */ persistence: number; /** Unconditional variance `ω / (1 − α − β)` the forecast mean-reverts to. */ longRunVariance: number; /** Maximized Gaussian log-likelihood; `null` when the likelihood is degenerate (disclosed). */ logLikelihood: number | null; /** Whether the optimizer converged (never fabricated). */ converged: boolean; /** Optimizer iterations performed. */ iterations: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; mean: 'zero' | 'sample'; observations: number; /** Whether the primary start was caller-supplied (`initialParameters`) or the classic (0.05, 0.90). */ initialParameters: 'supplied' | 'default'; }; /** Structured warnings; a degenerate / non-converged fit explains itself here. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - alpha: number; default: not declared — ARCH coefficient on the lagged squared return (`≥ 0`). - assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; mean: 'zero' | 'sample'; observations: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the primary start was caller-supplied (`initialParameters`) or the classic (0.05, 0.90). - assumptions.mean: 'zero' | 'sample'; default: not declared - assumptions.observations: number; default: not declared - beta: number; default: not declared — GARCH coefficient on the lagged conditional variance (`≥ 0`). - converged: boolean; default: not declared — Whether the optimizer converged (never fabricated). - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a degenerate / non-converged fit explains itself here. - diagnostics.warnings: QuantWarning[]; default: not declared - iterations: number; default: not declared — Optimizer iterations performed. - logLikelihood: number | null; default: not declared — Maximized Gaussian log-likelihood; `null` when the likelihood is degenerate (disclosed). - longRunVariance: number; default: not declared — Unconditional variance `ω / (1 − α − β)` the forecast mean-reverts to. - omega: number; default: not declared — Constant term of the variance recursion (`> 0`). - persistence: number; default: not declared — `α + β` — the variance half-life driver; `< 1` for a stationary fit. ### @insiderfinance/totalfinance/volatility#GarchFitOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link fitGarch}. ```typescript /** Options for {@link fitGarch}. */ export interface GarchFitOptions { /** Seed for the deterministic multi-start of the optimizer (default `0x61726368`). */ seed?: number; /** `'zero'` (default) fits second moments about zero; `'sample'` de-means first. A nonzero constant has a positive second moment in zero mode but is degenerate in sample mode. */ mean?: 'zero' | 'sample'; /** * Warm start for the `(α, β)` search (Stage 4.5): replaces the primary `(0.05, 0.90)` start; `ω` * is derived by variance targeting and is not a start. The seeded restarts still run. */ initialParameters?: { alpha: number; beta: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - initialParameters?: { alpha: number; beta: number; }; default: not declared — Warm start for the `(α, β)` search (Stage 4.5): replaces the primary `(0.05, 0.90)` start; `ω` is derived by variance targeting and is not a start. The seeded restarts still run. - initialParameters.alpha: number; default: not declared - initialParameters.beta: number; default: not declared - mean?: 'zero' | 'sample'; default: not declared — `'zero'` (default) fits second moments about zero; `'sample'` de-means first. A nonzero constant has a positive second moment in zero mode but is degenerate in sample mode. - seed?: number; default: not declared — Seed for the deterministic multi-start of the optimizer (default `0x61726368`). ### @insiderfinance/totalfinance/volatility#GarchForecast Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The multi-step variance forecast produced by {@link garchForecast}. ```typescript /** The multi-step variance forecast produced by {@link garchForecast}. */ export interface GarchForecast { /** `σ²ₜ₊ₕ` for `h = 1..horizonPeriods`. */ variancePath: number[]; /** `√σ²ₜ₊ₕ` — the per-period volatility. */ volatilityPath: number[]; /** `√(σ²ₜ₊ₕ · periodsPerYear)` — the annualized volatility. */ annualizedVolatility: number[]; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; periodsPerYear: number; horizonPeriods: number; }; /** Structured warnings; always present (possibly empty). */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualizedVolatility: number[]; default: not declared — `√(σ²ₜ₊ₕ · periodsPerYear)` — the annualized volatility. - assumptions: { conventionsVersion: string; horizonPeriods: number; periodsPerYear: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.horizonPeriods: number; default: not declared - assumptions.periodsPerYear: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - diagnostics.warnings: QuantWarning[]; default: not declared - variancePath: number[]; default: not declared — `σ²ₜ₊ₕ` for `h = 1..horizonPeriods`. - volatilityPath: number[]; default: not declared — `√σ²ₜ₊ₕ` — the per-period volatility. ### @insiderfinance/totalfinance/volatility#GarchForecastOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link garchForecast}. ```typescript /** Options for {@link garchForecast}. */ export interface GarchForecastOptions { /** Periods per year for annualization (default 252 trading days). */ periodsPerYear?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - periodsPerYear?: number; default: not declared — Periods per year for annualization (default 252 trading days). ### @insiderfinance/totalfinance/volatility#HarRvCoefficients Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). OLS coefficients of the HAR-RV regression `RVₜ = const + daily·RVᵈ + weekly·RVʷ + monthly·RVᵐ`. ```typescript // ─────────────────────────────────── HAR-RV (Corsi) ─────────────────────────────────── /** OLS coefficients of the HAR-RV regression `RVₜ = const + daily·RVᵈ + weekly·RVʷ + monthly·RVᵐ`. */ export interface HarRvCoefficients { /** Intercept. */ const: number; /** Loading on the previous day's realized variance. */ daily: number; /** Loading on the trailing weekly-average realized variance. */ weekly: number; /** Loading on the trailing monthly-average realized variance. */ monthly: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - const: number; default: not declared — Intercept. - daily: number; default: not declared — Loading on the previous day's realized variance. - monthly: number; default: not declared — Loading on the trailing monthly-average realized variance. - weekly: number; default: not declared — Loading on the trailing weekly-average realized variance. ### @insiderfinance/totalfinance/volatility#HarRvFit Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A fitted HAR-RV model plus its in-sample fit diagnostics. ```typescript /** A fitted HAR-RV model plus its in-sample fit diagnostics. */ export interface HarRvFit { coefficients: HarRvCoefficients; /** In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). */ rSquared: number | null; /** In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. */ residuals: number[]; /** Number of fitted observations. */ observationCount: number; /** The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). */ windows: { weekly: number; monthly: number; }; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; method: 'ols-qr'; weekly: number; monthly: number; }; /** Structured warnings; a flat response (undefined R²) explains itself here. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.method: 'ols-qr'; default: not declared - assumptions.monthly: number; default: not declared - assumptions.weekly: number; default: not declared - coefficients: HarRvCoefficients; default: not declared - coefficients.const: number; default: not declared — Intercept. - coefficients.daily: number; default: not declared — Loading on the previous day's realized variance. - coefficients.monthly: number; default: not declared — Loading on the trailing monthly-average realized variance. - coefficients.weekly: number; default: not declared — Loading on the trailing weekly-average realized variance. - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - diagnostics.warnings: QuantWarning[]; default: not declared - observationCount: number; default: not declared — Number of fitted observations. - rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - windows.monthly: number; default: not declared - windows.weekly: number; default: not declared ### @insiderfinance/totalfinance/volatility#HarRvForecastAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `harRvForecast.explain` echoes: the fitted windows and the forecast horizon. ```typescript /** The conventions `harRvForecast.explain` echoes: the fitted windows and the forecast horizon. */ export interface HarRvForecastAssumptions { conventionsVersion: string; /** Weekly averaging window in observations (from the fit). */ weekly: number; /** Monthly averaging window in observations (from the fit). */ monthly: number; /** The model forecasts exactly one step ahead. */ horizonKind: 'one-step-ahead'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - conventionsVersion: string; default: not declared - horizonKind: 'one-step-ahead'; default: not declared — The model forecasts exactly one step ahead. - monthly: number; default: not declared — Monthly averaging window in observations (from the fit). - weekly: number; default: not declared — Weekly averaging window in observations (from the fit). ### @insiderfinance/totalfinance/volatility#HarRvForecastFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type HarRvForecastFacade = ((fit: HarRvFit, history: number[]) => number) & { explain: (fit: HarRvFit, history: number[]) => Omit, 'assumptions'> & { assumptions: HarRvForecastAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (fit): HarRvFit; default: not declared - (fit).assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - (fit).assumptions.conventionsVersion: string; default: not declared - (fit).assumptions.method: 'ols-qr'; default: not declared - (fit).assumptions.monthly: number; default: not declared - (fit).assumptions.weekly: number; default: not declared - (fit).coefficients: HarRvCoefficients; default: not declared - (fit).diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - (fit).diagnostics.warnings: QuantWarning[]; default: not declared - (fit).observationCount: number; default: not declared — Number of fitted observations. - (fit).rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - (fit).residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - (fit).windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - (fit).windows.monthly: number; default: not declared - (fit).windows.weekly: number; default: not declared - (history): number[]; default: not declared - explain: (fit: HarRvFit, history: number[]) => Omit, 'assumptions'> & { assumptions: HarRvForecastAssumptions; }; default: not declared - explain().return.assumptions: HarRvForecastAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(fit): HarRvFit; default: not declared - explain(fit).assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - explain(fit).assumptions.conventionsVersion: string; default: not declared - explain(fit).assumptions.method: 'ols-qr'; default: not declared - explain(fit).assumptions.monthly: number; default: not declared - explain(fit).assumptions.weekly: number; default: not declared - explain(fit).coefficients: HarRvCoefficients; default: not declared - explain(fit).diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - explain(fit).diagnostics.warnings: QuantWarning[]; default: not declared - explain(fit).observationCount: number; default: not declared — Number of fitted observations. - explain(fit).rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - explain(fit).residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - explain(fit).windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - explain(fit).windows.monthly: number; default: not declared - explain(fit).windows.weekly: number; default: not declared - explain(history): number[]; default: not declared ### @insiderfinance/totalfinance/volatility#HarRvOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link fitHarRv}. ```typescript /** Options for {@link fitHarRv}. */ export interface HarRvOptions { /** Weekly averaging window in observations (default 5). */ weekly?: number; /** Monthly averaging window in observations (default 22). */ monthly?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - monthly?: number; default: not declared — Monthly averaging window in observations (default 22). - weekly?: number; default: not declared — Weekly averaging window in observations (default 5). ### @insiderfinance/totalfinance/volatility#HestonSurfaceFit Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HestonSurfaceFit { parameters: HestonParameters; /** Root-mean-square IV error across all calibration targets. */ rmse: number; /** The RMSE tolerance the `converged` flag was gated on (echoed for interpretability). */ rmseTolerance: number; converged: boolean; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; targets: number; maximumIterations: number; /** Whether any starting member was caller-supplied (`initialParameters`) or all were data-derived. */ initialParameters: 'supplied' | 'default'; }; /** Structured warnings; always present — a non-converged fit explains itself here. */ diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; maximumIterations: number; targets: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether any starting member was caller-supplied (`initialParameters`) or all were data-derived. - assumptions.maximumIterations: number; default: not declared - assumptions.targets: number; default: not declared - converged: boolean; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present — a non-converged fit explains itself here. - diagnostics.warnings: QuantWarning[]; default: not declared - parameters: HestonParameters; default: not declared - parameters.kappa: number; default: not declared — Mean-reversion speed κ. - parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - parameters.theta: number; default: not declared — Long-run variance θ. - parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - rmse: number; default: not declared — Root-mean-square IV error across all calibration targets. - rmseTolerance: number; default: not declared — The RMSE tolerance the `converged` flag was gated on (echoed for interpretability). ### @insiderfinance/totalfinance/volatility#HestonSurfaceMarket Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The state of the world for {@link calibrateHestonSurface}: spot and the carry rates. ```typescript /** * Calibrate one Heston parameter set to a set of `(strike, t, iv)` targets. Positives are fit in log * space and `ρ` through `tanh`, so the optimizer is unconstrained while the parameters stay valid. */ /** The state of the world for {@link calibrateHestonSurface}: spot and the carry rates. */ export interface HestonSurfaceMarket { spot: number; riskFreeRate: number; dividendYield: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/volatility#HestonSurfaceTarget Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface HestonSurfaceTarget { strike: number; timeToExpiryYears: number; impliedVolatility: number; forward: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - impliedVolatility: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#ImpliedVolatilityStatistics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ImpliedVolatilityStatistics { current: number; /** `null` for a flat history (rank undefined — disclosed via `implied_volatility.flat_history`). */ rank: number | null; percentile: number; min: number; max: number; mean: number; observations: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: number; default: not declared - max: number; default: not declared - mean: number; default: not declared - min: number; default: not declared - observations: number; default: not declared - percentile: number; default: not declared - rank: number | null; default: not declared — `null` for a flat history (rank undefined — disclosed via `implied_volatility.flat_history`). ### @insiderfinance/totalfinance/volatility#LocalVolatilityFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityFunction`. ### @insiderfinance/totalfinance/volatility#LocalVolatilityGridSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityGridSpecification`. ### @insiderfinance/totalfinance/volatility#LocalVolatilityMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityMarket`. ### @insiderfinance/totalfinance/volatility#LocalVolatilitySurface Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface LocalVolatilitySurface { /** Dupire local volatility `σ_loc(level, t)` (level = underlying price, t in years). */ localVolatility(level: number, timeToExpiryYears: number): number; /** * A grid-cached local-volatility function over the given (level, time) knots — bilinearly interpolated and * far cheaper to evaluate inside a Monte-Carlo simulation than the raw finite-difference transform. */ grid(specification: LocalVolatilityGridSpecification): LocalVolatilityFunction; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - grid: (specification: LocalVolatilityGridSpecification) => LocalVolatilityFunction; default: not declared — A grid-cached local-volatility function over the given (level, time) knots — bilinearly interpolated and far cheaper to evaluate inside a Monte-Carlo simulation than the raw finite-difference transform. - grid(specification): LocalVolatilityGridSpecification; default: not declared - grid(specification).levels: number[]; default: not declared — Underlying levels, ascending (e.g. 0.4·S₀ … 2.5·S₀). - grid(specification).times: number[]; default: not declared — Times in years, ascending (e.g. up to the longest expiry priced). - localVolatility: (level: number, timeToExpiryYears: number) => number; default: not declared — Dupire local volatility `σ_loc(level, t)` (level = underlying price, t in years). - localVolatility(level): number; default: not declared - localVolatility(timeToExpiryYears): number; default: not declared ### @insiderfinance/totalfinance/volatility#MinimumVarianceDeltaOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link minimumVarianceDelta}. Provide exactly one of `volatilitySpotBeta` or `skewSlope`. ```typescript /** Inputs for {@link minimumVarianceDelta}. Provide exactly one of `volatilitySpotBeta` or `skewSlope`. */ export interface MinimumVarianceDeltaOptions { type: OptionType; spot: number; strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; riskFreeRate: number; /** The option's implied vol (decimal). */ volatility: number; /** Continuous dividend yield (decimal, default 0). */ dividendYield?: number; /** * ∂σ/∂S directly (decimal vol **per $1 of spot**) — the empirical / minimum-variance β (preferred). * Take it from `estimateVolatilitySpotBeta(...).value.volatilitySpotBeta`, which is already in * these units. `stickyRegime`'s `volatilitySpotBetaPerLogSpot` is ∂σ/∂lnS — `S ×` larger — so * divide it by spot before passing it here, or the smile adjustment is scaled by the spot price. */ volatilitySpotBeta?: number; /** ∂σ/∂ln(K) (`SkewMetrics.skewSlope`) — mapped to β via `regime`. */ skewSlope?: number; /** How `skewSlope` maps to β. Default `'sticky-moneyness'`. */ regime?: 'sticky-strike' | 'sticky-moneyness'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - regime?: 'sticky-strike' | 'sticky-moneyness'; default: not declared — How `skewSlope` maps to β. Default `'sticky-moneyness'`. - riskFreeRate: number; default: not declared - skewSlope?: number; default: not declared — ∂σ/∂ln(K) (`SkewMetrics.skewSlope`) — mapped to β via `regime`. - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - type: OptionType; default: not declared - volatility: number; default: not declared — The option's implied vol (decimal). - volatilitySpotBeta?: number; default: not declared — ∂σ/∂S directly (decimal vol **per $1 of spot**) — the empirical / minimum-variance β (preferred). Take it from `estimateVolatilitySpotBeta(...).value.volatilitySpotBeta`, which is already in these units. `stickyRegime`'s `volatilitySpotBetaPerLogSpot` is ∂σ/∂lnS — `S ×` larger — so divide it by spot before passing it here, or the smile adjustment is scaled by the spot price. ### @insiderfinance/totalfinance/volatility#MinimumVarianceDeltaResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The minimum-variance delta read-out. ```typescript /** The minimum-variance delta read-out. */ export interface MinimumVarianceDeltaResult { /** `Δ_BS + Vega_raw · β` — the hedge ratio. */ minimumVarianceDelta: number; /** The Black-Scholes spot delta `∂V/∂S`. */ blackScholesDelta: number; /** Display vega (per 1% vol) at the option. */ vega: number; /** The `β = ∂σ/∂S` actually used (decimal vol **per $1 of spot**, never per log-spot). */ volatilitySpotBeta: number; /** `minimumVarianceDelta − blackScholesDelta` — the smile adjustment. */ skewAdjustment: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - blackScholesDelta: number; default: not declared — The Black-Scholes spot delta `∂V/∂S`. - minimumVarianceDelta: number; default: not declared — `Δ_BS + Vega_raw · β` — the hedge ratio. - skewAdjustment: number; default: not declared — `minimumVarianceDelta − blackScholesDelta` — the smile adjustment. - vega: number; default: not declared — Display vega (per 1% vol) at the option. - volatilitySpotBeta: number; default: not declared — The `β = ∂σ/∂S` actually used (decimal vol **per $1 of spot**, never per log-spot). ### @insiderfinance/totalfinance/volatility#ObservedSkewAssumptions Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ObservedSkewAssumptions = { spot: number; impliedVolatilitySource: 'provided'; deltaSource: 'provided'; atmMethod: 'nearest-spot-strike-mean'; wingMethod: 'nearest-provided-delta'; smileMethod: 'observed-otm-only'; slopeMethod: 'ols-implied-volatility-vs-moneyness'; /** Lower strike wins equal distances. Same-strike ties use latest timestamp, then delta, IV, OI. */ tieBreak: 'lower-strike-latest-timestamp-delta-implied-volatility-open-interest-input-index'; /** ATM/sample counts retain all rows; smile sides choose one actual row by the tie-break rule. */ duplicatePolicy: 'retain-observations-select-smile-side'; riskReversalConvention: RiskReversalConvention; minimumContracts: number; deltaTolerance: number; tailDeltaTolerance: number; slopeWindow: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmMethod: 'nearest-spot-strike-mean'; default: not declared - deltaSource: 'provided'; default: not declared - deltaTolerance: number; default: not declared - duplicatePolicy: 'retain-observations-select-smile-side'; default: not declared — ATM/sample counts retain all rows; smile sides choose one actual row by the tie-break rule. - impliedVolatilitySource: 'provided'; default: not declared - minimumContracts: number; default: not declared - riskReversalConvention: RiskReversalConvention; default: not declared - slopeMethod: 'ols-implied-volatility-vs-moneyness'; default: not declared - slopeWindow: number; default: not declared - smileMethod: 'observed-otm-only'; default: not declared - spot: number; default: not declared - tailDeltaTolerance: number; default: not declared - tieBreak: 'lower-strike-latest-timestamp-delta-implied-volatility-open-interest-input-index'; default: not declared — Lower strike wins equal distances. Same-strike ties use latest timestamp, then delta, IV, OI. - wingMethod: 'nearest-provided-delta'; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewAtm Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ObservedSkewAtm { strike: number; /** Arithmetic mean of ALL usable observations at the nearest spot strike (decimal IV). */ impliedVolatility: number; observations: ObservedSkewObservation[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility: number; default: not declared — Arithmetic mean of ALL usable observations at the nearest spot strike (decimal IV). - observations: ObservedSkewObservation[]; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Canonical quote plus vendor delta. Records are open to vendor decoration, never mutated. ```typescript /** Canonical quote plus vendor delta. Records are open to vendor decoration, never mutated. */ export interface ObservedSkewConfig { /** Exact expiry label in the chain; no nearest-expiry substitution. */ expiry: string; /** Default callMinusPut. Equity put-skew displays should explicitly select putMinusCall. */ riskReversalConvention?: RiskReversalConvention; /** Minimum IV-bearing quote records before aggregate reads are available; default 6, integer ≥ 1. */ minimumContracts?: number; /** Maximum absolute signed-delta distance from ±0.25; default 0.12, in [0, 1]. */ deltaTolerance?: number; /** Maximum absolute signed-delta distance from ±0.10; default 0.05, in [0, 1]. */ tailDeltaTolerance?: number; /** Symmetric K/spot − 1 window for OLS; default 0.10, in (0, 1]. Needs ≥ 4 OTM points. */ slopeWindow?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deltaTolerance?: number; default: not declared — Maximum absolute signed-delta distance from ±0.25; default 0.12, in [0, 1]. - expiry: string; default: not declared — Exact expiry label in the chain; no nearest-expiry substitution. - minimumContracts?: number; default: not declared — Minimum IV-bearing quote records before aggregate reads are available; default 6, integer ≥ 1. - riskReversalConvention?: RiskReversalConvention; default: not declared — Default callMinusPut. Equity put-skew displays should explicitly select putMinusCall. - slopeWindow?: number; default: not declared — Symmetric K/spot − 1 window for OLS; default 0.10, in (0, 1]. Needs ≥ 4 OTM points. - tailDeltaTolerance?: number; default: not declared — Maximum absolute signed-delta distance from ±0.10; default 0.05, in [0, 1]. ### @insiderfinance/totalfinance/volatility#ObservedSkewInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ObservedSkewInput { quotes: readonly OptionQuote[]; /** No rate, yield, volatility, clock default, or forward inference is used. */ market: Pick; config: ObservedSkewConfig; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - config: ObservedSkewConfig; default: not declared - config.deltaTolerance?: number; default: not declared — Maximum absolute signed-delta distance from ±0.25; default 0.12, in [0, 1]. - config.expiry: string; default: not declared — Exact expiry label in the chain; no nearest-expiry substitution. - config.minimumContracts?: number; default: not declared — Minimum IV-bearing quote records before aggregate reads are available; default 6, integer ≥ 1. - config.riskReversalConvention?: RiskReversalConvention; default: not declared — Default callMinusPut. Equity put-skew displays should explicitly select putMinusCall. - config.slopeWindow?: number; default: not declared — Symmetric K/spot − 1 window for OLS; default 0.10, in (0, 1]. Needs ≥ 4 OTM points. - config.tailDeltaTolerance?: number; default: not declared — Maximum absolute signed-delta distance from ±0.10; default 0.05, in [0, 1]. - market: Pick; default: not declared — No rate, yield, volatility, clock default, or forward inference is used. - market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - market.spot: number; default: not declared - quotes: readonly OptionQuote[]; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ObservedSkewMetrics { expiry: string; expiresAt: number; /** Signed ACT/365F horizon; analytics are unavailable at/after expiry. */ timeToExpiryYears: number; /** Ceiling of positive elapsed 24-hour days to expiry, not trading-day count. */ daysToExpiry: number; underlying: string | null; /** Selected-expiry, non-future, IV-bearing observations (missing delta still counts). */ contractCount: number; /** Non-null gates all aggregate metrics; raw smile observations remain available for inspection. */ unavailableReason: ObservedSkewUnavailableReason | null; atm: ObservedSkewAtm | null; put25Delta: ObservedSkewWing; call25Delta: ObservedSkewWing; put10Delta: ObservedSkewWing; call10Delta: ObservedSkewWing; /** Decimal IV differences, signed per the echoed RR convention. */ riskReversal25Delta: number | null; riskReversal10Delta: number | null; /** Mean of observed wings minus mean ATM, in decimal IV. */ butterfly25Delta: number | null; butterfly10Delta: number | null; /** * OLS d(decimal IV)/d(K/spot − 1), using ≥ 4 observed OTM smile points inside slopeWindow. * Numerically identical to IV percentage points per 1% moneyness; NOT the model skew's log slope. */ skewSlope: number | null; slopePointCount: number; unavailableReasons: { atm: ObservedSkewUnavailableReason | null; riskReversal25Delta: ObservedSkewUnavailableReason | null; riskReversal10Delta: ObservedSkewUnavailableReason | null; butterfly25Delta: ObservedSkewUnavailableReason | null; butterfly10Delta: ObservedSkewUnavailableReason | null; skewSlope: ObservedSkewUnavailableReason | null; }; /** Ascending strikes, with actual side observations for app smile/term-read conversion. */ smile: ObservedSkewSmilePoint[]; excludedQuotes: Array<{ quoteIndex: number; reason: 'other_expiry' | 'future_quote' | 'missing_implied_volatility'; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atm: ObservedSkewAtm | null; default: not declared - atm.impliedVolatility: number; default: not declared — Arithmetic mean of ALL usable observations at the nearest spot strike (decimal IV). - atm.observations: ObservedSkewObservation[]; default: not declared - atm.strike: number; default: not declared - butterfly10Delta: number | null; default: not declared - butterfly25Delta: number | null; default: not declared — Mean of observed wings minus mean ATM, in decimal IV. - call10Delta: ObservedSkewWing; default: not declared - call10Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - call10Delta.selected: ObservedSkewObservation | null; default: not declared - call10Delta.selected.delta: number | null; default: not declared - call10Delta.selected.impliedVolatility: number; default: not declared - call10Delta.selected.openInterest: number | null; default: not declared - call10Delta.selected.quoteIndex: number; default: not declared - call10Delta.selected.strike: number; default: not declared - call10Delta.selected.timestampMs: number; default: not declared - call10Delta.selected.type: 'call' | 'put'; default: not declared - call10Delta.targetDelta: number; default: not declared - call10Delta.tolerance: number; default: not declared - call10Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - call25Delta: ObservedSkewWing; default: not declared - call25Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - call25Delta.selected: ObservedSkewObservation | null; default: not declared - call25Delta.selected.delta: number | null; default: not declared - call25Delta.selected.impliedVolatility: number; default: not declared - call25Delta.selected.openInterest: number | null; default: not declared - call25Delta.selected.quoteIndex: number; default: not declared - call25Delta.selected.strike: number; default: not declared - call25Delta.selected.timestampMs: number; default: not declared - call25Delta.selected.type: 'call' | 'put'; default: not declared - call25Delta.targetDelta: number; default: not declared - call25Delta.tolerance: number; default: not declared - call25Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - contractCount: number; default: not declared — Selected-expiry, non-future, IV-bearing observations (missing delta still counts). - daysToExpiry: number; default: not declared — Ceiling of positive elapsed 24-hour days to expiry, not trading-day count. - excludedQuotes: { quoteIndex: number; reason: 'other_expiry' | 'future_quote' | 'missing_implied_volatility'; }[]; default: not declared - expiresAt: number; default: not declared - expiry: string; default: not declared - put10Delta: ObservedSkewWing; default: not declared - put10Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - put10Delta.selected: ObservedSkewObservation | null; default: not declared - put10Delta.selected.delta: number | null; default: not declared - put10Delta.selected.impliedVolatility: number; default: not declared - put10Delta.selected.openInterest: number | null; default: not declared - put10Delta.selected.quoteIndex: number; default: not declared - put10Delta.selected.strike: number; default: not declared - put10Delta.selected.timestampMs: number; default: not declared - put10Delta.selected.type: 'call' | 'put'; default: not declared - put10Delta.targetDelta: number; default: not declared - put10Delta.tolerance: number; default: not declared - put10Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - put25Delta: ObservedSkewWing; default: not declared - put25Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - put25Delta.selected: ObservedSkewObservation | null; default: not declared - put25Delta.selected.delta: number | null; default: not declared - put25Delta.selected.impliedVolatility: number; default: not declared - put25Delta.selected.openInterest: number | null; default: not declared - put25Delta.selected.quoteIndex: number; default: not declared - put25Delta.selected.strike: number; default: not declared - put25Delta.selected.timestampMs: number; default: not declared - put25Delta.selected.type: 'call' | 'put'; default: not declared - put25Delta.targetDelta: number; default: not declared - put25Delta.tolerance: number; default: not declared - put25Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - riskReversal10Delta: number | null; default: not declared - riskReversal25Delta: number | null; default: not declared — Decimal IV differences, signed per the echoed RR convention. - skewSlope: number | null; default: not declared — OLS d(decimal IV)/d(K/spot − 1), using ≥ 4 observed OTM smile points inside slopeWindow. Numerically identical to IV percentage points per 1% moneyness; NOT the model skew's log slope. - slopePointCount: number; default: not declared - smile: ObservedSkewSmilePoint[]; default: not declared — Ascending strikes, with actual side observations for app smile/term-read conversion. - timeToExpiryYears: number; default: not declared — Signed ACT/365F horizon; analytics are unavailable at/after expiry. - unavailableReason: ObservedSkewUnavailableReason | null; default: not declared — Non-null gates all aggregate metrics; raw smile observations remain available for inspection. - unavailableReasons: { atm: ObservedSkewUnavailableReason | null; riskReversal25Delta: ObservedSkewUnavailableReason | null; riskReversal10Delta: ObservedSkewUnavailableReason | null; butterfly25Delta: ObservedSkewUnavailableReason | null; butterfly10Delta: ObservedSkewUnavailableReason | null; skewSlope: ObservedSkewUnavailableReason | null; }; default: not declared - unavailableReasons.atm: ObservedSkewUnavailableReason | null; default: not declared - unavailableReasons.butterfly10Delta: ObservedSkewUnavailableReason | null; default: not declared - unavailableReasons.butterfly25Delta: ObservedSkewUnavailableReason | null; default: not declared - unavailableReasons.riskReversal10Delta: ObservedSkewUnavailableReason | null; default: not declared - unavailableReasons.riskReversal25Delta: ObservedSkewUnavailableReason | null; default: not declared - unavailableReasons.skewSlope: ObservedSkewUnavailableReason | null; default: not declared - underlying: string | null; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewObservation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). An actual supplied observation. quoteIndex traces back to the original input, not a sorted copy. ```typescript /** An actual supplied observation. quoteIndex traces back to the original input, not a sorted copy. */ export interface ObservedSkewObservation { quoteIndex: number; type: 'call' | 'put'; strike: number; impliedVolatility: number; delta: number | null; openInterest: number | null; timestampMs: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number | null; default: not declared - impliedVolatility: number; default: not declared - openInterest: number | null; default: not declared - quoteIndex: number; default: not declared - strike: number; default: not declared - timestampMs: number; default: not declared - type: 'call' | 'put'; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type ObservedSkewResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.atmMethod: 'nearest-spot-strike-mean'; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.deltaSource: 'provided'; default: not declared - assumptions.deltaTolerance: number; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.duplicatePolicy: 'retain-observations-select-smile-side'; default: not declared — ATM/sample counts retain all rows; smile sides choose one actual row by the tie-break rule. - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.impliedVolatilitySource: 'provided'; default: not declared - assumptions.minimumContracts: number; default: not declared - assumptions.model?: string; default: not declared - assumptions.riskReversalConvention: RiskReversalConvention; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.slopeMethod: 'ols-implied-volatility-vs-moneyness'; default: not declared - assumptions.slopeWindow: number; default: not declared - assumptions.smileMethod: 'observed-otm-only'; default: not declared - assumptions.spot: number; default: not declared - assumptions.tailDeltaTolerance: number; default: not declared - assumptions.tieBreak: 'lower-strike-latest-timestamp-delta-implied-volatility-open-interest-input-index'; default: not declared — Lower strike wins equal distances. Same-strike ties use latest timestamp, then delta, IV, OI. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - assumptions.wingMethod: 'nearest-provided-delta'; default: not declared - diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: ObservedSkewMetrics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.atm: ObservedSkewAtm | null; default: not declared - value.atm.impliedVolatility: number; default: not declared — Arithmetic mean of ALL usable observations at the nearest spot strike (decimal IV). - value.atm.observations: ObservedSkewObservation[]; default: not declared - value.atm.strike: number; default: not declared - value.butterfly10Delta: number | null; default: not declared - value.butterfly25Delta: number | null; default: not declared — Mean of observed wings minus mean ATM, in decimal IV. - value.call10Delta: ObservedSkewWing; default: not declared - value.call10Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - value.call10Delta.selected: ObservedSkewObservation | null; default: not declared - value.call10Delta.selected.delta: number | null; default: not declared - value.call10Delta.selected.impliedVolatility: number; default: not declared - value.call10Delta.selected.openInterest: number | null; default: not declared - value.call10Delta.selected.quoteIndex: number; default: not declared - value.call10Delta.selected.strike: number; default: not declared - value.call10Delta.selected.timestampMs: number; default: not declared - value.call10Delta.selected.type: 'call' | 'put'; default: not declared - value.call10Delta.targetDelta: number; default: not declared - value.call10Delta.tolerance: number; default: not declared - value.call10Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - value.call25Delta: ObservedSkewWing; default: not declared - value.call25Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - value.call25Delta.selected: ObservedSkewObservation | null; default: not declared - value.call25Delta.selected.delta: number | null; default: not declared - value.call25Delta.selected.impliedVolatility: number; default: not declared - value.call25Delta.selected.openInterest: number | null; default: not declared - value.call25Delta.selected.quoteIndex: number; default: not declared - value.call25Delta.selected.strike: number; default: not declared - value.call25Delta.selected.timestampMs: number; default: not declared - value.call25Delta.selected.type: 'call' | 'put'; default: not declared - value.call25Delta.targetDelta: number; default: not declared - value.call25Delta.tolerance: number; default: not declared - value.call25Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - value.contractCount: number; default: not declared — Selected-expiry, non-future, IV-bearing observations (missing delta still counts). - value.daysToExpiry: number; default: not declared — Ceiling of positive elapsed 24-hour days to expiry, not trading-day count. - value.excludedQuotes: { quoteIndex: number; reason: 'other_expiry' | 'future_quote' | 'missing_implied_volatility'; }[]; default: not declared - value.expiresAt: number; default: not declared - value.expiry: string; default: not declared - value.put10Delta: ObservedSkewWing; default: not declared - value.put10Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - value.put10Delta.selected: ObservedSkewObservation | null; default: not declared - value.put10Delta.selected.delta: number | null; default: not declared - value.put10Delta.selected.impliedVolatility: number; default: not declared - value.put10Delta.selected.openInterest: number | null; default: not declared - value.put10Delta.selected.quoteIndex: number; default: not declared - value.put10Delta.selected.strike: number; default: not declared - value.put10Delta.selected.timestampMs: number; default: not declared - value.put10Delta.selected.type: 'call' | 'put'; default: not declared - value.put10Delta.targetDelta: number; default: not declared - value.put10Delta.tolerance: number; default: not declared - value.put10Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - value.put25Delta: ObservedSkewWing; default: not declared - value.put25Delta.nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - value.put25Delta.selected: ObservedSkewObservation | null; default: not declared - value.put25Delta.selected.delta: number | null; default: not declared - value.put25Delta.selected.impliedVolatility: number; default: not declared - value.put25Delta.selected.openInterest: number | null; default: not declared - value.put25Delta.selected.quoteIndex: number; default: not declared - value.put25Delta.selected.strike: number; default: not declared - value.put25Delta.selected.timestampMs: number; default: not declared - value.put25Delta.selected.type: 'call' | 'put'; default: not declared - value.put25Delta.targetDelta: number; default: not declared - value.put25Delta.tolerance: number; default: not declared - value.put25Delta.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared - value.riskReversal10Delta: number | null; default: not declared - value.riskReversal25Delta: number | null; default: not declared — Decimal IV differences, signed per the echoed RR convention. - value.skewSlope: number | null; default: not declared — OLS d(decimal IV)/d(K/spot − 1), using ≥ 4 observed OTM smile points inside slopeWindow. Numerically identical to IV percentage points per 1% moneyness; NOT the model skew's log slope. - value.slopePointCount: number; default: not declared - value.smile: ObservedSkewSmilePoint[]; default: not declared — Ascending strikes, with actual side observations for app smile/term-read conversion. - value.timeToExpiryYears: number; default: not declared — Signed ACT/365F horizon; analytics are unavailable at/after expiry. - value.unavailableReason: ObservedSkewUnavailableReason | null; default: not declared — Non-null gates all aggregate metrics; raw smile observations remain available for inspection. - value.unavailableReasons: { atm: ObservedSkewUnavailableReason | null; butterfly10Delta: ObservedSkewUnavailableReason | null; butterfly25Delta: ObservedSkewUnavailableReason | null; riskReversal10Delta: ObservedSkewUnavailableReason | null; riskReversal25Delta: ObservedSkewUnavailableReason | null; skewSlope: ObservedSkewUnavailableReason | null; }; default: not declared - value.unavailableReasons.atm: ObservedSkewUnavailableReason | null; default: not declared - value.unavailableReasons.butterfly10Delta: ObservedSkewUnavailableReason | null; default: not declared - value.unavailableReasons.butterfly25Delta: ObservedSkewUnavailableReason | null; default: not declared - value.unavailableReasons.riskReversal10Delta: ObservedSkewUnavailableReason | null; default: not declared - value.unavailableReasons.riskReversal25Delta: ObservedSkewUnavailableReason | null; default: not declared - value.unavailableReasons.skewSlope: ObservedSkewUnavailableReason | null; default: not declared - value.underlying: string | null; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewSmilePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ObservedSkewSmilePoint { strike: number; /** K/spot − 1, NOT log-moneyness. */ moneyness: number; call: ObservedSkewObservation | null; put: ObservedSkewObservation | null; /** Put below spot, call at/above spot; never replaced with an ITM-side quote. Decimal IV. */ otmImpliedVolatility: number | null; otmUnavailableReason: 'missing_otm_side' | null; /** Decimal IV spread to the mean ATM read; unavailable when either input is unavailable. */ impliedVolatilityVsAtm: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - call: ObservedSkewObservation | null; default: not declared - call.delta: number | null; default: not declared - call.impliedVolatility: number; default: not declared - call.openInterest: number | null; default: not declared - call.quoteIndex: number; default: not declared - call.strike: number; default: not declared - call.timestampMs: number; default: not declared - call.type: 'call' | 'put'; default: not declared - impliedVolatilityVsAtm: number | null; default: not declared — Decimal IV spread to the mean ATM read; unavailable when either input is unavailable. - moneyness: number; default: not declared — K/spot − 1, NOT log-moneyness. - otmImpliedVolatility: number | null; default: not declared — Put below spot, call at/above spot; never replaced with an ITM-side quote. Decimal IV. - otmUnavailableReason: 'missing_otm_side' | null; default: not declared - put: ObservedSkewObservation | null; default: not declared - put.delta: number | null; default: not declared - put.impliedVolatility: number; default: not declared - put.openInterest: number | null; default: not declared - put.quoteIndex: number; default: not declared - put.strike: number; default: not declared - put.timestampMs: number; default: not declared - put.type: 'call' | 'put'; default: not declared - strike: number; default: not declared ### @insiderfinance/totalfinance/volatility#ObservedSkewUnavailableReason Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Reasons are data availability, not malformed-input errors (which throw typed InputError). ```typescript /** Reasons are data availability, not malformed-input errors (which throw typed InputError). */ export type ObservedSkewUnavailableReason = 'expiry_not_found' | 'expired' | 'insufficient_contracts' | 'no_usable_implied_volatility' | 'missing_delta' | 'outside_delta_tolerance' | 'missing_wing' | 'missing_otm_side' | 'insufficient_slope_points' | 'degenerate_moneyness' | 'non_finite_result'; ``` ### @insiderfinance/totalfinance/volatility#ObservedSkewWing Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ObservedSkewWing { targetDelta: number; tolerance: number; selected: ObservedSkewObservation | null; /** Distance of the nearest eligible delta, even when rejected by the tolerance gate. */ nearestDeltaDistance: number | null; unavailableReason: ObservedSkewUnavailableReason | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - nearestDeltaDistance: number | null; default: not declared — Distance of the nearest eligible delta, even when rejected by the tolerance gate. - selected: ObservedSkewObservation | null; default: not declared - selected.delta: number | null; default: not declared - selected.impliedVolatility: number; default: not declared - selected.openInterest: number | null; default: not declared - selected.quoteIndex: number; default: not declared - selected.strike: number; default: not declared - selected.timestampMs: number; default: not declared - selected.type: 'call' | 'put'; default: not declared - targetDelta: number; default: not declared - tolerance: number; default: not declared - unavailableReason: ObservedSkewUnavailableReason | null; default: not declared ### @insiderfinance/totalfinance/volatility#ProbabilityInTheMoneyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link probabilityInTheMoney}. ```typescript /** Input for {@link probabilityInTheMoney}. */ export interface ProbabilityInTheMoneyInput { type: OptionType; spot: number; strike: number; /** Time to expiry in years. */ timeToExpiryYears: number; riskFreeRate: number; /** Implied volatility (annualized decimal). */ volatility: number; /** Continuous dividend yield (decimal, default 0). */ dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - riskFreeRate: number; default: not declared - spot: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - type: OptionType; default: not declared - volatility: number; default: not declared — Implied volatility (annualized decimal). ### @insiderfinance/totalfinance/volatility#ProbabilityOfTouchInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link probabilityOfTouch}. ```typescript /** * Risk-neutral probability the underlying TOUCHES `barrier` at any time before `t` (first-passage * probability for geometric Brownian motion with drift `ν = r − q − σ²/2`). Uses the reflection * principle; for a driftless process it reduces to `2·P(S_t beyond barrier)`. */ /** Input for {@link probabilityOfTouch}. */ export interface ProbabilityOfTouchInput { spot: number; barrier: number; /** Time to expiry in years. */ timeToExpiryYears: number; riskFreeRate: number; /** Implied volatility (annualized decimal). */ volatility: number; /** Continuous dividend yield (decimal, default 0). */ dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - barrier: number; default: not declared - dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - riskFreeRate: number; default: not declared - spot: number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. - volatility: number; default: not declared — Implied volatility (annualized decimal). ### @insiderfinance/totalfinance/volatility#RISK_NEUTRAL_ESTIMATE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The standard "this is a risk-neutral model estimate, not a real-world forecast" caveat. ```typescript export declare const RISK_NEUTRAL_ESTIMATE: QuantWarning; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared - context?: Record; default: not declared - message: string; default: not declared - severity: import('@insiderfinance/totalfinance/core').WarningSeverity; default: not declared ### @insiderfinance/totalfinance/volatility#RiskNeutralDistribution Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface RiskNeutralDistribution { /** Risk-neutral PDF at strike `K`: `e^{rT}·∂²C/∂K²` (clamped ≥ 0 — see {@link diagnostics}). */ density(strike: number): number; /** Risk-neutral CDF `P(S_T ≤ K) = 1 + e^{rT}·∂C/∂K`, clamped to [0, 1]. */ cdf(strike: number): number; probabilityBelow(strike: number): number; probabilityAbove(strike: number): number; probabilityBetween(lowerStrike: number, upperStrike: number): number; /** * LIVE disclosure channel for the two places this object silently repairs itself — it accumulates * as the closures are called, so read it AFTER querying (it starts empty): * * • `model.limitation` "negative density clamped" — `∂²C/∂K²` came out negative, which means the * smile is butterfly-arbitrageable there. The clamp keeps `density()` a density; the warning * stops a caller integrating a repaired curve and calling it the market's distribution. * • `model.limitation` "one-sided difference" — a query within `step` of zero, where the centred * difference would price a NEGATIVE strike (which returned `NaN`). */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + e^{rT}·∂C/∂K`, clamped to [0, 1]. - cdf(strike): number; default: not declared - density: (strike: number) => number; default: not declared — Risk-neutral PDF at strike `K`: `e^{rT}·∂²C/∂K²` (clamped ≥ 0 — see {@link diagnostics}). - density(strike): number; default: not declared - diagnostics: Diagnostics; default: not declared — LIVE disclosure channel for the two places this object silently repairs itself — it accumulates as the closures are called, so read it AFTER querying (it starts empty): • `model.limitation` "negative density clamped" — `∂²C/∂K²` came out negative, which means the smile is butterfly-arbitrageable there. The clamp keeps `density()` a density; the warning stops a caller integrating a repaired curve and calling it the market's distribution. • `model.limitation` "one-sided difference" — a query within `step` of zero, where the centred difference would price a NEGATIVE strike (which returned `NaN`). - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - probabilityAbove: (strike: number) => number; default: not declared - probabilityAbove(strike): number; default: not declared - probabilityBelow: (strike: number) => number; default: not declared - probabilityBelow(strike): number; default: not declared - probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared - probabilityBetween(lowerStrike): number; default: not declared - probabilityBetween(upperStrike): number; default: not declared ### @insiderfinance/totalfinance/volatility#RiskNeutralOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── Breeden–Litzenberger risk-neutral distribution ───────────────────────── export interface RiskNeutralOptions { spot: number; /** Time to expiry in years. */ timeToExpiryYears: number; riskFreeRate: number; dividendYield?: number; /** Central-difference step in strike (default `spot · 0.001`). */ step?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - dividendYield?: number; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared - step?: number; default: not declared — Central-difference step in strike (default `spot · 0.001`). - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#RiskReversalButterfly Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The risk-reversal / butterfly decomposition of a smile. ```typescript /** The risk-reversal / butterfly decomposition of a smile. */ export interface RiskReversalButterfly { /** ATM vol (at `K = forward`). */ atmVolatility: number; /** The δ-delta call strike. */ callStrike: number; /** The vol at the call strike. */ callVolatility: number; /** The δ-delta put strike. */ putStrike: number; /** The vol at the put strike. */ putVolatility: number; /** `callVolatility − putVolatility` — the skew (< 0 ⇒ puts bid). */ riskReversal: number; /** `(callVolatility + putVolatility)/2 − atmVolatility` — the curvature (> 0 ⇒ smile). */ butterfly: number; delta: number; assumptions: { conventionsVersion: string; deltaConvention: 'forward'; delta: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.delta: number; default: not declared - assumptions.deltaConvention: 'forward'; default: not declared - atmVolatility: number; default: not declared — ATM vol (at `K = forward`). - butterfly: number; default: not declared — `(callVolatility + putVolatility)/2 − atmVolatility` — the curvature (> 0 ⇒ smile). - callStrike: number; default: not declared — The δ-delta call strike. - callVolatility: number; default: not declared — The vol at the call strike. - delta: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - putStrike: number; default: not declared — The δ-delta put strike. - putVolatility: number; default: not declared — The vol at the put strike. - riskReversal: number; default: not declared — `callVolatility − putVolatility` — the skew (< 0 ⇒ puts bid). ### @insiderfinance/totalfinance/volatility#RiskReversalButterflyInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link riskReversalButterfly}. ```typescript // ─────────────────────────────────────────────────────────────────────────────────────────────── // Forward: smile → (ATM, RR, BF) // ─────────────────────────────────────────────────────────────────────────────────────────────── /** Input for {@link riskReversalButterfly}. */ export interface RiskReversalButterflyInput { /** Forward price of the underlying. */ forward: number; /** Time to expiry in years. */ timeToExpiryYears: number; /** The smile: strike → implied vol (from any fit — SVI, SSVI, volatilitySurface, …). */ smile: (strike: number) => number; /** Delta level for the wings (0.25 = 25-delta). Default 0.25. Must be in `(0, 0.5)`. */ delta?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta?: number; default: not declared — Delta level for the wings (0.25 = 25-delta). Default 0.25. Must be in `(0, 0.5)`. - forward: number; default: not declared — Forward price of the underlying. - smile: (strike: number) => number; default: not declared — The smile: strike → implied vol (from any fit — SVI, SSVI, volatilitySurface, …). - smile(strike): number; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#RiskReversalConvention Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type RiskReversalConvention = 'callMinusPut' | 'putMinusCall'; ``` ### @insiderfinance/totalfinance/volatility#SABRCalibrationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SABRCalibrationOptions { /** Backbone exponent β ∈ [0, 1] (default 0.5). */ beta?: number; /** Hagan expansion to fit against (default `'lognormal'`). */ volatilityType?: SabrVolatilityType; /** LM iteration budget (default 200, maximum 10,000). */ maximumIterations?: number; /** LM tolerance (default 1e-12). */ tolerance?: number; /** * Warm start for the `(α, ρ, ν)` search (Stage 4.5); `β` stays an option and is never fitted. * Replaces the ATM-derived default start. */ initialParameters?: { alpha: number; rho: number; nu: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beta?: number; default: not declared — Backbone exponent β ∈ [0, 1] (default 0.5). - initialParameters?: { alpha: number; nu: number; rho: number; }; default: not declared — Warm start for the `(α, ρ, ν)` search (Stage 4.5); `β` stays an option and is never fitted. Replaces the ATM-derived default start. - initialParameters.alpha: number; default: not declared - initialParameters.nu: number; default: not declared - initialParameters.rho: number; default: not declared - maximumIterations?: number; default: not declared — LM iteration budget (default 200, maximum 10,000). - tolerance?: number; default: not declared — LM tolerance (default 1e-12). - volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion to fit against (default `'lognormal'`). ### @insiderfinance/totalfinance/volatility#SABRCalibrationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SABRCalibrationResult { parameters: SabrParameters; /** Root-mean-square implied-volatility error of the fit. */ rmse: number; converged: boolean; iterations: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; beta: number; volatilityType: SabrVolatilityType; /** Whether the search began from a caller-supplied `initialParameters` or the ATM-derived default. */ initialParameters: 'supplied' | 'default'; }; /** Structured warnings; a non-converged fit explains itself here. */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { beta: number; conventionsVersion: string; initialParameters: 'supplied' | 'default'; volatilityType: SabrVolatilityType; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.beta: number; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the ATM-derived default. - assumptions.volatilityType: SabrVolatilityType; default: not declared - converged: boolean; default: not declared - diagnostics: Diagnostics; default: not declared — Structured warnings; a non-converged fit explains itself here. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - iterations: number; default: not declared - parameters: SabrParameters; default: not declared - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - rmse: number; default: not declared — Root-mean-square implied-volatility error of the fit. ### @insiderfinance/totalfinance/volatility#SABRSmileInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market smile input for {@link calibrateSabrSmile}: the forward, and aligned strikes/impliedVolatilities at one expiry. ```typescript /** * Calibrate `(α, ρ, ν)` of a SABR smile to market implied volatilities at a single expiry. Needs at least 3 * strikes. Returns the full {@link SabrParameters} (including the fixed `β`), the fit RMSE, and convergence. */ /** Market smile input for {@link calibrateSabrSmile}: the forward, and aligned strikes/impliedVolatilities at one expiry. */ export interface SABRSmileInput { forward: number; strikes: number[]; /** Implied volatilities aligned to `strikes` (annualized decimals). */ impliedVolatilities: number[]; /** Time to expiry in years. */ timeToExpiryYears: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - forward: number; default: not declared - impliedVolatilities: number[]; default: not declared — Implied volatilities aligned to `strikes` (annualized decimals). - strikes: number[]; default: not declared - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#SSVIArbitrage Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). No-arbitrage diagnosis of an SSVI surface. ```typescript /** No-arbitrage diagnosis of an SSVI surface. */ export interface SSVIArbitrage { /** No calendar-spread arbitrage (θ non-decreasing + the ∂_θ(θφ) bound). */ calendarArbitrageFree: boolean; /** No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every θ-knot. */ butterflyArbitrageFree: boolean; /** The minimum Gatheral `g(k)` over the grid and knots (`≥ 0` ⇔ butterfly-free). */ minButterflyG: number; /** Whether the Gatheral–Jacquier SUFFICIENT conditions hold (guarantee arb-freedom for all `k`). */ sufficientConditionsHold: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every θ-knot. - calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage (θ non-decreasing + the ∂_θ(θφ) bound). - minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and knots (`≥ 0` ⇔ butterfly-free). - sufficientConditionsHold: boolean; default: not declared — Whether the Gatheral–Jacquier SUFFICIENT conditions hold (guarantee arb-freedom for all `k`). ### @insiderfinance/totalfinance/volatility#SSVICalibration Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link calibrateSsvi}. ```typescript /** Result of {@link calibrateSsvi}. */ export interface SSVICalibration { parameters: SSVIParameters; /** Root-mean-square total-variance error across all points. */ rmse: number; perSliceRmse: Array<{ timeToExpiryYears: number; rmse: number; }>; arbitrage: SSVIArbitrage; converged: boolean; assumptions: { conventionsVersion: string; phi: 'power-law' | 'heston'; weight: 'uniform' | 'vega'; /** Whether the search began from a caller-supplied `initialParameters` or the built-in start. */ initialParameters: 'supplied' | 'default'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - arbitrage: SSVIArbitrage; default: not declared - arbitrage.butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every θ-knot. - arbitrage.calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage (θ non-decreasing + the ∂_θ(θφ) bound). - arbitrage.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and knots (`≥ 0` ⇔ butterfly-free). - arbitrage.sufficientConditionsHold: boolean; default: not declared — Whether the Gatheral–Jacquier SUFFICIENT conditions hold (guarantee arb-freedom for all `k`). - assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; phi: 'power-law' | 'heston'; weight: 'uniform' | 'vega'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the built-in start. - assumptions.phi: 'power-law' | 'heston'; default: not declared - assumptions.weight: 'vega' | 'uniform'; default: not declared - converged: boolean; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - parameters: SSVIParameters; default: not declared - parameters.phi: SSVIPhi; default: not declared — Curvature function. - parameters.phi.eta: number; default: not declared - parameters.phi.gamma: number; default: not declared - parameters.phi.kind: ('heston') | ('power-law'); default: not declared - parameters.phi.lambda: number; default: not declared - parameters.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - parameters.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - rmse: number; default: not declared — Root-mean-square total-variance error across all points. ### @insiderfinance/totalfinance/volatility#SSVICalibrationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link calibrateSsvi}. ```typescript /** Input for {@link calibrateSsvi}. */ export interface SSVICalibrationInput { slices: SSVISliceInput[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - slices: SSVISliceInput[]; default: not declared ### @insiderfinance/totalfinance/volatility#SSVICalibrationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Options for {@link calibrateSsvi}. ```typescript /** Options for {@link calibrateSsvi}. */ export interface SSVICalibrationOptions { /** Curvature family; default `'power-law'`. */ phi?: 'power-law' | 'heston'; /** * Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each * point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit and thin, * low-vega wings are downweighted. */ weight?: 'uniform' | 'vega'; /** Outer-search iteration budget (default 1,000, maximum 10,000). */ maximumIterations?: number; /** Outer-search tolerance (default 1e-12). */ tolerance?: number; /** * Warm start for the `(ρ, φ)` search (Stage 4.5): `phi.kind` must equal the calibration's `phi` * family. The θ knots are fixed from the data and are not a start. */ initialParameters?: { rho: number; phi: SSVIPhi; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - initialParameters?: { phi: SSVIPhi; rho: number; }; default: not declared — Warm start for the `(ρ, φ)` search (Stage 4.5): `phi.kind` must equal the calibration's `phi` family. The θ knots are fixed from the data and are not a start. - initialParameters.phi: SSVIPhi; default: not declared - initialParameters.phi.eta: number; default: not declared - initialParameters.phi.gamma: number; default: not declared - initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - initialParameters.phi.lambda: number; default: not declared - initialParameters.rho: number; default: not declared - maximumIterations?: number; default: not declared — Outer-search iteration budget (default 1,000, maximum 10,000). - phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit and thin, low-vega wings are downweighted. ### @insiderfinance/totalfinance/volatility#SSVIParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calibrated SSVI surface parameters. ```typescript /** Calibrated SSVI surface parameters. */ export interface SSVIParameters { /** Global skew `ρ ∈ (−1, 1)`. */ rho: number; /** Curvature function. */ phi: SSVIPhi; /** ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). */ thetaTerm: Array<{ timeToExpiryYears: number; theta: number; }>; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - phi: SSVIPhi; default: not declared — Curvature function. - phi.eta: number; default: not declared - phi.gamma: number; default: not declared - phi.kind: ('heston') | ('power-law'); default: not declared - phi.lambda: number; default: not declared - rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). ### @insiderfinance/totalfinance/volatility#SSVIPhi Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The SSVI curvature function `φ(θ)`. ```typescript /** The SSVI curvature function `φ(θ)`. */ export type SSVIPhi = { kind: 'power-law'; eta: number; gamma: number; } | { kind: 'heston'; lambda: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eta: number; default: not declared - gamma: number; default: not declared - kind: ('heston') | ('power-law'); default: not declared - lambda: number; default: not declared ### @insiderfinance/totalfinance/volatility#SSVISliceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One maturity slice of the market surface. ```typescript /** One maturity slice of the market surface. */ export interface SSVISliceInput { /** Maturity in years. */ timeToExpiryYears: number; /** Log-moneyness `ln(K/F)` per observation. */ k: number[]; /** Total variance `σ²·t` aligned to `k`. Provide this or `iv`. */ w?: number[]; /** Implied volatilities aligned to `k` (converted to `w = iv²·t`). Provide this or `w`. */ impliedVolatility?: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - impliedVolatility?: number[]; default: not declared — Implied volatilities aligned to `k` (converted to `w = iv²·t`). Provide this or `w`. - k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - timeToExpiryYears: number; default: not declared — Maturity in years. - w?: number[]; default: not declared — Total variance `σ²·t` aligned to `k`. Provide this or `iv`. ### @insiderfinance/totalfinance/volatility#SURFACE_SCHEMA_VERSION Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Schema version stamped onto every {@link VolatilitySurface#toJSON } snapshot; checked on restore (WS4.4). ```typescript export declare const SURFACE_SCHEMA_VERSION: '1'; ``` ### @insiderfinance/totalfinance/volatility#SVICalibrationOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SVICalibrationOptions { /** Outer-search iteration budget (default 400, maximum 10,000). */ maximumIterations?: number; /** Outer-search tolerance (default 1e-12). */ tolerance?: number; /** * The slice's maturity in years. Supplied ⇒ the fit-vs-data deviation check (see * {@link calibrateSvi}) is expressed in true implied-VOL points, `σ = √(w/t)`. Omitted ⇒ `t = 1`, * i.e. the check runs on `√w = σ√t` — still a vol scale, but shrunk by `√t` on a short slice. */ timeToExpiryYears?: number; /** * Warm start for the outer `(m, σ)` search (Stage 4.5). Tried FIRST, ahead of the four built-in * starts — ties keep the first, so a warm start never loses to a cold fit. `a`, `b`, and `ρ` are * solved by the inner normal equations at every `(m, σ)` and are therefore not accepted as * starts (a member the search cannot honor is refused, never ignored). */ initialParameters?: SVIWarmStart; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - initialParameters?: SVIWarmStart; default: not declared — Warm start for the outer `(m, σ)` search (Stage 4.5). Tried FIRST, ahead of the four built-in starts — ties keep the first, so a warm start never loses to a cold fit. `a`, `b`, and `ρ` are solved by the inner normal equations at every `(m, σ)` and are therefore not accepted as starts (a member the search cannot honor is refused, never ignored). - initialParameters.m: number; default: not declared - initialParameters.sigma: number; default: not declared — `> 0`. - maximumIterations?: number; default: not declared — Outer-search iteration budget (default 400, maximum 10,000). - timeToExpiryYears?: number; default: not declared — The slice's maturity in years. Supplied ⇒ the fit-vs-data deviation check (see {@link calibrateSvi}) is expressed in true implied-VOL points, `σ = √(w/t)`. Omitted ⇒ `t = 1`, i.e. the check runs on `√w = σ√t` — still a vol scale, but shrunk by `√t` on a short slice. - tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). ### @insiderfinance/totalfinance/volatility#SVICalibrationResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SVICalibrationResult { parameters: SVIParameters; /** Root-mean-square total-variance error of the fit. */ rmse: number; /** * `false` when the outer search stopped early OR the fitted slice sits materially away from the * input smile (the arbitrage projection — see {@link calibrateSvi}); the reason is always a * `diagnostics.warnings` entry. Gate on it before trusting `parameters`. */ converged: boolean; iterations: number; /** Whether the fitted slice is butterfly-arbitrage-free (`g(k) ≥ 0` across the check grid). */ butterflyFree: boolean; /** The minimum Gatheral `g(k)` over the check grid (`≥ 0` ⇔ arbitrage-free). */ minButterflyG: number; /** Applied conventions, echoed (Law 2 report grammar). */ assumptions: { conventionsVersion: string; method: 'zeliade-quasi-explicit'; points: number; /** Whether the outer search began from a caller-supplied `initialParameters` or the built-in starts. */ initialParameters: 'supplied' | 'default'; }; /** Structured warnings; a non-converged or arbitrageable fit explains itself here. */ diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; method: 'zeliade-quasi-explicit'; points: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - assumptions.conventionsVersion: string; default: not declared - assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the outer search began from a caller-supplied `initialParameters` or the built-in starts. - assumptions.method: 'zeliade-quasi-explicit'; default: not declared - assumptions.points: number; default: not declared - butterflyFree: boolean; default: not declared — Whether the fitted slice is butterfly-arbitrage-free (`g(k) ≥ 0` across the check grid). - converged: boolean; default: not declared — `false` when the outer search stopped early OR the fitted slice sits materially away from the input smile (the arbitrage projection — see {@link calibrateSvi}); the reason is always a `diagnostics.warnings` entry. Gate on it before trusting `parameters`. - diagnostics: Diagnostics; default: not declared — Structured warnings; a non-converged or arbitrageable fit explains itself here. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - iterations: number; default: not declared - minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the check grid (`≥ 0` ⇔ arbitrage-free). - parameters: SVIParameters; default: not declared - parameters.a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - parameters.b: number; default: not declared — Wing slope / curvature, `≥ 0`. - parameters.m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - parameters.rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - parameters.sigma: number; default: not declared — Smoothness, `> 0`. - rmse: number; default: not declared — Root-mean-square total-variance error of the fit. ### @insiderfinance/totalfinance/volatility#SVIParameters Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Raw-SVI parameters (Gatheral). `a`,`b`,`σ` carry total-variance units; `m`,`k` are log-moneyness. ```typescript /** Raw-SVI parameters (Gatheral). `a`,`b`,`σ` carry total-variance units; `m`,`k` are log-moneyness. */ export interface SVIParameters { /** Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). */ a: number; /** Wing slope / curvature, `≥ 0`. */ b: number; /** Skew / rotation, `∈ [−1, 1]`. */ rho: number; /** Horizontal shift (log-moneyness of the smile's centre). */ m: number; /** Smoothness, `> 0`. */ sigma: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - b: number; default: not declared — Wing slope / curvature, `≥ 0`. - m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - sigma: number; default: not declared — Smoothness, `> 0`. ### @insiderfinance/totalfinance/volatility#SVISmileInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Total-variance smile input for {@link calibrateSvi}: log-moneyness `k` and total variance `w` points. ```typescript /** * Calibrate a raw-SVI slice to observed `(k, w)` total-variance points. Needs at least 5 distinct * strikes to identify the five parameters. The calibration is penalized for butterfly violations and * refined toward an arbitrage-free fit; the result carries its RMSE plus the verified * `butterflyFree` / `minButterflyG` diagnostics (it is *not* assumed arbitrage-free). * * **The fit is an arbitrage-free PROJECTION of the data, so it is also checked AGAINST the data.** * The butterfly penalty deliberately walks the fit away from an arbitrageable smile, and * `butterflyFree`/`minButterflyG` measure the FITTED slice's own density — they say nothing about how * far that slice ended up from the quotes. A smile that embeds butterfly arbitrage can therefore be * projected onto a clean SVI a hundred vol points away, which is a perfectly arbitrage-free answer to * a different question. So the result reports the fit-vs-data distance in implied-VOL points * (`σ = √(w/t)`, with `t` from `options.timeToExpiryYears`, default 1): when the RMSE exceeds * `max(0.005, 2% of mean IV)` or any single point is off by more than 5 vol points, `converged` is * `false` and a `volatility.calibration_fit_deviation` warning carries `{ rmse, maxDeviation }`. */ /** Total-variance smile input for {@link calibrateSvi}: log-moneyness `k` and total variance `w` points. */ export interface SVISmileInput { /** Log-moneyness `ln(K/F)` per observation. */ k: number[]; /** Total implied variance `σ²·t` aligned to `k`. */ w: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - w: number[]; default: not declared — Total implied variance `σ²·t` aligned to `k`. ### @insiderfinance/totalfinance/volatility#SVIWarmStart Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A warm start for {@link calibrateSvi}: the two FREE members of the outer search, in the canonical SVI spelling (`m` is the smile's centre, `σ` its smoothness). `a`, `b`, and `ρ` are solved by the inner normal equations and are therefore not part of a start. ```typescript /** * A warm start for {@link calibrateSvi}: the two FREE members of the outer search, in the canonical * SVI spelling (`m` is the smile's centre, `σ` its smoothness). `a`, `b`, and `ρ` are solved by the * inner normal equations and are therefore not part of a start. */ export interface SVIWarmStart { m: number; /** `> 0`. */ sigma: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - m: number; default: not declared - sigma: number; default: not declared — `> 0`. ### @insiderfinance/totalfinance/volatility#SabrBartlettGreeks Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Bartlett (minimum-variance) SABR greeks, alongside the naive SABR greeks they adjust. ```typescript /** The Bartlett (minimum-variance) SABR greeks, alongside the naive SABR greeks they adjust. */ export interface SabrBartlettGreeks { /** Hagan implied vol at `(F, K, t)`. */ impliedVolatility: number; /** `∂V/∂F` holding parameters fixed — the naive SABR (model) delta, per 1.00 of forward. */ sabrDelta: number; /** The Bartlett minimum-variance delta, per 1.00 of forward. */ bartlettDelta: number; /** `bartlettDelta − sabrDelta` — the correlation contribution to the delta. */ deltaAdjustment: number; /** `∂V/∂α`, per 1% of `α` — the naive SABR vega. */ sabrVega: number; /** The Bartlett minimum-variance vega, per 1% of `α`. */ bartlettVega: number; /** `bartlettVega − sabrVega` — the correlation contribution to the vega. */ vegaAdjustment: number; /** `∂²V/∂F²` holding parameters fixed — the naive SABR gamma, per 1.00 of forward. */ sabrGamma: number; /** The Bartlett minimum-variance gamma — `d²V/dF²` along the correlated hedge path. */ bartlettGamma: number; /** `bartlettGamma − sabrGamma` — the correlation contribution to the gamma (≈ 0 at the money). */ gammaAdjustment: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - bartlettDelta: number; default: not declared — The Bartlett minimum-variance delta, per 1.00 of forward. - bartlettGamma: number; default: not declared — The Bartlett minimum-variance gamma — `d²V/dF²` along the correlated hedge path. - bartlettVega: number; default: not declared — The Bartlett minimum-variance vega, per 1% of `α`. - deltaAdjustment: number; default: not declared — `bartlettDelta − sabrDelta` — the correlation contribution to the delta. - gammaAdjustment: number; default: not declared — `bartlettGamma − sabrGamma` — the correlation contribution to the gamma (≈ 0 at the money). - impliedVolatility: number; default: not declared — Hagan implied vol at `(F, K, t)`. - sabrDelta: number; default: not declared — `∂V/∂F` holding parameters fixed — the naive SABR (model) delta, per 1.00 of forward. - sabrGamma: number; default: not declared — `∂²V/∂F²` holding parameters fixed — the naive SABR gamma, per 1.00 of forward. - sabrVega: number; default: not declared — `∂V/∂α`, per 1% of `α` — the naive SABR vega. - vegaAdjustment: number; default: not declared — `bartlettVega − sabrVega` — the correlation contribution to the vega. ### @insiderfinance/totalfinance/volatility#SabrBartlettOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Knobs for {@link sabrBartlettGreeks}. ```typescript /** Knobs for {@link sabrBartlettGreeks}. */ export interface SabrBartlettOptions { /** Hagan expansion: `'lognormal'` (Black, default) or `'normal'` (Bachelier). */ volatilityType?: SabrVolatilityType; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion: `'lognormal'` (Black, default) or `'normal'` (Bachelier). ### @insiderfinance/totalfinance/volatility#SkewConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Non-market skew configuration: which expiry, the price source, model, and RR convention (WS3.2). ```typescript /** Non-market skew configuration: which expiry, the price source, model, and RR convention (WS3.2). */ export interface SkewConfig { /** The expiry to analyze (ISO label present in the chain). */ expiry: string; priceSource?: PriceSource; model?: SurfaceModel; /** Risk-reversal sign convention (default `callMinusPut`). */ riskReversalConvention?: RiskReversalConvention; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared — The expiry to analyze (ISO label present in the chain). - model?: SurfaceModel; default: not declared - priceSource?: PriceSource; default: not declared - riskReversalConvention?: RiskReversalConvention; default: not declared — Risk-reversal sign convention (default `callMinusPut`). ### @insiderfinance/totalfinance/volatility#SkewMarket Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market snapshot for `skew()` — the workspace-canonical {@link MarketInputs}, except `spot` is optional (it falls back to each quote's `underlyingPrice` when omitted) (WS3.2). ```typescript /** * Market snapshot for `skew()` — the workspace-canonical {@link MarketInputs}, except `spot` is * optional (it falls back to each quote's `underlyingPrice` when omitted) (WS3.2). */ export type SkewMarket = Omit & { /** Spot price. Falls back to each quote's `underlyingPrice` when omitted. */ spot?: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - riskFreeRate: number; default: not declared - spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. ### @insiderfinance/totalfinance/volatility#SkewMetrics Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SkewMetrics { expiry: string; timeToExpiryYears: number; forward: number; /** ATM-forward implied vol (the smile evaluated at `K = forward`). */ atmImpliedVolatility: number; put10DeltaImpliedVolatility: number; put25DeltaImpliedVolatility: number; call25DeltaImpliedVolatility: number; call10DeltaImpliedVolatility: number; /** 25-/10-delta risk reversals (signed per `riskReversalConvention`). */ riskReversal25Delta: number; riskReversal10Delta: number; /** 25-/10-delta butterflies: `(wingCall + wingPut)/2 − atmImpliedVolatility`. */ butterfly25Delta: number; butterfly10Delta: number; /** Wing IV minus ATM: `put25DeltaImpliedVolatility − atmImpliedVolatility` and `call25DeltaImpliedVolatility − atmImpliedVolatility`. */ putSkew: number; callSkew: number; /** `d(iv)/d(logMoneyness)` at the forward (negative for the usual equity put-skew). */ skewSlope: number; /** `d²(iv)/d(logMoneyness)²` at the forward (smile convexity). */ smileCurvature: number; /** Wing steepness: extra IV in the 10Δ wings over the 25Δ wings, `(iv10P − iv25P) + (iv10C − iv25C)`. */ wingSteepness: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmImpliedVolatility: number; default: not declared — ATM-forward implied vol (the smile evaluated at `K = forward`). - butterfly10Delta: number; default: not declared - butterfly25Delta: number; default: not declared — 25-/10-delta butterflies: `(wingCall + wingPut)/2 − atmImpliedVolatility`. - call10DeltaImpliedVolatility: number; default: not declared - call25DeltaImpliedVolatility: number; default: not declared - callSkew: number; default: not declared - expiry: string; default: not declared - forward: number; default: not declared - put10DeltaImpliedVolatility: number; default: not declared - put25DeltaImpliedVolatility: number; default: not declared - putSkew: number; default: not declared — Wing IV minus ATM: `put25DeltaImpliedVolatility − atmImpliedVolatility` and `call25DeltaImpliedVolatility − atmImpliedVolatility`. - riskReversal10Delta: number; default: not declared - riskReversal25Delta: number; default: not declared — 25-/10-delta risk reversals (signed per `riskReversalConvention`). - skewSlope: number; default: not declared — `d(iv)/d(logMoneyness)` at the forward (negative for the usual equity put-skew). - smileCurvature: number; default: not declared — `d²(iv)/d(logMoneyness)²` at the forward (smile convexity). - timeToExpiryYears: number; default: not declared - wingSteepness: number; default: not declared — Wing steepness: extra IV in the 10Δ wings over the 25Δ wings, `(iv10P − iv25P) + (iv10C − iv25C)`. ### @insiderfinance/totalfinance/volatility#SkewResult Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type SkewResult = Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: SkewMetrics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - value.atmImpliedVolatility: number; default: not declared — ATM-forward implied vol (the smile evaluated at `K = forward`). - value.butterfly10Delta: number; default: not declared - value.butterfly25Delta: number; default: not declared — 25-/10-delta butterflies: `(wingCall + wingPut)/2 − atmImpliedVolatility`. - value.call10DeltaImpliedVolatility: number; default: not declared - value.call25DeltaImpliedVolatility: number; default: not declared - value.callSkew: number; default: not declared - value.expiry: string; default: not declared - value.forward: number; default: not declared - value.put10DeltaImpliedVolatility: number; default: not declared - value.put25DeltaImpliedVolatility: number; default: not declared - value.putSkew: number; default: not declared — Wing IV minus ATM: `put25DeltaImpliedVolatility − atmImpliedVolatility` and `call25DeltaImpliedVolatility − atmImpliedVolatility`. - value.riskReversal10Delta: number; default: not declared - value.riskReversal25Delta: number; default: not declared — 25-/10-delta risk reversals (signed per `riskReversalConvention`). - value.skewSlope: number; default: not declared — `d(iv)/d(logMoneyness)` at the forward (negative for the usual equity put-skew). - value.smileCurvature: number; default: not declared — `d²(iv)/d(logMoneyness)²` at the forward (smile convexity). - value.timeToExpiryYears: number; default: not declared - value.wingSteepness: number; default: not declared — Wing steepness: extra IV in the 10Δ wings over the 25Δ wings, `(iv10P − iv25P) + (iv10C − iv25C)`. ### @insiderfinance/totalfinance/volatility#SmileAnchors Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The three `(strike, vol)` smile anchors implied by the quotes. ```typescript /** The three `(strike, vol)` smile anchors implied by the quotes. */ export interface SmileAnchors { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; delta: number; assumptions: { conventionsVersion: string; deltaConvention: 'forward'; delta: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.delta: number; default: not declared - assumptions.deltaConvention: 'forward'; default: not declared - atmStrike: number; default: not declared - atmVolatility: number; default: not declared - callStrike: number; default: not declared - callVolatility: number; default: not declared - delta: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - putStrike: number; default: not declared - putVolatility: number; default: not declared ### @insiderfinance/totalfinance/volatility#SmileFromQuotesInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link smileFromQuotes}. ```typescript // ─────────────────────────────────────────────────────────────────────────────────────────────── // Inverse: (ATM, RR, BF) → smile anchors // ─────────────────────────────────────────────────────────────────────────────────────────────── /** Input for {@link smileFromQuotes}. */ export interface SmileFromQuotesInput { forward: number; timeToExpiryYears: number; /** ATM vol. */ atmVolatility: number; /** Risk reversal (`callVolatility − putVolatility`). */ riskReversal: number; /** Butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). */ butterfly: number; /** Delta level. Default 0.25. */ delta?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared — ATM vol. - butterfly: number; default: not declared — Butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - delta?: number; default: not declared — Delta level. Default 0.25. - forward: number; default: not declared - riskReversal: number; default: not declared — Risk reversal (`callVolatility − putVolatility`). - timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#StickyRegime Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The measured regime. ```typescript /** The measured regime. */ export interface StickyRegime { /** * `∂σ_K/∂lnS` — the empirical vol-spot beta from the regression, **per LOG spot** (vol points per * 100% spot move). NOT the same quantity as `VolatilitySpotBeta.volatilitySpotBeta` / * `minimumVarianceDelta({ volatilitySpotBeta })`, which are `∂σ/∂S` — per DOLLAR. The two differ by * a factor of `S`: feeding this straight into the hedge would scale the smile adjustment by the * spot price. Divide by the reference spot first (`estimateVolatilitySpotBeta` does exactly that * when its `basis` is `'log'`). */ volatilitySpotBetaPerLogSpot: number; tStatistic: number; /** How much of the fixed-strike vol's change spot returns explain. */ rSquared: number; /** Position on the axis: 0 = sticky-strike, 1 = sticky-moneyness (`= −β/skewSlope`); `null` if no reference. */ stickiness: number | null; regime: 'sticky-strike' | 'sticky-moneyness' | 'intermediate' | 'indeterminate'; observations: number; assumptions: { conventionsVersion: string; skewSlope: number | null; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; skewSlope: number | null; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.skewSlope: number | null; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - observations: number; default: not declared - rSquared: number; default: not declared — How much of the fixed-strike vol's change spot returns explain. - regime: 'indeterminate' | 'sticky-strike' | 'sticky-moneyness' | 'intermediate'; default: not declared - stickiness: number | null; default: not declared — Position on the axis: 0 = sticky-strike, 1 = sticky-moneyness (`= −β/skewSlope`); `null` if no reference. - tStatistic: number; default: not declared - volatilitySpotBetaPerLogSpot: number; default: not declared — `∂σ_K/∂lnS` — the empirical vol-spot beta from the regression, **per LOG spot** (vol points per 100% spot move). NOT the same quantity as `VolatilitySpotBeta.volatilitySpotBeta` / `minimumVarianceDelta({ volatilitySpotBeta })`, which are `∂σ/∂S` — per DOLLAR. The two differ by a factor of `S`: feeding this straight into the hedge would scale the smile adjustment by the spot price. Divide by the reference spot first (`estimateVolatilitySpotBeta` does exactly that when its `basis` is `'log'`). ### @insiderfinance/totalfinance/volatility#StickyRegimeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link stickyRegime}. ```typescript /** Inputs for {@link stickyRegime}. */ export interface StickyRegimeInput { /** Per-observation underlying spot, aligned to `fixedStrikeVolatility`. */ spot: ArrayLike; /** Per-observation implied vol of a FIXED reference strike (same K across the series). */ fixedStrikeVolatility: ArrayLike; /** The smile slope `∂σ/∂ln(K)` — the sticky-moneyness reference. Omit ⇒ only `β`/R² (indeterminate). */ skewSlope?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fixedStrikeVolatility: ArrayLike; default: not declared — Per-observation implied vol of a FIXED reference strike (same K across the series). - skewSlope?: number; default: not declared — The smile slope `∂σ/∂ln(K)` — the sticky-moneyness reference. Omit ⇒ only `β`/R² (indeterminate). - spot: ArrayLike; default: not declared — Per-observation underlying spot, aligned to `fixedStrikeVolatility`. ### @insiderfinance/totalfinance/volatility#SurfaceConfig Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Non-market surface configuration: price source, model, and per-model calibration knobs (WS3.2). ```typescript /** Non-market surface configuration: price source, model, and per-model calibration knobs (WS3.2). */ export interface SurfaceConfig { /** Which quote price to invert when a quote has no `impliedVolatility` (default `mid`). */ priceSource?: PriceSource; /** * `interpolated` (PCHIP, default), `raw` (linear), `smoothed` (Gaussian kernel), `svi`/`sabr` * (parametric per expiry), `ssvi` (one global arbitrage-free surface SVI), `essvi` (SSVI with a * per-maturity skew), or `heston` (one global stochastic-vol model fit to the whole surface). */ model?: SurfaceModel; /** Below this many usable strikes, an expiry slice is flagged sparse (default 3). */ minQuotesPerExpiry?: number; /** SABR backbone exponent β ∈ [0, 1] for `model: 'sabr'` (default 0.5). */ sabrBeta?: number; /** SABR Hagan expansion for `model: 'sabr'` (default `'lognormal'`). */ sabrVolatilityType?: SabrVolatilityType; /** Gaussian-kernel bandwidth (in log-moneyness) for `model: 'smoothed'` (default auto). */ smoothingBandwidth?: number; /** Warm start (partial pin) for the global `model: 'heston'` calibration — threads into `calibrateHestonSurface`'s `initialParameters`. */ hestonInitialParameters?: Partial; /** COS cosine-term count for the `model: 'heston'` calibration & evaluation (default 128). */ cosineExpansionTerms?: number; /** Curvature family for the global `model: 'ssvi'` calibration (default `'power-law'`). */ ssviPhi?: 'power-law' | 'heston'; /** Least-squares weighting for `model: 'ssvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). */ ssviWeight?: 'uniform' | 'vega'; /** Curvature family for the global `model: 'essvi'` calibration (default `'power-law'`). */ essviPhi?: 'power-law' | 'heston'; /** Least-squares weighting for `model: 'essvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). */ essviWeight?: 'uniform' | 'vega'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cosineExpansionTerms?: number; default: not declared — COS cosine-term count for the `model: 'heston'` calibration & evaluation (default 128). - essviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'essvi'` calibration (default `'power-law'`). - essviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'essvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - hestonInitialParameters?: Partial; default: not declared — Warm start (partial pin) for the global `model: 'heston'` calibration — threads into `calibrateHestonSurface`'s `initialParameters`. - hestonInitialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - hestonInitialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - hestonInitialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - hestonInitialParameters.theta?: number; default: not declared — Long-run variance θ. - hestonInitialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - minQuotesPerExpiry?: number; default: not declared — Below this many usable strikes, an expiry slice is flagged sparse (default 3). - model?: SurfaceModel; default: not declared — `interpolated` (PCHIP, default), `raw` (linear), `smoothed` (Gaussian kernel), `svi`/`sabr` (parametric per expiry), `ssvi` (one global arbitrage-free surface SVI), `essvi` (SSVI with a per-maturity skew), or `heston` (one global stochastic-vol model fit to the whole surface). - priceSource?: PriceSource; default: not declared — Which quote price to invert when a quote has no `impliedVolatility` (default `mid`). - sabrBeta?: number; default: not declared — SABR backbone exponent β ∈ [0, 1] for `model: 'sabr'` (default 0.5). - sabrVolatilityType?: SabrVolatilityType; default: not declared — SABR Hagan expansion for `model: 'sabr'` (default `'lognormal'`). - smoothingBandwidth?: number; default: not declared — Gaussian-kernel bandwidth (in log-moneyness) for `model: 'smoothed'` (default auto). - ssviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'ssvi'` calibration (default `'power-law'`). - ssviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'ssvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). ### @insiderfinance/totalfinance/volatility#SurfaceLookup Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of a surface lookup: the IV plus whether the query was extrapolated. ```typescript /** Result of a surface lookup: the IV plus whether the query was extrapolated. */ export interface SurfaceLookup extends Computed { extrapolated: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - extrapolated: boolean; default: not declared - provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#SurfaceMarket Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Market snapshot for `volatilitySurface()` — the workspace-canonical {@link MarketInputs}, except `spot` is optional (it falls back to each quote's `underlyingPrice` when omitted) (WS3.2). ```typescript /** * Market snapshot for `volatilitySurface()` — the workspace-canonical {@link MarketInputs}, except `spot` is * optional (it falls back to each quote's `underlyingPrice` when omitted) (WS3.2). */ export type SurfaceMarket = Omit & { /** Spot price. Falls back to each quote's `underlyingPrice` when omitted. */ spot?: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - riskFreeRate: number; default: not declared - spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. ### @insiderfinance/totalfinance/volatility#SurfaceMode Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One principal mode of surface motion. ```typescript /** One principal mode of surface motion. */ export interface SurfaceMode { /** The eigenvector across the grid (sign-canonicalized so the loadings sum ≥ 0). */ loadings: number[]; eigenvalue: number; /** Fraction of the total change variance this mode explains. */ varianceExplained: number; /** Shape labeled from the loadings' sign-change count along the grid. */ shape: 'level' | 'slope' | 'curvature' | 'higher-order'; /** Factor score per change observation: the projection of each centered change onto `loadings`. */ scores: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - eigenvalue: number; default: not declared - loadings: number[]; default: not declared — The eigenvector across the grid (sign-canonicalized so the loadings sum ≥ 0). - scores: number[]; default: not declared — Factor score per change observation: the projection of each centered change onto `loadings`. - shape: 'level' | 'slope' | 'curvature' | 'higher-order'; default: not declared — Shape labeled from the loadings' sign-change count along the grid. - varianceExplained: number; default: not declared — Fraction of the total change variance this mode explains. ### @insiderfinance/totalfinance/volatility#SurfaceModel Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). `raw`/`interpolated`/`smoothed` are non-parametric (linear, PCHIP, and a Gaussian-kernel smoother); `svi`/`sabr` fit a parametric smile per expiry; `heston` calibrates one global stochastic-vol model to the whole surface. Parametric models fall back to an interpolated smile for expiries with too few strikes. (Dupire local-volatility *surface fitting* is sequenced later — spec §10.1.) ```typescript /** * `raw`/`interpolated`/`smoothed` are non-parametric (linear, PCHIP, and a Gaussian-kernel smoother); * `svi`/`sabr` fit a parametric smile per expiry; `heston` calibrates one global stochastic-vol model * to the whole surface. Parametric models fall back to an interpolated smile for expiries with too few * strikes. (Dupire local-volatility *surface fitting* is sequenced later — spec §10.1.) */ export type SurfaceModel = 'raw' | 'interpolated' | 'smoothed' | 'svi' | 'sabr' | 'ssvi' | 'essvi' | 'heston'; ``` ### @insiderfinance/totalfinance/volatility#SurfacePcaInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link surfacePCA}. ```typescript /** Inputs for {@link surfacePCA}. */ export interface SurfacePcaInput { /** IV snapshots over time; `snapshots[t]` is the vol vector at a FIXED set of grid points. */ snapshots: number[][]; /** Ordered grid coordinates (moneyness or tenor), one per column — used to label mode shapes. */ gridPoints?: number[]; /** How to difference consecutive snapshots; default `'absolute'`. */ changes?: 'absolute' | 'relative'; /** Retain only the top-k modes; default all (= grid size). */ maxComponents?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - changes?: 'absolute' | 'relative'; default: not declared — How to difference consecutive snapshots; default `'absolute'`. - gridPoints?: number[]; default: not declared — Ordered grid coordinates (moneyness or tenor), one per column — used to label mode shapes. - maxComponents?: number; default: not declared — Retain only the top-k modes; default all (= grid size). - snapshots: number[][]; default: not declared — IV snapshots over time; `snapshots[t]` is the vol vector at a FIXED set of grid points. ### @insiderfinance/totalfinance/volatility#SurfacePcaResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link surfacePCA}. ```typescript /** Result of {@link surfacePCA}. */ export interface SurfacePcaResult { modes: SurfaceMode[]; /** Cumulative variance explained up to and including each mode. */ cumulativeVarianceExplained: number[]; totalVariance: number; /** Number of change vectors (`snapshots.length − 1`). */ observations: number; gridSize: number; changeType: 'absolute' | 'relative'; assumptions: { conventionsVersion: string; changeType: 'absolute' | 'relative'; ordered: boolean; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { changeType: 'absolute' | 'relative'; conventionsVersion: string; ordered: boolean; }; default: not declared - assumptions.changeType: 'absolute' | 'relative'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.ordered: boolean; default: not declared - changeType: 'absolute' | 'relative'; default: not declared - cumulativeVarianceExplained: number[]; default: not declared — Cumulative variance explained up to and including each mode. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - gridSize: number; default: not declared - modes: SurfaceMode[]; default: not declared - observations: number; default: not declared — Number of change vectors (`snapshots.length − 1`). - totalVariance: number; default: not declared ### @insiderfinance/totalfinance/volatility#SurfacePcaScenarioInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link surfacePcaScenarios}. ```typescript // ───────────────────────── PCA scenario shocks ───────────────────────── /** Inputs for {@link surfacePcaScenarios}. */ export interface SurfacePcaScenarioInput { /** The result of {@link surfacePCA} — its modes drive the shocks. */ pca: SurfacePcaResult; /** Current volatilities to shock, at the SAME grid points as the PCA (length = `pca.gridSize`). */ base: number[]; /** Shock magnitudes in standard deviations, applied to each mode. Default `[-1, 1]`. */ sigmas?: number[]; /** Shock only the top-N modes. Default all of `pca.modes`. */ maxModes?: number; /** Floor for the shocked volatilities (a vol can't go negative). Default 0. */ floor?: number; /** Optional per-mode sigma moves → one combined shocked surface. */ combined?: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - base: number[]; default: not declared — Current volatilities to shock, at the SAME grid points as the PCA (length = `pca.gridSize`). - combined?: number[]; default: not declared — Optional per-mode sigma moves → one combined shocked surface. - floor?: number; default: not declared — Floor for the shocked volatilities (a vol can't go negative). Default 0. - maxModes?: number; default: not declared — Shock only the top-N modes. Default all of `pca.modes`. - pca: SurfacePcaResult; default: not declared — The result of {@link surfacePCA} — its modes drive the shocks. - pca.assumptions: { changeType: 'absolute' | 'relative'; conventionsVersion: string; ordered: boolean; }; default: not declared - pca.assumptions.changeType: 'absolute' | 'relative'; default: not declared - pca.assumptions.conventionsVersion: string; default: not declared - pca.assumptions.ordered: boolean; default: not declared - pca.changeType: 'absolute' | 'relative'; default: not declared - pca.cumulativeVarianceExplained: number[]; default: not declared — Cumulative variance explained up to and including each mode. - pca.diagnostics: Diagnostics; default: not declared - pca.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - pca.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - pca.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - pca.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - pca.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - pca.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - pca.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - pca.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - pca.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - pca.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - pca.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - pca.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - pca.diagnostics.selection.selected.name: string; default: not declared - pca.diagnostics.selection.selected.version?: string; default: not declared - pca.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - pca.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - pca.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pca.gridSize: number; default: not declared - pca.modes: SurfaceMode[]; default: not declared - pca.observations: number; default: not declared — Number of change vectors (`snapshots.length − 1`). - pca.totalVariance: number; default: not declared - sigmas?: number[]; default: not declared — Shock magnitudes in standard deviations, applied to each mode. Default `[-1, 1]`. ### @insiderfinance/totalfinance/volatility#SurfacePcaScenarios Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Result of {@link surfacePcaScenarios}. ```typescript /** Result of {@link surfacePcaScenarios}. */ export interface SurfacePcaScenarios { base: number[]; /** One per `(mode, sigma)`, in mode-major order. */ scenarios: SurfaceScenario[]; /** `base + Σ sᵢ·√λᵢ·loadingsᵢ`, floored — present only when `combined` is supplied. */ combinedSurface?: number[]; assumptions: { conventionsVersion: string; changeType: 'absolute' | 'relative'; floor: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { changeType: 'absolute' | 'relative'; conventionsVersion: string; floor: number; }; default: not declared - assumptions.changeType: 'absolute' | 'relative'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.floor: number; default: not declared - base: number[]; default: not declared - combinedSurface?: number[]; default: not declared — `base + Σ sᵢ·√λᵢ·loadingsᵢ`, floored — present only when `combined` is supplied. - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - scenarios: SurfaceScenario[]; default: not declared — One per `(mode, sigma)`, in mode-major order. ### @insiderfinance/totalfinance/volatility#SurfacePoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A raw solved surface point before smoothing. ```typescript /** A raw solved surface point before smoothing. */ export interface SurfacePoint { expiry: string; strike: number; type: OptionType; timeToExpiryYears: number; impliedVolatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - expiry: string; default: not declared - impliedVolatility: number; default: not declared - strike: number; default: not declared - timeToExpiryYears: number; default: not declared - type: OptionType; default: not declared ### @insiderfinance/totalfinance/volatility#SurfaceRow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One chart-facing row from {@link VolatilitySurface#toRows } — the smile-chart / heatmap feed. Per the workspace missing-value policy (WS2.12), every chart-facing numeric is `number | null`: a non-finite stored value becomes `null`, never `NaN` and never omitted. ```typescript /** * One chart-facing row from {@link VolatilitySurface#toRows} — the smile-chart / heatmap feed. Per the * workspace missing-value policy (WS2.12), every chart-facing numeric is `number | null`: a non-finite * stored value becomes `null`, never `NaN` and never omitted. */ export interface SurfaceRow { expiry: string; strike: number; /** `ln(strike/forward)`, or `null` if non-finite. */ logMoneyness: number | null; /** Stored call-delta at the strike, or `null` if the stored value is non-finite. */ delta: number | null; /** Stored implied vol at the strike, or `null` if the stored value is non-finite. */ impliedVolatility: number | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number | null; default: not declared — Stored call-delta at the strike, or `null` if the stored value is non-finite. - expiry: string; default: not declared - impliedVolatility: number | null; default: not declared — Stored implied vol at the strike, or `null` if the stored value is non-finite. - logMoneyness: number | null; default: not declared — `ln(strike/forward)`, or `null` if non-finite. - strike: number; default: not declared ### @insiderfinance/totalfinance/volatility#SurfaceScenario Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One shocked-surface scenario (a `sigma`-standard-deviation move along one mode). ```typescript /** One shocked-surface scenario (a `sigma`-standard-deviation move along one mode). */ export interface SurfaceScenario { /** 0-indexed mode. */ mode: number; shape: SurfaceMode['shape']; sigma: number; /** * `sigma·√λ·loadings` — the (unclamped) surface change vector, in the PCA's own units: VOL POINTS * for an `absolute` PCA, FRACTIONS of the base vol for a `relative` one. */ shockVector: number[]; /** * The shocked surface, floored: `max(floor, base + shockVector)` for an `absolute` PCA, * `max(floor, base · (1 + shockVector))` for a `relative` one. */ shockedSurface: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - mode: number; default: not declared — 0-indexed mode. - shape: 'level' | 'slope' | 'curvature' | 'higher-order'; default: not declared - shockVector: number[]; default: not declared — `sigma·√λ·loadings` — the (unclamped) surface change vector, in the PCA's own units: VOL POINTS for an `absolute` PCA, FRACTIONS of the base vol for a `relative` one. - shockedSurface: number[]; default: not declared — The shocked surface, floored: `max(floor, base + shockVector)` for an `absolute` PCA, `max(floor, base · (1 + shockVector))` for a `relative` one. - sigma: number; default: not declared ### @insiderfinance/totalfinance/volatility#SurfaceShock Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A vol-structure shock echoed in a shocked surface's {@link VolatilitySurface.assumptions} (WS4.4). ```typescript /** A vol-structure shock echoed in a shocked surface's {@link VolatilitySurface.assumptions} (WS4.4). */ export interface SurfaceShock { /** Additive parallel shift applied to every stored IV (in vol points, e.g. `0.02` = +2 vol). */ parallel: number; /** Skew rotation: adds `skewTilt · k` where `k = ln(K/forward)` (log-moneyness). */ skewTilt: number; /** Which quantity the tilt is pinned to: `'strike'` (default) or `'moneyness'`. */ sticky: 'strike' | 'moneyness'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - parallel: number; default: not declared — Additive parallel shift applied to every stored IV (in vol points, e.g. `0.02` = +2 vol). - skewTilt: number; default: not declared — Skew rotation: adds `skewTilt · k` where `k = ln(K/forward)` (log-moneyness). - sticky: 'strike' | 'moneyness'; default: not declared — Which quantity the tilt is pinned to: `'strike'` (default) or `'moneyness'`. ### @insiderfinance/totalfinance/volatility#SurfaceSlice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One per-expiry smile, strikes ascending. ```typescript /** One per-expiry smile, strikes ascending. */ export interface SurfaceSlice { expiry: string; /** Time to expiry in years (ACT/365F). */ timeToExpiryYears: number; /** Forward `S·e^{(r−q)t}`. */ forward: number; strikes: number[]; impliedVolatilities: number[]; /** Call-delta `e^{−qt}·N(d1)` at each strike (the smile's delta axis, for skew lookups). */ deltas: number[]; /** Fitted raw-SVI parameters when `model: 'svi'` (absent if the slice fell back to interpolation). */ svi?: SVIParameters; /** Fitted SABR parameters when `model: 'sabr'` (absent if the slice fell back to interpolation). */ sabr?: SabrParameters; /** The globally-calibrated SSVI parameters when `model: 'ssvi'` (shared across all slices). */ ssvi?: SSVIParameters; /** The globally-calibrated eSSVI parameters when `model: 'essvi'` (shared across all slices). */ essvi?: ESSVIParameters; /** The globally-calibrated Heston parameters when `model: 'heston'` (shared across all slices). */ heston?: HestonParameters; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - deltas: number[]; default: not declared — Call-delta `e^{−qt}·N(d1)` at each strike (the smile's delta axis, for skew lookups). - essvi?: ESSVIParameters; default: not declared — The globally-calibrated eSSVI parameters when `model: 'essvi'` (shared across all slices). - essvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - essvi.phi.eta: number; default: not declared - essvi.phi.gamma: number; default: not declared - essvi.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.phi.lambda: number; default: not declared - essvi.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - expiry: string; default: not declared - forward: number; default: not declared — Forward `S·e^{(r−q)t}`. - heston?: HestonParameters; default: not declared — The globally-calibrated Heston parameters when `model: 'heston'` (shared across all slices). - heston.kappa: number; default: not declared — Mean-reversion speed κ. - heston.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston.theta: number; default: not declared — Long-run variance θ. - heston.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - impliedVolatilities: number[]; default: not declared - sabr?: SabrParameters; default: not declared — Fitted SABR parameters when `model: 'sabr'` (absent if the slice fell back to interpolation). - sabr.alpha: number; default: not declared — Initial volatility level α (> 0). - sabr.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - sabr.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - sabr.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - ssvi?: SSVIParameters; default: not declared — The globally-calibrated SSVI parameters when `model: 'ssvi'` (shared across all slices). - ssvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function. - ssvi.phi.eta: number; default: not declared - ssvi.phi.gamma: number; default: not declared - ssvi.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.phi.lambda: number; default: not declared - ssvi.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - ssvi.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - strikes: number[]; default: not declared - svi?: SVIParameters; default: not declared — Fitted raw-SVI parameters when `model: 'svi'` (absent if the slice fell back to interpolation). - svi.a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - svi.b: number; default: not declared — Wing slope / curvature, `≥ 0`. - svi.m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - svi.rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - svi.sigma: number; default: not declared — Smoothness, `> 0`. - timeToExpiryYears: number; default: not declared — Time to expiry in years (ACT/365F). ### @insiderfinance/totalfinance/volatility#SwaptionCube Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The calibrated swaption cube (data-only, serializable). ```typescript /** The calibrated swaption cube (data-only, serializable). */ export interface SwaptionCube { /** Calibrated nodes, sorted by `(expiry, tenor)`. */ nodes: CalibratedSwaptionNode[]; /** Unique expiries, ascending. */ expiries: number[]; /** Unique tenors, ascending. */ tenors: number[]; volatilityType: SabrVolatilityType; /** * The rate displacement applied inside SABR (`0` for plain SABR). Nodes' `forward` fields stay the * real (unshifted) rates; the shift lives only in the SABR calibration/evaluation. {@link swaptionCubeVolatility} * reads this off the cube. OPTIONAL because legacy (pre-shift) serialized cubes carry no field — * evaluation reads an absent shift as `0`; the declaration used to say required while the * runtime documented that default, and the 3B.1b spec convicted the mismatch (the TA lesson: * when the runtime is right, the DECLARATION is what lies). */ shift?: number; assumptions: { conventionsVersion: string; volatilityType: SabrVolatilityType; backbone: 'sabr'; shift: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { backbone: 'sabr'; conventionsVersion: string; shift: number; volatilityType: SabrVolatilityType; }; default: not declared - assumptions.backbone: 'sabr'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.shift: number; default: not declared - assumptions.volatilityType: SabrVolatilityType; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - expiries: number[]; default: not declared — Unique expiries, ascending. - nodes: CalibratedSwaptionNode[]; default: not declared — Calibrated nodes, sorted by `(expiry, tenor)`. - shift?: number; default: not declared — The rate displacement applied inside SABR (`0` for plain SABR). Nodes' `forward` fields stay the real (unshifted) rates; the shift lives only in the SABR calibration/evaluation. {@link swaptionCubeVolatility} reads this off the cube. OPTIONAL because legacy (pre-shift) serialized cubes carry no field — evaluation reads an absent shift as `0`; the declaration used to say required while the runtime documented that default, and the 3B.1b spec convicted the mismatch (the TA lesson: when the runtime is right, the DECLARATION is what lies). - tenors: number[]; default: not declared — Unique tenors, ascending. - volatilityType: SabrVolatilityType; default: not declared ### @insiderfinance/totalfinance/volatility#SwaptionCubeInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link swaptionCube}. ```typescript /** Input for {@link swaptionCube}. */ export interface SwaptionCubeInput { nodes: SwaptionCubeNode[]; /** Default backbone β for every node's calibration (0.5, the rates convention). */ beta?: number; /** Volatility quote convention: `'lognormal'` (Black, default) or `'normal'` (Bachelier). */ volatilityType?: SabrVolatilityType; /** * Rate displacement `s ≥ 0` for **shifted (displaced) SABR** — SABR is lognormal and needs * `forward, strike > 0`, so a negative-rate cube must be calibrated on `forward + s` / `strike + s`. * Default `0` (plain SABR). With `s > 0` the `'lognormal'` volatilities are *shifted*-lognormal — price with * Black on the shifted rates, `annuity · Black(forward + s, strike + s, vol, expiry)`; `'normal'` * (Bachelier) volatilities are unchanged (a common shift cancels in `forward − strike`). See * `docs/specs/swaption-cube-shift.md`. */ shift?: number; /** `calibrateSabrSmile` iteration cap (pass-through). */ maximumIterations?: number; /** `calibrateSabrSmile` tolerance (pass-through). */ tolerance?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beta?: number; default: not declared — Default backbone β for every node's calibration (0.5, the rates convention). - maximumIterations?: number; default: not declared — `calibrateSabrSmile` iteration cap (pass-through). - nodes: SwaptionCubeNode[]; default: not declared - shift?: number; default: not declared — Rate displacement `s ≥ 0` for **shifted (displaced) SABR** — SABR is lognormal and needs `forward, strike > 0`, so a negative-rate cube must be calibrated on `forward + s` / `strike + s`. Default `0` (plain SABR). With `s > 0` the `'lognormal'` volatilities are *shifted*-lognormal — price with Black on the shifted rates, `annuity · Black(forward + s, strike + s, vol, expiry)`; `'normal'` (Bachelier) volatilities are unchanged (a common shift cancels in `forward − strike`). See `docs/specs/swaption-cube-shift.md`. - tolerance?: number; default: not declared — `calibrateSabrSmile` tolerance (pass-through). - volatilityType?: SabrVolatilityType; default: not declared — Volatility quote convention: `'lognormal'` (Black, default) or `'normal'` (Bachelier). ### @insiderfinance/totalfinance/volatility#SwaptionCubeNode Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One market `(expiry, tenor)` node: a forward swap rate and a smile. ```typescript /** One market `(expiry, tenor)` node: a forward swap rate and a smile. */ export interface SwaptionCubeNode { /** Option expiry in years. */ expiryYears: number; /** Underlying swap tenor in years. */ tenorYears: number; /** Forward swap rate for this node (the SABR forward). */ forward: number; /** Absolute strike rates (≥ 3), aligned to `volatilities`. */ strikes: number[]; /** Market implied volatilities aligned to `strikes`. */ volatilities: number[]; /** Per-node backbone β override (else the cube default). */ beta?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - beta?: number; default: not declared — Per-node backbone β override (else the cube default). - expiryYears: number; default: not declared — Option expiry in years. - forward: number; default: not declared — Forward swap rate for this node (the SABR forward). - strikes: number[]; default: not declared — Absolute strike rates (≥ 3), aligned to `volatilities`. - tenorYears: number; default: not declared — Underlying swap tenor in years. - volatilities: number[]; default: not declared — Market implied volatilities aligned to `strikes`. ### @insiderfinance/totalfinance/volatility#SwaptionCubeVolatilityQuery Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Query for {@link swaptionCubeVolatility}. ```typescript // --------------------------------------------------------------------------------------------------- // Evaluation // --------------------------------------------------------------------------------------------------- /** Query for {@link swaptionCubeVolatility}. */ export interface SwaptionCubeVolatilityQuery { cube: SwaptionCube; /** Option expiry in years. */ expiryYears: number; /** Underlying swap tenor in years. */ tenorYears: number; /** Absolute strike rate. */ strike: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - cube: SwaptionCube; default: not declared - cube.assumptions: { backbone: 'sabr'; conventionsVersion: string; shift: number; volatilityType: SabrVolatilityType; }; default: not declared - cube.assumptions.backbone: 'sabr'; default: not declared - cube.assumptions.conventionsVersion: string; default: not declared - cube.assumptions.shift: number; default: not declared - cube.assumptions.volatilityType: SabrVolatilityType; default: not declared - cube.diagnostics: Diagnostics; default: not declared - cube.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - cube.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - cube.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - cube.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - cube.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - cube.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - cube.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - cube.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - cube.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - cube.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - cube.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - cube.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - cube.diagnostics.selection.selected.name: string; default: not declared - cube.diagnostics.selection.selected.version?: string; default: not declared - cube.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - cube.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - cube.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - cube.expiries: number[]; default: not declared — Unique expiries, ascending. - cube.nodes: CalibratedSwaptionNode[]; default: not declared — Calibrated nodes, sorted by `(expiry, tenor)`. - cube.shift?: number; default: not declared — The rate displacement applied inside SABR (`0` for plain SABR). Nodes' `forward` fields stay the real (unshifted) rates; the shift lives only in the SABR calibration/evaluation. {@link swaptionCubeVolatility} reads this off the cube. OPTIONAL because legacy (pre-shift) serialized cubes carry no field — evaluation reads an absent shift as `0`; the declaration used to say required while the runtime documented that default, and the 3B.1b spec convicted the mismatch (the TA lesson: when the runtime is right, the DECLARATION is what lies). - cube.tenors: number[]; default: not declared — Unique tenors, ascending. - cube.volatilityType: SabrVolatilityType; default: not declared - expiryYears: number; default: not declared — Option expiry in years. - strike: number; default: not declared — Absolute strike rate. - tenorYears: number; default: not declared — Underlying swap tenor in years. ### @insiderfinance/totalfinance/volatility#SwaptionCubeVolatilityResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The interpolated implied vol at a cube point. ```typescript /** The interpolated implied vol at a cube point. */ export interface SwaptionCubeVolatilityResult { /** Interpolated implied vol. */ value: number; /** Interpolated forward swap rate. */ forward: number; /** The interpolated SABR parameters used. */ parameters: SabrParameters; /** Whether the query fell outside the `(expiry, tenor)` grid (clamped to the edge). */ extrapolated: boolean; assumptions: { conventionsVersion: string; volatilityType: SabrVolatilityType; interpolation: 'bilinear-parameters'; /** The cube's rate shift, echoed so the caller prices with the matching (shifted) convention. */ shift: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; interpolation: 'bilinear-parameters'; shift: number; volatilityType: SabrVolatilityType; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.interpolation: 'bilinear-parameters'; default: not declared - assumptions.shift: number; default: not declared — The cube's rate shift, echoed so the caller prices with the matching (shifted) convention. - assumptions.volatilityType: SabrVolatilityType; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - extrapolated: boolean; default: not declared — Whether the query fell outside the `(expiry, tenor)` grid (clamped to the edge). - forward: number; default: not declared — Interpolated forward swap rate. - parameters: SabrParameters; default: not declared — The interpolated SABR parameters used. - parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - value: number; default: not declared — Interpolated implied vol. ### @insiderfinance/totalfinance/volatility#TailRiskOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link tailRiskIndex}. ```typescript /** Inputs for {@link tailRiskIndex}. */ export interface TailRiskOptions { quotes: readonly OptionQuote[]; spot: number; riskFreeRate: number; asOf: number | string; /** Constant-maturity target in calendar days. Default 30 (CBOE SKEW). */ horizonDays?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (CBOE SKEW). - quotes: readonly OptionQuote[]; default: not declared - riskFreeRate: number; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/volatility#TailRiskResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The tail-risk read-out. ```typescript /** The tail-risk read-out. */ export interface TailRiskResult { /** Constant-maturity SKEW value (> 100 ⇒ elevated crash risk), interpolated to `horizonDays`. */ skewIndex: number; /** Constant-maturity risk-neutral skewness. */ skewness: number; /** Constant-maturity risk-neutral excess kurtosis. */ excessKurtosis: number; horizonDays: number; /** Per-expiry moments — the whole tail-risk term structure, ascending by DTE. */ termStructure: ExpiryTailRisk[]; /** The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). */ interpolatedBetween?: { near: string; far: string; }; assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.horizonDays: number; default: not declared - assumptions.measure: 'risk-neutral'; default: not declared - assumptions.method: string; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - excessKurtosis: number; default: not declared — Constant-maturity risk-neutral excess kurtosis. - horizonDays: number; default: not declared - interpolatedBetween?: { far: string; near: string; }; default: not declared — The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). - interpolatedBetween.far: string; default: not declared - interpolatedBetween.near: string; default: not declared - skewIndex: number; default: not declared — Constant-maturity SKEW value (> 100 ⇒ elevated crash risk), interpolated to `horizonDays`. - skewness: number; default: not declared — Constant-maturity risk-neutral skewness. - termStructure: ExpiryTailRisk[]; default: not declared — Per-expiry moments — the whole tail-risk term structure, ascending by DTE. ### @insiderfinance/totalfinance/volatility#VannaVolga5Density Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The 5-pillar-implied risk-neutral terminal distribution and its moments. ```typescript /** The 5-pillar-implied risk-neutral terminal distribution and its moments. */ export interface VannaVolga5Density { /** Risk-neutral (T-forward-measure) PDF at strike `K`, `∂²C/∂K²` (clamped ≥ 0). */ density(strike: number): number; /** Risk-neutral CDF `P(S_T ≤ K) = 1 + ∂C/∂K` (clamped to [0, 1]). */ cdf(strike: number): number; probabilityBelow(strike: number): number; probabilityAbove(strike: number): number; probabilityBetween(lowerStrike: number, upperStrike: number): number; /** Strike at CDF = `p` (inverse CDF via bisection); `p ∈ (0, 1)`. */ quantile(probability: number): number; /** The sampled grid the moments and quantiles are integrated on. */ grid: { strikes: number[]; density: number[]; cdf: number[]; }; moments: { /** `∫f dK` — total captured probability mass, ≈ 1. */ totalMass: number; /** `∫K·f dK` — the risk-neutral mean, ≈ forward by the martingale property. */ mean: number; variance: number; stdev: number; skewness: number; excessKurtosis: number; }; /** The five market pillars the underlying smile reprices exactly, low → high strike. */ pillars: VannaVolga5Pillar[]; innerDelta: number; outerDelta: number; assumptions: { conventionsVersion: string; method: 'breeden-litzenberger'; smile: 'vanna-volga-5'; measure: 'risk-neutral-forward'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'breeden-litzenberger'; smile: 'vanna-volga-5'; measure: 'risk-neutral-forward'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.measure: 'risk-neutral-forward'; default: not declared - assumptions.method: 'breeden-litzenberger'; default: not declared - assumptions.smile: 'vanna-volga-5'; default: not declared - cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + ∂C/∂K` (clamped to [0, 1]). - cdf(strike): number; default: not declared - density: (strike: number) => number; default: not declared — Risk-neutral (T-forward-measure) PDF at strike `K`, `∂²C/∂K²` (clamped ≥ 0). - density(strike): number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - grid: { strikes: number[]; density: number[]; cdf: number[]; }; default: not declared — The sampled grid the moments and quantiles are integrated on. - grid.cdf: number[]; default: not declared - grid.density: number[]; default: not declared - grid.strikes: number[]; default: not declared - innerDelta: number; default: not declared - moments: { totalMass: number; mean: number; variance: number; stdev: number; skewness: number; excessKurtosis: number; }; default: not declared - moments.excessKurtosis: number; default: not declared - moments.mean: number; default: not declared — `∫K·f dK` — the risk-neutral mean, ≈ forward by the martingale property. - moments.skewness: number; default: not declared - moments.stdev: number; default: not declared - moments.totalMass: number; default: not declared — `∫f dK` — total captured probability mass, ≈ 1. - moments.variance: number; default: not declared - outerDelta: number; default: not declared - pillars: VannaVolga5Pillar[]; default: not declared — The five market pillars the underlying smile reprices exactly, low → high strike. - probabilityAbove: (strike: number) => number; default: not declared - probabilityAbove(strike): number; default: not declared - probabilityBelow: (strike: number) => number; default: not declared - probabilityBelow(strike): number; default: not declared - probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared - probabilityBetween(lowerStrike): number; default: not declared - probabilityBetween(upperStrike): number; default: not declared - quantile: (probability: number) => number; default: not declared — Strike at CDF = `p` (inverse CDF via bisection); `p ∈ (0, 1)`. - quantile(probability): number; default: not declared ### @insiderfinance/totalfinance/volatility#VannaVolga5DensityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link vannaVolga5Density} — the five vanna-volga quotes plus the density grid controls. ```typescript // ──────────────────────────────────────────────────────────────────────────── // 5-pillar-implied risk-neutral density (Breeden–Litzenberger on the 5-pillar smile) // ──────────────────────────────────────────────────────────────────────────── /** Input for {@link vannaVolga5Density} — the five vanna-volga quotes plus the density grid controls. */ export interface VannaVolga5DensityInput extends Omit { /** Grid points for the sampled density / moments; an odd integer ≥ 11 (default 801). */ gridPoints?: number; /** Grid half-width in ATM standard deviations, `F·e^{±widthStandardDeviations·σ√T}` (default 6). */ widthStandardDeviations?: number; /** Central-difference step in strike for Breeden–Litzenberger (default `F·1e-3`). */ step?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared - butterfly10: number; default: not declared - butterfly25: number; default: not declared - forward: number; default: not declared - gridPoints?: number; default: not declared — Grid points for the sampled density / moments; an odd integer ≥ 11 (default 801). - innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - outerDelta?: number; default: not declared - riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - step?: number; default: not declared — Central-difference step in strike for Breeden–Litzenberger (default `F·1e-3`). - timeToExpiryYears: number; default: not declared - widthStandardDeviations?: number; default: not declared — Grid half-width in ATM standard deviations, `F·e^{±widthStandardDeviations·σ√T}` (default 6). ### @insiderfinance/totalfinance/volatility#VannaVolga5Input Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link calibrateVannaVolga5}. ```typescript // ──────────────────────────────────────────────────────────────────────────── // 5-pillar (10Δ) vanna-volga smile — exact-repricing PCHIP through 5 anchors // ──────────────────────────────────────────────────────────────────────────── /** Input for {@link calibrateVannaVolga5}. */ export interface VannaVolga5Input { forward: number; timeToExpiryYears: number; atmVolatility: number; /** 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. */ riskReversal25: number; butterfly25: number; /** 10-delta risk reversal and butterfly. */ riskReversal10: number; butterfly10: number; /** Inner / outer wing deltas. Defaults 0.25 / 0.10. */ innerDelta?: number; outerDelta?: number; /** Wing extrapolation beyond the 10Δ pillars, in total variance: `flat` (default) or `linear`. */ wingExtrapolation?: 'flat' | 'linear'; /** Strikes to evaluate the smile at. */ strikes: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared - butterfly10: number; default: not declared - butterfly25: number; default: not declared - forward: number; default: not declared - innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - outerDelta?: number; default: not declared - riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - strikes: number[]; default: not declared — Strikes to evaluate the smile at. - timeToExpiryYears: number; default: not declared - wingExtrapolation?: 'flat' | 'linear'; default: not declared — Wing extrapolation beyond the 10Δ pillars, in total variance: `flat` (default) or `linear`. ### @insiderfinance/totalfinance/volatility#VannaVolga5Pillar Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One of the five market pillars a {@link VannaVolga5Smile} reprices exactly. ```typescript /** One of the five market pillars a {@link VannaVolga5Smile} reprices exactly. */ export interface VannaVolga5Pillar { strike: number; volatility: number; delta: number; kind: 'put' | 'atm' | 'call'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - delta: number; default: not declared - kind: 'call' | 'put' | 'atm'; default: not declared - strike: number; default: not declared - volatility: number; default: not declared ### @insiderfinance/totalfinance/volatility#VannaVolga5Smile Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The 5-pillar smile and the pillars it reprices. ```typescript /** The 5-pillar smile and the pillars it reprices. */ export interface VannaVolga5Smile { strikes: number[]; volatilities: number[]; /** The five market pillars the smile reprices exactly, low → high strike. */ pillars: VannaVolga5Pillar[]; innerDelta: number; outerDelta: number; assumptions: { conventionsVersion: string; method: 'vanna-volga-5'; deltaConvention: 'forward'; interpolation: 'pchip-total-variance'; wingExtrapolation: 'flat' | 'linear'; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; deltaConvention: 'forward'; interpolation: 'pchip-total-variance'; method: 'vanna-volga-5'; wingExtrapolation: 'flat' | 'linear'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.deltaConvention: 'forward'; default: not declared - assumptions.interpolation: 'pchip-total-variance'; default: not declared - assumptions.method: 'vanna-volga-5'; default: not declared - assumptions.wingExtrapolation: 'flat' | 'linear'; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - innerDelta: number; default: not declared - outerDelta: number; default: not declared - pillars: VannaVolga5Pillar[]; default: not declared — The five market pillars the smile reprices exactly, low → high strike. - strikes: number[]; default: not declared - volatilities: number[]; default: not declared ### @insiderfinance/totalfinance/volatility#VannaVolgaApproximationInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link vannaVolgaApproximation} — the vanna-volga input plus the CM order. ```typescript // ──────────────────────────────────────────────────────────────────────────── // Castagna–Mercurio (2007) closed-form approximation // ──────────────────────────────────────────────────────────────────────────── /** Input for {@link vannaVolgaApproximation} — the vanna-volga input plus the CM order. */ export interface VannaVolgaApproximationInput extends VannaVolgaInput { /** * Castagna–Mercurio order: `1` (a quadratic interpolation of the three volatilities in log-strike) or `2` * (curvature-corrected; the accurate, market-standard form — default). */ order?: 1 | 2; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared — ATM vol. - butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - forward: number; default: not declared — Forward price of the underlying. - order?: 1 | 2; default: not declared — Castagna–Mercurio order: `1` (a quadratic interpolation of the three volatilities in log-strike) or `2` (curvature-corrected; the accurate, market-standard form — default). - riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#VannaVolgaApproximationSmile Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The Castagna–Mercurio-approximated smile and the pillars it reprices. ```typescript /** The Castagna–Mercurio-approximated smile and the pillars it reprices. */ export interface VannaVolgaApproximationSmile { strikes: number[]; volatilities: number[]; pillars: { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; }; delta: number; order: 1 | 2; assumptions: { conventionsVersion: string; method: 'castagna-mercurio'; deltaConvention: 'forward'; delta: number; order: 1 | 2; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'castagna-mercurio'; deltaConvention: 'forward'; delta: number; order: 1 | 2; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.delta: number; default: not declared - assumptions.deltaConvention: 'forward'; default: not declared - assumptions.method: 'castagna-mercurio'; default: not declared - assumptions.order: 1 | 2; default: not declared - delta: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - order: 1 | 2; default: not declared - pillars: { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; }; default: not declared - pillars.atmStrike: number; default: not declared - pillars.atmVolatility: number; default: not declared - pillars.callStrike: number; default: not declared - pillars.callVolatility: number; default: not declared - pillars.putStrike: number; default: not declared - pillars.putVolatility: number; default: not declared - strikes: number[]; default: not declared - volatilities: number[]; default: not declared ### @insiderfinance/totalfinance/volatility#VannaVolgaDensity Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The vanna-volga-implied risk-neutral terminal distribution and its moments. ```typescript /** The vanna-volga-implied risk-neutral terminal distribution and its moments. */ export interface VannaVolgaDensity { /** Risk-neutral (T-forward-measure) PDF at strike `K`, `∂²C/∂K²` (clamped ≥ 0). */ density(strike: number): number; /** Risk-neutral CDF `P(S_T ≤ K) = 1 + ∂C/∂K` (clamped to [0, 1]). */ cdf(strike: number): number; probabilityBelow(strike: number): number; probabilityAbove(strike: number): number; probabilityBetween(lowerStrike: number, upperStrike: number): number; /** Strike at CDF = `p` (inverse CDF via bisection); `p ∈ (0, 1)`. */ quantile(probability: number): number; /** The sampled grid the moments and quantiles are integrated on. */ grid: { strikes: number[]; density: number[]; cdf: number[]; }; moments: { /** `∫f dK` — total captured probability mass, ≈ 1. */ totalMass: number; /** `∫K·f dK` — the risk-neutral mean, ≈ forward by the martingale property. */ mean: number; variance: number; stdev: number; skewness: number; excessKurtosis: number; }; pillars: { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; }; order: 1 | 2; assumptions: { conventionsVersion: string; method: 'breeden-litzenberger'; smile: 'castagna-mercurio'; measure: 'risk-neutral-forward'; order: 1 | 2; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; method: 'breeden-litzenberger'; smile: 'castagna-mercurio'; measure: 'risk-neutral-forward'; order: 1 | 2; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.measure: 'risk-neutral-forward'; default: not declared - assumptions.method: 'breeden-litzenberger'; default: not declared - assumptions.order: 1 | 2; default: not declared - assumptions.smile: 'castagna-mercurio'; default: not declared - cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + ∂C/∂K` (clamped to [0, 1]). - cdf(strike): number; default: not declared - density: (strike: number) => number; default: not declared — Risk-neutral (T-forward-measure) PDF at strike `K`, `∂²C/∂K²` (clamped ≥ 0). - density(strike): number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - grid: { strikes: number[]; density: number[]; cdf: number[]; }; default: not declared — The sampled grid the moments and quantiles are integrated on. - grid.cdf: number[]; default: not declared - grid.density: number[]; default: not declared - grid.strikes: number[]; default: not declared - moments: { totalMass: number; mean: number; variance: number; stdev: number; skewness: number; excessKurtosis: number; }; default: not declared - moments.excessKurtosis: number; default: not declared - moments.mean: number; default: not declared — `∫K·f dK` — the risk-neutral mean, ≈ forward by the martingale property. - moments.skewness: number; default: not declared - moments.stdev: number; default: not declared - moments.totalMass: number; default: not declared — `∫f dK` — total captured probability mass, ≈ 1. - moments.variance: number; default: not declared - order: 1 | 2; default: not declared - pillars: { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; }; default: not declared - pillars.atmStrike: number; default: not declared - pillars.atmVolatility: number; default: not declared - pillars.callStrike: number; default: not declared - pillars.callVolatility: number; default: not declared - pillars.putStrike: number; default: not declared - pillars.putVolatility: number; default: not declared - probabilityAbove: (strike: number) => number; default: not declared - probabilityAbove(strike): number; default: not declared - probabilityBelow: (strike: number) => number; default: not declared - probabilityBelow(strike): number; default: not declared - probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared - probabilityBetween(lowerStrike): number; default: not declared - probabilityBetween(upperStrike): number; default: not declared - quantile: (probability: number) => number; default: not declared — Strike at CDF = `p` (inverse CDF via bisection); `p ∈ (0, 1)`. - quantile(probability): number; default: not declared ### @insiderfinance/totalfinance/volatility#VannaVolgaDensityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link vannaVolgaDensity} — the vanna-volga quotes plus the density grid controls. ```typescript // ──────────────────────────────────────────────────────────────────────────── // Vanna–volga-implied risk-neutral density (Breeden–Litzenberger on the CM smile) // ──────────────────────────────────────────────────────────────────────────── /** Input for {@link vannaVolgaDensity} — the vanna-volga quotes plus the density grid controls. */ export interface VannaVolgaDensityInput extends Omit { /** Castagna–Mercurio order for the underlying smile: `1` or `2` (default). */ order?: 1 | 2; /** Grid points for the sampled density / moments; an odd integer ≥ 11 (default 801). */ gridPoints?: number; /** Grid half-width in ATM standard deviations, `F·e^{±widthStandardDeviations·σ√T}` (default 6, capturing ≈ all mass). */ widthStandardDeviations?: number; /** Central-difference step in strike for Breeden–Litzenberger (default `F·1e-3`). */ step?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared — ATM vol. - butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - forward: number; default: not declared — Forward price of the underlying. - gridPoints?: number; default: not declared — Grid points for the sampled density / moments; an odd integer ≥ 11 (default 801). - order?: 1 | 2; default: not declared — Castagna–Mercurio order for the underlying smile: `1` or `2` (default). - riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - step?: number; default: not declared — Central-difference step in strike for Breeden–Litzenberger (default `F·1e-3`). - timeToExpiryYears: number; default: not declared — Time to expiry in years. - widthStandardDeviations?: number; default: not declared — Grid half-width in ATM standard deviations, `F·e^{±widthStandardDeviations·σ√T}` (default 6, capturing ≈ all mass). ### @insiderfinance/totalfinance/volatility#VannaVolgaInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link calibrateVannaVolga}. ```typescript /** Input for {@link calibrateVannaVolga}. */ export interface VannaVolgaInput { /** Forward price of the underlying. */ forward: number; /** Time to expiry in years. */ timeToExpiryYears: number; /** ATM vol. */ atmVolatility: number; /** δ-delta risk reversal (`callVolatility − putVolatility`). */ riskReversal: number; /** δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). */ butterfly: number; /** Delta level for the pillars. Default 0.25. */ delta?: number; /** Strikes to evaluate the constructed smile at. */ strikes: number[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - atmVolatility: number; default: not declared — ATM vol. - butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - forward: number; default: not declared — Forward price of the underlying. - riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - timeToExpiryYears: number; default: not declared — Time to expiry in years. ### @insiderfinance/totalfinance/volatility#VannaVolgaSmile Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The vanna–volga-constructed smile and the pillars it reprices. ```typescript /** The vanna–volga-constructed smile and the pillars it reprices. */ export interface VannaVolgaSmile { /** Requested strikes. */ strikes: number[]; /** The constructed vol at each strike (aligned to `strikes`). */ volatilities: number[]; /** The three market pillars the smile reprices exactly. */ pillars: { putStrike: number; putVolatility: number; atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; }; delta: number; assumptions: { conventionsVersion: string; method: 'vanna-volga'; deltaConvention: 'forward'; delta: number; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; method: 'vanna-volga'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.delta: number; default: not declared - assumptions.deltaConvention: 'forward'; default: not declared - assumptions.method: 'vanna-volga'; default: not declared - delta: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - pillars: { atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; putStrike: number; putVolatility: number; }; default: not declared — The three market pillars the smile reprices exactly. - pillars.atmStrike: number; default: not declared - pillars.atmVolatility: number; default: not declared - pillars.callStrike: number; default: not declared - pillars.callVolatility: number; default: not declared - pillars.putStrike: number; default: not declared - pillars.putVolatility: number; default: not declared - strikes: number[]; default: not declared — Requested strikes. - volatilities: number[]; default: not declared — The constructed vol at each strike (aligned to `strikes`). ### @insiderfinance/totalfinance/volatility#VarianceIndexOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link varianceIndex}. ```typescript /** Inputs for {@link varianceIndex}. */ export interface VarianceIndexOptions { /** Option chain across ≥ 1 expiries — call + put quotes with a usable mid. */ quotes: readonly OptionQuote[]; spot: number; riskFreeRate: number; asOf: EpochMs | string; /** Constant-maturity target in calendar days. Default 30 (VIX). */ horizonDays?: number; /** Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). */ dividendYield?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - dividendYield?: number; default: not declared — Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). - horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (VIX). - quotes: readonly OptionQuote[]; default: not declared — Option chain across ≥ 1 expiries — call + put quotes with a usable mid. - riskFreeRate: number; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/volatility#VarianceIndexResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The variance-index read-out. ```typescript /** The variance-index read-out. */ export interface VarianceIndexResult { /** Constant-maturity model-free vol in VIX-style points (e.g. 20.0 = 20% annualized). */ index: number; /** Constant-maturity annualized fair variance (decimal). */ variance: number; /** Constant-maturity fair vol as a decimal (`index / 100`). */ fairVolatility: number; horizonDays: number; /** Per-expiry fair variance/vol — the whole term structure, ascending by DTE. */ termStructure: ExpiryVariance[]; /** The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). */ interpolatedBetween?: { near: string; far: string; }; assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.horizonDays: number; default: not declared - assumptions.measure: 'risk-neutral'; default: not declared - assumptions.method: string; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - fairVolatility: number; default: not declared — Constant-maturity fair vol as a decimal (`index / 100`). - horizonDays: number; default: not declared - index: number; default: not declared — Constant-maturity model-free vol in VIX-style points (e.g. 20.0 = 20% annualized). - interpolatedBetween?: { far: string; near: string; }; default: not declared — The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). - interpolatedBetween.far: string; default: not declared - interpolatedBetween.near: string; default: not declared - termStructure: ExpiryVariance[]; default: not declared — Per-expiry fair variance/vol — the whole term structure, ascending by DTE. - variance: number; default: not declared — Constant-maturity annualized fair variance (decimal). ### @insiderfinance/totalfinance/volatility#VarianceRiskPremiumPoint Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One expiry's variance-risk-premium point. ```typescript /** One expiry's variance-risk-premium point. */ export interface VarianceRiskPremiumPoint extends ExpiryVariance { realizedVolatility: number; /** `iv² − rv²` (annualized) — the variance risk premium. */ varianceRiskPremium: number; /** `iv − rv` — the vol-point spread. */ volatilitySpread: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - daysToExpiry: number; default: not declared — Calendar days to expiry. - expiry: string; default: not declared - fairVolatility: number; default: not declared — `√variance` — model-free implied vol (decimal, e.g. 0.20). - forward: number; default: not declared — Parity forward. - realizedVolatility: number; default: not declared - strikesUsed: number; default: not declared — OTM strikes used in the replication. - timeToExpiryYears: number; default: not declared — Year fraction (ACT/365F). - variance: number; default: not declared — Annualized fair variance (decimal). - varianceRiskPremium: number; default: not declared — `iv² − rv²` (annualized) — the variance risk premium. - volatilitySpread: number; default: not declared — `iv − rv` — the vol-point spread. ### @insiderfinance/totalfinance/volatility#VarianceRiskPremiumTermStructureOptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Inputs for {@link varianceRiskPremiumTermStructure}. ```typescript /** Inputs for {@link varianceRiskPremiumTermStructure}. */ export interface VarianceRiskPremiumTermStructureOptions extends VarianceIndexOptions { /** Realized vol to compare (decimal): one number for the whole curve, or per-expiry by ISO date. */ realizedVolatility: number | Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - asOf: string | number; default: not declared - dividendYield?: number; default: not declared — Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). - horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (VIX). - quotes: readonly OptionQuote[]; default: not declared — Option chain across ≥ 1 expiries — call + put quotes with a usable mid. - realizedVolatility: number | Record; default: not declared — Realized vol to compare (decimal): one number for the whole curve, or per-expiry by ISO date. - riskFreeRate: number; default: not declared - spot: number; default: not declared ### @insiderfinance/totalfinance/volatility#VarianceRiskPremiumTermStructureResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The VRP term-structure read-out. ```typescript /** The VRP term-structure read-out. */ export interface VarianceRiskPremiumTermStructureResult { points: VarianceRiskPremiumPoint[]; /** VRP at the constant-maturity index vs the reference realized vol. */ indexVarianceRiskPremium: number; assumptions: { conventionsVersion: string; measure: 'risk-neutral'; method: string; }; diagnostics: Diagnostics; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; measure: 'risk-neutral'; method: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.measure: 'risk-neutral'; default: not declared - assumptions.method: string; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - indexVarianceRiskPremium: number; default: not declared — VRP at the constant-maturity index vs the reference realized vol. - points: VarianceRiskPremiumPoint[]; default: not declared ### @insiderfinance/totalfinance/volatility#VarianceSwapResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── variance-swap / VIX-style fair vol ───────────────────────── export interface VarianceSwapResult { /** Fair variance (annualized) from the model-free replication. */ variance: number; /** Fair volatility `√variance` — the VIX-style model-free implied vol. */ fairVolatility: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - fairVolatility: number; default: not declared — Fair volatility `√variance` — the VIX-style model-free implied vol. - variance: number; default: not declared — Fair variance (annualized) from the model-free replication. ### @insiderfinance/totalfinance/volatility#VolatilityConeAssumptions Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The conventions `volatilityCone.explain` echoes: the applied windows and annualization. ```typescript /** The conventions `volatilityCone.explain` echoes: the applied windows and annualization. */ export interface VolatilityConeAssumptions { conventionsVersion: string; /** The requested lookback windows, echoed in request order (one cone row each). */ windows: number[]; /** The applied annualization periods (`options.periodsPerYear`, default 252). */ periodsPerYear: number; /** Realized vol is the rolling stddev of returns scaled by `√periodsPerYear`. */ annualization: 'sqrt-periods-per-year'; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annualization: 'sqrt-periods-per-year'; default: not declared — Realized vol is the rolling stddev of returns scaled by `√periodsPerYear`. - conventionsVersion: string; default: not declared - periodsPerYear: number; default: not declared — The applied annualization periods (`options.periodsPerYear`, default 252). - windows: number[]; default: not declared — The requested lookback windows, echoed in request order (one cone row each). ### @insiderfinance/totalfinance/volatility#VolatilityConeFacade Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type VolatilityConeFacade = ((returns: ArrayLike, options: { windows: number[]; periodsPerYear?: number; }) => VolatilityConeWindow[]) & { explain: (returns: ArrayLike, options: { windows: number[]; periodsPerYear?: number; }) => Omit, 'assumptions'> & { assumptions: VolatilityConeAssumptions; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { periodsPerYear?: number; windows: number[]; }; default: not declared - (options).periodsPerYear?: number; default: not declared - (options).windows: number[]; default: not declared - (returns): ArrayLike; default: not declared - explain: (returns: ArrayLike, options: { windows: number[]; periodsPerYear?: number; }) => Omit, 'assumptions'> & { assumptions: VolatilityConeAssumptions; }; default: not declared - explain().return.assumptions: VolatilityConeAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: VolatilityConeWindow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(options): { periodsPerYear?: number; windows: number[]; }; default: not declared - explain(options).periodsPerYear?: number; default: not declared - explain(options).windows: number[]; default: not declared - explain(returns): ArrayLike; default: not declared ### @insiderfinance/totalfinance/volatility#VolatilityConeWindow Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ───────────────────────── realized-volatility cone ───────────────────────── export interface VolatilityConeWindow { /** Lookback length (number of returns) for this row. */ window: number; min: number; p25: number; median: number; p75: number; max: number; /** Annualized realized vol of the most recent `window` returns (the "current" reading). */ current: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - current: number; default: not declared — Annualized realized vol of the most recent `window` returns (the "current" reading). - max: number; default: not declared - median: number; default: not declared - min: number; default: not declared - p25: number; default: not declared - p75: number; default: not declared - window: number; default: not declared — Lookback length (number of returns) for this row. ### @insiderfinance/totalfinance/volatility#VolatilitySpotBeta Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The empirical vol–spot β and its regression diagnostics. ```typescript /** The empirical vol–spot β and its regression diagnostics. */ export interface VolatilitySpotBeta { /** * `β = ∂σ/∂S` in decimal vol **per $1 of spot** — feed straight to * `minimumVarianceDelta({ volatilitySpotBeta })`, which expects the same per-dollar units. * * Units matter here: `stickyRegime` reports `volatilitySpotBetaPerLogSpot` = `∂σ/∂lnS` (per 100% * spot move), which is `S ×` this number. On a `'log'` basis the conversion is done for you * (`slope / referenceSpot`); {@link slope} is the raw regression coefficient in its own basis. */ volatilitySpotBeta: number; /** The regression slope: `∂σ/∂ln S` (`'log'`) or `∂σ/∂S` (`'level'`). */ slope: number; /** Standard error of the slope. */ slopeStandardError: number; /** t-statistic of the slope. */ slopeTStatistic: number; /** Correlation of the IV change with the spot-change regressor (leverage ⇒ negative). */ correlation: number; /** Coefficient of determination `R²`. */ rSquared: number; /** Change observations used (after dropping bad pairs). */ observationCount: number; /** Dropped (non-finite / non-positive) change observations. */ dropped: number; /** Reference spot used for the `∂σ/∂S` conversion. */ referenceSpot: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - correlation: number; default: not declared — Correlation of the IV change with the spot-change regressor (leverage ⇒ negative). - dropped: number; default: not declared — Dropped (non-finite / non-positive) change observations. - observationCount: number; default: not declared — Change observations used (after dropping bad pairs). - rSquared: number; default: not declared — Coefficient of determination `R²`. - referenceSpot: number; default: not declared — Reference spot used for the `∂σ/∂S` conversion. - slope: number; default: not declared — The regression slope: `∂σ/∂ln S` (`'log'`) or `∂σ/∂S` (`'level'`). - slopeStandardError: number; default: not declared — Standard error of the slope. - slopeTStatistic: number; default: not declared — t-statistic of the slope. - volatilitySpotBeta: number; default: not declared — `β = ∂σ/∂S` in decimal vol **per $1 of spot** — feed straight to `minimumVarianceDelta({ volatilitySpotBeta })`, which expects the same per-dollar units. Units matter here: `stickyRegime` reports `volatilitySpotBetaPerLogSpot` = `∂σ/∂lnS` (per 100% spot move), which is `S ×` this number. On a `'log'` basis the conversion is done for you (`slope / referenceSpot`); {@link slope} is the raw regression coefficient in its own basis. ### @insiderfinance/totalfinance/volatility#VolatilitySpotBetaInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Input for {@link estimateVolatilitySpotBeta}. ```typescript /** Input for {@link estimateVolatilitySpotBeta}. */ export interface VolatilitySpotBetaInput { /** Chronological spot prices. */ spot: number[]; /** The option's implied vol (decimal), aligned to `spot`. */ impliedVolatility: number[]; /** Regress IV changes on log-returns (`'log'`, default) or dollar spot changes (`'level'`). */ basis?: 'log' | 'level'; /** Reference spot to convert a log-basis slope to `∂σ/∂S` (default: the latest spot). */ referenceSpot?: number; /** Newey–West HAC bandwidth for autocorrelation-robust errors. Default 0 uses classical standard errors (no HAC request). */ hacLags?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - basis?: 'log' | 'level'; default: not declared — Regress IV changes on log-returns (`'log'`, default) or dollar spot changes (`'level'`). - hacLags?: number; default: not declared — Newey–West HAC bandwidth for autocorrelation-robust errors. Default 0 uses classical standard errors (no HAC request). - impliedVolatility: number[]; default: not declared — The option's implied vol (decimal), aligned to `spot`. - referenceSpot?: number; default: not declared — Reference spot to convert a log-basis slope to `∂σ/∂S` (default: the latest spot). - spot: number[]; default: not declared — Chronological spot prices. ### @insiderfinance/totalfinance/volatility#VolatilitySurface Kind: class; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A fitted implied-volatility surface with diagnostics-bearing lookup. ```typescript export declare class VolatilitySurface { constructor(input: VolatilitySurfaceInput); static fromJSON(snapshot: VolatilitySurfaceSnapshot): VolatilitySurface; arbitrage(options?: ArbitrageCheckOptions): ArbitrageReport; readonly assumptions: Assumptions<{ shock?: SurfaceShock; }>; readonly diagnostics: Diagnostics; readonly essvi?: ESSVIParameters; expiries(): string[]; readonly heston?: HestonParameters; impliedVolatility(strike: number, expiry: string | number): number; impliedVolatilityByDelta(callDelta: number, expiry: string | number): number; impliedVolatilityByMoneyness(moneyness: number, expiry: string | number, options?: { forward?: boolean; }): number; lookup(strike: number, expiry: string | number): SurfaceLookup; readonly model: SurfaceModel; readonly points: SurfacePoint[]; shock(shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }): VolatilitySurface; slice(expiry: string | number): SurfaceSlice | undefined; readonly slices: SurfaceSlice[]; readonly ssvi?: SSVIParameters; toJSON(): VolatilitySurfaceSnapshot; toRows(): SurfaceRow[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VolatilitySurfaceInput; default: not declared - (input).config?: SurfaceConfig; default: not declared - (input).market: SurfaceMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - arbitrage: (options?: ArbitrageCheckOptions) => ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - arbitrage().return.arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - arbitrage().return.assumptions: { butterflyPoints: number; calendarPoints: number; conventionsVersion: string; step: number; tolerance: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - arbitrage().return.assumptions.butterflyPoints: number; default: not declared - arbitrage().return.assumptions.calendarPoints: number; default: not declared - arbitrage().return.assumptions.conventionsVersion: string; default: not declared - arbitrage().return.assumptions.step: number; default: not declared - arbitrage().return.assumptions.tolerance: number; default: not declared - arbitrage().return.checks: { butterfly: boolean; calendar: boolean; }; default: not declared — Per-check pass/fail summary. - arbitrage().return.checks.butterfly: boolean; default: not declared - arbitrage().return.checks.calendar: boolean; default: not declared - arbitrage().return.diagnostics: Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - arbitrage().return.violations: import('@insiderfinance/totalfinance/volatility').ArbitrageViolation[]; default: not declared - arbitrage(options)?: ArbitrageCheckOptions | undefined; default: not declared - arbitrage(options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - arbitrage(options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - arbitrage(options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - arbitrage(options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.shock?: SurfaceShock; default: not declared - assumptions.shock.parallel: number; default: not declared — Additive parallel shift applied to every stored IV (in vol points, e.g. `0.02` = +2 vol). - assumptions.shock.skewTilt: number; default: not declared — Skew rotation: adds `skewTilt · k` where `k = ln(K/forward)` (log-moneyness). - assumptions.shock.sticky: 'strike' | 'moneyness'; default: not declared — Which quantity the tilt is pinned to: `'strike'` (default) or `'moneyness'`. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - essvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - essvi.phi.eta: number; default: not declared - essvi.phi.gamma: number; default: not declared - essvi.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.phi.lambda: number; default: not declared - essvi.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - fromJSON: (snapshot: VolatilitySurfaceSnapshot) => VolatilitySurface; default: not declared — Rebuild a surface from a {@link VolatilitySurfaceSnapshot}. Rejects a `schemaVersion` mismatch (design law #4: never silently restore state a different build wrote). Interpolators are rebuilt via {@link buildSmile} from the stored slice parameters — never re-fitted — so the restored surface answers `iv()` identically to the one that produced the snapshot. - fromJSON().return.arbitrage: (options?: ArbitrageCheckOptions) => ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - fromJSON().return.assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - fromJSON().return.diagnostics: Diagnostics; default: not declared - fromJSON().return.essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - fromJSON().return.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - fromJSON().return.heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - fromJSON().return.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - fromJSON().return.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - fromJSON().return.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - fromJSON().return.lookup: (strike: number, expiry: string | number) => SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - fromJSON().return.model: SurfaceModel; default: not declared - fromJSON().return.points: SurfacePoint[]; default: not declared - fromJSON().return.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - fromJSON().return.slice: (expiry: string | number) => SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - fromJSON().return.slices: SurfaceSlice[]; default: not declared - fromJSON().return.ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - fromJSON().return.toJSON: () => VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - fromJSON().return.toRows: () => SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - fromJSON(snapshot): VolatilitySurfaceSnapshot; default: not declared - fromJSON(snapshot).assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - fromJSON(snapshot).config: { cosineExpansionTerms: number; dividendYield: number; riskFreeRate: number; sabrBeta: number; sabrVolatilityType: SabrVolatilityType; smoothingBandwidth?: number; }; default: not declared — Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. - fromJSON(snapshot).config.cosineExpansionTerms: number; default: not declared - fromJSON(snapshot).config.dividendYield: number; default: not declared - fromJSON(snapshot).config.riskFreeRate: number; default: not declared - fromJSON(snapshot).config.sabrBeta: number; default: not declared - fromJSON(snapshot).config.sabrVolatilityType: SabrVolatilityType; default: not declared - fromJSON(snapshot).config.smoothingBandwidth?: number; default: not declared - fromJSON(snapshot).diagnostics: Diagnostics; default: not declared - fromJSON(snapshot).essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`. - fromJSON(snapshot).heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`. - fromJSON(snapshot).model: SurfaceModel; default: not declared - fromJSON(snapshot).points: SurfacePoint[]; default: not declared - fromJSON(snapshot).referenceSpot: number; default: not declared - fromJSON(snapshot).schemaVersion: string; default: not declared - fromJSON(snapshot).slices: SurfaceSlice[]; default: not declared - fromJSON(snapshot).ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`. - heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - heston.kappa: number; default: not declared — Mean-reversion speed κ. - heston.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston.theta: number; default: not declared — Long-run variance θ. - heston.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - impliedVolatility(expiry): string | number; default: not declared - impliedVolatility(strike): number; default: not declared - impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - impliedVolatilityByDelta(callDelta): number; default: not declared - impliedVolatilityByDelta(expiry): string | number; default: not declared - impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - impliedVolatilityByMoneyness(expiry): string | number; default: not declared - impliedVolatilityByMoneyness(moneyness): number; default: not declared - impliedVolatilityByMoneyness(options)?: { forward?: boolean; }; default: not declared - impliedVolatilityByMoneyness(options).forward?: boolean; default: not declared - lookup: (strike: number, expiry: string | number) => SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - lookup().return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - lookup().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - lookup().return.extrapolated: boolean; default: not declared - lookup().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - lookup().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - lookup(expiry): string | number; default: not declared - lookup(strike): number; default: not declared - model: SurfaceModel; default: not declared - points: SurfacePoint[]; default: not declared - return.arbitrage: (options?: ArbitrageCheckOptions) => ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - return.assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - return.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - return.heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - return.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - return.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - return.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - return.lookup: (strike: number, expiry: string | number) => SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - return.model: SurfaceModel; default: not declared - return.points: SurfacePoint[]; default: not declared - return.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - return.slice: (expiry: string | number) => SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - return.slices: SurfaceSlice[]; default: not declared - return.ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - return.toJSON: () => VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - return.toRows: () => SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - shock(__1)?: { sticky?: 'strike' | 'moneyness'; }; default: not declared - shock(__1).sticky?: 'strike' | 'moneyness'; default: not declared - shock(shifts): { parallel?: number; skewTilt?: number; }; default: not declared - shock(shifts).parallel?: number; default: not declared - shock(shifts).skewTilt?: number; default: not declared - slice: (expiry: string | number) => SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - slice().return.deltas: number[]; default: not declared — Call-delta `e^{−qt}·N(d1)` at each strike (the smile's delta axis, for skew lookups). - slice().return.essvi?: ESSVIParameters; default: not declared — The globally-calibrated eSSVI parameters when `model: 'essvi'` (shared across all slices). - slice().return.expiry: string; default: not declared - slice().return.forward: number; default: not declared — Forward `S·e^{(r−q)t}`. - slice().return.heston?: HestonParameters; default: not declared — The globally-calibrated Heston parameters when `model: 'heston'` (shared across all slices). - slice().return.impliedVolatilities: number[]; default: not declared - slice().return.sabr?: SabrParameters; default: not declared — Fitted SABR parameters when `model: 'sabr'` (absent if the slice fell back to interpolation). - slice().return.ssvi?: SSVIParameters; default: not declared — The globally-calibrated SSVI parameters when `model: 'ssvi'` (shared across all slices). - slice().return.strikes: number[]; default: not declared - slice().return.svi?: SVIParameters; default: not declared — Fitted raw-SVI parameters when `model: 'svi'` (absent if the slice fell back to interpolation). - slice().return.timeToExpiryYears: number; default: not declared — Time to expiry in years (ACT/365F). - slice(expiry): string | number; default: not declared - slices: SurfaceSlice[]; default: not declared - ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - ssvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function. - ssvi.phi.eta: number; default: not declared - ssvi.phi.gamma: number; default: not declared - ssvi.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.phi.lambda: number; default: not declared - ssvi.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - ssvi.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - toJSON: () => VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - toJSON().return.assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - toJSON().return.config: { cosineExpansionTerms: number; dividendYield: number; riskFreeRate: number; sabrBeta: number; sabrVolatilityType: SabrVolatilityType; smoothingBandwidth?: number; }; default: not declared — Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. - toJSON().return.config.cosineExpansionTerms: number; default: not declared - toJSON().return.config.dividendYield: number; default: not declared - toJSON().return.config.riskFreeRate: number; default: not declared - toJSON().return.config.sabrBeta: number; default: not declared - toJSON().return.config.sabrVolatilityType: SabrVolatilityType; default: not declared - toJSON().return.config.smoothingBandwidth?: number; default: not declared - toJSON().return.diagnostics: Diagnostics; default: not declared - toJSON().return.essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`. - toJSON().return.heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`. - toJSON().return.model: SurfaceModel; default: not declared - toJSON().return.points: SurfacePoint[]; default: not declared - toJSON().return.referenceSpot: number; default: not declared - toJSON().return.schemaVersion: string; default: not declared - toJSON().return.slices: SurfaceSlice[]; default: not declared - toJSON().return.ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`. - toRows: () => SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). ### @insiderfinance/totalfinance/volatility#VolatilitySurfaceSnapshot Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A serialized surface (spec WS4.4). Carries the model, per-slice smile state (including any fitted `svi`/`sabr`/`heston` parameters), points, assumptions/diagnostics, the global Heston parameters, `spotRef`, and the config knobs needed to REBUILD interpolators. Closures are never serialized — {@link VolatilitySurface.fromJSON} rebuilds them from this state so the restored surface answers `iv()` identically. ```typescript /** * A serialized surface (spec WS4.4). Carries the model, per-slice smile state (including any fitted * `svi`/`sabr`/`heston` parameters), points, assumptions/diagnostics, the global Heston parameters, `spotRef`, * and the config knobs needed to REBUILD interpolators. Closures are never serialized — * {@link VolatilitySurface.fromJSON} rebuilds them from this state so the restored surface answers `iv()` * identically. */ export interface VolatilitySurfaceSnapshot { schemaVersion: string; model: SurfaceModel; slices: SurfaceSlice[]; points: SurfacePoint[]; assumptions: Assumptions<{ shock?: SurfaceShock; }>; diagnostics: Diagnostics; /** The global SSVI parameters when `model: 'ssvi'`. */ ssvi?: SSVIParameters; /** The global eSSVI parameters when `model: 'essvi'`. */ essvi?: ESSVIParameters; /** The global Heston parameters when `model: 'heston'`. */ heston?: HestonParameters; referenceSpot: number; /** Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. */ config: { riskFreeRate: number; dividendYield: number; sabrBeta: number; sabrVolatilityType: SabrVolatilityType; smoothingBandwidth?: number; cosineExpansionTerms: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - assumptions.asOf?: number; default: not declared - assumptions.calendar?: string; default: not declared - assumptions.calendarVersion?: string; default: not declared - assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - assumptions.compounding.periodsPerYear: number; default: not declared - assumptions.compounding.type: 'periodic'; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - assumptions.engine?: string; default: not declared - assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - assumptions.model?: string; default: not declared - assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - assumptions.shock?: SurfaceShock; default: not declared - assumptions.shock.parallel: number; default: not declared — Additive parallel shift applied to every stored IV (in vol points, e.g. `0.02` = +2 vol). - assumptions.shock.skewTilt: number; default: not declared — Skew rotation: adds `skewTilt · k` where `k = ln(K/forward)` (log-moneyness). - assumptions.shock.sticky: 'strike' | 'moneyness'; default: not declared — Which quantity the tilt is pinned to: `'strike'` (default) or `'moneyness'`. - assumptions.timeToExpiryConvention?: never; default: not declared - assumptions.timeToExpiryYears?: number; default: not declared - assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - config: { cosineExpansionTerms: number; dividendYield: number; riskFreeRate: number; sabrBeta: number; sabrVolatilityType: SabrVolatilityType; smoothingBandwidth?: number; }; default: not declared — Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. - config.cosineExpansionTerms: number; default: not declared - config.dividendYield: number; default: not declared - config.riskFreeRate: number; default: not declared - config.sabrBeta: number; default: not declared - config.sabrVolatilityType: SabrVolatilityType; default: not declared - config.smoothingBandwidth?: number; default: not declared - diagnostics: Diagnostics; default: not declared - diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - diagnostics.selection.selected.name: string; default: not declared - diagnostics.selection.selected.version?: string; default: not declared - diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`. - essvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - essvi.phi.eta: number; default: not declared - essvi.phi.gamma: number; default: not declared - essvi.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.phi.lambda: number; default: not declared - essvi.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`. - heston.kappa: number; default: not declared — Mean-reversion speed κ. - heston.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston.theta: number; default: not declared — Long-run variance θ. - heston.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - model: SurfaceModel; default: not declared - points: SurfacePoint[]; default: not declared - referenceSpot: number; default: not declared - schemaVersion: string; default: not declared - slices: SurfaceSlice[]; default: not declared - ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`. - ssvi.phi: import('@insiderfinance/totalfinance/volatility').SSVIPhi; default: not declared — Curvature function. - ssvi.phi.eta: number; default: not declared - ssvi.phi.gamma: number; default: not declared - ssvi.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.phi.lambda: number; default: not declared - ssvi.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - ssvi.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). ### @insiderfinance/totalfinance/volatility#arbitrageReport Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Run all static no-arbitrage checks over a set of slices (Law 2 report grammar). ```typescript export declare function arbitrageReport(slices: ArbitrageSlice[], options?: ArbitrageCheckOptions): ArbitrageReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: ArbitrageCheckOptions; default: not declared - (options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - (options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - (options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - (options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - (slices): ArbitrageSlice[]; default: not declared - return.arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - return.assumptions: { butterflyPoints: number; calendarPoints: number; conventionsVersion: string; step: number; tolerance: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - return.assumptions.butterflyPoints: number; default: not declared - return.assumptions.calendarPoints: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.step: number; default: not declared - return.assumptions.tolerance: number; default: not declared - return.checks: { butterfly: boolean; calendar: boolean; }; default: not declared — Per-check pass/fail summary. - return.checks.butterfly: boolean; default: not declared - return.checks.calendar: boolean; default: not declared - return.diagnostics: Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - return.violations: ArbitrageViolation[]; default: not declared ### @insiderfinance/totalfinance/volatility#atmTermStructure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The ATM implied-vol term structure: ATM IV and total variance per expiry, with a monotonicity flag. ```typescript export declare function atmTermStructure(surface: VolatilitySurface): AtmTermStructure; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - return.assumptions: { conventionsVersion: string; coordinate: 'atm-total-variance'; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.coordinate: 'atm-total-variance'; default: not declared - return.calendarMonotone: boolean; default: not declared — Whether ATM total variance is non-decreasing across maturities (calendar-arbitrage-free ATM). - return.diagnostics: Diagnostics; default: not declared — Structured warnings; a non-monotone ATM structure discloses itself here. - return.points: AtmTermPoint[]; default: not declared ### @insiderfinance/totalfinance/volatility#calendarSkew Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calendar skew: how the ATM skew slope changes from the near to the far expiry (`slope_far − slope_near`). Negative when the near-dated smile is steeper (the usual term-structure-of-skew shape). Facade (H22): the plain call returns the scalar; `.explain()` discloses the sorted near/far expiries and the canonical `0.05` log-moneyness central-difference step in `assumptions`, and both ATM skew slopes in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the plain call's first-touch teaching errors stay byte-identical. ```typescript export declare const calendarSkew: CalendarSkewFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (from): string | number; default: not declared - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - (to): string | number; default: not declared - explain: (surface: VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: CalendarSkewAssumptions; }; default: not declared - explain().return.assumptions: CalendarSkewAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(from): string | number; default: not declared - explain(surface): VolatilitySurface; default: not declared - explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - explain(surface).diagnostics: Diagnostics; default: not declared - explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - explain(to): string | number; default: not declared ### @insiderfinance/totalfinance/volatility#calibrateEssvi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a calendar-arbitrage-free eSSVI surface: θ knots from each slice's ATM variance (made monotone), then per-maturity `ρᵢ` and a global `φ` by least squares — warm-started from a global SSVI fit, so eSSVI begins at the best single-`ρ` surface and can only improve, with a calendar-crossing penalty keeping the fit arbitrage-free between maturities. See the spec. ```typescript export declare function calibrateEssvi(surface: ESSVICalibrationInput, options?: ESSVICalibrationOptions): ESSVICalibration; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: ESSVICalibrationOptions; default: not declared - (options).initialParameters?: { phi: SSVIPhi; rho: number | number[]; }; default: not declared — Warm start (Stage 4.5): a scalar `rho` broadcasts to every maturity knot, an array must match the slice count; `phi.kind` must equal the calibration's `phi` family. A supplied start REPLACES the internal SSVI warm start (echoed in `assumptions.initialParameters`). - (options).initialParameters.phi: SSVIPhi; default: not declared - (options).initialParameters.rho: number | number[]; default: not declared - (options).maximumIterations?: number; default: not declared — Outer-search iteration budget (default 2,000, maximum 10,000). - (options).phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - (options).tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - (options).weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit. Threaded through the SSVI warm-start too. - (surface): ESSVICalibrationInput; default: not declared - (surface).slices: SSVISliceInput[]; default: not declared - return.arbitrage: ESSVIArbitrage; default: not declared - return.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'ssvi-warm-start'; phi: 'power-law' | 'heston'; skew: 'per-maturity'; weight: 'uniform' | 'vega'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.initialParameters: 'supplied' | 'ssvi-warm-start'; default: not declared — Whether the search began from a caller-supplied start or the internal global-SSVI warm start. - return.assumptions.phi: 'power-law' | 'heston'; default: not declared - return.assumptions.skew: 'per-maturity'; default: not declared - return.assumptions.weight: 'vega' | 'uniform'; default: not declared - return.converged: boolean; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.parameters: ESSVIParameters; default: not declared - return.perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - return.rhoTerm: { timeToExpiryYears: number; rho: number; }[]; default: not declared — The fitted skew term structure — the payoff of eSSVI over global-ρ SSVI. - return.rmse: number; default: not declared — Root-mean-square total-variance error across all points. ### @insiderfinance/totalfinance/volatility#calibrateEventMove Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calibrate the earnings straddle: compare each past event's implied move (before) to its realized move (after), and aggregate — the ratio, how often selling the straddle won, and the average bias. A historical statistic (not a forecast). See the spec. ```typescript export declare function calibrateEventMove(observations: readonly EventMoveObservation[]): EventMoveCalibration; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (observations): readonly EventMoveObservation[]; default: not declared - return.assumptions: { conventionsVersion: string; method: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: string; default: not declared - return.averageImplied: number; default: not declared - return.averageRealized: number; default: not declared - return.bias: number; default: not declared — Mean `realized − implied` — positive ⇒ straddles underpriced on average. - return.count: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.meanAbsoluteError: number; default: not declared — Mean `|realized − implied|`. - return.overpricedFraction: number; default: not declared — Fraction of events where implied > realized (how often selling the straddle won). - return.perEvent: CalibratedEvent[]; default: not declared - return.ratio: number; default: not declared — `averageRealized / averageImplied` — > 1 ⇒ the stock moves MORE than the straddle prices. ### @insiderfinance/totalfinance/volatility#calibrateEventVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Extract the continuous vol and the discrete event jump from an ATM-vol term structure by fitting `Vᵢ = σ_base²·Tᵢ + J²·[spans]` (a 2-coefficient least-squares regression). See the spec. ```typescript export declare function calibrateEventVolatility(options: FitEventVolatilityOptions): EventVolatilityCalibration; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): FitEventVolatilityOptions; default: not declared - (options).asOf: string | number; default: not declared - (options).baseVolatility?: number; default: not declared — Pin the continuous vol when the term structure can't identify it (single expiry / no maturity spread). - (options).eventDate: string; default: not declared — ISO date of the earnings/event. - (options).termStructure: readonly AtmVolatilityPoint[]; default: not declared — The ATM-vol term structure (≥ 1 expiry; ≥ 2 to fit both `σ_base` and `J`, unless `baseVolatility` given). - return.assumptions: { asOf: EpochMs; conventionsVersion: string; eventDate: string; method: string; }; default: not declared - return.assumptions.asOf: number; default: not declared — The valuation instant the maturities were measured from (epoch ms) — what {@link eventVolatilityAtExpiry} evaluates against. - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.eventDate: string; default: not declared - return.assumptions.method: string; default: not declared - return.baseVariance: number; default: not declared — `σ_base²` — the fitted continuous variance itself (exact; `baseVolatility` is its root). - return.baseVolatility: number; default: not declared — Annualized continuous (non-event) vol `√σ_base²`. - return.daysToEvent: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.eventMove: number; default: not declared — Implied event move as a fraction of spot (`J`) — the "earnings move" (`spot·J` in price units). - return.eventVariance: number; default: not declared — `J²` — the discrete event variance. - return.perExpiry: FittedExpiry[]; default: not declared - return.rSquared: number; default: not declared — Fit quality on total variance (1 = perfect). ### @insiderfinance/totalfinance/volatility#calibrateHestonSurface Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function calibrateHestonSurface(request: HestonSurfaceCalibrationInput): HestonSurfaceFit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): HestonSurfaceCalibrationInput; default: not declared - (request).market: HestonSurfaceMarket; default: not declared - (request).options?: { initialParameters?: Partial; maximumIterations?: number; rmseTolerance?: number; terms?: number; }; default: not declared - (request).options.initialParameters?: Partial; default: not declared — Warm start — a partial pin of the five parameters (Stage 4.5; formerly `seed`, retired: `seed` names randomness everywhere else in the library). Unspecified members keep their data-derived starts (ATM variance for `v0`/`theta`, κ = 2, σ = 0.5, ρ = −0.5). - (request).options.initialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - (request).options.initialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - (request).options.initialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - (request).options.initialParameters.theta?: number; default: not declared — Long-run variance θ. - (request).options.initialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - (request).options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 300, maximum 10,000). - (request).options.rmseTolerance?: number; default: not declared — Max RMSE the `converged` flag tolerates (default 0.02 IV points). - (request).options.terms?: number; default: not declared — Heston COS expansion terms per target price (default 128, maximum 8,192). - (request).targets: readonly HestonSurfaceTarget[]; default: not declared - return.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; maximumIterations: number; targets: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether any starting member was caller-supplied (`initialParameters`) or all were data-derived. - return.assumptions.maximumIterations: number; default: not declared - return.assumptions.targets: number; default: not declared - return.converged: boolean; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present — a non-converged fit explains itself here. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.parameters: HestonParameters; default: not declared - return.rmse: number; default: not declared — Root-mean-square IV error across all calibration targets. - return.rmseTolerance: number; default: not declared — The RMSE tolerance the `converged` flag was gated on (echoed for interpretability). ### @insiderfinance/totalfinance/volatility#calibrateSabrSmile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function calibrateSabrSmile(input: SABRSmileInput, options?: SABRCalibrationOptions): SABRCalibrationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SABRSmileInput; default: not declared - (input).forward: number; default: not declared - (input).impliedVolatilities: number[]; default: not declared — Implied volatilities aligned to `strikes` (annualized decimals). - (input).strikes: number[]; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (options)?: SABRCalibrationOptions; default: not declared - (options).beta?: number; default: not declared — Backbone exponent β ∈ [0, 1] (default 0.5). - (options).initialParameters?: { alpha: number; nu: number; rho: number; }; default: not declared — Warm start for the `(α, ρ, ν)` search (Stage 4.5); `β` stays an option and is never fitted. Replaces the ATM-derived default start. - (options).initialParameters.alpha: number; default: not declared - (options).initialParameters.nu: number; default: not declared - (options).initialParameters.rho: number; default: not declared - (options).maximumIterations?: number; default: not declared — LM iteration budget (default 200, maximum 10,000). - (options).tolerance?: number; default: not declared — LM tolerance (default 1e-12). - (options).volatilityType?: SabrVolatilityType; default: not declared — Hagan expansion to fit against (default `'lognormal'`). - return.assumptions: { beta: number; conventionsVersion: string; initialParameters: 'supplied' | 'default'; volatilityType: SabrVolatilityType; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.beta: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the ATM-derived default. - return.assumptions.volatilityType: SabrVolatilityType; default: not declared - return.converged: boolean; default: not declared - return.diagnostics: Diagnostics; default: not declared — Structured warnings; a non-converged fit explains itself here. - return.iterations: number; default: not declared - return.parameters: SabrParameters; default: not declared - return.rmse: number; default: not declared — Root-mean-square implied-volatility error of the fit. ### @insiderfinance/totalfinance/volatility#calibrateSsvi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a calendar-arbitrage-free SSVI surface to a market total-variance surface: θ knots from each slice's ATM variance (made monotone), then a global `ρ` and `φ`-parameters by least squares. See the spec. ```typescript export declare function calibrateSsvi(surface: SSVICalibrationInput, options?: SSVICalibrationOptions): SSVICalibration; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: SSVICalibrationOptions; default: not declared - (options).initialParameters?: { phi: SSVIPhi; rho: number; }; default: not declared — Warm start for the `(ρ, φ)` search (Stage 4.5): `phi.kind` must equal the calibration's `phi` family. The θ knots are fixed from the data and are not a start. - (options).initialParameters.phi: SSVIPhi; default: not declared - (options).initialParameters.rho: number; default: not declared - (options).maximumIterations?: number; default: not declared — Outer-search iteration budget (default 1,000, maximum 10,000). - (options).phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - (options).tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - (options).weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit and thin, low-vega wings are downweighted. - (surface): SSVICalibrationInput; default: not declared - (surface).slices: SSVISliceInput[]; default: not declared - return.arbitrage: SSVIArbitrage; default: not declared - return.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; phi: 'power-law' | 'heston'; weight: 'uniform' | 'vega'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the built-in start. - return.assumptions.phi: 'power-law' | 'heston'; default: not declared - return.assumptions.weight: 'vega' | 'uniform'; default: not declared - return.converged: boolean; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.parameters: SSVIParameters; default: not declared - return.perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - return.rmse: number; default: not declared — Root-mean-square total-variance error across all points. ### @insiderfinance/totalfinance/volatility#calibrateSvi Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function calibrateSvi(input: SVISmileInput, options?: SVICalibrationOptions): SVICalibrationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SVISmileInput; default: not declared - (input).k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - (input).w: number[]; default: not declared — Total implied variance `σ²·t` aligned to `k`. - (options)?: SVICalibrationOptions; default: not declared - (options).initialParameters?: SVIWarmStart; default: not declared — Warm start for the outer `(m, σ)` search (Stage 4.5). Tried FIRST, ahead of the four built-in starts — ties keep the first, so a warm start never loses to a cold fit. `a`, `b`, and `ρ` are solved by the inner normal equations at every `(m, σ)` and are therefore not accepted as starts (a member the search cannot honor is refused, never ignored). - (options).maximumIterations?: number; default: not declared — Outer-search iteration budget (default 400, maximum 10,000). - (options).timeToExpiryYears?: number; default: not declared — The slice's maturity in years. Supplied ⇒ the fit-vs-data deviation check (see {@link calibrateSvi}) is expressed in true implied-VOL points, `σ = √(w/t)`. Omitted ⇒ `t = 1`, i.e. the check runs on `√w = σ√t` — still a vol scale, but shrunk by `√t` on a short slice. - (options).tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - return.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; method: 'zeliade-quasi-explicit'; points: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the outer search began from a caller-supplied `initialParameters` or the built-in starts. - return.assumptions.method: 'zeliade-quasi-explicit'; default: not declared - return.assumptions.points: number; default: not declared - return.butterflyFree: boolean; default: not declared — Whether the fitted slice is butterfly-arbitrage-free (`g(k) ≥ 0` across the check grid). - return.converged: boolean; default: not declared — `false` when the outer search stopped early OR the fitted slice sits materially away from the input smile (the arbitrage projection — see {@link calibrateSvi}); the reason is always a `diagnostics.warnings` entry. Gate on it before trusting `parameters`. - return.diagnostics: Diagnostics; default: not declared — Structured warnings; a non-converged or arbitrageable fit explains itself here. - return.iterations: number; default: not declared - return.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the check grid (`≥ 0` ⇔ arbitrage-free). - return.parameters: SVIParameters; default: not declared - return.rmse: number; default: not declared — Root-mean-square total-variance error of the fit. ### @insiderfinance/totalfinance/volatility#calibrateVannaVolga Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Construct a vanna–volga smile from the `(ATM, riskReversal, butterfly)` quotes and evaluate it at the requested strikes. The three market pillars (from {@link smileFromQuotes}) reprice exactly; strikes so far out of range that the VV price violates the no-arbitrage bounds cannot be inverted and are reported. See `docs/specs/vanna-volga.md`. ```typescript export declare function calibrateVannaVolga(input: VannaVolgaInput): VannaVolgaSmile; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VannaVolgaInput; default: not declared - (input).atmVolatility: number; default: not declared — ATM vol. - (input).butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - (input).delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - (input).forward: number; default: not declared — Forward price of the underlying. - (input).riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - (input).strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - return.assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; method: 'vanna-volga'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.delta: number; default: not declared - return.assumptions.deltaConvention: 'forward'; default: not declared - return.assumptions.method: 'vanna-volga'; default: not declared - return.delta: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.pillars: { atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; putStrike: number; putVolatility: number; }; default: not declared — The three market pillars the smile reprices exactly. - return.pillars.atmStrike: number; default: not declared - return.pillars.atmVolatility: number; default: not declared - return.pillars.callStrike: number; default: not declared - return.pillars.callVolatility: number; default: not declared - return.pillars.putStrike: number; default: not declared - return.pillars.putVolatility: number; default: not declared - return.strikes: number[]; default: not declared — Requested strikes. - return.volatilities: number[]; default: not declared — The constructed vol at each strike (aligned to `strikes`). ### @insiderfinance/totalfinance/volatility#calibrateVannaVolga5 Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Build the FX/crypto smile from the full five-quote set — ATM + the 25Δ and 10Δ risk reversal / butterfly — so it **exactly reprices all five market pillars** (10Δ put, 25Δ put, ATM, 25Δ call, 10Δ call) and pins the wings to real quotes instead of extrapolating them like the 3-pillar {@link calibrateVannaVolga} / {@link vannaVolgaApproximation}. The anchors come from {@link smileFromQuotes} at each delta; the smile is a shape-preserving PCHIP interpolation of total variance `σ²T` in log-moneyness (exact at the pillars, C¹ smooth, no overshoot). Exact repricing of arbitrary quotes can't guarantee no arbitrage, so the implied Breeden–Litzenberger density is checked across the pillar span and a butterfly arbitrage is a disclosed warning. See `docs/specs/vanna-volga-5.md`. ```typescript export declare function calibrateVannaVolga5(input: VannaVolga5Input): VannaVolga5Smile; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VannaVolga5Input; default: not declared - (input).atmVolatility: number; default: not declared - (input).butterfly10: number; default: not declared - (input).butterfly25: number; default: not declared - (input).forward: number; default: not declared - (input).innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - (input).outerDelta?: number; default: not declared - (input).riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - (input).riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - (input).strikes: number[]; default: not declared — Strikes to evaluate the smile at. - (input).timeToExpiryYears: number; default: not declared - (input).wingExtrapolation?: 'flat' | 'linear'; default: not declared — Wing extrapolation beyond the 10Δ pillars, in total variance: `flat` (default) or `linear`. - return.assumptions: { conventionsVersion: string; deltaConvention: 'forward'; interpolation: 'pchip-total-variance'; method: 'vanna-volga-5'; wingExtrapolation: 'flat' | 'linear'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.deltaConvention: 'forward'; default: not declared - return.assumptions.interpolation: 'pchip-total-variance'; default: not declared - return.assumptions.method: 'vanna-volga-5'; default: not declared - return.assumptions.wingExtrapolation: 'flat' | 'linear'; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.innerDelta: number; default: not declared - return.outerDelta: number; default: not declared - return.pillars: VannaVolga5Pillar[]; default: not declared — The five market pillars the smile reprices exactly, low → high strike. - return.strikes: number[]; default: not declared - return.volatilities: number[]; default: not declared ### @insiderfinance/totalfinance/volatility#checkButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Butterfly arbitrage: Gatheral's `g(k)` (∝ risk-neutral density) must stay non-negative. Envelope-shaped: `value` is the violation list, `assumptions.points` the resolution actually scanned (density-scaled from {@link ArbitrageSlice.strikes} when present) (Law 2 analysis grammar). ```typescript export declare function checkButterfly(slice: ArbitrageSlice, options?: ButterflyCheckOptions): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: ButterflyCheckOptions; default: not declared - (options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - (options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - (options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - (slice): ArbitrageSlice; default: not declared - (slice).expiry: string; default: not declared - (slice).forward: number; default: not declared — Forward price `S·e^{(r−q)t}`. - (slice).impliedVolatility: (strike: number) => number; default: not declared — Implied volatility at an absolute strike. - (slice).strikeRange: [number, number]; default: not declared — Fitted strike range `[Kmin, Kmax]`. - (slice).strikes?: readonly number[]; default: not declared — The slice's actual strike ladder, when known. Used ONLY to size the DEFAULT scan grids: the checks then sample at least {@link SAMPLES_PER_STRIKE_GAP} points per adjacent-strike gap, so a violation planted at a single strike cannot hide between two scan points (an explicit `butterflyPoints`/`calendarPoints` still wins). Omitted ⇒ the fixed 40/21-point defaults. - (slice).timeToExpiryYears: number; default: not declared — Time to expiry in years. - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: ArbitrageViolation[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#checkCalendar Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Calendar arbitrage: total variance must not fall as maturity increases (at fixed forward-moneyness). Envelope-shaped: `value` is the violation list, `assumptions` echoes the scan knobs (`points` is the resolution actually scanned — see {@link ArbitrageSlice.strikes}), and `diagnostics` is the standard warnings carrier (Law 2 analysis grammar). ```typescript export declare function checkCalendar(slices: ArbitrageSlice[], options?: CalendarCheckOptions): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: CalendarCheckOptions; default: not declared - (options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - (options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - (slices): ArbitrageSlice[]; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: ArbitrageViolation[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#estimateVolatilitySpotBeta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function estimateVolatilitySpotBeta(input: VolatilitySpotBetaInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VolatilitySpotBetaInput; default: not declared - (input).basis?: 'log' | 'level'; default: not declared — Regress IV changes on log-returns (`'log'`, default) or dollar spot changes (`'level'`). - (input).hacLags?: number; default: not declared — Newey–West HAC bandwidth for autocorrelation-robust errors. Default 0 uses classical standard errors (no HAC request). - (input).impliedVolatility: number[]; default: not declared — The option's implied vol (decimal), aligned to `spot`. - (input).referenceSpot?: number; default: not declared — Reference spot to convert a log-basis slope to `∂σ/∂S` (default: the latest spot). - (input).spot: number[]; default: not declared — Chronological spot prices. - return.assumptions: Assumptions<{ measure: 'real-world-hedge'; basis: 'log' | 'level'; hacLags: number; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: VolatilitySpotBeta; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#eventStrippedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Plain de-earned volatility; use `.explain()` for assumptions and clamp diagnostics. ```typescript export declare const eventStrippedVolatility: import('@insiderfinance/totalfinance/core').Facade<{ atmVolatility: number; eventMove: number; timeToExpiryYears: number; }, number, { method: 'additive-event-variance'; }, number>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { atmVolatility: number; eventMove: number; timeToExpiryYears: number; }; default: not declared - (input).atmVolatility: number; default: not declared - (input).eventMove: number; default: not declared - (input).timeToExpiryYears: number; default: not declared - explain: (input: { atmVolatility: number; eventMove: number; timeToExpiryYears: number; }) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ method: 'additive-event-variance'; }>; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): { atmVolatility: number; eventMove: number; timeToExpiryYears: number; }; default: not declared - explain(input).atmVolatility: number; default: not declared - explain(input).eventMove: number; default: not declared - explain(input).timeToExpiryYears: number; default: not declared ### @insiderfinance/totalfinance/volatility#eventVolatilityAtExpiry Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate a fitted event-volatility model at any expiries — the forward door of {@link calibrateEventVolatility}: the ATM volatility the model implies at an expiry, whether or not that expiry was in the calibration (an expiry after the event carries the jump; one before it does not). Maturities are measured from the fit's own `assumptions.asOf`. ```typescript export declare function eventVolatilityAtExpiry(input: { fit: EventVolatilityCalibration; expiries: readonly string[]; }): EventVolatilityAtExpiryResult; ``` Example (source JSDoc): ```ts const fit = calibrateEventVolatility({ termStructure, eventDate: '2026-05-11', asOf: '2026-05-01T10:00:00-04:00' }); eventVolatilityAtExpiry({ fit, expiries: ['2026-05-08', '2026-06-19'] }).values; // [σ_base, √(σ_base² + J²/t)] ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { expiries: readonly string[]; fit: EventVolatilityCalibration; }; default: not declared - (input).expiries: readonly string[]; default: not declared - (input).fit: EventVolatilityCalibration; default: not declared - return.assumptions: { asOf: EpochMs; baseVolatility: number; conventionsVersion: string; eventDate: string; eventMove: number; method: 'additive-event-variance'; }; default: not declared - return.assumptions.asOf: number; default: not declared - return.assumptions.baseVolatility: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.eventDate: string; default: not declared - return.assumptions.eventMove: number; default: not declared - return.assumptions.method: 'additive-event-variance'; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.rows: EventVolatilityAtExpiryRow[]; default: not declared - return.values: number[]; default: not declared — The model ATM volatilities, aligned to `input.expiries`. ### @insiderfinance/totalfinance/volatility#eventVolatilityDecomposition Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose an event-spanning ATM vol into a continuous (diffusive) part and a discrete event jump (spec §10.3). With a base (non-event) vol `σ_base` for the same tenor, the event contributes `σ_atm²·t − σ_base²·t` of variance, i.e. an implied move of `√(that)` on the event day. ```typescript export declare function eventVolatilityDecomposition(options: { atmVolatility: number; timeToExpiryYears: number; baseVolatility: number; }): EventVolatilityDecomposition; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { atmVolatility: number; baseVolatility: number; timeToExpiryYears: number; }; default: not declared - (options).atmVolatility: number; default: not declared - (options).baseVolatility: number; default: not declared - (options).timeToExpiryYears: number; default: not declared - return.assumptions: { conventionsVersion: string; method: 'additive-event-variance'; timeToExpiryYears: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'additive-event-variance'; default: not declared - return.assumptions.timeToExpiryYears: number; default: not declared - return.baseVariance: number; default: not declared — Continuous (non-event) variance over the tenor `σ_base²·t`. - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a clamped (base > total) decomposition explains itself here. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.eventMove: number; default: not declared — Implied one-event move as a fraction of spot, `√(eventVariance)` — the earnings/event jump size. - return.eventVariance: number; default: not declared — Variance attributed to the discrete event `σ_atm²·t − σ_base²·t` (clamped ≥ 0). - return.totalVariance: number; default: not declared — Total variance over the tenor `σ_atm²·t`. ### @insiderfinance/totalfinance/volatility#expectedMoveFromImpliedVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FACADE (P3.2, one gesture): the plain call returns the {@link ExpectedMove} numbers; the same call's `.explain()` returns the full envelope with the risk-neutral caveat — exactly the `blackScholes.call` / `blackScholes.call.explain` grammar, one import away. ```typescript export declare const expectedMoveFromImpliedVolatility: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExpectedMoveImpliedVolatilityInput; default: not declared - (input).impliedVolatility: number; default: not declared — Implied volatility (annualized decimal) — the one volatility vocabulary across the library. - (input).spot: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - explain: (input: ExpectedMoveImpliedVolatilityInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ExpectedMove; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ExpectedMoveImpliedVolatilityInput; default: not declared - explain(input).impliedVolatility: number; default: not declared — Implied volatility (annualized decimal) — the one volatility vocabulary across the library. - explain(input).spot: number; default: not declared - explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - return.expectedAbsolute: number; default: not declared — Expected absolute move `E|S_t − S_0| = oneSigma · √(2/π)` (≈ the ATM straddle price). - return.lower: number; default: not declared — Spot − oneSigma. - return.oneSigma: number; default: not declared — One standard-deviation move in price units: `spot · σ · √t`. - return.oneSigmaFraction: number; default: not declared — One-σ move as a fraction of spot: `σ · √t`. - return.upper: number; default: not declared — Spot + oneSigma. ### @insiderfinance/totalfinance/volatility#expectedMoveFromStraddle Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FACADE: plain {@link ExpectedMove}; `.explain()` for the envelope. ```typescript export declare const expectedMoveFromStraddle: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ExpectedMoveStraddleInput; default: not declared - (input).spot: number; default: not declared - (input).straddlePrice: number; default: not declared — The ATM straddle mid-price (call + put at the spot strike). - explain: (input: ExpectedMoveStraddleInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ExpectedMove; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ExpectedMoveStraddleInput; default: not declared - explain(input).spot: number; default: not declared - explain(input).straddlePrice: number; default: not declared — The ATM straddle mid-price (call + put at the spot strike). - return.expectedAbsolute: number; default: not declared — Expected absolute move `E|S_t − S_0| = oneSigma · √(2/π)` (≈ the ATM straddle price). - return.lower: number; default: not declared — Spot − oneSigma. - return.oneSigma: number; default: not declared — One standard-deviation move in price units: `spot · σ · √t`. - return.oneSigmaFraction: number; default: not declared — One-σ move as a fraction of spot: `σ · √t`. - return.upper: number; default: not declared — Spot + oneSigma. ### @insiderfinance/totalfinance/volatility#fitGarch Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a GARCH(1,1) model to a returns series by Gaussian MLE. The conditional variance follows `σ²ₜ = ω + α·r²ₜ₋₁ + β·σ²ₜ₋₁`, seeded with the sample second moment `E[r²]`. The optimizer works in the unconstrained space `θ = (log ω, logit p, logit f)` where `p = α+β` and `f = α/(α+β)`, so `ω>0, α≥0, β≥0, α+β<1` hold at every evaluation. A degenerate zero-second-moment series returns `converged: false`. Exact constants are degenerate in sample mode; in zero mode a nonzero constant retains its second moment about the declared zero mean. ```typescript export declare function fitGarch(returns: number[], options?: GarchFitOptions): GarchFit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: GarchFitOptions; default: not declared - (options).initialParameters?: { alpha: number; beta: number; }; default: not declared — Warm start for the `(α, β)` search (Stage 4.5): replaces the primary `(0.05, 0.90)` start; `ω` is derived by variance targeting and is not a start. The seeded restarts still run. - (options).initialParameters.alpha: number; default: not declared - (options).initialParameters.beta: number; default: not declared - (options).mean?: 'zero' | 'sample'; default: not declared — `'zero'` (default) fits second moments about zero; `'sample'` de-means first. A nonzero constant has a positive second moment in zero mode but is degenerate in sample mode. - (options).seed?: number; default: not declared — Seed for the deterministic multi-start of the optimizer (default `0x61726368`). - (returns): number[]; default: not declared - return.alpha: number; default: not declared — ARCH coefficient on the lagged squared return (`≥ 0`). - return.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; mean: 'zero' | 'sample'; observations: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the primary start was caller-supplied (`initialParameters`) or the classic (0.05, 0.90). - return.assumptions.mean: 'zero' | 'sample'; default: not declared - return.assumptions.observations: number; default: not declared - return.beta: number; default: not declared — GARCH coefficient on the lagged conditional variance (`≥ 0`). - return.converged: boolean; default: not declared — Whether the optimizer converged (never fabricated). - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a degenerate / non-converged fit explains itself here. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.iterations: number; default: not declared — Optimizer iterations performed. - return.logLikelihood: number | null; default: not declared — Maximized Gaussian log-likelihood; `null` when the likelihood is degenerate (disclosed). - return.longRunVariance: number; default: not declared — Unconditional variance `ω / (1 − α − β)` the forecast mean-reverts to. - return.omega: number; default: not declared — Constant term of the variance recursion (`> 0`). - return.persistence: number; default: not declared — `α + β` — the variance half-life driver; `< 1` for a stationary fit. ### @insiderfinance/totalfinance/volatility#fitHarRv Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a HAR-RV (heterogeneous autoregressive) model to a realized-variance series by OLS. Regresses `RVₜ` on `[1, RVₜ₋₁, avg(last {@link HarRvOptions.weekly}), avg(last {@link HarRvOptions.monthly})]`. The 4×4 least-squares system is solved by QR (stable — no normal-equations conditioning penalty). Requires more than `monthly` observations, with at least {@link HAR_PREDICTORS} fitted rows so the system is well-posed. ```typescript export declare function fitHarRv(realizedVariances: number[], options?: HarRvOptions): HarRvFit; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: HarRvOptions; default: not declared - (options).monthly?: number; default: not declared — Monthly averaging window in observations (default 22). - (options).weekly?: number; default: not declared — Weekly averaging window in observations (default 5). - (realizedVariances): number[]; default: not declared - return.assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.method: 'ols-qr'; default: not declared - return.assumptions.monthly: number; default: not declared - return.assumptions.weekly: number; default: not declared - return.coefficients: HarRvCoefficients; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.observationCount: number; default: not declared — Number of fitted observations. - return.rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - return.residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - return.windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - return.windows.monthly: number; default: not declared - return.windows.weekly: number; default: not declared ### @insiderfinance/totalfinance/volatility#forwardSkew Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Forward skew: the skew slope of the *forward-starting* smile between two expiries, built from the added forward variance at fixed forward-log-moneyness. `d(σ_fwd)/d(logMoneyness)` via a central difference, where `σ_fwd(k) = √((w_far(k) − w_near(k))/(t_far − t_near))`. Throws the same {@link ArbitrageError} (`volatility.calendar_arbitrage`) as {@link forwardVolatility} when the forward variance is negative at either sampled `k` — a forward smile that does not exist is reported, never clamped to zero and differenced into a plausible-looking number. Facade (H23): the plain call returns the scalar; `.explain()` discloses the applied `step` in `assumptions` and BOTH total-variance calculations (the `k = +step` and `k = −step` legs) in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the closed-request teaching error for a `null` options bag stays byte-identical. ```typescript export declare const forwardSkew: ForwardSkewFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (from): string | number; default: not declared - (options)?: { step?: number; } | undefined; default: not declared - (options).step?: number; default: not declared - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - (to): string | number; default: not declared - explain: (surface: VolatilitySurface, from: string | number, to: string | number, options?: { step?: number; }) => Omit, 'assumptions'> & { assumptions: ForwardSkewAssumptions; }; default: not declared - explain().return.assumptions: ForwardSkewAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(from): string | number; default: not declared - explain(options)?: { step?: number; } | undefined; default: not declared - explain(options).step?: number; default: not declared - explain(surface): VolatilitySurface; default: not declared - explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - explain(surface).diagnostics: Diagnostics; default: not declared - explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - explain(to): string | number; default: not declared ### @insiderfinance/totalfinance/volatility#forwardVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Forward-starting ATM volatility between two expiries from ATM total variance: `√((w_far − w_near)/(t_far − t_near))`. Throws an {@link ArbitrageError} (`volatility.calendar_arbitrage`) if the implied forward variance is negative (an ATM calendar-arbitrage breach). Facade (H21): the plain call returns the scalar; `.explain()` discloses the resolved near/far expiries and year fractions in `assumptions`, and the ATM total variances / forward variance / time gap the square root came from in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the plain call's first-touch teaching errors stay byte-identical. ```typescript export declare const forwardVolatility: ForwardVolatilityFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (from): string | number; default: not declared - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - (to): string | number; default: not declared - explain: (surface: VolatilitySurface, from: string | number, to: string | number) => Omit, 'assumptions'> & { assumptions: ForwardVolatilityAssumptions; }; default: not declared - explain().return.assumptions: ForwardVolatilityAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(from): string | number; default: not declared - explain(surface): VolatilitySurface; default: not declared - explain(surface).arbitrage: (options?: import('@insiderfinance/totalfinance/volatility').ArbitrageCheckOptions) => import('@insiderfinance/totalfinance/volatility').ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - explain(surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - explain(surface).diagnostics: Diagnostics; default: not declared - explain(surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - explain(surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - explain(surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - explain(surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - explain(surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - explain(surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - explain(surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - explain(surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - explain(surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - explain(surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - explain(surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - explain(surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - explain(surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - explain(surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - explain(surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - explain(to): string | number; default: not declared ### @insiderfinance/totalfinance/volatility#garchForecast Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function garchForecast(input: GarchForecastInput): GarchForecast; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): GarchForecastInput; default: not declared - (input).fit: GarchFit; default: not declared - (input).horizonPeriods: number; default: not declared - (input).lastVariance: number; default: not declared - (input).options?: GarchForecastOptions; default: not declared - return.annualizedVolatility: number[]; default: not declared — `√(σ²ₜ₊ₕ · periodsPerYear)` — the annualized volatility. - return.assumptions: { conventionsVersion: string; horizonPeriods: number; periodsPerYear: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.horizonPeriods: number; default: not declared - return.assumptions.periodsPerYear: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present (possibly empty). - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.variancePath: number[]; default: not declared — `σ²ₜ₊ₕ` for `h = 1..horizonPeriods`. - return.volatilityPath: number[]; default: not declared — `√σ²ₜ₊ₕ` — the per-period volatility. ### @insiderfinance/totalfinance/volatility#harRvForecast Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). One-step-ahead HAR-RV forecast from the latest daily/weekly/monthly aggregates of `history`, using the same windows the model was fit with. Requires at least `monthly` observations. A NEGATIVE forecast throws (`volatility.negative_variance_forecast`): the linear model can extrapolate below zero, and a negative variance is not a variance — it is never clamped, and never returned as if it were a successful forecast. `.explain()` throws the same typed error — a failed model output is never softened into an envelope. Facade (H24): the plain call returns the scalar; `.explain()` discloses the fitted windows in `assumptions`, and the three predictors plus the per-term regression contributions (which sum to the raw model output, i.e. the value) in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the closed-request teaching error for a hand-rolled `fit` stays byte-identical. ```typescript export declare const harRvForecast: HarRvForecastFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (fit): HarRvFit; default: not declared - (fit).assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - (fit).assumptions.conventionsVersion: string; default: not declared - (fit).assumptions.method: 'ols-qr'; default: not declared - (fit).assumptions.monthly: number; default: not declared - (fit).assumptions.weekly: number; default: not declared - (fit).coefficients: HarRvCoefficients; default: not declared - (fit).diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - (fit).diagnostics.warnings: QuantWarning[]; default: not declared - (fit).observationCount: number; default: not declared — Number of fitted observations. - (fit).rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - (fit).residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - (fit).windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - (fit).windows.monthly: number; default: not declared - (fit).windows.weekly: number; default: not declared - (history): number[]; default: not declared - explain: (fit: HarRvFit, history: number[]) => Omit, 'assumptions'> & { assumptions: HarRvForecastAssumptions; }; default: not declared - explain().return.assumptions: HarRvForecastAssumptions; default: not declared - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(fit): HarRvFit; default: not declared - explain(fit).assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - explain(fit).assumptions.conventionsVersion: string; default: not declared - explain(fit).assumptions.method: 'ols-qr'; default: not declared - explain(fit).assumptions.monthly: number; default: not declared - explain(fit).assumptions.weekly: number; default: not declared - explain(fit).coefficients: HarRvCoefficients; default: not declared - explain(fit).diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - explain(fit).diagnostics.warnings: QuantWarning[]; default: not declared - explain(fit).observationCount: number; default: not declared — Number of fitted observations. - explain(fit).rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - explain(fit).residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - explain(fit).windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - explain(fit).windows.monthly: number; default: not declared - explain(fit).windows.weekly: number; default: not declared - explain(history): number[]; default: not declared ### @insiderfinance/totalfinance/volatility#impliedVolatilityPercentile Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const impliedVolatilityPercentile: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedVolatilityMetricInput; default: not declared - (input).current: number; default: not declared — Current implied volatility (annualized decimal). - (input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - explain: (input: ImpliedVolatilityMetricInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ImpliedVolatilityMetricInput; default: not declared - explain(input).current: number; default: not declared — Current implied volatility (annualized decimal). - explain(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). ### @insiderfinance/totalfinance/volatility#impliedVolatilityRank Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FACADES (P3.2, one gesture): plain value from the call; the same call's `.explain()` returns the envelope (window, method, and the flat-history caveat when rank is undefined). Single-object input per Decision 3 — `impliedVolatilityRank({ current, history })`. ```typescript export declare const impliedVolatilityRank: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedVolatilityMetricInput; default: not declared - (input).current: number; default: not declared — Current implied volatility (annualized decimal). - (input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - explain: (input: ImpliedVolatilityMetricInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number | null; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ImpliedVolatilityMetricInput; default: not declared - explain(input).current: number; default: not declared — Current implied volatility (annualized decimal). - explain(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). ### @insiderfinance/totalfinance/volatility#impliedVolatilityStatistics Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const impliedVolatilityStatistics: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ImpliedVolatilityMetricInput; default: not declared - (input).current: number; default: not declared — Current implied volatility (annualized decimal). - (input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - explain: (input: ImpliedVolatilityMetricInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: ImpliedVolatilityStatistics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ImpliedVolatilityMetricInput; default: not declared - explain(input).current: number; default: not declared — Current implied volatility (annualized decimal). - explain(input).history: ArrayLike; default: not declared — Trailing IV history (chronological or not — order-insensitive). - return.current: number; default: not declared - return.max: number; default: not declared - return.mean: number; default: not declared - return.min: number; default: not declared - return.observations: number; default: not declared - return.percentile: number; default: not declared - return.rank: number | null; default: not declared — `null` for a flat history (rank undefined — disclosed via `implied_volatility.flat_history`). ### @insiderfinance/totalfinance/volatility#localVolatilitySurface Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a Dupire local-volatility surface from an implied-vol function `σ_imp(strike, t)` and market context. ```typescript export declare function localVolatilitySurface(input: LocalVolatilitySurfaceInput): LocalVolatilitySurface; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): LocalVolatilitySurfaceInput; default: not declared - (input).impliedVolatility: (strike: number, timeToExpiryYears: number) => number; default: not declared - (input).market: LocalVolatilityMarket; default: not declared - (input).options?: DupireOptions; default: not declared - return.grid: (specification: LocalVolatilityGridSpecification) => LocalVolatilityFunction; default: not declared — A grid-cached local-volatility function over the given (level, time) knots — bilinearly interpolated and far cheaper to evaluate inside a Monte-Carlo simulation than the raw finite-difference transform. - return.localVolatility: (level: number, timeToExpiryYears: number) => number; default: not declared — Dupire local volatility `σ_loc(level, t)` (level = underlying price, t in years). ### @insiderfinance/totalfinance/volatility#minimumVarianceDelta Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The minimum-variance (smile-adjusted) delta for one option. Composes `blackScholesGreeks` (for `Δ_BS` and vega) with a vol–spot sensitivity `β`. See the spec — β should be empirical (leverage) for a true minimum-variance hedge; the skew-derived regimes are smile models, not the leverage effect. ```typescript export declare function minimumVarianceDelta(options: MinimumVarianceDeltaOptions): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): MinimumVarianceDeltaOptions; default: not declared - (options).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - (options).regime?: 'sticky-strike' | 'sticky-moneyness'; default: not declared — How `skewSlope` maps to β. Default `'sticky-moneyness'`. - (options).riskFreeRate: number; default: not declared - (options).skewSlope?: number; default: not declared — ∂σ/∂ln(K) (`SkewMetrics.skewSlope`) — mapped to β via `regime`. - (options).spot: number; default: not declared - (options).strike: number; default: not declared - (options).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (options).type: OptionType; default: not declared - (options).volatility: number; default: not declared — The option's implied vol (decimal). - (options).volatilitySpotBeta?: number; default: not declared — ∂σ/∂S directly (decimal vol **per $1 of spot**) — the empirical / minimum-variance β (preferred). Take it from `estimateVolatilitySpotBeta(...).value.volatilitySpotBeta`, which is already in these units. `stickyRegime`'s `volatilitySpotBetaPerLogSpot` is ∂σ/∂lnS — `S ×` larger — so divide it by spot before passing it here, or the smile adjustment is scaled by the spot price. - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'real-world-hedge'; betaSource: string; regime?: string; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: MinimumVarianceDeltaResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#observedSkew Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Observe a single expiry. Compose separate calls for a term structure; compare their mean ATM IVs only when available. IV/RR/BF/spreads are decimals (multiply by 100 for IV-point displays). Missing IV/delta is omission, not null/NaN/zero. Missing wings and insufficient/expired samples return null with reasons. Supplied malformed values throw; no alternate quote/date shapes, delta recomputation, interpolation, forward adjustment or tail extrapolation is performed. Distance ties and inclusive boundaries allow only 4 × machine epsilon at the arithmetic operand scale. Ties are measured against the global minimum, then use the disclosed lower-strike order; an exact observed target always wins and a zero delta tolerance remains strictly exact. ```typescript export declare function observedSkew(input: ObservedSkewInput): ObservedSkewResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ObservedSkewInput; default: not declared - (input).config: ObservedSkewConfig; default: not declared - (input).market: Pick; default: not declared — No rate, yield, volatility, clock default, or forward inference is used. - (input).market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - (input).market.spot: number; default: not declared - (input).quotes: readonly OptionQuote[]; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: ObservedSkewMetrics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#probabilityInTheMoney Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FACADE: plain probability; `.explain()` carries the risk-neutral disclosure. ```typescript export declare const probabilityInTheMoney: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ProbabilityInTheMoneyInput; default: not declared - (input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).strike: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).type: OptionType; default: not declared - (input).volatility: number; default: not declared — Implied volatility (annualized decimal). - explain: (input: ProbabilityInTheMoneyInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ProbabilityInTheMoneyInput; default: not declared - explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - explain(input).riskFreeRate: number; default: not declared - explain(input).spot: number; default: not declared - explain(input).strike: number; default: not declared - explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - explain(input).type: OptionType; default: not declared - explain(input).volatility: number; default: not declared — Implied volatility (annualized decimal). ### @insiderfinance/totalfinance/volatility#probabilityOfTouch Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). FACADE: plain first-passage probability; `.explain()` for the envelope. ```typescript export declare const probabilityOfTouch: import('@insiderfinance/totalfinance/core').Facade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): ProbabilityOfTouchInput; default: not declared - (input).barrier: number; default: not declared - (input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - (input).riskFreeRate: number; default: not declared - (input).spot: number; default: not declared - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).volatility: number; default: not declared — Implied volatility (annualized decimal). - explain: (input: ProbabilityOfTouchInput) => Computed; default: not declared - explain().return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions; default: not declared — Every applied convention, echoed back. - explain().return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: number; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(input): ProbabilityOfTouchInput; default: not declared - explain(input).barrier: number; default: not declared - explain(input).dividendYield?: number; default: not declared — Continuous dividend yield (decimal, default 0). - explain(input).riskFreeRate: number; default: not declared - explain(input).spot: number; default: not declared - explain(input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - explain(input).volatility: number; default: not declared — Implied volatility (annualized decimal). ### @insiderfinance/totalfinance/volatility#realizedImpliedSpread Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function realizedImpliedSpread(input: RealizedImpliedInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RealizedImpliedInput; default: not declared - (input).impliedVolatility: number; default: not declared — Annualized implied volatility (decimal). - (input).realizedVolatility: number; default: not declared — Annualized realized volatility (decimal) — e.g. `historicalVolatility(closes, { period, annualization: 252 })`. ### @insiderfinance/totalfinance/volatility#riskNeutralDistribution Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Breeden–Litzenberger (1978): the risk-neutral terminal distribution implied by a call-price curve. Given the smile `volatilitySmile(strike)`, prices calls via BSM and differentiates numerically: `f(K) = e^{rT}·∂²C/∂K²` and `F(K) = 1 + e^{rT}·∂C/∂K`. Use it for probability cones / expected-range bands. The smile must be arbitrage-free for the density to stay non-negative. Where it repairs itself, it SAYS SO on the returned `diagnostics`: a negative (arbitrageable) density clamped to zero, and the one-sided difference used for strikes within `step` of zero (a deep-downside probe like `density(0.05)` on a $100 name, which used to price a negative strike and return `NaN`). `diagnostics.warnings` fills in as the closures are queried — read it after use. ```typescript export declare function riskNeutralDistribution(volatilitySmile: (strike: number) => number, options: RiskNeutralOptions): RiskNeutralDistribution; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): RiskNeutralOptions; default: not declared - (options).dividendYield?: number; default: not declared - (options).riskFreeRate: number; default: not declared - (options).spot: number; default: not declared - (options).step?: number; default: not declared — Central-difference step in strike (default `spot · 0.001`). - (options).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (volatilitySmile): (strike: number) => number; default: not declared - return.cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + e^{rT}·∂C/∂K`, clamped to [0, 1]. - return.density: (strike: number) => number; default: not declared — Risk-neutral PDF at strike `K`: `e^{rT}·∂²C/∂K²` (clamped ≥ 0 — see {@link diagnostics}). - return.diagnostics: Diagnostics; default: not declared — LIVE disclosure channel for the two places this object silently repairs itself — it accumulates as the closures are called, so read it AFTER querying (it starts empty): • `model.limitation` "negative density clamped" — `∂²C/∂K²` came out negative, which means the smile is butterfly-arbitrageable there. The clamp keeps `density()` a density; the warning stops a caller integrating a repaired curve and calling it the market's distribution. • `model.limitation` "one-sided difference" — a query within `step` of zero, where the centred difference would price a NEGATIVE strike (which returned `NaN`). - return.probabilityAbove: (strike: number) => number; default: not declared - return.probabilityBelow: (strike: number) => number; default: not declared - return.probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared ### @insiderfinance/totalfinance/volatility#riskReversalButterfly Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decompose a smile into the ATM vol, the δ-delta **risk reversal** (`callVolatility − putVolatility`, the skew) and **butterfly** (`(callVolatility + putVolatility)/2 − ATM`, the curvature) — the standard FX/crypto quoting triple. Forward delta throughout. See `docs/specs/risk-reversal-butterfly.md`. ```typescript export declare function riskReversalButterfly(input: RiskReversalButterflyInput): RiskReversalButterfly; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RiskReversalButterflyInput; default: not declared - (input).delta?: number; default: not declared — Delta level for the wings (0.25 = 25-delta). Default 0.25. Must be in `(0, 0.5)`. - (input).forward: number; default: not declared — Forward price of the underlying. - (input).smile: (strike: number) => number; default: not declared — The smile: strike → implied vol (from any fit — SVI, SSVI, volatilitySurface, …). - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - return.assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.delta: number; default: not declared - return.assumptions.deltaConvention: 'forward'; default: not declared - return.atmVolatility: number; default: not declared — ATM vol (at `K = forward`). - return.butterfly: number; default: not declared — `(callVolatility + putVolatility)/2 − atmVolatility` — the curvature (> 0 ⇒ smile). - return.callStrike: number; default: not declared — The δ-delta call strike. - return.callVolatility: number; default: not declared — The vol at the call strike. - return.delta: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.putStrike: number; default: not declared — The δ-delta put strike. - return.putVolatility: number; default: not declared — The vol at the put strike. - return.riskReversal: number; default: not declared — `callVolatility − putVolatility` — the skew (< 0 ⇒ puts bid). ### @insiderfinance/totalfinance/volatility#sabrBartlettGreeks Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Bartlett (2006) minimum-variance delta, vega & gamma for a SABR-parametrised option — the model-consistent hedges that account for the correlated forward/vol dynamics. Composes `sabrPrice` (naive delta/vega/gamma) with the correlation coupling `ρν/F^β` (delta) and `ρF^β/ν` (vega); the Bartlett gamma is the price convexity along the correlated hedge path. Greeks are w.r.t. the **forward**, as in `sabrPrice`. Each is reported alongside its naive counterpart and the adjustment. See `docs/specs/sabr-bartlett-delta.md` and `docs/specs/sabr-bartlett-gamma.md`. ```typescript export declare function sabrBartlettGreeks(request: SabrBartlettGreeksInput): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): SabrBartlettGreeksInput; default: not declared - (request).input: SabrInput; default: not declared - (request).options?: SabrBartlettOptions; default: not declared - (request).parameters: SabrParameters; default: not declared - (request).type: OptionType; default: not declared - return.assumptions: Assumptions<{ measure: 'min-variance-hedge'; volatilityType: SabrVolatilityType; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: SabrBartlettGreeks; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#skew Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compute skew/smile metrics for one expiry of an option chain. ```typescript export declare function skew(input: SkewInput): SkewResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SkewInput; default: not declared - (input).config: SkewConfig; default: not declared - (input).market: SkewMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.assumptions: Assumptions>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: SkewMetrics; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#smileFromQuotes Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Recover the three smile anchors — the δ-delta put, the ATM, and the δ-delta call `(strike, vol)` — from the `(ATM, riskReversal, butterfly)` quotes. Exact inverse of {@link riskReversalButterfly}: the wing volatilities are `ATM + BF ± RR/2`, and each wing strike is closed form (`K = F·exp(½σ²T − Φ⁻¹(·)σ√T)`) since the vol is now known. See `docs/specs/risk-reversal-butterfly.md`. ```typescript export declare function smileFromQuotes(input: SmileFromQuotesInput): SmileAnchors; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SmileFromQuotesInput; default: not declared - (input).atmVolatility: number; default: not declared — ATM vol. - (input).butterfly: number; default: not declared — Butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - (input).delta?: number; default: not declared — Delta level. Default 0.25. - (input).forward: number; default: not declared - (input).riskReversal: number; default: not declared — Risk reversal (`callVolatility − putVolatility`). - (input).timeToExpiryYears: number; default: not declared - return.assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.delta: number; default: not declared - return.assumptions.deltaConvention: 'forward'; default: not declared - return.atmStrike: number; default: not declared - return.atmVolatility: number; default: not declared - return.callStrike: number; default: not declared - return.callVolatility: number; default: not declared - return.delta: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.putStrike: number; default: not declared - return.putVolatility: number; default: not declared ### @insiderfinance/totalfinance/volatility#stickyRegime Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Measure whether the market's smile is sticky-strike or sticky-moneyness (sticky-delta) from a history of spot and a fixed reference strike's implied vol. See `docs/specs/sticky-regime.md`. ```typescript export declare function stickyRegime(input: StickyRegimeInput): StickyRegime; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): StickyRegimeInput; default: not declared - (input).fixedStrikeVolatility: ArrayLike; default: not declared — Per-observation implied vol of a FIXED reference strike (same K across the series). - (input).skewSlope?: number; default: not declared — The smile slope `∂σ/∂ln(K)` — the sticky-moneyness reference. Omit ⇒ only `β`/R² (indeterminate). - (input).spot: ArrayLike; default: not declared — Per-observation underlying spot, aligned to `fixedStrikeVolatility`. - return.assumptions: { conventionsVersion: string; skewSlope: number | null; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.skewSlope: number | null; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.observations: number; default: not declared - return.rSquared: number; default: not declared — How much of the fixed-strike vol's change spot returns explain. - return.regime: 'indeterminate' | 'sticky-strike' | 'sticky-moneyness' | 'intermediate'; default: not declared - return.stickiness: number | null; default: not declared — Position on the axis: 0 = sticky-strike, 1 = sticky-moneyness (`= −β/skewSlope`); `null` if no reference. - return.tStatistic: number; default: not declared - return.volatilitySpotBetaPerLogSpot: number; default: not declared — `∂σ_K/∂lnS` — the empirical vol-spot beta from the regression, **per LOG spot** (vol points per 100% spot move). NOT the same quantity as `VolatilitySpotBeta.volatilitySpotBeta` / `minimumVarianceDelta({ volatilitySpotBeta })`, which are `∂σ/∂S` — per DOLLAR. The two differ by a factor of `S`: feeding this straight into the hedge would scale the smile adjustment by the spot price. Divide by the reference spot first (`estimateVolatilitySpotBeta` does exactly that when its `basis` is `'log'`). ### @insiderfinance/totalfinance/volatility#surfaceArbitrageReport Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Adapt a {@link VolatilitySurface} to {@link arbitrageReport}, carrying its sparse-data warnings through into `diagnostics.warnings`. ```typescript export declare function surfaceArbitrageReport(surface: VolatilitySurface, options?: ArbitrageCheckOptions): ArbitrageReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: ArbitrageCheckOptions; default: not declared - (options).butterflyPoints?: number; default: not declared — Log-moneyness samples per slice for the butterfly check (default 40, must be ≥ 3). - (options).calendarPoints?: number; default: not declared — Log-moneyness samples for each calendar pair (default 21, must be ≥ 2). - (options).step?: number; default: not declared — Central-difference step in log-moneyness for the density derivatives (default 0.01, must be > 0). - (options).tolerance?: number; default: not declared — Tolerance below which a breach is reported (default 1e-4, must be finite ≥ 0). - (surface): VolatilitySurface; default: not declared - (surface).arbitrage: (options?: ArbitrageCheckOptions) => ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - (surface).assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - (surface).diagnostics: Diagnostics; default: not declared - (surface).essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - (surface).expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - (surface).heston?: import('@insiderfinance/totalfinance/options').HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - (surface).impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - (surface).impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - (surface).impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - (surface).lookup: (strike: number, expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - (surface).model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - (surface).points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - (surface).shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - (surface).slice: (expiry: string | number) => import('@insiderfinance/totalfinance/volatility').SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - (surface).slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - (surface).ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - (surface).toJSON: () => import('@insiderfinance/totalfinance/volatility').VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - (surface).toRows: () => import('@insiderfinance/totalfinance/volatility').SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). - return.arbitrageFree: boolean; default: not declared — True when no calendar or butterfly violation was found. - return.assumptions: { butterflyPoints: number; calendarPoints: number; conventionsVersion: string; step: number; tolerance: number; }; default: not declared — Applied conventions/knobs, echoed (Law 2 report grammar). - return.assumptions.butterflyPoints: number; default: not declared - return.assumptions.calendarPoints: number; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.step: number; default: not declared - return.assumptions.tolerance: number; default: not declared - return.checks: { butterfly: boolean; calendar: boolean; }; default: not declared — Per-check pass/fail summary. - return.checks.butterfly: boolean; default: not declared - return.checks.calendar: boolean; default: not declared - return.diagnostics: Diagnostics; default: not declared — Structured warnings (carried-through surface warnings live here); always present. - return.violations: ArbitrageViolation[]; default: not declared ### @insiderfinance/totalfinance/volatility#surfaceLocalVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit a Dupire local-volatility surface directly from a calibrated {@link VolatilitySurface}. ```typescript export declare function surfaceLocalVolatility(input: SurfaceLocalVolatilityInput): LocalVolatilitySurface; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SurfaceLocalVolatilityInput; default: not declared - (input).market: LocalVolatilityMarket; default: not declared - (input).options?: DupireOptions; default: not declared - (input).surface: VolatilitySurface; default: not declared - return.grid: (specification: LocalVolatilityGridSpecification) => LocalVolatilityFunction; default: not declared — A grid-cached local-volatility function over the given (level, time) knots — bilinearly interpolated and far cheaper to evaluate inside a Monte-Carlo simulation than the raw finite-difference transform. - return.localVolatility: (level: number, timeToExpiryYears: number) => number; default: not declared — Dupire local volatility `σ_loc(level, t)` (level = underlying price, t in years). ### @insiderfinance/totalfinance/volatility#surfacePCA Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Principal-component analysis of vol-surface changes: the dominant modes of surface motion (level / slope / curvature), each with its variance explained and factor-score series. See the spec. ```typescript export declare function surfacePCA(input: SurfacePcaInput): SurfacePcaResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SurfacePcaInput; default: not declared - (input).changes?: 'absolute' | 'relative'; default: not declared — How to difference consecutive snapshots; default `'absolute'`. - (input).gridPoints?: number[]; default: not declared — Ordered grid coordinates (moneyness or tenor), one per column — used to label mode shapes. - (input).maxComponents?: number; default: not declared — Retain only the top-k modes; default all (= grid size). - (input).snapshots: number[][]; default: not declared — IV snapshots over time; `snapshots[t]` is the vol vector at a FIXED set of grid points. - return.assumptions: { changeType: 'absolute' | 'relative'; conventionsVersion: string; ordered: boolean; }; default: not declared - return.assumptions.changeType: 'absolute' | 'relative'; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.ordered: boolean; default: not declared - return.changeType: 'absolute' | 'relative'; default: not declared - return.cumulativeVarianceExplained: number[]; default: not declared — Cumulative variance explained up to and including each mode. - return.diagnostics: Diagnostics; default: not declared - return.gridSize: number; default: not declared - return.modes: SurfaceMode[]; default: not declared - return.observations: number; default: not declared — Number of change vectors (`snapshots.length − 1`). - return.totalVariance: number; default: not declared ### @insiderfinance/totalfinance/volatility#surfacePcaScenarios Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Turn a fitted {@link surfacePCA} into **stress scenarios**: shock a base surface by `±k` standard deviations along each principal mode (`k·√λ·loadings`, since `√λ` is the mode's 1-sigma move and the loadings are unit-norm), and optionally by a combined per-mode move. Shocked volatilities are floored (default 0) so a large downside shock can't go negative. The shock is applied in the units the PCA was FITTED in (`pca.changeType`): `absolute` adds the vector to the base vols, `relative` scales them (`base·(1 + shock)`), because a relative PCA's modes are proportional moves. See `docs/specs/surface-pca-scenarios.md`. ```typescript export declare function surfacePcaScenarios(input: SurfacePcaScenarioInput): SurfacePcaScenarios; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SurfacePcaScenarioInput; default: not declared - (input).base: number[]; default: not declared — Current volatilities to shock, at the SAME grid points as the PCA (length = `pca.gridSize`). - (input).combined?: number[]; default: not declared — Optional per-mode sigma moves → one combined shocked surface. - (input).floor?: number; default: not declared — Floor for the shocked volatilities (a vol can't go negative). Default 0. - (input).maxModes?: number; default: not declared — Shock only the top-N modes. Default all of `pca.modes`. - (input).pca: SurfacePcaResult; default: not declared — The result of {@link surfacePCA} — its modes drive the shocks. - (input).sigmas?: number[]; default: not declared — Shock magnitudes in standard deviations, applied to each mode. Default `[-1, 1]`. - return.assumptions: { changeType: 'absolute' | 'relative'; conventionsVersion: string; floor: number; }; default: not declared - return.assumptions.changeType: 'absolute' | 'relative'; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.floor: number; default: not declared - return.base: number[]; default: not declared - return.combinedSurface?: number[]; default: not declared — `base + Σ sᵢ·√λᵢ·loadingsᵢ`, floored — present only when `combined` is supplied. - return.diagnostics: Diagnostics; default: not declared - return.scenarios: SurfaceScenario[]; default: not declared — One per `(mode, sigma)`, in mode-major order. ### @insiderfinance/totalfinance/volatility#swaptionCube Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function swaptionCube(input: SwaptionCubeInput): SwaptionCube; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SwaptionCubeInput; default: not declared - (input).beta?: number; default: not declared — Default backbone β for every node's calibration (0.5, the rates convention). - (input).maximumIterations?: number; default: not declared — `calibrateSabrSmile` iteration cap (pass-through). - (input).nodes: SwaptionCubeNode[]; default: not declared - (input).shift?: number; default: not declared — Rate displacement `s ≥ 0` for **shifted (displaced) SABR** — SABR is lognormal and needs `forward, strike > 0`, so a negative-rate cube must be calibrated on `forward + s` / `strike + s`. Default `0` (plain SABR). With `s > 0` the `'lognormal'` volatilities are *shifted*-lognormal — price with Black on the shifted rates, `annuity · Black(forward + s, strike + s, vol, expiry)`; `'normal'` (Bachelier) volatilities are unchanged (a common shift cancels in `forward − strike`). See `docs/specs/swaption-cube-shift.md`. - (input).tolerance?: number; default: not declared — `calibrateSabrSmile` tolerance (pass-through). - (input).volatilityType?: SabrVolatilityType; default: not declared — Volatility quote convention: `'lognormal'` (Black, default) or `'normal'` (Bachelier). - return.assumptions: { backbone: 'sabr'; conventionsVersion: string; shift: number; volatilityType: SabrVolatilityType; }; default: not declared - return.assumptions.backbone: 'sabr'; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.shift: number; default: not declared - return.assumptions.volatilityType: SabrVolatilityType; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.expiries: number[]; default: not declared — Unique expiries, ascending. - return.nodes: CalibratedSwaptionNode[]; default: not declared — Calibrated nodes, sorted by `(expiry, tenor)`. - return.shift?: number; default: not declared — The rate displacement applied inside SABR (`0` for plain SABR). Nodes' `forward` fields stay the real (unshifted) rates; the shift lives only in the SABR calibration/evaluation. {@link swaptionCubeVolatility} reads this off the cube. OPTIONAL because legacy (pre-shift) serialized cubes carry no field — evaluation reads an absent shift as `0`; the declaration used to say required while the runtime documented that default, and the 3B.1b spec convicted the mismatch (the TA lesson: when the runtime is right, the DECLARATION is what lies). - return.tenors: number[]; default: not declared — Unique tenors, ascending. - return.volatilityType: SabrVolatilityType; default: not declared ### @insiderfinance/totalfinance/volatility#swaptionCubeVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate the swaption cube's implied vol at an arbitrary `(expiry, tenor, strike)` by bilinearly interpolating the forward and SABR parameters across the grid, then evaluating the SABR smile. See `docs/specs/swaption-cube.md`. ```typescript export declare function swaptionCubeVolatility(query: SwaptionCubeVolatilityQuery): SwaptionCubeVolatilityResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (query): SwaptionCubeVolatilityQuery; default: not declared - (query).cube: SwaptionCube; default: not declared - (query).expiryYears: number; default: not declared — Option expiry in years. - (query).strike: number; default: not declared — Absolute strike rate. - (query).tenorYears: number; default: not declared — Underlying swap tenor in years. - return.assumptions: { conventionsVersion: string; interpolation: 'bilinear-parameters'; shift: number; volatilityType: SabrVolatilityType; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.interpolation: 'bilinear-parameters'; default: not declared - return.assumptions.shift: number; default: not declared — The cube's rate shift, echoed so the caller prices with the matching (shifted) convention. - return.assumptions.volatilityType: SabrVolatilityType; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.extrapolated: boolean; default: not declared — Whether the query fell outside the `(expiry, tenor)` grid (clamped to the edge). - return.forward: number; default: not declared — Interpolated forward swap rate. - return.parameters: SabrParameters; default: not declared — The interpolated SABR parameters used. - return.value: number; default: not declared — Interpolated implied vol. ### @insiderfinance/totalfinance/volatility#tailRiskIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The SKEW-style tail-risk index from an option chain: per-expiry risk-neutral skewness / excess kurtosis (BKM), plus the constant-maturity SKEW value. See `docs/specs/tail-risk-index.md`. ```typescript export declare function tailRiskIndex(options: TailRiskOptions): TailRiskResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): TailRiskOptions; default: not declared - (options).asOf: string | number; default: not declared - (options).horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (CBOE SKEW). - (options).quotes: readonly OptionQuote[]; default: not declared - (options).riskFreeRate: number; default: not declared - (options).spot: number; default: not declared - return.assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.horizonDays: number; default: not declared - return.assumptions.measure: 'risk-neutral'; default: not declared - return.assumptions.method: string; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.excessKurtosis: number; default: not declared — Constant-maturity risk-neutral excess kurtosis. - return.horizonDays: number; default: not declared - return.interpolatedBetween?: { far: string; near: string; }; default: not declared — The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). - return.interpolatedBetween.far: string; default: not declared - return.interpolatedBetween.near: string; default: not declared - return.skewIndex: number; default: not declared — Constant-maturity SKEW value (> 100 ⇒ elevated crash risk), interpolated to `horizonDays`. - return.skewness: number; default: not declared — Constant-maturity risk-neutral skewness. - return.termStructure: ExpiryTailRisk[]; default: not declared — Per-expiry moments — the whole tail-risk term structure, ascending by DTE. ### @insiderfinance/totalfinance/volatility#varianceIndex Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The VIX-style constant-maturity, model-free implied vol from an option chain, with the per-expiry fair-variance term structure. See `docs/specs/variance-index.md`. ```typescript export declare function varianceIndex(options: VarianceIndexOptions): VarianceIndexResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): VarianceIndexOptions; default: not declared - (options).asOf: string | number; default: not declared - (options).dividendYield?: number; default: not declared — Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). - (options).horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (VIX). - (options).quotes: readonly OptionQuote[]; default: not declared — Option chain across ≥ 1 expiries — call + put quotes with a usable mid. - (options).riskFreeRate: number; default: not declared - (options).spot: number; default: not declared - return.assumptions: { conventionsVersion: string; horizonDays: number; measure: 'risk-neutral'; method: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.horizonDays: number; default: not declared - return.assumptions.measure: 'risk-neutral'; default: not declared - return.assumptions.method: string; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.fairVolatility: number; default: not declared — Constant-maturity fair vol as a decimal (`index / 100`). - return.horizonDays: number; default: not declared - return.index: number; default: not declared — Constant-maturity model-free vol in VIX-style points (e.g. 20.0 = 20% annualized). - return.interpolatedBetween?: { far: string; near: string; }; default: not declared — The two expiries that bracketed the horizonPeriods (absent when extrapolated from one). - return.interpolatedBetween.far: string; default: not declared - return.interpolatedBetween.near: string; default: not declared - return.termStructure: ExpiryVariance[]; default: not declared — Per-expiry fair variance/vol — the whole term structure, ascending by DTE. - return.variance: number; default: not declared — Constant-maturity annualized fair variance (decimal). ### @insiderfinance/totalfinance/volatility#varianceRiskPremium Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Variance risk premium: `impliedVolatility² − realizedVolatility²`, the premium of option-implied ANNUALIZED variance over subsequently-realized annualized variance (the compensation for bearing variance risk; both inputs are annualized volatilities, so the result is in annualized-variance units). Positive on average. ```typescript export declare function varianceRiskPremium(input: RealizedImpliedInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): RealizedImpliedInput; default: not declared - (input).impliedVolatility: number; default: not declared — Annualized implied volatility (decimal). - (input).realizedVolatility: number; default: not declared — Annualized realized volatility (decimal) — e.g. `historicalVolatility(closes, { period, annualization: 252 })`. ### @insiderfinance/totalfinance/volatility#varianceRiskPremiumTermStructure Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The variance-risk-premium term structure — per-expiry implied variance (from {@link varianceIndex}) minus realized variance — plus the VRP at the constant-maturity index. See the spec. ```typescript export declare function varianceRiskPremiumTermStructure(options: VarianceRiskPremiumTermStructureOptions): VarianceRiskPremiumTermStructureResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): VarianceRiskPremiumTermStructureOptions; default: not declared - (options).asOf: string | number; default: not declared - (options).dividendYield?: number; default: not declared — Reserved for the forward; default 0 (the parity forward already carries dividend/borrow). - (options).horizonDays?: number; default: not declared — Constant-maturity target in calendar days. Default 30 (VIX). - (options).quotes: readonly OptionQuote[]; default: not declared — Option chain across ≥ 1 expiries — call + put quotes with a usable mid. - (options).realizedVolatility: number | Record; default: not declared — Realized vol to compare (decimal): one number for the whole curve, or per-expiry by ISO date. - (options).riskFreeRate: number; default: not declared - (options).spot: number; default: not declared - return.assumptions: { conventionsVersion: string; measure: 'risk-neutral'; method: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.measure: 'risk-neutral'; default: not declared - return.assumptions.method: string; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.indexVarianceRiskPremium: number; default: not declared — VRP at the constant-maturity index vs the reference realized vol. - return.points: VarianceRiskPremiumPoint[]; default: not declared ### @insiderfinance/totalfinance/volatility#varianceSwapRate Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Model-free implied volatility via the CBOE VIX replication (Demeterfi–Derman–Kamal–Zou): a strip of out-of-the-money option mid-prices integrates to the fair variance `σ² = (2/T)·Σ (ΔKᵢ/Kᵢ²)·e^{rT}·Q(Kᵢ) − (1/T)·(F/K₀ − 1)²`, where `K₀` is the highest strike below the forward `F`. `otmPrices[i]` is the OTM option (put below `F`, call above) mid at `strikes[i]`. **At `K₀` the CBOE strip is the AVERAGE of the put and the call**, and the `−(1/T)(F/K₀ − 1)²` correction subtracted here is derived for exactly that convention. Supply the `K₀` call as `boundaryCallPrice` and pass the `K₀` PUT in `otmPrices` — the two are averaged for you. With a put-only `K₀` price and no `boundaryCallPrice` the strip under-states variance by `ΔK₀·(F − K₀)/(T·K₀²)` (by put–call parity the missing half-difference is `(C−P)/2 = e^{−rT}(F−K₀)/2`), which on a typical 1-month index chain is ~1.7 vol points — so the disclosure rides the result. ```typescript export declare function varianceSwapRate(options: { strikes: number[]; otmPrices: number[]; forward: number; riskFreeRate: number; timeToExpiryYears: number; boundaryCallPrice?: number; boundaryPriceAveraged?: boolean; }): Computed; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { boundaryCallPrice?: number; boundaryPriceAveraged?: boolean; forward: number; otmPrices: number[]; riskFreeRate: number; strikes: number[]; timeToExpiryYears: number; }; default: not declared - (options).boundaryCallPrice?: number; default: not declared — The CALL price at `K₀` (the highest strike ≤ `F`), with the `K₀` PUT passed in `otmPrices`. Supplied ⇒ the `K₀` term becomes the CBOE put/call average; omitted ⇒ `otmPrices` is used as given and the put-only bias is disclosed in `diagnostics`. - (options).boundaryPriceAveraged?: boolean; default: not declared — Set when `otmPrices` at `K₀` is ALREADY the CBOE put/call average (a chain extractor that averaged there). Suppresses the put-only bias disclosure without touching the arithmetic. Cannot be combined with `boundaryCallPrice` — that would average an average. - (options).forward: number; default: not declared - (options).otmPrices: number[]; default: not declared - (options).riskFreeRate: number; default: not declared - (options).strikes: number[]; default: not declared - (options).timeToExpiryYears: number; default: not declared - return.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ measure: 'risk-neutral'; method: 'ddkz-replication'; }>; default: not declared — Every applied convention, echoed back. - return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - return.value: VarianceSwapResult; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). ### @insiderfinance/totalfinance/volatility#volatilityCone Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Realized-volatility cone: for each lookback `window`, the percentile spread of annualized realized volatility across all rolling windows of the return series, plus the current reading. The classic "is implied vol rich or cheap vs the underlying's own realized history" view. Facade (H27): the plain call returns the rows array; `.explain()` discloses the applied `periodsPerYear`, windows, and annualization convention in `assumptions`, and the observation count / annualization factor in `diagnostics.decomposition`. Hand-attached (not `seriesFacade`) so the closed-request teaching errors for the options bag stay byte-identical. ```typescript export declare const volatilityCone: VolatilityConeFacade; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options): { periodsPerYear?: number; windows: number[]; }; default: not declared - (options).periodsPerYear?: number; default: not declared - (options).windows: number[]; default: not declared - (returns): ArrayLike; default: not declared - explain: (returns: ArrayLike, options: { windows: number[]; periodsPerYear?: number; }) => Omit, 'assumptions'> & { assumptions: VolatilityConeAssumptions; }; default: not declared - explain().return.assumptions: VolatilityConeAssumptions; default: not declared - explain().return.diagnostics: Diagnostics; default: not declared — How the value was computed, plus any warnings. - explain().return.provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Optional data lineage when the inputs came from a provider. - explain().return.value: VolatilityConeWindow[]; default: not declared — The computed value. Never `NaN` or `±Infinity`: a value the model cannot produce is `null` beside a diagnostic that says why (Law 7 — a warning never licenses a non-finite number). - explain(options): { periodsPerYear?: number; windows: number[]; }; default: not declared - explain(options).periodsPerYear?: number; default: not declared - explain(options).windows: number[]; default: not declared - explain(returns): ArrayLike; default: not declared ### @insiderfinance/totalfinance/volatility#volatilitySurface Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function volatilitySurface(input: VolatilitySurfaceInput): VolatilitySurface; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VolatilitySurfaceInput; default: not declared - (input).config?: SurfaceConfig; default: not declared - (input).market: SurfaceMarket; default: not declared - (input).quotes: OptionQuote[]; default: not declared - return.arbitrage: (options?: ArbitrageCheckOptions) => ArbitrageReport; default: not declared — Run the static no-arbitrage diagnostics (calendar + butterfly) over this surface. - return.assumptions: Assumptions<{ shock?: SurfaceShock; }>; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.essvi?: ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`, else `undefined`. - return.expiries: () => string[]; default: not declared — Sorted list of the surface's expiry labels. - return.heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`, else `undefined`. - return.impliedVolatility: (strike: number, expiry: string | number) => number; default: not declared — Implied vol at `(strike, expiry)`. Throws if the surface is empty (never fabricates). - return.impliedVolatilityByDelta: (callDelta: number, expiry: string | number) => number; default: not declared — Implied vol on the call-delta axis: interpolate the strike whose call-delta equals `callDelta` (∈ (0, 1)) from the slice's stored delta ladder, then read the smile there. A 0.25 delta selects the 25-delta call strike. - return.impliedVolatilityByMoneyness: (moneyness: number, expiry: string | number, options?: { forward?: boolean; }) => number; default: not declared — Implied vol on the moneyness axis. `moneyness` is `K/S` (spot-moneyness) by default, or `K/F` (forward-moneyness) when `forward` is set — so `impliedVolatilityByMoneyness(1, e)` is the at-the-money(-forward) vol. For a NUMERIC `expiry` (a maturity in years) the forward is computed AT THAT MATURITY, `F(t) = spot·e^{(r−q)·t}` — not borrowed from the nearest fitted slice, which anchored a mid-expiry query to a neighbour's forward and shifted the ATM-forward point off by the carry between them. - return.lookup: (strike: number, expiry: string | number) => SurfaceLookup; default: not declared — Implied vol at `(strike, expiry)` with diagnostics. Strike uses the per-slice smile; expiry interpolates total variance linearly between the two bracketing slices. `extrapolated` is true when the query lies outside the fitted strike range or expiry range. - return.model: SurfaceModel; default: not declared - return.points: SurfacePoint[]; default: not declared - return.shock: (shifts: { parallel?: number; skewTilt?: number; }, { sticky }?: { sticky?: 'strike' | 'moneyness'; }) => VolatilitySurface; default: not declared — Return a NEW surface with a shifted vol structure, produced WITHOUT re-fitting: each stored IV sample gains a `parallel` offset plus a `skewTilt · k` skew rotation (`k = ln(K/forward)`, log-moneyness), the per-slice deltas are recomputed from the shifted IVs, and only the interpolators are rebuilt. The shock is echoed in the new surface's `assumptions.shock`. `sticky`: `'strike'` (default) pins the tilt to each stored strike's own log-moneyness vs the slice forward; `'moneyness'` lets the same additive shift travel with moneyness. Because the shift is applied to the stored strike-indexed IV samples, both modes coincide at the stored strikes in this eager v1 — the distinction only matters once a surface is re-anchored to a new spot/forward, which this method does not do; the requested mode is recorded in `assumptions.shock.sticky` so a caller that later re-anchors knows how the tilt was meant to travel. Parametric models (`svi`/`sabr`/`heston`) have no closed-form shock, so the current smile is SAMPLED at each slice's stored strikes, those samples are shifted, and the result DEGRADES to `'interpolated'` with a `volatility.shock_degraded_to_interpolated` `warn` — the parametric fit is not re-fit. Non-parametric models (`raw`/`interpolated`/`smoothed`) are preserved. - return.slice: (expiry: string | number) => SurfaceSlice | undefined; default: not declared — The smile at an expiry (exact label or nearest by `t`), or `undefined` if none. - return.slices: SurfaceSlice[]; default: not declared - return.ssvi?: SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`, else `undefined`. - return.toJSON: () => VolatilitySurfaceSnapshot; default: not declared — Serialize the surface to a plain, JSON-safe {@link VolatilitySurfaceSnapshot} (no closures). Restore it with {@link VolatilitySurface.fromJSON}; the pair round-trips `iv()` identically on all six models. - return.toRows: () => SurfaceRow[]; default: not declared — The smile-chart / heatmap feed: one {@link SurfaceRow} per (slice, stored strike), with `logMoneyness = ln(strike/forward)` and the stored `delta`/`iv`. Per the workspace missing-value policy (WS2.12), any non-finite chart-facing numeric is emitted as `null` (never `NaN`, never omitted). ## Entrypoint @insiderfinance/totalfinance/volatility/analytics ### @insiderfinance/totalfinance/volatility/analytics#RiskNeutralDistribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#RiskNeutralDistribution`. ### @insiderfinance/totalfinance/volatility/analytics#RiskNeutralOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#RiskNeutralOptions`. ### @insiderfinance/totalfinance/volatility/analytics#VarianceSwapResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VarianceSwapResult`. ### @insiderfinance/totalfinance/volatility/analytics#VolatilityConeAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilityConeAssumptions`. ### @insiderfinance/totalfinance/volatility/analytics#VolatilityConeFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilityConeFacade`. ### @insiderfinance/totalfinance/volatility/analytics#VolatilityConeWindow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilityConeWindow`. ### @insiderfinance/totalfinance/volatility/analytics#riskNeutralDistribution Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#riskNeutralDistribution`. ### @insiderfinance/totalfinance/volatility/analytics#varianceSwapRate Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#varianceSwapRate`. ### @insiderfinance/totalfinance/volatility/analytics#volatilityCone Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#volatilityCone`. ## Entrypoint @insiderfinance/totalfinance/volatility/arbitrage ### @insiderfinance/totalfinance/volatility/arbitrage#ArbitrageCheckOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ArbitrageCheckOptions`. ### @insiderfinance/totalfinance/volatility/arbitrage#ArbitrageKind Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ArbitrageKind`. ### @insiderfinance/totalfinance/volatility/arbitrage#ArbitrageReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ArbitrageReport`. ### @insiderfinance/totalfinance/volatility/arbitrage#ArbitrageSlice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ArbitrageSlice`. ### @insiderfinance/totalfinance/volatility/arbitrage#ArbitrageViolation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ArbitrageViolation`. ### @insiderfinance/totalfinance/volatility/arbitrage#ButterflyCheckOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ButterflyCheckOptions`. ### @insiderfinance/totalfinance/volatility/arbitrage#CalendarCheckOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#CalendarCheckOptions`. ### @insiderfinance/totalfinance/volatility/arbitrage#arbitrageReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#arbitrageReport`. ### @insiderfinance/totalfinance/volatility/arbitrage#checkButterfly Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#checkButterfly`. ### @insiderfinance/totalfinance/volatility/arbitrage#checkCalendar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#checkCalendar`. ### @insiderfinance/totalfinance/volatility/arbitrage#surfaceArbitrageReport Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#surfaceArbitrageReport`. ## Entrypoint @insiderfinance/totalfinance/volatility/artifacts ### @insiderfinance/totalfinance/volatility/artifacts#CalibrationOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type CalibrationOf = VolatilityCalibrations[F]; ``` ### @insiderfinance/totalfinance/volatility/artifacts#EvaluationOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type EvaluationOf = VolatilityEvaluations[F]; ``` ### @insiderfinance/totalfinance/volatility/artifacts#FITTED_MODEL_FAMILIES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The frozen, data-only descriptor table (Program 5's registry metadata). ```typescript export declare const FITTED_MODEL_FAMILIES: Readonly>; ``` ### @insiderfinance/totalfinance/volatility/artifacts#FITTED_MODEL_LIMITS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Decision 9's bounded-work table (core's `ARTIFACT_WORK_LIMITS`, re-exported for this subpath's callers). ```typescript export declare const FITTED_MODEL_LIMITS: Readonly<{ maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; gridPoints: Readonly<{ default: 256; maximum: 4096; }>; restarts: Readonly<{ maximum: 64; }>; holdoutEvaluations: Readonly<{ maximum: 100000; }>; listedIds: Readonly<{ default: 200; maximum: 10000; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - embeddedRowLimit: Readonly<{ default: 5000; maximum: 50000; }>; default: not declared - embeddedRowLimit.default: 5000; default: not declared - embeddedRowLimit.maximum: 50000; default: not declared - gridPoints: Readonly<{ default: 256; maximum: 4096; }>; default: not declared - gridPoints.default: 256; default: not declared - gridPoints.maximum: 4096; default: not declared - holdoutEvaluations: Readonly<{ maximum: 100000; }>; default: not declared - holdoutEvaluations.maximum: 100000; default: not declared - listedIds: Readonly<{ default: 200; maximum: 10000; }>; default: not declared - listedIds.default: 200; default: not declared - listedIds.maximum: 10000; default: not declared - maximumDifferences: Readonly<{ default: 1000; maximum: 100000; }>; default: not declared - maximumDifferences.default: 1000; default: not declared - maximumDifferences.maximum: 100000; default: not declared - maximumEmbeddedBytes: Readonly<{ default: 1048576; maximum: 8388608; }>; default: not declared - maximumEmbeddedBytes.default: 1048576; default: not declared - maximumEmbeddedBytes.maximum: 8388608; default: not declared - maximumLeaves: Readonly<{ default: 2000000; maximum: 2000000; }>; default: not declared - maximumLeaves.default: 2000000; default: not declared - maximumLeaves.maximum: 2000000; default: not declared - restarts: Readonly<{ maximum: 64; }>; default: not declared - restarts.maximum: 64; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FitOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FitOf = VolatilityFits[F]; ``` ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelArtifactInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelArtifactInput { family: F; /** The direct calibrator's result; for `volatility-surface` the live surface is accepted and snapshotted. */ fit: F extends 'volatility-surface' ? FitOf | VolatilitySurface : FitOf; /** The calibrator's input with its rows — the adapter mints the handle for any row set named in `referenceRowSets`. */ calibration: CalibrationOf; /** Row sets (from the family descriptor's `referenceableRowSets`) to store by `TableHandle` instead of embedding. */ referenceRowSets?: readonly string[]; /** Storage locators to stamp on the minted handles, keyed by row set. */ locators?: Record; snapshotHash?: string; libraryVersion?: string; createdFrom?: string[]; provenance?: Provenance; limits?: FittedModelArtifactLimits; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibration: CalibrationOf; default: not declared — The calibrator's input with its rows — the adapter mints the handle for any row set named in `referenceRowSets`. - createdFrom?: string[]; default: not declared - family: F; default: not declared - fit: F extends 'volatility-surface' ? VolatilitySurface | FitOf : FitOf; default: not declared — The direct calibrator's result; for `volatility-surface` the live surface is accepted and snapshotted. - libraryVersion?: string; default: not declared - limits?: FittedModelArtifactLimits; default: not declared - limits.embeddedRowLimit?: number; default: not declared - limits.maximumEmbeddedBytes?: number; default: not declared - locators?: Record; default: not declared — Storage locators to stamp on the minted handles, keyed by row set. - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - referenceRowSets?: readonly string[]; default: not declared — Row sets (from the family descriptor's `referenceableRowSets`) to store by `TableHandle` instead of embedding. - snapshotHash?: string; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelArtifactLimits Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income/artifacts#FittedModelArtifactLimits`. ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelComparison Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelComparison { family: F; artifactIds: { baseline: string | null; candidate: string | null; }; sameMarket: boolean | null; sameCalibrationInput: boolean; parameters: ParameterDelta[]; objective: { kind: string; unit: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; }; convergence: { baseline: boolean; candidate: boolean; }; residuals: { baselineRootMeanSquare: number | null; candidateRootMeanSquare: number | null; absoluteDelta: number | null; }; modelRisk: { baselineArbitrageFree: boolean | null; candidateArbitrageFree: boolean | null; changed: boolean; }; fit: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; evaluation: { grid: Array>; unit: string; comparedCount: number; nullCount: number; maximumAbsoluteDifference: number | null; rootMeanSquareDifference: number | null; placement: string; } | null; withinTolerance: boolean | null; assumptions: { conventionsVersion: string; family: F; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; gridPoints: number; }; evaluationReason: string | null; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - artifactIds.baseline: string | null; default: not declared - artifactIds.candidate: string | null; default: not declared - assumptions: { conventionsVersion: string; family: F; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; gridPoints: number; }; evaluationReason: string | null; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.evaluationReason: string | null; default: not declared - assumptions.family: F; default: not declared - assumptions.limits: { gridPoints: number; maximumDifferences: number; maximumLeaves: number; }; default: not declared - assumptions.limits.gridPoints: number; default: not declared - assumptions.limits.maximumDifferences: number; default: not declared - assumptions.limits.maximumLeaves: number; default: not declared - assumptions.tolerance: ComparisonTolerance | null; default: not declared - assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - convergence: { baseline: boolean; candidate: boolean; }; default: not declared - convergence.baseline: boolean; default: not declared - convergence.candidate: boolean; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - evaluation: { comparedCount: number; grid: Array>; maximumAbsoluteDifference: number | null; nullCount: number; placement: string; rootMeanSquareDifference: number | null; unit: string; } | null; default: not declared - evaluation.comparedCount: number; default: not declared - evaluation.grid: Record[]; default: not declared - evaluation.maximumAbsoluteDifference: number | null; default: not declared - evaluation.nullCount: number; default: not declared - evaluation.placement: string; default: not declared - evaluation.rootMeanSquareDifference: number | null; default: not declared - evaluation.unit: string; default: not declared - family: F; default: not declared - fit: { addedPaths: string[]; differenceCount: number; removedPaths: string[]; retainedDifferences: number; truncated: boolean; }; default: not declared - fit.addedPaths: string[]; default: not declared - fit.differenceCount: number; default: not declared - fit.removedPaths: string[]; default: not declared - fit.retainedDifferences: number; default: not declared - fit.truncated: boolean; default: not declared - modelRisk: { baselineArbitrageFree: boolean | null; candidateArbitrageFree: boolean | null; changed: boolean; }; default: not declared - modelRisk.baselineArbitrageFree: boolean | null; default: not declared - modelRisk.candidateArbitrageFree: boolean | null; default: not declared - modelRisk.changed: boolean; default: not declared - objective: { absoluteDelta: number | null; baselineValue: number | null; candidateValue: number | null; kind: string; unit: string; }; default: not declared - objective.absoluteDelta: number | null; default: not declared - objective.baselineValue: number | null; default: not declared - objective.candidateValue: number | null; default: not declared - objective.kind: string; default: not declared - objective.unit: string; default: not declared - parameters: ParameterDelta[]; default: not declared - residuals: { absoluteDelta: number | null; baselineRootMeanSquare: number | null; candidateRootMeanSquare: number | null; }; default: not declared - residuals.absoluteDelta: number | null; default: not declared - residuals.baselineRootMeanSquare: number | null; default: not declared - residuals.candidateRootMeanSquare: number | null; default: not declared - sameCalibrationInput: boolean; default: not declared - sameMarket: boolean | null; default: not declared - withinTolerance: boolean | null; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelEvaluation Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelEvaluation { family: F; at: EvaluationOf; values: (number | null)[]; reasons: Array<{ index: number; reason: string; }>; coordinates: Array>; unit: string; assumptions: { conventionsVersion: string; family: F; modelVersion: number; evaluator: string; options: Record; extrapolation: string; }; diagnostics: { warnings: QuantWarning[]; outsideCalibratedRange: number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; evaluator: string; options: Record; extrapolation: string; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.evaluator: string; default: not declared - assumptions.extrapolation: string; default: not declared - assumptions.family: F; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.options: Record; default: not declared - at: EvaluationOf; default: not declared - coordinates: Record[]; default: not declared - diagnostics: { outsideCalibratedRange: number; warnings: QuantWarning[]; }; default: not declared - diagnostics.outsideCalibratedRange: number; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - reasons: { index: number; reason: string; }[]; default: not declared - unit: string; default: not declared - values: (number | null)[]; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelFamilyDescriptor Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Program 5's "registry metadata" as DATA — one frozen descriptor per family, no runtime registry. ```typescript /** Program 5's "registry metadata" as DATA — one frozen descriptor per family, no runtime registry. */ export interface FittedModelFamilyDescriptor { family: string; qualifiedFamily: string; modelVersion: number; calibrator: string; evaluator: string | null; warmStart: boolean; /** Dot path of the one bulk row set that may be referenced by a `TableHandle`, or none. */ referenceableRowSets: readonly string[]; costClass: 'closed-form' | 'least-squares' | 'iterative-pricing' | 'bootstrap' | 'statistic'; requiredData: string; supportedProducts: string; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibrator: string; default: not declared - costClass: 'statistic' | 'closed-form' | 'least-squares' | 'iterative-pricing' | 'bootstrap'; default: not declared - evaluator: string | null; default: not declared - family: string; default: not declared - modelVersion: number; default: not declared - qualifiedFamily: string; default: not declared - referenceableRowSets: readonly string[]; default: not declared — Dot path of the one bulk row set that may be referenced by a `TableHandle`, or none. - requiredData: string; default: not declared - supportedProducts: string; default: not declared - warmStart: boolean; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelHoldoutInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelHoldoutInput { family: F; calibration: CalibrationOf; holdout: FittedModelHoldoutSelection; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibration: CalibrationOf; default: not declared - family: F; default: not declared - holdout: FittedModelHoldoutSelection; default: not declared - holdout.everyNth: number; default: not declared - holdout.indices: number[]; default: not declared - holdout.lastCount: number; default: not declared - holdout.offset: number; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelHoldoutReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelHoldoutReport { family: F; retainedCount: number; heldOutCount: number; inSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; outOfSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; unit: string; retainedFit: FittedModelSummary; assumptions: { conventionsVersion: string; family: F; modelVersion: number; holdout: FittedModelHoldoutSelection; residualSource: 'direct-evaluator'; partition: 'cross-sectional points' | 'time-series prefix'; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; holdout: FittedModelHoldoutSelection; residualSource: 'direct-evaluator'; partition: 'cross-sectional points' | 'time-series prefix'; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.family: F; default: not declared - assumptions.holdout: FittedModelHoldoutSelection; default: not declared - assumptions.holdout.everyNth: number; default: not declared - assumptions.holdout.indices: number[]; default: not declared - assumptions.holdout.lastCount: number; default: not declared - assumptions.holdout.offset: number; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.partition: 'cross-sectional points' | 'time-series prefix'; default: not declared - assumptions.residualSource: 'direct-evaluator'; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - heldOutCount: number; default: not declared - inSample: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; }; default: not declared - inSample.count: number; default: not declared - inSample.maximumAbsolute: number | null; default: not declared - inSample.rootMeanSquare: number | null; default: not declared - outOfSample: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; }; default: not declared - outOfSample.count: number; default: not declared - outOfSample.maximumAbsolute: number | null; default: not declared - outOfSample.rootMeanSquare: number | null; default: not declared - retainedCount: number; default: not declared - retainedFit: FittedModelSummary; default: not declared - retainedFit.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - retainedFit.convergence.converged: boolean; default: not declared - retainedFit.convergence.iterations: number | null; default: not declared - retainedFit.convergence.reason?: string; default: not declared - retainedFit.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - retainedFit.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - retainedFit.inputIdentity.calibrationHash: string; default: not declared - retainedFit.inputIdentity.snapshotHash: string | null; default: not declared - retainedFit.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - retainedFit.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - retainedFit.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - retainedFit.modelRisk.notes: string[]; default: not declared - retainedFit.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - retainedFit.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - retainedFit.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - retainedFit.objective.reason?: string; default: not declared — Required exactly when `value` is null. - retainedFit.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - retainedFit.objective.value: number | null; default: not declared - retainedFit.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - retainedFit.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - retainedFit.residuals.count: number; default: not declared - retainedFit.residuals.maximumAbsolute: number | null; default: not declared - retainedFit.residuals.rootMeanSquare: number | null; default: not declared - retainedFit.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - retainedFit.residuals.unit: string; default: not declared - retainedFit.warningCount: number; default: not declared - retainedFit.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. - unit: string; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelHoldoutSelection Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type FittedModelHoldoutSelection = { indices: number[]; } | { everyNth: number; offset: number; } | { lastCount: number; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - everyNth: number; default: not declared - indices: number[]; default: not declared - lastCount: number; default: not declared - offset: number; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelReplay Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelReplay { family: F; artifactId: string; recomputed: VolatilityFittedModelReport; parity: ArtifactReplayParity; assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifactId: string; default: not declared - assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; default: not declared - assumptions.calibrator: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.family: F; default: not declared - assumptions.libraryVersion: { current: string | null; saved: string | null; }; default: not declared - assumptions.libraryVersion.current: string | null; default: not declared - assumptions.libraryVersion.saved: string | null; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.referencedRowSets: string[]; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - parity: ArtifactReplayParity; default: not declared - parity.addedPaths: string[]; default: not declared - parity.assumptions: { comparison: 'canonical JSON bytes'; conventionsVersion: string; limits: { maximumDifferences: number; maximumLeaves: number; }; }; default: not declared - parity.assumptions.comparison: 'canonical JSON bytes'; default: not declared - parity.assumptions.conventionsVersion: string; default: not declared - parity.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; }; default: not declared - parity.assumptions.limits.maximumDifferences: number; default: not declared - parity.assumptions.limits.maximumLeaves: number; default: not declared - parity.comparedLeafCount: number; default: not declared - parity.diagnostics: { warnings: QuantWarning[]; }; default: not declared - parity.diagnostics.warnings: QuantWarning[]; default: not declared - parity.differenceCount: number; default: not declared - parity.differences: import('@insiderfinance/totalfinance/core/artifacts').ValueDifference[]; default: not declared - parity.identical: boolean; default: not declared - parity.recomputedHash: string; default: not declared - parity.removedPaths: string[]; default: not declared - parity.savedHash: string; default: not declared - parity.truncated: boolean; default: not declared - recomputed: VolatilityFittedModelReport; default: not declared - recomputed.assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; evaluator: string | null; inputPolicy: 'embedded' | 'referenced'; projection: string; }; default: not declared - recomputed.assumptions.calibrator: string; default: not declared - recomputed.assumptions.conventionsVersion: string; default: not declared - recomputed.assumptions.evaluator: string | null; default: not declared - recomputed.assumptions.family: F; default: not declared - recomputed.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - recomputed.assumptions.modelVersion: number; default: not declared - recomputed.assumptions.projection: string; default: not declared - recomputed.calibration: StoredCalibrationOf; default: not declared — The calibrator's input, verbatim, except that a referenced bulk row set is its `TableHandle`. - recomputed.diagnostics: { warnings: QuantWarning[]; fitWarningCount: number; embeddedCalibrationBytes: number; referencedRowSets: string[]; }; default: not declared - recomputed.diagnostics.embeddedCalibrationBytes: number; default: not declared - recomputed.diagnostics.fitWarningCount: number; default: not declared - recomputed.diagnostics.referencedRowSets: string[]; default: not declared - recomputed.diagnostics.warnings: QuantWarning[]; default: not declared - recomputed.family: F; default: not declared - recomputed.fit: FitOf; default: not declared — The direct calibrator's result, verbatim (the surface as its own `toJSON()` snapshot). - recomputed.modelVersion: number; default: not declared - recomputed.referencedData: Record; default: not declared - recomputed.summary: FittedModelSummary; default: not declared - recomputed.summary.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - recomputed.summary.convergence.converged: boolean; default: not declared - recomputed.summary.convergence.iterations: number | null; default: not declared - recomputed.summary.convergence.reason?: string; default: not declared - recomputed.summary.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - recomputed.summary.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - recomputed.summary.inputIdentity.calibrationHash: string; default: not declared - recomputed.summary.inputIdentity.snapshotHash: string | null; default: not declared - recomputed.summary.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - recomputed.summary.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - recomputed.summary.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - recomputed.summary.modelRisk.notes: string[]; default: not declared - recomputed.summary.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - recomputed.summary.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - recomputed.summary.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - recomputed.summary.objective.reason?: string; default: not declared — Required exactly when `value` is null. - recomputed.summary.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - recomputed.summary.objective.value: number | null; default: not declared - recomputed.summary.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - recomputed.summary.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - recomputed.summary.residuals.count: number; default: not declared - recomputed.summary.residuals.maximumAbsolute: number | null; default: not declared - recomputed.summary.residuals.rootMeanSquare: number | null; default: not declared - recomputed.summary.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - recomputed.summary.residuals.unit: string; default: not declared - recomputed.summary.warningCount: number; default: not declared - recomputed.summary.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelStabilityInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelStabilityInput { family: F; calibration: CalibrationOf; restarts: number; perturbation: { relative: number; }; seed: number; tolerance?: ComparisonTolerance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - calibration: CalibrationOf; default: not declared - family: F; default: not declared - perturbation: { relative: number; }; default: not declared - perturbation.relative: number; default: not declared - restarts: number; default: not declared - seed: number; default: not declared - tolerance?: ComparisonTolerance; default: not declared - tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. ### @insiderfinance/totalfinance/volatility/artifacts#FittedModelStabilityReport Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface FittedModelStabilityReport { family: F; restarts: number; parameters: Record; objective: { unit: string; baseline: number | null; minimum: number | null; maximum: number | null; }; convergedCount: number; stable: boolean | null; assumptions: { conventionsVersion: string; family: F; modelVersion: number; seed: number; generator: 'mulberry32'; perturbation: { relative: number; }; members: string[]; tolerance: ComparisonTolerance | null; }; diagnostics: { warnings: QuantWarning[]; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; seed: number; generator: 'mulberry32'; perturbation: { relative: number; }; members: string[]; tolerance: ComparisonTolerance | null; }; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.family: F; default: not declared - assumptions.generator: 'mulberry32'; default: not declared - assumptions.members: string[]; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.perturbation: { relative: number; }; default: not declared - assumptions.perturbation.relative: number; default: not declared - assumptions.seed: number; default: not declared - assumptions.tolerance: ComparisonTolerance | null; default: not declared - assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - convergedCount: number; default: not declared - diagnostics: { warnings: QuantWarning[]; }; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - objective: { baseline: number | null; maximum: number | null; minimum: number | null; unit: string; }; default: not declared - objective.baseline: number | null; default: not declared - objective.maximum: number | null; default: not declared - objective.minimum: number | null; default: not declared - objective.unit: string; default: not declared - parameters: Record; default: not declared - restarts: number; default: not declared - stable: boolean | null; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#ParameterDelta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/fixed-income/artifacts#ParameterDelta`. ### @insiderfinance/totalfinance/volatility/artifacts#ReadFittedModelResult Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface ReadFittedModelResult { report: VolatilityFittedModelReport; artifact: AnalysisArtifact; migrationsApplied: AppliedMigration[]; modelMigrationsApplied: AppliedMigration[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifact: AnalysisArtifact; default: not declared - artifact.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - artifact.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - artifact.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - artifact.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - artifact.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - artifact.inputs.inputsHash: string; default: not declared — Hash of everything replay needs: `{ snapshotHash, parameters }` — stamped, not caller-set, and RECOMPUTED from the stored fields on every validation pass (create and read), so a tampered hash or tampered inputs are refused even when the outer id was re-minted to match. - artifact.inputs.parameters?: unknown; default: not declared — The small, JSON-safe call parameters, embedded verbatim. Reference big inputs via tables. - artifact.inputs.snapshotHash?: string; default: not declared — `marketSnapshotContentHash(...)` of the snapshot the analysis read, when one was used. - artifact.kind: 'totalfinance.analysis-artifact'; default: not declared - artifact.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - artifact.producedBy.libraryVersion?: string; default: not declared — The TotalFinance version that produced it, when the caller knows it (e.g. from package.json). - artifact.producedBy.operation: string; default: not declared — The public operation name, e.g. `'analyzeChain'` or `'options.blackScholes.explain'`. - artifact.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - artifact.provenance.asOf?: number; default: not declared - artifact.provenance.dataset?: string; default: not declared - artifact.provenance.provider?: string; default: not declared - artifact.provenance.receivedAt?: number; default: not declared - artifact.provenance.requestId?: string; default: not declared - artifact.provenance.sourceVersion?: string; default: not declared - artifact.provenance.warnings?: QuantWarning[]; default: not declared - artifact.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - artifact.schemaVersion: number; default: not declared - artifact.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - migrationsApplied: AppliedMigration[]; default: not declared - modelMigrationsApplied: AppliedMigration[]; default: not declared - report: VolatilityFittedModelReport; default: not declared - report.assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; evaluator: string | null; inputPolicy: 'embedded' | 'referenced'; projection: string; }; default: not declared - report.assumptions.calibrator: string; default: not declared - report.assumptions.conventionsVersion: string; default: not declared - report.assumptions.evaluator: string | null; default: not declared - report.assumptions.family: F; default: not declared - report.assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - report.assumptions.modelVersion: number; default: not declared - report.assumptions.projection: string; default: not declared - report.calibration: StoredCalibrationOf; default: not declared — The calibrator's input, verbatim, except that a referenced bulk row set is its `TableHandle`. - report.diagnostics: { embeddedCalibrationBytes: number; fitWarningCount: number; referencedRowSets: string[]; warnings: QuantWarning[]; }; default: not declared - report.diagnostics.embeddedCalibrationBytes: number; default: not declared - report.diagnostics.fitWarningCount: number; default: not declared - report.diagnostics.referencedRowSets: string[]; default: not declared - report.diagnostics.warnings: QuantWarning[]; default: not declared - report.family: F; default: not declared - report.fit: FitOf; default: not declared — The direct calibrator's result, verbatim (the surface as its own `toJSON()` snapshot). - report.modelVersion: number; default: not declared - report.referencedData: Record; default: not declared - report.summary: FittedModelSummary; default: not declared - report.summary.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - report.summary.convergence.converged: boolean; default: not declared - report.summary.convergence.iterations: number | null; default: not declared - report.summary.convergence.reason?: string; default: not declared - report.summary.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - report.summary.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - report.summary.inputIdentity.calibrationHash: string; default: not declared - report.summary.inputIdentity.snapshotHash: string | null; default: not declared - report.summary.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - report.summary.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - report.summary.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - report.summary.modelRisk.notes: string[]; default: not declared - report.summary.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - report.summary.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - report.summary.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - report.summary.objective.reason?: string; default: not declared — Required exactly when `value` is null. - report.summary.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - report.summary.objective.value: number | null; default: not declared - report.summary.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - report.summary.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - report.summary.residuals.count: number; default: not declared - report.summary.residuals.maximumAbsolute: number | null; default: not declared - report.summary.residuals.rootMeanSquare: number | null; default: not declared - report.summary.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - report.summary.residuals.unit: string; default: not declared - report.summary.warningCount: number; default: not declared - report.summary.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/volatility/artifacts#StoredCalibrationOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type StoredCalibrationOf = VolatilityStoredCalibrations[F]; ``` ### @insiderfinance/totalfinance/volatility/artifacts#VOLATILITY_FITTED_MODEL_ARTIFACT_TYPE Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const VOLATILITY_FITTED_MODEL_ARTIFACT_TYPE: 'volatility.fitted-model'; ``` ### @insiderfinance/totalfinance/volatility/artifacts#VOLATILITY_MODEL_FAMILIES Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare const VOLATILITY_MODEL_FAMILIES: readonly VolatilityModelFamily[]; ``` ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityCalibrations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The direct calibrator's input per family, verbatim. ```typescript /** The direct calibrator's input per family, verbatim. */ export interface VolatilityCalibrations { svi: { smile: SVISmileInput; options?: SVICalibrationOptions; }; ssvi: { surface: SSVICalibrationInput; options?: SSVICalibrationOptions; }; essvi: { surface: ESSVICalibrationInput; options?: ESSVICalibrationOptions; }; 'sabr-smile': { smile: SABRSmileInput; options?: SABRCalibrationOptions; }; 'heston-surface': HestonSurfaceCalibrationInput; 'vanna-volga': VannaVolgaInput; 'vanna-volga-5': VannaVolga5Input; 'event-volatility': FitEventVolatilityOptions; 'event-move': { observations: readonly EventMoveObservation[]; }; garch: { returns: number[]; options?: GarchFitOptions; }; 'har-rv': { realizedVariances: number[]; options?: HarRvOptions; }; 'volatility-surface': VolatilitySurfaceInput; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - essvi: { surface: ESSVICalibrationInput; options?: ESSVICalibrationOptions; }; default: not declared - essvi.options?: ESSVICalibrationOptions; default: not declared - essvi.options.initialParameters?: { phi: SSVIPhi; rho: number | number[]; }; default: not declared — Warm start (Stage 4.5): a scalar `rho` broadcasts to every maturity knot, an array must match the slice count; `phi.kind` must equal the calibration's `phi` family. A supplied start REPLACES the internal SSVI warm start (echoed in `assumptions.initialParameters`). - essvi.options.initialParameters.phi: SSVIPhi; default: not declared - essvi.options.initialParameters.phi.eta: number; default: not declared - essvi.options.initialParameters.phi.gamma: number; default: not declared - essvi.options.initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.options.initialParameters.phi.lambda: number; default: not declared - essvi.options.initialParameters.rho: number | number[]; default: not declared - essvi.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 2,000, maximum 10,000). - essvi.options.phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - essvi.options.tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - essvi.options.weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit. Threaded through the SSVI warm-start too. - essvi.surface: ESSVICalibrationInput; default: not declared - essvi.surface.slices: SSVISliceInput[]; default: not declared - event-move: { observations: readonly EventMoveObservation[]; }; default: not declared - event-move.observations: readonly EventMoveObservation[]; default: not declared - event-volatility: FitEventVolatilityOptions; default: not declared - event-volatility.asOf: string | number; default: not declared - event-volatility.baseVolatility?: number; default: not declared — Pin the continuous vol when the term structure can't identify it (single expiry / no maturity spread). - event-volatility.eventDate: string; default: not declared — ISO date of the earnings/event. - event-volatility.termStructure: readonly AtmVolatilityPoint[]; default: not declared — The ATM-vol term structure (≥ 1 expiry; ≥ 2 to fit both `σ_base` and `J`, unless `baseVolatility` given). - garch: { returns: number[]; options?: GarchFitOptions; }; default: not declared - garch.options?: GarchFitOptions; default: not declared - garch.options.initialParameters?: { alpha: number; beta: number; }; default: not declared — Warm start for the `(α, β)` search (Stage 4.5): replaces the primary `(0.05, 0.90)` start; `ω` is derived by variance targeting and is not a start. The seeded restarts still run. - garch.options.initialParameters.alpha: number; default: not declared - garch.options.initialParameters.beta: number; default: not declared - garch.options.mean?: 'zero' | 'sample'; default: not declared — `'zero'` (default) fits second moments about zero; `'sample'` de-means first. A nonzero constant has a positive second moment in zero mode but is degenerate in sample mode. - garch.options.seed?: number; default: not declared — Seed for the deterministic multi-start of the optimizer (default `0x61726368`). - garch.returns: number[]; default: not declared - har-rv: { realizedVariances: number[]; options?: HarRvOptions; }; default: not declared - har-rv.options?: HarRvOptions; default: not declared - har-rv.options.monthly?: number; default: not declared — Monthly averaging window in observations (default 22). - har-rv.options.weekly?: number; default: not declared — Weekly averaging window in observations (default 5). - har-rv.realizedVariances: number[]; default: not declared - heston-surface: HestonSurfaceCalibrationInput; default: not declared - heston-surface.market: import('@insiderfinance/totalfinance/volatility').HestonSurfaceMarket; default: not declared - heston-surface.market.dividendYield: number; default: not declared - heston-surface.market.riskFreeRate: number; default: not declared - heston-surface.market.spot: number; default: not declared - heston-surface.options?: { initialParameters?: Partial; maximumIterations?: number; rmseTolerance?: number; terms?: number; }; default: not declared - heston-surface.options.initialParameters?: Partial; default: not declared — Warm start — a partial pin of the five parameters (Stage 4.5; formerly `seed`, retired: `seed` names randomness everywhere else in the library). Unspecified members keep their data-derived starts (ATM variance for `v0`/`theta`, κ = 2, σ = 0.5, ρ = −0.5). - heston-surface.options.initialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - heston-surface.options.initialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston-surface.options.initialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston-surface.options.initialParameters.theta?: number; default: not declared — Long-run variance θ. - heston-surface.options.initialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - heston-surface.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 300, maximum 10,000). - heston-surface.options.rmseTolerance?: number; default: not declared — Max RMSE the `converged` flag tolerates (default 0.02 IV points). - heston-surface.options.terms?: number; default: not declared — Heston COS expansion terms per target price (default 128, maximum 8,192). - heston-surface.targets: readonly HestonSurfaceTarget[]; default: not declared - sabr-smile: { smile: SABRSmileInput; options?: SABRCalibrationOptions; }; default: not declared - sabr-smile.options?: SABRCalibrationOptions; default: not declared - sabr-smile.options.beta?: number; default: not declared — Backbone exponent β ∈ [0, 1] (default 0.5). - sabr-smile.options.initialParameters?: { alpha: number; nu: number; rho: number; }; default: not declared — Warm start for the `(α, ρ, ν)` search (Stage 4.5); `β` stays an option and is never fitted. Replaces the ATM-derived default start. - sabr-smile.options.initialParameters.alpha: number; default: not declared - sabr-smile.options.initialParameters.nu: number; default: not declared - sabr-smile.options.initialParameters.rho: number; default: not declared - sabr-smile.options.maximumIterations?: number; default: not declared — LM iteration budget (default 200, maximum 10,000). - sabr-smile.options.tolerance?: number; default: not declared — LM tolerance (default 1e-12). - sabr-smile.options.volatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — Hagan expansion to fit against (default `'lognormal'`). - sabr-smile.smile: SABRSmileInput; default: not declared - sabr-smile.smile.forward: number; default: not declared - sabr-smile.smile.impliedVolatilities: number[]; default: not declared — Implied volatilities aligned to `strikes` (annualized decimals). - sabr-smile.smile.strikes: number[]; default: not declared - sabr-smile.smile.timeToExpiryYears: number; default: not declared — Time to expiry in years. - ssvi: { surface: SSVICalibrationInput; options?: SSVICalibrationOptions; }; default: not declared - ssvi.options?: SSVICalibrationOptions; default: not declared - ssvi.options.initialParameters?: { phi: SSVIPhi; rho: number; }; default: not declared — Warm start for the `(ρ, φ)` search (Stage 4.5): `phi.kind` must equal the calibration's `phi` family. The θ knots are fixed from the data and are not a start. - ssvi.options.initialParameters.phi: SSVIPhi; default: not declared - ssvi.options.initialParameters.phi.eta: number; default: not declared - ssvi.options.initialParameters.phi.gamma: number; default: not declared - ssvi.options.initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.options.initialParameters.phi.lambda: number; default: not declared - ssvi.options.initialParameters.rho: number; default: not declared - ssvi.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 1,000, maximum 10,000). - ssvi.options.phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - ssvi.options.tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - ssvi.options.weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit and thin, low-vega wings are downweighted. - ssvi.surface: SSVICalibrationInput; default: not declared - ssvi.surface.slices: SSVISliceInput[]; default: not declared - svi: { smile: SVISmileInput; options?: SVICalibrationOptions; }; default: not declared - svi.options?: SVICalibrationOptions; default: not declared - svi.options.initialParameters?: SVIWarmStart; default: not declared — Warm start for the outer `(m, σ)` search (Stage 4.5). Tried FIRST, ahead of the four built-in starts — ties keep the first, so a warm start never loses to a cold fit. `a`, `b`, and `ρ` are solved by the inner normal equations at every `(m, σ)` and are therefore not accepted as starts (a member the search cannot honor is refused, never ignored). - svi.options.initialParameters.m: number; default: not declared - svi.options.initialParameters.sigma: number; default: not declared — `> 0`. - svi.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 400, maximum 10,000). - svi.options.timeToExpiryYears?: number; default: not declared — The slice's maturity in years. Supplied ⇒ the fit-vs-data deviation check (see {@link calibrateSvi}) is expressed in true implied-VOL points, `σ = √(w/t)`. Omitted ⇒ `t = 1`, i.e. the check runs on `√w = σ√t` — still a vol scale, but shrunk by `√t` on a short slice. - svi.options.tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - svi.smile: SVISmileInput; default: not declared - svi.smile.k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - svi.smile.w: number[]; default: not declared — Total implied variance `σ²·t` aligned to `k`. - vanna-volga: VannaVolgaInput; default: not declared - vanna-volga-5: VannaVolga5Input; default: not declared - vanna-volga-5.atmVolatility: number; default: not declared - vanna-volga-5.butterfly10: number; default: not declared - vanna-volga-5.butterfly25: number; default: not declared - vanna-volga-5.forward: number; default: not declared - vanna-volga-5.innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - vanna-volga-5.outerDelta?: number; default: not declared - vanna-volga-5.riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - vanna-volga-5.riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - vanna-volga-5.strikes: number[]; default: not declared — Strikes to evaluate the smile at. - vanna-volga-5.timeToExpiryYears: number; default: not declared - vanna-volga-5.wingExtrapolation?: 'flat' | 'linear'; default: not declared — Wing extrapolation beyond the 10Δ pillars, in total variance: `flat` (default) or `linear`. - vanna-volga.atmVolatility: number; default: not declared — ATM vol. - vanna-volga.butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - vanna-volga.delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - vanna-volga.forward: number; default: not declared — Forward price of the underlying. - vanna-volga.riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - vanna-volga.strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - vanna-volga.timeToExpiryYears: number; default: not declared — Time to expiry in years. - volatility-surface: VolatilitySurfaceInput; default: not declared - volatility-surface.config?: import('@insiderfinance/totalfinance/volatility').SurfaceConfig; default: not declared - volatility-surface.config.cosineExpansionTerms?: number; default: not declared — COS cosine-term count for the `model: 'heston'` calibration & evaluation (default 128). - volatility-surface.config.essviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'essvi'` calibration (default `'power-law'`). - volatility-surface.config.essviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'essvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - volatility-surface.config.hestonInitialParameters?: Partial; default: not declared — Warm start (partial pin) for the global `model: 'heston'` calibration — threads into `calibrateHestonSurface`'s `initialParameters`. - volatility-surface.config.hestonInitialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - volatility-surface.config.hestonInitialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - volatility-surface.config.hestonInitialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - volatility-surface.config.hestonInitialParameters.theta?: number; default: not declared — Long-run variance θ. - volatility-surface.config.hestonInitialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - volatility-surface.config.minQuotesPerExpiry?: number; default: not declared — Below this many usable strikes, an expiry slice is flagged sparse (default 3). - volatility-surface.config.model?: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared — `interpolated` (PCHIP, default), `raw` (linear), `smoothed` (Gaussian kernel), `svi`/`sabr` (parametric per expiry), `ssvi` (one global arbitrage-free surface SVI), `essvi` (SSVI with a per-maturity skew), or `heston` (one global stochastic-vol model fit to the whole surface). - volatility-surface.config.priceSource?: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — Which quote price to invert when a quote has no `impliedVolatility` (default `mid`). - volatility-surface.config.sabrBeta?: number; default: not declared — SABR backbone exponent β ∈ [0, 1] for `model: 'sabr'` (default 0.5). - volatility-surface.config.sabrVolatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — SABR Hagan expansion for `model: 'sabr'` (default `'lognormal'`). - volatility-surface.config.smoothingBandwidth?: number; default: not declared — Gaussian-kernel bandwidth (in log-moneyness) for `model: 'smoothed'` (default auto). - volatility-surface.config.ssviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'ssvi'` calibration (default `'power-law'`). - volatility-surface.config.ssviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'ssvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - volatility-surface.market: import('@insiderfinance/totalfinance/volatility').SurfaceMarket; default: not declared - volatility-surface.market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - volatility-surface.market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - volatility-surface.market.riskFreeRate: number; default: not declared - volatility-surface.market.spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. - volatility-surface.quotes: OptionQuote[]; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityEvaluations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What `evaluateFittedModel` takes per family — the family's direct evaluator's coordinates. ```typescript /** What `evaluateFittedModel` takes per family — the family's direct evaluator's coordinates. */ export interface VolatilityEvaluations { svi: { logMoneyness: number[]; timeToExpiryYears?: number; }; ssvi: { logMoneyness: number[]; timeToExpiryYears: number[]; }; essvi: { logMoneyness: number[]; timeToExpiryYears: number[]; }; 'sabr-smile': { strikes: number[]; }; 'heston-surface': { type: 'call' | 'put'; strikes: number[]; timeToExpiryYears: number[]; }; 'vanna-volga': { strikes: number[]; }; 'vanna-volga-5': { strikes: number[]; }; 'event-volatility': { expiries: string[]; }; 'event-move': never; garch: { lastVariance: number; horizonPeriods: number; }; 'har-rv': { history: number[]; }; 'volatility-surface': { strikes: number[]; expiry: string | number; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - essvi: { logMoneyness: number[]; timeToExpiryYears: number[]; }; default: not declared - essvi.logMoneyness: number[]; default: not declared - essvi.timeToExpiryYears: number[]; default: not declared - event-move: never; default: not declared - event-volatility: { expiries: string[]; }; default: not declared - event-volatility.expiries: string[]; default: not declared - garch: { lastVariance: number; horizonPeriods: number; }; default: not declared - garch.horizonPeriods: number; default: not declared - garch.lastVariance: number; default: not declared - har-rv: { history: number[]; }; default: not declared - har-rv.history: number[]; default: not declared - heston-surface: { type: 'call' | 'put'; strikes: number[]; timeToExpiryYears: number[]; }; default: not declared - heston-surface.strikes: number[]; default: not declared - heston-surface.timeToExpiryYears: number[]; default: not declared - heston-surface.type: 'call' | 'put'; default: not declared - sabr-smile: { strikes: number[]; }; default: not declared - sabr-smile.strikes: number[]; default: not declared - ssvi: { logMoneyness: number[]; timeToExpiryYears: number[]; }; default: not declared - ssvi.logMoneyness: number[]; default: not declared - ssvi.timeToExpiryYears: number[]; default: not declared - svi: { logMoneyness: number[]; timeToExpiryYears?: number; }; default: not declared - svi.logMoneyness: number[]; default: not declared - svi.timeToExpiryYears?: number; default: not declared - vanna-volga: { strikes: number[]; }; default: not declared - vanna-volga-5: { strikes: number[]; }; default: not declared - vanna-volga-5.strikes: number[]; default: not declared - vanna-volga.strikes: number[]; default: not declared - volatility-surface: { strikes: number[]; expiry: string | number; }; default: not declared - volatility-surface.expiry: string | number; default: not declared - volatility-surface.strikes: number[]; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityFits Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The direct calibrator's result per family, verbatim (the surface as its own `toJSON()` snapshot). ```typescript /** The direct calibrator's result per family, verbatim (the surface as its own `toJSON()` snapshot). */ export interface VolatilityFits { svi: SVICalibrationResult; ssvi: SSVICalibration; essvi: ESSVICalibration; 'sabr-smile': SABRCalibrationResult; 'heston-surface': HestonSurfaceFit; 'vanna-volga': VannaVolgaSmile; 'vanna-volga-5': VannaVolga5Smile; 'event-volatility': EventVolatilityCalibration; 'event-move': EventMoveCalibration; garch: GarchFit; 'har-rv': HarRvFit; 'volatility-surface': VolatilitySurfaceSnapshot; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - essvi: ESSVICalibration; default: not declared - essvi.arbitrage: import('@insiderfinance/totalfinance/volatility').ESSVIArbitrage; default: not declared - essvi.arbitrage.butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every grid maturity. - essvi.arbitrage.calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage — `w(k, t)` non-decreasing in `t` at every grid `k` (the definition). - essvi.arbitrage.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and maturities (`≥ 0` ⇔ butterfly-free). - essvi.arbitrage.minCalendarSlope: number; default: not declared — Minimum `Δw` between adjacent maturities over the grid (`≥ 0` ⇔ calendar-free). - essvi.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'ssvi-warm-start'; phi: 'power-law' | 'heston'; skew: 'per-maturity'; weight: 'uniform' | 'vega'; }; default: not declared - essvi.assumptions.conventionsVersion: string; default: not declared - essvi.assumptions.initialParameters: 'supplied' | 'ssvi-warm-start'; default: not declared — Whether the search began from a caller-supplied start or the internal global-SSVI warm start. - essvi.assumptions.phi: 'power-law' | 'heston'; default: not declared - essvi.assumptions.skew: 'per-maturity'; default: not declared - essvi.assumptions.weight: 'vega' | 'uniform'; default: not declared - essvi.converged: boolean; default: not declared - essvi.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - essvi.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - essvi.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - essvi.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - essvi.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - essvi.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - essvi.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - essvi.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - essvi.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - essvi.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - essvi.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - essvi.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - essvi.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - essvi.diagnostics.selection.selected.name: string; default: not declared - essvi.diagnostics.selection.selected.version?: string; default: not declared - essvi.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - essvi.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - essvi.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - essvi.parameters: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared - essvi.parameters.phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - essvi.parameters.phi.eta: number; default: not declared - essvi.parameters.phi.gamma: number; default: not declared - essvi.parameters.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.parameters.phi.lambda: number; default: not declared - essvi.parameters.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - essvi.perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - essvi.rhoTerm: { timeToExpiryYears: number; rho: number; }[]; default: not declared — The fitted skew term structure — the payoff of eSSVI over global-ρ SSVI. - essvi.rmse: number; default: not declared — Root-mean-square total-variance error across all points. - event-move: EventMoveCalibration; default: not declared - event-move.assumptions: { conventionsVersion: string; method: string; }; default: not declared - event-move.assumptions.conventionsVersion: string; default: not declared - event-move.assumptions.method: string; default: not declared - event-move.averageImplied: number; default: not declared - event-move.averageRealized: number; default: not declared - event-move.bias: number; default: not declared — Mean `realized − implied` — positive ⇒ straddles underpriced on average. - event-move.count: number; default: not declared - event-move.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - event-move.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - event-move.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - event-move.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - event-move.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - event-move.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - event-move.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - event-move.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - event-move.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - event-move.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - event-move.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - event-move.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - event-move.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - event-move.diagnostics.selection.selected.name: string; default: not declared - event-move.diagnostics.selection.selected.version?: string; default: not declared - event-move.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - event-move.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - event-move.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - event-move.meanAbsoluteError: number; default: not declared — Mean `|realized − implied|`. - event-move.overpricedFraction: number; default: not declared — Fraction of events where implied > realized (how often selling the straddle won). - event-move.perEvent: import('@insiderfinance/totalfinance/volatility').CalibratedEvent[]; default: not declared - event-move.ratio: number; default: not declared — `averageRealized / averageImplied` — > 1 ⇒ the stock moves MORE than the straddle prices. - event-volatility: EventVolatilityCalibration; default: not declared - event-volatility.assumptions: { asOf: EpochMs; conventionsVersion: string; eventDate: string; method: string; }; default: not declared - event-volatility.assumptions.asOf: number; default: not declared — The valuation instant the maturities were measured from (epoch ms) — what {@link eventVolatilityAtExpiry} evaluates against. - event-volatility.assumptions.conventionsVersion: string; default: not declared - event-volatility.assumptions.eventDate: string; default: not declared - event-volatility.assumptions.method: string; default: not declared - event-volatility.baseVariance: number; default: not declared — `σ_base²` — the fitted continuous variance itself (exact; `baseVolatility` is its root). - event-volatility.baseVolatility: number; default: not declared — Annualized continuous (non-event) vol `√σ_base²`. - event-volatility.daysToEvent: number; default: not declared - event-volatility.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - event-volatility.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - event-volatility.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - event-volatility.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - event-volatility.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - event-volatility.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - event-volatility.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - event-volatility.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - event-volatility.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - event-volatility.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - event-volatility.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - event-volatility.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - event-volatility.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - event-volatility.diagnostics.selection.selected.name: string; default: not declared - event-volatility.diagnostics.selection.selected.version?: string; default: not declared - event-volatility.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - event-volatility.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - event-volatility.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - event-volatility.eventMove: number; default: not declared — Implied event move as a fraction of spot (`J`) — the "earnings move" (`spot·J` in price units). - event-volatility.eventVariance: number; default: not declared — `J²` — the discrete event variance. - event-volatility.perExpiry: import('@insiderfinance/totalfinance/volatility').FittedExpiry[]; default: not declared - event-volatility.rSquared: number; default: not declared — Fit quality on total variance (1 = perfect). - garch: GarchFit; default: not declared - garch.alpha: number; default: not declared — ARCH coefficient on the lagged squared return (`≥ 0`). - garch.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; mean: 'zero' | 'sample'; observations: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - garch.assumptions.conventionsVersion: string; default: not declared - garch.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the primary start was caller-supplied (`initialParameters`) or the classic (0.05, 0.90). - garch.assumptions.mean: 'zero' | 'sample'; default: not declared - garch.assumptions.observations: number; default: not declared - garch.beta: number; default: not declared — GARCH coefficient on the lagged conditional variance (`≥ 0`). - garch.converged: boolean; default: not declared — Whether the optimizer converged (never fabricated). - garch.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a degenerate / non-converged fit explains itself here. - garch.diagnostics.warnings: QuantWarning[]; default: not declared - garch.iterations: number; default: not declared — Optimizer iterations performed. - garch.logLikelihood: number | null; default: not declared — Maximized Gaussian log-likelihood; `null` when the likelihood is degenerate (disclosed). - garch.longRunVariance: number; default: not declared — Unconditional variance `ω / (1 − α − β)` the forecast mean-reverts to. - garch.omega: number; default: not declared — Constant term of the variance recursion (`> 0`). - garch.persistence: number; default: not declared — `α + β` — the variance half-life driver; `< 1` for a stationary fit. - har-rv: HarRvFit; default: not declared - har-rv.assumptions: { conventionsVersion: string; method: 'ols-qr'; monthly: number; weekly: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - har-rv.assumptions.conventionsVersion: string; default: not declared - har-rv.assumptions.method: 'ols-qr'; default: not declared - har-rv.assumptions.monthly: number; default: not declared - har-rv.assumptions.weekly: number; default: not declared - har-rv.coefficients: import('@insiderfinance/totalfinance/volatility').HarRvCoefficients; default: not declared - har-rv.coefficients.const: number; default: not declared — Intercept. - har-rv.coefficients.daily: number; default: not declared — Loading on the previous day's realized variance. - har-rv.coefficients.monthly: number; default: not declared — Loading on the trailing monthly-average realized variance. - har-rv.coefficients.weekly: number; default: not declared — Loading on the trailing weekly-average realized variance. - har-rv.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; a flat response (undefined R²) explains itself here. - har-rv.diagnostics.warnings: QuantWarning[]; default: not declared - har-rv.observationCount: number; default: not declared — Number of fitted observations. - har-rv.rSquared: number | null; default: not declared — In-sample coefficient of determination (`null` for a flat response — disclosed, never NaN). - har-rv.residuals: number[]; default: not declared — In-sample residuals `RVₜ − ŘVₜ`, one per fitted observation. - har-rv.windows: { monthly: number; weekly: number; }; default: not declared — The daily/weekly/monthly averaging windows used (also drives {@link harRvForecast}). - har-rv.windows.monthly: number; default: not declared - har-rv.windows.weekly: number; default: not declared - heston-surface: HestonSurfaceFit; default: not declared - heston-surface.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; maximumIterations: number; targets: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - heston-surface.assumptions.conventionsVersion: string; default: not declared - heston-surface.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether any starting member was caller-supplied (`initialParameters`) or all were data-derived. - heston-surface.assumptions.maximumIterations: number; default: not declared - heston-surface.assumptions.targets: number; default: not declared - heston-surface.converged: boolean; default: not declared - heston-surface.diagnostics: { warnings: QuantWarning[]; }; default: not declared — Structured warnings; always present — a non-converged fit explains itself here. - heston-surface.diagnostics.warnings: QuantWarning[]; default: not declared - heston-surface.parameters: HestonParameters; default: not declared - heston-surface.parameters.kappa: number; default: not declared — Mean-reversion speed κ. - heston-surface.parameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston-surface.parameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston-surface.parameters.theta: number; default: not declared — Long-run variance θ. - heston-surface.parameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - heston-surface.rmse: number; default: not declared — Root-mean-square IV error across all calibration targets. - heston-surface.rmseTolerance: number; default: not declared — The RMSE tolerance the `converged` flag was gated on (echoed for interpretability). - sabr-smile: SABRCalibrationResult; default: not declared - sabr-smile.assumptions: { beta: number; conventionsVersion: string; initialParameters: 'supplied' | 'default'; volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - sabr-smile.assumptions.beta: number; default: not declared - sabr-smile.assumptions.conventionsVersion: string; default: not declared - sabr-smile.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the ATM-derived default. - sabr-smile.assumptions.volatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - sabr-smile.converged: boolean; default: not declared - sabr-smile.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings; a non-converged fit explains itself here. - sabr-smile.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - sabr-smile.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - sabr-smile.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - sabr-smile.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - sabr-smile.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - sabr-smile.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - sabr-smile.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - sabr-smile.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - sabr-smile.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - sabr-smile.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - sabr-smile.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - sabr-smile.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - sabr-smile.diagnostics.selection.selected.name: string; default: not declared - sabr-smile.diagnostics.selection.selected.version?: string; default: not declared - sabr-smile.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - sabr-smile.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - sabr-smile.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - sabr-smile.iterations: number; default: not declared - sabr-smile.parameters: SabrParameters; default: not declared - sabr-smile.parameters.alpha: number; default: not declared — Initial volatility level α (> 0). - sabr-smile.parameters.beta: number; default: not declared — Backbone exponent β ∈ [0, 1]. - sabr-smile.parameters.nu: number; default: not declared — Volatility of volatility ν (≥ 0). - sabr-smile.parameters.rho: number; default: not declared — Correlation ρ ∈ (−1, 1). - sabr-smile.rmse: number; default: not declared — Root-mean-square implied-volatility error of the fit. - ssvi: SSVICalibration; default: not declared - ssvi.arbitrage: import('@insiderfinance/totalfinance/volatility').SSVIArbitrage; default: not declared - ssvi.arbitrage.butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every θ-knot. - ssvi.arbitrage.calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage (θ non-decreasing + the ∂_θ(θφ) bound). - ssvi.arbitrage.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and knots (`≥ 0` ⇔ butterfly-free). - ssvi.arbitrage.sufficientConditionsHold: boolean; default: not declared — Whether the Gatheral–Jacquier SUFFICIENT conditions hold (guarantee arb-freedom for all `k`). - ssvi.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; phi: 'power-law' | 'heston'; weight: 'uniform' | 'vega'; }; default: not declared - ssvi.assumptions.conventionsVersion: string; default: not declared - ssvi.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the search began from a caller-supplied `initialParameters` or the built-in start. - ssvi.assumptions.phi: 'power-law' | 'heston'; default: not declared - ssvi.assumptions.weight: 'vega' | 'uniform'; default: not declared - ssvi.converged: boolean; default: not declared - ssvi.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - ssvi.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - ssvi.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - ssvi.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - ssvi.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - ssvi.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - ssvi.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - ssvi.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - ssvi.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - ssvi.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - ssvi.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - ssvi.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - ssvi.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - ssvi.diagnostics.selection.selected.name: string; default: not declared - ssvi.diagnostics.selection.selected.version?: string; default: not declared - ssvi.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - ssvi.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - ssvi.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - ssvi.parameters: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared - ssvi.parameters.phi: SSVIPhi; default: not declared — Curvature function. - ssvi.parameters.phi.eta: number; default: not declared - ssvi.parameters.phi.gamma: number; default: not declared - ssvi.parameters.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.parameters.phi.lambda: number; default: not declared - ssvi.parameters.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - ssvi.parameters.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - ssvi.perSliceRmse: { timeToExpiryYears: number; rmse: number; }[]; default: not declared - ssvi.rmse: number; default: not declared — Root-mean-square total-variance error across all points. - svi: SVICalibrationResult; default: not declared - svi.assumptions: { conventionsVersion: string; initialParameters: 'supplied' | 'default'; method: 'zeliade-quasi-explicit'; points: number; }; default: not declared — Applied conventions, echoed (Law 2 report grammar). - svi.assumptions.conventionsVersion: string; default: not declared - svi.assumptions.initialParameters: 'supplied' | 'default'; default: not declared — Whether the outer search began from a caller-supplied `initialParameters` or the built-in starts. - svi.assumptions.method: 'zeliade-quasi-explicit'; default: not declared - svi.assumptions.points: number; default: not declared - svi.butterflyFree: boolean; default: not declared — Whether the fitted slice is butterfly-arbitrage-free (`g(k) ≥ 0` across the check grid). - svi.converged: boolean; default: not declared — `false` when the outer search stopped early OR the fitted slice sits materially away from the input smile (the arbitrage projection — see {@link calibrateSvi}); the reason is always a `diagnostics.warnings` entry. Gate on it before trusting `parameters`. - svi.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared — Structured warnings; a non-converged or arbitrageable fit explains itself here. - svi.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - svi.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - svi.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - svi.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - svi.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - svi.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - svi.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - svi.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - svi.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - svi.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - svi.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - svi.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - svi.diagnostics.selection.selected.name: string; default: not declared - svi.diagnostics.selection.selected.version?: string; default: not declared - svi.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - svi.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - svi.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - svi.iterations: number; default: not declared - svi.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the check grid (`≥ 0` ⇔ arbitrage-free). - svi.parameters: import('@insiderfinance/totalfinance/volatility').SVIParameters; default: not declared - svi.parameters.a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - svi.parameters.b: number; default: not declared — Wing slope / curvature, `≥ 0`. - svi.parameters.m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - svi.parameters.rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - svi.parameters.sigma: number; default: not declared — Smoothness, `> 0`. - svi.rmse: number; default: not declared — Root-mean-square total-variance error of the fit. - vanna-volga: VannaVolgaSmile; default: not declared - vanna-volga-5: VannaVolga5Smile; default: not declared - vanna-volga-5.assumptions: { conventionsVersion: string; deltaConvention: 'forward'; interpolation: 'pchip-total-variance'; method: 'vanna-volga-5'; wingExtrapolation: 'flat' | 'linear'; }; default: not declared - vanna-volga-5.assumptions.conventionsVersion: string; default: not declared - vanna-volga-5.assumptions.deltaConvention: 'forward'; default: not declared - vanna-volga-5.assumptions.interpolation: 'pchip-total-variance'; default: not declared - vanna-volga-5.assumptions.method: 'vanna-volga-5'; default: not declared - vanna-volga-5.assumptions.wingExtrapolation: 'flat' | 'linear'; default: not declared - vanna-volga-5.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - vanna-volga-5.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vanna-volga-5.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vanna-volga-5.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vanna-volga-5.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vanna-volga-5.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vanna-volga-5.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vanna-volga-5.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vanna-volga-5.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vanna-volga-5.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - vanna-volga-5.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - vanna-volga-5.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - vanna-volga-5.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - vanna-volga-5.diagnostics.selection.selected.name: string; default: not declared - vanna-volga-5.diagnostics.selection.selected.version?: string; default: not declared - vanna-volga-5.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vanna-volga-5.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vanna-volga-5.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vanna-volga-5.innerDelta: number; default: not declared - vanna-volga-5.outerDelta: number; default: not declared - vanna-volga-5.pillars: import('@insiderfinance/totalfinance/volatility').VannaVolga5Pillar[]; default: not declared — The five market pillars the smile reprices exactly, low → high strike. - vanna-volga-5.strikes: number[]; default: not declared - vanna-volga-5.volatilities: number[]; default: not declared - vanna-volga.assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; method: 'vanna-volga'; }; default: not declared - vanna-volga.assumptions.conventionsVersion: string; default: not declared - vanna-volga.assumptions.delta: number; default: not declared - vanna-volga.assumptions.deltaConvention: 'forward'; default: not declared - vanna-volga.assumptions.method: 'vanna-volga'; default: not declared - vanna-volga.delta: number; default: not declared - vanna-volga.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - vanna-volga.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - vanna-volga.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - vanna-volga.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - vanna-volga.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - vanna-volga.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - vanna-volga.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - vanna-volga.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - vanna-volga.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - vanna-volga.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - vanna-volga.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - vanna-volga.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - vanna-volga.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - vanna-volga.diagnostics.selection.selected.name: string; default: not declared - vanna-volga.diagnostics.selection.selected.version?: string; default: not declared - vanna-volga.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - vanna-volga.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - vanna-volga.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - vanna-volga.pillars: { atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; putStrike: number; putVolatility: number; }; default: not declared — The three market pillars the smile reprices exactly. - vanna-volga.pillars.atmStrike: number; default: not declared - vanna-volga.pillars.atmVolatility: number; default: not declared - vanna-volga.pillars.callStrike: number; default: not declared - vanna-volga.pillars.callVolatility: number; default: not declared - vanna-volga.pillars.putStrike: number; default: not declared - vanna-volga.pillars.putVolatility: number; default: not declared - vanna-volga.strikes: number[]; default: not declared — Requested strikes. - vanna-volga.volatilities: number[]; default: not declared — The constructed vol at each strike (aligned to `strikes`). - volatility-surface: VolatilitySurfaceSnapshot; default: not declared - volatility-surface.assumptions: import('@insiderfinance/totalfinance/core').Assumptions<{ shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; }>; default: not declared - volatility-surface.assumptions.asOf?: number; default: not declared - volatility-surface.assumptions.calendar?: string; default: not declared - volatility-surface.assumptions.calendarVersion?: string; default: not declared - volatility-surface.assumptions.compounding?: import('@insiderfinance/totalfinance/core').InterestCompounding; default: not declared - volatility-surface.assumptions.compounding.periodsPerYear: number; default: not declared - volatility-surface.assumptions.compounding.type: 'periodic'; default: not declared - volatility-surface.assumptions.conventionsVersion: string; default: not declared - volatility-surface.assumptions.dayCount?: import('@insiderfinance/totalfinance/core').DayCount; default: not declared - volatility-surface.assumptions.dividendModel?: import('@insiderfinance/totalfinance/core').DividendModel; default: not declared - volatility-surface.assumptions.engine?: string; default: not declared - volatility-surface.assumptions.expiryConvention?: 'us-equity-close' | 'explicit-instant'; default: not declared — How the contract's expiry label was resolved to an instant: `'us-equity-close'` when a date-only `YYYY-MM-DD` expiry resolved to the US equity/options close — 16:00 America/New_York, or 13:00 on an early-close day; `'explicit-instant'` when the caller supplied a zoned datetime. Named so the convention is never silent (alignment spec P1.6); instrument builders own the full story in Phase 3. - volatility-surface.assumptions.model?: string; default: not declared - volatility-surface.assumptions.seed?: number; default: not declared — The randomness seed this result was computed under — REQUIRED echo for a `randomness: 'seeded'` Pricer (Gate C, 2026-08-23): a stochastic result that does not name its seed cannot be replayed from the result alone. Deterministic paths never set it. - volatility-surface.assumptions.shock?: import('@insiderfinance/totalfinance/volatility').SurfaceShock; default: not declared - volatility-surface.assumptions.shock.parallel: number; default: not declared — Additive parallel shift applied to every stored IV (in vol points, e.g. `0.02` = +2 vol). - volatility-surface.assumptions.shock.skewTilt: number; default: not declared — Skew rotation: adds `skewTilt · k` where `k = ln(K/forward)` (log-moneyness). - volatility-surface.assumptions.shock.sticky: 'strike' | 'moneyness'; default: not declared — Which quantity the tilt is pinned to: `'strike'` (default) or `'moneyness'`. - volatility-surface.assumptions.timeToExpiryConvention?: never; default: not declared - volatility-surface.assumptions.timeToExpiryYears?: number; default: not declared - volatility-surface.assumptions.units?: import('@insiderfinance/totalfinance/core').GreekUnits; default: not declared - volatility-surface.assumptions.units.rho: import('@insiderfinance/totalfinance/core').RhoUnit; default: not declared - volatility-surface.assumptions.units.theta: import('@insiderfinance/totalfinance/core').ThetaUnit; default: not declared - volatility-surface.assumptions.units.vega: import('@insiderfinance/totalfinance/core').VegaUnit; default: not declared - volatility-surface.config: { cosineExpansionTerms: number; dividendYield: number; riskFreeRate: number; sabrBeta: number; sabrVolatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; smoothingBandwidth?: number; }; default: not declared — Config knobs needed to rebuild the per-slice interpolators without re-solving from quotes. - volatility-surface.config.cosineExpansionTerms: number; default: not declared - volatility-surface.config.dividendYield: number; default: not declared - volatility-surface.config.riskFreeRate: number; default: not declared - volatility-surface.config.sabrBeta: number; default: not declared - volatility-surface.config.sabrVolatilityType: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared - volatility-surface.config.smoothingBandwidth?: number; default: not declared - volatility-surface.diagnostics: import('@insiderfinance/totalfinance/core').Diagnostics; default: not declared - volatility-surface.diagnostics.autoReason?: string; default: not declared — When a meta-engine (e.g. `engines.auto()`) selected a delegate, this is a one-sentence, human-readable explanation of WHY that delegate was chosen (`engine` then names the delegate). Absent when no auto-selection took place. - volatility-surface.diagnostics.converged?: boolean; default: not declared — Whether an iterative procedure converged. `false` means the value is not trustworthy. - volatility-surface.diagnostics.decomposition?: Record; default: not declared — Named intermediate quantities the value decomposes into — a par spread's protection leg and risky annuity, a forward variance's near/far legs. The H-series explain paths disclose their arithmetic here so a caller can audit the ratio, not just receive it (3B.3). - volatility-surface.diagnostics.engine?: string; default: not declared — Pricing/solver engine name, e.g. `black-scholes-merton`. - volatility-surface.diagnostics.finiteDifferenceBumps?: Record; default: not declared — Finite-difference engines: the ACTUAL bump sizes used for FD Greeks (spec P2.3) — adaptive near the vol/time boundaries, so the caller can see exactly what was differenced. Keys: `spotStep`, `volatilityStep`, `timeStepYears`, `rateStep`, and — extended Greeks only — `dividendYieldStep`. Each is the actual step differenced, in the unit of the coordinate it bumps. (This doc named the retired `hS`/`hSig`/`hT`/`hR`/`hQ` keys for one release after the emit sites had moved to the semantic names, so a caller following it read `undefined`.) - volatility-surface.diagnostics.iterations?: number; default: not declared — Iteration count for iterative methods. - volatility-surface.diagnostics.method?: string; default: not declared — Numerical method, e.g. `closed-form`, `brent`, `finite-difference`. - volatility-surface.diagnostics.selection?: import('@insiderfinance/totalfinance/core/pricing').SelectionReport; default: not declared — The structured engine-selection report (Gate C, `@insiderfinance/totalfinance/core/pricing`): who was selected, why, and — for automatic selection — every candidate considered with its verdict. This is the machine-readable superset of `engine` + `autoReason` (which remain for compatibility); `selected.name` always agrees with `engine` when both are present. - volatility-surface.diagnostics.selection.candidates?: readonly import('@insiderfinance/totalfinance/core/pricing').SelectionCandidate[]; default: not declared — Candidates an automatic selection considered; absent for explicit mode. - volatility-surface.diagnostics.selection.mode: 'explicit' | 'automatic'; default: not declared - volatility-surface.diagnostics.selection.reason: string; default: not declared — Why the selected engine answers this request. - volatility-surface.diagnostics.selection.selected: { name: string; version?: string; }; default: not declared - volatility-surface.diagnostics.selection.selected.name: string; default: not declared - volatility-surface.diagnostics.selection.selected.version?: string; default: not declared - volatility-surface.diagnostics.timingMs?: number; default: not declared — Wall-clock timing in milliseconds, when measured. - volatility-surface.diagnostics.warmup?: number; default: not declared — Series facades: number of leading output slots that are warmup sentinels (null/NaN) while the computation seeds. Equals the input length when the indicator never emitted. - volatility-surface.diagnostics.warnings: QuantWarning[]; default: not declared — Structured warnings; always present (possibly empty). - volatility-surface.essvi?: import('@insiderfinance/totalfinance/volatility').ESSVIParameters; default: not declared — The global eSSVI parameters when `model: 'essvi'`. - volatility-surface.essvi.phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - volatility-surface.essvi.phi.eta: number; default: not declared - volatility-surface.essvi.phi.gamma: number; default: not declared - volatility-surface.essvi.phi.kind: ('heston') | ('power-law'); default: not declared - volatility-surface.essvi.phi.lambda: number; default: not declared - volatility-surface.essvi.thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - volatility-surface.heston?: HestonParameters; default: not declared — The global Heston parameters when `model: 'heston'`. - volatility-surface.heston.kappa: number; default: not declared — Mean-reversion speed κ. - volatility-surface.heston.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - volatility-surface.heston.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - volatility-surface.heston.theta: number; default: not declared — Long-run variance θ. - volatility-surface.heston.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - volatility-surface.model: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared - volatility-surface.points: import('@insiderfinance/totalfinance/volatility').SurfacePoint[]; default: not declared - volatility-surface.referenceSpot: number; default: not declared - volatility-surface.schemaVersion: string; default: not declared - volatility-surface.slices: import('@insiderfinance/totalfinance/volatility').SurfaceSlice[]; default: not declared - volatility-surface.ssvi?: import('@insiderfinance/totalfinance/volatility').SSVIParameters; default: not declared — The global SSVI parameters when `model: 'ssvi'`. - volatility-surface.ssvi.phi: SSVIPhi; default: not declared — Curvature function. - volatility-surface.ssvi.phi.eta: number; default: not declared - volatility-surface.ssvi.phi.gamma: number; default: not declared - volatility-surface.ssvi.phi.kind: ('heston') | ('power-law'); default: not declared - volatility-surface.ssvi.phi.lambda: number; default: not declared - volatility-surface.ssvi.rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - volatility-surface.ssvi.thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityFittedModelReport Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The typed report every domain verb reads and writes — the artifact's `result`, verbatim. ```typescript /** The typed report every domain verb reads and writes — the artifact's `result`, verbatim. */ export type VolatilityFittedModelReport = Readonly> & { family: F; modelVersion: number; summary: FittedModelSummary; /** The direct calibrator's result, verbatim (the surface as its own `toJSON()` snapshot). */ fit: FitOf; /** The calibrator's input, verbatim, except that a referenced bulk row set is its `TableHandle`. */ calibration: StoredCalibrationOf; referencedData: Record; assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; evaluator: string | null; inputPolicy: 'embedded' | 'referenced'; projection: string; }; diagnostics: { warnings: QuantWarning[]; fitWarningCount: number; embeddedCalibrationBytes: number; referencedRowSets: string[]; }; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - assumptions: { conventionsVersion: string; family: F; modelVersion: number; calibrator: string; evaluator: string | null; inputPolicy: 'embedded' | 'referenced'; projection: string; }; default: not declared - assumptions.calibrator: string; default: not declared - assumptions.conventionsVersion: string; default: not declared - assumptions.evaluator: string | null; default: not declared - assumptions.family: F; default: not declared - assumptions.inputPolicy: 'embedded' | 'referenced'; default: not declared - assumptions.modelVersion: number; default: not declared - assumptions.projection: string; default: not declared - calibration: StoredCalibrationOf; default: not declared — The calibrator's input, verbatim, except that a referenced bulk row set is its `TableHandle`. - diagnostics: { embeddedCalibrationBytes: number; fitWarningCount: number; referencedRowSets: string[]; warnings: QuantWarning[]; }; default: not declared - diagnostics.embeddedCalibrationBytes: number; default: not declared - diagnostics.fitWarningCount: number; default: not declared - diagnostics.referencedRowSets: string[]; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - family: F; default: not declared - fit: FitOf; default: not declared — The direct calibrator's result, verbatim (the surface as its own `toJSON()` snapshot). - modelVersion: number; default: not declared - referencedData: Record; default: not declared - summary: FittedModelSummary; default: not declared - summary.convergence: { converged: boolean; iterations: number | null; reason?: string; }; default: not declared - summary.convergence.converged: boolean; default: not declared - summary.convergence.iterations: number | null; default: not declared - summary.convergence.reason?: string; default: not declared - summary.family: string; default: not declared — Dot-namespaced family, e.g. `'volatility.ssvi'` or `'fixed-income.discount-curve'`. - summary.inputIdentity: { calibrationHash: string; snapshotHash: string | null; }; default: not declared — Identity of what was fitted: the calibration input's content hash, and the market snapshot's when one was read. - summary.inputIdentity.calibrationHash: string; default: not declared - summary.inputIdentity.snapshotHash: string | null; default: not declared - summary.modelRisk: { arbitrageFree: boolean | null; calibratedRange: Record; notes: string[]; }; default: not declared - summary.modelRisk.arbitrageFree: boolean | null; default: not declared — Butterfly/calendar freedom for smiles and surfaces; null where the notion does not apply. - summary.modelRisk.calibratedRange: Record; default: not declared — The coordinate range the fit was calibrated over; evaluation outside it warns. - summary.modelRisk.notes: string[]; default: not declared - summary.modelVersion: number; default: not declared — The family's integer semantics/shape version; bumps when the calibrator's result shape or meaning changes. - summary.objective: { kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; reason?: string; unit: string; value: number | null; }; default: not declared - summary.objective.kind: import('@insiderfinance/totalfinance/core/artifacts').FittedModelObjectiveKind; default: not declared - summary.objective.reason?: string; default: not declared — Required exactly when `value` is null. - summary.objective.unit: string; default: not declared — The objective's unit or basis, e.g. `'total variance'`, `'implied volatility'`, `'log-likelihood'`. - summary.objective.value: number | null; default: not declared - summary.parameters: Record; default: not declared — Flat, named, JSON-safe parameters — the numbers a reader would want to diff (dot paths for nested members). - summary.residuals: { count: number; maximumAbsolute: number | null; rootMeanSquare: number | null; source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; unit: string; } | null; default: not declared — Null when the family has no per-point residual (with the reason in `modelRisk.notes`). - summary.residuals.count: number; default: not declared - summary.residuals.maximumAbsolute: number | null; default: not declared - summary.residuals.rootMeanSquare: number | null; default: not declared - summary.residuals.source: import('@insiderfinance/totalfinance/core/artifacts').FittedModelResidualSource; default: not declared - summary.residuals.unit: string; default: not declared - summary.warningCount: number; default: not declared - summary.weighting: string | null; default: not declared — The weighting the calibrator applied, when it applied one; null otherwise. ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityModelFamily Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript // ─────────────────────────────────────────── the grammar ─────────────────────────────────────────── export type VolatilityModelFamily = 'svi' | 'ssvi' | 'essvi' | 'sabr-smile' | 'heston-surface' | 'vanna-volga' | 'vanna-volga-5' | 'event-volatility' | 'event-move' | 'garch' | 'har-rv' | 'volatility-surface'; ``` ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityStoredCalibrations Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The STORED calibration: the declared bulk row set may be a `TableHandle` (Decision 9). ```typescript /** The STORED calibration: the declared bulk row set may be a `TableHandle` (Decision 9). */ export interface VolatilityStoredCalibrations { svi: VolatilityCalibrations['svi']; ssvi: { surface: { slices: SSVISliceInput[] | TableHandle; }; options?: SSVICalibrationOptions; }; essvi: { surface: { slices: SSVISliceInput[] | TableHandle; }; options?: ESSVICalibrationOptions; }; 'sabr-smile': VolatilityCalibrations['sabr-smile']; 'heston-surface': Omit & { targets: readonly HestonSurfaceTarget[] | TableHandle; }; 'vanna-volga': VannaVolgaInput; 'vanna-volga-5': VannaVolga5Input; 'event-volatility': Omit & { termStructure: readonly AtmVolatilityPoint[] | TableHandle; }; 'event-move': { observations: readonly EventMoveObservation[] | TableHandle; }; garch: { returns: number[] | TableHandle; options?: GarchFitOptions; }; 'har-rv': { realizedVariances: number[] | TableHandle; options?: HarRvOptions; }; 'volatility-surface': Omit & { quotes: OptionQuote[] | TableHandle; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - essvi: { surface: { slices: SSVISliceInput[] | TableHandle; }; options?: ESSVICalibrationOptions; }; default: not declared - essvi.options?: ESSVICalibrationOptions; default: not declared - essvi.options.initialParameters?: { phi: SSVIPhi; rho: number | number[]; }; default: not declared — Warm start (Stage 4.5): a scalar `rho` broadcasts to every maturity knot, an array must match the slice count; `phi.kind` must equal the calibration's `phi` family. A supplied start REPLACES the internal SSVI warm start (echoed in `assumptions.initialParameters`). - essvi.options.initialParameters.phi: SSVIPhi; default: not declared - essvi.options.initialParameters.phi.eta: number; default: not declared - essvi.options.initialParameters.phi.gamma: number; default: not declared - essvi.options.initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.options.initialParameters.phi.lambda: number; default: not declared - essvi.options.initialParameters.rho: number | number[]; default: not declared - essvi.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 2,000, maximum 10,000). - essvi.options.phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - essvi.options.tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - essvi.options.weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit. Threaded through the SSVI warm-start too. - essvi.surface: { slices: SSVISliceInput[] | TableHandle; }; default: not declared - essvi.surface.slices: SSVISliceInput[] | TableHandle; default: not declared - essvi.surface.slices.columnCount: number; default: not declared - essvi.surface.slices.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - essvi.surface.slices.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - essvi.surface.slices.kind: 'totalfinance.table-handle'; default: not declared - essvi.surface.slices.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - essvi.surface.slices.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - essvi.surface.slices.rowCount: number; default: not declared - event-move: { observations: readonly EventMoveObservation[] | TableHandle; }; default: not declared - event-move.observations: readonly EventMoveObservation[] | TableHandle; default: not declared - event-move.observations.columnCount: number; default: not declared - event-move.observations.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - event-move.observations.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - event-move.observations.kind: 'totalfinance.table-handle'; default: not declared - event-move.observations.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - event-move.observations.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - event-move.observations.rowCount: number; default: not declared - event-volatility: Omit & { termStructure: readonly AtmVolatilityPoint[] | TableHandle; }; default: not declared - event-volatility.asOf: string | number; default: not declared - event-volatility.baseVolatility?: number; default: not declared — Pin the continuous vol when the term structure can't identify it (single expiry / no maturity spread). - event-volatility.eventDate: string; default: not declared — ISO date of the earnings/event. - event-volatility.termStructure: readonly AtmVolatilityPoint[] | TableHandle; default: not declared - event-volatility.termStructure.columnCount: number; default: not declared - event-volatility.termStructure.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - event-volatility.termStructure.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - event-volatility.termStructure.kind: 'totalfinance.table-handle'; default: not declared - event-volatility.termStructure.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - event-volatility.termStructure.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - event-volatility.termStructure.rowCount: number; default: not declared - garch: { returns: number[] | TableHandle; options?: GarchFitOptions; }; default: not declared - garch.options?: GarchFitOptions; default: not declared - garch.options.initialParameters?: { alpha: number; beta: number; }; default: not declared — Warm start for the `(α, β)` search (Stage 4.5): replaces the primary `(0.05, 0.90)` start; `ω` is derived by variance targeting and is not a start. The seeded restarts still run. - garch.options.initialParameters.alpha: number; default: not declared - garch.options.initialParameters.beta: number; default: not declared - garch.options.mean?: 'zero' | 'sample'; default: not declared — `'zero'` (default) fits second moments about zero; `'sample'` de-means first. A nonzero constant has a positive second moment in zero mode but is degenerate in sample mode. - garch.options.seed?: number; default: not declared — Seed for the deterministic multi-start of the optimizer (default `0x61726368`). - garch.returns: number[] | TableHandle; default: not declared - garch.returns.columnCount: number; default: not declared - garch.returns.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - garch.returns.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - garch.returns.kind: 'totalfinance.table-handle'; default: not declared - garch.returns.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - garch.returns.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - garch.returns.rowCount: number; default: not declared - har-rv: { realizedVariances: number[] | TableHandle; options?: HarRvOptions; }; default: not declared - har-rv.options?: HarRvOptions; default: not declared - har-rv.options.monthly?: number; default: not declared — Monthly averaging window in observations (default 22). - har-rv.options.weekly?: number; default: not declared — Weekly averaging window in observations (default 5). - har-rv.realizedVariances: number[] | TableHandle; default: not declared - har-rv.realizedVariances.columnCount: number; default: not declared - har-rv.realizedVariances.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - har-rv.realizedVariances.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - har-rv.realizedVariances.kind: 'totalfinance.table-handle'; default: not declared - har-rv.realizedVariances.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - har-rv.realizedVariances.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - har-rv.realizedVariances.rowCount: number; default: not declared - heston-surface: Omit & { targets: readonly HestonSurfaceTarget[] | TableHandle; }; default: not declared - heston-surface.market: import('@insiderfinance/totalfinance/volatility').HestonSurfaceMarket; default: not declared - heston-surface.market.dividendYield: number; default: not declared - heston-surface.market.riskFreeRate: number; default: not declared - heston-surface.market.spot: number; default: not declared - heston-surface.options?: { initialParameters?: Partial; maximumIterations?: number; rmseTolerance?: number; terms?: number; }; default: not declared - heston-surface.options.initialParameters?: Partial; default: not declared — Warm start — a partial pin of the five parameters (Stage 4.5; formerly `seed`, retired: `seed` names randomness everywhere else in the library). Unspecified members keep their data-derived starts (ATM variance for `v0`/`theta`, κ = 2, σ = 0.5, ρ = −0.5). - heston-surface.options.initialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - heston-surface.options.initialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston-surface.options.initialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston-surface.options.initialParameters.theta?: number; default: not declared — Long-run variance θ. - heston-surface.options.initialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - heston-surface.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 300, maximum 10,000). - heston-surface.options.rmseTolerance?: number; default: not declared — Max RMSE the `converged` flag tolerates (default 0.02 IV points). - heston-surface.options.terms?: number; default: not declared — Heston COS expansion terms per target price (default 128, maximum 8,192). - heston-surface.targets: readonly HestonSurfaceTarget[] | TableHandle; default: not declared - heston-surface.targets.columnCount: number; default: not declared - heston-surface.targets.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - heston-surface.targets.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - heston-surface.targets.kind: 'totalfinance.table-handle'; default: not declared - heston-surface.targets.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - heston-surface.targets.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - heston-surface.targets.rowCount: number; default: not declared - sabr-smile: { options?: SABRCalibrationOptions; smile: SABRSmileInput; }; default: not declared - sabr-smile.options?: SABRCalibrationOptions; default: not declared - sabr-smile.options.beta?: number; default: not declared — Backbone exponent β ∈ [0, 1] (default 0.5). - sabr-smile.options.initialParameters?: { alpha: number; nu: number; rho: number; }; default: not declared — Warm start for the `(α, ρ, ν)` search (Stage 4.5); `β` stays an option and is never fitted. Replaces the ATM-derived default start. - sabr-smile.options.initialParameters.alpha: number; default: not declared - sabr-smile.options.initialParameters.nu: number; default: not declared - sabr-smile.options.initialParameters.rho: number; default: not declared - sabr-smile.options.maximumIterations?: number; default: not declared — LM iteration budget (default 200, maximum 10,000). - sabr-smile.options.tolerance?: number; default: not declared — LM tolerance (default 1e-12). - sabr-smile.options.volatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — Hagan expansion to fit against (default `'lognormal'`). - sabr-smile.smile: SABRSmileInput; default: not declared - sabr-smile.smile.forward: number; default: not declared - sabr-smile.smile.impliedVolatilities: number[]; default: not declared — Implied volatilities aligned to `strikes` (annualized decimals). - sabr-smile.smile.strikes: number[]; default: not declared - sabr-smile.smile.timeToExpiryYears: number; default: not declared — Time to expiry in years. - ssvi: { surface: { slices: SSVISliceInput[] | TableHandle; }; options?: SSVICalibrationOptions; }; default: not declared - ssvi.options?: SSVICalibrationOptions; default: not declared - ssvi.options.initialParameters?: { phi: SSVIPhi; rho: number; }; default: not declared — Warm start for the `(ρ, φ)` search (Stage 4.5): `phi.kind` must equal the calibration's `phi` family. The θ knots are fixed from the data and are not a start. - ssvi.options.initialParameters.phi: SSVIPhi; default: not declared - ssvi.options.initialParameters.phi.eta: number; default: not declared - ssvi.options.initialParameters.phi.gamma: number; default: not declared - ssvi.options.initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.options.initialParameters.phi.lambda: number; default: not declared - ssvi.options.initialParameters.rho: number; default: not declared - ssvi.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 1,000, maximum 10,000). - ssvi.options.phi?: 'power-law' | 'heston'; default: not declared — Curvature family; default `'power-law'`. - ssvi.options.tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - ssvi.options.weight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting of the total-variance residuals: `'uniform'` (default) or `'vega'` — weight each point by its Black vega `∝ φ(d₁)·√t`, so liquid ATM/near-the-money strikes dominate the fit and thin, low-vega wings are downweighted. - ssvi.surface: { slices: SSVISliceInput[] | TableHandle; }; default: not declared - ssvi.surface.slices: SSVISliceInput[] | TableHandle; default: not declared - ssvi.surface.slices.columnCount: number; default: not declared - ssvi.surface.slices.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - ssvi.surface.slices.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - ssvi.surface.slices.kind: 'totalfinance.table-handle'; default: not declared - ssvi.surface.slices.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - ssvi.surface.slices.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - ssvi.surface.slices.rowCount: number; default: not declared - svi: { options?: SVICalibrationOptions; smile: SVISmileInput; }; default: not declared - svi.options?: SVICalibrationOptions; default: not declared - svi.options.initialParameters?: SVIWarmStart; default: not declared — Warm start for the outer `(m, σ)` search (Stage 4.5). Tried FIRST, ahead of the four built-in starts — ties keep the first, so a warm start never loses to a cold fit. `a`, `b`, and `ρ` are solved by the inner normal equations at every `(m, σ)` and are therefore not accepted as starts (a member the search cannot honor is refused, never ignored). - svi.options.initialParameters.m: number; default: not declared - svi.options.initialParameters.sigma: number; default: not declared — `> 0`. - svi.options.maximumIterations?: number; default: not declared — Outer-search iteration budget (default 400, maximum 10,000). - svi.options.timeToExpiryYears?: number; default: not declared — The slice's maturity in years. Supplied ⇒ the fit-vs-data deviation check (see {@link calibrateSvi}) is expressed in true implied-VOL points, `σ = √(w/t)`. Omitted ⇒ `t = 1`, i.e. the check runs on `√w = σ√t` — still a vol scale, but shrunk by `√t` on a short slice. - svi.options.tolerance?: number; default: not declared — Outer-search tolerance (default 1e-12). - svi.smile: SVISmileInput; default: not declared - svi.smile.k: number[]; default: not declared — Log-moneyness `ln(K/F)` per observation. - svi.smile.w: number[]; default: not declared — Total implied variance `σ²·t` aligned to `k`. - vanna-volga: VannaVolgaInput; default: not declared - vanna-volga-5: VannaVolga5Input; default: not declared - vanna-volga-5.atmVolatility: number; default: not declared - vanna-volga-5.butterfly10: number; default: not declared - vanna-volga-5.butterfly25: number; default: not declared - vanna-volga-5.forward: number; default: not declared - vanna-volga-5.innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - vanna-volga-5.outerDelta?: number; default: not declared - vanna-volga-5.riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - vanna-volga-5.riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - vanna-volga-5.strikes: number[]; default: not declared — Strikes to evaluate the smile at. - vanna-volga-5.timeToExpiryYears: number; default: not declared - vanna-volga-5.wingExtrapolation?: 'flat' | 'linear'; default: not declared — Wing extrapolation beyond the 10Δ pillars, in total variance: `flat` (default) or `linear`. - vanna-volga.atmVolatility: number; default: not declared — ATM vol. - vanna-volga.butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - vanna-volga.delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - vanna-volga.forward: number; default: not declared — Forward price of the underlying. - vanna-volga.riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - vanna-volga.strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - vanna-volga.timeToExpiryYears: number; default: not declared — Time to expiry in years. - volatility-surface: Omit & { quotes: OptionQuote[] | TableHandle; }; default: not declared - volatility-surface.config?: import('@insiderfinance/totalfinance/volatility').SurfaceConfig; default: not declared - volatility-surface.config.cosineExpansionTerms?: number; default: not declared — COS cosine-term count for the `model: 'heston'` calibration & evaluation (default 128). - volatility-surface.config.essviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'essvi'` calibration (default `'power-law'`). - volatility-surface.config.essviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'essvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - volatility-surface.config.hestonInitialParameters?: Partial; default: not declared — Warm start (partial pin) for the global `model: 'heston'` calibration — threads into `calibrateHestonSurface`'s `initialParameters`. - volatility-surface.config.hestonInitialParameters.kappa?: number; default: not declared — Mean-reversion speed κ. - volatility-surface.config.hestonInitialParameters.rho?: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - volatility-surface.config.hestonInitialParameters.sigma?: number; default: not declared — Volatility of variance ξ ("vol of vol"). - volatility-surface.config.hestonInitialParameters.theta?: number; default: not declared — Long-run variance θ. - volatility-surface.config.hestonInitialParameters.v0?: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - volatility-surface.config.minQuotesPerExpiry?: number; default: not declared — Below this many usable strikes, an expiry slice is flagged sparse (default 3). - volatility-surface.config.model?: import('@insiderfinance/totalfinance/volatility').SurfaceModel; default: not declared — `interpolated` (PCHIP, default), `raw` (linear), `smoothed` (Gaussian kernel), `svi`/`sabr` (parametric per expiry), `ssvi` (one global arbitrage-free surface SVI), `essvi` (SSVI with a per-maturity skew), or `heston` (one global stochastic-vol model fit to the whole surface). - volatility-surface.config.priceSource?: import('@insiderfinance/totalfinance/core').PriceSource; default: not declared — Which quote price to invert when a quote has no `impliedVolatility` (default `mid`). - volatility-surface.config.sabrBeta?: number; default: not declared — SABR backbone exponent β ∈ [0, 1] for `model: 'sabr'` (default 0.5). - volatility-surface.config.sabrVolatilityType?: import('@insiderfinance/totalfinance/options').SabrVolatilityType; default: not declared — SABR Hagan expansion for `model: 'sabr'` (default `'lognormal'`). - volatility-surface.config.smoothingBandwidth?: number; default: not declared — Gaussian-kernel bandwidth (in log-moneyness) for `model: 'smoothed'` (default auto). - volatility-surface.config.ssviPhi?: 'power-law' | 'heston'; default: not declared — Curvature family for the global `model: 'ssvi'` calibration (default `'power-law'`). - volatility-surface.config.ssviWeight?: 'vega' | 'uniform'; default: not declared — Least-squares weighting for `model: 'ssvi'`: `'uniform'` (default) or `'vega'` (ATM-dominant). - volatility-surface.market: import('@insiderfinance/totalfinance/volatility').SurfaceMarket; default: not declared - volatility-surface.market.asOf: string | number; default: not declared — Snapshot time: epoch ms, `'YYYY-MM-DD'`, or a ZONED ISO datetime — one grammar for "when" across every package. Each boundary resolves it once via core `resolveAsOf` (zone-less datetimes are rejected with a teaching error; TotalFinance never reads the machine clock or zone). - volatility-surface.market.dividendYield?: number; default: not declared — Continuous dividend yield; defaults to 0 when omitted. - volatility-surface.market.riskFreeRate: number; default: not declared - volatility-surface.market.spot?: number; default: not declared — Spot price. Falls back to each quote's `underlyingPrice` when omitted. - volatility-surface.quotes: OptionQuote[] | TableHandle; default: not declared - volatility-surface.quotes.columnCount: number; default: not declared - volatility-surface.quotes.columns?: string[]; default: not declared — Column names, in table order; when present, `columns.length === columnCount`. - volatility-surface.quotes.contentHash: string; default: not declared — `sha256:` hash of the table's canonical JSON row projection — encoding-independent identity. - volatility-surface.quotes.kind: 'totalfinance.table-handle'; default: not declared - volatility-surface.quotes.locator?: string; default: not declared — Storage-agnostic opaque reference — meaningful only to the storage layer that minted it. - volatility-surface.quotes.mediaType?: string; default: not declared — Concrete encoding of the stored bytes. `application/json` unless a future Arrow mapping lands. - volatility-surface.quotes.rowCount: number; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#VolatilityWarmStarts Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). What `warmStartFrom` returns per warm-startable family — spread into the next calibration's options. ```typescript /** What `warmStartFrom` returns per warm-startable family — spread into the next calibration's options. */ export interface VolatilityWarmStarts { svi: { initialParameters: SVIWarmStart; }; ssvi: { initialParameters: { rho: number; phi: SSVIPhi; }; }; essvi: { initialParameters: { rho: number[]; phi: SSVIPhi; }; }; 'sabr-smile': { initialParameters: { alpha: number; rho: number; nu: number; }; }; 'heston-surface': { initialParameters: HestonParameters; }; garch: { initialParameters: { alpha: number; beta: number; }; }; 'volatility-surface': { config: { hestonInitialParameters: HestonParameters; }; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - essvi: { initialParameters: { rho: number[]; phi: SSVIPhi; }; }; default: not declared - essvi.initialParameters: { rho: number[]; phi: SSVIPhi; }; default: not declared - essvi.initialParameters.phi: SSVIPhi; default: not declared - essvi.initialParameters.phi.eta: number; default: not declared - essvi.initialParameters.phi.gamma: number; default: not declared - essvi.initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - essvi.initialParameters.phi.lambda: number; default: not declared - essvi.initialParameters.rho: number[]; default: not declared - garch: { initialParameters: { alpha: number; beta: number; }; }; default: not declared - garch.initialParameters: { alpha: number; beta: number; }; default: not declared - garch.initialParameters.alpha: number; default: not declared - garch.initialParameters.beta: number; default: not declared - heston-surface: { initialParameters: HestonParameters; }; default: not declared - heston-surface.initialParameters: HestonParameters; default: not declared - heston-surface.initialParameters.kappa: number; default: not declared — Mean-reversion speed κ. - heston-surface.initialParameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - heston-surface.initialParameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - heston-surface.initialParameters.theta: number; default: not declared — Long-run variance θ. - heston-surface.initialParameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). - sabr-smile: { initialParameters: { alpha: number; rho: number; nu: number; }; }; default: not declared - sabr-smile.initialParameters: { alpha: number; rho: number; nu: number; }; default: not declared - sabr-smile.initialParameters.alpha: number; default: not declared - sabr-smile.initialParameters.nu: number; default: not declared - sabr-smile.initialParameters.rho: number; default: not declared - ssvi: { initialParameters: { rho: number; phi: SSVIPhi; }; }; default: not declared - ssvi.initialParameters: { rho: number; phi: SSVIPhi; }; default: not declared - ssvi.initialParameters.phi: SSVIPhi; default: not declared - ssvi.initialParameters.phi.eta: number; default: not declared - ssvi.initialParameters.phi.gamma: number; default: not declared - ssvi.initialParameters.phi.kind: ('heston') | ('power-law'); default: not declared - ssvi.initialParameters.phi.lambda: number; default: not declared - ssvi.initialParameters.rho: number; default: not declared - svi: { initialParameters: SVIWarmStart; }; default: not declared - svi.initialParameters: SVIWarmStart; default: not declared - svi.initialParameters.m: number; default: not declared - svi.initialParameters.sigma: number; default: not declared — `> 0`. - volatility-surface: { config: { hestonInitialParameters: HestonParameters; }; }; default: not declared - volatility-surface.config: { hestonInitialParameters: HestonParameters; }; default: not declared - volatility-surface.config.hestonInitialParameters: HestonParameters; default: not declared - volatility-surface.config.hestonInitialParameters.kappa: number; default: not declared — Mean-reversion speed κ. - volatility-surface.config.hestonInitialParameters.rho: number; default: not declared — Spot/variance correlation ρ ∈ [−1, 1]. - volatility-surface.config.hestonInitialParameters.sigma: number; default: not declared — Volatility of variance ξ ("vol of vol"). - volatility-surface.config.hestonInitialParameters.theta: number; default: not declared — Long-run variance θ. - volatility-surface.config.hestonInitialParameters.v0: number; default: not declared — Initial instantaneous variance v₀ (= σ₀²). ### @insiderfinance/totalfinance/volatility/artifacts#WarmStartOf Kind: type; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export type WarmStartOf = F extends keyof VolatilityWarmStarts ? VolatilityWarmStarts[F] : never; ``` ### @insiderfinance/totalfinance/volatility/artifacts#compareFittedModels Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Compare two fits of one family: named parameter deltas, objective/convergence/residual deltas, arbitrage-status change, market and calibration identity, the structural fit diff, and a shared-grid evaluation difference through the direct evaluator (Decision 6). ```typescript export declare function compareFittedModels(input: { baseline: VolatilityFittedModelReport | AnalysisArtifact; candidate: VolatilityFittedModelReport | AnalysisArtifact; tolerance?: ComparisonTolerance; evaluation?: Record; limits?: ComparisonLimits & { gridPoints?: number; }; }): FittedModelComparison; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { baseline: VolatilityFittedModelReport | AnalysisArtifact; candidate: VolatilityFittedModelReport | AnalysisArtifact; tolerance?: ComparisonTolerance; evaluation?: Record; limits?: ComparisonLimits & { gridPoints?: number; }; }; default: not declared - (input).baseline: AnalysisArtifact | VolatilityFittedModelReport; default: not declared - (input).baseline.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).baseline.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).baseline.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).baseline.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).baseline.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).baseline.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).baseline.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).baseline.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).baseline.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).baseline.schemaVersion: number; default: not declared - (input).baseline.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).candidate: AnalysisArtifact | VolatilityFittedModelReport; default: not declared - (input).candidate.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).candidate.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).candidate.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).candidate.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).candidate.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).candidate.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).candidate.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).candidate.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).candidate.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).candidate.schemaVersion: number; default: not declared - (input).candidate.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - (input).evaluation?: Record; default: not declared - (input).limits?: ComparisonLimits & { gridPoints?: number; }; default: not declared - (input).limits.gridPoints?: number; default: not declared - (input).limits.maximumDifferences?: number; default: not declared — Changed, added and removed differences share one retention cap per walk (default 1,000, maximum 100,000); the rest are counted. - (input).limits.maximumLeaves?: number; default: not declared — Canonical work units each side may cost before the comparison refuses (default and maximum 2,000,000). A leaf costs one unit, so this bounds the leaves walked from above. - (input).tolerance?: ComparisonTolerance; default: not declared - return.artifactIds: { baseline: string | null; candidate: string | null; }; default: not declared - return.artifactIds.baseline: string | null; default: not declared - return.artifactIds.candidate: string | null; default: not declared - return.assumptions: { conventionsVersion: string; family: F; tolerance: ComparisonTolerance | null; limits: { maximumDifferences: number; maximumLeaves: number; gridPoints: number; }; evaluationReason: string | null; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.evaluationReason: string | null; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.limits: { maximumDifferences: number; maximumLeaves: number; gridPoints: number; }; default: not declared - return.assumptions.limits.gridPoints: number; default: not declared - return.assumptions.limits.maximumDifferences: number; default: not declared - return.assumptions.limits.maximumLeaves: number; default: not declared - return.assumptions.tolerance: ComparisonTolerance | null; default: not declared - return.assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - return.assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - return.convergence: { baseline: boolean; candidate: boolean; }; default: not declared - return.convergence.baseline: boolean; default: not declared - return.convergence.candidate: boolean; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.evaluation: { grid: Array>; unit: string; comparedCount: number; nullCount: number; maximumAbsoluteDifference: number | null; rootMeanSquareDifference: number | null; placement: string; } | null; default: not declared - return.evaluation.comparedCount: number; default: not declared - return.evaluation.grid: Record[]; default: not declared - return.evaluation.maximumAbsoluteDifference: number | null; default: not declared - return.evaluation.nullCount: number; default: not declared - return.evaluation.placement: string; default: not declared - return.evaluation.rootMeanSquareDifference: number | null; default: not declared - return.evaluation.unit: string; default: not declared - return.family: F; default: not declared - return.fit: { differenceCount: number; retainedDifferences: number; addedPaths: string[]; removedPaths: string[]; truncated: boolean; }; default: not declared - return.fit.addedPaths: string[]; default: not declared - return.fit.differenceCount: number; default: not declared - return.fit.removedPaths: string[]; default: not declared - return.fit.retainedDifferences: number; default: not declared - return.fit.truncated: boolean; default: not declared - return.modelRisk: { baselineArbitrageFree: boolean | null; candidateArbitrageFree: boolean | null; changed: boolean; }; default: not declared - return.modelRisk.baselineArbitrageFree: boolean | null; default: not declared - return.modelRisk.candidateArbitrageFree: boolean | null; default: not declared - return.modelRisk.changed: boolean; default: not declared - return.objective: { kind: string; unit: string; baselineValue: number | null; candidateValue: number | null; absoluteDelta: number | null; }; default: not declared - return.objective.absoluteDelta: number | null; default: not declared - return.objective.baselineValue: number | null; default: not declared - return.objective.candidateValue: number | null; default: not declared - return.objective.kind: string; default: not declared - return.objective.unit: string; default: not declared - return.parameters: ParameterDelta[]; default: not declared - return.residuals: { baselineRootMeanSquare: number | null; candidateRootMeanSquare: number | null; absoluteDelta: number | null; }; default: not declared - return.residuals.absoluteDelta: number | null; default: not declared - return.residuals.baselineRootMeanSquare: number | null; default: not declared - return.residuals.candidateRootMeanSquare: number | null; default: not declared - return.sameCalibrationInput: boolean; default: not declared - return.sameMarket: boolean | null; default: not declared - return.withinTolerance: boolean | null; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#evaluateFittedModel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate a restored fitted model through its family's direct evaluator (Decision 3). ```typescript export declare function evaluateFittedModel(input: { model: VolatilityFittedModelReport | AnalysisArtifact; at: EvaluationOf; }): FittedModelEvaluation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { model: VolatilityFittedModelReport | AnalysisArtifact; at: EvaluationOf; }; default: not declared - (input).at: EvaluationOf; default: not declared - (input).model: AnalysisArtifact | VolatilityFittedModelReport; default: not declared - (input).model.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).model.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).model.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).model.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).model.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).model.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).model.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).model.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).model.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).model.schemaVersion: number; default: not declared - (input).model.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. - return.assumptions: { conventionsVersion: string; family: F; modelVersion: number; evaluator: string; options: Record; extrapolation: string; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.evaluator: string; default: not declared - return.assumptions.extrapolation: string; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.options: Record; default: not declared - return.at: EvaluationOf; default: not declared - return.coordinates: Record[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; outsideCalibratedRange: number; }; default: not declared - return.diagnostics.outsideCalibratedRange: number; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: F; default: not declared - return.reasons: { index: number; reason: string; }[]; default: not declared - return.unit: string; default: not declared - return.values: (number | null)[]; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#fittedModelArtifact Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Describe a direct calibrator's result and save it as an identified, immutable artifact. ```typescript export declare function fittedModelArtifact(input: FittedModelArtifactInput): AnalysisArtifact; ``` Example (source JSDoc): ```ts const fit = calibrateSsvi(surface, { weight: 'vega' }); const artifact = fittedModelArtifact({ family: 'ssvi', fit, calibration: { surface, options: { weight: 'vega' } }, snapshotHash: marketSnapshotContentHash(snapshot), }); ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FittedModelArtifactInput; default: not declared - (input).calibration: CalibrationOf; default: not declared — The calibrator's input with its rows — the adapter mints the handle for any row set named in `referenceRowSets`. - (input).createdFrom?: string[]; default: not declared - (input).family: F; default: not declared - (input).fit: F extends 'volatility-surface' ? VolatilitySurface | FitOf : FitOf; default: not declared — The direct calibrator's result; for `volatility-surface` the live surface is accepted and snapshotted. - (input).libraryVersion?: string; default: not declared - (input).limits?: FittedModelArtifactLimits; default: not declared - (input).locators?: Record; default: not declared — Storage locators to stamp on the minted handles, keyed by row set. - (input).provenance?: Provenance; default: not declared - (input).referenceRowSets?: readonly string[]; default: not declared — Row sets (from the family descriptor's `referenceableRowSets`) to store by `TableHandle` instead of embedding. - (input).snapshotHash?: string; default: not declared - return.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - return.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - return.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - return.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - return.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - return.kind: 'totalfinance.analysis-artifact'; default: not declared - return.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - return.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - return.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - return.schemaVersion: number; default: not declared - return.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ### @insiderfinance/totalfinance/volatility/artifacts#fittedModelHoldout Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Fit on the retained points through the direct calibrator, evaluate the direct evaluator on the held-out points, and report in-sample and out-of-sample residuals (Decision 8). ```typescript export declare function fittedModelHoldout(input: FittedModelHoldoutInput): FittedModelHoldoutReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FittedModelHoldoutInput; default: not declared - (input).calibration: CalibrationOf; default: not declared - (input).family: F; default: not declared - (input).holdout: FittedModelHoldoutSelection; default: not declared - return.assumptions: { conventionsVersion: string; family: F; modelVersion: number; holdout: FittedModelHoldoutSelection; residualSource: 'direct-evaluator'; partition: 'cross-sectional points' | 'time-series prefix'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.holdout: FittedModelHoldoutSelection; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.partition: 'cross-sectional points' | 'time-series prefix'; default: not declared - return.assumptions.residualSource: 'direct-evaluator'; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: F; default: not declared - return.heldOutCount: number; default: not declared - return.inSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; default: not declared - return.inSample.count: number; default: not declared - return.inSample.maximumAbsolute: number | null; default: not declared - return.inSample.rootMeanSquare: number | null; default: not declared - return.outOfSample: { count: number; rootMeanSquare: number | null; maximumAbsolute: number | null; }; default: not declared - return.outOfSample.count: number; default: not declared - return.outOfSample.maximumAbsolute: number | null; default: not declared - return.outOfSample.rootMeanSquare: number | null; default: not declared - return.retainedCount: number; default: not declared - return.retainedFit: FittedModelSummary; default: not declared - return.unit: string; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#fittedModelStability Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-run the direct calibrator from seeded, deterministic perturbations of the base fit's free start members and report the parameter spread (Decision 8). ```typescript export declare function fittedModelStability(input: FittedModelStabilityInput): FittedModelStabilityReport; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): FittedModelStabilityInput; default: not declared - (input).calibration: CalibrationOf; default: not declared - (input).family: F; default: not declared - (input).perturbation: { relative: number; }; default: not declared - (input).perturbation.relative: number; default: not declared - (input).restarts: number; default: not declared - (input).seed: number; default: not declared - (input).tolerance?: ComparisonTolerance; default: not declared - return.assumptions: { conventionsVersion: string; family: F; modelVersion: number; seed: number; generator: 'mulberry32'; perturbation: { relative: number; }; members: string[]; tolerance: ComparisonTolerance | null; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.family: F; default: not declared - return.assumptions.generator: 'mulberry32'; default: not declared - return.assumptions.members: string[]; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.perturbation: { relative: number; }; default: not declared - return.assumptions.perturbation.relative: number; default: not declared - return.assumptions.seed: number; default: not declared - return.assumptions.tolerance: ComparisonTolerance | null; default: not declared - return.assumptions.tolerance.absolute: number; default: not declared — Absolute tolerance in the leaf's own unit; `≥ 0`, finite. - return.assumptions.tolerance.relative: number; default: not declared — Relative tolerance as a fraction of the baseline's magnitude; `≥ 0`, finite. - return.convergedCount: number; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: F; default: not declared - return.objective: { unit: string; baseline: number | null; minimum: number | null; maximum: number | null; }; default: not declared - return.objective.baseline: number | null; default: not declared - return.objective.maximum: number | null; default: not declared - return.objective.minimum: number | null; default: not declared - return.objective.unit: string; default: not declared - return.parameters: Record; default: not declared - return.restarts: number; default: not declared - return.stable: boolean | null; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#readFittedModel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Restore a fitted-model artifact: Gate B's read door, a foreign-type refusal, then the caller's registry applied a second time at the report level (Decision 5), then the report re-validated. ```typescript export declare function readFittedModel(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; }): ReadFittedModelResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).migrations?: ArtifactMigrationRegistry; default: not declared - return.artifact: AnalysisArtifact; default: not declared - return.migrationsApplied: AppliedMigration[]; default: not declared - return.modelMigrationsApplied: AppliedMigration[]; default: not declared - return.report: VolatilityFittedModelReport; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#replayFittedModel Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Re-issue the family's direct calibrator from the stored calibration and prove byte parity. ```typescript export declare function replayFittedModel(input: { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; libraryVersion?: string; limits?: ComparisonLimits; }): FittedModelReplay; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { artifact: unknown; migrations?: ArtifactMigrationRegistry; referencedData?: Record; libraryVersion?: string; limits?: ComparisonLimits; }; default: not declared - (input).artifact: unknown; default: not declared — The artifact as held OR as restored from JSON (`fromCanonicalJson`) — validated at runtime, never trusted by declaration. - (input).libraryVersion?: string; default: not declared - (input).limits?: ComparisonLimits; default: not declared - (input).migrations?: ArtifactMigrationRegistry; default: not declared - (input).referencedData?: Record; default: not declared - return.artifactId: string; default: not declared - return.assumptions: { conventionsVersion: string; family: VolatilityModelFamily; modelVersion: number; calibrator: string; libraryVersion: { saved: string | null; current: string | null; }; referencedRowSets: string[]; }; default: not declared - return.assumptions.calibrator: string; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.family: VolatilityModelFamily; default: not declared - return.assumptions.libraryVersion: { saved: string | null; current: string | null; }; default: not declared - return.assumptions.libraryVersion.current: string | null; default: not declared - return.assumptions.libraryVersion.saved: string | null; default: not declared - return.assumptions.modelVersion: number; default: not declared - return.assumptions.referencedRowSets: string[]; default: not declared - return.diagnostics: { warnings: QuantWarning[]; }; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.family: VolatilityModelFamily; default: not declared - return.parity: ArtifactReplayParity; default: not declared - return.recomputed: VolatilityFittedModelReport; default: not declared ### @insiderfinance/totalfinance/volatility/artifacts#warmStartFrom Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The warm-start option a saved fit fills for the next calibration (Decision 8). ```typescript export declare function warmStartFrom(input: { model: VolatilityFittedModelReport | AnalysisArtifact; }): WarmStartOf; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { model: VolatilityFittedModelReport | AnalysisArtifact; }; default: not declared - (input).model: AnalysisArtifact | VolatilityFittedModelReport; default: not declared - (input).model.artifactType: string; default: not declared — Dot-namespaced artifact type, e.g. `'options.chain-analysis'` — names the result schema. - (input).model.conventionsVersion: string; default: not declared — The library conventions revision the artifact was CREATED under — stamped from core's `CONVENTIONS_VERSION` (the market snapshot's law, one law), never an echo of the result and never caller-set. Covered by the id; validated as a non-empty string on read. - (input).model.createdFrom?: string[]; default: not declared — Parent artifact ids this one was derived from, oldest first. - (input).model.id: string; default: not declared — Content hash of the body (everything but `id` and `provenance`) — stamped at creation. - (input).model.inputs: import('@insiderfinance/totalfinance/core/artifacts').ArtifactInputs; default: not declared - (input).model.kind: 'totalfinance.analysis-artifact'; default: not declared - (input).model.producedBy: import('@insiderfinance/totalfinance/core/artifacts').ArtifactProducedBy; default: not declared - (input).model.provenance?: Provenance; default: not declared — Data lineage, caller-supplied, outside the id (labels are not identity). - (input).model.result: Record; default: not declared — The producing call's return value, verbatim: `{ …, assumptions, diagnostics }`. - (input).model.schemaVersion: number; default: not declared - (input).model.tables?: Record; default: not declared — Named large-table references — rows live where storage puts them, identity lives here. ## Entrypoint @insiderfinance/totalfinance/volatility/earnings ### @insiderfinance/totalfinance/volatility/earnings#AtmVolatilityPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#AtmVolatilityPoint`. ### @insiderfinance/totalfinance/volatility/earnings#CalibratedEvent Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#CalibratedEvent`. ### @insiderfinance/totalfinance/volatility/earnings#EventMoveCalibration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#EventMoveCalibration`. ### @insiderfinance/totalfinance/volatility/earnings#EventMoveObservation Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#EventMoveObservation`. ### @insiderfinance/totalfinance/volatility/earnings#EventVolatilityAtExpiryResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#EventVolatilityAtExpiryResult`. ### @insiderfinance/totalfinance/volatility/earnings#EventVolatilityAtExpiryRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#EventVolatilityAtExpiryRow`. ### @insiderfinance/totalfinance/volatility/earnings#EventVolatilityCalibration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#EventVolatilityCalibration`. ### @insiderfinance/totalfinance/volatility/earnings#FitEventVolatilityOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#FitEventVolatilityOptions`. ### @insiderfinance/totalfinance/volatility/earnings#FittedExpiry Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#FittedExpiry`. ### @insiderfinance/totalfinance/volatility/earnings#calibrateEventMove Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateEventMove`. ### @insiderfinance/totalfinance/volatility/earnings#calibrateEventVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateEventVolatility`. ### @insiderfinance/totalfinance/volatility/earnings#eventVolatilityAtExpiry Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#eventVolatilityAtExpiry`. ## Entrypoint @insiderfinance/totalfinance/volatility/essvi ### @insiderfinance/totalfinance/volatility/essvi#ESSVIArbitrage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ESSVIArbitrage`. ### @insiderfinance/totalfinance/volatility/essvi#ESSVICalibration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ESSVICalibration`. ### @insiderfinance/totalfinance/volatility/essvi#ESSVICalibrationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ESSVICalibrationInput`. ### @insiderfinance/totalfinance/volatility/essvi#ESSVICalibrationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ESSVICalibrationOptions`. ### @insiderfinance/totalfinance/volatility/essvi#ESSVIParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ESSVIParameters`. ### @insiderfinance/totalfinance/volatility/essvi#ESSVISliceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ESSVISliceInput`. ### @insiderfinance/totalfinance/volatility/essvi#calibrateEssvi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateEssvi`. ### @insiderfinance/totalfinance/volatility/essvi#essviArbitrageFree Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnose the no-arbitrage status of an eSSVI surface: butterfly (exact Gatheral `g ≥ 0` at each grid maturity, reducing the slice to raw SVI) and calendar (`w(k, t)` non-decreasing in `t` at every grid `k`, scanned directly because θ-monotonicity is not sufficient once `ρ` varies). See the spec. ```typescript export declare function essviArbitrageFree(parameters: ESSVIParameters, options?: { grid?: number[]; maturityGrid?: number[]; }): ESSVIArbitrage; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { grid?: number[]; maturityGrid?: number[]; }; default: not declared - (options).grid?: number[]; default: not declared - (options).maturityGrid?: number[]; default: not declared - (parameters): ESSVIParameters; default: not declared - (parameters).phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - (parameters).thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - return.butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every grid maturity. - return.calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage — `w(k, t)` non-decreasing in `t` at every grid `k` (the definition). - return.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and maturities (`≥ 0` ⇔ butterfly-free). - return.minCalendarSlope: number; default: not declared — Minimum `Δw` between adjacent maturities over the grid (`≥ 0` ⇔ calendar-free). ### @insiderfinance/totalfinance/volatility/essvi#essviTotalVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Total implied variance `w(k, t)` on a calibrated eSSVI surface. ```typescript export declare function essviTotalVariance(parameters: ESSVIParameters, k: number, timeToExpiryYears: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): ESSVIParameters; default: not declared - (parameters).phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - (parameters).thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - (timeToExpiryYears): number; default: not declared ### @insiderfinance/totalfinance/volatility/essvi#essviVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied volatility `√(w/t)` on a calibrated eSSVI surface. ```typescript export declare function essviVolatility(parameters: ESSVIParameters, k: number, timeToExpiryYears: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): ESSVIParameters; default: not declared - (parameters).phi: SSVIPhi; default: not declared — Curvature function (global), same family as SSVI. - (parameters).thetaTerm: { timeToExpiryYears: number; theta: number; rho: number; }[]; default: not declared — Per-knot `(t, θ, ρ)`: θ strictly increasing (calendar backbone), ρ ∈ (−1, 1) per maturity. - (timeToExpiryYears): number; default: not declared ## Entrypoint @insiderfinance/totalfinance/volatility/estimate ### @insiderfinance/totalfinance/volatility/estimate#RISK_NEUTRAL_ESTIMATE Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#RISK_NEUTRAL_ESTIMATE`. ## Entrypoint @insiderfinance/totalfinance/volatility/event ### @insiderfinance/totalfinance/volatility/event#EventVolatilityDecomposition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#EventVolatilityDecomposition`. ### @insiderfinance/totalfinance/volatility/event#ExpectedMove Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ExpectedMove`. ### @insiderfinance/totalfinance/volatility/event#ExpectedMoveImpliedVolatilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ExpectedMoveImpliedVolatilityInput`. ### @insiderfinance/totalfinance/volatility/event#ExpectedMoveStraddleInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ExpectedMoveStraddleInput`. ### @insiderfinance/totalfinance/volatility/event#ProbabilityInTheMoneyInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ProbabilityInTheMoneyInput`. ### @insiderfinance/totalfinance/volatility/event#ProbabilityOfTouchInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ProbabilityOfTouchInput`. ### @insiderfinance/totalfinance/volatility/event#RealizedImpliedInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#RealizedImpliedInput`. ### @insiderfinance/totalfinance/volatility/event#eventStrippedVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#eventStrippedVolatility`. ### @insiderfinance/totalfinance/volatility/event#eventVolatilityDecomposition Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#eventVolatilityDecomposition`. ### @insiderfinance/totalfinance/volatility/event#expectedMoveFromImpliedVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#expectedMoveFromImpliedVolatility`. ### @insiderfinance/totalfinance/volatility/event#expectedMoveFromStraddle Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#expectedMoveFromStraddle`. ### @insiderfinance/totalfinance/volatility/event#probabilityInTheMoney Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#probabilityInTheMoney`. ### @insiderfinance/totalfinance/volatility/event#probabilityOfTouch Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#probabilityOfTouch`. ### @insiderfinance/totalfinance/volatility/event#realizedImpliedSpread Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#realizedImpliedSpread`. ### @insiderfinance/totalfinance/volatility/event#varianceRiskPremium Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#varianceRiskPremium`. ## Entrypoint @insiderfinance/totalfinance/volatility/forecast ### @insiderfinance/totalfinance/volatility/forecast#GarchFit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#GarchFit`. ### @insiderfinance/totalfinance/volatility/forecast#GarchFitOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#GarchFitOptions`. ### @insiderfinance/totalfinance/volatility/forecast#GarchForecast Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#GarchForecast`. ### @insiderfinance/totalfinance/volatility/forecast#GarchForecastInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#GarchForecastInput`. ### @insiderfinance/totalfinance/volatility/forecast#GarchForecastOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#GarchForecastOptions`. ### @insiderfinance/totalfinance/volatility/forecast#HarRvCoefficients Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HarRvCoefficients`. ### @insiderfinance/totalfinance/volatility/forecast#HarRvFit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HarRvFit`. ### @insiderfinance/totalfinance/volatility/forecast#HarRvForecastAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HarRvForecastAssumptions`. ### @insiderfinance/totalfinance/volatility/forecast#HarRvForecastFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HarRvForecastFacade`. ### @insiderfinance/totalfinance/volatility/forecast#HarRvOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HarRvOptions`. ### @insiderfinance/totalfinance/volatility/forecast#fitGarch Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#fitGarch`. ### @insiderfinance/totalfinance/volatility/forecast#fitHarRv Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#fitHarRv`. ### @insiderfinance/totalfinance/volatility/forecast#garchForecast Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#garchForecast`. ### @insiderfinance/totalfinance/volatility/forecast#harRvForecast Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#harRvForecast`. ## Entrypoint @insiderfinance/totalfinance/volatility/heston-surface ### @insiderfinance/totalfinance/volatility/heston-surface#HestonSurfaceCalibrationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#HestonSurfaceCalibrationInput`. ### @insiderfinance/totalfinance/volatility/heston-surface#HestonSurfaceFit Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HestonSurfaceFit`. ### @insiderfinance/totalfinance/volatility/heston-surface#HestonSurfaceMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HestonSurfaceMarket`. ### @insiderfinance/totalfinance/volatility/heston-surface#HestonSurfaceTarget Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#HestonSurfaceTarget`. ### @insiderfinance/totalfinance/volatility/heston-surface#calibrateHestonSurface Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateHestonSurface`. ## Entrypoint @insiderfinance/totalfinance/volatility/local-volatility ### @insiderfinance/totalfinance/volatility/local-volatility#DupireOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#DupireOptions`. ### @insiderfinance/totalfinance/volatility/local-volatility#LocalVolatilityFunction Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityFunction`. ### @insiderfinance/totalfinance/volatility/local-volatility#LocalVolatilityGridSpecification Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityGridSpecification`. ### @insiderfinance/totalfinance/volatility/local-volatility#LocalVolatilityMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/options#LocalVolatilityMarket`. ### @insiderfinance/totalfinance/volatility/local-volatility#LocalVolatilitySurface Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#LocalVolatilitySurface`. ### @insiderfinance/totalfinance/volatility/local-volatility#LocalVolatilitySurfaceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#LocalVolatilitySurfaceInput`. ### @insiderfinance/totalfinance/volatility/local-volatility#SurfaceLocalVolatilityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SurfaceLocalVolatilityInput`. ### @insiderfinance/totalfinance/volatility/local-volatility#localVolatilitySurface Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#localVolatilitySurface`. ### @insiderfinance/totalfinance/volatility/local-volatility#surfaceLocalVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#surfaceLocalVolatility`. ## Entrypoint @insiderfinance/totalfinance/volatility/metrics ### @insiderfinance/totalfinance/volatility/metrics#ImpliedVolatilityMetricInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#ImpliedVolatilityMetricInput`. ### @insiderfinance/totalfinance/volatility/metrics#ImpliedVolatilityStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ImpliedVolatilityStatistics`. ### @insiderfinance/totalfinance/volatility/metrics#impliedVolatilityPercentile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#impliedVolatilityPercentile`. ### @insiderfinance/totalfinance/volatility/metrics#impliedVolatilityRank Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#impliedVolatilityRank`. ### @insiderfinance/totalfinance/volatility/metrics#impliedVolatilityStatistics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#impliedVolatilityStatistics`. ## Entrypoint @insiderfinance/totalfinance/volatility/min-variance-delta ### @insiderfinance/totalfinance/volatility/min-variance-delta#MinimumVarianceDeltaOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#MinimumVarianceDeltaOptions`. ### @insiderfinance/totalfinance/volatility/min-variance-delta#MinimumVarianceDeltaResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#MinimumVarianceDeltaResult`. ### @insiderfinance/totalfinance/volatility/min-variance-delta#minimumVarianceDelta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#minimumVarianceDelta`. ## Entrypoint @insiderfinance/totalfinance/volatility/risk-reversal ### @insiderfinance/totalfinance/volatility/risk-reversal#RiskReversalButterfly Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#RiskReversalButterfly`. ### @insiderfinance/totalfinance/volatility/risk-reversal#RiskReversalButterflyInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#RiskReversalButterflyInput`. ### @insiderfinance/totalfinance/volatility/risk-reversal#SmileAnchors Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SmileAnchors`. ### @insiderfinance/totalfinance/volatility/risk-reversal#SmileFromQuotesInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SmileFromQuotesInput`. ### @insiderfinance/totalfinance/volatility/risk-reversal#riskReversalButterfly Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#riskReversalButterfly`. ### @insiderfinance/totalfinance/volatility/risk-reversal#smileFromQuotes Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#smileFromQuotes`. ## Entrypoint @insiderfinance/totalfinance/volatility/sabr ### @insiderfinance/totalfinance/volatility/sabr#SABRCalibrationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SABRCalibrationOptions`. ### @insiderfinance/totalfinance/volatility/sabr#SABRCalibrationResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SABRCalibrationResult`. ### @insiderfinance/totalfinance/volatility/sabr#SABRSmileInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SABRSmileInput`. ### @insiderfinance/totalfinance/volatility/sabr#calibrateSabrSmile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateSabrSmile`. ## Entrypoint @insiderfinance/totalfinance/volatility/sabr-delta ### @insiderfinance/totalfinance/volatility/sabr-delta#SabrBartlettGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SabrBartlettGreeks`. ### @insiderfinance/totalfinance/volatility/sabr-delta#SabrBartlettGreeksInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SabrBartlettGreeksInput`. ### @insiderfinance/totalfinance/volatility/sabr-delta#SabrBartlettOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SabrBartlettOptions`. ### @insiderfinance/totalfinance/volatility/sabr-delta#sabrBartlettGreeks Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#sabrBartlettGreeks`. ## Entrypoint @insiderfinance/totalfinance/volatility/skew ### @insiderfinance/totalfinance/volatility/skew#RiskReversalConvention Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#RiskReversalConvention`. ### @insiderfinance/totalfinance/volatility/skew#SkewConfig Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SkewConfig`. ### @insiderfinance/totalfinance/volatility/skew#SkewInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#SkewInput`. ### @insiderfinance/totalfinance/volatility/skew#SkewMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SkewMarket`. ### @insiderfinance/totalfinance/volatility/skew#SkewMetrics Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SkewMetrics`. ### @insiderfinance/totalfinance/volatility/skew#SkewResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SkewResult`. ### @insiderfinance/totalfinance/volatility/skew#skew Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#skew`. ## Entrypoint @insiderfinance/totalfinance/volatility/ssvi ### @insiderfinance/totalfinance/volatility/ssvi#PreparedSlice Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). A market slice with its total variances resolved and its ATM θ computed. Shared with `./essvi.ts`. ```typescript /** A market slice with its total variances resolved and its ATM θ computed. Shared with `./essvi.ts`. */ export interface PreparedSlice { timeToExpiryYears: number; k: number[]; w: number[]; theta: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - k: number[]; default: not declared - theta: number; default: not declared - timeToExpiryYears: number; default: not declared - w: number[]; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#SSVIArbitrage Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVIArbitrage`. ### @insiderfinance/totalfinance/volatility/ssvi#SSVICalibration Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVICalibration`. ### @insiderfinance/totalfinance/volatility/ssvi#SSVICalibrationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVICalibrationInput`. ### @insiderfinance/totalfinance/volatility/ssvi#SSVICalibrationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVICalibrationOptions`. ### @insiderfinance/totalfinance/volatility/ssvi#SSVIParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVIParameters`. ### @insiderfinance/totalfinance/volatility/ssvi#SSVIPhi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVIPhi`. ### @insiderfinance/totalfinance/volatility/ssvi#SSVISliceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SSVISliceInput`. ### @insiderfinance/totalfinance/volatility/ssvi#SsviSliceInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export interface SsviSliceInput { k: number; theta: number; rho: number; psi: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - k: number; default: not declared - psi: number; default: not declared - rho: number; default: not declared - theta: number; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#SsviToSviInput Kind: interface; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Exact reduction of SSVI-at-θ to a raw-SVI slice, so `./svi.ts` evaluation and the Gatheral-`g` butterfly test apply directly: `a = (θ/2)(1−ρ²)`, `b = θψ/2`, `ρ_svi = ρ`, `m = −ρ/ψ`, `σ = √(1−ρ²)/ψ` (`ψ = φ(θ)`). Shared with `./essvi.ts`. ```typescript /** * Exact reduction of SSVI-at-θ to a raw-SVI slice, so `./svi.ts` evaluation and the Gatheral-`g` * butterfly test apply directly: `a = (θ/2)(1−ρ²)`, `b = θψ/2`, `ρ_svi = ρ`, `m = −ρ/ψ`, * `σ = √(1−ρ²)/ψ` (`ψ = φ(θ)`). Shared with `./essvi.ts`. */ export interface SsviToSviInput { theta: number; rho: number; psi: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - psi: number; default: not declared - rho: number; default: not declared - theta: number; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#atmTotalVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Linear interpolation of the (k, w) points evaluated at k = 0 (the ATM total variance). Shared with `./essvi.ts`. ```typescript export declare function atmTotalVariance(k: number[], w: number[]): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number[]; default: not declared - (w): number[]; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#calibrateSsvi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateSsvi`. ### @insiderfinance/totalfinance/volatility/ssvi#calibrationWeights Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Per-point least-squares weights for a set of prepared slices: `1` (uniform) or the Black vega `φ(d₁)·√t` at the market vol `σ = √(w/t)` (vega). The weights depend only on the market data, so they are computed once and held fixed across the calibration search. A degenerate point (`w ≤ 0`) gets weight 0. ```typescript export declare function calibrationWeights(slices: Array<{ timeToExpiryYears: number; k: number[]; w: number[]; }>, weight: 'uniform' | 'vega'): number[][]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (slices): { timeToExpiryYears: number; k: number[]; w: number[]; }[]; default: not declared - (weight): 'vega' | 'uniform'; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#phiValue Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Evaluate the curvature `φ(θ)`. Shared with `./essvi.ts` (the eSSVI extension) so the two use one definition. The unguarded arithmetic lives in `./ssvi-kernel.ts`, which the grid sweeps call. 3B.1b STOP: `phiValue#0`'s generated spec collapses the `SSVIPhi` union to its shared `kind` field (a top-level spec carries no branches), so enforcing it would reject the union's own `eta`/`gamma`/`lambda` as unknown fields. `requirePhi` remains the validation head here. ```typescript export declare function phiValue(phi: SSVIPhi, theta: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (phi): SSVIPhi; default: not declared - (phi).eta: number; default: not declared - (phi).gamma: number; default: not declared - (phi).kind: ('heston') | ('power-law'); default: not declared - (phi).lambda: number; default: not declared - (theta): number; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#prepareSlices Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Validate + resolve each slice's total variances (`w` or `iv²·t`), compute its ATM θ, and sort by maturity. Shared with `./essvi.ts`, whose calibration input is the same `{ slices }` shape. ```typescript export declare function prepareSlices(input: SSVICalibrationInput, functionName: string): PreparedSlice[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (input): SSVICalibrationInput; default: not declared - (input).slices: SSVISliceInput[]; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#ssviArbitrageFree Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Diagnose the no-arbitrage status of an SSVI surface: calendar (θ non-decreasing + the ∂_θ(θφ) bound) and butterfly (the exact Gatheral `g ≥ 0` density test at every θ-knot, plus the Gatheral–Jacquier sufficient conditions). See the spec. ```typescript export declare function ssviArbitrageFree(parameters: SSVIParameters, options?: { grid?: number[]; }): SSVIArbitrage; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: { grid?: number[]; }; default: not declared - (options).grid?: number[]; default: not declared - (parameters): SSVIParameters; default: not declared - (parameters).phi: SSVIPhi; default: not declared — Curvature function. - (parameters).rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - (parameters).thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - return.butterflyArbitrageFree: boolean; default: not declared — No butterfly arbitrage — the exact Gatheral `g ≥ 0` density test at every θ-knot. - return.calendarArbitrageFree: boolean; default: not declared — No calendar-spread arbitrage (θ non-decreasing + the ∂_θ(θφ) bound). - return.minButterflyG: number; default: not declared — The minimum Gatheral `g(k)` over the grid and knots (`≥ 0` ⇔ butterfly-free). - return.sufficientConditionsHold: boolean; default: not declared — Whether the Gatheral–Jacquier SUFFICIENT conditions hold (guarantee arb-freedom for all `k`). ### @insiderfinance/totalfinance/volatility/ssvi#ssviSliceW Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). SSVI total variance at a fixed θ (the raw SSVI slice function). Shared with `./essvi.ts`. ```typescript export declare function ssviSliceW(input: SsviSliceInput): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SsviSliceInput; default: not declared - (input).k: number; default: not declared - (input).psi: number; default: not declared - (input).rho: number; default: not declared - (input).theta: number; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#ssviToSVI Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). ```typescript export declare function ssviToSVI(input: SsviToSviInput): SVIParameters; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): SsviToSviInput; default: not declared - (input).psi: number; default: not declared - (input).rho: number; default: not declared - (input).theta: number; default: not declared - return.a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - return.b: number; default: not declared — Wing slope / curvature, `≥ 0`. - return.m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - return.rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - return.sigma: number; default: not declared — Smoothness, `> 0`. ### @insiderfinance/totalfinance/volatility/ssvi#ssviTotalVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Total implied variance `w(k, t)` on a calibrated SSVI surface. ```typescript export declare function ssviTotalVariance(parameters: SSVIParameters, k: number, timeToExpiryYears: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): SSVIParameters; default: not declared - (parameters).phi: SSVIPhi; default: not declared — Curvature function. - (parameters).rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - (parameters).thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - (timeToExpiryYears): number; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#ssviVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied volatility `√(w/t)` on a calibrated SSVI surface. ```typescript export declare function ssviVolatility(parameters: SSVIParameters, k: number, timeToExpiryYears: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): SSVIParameters; default: not declared - (parameters).phi: SSVIPhi; default: not declared — Curvature function. - (parameters).rho: number; default: not declared — Global skew `ρ ∈ (−1, 1)`. - (parameters).thetaTerm: { timeToExpiryYears: number; theta: number; }[]; default: not declared — ATM total-variance knots `(t, θ)`, strictly increasing in both (calendar-arbitrage-free). - (timeToExpiryYears): number; default: not declared ### @insiderfinance/totalfinance/volatility/ssvi#thetaAt Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Interpolate `θ(t)` linearly in `t` from the knots; `θ(0)=0`, flat beyond the last knot (constant total variance — a decreasing vol). Monotone knots ⇒ monotone `θ(t)` ⇒ the time interpolation stays calendar-arbitrage-free. Shared with `./essvi.ts` (its richer `{t,theta,rho}` knots are assignable). ```typescript export declare function thetaAt(thetaTerm: SSVIParameters['thetaTerm'], timeToExpiryYears: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (thetaTerm): { timeToExpiryYears: number; theta: number; }[]; default: not declared - (timeToExpiryYears): number; default: not declared ## Entrypoint @insiderfinance/totalfinance/volatility/sticky-regime ### @insiderfinance/totalfinance/volatility/sticky-regime#StickyRegime Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#StickyRegime`. ### @insiderfinance/totalfinance/volatility/sticky-regime#StickyRegimeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#StickyRegimeInput`. ### @insiderfinance/totalfinance/volatility/sticky-regime#stickyRegime Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#stickyRegime`. ## Entrypoint @insiderfinance/totalfinance/volatility/surface ### @insiderfinance/totalfinance/volatility/surface#SURFACE_MARKET_KEYS Kind: value; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The documented {@link SurfaceMarket} fields (the {@link MarketInputs} keys, `spot` optional). ```typescript export declare const SURFACE_MARKET_KEYS: readonly ['spot', 'riskFreeRate', 'dividendYield', 'asOf']; ``` ### @insiderfinance/totalfinance/volatility/surface#SURFACE_SCHEMA_VERSION Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SURFACE_SCHEMA_VERSION`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceConfig Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceConfig`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceLookup Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceLookup`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceMarket Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceMarket`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceModel Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceModel`. ### @insiderfinance/totalfinance/volatility/surface#SurfacePoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfacePoint`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceRow Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceRow`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceShock Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceShock`. ### @insiderfinance/totalfinance/volatility/surface#SurfaceSlice Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceSlice`. ### @insiderfinance/totalfinance/volatility/surface#VolatilitySurface Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilitySurface`. ### @insiderfinance/totalfinance/volatility/surface#VolatilitySurfaceInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance#VolatilitySurfaceInput`. ### @insiderfinance/totalfinance/volatility/surface#VolatilitySurfaceSnapshot Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilitySurfaceSnapshot`. ### @insiderfinance/totalfinance/volatility/surface#volatilitySurface Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#volatilitySurface`. ## Entrypoint @insiderfinance/totalfinance/volatility/surface-pca ### @insiderfinance/totalfinance/volatility/surface-pca#SurfaceMode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceMode`. ### @insiderfinance/totalfinance/volatility/surface-pca#SurfacePcaInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfacePcaInput`. ### @insiderfinance/totalfinance/volatility/surface-pca#SurfacePcaResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfacePcaResult`. ### @insiderfinance/totalfinance/volatility/surface-pca#SurfacePcaScenarioInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfacePcaScenarioInput`. ### @insiderfinance/totalfinance/volatility/surface-pca#SurfacePcaScenarios Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfacePcaScenarios`. ### @insiderfinance/totalfinance/volatility/surface-pca#SurfaceScenario Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SurfaceScenario`. ### @insiderfinance/totalfinance/volatility/surface-pca#surfacePCA Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#surfacePCA`. ### @insiderfinance/totalfinance/volatility/surface-pca#surfacePcaScenarios Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#surfacePcaScenarios`. ## Entrypoint @insiderfinance/totalfinance/volatility/svi ### @insiderfinance/totalfinance/volatility/svi#SVICalibrationOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SVICalibrationOptions`. ### @insiderfinance/totalfinance/volatility/svi#SVICalibrationResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SVICalibrationResult`. ### @insiderfinance/totalfinance/volatility/svi#SVIParameters Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SVIParameters`. ### @insiderfinance/totalfinance/volatility/svi#SVISmileInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SVISmileInput`. ### @insiderfinance/totalfinance/volatility/svi#SVIWarmStart Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SVIWarmStart`. ### @insiderfinance/totalfinance/volatility/svi#calibrateSvi Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateSvi`. ### @insiderfinance/totalfinance/volatility/svi#sviButterflyFree Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Whether the slice is butterfly-arbitrage-free across a log-moneyness grid (default ±1, 81 points). ```typescript export declare function sviButterflyFree(parameters: SVIParameters, grid?: number[]): boolean; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (grid)?: number[]; default: not declared - (parameters): SVIParameters; default: not declared - (parameters).a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - (parameters).b: number; default: not declared — Wing slope / curvature, `≥ 0`. - (parameters).m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - (parameters).rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - (parameters).sigma: number; default: not declared — Smoothness, `> 0`. ### @insiderfinance/totalfinance/volatility/svi#sviG Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Gatheral's `g(k)` density function. The risk-neutral density implied by an SVI slice is proportional to `g(k)`, so `g(k) ≥ 0` everywhere ⇔ the slice is free of **butterfly** arbitrage. ```typescript export declare function sviG(parameters: SVIParameters, k: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): SVIParameters; default: not declared - (parameters).a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - (parameters).b: number; default: not declared — Wing slope / curvature, `≥ 0`. - (parameters).m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - (parameters).rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - (parameters).sigma: number; default: not declared — Smoothness, `> 0`. ### @insiderfinance/totalfinance/volatility/svi#sviMinG Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The minimum Gatheral `g(k)` over a log-moneyness grid (`≥ 0` ⇔ butterfly-arbitrage-free). ```typescript export declare function sviMinG(parameters: SVIParameters, grid?: number[]): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (grid)?: number[]; default: not declared - (parameters): SVIParameters; default: not declared - (parameters).a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - (parameters).b: number; default: not declared — Wing slope / curvature, `≥ 0`. - (parameters).m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - (parameters).rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - (parameters).sigma: number; default: not declared — Smoothness, `> 0`. ### @insiderfinance/totalfinance/volatility/svi#sviTotalVariance Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Total implied variance `w(k)` of a raw-SVI slice. Omitting any of the five parameters used to return `NaN` — a total variance that is not a number, handed back as a success. Downstream that becomes a `NaN` implied vol, a `NaN` price, and a quote. ```typescript export declare function sviTotalVariance(parameters: SVIParameters, k: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): SVIParameters; default: not declared - (parameters).a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - (parameters).b: number; default: not declared — Wing slope / curvature, `≥ 0`. - (parameters).m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - (parameters).rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - (parameters).sigma: number; default: not declared — Smoothness, `> 0`. ### @insiderfinance/totalfinance/volatility/svi#sviVolatility Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Implied volatility of a raw-SVI slice at log-moneyness `k` and maturity `t` (years). ```typescript export declare function sviVolatility(parameters: SVIParameters, k: number, timeToExpiryYears: number): number; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (k): number; default: not declared - (parameters): SVIParameters; default: not declared - (parameters).a: number; default: not declared — Vertical level (minimum total variance is `a + b·σ·√(1−ρ²)`). - (parameters).b: number; default: not declared — Wing slope / curvature, `≥ 0`. - (parameters).m: number; default: not declared — Horizontal shift (log-moneyness of the smile's centre). - (parameters).rho: number; default: not declared — Skew / rotation, `∈ [−1, 1]`. - (parameters).sigma: number; default: not declared — Smoothness, `> 0`. - (timeToExpiryYears): number; default: not declared ## Entrypoint @insiderfinance/totalfinance/volatility/swaption-cube ### @insiderfinance/totalfinance/volatility/swaption-cube#CalibratedSwaptionNode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#CalibratedSwaptionNode`. ### @insiderfinance/totalfinance/volatility/swaption-cube#SwaptionCube Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SwaptionCube`. ### @insiderfinance/totalfinance/volatility/swaption-cube#SwaptionCubeInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SwaptionCubeInput`. ### @insiderfinance/totalfinance/volatility/swaption-cube#SwaptionCubeNode Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SwaptionCubeNode`. ### @insiderfinance/totalfinance/volatility/swaption-cube#SwaptionCubeVolatilityQuery Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SwaptionCubeVolatilityQuery`. ### @insiderfinance/totalfinance/volatility/swaption-cube#SwaptionCubeVolatilityResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#SwaptionCubeVolatilityResult`. ### @insiderfinance/totalfinance/volatility/swaption-cube#swaptionCube Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#swaptionCube`. ### @insiderfinance/totalfinance/volatility/swaption-cube#swaptionCubeVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#swaptionCubeVolatility`. ## Entrypoint @insiderfinance/totalfinance/volatility/tail-risk ### @insiderfinance/totalfinance/volatility/tail-risk#ExpiryTailRisk Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ExpiryTailRisk`. ### @insiderfinance/totalfinance/volatility/tail-risk#TailRiskOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#TailRiskOptions`. ### @insiderfinance/totalfinance/volatility/tail-risk#TailRiskResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#TailRiskResult`. ### @insiderfinance/totalfinance/volatility/tail-risk#tailRiskIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#tailRiskIndex`. ## Entrypoint @insiderfinance/totalfinance/volatility/term ### @insiderfinance/totalfinance/volatility/term#AtmTermPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#AtmTermPoint`. ### @insiderfinance/totalfinance/volatility/term#AtmTermStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#AtmTermStructure`. ### @insiderfinance/totalfinance/volatility/term#CalendarSkewAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#CalendarSkewAssumptions`. ### @insiderfinance/totalfinance/volatility/term#CalendarSkewFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#CalendarSkewFacade`. ### @insiderfinance/totalfinance/volatility/term#ForwardSkewAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ForwardSkewAssumptions`. ### @insiderfinance/totalfinance/volatility/term#ForwardSkewFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ForwardSkewFacade`. ### @insiderfinance/totalfinance/volatility/term#ForwardVolatilityAssumptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ForwardVolatilityAssumptions`. ### @insiderfinance/totalfinance/volatility/term#ForwardVolatilityFacade Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ForwardVolatilityFacade`. ### @insiderfinance/totalfinance/volatility/term#atmTermStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#atmTermStructure`. ### @insiderfinance/totalfinance/volatility/term#calendarSkew Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calendarSkew`. ### @insiderfinance/totalfinance/volatility/term#forwardSkew Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#forwardSkew`. ### @insiderfinance/totalfinance/volatility/term#forwardVolatility Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#forwardVolatility`. ## Entrypoint @insiderfinance/totalfinance/volatility/vanna-volga ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolga5Density Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolga5Density`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolga5DensityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolga5DensityInput`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolga5Input Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolga5Input`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolga5Pillar Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolga5Pillar`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolga5Smile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolga5Smile`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolgaApproximationInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolgaApproximationInput`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolgaApproximationSmile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolgaApproximationSmile`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolgaDensity Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolgaDensity`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolgaDensityInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolgaDensityInput`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolgaInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolgaInput`. ### @insiderfinance/totalfinance/volatility/vanna-volga#VannaVolgaSmile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VannaVolgaSmile`. ### @insiderfinance/totalfinance/volatility/vanna-volga#calibrateVannaVolga Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateVannaVolga`. ### @insiderfinance/totalfinance/volatility/vanna-volga#calibrateVannaVolga5 Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#calibrateVannaVolga5`. ### @insiderfinance/totalfinance/volatility/vanna-volga#vannaVolga5Density Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The risk-neutral terminal distribution implied by the **five**-pillar vanna-volga smile (ATM + 25Δ + 10Δ RR/BF) — the {@link vannaVolgaDensity} read-out (PDF / CDF / quantiles / probability-in-range / moments), but with the core `[10Δ put, 10Δ call]` range (where most probability mass sits) pinned to real quotes instead of extrapolated from three. Builds the {@link calibrateVannaVolga5} PCHIP smile and applies **Breeden–Litzenberger** in forward space via the shared density core. The wing is extrapolated **linearly** in total variance (C¹ at the 10Δ knots, so the density stays smooth — a `flat` wing would put a spurious kink-spike in the density at the interior 10Δ knots); a down-sloping wing that drives total variance ≤ 0 on the grid is a typed error. See `docs/specs/vanna-volga-5-density.md`. ```typescript export declare function vannaVolga5Density(input: VannaVolga5DensityInput): VannaVolga5Density; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VannaVolga5DensityInput; default: not declared - (input).atmVolatility: number; default: not declared - (input).butterfly10: number; default: not declared - (input).butterfly25: number; default: not declared - (input).forward: number; default: not declared - (input).gridPoints?: number; default: not declared — Grid points for the sampled density / moments; an odd integer ≥ 11 (default 801). - (input).innerDelta?: number; default: not declared — Inner / outer wing deltas. Defaults 0.25 / 0.10. - (input).outerDelta?: number; default: not declared - (input).riskReversal10: number; default: not declared — 10-delta risk reversal and butterfly. - (input).riskReversal25: number; default: not declared — 25-delta risk reversal (`callVolatility − putVolatility`) and butterfly. - (input).step?: number; default: not declared — Central-difference step in strike for Breeden–Litzenberger (default `F·1e-3`). - (input).timeToExpiryYears: number; default: not declared - (input).widthStandardDeviations?: number; default: not declared — Grid half-width in ATM standard deviations, `F·e^{±widthStandardDeviations·σ√T}` (default 6). - return.assumptions: { conventionsVersion: string; measure: 'risk-neutral-forward'; method: 'breeden-litzenberger'; smile: 'vanna-volga-5'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.measure: 'risk-neutral-forward'; default: not declared - return.assumptions.method: 'breeden-litzenberger'; default: not declared - return.assumptions.smile: 'vanna-volga-5'; default: not declared - return.cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + ∂C/∂K` (clamped to [0, 1]). - return.density: (strike: number) => number; default: not declared — Risk-neutral (T-forward-measure) PDF at strike `K`, `∂²C/∂K²` (clamped ≥ 0). - return.diagnostics: Diagnostics; default: not declared - return.grid: { cdf: number[]; density: number[]; strikes: number[]; }; default: not declared — The sampled grid the moments and quantiles are integrated on. - return.grid.cdf: number[]; default: not declared - return.grid.density: number[]; default: not declared - return.grid.strikes: number[]; default: not declared - return.innerDelta: number; default: not declared - return.moments: { excessKurtosis: number; mean: number; skewness: number; stdev: number; totalMass: number; variance: number; }; default: not declared - return.moments.excessKurtosis: number; default: not declared - return.moments.mean: number; default: not declared — `∫K·f dK` — the risk-neutral mean, ≈ forward by the martingale property. - return.moments.skewness: number; default: not declared - return.moments.stdev: number; default: not declared - return.moments.totalMass: number; default: not declared — `∫f dK` — total captured probability mass, ≈ 1. - return.moments.variance: number; default: not declared - return.outerDelta: number; default: not declared - return.pillars: VannaVolga5Pillar[]; default: not declared — The five market pillars the underlying smile reprices exactly, low → high strike. - return.probabilityAbove: (strike: number) => number; default: not declared - return.probabilityBelow: (strike: number) => number; default: not declared - return.probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared - return.quantile: (probability: number) => number; default: not declared — Strike at CDF = `p` (inverse CDF via bisection); `p ∈ (0, 1)`. ### @insiderfinance/totalfinance/volatility/vanna-volga#vannaVolgaApproximation Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). Vanna-volga implied vol by the Castagna–Mercurio (2007) closed form — the fast, always-defined market quote, complementing the exact replication in {@link calibrateVannaVolga}. Same three pillars (via `smileFromQuotes`), which both orders reprice exactly; far-extrapolation breakdowns (a negative curvature `√`, or a vol collapsed below `MIN_VOL`) are collected and reported rather than returned as garbage. See `docs/specs/vanna-volga-approx.md`. ```typescript export declare function vannaVolgaApproximation(input: VannaVolgaApproximationInput): VannaVolgaApproximationSmile; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VannaVolgaApproximationInput; default: not declared - (input).atmVolatility: number; default: not declared — ATM vol. - (input).butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - (input).delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - (input).forward: number; default: not declared — Forward price of the underlying. - (input).order?: 1 | 2; default: not declared — Castagna–Mercurio order: `1` (a quadratic interpolation of the three volatilities in log-strike) or `2` (curvature-corrected; the accurate, market-standard form — default). - (input).riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - (input).strikes: number[]; default: not declared — Strikes to evaluate the constructed smile at. - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - return.assumptions: { conventionsVersion: string; delta: number; deltaConvention: 'forward'; method: 'castagna-mercurio'; order: 1 | 2; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.delta: number; default: not declared - return.assumptions.deltaConvention: 'forward'; default: not declared - return.assumptions.method: 'castagna-mercurio'; default: not declared - return.assumptions.order: 1 | 2; default: not declared - return.delta: number; default: not declared - return.diagnostics: Diagnostics; default: not declared - return.order: 1 | 2; default: not declared - return.pillars: { atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; putStrike: number; putVolatility: number; }; default: not declared - return.pillars.atmStrike: number; default: not declared - return.pillars.atmVolatility: number; default: not declared - return.pillars.callStrike: number; default: not declared - return.pillars.callVolatility: number; default: not declared - return.pillars.putStrike: number; default: not declared - return.pillars.putVolatility: number; default: not declared - return.strikes: number[]; default: not declared - return.volatilities: number[]; default: not declared ### @insiderfinance/totalfinance/volatility/vanna-volga#vannaVolgaDensity Kind: function; stability: stable-by-law (pre-1.0; not a 1.0 stability guarantee). The risk-neutral terminal distribution implied by the three vanna-volga quotes (ATM + δ-delta RR/BF). Builds the **Castagna–Mercurio** smile (the always-defined closed form — the exact {@link calibrateVannaVolga} breaks down across the wide strike grid a density needs) and applies **Breeden–Litzenberger** in forward space: the undiscounted forward Black call's strike derivatives are the risk-neutral density and CDF directly. Returns density/CDF/probability closures plus a sampled grid, the distribution's moments (mass ≈ 1, mean ≈ forward, variance, skewness, excess kurtosis), and an inverse CDF. A non-convex (butterfly ≤ 0) smile — where the CM curvature itself is undefined — is a typed error; a residual butterfly arbitrage (non-monotone CDF) or a grid-truncation mass/mean drift is a disclosed warning. See `docs/specs/vanna-volga-density.md`. ```typescript export declare function vannaVolgaDensity(input: VannaVolgaDensityInput): VannaVolgaDensity; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): VannaVolgaDensityInput; default: not declared - (input).atmVolatility: number; default: not declared — ATM vol. - (input).butterfly: number; default: not declared — δ-delta butterfly (`(callVolatility + putVolatility)/2 − atmVolatility`). - (input).delta?: number; default: not declared — Delta level for the pillars. Default 0.25. - (input).forward: number; default: not declared — Forward price of the underlying. - (input).gridPoints?: number; default: not declared — Grid points for the sampled density / moments; an odd integer ≥ 11 (default 801). - (input).order?: 1 | 2; default: not declared — Castagna–Mercurio order for the underlying smile: `1` or `2` (default). - (input).riskReversal: number; default: not declared — δ-delta risk reversal (`callVolatility − putVolatility`). - (input).step?: number; default: not declared — Central-difference step in strike for Breeden–Litzenberger (default `F·1e-3`). - (input).timeToExpiryYears: number; default: not declared — Time to expiry in years. - (input).widthStandardDeviations?: number; default: not declared — Grid half-width in ATM standard deviations, `F·e^{±widthStandardDeviations·σ√T}` (default 6, capturing ≈ all mass). - return.assumptions: { conventionsVersion: string; measure: 'risk-neutral-forward'; method: 'breeden-litzenberger'; order: 1 | 2; smile: 'castagna-mercurio'; }; default: not declared - return.assumptions.conventionsVersion: string; default: not declared - return.assumptions.measure: 'risk-neutral-forward'; default: not declared - return.assumptions.method: 'breeden-litzenberger'; default: not declared - return.assumptions.order: 1 | 2; default: not declared - return.assumptions.smile: 'castagna-mercurio'; default: not declared - return.cdf: (strike: number) => number; default: not declared — Risk-neutral CDF `P(S_T ≤ K) = 1 + ∂C/∂K` (clamped to [0, 1]). - return.density: (strike: number) => number; default: not declared — Risk-neutral (T-forward-measure) PDF at strike `K`, `∂²C/∂K²` (clamped ≥ 0). - return.diagnostics: Diagnostics; default: not declared - return.grid: { cdf: number[]; density: number[]; strikes: number[]; }; default: not declared — The sampled grid the moments and quantiles are integrated on. - return.grid.cdf: number[]; default: not declared - return.grid.density: number[]; default: not declared - return.grid.strikes: number[]; default: not declared - return.moments: { excessKurtosis: number; mean: number; skewness: number; stdev: number; totalMass: number; variance: number; }; default: not declared - return.moments.excessKurtosis: number; default: not declared - return.moments.mean: number; default: not declared — `∫K·f dK` — the risk-neutral mean, ≈ forward by the martingale property. - return.moments.skewness: number; default: not declared - return.moments.stdev: number; default: not declared - return.moments.totalMass: number; default: not declared — `∫f dK` — total captured probability mass, ≈ 1. - return.moments.variance: number; default: not declared - return.order: 1 | 2; default: not declared - return.pillars: { atmStrike: number; atmVolatility: number; callStrike: number; callVolatility: number; putStrike: number; putVolatility: number; }; default: not declared - return.pillars.atmStrike: number; default: not declared - return.pillars.atmVolatility: number; default: not declared - return.pillars.callStrike: number; default: not declared - return.pillars.callVolatility: number; default: not declared - return.pillars.putStrike: number; default: not declared - return.pillars.putVolatility: number; default: not declared - return.probabilityAbove: (strike: number) => number; default: not declared - return.probabilityBelow: (strike: number) => number; default: not declared - return.probabilityBetween: (lowerStrike: number, upperStrike: number) => number; default: not declared - return.quantile: (probability: number) => number; default: not declared — Strike at CDF = `p` (inverse CDF via bisection); `p ∈ (0, 1)`. ## Entrypoint @insiderfinance/totalfinance/volatility/variance-index ### @insiderfinance/totalfinance/volatility/variance-index#ExpiryVariance Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#ExpiryVariance`. ### @insiderfinance/totalfinance/volatility/variance-index#VarianceIndexOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VarianceIndexOptions`. ### @insiderfinance/totalfinance/volatility/variance-index#VarianceIndexResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VarianceIndexResult`. ### @insiderfinance/totalfinance/volatility/variance-index#VarianceRiskPremiumPoint Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VarianceRiskPremiumPoint`. ### @insiderfinance/totalfinance/volatility/variance-index#VarianceRiskPremiumTermStructureOptions Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VarianceRiskPremiumTermStructureOptions`. ### @insiderfinance/totalfinance/volatility/variance-index#VarianceRiskPremiumTermStructureResult Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VarianceRiskPremiumTermStructureResult`. ### @insiderfinance/totalfinance/volatility/variance-index#varianceIndex Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#varianceIndex`. ### @insiderfinance/totalfinance/volatility/variance-index#varianceRiskPremiumTermStructure Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#varianceRiskPremiumTermStructure`. ## Entrypoint @insiderfinance/totalfinance/volatility/volatility-spot-beta ### @insiderfinance/totalfinance/volatility/volatility-spot-beta#VolatilitySpotBeta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilitySpotBeta`. ### @insiderfinance/totalfinance/volatility/volatility-spot-beta#VolatilitySpotBetaInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#VolatilitySpotBetaInput`. ### @insiderfinance/totalfinance/volatility/volatility-spot-beta#estimateVolatilitySpotBeta Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/volatility#estimateVolatilitySpotBeta`. ## Entrypoint @insiderfinance/totalfinance/workflows ### @insiderfinance/totalfinance/workflows#ArtifactStore Kind: interface; stability: preview (pre-1.0). A writable store: `put` is idempotent by content (the same value yields the same handle). ```typescript /** A writable store: `put` is idempotent by content (the same value yields the same handle). */ export interface ArtifactStore extends ArtifactStoreReader { put(input: ArtifactStorePutInput): ResourceHandle; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - get().return.handle: ResourceHandle; default: not declared - get().return.value: Record; default: not declared - get(uri): string; default: not declared - list: (filter?: { kind?: ResourceHandleKind; }) => ResourceHandle[]; default: not declared - list(filter)?: { kind?: ResourceHandleKind; } | undefined; default: not declared - list(filter).kind?: ResourceHandleKind; default: not declared - put: (input: ArtifactStorePutInput) => ResourceHandle; default: not declared - put().return.contentHash: string | null; default: not declared - put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - put().return.kind: ResourceHandleKind; default: not declared - put().return.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - put().return.schema: string; default: not declared - put().return.uri: string; default: not declared - put().return.version: string; default: not declared - put(input): ArtifactStorePutInput; default: not declared - put(input).createdTimestampMs: number; default: not declared — Epoch ms — the caller's clock, never read by the library. - put(input).expiresTimestampMs?: number; default: not declared — Epoch ms; must be after `createdTimestampMs`. - put(input).kind: 'market' | 'portfolio' | 'report' | 'scenario' | 'authorization' | 'journal'; default: not declared - put(input).provenance?: Provenance; default: not declared - put(input).value: Record; default: not declared — The stored data — an envelope or an operation's structured result; JSON-safe by construction. ### @insiderfinance/totalfinance/workflows#ArtifactStorePutInput Kind: interface; stability: preview (pre-1.0). ```typescript // ── artifact stores ─────────────────────────────────────────────────────────────────────────── export interface ArtifactStorePutInput { /** The stored data — an envelope or an operation's structured result; JSON-safe by construction. */ value: Record; kind: Exclude; /** Epoch ms — the caller's clock, never read by the library. */ createdTimestampMs: EpochMs; /** Epoch ms; must be after `createdTimestampMs`. */ expiresTimestampMs?: EpochMs; provenance?: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - createdTimestampMs: number; default: not declared — Epoch ms — the caller's clock, never read by the library. - expiresTimestampMs?: number; default: not declared — Epoch ms; must be after `createdTimestampMs`. - kind: 'market' | 'portfolio' | 'report' | 'scenario' | 'authorization' | 'journal'; default: not declared - provenance?: Provenance; default: not declared - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - value: Record; default: not declared — The stored data — an envelope or an operation's structured result; JSON-safe by construction. ### @insiderfinance/totalfinance/workflows#ArtifactStoreReader Kind: interface; stability: preview (pre-1.0). Read access to the handles an input may reference (Decision 5); `null` when no store was supplied. ```typescript /** Read access to the handles an input may reference (Decision 5); `null` when no store was supplied. */ export interface ArtifactStoreReader { get(uri: string): { handle: ResourceHandle; value: Record; } | null; list(filter?: { kind?: ResourceHandleKind; }): ResourceHandle[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - get().return.handle: ResourceHandle; default: not declared - get().return.value: Record; default: not declared - get(uri): string; default: not declared - list: (filter?: { kind?: ResourceHandleKind; }) => ResourceHandle[]; default: not declared - list(filter)?: { kind?: ResourceHandleKind; } | undefined; default: not declared - list(filter).kind?: ResourceHandleKind; default: not declared ### @insiderfinance/totalfinance/workflows#AuthorizationStore Kind: interface; stability: preview (pre-1.0). ```typescript export interface AuthorizationStore { /** Store a grant under its content hash; idempotent (the first put stands). Returns its handle. */ put(input: { grant: AuthorizationGrant; createdTimestampMs: EpochMs; }): ResourceHandle; /** The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. */ get(hashOrUri: string): { handle: ResourceHandle; grant: AuthorizationGrant; consumed: GrantConsumption | null; } | null; /** * Atomically claim the grant with its validated write-ahead batch before journal commit. * Idempotent only for the same store, receipt, key and batch; all other claims refuse. */ consume(input: GrantConsumption & { hashOrUri: string; }): GrantConsumption; list(): ResourceHandle[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - consume: (input: GrantConsumption & { hashOrUri: string; }) => GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - consume().return.consumedTimestampMs: number; default: not declared - consume().return.idempotencyKey: string; default: not declared - consume().return.journalEvents: readonly ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - consume().return.journalId: string; default: not declared - consume().return.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - consume().return.receiptId: string; default: not declared - consume(input): GrantConsumption & { hashOrUri: string; }; default: not declared - consume(input).consumedTimestampMs: number; default: not declared - consume(input).hashOrUri: string; default: not declared - consume(input).idempotencyKey: string; default: not declared - consume(input).journalEvents: readonly ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - consume(input).journalId: string; default: not declared - consume(input).journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - consume(input).receiptId: string; default: not declared - get: (hashOrUri: string) => { handle: ResourceHandle; grant: AuthorizationGrant; consumed: GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - get().return.consumed: GrantConsumption | null; default: not declared - get().return.consumed.consumedTimestampMs: number; default: not declared - get().return.consumed.idempotencyKey: string; default: not declared - get().return.consumed.journalEvents: readonly ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - get().return.consumed.journalId: string; default: not declared - get().return.consumed.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - get().return.consumed.receiptId: string; default: not declared - get().return.grant: AuthorizationGrant; default: not declared - get().return.handle: ResourceHandle; default: not declared - get(hashOrUri): string; default: not declared - list: () => ResourceHandle[]; default: not declared - put: (input: { grant: AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - put().return.contentHash: string | null; default: not declared - put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - put().return.schema: string; default: not declared - put().return.uri: string; default: not declared - put().return.version: string; default: not declared - put(input): { createdTimestampMs: EpochMs; grant: AuthorizationGrant; }; default: not declared - put(input).createdTimestampMs: number; default: not declared - put(input).grant: AuthorizationGrant; default: not declared ### @insiderfinance/totalfinance/workflows#DEFAULT_CAPABILITIES Kind: value; stability: preview (pre-1.0). What a caller holds when it names nothing: read, analyze, propose. ```typescript export declare const DEFAULT_CAPABILITIES: readonly string[]; ``` ### @insiderfinance/totalfinance/workflows#EXECUTION_JOURNAL_STORE_CEILING Kind: value; stability: preview (pre-1.0). A journal read folds at most this many events; the store refuses to grow a journal beyond it. ```typescript export declare const EXECUTION_JOURNAL_STORE_CEILING: 100000; ``` ### @insiderfinance/totalfinance/workflows#ExecutionJournalStore Kind: interface; stability: preview (pre-1.0). ```typescript export interface ExecutionJournalStore { /** Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. */ readonly storeId: string; /** * Serialize restoration, idempotency checks, identity allocation and commit for one journal. * `execute` is synchronous and receives a detached snapshot. Its events are a newly appended * batch (possibly empty), committed before result is returned. Exceptions commit nothing. * Do not nest transactions/append on the same journal; read does not acquire another lock. */ transact(input: { journalId: string; execute: (prior: readonly ExecutionJournalEvent[]) => { events: readonly ExecutionJournalEvent[]; result: T; }; }): T; /** Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. */ append(input: { events: readonly ExecutionJournalEvent[]; }): { journalId: string; appended: number; skipped: number; total: number; }; /** Every event of a journal in append order (empty for an unknown journal). */ read(journalId: string): ExecutionJournalEvent[]; /** Every journal id, sorted. */ list(): string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - append: (input: { events: readonly ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - append().return.appended: number; default: not declared - append().return.journalId: string; default: not declared - append().return.skipped: number; default: not declared - append().return.total: number; default: not declared - append(input): { events: readonly ExecutionJournalEvent[]; }; default: not declared - append(input).events: readonly ExecutionJournalEvent[]; default: not declared - list: () => string[]; default: not declared — Every journal id, sorted. - read: (journalId: string) => ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - read(journalId): string; default: not declared - storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - transact: (input: { journalId: string; execute: (prior: readonly ExecutionJournalEvent[]) => { events: readonly ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - transact(input): { execute: (prior: readonly ExecutionJournalEvent[]) => { events: readonly ExecutionJournalEvent[]; result: T; }; journalId: string; }; default: not declared - transact(input).execute: (prior: readonly ExecutionJournalEvent[]) => { events: readonly ExecutionJournalEvent[]; result: T; }; default: not declared - transact(input).journalId: string; default: not declared ### @insiderfinance/totalfinance/workflows#GrantConsumption Kind: interface; stability: preview (pre-1.0). The one submission a grant licensed, durably prepared before its journal commit. ```typescript /** The one submission a grant licensed, durably prepared before its journal commit. */ export interface GrantConsumption { /** Opaque identity of the authoritative store, retained across file-store restarts. */ journalStoreId: string; journalId: string; receiptId: string; idempotencyKey: string; consumedTimestampMs: EpochMs; /** Write-ahead event batch: recovery replays these exact facts, never the fill engine. */ journalEvents: readonly ExecutionJournalEvent[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - consumedTimestampMs: number; default: not declared - idempotencyKey: string; default: not declared - journalEvents: readonly ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - journalId: string; default: not declared - journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - receiptId: string; default: not declared ### @insiderfinance/totalfinance/workflows#HANDLE_KINDS Kind: value; stability: preview (pre-1.0). The handle kinds, their uri namespaces, and the envelope kind a stored value of that kind carries. ```typescript export declare const HANDLE_KINDS: Readonly<{ readonly report: Readonly<{ namespace: 'reports'; envelopeKind: null; }>; readonly job: Readonly<{ namespace: 'jobs'; envelopeKind: null; }>; readonly portfolio: Readonly<{ namespace: 'portfolios'; envelopeKind: 'totalfinance.portfolio-ledger'; }>; readonly scenario: Readonly<{ namespace: 'scenarios'; envelopeKind: 'totalfinance.scenario-set'; }>; readonly market: Readonly<{ namespace: 'markets'; envelopeKind: 'totalfinance.market-snapshot'; }>; readonly authorization: Readonly<{ namespace: 'authorizations'; envelopeKind: 'totalfinance.authorization-grant'; }>; readonly journal: Readonly<{ namespace: 'journals'; envelopeKind: null; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - authorization: Readonly<{ namespace: 'authorizations'; envelopeKind: 'totalfinance.authorization-grant'; }>; default: not declared - authorization.envelopeKind: 'totalfinance.authorization-grant'; default: not declared - authorization.namespace: 'authorizations'; default: not declared - job: Readonly<{ namespace: 'jobs'; envelopeKind: null; }>; default: not declared - job.envelopeKind: null; default: not declared - job.namespace: 'jobs'; default: not declared - journal: Readonly<{ namespace: 'journals'; envelopeKind: null; }>; default: not declared - journal.envelopeKind: null; default: not declared - journal.namespace: 'journals'; default: not declared - market: Readonly<{ namespace: 'markets'; envelopeKind: 'totalfinance.market-snapshot'; }>; default: not declared - market.envelopeKind: 'totalfinance.market-snapshot'; default: not declared - market.namespace: 'markets'; default: not declared - portfolio: Readonly<{ namespace: 'portfolios'; envelopeKind: 'totalfinance.portfolio-ledger'; }>; default: not declared - portfolio.envelopeKind: 'totalfinance.portfolio-ledger'; default: not declared - portfolio.namespace: 'portfolios'; default: not declared - report: Readonly<{ namespace: 'reports'; envelopeKind: null; }>; default: not declared - report.envelopeKind: null; default: not declared - report.namespace: 'reports'; default: not declared - scenario: Readonly<{ namespace: 'scenarios'; envelopeKind: 'totalfinance.scenario-set'; }>; default: not declared - scenario.envelopeKind: 'totalfinance.scenario-set'; default: not declared - scenario.namespace: 'scenarios'; default: not declared ### @insiderfinance/totalfinance/workflows#JOB_STATES Kind: value; stability: preview (pre-1.0). ```typescript export declare const JOB_STATES: readonly JobState[]; ``` ### @insiderfinance/totalfinance/workflows#JobRecord Kind: interface; stability: preview (pre-1.0). ```typescript export interface JobRecord { id: string; operation: { id: string; version: string; }; state: JobState; progress: { stage: string; fraction: number | null; } | null; inputsHash: string; seed: number | null; submittedAt: string; startedAt: string | null; finishedAt: string | null; result: ResourceHandle | null; error: OperationError | null; usage: { elapsedMs: number | null; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - error: OperationError | null; default: not declared - error.code: string; default: not declared - error.context: Record; default: not declared - error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - error.message: string; default: not declared - error.operation: { id: string; version: string; } | null; default: not declared - error.operation.id: string; default: not declared - error.operation.version: string; default: not declared - finishedAt: string | null; default: not declared - id: string; default: not declared - inputsHash: string; default: not declared - operation: { id: string; version: string; }; default: not declared - operation.id: string; default: not declared - operation.version: string; default: not declared - progress: { fraction: number | null; stage: string; } | null; default: not declared - progress.fraction: number | null; default: not declared - progress.stage: string; default: not declared - result: ResourceHandle | null; default: not declared - result.contentHash: string | null; default: not declared - result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - result.kind: ResourceHandleKind; default: not declared - result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - result.provenance.asOf?: number; default: not declared - result.provenance.dataset?: string; default: not declared - result.provenance.provider?: string; default: not declared - result.provenance.receivedAt?: number; default: not declared - result.provenance.requestId?: string; default: not declared - result.provenance.sourceVersion?: string; default: not declared - result.provenance.warnings?: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - result.schema: string; default: not declared - result.uri: string; default: not declared - result.version: string; default: not declared - seed: number | null; default: not declared - startedAt: string | null; default: not declared - state: JobState; default: not declared - submittedAt: string; default: not declared - usage: { elapsedMs: number | null; }; default: not declared - usage.elapsedMs: number | null; default: not declared ### @insiderfinance/totalfinance/workflows#JobState Kind: type; stability: preview (pre-1.0). ```typescript // ── job stores ──────────────────────────────────────────────────────────────────────────────── export type JobState = 'accepted' | 'queued' | 'running' | 'completed' | 'failed' | 'cancelled'; ``` ### @insiderfinance/totalfinance/workflows#JobStore Kind: interface; stability: preview (pre-1.0). ```typescript export interface JobStore { create(record: JobRecord): JobRecord; update(id: string, patch: Partial>): JobRecord; get(id: string): JobRecord | null; list(): JobRecord[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - create: (record: JobRecord) => JobRecord; default: not declared - create().return.error: OperationError | null; default: not declared - create().return.error.code: string; default: not declared - create().return.error.context: Record; default: not declared - create().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - create().return.error.message: string; default: not declared - create().return.error.operation: { id: string; version: string; } | null; default: not declared - create().return.error.operation.id: string; default: not declared - create().return.error.operation.version: string; default: not declared - create().return.finishedAt: string | null; default: not declared - create().return.id: string; default: not declared - create().return.inputsHash: string; default: not declared - create().return.operation: { id: string; version: string; }; default: not declared - create().return.operation.id: string; default: not declared - create().return.operation.version: string; default: not declared - create().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - create().return.progress.fraction: number | null; default: not declared - create().return.progress.stage: string; default: not declared - create().return.result: ResourceHandle | null; default: not declared - create().return.result.contentHash: string | null; default: not declared - create().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - create().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - create().return.result.kind: ResourceHandleKind; default: not declared - create().return.result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - create().return.result.schema: string; default: not declared - create().return.result.uri: string; default: not declared - create().return.result.version: string; default: not declared - create().return.seed: number | null; default: not declared - create().return.startedAt: string | null; default: not declared - create().return.state: JobState; default: not declared - create().return.submittedAt: string; default: not declared - create().return.usage: { elapsedMs: number | null; }; default: not declared - create().return.usage.elapsedMs: number | null; default: not declared - create(record): JobRecord; default: not declared - create(record).error: OperationError | null; default: not declared - create(record).error.code: string; default: not declared - create(record).error.context: Record; default: not declared - create(record).error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - create(record).error.message: string; default: not declared - create(record).error.operation: { id: string; version: string; } | null; default: not declared - create(record).error.operation.id: string; default: not declared - create(record).error.operation.version: string; default: not declared - create(record).finishedAt: string | null; default: not declared - create(record).id: string; default: not declared - create(record).inputsHash: string; default: not declared - create(record).operation: { id: string; version: string; }; default: not declared - create(record).operation.id: string; default: not declared - create(record).operation.version: string; default: not declared - create(record).progress: { fraction: number | null; stage: string; } | null; default: not declared - create(record).progress.fraction: number | null; default: not declared - create(record).progress.stage: string; default: not declared - create(record).result: ResourceHandle | null; default: not declared - create(record).result.contentHash: string | null; default: not declared - create(record).result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - create(record).result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - create(record).result.kind: ResourceHandleKind; default: not declared - create(record).result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - create(record).result.schema: string; default: not declared - create(record).result.uri: string; default: not declared - create(record).result.version: string; default: not declared - create(record).seed: number | null; default: not declared - create(record).startedAt: string | null; default: not declared - create(record).state: JobState; default: not declared - create(record).submittedAt: string; default: not declared - create(record).usage: { elapsedMs: number | null; }; default: not declared - create(record).usage.elapsedMs: number | null; default: not declared - get: (id: string) => JobRecord | null; default: not declared - get().return.error: OperationError | null; default: not declared - get().return.error.code: string; default: not declared - get().return.error.context: Record; default: not declared - get().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - get().return.error.message: string; default: not declared - get().return.error.operation: { id: string; version: string; } | null; default: not declared - get().return.error.operation.id: string; default: not declared - get().return.error.operation.version: string; default: not declared - get().return.finishedAt: string | null; default: not declared - get().return.id: string; default: not declared - get().return.inputsHash: string; default: not declared - get().return.operation: { id: string; version: string; }; default: not declared - get().return.operation.id: string; default: not declared - get().return.operation.version: string; default: not declared - get().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - get().return.progress.fraction: number | null; default: not declared - get().return.progress.stage: string; default: not declared - get().return.result: ResourceHandle | null; default: not declared - get().return.result.contentHash: string | null; default: not declared - get().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - get().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - get().return.result.kind: ResourceHandleKind; default: not declared - get().return.result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - get().return.result.schema: string; default: not declared - get().return.result.uri: string; default: not declared - get().return.result.version: string; default: not declared - get().return.seed: number | null; default: not declared - get().return.startedAt: string | null; default: not declared - get().return.state: JobState; default: not declared - get().return.submittedAt: string; default: not declared - get().return.usage: { elapsedMs: number | null; }; default: not declared - get().return.usage.elapsedMs: number | null; default: not declared - get(id): string; default: not declared - list: () => JobRecord[]; default: not declared - update: (id: string, patch: Partial>) => JobRecord; default: not declared - update().return.error: OperationError | null; default: not declared - update().return.error.code: string; default: not declared - update().return.error.context: Record; default: not declared - update().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - update().return.error.message: string; default: not declared - update().return.error.operation: { id: string; version: string; } | null; default: not declared - update().return.error.operation.id: string; default: not declared - update().return.error.operation.version: string; default: not declared - update().return.finishedAt: string | null; default: not declared - update().return.id: string; default: not declared - update().return.inputsHash: string; default: not declared - update().return.operation: { id: string; version: string; }; default: not declared - update().return.operation.id: string; default: not declared - update().return.operation.version: string; default: not declared - update().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - update().return.progress.fraction: number | null; default: not declared - update().return.progress.stage: string; default: not declared - update().return.result: ResourceHandle | null; default: not declared - update().return.result.contentHash: string | null; default: not declared - update().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - update().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - update().return.result.kind: ResourceHandleKind; default: not declared - update().return.result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - update().return.result.schema: string; default: not declared - update().return.result.uri: string; default: not declared - update().return.result.version: string; default: not declared - update().return.seed: number | null; default: not declared - update().return.startedAt: string | null; default: not declared - update().return.state: JobState; default: not declared - update().return.submittedAt: string; default: not declared - update().return.usage: { elapsedMs: number | null; }; default: not declared - update().return.usage.elapsedMs: number | null; default: not declared - update(id): string; default: not declared - update(patch): Partial>; default: not declared - update(patch).error?: OperationError | null; default: not declared - update(patch).error.code: string; default: not declared - update(patch).error.context: Record; default: not declared - update(patch).error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - update(patch).error.message: string; default: not declared - update(patch).error.operation: { id: string; version: string; } | null; default: not declared - update(patch).error.operation.id: string; default: not declared - update(patch).error.operation.version: string; default: not declared - update(patch).finishedAt?: string | null; default: not declared - update(patch).inputsHash?: string; default: not declared - update(patch).operation?: { id: string; version: string; }; default: not declared - update(patch).operation.id: string; default: not declared - update(patch).operation.version: string; default: not declared - update(patch).progress?: { fraction: number | null; stage: string; } | null; default: not declared - update(patch).progress.fraction: number | null; default: not declared - update(patch).progress.stage: string; default: not declared - update(patch).result?: ResourceHandle | null; default: not declared - update(patch).result.contentHash: string | null; default: not declared - update(patch).result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - update(patch).result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - update(patch).result.kind: ResourceHandleKind; default: not declared - update(patch).result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - update(patch).result.schema: string; default: not declared - update(patch).result.uri: string; default: not declared - update(patch).result.version: string; default: not declared - update(patch).seed?: number | null; default: not declared - update(patch).startedAt?: string | null; default: not declared - update(patch).state?: JobState; default: not declared - update(patch).submittedAt?: string; default: not declared - update(patch).usage?: { elapsedMs: number | null; }; default: not declared - update(patch).usage.elapsedMs: number | null; default: not declared ### @insiderfinance/totalfinance/workflows#KNOWN_CAPABILITIES Kind: value; stability: preview (pre-1.0). The capabilities this stage names; a runtime may grant others (the registry does not enumerate them). ```typescript export declare const KNOWN_CAPABILITIES: readonly string[]; ``` ### @insiderfinance/totalfinance/workflows#MAX_ROWS Kind: value; stability: preview (pre-1.0). ```typescript export declare const MAX_ROWS: 5000; ``` ### @insiderfinance/totalfinance/workflows#OPERATION_BUDGETS Kind: value; stability: preview (pre-1.0). ```typescript export declare const OPERATION_BUDGETS: Readonly<{ maxInputBytes: Readonly<{ transportDefault: 65536; maximum: 16777216; }>; inlineResultBytes: Readonly<{ default: 262144; maximum: 16777216; }>; }>; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - inlineResultBytes: Readonly<{ default: 262144; maximum: 16777216; }>; default: not declared — Canonical bytes of a structured result above which, when a WRITABLE artifact store is supplied, the result is stored and the response carries its handle with a bounded preview — never a silent truncation (Decision 5). - inlineResultBytes.default: 262144; default: not declared - inlineResultBytes.maximum: 16777216; default: not declared - maxInputBytes: Readonly<{ transportDefault: 65536; maximum: 16777216; }>; default: not declared — Serialized input bytes a call may carry (UTF-8, measured on the raw request). A WIRE budget: a transport always passes one (the MCP server's default is 64 KiB); an in-process run that omits it is bounded by the operation's own row caps instead. - maxInputBytes.maximum: 16777216; default: not declared - maxInputBytes.transportDefault: 65536; default: not declared ### @insiderfinance/totalfinance/workflows#OPERATION_ID Kind: value; stability: preview (pre-1.0). ```typescript export declare const OPERATION_ID: RegExp; ``` ### @insiderfinance/totalfinance/workflows#OperationAnnotations Kind: interface; stability: preview (pre-1.0). What a transport advertises about an operation's behaviour — DERIVED from its effect metadata, never authored. ```typescript /** What a transport advertises about an operation's behaviour — DERIVED from its effect metadata, never authored. */ export interface OperationAnnotations { readOnlyHint: boolean; destructiveHint: boolean; idempotentHint: boolean; openWorldHint: boolean; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - destructiveHint: boolean; default: not declared - idempotentHint: boolean; default: not declared - openWorldHint: boolean; default: not declared - readOnlyHint: boolean; default: not declared ### @insiderfinance/totalfinance/workflows#OperationAuthorization Kind: type; stability: preview (pre-1.0). ```typescript export type OperationAuthorization = 'none' | 'policy' | 'human'; ``` ### @insiderfinance/totalfinance/workflows#OperationContext Kind: interface; stability: preview (pre-1.0). ```typescript export interface OperationContext { /** The resolved seed for a stochastic call (the seed policy injects the default when absent); `null` for a deterministic call. */ seed: number | null; budgets: { maxInputBytes: number | null; deadlineMs: number | null; }; /** Cooperative cancellation for job-class operations; `null` for an inline run. */ signal: OperationSignal | null; artifacts: ArtifactStoreReader | null; /** What the caller holds (Stage 7B.2 Decision 9); the runtime refused the call already when a required one is missing. */ capabilities: readonly string[]; /** The trade lifecycle's stores (Decision 10), explicit parameters of the runtime — never session state. */ stores: { authorization: AuthorizationStore | null; journal: ExecutionJournalStore | null; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts: ArtifactStoreReader | null; default: not declared - artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - artifacts.get().return.handle: ResourceHandle; default: not declared - artifacts.get().return.value: Record; default: not declared - artifacts.get(uri): string; default: not declared - artifacts.list: (filter?: { kind?: ResourceHandleKind; }) => ResourceHandle[]; default: not declared - artifacts.list(filter)?: { kind?: ResourceHandleKind; } | undefined; default: not declared - artifacts.list(filter).kind?: ResourceHandleKind; default: not declared - budgets: { maxInputBytes: number | null; deadlineMs: number | null; }; default: not declared - budgets.deadlineMs: number | null; default: not declared - budgets.maxInputBytes: number | null; default: not declared - capabilities: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); the runtime refused the call already when a required one is missing. - seed: number | null; default: not declared — The resolved seed for a stochastic call (the seed policy injects the default when absent); `null` for a deterministic call. - signal: OperationSignal | null; default: not declared — Cooperative cancellation for job-class operations; `null` for an inline run. - signal.aborted: boolean; default: not declared - signal.reason?: unknown; default: not declared - stores: { authorization: AuthorizationStore | null; journal: ExecutionJournalStore | null; }; default: not declared — The trade lifecycle's stores (Decision 10), explicit parameters of the runtime — never session state. - stores.authorization: AuthorizationStore | null; default: not declared - stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - stores.authorization.consume().return.consumedTimestampMs: number; default: not declared - stores.authorization.consume().return.idempotencyKey: string; default: not declared - stores.authorization.consume().return.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume().return.journalId: string; default: not declared - stores.authorization.consume().return.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume().return.receiptId: string; default: not declared - stores.authorization.consume(input): import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }; default: not declared - stores.authorization.consume(input).consumedTimestampMs: number; default: not declared - stores.authorization.consume(input).hashOrUri: string; default: not declared - stores.authorization.consume(input).idempotencyKey: string; default: not declared - stores.authorization.consume(input).journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume(input).journalId: string; default: not declared - stores.authorization.consume(input).journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume(input).receiptId: string; default: not declared - stores.authorization.get: (hashOrUri: string) => { handle: ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - stores.authorization.get().return.consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; default: not declared - stores.authorization.get().return.consumed.consumedTimestampMs: number; default: not declared - stores.authorization.get().return.consumed.idempotencyKey: string; default: not declared - stores.authorization.get().return.consumed.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.get().return.consumed.journalId: string; default: not declared - stores.authorization.get().return.consumed.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.get().return.consumed.receiptId: string; default: not declared - stores.authorization.get().return.grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.authorization.get().return.handle: ResourceHandle; default: not declared - stores.authorization.get(hashOrUri): string; default: not declared - stores.authorization.list: () => ResourceHandle[]; default: not declared - stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - stores.authorization.put().return.contentHash: string | null; default: not declared - stores.authorization.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - stores.authorization.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - stores.authorization.put().return.kind: ResourceHandleKind; default: not declared - stores.authorization.put().return.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - stores.authorization.put().return.schema: string; default: not declared - stores.authorization.put().return.uri: string; default: not declared - stores.authorization.put().return.version: string; default: not declared - stores.authorization.put(input): { createdTimestampMs: EpochMs; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; }; default: not declared - stores.authorization.put(input).createdTimestampMs: number; default: not declared - stores.authorization.put(input).grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.journal: ExecutionJournalStore | null; default: not declared - stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - stores.journal.append().return.appended: number; default: not declared - stores.journal.append().return.journalId: string; default: not declared - stores.journal.append().return.skipped: number; default: not declared - stores.journal.append().return.total: number; default: not declared - stores.journal.append(input): { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }; default: not declared - stores.journal.append(input).events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared - stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - stores.journal.read(journalId): string; default: not declared - stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - stores.journal.transact(input): { execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; journalId: string; }; default: not declared - stores.journal.transact(input).execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; default: not declared - stores.journal.transact(input).journalId: string; default: not declared ### @insiderfinance/totalfinance/workflows#OperationCostClass Kind: type; stability: preview (pre-1.0). ```typescript export type OperationCostClass = 'small' | 'medium' | 'large' | 'job'; ``` ### @insiderfinance/totalfinance/workflows#OperationDescription Kind: interface; stability: preview (pre-1.0). The transport-neutral description every adapter renders. ```typescript /** The transport-neutral description every adapter renders. */ export interface OperationDescription { id: string; version: string; title: string; description: string; inputSchema: JSONSchema; outputSchema: JSONSchema | null; sideEffect: OperationSideEffect; authorization: OperationAuthorization; idempotency: OperationIdempotency; deterministic: boolean; stochastic: boolean | 'per-call'; costClass: OperationCostClass; requiredCapabilities: string[]; supportsCancellation: boolean; handleFields: string[]; annotations: OperationAnnotations; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - annotations: OperationAnnotations; default: not declared - annotations.destructiveHint: boolean; default: not declared - annotations.idempotentHint: boolean; default: not declared - annotations.openWorldHint: boolean; default: not declared - annotations.readOnlyHint: boolean; default: not declared - authorization: OperationAuthorization; default: not declared - costClass: OperationCostClass; default: not declared - description: string; default: not declared - deterministic: boolean; default: not declared - handleFields: string[]; default: not declared - id: string; default: not declared - idempotency: OperationIdempotency; default: not declared - inputSchema: JSONSchema; default: not declared - inputSchema.$id?: string; default: not declared - inputSchema.$schema?: string; default: not declared - inputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - inputSchema.additionalProperties.$id?: string; default: not declared - inputSchema.additionalProperties.$schema?: string; default: not declared - inputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - inputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - inputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - inputSchema.additionalProperties.const?: unknown; default: not declared - inputSchema.additionalProperties.default?: unknown; default: not declared - inputSchema.additionalProperties.description?: string; default: not declared - inputSchema.additionalProperties.enum?: unknown[]; default: not declared - inputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - inputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - inputSchema.additionalProperties.format?: string; default: not declared - inputSchema.additionalProperties.items?: JSONSchema; default: not declared - inputSchema.additionalProperties.maxItems?: number; default: not declared - inputSchema.additionalProperties.maxLength?: number; default: not declared - inputSchema.additionalProperties.maximum?: number; default: not declared - inputSchema.additionalProperties.minItems?: number; default: not declared - inputSchema.additionalProperties.minLength?: number; default: not declared - inputSchema.additionalProperties.minimum?: number; default: not declared - inputSchema.additionalProperties.multipleOf?: number; default: not declared - inputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - inputSchema.additionalProperties.pattern?: string; default: not declared - inputSchema.additionalProperties.properties?: Record; default: not declared - inputSchema.additionalProperties.required?: string[]; default: not declared - inputSchema.additionalProperties.title?: string; default: not declared - inputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - inputSchema.allOf?: JSONSchema[]; default: not declared - inputSchema.anyOf?: JSONSchema[]; default: not declared - inputSchema.const?: unknown; default: not declared - inputSchema.default?: unknown; default: not declared - inputSchema.description?: string; default: not declared - inputSchema.enum?: unknown[]; default: not declared - inputSchema.exclusiveMaximum?: number; default: not declared - inputSchema.exclusiveMinimum?: number; default: not declared - inputSchema.format?: string; default: not declared - inputSchema.items?: JSONSchema; default: not declared - inputSchema.maxItems?: number; default: not declared - inputSchema.maxLength?: number; default: not declared - inputSchema.maximum?: number; default: not declared - inputSchema.minItems?: number; default: not declared - inputSchema.minLength?: number; default: not declared - inputSchema.minimum?: number; default: not declared - inputSchema.multipleOf?: number; default: not declared - inputSchema.oneOf?: JSONSchema[]; default: not declared - inputSchema.pattern?: string; default: not declared - inputSchema.properties?: Record; default: not declared - inputSchema.required?: string[]; default: not declared - inputSchema.title?: string; default: not declared - inputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema: JSONSchema | null; default: not declared - outputSchema.$id?: string; default: not declared - outputSchema.$schema?: string; default: not declared - outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.$id?: string; default: not declared - outputSchema.additionalProperties.$schema?: string; default: not declared - outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.const?: unknown; default: not declared - outputSchema.additionalProperties.default?: unknown; default: not declared - outputSchema.additionalProperties.description?: string; default: not declared - outputSchema.additionalProperties.enum?: unknown[]; default: not declared - outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - outputSchema.additionalProperties.format?: string; default: not declared - outputSchema.additionalProperties.items?: JSONSchema; default: not declared - outputSchema.additionalProperties.items.$id?: string; default: not declared - outputSchema.additionalProperties.items.$schema?: string; default: not declared - outputSchema.additionalProperties.items.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.items.allOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.items.anyOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.items.const?: unknown; default: not declared - outputSchema.additionalProperties.items.default?: unknown; default: not declared - outputSchema.additionalProperties.items.description?: string; default: not declared - outputSchema.additionalProperties.items.enum?: unknown[]; default: not declared - outputSchema.additionalProperties.items.exclusiveMaximum?: number; default: not declared - outputSchema.additionalProperties.items.exclusiveMinimum?: number; default: not declared - outputSchema.additionalProperties.items.format?: string; default: not declared - outputSchema.additionalProperties.items.items?: JSONSchema; default: not declared - outputSchema.additionalProperties.items.maxItems?: number; default: not declared - outputSchema.additionalProperties.items.maxLength?: number; default: not declared - outputSchema.additionalProperties.items.maximum?: number; default: not declared - outputSchema.additionalProperties.items.minItems?: number; default: not declared - outputSchema.additionalProperties.items.minLength?: number; default: not declared - outputSchema.additionalProperties.items.minimum?: number; default: not declared - outputSchema.additionalProperties.items.multipleOf?: number; default: not declared - outputSchema.additionalProperties.items.oneOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.items.pattern?: string; default: not declared - outputSchema.additionalProperties.items.properties?: Record; default: not declared - outputSchema.additionalProperties.items.required?: string[]; default: not declared - outputSchema.additionalProperties.items.title?: string; default: not declared - outputSchema.additionalProperties.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.additionalProperties.maxItems?: number; default: not declared - outputSchema.additionalProperties.maxLength?: number; default: not declared - outputSchema.additionalProperties.maximum?: number; default: not declared - outputSchema.additionalProperties.minItems?: number; default: not declared - outputSchema.additionalProperties.minLength?: number; default: not declared - outputSchema.additionalProperties.minimum?: number; default: not declared - outputSchema.additionalProperties.multipleOf?: number; default: not declared - outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.pattern?: string; default: not declared - outputSchema.additionalProperties.properties?: Record; default: not declared - outputSchema.additionalProperties.required?: string[]; default: not declared - outputSchema.additionalProperties.title?: string; default: not declared - outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.allOf?: JSONSchema[]; default: not declared - outputSchema.anyOf?: JSONSchema[]; default: not declared - outputSchema.const?: unknown; default: not declared - outputSchema.default?: unknown; default: not declared - outputSchema.description?: string; default: not declared - outputSchema.enum?: unknown[]; default: not declared - outputSchema.exclusiveMaximum?: number; default: not declared - outputSchema.exclusiveMinimum?: number; default: not declared - outputSchema.format?: string; default: not declared - outputSchema.items?: JSONSchema; default: not declared - outputSchema.items.$id?: string; default: not declared - outputSchema.items.$schema?: string; default: not declared - outputSchema.items.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.items.additionalProperties.$id?: string; default: not declared - outputSchema.items.additionalProperties.$schema?: string; default: not declared - outputSchema.items.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.items.additionalProperties.allOf?: JSONSchema[]; default: not declared - outputSchema.items.additionalProperties.anyOf?: JSONSchema[]; default: not declared - outputSchema.items.additionalProperties.const?: unknown; default: not declared - outputSchema.items.additionalProperties.default?: unknown; default: not declared - outputSchema.items.additionalProperties.description?: string; default: not declared - outputSchema.items.additionalProperties.enum?: unknown[]; default: not declared - outputSchema.items.additionalProperties.exclusiveMaximum?: number; default: not declared - outputSchema.items.additionalProperties.exclusiveMinimum?: number; default: not declared - outputSchema.items.additionalProperties.format?: string; default: not declared - outputSchema.items.additionalProperties.items?: JSONSchema; default: not declared - outputSchema.items.additionalProperties.maxItems?: number; default: not declared - outputSchema.items.additionalProperties.maxLength?: number; default: not declared - outputSchema.items.additionalProperties.maximum?: number; default: not declared - outputSchema.items.additionalProperties.minItems?: number; default: not declared - outputSchema.items.additionalProperties.minLength?: number; default: not declared - outputSchema.items.additionalProperties.minimum?: number; default: not declared - outputSchema.items.additionalProperties.multipleOf?: number; default: not declared - outputSchema.items.additionalProperties.oneOf?: JSONSchema[]; default: not declared - outputSchema.items.additionalProperties.pattern?: string; default: not declared - outputSchema.items.additionalProperties.properties?: Record; default: not declared - outputSchema.items.additionalProperties.required?: string[]; default: not declared - outputSchema.items.additionalProperties.title?: string; default: not declared - outputSchema.items.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.items.allOf?: JSONSchema[]; default: not declared - outputSchema.items.anyOf?: JSONSchema[]; default: not declared - outputSchema.items.const?: unknown; default: not declared - outputSchema.items.default?: unknown; default: not declared - outputSchema.items.description?: string; default: not declared - outputSchema.items.enum?: unknown[]; default: not declared - outputSchema.items.exclusiveMaximum?: number; default: not declared - outputSchema.items.exclusiveMinimum?: number; default: not declared - outputSchema.items.format?: string; default: not declared - outputSchema.items.items?: JSONSchema; default: not declared - outputSchema.items.maxItems?: number; default: not declared - outputSchema.items.maxLength?: number; default: not declared - outputSchema.items.maximum?: number; default: not declared - outputSchema.items.minItems?: number; default: not declared - outputSchema.items.minLength?: number; default: not declared - outputSchema.items.minimum?: number; default: not declared - outputSchema.items.multipleOf?: number; default: not declared - outputSchema.items.oneOf?: JSONSchema[]; default: not declared - outputSchema.items.pattern?: string; default: not declared - outputSchema.items.properties?: Record; default: not declared - outputSchema.items.required?: string[]; default: not declared - outputSchema.items.title?: string; default: not declared - outputSchema.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.maxItems?: number; default: not declared - outputSchema.maxLength?: number; default: not declared - outputSchema.maximum?: number; default: not declared - outputSchema.minItems?: number; default: not declared - outputSchema.minLength?: number; default: not declared - outputSchema.minimum?: number; default: not declared - outputSchema.multipleOf?: number; default: not declared - outputSchema.oneOf?: JSONSchema[]; default: not declared - outputSchema.pattern?: string; default: not declared - outputSchema.properties?: Record; default: not declared - outputSchema.required?: string[]; default: not declared - outputSchema.title?: string; default: not declared - outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - requiredCapabilities: string[]; default: not declared - sideEffect: OperationSideEffect; default: not declared - stochastic: boolean | 'per-call'; default: not declared - supportsCancellation: boolean; default: not declared - title: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/workflows#OperationError Kind: interface; stability: preview (pre-1.0). The one error shape every transport maps: the QuantError code, or a runtime code. ```typescript /** The one error shape every transport maps: the QuantError code, or a runtime code. */ export interface OperationError { code: string; message: string; context: Record; issues?: SchemaIssue[]; operation: { id: string; version: string; } | null; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - code: string; default: not declared - context: Record; default: not declared - issues?: SchemaIssue[]; default: not declared - message: string; default: not declared - operation: { id: string; version: string; } | null; default: not declared - operation.id: string; default: not declared - operation.version: string; default: not declared ### @insiderfinance/totalfinance/workflows#OperationIdempotency Kind: type; stability: preview (pre-1.0). ```typescript export type OperationIdempotency = 'not-applicable' | 'optional' | 'required'; ``` ### @insiderfinance/totalfinance/workflows#OperationOutput Kind: interface; stability: preview (pre-1.0). What an operation returns — the runtime completes it into an {@link OperationResult}. ```typescript /** What an operation returns — the runtime completes it into an {@link OperationResult}. */ export interface OperationOutput> { /** Human-readable one-line summary. */ summary: string; /** Machine-readable structured output (validated against `outputSchema` in the parity fixtures). */ structured: Output; artifacts?: ResourceHandle[]; status?: 'complete' | 'partial'; incomplete?: string[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts?: ResourceHandle[]; default: not declared - incomplete?: string[]; default: not declared - status?: 'complete' | 'partial'; default: not declared - structured: Output; default: not declared — Machine-readable structured output (validated against `outputSchema` in the parity fixtures). - summary: string; default: not declared — Human-readable one-line summary. ### @insiderfinance/totalfinance/workflows#OperationPack Kind: interface; stability: preview (pre-1.0). ```typescript export interface OperationPack { name: string; operations: TotalFinanceOperation[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#OperationRegistry Kind: interface; stability: preview (pre-1.0). ```typescript export interface OperationRegistry { list(): OperationDescription[]; get(id: string): TotalFinanceOperation | null; /** The operation, or a typed refusal naming the closest id. */ require(id: string): TotalFinanceOperation; describe(id: string): OperationDescription; /** Run one registered operation: `{ id, input, ...runtime options }` — one closed request. */ run(request: { id: string; input: unknown; } & RunOperationOptions): OperationResult; packs(): OperationPack[]; readonly size: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - describe: (id: string) => OperationDescription; default: not declared - describe().return.annotations: import('@insiderfinance/totalfinance/workflows').OperationAnnotations; default: not declared - describe().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - describe().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - describe().return.description: string; default: not declared - describe().return.deterministic: boolean; default: not declared - describe().return.handleFields: string[]; default: not declared - describe().return.id: string; default: not declared - describe().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - describe().return.inputSchema: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - describe().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - describe().return.outputSchema.$id?: string; default: not declared - describe().return.outputSchema.$schema?: string; default: not declared - describe().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - describe().return.outputSchema.additionalProperties.$id?: string; default: not declared - describe().return.outputSchema.additionalProperties.$schema?: string; default: not declared - describe().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - describe().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - describe().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - describe().return.outputSchema.additionalProperties.const?: unknown; default: not declared - describe().return.outputSchema.additionalProperties.default?: unknown; default: not declared - describe().return.outputSchema.additionalProperties.description?: string; default: not declared - describe().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - describe().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - describe().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - describe().return.outputSchema.additionalProperties.format?: string; default: not declared - describe().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - describe().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - describe().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - describe().return.outputSchema.additionalProperties.maximum?: number; default: not declared - describe().return.outputSchema.additionalProperties.minItems?: number; default: not declared - describe().return.outputSchema.additionalProperties.minLength?: number; default: not declared - describe().return.outputSchema.additionalProperties.minimum?: number; default: not declared - describe().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - describe().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - describe().return.outputSchema.additionalProperties.pattern?: string; default: not declared - describe().return.outputSchema.additionalProperties.properties?: Record; default: not declared - describe().return.outputSchema.additionalProperties.required?: string[]; default: not declared - describe().return.outputSchema.additionalProperties.title?: string; default: not declared - describe().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - describe().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - describe().return.outputSchema.const?: unknown; default: not declared - describe().return.outputSchema.default?: unknown; default: not declared - describe().return.outputSchema.description?: string; default: not declared - describe().return.outputSchema.enum?: unknown[]; default: not declared - describe().return.outputSchema.exclusiveMaximum?: number; default: not declared - describe().return.outputSchema.exclusiveMinimum?: number; default: not declared - describe().return.outputSchema.format?: string; default: not declared - describe().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - describe().return.outputSchema.maxItems?: number; default: not declared - describe().return.outputSchema.maxLength?: number; default: not declared - describe().return.outputSchema.maximum?: number; default: not declared - describe().return.outputSchema.minItems?: number; default: not declared - describe().return.outputSchema.minLength?: number; default: not declared - describe().return.outputSchema.minimum?: number; default: not declared - describe().return.outputSchema.multipleOf?: number; default: not declared - describe().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - describe().return.outputSchema.pattern?: string; default: not declared - describe().return.outputSchema.properties?: Record; default: not declared - describe().return.outputSchema.required?: string[]; default: not declared - describe().return.outputSchema.title?: string; default: not declared - describe().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - describe().return.requiredCapabilities: string[]; default: not declared - describe().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - describe().return.stochastic: boolean | 'per-call'; default: not declared - describe().return.supportsCancellation: boolean; default: not declared - describe().return.title: string; default: not declared - describe().return.version: string; default: not declared - describe(id): string; default: not declared - get: (id: string) => TotalFinanceOperation | null; default: not declared - get().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - get().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - get().return.description: string; default: not declared - get().return.deterministic: boolean; default: not declared - get().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - get().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - get().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - get().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - get().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - get().return.outputSchema.$id?: string; default: not declared - get().return.outputSchema.$schema?: string; default: not declared - get().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - get().return.outputSchema.additionalProperties.$id?: string; default: not declared - get().return.outputSchema.additionalProperties.$schema?: string; default: not declared - get().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - get().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - get().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - get().return.outputSchema.additionalProperties.const?: unknown; default: not declared - get().return.outputSchema.additionalProperties.default?: unknown; default: not declared - get().return.outputSchema.additionalProperties.description?: string; default: not declared - get().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - get().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - get().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - get().return.outputSchema.additionalProperties.format?: string; default: not declared - get().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - get().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - get().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - get().return.outputSchema.additionalProperties.maximum?: number; default: not declared - get().return.outputSchema.additionalProperties.minItems?: number; default: not declared - get().return.outputSchema.additionalProperties.minLength?: number; default: not declared - get().return.outputSchema.additionalProperties.minimum?: number; default: not declared - get().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - get().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - get().return.outputSchema.additionalProperties.pattern?: string; default: not declared - get().return.outputSchema.additionalProperties.properties?: Record; default: not declared - get().return.outputSchema.additionalProperties.required?: string[]; default: not declared - get().return.outputSchema.additionalProperties.title?: string; default: not declared - get().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - get().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - get().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - get().return.outputSchema.const?: unknown; default: not declared - get().return.outputSchema.default?: unknown; default: not declared - get().return.outputSchema.description?: string; default: not declared - get().return.outputSchema.enum?: unknown[]; default: not declared - get().return.outputSchema.exclusiveMaximum?: number; default: not declared - get().return.outputSchema.exclusiveMinimum?: number; default: not declared - get().return.outputSchema.format?: string; default: not declared - get().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - get().return.outputSchema.maxItems?: number; default: not declared - get().return.outputSchema.maxLength?: number; default: not declared - get().return.outputSchema.maximum?: number; default: not declared - get().return.outputSchema.minItems?: number; default: not declared - get().return.outputSchema.minLength?: number; default: not declared - get().return.outputSchema.minimum?: number; default: not declared - get().return.outputSchema.multipleOf?: number; default: not declared - get().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - get().return.outputSchema.pattern?: string; default: not declared - get().return.outputSchema.properties?: Record; default: not declared - get().return.outputSchema.required?: string[]; default: not declared - get().return.outputSchema.title?: string; default: not declared - get().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - get().return.requiredCapabilities: readonly string[]; default: not declared - get().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - get().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - get().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - get().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - get().return.title: string; default: not declared - get().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - get(id): string; default: not declared - list: () => OperationDescription[]; default: not declared - packs: () => OperationPack[]; default: not declared - require: (id: string) => TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - require().return.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - require().return.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - require().return.description: string; default: not declared - require().return.deterministic: boolean; default: not declared - require().return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - require().return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - require().return.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - require().return.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - require().return.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - require().return.outputSchema.$id?: string; default: not declared - require().return.outputSchema.$schema?: string; default: not declared - require().return.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - require().return.outputSchema.additionalProperties.$id?: string; default: not declared - require().return.outputSchema.additionalProperties.$schema?: string; default: not declared - require().return.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - require().return.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - require().return.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - require().return.outputSchema.additionalProperties.const?: unknown; default: not declared - require().return.outputSchema.additionalProperties.default?: unknown; default: not declared - require().return.outputSchema.additionalProperties.description?: string; default: not declared - require().return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - require().return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - require().return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - require().return.outputSchema.additionalProperties.format?: string; default: not declared - require().return.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - require().return.outputSchema.additionalProperties.maxItems?: number; default: not declared - require().return.outputSchema.additionalProperties.maxLength?: number; default: not declared - require().return.outputSchema.additionalProperties.maximum?: number; default: not declared - require().return.outputSchema.additionalProperties.minItems?: number; default: not declared - require().return.outputSchema.additionalProperties.minLength?: number; default: not declared - require().return.outputSchema.additionalProperties.minimum?: number; default: not declared - require().return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - require().return.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - require().return.outputSchema.additionalProperties.pattern?: string; default: not declared - require().return.outputSchema.additionalProperties.properties?: Record; default: not declared - require().return.outputSchema.additionalProperties.required?: string[]; default: not declared - require().return.outputSchema.additionalProperties.title?: string; default: not declared - require().return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - require().return.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - require().return.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - require().return.outputSchema.const?: unknown; default: not declared - require().return.outputSchema.default?: unknown; default: not declared - require().return.outputSchema.description?: string; default: not declared - require().return.outputSchema.enum?: unknown[]; default: not declared - require().return.outputSchema.exclusiveMaximum?: number; default: not declared - require().return.outputSchema.exclusiveMinimum?: number; default: not declared - require().return.outputSchema.format?: string; default: not declared - require().return.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - require().return.outputSchema.maxItems?: number; default: not declared - require().return.outputSchema.maxLength?: number; default: not declared - require().return.outputSchema.maximum?: number; default: not declared - require().return.outputSchema.minItems?: number; default: not declared - require().return.outputSchema.minLength?: number; default: not declared - require().return.outputSchema.minimum?: number; default: not declared - require().return.outputSchema.multipleOf?: number; default: not declared - require().return.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - require().return.outputSchema.pattern?: string; default: not declared - require().return.outputSchema.properties?: Record; default: not declared - require().return.outputSchema.required?: string[]; default: not declared - require().return.outputSchema.title?: string; default: not declared - require().return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - require().return.requiredCapabilities: readonly string[]; default: not declared - require().return.run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - require().return.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - require().return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - require().return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - require().return.title: string; default: not declared - require().return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - require(id): string; default: not declared - run: (request: { id: string; input: unknown; } & RunOperationOptions) => OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - run().return.artifacts: import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - run().return.assumptions: Record; default: not declared - run().return.diagnostics: { incomplete: string[]; status: 'complete' | 'partial'; warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; }; default: not declared - run().return.diagnostics.incomplete: string[]; default: not declared - run().return.diagnostics.status: 'complete' | 'partial'; default: not declared - run().return.diagnostics.warnings: import('@insiderfinance/totalfinance/core').QuantWarning[]; default: not declared - run().return.identity: { artifactIds: string[]; inputsHash: string; snapshotHash: string | null; }; default: not declared - run().return.identity.artifactIds: string[]; default: not declared - run().return.identity.inputsHash: string; default: not declared - run().return.identity.snapshotHash: string | null; default: not declared - run().return.library: { version: string; }; default: not declared - run().return.library.version: string; default: not declared - run().return.operation: { id: string; version: string; }; default: not declared - run().return.operation.id: string; default: not declared - run().return.operation.version: string; default: not declared - run().return.structured: Record; default: not declared - run().return.summary: string; default: not declared - run().return.trace: { requestId: string | null; }; default: not declared - run().return.trace.requestId: string | null; default: not declared - run().return.usage: { elapsedMs: number | null; inputBytes: number; }; default: not declared - run().return.usage.elapsedMs: number | null; default: not declared - run().return.usage.inputBytes: number; default: not declared - run(request): { id: string; input: unknown; } & RunOperationOptions; default: not declared - run(request).artifacts?: import('@insiderfinance/totalfinance/workflows').ArtifactStore | import('@insiderfinance/totalfinance/workflows').ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - run(request).artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - run(request).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - run(request).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - run(request).capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - run(request).createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - run(request).deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - run(request).defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - run(request).id: string; default: not declared - run(request).inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - run(request).input: unknown; default: not declared - run(request).maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - run(request).now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - run(request).requestId?: string; default: not declared - run(request).signal?: import('@insiderfinance/totalfinance/workflows').OperationSignal; default: not declared - run(request).stores?: { authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - run(request).stores.authorization?: import('@insiderfinance/totalfinance/workflows').AuthorizationStore; default: not declared - run(request).stores.journal?: import('@insiderfinance/totalfinance/workflows').ExecutionJournalStore; default: not declared - size: number; default: not declared ### @insiderfinance/totalfinance/workflows#OperationResult Kind: interface; stability: preview (pre-1.0). ```typescript export interface OperationResult> { operation: { id: string; version: string; }; library: { version: string; }; summary: string; structured: Output; assumptions: Record; diagnostics: { warnings: QuantWarning[]; status: 'complete' | 'partial'; incomplete: string[]; }; identity: { inputsHash: string; artifactIds: string[]; snapshotHash: string | null; }; artifacts: ResourceHandle[]; usage: { inputBytes: number; elapsedMs: number | null; }; trace: { requestId: string | null; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts: ResourceHandle[]; default: not declared - assumptions: Record; default: not declared - diagnostics: { incomplete: string[]; status: 'complete' | 'partial'; warnings: QuantWarning[]; }; default: not declared - diagnostics.incomplete: string[]; default: not declared - diagnostics.status: 'complete' | 'partial'; default: not declared - diagnostics.warnings: QuantWarning[]; default: not declared - identity: { artifactIds: string[]; inputsHash: string; snapshotHash: string | null; }; default: not declared - identity.artifactIds: string[]; default: not declared - identity.inputsHash: string; default: not declared - identity.snapshotHash: string | null; default: not declared - library: { version: string; }; default: not declared - library.version: string; default: not declared - operation: { id: string; version: string; }; default: not declared - operation.id: string; default: not declared - operation.version: string; default: not declared - structured: Output; default: not declared - summary: string; default: not declared - trace: { requestId: string | null; }; default: not declared - trace.requestId: string | null; default: not declared - usage: { elapsedMs: number | null; inputBytes: number; }; default: not declared - usage.elapsedMs: number | null; default: not declared - usage.inputBytes: number; default: not declared ### @insiderfinance/totalfinance/workflows#OperationResultSchemaInput Kind: interface; stability: preview (pre-1.0). ```typescript export interface OperationResultSchemaInput { /** The operation's own structured-output schema, or an open object when it declares none. */ structured?: JSONSchema | undefined; /** How to refer to a resource handle — inline by default, or a `$ref` inside an OpenAPI document. */ handle?: JSONSchema | undefined; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - handle?: JSONSchema | undefined; default: not declared — How to refer to a resource handle — inline by default, or a `$ref` inside an OpenAPI document. - handle.$id?: string; default: not declared - handle.$schema?: string; default: not declared - handle.additionalProperties?: boolean | JSONSchema; default: not declared - handle.additionalProperties.$id?: string; default: not declared - handle.additionalProperties.$schema?: string; default: not declared - handle.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - handle.additionalProperties.allOf?: JSONSchema[]; default: not declared - handle.additionalProperties.anyOf?: JSONSchema[]; default: not declared - handle.additionalProperties.const?: unknown; default: not declared - handle.additionalProperties.default?: unknown; default: not declared - handle.additionalProperties.description?: string; default: not declared - handle.additionalProperties.enum?: unknown[]; default: not declared - handle.additionalProperties.exclusiveMaximum?: number; default: not declared - handle.additionalProperties.exclusiveMinimum?: number; default: not declared - handle.additionalProperties.format?: string; default: not declared - handle.additionalProperties.items?: JSONSchema; default: not declared - handle.additionalProperties.items.$id?: string; default: not declared - handle.additionalProperties.items.$schema?: string; default: not declared - handle.additionalProperties.items.additionalProperties?: boolean | JSONSchema; default: not declared - handle.additionalProperties.items.allOf?: JSONSchema[]; default: not declared - handle.additionalProperties.items.anyOf?: JSONSchema[]; default: not declared - handle.additionalProperties.items.const?: unknown; default: not declared - handle.additionalProperties.items.default?: unknown; default: not declared - handle.additionalProperties.items.description?: string; default: not declared - handle.additionalProperties.items.enum?: unknown[]; default: not declared - handle.additionalProperties.items.exclusiveMaximum?: number; default: not declared - handle.additionalProperties.items.exclusiveMinimum?: number; default: not declared - handle.additionalProperties.items.format?: string; default: not declared - handle.additionalProperties.items.items?: JSONSchema; default: not declared - handle.additionalProperties.items.maxItems?: number; default: not declared - handle.additionalProperties.items.maxLength?: number; default: not declared - handle.additionalProperties.items.maximum?: number; default: not declared - handle.additionalProperties.items.minItems?: number; default: not declared - handle.additionalProperties.items.minLength?: number; default: not declared - handle.additionalProperties.items.minimum?: number; default: not declared - handle.additionalProperties.items.multipleOf?: number; default: not declared - handle.additionalProperties.items.oneOf?: JSONSchema[]; default: not declared - handle.additionalProperties.items.pattern?: string; default: not declared - handle.additionalProperties.items.properties?: Record; default: not declared - handle.additionalProperties.items.required?: string[]; default: not declared - handle.additionalProperties.items.title?: string; default: not declared - handle.additionalProperties.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - handle.additionalProperties.maxItems?: number; default: not declared - handle.additionalProperties.maxLength?: number; default: not declared - handle.additionalProperties.maximum?: number; default: not declared - handle.additionalProperties.minItems?: number; default: not declared - handle.additionalProperties.minLength?: number; default: not declared - handle.additionalProperties.minimum?: number; default: not declared - handle.additionalProperties.multipleOf?: number; default: not declared - handle.additionalProperties.oneOf?: JSONSchema[]; default: not declared - handle.additionalProperties.pattern?: string; default: not declared - handle.additionalProperties.properties?: Record; default: not declared - handle.additionalProperties.required?: string[]; default: not declared - handle.additionalProperties.title?: string; default: not declared - handle.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - handle.allOf?: JSONSchema[]; default: not declared - handle.anyOf?: JSONSchema[]; default: not declared - handle.const?: unknown; default: not declared - handle.default?: unknown; default: not declared - handle.description?: string; default: not declared - handle.enum?: unknown[]; default: not declared - handle.exclusiveMaximum?: number; default: not declared - handle.exclusiveMinimum?: number; default: not declared - handle.format?: string; default: not declared - handle.items?: JSONSchema; default: not declared - handle.items.$id?: string; default: not declared - handle.items.$schema?: string; default: not declared - handle.items.additionalProperties?: boolean | JSONSchema; default: not declared - handle.items.additionalProperties.$id?: string; default: not declared - handle.items.additionalProperties.$schema?: string; default: not declared - handle.items.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - handle.items.additionalProperties.allOf?: JSONSchema[]; default: not declared - handle.items.additionalProperties.anyOf?: JSONSchema[]; default: not declared - handle.items.additionalProperties.const?: unknown; default: not declared - handle.items.additionalProperties.default?: unknown; default: not declared - handle.items.additionalProperties.description?: string; default: not declared - handle.items.additionalProperties.enum?: unknown[]; default: not declared - handle.items.additionalProperties.exclusiveMaximum?: number; default: not declared - handle.items.additionalProperties.exclusiveMinimum?: number; default: not declared - handle.items.additionalProperties.format?: string; default: not declared - handle.items.additionalProperties.items?: JSONSchema; default: not declared - handle.items.additionalProperties.maxItems?: number; default: not declared - handle.items.additionalProperties.maxLength?: number; default: not declared - handle.items.additionalProperties.maximum?: number; default: not declared - handle.items.additionalProperties.minItems?: number; default: not declared - handle.items.additionalProperties.minLength?: number; default: not declared - handle.items.additionalProperties.minimum?: number; default: not declared - handle.items.additionalProperties.multipleOf?: number; default: not declared - handle.items.additionalProperties.oneOf?: JSONSchema[]; default: not declared - handle.items.additionalProperties.pattern?: string; default: not declared - handle.items.additionalProperties.properties?: Record; default: not declared - handle.items.additionalProperties.required?: string[]; default: not declared - handle.items.additionalProperties.title?: string; default: not declared - handle.items.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - handle.items.allOf?: JSONSchema[]; default: not declared - handle.items.anyOf?: JSONSchema[]; default: not declared - handle.items.const?: unknown; default: not declared - handle.items.default?: unknown; default: not declared - handle.items.description?: string; default: not declared - handle.items.enum?: unknown[]; default: not declared - handle.items.exclusiveMaximum?: number; default: not declared - handle.items.exclusiveMinimum?: number; default: not declared - handle.items.format?: string; default: not declared - handle.items.items?: JSONSchema; default: not declared - handle.items.maxItems?: number; default: not declared - handle.items.maxLength?: number; default: not declared - handle.items.maximum?: number; default: not declared - handle.items.minItems?: number; default: not declared - handle.items.minLength?: number; default: not declared - handle.items.minimum?: number; default: not declared - handle.items.multipleOf?: number; default: not declared - handle.items.oneOf?: JSONSchema[]; default: not declared - handle.items.pattern?: string; default: not declared - handle.items.properties?: Record; default: not declared - handle.items.required?: string[]; default: not declared - handle.items.title?: string; default: not declared - handle.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - handle.maxItems?: number; default: not declared - handle.maxLength?: number; default: not declared - handle.maximum?: number; default: not declared - handle.minItems?: number; default: not declared - handle.minLength?: number; default: not declared - handle.minimum?: number; default: not declared - handle.multipleOf?: number; default: not declared - handle.oneOf?: JSONSchema[]; default: not declared - handle.pattern?: string; default: not declared - handle.properties?: Record; default: not declared - handle.required?: string[]; default: not declared - handle.title?: string; default: not declared - handle.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - structured?: JSONSchema | undefined; default: not declared — The operation's own structured-output schema, or an open object when it declares none. - structured.$id?: string; default: not declared - structured.$schema?: string; default: not declared - structured.additionalProperties?: boolean | JSONSchema; default: not declared - structured.additionalProperties.$id?: string; default: not declared - structured.additionalProperties.$schema?: string; default: not declared - structured.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - structured.additionalProperties.allOf?: JSONSchema[]; default: not declared - structured.additionalProperties.anyOf?: JSONSchema[]; default: not declared - structured.additionalProperties.const?: unknown; default: not declared - structured.additionalProperties.default?: unknown; default: not declared - structured.additionalProperties.description?: string; default: not declared - structured.additionalProperties.enum?: unknown[]; default: not declared - structured.additionalProperties.exclusiveMaximum?: number; default: not declared - structured.additionalProperties.exclusiveMinimum?: number; default: not declared - structured.additionalProperties.format?: string; default: not declared - structured.additionalProperties.items?: JSONSchema; default: not declared - structured.additionalProperties.items.$id?: string; default: not declared - structured.additionalProperties.items.$schema?: string; default: not declared - structured.additionalProperties.items.additionalProperties?: boolean | JSONSchema; default: not declared - structured.additionalProperties.items.allOf?: JSONSchema[]; default: not declared - structured.additionalProperties.items.anyOf?: JSONSchema[]; default: not declared - structured.additionalProperties.items.const?: unknown; default: not declared - structured.additionalProperties.items.default?: unknown; default: not declared - structured.additionalProperties.items.description?: string; default: not declared - structured.additionalProperties.items.enum?: unknown[]; default: not declared - structured.additionalProperties.items.exclusiveMaximum?: number; default: not declared - structured.additionalProperties.items.exclusiveMinimum?: number; default: not declared - structured.additionalProperties.items.format?: string; default: not declared - structured.additionalProperties.items.items?: JSONSchema; default: not declared - structured.additionalProperties.items.maxItems?: number; default: not declared - structured.additionalProperties.items.maxLength?: number; default: not declared - structured.additionalProperties.items.maximum?: number; default: not declared - structured.additionalProperties.items.minItems?: number; default: not declared - structured.additionalProperties.items.minLength?: number; default: not declared - structured.additionalProperties.items.minimum?: number; default: not declared - structured.additionalProperties.items.multipleOf?: number; default: not declared - structured.additionalProperties.items.oneOf?: JSONSchema[]; default: not declared - structured.additionalProperties.items.pattern?: string; default: not declared - structured.additionalProperties.items.properties?: Record; default: not declared - structured.additionalProperties.items.required?: string[]; default: not declared - structured.additionalProperties.items.title?: string; default: not declared - structured.additionalProperties.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - structured.additionalProperties.maxItems?: number; default: not declared - structured.additionalProperties.maxLength?: number; default: not declared - structured.additionalProperties.maximum?: number; default: not declared - structured.additionalProperties.minItems?: number; default: not declared - structured.additionalProperties.minLength?: number; default: not declared - structured.additionalProperties.minimum?: number; default: not declared - structured.additionalProperties.multipleOf?: number; default: not declared - structured.additionalProperties.oneOf?: JSONSchema[]; default: not declared - structured.additionalProperties.pattern?: string; default: not declared - structured.additionalProperties.properties?: Record; default: not declared - structured.additionalProperties.required?: string[]; default: not declared - structured.additionalProperties.title?: string; default: not declared - structured.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - structured.allOf?: JSONSchema[]; default: not declared - structured.anyOf?: JSONSchema[]; default: not declared - structured.const?: unknown; default: not declared - structured.default?: unknown; default: not declared - structured.description?: string; default: not declared - structured.enum?: unknown[]; default: not declared - structured.exclusiveMaximum?: number; default: not declared - structured.exclusiveMinimum?: number; default: not declared - structured.format?: string; default: not declared - structured.items?: JSONSchema; default: not declared - structured.items.$id?: string; default: not declared - structured.items.$schema?: string; default: not declared - structured.items.additionalProperties?: boolean | JSONSchema; default: not declared - structured.items.additionalProperties.$id?: string; default: not declared - structured.items.additionalProperties.$schema?: string; default: not declared - structured.items.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - structured.items.additionalProperties.allOf?: JSONSchema[]; default: not declared - structured.items.additionalProperties.anyOf?: JSONSchema[]; default: not declared - structured.items.additionalProperties.const?: unknown; default: not declared - structured.items.additionalProperties.default?: unknown; default: not declared - structured.items.additionalProperties.description?: string; default: not declared - structured.items.additionalProperties.enum?: unknown[]; default: not declared - structured.items.additionalProperties.exclusiveMaximum?: number; default: not declared - structured.items.additionalProperties.exclusiveMinimum?: number; default: not declared - structured.items.additionalProperties.format?: string; default: not declared - structured.items.additionalProperties.items?: JSONSchema; default: not declared - structured.items.additionalProperties.maxItems?: number; default: not declared - structured.items.additionalProperties.maxLength?: number; default: not declared - structured.items.additionalProperties.maximum?: number; default: not declared - structured.items.additionalProperties.minItems?: number; default: not declared - structured.items.additionalProperties.minLength?: number; default: not declared - structured.items.additionalProperties.minimum?: number; default: not declared - structured.items.additionalProperties.multipleOf?: number; default: not declared - structured.items.additionalProperties.oneOf?: JSONSchema[]; default: not declared - structured.items.additionalProperties.pattern?: string; default: not declared - structured.items.additionalProperties.properties?: Record; default: not declared - structured.items.additionalProperties.required?: string[]; default: not declared - structured.items.additionalProperties.title?: string; default: not declared - structured.items.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - structured.items.allOf?: JSONSchema[]; default: not declared - structured.items.anyOf?: JSONSchema[]; default: not declared - structured.items.const?: unknown; default: not declared - structured.items.default?: unknown; default: not declared - structured.items.description?: string; default: not declared - structured.items.enum?: unknown[]; default: not declared - structured.items.exclusiveMaximum?: number; default: not declared - structured.items.exclusiveMinimum?: number; default: not declared - structured.items.format?: string; default: not declared - structured.items.items?: JSONSchema; default: not declared - structured.items.maxItems?: number; default: not declared - structured.items.maxLength?: number; default: not declared - structured.items.maximum?: number; default: not declared - structured.items.minItems?: number; default: not declared - structured.items.minLength?: number; default: not declared - structured.items.minimum?: number; default: not declared - structured.items.multipleOf?: number; default: not declared - structured.items.oneOf?: JSONSchema[]; default: not declared - structured.items.pattern?: string; default: not declared - structured.items.properties?: Record; default: not declared - structured.items.required?: string[]; default: not declared - structured.items.title?: string; default: not declared - structured.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - structured.maxItems?: number; default: not declared - structured.maxLength?: number; default: not declared - structured.maximum?: number; default: not declared - structured.minItems?: number; default: not declared - structured.minLength?: number; default: not declared - structured.minimum?: number; default: not declared - structured.multipleOf?: number; default: not declared - structured.oneOf?: JSONSchema[]; default: not declared - structured.pattern?: string; default: not declared - structured.properties?: Record; default: not declared - structured.required?: string[]; default: not declared - structured.title?: string; default: not declared - structured.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared ### @insiderfinance/totalfinance/workflows#OperationSideEffect Kind: type; stability: preview (pre-1.0). ```typescript export type OperationSideEffect = 'none' | 'portfolio-state' | 'external-order'; ``` ### @insiderfinance/totalfinance/workflows#OperationSignal Kind: interface; stability: preview (pre-1.0). The structural shape of a cancellation signal (an `AbortSignal` satisfies it): this package is browser-safe and declares no platform lib, so the contract names only what an operation reads. ```typescript /** * The structural shape of a cancellation signal (an `AbortSignal` satisfies it): this package is * browser-safe and declares no platform lib, so the contract names only what an operation reads. */ export interface OperationSignal { readonly aborted: boolean; readonly reason?: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - aborted: boolean; default: not declared - reason?: unknown; default: not declared ### @insiderfinance/totalfinance/workflows#RESOURCE_HANDLE_SCHEMA Kind: value; stability: preview (pre-1.0). A `ResourceHandle` — a stored report, job, portfolio, scenario, market, authorization or journal — as JSON Schema. The kinds and URI namespaces are read from the one handle table, so the schema can never list fewer kinds than the stores mint (an MCP client validates every structured result against it). ```typescript export declare const RESOURCE_HANDLE_SCHEMA: JSONSchema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - $id?: string; default: not declared - $schema?: string; default: not declared - additionalProperties?: boolean | JSONSchema; default: not declared - additionalProperties.$id?: string; default: not declared - additionalProperties.$schema?: string; default: not declared - additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - additionalProperties.allOf?: JSONSchema[]; default: not declared - additionalProperties.anyOf?: JSONSchema[]; default: not declared - additionalProperties.const?: unknown; default: not declared - additionalProperties.default?: unknown; default: not declared - additionalProperties.description?: string; default: not declared - additionalProperties.enum?: unknown[]; default: not declared - additionalProperties.exclusiveMaximum?: number; default: not declared - additionalProperties.exclusiveMinimum?: number; default: not declared - additionalProperties.format?: string; default: not declared - additionalProperties.items?: JSONSchema; default: not declared - additionalProperties.maxItems?: number; default: not declared - additionalProperties.maxLength?: number; default: not declared - additionalProperties.maximum?: number; default: not declared - additionalProperties.minItems?: number; default: not declared - additionalProperties.minLength?: number; default: not declared - additionalProperties.minimum?: number; default: not declared - additionalProperties.multipleOf?: number; default: not declared - additionalProperties.oneOf?: JSONSchema[]; default: not declared - additionalProperties.pattern?: string; default: not declared - additionalProperties.properties?: Record; default: not declared - additionalProperties.required?: string[]; default: not declared - additionalProperties.title?: string; default: not declared - additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - allOf?: JSONSchema[]; default: not declared - anyOf?: JSONSchema[]; default: not declared - const?: unknown; default: not declared - default?: unknown; default: not declared - description?: string; default: not declared - enum?: unknown[]; default: not declared - exclusiveMaximum?: number; default: not declared - exclusiveMinimum?: number; default: not declared - format?: string; default: not declared - items?: JSONSchema; default: not declared - maxItems?: number; default: not declared - maxLength?: number; default: not declared - maximum?: number; default: not declared - minItems?: number; default: not declared - minLength?: number; default: not declared - minimum?: number; default: not declared - multipleOf?: number; default: not declared - oneOf?: JSONSchema[]; default: not declared - pattern?: string; default: not declared - properties?: Record; default: not declared - required?: string[]; default: not declared - title?: string; default: not declared - type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared ### @insiderfinance/totalfinance/workflows#ResourceHandle Kind: interface; stability: preview (pre-1.0). An explicit, store-scoped reference to stored data — never implicit session state. ```typescript /** An explicit, store-scoped reference to stored data — never implicit session state. */ export interface ResourceHandle { uri: string; kind: ResourceHandleKind; schema: string; version: string; contentHash: string | null; /** When the store minted the handle — the caller's clock in epoch ms, never the library's. */ createdTimestampMs: EpochMs; /** When the stored value stops being served, epoch ms; null = never. */ expiresTimestampMs: EpochMs | null; /** Caller-supplied provenance, preserved verbatim. */ provenance: Provenance; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - contentHash: string | null; default: not declared - createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - kind: ResourceHandleKind; default: not declared - provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - provenance.asOf?: number; default: not declared - provenance.dataset?: string; default: not declared - provenance.provider?: string; default: not declared - provenance.receivedAt?: number; default: not declared - provenance.requestId?: string; default: not declared - provenance.sourceVersion?: string; default: not declared - provenance.warnings?: QuantWarning[]; default: not declared - schema: string; default: not declared - uri: string; default: not declared - version: string; default: not declared ### @insiderfinance/totalfinance/workflows#ResourceHandleKind Kind: type; stability: preview (pre-1.0). The kinds of stored data a handle can point at (Decision 5). ```typescript /** The kinds of stored data a handle can point at (Decision 5). */ export type ResourceHandleKind = 'report' | 'job' | 'portfolio' | 'scenario' | 'market' | 'authorization' | 'journal'; ``` ### @insiderfinance/totalfinance/workflows#RunOperationInput Kind: interface; stability: preview (pre-1.0). Run one operation: bytes → strict parse → seed policy → run → JSON-safe → identity/usage. Throws the typed teaching error a direct call would raise (a QuantError with a registered code); never a raw crash. ```typescript /** * Run one operation: bytes → strict parse → seed policy → run → JSON-safe → identity/usage. * Throws the typed teaching error a direct call would raise (a QuantError with a registered code); never a raw crash. */ export interface RunOperationInput = Record> extends RunOperationOptions { operation: TotalFinanceOperation; /** The raw request as the caller (or the wire) supplied it — validated here, never trusted. */ input: unknown; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts?: ArtifactStore | ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - artifacts.get().return.handle: ResourceHandle; default: not declared - artifacts.get().return.value: Record; default: not declared - artifacts.get(uri): string; default: not declared - artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - artifacts.list(filter)?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; } | undefined; default: not declared - artifacts.list(filter).kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => ResourceHandle; default: not declared - artifacts.put().return.contentHash: string | null; default: not declared - artifacts.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - artifacts.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - artifacts.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - artifacts.put().return.schema: string; default: not declared - artifacts.put().return.uri: string; default: not declared - artifacts.put().return.version: string; default: not declared - artifacts.put(input): import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput; default: not declared - artifacts.put(input).createdTimestampMs: number; default: not declared — Epoch ms — the caller's clock, never read by the library. - artifacts.put(input).expiresTimestampMs?: number; default: not declared — Epoch ms; must be after `createdTimestampMs`. - artifacts.put(input).kind: 'market' | 'portfolio' | 'report' | 'scenario' | 'authorization' | 'journal'; default: not declared - artifacts.put(input).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - artifacts.put(input).value: Record; default: not declared — The stored data — an envelope or an operation's structured result; JSON-safe by construction. - capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - input: unknown; default: not declared — The raw request as the caller (or the wire) supplied it — validated here, never trusted. - maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - operation: TotalFinanceOperation; default: not declared - operation.authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - operation.costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - operation.description: string; default: not declared - operation.deterministic: boolean; default: not declared - operation.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - operation.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - operation.idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - operation.inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - operation.inputSchema.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - operation.inputSchema.describe(description): string; default: not declared - operation.inputSchema.isOptional: boolean; default: not declared - operation.inputSchema.kind: string; default: not declared - operation.inputSchema.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - operation.inputSchema.optional().return.describe: (description: string) => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - operation.inputSchema.optional().return.isOptional: boolean; default: not declared - operation.inputSchema.optional().return.kind: string; default: not declared - operation.inputSchema.optional().return.optional: () => import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - operation.inputSchema.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => Input | undefined; default: not declared - operation.inputSchema.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - operation.inputSchema.optional().return.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.inputSchema.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - operation.inputSchema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => Input; default: not declared - operation.inputSchema.parse(input): unknown; default: not declared - operation.inputSchema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - operation.inputSchema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - operation.inputSchema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - operation.inputSchema.safeParse().return.data: Input; default: not declared - operation.inputSchema.safeParse().return.error: InputError; default: not declared - operation.inputSchema.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - operation.inputSchema.safeParse().return.success: (false) | (true); default: not declared - operation.inputSchema.safeParse(input): unknown; default: not declared - operation.inputSchema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - operation.inputSchema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - operation.inputSchema.toJSONSchema: () => import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.inputSchema.toJSONSchema().return.$id?: string; default: not declared - operation.inputSchema.toJSONSchema().return.$schema?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - operation.inputSchema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.inputSchema.toJSONSchema().return.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.inputSchema.toJSONSchema().return.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.inputSchema.toJSONSchema().return.const?: unknown; default: not declared - operation.inputSchema.toJSONSchema().return.default?: unknown; default: not declared - operation.inputSchema.toJSONSchema().return.description?: string; default: not declared - operation.inputSchema.toJSONSchema().return.enum?: unknown[]; default: not declared - operation.inputSchema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.format?: string; default: not declared - operation.inputSchema.toJSONSchema().return.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.inputSchema.toJSONSchema().return.maxItems?: number; default: not declared - operation.inputSchema.toJSONSchema().return.maxLength?: number; default: not declared - operation.inputSchema.toJSONSchema().return.maximum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.minItems?: number; default: not declared - operation.inputSchema.toJSONSchema().return.minLength?: number; default: not declared - operation.inputSchema.toJSONSchema().return.minimum?: number; default: not declared - operation.inputSchema.toJSONSchema().return.multipleOf?: number; default: not declared - operation.inputSchema.toJSONSchema().return.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.inputSchema.toJSONSchema().return.pattern?: string; default: not declared - operation.inputSchema.toJSONSchema().return.properties?: Record; default: not declared - operation.inputSchema.toJSONSchema().return.required?: string[]; default: not declared - operation.inputSchema.toJSONSchema().return.title?: string; default: not declared - operation.inputSchema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.inputSchema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - operation.inputSchema.~standard.types?: ({ readonly input: unknown; readonly output: Input; }) | undefined; default: not declared - operation.inputSchema.~standard.types.input: unknown; default: not declared - operation.inputSchema.~standard.types.output: Input; default: not declared - operation.inputSchema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - operation.inputSchema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - operation.inputSchema.~standard.validate().return.value: Input; default: not declared - operation.inputSchema.~standard.validate(value): unknown; default: not declared - operation.inputSchema.~standard.vendor: string; default: not declared - operation.inputSchema.~standard.version: 1; default: not declared - operation.outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - operation.outputSchema.$id?: string; default: not declared - operation.outputSchema.$schema?: string; default: not declared - operation.outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.additionalProperties.$id?: string; default: not declared - operation.outputSchema.additionalProperties.$schema?: string; default: not declared - operation.outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.additionalProperties.const?: unknown; default: not declared - operation.outputSchema.additionalProperties.default?: unknown; default: not declared - operation.outputSchema.additionalProperties.description?: string; default: not declared - operation.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - operation.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - operation.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - operation.outputSchema.additionalProperties.format?: string; default: not declared - operation.outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.additionalProperties.items.$id?: string; default: not declared - operation.outputSchema.additionalProperties.items.$schema?: string; default: not declared - operation.outputSchema.additionalProperties.items.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.additionalProperties.items.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.additionalProperties.items.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.additionalProperties.items.const?: unknown; default: not declared - operation.outputSchema.additionalProperties.items.default?: unknown; default: not declared - operation.outputSchema.additionalProperties.items.description?: string; default: not declared - operation.outputSchema.additionalProperties.items.enum?: unknown[]; default: not declared - operation.outputSchema.additionalProperties.items.exclusiveMaximum?: number; default: not declared - operation.outputSchema.additionalProperties.items.exclusiveMinimum?: number; default: not declared - operation.outputSchema.additionalProperties.items.format?: string; default: not declared - operation.outputSchema.additionalProperties.items.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.additionalProperties.items.maxItems?: number; default: not declared - operation.outputSchema.additionalProperties.items.maxLength?: number; default: not declared - operation.outputSchema.additionalProperties.items.maximum?: number; default: not declared - operation.outputSchema.additionalProperties.items.minItems?: number; default: not declared - operation.outputSchema.additionalProperties.items.minLength?: number; default: not declared - operation.outputSchema.additionalProperties.items.minimum?: number; default: not declared - operation.outputSchema.additionalProperties.items.multipleOf?: number; default: not declared - operation.outputSchema.additionalProperties.items.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.additionalProperties.items.pattern?: string; default: not declared - operation.outputSchema.additionalProperties.items.properties?: Record; default: not declared - operation.outputSchema.additionalProperties.items.required?: string[]; default: not declared - operation.outputSchema.additionalProperties.items.title?: string; default: not declared - operation.outputSchema.additionalProperties.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.outputSchema.additionalProperties.maxItems?: number; default: not declared - operation.outputSchema.additionalProperties.maxLength?: number; default: not declared - operation.outputSchema.additionalProperties.maximum?: number; default: not declared - operation.outputSchema.additionalProperties.minItems?: number; default: not declared - operation.outputSchema.additionalProperties.minLength?: number; default: not declared - operation.outputSchema.additionalProperties.minimum?: number; default: not declared - operation.outputSchema.additionalProperties.multipleOf?: number; default: not declared - operation.outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.additionalProperties.pattern?: string; default: not declared - operation.outputSchema.additionalProperties.properties?: Record; default: not declared - operation.outputSchema.additionalProperties.required?: string[]; default: not declared - operation.outputSchema.additionalProperties.title?: string; default: not declared - operation.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.const?: unknown; default: not declared - operation.outputSchema.default?: unknown; default: not declared - operation.outputSchema.description?: string; default: not declared - operation.outputSchema.enum?: unknown[]; default: not declared - operation.outputSchema.exclusiveMaximum?: number; default: not declared - operation.outputSchema.exclusiveMinimum?: number; default: not declared - operation.outputSchema.format?: string; default: not declared - operation.outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.items.$id?: string; default: not declared - operation.outputSchema.items.$schema?: string; default: not declared - operation.outputSchema.items.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.items.additionalProperties.$id?: string; default: not declared - operation.outputSchema.items.additionalProperties.$schema?: string; default: not declared - operation.outputSchema.items.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.items.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.items.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.items.additionalProperties.const?: unknown; default: not declared - operation.outputSchema.items.additionalProperties.default?: unknown; default: not declared - operation.outputSchema.items.additionalProperties.description?: string; default: not declared - operation.outputSchema.items.additionalProperties.enum?: unknown[]; default: not declared - operation.outputSchema.items.additionalProperties.exclusiveMaximum?: number; default: not declared - operation.outputSchema.items.additionalProperties.exclusiveMinimum?: number; default: not declared - operation.outputSchema.items.additionalProperties.format?: string; default: not declared - operation.outputSchema.items.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.items.additionalProperties.maxItems?: number; default: not declared - operation.outputSchema.items.additionalProperties.maxLength?: number; default: not declared - operation.outputSchema.items.additionalProperties.maximum?: number; default: not declared - operation.outputSchema.items.additionalProperties.minItems?: number; default: not declared - operation.outputSchema.items.additionalProperties.minLength?: number; default: not declared - operation.outputSchema.items.additionalProperties.minimum?: number; default: not declared - operation.outputSchema.items.additionalProperties.multipleOf?: number; default: not declared - operation.outputSchema.items.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.items.additionalProperties.pattern?: string; default: not declared - operation.outputSchema.items.additionalProperties.properties?: Record; default: not declared - operation.outputSchema.items.additionalProperties.required?: string[]; default: not declared - operation.outputSchema.items.additionalProperties.title?: string; default: not declared - operation.outputSchema.items.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.outputSchema.items.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.items.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.items.const?: unknown; default: not declared - operation.outputSchema.items.default?: unknown; default: not declared - operation.outputSchema.items.description?: string; default: not declared - operation.outputSchema.items.enum?: unknown[]; default: not declared - operation.outputSchema.items.exclusiveMaximum?: number; default: not declared - operation.outputSchema.items.exclusiveMinimum?: number; default: not declared - operation.outputSchema.items.format?: string; default: not declared - operation.outputSchema.items.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - operation.outputSchema.items.maxItems?: number; default: not declared - operation.outputSchema.items.maxLength?: number; default: not declared - operation.outputSchema.items.maximum?: number; default: not declared - operation.outputSchema.items.minItems?: number; default: not declared - operation.outputSchema.items.minLength?: number; default: not declared - operation.outputSchema.items.minimum?: number; default: not declared - operation.outputSchema.items.multipleOf?: number; default: not declared - operation.outputSchema.items.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.items.pattern?: string; default: not declared - operation.outputSchema.items.properties?: Record; default: not declared - operation.outputSchema.items.required?: string[]; default: not declared - operation.outputSchema.items.title?: string; default: not declared - operation.outputSchema.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.outputSchema.maxItems?: number; default: not declared - operation.outputSchema.maxLength?: number; default: not declared - operation.outputSchema.maximum?: number; default: not declared - operation.outputSchema.minItems?: number; default: not declared - operation.outputSchema.minLength?: number; default: not declared - operation.outputSchema.minimum?: number; default: not declared - operation.outputSchema.multipleOf?: number; default: not declared - operation.outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - operation.outputSchema.pattern?: string; default: not declared - operation.outputSchema.properties?: Record; default: not declared - operation.outputSchema.required?: string[]; default: not declared - operation.outputSchema.title?: string; default: not declared - operation.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - operation.requiredCapabilities: readonly string[]; default: not declared - operation.run: (input: Input, context: OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - operation.run().return.artifacts?: ResourceHandle[]; default: not declared - operation.run().return.incomplete?: string[]; default: not declared - operation.run().return.status?: 'complete' | 'partial'; default: not declared - operation.run().return.structured: Output; default: not declared — Machine-readable structured output (validated against `outputSchema` in the parity fixtures). - operation.run().return.summary: string; default: not declared — Human-readable one-line summary. - operation.run(context): OperationContext; default: not declared - operation.run(context).artifacts: ArtifactStoreReader | null; default: not declared - operation.run(context).artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - operation.run(context).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - operation.run(context).budgets: { deadlineMs: number | null; maxInputBytes: number | null; }; default: not declared - operation.run(context).budgets.deadlineMs: number | null; default: not declared - operation.run(context).budgets.maxInputBytes: number | null; default: not declared - operation.run(context).capabilities: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); the runtime refused the call already when a required one is missing. - operation.run(context).seed: number | null; default: not declared — The resolved seed for a stochastic call (the seed policy injects the default when absent); `null` for a deterministic call. - operation.run(context).signal: OperationSignal | null; default: not declared — Cooperative cancellation for job-class operations; `null` for an inline run. - operation.run(context).signal.aborted: boolean; default: not declared - operation.run(context).signal.reason?: unknown; default: not declared - operation.run(context).stores: { authorization: AuthorizationStore | null; journal: ExecutionJournalStore | null; }; default: not declared — The trade lifecycle's stores (Decision 10), explicit parameters of the runtime — never session state. - operation.run(context).stores.authorization: AuthorizationStore | null; default: not declared - operation.run(context).stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - operation.run(context).stores.authorization.get: (hashOrUri: string) => { handle: ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - operation.run(context).stores.authorization.list: () => ResourceHandle[]; default: not declared - operation.run(context).stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - operation.run(context).stores.journal: ExecutionJournalStore | null; default: not declared - operation.run(context).stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - operation.run(context).stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - operation.run(context).stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - operation.run(context).stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - operation.run(context).stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - operation.run(input): Input; default: not declared - operation.sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - operation.stochastic: boolean | ((input: Input) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - operation.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - operation.title: string; default: not declared - operation.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - requestId?: string; default: not declared - signal?: OperationSignal; default: not declared - signal.aborted: boolean; default: not declared - signal.reason?: unknown; default: not declared - stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - stores.authorization?: AuthorizationStore; default: not declared - stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - stores.authorization.consume().return.consumedTimestampMs: number; default: not declared - stores.authorization.consume().return.idempotencyKey: string; default: not declared - stores.authorization.consume().return.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume().return.journalId: string; default: not declared - stores.authorization.consume().return.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume().return.receiptId: string; default: not declared - stores.authorization.consume(input): import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }; default: not declared - stores.authorization.consume(input).consumedTimestampMs: number; default: not declared - stores.authorization.consume(input).hashOrUri: string; default: not declared - stores.authorization.consume(input).idempotencyKey: string; default: not declared - stores.authorization.consume(input).journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume(input).journalId: string; default: not declared - stores.authorization.consume(input).journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume(input).receiptId: string; default: not declared - stores.authorization.get: (hashOrUri: string) => { handle: ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - stores.authorization.get().return.consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; default: not declared - stores.authorization.get().return.consumed.consumedTimestampMs: number; default: not declared - stores.authorization.get().return.consumed.idempotencyKey: string; default: not declared - stores.authorization.get().return.consumed.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.get().return.consumed.journalId: string; default: not declared - stores.authorization.get().return.consumed.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.get().return.consumed.receiptId: string; default: not declared - stores.authorization.get().return.grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.authorization.get().return.handle: ResourceHandle; default: not declared - stores.authorization.get(hashOrUri): string; default: not declared - stores.authorization.list: () => ResourceHandle[]; default: not declared - stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - stores.authorization.put().return.contentHash: string | null; default: not declared - stores.authorization.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - stores.authorization.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - stores.authorization.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - stores.authorization.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - stores.authorization.put().return.schema: string; default: not declared - stores.authorization.put().return.uri: string; default: not declared - stores.authorization.put().return.version: string; default: not declared - stores.authorization.put(input): { createdTimestampMs: EpochMs; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; }; default: not declared - stores.authorization.put(input).createdTimestampMs: number; default: not declared - stores.authorization.put(input).grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.journal?: ExecutionJournalStore; default: not declared - stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - stores.journal.append().return.appended: number; default: not declared - stores.journal.append().return.journalId: string; default: not declared - stores.journal.append().return.skipped: number; default: not declared - stores.journal.append().return.total: number; default: not declared - stores.journal.append(input): { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }; default: not declared - stores.journal.append(input).events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared - stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - stores.journal.read(journalId): string; default: not declared - stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - stores.journal.transact(input): { execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; journalId: string; }; default: not declared - stores.journal.transact(input).execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; default: not declared - stores.journal.transact(input).journalId: string; default: not declared ### @insiderfinance/totalfinance/workflows#RunOperationOptions Kind: interface; stability: preview (pre-1.0). ```typescript export interface RunOperationOptions { /** Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). */ maxInputBytes?: number; /** Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). */ defaultSeed?: number; /** Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. */ deadlineMs?: number; signal?: OperationSignal; /** * The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store * (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs * `createdTimestampMs` — the caller's clock, never the library's. */ artifacts?: ArtifactStoreReader | ArtifactStore; /** Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. */ inlineResultBytes?: number; /** Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. */ createdTimestampMs?: EpochMs; requestId?: string; /** Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. */ now?: () => number; /** What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). */ capabilities?: readonly string[]; /** The trade lifecycle's stores (Decision 10): authorization grants and execution journals. */ stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts?: ArtifactStore | ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - artifacts.get().return.handle: ResourceHandle; default: not declared - artifacts.get().return.value: Record; default: not declared - artifacts.get(uri): string; default: not declared - artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - artifacts.list(filter)?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; } | undefined; default: not declared - artifacts.list(filter).kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => ResourceHandle; default: not declared - artifacts.put().return.contentHash: string | null; default: not declared - artifacts.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - artifacts.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - artifacts.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - artifacts.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - artifacts.put().return.schema: string; default: not declared - artifacts.put().return.uri: string; default: not declared - artifacts.put().return.version: string; default: not declared - artifacts.put(input): import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput; default: not declared - artifacts.put(input).createdTimestampMs: number; default: not declared — Epoch ms — the caller's clock, never read by the library. - artifacts.put(input).expiresTimestampMs?: number; default: not declared — Epoch ms; must be after `createdTimestampMs`. - artifacts.put(input).kind: 'market' | 'portfolio' | 'report' | 'scenario' | 'authorization' | 'journal'; default: not declared - artifacts.put(input).provenance?: import('@insiderfinance/totalfinance/core').Provenance; default: not declared - artifacts.put(input).value: Record; default: not declared — The stored data — an envelope or an operation's structured result; JSON-safe by construction. - capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - requestId?: string; default: not declared - signal?: OperationSignal; default: not declared - signal.aborted: boolean; default: not declared - signal.reason?: unknown; default: not declared - stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - stores.authorization?: AuthorizationStore; default: not declared - stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - stores.authorization.consume().return.consumedTimestampMs: number; default: not declared - stores.authorization.consume().return.idempotencyKey: string; default: not declared - stores.authorization.consume().return.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume().return.journalId: string; default: not declared - stores.authorization.consume().return.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume().return.receiptId: string; default: not declared - stores.authorization.consume(input): import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }; default: not declared - stores.authorization.consume(input).consumedTimestampMs: number; default: not declared - stores.authorization.consume(input).hashOrUri: string; default: not declared - stores.authorization.consume(input).idempotencyKey: string; default: not declared - stores.authorization.consume(input).journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume(input).journalId: string; default: not declared - stores.authorization.consume(input).journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume(input).receiptId: string; default: not declared - stores.authorization.get: (hashOrUri: string) => { handle: ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - stores.authorization.get().return.consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; default: not declared - stores.authorization.get().return.consumed.consumedTimestampMs: number; default: not declared - stores.authorization.get().return.consumed.idempotencyKey: string; default: not declared - stores.authorization.get().return.consumed.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.get().return.consumed.journalId: string; default: not declared - stores.authorization.get().return.consumed.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.get().return.consumed.receiptId: string; default: not declared - stores.authorization.get().return.grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.authorization.get().return.handle: ResourceHandle; default: not declared - stores.authorization.get(hashOrUri): string; default: not declared - stores.authorization.list: () => ResourceHandle[]; default: not declared - stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - stores.authorization.put().return.contentHash: string | null; default: not declared - stores.authorization.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - stores.authorization.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - stores.authorization.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - stores.authorization.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - stores.authorization.put().return.schema: string; default: not declared - stores.authorization.put().return.uri: string; default: not declared - stores.authorization.put().return.version: string; default: not declared - stores.authorization.put(input): { createdTimestampMs: EpochMs; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; }; default: not declared - stores.authorization.put(input).createdTimestampMs: number; default: not declared - stores.authorization.put(input).grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.journal?: ExecutionJournalStore; default: not declared - stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - stores.journal.append().return.appended: number; default: not declared - stores.journal.append().return.journalId: string; default: not declared - stores.journal.append().return.skipped: number; default: not declared - stores.journal.append().return.total: number; default: not declared - stores.journal.append(input): { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }; default: not declared - stores.journal.append(input).events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared - stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - stores.journal.read(journalId): string; default: not declared - stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - stores.journal.transact(input): { execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; journalId: string; }; default: not declared - stores.journal.transact(input).execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; default: not declared - stores.journal.transact(input).journalId: string; default: not declared ### @insiderfinance/totalfinance/workflows#TotalFinanceOperation Kind: interface; stability: preview (pre-1.0). ```typescript export interface TotalFinanceOperation> { /** The wire identity every transport uses: `totalfinance..`. */ id: string; /** An integer string; a breaking output change bumps it (pre-1.0: no aliases). */ version: string; title: string; description: string; inputSchema: Schema; outputSchema: JSONSchema | null; sideEffect: OperationSideEffect; authorization: OperationAuthorization; idempotency: OperationIdempotency; deterministic: boolean; /** * A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED * input. (Declared through a method type so a specifically typed operation stays assignable to the * registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) */ stochastic: boolean | { predicate(input: Input): boolean; }['predicate']; costClass: OperationCostClass; requiredCapabilities: readonly string[]; /** True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. */ supportsCancellation: boolean; /** Input paths that accept a resource handle in place of inline data. */ handleFields: readonly string[]; /** SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. */ run(input: Input, context: OperationContext): OperationOutput; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - authorization: OperationAuthorization; default: not declared - costClass: OperationCostClass; default: not declared - description: string; default: not declared - deterministic: boolean; default: not declared - handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - idempotency: OperationIdempotency; default: not declared - inputSchema: Schema; default: not declared - inputSchema.describe: (description: string) => Schema; default: not declared - inputSchema.describe(description): string; default: not declared - inputSchema.isOptional: boolean; default: not declared - inputSchema.kind: string; default: not declared - inputSchema.optional: () => Schema; default: not declared - inputSchema.optional().return.describe: (description: string) => Schema; default: not declared - inputSchema.optional().return.isOptional: boolean; default: not declared - inputSchema.optional().return.kind: string; default: not declared - inputSchema.optional().return.optional: () => Schema; default: not declared - inputSchema.optional().return.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => Input | undefined; default: not declared - inputSchema.optional().return.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - inputSchema.optional().return.toJSONSchema: () => JSONSchema; default: not declared - inputSchema.optional().return.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - inputSchema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => Input; default: not declared - inputSchema.parse(input): unknown; default: not declared - inputSchema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - inputSchema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - inputSchema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - inputSchema.safeParse().return.data: Input; default: not declared - inputSchema.safeParse().return.error: InputError; default: not declared - inputSchema.safeParse().return.issues: SchemaIssue[]; default: not declared - inputSchema.safeParse().return.success: (false) | (true); default: not declared - inputSchema.safeParse(input): unknown; default: not declared - inputSchema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - inputSchema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - inputSchema.toJSONSchema: () => JSONSchema; default: not declared - inputSchema.toJSONSchema().return.$id?: string; default: not declared - inputSchema.toJSONSchema().return.$schema?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - inputSchema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - inputSchema.toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - inputSchema.toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - inputSchema.toJSONSchema().return.const?: unknown; default: not declared - inputSchema.toJSONSchema().return.default?: unknown; default: not declared - inputSchema.toJSONSchema().return.description?: string; default: not declared - inputSchema.toJSONSchema().return.enum?: unknown[]; default: not declared - inputSchema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - inputSchema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - inputSchema.toJSONSchema().return.format?: string; default: not declared - inputSchema.toJSONSchema().return.items?: JSONSchema; default: not declared - inputSchema.toJSONSchema().return.maxItems?: number; default: not declared - inputSchema.toJSONSchema().return.maxLength?: number; default: not declared - inputSchema.toJSONSchema().return.maximum?: number; default: not declared - inputSchema.toJSONSchema().return.minItems?: number; default: not declared - inputSchema.toJSONSchema().return.minLength?: number; default: not declared - inputSchema.toJSONSchema().return.minimum?: number; default: not declared - inputSchema.toJSONSchema().return.multipleOf?: number; default: not declared - inputSchema.toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - inputSchema.toJSONSchema().return.pattern?: string; default: not declared - inputSchema.toJSONSchema().return.properties?: Record; default: not declared - inputSchema.toJSONSchema().return.required?: string[]; default: not declared - inputSchema.toJSONSchema().return.title?: string; default: not declared - inputSchema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - inputSchema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - inputSchema.~standard.types?: ({ readonly input: unknown; readonly output: Input; }) | undefined; default: not declared - inputSchema.~standard.types.input: unknown; default: not declared - inputSchema.~standard.types.output: Input; default: not declared - inputSchema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - inputSchema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - inputSchema.~standard.validate().return.value: Input; default: not declared - inputSchema.~standard.validate(value): unknown; default: not declared - inputSchema.~standard.vendor: string; default: not declared - inputSchema.~standard.version: 1; default: not declared - outputSchema: JSONSchema | null; default: not declared - outputSchema.$id?: string; default: not declared - outputSchema.$schema?: string; default: not declared - outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.$id?: string; default: not declared - outputSchema.additionalProperties.$schema?: string; default: not declared - outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.const?: unknown; default: not declared - outputSchema.additionalProperties.default?: unknown; default: not declared - outputSchema.additionalProperties.description?: string; default: not declared - outputSchema.additionalProperties.enum?: unknown[]; default: not declared - outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - outputSchema.additionalProperties.format?: string; default: not declared - outputSchema.additionalProperties.items?: JSONSchema; default: not declared - outputSchema.additionalProperties.items.$id?: string; default: not declared - outputSchema.additionalProperties.items.$schema?: string; default: not declared - outputSchema.additionalProperties.items.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.items.allOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.items.anyOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.items.const?: unknown; default: not declared - outputSchema.additionalProperties.items.default?: unknown; default: not declared - outputSchema.additionalProperties.items.description?: string; default: not declared - outputSchema.additionalProperties.items.enum?: unknown[]; default: not declared - outputSchema.additionalProperties.items.exclusiveMaximum?: number; default: not declared - outputSchema.additionalProperties.items.exclusiveMinimum?: number; default: not declared - outputSchema.additionalProperties.items.format?: string; default: not declared - outputSchema.additionalProperties.items.items?: JSONSchema; default: not declared - outputSchema.additionalProperties.items.maxItems?: number; default: not declared - outputSchema.additionalProperties.items.maxLength?: number; default: not declared - outputSchema.additionalProperties.items.maximum?: number; default: not declared - outputSchema.additionalProperties.items.minItems?: number; default: not declared - outputSchema.additionalProperties.items.minLength?: number; default: not declared - outputSchema.additionalProperties.items.minimum?: number; default: not declared - outputSchema.additionalProperties.items.multipleOf?: number; default: not declared - outputSchema.additionalProperties.items.oneOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.items.pattern?: string; default: not declared - outputSchema.additionalProperties.items.properties?: Record; default: not declared - outputSchema.additionalProperties.items.required?: string[]; default: not declared - outputSchema.additionalProperties.items.title?: string; default: not declared - outputSchema.additionalProperties.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.additionalProperties.maxItems?: number; default: not declared - outputSchema.additionalProperties.maxLength?: number; default: not declared - outputSchema.additionalProperties.maximum?: number; default: not declared - outputSchema.additionalProperties.minItems?: number; default: not declared - outputSchema.additionalProperties.minLength?: number; default: not declared - outputSchema.additionalProperties.minimum?: number; default: not declared - outputSchema.additionalProperties.multipleOf?: number; default: not declared - outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.pattern?: string; default: not declared - outputSchema.additionalProperties.properties?: Record; default: not declared - outputSchema.additionalProperties.required?: string[]; default: not declared - outputSchema.additionalProperties.title?: string; default: not declared - outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.allOf?: JSONSchema[]; default: not declared - outputSchema.anyOf?: JSONSchema[]; default: not declared - outputSchema.const?: unknown; default: not declared - outputSchema.default?: unknown; default: not declared - outputSchema.description?: string; default: not declared - outputSchema.enum?: unknown[]; default: not declared - outputSchema.exclusiveMaximum?: number; default: not declared - outputSchema.exclusiveMinimum?: number; default: not declared - outputSchema.format?: string; default: not declared - outputSchema.items?: JSONSchema; default: not declared - outputSchema.items.$id?: string; default: not declared - outputSchema.items.$schema?: string; default: not declared - outputSchema.items.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.items.additionalProperties.$id?: string; default: not declared - outputSchema.items.additionalProperties.$schema?: string; default: not declared - outputSchema.items.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.items.additionalProperties.allOf?: JSONSchema[]; default: not declared - outputSchema.items.additionalProperties.anyOf?: JSONSchema[]; default: not declared - outputSchema.items.additionalProperties.const?: unknown; default: not declared - outputSchema.items.additionalProperties.default?: unknown; default: not declared - outputSchema.items.additionalProperties.description?: string; default: not declared - outputSchema.items.additionalProperties.enum?: unknown[]; default: not declared - outputSchema.items.additionalProperties.exclusiveMaximum?: number; default: not declared - outputSchema.items.additionalProperties.exclusiveMinimum?: number; default: not declared - outputSchema.items.additionalProperties.format?: string; default: not declared - outputSchema.items.additionalProperties.items?: JSONSchema; default: not declared - outputSchema.items.additionalProperties.maxItems?: number; default: not declared - outputSchema.items.additionalProperties.maxLength?: number; default: not declared - outputSchema.items.additionalProperties.maximum?: number; default: not declared - outputSchema.items.additionalProperties.minItems?: number; default: not declared - outputSchema.items.additionalProperties.minLength?: number; default: not declared - outputSchema.items.additionalProperties.minimum?: number; default: not declared - outputSchema.items.additionalProperties.multipleOf?: number; default: not declared - outputSchema.items.additionalProperties.oneOf?: JSONSchema[]; default: not declared - outputSchema.items.additionalProperties.pattern?: string; default: not declared - outputSchema.items.additionalProperties.properties?: Record; default: not declared - outputSchema.items.additionalProperties.required?: string[]; default: not declared - outputSchema.items.additionalProperties.title?: string; default: not declared - outputSchema.items.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.items.allOf?: JSONSchema[]; default: not declared - outputSchema.items.anyOf?: JSONSchema[]; default: not declared - outputSchema.items.const?: unknown; default: not declared - outputSchema.items.default?: unknown; default: not declared - outputSchema.items.description?: string; default: not declared - outputSchema.items.enum?: unknown[]; default: not declared - outputSchema.items.exclusiveMaximum?: number; default: not declared - outputSchema.items.exclusiveMinimum?: number; default: not declared - outputSchema.items.format?: string; default: not declared - outputSchema.items.items?: JSONSchema; default: not declared - outputSchema.items.maxItems?: number; default: not declared - outputSchema.items.maxLength?: number; default: not declared - outputSchema.items.maximum?: number; default: not declared - outputSchema.items.minItems?: number; default: not declared - outputSchema.items.minLength?: number; default: not declared - outputSchema.items.minimum?: number; default: not declared - outputSchema.items.multipleOf?: number; default: not declared - outputSchema.items.oneOf?: JSONSchema[]; default: not declared - outputSchema.items.pattern?: string; default: not declared - outputSchema.items.properties?: Record; default: not declared - outputSchema.items.required?: string[]; default: not declared - outputSchema.items.title?: string; default: not declared - outputSchema.items.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.maxItems?: number; default: not declared - outputSchema.maxLength?: number; default: not declared - outputSchema.maximum?: number; default: not declared - outputSchema.minItems?: number; default: not declared - outputSchema.minLength?: number; default: not declared - outputSchema.minimum?: number; default: not declared - outputSchema.multipleOf?: number; default: not declared - outputSchema.oneOf?: JSONSchema[]; default: not declared - outputSchema.pattern?: string; default: not declared - outputSchema.properties?: Record; default: not declared - outputSchema.required?: string[]; default: not declared - outputSchema.title?: string; default: not declared - outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - requiredCapabilities: readonly string[]; default: not declared - run: (input: Input, context: OperationContext) => OperationOutput; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - run().return.artifacts?: ResourceHandle[]; default: not declared - run().return.incomplete?: string[]; default: not declared - run().return.status?: 'complete' | 'partial'; default: not declared - run().return.structured: Output; default: not declared — Machine-readable structured output (validated against `outputSchema` in the parity fixtures). - run().return.summary: string; default: not declared — Human-readable one-line summary. - run(context): OperationContext; default: not declared - run(context).artifacts: ArtifactStoreReader | null; default: not declared - run(context).artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - run(context).artifacts.list: (filter?: { kind?: ResourceHandleKind; }) => ResourceHandle[]; default: not declared - run(context).budgets: { deadlineMs: number | null; maxInputBytes: number | null; }; default: not declared - run(context).budgets.deadlineMs: number | null; default: not declared - run(context).budgets.maxInputBytes: number | null; default: not declared - run(context).capabilities: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); the runtime refused the call already when a required one is missing. - run(context).seed: number | null; default: not declared — The resolved seed for a stochastic call (the seed policy injects the default when absent); `null` for a deterministic call. - run(context).signal: OperationSignal | null; default: not declared — Cooperative cancellation for job-class operations; `null` for an inline run. - run(context).signal.aborted: boolean; default: not declared - run(context).signal.reason?: unknown; default: not declared - run(context).stores: { authorization: AuthorizationStore | null; journal: ExecutionJournalStore | null; }; default: not declared — The trade lifecycle's stores (Decision 10), explicit parameters of the runtime — never session state. - run(context).stores.authorization: AuthorizationStore | null; default: not declared - run(context).stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - run(context).stores.authorization.get: (hashOrUri: string) => { handle: ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - run(context).stores.authorization.list: () => ResourceHandle[]; default: not declared - run(context).stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - run(context).stores.journal: ExecutionJournalStore | null; default: not declared - run(context).stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - run(context).stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - run(context).stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - run(context).stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - run(context).stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - run(input): Input; default: not declared - sideEffect: OperationSideEffect; default: not declared - stochastic: boolean | ((input: Input) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - title: string; default: not declared - version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). ### @insiderfinance/totalfinance/workflows#WORKFLOWS_VERSION Kind: value; stability: preview (pre-1.0). Generated by publication:update from the public distribution version; browser-safe. ```typescript export declare const WORKFLOWS_VERSION: '0.1.5'; ``` ### @insiderfinance/totalfinance/workflows#analysisOperations Kind: function; stability: preview (pre-1.0). The analysis additions (dx §WS-5) to the default read-only tool set. ```typescript export declare function analysisOperations(): TotalFinanceOperation[]; ``` ### @insiderfinance/totalfinance/workflows#applyJobPatch Kind: function; stability: preview (pre-1.0). Apply a patch to a record under the state machine; the merged record is re-validated whole. ```typescript export declare function applyJobPatch(functionName: string, current: JobRecord, patch: unknown): JobRecord; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (current): JobRecord; default: not declared - (current).error: OperationError | null; default: not declared - (current).error.code: string; default: not declared - (current).error.context: Record; default: not declared - (current).error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - (current).error.message: string; default: not declared - (current).error.operation: { id: string; version: string; } | null; default: not declared - (current).error.operation.id: string; default: not declared - (current).error.operation.version: string; default: not declared - (current).finishedAt: string | null; default: not declared - (current).id: string; default: not declared - (current).inputsHash: string; default: not declared - (current).operation: { id: string; version: string; }; default: not declared - (current).operation.id: string; default: not declared - (current).operation.version: string; default: not declared - (current).progress: { fraction: number | null; stage: string; } | null; default: not declared - (current).progress.fraction: number | null; default: not declared - (current).progress.stage: string; default: not declared - (current).result: ResourceHandle | null; default: not declared - (current).result.contentHash: string | null; default: not declared - (current).result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - (current).result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - (current).result.kind: ResourceHandleKind; default: not declared - (current).result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - (current).result.schema: string; default: not declared - (current).result.uri: string; default: not declared - (current).result.version: string; default: not declared - (current).seed: number | null; default: not declared - (current).startedAt: string | null; default: not declared - (current).state: JobState; default: not declared - (current).submittedAt: string; default: not declared - (current).usage: { elapsedMs: number | null; }; default: not declared - (current).usage.elapsedMs: number | null; default: not declared - (functionName): string; default: not declared - (patch): unknown; default: not declared - return.error: OperationError | null; default: not declared - return.error.code: string; default: not declared - return.error.context: Record; default: not declared - return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - return.error.message: string; default: not declared - return.error.operation: { id: string; version: string; } | null; default: not declared - return.error.operation.id: string; default: not declared - return.error.operation.version: string; default: not declared - return.finishedAt: string | null; default: not declared - return.id: string; default: not declared - return.inputsHash: string; default: not declared - return.operation: { id: string; version: string; }; default: not declared - return.operation.id: string; default: not declared - return.operation.version: string; default: not declared - return.progress: { fraction: number | null; stage: string; } | null; default: not declared - return.progress.fraction: number | null; default: not declared - return.progress.stage: string; default: not declared - return.result: ResourceHandle | null; default: not declared - return.result.contentHash: string | null; default: not declared - return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - return.result.kind: ResourceHandleKind; default: not declared - return.result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - return.result.schema: string; default: not declared - return.result.uri: string; default: not declared - return.result.version: string; default: not declared - return.seed: number | null; default: not declared - return.startedAt: string | null; default: not declared - return.state: JobState; default: not declared - return.submittedAt: string; default: not declared - return.usage: { elapsedMs: number | null; }; default: not declared - return.usage.elapsedMs: number | null; default: not declared ### @insiderfinance/totalfinance/workflows#artifactPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function artifactPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#backtestPack Kind: function; stability: preview (pre-1.0). The opt-in backtest pack (dx §4.2: backtests do not belong in the default server). Enable with `createTotalFinanceMcpServer({ packs: [backtestPack()] })`. ```typescript export declare function backtestPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#calendarPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function calendarPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#capRows Kind: function; stability: preview (pre-1.0). ```typescript export declare function capRows(rows: Rows, field: string, operationId: string, max?: number): Rows; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (max)?: number; default: not declared - (operationId): string; default: not declared - (rows): Rows; default: not declared ### @insiderfinance/totalfinance/workflows#createMemoryArtifactStore Kind: function; stability: preview (pre-1.0). A pure in-memory artifact store — browser-safe; idempotent by content. ```typescript export declare function createMemoryArtifactStore(): ArtifactStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - return.list: (filter?: { kind?: ResourceHandleKind; }) => ResourceHandle[]; default: not declared - return.put: (input: ArtifactStorePutInput) => ResourceHandle; default: not declared ### @insiderfinance/totalfinance/workflows#createMemoryAuthorizationStore Kind: function; stability: preview (pre-1.0). ```typescript export declare function createMemoryAuthorizationStore(): AuthorizationStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.consume: (input: GrantConsumption & { hashOrUri: string; }) => GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - return.get: (hashOrUri: string) => { handle: ResourceHandle; grant: AuthorizationGrant; consumed: GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - return.list: () => ResourceHandle[]; default: not declared - return.put: (input: { grant: AuthorizationGrant; createdTimestampMs: EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. ### @insiderfinance/totalfinance/workflows#createMemoryExecutionJournalStore Kind: function; stability: preview (pre-1.0). ```typescript export declare function createMemoryExecutionJournalStore(): ExecutionJournalStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.append: (input: { events: readonly ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - return.list: () => string[]; default: not declared — Every journal id, sorted. - return.read: (journalId: string) => ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - return.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - return.transact: (input: { journalId: string; execute: (prior: readonly ExecutionJournalEvent[]) => { events: readonly ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. ### @insiderfinance/totalfinance/workflows#createMemoryJobStore Kind: function; stability: preview (pre-1.0). A pure in-memory job store — browser-safe; records are copied on the way in and out. ```typescript export declare function createMemoryJobStore(): JobStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.create: (record: JobRecord) => JobRecord; default: not declared - return.get: (id: string) => JobRecord | null; default: not declared - return.list: () => JobRecord[]; default: not declared - return.update: (id: string, patch: Partial>) => JobRecord; default: not declared ### @insiderfinance/totalfinance/workflows#createOperationRegistry Kind: function; stability: preview (pre-1.0). ```typescript export declare function createOperationRegistry(input: { operations?: readonly TotalFinanceOperation[]; packs?: readonly OperationPack[]; }): OperationRegistry; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { operations?: readonly TotalFinanceOperation[]; packs?: readonly OperationPack[]; }; default: not declared - (input).operations?: readonly TotalFinanceOperation>[]; default: not declared - (input).packs?: readonly OperationPack[]; default: not declared - return.describe: (id: string) => OperationDescription; default: not declared - return.get: (id: string) => TotalFinanceOperation | null; default: not declared - return.list: () => OperationDescription[]; default: not declared - return.packs: () => OperationPack[]; default: not declared - return.require: (id: string) => TotalFinanceOperation; default: not declared — The operation, or a typed refusal naming the closest id. - return.run: (request: { id: string; input: unknown; } & RunOperationOptions) => OperationResult; default: not declared — Run one registered operation: `{ id, input, ...runtime options }` — one closed request. - return.size: number; default: not declared ### @insiderfinance/totalfinance/workflows#cryptoPack Kind: function; stability: preview (pre-1.0). The crypto derivatives pack (P3.7): funding + carry analytics. ```typescript export declare function cryptoPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#defaultOperations Kind: function; stability: preview (pre-1.0). The default read-only tool set — every domain pack flattened (dx §WS-5). ```typescript export declare function defaultOperations(): TotalFinanceOperation[]; ``` ### @insiderfinance/totalfinance/workflows#defaultPacks Kind: function; stability: preview (pre-1.0). The ten domain packs that make up the default read-only server, in tool-list order. ```typescript export declare function defaultPacks(): OperationPack[]; ``` ### @insiderfinance/totalfinance/workflows#defineOperation Kind: function; stability: preview (pre-1.0). Define an operation. Every effect field has the read-only default this stage ships; a definition is validated once here so a malformed operation never reaches a registry or a transport. ```typescript export declare function defineOperation>(definition: { id: string; version?: string; title: string; description: string; inputSchema: Schema; outputSchema?: JSONSchema; sideEffect?: OperationSideEffect; authorization?: OperationAuthorization; idempotency?: OperationIdempotency; deterministic?: boolean; stochastic?: boolean | ((input: Input) => boolean); costClass?: OperationCostClass; requiredCapabilities?: readonly string[]; supportsCancellation?: boolean; handleFields?: readonly string[]; run: (input: Input, context: OperationContext) => OperationOutput; }): TotalFinanceOperation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definition): { id: string; version?: string; title: string; description: string; inputSchema: Schema; outputSchema?: JSONSchema; sideEffect?: OperationSideEffect; authorization?: OperationAuthorization; idempotency?: OperationIdempotency; deterministic?: boolean; stochastic?: boolean | ((input: Input) => boolean); costClass?: OperationCostClass; requiredCapabilities?: readonly string[]; supportsCancellation?: boolean; handleFields?: readonly string[]; run: (input: Input, context: OperationContext) => OperationOutput; }; default: not declared - (definition).authorization?: OperationAuthorization; default: not declared - (definition).costClass?: OperationCostClass; default: not declared - (definition).description: string; default: not declared - (definition).deterministic?: boolean; default: not declared - (definition).handleFields?: readonly string[]; default: not declared - (definition).id: string; default: not declared - (definition).idempotency?: OperationIdempotency; default: not declared - (definition).inputSchema: Schema; default: not declared - (definition).outputSchema?: JSONSchema; default: not declared - (definition).requiredCapabilities?: readonly string[]; default: not declared - (definition).run: (input: Input, context: OperationContext) => OperationOutput; default: not declared - (definition).sideEffect?: OperationSideEffect; default: not declared - (definition).stochastic?: boolean | ((input: Input) => boolean); default: not declared - (definition).supportsCancellation?: boolean; default: not declared - (definition).title: string; default: not declared - (definition).version?: string; default: not declared - return.authorization: OperationAuthorization; default: not declared - return.costClass: OperationCostClass; default: not declared - return.description: string; default: not declared - return.deterministic: boolean; default: not declared - return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - return.idempotency: OperationIdempotency; default: not declared - return.inputSchema: Schema; default: not declared - return.outputSchema: JSONSchema | null; default: not declared - return.outputSchema.$id?: string; default: not declared - return.outputSchema.$schema?: string; default: not declared - return.outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - return.outputSchema.additionalProperties.$id?: string; default: not declared - return.outputSchema.additionalProperties.$schema?: string; default: not declared - return.outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - return.outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.const?: unknown; default: not declared - return.outputSchema.additionalProperties.default?: unknown; default: not declared - return.outputSchema.additionalProperties.description?: string; default: not declared - return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - return.outputSchema.additionalProperties.format?: string; default: not declared - return.outputSchema.additionalProperties.items?: JSONSchema; default: not declared - return.outputSchema.additionalProperties.maxItems?: number; default: not declared - return.outputSchema.additionalProperties.maxLength?: number; default: not declared - return.outputSchema.additionalProperties.maximum?: number; default: not declared - return.outputSchema.additionalProperties.minItems?: number; default: not declared - return.outputSchema.additionalProperties.minLength?: number; default: not declared - return.outputSchema.additionalProperties.minimum?: number; default: not declared - return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - return.outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.pattern?: string; default: not declared - return.outputSchema.additionalProperties.properties?: Record; default: not declared - return.outputSchema.additionalProperties.required?: string[]; default: not declared - return.outputSchema.additionalProperties.title?: string; default: not declared - return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.outputSchema.allOf?: JSONSchema[]; default: not declared - return.outputSchema.anyOf?: JSONSchema[]; default: not declared - return.outputSchema.const?: unknown; default: not declared - return.outputSchema.default?: unknown; default: not declared - return.outputSchema.description?: string; default: not declared - return.outputSchema.enum?: unknown[]; default: not declared - return.outputSchema.exclusiveMaximum?: number; default: not declared - return.outputSchema.exclusiveMinimum?: number; default: not declared - return.outputSchema.format?: string; default: not declared - return.outputSchema.items?: JSONSchema; default: not declared - return.outputSchema.maxItems?: number; default: not declared - return.outputSchema.maxLength?: number; default: not declared - return.outputSchema.maximum?: number; default: not declared - return.outputSchema.minItems?: number; default: not declared - return.outputSchema.minLength?: number; default: not declared - return.outputSchema.minimum?: number; default: not declared - return.outputSchema.multipleOf?: number; default: not declared - return.outputSchema.oneOf?: JSONSchema[]; default: not declared - return.outputSchema.pattern?: string; default: not declared - return.outputSchema.properties?: Record; default: not declared - return.outputSchema.required?: string[]; default: not declared - return.outputSchema.title?: string; default: not declared - return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.requiredCapabilities: readonly string[]; default: not declared - return.run: (input: Input, context: OperationContext) => OperationOutput; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - return.sideEffect: OperationSideEffect; default: not declared - return.stochastic: boolean | ((input: Input) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - return.title: string; default: not declared - return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). ### @insiderfinance/totalfinance/workflows#describeOperation Kind: function; stability: preview (pre-1.0). The transport-neutral description of an operation — what CLI help, OpenAPI, and MCP tools render. ```typescript export declare function describeOperation(operation: TotalFinanceOperation): OperationDescription; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (operation): TotalFinanceOperation>; default: not declared - (operation).authorization: OperationAuthorization; default: not declared - (operation).costClass: OperationCostClass; default: not declared - (operation).description: string; default: not declared - (operation).deterministic: boolean; default: not declared - (operation).handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - (operation).id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - (operation).idempotency: OperationIdempotency; default: not declared - (operation).inputSchema: Schema; default: not declared - (operation).outputSchema: JSONSchema | null; default: not declared - (operation).outputSchema.$id?: string; default: not declared - (operation).outputSchema.$schema?: string; default: not declared - (operation).outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.$id?: string; default: not declared - (operation).outputSchema.additionalProperties.$schema?: string; default: not declared - (operation).outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.const?: unknown; default: not declared - (operation).outputSchema.additionalProperties.default?: unknown; default: not declared - (operation).outputSchema.additionalProperties.description?: string; default: not declared - (operation).outputSchema.additionalProperties.enum?: unknown[]; default: not declared - (operation).outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - (operation).outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - (operation).outputSchema.additionalProperties.format?: string; default: not declared - (operation).outputSchema.additionalProperties.items?: JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.maxItems?: number; default: not declared - (operation).outputSchema.additionalProperties.maxLength?: number; default: not declared - (operation).outputSchema.additionalProperties.maximum?: number; default: not declared - (operation).outputSchema.additionalProperties.minItems?: number; default: not declared - (operation).outputSchema.additionalProperties.minLength?: number; default: not declared - (operation).outputSchema.additionalProperties.minimum?: number; default: not declared - (operation).outputSchema.additionalProperties.multipleOf?: number; default: not declared - (operation).outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.pattern?: string; default: not declared - (operation).outputSchema.additionalProperties.properties?: Record; default: not declared - (operation).outputSchema.additionalProperties.required?: string[]; default: not declared - (operation).outputSchema.additionalProperties.title?: string; default: not declared - (operation).outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (operation).outputSchema.allOf?: JSONSchema[]; default: not declared - (operation).outputSchema.anyOf?: JSONSchema[]; default: not declared - (operation).outputSchema.const?: unknown; default: not declared - (operation).outputSchema.default?: unknown; default: not declared - (operation).outputSchema.description?: string; default: not declared - (operation).outputSchema.enum?: unknown[]; default: not declared - (operation).outputSchema.exclusiveMaximum?: number; default: not declared - (operation).outputSchema.exclusiveMinimum?: number; default: not declared - (operation).outputSchema.format?: string; default: not declared - (operation).outputSchema.items?: JSONSchema; default: not declared - (operation).outputSchema.maxItems?: number; default: not declared - (operation).outputSchema.maxLength?: number; default: not declared - (operation).outputSchema.maximum?: number; default: not declared - (operation).outputSchema.minItems?: number; default: not declared - (operation).outputSchema.minLength?: number; default: not declared - (operation).outputSchema.minimum?: number; default: not declared - (operation).outputSchema.multipleOf?: number; default: not declared - (operation).outputSchema.oneOf?: JSONSchema[]; default: not declared - (operation).outputSchema.pattern?: string; default: not declared - (operation).outputSchema.properties?: Record; default: not declared - (operation).outputSchema.required?: string[]; default: not declared - (operation).outputSchema.title?: string; default: not declared - (operation).outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (operation).requiredCapabilities: readonly string[]; default: not declared - (operation).run: (input: unknown, context: OperationContext) => OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - (operation).sideEffect: OperationSideEffect; default: not declared - (operation).stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - (operation).supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - (operation).title: string; default: not declared - (operation).version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - return.annotations: OperationAnnotations; default: not declared - return.authorization: OperationAuthorization; default: not declared - return.costClass: OperationCostClass; default: not declared - return.description: string; default: not declared - return.deterministic: boolean; default: not declared - return.handleFields: string[]; default: not declared - return.id: string; default: not declared - return.idempotency: OperationIdempotency; default: not declared - return.inputSchema: JSONSchema; default: not declared - return.outputSchema: JSONSchema | null; default: not declared - return.outputSchema.$id?: string; default: not declared - return.outputSchema.$schema?: string; default: not declared - return.outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - return.outputSchema.additionalProperties.$id?: string; default: not declared - return.outputSchema.additionalProperties.$schema?: string; default: not declared - return.outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - return.outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.const?: unknown; default: not declared - return.outputSchema.additionalProperties.default?: unknown; default: not declared - return.outputSchema.additionalProperties.description?: string; default: not declared - return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - return.outputSchema.additionalProperties.format?: string; default: not declared - return.outputSchema.additionalProperties.items?: JSONSchema; default: not declared - return.outputSchema.additionalProperties.maxItems?: number; default: not declared - return.outputSchema.additionalProperties.maxLength?: number; default: not declared - return.outputSchema.additionalProperties.maximum?: number; default: not declared - return.outputSchema.additionalProperties.minItems?: number; default: not declared - return.outputSchema.additionalProperties.minLength?: number; default: not declared - return.outputSchema.additionalProperties.minimum?: number; default: not declared - return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - return.outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.pattern?: string; default: not declared - return.outputSchema.additionalProperties.properties?: Record; default: not declared - return.outputSchema.additionalProperties.required?: string[]; default: not declared - return.outputSchema.additionalProperties.title?: string; default: not declared - return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.outputSchema.allOf?: JSONSchema[]; default: not declared - return.outputSchema.anyOf?: JSONSchema[]; default: not declared - return.outputSchema.const?: unknown; default: not declared - return.outputSchema.default?: unknown; default: not declared - return.outputSchema.description?: string; default: not declared - return.outputSchema.enum?: unknown[]; default: not declared - return.outputSchema.exclusiveMaximum?: number; default: not declared - return.outputSchema.exclusiveMinimum?: number; default: not declared - return.outputSchema.format?: string; default: not declared - return.outputSchema.items?: JSONSchema; default: not declared - return.outputSchema.maxItems?: number; default: not declared - return.outputSchema.maxLength?: number; default: not declared - return.outputSchema.maximum?: number; default: not declared - return.outputSchema.minItems?: number; default: not declared - return.outputSchema.minLength?: number; default: not declared - return.outputSchema.minimum?: number; default: not declared - return.outputSchema.multipleOf?: number; default: not declared - return.outputSchema.oneOf?: JSONSchema[]; default: not declared - return.outputSchema.pattern?: string; default: not declared - return.outputSchema.properties?: Record; default: not declared - return.outputSchema.required?: string[]; default: not declared - return.outputSchema.title?: string; default: not declared - return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.requiredCapabilities: string[]; default: not declared - return.sideEffect: OperationSideEffect; default: not declared - return.stochastic: boolean | 'per-call'; default: not declared - return.supportsCancellation: boolean; default: not declared - return.title: string; default: not declared - return.version: string; default: not declared ### @insiderfinance/totalfinance/workflows#extendObjectSchema Kind: function; stability: preview (pre-1.0). ```typescript export declare function extendObjectSchema(base: Schema, extension: Schema): Schema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (base): Schema; default: not declared - (base).describe: (description: string) => Schema; default: not declared - (base).isOptional: boolean; default: not declared - (base).kind: string; default: not declared - (base).optional: () => Schema; default: not declared - (base).parse: (input: unknown, options?: ParseOptions) => B; default: not declared - (base).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - (base).toJSONSchema: () => JSONSchema; default: not declared - (base).~standard: StandardSchemaV1Props; default: not declared - (extension): Schema; default: not declared - (extension).describe: (description: string) => Schema; default: not declared - (extension).isOptional: boolean; default: not declared - (extension).kind: string; default: not declared - (extension).optional: () => Schema; default: not declared - (extension).parse: (input: unknown, options?: ParseOptions) => E; default: not declared - (extension).safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - (extension).toJSONSchema: () => JSONSchema; default: not declared - (extension).~standard: StandardSchemaV1Props; default: not declared - return.describe: (description: string) => Schema; default: not declared - return.isOptional: boolean; default: not declared - return.kind: string; default: not declared - return.optional: () => Schema<(B & E) | undefined>; default: not declared - return.parse: (input: unknown, options?: ParseOptions) => B & E; default: not declared - return.safeParse: (input: unknown, options?: ParseOptions) => SafeParseResult; default: not declared - return.toJSONSchema: () => JSONSchema; default: not declared - return.~standard: StandardSchemaV1Props; default: not declared ### @insiderfinance/totalfinance/workflows#fixedIncomePack Kind: function; stability: preview (pre-1.0). The fixed-income pack (P3.7): bond analytics. The pack id is `fixed_income`, matching the `totalfinance.fixed_income.*` tool prefix. It was `fixed-income` while its tools were `fixed_income` — one identity spelled two ways on the wire, so a client selecting packs by name could not derive the name from the tools it saw. Renamed as a pre-1.0 clean break rather than aliased: two spellings is the defect. ```typescript export declare function fixedIncomePack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#handleUriOf Kind: function; stability: preview (pre-1.0). The uri of a handle: `totalfinance:///` — content hash for data, the job id for a job. ```typescript export declare function handleUriOf(kind: ResourceHandleKind, id: string): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (id): string; default: not declared - (kind): ResourceHandleKind; default: not declared ### @insiderfinance/totalfinance/workflows#journeyOperations Kind: function; stability: preview (pre-1.0). Every journey operation across the four journey packs, flattened. ```typescript export declare function journeyOperations(): TotalFinanceOperation[]; ``` ### @insiderfinance/totalfinance/workflows#journeyPacks Kind: function; stability: preview (pre-1.0). The five journey packs — opt-in beside the ten domain packs (Decision 9 counts them apart from the twenty-three defaults; Stage 4.7 slice 2 added the valuation pack): `createOperationRegistry({ packs: [...defaultPacks(), ...journeyPacks()] })`. ```typescript export declare function journeyPacks(): OperationPack[]; ``` ### @insiderfinance/totalfinance/workflows#jsonSafe Kind: function; stability: preview (pre-1.0). JSON-safe normalization of a structured result: every non-finite number (NaN, ±Infinity — a non-converged inversion, an indicator warmup) becomes `null` at the source, so an in-process result and its JSON mirror agree and both validate against the advertised output schema. ```typescript export declare function jsonSafe(value: unknown): unknown; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (value): unknown; default: not declared ### @insiderfinance/totalfinance/workflows#missingCapabilities Kind: function; stability: preview (pre-1.0). The required capabilities the caller does not hold, sorted — the runtime's gate. Both lists are validated. ```typescript export declare function missingCapabilities(required: readonly string[], capabilities: readonly string[]): string[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (capabilities): readonly string[]; default: not declared - (required): readonly string[]; default: not declared ### @insiderfinance/totalfinance/workflows#operationAnnotations Kind: function; stability: preview (pre-1.0). Annotations are a pure function of the effect metadata — the one place a transport hint is decided. ```typescript export declare function operationAnnotations(operation: Pick): OperationAnnotations; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (operation): Pick>, 'sideEffect' | 'idempotency' | 'requiredCapabilities'>; default: not declared - (operation).idempotency: OperationIdempotency; default: not declared - (operation).requiredCapabilities: readonly string[]; default: not declared - (operation).sideEffect: OperationSideEffect; default: not declared - return.destructiveHint: boolean; default: not declared - return.idempotentHint: boolean; default: not declared - return.openWorldHint: boolean; default: not declared - return.readOnlyHint: boolean; default: not declared ### @insiderfinance/totalfinance/workflows#operationResultSchema Kind: function; stability: preview (pre-1.0). The `OperationResult` envelope as JSON Schema: operation and library identity, the summary, the structured output (or its spilled handle), assumptions, diagnostics with status, identity, the artifact handles, usage and trace. ```typescript export declare function operationResultSchema(input?: OperationResultSchemaInput): JSONSchema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input)?: OperationResultSchemaInput; default: not declared - (input).handle?: JSONSchema | undefined; default: not declared — How to refer to a resource handle — inline by default, or a `$ref` inside an OpenAPI document. - (input).handle.$id?: string; default: not declared - (input).handle.$schema?: string; default: not declared - (input).handle.additionalProperties?: boolean | JSONSchema; default: not declared - (input).handle.additionalProperties.$id?: string; default: not declared - (input).handle.additionalProperties.$schema?: string; default: not declared - (input).handle.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - (input).handle.additionalProperties.allOf?: JSONSchema[]; default: not declared - (input).handle.additionalProperties.anyOf?: JSONSchema[]; default: not declared - (input).handle.additionalProperties.const?: unknown; default: not declared - (input).handle.additionalProperties.default?: unknown; default: not declared - (input).handle.additionalProperties.description?: string; default: not declared - (input).handle.additionalProperties.enum?: unknown[]; default: not declared - (input).handle.additionalProperties.exclusiveMaximum?: number; default: not declared - (input).handle.additionalProperties.exclusiveMinimum?: number; default: not declared - (input).handle.additionalProperties.format?: string; default: not declared - (input).handle.additionalProperties.items?: JSONSchema; default: not declared - (input).handle.additionalProperties.maxItems?: number; default: not declared - (input).handle.additionalProperties.maxLength?: number; default: not declared - (input).handle.additionalProperties.maximum?: number; default: not declared - (input).handle.additionalProperties.minItems?: number; default: not declared - (input).handle.additionalProperties.minLength?: number; default: not declared - (input).handle.additionalProperties.minimum?: number; default: not declared - (input).handle.additionalProperties.multipleOf?: number; default: not declared - (input).handle.additionalProperties.oneOf?: JSONSchema[]; default: not declared - (input).handle.additionalProperties.pattern?: string; default: not declared - (input).handle.additionalProperties.properties?: Record; default: not declared - (input).handle.additionalProperties.required?: string[]; default: not declared - (input).handle.additionalProperties.title?: string; default: not declared - (input).handle.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (input).handle.allOf?: JSONSchema[]; default: not declared - (input).handle.anyOf?: JSONSchema[]; default: not declared - (input).handle.const?: unknown; default: not declared - (input).handle.default?: unknown; default: not declared - (input).handle.description?: string; default: not declared - (input).handle.enum?: unknown[]; default: not declared - (input).handle.exclusiveMaximum?: number; default: not declared - (input).handle.exclusiveMinimum?: number; default: not declared - (input).handle.format?: string; default: not declared - (input).handle.items?: JSONSchema; default: not declared - (input).handle.maxItems?: number; default: not declared - (input).handle.maxLength?: number; default: not declared - (input).handle.maximum?: number; default: not declared - (input).handle.minItems?: number; default: not declared - (input).handle.minLength?: number; default: not declared - (input).handle.minimum?: number; default: not declared - (input).handle.multipleOf?: number; default: not declared - (input).handle.oneOf?: JSONSchema[]; default: not declared - (input).handle.pattern?: string; default: not declared - (input).handle.properties?: Record; default: not declared - (input).handle.required?: string[]; default: not declared - (input).handle.title?: string; default: not declared - (input).handle.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (input).structured?: JSONSchema | undefined; default: not declared — The operation's own structured-output schema, or an open object when it declares none. - (input).structured.$id?: string; default: not declared - (input).structured.$schema?: string; default: not declared - (input).structured.additionalProperties?: boolean | JSONSchema; default: not declared - (input).structured.additionalProperties.$id?: string; default: not declared - (input).structured.additionalProperties.$schema?: string; default: not declared - (input).structured.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - (input).structured.additionalProperties.allOf?: JSONSchema[]; default: not declared - (input).structured.additionalProperties.anyOf?: JSONSchema[]; default: not declared - (input).structured.additionalProperties.const?: unknown; default: not declared - (input).structured.additionalProperties.default?: unknown; default: not declared - (input).structured.additionalProperties.description?: string; default: not declared - (input).structured.additionalProperties.enum?: unknown[]; default: not declared - (input).structured.additionalProperties.exclusiveMaximum?: number; default: not declared - (input).structured.additionalProperties.exclusiveMinimum?: number; default: not declared - (input).structured.additionalProperties.format?: string; default: not declared - (input).structured.additionalProperties.items?: JSONSchema; default: not declared - (input).structured.additionalProperties.maxItems?: number; default: not declared - (input).structured.additionalProperties.maxLength?: number; default: not declared - (input).structured.additionalProperties.maximum?: number; default: not declared - (input).structured.additionalProperties.minItems?: number; default: not declared - (input).structured.additionalProperties.minLength?: number; default: not declared - (input).structured.additionalProperties.minimum?: number; default: not declared - (input).structured.additionalProperties.multipleOf?: number; default: not declared - (input).structured.additionalProperties.oneOf?: JSONSchema[]; default: not declared - (input).structured.additionalProperties.pattern?: string; default: not declared - (input).structured.additionalProperties.properties?: Record; default: not declared - (input).structured.additionalProperties.required?: string[]; default: not declared - (input).structured.additionalProperties.title?: string; default: not declared - (input).structured.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (input).structured.allOf?: JSONSchema[]; default: not declared - (input).structured.anyOf?: JSONSchema[]; default: not declared - (input).structured.const?: unknown; default: not declared - (input).structured.default?: unknown; default: not declared - (input).structured.description?: string; default: not declared - (input).structured.enum?: unknown[]; default: not declared - (input).structured.exclusiveMaximum?: number; default: not declared - (input).structured.exclusiveMinimum?: number; default: not declared - (input).structured.format?: string; default: not declared - (input).structured.items?: JSONSchema; default: not declared - (input).structured.maxItems?: number; default: not declared - (input).structured.maxLength?: number; default: not declared - (input).structured.maximum?: number; default: not declared - (input).structured.minItems?: number; default: not declared - (input).structured.minLength?: number; default: not declared - (input).structured.minimum?: number; default: not declared - (input).structured.multipleOf?: number; default: not declared - (input).structured.oneOf?: JSONSchema[]; default: not declared - (input).structured.pattern?: string; default: not declared - (input).structured.properties?: Record; default: not declared - (input).structured.required?: string[]; default: not declared - (input).structured.title?: string; default: not declared - (input).structured.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.$id?: string; default: not declared - return.$schema?: string; default: not declared - return.additionalProperties?: boolean | JSONSchema; default: not declared - return.additionalProperties.$id?: string; default: not declared - return.additionalProperties.$schema?: string; default: not declared - return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - return.additionalProperties.allOf?: JSONSchema[]; default: not declared - return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - return.additionalProperties.const?: unknown; default: not declared - return.additionalProperties.default?: unknown; default: not declared - return.additionalProperties.description?: string; default: not declared - return.additionalProperties.enum?: unknown[]; default: not declared - return.additionalProperties.exclusiveMaximum?: number; default: not declared - return.additionalProperties.exclusiveMinimum?: number; default: not declared - return.additionalProperties.format?: string; default: not declared - return.additionalProperties.items?: JSONSchema; default: not declared - return.additionalProperties.maxItems?: number; default: not declared - return.additionalProperties.maxLength?: number; default: not declared - return.additionalProperties.maximum?: number; default: not declared - return.additionalProperties.minItems?: number; default: not declared - return.additionalProperties.minLength?: number; default: not declared - return.additionalProperties.minimum?: number; default: not declared - return.additionalProperties.multipleOf?: number; default: not declared - return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - return.additionalProperties.pattern?: string; default: not declared - return.additionalProperties.properties?: Record; default: not declared - return.additionalProperties.required?: string[]; default: not declared - return.additionalProperties.title?: string; default: not declared - return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.allOf?: JSONSchema[]; default: not declared - return.anyOf?: JSONSchema[]; default: not declared - return.const?: unknown; default: not declared - return.default?: unknown; default: not declared - return.description?: string; default: not declared - return.enum?: unknown[]; default: not declared - return.exclusiveMaximum?: number; default: not declared - return.exclusiveMinimum?: number; default: not declared - return.format?: string; default: not declared - return.items?: JSONSchema; default: not declared - return.maxItems?: number; default: not declared - return.maxLength?: number; default: not declared - return.maximum?: number; default: not declared - return.minItems?: number; default: not declared - return.minLength?: number; default: not declared - return.minimum?: number; default: not declared - return.multipleOf?: number; default: not declared - return.oneOf?: JSONSchema[]; default: not declared - return.pattern?: string; default: not declared - return.properties?: Record; default: not declared - return.required?: string[]; default: not declared - return.title?: string; default: not declared - return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared ### @insiderfinance/totalfinance/workflows#optionsPack Kind: function; stability: preview (pre-1.0). The default read-only tools, grouped into ten domain packs (dx §5.3). Each pack can be enabled on its own — `createTotalFinanceMcpServer({ packs: [optionsPack(), technicalAnalysisPack()] })` exposes only those domains instead of the full set — so an agent that only needs option math isn't handed the full set. `t.length` and the domain count are DERIVED from this one list, so the docs' "N read-only tools across N packs" can never drift (a conformance test pins the doc numbers to `defaultTools()`/`defaultPacks()`). ```typescript export declare function optionsPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#parseHandleUri Kind: function; stability: preview (pre-1.0). Parse a handle uri into its kind and id; a malformed uri is refused with the grammar. ```typescript export declare function parseHandleUri(uri: string): { kind: ResourceHandleKind; id: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (uri): string; default: not declared - return.id: string; default: not declared - return.kind: ResourceHandleKind; default: not declared ### @insiderfinance/totalfinance/workflows#performancePack Kind: function; stability: preview (pre-1.0). ```typescript export declare function performancePack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#portfolioPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function portfolioPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#requireArtifactListFilter Kind: function; stability: preview (pre-1.0). Validate a `list` filter (shared by every store). ```typescript export declare function requireArtifactListFilter(functionName: string, filter: unknown): { kind?: ResourceHandleKind; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (filter): unknown; default: not declared - (functionName): string; default: not declared - return.kind?: ResourceHandleKind; default: not declared ### @insiderfinance/totalfinance/workflows#requireArtifactPut Kind: function; stability: preview (pre-1.0). Validate a `put` request and derive the handle it would mint (shared by every store). ```typescript export declare function requireArtifactPut(functionName: string, input: unknown): { handle: ResourceHandle; canonical: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (input): unknown; default: not declared - return.canonical: string; default: not declared - return.handle: ResourceHandle; default: not declared ### @insiderfinance/totalfinance/workflows#requireAuthorizationPut Kind: function; stability: preview (pre-1.0). ```typescript export declare function requireAuthorizationPut(functionName: string, input: unknown): { grant: AuthorizationGrant; handle: ResourceHandle; canonical: string; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (input): unknown; default: not declared - return.canonical: string; default: not declared - return.grant: AuthorizationGrant; default: not declared - return.handle: ResourceHandle; default: not declared ### @insiderfinance/totalfinance/workflows#requireCapabilities Kind: function; stability: preview (pre-1.0). ```typescript export declare function requireCapabilities(functionName: string, field: string, value: unknown): readonly string[]; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/workflows#requireJobRecord Kind: function; stability: preview (pre-1.0). The closed structural guard for a job record (shared by every store). ```typescript export declare function requireJobRecord(functionName: string, field: string, value: unknown): JobRecord; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared - return.error: OperationError | null; default: not declared - return.error.code: string; default: not declared - return.error.context: Record; default: not declared - return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - return.error.message: string; default: not declared - return.error.operation: { id: string; version: string; } | null; default: not declared - return.error.operation.id: string; default: not declared - return.error.operation.version: string; default: not declared - return.finishedAt: string | null; default: not declared - return.id: string; default: not declared - return.inputsHash: string; default: not declared - return.operation: { id: string; version: string; }; default: not declared - return.operation.id: string; default: not declared - return.operation.version: string; default: not declared - return.progress: { fraction: number | null; stage: string; } | null; default: not declared - return.progress.fraction: number | null; default: not declared - return.progress.stage: string; default: not declared - return.result: ResourceHandle | null; default: not declared - return.result.contentHash: string | null; default: not declared - return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - return.result.kind: ResourceHandleKind; default: not declared - return.result.provenance: Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - return.result.schema: string; default: not declared - return.result.uri: string; default: not declared - return.result.version: string; default: not declared - return.seed: number | null; default: not declared - return.startedAt: string | null; default: not declared - return.state: JobState; default: not declared - return.submittedAt: string; default: not declared - return.usage: { elapsedMs: number | null; }; default: not declared - return.usage.elapsedMs: number | null; default: not declared ### @insiderfinance/totalfinance/workflows#requireJournalAppend Kind: function; stability: preview (pre-1.0). ```typescript export declare function requireJournalAppend(functionName: string, input: unknown): { journalId: string; events: ExecutionJournalEvent[]; }; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (input): unknown; default: not declared - return.events: ExecutionJournalEvent[]; default: not declared - return.journalId: string; default: not declared ### @insiderfinance/totalfinance/workflows#requireJournalId Kind: function; stability: preview (pre-1.0). ```typescript export declare function requireJournalId(functionName: string, value: unknown): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/workflows#requireOperation Kind: function; stability: preview (pre-1.0). Prove a value is a COMPLETE operation (the shape `defineOperation` returns): closed keys, every member typed. The one guard every door that receives an operation applies — a hand-assembled object with a missing member or a null effect field never reaches a registry or a transport. ```typescript export declare function requireOperation(functionName: string, field: string, value: unknown): TotalFinanceOperation; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared - return.authorization: OperationAuthorization; default: not declared - return.costClass: OperationCostClass; default: not declared - return.description: string; default: not declared - return.deterministic: boolean; default: not declared - return.handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - return.id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - return.idempotency: OperationIdempotency; default: not declared - return.inputSchema: Schema; default: not declared - return.outputSchema: JSONSchema | null; default: not declared - return.outputSchema.$id?: string; default: not declared - return.outputSchema.$schema?: string; default: not declared - return.outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - return.outputSchema.additionalProperties.$id?: string; default: not declared - return.outputSchema.additionalProperties.$schema?: string; default: not declared - return.outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - return.outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.const?: unknown; default: not declared - return.outputSchema.additionalProperties.default?: unknown; default: not declared - return.outputSchema.additionalProperties.description?: string; default: not declared - return.outputSchema.additionalProperties.enum?: unknown[]; default: not declared - return.outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - return.outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - return.outputSchema.additionalProperties.format?: string; default: not declared - return.outputSchema.additionalProperties.items?: JSONSchema; default: not declared - return.outputSchema.additionalProperties.maxItems?: number; default: not declared - return.outputSchema.additionalProperties.maxLength?: number; default: not declared - return.outputSchema.additionalProperties.maximum?: number; default: not declared - return.outputSchema.additionalProperties.minItems?: number; default: not declared - return.outputSchema.additionalProperties.minLength?: number; default: not declared - return.outputSchema.additionalProperties.minimum?: number; default: not declared - return.outputSchema.additionalProperties.multipleOf?: number; default: not declared - return.outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - return.outputSchema.additionalProperties.pattern?: string; default: not declared - return.outputSchema.additionalProperties.properties?: Record; default: not declared - return.outputSchema.additionalProperties.required?: string[]; default: not declared - return.outputSchema.additionalProperties.title?: string; default: not declared - return.outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.outputSchema.allOf?: JSONSchema[]; default: not declared - return.outputSchema.anyOf?: JSONSchema[]; default: not declared - return.outputSchema.const?: unknown; default: not declared - return.outputSchema.default?: unknown; default: not declared - return.outputSchema.description?: string; default: not declared - return.outputSchema.enum?: unknown[]; default: not declared - return.outputSchema.exclusiveMaximum?: number; default: not declared - return.outputSchema.exclusiveMinimum?: number; default: not declared - return.outputSchema.format?: string; default: not declared - return.outputSchema.items?: JSONSchema; default: not declared - return.outputSchema.maxItems?: number; default: not declared - return.outputSchema.maxLength?: number; default: not declared - return.outputSchema.maximum?: number; default: not declared - return.outputSchema.minItems?: number; default: not declared - return.outputSchema.minLength?: number; default: not declared - return.outputSchema.minimum?: number; default: not declared - return.outputSchema.multipleOf?: number; default: not declared - return.outputSchema.oneOf?: JSONSchema[]; default: not declared - return.outputSchema.pattern?: string; default: not declared - return.outputSchema.properties?: Record; default: not declared - return.outputSchema.required?: string[]; default: not declared - return.outputSchema.title?: string; default: not declared - return.outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.requiredCapabilities: readonly string[]; default: not declared - return.run: (input: unknown, context: OperationContext) => OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - return.sideEffect: OperationSideEffect; default: not declared - return.stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - return.supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - return.title: string; default: not declared - return.version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). ### @insiderfinance/totalfinance/workflows#requireResourceHandle Kind: function; stability: preview (pre-1.0). The closed structural guard for a caller-supplied handle (core's guard order). ```typescript export declare function requireResourceHandle(functionName: string, field: string, value: unknown): asserts value is ResourceHandle; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (field): string; default: not declared - (functionName): string; default: not declared - (value): unknown; default: not declared ### @insiderfinance/totalfinance/workflows#researchPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function researchPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#riskPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function riskPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#runOperation Kind: function; stability: preview (pre-1.0). ```typescript export declare function runOperation>(request: RunOperationInput): OperationResult; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (request): RunOperationInput; default: not declared - (request).artifacts?: ArtifactStore | ArtifactStoreReader; default: not declared — The store handles in the input resolve through (`operation.handleFields`). A WRITABLE store (`put`) also receives a result whose canonical bytes exceed `inlineResultBytes`; that needs `createdTimestampMs` — the caller's clock, never the library's. - (request).artifacts.get: (uri: string) => { handle: ResourceHandle; value: Record; } | null; default: not declared - (request).artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => ResourceHandle[]; default: not declared - (request).artifacts.put: (input: import('@insiderfinance/totalfinance/workflows').ArtifactStorePutInput) => ResourceHandle; default: not declared - (request).capabilities?: readonly string[]; default: not declared — What the caller holds (Stage 7B.2 Decision 9); default DEFAULT_CAPABILITIES (read, analyze, propose). - (request).createdTimestampMs?: number; default: not declared — Epoch ms stamped on a spilled result's handle (the caller's clock); required with a writable store. - (request).deadlineMs?: number; default: not declared — Post-hoc wall-clock verdict for an inline run (ms); a job runner pre-empts instead. - (request).defaultSeed?: number; default: not declared — Injected for a stochastic call that omits its seed; echoed under `assumptions.seed` (default 0). - (request).inlineResultBytes?: number; default: not declared — Spill threshold in canonical bytes (default 256 KiB); only meaningful with a writable store. - (request).input: unknown; default: not declared — The raw request as the caller (or the wire) supplied it — validated here, never trusted. - (request).maxInputBytes?: number; default: not declared — Reject a call whose serialized input exceeds this many UTF-8 bytes; omitted ⇒ no byte budget (the operation's row caps still bound work). - (request).now?: () => number; default: not declared — Elapsed-time source for `usage` only — never for a result. Defaults to `Date.now`. - (request).operation: TotalFinanceOperation; default: not declared - (request).requestId?: string; default: not declared - (request).signal?: OperationSignal; default: not declared - (request).stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10): authorization grants and execution journals. - (request).stores.authorization?: AuthorizationStore; default: not declared - (request).stores.journal?: ExecutionJournalStore; default: not declared - return.artifacts: ResourceHandle[]; default: not declared - return.assumptions: Record; default: not declared - return.diagnostics: { incomplete: string[]; status: 'complete' | 'partial'; warnings: QuantWarning[]; }; default: not declared - return.diagnostics.incomplete: string[]; default: not declared - return.diagnostics.status: 'complete' | 'partial'; default: not declared - return.diagnostics.warnings: QuantWarning[]; default: not declared - return.identity: { artifactIds: string[]; inputsHash: string; snapshotHash: string | null; }; default: not declared - return.identity.artifactIds: string[]; default: not declared - return.identity.inputsHash: string; default: not declared - return.identity.snapshotHash: string | null; default: not declared - return.library: { version: string; }; default: not declared - return.library.version: string; default: not declared - return.operation: { id: string; version: string; }; default: not declared - return.operation.id: string; default: not declared - return.operation.version: string; default: not declared - return.structured: Output; default: not declared - return.summary: string; default: not declared - return.trace: { requestId: string | null; }; default: not declared - return.trace.requestId: string | null; default: not declared - return.usage: { elapsedMs: number | null; inputBytes: number; }; default: not declared - return.usage.elapsedMs: number | null; default: not declared - return.usage.inputBytes: number; default: not declared ### @insiderfinance/totalfinance/workflows#scenarioPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function scenarioPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#spilledResultSchema Kind: function; stability: preview (pre-1.0). The `structured` slot of a result that exceeded the caller's inline byte budget: the runtime stored the full output as a report and answered with its handle and a bounded preview. ```typescript export declare function spilledResultSchema(handle?: JSONSchema): JSONSchema; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (handle)?: JSONSchema; default: not declared - (handle).$id?: string; default: not declared - (handle).$schema?: string; default: not declared - (handle).additionalProperties?: boolean | JSONSchema; default: not declared - (handle).additionalProperties.$id?: string; default: not declared - (handle).additionalProperties.$schema?: string; default: not declared - (handle).additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - (handle).additionalProperties.allOf?: JSONSchema[]; default: not declared - (handle).additionalProperties.anyOf?: JSONSchema[]; default: not declared - (handle).additionalProperties.const?: unknown; default: not declared - (handle).additionalProperties.default?: unknown; default: not declared - (handle).additionalProperties.description?: string; default: not declared - (handle).additionalProperties.enum?: unknown[]; default: not declared - (handle).additionalProperties.exclusiveMaximum?: number; default: not declared - (handle).additionalProperties.exclusiveMinimum?: number; default: not declared - (handle).additionalProperties.format?: string; default: not declared - (handle).additionalProperties.items?: JSONSchema; default: not declared - (handle).additionalProperties.maxItems?: number; default: not declared - (handle).additionalProperties.maxLength?: number; default: not declared - (handle).additionalProperties.maximum?: number; default: not declared - (handle).additionalProperties.minItems?: number; default: not declared - (handle).additionalProperties.minLength?: number; default: not declared - (handle).additionalProperties.minimum?: number; default: not declared - (handle).additionalProperties.multipleOf?: number; default: not declared - (handle).additionalProperties.oneOf?: JSONSchema[]; default: not declared - (handle).additionalProperties.pattern?: string; default: not declared - (handle).additionalProperties.properties?: Record; default: not declared - (handle).additionalProperties.required?: string[]; default: not declared - (handle).additionalProperties.title?: string; default: not declared - (handle).additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (handle).allOf?: JSONSchema[]; default: not declared - (handle).anyOf?: JSONSchema[]; default: not declared - (handle).const?: unknown; default: not declared - (handle).default?: unknown; default: not declared - (handle).description?: string; default: not declared - (handle).enum?: unknown[]; default: not declared - (handle).exclusiveMaximum?: number; default: not declared - (handle).exclusiveMinimum?: number; default: not declared - (handle).format?: string; default: not declared - (handle).items?: JSONSchema; default: not declared - (handle).maxItems?: number; default: not declared - (handle).maxLength?: number; default: not declared - (handle).maximum?: number; default: not declared - (handle).minItems?: number; default: not declared - (handle).minLength?: number; default: not declared - (handle).minimum?: number; default: not declared - (handle).multipleOf?: number; default: not declared - (handle).oneOf?: JSONSchema[]; default: not declared - (handle).pattern?: string; default: not declared - (handle).properties?: Record; default: not declared - (handle).required?: string[]; default: not declared - (handle).title?: string; default: not declared - (handle).type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.$id?: string; default: not declared - return.$schema?: string; default: not declared - return.additionalProperties?: boolean | JSONSchema; default: not declared - return.additionalProperties.$id?: string; default: not declared - return.additionalProperties.$schema?: string; default: not declared - return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - return.additionalProperties.allOf?: JSONSchema[]; default: not declared - return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - return.additionalProperties.const?: unknown; default: not declared - return.additionalProperties.default?: unknown; default: not declared - return.additionalProperties.description?: string; default: not declared - return.additionalProperties.enum?: unknown[]; default: not declared - return.additionalProperties.exclusiveMaximum?: number; default: not declared - return.additionalProperties.exclusiveMinimum?: number; default: not declared - return.additionalProperties.format?: string; default: not declared - return.additionalProperties.items?: JSONSchema; default: not declared - return.additionalProperties.maxItems?: number; default: not declared - return.additionalProperties.maxLength?: number; default: not declared - return.additionalProperties.maximum?: number; default: not declared - return.additionalProperties.minItems?: number; default: not declared - return.additionalProperties.minLength?: number; default: not declared - return.additionalProperties.minimum?: number; default: not declared - return.additionalProperties.multipleOf?: number; default: not declared - return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - return.additionalProperties.pattern?: string; default: not declared - return.additionalProperties.properties?: Record; default: not declared - return.additionalProperties.required?: string[]; default: not declared - return.additionalProperties.title?: string; default: not declared - return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - return.allOf?: JSONSchema[]; default: not declared - return.anyOf?: JSONSchema[]; default: not declared - return.const?: unknown; default: not declared - return.default?: unknown; default: not declared - return.description?: string; default: not declared - return.enum?: unknown[]; default: not declared - return.exclusiveMaximum?: number; default: not declared - return.exclusiveMinimum?: number; default: not declared - return.format?: string; default: not declared - return.items?: JSONSchema; default: not declared - return.maxItems?: number; default: not declared - return.maxLength?: number; default: not declared - return.maximum?: number; default: not declared - return.minItems?: number; default: not declared - return.minLength?: number; default: not declared - return.minimum?: number; default: not declared - return.multipleOf?: number; default: not declared - return.oneOf?: JSONSchema[]; default: not declared - return.pattern?: string; default: not declared - return.properties?: Record; default: not declared - return.required?: string[]; default: not declared - return.title?: string; default: not declared - return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared ### @insiderfinance/totalfinance/workflows#strategyPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function strategyPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#structurePack Kind: function; stability: preview (pre-1.0). ```typescript export declare function structurePack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#technicalAnalysisPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function technicalAnalysisPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#toOperationError Kind: function; stability: preview (pre-1.0). Map any thrown value to the one error shape every transport renders: a QuantError keeps its code, message, and context (a schema refusal keeps its issues); anything else is `operation.internal`. The runtime itself THROWS the typed error (an embedding caller sees the same teaching error the direct SDK call would raise); a transport calls this at its edge. ```typescript export declare function toOperationError(error: unknown, operation: TotalFinanceOperation | null): OperationError; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (error): unknown; default: not declared - (operation): TotalFinanceOperation> | null; default: not declared - (operation).authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - (operation).costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - (operation).description: string; default: not declared - (operation).deterministic: boolean; default: not declared - (operation).handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - (operation).id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - (operation).idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - (operation).inputSchema: import('@insiderfinance/totalfinance/core/schema').Schema; default: not declared - (operation).outputSchema: import('@insiderfinance/totalfinance/core').JSONSchema | null; default: not declared - (operation).outputSchema.$id?: string; default: not declared - (operation).outputSchema.$schema?: string; default: not declared - (operation).outputSchema.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.$id?: string; default: not declared - (operation).outputSchema.additionalProperties.$schema?: string; default: not declared - (operation).outputSchema.additionalProperties.additionalProperties?: boolean | import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.const?: unknown; default: not declared - (operation).outputSchema.additionalProperties.default?: unknown; default: not declared - (operation).outputSchema.additionalProperties.description?: string; default: not declared - (operation).outputSchema.additionalProperties.enum?: unknown[]; default: not declared - (operation).outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - (operation).outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - (operation).outputSchema.additionalProperties.format?: string; default: not declared - (operation).outputSchema.additionalProperties.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.maxItems?: number; default: not declared - (operation).outputSchema.additionalProperties.maxLength?: number; default: not declared - (operation).outputSchema.additionalProperties.maximum?: number; default: not declared - (operation).outputSchema.additionalProperties.minItems?: number; default: not declared - (operation).outputSchema.additionalProperties.minLength?: number; default: not declared - (operation).outputSchema.additionalProperties.minimum?: number; default: not declared - (operation).outputSchema.additionalProperties.multipleOf?: number; default: not declared - (operation).outputSchema.additionalProperties.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.pattern?: string; default: not declared - (operation).outputSchema.additionalProperties.properties?: Record; default: not declared - (operation).outputSchema.additionalProperties.required?: string[]; default: not declared - (operation).outputSchema.additionalProperties.title?: string; default: not declared - (operation).outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (operation).outputSchema.allOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - (operation).outputSchema.anyOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - (operation).outputSchema.const?: unknown; default: not declared - (operation).outputSchema.default?: unknown; default: not declared - (operation).outputSchema.description?: string; default: not declared - (operation).outputSchema.enum?: unknown[]; default: not declared - (operation).outputSchema.exclusiveMaximum?: number; default: not declared - (operation).outputSchema.exclusiveMinimum?: number; default: not declared - (operation).outputSchema.format?: string; default: not declared - (operation).outputSchema.items?: import('@insiderfinance/totalfinance/core').JSONSchema; default: not declared - (operation).outputSchema.maxItems?: number; default: not declared - (operation).outputSchema.maxLength?: number; default: not declared - (operation).outputSchema.maximum?: number; default: not declared - (operation).outputSchema.minItems?: number; default: not declared - (operation).outputSchema.minLength?: number; default: not declared - (operation).outputSchema.minimum?: number; default: not declared - (operation).outputSchema.multipleOf?: number; default: not declared - (operation).outputSchema.oneOf?: import('@insiderfinance/totalfinance/core').JSONSchema[]; default: not declared - (operation).outputSchema.pattern?: string; default: not declared - (operation).outputSchema.properties?: Record; default: not declared - (operation).outputSchema.required?: string[]; default: not declared - (operation).outputSchema.title?: string; default: not declared - (operation).outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (operation).requiredCapabilities: readonly string[]; default: not declared - (operation).run: (input: unknown, context: OperationContext) => import('@insiderfinance/totalfinance/workflows').OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - (operation).sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - (operation).stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - (operation).supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - (operation).title: string; default: not declared - (operation).version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - return.code: string; default: not declared - return.context: Record; default: not declared - return.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - return.message: string; default: not declared - return.operation: { id: string; version: string; } | null; default: not declared - return.operation.id: string; default: not declared - return.operation.version: string; default: not declared ### @insiderfinance/totalfinance/workflows#tradePack Kind: function; stability: preview (pre-1.0). ```typescript export declare function tradePack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: import('@insiderfinance/totalfinance/workflows').TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#valuationPack Kind: function; stability: preview (pre-1.0). The company-valuation journey pack — opt-in beside the ten domain packs and the other journey packs. ```typescript export declare function valuationPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ### @insiderfinance/totalfinance/workflows#volatilityPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function volatilityPack(): OperationPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.operations: TotalFinanceOperation>[]; default: not declared ## Entrypoint @insiderfinance/totalfinance/workflows/local ### @insiderfinance/totalfinance/workflows/local#JobRun Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#JobRun`. ### @insiderfinance/totalfinance/workflows/local#JobRunner Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#JobRunner`. ### @insiderfinance/totalfinance/workflows/local#JobSubmission Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#JobSubmission`. ### @insiderfinance/totalfinance/workflows/local#LocalJobRunnerInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#LocalJobRunnerInput`. ### @insiderfinance/totalfinance/workflows/local#REGISTRY_PROFILES Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#REGISTRY_PROFILES`. ### @insiderfinance/totalfinance/workflows/local#RegistryProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#RegistryProfile`. ### @insiderfinance/totalfinance/workflows/local#SubmitJobInput Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#SubmitJobInput`. ### @insiderfinance/totalfinance/workflows/local#cancelJob Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#cancelJob`. ### @insiderfinance/totalfinance/workflows/local#createFileArtifactStore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#createFileArtifactStore`. ### @insiderfinance/totalfinance/workflows/local#createFileAuthorizationStore Kind: function; stability: preview (pre-1.0). The authorization store on disk: `/authorizations/.json` plus an index of handles. ```typescript export declare function createFileAuthorizationStore(input: { directory: string; }): AuthorizationStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { directory: string; }; default: not declared - (input).directory: string; default: not declared - return.consume: (input: GrantConsumption & { hashOrUri: string; }) => GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - return.get: (hashOrUri: string) => { handle: ResourceHandle; grant: AuthorizationGrant; consumed: GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - return.list: () => ResourceHandle[]; default: not declared - return.put: (input: { grant: AuthorizationGrant; createdTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs; }) => ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. ### @insiderfinance/totalfinance/workflows/local#createFileExecutionJournalStore Kind: function; stability: preview (pre-1.0). Journals use `journals/v2/.json` with an identity-checked envelope. Legacy sanitized arrays are read only if ALL embedded IDs match. A successful transaction migrates that snapshot; the legacy file is retained, never overwritten through a colliding ID. Only a fully valid foreign collision is absent; malformed/ambiguous files fail closed. Stop old-version writers before migration: they do not participate in the transaction protocol. ```typescript export declare function createFileExecutionJournalStore(input: { directory: string; }): ExecutionJournalStore; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (input): { directory: string; }; default: not declared - (input).directory: string; default: not declared - return.append: (input: { events: readonly ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - return.list: () => string[]; default: not declared — Every journal id, sorted. - return.read: (journalId: string) => ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - return.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - return.transact: (input: { journalId: string; execute: (prior: readonly ExecutionJournalEvent[]) => { events: readonly ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. ### @insiderfinance/totalfinance/workflows/local#createFileJobStore Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#createFileJobStore`. ### @insiderfinance/totalfinance/workflows/local#createLocalJobRunner Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#createLocalJobRunner`. ### @insiderfinance/totalfinance/workflows/local#packsForProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#packsForProfile`. ### @insiderfinance/totalfinance/workflows/local#registryForProfile Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#registryForProfile`. ### @insiderfinance/totalfinance/workflows/local#submitJob Same declaration, documentation, members and stability as `@insiderfinance/totalfinance/cli#submitJob`. ## Package @insiderfinance/totalfinance-mcp Version: 0.1.5; stability: pre-1.0; component maturity varies (see stability policy). TotalFinance MCP server for AI agents. Read-only by default; explicit capabilities for paper-trading workflows. Entrypoints: `@insiderfinance/totalfinance-mcp` ## Entrypoint @insiderfinance/totalfinance-mcp ### @insiderfinance/totalfinance-mcp#McpServerOptions Kind: interface; stability: preview (pre-1.0). ```typescript export interface McpServerOptions { /** Task selection when neither tools nor packs is supplied. Explicit tools/packs remain exact. */ profile?: RegistryProfile; /** Maximum entries per tools/resources list page: integer 1–100, default 100. */ pageSize?: number; /** Explicit local worker runner; requires its artifact reader. Adds typed job controls, never grants. */ jobs?: JobRunner; /** * An artifact store (Decision 5): input handles resolve through it; permitted reports are listed * as `totalfinance://reports/` resources. With jobs attached, reports for excluded operations * are hidden. A constructor argument — nothing is looked up by "current session". */ artifacts?: ArtifactStoreReader; /** Override the default tool set with an explicit list (the low-level escape hatch). */ tools?: TotalFinanceTool[]; /** * EXACT pack selection (alignment spec P1.1): omitted → the selected profile; provided → exactly * the packs given, nothing implicit. `packs: [optionsPack()]` exposes only the option tools; * expand the defaults with `packs: [...defaultPacks(), backtestPack()]`. When `tools` is also * given, the registry is their union (both are explicit). Pack tools obey the same read-only * filter, seed policy, and budgets as the defaults. */ packs?: (ToolPack | OperationPack)[]; /** * Reject any tool call whose serialized arguments exceed this many bytes (compute-budget guard, * spec §18.5). Default 64 KB. */ maxInputBytes?: number; /** * Financial read-only mode (default `true`): tools flagged `mutates` or requiring a write/approval * capability are filtered out. Explicit artifact storage and job controls are independent. */ readOnly?: boolean; /** What every caller of this server holds (Stage 7B.2 Decision 9); default the runtime's defaults. */ capabilities?: readonly string[]; /** The trade lifecycle's stores (Decision 10). */ stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; /** The instant stamped on a stored result's handle when `artifacts` is writable — the edge's clock (default `new Date().toISOString()`). */ clock?: () => string; /** * Deterministic seed policy (spec §18.5). Any stochastic CALL (Monte Carlo, resampling — a tool's * `stochastic` flag may be a per-call predicate) requires a seed; when absent, this default is * injected and echoed in `structured.assumptions.seed` so MCP results are reproducible. Default 0. * Deterministic calls (e.g. historical/parametric VaR) never get a meaningless seed injected. */ defaultSeed?: number; /** Soft wall-clock budget per tool call (ms). A call exceeding it returns an error. */ deadlineMs?: number; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - artifacts?: ArtifactStoreReader; default: not declared — An artifact store (Decision 5): input handles resolve through it; permitted reports are listed as `totalfinance://reports/` resources. With jobs attached, reports for excluded operations are hidden. A constructor argument — nothing is looked up by "current session". - artifacts.get: (uri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; value: Record; } | null; default: not declared - artifacts.get().return.handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - artifacts.get().return.value: Record; default: not declared - artifacts.get(uri): string; default: not declared - artifacts.list: (filter?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - artifacts.list(filter)?: { kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; } | undefined; default: not declared - artifacts.list(filter).kind?: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - capabilities?: readonly string[]; default: not declared — What every caller of this server holds (Stage 7B.2 Decision 9); default the runtime's defaults. - clock?: () => string; default: not declared — The instant stamped on a stored result's handle when `artifacts` is writable — the edge's clock (default `new Date().toISOString()`). - deadlineMs?: number; default: not declared — Soft wall-clock budget per tool call (ms). A call exceeding it returns an error. - defaultSeed?: number; default: not declared — Deterministic seed policy (spec §18.5). Any stochastic CALL (Monte Carlo, resampling — a tool's `stochastic` flag may be a per-call predicate) requires a seed; when absent, this default is injected and echoed in `structured.assumptions.seed` so MCP results are reproducible. Default 0. Deterministic calls (e.g. historical/parametric VaR) never get a meaningless seed injected. - jobs?: JobRunner; default: not declared — Explicit local worker runner; requires its artifact reader. Adds typed job controls, never grants. - jobs.cancel: (id: string) => import('@insiderfinance/totalfinance/workflows').JobRecord; default: not declared - jobs.cancel().return.error: OperationError | null; default: not declared - jobs.cancel().return.error.code: string; default: not declared - jobs.cancel().return.error.context: Record; default: not declared - jobs.cancel().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.cancel().return.error.message: string; default: not declared - jobs.cancel().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.cancel().return.error.operation.id: string; default: not declared - jobs.cancel().return.error.operation.version: string; default: not declared - jobs.cancel().return.finishedAt: string | null; default: not declared - jobs.cancel().return.id: string; default: not declared - jobs.cancel().return.inputsHash: string; default: not declared - jobs.cancel().return.operation: { id: string; version: string; }; default: not declared - jobs.cancel().return.operation.id: string; default: not declared - jobs.cancel().return.operation.version: string; default: not declared - jobs.cancel().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.cancel().return.progress.fraction: number | null; default: not declared - jobs.cancel().return.progress.stage: string; default: not declared - jobs.cancel().return.result: import('@insiderfinance/totalfinance/workflows').ResourceHandle | null; default: not declared - jobs.cancel().return.result.contentHash: string | null; default: not declared - jobs.cancel().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.cancel().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.cancel().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.cancel().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.cancel().return.result.schema: string; default: not declared - jobs.cancel().return.result.uri: string; default: not declared - jobs.cancel().return.result.version: string; default: not declared - jobs.cancel().return.seed: number | null; default: not declared - jobs.cancel().return.startedAt: string | null; default: not declared - jobs.cancel().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.cancel().return.submittedAt: string; default: not declared - jobs.cancel().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.cancel().return.usage.elapsedMs: number | null; default: not declared - jobs.cancel(id): string; default: not declared - jobs.get: (id: string) => import('@insiderfinance/totalfinance/workflows').JobRecord | null; default: not declared - jobs.get().return.error: OperationError | null; default: not declared - jobs.get().return.error.code: string; default: not declared - jobs.get().return.error.context: Record; default: not declared - jobs.get().return.error.issues?: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - jobs.get().return.error.message: string; default: not declared - jobs.get().return.error.operation: { id: string; version: string; } | null; default: not declared - jobs.get().return.error.operation.id: string; default: not declared - jobs.get().return.error.operation.version: string; default: not declared - jobs.get().return.finishedAt: string | null; default: not declared - jobs.get().return.id: string; default: not declared - jobs.get().return.inputsHash: string; default: not declared - jobs.get().return.operation: { id: string; version: string; }; default: not declared - jobs.get().return.operation.id: string; default: not declared - jobs.get().return.operation.version: string; default: not declared - jobs.get().return.progress: { fraction: number | null; stage: string; } | null; default: not declared - jobs.get().return.progress.fraction: number | null; default: not declared - jobs.get().return.progress.stage: string; default: not declared - jobs.get().return.result: import('@insiderfinance/totalfinance/workflows').ResourceHandle | null; default: not declared - jobs.get().return.result.contentHash: string | null; default: not declared - jobs.get().return.result.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - jobs.get().return.result.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - jobs.get().return.result.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - jobs.get().return.result.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - jobs.get().return.result.schema: string; default: not declared - jobs.get().return.result.uri: string; default: not declared - jobs.get().return.result.version: string; default: not declared - jobs.get().return.seed: number | null; default: not declared - jobs.get().return.startedAt: string | null; default: not declared - jobs.get().return.state: import('@insiderfinance/totalfinance/workflows').JobState; default: not declared - jobs.get().return.submittedAt: string; default: not declared - jobs.get().return.usage: { elapsedMs: number | null; }; default: not declared - jobs.get().return.usage.elapsedMs: number | null; default: not declared - jobs.get(id): string; default: not declared - jobs.list: () => import('@insiderfinance/totalfinance/workflows').JobRecord[]; default: not declared - jobs.submit: (submission: import('@insiderfinance/totalfinance/workflows/local').JobSubmission) => import('@insiderfinance/totalfinance/workflows/local').JobRun; default: not declared - jobs.submit().return.cancel: () => Promise; default: not declared — Terminate the worker now; resolves with the cancelled (or already terminal) record. - jobs.submit().return.completion: Promise; default: not declared — Resolves with the terminal record — completed, failed, or cancelled. Never rejects. - jobs.submit().return.record: import('@insiderfinance/totalfinance/workflows').JobRecord; default: not declared — The record as accepted (or, for an inline non-job operation, as completed). - jobs.submit(submission): import('@insiderfinance/totalfinance/workflows/local').JobSubmission; default: not declared - jobs.submit(submission).deadlineMs?: number; default: not declared - jobs.submit(submission).id: string; default: not declared — The operation id. - jobs.submit(submission).inlineResultBytes?: number; default: not declared - jobs.submit(submission).input: unknown; default: not declared - jobs.submit(submission).maxInputBytes?: number; default: not declared - jobs.submit(submission).requestId?: string; default: not declared - jobs.submit(submission).seed?: number; default: not declared - maxInputBytes?: number; default: not declared — Reject any tool call whose serialized arguments exceed this many bytes (compute-budget guard, spec §18.5). Default 64 KB. - packs?: (OperationPack | ToolPack)[]; default: not declared — EXACT pack selection (alignment spec P1.1): omitted → the selected profile; provided → exactly the packs given, nothing implicit. `packs: [optionsPack()]` exposes only the option tools; expand the defaults with `packs: [...defaultPacks(), backtestPack()]`. When `tools` is also given, the registry is their union (both are explicit). Pack tools obey the same read-only filter, seed policy, and budgets as the defaults. - pageSize?: number; default: not declared — Maximum entries per tools/resources list page: integer 1–100, default 100. - profile?: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared — Task selection when neither tools nor packs is supplied. Explicit tools/packs remain exact. - readOnly?: boolean; default: not declared — Financial read-only mode (default `true`): tools flagged `mutates` or requiring a write/approval capability are filtered out. Explicit artifact storage and job controls are independent. - stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10). - stores.authorization?: AuthorizationStore; default: not declared - stores.authorization.consume: (input: import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }) => import('@insiderfinance/totalfinance/workflows').GrantConsumption; default: not declared — Atomically claim the grant with its validated write-ahead batch before journal commit. Idempotent only for the same store, receipt, key and batch; all other claims refuse. - stores.authorization.consume().return.consumedTimestampMs: number; default: not declared - stores.authorization.consume().return.idempotencyKey: string; default: not declared - stores.authorization.consume().return.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume().return.journalId: string; default: not declared - stores.authorization.consume().return.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume().return.receiptId: string; default: not declared - stores.authorization.consume(input): import('@insiderfinance/totalfinance/workflows').GrantConsumption & { hashOrUri: string; }; default: not declared - stores.authorization.consume(input).consumedTimestampMs: number; default: not declared - stores.authorization.consume(input).hashOrUri: string; default: not declared - stores.authorization.consume(input).idempotencyKey: string; default: not declared - stores.authorization.consume(input).journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.consume(input).journalId: string; default: not declared - stores.authorization.consume(input).journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.consume(input).receiptId: string; default: not declared - stores.authorization.get: (hashOrUri: string) => { handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; } | null; default: not declared — The grant by content hash (or handle uri) with its consumption (null while unconsumed), or null. - stores.authorization.get().return.consumed: import('@insiderfinance/totalfinance/workflows').GrantConsumption | null; default: not declared - stores.authorization.get().return.consumed.consumedTimestampMs: number; default: not declared - stores.authorization.get().return.consumed.idempotencyKey: string; default: not declared - stores.authorization.get().return.consumed.journalEvents: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Write-ahead event batch: recovery replays these exact facts, never the fill engine. - stores.authorization.get().return.consumed.journalId: string; default: not declared - stores.authorization.get().return.consumed.journalStoreId: string; default: not declared — Opaque identity of the authoritative store, retained across file-store restarts. - stores.authorization.get().return.consumed.receiptId: string; default: not declared - stores.authorization.get().return.grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.authorization.get().return.handle: import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared - stores.authorization.get(hashOrUri): string; default: not declared - stores.authorization.list: () => import('@insiderfinance/totalfinance/workflows').ResourceHandle[]; default: not declared - stores.authorization.put: (input: { grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; createdTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs; }) => import('@insiderfinance/totalfinance/workflows').ResourceHandle; default: not declared — Store a grant under its content hash; idempotent (the first put stands). Returns its handle. - stores.authorization.put().return.contentHash: string | null; default: not declared - stores.authorization.put().return.createdTimestampMs: number; default: not declared — When the store minted the handle — the caller's clock in epoch ms, never the library's. - stores.authorization.put().return.expiresTimestampMs: number | null; default: not declared — When the stored value stops being served, epoch ms; null = never. - stores.authorization.put().return.kind: import('@insiderfinance/totalfinance/workflows').ResourceHandleKind; default: not declared - stores.authorization.put().return.provenance: import('@insiderfinance/totalfinance/core').Provenance; default: not declared — Caller-supplied provenance, preserved verbatim. - stores.authorization.put().return.schema: string; default: not declared - stores.authorization.put().return.uri: string; default: not declared - stores.authorization.put().return.version: string; default: not declared - stores.authorization.put(input): { createdTimestampMs: import('@insiderfinance/totalfinance/core').EpochMs; grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; }; default: not declared - stores.authorization.put(input).createdTimestampMs: number; default: not declared - stores.authorization.put(input).grant: import('@insiderfinance/totalfinance/portfolio').AuthorizationGrant; default: not declared - stores.journal?: ExecutionJournalStore; default: not declared - stores.journal.append: (input: { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }) => { journalId: string; appended: number; skipped: number; total: number; }; default: not declared — Append atomically; identical eventId/body retries are skipped, conflicting bodies refused. - stores.journal.append().return.appended: number; default: not declared - stores.journal.append().return.journalId: string; default: not declared - stores.journal.append().return.skipped: number; default: not declared - stores.journal.append().return.total: number; default: not declared - stores.journal.append(input): { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; }; default: not declared - stores.journal.append(input).events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared - stores.journal.list: () => string[]; default: not declared — Every journal id, sorted. - stores.journal.read: (journalId: string) => import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; default: not declared — Every event of a journal in append order (empty for an unknown journal). - stores.journal.read(journalId): string; default: not declared - stores.journal.storeId: string; default: not declared — Stable opaque storage identity. Fresh stores differ; reopening a file store retains it. - stores.journal.transact: (input: { journalId: string; execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; }) => T; default: not declared — Serialize restoration, idempotency checks, identity allocation and commit for one journal. `execute` is synchronous and receives a detached snapshot. Its events are a newly appended batch (possibly empty), committed before result is returned. Exceptions commit nothing. Do not nest transactions/append on the same journal; read does not acquire another lock. - stores.journal.transact(input): { execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; journalId: string; }; default: not declared - stores.journal.transact(input).execute: (prior: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]) => { events: readonly import('@insiderfinance/totalfinance/portfolio').ExecutionJournalEvent[]; result: T; }; default: not declared - stores.journal.transact(input).journalId: string; default: not declared - tools?: TotalFinanceTool[]; default: not declared — Override the default tool set with an explicit list (the low-level escape hatch). ### @insiderfinance/totalfinance-mcp#ToolPack Kind: interface; stability: preview (pre-1.0). ```typescript export interface ToolPack { name: string; tools: TotalFinanceTool[]; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - name: string; default: not declared - tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#ToolResult Kind: interface; stability: preview (pre-1.0). ```typescript export interface ToolResult { /** Human-readable one-line summary. */ summary: string; /** Machine-readable structured output (returned as MCP `structuredContent`). */ structured: Record; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - structured: Record; default: not declared — Machine-readable structured output (returned as MCP `structuredContent`). - summary: string; default: not declared — Human-readable one-line summary. ### @insiderfinance/totalfinance-mcp#TotalFinanceTool Kind: interface; stability: preview (pre-1.0). ```typescript export interface TotalFinanceTool { name: string; title: string; description: string; schema: Schema; /** * JSON Schema describing the structured output (the `structured` slot). On the wire every * tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema. */ outputSchema?: JSONSchema; /** Whether the tool mutates state (filtered out in read-only mode). Default `false`. */ mutates?: boolean; /** * Whether a call draws random samples, so the server's deterministic seed policy applies (inject * the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; * a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`. */ stochastic?: boolean | ((args: Record) => boolean); run(input: unknown): ToolResult; } ``` Members/parameters (default = JSDoc only; not declared means no documented default): - description: string; default: not declared - mutates?: boolean; default: not declared — Whether the tool mutates state (filtered out in read-only mode). Default `false`. - name: string; default: not declared - outputSchema?: JSONSchema; default: not declared — JSON Schema describing the structured output (the `structured` slot). On the wire every tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema. - outputSchema.$id?: string; default: not declared - outputSchema.$schema?: string; default: not declared - outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.$id?: string; default: not declared - outputSchema.additionalProperties.$schema?: string; default: not declared - outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.const?: unknown; default: not declared - outputSchema.additionalProperties.default?: unknown; default: not declared - outputSchema.additionalProperties.description?: string; default: not declared - outputSchema.additionalProperties.enum?: unknown[]; default: not declared - outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - outputSchema.additionalProperties.format?: string; default: not declared - outputSchema.additionalProperties.items?: JSONSchema; default: not declared - outputSchema.additionalProperties.maxItems?: number; default: not declared - outputSchema.additionalProperties.maxLength?: number; default: not declared - outputSchema.additionalProperties.maximum?: number; default: not declared - outputSchema.additionalProperties.minItems?: number; default: not declared - outputSchema.additionalProperties.minLength?: number; default: not declared - outputSchema.additionalProperties.minimum?: number; default: not declared - outputSchema.additionalProperties.multipleOf?: number; default: not declared - outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - outputSchema.additionalProperties.pattern?: string; default: not declared - outputSchema.additionalProperties.properties?: Record; default: not declared - outputSchema.additionalProperties.required?: string[]; default: not declared - outputSchema.additionalProperties.title?: string; default: not declared - outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - outputSchema.allOf?: JSONSchema[]; default: not declared - outputSchema.anyOf?: JSONSchema[]; default: not declared - outputSchema.const?: unknown; default: not declared - outputSchema.default?: unknown; default: not declared - outputSchema.description?: string; default: not declared - outputSchema.enum?: unknown[]; default: not declared - outputSchema.exclusiveMaximum?: number; default: not declared - outputSchema.exclusiveMinimum?: number; default: not declared - outputSchema.format?: string; default: not declared - outputSchema.items?: JSONSchema; default: not declared - outputSchema.maxItems?: number; default: not declared - outputSchema.maxLength?: number; default: not declared - outputSchema.maximum?: number; default: not declared - outputSchema.minItems?: number; default: not declared - outputSchema.minLength?: number; default: not declared - outputSchema.minimum?: number; default: not declared - outputSchema.multipleOf?: number; default: not declared - outputSchema.oneOf?: JSONSchema[]; default: not declared - outputSchema.pattern?: string; default: not declared - outputSchema.properties?: Record; default: not declared - outputSchema.required?: string[]; default: not declared - outputSchema.title?: string; default: not declared - outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - run: (input: unknown) => ToolResult; default: not declared - run().return.structured: Record; default: not declared — Machine-readable structured output (returned as MCP `structuredContent`). - run().return.summary: string; default: not declared — Human-readable one-line summary. - run(input): unknown; default: not declared - schema: Schema; default: not declared - schema.describe: (description: string) => Schema; default: not declared - schema.describe(description): string; default: not declared - schema.isOptional: boolean; default: not declared - schema.kind: string; default: not declared - schema.optional: () => Schema; default: not declared - schema.parse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => unknown; default: not declared - schema.parse(input): unknown; default: not declared - schema.parse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schema.parse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schema.safeParse: (input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult; default: not declared - schema.safeParse().return.data: unknown; default: not declared - schema.safeParse().return.error: InputError; default: not declared - schema.safeParse().return.issues: import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]; default: not declared - schema.safeParse().return.success: (false) | (true); default: not declared - schema.safeParse(input): unknown; default: not declared - schema.safeParse(options)?: import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined; default: not declared - schema.safeParse(options).mode?: import('@insiderfinance/totalfinance/core/schema').ValidationMode; default: not declared — Validation strictness (spec §6). Defaults to `strict`. - schema.toJSONSchema: () => JSONSchema; default: not declared - schema.toJSONSchema().return.$id?: string; default: not declared - schema.toJSONSchema().return.$schema?: string; default: not declared - schema.toJSONSchema().return.additionalProperties?: boolean | JSONSchema; default: not declared - schema.toJSONSchema().return.additionalProperties.$id?: string; default: not declared - schema.toJSONSchema().return.additionalProperties.$schema?: string; default: not declared - schema.toJSONSchema().return.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - schema.toJSONSchema().return.additionalProperties.allOf?: JSONSchema[]; default: not declared - schema.toJSONSchema().return.additionalProperties.anyOf?: JSONSchema[]; default: not declared - schema.toJSONSchema().return.additionalProperties.const?: unknown; default: not declared - schema.toJSONSchema().return.additionalProperties.default?: unknown; default: not declared - schema.toJSONSchema().return.additionalProperties.description?: string; default: not declared - schema.toJSONSchema().return.additionalProperties.enum?: unknown[]; default: not declared - schema.toJSONSchema().return.additionalProperties.exclusiveMaximum?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.exclusiveMinimum?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.format?: string; default: not declared - schema.toJSONSchema().return.additionalProperties.items?: JSONSchema; default: not declared - schema.toJSONSchema().return.additionalProperties.maxItems?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.maxLength?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.maximum?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.minItems?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.minLength?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.minimum?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.multipleOf?: number; default: not declared - schema.toJSONSchema().return.additionalProperties.oneOf?: JSONSchema[]; default: not declared - schema.toJSONSchema().return.additionalProperties.pattern?: string; default: not declared - schema.toJSONSchema().return.additionalProperties.properties?: Record; default: not declared - schema.toJSONSchema().return.additionalProperties.required?: string[]; default: not declared - schema.toJSONSchema().return.additionalProperties.title?: string; default: not declared - schema.toJSONSchema().return.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schema.toJSONSchema().return.allOf?: JSONSchema[]; default: not declared - schema.toJSONSchema().return.anyOf?: JSONSchema[]; default: not declared - schema.toJSONSchema().return.const?: unknown; default: not declared - schema.toJSONSchema().return.default?: unknown; default: not declared - schema.toJSONSchema().return.description?: string; default: not declared - schema.toJSONSchema().return.enum?: unknown[]; default: not declared - schema.toJSONSchema().return.exclusiveMaximum?: number; default: not declared - schema.toJSONSchema().return.exclusiveMinimum?: number; default: not declared - schema.toJSONSchema().return.format?: string; default: not declared - schema.toJSONSchema().return.items?: JSONSchema; default: not declared - schema.toJSONSchema().return.maxItems?: number; default: not declared - schema.toJSONSchema().return.maxLength?: number; default: not declared - schema.toJSONSchema().return.maximum?: number; default: not declared - schema.toJSONSchema().return.minItems?: number; default: not declared - schema.toJSONSchema().return.minLength?: number; default: not declared - schema.toJSONSchema().return.minimum?: number; default: not declared - schema.toJSONSchema().return.multipleOf?: number; default: not declared - schema.toJSONSchema().return.oneOf?: JSONSchema[]; default: not declared - schema.toJSONSchema().return.pattern?: string; default: not declared - schema.toJSONSchema().return.properties?: Record; default: not declared - schema.toJSONSchema().return.required?: string[]; default: not declared - schema.toJSONSchema().return.title?: string; default: not declared - schema.toJSONSchema().return.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - schema.~standard: import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props; default: not declared - schema.~standard.types?: ({ readonly input: unknown; readonly output: unknown; }) | undefined; default: not declared - schema.~standard.types.input: unknown; default: not declared - schema.~standard.types.output: unknown; default: not declared - schema.~standard.validate: (value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result; default: not declared - schema.~standard.validate().return.issues?: (readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined); default: not declared - schema.~standard.validate().return.value: unknown; default: not declared - schema.~standard.validate(value): unknown; default: not declared - schema.~standard.vendor: string; default: not declared - schema.~standard.version: 1; default: not declared - stochastic?: boolean | ((args: Record) => boolean); default: not declared — Whether a call draws random samples, so the server's deterministic seed policy applies (inject the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`. - title: string; default: not declared ### @insiderfinance/totalfinance-mcp#analysisTools Kind: function; stability: preview (pre-1.0). The analysis-role tools beyond the compute defaults, as MCP tools. ```typescript export declare function analysisTools(): TotalFinanceTool[]; ``` ### @insiderfinance/totalfinance-mcp#artifactPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function artifactPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#backtestPack Kind: function; stability: preview (pre-1.0). The opt-in backtest pack (payload/runtime heavy — deliberately not a default). ```typescript export declare function backtestPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#calendarPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function calendarPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#createTotalFinanceMcpServer Kind: function; stability: preview (pre-1.0). Build (but do not connect) a TotalFinance MCP server. ```typescript export declare function createTotalFinanceMcpServer(options?: McpServerOptions): Server; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (options)?: McpServerOptions; default: not declared - (options).artifacts?: ArtifactStoreReader; default: not declared — An artifact store (Decision 5): input handles resolve through it; permitted reports are listed as `totalfinance://reports/` resources. With jobs attached, reports for excluded operations are hidden. A constructor argument — nothing is looked up by "current session". - (options).capabilities?: readonly string[]; default: not declared — What every caller of this server holds (Stage 7B.2 Decision 9); default the runtime's defaults. - (options).clock?: () => string; default: not declared — The instant stamped on a stored result's handle when `artifacts` is writable — the edge's clock (default `new Date().toISOString()`). - (options).deadlineMs?: number; default: not declared — Soft wall-clock budget per tool call (ms). A call exceeding it returns an error. - (options).defaultSeed?: number; default: not declared — Deterministic seed policy (spec §18.5). Any stochastic CALL (Monte Carlo, resampling — a tool's `stochastic` flag may be a per-call predicate) requires a seed; when absent, this default is injected and echoed in `structured.assumptions.seed` so MCP results are reproducible. Default 0. Deterministic calls (e.g. historical/parametric VaR) never get a meaningless seed injected. - (options).jobs?: JobRunner; default: not declared — Explicit local worker runner; requires its artifact reader. Adds typed job controls, never grants. - (options).maxInputBytes?: number; default: not declared — Reject any tool call whose serialized arguments exceed this many bytes (compute-budget guard, spec §18.5). Default 64 KB. - (options).packs?: (OperationPack | ToolPack)[]; default: not declared — EXACT pack selection (alignment spec P1.1): omitted → the selected profile; provided → exactly the packs given, nothing implicit. `packs: [optionsPack()]` exposes only the option tools; expand the defaults with `packs: [...defaultPacks(), backtestPack()]`. When `tools` is also given, the registry is their union (both are explicit). Pack tools obey the same read-only filter, seed policy, and budgets as the defaults. - (options).pageSize?: number; default: not declared — Maximum entries per tools/resources list page: integer 1–100, default 100. - (options).profile?: 'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'; default: not declared — Task selection when neither tools nor packs is supplied. Explicit tools/packs remain exact. - (options).readOnly?: boolean; default: not declared — Financial read-only mode (default `true`): tools flagged `mutates` or requiring a write/approval capability are filtered out. Explicit artifact storage and job controls are independent. - (options).stores?: { authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }; default: not declared — The trade lifecycle's stores (Decision 10). - (options).stores.authorization?: AuthorizationStore; default: not declared - (options).stores.journal?: ExecutionJournalStore; default: not declared - (options).tools?: TotalFinanceTool[]; default: not declared — Override the default tool set with an explicit list (the low-level escape hatch). ### @insiderfinance/totalfinance-mcp#cryptoPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function cryptoPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#defaultPacks Kind: function; stability: preview (pre-1.0). The ten domain packs that make up the default read-only server, in tool-list order. ```typescript export declare function defaultPacks(): ToolPack[]; ``` ### @insiderfinance/totalfinance-mcp#defaultTools Kind: function; stability: preview (pre-1.0). The default read-only tool set — every domain pack flattened (dx §WS-5). ```typescript export declare function defaultTools(): TotalFinanceTool[]; ``` ### @insiderfinance/totalfinance-mcp#defineTool Kind: function; stability: preview (pre-1.0). Define a caller's own tool (the escape hatch for a custom server); validated on every run. ```typescript export declare function defineTool(definition: { name: string; title: string; description: string; schema: Schema; outputSchema?: JSONSchema; mutates?: boolean; stochastic?: boolean | ((args: Record) => boolean); run: (input: I) => ToolResult | OperationOutput>; }): TotalFinanceTool; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (definition): { name: string; title: string; description: string; schema: Schema; outputSchema?: JSONSchema; mutates?: boolean; stochastic?: boolean | ((args: Record) => boolean); run: (input: I) => ToolResult | OperationOutput>; }; default: not declared - (definition).description: string; default: not declared - (definition).mutates?: boolean; default: not declared - (definition).name: string; default: not declared - (definition).outputSchema?: JSONSchema; default: not declared - (definition).run: (input: I) => ToolResult | OperationOutput>; default: not declared - (definition).schema: Schema; default: not declared - (definition).stochastic?: boolean | ((args: Record) => boolean); default: not declared - (definition).title: string; default: not declared - return.description: string; default: not declared - return.mutates?: boolean; default: not declared — Whether the tool mutates state (filtered out in read-only mode). Default `false`. - return.name: string; default: not declared - return.outputSchema?: JSONSchema; default: not declared — JSON Schema describing the structured output (the `structured` slot). On the wire every tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema. - return.run: (input: unknown) => ToolResult; default: not declared - return.schema: Schema; default: not declared - return.stochastic?: boolean | ((args: Record) => boolean); default: not declared — Whether a call draws random samples, so the server's deterministic seed policy applies (inject the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`. - return.title: string; default: not declared ### @insiderfinance/totalfinance-mcp#fixedIncomePack Kind: function; stability: preview (pre-1.0). ```typescript export declare function fixedIncomePack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#journeyPacks Kind: function; stability: preview (pre-1.0). The five journey packs as tool packs (the valuation pack joined in Stage 4.7): `createTotalFinanceMcpServer({ packs: [...defaultPacks(), ...journeyPacks()] })`. ```typescript export declare function journeyPacks(): ToolPack[]; ``` ### @insiderfinance/totalfinance-mcp#optionsPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function optionsPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#performancePack Kind: function; stability: preview (pre-1.0). ```typescript export declare function performancePack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#portfolioPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function portfolioPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#researchPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function researchPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#riskPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function riskPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#scenarioPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function scenarioPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#strategyPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function strategyPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#structurePack Kind: function; stability: preview (pre-1.0). ```typescript export declare function structurePack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#technicalAnalysisPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function technicalAnalysisPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#toolFromOperation Kind: function; stability: preview (pre-1.0). Render a registry operation as an MCP tool — the shipped tools are exactly these. ```typescript export declare function toolFromOperation(operation: TotalFinanceOperation): TotalFinanceTool; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (operation): TotalFinanceOperation>; default: not declared - (operation).authorization: import('@insiderfinance/totalfinance/workflows').OperationAuthorization; default: not declared - (operation).costClass: import('@insiderfinance/totalfinance/workflows').OperationCostClass; default: not declared - (operation).description: string; default: not declared - (operation).deterministic: boolean; default: not declared - (operation).handleFields: readonly string[]; default: not declared — Input paths that accept a resource handle in place of inline data. - (operation).id: string; default: not declared — The wire identity every transport uses: `totalfinance..`. - (operation).idempotency: import('@insiderfinance/totalfinance/workflows').OperationIdempotency; default: not declared - (operation).inputSchema: Schema; default: not declared - (operation).outputSchema: JSONSchema | null; default: not declared - (operation).outputSchema.$id?: string; default: not declared - (operation).outputSchema.$schema?: string; default: not declared - (operation).outputSchema.additionalProperties?: boolean | JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.$id?: string; default: not declared - (operation).outputSchema.additionalProperties.$schema?: string; default: not declared - (operation).outputSchema.additionalProperties.additionalProperties?: boolean | JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.allOf?: JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.anyOf?: JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.const?: unknown; default: not declared - (operation).outputSchema.additionalProperties.default?: unknown; default: not declared - (operation).outputSchema.additionalProperties.description?: string; default: not declared - (operation).outputSchema.additionalProperties.enum?: unknown[]; default: not declared - (operation).outputSchema.additionalProperties.exclusiveMaximum?: number; default: not declared - (operation).outputSchema.additionalProperties.exclusiveMinimum?: number; default: not declared - (operation).outputSchema.additionalProperties.format?: string; default: not declared - (operation).outputSchema.additionalProperties.items?: JSONSchema; default: not declared - (operation).outputSchema.additionalProperties.maxItems?: number; default: not declared - (operation).outputSchema.additionalProperties.maxLength?: number; default: not declared - (operation).outputSchema.additionalProperties.maximum?: number; default: not declared - (operation).outputSchema.additionalProperties.minItems?: number; default: not declared - (operation).outputSchema.additionalProperties.minLength?: number; default: not declared - (operation).outputSchema.additionalProperties.minimum?: number; default: not declared - (operation).outputSchema.additionalProperties.multipleOf?: number; default: not declared - (operation).outputSchema.additionalProperties.oneOf?: JSONSchema[]; default: not declared - (operation).outputSchema.additionalProperties.pattern?: string; default: not declared - (operation).outputSchema.additionalProperties.properties?: Record; default: not declared - (operation).outputSchema.additionalProperties.required?: string[]; default: not declared - (operation).outputSchema.additionalProperties.title?: string; default: not declared - (operation).outputSchema.additionalProperties.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (operation).outputSchema.allOf?: JSONSchema[]; default: not declared - (operation).outputSchema.anyOf?: JSONSchema[]; default: not declared - (operation).outputSchema.const?: unknown; default: not declared - (operation).outputSchema.default?: unknown; default: not declared - (operation).outputSchema.description?: string; default: not declared - (operation).outputSchema.enum?: unknown[]; default: not declared - (operation).outputSchema.exclusiveMaximum?: number; default: not declared - (operation).outputSchema.exclusiveMinimum?: number; default: not declared - (operation).outputSchema.format?: string; default: not declared - (operation).outputSchema.items?: JSONSchema; default: not declared - (operation).outputSchema.maxItems?: number; default: not declared - (operation).outputSchema.maxLength?: number; default: not declared - (operation).outputSchema.maximum?: number; default: not declared - (operation).outputSchema.minItems?: number; default: not declared - (operation).outputSchema.minLength?: number; default: not declared - (operation).outputSchema.minimum?: number; default: not declared - (operation).outputSchema.multipleOf?: number; default: not declared - (operation).outputSchema.oneOf?: JSONSchema[]; default: not declared - (operation).outputSchema.pattern?: string; default: not declared - (operation).outputSchema.properties?: Record; default: not declared - (operation).outputSchema.required?: string[]; default: not declared - (operation).outputSchema.title?: string; default: not declared - (operation).outputSchema.type?: import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]; default: not declared - (operation).requiredCapabilities: readonly string[]; default: not declared - (operation).run: (input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => OperationOutput>; default: not declared — SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony. - (operation).sideEffect: import('@insiderfinance/totalfinance/workflows').OperationSideEffect; default: not declared - (operation).stochastic: boolean | ((input: unknown) => boolean); default: not declared — A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation` — the predicate reads its own parsed input.) - (operation).supportsCancellation: boolean; default: not declared — True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report. - (operation).title: string; default: not declared - (operation).version: string; default: not declared — An integer string; a breaking output change bumps it (pre-1.0: no aliases). - return.description: string; default: not declared - return.mutates?: boolean; default: not declared — Whether the tool mutates state (filtered out in read-only mode). Default `false`. - return.name: string; default: not declared - return.outputSchema?: JSONSchema; default: not declared — JSON Schema describing the structured output (the `structured` slot). On the wire every tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema. - return.run: (input: unknown) => ToolResult; default: not declared - return.schema: Schema; default: not declared - return.stochastic?: boolean | ((args: Record) => boolean); default: not declared — Whether a call draws random samples, so the server's deterministic seed policy applies (inject the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`. - return.title: string; default: not declared ### @insiderfinance/totalfinance-mcp#toolNameFor Kind: function; stability: preview (pre-1.0). The MCP tool name of an operation: the dotted operation id with every dot replaced by an underscore (`totalfinance.option.price` → `totalfinance_option_price`). MCP clients constrain tool names to `[A-Za-z0-9_-]`; the dotted id stays the operation's identity everywhere else — in `_meta['totalfinance/operation'].id`, `totalfinance://operations/`, the HTTP paths and the CLI. ```typescript export declare function toolNameFor(operationId: string): string; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - (operationId): string; default: not declared ### @insiderfinance/totalfinance-mcp#valuationPack Kind: function; stability: preview (pre-1.0). The company-valuation journey pack (Stage 4.7 slice 2): `totalfinance.valuation.company`. ```typescript export declare function valuationPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ### @insiderfinance/totalfinance-mcp#volatilityPack Kind: function; stability: preview (pre-1.0). ```typescript export declare function volatilityPack(): ToolPack; ``` Members/parameters (default = JSDoc only; not declared means no documented default): - return.name: string; default: not declared - return.tools: TotalFinanceTool[]; default: not declared ## Technical indicators (full registry) Registry metadata: name · category · inputs · declared parameters/defaults · warmup · aliases. No defaults are inferred. - abandonedBaby · candlestick · bars · not declared · warmup 12 - advanceBlock · candlestick · bars · not declared · warmup 12 - beltHold · candlestick · bars · not declared · warmup 10 - breakaway · candlestick · bars · not declared · warmup 14 - cdlDoji · candlestick · bars · not declared · warmup 10 · aka cdl_doji - cdlInside · candlestick · bars · not declared · warmup 11 · aka cdl_inside - cdlZ · candlestick · bars · ddof=1, period=14 · warmup 13 · aka cdl_z - closingMarubozu · candlestick · bars · not declared · warmup 10 - concealBabySwallow · candlestick · bars · not declared · warmup 13 - counterattack · candlestick · bars · not declared · warmup 11 - darkCloudCover · candlestick · bars · not declared · warmup 11 - doji · candlestick · bars · not declared · warmup 10 - dojiStar · candlestick · bars · not declared · warmup 11 - dragonflyDoji · candlestick · bars · not declared · warmup 10 - engulfing · candlestick · bars · not declared · warmup 11 - eveningDojiStar · candlestick · bars · not declared · warmup 12 - eveningStar · candlestick · bars · not declared · warmup 12 - gapSideSideWhite · candlestick · bars · not declared · warmup 12 - gravestoneDoji · candlestick · bars · not declared · warmup 10 - hammer · candlestick · bars · not declared · warmup 10 - hangingMan · candlestick · bars · not declared · warmup 10 - harami · candlestick · bars · not declared · warmup 11 - haramiCross · candlestick · bars · not declared · warmup 11 - highWave · candlestick · bars · not declared · warmup 10 - hikkake · candlestick · bars · not declared · warmup 12 - hikkakeMod · candlestick · bars · not declared · warmup 12 - homingPigeon · candlestick · bars · not declared · warmup 11 - identicalThreeCrows · candlestick · bars · not declared · warmup 12 - inNeck · candlestick · bars · not declared · warmup 11 - inside · candlestick · bars · not declared · warmup 11 - invertedHammer · candlestick · bars · not declared · warmup 10 - kicking · candlestick · bars · not declared · warmup 11 - kickingByLength · candlestick · bars · not declared · warmup 11 - ladderBottom · candlestick · bars · not declared · warmup 14 - longLeggedDoji · candlestick · bars · not declared · warmup 10 - longLine · candlestick · bars · not declared · warmup 10 - marubozu · candlestick · bars · not declared · warmup 10 - matchingLow · candlestick · bars · not declared · warmup 11 - matHold · candlestick · bars · not declared · warmup 14 - morningDojiStar · candlestick · bars · not declared · warmup 12 - morningStar · candlestick · bars · not declared · warmup 12 - onNeck · candlestick · bars · not declared · warmup 11 - piercing · candlestick · bars · not declared · warmup 11 - rickshawMan · candlestick · bars · not declared · warmup 10 - riseFallThreeMethods · candlestick · bars · not declared · warmup 14 - separatingLines · candlestick · bars · not declared · warmup 11 - shootingStar · candlestick · bars · not declared · warmup 10 - shortLine · candlestick · bars · not declared · warmup 10 - spinningTop · candlestick · bars · not declared · warmup 10 - stalledPattern · candlestick · bars · not declared · warmup 12 - stickSandwich · candlestick · bars · not declared · warmup 12 - takuri · candlestick · bars · not declared · warmup 10 - tasukiGap · candlestick · bars · not declared · warmup 12 - threeBlackCrows · candlestick · bars · not declared · warmup 12 - threeInside · candlestick · bars · not declared · warmup 12 - threeLineStrike · candlestick · bars · not declared · warmup 13 - threeOutside · candlestick · bars · not declared · warmup 12 - threeStarsInSouth · candlestick · bars · not declared · warmup 12 - threeWhiteSoldiers · candlestick · bars · not declared · warmup 12 - thrusting · candlestick · bars · not declared · warmup 11 - triStar · candlestick · bars · not declared · warmup 12 - twoCrows · candlestick · bars · not declared · warmup 12 - uniqueThreeRiver · candlestick · bars · not declared · warmup 12 - upsideGapTwoCrows · candlestick · bars · not declared · warmup 12 - xSideGapThreeMethods · candlestick · bars · not declared · warmup 12 - dsp · cycle · series · period=14 · warmup 13 · aka dsp - ebsw · cycle · series · bars=10, period=40 · warmup 39 · aka ebsw - htDcPeriod · cycle · series · not declared · warmup 6 · aka HT_DCPERIOD, ht_dcperiod - htDcPhase · cycle · series · not declared · warmup 6 · aka HT_DCPHASE, ht_dcphase - htPhasor · cycle · series · not declared · warmup 6 · aka HT_PHASOR, ht_phasor - htSine · cycle · series · not declared · warmup 6 · aka HT_SINE, ht_sine - htTrendline · cycle · series · not declared · warmup 6 · aka HT_TRENDLINE, ht_trendline - htTrendMode · cycle · series · not declared · warmup 6 · aka HT_TRENDMODE, ht_trendmode - msw · cycle · series · period=14 · warmup 14 · aka msw - acos · math · series · not declared · warmup 0 · aka ACOS, acos - add · math · pair · not declared · warmup 0 · aka ADD, add - asin · math · series · not declared · warmup 0 · aka ASIN, asin - atan · math · series · not declared · warmup 0 · aka ATAN, atan - ceil · math · series · not declared · warmup 0 · aka CEIL, ceil - cos · math · series · not declared · warmup 0 · aka COS, cos - cosh · math · series · not declared · warmup 0 · aka COSH, cosh - crossany · math · pair · not declared · warmup 0 · aka crossany - crossover · math · pair · not declared · warmup 0 · aka crossover - div · math · pair · not declared · warmup 0 · aka DIV, div - exp · math · series · not declared · warmup 0 · aka EXP, exp - floor · math · series · not declared · warmup 0 · aka FLOOR, floor - ln · math · series · not declared · warmup 0 · aka LN, ln - log10 · math · series · not declared · warmup 0 · aka LOG10, log10 - mult · math · pair · not declared · warmup 0 · aka MULT, mult - sin · math · series · not declared · warmup 0 · aka SIN, sin - sinh · math · series · not declared · warmup 0 · aka SINH, sinh - sqrt · math · series · not declared · warmup 0 · aka SQRT, sqrt - sub · math · pair · not declared · warmup 0 · aka SUB, sub - tan · math · series · not declared · warmup 0 · aka TAN, tan - tanh · math · series · not declared · warmup 0 · aka TANH, tanh - apo · momentum · series · fast=12, slow=26 · warmup 25 · aka APO, apo - awesomeOscillator · momentum · bars · fast=12, slow=26 · warmup 25 · aka ao, Awesome Oscillator - bias · momentum · series · period=14 · warmup 13 · aka bias - bop · momentum · bars · not declared · warmup 0 · aka BOP, bop - brar · momentum · bars · period=14 · warmup 14 · aka brar - cci · momentum · bars · period=14 · warmup 13 · aka CCI, cci, CCI - centerOfGravity · momentum · series · period=14 · warmup 13 · aka cg - cfo · momentum · series · period=14 · warmup 13 · aka cfo - cmo · momentum · series · period=14, talib=false · warmup 14 · aka CMO, cmo - connorsRsi · momentum · series · rankPeriod=100, rsiPeriod=14, streakPeriod=2 · warmup 101 - coppock · momentum · series · longRoc=14, shortRoc=11, wma=10 · warmup 23 · aka coppock, Coppock Curve - cti · momentum · series · period=14 · warmup 13 · aka cti - dpo · momentum · series · period=14 · warmup 13 · aka dpo - efficiencyRatio · momentum · series · period=14 · warmup 14 · aka er - elderRay · momentum · bars · period=14 · warmup 13 · aka eri, Elder Ray - fisherTransform · momentum · bars · period=14 · warmup 13 · aka fisher, Fisher Transform - forecastOscillator · momentum · series · period=14 · warmup 13 · aka fosc - inertia · momentum · series · period=14, rviPeriod=14 · warmup 39 · aka inertia - kdj · momentum · bars · period=14, signal=9 · warmup 13 · aka kdj, KDJ - kst · momentum · series · rocPeriods=[10,15,20,30], signal=9, smaPeriods=[10,10,10,15] · warmup 52 · aka kst, KST - laguerreRsi · momentum · series · gamma=0.5 · warmup 0 · aka lrsi - macd · momentum · series · fast=12, signal=9, slow=26 · warmup 33 · aka MACD, macd, MACD - macdExt · momentum · series · fast=12, fastMovingAverageType="ema", signal=9, signalMovingAverageType="ema", slow=26, slowMovingAverageType="ema" · warmup 33 · aka MACDEXT, macdext - macdFix · momentum · series · signal=9 · warmup 33 · aka MACDFIX, macdfix - momentum · momentum · series · period=14 · warmup 14 · aka MOM, mom - pgo · momentum · bars · period=14 · warmup 13 · aka pgo - ppo · momentum · series · fast=12, signal=9, slow=26 · warmup 33 · aka PPO, ppo - projectionOscillator · momentum · bars · period=14 · warmup 13 · aka po - psychologicalLine · momentum · series · period=14 · warmup 14 · aka psl - pvo · momentum · bars · fast=12, signal=9, slow=26 · warmup 33 · aka pvo - qqe · momentum · series · factor=4.236, rsiPeriod=14, smooth=5 · warmup 71 · aka qqe, QQE - relativeVigorIndex · momentum · bars · period=14 · warmup 19 · aka rvgi, RVGI - roc · momentum · series · period=14 · warmup 14 · aka ROC, roc - rocp · momentum · series · period=14 · warmup 14 · aka ROCP, rocp - rocr · momentum · series · period=14 · warmup 14 · aka ROCR, rocr - rocr100 · momentum · series · period=14 · warmup 14 · aka ROCR100, rocr100 - rsi · momentum · series · period=14 · warmup 14 · aka RSI, rsi, RSI - rsx · momentum · series · period=14 · warmup 14 · aka rsx - schaffTrendCycle · momentum · series · cycle=10, fast=12, slow=26 · warmup 43 · aka stc, Schaff Trend Cycle - slope · momentum · series · period=14 · warmup 14 · aka slope - smcSweep · momentum · bars · period=14, wickMultiplier=1.5 · warmup 0 · aka smc_sweep - smiErgodic · momentum · series · long=25, short=13, signal=9 · warmup 45 · aka smi, SMI Ergodic - squeeze · momentum · bars · bollingerBandPeriod=20, bollingerStandardDeviations=2, keltnerChannelMultiplier=1.5, keltnerChannelPeriod=20 · warmup 38 · aka squeeze, TTM Squeeze - squeezePro · momentum · bars · bollingerBandPeriod=20, bollingerStandardDeviations=2, keltnerChannelPeriod=20, narrowKeltnerChannelMultiplier=1, normalKeltnerChannelMultiplier=1.5, wideKeltnerChannelMultiplier=2 · warmup 38 · aka squeeze_pro - stochastic · momentum · bars · dPeriod=3, kPeriod=14, smoothK=1 · warmup 15 · aka STOCH, stoch, Stochastic - stochFast · momentum · bars · dPeriod=3, kPeriod=14, smoothK=1 · warmup 15 · aka STOCHF, stochf - stochRsi · momentum · series · dPeriod=3, kPeriod=14, rsiPeriod=14, stochPeriod=14 · warmup 42 · aka STOCHRSI, stochrsi, Stochastic RSI - tdSequential · momentum · bars · lookback=20 · warmup 20 · aka td_seq, TD Sequential - trix · momentum · series · period=14 · warmup 40 · aka TRIX, trix - trixHistogram · momentum · series · period=14, signal=9 · warmup 48 · aka trixh - tsi · momentum · series · long=25, short=13, signal=9 · warmup 45 · aka tsi, TSI - ultimateOscillator · momentum · bars · long=25, medium=14, short=13 · warmup 25 · aka ULTOSC, uo - volumeWeightedMacd · momentum · bars · fast=12, signal=9, slow=26 · warmup 33 · aka vwmacd - williamsR · momentum · bars · period=14 · warmup 13 · aka WILLR, willr, Williams %R - alma · moving-average · series · offset=0.85, period=14, sigma=6 · warmup 13 · aka alma, ALMA - anchoredVwap · moving-average · bars · anchor=0 · warmup 0 - dema · moving-average · series · period=14 · warmup 26 · aka DEMA, dema - ema · moving-average · series · period=14 · warmup 13 · aka EMA, ema, EMA - frama · moving-average · bars · period=14 · warmup 13 - fwma · moving-average · series · period=14 · warmup 13 · aka fwma - gannHighLowActivator · moving-average · bars · period=14 · warmup 13 · aka hilo, Gann HiLo Activator - hma · moving-average · series · period=14 · warmup 16 · aka hma, HMA - holtWinterMovingAverage · moving-average · series · accelerationSmoothing=0.1, levelSmoothing=0.2, trendSmoothing=0.1 · warmup 0 · aka hwma - jma · moving-average · series · period=14, phase=0, power=1 · warmup 0 · aka jma - kama · moving-average · series · fast=12, period=14, slow=26 · warmup 14 · aka KAMA, kama - mama · moving-average · bars · fastLimit=0.5, slowLimit=0.05 · warmup 6 · aka MAMA, mama - mcginley · moving-average · series · period=14 · warmup 0 · aka mcgd, McGinley Dynamic - midpoint · moving-average · series · period=14 · warmup 13 · aka MIDPOINT, midpoint - midprice · moving-average · bars · period=14 · warmup 13 · aka MIDPRICE, midprice - movingAverage · moving-average · series · movingAverageType="ema", period=14 · warmup 13 · aka MA, ma - movingAverageRibbon · moving-average · series · periods=[5,10,20] · warmup 19 · aka mmar - pascalWma · moving-average · series · period=14 · warmup 13 · aka pwma - rainbowMovingAverage · moving-average · series · levels=10, period=14 · warmup 130 · aka rainbow - rma · moving-average · series · period=14 · warmup 13 · aka rma, RMA - rollingAnchoredVwap · moving-average · bars · anchor="high", lookback=20 · warmup 19 - rollingVwap · moving-average · bars · period=14 · warmup 13 - sessionVwap · moving-average · bars · resetEvery=20 · warmup 0 - sineWma · moving-average · series · period=14 · warmup 13 · aka sinwma - sma · moving-average · series · period=14 · warmup 13 · aka SMA, sma, SMA - superSmoother · moving-average · series · period=14 · warmup 0 · aka ssf - symmetricWma · moving-average · series · period=14 · warmup 13 · aka swma - t3 · moving-average · series · period=14, volumeFactor=0.7 · warmup 78 · aka T3, t3 - tema · moving-average · series · period=14 · warmup 39 · aka TEMA, tema - trima · moving-average · series · period=14 · warmup 13 · aka TRIMA, trima - vidya · moving-average · series · cmoPeriod=9, period=14 · warmup 9 · aka vidya, VIDYA - vwapBands · moving-average · bars · multiplier=2 · warmup 0 - vwma · moving-average · bars · period=14 · warmup 13 · aka vwma, VWMA - wma · moving-average · series · period=14 · warmup 13 · aka WMA, wma, WMA - zlema · moving-average · series · period=14 · warmup 13 · aka zlma, ZLEMA - drawdown · performance · series · not declared · warmup 0 · aka drawdown - atrTrailingStop · price-action · bars · multiplier=2, period=14 · warmup 13 · aka ATR Trailing Stop - divergence · price-action · pair · kinds=["bullish","bearish","hiddenBullish","hiddenBearish"], swing={"left":5,"right":5} · warmup 10 - equalHighs · price-action · bars · strength=2, tolerance=0.001 · warmup 4 · aka Equal Highs - equalLows · price-action · bars · strength=2, tolerance=0.001 · warmup 4 · aka Equal Lows - fairValueGaps · price-action · bars · minimumGapPercent=0 · warmup 2 · aka Fair Value Gap - liquiditySweeps · price-action · bars · lookback=20 · warmup 20 · aka Liquidity Sweep - orderBlocks · price-action · bars · lookback=20 · warmup 0 · aka Order Block - swingTrailingStop · price-action · bars · strength=2 · warmup 10 · aka Swing Trailing Stop - barSince · statistic · series · not declared · warmup 0 · aka BarsSince - beta · statistic · pair · period=14 · warmup 14 · aka BETA, beta - change · statistic · series · period=14 · warmup 14 - correl · statistic · pair · period=14 · warmup 13 · aka CORREL, correl - covariance · statistic · pair · period=14, sample=true · warmup 13 - cum · statistic · series · not declared · warmup 0 - diff · statistic · series · period=14 · warmup 14 - entropy · statistic · series · period=14 · warmup 13 · aka entropy - fractionalChange · statistic · series · period=14 · warmup 14 - highestBars · statistic · series · period=14 · warmup 13 · aka HighestBars - kurtosis · statistic · series · period=14 · warmup 13 · aka kurtosis - lag · statistic · series · period=14 · warmup 14 - lowestBars · statistic · series · period=14 · warmup 13 · aka LowestBars - mad · statistic · series · period=14 · warmup 13 · aka mad, md - normalize · statistic · series · period=14 · warmup 13 - percentRank · statistic · series · period=14 · warmup 13 - rescale · statistic · series · max=0.2, min=0, period=14 · warmup 13 - rollingBeta · statistic · pair · period=14 · warmup 14 - rollingCorrelation · statistic · pair · period=14 · warmup 13 - rollingMax · statistic · series · period=14 · warmup 13 · aka MAX, rolling_max - rollingMaxIndex · statistic · series · period=14 · warmup 13 · aka MAXINDEX - rollingMean · statistic · series · period=14 · warmup 13 - rollingMedian · statistic · series · period=14 · warmup 13 · aka median - rollingMin · statistic · series · period=14 · warmup 13 · aka MIN, rolling_min - rollingMinIndex · statistic · series · period=14 · warmup 13 · aka MININDEX - rollingMinMax · statistic · series · period=14 · warmup 13 · aka MINMAX - rollingMinMaxIndex · statistic · series · period=14 · warmup 13 · aka MINMAXINDEX - rollingQuantile · statistic · series · period=14, quantile=0.5 · warmup 13 · aka quantile - rollingRank · statistic · series · period=14 · warmup 13 - rollingRegression · statistic · pair · period=14 · warmup 13 - rollingSum · statistic · series · period=14 · warmup 13 · aka SUM, rolling_sum - rSquared · statistic · pair · period=14 · warmup 13 - shift · statistic · series · period=14 · warmup 14 - skew · statistic · series · period=14 · warmup 13 · aka skew - standardError · statistic · series · period=14 · warmup 13 - tosStdevAll · statistic · series · ddof=1, period=14, stds=[1,2,3] · warmup 13 · aka tos_stdevall - valueWhen · statistic · pair · occurrence=0 · warmup 0 · aka ValueWhen - winsorize · statistic · series · lower=0.05, period=14, upper=0.95 · warmup 13 - zScore · statistic · series · period=14 · warmup 13 · aka zscore - averagePrice · transform · bars · not declared · warmup 0 · aka AVGPRICE, avgprice, ohlc4, Average Price - candleRange · transform · bars · not declared · warmup 0 - gap · transform · bars · not declared · warmup 1 - heikinAshi · transform · bars · not declared · warmup 0 · aka ha, Heikin Ashi - logReturns · transform · series · not declared · warmup 1 · aka log_return - lowerShadow · transform · bars · not declared · warmup 0 - medianPrice · transform · bars · not declared · warmup 0 · aka MEDPRICE, hl2, medprice, Median Price - realBody · transform · bars · not declared · warmup 0 - returns · transform · series · not declared · warmup 1 · aka percent_return - rollingVolatility · transform · series · annualization=252, period=14 · warmup 14 - trueRange · transform · bars · not declared · warmup 0 · aka TRANGE, true_range - typicalPrice · transform · bars · not declared · warmup 0 · aka TYPPRICE, hlc3, typprice, Typical Price - upperShadow · transform · bars · not declared · warmup 0 - weightedClose · transform · bars · not declared · warmup 0 · aka WCLPRICE, wcp, Weighted Close - adx · trend · bars · period=14 · warmup 27 · aka ADX, adx, ADX - adxr · trend · bars · period=14 · warmup 41 · aka ADXR, adxr - amat · trend · series · fast=12, lookback=20, movingAverageType="ema", slow=26 · warmup 45 · aka amat - aroon · trend · bars · period=14 · warmup 14 · aka AROON, aroon, Aroon - aroonOscillator · trend · bars · period=14 · warmup 14 · aka AROONOSC, aroonosc - centralPivotRange · trend · bars · not declared · warmup 1 · aka cpr, cpr_option, Central Pivot Range - chandeKrollStop · trend · bars · atrPeriod=14, multiplier=2, period=14 · warmup 26 · aka cksp, Chande Kroll Stop - chandelierExit · trend · bars · multiplier=2, period=14 · warmup 13 · aka ce, Chandelier Exit - choppinessIndex · trend · bars · period=14 · warmup 13 · aka chop, Choppiness Index - crossSignals · trend · series · above=0, below=0 · warmup 1 · aka xsignals - decreasing · trend · series · period=14, strict=false · warmup 14 · aka decreasing - dmi · trend · bars · period=14 · warmup 14 · aka dm - donchianTrend · trend · bars · period=14 · warmup 13 - dx · trend · bars · period=14 · warmup 14 · aka DX, dx - exponentialDecay · trend · series · period=14 · warmup 0 · aka edecay - ichimoku · trend · bars · base=26, conversion=9, displacement=26, spanB=52 · warmup 51 · aka ichimoku, Ichimoku Cloud - increasing · trend · series · period=14, strict=false · warmup 14 · aka increasing - linearDecay · trend · series · period=14 · warmup 0 · aka decay, linear_decay - linreg · trend · series · period=14 · warmup 13 · aka LINEARREG, linreg - linregAngle · trend · series · period=14 · warmup 13 · aka LINEARREG_ANGLE, linregangle - linregIntercept · trend · series · period=14 · warmup 13 · aka LINEARREG_INTERCEPT, linregintercept - linregSlope · trend · series · period=14 · warmup 13 · aka LINEARREG_SLOPE, linregslope - longRun · trend · pair · period=14 · warmup 14 · aka long_run - minusDI · trend · bars · period=14 · warmup 14 · aka MINUS_DI - minusDM · trend · bars · period=14 · warmup 14 · aka MINUS_DM, minus_dm - plusDI · trend · bars · period=14 · warmup 14 · aka PLUS_DI - plusDM · trend · bars · period=14 · warmup 14 · aka PLUS_DM, plus_dm - pMax · trend · bars · multiplier=2, period=14 · warmup 13 · aka pmax, PMax - psar · trend · bars · max=0.2, step=0.02 · warmup 1 · aka SAR, psar, Parabolic SAR - psarExt · trend · bars · accelInitLong=0.02, accelInitShort=0.02, accelLong=0.02, accelMaxLong=0.2, accelMaxShort=0.2, accelShort=0.02, offsetOnReverse=0, startValue=0 · warmup 1 · aka SAREXT, sarext - qstick · trend · bars · period=14 · warmup 13 · aka qstick - shortRun · trend · pair · period=14 · warmup 14 · aka short_run - supertrend · trend · bars · multiplier=2, period=14 · warmup 13 · aka supertrend, Supertrend - trendSignals · trend · series · not declared · warmup 0 · aka tsignals - tsf · trend · series · period=14 · warmup 13 · aka TSF, tsf - ttmTrend · trend · bars · period=14 · warmup 13 · aka ttm_trend, TTM Trend - verticalHorizontalFilter · trend · series · period=14 · warmup 14 · aka vhf - vortex · trend · bars · period=14 · warmup 14 · aka vortex, Vortex - aberration · volatility · bars · atrPeriod=14, period=14 · warmup 13 · aka aberration - accelerationBands · volatility · bars · multiplier=2, period=14 · warmup 13 · aka accbands, Acceleration Bands - atr · volatility · bars · period=14 · warmup 13 · aka ATR, atr, ATR - atrBands · volatility · bars · multiplier=2, period=14 · warmup 13 - bbands · volatility · series · period=14, standardDeviation=2 · warmup 13 · aka BBANDS, bbands, Bollinger Bands - bollingerBandWidth · volatility · series · period=14, standardDeviation=2 · warmup 13 - bollingerPercentB · volatility · series · period=14, standardDeviation=2 · warmup 13 - chaikinVolatility · volatility · bars · period=14, rocPeriod=10 · warmup 23 · aka cvi - donchian · volatility · bars · period=14 · warmup 13 · aka donchian, Donchian Channels - elderThermometer · volatility · bars · long=25, period=14, short=13 · warmup 14 · aka thermo - garmanKlass · volatility · bars · annualization=252, period=14 · warmup 13 - historicalVolatility · volatility · series · annualization=252, period=14 · warmup 14 · aka hvol, avolume - holtWinterChannel · volatility · series · accelerationSmoothing=0.1, levelSmoothing=0.2, scalar=1, trendSmoothing=0.1, varianceSmoothing=0.1 · warmup 0 · aka hwc - keltner · volatility · bars · atrPeriod=14, multiplier=2, period=14 · warmup 13 · aka kc, Keltner Channels - massIndex · volatility · bars · fast=12, slow=26 · warmup 47 · aka massi, Mass Index - natr · volatility · bars · period=14 · warmup 13 · aka NATR, natr - parkinson · volatility · bars · annualization=252, period=14 · warmup 13 - percentAtr · volatility · bars · period=14 · warmup 13 - priceDistance · volatility · bars · drift=1 · warmup 1 · aka pdist - realizedVolatility · volatility · series · annualization=252, period=14 · warmup 14 - relativeVolatilityIndex · volatility · series · period=14, stdevPeriod=14 · warmup 26 · aka rvi, Relative Volatility Index - rogersSatchell · volatility · bars · annualization=252, period=14 · warmup 13 - standardDeviation · volatility · series · period=14, sample=true · warmup 13 · aka STDDEV, stdev - ulcerIndex · volatility · series · period=14 · warmup 26 · aka ui, Ulcer Index - variance · volatility · series · period=14, sample=true · warmup 13 · aka VAR, variance - volatilityStop · volatility · bars · multiplier=2, period=14 · warmup 13 - yangZhang · volatility · bars · annualization=252, period=14 · warmup 14 - adLine · volume · bars · not declared · warmup 0 · aka AD, ad, Accumulation/Distribution - archerObv · volume · bars · fast=12, runLength=2, slow=26 · warmup 27 · aka aobv - chaikinMoneyFlow · volume · bars · period=14 · warmup 13 · aka cmf, CMF - chaikinOscillator · volume · bars · fast=12, slow=26 · warmup 25 · aka ADOSC, adosc - cvd · volume · bars · not declared · warmup 0 - easeOfMovement · volume · bars · period=14, scale=10000 · warmup 14 · aka eom, Ease of Movement - efi · volume · bars · period=14 · warmup 14 - emv · volume · bars · period=14, scale=10000 · warmup 14 - forceIndex · volume · bars · period=14 · warmup 14 · aka efi, Force Index - klinger · volume · bars · fast=12, signal=9, slow=26 · warmup 34 · aka kvo, Klinger Oscillator - kvo · volume · bars · fast=12, signal=9, slow=26 · warmup 34 - marketFacilitationIndex · volume · bars · not declared · warmup 0 · aka marketfi, Market Facilitation Index - mfi · volume · bars · period=14 · warmup 14 · aka MFI, mfi, Money Flow Index - nvi · volume · bars · not declared · warmup 0 · aka nvi - obv · volume · bars · talib=false · warmup 0 · aka OBV, obv, OBV - priceVolume · volume · bars · signed=false · warmup 0 · aka pvol - priceVolumeRank · volume · bars · not declared · warmup 1 · aka pvr - pvi · volume · bars · not declared · warmup 0 · aka pvi - pvt · volume · bars · not declared · warmup 0 · aka pvt, Price Volume Trend - relativeVolume · volume · bars · period=14 · warmup 13 - vfi · volume · bars · coefficient=0.2, period=14, smooth=5, volumeCutoff=2.5 · warmup 18 - volumeOscillator · volume · bars · fast=12, slow=26 · warmup 25 · aka vosc, Volume Oscillator - vwap · volume · bars · not declared · warmup 0 · aka vwap, VWAP - williamsAd · volume · bars · not declared · warmup 0 · aka wad, Williams A/D